Annotation of loncom/interface/loncommon.pm, revision 1.948.2.5
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.5! raeburn 4: # $Id: loncommon.pm,v 1.948.2.4 2010/05/18 01:24:42 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.948.2.4 raeburn 3704: if ($target) { $target=" target=\"$target\""; }
3705: return
3706: '<a href="/adm/grades?command=submission'.
3707: '&symb='.$symb.
3708: '&student='.$uname.
3709: '&userdom='.$udom.'"'.
3710: $target.'>'.$text.'</a>';
1.242 albertel 3711: }
3712: ##############################################
3713:
3714: =pod
3715:
3716: =item * &pgrdlink()
3717:
3718: Inputs: $text $uname $udom $symb $target
3719:
3720: Returns: A link to grades.pm such as to see the PGRD view of a student
3721:
3722: =cut
3723:
3724: ###############################################
3725: sub pgrdlink {
3726: my $link=&submlink(@_);
3727: $link=~s/(&command=submission)/$1&showgrading=yes/;
3728: return $link;
3729: }
3730: ##############################################
3731:
3732: =pod
3733:
3734: =item * &pprmlink()
3735:
3736: Inputs: $text $uname $udom $symb $target
3737:
3738: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3739: student and a specific resource
1.242 albertel 3740:
3741: =cut
3742:
3743: ###############################################
3744: sub pprmlink {
3745: my ($text,$uname,$udom,$symb,$target)=@_;
3746: if (!($uname && $udom)) {
3747: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3748: &Apache::lonnet::whichuser($symb);
1.242 albertel 3749: if (!$symb) { $symb=$cursymb; }
3750: }
1.254 matthew 3751: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3752: $symb=&escape($symb);
1.242 albertel 3753: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3754: return '<a href="/adm/parmset?command=set&'.
3755: 'symb='.$symb.'&uname='.$uname.
3756: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3757: }
3758: ##############################################
1.37 matthew 3759:
1.112 bowersj2 3760: =pod
3761:
3762: =back
3763:
3764: =cut
3765:
1.37 matthew 3766: ###############################################
1.51 www 3767:
3768:
3769: sub timehash {
1.687 raeburn 3770: my ($thistime) = @_;
3771: my $timezone = &Apache::lonlocal::gettimezone();
3772: my $dt = DateTime->from_epoch(epoch => $thistime)
3773: ->set_time_zone($timezone);
3774: my $wday = $dt->day_of_week();
3775: if ($wday == 7) { $wday = 0; }
3776: return ( 'second' => $dt->second(),
3777: 'minute' => $dt->minute(),
3778: 'hour' => $dt->hour(),
3779: 'day' => $dt->day_of_month(),
3780: 'month' => $dt->month(),
3781: 'year' => $dt->year(),
3782: 'weekday' => $wday,
3783: 'dayyear' => $dt->day_of_year(),
3784: 'dlsav' => $dt->is_dst() );
1.51 www 3785: }
3786:
1.370 www 3787: sub utc_string {
3788: my ($date)=@_;
1.371 www 3789: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3790: }
3791:
1.51 www 3792: sub maketime {
3793: my %th=@_;
1.687 raeburn 3794: my ($epoch_time,$timezone,$dt);
3795: $timezone = &Apache::lonlocal::gettimezone();
3796: eval {
3797: $dt = DateTime->new( year => $th{'year'},
3798: month => $th{'month'},
3799: day => $th{'day'},
3800: hour => $th{'hour'},
3801: minute => $th{'minute'},
3802: second => $th{'second'},
3803: time_zone => $timezone,
3804: );
3805: };
3806: if (!$@) {
3807: $epoch_time = $dt->epoch;
3808: if ($epoch_time) {
3809: return $epoch_time;
3810: }
3811: }
1.51 www 3812: return POSIX::mktime(
3813: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3814: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3815: }
3816:
3817: #########################################
1.51 www 3818:
3819: sub findallcourses {
1.482 raeburn 3820: my ($roles,$uname,$udom) = @_;
1.355 albertel 3821: my %roles;
3822: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3823: my %courses;
1.51 www 3824: my $now=time;
1.482 raeburn 3825: if (!defined($uname)) {
3826: $uname = $env{'user.name'};
3827: }
3828: if (!defined($udom)) {
3829: $udom = $env{'user.domain'};
3830: }
3831: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
3832: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
3833: if (!%roles) {
3834: %roles = (
3835: cc => 1,
1.907 raeburn 3836: co => 1,
1.482 raeburn 3837: in => 1,
3838: ep => 1,
3839: ta => 1,
3840: cr => 1,
3841: st => 1,
3842: );
3843: }
3844: foreach my $entry (keys(%roleshash)) {
3845: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3846: if ($trole =~ /^cr/) {
3847: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3848: } else {
3849: next if (!exists($roles{$trole}));
3850: }
3851: if ($tend) {
3852: next if ($tend < $now);
3853: }
3854: if ($tstart) {
3855: next if ($tstart > $now);
3856: }
3857: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3858: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3859: if ($secpart eq '') {
3860: ($cnum,$role) = split(/_/,$cnumpart);
3861: $sec = 'none';
3862: $realsec = '';
3863: } else {
3864: $cnum = $cnumpart;
3865: ($sec,$role) = split(/_/,$secpart);
3866: $realsec = $sec;
1.490 raeburn 3867: }
1.482 raeburn 3868: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3869: }
3870: } else {
3871: foreach my $key (keys(%env)) {
1.483 albertel 3872: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3873: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3874: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3875: next if ($role eq 'ca' || $role eq 'aa');
3876: next if (%roles && !exists($roles{$role}));
3877: my ($starttime,$endtime)=split(/\./,$env{$key});
3878: my $active=1;
3879: if ($starttime) {
3880: if ($now<$starttime) { $active=0; }
3881: }
3882: if ($endtime) {
3883: if ($now>$endtime) { $active=0; }
3884: }
3885: if ($active) {
3886: if ($sec eq '') {
3887: $sec = 'none';
3888: }
3889: $courses{$cdom.'_'.$cnum}{$sec} =
3890: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 3891: }
3892: }
1.51 www 3893: }
3894: }
1.474 raeburn 3895: return %courses;
1.51 www 3896: }
1.37 matthew 3897:
1.54 www 3898: ###############################################
1.474 raeburn 3899:
3900: sub blockcheck {
1.482 raeburn 3901: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 3902:
3903: if (!defined($udom)) {
3904: $udom = $env{'user.domain'};
3905: }
3906: if (!defined($uname)) {
3907: $uname = $env{'user.name'};
3908: }
3909:
3910: # If uname and udom are for a course, check for blocks in the course.
3911:
3912: if (&Apache::lonnet::is_course($udom,$uname)) {
3913: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 3914: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 3915: return ($startblock,$endblock);
3916: }
1.474 raeburn 3917:
1.502 raeburn 3918: my $startblock = 0;
3919: my $endblock = 0;
1.482 raeburn 3920: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 3921:
1.490 raeburn 3922: # If uname is for a user, and activity is course-specific, i.e.,
3923: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3924:
1.490 raeburn 3925: if (($activity eq 'boards' || $activity eq 'chat' ||
3926: $activity eq 'groups') && ($env{'request.course.id'})) {
3927: foreach my $key (keys(%live_courses)) {
3928: if ($key ne $env{'request.course.id'}) {
3929: delete($live_courses{$key});
3930: }
3931: }
3932: }
3933:
3934: my $otheruser = 0;
3935: my %own_courses;
3936: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3937: # Resource belongs to user other than current user.
3938: $otheruser = 1;
3939: # Gather courses for current user
3940: %own_courses =
3941: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3942: }
3943:
3944: # Gather active course roles - course coordinator, instructor,
3945: # exam proctor, ta, student, or custom role.
1.474 raeburn 3946:
3947: foreach my $course (keys(%live_courses)) {
1.482 raeburn 3948: my ($cdom,$cnum);
3949: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3950: $cdom = $env{'course.'.$course.'.domain'};
3951: $cnum = $env{'course.'.$course.'.num'};
3952: } else {
1.490 raeburn 3953: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 3954: }
3955: my $no_ownblock = 0;
3956: my $no_userblock = 0;
1.533 raeburn 3957: if ($otheruser && $activity ne 'com') {
1.490 raeburn 3958: # Check if current user has 'evb' priv for this
3959: if (defined($own_courses{$course})) {
3960: foreach my $sec (keys(%{$own_courses{$course}})) {
3961: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3962: if ($sec ne 'none') {
3963: $checkrole .= '/'.$sec;
3964: }
3965: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3966: $no_ownblock = 1;
3967: last;
3968: }
3969: }
3970: }
3971: # if they have 'evb' priv and are currently not playing student
3972: next if (($no_ownblock) &&
3973: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
3974: }
1.474 raeburn 3975: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 3976: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 3977: if ($sec ne 'none') {
1.482 raeburn 3978: $checkrole .= '/'.$sec;
1.474 raeburn 3979: }
1.490 raeburn 3980: if ($otheruser) {
3981: # Resource belongs to user other than current user.
3982: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 3983: my ($trole,$tdom,$tnum,$tsec);
3984: my $entry = $live_courses{$course}{$sec};
3985: if ($entry =~ /^cr/) {
3986: ($trole,$tdom,$tnum,$tsec) =
3987: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
3988: } else {
3989: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
3990: }
3991: my ($spec,$area,$trest,%allroles,%userroles);
3992: $area = '/'.$tdom.'/'.$tnum;
3993: $trest = $tnum;
3994: if ($tsec ne '') {
3995: $area .= '/'.$tsec;
3996: $trest .= '/'.$tsec;
3997: }
3998: $spec = $trole.'.'.$area;
3999: if ($trole =~ /^cr/) {
4000: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
4001: $tdom,$spec,$trest,$area);
4002: } else {
4003: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
4004: $tdom,$spec,$trest,$area);
4005: }
4006: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 4007: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
4008: if ($1) {
4009: $no_userblock = 1;
4010: last;
4011: }
4012: }
1.490 raeburn 4013: } else {
4014: # Resource belongs to current user
4015: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 4016: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4017: $no_ownblock = 1;
4018: last;
4019: }
1.474 raeburn 4020: }
4021: }
4022: # if they have the evb priv and are currently not playing student
1.482 raeburn 4023: next if (($no_ownblock) &&
1.491 albertel 4024: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 4025: next if ($no_userblock);
1.474 raeburn 4026:
1.866 kalberla 4027: # Retrieve blocking times and identity of locker for course
1.490 raeburn 4028: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 4029:
4030: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
4031: if (($start != 0) &&
4032: (($startblock == 0) || ($startblock > $start))) {
4033: $startblock = $start;
4034: }
4035: if (($end != 0) &&
4036: (($endblock == 0) || ($endblock < $end))) {
4037: $endblock = $end;
4038: }
1.490 raeburn 4039: }
4040: return ($startblock,$endblock);
4041: }
4042:
4043: sub get_blocks {
4044: my ($setters,$activity,$cdom,$cnum) = @_;
4045: my $startblock = 0;
4046: my $endblock = 0;
4047: my $course = $cdom.'_'.$cnum;
4048: $setters->{$course} = {};
4049: $setters->{$course}{'staff'} = [];
4050: $setters->{$course}{'times'} = [];
4051: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
4052: foreach my $record (keys(%records)) {
4053: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
4054: if ($start <= time && $end >= time) {
4055: my ($staff_name,$staff_dom,$title,$blocks) =
4056: &parse_block_record($records{$record});
4057: if ($blocks->{$activity} eq 'on') {
4058: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
4059: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 4060: if ( ($startblock == 0) || ($startblock > $start) ) {
4061: $startblock = $start;
1.490 raeburn 4062: }
1.491 albertel 4063: if ( ($endblock == 0) || ($endblock < $end) ) {
4064: $endblock = $end;
1.474 raeburn 4065: }
4066: }
4067: }
4068: }
4069: return ($startblock,$endblock);
4070: }
4071:
4072: sub parse_block_record {
4073: my ($record) = @_;
4074: my ($setuname,$setudom,$title,$blocks);
4075: if (ref($record) eq 'HASH') {
4076: ($setuname,$setudom) = split(/:/,$record->{'setter'});
4077: $title = &unescape($record->{'event'});
4078: $blocks = $record->{'blocks'};
4079: } else {
4080: my @data = split(/:/,$record,3);
4081: if (scalar(@data) eq 2) {
4082: $title = $data[1];
4083: ($setuname,$setudom) = split(/@/,$data[0]);
4084: } else {
4085: ($setuname,$setudom,$title) = @data;
4086: }
4087: $blocks = { 'com' => 'on' };
4088: }
4089: return ($setuname,$setudom,$title,$blocks);
4090: }
4091:
1.854 kalberla 4092: sub blocking_status {
4093: my ($activity,$uname,$udom) = @_;
1.867 kalberla 4094: my %setters;
1.890 droeschl 4095:
4096: # check for active blocking
1.867 kalberla 4097: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
1.854 kalberla 4098:
1.890 droeschl 4099: my $blocked = $startblock && $endblock ? 1 : 0;
4100:
4101: # caller just wants to know whether a block is active
4102: if (!wantarray) { return $blocked; }
4103:
4104: # build a link to a popup window containing the details
4105: my $querystring = "?activity=$activity";
4106: # $uname and $udom decide whose portfolio the user is trying to look at
4107: $querystring .= "&udom=$udom" if $udom;
4108: $querystring .= "&uname=$uname" if $uname;
4109:
4110: my $output .= <<'END_MYBLOCK';
1.854 kalberla 4111: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
4112: var options = "width=" + w + ",height=" + h + ",";
4113: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
4114: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
4115: var newWin = window.open(url, wdwName, options);
4116: newWin.focus();
4117: }
1.890 droeschl 4118: END_MYBLOCK
1.854 kalberla 4119:
1.890 droeschl 4120: $output = Apache::lonhtmlcommon::scripttag($output);
4121:
1.854 kalberla 4122: my $popupUrl = "/adm/blockingstatus/$querystring";
1.890 droeschl 4123: my $text = mt('Communication Blocked');
4124:
1.867 kalberla 4125: $output .= <<"END_BLOCK";
4126: <div class='LC_comblock'>
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'>
4129: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 4130: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4131: title='$text'>$text</a>
1.867 kalberla 4132: </div>
4133:
4134: END_BLOCK
1.474 raeburn 4135:
1.854 kalberla 4136: return ($blocked, $output);
4137: }
1.490 raeburn 4138:
1.60 matthew 4139: ###############################################
4140:
1.682 raeburn 4141: sub check_ip_acc {
4142: my ($acc)=@_;
4143: &Apache::lonxml::debug("acc is $acc");
4144: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
4145: return 1;
4146: }
4147: my $allowed=0;
4148: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
4149:
4150: my $name;
4151: foreach my $pattern (split(',',$acc)) {
4152: $pattern =~ s/^\s*//;
4153: $pattern =~ s/\s*$//;
4154: if ($pattern =~ /\*$/) {
4155: #35.8.*
4156: $pattern=~s/\*//;
4157: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4158: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
4159: #35.8.3.[34-56]
4160: my $low=$2;
4161: my $high=$3;
4162: $pattern=$1;
4163: if ($ip =~ /^\Q$pattern\E/) {
4164: my $last=(split(/\./,$ip))[3];
4165: if ($last <=$high && $last >=$low) { $allowed=1; }
4166: }
4167: } elsif ($pattern =~ /^\*/) {
4168: #*.msu.edu
4169: $pattern=~s/\*//;
4170: if (!defined($name)) {
4171: use Socket;
4172: my $netaddr=inet_aton($ip);
4173: ($name)=gethostbyaddr($netaddr,AF_INET);
4174: }
4175: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4176: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
4177: #127.0.0.1
4178: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4179: } else {
4180: #some.name.com
4181: if (!defined($name)) {
4182: use Socket;
4183: my $netaddr=inet_aton($ip);
4184: ($name)=gethostbyaddr($netaddr,AF_INET);
4185: }
4186: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4187: }
4188: if ($allowed) { last; }
4189: }
4190: return $allowed;
4191: }
4192:
4193: ###############################################
4194:
1.60 matthew 4195: =pod
4196:
1.112 bowersj2 4197: =head1 Domain Template Functions
4198:
4199: =over 4
4200:
4201: =item * &determinedomain()
1.60 matthew 4202:
4203: Inputs: $domain (usually will be undef)
4204:
1.63 www 4205: Returns: Determines which domain should be used for designs
1.60 matthew 4206:
4207: =cut
1.54 www 4208:
1.60 matthew 4209: ###############################################
1.63 www 4210: sub determinedomain {
4211: my $domain=shift;
1.531 albertel 4212: if (! $domain) {
1.60 matthew 4213: # Determine domain if we have not been given one
1.893 raeburn 4214: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 4215: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
4216: if ($env{'request.role.domain'}) {
4217: $domain=$env{'request.role.domain'};
1.60 matthew 4218: }
4219: }
1.63 www 4220: return $domain;
4221: }
4222: ###############################################
1.517 raeburn 4223:
1.518 albertel 4224: sub devalidate_domconfig_cache {
4225: my ($udom)=@_;
4226: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
4227: }
4228:
4229: # ---------------------- Get domain configuration for a domain
4230: sub get_domainconf {
4231: my ($udom) = @_;
4232: my $cachetime=1800;
4233: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
4234: if (defined($cached)) { return %{$result}; }
4235:
4236: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 4237: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 4238: my (%designhash,%legacy);
1.518 albertel 4239: if (keys(%domconfig) > 0) {
4240: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 4241: if (keys(%{$domconfig{'login'}})) {
4242: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 4243: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.946 raeburn 4244: if ($key eq 'loginvia') {
4245: if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') {
4246: my @ids = &Apache::lonnet::current_machine_ids();
4247: foreach my $hostname (@ids) {
1.948 raeburn 4248: if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') {
4249: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
4250: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
4251: $designhash{$udom.'.login.loginvia'} = $server;
4252: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
4253:
4254: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
4255: } else {
4256: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
4257: }
4258: if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) {
4259: $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'};
4260: }
1.946 raeburn 4261: }
4262: }
4263: }
4264: }
4265: } else {
4266: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
4267: $designhash{$udom.'.login.'.$key.'_'.$img} =
4268: $domconfig{'login'}{$key}{$img};
4269: }
1.699 raeburn 4270: }
4271: } else {
4272: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
4273: }
1.632 raeburn 4274: }
4275: } else {
4276: $legacy{'login'} = 1;
1.518 albertel 4277: }
1.632 raeburn 4278: } else {
4279: $legacy{'login'} = 1;
1.518 albertel 4280: }
4281: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 4282: if (keys(%{$domconfig{'rolecolors'}})) {
4283: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
4284: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
4285: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
4286: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
4287: }
1.518 albertel 4288: }
4289: }
1.632 raeburn 4290: } else {
4291: $legacy{'rolecolors'} = 1;
1.518 albertel 4292: }
1.632 raeburn 4293: } else {
4294: $legacy{'rolecolors'} = 1;
1.518 albertel 4295: }
1.948 raeburn 4296: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
4297: if ($domconfig{'autoenroll'}{'co-owners'}) {
4298: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
4299: }
4300: }
1.632 raeburn 4301: if (keys(%legacy) > 0) {
4302: my %legacyhash = &get_legacy_domconf($udom);
4303: foreach my $item (keys(%legacyhash)) {
4304: if ($item =~ /^\Q$udom\E\.login/) {
4305: if ($legacy{'login'}) {
4306: $designhash{$item} = $legacyhash{$item};
4307: }
4308: } else {
4309: if ($legacy{'rolecolors'}) {
4310: $designhash{$item} = $legacyhash{$item};
4311: }
1.518 albertel 4312: }
4313: }
4314: }
1.632 raeburn 4315: } else {
4316: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4317: }
4318: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4319: $cachetime);
4320: return %designhash;
4321: }
4322:
1.632 raeburn 4323: sub get_legacy_domconf {
4324: my ($udom) = @_;
4325: my %legacyhash;
4326: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4327: my $designfile = $designdir.'/'.$udom.'.tab';
4328: if (-e $designfile) {
4329: if ( open (my $fh,"<$designfile") ) {
4330: while (my $line = <$fh>) {
4331: next if ($line =~ /^\#/);
4332: chomp($line);
4333: my ($key,$val)=(split(/\=/,$line));
4334: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4335: }
4336: close($fh);
4337: }
4338: }
4339: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
4340: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4341: }
4342: return %legacyhash;
4343: }
4344:
1.63 www 4345: =pod
4346:
1.112 bowersj2 4347: =item * &domainlogo()
1.63 www 4348:
4349: Inputs: $domain (usually will be undef)
4350:
4351: Returns: A link to a domain logo, if the domain logo exists.
4352: If the domain logo does not exist, a description of the domain.
4353:
4354: =cut
1.112 bowersj2 4355:
1.63 www 4356: ###############################################
4357: sub domainlogo {
1.517 raeburn 4358: my $domain = &determinedomain(shift);
1.518 albertel 4359: my %designhash = &get_domainconf($domain);
1.517 raeburn 4360: # See if there is a logo
4361: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4362: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4363: if ($imgsrc =~ m{^/(adm|res)/}) {
4364: if ($imgsrc =~ m{^/res/}) {
4365: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4366: &Apache::lonnet::repcopy($local_name);
4367: }
4368: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4369: }
4370: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4371: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4372: return &Apache::lonnet::domain($domain,'description');
1.59 www 4373: } else {
1.60 matthew 4374: return '';
1.59 www 4375: }
4376: }
1.63 www 4377: ##############################################
4378:
4379: =pod
4380:
1.112 bowersj2 4381: =item * &designparm()
1.63 www 4382:
4383: Inputs: $which parameter; $domain (usually will be undef)
4384:
4385: Returns: value of designparamter $which
4386:
4387: =cut
1.112 bowersj2 4388:
1.397 albertel 4389:
1.400 albertel 4390: ##############################################
1.397 albertel 4391: sub designparm {
4392: my ($which,$domain)=@_;
4393: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 4394: return $env{'environment.color.'.$which};
1.96 www 4395: }
1.63 www 4396: $domain=&determinedomain($domain);
1.518 albertel 4397: my %domdesign = &get_domainconf($domain);
1.520 raeburn 4398: my $output;
1.517 raeburn 4399: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 4400: $output = $domdesign{$domain.'.'.$which};
1.63 www 4401: } else {
1.520 raeburn 4402: $output = $defaultdesign{$which};
4403: }
4404: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4405: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4406: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 4407: if ($output =~ m{^/res/}) {
4408: my $local_name = &Apache::lonnet::filelocation('',$output);
4409: &Apache::lonnet::repcopy($local_name);
4410: }
1.520 raeburn 4411: $output = &lonhttpdurl($output);
4412: }
1.63 www 4413: }
1.520 raeburn 4414: return $output;
1.63 www 4415: }
1.59 www 4416:
1.822 bisitz 4417: ##############################################
4418: =pod
4419:
1.832 bisitz 4420: =item * &authorspace()
4421:
4422: Inputs: ./.
4423:
4424: Returns: Path to the Construction Space of the current user's
4425: accessed author space
4426: The author space will be that of the current user
4427: when accessing the own author space
4428: and that of the co-author/assistent co-author
4429: when accessing the co-author's/assistent co-author's
4430: space
4431:
4432: =cut
4433:
4434: sub authorspace {
4435: my $caname = '';
4436: if ($env{'request.role'} =~ /^ca|^aa/) {
4437: (undef,$caname) =
4438: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
4439: } else {
4440: $caname = $env{'user.name'};
4441: }
4442: return '/priv/'.$caname.'/';
4443: }
4444:
4445: ##############################################
4446: =pod
4447:
1.822 bisitz 4448: =item * &head_subbox()
4449:
4450: Inputs: $content (contains HTML code with page functions, etc.)
4451:
4452: Returns: HTML div with $content
4453: To be included in page header
4454:
4455: =cut
4456:
4457: sub head_subbox {
4458: my ($content)=@_;
4459: my $output =
1.844 bisitz 4460: '<div id="LC_head_subbox">'
1.822 bisitz 4461: .$content
4462: .'</div>'
4463: }
4464:
4465: ##############################################
4466: =pod
4467:
4468: =item * &CSTR_pageheader()
4469:
4470: Inputs: ./.
4471:
4472: Returns: HTML div with CSTR path and recent box
4473: To be included on Construction Space pages
4474:
4475: =cut
4476:
4477: sub CSTR_pageheader {
4478: # this is for resources; directories have customtitle, and crumbs
4479: # and select recent are created in lonpubdir.pm
4480: my ($uname,$thisdisfn)=
4481: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
4482: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4483: $formaction=~s/\/+/\//g;
4484:
4485: my $parentpath = '';
4486: my $lastitem = '';
4487: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4488: $parentpath = $1;
4489: $lastitem = $2;
4490: } else {
4491: $lastitem = $thisdisfn;
4492: }
1.921 bisitz 4493:
4494: my $output =
1.822 bisitz 4495: '<div>'
4496: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
4497: .'<b>'.&mt('Construction Space:').'</b> '
4498: .'<form name="dirs" method="post" action="'.$formaction
1.921 bisitz 4499: .'" target="_top">' #FIXME lonpubdir: target="_parent"
4500: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv',undef,undef);
4501:
4502: if ($lastitem) {
4503: $output .=
4504: '<span class="LC_filename">'
4505: .$lastitem
4506: .'</span>';
4507: }
4508: $output .=
4509: '<br />'
1.822 bisitz 4510: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
4511: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4512: .'</form>'
4513: .&Apache::lonmenu::constspaceform()
4514: .'</div>';
1.921 bisitz 4515:
4516: return $output;
1.822 bisitz 4517: }
4518:
1.60 matthew 4519: ###############################################
4520: ###############################################
4521:
4522: =pod
4523:
1.112 bowersj2 4524: =back
4525:
1.549 albertel 4526: =head1 HTML Helpers
1.112 bowersj2 4527:
4528: =over 4
4529:
4530: =item * &bodytag()
1.60 matthew 4531:
4532: Returns a uniform header for LON-CAPA web pages.
4533:
4534: Inputs:
4535:
1.112 bowersj2 4536: =over 4
4537:
4538: =item * $title, A title to be displayed on the page.
4539:
4540: =item * $function, the current role (can be undef).
4541:
4542: =item * $addentries, extra parameters for the <body> tag.
4543:
4544: =item * $bodyonly, if defined, only return the <body> tag.
4545:
4546: =item * $domain, if defined, force a given domain.
4547:
4548: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4549: text interface only)
1.60 matthew 4550:
1.814 bisitz 4551: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
4552: navigational links
1.317 albertel 4553:
1.338 albertel 4554: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4555:
1.361 albertel 4556: =item * $no_inline_link, if true and in remote mode, don't show the
4557: 'Switch To Inline Menu' link
4558:
1.460 albertel 4559: =item * $args, optional argument valid values are
4560: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4561: inherit_jsmath -> when creating popup window in a page,
4562: should it have jsmath forced on by the
4563: current page
1.460 albertel 4564:
1.112 bowersj2 4565: =back
4566:
1.60 matthew 4567: Returns: A uniform header for LON-CAPA web pages.
4568: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4569: If $bodyonly is undef or zero, an html string containing a <body> tag and
4570: other decorations will be returned.
4571:
4572: =cut
4573:
1.54 www 4574: sub bodytag {
1.831 bisitz 4575: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.816 bisitz 4576: $no_nav_bar,$bgcolor,$no_inline_link,$args)=@_;
1.339 albertel 4577:
1.948.2.2 raeburn 4578: my $public;
4579: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
4580: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
4581: $public = 1;
4582: }
1.460 albertel 4583: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4584:
1.183 matthew 4585: $function = &get_users_function() if (!$function);
1.339 albertel 4586: my $img = &designparm($function.'.img',$domain);
4587: my $font = &designparm($function.'.font',$domain);
4588: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4589:
1.803 bisitz 4590: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 4591: 'bgcolor' => $pgbg,
1.339 albertel 4592: 'text' => $font,
4593: 'alink' => &designparm($function.'.alink',$domain),
4594: 'vlink' => &designparm($function.'.vlink',$domain),
4595: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4596: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4597:
1.63 www 4598: # role and realm
1.378 raeburn 4599: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4600: if ($role eq 'ca') {
1.479 albertel 4601: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4602: $realm = &plainname($rname,$rdom);
1.378 raeburn 4603: }
1.55 www 4604: # realm
1.258 albertel 4605: if ($env{'request.course.id'}) {
1.378 raeburn 4606: if ($env{'request.role'} !~ /^cr/) {
4607: $role = &Apache::lonnet::plaintext($role,&course_type());
4608: }
1.898 raeburn 4609: if ($env{'request.course.sec'}) {
4610: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
4611: }
1.359 albertel 4612: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4613: } else {
4614: $role = &Apache::lonnet::plaintext($role);
1.54 www 4615: }
1.433 albertel 4616:
1.359 albertel 4617: if (!$realm) { $realm=' '; }
1.55 www 4618: # Set messages
1.60 matthew 4619: my $messages=&domainlogo($domain);
1.330 albertel 4620:
1.438 albertel 4621: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4622:
1.101 www 4623: # construct main body tag
1.359 albertel 4624: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4625: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4626:
1.530 albertel 4627: if ($bodyonly) {
1.60 matthew 4628: return $bodytag;
1.798 tempelho 4629: }
1.359 albertel 4630:
1.410 albertel 4631: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.948.2.2 raeburn 4632: if ($public) {
1.433 albertel 4633: undef($role);
1.434 albertel 4634: } else {
4635: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4636: }
1.948.2.2 raeburn 4637:
1.762 bisitz 4638: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 4639: #
4640: # Extra info if you are the DC
4641: my $dc_info = '';
4642: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4643: $env{'course.'.$env{'request.course.id'}.
4644: '.domain'}.'/'})) {
4645: my $cid = $env{'request.course.id'};
1.917 raeburn 4646: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4647: $dc_info =~ s/\s+$//;
1.359 albertel 4648: }
4649:
1.898 raeburn 4650: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853 droeschl 4651: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
4652:
1.837 bisitz 4653: if ($env{'environment.remote'} eq 'off') {
1.359 albertel 4654: # No Remote
1.916 droeschl 4655: if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') {
4656: return $bodytag;
4657: }
1.903 droeschl 4658:
4659: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
4660:
4661: # if ($env{'request.state'} eq 'construct') {
4662: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
4663: # }
4664:
1.359 albertel 4665:
4666:
1.916 droeschl 4667: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917 raeburn 4668: if ($dc_info) {
4669: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
4670: }
1.916 droeschl 4671: $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
4672: <em>$realm</em> $dc_info</div>|;
1.903 droeschl 4673: return $bodytag;
4674: }
1.894 droeschl 4675:
1.927 raeburn 4676: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
4677: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
4678: }
1.916 droeschl 4679:
1.903 droeschl 4680: $bodytag .= Apache::lonhtmlcommon::scripttag(
4681: Apache::lonmenu::utilityfunctions(), 'start');
1.816 bisitz 4682:
1.903 droeschl 4683: $bodytag .= Apache::lonmenu::primary_menu();
1.852 droeschl 4684:
1.917 raeburn 4685: if ($dc_info) {
4686: $dc_info = &dc_courseid_toggle($dc_info);
4687: }
4688: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 4689:
1.903 droeschl 4690: #don't show menus for public users
1.948.2.2 raeburn 4691: if (!$public){
1.903 droeschl 4692: $bodytag .= Apache::lonmenu::secondary_menu();
4693: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 4694: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
4695: if ($env{'request.state'} eq 'construct') {
4696: $bodytag .= &Apache::lonmenu::innerregister($forcereg,'',
4697: $args->{'bread_crumbs'});
4698: } elsif ($forcereg) {
4699: $bodytag .= &Apache::lonmenu::innerregister($forcereg);
4700: }
1.903 droeschl 4701: }else{
4702: # this is to seperate menu from content when there's no secondary
4703: # menu. Especially needed for public accessible ressources.
4704: $bodytag .= '<hr style="clear:both" />';
4705: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 4706: }
1.903 droeschl 4707:
1.235 raeburn 4708: return $bodytag;
1.94 www 4709: }
1.95 www 4710:
1.93 www 4711: #
1.95 www 4712: # Top frame rendering, Remote is up
1.93 www 4713: #
1.359 albertel 4714:
1.517 raeburn 4715: my $imgsrc = $img;
4716: if ($img =~ /^\/adm/) {
1.575 albertel 4717: $imgsrc = &lonhttpdurl($img);
1.517 raeburn 4718: }
4719: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359 albertel 4720:
1.305 www 4721: # Explicit link to get inline menu
1.361 albertel 4722: my $menu= ($no_inline_link?''
1.883 droeschl 4723: :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
1.917 raeburn 4724:
4725: if ($dc_info) {
4726: $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
4727: }
4728:
1.916 droeschl 4729: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>
1.897 wenzelju 4730: <ol class="LC_primary_menu LC_right">
1.853 droeschl 4731: <li>$menu</li>
1.917 raeburn 4732: </ol><div id="LC_realm"> $realm $dc_info</div>| unless $env{'form.inhibitmenu'};
1.94 www 4733: return(<<ENDBODY);
1.60 matthew 4734: $bodytag
1.359 albertel 4735: <table id="LC_title_bar" class="LC_with_remote">
1.791 tempelho 4736: <tr><td>$upperleft</td>
4737: <td>$messages </td>
1.54 www 4738: </tr>
1.359 albertel 4739: <tr><td>$titleinfo $dc_info $menu</td>
1.368 albertel 4740: </tr>
1.356 albertel 4741: </table>
1.54 www 4742: ENDBODY
1.182 matthew 4743: }
4744:
1.917 raeburn 4745: sub dc_courseid_toggle {
4746: my ($dc_info) = @_;
4747: return ' <span id="dccidtext" class="LC_cusr_subheading">'.
4748: '<a href="javascript:showCourseID();">'.
4749: &mt('(More ...)').'</a></span>'.
4750: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
4751: }
4752:
1.330 albertel 4753: sub make_attr_string {
4754: my ($register,$attr_ref) = @_;
4755:
4756: if ($attr_ref && !ref($attr_ref)) {
4757: die("addentries Must be a hash ref ".
4758: join(':',caller(1))." ".
4759: join(':',caller(0))." ");
4760: }
4761:
4762: if ($register) {
1.339 albertel 4763: my ($on_load,$on_unload);
4764: foreach my $key (keys(%{$attr_ref})) {
4765: if (lc($key) eq 'onload') {
4766: $on_load.=$attr_ref->{$key}.';';
4767: delete($attr_ref->{$key});
4768:
4769: } elsif (lc($key) eq 'onunload') {
4770: $on_unload.=$attr_ref->{$key}.';';
4771: delete($attr_ref->{$key});
4772: }
4773: }
4774: $attr_ref->{'onload'} =
4775: &Apache::lonmenu::loadevents(). $on_load;
4776: $attr_ref->{'onunload'}=
4777: &Apache::lonmenu::unloadevents().$on_unload;
4778: }
4779:
4780: # Accessibility font enhance
4781: if ($env{'browser.fontenhance'} eq 'on') {
4782: my $style;
4783: foreach my $key (keys(%{$attr_ref})) {
4784: if (lc($key) eq 'style') {
4785: $style.=$attr_ref->{$key}.';';
4786: delete($attr_ref->{$key});
4787: }
4788: }
4789: $attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330 albertel 4790: }
1.339 albertel 4791:
1.330 albertel 4792: my $attr_string;
4793: foreach my $attr (keys(%$attr_ref)) {
4794: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4795: }
4796: return $attr_string;
4797: }
4798:
4799:
1.182 matthew 4800: ###############################################
1.251 albertel 4801: ###############################################
4802:
4803: =pod
4804:
4805: =item * &endbodytag()
4806:
4807: Returns a uniform footer for LON-CAPA web pages.
4808:
1.635 raeburn 4809: Inputs: 1 - optional reference to an args hash
4810: If in the hash, key for noredirectlink has a value which evaluates to true,
4811: a 'Continue' link is not displayed if the page contains an
4812: internal redirect in the <head></head> section,
4813: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4814:
4815: =cut
4816:
4817: sub endbodytag {
1.635 raeburn 4818: my ($args) = @_;
1.251 albertel 4819: my $endbodytag='</body>';
1.269 albertel 4820: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4821: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4822: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4823: $endbodytag=
4824: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4825: &mt('Continue').'</a>'.
4826: $endbodytag;
4827: }
1.315 albertel 4828: }
1.251 albertel 4829: return $endbodytag;
4830: }
4831:
1.352 albertel 4832: =pod
4833:
4834: =item * &standard_css()
4835:
4836: Returns a style sheet
4837:
4838: Inputs: (all optional)
4839: domain -> force to color decorate a page for a specific
4840: domain
4841: function -> force usage of a specific rolish color scheme
4842: bgcolor -> override the default page bgcolor
4843:
4844: =cut
4845:
1.343 albertel 4846: sub standard_css {
1.345 albertel 4847: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4848: $function = &get_users_function() if (!$function);
4849: my $img = &designparm($function.'.img', $domain);
4850: my $tabbg = &designparm($function.'.tabbg', $domain);
4851: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 4852: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 4853: #second colour for later usage
1.345 albertel 4854: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4855: my $pgbg_or_bgcolor =
4856: $bgcolor ||
1.352 albertel 4857: &designparm($function.'.pgbg', $domain);
1.382 albertel 4858: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4859: my $alink = &designparm($function.'.alink', $domain);
4860: my $vlink = &designparm($function.'.vlink', $domain);
4861: my $link = &designparm($function.'.link', $domain);
4862:
1.704 muellerd 4863: my $loginbg = &designparm('login.sidebg',$domain);
1.712 muellerd 4864: my $bgcol = &designparm('login.bgcol',$domain);
4865: my $textcol = &designparm('login.textcol',$domain);
1.704 muellerd 4866:
1.602 albertel 4867: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4868: my $mono = 'monospace';
1.850 bisitz 4869: my $data_table_head = $sidebg;
4870: my $data_table_light = '#FAFAFA';
4871: my $data_table_dark = '#F0F0F0';
1.470 banghart 4872: my $data_table_darker = '#CCCCCC';
1.349 albertel 4873: my $data_table_highlight = '#FFFF00';
1.352 albertel 4874: my $mail_new = '#FFBB77';
4875: my $mail_new_hover = '#DD9955';
4876: my $mail_read = '#BBBB77';
4877: my $mail_read_hover = '#999944';
4878: my $mail_replied = '#AAAA88';
4879: my $mail_replied_hover = '#888855';
4880: my $mail_other = '#99BBBB';
4881: my $mail_other_hover = '#669999';
1.391 albertel 4882: my $table_header = '#DDDDDD';
1.489 raeburn 4883: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 4884: my $lg_border_color = '#C8C8C8';
1.948.2.1 raeburn 4885: my $button_hover = '#BF2317';
1.392 albertel 4886:
1.608 albertel 4887: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 4888: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
4889: : '0 3px 0 4px';
1.448 albertel 4890:
1.343 albertel 4891: return <<END;
1.947 droeschl 4892:
4893: /* needed for iframe to allow 100% height in FF */
4894: body, html {
4895: margin: 0;
4896: padding: 0 0.5%;
4897: height: 99%; /* to avoid scrollbars */
4898: }
4899:
1.795 www 4900: body {
1.911 bisitz 4901: font-family: $sans;
4902: line-height:130%;
4903: font-size:0.83em;
4904: color:$font;
1.795 www 4905: }
4906:
1.948.2.3 raeburn 4907: +a:focus,
4908: +a:focus img {
1.795 www 4909: color: red;
1.911 bisitz 4910: background: yellow;
1.795 www 4911: }
1.698 harmsja 4912:
1.911 bisitz 4913: form, .inline {
4914: display: inline;
1.795 www 4915: }
1.721 harmsja 4916:
1.795 www 4917: .LC_right {
1.911 bisitz 4918: text-align:right;
1.795 www 4919: }
4920:
4921: .LC_middle {
1.911 bisitz 4922: vertical-align:middle;
1.795 www 4923: }
1.721 harmsja 4924:
1.911 bisitz 4925: .LC_400Box {
4926: width:400px;
4927: }
1.721 harmsja 4928:
1.947 droeschl 4929: .LC_iframecontainer {
4930: width: 98%;
4931: margin: 0;
4932: position: fixed;
4933: top: 8.5em;
4934: bottom: 0;
4935: }
4936:
4937: .LC_iframecontainer iframe{
4938: border: none;
4939: width: 100%;
4940: height: 100%;
4941: }
4942:
1.778 bisitz 4943: .LC_filename {
4944: font-family: $mono;
4945: white-space:pre;
1.921 bisitz 4946: font-size: 120%;
1.778 bisitz 4947: }
4948:
4949: .LC_fileicon {
4950: border: none;
4951: height: 1.3em;
4952: vertical-align: text-bottom;
4953: margin-right: 0.3em;
4954: text-decoration:none;
4955: }
4956:
1.350 albertel 4957: .LC_error {
4958: color: red;
4959: font-size: larger;
4960: }
1.795 www 4961:
1.457 albertel 4962: .LC_warning,
4963: .LC_diff_removed {
1.733 bisitz 4964: color: red;
1.394 albertel 4965: }
1.532 albertel 4966:
4967: .LC_info,
1.457 albertel 4968: .LC_success,
4969: .LC_diff_added {
1.350 albertel 4970: color: green;
4971: }
1.795 www 4972:
1.802 bisitz 4973: div.LC_confirm_box {
4974: background-color: #FAFAFA;
4975: border: 1px solid $lg_border_color;
4976: margin-right: 0;
4977: padding: 5px;
4978: }
4979:
4980: div.LC_confirm_box .LC_error img,
4981: div.LC_confirm_box .LC_success img {
4982: vertical-align: middle;
4983: }
4984:
1.440 albertel 4985: .LC_icon {
1.771 droeschl 4986: border: none;
1.790 droeschl 4987: vertical-align: middle;
1.771 droeschl 4988: }
4989:
1.543 albertel 4990: .LC_docs_spacer {
4991: width: 25px;
4992: height: 1px;
1.771 droeschl 4993: border: none;
1.543 albertel 4994: }
1.346 albertel 4995:
1.532 albertel 4996: .LC_internal_info {
1.735 bisitz 4997: color: #999999;
1.532 albertel 4998: }
4999:
1.794 www 5000: .LC_discussion {
1.911 bisitz 5001: background: $tabbg;
5002: border: 1px solid black;
5003: margin: 2px;
1.794 www 5004: }
5005:
5006: .LC_disc_action_links_bar {
1.911 bisitz 5007: background: $tabbg;
5008: border: none;
5009: margin: 4px;
1.794 www 5010: }
5011:
5012: .LC_disc_action_left {
1.911 bisitz 5013: text-align: left;
1.794 www 5014: }
5015:
5016: .LC_disc_action_right {
1.911 bisitz 5017: text-align: right;
1.794 www 5018: }
5019:
5020: .LC_disc_new_item {
1.911 bisitz 5021: background: white;
5022: border: 2px solid red;
5023: margin: 2px;
1.794 www 5024: }
5025:
5026: .LC_disc_old_item {
1.911 bisitz 5027: background: white;
5028: border: 1px solid black;
5029: margin: 2px;
1.794 www 5030: }
5031:
1.458 albertel 5032: table.LC_pastsubmission {
5033: border: 1px solid black;
5034: margin: 2px;
5035: }
5036:
1.924 bisitz 5037: table#LC_menubuttons {
1.345 albertel 5038: width: 100%;
5039: background: $pgbg;
1.392 albertel 5040: border: 2px;
1.402 albertel 5041: border-collapse: separate;
1.803 bisitz 5042: padding: 0;
1.345 albertel 5043: }
1.392 albertel 5044:
1.801 tempelho 5045: table#LC_title_bar a {
5046: color: $fontmenu;
5047: }
1.836 bisitz 5048:
1.807 droeschl 5049: table#LC_title_bar {
1.819 tempelho 5050: clear: both;
1.836 bisitz 5051: display: none;
1.807 droeschl 5052: }
5053:
1.795 www 5054: table#LC_title_bar,
1.933 droeschl 5055: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 5056: table#LC_title_bar.LC_with_remote {
1.359 albertel 5057: width: 100%;
1.392 albertel 5058: border-color: $pgbg;
5059: border-style: solid;
5060: border-width: $border;
1.379 albertel 5061: background: $pgbg;
1.801 tempelho 5062: color: $fontmenu;
1.392 albertel 5063: border-collapse: collapse;
1.803 bisitz 5064: padding: 0;
1.819 tempelho 5065: margin: 0;
1.359 albertel 5066: }
1.795 www 5067:
1.933 droeschl 5068: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 5069: margin: 0;
5070: padding: 0;
1.933 droeschl 5071: position: relative;
5072: list-style: none;
1.913 droeschl 5073: }
1.933 droeschl 5074: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 5075: display: inline;
5076: }
1.933 droeschl 5077:
5078: .LC_breadcrumb_tools_navigation {
1.913 droeschl 5079: padding: 0;
1.933 droeschl 5080: margin: 0;
5081: float: left;
1.913 droeschl 5082: }
1.933 droeschl 5083: .LC_breadcrumb_tools_tools {
5084: padding: 0;
5085: margin: 0;
1.913 droeschl 5086: float: right;
5087: }
5088:
1.359 albertel 5089: table#LC_title_bar td {
5090: background: $tabbg;
5091: }
1.795 www 5092:
1.911 bisitz 5093: table#LC_menubuttons img {
1.803 bisitz 5094: border: none;
1.346 albertel 5095: }
1.795 www 5096:
1.842 droeschl 5097: .LC_breadcrumbs_component {
1.911 bisitz 5098: float: right;
5099: margin: 0 1em;
1.357 albertel 5100: }
1.842 droeschl 5101: .LC_breadcrumbs_component img {
1.911 bisitz 5102: vertical-align: middle;
1.777 tempelho 5103: }
1.795 www 5104:
1.383 albertel 5105: td.LC_table_cell_checkbox {
5106: text-align: center;
5107: }
1.795 www 5108:
5109: .LC_fontsize_small {
1.911 bisitz 5110: font-size: 70%;
1.705 tempelho 5111: }
5112:
1.844 bisitz 5113: #LC_breadcrumbs {
1.911 bisitz 5114: clear:both;
5115: background: $sidebg;
5116: border-bottom: 1px solid $lg_border_color;
5117: line-height: 2.5em;
1.933 droeschl 5118: overflow: hidden;
1.911 bisitz 5119: margin: 0;
5120: padding: 0;
1.819 tempelho 5121: }
1.862 bisitz 5122:
1.839 droeschl 5123: /* Preliminary fix to hide breadcrumbs inside remote control window */
1.844 bisitz 5124: #LC_remote #LC_breadcrumbs {
1.911 bisitz 5125: display:none;
1.839 droeschl 5126: }
1.819 tempelho 5127:
1.844 bisitz 5128: #LC_head_subbox {
1.911 bisitz 5129: clear:both;
5130: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 5131: border: 1px solid $sidebg;
5132: margin: 0 0 10px 0;
1.822 bisitz 5133: }
5134:
1.795 www 5135: .LC_fontsize_medium {
1.911 bisitz 5136: font-size: 85%;
1.705 tempelho 5137: }
5138:
1.795 www 5139: .LC_fontsize_large {
1.911 bisitz 5140: font-size: 120%;
1.705 tempelho 5141: }
5142:
1.346 albertel 5143: .LC_menubuttons_inline_text {
5144: color: $font;
1.698 harmsja 5145: font-size: 90%;
1.701 harmsja 5146: padding-left:3px;
1.346 albertel 5147: }
5148:
1.934 droeschl 5149: .LC_menubuttons_inline_text img{
5150: vertical-align: middle;
5151: }
5152:
1.948.2.1 raeburn 5153: li.LC_menubuttons_inline_text img,a {
5154: cursor:pointer;
5155: }
5156:
1.526 www 5157: .LC_menubuttons_link {
5158: text-decoration: none;
5159: }
1.795 www 5160:
1.522 albertel 5161: .LC_menubuttons_category {
1.521 www 5162: color: $font;
1.526 www 5163: background: $pgbg;
1.521 www 5164: font-size: larger;
5165: font-weight: bold;
5166: }
5167:
1.346 albertel 5168: td.LC_menubuttons_text {
1.911 bisitz 5169: color: $font;
1.346 albertel 5170: }
1.706 harmsja 5171:
1.346 albertel 5172: .LC_current_location {
5173: background: $tabbg;
5174: }
1.795 www 5175:
1.938 bisitz 5176: table.LC_data_table {
1.347 albertel 5177: border: 1px solid #000000;
1.402 albertel 5178: border-collapse: separate;
1.426 albertel 5179: border-spacing: 1px;
1.610 albertel 5180: background: $pgbg;
1.347 albertel 5181: }
1.795 www 5182:
1.422 albertel 5183: .LC_data_table_dense {
5184: font-size: small;
5185: }
1.795 www 5186:
1.507 raeburn 5187: table.LC_nested_outer {
5188: border: 1px solid #000000;
1.589 raeburn 5189: border-collapse: collapse;
1.803 bisitz 5190: border-spacing: 0;
1.507 raeburn 5191: width: 100%;
5192: }
1.795 www 5193:
1.879 raeburn 5194: table.LC_innerpickbox,
1.507 raeburn 5195: table.LC_nested {
1.803 bisitz 5196: border: none;
1.589 raeburn 5197: border-collapse: collapse;
1.803 bisitz 5198: border-spacing: 0;
1.507 raeburn 5199: width: 100%;
5200: }
1.795 www 5201:
1.930 faziophi 5202: .ui-accordion,
5203: .ui-accordion table.LC_data_table,
5204: .ui-accordion table.LC_nested_outer{
5205: border: 0px;
5206: border-spacing: 0px;
5207: margin: 3px;
5208: }
5209:
1.911 bisitz 5210: table.LC_data_table tr th,
5211: table.LC_calendar tr th,
1.879 raeburn 5212: table.LC_prior_tries tr th,
5213: table.LC_innerpickbox tr th {
1.349 albertel 5214: font-weight: bold;
5215: background-color: $data_table_head;
1.801 tempelho 5216: color:$fontmenu;
1.701 harmsja 5217: font-size:90%;
1.347 albertel 5218: }
1.795 www 5219:
1.879 raeburn 5220: table.LC_innerpickbox tr th,
5221: table.LC_innerpickbox tr td {
5222: vertical-align: top;
5223: }
5224:
1.711 raeburn 5225: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 5226: background-color: #CCCCCC;
1.711 raeburn 5227: font-weight: bold;
5228: text-align: left;
5229: }
1.795 www 5230:
1.912 bisitz 5231: table.LC_data_table tr.LC_odd_row > td {
5232: background-color: $data_table_light;
5233: padding: 2px;
5234: vertical-align: top;
5235: }
5236:
1.809 bisitz 5237: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 5238: background-color: $data_table_light;
1.912 bisitz 5239: vertical-align: top;
5240: }
5241:
5242: table.LC_data_table tr.LC_even_row > td {
5243: background-color: $data_table_dark;
1.425 albertel 5244: padding: 2px;
1.900 bisitz 5245: vertical-align: top;
1.347 albertel 5246: }
1.795 www 5247:
1.809 bisitz 5248: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 5249: background-color: $data_table_dark;
1.900 bisitz 5250: vertical-align: top;
1.347 albertel 5251: }
1.795 www 5252:
1.425 albertel 5253: table.LC_data_table tr.LC_data_table_highlight td {
5254: background-color: $data_table_darker;
5255: }
1.795 www 5256:
1.639 raeburn 5257: table.LC_data_table tr td.LC_leftcol_header {
5258: background-color: $data_table_head;
5259: font-weight: bold;
5260: }
1.795 www 5261:
1.451 albertel 5262: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5263: table.LC_nested tr.LC_empty_row td {
1.421 albertel 5264: font-weight: bold;
5265: font-style: italic;
5266: text-align: center;
5267: padding: 8px;
1.347 albertel 5268: }
1.795 www 5269:
1.940 bisitz 5270: table.LC_data_table tr.LC_empty_row td {
5271: background-color: $sidebg;
5272: }
5273:
5274: table.LC_nested tr.LC_empty_row td {
5275: background-color: #FFFFFF;
5276: }
5277:
1.890 droeschl 5278: table.LC_caption {
5279: }
5280:
1.507 raeburn 5281: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5282: padding: 4ex
5283: }
1.795 www 5284:
1.507 raeburn 5285: table.LC_nested_outer tr th {
5286: font-weight: bold;
1.801 tempelho 5287: color:$fontmenu;
1.507 raeburn 5288: background-color: $data_table_head;
1.701 harmsja 5289: font-size: small;
1.507 raeburn 5290: border-bottom: 1px solid #000000;
5291: }
1.795 www 5292:
1.507 raeburn 5293: table.LC_nested_outer tr td.LC_subheader {
5294: background-color: $data_table_head;
5295: font-weight: bold;
5296: font-size: small;
5297: border-bottom: 1px solid #000000;
5298: text-align: right;
1.451 albertel 5299: }
1.795 www 5300:
1.507 raeburn 5301: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5302: background-color: #CCCCCC;
1.451 albertel 5303: font-weight: bold;
5304: font-size: small;
1.507 raeburn 5305: text-align: center;
5306: }
1.795 www 5307:
1.589 raeburn 5308: table.LC_nested tr.LC_info_row td.LC_left_item,
5309: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5310: text-align: left;
1.451 albertel 5311: }
1.795 www 5312:
1.507 raeburn 5313: table.LC_nested td {
1.735 bisitz 5314: background-color: #FFFFFF;
1.451 albertel 5315: font-size: small;
1.507 raeburn 5316: }
1.795 www 5317:
1.507 raeburn 5318: table.LC_nested_outer tr th.LC_right_item,
5319: table.LC_nested tr.LC_info_row td.LC_right_item,
5320: table.LC_nested tr.LC_odd_row td.LC_right_item,
5321: table.LC_nested tr td.LC_right_item {
1.451 albertel 5322: text-align: right;
5323: }
5324:
1.930 faziophi 5325: .ui-accordion table.LC_nested tr.LC_odd_row td.LC_left_item,
5326: .ui-accordion table.LC_nested tr.LC_even_row td.LC_left_item {
5327: text-align: right;
5328: width: 40%;
5329: padding-right:10px;
5330: vertical-align: top;
5331: padding: 5px;
5332: }
5333:
5334: .ui-accordion table.LC_nested tr.LC_odd_row td.LC_right_item,
5335: .ui-accordion table.LC_nested tr.LC_even_row td.LC_right_item {
5336: text-align: left;
5337: width: 60%;
5338: padding: 2px 4px;
5339: }
5340:
1.507 raeburn 5341: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5342: background-color: #EEEEEE;
1.451 albertel 5343: }
5344:
1.473 raeburn 5345: table.LC_createuser {
5346: }
5347:
5348: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5349: font-size: small;
1.473 raeburn 5350: }
5351:
5352: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5353: background-color: #CCCCCC;
1.473 raeburn 5354: font-weight: bold;
5355: text-align: center;
5356: }
5357:
1.349 albertel 5358: table.LC_calendar {
5359: border: 1px solid #000000;
5360: border-collapse: collapse;
1.917 raeburn 5361: width: 98%;
1.349 albertel 5362: }
1.795 www 5363:
1.349 albertel 5364: table.LC_calendar_pickdate {
5365: font-size: xx-small;
5366: }
1.795 www 5367:
1.349 albertel 5368: table.LC_calendar tr td {
5369: border: 1px solid #000000;
5370: vertical-align: top;
1.917 raeburn 5371: width: 14%;
1.349 albertel 5372: }
1.795 www 5373:
1.349 albertel 5374: table.LC_calendar tr td.LC_calendar_day_empty {
5375: background-color: $data_table_dark;
5376: }
1.795 www 5377:
1.779 bisitz 5378: table.LC_calendar tr td.LC_calendar_day_current {
5379: background-color: $data_table_highlight;
1.777 tempelho 5380: }
1.795 www 5381:
1.938 bisitz 5382: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 5383: background-color: $mail_new;
5384: }
1.795 www 5385:
1.938 bisitz 5386: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 5387: background-color: $mail_new_hover;
5388: }
1.795 www 5389:
1.938 bisitz 5390: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 5391: background-color: $mail_read;
5392: }
1.795 www 5393:
1.938 bisitz 5394: /*
5395: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 5396: background-color: $mail_read_hover;
5397: }
1.938 bisitz 5398: */
1.795 www 5399:
1.938 bisitz 5400: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 5401: background-color: $mail_replied;
5402: }
1.795 www 5403:
1.938 bisitz 5404: /*
5405: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 5406: background-color: $mail_replied_hover;
5407: }
1.938 bisitz 5408: */
1.795 www 5409:
1.938 bisitz 5410: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 5411: background-color: $mail_other;
5412: }
1.795 www 5413:
1.938 bisitz 5414: /*
5415: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 5416: background-color: $mail_other_hover;
5417: }
1.938 bisitz 5418: */
1.494 raeburn 5419:
1.777 tempelho 5420: table.LC_data_table tr > td.LC_browser_file,
5421: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 5422: background: #AAEE77;
1.389 albertel 5423: }
1.795 www 5424:
1.777 tempelho 5425: table.LC_data_table tr > td.LC_browser_file_locked,
5426: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5427: background: #FFAA99;
1.387 albertel 5428: }
1.795 www 5429:
1.777 tempelho 5430: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 5431: background: #888888;
1.779 bisitz 5432: }
1.795 www 5433:
1.777 tempelho 5434: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5435: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 5436: background: #F8F866;
1.777 tempelho 5437: }
1.795 www 5438:
1.696 bisitz 5439: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 5440: background: #E0E8FF;
1.387 albertel 5441: }
1.696 bisitz 5442:
1.707 bisitz 5443: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 5444: /* background: #77FF77; */
1.707 bisitz 5445: }
1.795 www 5446:
1.707 bisitz 5447: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 5448: border-right: 8px solid #FFFF77;
1.707 bisitz 5449: }
1.795 www 5450:
1.707 bisitz 5451: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 5452: border-right: 8px solid #FFAA77;
1.707 bisitz 5453: }
1.795 www 5454:
1.707 bisitz 5455: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 5456: border-right: 8px solid #FF7777;
1.707 bisitz 5457: }
1.795 www 5458:
1.707 bisitz 5459: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 5460: border-right: 8px solid #AAFF77;
1.707 bisitz 5461: }
1.795 www 5462:
1.707 bisitz 5463: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 5464: border-right: 8px solid #11CC55;
1.707 bisitz 5465: }
5466:
1.388 albertel 5467: span.LC_current_location {
1.701 harmsja 5468: font-size:larger;
1.388 albertel 5469: background: $pgbg;
5470: }
1.387 albertel 5471:
1.395 albertel 5472: span.LC_parm_menu_item {
5473: font-size: larger;
5474: }
1.795 www 5475:
1.395 albertel 5476: span.LC_parm_scope_all {
5477: color: red;
5478: }
1.795 www 5479:
1.395 albertel 5480: span.LC_parm_scope_folder {
5481: color: green;
5482: }
1.795 www 5483:
1.395 albertel 5484: span.LC_parm_scope_resource {
5485: color: orange;
5486: }
1.795 www 5487:
1.395 albertel 5488: span.LC_parm_part {
5489: color: blue;
5490: }
1.795 www 5491:
1.911 bisitz 5492: span.LC_parm_folder,
5493: span.LC_parm_symb {
1.395 albertel 5494: font-size: x-small;
5495: font-family: $mono;
5496: color: #AAAAAA;
5497: }
5498:
1.795 www 5499: td.LC_parm_overview_level_menu,
5500: td.LC_parm_overview_map_menu,
5501: td.LC_parm_overview_parm_selectors,
5502: td.LC_parm_overview_restrictions {
1.396 albertel 5503: border: 1px solid black;
5504: border-collapse: collapse;
5505: }
1.795 www 5506:
1.396 albertel 5507: table.LC_parm_overview_restrictions td {
5508: border-width: 1px 4px 1px 4px;
5509: border-style: solid;
5510: border-color: $pgbg;
5511: text-align: center;
5512: }
1.795 www 5513:
1.396 albertel 5514: table.LC_parm_overview_restrictions th {
5515: background: $tabbg;
5516: border-width: 1px 4px 1px 4px;
5517: border-style: solid;
5518: border-color: $pgbg;
5519: }
1.795 www 5520:
1.398 albertel 5521: table#LC_helpmenu {
1.803 bisitz 5522: border: none;
1.398 albertel 5523: height: 55px;
1.803 bisitz 5524: border-spacing: 0;
1.398 albertel 5525: }
5526:
5527: table#LC_helpmenu fieldset legend {
5528: font-size: larger;
5529: }
1.795 www 5530:
1.397 albertel 5531: table#LC_helpmenu_links {
5532: width: 100%;
5533: border: 1px solid black;
5534: background: $pgbg;
1.803 bisitz 5535: padding: 0;
1.397 albertel 5536: border-spacing: 1px;
5537: }
1.795 www 5538:
1.397 albertel 5539: table#LC_helpmenu_links tr td {
5540: padding: 1px;
5541: background: $tabbg;
1.399 albertel 5542: text-align: center;
5543: font-weight: bold;
1.397 albertel 5544: }
1.396 albertel 5545:
1.795 www 5546: table#LC_helpmenu_links a:link,
5547: table#LC_helpmenu_links a:visited,
1.397 albertel 5548: table#LC_helpmenu_links a:active {
5549: text-decoration: none;
5550: color: $font;
5551: }
1.795 www 5552:
1.397 albertel 5553: table#LC_helpmenu_links a:hover {
5554: text-decoration: underline;
5555: color: $vlink;
5556: }
1.396 albertel 5557:
1.417 albertel 5558: .LC_chrt_popup_exists {
5559: border: 1px solid #339933;
5560: margin: -1px;
5561: }
1.795 www 5562:
1.417 albertel 5563: .LC_chrt_popup_up {
5564: border: 1px solid yellow;
5565: margin: -1px;
5566: }
1.795 www 5567:
1.417 albertel 5568: .LC_chrt_popup {
5569: border: 1px solid #8888FF;
5570: background: #CCCCFF;
5571: }
1.795 www 5572:
1.421 albertel 5573: table.LC_pick_box {
5574: border-collapse: separate;
5575: background: white;
5576: border: 1px solid black;
5577: border-spacing: 1px;
5578: }
1.795 www 5579:
1.421 albertel 5580: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 5581: background: $sidebg;
1.421 albertel 5582: font-weight: bold;
1.900 bisitz 5583: text-align: left;
1.740 bisitz 5584: vertical-align: top;
1.421 albertel 5585: width: 184px;
5586: padding: 8px;
5587: }
1.795 www 5588:
1.579 raeburn 5589: table.LC_pick_box td.LC_pick_box_value {
5590: text-align: left;
5591: padding: 8px;
5592: }
1.795 www 5593:
1.579 raeburn 5594: table.LC_pick_box td.LC_pick_box_select {
5595: text-align: left;
5596: padding: 8px;
5597: }
1.795 www 5598:
1.424 albertel 5599: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 5600: padding: 0;
1.421 albertel 5601: height: 1px;
5602: background: black;
5603: }
1.795 www 5604:
1.421 albertel 5605: table.LC_pick_box td.LC_pick_box_submit {
5606: text-align: right;
5607: }
1.795 www 5608:
1.579 raeburn 5609: table.LC_pick_box td.LC_evenrow_value {
5610: text-align: left;
5611: padding: 8px;
5612: background-color: $data_table_light;
5613: }
1.795 www 5614:
1.579 raeburn 5615: table.LC_pick_box td.LC_oddrow_value {
5616: text-align: left;
5617: padding: 8px;
5618: background-color: $data_table_light;
5619: }
1.795 www 5620:
1.579 raeburn 5621: span.LC_helpform_receipt_cat {
5622: font-weight: bold;
5623: }
1.795 www 5624:
1.424 albertel 5625: table.LC_group_priv_box {
5626: background: white;
5627: border: 1px solid black;
5628: border-spacing: 1px;
5629: }
1.795 www 5630:
1.424 albertel 5631: table.LC_group_priv_box td.LC_pick_box_title {
5632: background: $tabbg;
5633: font-weight: bold;
5634: text-align: right;
5635: width: 184px;
5636: }
1.795 www 5637:
1.424 albertel 5638: table.LC_group_priv_box td.LC_groups_fixed {
5639: background: $data_table_light;
5640: text-align: center;
5641: }
1.795 www 5642:
1.424 albertel 5643: table.LC_group_priv_box td.LC_groups_optional {
5644: background: $data_table_dark;
5645: text-align: center;
5646: }
1.795 www 5647:
1.424 albertel 5648: table.LC_group_priv_box td.LC_groups_functionality {
5649: background: $data_table_darker;
5650: text-align: center;
5651: font-weight: bold;
5652: }
1.795 www 5653:
1.424 albertel 5654: table.LC_group_priv td {
5655: text-align: left;
1.803 bisitz 5656: padding: 0;
1.424 albertel 5657: }
5658:
1.421 albertel 5659: table.LC_notify_front_page {
5660: background: white;
5661: border: 1px solid black;
5662: padding: 8px;
5663: }
1.795 www 5664:
1.421 albertel 5665: table.LC_notify_front_page td {
5666: padding: 8px;
5667: }
1.795 www 5668:
1.424 albertel 5669: .LC_navbuttons {
5670: margin: 2ex 0ex 2ex 0ex;
5671: }
1.795 www 5672:
1.423 albertel 5673: .LC_topic_bar {
5674: font-weight: bold;
5675: background: $tabbg;
1.918 wenzelju 5676: margin: 1em 0em 1em 2em;
1.805 bisitz 5677: padding: 3px;
1.918 wenzelju 5678: font-size: 1.2em;
1.423 albertel 5679: }
1.795 www 5680:
1.423 albertel 5681: .LC_topic_bar span {
1.918 wenzelju 5682: left: 0.5em;
5683: position: absolute;
1.423 albertel 5684: vertical-align: middle;
1.918 wenzelju 5685: font-size: 1.2em;
1.423 albertel 5686: }
1.795 www 5687:
1.423 albertel 5688: table.LC_course_group_status {
5689: margin: 20px;
5690: }
1.795 www 5691:
1.423 albertel 5692: table.LC_status_selector td {
5693: vertical-align: top;
5694: text-align: center;
1.424 albertel 5695: padding: 4px;
5696: }
1.795 www 5697:
1.599 albertel 5698: div.LC_feedback_link {
1.616 albertel 5699: clear: both;
1.829 kalberla 5700: background: $sidebg;
1.779 bisitz 5701: width: 100%;
1.829 kalberla 5702: padding-bottom: 10px;
5703: border: 1px $tabbg solid;
1.833 kalberla 5704: height: 22px;
5705: line-height: 22px;
5706: padding-top: 5px;
5707: }
5708:
5709: div.LC_feedback_link img {
5710: height: 22px;
1.867 kalberla 5711: vertical-align:middle;
1.829 kalberla 5712: }
5713:
1.911 bisitz 5714: div.LC_feedback_link a {
1.829 kalberla 5715: text-decoration: none;
1.489 raeburn 5716: }
1.795 www 5717:
1.867 kalberla 5718: div.LC_comblock {
1.911 bisitz 5719: display:inline;
1.867 kalberla 5720: color:$font;
5721: font-size:90%;
5722: }
5723:
5724: div.LC_feedback_link div.LC_comblock {
5725: padding-left:5px;
5726: }
5727:
5728: div.LC_feedback_link div.LC_comblock a {
5729: color:$font;
5730: }
5731:
1.489 raeburn 5732: span.LC_feedback_link {
1.858 bisitz 5733: /* background: $feedback_link_bg; */
1.599 albertel 5734: font-size: larger;
5735: }
1.795 www 5736:
1.599 albertel 5737: span.LC_message_link {
1.858 bisitz 5738: /* background: $feedback_link_bg; */
1.599 albertel 5739: font-size: larger;
5740: position: absolute;
5741: right: 1em;
1.489 raeburn 5742: }
1.421 albertel 5743:
1.515 albertel 5744: table.LC_prior_tries {
1.524 albertel 5745: border: 1px solid #000000;
5746: border-collapse: separate;
5747: border-spacing: 1px;
1.515 albertel 5748: }
1.523 albertel 5749:
1.515 albertel 5750: table.LC_prior_tries td {
1.524 albertel 5751: padding: 2px;
1.515 albertel 5752: }
1.523 albertel 5753:
5754: .LC_answer_correct {
1.795 www 5755: background: lightgreen;
5756: color: darkgreen;
5757: padding: 6px;
1.523 albertel 5758: }
1.795 www 5759:
1.523 albertel 5760: .LC_answer_charged_try {
1.797 www 5761: background: #FFAAAA;
1.795 www 5762: color: darkred;
5763: padding: 6px;
1.523 albertel 5764: }
1.795 www 5765:
1.779 bisitz 5766: .LC_answer_not_charged_try,
1.523 albertel 5767: .LC_answer_no_grade,
5768: .LC_answer_late {
1.795 www 5769: background: lightyellow;
1.523 albertel 5770: color: black;
1.795 www 5771: padding: 6px;
1.523 albertel 5772: }
1.795 www 5773:
1.523 albertel 5774: .LC_answer_previous {
1.795 www 5775: background: lightblue;
5776: color: darkblue;
5777: padding: 6px;
1.523 albertel 5778: }
1.795 www 5779:
1.779 bisitz 5780: .LC_answer_no_message {
1.777 tempelho 5781: background: #FFFFFF;
5782: color: black;
1.795 www 5783: padding: 6px;
1.779 bisitz 5784: }
1.795 www 5785:
1.779 bisitz 5786: .LC_answer_unknown {
5787: background: orange;
5788: color: black;
1.795 www 5789: padding: 6px;
1.777 tempelho 5790: }
1.795 www 5791:
1.529 albertel 5792: span.LC_prior_numerical,
5793: span.LC_prior_string,
5794: span.LC_prior_custom,
5795: span.LC_prior_reaction,
5796: span.LC_prior_math {
1.925 bisitz 5797: font-family: $mono;
1.523 albertel 5798: white-space: pre;
5799: }
5800:
1.525 albertel 5801: span.LC_prior_string {
1.925 bisitz 5802: font-family: $mono;
1.525 albertel 5803: white-space: pre;
5804: }
5805:
1.523 albertel 5806: table.LC_prior_option {
5807: width: 100%;
5808: border-collapse: collapse;
5809: }
1.795 www 5810:
1.911 bisitz 5811: table.LC_prior_rank,
1.795 www 5812: table.LC_prior_match {
1.528 albertel 5813: border-collapse: collapse;
5814: }
1.795 www 5815:
1.528 albertel 5816: table.LC_prior_option tr td,
5817: table.LC_prior_rank tr td,
5818: table.LC_prior_match tr td {
1.524 albertel 5819: border: 1px solid #000000;
1.515 albertel 5820: }
5821:
1.855 bisitz 5822: .LC_nobreak {
1.544 albertel 5823: white-space: nowrap;
1.519 raeburn 5824: }
5825:
1.576 raeburn 5826: span.LC_cusr_emph {
5827: font-style: italic;
5828: }
5829:
1.633 raeburn 5830: span.LC_cusr_subheading {
5831: font-weight: normal;
5832: font-size: 85%;
5833: }
5834:
1.861 bisitz 5835: div.LC_docs_entry_move {
1.859 bisitz 5836: border: 1px solid #BBBBBB;
1.545 albertel 5837: background: #DDDDDD;
1.861 bisitz 5838: width: 22px;
1.859 bisitz 5839: padding: 1px;
5840: margin: 0;
1.545 albertel 5841: }
5842:
1.861 bisitz 5843: table.LC_data_table tr > td.LC_docs_entry_commands,
5844: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 5845: background: #DDDDDD;
5846: font-size: x-small;
5847: }
1.795 www 5848:
1.861 bisitz 5849: .LC_docs_entry_parameter {
5850: white-space: nowrap;
5851: }
5852:
1.544 albertel 5853: .LC_docs_copy {
1.545 albertel 5854: color: #000099;
1.544 albertel 5855: }
1.795 www 5856:
1.544 albertel 5857: .LC_docs_cut {
1.545 albertel 5858: color: #550044;
1.544 albertel 5859: }
1.795 www 5860:
1.544 albertel 5861: .LC_docs_rename {
1.545 albertel 5862: color: #009900;
1.544 albertel 5863: }
1.795 www 5864:
1.544 albertel 5865: .LC_docs_remove {
1.545 albertel 5866: color: #990000;
5867: }
5868:
1.547 albertel 5869: .LC_docs_reinit_warn,
5870: .LC_docs_ext_edit {
5871: font-size: x-small;
5872: }
5873:
1.545 albertel 5874: table.LC_docs_adddocs td,
5875: table.LC_docs_adddocs th {
5876: border: 1px solid #BBBBBB;
5877: padding: 4px;
5878: background: #DDDDDD;
1.543 albertel 5879: }
5880:
1.584 albertel 5881: table.LC_sty_begin {
5882: background: #BBFFBB;
5883: }
1.795 www 5884:
1.584 albertel 5885: table.LC_sty_end {
5886: background: #FFBBBB;
5887: }
5888:
1.589 raeburn 5889: table.LC_double_column {
1.803 bisitz 5890: border-width: 0;
1.589 raeburn 5891: border-collapse: collapse;
5892: width: 100%;
5893: padding: 2px;
5894: }
5895:
5896: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5897: top: 2px;
1.589 raeburn 5898: left: 2px;
5899: width: 47%;
5900: vertical-align: top;
5901: }
5902:
5903: table.LC_double_column tr td.LC_right_col {
5904: top: 2px;
1.779 bisitz 5905: right: 2px;
1.589 raeburn 5906: width: 47%;
5907: vertical-align: top;
5908: }
5909:
1.591 raeburn 5910: div.LC_left_float {
5911: float: left;
5912: padding-right: 5%;
1.597 albertel 5913: padding-bottom: 4px;
1.591 raeburn 5914: }
5915:
5916: div.LC_clear_float_header {
1.597 albertel 5917: padding-bottom: 2px;
1.591 raeburn 5918: }
5919:
5920: div.LC_clear_float_footer {
1.597 albertel 5921: padding-top: 10px;
1.591 raeburn 5922: clear: both;
5923: }
5924:
1.597 albertel 5925: div.LC_grade_show_user {
1.941 bisitz 5926: /* border-left: 5px solid $sidebg; */
5927: border-top: 5px solid #000000;
5928: margin: 50px 0 0 0;
1.936 bisitz 5929: padding: 15px 0 5px 10px;
1.597 albertel 5930: }
1.795 www 5931:
1.936 bisitz 5932: div.LC_grade_show_user_odd_row {
1.941 bisitz 5933: /* border-left: 5px solid #000000; */
5934: }
5935:
5936: div.LC_grade_show_user div.LC_Box {
5937: margin-right: 50px;
1.597 albertel 5938: }
5939:
5940: div.LC_grade_submissions,
5941: div.LC_grade_message_center,
1.936 bisitz 5942: div.LC_grade_info_links {
1.597 albertel 5943: margin: 5px;
5944: width: 99%;
5945: background: #FFFFFF;
5946: }
1.795 www 5947:
1.597 albertel 5948: div.LC_grade_submissions_header,
1.936 bisitz 5949: div.LC_grade_message_center_header {
1.705 tempelho 5950: font-weight: bold;
5951: font-size: large;
1.597 albertel 5952: }
1.795 www 5953:
1.597 albertel 5954: div.LC_grade_submissions_body,
1.936 bisitz 5955: div.LC_grade_message_center_body {
1.597 albertel 5956: border: 1px solid black;
5957: width: 99%;
5958: background: #FFFFFF;
5959: }
1.795 www 5960:
1.613 albertel 5961: table.LC_scantron_action {
5962: width: 100%;
5963: }
1.795 www 5964:
1.613 albertel 5965: table.LC_scantron_action tr th {
1.698 harmsja 5966: font-weight:bold;
5967: font-style:normal;
1.613 albertel 5968: }
1.795 www 5969:
1.779 bisitz 5970: .LC_edit_problem_header,
1.614 albertel 5971: div.LC_edit_problem_footer {
1.705 tempelho 5972: font-weight: normal;
5973: font-size: medium;
1.602 albertel 5974: margin: 2px;
1.600 albertel 5975: }
1.795 www 5976:
1.600 albertel 5977: div.LC_edit_problem_header,
1.602 albertel 5978: div.LC_edit_problem_header div,
1.614 albertel 5979: div.LC_edit_problem_footer,
5980: div.LC_edit_problem_footer div,
1.602 albertel 5981: div.LC_edit_problem_editxml_header,
5982: div.LC_edit_problem_editxml_header div {
1.600 albertel 5983: margin-top: 5px;
5984: }
1.795 www 5985:
1.600 albertel 5986: div.LC_edit_problem_header_title {
1.705 tempelho 5987: font-weight: bold;
5988: font-size: larger;
1.602 albertel 5989: background: $tabbg;
5990: padding: 3px;
5991: }
1.795 www 5992:
1.602 albertel 5993: table.LC_edit_problem_header_title {
5994: width: 100%;
1.600 albertel 5995: background: $tabbg;
1.602 albertel 5996: }
5997:
5998: div.LC_edit_problem_discards {
5999: float: left;
6000: padding-bottom: 5px;
6001: }
1.795 www 6002:
1.602 albertel 6003: div.LC_edit_problem_saves {
6004: float: right;
6005: padding-bottom: 5px;
1.600 albertel 6006: }
1.795 www 6007:
1.911 bisitz 6008: img.stift {
1.803 bisitz 6009: border-width: 0;
6010: vertical-align: middle;
1.677 riegler 6011: }
1.680 riegler 6012:
1.923 bisitz 6013: table td.LC_mainmenu_col_fieldset {
1.680 riegler 6014: vertical-align: top;
1.777 tempelho 6015: }
1.795 www 6016:
1.716 raeburn 6017: div.LC_createcourse {
1.911 bisitz 6018: margin: 10px 10px 10px 10px;
1.716 raeburn 6019: }
6020:
1.917 raeburn 6021: .LC_dccid {
6022: margin: 0.2em 0 0 0;
6023: padding: 0;
6024: font-size: 90%;
6025: display:none;
6026: }
6027:
1.698 harmsja 6028: a:hover,
1.897 wenzelju 6029: ol.LC_primary_menu a:hover,
1.721 harmsja 6030: ol#LC_MenuBreadcrumbs a:hover,
6031: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 6032: ul#LC_secondary_menu a:hover,
1.721 harmsja 6033: .LC_FormSectionClearButton input:hover
1.795 www 6034: ul.LC_TabContent li:hover a {
1.948.2.1 raeburn 6035: color:$button_hover;
1.911 bisitz 6036: text-decoration:none;
1.693 droeschl 6037: }
6038:
1.779 bisitz 6039: h1 {
1.911 bisitz 6040: padding: 0;
6041: line-height:130%;
1.693 droeschl 6042: }
1.698 harmsja 6043:
1.911 bisitz 6044: h2,
6045: h3,
6046: h4,
6047: h5,
6048: h6 {
6049: margin: 5px 0 5px 0;
6050: padding: 0;
6051: line-height:130%;
1.693 droeschl 6052: }
1.795 www 6053:
6054: .LC_hcell {
1.911 bisitz 6055: padding:3px 15px 3px 15px;
6056: margin: 0;
6057: background-color:$tabbg;
6058: color:$fontmenu;
6059: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 6060: }
1.795 www 6061:
1.840 bisitz 6062: .LC_Box > .LC_hcell {
1.911 bisitz 6063: margin: 0 -10px 10px -10px;
1.835 bisitz 6064: }
6065:
1.721 harmsja 6066: .LC_noBorder {
1.911 bisitz 6067: border: 0;
1.698 harmsja 6068: }
1.693 droeschl 6069:
1.721 harmsja 6070: .LC_FormSectionClearButton input {
1.911 bisitz 6071: background-color:transparent;
6072: border: none;
6073: cursor:pointer;
6074: text-decoration:underline;
1.693 droeschl 6075: }
1.763 bisitz 6076:
6077: .LC_help_open_topic {
1.911 bisitz 6078: color: #FFFFFF;
6079: background-color: #EEEEFF;
6080: margin: 1px;
6081: padding: 4px;
6082: border: 1px solid #000033;
6083: white-space: nowrap;
6084: /* vertical-align: middle; */
1.759 neumanie 6085: }
1.693 droeschl 6086:
1.911 bisitz 6087: dl,
6088: ul,
6089: div,
6090: fieldset {
6091: margin: 10px 10px 10px 0;
6092: /* overflow: hidden; */
1.693 droeschl 6093: }
1.795 www 6094:
1.838 bisitz 6095: fieldset > legend {
1.911 bisitz 6096: font-weight: bold;
6097: padding: 0 5px 0 5px;
1.838 bisitz 6098: }
6099:
1.813 bisitz 6100: #LC_nav_bar {
1.911 bisitz 6101: float: left;
1.934 droeschl 6102: margin: 0;
1.807 droeschl 6103: }
6104:
1.916 droeschl 6105: #LC_realm {
6106: margin: 0.2em 0 0 0;
6107: padding: 0;
6108: font-weight: bold;
6109: text-align: center;
6110: }
6111:
1.911 bisitz 6112: #LC_nav_bar em {
6113: font-weight: bold;
6114: font-style: normal;
1.807 droeschl 6115: }
6116:
1.897 wenzelju 6117: ol.LC_primary_menu {
1.911 bisitz 6118: float: right;
1.934 droeschl 6119: margin: 0;
1.807 droeschl 6120: }
6121:
1.929 wenzelju 6122: span.LC_new_message{
6123: font-weight:bold;
6124: color: darkred;
6125: }
6126:
1.852 droeschl 6127: ol#LC_PathBreadcrumbs {
1.911 bisitz 6128: margin: 0;
1.693 droeschl 6129: }
6130:
1.897 wenzelju 6131: ol.LC_primary_menu li {
1.911 bisitz 6132: display: inline;
6133: padding: 5px 5px 0 10px;
6134: vertical-align: top;
1.693 droeschl 6135: }
6136:
1.897 wenzelju 6137: ol.LC_primary_menu li img {
1.911 bisitz 6138: vertical-align: bottom;
1.934 droeschl 6139: height: 1.1em;
1.693 droeschl 6140: }
6141:
1.897 wenzelju 6142: ol.LC_primary_menu a {
1.911 bisitz 6143: color: RGB(80, 80, 80);
6144: text-decoration: none;
1.693 droeschl 6145: }
1.795 www 6146:
1.897 wenzelju 6147: ul#LC_secondary_menu {
1.911 bisitz 6148: clear: both;
6149: color: $fontmenu;
6150: background: $tabbg;
6151: list-style: none;
6152: padding: 0;
6153: margin: 0;
6154: width: 100%;
1.808 droeschl 6155: }
6156:
1.897 wenzelju 6157: ul#LC_secondary_menu li {
1.911 bisitz 6158: font-weight: bold;
6159: line-height: 1.8em;
6160: padding: 0 0.8em;
6161: border-right: 1px solid black;
6162: display: inline;
6163: vertical-align: middle;
1.807 droeschl 6164: }
6165:
1.847 tempelho 6166: ul.LC_TabContent {
1.911 bisitz 6167: display:block;
6168: background: $sidebg;
6169: border-bottom: solid 1px $lg_border_color;
6170: list-style:none;
6171: margin: 0 -10px;
6172: padding: 0;
1.693 droeschl 6173: }
6174:
1.795 www 6175: ul.LC_TabContent li,
6176: ul.LC_TabContentBigger li {
1.911 bisitz 6177: float:left;
1.741 harmsja 6178: }
1.795 www 6179:
1.897 wenzelju 6180: ul#LC_secondary_menu li a {
1.911 bisitz 6181: color: $fontmenu;
6182: text-decoration: none;
1.693 droeschl 6183: }
1.795 www 6184:
1.721 harmsja 6185: ul.LC_TabContent {
1.948.2.1 raeburn 6186: min-height:20px;
1.721 harmsja 6187: }
1.795 www 6188:
6189: ul.LC_TabContent li {
1.911 bisitz 6190: vertical-align:middle;
1.948.2.3 raeburn 6191: padding: 0 16px 0 10px;
1.911 bisitz 6192: background-color:$tabbg;
6193: border-bottom:solid 1px $lg_border_color;
1.948.2.1 raeburn 6194: border-right: solid 1px $font;
1.721 harmsja 6195: }
1.795 www 6196:
1.847 tempelho 6197: ul.LC_TabContent .right {
1.911 bisitz 6198: float:right;
1.847 tempelho 6199: }
6200:
1.911 bisitz 6201: ul.LC_TabContent li a,
6202: ul.LC_TabContent li {
6203: color:rgb(47,47,47);
6204: text-decoration:none;
6205: font-size:95%;
6206: font-weight:bold;
1.948.2.1 raeburn 6207: min-height:20px;
6208: }
6209:
1.948.2.3 raeburn 6210: ul.LC_TabContent li a:hover,
6211: ul.LC_TabContent li a:focus {
1.948.2.1 raeburn 6212: color: $button_hover;
1.948.2.3 raeburn 6213: background:none;
6214: outline:none;
1.948.2.1 raeburn 6215: }
6216:
6217: ul.LC_TabContent li:hover {
6218: color: $button_hover;
6219: cursor:pointer;
1.721 harmsja 6220: }
1.795 www 6221:
1.911 bisitz 6222: ul.LC_TabContent li.active {
1.948.2.1 raeburn 6223: color: $font;
1.911 bisitz 6224: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.948.2.1 raeburn 6225: border-bottom:solid 1px #FFFFFF;
6226: cursor: default;
1.744 ehlerst 6227: }
1.795 www 6228:
1.948.2.3 raeburn 6229: ul.LC_TabContent li.active a {
6230: color:$font;
6231: background:#FFFFFF;
6232: outline: none;
6233: }
1.870 tempelho 6234: #maincoursedoc {
1.911 bisitz 6235: clear:both;
1.870 tempelho 6236: }
6237:
6238: ul.LC_TabContentBigger {
1.911 bisitz 6239: display:block;
6240: list-style:none;
6241: padding: 0;
1.870 tempelho 6242: }
6243:
1.795 www 6244: ul.LC_TabContentBigger li {
1.911 bisitz 6245: vertical-align:bottom;
6246: height: 30px;
6247: font-size:110%;
6248: font-weight:bold;
6249: color: #737373;
1.841 tempelho 6250: }
6251:
1.948.2.3 raeburn 6252: ul.LC_TabContentBigger li.active {
6253: position: relative;
6254: top: 1px;
6255: }
1.870 tempelho 6256:
6257: ul.LC_TabContentBigger li a {
1.911 bisitz 6258: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6259: height: 30px;
6260: line-height: 30px;
6261: text-align: center;
6262: display: block;
6263: text-decoration: none;
1.948.2.3 raeburn 6264: outline: none;
1.741 harmsja 6265: }
1.795 www 6266:
1.870 tempelho 6267: ul.LC_TabContentBigger li.active a {
1.911 bisitz 6268: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6269: color:$font;
1.744 ehlerst 6270: }
1.795 www 6271:
1.870 tempelho 6272: ul.LC_TabContentBigger li b {
1.911 bisitz 6273: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
6274: display: block;
6275: float: left;
6276: padding: 0 30px;
1.948.2.3 raeburn 6277: border-bottom: 1px solid $lg_border_color;
6278: }
6279:
6280: ul.LC_TabContentBigger li:hover b {
6281: color:$button_hover;
1.870 tempelho 6282: }
6283:
6284: ul.LC_TabContentBigger li.active b {
1.911 bisitz 6285: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
6286: color:$font;
1.948.2.3 raeburn 6287: border: 0;
6288: cursor:default;
1.741 harmsja 6289: }
1.693 droeschl 6290:
1.862 bisitz 6291: ul.LC_CourseBreadcrumbs {
6292: background: $sidebg;
6293: line-height: 32px;
6294: padding-left: 10px;
6295: margin: 0 0 10px 0;
6296: list-style-position: inside;
6297:
6298: }
6299:
1.911 bisitz 6300: ol#LC_MenuBreadcrumbs,
1.862 bisitz 6301: ol#LC_PathBreadcrumbs {
1.911 bisitz 6302: padding-left: 10px;
6303: margin: 0;
1.933 droeschl 6304: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 6305: }
6306:
1.911 bisitz 6307: ol#LC_MenuBreadcrumbs li,
6308: ol#LC_PathBreadcrumbs li,
1.862 bisitz 6309: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 6310: display: inline;
1.933 droeschl 6311: white-space: normal;
1.693 droeschl 6312: }
6313:
1.823 bisitz 6314: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 6315: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 6316: text-decoration: none;
6317: font-size:90%;
1.693 droeschl 6318: }
1.795 www 6319:
6320: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 6321: text-decoration:none;
6322: font-size:100%;
6323: font-weight:bold;
1.693 droeschl 6324: }
1.795 www 6325:
1.840 bisitz 6326: .LC_Box {
1.911 bisitz 6327: border: solid 1px $lg_border_color;
6328: padding: 0 10px 10px 10px;
1.746 neumanie 6329: }
1.795 www 6330:
6331: .LC_AboutMe_Image {
1.911 bisitz 6332: float:left;
6333: margin-right:10px;
1.747 neumanie 6334: }
1.795 www 6335:
6336: .LC_Clear_AboutMe_Image {
1.911 bisitz 6337: clear:left;
1.747 neumanie 6338: }
1.795 www 6339:
1.721 harmsja 6340: dl.LC_ListStyleClean dt {
1.911 bisitz 6341: padding-right: 5px;
6342: display: table-header-group;
1.693 droeschl 6343: }
6344:
1.721 harmsja 6345: dl.LC_ListStyleClean dd {
1.911 bisitz 6346: display: table-row;
1.693 droeschl 6347: }
6348:
1.721 harmsja 6349: .LC_ListStyleClean,
6350: .LC_ListStyleSimple,
6351: .LC_ListStyleNormal,
1.795 www 6352: .LC_ListStyleSpecial {
1.911 bisitz 6353: /* display:block; */
6354: list-style-position: inside;
6355: list-style-type: none;
6356: overflow: hidden;
6357: padding: 0;
1.693 droeschl 6358: }
6359:
1.721 harmsja 6360: .LC_ListStyleSimple li,
6361: .LC_ListStyleSimple dd,
6362: .LC_ListStyleNormal li,
6363: .LC_ListStyleNormal dd,
6364: .LC_ListStyleSpecial li,
1.795 www 6365: .LC_ListStyleSpecial dd {
1.911 bisitz 6366: margin: 0;
6367: padding: 5px 5px 5px 10px;
6368: clear: both;
1.693 droeschl 6369: }
6370:
1.721 harmsja 6371: .LC_ListStyleClean li,
6372: .LC_ListStyleClean dd {
1.911 bisitz 6373: padding-top: 0;
6374: padding-bottom: 0;
1.693 droeschl 6375: }
6376:
1.721 harmsja 6377: .LC_ListStyleSimple dd,
1.795 www 6378: .LC_ListStyleSimple li {
1.911 bisitz 6379: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6380: }
6381:
1.721 harmsja 6382: .LC_ListStyleSpecial li,
6383: .LC_ListStyleSpecial dd {
1.911 bisitz 6384: list-style-type: none;
6385: background-color: RGB(220, 220, 220);
6386: margin-bottom: 4px;
1.693 droeschl 6387: }
6388:
1.721 harmsja 6389: table.LC_SimpleTable {
1.911 bisitz 6390: margin:5px;
6391: border:solid 1px $lg_border_color;
1.795 www 6392: }
1.693 droeschl 6393:
1.721 harmsja 6394: table.LC_SimpleTable tr {
1.911 bisitz 6395: padding: 0;
6396: border:solid 1px $lg_border_color;
1.693 droeschl 6397: }
1.795 www 6398:
6399: table.LC_SimpleTable thead {
1.911 bisitz 6400: background:rgb(220,220,220);
1.693 droeschl 6401: }
6402:
1.721 harmsja 6403: div.LC_columnSection {
1.911 bisitz 6404: display: block;
6405: clear: both;
6406: overflow: hidden;
6407: margin: 0;
1.693 droeschl 6408: }
6409:
1.721 harmsja 6410: div.LC_columnSection>* {
1.911 bisitz 6411: float: left;
6412: margin: 10px 20px 10px 0;
6413: overflow:hidden;
1.693 droeschl 6414: }
1.721 harmsja 6415:
1.694 tempelho 6416: .LC_loginpage_container {
1.911 bisitz 6417: text-align:left;
6418: margin : 0 auto;
6419: width:90%;
6420: padding: 10px;
6421: height: auto;
6422: background-color:#FFFFFF;
6423: border:1px solid #CCCCCC;
1.694 tempelho 6424: }
6425:
6426:
6427: .LC_loginpage_loginContainer {
1.911 bisitz 6428: float:left;
6429: width: 182px;
6430: padding: 2px;
6431: border:1px solid #CCCCCC;
6432: background-color:$loginbg;
1.694 tempelho 6433: }
6434:
1.795 www 6435: .LC_loginpage_loginContainer h2 {
1.911 bisitz 6436: margin-top: 0;
6437: display:block;
6438: background:$bgcol;
6439: color:$textcol;
6440: padding-left:5px;
1.712 muellerd 6441: }
1.785 tempelho 6442:
1.694 tempelho 6443: .LC_loginpage_loginInfo {
1.911 bisitz 6444: float:left;
6445: width:182px;
6446: border:1px solid #CCCCCC;
6447: padding:2px;
1.712 muellerd 6448: }
6449:
1.694 tempelho 6450: .LC_loginpage_space {
1.911 bisitz 6451: clear: both;
6452: margin-bottom: 20px;
6453: border-bottom: 1px solid #CCCCCC;
1.694 tempelho 6454: }
6455:
1.785 tempelho 6456: .LC_loginpage_floatLeft {
1.911 bisitz 6457: float: left;
6458: width: 200px;
6459: margin: 0;
1.785 tempelho 6460: }
6461:
1.795 www 6462: table em {
1.911 bisitz 6463: font-weight: bold;
6464: font-style: normal;
1.748 schulted 6465: }
1.795 www 6466:
1.779 bisitz 6467: table.LC_tableBrowseRes,
1.795 www 6468: table.LC_tableOfContent {
1.911 bisitz 6469: border:none;
6470: border-spacing: 1px;
6471: padding: 3px;
6472: background-color: #FFFFFF;
6473: font-size: 90%;
1.753 droeschl 6474: }
1.789 droeschl 6475:
1.911 bisitz 6476: table.LC_tableOfContent {
6477: border-collapse: collapse;
1.789 droeschl 6478: }
6479:
1.771 droeschl 6480: table.LC_tableBrowseRes a,
1.768 schulted 6481: table.LC_tableOfContent a {
1.911 bisitz 6482: background-color: transparent;
6483: text-decoration: none;
1.753 droeschl 6484: }
6485:
1.795 www 6486: table.LC_tableOfContent img {
1.911 bisitz 6487: border: none;
6488: height: 1.3em;
6489: vertical-align: text-bottom;
6490: margin-right: 0.3em;
1.753 droeschl 6491: }
1.757 schulted 6492:
1.795 www 6493: a#LC_content_toolbar_firsthomework {
1.911 bisitz 6494: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 6495: }
6496:
1.795 www 6497: a#LC_content_toolbar_launchnav {
1.911 bisitz 6498: background-image:url(/res/adm/pages/start-navigation.gif);
1.774 ehlerst 6499: }
6500:
1.795 www 6501: a#LC_content_toolbar_closenav {
1.911 bisitz 6502: background-image:url(/res/adm/pages/close-navigation.gif);
1.774 ehlerst 6503: }
6504:
1.795 www 6505: a#LC_content_toolbar_everything {
1.911 bisitz 6506: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 6507: }
6508:
1.795 www 6509: a#LC_content_toolbar_uncompleted {
1.911 bisitz 6510: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 6511: }
6512:
1.795 www 6513: #LC_content_toolbar_clearbubbles {
1.911 bisitz 6514: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 6515: }
6516:
1.795 www 6517: a#LC_content_toolbar_changefolder {
1.911 bisitz 6518: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 6519: }
6520:
1.795 www 6521: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 6522: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 6523: }
6524:
1.795 www 6525: ul#LC_toolbar li a:hover {
1.911 bisitz 6526: background-position: bottom center;
1.757 schulted 6527: }
6528:
1.795 www 6529: ul#LC_toolbar {
1.911 bisitz 6530: padding: 0;
6531: margin: 2px;
6532: list-style:none;
6533: position:relative;
6534: background-color:white;
1.757 schulted 6535: }
6536:
1.795 www 6537: ul#LC_toolbar li {
1.911 bisitz 6538: border:1px solid white;
6539: padding: 0;
6540: margin: 0;
6541: float: left;
6542: display:inline;
6543: vertical-align:middle;
6544: }
1.757 schulted 6545:
1.783 amueller 6546:
1.795 www 6547: a.LC_toolbarItem {
1.911 bisitz 6548: display:block;
6549: padding: 0;
6550: margin: 0;
6551: height: 32px;
6552: width: 32px;
6553: color:white;
6554: border: none;
6555: background-repeat:no-repeat;
6556: background-color:transparent;
1.757 schulted 6557: }
6558:
1.915 droeschl 6559: ul.LC_funclist {
6560: margin: 0;
6561: padding: 0.5em 1em 0.5em 0;
6562: }
6563:
1.933 droeschl 6564: ul.LC_funclist > li:first-child {
6565: font-weight:bold;
6566: margin-left:0.8em;
6567: }
6568:
1.915 droeschl 6569: ul.LC_funclist + ul.LC_funclist {
6570: /*
6571: left border as a seperator if we have more than
6572: one list
6573: */
6574: border-left: 1px solid $sidebg;
6575: /*
6576: this hides the left border behind the border of the
6577: outer box if element is wrapped to the next 'line'
6578: */
6579: margin-left: -1px;
6580: }
6581:
1.843 bisitz 6582: ul.LC_funclist li {
1.915 droeschl 6583: display: inline;
1.782 bisitz 6584: white-space: nowrap;
1.915 droeschl 6585: margin: 0 0 0 25px;
6586: line-height: 150%;
1.782 bisitz 6587: }
6588:
1.930 faziophi 6589: .ui-accordion .LC_advanced_toggle {
6590: float: right;
6591: font-size: 90%;
6592: padding: 0px 4px
6593: }
1.757 schulted 6594:
1.343 albertel 6595: END
6596: }
6597:
1.306 albertel 6598: =pod
6599:
6600: =item * &headtag()
6601:
6602: Returns a uniform footer for LON-CAPA web pages.
6603:
1.307 albertel 6604: Inputs: $title - optional title for the head
6605: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 6606: $args - optional arguments
1.319 albertel 6607: force_register - if is true call registerurl so the remote is
6608: informed
1.415 albertel 6609: redirect -> array ref of
6610: 1- seconds before redirect occurs
6611: 2- url to redirect to
6612: 3- whether the side effect should occur
1.315 albertel 6613: (side effect of setting
6614: $env{'internal.head.redirect'} to the url
6615: redirected too)
1.352 albertel 6616: domain -> force to color decorate a page for a specific
6617: domain
6618: function -> force usage of a specific rolish color scheme
6619: bgcolor -> override the default page bgcolor
1.460 albertel 6620: no_auto_mt_title
6621: -> prevent &mt()ing the title arg
1.464 albertel 6622:
1.306 albertel 6623: =cut
6624:
6625: sub headtag {
1.313 albertel 6626: my ($title,$head_extra,$args) = @_;
1.306 albertel 6627:
1.363 albertel 6628: my $function = $args->{'function'} || &get_users_function();
6629: my $domain = $args->{'domain'} || &determinedomain();
6630: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 6631: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 6632: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 6633: #time(),
1.418 albertel 6634: $env{'environment.color.timestamp'},
1.363 albertel 6635: $function,$domain,$bgcolor);
6636:
1.369 www 6637: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 6638:
1.308 albertel 6639: my $result =
6640: '<head>'.
1.461 albertel 6641: &font_settings();
1.319 albertel 6642:
1.461 albertel 6643: if (!$args->{'frameset'}) {
6644: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
6645: }
1.319 albertel 6646: if ($args->{'force_register'}) {
6647: $result .= &Apache::lonmenu::registerurl(1);
6648: }
1.436 albertel 6649: if (!$args->{'no_nav_bar'}
6650: && !$args->{'only_body'}
6651: && !$args->{'frameset'}) {
6652: $result .= &help_menu_js();
6653: }
1.319 albertel 6654:
1.314 albertel 6655: if (ref($args->{'redirect'})) {
1.414 albertel 6656: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 6657: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 6658: if (!$inhibit_continue) {
6659: $env{'internal.head.redirect'} = $url;
6660: }
1.313 albertel 6661: $result.=<<ADDMETA
6662: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 6663: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 6664: ADDMETA
6665: }
1.306 albertel 6666: if (!defined($title)) {
6667: $title = 'The LearningOnline Network with CAPA';
6668: }
1.460 albertel 6669: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
6670: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 6671: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
6672: .$head_extra;
1.306 albertel 6673: return $result;
6674: }
6675:
6676: =pod
6677:
1.340 albertel 6678: =item * &font_settings()
6679:
6680: Returns neccessary <meta> to set the proper encoding
6681:
6682: Inputs: none
6683:
6684: =cut
6685:
6686: sub font_settings {
6687: my $headerstring='';
1.647 www 6688: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 6689: $headerstring.=
6690: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
6691: }
6692: return $headerstring;
6693: }
6694:
1.341 albertel 6695: =pod
6696:
6697: =item * &xml_begin()
6698:
6699: Returns the needed doctype and <html>
6700:
6701: Inputs: none
6702:
6703: =cut
6704:
6705: sub xml_begin {
6706: my $output='';
6707:
1.592 albertel 6708: if ($env{'internal.start_page'}==1) {
6709: &Apache::lonhtmlcommon::init_htmlareafields();
6710: }
1.342 albertel 6711:
1.341 albertel 6712: if ($env{'browser.mathml'}) {
6713: $output='<?xml version="1.0"?>'
6714: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
6715: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
6716:
6717: # .'<!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">] >'
6718: .'<!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">'
6719: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
6720: .'xmlns="http://www.w3.org/1999/xhtml">';
6721: } else {
1.849 bisitz 6722: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
6723: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341 albertel 6724: }
6725: return $output;
6726: }
1.340 albertel 6727:
6728: =pod
6729:
1.306 albertel 6730: =item * &endheadtag()
6731:
6732: Returns a uniform </head> for LON-CAPA web pages.
6733:
6734: Inputs: none
6735:
6736: =cut
6737:
6738: sub endheadtag {
6739: return '</head>';
6740: }
6741:
6742: =pod
6743:
6744: =item * &head()
6745:
6746: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
6747:
1.648 raeburn 6748: Inputs:
6749:
6750: =over 4
6751:
6752: $title - optional title for the page
6753:
6754: $head_extra - optional extra HTML to put inside the <head>
6755:
6756: =back
1.405 albertel 6757:
1.306 albertel 6758: =cut
6759:
6760: sub head {
1.325 albertel 6761: my ($title,$head_extra,$args) = @_;
6762: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 6763: }
6764:
6765: =pod
6766:
6767: =item * &start_page()
6768:
6769: Returns a complete <html> .. <body> section for LON-CAPA web pages.
6770:
1.648 raeburn 6771: Inputs:
6772:
6773: =over 4
6774:
6775: $title - optional title for the page
6776:
6777: $head_extra - optional extra HTML to incude inside the <head>
6778:
6779: $args - additional optional args supported are:
6780:
6781: =over 8
6782:
6783: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 6784: arg on
1.814 bisitz 6785: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 6786: add_entries -> additional attributes to add to the <body>
6787: domain -> force to color decorate a page for a
1.317 albertel 6788: specific domain
1.648 raeburn 6789: function -> force usage of a specific rolish color
1.317 albertel 6790: scheme
1.648 raeburn 6791: redirect -> see &headtag()
6792: bgcolor -> override the default page bg color
6793: js_ready -> return a string ready for being used in
1.317 albertel 6794: a javascript writeln
1.648 raeburn 6795: html_encode -> return a string ready for being used in
1.320 albertel 6796: a html attribute
1.648 raeburn 6797: force_register -> if is true will turn on the &bodytag()
1.317 albertel 6798: $forcereg arg
1.648 raeburn 6799: frameset -> if true will start with a <frameset>
1.330 albertel 6800: rather than <body>
1.648 raeburn 6801: skip_phases -> hash ref of
1.338 albertel 6802: head -> skip the <html><head> generation
6803: body -> skip all <body> generation
1.648 raeburn 6804: no_inline_link -> if true and in remote mode, don't show the
1.361 albertel 6805: 'Switch To Inline Menu' link
1.648 raeburn 6806: no_auto_mt_title -> prevent &mt()ing the title arg
6807: inherit_jsmath -> when creating popup window in a page,
6808: should it have jsmath forced on by the
6809: current page
1.867 kalberla 6810: bread_crumbs -> Array containing breadcrumbs
6811: bread_crumbs_components -> if exists show it as headline else show only the breadcrumbs
1.361 albertel 6812:
1.648 raeburn 6813: =back
1.460 albertel 6814:
1.648 raeburn 6815: =back
1.562 albertel 6816:
1.306 albertel 6817: =cut
6818:
6819: sub start_page {
1.309 albertel 6820: my ($title,$head_extra,$args) = @_;
1.318 albertel 6821: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 6822: my %head_args;
1.352 albertel 6823: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6824: 'bgcolor','frameset','no_nav_bar','only_body',
6825: 'no_auto_mt_title') {
1.319 albertel 6826: if (defined($args->{$arg})) {
1.324 raeburn 6827: $head_args{$arg} = $args->{$arg};
1.319 albertel 6828: }
1.313 albertel 6829: }
1.319 albertel 6830:
1.315 albertel 6831: $env{'internal.start_page'}++;
1.338 albertel 6832: my $result;
6833: if (! exists($args->{'skip_phases'}{'head'}) ) {
6834: $result.=
1.341 albertel 6835: &xml_begin().
1.338 albertel 6836: &headtag($title,$head_extra,\%head_args).&endheadtag();
6837: }
6838:
6839: if (! exists($args->{'skip_phases'}{'body'}) ) {
6840: if ($args->{'frameset'}) {
6841: my $attr_string = &make_attr_string($args->{'force_register'},
6842: $args->{'add_entries'});
6843: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 6844: } else {
6845: $result .=
6846: &bodytag($title,
6847: $args->{'function'}, $args->{'add_entries'},
6848: $args->{'only_body'}, $args->{'domain'},
6849: $args->{'force_register'}, $args->{'no_nav_bar'},
6850: $args->{'bgcolor'}, $args->{'no_inline_link'},
6851: $args);
6852: }
1.330 albertel 6853: }
1.338 albertel 6854:
1.315 albertel 6855: if ($args->{'js_ready'}) {
1.713 kaisler 6856: $result = &js_ready($result);
1.315 albertel 6857: }
1.320 albertel 6858: if ($args->{'html_encode'}) {
1.713 kaisler 6859: $result = &html_encode($result);
6860: }
6861:
1.813 bisitz 6862: # Preparation for new and consistent functionlist at top of screen
6863: # if ($args->{'functionlist'}) {
6864: # $result .= &build_functionlist();
6865: #}
6866:
6867: # Don't add anything more if only_body wanted
6868: return $result if $args->{'only_body'};
6869:
1.920 raeburn 6870: #Breadcrumbs for Construction Space provided by &bodytag.
6871: if (($env{'environment.remote'} eq 'off') && ($env{'request.state'} eq 'construct')) {
6872: return $result;
6873: }
6874:
1.813 bisitz 6875: #Breadcrumbs
1.758 kaisler 6876: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
6877: &Apache::lonhtmlcommon::clear_breadcrumbs();
6878: #if any br links exists, add them to the breadcrumbs
6879: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6880: foreach my $crumb (@{$args->{'bread_crumbs'}}){
6881: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
6882: }
6883: }
6884:
6885: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
6886: if(exists($args->{'bread_crumbs_component'})){
6887: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
6888: }else{
6889: $result .= &Apache::lonhtmlcommon::breadcrumbs();
6890: }
1.320 albertel 6891: }
1.315 albertel 6892: return $result;
1.306 albertel 6893: }
6894:
1.330 albertel 6895:
1.306 albertel 6896: =pod
6897:
6898: =item * &head()
6899:
6900: Returns a complete </body></html> section for LON-CAPA web pages.
6901:
1.315 albertel 6902: Inputs: $args - additional optional args supported are:
6903: js_ready -> return a string ready for being used in
6904: a javascript writeln
1.320 albertel 6905: html_encode -> return a string ready for being used in
6906: a html attribute
1.330 albertel 6907: frameset -> if true will start with a <frameset>
6908: rather than <body>
1.493 albertel 6909: dicsussion -> if true will get discussion from
6910: lonxml::xmlend
6911: (you can pass the target and parser arguments
6912: through optional 'target' and 'parser' args
6913: to this routine)
1.306 albertel 6914:
6915: =cut
6916:
6917: sub end_page {
1.315 albertel 6918: my ($args) = @_;
6919: $env{'internal.end_page'}++;
1.330 albertel 6920: my $result;
1.335 albertel 6921: if ($args->{'discussion'}) {
6922: my ($target,$parser);
6923: if (ref($args->{'discussion'})) {
6924: ($target,$parser) =($args->{'discussion'}{'target'},
6925: $args->{'discussion'}{'parser'});
6926: }
6927: $result .= &Apache::lonxml::xmlend($target,$parser);
6928: }
6929:
1.330 albertel 6930: if ($args->{'frameset'}) {
6931: $result .= '</frameset>';
6932: } else {
1.635 raeburn 6933: $result .= &endbodytag($args);
1.330 albertel 6934: }
6935: $result .= "\n</html>";
6936:
1.315 albertel 6937: if ($args->{'js_ready'}) {
1.317 albertel 6938: $result = &js_ready($result);
1.315 albertel 6939: }
1.335 albertel 6940:
1.320 albertel 6941: if ($args->{'html_encode'}) {
6942: $result = &html_encode($result);
6943: }
1.335 albertel 6944:
1.315 albertel 6945: return $result;
6946: }
6947:
1.320 albertel 6948: sub html_encode {
6949: my ($result) = @_;
6950:
1.322 albertel 6951: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6952:
6953: return $result;
6954: }
1.317 albertel 6955: sub js_ready {
6956: my ($result) = @_;
6957:
1.323 albertel 6958: $result =~ s/[\n\r]/ /xmsg;
6959: $result =~ s/\\/\\\\/xmsg;
6960: $result =~ s/'/\\'/xmsg;
1.372 albertel 6961: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6962:
6963: return $result;
6964: }
6965:
1.315 albertel 6966: sub validate_page {
6967: if ( exists($env{'internal.start_page'})
1.316 albertel 6968: && $env{'internal.start_page'} > 1) {
6969: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6970: $env{'internal.start_page'}.' '.
1.316 albertel 6971: $ENV{'request.filename'});
1.315 albertel 6972: }
6973: if ( exists($env{'internal.end_page'})
1.316 albertel 6974: && $env{'internal.end_page'} > 1) {
6975: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6976: $env{'internal.end_page'}.' '.
1.316 albertel 6977: $env{'request.filename'});
1.315 albertel 6978: }
6979: if ( exists($env{'internal.start_page'})
6980: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6981: &Apache::lonnet::logthis('start_page called without end_page '.
6982: $env{'request.filename'});
1.315 albertel 6983: }
6984: if ( ! exists($env{'internal.start_page'})
6985: && exists($env{'internal.end_page'})) {
1.316 albertel 6986: &Apache::lonnet::logthis('end_page called without start_page'.
6987: $env{'request.filename'});
1.315 albertel 6988: }
1.306 albertel 6989: }
1.315 albertel 6990:
1.318 albertel 6991: sub simple_error_page {
6992: my ($r,$title,$msg) = @_;
6993: my $page =
6994: &Apache::loncommon::start_page($title).
6995: &mt($msg).
6996: &Apache::loncommon::end_page();
6997: if (ref($r)) {
6998: $r->print($page);
1.327 albertel 6999: return;
1.318 albertel 7000: }
7001: return $page;
7002: }
1.347 albertel 7003:
7004: {
1.610 albertel 7005: my @row_count;
1.948.2.5! raeburn 7006:
! 7007: sub start_data_table_count {
! 7008: unshift(@row_count, 0);
! 7009: return;
! 7010: }
! 7011:
! 7012: sub end_data_table_count {
! 7013: shift(@row_count);
! 7014: return;
! 7015: }
! 7016:
1.347 albertel 7017: sub start_data_table {
1.422 albertel 7018: my ($add_class) = @_;
7019: my $css_class = (join(' ','LC_data_table',$add_class));
1.948.2.5! raeburn 7020: &start_data_table_count();
1.422 albertel 7021: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 7022: }
7023:
7024: sub end_data_table {
1.948.2.5! raeburn 7025: &end_data_table_count();
1.389 albertel 7026: return '</table>'."\n";;
1.347 albertel 7027: }
7028:
7029: sub start_data_table_row {
1.422 albertel 7030: my ($add_class) = @_;
1.610 albertel 7031: $row_count[0]++;
7032: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 7033: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.422 albertel 7034: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 7035: }
1.471 banghart 7036:
7037: sub continue_data_table_row {
7038: my ($add_class) = @_;
1.610 albertel 7039: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 7040: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');;
1.471 banghart 7041: return '<tr class="'.$css_class.'">'."\n";;
7042: }
1.347 albertel 7043:
7044: sub end_data_table_row {
1.389 albertel 7045: return '</tr>'."\n";;
1.347 albertel 7046: }
1.367 www 7047:
1.421 albertel 7048: sub start_data_table_empty_row {
1.707 bisitz 7049: # $row_count[0]++;
1.421 albertel 7050: return '<tr class="LC_empty_row" >'."\n";;
7051: }
7052:
7053: sub end_data_table_empty_row {
7054: return '</tr>'."\n";;
7055: }
7056:
1.367 www 7057: sub start_data_table_header_row {
1.389 albertel 7058: return '<tr class="LC_header_row">'."\n";;
1.367 www 7059: }
7060:
7061: sub end_data_table_header_row {
1.389 albertel 7062: return '</tr>'."\n";;
1.367 www 7063: }
1.890 droeschl 7064:
7065: sub data_table_caption {
7066: my $caption = shift;
7067: return "<caption class=\"LC_caption\">$caption</caption>";
7068: }
1.347 albertel 7069: }
7070:
1.548 albertel 7071: =pod
7072:
7073: =item * &inhibit_menu_check($arg)
7074:
7075: Checks for a inhibitmenu state and generates output to preserve it
7076:
7077: Inputs: $arg - can be any of
7078: - undef - in which case the return value is a string
7079: to add into arguments list of a uri
7080: - 'input' - in which case the return value is a HTML
7081: <form> <input> field of type hidden to
7082: preserve the value
7083: - a url - in which case the return value is the url with
7084: the neccesary cgi args added to preserve the
7085: inhibitmenu state
7086: - a ref to a url - no return value, but the string is
7087: updated to include the neccessary cgi
7088: args to preserve the inhibitmenu state
7089:
7090: =cut
7091:
7092: sub inhibit_menu_check {
7093: my ($arg) = @_;
7094: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
7095: if ($arg eq 'input') {
7096: if ($env{'form.inhibitmenu'}) {
7097: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
7098: } else {
7099: return
7100: }
7101: }
7102: if ($env{'form.inhibitmenu'}) {
7103: if (ref($arg)) {
7104: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7105: } elsif ($arg eq '') {
7106: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
7107: } else {
7108: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7109: }
7110: }
7111: if (!ref($arg)) {
7112: return $arg;
7113: }
7114: }
7115:
1.251 albertel 7116: ###############################################
1.182 matthew 7117:
7118: =pod
7119:
1.549 albertel 7120: =back
7121:
7122: =head1 User Information Routines
7123:
7124: =over 4
7125:
1.405 albertel 7126: =item * &get_users_function()
1.182 matthew 7127:
7128: Used by &bodytag to determine the current users primary role.
7129: Returns either 'student','coordinator','admin', or 'author'.
7130:
7131: =cut
7132:
7133: ###############################################
7134: sub get_users_function {
1.815 tempelho 7135: my $function = 'norole';
1.818 tempelho 7136: if ($env{'request.role'}=~/^(st)/) {
7137: $function='student';
7138: }
1.907 raeburn 7139: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 7140: $function='coordinator';
7141: }
1.258 albertel 7142: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 7143: $function='admin';
7144: }
1.826 bisitz 7145: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182 matthew 7146: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
7147: $function='author';
7148: }
7149: return $function;
1.54 www 7150: }
1.99 www 7151:
7152: ###############################################
7153:
1.233 raeburn 7154: =pod
7155:
1.821 raeburn 7156: =item * &show_course()
7157:
7158: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
7159: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
7160:
7161: Inputs:
7162: None
7163:
7164: Outputs:
7165: Scalar: 1 if 'Course' to be used, 0 otherwise.
7166:
7167: =cut
7168:
7169: ###############################################
7170: sub show_course {
7171: my $course = !$env{'user.adv'};
7172: if (!$env{'user.adv'}) {
7173: foreach my $env (keys(%env)) {
7174: next if ($env !~ m/^user\.priv\./);
7175: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
7176: $course = 0;
7177: last;
7178: }
7179: }
7180: }
7181: return $course;
7182: }
7183:
7184: ###############################################
7185:
7186: =pod
7187:
1.542 raeburn 7188: =item * &check_user_status()
1.274 raeburn 7189:
7190: Determines current status of supplied role for a
7191: specific user. Roles can be active, previous or future.
7192:
7193: Inputs:
7194: user's domain, user's username, course's domain,
1.375 raeburn 7195: course's number, optional section ID.
1.274 raeburn 7196:
7197: Outputs:
7198: role status: active, previous or future.
7199:
7200: =cut
7201:
7202: sub check_user_status {
1.412 raeburn 7203: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 7204: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
7205: my @uroles = keys %userinfo;
7206: my $srchstr;
7207: my $active_chk = 'none';
1.412 raeburn 7208: my $now = time;
1.274 raeburn 7209: if (@uroles > 0) {
1.908 raeburn 7210: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 7211: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
7212: } else {
1.412 raeburn 7213: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
7214: }
7215: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 7216: my $role_end = 0;
7217: my $role_start = 0;
7218: $active_chk = 'active';
1.412 raeburn 7219: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
7220: $role_end = $1;
7221: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
7222: $role_start = $1;
1.274 raeburn 7223: }
7224: }
7225: if ($role_start > 0) {
1.412 raeburn 7226: if ($now < $role_start) {
1.274 raeburn 7227: $active_chk = 'future';
7228: }
7229: }
7230: if ($role_end > 0) {
1.412 raeburn 7231: if ($now > $role_end) {
1.274 raeburn 7232: $active_chk = 'previous';
7233: }
7234: }
7235: }
7236: }
7237: return $active_chk;
7238: }
7239:
7240: ###############################################
7241:
7242: =pod
7243:
1.405 albertel 7244: =item * &get_sections()
1.233 raeburn 7245:
7246: Determines all the sections for a course including
7247: sections with students and sections containing other roles.
1.419 raeburn 7248: Incoming parameters:
7249:
7250: 1. domain
7251: 2. course number
7252: 3. reference to array containing roles for which sections should
7253: be gathered (optional).
7254: 4. reference to array containing status types for which sections
7255: should be gathered (optional).
7256:
7257: If the third argument is undefined, sections are gathered for any role.
7258: If the fourth argument is undefined, sections are gathered for any status.
7259: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 7260:
1.374 raeburn 7261: Returns section hash (keys are section IDs, values are
7262: number of users in each section), subject to the
1.419 raeburn 7263: optional roles filter, optional status filter
1.233 raeburn 7264:
7265: =cut
7266:
7267: ###############################################
7268: sub get_sections {
1.419 raeburn 7269: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 7270: if (!defined($cdom) || !defined($cnum)) {
7271: my $cid = $env{'request.course.id'};
7272:
7273: return if (!defined($cid));
7274:
7275: $cdom = $env{'course.'.$cid.'.domain'};
7276: $cnum = $env{'course.'.$cid.'.num'};
7277: }
7278:
7279: my %sectioncount;
1.419 raeburn 7280: my $now = time;
1.240 albertel 7281:
1.366 albertel 7282: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 7283: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 7284: my $sec_index = &Apache::loncoursedata::CL_SECTION();
7285: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 7286: my $start_index = &Apache::loncoursedata::CL_START();
7287: my $end_index = &Apache::loncoursedata::CL_END();
7288: my $status;
1.366 albertel 7289: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 7290: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
7291: $data->[$status_index],
7292: $data->[$start_index],
7293: $data->[$end_index]);
7294: if ($stu_status eq 'Active') {
7295: $status = 'active';
7296: } elsif ($end < $now) {
7297: $status = 'previous';
7298: } elsif ($start > $now) {
7299: $status = 'future';
7300: }
7301: if ($section ne '-1' && $section !~ /^\s*$/) {
7302: if ((!defined($possible_status)) || (($status ne '') &&
7303: (grep/^\Q$status\E$/,@{$possible_status}))) {
7304: $sectioncount{$section}++;
7305: }
1.240 albertel 7306: }
7307: }
7308: }
7309: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7310: foreach my $user (sort(keys(%courseroles))) {
7311: if ($user !~ /^(\w{2})/) { next; }
7312: my ($role) = ($user =~ /^(\w{2})/);
7313: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 7314: my ($section,$status);
1.240 albertel 7315: if ($role eq 'cr' &&
7316: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
7317: $section=$1;
7318: }
7319: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
7320: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 7321: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
7322: if ($end == -1 && $start == -1) {
7323: next; #deleted role
7324: }
7325: if (!defined($possible_status)) {
7326: $sectioncount{$section}++;
7327: } else {
7328: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
7329: $status = 'active';
7330: } elsif ($end < $now) {
7331: $status = 'future';
7332: } elsif ($start > $now) {
7333: $status = 'previous';
7334: }
7335: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
7336: $sectioncount{$section}++;
7337: }
7338: }
1.233 raeburn 7339: }
1.366 albertel 7340: return %sectioncount;
1.233 raeburn 7341: }
7342:
1.274 raeburn 7343: ###############################################
1.294 raeburn 7344:
7345: =pod
1.405 albertel 7346:
7347: =item * &get_course_users()
7348:
1.275 raeburn 7349: Retrieves usernames:domains for users in the specified course
7350: with specific role(s), and access status.
7351:
7352: Incoming parameters:
1.277 albertel 7353: 1. course domain
7354: 2. course number
7355: 3. access status: users must have - either active,
1.275 raeburn 7356: previous, future, or all.
1.277 albertel 7357: 4. reference to array of permissible roles
1.288 raeburn 7358: 5. reference to array of section restrictions (optional)
7359: 6. reference to results object (hash of hashes).
7360: 7. reference to optional userdata hash
1.609 raeburn 7361: 8. reference to optional statushash
1.630 raeburn 7362: 9. flag if privileged users (except those set to unhide in
7363: course settings) should be excluded
1.609 raeburn 7364: Keys of top level results hash are roles.
1.275 raeburn 7365: Keys of inner hashes are username:domain, with
7366: values set to access type.
1.288 raeburn 7367: Optional userdata hash returns an array with arguments in the
7368: same order as loncoursedata::get_classlist() for student data.
7369:
1.609 raeburn 7370: Optional statushash returns
7371:
1.288 raeburn 7372: Entries for end, start, section and status are blank because
7373: of the possibility of multiple values for non-student roles.
7374:
1.275 raeburn 7375: =cut
1.405 albertel 7376:
1.275 raeburn 7377: ###############################################
1.405 albertel 7378:
1.275 raeburn 7379: sub get_course_users {
1.630 raeburn 7380: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 7381: my %idx = ();
1.419 raeburn 7382: my %seclists;
1.288 raeburn 7383:
7384: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
7385: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
7386: $idx{end} = &Apache::loncoursedata::CL_END();
7387: $idx{start} = &Apache::loncoursedata::CL_START();
7388: $idx{id} = &Apache::loncoursedata::CL_ID();
7389: $idx{section} = &Apache::loncoursedata::CL_SECTION();
7390: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
7391: $idx{status} = &Apache::loncoursedata::CL_STATUS();
7392:
1.290 albertel 7393: if (grep(/^st$/,@{$roles})) {
1.276 albertel 7394: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 7395: my $now = time;
1.277 albertel 7396: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 7397: my $match = 0;
1.412 raeburn 7398: my $secmatch = 0;
1.419 raeburn 7399: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 7400: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 7401: if ($section eq '') {
7402: $section = 'none';
7403: }
1.291 albertel 7404: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7405: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7406: $secmatch = 1;
7407: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 7408: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7409: $secmatch = 1;
7410: }
7411: } else {
1.419 raeburn 7412: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 7413: $secmatch = 1;
7414: }
1.290 albertel 7415: }
1.412 raeburn 7416: if (!$secmatch) {
7417: next;
7418: }
1.419 raeburn 7419: }
1.275 raeburn 7420: if (defined($$types{'active'})) {
1.288 raeburn 7421: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 7422: push(@{$$users{st}{$student}},'active');
1.288 raeburn 7423: $match = 1;
1.275 raeburn 7424: }
7425: }
7426: if (defined($$types{'previous'})) {
1.609 raeburn 7427: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 7428: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 7429: $match = 1;
1.275 raeburn 7430: }
7431: }
7432: if (defined($$types{'future'})) {
1.609 raeburn 7433: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 7434: push(@{$$users{st}{$student}},'future');
1.288 raeburn 7435: $match = 1;
1.275 raeburn 7436: }
7437: }
1.609 raeburn 7438: if ($match) {
7439: push(@{$seclists{$student}},$section);
7440: if (ref($userdata) eq 'HASH') {
7441: $$userdata{$student} = $$classlist{$student};
7442: }
7443: if (ref($statushash) eq 'HASH') {
7444: $statushash->{$student}{'st'}{$section} = $status;
7445: }
1.288 raeburn 7446: }
1.275 raeburn 7447: }
7448: }
1.412 raeburn 7449: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 7450: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7451: my $now = time;
1.609 raeburn 7452: my %displaystatus = ( previous => 'Expired',
7453: active => 'Active',
7454: future => 'Future',
7455: );
1.630 raeburn 7456: my %nothide;
7457: if ($hidepriv) {
7458: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
7459: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
7460: if ($user !~ /:/) {
7461: $nothide{join(':',split(/[\@]/,$user))}=1;
7462: } else {
7463: $nothide{$user} = 1;
7464: }
7465: }
7466: }
1.439 raeburn 7467: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 7468: my $match = 0;
1.412 raeburn 7469: my $secmatch = 0;
1.439 raeburn 7470: my $status;
1.412 raeburn 7471: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 7472: $user =~ s/:$//;
1.439 raeburn 7473: my ($end,$start) = split(/:/,$coursepersonnel{$person});
7474: if ($end == -1 || $start == -1) {
7475: next;
7476: }
7477: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
7478: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 7479: my ($uname,$udom) = split(/:/,$user);
7480: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7481: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7482: $secmatch = 1;
7483: } elsif ($usec eq '') {
1.420 albertel 7484: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7485: $secmatch = 1;
7486: }
7487: } else {
7488: if (grep(/^\Q$usec\E$/,@{$sections})) {
7489: $secmatch = 1;
7490: }
7491: }
7492: if (!$secmatch) {
7493: next;
7494: }
1.288 raeburn 7495: }
1.419 raeburn 7496: if ($usec eq '') {
7497: $usec = 'none';
7498: }
1.275 raeburn 7499: if ($uname ne '' && $udom ne '') {
1.630 raeburn 7500: if ($hidepriv) {
7501: if ((&Apache::lonnet::privileged($uname,$udom)) &&
7502: (!$nothide{$uname.':'.$udom})) {
7503: next;
7504: }
7505: }
1.503 raeburn 7506: if ($end > 0 && $end < $now) {
1.439 raeburn 7507: $status = 'previous';
7508: } elsif ($start > $now) {
7509: $status = 'future';
7510: } else {
7511: $status = 'active';
7512: }
1.277 albertel 7513: foreach my $type (keys(%{$types})) {
1.275 raeburn 7514: if ($status eq $type) {
1.420 albertel 7515: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 7516: push(@{$$users{$role}{$user}},$type);
7517: }
1.288 raeburn 7518: $match = 1;
7519: }
7520: }
1.419 raeburn 7521: if (($match) && (ref($userdata) eq 'HASH')) {
7522: if (!exists($$userdata{$uname.':'.$udom})) {
7523: &get_user_info($udom,$uname,\%idx,$userdata);
7524: }
1.420 albertel 7525: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 7526: push(@{$seclists{$uname.':'.$udom}},$usec);
7527: }
1.609 raeburn 7528: if (ref($statushash) eq 'HASH') {
7529: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
7530: }
1.275 raeburn 7531: }
7532: }
7533: }
7534: }
1.290 albertel 7535: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 7536: if ((defined($cdom)) && (defined($cnum))) {
7537: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
7538: if ( defined($csettings{'internal.courseowner'}) ) {
7539: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 7540: next if ($owner eq '');
7541: my ($ownername,$ownerdom);
7542: if ($owner =~ /^([^:]+):([^:]+)$/) {
7543: $ownername = $1;
7544: $ownerdom = $2;
7545: } else {
7546: $ownername = $owner;
7547: $ownerdom = $cdom;
7548: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 7549: }
7550: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 7551: if (defined($userdata) &&
1.609 raeburn 7552: !exists($$userdata{$owner})) {
7553: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
7554: if (!grep(/^none$/,@{$seclists{$owner}})) {
7555: push(@{$seclists{$owner}},'none');
7556: }
7557: if (ref($statushash) eq 'HASH') {
7558: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 7559: }
1.290 albertel 7560: }
1.279 raeburn 7561: }
7562: }
7563: }
1.419 raeburn 7564: foreach my $user (keys(%seclists)) {
7565: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
7566: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
7567: }
1.275 raeburn 7568: }
7569: return;
7570: }
7571:
1.288 raeburn 7572: sub get_user_info {
7573: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 7574: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
7575: &plainname($uname,$udom,'lastname');
1.291 albertel 7576: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 7577: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 7578: my %idhash = &Apache::lonnet::idrget($udom,($uname));
7579: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 7580: return;
7581: }
1.275 raeburn 7582:
1.472 raeburn 7583: ###############################################
7584:
7585: =pod
7586:
7587: =item * &get_user_quota()
7588:
7589: Retrieves quota assigned for storage of portfolio files for a user
7590:
7591: Incoming parameters:
7592: 1. user's username
7593: 2. user's domain
7594:
7595: Returns:
1.536 raeburn 7596: 1. Disk quota (in Mb) assigned to student.
7597: 2. (Optional) Type of setting: custom or default
7598: (individually assigned or default for user's
7599: institutional status).
7600: 3. (Optional) - User's institutional status (e.g., faculty, staff
7601: or student - types as defined in localenroll::inst_usertypes
7602: for user's domain, which determines default quota for user.
7603: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 7604:
7605: If a value has been stored in the user's environment,
1.536 raeburn 7606: it will return that, otherwise it returns the maximal default
7607: defined for the user's instituional status(es) in the domain.
1.472 raeburn 7608:
7609: =cut
7610:
7611: ###############################################
7612:
7613:
7614: sub get_user_quota {
7615: my ($uname,$udom) = @_;
1.536 raeburn 7616: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 7617: if (!defined($udom)) {
7618: $udom = $env{'user.domain'};
7619: }
7620: if (!defined($uname)) {
7621: $uname = $env{'user.name'};
7622: }
7623: if (($udom eq '' || $uname eq '') ||
7624: ($udom eq 'public') && ($uname eq 'public')) {
7625: $quota = 0;
1.536 raeburn 7626: $quotatype = 'default';
7627: $defquota = 0;
1.472 raeburn 7628: } else {
1.536 raeburn 7629: my $inststatus;
1.472 raeburn 7630: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
7631: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 7632: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 7633: } else {
1.536 raeburn 7634: my %userenv =
7635: &Apache::lonnet::get('environment',['portfolioquota',
7636: 'inststatus'],$udom,$uname);
1.472 raeburn 7637: my ($tmp) = keys(%userenv);
7638: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7639: $quota = $userenv{'portfolioquota'};
1.536 raeburn 7640: $inststatus = $userenv{'inststatus'};
1.472 raeburn 7641: } else {
7642: undef(%userenv);
7643: }
7644: }
1.536 raeburn 7645: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 7646: if ($quota eq '') {
1.536 raeburn 7647: $quota = $defquota;
7648: $quotatype = 'default';
7649: } else {
7650: $quotatype = 'custom';
1.472 raeburn 7651: }
7652: }
1.536 raeburn 7653: if (wantarray) {
7654: return ($quota,$quotatype,$settingstatus,$defquota);
7655: } else {
7656: return $quota;
7657: }
1.472 raeburn 7658: }
7659:
7660: ###############################################
7661:
7662: =pod
7663:
7664: =item * &default_quota()
7665:
1.536 raeburn 7666: Retrieves default quota assigned for storage of user portfolio files,
7667: given an (optional) user's institutional status.
1.472 raeburn 7668:
7669: Incoming parameters:
7670: 1. domain
1.536 raeburn 7671: 2. (Optional) institutional status(es). This is a : separated list of
7672: status types (e.g., faculty, staff, student etc.)
7673: which apply to the user for whom the default is being retrieved.
7674: If the institutional status string in undefined, the domain
7675: default quota will be returned.
1.472 raeburn 7676:
7677: Returns:
7678: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 7679: 2. (Optional) institutional type which determined the value of the
7680: default quota.
1.472 raeburn 7681:
7682: If a value has been stored in the domain's configuration db,
7683: it will return that, otherwise it returns 20 (for backwards
7684: compatibility with domains which have not set up a configuration
7685: db file; the original statically defined portfolio quota was 20 Mb).
7686:
1.536 raeburn 7687: If the user's status includes multiple types (e.g., staff and student),
7688: the largest default quota which applies to the user determines the
7689: default quota returned.
7690:
1.780 raeburn 7691: =back
7692:
1.472 raeburn 7693: =cut
7694:
7695: ###############################################
7696:
7697:
7698: sub default_quota {
1.536 raeburn 7699: my ($udom,$inststatus) = @_;
7700: my ($defquota,$settingstatus);
7701: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 7702: ['quotas'],$udom);
7703: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 7704: if ($inststatus ne '') {
1.765 raeburn 7705: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 7706: foreach my $item (@statuses) {
1.711 raeburn 7707: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7708: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
7709: if ($defquota eq '') {
7710: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7711: $settingstatus = $item;
7712: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
7713: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7714: $settingstatus = $item;
7715: }
7716: }
7717: } else {
7718: if ($quotahash{'quotas'}{$item} ne '') {
7719: if ($defquota eq '') {
7720: $defquota = $quotahash{'quotas'}{$item};
7721: $settingstatus = $item;
7722: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
7723: $defquota = $quotahash{'quotas'}{$item};
7724: $settingstatus = $item;
7725: }
1.536 raeburn 7726: }
7727: }
7728: }
7729: }
7730: if ($defquota eq '') {
1.711 raeburn 7731: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7732: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
7733: } else {
7734: $defquota = $quotahash{'quotas'}{'default'};
7735: }
1.536 raeburn 7736: $settingstatus = 'default';
7737: }
7738: } else {
7739: $settingstatus = 'default';
7740: $defquota = 20;
7741: }
7742: if (wantarray) {
7743: return ($defquota,$settingstatus);
1.472 raeburn 7744: } else {
1.536 raeburn 7745: return $defquota;
1.472 raeburn 7746: }
7747: }
7748:
1.384 raeburn 7749: sub get_secgrprole_info {
7750: my ($cdom,$cnum,$needroles,$type) = @_;
7751: my %sections_count = &get_sections($cdom,$cnum);
7752: my @sections = (sort {$a <=> $b} keys(%sections_count));
7753: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
7754: my @groups = sort(keys(%curr_groups));
7755: my $allroles = [];
7756: my $rolehash;
7757: my $accesshash = {
7758: active => 'Currently has access',
7759: future => 'Will have future access',
7760: previous => 'Previously had access',
7761: };
7762: if ($needroles) {
7763: $rolehash = {'all' => 'all'};
1.385 albertel 7764: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7765: if (&Apache::lonnet::error(%user_roles)) {
7766: undef(%user_roles);
7767: }
7768: foreach my $item (keys(%user_roles)) {
1.384 raeburn 7769: my ($role)=split(/\:/,$item,2);
7770: if ($role eq 'cr') { next; }
7771: if ($role =~ /^cr/) {
7772: $$rolehash{$role} = (split('/',$role))[3];
7773: } else {
7774: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
7775: }
7776: }
7777: foreach my $key (sort(keys(%{$rolehash}))) {
7778: push(@{$allroles},$key);
7779: }
7780: push (@{$allroles},'st');
7781: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
7782: }
7783: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
7784: }
7785:
1.555 raeburn 7786: sub user_picker {
1.627 raeburn 7787: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555 raeburn 7788: my $currdom = $dom;
7789: my %curr_selected = (
7790: srchin => 'dom',
1.580 raeburn 7791: srchby => 'lastname',
1.555 raeburn 7792: );
7793: my $srchterm;
1.625 raeburn 7794: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 7795: if ($srch->{'srchby'} ne '') {
7796: $curr_selected{'srchby'} = $srch->{'srchby'};
7797: }
7798: if ($srch->{'srchin'} ne '') {
7799: $curr_selected{'srchin'} = $srch->{'srchin'};
7800: }
7801: if ($srch->{'srchtype'} ne '') {
7802: $curr_selected{'srchtype'} = $srch->{'srchtype'};
7803: }
7804: if ($srch->{'srchdomain'} ne '') {
7805: $currdom = $srch->{'srchdomain'};
7806: }
7807: $srchterm = $srch->{'srchterm'};
7808: }
7809: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 7810: 'usr' => 'Search criteria',
1.563 raeburn 7811: 'doma' => 'Domain/institution to search',
1.558 albertel 7812: 'uname' => 'username',
7813: 'lastname' => 'last name',
1.555 raeburn 7814: 'lastfirst' => 'last name, first name',
1.558 albertel 7815: 'crs' => 'in this course',
1.576 raeburn 7816: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 7817: 'alc' => 'all LON-CAPA',
1.573 raeburn 7818: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 7819: 'exact' => 'is',
7820: 'contains' => 'contains',
1.569 raeburn 7821: 'begins' => 'begins with',
1.571 raeburn 7822: 'youm' => "You must include some text to search for.",
7823: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
7824: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
7825: 'yomc' => "You must choose a domain when using an institutional directory search.",
7826: 'ymcd' => "You must choose a domain when using a domain search.",
7827: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
7828: 'whse' => "When searching by last,first you must include at least one character in the first name.",
7829: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 7830: );
1.563 raeburn 7831: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
7832: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 7833:
7834: my @srchins = ('crs','dom','alc','instd');
7835:
7836: foreach my $option (@srchins) {
7837: # FIXME 'alc' option unavailable until
7838: # loncreateuser::print_user_query_page()
7839: # has been completed.
7840: next if ($option eq 'alc');
1.880 raeburn 7841: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 7842: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 7843: if ($curr_selected{'srchin'} eq $option) {
7844: $srchinsel .= '
7845: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7846: } else {
7847: $srchinsel .= '
7848: <option value="'.$option.'">'.$lt{$option}.'</option>';
7849: }
1.555 raeburn 7850: }
1.563 raeburn 7851: $srchinsel .= "\n </select>\n";
1.555 raeburn 7852:
7853: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 7854: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 7855: if ($curr_selected{'srchby'} eq $option) {
7856: $srchbysel .= '
7857: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7858: } else {
7859: $srchbysel .= '
7860: <option value="'.$option.'">'.$lt{$option}.'</option>';
7861: }
7862: }
7863: $srchbysel .= "\n </select>\n";
7864:
7865: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 7866: foreach my $option ('begins','contains','exact') {
1.555 raeburn 7867: if ($curr_selected{'srchtype'} eq $option) {
7868: $srchtypesel .= '
7869: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7870: } else {
7871: $srchtypesel .= '
7872: <option value="'.$option.'">'.$lt{$option}.'</option>';
7873: }
7874: }
7875: $srchtypesel .= "\n </select>\n";
7876:
1.558 albertel 7877: my ($newuserscript,$new_user_create);
1.556 raeburn 7878:
7879: if ($forcenewuser) {
1.576 raeburn 7880: if (ref($srch) eq 'HASH') {
7881: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627 raeburn 7882: if ($cancreate) {
7883: $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>';
7884: } else {
1.799 bisitz 7885: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 7886: my %usertypetext = (
7887: official => 'institutional',
7888: unofficial => 'non-institutional',
7889: );
1.799 bisitz 7890: $new_user_create = '<p class="LC_warning">'
7891: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
7892: .' '
7893: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
7894: ,'<a href="'.$helplink.'">','</a>')
7895: .'</p><br />';
1.627 raeburn 7896: }
1.576 raeburn 7897: }
7898: }
7899:
1.556 raeburn 7900: $newuserscript = <<"ENDSCRIPT";
7901:
1.570 raeburn 7902: function setSearch(createnew,callingForm) {
1.556 raeburn 7903: if (createnew == 1) {
1.570 raeburn 7904: for (var i=0; i<callingForm.srchby.length; i++) {
7905: if (callingForm.srchby.options[i].value == 'uname') {
7906: callingForm.srchby.selectedIndex = i;
1.556 raeburn 7907: }
7908: }
1.570 raeburn 7909: for (var i=0; i<callingForm.srchin.length; i++) {
7910: if ( callingForm.srchin.options[i].value == 'dom') {
7911: callingForm.srchin.selectedIndex = i;
1.556 raeburn 7912: }
7913: }
1.570 raeburn 7914: for (var i=0; i<callingForm.srchtype.length; i++) {
7915: if (callingForm.srchtype.options[i].value == 'exact') {
7916: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 7917: }
7918: }
1.570 raeburn 7919: for (var i=0; i<callingForm.srchdomain.length; i++) {
7920: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
7921: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 7922: }
7923: }
7924: }
7925: }
7926: ENDSCRIPT
1.558 albertel 7927:
1.556 raeburn 7928: }
7929:
1.555 raeburn 7930: my $output = <<"END_BLOCK";
1.556 raeburn 7931: <script type="text/javascript">
1.824 bisitz 7932: // <![CDATA[
1.570 raeburn 7933: function validateEntry(callingForm) {
1.558 albertel 7934:
1.556 raeburn 7935: var checkok = 1;
1.558 albertel 7936: var srchin;
1.570 raeburn 7937: for (var i=0; i<callingForm.srchin.length; i++) {
7938: if ( callingForm.srchin[i].checked ) {
7939: srchin = callingForm.srchin[i].value;
1.558 albertel 7940: }
7941: }
7942:
1.570 raeburn 7943: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7944: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7945: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7946: var srchterm = callingForm.srchterm.value;
7947: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7948: var msg = "";
7949:
7950: if (srchterm == "") {
7951: checkok = 0;
1.571 raeburn 7952: msg += "$lt{'youm'}\\n";
1.556 raeburn 7953: }
7954:
1.569 raeburn 7955: if (srchtype== 'begins') {
7956: if (srchterm.length < 2) {
7957: checkok = 0;
1.571 raeburn 7958: msg += "$lt{'thte'}\\n";
1.569 raeburn 7959: }
7960: }
7961:
1.556 raeburn 7962: if (srchtype== 'contains') {
7963: if (srchterm.length < 3) {
7964: checkok = 0;
1.571 raeburn 7965: msg += "$lt{'thet'}\\n";
1.556 raeburn 7966: }
7967: }
7968: if (srchin == 'instd') {
7969: if (srchdomain == '') {
7970: checkok = 0;
1.571 raeburn 7971: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7972: }
7973: }
7974: if (srchin == 'dom') {
7975: if (srchdomain == '') {
7976: checkok = 0;
1.571 raeburn 7977: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7978: }
7979: }
7980: if (srchby == 'lastfirst') {
7981: if (srchterm.indexOf(",") == -1) {
7982: checkok = 0;
1.571 raeburn 7983: msg += "$lt{'whus'}\\n";
1.556 raeburn 7984: }
7985: if (srchterm.indexOf(",") == srchterm.length -1) {
7986: checkok = 0;
1.571 raeburn 7987: msg += "$lt{'whse'}\\n";
1.556 raeburn 7988: }
7989: }
7990: if (checkok == 0) {
1.571 raeburn 7991: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7992: return;
7993: }
7994: if (checkok == 1) {
1.570 raeburn 7995: callingForm.submit();
1.556 raeburn 7996: }
7997: }
7998:
7999: $newuserscript
8000:
1.824 bisitz 8001: // ]]>
1.556 raeburn 8002: </script>
1.558 albertel 8003:
8004: $new_user_create
8005:
1.555 raeburn 8006: END_BLOCK
1.558 albertel 8007:
1.876 raeburn 8008: $output .= &Apache::lonhtmlcommon::start_pick_box().
8009: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
8010: $domform.
8011: &Apache::lonhtmlcommon::row_closure().
8012: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
8013: $srchbysel.
8014: $srchtypesel.
8015: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
8016: $srchinsel.
8017: &Apache::lonhtmlcommon::row_closure(1).
8018: &Apache::lonhtmlcommon::end_pick_box().
8019: '<br />';
1.555 raeburn 8020: return $output;
8021: }
8022:
1.612 raeburn 8023: sub user_rule_check {
1.615 raeburn 8024: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 8025: my $response;
8026: if (ref($usershash) eq 'HASH') {
8027: foreach my $user (keys(%{$usershash})) {
8028: my ($uname,$udom) = split(/:/,$user);
8029: next if ($udom eq '' || $uname eq '');
1.615 raeburn 8030: my ($id,$newuser);
1.612 raeburn 8031: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 8032: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 8033: $id = $usershash->{$user}->{'id'};
8034: }
8035: my $inst_response;
8036: if (ref($checks) eq 'HASH') {
8037: if (defined($checks->{'username'})) {
1.615 raeburn 8038: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 8039: &Apache::lonnet::get_instuser($udom,$uname);
8040: } elsif (defined($checks->{'id'})) {
1.615 raeburn 8041: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 8042: &Apache::lonnet::get_instuser($udom,undef,$id);
8043: }
1.615 raeburn 8044: } else {
8045: ($inst_response,%{$inst_results->{$user}}) =
8046: &Apache::lonnet::get_instuser($udom,$uname);
8047: return;
1.612 raeburn 8048: }
1.615 raeburn 8049: if (!$got_rules->{$udom}) {
1.612 raeburn 8050: my %domconfig = &Apache::lonnet::get_dom('configuration',
8051: ['usercreation'],$udom);
8052: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 8053: foreach my $item ('username','id') {
1.612 raeburn 8054: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
8055: $$curr_rules{$udom}{$item} =
8056: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 8057: }
8058: }
8059: }
1.615 raeburn 8060: $got_rules->{$udom} = 1;
1.585 raeburn 8061: }
1.612 raeburn 8062: foreach my $item (keys(%{$checks})) {
8063: if (ref($$curr_rules{$udom}) eq 'HASH') {
8064: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
8065: if (@{$$curr_rules{$udom}{$item}} > 0) {
8066: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
8067: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
8068: if ($rule_check{$rule}) {
8069: $$rulematch{$user}{$item} = $rule;
8070: if ($inst_response eq 'ok') {
1.615 raeburn 8071: if (ref($inst_results) eq 'HASH') {
8072: if (ref($inst_results->{$user}) eq 'HASH') {
8073: if (keys(%{$inst_results->{$user}}) == 0) {
8074: $$alerts{$item}{$udom}{$uname} = 1;
8075: }
1.612 raeburn 8076: }
8077: }
1.615 raeburn 8078: }
8079: last;
1.585 raeburn 8080: }
8081: }
8082: }
8083: }
8084: }
8085: }
8086: }
8087: }
1.612 raeburn 8088: return;
8089: }
8090:
8091: sub user_rule_formats {
8092: my ($domain,$domdesc,$curr_rules,$check) = @_;
8093: my %text = (
8094: 'username' => 'Usernames',
8095: 'id' => 'IDs',
8096: );
8097: my $output;
8098: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
8099: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
8100: if (@{$ruleorder} > 0) {
8101: $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>';
8102: foreach my $rule (@{$ruleorder}) {
8103: if (ref($curr_rules) eq 'ARRAY') {
8104: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
8105: if (ref($rules->{$rule}) eq 'HASH') {
8106: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
8107: $rules->{$rule}{'desc'}.'</li>';
8108: }
8109: }
8110: }
8111: }
8112: $output .= '</ul>';
8113: }
8114: }
8115: return $output;
8116: }
8117:
8118: sub instrule_disallow_msg {
1.615 raeburn 8119: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 8120: my $response;
8121: my %text = (
8122: item => 'username',
8123: items => 'usernames',
8124: match => 'matches',
8125: do => 'does',
8126: action => 'a username',
8127: one => 'one',
8128: );
8129: if ($count > 1) {
8130: $text{'item'} = 'usernames';
8131: $text{'match'} ='match';
8132: $text{'do'} = 'do';
8133: $text{'action'} = 'usernames',
8134: $text{'one'} = 'ones';
8135: }
8136: if ($checkitem eq 'id') {
8137: $text{'items'} = 'IDs';
8138: $text{'item'} = 'ID';
8139: $text{'action'} = 'an ID';
1.615 raeburn 8140: if ($count > 1) {
8141: $text{'item'} = 'IDs';
8142: $text{'action'} = 'IDs';
8143: }
1.612 raeburn 8144: }
1.674 bisitz 8145: $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 8146: if ($mode eq 'upload') {
8147: if ($checkitem eq 'username') {
8148: $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'}.");
8149: } elsif ($checkitem eq 'id') {
1.674 bisitz 8150: $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 8151: }
1.669 raeburn 8152: } elsif ($mode eq 'selfcreate') {
8153: if ($checkitem eq 'id') {
8154: $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.");
8155: }
1.615 raeburn 8156: } else {
8157: if ($checkitem eq 'username') {
8158: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
8159: } elsif ($checkitem eq 'id') {
8160: $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.");
8161: }
1.612 raeburn 8162: }
8163: return $response;
1.585 raeburn 8164: }
8165:
1.624 raeburn 8166: sub personal_data_fieldtitles {
8167: my %fieldtitles = &Apache::lonlocal::texthash (
8168: id => 'Student/Employee ID',
8169: permanentemail => 'E-mail address',
8170: lastname => 'Last Name',
8171: firstname => 'First Name',
8172: middlename => 'Middle Name',
8173: generation => 'Generation',
8174: gen => 'Generation',
1.765 raeburn 8175: inststatus => 'Affiliation',
1.624 raeburn 8176: );
8177: return %fieldtitles;
8178: }
8179:
1.642 raeburn 8180: sub sorted_inst_types {
8181: my ($dom) = @_;
8182: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
8183: my $othertitle = &mt('All users');
8184: if ($env{'request.course.id'}) {
1.668 raeburn 8185: $othertitle = &mt('Any users');
1.642 raeburn 8186: }
8187: my @types;
8188: if (ref($order) eq 'ARRAY') {
8189: @types = @{$order};
8190: }
8191: if (@types == 0) {
8192: if (ref($usertypes) eq 'HASH') {
8193: @types = sort(keys(%{$usertypes}));
8194: }
8195: }
8196: if (keys(%{$usertypes}) > 0) {
8197: $othertitle = &mt('Other users');
8198: }
8199: return ($othertitle,$usertypes,\@types);
8200: }
8201:
1.645 raeburn 8202: sub get_institutional_codes {
8203: my ($settings,$allcourses,$LC_code) = @_;
8204: # Get complete list of course sections to update
8205: my @currsections = ();
8206: my @currxlists = ();
8207: my $coursecode = $$settings{'internal.coursecode'};
8208:
8209: if ($$settings{'internal.sectionnums'} ne '') {
8210: @currsections = split(/,/,$$settings{'internal.sectionnums'});
8211: }
8212:
8213: if ($$settings{'internal.crosslistings'} ne '') {
8214: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
8215: }
8216:
8217: if (@currxlists > 0) {
8218: foreach (@currxlists) {
8219: if (m/^([^:]+):(\w*)$/) {
8220: unless (grep/^$1$/,@{$allcourses}) {
8221: push @{$allcourses},$1;
8222: $$LC_code{$1} = $2;
8223: }
8224: }
8225: }
8226: }
8227:
8228: if (@currsections > 0) {
8229: foreach (@currsections) {
8230: if (m/^(\w+):(\w*)$/) {
8231: my $sec = $coursecode.$1;
8232: my $lc_sec = $2;
8233: unless (grep/^$sec$/,@{$allcourses}) {
8234: push @{$allcourses},$sec;
8235: $$LC_code{$sec} = $lc_sec;
8236: }
8237: }
8238: }
8239: }
8240: return;
8241: }
8242:
1.112 bowersj2 8243: =pod
8244:
1.780 raeburn 8245: =head1 Slot Helpers
8246:
8247: =over 4
8248:
8249: =item * sorted_slots()
8250:
8251: Sorts an array of slot names in order of slot start time (earliest first).
8252:
8253: Inputs:
8254:
8255: =over 4
8256:
8257: slotsarr - Reference to array of unsorted slot names.
8258:
8259: slots - Reference to hash of hash, where outer hash keys are slot names.
8260:
1.549 albertel 8261: =back
8262:
1.780 raeburn 8263: Returns:
8264:
8265: =over 4
8266:
8267: sorted - An array of slot names sorted by the start time of the slot.
8268:
8269: =back
8270:
8271: =back
8272:
8273: =cut
8274:
8275:
8276: sub sorted_slots {
8277: my ($slotsarr,$slots) = @_;
8278: my @sorted;
8279: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
8280: @sorted =
8281: sort {
8282: if (ref($slots->{$a}) && ref($slots->{$b})) {
8283: return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
8284: }
8285: if (ref($slots->{$a})) { return -1;}
8286: if (ref($slots->{$b})) { return 1;}
8287: return 0;
8288: } @{$slotsarr};
8289: }
8290: return @sorted;
8291: }
8292:
8293:
8294: =pod
8295:
1.549 albertel 8296: =head1 HTTP Helpers
8297:
8298: =over 4
8299:
1.648 raeburn 8300: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 8301:
1.258 albertel 8302: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 8303: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 8304: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 8305:
8306: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
8307: $possible_names is an ref to an array of form element names. As an example:
8308: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 8309: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 8310:
8311: =cut
1.1 albertel 8312:
1.6 albertel 8313: sub get_unprocessed_cgi {
1.25 albertel 8314: my ($query,$possible_names)= @_;
1.26 matthew 8315: # $Apache::lonxml::debug=1;
1.356 albertel 8316: foreach my $pair (split(/&/,$query)) {
8317: my ($name, $value) = split(/=/,$pair);
1.369 www 8318: $name = &unescape($name);
1.25 albertel 8319: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
8320: $value =~ tr/+/ /;
8321: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 8322: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 8323: }
1.16 harris41 8324: }
1.6 albertel 8325: }
8326:
1.112 bowersj2 8327: =pod
8328:
1.648 raeburn 8329: =item * &cacheheader()
1.112 bowersj2 8330:
8331: returns cache-controlling header code
8332:
8333: =cut
8334:
1.7 albertel 8335: sub cacheheader {
1.258 albertel 8336: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 8337: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
8338: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 8339: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
8340: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 8341: return $output;
1.7 albertel 8342: }
8343:
1.112 bowersj2 8344: =pod
8345:
1.648 raeburn 8346: =item * &no_cache($r)
1.112 bowersj2 8347:
8348: specifies header code to not have cache
8349:
8350: =cut
8351:
1.9 albertel 8352: sub no_cache {
1.216 albertel 8353: my ($r) = @_;
8354: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 8355: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 8356: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
8357: $r->no_cache(1);
8358: $r->header_out("Expires" => $date);
8359: $r->header_out("Pragma" => "no-cache");
1.123 www 8360: }
8361:
8362: sub content_type {
1.181 albertel 8363: my ($r,$type,$charset) = @_;
1.299 foxr 8364: if ($r) {
8365: # Note that printout.pl calls this with undef for $r.
8366: &no_cache($r);
8367: }
1.258 albertel 8368: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 8369: unless ($charset) {
8370: $charset=&Apache::lonlocal::current_encoding;
8371: }
8372: if ($charset) { $type.='; charset='.$charset; }
8373: if ($r) {
8374: $r->content_type($type);
8375: } else {
8376: print("Content-type: $type\n\n");
8377: }
1.9 albertel 8378: }
1.25 albertel 8379:
1.112 bowersj2 8380: =pod
8381:
1.648 raeburn 8382: =item * &add_to_env($name,$value)
1.112 bowersj2 8383:
1.258 albertel 8384: adds $name to the %env hash with value
1.112 bowersj2 8385: $value, if $name already exists, the entry is converted to an array
8386: reference and $value is added to the array.
8387:
8388: =cut
8389:
1.25 albertel 8390: sub add_to_env {
8391: my ($name,$value)=@_;
1.258 albertel 8392: if (defined($env{$name})) {
8393: if (ref($env{$name})) {
1.25 albertel 8394: #already have multiple values
1.258 albertel 8395: push(@{ $env{$name} },$value);
1.25 albertel 8396: } else {
8397: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 8398: my $first=$env{$name};
8399: undef($env{$name});
8400: push(@{ $env{$name} },$first,$value);
1.25 albertel 8401: }
8402: } else {
1.258 albertel 8403: $env{$name}=$value;
1.25 albertel 8404: }
1.31 albertel 8405: }
1.149 albertel 8406:
8407: =pod
8408:
1.648 raeburn 8409: =item * &get_env_multiple($name)
1.149 albertel 8410:
1.258 albertel 8411: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 8412: values may be defined and end up as an array ref.
8413:
8414: returns an array of values
8415:
8416: =cut
8417:
8418: sub get_env_multiple {
8419: my ($name) = @_;
8420: my @values;
1.258 albertel 8421: if (defined($env{$name})) {
1.149 albertel 8422: # exists is it an array
1.258 albertel 8423: if (ref($env{$name})) {
8424: @values=@{ $env{$name} };
1.149 albertel 8425: } else {
1.258 albertel 8426: $values[0]=$env{$name};
1.149 albertel 8427: }
8428: }
8429: return(@values);
8430: }
8431:
1.660 raeburn 8432: sub ask_for_embedded_content {
8433: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
8434: my $upload_output = '
8435: <form name="upload_embedded" action="'.$actionurl.'"
8436: method="post" enctype="multipart/form-data">';
8437: $upload_output .= $state;
1.661 raeburn 8438: $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660 raeburn 8439:
8440: my $num = 0;
8441: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
8442: $upload_output .= &start_data_table_row().
8443: '<td>'.$embed_file.'</td><td>';
8444: if ($args->{'ignore_remote_references'}
8445: && $embed_file =~ m{^\w+://}) {
8446: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
8447: } elsif ($args->{'error_on_invalid_names'}
8448: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
8449:
8450: $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
8451:
8452: } else {
8453: $upload_output .='
1.661 raeburn 8454: <input name="embedded_item_'.$num.'" type="file" value="" />
1.660 raeburn 8455: <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
8456: my $attrib = join(':',@{$$allfiles{$embed_file}});
8457: $upload_output .=
8458: "\n\t\t".
8459: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
8460: $attrib.'" />';
8461: if (exists($$codebase{$embed_file})) {
8462: $upload_output .=
8463: "\n\t\t".
8464: '<input name="codebase_'.$num.'" type="hidden" value="'.
8465: &escape($$codebase{$embed_file}).'" />';
8466: }
8467: }
8468: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
8469: $num++;
8470: }
8471: $upload_output .= &Apache::loncommon::end_data_table().'<br />
8472: <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
8473: <input type ="submit" value="'.&mt('Upload Listed Files').'" />
8474: '.&mt('(only files for which a location has been provided will be uploaded)').'
8475: </form>';
8476: return $upload_output;
8477: }
8478:
1.661 raeburn 8479: sub upload_embedded {
8480: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
8481: $current_disk_usage) = @_;
8482: my $output;
8483: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
8484: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
8485: my $orig_uploaded_filename =
8486: $env{'form.embedded_item_'.$i.'.filename'};
8487:
8488: $env{'form.embedded_orig_'.$i} =
8489: &unescape($env{'form.embedded_orig_'.$i});
8490: my ($path,$fname) =
8491: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
8492: # no path, whole string is fname
8493: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
8494:
8495: $path = $env{'form.currentpath'}.$path;
8496: $fname = &Apache::lonnet::clean_filename($fname);
8497: # See if there is anything left
8498: next if ($fname eq '');
8499:
8500: # Check if file already exists as a file or directory.
8501: my ($state,$msg);
8502: if ($context eq 'portfolio') {
8503: my $port_path = $dirpath;
8504: if ($group ne '') {
8505: $port_path = "groups/$group/$port_path";
8506: }
8507: ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
8508: $dir_root,$port_path,$disk_quota,
8509: $current_disk_usage,$uname,$udom);
8510: if ($state eq 'will_exceed_quota'
8511: || $state eq 'file_locked'
8512: || $state eq 'file_exists' ) {
8513: $output .= $msg;
8514: next;
8515: }
8516: } elsif (($context eq 'author') || ($context eq 'testbank')) {
8517: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
8518: if ($state eq 'exists') {
8519: $output .= $msg;
8520: next;
8521: }
8522: }
8523: # Check if extension is valid
8524: if (($fname =~ /\.(\w+)$/) &&
8525: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
8526: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
8527: next;
8528: } elsif (($fname =~ /\.(\w+)$/) &&
8529: (!defined(&Apache::loncommon::fileembstyle($1)))) {
8530: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
8531: next;
8532: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
8533: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
8534: next;
8535: }
8536:
8537: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
8538: if ($context eq 'portfolio') {
8539: my $result=
8540: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
8541: $dirpath.$path);
8542: if ($result !~ m|^/uploaded/|) {
8543: $output .= '<span class="LC_error">'
8544: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
8545: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
8546: .'</span><br />';
8547: next;
8548: } else {
8549: $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
8550: $path.$fname.'</span>').'</p>';
8551: }
8552: } else {
8553: # Save the file
8554: my $target = $env{'form.embedded_item_'.$i};
8555: my $fullpath = $dir_root.$dirpath.'/'.$path;
8556: my $dest = $fullpath.$fname;
8557: my $url = $url_root.$dirpath.'/'.$path.$fname;
8558: my @parts=split(/\//,$fullpath);
8559: my $count;
8560: my $filepath = $dir_root;
8561: for ($count=4;$count<=$#parts;$count++) {
8562: $filepath .= "/$parts[$count]";
8563: if ((-e $filepath)!=1) {
8564: mkdir($filepath,0770);
8565: }
8566: }
8567: my $fh;
8568: if (!open($fh,'>'.$dest)) {
8569: &Apache::lonnet::logthis('Failed to create '.$dest);
8570: $output .= '<span class="LC_error">'.
8571: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8572: '</span><br />';
8573: } else {
8574: if (!print $fh $env{'form.embedded_item_'.$i}) {
8575: &Apache::lonnet::logthis('Failed to write to '.$dest);
8576: $output .= '<span class="LC_error">'.
8577: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8578: '</span><br />';
8579: } else {
8580: if ($context eq 'testbank') {
8581: $output .= &mt('Embedded file uploaded successfully:').
8582: ' <a href="'.$url.'">'.
8583: $orig_uploaded_filename.'</a><br />';
8584: } else {
1.705 tempelho 8585: $output .= '<span class=\"LC_fontsize_large\">'.
1.661 raeburn 8586: &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705 tempelho 8587: $orig_uploaded_filename.'</a>').'</span><br />';
1.661 raeburn 8588: }
8589: }
8590: close($fh);
8591: }
8592: }
8593: }
8594: return $output;
8595: }
8596:
8597: sub check_for_existing {
8598: my ($path,$fname,$element) = @_;
8599: my ($state,$msg);
8600: if (-d $path.'/'.$fname) {
8601: $state = 'exists';
8602: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8603: } elsif (-e $path.'/'.$fname) {
8604: $state = 'exists';
8605: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8606: }
8607: if ($state eq 'exists') {
8608: $msg = '<span class="LC_error">'.$msg.'</span><br />';
8609: }
8610: return ($state,$msg);
8611: }
8612:
8613: sub check_for_upload {
8614: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
8615: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
8616: my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
8617: my $getpropath = 1;
8618: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
8619: $getpropath);
8620: my $found_file = 0;
8621: my $locked_file = 0;
8622: foreach my $line (@dir_list) {
8623: my ($file_name)=split(/\&/,$line,2);
8624: if ($file_name eq $fname){
8625: $file_name = $path.$file_name;
8626: if ($group ne '') {
8627: $file_name = $group.$file_name;
8628: }
8629: $found_file = 1;
8630: if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
8631: $locked_file = 1;
8632: }
8633: }
8634: }
8635: if (($current_disk_usage + $filesize) > $disk_quota){
8636: my $msg = '<span class="LC_error">'.
8637: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
8638: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
8639: return ('will_exceed_quota',$msg);
8640: } elsif ($found_file) {
8641: if ($locked_file) {
8642: my $msg = '<span class="LC_error">';
8643: $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>');
8644: $msg .= '</span><br />';
8645: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
8646: return ('file_locked',$msg);
8647: } else {
8648: my $msg = '<span class="LC_error">';
8649: $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'});
8650: $msg .= '</span>';
8651: $msg .= '<br />';
8652: $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
8653: return ('file_exists',$msg);
8654: }
8655: }
8656: }
8657:
1.31 albertel 8658:
1.41 ng 8659: =pod
1.45 matthew 8660:
1.464 albertel 8661: =back
1.41 ng 8662:
1.112 bowersj2 8663: =head1 CSV Upload/Handling functions
1.38 albertel 8664:
1.41 ng 8665: =over 4
8666:
1.648 raeburn 8667: =item * &upfile_store($r)
1.41 ng 8668:
8669: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 8670: needs $env{'form.upfile'}
1.41 ng 8671: returns $datatoken to be put into hidden field
8672:
8673: =cut
1.31 albertel 8674:
8675: sub upfile_store {
8676: my $r=shift;
1.258 albertel 8677: $env{'form.upfile'}=~s/\r/\n/gs;
8678: $env{'form.upfile'}=~s/\f/\n/gs;
8679: $env{'form.upfile'}=~s/\n+/\n/gs;
8680: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 8681:
1.258 albertel 8682: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
8683: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 8684: {
1.158 raeburn 8685: my $datafile = $r->dir_config('lonDaemons').
8686: '/tmp/'.$datatoken.'.tmp';
8687: if ( open(my $fh,">$datafile") ) {
1.258 albertel 8688: print $fh $env{'form.upfile'};
1.158 raeburn 8689: close($fh);
8690: }
1.31 albertel 8691: }
8692: return $datatoken;
8693: }
8694:
1.56 matthew 8695: =pod
8696:
1.648 raeburn 8697: =item * &load_tmp_file($r)
1.41 ng 8698:
8699: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 8700: needs $env{'form.datatoken'},
8701: sets $env{'form.upfile'} to the contents of the file
1.41 ng 8702:
8703: =cut
1.31 albertel 8704:
8705: sub load_tmp_file {
8706: my $r=shift;
8707: my @studentdata=();
8708: {
1.158 raeburn 8709: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 8710: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 8711: if ( open(my $fh,"<$studentfile") ) {
8712: @studentdata=<$fh>;
8713: close($fh);
8714: }
1.31 albertel 8715: }
1.258 albertel 8716: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 8717: }
8718:
1.56 matthew 8719: =pod
8720:
1.648 raeburn 8721: =item * &upfile_record_sep()
1.41 ng 8722:
8723: Separate uploaded file into records
8724: returns array of records,
1.258 albertel 8725: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 8726:
8727: =cut
1.31 albertel 8728:
8729: sub upfile_record_sep {
1.258 albertel 8730: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 8731: } else {
1.248 albertel 8732: my @records;
1.258 albertel 8733: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 8734: if ($line=~/^\s*$/) { next; }
8735: push(@records,$line);
8736: }
8737: return @records;
1.31 albertel 8738: }
8739: }
8740:
1.56 matthew 8741: =pod
8742:
1.648 raeburn 8743: =item * &record_sep($record)
1.41 ng 8744:
1.258 albertel 8745: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 8746:
8747: =cut
8748:
1.263 www 8749: sub takeleft {
8750: my $index=shift;
8751: return substr('0000'.$index,-4,4);
8752: }
8753:
1.31 albertel 8754: sub record_sep {
8755: my $record=shift;
8756: my %components=();
1.258 albertel 8757: if ($env{'form.upfiletype'} eq 'xml') {
8758: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 8759: my $i=0;
1.356 albertel 8760: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 8761: $field=~s/^(\"|\')//;
8762: $field=~s/(\"|\')$//;
1.263 www 8763: $components{&takeleft($i)}=$field;
1.31 albertel 8764: $i++;
8765: }
1.258 albertel 8766: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 8767: my $i=0;
1.356 albertel 8768: foreach my $field (split(/\t/,$record)) {
1.31 albertel 8769: $field=~s/^(\"|\')//;
8770: $field=~s/(\"|\')$//;
1.263 www 8771: $components{&takeleft($i)}=$field;
1.31 albertel 8772: $i++;
8773: }
8774: } else {
1.561 www 8775: my $separator=',';
1.480 banghart 8776: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 8777: $separator=';';
1.480 banghart 8778: }
1.31 albertel 8779: my $i=0;
1.561 www 8780: # the character we are looking for to indicate the end of a quote or a record
8781: my $looking_for=$separator;
8782: # do not add the characters to the fields
8783: my $ignore=0;
8784: # we just encountered a separator (or the beginning of the record)
8785: my $just_found_separator=1;
8786: # store the field we are working on here
8787: my $field='';
8788: # work our way through all characters in record
8789: foreach my $character ($record=~/(.)/g) {
8790: if ($character eq $looking_for) {
8791: if ($character ne $separator) {
8792: # Found the end of a quote, again looking for separator
8793: $looking_for=$separator;
8794: $ignore=1;
8795: } else {
8796: # Found a separator, store away what we got
8797: $components{&takeleft($i)}=$field;
8798: $i++;
8799: $just_found_separator=1;
8800: $ignore=0;
8801: $field='';
8802: }
8803: next;
8804: }
8805: # single or double quotation marks after a separator indicate beginning of a quote
8806: # we are now looking for the end of the quote and need to ignore separators
8807: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
8808: $looking_for=$character;
8809: next;
8810: }
8811: # ignore would be true after we reached the end of a quote
8812: if ($ignore) { next; }
8813: if (($just_found_separator) && ($character=~/\s/)) { next; }
8814: $field.=$character;
8815: $just_found_separator=0;
1.31 albertel 8816: }
1.561 www 8817: # catch the very last entry, since we never encountered the separator
8818: $components{&takeleft($i)}=$field;
1.31 albertel 8819: }
8820: return %components;
8821: }
8822:
1.144 matthew 8823: ######################################################
8824: ######################################################
8825:
1.56 matthew 8826: =pod
8827:
1.648 raeburn 8828: =item * &upfile_select_html()
1.41 ng 8829:
1.144 matthew 8830: Return HTML code to select a file from the users machine and specify
8831: the file type.
1.41 ng 8832:
8833: =cut
8834:
1.144 matthew 8835: ######################################################
8836: ######################################################
1.31 albertel 8837: sub upfile_select_html {
1.144 matthew 8838: my %Types = (
8839: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 8840: semisv => &mt('Semicolon separated values'),
1.144 matthew 8841: space => &mt('Space separated'),
8842: tab => &mt('Tabulator separated'),
8843: # xml => &mt('HTML/XML'),
8844: );
8845: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 8846: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 8847: foreach my $type (sort(keys(%Types))) {
8848: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
8849: }
8850: $Str .= "</select>\n";
8851: return $Str;
1.31 albertel 8852: }
8853:
1.301 albertel 8854: sub get_samples {
8855: my ($records,$toget) = @_;
8856: my @samples=({});
8857: my $got=0;
8858: foreach my $rec (@$records) {
8859: my %temp = &record_sep($rec);
8860: if (! grep(/\S/, values(%temp))) { next; }
8861: if (%temp) {
8862: $samples[$got]=\%temp;
8863: $got++;
8864: if ($got == $toget) { last; }
8865: }
8866: }
8867: return \@samples;
8868: }
8869:
1.144 matthew 8870: ######################################################
8871: ######################################################
8872:
1.56 matthew 8873: =pod
8874:
1.648 raeburn 8875: =item * &csv_print_samples($r,$records)
1.41 ng 8876:
8877: Prints a table of sample values from each column uploaded $r is an
8878: Apache Request ref, $records is an arrayref from
8879: &Apache::loncommon::upfile_record_sep
8880:
8881: =cut
8882:
1.144 matthew 8883: ######################################################
8884: ######################################################
1.31 albertel 8885: sub csv_print_samples {
8886: my ($r,$records) = @_;
1.662 bisitz 8887: my $samples = &get_samples($records,5);
1.301 albertel 8888:
1.594 raeburn 8889: $r->print(&mt('Samples').'<br />'.&start_data_table().
8890: &start_data_table_header_row());
1.356 albertel 8891: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 8892: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 8893: $r->print(&end_data_table_header_row());
1.301 albertel 8894: foreach my $hash (@$samples) {
1.594 raeburn 8895: $r->print(&start_data_table_row());
1.356 albertel 8896: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 8897: $r->print('<td>');
1.356 albertel 8898: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 8899: $r->print('</td>');
8900: }
1.594 raeburn 8901: $r->print(&end_data_table_row());
1.31 albertel 8902: }
1.594 raeburn 8903: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 8904: }
8905:
1.144 matthew 8906: ######################################################
8907: ######################################################
8908:
1.56 matthew 8909: =pod
8910:
1.648 raeburn 8911: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 8912:
8913: Prints a table to create associations between values and table columns.
1.144 matthew 8914:
1.41 ng 8915: $r is an Apache Request ref,
8916: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 8917: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 8918:
8919: =cut
8920:
1.144 matthew 8921: ######################################################
8922: ######################################################
1.31 albertel 8923: sub csv_print_select_table {
8924: my ($r,$records,$d) = @_;
1.301 albertel 8925: my $i=0;
8926: my $samples = &get_samples($records,1);
1.144 matthew 8927: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 8928: &start_data_table().&start_data_table_header_row().
1.144 matthew 8929: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 8930: '<th>'.&mt('Column').'</th>'.
8931: &end_data_table_header_row()."\n");
1.356 albertel 8932: foreach my $array_ref (@$d) {
8933: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 8934: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 8935:
1.875 bisitz 8936: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 8937: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 8938: $r->print('<option value="none"></option>');
1.356 albertel 8939: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8940: $r->print('<option value="'.$sample.'"'.
8941: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 8942: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 8943: }
1.594 raeburn 8944: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 8945: $i++;
8946: }
1.594 raeburn 8947: $r->print(&end_data_table());
1.31 albertel 8948: $i--;
8949: return $i;
8950: }
1.56 matthew 8951:
1.144 matthew 8952: ######################################################
8953: ######################################################
8954:
1.56 matthew 8955: =pod
1.31 albertel 8956:
1.648 raeburn 8957: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 8958:
8959: Prints a table of sample values from the upload and can make associate samples to internal names.
8960:
8961: $r is an Apache Request ref,
8962: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
8963: $d is an array of 2 element arrays (internal name, displayed name)
8964:
8965: =cut
8966:
1.144 matthew 8967: ######################################################
8968: ######################################################
1.31 albertel 8969: sub csv_samples_select_table {
8970: my ($r,$records,$d) = @_;
8971: my $i=0;
1.144 matthew 8972: #
1.662 bisitz 8973: my $max_samples = 5;
8974: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 8975: $r->print(&start_data_table().
8976: &start_data_table_header_row().'<th>'.
8977: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
8978: &end_data_table_header_row());
1.301 albertel 8979:
8980: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 8981: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 8982: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 8983: foreach my $option (@$d) {
8984: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 8985: $r->print('<option value="'.$value.'"'.
1.253 albertel 8986: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 8987: $display.'</option>');
1.31 albertel 8988: }
8989: $r->print('</select></td><td>');
1.662 bisitz 8990: foreach my $line (0..($max_samples-1)) {
1.301 albertel 8991: if (defined($samples->[$line]{$key})) {
8992: $r->print($samples->[$line]{$key}."<br />\n");
8993: }
8994: }
1.594 raeburn 8995: $r->print('</td>'.&end_data_table_row());
1.31 albertel 8996: $i++;
8997: }
1.594 raeburn 8998: $r->print(&end_data_table());
1.31 albertel 8999: $i--;
9000: return($i);
1.115 matthew 9001: }
9002:
1.144 matthew 9003: ######################################################
9004: ######################################################
9005:
1.115 matthew 9006: =pod
9007:
1.648 raeburn 9008: =item * &clean_excel_name($name)
1.115 matthew 9009:
9010: Returns a replacement for $name which does not contain any illegal characters.
9011:
9012: =cut
9013:
1.144 matthew 9014: ######################################################
9015: ######################################################
1.115 matthew 9016: sub clean_excel_name {
9017: my ($name) = @_;
9018: $name =~ s/[:\*\?\/\\]//g;
9019: if (length($name) > 31) {
9020: $name = substr($name,0,31);
9021: }
9022: return $name;
1.25 albertel 9023: }
1.84 albertel 9024:
1.85 albertel 9025: =pod
9026:
1.648 raeburn 9027: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 9028:
9029: Returns either 1 or undef
9030:
9031: 1 if the part is to be hidden, undef if it is to be shown
9032:
9033: Arguments are:
9034:
9035: $id the id of the part to be checked
9036: $symb, optional the symb of the resource to check
9037: $udom, optional the domain of the user to check for
9038: $uname, optional the username of the user to check for
9039:
9040: =cut
1.84 albertel 9041:
9042: sub check_if_partid_hidden {
9043: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 9044: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 9045: $symb,$udom,$uname);
1.141 albertel 9046: my $truth=1;
9047: #if the string starts with !, then the list is the list to show not hide
9048: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 9049: my @hiddenlist=split(/,/,$hiddenparts);
9050: foreach my $checkid (@hiddenlist) {
1.141 albertel 9051: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 9052: }
1.141 albertel 9053: return !$truth;
1.84 albertel 9054: }
1.127 matthew 9055:
1.138 matthew 9056:
9057: ############################################################
9058: ############################################################
9059:
9060: =pod
9061:
1.157 matthew 9062: =back
9063:
1.138 matthew 9064: =head1 cgi-bin script and graphing routines
9065:
1.157 matthew 9066: =over 4
9067:
1.648 raeburn 9068: =item * &get_cgi_id()
1.138 matthew 9069:
9070: Inputs: none
9071:
9072: Returns an id which can be used to pass environment variables
9073: to various cgi-bin scripts. These environment variables will
9074: be removed from the users environment after a given time by
9075: the routine &Apache::lonnet::transfer_profile_to_env.
9076:
9077: =cut
9078:
9079: ############################################################
9080: ############################################################
1.152 albertel 9081: my $uniq=0;
1.136 matthew 9082: sub get_cgi_id {
1.154 albertel 9083: $uniq=($uniq+1)%100000;
1.280 albertel 9084: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 9085: }
9086:
1.127 matthew 9087: ############################################################
9088: ############################################################
9089:
9090: =pod
9091:
1.648 raeburn 9092: =item * &DrawBarGraph()
1.127 matthew 9093:
1.138 matthew 9094: Facilitates the plotting of data in a (stacked) bar graph.
9095: Puts plot definition data into the users environment in order for
9096: graph.png to plot it. Returns an <img> tag for the plot.
9097: The bars on the plot are labeled '1','2',...,'n'.
9098:
9099: Inputs:
9100:
9101: =over 4
9102:
9103: =item $Title: string, the title of the plot
9104:
9105: =item $xlabel: string, text describing the X-axis of the plot
9106:
9107: =item $ylabel: string, text describing the Y-axis of the plot
9108:
9109: =item $Max: scalar, the maximum Y value to use in the plot
9110: If $Max is < any data point, the graph will not be rendered.
9111:
1.140 matthew 9112: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 9113: they are plotted. If undefined, default values will be used.
9114:
1.178 matthew 9115: =item $labels: array ref holding the labels to use on the x-axis for the bars.
9116:
1.138 matthew 9117: =item @Values: An array of array references. Each array reference holds data
9118: to be plotted in a stacked bar chart.
9119:
1.239 matthew 9120: =item If the final element of @Values is a hash reference the key/value
9121: pairs will be added to the graph definition.
9122:
1.138 matthew 9123: =back
9124:
9125: Returns:
9126:
9127: An <img> tag which references graph.png and the appropriate identifying
9128: information for the plot.
9129:
1.127 matthew 9130: =cut
9131:
9132: ############################################################
9133: ############################################################
1.134 matthew 9134: sub DrawBarGraph {
1.178 matthew 9135: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 9136: #
9137: if (! defined($colors)) {
9138: $colors = ['#33ff00',
9139: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
9140: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
9141: ];
9142: }
1.228 matthew 9143: my $extra_settings = {};
9144: if (ref($Values[-1]) eq 'HASH') {
9145: $extra_settings = pop(@Values);
9146: }
1.127 matthew 9147: #
1.136 matthew 9148: my $identifier = &get_cgi_id();
9149: my $id = 'cgi.'.$identifier;
1.129 matthew 9150: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 9151: return '';
9152: }
1.225 matthew 9153: #
9154: my @Labels;
9155: if (defined($labels)) {
9156: @Labels = @$labels;
9157: } else {
9158: for (my $i=0;$i<@{$Values[0]};$i++) {
9159: push (@Labels,$i+1);
9160: }
9161: }
9162: #
1.129 matthew 9163: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 9164: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 9165: my %ValuesHash;
9166: my $NumSets=1;
9167: foreach my $array (@Values) {
9168: next if (! ref($array));
1.136 matthew 9169: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 9170: join(',',@$array);
1.129 matthew 9171: }
1.127 matthew 9172: #
1.136 matthew 9173: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 9174: if ($NumBars < 3) {
9175: $width = 120+$NumBars*32;
1.220 matthew 9176: $xskip = 1;
1.225 matthew 9177: $bar_width = 30;
9178: } elsif ($NumBars < 5) {
9179: $width = 120+$NumBars*20;
9180: $xskip = 1;
9181: $bar_width = 20;
1.220 matthew 9182: } elsif ($NumBars < 10) {
1.136 matthew 9183: $width = 120+$NumBars*15;
9184: $xskip = 1;
9185: $bar_width = 15;
9186: } elsif ($NumBars <= 25) {
9187: $width = 120+$NumBars*11;
9188: $xskip = 5;
9189: $bar_width = 8;
9190: } elsif ($NumBars <= 50) {
9191: $width = 120+$NumBars*8;
9192: $xskip = 5;
9193: $bar_width = 4;
9194: } else {
9195: $width = 120+$NumBars*8;
9196: $xskip = 5;
9197: $bar_width = 4;
9198: }
9199: #
1.137 matthew 9200: $Max = 1 if ($Max < 1);
9201: if ( int($Max) < $Max ) {
9202: $Max++;
9203: $Max = int($Max);
9204: }
1.127 matthew 9205: $Title = '' if (! defined($Title));
9206: $xlabel = '' if (! defined($xlabel));
9207: $ylabel = '' if (! defined($ylabel));
1.369 www 9208: $ValuesHash{$id.'.title'} = &escape($Title);
9209: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
9210: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 9211: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 9212: $ValuesHash{$id.'.NumBars'} = $NumBars;
9213: $ValuesHash{$id.'.NumSets'} = $NumSets;
9214: $ValuesHash{$id.'.PlotType'} = 'bar';
9215: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9216: $ValuesHash{$id.'.height'} = $height;
9217: $ValuesHash{$id.'.width'} = $width;
9218: $ValuesHash{$id.'.xskip'} = $xskip;
9219: $ValuesHash{$id.'.bar_width'} = $bar_width;
9220: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 9221: #
1.228 matthew 9222: # Deal with other parameters
9223: while (my ($key,$value) = each(%$extra_settings)) {
9224: $ValuesHash{$id.'.'.$key} = $value;
9225: }
9226: #
1.646 raeburn 9227: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 9228: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9229: }
9230:
9231: ############################################################
9232: ############################################################
9233:
9234: =pod
9235:
1.648 raeburn 9236: =item * &DrawXYGraph()
1.137 matthew 9237:
1.138 matthew 9238: Facilitates the plotting of data in an XY graph.
9239: Puts plot definition data into the users environment in order for
9240: graph.png to plot it. Returns an <img> tag for the plot.
9241:
9242: Inputs:
9243:
9244: =over 4
9245:
9246: =item $Title: string, the title of the plot
9247:
9248: =item $xlabel: string, text describing the X-axis of the plot
9249:
9250: =item $ylabel: string, text describing the Y-axis of the plot
9251:
9252: =item $Max: scalar, the maximum Y value to use in the plot
9253: If $Max is < any data point, the graph will not be rendered.
9254:
9255: =item $colors: Array ref containing the hex color codes for the data to be
9256: plotted in. If undefined, default values will be used.
9257:
9258: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9259:
9260: =item $Ydata: Array ref containing Array refs.
1.185 www 9261: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 9262:
9263: =item %Values: hash indicating or overriding any default values which are
9264: passed to graph.png.
9265: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9266:
9267: =back
9268:
9269: Returns:
9270:
9271: An <img> tag which references graph.png and the appropriate identifying
9272: information for the plot.
9273:
1.137 matthew 9274: =cut
9275:
9276: ############################################################
9277: ############################################################
9278: sub DrawXYGraph {
9279: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
9280: #
9281: # Create the identifier for the graph
9282: my $identifier = &get_cgi_id();
9283: my $id = 'cgi.'.$identifier;
9284: #
9285: $Title = '' if (! defined($Title));
9286: $xlabel = '' if (! defined($xlabel));
9287: $ylabel = '' if (! defined($ylabel));
9288: my %ValuesHash =
9289: (
1.369 www 9290: $id.'.title' => &escape($Title),
9291: $id.'.xlabel' => &escape($xlabel),
9292: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 9293: $id.'.y_max_value'=> $Max,
9294: $id.'.labels' => join(',',@$Xlabels),
9295: $id.'.PlotType' => 'XY',
9296: );
9297: #
9298: if (defined($colors) && ref($colors) eq 'ARRAY') {
9299: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9300: }
9301: #
9302: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
9303: return '';
9304: }
9305: my $NumSets=1;
1.138 matthew 9306: foreach my $array (@{$Ydata}){
1.137 matthew 9307: next if (! ref($array));
9308: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
9309: }
1.138 matthew 9310: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 9311: #
9312: # Deal with other parameters
9313: while (my ($key,$value) = each(%Values)) {
9314: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 9315: }
9316: #
1.646 raeburn 9317: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 9318: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9319: }
9320:
9321: ############################################################
9322: ############################################################
9323:
9324: =pod
9325:
1.648 raeburn 9326: =item * &DrawXYYGraph()
1.138 matthew 9327:
9328: Facilitates the plotting of data in an XY graph with two Y axes.
9329: Puts plot definition data into the users environment in order for
9330: graph.png to plot it. Returns an <img> tag for the plot.
9331:
9332: Inputs:
9333:
9334: =over 4
9335:
9336: =item $Title: string, the title of the plot
9337:
9338: =item $xlabel: string, text describing the X-axis of the plot
9339:
9340: =item $ylabel: string, text describing the Y-axis of the plot
9341:
9342: =item $colors: Array ref containing the hex color codes for the data to be
9343: plotted in. If undefined, default values will be used.
9344:
9345: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9346:
9347: =item $Ydata1: The first data set
9348:
9349: =item $Min1: The minimum value of the left Y-axis
9350:
9351: =item $Max1: The maximum value of the left Y-axis
9352:
9353: =item $Ydata2: The second data set
9354:
9355: =item $Min2: The minimum value of the right Y-axis
9356:
9357: =item $Max2: The maximum value of the left Y-axis
9358:
9359: =item %Values: hash indicating or overriding any default values which are
9360: passed to graph.png.
9361: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9362:
9363: =back
9364:
9365: Returns:
9366:
9367: An <img> tag which references graph.png and the appropriate identifying
9368: information for the plot.
1.136 matthew 9369:
9370: =cut
9371:
9372: ############################################################
9373: ############################################################
1.137 matthew 9374: sub DrawXYYGraph {
9375: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
9376: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 9377: #
9378: # Create the identifier for the graph
9379: my $identifier = &get_cgi_id();
9380: my $id = 'cgi.'.$identifier;
9381: #
9382: $Title = '' if (! defined($Title));
9383: $xlabel = '' if (! defined($xlabel));
9384: $ylabel = '' if (! defined($ylabel));
9385: my %ValuesHash =
9386: (
1.369 www 9387: $id.'.title' => &escape($Title),
9388: $id.'.xlabel' => &escape($xlabel),
9389: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 9390: $id.'.labels' => join(',',@$Xlabels),
9391: $id.'.PlotType' => 'XY',
9392: $id.'.NumSets' => 2,
1.137 matthew 9393: $id.'.two_axes' => 1,
9394: $id.'.y1_max_value' => $Max1,
9395: $id.'.y1_min_value' => $Min1,
9396: $id.'.y2_max_value' => $Max2,
9397: $id.'.y2_min_value' => $Min2,
1.136 matthew 9398: );
9399: #
1.137 matthew 9400: if (defined($colors) && ref($colors) eq 'ARRAY') {
9401: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9402: }
9403: #
9404: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
9405: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 9406: return '';
9407: }
9408: my $NumSets=1;
1.137 matthew 9409: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 9410: next if (! ref($array));
9411: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 9412: }
9413: #
9414: # Deal with other parameters
9415: while (my ($key,$value) = each(%Values)) {
9416: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 9417: }
9418: #
1.646 raeburn 9419: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 9420: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 9421: }
9422:
9423: ############################################################
9424: ############################################################
9425:
9426: =pod
9427:
1.157 matthew 9428: =back
9429:
1.139 matthew 9430: =head1 Statistics helper routines?
9431:
9432: Bad place for them but what the hell.
9433:
1.157 matthew 9434: =over 4
9435:
1.648 raeburn 9436: =item * &chartlink()
1.139 matthew 9437:
9438: Returns a link to the chart for a specific student.
9439:
9440: Inputs:
9441:
9442: =over 4
9443:
9444: =item $linktext: The text of the link
9445:
9446: =item $sname: The students username
9447:
9448: =item $sdomain: The students domain
9449:
9450: =back
9451:
1.157 matthew 9452: =back
9453:
1.139 matthew 9454: =cut
9455:
9456: ############################################################
9457: ############################################################
9458: sub chartlink {
9459: my ($linktext, $sname, $sdomain) = @_;
9460: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 9461: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 9462: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 9463: '">'.$linktext.'</a>';
1.153 matthew 9464: }
9465:
9466: #######################################################
9467: #######################################################
9468:
9469: =pod
9470:
9471: =head1 Course Environment Routines
1.157 matthew 9472:
9473: =over 4
1.153 matthew 9474:
1.648 raeburn 9475: =item * &restore_course_settings()
1.153 matthew 9476:
1.648 raeburn 9477: =item * &store_course_settings()
1.153 matthew 9478:
9479: Restores/Store indicated form parameters from the course environment.
9480: Will not overwrite existing values of the form parameters.
9481:
9482: Inputs:
9483: a scalar describing the data (e.g. 'chart', 'problem_analysis')
9484:
9485: a hash ref describing the data to be stored. For example:
9486:
9487: %Save_Parameters = ('Status' => 'scalar',
9488: 'chartoutputmode' => 'scalar',
9489: 'chartoutputdata' => 'scalar',
9490: 'Section' => 'array',
1.373 raeburn 9491: 'Group' => 'array',
1.153 matthew 9492: 'StudentData' => 'array',
9493: 'Maps' => 'array');
9494:
9495: Returns: both routines return nothing
9496:
1.631 raeburn 9497: =back
9498:
1.153 matthew 9499: =cut
9500:
9501: #######################################################
9502: #######################################################
9503: sub store_course_settings {
1.496 albertel 9504: return &store_settings($env{'request.course.id'},@_);
9505: }
9506:
9507: sub store_settings {
1.153 matthew 9508: # save to the environment
9509: # appenv the same items, just to be safe
1.300 albertel 9510: my $udom = $env{'user.domain'};
9511: my $uname = $env{'user.name'};
1.496 albertel 9512: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9513: my %SaveHash;
9514: my %AppHash;
9515: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 9516: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 9517: my $envname = 'environment.'.$basename;
1.258 albertel 9518: if (exists($env{'form.'.$setting})) {
1.153 matthew 9519: # Save this value away
9520: if ($type eq 'scalar' &&
1.258 albertel 9521: (! exists($env{$envname}) ||
9522: $env{$envname} ne $env{'form.'.$setting})) {
9523: $SaveHash{$basename} = $env{'form.'.$setting};
9524: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 9525: } elsif ($type eq 'array') {
9526: my $stored_form;
1.258 albertel 9527: if (ref($env{'form.'.$setting})) {
1.153 matthew 9528: $stored_form = join(',',
9529: map {
1.369 www 9530: &escape($_);
1.258 albertel 9531: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 9532: } else {
9533: $stored_form =
1.369 www 9534: &escape($env{'form.'.$setting});
1.153 matthew 9535: }
9536: # Determine if the array contents are the same.
1.258 albertel 9537: if ($stored_form ne $env{$envname}) {
1.153 matthew 9538: $SaveHash{$basename} = $stored_form;
9539: $AppHash{$envname} = $stored_form;
9540: }
9541: }
9542: }
9543: }
9544: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 9545: $udom,$uname);
1.153 matthew 9546: if ($put_result !~ /^(ok|delayed)/) {
9547: &Apache::lonnet::logthis('unable to save form parameters, '.
9548: 'got error:'.$put_result);
9549: }
9550: # Make sure these settings stick around in this session, too
1.646 raeburn 9551: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 9552: return;
9553: }
9554:
9555: sub restore_course_settings {
1.499 albertel 9556: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 9557: }
9558:
9559: sub restore_settings {
9560: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9561: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 9562: next if (exists($env{'form.'.$setting}));
1.496 albertel 9563: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 9564: '.'.$setting;
1.258 albertel 9565: if (exists($env{$envname})) {
1.153 matthew 9566: if ($type eq 'scalar') {
1.258 albertel 9567: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 9568: } elsif ($type eq 'array') {
1.258 albertel 9569: $env{'form.'.$setting} = [
1.153 matthew 9570: map {
1.369 www 9571: &unescape($_);
1.258 albertel 9572: } split(',',$env{$envname})
1.153 matthew 9573: ];
9574: }
9575: }
9576: }
1.127 matthew 9577: }
9578:
1.618 raeburn 9579: #######################################################
9580: #######################################################
9581:
9582: =pod
9583:
9584: =head1 Domain E-mail Routines
9585:
9586: =over 4
9587:
1.648 raeburn 9588: =item * &build_recipient_list()
1.618 raeburn 9589:
1.884 raeburn 9590: Build recipient lists for five types of e-mail:
1.766 raeburn 9591: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884 raeburn 9592: (d) Help requests, (e) Course requests needing approval, generated by
9593: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
9594: loncoursequeueadmin.pm respectively.
1.618 raeburn 9595:
9596: Inputs:
1.619 raeburn 9597: defmail (scalar - email address of default recipient),
1.618 raeburn 9598: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 9599: defdom (domain for which to retrieve configuration settings),
9600: origmail (scalar - email address of recipient from loncapa.conf,
9601: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 9602:
1.655 raeburn 9603: Returns: comma separated list of addresses to which to send e-mail.
9604:
9605: =back
1.618 raeburn 9606:
9607: =cut
9608:
9609: ############################################################
9610: ############################################################
9611: sub build_recipient_list {
1.619 raeburn 9612: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 9613: my @recipients;
9614: my $otheremails;
9615: my %domconfig =
9616: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
9617: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 9618: if (exists($domconfig{'contacts'}{$mailing})) {
9619: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
9620: my @contacts = ('adminemail','supportemail');
9621: foreach my $item (@contacts) {
9622: if ($domconfig{'contacts'}{$mailing}{$item}) {
9623: my $addr = $domconfig{'contacts'}{$item};
9624: if (!grep(/^\Q$addr\E$/,@recipients)) {
9625: push(@recipients,$addr);
9626: }
1.619 raeburn 9627: }
1.766 raeburn 9628: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 9629: }
9630: }
1.766 raeburn 9631: } elsif ($origmail ne '') {
9632: push(@recipients,$origmail);
1.618 raeburn 9633: }
1.619 raeburn 9634: } elsif ($origmail ne '') {
9635: push(@recipients,$origmail);
1.618 raeburn 9636: }
1.688 raeburn 9637: if (defined($defmail)) {
9638: if ($defmail ne '') {
9639: push(@recipients,$defmail);
9640: }
1.618 raeburn 9641: }
9642: if ($otheremails) {
1.619 raeburn 9643: my @others;
9644: if ($otheremails =~ /,/) {
9645: @others = split(/,/,$otheremails);
1.618 raeburn 9646: } else {
1.619 raeburn 9647: push(@others,$otheremails);
9648: }
9649: foreach my $addr (@others) {
9650: if (!grep(/^\Q$addr\E$/,@recipients)) {
9651: push(@recipients,$addr);
9652: }
1.618 raeburn 9653: }
9654: }
1.619 raeburn 9655: my $recipientlist = join(',',@recipients);
1.618 raeburn 9656: return $recipientlist;
9657: }
9658:
1.127 matthew 9659: ############################################################
9660: ############################################################
1.154 albertel 9661:
1.655 raeburn 9662: =pod
9663:
9664: =head1 Course Catalog Routines
9665:
9666: =over 4
9667:
9668: =item * &gather_categories()
9669:
9670: Converts category definitions - keys of categories hash stored in
9671: coursecategories in configuration.db on the primary library server in a
9672: domain - to an array. Also generates javascript and idx hash used to
9673: generate Domain Coordinator interface for editing Course Categories.
9674:
9675: Inputs:
1.663 raeburn 9676:
1.655 raeburn 9677: categories (reference to hash of category definitions).
1.663 raeburn 9678:
1.655 raeburn 9679: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9680: categories and subcategories).
1.663 raeburn 9681:
1.655 raeburn 9682: idx (reference to hash of counters used in Domain Coordinator interface for
9683: editing Course Categories).
1.663 raeburn 9684:
1.655 raeburn 9685: jsarray (reference to array of categories used to create Javascript arrays for
9686: Domain Coordinator interface for editing Course Categories).
9687:
9688: Returns: nothing
9689:
9690: Side effects: populates cats, idx and jsarray.
9691:
9692: =cut
9693:
9694: sub gather_categories {
9695: my ($categories,$cats,$idx,$jsarray) = @_;
9696: my %counters;
9697: my $num = 0;
9698: foreach my $item (keys(%{$categories})) {
9699: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
9700: if ($container eq '' && $depth == 0) {
9701: $cats->[$depth][$categories->{$item}] = $cat;
9702: } else {
9703: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
9704: }
9705: my ($escitem,$tail) = split(/:/,$item,2);
9706: if ($counters{$tail} eq '') {
9707: $counters{$tail} = $num;
9708: $num ++;
9709: }
9710: if (ref($idx) eq 'HASH') {
9711: $idx->{$item} = $counters{$tail};
9712: }
9713: if (ref($jsarray) eq 'ARRAY') {
9714: push(@{$jsarray->[$counters{$tail}]},$item);
9715: }
9716: }
9717: return;
9718: }
9719:
9720: =pod
9721:
9722: =item * &extract_categories()
9723:
9724: Used to generate breadcrumb trails for course categories.
9725:
9726: Inputs:
1.663 raeburn 9727:
1.655 raeburn 9728: categories (reference to hash of category definitions).
1.663 raeburn 9729:
1.655 raeburn 9730: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9731: categories and subcategories).
1.663 raeburn 9732:
1.655 raeburn 9733: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 9734:
1.655 raeburn 9735: allitems (reference to hash - key is category key
9736: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9737:
1.655 raeburn 9738: idx (reference to hash of counters used in Domain Coordinator interface for
9739: editing Course Categories).
1.663 raeburn 9740:
1.655 raeburn 9741: jsarray (reference to array of categories used to create Javascript arrays for
9742: Domain Coordinator interface for editing Course Categories).
9743:
1.665 raeburn 9744: subcats (reference to hash of arrays containing all subcategories within each
9745: category, -recursive)
9746:
1.655 raeburn 9747: Returns: nothing
9748:
9749: Side effects: populates trails and allitems hash references.
9750:
9751: =cut
9752:
9753: sub extract_categories {
1.665 raeburn 9754: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 9755: if (ref($categories) eq 'HASH') {
9756: &gather_categories($categories,$cats,$idx,$jsarray);
9757: if (ref($cats->[0]) eq 'ARRAY') {
9758: for (my $i=0; $i<@{$cats->[0]}; $i++) {
9759: my $name = $cats->[0][$i];
9760: my $item = &escape($name).'::0';
9761: my $trailstr;
9762: if ($name eq 'instcode') {
9763: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 9764: } elsif ($name eq 'communities') {
9765: $trailstr = &mt('Communities');
1.655 raeburn 9766: } else {
9767: $trailstr = $name;
9768: }
9769: if ($allitems->{$item} eq '') {
9770: push(@{$trails},$trailstr);
9771: $allitems->{$item} = scalar(@{$trails})-1;
9772: }
9773: my @parents = ($name);
9774: if (ref($cats->[1]{$name}) eq 'ARRAY') {
9775: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
9776: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 9777: if (ref($subcats) eq 'HASH') {
9778: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
9779: }
9780: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
9781: }
9782: } else {
9783: if (ref($subcats) eq 'HASH') {
9784: $subcats->{$item} = [];
1.655 raeburn 9785: }
9786: }
9787: }
9788: }
9789: }
9790: return;
9791: }
9792:
9793: =pod
9794:
9795: =item *&recurse_categories()
9796:
9797: Recursively used to generate breadcrumb trails for course categories.
9798:
9799: Inputs:
1.663 raeburn 9800:
1.655 raeburn 9801: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9802: categories and subcategories).
1.663 raeburn 9803:
1.655 raeburn 9804: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 9805:
9806: category (current course category, for which breadcrumb trail is being generated).
9807:
9808: trails (reference to array of breadcrumb trails for each category).
9809:
1.655 raeburn 9810: allitems (reference to hash - key is category key
9811: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9812:
1.655 raeburn 9813: parents (array containing containers directories for current category,
9814: back to top level).
9815:
9816: Returns: nothing
9817:
9818: Side effects: populates trails and allitems hash references
9819:
9820: =cut
9821:
9822: sub recurse_categories {
1.665 raeburn 9823: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 9824: my $shallower = $depth - 1;
9825: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
9826: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
9827: my $name = $cats->[$depth]{$category}[$k];
9828: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9829: my $trailstr = join(' -> ',(@{$parents},$category));
9830: if ($allitems->{$item} eq '') {
9831: push(@{$trails},$trailstr);
9832: $allitems->{$item} = scalar(@{$trails})-1;
9833: }
9834: my $deeper = $depth+1;
9835: push(@{$parents},$category);
1.665 raeburn 9836: if (ref($subcats) eq 'HASH') {
9837: my $subcat = &escape($name).':'.$category.':'.$depth;
9838: for (my $j=@{$parents}; $j>=0; $j--) {
9839: my $higher;
9840: if ($j > 0) {
9841: $higher = &escape($parents->[$j]).':'.
9842: &escape($parents->[$j-1]).':'.$j;
9843: } else {
9844: $higher = &escape($parents->[$j]).'::'.$j;
9845: }
9846: push(@{$subcats->{$higher}},$subcat);
9847: }
9848: }
9849: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
9850: $subcats);
1.655 raeburn 9851: pop(@{$parents});
9852: }
9853: } else {
9854: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9855: my $trailstr = join(' -> ',(@{$parents},$category));
9856: if ($allitems->{$item} eq '') {
9857: push(@{$trails},$trailstr);
9858: $allitems->{$item} = scalar(@{$trails})-1;
9859: }
9860: }
9861: return;
9862: }
9863:
1.663 raeburn 9864: =pod
9865:
9866: =item *&assign_categories_table()
9867:
9868: Create a datatable for display of hierarchical categories in a domain,
9869: with checkboxes to allow a course to be categorized.
9870:
9871: Inputs:
9872:
9873: cathash - reference to hash of categories defined for the domain (from
9874: configuration.db)
9875:
9876: currcat - scalar with an & separated list of categories assigned to a course.
9877:
1.919 raeburn 9878: type - scalar contains course type (Course or Community).
9879:
1.663 raeburn 9880: Returns: $output (markup to be displayed)
9881:
9882: =cut
9883:
9884: sub assign_categories_table {
1.919 raeburn 9885: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 9886: my $output;
9887: if (ref($cathash) eq 'HASH') {
9888: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
9889: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
9890: $maxdepth = scalar(@cats);
9891: if (@cats > 0) {
9892: my $itemcount = 0;
9893: if (ref($cats[0]) eq 'ARRAY') {
9894: my @currcategories;
9895: if ($currcat ne '') {
9896: @currcategories = split('&',$currcat);
9897: }
1.919 raeburn 9898: my $table;
1.663 raeburn 9899: for (my $i=0; $i<@{$cats[0]}; $i++) {
9900: my $parent = $cats[0][$i];
1.919 raeburn 9901: next if ($parent eq 'instcode');
9902: if ($type eq 'Community') {
9903: next unless ($parent eq 'communities');
9904: } else {
9905: next if ($parent eq 'communities');
9906: }
1.663 raeburn 9907: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9908: my $item = &escape($parent).'::0';
9909: my $checked = '';
9910: if (@currcategories > 0) {
9911: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 9912: $checked = ' checked="checked"';
1.663 raeburn 9913: }
9914: }
1.919 raeburn 9915: my $parent_title = $parent;
9916: if ($parent eq 'communities') {
9917: $parent_title = &mt('Communities');
9918: }
9919: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
9920: '<input type="checkbox" name="usecategory" value="'.
9921: $item.'"'.$checked.' />'.$parent_title.'</span>'.
9922: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 9923: my $depth = 1;
9924: push(@path,$parent);
1.919 raeburn 9925: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 9926: pop(@path);
1.919 raeburn 9927: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 9928: $itemcount ++;
9929: }
1.919 raeburn 9930: if ($itemcount) {
9931: $output = &Apache::loncommon::start_data_table().
9932: $table.
9933: &Apache::loncommon::end_data_table();
9934: }
1.663 raeburn 9935: }
9936: }
9937: }
9938: return $output;
9939: }
9940:
9941: =pod
9942:
9943: =item *&assign_category_rows()
9944:
9945: Create a datatable row for display of nested categories in a domain,
9946: with checkboxes to allow a course to be categorized,called recursively.
9947:
9948: Inputs:
9949:
9950: itemcount - track row number for alternating colors
9951:
9952: cats - reference to array of arrays/hashes which encapsulates hierarchy of
9953: categories and subcategories.
9954:
9955: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
9956:
9957: parent - parent of current category item
9958:
9959: path - Array containing all categories back up through the hierarchy from the
9960: current category to the top level.
9961:
9962: currcategories - reference to array of current categories assigned to the course
9963:
9964: Returns: $output (markup to be displayed).
9965:
9966: =cut
9967:
9968: sub assign_category_rows {
9969: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
9970: my ($text,$name,$item,$chgstr);
9971: if (ref($cats) eq 'ARRAY') {
9972: my $maxdepth = scalar(@{$cats});
9973: if (ref($cats->[$depth]) eq 'HASH') {
9974: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
9975: my $numchildren = @{$cats->[$depth]{$parent}};
9976: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9977: $text .= '<td><table class="LC_datatable">';
9978: for (my $j=0; $j<$numchildren; $j++) {
9979: $name = $cats->[$depth]{$parent}[$j];
9980: $item = &escape($name).':'.&escape($parent).':'.$depth;
9981: my $deeper = $depth+1;
9982: my $checked = '';
9983: if (ref($currcategories) eq 'ARRAY') {
9984: if (@{$currcategories} > 0) {
9985: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 9986: $checked = ' checked="checked"';
1.663 raeburn 9987: }
9988: }
9989: }
1.664 raeburn 9990: $text .= '<tr><td><span class="LC_nobreak"><label>'.
9991: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 9992: $item.'"'.$checked.' />'.$name.'</label></span>'.
9993: '<input type="hidden" name="catname" value="'.$name.'" />'.
9994: '</td><td>';
1.663 raeburn 9995: if (ref($path) eq 'ARRAY') {
9996: push(@{$path},$name);
9997: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
9998: pop(@{$path});
9999: }
10000: $text .= '</td></tr>';
10001: }
10002: $text .= '</table></td>';
10003: }
10004: }
10005: }
10006: return $text;
10007: }
10008:
1.655 raeburn 10009: ############################################################
10010: ############################################################
10011:
10012:
1.443 albertel 10013: sub commit_customrole {
1.664 raeburn 10014: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 10015: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 10016: ($start?', '.&mt('starting').' '.localtime($start):'').
10017: ($end?', ending '.localtime($end):'').': <b>'.
10018: &Apache::lonnet::assigncustomrole(
1.664 raeburn 10019: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 10020: '</b><br />';
10021: return $output;
10022: }
10023:
10024: sub commit_standardrole {
1.541 raeburn 10025: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
10026: my ($output,$logmsg,$linefeed);
10027: if ($context eq 'auto') {
10028: $linefeed = "\n";
10029: } else {
10030: $linefeed = "<br />\n";
10031: }
1.443 albertel 10032: if ($three eq 'st') {
1.541 raeburn 10033: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
10034: $one,$two,$sec,$context);
10035: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 10036: ($result eq 'unknown_course') || ($result eq 'refused')) {
10037: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 10038: } else {
1.541 raeburn 10039: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 10040: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 10041: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
10042: if ($context eq 'auto') {
10043: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
10044: } else {
10045: $output .= '<b>'.$result.'</b>'.$linefeed.
10046: &mt('Add to classlist').': <b>ok</b>';
10047: }
10048: $output .= $linefeed;
1.443 albertel 10049: }
10050: } else {
10051: $output = &mt('Assigning').' '.$three.' in '.$url.
10052: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 10053: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 10054: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 10055: if ($context eq 'auto') {
10056: $output .= $result.$linefeed;
10057: } else {
10058: $output .= '<b>'.$result.'</b>'.$linefeed;
10059: }
1.443 albertel 10060: }
10061: return $output;
10062: }
10063:
10064: sub commit_studentrole {
1.541 raeburn 10065: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 10066: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 10067: if ($context eq 'auto') {
10068: $linefeed = "\n";
10069: } else {
10070: $linefeed = '<br />'."\n";
10071: }
1.443 albertel 10072: if (defined($one) && defined($two)) {
10073: my $cid=$one.'_'.$two;
10074: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
10075: my $secchange = 0;
10076: my $expire_role_result;
10077: my $modify_section_result;
1.628 raeburn 10078: if ($oldsec ne '-1') {
10079: if ($oldsec ne $sec) {
1.443 albertel 10080: $secchange = 1;
1.628 raeburn 10081: my $now = time;
1.443 albertel 10082: my $uurl='/'.$cid;
10083: $uurl=~s/\_/\//g;
10084: if ($oldsec) {
10085: $uurl.='/'.$oldsec;
10086: }
1.626 raeburn 10087: $oldsecurl = $uurl;
1.628 raeburn 10088: $expire_role_result =
1.652 raeburn 10089: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 10090: if ($env{'request.course.sec'} ne '') {
10091: if ($expire_role_result eq 'refused') {
10092: my @roles = ('st');
10093: my @statuses = ('previous');
10094: my @roledoms = ($one);
10095: my $withsec = 1;
10096: my %roleshash =
10097: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
10098: \@statuses,\@roles,\@roledoms,$withsec);
10099: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
10100: my ($oldstart,$oldend) =
10101: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
10102: if ($oldend > 0 && $oldend <= $now) {
10103: $expire_role_result = 'ok';
10104: }
10105: }
10106: }
10107: }
1.443 albertel 10108: $result = $expire_role_result;
10109: }
10110: }
10111: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 10112: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 10113: if ($modify_section_result =~ /^ok/) {
10114: if ($secchange == 1) {
1.628 raeburn 10115: if ($sec eq '') {
10116: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
10117: } else {
10118: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
10119: }
1.443 albertel 10120: } elsif ($oldsec eq '-1') {
1.628 raeburn 10121: if ($sec eq '') {
10122: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
10123: } else {
10124: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
10125: }
1.443 albertel 10126: } else {
1.628 raeburn 10127: if ($sec eq '') {
10128: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
10129: } else {
10130: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
10131: }
1.443 albertel 10132: }
10133: } else {
1.628 raeburn 10134: if ($secchange) {
10135: $$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;
10136: } else {
10137: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
10138: }
1.443 albertel 10139: }
10140: $result = $modify_section_result;
10141: } elsif ($secchange == 1) {
1.628 raeburn 10142: if ($oldsec eq '') {
10143: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
10144: } else {
10145: $$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;
10146: }
1.626 raeburn 10147: if ($expire_role_result eq 'refused') {
10148: my $newsecurl = '/'.$cid;
10149: $newsecurl =~ s/\_/\//g;
10150: if ($sec ne '') {
10151: $newsecurl.='/'.$sec;
10152: }
10153: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
10154: if ($sec eq '') {
10155: $$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;
10156: } else {
10157: $$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;
10158: }
10159: }
10160: }
1.443 albertel 10161: }
10162: } else {
1.626 raeburn 10163: $$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 10164: $result = "error: incomplete course id\n";
10165: }
10166: return $result;
10167: }
10168:
10169: ############################################################
10170: ############################################################
10171:
1.566 albertel 10172: sub check_clone {
1.578 raeburn 10173: my ($args,$linefeed) = @_;
1.566 albertel 10174: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
10175: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
10176: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
10177: my $clonemsg;
10178: my $can_clone = 0;
1.944 raeburn 10179: my $lctype = lc($args->{'crstype'});
1.908 raeburn 10180: if ($lctype ne 'community') {
10181: $lctype = 'course';
10182: }
1.566 albertel 10183: if ($clonehome eq 'no_host') {
1.944 raeburn 10184: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10185: $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'});
10186: } else {
10187: $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'});
10188: }
1.566 albertel 10189: } else {
10190: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944 raeburn 10191: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10192: if ($clonedesc{'type'} ne 'Community') {
10193: $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'});
10194: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10195: }
10196: }
1.882 raeburn 10197: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
10198: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 10199: $can_clone = 1;
10200: } else {
10201: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
10202: $args->{'clonedomain'},$args->{'clonecourse'});
10203: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 10204: if (grep(/^\*$/,@cloners)) {
10205: $can_clone = 1;
10206: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
10207: $can_clone = 1;
10208: } else {
1.908 raeburn 10209: my $ccrole = 'cc';
1.944 raeburn 10210: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10211: $ccrole = 'co';
10212: }
1.578 raeburn 10213: my %roleshash =
10214: &Apache::lonnet::get_my_roles($args->{'ccuname'},
10215: $args->{'ccdomain'},
1.908 raeburn 10216: 'userroles',['active'],[$ccrole],
1.578 raeburn 10217: [$args->{'clonedomain'}]);
1.908 raeburn 10218: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942 raeburn 10219: $can_clone = 1;
10220: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
10221: $can_clone = 1;
10222: } else {
1.944 raeburn 10223: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10224: $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'});
10225: } else {
10226: $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'});
10227: }
1.578 raeburn 10228: }
1.566 albertel 10229: }
1.578 raeburn 10230: }
1.566 albertel 10231: }
10232: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10233: }
10234:
1.444 albertel 10235: sub construct_course {
1.885 raeburn 10236: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444 albertel 10237: my $outcome;
1.541 raeburn 10238: my $linefeed = '<br />'."\n";
10239: if ($context eq 'auto') {
10240: $linefeed = "\n";
10241: }
1.566 albertel 10242:
10243: #
10244: # Are we cloning?
10245: #
10246: my ($can_clone, $clonemsg, $cloneid, $clonehome);
10247: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 10248: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 10249: if ($context ne 'auto') {
1.578 raeburn 10250: if ($clonemsg ne '') {
10251: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
10252: }
1.566 albertel 10253: }
10254: $outcome .= $clonemsg.$linefeed;
10255:
10256: if (!$can_clone) {
10257: return (0,$outcome);
10258: }
10259: }
10260:
1.444 albertel 10261: #
10262: # Open course
10263: #
10264: my $crstype = lc($args->{'crstype'});
10265: my %cenv=();
10266: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
10267: $args->{'cdescr'},
10268: $args->{'curl'},
10269: $args->{'course_home'},
10270: $args->{'nonstandard'},
10271: $args->{'crscode'},
10272: $args->{'ccuname'}.':'.
10273: $args->{'ccdomain'},
1.882 raeburn 10274: $args->{'crstype'},
1.885 raeburn 10275: $cnum,$context,$category);
1.444 albertel 10276:
10277: # Note: The testing routines depend on this being output; see
10278: # Utils::Course. This needs to at least be output as a comment
10279: # if anyone ever decides to not show this, and Utils::Course::new
10280: # will need to be suitably modified.
1.541 raeburn 10281: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943 raeburn 10282: if ($$courseid =~ /^error:/) {
10283: return (0,$outcome);
10284: }
10285:
1.444 albertel 10286: #
10287: # Check if created correctly
10288: #
1.479 albertel 10289: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 10290: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 10291: if ($crsuhome eq 'no_host') {
10292: $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
10293: return (0,$outcome);
10294: }
1.541 raeburn 10295: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 10296:
1.444 albertel 10297: #
1.566 albertel 10298: # Do the cloning
10299: #
10300: if ($can_clone && $cloneid) {
10301: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
10302: if ($context ne 'auto') {
10303: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
10304: }
10305: $outcome .= $clonemsg.$linefeed;
10306: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 10307: # Copy all files
1.637 www 10308: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 10309: # Restore URL
1.566 albertel 10310: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 10311: # Restore title
1.566 albertel 10312: $cenv{'description'}=$oldcenv{'description'};
1.948.2.2 raeburn 10313: # Restore creation date, creator and creation context.
10314: $cenv{'internal.created'}=$oldcenv{'internal.created'};
10315: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
10316: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 10317: # Mark as cloned
1.566 albertel 10318: $cenv{'clonedfrom'}=$cloneid;
1.638 www 10319: # Need to clone grading mode
10320: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
10321: $cenv{'grading'}=$newenv{'grading'};
10322: # Do not clone these environment entries
10323: &Apache::lonnet::del('environment',
10324: ['default_enrollment_start_date',
10325: 'default_enrollment_end_date',
10326: 'question.email',
10327: 'policy.email',
10328: 'comment.email',
10329: 'pch.users.denied',
1.725 raeburn 10330: 'plc.users.denied',
10331: 'hidefromcat',
10332: 'categories'],
1.638 www 10333: $$crsudom,$$crsunum);
1.444 albertel 10334: }
1.566 albertel 10335:
1.444 albertel 10336: #
10337: # Set environment (will override cloned, if existing)
10338: #
10339: my @sections = ();
10340: my @xlists = ();
10341: if ($args->{'crstype'}) {
10342: $cenv{'type'}=$args->{'crstype'};
10343: }
10344: if ($args->{'crsid'}) {
10345: $cenv{'courseid'}=$args->{'crsid'};
10346: }
10347: if ($args->{'crscode'}) {
10348: $cenv{'internal.coursecode'}=$args->{'crscode'};
10349: }
10350: if ($args->{'crsquota'} ne '') {
10351: $cenv{'internal.coursequota'}=$args->{'crsquota'};
10352: } else {
10353: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
10354: }
10355: if ($args->{'ccuname'}) {
10356: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
10357: ':'.$args->{'ccdomain'};
10358: } else {
10359: $cenv{'internal.courseowner'} = $args->{'curruser'};
10360: }
10361: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
10362: if ($args->{'crssections'}) {
10363: $cenv{'internal.sectionnums'} = '';
10364: if ($args->{'crssections'} =~ m/,/) {
10365: @sections = split/,/,$args->{'crssections'};
10366: } else {
10367: $sections[0] = $args->{'crssections'};
10368: }
10369: if (@sections > 0) {
10370: foreach my $item (@sections) {
10371: my ($sec,$gp) = split/:/,$item;
10372: my $class = $args->{'crscode'}.$sec;
10373: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
10374: $cenv{'internal.sectionnums'} .= $item.',';
10375: unless ($addcheck eq 'ok') {
10376: push @badclasses, $class;
10377: }
10378: }
10379: $cenv{'internal.sectionnums'} =~ s/,$//;
10380: }
10381: }
10382: # do not hide course coordinator from staff listing,
10383: # even if privileged
10384: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10385: # add crosslistings
10386: if ($args->{'crsxlist'}) {
10387: $cenv{'internal.crosslistings'}='';
10388: if ($args->{'crsxlist'} =~ m/,/) {
10389: @xlists = split/,/,$args->{'crsxlist'};
10390: } else {
10391: $xlists[0] = $args->{'crsxlist'};
10392: }
10393: if (@xlists > 0) {
10394: foreach my $item (@xlists) {
10395: my ($xl,$gp) = split/:/,$item;
10396: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
10397: $cenv{'internal.crosslistings'} .= $item.',';
10398: unless ($addcheck eq 'ok') {
10399: push @badclasses, $xl;
10400: }
10401: }
10402: $cenv{'internal.crosslistings'} =~ s/,$//;
10403: }
10404: }
10405: if ($args->{'autoadds'}) {
10406: $cenv{'internal.autoadds'}=$args->{'autoadds'};
10407: }
10408: if ($args->{'autodrops'}) {
10409: $cenv{'internal.autodrops'}=$args->{'autodrops'};
10410: }
10411: # check for notification of enrollment changes
10412: my @notified = ();
10413: if ($args->{'notify_owner'}) {
10414: if ($args->{'ccuname'} ne '') {
10415: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
10416: }
10417: }
10418: if ($args->{'notify_dc'}) {
10419: if ($uname ne '') {
1.630 raeburn 10420: push(@notified,$uname.':'.$udom);
1.444 albertel 10421: }
10422: }
10423: if (@notified > 0) {
10424: my $notifylist;
10425: if (@notified > 1) {
10426: $notifylist = join(',',@notified);
10427: } else {
10428: $notifylist = $notified[0];
10429: }
10430: $cenv{'internal.notifylist'} = $notifylist;
10431: }
10432: if (@badclasses > 0) {
10433: my %lt=&Apache::lonlocal::texthash(
10434: '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',
10435: 'dnhr' => 'does not have rights to access enrollment in these classes',
10436: 'adby' => 'as determined by the policies of your institution on access to official classlists'
10437: );
1.541 raeburn 10438: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
10439: ' ('.$lt{'adby'}.')';
10440: if ($context eq 'auto') {
10441: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 10442: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 10443: foreach my $item (@badclasses) {
10444: if ($context eq 'auto') {
10445: $outcome .= " - $item\n";
10446: } else {
10447: $outcome .= "<li>$item</li>\n";
10448: }
10449: }
10450: if ($context eq 'auto') {
10451: $outcome .= $linefeed;
10452: } else {
1.566 albertel 10453: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 10454: }
10455: }
1.444 albertel 10456: }
10457: if ($args->{'no_end_date'}) {
10458: $args->{'endaccess'} = 0;
10459: }
10460: $cenv{'internal.autostart'}=$args->{'enrollstart'};
10461: $cenv{'internal.autoend'}=$args->{'enrollend'};
10462: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
10463: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
10464: if ($args->{'showphotos'}) {
10465: $cenv{'internal.showphotos'}=$args->{'showphotos'};
10466: }
10467: $cenv{'internal.authtype'} = $args->{'authtype'};
10468: $cenv{'internal.autharg'} = $args->{'autharg'};
10469: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
10470: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 10471: 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');
10472: if ($context eq 'auto') {
10473: $outcome .= $krb_msg;
10474: } else {
1.566 albertel 10475: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 10476: }
10477: $outcome .= $linefeed;
1.444 albertel 10478: }
10479: }
10480: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
10481: if ($args->{'setpolicy'}) {
10482: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10483: }
10484: if ($args->{'setcontent'}) {
10485: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10486: }
10487: }
10488: if ($args->{'reshome'}) {
10489: $cenv{'reshome'}=$args->{'reshome'}.'/';
10490: $cenv{'reshome'}=~s/\/+$/\//;
10491: }
10492: #
10493: # course has keyed access
10494: #
10495: if ($args->{'setkeys'}) {
10496: $cenv{'keyaccess'}='yes';
10497: }
10498: # if specified, key authority is not course, but user
10499: # only active if keyaccess is yes
10500: if ($args->{'keyauth'}) {
1.487 albertel 10501: my ($user,$domain) = split(':',$args->{'keyauth'});
10502: $user = &LONCAPA::clean_username($user);
10503: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 10504: if ($user ne '' && $domain ne '') {
1.487 albertel 10505: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 10506: }
10507: }
10508:
10509: if ($args->{'disresdis'}) {
10510: $cenv{'pch.roles.denied'}='st';
10511: }
10512: if ($args->{'disablechat'}) {
10513: $cenv{'plc.roles.denied'}='st';
10514: }
10515:
10516: # Record we've not yet viewed the Course Initialization Helper for this
10517: # course
10518: $cenv{'course.helper.not.run'} = 1;
10519: #
10520: # Use new Randomseed
10521: #
10522: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
10523: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
10524: #
10525: # The encryption code and receipt prefix for this course
10526: #
10527: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
10528: $cenv{'internal.encpref'}=100+int(9*rand(99));
10529: #
10530: # By default, use standard grading
10531: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
10532:
1.541 raeburn 10533: $outcome .= $linefeed.&mt('Setting environment').': '.
10534: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10535: #
10536: # Open all assignments
10537: #
10538: if ($args->{'openall'}) {
10539: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
10540: my %storecontent = ($storeunder => time,
10541: $storeunder.'.type' => 'date_start');
10542:
10543: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 10544: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10545: }
10546: #
10547: # Set first page
10548: #
10549: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
10550: || ($cloneid)) {
1.445 albertel 10551: use LONCAPA::map;
1.444 albertel 10552: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 10553:
10554: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
10555: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
10556:
1.444 albertel 10557: $outcome .= ($fatal?$errtext:'read ok').' - ';
10558: my $title; my $url;
10559: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 10560: $title=&mt('Syllabus');
1.444 albertel 10561: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
10562: } else {
1.948.2.5! raeburn 10563: $title=&mt('Table of Contents');
1.444 albertel 10564: $url='/adm/navmaps';
10565: }
1.445 albertel 10566:
10567: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
10568: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
10569:
10570: if ($errtext) { $fatal=2; }
1.541 raeburn 10571: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 10572: }
1.566 albertel 10573:
10574: return (1,$outcome);
1.444 albertel 10575: }
10576:
10577: ############################################################
10578: ############################################################
10579:
1.378 raeburn 10580: sub course_type {
10581: my ($cid) = @_;
10582: if (!defined($cid)) {
10583: $cid = $env{'request.course.id'};
10584: }
1.404 albertel 10585: if (defined($env{'course.'.$cid.'.type'})) {
10586: return $env{'course.'.$cid.'.type'};
1.378 raeburn 10587: } else {
10588: return 'Course';
1.377 raeburn 10589: }
10590: }
1.156 albertel 10591:
1.406 raeburn 10592: sub group_term {
10593: my $crstype = &course_type();
10594: my %names = (
10595: 'Course' => 'group',
1.865 raeburn 10596: 'Community' => 'group',
1.406 raeburn 10597: );
10598: return $names{$crstype};
10599: }
10600:
1.902 raeburn 10601: sub course_types {
10602: my @types = ('official','unofficial','community');
10603: my %typename = (
10604: official => 'Official course',
10605: unofficial => 'Unofficial course',
10606: community => 'Community',
10607: );
10608: return (\@types,\%typename);
10609: }
10610:
1.156 albertel 10611: sub icon {
10612: my ($file)=@_;
1.505 albertel 10613: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 10614: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 10615: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 10616: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
10617: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
10618: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10619: $curfext.".gif") {
10620: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10621: $curfext.".gif";
10622: }
10623: }
1.249 albertel 10624: return &lonhttpdurl($iconname);
1.154 albertel 10625: }
1.84 albertel 10626:
1.575 albertel 10627: sub lonhttpdurl {
1.692 www 10628: #
10629: # Had been used for "small fry" static images on separate port 8080.
10630: # Modify here if lightweight http functionality desired again.
10631: # Currently eliminated due to increasing firewall issues.
10632: #
1.575 albertel 10633: my ($url)=@_;
1.692 www 10634: return $url;
1.215 albertel 10635: }
10636:
1.213 albertel 10637: sub connection_aborted {
10638: my ($r)=@_;
10639: $r->print(" ");$r->rflush();
10640: my $c = $r->connection;
10641: return $c->aborted();
10642: }
10643:
1.221 foxr 10644: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 10645: # strings as 'strings'.
10646: sub escape_single {
1.221 foxr 10647: my ($input) = @_;
1.223 albertel 10648: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 10649: $input =~ s/\'/\\\'/g; # Esacpe the 's....
10650: return $input;
10651: }
1.223 albertel 10652:
1.222 foxr 10653: # Same as escape_single, but escape's "'s This
10654: # can be used for "strings"
10655: sub escape_double {
10656: my ($input) = @_;
10657: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
10658: $input =~ s/\"/\\\"/g; # Esacpe the "s....
10659: return $input;
10660: }
1.223 albertel 10661:
1.222 foxr 10662: # Escapes the last element of a full URL.
10663: sub escape_url {
10664: my ($url) = @_;
1.238 raeburn 10665: my @urlslices = split(/\//, $url,-1);
1.369 www 10666: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 10667: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 10668: }
1.462 albertel 10669:
1.820 raeburn 10670: sub compare_arrays {
10671: my ($arrayref1,$arrayref2) = @_;
10672: my (@difference,%count);
10673: @difference = ();
10674: %count = ();
10675: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
10676: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
10677: foreach my $element (keys(%count)) {
10678: if ($count{$element} == 1) {
10679: push(@difference,$element);
10680: }
10681: }
10682: }
10683: return @difference;
10684: }
10685:
1.817 bisitz 10686: # -------------------------------------------------------- Initialize user login
1.462 albertel 10687: sub init_user_environment {
1.463 albertel 10688: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 10689: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
10690:
10691: my $public=($username eq 'public' && $domain eq 'public');
10692:
10693: # See if old ID present, if so, remove
10694:
10695: my ($filename,$cookie,$userroles);
10696: my $now=time;
10697:
10698: if ($public) {
10699: my $max_public=100;
10700: my $oldest;
10701: my $oldest_time=0;
10702: for(my $next=1;$next<=$max_public;$next++) {
10703: if (-e $lonids."/publicuser_$next.id") {
10704: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
10705: if ($mtime<$oldest_time || !$oldest_time) {
10706: $oldest_time=$mtime;
10707: $oldest=$next;
10708: }
10709: } else {
10710: $cookie="publicuser_$next";
10711: last;
10712: }
10713: }
10714: if (!$cookie) { $cookie="publicuser_$oldest"; }
10715: } else {
1.463 albertel 10716: # if this isn't a robot, kill any existing non-robot sessions
10717: if (!$args->{'robot'}) {
10718: opendir(DIR,$lonids);
10719: while ($filename=readdir(DIR)) {
10720: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
10721: unlink($lonids.'/'.$filename);
10722: }
1.462 albertel 10723: }
1.463 albertel 10724: closedir(DIR);
1.462 albertel 10725: }
10726: # Give them a new cookie
1.463 albertel 10727: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 10728: : $now.$$.int(rand(10000)));
1.463 albertel 10729: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 10730:
10731: # Initialize roles
10732:
10733: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
10734: }
10735: # ------------------------------------ Check browser type and MathML capability
10736:
10737: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
10738: $clientunicode,$clientos) = &decode_user_agent($r);
10739:
10740: # ------------------------------------------------------------- Get environment
10741:
10742: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
10743: my ($tmp) = keys(%userenv);
10744: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
10745: # default remote control to off
10746: if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
10747: } else {
10748: undef(%userenv);
10749: }
10750: if (($userenv{'interface'}) && (!$form->{'interface'})) {
10751: $form->{'interface'}=$userenv{'interface'};
10752: }
10753: $env{'environment.remote'}=$userenv{'remote'};
10754: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
10755:
10756: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 10757: foreach my $option ('interface','localpath','localres') {
10758: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 10759: }
10760: # --------------------------------------------------------- Write first profile
10761:
10762: {
10763: my %initial_env =
10764: ("user.name" => $username,
10765: "user.domain" => $domain,
10766: "user.home" => $authhost,
10767: "browser.type" => $clientbrowser,
10768: "browser.version" => $clientversion,
10769: "browser.mathml" => $clientmathml,
10770: "browser.unicode" => $clientunicode,
10771: "browser.os" => $clientos,
10772: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
10773: "request.course.fn" => '',
10774: "request.course.uri" => '',
10775: "request.course.sec" => '',
10776: "request.role" => 'cm',
10777: "request.role.adv" => $env{'user.adv'},
10778: "request.host" => $ENV{'REMOTE_ADDR'},);
10779:
10780: if ($form->{'localpath'}) {
10781: $initial_env{"browser.localpath"} = $form->{'localpath'};
10782: $initial_env{"browser.localres"} = $form->{'localres'};
10783: }
10784:
10785: if ($public) {
10786: $initial_env{"environment.remote"} = "off";
10787: }
10788: if ($form->{'interface'}) {
10789: $form->{'interface'}=~s/\W//gs;
10790: $initial_env{"browser.interface"} = $form->{'interface'};
10791: $env{'browser.interface'}=$form->{'interface'};
10792: }
10793:
1.724 raeburn 10794: foreach my $tool ('aboutme','blog','portfolio') {
10795: $userenv{'availabletools.'.$tool} =
10796: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
10797: }
10798:
1.864 raeburn 10799: foreach my $crstype ('official','unofficial','community') {
1.765 raeburn 10800: $userenv{'canrequest.'.$crstype} =
10801: &Apache::lonnet::usertools_access($username,$domain,$crstype,
10802: 'reload','requestcourses');
10803: }
10804:
1.462 albertel 10805: $env{'user.environment'} = "$lonids/$cookie.id";
10806:
10807: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
10808: &GDBM_WRCREAT(),0640)) {
10809: &_add_to_env(\%disk_env,\%initial_env);
10810: &_add_to_env(\%disk_env,\%userenv,'environment.');
10811: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 10812: if (ref($args->{'extra_env'})) {
10813: &_add_to_env(\%disk_env,$args->{'extra_env'});
10814: }
1.462 albertel 10815: untie(%disk_env);
10816: } else {
1.705 tempelho 10817: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
10818: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 10819: return 'error: '.$!;
10820: }
10821: }
10822: $env{'request.role'}='cm';
10823: $env{'request.role.adv'}=$env{'user.adv'};
10824: $env{'browser.type'}=$clientbrowser;
10825:
10826: return $cookie;
10827:
10828: }
10829:
10830: sub _add_to_env {
10831: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 10832: if (ref($env_data) eq 'HASH') {
10833: while (my ($key,$value) = each(%$env_data)) {
10834: $idf->{$prefix.$key} = $value;
10835: $env{$prefix.$key} = $value;
10836: }
1.462 albertel 10837: }
10838: }
10839:
1.685 tempelho 10840: # --- Get the symbolic name of a problem and the url
10841: sub get_symb {
10842: my ($request,$silent) = @_;
1.726 raeburn 10843: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 10844: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
10845: if ($symb eq '') {
10846: if (!$silent) {
10847: $request->print("Unable to handle ambiguous references:$url:.");
10848: return ();
10849: }
10850: }
10851: &Apache::lonenc::check_decrypt(\$symb);
10852: return ($symb);
10853: }
10854:
10855: # --------------------------------------------------------------Get annotation
10856:
10857: sub get_annotation {
10858: my ($symb,$enc) = @_;
10859:
10860: my $key = $symb;
10861: if (!$enc) {
10862: $key =
10863: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
10864: }
10865: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
10866: return $annotation{$key};
10867: }
10868:
10869: sub clean_symb {
1.731 raeburn 10870: my ($symb,$delete_enc) = @_;
1.685 tempelho 10871:
10872: &Apache::lonenc::check_decrypt(\$symb);
10873: my $enc = $env{'request.enc'};
1.731 raeburn 10874: if ($delete_enc) {
1.730 raeburn 10875: delete($env{'request.enc'});
10876: }
1.685 tempelho 10877:
10878: return ($symb,$enc);
10879: }
1.462 albertel 10880:
1.41 ng 10881: =pod
10882:
10883: =back
10884:
1.112 bowersj2 10885: =cut
1.41 ng 10886:
1.112 bowersj2 10887: 1;
10888: __END__;
1.41 ng 10889:
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