Annotation of loncom/interface/loncommon.pm, revision 1.948.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.948.2.2! raeburn 4: # $Id: loncommon.pm,v 1.948.2.1 2010/05/18 00:35:17 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.705 tempelho 274: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 275: $readit=1;
1.46 matthew 276: } # end of unless($readit)
1.32 matthew 277:
278: }
1.112 bowersj2 279:
1.42 matthew 280: ###############################################################
281: ## HTML and Javascript Helper Functions ##
282: ###############################################################
283:
284: =pod
285:
1.112 bowersj2 286: =head1 HTML and Javascript Functions
1.42 matthew 287:
1.112 bowersj2 288: =over 4
289:
1.648 raeburn 290: =item * &browser_and_searcher_javascript()
1.112 bowersj2 291:
292: X<browsing, javascript>X<searching, javascript>Returns a string
293: containing javascript with two functions, C<openbrowser> and
294: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
295: tags.
1.42 matthew 296:
1.648 raeburn 297: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 298:
299: inputs: formname, elementname, only, omit
300:
301: formname and elementname indicate the name of the html form and name of
302: the element that the results of the browsing selection are to be placed in.
303:
304: Specifying 'only' will restrict the browser to displaying only files
1.185 www 305: with the given extension. Can be a comma separated list.
1.42 matthew 306:
307: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 308: with the given extension. Can be a comma separated list.
1.42 matthew 309:
1.648 raeburn 310: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 311:
312: Inputs: formname, elementname
313:
314: formname and elementname specify the name of the html form and the name
315: of the element the selection from the search results will be placed in.
1.542 raeburn 316:
1.42 matthew 317: =cut
318:
319: sub browser_and_searcher_javascript {
1.199 albertel 320: my ($mode)=@_;
321: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 322: my $resurl=&escape_single(&lastresurl());
1.42 matthew 323: return <<END;
1.219 albertel 324: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 325: var editbrowser = null;
1.135 albertel 326: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 327: var url = '$resurl/?';
1.42 matthew 328: if (editbrowser == null) {
329: url += 'launch=1&';
330: }
331: url += 'catalogmode=interactive&';
1.199 albertel 332: url += 'mode=$mode&';
1.611 albertel 333: url += 'inhibitmenu=yes&';
1.42 matthew 334: url += 'form=' + formname + '&';
335: if (only != null) {
336: url += 'only=' + only + '&';
1.217 albertel 337: } else {
338: url += 'only=&';
339: }
1.42 matthew 340: if (omit != null) {
341: url += 'omit=' + omit + '&';
1.217 albertel 342: } else {
343: url += 'omit=&';
344: }
1.135 albertel 345: if (titleelement != null) {
346: url += 'titleelement=' + titleelement + '&';
1.217 albertel 347: } else {
348: url += 'titleelement=&';
349: }
1.42 matthew 350: url += 'element=' + elementname + '';
351: var title = 'Browser';
1.435 albertel 352: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 353: options += ',width=700,height=600';
354: editbrowser = open(url,title,options,'1');
355: editbrowser.focus();
356: }
357: var editsearcher;
1.135 albertel 358: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 359: var url = '/adm/searchcat?';
360: if (editsearcher == null) {
361: url += 'launch=1&';
362: }
363: url += 'catalogmode=interactive&';
1.199 albertel 364: url += 'mode=$mode&';
1.42 matthew 365: url += 'form=' + formname + '&';
1.135 albertel 366: if (titleelement != null) {
367: url += 'titleelement=' + titleelement + '&';
1.217 albertel 368: } else {
369: url += 'titleelement=&';
370: }
1.42 matthew 371: url += 'element=' + elementname + '';
372: var title = 'Search';
1.435 albertel 373: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 374: options += ',width=700,height=600';
375: editsearcher = open(url,title,options,'1');
376: editsearcher.focus();
377: }
1.219 albertel 378: // END LON-CAPA Internal -->
1.42 matthew 379: END
1.170 www 380: }
381:
382: sub lastresurl {
1.258 albertel 383: if ($env{'environment.lastresurl'}) {
384: return $env{'environment.lastresurl'}
1.170 www 385: } else {
386: return '/res';
387: }
388: }
389:
390: sub storeresurl {
391: my $resurl=&Apache::lonnet::clutter(shift);
392: unless ($resurl=~/^\/res/) { return 0; }
393: $resurl=~s/\/$//;
394: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 395: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 396: return 1;
1.42 matthew 397: }
398:
1.74 www 399: sub studentbrowser_javascript {
1.111 www 400: unless (
1.258 albertel 401: (($env{'request.course.id'}) &&
1.302 albertel 402: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
403: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
404: '/'.$env{'request.course.sec'})
405: ))
1.258 albertel 406: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 407: ) { return ''; }
1.74 www 408: return (<<'ENDSTDBRW');
1.776 bisitz 409: <script type="text/javascript" language="Javascript">
1.824 bisitz 410: // <![CDATA[
1.74 www 411: var stdeditbrowser;
1.793 raeburn 412: function openstdbrowser(formname,uname,udom,roleflag,ignorefilter,courseadvonly) {
1.74 www 413: var url = '/adm/pickstudent?';
414: var filter;
1.558 albertel 415: if (!ignorefilter) {
416: eval('filter=document.'+formname+'.'+uname+'.value;');
417: }
1.74 www 418: if (filter != null) {
419: if (filter != '') {
420: url += 'filter='+filter+'&';
421: }
422: }
423: url += 'form=' + formname + '&unameelement='+uname+
424: '&udomelement='+udom;
1.111 www 425: if (roleflag) { url+="&roles=1"; }
1.793 raeburn 426: if (courseadvonly) { url+="&courseadvonly=1"; }
1.102 www 427: var title = 'Student_Browser';
1.74 www 428: var options = 'scrollbars=1,resizable=1,menubar=0';
429: options += ',width=700,height=600';
430: stdeditbrowser = open(url,title,options,'1');
431: stdeditbrowser.focus();
432: }
1.824 bisitz 433: // ]]>
1.74 www 434: </script>
435: ENDSTDBRW
436: }
1.42 matthew 437:
1.74 www 438: sub selectstudent_link {
1.793 raeburn 439: my ($form,$unameele,$udomele,$courseadvonly)=@_;
440: my $callargs = "'".$form."','".$unameele."','".$udomele."'";
1.258 albertel 441: if ($env{'request.course.id'}) {
1.302 albertel 442: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
443: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
444: '/'.$env{'request.course.sec'})) {
1.111 www 445: return '';
446: }
1.793 raeburn 447: if ($courseadvonly) {
448: $callargs .= ",'',1,1";
449: }
450: return '<span class="LC_nobreak">'.
451: '<a href="javascript:openstdbrowser('.$callargs.');">'.
452: &mt('Select User').'</a></span>';
1.74 www 453: }
1.258 albertel 454: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.793 raeburn 455: $callargs .= ",1";
456: return '<span class="LC_nobreak">'.
457: '<a href="javascript:openstdbrowser('.$callargs.');">'.
458: &mt('Select User').'</a></span>';
1.111 www 459: }
460: return '';
1.91 www 461: }
462:
1.653 raeburn 463: sub authorbrowser_javascript {
464: return <<"ENDAUTHORBRW";
1.776 bisitz 465: <script type="text/javascript" language="JavaScript">
1.824 bisitz 466: // <![CDATA[
1.653 raeburn 467: var stdeditbrowser;
468:
469: function openauthorbrowser(formname,udom) {
470: var url = '/adm/pickauthor?';
471: url += 'form='+formname+'&roledom='+udom;
472: var title = 'Author_Browser';
473: var options = 'scrollbars=1,resizable=1,menubar=0';
474: options += ',width=700,height=600';
475: stdeditbrowser = open(url,title,options,'1');
476: stdeditbrowser.focus();
477: }
478:
1.824 bisitz 479: // ]]>
1.653 raeburn 480: </script>
481: ENDAUTHORBRW
482: }
483:
1.91 www 484: sub coursebrowser_javascript {
1.909 raeburn 485: my ($domainfilter,$sec_element,$formname,$role_element,$crstype) = @_;
1.932 raeburn 486: my $wintitle = 'Course_Browser';
1.931 raeburn 487: if ($crstype eq 'Community') {
1.932 raeburn 488: $wintitle = 'Community_Browser';
1.909 raeburn 489: }
1.876 raeburn 490: my $id_functions = &javascript_index_functions();
491: my $output = '
1.776 bisitz 492: <script type="text/javascript" language="JavaScript">
1.824 bisitz 493: // <![CDATA[
1.468 raeburn 494: var stdeditbrowser;'."\n";
1.876 raeburn 495:
496: $output .= <<"ENDSTDBRW";
1.909 raeburn 497: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91 www 498: var url = '/adm/pickcourse?';
1.895 raeburn 499: var formid = getFormIdByName(formname);
1.876 raeburn 500: var domainfilter = getDomainFromSelectbox(formname,udom);
1.128 albertel 501: if (domainfilter != null) {
502: if (domainfilter != '') {
503: url += 'domainfilter='+domainfilter+'&';
504: }
505: }
1.91 www 506: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 507: '&cdomelement='+udom+
508: '&cnameelement='+desc;
1.468 raeburn 509: if (extra_element !=null && extra_element != '') {
1.594 raeburn 510: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 511: url += '&roleelement='+extra_element;
512: if (domainfilter == null || domainfilter == '') {
513: url += '&domainfilter='+extra_element;
514: }
1.234 raeburn 515: }
1.468 raeburn 516: else {
517: if (formname == 'portform') {
518: url += '&setroles='+extra_element;
1.800 raeburn 519: } else {
520: if (formname == 'rules') {
521: url += '&fixeddom='+extra_element;
522: }
1.468 raeburn 523: }
524: }
1.230 raeburn 525: }
1.909 raeburn 526: if (type != null && type != '') {
527: url += '&type='+type;
528: }
529: if (type_elem != null && type_elem != '') {
530: url += '&typeelement='+type_elem;
531: }
1.872 raeburn 532: if (formname == 'ccrs') {
533: var ownername = document.forms[formid].ccuname.value;
534: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
535: url += '&cloner='+ownername+':'+ownerdom;
536: }
1.293 raeburn 537: if (multflag !=null && multflag != '') {
538: url += '&multiple='+multflag;
539: }
1.909 raeburn 540: var title = '$wintitle';
1.91 www 541: var options = 'scrollbars=1,resizable=1,menubar=0';
542: options += ',width=700,height=600';
543: stdeditbrowser = open(url,title,options,'1');
544: stdeditbrowser.focus();
545: }
1.876 raeburn 546: $id_functions
547: ENDSTDBRW
1.905 raeburn 548: if (($sec_element ne '') || ($role_element ne '')) {
549: $output .= &setsec_javascript($sec_element,$formname,$role_element);
1.876 raeburn 550: }
551: $output .= '
552: // ]]>
553: </script>';
554: return $output;
555: }
556:
557: sub javascript_index_functions {
558: return <<"ENDJS";
559:
560: function getFormIdByName(formname) {
561: for (var i=0;i<document.forms.length;i++) {
562: if (document.forms[i].name == formname) {
563: return i;
564: }
565: }
566: return -1;
567: }
568:
569: function getIndexByName(formid,item) {
570: for (var i=0;i<document.forms[formid].elements.length;i++) {
571: if (document.forms[formid].elements[i].name == item) {
572: return i;
573: }
574: }
575: return -1;
576: }
1.468 raeburn 577:
1.876 raeburn 578: function getDomainFromSelectbox(formname,udom) {
579: var userdom;
580: var formid = getFormIdByName(formname);
581: if (formid > -1) {
582: var domid = getIndexByName(formid,udom);
583: if (domid > -1) {
584: if (document.forms[formid].elements[domid].type == 'select-one') {
585: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
586: }
587: if (document.forms[formid].elements[domid].type == 'hidden') {
588: userdom=document.forms[formid].elements[domid].value;
1.468 raeburn 589: }
590: }
591: }
1.876 raeburn 592: return userdom;
593: }
594:
595: ENDJS
1.468 raeburn 596:
1.876 raeburn 597: }
598:
599: sub userbrowser_javascript {
600: my $id_functions = &javascript_index_functions();
601: return <<"ENDUSERBRW";
602:
1.888 raeburn 603: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876 raeburn 604: var url = '/adm/pickuser?';
605: var userdom = getDomainFromSelectbox(formname,udom);
606: if (userdom != null) {
607: if (userdom != '') {
608: url += 'srchdom='+userdom+'&';
609: }
610: }
611: url += 'form=' + formname + '&unameelement='+uname+
612: '&udomelement='+udom+
613: '&ulastelement='+ulast+
614: '&ufirstelement='+ufirst+
615: '&uemailelement='+uemail+
1.881 raeburn 616: '&hideudomelement='+hideudom+
617: '&coursedom='+crsdom;
1.888 raeburn 618: if ((caller != null) && (caller != undefined)) {
619: url += '&caller='+caller;
620: }
1.876 raeburn 621: var title = 'User_Browser';
622: var options = 'scrollbars=1,resizable=1,menubar=0';
623: options += ',width=700,height=600';
624: var stdeditbrowser = open(url,title,options,'1');
625: stdeditbrowser.focus();
626: }
627:
1.888 raeburn 628: function fix_domain (formname,udom,origdom,uname) {
1.876 raeburn 629: var formid = getFormIdByName(formname);
630: if (formid > -1) {
1.888 raeburn 631: var unameid = getIndexByName(formid,uname);
1.876 raeburn 632: var domid = getIndexByName(formid,udom);
633: var hidedomid = getIndexByName(formid,origdom);
634: if (hidedomid > -1) {
635: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888 raeburn 636: var unameval = document.forms[formid].elements[unameid].value;
637: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
638: if (domid > -1) {
639: var slct = document.forms[formid].elements[domid];
640: if (slct.type == 'select-one') {
641: var i;
642: for (i=0;i<slct.length;i++) {
643: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
644: }
645: }
646: if (slct.type == 'hidden') {
647: slct.value = fixeddom;
1.876 raeburn 648: }
649: }
1.468 raeburn 650: }
651: }
652: }
1.876 raeburn 653: return;
654: }
655:
656: $id_functions
657: ENDUSERBRW
1.468 raeburn 658: }
659:
660: sub setsec_javascript {
1.905 raeburn 661: my ($sec_element,$formname,$role_element) = @_;
662: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
663: $communityrolestr);
664: if ($role_element ne '') {
665: my @allroles = ('st','ta','ep','in','ad');
666: foreach my $crstype ('Course','Community') {
667: if ($crstype eq 'Community') {
668: foreach my $role (@allroles) {
669: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
670: }
671: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
672: } else {
673: foreach my $role (@allroles) {
674: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
675: }
676: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
677: }
678: }
679: $rolestr = '"'.join('","',@allroles).'"';
680: $courserolestr = '"'.join('","',@courserolenames).'"';
681: $communityrolestr = '"'.join('","',@communityrolenames).'"';
682: }
1.468 raeburn 683: my $setsections = qq|
684: function setSect(sectionlist) {
1.629 raeburn 685: var sectionsArray = new Array();
686: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
687: sectionsArray = sectionlist.split(",");
688: }
1.468 raeburn 689: var numSections = sectionsArray.length;
690: document.$formname.$sec_element.length = 0;
691: if (numSections == 0) {
692: document.$formname.$sec_element.multiple=false;
693: document.$formname.$sec_element.size=1;
694: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
695: } else {
696: if (numSections == 1) {
697: document.$formname.$sec_element.multiple=false;
698: document.$formname.$sec_element.size=1;
699: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
700: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
701: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
702: } else {
703: for (var i=0; i<numSections; i++) {
704: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
705: }
706: document.$formname.$sec_element.multiple=true
707: if (numSections < 3) {
708: document.$formname.$sec_element.size=numSections;
709: } else {
710: document.$formname.$sec_element.size=3;
711: }
712: document.$formname.$sec_element.options[0].selected = false
713: }
714: }
1.91 www 715: }
1.905 raeburn 716:
717: function setRole(crstype) {
1.468 raeburn 718: |;
1.905 raeburn 719: if ($role_element eq '') {
720: $setsections .= ' return;
721: }
722: ';
723: } else {
724: $setsections .= qq|
725: var elementLength = document.$formname.$role_element.length;
726: var allroles = Array($rolestr);
727: var courserolenames = Array($courserolestr);
728: var communityrolenames = Array($communityrolestr);
729: if (elementLength != undefined) {
730: if (document.$formname.$role_element.options[5].value == 'cc') {
731: if (crstype == 'Course') {
732: return;
733: } else {
734: allroles[5] = 'co';
735: for (var i=0; i<6; i++) {
736: document.$formname.$role_element.options[i].value = allroles[i];
737: document.$formname.$role_element.options[i].text = communityrolenames[i];
738: }
739: }
740: } else {
741: if (crstype == 'Community') {
742: return;
743: } else {
744: allroles[5] = 'cc';
745: for (var i=0; i<6; i++) {
746: document.$formname.$role_element.options[i].value = allroles[i];
747: document.$formname.$role_element.options[i].text = courserolenames[i];
748: }
749: }
750: }
751: }
752: return;
753: }
754: |;
755: }
1.468 raeburn 756: return $setsections;
757: }
758:
1.91 www 759: sub selectcourse_link {
1.909 raeburn 760: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
761: $typeelement) = @_;
762: my $type = $selecttype;
1.871 raeburn 763: my $linktext = &mt('Select Course');
764: if ($selecttype eq 'Community') {
1.909 raeburn 765: $linktext = &mt('Select Community');
1.906 raeburn 766: } elsif ($selecttype eq 'Course/Community') {
767: $linktext = &mt('Select Course/Community');
1.909 raeburn 768: $type = '';
1.871 raeburn 769: }
1.787 bisitz 770: return '<span class="LC_nobreak">'
771: ."<a href='"
772: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
773: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 774: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 775: ."'>".$linktext.'</a>'
1.787 bisitz 776: .'</span>';
1.74 www 777: }
1.42 matthew 778:
1.653 raeburn 779: sub selectauthor_link {
780: my ($form,$udom)=@_;
781: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
782: &mt('Select Author').'</a>';
783: }
784:
1.876 raeburn 785: sub selectuser_link {
1.881 raeburn 786: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 787: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 788: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 789: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 790: ');">'.$linktext.'</a>';
1.876 raeburn 791: }
792:
1.273 raeburn 793: sub check_uncheck_jscript {
794: my $jscript = <<"ENDSCRT";
795: function checkAll(field) {
796: if (field.length > 0) {
797: for (i = 0; i < field.length; i++) {
798: field[i].checked = true ;
799: }
800: } else {
801: field.checked = true
802: }
803: }
804:
805: function uncheckAll(field) {
806: if (field.length > 0) {
807: for (i = 0; i < field.length; i++) {
808: field[i].checked = false ;
1.543 albertel 809: }
810: } else {
1.273 raeburn 811: field.checked = false ;
812: }
813: }
814: ENDSCRT
815: return $jscript;
816: }
817:
1.656 www 818: sub select_timezone {
1.659 raeburn 819: my ($name,$selected,$onchange,$includeempty)=@_;
820: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
821: if ($includeempty) {
822: $output .= '<option value=""';
823: if (($selected eq '') || ($selected eq 'local')) {
824: $output .= ' selected="selected" ';
825: }
826: $output .= '> </option>';
827: }
1.657 raeburn 828: my @timezones = DateTime::TimeZone->all_names;
829: foreach my $tzone (@timezones) {
830: $output.= '<option value="'.$tzone.'"';
831: if ($tzone eq $selected) {
832: $output.=' selected="selected"';
833: }
834: $output.=">$tzone</option>\n";
1.656 www 835: }
836: $output.="</select>";
837: return $output;
838: }
1.273 raeburn 839:
1.687 raeburn 840: sub select_datelocale {
841: my ($name,$selected,$onchange,$includeempty)=@_;
842: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
843: if ($includeempty) {
844: $output .= '<option value=""';
845: if ($selected eq '') {
846: $output .= ' selected="selected" ';
847: }
848: $output .= '> </option>';
849: }
850: my (@possibles,%locale_names);
851: my @locales = DateTime::Locale::Catalog::Locales;
852: foreach my $locale (@locales) {
853: if (ref($locale) eq 'HASH') {
854: my $id = $locale->{'id'};
855: if ($id ne '') {
856: my $en_terr = $locale->{'en_territory'};
857: my $native_terr = $locale->{'native_territory'};
1.695 raeburn 858: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 859: if (grep(/^en$/,@languages) || !@languages) {
860: if ($en_terr ne '') {
861: $locale_names{$id} = '('.$en_terr.')';
862: } elsif ($native_terr ne '') {
863: $locale_names{$id} = $native_terr;
864: }
865: } else {
866: if ($native_terr ne '') {
867: $locale_names{$id} = $native_terr.' ';
868: } elsif ($en_terr ne '') {
869: $locale_names{$id} = '('.$en_terr.')';
870: }
871: }
872: push (@possibles,$id);
873: }
874: }
875: }
876: foreach my $item (sort(@possibles)) {
877: $output.= '<option value="'.$item.'"';
878: if ($item eq $selected) {
879: $output.=' selected="selected"';
880: }
881: $output.=">$item";
882: if ($locale_names{$item} ne '') {
883: $output.=" $locale_names{$item}</option>\n";
884: }
885: $output.="</option>\n";
886: }
887: $output.="</select>";
888: return $output;
889: }
890:
1.792 raeburn 891: sub select_language {
892: my ($name,$selected,$includeempty) = @_;
893: my %langchoices;
894: if ($includeempty) {
895: %langchoices = ('' => 'No language preference');
896: }
897: foreach my $id (&languageids()) {
898: my $code = &supportedlanguagecode($id);
899: if ($code) {
900: $langchoices{$code} = &plainlanguagedescription($id);
901: }
902: }
903: return &select_form($selected,$name,%langchoices);
904: }
905:
1.42 matthew 906: =pod
1.36 matthew 907:
1.648 raeburn 908: =item * &linked_select_forms(...)
1.36 matthew 909:
910: linked_select_forms returns a string containing a <script></script> block
911: and html for two <select> menus. The select menus will be linked in that
912: changing the value of the first menu will result in new values being placed
913: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 914: order unless a defined order is provided.
1.36 matthew 915:
916: linked_select_forms takes the following ordered inputs:
917:
918: =over 4
919:
1.112 bowersj2 920: =item * $formname, the name of the <form> tag
1.36 matthew 921:
1.112 bowersj2 922: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 923:
1.112 bowersj2 924: =item * $firstdefault, the default value for the first menu
1.36 matthew 925:
1.112 bowersj2 926: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 927:
1.112 bowersj2 928: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 929:
1.112 bowersj2 930: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 931:
1.609 raeburn 932: =item * $menuorder, the order of values in the first menu
933:
1.41 ng 934: =back
935:
1.36 matthew 936: Below is an example of such a hash. Only the 'text', 'default', and
937: 'select2' keys must appear as stated. keys(%menu) are the possible
938: values for the first select menu. The text that coincides with the
1.41 ng 939: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 940: and text for the second menu are given in the hash pointed to by
941: $menu{$choice1}->{'select2'}.
942:
1.112 bowersj2 943: my %menu = ( A1 => { text =>"Choice A1" ,
944: default => "B3",
945: select2 => {
946: B1 => "Choice B1",
947: B2 => "Choice B2",
948: B3 => "Choice B3",
949: B4 => "Choice B4"
1.609 raeburn 950: },
951: order => ['B4','B3','B1','B2'],
1.112 bowersj2 952: },
953: A2 => { text =>"Choice A2" ,
954: default => "C2",
955: select2 => {
956: C1 => "Choice C1",
957: C2 => "Choice C2",
958: C3 => "Choice C3"
1.609 raeburn 959: },
960: order => ['C2','C1','C3'],
1.112 bowersj2 961: },
962: A3 => { text =>"Choice A3" ,
963: default => "D6",
964: select2 => {
965: D1 => "Choice D1",
966: D2 => "Choice D2",
967: D3 => "Choice D3",
968: D4 => "Choice D4",
969: D5 => "Choice D5",
970: D6 => "Choice D6",
971: D7 => "Choice D7"
1.609 raeburn 972: },
973: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 974: }
975: );
1.36 matthew 976:
977: =cut
978:
979: sub linked_select_forms {
980: my ($formname,
981: $middletext,
982: $firstdefault,
983: $firstselectname,
984: $secondselectname,
1.609 raeburn 985: $hashref,
986: $menuorder,
1.36 matthew 987: ) = @_;
988: my $second = "document.$formname.$secondselectname";
989: my $first = "document.$formname.$firstselectname";
990: # output the javascript to do the changing
991: my $result = '';
1.776 bisitz 992: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 993: $result.="// <![CDATA[\n";
1.36 matthew 994: $result.="var select2data = new Object();\n";
995: $" = '","';
996: my $debug = '';
997: foreach my $s1 (sort(keys(%$hashref))) {
998: $result.="select2data.d_$s1 = new Object();\n";
999: $result.="select2data.d_$s1.def = new String('".
1000: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 1001: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 1002: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1003: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1004: @s2values = @{$hashref->{$s1}->{'order'}};
1005: }
1.36 matthew 1006: $result.="\"@s2values\");\n";
1007: $result.="select2data.d_$s1.texts = new Array(";
1008: my @s2texts;
1009: foreach my $value (@s2values) {
1010: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
1011: }
1012: $result.="\"@s2texts\");\n";
1013: }
1014: $"=' ';
1015: $result.= <<"END";
1016:
1017: function select1_changed() {
1018: // Determine new choice
1019: var newvalue = "d_" + $first.value;
1020: // update select2
1021: var values = select2data[newvalue].values;
1022: var texts = select2data[newvalue].texts;
1023: var select2def = select2data[newvalue].def;
1024: var i;
1025: // out with the old
1026: for (i = 0; i < $second.options.length; i++) {
1027: $second.options[i] = null;
1028: }
1029: // in with the nuclear
1030: for (i=0;i<values.length; i++) {
1031: $second.options[i] = new Option(values[i]);
1.143 matthew 1032: $second.options[i].value = values[i];
1.36 matthew 1033: $second.options[i].text = texts[i];
1034: if (values[i] == select2def) {
1035: $second.options[i].selected = true;
1036: }
1037: }
1038: }
1.824 bisitz 1039: // ]]>
1.36 matthew 1040: </script>
1041: END
1042: # output the initial values for the selection lists
1043: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609 raeburn 1044: my @order = sort(keys(%{$hashref}));
1045: if (ref($menuorder) eq 'ARRAY') {
1046: @order = @{$menuorder};
1047: }
1048: foreach my $value (@order) {
1.36 matthew 1049: $result.=" <option value=\"$value\" ";
1.253 albertel 1050: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1051: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1052: }
1053: $result .= "</select>\n";
1054: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1055: $result .= $middletext;
1056: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
1057: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1058:
1059: my @secondorder = sort(keys(%select2));
1060: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1061: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1062: }
1063: foreach my $value (@secondorder) {
1.36 matthew 1064: $result.=" <option value=\"$value\" ";
1.253 albertel 1065: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1066: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1067: }
1068: $result .= "</select>\n";
1069: # return $debug;
1070: return $result;
1071: } # end of sub linked_select_forms {
1072:
1.45 matthew 1073: =pod
1.44 bowersj2 1074:
1.648 raeburn 1075: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
1.44 bowersj2 1076:
1.112 bowersj2 1077: Returns a string corresponding to an HTML link to the given help
1078: $topic, where $topic corresponds to the name of a .tex file in
1079: /home/httpd/html/adm/help/tex, with underscores replaced by
1080: spaces.
1081:
1082: $text will optionally be linked to the same topic, allowing you to
1083: link text in addition to the graphic. If you do not want to link
1084: text, but wish to specify one of the later parameters, pass an
1085: empty string.
1086:
1087: $stayOnPage is a value that will be interpreted as a boolean. If true,
1088: the link will not open a new window. If false, the link will open
1089: a new window using Javascript. (Default is false.)
1090:
1091: $width and $height are optional numerical parameters that will
1092: override the width and height of the popped up window, which may
1093: be useful for certain help topics with big pictures included.
1.44 bowersj2 1094:
1095: =cut
1096:
1097: sub help_open_topic {
1.48 bowersj2 1098: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1099: $text = "" if (not defined $text);
1.44 bowersj2 1100: $stayOnPage = 0 if (not defined $stayOnPage);
1101: $width = 350 if (not defined $width);
1102: $height = 400 if (not defined $height);
1103: my $filename = $topic;
1104: $filename =~ s/ /_/g;
1105:
1.48 bowersj2 1106: my $template = "";
1107: my $link;
1.572 banghart 1108:
1.159 www 1109: $topic=~s/\W/\_/g;
1.44 bowersj2 1110:
1.572 banghart 1111: if (!$stayOnPage) {
1.72 bowersj2 1112: $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 1113: } else {
1.48 bowersj2 1114: $link = "/adm/help/${filename}.hlp";
1115: }
1116:
1117: # Add the text
1.755 neumanie 1118: if ($text ne "") {
1.763 bisitz 1119: $template.='<span class="LC_help_open_topic">'
1120: .'<a target="_top" href="'.$link.'">'
1121: .$text.'</a>';
1.48 bowersj2 1122: }
1123:
1.763 bisitz 1124: # (Always) Add the graphic
1.179 matthew 1125: my $title = &mt('Online Help');
1.667 raeburn 1126: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.763 bisitz 1127: $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
1128: .'<img src="'.$helpicon.'" border="0"'
1129: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.934 droeschl 1130: .' title="'.$title.'" style="vertical-align:middle;"'
1.763 bisitz 1131: .' /></a>';
1132: if ($text ne "") {
1133: $template.='</span>';
1134: }
1.44 bowersj2 1135: return $template;
1136:
1.106 bowersj2 1137: }
1138:
1139: # This is a quicky function for Latex cheatsheet editing, since it
1140: # appears in at least four places
1141: sub helpLatexCheatsheet {
1.732 raeburn 1142: my ($topic,$text,$not_author) = @_;
1143: my $out;
1.106 bowersj2 1144: my $addOther = '';
1.732 raeburn 1145: if ($topic) {
1.763 bisitz 1146: $addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
1147: undef, undef, 600).
1148: '</span> ';
1149: }
1150: $out = '<span>' # Start cheatsheet
1151: .$addOther
1152: .'<span>'
1153: .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
1154: undef,undef,600)
1155: .'</span> <span>'
1156: .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
1157: undef,undef,600)
1158: .'</span>';
1.732 raeburn 1159: unless ($not_author) {
1.763 bisitz 1160: $out .= ' <span>'
1161: .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
1162: undef,undef,600)
1163: .'</span>';
1.732 raeburn 1164: }
1.763 bisitz 1165: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1166: return $out;
1.172 www 1167: }
1168:
1.430 albertel 1169: sub general_help {
1170: my $helptopic='Student_Intro';
1171: if ($env{'request.role'}=~/^(ca|au)/) {
1172: $helptopic='Authoring_Intro';
1.907 raeburn 1173: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1174: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1175: } elsif ($env{'request.role'}=~/^dc/) {
1176: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1177: }
1178: return $helptopic;
1179: }
1180:
1181: sub update_help_link {
1182: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1183: my $origurl = $ENV{'REQUEST_URI'};
1184: $origurl=~s|^/~|/priv/|;
1185: my $timestamp = time;
1186: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1187: $$datum = &escape($$datum);
1188: }
1189:
1190: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1191: my $output .= <<"ENDOUTPUT";
1192: <script type="text/javascript">
1.824 bisitz 1193: // <![CDATA[
1.430 albertel 1194: banner_link = '$banner_link';
1.824 bisitz 1195: // ]]>
1.430 albertel 1196: </script>
1197: ENDOUTPUT
1198: return $output;
1199: }
1200:
1201: # now just updates the help link and generates a blue icon
1.193 raeburn 1202: sub help_open_menu {
1.430 albertel 1203: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1204: = @_;
1.430 albertel 1205: $stayOnPage = 0 if (not defined $stayOnPage);
1.572 banghart 1206: # only use pop-up help (stayOnPage == 0)
1.552 banghart 1207: # if environment.remote is on (using remote control UI)
1.798 tempelho 1208: if ($env{'environment.remote'} eq 'off' ) {
1.552 banghart 1209: $stayOnPage=1;
1.430 albertel 1210: }
1211: my $output;
1212: if ($component_help) {
1213: if (!$text) {
1214: $output=&help_open_topic($component_help,undef,$stayOnPage,
1215: $width,$height);
1216: } else {
1217: my $help_text;
1218: $help_text=&unescape($topic);
1219: $output='<table><tr><td>'.
1220: &help_open_topic($component_help,$help_text,$stayOnPage,
1221: $width,$height).'</td></tr></table>';
1222: }
1223: }
1224: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1225: return $output.$banner_link;
1226: }
1227:
1228: sub top_nav_help {
1229: my ($text) = @_;
1.436 albertel 1230: $text = &mt($text);
1.572 banghart 1231: my $stay_on_page =
1.798 tempelho 1232: ($env{'environment.remote'} eq 'off' );
1.572 banghart 1233: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1234: : "javascript:helpMenu('open')";
1.572 banghart 1235: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1236:
1.201 raeburn 1237: my $title = &mt('Get help');
1.436 albertel 1238:
1239: return <<"END";
1240: $banner_link
1241: <a href="$link" title="$title">$text</a>
1242: END
1243: }
1244:
1245: sub help_menu_js {
1246: my ($text) = @_;
1247:
1248: my $stayOnPage =
1.798 tempelho 1249: ($env{'environment.remote'} eq 'off' );
1.436 albertel 1250:
1251: my $width = 620;
1252: my $height = 600;
1.430 albertel 1253: my $helptopic=&general_help();
1254: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1255: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1256: my $start_page =
1257: &Apache::loncommon::start_page('Help Menu', undef,
1258: {'frameset' => 1,
1259: 'js_ready' => 1,
1260: 'add_entries' => {
1261: 'border' => '0',
1.579 raeburn 1262: 'rows' => "110,*",},});
1.331 albertel 1263: my $end_page =
1264: &Apache::loncommon::end_page({'frameset' => 1,
1265: 'js_ready' => 1,});
1266:
1.436 albertel 1267: my $template .= <<"ENDTEMPLATE";
1268: <script type="text/javascript">
1.877 bisitz 1269: // <![CDATA[
1.253 albertel 1270: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1271: var banner_link = '';
1.243 raeburn 1272: function helpMenu(target) {
1273: var caller = this;
1274: if (target == 'open') {
1275: var newWindow = null;
1276: try {
1.262 albertel 1277: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1278: }
1279: catch(error) {
1280: writeHelp(caller);
1281: return;
1282: }
1283: if (newWindow) {
1284: caller = newWindow;
1285: }
1.193 raeburn 1286: }
1.243 raeburn 1287: writeHelp(caller);
1288: return;
1289: }
1290: function writeHelp(caller) {
1.430 albertel 1291: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243 raeburn 1292: caller.document.close()
1293: caller.focus()
1.193 raeburn 1294: }
1.877 bisitz 1295: // END LON-CAPA Internal -->
1.253 albertel 1296: // ]]>
1.436 albertel 1297: </script>
1.193 raeburn 1298: ENDTEMPLATE
1299: return $template;
1300: }
1301:
1.172 www 1302: sub help_open_bug {
1303: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1304: unless ($env{'user.adv'}) { return ''; }
1.172 www 1305: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1306: $text = "" if (not defined $text);
1307: $stayOnPage = 0 if (not defined $stayOnPage);
1.798 tempelho 1308: if ($env{'environment.remote'} eq 'off' ) {
1.172 www 1309: $stayOnPage=1;
1310: }
1.184 albertel 1311: $width = 600 if (not defined $width);
1312: $height = 600 if (not defined $height);
1.172 www 1313:
1314: $topic=~s/\W+/\+/g;
1315: my $link='';
1316: my $template='';
1.379 albertel 1317: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1318: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1319: if (!$stayOnPage)
1320: {
1321: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1322: }
1323: else
1324: {
1325: $link = $url;
1326: }
1327: # Add the text
1328: if ($text ne "")
1329: {
1330: $template .=
1331: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1332: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1333: }
1334:
1335: # Add the graphic
1.179 matthew 1336: my $title = &mt('Report a Bug');
1.215 albertel 1337: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1338: $template .= <<"ENDTEMPLATE";
1.436 albertel 1339: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1340: ENDTEMPLATE
1341: if ($text ne '') { $template.='</td></tr></table>' };
1342: return $template;
1343:
1344: }
1345:
1346: sub help_open_faq {
1347: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1348: unless ($env{'user.adv'}) { return ''; }
1.172 www 1349: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1350: $text = "" if (not defined $text);
1351: $stayOnPage = 0 if (not defined $stayOnPage);
1.798 tempelho 1352: if ($env{'environment.remote'} eq 'off' ) {
1.172 www 1353: $stayOnPage=1;
1354: }
1355: $width = 350 if (not defined $width);
1356: $height = 400 if (not defined $height);
1357:
1358: $topic=~s/\W+/\+/g;
1359: my $link='';
1360: my $template='';
1361: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1362: if (!$stayOnPage)
1363: {
1364: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1365: }
1366: else
1367: {
1368: $link = $url;
1369: }
1370:
1371: # Add the text
1372: if ($text ne "")
1373: {
1374: $template .=
1.173 www 1375: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1376: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1377: }
1378:
1379: # Add the graphic
1.179 matthew 1380: my $title = &mt('View the FAQ');
1.215 albertel 1381: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1382: $template .= <<"ENDTEMPLATE";
1.436 albertel 1383: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1384: ENDTEMPLATE
1385: if ($text ne '') { $template.='</td></tr></table>' };
1386: return $template;
1387:
1.44 bowersj2 1388: }
1.37 matthew 1389:
1.180 matthew 1390: ###############################################################
1391: ###############################################################
1392:
1.45 matthew 1393: =pod
1394:
1.648 raeburn 1395: =item * &change_content_javascript():
1.256 matthew 1396:
1397: This and the next function allow you to create small sections of an
1398: otherwise static HTML page that you can update on the fly with
1399: Javascript, even in Netscape 4.
1400:
1401: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1402: must be written to the HTML page once. It will prove the Javascript
1403: function "change(name, content)". Calling the change function with the
1404: name of the section
1405: you want to update, matching the name passed to C<changable_area>, and
1406: the new content you want to put in there, will put the content into
1407: that area.
1408:
1409: B<Note>: Netscape 4 only reserves enough space for the changable area
1410: to contain room for the original contents. You need to "make space"
1411: for whatever changes you wish to make, and be B<sure> to check your
1412: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1413: it's adequate for updating a one-line status display, but little more.
1414: This script will set the space to 100% width, so you only need to
1415: worry about height in Netscape 4.
1416:
1417: Modern browsers are much less limiting, and if you can commit to the
1418: user not using Netscape 4, this feature may be used freely with
1419: pretty much any HTML.
1420:
1421: =cut
1422:
1423: sub change_content_javascript {
1424: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1425: if ($env{'browser.type'} eq 'netscape' &&
1426: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1427: return (<<NETSCAPE4);
1428: function change(name, content) {
1429: doc = document.layers[name+"___escape"].layers[0].document;
1430: doc.open();
1431: doc.write(content);
1432: doc.close();
1433: }
1434: NETSCAPE4
1435: } else {
1436: # Otherwise, we need to use semi-standards-compliant code
1437: # (technically, "innerHTML" isn't standard but the equivalent
1438: # is really scary, and every useful browser supports it
1439: return (<<DOMBASED);
1440: function change(name, content) {
1441: element = document.getElementById(name);
1442: element.innerHTML = content;
1443: }
1444: DOMBASED
1445: }
1446: }
1447:
1448: =pod
1449:
1.648 raeburn 1450: =item * &changable_area($name,$origContent):
1.256 matthew 1451:
1452: This provides a "changable area" that can be modified on the fly via
1453: the Javascript code provided in C<change_content_javascript>. $name is
1454: the name you will use to reference the area later; do not repeat the
1455: same name on a given HTML page more then once. $origContent is what
1456: the area will originally contain, which can be left blank.
1457:
1458: =cut
1459:
1460: sub changable_area {
1461: my ($name, $origContent) = @_;
1462:
1.258 albertel 1463: if ($env{'browser.type'} eq 'netscape' &&
1464: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1465: # If this is netscape 4, we need to use the Layer tag
1466: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1467: } else {
1468: return "<span id='$name'>$origContent</span>";
1469: }
1470: }
1471:
1472: =pod
1473:
1.648 raeburn 1474: =item * &viewport_geometry_js
1.590 raeburn 1475:
1476: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1477:
1478: =cut
1479:
1480:
1481: sub viewport_geometry_js {
1482: return <<"GEOMETRY";
1483: var Geometry = {};
1484: function init_geometry() {
1485: if (Geometry.init) { return };
1486: Geometry.init=1;
1487: if (window.innerHeight) {
1488: Geometry.getViewportHeight = function() { return window.innerHeight; };
1489: Geometry.getViewportWidth = function() { return window.innerWidth; };
1490: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1491: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1492: }
1493: else if (document.documentElement && document.documentElement.clientHeight) {
1494: Geometry.getViewportHeight =
1495: function() { return document.documentElement.clientHeight; };
1496: Geometry.getViewportWidth =
1497: function() { return document.documentElement.clientWidth; };
1498:
1499: Geometry.getHorizontalScroll =
1500: function() { return document.documentElement.scrollLeft; };
1501: Geometry.getVerticalScroll =
1502: function() { return document.documentElement.scrollTop; };
1503: }
1504: else if (document.body.clientHeight) {
1505: Geometry.getViewportHeight =
1506: function() { return document.body.clientHeight; };
1507: Geometry.getViewportWidth =
1508: function() { return document.body.clientWidth; };
1509: Geometry.getHorizontalScroll =
1510: function() { return document.body.scrollLeft; };
1511: Geometry.getVerticalScroll =
1512: function() { return document.body.scrollTop; };
1513: }
1514: }
1515:
1516: GEOMETRY
1517: }
1518:
1519: =pod
1520:
1.648 raeburn 1521: =item * &viewport_size_js()
1.590 raeburn 1522:
1523: 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.
1524:
1525: =cut
1526:
1527: sub viewport_size_js {
1528: my $geometry = &viewport_geometry_js();
1529: return <<"DIMS";
1530:
1531: $geometry
1532:
1533: function getViewportDims(width,height) {
1534: init_geometry();
1535: width.value = Geometry.getViewportWidth();
1536: height.value = Geometry.getViewportHeight();
1537: return;
1538: }
1539:
1540: DIMS
1541: }
1542:
1543: =pod
1544:
1.648 raeburn 1545: =item * &resize_textarea_js()
1.565 albertel 1546:
1547: emits the needed javascript to resize a textarea to be as big as possible
1548:
1549: creates a function resize_textrea that takes two IDs first should be
1550: the id of the element to resize, second should be the id of a div that
1551: surrounds everything that comes after the textarea, this routine needs
1552: to be attached to the <body> for the onload and onresize events.
1553:
1.648 raeburn 1554: =back
1.565 albertel 1555:
1556: =cut
1557:
1558: sub resize_textarea_js {
1.590 raeburn 1559: my $geometry = &viewport_geometry_js();
1.565 albertel 1560: return <<"RESIZE";
1561: <script type="text/javascript">
1.824 bisitz 1562: // <![CDATA[
1.590 raeburn 1563: $geometry
1.565 albertel 1564:
1.588 albertel 1565: function getX(element) {
1566: var x = 0;
1567: while (element) {
1568: x += element.offsetLeft;
1569: element = element.offsetParent;
1570: }
1571: return x;
1572: }
1573: function getY(element) {
1574: var y = 0;
1575: while (element) {
1576: y += element.offsetTop;
1577: element = element.offsetParent;
1578: }
1579: return y;
1580: }
1581:
1582:
1.565 albertel 1583: function resize_textarea(textarea_id,bottom_id) {
1584: init_geometry();
1585: var textarea = document.getElementById(textarea_id);
1586: //alert(textarea);
1587:
1.588 albertel 1588: var textarea_top = getY(textarea);
1.565 albertel 1589: var textarea_height = textarea.offsetHeight;
1590: var bottom = document.getElementById(bottom_id);
1.588 albertel 1591: var bottom_top = getY(bottom);
1.565 albertel 1592: var bottom_height = bottom.offsetHeight;
1593: var window_height = Geometry.getViewportHeight();
1.588 albertel 1594: var fudge = 23;
1.565 albertel 1595: var new_height = window_height-fudge-textarea_top-bottom_height;
1596: if (new_height < 300) {
1597: new_height = 300;
1598: }
1599: textarea.style.height=new_height+'px';
1600: }
1.824 bisitz 1601: // ]]>
1.565 albertel 1602: </script>
1603: RESIZE
1604:
1605: }
1606:
1607: =pod
1608:
1.256 matthew 1609: =head1 Excel and CSV file utility routines
1610:
1611: =over 4
1612:
1613: =cut
1614:
1615: ###############################################################
1616: ###############################################################
1617:
1618: =pod
1619:
1.648 raeburn 1620: =item * &csv_translate($text)
1.37 matthew 1621:
1.185 www 1622: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1623: format.
1624:
1625: =cut
1626:
1.180 matthew 1627: ###############################################################
1628: ###############################################################
1.37 matthew 1629: sub csv_translate {
1630: my $text = shift;
1631: $text =~ s/\"/\"\"/g;
1.209 albertel 1632: $text =~ s/\n/ /g;
1.37 matthew 1633: return $text;
1634: }
1.180 matthew 1635:
1636: ###############################################################
1637: ###############################################################
1638:
1639: =pod
1640:
1.648 raeburn 1641: =item * &define_excel_formats()
1.180 matthew 1642:
1643: Define some commonly used Excel cell formats.
1644:
1645: Currently supported formats:
1646:
1647: =over 4
1648:
1649: =item header
1650:
1651: =item bold
1652:
1653: =item h1
1654:
1655: =item h2
1656:
1657: =item h3
1658:
1.256 matthew 1659: =item h4
1660:
1661: =item i
1662:
1.180 matthew 1663: =item date
1664:
1665: =back
1666:
1667: Inputs: $workbook
1668:
1669: Returns: $format, a hash reference.
1670:
1671: =cut
1672:
1673: ###############################################################
1674: ###############################################################
1675: sub define_excel_formats {
1676: my ($workbook) = @_;
1677: my $format;
1678: $format->{'header'} = $workbook->add_format(bold => 1,
1679: bottom => 1,
1680: align => 'center');
1681: $format->{'bold'} = $workbook->add_format(bold=>1);
1682: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1683: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1684: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1685: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1686: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1687: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1688: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1689: return $format;
1690: }
1691:
1692: ###############################################################
1693: ###############################################################
1.113 bowersj2 1694:
1695: =pod
1696:
1.648 raeburn 1697: =item * &create_workbook()
1.255 matthew 1698:
1699: Create an Excel worksheet. If it fails, output message on the
1700: request object and return undefs.
1701:
1702: Inputs: Apache request object
1703:
1704: Returns (undef) on failure,
1705: Excel worksheet object, scalar with filename, and formats
1706: from &Apache::loncommon::define_excel_formats on success
1707:
1708: =cut
1709:
1710: ###############################################################
1711: ###############################################################
1712: sub create_workbook {
1713: my ($r) = @_;
1714: #
1715: # Create the excel spreadsheet
1716: my $filename = '/prtspool/'.
1.258 albertel 1717: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1718: time.'_'.rand(1000000000).'.xls';
1719: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1720: if (! defined($workbook)) {
1721: $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928 bisitz 1722: $r->print(
1723: '<p class="LC_error">'
1724: .&mt('Problems occurred in creating the new Excel file.')
1725: .' '.&mt('This error has been logged.')
1726: .' '.&mt('Please alert your LON-CAPA administrator.')
1727: .'</p>'
1728: );
1.255 matthew 1729: return (undef);
1730: }
1731: #
1732: $workbook->set_tempdir('/home/httpd/perl/tmp');
1733: #
1734: my $format = &Apache::loncommon::define_excel_formats($workbook);
1735: return ($workbook,$filename,$format);
1736: }
1737:
1738: ###############################################################
1739: ###############################################################
1740:
1741: =pod
1742:
1.648 raeburn 1743: =item * &create_text_file()
1.113 bowersj2 1744:
1.542 raeburn 1745: Create a file to write to and eventually make available to the user.
1.256 matthew 1746: If file creation fails, outputs an error message on the request object and
1747: return undefs.
1.113 bowersj2 1748:
1.256 matthew 1749: Inputs: Apache request object, and file suffix
1.113 bowersj2 1750:
1.256 matthew 1751: Returns (undef) on failure,
1752: Filehandle and filename on success.
1.113 bowersj2 1753:
1754: =cut
1755:
1.256 matthew 1756: ###############################################################
1757: ###############################################################
1758: sub create_text_file {
1759: my ($r,$suffix) = @_;
1760: if (! defined($suffix)) { $suffix = 'txt'; };
1761: my $fh;
1762: my $filename = '/prtspool/'.
1.258 albertel 1763: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1764: time.'_'.rand(1000000000).'.'.$suffix;
1765: $fh = Apache::File->new('>/home/httpd'.$filename);
1766: if (! defined($fh)) {
1767: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 1768: $r->print(
1769: '<p class="LC_error">'
1770: .&mt('Problems occurred in creating the output file.')
1771: .' '.&mt('This error has been logged.')
1772: .' '.&mt('Please alert your LON-CAPA administrator.')
1773: .'</p>'
1774: );
1.113 bowersj2 1775: }
1.256 matthew 1776: return ($fh,$filename)
1.113 bowersj2 1777: }
1778:
1779:
1.256 matthew 1780: =pod
1.113 bowersj2 1781:
1782: =back
1783:
1784: =cut
1.37 matthew 1785:
1786: ###############################################################
1.33 matthew 1787: ## Home server <option> list generating code ##
1788: ###############################################################
1.35 matthew 1789:
1.169 www 1790: # ------------------------------------------
1791:
1792: sub domain_select {
1793: my ($name,$value,$multiple)=@_;
1794: my %domains=map {
1.514 albertel 1795: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1796: } &Apache::lonnet::all_domains();
1.169 www 1797: if ($multiple) {
1798: $domains{''}=&mt('Any domain');
1.550 albertel 1799: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1800: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1801: } else {
1.550 albertel 1802: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169 www 1803: return &select_form($name,$value,%domains);
1804: }
1805: }
1806:
1.282 albertel 1807: #-------------------------------------------
1808:
1809: =pod
1810:
1.519 raeburn 1811: =head1 Routines for form select boxes
1812:
1813: =over 4
1814:
1.648 raeburn 1815: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1816:
1817: Returns a string containing a <select> element int multiple mode
1818:
1819:
1820: Args:
1821: $name - name of the <select> element
1.506 raeburn 1822: $value - scalar or array ref of values that should already be selected
1.282 albertel 1823: $size - number of rows long the select element is
1.283 albertel 1824: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1825: (shown text should already have been &mt())
1.506 raeburn 1826: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1827:
1.282 albertel 1828: =cut
1829:
1830: #-------------------------------------------
1.169 www 1831: sub multiple_select_form {
1.284 albertel 1832: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1833: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1834: my $output='';
1.191 matthew 1835: if (! defined($size)) {
1836: $size = 4;
1.283 albertel 1837: if (scalar(keys(%$hash))<4) {
1838: $size = scalar(keys(%$hash));
1.191 matthew 1839: }
1840: }
1.734 bisitz 1841: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1842: my @order;
1.506 raeburn 1843: if (ref($order) eq 'ARRAY') {
1844: @order = @{$order};
1845: } else {
1846: @order = sort(keys(%$hash));
1.501 banghart 1847: }
1848: if (exists($$hash{'select_form_order'})) {
1849: @order = @{$$hash{'select_form_order'}};
1850: }
1851:
1.284 albertel 1852: foreach my $key (@order) {
1.356 albertel 1853: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1854: $output.='selected="selected" ' if ($selected{$key});
1855: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1856: }
1857: $output.="</select>\n";
1858: return $output;
1859: }
1860:
1.88 www 1861: #-------------------------------------------
1862:
1863: =pod
1864:
1.648 raeburn 1865: =item * &select_form($defdom,$name,%hash)
1.88 www 1866:
1867: Returns a string containing a <select name='$name' size='1'> form to
1868: allow a user to select options from a hash option_name => displayed text.
1869: See lonrights.pm for an example invocation and use.
1870:
1871: =cut
1872:
1873: #-------------------------------------------
1874: sub select_form {
1875: my ($def,$name,%hash) = @_;
1876: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128 albertel 1877: my @keys;
1878: if (exists($hash{'select_form_order'})) {
1879: @keys=@{$hash{'select_form_order'}};
1880: } else {
1881: @keys=sort(keys(%hash));
1882: }
1.356 albertel 1883: foreach my $key (@keys) {
1884: $selectform.=
1885: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1886: ($key eq $def ? 'selected="selected" ' : '').
1.922 bisitz 1887: ">".$hash{$key}."</option>\n";
1.88 www 1888: }
1889: $selectform.="</select>";
1890: return $selectform;
1891: }
1892:
1.475 www 1893: # For display filters
1894:
1895: sub display_filter {
1896: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1897: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714 bisitz 1898: return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475 www 1899: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1900: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 1901: '</label></span> <span class="LC_nobreak">'.
1.475 www 1902: &mt('Filter [_1]',
1.477 www 1903: &select_form($env{'form.displayfilter'},
1904: 'displayfilter',
1905: ('currentfolder' => 'Current folder/page',
1906: 'containing' => 'Containing phrase',
1907: 'none' => 'None'))).
1.714 bisitz 1908: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475 www 1909: }
1910:
1.167 www 1911: sub gradeleveldescription {
1912: my $gradelevel=shift;
1913: my %gradelevels=(0 => 'Not specified',
1914: 1 => 'Grade 1',
1915: 2 => 'Grade 2',
1916: 3 => 'Grade 3',
1917: 4 => 'Grade 4',
1918: 5 => 'Grade 5',
1919: 6 => 'Grade 6',
1920: 7 => 'Grade 7',
1921: 8 => 'Grade 8',
1922: 9 => 'Grade 9',
1923: 10 => 'Grade 10',
1924: 11 => 'Grade 11',
1925: 12 => 'Grade 12',
1926: 13 => 'Grade 13',
1927: 14 => '100 Level',
1928: 15 => '200 Level',
1929: 16 => '300 Level',
1930: 17 => '400 Level',
1931: 18 => 'Graduate Level');
1932: return &mt($gradelevels{$gradelevel});
1933: }
1934:
1.163 www 1935: sub select_level_form {
1936: my ($deflevel,$name)=@_;
1937: unless ($deflevel) { $deflevel=0; }
1.167 www 1938: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1939: for (my $i=0; $i<=18; $i++) {
1940: $selectform.="<option value=\"$i\" ".
1.253 albertel 1941: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1942: ">".&gradeleveldescription($i)."</option>\n";
1943: }
1944: $selectform.="</select>";
1945: return $selectform;
1.163 www 1946: }
1.167 www 1947:
1.35 matthew 1948: #-------------------------------------------
1949:
1.45 matthew 1950: =pod
1951:
1.910 raeburn 1952: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35 matthew 1953:
1954: Returns a string containing a <select name='$name' size='1'> form to
1955: allow a user to select the domain to preform an operation in.
1956: See loncreateuser.pm for an example invocation and use.
1957:
1.90 www 1958: If the $includeempty flag is set, it also includes an empty choice ("no domain
1959: selected");
1960:
1.743 raeburn 1961: If the $showdomdesc flag is set, the domain name is followed by the domain description.
1962:
1.910 raeburn 1963: The optional $onchange argument specifies what should occur if the domain selector is changed, e.g., 'this.form.submit()' if the form is to be automatically submitted.
1964:
1965: The optional $incdoms is a reference to an array of domains which will be the only available options.
1.563 raeburn 1966:
1.35 matthew 1967: =cut
1968:
1969: #-------------------------------------------
1.34 matthew 1970: sub select_dom_form {
1.910 raeburn 1971: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.872 raeburn 1972: if ($onchange) {
1.874 raeburn 1973: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 1974: }
1.910 raeburn 1975: my @domains;
1976: if (ref($incdoms) eq 'ARRAY') {
1977: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
1978: } else {
1979: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1980: }
1.90 www 1981: if ($includeempty) { @domains=('',@domains); }
1.743 raeburn 1982: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 1983: foreach my $dom (@domains) {
1984: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 1985: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
1986: if ($showdomdesc) {
1987: if ($dom ne '') {
1988: my $domdesc = &Apache::lonnet::domain($dom,'description');
1989: if ($domdesc ne '') {
1990: $selectdomain .= ' ('.$domdesc.')';
1991: }
1992: }
1993: }
1994: $selectdomain .= "</option>\n";
1.34 matthew 1995: }
1996: $selectdomain.="</select>";
1997: return $selectdomain;
1998: }
1999:
1.35 matthew 2000: #-------------------------------------------
2001:
1.45 matthew 2002: =pod
2003:
1.648 raeburn 2004: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 2005:
1.586 raeburn 2006: input: 4 arguments (two required, two optional) -
2007: $domain - domain of new user
2008: $name - name of form element
2009: $default - Value of 'default' causes a default item to be first
2010: option, and selected by default.
2011: $hide - Value of 'hide' causes hiding of the name of the server,
2012: if 1 server found, or default, if 0 found.
1.594 raeburn 2013: output: returns 2 items:
1.586 raeburn 2014: (a) form element which contains either:
2015: (i) <select name="$name">
2016: <option value="$hostid1">$hostid $servers{$hostid}</option>
2017: <option value="$hostid2">$hostid $servers{$hostid}</option>
2018: </select>
2019: form item if there are multiple library servers in $domain, or
2020: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2021: if there is only one library server in $domain.
2022:
2023: (b) number of library servers found.
2024:
2025: See loncreateuser.pm for example of use.
1.35 matthew 2026:
2027: =cut
2028:
2029: #-------------------------------------------
1.586 raeburn 2030: sub home_server_form_item {
2031: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2032: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2033: my $result;
2034: my $numlib = keys(%servers);
2035: if ($numlib > 1) {
2036: $result .= '<select name="'.$name.'" />'."\n";
2037: if ($default) {
1.804 bisitz 2038: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 2039: '</option>'."\n";
2040: }
2041: foreach my $hostid (sort(keys(%servers))) {
2042: $result.= '<option value="'.$hostid.'">'.
2043: $hostid.' '.$servers{$hostid}."</option>\n";
2044: }
2045: $result .= '</select>'."\n";
2046: } elsif ($numlib == 1) {
2047: my $hostid;
2048: foreach my $item (keys(%servers)) {
2049: $hostid = $item;
2050: }
2051: $result .= '<input type="hidden" name="'.$name.'" value="'.
2052: $hostid.'" />';
2053: if (!$hide) {
2054: $result .= $hostid.' '.$servers{$hostid};
2055: }
2056: $result .= "\n";
2057: } elsif ($default) {
2058: $result .= '<input type="hidden" name="'.$name.
2059: '" value="default" />';
2060: if (!$hide) {
2061: $result .= &mt('default');
2062: }
2063: $result .= "\n";
1.33 matthew 2064: }
1.586 raeburn 2065: return ($result,$numlib);
1.33 matthew 2066: }
1.112 bowersj2 2067:
2068: =pod
2069:
1.534 albertel 2070: =back
2071:
1.112 bowersj2 2072: =cut
1.87 matthew 2073:
2074: ###############################################################
1.112 bowersj2 2075: ## Decoding User Agent ##
1.87 matthew 2076: ###############################################################
2077:
2078: =pod
2079:
1.112 bowersj2 2080: =head1 Decoding the User Agent
2081:
2082: =over 4
2083:
2084: =item * &decode_user_agent()
1.87 matthew 2085:
2086: Inputs: $r
2087:
2088: Outputs:
2089:
2090: =over 4
2091:
1.112 bowersj2 2092: =item * $httpbrowser
1.87 matthew 2093:
1.112 bowersj2 2094: =item * $clientbrowser
1.87 matthew 2095:
1.112 bowersj2 2096: =item * $clientversion
1.87 matthew 2097:
1.112 bowersj2 2098: =item * $clientmathml
1.87 matthew 2099:
1.112 bowersj2 2100: =item * $clientunicode
1.87 matthew 2101:
1.112 bowersj2 2102: =item * $clientos
1.87 matthew 2103:
2104: =back
2105:
1.157 matthew 2106: =back
2107:
1.87 matthew 2108: =cut
2109:
2110: ###############################################################
2111: ###############################################################
2112: sub decode_user_agent {
1.247 albertel 2113: my ($r)=@_;
1.87 matthew 2114: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2115: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2116: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2117: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2118: my $clientbrowser='unknown';
2119: my $clientversion='0';
2120: my $clientmathml='';
2121: my $clientunicode='0';
2122: for (my $i=0;$i<=$#browsertype;$i++) {
2123: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
2124: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2125: $clientbrowser=$bname;
2126: $httpbrowser=~/$vreg/i;
2127: $clientversion=$1;
2128: $clientmathml=($clientversion>=$minv);
2129: $clientunicode=($clientversion>=$univ);
2130: }
2131: }
2132: my $clientos='unknown';
2133: if (($httpbrowser=~/linux/i) ||
2134: ($httpbrowser=~/unix/i) ||
2135: ($httpbrowser=~/ux/i) ||
2136: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2137: if (($httpbrowser=~/vax/i) ||
2138: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2139: if ($httpbrowser=~/next/i) { $clientos='next'; }
2140: if (($httpbrowser=~/mac/i) ||
2141: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
2142: if ($httpbrowser=~/win/i) { $clientos='win'; }
2143: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
2144: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
2145: $clientunicode,$clientos,);
2146: }
2147:
1.32 matthew 2148: ###############################################################
2149: ## Authentication changing form generation subroutines ##
2150: ###############################################################
2151: ##
2152: ## All of the authform_xxxxxxx subroutines take their inputs in a
2153: ## hash, and have reasonable default values.
2154: ##
2155: ## formname = the name given in the <form> tag.
1.35 matthew 2156: #-------------------------------------------
2157:
1.45 matthew 2158: =pod
2159:
1.112 bowersj2 2160: =head1 Authentication Routines
2161:
2162: =over 4
2163:
1.648 raeburn 2164: =item * &authform_xxxxxx()
1.35 matthew 2165:
2166: The authform_xxxxxx subroutines provide javascript and html forms which
2167: handle some of the conveniences required for authentication forms.
2168: This is not an optimal method, but it works.
2169:
2170: =over 4
2171:
1.112 bowersj2 2172: =item * authform_header
1.35 matthew 2173:
1.112 bowersj2 2174: =item * authform_authorwarning
1.35 matthew 2175:
1.112 bowersj2 2176: =item * authform_nochange
1.35 matthew 2177:
1.112 bowersj2 2178: =item * authform_kerberos
1.35 matthew 2179:
1.112 bowersj2 2180: =item * authform_internal
1.35 matthew 2181:
1.112 bowersj2 2182: =item * authform_filesystem
1.35 matthew 2183:
2184: =back
2185:
1.648 raeburn 2186: See loncreateuser.pm for invocation and use examples.
1.157 matthew 2187:
1.35 matthew 2188: =cut
2189:
2190: #-------------------------------------------
1.32 matthew 2191: sub authform_header{
2192: my %in = (
2193: formname => 'cu',
1.80 albertel 2194: kerb_def_dom => '',
1.32 matthew 2195: @_,
2196: );
2197: $in{'formname'} = 'document.' . $in{'formname'};
2198: my $result='';
1.80 albertel 2199:
2200: #---------------------------------------------- Code for upper case translation
2201: my $Javascript_toUpperCase;
2202: unless ($in{kerb_def_dom}) {
2203: $Javascript_toUpperCase =<<"END";
2204: switch (choice) {
2205: case 'krb': currentform.elements[choicearg].value =
2206: currentform.elements[choicearg].value.toUpperCase();
2207: break;
2208: default:
2209: }
2210: END
2211: } else {
2212: $Javascript_toUpperCase = "";
2213: }
2214:
1.165 raeburn 2215: my $radioval = "'nochange'";
1.591 raeburn 2216: if (defined($in{'curr_authtype'})) {
2217: if ($in{'curr_authtype'} ne '') {
2218: $radioval = "'".$in{'curr_authtype'}."arg'";
2219: }
1.174 matthew 2220: }
1.165 raeburn 2221: my $argfield = 'null';
1.591 raeburn 2222: if (defined($in{'mode'})) {
1.165 raeburn 2223: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2224: if (defined($in{'curr_autharg'})) {
2225: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2226: $argfield = "'$in{'curr_autharg'}'";
2227: }
2228: }
2229: }
2230: }
2231:
1.32 matthew 2232: $result.=<<"END";
2233: var current = new Object();
1.165 raeburn 2234: current.radiovalue = $radioval;
2235: current.argfield = $argfield;
1.32 matthew 2236:
2237: function changed_radio(choice,currentform) {
2238: var choicearg = choice + 'arg';
2239: // If a radio button in changed, we need to change the argfield
2240: if (current.radiovalue != choice) {
2241: current.radiovalue = choice;
2242: if (current.argfield != null) {
2243: currentform.elements[current.argfield].value = '';
2244: }
2245: if (choice == 'nochange') {
2246: current.argfield = null;
2247: } else {
2248: current.argfield = choicearg;
2249: switch(choice) {
2250: case 'krb':
2251: currentform.elements[current.argfield].value =
2252: "$in{'kerb_def_dom'}";
2253: break;
2254: default:
2255: break;
2256: }
2257: }
2258: }
2259: return;
2260: }
1.22 www 2261:
1.32 matthew 2262: function changed_text(choice,currentform) {
2263: var choicearg = choice + 'arg';
2264: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2265: $Javascript_toUpperCase
1.32 matthew 2266: // clear old field
2267: if ((current.argfield != choicearg) && (current.argfield != null)) {
2268: currentform.elements[current.argfield].value = '';
2269: }
2270: current.argfield = choicearg;
2271: }
2272: set_auth_radio_buttons(choice,currentform);
2273: return;
1.20 www 2274: }
1.32 matthew 2275:
2276: function set_auth_radio_buttons(newvalue,currentform) {
2277: var i=0;
2278: while (i < currentform.login.length) {
2279: if (currentform.login[i].value == newvalue) { break; }
2280: i++;
2281: }
2282: if (i == currentform.login.length) {
2283: return;
2284: }
2285: current.radiovalue = newvalue;
2286: currentform.login[i].checked = true;
2287: return;
2288: }
2289: END
2290: return $result;
2291: }
2292:
2293: sub authform_authorwarning{
2294: my $result='';
1.144 matthew 2295: $result='<i>'.
2296: &mt('As a general rule, only authors or co-authors should be '.
2297: 'filesystem authenticated '.
2298: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2299: return $result;
2300: }
2301:
2302: sub authform_nochange{
2303: my %in = (
2304: formname => 'document.cu',
2305: kerb_def_dom => 'MSU.EDU',
2306: @_,
2307: );
1.586 raeburn 2308: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2309: my $result;
2310: if (keys(%can_assign) == 0) {
2311: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2312: } else {
2313: $result = '<label>'.&mt('[_1] Do not change login data',
2314: '<input type="radio" name="login" value="nochange" '.
2315: 'checked="checked" onclick="'.
1.281 albertel 2316: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2317: '</label>';
1.586 raeburn 2318: }
1.32 matthew 2319: return $result;
2320: }
2321:
1.591 raeburn 2322: sub authform_kerberos {
1.32 matthew 2323: my %in = (
2324: formname => 'document.cu',
2325: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2326: kerb_def_auth => 'krb4',
1.32 matthew 2327: @_,
2328: );
1.586 raeburn 2329: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2330: $autharg,$jscall);
2331: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2332: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2333: $check5 = ' checked="checked"';
1.80 albertel 2334: } else {
1.772 bisitz 2335: $check4 = ' checked="checked"';
1.80 albertel 2336: }
1.165 raeburn 2337: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2338: if (defined($in{'curr_authtype'})) {
2339: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2340: $krbcheck = ' checked="checked"';
1.623 raeburn 2341: if (defined($in{'mode'})) {
2342: if ($in{'mode'} eq 'modifyuser') {
2343: $krbcheck = '';
2344: }
2345: }
1.591 raeburn 2346: if (defined($in{'curr_kerb_ver'})) {
2347: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2348: $check5 = ' checked="checked"';
1.591 raeburn 2349: $check4 = '';
2350: } else {
1.772 bisitz 2351: $check4 = ' checked="checked"';
1.591 raeburn 2352: $check5 = '';
2353: }
1.586 raeburn 2354: }
1.591 raeburn 2355: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2356: $krbarg = $in{'curr_autharg'};
2357: }
1.586 raeburn 2358: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2359: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2360: $result =
2361: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2362: $in{'curr_autharg'},$krbver);
2363: } else {
2364: $result =
2365: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2366: }
2367: return $result;
2368: }
2369: }
2370: } else {
2371: if ($authnum == 1) {
1.784 bisitz 2372: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2373: }
2374: }
1.586 raeburn 2375: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2376: return;
1.587 raeburn 2377: } elsif ($authtype eq '') {
1.591 raeburn 2378: if (defined($in{'mode'})) {
1.587 raeburn 2379: if ($in{'mode'} eq 'modifycourse') {
2380: if ($authnum == 1) {
1.784 bisitz 2381: $authtype = '<input type="hidden" name="login" value="krb" />';
1.587 raeburn 2382: }
2383: }
2384: }
1.586 raeburn 2385: }
2386: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2387: if ($authtype eq '') {
2388: $authtype = '<input type="radio" name="login" value="krb" '.
2389: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2390: $krbcheck.' />';
2391: }
2392: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2393: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2394: $in{'curr_authtype'} eq 'krb5') ||
2395: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2396: $in{'curr_authtype'} eq 'krb4')) {
2397: $result .= &mt
1.144 matthew 2398: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2399: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2400: '<label>'.$authtype,
1.281 albertel 2401: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2402: 'value="'.$krbarg.'" '.
1.144 matthew 2403: 'onchange="'.$jscall.'" />',
1.281 albertel 2404: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2405: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2406: '</label>');
1.586 raeburn 2407: } elsif ($can_assign{'krb4'}) {
2408: $result .= &mt
2409: ('[_1] Kerberos authenticated with domain [_2] '.
2410: '[_3] Version 4 [_4]',
2411: '<label>'.$authtype,
2412: '</label><input type="text" size="10" name="krbarg" '.
2413: 'value="'.$krbarg.'" '.
2414: 'onchange="'.$jscall.'" />',
2415: '<label><input type="hidden" name="krbver" value="4" />',
2416: '</label>');
2417: } elsif ($can_assign{'krb5'}) {
2418: $result .= &mt
2419: ('[_1] Kerberos authenticated with domain [_2] '.
2420: '[_3] Version 5 [_4]',
2421: '<label>'.$authtype,
2422: '</label><input type="text" size="10" name="krbarg" '.
2423: 'value="'.$krbarg.'" '.
2424: 'onchange="'.$jscall.'" />',
2425: '<label><input type="hidden" name="krbver" value="5" />',
2426: '</label>');
2427: }
1.32 matthew 2428: return $result;
2429: }
2430:
2431: sub authform_internal{
1.586 raeburn 2432: my %in = (
1.32 matthew 2433: formname => 'document.cu',
2434: kerb_def_dom => 'MSU.EDU',
2435: @_,
2436: );
1.586 raeburn 2437: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2438: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2439: if (defined($in{'curr_authtype'})) {
2440: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2441: if ($can_assign{'int'}) {
1.772 bisitz 2442: $intcheck = 'checked="checked" ';
1.623 raeburn 2443: if (defined($in{'mode'})) {
2444: if ($in{'mode'} eq 'modifyuser') {
2445: $intcheck = '';
2446: }
2447: }
1.591 raeburn 2448: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2449: $intarg = $in{'curr_autharg'};
2450: }
2451: } else {
2452: $result = &mt('Currently internally authenticated.');
2453: return $result;
1.165 raeburn 2454: }
2455: }
1.586 raeburn 2456: } else {
2457: if ($authnum == 1) {
1.784 bisitz 2458: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 2459: }
2460: }
2461: if (!$can_assign{'int'}) {
2462: return;
1.587 raeburn 2463: } elsif ($authtype eq '') {
1.591 raeburn 2464: if (defined($in{'mode'})) {
1.587 raeburn 2465: if ($in{'mode'} eq 'modifycourse') {
2466: if ($authnum == 1) {
1.784 bisitz 2467: $authtype = '<input type="hidden" name="login" value="int" />';
1.587 raeburn 2468: }
2469: }
2470: }
1.165 raeburn 2471: }
1.586 raeburn 2472: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2473: if ($authtype eq '') {
2474: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2475: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2476: }
1.605 bisitz 2477: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2478: $intarg.'" onchange="'.$jscall.'" />';
2479: $result = &mt
1.144 matthew 2480: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2481: '<label>'.$authtype,'</label>'.$autharg);
1.824 bisitz 2482: $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 2483: return $result;
2484: }
2485:
2486: sub authform_local{
2487: my %in = (
2488: formname => 'document.cu',
2489: kerb_def_dom => 'MSU.EDU',
2490: @_,
2491: );
1.586 raeburn 2492: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2493: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2494: if (defined($in{'curr_authtype'})) {
2495: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2496: if ($can_assign{'loc'}) {
1.772 bisitz 2497: $loccheck = 'checked="checked" ';
1.623 raeburn 2498: if (defined($in{'mode'})) {
2499: if ($in{'mode'} eq 'modifyuser') {
2500: $loccheck = '';
2501: }
2502: }
1.591 raeburn 2503: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2504: $locarg = $in{'curr_autharg'};
2505: }
2506: } else {
2507: $result = &mt('Currently using local (institutional) authentication.');
2508: return $result;
1.165 raeburn 2509: }
2510: }
1.586 raeburn 2511: } else {
2512: if ($authnum == 1) {
1.784 bisitz 2513: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 2514: }
2515: }
2516: if (!$can_assign{'loc'}) {
2517: return;
1.587 raeburn 2518: } elsif ($authtype eq '') {
1.591 raeburn 2519: if (defined($in{'mode'})) {
1.587 raeburn 2520: if ($in{'mode'} eq 'modifycourse') {
2521: if ($authnum == 1) {
1.784 bisitz 2522: $authtype = '<input type="hidden" name="login" value="loc" />';
1.587 raeburn 2523: }
2524: }
2525: }
1.165 raeburn 2526: }
1.586 raeburn 2527: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2528: if ($authtype eq '') {
2529: $authtype = '<input type="radio" name="login" value="loc" '.
2530: $loccheck.' onchange="'.$jscall.'" onclick="'.
2531: $jscall.'" />';
2532: }
2533: $autharg = '<input type="text" size="10" name="locarg" value="'.
2534: $locarg.'" onchange="'.$jscall.'" />';
2535: $result = &mt('[_1] Local Authentication with argument [_2]',
2536: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2537: return $result;
2538: }
2539:
2540: sub authform_filesystem{
2541: my %in = (
2542: formname => 'document.cu',
2543: kerb_def_dom => 'MSU.EDU',
2544: @_,
2545: );
1.586 raeburn 2546: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2547: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2548: if (defined($in{'curr_authtype'})) {
2549: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2550: if ($can_assign{'fsys'}) {
1.772 bisitz 2551: $fsyscheck = 'checked="checked" ';
1.623 raeburn 2552: if (defined($in{'mode'})) {
2553: if ($in{'mode'} eq 'modifyuser') {
2554: $fsyscheck = '';
2555: }
2556: }
1.586 raeburn 2557: } else {
2558: $result = &mt('Currently Filesystem Authenticated.');
2559: return $result;
2560: }
2561: }
2562: } else {
2563: if ($authnum == 1) {
1.784 bisitz 2564: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 2565: }
2566: }
2567: if (!$can_assign{'fsys'}) {
2568: return;
1.587 raeburn 2569: } elsif ($authtype eq '') {
1.591 raeburn 2570: if (defined($in{'mode'})) {
1.587 raeburn 2571: if ($in{'mode'} eq 'modifycourse') {
2572: if ($authnum == 1) {
1.784 bisitz 2573: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587 raeburn 2574: }
2575: }
2576: }
1.586 raeburn 2577: }
2578: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2579: if ($authtype eq '') {
2580: $authtype = '<input type="radio" name="login" value="fsys" '.
2581: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2582: $jscall.'" />';
2583: }
2584: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2585: ' onchange="'.$jscall.'" />';
2586: $result = &mt
1.144 matthew 2587: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2588: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2589: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2590: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2591: 'onchange="'.$jscall.'" />');
1.32 matthew 2592: return $result;
2593: }
2594:
1.586 raeburn 2595: sub get_assignable_auth {
2596: my ($dom) = @_;
2597: if ($dom eq '') {
2598: $dom = $env{'request.role.domain'};
2599: }
2600: my %can_assign = (
2601: krb4 => 1,
2602: krb5 => 1,
2603: int => 1,
2604: loc => 1,
2605: );
2606: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2607: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2608: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2609: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2610: my $context;
2611: if ($env{'request.role'} =~ /^au/) {
2612: $context = 'author';
2613: } elsif ($env{'request.role'} =~ /^dc/) {
2614: $context = 'domain';
2615: } elsif ($env{'request.course.id'}) {
2616: $context = 'course';
2617: }
2618: if ($context) {
2619: if (ref($authhash->{$context}) eq 'HASH') {
2620: %can_assign = %{$authhash->{$context}};
2621: }
2622: }
2623: }
2624: }
2625: my $authnum = 0;
2626: foreach my $key (keys(%can_assign)) {
2627: if ($can_assign{$key}) {
2628: $authnum ++;
2629: }
2630: }
2631: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2632: $authnum --;
2633: }
2634: return ($authnum,%can_assign);
2635: }
2636:
1.80 albertel 2637: ###############################################################
2638: ## Get Kerberos Defaults for Domain ##
2639: ###############################################################
2640: ##
2641: ## Returns default kerberos version and an associated argument
2642: ## as listed in file domain.tab. If not listed, provides
2643: ## appropriate default domain and kerberos version.
2644: ##
2645: #-------------------------------------------
2646:
2647: =pod
2648:
1.648 raeburn 2649: =item * &get_kerberos_defaults()
1.80 albertel 2650:
2651: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2652: version and domain. If not found, it defaults to version 4 and the
2653: domain of the server.
1.80 albertel 2654:
1.648 raeburn 2655: =over 4
2656:
1.80 albertel 2657: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2658:
1.648 raeburn 2659: =back
2660:
2661: =back
2662:
1.80 albertel 2663: =cut
2664:
2665: #-------------------------------------------
2666: sub get_kerberos_defaults {
2667: my $domain=shift;
1.641 raeburn 2668: my ($krbdef,$krbdefdom);
2669: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2670: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2671: $krbdef = $domdefaults{'auth_def'};
2672: $krbdefdom = $domdefaults{'auth_arg_def'};
2673: } else {
1.80 albertel 2674: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2675: my $krbdefdom=$1;
2676: $krbdefdom=~tr/a-z/A-Z/;
2677: $krbdef = "krb4";
2678: }
2679: return ($krbdef,$krbdefdom);
2680: }
1.112 bowersj2 2681:
1.32 matthew 2682:
1.46 matthew 2683: ###############################################################
2684: ## Thesaurus Functions ##
2685: ###############################################################
1.20 www 2686:
1.46 matthew 2687: =pod
1.20 www 2688:
1.112 bowersj2 2689: =head1 Thesaurus Functions
2690:
2691: =over 4
2692:
1.648 raeburn 2693: =item * &initialize_keywords()
1.46 matthew 2694:
2695: Initializes the package variable %Keywords if it is empty. Uses the
2696: package variable $thesaurus_db_file.
2697:
2698: =cut
2699:
2700: ###################################################
2701:
2702: sub initialize_keywords {
2703: return 1 if (scalar keys(%Keywords));
2704: # If we are here, %Keywords is empty, so fill it up
2705: # Make sure the file we need exists...
2706: if (! -e $thesaurus_db_file) {
2707: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2708: " failed because it does not exist");
2709: return 0;
2710: }
2711: # Set up the hash as a database
2712: my %thesaurus_db;
2713: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2714: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2715: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2716: $thesaurus_db_file);
2717: return 0;
2718: }
2719: # Get the average number of appearances of a word.
2720: my $avecount = $thesaurus_db{'average.count'};
2721: # Put keywords (those that appear > average) into %Keywords
2722: while (my ($word,$data)=each (%thesaurus_db)) {
2723: my ($count,undef) = split /:/,$data;
2724: $Keywords{$word}++ if ($count > $avecount);
2725: }
2726: untie %thesaurus_db;
2727: # Remove special values from %Keywords.
1.356 albertel 2728: foreach my $value ('total.count','average.count') {
2729: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2730: }
1.46 matthew 2731: return 1;
2732: }
2733:
2734: ###################################################
2735:
2736: =pod
2737:
1.648 raeburn 2738: =item * &keyword($word)
1.46 matthew 2739:
2740: Returns true if $word is a keyword. A keyword is a word that appears more
2741: than the average number of times in the thesaurus database. Calls
2742: &initialize_keywords
2743:
2744: =cut
2745:
2746: ###################################################
1.20 www 2747:
2748: sub keyword {
1.46 matthew 2749: return if (!&initialize_keywords());
2750: my $word=lc(shift());
2751: $word=~s/\W//g;
2752: return exists($Keywords{$word});
1.20 www 2753: }
1.46 matthew 2754:
2755: ###############################################################
2756:
2757: =pod
1.20 www 2758:
1.648 raeburn 2759: =item * &get_related_words()
1.46 matthew 2760:
1.160 matthew 2761: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2762: an array of words. If the keyword is not in the thesaurus, an empty array
2763: will be returned. The order of the words returned is determined by the
2764: database which holds them.
2765:
2766: Uses global $thesaurus_db_file.
2767:
2768: =cut
2769:
2770: ###############################################################
2771: sub get_related_words {
2772: my $keyword = shift;
2773: my %thesaurus_db;
2774: if (! -e $thesaurus_db_file) {
2775: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2776: "failed because the file does not exist");
2777: return ();
2778: }
2779: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2780: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2781: return ();
2782: }
2783: my @Words=();
1.429 www 2784: my $count=0;
1.46 matthew 2785: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2786: # The first element is the number of times
2787: # the word appears. We do not need it now.
1.429 www 2788: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2789: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2790: my $threshold=$mostfrequentcount/10;
2791: foreach my $possibleword (@RelatedWords) {
2792: my ($word,$wordcount)=split(/\,/,$possibleword);
2793: if ($wordcount>$threshold) {
2794: push(@Words,$word);
2795: $count++;
2796: if ($count>10) { last; }
2797: }
1.20 www 2798: }
2799: }
1.46 matthew 2800: untie %thesaurus_db;
2801: return @Words;
1.14 harris41 2802: }
1.46 matthew 2803:
1.112 bowersj2 2804: =pod
2805:
2806: =back
2807:
2808: =cut
1.61 www 2809:
2810: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2811: =pod
2812:
1.112 bowersj2 2813: =head1 User Name Functions
2814:
2815: =over 4
2816:
1.648 raeburn 2817: =item * &plainname($uname,$udom,$first)
1.81 albertel 2818:
1.112 bowersj2 2819: Takes a users logon name and returns it as a string in
1.226 albertel 2820: "first middle last generation" form
2821: if $first is set to 'lastname' then it returns it as
2822: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2823:
2824: =cut
1.61 www 2825:
1.295 www 2826:
1.81 albertel 2827: ###############################################################
1.61 www 2828: sub plainname {
1.226 albertel 2829: my ($uname,$udom,$first)=@_;
1.537 albertel 2830: return if (!defined($uname) || !defined($udom));
1.295 www 2831: my %names=&getnames($uname,$udom);
1.226 albertel 2832: my $name=&Apache::lonnet::format_name($names{'firstname'},
2833: $names{'middlename'},
2834: $names{'lastname'},
2835: $names{'generation'},$first);
2836: $name=~s/^\s+//;
1.62 www 2837: $name=~s/\s+$//;
2838: $name=~s/\s+/ /g;
1.353 albertel 2839: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2840: return $name;
1.61 www 2841: }
1.66 www 2842:
2843: # -------------------------------------------------------------------- Nickname
1.81 albertel 2844: =pod
2845:
1.648 raeburn 2846: =item * &nickname($uname,$udom)
1.81 albertel 2847:
2848: Gets a users name and returns it as a string as
2849:
2850: ""nickname""
1.66 www 2851:
1.81 albertel 2852: if the user has a nickname or
2853:
2854: "first middle last generation"
2855:
2856: if the user does not
2857:
2858: =cut
1.66 www 2859:
2860: sub nickname {
2861: my ($uname,$udom)=@_;
1.537 albertel 2862: return if (!defined($uname) || !defined($udom));
1.295 www 2863: my %names=&getnames($uname,$udom);
1.68 albertel 2864: my $name=$names{'nickname'};
1.66 www 2865: if ($name) {
2866: $name='"'.$name.'"';
2867: } else {
2868: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2869: $names{'lastname'}.' '.$names{'generation'};
2870: $name=~s/\s+$//;
2871: $name=~s/\s+/ /g;
2872: }
2873: return $name;
2874: }
2875:
1.295 www 2876: sub getnames {
2877: my ($uname,$udom)=@_;
1.537 albertel 2878: return if (!defined($uname) || !defined($udom));
1.433 albertel 2879: if ($udom eq 'public' && $uname eq 'public') {
2880: return ('lastname' => &mt('Public'));
2881: }
1.295 www 2882: my $id=$uname.':'.$udom;
2883: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2884: if ($cached) {
2885: return %{$names};
2886: } else {
2887: my %loadnames=&Apache::lonnet::get('environment',
2888: ['firstname','middlename','lastname','generation','nickname'],
2889: $udom,$uname);
2890: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2891: return %loadnames;
2892: }
2893: }
1.61 www 2894:
1.542 raeburn 2895: # -------------------------------------------------------------------- getemails
1.648 raeburn 2896:
1.542 raeburn 2897: =pod
2898:
1.648 raeburn 2899: =item * &getemails($uname,$udom)
1.542 raeburn 2900:
2901: Gets a user's email information and returns it as a hash with keys:
2902: notification, critnotification, permanentemail
2903:
2904: For notification and critnotification, values are comma-separated lists
1.648 raeburn 2905: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 2906:
1.648 raeburn 2907:
1.542 raeburn 2908: =cut
2909:
1.648 raeburn 2910:
1.466 albertel 2911: sub getemails {
2912: my ($uname,$udom)=@_;
2913: if ($udom eq 'public' && $uname eq 'public') {
2914: return;
2915: }
1.467 www 2916: if (!$udom) { $udom=$env{'user.domain'}; }
2917: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 2918: my $id=$uname.':'.$udom;
2919: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2920: if ($cached) {
2921: return %{$names};
2922: } else {
2923: my %loadnames=&Apache::lonnet::get('environment',
2924: ['notification','critnotification',
2925: 'permanentemail'],
2926: $udom,$uname);
2927: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2928: return %loadnames;
2929: }
2930: }
2931:
1.551 albertel 2932: sub flush_email_cache {
2933: my ($uname,$udom)=@_;
2934: if (!$udom) { $udom =$env{'user.domain'}; }
2935: if (!$uname) { $uname=$env{'user.name'}; }
2936: return if ($udom eq 'public' && $uname eq 'public');
2937: my $id=$uname.':'.$udom;
2938: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2939: }
2940:
1.728 raeburn 2941: # -------------------------------------------------------------------- getlangs
2942:
2943: =pod
2944:
2945: =item * &getlangs($uname,$udom)
2946:
2947: Gets a user's language preference and returns it as a hash with key:
2948: language.
2949:
2950: =cut
2951:
2952:
2953: sub getlangs {
2954: my ($uname,$udom) = @_;
2955: if (!$udom) { $udom =$env{'user.domain'}; }
2956: if (!$uname) { $uname=$env{'user.name'}; }
2957: my $id=$uname.':'.$udom;
2958: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
2959: if ($cached) {
2960: return %{$langs};
2961: } else {
2962: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
2963: $udom,$uname);
2964: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
2965: return %loadlangs;
2966: }
2967: }
2968:
2969: sub flush_langs_cache {
2970: my ($uname,$udom)=@_;
2971: if (!$udom) { $udom =$env{'user.domain'}; }
2972: if (!$uname) { $uname=$env{'user.name'}; }
2973: return if ($udom eq 'public' && $uname eq 'public');
2974: my $id=$uname.':'.$udom;
2975: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
2976: }
2977:
1.61 www 2978: # ------------------------------------------------------------------ Screenname
1.81 albertel 2979:
2980: =pod
2981:
1.648 raeburn 2982: =item * &screenname($uname,$udom)
1.81 albertel 2983:
2984: Gets a users screenname and returns it as a string
2985:
2986: =cut
1.61 www 2987:
2988: sub screenname {
2989: my ($uname,$udom)=@_;
1.258 albertel 2990: if ($uname eq $env{'user.name'} &&
2991: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 2992: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 2993: return $names{'screenname'};
1.62 www 2994: }
2995:
1.212 albertel 2996:
1.802 bisitz 2997: # ------------------------------------------------------------- Confirm Wrapper
2998: =pod
2999:
3000: =item confirmwrapper
3001:
3002: Wrap messages about completion of operation in box
3003:
3004: =cut
3005:
3006: sub confirmwrapper {
3007: my ($message)=@_;
3008: if ($message) {
3009: return "\n".'<div class="LC_confirm_box">'."\n"
3010: .$message."\n"
3011: .'</div>'."\n";
3012: } else {
3013: return $message;
3014: }
3015: }
3016:
1.62 www 3017: # ------------------------------------------------------------- Message Wrapper
3018:
3019: sub messagewrapper {
1.369 www 3020: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 3021: return
1.441 albertel 3022: '<a href="/adm/email?compose=individual&'.
3023: 'recname='.$username.'&recdom='.$domain.
3024: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 3025: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 3026: }
1.802 bisitz 3027:
1.74 www 3028: # --------------------------------------------------------------- Notes Wrapper
3029:
3030: sub noteswrapper {
3031: my ($link,$un,$do)=@_;
3032: return
1.896 amueller 3033: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 3034: }
1.802 bisitz 3035:
1.62 www 3036: # ------------------------------------------------------------- Aboutme Wrapper
3037:
3038: sub aboutmewrapper {
1.166 www 3039: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 3040: if (!defined($username) && !defined($domain)) {
3041: return;
3042: }
1.892 amueller 3043: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.756 weissno 3044: ($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 3045: }
3046:
3047: # ------------------------------------------------------------ Syllabus Wrapper
3048:
3049: sub syllabuswrapper {
1.707 bisitz 3050: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 3051: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 3052: }
1.14 harris41 3053:
1.802 bisitz 3054: # -----------------------------------------------------------------------------
3055:
1.208 matthew 3056: sub track_student_link {
1.887 raeburn 3057: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 3058: my $link ="/adm/trackstudent?";
1.208 matthew 3059: my $title = 'View recent activity';
3060: if (defined($sname) && $sname !~ /^\s*$/ &&
3061: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 3062: $link .= "selected_student=$sname:$sdom";
1.208 matthew 3063: $title .= ' of this student';
1.268 albertel 3064: }
1.208 matthew 3065: if (defined($target) && $target !~ /^\s*$/) {
3066: $target = qq{target="$target"};
3067: } else {
3068: $target = '';
3069: }
1.268 albertel 3070: if ($start) { $link.='&start='.$start; }
1.887 raeburn 3071: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 3072: $title = &mt($title);
3073: $linktext = &mt($linktext);
1.448 albertel 3074: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
3075: &help_open_topic('View_recent_activity');
1.208 matthew 3076: }
3077:
1.781 raeburn 3078: sub slot_reservations_link {
3079: my ($linktext,$sname,$sdom,$target) = @_;
3080: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
3081: my $title = 'View slot reservation history';
3082: if (defined($sname) && $sname !~ /^\s*$/ &&
3083: defined($sdom) && $sdom !~ /^\s*$/) {
3084: $link .= "&uname=$sname&udom=$sdom";
3085: $title .= ' of this student';
3086: }
3087: if (defined($target) && $target !~ /^\s*$/) {
3088: $target = qq{target="$target"};
3089: } else {
3090: $target = '';
3091: }
3092: $title = &mt($title);
3093: $linktext = &mt($linktext);
3094: return qq{<a href="$link" title="$title" $target>$linktext</a>};
3095: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
3096:
3097: }
3098:
1.508 www 3099: # ===================================================== Display a student photo
3100:
3101:
1.509 albertel 3102: sub student_image_tag {
1.508 www 3103: my ($domain,$user)=@_;
3104: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
3105: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
3106: return '<img src="'.$imgsrc.'" align="right" />';
3107: } else {
3108: return '';
3109: }
3110: }
3111:
1.112 bowersj2 3112: =pod
3113:
3114: =back
3115:
3116: =head1 Access .tab File Data
3117:
3118: =over 4
3119:
1.648 raeburn 3120: =item * &languageids()
1.112 bowersj2 3121:
3122: returns list of all language ids
3123:
3124: =cut
3125:
1.14 harris41 3126: sub languageids {
1.16 harris41 3127: return sort(keys(%language));
1.14 harris41 3128: }
3129:
1.112 bowersj2 3130: =pod
3131:
1.648 raeburn 3132: =item * &languagedescription()
1.112 bowersj2 3133:
3134: returns description of a specified language id
3135:
3136: =cut
3137:
1.14 harris41 3138: sub languagedescription {
1.125 www 3139: my $code=shift;
3140: return ($supported_language{$code}?'* ':'').
3141: $language{$code}.
1.126 www 3142: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 3143: }
3144:
3145: sub plainlanguagedescription {
3146: my $code=shift;
3147: return $language{$code};
3148: }
3149:
3150: sub supportedlanguagecode {
3151: my $code=shift;
3152: return $supported_language{$code};
1.97 www 3153: }
3154:
1.112 bowersj2 3155: =pod
3156:
1.648 raeburn 3157: =item * ©rightids()
1.112 bowersj2 3158:
3159: returns list of all copyrights
3160:
3161: =cut
3162:
3163: sub copyrightids {
3164: return sort(keys(%cprtag));
3165: }
3166:
3167: =pod
3168:
1.648 raeburn 3169: =item * ©rightdescription()
1.112 bowersj2 3170:
3171: returns description of a specified copyright id
3172:
3173: =cut
3174:
3175: sub copyrightdescription {
1.166 www 3176: return &mt($cprtag{shift(@_)});
1.112 bowersj2 3177: }
1.197 matthew 3178:
3179: =pod
3180:
1.648 raeburn 3181: =item * &source_copyrightids()
1.192 taceyjo1 3182:
3183: returns list of all source copyrights
3184:
3185: =cut
3186:
3187: sub source_copyrightids {
3188: return sort(keys(%scprtag));
3189: }
3190:
3191: =pod
3192:
1.648 raeburn 3193: =item * &source_copyrightdescription()
1.192 taceyjo1 3194:
3195: returns description of a specified source copyright id
3196:
3197: =cut
3198:
3199: sub source_copyrightdescription {
3200: return &mt($scprtag{shift(@_)});
3201: }
1.112 bowersj2 3202:
3203: =pod
3204:
1.648 raeburn 3205: =item * &filecategories()
1.112 bowersj2 3206:
3207: returns list of all file categories
3208:
3209: =cut
3210:
3211: sub filecategories {
3212: return sort(keys(%category_extensions));
3213: }
3214:
3215: =pod
3216:
1.648 raeburn 3217: =item * &filecategorytypes()
1.112 bowersj2 3218:
3219: returns list of file types belonging to a given file
3220: category
3221:
3222: =cut
3223:
3224: sub filecategorytypes {
1.356 albertel 3225: my ($cat) = @_;
3226: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 3227: }
3228:
3229: =pod
3230:
1.648 raeburn 3231: =item * &fileembstyle()
1.112 bowersj2 3232:
3233: returns embedding style for a specified file type
3234:
3235: =cut
3236:
3237: sub fileembstyle {
3238: return $fe{lc(shift(@_))};
1.169 www 3239: }
3240:
1.351 www 3241: sub filemimetype {
3242: return $fm{lc(shift(@_))};
3243: }
3244:
1.169 www 3245:
3246: sub filecategoryselect {
3247: my ($name,$value)=@_;
1.189 matthew 3248: return &select_form($value,$name,
1.169 www 3249: '' => &mt('Any category'),
3250: map { $_,$_ } sort(keys(%category_extensions)));
1.112 bowersj2 3251: }
3252:
3253: =pod
3254:
1.648 raeburn 3255: =item * &filedescription()
1.112 bowersj2 3256:
3257: returns description for a specified file type
3258:
3259: =cut
3260:
3261: sub filedescription {
1.188 matthew 3262: my $file_description = $fd{lc(shift())};
3263: $file_description =~ s:([\[\]]):~$1:g;
3264: return &mt($file_description);
1.112 bowersj2 3265: }
3266:
3267: =pod
3268:
1.648 raeburn 3269: =item * &filedescriptionex()
1.112 bowersj2 3270:
3271: returns description for a specified file type with
3272: extra formatting
3273:
3274: =cut
3275:
3276: sub filedescriptionex {
3277: my $ex=shift;
1.188 matthew 3278: my $file_description = $fd{lc($ex)};
3279: $file_description =~ s:([\[\]]):~$1:g;
3280: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3281: }
3282:
3283: # End of .tab access
3284: =pod
3285:
3286: =back
3287:
3288: =cut
3289:
3290: # ------------------------------------------------------------------ File Types
3291: sub fileextensions {
3292: return sort(keys(%fe));
3293: }
3294:
1.97 www 3295: # ----------------------------------------------------------- Display Languages
3296: # returns a hash with all desired display languages
3297: #
3298:
3299: sub display_languages {
3300: my %languages=();
1.695 raeburn 3301: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3302: $languages{$lang}=1;
1.97 www 3303: }
3304: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3305: if ($env{'form.displaylanguage'}) {
1.356 albertel 3306: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3307: $languages{$lang}=1;
1.97 www 3308: }
3309: }
3310: return %languages;
1.14 harris41 3311: }
3312:
1.582 albertel 3313: sub languages {
3314: my ($possible_langs) = @_;
1.695 raeburn 3315: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3316: if (!ref($possible_langs)) {
3317: if( wantarray ) {
3318: return @preferred_langs;
3319: } else {
3320: return $preferred_langs[0];
3321: }
3322: }
3323: my %possibilities = map { $_ => 1 } (@$possible_langs);
3324: my @preferred_possibilities;
3325: foreach my $preferred_lang (@preferred_langs) {
3326: if (exists($possibilities{$preferred_lang})) {
3327: push(@preferred_possibilities, $preferred_lang);
3328: }
3329: }
3330: if( wantarray ) {
3331: return @preferred_possibilities;
3332: }
3333: return $preferred_possibilities[0];
3334: }
3335:
1.742 raeburn 3336: sub user_lang {
3337: my ($touname,$toudom,$fromcid) = @_;
3338: my @userlangs;
3339: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3340: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3341: $env{'course.'.$fromcid.'.languages'}));
3342: } else {
3343: my %langhash = &getlangs($touname,$toudom);
3344: if ($langhash{'languages'} ne '') {
3345: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3346: } else {
3347: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3348: if ($domdefs{'lang_def'} ne '') {
3349: @userlangs = ($domdefs{'lang_def'});
3350: }
3351: }
3352: }
3353: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3354: my $user_lh = Apache::localize->get_handle(@languages);
3355: return $user_lh;
3356: }
3357:
3358:
1.112 bowersj2 3359: ###############################################################
3360: ## Student Answer Attempts ##
3361: ###############################################################
3362:
3363: =pod
3364:
3365: =head1 Alternate Problem Views
3366:
3367: =over 4
3368:
1.648 raeburn 3369: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3370: $getattempt, $regexp, $gradesub)
3371:
3372: Return string with previous attempt on problem. Arguments:
3373:
3374: =over 4
3375:
3376: =item * $symb: Problem, including path
3377:
3378: =item * $username: username of the desired student
3379:
3380: =item * $domain: domain of the desired student
1.14 harris41 3381:
1.112 bowersj2 3382: =item * $course: Course ID
1.14 harris41 3383:
1.112 bowersj2 3384: =item * $getattempt: Leave blank for all attempts, otherwise put
3385: something
1.14 harris41 3386:
1.112 bowersj2 3387: =item * $regexp: if string matches this regexp, the string will be
3388: sent to $gradesub
1.14 harris41 3389:
1.112 bowersj2 3390: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3391:
1.112 bowersj2 3392: =back
1.14 harris41 3393:
1.112 bowersj2 3394: The output string is a table containing all desired attempts, if any.
1.16 harris41 3395:
1.112 bowersj2 3396: =cut
1.1 albertel 3397:
3398: sub get_previous_attempt {
1.43 ng 3399: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3400: my $prevattempts='';
1.43 ng 3401: no strict 'refs';
1.1 albertel 3402: if ($symb) {
1.3 albertel 3403: my (%returnhash)=
3404: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3405: if ($returnhash{'version'}) {
3406: my %lasthash=();
3407: my $version;
3408: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3409: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3410: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3411: }
1.1 albertel 3412: }
1.596 albertel 3413: $prevattempts=&start_data_table().&start_data_table_header_row();
3414: $prevattempts.='<th>'.&mt('History').'</th>';
1.945 raeburn 3415: my %typeparts;
3416: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 3417: foreach my $key (sort(keys(%lasthash))) {
3418: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3419: if ($#parts > 0) {
1.31 albertel 3420: my $data=$parts[-1];
3421: pop(@parts);
1.945 raeburn 3422: if ($data eq 'type') {
3423: unless ($showsurv) {
3424: my $id = join(',',@parts);
3425: $typeparts{$ign.'.'.$id} = $lasthash{$key};
3426: }
3427: delete($lasthash{$key});
3428: } else {
3429: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
3430: }
1.31 albertel 3431: } else {
1.41 ng 3432: if ($#parts == 0) {
3433: $prevattempts.='<th>'.$parts[0].'</th>';
3434: } else {
3435: $prevattempts.='<th>'.$ign.'</th>';
3436: }
1.31 albertel 3437: }
1.16 harris41 3438: }
1.596 albertel 3439: $prevattempts.=&end_data_table_header_row();
1.945 raeburn 3440: my %lasthidden;
1.40 ng 3441: if ($getattempt eq '') {
3442: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.945 raeburn 3443: my @hidden;
3444: if (%typeparts) {
3445: foreach my $id (keys(%typeparts)) {
3446: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
3447: push(@hidden,$id);
3448: $lasthidden{$id} = 1;
3449: } elsif ($lasthidden{$id}) {
3450: if (exists($returnhash{$version.':'.$id.'.award'})) {
3451: delete($lasthidden{$id});
3452: }
3453: }
3454: }
3455: }
3456: $prevattempts.=&start_data_table_row().
3457: '<td>'.&mt('Transaction [_1]',$version).'</td>';
3458: if (@hidden) {
3459: foreach my $key (sort(keys(%lasthash))) {
3460: my $hide;
3461: foreach my $id (@hidden) {
3462: if ($key =~ /^\Q$id\E/) {
3463: $hide = 1;
3464: last;
3465: }
3466: }
3467: if ($hide) {
3468: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3469: if (($data eq 'award') || ($data eq 'awarddetail')) {
3470: my $value = &format_previous_attempt_value($key,
3471: $returnhash{$version.':'.$key});
3472: $prevattempts.='<td>'.$value.' </td>';
3473: } else {
3474: $prevattempts.='<td> </td>';
3475: }
3476: } else {
3477: if ($key =~ /\./) {
3478: my $value = &format_previous_attempt_value($key,
3479: $returnhash{$version.':'.$key});
3480: $prevattempts.='<td>'.$value.' </td>';
3481: } else {
3482: $prevattempts.='<td> </td>';
3483: }
3484: }
3485: }
3486: } else {
3487: foreach my $key (sort(keys(%lasthash))) {
3488: my $value = &format_previous_attempt_value($key,
3489: $returnhash{$version.':'.$key});
3490: $prevattempts.='<td>'.$value.' </td>';
3491: }
3492: }
3493: $prevattempts.=&end_data_table_row();
1.40 ng 3494: }
1.1 albertel 3495: }
1.945 raeburn 3496: my @currhidden = keys(%lasthidden);
1.596 albertel 3497: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3498: foreach my $key (sort(keys(%lasthash))) {
1.945 raeburn 3499: if (%typeparts) {
3500: my $hidden;
3501: foreach my $id (@currhidden) {
3502: if ($key =~ /^\Q$id\E/) {
3503: $hidden = 1;
3504: last;
3505: }
3506: }
3507: if ($hidden) {
3508: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3509: if (($data eq 'award') || ($data eq 'awarddetail')) {
3510: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3511: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3512: $value = &$gradesub($value);
3513: }
3514: $prevattempts.='<td>'.$value.' </td>';
3515: } else {
3516: $prevattempts.='<td> </td>';
3517: }
3518: } else {
3519: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3520: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3521: $value = &$gradesub($value);
3522: }
3523: $prevattempts.='<td>'.$value.' </td>';
3524: }
3525: } else {
3526: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3527: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3528: $value = &$gradesub($value);
3529: }
3530: $prevattempts.='<td>'.$value.' </td>';
3531: }
1.16 harris41 3532: }
1.596 albertel 3533: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3534: } else {
1.596 albertel 3535: $prevattempts=
3536: &start_data_table().&start_data_table_row().
3537: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3538: &end_data_table_row().&end_data_table();
1.1 albertel 3539: }
3540: } else {
1.596 albertel 3541: $prevattempts=
3542: &start_data_table().&start_data_table_row().
3543: '<td>'.&mt('No data.').'</td>'.
3544: &end_data_table_row().&end_data_table();
1.1 albertel 3545: }
1.10 albertel 3546: }
3547:
1.581 albertel 3548: sub format_previous_attempt_value {
3549: my ($key,$value) = @_;
3550: if ($key =~ /timestamp/) {
3551: $value = &Apache::lonlocal::locallocaltime($value);
3552: } elsif (ref($value) eq 'ARRAY') {
3553: $value = '('.join(', ', @{ $value }).')';
3554: } else {
3555: $value = &unescape($value);
3556: }
3557: return $value;
3558: }
3559:
3560:
1.107 albertel 3561: sub relative_to_absolute {
3562: my ($url,$output)=@_;
3563: my $parser=HTML::TokeParser->new(\$output);
3564: my $token;
3565: my $thisdir=$url;
3566: my @rlinks=();
3567: while ($token=$parser->get_token) {
3568: if ($token->[0] eq 'S') {
3569: if ($token->[1] eq 'a') {
3570: if ($token->[2]->{'href'}) {
3571: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3572: }
3573: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3574: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3575: } elsif ($token->[1] eq 'base') {
3576: $thisdir=$token->[2]->{'href'};
3577: }
3578: }
3579: }
3580: $thisdir=~s-/[^/]*$--;
1.356 albertel 3581: foreach my $link (@rlinks) {
1.726 raeburn 3582: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3583: ($link=~/^\//) ||
3584: ($link=~/^javascript:/i) ||
3585: ($link=~/^mailto:/i) ||
3586: ($link=~/^\#/)) {
3587: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3588: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3589: }
3590: }
3591: # -------------------------------------------------- Deal with Applet codebases
3592: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3593: return $output;
3594: }
3595:
1.112 bowersj2 3596: =pod
3597:
1.648 raeburn 3598: =item * &get_student_view()
1.112 bowersj2 3599:
3600: show a snapshot of what student was looking at
3601:
3602: =cut
3603:
1.10 albertel 3604: sub get_student_view {
1.186 albertel 3605: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3606: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3607: my (%form);
1.10 albertel 3608: my @elements=('symb','courseid','domain','username');
3609: foreach my $element (@elements) {
1.186 albertel 3610: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3611: }
1.186 albertel 3612: if (defined($moreenv)) {
3613: %form=(%form,%{$moreenv});
3614: }
1.236 albertel 3615: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3616: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3617: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3618: $userview=~s/\<body[^\>]*\>//gi;
3619: $userview=~s/\<\/body\>//gi;
3620: $userview=~s/\<html\>//gi;
3621: $userview=~s/\<\/html\>//gi;
3622: $userview=~s/\<head\>//gi;
3623: $userview=~s/\<\/head\>//gi;
3624: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3625: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3626: if (wantarray) {
3627: return ($userview,$response);
3628: } else {
3629: return $userview;
3630: }
3631: }
3632:
3633: sub get_student_view_with_retries {
3634: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3635:
3636: my $ok = 0; # True if we got a good response.
3637: my $content;
3638: my $response;
3639:
3640: # Try to get the student_view done. within the retries count:
3641:
3642: do {
3643: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3644: $ok = $response->is_success;
3645: if (!$ok) {
3646: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3647: }
3648: $retries--;
3649: } while (!$ok && ($retries > 0));
3650:
3651: if (!$ok) {
3652: $content = ''; # On error return an empty content.
3653: }
1.651 www 3654: if (wantarray) {
3655: return ($content, $response);
3656: } else {
3657: return $content;
3658: }
1.11 albertel 3659: }
3660:
1.112 bowersj2 3661: =pod
3662:
1.648 raeburn 3663: =item * &get_student_answers()
1.112 bowersj2 3664:
3665: show a snapshot of how student was answering problem
3666:
3667: =cut
3668:
1.11 albertel 3669: sub get_student_answers {
1.100 sakharuk 3670: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3671: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3672: my (%moreenv);
1.11 albertel 3673: my @elements=('symb','courseid','domain','username');
3674: foreach my $element (@elements) {
1.186 albertel 3675: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3676: }
1.186 albertel 3677: $moreenv{'grade_target'}='answer';
3678: %moreenv=(%form,%moreenv);
1.497 raeburn 3679: $feedurl = &Apache::lonnet::clutter($feedurl);
3680: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3681: return $userview;
1.1 albertel 3682: }
1.116 albertel 3683:
3684: =pod
3685:
3686: =item * &submlink()
3687:
1.242 albertel 3688: Inputs: $text $uname $udom $symb $target
1.116 albertel 3689:
3690: Returns: A link to grades.pm such as to see the SUBM view of a student
3691:
3692: =cut
3693:
3694: ###############################################
3695: sub submlink {
1.242 albertel 3696: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3697: if (!($uname && $udom)) {
3698: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3699: &Apache::lonnet::whichuser($symb);
1.116 albertel 3700: if (!$symb) { $symb=$cursymb; }
3701: }
1.254 matthew 3702: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3703: $symb=&escape($symb);
1.242 albertel 3704: if ($target) { $target="target=\"$target\""; }
3705: return '<a href="/adm/grades?&command=submission&'.
3706: 'symb='.$symb.'&student='.$uname.
3707: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
3708: }
3709: ##############################################
3710:
3711: =pod
3712:
3713: =item * &pgrdlink()
3714:
3715: Inputs: $text $uname $udom $symb $target
3716:
3717: Returns: A link to grades.pm such as to see the PGRD view of a student
3718:
3719: =cut
3720:
3721: ###############################################
3722: sub pgrdlink {
3723: my $link=&submlink(@_);
3724: $link=~s/(&command=submission)/$1&showgrading=yes/;
3725: return $link;
3726: }
3727: ##############################################
3728:
3729: =pod
3730:
3731: =item * &pprmlink()
3732:
3733: Inputs: $text $uname $udom $symb $target
3734:
3735: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3736: student and a specific resource
1.242 albertel 3737:
3738: =cut
3739:
3740: ###############################################
3741: sub pprmlink {
3742: my ($text,$uname,$udom,$symb,$target)=@_;
3743: if (!($uname && $udom)) {
3744: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3745: &Apache::lonnet::whichuser($symb);
1.242 albertel 3746: if (!$symb) { $symb=$cursymb; }
3747: }
1.254 matthew 3748: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3749: $symb=&escape($symb);
1.242 albertel 3750: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3751: return '<a href="/adm/parmset?command=set&'.
3752: 'symb='.$symb.'&uname='.$uname.
3753: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3754: }
3755: ##############################################
1.37 matthew 3756:
1.112 bowersj2 3757: =pod
3758:
3759: =back
3760:
3761: =cut
3762:
1.37 matthew 3763: ###############################################
1.51 www 3764:
3765:
3766: sub timehash {
1.687 raeburn 3767: my ($thistime) = @_;
3768: my $timezone = &Apache::lonlocal::gettimezone();
3769: my $dt = DateTime->from_epoch(epoch => $thistime)
3770: ->set_time_zone($timezone);
3771: my $wday = $dt->day_of_week();
3772: if ($wday == 7) { $wday = 0; }
3773: return ( 'second' => $dt->second(),
3774: 'minute' => $dt->minute(),
3775: 'hour' => $dt->hour(),
3776: 'day' => $dt->day_of_month(),
3777: 'month' => $dt->month(),
3778: 'year' => $dt->year(),
3779: 'weekday' => $wday,
3780: 'dayyear' => $dt->day_of_year(),
3781: 'dlsav' => $dt->is_dst() );
1.51 www 3782: }
3783:
1.370 www 3784: sub utc_string {
3785: my ($date)=@_;
1.371 www 3786: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3787: }
3788:
1.51 www 3789: sub maketime {
3790: my %th=@_;
1.687 raeburn 3791: my ($epoch_time,$timezone,$dt);
3792: $timezone = &Apache::lonlocal::gettimezone();
3793: eval {
3794: $dt = DateTime->new( year => $th{'year'},
3795: month => $th{'month'},
3796: day => $th{'day'},
3797: hour => $th{'hour'},
3798: minute => $th{'minute'},
3799: second => $th{'second'},
3800: time_zone => $timezone,
3801: );
3802: };
3803: if (!$@) {
3804: $epoch_time = $dt->epoch;
3805: if ($epoch_time) {
3806: return $epoch_time;
3807: }
3808: }
1.51 www 3809: return POSIX::mktime(
3810: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3811: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3812: }
3813:
3814: #########################################
1.51 www 3815:
3816: sub findallcourses {
1.482 raeburn 3817: my ($roles,$uname,$udom) = @_;
1.355 albertel 3818: my %roles;
3819: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3820: my %courses;
1.51 www 3821: my $now=time;
1.482 raeburn 3822: if (!defined($uname)) {
3823: $uname = $env{'user.name'};
3824: }
3825: if (!defined($udom)) {
3826: $udom = $env{'user.domain'};
3827: }
3828: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
3829: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
3830: if (!%roles) {
3831: %roles = (
3832: cc => 1,
1.907 raeburn 3833: co => 1,
1.482 raeburn 3834: in => 1,
3835: ep => 1,
3836: ta => 1,
3837: cr => 1,
3838: st => 1,
3839: );
3840: }
3841: foreach my $entry (keys(%roleshash)) {
3842: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3843: if ($trole =~ /^cr/) {
3844: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3845: } else {
3846: next if (!exists($roles{$trole}));
3847: }
3848: if ($tend) {
3849: next if ($tend < $now);
3850: }
3851: if ($tstart) {
3852: next if ($tstart > $now);
3853: }
3854: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3855: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3856: if ($secpart eq '') {
3857: ($cnum,$role) = split(/_/,$cnumpart);
3858: $sec = 'none';
3859: $realsec = '';
3860: } else {
3861: $cnum = $cnumpart;
3862: ($sec,$role) = split(/_/,$secpart);
3863: $realsec = $sec;
1.490 raeburn 3864: }
1.482 raeburn 3865: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3866: }
3867: } else {
3868: foreach my $key (keys(%env)) {
1.483 albertel 3869: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3870: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3871: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3872: next if ($role eq 'ca' || $role eq 'aa');
3873: next if (%roles && !exists($roles{$role}));
3874: my ($starttime,$endtime)=split(/\./,$env{$key});
3875: my $active=1;
3876: if ($starttime) {
3877: if ($now<$starttime) { $active=0; }
3878: }
3879: if ($endtime) {
3880: if ($now>$endtime) { $active=0; }
3881: }
3882: if ($active) {
3883: if ($sec eq '') {
3884: $sec = 'none';
3885: }
3886: $courses{$cdom.'_'.$cnum}{$sec} =
3887: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 3888: }
3889: }
1.51 www 3890: }
3891: }
1.474 raeburn 3892: return %courses;
1.51 www 3893: }
1.37 matthew 3894:
1.54 www 3895: ###############################################
1.474 raeburn 3896:
3897: sub blockcheck {
1.482 raeburn 3898: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 3899:
3900: if (!defined($udom)) {
3901: $udom = $env{'user.domain'};
3902: }
3903: if (!defined($uname)) {
3904: $uname = $env{'user.name'};
3905: }
3906:
3907: # If uname and udom are for a course, check for blocks in the course.
3908:
3909: if (&Apache::lonnet::is_course($udom,$uname)) {
3910: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 3911: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 3912: return ($startblock,$endblock);
3913: }
1.474 raeburn 3914:
1.502 raeburn 3915: my $startblock = 0;
3916: my $endblock = 0;
1.482 raeburn 3917: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 3918:
1.490 raeburn 3919: # If uname is for a user, and activity is course-specific, i.e.,
3920: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3921:
1.490 raeburn 3922: if (($activity eq 'boards' || $activity eq 'chat' ||
3923: $activity eq 'groups') && ($env{'request.course.id'})) {
3924: foreach my $key (keys(%live_courses)) {
3925: if ($key ne $env{'request.course.id'}) {
3926: delete($live_courses{$key});
3927: }
3928: }
3929: }
3930:
3931: my $otheruser = 0;
3932: my %own_courses;
3933: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3934: # Resource belongs to user other than current user.
3935: $otheruser = 1;
3936: # Gather courses for current user
3937: %own_courses =
3938: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3939: }
3940:
3941: # Gather active course roles - course coordinator, instructor,
3942: # exam proctor, ta, student, or custom role.
1.474 raeburn 3943:
3944: foreach my $course (keys(%live_courses)) {
1.482 raeburn 3945: my ($cdom,$cnum);
3946: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3947: $cdom = $env{'course.'.$course.'.domain'};
3948: $cnum = $env{'course.'.$course.'.num'};
3949: } else {
1.490 raeburn 3950: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 3951: }
3952: my $no_ownblock = 0;
3953: my $no_userblock = 0;
1.533 raeburn 3954: if ($otheruser && $activity ne 'com') {
1.490 raeburn 3955: # Check if current user has 'evb' priv for this
3956: if (defined($own_courses{$course})) {
3957: foreach my $sec (keys(%{$own_courses{$course}})) {
3958: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3959: if ($sec ne 'none') {
3960: $checkrole .= '/'.$sec;
3961: }
3962: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3963: $no_ownblock = 1;
3964: last;
3965: }
3966: }
3967: }
3968: # if they have 'evb' priv and are currently not playing student
3969: next if (($no_ownblock) &&
3970: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
3971: }
1.474 raeburn 3972: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 3973: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 3974: if ($sec ne 'none') {
1.482 raeburn 3975: $checkrole .= '/'.$sec;
1.474 raeburn 3976: }
1.490 raeburn 3977: if ($otheruser) {
3978: # Resource belongs to user other than current user.
3979: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 3980: my ($trole,$tdom,$tnum,$tsec);
3981: my $entry = $live_courses{$course}{$sec};
3982: if ($entry =~ /^cr/) {
3983: ($trole,$tdom,$tnum,$tsec) =
3984: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
3985: } else {
3986: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
3987: }
3988: my ($spec,$area,$trest,%allroles,%userroles);
3989: $area = '/'.$tdom.'/'.$tnum;
3990: $trest = $tnum;
3991: if ($tsec ne '') {
3992: $area .= '/'.$tsec;
3993: $trest .= '/'.$tsec;
3994: }
3995: $spec = $trole.'.'.$area;
3996: if ($trole =~ /^cr/) {
3997: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
3998: $tdom,$spec,$trest,$area);
3999: } else {
4000: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
4001: $tdom,$spec,$trest,$area);
4002: }
4003: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 4004: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
4005: if ($1) {
4006: $no_userblock = 1;
4007: last;
4008: }
4009: }
1.490 raeburn 4010: } else {
4011: # Resource belongs to current user
4012: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 4013: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4014: $no_ownblock = 1;
4015: last;
4016: }
1.474 raeburn 4017: }
4018: }
4019: # if they have the evb priv and are currently not playing student
1.482 raeburn 4020: next if (($no_ownblock) &&
1.491 albertel 4021: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 4022: next if ($no_userblock);
1.474 raeburn 4023:
1.866 kalberla 4024: # Retrieve blocking times and identity of locker for course
1.490 raeburn 4025: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 4026:
4027: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
4028: if (($start != 0) &&
4029: (($startblock == 0) || ($startblock > $start))) {
4030: $startblock = $start;
4031: }
4032: if (($end != 0) &&
4033: (($endblock == 0) || ($endblock < $end))) {
4034: $endblock = $end;
4035: }
1.490 raeburn 4036: }
4037: return ($startblock,$endblock);
4038: }
4039:
4040: sub get_blocks {
4041: my ($setters,$activity,$cdom,$cnum) = @_;
4042: my $startblock = 0;
4043: my $endblock = 0;
4044: my $course = $cdom.'_'.$cnum;
4045: $setters->{$course} = {};
4046: $setters->{$course}{'staff'} = [];
4047: $setters->{$course}{'times'} = [];
4048: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
4049: foreach my $record (keys(%records)) {
4050: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
4051: if ($start <= time && $end >= time) {
4052: my ($staff_name,$staff_dom,$title,$blocks) =
4053: &parse_block_record($records{$record});
4054: if ($blocks->{$activity} eq 'on') {
4055: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
4056: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 4057: if ( ($startblock == 0) || ($startblock > $start) ) {
4058: $startblock = $start;
1.490 raeburn 4059: }
1.491 albertel 4060: if ( ($endblock == 0) || ($endblock < $end) ) {
4061: $endblock = $end;
1.474 raeburn 4062: }
4063: }
4064: }
4065: }
4066: return ($startblock,$endblock);
4067: }
4068:
4069: sub parse_block_record {
4070: my ($record) = @_;
4071: my ($setuname,$setudom,$title,$blocks);
4072: if (ref($record) eq 'HASH') {
4073: ($setuname,$setudom) = split(/:/,$record->{'setter'});
4074: $title = &unescape($record->{'event'});
4075: $blocks = $record->{'blocks'};
4076: } else {
4077: my @data = split(/:/,$record,3);
4078: if (scalar(@data) eq 2) {
4079: $title = $data[1];
4080: ($setuname,$setudom) = split(/@/,$data[0]);
4081: } else {
4082: ($setuname,$setudom,$title) = @data;
4083: }
4084: $blocks = { 'com' => 'on' };
4085: }
4086: return ($setuname,$setudom,$title,$blocks);
4087: }
4088:
1.854 kalberla 4089: sub blocking_status {
4090: my ($activity,$uname,$udom) = @_;
1.867 kalberla 4091: my %setters;
1.890 droeschl 4092:
4093: # check for active blocking
1.867 kalberla 4094: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
1.854 kalberla 4095:
1.890 droeschl 4096: my $blocked = $startblock && $endblock ? 1 : 0;
4097:
4098: # caller just wants to know whether a block is active
4099: if (!wantarray) { return $blocked; }
4100:
4101: # build a link to a popup window containing the details
4102: my $querystring = "?activity=$activity";
4103: # $uname and $udom decide whose portfolio the user is trying to look at
4104: $querystring .= "&udom=$udom" if $udom;
4105: $querystring .= "&uname=$uname" if $uname;
4106:
4107: my $output .= <<'END_MYBLOCK';
1.854 kalberla 4108: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
4109: var options = "width=" + w + ",height=" + h + ",";
4110: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
4111: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
4112: var newWin = window.open(url, wdwName, options);
4113: newWin.focus();
4114: }
1.890 droeschl 4115: END_MYBLOCK
1.854 kalberla 4116:
1.890 droeschl 4117: $output = Apache::lonhtmlcommon::scripttag($output);
4118:
1.854 kalberla 4119: my $popupUrl = "/adm/blockingstatus/$querystring";
1.890 droeschl 4120: my $text = mt('Communication Blocked');
4121:
1.867 kalberla 4122: $output .= <<"END_BLOCK";
4123: <div class='LC_comblock'>
1.869 kalberla 4124: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4125: title='$text'>
4126: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 4127: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4128: title='$text'>$text</a>
1.867 kalberla 4129: </div>
4130:
4131: END_BLOCK
1.474 raeburn 4132:
1.854 kalberla 4133: return ($blocked, $output);
4134: }
1.490 raeburn 4135:
1.60 matthew 4136: ###############################################
4137:
1.682 raeburn 4138: sub check_ip_acc {
4139: my ($acc)=@_;
4140: &Apache::lonxml::debug("acc is $acc");
4141: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
4142: return 1;
4143: }
4144: my $allowed=0;
4145: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
4146:
4147: my $name;
4148: foreach my $pattern (split(',',$acc)) {
4149: $pattern =~ s/^\s*//;
4150: $pattern =~ s/\s*$//;
4151: if ($pattern =~ /\*$/) {
4152: #35.8.*
4153: $pattern=~s/\*//;
4154: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4155: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
4156: #35.8.3.[34-56]
4157: my $low=$2;
4158: my $high=$3;
4159: $pattern=$1;
4160: if ($ip =~ /^\Q$pattern\E/) {
4161: my $last=(split(/\./,$ip))[3];
4162: if ($last <=$high && $last >=$low) { $allowed=1; }
4163: }
4164: } elsif ($pattern =~ /^\*/) {
4165: #*.msu.edu
4166: $pattern=~s/\*//;
4167: if (!defined($name)) {
4168: use Socket;
4169: my $netaddr=inet_aton($ip);
4170: ($name)=gethostbyaddr($netaddr,AF_INET);
4171: }
4172: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4173: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
4174: #127.0.0.1
4175: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4176: } else {
4177: #some.name.com
4178: if (!defined($name)) {
4179: use Socket;
4180: my $netaddr=inet_aton($ip);
4181: ($name)=gethostbyaddr($netaddr,AF_INET);
4182: }
4183: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4184: }
4185: if ($allowed) { last; }
4186: }
4187: return $allowed;
4188: }
4189:
4190: ###############################################
4191:
1.60 matthew 4192: =pod
4193:
1.112 bowersj2 4194: =head1 Domain Template Functions
4195:
4196: =over 4
4197:
4198: =item * &determinedomain()
1.60 matthew 4199:
4200: Inputs: $domain (usually will be undef)
4201:
1.63 www 4202: Returns: Determines which domain should be used for designs
1.60 matthew 4203:
4204: =cut
1.54 www 4205:
1.60 matthew 4206: ###############################################
1.63 www 4207: sub determinedomain {
4208: my $domain=shift;
1.531 albertel 4209: if (! $domain) {
1.60 matthew 4210: # Determine domain if we have not been given one
1.893 raeburn 4211: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 4212: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
4213: if ($env{'request.role.domain'}) {
4214: $domain=$env{'request.role.domain'};
1.60 matthew 4215: }
4216: }
1.63 www 4217: return $domain;
4218: }
4219: ###############################################
1.517 raeburn 4220:
1.518 albertel 4221: sub devalidate_domconfig_cache {
4222: my ($udom)=@_;
4223: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
4224: }
4225:
4226: # ---------------------- Get domain configuration for a domain
4227: sub get_domainconf {
4228: my ($udom) = @_;
4229: my $cachetime=1800;
4230: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
4231: if (defined($cached)) { return %{$result}; }
4232:
4233: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 4234: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 4235: my (%designhash,%legacy);
1.518 albertel 4236: if (keys(%domconfig) > 0) {
4237: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 4238: if (keys(%{$domconfig{'login'}})) {
4239: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 4240: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.946 raeburn 4241: if ($key eq 'loginvia') {
4242: if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') {
4243: my @ids = &Apache::lonnet::current_machine_ids();
4244: foreach my $hostname (@ids) {
1.948 raeburn 4245: if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') {
4246: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
4247: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
4248: $designhash{$udom.'.login.loginvia'} = $server;
4249: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
4250:
4251: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
4252: } else {
4253: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
4254: }
4255: if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) {
4256: $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'};
4257: }
1.946 raeburn 4258: }
4259: }
4260: }
4261: }
4262: } else {
4263: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
4264: $designhash{$udom.'.login.'.$key.'_'.$img} =
4265: $domconfig{'login'}{$key}{$img};
4266: }
1.699 raeburn 4267: }
4268: } else {
4269: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
4270: }
1.632 raeburn 4271: }
4272: } else {
4273: $legacy{'login'} = 1;
1.518 albertel 4274: }
1.632 raeburn 4275: } else {
4276: $legacy{'login'} = 1;
1.518 albertel 4277: }
4278: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 4279: if (keys(%{$domconfig{'rolecolors'}})) {
4280: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
4281: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
4282: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
4283: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
4284: }
1.518 albertel 4285: }
4286: }
1.632 raeburn 4287: } else {
4288: $legacy{'rolecolors'} = 1;
1.518 albertel 4289: }
1.632 raeburn 4290: } else {
4291: $legacy{'rolecolors'} = 1;
1.518 albertel 4292: }
1.948 raeburn 4293: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
4294: if ($domconfig{'autoenroll'}{'co-owners'}) {
4295: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
4296: }
4297: }
1.632 raeburn 4298: if (keys(%legacy) > 0) {
4299: my %legacyhash = &get_legacy_domconf($udom);
4300: foreach my $item (keys(%legacyhash)) {
4301: if ($item =~ /^\Q$udom\E\.login/) {
4302: if ($legacy{'login'}) {
4303: $designhash{$item} = $legacyhash{$item};
4304: }
4305: } else {
4306: if ($legacy{'rolecolors'}) {
4307: $designhash{$item} = $legacyhash{$item};
4308: }
1.518 albertel 4309: }
4310: }
4311: }
1.632 raeburn 4312: } else {
4313: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4314: }
4315: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4316: $cachetime);
4317: return %designhash;
4318: }
4319:
1.632 raeburn 4320: sub get_legacy_domconf {
4321: my ($udom) = @_;
4322: my %legacyhash;
4323: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4324: my $designfile = $designdir.'/'.$udom.'.tab';
4325: if (-e $designfile) {
4326: if ( open (my $fh,"<$designfile") ) {
4327: while (my $line = <$fh>) {
4328: next if ($line =~ /^\#/);
4329: chomp($line);
4330: my ($key,$val)=(split(/\=/,$line));
4331: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4332: }
4333: close($fh);
4334: }
4335: }
4336: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
4337: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4338: }
4339: return %legacyhash;
4340: }
4341:
1.63 www 4342: =pod
4343:
1.112 bowersj2 4344: =item * &domainlogo()
1.63 www 4345:
4346: Inputs: $domain (usually will be undef)
4347:
4348: Returns: A link to a domain logo, if the domain logo exists.
4349: If the domain logo does not exist, a description of the domain.
4350:
4351: =cut
1.112 bowersj2 4352:
1.63 www 4353: ###############################################
4354: sub domainlogo {
1.517 raeburn 4355: my $domain = &determinedomain(shift);
1.518 albertel 4356: my %designhash = &get_domainconf($domain);
1.517 raeburn 4357: # See if there is a logo
4358: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4359: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4360: if ($imgsrc =~ m{^/(adm|res)/}) {
4361: if ($imgsrc =~ m{^/res/}) {
4362: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4363: &Apache::lonnet::repcopy($local_name);
4364: }
4365: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4366: }
4367: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4368: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4369: return &Apache::lonnet::domain($domain,'description');
1.59 www 4370: } else {
1.60 matthew 4371: return '';
1.59 www 4372: }
4373: }
1.63 www 4374: ##############################################
4375:
4376: =pod
4377:
1.112 bowersj2 4378: =item * &designparm()
1.63 www 4379:
4380: Inputs: $which parameter; $domain (usually will be undef)
4381:
4382: Returns: value of designparamter $which
4383:
4384: =cut
1.112 bowersj2 4385:
1.397 albertel 4386:
1.400 albertel 4387: ##############################################
1.397 albertel 4388: sub designparm {
4389: my ($which,$domain)=@_;
4390: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 4391: return $env{'environment.color.'.$which};
1.96 www 4392: }
1.63 www 4393: $domain=&determinedomain($domain);
1.518 albertel 4394: my %domdesign = &get_domainconf($domain);
1.520 raeburn 4395: my $output;
1.517 raeburn 4396: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 4397: $output = $domdesign{$domain.'.'.$which};
1.63 www 4398: } else {
1.520 raeburn 4399: $output = $defaultdesign{$which};
4400: }
4401: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4402: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4403: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 4404: if ($output =~ m{^/res/}) {
4405: my $local_name = &Apache::lonnet::filelocation('',$output);
4406: &Apache::lonnet::repcopy($local_name);
4407: }
1.520 raeburn 4408: $output = &lonhttpdurl($output);
4409: }
1.63 www 4410: }
1.520 raeburn 4411: return $output;
1.63 www 4412: }
1.59 www 4413:
1.822 bisitz 4414: ##############################################
4415: =pod
4416:
1.832 bisitz 4417: =item * &authorspace()
4418:
4419: Inputs: ./.
4420:
4421: Returns: Path to the Construction Space of the current user's
4422: accessed author space
4423: The author space will be that of the current user
4424: when accessing the own author space
4425: and that of the co-author/assistent co-author
4426: when accessing the co-author's/assistent co-author's
4427: space
4428:
4429: =cut
4430:
4431: sub authorspace {
4432: my $caname = '';
4433: if ($env{'request.role'} =~ /^ca|^aa/) {
4434: (undef,$caname) =
4435: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
4436: } else {
4437: $caname = $env{'user.name'};
4438: }
4439: return '/priv/'.$caname.'/';
4440: }
4441:
4442: ##############################################
4443: =pod
4444:
1.822 bisitz 4445: =item * &head_subbox()
4446:
4447: Inputs: $content (contains HTML code with page functions, etc.)
4448:
4449: Returns: HTML div with $content
4450: To be included in page header
4451:
4452: =cut
4453:
4454: sub head_subbox {
4455: my ($content)=@_;
4456: my $output =
1.844 bisitz 4457: '<div id="LC_head_subbox">'
1.822 bisitz 4458: .$content
4459: .'</div>'
4460: }
4461:
4462: ##############################################
4463: =pod
4464:
4465: =item * &CSTR_pageheader()
4466:
4467: Inputs: ./.
4468:
4469: Returns: HTML div with CSTR path and recent box
4470: To be included on Construction Space pages
4471:
4472: =cut
4473:
4474: sub CSTR_pageheader {
4475: # this is for resources; directories have customtitle, and crumbs
4476: # and select recent are created in lonpubdir.pm
4477: my ($uname,$thisdisfn)=
4478: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
4479: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4480: $formaction=~s/\/+/\//g;
4481:
4482: my $parentpath = '';
4483: my $lastitem = '';
4484: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4485: $parentpath = $1;
4486: $lastitem = $2;
4487: } else {
4488: $lastitem = $thisdisfn;
4489: }
1.921 bisitz 4490:
4491: my $output =
1.822 bisitz 4492: '<div>'
4493: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
4494: .'<b>'.&mt('Construction Space:').'</b> '
4495: .'<form name="dirs" method="post" action="'.$formaction
1.921 bisitz 4496: .'" target="_top">' #FIXME lonpubdir: target="_parent"
4497: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv',undef,undef);
4498:
4499: if ($lastitem) {
4500: $output .=
4501: '<span class="LC_filename">'
4502: .$lastitem
4503: .'</span>';
4504: }
4505: $output .=
4506: '<br />'
1.822 bisitz 4507: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
4508: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4509: .'</form>'
4510: .&Apache::lonmenu::constspaceform()
4511: .'</div>';
1.921 bisitz 4512:
4513: return $output;
1.822 bisitz 4514: }
4515:
1.60 matthew 4516: ###############################################
4517: ###############################################
4518:
4519: =pod
4520:
1.112 bowersj2 4521: =back
4522:
1.549 albertel 4523: =head1 HTML Helpers
1.112 bowersj2 4524:
4525: =over 4
4526:
4527: =item * &bodytag()
1.60 matthew 4528:
4529: Returns a uniform header for LON-CAPA web pages.
4530:
4531: Inputs:
4532:
1.112 bowersj2 4533: =over 4
4534:
4535: =item * $title, A title to be displayed on the page.
4536:
4537: =item * $function, the current role (can be undef).
4538:
4539: =item * $addentries, extra parameters for the <body> tag.
4540:
4541: =item * $bodyonly, if defined, only return the <body> tag.
4542:
4543: =item * $domain, if defined, force a given domain.
4544:
4545: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4546: text interface only)
1.60 matthew 4547:
1.814 bisitz 4548: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
4549: navigational links
1.317 albertel 4550:
1.338 albertel 4551: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4552:
1.361 albertel 4553: =item * $no_inline_link, if true and in remote mode, don't show the
4554: 'Switch To Inline Menu' link
4555:
1.460 albertel 4556: =item * $args, optional argument valid values are
4557: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4558: inherit_jsmath -> when creating popup window in a page,
4559: should it have jsmath forced on by the
4560: current page
1.460 albertel 4561:
1.112 bowersj2 4562: =back
4563:
1.60 matthew 4564: Returns: A uniform header for LON-CAPA web pages.
4565: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4566: If $bodyonly is undef or zero, an html string containing a <body> tag and
4567: other decorations will be returned.
4568:
4569: =cut
4570:
1.54 www 4571: sub bodytag {
1.831 bisitz 4572: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.816 bisitz 4573: $no_nav_bar,$bgcolor,$no_inline_link,$args)=@_;
1.339 albertel 4574:
1.948.2.2! raeburn 4575: my $public;
! 4576: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
! 4577: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
! 4578: $public = 1;
! 4579: }
1.460 albertel 4580: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4581:
1.183 matthew 4582: $function = &get_users_function() if (!$function);
1.339 albertel 4583: my $img = &designparm($function.'.img',$domain);
4584: my $font = &designparm($function.'.font',$domain);
4585: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4586:
1.803 bisitz 4587: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 4588: 'bgcolor' => $pgbg,
1.339 albertel 4589: 'text' => $font,
4590: 'alink' => &designparm($function.'.alink',$domain),
4591: 'vlink' => &designparm($function.'.vlink',$domain),
4592: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4593: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4594:
1.63 www 4595: # role and realm
1.378 raeburn 4596: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4597: if ($role eq 'ca') {
1.479 albertel 4598: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4599: $realm = &plainname($rname,$rdom);
1.378 raeburn 4600: }
1.55 www 4601: # realm
1.258 albertel 4602: if ($env{'request.course.id'}) {
1.378 raeburn 4603: if ($env{'request.role'} !~ /^cr/) {
4604: $role = &Apache::lonnet::plaintext($role,&course_type());
4605: }
1.898 raeburn 4606: if ($env{'request.course.sec'}) {
4607: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
4608: }
1.359 albertel 4609: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4610: } else {
4611: $role = &Apache::lonnet::plaintext($role);
1.54 www 4612: }
1.433 albertel 4613:
1.359 albertel 4614: if (!$realm) { $realm=' '; }
1.55 www 4615: # Set messages
1.60 matthew 4616: my $messages=&domainlogo($domain);
1.330 albertel 4617:
1.438 albertel 4618: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4619:
1.101 www 4620: # construct main body tag
1.359 albertel 4621: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4622: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4623:
1.530 albertel 4624: if ($bodyonly) {
1.60 matthew 4625: return $bodytag;
1.798 tempelho 4626: }
1.359 albertel 4627:
1.410 albertel 4628: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.948.2.2! raeburn 4629: if ($public) {
1.433 albertel 4630: undef($role);
1.434 albertel 4631: } else {
4632: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4633: }
1.948.2.2! raeburn 4634:
1.762 bisitz 4635: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 4636: #
4637: # Extra info if you are the DC
4638: my $dc_info = '';
4639: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4640: $env{'course.'.$env{'request.course.id'}.
4641: '.domain'}.'/'})) {
4642: my $cid = $env{'request.course.id'};
1.917 raeburn 4643: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4644: $dc_info =~ s/\s+$//;
1.359 albertel 4645: }
4646:
1.898 raeburn 4647: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853 droeschl 4648: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
4649:
1.837 bisitz 4650: if ($env{'environment.remote'} eq 'off') {
1.359 albertel 4651: # No Remote
1.916 droeschl 4652: if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') {
4653: return $bodytag;
4654: }
1.903 droeschl 4655:
4656: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
4657:
4658: # if ($env{'request.state'} eq 'construct') {
4659: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
4660: # }
4661:
1.359 albertel 4662:
4663:
1.916 droeschl 4664: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917 raeburn 4665: if ($dc_info) {
4666: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
4667: }
1.916 droeschl 4668: $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
4669: <em>$realm</em> $dc_info</div>|;
1.903 droeschl 4670: return $bodytag;
4671: }
1.894 droeschl 4672:
1.927 raeburn 4673: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
4674: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
4675: }
1.916 droeschl 4676:
1.903 droeschl 4677: $bodytag .= Apache::lonhtmlcommon::scripttag(
4678: Apache::lonmenu::utilityfunctions(), 'start');
1.816 bisitz 4679:
1.903 droeschl 4680: $bodytag .= Apache::lonmenu::primary_menu();
1.852 droeschl 4681:
1.917 raeburn 4682: if ($dc_info) {
4683: $dc_info = &dc_courseid_toggle($dc_info);
4684: }
4685: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 4686:
1.903 droeschl 4687: #don't show menus for public users
1.948.2.2! raeburn 4688: if (!$public){
1.903 droeschl 4689: $bodytag .= Apache::lonmenu::secondary_menu();
4690: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 4691: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
4692: if ($env{'request.state'} eq 'construct') {
4693: $bodytag .= &Apache::lonmenu::innerregister($forcereg,'',
4694: $args->{'bread_crumbs'});
4695: } elsif ($forcereg) {
4696: $bodytag .= &Apache::lonmenu::innerregister($forcereg);
4697: }
1.903 droeschl 4698: }else{
4699: # this is to seperate menu from content when there's no secondary
4700: # menu. Especially needed for public accessible ressources.
4701: $bodytag .= '<hr style="clear:both" />';
4702: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 4703: }
1.903 droeschl 4704:
1.235 raeburn 4705: return $bodytag;
1.94 www 4706: }
1.95 www 4707:
1.93 www 4708: #
1.95 www 4709: # Top frame rendering, Remote is up
1.93 www 4710: #
1.359 albertel 4711:
1.517 raeburn 4712: my $imgsrc = $img;
4713: if ($img =~ /^\/adm/) {
1.575 albertel 4714: $imgsrc = &lonhttpdurl($img);
1.517 raeburn 4715: }
4716: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359 albertel 4717:
1.305 www 4718: # Explicit link to get inline menu
1.361 albertel 4719: my $menu= ($no_inline_link?''
1.883 droeschl 4720: :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
1.917 raeburn 4721:
4722: if ($dc_info) {
4723: $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
4724: }
4725:
1.916 droeschl 4726: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>
1.897 wenzelju 4727: <ol class="LC_primary_menu LC_right">
1.853 droeschl 4728: <li>$menu</li>
1.917 raeburn 4729: </ol><div id="LC_realm"> $realm $dc_info</div>| unless $env{'form.inhibitmenu'};
1.94 www 4730: return(<<ENDBODY);
1.60 matthew 4731: $bodytag
1.359 albertel 4732: <table id="LC_title_bar" class="LC_with_remote">
1.791 tempelho 4733: <tr><td>$upperleft</td>
4734: <td>$messages </td>
1.54 www 4735: </tr>
1.359 albertel 4736: <tr><td>$titleinfo $dc_info $menu</td>
1.368 albertel 4737: </tr>
1.356 albertel 4738: </table>
1.54 www 4739: ENDBODY
1.182 matthew 4740: }
4741:
1.917 raeburn 4742: sub dc_courseid_toggle {
4743: my ($dc_info) = @_;
4744: return ' <span id="dccidtext" class="LC_cusr_subheading">'.
4745: '<a href="javascript:showCourseID();">'.
4746: &mt('(More ...)').'</a></span>'.
4747: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
4748: }
4749:
1.330 albertel 4750: sub make_attr_string {
4751: my ($register,$attr_ref) = @_;
4752:
4753: if ($attr_ref && !ref($attr_ref)) {
4754: die("addentries Must be a hash ref ".
4755: join(':',caller(1))." ".
4756: join(':',caller(0))." ");
4757: }
4758:
4759: if ($register) {
1.339 albertel 4760: my ($on_load,$on_unload);
4761: foreach my $key (keys(%{$attr_ref})) {
4762: if (lc($key) eq 'onload') {
4763: $on_load.=$attr_ref->{$key}.';';
4764: delete($attr_ref->{$key});
4765:
4766: } elsif (lc($key) eq 'onunload') {
4767: $on_unload.=$attr_ref->{$key}.';';
4768: delete($attr_ref->{$key});
4769: }
4770: }
4771: $attr_ref->{'onload'} =
4772: &Apache::lonmenu::loadevents(). $on_load;
4773: $attr_ref->{'onunload'}=
4774: &Apache::lonmenu::unloadevents().$on_unload;
4775: }
4776:
4777: # Accessibility font enhance
4778: if ($env{'browser.fontenhance'} eq 'on') {
4779: my $style;
4780: foreach my $key (keys(%{$attr_ref})) {
4781: if (lc($key) eq 'style') {
4782: $style.=$attr_ref->{$key}.';';
4783: delete($attr_ref->{$key});
4784: }
4785: }
4786: $attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330 albertel 4787: }
1.339 albertel 4788:
1.330 albertel 4789: my $attr_string;
4790: foreach my $attr (keys(%$attr_ref)) {
4791: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4792: }
4793: return $attr_string;
4794: }
4795:
4796:
1.182 matthew 4797: ###############################################
1.251 albertel 4798: ###############################################
4799:
4800: =pod
4801:
4802: =item * &endbodytag()
4803:
4804: Returns a uniform footer for LON-CAPA web pages.
4805:
1.635 raeburn 4806: Inputs: 1 - optional reference to an args hash
4807: If in the hash, key for noredirectlink has a value which evaluates to true,
4808: a 'Continue' link is not displayed if the page contains an
4809: internal redirect in the <head></head> section,
4810: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4811:
4812: =cut
4813:
4814: sub endbodytag {
1.635 raeburn 4815: my ($args) = @_;
1.251 albertel 4816: my $endbodytag='</body>';
1.269 albertel 4817: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4818: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4819: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4820: $endbodytag=
4821: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4822: &mt('Continue').'</a>'.
4823: $endbodytag;
4824: }
1.315 albertel 4825: }
1.251 albertel 4826: return $endbodytag;
4827: }
4828:
1.352 albertel 4829: =pod
4830:
4831: =item * &standard_css()
4832:
4833: Returns a style sheet
4834:
4835: Inputs: (all optional)
4836: domain -> force to color decorate a page for a specific
4837: domain
4838: function -> force usage of a specific rolish color scheme
4839: bgcolor -> override the default page bgcolor
4840:
4841: =cut
4842:
1.343 albertel 4843: sub standard_css {
1.345 albertel 4844: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4845: $function = &get_users_function() if (!$function);
4846: my $img = &designparm($function.'.img', $domain);
4847: my $tabbg = &designparm($function.'.tabbg', $domain);
4848: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 4849: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 4850: #second colour for later usage
1.345 albertel 4851: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4852: my $pgbg_or_bgcolor =
4853: $bgcolor ||
1.352 albertel 4854: &designparm($function.'.pgbg', $domain);
1.382 albertel 4855: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4856: my $alink = &designparm($function.'.alink', $domain);
4857: my $vlink = &designparm($function.'.vlink', $domain);
4858: my $link = &designparm($function.'.link', $domain);
4859:
1.704 muellerd 4860: my $loginbg = &designparm('login.sidebg',$domain);
1.712 muellerd 4861: my $bgcol = &designparm('login.bgcol',$domain);
4862: my $textcol = &designparm('login.textcol',$domain);
1.704 muellerd 4863:
1.602 albertel 4864: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4865: my $mono = 'monospace';
1.850 bisitz 4866: my $data_table_head = $sidebg;
4867: my $data_table_light = '#FAFAFA';
4868: my $data_table_dark = '#F0F0F0';
1.470 banghart 4869: my $data_table_darker = '#CCCCCC';
1.349 albertel 4870: my $data_table_highlight = '#FFFF00';
1.352 albertel 4871: my $mail_new = '#FFBB77';
4872: my $mail_new_hover = '#DD9955';
4873: my $mail_read = '#BBBB77';
4874: my $mail_read_hover = '#999944';
4875: my $mail_replied = '#AAAA88';
4876: my $mail_replied_hover = '#888855';
4877: my $mail_other = '#99BBBB';
4878: my $mail_other_hover = '#669999';
1.391 albertel 4879: my $table_header = '#DDDDDD';
1.489 raeburn 4880: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 4881: my $lg_border_color = '#C8C8C8';
1.948.2.1 raeburn 4882: my $button_hover = '#BF2317';
1.392 albertel 4883:
1.608 albertel 4884: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 4885: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
4886: : '0 3px 0 4px';
1.448 albertel 4887:
1.343 albertel 4888: return <<END;
1.947 droeschl 4889:
4890: /* needed for iframe to allow 100% height in FF */
4891: body, html {
4892: margin: 0;
4893: padding: 0 0.5%;
4894: height: 99%; /* to avoid scrollbars */
4895: }
4896:
1.795 www 4897: body {
1.911 bisitz 4898: font-family: $sans;
4899: line-height:130%;
4900: font-size:0.83em;
4901: color:$font;
1.795 www 4902: }
4903:
1.911 bisitz 4904: a:focus {
1.795 www 4905: color: red;
1.911 bisitz 4906: background: yellow;
1.795 www 4907: }
1.698 harmsja 4908:
1.911 bisitz 4909: form, .inline {
4910: display: inline;
1.795 www 4911: }
1.721 harmsja 4912:
1.795 www 4913: .LC_right {
1.911 bisitz 4914: text-align:right;
1.795 www 4915: }
4916:
4917: .LC_middle {
1.911 bisitz 4918: vertical-align:middle;
1.795 www 4919: }
1.721 harmsja 4920:
1.911 bisitz 4921: .LC_400Box {
4922: width:400px;
4923: }
1.721 harmsja 4924:
1.947 droeschl 4925: .LC_iframecontainer {
4926: width: 98%;
4927: margin: 0;
4928: position: fixed;
4929: top: 8.5em;
4930: bottom: 0;
4931: }
4932:
4933: .LC_iframecontainer iframe{
4934: border: none;
4935: width: 100%;
4936: height: 100%;
4937: }
4938:
1.778 bisitz 4939: .LC_filename {
4940: font-family: $mono;
4941: white-space:pre;
1.921 bisitz 4942: font-size: 120%;
1.778 bisitz 4943: }
4944:
4945: .LC_fileicon {
4946: border: none;
4947: height: 1.3em;
4948: vertical-align: text-bottom;
4949: margin-right: 0.3em;
4950: text-decoration:none;
4951: }
4952:
1.350 albertel 4953: .LC_error {
4954: color: red;
4955: font-size: larger;
4956: }
1.795 www 4957:
1.457 albertel 4958: .LC_warning,
4959: .LC_diff_removed {
1.733 bisitz 4960: color: red;
1.394 albertel 4961: }
1.532 albertel 4962:
4963: .LC_info,
1.457 albertel 4964: .LC_success,
4965: .LC_diff_added {
1.350 albertel 4966: color: green;
4967: }
1.795 www 4968:
1.802 bisitz 4969: div.LC_confirm_box {
4970: background-color: #FAFAFA;
4971: border: 1px solid $lg_border_color;
4972: margin-right: 0;
4973: padding: 5px;
4974: }
4975:
4976: div.LC_confirm_box .LC_error img,
4977: div.LC_confirm_box .LC_success img {
4978: vertical-align: middle;
4979: }
4980:
1.440 albertel 4981: .LC_icon {
1.771 droeschl 4982: border: none;
1.790 droeschl 4983: vertical-align: middle;
1.771 droeschl 4984: }
4985:
1.543 albertel 4986: .LC_docs_spacer {
4987: width: 25px;
4988: height: 1px;
1.771 droeschl 4989: border: none;
1.543 albertel 4990: }
1.346 albertel 4991:
1.532 albertel 4992: .LC_internal_info {
1.735 bisitz 4993: color: #999999;
1.532 albertel 4994: }
4995:
1.794 www 4996: .LC_discussion {
1.911 bisitz 4997: background: $tabbg;
4998: border: 1px solid black;
4999: margin: 2px;
1.794 www 5000: }
5001:
5002: .LC_disc_action_links_bar {
1.911 bisitz 5003: background: $tabbg;
5004: border: none;
5005: margin: 4px;
1.794 www 5006: }
5007:
5008: .LC_disc_action_left {
1.911 bisitz 5009: text-align: left;
1.794 www 5010: }
5011:
5012: .LC_disc_action_right {
1.911 bisitz 5013: text-align: right;
1.794 www 5014: }
5015:
5016: .LC_disc_new_item {
1.911 bisitz 5017: background: white;
5018: border: 2px solid red;
5019: margin: 2px;
1.794 www 5020: }
5021:
5022: .LC_disc_old_item {
1.911 bisitz 5023: background: white;
5024: border: 1px solid black;
5025: margin: 2px;
1.794 www 5026: }
5027:
1.458 albertel 5028: table.LC_pastsubmission {
5029: border: 1px solid black;
5030: margin: 2px;
5031: }
5032:
1.924 bisitz 5033: table#LC_menubuttons {
1.345 albertel 5034: width: 100%;
5035: background: $pgbg;
1.392 albertel 5036: border: 2px;
1.402 albertel 5037: border-collapse: separate;
1.803 bisitz 5038: padding: 0;
1.345 albertel 5039: }
1.392 albertel 5040:
1.801 tempelho 5041: table#LC_title_bar a {
5042: color: $fontmenu;
5043: }
1.836 bisitz 5044:
1.807 droeschl 5045: table#LC_title_bar {
1.819 tempelho 5046: clear: both;
1.836 bisitz 5047: display: none;
1.807 droeschl 5048: }
5049:
1.795 www 5050: table#LC_title_bar,
1.933 droeschl 5051: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 5052: table#LC_title_bar.LC_with_remote {
1.359 albertel 5053: width: 100%;
1.392 albertel 5054: border-color: $pgbg;
5055: border-style: solid;
5056: border-width: $border;
1.379 albertel 5057: background: $pgbg;
1.801 tempelho 5058: color: $fontmenu;
1.392 albertel 5059: border-collapse: collapse;
1.803 bisitz 5060: padding: 0;
1.819 tempelho 5061: margin: 0;
1.359 albertel 5062: }
1.795 www 5063:
1.933 droeschl 5064: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 5065: margin: 0;
5066: padding: 0;
1.933 droeschl 5067: position: relative;
5068: list-style: none;
1.913 droeschl 5069: }
1.933 droeschl 5070: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 5071: display: inline;
5072: }
1.933 droeschl 5073:
5074: .LC_breadcrumb_tools_navigation {
1.913 droeschl 5075: padding: 0;
1.933 droeschl 5076: margin: 0;
5077: float: left;
1.913 droeschl 5078: }
1.933 droeschl 5079: .LC_breadcrumb_tools_tools {
5080: padding: 0;
5081: margin: 0;
1.913 droeschl 5082: float: right;
5083: }
5084:
1.359 albertel 5085: table#LC_title_bar td {
5086: background: $tabbg;
5087: }
1.795 www 5088:
1.911 bisitz 5089: table#LC_menubuttons img {
1.803 bisitz 5090: border: none;
1.346 albertel 5091: }
1.795 www 5092:
1.842 droeschl 5093: .LC_breadcrumbs_component {
1.911 bisitz 5094: float: right;
5095: margin: 0 1em;
1.357 albertel 5096: }
1.842 droeschl 5097: .LC_breadcrumbs_component img {
1.911 bisitz 5098: vertical-align: middle;
1.777 tempelho 5099: }
1.795 www 5100:
1.383 albertel 5101: td.LC_table_cell_checkbox {
5102: text-align: center;
5103: }
1.795 www 5104:
5105: .LC_fontsize_small {
1.911 bisitz 5106: font-size: 70%;
1.705 tempelho 5107: }
5108:
1.844 bisitz 5109: #LC_breadcrumbs {
1.911 bisitz 5110: clear:both;
5111: background: $sidebg;
5112: border-bottom: 1px solid $lg_border_color;
5113: line-height: 2.5em;
1.933 droeschl 5114: overflow: hidden;
1.911 bisitz 5115: margin: 0;
5116: padding: 0;
1.819 tempelho 5117: }
1.862 bisitz 5118:
1.839 droeschl 5119: /* Preliminary fix to hide breadcrumbs inside remote control window */
1.844 bisitz 5120: #LC_remote #LC_breadcrumbs {
1.911 bisitz 5121: display:none;
1.839 droeschl 5122: }
1.819 tempelho 5123:
1.844 bisitz 5124: #LC_head_subbox {
1.911 bisitz 5125: clear:both;
5126: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 5127: border: 1px solid $sidebg;
5128: margin: 0 0 10px 0;
1.822 bisitz 5129: }
5130:
1.795 www 5131: .LC_fontsize_medium {
1.911 bisitz 5132: font-size: 85%;
1.705 tempelho 5133: }
5134:
1.795 www 5135: .LC_fontsize_large {
1.911 bisitz 5136: font-size: 120%;
1.705 tempelho 5137: }
5138:
1.346 albertel 5139: .LC_menubuttons_inline_text {
5140: color: $font;
1.698 harmsja 5141: font-size: 90%;
1.701 harmsja 5142: padding-left:3px;
1.346 albertel 5143: }
5144:
1.934 droeschl 5145: .LC_menubuttons_inline_text img{
5146: vertical-align: middle;
5147: }
5148:
1.948.2.1 raeburn 5149: li.LC_menubuttons_inline_text img,a {
5150: cursor:pointer;
5151: }
5152:
1.526 www 5153: .LC_menubuttons_link {
5154: text-decoration: none;
5155: }
1.795 www 5156:
1.522 albertel 5157: .LC_menubuttons_category {
1.521 www 5158: color: $font;
1.526 www 5159: background: $pgbg;
1.521 www 5160: font-size: larger;
5161: font-weight: bold;
5162: }
5163:
1.346 albertel 5164: td.LC_menubuttons_text {
1.911 bisitz 5165: color: $font;
1.346 albertel 5166: }
1.706 harmsja 5167:
1.346 albertel 5168: .LC_current_location {
5169: background: $tabbg;
5170: }
1.795 www 5171:
1.938 bisitz 5172: table.LC_data_table {
1.347 albertel 5173: border: 1px solid #000000;
1.402 albertel 5174: border-collapse: separate;
1.426 albertel 5175: border-spacing: 1px;
1.610 albertel 5176: background: $pgbg;
1.347 albertel 5177: }
1.795 www 5178:
1.422 albertel 5179: .LC_data_table_dense {
5180: font-size: small;
5181: }
1.795 www 5182:
1.507 raeburn 5183: table.LC_nested_outer {
5184: border: 1px solid #000000;
1.589 raeburn 5185: border-collapse: collapse;
1.803 bisitz 5186: border-spacing: 0;
1.507 raeburn 5187: width: 100%;
5188: }
1.795 www 5189:
1.879 raeburn 5190: table.LC_innerpickbox,
1.507 raeburn 5191: table.LC_nested {
1.803 bisitz 5192: border: none;
1.589 raeburn 5193: border-collapse: collapse;
1.803 bisitz 5194: border-spacing: 0;
1.507 raeburn 5195: width: 100%;
5196: }
1.795 www 5197:
1.930 faziophi 5198: .ui-accordion,
5199: .ui-accordion table.LC_data_table,
5200: .ui-accordion table.LC_nested_outer{
5201: border: 0px;
5202: border-spacing: 0px;
5203: margin: 3px;
5204: }
5205:
1.911 bisitz 5206: table.LC_data_table tr th,
5207: table.LC_calendar tr th,
1.879 raeburn 5208: table.LC_prior_tries tr th,
5209: table.LC_innerpickbox tr th {
1.349 albertel 5210: font-weight: bold;
5211: background-color: $data_table_head;
1.801 tempelho 5212: color:$fontmenu;
1.701 harmsja 5213: font-size:90%;
1.347 albertel 5214: }
1.795 www 5215:
1.879 raeburn 5216: table.LC_innerpickbox tr th,
5217: table.LC_innerpickbox tr td {
5218: vertical-align: top;
5219: }
5220:
1.711 raeburn 5221: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 5222: background-color: #CCCCCC;
1.711 raeburn 5223: font-weight: bold;
5224: text-align: left;
5225: }
1.795 www 5226:
1.912 bisitz 5227: table.LC_data_table tr.LC_odd_row > td {
5228: background-color: $data_table_light;
5229: padding: 2px;
5230: vertical-align: top;
5231: }
5232:
1.809 bisitz 5233: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 5234: background-color: $data_table_light;
1.912 bisitz 5235: vertical-align: top;
5236: }
5237:
5238: table.LC_data_table tr.LC_even_row > td {
5239: background-color: $data_table_dark;
1.425 albertel 5240: padding: 2px;
1.900 bisitz 5241: vertical-align: top;
1.347 albertel 5242: }
1.795 www 5243:
1.809 bisitz 5244: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 5245: background-color: $data_table_dark;
1.900 bisitz 5246: vertical-align: top;
1.347 albertel 5247: }
1.795 www 5248:
1.425 albertel 5249: table.LC_data_table tr.LC_data_table_highlight td {
5250: background-color: $data_table_darker;
5251: }
1.795 www 5252:
1.639 raeburn 5253: table.LC_data_table tr td.LC_leftcol_header {
5254: background-color: $data_table_head;
5255: font-weight: bold;
5256: }
1.795 www 5257:
1.451 albertel 5258: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5259: table.LC_nested tr.LC_empty_row td {
1.421 albertel 5260: font-weight: bold;
5261: font-style: italic;
5262: text-align: center;
5263: padding: 8px;
1.347 albertel 5264: }
1.795 www 5265:
1.940 bisitz 5266: table.LC_data_table tr.LC_empty_row td {
5267: background-color: $sidebg;
5268: }
5269:
5270: table.LC_nested tr.LC_empty_row td {
5271: background-color: #FFFFFF;
5272: }
5273:
1.890 droeschl 5274: table.LC_caption {
5275: }
5276:
1.507 raeburn 5277: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5278: padding: 4ex
5279: }
1.795 www 5280:
1.507 raeburn 5281: table.LC_nested_outer tr th {
5282: font-weight: bold;
1.801 tempelho 5283: color:$fontmenu;
1.507 raeburn 5284: background-color: $data_table_head;
1.701 harmsja 5285: font-size: small;
1.507 raeburn 5286: border-bottom: 1px solid #000000;
5287: }
1.795 www 5288:
1.507 raeburn 5289: table.LC_nested_outer tr td.LC_subheader {
5290: background-color: $data_table_head;
5291: font-weight: bold;
5292: font-size: small;
5293: border-bottom: 1px solid #000000;
5294: text-align: right;
1.451 albertel 5295: }
1.795 www 5296:
1.507 raeburn 5297: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5298: background-color: #CCCCCC;
1.451 albertel 5299: font-weight: bold;
5300: font-size: small;
1.507 raeburn 5301: text-align: center;
5302: }
1.795 www 5303:
1.589 raeburn 5304: table.LC_nested tr.LC_info_row td.LC_left_item,
5305: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5306: text-align: left;
1.451 albertel 5307: }
1.795 www 5308:
1.507 raeburn 5309: table.LC_nested td {
1.735 bisitz 5310: background-color: #FFFFFF;
1.451 albertel 5311: font-size: small;
1.507 raeburn 5312: }
1.795 www 5313:
1.507 raeburn 5314: table.LC_nested_outer tr th.LC_right_item,
5315: table.LC_nested tr.LC_info_row td.LC_right_item,
5316: table.LC_nested tr.LC_odd_row td.LC_right_item,
5317: table.LC_nested tr td.LC_right_item {
1.451 albertel 5318: text-align: right;
5319: }
5320:
1.930 faziophi 5321: .ui-accordion table.LC_nested tr.LC_odd_row td.LC_left_item,
5322: .ui-accordion table.LC_nested tr.LC_even_row td.LC_left_item {
5323: text-align: right;
5324: width: 40%;
5325: padding-right:10px;
5326: vertical-align: top;
5327: padding: 5px;
5328: }
5329:
5330: .ui-accordion table.LC_nested tr.LC_odd_row td.LC_right_item,
5331: .ui-accordion table.LC_nested tr.LC_even_row td.LC_right_item {
5332: text-align: left;
5333: width: 60%;
5334: padding: 2px 4px;
5335: }
5336:
1.507 raeburn 5337: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5338: background-color: #EEEEEE;
1.451 albertel 5339: }
5340:
1.473 raeburn 5341: table.LC_createuser {
5342: }
5343:
5344: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5345: font-size: small;
1.473 raeburn 5346: }
5347:
5348: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5349: background-color: #CCCCCC;
1.473 raeburn 5350: font-weight: bold;
5351: text-align: center;
5352: }
5353:
1.349 albertel 5354: table.LC_calendar {
5355: border: 1px solid #000000;
5356: border-collapse: collapse;
1.917 raeburn 5357: width: 98%;
1.349 albertel 5358: }
1.795 www 5359:
1.349 albertel 5360: table.LC_calendar_pickdate {
5361: font-size: xx-small;
5362: }
1.795 www 5363:
1.349 albertel 5364: table.LC_calendar tr td {
5365: border: 1px solid #000000;
5366: vertical-align: top;
1.917 raeburn 5367: width: 14%;
1.349 albertel 5368: }
1.795 www 5369:
1.349 albertel 5370: table.LC_calendar tr td.LC_calendar_day_empty {
5371: background-color: $data_table_dark;
5372: }
1.795 www 5373:
1.779 bisitz 5374: table.LC_calendar tr td.LC_calendar_day_current {
5375: background-color: $data_table_highlight;
1.777 tempelho 5376: }
1.795 www 5377:
1.938 bisitz 5378: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 5379: background-color: $mail_new;
5380: }
1.795 www 5381:
1.938 bisitz 5382: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 5383: background-color: $mail_new_hover;
5384: }
1.795 www 5385:
1.938 bisitz 5386: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 5387: background-color: $mail_read;
5388: }
1.795 www 5389:
1.938 bisitz 5390: /*
5391: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 5392: background-color: $mail_read_hover;
5393: }
1.938 bisitz 5394: */
1.795 www 5395:
1.938 bisitz 5396: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 5397: background-color: $mail_replied;
5398: }
1.795 www 5399:
1.938 bisitz 5400: /*
5401: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 5402: background-color: $mail_replied_hover;
5403: }
1.938 bisitz 5404: */
1.795 www 5405:
1.938 bisitz 5406: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 5407: background-color: $mail_other;
5408: }
1.795 www 5409:
1.938 bisitz 5410: /*
5411: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 5412: background-color: $mail_other_hover;
5413: }
1.938 bisitz 5414: */
1.494 raeburn 5415:
1.777 tempelho 5416: table.LC_data_table tr > td.LC_browser_file,
5417: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 5418: background: #AAEE77;
1.389 albertel 5419: }
1.795 www 5420:
1.777 tempelho 5421: table.LC_data_table tr > td.LC_browser_file_locked,
5422: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5423: background: #FFAA99;
1.387 albertel 5424: }
1.795 www 5425:
1.777 tempelho 5426: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 5427: background: #888888;
1.779 bisitz 5428: }
1.795 www 5429:
1.777 tempelho 5430: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5431: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 5432: background: #F8F866;
1.777 tempelho 5433: }
1.795 www 5434:
1.696 bisitz 5435: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 5436: background: #E0E8FF;
1.387 albertel 5437: }
1.696 bisitz 5438:
1.707 bisitz 5439: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 5440: /* background: #77FF77; */
1.707 bisitz 5441: }
1.795 www 5442:
1.707 bisitz 5443: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 5444: border-right: 8px solid #FFFF77;
1.707 bisitz 5445: }
1.795 www 5446:
1.707 bisitz 5447: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 5448: border-right: 8px solid #FFAA77;
1.707 bisitz 5449: }
1.795 www 5450:
1.707 bisitz 5451: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 5452: border-right: 8px solid #FF7777;
1.707 bisitz 5453: }
1.795 www 5454:
1.707 bisitz 5455: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 5456: border-right: 8px solid #AAFF77;
1.707 bisitz 5457: }
1.795 www 5458:
1.707 bisitz 5459: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 5460: border-right: 8px solid #11CC55;
1.707 bisitz 5461: }
5462:
1.388 albertel 5463: span.LC_current_location {
1.701 harmsja 5464: font-size:larger;
1.388 albertel 5465: background: $pgbg;
5466: }
1.387 albertel 5467:
1.395 albertel 5468: span.LC_parm_menu_item {
5469: font-size: larger;
5470: }
1.795 www 5471:
1.395 albertel 5472: span.LC_parm_scope_all {
5473: color: red;
5474: }
1.795 www 5475:
1.395 albertel 5476: span.LC_parm_scope_folder {
5477: color: green;
5478: }
1.795 www 5479:
1.395 albertel 5480: span.LC_parm_scope_resource {
5481: color: orange;
5482: }
1.795 www 5483:
1.395 albertel 5484: span.LC_parm_part {
5485: color: blue;
5486: }
1.795 www 5487:
1.911 bisitz 5488: span.LC_parm_folder,
5489: span.LC_parm_symb {
1.395 albertel 5490: font-size: x-small;
5491: font-family: $mono;
5492: color: #AAAAAA;
5493: }
5494:
1.795 www 5495: td.LC_parm_overview_level_menu,
5496: td.LC_parm_overview_map_menu,
5497: td.LC_parm_overview_parm_selectors,
5498: td.LC_parm_overview_restrictions {
1.396 albertel 5499: border: 1px solid black;
5500: border-collapse: collapse;
5501: }
1.795 www 5502:
1.396 albertel 5503: table.LC_parm_overview_restrictions td {
5504: border-width: 1px 4px 1px 4px;
5505: border-style: solid;
5506: border-color: $pgbg;
5507: text-align: center;
5508: }
1.795 www 5509:
1.396 albertel 5510: table.LC_parm_overview_restrictions th {
5511: background: $tabbg;
5512: border-width: 1px 4px 1px 4px;
5513: border-style: solid;
5514: border-color: $pgbg;
5515: }
1.795 www 5516:
1.398 albertel 5517: table#LC_helpmenu {
1.803 bisitz 5518: border: none;
1.398 albertel 5519: height: 55px;
1.803 bisitz 5520: border-spacing: 0;
1.398 albertel 5521: }
5522:
5523: table#LC_helpmenu fieldset legend {
5524: font-size: larger;
5525: }
1.795 www 5526:
1.397 albertel 5527: table#LC_helpmenu_links {
5528: width: 100%;
5529: border: 1px solid black;
5530: background: $pgbg;
1.803 bisitz 5531: padding: 0;
1.397 albertel 5532: border-spacing: 1px;
5533: }
1.795 www 5534:
1.397 albertel 5535: table#LC_helpmenu_links tr td {
5536: padding: 1px;
5537: background: $tabbg;
1.399 albertel 5538: text-align: center;
5539: font-weight: bold;
1.397 albertel 5540: }
1.396 albertel 5541:
1.795 www 5542: table#LC_helpmenu_links a:link,
5543: table#LC_helpmenu_links a:visited,
1.397 albertel 5544: table#LC_helpmenu_links a:active {
5545: text-decoration: none;
5546: color: $font;
5547: }
1.795 www 5548:
1.397 albertel 5549: table#LC_helpmenu_links a:hover {
5550: text-decoration: underline;
5551: color: $vlink;
5552: }
1.396 albertel 5553:
1.417 albertel 5554: .LC_chrt_popup_exists {
5555: border: 1px solid #339933;
5556: margin: -1px;
5557: }
1.795 www 5558:
1.417 albertel 5559: .LC_chrt_popup_up {
5560: border: 1px solid yellow;
5561: margin: -1px;
5562: }
1.795 www 5563:
1.417 albertel 5564: .LC_chrt_popup {
5565: border: 1px solid #8888FF;
5566: background: #CCCCFF;
5567: }
1.795 www 5568:
1.421 albertel 5569: table.LC_pick_box {
5570: border-collapse: separate;
5571: background: white;
5572: border: 1px solid black;
5573: border-spacing: 1px;
5574: }
1.795 www 5575:
1.421 albertel 5576: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 5577: background: $sidebg;
1.421 albertel 5578: font-weight: bold;
1.900 bisitz 5579: text-align: left;
1.740 bisitz 5580: vertical-align: top;
1.421 albertel 5581: width: 184px;
5582: padding: 8px;
5583: }
1.795 www 5584:
1.579 raeburn 5585: table.LC_pick_box td.LC_pick_box_value {
5586: text-align: left;
5587: padding: 8px;
5588: }
1.795 www 5589:
1.579 raeburn 5590: table.LC_pick_box td.LC_pick_box_select {
5591: text-align: left;
5592: padding: 8px;
5593: }
1.795 www 5594:
1.424 albertel 5595: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 5596: padding: 0;
1.421 albertel 5597: height: 1px;
5598: background: black;
5599: }
1.795 www 5600:
1.421 albertel 5601: table.LC_pick_box td.LC_pick_box_submit {
5602: text-align: right;
5603: }
1.795 www 5604:
1.579 raeburn 5605: table.LC_pick_box td.LC_evenrow_value {
5606: text-align: left;
5607: padding: 8px;
5608: background-color: $data_table_light;
5609: }
1.795 www 5610:
1.579 raeburn 5611: table.LC_pick_box td.LC_oddrow_value {
5612: text-align: left;
5613: padding: 8px;
5614: background-color: $data_table_light;
5615: }
1.795 www 5616:
1.579 raeburn 5617: span.LC_helpform_receipt_cat {
5618: font-weight: bold;
5619: }
1.795 www 5620:
1.424 albertel 5621: table.LC_group_priv_box {
5622: background: white;
5623: border: 1px solid black;
5624: border-spacing: 1px;
5625: }
1.795 www 5626:
1.424 albertel 5627: table.LC_group_priv_box td.LC_pick_box_title {
5628: background: $tabbg;
5629: font-weight: bold;
5630: text-align: right;
5631: width: 184px;
5632: }
1.795 www 5633:
1.424 albertel 5634: table.LC_group_priv_box td.LC_groups_fixed {
5635: background: $data_table_light;
5636: text-align: center;
5637: }
1.795 www 5638:
1.424 albertel 5639: table.LC_group_priv_box td.LC_groups_optional {
5640: background: $data_table_dark;
5641: text-align: center;
5642: }
1.795 www 5643:
1.424 albertel 5644: table.LC_group_priv_box td.LC_groups_functionality {
5645: background: $data_table_darker;
5646: text-align: center;
5647: font-weight: bold;
5648: }
1.795 www 5649:
1.424 albertel 5650: table.LC_group_priv td {
5651: text-align: left;
1.803 bisitz 5652: padding: 0;
1.424 albertel 5653: }
5654:
1.421 albertel 5655: table.LC_notify_front_page {
5656: background: white;
5657: border: 1px solid black;
5658: padding: 8px;
5659: }
1.795 www 5660:
1.421 albertel 5661: table.LC_notify_front_page td {
5662: padding: 8px;
5663: }
1.795 www 5664:
1.424 albertel 5665: .LC_navbuttons {
5666: margin: 2ex 0ex 2ex 0ex;
5667: }
1.795 www 5668:
1.423 albertel 5669: .LC_topic_bar {
5670: font-weight: bold;
5671: background: $tabbg;
1.918 wenzelju 5672: margin: 1em 0em 1em 2em;
1.805 bisitz 5673: padding: 3px;
1.918 wenzelju 5674: font-size: 1.2em;
1.423 albertel 5675: }
1.795 www 5676:
1.423 albertel 5677: .LC_topic_bar span {
1.918 wenzelju 5678: left: 0.5em;
5679: position: absolute;
1.423 albertel 5680: vertical-align: middle;
1.918 wenzelju 5681: font-size: 1.2em;
1.423 albertel 5682: }
1.795 www 5683:
1.423 albertel 5684: table.LC_course_group_status {
5685: margin: 20px;
5686: }
1.795 www 5687:
1.423 albertel 5688: table.LC_status_selector td {
5689: vertical-align: top;
5690: text-align: center;
1.424 albertel 5691: padding: 4px;
5692: }
1.795 www 5693:
1.599 albertel 5694: div.LC_feedback_link {
1.616 albertel 5695: clear: both;
1.829 kalberla 5696: background: $sidebg;
1.779 bisitz 5697: width: 100%;
1.829 kalberla 5698: padding-bottom: 10px;
5699: border: 1px $tabbg solid;
1.833 kalberla 5700: height: 22px;
5701: line-height: 22px;
5702: padding-top: 5px;
5703: }
5704:
5705: div.LC_feedback_link img {
5706: height: 22px;
1.867 kalberla 5707: vertical-align:middle;
1.829 kalberla 5708: }
5709:
1.911 bisitz 5710: div.LC_feedback_link a {
1.829 kalberla 5711: text-decoration: none;
1.489 raeburn 5712: }
1.795 www 5713:
1.867 kalberla 5714: div.LC_comblock {
1.911 bisitz 5715: display:inline;
1.867 kalberla 5716: color:$font;
5717: font-size:90%;
5718: }
5719:
5720: div.LC_feedback_link div.LC_comblock {
5721: padding-left:5px;
5722: }
5723:
5724: div.LC_feedback_link div.LC_comblock a {
5725: color:$font;
5726: }
5727:
1.489 raeburn 5728: span.LC_feedback_link {
1.858 bisitz 5729: /* background: $feedback_link_bg; */
1.599 albertel 5730: font-size: larger;
5731: }
1.795 www 5732:
1.599 albertel 5733: span.LC_message_link {
1.858 bisitz 5734: /* background: $feedback_link_bg; */
1.599 albertel 5735: font-size: larger;
5736: position: absolute;
5737: right: 1em;
1.489 raeburn 5738: }
1.421 albertel 5739:
1.515 albertel 5740: table.LC_prior_tries {
1.524 albertel 5741: border: 1px solid #000000;
5742: border-collapse: separate;
5743: border-spacing: 1px;
1.515 albertel 5744: }
1.523 albertel 5745:
1.515 albertel 5746: table.LC_prior_tries td {
1.524 albertel 5747: padding: 2px;
1.515 albertel 5748: }
1.523 albertel 5749:
5750: .LC_answer_correct {
1.795 www 5751: background: lightgreen;
5752: color: darkgreen;
5753: padding: 6px;
1.523 albertel 5754: }
1.795 www 5755:
1.523 albertel 5756: .LC_answer_charged_try {
1.797 www 5757: background: #FFAAAA;
1.795 www 5758: color: darkred;
5759: padding: 6px;
1.523 albertel 5760: }
1.795 www 5761:
1.779 bisitz 5762: .LC_answer_not_charged_try,
1.523 albertel 5763: .LC_answer_no_grade,
5764: .LC_answer_late {
1.795 www 5765: background: lightyellow;
1.523 albertel 5766: color: black;
1.795 www 5767: padding: 6px;
1.523 albertel 5768: }
1.795 www 5769:
1.523 albertel 5770: .LC_answer_previous {
1.795 www 5771: background: lightblue;
5772: color: darkblue;
5773: padding: 6px;
1.523 albertel 5774: }
1.795 www 5775:
1.779 bisitz 5776: .LC_answer_no_message {
1.777 tempelho 5777: background: #FFFFFF;
5778: color: black;
1.795 www 5779: padding: 6px;
1.779 bisitz 5780: }
1.795 www 5781:
1.779 bisitz 5782: .LC_answer_unknown {
5783: background: orange;
5784: color: black;
1.795 www 5785: padding: 6px;
1.777 tempelho 5786: }
1.795 www 5787:
1.529 albertel 5788: span.LC_prior_numerical,
5789: span.LC_prior_string,
5790: span.LC_prior_custom,
5791: span.LC_prior_reaction,
5792: span.LC_prior_math {
1.925 bisitz 5793: font-family: $mono;
1.523 albertel 5794: white-space: pre;
5795: }
5796:
1.525 albertel 5797: span.LC_prior_string {
1.925 bisitz 5798: font-family: $mono;
1.525 albertel 5799: white-space: pre;
5800: }
5801:
1.523 albertel 5802: table.LC_prior_option {
5803: width: 100%;
5804: border-collapse: collapse;
5805: }
1.795 www 5806:
1.911 bisitz 5807: table.LC_prior_rank,
1.795 www 5808: table.LC_prior_match {
1.528 albertel 5809: border-collapse: collapse;
5810: }
1.795 www 5811:
1.528 albertel 5812: table.LC_prior_option tr td,
5813: table.LC_prior_rank tr td,
5814: table.LC_prior_match tr td {
1.524 albertel 5815: border: 1px solid #000000;
1.515 albertel 5816: }
5817:
1.855 bisitz 5818: .LC_nobreak {
1.544 albertel 5819: white-space: nowrap;
1.519 raeburn 5820: }
5821:
1.576 raeburn 5822: span.LC_cusr_emph {
5823: font-style: italic;
5824: }
5825:
1.633 raeburn 5826: span.LC_cusr_subheading {
5827: font-weight: normal;
5828: font-size: 85%;
5829: }
5830:
1.861 bisitz 5831: div.LC_docs_entry_move {
1.859 bisitz 5832: border: 1px solid #BBBBBB;
1.545 albertel 5833: background: #DDDDDD;
1.861 bisitz 5834: width: 22px;
1.859 bisitz 5835: padding: 1px;
5836: margin: 0;
1.545 albertel 5837: }
5838:
1.861 bisitz 5839: table.LC_data_table tr > td.LC_docs_entry_commands,
5840: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 5841: background: #DDDDDD;
5842: font-size: x-small;
5843: }
1.795 www 5844:
1.861 bisitz 5845: .LC_docs_entry_parameter {
5846: white-space: nowrap;
5847: }
5848:
1.544 albertel 5849: .LC_docs_copy {
1.545 albertel 5850: color: #000099;
1.544 albertel 5851: }
1.795 www 5852:
1.544 albertel 5853: .LC_docs_cut {
1.545 albertel 5854: color: #550044;
1.544 albertel 5855: }
1.795 www 5856:
1.544 albertel 5857: .LC_docs_rename {
1.545 albertel 5858: color: #009900;
1.544 albertel 5859: }
1.795 www 5860:
1.544 albertel 5861: .LC_docs_remove {
1.545 albertel 5862: color: #990000;
5863: }
5864:
1.547 albertel 5865: .LC_docs_reinit_warn,
5866: .LC_docs_ext_edit {
5867: font-size: x-small;
5868: }
5869:
1.545 albertel 5870: table.LC_docs_adddocs td,
5871: table.LC_docs_adddocs th {
5872: border: 1px solid #BBBBBB;
5873: padding: 4px;
5874: background: #DDDDDD;
1.543 albertel 5875: }
5876:
1.584 albertel 5877: table.LC_sty_begin {
5878: background: #BBFFBB;
5879: }
1.795 www 5880:
1.584 albertel 5881: table.LC_sty_end {
5882: background: #FFBBBB;
5883: }
5884:
1.589 raeburn 5885: table.LC_double_column {
1.803 bisitz 5886: border-width: 0;
1.589 raeburn 5887: border-collapse: collapse;
5888: width: 100%;
5889: padding: 2px;
5890: }
5891:
5892: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5893: top: 2px;
1.589 raeburn 5894: left: 2px;
5895: width: 47%;
5896: vertical-align: top;
5897: }
5898:
5899: table.LC_double_column tr td.LC_right_col {
5900: top: 2px;
1.779 bisitz 5901: right: 2px;
1.589 raeburn 5902: width: 47%;
5903: vertical-align: top;
5904: }
5905:
1.591 raeburn 5906: div.LC_left_float {
5907: float: left;
5908: padding-right: 5%;
1.597 albertel 5909: padding-bottom: 4px;
1.591 raeburn 5910: }
5911:
5912: div.LC_clear_float_header {
1.597 albertel 5913: padding-bottom: 2px;
1.591 raeburn 5914: }
5915:
5916: div.LC_clear_float_footer {
1.597 albertel 5917: padding-top: 10px;
1.591 raeburn 5918: clear: both;
5919: }
5920:
1.597 albertel 5921: div.LC_grade_show_user {
1.941 bisitz 5922: /* border-left: 5px solid $sidebg; */
5923: border-top: 5px solid #000000;
5924: margin: 50px 0 0 0;
1.936 bisitz 5925: padding: 15px 0 5px 10px;
1.597 albertel 5926: }
1.795 www 5927:
1.936 bisitz 5928: div.LC_grade_show_user_odd_row {
1.941 bisitz 5929: /* border-left: 5px solid #000000; */
5930: }
5931:
5932: div.LC_grade_show_user div.LC_Box {
5933: margin-right: 50px;
1.597 albertel 5934: }
5935:
5936: div.LC_grade_submissions,
5937: div.LC_grade_message_center,
1.936 bisitz 5938: div.LC_grade_info_links {
1.597 albertel 5939: margin: 5px;
5940: width: 99%;
5941: background: #FFFFFF;
5942: }
1.795 www 5943:
1.597 albertel 5944: div.LC_grade_submissions_header,
1.936 bisitz 5945: div.LC_grade_message_center_header {
1.705 tempelho 5946: font-weight: bold;
5947: font-size: large;
1.597 albertel 5948: }
1.795 www 5949:
1.597 albertel 5950: div.LC_grade_submissions_body,
1.936 bisitz 5951: div.LC_grade_message_center_body {
1.597 albertel 5952: border: 1px solid black;
5953: width: 99%;
5954: background: #FFFFFF;
5955: }
1.795 www 5956:
1.613 albertel 5957: table.LC_scantron_action {
5958: width: 100%;
5959: }
1.795 www 5960:
1.613 albertel 5961: table.LC_scantron_action tr th {
1.698 harmsja 5962: font-weight:bold;
5963: font-style:normal;
1.613 albertel 5964: }
1.795 www 5965:
1.779 bisitz 5966: .LC_edit_problem_header,
1.614 albertel 5967: div.LC_edit_problem_footer {
1.705 tempelho 5968: font-weight: normal;
5969: font-size: medium;
1.602 albertel 5970: margin: 2px;
1.600 albertel 5971: }
1.795 www 5972:
1.600 albertel 5973: div.LC_edit_problem_header,
1.602 albertel 5974: div.LC_edit_problem_header div,
1.614 albertel 5975: div.LC_edit_problem_footer,
5976: div.LC_edit_problem_footer div,
1.602 albertel 5977: div.LC_edit_problem_editxml_header,
5978: div.LC_edit_problem_editxml_header div {
1.600 albertel 5979: margin-top: 5px;
5980: }
1.795 www 5981:
1.600 albertel 5982: div.LC_edit_problem_header_title {
1.705 tempelho 5983: font-weight: bold;
5984: font-size: larger;
1.602 albertel 5985: background: $tabbg;
5986: padding: 3px;
5987: }
1.795 www 5988:
1.602 albertel 5989: table.LC_edit_problem_header_title {
5990: width: 100%;
1.600 albertel 5991: background: $tabbg;
1.602 albertel 5992: }
5993:
5994: div.LC_edit_problem_discards {
5995: float: left;
5996: padding-bottom: 5px;
5997: }
1.795 www 5998:
1.602 albertel 5999: div.LC_edit_problem_saves {
6000: float: right;
6001: padding-bottom: 5px;
1.600 albertel 6002: }
1.795 www 6003:
1.911 bisitz 6004: img.stift {
1.803 bisitz 6005: border-width: 0;
6006: vertical-align: middle;
1.677 riegler 6007: }
1.680 riegler 6008:
1.923 bisitz 6009: table td.LC_mainmenu_col_fieldset {
1.680 riegler 6010: vertical-align: top;
1.777 tempelho 6011: }
1.795 www 6012:
1.716 raeburn 6013: div.LC_createcourse {
1.911 bisitz 6014: margin: 10px 10px 10px 10px;
1.716 raeburn 6015: }
6016:
1.917 raeburn 6017: .LC_dccid {
6018: margin: 0.2em 0 0 0;
6019: padding: 0;
6020: font-size: 90%;
6021: display:none;
6022: }
6023:
1.698 harmsja 6024: a:hover,
1.897 wenzelju 6025: ol.LC_primary_menu a:hover,
1.721 harmsja 6026: ol#LC_MenuBreadcrumbs a:hover,
6027: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 6028: ul#LC_secondary_menu a:hover,
1.721 harmsja 6029: .LC_FormSectionClearButton input:hover
1.795 www 6030: ul.LC_TabContent li:hover a {
1.948.2.1 raeburn 6031: color:$button_hover;
1.911 bisitz 6032: text-decoration:none;
1.693 droeschl 6033: }
6034:
1.779 bisitz 6035: h1 {
1.911 bisitz 6036: padding: 0;
6037: line-height:130%;
1.693 droeschl 6038: }
1.698 harmsja 6039:
1.911 bisitz 6040: h2,
6041: h3,
6042: h4,
6043: h5,
6044: h6 {
6045: margin: 5px 0 5px 0;
6046: padding: 0;
6047: line-height:130%;
1.693 droeschl 6048: }
1.795 www 6049:
6050: .LC_hcell {
1.911 bisitz 6051: padding:3px 15px 3px 15px;
6052: margin: 0;
6053: background-color:$tabbg;
6054: color:$fontmenu;
6055: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 6056: }
1.795 www 6057:
1.840 bisitz 6058: .LC_Box > .LC_hcell {
1.911 bisitz 6059: margin: 0 -10px 10px -10px;
1.835 bisitz 6060: }
6061:
1.721 harmsja 6062: .LC_noBorder {
1.911 bisitz 6063: border: 0;
1.698 harmsja 6064: }
1.693 droeschl 6065:
1.721 harmsja 6066: .LC_FormSectionClearButton input {
1.911 bisitz 6067: background-color:transparent;
6068: border: none;
6069: cursor:pointer;
6070: text-decoration:underline;
1.693 droeschl 6071: }
1.763 bisitz 6072:
6073: .LC_help_open_topic {
1.911 bisitz 6074: color: #FFFFFF;
6075: background-color: #EEEEFF;
6076: margin: 1px;
6077: padding: 4px;
6078: border: 1px solid #000033;
6079: white-space: nowrap;
6080: /* vertical-align: middle; */
1.759 neumanie 6081: }
1.693 droeschl 6082:
1.911 bisitz 6083: dl,
6084: ul,
6085: div,
6086: fieldset {
6087: margin: 10px 10px 10px 0;
6088: /* overflow: hidden; */
1.693 droeschl 6089: }
1.795 www 6090:
1.838 bisitz 6091: fieldset > legend {
1.911 bisitz 6092: font-weight: bold;
6093: padding: 0 5px 0 5px;
1.838 bisitz 6094: }
6095:
1.813 bisitz 6096: #LC_nav_bar {
1.911 bisitz 6097: float: left;
1.934 droeschl 6098: margin: 0;
1.807 droeschl 6099: }
6100:
1.916 droeschl 6101: #LC_realm {
6102: margin: 0.2em 0 0 0;
6103: padding: 0;
6104: font-weight: bold;
6105: text-align: center;
6106: }
6107:
1.911 bisitz 6108: #LC_nav_bar em {
6109: font-weight: bold;
6110: font-style: normal;
1.807 droeschl 6111: }
6112:
1.897 wenzelju 6113: ol.LC_primary_menu {
1.911 bisitz 6114: float: right;
1.934 droeschl 6115: margin: 0;
1.807 droeschl 6116: }
6117:
1.929 wenzelju 6118: span.LC_new_message{
6119: font-weight:bold;
6120: color: darkred;
6121: }
6122:
1.852 droeschl 6123: ol#LC_PathBreadcrumbs {
1.911 bisitz 6124: margin: 0;
1.693 droeschl 6125: }
6126:
1.897 wenzelju 6127: ol.LC_primary_menu li {
1.911 bisitz 6128: display: inline;
6129: padding: 5px 5px 0 10px;
6130: vertical-align: top;
1.693 droeschl 6131: }
6132:
1.897 wenzelju 6133: ol.LC_primary_menu li img {
1.911 bisitz 6134: vertical-align: bottom;
1.934 droeschl 6135: height: 1.1em;
1.693 droeschl 6136: }
6137:
1.897 wenzelju 6138: ol.LC_primary_menu a {
1.911 bisitz 6139: color: RGB(80, 80, 80);
6140: text-decoration: none;
1.693 droeschl 6141: }
1.795 www 6142:
1.897 wenzelju 6143: ul#LC_secondary_menu {
1.911 bisitz 6144: clear: both;
6145: color: $fontmenu;
6146: background: $tabbg;
6147: list-style: none;
6148: padding: 0;
6149: margin: 0;
6150: width: 100%;
1.808 droeschl 6151: }
6152:
1.897 wenzelju 6153: ul#LC_secondary_menu li {
1.911 bisitz 6154: font-weight: bold;
6155: line-height: 1.8em;
6156: padding: 0 0.8em;
6157: border-right: 1px solid black;
6158: display: inline;
6159: vertical-align: middle;
1.807 droeschl 6160: }
6161:
1.847 tempelho 6162: ul.LC_TabContent {
1.911 bisitz 6163: display:block;
6164: background: $sidebg;
6165: border-bottom: solid 1px $lg_border_color;
6166: list-style:none;
6167: margin: 0 -10px;
6168: padding: 0;
1.693 droeschl 6169: }
6170:
1.795 www 6171: ul.LC_TabContent li,
6172: ul.LC_TabContentBigger li {
1.911 bisitz 6173: float:left;
1.741 harmsja 6174: }
1.795 www 6175:
1.897 wenzelju 6176: ul#LC_secondary_menu li a {
1.911 bisitz 6177: color: $fontmenu;
6178: text-decoration: none;
1.693 droeschl 6179: }
1.795 www 6180:
1.721 harmsja 6181: ul.LC_TabContent {
1.948.2.1 raeburn 6182: min-height:20px;
1.721 harmsja 6183: }
1.795 www 6184:
6185: ul.LC_TabContent li {
1.911 bisitz 6186: vertical-align:middle;
6187: padding: 0 10px 0 10px;
6188: background-color:$tabbg;
6189: border-bottom:solid 1px $lg_border_color;
1.948.2.1 raeburn 6190: border-right: solid 1px $font;
1.721 harmsja 6191: }
1.795 www 6192:
1.847 tempelho 6193: ul.LC_TabContent .right {
1.911 bisitz 6194: float:right;
1.847 tempelho 6195: }
6196:
1.911 bisitz 6197: ul.LC_TabContent li a,
6198: ul.LC_TabContent li {
6199: color:rgb(47,47,47);
6200: text-decoration:none;
6201: font-size:95%;
6202: font-weight:bold;
6203: padding-right: 16px;
1.948.2.1 raeburn 6204: min-height:20px;
6205: }
6206:
6207: ul.LC_TabContent li a:hover {
6208: color: $button_hover;
6209: }
6210:
6211: ul.LC_TabContent li:hover {
6212: color: $button_hover;
6213: cursor:pointer;
1.721 harmsja 6214: }
1.795 www 6215:
1.911 bisitz 6216: ul.LC_TabContent li.active {
1.948.2.1 raeburn 6217: color: $font;
1.911 bisitz 6218: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.948.2.1 raeburn 6219: border-bottom:solid 1px #FFFFFF;
6220: cursor: default;
1.744 ehlerst 6221: }
1.795 www 6222:
1.870 tempelho 6223: #maincoursedoc {
1.911 bisitz 6224: clear:both;
1.870 tempelho 6225: }
6226:
6227: ul.LC_TabContentBigger {
1.911 bisitz 6228: display:block;
6229: list-style:none;
6230: padding: 0;
1.870 tempelho 6231: }
6232:
1.795 www 6233: ul.LC_TabContentBigger li {
1.911 bisitz 6234: vertical-align:bottom;
6235: height: 30px;
6236: font-size:110%;
6237: font-weight:bold;
6238: color: #737373;
1.841 tempelho 6239: }
6240:
1.870 tempelho 6241:
6242: ul.LC_TabContentBigger li a {
1.911 bisitz 6243: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6244: height: 30px;
6245: line-height: 30px;
6246: text-align: center;
6247: display: block;
6248: text-decoration: none;
1.741 harmsja 6249: }
1.795 www 6250:
1.911 bisitz 6251: ul.LC_TabContentBigger li:hover a,
1.870 tempelho 6252: ul.LC_TabContentBigger li.active a {
1.911 bisitz 6253: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6254: color:$font;
6255: text-decoration: underline;
1.744 ehlerst 6256: }
1.795 www 6257:
1.870 tempelho 6258:
6259: ul.LC_TabContentBigger li b {
1.911 bisitz 6260: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
6261: display: block;
6262: float: left;
6263: padding: 0 30px;
1.870 tempelho 6264: }
6265:
6266: ul.LC_TabContentBigger li:hover b,
6267: ul.LC_TabContentBigger li.active b {
1.911 bisitz 6268: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
6269: color:$font;
6270: border-bottom: 1px solid #FFFFFF;
1.741 harmsja 6271: }
1.693 droeschl 6272:
1.870 tempelho 6273:
1.862 bisitz 6274: ul.LC_CourseBreadcrumbs {
6275: background: $sidebg;
6276: line-height: 32px;
6277: padding-left: 10px;
6278: margin: 0 0 10px 0;
6279: list-style-position: inside;
6280:
6281: }
6282:
1.911 bisitz 6283: ol#LC_MenuBreadcrumbs,
1.862 bisitz 6284: ol#LC_PathBreadcrumbs {
1.911 bisitz 6285: padding-left: 10px;
6286: margin: 0;
1.933 droeschl 6287: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 6288: }
6289:
1.911 bisitz 6290: ol#LC_MenuBreadcrumbs li,
6291: ol#LC_PathBreadcrumbs li,
1.862 bisitz 6292: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 6293: display: inline;
1.933 droeschl 6294: white-space: normal;
1.693 droeschl 6295: }
6296:
1.823 bisitz 6297: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 6298: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 6299: text-decoration: none;
6300: font-size:90%;
1.693 droeschl 6301: }
1.795 www 6302:
6303: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 6304: text-decoration:none;
6305: font-size:100%;
6306: font-weight:bold;
1.693 droeschl 6307: }
1.795 www 6308:
1.840 bisitz 6309: .LC_Box {
1.911 bisitz 6310: border: solid 1px $lg_border_color;
6311: padding: 0 10px 10px 10px;
1.746 neumanie 6312: }
1.795 www 6313:
6314: .LC_AboutMe_Image {
1.911 bisitz 6315: float:left;
6316: margin-right:10px;
1.747 neumanie 6317: }
1.795 www 6318:
6319: .LC_Clear_AboutMe_Image {
1.911 bisitz 6320: clear:left;
1.747 neumanie 6321: }
1.795 www 6322:
1.721 harmsja 6323: dl.LC_ListStyleClean dt {
1.911 bisitz 6324: padding-right: 5px;
6325: display: table-header-group;
1.693 droeschl 6326: }
6327:
1.721 harmsja 6328: dl.LC_ListStyleClean dd {
1.911 bisitz 6329: display: table-row;
1.693 droeschl 6330: }
6331:
1.721 harmsja 6332: .LC_ListStyleClean,
6333: .LC_ListStyleSimple,
6334: .LC_ListStyleNormal,
1.795 www 6335: .LC_ListStyleSpecial {
1.911 bisitz 6336: /* display:block; */
6337: list-style-position: inside;
6338: list-style-type: none;
6339: overflow: hidden;
6340: padding: 0;
1.693 droeschl 6341: }
6342:
1.721 harmsja 6343: .LC_ListStyleSimple li,
6344: .LC_ListStyleSimple dd,
6345: .LC_ListStyleNormal li,
6346: .LC_ListStyleNormal dd,
6347: .LC_ListStyleSpecial li,
1.795 www 6348: .LC_ListStyleSpecial dd {
1.911 bisitz 6349: margin: 0;
6350: padding: 5px 5px 5px 10px;
6351: clear: both;
1.693 droeschl 6352: }
6353:
1.721 harmsja 6354: .LC_ListStyleClean li,
6355: .LC_ListStyleClean dd {
1.911 bisitz 6356: padding-top: 0;
6357: padding-bottom: 0;
1.693 droeschl 6358: }
6359:
1.721 harmsja 6360: .LC_ListStyleSimple dd,
1.795 www 6361: .LC_ListStyleSimple li {
1.911 bisitz 6362: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6363: }
6364:
1.721 harmsja 6365: .LC_ListStyleSpecial li,
6366: .LC_ListStyleSpecial dd {
1.911 bisitz 6367: list-style-type: none;
6368: background-color: RGB(220, 220, 220);
6369: margin-bottom: 4px;
1.693 droeschl 6370: }
6371:
1.721 harmsja 6372: table.LC_SimpleTable {
1.911 bisitz 6373: margin:5px;
6374: border:solid 1px $lg_border_color;
1.795 www 6375: }
1.693 droeschl 6376:
1.721 harmsja 6377: table.LC_SimpleTable tr {
1.911 bisitz 6378: padding: 0;
6379: border:solid 1px $lg_border_color;
1.693 droeschl 6380: }
1.795 www 6381:
6382: table.LC_SimpleTable thead {
1.911 bisitz 6383: background:rgb(220,220,220);
1.693 droeschl 6384: }
6385:
1.721 harmsja 6386: div.LC_columnSection {
1.911 bisitz 6387: display: block;
6388: clear: both;
6389: overflow: hidden;
6390: margin: 0;
1.693 droeschl 6391: }
6392:
1.721 harmsja 6393: div.LC_columnSection>* {
1.911 bisitz 6394: float: left;
6395: margin: 10px 20px 10px 0;
6396: overflow:hidden;
1.693 droeschl 6397: }
1.721 harmsja 6398:
1.694 tempelho 6399: .LC_loginpage_container {
1.911 bisitz 6400: text-align:left;
6401: margin : 0 auto;
6402: width:90%;
6403: padding: 10px;
6404: height: auto;
6405: background-color:#FFFFFF;
6406: border:1px solid #CCCCCC;
1.694 tempelho 6407: }
6408:
6409:
6410: .LC_loginpage_loginContainer {
1.911 bisitz 6411: float:left;
6412: width: 182px;
6413: padding: 2px;
6414: border:1px solid #CCCCCC;
6415: background-color:$loginbg;
1.694 tempelho 6416: }
6417:
1.795 www 6418: .LC_loginpage_loginContainer h2 {
1.911 bisitz 6419: margin-top: 0;
6420: display:block;
6421: background:$bgcol;
6422: color:$textcol;
6423: padding-left:5px;
1.712 muellerd 6424: }
1.785 tempelho 6425:
1.694 tempelho 6426: .LC_loginpage_loginInfo {
1.911 bisitz 6427: float:left;
6428: width:182px;
6429: border:1px solid #CCCCCC;
6430: padding:2px;
1.712 muellerd 6431: }
6432:
1.694 tempelho 6433: .LC_loginpage_space {
1.911 bisitz 6434: clear: both;
6435: margin-bottom: 20px;
6436: border-bottom: 1px solid #CCCCCC;
1.694 tempelho 6437: }
6438:
1.785 tempelho 6439: .LC_loginpage_floatLeft {
1.911 bisitz 6440: float: left;
6441: width: 200px;
6442: margin: 0;
1.785 tempelho 6443: }
6444:
1.795 www 6445: table em {
1.911 bisitz 6446: font-weight: bold;
6447: font-style: normal;
1.748 schulted 6448: }
1.795 www 6449:
1.779 bisitz 6450: table.LC_tableBrowseRes,
1.795 www 6451: table.LC_tableOfContent {
1.911 bisitz 6452: border:none;
6453: border-spacing: 1px;
6454: padding: 3px;
6455: background-color: #FFFFFF;
6456: font-size: 90%;
1.753 droeschl 6457: }
1.789 droeschl 6458:
1.911 bisitz 6459: table.LC_tableOfContent {
6460: border-collapse: collapse;
1.789 droeschl 6461: }
6462:
1.771 droeschl 6463: table.LC_tableBrowseRes a,
1.768 schulted 6464: table.LC_tableOfContent a {
1.911 bisitz 6465: background-color: transparent;
6466: text-decoration: none;
1.753 droeschl 6467: }
6468:
1.795 www 6469: table.LC_tableOfContent img {
1.911 bisitz 6470: border: none;
6471: height: 1.3em;
6472: vertical-align: text-bottom;
6473: margin-right: 0.3em;
1.753 droeschl 6474: }
1.757 schulted 6475:
1.795 www 6476: a#LC_content_toolbar_firsthomework {
1.911 bisitz 6477: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 6478: }
6479:
1.795 www 6480: a#LC_content_toolbar_launchnav {
1.911 bisitz 6481: background-image:url(/res/adm/pages/start-navigation.gif);
1.774 ehlerst 6482: }
6483:
1.795 www 6484: a#LC_content_toolbar_closenav {
1.911 bisitz 6485: background-image:url(/res/adm/pages/close-navigation.gif);
1.774 ehlerst 6486: }
6487:
1.795 www 6488: a#LC_content_toolbar_everything {
1.911 bisitz 6489: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 6490: }
6491:
1.795 www 6492: a#LC_content_toolbar_uncompleted {
1.911 bisitz 6493: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 6494: }
6495:
1.795 www 6496: #LC_content_toolbar_clearbubbles {
1.911 bisitz 6497: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 6498: }
6499:
1.795 www 6500: a#LC_content_toolbar_changefolder {
1.911 bisitz 6501: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 6502: }
6503:
1.795 www 6504: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 6505: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 6506: }
6507:
1.795 www 6508: ul#LC_toolbar li a:hover {
1.911 bisitz 6509: background-position: bottom center;
1.757 schulted 6510: }
6511:
1.795 www 6512: ul#LC_toolbar {
1.911 bisitz 6513: padding: 0;
6514: margin: 2px;
6515: list-style:none;
6516: position:relative;
6517: background-color:white;
1.757 schulted 6518: }
6519:
1.795 www 6520: ul#LC_toolbar li {
1.911 bisitz 6521: border:1px solid white;
6522: padding: 0;
6523: margin: 0;
6524: float: left;
6525: display:inline;
6526: vertical-align:middle;
6527: }
1.757 schulted 6528:
1.783 amueller 6529:
1.795 www 6530: a.LC_toolbarItem {
1.911 bisitz 6531: display:block;
6532: padding: 0;
6533: margin: 0;
6534: height: 32px;
6535: width: 32px;
6536: color:white;
6537: border: none;
6538: background-repeat:no-repeat;
6539: background-color:transparent;
1.757 schulted 6540: }
6541:
1.915 droeschl 6542: ul.LC_funclist {
6543: margin: 0;
6544: padding: 0.5em 1em 0.5em 0;
6545: }
6546:
1.933 droeschl 6547: ul.LC_funclist > li:first-child {
6548: font-weight:bold;
6549: margin-left:0.8em;
6550: }
6551:
1.915 droeschl 6552: ul.LC_funclist + ul.LC_funclist {
6553: /*
6554: left border as a seperator if we have more than
6555: one list
6556: */
6557: border-left: 1px solid $sidebg;
6558: /*
6559: this hides the left border behind the border of the
6560: outer box if element is wrapped to the next 'line'
6561: */
6562: margin-left: -1px;
6563: }
6564:
1.843 bisitz 6565: ul.LC_funclist li {
1.915 droeschl 6566: display: inline;
1.782 bisitz 6567: white-space: nowrap;
1.915 droeschl 6568: margin: 0 0 0 25px;
6569: line-height: 150%;
1.782 bisitz 6570: }
6571:
1.930 faziophi 6572: .ui-accordion .LC_advanced_toggle {
6573: float: right;
6574: font-size: 90%;
6575: padding: 0px 4px
6576: }
1.757 schulted 6577:
1.343 albertel 6578: END
6579: }
6580:
1.306 albertel 6581: =pod
6582:
6583: =item * &headtag()
6584:
6585: Returns a uniform footer for LON-CAPA web pages.
6586:
1.307 albertel 6587: Inputs: $title - optional title for the head
6588: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 6589: $args - optional arguments
1.319 albertel 6590: force_register - if is true call registerurl so the remote is
6591: informed
1.415 albertel 6592: redirect -> array ref of
6593: 1- seconds before redirect occurs
6594: 2- url to redirect to
6595: 3- whether the side effect should occur
1.315 albertel 6596: (side effect of setting
6597: $env{'internal.head.redirect'} to the url
6598: redirected too)
1.352 albertel 6599: domain -> force to color decorate a page for a specific
6600: domain
6601: function -> force usage of a specific rolish color scheme
6602: bgcolor -> override the default page bgcolor
1.460 albertel 6603: no_auto_mt_title
6604: -> prevent &mt()ing the title arg
1.464 albertel 6605:
1.306 albertel 6606: =cut
6607:
6608: sub headtag {
1.313 albertel 6609: my ($title,$head_extra,$args) = @_;
1.306 albertel 6610:
1.363 albertel 6611: my $function = $args->{'function'} || &get_users_function();
6612: my $domain = $args->{'domain'} || &determinedomain();
6613: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 6614: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 6615: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 6616: #time(),
1.418 albertel 6617: $env{'environment.color.timestamp'},
1.363 albertel 6618: $function,$domain,$bgcolor);
6619:
1.369 www 6620: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 6621:
1.308 albertel 6622: my $result =
6623: '<head>'.
1.461 albertel 6624: &font_settings();
1.319 albertel 6625:
1.461 albertel 6626: if (!$args->{'frameset'}) {
6627: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
6628: }
1.319 albertel 6629: if ($args->{'force_register'}) {
6630: $result .= &Apache::lonmenu::registerurl(1);
6631: }
1.436 albertel 6632: if (!$args->{'no_nav_bar'}
6633: && !$args->{'only_body'}
6634: && !$args->{'frameset'}) {
6635: $result .= &help_menu_js();
6636: }
1.319 albertel 6637:
1.314 albertel 6638: if (ref($args->{'redirect'})) {
1.414 albertel 6639: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 6640: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 6641: if (!$inhibit_continue) {
6642: $env{'internal.head.redirect'} = $url;
6643: }
1.313 albertel 6644: $result.=<<ADDMETA
6645: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 6646: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 6647: ADDMETA
6648: }
1.306 albertel 6649: if (!defined($title)) {
6650: $title = 'The LearningOnline Network with CAPA';
6651: }
1.460 albertel 6652: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
6653: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 6654: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
6655: .$head_extra;
1.306 albertel 6656: return $result;
6657: }
6658:
6659: =pod
6660:
1.340 albertel 6661: =item * &font_settings()
6662:
6663: Returns neccessary <meta> to set the proper encoding
6664:
6665: Inputs: none
6666:
6667: =cut
6668:
6669: sub font_settings {
6670: my $headerstring='';
1.647 www 6671: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 6672: $headerstring.=
6673: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
6674: }
6675: return $headerstring;
6676: }
6677:
1.341 albertel 6678: =pod
6679:
6680: =item * &xml_begin()
6681:
6682: Returns the needed doctype and <html>
6683:
6684: Inputs: none
6685:
6686: =cut
6687:
6688: sub xml_begin {
6689: my $output='';
6690:
1.592 albertel 6691: if ($env{'internal.start_page'}==1) {
6692: &Apache::lonhtmlcommon::init_htmlareafields();
6693: }
1.342 albertel 6694:
1.341 albertel 6695: if ($env{'browser.mathml'}) {
6696: $output='<?xml version="1.0"?>'
6697: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
6698: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
6699:
6700: # .'<!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">] >'
6701: .'<!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">'
6702: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
6703: .'xmlns="http://www.w3.org/1999/xhtml">';
6704: } else {
1.849 bisitz 6705: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
6706: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341 albertel 6707: }
6708: return $output;
6709: }
1.340 albertel 6710:
6711: =pod
6712:
1.306 albertel 6713: =item * &endheadtag()
6714:
6715: Returns a uniform </head> for LON-CAPA web pages.
6716:
6717: Inputs: none
6718:
6719: =cut
6720:
6721: sub endheadtag {
6722: return '</head>';
6723: }
6724:
6725: =pod
6726:
6727: =item * &head()
6728:
6729: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
6730:
1.648 raeburn 6731: Inputs:
6732:
6733: =over 4
6734:
6735: $title - optional title for the page
6736:
6737: $head_extra - optional extra HTML to put inside the <head>
6738:
6739: =back
1.405 albertel 6740:
1.306 albertel 6741: =cut
6742:
6743: sub head {
1.325 albertel 6744: my ($title,$head_extra,$args) = @_;
6745: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 6746: }
6747:
6748: =pod
6749:
6750: =item * &start_page()
6751:
6752: Returns a complete <html> .. <body> section for LON-CAPA web pages.
6753:
1.648 raeburn 6754: Inputs:
6755:
6756: =over 4
6757:
6758: $title - optional title for the page
6759:
6760: $head_extra - optional extra HTML to incude inside the <head>
6761:
6762: $args - additional optional args supported are:
6763:
6764: =over 8
6765:
6766: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 6767: arg on
1.814 bisitz 6768: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 6769: add_entries -> additional attributes to add to the <body>
6770: domain -> force to color decorate a page for a
1.317 albertel 6771: specific domain
1.648 raeburn 6772: function -> force usage of a specific rolish color
1.317 albertel 6773: scheme
1.648 raeburn 6774: redirect -> see &headtag()
6775: bgcolor -> override the default page bg color
6776: js_ready -> return a string ready for being used in
1.317 albertel 6777: a javascript writeln
1.648 raeburn 6778: html_encode -> return a string ready for being used in
1.320 albertel 6779: a html attribute
1.648 raeburn 6780: force_register -> if is true will turn on the &bodytag()
1.317 albertel 6781: $forcereg arg
1.648 raeburn 6782: frameset -> if true will start with a <frameset>
1.330 albertel 6783: rather than <body>
1.648 raeburn 6784: skip_phases -> hash ref of
1.338 albertel 6785: head -> skip the <html><head> generation
6786: body -> skip all <body> generation
1.648 raeburn 6787: no_inline_link -> if true and in remote mode, don't show the
1.361 albertel 6788: 'Switch To Inline Menu' link
1.648 raeburn 6789: no_auto_mt_title -> prevent &mt()ing the title arg
6790: inherit_jsmath -> when creating popup window in a page,
6791: should it have jsmath forced on by the
6792: current page
1.867 kalberla 6793: bread_crumbs -> Array containing breadcrumbs
6794: bread_crumbs_components -> if exists show it as headline else show only the breadcrumbs
1.361 albertel 6795:
1.648 raeburn 6796: =back
1.460 albertel 6797:
1.648 raeburn 6798: =back
1.562 albertel 6799:
1.306 albertel 6800: =cut
6801:
6802: sub start_page {
1.309 albertel 6803: my ($title,$head_extra,$args) = @_;
1.318 albertel 6804: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 6805: my %head_args;
1.352 albertel 6806: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6807: 'bgcolor','frameset','no_nav_bar','only_body',
6808: 'no_auto_mt_title') {
1.319 albertel 6809: if (defined($args->{$arg})) {
1.324 raeburn 6810: $head_args{$arg} = $args->{$arg};
1.319 albertel 6811: }
1.313 albertel 6812: }
1.319 albertel 6813:
1.315 albertel 6814: $env{'internal.start_page'}++;
1.338 albertel 6815: my $result;
6816: if (! exists($args->{'skip_phases'}{'head'}) ) {
6817: $result.=
1.341 albertel 6818: &xml_begin().
1.338 albertel 6819: &headtag($title,$head_extra,\%head_args).&endheadtag();
6820: }
6821:
6822: if (! exists($args->{'skip_phases'}{'body'}) ) {
6823: if ($args->{'frameset'}) {
6824: my $attr_string = &make_attr_string($args->{'force_register'},
6825: $args->{'add_entries'});
6826: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 6827: } else {
6828: $result .=
6829: &bodytag($title,
6830: $args->{'function'}, $args->{'add_entries'},
6831: $args->{'only_body'}, $args->{'domain'},
6832: $args->{'force_register'}, $args->{'no_nav_bar'},
6833: $args->{'bgcolor'}, $args->{'no_inline_link'},
6834: $args);
6835: }
1.330 albertel 6836: }
1.338 albertel 6837:
1.315 albertel 6838: if ($args->{'js_ready'}) {
1.713 kaisler 6839: $result = &js_ready($result);
1.315 albertel 6840: }
1.320 albertel 6841: if ($args->{'html_encode'}) {
1.713 kaisler 6842: $result = &html_encode($result);
6843: }
6844:
1.813 bisitz 6845: # Preparation for new and consistent functionlist at top of screen
6846: # if ($args->{'functionlist'}) {
6847: # $result .= &build_functionlist();
6848: #}
6849:
6850: # Don't add anything more if only_body wanted
6851: return $result if $args->{'only_body'};
6852:
1.920 raeburn 6853: #Breadcrumbs for Construction Space provided by &bodytag.
6854: if (($env{'environment.remote'} eq 'off') && ($env{'request.state'} eq 'construct')) {
6855: return $result;
6856: }
6857:
1.813 bisitz 6858: #Breadcrumbs
1.758 kaisler 6859: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
6860: &Apache::lonhtmlcommon::clear_breadcrumbs();
6861: #if any br links exists, add them to the breadcrumbs
6862: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6863: foreach my $crumb (@{$args->{'bread_crumbs'}}){
6864: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
6865: }
6866: }
6867:
6868: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
6869: if(exists($args->{'bread_crumbs_component'})){
6870: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
6871: }else{
6872: $result .= &Apache::lonhtmlcommon::breadcrumbs();
6873: }
1.320 albertel 6874: }
1.315 albertel 6875: return $result;
1.306 albertel 6876: }
6877:
1.330 albertel 6878:
1.306 albertel 6879: =pod
6880:
6881: =item * &head()
6882:
6883: Returns a complete </body></html> section for LON-CAPA web pages.
6884:
1.315 albertel 6885: Inputs: $args - additional optional args supported are:
6886: js_ready -> return a string ready for being used in
6887: a javascript writeln
1.320 albertel 6888: html_encode -> return a string ready for being used in
6889: a html attribute
1.330 albertel 6890: frameset -> if true will start with a <frameset>
6891: rather than <body>
1.493 albertel 6892: dicsussion -> if true will get discussion from
6893: lonxml::xmlend
6894: (you can pass the target and parser arguments
6895: through optional 'target' and 'parser' args
6896: to this routine)
1.306 albertel 6897:
6898: =cut
6899:
6900: sub end_page {
1.315 albertel 6901: my ($args) = @_;
6902: $env{'internal.end_page'}++;
1.330 albertel 6903: my $result;
1.335 albertel 6904: if ($args->{'discussion'}) {
6905: my ($target,$parser);
6906: if (ref($args->{'discussion'})) {
6907: ($target,$parser) =($args->{'discussion'}{'target'},
6908: $args->{'discussion'}{'parser'});
6909: }
6910: $result .= &Apache::lonxml::xmlend($target,$parser);
6911: }
6912:
1.330 albertel 6913: if ($args->{'frameset'}) {
6914: $result .= '</frameset>';
6915: } else {
1.635 raeburn 6916: $result .= &endbodytag($args);
1.330 albertel 6917: }
6918: $result .= "\n</html>";
6919:
1.315 albertel 6920: if ($args->{'js_ready'}) {
1.317 albertel 6921: $result = &js_ready($result);
1.315 albertel 6922: }
1.335 albertel 6923:
1.320 albertel 6924: if ($args->{'html_encode'}) {
6925: $result = &html_encode($result);
6926: }
1.335 albertel 6927:
1.315 albertel 6928: return $result;
6929: }
6930:
1.320 albertel 6931: sub html_encode {
6932: my ($result) = @_;
6933:
1.322 albertel 6934: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6935:
6936: return $result;
6937: }
1.317 albertel 6938: sub js_ready {
6939: my ($result) = @_;
6940:
1.323 albertel 6941: $result =~ s/[\n\r]/ /xmsg;
6942: $result =~ s/\\/\\\\/xmsg;
6943: $result =~ s/'/\\'/xmsg;
1.372 albertel 6944: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6945:
6946: return $result;
6947: }
6948:
1.315 albertel 6949: sub validate_page {
6950: if ( exists($env{'internal.start_page'})
1.316 albertel 6951: && $env{'internal.start_page'} > 1) {
6952: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6953: $env{'internal.start_page'}.' '.
1.316 albertel 6954: $ENV{'request.filename'});
1.315 albertel 6955: }
6956: if ( exists($env{'internal.end_page'})
1.316 albertel 6957: && $env{'internal.end_page'} > 1) {
6958: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6959: $env{'internal.end_page'}.' '.
1.316 albertel 6960: $env{'request.filename'});
1.315 albertel 6961: }
6962: if ( exists($env{'internal.start_page'})
6963: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6964: &Apache::lonnet::logthis('start_page called without end_page '.
6965: $env{'request.filename'});
1.315 albertel 6966: }
6967: if ( ! exists($env{'internal.start_page'})
6968: && exists($env{'internal.end_page'})) {
1.316 albertel 6969: &Apache::lonnet::logthis('end_page called without start_page'.
6970: $env{'request.filename'});
1.315 albertel 6971: }
1.306 albertel 6972: }
1.315 albertel 6973:
1.318 albertel 6974: sub simple_error_page {
6975: my ($r,$title,$msg) = @_;
6976: my $page =
6977: &Apache::loncommon::start_page($title).
6978: &mt($msg).
6979: &Apache::loncommon::end_page();
6980: if (ref($r)) {
6981: $r->print($page);
1.327 albertel 6982: return;
1.318 albertel 6983: }
6984: return $page;
6985: }
1.347 albertel 6986:
6987: {
1.610 albertel 6988: my @row_count;
1.347 albertel 6989: sub start_data_table {
1.422 albertel 6990: my ($add_class) = @_;
6991: my $css_class = (join(' ','LC_data_table',$add_class));
1.610 albertel 6992: unshift(@row_count,0);
1.422 albertel 6993: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 6994: }
6995:
6996: sub end_data_table {
1.610 albertel 6997: shift(@row_count);
1.389 albertel 6998: return '</table>'."\n";;
1.347 albertel 6999: }
7000:
7001: sub start_data_table_row {
1.422 albertel 7002: my ($add_class) = @_;
1.610 albertel 7003: $row_count[0]++;
7004: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 7005: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.422 albertel 7006: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 7007: }
1.471 banghart 7008:
7009: sub continue_data_table_row {
7010: my ($add_class) = @_;
1.610 albertel 7011: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 7012: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');;
1.471 banghart 7013: return '<tr class="'.$css_class.'">'."\n";;
7014: }
1.347 albertel 7015:
7016: sub end_data_table_row {
1.389 albertel 7017: return '</tr>'."\n";;
1.347 albertel 7018: }
1.367 www 7019:
1.421 albertel 7020: sub start_data_table_empty_row {
1.707 bisitz 7021: # $row_count[0]++;
1.421 albertel 7022: return '<tr class="LC_empty_row" >'."\n";;
7023: }
7024:
7025: sub end_data_table_empty_row {
7026: return '</tr>'."\n";;
7027: }
7028:
1.367 www 7029: sub start_data_table_header_row {
1.389 albertel 7030: return '<tr class="LC_header_row">'."\n";;
1.367 www 7031: }
7032:
7033: sub end_data_table_header_row {
1.389 albertel 7034: return '</tr>'."\n";;
1.367 www 7035: }
1.890 droeschl 7036:
7037: sub data_table_caption {
7038: my $caption = shift;
7039: return "<caption class=\"LC_caption\">$caption</caption>";
7040: }
1.347 albertel 7041: }
7042:
1.548 albertel 7043: =pod
7044:
7045: =item * &inhibit_menu_check($arg)
7046:
7047: Checks for a inhibitmenu state and generates output to preserve it
7048:
7049: Inputs: $arg - can be any of
7050: - undef - in which case the return value is a string
7051: to add into arguments list of a uri
7052: - 'input' - in which case the return value is a HTML
7053: <form> <input> field of type hidden to
7054: preserve the value
7055: - a url - in which case the return value is the url with
7056: the neccesary cgi args added to preserve the
7057: inhibitmenu state
7058: - a ref to a url - no return value, but the string is
7059: updated to include the neccessary cgi
7060: args to preserve the inhibitmenu state
7061:
7062: =cut
7063:
7064: sub inhibit_menu_check {
7065: my ($arg) = @_;
7066: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
7067: if ($arg eq 'input') {
7068: if ($env{'form.inhibitmenu'}) {
7069: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
7070: } else {
7071: return
7072: }
7073: }
7074: if ($env{'form.inhibitmenu'}) {
7075: if (ref($arg)) {
7076: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7077: } elsif ($arg eq '') {
7078: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
7079: } else {
7080: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7081: }
7082: }
7083: if (!ref($arg)) {
7084: return $arg;
7085: }
7086: }
7087:
1.251 albertel 7088: ###############################################
1.182 matthew 7089:
7090: =pod
7091:
1.549 albertel 7092: =back
7093:
7094: =head1 User Information Routines
7095:
7096: =over 4
7097:
1.405 albertel 7098: =item * &get_users_function()
1.182 matthew 7099:
7100: Used by &bodytag to determine the current users primary role.
7101: Returns either 'student','coordinator','admin', or 'author'.
7102:
7103: =cut
7104:
7105: ###############################################
7106: sub get_users_function {
1.815 tempelho 7107: my $function = 'norole';
1.818 tempelho 7108: if ($env{'request.role'}=~/^(st)/) {
7109: $function='student';
7110: }
1.907 raeburn 7111: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 7112: $function='coordinator';
7113: }
1.258 albertel 7114: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 7115: $function='admin';
7116: }
1.826 bisitz 7117: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182 matthew 7118: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
7119: $function='author';
7120: }
7121: return $function;
1.54 www 7122: }
1.99 www 7123:
7124: ###############################################
7125:
1.233 raeburn 7126: =pod
7127:
1.821 raeburn 7128: =item * &show_course()
7129:
7130: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
7131: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
7132:
7133: Inputs:
7134: None
7135:
7136: Outputs:
7137: Scalar: 1 if 'Course' to be used, 0 otherwise.
7138:
7139: =cut
7140:
7141: ###############################################
7142: sub show_course {
7143: my $course = !$env{'user.adv'};
7144: if (!$env{'user.adv'}) {
7145: foreach my $env (keys(%env)) {
7146: next if ($env !~ m/^user\.priv\./);
7147: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
7148: $course = 0;
7149: last;
7150: }
7151: }
7152: }
7153: return $course;
7154: }
7155:
7156: ###############################################
7157:
7158: =pod
7159:
1.542 raeburn 7160: =item * &check_user_status()
1.274 raeburn 7161:
7162: Determines current status of supplied role for a
7163: specific user. Roles can be active, previous or future.
7164:
7165: Inputs:
7166: user's domain, user's username, course's domain,
1.375 raeburn 7167: course's number, optional section ID.
1.274 raeburn 7168:
7169: Outputs:
7170: role status: active, previous or future.
7171:
7172: =cut
7173:
7174: sub check_user_status {
1.412 raeburn 7175: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 7176: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
7177: my @uroles = keys %userinfo;
7178: my $srchstr;
7179: my $active_chk = 'none';
1.412 raeburn 7180: my $now = time;
1.274 raeburn 7181: if (@uroles > 0) {
1.908 raeburn 7182: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 7183: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
7184: } else {
1.412 raeburn 7185: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
7186: }
7187: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 7188: my $role_end = 0;
7189: my $role_start = 0;
7190: $active_chk = 'active';
1.412 raeburn 7191: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
7192: $role_end = $1;
7193: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
7194: $role_start = $1;
1.274 raeburn 7195: }
7196: }
7197: if ($role_start > 0) {
1.412 raeburn 7198: if ($now < $role_start) {
1.274 raeburn 7199: $active_chk = 'future';
7200: }
7201: }
7202: if ($role_end > 0) {
1.412 raeburn 7203: if ($now > $role_end) {
1.274 raeburn 7204: $active_chk = 'previous';
7205: }
7206: }
7207: }
7208: }
7209: return $active_chk;
7210: }
7211:
7212: ###############################################
7213:
7214: =pod
7215:
1.405 albertel 7216: =item * &get_sections()
1.233 raeburn 7217:
7218: Determines all the sections for a course including
7219: sections with students and sections containing other roles.
1.419 raeburn 7220: Incoming parameters:
7221:
7222: 1. domain
7223: 2. course number
7224: 3. reference to array containing roles for which sections should
7225: be gathered (optional).
7226: 4. reference to array containing status types for which sections
7227: should be gathered (optional).
7228:
7229: If the third argument is undefined, sections are gathered for any role.
7230: If the fourth argument is undefined, sections are gathered for any status.
7231: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 7232:
1.374 raeburn 7233: Returns section hash (keys are section IDs, values are
7234: number of users in each section), subject to the
1.419 raeburn 7235: optional roles filter, optional status filter
1.233 raeburn 7236:
7237: =cut
7238:
7239: ###############################################
7240: sub get_sections {
1.419 raeburn 7241: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 7242: if (!defined($cdom) || !defined($cnum)) {
7243: my $cid = $env{'request.course.id'};
7244:
7245: return if (!defined($cid));
7246:
7247: $cdom = $env{'course.'.$cid.'.domain'};
7248: $cnum = $env{'course.'.$cid.'.num'};
7249: }
7250:
7251: my %sectioncount;
1.419 raeburn 7252: my $now = time;
1.240 albertel 7253:
1.366 albertel 7254: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 7255: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 7256: my $sec_index = &Apache::loncoursedata::CL_SECTION();
7257: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 7258: my $start_index = &Apache::loncoursedata::CL_START();
7259: my $end_index = &Apache::loncoursedata::CL_END();
7260: my $status;
1.366 albertel 7261: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 7262: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
7263: $data->[$status_index],
7264: $data->[$start_index],
7265: $data->[$end_index]);
7266: if ($stu_status eq 'Active') {
7267: $status = 'active';
7268: } elsif ($end < $now) {
7269: $status = 'previous';
7270: } elsif ($start > $now) {
7271: $status = 'future';
7272: }
7273: if ($section ne '-1' && $section !~ /^\s*$/) {
7274: if ((!defined($possible_status)) || (($status ne '') &&
7275: (grep/^\Q$status\E$/,@{$possible_status}))) {
7276: $sectioncount{$section}++;
7277: }
1.240 albertel 7278: }
7279: }
7280: }
7281: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7282: foreach my $user (sort(keys(%courseroles))) {
7283: if ($user !~ /^(\w{2})/) { next; }
7284: my ($role) = ($user =~ /^(\w{2})/);
7285: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 7286: my ($section,$status);
1.240 albertel 7287: if ($role eq 'cr' &&
7288: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
7289: $section=$1;
7290: }
7291: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
7292: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 7293: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
7294: if ($end == -1 && $start == -1) {
7295: next; #deleted role
7296: }
7297: if (!defined($possible_status)) {
7298: $sectioncount{$section}++;
7299: } else {
7300: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
7301: $status = 'active';
7302: } elsif ($end < $now) {
7303: $status = 'future';
7304: } elsif ($start > $now) {
7305: $status = 'previous';
7306: }
7307: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
7308: $sectioncount{$section}++;
7309: }
7310: }
1.233 raeburn 7311: }
1.366 albertel 7312: return %sectioncount;
1.233 raeburn 7313: }
7314:
1.274 raeburn 7315: ###############################################
1.294 raeburn 7316:
7317: =pod
1.405 albertel 7318:
7319: =item * &get_course_users()
7320:
1.275 raeburn 7321: Retrieves usernames:domains for users in the specified course
7322: with specific role(s), and access status.
7323:
7324: Incoming parameters:
1.277 albertel 7325: 1. course domain
7326: 2. course number
7327: 3. access status: users must have - either active,
1.275 raeburn 7328: previous, future, or all.
1.277 albertel 7329: 4. reference to array of permissible roles
1.288 raeburn 7330: 5. reference to array of section restrictions (optional)
7331: 6. reference to results object (hash of hashes).
7332: 7. reference to optional userdata hash
1.609 raeburn 7333: 8. reference to optional statushash
1.630 raeburn 7334: 9. flag if privileged users (except those set to unhide in
7335: course settings) should be excluded
1.609 raeburn 7336: Keys of top level results hash are roles.
1.275 raeburn 7337: Keys of inner hashes are username:domain, with
7338: values set to access type.
1.288 raeburn 7339: Optional userdata hash returns an array with arguments in the
7340: same order as loncoursedata::get_classlist() for student data.
7341:
1.609 raeburn 7342: Optional statushash returns
7343:
1.288 raeburn 7344: Entries for end, start, section and status are blank because
7345: of the possibility of multiple values for non-student roles.
7346:
1.275 raeburn 7347: =cut
1.405 albertel 7348:
1.275 raeburn 7349: ###############################################
1.405 albertel 7350:
1.275 raeburn 7351: sub get_course_users {
1.630 raeburn 7352: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 7353: my %idx = ();
1.419 raeburn 7354: my %seclists;
1.288 raeburn 7355:
7356: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
7357: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
7358: $idx{end} = &Apache::loncoursedata::CL_END();
7359: $idx{start} = &Apache::loncoursedata::CL_START();
7360: $idx{id} = &Apache::loncoursedata::CL_ID();
7361: $idx{section} = &Apache::loncoursedata::CL_SECTION();
7362: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
7363: $idx{status} = &Apache::loncoursedata::CL_STATUS();
7364:
1.290 albertel 7365: if (grep(/^st$/,@{$roles})) {
1.276 albertel 7366: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 7367: my $now = time;
1.277 albertel 7368: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 7369: my $match = 0;
1.412 raeburn 7370: my $secmatch = 0;
1.419 raeburn 7371: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 7372: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 7373: if ($section eq '') {
7374: $section = 'none';
7375: }
1.291 albertel 7376: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7377: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7378: $secmatch = 1;
7379: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 7380: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7381: $secmatch = 1;
7382: }
7383: } else {
1.419 raeburn 7384: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 7385: $secmatch = 1;
7386: }
1.290 albertel 7387: }
1.412 raeburn 7388: if (!$secmatch) {
7389: next;
7390: }
1.419 raeburn 7391: }
1.275 raeburn 7392: if (defined($$types{'active'})) {
1.288 raeburn 7393: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 7394: push(@{$$users{st}{$student}},'active');
1.288 raeburn 7395: $match = 1;
1.275 raeburn 7396: }
7397: }
7398: if (defined($$types{'previous'})) {
1.609 raeburn 7399: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 7400: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 7401: $match = 1;
1.275 raeburn 7402: }
7403: }
7404: if (defined($$types{'future'})) {
1.609 raeburn 7405: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 7406: push(@{$$users{st}{$student}},'future');
1.288 raeburn 7407: $match = 1;
1.275 raeburn 7408: }
7409: }
1.609 raeburn 7410: if ($match) {
7411: push(@{$seclists{$student}},$section);
7412: if (ref($userdata) eq 'HASH') {
7413: $$userdata{$student} = $$classlist{$student};
7414: }
7415: if (ref($statushash) eq 'HASH') {
7416: $statushash->{$student}{'st'}{$section} = $status;
7417: }
1.288 raeburn 7418: }
1.275 raeburn 7419: }
7420: }
1.412 raeburn 7421: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 7422: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7423: my $now = time;
1.609 raeburn 7424: my %displaystatus = ( previous => 'Expired',
7425: active => 'Active',
7426: future => 'Future',
7427: );
1.630 raeburn 7428: my %nothide;
7429: if ($hidepriv) {
7430: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
7431: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
7432: if ($user !~ /:/) {
7433: $nothide{join(':',split(/[\@]/,$user))}=1;
7434: } else {
7435: $nothide{$user} = 1;
7436: }
7437: }
7438: }
1.439 raeburn 7439: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 7440: my $match = 0;
1.412 raeburn 7441: my $secmatch = 0;
1.439 raeburn 7442: my $status;
1.412 raeburn 7443: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 7444: $user =~ s/:$//;
1.439 raeburn 7445: my ($end,$start) = split(/:/,$coursepersonnel{$person});
7446: if ($end == -1 || $start == -1) {
7447: next;
7448: }
7449: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
7450: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 7451: my ($uname,$udom) = split(/:/,$user);
7452: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7453: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7454: $secmatch = 1;
7455: } elsif ($usec eq '') {
1.420 albertel 7456: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7457: $secmatch = 1;
7458: }
7459: } else {
7460: if (grep(/^\Q$usec\E$/,@{$sections})) {
7461: $secmatch = 1;
7462: }
7463: }
7464: if (!$secmatch) {
7465: next;
7466: }
1.288 raeburn 7467: }
1.419 raeburn 7468: if ($usec eq '') {
7469: $usec = 'none';
7470: }
1.275 raeburn 7471: if ($uname ne '' && $udom ne '') {
1.630 raeburn 7472: if ($hidepriv) {
7473: if ((&Apache::lonnet::privileged($uname,$udom)) &&
7474: (!$nothide{$uname.':'.$udom})) {
7475: next;
7476: }
7477: }
1.503 raeburn 7478: if ($end > 0 && $end < $now) {
1.439 raeburn 7479: $status = 'previous';
7480: } elsif ($start > $now) {
7481: $status = 'future';
7482: } else {
7483: $status = 'active';
7484: }
1.277 albertel 7485: foreach my $type (keys(%{$types})) {
1.275 raeburn 7486: if ($status eq $type) {
1.420 albertel 7487: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 7488: push(@{$$users{$role}{$user}},$type);
7489: }
1.288 raeburn 7490: $match = 1;
7491: }
7492: }
1.419 raeburn 7493: if (($match) && (ref($userdata) eq 'HASH')) {
7494: if (!exists($$userdata{$uname.':'.$udom})) {
7495: &get_user_info($udom,$uname,\%idx,$userdata);
7496: }
1.420 albertel 7497: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 7498: push(@{$seclists{$uname.':'.$udom}},$usec);
7499: }
1.609 raeburn 7500: if (ref($statushash) eq 'HASH') {
7501: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
7502: }
1.275 raeburn 7503: }
7504: }
7505: }
7506: }
1.290 albertel 7507: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 7508: if ((defined($cdom)) && (defined($cnum))) {
7509: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
7510: if ( defined($csettings{'internal.courseowner'}) ) {
7511: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 7512: next if ($owner eq '');
7513: my ($ownername,$ownerdom);
7514: if ($owner =~ /^([^:]+):([^:]+)$/) {
7515: $ownername = $1;
7516: $ownerdom = $2;
7517: } else {
7518: $ownername = $owner;
7519: $ownerdom = $cdom;
7520: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 7521: }
7522: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 7523: if (defined($userdata) &&
1.609 raeburn 7524: !exists($$userdata{$owner})) {
7525: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
7526: if (!grep(/^none$/,@{$seclists{$owner}})) {
7527: push(@{$seclists{$owner}},'none');
7528: }
7529: if (ref($statushash) eq 'HASH') {
7530: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 7531: }
1.290 albertel 7532: }
1.279 raeburn 7533: }
7534: }
7535: }
1.419 raeburn 7536: foreach my $user (keys(%seclists)) {
7537: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
7538: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
7539: }
1.275 raeburn 7540: }
7541: return;
7542: }
7543:
1.288 raeburn 7544: sub get_user_info {
7545: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 7546: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
7547: &plainname($uname,$udom,'lastname');
1.291 albertel 7548: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 7549: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 7550: my %idhash = &Apache::lonnet::idrget($udom,($uname));
7551: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 7552: return;
7553: }
1.275 raeburn 7554:
1.472 raeburn 7555: ###############################################
7556:
7557: =pod
7558:
7559: =item * &get_user_quota()
7560:
7561: Retrieves quota assigned for storage of portfolio files for a user
7562:
7563: Incoming parameters:
7564: 1. user's username
7565: 2. user's domain
7566:
7567: Returns:
1.536 raeburn 7568: 1. Disk quota (in Mb) assigned to student.
7569: 2. (Optional) Type of setting: custom or default
7570: (individually assigned or default for user's
7571: institutional status).
7572: 3. (Optional) - User's institutional status (e.g., faculty, staff
7573: or student - types as defined in localenroll::inst_usertypes
7574: for user's domain, which determines default quota for user.
7575: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 7576:
7577: If a value has been stored in the user's environment,
1.536 raeburn 7578: it will return that, otherwise it returns the maximal default
7579: defined for the user's instituional status(es) in the domain.
1.472 raeburn 7580:
7581: =cut
7582:
7583: ###############################################
7584:
7585:
7586: sub get_user_quota {
7587: my ($uname,$udom) = @_;
1.536 raeburn 7588: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 7589: if (!defined($udom)) {
7590: $udom = $env{'user.domain'};
7591: }
7592: if (!defined($uname)) {
7593: $uname = $env{'user.name'};
7594: }
7595: if (($udom eq '' || $uname eq '') ||
7596: ($udom eq 'public') && ($uname eq 'public')) {
7597: $quota = 0;
1.536 raeburn 7598: $quotatype = 'default';
7599: $defquota = 0;
1.472 raeburn 7600: } else {
1.536 raeburn 7601: my $inststatus;
1.472 raeburn 7602: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
7603: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 7604: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 7605: } else {
1.536 raeburn 7606: my %userenv =
7607: &Apache::lonnet::get('environment',['portfolioquota',
7608: 'inststatus'],$udom,$uname);
1.472 raeburn 7609: my ($tmp) = keys(%userenv);
7610: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7611: $quota = $userenv{'portfolioquota'};
1.536 raeburn 7612: $inststatus = $userenv{'inststatus'};
1.472 raeburn 7613: } else {
7614: undef(%userenv);
7615: }
7616: }
1.536 raeburn 7617: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 7618: if ($quota eq '') {
1.536 raeburn 7619: $quota = $defquota;
7620: $quotatype = 'default';
7621: } else {
7622: $quotatype = 'custom';
1.472 raeburn 7623: }
7624: }
1.536 raeburn 7625: if (wantarray) {
7626: return ($quota,$quotatype,$settingstatus,$defquota);
7627: } else {
7628: return $quota;
7629: }
1.472 raeburn 7630: }
7631:
7632: ###############################################
7633:
7634: =pod
7635:
7636: =item * &default_quota()
7637:
1.536 raeburn 7638: Retrieves default quota assigned for storage of user portfolio files,
7639: given an (optional) user's institutional status.
1.472 raeburn 7640:
7641: Incoming parameters:
7642: 1. domain
1.536 raeburn 7643: 2. (Optional) institutional status(es). This is a : separated list of
7644: status types (e.g., faculty, staff, student etc.)
7645: which apply to the user for whom the default is being retrieved.
7646: If the institutional status string in undefined, the domain
7647: default quota will be returned.
1.472 raeburn 7648:
7649: Returns:
7650: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 7651: 2. (Optional) institutional type which determined the value of the
7652: default quota.
1.472 raeburn 7653:
7654: If a value has been stored in the domain's configuration db,
7655: it will return that, otherwise it returns 20 (for backwards
7656: compatibility with domains which have not set up a configuration
7657: db file; the original statically defined portfolio quota was 20 Mb).
7658:
1.536 raeburn 7659: If the user's status includes multiple types (e.g., staff and student),
7660: the largest default quota which applies to the user determines the
7661: default quota returned.
7662:
1.780 raeburn 7663: =back
7664:
1.472 raeburn 7665: =cut
7666:
7667: ###############################################
7668:
7669:
7670: sub default_quota {
1.536 raeburn 7671: my ($udom,$inststatus) = @_;
7672: my ($defquota,$settingstatus);
7673: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 7674: ['quotas'],$udom);
7675: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 7676: if ($inststatus ne '') {
1.765 raeburn 7677: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 7678: foreach my $item (@statuses) {
1.711 raeburn 7679: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7680: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
7681: if ($defquota eq '') {
7682: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7683: $settingstatus = $item;
7684: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
7685: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7686: $settingstatus = $item;
7687: }
7688: }
7689: } else {
7690: if ($quotahash{'quotas'}{$item} ne '') {
7691: if ($defquota eq '') {
7692: $defquota = $quotahash{'quotas'}{$item};
7693: $settingstatus = $item;
7694: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
7695: $defquota = $quotahash{'quotas'}{$item};
7696: $settingstatus = $item;
7697: }
1.536 raeburn 7698: }
7699: }
7700: }
7701: }
7702: if ($defquota eq '') {
1.711 raeburn 7703: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7704: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
7705: } else {
7706: $defquota = $quotahash{'quotas'}{'default'};
7707: }
1.536 raeburn 7708: $settingstatus = 'default';
7709: }
7710: } else {
7711: $settingstatus = 'default';
7712: $defquota = 20;
7713: }
7714: if (wantarray) {
7715: return ($defquota,$settingstatus);
1.472 raeburn 7716: } else {
1.536 raeburn 7717: return $defquota;
1.472 raeburn 7718: }
7719: }
7720:
1.384 raeburn 7721: sub get_secgrprole_info {
7722: my ($cdom,$cnum,$needroles,$type) = @_;
7723: my %sections_count = &get_sections($cdom,$cnum);
7724: my @sections = (sort {$a <=> $b} keys(%sections_count));
7725: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
7726: my @groups = sort(keys(%curr_groups));
7727: my $allroles = [];
7728: my $rolehash;
7729: my $accesshash = {
7730: active => 'Currently has access',
7731: future => 'Will have future access',
7732: previous => 'Previously had access',
7733: };
7734: if ($needroles) {
7735: $rolehash = {'all' => 'all'};
1.385 albertel 7736: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7737: if (&Apache::lonnet::error(%user_roles)) {
7738: undef(%user_roles);
7739: }
7740: foreach my $item (keys(%user_roles)) {
1.384 raeburn 7741: my ($role)=split(/\:/,$item,2);
7742: if ($role eq 'cr') { next; }
7743: if ($role =~ /^cr/) {
7744: $$rolehash{$role} = (split('/',$role))[3];
7745: } else {
7746: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
7747: }
7748: }
7749: foreach my $key (sort(keys(%{$rolehash}))) {
7750: push(@{$allroles},$key);
7751: }
7752: push (@{$allroles},'st');
7753: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
7754: }
7755: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
7756: }
7757:
1.555 raeburn 7758: sub user_picker {
1.627 raeburn 7759: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555 raeburn 7760: my $currdom = $dom;
7761: my %curr_selected = (
7762: srchin => 'dom',
1.580 raeburn 7763: srchby => 'lastname',
1.555 raeburn 7764: );
7765: my $srchterm;
1.625 raeburn 7766: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 7767: if ($srch->{'srchby'} ne '') {
7768: $curr_selected{'srchby'} = $srch->{'srchby'};
7769: }
7770: if ($srch->{'srchin'} ne '') {
7771: $curr_selected{'srchin'} = $srch->{'srchin'};
7772: }
7773: if ($srch->{'srchtype'} ne '') {
7774: $curr_selected{'srchtype'} = $srch->{'srchtype'};
7775: }
7776: if ($srch->{'srchdomain'} ne '') {
7777: $currdom = $srch->{'srchdomain'};
7778: }
7779: $srchterm = $srch->{'srchterm'};
7780: }
7781: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 7782: 'usr' => 'Search criteria',
1.563 raeburn 7783: 'doma' => 'Domain/institution to search',
1.558 albertel 7784: 'uname' => 'username',
7785: 'lastname' => 'last name',
1.555 raeburn 7786: 'lastfirst' => 'last name, first name',
1.558 albertel 7787: 'crs' => 'in this course',
1.576 raeburn 7788: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 7789: 'alc' => 'all LON-CAPA',
1.573 raeburn 7790: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 7791: 'exact' => 'is',
7792: 'contains' => 'contains',
1.569 raeburn 7793: 'begins' => 'begins with',
1.571 raeburn 7794: 'youm' => "You must include some text to search for.",
7795: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
7796: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
7797: 'yomc' => "You must choose a domain when using an institutional directory search.",
7798: 'ymcd' => "You must choose a domain when using a domain search.",
7799: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
7800: 'whse' => "When searching by last,first you must include at least one character in the first name.",
7801: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 7802: );
1.563 raeburn 7803: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
7804: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 7805:
7806: my @srchins = ('crs','dom','alc','instd');
7807:
7808: foreach my $option (@srchins) {
7809: # FIXME 'alc' option unavailable until
7810: # loncreateuser::print_user_query_page()
7811: # has been completed.
7812: next if ($option eq 'alc');
1.880 raeburn 7813: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 7814: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 7815: if ($curr_selected{'srchin'} eq $option) {
7816: $srchinsel .= '
7817: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7818: } else {
7819: $srchinsel .= '
7820: <option value="'.$option.'">'.$lt{$option}.'</option>';
7821: }
1.555 raeburn 7822: }
1.563 raeburn 7823: $srchinsel .= "\n </select>\n";
1.555 raeburn 7824:
7825: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 7826: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 7827: if ($curr_selected{'srchby'} eq $option) {
7828: $srchbysel .= '
7829: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7830: } else {
7831: $srchbysel .= '
7832: <option value="'.$option.'">'.$lt{$option}.'</option>';
7833: }
7834: }
7835: $srchbysel .= "\n </select>\n";
7836:
7837: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 7838: foreach my $option ('begins','contains','exact') {
1.555 raeburn 7839: if ($curr_selected{'srchtype'} eq $option) {
7840: $srchtypesel .= '
7841: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7842: } else {
7843: $srchtypesel .= '
7844: <option value="'.$option.'">'.$lt{$option}.'</option>';
7845: }
7846: }
7847: $srchtypesel .= "\n </select>\n";
7848:
1.558 albertel 7849: my ($newuserscript,$new_user_create);
1.556 raeburn 7850:
7851: if ($forcenewuser) {
1.576 raeburn 7852: if (ref($srch) eq 'HASH') {
7853: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627 raeburn 7854: if ($cancreate) {
7855: $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>';
7856: } else {
1.799 bisitz 7857: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 7858: my %usertypetext = (
7859: official => 'institutional',
7860: unofficial => 'non-institutional',
7861: );
1.799 bisitz 7862: $new_user_create = '<p class="LC_warning">'
7863: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
7864: .' '
7865: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
7866: ,'<a href="'.$helplink.'">','</a>')
7867: .'</p><br />';
1.627 raeburn 7868: }
1.576 raeburn 7869: }
7870: }
7871:
1.556 raeburn 7872: $newuserscript = <<"ENDSCRIPT";
7873:
1.570 raeburn 7874: function setSearch(createnew,callingForm) {
1.556 raeburn 7875: if (createnew == 1) {
1.570 raeburn 7876: for (var i=0; i<callingForm.srchby.length; i++) {
7877: if (callingForm.srchby.options[i].value == 'uname') {
7878: callingForm.srchby.selectedIndex = i;
1.556 raeburn 7879: }
7880: }
1.570 raeburn 7881: for (var i=0; i<callingForm.srchin.length; i++) {
7882: if ( callingForm.srchin.options[i].value == 'dom') {
7883: callingForm.srchin.selectedIndex = i;
1.556 raeburn 7884: }
7885: }
1.570 raeburn 7886: for (var i=0; i<callingForm.srchtype.length; i++) {
7887: if (callingForm.srchtype.options[i].value == 'exact') {
7888: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 7889: }
7890: }
1.570 raeburn 7891: for (var i=0; i<callingForm.srchdomain.length; i++) {
7892: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
7893: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 7894: }
7895: }
7896: }
7897: }
7898: ENDSCRIPT
1.558 albertel 7899:
1.556 raeburn 7900: }
7901:
1.555 raeburn 7902: my $output = <<"END_BLOCK";
1.556 raeburn 7903: <script type="text/javascript">
1.824 bisitz 7904: // <![CDATA[
1.570 raeburn 7905: function validateEntry(callingForm) {
1.558 albertel 7906:
1.556 raeburn 7907: var checkok = 1;
1.558 albertel 7908: var srchin;
1.570 raeburn 7909: for (var i=0; i<callingForm.srchin.length; i++) {
7910: if ( callingForm.srchin[i].checked ) {
7911: srchin = callingForm.srchin[i].value;
1.558 albertel 7912: }
7913: }
7914:
1.570 raeburn 7915: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7916: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7917: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7918: var srchterm = callingForm.srchterm.value;
7919: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7920: var msg = "";
7921:
7922: if (srchterm == "") {
7923: checkok = 0;
1.571 raeburn 7924: msg += "$lt{'youm'}\\n";
1.556 raeburn 7925: }
7926:
1.569 raeburn 7927: if (srchtype== 'begins') {
7928: if (srchterm.length < 2) {
7929: checkok = 0;
1.571 raeburn 7930: msg += "$lt{'thte'}\\n";
1.569 raeburn 7931: }
7932: }
7933:
1.556 raeburn 7934: if (srchtype== 'contains') {
7935: if (srchterm.length < 3) {
7936: checkok = 0;
1.571 raeburn 7937: msg += "$lt{'thet'}\\n";
1.556 raeburn 7938: }
7939: }
7940: if (srchin == 'instd') {
7941: if (srchdomain == '') {
7942: checkok = 0;
1.571 raeburn 7943: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7944: }
7945: }
7946: if (srchin == 'dom') {
7947: if (srchdomain == '') {
7948: checkok = 0;
1.571 raeburn 7949: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7950: }
7951: }
7952: if (srchby == 'lastfirst') {
7953: if (srchterm.indexOf(",") == -1) {
7954: checkok = 0;
1.571 raeburn 7955: msg += "$lt{'whus'}\\n";
1.556 raeburn 7956: }
7957: if (srchterm.indexOf(",") == srchterm.length -1) {
7958: checkok = 0;
1.571 raeburn 7959: msg += "$lt{'whse'}\\n";
1.556 raeburn 7960: }
7961: }
7962: if (checkok == 0) {
1.571 raeburn 7963: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7964: return;
7965: }
7966: if (checkok == 1) {
1.570 raeburn 7967: callingForm.submit();
1.556 raeburn 7968: }
7969: }
7970:
7971: $newuserscript
7972:
1.824 bisitz 7973: // ]]>
1.556 raeburn 7974: </script>
1.558 albertel 7975:
7976: $new_user_create
7977:
1.555 raeburn 7978: END_BLOCK
1.558 albertel 7979:
1.876 raeburn 7980: $output .= &Apache::lonhtmlcommon::start_pick_box().
7981: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
7982: $domform.
7983: &Apache::lonhtmlcommon::row_closure().
7984: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
7985: $srchbysel.
7986: $srchtypesel.
7987: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
7988: $srchinsel.
7989: &Apache::lonhtmlcommon::row_closure(1).
7990: &Apache::lonhtmlcommon::end_pick_box().
7991: '<br />';
1.555 raeburn 7992: return $output;
7993: }
7994:
1.612 raeburn 7995: sub user_rule_check {
1.615 raeburn 7996: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 7997: my $response;
7998: if (ref($usershash) eq 'HASH') {
7999: foreach my $user (keys(%{$usershash})) {
8000: my ($uname,$udom) = split(/:/,$user);
8001: next if ($udom eq '' || $uname eq '');
1.615 raeburn 8002: my ($id,$newuser);
1.612 raeburn 8003: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 8004: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 8005: $id = $usershash->{$user}->{'id'};
8006: }
8007: my $inst_response;
8008: if (ref($checks) eq 'HASH') {
8009: if (defined($checks->{'username'})) {
1.615 raeburn 8010: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 8011: &Apache::lonnet::get_instuser($udom,$uname);
8012: } elsif (defined($checks->{'id'})) {
1.615 raeburn 8013: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 8014: &Apache::lonnet::get_instuser($udom,undef,$id);
8015: }
1.615 raeburn 8016: } else {
8017: ($inst_response,%{$inst_results->{$user}}) =
8018: &Apache::lonnet::get_instuser($udom,$uname);
8019: return;
1.612 raeburn 8020: }
1.615 raeburn 8021: if (!$got_rules->{$udom}) {
1.612 raeburn 8022: my %domconfig = &Apache::lonnet::get_dom('configuration',
8023: ['usercreation'],$udom);
8024: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 8025: foreach my $item ('username','id') {
1.612 raeburn 8026: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
8027: $$curr_rules{$udom}{$item} =
8028: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 8029: }
8030: }
8031: }
1.615 raeburn 8032: $got_rules->{$udom} = 1;
1.585 raeburn 8033: }
1.612 raeburn 8034: foreach my $item (keys(%{$checks})) {
8035: if (ref($$curr_rules{$udom}) eq 'HASH') {
8036: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
8037: if (@{$$curr_rules{$udom}{$item}} > 0) {
8038: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
8039: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
8040: if ($rule_check{$rule}) {
8041: $$rulematch{$user}{$item} = $rule;
8042: if ($inst_response eq 'ok') {
1.615 raeburn 8043: if (ref($inst_results) eq 'HASH') {
8044: if (ref($inst_results->{$user}) eq 'HASH') {
8045: if (keys(%{$inst_results->{$user}}) == 0) {
8046: $$alerts{$item}{$udom}{$uname} = 1;
8047: }
1.612 raeburn 8048: }
8049: }
1.615 raeburn 8050: }
8051: last;
1.585 raeburn 8052: }
8053: }
8054: }
8055: }
8056: }
8057: }
8058: }
8059: }
1.612 raeburn 8060: return;
8061: }
8062:
8063: sub user_rule_formats {
8064: my ($domain,$domdesc,$curr_rules,$check) = @_;
8065: my %text = (
8066: 'username' => 'Usernames',
8067: 'id' => 'IDs',
8068: );
8069: my $output;
8070: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
8071: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
8072: if (@{$ruleorder} > 0) {
8073: $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>';
8074: foreach my $rule (@{$ruleorder}) {
8075: if (ref($curr_rules) eq 'ARRAY') {
8076: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
8077: if (ref($rules->{$rule}) eq 'HASH') {
8078: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
8079: $rules->{$rule}{'desc'}.'</li>';
8080: }
8081: }
8082: }
8083: }
8084: $output .= '</ul>';
8085: }
8086: }
8087: return $output;
8088: }
8089:
8090: sub instrule_disallow_msg {
1.615 raeburn 8091: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 8092: my $response;
8093: my %text = (
8094: item => 'username',
8095: items => 'usernames',
8096: match => 'matches',
8097: do => 'does',
8098: action => 'a username',
8099: one => 'one',
8100: );
8101: if ($count > 1) {
8102: $text{'item'} = 'usernames';
8103: $text{'match'} ='match';
8104: $text{'do'} = 'do';
8105: $text{'action'} = 'usernames',
8106: $text{'one'} = 'ones';
8107: }
8108: if ($checkitem eq 'id') {
8109: $text{'items'} = 'IDs';
8110: $text{'item'} = 'ID';
8111: $text{'action'} = 'an ID';
1.615 raeburn 8112: if ($count > 1) {
8113: $text{'item'} = 'IDs';
8114: $text{'action'} = 'IDs';
8115: }
1.612 raeburn 8116: }
1.674 bisitz 8117: $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 8118: if ($mode eq 'upload') {
8119: if ($checkitem eq 'username') {
8120: $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'}.");
8121: } elsif ($checkitem eq 'id') {
1.674 bisitz 8122: $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 8123: }
1.669 raeburn 8124: } elsif ($mode eq 'selfcreate') {
8125: if ($checkitem eq 'id') {
8126: $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.");
8127: }
1.615 raeburn 8128: } else {
8129: if ($checkitem eq 'username') {
8130: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
8131: } elsif ($checkitem eq 'id') {
8132: $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.");
8133: }
1.612 raeburn 8134: }
8135: return $response;
1.585 raeburn 8136: }
8137:
1.624 raeburn 8138: sub personal_data_fieldtitles {
8139: my %fieldtitles = &Apache::lonlocal::texthash (
8140: id => 'Student/Employee ID',
8141: permanentemail => 'E-mail address',
8142: lastname => 'Last Name',
8143: firstname => 'First Name',
8144: middlename => 'Middle Name',
8145: generation => 'Generation',
8146: gen => 'Generation',
1.765 raeburn 8147: inststatus => 'Affiliation',
1.624 raeburn 8148: );
8149: return %fieldtitles;
8150: }
8151:
1.642 raeburn 8152: sub sorted_inst_types {
8153: my ($dom) = @_;
8154: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
8155: my $othertitle = &mt('All users');
8156: if ($env{'request.course.id'}) {
1.668 raeburn 8157: $othertitle = &mt('Any users');
1.642 raeburn 8158: }
8159: my @types;
8160: if (ref($order) eq 'ARRAY') {
8161: @types = @{$order};
8162: }
8163: if (@types == 0) {
8164: if (ref($usertypes) eq 'HASH') {
8165: @types = sort(keys(%{$usertypes}));
8166: }
8167: }
8168: if (keys(%{$usertypes}) > 0) {
8169: $othertitle = &mt('Other users');
8170: }
8171: return ($othertitle,$usertypes,\@types);
8172: }
8173:
1.645 raeburn 8174: sub get_institutional_codes {
8175: my ($settings,$allcourses,$LC_code) = @_;
8176: # Get complete list of course sections to update
8177: my @currsections = ();
8178: my @currxlists = ();
8179: my $coursecode = $$settings{'internal.coursecode'};
8180:
8181: if ($$settings{'internal.sectionnums'} ne '') {
8182: @currsections = split(/,/,$$settings{'internal.sectionnums'});
8183: }
8184:
8185: if ($$settings{'internal.crosslistings'} ne '') {
8186: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
8187: }
8188:
8189: if (@currxlists > 0) {
8190: foreach (@currxlists) {
8191: if (m/^([^:]+):(\w*)$/) {
8192: unless (grep/^$1$/,@{$allcourses}) {
8193: push @{$allcourses},$1;
8194: $$LC_code{$1} = $2;
8195: }
8196: }
8197: }
8198: }
8199:
8200: if (@currsections > 0) {
8201: foreach (@currsections) {
8202: if (m/^(\w+):(\w*)$/) {
8203: my $sec = $coursecode.$1;
8204: my $lc_sec = $2;
8205: unless (grep/^$sec$/,@{$allcourses}) {
8206: push @{$allcourses},$sec;
8207: $$LC_code{$sec} = $lc_sec;
8208: }
8209: }
8210: }
8211: }
8212: return;
8213: }
8214:
1.112 bowersj2 8215: =pod
8216:
1.780 raeburn 8217: =head1 Slot Helpers
8218:
8219: =over 4
8220:
8221: =item * sorted_slots()
8222:
8223: Sorts an array of slot names in order of slot start time (earliest first).
8224:
8225: Inputs:
8226:
8227: =over 4
8228:
8229: slotsarr - Reference to array of unsorted slot names.
8230:
8231: slots - Reference to hash of hash, where outer hash keys are slot names.
8232:
1.549 albertel 8233: =back
8234:
1.780 raeburn 8235: Returns:
8236:
8237: =over 4
8238:
8239: sorted - An array of slot names sorted by the start time of the slot.
8240:
8241: =back
8242:
8243: =back
8244:
8245: =cut
8246:
8247:
8248: sub sorted_slots {
8249: my ($slotsarr,$slots) = @_;
8250: my @sorted;
8251: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
8252: @sorted =
8253: sort {
8254: if (ref($slots->{$a}) && ref($slots->{$b})) {
8255: return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
8256: }
8257: if (ref($slots->{$a})) { return -1;}
8258: if (ref($slots->{$b})) { return 1;}
8259: return 0;
8260: } @{$slotsarr};
8261: }
8262: return @sorted;
8263: }
8264:
8265:
8266: =pod
8267:
1.549 albertel 8268: =head1 HTTP Helpers
8269:
8270: =over 4
8271:
1.648 raeburn 8272: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 8273:
1.258 albertel 8274: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 8275: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 8276: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 8277:
8278: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
8279: $possible_names is an ref to an array of form element names. As an example:
8280: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 8281: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 8282:
8283: =cut
1.1 albertel 8284:
1.6 albertel 8285: sub get_unprocessed_cgi {
1.25 albertel 8286: my ($query,$possible_names)= @_;
1.26 matthew 8287: # $Apache::lonxml::debug=1;
1.356 albertel 8288: foreach my $pair (split(/&/,$query)) {
8289: my ($name, $value) = split(/=/,$pair);
1.369 www 8290: $name = &unescape($name);
1.25 albertel 8291: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
8292: $value =~ tr/+/ /;
8293: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 8294: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 8295: }
1.16 harris41 8296: }
1.6 albertel 8297: }
8298:
1.112 bowersj2 8299: =pod
8300:
1.648 raeburn 8301: =item * &cacheheader()
1.112 bowersj2 8302:
8303: returns cache-controlling header code
8304:
8305: =cut
8306:
1.7 albertel 8307: sub cacheheader {
1.258 albertel 8308: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 8309: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
8310: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 8311: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
8312: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 8313: return $output;
1.7 albertel 8314: }
8315:
1.112 bowersj2 8316: =pod
8317:
1.648 raeburn 8318: =item * &no_cache($r)
1.112 bowersj2 8319:
8320: specifies header code to not have cache
8321:
8322: =cut
8323:
1.9 albertel 8324: sub no_cache {
1.216 albertel 8325: my ($r) = @_;
8326: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 8327: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 8328: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
8329: $r->no_cache(1);
8330: $r->header_out("Expires" => $date);
8331: $r->header_out("Pragma" => "no-cache");
1.123 www 8332: }
8333:
8334: sub content_type {
1.181 albertel 8335: my ($r,$type,$charset) = @_;
1.299 foxr 8336: if ($r) {
8337: # Note that printout.pl calls this with undef for $r.
8338: &no_cache($r);
8339: }
1.258 albertel 8340: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 8341: unless ($charset) {
8342: $charset=&Apache::lonlocal::current_encoding;
8343: }
8344: if ($charset) { $type.='; charset='.$charset; }
8345: if ($r) {
8346: $r->content_type($type);
8347: } else {
8348: print("Content-type: $type\n\n");
8349: }
1.9 albertel 8350: }
1.25 albertel 8351:
1.112 bowersj2 8352: =pod
8353:
1.648 raeburn 8354: =item * &add_to_env($name,$value)
1.112 bowersj2 8355:
1.258 albertel 8356: adds $name to the %env hash with value
1.112 bowersj2 8357: $value, if $name already exists, the entry is converted to an array
8358: reference and $value is added to the array.
8359:
8360: =cut
8361:
1.25 albertel 8362: sub add_to_env {
8363: my ($name,$value)=@_;
1.258 albertel 8364: if (defined($env{$name})) {
8365: if (ref($env{$name})) {
1.25 albertel 8366: #already have multiple values
1.258 albertel 8367: push(@{ $env{$name} },$value);
1.25 albertel 8368: } else {
8369: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 8370: my $first=$env{$name};
8371: undef($env{$name});
8372: push(@{ $env{$name} },$first,$value);
1.25 albertel 8373: }
8374: } else {
1.258 albertel 8375: $env{$name}=$value;
1.25 albertel 8376: }
1.31 albertel 8377: }
1.149 albertel 8378:
8379: =pod
8380:
1.648 raeburn 8381: =item * &get_env_multiple($name)
1.149 albertel 8382:
1.258 albertel 8383: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 8384: values may be defined and end up as an array ref.
8385:
8386: returns an array of values
8387:
8388: =cut
8389:
8390: sub get_env_multiple {
8391: my ($name) = @_;
8392: my @values;
1.258 albertel 8393: if (defined($env{$name})) {
1.149 albertel 8394: # exists is it an array
1.258 albertel 8395: if (ref($env{$name})) {
8396: @values=@{ $env{$name} };
1.149 albertel 8397: } else {
1.258 albertel 8398: $values[0]=$env{$name};
1.149 albertel 8399: }
8400: }
8401: return(@values);
8402: }
8403:
1.660 raeburn 8404: sub ask_for_embedded_content {
8405: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
8406: my $upload_output = '
8407: <form name="upload_embedded" action="'.$actionurl.'"
8408: method="post" enctype="multipart/form-data">';
8409: $upload_output .= $state;
1.661 raeburn 8410: $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660 raeburn 8411:
8412: my $num = 0;
8413: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
8414: $upload_output .= &start_data_table_row().
8415: '<td>'.$embed_file.'</td><td>';
8416: if ($args->{'ignore_remote_references'}
8417: && $embed_file =~ m{^\w+://}) {
8418: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
8419: } elsif ($args->{'error_on_invalid_names'}
8420: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
8421:
8422: $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
8423:
8424: } else {
8425: $upload_output .='
1.661 raeburn 8426: <input name="embedded_item_'.$num.'" type="file" value="" />
1.660 raeburn 8427: <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
8428: my $attrib = join(':',@{$$allfiles{$embed_file}});
8429: $upload_output .=
8430: "\n\t\t".
8431: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
8432: $attrib.'" />';
8433: if (exists($$codebase{$embed_file})) {
8434: $upload_output .=
8435: "\n\t\t".
8436: '<input name="codebase_'.$num.'" type="hidden" value="'.
8437: &escape($$codebase{$embed_file}).'" />';
8438: }
8439: }
8440: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
8441: $num++;
8442: }
8443: $upload_output .= &Apache::loncommon::end_data_table().'<br />
8444: <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
8445: <input type ="submit" value="'.&mt('Upload Listed Files').'" />
8446: '.&mt('(only files for which a location has been provided will be uploaded)').'
8447: </form>';
8448: return $upload_output;
8449: }
8450:
1.661 raeburn 8451: sub upload_embedded {
8452: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
8453: $current_disk_usage) = @_;
8454: my $output;
8455: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
8456: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
8457: my $orig_uploaded_filename =
8458: $env{'form.embedded_item_'.$i.'.filename'};
8459:
8460: $env{'form.embedded_orig_'.$i} =
8461: &unescape($env{'form.embedded_orig_'.$i});
8462: my ($path,$fname) =
8463: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
8464: # no path, whole string is fname
8465: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
8466:
8467: $path = $env{'form.currentpath'}.$path;
8468: $fname = &Apache::lonnet::clean_filename($fname);
8469: # See if there is anything left
8470: next if ($fname eq '');
8471:
8472: # Check if file already exists as a file or directory.
8473: my ($state,$msg);
8474: if ($context eq 'portfolio') {
8475: my $port_path = $dirpath;
8476: if ($group ne '') {
8477: $port_path = "groups/$group/$port_path";
8478: }
8479: ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
8480: $dir_root,$port_path,$disk_quota,
8481: $current_disk_usage,$uname,$udom);
8482: if ($state eq 'will_exceed_quota'
8483: || $state eq 'file_locked'
8484: || $state eq 'file_exists' ) {
8485: $output .= $msg;
8486: next;
8487: }
8488: } elsif (($context eq 'author') || ($context eq 'testbank')) {
8489: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
8490: if ($state eq 'exists') {
8491: $output .= $msg;
8492: next;
8493: }
8494: }
8495: # Check if extension is valid
8496: if (($fname =~ /\.(\w+)$/) &&
8497: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
8498: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
8499: next;
8500: } elsif (($fname =~ /\.(\w+)$/) &&
8501: (!defined(&Apache::loncommon::fileembstyle($1)))) {
8502: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
8503: next;
8504: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
8505: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
8506: next;
8507: }
8508:
8509: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
8510: if ($context eq 'portfolio') {
8511: my $result=
8512: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
8513: $dirpath.$path);
8514: if ($result !~ m|^/uploaded/|) {
8515: $output .= '<span class="LC_error">'
8516: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
8517: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
8518: .'</span><br />';
8519: next;
8520: } else {
8521: $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
8522: $path.$fname.'</span>').'</p>';
8523: }
8524: } else {
8525: # Save the file
8526: my $target = $env{'form.embedded_item_'.$i};
8527: my $fullpath = $dir_root.$dirpath.'/'.$path;
8528: my $dest = $fullpath.$fname;
8529: my $url = $url_root.$dirpath.'/'.$path.$fname;
8530: my @parts=split(/\//,$fullpath);
8531: my $count;
8532: my $filepath = $dir_root;
8533: for ($count=4;$count<=$#parts;$count++) {
8534: $filepath .= "/$parts[$count]";
8535: if ((-e $filepath)!=1) {
8536: mkdir($filepath,0770);
8537: }
8538: }
8539: my $fh;
8540: if (!open($fh,'>'.$dest)) {
8541: &Apache::lonnet::logthis('Failed to create '.$dest);
8542: $output .= '<span class="LC_error">'.
8543: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8544: '</span><br />';
8545: } else {
8546: if (!print $fh $env{'form.embedded_item_'.$i}) {
8547: &Apache::lonnet::logthis('Failed to write to '.$dest);
8548: $output .= '<span class="LC_error">'.
8549: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8550: '</span><br />';
8551: } else {
8552: if ($context eq 'testbank') {
8553: $output .= &mt('Embedded file uploaded successfully:').
8554: ' <a href="'.$url.'">'.
8555: $orig_uploaded_filename.'</a><br />';
8556: } else {
1.705 tempelho 8557: $output .= '<span class=\"LC_fontsize_large\">'.
1.661 raeburn 8558: &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705 tempelho 8559: $orig_uploaded_filename.'</a>').'</span><br />';
1.661 raeburn 8560: }
8561: }
8562: close($fh);
8563: }
8564: }
8565: }
8566: return $output;
8567: }
8568:
8569: sub check_for_existing {
8570: my ($path,$fname,$element) = @_;
8571: my ($state,$msg);
8572: if (-d $path.'/'.$fname) {
8573: $state = 'exists';
8574: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8575: } elsif (-e $path.'/'.$fname) {
8576: $state = 'exists';
8577: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8578: }
8579: if ($state eq 'exists') {
8580: $msg = '<span class="LC_error">'.$msg.'</span><br />';
8581: }
8582: return ($state,$msg);
8583: }
8584:
8585: sub check_for_upload {
8586: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
8587: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
8588: my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
8589: my $getpropath = 1;
8590: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
8591: $getpropath);
8592: my $found_file = 0;
8593: my $locked_file = 0;
8594: foreach my $line (@dir_list) {
8595: my ($file_name)=split(/\&/,$line,2);
8596: if ($file_name eq $fname){
8597: $file_name = $path.$file_name;
8598: if ($group ne '') {
8599: $file_name = $group.$file_name;
8600: }
8601: $found_file = 1;
8602: if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
8603: $locked_file = 1;
8604: }
8605: }
8606: }
8607: if (($current_disk_usage + $filesize) > $disk_quota){
8608: my $msg = '<span class="LC_error">'.
8609: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
8610: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
8611: return ('will_exceed_quota',$msg);
8612: } elsif ($found_file) {
8613: if ($locked_file) {
8614: my $msg = '<span class="LC_error">';
8615: $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>');
8616: $msg .= '</span><br />';
8617: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
8618: return ('file_locked',$msg);
8619: } else {
8620: my $msg = '<span class="LC_error">';
8621: $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'});
8622: $msg .= '</span>';
8623: $msg .= '<br />';
8624: $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
8625: return ('file_exists',$msg);
8626: }
8627: }
8628: }
8629:
1.31 albertel 8630:
1.41 ng 8631: =pod
1.45 matthew 8632:
1.464 albertel 8633: =back
1.41 ng 8634:
1.112 bowersj2 8635: =head1 CSV Upload/Handling functions
1.38 albertel 8636:
1.41 ng 8637: =over 4
8638:
1.648 raeburn 8639: =item * &upfile_store($r)
1.41 ng 8640:
8641: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 8642: needs $env{'form.upfile'}
1.41 ng 8643: returns $datatoken to be put into hidden field
8644:
8645: =cut
1.31 albertel 8646:
8647: sub upfile_store {
8648: my $r=shift;
1.258 albertel 8649: $env{'form.upfile'}=~s/\r/\n/gs;
8650: $env{'form.upfile'}=~s/\f/\n/gs;
8651: $env{'form.upfile'}=~s/\n+/\n/gs;
8652: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 8653:
1.258 albertel 8654: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
8655: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 8656: {
1.158 raeburn 8657: my $datafile = $r->dir_config('lonDaemons').
8658: '/tmp/'.$datatoken.'.tmp';
8659: if ( open(my $fh,">$datafile") ) {
1.258 albertel 8660: print $fh $env{'form.upfile'};
1.158 raeburn 8661: close($fh);
8662: }
1.31 albertel 8663: }
8664: return $datatoken;
8665: }
8666:
1.56 matthew 8667: =pod
8668:
1.648 raeburn 8669: =item * &load_tmp_file($r)
1.41 ng 8670:
8671: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 8672: needs $env{'form.datatoken'},
8673: sets $env{'form.upfile'} to the contents of the file
1.41 ng 8674:
8675: =cut
1.31 albertel 8676:
8677: sub load_tmp_file {
8678: my $r=shift;
8679: my @studentdata=();
8680: {
1.158 raeburn 8681: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 8682: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 8683: if ( open(my $fh,"<$studentfile") ) {
8684: @studentdata=<$fh>;
8685: close($fh);
8686: }
1.31 albertel 8687: }
1.258 albertel 8688: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 8689: }
8690:
1.56 matthew 8691: =pod
8692:
1.648 raeburn 8693: =item * &upfile_record_sep()
1.41 ng 8694:
8695: Separate uploaded file into records
8696: returns array of records,
1.258 albertel 8697: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 8698:
8699: =cut
1.31 albertel 8700:
8701: sub upfile_record_sep {
1.258 albertel 8702: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 8703: } else {
1.248 albertel 8704: my @records;
1.258 albertel 8705: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 8706: if ($line=~/^\s*$/) { next; }
8707: push(@records,$line);
8708: }
8709: return @records;
1.31 albertel 8710: }
8711: }
8712:
1.56 matthew 8713: =pod
8714:
1.648 raeburn 8715: =item * &record_sep($record)
1.41 ng 8716:
1.258 albertel 8717: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 8718:
8719: =cut
8720:
1.263 www 8721: sub takeleft {
8722: my $index=shift;
8723: return substr('0000'.$index,-4,4);
8724: }
8725:
1.31 albertel 8726: sub record_sep {
8727: my $record=shift;
8728: my %components=();
1.258 albertel 8729: if ($env{'form.upfiletype'} eq 'xml') {
8730: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 8731: my $i=0;
1.356 albertel 8732: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 8733: $field=~s/^(\"|\')//;
8734: $field=~s/(\"|\')$//;
1.263 www 8735: $components{&takeleft($i)}=$field;
1.31 albertel 8736: $i++;
8737: }
1.258 albertel 8738: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 8739: my $i=0;
1.356 albertel 8740: foreach my $field (split(/\t/,$record)) {
1.31 albertel 8741: $field=~s/^(\"|\')//;
8742: $field=~s/(\"|\')$//;
1.263 www 8743: $components{&takeleft($i)}=$field;
1.31 albertel 8744: $i++;
8745: }
8746: } else {
1.561 www 8747: my $separator=',';
1.480 banghart 8748: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 8749: $separator=';';
1.480 banghart 8750: }
1.31 albertel 8751: my $i=0;
1.561 www 8752: # the character we are looking for to indicate the end of a quote or a record
8753: my $looking_for=$separator;
8754: # do not add the characters to the fields
8755: my $ignore=0;
8756: # we just encountered a separator (or the beginning of the record)
8757: my $just_found_separator=1;
8758: # store the field we are working on here
8759: my $field='';
8760: # work our way through all characters in record
8761: foreach my $character ($record=~/(.)/g) {
8762: if ($character eq $looking_for) {
8763: if ($character ne $separator) {
8764: # Found the end of a quote, again looking for separator
8765: $looking_for=$separator;
8766: $ignore=1;
8767: } else {
8768: # Found a separator, store away what we got
8769: $components{&takeleft($i)}=$field;
8770: $i++;
8771: $just_found_separator=1;
8772: $ignore=0;
8773: $field='';
8774: }
8775: next;
8776: }
8777: # single or double quotation marks after a separator indicate beginning of a quote
8778: # we are now looking for the end of the quote and need to ignore separators
8779: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
8780: $looking_for=$character;
8781: next;
8782: }
8783: # ignore would be true after we reached the end of a quote
8784: if ($ignore) { next; }
8785: if (($just_found_separator) && ($character=~/\s/)) { next; }
8786: $field.=$character;
8787: $just_found_separator=0;
1.31 albertel 8788: }
1.561 www 8789: # catch the very last entry, since we never encountered the separator
8790: $components{&takeleft($i)}=$field;
1.31 albertel 8791: }
8792: return %components;
8793: }
8794:
1.144 matthew 8795: ######################################################
8796: ######################################################
8797:
1.56 matthew 8798: =pod
8799:
1.648 raeburn 8800: =item * &upfile_select_html()
1.41 ng 8801:
1.144 matthew 8802: Return HTML code to select a file from the users machine and specify
8803: the file type.
1.41 ng 8804:
8805: =cut
8806:
1.144 matthew 8807: ######################################################
8808: ######################################################
1.31 albertel 8809: sub upfile_select_html {
1.144 matthew 8810: my %Types = (
8811: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 8812: semisv => &mt('Semicolon separated values'),
1.144 matthew 8813: space => &mt('Space separated'),
8814: tab => &mt('Tabulator separated'),
8815: # xml => &mt('HTML/XML'),
8816: );
8817: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 8818: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 8819: foreach my $type (sort(keys(%Types))) {
8820: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
8821: }
8822: $Str .= "</select>\n";
8823: return $Str;
1.31 albertel 8824: }
8825:
1.301 albertel 8826: sub get_samples {
8827: my ($records,$toget) = @_;
8828: my @samples=({});
8829: my $got=0;
8830: foreach my $rec (@$records) {
8831: my %temp = &record_sep($rec);
8832: if (! grep(/\S/, values(%temp))) { next; }
8833: if (%temp) {
8834: $samples[$got]=\%temp;
8835: $got++;
8836: if ($got == $toget) { last; }
8837: }
8838: }
8839: return \@samples;
8840: }
8841:
1.144 matthew 8842: ######################################################
8843: ######################################################
8844:
1.56 matthew 8845: =pod
8846:
1.648 raeburn 8847: =item * &csv_print_samples($r,$records)
1.41 ng 8848:
8849: Prints a table of sample values from each column uploaded $r is an
8850: Apache Request ref, $records is an arrayref from
8851: &Apache::loncommon::upfile_record_sep
8852:
8853: =cut
8854:
1.144 matthew 8855: ######################################################
8856: ######################################################
1.31 albertel 8857: sub csv_print_samples {
8858: my ($r,$records) = @_;
1.662 bisitz 8859: my $samples = &get_samples($records,5);
1.301 albertel 8860:
1.594 raeburn 8861: $r->print(&mt('Samples').'<br />'.&start_data_table().
8862: &start_data_table_header_row());
1.356 albertel 8863: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 8864: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 8865: $r->print(&end_data_table_header_row());
1.301 albertel 8866: foreach my $hash (@$samples) {
1.594 raeburn 8867: $r->print(&start_data_table_row());
1.356 albertel 8868: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 8869: $r->print('<td>');
1.356 albertel 8870: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 8871: $r->print('</td>');
8872: }
1.594 raeburn 8873: $r->print(&end_data_table_row());
1.31 albertel 8874: }
1.594 raeburn 8875: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 8876: }
8877:
1.144 matthew 8878: ######################################################
8879: ######################################################
8880:
1.56 matthew 8881: =pod
8882:
1.648 raeburn 8883: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 8884:
8885: Prints a table to create associations between values and table columns.
1.144 matthew 8886:
1.41 ng 8887: $r is an Apache Request ref,
8888: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 8889: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 8890:
8891: =cut
8892:
1.144 matthew 8893: ######################################################
8894: ######################################################
1.31 albertel 8895: sub csv_print_select_table {
8896: my ($r,$records,$d) = @_;
1.301 albertel 8897: my $i=0;
8898: my $samples = &get_samples($records,1);
1.144 matthew 8899: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 8900: &start_data_table().&start_data_table_header_row().
1.144 matthew 8901: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 8902: '<th>'.&mt('Column').'</th>'.
8903: &end_data_table_header_row()."\n");
1.356 albertel 8904: foreach my $array_ref (@$d) {
8905: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 8906: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 8907:
1.875 bisitz 8908: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 8909: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 8910: $r->print('<option value="none"></option>');
1.356 albertel 8911: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8912: $r->print('<option value="'.$sample.'"'.
8913: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 8914: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 8915: }
1.594 raeburn 8916: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 8917: $i++;
8918: }
1.594 raeburn 8919: $r->print(&end_data_table());
1.31 albertel 8920: $i--;
8921: return $i;
8922: }
1.56 matthew 8923:
1.144 matthew 8924: ######################################################
8925: ######################################################
8926:
1.56 matthew 8927: =pod
1.31 albertel 8928:
1.648 raeburn 8929: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 8930:
8931: Prints a table of sample values from the upload and can make associate samples to internal names.
8932:
8933: $r is an Apache Request ref,
8934: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
8935: $d is an array of 2 element arrays (internal name, displayed name)
8936:
8937: =cut
8938:
1.144 matthew 8939: ######################################################
8940: ######################################################
1.31 albertel 8941: sub csv_samples_select_table {
8942: my ($r,$records,$d) = @_;
8943: my $i=0;
1.144 matthew 8944: #
1.662 bisitz 8945: my $max_samples = 5;
8946: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 8947: $r->print(&start_data_table().
8948: &start_data_table_header_row().'<th>'.
8949: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
8950: &end_data_table_header_row());
1.301 albertel 8951:
8952: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 8953: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 8954: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 8955: foreach my $option (@$d) {
8956: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 8957: $r->print('<option value="'.$value.'"'.
1.253 albertel 8958: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 8959: $display.'</option>');
1.31 albertel 8960: }
8961: $r->print('</select></td><td>');
1.662 bisitz 8962: foreach my $line (0..($max_samples-1)) {
1.301 albertel 8963: if (defined($samples->[$line]{$key})) {
8964: $r->print($samples->[$line]{$key}."<br />\n");
8965: }
8966: }
1.594 raeburn 8967: $r->print('</td>'.&end_data_table_row());
1.31 albertel 8968: $i++;
8969: }
1.594 raeburn 8970: $r->print(&end_data_table());
1.31 albertel 8971: $i--;
8972: return($i);
1.115 matthew 8973: }
8974:
1.144 matthew 8975: ######################################################
8976: ######################################################
8977:
1.115 matthew 8978: =pod
8979:
1.648 raeburn 8980: =item * &clean_excel_name($name)
1.115 matthew 8981:
8982: Returns a replacement for $name which does not contain any illegal characters.
8983:
8984: =cut
8985:
1.144 matthew 8986: ######################################################
8987: ######################################################
1.115 matthew 8988: sub clean_excel_name {
8989: my ($name) = @_;
8990: $name =~ s/[:\*\?\/\\]//g;
8991: if (length($name) > 31) {
8992: $name = substr($name,0,31);
8993: }
8994: return $name;
1.25 albertel 8995: }
1.84 albertel 8996:
1.85 albertel 8997: =pod
8998:
1.648 raeburn 8999: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 9000:
9001: Returns either 1 or undef
9002:
9003: 1 if the part is to be hidden, undef if it is to be shown
9004:
9005: Arguments are:
9006:
9007: $id the id of the part to be checked
9008: $symb, optional the symb of the resource to check
9009: $udom, optional the domain of the user to check for
9010: $uname, optional the username of the user to check for
9011:
9012: =cut
1.84 albertel 9013:
9014: sub check_if_partid_hidden {
9015: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 9016: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 9017: $symb,$udom,$uname);
1.141 albertel 9018: my $truth=1;
9019: #if the string starts with !, then the list is the list to show not hide
9020: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 9021: my @hiddenlist=split(/,/,$hiddenparts);
9022: foreach my $checkid (@hiddenlist) {
1.141 albertel 9023: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 9024: }
1.141 albertel 9025: return !$truth;
1.84 albertel 9026: }
1.127 matthew 9027:
1.138 matthew 9028:
9029: ############################################################
9030: ############################################################
9031:
9032: =pod
9033:
1.157 matthew 9034: =back
9035:
1.138 matthew 9036: =head1 cgi-bin script and graphing routines
9037:
1.157 matthew 9038: =over 4
9039:
1.648 raeburn 9040: =item * &get_cgi_id()
1.138 matthew 9041:
9042: Inputs: none
9043:
9044: Returns an id which can be used to pass environment variables
9045: to various cgi-bin scripts. These environment variables will
9046: be removed from the users environment after a given time by
9047: the routine &Apache::lonnet::transfer_profile_to_env.
9048:
9049: =cut
9050:
9051: ############################################################
9052: ############################################################
1.152 albertel 9053: my $uniq=0;
1.136 matthew 9054: sub get_cgi_id {
1.154 albertel 9055: $uniq=($uniq+1)%100000;
1.280 albertel 9056: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 9057: }
9058:
1.127 matthew 9059: ############################################################
9060: ############################################################
9061:
9062: =pod
9063:
1.648 raeburn 9064: =item * &DrawBarGraph()
1.127 matthew 9065:
1.138 matthew 9066: Facilitates the plotting of data in a (stacked) bar graph.
9067: Puts plot definition data into the users environment in order for
9068: graph.png to plot it. Returns an <img> tag for the plot.
9069: The bars on the plot are labeled '1','2',...,'n'.
9070:
9071: Inputs:
9072:
9073: =over 4
9074:
9075: =item $Title: string, the title of the plot
9076:
9077: =item $xlabel: string, text describing the X-axis of the plot
9078:
9079: =item $ylabel: string, text describing the Y-axis of the plot
9080:
9081: =item $Max: scalar, the maximum Y value to use in the plot
9082: If $Max is < any data point, the graph will not be rendered.
9083:
1.140 matthew 9084: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 9085: they are plotted. If undefined, default values will be used.
9086:
1.178 matthew 9087: =item $labels: array ref holding the labels to use on the x-axis for the bars.
9088:
1.138 matthew 9089: =item @Values: An array of array references. Each array reference holds data
9090: to be plotted in a stacked bar chart.
9091:
1.239 matthew 9092: =item If the final element of @Values is a hash reference the key/value
9093: pairs will be added to the graph definition.
9094:
1.138 matthew 9095: =back
9096:
9097: Returns:
9098:
9099: An <img> tag which references graph.png and the appropriate identifying
9100: information for the plot.
9101:
1.127 matthew 9102: =cut
9103:
9104: ############################################################
9105: ############################################################
1.134 matthew 9106: sub DrawBarGraph {
1.178 matthew 9107: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 9108: #
9109: if (! defined($colors)) {
9110: $colors = ['#33ff00',
9111: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
9112: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
9113: ];
9114: }
1.228 matthew 9115: my $extra_settings = {};
9116: if (ref($Values[-1]) eq 'HASH') {
9117: $extra_settings = pop(@Values);
9118: }
1.127 matthew 9119: #
1.136 matthew 9120: my $identifier = &get_cgi_id();
9121: my $id = 'cgi.'.$identifier;
1.129 matthew 9122: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 9123: return '';
9124: }
1.225 matthew 9125: #
9126: my @Labels;
9127: if (defined($labels)) {
9128: @Labels = @$labels;
9129: } else {
9130: for (my $i=0;$i<@{$Values[0]};$i++) {
9131: push (@Labels,$i+1);
9132: }
9133: }
9134: #
1.129 matthew 9135: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 9136: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 9137: my %ValuesHash;
9138: my $NumSets=1;
9139: foreach my $array (@Values) {
9140: next if (! ref($array));
1.136 matthew 9141: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 9142: join(',',@$array);
1.129 matthew 9143: }
1.127 matthew 9144: #
1.136 matthew 9145: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 9146: if ($NumBars < 3) {
9147: $width = 120+$NumBars*32;
1.220 matthew 9148: $xskip = 1;
1.225 matthew 9149: $bar_width = 30;
9150: } elsif ($NumBars < 5) {
9151: $width = 120+$NumBars*20;
9152: $xskip = 1;
9153: $bar_width = 20;
1.220 matthew 9154: } elsif ($NumBars < 10) {
1.136 matthew 9155: $width = 120+$NumBars*15;
9156: $xskip = 1;
9157: $bar_width = 15;
9158: } elsif ($NumBars <= 25) {
9159: $width = 120+$NumBars*11;
9160: $xskip = 5;
9161: $bar_width = 8;
9162: } elsif ($NumBars <= 50) {
9163: $width = 120+$NumBars*8;
9164: $xskip = 5;
9165: $bar_width = 4;
9166: } else {
9167: $width = 120+$NumBars*8;
9168: $xskip = 5;
9169: $bar_width = 4;
9170: }
9171: #
1.137 matthew 9172: $Max = 1 if ($Max < 1);
9173: if ( int($Max) < $Max ) {
9174: $Max++;
9175: $Max = int($Max);
9176: }
1.127 matthew 9177: $Title = '' if (! defined($Title));
9178: $xlabel = '' if (! defined($xlabel));
9179: $ylabel = '' if (! defined($ylabel));
1.369 www 9180: $ValuesHash{$id.'.title'} = &escape($Title);
9181: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
9182: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 9183: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 9184: $ValuesHash{$id.'.NumBars'} = $NumBars;
9185: $ValuesHash{$id.'.NumSets'} = $NumSets;
9186: $ValuesHash{$id.'.PlotType'} = 'bar';
9187: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9188: $ValuesHash{$id.'.height'} = $height;
9189: $ValuesHash{$id.'.width'} = $width;
9190: $ValuesHash{$id.'.xskip'} = $xskip;
9191: $ValuesHash{$id.'.bar_width'} = $bar_width;
9192: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 9193: #
1.228 matthew 9194: # Deal with other parameters
9195: while (my ($key,$value) = each(%$extra_settings)) {
9196: $ValuesHash{$id.'.'.$key} = $value;
9197: }
9198: #
1.646 raeburn 9199: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 9200: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9201: }
9202:
9203: ############################################################
9204: ############################################################
9205:
9206: =pod
9207:
1.648 raeburn 9208: =item * &DrawXYGraph()
1.137 matthew 9209:
1.138 matthew 9210: Facilitates the plotting of data in an XY graph.
9211: Puts plot definition data into the users environment in order for
9212: graph.png to plot it. Returns an <img> tag for the plot.
9213:
9214: Inputs:
9215:
9216: =over 4
9217:
9218: =item $Title: string, the title of the plot
9219:
9220: =item $xlabel: string, text describing the X-axis of the plot
9221:
9222: =item $ylabel: string, text describing the Y-axis of the plot
9223:
9224: =item $Max: scalar, the maximum Y value to use in the plot
9225: If $Max is < any data point, the graph will not be rendered.
9226:
9227: =item $colors: Array ref containing the hex color codes for the data to be
9228: plotted in. If undefined, default values will be used.
9229:
9230: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9231:
9232: =item $Ydata: Array ref containing Array refs.
1.185 www 9233: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 9234:
9235: =item %Values: hash indicating or overriding any default values which are
9236: passed to graph.png.
9237: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9238:
9239: =back
9240:
9241: Returns:
9242:
9243: An <img> tag which references graph.png and the appropriate identifying
9244: information for the plot.
9245:
1.137 matthew 9246: =cut
9247:
9248: ############################################################
9249: ############################################################
9250: sub DrawXYGraph {
9251: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
9252: #
9253: # Create the identifier for the graph
9254: my $identifier = &get_cgi_id();
9255: my $id = 'cgi.'.$identifier;
9256: #
9257: $Title = '' if (! defined($Title));
9258: $xlabel = '' if (! defined($xlabel));
9259: $ylabel = '' if (! defined($ylabel));
9260: my %ValuesHash =
9261: (
1.369 www 9262: $id.'.title' => &escape($Title),
9263: $id.'.xlabel' => &escape($xlabel),
9264: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 9265: $id.'.y_max_value'=> $Max,
9266: $id.'.labels' => join(',',@$Xlabels),
9267: $id.'.PlotType' => 'XY',
9268: );
9269: #
9270: if (defined($colors) && ref($colors) eq 'ARRAY') {
9271: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9272: }
9273: #
9274: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
9275: return '';
9276: }
9277: my $NumSets=1;
1.138 matthew 9278: foreach my $array (@{$Ydata}){
1.137 matthew 9279: next if (! ref($array));
9280: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
9281: }
1.138 matthew 9282: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 9283: #
9284: # Deal with other parameters
9285: while (my ($key,$value) = each(%Values)) {
9286: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 9287: }
9288: #
1.646 raeburn 9289: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 9290: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9291: }
9292:
9293: ############################################################
9294: ############################################################
9295:
9296: =pod
9297:
1.648 raeburn 9298: =item * &DrawXYYGraph()
1.138 matthew 9299:
9300: Facilitates the plotting of data in an XY graph with two Y axes.
9301: Puts plot definition data into the users environment in order for
9302: graph.png to plot it. Returns an <img> tag for the plot.
9303:
9304: Inputs:
9305:
9306: =over 4
9307:
9308: =item $Title: string, the title of the plot
9309:
9310: =item $xlabel: string, text describing the X-axis of the plot
9311:
9312: =item $ylabel: string, text describing the Y-axis of the plot
9313:
9314: =item $colors: Array ref containing the hex color codes for the data to be
9315: plotted in. If undefined, default values will be used.
9316:
9317: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9318:
9319: =item $Ydata1: The first data set
9320:
9321: =item $Min1: The minimum value of the left Y-axis
9322:
9323: =item $Max1: The maximum value of the left Y-axis
9324:
9325: =item $Ydata2: The second data set
9326:
9327: =item $Min2: The minimum value of the right Y-axis
9328:
9329: =item $Max2: The maximum value of the left Y-axis
9330:
9331: =item %Values: hash indicating or overriding any default values which are
9332: passed to graph.png.
9333: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9334:
9335: =back
9336:
9337: Returns:
9338:
9339: An <img> tag which references graph.png and the appropriate identifying
9340: information for the plot.
1.136 matthew 9341:
9342: =cut
9343:
9344: ############################################################
9345: ############################################################
1.137 matthew 9346: sub DrawXYYGraph {
9347: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
9348: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 9349: #
9350: # Create the identifier for the graph
9351: my $identifier = &get_cgi_id();
9352: my $id = 'cgi.'.$identifier;
9353: #
9354: $Title = '' if (! defined($Title));
9355: $xlabel = '' if (! defined($xlabel));
9356: $ylabel = '' if (! defined($ylabel));
9357: my %ValuesHash =
9358: (
1.369 www 9359: $id.'.title' => &escape($Title),
9360: $id.'.xlabel' => &escape($xlabel),
9361: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 9362: $id.'.labels' => join(',',@$Xlabels),
9363: $id.'.PlotType' => 'XY',
9364: $id.'.NumSets' => 2,
1.137 matthew 9365: $id.'.two_axes' => 1,
9366: $id.'.y1_max_value' => $Max1,
9367: $id.'.y1_min_value' => $Min1,
9368: $id.'.y2_max_value' => $Max2,
9369: $id.'.y2_min_value' => $Min2,
1.136 matthew 9370: );
9371: #
1.137 matthew 9372: if (defined($colors) && ref($colors) eq 'ARRAY') {
9373: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9374: }
9375: #
9376: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
9377: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 9378: return '';
9379: }
9380: my $NumSets=1;
1.137 matthew 9381: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 9382: next if (! ref($array));
9383: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 9384: }
9385: #
9386: # Deal with other parameters
9387: while (my ($key,$value) = each(%Values)) {
9388: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 9389: }
9390: #
1.646 raeburn 9391: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 9392: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 9393: }
9394:
9395: ############################################################
9396: ############################################################
9397:
9398: =pod
9399:
1.157 matthew 9400: =back
9401:
1.139 matthew 9402: =head1 Statistics helper routines?
9403:
9404: Bad place for them but what the hell.
9405:
1.157 matthew 9406: =over 4
9407:
1.648 raeburn 9408: =item * &chartlink()
1.139 matthew 9409:
9410: Returns a link to the chart for a specific student.
9411:
9412: Inputs:
9413:
9414: =over 4
9415:
9416: =item $linktext: The text of the link
9417:
9418: =item $sname: The students username
9419:
9420: =item $sdomain: The students domain
9421:
9422: =back
9423:
1.157 matthew 9424: =back
9425:
1.139 matthew 9426: =cut
9427:
9428: ############################################################
9429: ############################################################
9430: sub chartlink {
9431: my ($linktext, $sname, $sdomain) = @_;
9432: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 9433: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 9434: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 9435: '">'.$linktext.'</a>';
1.153 matthew 9436: }
9437:
9438: #######################################################
9439: #######################################################
9440:
9441: =pod
9442:
9443: =head1 Course Environment Routines
1.157 matthew 9444:
9445: =over 4
1.153 matthew 9446:
1.648 raeburn 9447: =item * &restore_course_settings()
1.153 matthew 9448:
1.648 raeburn 9449: =item * &store_course_settings()
1.153 matthew 9450:
9451: Restores/Store indicated form parameters from the course environment.
9452: Will not overwrite existing values of the form parameters.
9453:
9454: Inputs:
9455: a scalar describing the data (e.g. 'chart', 'problem_analysis')
9456:
9457: a hash ref describing the data to be stored. For example:
9458:
9459: %Save_Parameters = ('Status' => 'scalar',
9460: 'chartoutputmode' => 'scalar',
9461: 'chartoutputdata' => 'scalar',
9462: 'Section' => 'array',
1.373 raeburn 9463: 'Group' => 'array',
1.153 matthew 9464: 'StudentData' => 'array',
9465: 'Maps' => 'array');
9466:
9467: Returns: both routines return nothing
9468:
1.631 raeburn 9469: =back
9470:
1.153 matthew 9471: =cut
9472:
9473: #######################################################
9474: #######################################################
9475: sub store_course_settings {
1.496 albertel 9476: return &store_settings($env{'request.course.id'},@_);
9477: }
9478:
9479: sub store_settings {
1.153 matthew 9480: # save to the environment
9481: # appenv the same items, just to be safe
1.300 albertel 9482: my $udom = $env{'user.domain'};
9483: my $uname = $env{'user.name'};
1.496 albertel 9484: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9485: my %SaveHash;
9486: my %AppHash;
9487: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 9488: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 9489: my $envname = 'environment.'.$basename;
1.258 albertel 9490: if (exists($env{'form.'.$setting})) {
1.153 matthew 9491: # Save this value away
9492: if ($type eq 'scalar' &&
1.258 albertel 9493: (! exists($env{$envname}) ||
9494: $env{$envname} ne $env{'form.'.$setting})) {
9495: $SaveHash{$basename} = $env{'form.'.$setting};
9496: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 9497: } elsif ($type eq 'array') {
9498: my $stored_form;
1.258 albertel 9499: if (ref($env{'form.'.$setting})) {
1.153 matthew 9500: $stored_form = join(',',
9501: map {
1.369 www 9502: &escape($_);
1.258 albertel 9503: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 9504: } else {
9505: $stored_form =
1.369 www 9506: &escape($env{'form.'.$setting});
1.153 matthew 9507: }
9508: # Determine if the array contents are the same.
1.258 albertel 9509: if ($stored_form ne $env{$envname}) {
1.153 matthew 9510: $SaveHash{$basename} = $stored_form;
9511: $AppHash{$envname} = $stored_form;
9512: }
9513: }
9514: }
9515: }
9516: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 9517: $udom,$uname);
1.153 matthew 9518: if ($put_result !~ /^(ok|delayed)/) {
9519: &Apache::lonnet::logthis('unable to save form parameters, '.
9520: 'got error:'.$put_result);
9521: }
9522: # Make sure these settings stick around in this session, too
1.646 raeburn 9523: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 9524: return;
9525: }
9526:
9527: sub restore_course_settings {
1.499 albertel 9528: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 9529: }
9530:
9531: sub restore_settings {
9532: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9533: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 9534: next if (exists($env{'form.'.$setting}));
1.496 albertel 9535: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 9536: '.'.$setting;
1.258 albertel 9537: if (exists($env{$envname})) {
1.153 matthew 9538: if ($type eq 'scalar') {
1.258 albertel 9539: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 9540: } elsif ($type eq 'array') {
1.258 albertel 9541: $env{'form.'.$setting} = [
1.153 matthew 9542: map {
1.369 www 9543: &unescape($_);
1.258 albertel 9544: } split(',',$env{$envname})
1.153 matthew 9545: ];
9546: }
9547: }
9548: }
1.127 matthew 9549: }
9550:
1.618 raeburn 9551: #######################################################
9552: #######################################################
9553:
9554: =pod
9555:
9556: =head1 Domain E-mail Routines
9557:
9558: =over 4
9559:
1.648 raeburn 9560: =item * &build_recipient_list()
1.618 raeburn 9561:
1.884 raeburn 9562: Build recipient lists for five types of e-mail:
1.766 raeburn 9563: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884 raeburn 9564: (d) Help requests, (e) Course requests needing approval, generated by
9565: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
9566: loncoursequeueadmin.pm respectively.
1.618 raeburn 9567:
9568: Inputs:
1.619 raeburn 9569: defmail (scalar - email address of default recipient),
1.618 raeburn 9570: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 9571: defdom (domain for which to retrieve configuration settings),
9572: origmail (scalar - email address of recipient from loncapa.conf,
9573: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 9574:
1.655 raeburn 9575: Returns: comma separated list of addresses to which to send e-mail.
9576:
9577: =back
1.618 raeburn 9578:
9579: =cut
9580:
9581: ############################################################
9582: ############################################################
9583: sub build_recipient_list {
1.619 raeburn 9584: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 9585: my @recipients;
9586: my $otheremails;
9587: my %domconfig =
9588: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
9589: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 9590: if (exists($domconfig{'contacts'}{$mailing})) {
9591: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
9592: my @contacts = ('adminemail','supportemail');
9593: foreach my $item (@contacts) {
9594: if ($domconfig{'contacts'}{$mailing}{$item}) {
9595: my $addr = $domconfig{'contacts'}{$item};
9596: if (!grep(/^\Q$addr\E$/,@recipients)) {
9597: push(@recipients,$addr);
9598: }
1.619 raeburn 9599: }
1.766 raeburn 9600: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 9601: }
9602: }
1.766 raeburn 9603: } elsif ($origmail ne '') {
9604: push(@recipients,$origmail);
1.618 raeburn 9605: }
1.619 raeburn 9606: } elsif ($origmail ne '') {
9607: push(@recipients,$origmail);
1.618 raeburn 9608: }
1.688 raeburn 9609: if (defined($defmail)) {
9610: if ($defmail ne '') {
9611: push(@recipients,$defmail);
9612: }
1.618 raeburn 9613: }
9614: if ($otheremails) {
1.619 raeburn 9615: my @others;
9616: if ($otheremails =~ /,/) {
9617: @others = split(/,/,$otheremails);
1.618 raeburn 9618: } else {
1.619 raeburn 9619: push(@others,$otheremails);
9620: }
9621: foreach my $addr (@others) {
9622: if (!grep(/^\Q$addr\E$/,@recipients)) {
9623: push(@recipients,$addr);
9624: }
1.618 raeburn 9625: }
9626: }
1.619 raeburn 9627: my $recipientlist = join(',',@recipients);
1.618 raeburn 9628: return $recipientlist;
9629: }
9630:
1.127 matthew 9631: ############################################################
9632: ############################################################
1.154 albertel 9633:
1.655 raeburn 9634: =pod
9635:
9636: =head1 Course Catalog Routines
9637:
9638: =over 4
9639:
9640: =item * &gather_categories()
9641:
9642: Converts category definitions - keys of categories hash stored in
9643: coursecategories in configuration.db on the primary library server in a
9644: domain - to an array. Also generates javascript and idx hash used to
9645: generate Domain Coordinator interface for editing Course Categories.
9646:
9647: Inputs:
1.663 raeburn 9648:
1.655 raeburn 9649: categories (reference to hash of category definitions).
1.663 raeburn 9650:
1.655 raeburn 9651: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9652: categories and subcategories).
1.663 raeburn 9653:
1.655 raeburn 9654: idx (reference to hash of counters used in Domain Coordinator interface for
9655: editing Course Categories).
1.663 raeburn 9656:
1.655 raeburn 9657: jsarray (reference to array of categories used to create Javascript arrays for
9658: Domain Coordinator interface for editing Course Categories).
9659:
9660: Returns: nothing
9661:
9662: Side effects: populates cats, idx and jsarray.
9663:
9664: =cut
9665:
9666: sub gather_categories {
9667: my ($categories,$cats,$idx,$jsarray) = @_;
9668: my %counters;
9669: my $num = 0;
9670: foreach my $item (keys(%{$categories})) {
9671: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
9672: if ($container eq '' && $depth == 0) {
9673: $cats->[$depth][$categories->{$item}] = $cat;
9674: } else {
9675: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
9676: }
9677: my ($escitem,$tail) = split(/:/,$item,2);
9678: if ($counters{$tail} eq '') {
9679: $counters{$tail} = $num;
9680: $num ++;
9681: }
9682: if (ref($idx) eq 'HASH') {
9683: $idx->{$item} = $counters{$tail};
9684: }
9685: if (ref($jsarray) eq 'ARRAY') {
9686: push(@{$jsarray->[$counters{$tail}]},$item);
9687: }
9688: }
9689: return;
9690: }
9691:
9692: =pod
9693:
9694: =item * &extract_categories()
9695:
9696: Used to generate breadcrumb trails for course categories.
9697:
9698: Inputs:
1.663 raeburn 9699:
1.655 raeburn 9700: categories (reference to hash of category definitions).
1.663 raeburn 9701:
1.655 raeburn 9702: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9703: categories and subcategories).
1.663 raeburn 9704:
1.655 raeburn 9705: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 9706:
1.655 raeburn 9707: allitems (reference to hash - key is category key
9708: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9709:
1.655 raeburn 9710: idx (reference to hash of counters used in Domain Coordinator interface for
9711: editing Course Categories).
1.663 raeburn 9712:
1.655 raeburn 9713: jsarray (reference to array of categories used to create Javascript arrays for
9714: Domain Coordinator interface for editing Course Categories).
9715:
1.665 raeburn 9716: subcats (reference to hash of arrays containing all subcategories within each
9717: category, -recursive)
9718:
1.655 raeburn 9719: Returns: nothing
9720:
9721: Side effects: populates trails and allitems hash references.
9722:
9723: =cut
9724:
9725: sub extract_categories {
1.665 raeburn 9726: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 9727: if (ref($categories) eq 'HASH') {
9728: &gather_categories($categories,$cats,$idx,$jsarray);
9729: if (ref($cats->[0]) eq 'ARRAY') {
9730: for (my $i=0; $i<@{$cats->[0]}; $i++) {
9731: my $name = $cats->[0][$i];
9732: my $item = &escape($name).'::0';
9733: my $trailstr;
9734: if ($name eq 'instcode') {
9735: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 9736: } elsif ($name eq 'communities') {
9737: $trailstr = &mt('Communities');
1.655 raeburn 9738: } else {
9739: $trailstr = $name;
9740: }
9741: if ($allitems->{$item} eq '') {
9742: push(@{$trails},$trailstr);
9743: $allitems->{$item} = scalar(@{$trails})-1;
9744: }
9745: my @parents = ($name);
9746: if (ref($cats->[1]{$name}) eq 'ARRAY') {
9747: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
9748: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 9749: if (ref($subcats) eq 'HASH') {
9750: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
9751: }
9752: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
9753: }
9754: } else {
9755: if (ref($subcats) eq 'HASH') {
9756: $subcats->{$item} = [];
1.655 raeburn 9757: }
9758: }
9759: }
9760: }
9761: }
9762: return;
9763: }
9764:
9765: =pod
9766:
9767: =item *&recurse_categories()
9768:
9769: Recursively used to generate breadcrumb trails for course categories.
9770:
9771: Inputs:
1.663 raeburn 9772:
1.655 raeburn 9773: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9774: categories and subcategories).
1.663 raeburn 9775:
1.655 raeburn 9776: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 9777:
9778: category (current course category, for which breadcrumb trail is being generated).
9779:
9780: trails (reference to array of breadcrumb trails for each category).
9781:
1.655 raeburn 9782: allitems (reference to hash - key is category key
9783: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9784:
1.655 raeburn 9785: parents (array containing containers directories for current category,
9786: back to top level).
9787:
9788: Returns: nothing
9789:
9790: Side effects: populates trails and allitems hash references
9791:
9792: =cut
9793:
9794: sub recurse_categories {
1.665 raeburn 9795: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 9796: my $shallower = $depth - 1;
9797: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
9798: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
9799: my $name = $cats->[$depth]{$category}[$k];
9800: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9801: my $trailstr = join(' -> ',(@{$parents},$category));
9802: if ($allitems->{$item} eq '') {
9803: push(@{$trails},$trailstr);
9804: $allitems->{$item} = scalar(@{$trails})-1;
9805: }
9806: my $deeper = $depth+1;
9807: push(@{$parents},$category);
1.665 raeburn 9808: if (ref($subcats) eq 'HASH') {
9809: my $subcat = &escape($name).':'.$category.':'.$depth;
9810: for (my $j=@{$parents}; $j>=0; $j--) {
9811: my $higher;
9812: if ($j > 0) {
9813: $higher = &escape($parents->[$j]).':'.
9814: &escape($parents->[$j-1]).':'.$j;
9815: } else {
9816: $higher = &escape($parents->[$j]).'::'.$j;
9817: }
9818: push(@{$subcats->{$higher}},$subcat);
9819: }
9820: }
9821: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
9822: $subcats);
1.655 raeburn 9823: pop(@{$parents});
9824: }
9825: } else {
9826: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9827: my $trailstr = join(' -> ',(@{$parents},$category));
9828: if ($allitems->{$item} eq '') {
9829: push(@{$trails},$trailstr);
9830: $allitems->{$item} = scalar(@{$trails})-1;
9831: }
9832: }
9833: return;
9834: }
9835:
1.663 raeburn 9836: =pod
9837:
9838: =item *&assign_categories_table()
9839:
9840: Create a datatable for display of hierarchical categories in a domain,
9841: with checkboxes to allow a course to be categorized.
9842:
9843: Inputs:
9844:
9845: cathash - reference to hash of categories defined for the domain (from
9846: configuration.db)
9847:
9848: currcat - scalar with an & separated list of categories assigned to a course.
9849:
1.919 raeburn 9850: type - scalar contains course type (Course or Community).
9851:
1.663 raeburn 9852: Returns: $output (markup to be displayed)
9853:
9854: =cut
9855:
9856: sub assign_categories_table {
1.919 raeburn 9857: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 9858: my $output;
9859: if (ref($cathash) eq 'HASH') {
9860: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
9861: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
9862: $maxdepth = scalar(@cats);
9863: if (@cats > 0) {
9864: my $itemcount = 0;
9865: if (ref($cats[0]) eq 'ARRAY') {
9866: my @currcategories;
9867: if ($currcat ne '') {
9868: @currcategories = split('&',$currcat);
9869: }
1.919 raeburn 9870: my $table;
1.663 raeburn 9871: for (my $i=0; $i<@{$cats[0]}; $i++) {
9872: my $parent = $cats[0][$i];
1.919 raeburn 9873: next if ($parent eq 'instcode');
9874: if ($type eq 'Community') {
9875: next unless ($parent eq 'communities');
9876: } else {
9877: next if ($parent eq 'communities');
9878: }
1.663 raeburn 9879: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9880: my $item = &escape($parent).'::0';
9881: my $checked = '';
9882: if (@currcategories > 0) {
9883: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 9884: $checked = ' checked="checked"';
1.663 raeburn 9885: }
9886: }
1.919 raeburn 9887: my $parent_title = $parent;
9888: if ($parent eq 'communities') {
9889: $parent_title = &mt('Communities');
9890: }
9891: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
9892: '<input type="checkbox" name="usecategory" value="'.
9893: $item.'"'.$checked.' />'.$parent_title.'</span>'.
9894: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 9895: my $depth = 1;
9896: push(@path,$parent);
1.919 raeburn 9897: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 9898: pop(@path);
1.919 raeburn 9899: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 9900: $itemcount ++;
9901: }
1.919 raeburn 9902: if ($itemcount) {
9903: $output = &Apache::loncommon::start_data_table().
9904: $table.
9905: &Apache::loncommon::end_data_table();
9906: }
1.663 raeburn 9907: }
9908: }
9909: }
9910: return $output;
9911: }
9912:
9913: =pod
9914:
9915: =item *&assign_category_rows()
9916:
9917: Create a datatable row for display of nested categories in a domain,
9918: with checkboxes to allow a course to be categorized,called recursively.
9919:
9920: Inputs:
9921:
9922: itemcount - track row number for alternating colors
9923:
9924: cats - reference to array of arrays/hashes which encapsulates hierarchy of
9925: categories and subcategories.
9926:
9927: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
9928:
9929: parent - parent of current category item
9930:
9931: path - Array containing all categories back up through the hierarchy from the
9932: current category to the top level.
9933:
9934: currcategories - reference to array of current categories assigned to the course
9935:
9936: Returns: $output (markup to be displayed).
9937:
9938: =cut
9939:
9940: sub assign_category_rows {
9941: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
9942: my ($text,$name,$item,$chgstr);
9943: if (ref($cats) eq 'ARRAY') {
9944: my $maxdepth = scalar(@{$cats});
9945: if (ref($cats->[$depth]) eq 'HASH') {
9946: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
9947: my $numchildren = @{$cats->[$depth]{$parent}};
9948: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9949: $text .= '<td><table class="LC_datatable">';
9950: for (my $j=0; $j<$numchildren; $j++) {
9951: $name = $cats->[$depth]{$parent}[$j];
9952: $item = &escape($name).':'.&escape($parent).':'.$depth;
9953: my $deeper = $depth+1;
9954: my $checked = '';
9955: if (ref($currcategories) eq 'ARRAY') {
9956: if (@{$currcategories} > 0) {
9957: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 9958: $checked = ' checked="checked"';
1.663 raeburn 9959: }
9960: }
9961: }
1.664 raeburn 9962: $text .= '<tr><td><span class="LC_nobreak"><label>'.
9963: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 9964: $item.'"'.$checked.' />'.$name.'</label></span>'.
9965: '<input type="hidden" name="catname" value="'.$name.'" />'.
9966: '</td><td>';
1.663 raeburn 9967: if (ref($path) eq 'ARRAY') {
9968: push(@{$path},$name);
9969: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
9970: pop(@{$path});
9971: }
9972: $text .= '</td></tr>';
9973: }
9974: $text .= '</table></td>';
9975: }
9976: }
9977: }
9978: return $text;
9979: }
9980:
1.655 raeburn 9981: ############################################################
9982: ############################################################
9983:
9984:
1.443 albertel 9985: sub commit_customrole {
1.664 raeburn 9986: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 9987: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 9988: ($start?', '.&mt('starting').' '.localtime($start):'').
9989: ($end?', ending '.localtime($end):'').': <b>'.
9990: &Apache::lonnet::assigncustomrole(
1.664 raeburn 9991: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 9992: '</b><br />';
9993: return $output;
9994: }
9995:
9996: sub commit_standardrole {
1.541 raeburn 9997: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
9998: my ($output,$logmsg,$linefeed);
9999: if ($context eq 'auto') {
10000: $linefeed = "\n";
10001: } else {
10002: $linefeed = "<br />\n";
10003: }
1.443 albertel 10004: if ($three eq 'st') {
1.541 raeburn 10005: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
10006: $one,$two,$sec,$context);
10007: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 10008: ($result eq 'unknown_course') || ($result eq 'refused')) {
10009: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 10010: } else {
1.541 raeburn 10011: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 10012: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 10013: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
10014: if ($context eq 'auto') {
10015: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
10016: } else {
10017: $output .= '<b>'.$result.'</b>'.$linefeed.
10018: &mt('Add to classlist').': <b>ok</b>';
10019: }
10020: $output .= $linefeed;
1.443 albertel 10021: }
10022: } else {
10023: $output = &mt('Assigning').' '.$three.' in '.$url.
10024: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 10025: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 10026: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 10027: if ($context eq 'auto') {
10028: $output .= $result.$linefeed;
10029: } else {
10030: $output .= '<b>'.$result.'</b>'.$linefeed;
10031: }
1.443 albertel 10032: }
10033: return $output;
10034: }
10035:
10036: sub commit_studentrole {
1.541 raeburn 10037: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 10038: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 10039: if ($context eq 'auto') {
10040: $linefeed = "\n";
10041: } else {
10042: $linefeed = '<br />'."\n";
10043: }
1.443 albertel 10044: if (defined($one) && defined($two)) {
10045: my $cid=$one.'_'.$two;
10046: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
10047: my $secchange = 0;
10048: my $expire_role_result;
10049: my $modify_section_result;
1.628 raeburn 10050: if ($oldsec ne '-1') {
10051: if ($oldsec ne $sec) {
1.443 albertel 10052: $secchange = 1;
1.628 raeburn 10053: my $now = time;
1.443 albertel 10054: my $uurl='/'.$cid;
10055: $uurl=~s/\_/\//g;
10056: if ($oldsec) {
10057: $uurl.='/'.$oldsec;
10058: }
1.626 raeburn 10059: $oldsecurl = $uurl;
1.628 raeburn 10060: $expire_role_result =
1.652 raeburn 10061: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 10062: if ($env{'request.course.sec'} ne '') {
10063: if ($expire_role_result eq 'refused') {
10064: my @roles = ('st');
10065: my @statuses = ('previous');
10066: my @roledoms = ($one);
10067: my $withsec = 1;
10068: my %roleshash =
10069: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
10070: \@statuses,\@roles,\@roledoms,$withsec);
10071: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
10072: my ($oldstart,$oldend) =
10073: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
10074: if ($oldend > 0 && $oldend <= $now) {
10075: $expire_role_result = 'ok';
10076: }
10077: }
10078: }
10079: }
1.443 albertel 10080: $result = $expire_role_result;
10081: }
10082: }
10083: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 10084: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 10085: if ($modify_section_result =~ /^ok/) {
10086: if ($secchange == 1) {
1.628 raeburn 10087: if ($sec eq '') {
10088: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
10089: } else {
10090: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
10091: }
1.443 albertel 10092: } elsif ($oldsec eq '-1') {
1.628 raeburn 10093: if ($sec eq '') {
10094: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
10095: } else {
10096: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
10097: }
1.443 albertel 10098: } else {
1.628 raeburn 10099: if ($sec eq '') {
10100: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
10101: } else {
10102: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
10103: }
1.443 albertel 10104: }
10105: } else {
1.628 raeburn 10106: if ($secchange) {
10107: $$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;
10108: } else {
10109: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
10110: }
1.443 albertel 10111: }
10112: $result = $modify_section_result;
10113: } elsif ($secchange == 1) {
1.628 raeburn 10114: if ($oldsec eq '') {
10115: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
10116: } else {
10117: $$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;
10118: }
1.626 raeburn 10119: if ($expire_role_result eq 'refused') {
10120: my $newsecurl = '/'.$cid;
10121: $newsecurl =~ s/\_/\//g;
10122: if ($sec ne '') {
10123: $newsecurl.='/'.$sec;
10124: }
10125: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
10126: if ($sec eq '') {
10127: $$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;
10128: } else {
10129: $$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;
10130: }
10131: }
10132: }
1.443 albertel 10133: }
10134: } else {
1.626 raeburn 10135: $$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 10136: $result = "error: incomplete course id\n";
10137: }
10138: return $result;
10139: }
10140:
10141: ############################################################
10142: ############################################################
10143:
1.566 albertel 10144: sub check_clone {
1.578 raeburn 10145: my ($args,$linefeed) = @_;
1.566 albertel 10146: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
10147: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
10148: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
10149: my $clonemsg;
10150: my $can_clone = 0;
1.944 raeburn 10151: my $lctype = lc($args->{'crstype'});
1.908 raeburn 10152: if ($lctype ne 'community') {
10153: $lctype = 'course';
10154: }
1.566 albertel 10155: if ($clonehome eq 'no_host') {
1.944 raeburn 10156: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10157: $clonemsg = &mt('No new community created.').$linefeed.&mt('A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
10158: } else {
10159: $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'});
10160: }
1.566 albertel 10161: } else {
10162: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944 raeburn 10163: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10164: if ($clonedesc{'type'} ne 'Community') {
10165: $clonemsg = &mt('No new community created.').$linefeed.&mt('A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
10166: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10167: }
10168: }
1.882 raeburn 10169: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
10170: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 10171: $can_clone = 1;
10172: } else {
10173: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
10174: $args->{'clonedomain'},$args->{'clonecourse'});
10175: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 10176: if (grep(/^\*$/,@cloners)) {
10177: $can_clone = 1;
10178: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
10179: $can_clone = 1;
10180: } else {
1.908 raeburn 10181: my $ccrole = 'cc';
1.944 raeburn 10182: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10183: $ccrole = 'co';
10184: }
1.578 raeburn 10185: my %roleshash =
10186: &Apache::lonnet::get_my_roles($args->{'ccuname'},
10187: $args->{'ccdomain'},
1.908 raeburn 10188: 'userroles',['active'],[$ccrole],
1.578 raeburn 10189: [$args->{'clonedomain'}]);
1.908 raeburn 10190: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942 raeburn 10191: $can_clone = 1;
10192: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
10193: $can_clone = 1;
10194: } else {
1.944 raeburn 10195: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10196: $clonemsg = &mt('No new community created.').$linefeed.&mt('The new community could not be cloned from the existing community because the new community owner ([_1]) does not have cloning rights in the existing community ([_2]).',$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'});
10197: } else {
10198: $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'});
10199: }
1.578 raeburn 10200: }
1.566 albertel 10201: }
1.578 raeburn 10202: }
1.566 albertel 10203: }
10204: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10205: }
10206:
1.444 albertel 10207: sub construct_course {
1.885 raeburn 10208: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444 albertel 10209: my $outcome;
1.541 raeburn 10210: my $linefeed = '<br />'."\n";
10211: if ($context eq 'auto') {
10212: $linefeed = "\n";
10213: }
1.566 albertel 10214:
10215: #
10216: # Are we cloning?
10217: #
10218: my ($can_clone, $clonemsg, $cloneid, $clonehome);
10219: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 10220: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 10221: if ($context ne 'auto') {
1.578 raeburn 10222: if ($clonemsg ne '') {
10223: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
10224: }
1.566 albertel 10225: }
10226: $outcome .= $clonemsg.$linefeed;
10227:
10228: if (!$can_clone) {
10229: return (0,$outcome);
10230: }
10231: }
10232:
1.444 albertel 10233: #
10234: # Open course
10235: #
10236: my $crstype = lc($args->{'crstype'});
10237: my %cenv=();
10238: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
10239: $args->{'cdescr'},
10240: $args->{'curl'},
10241: $args->{'course_home'},
10242: $args->{'nonstandard'},
10243: $args->{'crscode'},
10244: $args->{'ccuname'}.':'.
10245: $args->{'ccdomain'},
1.882 raeburn 10246: $args->{'crstype'},
1.885 raeburn 10247: $cnum,$context,$category);
1.444 albertel 10248:
10249: # Note: The testing routines depend on this being output; see
10250: # Utils::Course. This needs to at least be output as a comment
10251: # if anyone ever decides to not show this, and Utils::Course::new
10252: # will need to be suitably modified.
1.541 raeburn 10253: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943 raeburn 10254: if ($$courseid =~ /^error:/) {
10255: return (0,$outcome);
10256: }
10257:
1.444 albertel 10258: #
10259: # Check if created correctly
10260: #
1.479 albertel 10261: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 10262: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 10263: if ($crsuhome eq 'no_host') {
10264: $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
10265: return (0,$outcome);
10266: }
1.541 raeburn 10267: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 10268:
1.444 albertel 10269: #
1.566 albertel 10270: # Do the cloning
10271: #
10272: if ($can_clone && $cloneid) {
10273: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
10274: if ($context ne 'auto') {
10275: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
10276: }
10277: $outcome .= $clonemsg.$linefeed;
10278: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 10279: # Copy all files
1.637 www 10280: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 10281: # Restore URL
1.566 albertel 10282: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 10283: # Restore title
1.566 albertel 10284: $cenv{'description'}=$oldcenv{'description'};
1.948.2.2! raeburn 10285: # Restore creation date, creator and creation context.
! 10286: $cenv{'internal.created'}=$oldcenv{'internal.created'};
! 10287: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
! 10288: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 10289: # Mark as cloned
1.566 albertel 10290: $cenv{'clonedfrom'}=$cloneid;
1.638 www 10291: # Need to clone grading mode
10292: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
10293: $cenv{'grading'}=$newenv{'grading'};
10294: # Do not clone these environment entries
10295: &Apache::lonnet::del('environment',
10296: ['default_enrollment_start_date',
10297: 'default_enrollment_end_date',
10298: 'question.email',
10299: 'policy.email',
10300: 'comment.email',
10301: 'pch.users.denied',
1.725 raeburn 10302: 'plc.users.denied',
10303: 'hidefromcat',
10304: 'categories'],
1.638 www 10305: $$crsudom,$$crsunum);
1.444 albertel 10306: }
1.566 albertel 10307:
1.444 albertel 10308: #
10309: # Set environment (will override cloned, if existing)
10310: #
10311: my @sections = ();
10312: my @xlists = ();
10313: if ($args->{'crstype'}) {
10314: $cenv{'type'}=$args->{'crstype'};
10315: }
10316: if ($args->{'crsid'}) {
10317: $cenv{'courseid'}=$args->{'crsid'};
10318: }
10319: if ($args->{'crscode'}) {
10320: $cenv{'internal.coursecode'}=$args->{'crscode'};
10321: }
10322: if ($args->{'crsquota'} ne '') {
10323: $cenv{'internal.coursequota'}=$args->{'crsquota'};
10324: } else {
10325: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
10326: }
10327: if ($args->{'ccuname'}) {
10328: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
10329: ':'.$args->{'ccdomain'};
10330: } else {
10331: $cenv{'internal.courseowner'} = $args->{'curruser'};
10332: }
10333: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
10334: if ($args->{'crssections'}) {
10335: $cenv{'internal.sectionnums'} = '';
10336: if ($args->{'crssections'} =~ m/,/) {
10337: @sections = split/,/,$args->{'crssections'};
10338: } else {
10339: $sections[0] = $args->{'crssections'};
10340: }
10341: if (@sections > 0) {
10342: foreach my $item (@sections) {
10343: my ($sec,$gp) = split/:/,$item;
10344: my $class = $args->{'crscode'}.$sec;
10345: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
10346: $cenv{'internal.sectionnums'} .= $item.',';
10347: unless ($addcheck eq 'ok') {
10348: push @badclasses, $class;
10349: }
10350: }
10351: $cenv{'internal.sectionnums'} =~ s/,$//;
10352: }
10353: }
10354: # do not hide course coordinator from staff listing,
10355: # even if privileged
10356: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10357: # add crosslistings
10358: if ($args->{'crsxlist'}) {
10359: $cenv{'internal.crosslistings'}='';
10360: if ($args->{'crsxlist'} =~ m/,/) {
10361: @xlists = split/,/,$args->{'crsxlist'};
10362: } else {
10363: $xlists[0] = $args->{'crsxlist'};
10364: }
10365: if (@xlists > 0) {
10366: foreach my $item (@xlists) {
10367: my ($xl,$gp) = split/:/,$item;
10368: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
10369: $cenv{'internal.crosslistings'} .= $item.',';
10370: unless ($addcheck eq 'ok') {
10371: push @badclasses, $xl;
10372: }
10373: }
10374: $cenv{'internal.crosslistings'} =~ s/,$//;
10375: }
10376: }
10377: if ($args->{'autoadds'}) {
10378: $cenv{'internal.autoadds'}=$args->{'autoadds'};
10379: }
10380: if ($args->{'autodrops'}) {
10381: $cenv{'internal.autodrops'}=$args->{'autodrops'};
10382: }
10383: # check for notification of enrollment changes
10384: my @notified = ();
10385: if ($args->{'notify_owner'}) {
10386: if ($args->{'ccuname'} ne '') {
10387: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
10388: }
10389: }
10390: if ($args->{'notify_dc'}) {
10391: if ($uname ne '') {
1.630 raeburn 10392: push(@notified,$uname.':'.$udom);
1.444 albertel 10393: }
10394: }
10395: if (@notified > 0) {
10396: my $notifylist;
10397: if (@notified > 1) {
10398: $notifylist = join(',',@notified);
10399: } else {
10400: $notifylist = $notified[0];
10401: }
10402: $cenv{'internal.notifylist'} = $notifylist;
10403: }
10404: if (@badclasses > 0) {
10405: my %lt=&Apache::lonlocal::texthash(
10406: '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',
10407: 'dnhr' => 'does not have rights to access enrollment in these classes',
10408: 'adby' => 'as determined by the policies of your institution on access to official classlists'
10409: );
1.541 raeburn 10410: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
10411: ' ('.$lt{'adby'}.')';
10412: if ($context eq 'auto') {
10413: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 10414: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 10415: foreach my $item (@badclasses) {
10416: if ($context eq 'auto') {
10417: $outcome .= " - $item\n";
10418: } else {
10419: $outcome .= "<li>$item</li>\n";
10420: }
10421: }
10422: if ($context eq 'auto') {
10423: $outcome .= $linefeed;
10424: } else {
1.566 albertel 10425: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 10426: }
10427: }
1.444 albertel 10428: }
10429: if ($args->{'no_end_date'}) {
10430: $args->{'endaccess'} = 0;
10431: }
10432: $cenv{'internal.autostart'}=$args->{'enrollstart'};
10433: $cenv{'internal.autoend'}=$args->{'enrollend'};
10434: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
10435: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
10436: if ($args->{'showphotos'}) {
10437: $cenv{'internal.showphotos'}=$args->{'showphotos'};
10438: }
10439: $cenv{'internal.authtype'} = $args->{'authtype'};
10440: $cenv{'internal.autharg'} = $args->{'autharg'};
10441: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
10442: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 10443: 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');
10444: if ($context eq 'auto') {
10445: $outcome .= $krb_msg;
10446: } else {
1.566 albertel 10447: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 10448: }
10449: $outcome .= $linefeed;
1.444 albertel 10450: }
10451: }
10452: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
10453: if ($args->{'setpolicy'}) {
10454: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10455: }
10456: if ($args->{'setcontent'}) {
10457: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10458: }
10459: }
10460: if ($args->{'reshome'}) {
10461: $cenv{'reshome'}=$args->{'reshome'}.'/';
10462: $cenv{'reshome'}=~s/\/+$/\//;
10463: }
10464: #
10465: # course has keyed access
10466: #
10467: if ($args->{'setkeys'}) {
10468: $cenv{'keyaccess'}='yes';
10469: }
10470: # if specified, key authority is not course, but user
10471: # only active if keyaccess is yes
10472: if ($args->{'keyauth'}) {
1.487 albertel 10473: my ($user,$domain) = split(':',$args->{'keyauth'});
10474: $user = &LONCAPA::clean_username($user);
10475: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 10476: if ($user ne '' && $domain ne '') {
1.487 albertel 10477: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 10478: }
10479: }
10480:
10481: if ($args->{'disresdis'}) {
10482: $cenv{'pch.roles.denied'}='st';
10483: }
10484: if ($args->{'disablechat'}) {
10485: $cenv{'plc.roles.denied'}='st';
10486: }
10487:
10488: # Record we've not yet viewed the Course Initialization Helper for this
10489: # course
10490: $cenv{'course.helper.not.run'} = 1;
10491: #
10492: # Use new Randomseed
10493: #
10494: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
10495: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
10496: #
10497: # The encryption code and receipt prefix for this course
10498: #
10499: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
10500: $cenv{'internal.encpref'}=100+int(9*rand(99));
10501: #
10502: # By default, use standard grading
10503: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
10504:
1.541 raeburn 10505: $outcome .= $linefeed.&mt('Setting environment').': '.
10506: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10507: #
10508: # Open all assignments
10509: #
10510: if ($args->{'openall'}) {
10511: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
10512: my %storecontent = ($storeunder => time,
10513: $storeunder.'.type' => 'date_start');
10514:
10515: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 10516: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10517: }
10518: #
10519: # Set first page
10520: #
10521: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
10522: || ($cloneid)) {
1.445 albertel 10523: use LONCAPA::map;
1.444 albertel 10524: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 10525:
10526: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
10527: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
10528:
1.444 albertel 10529: $outcome .= ($fatal?$errtext:'read ok').' - ';
10530: my $title; my $url;
10531: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 10532: $title=&mt('Syllabus');
1.444 albertel 10533: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
10534: } else {
1.690 bisitz 10535: $title=&mt('Navigate Contents');
1.444 albertel 10536: $url='/adm/navmaps';
10537: }
1.445 albertel 10538:
10539: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
10540: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
10541:
10542: if ($errtext) { $fatal=2; }
1.541 raeburn 10543: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 10544: }
1.566 albertel 10545:
10546: return (1,$outcome);
1.444 albertel 10547: }
10548:
10549: ############################################################
10550: ############################################################
10551:
1.378 raeburn 10552: sub course_type {
10553: my ($cid) = @_;
10554: if (!defined($cid)) {
10555: $cid = $env{'request.course.id'};
10556: }
1.404 albertel 10557: if (defined($env{'course.'.$cid.'.type'})) {
10558: return $env{'course.'.$cid.'.type'};
1.378 raeburn 10559: } else {
10560: return 'Course';
1.377 raeburn 10561: }
10562: }
1.156 albertel 10563:
1.406 raeburn 10564: sub group_term {
10565: my $crstype = &course_type();
10566: my %names = (
10567: 'Course' => 'group',
1.865 raeburn 10568: 'Community' => 'group',
1.406 raeburn 10569: );
10570: return $names{$crstype};
10571: }
10572:
1.902 raeburn 10573: sub course_types {
10574: my @types = ('official','unofficial','community');
10575: my %typename = (
10576: official => 'Official course',
10577: unofficial => 'Unofficial course',
10578: community => 'Community',
10579: );
10580: return (\@types,\%typename);
10581: }
10582:
1.156 albertel 10583: sub icon {
10584: my ($file)=@_;
1.505 albertel 10585: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 10586: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 10587: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 10588: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
10589: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
10590: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10591: $curfext.".gif") {
10592: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10593: $curfext.".gif";
10594: }
10595: }
1.249 albertel 10596: return &lonhttpdurl($iconname);
1.154 albertel 10597: }
1.84 albertel 10598:
1.575 albertel 10599: sub lonhttpdurl {
1.692 www 10600: #
10601: # Had been used for "small fry" static images on separate port 8080.
10602: # Modify here if lightweight http functionality desired again.
10603: # Currently eliminated due to increasing firewall issues.
10604: #
1.575 albertel 10605: my ($url)=@_;
1.692 www 10606: return $url;
1.215 albertel 10607: }
10608:
1.213 albertel 10609: sub connection_aborted {
10610: my ($r)=@_;
10611: $r->print(" ");$r->rflush();
10612: my $c = $r->connection;
10613: return $c->aborted();
10614: }
10615:
1.221 foxr 10616: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 10617: # strings as 'strings'.
10618: sub escape_single {
1.221 foxr 10619: my ($input) = @_;
1.223 albertel 10620: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 10621: $input =~ s/\'/\\\'/g; # Esacpe the 's....
10622: return $input;
10623: }
1.223 albertel 10624:
1.222 foxr 10625: # Same as escape_single, but escape's "'s This
10626: # can be used for "strings"
10627: sub escape_double {
10628: my ($input) = @_;
10629: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
10630: $input =~ s/\"/\\\"/g; # Esacpe the "s....
10631: return $input;
10632: }
1.223 albertel 10633:
1.222 foxr 10634: # Escapes the last element of a full URL.
10635: sub escape_url {
10636: my ($url) = @_;
1.238 raeburn 10637: my @urlslices = split(/\//, $url,-1);
1.369 www 10638: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 10639: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 10640: }
1.462 albertel 10641:
1.820 raeburn 10642: sub compare_arrays {
10643: my ($arrayref1,$arrayref2) = @_;
10644: my (@difference,%count);
10645: @difference = ();
10646: %count = ();
10647: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
10648: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
10649: foreach my $element (keys(%count)) {
10650: if ($count{$element} == 1) {
10651: push(@difference,$element);
10652: }
10653: }
10654: }
10655: return @difference;
10656: }
10657:
1.817 bisitz 10658: # -------------------------------------------------------- Initialize user login
1.462 albertel 10659: sub init_user_environment {
1.463 albertel 10660: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 10661: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
10662:
10663: my $public=($username eq 'public' && $domain eq 'public');
10664:
10665: # See if old ID present, if so, remove
10666:
10667: my ($filename,$cookie,$userroles);
10668: my $now=time;
10669:
10670: if ($public) {
10671: my $max_public=100;
10672: my $oldest;
10673: my $oldest_time=0;
10674: for(my $next=1;$next<=$max_public;$next++) {
10675: if (-e $lonids."/publicuser_$next.id") {
10676: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
10677: if ($mtime<$oldest_time || !$oldest_time) {
10678: $oldest_time=$mtime;
10679: $oldest=$next;
10680: }
10681: } else {
10682: $cookie="publicuser_$next";
10683: last;
10684: }
10685: }
10686: if (!$cookie) { $cookie="publicuser_$oldest"; }
10687: } else {
1.463 albertel 10688: # if this isn't a robot, kill any existing non-robot sessions
10689: if (!$args->{'robot'}) {
10690: opendir(DIR,$lonids);
10691: while ($filename=readdir(DIR)) {
10692: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
10693: unlink($lonids.'/'.$filename);
10694: }
1.462 albertel 10695: }
1.463 albertel 10696: closedir(DIR);
1.462 albertel 10697: }
10698: # Give them a new cookie
1.463 albertel 10699: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 10700: : $now.$$.int(rand(10000)));
1.463 albertel 10701: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 10702:
10703: # Initialize roles
10704:
10705: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
10706: }
10707: # ------------------------------------ Check browser type and MathML capability
10708:
10709: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
10710: $clientunicode,$clientos) = &decode_user_agent($r);
10711:
10712: # ------------------------------------------------------------- Get environment
10713:
10714: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
10715: my ($tmp) = keys(%userenv);
10716: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
10717: # default remote control to off
10718: if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
10719: } else {
10720: undef(%userenv);
10721: }
10722: if (($userenv{'interface'}) && (!$form->{'interface'})) {
10723: $form->{'interface'}=$userenv{'interface'};
10724: }
10725: $env{'environment.remote'}=$userenv{'remote'};
10726: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
10727:
10728: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 10729: foreach my $option ('interface','localpath','localres') {
10730: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 10731: }
10732: # --------------------------------------------------------- Write first profile
10733:
10734: {
10735: my %initial_env =
10736: ("user.name" => $username,
10737: "user.domain" => $domain,
10738: "user.home" => $authhost,
10739: "browser.type" => $clientbrowser,
10740: "browser.version" => $clientversion,
10741: "browser.mathml" => $clientmathml,
10742: "browser.unicode" => $clientunicode,
10743: "browser.os" => $clientos,
10744: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
10745: "request.course.fn" => '',
10746: "request.course.uri" => '',
10747: "request.course.sec" => '',
10748: "request.role" => 'cm',
10749: "request.role.adv" => $env{'user.adv'},
10750: "request.host" => $ENV{'REMOTE_ADDR'},);
10751:
10752: if ($form->{'localpath'}) {
10753: $initial_env{"browser.localpath"} = $form->{'localpath'};
10754: $initial_env{"browser.localres"} = $form->{'localres'};
10755: }
10756:
10757: if ($public) {
10758: $initial_env{"environment.remote"} = "off";
10759: }
10760: if ($form->{'interface'}) {
10761: $form->{'interface'}=~s/\W//gs;
10762: $initial_env{"browser.interface"} = $form->{'interface'};
10763: $env{'browser.interface'}=$form->{'interface'};
10764: }
10765:
1.724 raeburn 10766: foreach my $tool ('aboutme','blog','portfolio') {
10767: $userenv{'availabletools.'.$tool} =
10768: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
10769: }
10770:
1.864 raeburn 10771: foreach my $crstype ('official','unofficial','community') {
1.765 raeburn 10772: $userenv{'canrequest.'.$crstype} =
10773: &Apache::lonnet::usertools_access($username,$domain,$crstype,
10774: 'reload','requestcourses');
10775: }
10776:
1.462 albertel 10777: $env{'user.environment'} = "$lonids/$cookie.id";
10778:
10779: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
10780: &GDBM_WRCREAT(),0640)) {
10781: &_add_to_env(\%disk_env,\%initial_env);
10782: &_add_to_env(\%disk_env,\%userenv,'environment.');
10783: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 10784: if (ref($args->{'extra_env'})) {
10785: &_add_to_env(\%disk_env,$args->{'extra_env'});
10786: }
1.462 albertel 10787: untie(%disk_env);
10788: } else {
1.705 tempelho 10789: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
10790: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 10791: return 'error: '.$!;
10792: }
10793: }
10794: $env{'request.role'}='cm';
10795: $env{'request.role.adv'}=$env{'user.adv'};
10796: $env{'browser.type'}=$clientbrowser;
10797:
10798: return $cookie;
10799:
10800: }
10801:
10802: sub _add_to_env {
10803: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 10804: if (ref($env_data) eq 'HASH') {
10805: while (my ($key,$value) = each(%$env_data)) {
10806: $idf->{$prefix.$key} = $value;
10807: $env{$prefix.$key} = $value;
10808: }
1.462 albertel 10809: }
10810: }
10811:
1.685 tempelho 10812: # --- Get the symbolic name of a problem and the url
10813: sub get_symb {
10814: my ($request,$silent) = @_;
1.726 raeburn 10815: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 10816: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
10817: if ($symb eq '') {
10818: if (!$silent) {
10819: $request->print("Unable to handle ambiguous references:$url:.");
10820: return ();
10821: }
10822: }
10823: &Apache::lonenc::check_decrypt(\$symb);
10824: return ($symb);
10825: }
10826:
10827: # --------------------------------------------------------------Get annotation
10828:
10829: sub get_annotation {
10830: my ($symb,$enc) = @_;
10831:
10832: my $key = $symb;
10833: if (!$enc) {
10834: $key =
10835: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
10836: }
10837: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
10838: return $annotation{$key};
10839: }
10840:
10841: sub clean_symb {
1.731 raeburn 10842: my ($symb,$delete_enc) = @_;
1.685 tempelho 10843:
10844: &Apache::lonenc::check_decrypt(\$symb);
10845: my $enc = $env{'request.enc'};
1.731 raeburn 10846: if ($delete_enc) {
1.730 raeburn 10847: delete($env{'request.enc'});
10848: }
1.685 tempelho 10849:
10850: return ($symb,$enc);
10851: }
1.462 albertel 10852:
1.41 ng 10853: =pod
10854:
10855: =back
10856:
1.112 bowersj2 10857: =cut
1.41 ng 10858:
1.112 bowersj2 10859: 1;
10860: __END__;
1.41 ng 10861:
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