Annotation of loncom/interface/loncommon.pm, revision 1.948.2.1
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.1! raeburn 4: # $Id: loncommon.pm,v 1.948 2010/03/08 14:51:14 raeburn Exp $
1.10 albertel 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.1 albertel 28:
29: # Makes a table out of the previous attempts
1.2 albertel 30: # Inputs result_from_symbread, user, domain, course_id
1.16 harris41 31: # Reads in non-network-related .tab files
1.1 albertel 32:
1.35 matthew 33: # POD header:
34:
1.45 matthew 35: =pod
36:
1.35 matthew 37: =head1 NAME
38:
39: Apache::loncommon - pile of common routines
40:
41: =head1 SYNOPSIS
42:
1.112 bowersj2 43: Common routines for manipulating connections, student answers,
44: domains, common Javascript fragments, etc.
1.35 matthew 45:
1.112 bowersj2 46: =head1 OVERVIEW
1.35 matthew 47:
1.112 bowersj2 48: A collection of commonly used subroutines that don't have a natural
49: home anywhere else. This collection helps remove
1.35 matthew 50: redundancy from other modules and increase efficiency of memory usage.
51:
52: =cut
53:
54: # End of POD header
1.1 albertel 55: package Apache::loncommon;
56:
57: use strict;
1.258 albertel 58: use Apache::lonnet;
1.46 matthew 59: use GDBM_File;
1.51 www 60: use POSIX qw(strftime mktime);
1.82 www 61: use Apache::lonmenu();
1.498 albertel 62: use Apache::lonenc();
1.117 www 63: use Apache::lonlocal;
1.685 tempelho 64: use Apache::lonnet();
1.139 matthew 65: use HTML::Entities;
1.334 albertel 66: use Apache::lonhtmlcommon();
67: use Apache::loncoursedata();
1.344 albertel 68: use Apache::lontexconvert();
1.444 albertel 69: use Apache::lonclonecourse();
1.479 albertel 70: use LONCAPA qw(:DEFAULT :match);
1.657 raeburn 71: use DateTime::TimeZone;
1.687 raeburn 72: use DateTime::Locale::Catalog;
1.117 www 73:
1.517 raeburn 74: # ---------------------------------------------- Designs
75: use vars qw(%defaultdesign);
76:
1.22 www 77: my $readit;
78:
1.517 raeburn 79:
1.157 matthew 80: ##
81: ## Global Variables
82: ##
1.46 matthew 83:
1.643 foxr 84:
85: # ----------------------------------------------- SSI with retries:
86: #
87:
88: =pod
89:
1.648 raeburn 90: =head1 Server Side include with retries:
1.643 foxr 91:
92: =over 4
93:
1.648 raeburn 94: =item * &ssi_with_retries(resource,retries form)
1.643 foxr 95:
96: Performs an ssi with some number of retries. Retries continue either
97: until the result is ok or until the retry count supplied by the
98: caller is exhausted.
99:
100: Inputs:
1.648 raeburn 101:
102: =over 4
103:
1.643 foxr 104: resource - Identifies the resource to insert.
1.648 raeburn 105:
1.643 foxr 106: retries - Count of the number of retries allowed.
1.648 raeburn 107:
1.643 foxr 108: form - Hash that identifies the rendering options.
109:
1.648 raeburn 110: =back
111:
112: Returns:
113:
114: =over 4
115:
1.643 foxr 116: content - The content of the response. If retries were exhausted this is empty.
1.648 raeburn 117:
1.643 foxr 118: response - The response from the last attempt (which may or may not have been successful.
119:
1.648 raeburn 120: =back
121:
122: =back
123:
1.643 foxr 124: =cut
125:
126: sub ssi_with_retries {
127: my ($resource, $retries, %form) = @_;
128:
129:
130: my $ok = 0; # True if we got a good response.
131: my $content;
132: my $response;
133:
134: # Try to get the ssi done. within the retries count:
135:
136: do {
137: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
138: $ok = $response->is_success;
1.650 www 139: if (!$ok) {
140: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
141: }
1.643 foxr 142: $retries--;
143: } while (!$ok && ($retries > 0));
144:
145: if (!$ok) {
146: $content = ''; # On error return an empty content.
147: }
148: return ($content, $response);
149:
150: }
151:
152:
153:
1.20 www 154: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 155: my %language;
1.124 www 156: my %supported_language;
1.12 harris41 157: my %cprtag;
1.192 taceyjo1 158: my %scprtag;
1.351 www 159: my %fe; my %fd; my %fm;
1.41 ng 160: my %category_extensions;
1.12 harris41 161:
1.46 matthew 162: # ---------------------------------------------- Thesaurus variables
1.144 matthew 163: #
164: # %Keywords:
165: # A hash used by &keyword to determine if a word is considered a keyword.
166: # $thesaurus_db_file
167: # Scalar containing the full path to the thesaurus database.
1.46 matthew 168:
169: my %Keywords;
170: my $thesaurus_db_file;
171:
1.144 matthew 172: #
173: # Initialize values from language.tab, copyright.tab, filetypes.tab,
174: # thesaurus.tab, and filecategories.tab.
175: #
1.18 www 176: BEGIN {
1.46 matthew 177: # Variable initialization
178: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
179: #
1.22 www 180: unless ($readit) {
1.12 harris41 181: # ------------------------------------------------------------------- languages
182: {
1.158 raeburn 183: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
184: '/language.tab';
185: if ( open(my $fh,"<$langtabfile") ) {
1.356 albertel 186: while (my $line = <$fh>) {
187: next if ($line=~/^\#/);
188: chomp($line);
189: my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
1.158 raeburn 190: $language{$key}=$val.' - '.$enc;
191: if ($sup) {
192: $supported_language{$key}=$sup;
193: }
194: }
195: close($fh);
196: }
1.12 harris41 197: }
198: # ------------------------------------------------------------------ copyrights
199: {
1.158 raeburn 200: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
201: '/copyright.tab';
202: if ( open (my $fh,"<$copyrightfile") ) {
1.356 albertel 203: while (my $line = <$fh>) {
204: next if ($line=~/^\#/);
205: chomp($line);
206: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 207: $cprtag{$key}=$val;
208: }
209: close($fh);
210: }
1.12 harris41 211: }
1.351 www 212: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 213: {
214: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
215: '/source_copyright.tab';
216: if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356 albertel 217: while (my $line = <$fh>) {
218: next if ($line =~ /^\#/);
219: chomp($line);
220: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 221: $scprtag{$key}=$val;
222: }
223: close($fh);
224: }
225: }
1.63 www 226:
1.517 raeburn 227: # -------------------------------------------------------------- default domain designs
1.63 www 228: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 229: my $designfile = $designdir.'/default.tab';
230: if ( open (my $fh,"<$designfile") ) {
231: while (my $line = <$fh>) {
232: next if ($line =~ /^\#/);
233: chomp($line);
234: my ($key,$val)=(split(/\=/,$line));
235: if ($val) { $defaultdesign{$key}=$val; }
236: }
237: close($fh);
1.63 www 238: }
239:
1.15 harris41 240: # ------------------------------------------------------------- file categories
241: {
1.158 raeburn 242: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
243: '/filecategories.tab';
244: if ( open (my $fh,"<$categoryfile") ) {
1.356 albertel 245: while (my $line = <$fh>) {
246: next if ($line =~ /^\#/);
247: chomp($line);
248: my ($extension,$category)=(split(/\s+/,$line,2));
1.158 raeburn 249: push @{$category_extensions{lc($category)}},$extension;
250: }
251: close($fh);
252: }
253:
1.15 harris41 254: }
1.12 harris41 255: # ------------------------------------------------------------------ file types
256: {
1.158 raeburn 257: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
258: '/filetypes.tab';
259: if ( open (my $fh,"<$typesfile") ) {
1.356 albertel 260: while (my $line = <$fh>) {
261: next if ($line =~ /^\#/);
262: chomp($line);
263: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 264: if ($descr ne '') {
265: $fe{$ending}=lc($emb);
266: $fd{$ending}=$descr;
1.351 www 267: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 268: }
269: }
270: close($fh);
271: }
1.12 harris41 272: }
1.22 www 273: &Apache::lonnet::logthis(
1.705 tempelho 274: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 275: $readit=1;
1.46 matthew 276: } # end of unless($readit)
1.32 matthew 277:
278: }
1.112 bowersj2 279:
1.42 matthew 280: ###############################################################
281: ## HTML and Javascript Helper Functions ##
282: ###############################################################
283:
284: =pod
285:
1.112 bowersj2 286: =head1 HTML and Javascript Functions
1.42 matthew 287:
1.112 bowersj2 288: =over 4
289:
1.648 raeburn 290: =item * &browser_and_searcher_javascript()
1.112 bowersj2 291:
292: X<browsing, javascript>X<searching, javascript>Returns a string
293: containing javascript with two functions, C<openbrowser> and
294: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
295: tags.
1.42 matthew 296:
1.648 raeburn 297: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 298:
299: inputs: formname, elementname, only, omit
300:
301: formname and elementname indicate the name of the html form and name of
302: the element that the results of the browsing selection are to be placed in.
303:
304: Specifying 'only' will restrict the browser to displaying only files
1.185 www 305: with the given extension. Can be a comma separated list.
1.42 matthew 306:
307: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 308: with the given extension. Can be a comma separated list.
1.42 matthew 309:
1.648 raeburn 310: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 311:
312: Inputs: formname, elementname
313:
314: formname and elementname specify the name of the html form and the name
315: of the element the selection from the search results will be placed in.
1.542 raeburn 316:
1.42 matthew 317: =cut
318:
319: sub browser_and_searcher_javascript {
1.199 albertel 320: my ($mode)=@_;
321: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 322: my $resurl=&escape_single(&lastresurl());
1.42 matthew 323: return <<END;
1.219 albertel 324: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 325: var editbrowser = null;
1.135 albertel 326: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 327: var url = '$resurl/?';
1.42 matthew 328: if (editbrowser == null) {
329: url += 'launch=1&';
330: }
331: url += 'catalogmode=interactive&';
1.199 albertel 332: url += 'mode=$mode&';
1.611 albertel 333: url += 'inhibitmenu=yes&';
1.42 matthew 334: url += 'form=' + formname + '&';
335: if (only != null) {
336: url += 'only=' + only + '&';
1.217 albertel 337: } else {
338: url += 'only=&';
339: }
1.42 matthew 340: if (omit != null) {
341: url += 'omit=' + omit + '&';
1.217 albertel 342: } else {
343: url += 'omit=&';
344: }
1.135 albertel 345: if (titleelement != null) {
346: url += 'titleelement=' + titleelement + '&';
1.217 albertel 347: } else {
348: url += 'titleelement=&';
349: }
1.42 matthew 350: url += 'element=' + elementname + '';
351: var title = 'Browser';
1.435 albertel 352: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 353: options += ',width=700,height=600';
354: editbrowser = open(url,title,options,'1');
355: editbrowser.focus();
356: }
357: var editsearcher;
1.135 albertel 358: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 359: var url = '/adm/searchcat?';
360: if (editsearcher == null) {
361: url += 'launch=1&';
362: }
363: url += 'catalogmode=interactive&';
1.199 albertel 364: url += 'mode=$mode&';
1.42 matthew 365: url += 'form=' + formname + '&';
1.135 albertel 366: if (titleelement != null) {
367: url += 'titleelement=' + titleelement + '&';
1.217 albertel 368: } else {
369: url += 'titleelement=&';
370: }
1.42 matthew 371: url += 'element=' + elementname + '';
372: var title = 'Search';
1.435 albertel 373: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 374: options += ',width=700,height=600';
375: editsearcher = open(url,title,options,'1');
376: editsearcher.focus();
377: }
1.219 albertel 378: // END LON-CAPA Internal -->
1.42 matthew 379: END
1.170 www 380: }
381:
382: sub lastresurl {
1.258 albertel 383: if ($env{'environment.lastresurl'}) {
384: return $env{'environment.lastresurl'}
1.170 www 385: } else {
386: return '/res';
387: }
388: }
389:
390: sub storeresurl {
391: my $resurl=&Apache::lonnet::clutter(shift);
392: unless ($resurl=~/^\/res/) { return 0; }
393: $resurl=~s/\/$//;
394: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 395: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 396: return 1;
1.42 matthew 397: }
398:
1.74 www 399: sub studentbrowser_javascript {
1.111 www 400: unless (
1.258 albertel 401: (($env{'request.course.id'}) &&
1.302 albertel 402: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
403: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
404: '/'.$env{'request.course.sec'})
405: ))
1.258 albertel 406: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 407: ) { return ''; }
1.74 www 408: return (<<'ENDSTDBRW');
1.776 bisitz 409: <script type="text/javascript" language="Javascript">
1.824 bisitz 410: // <![CDATA[
1.74 www 411: var stdeditbrowser;
1.793 raeburn 412: function openstdbrowser(formname,uname,udom,roleflag,ignorefilter,courseadvonly) {
1.74 www 413: var url = '/adm/pickstudent?';
414: var filter;
1.558 albertel 415: if (!ignorefilter) {
416: eval('filter=document.'+formname+'.'+uname+'.value;');
417: }
1.74 www 418: if (filter != null) {
419: if (filter != '') {
420: url += 'filter='+filter+'&';
421: }
422: }
423: url += 'form=' + formname + '&unameelement='+uname+
424: '&udomelement='+udom;
1.111 www 425: if (roleflag) { url+="&roles=1"; }
1.793 raeburn 426: if (courseadvonly) { url+="&courseadvonly=1"; }
1.102 www 427: var title = 'Student_Browser';
1.74 www 428: var options = 'scrollbars=1,resizable=1,menubar=0';
429: options += ',width=700,height=600';
430: stdeditbrowser = open(url,title,options,'1');
431: stdeditbrowser.focus();
432: }
1.824 bisitz 433: // ]]>
1.74 www 434: </script>
435: ENDSTDBRW
436: }
1.42 matthew 437:
1.74 www 438: sub selectstudent_link {
1.793 raeburn 439: my ($form,$unameele,$udomele,$courseadvonly)=@_;
440: my $callargs = "'".$form."','".$unameele."','".$udomele."'";
1.258 albertel 441: if ($env{'request.course.id'}) {
1.302 albertel 442: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
443: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
444: '/'.$env{'request.course.sec'})) {
1.111 www 445: return '';
446: }
1.793 raeburn 447: if ($courseadvonly) {
448: $callargs .= ",'',1,1";
449: }
450: return '<span class="LC_nobreak">'.
451: '<a href="javascript:openstdbrowser('.$callargs.');">'.
452: &mt('Select User').'</a></span>';
1.74 www 453: }
1.258 albertel 454: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.793 raeburn 455: $callargs .= ",1";
456: return '<span class="LC_nobreak">'.
457: '<a href="javascript:openstdbrowser('.$callargs.');">'.
458: &mt('Select User').'</a></span>';
1.111 www 459: }
460: return '';
1.91 www 461: }
462:
1.653 raeburn 463: sub authorbrowser_javascript {
464: return <<"ENDAUTHORBRW";
1.776 bisitz 465: <script type="text/javascript" language="JavaScript">
1.824 bisitz 466: // <![CDATA[
1.653 raeburn 467: var stdeditbrowser;
468:
469: function openauthorbrowser(formname,udom) {
470: var url = '/adm/pickauthor?';
471: url += 'form='+formname+'&roledom='+udom;
472: var title = 'Author_Browser';
473: var options = 'scrollbars=1,resizable=1,menubar=0';
474: options += ',width=700,height=600';
475: stdeditbrowser = open(url,title,options,'1');
476: stdeditbrowser.focus();
477: }
478:
1.824 bisitz 479: // ]]>
1.653 raeburn 480: </script>
481: ENDAUTHORBRW
482: }
483:
1.91 www 484: sub coursebrowser_javascript {
1.909 raeburn 485: my ($domainfilter,$sec_element,$formname,$role_element,$crstype) = @_;
1.932 raeburn 486: my $wintitle = 'Course_Browser';
1.931 raeburn 487: if ($crstype eq 'Community') {
1.932 raeburn 488: $wintitle = 'Community_Browser';
1.909 raeburn 489: }
1.876 raeburn 490: my $id_functions = &javascript_index_functions();
491: my $output = '
1.776 bisitz 492: <script type="text/javascript" language="JavaScript">
1.824 bisitz 493: // <![CDATA[
1.468 raeburn 494: var stdeditbrowser;'."\n";
1.876 raeburn 495:
496: $output .= <<"ENDSTDBRW";
1.909 raeburn 497: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91 www 498: var url = '/adm/pickcourse?';
1.895 raeburn 499: var formid = getFormIdByName(formname);
1.876 raeburn 500: var domainfilter = getDomainFromSelectbox(formname,udom);
1.128 albertel 501: if (domainfilter != null) {
502: if (domainfilter != '') {
503: url += 'domainfilter='+domainfilter+'&';
504: }
505: }
1.91 www 506: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 507: '&cdomelement='+udom+
508: '&cnameelement='+desc;
1.468 raeburn 509: if (extra_element !=null && extra_element != '') {
1.594 raeburn 510: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 511: url += '&roleelement='+extra_element;
512: if (domainfilter == null || domainfilter == '') {
513: url += '&domainfilter='+extra_element;
514: }
1.234 raeburn 515: }
1.468 raeburn 516: else {
517: if (formname == 'portform') {
518: url += '&setroles='+extra_element;
1.800 raeburn 519: } else {
520: if (formname == 'rules') {
521: url += '&fixeddom='+extra_element;
522: }
1.468 raeburn 523: }
524: }
1.230 raeburn 525: }
1.909 raeburn 526: if (type != null && type != '') {
527: url += '&type='+type;
528: }
529: if (type_elem != null && type_elem != '') {
530: url += '&typeelement='+type_elem;
531: }
1.872 raeburn 532: if (formname == 'ccrs') {
533: var ownername = document.forms[formid].ccuname.value;
534: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
535: url += '&cloner='+ownername+':'+ownerdom;
536: }
1.293 raeburn 537: if (multflag !=null && multflag != '') {
538: url += '&multiple='+multflag;
539: }
1.909 raeburn 540: var title = '$wintitle';
1.91 www 541: var options = 'scrollbars=1,resizable=1,menubar=0';
542: options += ',width=700,height=600';
543: stdeditbrowser = open(url,title,options,'1');
544: stdeditbrowser.focus();
545: }
1.876 raeburn 546: $id_functions
547: ENDSTDBRW
1.905 raeburn 548: if (($sec_element ne '') || ($role_element ne '')) {
549: $output .= &setsec_javascript($sec_element,$formname,$role_element);
1.876 raeburn 550: }
551: $output .= '
552: // ]]>
553: </script>';
554: return $output;
555: }
556:
557: sub javascript_index_functions {
558: return <<"ENDJS";
559:
560: function getFormIdByName(formname) {
561: for (var i=0;i<document.forms.length;i++) {
562: if (document.forms[i].name == formname) {
563: return i;
564: }
565: }
566: return -1;
567: }
568:
569: function getIndexByName(formid,item) {
570: for (var i=0;i<document.forms[formid].elements.length;i++) {
571: if (document.forms[formid].elements[i].name == item) {
572: return i;
573: }
574: }
575: return -1;
576: }
1.468 raeburn 577:
1.876 raeburn 578: function getDomainFromSelectbox(formname,udom) {
579: var userdom;
580: var formid = getFormIdByName(formname);
581: if (formid > -1) {
582: var domid = getIndexByName(formid,udom);
583: if (domid > -1) {
584: if (document.forms[formid].elements[domid].type == 'select-one') {
585: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
586: }
587: if (document.forms[formid].elements[domid].type == 'hidden') {
588: userdom=document.forms[formid].elements[domid].value;
1.468 raeburn 589: }
590: }
591: }
1.876 raeburn 592: return userdom;
593: }
594:
595: ENDJS
1.468 raeburn 596:
1.876 raeburn 597: }
598:
599: sub userbrowser_javascript {
600: my $id_functions = &javascript_index_functions();
601: return <<"ENDUSERBRW";
602:
1.888 raeburn 603: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876 raeburn 604: var url = '/adm/pickuser?';
605: var userdom = getDomainFromSelectbox(formname,udom);
606: if (userdom != null) {
607: if (userdom != '') {
608: url += 'srchdom='+userdom+'&';
609: }
610: }
611: url += 'form=' + formname + '&unameelement='+uname+
612: '&udomelement='+udom+
613: '&ulastelement='+ulast+
614: '&ufirstelement='+ufirst+
615: '&uemailelement='+uemail+
1.881 raeburn 616: '&hideudomelement='+hideudom+
617: '&coursedom='+crsdom;
1.888 raeburn 618: if ((caller != null) && (caller != undefined)) {
619: url += '&caller='+caller;
620: }
1.876 raeburn 621: var title = 'User_Browser';
622: var options = 'scrollbars=1,resizable=1,menubar=0';
623: options += ',width=700,height=600';
624: var stdeditbrowser = open(url,title,options,'1');
625: stdeditbrowser.focus();
626: }
627:
1.888 raeburn 628: function fix_domain (formname,udom,origdom,uname) {
1.876 raeburn 629: var formid = getFormIdByName(formname);
630: if (formid > -1) {
1.888 raeburn 631: var unameid = getIndexByName(formid,uname);
1.876 raeburn 632: var domid = getIndexByName(formid,udom);
633: var hidedomid = getIndexByName(formid,origdom);
634: if (hidedomid > -1) {
635: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888 raeburn 636: var unameval = document.forms[formid].elements[unameid].value;
637: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
638: if (domid > -1) {
639: var slct = document.forms[formid].elements[domid];
640: if (slct.type == 'select-one') {
641: var i;
642: for (i=0;i<slct.length;i++) {
643: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
644: }
645: }
646: if (slct.type == 'hidden') {
647: slct.value = fixeddom;
1.876 raeburn 648: }
649: }
1.468 raeburn 650: }
651: }
652: }
1.876 raeburn 653: return;
654: }
655:
656: $id_functions
657: ENDUSERBRW
1.468 raeburn 658: }
659:
660: sub setsec_javascript {
1.905 raeburn 661: my ($sec_element,$formname,$role_element) = @_;
662: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
663: $communityrolestr);
664: if ($role_element ne '') {
665: my @allroles = ('st','ta','ep','in','ad');
666: foreach my $crstype ('Course','Community') {
667: if ($crstype eq 'Community') {
668: foreach my $role (@allroles) {
669: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
670: }
671: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
672: } else {
673: foreach my $role (@allroles) {
674: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
675: }
676: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
677: }
678: }
679: $rolestr = '"'.join('","',@allroles).'"';
680: $courserolestr = '"'.join('","',@courserolenames).'"';
681: $communityrolestr = '"'.join('","',@communityrolenames).'"';
682: }
1.468 raeburn 683: my $setsections = qq|
684: function setSect(sectionlist) {
1.629 raeburn 685: var sectionsArray = new Array();
686: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
687: sectionsArray = sectionlist.split(",");
688: }
1.468 raeburn 689: var numSections = sectionsArray.length;
690: document.$formname.$sec_element.length = 0;
691: if (numSections == 0) {
692: document.$formname.$sec_element.multiple=false;
693: document.$formname.$sec_element.size=1;
694: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
695: } else {
696: if (numSections == 1) {
697: document.$formname.$sec_element.multiple=false;
698: document.$formname.$sec_element.size=1;
699: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
700: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
701: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
702: } else {
703: for (var i=0; i<numSections; i++) {
704: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
705: }
706: document.$formname.$sec_element.multiple=true
707: if (numSections < 3) {
708: document.$formname.$sec_element.size=numSections;
709: } else {
710: document.$formname.$sec_element.size=3;
711: }
712: document.$formname.$sec_element.options[0].selected = false
713: }
714: }
1.91 www 715: }
1.905 raeburn 716:
717: function setRole(crstype) {
1.468 raeburn 718: |;
1.905 raeburn 719: if ($role_element eq '') {
720: $setsections .= ' return;
721: }
722: ';
723: } else {
724: $setsections .= qq|
725: var elementLength = document.$formname.$role_element.length;
726: var allroles = Array($rolestr);
727: var courserolenames = Array($courserolestr);
728: var communityrolenames = Array($communityrolestr);
729: if (elementLength != undefined) {
730: if (document.$formname.$role_element.options[5].value == 'cc') {
731: if (crstype == 'Course') {
732: return;
733: } else {
734: allroles[5] = 'co';
735: for (var i=0; i<6; i++) {
736: document.$formname.$role_element.options[i].value = allroles[i];
737: document.$formname.$role_element.options[i].text = communityrolenames[i];
738: }
739: }
740: } else {
741: if (crstype == 'Community') {
742: return;
743: } else {
744: allroles[5] = 'cc';
745: for (var i=0; i<6; i++) {
746: document.$formname.$role_element.options[i].value = allroles[i];
747: document.$formname.$role_element.options[i].text = courserolenames[i];
748: }
749: }
750: }
751: }
752: return;
753: }
754: |;
755: }
1.468 raeburn 756: return $setsections;
757: }
758:
1.91 www 759: sub selectcourse_link {
1.909 raeburn 760: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
761: $typeelement) = @_;
762: my $type = $selecttype;
1.871 raeburn 763: my $linktext = &mt('Select Course');
764: if ($selecttype eq 'Community') {
1.909 raeburn 765: $linktext = &mt('Select Community');
1.906 raeburn 766: } elsif ($selecttype eq 'Course/Community') {
767: $linktext = &mt('Select Course/Community');
1.909 raeburn 768: $type = '';
1.871 raeburn 769: }
1.787 bisitz 770: return '<span class="LC_nobreak">'
771: ."<a href='"
772: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
773: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 774: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 775: ."'>".$linktext.'</a>'
1.787 bisitz 776: .'</span>';
1.74 www 777: }
1.42 matthew 778:
1.653 raeburn 779: sub selectauthor_link {
780: my ($form,$udom)=@_;
781: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
782: &mt('Select Author').'</a>';
783: }
784:
1.876 raeburn 785: sub selectuser_link {
1.881 raeburn 786: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 787: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 788: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 789: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 790: ');">'.$linktext.'</a>';
1.876 raeburn 791: }
792:
1.273 raeburn 793: sub check_uncheck_jscript {
794: my $jscript = <<"ENDSCRT";
795: function checkAll(field) {
796: if (field.length > 0) {
797: for (i = 0; i < field.length; i++) {
798: field[i].checked = true ;
799: }
800: } else {
801: field.checked = true
802: }
803: }
804:
805: function uncheckAll(field) {
806: if (field.length > 0) {
807: for (i = 0; i < field.length; i++) {
808: field[i].checked = false ;
1.543 albertel 809: }
810: } else {
1.273 raeburn 811: field.checked = false ;
812: }
813: }
814: ENDSCRT
815: return $jscript;
816: }
817:
1.656 www 818: sub select_timezone {
1.659 raeburn 819: my ($name,$selected,$onchange,$includeempty)=@_;
820: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
821: if ($includeempty) {
822: $output .= '<option value=""';
823: if (($selected eq '') || ($selected eq 'local')) {
824: $output .= ' selected="selected" ';
825: }
826: $output .= '> </option>';
827: }
1.657 raeburn 828: my @timezones = DateTime::TimeZone->all_names;
829: foreach my $tzone (@timezones) {
830: $output.= '<option value="'.$tzone.'"';
831: if ($tzone eq $selected) {
832: $output.=' selected="selected"';
833: }
834: $output.=">$tzone</option>\n";
1.656 www 835: }
836: $output.="</select>";
837: return $output;
838: }
1.273 raeburn 839:
1.687 raeburn 840: sub select_datelocale {
841: my ($name,$selected,$onchange,$includeempty)=@_;
842: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
843: if ($includeempty) {
844: $output .= '<option value=""';
845: if ($selected eq '') {
846: $output .= ' selected="selected" ';
847: }
848: $output .= '> </option>';
849: }
850: my (@possibles,%locale_names);
851: my @locales = DateTime::Locale::Catalog::Locales;
852: foreach my $locale (@locales) {
853: if (ref($locale) eq 'HASH') {
854: my $id = $locale->{'id'};
855: if ($id ne '') {
856: my $en_terr = $locale->{'en_territory'};
857: my $native_terr = $locale->{'native_territory'};
1.695 raeburn 858: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 859: if (grep(/^en$/,@languages) || !@languages) {
860: if ($en_terr ne '') {
861: $locale_names{$id} = '('.$en_terr.')';
862: } elsif ($native_terr ne '') {
863: $locale_names{$id} = $native_terr;
864: }
865: } else {
866: if ($native_terr ne '') {
867: $locale_names{$id} = $native_terr.' ';
868: } elsif ($en_terr ne '') {
869: $locale_names{$id} = '('.$en_terr.')';
870: }
871: }
872: push (@possibles,$id);
873: }
874: }
875: }
876: foreach my $item (sort(@possibles)) {
877: $output.= '<option value="'.$item.'"';
878: if ($item eq $selected) {
879: $output.=' selected="selected"';
880: }
881: $output.=">$item";
882: if ($locale_names{$item} ne '') {
883: $output.=" $locale_names{$item}</option>\n";
884: }
885: $output.="</option>\n";
886: }
887: $output.="</select>";
888: return $output;
889: }
890:
1.792 raeburn 891: sub select_language {
892: my ($name,$selected,$includeempty) = @_;
893: my %langchoices;
894: if ($includeempty) {
895: %langchoices = ('' => 'No language preference');
896: }
897: foreach my $id (&languageids()) {
898: my $code = &supportedlanguagecode($id);
899: if ($code) {
900: $langchoices{$code} = &plainlanguagedescription($id);
901: }
902: }
903: return &select_form($selected,$name,%langchoices);
904: }
905:
1.42 matthew 906: =pod
1.36 matthew 907:
1.648 raeburn 908: =item * &linked_select_forms(...)
1.36 matthew 909:
910: linked_select_forms returns a string containing a <script></script> block
911: and html for two <select> menus. The select menus will be linked in that
912: changing the value of the first menu will result in new values being placed
913: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 914: order unless a defined order is provided.
1.36 matthew 915:
916: linked_select_forms takes the following ordered inputs:
917:
918: =over 4
919:
1.112 bowersj2 920: =item * $formname, the name of the <form> tag
1.36 matthew 921:
1.112 bowersj2 922: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 923:
1.112 bowersj2 924: =item * $firstdefault, the default value for the first menu
1.36 matthew 925:
1.112 bowersj2 926: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 927:
1.112 bowersj2 928: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 929:
1.112 bowersj2 930: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 931:
1.609 raeburn 932: =item * $menuorder, the order of values in the first menu
933:
1.41 ng 934: =back
935:
1.36 matthew 936: Below is an example of such a hash. Only the 'text', 'default', and
937: 'select2' keys must appear as stated. keys(%menu) are the possible
938: values for the first select menu. The text that coincides with the
1.41 ng 939: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 940: and text for the second menu are given in the hash pointed to by
941: $menu{$choice1}->{'select2'}.
942:
1.112 bowersj2 943: my %menu = ( A1 => { text =>"Choice A1" ,
944: default => "B3",
945: select2 => {
946: B1 => "Choice B1",
947: B2 => "Choice B2",
948: B3 => "Choice B3",
949: B4 => "Choice B4"
1.609 raeburn 950: },
951: order => ['B4','B3','B1','B2'],
1.112 bowersj2 952: },
953: A2 => { text =>"Choice A2" ,
954: default => "C2",
955: select2 => {
956: C1 => "Choice C1",
957: C2 => "Choice C2",
958: C3 => "Choice C3"
1.609 raeburn 959: },
960: order => ['C2','C1','C3'],
1.112 bowersj2 961: },
962: A3 => { text =>"Choice A3" ,
963: default => "D6",
964: select2 => {
965: D1 => "Choice D1",
966: D2 => "Choice D2",
967: D3 => "Choice D3",
968: D4 => "Choice D4",
969: D5 => "Choice D5",
970: D6 => "Choice D6",
971: D7 => "Choice D7"
1.609 raeburn 972: },
973: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 974: }
975: );
1.36 matthew 976:
977: =cut
978:
979: sub linked_select_forms {
980: my ($formname,
981: $middletext,
982: $firstdefault,
983: $firstselectname,
984: $secondselectname,
1.609 raeburn 985: $hashref,
986: $menuorder,
1.36 matthew 987: ) = @_;
988: my $second = "document.$formname.$secondselectname";
989: my $first = "document.$formname.$firstselectname";
990: # output the javascript to do the changing
991: my $result = '';
1.776 bisitz 992: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 993: $result.="// <![CDATA[\n";
1.36 matthew 994: $result.="var select2data = new Object();\n";
995: $" = '","';
996: my $debug = '';
997: foreach my $s1 (sort(keys(%$hashref))) {
998: $result.="select2data.d_$s1 = new Object();\n";
999: $result.="select2data.d_$s1.def = new String('".
1000: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 1001: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 1002: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1003: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1004: @s2values = @{$hashref->{$s1}->{'order'}};
1005: }
1.36 matthew 1006: $result.="\"@s2values\");\n";
1007: $result.="select2data.d_$s1.texts = new Array(";
1008: my @s2texts;
1009: foreach my $value (@s2values) {
1010: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
1011: }
1012: $result.="\"@s2texts\");\n";
1013: }
1014: $"=' ';
1015: $result.= <<"END";
1016:
1017: function select1_changed() {
1018: // Determine new choice
1019: var newvalue = "d_" + $first.value;
1020: // update select2
1021: var values = select2data[newvalue].values;
1022: var texts = select2data[newvalue].texts;
1023: var select2def = select2data[newvalue].def;
1024: var i;
1025: // out with the old
1026: for (i = 0; i < $second.options.length; i++) {
1027: $second.options[i] = null;
1028: }
1029: // in with the nuclear
1030: for (i=0;i<values.length; i++) {
1031: $second.options[i] = new Option(values[i]);
1.143 matthew 1032: $second.options[i].value = values[i];
1.36 matthew 1033: $second.options[i].text = texts[i];
1034: if (values[i] == select2def) {
1035: $second.options[i].selected = true;
1036: }
1037: }
1038: }
1.824 bisitz 1039: // ]]>
1.36 matthew 1040: </script>
1041: END
1042: # output the initial values for the selection lists
1043: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609 raeburn 1044: my @order = sort(keys(%{$hashref}));
1045: if (ref($menuorder) eq 'ARRAY') {
1046: @order = @{$menuorder};
1047: }
1048: foreach my $value (@order) {
1.36 matthew 1049: $result.=" <option value=\"$value\" ";
1.253 albertel 1050: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1051: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1052: }
1053: $result .= "</select>\n";
1054: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1055: $result .= $middletext;
1056: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
1057: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1058:
1059: my @secondorder = sort(keys(%select2));
1060: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1061: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1062: }
1063: foreach my $value (@secondorder) {
1.36 matthew 1064: $result.=" <option value=\"$value\" ";
1.253 albertel 1065: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1066: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1067: }
1068: $result .= "</select>\n";
1069: # return $debug;
1070: return $result;
1071: } # end of sub linked_select_forms {
1072:
1.45 matthew 1073: =pod
1.44 bowersj2 1074:
1.648 raeburn 1075: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
1.44 bowersj2 1076:
1.112 bowersj2 1077: Returns a string corresponding to an HTML link to the given help
1078: $topic, where $topic corresponds to the name of a .tex file in
1079: /home/httpd/html/adm/help/tex, with underscores replaced by
1080: spaces.
1081:
1082: $text will optionally be linked to the same topic, allowing you to
1083: link text in addition to the graphic. If you do not want to link
1084: text, but wish to specify one of the later parameters, pass an
1085: empty string.
1086:
1087: $stayOnPage is a value that will be interpreted as a boolean. If true,
1088: the link will not open a new window. If false, the link will open
1089: a new window using Javascript. (Default is false.)
1090:
1091: $width and $height are optional numerical parameters that will
1092: override the width and height of the popped up window, which may
1093: be useful for certain help topics with big pictures included.
1.44 bowersj2 1094:
1095: =cut
1096:
1097: sub help_open_topic {
1.48 bowersj2 1098: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1099: $text = "" if (not defined $text);
1.44 bowersj2 1100: $stayOnPage = 0 if (not defined $stayOnPage);
1101: $width = 350 if (not defined $width);
1102: $height = 400 if (not defined $height);
1103: my $filename = $topic;
1104: $filename =~ s/ /_/g;
1105:
1.48 bowersj2 1106: my $template = "";
1107: my $link;
1.572 banghart 1108:
1.159 www 1109: $topic=~s/\W/\_/g;
1.44 bowersj2 1110:
1.572 banghart 1111: if (!$stayOnPage) {
1.72 bowersj2 1112: $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1.572 banghart 1113: } else {
1.48 bowersj2 1114: $link = "/adm/help/${filename}.hlp";
1115: }
1116:
1117: # Add the text
1.755 neumanie 1118: if ($text ne "") {
1.763 bisitz 1119: $template.='<span class="LC_help_open_topic">'
1120: .'<a target="_top" href="'.$link.'">'
1121: .$text.'</a>';
1.48 bowersj2 1122: }
1123:
1.763 bisitz 1124: # (Always) Add the graphic
1.179 matthew 1125: my $title = &mt('Online Help');
1.667 raeburn 1126: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.763 bisitz 1127: $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
1128: .'<img src="'.$helpicon.'" border="0"'
1129: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.934 droeschl 1130: .' title="'.$title.'" style="vertical-align:middle;"'
1.763 bisitz 1131: .' /></a>';
1132: if ($text ne "") {
1133: $template.='</span>';
1134: }
1.44 bowersj2 1135: return $template;
1136:
1.106 bowersj2 1137: }
1138:
1139: # This is a quicky function for Latex cheatsheet editing, since it
1140: # appears in at least four places
1141: sub helpLatexCheatsheet {
1.732 raeburn 1142: my ($topic,$text,$not_author) = @_;
1143: my $out;
1.106 bowersj2 1144: my $addOther = '';
1.732 raeburn 1145: if ($topic) {
1.763 bisitz 1146: $addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
1147: undef, undef, 600).
1148: '</span> ';
1149: }
1150: $out = '<span>' # Start cheatsheet
1151: .$addOther
1152: .'<span>'
1153: .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
1154: undef,undef,600)
1155: .'</span> <span>'
1156: .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
1157: undef,undef,600)
1158: .'</span>';
1.732 raeburn 1159: unless ($not_author) {
1.763 bisitz 1160: $out .= ' <span>'
1161: .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
1162: undef,undef,600)
1163: .'</span>';
1.732 raeburn 1164: }
1.763 bisitz 1165: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1166: return $out;
1.172 www 1167: }
1168:
1.430 albertel 1169: sub general_help {
1170: my $helptopic='Student_Intro';
1171: if ($env{'request.role'}=~/^(ca|au)/) {
1172: $helptopic='Authoring_Intro';
1.907 raeburn 1173: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1174: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1175: } elsif ($env{'request.role'}=~/^dc/) {
1176: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1177: }
1178: return $helptopic;
1179: }
1180:
1181: sub update_help_link {
1182: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1183: my $origurl = $ENV{'REQUEST_URI'};
1184: $origurl=~s|^/~|/priv/|;
1185: my $timestamp = time;
1186: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1187: $$datum = &escape($$datum);
1188: }
1189:
1190: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1191: my $output .= <<"ENDOUTPUT";
1192: <script type="text/javascript">
1.824 bisitz 1193: // <![CDATA[
1.430 albertel 1194: banner_link = '$banner_link';
1.824 bisitz 1195: // ]]>
1.430 albertel 1196: </script>
1197: ENDOUTPUT
1198: return $output;
1199: }
1200:
1201: # now just updates the help link and generates a blue icon
1.193 raeburn 1202: sub help_open_menu {
1.430 albertel 1203: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1204: = @_;
1.430 albertel 1205: $stayOnPage = 0 if (not defined $stayOnPage);
1.572 banghart 1206: # only use pop-up help (stayOnPage == 0)
1.552 banghart 1207: # if environment.remote is on (using remote control UI)
1.798 tempelho 1208: if ($env{'environment.remote'} eq 'off' ) {
1.552 banghart 1209: $stayOnPage=1;
1.430 albertel 1210: }
1211: my $output;
1212: if ($component_help) {
1213: if (!$text) {
1214: $output=&help_open_topic($component_help,undef,$stayOnPage,
1215: $width,$height);
1216: } else {
1217: my $help_text;
1218: $help_text=&unescape($topic);
1219: $output='<table><tr><td>'.
1220: &help_open_topic($component_help,$help_text,$stayOnPage,
1221: $width,$height).'</td></tr></table>';
1222: }
1223: }
1224: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1225: return $output.$banner_link;
1226: }
1227:
1228: sub top_nav_help {
1229: my ($text) = @_;
1.436 albertel 1230: $text = &mt($text);
1.572 banghart 1231: my $stay_on_page =
1.798 tempelho 1232: ($env{'environment.remote'} eq 'off' );
1.572 banghart 1233: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1234: : "javascript:helpMenu('open')";
1.572 banghart 1235: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1236:
1.201 raeburn 1237: my $title = &mt('Get help');
1.436 albertel 1238:
1239: return <<"END";
1240: $banner_link
1241: <a href="$link" title="$title">$text</a>
1242: END
1243: }
1244:
1245: sub help_menu_js {
1246: my ($text) = @_;
1247:
1248: my $stayOnPage =
1.798 tempelho 1249: ($env{'environment.remote'} eq 'off' );
1.436 albertel 1250:
1251: my $width = 620;
1252: my $height = 600;
1.430 albertel 1253: my $helptopic=&general_help();
1254: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1255: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1256: my $start_page =
1257: &Apache::loncommon::start_page('Help Menu', undef,
1258: {'frameset' => 1,
1259: 'js_ready' => 1,
1260: 'add_entries' => {
1261: 'border' => '0',
1.579 raeburn 1262: 'rows' => "110,*",},});
1.331 albertel 1263: my $end_page =
1264: &Apache::loncommon::end_page({'frameset' => 1,
1265: 'js_ready' => 1,});
1266:
1.436 albertel 1267: my $template .= <<"ENDTEMPLATE";
1268: <script type="text/javascript">
1.877 bisitz 1269: // <![CDATA[
1.253 albertel 1270: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1271: var banner_link = '';
1.243 raeburn 1272: function helpMenu(target) {
1273: var caller = this;
1274: if (target == 'open') {
1275: var newWindow = null;
1276: try {
1.262 albertel 1277: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1278: }
1279: catch(error) {
1280: writeHelp(caller);
1281: return;
1282: }
1283: if (newWindow) {
1284: caller = newWindow;
1285: }
1.193 raeburn 1286: }
1.243 raeburn 1287: writeHelp(caller);
1288: return;
1289: }
1290: function writeHelp(caller) {
1.430 albertel 1291: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243 raeburn 1292: caller.document.close()
1293: caller.focus()
1.193 raeburn 1294: }
1.877 bisitz 1295: // END LON-CAPA Internal -->
1.253 albertel 1296: // ]]>
1.436 albertel 1297: </script>
1.193 raeburn 1298: ENDTEMPLATE
1299: return $template;
1300: }
1301:
1.172 www 1302: sub help_open_bug {
1303: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1304: unless ($env{'user.adv'}) { return ''; }
1.172 www 1305: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1306: $text = "" if (not defined $text);
1307: $stayOnPage = 0 if (not defined $stayOnPage);
1.798 tempelho 1308: if ($env{'environment.remote'} eq 'off' ) {
1.172 www 1309: $stayOnPage=1;
1310: }
1.184 albertel 1311: $width = 600 if (not defined $width);
1312: $height = 600 if (not defined $height);
1.172 www 1313:
1314: $topic=~s/\W+/\+/g;
1315: my $link='';
1316: my $template='';
1.379 albertel 1317: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1318: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1319: if (!$stayOnPage)
1320: {
1321: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1322: }
1323: else
1324: {
1325: $link = $url;
1326: }
1327: # Add the text
1328: if ($text ne "")
1329: {
1330: $template .=
1331: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1332: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1333: }
1334:
1335: # Add the graphic
1.179 matthew 1336: my $title = &mt('Report a Bug');
1.215 albertel 1337: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1338: $template .= <<"ENDTEMPLATE";
1.436 albertel 1339: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1340: ENDTEMPLATE
1341: if ($text ne '') { $template.='</td></tr></table>' };
1342: return $template;
1343:
1344: }
1345:
1346: sub help_open_faq {
1347: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1348: unless ($env{'user.adv'}) { return ''; }
1.172 www 1349: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1350: $text = "" if (not defined $text);
1351: $stayOnPage = 0 if (not defined $stayOnPage);
1.798 tempelho 1352: if ($env{'environment.remote'} eq 'off' ) {
1.172 www 1353: $stayOnPage=1;
1354: }
1355: $width = 350 if (not defined $width);
1356: $height = 400 if (not defined $height);
1357:
1358: $topic=~s/\W+/\+/g;
1359: my $link='';
1360: my $template='';
1361: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1362: if (!$stayOnPage)
1363: {
1364: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1365: }
1366: else
1367: {
1368: $link = $url;
1369: }
1370:
1371: # Add the text
1372: if ($text ne "")
1373: {
1374: $template .=
1.173 www 1375: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1376: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1377: }
1378:
1379: # Add the graphic
1.179 matthew 1380: my $title = &mt('View the FAQ');
1.215 albertel 1381: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1382: $template .= <<"ENDTEMPLATE";
1.436 albertel 1383: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1384: ENDTEMPLATE
1385: if ($text ne '') { $template.='</td></tr></table>' };
1386: return $template;
1387:
1.44 bowersj2 1388: }
1.37 matthew 1389:
1.180 matthew 1390: ###############################################################
1391: ###############################################################
1392:
1.45 matthew 1393: =pod
1394:
1.648 raeburn 1395: =item * &change_content_javascript():
1.256 matthew 1396:
1397: This and the next function allow you to create small sections of an
1398: otherwise static HTML page that you can update on the fly with
1399: Javascript, even in Netscape 4.
1400:
1401: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1402: must be written to the HTML page once. It will prove the Javascript
1403: function "change(name, content)". Calling the change function with the
1404: name of the section
1405: you want to update, matching the name passed to C<changable_area>, and
1406: the new content you want to put in there, will put the content into
1407: that area.
1408:
1409: B<Note>: Netscape 4 only reserves enough space for the changable area
1410: to contain room for the original contents. You need to "make space"
1411: for whatever changes you wish to make, and be B<sure> to check your
1412: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1413: it's adequate for updating a one-line status display, but little more.
1414: This script will set the space to 100% width, so you only need to
1415: worry about height in Netscape 4.
1416:
1417: Modern browsers are much less limiting, and if you can commit to the
1418: user not using Netscape 4, this feature may be used freely with
1419: pretty much any HTML.
1420:
1421: =cut
1422:
1423: sub change_content_javascript {
1424: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1425: if ($env{'browser.type'} eq 'netscape' &&
1426: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1427: return (<<NETSCAPE4);
1428: function change(name, content) {
1429: doc = document.layers[name+"___escape"].layers[0].document;
1430: doc.open();
1431: doc.write(content);
1432: doc.close();
1433: }
1434: NETSCAPE4
1435: } else {
1436: # Otherwise, we need to use semi-standards-compliant code
1437: # (technically, "innerHTML" isn't standard but the equivalent
1438: # is really scary, and every useful browser supports it
1439: return (<<DOMBASED);
1440: function change(name, content) {
1441: element = document.getElementById(name);
1442: element.innerHTML = content;
1443: }
1444: DOMBASED
1445: }
1446: }
1447:
1448: =pod
1449:
1.648 raeburn 1450: =item * &changable_area($name,$origContent):
1.256 matthew 1451:
1452: This provides a "changable area" that can be modified on the fly via
1453: the Javascript code provided in C<change_content_javascript>. $name is
1454: the name you will use to reference the area later; do not repeat the
1455: same name on a given HTML page more then once. $origContent is what
1456: the area will originally contain, which can be left blank.
1457:
1458: =cut
1459:
1460: sub changable_area {
1461: my ($name, $origContent) = @_;
1462:
1.258 albertel 1463: if ($env{'browser.type'} eq 'netscape' &&
1464: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1465: # If this is netscape 4, we need to use the Layer tag
1466: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1467: } else {
1468: return "<span id='$name'>$origContent</span>";
1469: }
1470: }
1471:
1472: =pod
1473:
1.648 raeburn 1474: =item * &viewport_geometry_js
1.590 raeburn 1475:
1476: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1477:
1478: =cut
1479:
1480:
1481: sub viewport_geometry_js {
1482: return <<"GEOMETRY";
1483: var Geometry = {};
1484: function init_geometry() {
1485: if (Geometry.init) { return };
1486: Geometry.init=1;
1487: if (window.innerHeight) {
1488: Geometry.getViewportHeight = function() { return window.innerHeight; };
1489: Geometry.getViewportWidth = function() { return window.innerWidth; };
1490: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1491: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1492: }
1493: else if (document.documentElement && document.documentElement.clientHeight) {
1494: Geometry.getViewportHeight =
1495: function() { return document.documentElement.clientHeight; };
1496: Geometry.getViewportWidth =
1497: function() { return document.documentElement.clientWidth; };
1498:
1499: Geometry.getHorizontalScroll =
1500: function() { return document.documentElement.scrollLeft; };
1501: Geometry.getVerticalScroll =
1502: function() { return document.documentElement.scrollTop; };
1503: }
1504: else if (document.body.clientHeight) {
1505: Geometry.getViewportHeight =
1506: function() { return document.body.clientHeight; };
1507: Geometry.getViewportWidth =
1508: function() { return document.body.clientWidth; };
1509: Geometry.getHorizontalScroll =
1510: function() { return document.body.scrollLeft; };
1511: Geometry.getVerticalScroll =
1512: function() { return document.body.scrollTop; };
1513: }
1514: }
1515:
1516: GEOMETRY
1517: }
1518:
1519: =pod
1520:
1.648 raeburn 1521: =item * &viewport_size_js()
1.590 raeburn 1522:
1523: Provides a javascript function to set values of two form elements - width and height (elements are passed in as arguments to the javascript function) to the dimensions of the user's browser window.
1524:
1525: =cut
1526:
1527: sub viewport_size_js {
1528: my $geometry = &viewport_geometry_js();
1529: return <<"DIMS";
1530:
1531: $geometry
1532:
1533: function getViewportDims(width,height) {
1534: init_geometry();
1535: width.value = Geometry.getViewportWidth();
1536: height.value = Geometry.getViewportHeight();
1537: return;
1538: }
1539:
1540: DIMS
1541: }
1542:
1543: =pod
1544:
1.648 raeburn 1545: =item * &resize_textarea_js()
1.565 albertel 1546:
1547: emits the needed javascript to resize a textarea to be as big as possible
1548:
1549: creates a function resize_textrea that takes two IDs first should be
1550: the id of the element to resize, second should be the id of a div that
1551: surrounds everything that comes after the textarea, this routine needs
1552: to be attached to the <body> for the onload and onresize events.
1553:
1.648 raeburn 1554: =back
1.565 albertel 1555:
1556: =cut
1557:
1558: sub resize_textarea_js {
1.590 raeburn 1559: my $geometry = &viewport_geometry_js();
1.565 albertel 1560: return <<"RESIZE";
1561: <script type="text/javascript">
1.824 bisitz 1562: // <![CDATA[
1.590 raeburn 1563: $geometry
1.565 albertel 1564:
1.588 albertel 1565: function getX(element) {
1566: var x = 0;
1567: while (element) {
1568: x += element.offsetLeft;
1569: element = element.offsetParent;
1570: }
1571: return x;
1572: }
1573: function getY(element) {
1574: var y = 0;
1575: while (element) {
1576: y += element.offsetTop;
1577: element = element.offsetParent;
1578: }
1579: return y;
1580: }
1581:
1582:
1.565 albertel 1583: function resize_textarea(textarea_id,bottom_id) {
1584: init_geometry();
1585: var textarea = document.getElementById(textarea_id);
1586: //alert(textarea);
1587:
1.588 albertel 1588: var textarea_top = getY(textarea);
1.565 albertel 1589: var textarea_height = textarea.offsetHeight;
1590: var bottom = document.getElementById(bottom_id);
1.588 albertel 1591: var bottom_top = getY(bottom);
1.565 albertel 1592: var bottom_height = bottom.offsetHeight;
1593: var window_height = Geometry.getViewportHeight();
1.588 albertel 1594: var fudge = 23;
1.565 albertel 1595: var new_height = window_height-fudge-textarea_top-bottom_height;
1596: if (new_height < 300) {
1597: new_height = 300;
1598: }
1599: textarea.style.height=new_height+'px';
1600: }
1.824 bisitz 1601: // ]]>
1.565 albertel 1602: </script>
1603: RESIZE
1604:
1605: }
1606:
1607: =pod
1608:
1.256 matthew 1609: =head1 Excel and CSV file utility routines
1610:
1611: =over 4
1612:
1613: =cut
1614:
1615: ###############################################################
1616: ###############################################################
1617:
1618: =pod
1619:
1.648 raeburn 1620: =item * &csv_translate($text)
1.37 matthew 1621:
1.185 www 1622: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1623: format.
1624:
1625: =cut
1626:
1.180 matthew 1627: ###############################################################
1628: ###############################################################
1.37 matthew 1629: sub csv_translate {
1630: my $text = shift;
1631: $text =~ s/\"/\"\"/g;
1.209 albertel 1632: $text =~ s/\n/ /g;
1.37 matthew 1633: return $text;
1634: }
1.180 matthew 1635:
1636: ###############################################################
1637: ###############################################################
1638:
1639: =pod
1640:
1.648 raeburn 1641: =item * &define_excel_formats()
1.180 matthew 1642:
1643: Define some commonly used Excel cell formats.
1644:
1645: Currently supported formats:
1646:
1647: =over 4
1648:
1649: =item header
1650:
1651: =item bold
1652:
1653: =item h1
1654:
1655: =item h2
1656:
1657: =item h3
1658:
1.256 matthew 1659: =item h4
1660:
1661: =item i
1662:
1.180 matthew 1663: =item date
1664:
1665: =back
1666:
1667: Inputs: $workbook
1668:
1669: Returns: $format, a hash reference.
1670:
1671: =cut
1672:
1673: ###############################################################
1674: ###############################################################
1675: sub define_excel_formats {
1676: my ($workbook) = @_;
1677: my $format;
1678: $format->{'header'} = $workbook->add_format(bold => 1,
1679: bottom => 1,
1680: align => 'center');
1681: $format->{'bold'} = $workbook->add_format(bold=>1);
1682: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1683: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1684: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1685: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1686: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1687: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1688: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1689: return $format;
1690: }
1691:
1692: ###############################################################
1693: ###############################################################
1.113 bowersj2 1694:
1695: =pod
1696:
1.648 raeburn 1697: =item * &create_workbook()
1.255 matthew 1698:
1699: Create an Excel worksheet. If it fails, output message on the
1700: request object and return undefs.
1701:
1702: Inputs: Apache request object
1703:
1704: Returns (undef) on failure,
1705: Excel worksheet object, scalar with filename, and formats
1706: from &Apache::loncommon::define_excel_formats on success
1707:
1708: =cut
1709:
1710: ###############################################################
1711: ###############################################################
1712: sub create_workbook {
1713: my ($r) = @_;
1714: #
1715: # Create the excel spreadsheet
1716: my $filename = '/prtspool/'.
1.258 albertel 1717: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1718: time.'_'.rand(1000000000).'.xls';
1719: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1720: if (! defined($workbook)) {
1721: $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928 bisitz 1722: $r->print(
1723: '<p class="LC_error">'
1724: .&mt('Problems occurred in creating the new Excel file.')
1725: .' '.&mt('This error has been logged.')
1726: .' '.&mt('Please alert your LON-CAPA administrator.')
1727: .'</p>'
1728: );
1.255 matthew 1729: return (undef);
1730: }
1731: #
1732: $workbook->set_tempdir('/home/httpd/perl/tmp');
1733: #
1734: my $format = &Apache::loncommon::define_excel_formats($workbook);
1735: return ($workbook,$filename,$format);
1736: }
1737:
1738: ###############################################################
1739: ###############################################################
1740:
1741: =pod
1742:
1.648 raeburn 1743: =item * &create_text_file()
1.113 bowersj2 1744:
1.542 raeburn 1745: Create a file to write to and eventually make available to the user.
1.256 matthew 1746: If file creation fails, outputs an error message on the request object and
1747: return undefs.
1.113 bowersj2 1748:
1.256 matthew 1749: Inputs: Apache request object, and file suffix
1.113 bowersj2 1750:
1.256 matthew 1751: Returns (undef) on failure,
1752: Filehandle and filename on success.
1.113 bowersj2 1753:
1754: =cut
1755:
1.256 matthew 1756: ###############################################################
1757: ###############################################################
1758: sub create_text_file {
1759: my ($r,$suffix) = @_;
1760: if (! defined($suffix)) { $suffix = 'txt'; };
1761: my $fh;
1762: my $filename = '/prtspool/'.
1.258 albertel 1763: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1764: time.'_'.rand(1000000000).'.'.$suffix;
1765: $fh = Apache::File->new('>/home/httpd'.$filename);
1766: if (! defined($fh)) {
1767: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 1768: $r->print(
1769: '<p class="LC_error">'
1770: .&mt('Problems occurred in creating the output file.')
1771: .' '.&mt('This error has been logged.')
1772: .' '.&mt('Please alert your LON-CAPA administrator.')
1773: .'</p>'
1774: );
1.113 bowersj2 1775: }
1.256 matthew 1776: return ($fh,$filename)
1.113 bowersj2 1777: }
1778:
1779:
1.256 matthew 1780: =pod
1.113 bowersj2 1781:
1782: =back
1783:
1784: =cut
1.37 matthew 1785:
1786: ###############################################################
1.33 matthew 1787: ## Home server <option> list generating code ##
1788: ###############################################################
1.35 matthew 1789:
1.169 www 1790: # ------------------------------------------
1791:
1792: sub domain_select {
1793: my ($name,$value,$multiple)=@_;
1794: my %domains=map {
1.514 albertel 1795: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1796: } &Apache::lonnet::all_domains();
1.169 www 1797: if ($multiple) {
1798: $domains{''}=&mt('Any domain');
1.550 albertel 1799: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1800: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1801: } else {
1.550 albertel 1802: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169 www 1803: return &select_form($name,$value,%domains);
1804: }
1805: }
1806:
1.282 albertel 1807: #-------------------------------------------
1808:
1809: =pod
1810:
1.519 raeburn 1811: =head1 Routines for form select boxes
1812:
1813: =over 4
1814:
1.648 raeburn 1815: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1816:
1817: Returns a string containing a <select> element int multiple mode
1818:
1819:
1820: Args:
1821: $name - name of the <select> element
1.506 raeburn 1822: $value - scalar or array ref of values that should already be selected
1.282 albertel 1823: $size - number of rows long the select element is
1.283 albertel 1824: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1825: (shown text should already have been &mt())
1.506 raeburn 1826: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1827:
1.282 albertel 1828: =cut
1829:
1830: #-------------------------------------------
1.169 www 1831: sub multiple_select_form {
1.284 albertel 1832: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1833: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1834: my $output='';
1.191 matthew 1835: if (! defined($size)) {
1836: $size = 4;
1.283 albertel 1837: if (scalar(keys(%$hash))<4) {
1838: $size = scalar(keys(%$hash));
1.191 matthew 1839: }
1840: }
1.734 bisitz 1841: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1842: my @order;
1.506 raeburn 1843: if (ref($order) eq 'ARRAY') {
1844: @order = @{$order};
1845: } else {
1846: @order = sort(keys(%$hash));
1.501 banghart 1847: }
1848: if (exists($$hash{'select_form_order'})) {
1849: @order = @{$$hash{'select_form_order'}};
1850: }
1851:
1.284 albertel 1852: foreach my $key (@order) {
1.356 albertel 1853: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1854: $output.='selected="selected" ' if ($selected{$key});
1855: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1856: }
1857: $output.="</select>\n";
1858: return $output;
1859: }
1860:
1.88 www 1861: #-------------------------------------------
1862:
1863: =pod
1864:
1.648 raeburn 1865: =item * &select_form($defdom,$name,%hash)
1.88 www 1866:
1867: Returns a string containing a <select name='$name' size='1'> form to
1868: allow a user to select options from a hash option_name => displayed text.
1869: See lonrights.pm for an example invocation and use.
1870:
1871: =cut
1872:
1873: #-------------------------------------------
1874: sub select_form {
1875: my ($def,$name,%hash) = @_;
1876: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128 albertel 1877: my @keys;
1878: if (exists($hash{'select_form_order'})) {
1879: @keys=@{$hash{'select_form_order'}};
1880: } else {
1881: @keys=sort(keys(%hash));
1882: }
1.356 albertel 1883: foreach my $key (@keys) {
1884: $selectform.=
1885: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1886: ($key eq $def ? 'selected="selected" ' : '').
1.922 bisitz 1887: ">".$hash{$key}."</option>\n";
1.88 www 1888: }
1889: $selectform.="</select>";
1890: return $selectform;
1891: }
1892:
1.475 www 1893: # For display filters
1894:
1895: sub display_filter {
1896: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1897: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714 bisitz 1898: return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475 www 1899: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1900: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 1901: '</label></span> <span class="LC_nobreak">'.
1.475 www 1902: &mt('Filter [_1]',
1.477 www 1903: &select_form($env{'form.displayfilter'},
1904: 'displayfilter',
1905: ('currentfolder' => 'Current folder/page',
1906: 'containing' => 'Containing phrase',
1907: 'none' => 'None'))).
1.714 bisitz 1908: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475 www 1909: }
1910:
1.167 www 1911: sub gradeleveldescription {
1912: my $gradelevel=shift;
1913: my %gradelevels=(0 => 'Not specified',
1914: 1 => 'Grade 1',
1915: 2 => 'Grade 2',
1916: 3 => 'Grade 3',
1917: 4 => 'Grade 4',
1918: 5 => 'Grade 5',
1919: 6 => 'Grade 6',
1920: 7 => 'Grade 7',
1921: 8 => 'Grade 8',
1922: 9 => 'Grade 9',
1923: 10 => 'Grade 10',
1924: 11 => 'Grade 11',
1925: 12 => 'Grade 12',
1926: 13 => 'Grade 13',
1927: 14 => '100 Level',
1928: 15 => '200 Level',
1929: 16 => '300 Level',
1930: 17 => '400 Level',
1931: 18 => 'Graduate Level');
1932: return &mt($gradelevels{$gradelevel});
1933: }
1934:
1.163 www 1935: sub select_level_form {
1936: my ($deflevel,$name)=@_;
1937: unless ($deflevel) { $deflevel=0; }
1.167 www 1938: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1939: for (my $i=0; $i<=18; $i++) {
1940: $selectform.="<option value=\"$i\" ".
1.253 albertel 1941: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1942: ">".&gradeleveldescription($i)."</option>\n";
1943: }
1944: $selectform.="</select>";
1945: return $selectform;
1.163 www 1946: }
1.167 www 1947:
1.35 matthew 1948: #-------------------------------------------
1949:
1.45 matthew 1950: =pod
1951:
1.910 raeburn 1952: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35 matthew 1953:
1954: Returns a string containing a <select name='$name' size='1'> form to
1955: allow a user to select the domain to preform an operation in.
1956: See loncreateuser.pm for an example invocation and use.
1957:
1.90 www 1958: If the $includeempty flag is set, it also includes an empty choice ("no domain
1959: selected");
1960:
1.743 raeburn 1961: If the $showdomdesc flag is set, the domain name is followed by the domain description.
1962:
1.910 raeburn 1963: The optional $onchange argument specifies what should occur if the domain selector is changed, e.g., 'this.form.submit()' if the form is to be automatically submitted.
1964:
1965: The optional $incdoms is a reference to an array of domains which will be the only available options.
1.563 raeburn 1966:
1.35 matthew 1967: =cut
1968:
1969: #-------------------------------------------
1.34 matthew 1970: sub select_dom_form {
1.910 raeburn 1971: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.872 raeburn 1972: if ($onchange) {
1.874 raeburn 1973: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 1974: }
1.910 raeburn 1975: my @domains;
1976: if (ref($incdoms) eq 'ARRAY') {
1977: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
1978: } else {
1979: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1980: }
1.90 www 1981: if ($includeempty) { @domains=('',@domains); }
1.743 raeburn 1982: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 1983: foreach my $dom (@domains) {
1984: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 1985: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
1986: if ($showdomdesc) {
1987: if ($dom ne '') {
1988: my $domdesc = &Apache::lonnet::domain($dom,'description');
1989: if ($domdesc ne '') {
1990: $selectdomain .= ' ('.$domdesc.')';
1991: }
1992: }
1993: }
1994: $selectdomain .= "</option>\n";
1.34 matthew 1995: }
1996: $selectdomain.="</select>";
1997: return $selectdomain;
1998: }
1999:
1.35 matthew 2000: #-------------------------------------------
2001:
1.45 matthew 2002: =pod
2003:
1.648 raeburn 2004: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 2005:
1.586 raeburn 2006: input: 4 arguments (two required, two optional) -
2007: $domain - domain of new user
2008: $name - name of form element
2009: $default - Value of 'default' causes a default item to be first
2010: option, and selected by default.
2011: $hide - Value of 'hide' causes hiding of the name of the server,
2012: if 1 server found, or default, if 0 found.
1.594 raeburn 2013: output: returns 2 items:
1.586 raeburn 2014: (a) form element which contains either:
2015: (i) <select name="$name">
2016: <option value="$hostid1">$hostid $servers{$hostid}</option>
2017: <option value="$hostid2">$hostid $servers{$hostid}</option>
2018: </select>
2019: form item if there are multiple library servers in $domain, or
2020: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2021: if there is only one library server in $domain.
2022:
2023: (b) number of library servers found.
2024:
2025: See loncreateuser.pm for example of use.
1.35 matthew 2026:
2027: =cut
2028:
2029: #-------------------------------------------
1.586 raeburn 2030: sub home_server_form_item {
2031: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2032: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2033: my $result;
2034: my $numlib = keys(%servers);
2035: if ($numlib > 1) {
2036: $result .= '<select name="'.$name.'" />'."\n";
2037: if ($default) {
1.804 bisitz 2038: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 2039: '</option>'."\n";
2040: }
2041: foreach my $hostid (sort(keys(%servers))) {
2042: $result.= '<option value="'.$hostid.'">'.
2043: $hostid.' '.$servers{$hostid}."</option>\n";
2044: }
2045: $result .= '</select>'."\n";
2046: } elsif ($numlib == 1) {
2047: my $hostid;
2048: foreach my $item (keys(%servers)) {
2049: $hostid = $item;
2050: }
2051: $result .= '<input type="hidden" name="'.$name.'" value="'.
2052: $hostid.'" />';
2053: if (!$hide) {
2054: $result .= $hostid.' '.$servers{$hostid};
2055: }
2056: $result .= "\n";
2057: } elsif ($default) {
2058: $result .= '<input type="hidden" name="'.$name.
2059: '" value="default" />';
2060: if (!$hide) {
2061: $result .= &mt('default');
2062: }
2063: $result .= "\n";
1.33 matthew 2064: }
1.586 raeburn 2065: return ($result,$numlib);
1.33 matthew 2066: }
1.112 bowersj2 2067:
2068: =pod
2069:
1.534 albertel 2070: =back
2071:
1.112 bowersj2 2072: =cut
1.87 matthew 2073:
2074: ###############################################################
1.112 bowersj2 2075: ## Decoding User Agent ##
1.87 matthew 2076: ###############################################################
2077:
2078: =pod
2079:
1.112 bowersj2 2080: =head1 Decoding the User Agent
2081:
2082: =over 4
2083:
2084: =item * &decode_user_agent()
1.87 matthew 2085:
2086: Inputs: $r
2087:
2088: Outputs:
2089:
2090: =over 4
2091:
1.112 bowersj2 2092: =item * $httpbrowser
1.87 matthew 2093:
1.112 bowersj2 2094: =item * $clientbrowser
1.87 matthew 2095:
1.112 bowersj2 2096: =item * $clientversion
1.87 matthew 2097:
1.112 bowersj2 2098: =item * $clientmathml
1.87 matthew 2099:
1.112 bowersj2 2100: =item * $clientunicode
1.87 matthew 2101:
1.112 bowersj2 2102: =item * $clientos
1.87 matthew 2103:
2104: =back
2105:
1.157 matthew 2106: =back
2107:
1.87 matthew 2108: =cut
2109:
2110: ###############################################################
2111: ###############################################################
2112: sub decode_user_agent {
1.247 albertel 2113: my ($r)=@_;
1.87 matthew 2114: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2115: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2116: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2117: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2118: my $clientbrowser='unknown';
2119: my $clientversion='0';
2120: my $clientmathml='';
2121: my $clientunicode='0';
2122: for (my $i=0;$i<=$#browsertype;$i++) {
2123: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
2124: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2125: $clientbrowser=$bname;
2126: $httpbrowser=~/$vreg/i;
2127: $clientversion=$1;
2128: $clientmathml=($clientversion>=$minv);
2129: $clientunicode=($clientversion>=$univ);
2130: }
2131: }
2132: my $clientos='unknown';
2133: if (($httpbrowser=~/linux/i) ||
2134: ($httpbrowser=~/unix/i) ||
2135: ($httpbrowser=~/ux/i) ||
2136: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2137: if (($httpbrowser=~/vax/i) ||
2138: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2139: if ($httpbrowser=~/next/i) { $clientos='next'; }
2140: if (($httpbrowser=~/mac/i) ||
2141: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
2142: if ($httpbrowser=~/win/i) { $clientos='win'; }
2143: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
2144: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
2145: $clientunicode,$clientos,);
2146: }
2147:
1.32 matthew 2148: ###############################################################
2149: ## Authentication changing form generation subroutines ##
2150: ###############################################################
2151: ##
2152: ## All of the authform_xxxxxxx subroutines take their inputs in a
2153: ## hash, and have reasonable default values.
2154: ##
2155: ## formname = the name given in the <form> tag.
1.35 matthew 2156: #-------------------------------------------
2157:
1.45 matthew 2158: =pod
2159:
1.112 bowersj2 2160: =head1 Authentication Routines
2161:
2162: =over 4
2163:
1.648 raeburn 2164: =item * &authform_xxxxxx()
1.35 matthew 2165:
2166: The authform_xxxxxx subroutines provide javascript and html forms which
2167: handle some of the conveniences required for authentication forms.
2168: This is not an optimal method, but it works.
2169:
2170: =over 4
2171:
1.112 bowersj2 2172: =item * authform_header
1.35 matthew 2173:
1.112 bowersj2 2174: =item * authform_authorwarning
1.35 matthew 2175:
1.112 bowersj2 2176: =item * authform_nochange
1.35 matthew 2177:
1.112 bowersj2 2178: =item * authform_kerberos
1.35 matthew 2179:
1.112 bowersj2 2180: =item * authform_internal
1.35 matthew 2181:
1.112 bowersj2 2182: =item * authform_filesystem
1.35 matthew 2183:
2184: =back
2185:
1.648 raeburn 2186: See loncreateuser.pm for invocation and use examples.
1.157 matthew 2187:
1.35 matthew 2188: =cut
2189:
2190: #-------------------------------------------
1.32 matthew 2191: sub authform_header{
2192: my %in = (
2193: formname => 'cu',
1.80 albertel 2194: kerb_def_dom => '',
1.32 matthew 2195: @_,
2196: );
2197: $in{'formname'} = 'document.' . $in{'formname'};
2198: my $result='';
1.80 albertel 2199:
2200: #---------------------------------------------- Code for upper case translation
2201: my $Javascript_toUpperCase;
2202: unless ($in{kerb_def_dom}) {
2203: $Javascript_toUpperCase =<<"END";
2204: switch (choice) {
2205: case 'krb': currentform.elements[choicearg].value =
2206: currentform.elements[choicearg].value.toUpperCase();
2207: break;
2208: default:
2209: }
2210: END
2211: } else {
2212: $Javascript_toUpperCase = "";
2213: }
2214:
1.165 raeburn 2215: my $radioval = "'nochange'";
1.591 raeburn 2216: if (defined($in{'curr_authtype'})) {
2217: if ($in{'curr_authtype'} ne '') {
2218: $radioval = "'".$in{'curr_authtype'}."arg'";
2219: }
1.174 matthew 2220: }
1.165 raeburn 2221: my $argfield = 'null';
1.591 raeburn 2222: if (defined($in{'mode'})) {
1.165 raeburn 2223: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2224: if (defined($in{'curr_autharg'})) {
2225: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2226: $argfield = "'$in{'curr_autharg'}'";
2227: }
2228: }
2229: }
2230: }
2231:
1.32 matthew 2232: $result.=<<"END";
2233: var current = new Object();
1.165 raeburn 2234: current.radiovalue = $radioval;
2235: current.argfield = $argfield;
1.32 matthew 2236:
2237: function changed_radio(choice,currentform) {
2238: var choicearg = choice + 'arg';
2239: // If a radio button in changed, we need to change the argfield
2240: if (current.radiovalue != choice) {
2241: current.radiovalue = choice;
2242: if (current.argfield != null) {
2243: currentform.elements[current.argfield].value = '';
2244: }
2245: if (choice == 'nochange') {
2246: current.argfield = null;
2247: } else {
2248: current.argfield = choicearg;
2249: switch(choice) {
2250: case 'krb':
2251: currentform.elements[current.argfield].value =
2252: "$in{'kerb_def_dom'}";
2253: break;
2254: default:
2255: break;
2256: }
2257: }
2258: }
2259: return;
2260: }
1.22 www 2261:
1.32 matthew 2262: function changed_text(choice,currentform) {
2263: var choicearg = choice + 'arg';
2264: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2265: $Javascript_toUpperCase
1.32 matthew 2266: // clear old field
2267: if ((current.argfield != choicearg) && (current.argfield != null)) {
2268: currentform.elements[current.argfield].value = '';
2269: }
2270: current.argfield = choicearg;
2271: }
2272: set_auth_radio_buttons(choice,currentform);
2273: return;
1.20 www 2274: }
1.32 matthew 2275:
2276: function set_auth_radio_buttons(newvalue,currentform) {
2277: var i=0;
2278: while (i < currentform.login.length) {
2279: if (currentform.login[i].value == newvalue) { break; }
2280: i++;
2281: }
2282: if (i == currentform.login.length) {
2283: return;
2284: }
2285: current.radiovalue = newvalue;
2286: currentform.login[i].checked = true;
2287: return;
2288: }
2289: END
2290: return $result;
2291: }
2292:
2293: sub authform_authorwarning{
2294: my $result='';
1.144 matthew 2295: $result='<i>'.
2296: &mt('As a general rule, only authors or co-authors should be '.
2297: 'filesystem authenticated '.
2298: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2299: return $result;
2300: }
2301:
2302: sub authform_nochange{
2303: my %in = (
2304: formname => 'document.cu',
2305: kerb_def_dom => 'MSU.EDU',
2306: @_,
2307: );
1.586 raeburn 2308: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2309: my $result;
2310: if (keys(%can_assign) == 0) {
2311: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2312: } else {
2313: $result = '<label>'.&mt('[_1] Do not change login data',
2314: '<input type="radio" name="login" value="nochange" '.
2315: 'checked="checked" onclick="'.
1.281 albertel 2316: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2317: '</label>';
1.586 raeburn 2318: }
1.32 matthew 2319: return $result;
2320: }
2321:
1.591 raeburn 2322: sub authform_kerberos {
1.32 matthew 2323: my %in = (
2324: formname => 'document.cu',
2325: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2326: kerb_def_auth => 'krb4',
1.32 matthew 2327: @_,
2328: );
1.586 raeburn 2329: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2330: $autharg,$jscall);
2331: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2332: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2333: $check5 = ' checked="checked"';
1.80 albertel 2334: } else {
1.772 bisitz 2335: $check4 = ' checked="checked"';
1.80 albertel 2336: }
1.165 raeburn 2337: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2338: if (defined($in{'curr_authtype'})) {
2339: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2340: $krbcheck = ' checked="checked"';
1.623 raeburn 2341: if (defined($in{'mode'})) {
2342: if ($in{'mode'} eq 'modifyuser') {
2343: $krbcheck = '';
2344: }
2345: }
1.591 raeburn 2346: if (defined($in{'curr_kerb_ver'})) {
2347: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2348: $check5 = ' checked="checked"';
1.591 raeburn 2349: $check4 = '';
2350: } else {
1.772 bisitz 2351: $check4 = ' checked="checked"';
1.591 raeburn 2352: $check5 = '';
2353: }
1.586 raeburn 2354: }
1.591 raeburn 2355: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2356: $krbarg = $in{'curr_autharg'};
2357: }
1.586 raeburn 2358: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2359: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2360: $result =
2361: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2362: $in{'curr_autharg'},$krbver);
2363: } else {
2364: $result =
2365: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2366: }
2367: return $result;
2368: }
2369: }
2370: } else {
2371: if ($authnum == 1) {
1.784 bisitz 2372: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2373: }
2374: }
1.586 raeburn 2375: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2376: return;
1.587 raeburn 2377: } elsif ($authtype eq '') {
1.591 raeburn 2378: if (defined($in{'mode'})) {
1.587 raeburn 2379: if ($in{'mode'} eq 'modifycourse') {
2380: if ($authnum == 1) {
1.784 bisitz 2381: $authtype = '<input type="hidden" name="login" value="krb" />';
1.587 raeburn 2382: }
2383: }
2384: }
1.586 raeburn 2385: }
2386: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2387: if ($authtype eq '') {
2388: $authtype = '<input type="radio" name="login" value="krb" '.
2389: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2390: $krbcheck.' />';
2391: }
2392: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2393: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2394: $in{'curr_authtype'} eq 'krb5') ||
2395: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2396: $in{'curr_authtype'} eq 'krb4')) {
2397: $result .= &mt
1.144 matthew 2398: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2399: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2400: '<label>'.$authtype,
1.281 albertel 2401: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2402: 'value="'.$krbarg.'" '.
1.144 matthew 2403: 'onchange="'.$jscall.'" />',
1.281 albertel 2404: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2405: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2406: '</label>');
1.586 raeburn 2407: } elsif ($can_assign{'krb4'}) {
2408: $result .= &mt
2409: ('[_1] Kerberos authenticated with domain [_2] '.
2410: '[_3] Version 4 [_4]',
2411: '<label>'.$authtype,
2412: '</label><input type="text" size="10" name="krbarg" '.
2413: 'value="'.$krbarg.'" '.
2414: 'onchange="'.$jscall.'" />',
2415: '<label><input type="hidden" name="krbver" value="4" />',
2416: '</label>');
2417: } elsif ($can_assign{'krb5'}) {
2418: $result .= &mt
2419: ('[_1] Kerberos authenticated with domain [_2] '.
2420: '[_3] Version 5 [_4]',
2421: '<label>'.$authtype,
2422: '</label><input type="text" size="10" name="krbarg" '.
2423: 'value="'.$krbarg.'" '.
2424: 'onchange="'.$jscall.'" />',
2425: '<label><input type="hidden" name="krbver" value="5" />',
2426: '</label>');
2427: }
1.32 matthew 2428: return $result;
2429: }
2430:
2431: sub authform_internal{
1.586 raeburn 2432: my %in = (
1.32 matthew 2433: formname => 'document.cu',
2434: kerb_def_dom => 'MSU.EDU',
2435: @_,
2436: );
1.586 raeburn 2437: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2438: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2439: if (defined($in{'curr_authtype'})) {
2440: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2441: if ($can_assign{'int'}) {
1.772 bisitz 2442: $intcheck = 'checked="checked" ';
1.623 raeburn 2443: if (defined($in{'mode'})) {
2444: if ($in{'mode'} eq 'modifyuser') {
2445: $intcheck = '';
2446: }
2447: }
1.591 raeburn 2448: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2449: $intarg = $in{'curr_autharg'};
2450: }
2451: } else {
2452: $result = &mt('Currently internally authenticated.');
2453: return $result;
1.165 raeburn 2454: }
2455: }
1.586 raeburn 2456: } else {
2457: if ($authnum == 1) {
1.784 bisitz 2458: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 2459: }
2460: }
2461: if (!$can_assign{'int'}) {
2462: return;
1.587 raeburn 2463: } elsif ($authtype eq '') {
1.591 raeburn 2464: if (defined($in{'mode'})) {
1.587 raeburn 2465: if ($in{'mode'} eq 'modifycourse') {
2466: if ($authnum == 1) {
1.784 bisitz 2467: $authtype = '<input type="hidden" name="login" value="int" />';
1.587 raeburn 2468: }
2469: }
2470: }
1.165 raeburn 2471: }
1.586 raeburn 2472: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2473: if ($authtype eq '') {
2474: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2475: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2476: }
1.605 bisitz 2477: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2478: $intarg.'" onchange="'.$jscall.'" />';
2479: $result = &mt
1.144 matthew 2480: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2481: '<label>'.$authtype,'</label>'.$autharg);
1.824 bisitz 2482: $result.="<label><input type=\"checkbox\" name=\"visible\" onclick='if (this.checked) { this.form.intarg.type=\"text\" } else { this.form.intarg.type=\"password\" }' />".&mt('Visible input').'</label>';
1.32 matthew 2483: return $result;
2484: }
2485:
2486: sub authform_local{
2487: my %in = (
2488: formname => 'document.cu',
2489: kerb_def_dom => 'MSU.EDU',
2490: @_,
2491: );
1.586 raeburn 2492: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2493: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2494: if (defined($in{'curr_authtype'})) {
2495: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2496: if ($can_assign{'loc'}) {
1.772 bisitz 2497: $loccheck = 'checked="checked" ';
1.623 raeburn 2498: if (defined($in{'mode'})) {
2499: if ($in{'mode'} eq 'modifyuser') {
2500: $loccheck = '';
2501: }
2502: }
1.591 raeburn 2503: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2504: $locarg = $in{'curr_autharg'};
2505: }
2506: } else {
2507: $result = &mt('Currently using local (institutional) authentication.');
2508: return $result;
1.165 raeburn 2509: }
2510: }
1.586 raeburn 2511: } else {
2512: if ($authnum == 1) {
1.784 bisitz 2513: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 2514: }
2515: }
2516: if (!$can_assign{'loc'}) {
2517: return;
1.587 raeburn 2518: } elsif ($authtype eq '') {
1.591 raeburn 2519: if (defined($in{'mode'})) {
1.587 raeburn 2520: if ($in{'mode'} eq 'modifycourse') {
2521: if ($authnum == 1) {
1.784 bisitz 2522: $authtype = '<input type="hidden" name="login" value="loc" />';
1.587 raeburn 2523: }
2524: }
2525: }
1.165 raeburn 2526: }
1.586 raeburn 2527: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2528: if ($authtype eq '') {
2529: $authtype = '<input type="radio" name="login" value="loc" '.
2530: $loccheck.' onchange="'.$jscall.'" onclick="'.
2531: $jscall.'" />';
2532: }
2533: $autharg = '<input type="text" size="10" name="locarg" value="'.
2534: $locarg.'" onchange="'.$jscall.'" />';
2535: $result = &mt('[_1] Local Authentication with argument [_2]',
2536: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2537: return $result;
2538: }
2539:
2540: sub authform_filesystem{
2541: my %in = (
2542: formname => 'document.cu',
2543: kerb_def_dom => 'MSU.EDU',
2544: @_,
2545: );
1.586 raeburn 2546: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2547: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2548: if (defined($in{'curr_authtype'})) {
2549: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2550: if ($can_assign{'fsys'}) {
1.772 bisitz 2551: $fsyscheck = 'checked="checked" ';
1.623 raeburn 2552: if (defined($in{'mode'})) {
2553: if ($in{'mode'} eq 'modifyuser') {
2554: $fsyscheck = '';
2555: }
2556: }
1.586 raeburn 2557: } else {
2558: $result = &mt('Currently Filesystem Authenticated.');
2559: return $result;
2560: }
2561: }
2562: } else {
2563: if ($authnum == 1) {
1.784 bisitz 2564: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 2565: }
2566: }
2567: if (!$can_assign{'fsys'}) {
2568: return;
1.587 raeburn 2569: } elsif ($authtype eq '') {
1.591 raeburn 2570: if (defined($in{'mode'})) {
1.587 raeburn 2571: if ($in{'mode'} eq 'modifycourse') {
2572: if ($authnum == 1) {
1.784 bisitz 2573: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587 raeburn 2574: }
2575: }
2576: }
1.586 raeburn 2577: }
2578: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2579: if ($authtype eq '') {
2580: $authtype = '<input type="radio" name="login" value="fsys" '.
2581: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2582: $jscall.'" />';
2583: }
2584: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2585: ' onchange="'.$jscall.'" />';
2586: $result = &mt
1.144 matthew 2587: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2588: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2589: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2590: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2591: 'onchange="'.$jscall.'" />');
1.32 matthew 2592: return $result;
2593: }
2594:
1.586 raeburn 2595: sub get_assignable_auth {
2596: my ($dom) = @_;
2597: if ($dom eq '') {
2598: $dom = $env{'request.role.domain'};
2599: }
2600: my %can_assign = (
2601: krb4 => 1,
2602: krb5 => 1,
2603: int => 1,
2604: loc => 1,
2605: );
2606: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2607: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2608: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2609: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2610: my $context;
2611: if ($env{'request.role'} =~ /^au/) {
2612: $context = 'author';
2613: } elsif ($env{'request.role'} =~ /^dc/) {
2614: $context = 'domain';
2615: } elsif ($env{'request.course.id'}) {
2616: $context = 'course';
2617: }
2618: if ($context) {
2619: if (ref($authhash->{$context}) eq 'HASH') {
2620: %can_assign = %{$authhash->{$context}};
2621: }
2622: }
2623: }
2624: }
2625: my $authnum = 0;
2626: foreach my $key (keys(%can_assign)) {
2627: if ($can_assign{$key}) {
2628: $authnum ++;
2629: }
2630: }
2631: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2632: $authnum --;
2633: }
2634: return ($authnum,%can_assign);
2635: }
2636:
1.80 albertel 2637: ###############################################################
2638: ## Get Kerberos Defaults for Domain ##
2639: ###############################################################
2640: ##
2641: ## Returns default kerberos version and an associated argument
2642: ## as listed in file domain.tab. If not listed, provides
2643: ## appropriate default domain and kerberos version.
2644: ##
2645: #-------------------------------------------
2646:
2647: =pod
2648:
1.648 raeburn 2649: =item * &get_kerberos_defaults()
1.80 albertel 2650:
2651: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2652: version and domain. If not found, it defaults to version 4 and the
2653: domain of the server.
1.80 albertel 2654:
1.648 raeburn 2655: =over 4
2656:
1.80 albertel 2657: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2658:
1.648 raeburn 2659: =back
2660:
2661: =back
2662:
1.80 albertel 2663: =cut
2664:
2665: #-------------------------------------------
2666: sub get_kerberos_defaults {
2667: my $domain=shift;
1.641 raeburn 2668: my ($krbdef,$krbdefdom);
2669: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2670: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2671: $krbdef = $domdefaults{'auth_def'};
2672: $krbdefdom = $domdefaults{'auth_arg_def'};
2673: } else {
1.80 albertel 2674: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2675: my $krbdefdom=$1;
2676: $krbdefdom=~tr/a-z/A-Z/;
2677: $krbdef = "krb4";
2678: }
2679: return ($krbdef,$krbdefdom);
2680: }
1.112 bowersj2 2681:
1.32 matthew 2682:
1.46 matthew 2683: ###############################################################
2684: ## Thesaurus Functions ##
2685: ###############################################################
1.20 www 2686:
1.46 matthew 2687: =pod
1.20 www 2688:
1.112 bowersj2 2689: =head1 Thesaurus Functions
2690:
2691: =over 4
2692:
1.648 raeburn 2693: =item * &initialize_keywords()
1.46 matthew 2694:
2695: Initializes the package variable %Keywords if it is empty. Uses the
2696: package variable $thesaurus_db_file.
2697:
2698: =cut
2699:
2700: ###################################################
2701:
2702: sub initialize_keywords {
2703: return 1 if (scalar keys(%Keywords));
2704: # If we are here, %Keywords is empty, so fill it up
2705: # Make sure the file we need exists...
2706: if (! -e $thesaurus_db_file) {
2707: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2708: " failed because it does not exist");
2709: return 0;
2710: }
2711: # Set up the hash as a database
2712: my %thesaurus_db;
2713: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2714: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2715: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2716: $thesaurus_db_file);
2717: return 0;
2718: }
2719: # Get the average number of appearances of a word.
2720: my $avecount = $thesaurus_db{'average.count'};
2721: # Put keywords (those that appear > average) into %Keywords
2722: while (my ($word,$data)=each (%thesaurus_db)) {
2723: my ($count,undef) = split /:/,$data;
2724: $Keywords{$word}++ if ($count > $avecount);
2725: }
2726: untie %thesaurus_db;
2727: # Remove special values from %Keywords.
1.356 albertel 2728: foreach my $value ('total.count','average.count') {
2729: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2730: }
1.46 matthew 2731: return 1;
2732: }
2733:
2734: ###################################################
2735:
2736: =pod
2737:
1.648 raeburn 2738: =item * &keyword($word)
1.46 matthew 2739:
2740: Returns true if $word is a keyword. A keyword is a word that appears more
2741: than the average number of times in the thesaurus database. Calls
2742: &initialize_keywords
2743:
2744: =cut
2745:
2746: ###################################################
1.20 www 2747:
2748: sub keyword {
1.46 matthew 2749: return if (!&initialize_keywords());
2750: my $word=lc(shift());
2751: $word=~s/\W//g;
2752: return exists($Keywords{$word});
1.20 www 2753: }
1.46 matthew 2754:
2755: ###############################################################
2756:
2757: =pod
1.20 www 2758:
1.648 raeburn 2759: =item * &get_related_words()
1.46 matthew 2760:
1.160 matthew 2761: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2762: an array of words. If the keyword is not in the thesaurus, an empty array
2763: will be returned. The order of the words returned is determined by the
2764: database which holds them.
2765:
2766: Uses global $thesaurus_db_file.
2767:
2768: =cut
2769:
2770: ###############################################################
2771: sub get_related_words {
2772: my $keyword = shift;
2773: my %thesaurus_db;
2774: if (! -e $thesaurus_db_file) {
2775: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2776: "failed because the file does not exist");
2777: return ();
2778: }
2779: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2780: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2781: return ();
2782: }
2783: my @Words=();
1.429 www 2784: my $count=0;
1.46 matthew 2785: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2786: # The first element is the number of times
2787: # the word appears. We do not need it now.
1.429 www 2788: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2789: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2790: my $threshold=$mostfrequentcount/10;
2791: foreach my $possibleword (@RelatedWords) {
2792: my ($word,$wordcount)=split(/\,/,$possibleword);
2793: if ($wordcount>$threshold) {
2794: push(@Words,$word);
2795: $count++;
2796: if ($count>10) { last; }
2797: }
1.20 www 2798: }
2799: }
1.46 matthew 2800: untie %thesaurus_db;
2801: return @Words;
1.14 harris41 2802: }
1.46 matthew 2803:
1.112 bowersj2 2804: =pod
2805:
2806: =back
2807:
2808: =cut
1.61 www 2809:
2810: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2811: =pod
2812:
1.112 bowersj2 2813: =head1 User Name Functions
2814:
2815: =over 4
2816:
1.648 raeburn 2817: =item * &plainname($uname,$udom,$first)
1.81 albertel 2818:
1.112 bowersj2 2819: Takes a users logon name and returns it as a string in
1.226 albertel 2820: "first middle last generation" form
2821: if $first is set to 'lastname' then it returns it as
2822: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2823:
2824: =cut
1.61 www 2825:
1.295 www 2826:
1.81 albertel 2827: ###############################################################
1.61 www 2828: sub plainname {
1.226 albertel 2829: my ($uname,$udom,$first)=@_;
1.537 albertel 2830: return if (!defined($uname) || !defined($udom));
1.295 www 2831: my %names=&getnames($uname,$udom);
1.226 albertel 2832: my $name=&Apache::lonnet::format_name($names{'firstname'},
2833: $names{'middlename'},
2834: $names{'lastname'},
2835: $names{'generation'},$first);
2836: $name=~s/^\s+//;
1.62 www 2837: $name=~s/\s+$//;
2838: $name=~s/\s+/ /g;
1.353 albertel 2839: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2840: return $name;
1.61 www 2841: }
1.66 www 2842:
2843: # -------------------------------------------------------------------- Nickname
1.81 albertel 2844: =pod
2845:
1.648 raeburn 2846: =item * &nickname($uname,$udom)
1.81 albertel 2847:
2848: Gets a users name and returns it as a string as
2849:
2850: ""nickname""
1.66 www 2851:
1.81 albertel 2852: if the user has a nickname or
2853:
2854: "first middle last generation"
2855:
2856: if the user does not
2857:
2858: =cut
1.66 www 2859:
2860: sub nickname {
2861: my ($uname,$udom)=@_;
1.537 albertel 2862: return if (!defined($uname) || !defined($udom));
1.295 www 2863: my %names=&getnames($uname,$udom);
1.68 albertel 2864: my $name=$names{'nickname'};
1.66 www 2865: if ($name) {
2866: $name='"'.$name.'"';
2867: } else {
2868: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2869: $names{'lastname'}.' '.$names{'generation'};
2870: $name=~s/\s+$//;
2871: $name=~s/\s+/ /g;
2872: }
2873: return $name;
2874: }
2875:
1.295 www 2876: sub getnames {
2877: my ($uname,$udom)=@_;
1.537 albertel 2878: return if (!defined($uname) || !defined($udom));
1.433 albertel 2879: if ($udom eq 'public' && $uname eq 'public') {
2880: return ('lastname' => &mt('Public'));
2881: }
1.295 www 2882: my $id=$uname.':'.$udom;
2883: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2884: if ($cached) {
2885: return %{$names};
2886: } else {
2887: my %loadnames=&Apache::lonnet::get('environment',
2888: ['firstname','middlename','lastname','generation','nickname'],
2889: $udom,$uname);
2890: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2891: return %loadnames;
2892: }
2893: }
1.61 www 2894:
1.542 raeburn 2895: # -------------------------------------------------------------------- getemails
1.648 raeburn 2896:
1.542 raeburn 2897: =pod
2898:
1.648 raeburn 2899: =item * &getemails($uname,$udom)
1.542 raeburn 2900:
2901: Gets a user's email information and returns it as a hash with keys:
2902: notification, critnotification, permanentemail
2903:
2904: For notification and critnotification, values are comma-separated lists
1.648 raeburn 2905: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 2906:
1.648 raeburn 2907:
1.542 raeburn 2908: =cut
2909:
1.648 raeburn 2910:
1.466 albertel 2911: sub getemails {
2912: my ($uname,$udom)=@_;
2913: if ($udom eq 'public' && $uname eq 'public') {
2914: return;
2915: }
1.467 www 2916: if (!$udom) { $udom=$env{'user.domain'}; }
2917: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 2918: my $id=$uname.':'.$udom;
2919: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2920: if ($cached) {
2921: return %{$names};
2922: } else {
2923: my %loadnames=&Apache::lonnet::get('environment',
2924: ['notification','critnotification',
2925: 'permanentemail'],
2926: $udom,$uname);
2927: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2928: return %loadnames;
2929: }
2930: }
2931:
1.551 albertel 2932: sub flush_email_cache {
2933: my ($uname,$udom)=@_;
2934: if (!$udom) { $udom =$env{'user.domain'}; }
2935: if (!$uname) { $uname=$env{'user.name'}; }
2936: return if ($udom eq 'public' && $uname eq 'public');
2937: my $id=$uname.':'.$udom;
2938: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2939: }
2940:
1.728 raeburn 2941: # -------------------------------------------------------------------- getlangs
2942:
2943: =pod
2944:
2945: =item * &getlangs($uname,$udom)
2946:
2947: Gets a user's language preference and returns it as a hash with key:
2948: language.
2949:
2950: =cut
2951:
2952:
2953: sub getlangs {
2954: my ($uname,$udom) = @_;
2955: if (!$udom) { $udom =$env{'user.domain'}; }
2956: if (!$uname) { $uname=$env{'user.name'}; }
2957: my $id=$uname.':'.$udom;
2958: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
2959: if ($cached) {
2960: return %{$langs};
2961: } else {
2962: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
2963: $udom,$uname);
2964: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
2965: return %loadlangs;
2966: }
2967: }
2968:
2969: sub flush_langs_cache {
2970: my ($uname,$udom)=@_;
2971: if (!$udom) { $udom =$env{'user.domain'}; }
2972: if (!$uname) { $uname=$env{'user.name'}; }
2973: return if ($udom eq 'public' && $uname eq 'public');
2974: my $id=$uname.':'.$udom;
2975: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
2976: }
2977:
1.61 www 2978: # ------------------------------------------------------------------ Screenname
1.81 albertel 2979:
2980: =pod
2981:
1.648 raeburn 2982: =item * &screenname($uname,$udom)
1.81 albertel 2983:
2984: Gets a users screenname and returns it as a string
2985:
2986: =cut
1.61 www 2987:
2988: sub screenname {
2989: my ($uname,$udom)=@_;
1.258 albertel 2990: if ($uname eq $env{'user.name'} &&
2991: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 2992: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 2993: return $names{'screenname'};
1.62 www 2994: }
2995:
1.212 albertel 2996:
1.802 bisitz 2997: # ------------------------------------------------------------- Confirm Wrapper
2998: =pod
2999:
3000: =item confirmwrapper
3001:
3002: Wrap messages about completion of operation in box
3003:
3004: =cut
3005:
3006: sub confirmwrapper {
3007: my ($message)=@_;
3008: if ($message) {
3009: return "\n".'<div class="LC_confirm_box">'."\n"
3010: .$message."\n"
3011: .'</div>'."\n";
3012: } else {
3013: return $message;
3014: }
3015: }
3016:
1.62 www 3017: # ------------------------------------------------------------- Message Wrapper
3018:
3019: sub messagewrapper {
1.369 www 3020: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 3021: return
1.441 albertel 3022: '<a href="/adm/email?compose=individual&'.
3023: 'recname='.$username.'&recdom='.$domain.
3024: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 3025: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 3026: }
1.802 bisitz 3027:
1.74 www 3028: # --------------------------------------------------------------- Notes Wrapper
3029:
3030: sub noteswrapper {
3031: my ($link,$un,$do)=@_;
3032: return
1.896 amueller 3033: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 3034: }
1.802 bisitz 3035:
1.62 www 3036: # ------------------------------------------------------------- Aboutme Wrapper
3037:
3038: sub aboutmewrapper {
1.166 www 3039: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 3040: if (!defined($username) && !defined($domain)) {
3041: return;
3042: }
1.892 amueller 3043: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.756 weissno 3044: ($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 3045: }
3046:
3047: # ------------------------------------------------------------ Syllabus Wrapper
3048:
3049: sub syllabuswrapper {
1.707 bisitz 3050: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 3051: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 3052: }
1.14 harris41 3053:
1.802 bisitz 3054: # -----------------------------------------------------------------------------
3055:
1.208 matthew 3056: sub track_student_link {
1.887 raeburn 3057: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 3058: my $link ="/adm/trackstudent?";
1.208 matthew 3059: my $title = 'View recent activity';
3060: if (defined($sname) && $sname !~ /^\s*$/ &&
3061: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 3062: $link .= "selected_student=$sname:$sdom";
1.208 matthew 3063: $title .= ' of this student';
1.268 albertel 3064: }
1.208 matthew 3065: if (defined($target) && $target !~ /^\s*$/) {
3066: $target = qq{target="$target"};
3067: } else {
3068: $target = '';
3069: }
1.268 albertel 3070: if ($start) { $link.='&start='.$start; }
1.887 raeburn 3071: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 3072: $title = &mt($title);
3073: $linktext = &mt($linktext);
1.448 albertel 3074: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
3075: &help_open_topic('View_recent_activity');
1.208 matthew 3076: }
3077:
1.781 raeburn 3078: sub slot_reservations_link {
3079: my ($linktext,$sname,$sdom,$target) = @_;
3080: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
3081: my $title = 'View slot reservation history';
3082: if (defined($sname) && $sname !~ /^\s*$/ &&
3083: defined($sdom) && $sdom !~ /^\s*$/) {
3084: $link .= "&uname=$sname&udom=$sdom";
3085: $title .= ' of this student';
3086: }
3087: if (defined($target) && $target !~ /^\s*$/) {
3088: $target = qq{target="$target"};
3089: } else {
3090: $target = '';
3091: }
3092: $title = &mt($title);
3093: $linktext = &mt($linktext);
3094: return qq{<a href="$link" title="$title" $target>$linktext</a>};
3095: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
3096:
3097: }
3098:
1.508 www 3099: # ===================================================== Display a student photo
3100:
3101:
1.509 albertel 3102: sub student_image_tag {
1.508 www 3103: my ($domain,$user)=@_;
3104: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
3105: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
3106: return '<img src="'.$imgsrc.'" align="right" />';
3107: } else {
3108: return '';
3109: }
3110: }
3111:
1.112 bowersj2 3112: =pod
3113:
3114: =back
3115:
3116: =head1 Access .tab File Data
3117:
3118: =over 4
3119:
1.648 raeburn 3120: =item * &languageids()
1.112 bowersj2 3121:
3122: returns list of all language ids
3123:
3124: =cut
3125:
1.14 harris41 3126: sub languageids {
1.16 harris41 3127: return sort(keys(%language));
1.14 harris41 3128: }
3129:
1.112 bowersj2 3130: =pod
3131:
1.648 raeburn 3132: =item * &languagedescription()
1.112 bowersj2 3133:
3134: returns description of a specified language id
3135:
3136: =cut
3137:
1.14 harris41 3138: sub languagedescription {
1.125 www 3139: my $code=shift;
3140: return ($supported_language{$code}?'* ':'').
3141: $language{$code}.
1.126 www 3142: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 3143: }
3144:
3145: sub plainlanguagedescription {
3146: my $code=shift;
3147: return $language{$code};
3148: }
3149:
3150: sub supportedlanguagecode {
3151: my $code=shift;
3152: return $supported_language{$code};
1.97 www 3153: }
3154:
1.112 bowersj2 3155: =pod
3156:
1.648 raeburn 3157: =item * ©rightids()
1.112 bowersj2 3158:
3159: returns list of all copyrights
3160:
3161: =cut
3162:
3163: sub copyrightids {
3164: return sort(keys(%cprtag));
3165: }
3166:
3167: =pod
3168:
1.648 raeburn 3169: =item * ©rightdescription()
1.112 bowersj2 3170:
3171: returns description of a specified copyright id
3172:
3173: =cut
3174:
3175: sub copyrightdescription {
1.166 www 3176: return &mt($cprtag{shift(@_)});
1.112 bowersj2 3177: }
1.197 matthew 3178:
3179: =pod
3180:
1.648 raeburn 3181: =item * &source_copyrightids()
1.192 taceyjo1 3182:
3183: returns list of all source copyrights
3184:
3185: =cut
3186:
3187: sub source_copyrightids {
3188: return sort(keys(%scprtag));
3189: }
3190:
3191: =pod
3192:
1.648 raeburn 3193: =item * &source_copyrightdescription()
1.192 taceyjo1 3194:
3195: returns description of a specified source copyright id
3196:
3197: =cut
3198:
3199: sub source_copyrightdescription {
3200: return &mt($scprtag{shift(@_)});
3201: }
1.112 bowersj2 3202:
3203: =pod
3204:
1.648 raeburn 3205: =item * &filecategories()
1.112 bowersj2 3206:
3207: returns list of all file categories
3208:
3209: =cut
3210:
3211: sub filecategories {
3212: return sort(keys(%category_extensions));
3213: }
3214:
3215: =pod
3216:
1.648 raeburn 3217: =item * &filecategorytypes()
1.112 bowersj2 3218:
3219: returns list of file types belonging to a given file
3220: category
3221:
3222: =cut
3223:
3224: sub filecategorytypes {
1.356 albertel 3225: my ($cat) = @_;
3226: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 3227: }
3228:
3229: =pod
3230:
1.648 raeburn 3231: =item * &fileembstyle()
1.112 bowersj2 3232:
3233: returns embedding style for a specified file type
3234:
3235: =cut
3236:
3237: sub fileembstyle {
3238: return $fe{lc(shift(@_))};
1.169 www 3239: }
3240:
1.351 www 3241: sub filemimetype {
3242: return $fm{lc(shift(@_))};
3243: }
3244:
1.169 www 3245:
3246: sub filecategoryselect {
3247: my ($name,$value)=@_;
1.189 matthew 3248: return &select_form($value,$name,
1.169 www 3249: '' => &mt('Any category'),
3250: map { $_,$_ } sort(keys(%category_extensions)));
1.112 bowersj2 3251: }
3252:
3253: =pod
3254:
1.648 raeburn 3255: =item * &filedescription()
1.112 bowersj2 3256:
3257: returns description for a specified file type
3258:
3259: =cut
3260:
3261: sub filedescription {
1.188 matthew 3262: my $file_description = $fd{lc(shift())};
3263: $file_description =~ s:([\[\]]):~$1:g;
3264: return &mt($file_description);
1.112 bowersj2 3265: }
3266:
3267: =pod
3268:
1.648 raeburn 3269: =item * &filedescriptionex()
1.112 bowersj2 3270:
3271: returns description for a specified file type with
3272: extra formatting
3273:
3274: =cut
3275:
3276: sub filedescriptionex {
3277: my $ex=shift;
1.188 matthew 3278: my $file_description = $fd{lc($ex)};
3279: $file_description =~ s:([\[\]]):~$1:g;
3280: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3281: }
3282:
3283: # End of .tab access
3284: =pod
3285:
3286: =back
3287:
3288: =cut
3289:
3290: # ------------------------------------------------------------------ File Types
3291: sub fileextensions {
3292: return sort(keys(%fe));
3293: }
3294:
1.97 www 3295: # ----------------------------------------------------------- Display Languages
3296: # returns a hash with all desired display languages
3297: #
3298:
3299: sub display_languages {
3300: my %languages=();
1.695 raeburn 3301: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3302: $languages{$lang}=1;
1.97 www 3303: }
3304: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3305: if ($env{'form.displaylanguage'}) {
1.356 albertel 3306: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3307: $languages{$lang}=1;
1.97 www 3308: }
3309: }
3310: return %languages;
1.14 harris41 3311: }
3312:
1.582 albertel 3313: sub languages {
3314: my ($possible_langs) = @_;
1.695 raeburn 3315: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3316: if (!ref($possible_langs)) {
3317: if( wantarray ) {
3318: return @preferred_langs;
3319: } else {
3320: return $preferred_langs[0];
3321: }
3322: }
3323: my %possibilities = map { $_ => 1 } (@$possible_langs);
3324: my @preferred_possibilities;
3325: foreach my $preferred_lang (@preferred_langs) {
3326: if (exists($possibilities{$preferred_lang})) {
3327: push(@preferred_possibilities, $preferred_lang);
3328: }
3329: }
3330: if( wantarray ) {
3331: return @preferred_possibilities;
3332: }
3333: return $preferred_possibilities[0];
3334: }
3335:
1.742 raeburn 3336: sub user_lang {
3337: my ($touname,$toudom,$fromcid) = @_;
3338: my @userlangs;
3339: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3340: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3341: $env{'course.'.$fromcid.'.languages'}));
3342: } else {
3343: my %langhash = &getlangs($touname,$toudom);
3344: if ($langhash{'languages'} ne '') {
3345: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3346: } else {
3347: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3348: if ($domdefs{'lang_def'} ne '') {
3349: @userlangs = ($domdefs{'lang_def'});
3350: }
3351: }
3352: }
3353: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3354: my $user_lh = Apache::localize->get_handle(@languages);
3355: return $user_lh;
3356: }
3357:
3358:
1.112 bowersj2 3359: ###############################################################
3360: ## Student Answer Attempts ##
3361: ###############################################################
3362:
3363: =pod
3364:
3365: =head1 Alternate Problem Views
3366:
3367: =over 4
3368:
1.648 raeburn 3369: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3370: $getattempt, $regexp, $gradesub)
3371:
3372: Return string with previous attempt on problem. Arguments:
3373:
3374: =over 4
3375:
3376: =item * $symb: Problem, including path
3377:
3378: =item * $username: username of the desired student
3379:
3380: =item * $domain: domain of the desired student
1.14 harris41 3381:
1.112 bowersj2 3382: =item * $course: Course ID
1.14 harris41 3383:
1.112 bowersj2 3384: =item * $getattempt: Leave blank for all attempts, otherwise put
3385: something
1.14 harris41 3386:
1.112 bowersj2 3387: =item * $regexp: if string matches this regexp, the string will be
3388: sent to $gradesub
1.14 harris41 3389:
1.112 bowersj2 3390: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3391:
1.112 bowersj2 3392: =back
1.14 harris41 3393:
1.112 bowersj2 3394: The output string is a table containing all desired attempts, if any.
1.16 harris41 3395:
1.112 bowersj2 3396: =cut
1.1 albertel 3397:
3398: sub get_previous_attempt {
1.43 ng 3399: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3400: my $prevattempts='';
1.43 ng 3401: no strict 'refs';
1.1 albertel 3402: if ($symb) {
1.3 albertel 3403: my (%returnhash)=
3404: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3405: if ($returnhash{'version'}) {
3406: my %lasthash=();
3407: my $version;
3408: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3409: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3410: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3411: }
1.1 albertel 3412: }
1.596 albertel 3413: $prevattempts=&start_data_table().&start_data_table_header_row();
3414: $prevattempts.='<th>'.&mt('History').'</th>';
1.945 raeburn 3415: my %typeparts;
3416: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 3417: foreach my $key (sort(keys(%lasthash))) {
3418: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3419: if ($#parts > 0) {
1.31 albertel 3420: my $data=$parts[-1];
3421: pop(@parts);
1.945 raeburn 3422: if ($data eq 'type') {
3423: unless ($showsurv) {
3424: my $id = join(',',@parts);
3425: $typeparts{$ign.'.'.$id} = $lasthash{$key};
3426: }
3427: delete($lasthash{$key});
3428: } else {
3429: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
3430: }
1.31 albertel 3431: } else {
1.41 ng 3432: if ($#parts == 0) {
3433: $prevattempts.='<th>'.$parts[0].'</th>';
3434: } else {
3435: $prevattempts.='<th>'.$ign.'</th>';
3436: }
1.31 albertel 3437: }
1.16 harris41 3438: }
1.596 albertel 3439: $prevattempts.=&end_data_table_header_row();
1.945 raeburn 3440: my %lasthidden;
1.40 ng 3441: if ($getattempt eq '') {
3442: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.945 raeburn 3443: my @hidden;
3444: if (%typeparts) {
3445: foreach my $id (keys(%typeparts)) {
3446: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
3447: push(@hidden,$id);
3448: $lasthidden{$id} = 1;
3449: } elsif ($lasthidden{$id}) {
3450: if (exists($returnhash{$version.':'.$id.'.award'})) {
3451: delete($lasthidden{$id});
3452: }
3453: }
3454: }
3455: }
3456: $prevattempts.=&start_data_table_row().
3457: '<td>'.&mt('Transaction [_1]',$version).'</td>';
3458: if (@hidden) {
3459: foreach my $key (sort(keys(%lasthash))) {
3460: my $hide;
3461: foreach my $id (@hidden) {
3462: if ($key =~ /^\Q$id\E/) {
3463: $hide = 1;
3464: last;
3465: }
3466: }
3467: if ($hide) {
3468: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3469: if (($data eq 'award') || ($data eq 'awarddetail')) {
3470: my $value = &format_previous_attempt_value($key,
3471: $returnhash{$version.':'.$key});
3472: $prevattempts.='<td>'.$value.' </td>';
3473: } else {
3474: $prevattempts.='<td> </td>';
3475: }
3476: } else {
3477: if ($key =~ /\./) {
3478: my $value = &format_previous_attempt_value($key,
3479: $returnhash{$version.':'.$key});
3480: $prevattempts.='<td>'.$value.' </td>';
3481: } else {
3482: $prevattempts.='<td> </td>';
3483: }
3484: }
3485: }
3486: } else {
3487: foreach my $key (sort(keys(%lasthash))) {
3488: my $value = &format_previous_attempt_value($key,
3489: $returnhash{$version.':'.$key});
3490: $prevattempts.='<td>'.$value.' </td>';
3491: }
3492: }
3493: $prevattempts.=&end_data_table_row();
1.40 ng 3494: }
1.1 albertel 3495: }
1.945 raeburn 3496: my @currhidden = keys(%lasthidden);
1.596 albertel 3497: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3498: foreach my $key (sort(keys(%lasthash))) {
1.945 raeburn 3499: if (%typeparts) {
3500: my $hidden;
3501: foreach my $id (@currhidden) {
3502: if ($key =~ /^\Q$id\E/) {
3503: $hidden = 1;
3504: last;
3505: }
3506: }
3507: if ($hidden) {
3508: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3509: if (($data eq 'award') || ($data eq 'awarddetail')) {
3510: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3511: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3512: $value = &$gradesub($value);
3513: }
3514: $prevattempts.='<td>'.$value.' </td>';
3515: } else {
3516: $prevattempts.='<td> </td>';
3517: }
3518: } else {
3519: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3520: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3521: $value = &$gradesub($value);
3522: }
3523: $prevattempts.='<td>'.$value.' </td>';
3524: }
3525: } else {
3526: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3527: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3528: $value = &$gradesub($value);
3529: }
3530: $prevattempts.='<td>'.$value.' </td>';
3531: }
1.16 harris41 3532: }
1.596 albertel 3533: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3534: } else {
1.596 albertel 3535: $prevattempts=
3536: &start_data_table().&start_data_table_row().
3537: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3538: &end_data_table_row().&end_data_table();
1.1 albertel 3539: }
3540: } else {
1.596 albertel 3541: $prevattempts=
3542: &start_data_table().&start_data_table_row().
3543: '<td>'.&mt('No data.').'</td>'.
3544: &end_data_table_row().&end_data_table();
1.1 albertel 3545: }
1.10 albertel 3546: }
3547:
1.581 albertel 3548: sub format_previous_attempt_value {
3549: my ($key,$value) = @_;
3550: if ($key =~ /timestamp/) {
3551: $value = &Apache::lonlocal::locallocaltime($value);
3552: } elsif (ref($value) eq 'ARRAY') {
3553: $value = '('.join(', ', @{ $value }).')';
3554: } else {
3555: $value = &unescape($value);
3556: }
3557: return $value;
3558: }
3559:
3560:
1.107 albertel 3561: sub relative_to_absolute {
3562: my ($url,$output)=@_;
3563: my $parser=HTML::TokeParser->new(\$output);
3564: my $token;
3565: my $thisdir=$url;
3566: my @rlinks=();
3567: while ($token=$parser->get_token) {
3568: if ($token->[0] eq 'S') {
3569: if ($token->[1] eq 'a') {
3570: if ($token->[2]->{'href'}) {
3571: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3572: }
3573: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3574: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3575: } elsif ($token->[1] eq 'base') {
3576: $thisdir=$token->[2]->{'href'};
3577: }
3578: }
3579: }
3580: $thisdir=~s-/[^/]*$--;
1.356 albertel 3581: foreach my $link (@rlinks) {
1.726 raeburn 3582: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3583: ($link=~/^\//) ||
3584: ($link=~/^javascript:/i) ||
3585: ($link=~/^mailto:/i) ||
3586: ($link=~/^\#/)) {
3587: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3588: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3589: }
3590: }
3591: # -------------------------------------------------- Deal with Applet codebases
3592: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3593: return $output;
3594: }
3595:
1.112 bowersj2 3596: =pod
3597:
1.648 raeburn 3598: =item * &get_student_view()
1.112 bowersj2 3599:
3600: show a snapshot of what student was looking at
3601:
3602: =cut
3603:
1.10 albertel 3604: sub get_student_view {
1.186 albertel 3605: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3606: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3607: my (%form);
1.10 albertel 3608: my @elements=('symb','courseid','domain','username');
3609: foreach my $element (@elements) {
1.186 albertel 3610: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3611: }
1.186 albertel 3612: if (defined($moreenv)) {
3613: %form=(%form,%{$moreenv});
3614: }
1.236 albertel 3615: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3616: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3617: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3618: $userview=~s/\<body[^\>]*\>//gi;
3619: $userview=~s/\<\/body\>//gi;
3620: $userview=~s/\<html\>//gi;
3621: $userview=~s/\<\/html\>//gi;
3622: $userview=~s/\<head\>//gi;
3623: $userview=~s/\<\/head\>//gi;
3624: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3625: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3626: if (wantarray) {
3627: return ($userview,$response);
3628: } else {
3629: return $userview;
3630: }
3631: }
3632:
3633: sub get_student_view_with_retries {
3634: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3635:
3636: my $ok = 0; # True if we got a good response.
3637: my $content;
3638: my $response;
3639:
3640: # Try to get the student_view done. within the retries count:
3641:
3642: do {
3643: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3644: $ok = $response->is_success;
3645: if (!$ok) {
3646: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3647: }
3648: $retries--;
3649: } while (!$ok && ($retries > 0));
3650:
3651: if (!$ok) {
3652: $content = ''; # On error return an empty content.
3653: }
1.651 www 3654: if (wantarray) {
3655: return ($content, $response);
3656: } else {
3657: return $content;
3658: }
1.11 albertel 3659: }
3660:
1.112 bowersj2 3661: =pod
3662:
1.648 raeburn 3663: =item * &get_student_answers()
1.112 bowersj2 3664:
3665: show a snapshot of how student was answering problem
3666:
3667: =cut
3668:
1.11 albertel 3669: sub get_student_answers {
1.100 sakharuk 3670: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3671: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3672: my (%moreenv);
1.11 albertel 3673: my @elements=('symb','courseid','domain','username');
3674: foreach my $element (@elements) {
1.186 albertel 3675: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3676: }
1.186 albertel 3677: $moreenv{'grade_target'}='answer';
3678: %moreenv=(%form,%moreenv);
1.497 raeburn 3679: $feedurl = &Apache::lonnet::clutter($feedurl);
3680: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3681: return $userview;
1.1 albertel 3682: }
1.116 albertel 3683:
3684: =pod
3685:
3686: =item * &submlink()
3687:
1.242 albertel 3688: Inputs: $text $uname $udom $symb $target
1.116 albertel 3689:
3690: Returns: A link to grades.pm such as to see the SUBM view of a student
3691:
3692: =cut
3693:
3694: ###############################################
3695: sub submlink {
1.242 albertel 3696: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3697: if (!($uname && $udom)) {
3698: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3699: &Apache::lonnet::whichuser($symb);
1.116 albertel 3700: if (!$symb) { $symb=$cursymb; }
3701: }
1.254 matthew 3702: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3703: $symb=&escape($symb);
1.242 albertel 3704: if ($target) { $target="target=\"$target\""; }
3705: return '<a href="/adm/grades?&command=submission&'.
3706: 'symb='.$symb.'&student='.$uname.
3707: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
3708: }
3709: ##############################################
3710:
3711: =pod
3712:
3713: =item * &pgrdlink()
3714:
3715: Inputs: $text $uname $udom $symb $target
3716:
3717: Returns: A link to grades.pm such as to see the PGRD view of a student
3718:
3719: =cut
3720:
3721: ###############################################
3722: sub pgrdlink {
3723: my $link=&submlink(@_);
3724: $link=~s/(&command=submission)/$1&showgrading=yes/;
3725: return $link;
3726: }
3727: ##############################################
3728:
3729: =pod
3730:
3731: =item * &pprmlink()
3732:
3733: Inputs: $text $uname $udom $symb $target
3734:
3735: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3736: student and a specific resource
1.242 albertel 3737:
3738: =cut
3739:
3740: ###############################################
3741: sub pprmlink {
3742: my ($text,$uname,$udom,$symb,$target)=@_;
3743: if (!($uname && $udom)) {
3744: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3745: &Apache::lonnet::whichuser($symb);
1.242 albertel 3746: if (!$symb) { $symb=$cursymb; }
3747: }
1.254 matthew 3748: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3749: $symb=&escape($symb);
1.242 albertel 3750: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3751: return '<a href="/adm/parmset?command=set&'.
3752: 'symb='.$symb.'&uname='.$uname.
3753: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3754: }
3755: ##############################################
1.37 matthew 3756:
1.112 bowersj2 3757: =pod
3758:
3759: =back
3760:
3761: =cut
3762:
1.37 matthew 3763: ###############################################
1.51 www 3764:
3765:
3766: sub timehash {
1.687 raeburn 3767: my ($thistime) = @_;
3768: my $timezone = &Apache::lonlocal::gettimezone();
3769: my $dt = DateTime->from_epoch(epoch => $thistime)
3770: ->set_time_zone($timezone);
3771: my $wday = $dt->day_of_week();
3772: if ($wday == 7) { $wday = 0; }
3773: return ( 'second' => $dt->second(),
3774: 'minute' => $dt->minute(),
3775: 'hour' => $dt->hour(),
3776: 'day' => $dt->day_of_month(),
3777: 'month' => $dt->month(),
3778: 'year' => $dt->year(),
3779: 'weekday' => $wday,
3780: 'dayyear' => $dt->day_of_year(),
3781: 'dlsav' => $dt->is_dst() );
1.51 www 3782: }
3783:
1.370 www 3784: sub utc_string {
3785: my ($date)=@_;
1.371 www 3786: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3787: }
3788:
1.51 www 3789: sub maketime {
3790: my %th=@_;
1.687 raeburn 3791: my ($epoch_time,$timezone,$dt);
3792: $timezone = &Apache::lonlocal::gettimezone();
3793: eval {
3794: $dt = DateTime->new( year => $th{'year'},
3795: month => $th{'month'},
3796: day => $th{'day'},
3797: hour => $th{'hour'},
3798: minute => $th{'minute'},
3799: second => $th{'second'},
3800: time_zone => $timezone,
3801: );
3802: };
3803: if (!$@) {
3804: $epoch_time = $dt->epoch;
3805: if ($epoch_time) {
3806: return $epoch_time;
3807: }
3808: }
1.51 www 3809: return POSIX::mktime(
3810: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3811: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3812: }
3813:
3814: #########################################
1.51 www 3815:
3816: sub findallcourses {
1.482 raeburn 3817: my ($roles,$uname,$udom) = @_;
1.355 albertel 3818: my %roles;
3819: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3820: my %courses;
1.51 www 3821: my $now=time;
1.482 raeburn 3822: if (!defined($uname)) {
3823: $uname = $env{'user.name'};
3824: }
3825: if (!defined($udom)) {
3826: $udom = $env{'user.domain'};
3827: }
3828: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
3829: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
3830: if (!%roles) {
3831: %roles = (
3832: cc => 1,
1.907 raeburn 3833: co => 1,
1.482 raeburn 3834: in => 1,
3835: ep => 1,
3836: ta => 1,
3837: cr => 1,
3838: st => 1,
3839: );
3840: }
3841: foreach my $entry (keys(%roleshash)) {
3842: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3843: if ($trole =~ /^cr/) {
3844: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3845: } else {
3846: next if (!exists($roles{$trole}));
3847: }
3848: if ($tend) {
3849: next if ($tend < $now);
3850: }
3851: if ($tstart) {
3852: next if ($tstart > $now);
3853: }
3854: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3855: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3856: if ($secpart eq '') {
3857: ($cnum,$role) = split(/_/,$cnumpart);
3858: $sec = 'none';
3859: $realsec = '';
3860: } else {
3861: $cnum = $cnumpart;
3862: ($sec,$role) = split(/_/,$secpart);
3863: $realsec = $sec;
1.490 raeburn 3864: }
1.482 raeburn 3865: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3866: }
3867: } else {
3868: foreach my $key (keys(%env)) {
1.483 albertel 3869: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3870: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3871: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3872: next if ($role eq 'ca' || $role eq 'aa');
3873: next if (%roles && !exists($roles{$role}));
3874: my ($starttime,$endtime)=split(/\./,$env{$key});
3875: my $active=1;
3876: if ($starttime) {
3877: if ($now<$starttime) { $active=0; }
3878: }
3879: if ($endtime) {
3880: if ($now>$endtime) { $active=0; }
3881: }
3882: if ($active) {
3883: if ($sec eq '') {
3884: $sec = 'none';
3885: }
3886: $courses{$cdom.'_'.$cnum}{$sec} =
3887: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 3888: }
3889: }
1.51 www 3890: }
3891: }
1.474 raeburn 3892: return %courses;
1.51 www 3893: }
1.37 matthew 3894:
1.54 www 3895: ###############################################
1.474 raeburn 3896:
3897: sub blockcheck {
1.482 raeburn 3898: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 3899:
3900: if (!defined($udom)) {
3901: $udom = $env{'user.domain'};
3902: }
3903: if (!defined($uname)) {
3904: $uname = $env{'user.name'};
3905: }
3906:
3907: # If uname and udom are for a course, check for blocks in the course.
3908:
3909: if (&Apache::lonnet::is_course($udom,$uname)) {
3910: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 3911: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 3912: return ($startblock,$endblock);
3913: }
1.474 raeburn 3914:
1.502 raeburn 3915: my $startblock = 0;
3916: my $endblock = 0;
1.482 raeburn 3917: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 3918:
1.490 raeburn 3919: # If uname is for a user, and activity is course-specific, i.e.,
3920: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3921:
1.490 raeburn 3922: if (($activity eq 'boards' || $activity eq 'chat' ||
3923: $activity eq 'groups') && ($env{'request.course.id'})) {
3924: foreach my $key (keys(%live_courses)) {
3925: if ($key ne $env{'request.course.id'}) {
3926: delete($live_courses{$key});
3927: }
3928: }
3929: }
3930:
3931: my $otheruser = 0;
3932: my %own_courses;
3933: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3934: # Resource belongs to user other than current user.
3935: $otheruser = 1;
3936: # Gather courses for current user
3937: %own_courses =
3938: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3939: }
3940:
3941: # Gather active course roles - course coordinator, instructor,
3942: # exam proctor, ta, student, or custom role.
1.474 raeburn 3943:
3944: foreach my $course (keys(%live_courses)) {
1.482 raeburn 3945: my ($cdom,$cnum);
3946: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3947: $cdom = $env{'course.'.$course.'.domain'};
3948: $cnum = $env{'course.'.$course.'.num'};
3949: } else {
1.490 raeburn 3950: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 3951: }
3952: my $no_ownblock = 0;
3953: my $no_userblock = 0;
1.533 raeburn 3954: if ($otheruser && $activity ne 'com') {
1.490 raeburn 3955: # Check if current user has 'evb' priv for this
3956: if (defined($own_courses{$course})) {
3957: foreach my $sec (keys(%{$own_courses{$course}})) {
3958: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3959: if ($sec ne 'none') {
3960: $checkrole .= '/'.$sec;
3961: }
3962: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3963: $no_ownblock = 1;
3964: last;
3965: }
3966: }
3967: }
3968: # if they have 'evb' priv and are currently not playing student
3969: next if (($no_ownblock) &&
3970: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
3971: }
1.474 raeburn 3972: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 3973: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 3974: if ($sec ne 'none') {
1.482 raeburn 3975: $checkrole .= '/'.$sec;
1.474 raeburn 3976: }
1.490 raeburn 3977: if ($otheruser) {
3978: # Resource belongs to user other than current user.
3979: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 3980: my ($trole,$tdom,$tnum,$tsec);
3981: my $entry = $live_courses{$course}{$sec};
3982: if ($entry =~ /^cr/) {
3983: ($trole,$tdom,$tnum,$tsec) =
3984: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
3985: } else {
3986: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
3987: }
3988: my ($spec,$area,$trest,%allroles,%userroles);
3989: $area = '/'.$tdom.'/'.$tnum;
3990: $trest = $tnum;
3991: if ($tsec ne '') {
3992: $area .= '/'.$tsec;
3993: $trest .= '/'.$tsec;
3994: }
3995: $spec = $trole.'.'.$area;
3996: if ($trole =~ /^cr/) {
3997: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
3998: $tdom,$spec,$trest,$area);
3999: } else {
4000: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
4001: $tdom,$spec,$trest,$area);
4002: }
4003: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 4004: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
4005: if ($1) {
4006: $no_userblock = 1;
4007: last;
4008: }
4009: }
1.490 raeburn 4010: } else {
4011: # Resource belongs to current user
4012: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 4013: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4014: $no_ownblock = 1;
4015: last;
4016: }
1.474 raeburn 4017: }
4018: }
4019: # if they have the evb priv and are currently not playing student
1.482 raeburn 4020: next if (($no_ownblock) &&
1.491 albertel 4021: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 4022: next if ($no_userblock);
1.474 raeburn 4023:
1.866 kalberla 4024: # Retrieve blocking times and identity of locker for course
1.490 raeburn 4025: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 4026:
4027: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
4028: if (($start != 0) &&
4029: (($startblock == 0) || ($startblock > $start))) {
4030: $startblock = $start;
4031: }
4032: if (($end != 0) &&
4033: (($endblock == 0) || ($endblock < $end))) {
4034: $endblock = $end;
4035: }
1.490 raeburn 4036: }
4037: return ($startblock,$endblock);
4038: }
4039:
4040: sub get_blocks {
4041: my ($setters,$activity,$cdom,$cnum) = @_;
4042: my $startblock = 0;
4043: my $endblock = 0;
4044: my $course = $cdom.'_'.$cnum;
4045: $setters->{$course} = {};
4046: $setters->{$course}{'staff'} = [];
4047: $setters->{$course}{'times'} = [];
4048: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
4049: foreach my $record (keys(%records)) {
4050: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
4051: if ($start <= time && $end >= time) {
4052: my ($staff_name,$staff_dom,$title,$blocks) =
4053: &parse_block_record($records{$record});
4054: if ($blocks->{$activity} eq 'on') {
4055: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
4056: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 4057: if ( ($startblock == 0) || ($startblock > $start) ) {
4058: $startblock = $start;
1.490 raeburn 4059: }
1.491 albertel 4060: if ( ($endblock == 0) || ($endblock < $end) ) {
4061: $endblock = $end;
1.474 raeburn 4062: }
4063: }
4064: }
4065: }
4066: return ($startblock,$endblock);
4067: }
4068:
4069: sub parse_block_record {
4070: my ($record) = @_;
4071: my ($setuname,$setudom,$title,$blocks);
4072: if (ref($record) eq 'HASH') {
4073: ($setuname,$setudom) = split(/:/,$record->{'setter'});
4074: $title = &unescape($record->{'event'});
4075: $blocks = $record->{'blocks'};
4076: } else {
4077: my @data = split(/:/,$record,3);
4078: if (scalar(@data) eq 2) {
4079: $title = $data[1];
4080: ($setuname,$setudom) = split(/@/,$data[0]);
4081: } else {
4082: ($setuname,$setudom,$title) = @data;
4083: }
4084: $blocks = { 'com' => 'on' };
4085: }
4086: return ($setuname,$setudom,$title,$blocks);
4087: }
4088:
1.854 kalberla 4089: sub blocking_status {
4090: my ($activity,$uname,$udom) = @_;
1.867 kalberla 4091: my %setters;
1.890 droeschl 4092:
4093: # check for active blocking
1.867 kalberla 4094: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
1.854 kalberla 4095:
1.890 droeschl 4096: my $blocked = $startblock && $endblock ? 1 : 0;
4097:
4098: # caller just wants to know whether a block is active
4099: if (!wantarray) { return $blocked; }
4100:
4101: # build a link to a popup window containing the details
4102: my $querystring = "?activity=$activity";
4103: # $uname and $udom decide whose portfolio the user is trying to look at
4104: $querystring .= "&udom=$udom" if $udom;
4105: $querystring .= "&uname=$uname" if $uname;
4106:
4107: my $output .= <<'END_MYBLOCK';
1.854 kalberla 4108: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
4109: var options = "width=" + w + ",height=" + h + ",";
4110: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
4111: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
4112: var newWin = window.open(url, wdwName, options);
4113: newWin.focus();
4114: }
1.890 droeschl 4115: END_MYBLOCK
1.854 kalberla 4116:
1.890 droeschl 4117: $output = Apache::lonhtmlcommon::scripttag($output);
4118:
1.854 kalberla 4119: my $popupUrl = "/adm/blockingstatus/$querystring";
1.890 droeschl 4120: my $text = mt('Communication Blocked');
4121:
1.867 kalberla 4122: $output .= <<"END_BLOCK";
4123: <div class='LC_comblock'>
1.869 kalberla 4124: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4125: title='$text'>
4126: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 4127: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4128: title='$text'>$text</a>
1.867 kalberla 4129: </div>
4130:
4131: END_BLOCK
1.474 raeburn 4132:
1.854 kalberla 4133: return ($blocked, $output);
4134: }
1.490 raeburn 4135:
1.60 matthew 4136: ###############################################
4137:
1.682 raeburn 4138: sub check_ip_acc {
4139: my ($acc)=@_;
4140: &Apache::lonxml::debug("acc is $acc");
4141: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
4142: return 1;
4143: }
4144: my $allowed=0;
4145: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
4146:
4147: my $name;
4148: foreach my $pattern (split(',',$acc)) {
4149: $pattern =~ s/^\s*//;
4150: $pattern =~ s/\s*$//;
4151: if ($pattern =~ /\*$/) {
4152: #35.8.*
4153: $pattern=~s/\*//;
4154: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4155: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
4156: #35.8.3.[34-56]
4157: my $low=$2;
4158: my $high=$3;
4159: $pattern=$1;
4160: if ($ip =~ /^\Q$pattern\E/) {
4161: my $last=(split(/\./,$ip))[3];
4162: if ($last <=$high && $last >=$low) { $allowed=1; }
4163: }
4164: } elsif ($pattern =~ /^\*/) {
4165: #*.msu.edu
4166: $pattern=~s/\*//;
4167: if (!defined($name)) {
4168: use Socket;
4169: my $netaddr=inet_aton($ip);
4170: ($name)=gethostbyaddr($netaddr,AF_INET);
4171: }
4172: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4173: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
4174: #127.0.0.1
4175: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4176: } else {
4177: #some.name.com
4178: if (!defined($name)) {
4179: use Socket;
4180: my $netaddr=inet_aton($ip);
4181: ($name)=gethostbyaddr($netaddr,AF_INET);
4182: }
4183: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4184: }
4185: if ($allowed) { last; }
4186: }
4187: return $allowed;
4188: }
4189:
4190: ###############################################
4191:
1.60 matthew 4192: =pod
4193:
1.112 bowersj2 4194: =head1 Domain Template Functions
4195:
4196: =over 4
4197:
4198: =item * &determinedomain()
1.60 matthew 4199:
4200: Inputs: $domain (usually will be undef)
4201:
1.63 www 4202: Returns: Determines which domain should be used for designs
1.60 matthew 4203:
4204: =cut
1.54 www 4205:
1.60 matthew 4206: ###############################################
1.63 www 4207: sub determinedomain {
4208: my $domain=shift;
1.531 albertel 4209: if (! $domain) {
1.60 matthew 4210: # Determine domain if we have not been given one
1.893 raeburn 4211: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 4212: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
4213: if ($env{'request.role.domain'}) {
4214: $domain=$env{'request.role.domain'};
1.60 matthew 4215: }
4216: }
1.63 www 4217: return $domain;
4218: }
4219: ###############################################
1.517 raeburn 4220:
1.518 albertel 4221: sub devalidate_domconfig_cache {
4222: my ($udom)=@_;
4223: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
4224: }
4225:
4226: # ---------------------- Get domain configuration for a domain
4227: sub get_domainconf {
4228: my ($udom) = @_;
4229: my $cachetime=1800;
4230: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
4231: if (defined($cached)) { return %{$result}; }
4232:
4233: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 4234: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 4235: my (%designhash,%legacy);
1.518 albertel 4236: if (keys(%domconfig) > 0) {
4237: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 4238: if (keys(%{$domconfig{'login'}})) {
4239: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 4240: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.946 raeburn 4241: if ($key eq 'loginvia') {
4242: if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') {
4243: my @ids = &Apache::lonnet::current_machine_ids();
4244: foreach my $hostname (@ids) {
1.948 raeburn 4245: if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') {
4246: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
4247: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
4248: $designhash{$udom.'.login.loginvia'} = $server;
4249: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
4250:
4251: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
4252: } else {
4253: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
4254: }
4255: if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) {
4256: $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'};
4257: }
1.946 raeburn 4258: }
4259: }
4260: }
4261: }
4262: } else {
4263: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
4264: $designhash{$udom.'.login.'.$key.'_'.$img} =
4265: $domconfig{'login'}{$key}{$img};
4266: }
1.699 raeburn 4267: }
4268: } else {
4269: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
4270: }
1.632 raeburn 4271: }
4272: } else {
4273: $legacy{'login'} = 1;
1.518 albertel 4274: }
1.632 raeburn 4275: } else {
4276: $legacy{'login'} = 1;
1.518 albertel 4277: }
4278: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 4279: if (keys(%{$domconfig{'rolecolors'}})) {
4280: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
4281: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
4282: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
4283: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
4284: }
1.518 albertel 4285: }
4286: }
1.632 raeburn 4287: } else {
4288: $legacy{'rolecolors'} = 1;
1.518 albertel 4289: }
1.632 raeburn 4290: } else {
4291: $legacy{'rolecolors'} = 1;
1.518 albertel 4292: }
1.948 raeburn 4293: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
4294: if ($domconfig{'autoenroll'}{'co-owners'}) {
4295: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
4296: }
4297: }
1.632 raeburn 4298: if (keys(%legacy) > 0) {
4299: my %legacyhash = &get_legacy_domconf($udom);
4300: foreach my $item (keys(%legacyhash)) {
4301: if ($item =~ /^\Q$udom\E\.login/) {
4302: if ($legacy{'login'}) {
4303: $designhash{$item} = $legacyhash{$item};
4304: }
4305: } else {
4306: if ($legacy{'rolecolors'}) {
4307: $designhash{$item} = $legacyhash{$item};
4308: }
1.518 albertel 4309: }
4310: }
4311: }
1.632 raeburn 4312: } else {
4313: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4314: }
4315: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4316: $cachetime);
4317: return %designhash;
4318: }
4319:
1.632 raeburn 4320: sub get_legacy_domconf {
4321: my ($udom) = @_;
4322: my %legacyhash;
4323: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4324: my $designfile = $designdir.'/'.$udom.'.tab';
4325: if (-e $designfile) {
4326: if ( open (my $fh,"<$designfile") ) {
4327: while (my $line = <$fh>) {
4328: next if ($line =~ /^\#/);
4329: chomp($line);
4330: my ($key,$val)=(split(/\=/,$line));
4331: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4332: }
4333: close($fh);
4334: }
4335: }
4336: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
4337: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4338: }
4339: return %legacyhash;
4340: }
4341:
1.63 www 4342: =pod
4343:
1.112 bowersj2 4344: =item * &domainlogo()
1.63 www 4345:
4346: Inputs: $domain (usually will be undef)
4347:
4348: Returns: A link to a domain logo, if the domain logo exists.
4349: If the domain logo does not exist, a description of the domain.
4350:
4351: =cut
1.112 bowersj2 4352:
1.63 www 4353: ###############################################
4354: sub domainlogo {
1.517 raeburn 4355: my $domain = &determinedomain(shift);
1.518 albertel 4356: my %designhash = &get_domainconf($domain);
1.517 raeburn 4357: # See if there is a logo
4358: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4359: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4360: if ($imgsrc =~ m{^/(adm|res)/}) {
4361: if ($imgsrc =~ m{^/res/}) {
4362: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4363: &Apache::lonnet::repcopy($local_name);
4364: }
4365: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4366: }
4367: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4368: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4369: return &Apache::lonnet::domain($domain,'description');
1.59 www 4370: } else {
1.60 matthew 4371: return '';
1.59 www 4372: }
4373: }
1.63 www 4374: ##############################################
4375:
4376: =pod
4377:
1.112 bowersj2 4378: =item * &designparm()
1.63 www 4379:
4380: Inputs: $which parameter; $domain (usually will be undef)
4381:
4382: Returns: value of designparamter $which
4383:
4384: =cut
1.112 bowersj2 4385:
1.397 albertel 4386:
1.400 albertel 4387: ##############################################
1.397 albertel 4388: sub designparm {
4389: my ($which,$domain)=@_;
4390: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 4391: return $env{'environment.color.'.$which};
1.96 www 4392: }
1.63 www 4393: $domain=&determinedomain($domain);
1.518 albertel 4394: my %domdesign = &get_domainconf($domain);
1.520 raeburn 4395: my $output;
1.517 raeburn 4396: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 4397: $output = $domdesign{$domain.'.'.$which};
1.63 www 4398: } else {
1.520 raeburn 4399: $output = $defaultdesign{$which};
4400: }
4401: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4402: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4403: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 4404: if ($output =~ m{^/res/}) {
4405: my $local_name = &Apache::lonnet::filelocation('',$output);
4406: &Apache::lonnet::repcopy($local_name);
4407: }
1.520 raeburn 4408: $output = &lonhttpdurl($output);
4409: }
1.63 www 4410: }
1.520 raeburn 4411: return $output;
1.63 www 4412: }
1.59 www 4413:
1.822 bisitz 4414: ##############################################
4415: =pod
4416:
1.832 bisitz 4417: =item * &authorspace()
4418:
4419: Inputs: ./.
4420:
4421: Returns: Path to the Construction Space of the current user's
4422: accessed author space
4423: The author space will be that of the current user
4424: when accessing the own author space
4425: and that of the co-author/assistent co-author
4426: when accessing the co-author's/assistent co-author's
4427: space
4428:
4429: =cut
4430:
4431: sub authorspace {
4432: my $caname = '';
4433: if ($env{'request.role'} =~ /^ca|^aa/) {
4434: (undef,$caname) =
4435: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
4436: } else {
4437: $caname = $env{'user.name'};
4438: }
4439: return '/priv/'.$caname.'/';
4440: }
4441:
4442: ##############################################
4443: =pod
4444:
1.822 bisitz 4445: =item * &head_subbox()
4446:
4447: Inputs: $content (contains HTML code with page functions, etc.)
4448:
4449: Returns: HTML div with $content
4450: To be included in page header
4451:
4452: =cut
4453:
4454: sub head_subbox {
4455: my ($content)=@_;
4456: my $output =
1.844 bisitz 4457: '<div id="LC_head_subbox">'
1.822 bisitz 4458: .$content
4459: .'</div>'
4460: }
4461:
4462: ##############################################
4463: =pod
4464:
4465: =item * &CSTR_pageheader()
4466:
4467: Inputs: ./.
4468:
4469: Returns: HTML div with CSTR path and recent box
4470: To be included on Construction Space pages
4471:
4472: =cut
4473:
4474: sub CSTR_pageheader {
4475: # this is for resources; directories have customtitle, and crumbs
4476: # and select recent are created in lonpubdir.pm
4477: my ($uname,$thisdisfn)=
4478: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
4479: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4480: $formaction=~s/\/+/\//g;
4481:
4482: my $parentpath = '';
4483: my $lastitem = '';
4484: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4485: $parentpath = $1;
4486: $lastitem = $2;
4487: } else {
4488: $lastitem = $thisdisfn;
4489: }
1.921 bisitz 4490:
4491: my $output =
1.822 bisitz 4492: '<div>'
4493: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
4494: .'<b>'.&mt('Construction Space:').'</b> '
4495: .'<form name="dirs" method="post" action="'.$formaction
1.921 bisitz 4496: .'" target="_top">' #FIXME lonpubdir: target="_parent"
4497: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv',undef,undef);
4498:
4499: if ($lastitem) {
4500: $output .=
4501: '<span class="LC_filename">'
4502: .$lastitem
4503: .'</span>';
4504: }
4505: $output .=
4506: '<br />'
1.822 bisitz 4507: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
4508: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4509: .'</form>'
4510: .&Apache::lonmenu::constspaceform()
4511: .'</div>';
1.921 bisitz 4512:
4513: return $output;
1.822 bisitz 4514: }
4515:
1.60 matthew 4516: ###############################################
4517: ###############################################
4518:
4519: =pod
4520:
1.112 bowersj2 4521: =back
4522:
1.549 albertel 4523: =head1 HTML Helpers
1.112 bowersj2 4524:
4525: =over 4
4526:
4527: =item * &bodytag()
1.60 matthew 4528:
4529: Returns a uniform header for LON-CAPA web pages.
4530:
4531: Inputs:
4532:
1.112 bowersj2 4533: =over 4
4534:
4535: =item * $title, A title to be displayed on the page.
4536:
4537: =item * $function, the current role (can be undef).
4538:
4539: =item * $addentries, extra parameters for the <body> tag.
4540:
4541: =item * $bodyonly, if defined, only return the <body> tag.
4542:
4543: =item * $domain, if defined, force a given domain.
4544:
4545: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4546: text interface only)
1.60 matthew 4547:
1.814 bisitz 4548: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
4549: navigational links
1.317 albertel 4550:
1.338 albertel 4551: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4552:
1.361 albertel 4553: =item * $no_inline_link, if true and in remote mode, don't show the
4554: 'Switch To Inline Menu' link
4555:
1.460 albertel 4556: =item * $args, optional argument valid values are
4557: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4558: inherit_jsmath -> when creating popup window in a page,
4559: should it have jsmath forced on by the
4560: current page
1.460 albertel 4561:
1.112 bowersj2 4562: =back
4563:
1.60 matthew 4564: Returns: A uniform header for LON-CAPA web pages.
4565: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4566: If $bodyonly is undef or zero, an html string containing a <body> tag and
4567: other decorations will be returned.
4568:
4569: =cut
4570:
1.54 www 4571: sub bodytag {
1.831 bisitz 4572: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.816 bisitz 4573: $no_nav_bar,$bgcolor,$no_inline_link,$args)=@_;
1.339 albertel 4574:
1.460 albertel 4575: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4576:
1.183 matthew 4577: $function = &get_users_function() if (!$function);
1.339 albertel 4578: my $img = &designparm($function.'.img',$domain);
4579: my $font = &designparm($function.'.font',$domain);
4580: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4581:
1.803 bisitz 4582: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 4583: 'bgcolor' => $pgbg,
1.339 albertel 4584: 'text' => $font,
4585: 'alink' => &designparm($function.'.alink',$domain),
4586: 'vlink' => &designparm($function.'.vlink',$domain),
4587: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4588: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4589:
1.63 www 4590: # role and realm
1.378 raeburn 4591: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4592: if ($role eq 'ca') {
1.479 albertel 4593: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4594: $realm = &plainname($rname,$rdom);
1.378 raeburn 4595: }
1.55 www 4596: # realm
1.258 albertel 4597: if ($env{'request.course.id'}) {
1.378 raeburn 4598: if ($env{'request.role'} !~ /^cr/) {
4599: $role = &Apache::lonnet::plaintext($role,&course_type());
4600: }
1.898 raeburn 4601: if ($env{'request.course.sec'}) {
4602: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
4603: }
1.359 albertel 4604: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4605: } else {
4606: $role = &Apache::lonnet::plaintext($role);
1.54 www 4607: }
1.433 albertel 4608:
1.359 albertel 4609: if (!$realm) { $realm=' '; }
1.55 www 4610: # Set messages
1.60 matthew 4611: my $messages=&domainlogo($domain);
1.330 albertel 4612:
1.438 albertel 4613: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4614:
1.101 www 4615: # construct main body tag
1.359 albertel 4616: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4617: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4618:
1.530 albertel 4619: if ($bodyonly) {
1.60 matthew 4620: return $bodytag;
1.798 tempelho 4621: }
1.359 albertel 4622:
1.410 albertel 4623: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433 albertel 4624: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4625: undef($role);
1.434 albertel 4626: } else {
4627: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4628: }
1.359 albertel 4629:
1.762 bisitz 4630: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 4631: #
4632: # Extra info if you are the DC
4633: my $dc_info = '';
4634: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4635: $env{'course.'.$env{'request.course.id'}.
4636: '.domain'}.'/'})) {
4637: my $cid = $env{'request.course.id'};
1.917 raeburn 4638: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4639: $dc_info =~ s/\s+$//;
1.359 albertel 4640: }
4641:
1.898 raeburn 4642: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853 droeschl 4643: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
4644:
1.837 bisitz 4645: if ($env{'environment.remote'} eq 'off') {
1.359 albertel 4646: # No Remote
1.916 droeschl 4647: if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') {
4648: return $bodytag;
4649: }
1.903 droeschl 4650:
4651: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
4652:
4653: # if ($env{'request.state'} eq 'construct') {
4654: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
4655: # }
4656:
1.359 albertel 4657:
4658:
1.916 droeschl 4659: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917 raeburn 4660: if ($dc_info) {
4661: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
4662: }
1.916 droeschl 4663: $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
4664: <em>$realm</em> $dc_info</div>|;
1.903 droeschl 4665: return $bodytag;
4666: }
1.894 droeschl 4667:
1.927 raeburn 4668: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
4669: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
4670: }
1.916 droeschl 4671:
1.903 droeschl 4672: $bodytag .= Apache::lonhtmlcommon::scripttag(
4673: Apache::lonmenu::utilityfunctions(), 'start');
1.816 bisitz 4674:
1.903 droeschl 4675: $bodytag .= Apache::lonmenu::primary_menu();
1.852 droeschl 4676:
1.917 raeburn 4677: if ($dc_info) {
4678: $dc_info = &dc_courseid_toggle($dc_info);
4679: }
4680: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 4681:
1.903 droeschl 4682: #don't show menus for public users
4683: if($env{'user.name'} ne 'public' && $env{'user.domain'} ne 'public'){
4684: $bodytag .= Apache::lonmenu::secondary_menu();
4685: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 4686: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
4687: if ($env{'request.state'} eq 'construct') {
4688: $bodytag .= &Apache::lonmenu::innerregister($forcereg,'',
4689: $args->{'bread_crumbs'});
4690: } elsif ($forcereg) {
4691: $bodytag .= &Apache::lonmenu::innerregister($forcereg);
4692: }
1.903 droeschl 4693: }else{
4694: # this is to seperate menu from content when there's no secondary
4695: # menu. Especially needed for public accessible ressources.
4696: $bodytag .= '<hr style="clear:both" />';
4697: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 4698: }
1.903 droeschl 4699:
1.235 raeburn 4700: return $bodytag;
1.94 www 4701: }
1.95 www 4702:
1.93 www 4703: #
1.95 www 4704: # Top frame rendering, Remote is up
1.93 www 4705: #
1.359 albertel 4706:
1.517 raeburn 4707: my $imgsrc = $img;
4708: if ($img =~ /^\/adm/) {
1.575 albertel 4709: $imgsrc = &lonhttpdurl($img);
1.517 raeburn 4710: }
4711: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359 albertel 4712:
1.305 www 4713: # Explicit link to get inline menu
1.361 albertel 4714: my $menu= ($no_inline_link?''
1.883 droeschl 4715: :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
1.917 raeburn 4716:
4717: if ($dc_info) {
4718: $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
4719: }
4720:
1.916 droeschl 4721: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>
1.897 wenzelju 4722: <ol class="LC_primary_menu LC_right">
1.853 droeschl 4723: <li>$menu</li>
1.917 raeburn 4724: </ol><div id="LC_realm"> $realm $dc_info</div>| unless $env{'form.inhibitmenu'};
1.94 www 4725: return(<<ENDBODY);
1.60 matthew 4726: $bodytag
1.359 albertel 4727: <table id="LC_title_bar" class="LC_with_remote">
1.791 tempelho 4728: <tr><td>$upperleft</td>
4729: <td>$messages </td>
1.54 www 4730: </tr>
1.359 albertel 4731: <tr><td>$titleinfo $dc_info $menu</td>
1.368 albertel 4732: </tr>
1.356 albertel 4733: </table>
1.54 www 4734: ENDBODY
1.182 matthew 4735: }
4736:
1.917 raeburn 4737: sub dc_courseid_toggle {
4738: my ($dc_info) = @_;
4739: return ' <span id="dccidtext" class="LC_cusr_subheading">'.
4740: '<a href="javascript:showCourseID();">'.
4741: &mt('(More ...)').'</a></span>'.
4742: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
4743: }
4744:
1.330 albertel 4745: sub make_attr_string {
4746: my ($register,$attr_ref) = @_;
4747:
4748: if ($attr_ref && !ref($attr_ref)) {
4749: die("addentries Must be a hash ref ".
4750: join(':',caller(1))." ".
4751: join(':',caller(0))." ");
4752: }
4753:
4754: if ($register) {
1.339 albertel 4755: my ($on_load,$on_unload);
4756: foreach my $key (keys(%{$attr_ref})) {
4757: if (lc($key) eq 'onload') {
4758: $on_load.=$attr_ref->{$key}.';';
4759: delete($attr_ref->{$key});
4760:
4761: } elsif (lc($key) eq 'onunload') {
4762: $on_unload.=$attr_ref->{$key}.';';
4763: delete($attr_ref->{$key});
4764: }
4765: }
4766: $attr_ref->{'onload'} =
4767: &Apache::lonmenu::loadevents(). $on_load;
4768: $attr_ref->{'onunload'}=
4769: &Apache::lonmenu::unloadevents().$on_unload;
4770: }
4771:
4772: # Accessibility font enhance
4773: if ($env{'browser.fontenhance'} eq 'on') {
4774: my $style;
4775: foreach my $key (keys(%{$attr_ref})) {
4776: if (lc($key) eq 'style') {
4777: $style.=$attr_ref->{$key}.';';
4778: delete($attr_ref->{$key});
4779: }
4780: }
4781: $attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330 albertel 4782: }
1.339 albertel 4783:
1.330 albertel 4784: my $attr_string;
4785: foreach my $attr (keys(%$attr_ref)) {
4786: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4787: }
4788: return $attr_string;
4789: }
4790:
4791:
1.182 matthew 4792: ###############################################
1.251 albertel 4793: ###############################################
4794:
4795: =pod
4796:
4797: =item * &endbodytag()
4798:
4799: Returns a uniform footer for LON-CAPA web pages.
4800:
1.635 raeburn 4801: Inputs: 1 - optional reference to an args hash
4802: If in the hash, key for noredirectlink has a value which evaluates to true,
4803: a 'Continue' link is not displayed if the page contains an
4804: internal redirect in the <head></head> section,
4805: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4806:
4807: =cut
4808:
4809: sub endbodytag {
1.635 raeburn 4810: my ($args) = @_;
1.251 albertel 4811: my $endbodytag='</body>';
1.269 albertel 4812: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4813: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4814: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4815: $endbodytag=
4816: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4817: &mt('Continue').'</a>'.
4818: $endbodytag;
4819: }
1.315 albertel 4820: }
1.251 albertel 4821: return $endbodytag;
4822: }
4823:
1.352 albertel 4824: =pod
4825:
4826: =item * &standard_css()
4827:
4828: Returns a style sheet
4829:
4830: Inputs: (all optional)
4831: domain -> force to color decorate a page for a specific
4832: domain
4833: function -> force usage of a specific rolish color scheme
4834: bgcolor -> override the default page bgcolor
4835:
4836: =cut
4837:
1.343 albertel 4838: sub standard_css {
1.345 albertel 4839: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4840: $function = &get_users_function() if (!$function);
4841: my $img = &designparm($function.'.img', $domain);
4842: my $tabbg = &designparm($function.'.tabbg', $domain);
4843: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 4844: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 4845: #second colour for later usage
1.345 albertel 4846: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4847: my $pgbg_or_bgcolor =
4848: $bgcolor ||
1.352 albertel 4849: &designparm($function.'.pgbg', $domain);
1.382 albertel 4850: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4851: my $alink = &designparm($function.'.alink', $domain);
4852: my $vlink = &designparm($function.'.vlink', $domain);
4853: my $link = &designparm($function.'.link', $domain);
4854:
1.704 muellerd 4855: my $loginbg = &designparm('login.sidebg',$domain);
1.712 muellerd 4856: my $bgcol = &designparm('login.bgcol',$domain);
4857: my $textcol = &designparm('login.textcol',$domain);
1.704 muellerd 4858:
1.602 albertel 4859: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4860: my $mono = 'monospace';
1.850 bisitz 4861: my $data_table_head = $sidebg;
4862: my $data_table_light = '#FAFAFA';
4863: my $data_table_dark = '#F0F0F0';
1.470 banghart 4864: my $data_table_darker = '#CCCCCC';
1.349 albertel 4865: my $data_table_highlight = '#FFFF00';
1.352 albertel 4866: my $mail_new = '#FFBB77';
4867: my $mail_new_hover = '#DD9955';
4868: my $mail_read = '#BBBB77';
4869: my $mail_read_hover = '#999944';
4870: my $mail_replied = '#AAAA88';
4871: my $mail_replied_hover = '#888855';
4872: my $mail_other = '#99BBBB';
4873: my $mail_other_hover = '#669999';
1.391 albertel 4874: my $table_header = '#DDDDDD';
1.489 raeburn 4875: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 4876: my $lg_border_color = '#C8C8C8';
1.948.2.1! raeburn 4877: my $button_hover = '#BF2317';
1.392 albertel 4878:
1.608 albertel 4879: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 4880: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
4881: : '0 3px 0 4px';
1.448 albertel 4882:
1.343 albertel 4883: return <<END;
1.947 droeschl 4884:
4885: /* needed for iframe to allow 100% height in FF */
4886: body, html {
4887: margin: 0;
4888: padding: 0 0.5%;
4889: height: 99%; /* to avoid scrollbars */
4890: }
4891:
1.795 www 4892: body {
1.911 bisitz 4893: font-family: $sans;
4894: line-height:130%;
4895: font-size:0.83em;
4896: color:$font;
1.795 www 4897: }
4898:
1.911 bisitz 4899: a:focus {
1.795 www 4900: color: red;
1.911 bisitz 4901: background: yellow;
1.795 www 4902: }
1.698 harmsja 4903:
1.911 bisitz 4904: form, .inline {
4905: display: inline;
1.795 www 4906: }
1.721 harmsja 4907:
1.795 www 4908: .LC_right {
1.911 bisitz 4909: text-align:right;
1.795 www 4910: }
4911:
4912: .LC_middle {
1.911 bisitz 4913: vertical-align:middle;
1.795 www 4914: }
1.721 harmsja 4915:
1.911 bisitz 4916: .LC_400Box {
4917: width:400px;
4918: }
1.721 harmsja 4919:
1.947 droeschl 4920: .LC_iframecontainer {
4921: width: 98%;
4922: margin: 0;
4923: position: fixed;
4924: top: 8.5em;
4925: bottom: 0;
4926: }
4927:
4928: .LC_iframecontainer iframe{
4929: border: none;
4930: width: 100%;
4931: height: 100%;
4932: }
4933:
1.778 bisitz 4934: .LC_filename {
4935: font-family: $mono;
4936: white-space:pre;
1.921 bisitz 4937: font-size: 120%;
1.778 bisitz 4938: }
4939:
4940: .LC_fileicon {
4941: border: none;
4942: height: 1.3em;
4943: vertical-align: text-bottom;
4944: margin-right: 0.3em;
4945: text-decoration:none;
4946: }
4947:
1.350 albertel 4948: .LC_error {
4949: color: red;
4950: font-size: larger;
4951: }
1.795 www 4952:
1.457 albertel 4953: .LC_warning,
4954: .LC_diff_removed {
1.733 bisitz 4955: color: red;
1.394 albertel 4956: }
1.532 albertel 4957:
4958: .LC_info,
1.457 albertel 4959: .LC_success,
4960: .LC_diff_added {
1.350 albertel 4961: color: green;
4962: }
1.795 www 4963:
1.802 bisitz 4964: div.LC_confirm_box {
4965: background-color: #FAFAFA;
4966: border: 1px solid $lg_border_color;
4967: margin-right: 0;
4968: padding: 5px;
4969: }
4970:
4971: div.LC_confirm_box .LC_error img,
4972: div.LC_confirm_box .LC_success img {
4973: vertical-align: middle;
4974: }
4975:
1.440 albertel 4976: .LC_icon {
1.771 droeschl 4977: border: none;
1.790 droeschl 4978: vertical-align: middle;
1.771 droeschl 4979: }
4980:
1.543 albertel 4981: .LC_docs_spacer {
4982: width: 25px;
4983: height: 1px;
1.771 droeschl 4984: border: none;
1.543 albertel 4985: }
1.346 albertel 4986:
1.532 albertel 4987: .LC_internal_info {
1.735 bisitz 4988: color: #999999;
1.532 albertel 4989: }
4990:
1.794 www 4991: .LC_discussion {
1.911 bisitz 4992: background: $tabbg;
4993: border: 1px solid black;
4994: margin: 2px;
1.794 www 4995: }
4996:
4997: .LC_disc_action_links_bar {
1.911 bisitz 4998: background: $tabbg;
4999: border: none;
5000: margin: 4px;
1.794 www 5001: }
5002:
5003: .LC_disc_action_left {
1.911 bisitz 5004: text-align: left;
1.794 www 5005: }
5006:
5007: .LC_disc_action_right {
1.911 bisitz 5008: text-align: right;
1.794 www 5009: }
5010:
5011: .LC_disc_new_item {
1.911 bisitz 5012: background: white;
5013: border: 2px solid red;
5014: margin: 2px;
1.794 www 5015: }
5016:
5017: .LC_disc_old_item {
1.911 bisitz 5018: background: white;
5019: border: 1px solid black;
5020: margin: 2px;
1.794 www 5021: }
5022:
1.458 albertel 5023: table.LC_pastsubmission {
5024: border: 1px solid black;
5025: margin: 2px;
5026: }
5027:
1.924 bisitz 5028: table#LC_menubuttons {
1.345 albertel 5029: width: 100%;
5030: background: $pgbg;
1.392 albertel 5031: border: 2px;
1.402 albertel 5032: border-collapse: separate;
1.803 bisitz 5033: padding: 0;
1.345 albertel 5034: }
1.392 albertel 5035:
1.801 tempelho 5036: table#LC_title_bar a {
5037: color: $fontmenu;
5038: }
1.836 bisitz 5039:
1.807 droeschl 5040: table#LC_title_bar {
1.819 tempelho 5041: clear: both;
1.836 bisitz 5042: display: none;
1.807 droeschl 5043: }
5044:
1.795 www 5045: table#LC_title_bar,
1.933 droeschl 5046: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 5047: table#LC_title_bar.LC_with_remote {
1.359 albertel 5048: width: 100%;
1.392 albertel 5049: border-color: $pgbg;
5050: border-style: solid;
5051: border-width: $border;
1.379 albertel 5052: background: $pgbg;
1.801 tempelho 5053: color: $fontmenu;
1.392 albertel 5054: border-collapse: collapse;
1.803 bisitz 5055: padding: 0;
1.819 tempelho 5056: margin: 0;
1.359 albertel 5057: }
1.795 www 5058:
1.933 droeschl 5059: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 5060: margin: 0;
5061: padding: 0;
1.933 droeschl 5062: position: relative;
5063: list-style: none;
1.913 droeschl 5064: }
1.933 droeschl 5065: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 5066: display: inline;
5067: }
1.933 droeschl 5068:
5069: .LC_breadcrumb_tools_navigation {
1.913 droeschl 5070: padding: 0;
1.933 droeschl 5071: margin: 0;
5072: float: left;
1.913 droeschl 5073: }
1.933 droeschl 5074: .LC_breadcrumb_tools_tools {
5075: padding: 0;
5076: margin: 0;
1.913 droeschl 5077: float: right;
5078: }
5079:
1.359 albertel 5080: table#LC_title_bar td {
5081: background: $tabbg;
5082: }
1.795 www 5083:
1.911 bisitz 5084: table#LC_menubuttons img {
1.803 bisitz 5085: border: none;
1.346 albertel 5086: }
1.795 www 5087:
1.842 droeschl 5088: .LC_breadcrumbs_component {
1.911 bisitz 5089: float: right;
5090: margin: 0 1em;
1.357 albertel 5091: }
1.842 droeschl 5092: .LC_breadcrumbs_component img {
1.911 bisitz 5093: vertical-align: middle;
1.777 tempelho 5094: }
1.795 www 5095:
1.383 albertel 5096: td.LC_table_cell_checkbox {
5097: text-align: center;
5098: }
1.795 www 5099:
5100: .LC_fontsize_small {
1.911 bisitz 5101: font-size: 70%;
1.705 tempelho 5102: }
5103:
1.844 bisitz 5104: #LC_breadcrumbs {
1.911 bisitz 5105: clear:both;
5106: background: $sidebg;
5107: border-bottom: 1px solid $lg_border_color;
5108: line-height: 2.5em;
1.933 droeschl 5109: overflow: hidden;
1.911 bisitz 5110: margin: 0;
5111: padding: 0;
1.819 tempelho 5112: }
1.862 bisitz 5113:
1.839 droeschl 5114: /* Preliminary fix to hide breadcrumbs inside remote control window */
1.844 bisitz 5115: #LC_remote #LC_breadcrumbs {
1.911 bisitz 5116: display:none;
1.839 droeschl 5117: }
1.819 tempelho 5118:
1.844 bisitz 5119: #LC_head_subbox {
1.911 bisitz 5120: clear:both;
5121: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 5122: border: 1px solid $sidebg;
5123: margin: 0 0 10px 0;
1.822 bisitz 5124: }
5125:
1.795 www 5126: .LC_fontsize_medium {
1.911 bisitz 5127: font-size: 85%;
1.705 tempelho 5128: }
5129:
1.795 www 5130: .LC_fontsize_large {
1.911 bisitz 5131: font-size: 120%;
1.705 tempelho 5132: }
5133:
1.346 albertel 5134: .LC_menubuttons_inline_text {
5135: color: $font;
1.698 harmsja 5136: font-size: 90%;
1.701 harmsja 5137: padding-left:3px;
1.346 albertel 5138: }
5139:
1.934 droeschl 5140: .LC_menubuttons_inline_text img{
5141: vertical-align: middle;
5142: }
5143:
1.948.2.1! raeburn 5144: li.LC_menubuttons_inline_text img,a {
! 5145: cursor:pointer;
! 5146: }
! 5147:
1.526 www 5148: .LC_menubuttons_link {
5149: text-decoration: none;
5150: }
1.795 www 5151:
1.522 albertel 5152: .LC_menubuttons_category {
1.521 www 5153: color: $font;
1.526 www 5154: background: $pgbg;
1.521 www 5155: font-size: larger;
5156: font-weight: bold;
5157: }
5158:
1.346 albertel 5159: td.LC_menubuttons_text {
1.911 bisitz 5160: color: $font;
1.346 albertel 5161: }
1.706 harmsja 5162:
1.346 albertel 5163: .LC_current_location {
5164: background: $tabbg;
5165: }
1.795 www 5166:
1.938 bisitz 5167: table.LC_data_table {
1.347 albertel 5168: border: 1px solid #000000;
1.402 albertel 5169: border-collapse: separate;
1.426 albertel 5170: border-spacing: 1px;
1.610 albertel 5171: background: $pgbg;
1.347 albertel 5172: }
1.795 www 5173:
1.422 albertel 5174: .LC_data_table_dense {
5175: font-size: small;
5176: }
1.795 www 5177:
1.507 raeburn 5178: table.LC_nested_outer {
5179: border: 1px solid #000000;
1.589 raeburn 5180: border-collapse: collapse;
1.803 bisitz 5181: border-spacing: 0;
1.507 raeburn 5182: width: 100%;
5183: }
1.795 www 5184:
1.879 raeburn 5185: table.LC_innerpickbox,
1.507 raeburn 5186: table.LC_nested {
1.803 bisitz 5187: border: none;
1.589 raeburn 5188: border-collapse: collapse;
1.803 bisitz 5189: border-spacing: 0;
1.507 raeburn 5190: width: 100%;
5191: }
1.795 www 5192:
1.930 faziophi 5193: .ui-accordion,
5194: .ui-accordion table.LC_data_table,
5195: .ui-accordion table.LC_nested_outer{
5196: border: 0px;
5197: border-spacing: 0px;
5198: margin: 3px;
5199: }
5200:
1.911 bisitz 5201: table.LC_data_table tr th,
5202: table.LC_calendar tr th,
1.879 raeburn 5203: table.LC_prior_tries tr th,
5204: table.LC_innerpickbox tr th {
1.349 albertel 5205: font-weight: bold;
5206: background-color: $data_table_head;
1.801 tempelho 5207: color:$fontmenu;
1.701 harmsja 5208: font-size:90%;
1.347 albertel 5209: }
1.795 www 5210:
1.879 raeburn 5211: table.LC_innerpickbox tr th,
5212: table.LC_innerpickbox tr td {
5213: vertical-align: top;
5214: }
5215:
1.711 raeburn 5216: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 5217: background-color: #CCCCCC;
1.711 raeburn 5218: font-weight: bold;
5219: text-align: left;
5220: }
1.795 www 5221:
1.912 bisitz 5222: table.LC_data_table tr.LC_odd_row > td {
5223: background-color: $data_table_light;
5224: padding: 2px;
5225: vertical-align: top;
5226: }
5227:
1.809 bisitz 5228: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 5229: background-color: $data_table_light;
1.912 bisitz 5230: vertical-align: top;
5231: }
5232:
5233: table.LC_data_table tr.LC_even_row > td {
5234: background-color: $data_table_dark;
1.425 albertel 5235: padding: 2px;
1.900 bisitz 5236: vertical-align: top;
1.347 albertel 5237: }
1.795 www 5238:
1.809 bisitz 5239: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 5240: background-color: $data_table_dark;
1.900 bisitz 5241: vertical-align: top;
1.347 albertel 5242: }
1.795 www 5243:
1.425 albertel 5244: table.LC_data_table tr.LC_data_table_highlight td {
5245: background-color: $data_table_darker;
5246: }
1.795 www 5247:
1.639 raeburn 5248: table.LC_data_table tr td.LC_leftcol_header {
5249: background-color: $data_table_head;
5250: font-weight: bold;
5251: }
1.795 www 5252:
1.451 albertel 5253: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5254: table.LC_nested tr.LC_empty_row td {
1.421 albertel 5255: font-weight: bold;
5256: font-style: italic;
5257: text-align: center;
5258: padding: 8px;
1.347 albertel 5259: }
1.795 www 5260:
1.940 bisitz 5261: table.LC_data_table tr.LC_empty_row td {
5262: background-color: $sidebg;
5263: }
5264:
5265: table.LC_nested tr.LC_empty_row td {
5266: background-color: #FFFFFF;
5267: }
5268:
1.890 droeschl 5269: table.LC_caption {
5270: }
5271:
1.507 raeburn 5272: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5273: padding: 4ex
5274: }
1.795 www 5275:
1.507 raeburn 5276: table.LC_nested_outer tr th {
5277: font-weight: bold;
1.801 tempelho 5278: color:$fontmenu;
1.507 raeburn 5279: background-color: $data_table_head;
1.701 harmsja 5280: font-size: small;
1.507 raeburn 5281: border-bottom: 1px solid #000000;
5282: }
1.795 www 5283:
1.507 raeburn 5284: table.LC_nested_outer tr td.LC_subheader {
5285: background-color: $data_table_head;
5286: font-weight: bold;
5287: font-size: small;
5288: border-bottom: 1px solid #000000;
5289: text-align: right;
1.451 albertel 5290: }
1.795 www 5291:
1.507 raeburn 5292: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5293: background-color: #CCCCCC;
1.451 albertel 5294: font-weight: bold;
5295: font-size: small;
1.507 raeburn 5296: text-align: center;
5297: }
1.795 www 5298:
1.589 raeburn 5299: table.LC_nested tr.LC_info_row td.LC_left_item,
5300: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5301: text-align: left;
1.451 albertel 5302: }
1.795 www 5303:
1.507 raeburn 5304: table.LC_nested td {
1.735 bisitz 5305: background-color: #FFFFFF;
1.451 albertel 5306: font-size: small;
1.507 raeburn 5307: }
1.795 www 5308:
1.507 raeburn 5309: table.LC_nested_outer tr th.LC_right_item,
5310: table.LC_nested tr.LC_info_row td.LC_right_item,
5311: table.LC_nested tr.LC_odd_row td.LC_right_item,
5312: table.LC_nested tr td.LC_right_item {
1.451 albertel 5313: text-align: right;
5314: }
5315:
1.930 faziophi 5316: .ui-accordion table.LC_nested tr.LC_odd_row td.LC_left_item,
5317: .ui-accordion table.LC_nested tr.LC_even_row td.LC_left_item {
5318: text-align: right;
5319: width: 40%;
5320: padding-right:10px;
5321: vertical-align: top;
5322: padding: 5px;
5323: }
5324:
5325: .ui-accordion table.LC_nested tr.LC_odd_row td.LC_right_item,
5326: .ui-accordion table.LC_nested tr.LC_even_row td.LC_right_item {
5327: text-align: left;
5328: width: 60%;
5329: padding: 2px 4px;
5330: }
5331:
1.507 raeburn 5332: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5333: background-color: #EEEEEE;
1.451 albertel 5334: }
5335:
1.473 raeburn 5336: table.LC_createuser {
5337: }
5338:
5339: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5340: font-size: small;
1.473 raeburn 5341: }
5342:
5343: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5344: background-color: #CCCCCC;
1.473 raeburn 5345: font-weight: bold;
5346: text-align: center;
5347: }
5348:
1.349 albertel 5349: table.LC_calendar {
5350: border: 1px solid #000000;
5351: border-collapse: collapse;
1.917 raeburn 5352: width: 98%;
1.349 albertel 5353: }
1.795 www 5354:
1.349 albertel 5355: table.LC_calendar_pickdate {
5356: font-size: xx-small;
5357: }
1.795 www 5358:
1.349 albertel 5359: table.LC_calendar tr td {
5360: border: 1px solid #000000;
5361: vertical-align: top;
1.917 raeburn 5362: width: 14%;
1.349 albertel 5363: }
1.795 www 5364:
1.349 albertel 5365: table.LC_calendar tr td.LC_calendar_day_empty {
5366: background-color: $data_table_dark;
5367: }
1.795 www 5368:
1.779 bisitz 5369: table.LC_calendar tr td.LC_calendar_day_current {
5370: background-color: $data_table_highlight;
1.777 tempelho 5371: }
1.795 www 5372:
1.938 bisitz 5373: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 5374: background-color: $mail_new;
5375: }
1.795 www 5376:
1.938 bisitz 5377: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 5378: background-color: $mail_new_hover;
5379: }
1.795 www 5380:
1.938 bisitz 5381: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 5382: background-color: $mail_read;
5383: }
1.795 www 5384:
1.938 bisitz 5385: /*
5386: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 5387: background-color: $mail_read_hover;
5388: }
1.938 bisitz 5389: */
1.795 www 5390:
1.938 bisitz 5391: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 5392: background-color: $mail_replied;
5393: }
1.795 www 5394:
1.938 bisitz 5395: /*
5396: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 5397: background-color: $mail_replied_hover;
5398: }
1.938 bisitz 5399: */
1.795 www 5400:
1.938 bisitz 5401: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 5402: background-color: $mail_other;
5403: }
1.795 www 5404:
1.938 bisitz 5405: /*
5406: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 5407: background-color: $mail_other_hover;
5408: }
1.938 bisitz 5409: */
1.494 raeburn 5410:
1.777 tempelho 5411: table.LC_data_table tr > td.LC_browser_file,
5412: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 5413: background: #AAEE77;
1.389 albertel 5414: }
1.795 www 5415:
1.777 tempelho 5416: table.LC_data_table tr > td.LC_browser_file_locked,
5417: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5418: background: #FFAA99;
1.387 albertel 5419: }
1.795 www 5420:
1.777 tempelho 5421: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 5422: background: #888888;
1.779 bisitz 5423: }
1.795 www 5424:
1.777 tempelho 5425: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5426: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 5427: background: #F8F866;
1.777 tempelho 5428: }
1.795 www 5429:
1.696 bisitz 5430: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 5431: background: #E0E8FF;
1.387 albertel 5432: }
1.696 bisitz 5433:
1.707 bisitz 5434: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 5435: /* background: #77FF77; */
1.707 bisitz 5436: }
1.795 www 5437:
1.707 bisitz 5438: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 5439: border-right: 8px solid #FFFF77;
1.707 bisitz 5440: }
1.795 www 5441:
1.707 bisitz 5442: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 5443: border-right: 8px solid #FFAA77;
1.707 bisitz 5444: }
1.795 www 5445:
1.707 bisitz 5446: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 5447: border-right: 8px solid #FF7777;
1.707 bisitz 5448: }
1.795 www 5449:
1.707 bisitz 5450: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 5451: border-right: 8px solid #AAFF77;
1.707 bisitz 5452: }
1.795 www 5453:
1.707 bisitz 5454: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 5455: border-right: 8px solid #11CC55;
1.707 bisitz 5456: }
5457:
1.388 albertel 5458: span.LC_current_location {
1.701 harmsja 5459: font-size:larger;
1.388 albertel 5460: background: $pgbg;
5461: }
1.387 albertel 5462:
1.395 albertel 5463: span.LC_parm_menu_item {
5464: font-size: larger;
5465: }
1.795 www 5466:
1.395 albertel 5467: span.LC_parm_scope_all {
5468: color: red;
5469: }
1.795 www 5470:
1.395 albertel 5471: span.LC_parm_scope_folder {
5472: color: green;
5473: }
1.795 www 5474:
1.395 albertel 5475: span.LC_parm_scope_resource {
5476: color: orange;
5477: }
1.795 www 5478:
1.395 albertel 5479: span.LC_parm_part {
5480: color: blue;
5481: }
1.795 www 5482:
1.911 bisitz 5483: span.LC_parm_folder,
5484: span.LC_parm_symb {
1.395 albertel 5485: font-size: x-small;
5486: font-family: $mono;
5487: color: #AAAAAA;
5488: }
5489:
1.795 www 5490: td.LC_parm_overview_level_menu,
5491: td.LC_parm_overview_map_menu,
5492: td.LC_parm_overview_parm_selectors,
5493: td.LC_parm_overview_restrictions {
1.396 albertel 5494: border: 1px solid black;
5495: border-collapse: collapse;
5496: }
1.795 www 5497:
1.396 albertel 5498: table.LC_parm_overview_restrictions td {
5499: border-width: 1px 4px 1px 4px;
5500: border-style: solid;
5501: border-color: $pgbg;
5502: text-align: center;
5503: }
1.795 www 5504:
1.396 albertel 5505: table.LC_parm_overview_restrictions th {
5506: background: $tabbg;
5507: border-width: 1px 4px 1px 4px;
5508: border-style: solid;
5509: border-color: $pgbg;
5510: }
1.795 www 5511:
1.398 albertel 5512: table#LC_helpmenu {
1.803 bisitz 5513: border: none;
1.398 albertel 5514: height: 55px;
1.803 bisitz 5515: border-spacing: 0;
1.398 albertel 5516: }
5517:
5518: table#LC_helpmenu fieldset legend {
5519: font-size: larger;
5520: }
1.795 www 5521:
1.397 albertel 5522: table#LC_helpmenu_links {
5523: width: 100%;
5524: border: 1px solid black;
5525: background: $pgbg;
1.803 bisitz 5526: padding: 0;
1.397 albertel 5527: border-spacing: 1px;
5528: }
1.795 www 5529:
1.397 albertel 5530: table#LC_helpmenu_links tr td {
5531: padding: 1px;
5532: background: $tabbg;
1.399 albertel 5533: text-align: center;
5534: font-weight: bold;
1.397 albertel 5535: }
1.396 albertel 5536:
1.795 www 5537: table#LC_helpmenu_links a:link,
5538: table#LC_helpmenu_links a:visited,
1.397 albertel 5539: table#LC_helpmenu_links a:active {
5540: text-decoration: none;
5541: color: $font;
5542: }
1.795 www 5543:
1.397 albertel 5544: table#LC_helpmenu_links a:hover {
5545: text-decoration: underline;
5546: color: $vlink;
5547: }
1.396 albertel 5548:
1.417 albertel 5549: .LC_chrt_popup_exists {
5550: border: 1px solid #339933;
5551: margin: -1px;
5552: }
1.795 www 5553:
1.417 albertel 5554: .LC_chrt_popup_up {
5555: border: 1px solid yellow;
5556: margin: -1px;
5557: }
1.795 www 5558:
1.417 albertel 5559: .LC_chrt_popup {
5560: border: 1px solid #8888FF;
5561: background: #CCCCFF;
5562: }
1.795 www 5563:
1.421 albertel 5564: table.LC_pick_box {
5565: border-collapse: separate;
5566: background: white;
5567: border: 1px solid black;
5568: border-spacing: 1px;
5569: }
1.795 www 5570:
1.421 albertel 5571: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 5572: background: $sidebg;
1.421 albertel 5573: font-weight: bold;
1.900 bisitz 5574: text-align: left;
1.740 bisitz 5575: vertical-align: top;
1.421 albertel 5576: width: 184px;
5577: padding: 8px;
5578: }
1.795 www 5579:
1.579 raeburn 5580: table.LC_pick_box td.LC_pick_box_value {
5581: text-align: left;
5582: padding: 8px;
5583: }
1.795 www 5584:
1.579 raeburn 5585: table.LC_pick_box td.LC_pick_box_select {
5586: text-align: left;
5587: padding: 8px;
5588: }
1.795 www 5589:
1.424 albertel 5590: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 5591: padding: 0;
1.421 albertel 5592: height: 1px;
5593: background: black;
5594: }
1.795 www 5595:
1.421 albertel 5596: table.LC_pick_box td.LC_pick_box_submit {
5597: text-align: right;
5598: }
1.795 www 5599:
1.579 raeburn 5600: table.LC_pick_box td.LC_evenrow_value {
5601: text-align: left;
5602: padding: 8px;
5603: background-color: $data_table_light;
5604: }
1.795 www 5605:
1.579 raeburn 5606: table.LC_pick_box td.LC_oddrow_value {
5607: text-align: left;
5608: padding: 8px;
5609: background-color: $data_table_light;
5610: }
1.795 www 5611:
1.579 raeburn 5612: span.LC_helpform_receipt_cat {
5613: font-weight: bold;
5614: }
1.795 www 5615:
1.424 albertel 5616: table.LC_group_priv_box {
5617: background: white;
5618: border: 1px solid black;
5619: border-spacing: 1px;
5620: }
1.795 www 5621:
1.424 albertel 5622: table.LC_group_priv_box td.LC_pick_box_title {
5623: background: $tabbg;
5624: font-weight: bold;
5625: text-align: right;
5626: width: 184px;
5627: }
1.795 www 5628:
1.424 albertel 5629: table.LC_group_priv_box td.LC_groups_fixed {
5630: background: $data_table_light;
5631: text-align: center;
5632: }
1.795 www 5633:
1.424 albertel 5634: table.LC_group_priv_box td.LC_groups_optional {
5635: background: $data_table_dark;
5636: text-align: center;
5637: }
1.795 www 5638:
1.424 albertel 5639: table.LC_group_priv_box td.LC_groups_functionality {
5640: background: $data_table_darker;
5641: text-align: center;
5642: font-weight: bold;
5643: }
1.795 www 5644:
1.424 albertel 5645: table.LC_group_priv td {
5646: text-align: left;
1.803 bisitz 5647: padding: 0;
1.424 albertel 5648: }
5649:
1.421 albertel 5650: table.LC_notify_front_page {
5651: background: white;
5652: border: 1px solid black;
5653: padding: 8px;
5654: }
1.795 www 5655:
1.421 albertel 5656: table.LC_notify_front_page td {
5657: padding: 8px;
5658: }
1.795 www 5659:
1.424 albertel 5660: .LC_navbuttons {
5661: margin: 2ex 0ex 2ex 0ex;
5662: }
1.795 www 5663:
1.423 albertel 5664: .LC_topic_bar {
5665: font-weight: bold;
5666: background: $tabbg;
1.918 wenzelju 5667: margin: 1em 0em 1em 2em;
1.805 bisitz 5668: padding: 3px;
1.918 wenzelju 5669: font-size: 1.2em;
1.423 albertel 5670: }
1.795 www 5671:
1.423 albertel 5672: .LC_topic_bar span {
1.918 wenzelju 5673: left: 0.5em;
5674: position: absolute;
1.423 albertel 5675: vertical-align: middle;
1.918 wenzelju 5676: font-size: 1.2em;
1.423 albertel 5677: }
1.795 www 5678:
1.423 albertel 5679: table.LC_course_group_status {
5680: margin: 20px;
5681: }
1.795 www 5682:
1.423 albertel 5683: table.LC_status_selector td {
5684: vertical-align: top;
5685: text-align: center;
1.424 albertel 5686: padding: 4px;
5687: }
1.795 www 5688:
1.599 albertel 5689: div.LC_feedback_link {
1.616 albertel 5690: clear: both;
1.829 kalberla 5691: background: $sidebg;
1.779 bisitz 5692: width: 100%;
1.829 kalberla 5693: padding-bottom: 10px;
5694: border: 1px $tabbg solid;
1.833 kalberla 5695: height: 22px;
5696: line-height: 22px;
5697: padding-top: 5px;
5698: }
5699:
5700: div.LC_feedback_link img {
5701: height: 22px;
1.867 kalberla 5702: vertical-align:middle;
1.829 kalberla 5703: }
5704:
1.911 bisitz 5705: div.LC_feedback_link a {
1.829 kalberla 5706: text-decoration: none;
1.489 raeburn 5707: }
1.795 www 5708:
1.867 kalberla 5709: div.LC_comblock {
1.911 bisitz 5710: display:inline;
1.867 kalberla 5711: color:$font;
5712: font-size:90%;
5713: }
5714:
5715: div.LC_feedback_link div.LC_comblock {
5716: padding-left:5px;
5717: }
5718:
5719: div.LC_feedback_link div.LC_comblock a {
5720: color:$font;
5721: }
5722:
1.489 raeburn 5723: span.LC_feedback_link {
1.858 bisitz 5724: /* background: $feedback_link_bg; */
1.599 albertel 5725: font-size: larger;
5726: }
1.795 www 5727:
1.599 albertel 5728: span.LC_message_link {
1.858 bisitz 5729: /* background: $feedback_link_bg; */
1.599 albertel 5730: font-size: larger;
5731: position: absolute;
5732: right: 1em;
1.489 raeburn 5733: }
1.421 albertel 5734:
1.515 albertel 5735: table.LC_prior_tries {
1.524 albertel 5736: border: 1px solid #000000;
5737: border-collapse: separate;
5738: border-spacing: 1px;
1.515 albertel 5739: }
1.523 albertel 5740:
1.515 albertel 5741: table.LC_prior_tries td {
1.524 albertel 5742: padding: 2px;
1.515 albertel 5743: }
1.523 albertel 5744:
5745: .LC_answer_correct {
1.795 www 5746: background: lightgreen;
5747: color: darkgreen;
5748: padding: 6px;
1.523 albertel 5749: }
1.795 www 5750:
1.523 albertel 5751: .LC_answer_charged_try {
1.797 www 5752: background: #FFAAAA;
1.795 www 5753: color: darkred;
5754: padding: 6px;
1.523 albertel 5755: }
1.795 www 5756:
1.779 bisitz 5757: .LC_answer_not_charged_try,
1.523 albertel 5758: .LC_answer_no_grade,
5759: .LC_answer_late {
1.795 www 5760: background: lightyellow;
1.523 albertel 5761: color: black;
1.795 www 5762: padding: 6px;
1.523 albertel 5763: }
1.795 www 5764:
1.523 albertel 5765: .LC_answer_previous {
1.795 www 5766: background: lightblue;
5767: color: darkblue;
5768: padding: 6px;
1.523 albertel 5769: }
1.795 www 5770:
1.779 bisitz 5771: .LC_answer_no_message {
1.777 tempelho 5772: background: #FFFFFF;
5773: color: black;
1.795 www 5774: padding: 6px;
1.779 bisitz 5775: }
1.795 www 5776:
1.779 bisitz 5777: .LC_answer_unknown {
5778: background: orange;
5779: color: black;
1.795 www 5780: padding: 6px;
1.777 tempelho 5781: }
1.795 www 5782:
1.529 albertel 5783: span.LC_prior_numerical,
5784: span.LC_prior_string,
5785: span.LC_prior_custom,
5786: span.LC_prior_reaction,
5787: span.LC_prior_math {
1.925 bisitz 5788: font-family: $mono;
1.523 albertel 5789: white-space: pre;
5790: }
5791:
1.525 albertel 5792: span.LC_prior_string {
1.925 bisitz 5793: font-family: $mono;
1.525 albertel 5794: white-space: pre;
5795: }
5796:
1.523 albertel 5797: table.LC_prior_option {
5798: width: 100%;
5799: border-collapse: collapse;
5800: }
1.795 www 5801:
1.911 bisitz 5802: table.LC_prior_rank,
1.795 www 5803: table.LC_prior_match {
1.528 albertel 5804: border-collapse: collapse;
5805: }
1.795 www 5806:
1.528 albertel 5807: table.LC_prior_option tr td,
5808: table.LC_prior_rank tr td,
5809: table.LC_prior_match tr td {
1.524 albertel 5810: border: 1px solid #000000;
1.515 albertel 5811: }
5812:
1.855 bisitz 5813: .LC_nobreak {
1.544 albertel 5814: white-space: nowrap;
1.519 raeburn 5815: }
5816:
1.576 raeburn 5817: span.LC_cusr_emph {
5818: font-style: italic;
5819: }
5820:
1.633 raeburn 5821: span.LC_cusr_subheading {
5822: font-weight: normal;
5823: font-size: 85%;
5824: }
5825:
1.861 bisitz 5826: div.LC_docs_entry_move {
1.859 bisitz 5827: border: 1px solid #BBBBBB;
1.545 albertel 5828: background: #DDDDDD;
1.861 bisitz 5829: width: 22px;
1.859 bisitz 5830: padding: 1px;
5831: margin: 0;
1.545 albertel 5832: }
5833:
1.861 bisitz 5834: table.LC_data_table tr > td.LC_docs_entry_commands,
5835: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 5836: background: #DDDDDD;
5837: font-size: x-small;
5838: }
1.795 www 5839:
1.861 bisitz 5840: .LC_docs_entry_parameter {
5841: white-space: nowrap;
5842: }
5843:
1.544 albertel 5844: .LC_docs_copy {
1.545 albertel 5845: color: #000099;
1.544 albertel 5846: }
1.795 www 5847:
1.544 albertel 5848: .LC_docs_cut {
1.545 albertel 5849: color: #550044;
1.544 albertel 5850: }
1.795 www 5851:
1.544 albertel 5852: .LC_docs_rename {
1.545 albertel 5853: color: #009900;
1.544 albertel 5854: }
1.795 www 5855:
1.544 albertel 5856: .LC_docs_remove {
1.545 albertel 5857: color: #990000;
5858: }
5859:
1.547 albertel 5860: .LC_docs_reinit_warn,
5861: .LC_docs_ext_edit {
5862: font-size: x-small;
5863: }
5864:
1.545 albertel 5865: table.LC_docs_adddocs td,
5866: table.LC_docs_adddocs th {
5867: border: 1px solid #BBBBBB;
5868: padding: 4px;
5869: background: #DDDDDD;
1.543 albertel 5870: }
5871:
1.584 albertel 5872: table.LC_sty_begin {
5873: background: #BBFFBB;
5874: }
1.795 www 5875:
1.584 albertel 5876: table.LC_sty_end {
5877: background: #FFBBBB;
5878: }
5879:
1.589 raeburn 5880: table.LC_double_column {
1.803 bisitz 5881: border-width: 0;
1.589 raeburn 5882: border-collapse: collapse;
5883: width: 100%;
5884: padding: 2px;
5885: }
5886:
5887: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5888: top: 2px;
1.589 raeburn 5889: left: 2px;
5890: width: 47%;
5891: vertical-align: top;
5892: }
5893:
5894: table.LC_double_column tr td.LC_right_col {
5895: top: 2px;
1.779 bisitz 5896: right: 2px;
1.589 raeburn 5897: width: 47%;
5898: vertical-align: top;
5899: }
5900:
1.591 raeburn 5901: div.LC_left_float {
5902: float: left;
5903: padding-right: 5%;
1.597 albertel 5904: padding-bottom: 4px;
1.591 raeburn 5905: }
5906:
5907: div.LC_clear_float_header {
1.597 albertel 5908: padding-bottom: 2px;
1.591 raeburn 5909: }
5910:
5911: div.LC_clear_float_footer {
1.597 albertel 5912: padding-top: 10px;
1.591 raeburn 5913: clear: both;
5914: }
5915:
1.597 albertel 5916: div.LC_grade_show_user {
1.941 bisitz 5917: /* border-left: 5px solid $sidebg; */
5918: border-top: 5px solid #000000;
5919: margin: 50px 0 0 0;
1.936 bisitz 5920: padding: 15px 0 5px 10px;
1.597 albertel 5921: }
1.795 www 5922:
1.936 bisitz 5923: div.LC_grade_show_user_odd_row {
1.941 bisitz 5924: /* border-left: 5px solid #000000; */
5925: }
5926:
5927: div.LC_grade_show_user div.LC_Box {
5928: margin-right: 50px;
1.597 albertel 5929: }
5930:
5931: div.LC_grade_submissions,
5932: div.LC_grade_message_center,
1.936 bisitz 5933: div.LC_grade_info_links {
1.597 albertel 5934: margin: 5px;
5935: width: 99%;
5936: background: #FFFFFF;
5937: }
1.795 www 5938:
1.597 albertel 5939: div.LC_grade_submissions_header,
1.936 bisitz 5940: div.LC_grade_message_center_header {
1.705 tempelho 5941: font-weight: bold;
5942: font-size: large;
1.597 albertel 5943: }
1.795 www 5944:
1.597 albertel 5945: div.LC_grade_submissions_body,
1.936 bisitz 5946: div.LC_grade_message_center_body {
1.597 albertel 5947: border: 1px solid black;
5948: width: 99%;
5949: background: #FFFFFF;
5950: }
1.795 www 5951:
1.613 albertel 5952: table.LC_scantron_action {
5953: width: 100%;
5954: }
1.795 www 5955:
1.613 albertel 5956: table.LC_scantron_action tr th {
1.698 harmsja 5957: font-weight:bold;
5958: font-style:normal;
1.613 albertel 5959: }
1.795 www 5960:
1.779 bisitz 5961: .LC_edit_problem_header,
1.614 albertel 5962: div.LC_edit_problem_footer {
1.705 tempelho 5963: font-weight: normal;
5964: font-size: medium;
1.602 albertel 5965: margin: 2px;
1.600 albertel 5966: }
1.795 www 5967:
1.600 albertel 5968: div.LC_edit_problem_header,
1.602 albertel 5969: div.LC_edit_problem_header div,
1.614 albertel 5970: div.LC_edit_problem_footer,
5971: div.LC_edit_problem_footer div,
1.602 albertel 5972: div.LC_edit_problem_editxml_header,
5973: div.LC_edit_problem_editxml_header div {
1.600 albertel 5974: margin-top: 5px;
5975: }
1.795 www 5976:
1.600 albertel 5977: div.LC_edit_problem_header_title {
1.705 tempelho 5978: font-weight: bold;
5979: font-size: larger;
1.602 albertel 5980: background: $tabbg;
5981: padding: 3px;
5982: }
1.795 www 5983:
1.602 albertel 5984: table.LC_edit_problem_header_title {
5985: width: 100%;
1.600 albertel 5986: background: $tabbg;
1.602 albertel 5987: }
5988:
5989: div.LC_edit_problem_discards {
5990: float: left;
5991: padding-bottom: 5px;
5992: }
1.795 www 5993:
1.602 albertel 5994: div.LC_edit_problem_saves {
5995: float: right;
5996: padding-bottom: 5px;
1.600 albertel 5997: }
1.795 www 5998:
1.911 bisitz 5999: img.stift {
1.803 bisitz 6000: border-width: 0;
6001: vertical-align: middle;
1.677 riegler 6002: }
1.680 riegler 6003:
1.923 bisitz 6004: table td.LC_mainmenu_col_fieldset {
1.680 riegler 6005: vertical-align: top;
1.777 tempelho 6006: }
1.795 www 6007:
1.716 raeburn 6008: div.LC_createcourse {
1.911 bisitz 6009: margin: 10px 10px 10px 10px;
1.716 raeburn 6010: }
6011:
1.917 raeburn 6012: .LC_dccid {
6013: margin: 0.2em 0 0 0;
6014: padding: 0;
6015: font-size: 90%;
6016: display:none;
6017: }
6018:
1.698 harmsja 6019: a:hover,
1.897 wenzelju 6020: ol.LC_primary_menu a:hover,
1.721 harmsja 6021: ol#LC_MenuBreadcrumbs a:hover,
6022: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 6023: ul#LC_secondary_menu a:hover,
1.721 harmsja 6024: .LC_FormSectionClearButton input:hover
1.795 www 6025: ul.LC_TabContent li:hover a {
1.948.2.1! raeburn 6026: color:$button_hover;
1.911 bisitz 6027: text-decoration:none;
1.693 droeschl 6028: }
6029:
1.779 bisitz 6030: h1 {
1.911 bisitz 6031: padding: 0;
6032: line-height:130%;
1.693 droeschl 6033: }
1.698 harmsja 6034:
1.911 bisitz 6035: h2,
6036: h3,
6037: h4,
6038: h5,
6039: h6 {
6040: margin: 5px 0 5px 0;
6041: padding: 0;
6042: line-height:130%;
1.693 droeschl 6043: }
1.795 www 6044:
6045: .LC_hcell {
1.911 bisitz 6046: padding:3px 15px 3px 15px;
6047: margin: 0;
6048: background-color:$tabbg;
6049: color:$fontmenu;
6050: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 6051: }
1.795 www 6052:
1.840 bisitz 6053: .LC_Box > .LC_hcell {
1.911 bisitz 6054: margin: 0 -10px 10px -10px;
1.835 bisitz 6055: }
6056:
1.721 harmsja 6057: .LC_noBorder {
1.911 bisitz 6058: border: 0;
1.698 harmsja 6059: }
1.693 droeschl 6060:
1.721 harmsja 6061: .LC_FormSectionClearButton input {
1.911 bisitz 6062: background-color:transparent;
6063: border: none;
6064: cursor:pointer;
6065: text-decoration:underline;
1.693 droeschl 6066: }
1.763 bisitz 6067:
6068: .LC_help_open_topic {
1.911 bisitz 6069: color: #FFFFFF;
6070: background-color: #EEEEFF;
6071: margin: 1px;
6072: padding: 4px;
6073: border: 1px solid #000033;
6074: white-space: nowrap;
6075: /* vertical-align: middle; */
1.759 neumanie 6076: }
1.693 droeschl 6077:
1.911 bisitz 6078: dl,
6079: ul,
6080: div,
6081: fieldset {
6082: margin: 10px 10px 10px 0;
6083: /* overflow: hidden; */
1.693 droeschl 6084: }
1.795 www 6085:
1.838 bisitz 6086: fieldset > legend {
1.911 bisitz 6087: font-weight: bold;
6088: padding: 0 5px 0 5px;
1.838 bisitz 6089: }
6090:
1.813 bisitz 6091: #LC_nav_bar {
1.911 bisitz 6092: float: left;
1.934 droeschl 6093: margin: 0;
1.807 droeschl 6094: }
6095:
1.916 droeschl 6096: #LC_realm {
6097: margin: 0.2em 0 0 0;
6098: padding: 0;
6099: font-weight: bold;
6100: text-align: center;
6101: }
6102:
1.911 bisitz 6103: #LC_nav_bar em {
6104: font-weight: bold;
6105: font-style: normal;
1.807 droeschl 6106: }
6107:
1.897 wenzelju 6108: ol.LC_primary_menu {
1.911 bisitz 6109: float: right;
1.934 droeschl 6110: margin: 0;
1.807 droeschl 6111: }
6112:
1.929 wenzelju 6113: span.LC_new_message{
6114: font-weight:bold;
6115: color: darkred;
6116: }
6117:
1.852 droeschl 6118: ol#LC_PathBreadcrumbs {
1.911 bisitz 6119: margin: 0;
1.693 droeschl 6120: }
6121:
1.897 wenzelju 6122: ol.LC_primary_menu li {
1.911 bisitz 6123: display: inline;
6124: padding: 5px 5px 0 10px;
6125: vertical-align: top;
1.693 droeschl 6126: }
6127:
1.897 wenzelju 6128: ol.LC_primary_menu li img {
1.911 bisitz 6129: vertical-align: bottom;
1.934 droeschl 6130: height: 1.1em;
1.693 droeschl 6131: }
6132:
1.897 wenzelju 6133: ol.LC_primary_menu a {
1.911 bisitz 6134: color: RGB(80, 80, 80);
6135: text-decoration: none;
1.693 droeschl 6136: }
1.795 www 6137:
1.897 wenzelju 6138: ul#LC_secondary_menu {
1.911 bisitz 6139: clear: both;
6140: color: $fontmenu;
6141: background: $tabbg;
6142: list-style: none;
6143: padding: 0;
6144: margin: 0;
6145: width: 100%;
1.808 droeschl 6146: }
6147:
1.897 wenzelju 6148: ul#LC_secondary_menu li {
1.911 bisitz 6149: font-weight: bold;
6150: line-height: 1.8em;
6151: padding: 0 0.8em;
6152: border-right: 1px solid black;
6153: display: inline;
6154: vertical-align: middle;
1.807 droeschl 6155: }
6156:
1.847 tempelho 6157: ul.LC_TabContent {
1.911 bisitz 6158: display:block;
6159: background: $sidebg;
6160: border-bottom: solid 1px $lg_border_color;
6161: list-style:none;
6162: margin: 0 -10px;
6163: padding: 0;
1.693 droeschl 6164: }
6165:
1.795 www 6166: ul.LC_TabContent li,
6167: ul.LC_TabContentBigger li {
1.911 bisitz 6168: float:left;
1.741 harmsja 6169: }
1.795 www 6170:
1.897 wenzelju 6171: ul#LC_secondary_menu li a {
1.911 bisitz 6172: color: $fontmenu;
6173: text-decoration: none;
1.693 droeschl 6174: }
1.795 www 6175:
1.721 harmsja 6176: ul.LC_TabContent {
1.948.2.1! raeburn 6177: min-height:20px;
1.721 harmsja 6178: }
1.795 www 6179:
6180: ul.LC_TabContent li {
1.911 bisitz 6181: vertical-align:middle;
6182: padding: 0 10px 0 10px;
6183: background-color:$tabbg;
6184: border-bottom:solid 1px $lg_border_color;
1.948.2.1! raeburn 6185: border-right: solid 1px $font;
1.721 harmsja 6186: }
1.795 www 6187:
1.847 tempelho 6188: ul.LC_TabContent .right {
1.911 bisitz 6189: float:right;
1.847 tempelho 6190: }
6191:
1.911 bisitz 6192: ul.LC_TabContent li a,
6193: ul.LC_TabContent li {
6194: color:rgb(47,47,47);
6195: text-decoration:none;
6196: font-size:95%;
6197: font-weight:bold;
6198: padding-right: 16px;
1.948.2.1! raeburn 6199: min-height:20px;
! 6200: }
! 6201:
! 6202: ul.LC_TabContent li a:hover {
! 6203: color: $button_hover;
! 6204: }
! 6205:
! 6206: ul.LC_TabContent li:hover {
! 6207: color: $button_hover;
! 6208: cursor:pointer;
1.721 harmsja 6209: }
1.795 www 6210:
1.911 bisitz 6211: ul.LC_TabContent li.active {
1.948.2.1! raeburn 6212: color: $font;
1.911 bisitz 6213: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.948.2.1! raeburn 6214: border-bottom:solid 1px #FFFFFF;
! 6215: cursor: default;
1.744 ehlerst 6216: }
1.795 www 6217:
1.870 tempelho 6218: #maincoursedoc {
1.911 bisitz 6219: clear:both;
1.870 tempelho 6220: }
6221:
6222: ul.LC_TabContentBigger {
1.911 bisitz 6223: display:block;
6224: list-style:none;
6225: padding: 0;
1.870 tempelho 6226: }
6227:
1.795 www 6228: ul.LC_TabContentBigger li {
1.911 bisitz 6229: vertical-align:bottom;
6230: height: 30px;
6231: font-size:110%;
6232: font-weight:bold;
6233: color: #737373;
1.841 tempelho 6234: }
6235:
1.870 tempelho 6236:
6237: ul.LC_TabContentBigger li a {
1.911 bisitz 6238: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6239: height: 30px;
6240: line-height: 30px;
6241: text-align: center;
6242: display: block;
6243: text-decoration: none;
1.741 harmsja 6244: }
1.795 www 6245:
1.911 bisitz 6246: ul.LC_TabContentBigger li:hover a,
1.870 tempelho 6247: ul.LC_TabContentBigger li.active a {
1.911 bisitz 6248: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6249: color:$font;
6250: text-decoration: underline;
1.744 ehlerst 6251: }
1.795 www 6252:
1.870 tempelho 6253:
6254: ul.LC_TabContentBigger li b {
1.911 bisitz 6255: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
6256: display: block;
6257: float: left;
6258: padding: 0 30px;
1.870 tempelho 6259: }
6260:
6261: ul.LC_TabContentBigger li:hover b,
6262: ul.LC_TabContentBigger li.active b {
1.911 bisitz 6263: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
6264: color:$font;
6265: border-bottom: 1px solid #FFFFFF;
1.741 harmsja 6266: }
1.693 droeschl 6267:
1.870 tempelho 6268:
1.862 bisitz 6269: ul.LC_CourseBreadcrumbs {
6270: background: $sidebg;
6271: line-height: 32px;
6272: padding-left: 10px;
6273: margin: 0 0 10px 0;
6274: list-style-position: inside;
6275:
6276: }
6277:
1.911 bisitz 6278: ol#LC_MenuBreadcrumbs,
1.862 bisitz 6279: ol#LC_PathBreadcrumbs {
1.911 bisitz 6280: padding-left: 10px;
6281: margin: 0;
1.933 droeschl 6282: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 6283: }
6284:
1.911 bisitz 6285: ol#LC_MenuBreadcrumbs li,
6286: ol#LC_PathBreadcrumbs li,
1.862 bisitz 6287: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 6288: display: inline;
1.933 droeschl 6289: white-space: normal;
1.693 droeschl 6290: }
6291:
1.823 bisitz 6292: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 6293: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 6294: text-decoration: none;
6295: font-size:90%;
1.693 droeschl 6296: }
1.795 www 6297:
6298: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 6299: text-decoration:none;
6300: font-size:100%;
6301: font-weight:bold;
1.693 droeschl 6302: }
1.795 www 6303:
1.840 bisitz 6304: .LC_Box {
1.911 bisitz 6305: border: solid 1px $lg_border_color;
6306: padding: 0 10px 10px 10px;
1.746 neumanie 6307: }
1.795 www 6308:
6309: .LC_AboutMe_Image {
1.911 bisitz 6310: float:left;
6311: margin-right:10px;
1.747 neumanie 6312: }
1.795 www 6313:
6314: .LC_Clear_AboutMe_Image {
1.911 bisitz 6315: clear:left;
1.747 neumanie 6316: }
1.795 www 6317:
1.721 harmsja 6318: dl.LC_ListStyleClean dt {
1.911 bisitz 6319: padding-right: 5px;
6320: display: table-header-group;
1.693 droeschl 6321: }
6322:
1.721 harmsja 6323: dl.LC_ListStyleClean dd {
1.911 bisitz 6324: display: table-row;
1.693 droeschl 6325: }
6326:
1.721 harmsja 6327: .LC_ListStyleClean,
6328: .LC_ListStyleSimple,
6329: .LC_ListStyleNormal,
1.795 www 6330: .LC_ListStyleSpecial {
1.911 bisitz 6331: /* display:block; */
6332: list-style-position: inside;
6333: list-style-type: none;
6334: overflow: hidden;
6335: padding: 0;
1.693 droeschl 6336: }
6337:
1.721 harmsja 6338: .LC_ListStyleSimple li,
6339: .LC_ListStyleSimple dd,
6340: .LC_ListStyleNormal li,
6341: .LC_ListStyleNormal dd,
6342: .LC_ListStyleSpecial li,
1.795 www 6343: .LC_ListStyleSpecial dd {
1.911 bisitz 6344: margin: 0;
6345: padding: 5px 5px 5px 10px;
6346: clear: both;
1.693 droeschl 6347: }
6348:
1.721 harmsja 6349: .LC_ListStyleClean li,
6350: .LC_ListStyleClean dd {
1.911 bisitz 6351: padding-top: 0;
6352: padding-bottom: 0;
1.693 droeschl 6353: }
6354:
1.721 harmsja 6355: .LC_ListStyleSimple dd,
1.795 www 6356: .LC_ListStyleSimple li {
1.911 bisitz 6357: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6358: }
6359:
1.721 harmsja 6360: .LC_ListStyleSpecial li,
6361: .LC_ListStyleSpecial dd {
1.911 bisitz 6362: list-style-type: none;
6363: background-color: RGB(220, 220, 220);
6364: margin-bottom: 4px;
1.693 droeschl 6365: }
6366:
1.721 harmsja 6367: table.LC_SimpleTable {
1.911 bisitz 6368: margin:5px;
6369: border:solid 1px $lg_border_color;
1.795 www 6370: }
1.693 droeschl 6371:
1.721 harmsja 6372: table.LC_SimpleTable tr {
1.911 bisitz 6373: padding: 0;
6374: border:solid 1px $lg_border_color;
1.693 droeschl 6375: }
1.795 www 6376:
6377: table.LC_SimpleTable thead {
1.911 bisitz 6378: background:rgb(220,220,220);
1.693 droeschl 6379: }
6380:
1.721 harmsja 6381: div.LC_columnSection {
1.911 bisitz 6382: display: block;
6383: clear: both;
6384: overflow: hidden;
6385: margin: 0;
1.693 droeschl 6386: }
6387:
1.721 harmsja 6388: div.LC_columnSection>* {
1.911 bisitz 6389: float: left;
6390: margin: 10px 20px 10px 0;
6391: overflow:hidden;
1.693 droeschl 6392: }
1.721 harmsja 6393:
1.694 tempelho 6394: .LC_loginpage_container {
1.911 bisitz 6395: text-align:left;
6396: margin : 0 auto;
6397: width:90%;
6398: padding: 10px;
6399: height: auto;
6400: background-color:#FFFFFF;
6401: border:1px solid #CCCCCC;
1.694 tempelho 6402: }
6403:
6404:
6405: .LC_loginpage_loginContainer {
1.911 bisitz 6406: float:left;
6407: width: 182px;
6408: padding: 2px;
6409: border:1px solid #CCCCCC;
6410: background-color:$loginbg;
1.694 tempelho 6411: }
6412:
1.795 www 6413: .LC_loginpage_loginContainer h2 {
1.911 bisitz 6414: margin-top: 0;
6415: display:block;
6416: background:$bgcol;
6417: color:$textcol;
6418: padding-left:5px;
1.712 muellerd 6419: }
1.785 tempelho 6420:
1.694 tempelho 6421: .LC_loginpage_loginInfo {
1.911 bisitz 6422: float:left;
6423: width:182px;
6424: border:1px solid #CCCCCC;
6425: padding:2px;
1.712 muellerd 6426: }
6427:
1.694 tempelho 6428: .LC_loginpage_space {
1.911 bisitz 6429: clear: both;
6430: margin-bottom: 20px;
6431: border-bottom: 1px solid #CCCCCC;
1.694 tempelho 6432: }
6433:
1.785 tempelho 6434: .LC_loginpage_floatLeft {
1.911 bisitz 6435: float: left;
6436: width: 200px;
6437: margin: 0;
1.785 tempelho 6438: }
6439:
1.795 www 6440: table em {
1.911 bisitz 6441: font-weight: bold;
6442: font-style: normal;
1.748 schulted 6443: }
1.795 www 6444:
1.779 bisitz 6445: table.LC_tableBrowseRes,
1.795 www 6446: table.LC_tableOfContent {
1.911 bisitz 6447: border:none;
6448: border-spacing: 1px;
6449: padding: 3px;
6450: background-color: #FFFFFF;
6451: font-size: 90%;
1.753 droeschl 6452: }
1.789 droeschl 6453:
1.911 bisitz 6454: table.LC_tableOfContent {
6455: border-collapse: collapse;
1.789 droeschl 6456: }
6457:
1.771 droeschl 6458: table.LC_tableBrowseRes a,
1.768 schulted 6459: table.LC_tableOfContent a {
1.911 bisitz 6460: background-color: transparent;
6461: text-decoration: none;
1.753 droeschl 6462: }
6463:
1.795 www 6464: table.LC_tableOfContent img {
1.911 bisitz 6465: border: none;
6466: height: 1.3em;
6467: vertical-align: text-bottom;
6468: margin-right: 0.3em;
1.753 droeschl 6469: }
1.757 schulted 6470:
1.795 www 6471: a#LC_content_toolbar_firsthomework {
1.911 bisitz 6472: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 6473: }
6474:
1.795 www 6475: a#LC_content_toolbar_launchnav {
1.911 bisitz 6476: background-image:url(/res/adm/pages/start-navigation.gif);
1.774 ehlerst 6477: }
6478:
1.795 www 6479: a#LC_content_toolbar_closenav {
1.911 bisitz 6480: background-image:url(/res/adm/pages/close-navigation.gif);
1.774 ehlerst 6481: }
6482:
1.795 www 6483: a#LC_content_toolbar_everything {
1.911 bisitz 6484: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 6485: }
6486:
1.795 www 6487: a#LC_content_toolbar_uncompleted {
1.911 bisitz 6488: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 6489: }
6490:
1.795 www 6491: #LC_content_toolbar_clearbubbles {
1.911 bisitz 6492: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 6493: }
6494:
1.795 www 6495: a#LC_content_toolbar_changefolder {
1.911 bisitz 6496: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 6497: }
6498:
1.795 www 6499: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 6500: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 6501: }
6502:
1.795 www 6503: ul#LC_toolbar li a:hover {
1.911 bisitz 6504: background-position: bottom center;
1.757 schulted 6505: }
6506:
1.795 www 6507: ul#LC_toolbar {
1.911 bisitz 6508: padding: 0;
6509: margin: 2px;
6510: list-style:none;
6511: position:relative;
6512: background-color:white;
1.757 schulted 6513: }
6514:
1.795 www 6515: ul#LC_toolbar li {
1.911 bisitz 6516: border:1px solid white;
6517: padding: 0;
6518: margin: 0;
6519: float: left;
6520: display:inline;
6521: vertical-align:middle;
6522: }
1.757 schulted 6523:
1.783 amueller 6524:
1.795 www 6525: a.LC_toolbarItem {
1.911 bisitz 6526: display:block;
6527: padding: 0;
6528: margin: 0;
6529: height: 32px;
6530: width: 32px;
6531: color:white;
6532: border: none;
6533: background-repeat:no-repeat;
6534: background-color:transparent;
1.757 schulted 6535: }
6536:
1.915 droeschl 6537: ul.LC_funclist {
6538: margin: 0;
6539: padding: 0.5em 1em 0.5em 0;
6540: }
6541:
1.933 droeschl 6542: ul.LC_funclist > li:first-child {
6543: font-weight:bold;
6544: margin-left:0.8em;
6545: }
6546:
1.915 droeschl 6547: ul.LC_funclist + ul.LC_funclist {
6548: /*
6549: left border as a seperator if we have more than
6550: one list
6551: */
6552: border-left: 1px solid $sidebg;
6553: /*
6554: this hides the left border behind the border of the
6555: outer box if element is wrapped to the next 'line'
6556: */
6557: margin-left: -1px;
6558: }
6559:
1.843 bisitz 6560: ul.LC_funclist li {
1.915 droeschl 6561: display: inline;
1.782 bisitz 6562: white-space: nowrap;
1.915 droeschl 6563: margin: 0 0 0 25px;
6564: line-height: 150%;
1.782 bisitz 6565: }
6566:
1.930 faziophi 6567: .ui-accordion .LC_advanced_toggle {
6568: float: right;
6569: font-size: 90%;
6570: padding: 0px 4px
6571: }
1.757 schulted 6572:
1.343 albertel 6573: END
6574: }
6575:
1.306 albertel 6576: =pod
6577:
6578: =item * &headtag()
6579:
6580: Returns a uniform footer for LON-CAPA web pages.
6581:
1.307 albertel 6582: Inputs: $title - optional title for the head
6583: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 6584: $args - optional arguments
1.319 albertel 6585: force_register - if is true call registerurl so the remote is
6586: informed
1.415 albertel 6587: redirect -> array ref of
6588: 1- seconds before redirect occurs
6589: 2- url to redirect to
6590: 3- whether the side effect should occur
1.315 albertel 6591: (side effect of setting
6592: $env{'internal.head.redirect'} to the url
6593: redirected too)
1.352 albertel 6594: domain -> force to color decorate a page for a specific
6595: domain
6596: function -> force usage of a specific rolish color scheme
6597: bgcolor -> override the default page bgcolor
1.460 albertel 6598: no_auto_mt_title
6599: -> prevent &mt()ing the title arg
1.464 albertel 6600:
1.306 albertel 6601: =cut
6602:
6603: sub headtag {
1.313 albertel 6604: my ($title,$head_extra,$args) = @_;
1.306 albertel 6605:
1.363 albertel 6606: my $function = $args->{'function'} || &get_users_function();
6607: my $domain = $args->{'domain'} || &determinedomain();
6608: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 6609: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 6610: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 6611: #time(),
1.418 albertel 6612: $env{'environment.color.timestamp'},
1.363 albertel 6613: $function,$domain,$bgcolor);
6614:
1.369 www 6615: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 6616:
1.308 albertel 6617: my $result =
6618: '<head>'.
1.461 albertel 6619: &font_settings();
1.319 albertel 6620:
1.461 albertel 6621: if (!$args->{'frameset'}) {
6622: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
6623: }
1.319 albertel 6624: if ($args->{'force_register'}) {
6625: $result .= &Apache::lonmenu::registerurl(1);
6626: }
1.436 albertel 6627: if (!$args->{'no_nav_bar'}
6628: && !$args->{'only_body'}
6629: && !$args->{'frameset'}) {
6630: $result .= &help_menu_js();
6631: }
1.319 albertel 6632:
1.314 albertel 6633: if (ref($args->{'redirect'})) {
1.414 albertel 6634: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 6635: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 6636: if (!$inhibit_continue) {
6637: $env{'internal.head.redirect'} = $url;
6638: }
1.313 albertel 6639: $result.=<<ADDMETA
6640: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 6641: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 6642: ADDMETA
6643: }
1.306 albertel 6644: if (!defined($title)) {
6645: $title = 'The LearningOnline Network with CAPA';
6646: }
1.460 albertel 6647: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
6648: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 6649: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
6650: .$head_extra;
1.306 albertel 6651: return $result;
6652: }
6653:
6654: =pod
6655:
1.340 albertel 6656: =item * &font_settings()
6657:
6658: Returns neccessary <meta> to set the proper encoding
6659:
6660: Inputs: none
6661:
6662: =cut
6663:
6664: sub font_settings {
6665: my $headerstring='';
1.647 www 6666: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 6667: $headerstring.=
6668: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
6669: }
6670: return $headerstring;
6671: }
6672:
1.341 albertel 6673: =pod
6674:
6675: =item * &xml_begin()
6676:
6677: Returns the needed doctype and <html>
6678:
6679: Inputs: none
6680:
6681: =cut
6682:
6683: sub xml_begin {
6684: my $output='';
6685:
1.592 albertel 6686: if ($env{'internal.start_page'}==1) {
6687: &Apache::lonhtmlcommon::init_htmlareafields();
6688: }
1.342 albertel 6689:
1.341 albertel 6690: if ($env{'browser.mathml'}) {
6691: $output='<?xml version="1.0"?>'
6692: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
6693: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
6694:
6695: # .'<!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">] >'
6696: .'<!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">'
6697: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
6698: .'xmlns="http://www.w3.org/1999/xhtml">';
6699: } else {
1.849 bisitz 6700: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
6701: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341 albertel 6702: }
6703: return $output;
6704: }
1.340 albertel 6705:
6706: =pod
6707:
1.306 albertel 6708: =item * &endheadtag()
6709:
6710: Returns a uniform </head> for LON-CAPA web pages.
6711:
6712: Inputs: none
6713:
6714: =cut
6715:
6716: sub endheadtag {
6717: return '</head>';
6718: }
6719:
6720: =pod
6721:
6722: =item * &head()
6723:
6724: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
6725:
1.648 raeburn 6726: Inputs:
6727:
6728: =over 4
6729:
6730: $title - optional title for the page
6731:
6732: $head_extra - optional extra HTML to put inside the <head>
6733:
6734: =back
1.405 albertel 6735:
1.306 albertel 6736: =cut
6737:
6738: sub head {
1.325 albertel 6739: my ($title,$head_extra,$args) = @_;
6740: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 6741: }
6742:
6743: =pod
6744:
6745: =item * &start_page()
6746:
6747: Returns a complete <html> .. <body> section for LON-CAPA web pages.
6748:
1.648 raeburn 6749: Inputs:
6750:
6751: =over 4
6752:
6753: $title - optional title for the page
6754:
6755: $head_extra - optional extra HTML to incude inside the <head>
6756:
6757: $args - additional optional args supported are:
6758:
6759: =over 8
6760:
6761: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 6762: arg on
1.814 bisitz 6763: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 6764: add_entries -> additional attributes to add to the <body>
6765: domain -> force to color decorate a page for a
1.317 albertel 6766: specific domain
1.648 raeburn 6767: function -> force usage of a specific rolish color
1.317 albertel 6768: scheme
1.648 raeburn 6769: redirect -> see &headtag()
6770: bgcolor -> override the default page bg color
6771: js_ready -> return a string ready for being used in
1.317 albertel 6772: a javascript writeln
1.648 raeburn 6773: html_encode -> return a string ready for being used in
1.320 albertel 6774: a html attribute
1.648 raeburn 6775: force_register -> if is true will turn on the &bodytag()
1.317 albertel 6776: $forcereg arg
1.648 raeburn 6777: frameset -> if true will start with a <frameset>
1.330 albertel 6778: rather than <body>
1.648 raeburn 6779: skip_phases -> hash ref of
1.338 albertel 6780: head -> skip the <html><head> generation
6781: body -> skip all <body> generation
1.648 raeburn 6782: no_inline_link -> if true and in remote mode, don't show the
1.361 albertel 6783: 'Switch To Inline Menu' link
1.648 raeburn 6784: no_auto_mt_title -> prevent &mt()ing the title arg
6785: inherit_jsmath -> when creating popup window in a page,
6786: should it have jsmath forced on by the
6787: current page
1.867 kalberla 6788: bread_crumbs -> Array containing breadcrumbs
6789: bread_crumbs_components -> if exists show it as headline else show only the breadcrumbs
1.361 albertel 6790:
1.648 raeburn 6791: =back
1.460 albertel 6792:
1.648 raeburn 6793: =back
1.562 albertel 6794:
1.306 albertel 6795: =cut
6796:
6797: sub start_page {
1.309 albertel 6798: my ($title,$head_extra,$args) = @_;
1.318 albertel 6799: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 6800: my %head_args;
1.352 albertel 6801: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6802: 'bgcolor','frameset','no_nav_bar','only_body',
6803: 'no_auto_mt_title') {
1.319 albertel 6804: if (defined($args->{$arg})) {
1.324 raeburn 6805: $head_args{$arg} = $args->{$arg};
1.319 albertel 6806: }
1.313 albertel 6807: }
1.319 albertel 6808:
1.315 albertel 6809: $env{'internal.start_page'}++;
1.338 albertel 6810: my $result;
6811: if (! exists($args->{'skip_phases'}{'head'}) ) {
6812: $result.=
1.341 albertel 6813: &xml_begin().
1.338 albertel 6814: &headtag($title,$head_extra,\%head_args).&endheadtag();
6815: }
6816:
6817: if (! exists($args->{'skip_phases'}{'body'}) ) {
6818: if ($args->{'frameset'}) {
6819: my $attr_string = &make_attr_string($args->{'force_register'},
6820: $args->{'add_entries'});
6821: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 6822: } else {
6823: $result .=
6824: &bodytag($title,
6825: $args->{'function'}, $args->{'add_entries'},
6826: $args->{'only_body'}, $args->{'domain'},
6827: $args->{'force_register'}, $args->{'no_nav_bar'},
6828: $args->{'bgcolor'}, $args->{'no_inline_link'},
6829: $args);
6830: }
1.330 albertel 6831: }
1.338 albertel 6832:
1.315 albertel 6833: if ($args->{'js_ready'}) {
1.713 kaisler 6834: $result = &js_ready($result);
1.315 albertel 6835: }
1.320 albertel 6836: if ($args->{'html_encode'}) {
1.713 kaisler 6837: $result = &html_encode($result);
6838: }
6839:
1.813 bisitz 6840: # Preparation for new and consistent functionlist at top of screen
6841: # if ($args->{'functionlist'}) {
6842: # $result .= &build_functionlist();
6843: #}
6844:
6845: # Don't add anything more if only_body wanted
6846: return $result if $args->{'only_body'};
6847:
1.920 raeburn 6848: #Breadcrumbs for Construction Space provided by &bodytag.
6849: if (($env{'environment.remote'} eq 'off') && ($env{'request.state'} eq 'construct')) {
6850: return $result;
6851: }
6852:
1.813 bisitz 6853: #Breadcrumbs
1.758 kaisler 6854: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
6855: &Apache::lonhtmlcommon::clear_breadcrumbs();
6856: #if any br links exists, add them to the breadcrumbs
6857: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6858: foreach my $crumb (@{$args->{'bread_crumbs'}}){
6859: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
6860: }
6861: }
6862:
6863: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
6864: if(exists($args->{'bread_crumbs_component'})){
6865: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
6866: }else{
6867: $result .= &Apache::lonhtmlcommon::breadcrumbs();
6868: }
1.320 albertel 6869: }
1.315 albertel 6870: return $result;
1.306 albertel 6871: }
6872:
1.330 albertel 6873:
1.306 albertel 6874: =pod
6875:
6876: =item * &head()
6877:
6878: Returns a complete </body></html> section for LON-CAPA web pages.
6879:
1.315 albertel 6880: Inputs: $args - additional optional args supported are:
6881: js_ready -> return a string ready for being used in
6882: a javascript writeln
1.320 albertel 6883: html_encode -> return a string ready for being used in
6884: a html attribute
1.330 albertel 6885: frameset -> if true will start with a <frameset>
6886: rather than <body>
1.493 albertel 6887: dicsussion -> if true will get discussion from
6888: lonxml::xmlend
6889: (you can pass the target and parser arguments
6890: through optional 'target' and 'parser' args
6891: to this routine)
1.306 albertel 6892:
6893: =cut
6894:
6895: sub end_page {
1.315 albertel 6896: my ($args) = @_;
6897: $env{'internal.end_page'}++;
1.330 albertel 6898: my $result;
1.335 albertel 6899: if ($args->{'discussion'}) {
6900: my ($target,$parser);
6901: if (ref($args->{'discussion'})) {
6902: ($target,$parser) =($args->{'discussion'}{'target'},
6903: $args->{'discussion'}{'parser'});
6904: }
6905: $result .= &Apache::lonxml::xmlend($target,$parser);
6906: }
6907:
1.330 albertel 6908: if ($args->{'frameset'}) {
6909: $result .= '</frameset>';
6910: } else {
1.635 raeburn 6911: $result .= &endbodytag($args);
1.330 albertel 6912: }
6913: $result .= "\n</html>";
6914:
1.315 albertel 6915: if ($args->{'js_ready'}) {
1.317 albertel 6916: $result = &js_ready($result);
1.315 albertel 6917: }
1.335 albertel 6918:
1.320 albertel 6919: if ($args->{'html_encode'}) {
6920: $result = &html_encode($result);
6921: }
1.335 albertel 6922:
1.315 albertel 6923: return $result;
6924: }
6925:
1.320 albertel 6926: sub html_encode {
6927: my ($result) = @_;
6928:
1.322 albertel 6929: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6930:
6931: return $result;
6932: }
1.317 albertel 6933: sub js_ready {
6934: my ($result) = @_;
6935:
1.323 albertel 6936: $result =~ s/[\n\r]/ /xmsg;
6937: $result =~ s/\\/\\\\/xmsg;
6938: $result =~ s/'/\\'/xmsg;
1.372 albertel 6939: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6940:
6941: return $result;
6942: }
6943:
1.315 albertel 6944: sub validate_page {
6945: if ( exists($env{'internal.start_page'})
1.316 albertel 6946: && $env{'internal.start_page'} > 1) {
6947: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6948: $env{'internal.start_page'}.' '.
1.316 albertel 6949: $ENV{'request.filename'});
1.315 albertel 6950: }
6951: if ( exists($env{'internal.end_page'})
1.316 albertel 6952: && $env{'internal.end_page'} > 1) {
6953: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6954: $env{'internal.end_page'}.' '.
1.316 albertel 6955: $env{'request.filename'});
1.315 albertel 6956: }
6957: if ( exists($env{'internal.start_page'})
6958: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6959: &Apache::lonnet::logthis('start_page called without end_page '.
6960: $env{'request.filename'});
1.315 albertel 6961: }
6962: if ( ! exists($env{'internal.start_page'})
6963: && exists($env{'internal.end_page'})) {
1.316 albertel 6964: &Apache::lonnet::logthis('end_page called without start_page'.
6965: $env{'request.filename'});
1.315 albertel 6966: }
1.306 albertel 6967: }
1.315 albertel 6968:
1.318 albertel 6969: sub simple_error_page {
6970: my ($r,$title,$msg) = @_;
6971: my $page =
6972: &Apache::loncommon::start_page($title).
6973: &mt($msg).
6974: &Apache::loncommon::end_page();
6975: if (ref($r)) {
6976: $r->print($page);
1.327 albertel 6977: return;
1.318 albertel 6978: }
6979: return $page;
6980: }
1.347 albertel 6981:
6982: {
1.610 albertel 6983: my @row_count;
1.347 albertel 6984: sub start_data_table {
1.422 albertel 6985: my ($add_class) = @_;
6986: my $css_class = (join(' ','LC_data_table',$add_class));
1.610 albertel 6987: unshift(@row_count,0);
1.422 albertel 6988: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 6989: }
6990:
6991: sub end_data_table {
1.610 albertel 6992: shift(@row_count);
1.389 albertel 6993: return '</table>'."\n";;
1.347 albertel 6994: }
6995:
6996: sub start_data_table_row {
1.422 albertel 6997: my ($add_class) = @_;
1.610 albertel 6998: $row_count[0]++;
6999: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 7000: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.422 albertel 7001: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 7002: }
1.471 banghart 7003:
7004: sub continue_data_table_row {
7005: my ($add_class) = @_;
1.610 albertel 7006: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 7007: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');;
1.471 banghart 7008: return '<tr class="'.$css_class.'">'."\n";;
7009: }
1.347 albertel 7010:
7011: sub end_data_table_row {
1.389 albertel 7012: return '</tr>'."\n";;
1.347 albertel 7013: }
1.367 www 7014:
1.421 albertel 7015: sub start_data_table_empty_row {
1.707 bisitz 7016: # $row_count[0]++;
1.421 albertel 7017: return '<tr class="LC_empty_row" >'."\n";;
7018: }
7019:
7020: sub end_data_table_empty_row {
7021: return '</tr>'."\n";;
7022: }
7023:
1.367 www 7024: sub start_data_table_header_row {
1.389 albertel 7025: return '<tr class="LC_header_row">'."\n";;
1.367 www 7026: }
7027:
7028: sub end_data_table_header_row {
1.389 albertel 7029: return '</tr>'."\n";;
1.367 www 7030: }
1.890 droeschl 7031:
7032: sub data_table_caption {
7033: my $caption = shift;
7034: return "<caption class=\"LC_caption\">$caption</caption>";
7035: }
1.347 albertel 7036: }
7037:
1.548 albertel 7038: =pod
7039:
7040: =item * &inhibit_menu_check($arg)
7041:
7042: Checks for a inhibitmenu state and generates output to preserve it
7043:
7044: Inputs: $arg - can be any of
7045: - undef - in which case the return value is a string
7046: to add into arguments list of a uri
7047: - 'input' - in which case the return value is a HTML
7048: <form> <input> field of type hidden to
7049: preserve the value
7050: - a url - in which case the return value is the url with
7051: the neccesary cgi args added to preserve the
7052: inhibitmenu state
7053: - a ref to a url - no return value, but the string is
7054: updated to include the neccessary cgi
7055: args to preserve the inhibitmenu state
7056:
7057: =cut
7058:
7059: sub inhibit_menu_check {
7060: my ($arg) = @_;
7061: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
7062: if ($arg eq 'input') {
7063: if ($env{'form.inhibitmenu'}) {
7064: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
7065: } else {
7066: return
7067: }
7068: }
7069: if ($env{'form.inhibitmenu'}) {
7070: if (ref($arg)) {
7071: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7072: } elsif ($arg eq '') {
7073: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
7074: } else {
7075: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7076: }
7077: }
7078: if (!ref($arg)) {
7079: return $arg;
7080: }
7081: }
7082:
1.251 albertel 7083: ###############################################
1.182 matthew 7084:
7085: =pod
7086:
1.549 albertel 7087: =back
7088:
7089: =head1 User Information Routines
7090:
7091: =over 4
7092:
1.405 albertel 7093: =item * &get_users_function()
1.182 matthew 7094:
7095: Used by &bodytag to determine the current users primary role.
7096: Returns either 'student','coordinator','admin', or 'author'.
7097:
7098: =cut
7099:
7100: ###############################################
7101: sub get_users_function {
1.815 tempelho 7102: my $function = 'norole';
1.818 tempelho 7103: if ($env{'request.role'}=~/^(st)/) {
7104: $function='student';
7105: }
1.907 raeburn 7106: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 7107: $function='coordinator';
7108: }
1.258 albertel 7109: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 7110: $function='admin';
7111: }
1.826 bisitz 7112: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182 matthew 7113: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
7114: $function='author';
7115: }
7116: return $function;
1.54 www 7117: }
1.99 www 7118:
7119: ###############################################
7120:
1.233 raeburn 7121: =pod
7122:
1.821 raeburn 7123: =item * &show_course()
7124:
7125: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
7126: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
7127:
7128: Inputs:
7129: None
7130:
7131: Outputs:
7132: Scalar: 1 if 'Course' to be used, 0 otherwise.
7133:
7134: =cut
7135:
7136: ###############################################
7137: sub show_course {
7138: my $course = !$env{'user.adv'};
7139: if (!$env{'user.adv'}) {
7140: foreach my $env (keys(%env)) {
7141: next if ($env !~ m/^user\.priv\./);
7142: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
7143: $course = 0;
7144: last;
7145: }
7146: }
7147: }
7148: return $course;
7149: }
7150:
7151: ###############################################
7152:
7153: =pod
7154:
1.542 raeburn 7155: =item * &check_user_status()
1.274 raeburn 7156:
7157: Determines current status of supplied role for a
7158: specific user. Roles can be active, previous or future.
7159:
7160: Inputs:
7161: user's domain, user's username, course's domain,
1.375 raeburn 7162: course's number, optional section ID.
1.274 raeburn 7163:
7164: Outputs:
7165: role status: active, previous or future.
7166:
7167: =cut
7168:
7169: sub check_user_status {
1.412 raeburn 7170: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 7171: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
7172: my @uroles = keys %userinfo;
7173: my $srchstr;
7174: my $active_chk = 'none';
1.412 raeburn 7175: my $now = time;
1.274 raeburn 7176: if (@uroles > 0) {
1.908 raeburn 7177: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 7178: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
7179: } else {
1.412 raeburn 7180: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
7181: }
7182: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 7183: my $role_end = 0;
7184: my $role_start = 0;
7185: $active_chk = 'active';
1.412 raeburn 7186: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
7187: $role_end = $1;
7188: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
7189: $role_start = $1;
1.274 raeburn 7190: }
7191: }
7192: if ($role_start > 0) {
1.412 raeburn 7193: if ($now < $role_start) {
1.274 raeburn 7194: $active_chk = 'future';
7195: }
7196: }
7197: if ($role_end > 0) {
1.412 raeburn 7198: if ($now > $role_end) {
1.274 raeburn 7199: $active_chk = 'previous';
7200: }
7201: }
7202: }
7203: }
7204: return $active_chk;
7205: }
7206:
7207: ###############################################
7208:
7209: =pod
7210:
1.405 albertel 7211: =item * &get_sections()
1.233 raeburn 7212:
7213: Determines all the sections for a course including
7214: sections with students and sections containing other roles.
1.419 raeburn 7215: Incoming parameters:
7216:
7217: 1. domain
7218: 2. course number
7219: 3. reference to array containing roles for which sections should
7220: be gathered (optional).
7221: 4. reference to array containing status types for which sections
7222: should be gathered (optional).
7223:
7224: If the third argument is undefined, sections are gathered for any role.
7225: If the fourth argument is undefined, sections are gathered for any status.
7226: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 7227:
1.374 raeburn 7228: Returns section hash (keys are section IDs, values are
7229: number of users in each section), subject to the
1.419 raeburn 7230: optional roles filter, optional status filter
1.233 raeburn 7231:
7232: =cut
7233:
7234: ###############################################
7235: sub get_sections {
1.419 raeburn 7236: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 7237: if (!defined($cdom) || !defined($cnum)) {
7238: my $cid = $env{'request.course.id'};
7239:
7240: return if (!defined($cid));
7241:
7242: $cdom = $env{'course.'.$cid.'.domain'};
7243: $cnum = $env{'course.'.$cid.'.num'};
7244: }
7245:
7246: my %sectioncount;
1.419 raeburn 7247: my $now = time;
1.240 albertel 7248:
1.366 albertel 7249: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 7250: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 7251: my $sec_index = &Apache::loncoursedata::CL_SECTION();
7252: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 7253: my $start_index = &Apache::loncoursedata::CL_START();
7254: my $end_index = &Apache::loncoursedata::CL_END();
7255: my $status;
1.366 albertel 7256: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 7257: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
7258: $data->[$status_index],
7259: $data->[$start_index],
7260: $data->[$end_index]);
7261: if ($stu_status eq 'Active') {
7262: $status = 'active';
7263: } elsif ($end < $now) {
7264: $status = 'previous';
7265: } elsif ($start > $now) {
7266: $status = 'future';
7267: }
7268: if ($section ne '-1' && $section !~ /^\s*$/) {
7269: if ((!defined($possible_status)) || (($status ne '') &&
7270: (grep/^\Q$status\E$/,@{$possible_status}))) {
7271: $sectioncount{$section}++;
7272: }
1.240 albertel 7273: }
7274: }
7275: }
7276: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7277: foreach my $user (sort(keys(%courseroles))) {
7278: if ($user !~ /^(\w{2})/) { next; }
7279: my ($role) = ($user =~ /^(\w{2})/);
7280: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 7281: my ($section,$status);
1.240 albertel 7282: if ($role eq 'cr' &&
7283: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
7284: $section=$1;
7285: }
7286: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
7287: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 7288: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
7289: if ($end == -1 && $start == -1) {
7290: next; #deleted role
7291: }
7292: if (!defined($possible_status)) {
7293: $sectioncount{$section}++;
7294: } else {
7295: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
7296: $status = 'active';
7297: } elsif ($end < $now) {
7298: $status = 'future';
7299: } elsif ($start > $now) {
7300: $status = 'previous';
7301: }
7302: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
7303: $sectioncount{$section}++;
7304: }
7305: }
1.233 raeburn 7306: }
1.366 albertel 7307: return %sectioncount;
1.233 raeburn 7308: }
7309:
1.274 raeburn 7310: ###############################################
1.294 raeburn 7311:
7312: =pod
1.405 albertel 7313:
7314: =item * &get_course_users()
7315:
1.275 raeburn 7316: Retrieves usernames:domains for users in the specified course
7317: with specific role(s), and access status.
7318:
7319: Incoming parameters:
1.277 albertel 7320: 1. course domain
7321: 2. course number
7322: 3. access status: users must have - either active,
1.275 raeburn 7323: previous, future, or all.
1.277 albertel 7324: 4. reference to array of permissible roles
1.288 raeburn 7325: 5. reference to array of section restrictions (optional)
7326: 6. reference to results object (hash of hashes).
7327: 7. reference to optional userdata hash
1.609 raeburn 7328: 8. reference to optional statushash
1.630 raeburn 7329: 9. flag if privileged users (except those set to unhide in
7330: course settings) should be excluded
1.609 raeburn 7331: Keys of top level results hash are roles.
1.275 raeburn 7332: Keys of inner hashes are username:domain, with
7333: values set to access type.
1.288 raeburn 7334: Optional userdata hash returns an array with arguments in the
7335: same order as loncoursedata::get_classlist() for student data.
7336:
1.609 raeburn 7337: Optional statushash returns
7338:
1.288 raeburn 7339: Entries for end, start, section and status are blank because
7340: of the possibility of multiple values for non-student roles.
7341:
1.275 raeburn 7342: =cut
1.405 albertel 7343:
1.275 raeburn 7344: ###############################################
1.405 albertel 7345:
1.275 raeburn 7346: sub get_course_users {
1.630 raeburn 7347: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 7348: my %idx = ();
1.419 raeburn 7349: my %seclists;
1.288 raeburn 7350:
7351: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
7352: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
7353: $idx{end} = &Apache::loncoursedata::CL_END();
7354: $idx{start} = &Apache::loncoursedata::CL_START();
7355: $idx{id} = &Apache::loncoursedata::CL_ID();
7356: $idx{section} = &Apache::loncoursedata::CL_SECTION();
7357: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
7358: $idx{status} = &Apache::loncoursedata::CL_STATUS();
7359:
1.290 albertel 7360: if (grep(/^st$/,@{$roles})) {
1.276 albertel 7361: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 7362: my $now = time;
1.277 albertel 7363: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 7364: my $match = 0;
1.412 raeburn 7365: my $secmatch = 0;
1.419 raeburn 7366: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 7367: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 7368: if ($section eq '') {
7369: $section = 'none';
7370: }
1.291 albertel 7371: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7372: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7373: $secmatch = 1;
7374: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 7375: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7376: $secmatch = 1;
7377: }
7378: } else {
1.419 raeburn 7379: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 7380: $secmatch = 1;
7381: }
1.290 albertel 7382: }
1.412 raeburn 7383: if (!$secmatch) {
7384: next;
7385: }
1.419 raeburn 7386: }
1.275 raeburn 7387: if (defined($$types{'active'})) {
1.288 raeburn 7388: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 7389: push(@{$$users{st}{$student}},'active');
1.288 raeburn 7390: $match = 1;
1.275 raeburn 7391: }
7392: }
7393: if (defined($$types{'previous'})) {
1.609 raeburn 7394: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 7395: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 7396: $match = 1;
1.275 raeburn 7397: }
7398: }
7399: if (defined($$types{'future'})) {
1.609 raeburn 7400: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 7401: push(@{$$users{st}{$student}},'future');
1.288 raeburn 7402: $match = 1;
1.275 raeburn 7403: }
7404: }
1.609 raeburn 7405: if ($match) {
7406: push(@{$seclists{$student}},$section);
7407: if (ref($userdata) eq 'HASH') {
7408: $$userdata{$student} = $$classlist{$student};
7409: }
7410: if (ref($statushash) eq 'HASH') {
7411: $statushash->{$student}{'st'}{$section} = $status;
7412: }
1.288 raeburn 7413: }
1.275 raeburn 7414: }
7415: }
1.412 raeburn 7416: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 7417: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7418: my $now = time;
1.609 raeburn 7419: my %displaystatus = ( previous => 'Expired',
7420: active => 'Active',
7421: future => 'Future',
7422: );
1.630 raeburn 7423: my %nothide;
7424: if ($hidepriv) {
7425: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
7426: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
7427: if ($user !~ /:/) {
7428: $nothide{join(':',split(/[\@]/,$user))}=1;
7429: } else {
7430: $nothide{$user} = 1;
7431: }
7432: }
7433: }
1.439 raeburn 7434: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 7435: my $match = 0;
1.412 raeburn 7436: my $secmatch = 0;
1.439 raeburn 7437: my $status;
1.412 raeburn 7438: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 7439: $user =~ s/:$//;
1.439 raeburn 7440: my ($end,$start) = split(/:/,$coursepersonnel{$person});
7441: if ($end == -1 || $start == -1) {
7442: next;
7443: }
7444: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
7445: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 7446: my ($uname,$udom) = split(/:/,$user);
7447: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7448: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7449: $secmatch = 1;
7450: } elsif ($usec eq '') {
1.420 albertel 7451: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7452: $secmatch = 1;
7453: }
7454: } else {
7455: if (grep(/^\Q$usec\E$/,@{$sections})) {
7456: $secmatch = 1;
7457: }
7458: }
7459: if (!$secmatch) {
7460: next;
7461: }
1.288 raeburn 7462: }
1.419 raeburn 7463: if ($usec eq '') {
7464: $usec = 'none';
7465: }
1.275 raeburn 7466: if ($uname ne '' && $udom ne '') {
1.630 raeburn 7467: if ($hidepriv) {
7468: if ((&Apache::lonnet::privileged($uname,$udom)) &&
7469: (!$nothide{$uname.':'.$udom})) {
7470: next;
7471: }
7472: }
1.503 raeburn 7473: if ($end > 0 && $end < $now) {
1.439 raeburn 7474: $status = 'previous';
7475: } elsif ($start > $now) {
7476: $status = 'future';
7477: } else {
7478: $status = 'active';
7479: }
1.277 albertel 7480: foreach my $type (keys(%{$types})) {
1.275 raeburn 7481: if ($status eq $type) {
1.420 albertel 7482: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 7483: push(@{$$users{$role}{$user}},$type);
7484: }
1.288 raeburn 7485: $match = 1;
7486: }
7487: }
1.419 raeburn 7488: if (($match) && (ref($userdata) eq 'HASH')) {
7489: if (!exists($$userdata{$uname.':'.$udom})) {
7490: &get_user_info($udom,$uname,\%idx,$userdata);
7491: }
1.420 albertel 7492: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 7493: push(@{$seclists{$uname.':'.$udom}},$usec);
7494: }
1.609 raeburn 7495: if (ref($statushash) eq 'HASH') {
7496: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
7497: }
1.275 raeburn 7498: }
7499: }
7500: }
7501: }
1.290 albertel 7502: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 7503: if ((defined($cdom)) && (defined($cnum))) {
7504: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
7505: if ( defined($csettings{'internal.courseowner'}) ) {
7506: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 7507: next if ($owner eq '');
7508: my ($ownername,$ownerdom);
7509: if ($owner =~ /^([^:]+):([^:]+)$/) {
7510: $ownername = $1;
7511: $ownerdom = $2;
7512: } else {
7513: $ownername = $owner;
7514: $ownerdom = $cdom;
7515: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 7516: }
7517: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 7518: if (defined($userdata) &&
1.609 raeburn 7519: !exists($$userdata{$owner})) {
7520: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
7521: if (!grep(/^none$/,@{$seclists{$owner}})) {
7522: push(@{$seclists{$owner}},'none');
7523: }
7524: if (ref($statushash) eq 'HASH') {
7525: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 7526: }
1.290 albertel 7527: }
1.279 raeburn 7528: }
7529: }
7530: }
1.419 raeburn 7531: foreach my $user (keys(%seclists)) {
7532: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
7533: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
7534: }
1.275 raeburn 7535: }
7536: return;
7537: }
7538:
1.288 raeburn 7539: sub get_user_info {
7540: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 7541: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
7542: &plainname($uname,$udom,'lastname');
1.291 albertel 7543: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 7544: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 7545: my %idhash = &Apache::lonnet::idrget($udom,($uname));
7546: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 7547: return;
7548: }
1.275 raeburn 7549:
1.472 raeburn 7550: ###############################################
7551:
7552: =pod
7553:
7554: =item * &get_user_quota()
7555:
7556: Retrieves quota assigned for storage of portfolio files for a user
7557:
7558: Incoming parameters:
7559: 1. user's username
7560: 2. user's domain
7561:
7562: Returns:
1.536 raeburn 7563: 1. Disk quota (in Mb) assigned to student.
7564: 2. (Optional) Type of setting: custom or default
7565: (individually assigned or default for user's
7566: institutional status).
7567: 3. (Optional) - User's institutional status (e.g., faculty, staff
7568: or student - types as defined in localenroll::inst_usertypes
7569: for user's domain, which determines default quota for user.
7570: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 7571:
7572: If a value has been stored in the user's environment,
1.536 raeburn 7573: it will return that, otherwise it returns the maximal default
7574: defined for the user's instituional status(es) in the domain.
1.472 raeburn 7575:
7576: =cut
7577:
7578: ###############################################
7579:
7580:
7581: sub get_user_quota {
7582: my ($uname,$udom) = @_;
1.536 raeburn 7583: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 7584: if (!defined($udom)) {
7585: $udom = $env{'user.domain'};
7586: }
7587: if (!defined($uname)) {
7588: $uname = $env{'user.name'};
7589: }
7590: if (($udom eq '' || $uname eq '') ||
7591: ($udom eq 'public') && ($uname eq 'public')) {
7592: $quota = 0;
1.536 raeburn 7593: $quotatype = 'default';
7594: $defquota = 0;
1.472 raeburn 7595: } else {
1.536 raeburn 7596: my $inststatus;
1.472 raeburn 7597: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
7598: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 7599: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 7600: } else {
1.536 raeburn 7601: my %userenv =
7602: &Apache::lonnet::get('environment',['portfolioquota',
7603: 'inststatus'],$udom,$uname);
1.472 raeburn 7604: my ($tmp) = keys(%userenv);
7605: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7606: $quota = $userenv{'portfolioquota'};
1.536 raeburn 7607: $inststatus = $userenv{'inststatus'};
1.472 raeburn 7608: } else {
7609: undef(%userenv);
7610: }
7611: }
1.536 raeburn 7612: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 7613: if ($quota eq '') {
1.536 raeburn 7614: $quota = $defquota;
7615: $quotatype = 'default';
7616: } else {
7617: $quotatype = 'custom';
1.472 raeburn 7618: }
7619: }
1.536 raeburn 7620: if (wantarray) {
7621: return ($quota,$quotatype,$settingstatus,$defquota);
7622: } else {
7623: return $quota;
7624: }
1.472 raeburn 7625: }
7626:
7627: ###############################################
7628:
7629: =pod
7630:
7631: =item * &default_quota()
7632:
1.536 raeburn 7633: Retrieves default quota assigned for storage of user portfolio files,
7634: given an (optional) user's institutional status.
1.472 raeburn 7635:
7636: Incoming parameters:
7637: 1. domain
1.536 raeburn 7638: 2. (Optional) institutional status(es). This is a : separated list of
7639: status types (e.g., faculty, staff, student etc.)
7640: which apply to the user for whom the default is being retrieved.
7641: If the institutional status string in undefined, the domain
7642: default quota will be returned.
1.472 raeburn 7643:
7644: Returns:
7645: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 7646: 2. (Optional) institutional type which determined the value of the
7647: default quota.
1.472 raeburn 7648:
7649: If a value has been stored in the domain's configuration db,
7650: it will return that, otherwise it returns 20 (for backwards
7651: compatibility with domains which have not set up a configuration
7652: db file; the original statically defined portfolio quota was 20 Mb).
7653:
1.536 raeburn 7654: If the user's status includes multiple types (e.g., staff and student),
7655: the largest default quota which applies to the user determines the
7656: default quota returned.
7657:
1.780 raeburn 7658: =back
7659:
1.472 raeburn 7660: =cut
7661:
7662: ###############################################
7663:
7664:
7665: sub default_quota {
1.536 raeburn 7666: my ($udom,$inststatus) = @_;
7667: my ($defquota,$settingstatus);
7668: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 7669: ['quotas'],$udom);
7670: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 7671: if ($inststatus ne '') {
1.765 raeburn 7672: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 7673: foreach my $item (@statuses) {
1.711 raeburn 7674: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7675: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
7676: if ($defquota eq '') {
7677: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7678: $settingstatus = $item;
7679: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
7680: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7681: $settingstatus = $item;
7682: }
7683: }
7684: } else {
7685: if ($quotahash{'quotas'}{$item} ne '') {
7686: if ($defquota eq '') {
7687: $defquota = $quotahash{'quotas'}{$item};
7688: $settingstatus = $item;
7689: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
7690: $defquota = $quotahash{'quotas'}{$item};
7691: $settingstatus = $item;
7692: }
1.536 raeburn 7693: }
7694: }
7695: }
7696: }
7697: if ($defquota eq '') {
1.711 raeburn 7698: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7699: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
7700: } else {
7701: $defquota = $quotahash{'quotas'}{'default'};
7702: }
1.536 raeburn 7703: $settingstatus = 'default';
7704: }
7705: } else {
7706: $settingstatus = 'default';
7707: $defquota = 20;
7708: }
7709: if (wantarray) {
7710: return ($defquota,$settingstatus);
1.472 raeburn 7711: } else {
1.536 raeburn 7712: return $defquota;
1.472 raeburn 7713: }
7714: }
7715:
1.384 raeburn 7716: sub get_secgrprole_info {
7717: my ($cdom,$cnum,$needroles,$type) = @_;
7718: my %sections_count = &get_sections($cdom,$cnum);
7719: my @sections = (sort {$a <=> $b} keys(%sections_count));
7720: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
7721: my @groups = sort(keys(%curr_groups));
7722: my $allroles = [];
7723: my $rolehash;
7724: my $accesshash = {
7725: active => 'Currently has access',
7726: future => 'Will have future access',
7727: previous => 'Previously had access',
7728: };
7729: if ($needroles) {
7730: $rolehash = {'all' => 'all'};
1.385 albertel 7731: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7732: if (&Apache::lonnet::error(%user_roles)) {
7733: undef(%user_roles);
7734: }
7735: foreach my $item (keys(%user_roles)) {
1.384 raeburn 7736: my ($role)=split(/\:/,$item,2);
7737: if ($role eq 'cr') { next; }
7738: if ($role =~ /^cr/) {
7739: $$rolehash{$role} = (split('/',$role))[3];
7740: } else {
7741: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
7742: }
7743: }
7744: foreach my $key (sort(keys(%{$rolehash}))) {
7745: push(@{$allroles},$key);
7746: }
7747: push (@{$allroles},'st');
7748: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
7749: }
7750: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
7751: }
7752:
1.555 raeburn 7753: sub user_picker {
1.627 raeburn 7754: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555 raeburn 7755: my $currdom = $dom;
7756: my %curr_selected = (
7757: srchin => 'dom',
1.580 raeburn 7758: srchby => 'lastname',
1.555 raeburn 7759: );
7760: my $srchterm;
1.625 raeburn 7761: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 7762: if ($srch->{'srchby'} ne '') {
7763: $curr_selected{'srchby'} = $srch->{'srchby'};
7764: }
7765: if ($srch->{'srchin'} ne '') {
7766: $curr_selected{'srchin'} = $srch->{'srchin'};
7767: }
7768: if ($srch->{'srchtype'} ne '') {
7769: $curr_selected{'srchtype'} = $srch->{'srchtype'};
7770: }
7771: if ($srch->{'srchdomain'} ne '') {
7772: $currdom = $srch->{'srchdomain'};
7773: }
7774: $srchterm = $srch->{'srchterm'};
7775: }
7776: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 7777: 'usr' => 'Search criteria',
1.563 raeburn 7778: 'doma' => 'Domain/institution to search',
1.558 albertel 7779: 'uname' => 'username',
7780: 'lastname' => 'last name',
1.555 raeburn 7781: 'lastfirst' => 'last name, first name',
1.558 albertel 7782: 'crs' => 'in this course',
1.576 raeburn 7783: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 7784: 'alc' => 'all LON-CAPA',
1.573 raeburn 7785: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 7786: 'exact' => 'is',
7787: 'contains' => 'contains',
1.569 raeburn 7788: 'begins' => 'begins with',
1.571 raeburn 7789: 'youm' => "You must include some text to search for.",
7790: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
7791: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
7792: 'yomc' => "You must choose a domain when using an institutional directory search.",
7793: 'ymcd' => "You must choose a domain when using a domain search.",
7794: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
7795: 'whse' => "When searching by last,first you must include at least one character in the first name.",
7796: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 7797: );
1.563 raeburn 7798: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
7799: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 7800:
7801: my @srchins = ('crs','dom','alc','instd');
7802:
7803: foreach my $option (@srchins) {
7804: # FIXME 'alc' option unavailable until
7805: # loncreateuser::print_user_query_page()
7806: # has been completed.
7807: next if ($option eq 'alc');
1.880 raeburn 7808: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 7809: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 7810: if ($curr_selected{'srchin'} eq $option) {
7811: $srchinsel .= '
7812: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7813: } else {
7814: $srchinsel .= '
7815: <option value="'.$option.'">'.$lt{$option}.'</option>';
7816: }
1.555 raeburn 7817: }
1.563 raeburn 7818: $srchinsel .= "\n </select>\n";
1.555 raeburn 7819:
7820: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 7821: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 7822: if ($curr_selected{'srchby'} eq $option) {
7823: $srchbysel .= '
7824: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7825: } else {
7826: $srchbysel .= '
7827: <option value="'.$option.'">'.$lt{$option}.'</option>';
7828: }
7829: }
7830: $srchbysel .= "\n </select>\n";
7831:
7832: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 7833: foreach my $option ('begins','contains','exact') {
1.555 raeburn 7834: if ($curr_selected{'srchtype'} eq $option) {
7835: $srchtypesel .= '
7836: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7837: } else {
7838: $srchtypesel .= '
7839: <option value="'.$option.'">'.$lt{$option}.'</option>';
7840: }
7841: }
7842: $srchtypesel .= "\n </select>\n";
7843:
1.558 albertel 7844: my ($newuserscript,$new_user_create);
1.556 raeburn 7845:
7846: if ($forcenewuser) {
1.576 raeburn 7847: if (ref($srch) eq 'HASH') {
7848: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627 raeburn 7849: if ($cancreate) {
7850: $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>';
7851: } else {
1.799 bisitz 7852: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 7853: my %usertypetext = (
7854: official => 'institutional',
7855: unofficial => 'non-institutional',
7856: );
1.799 bisitz 7857: $new_user_create = '<p class="LC_warning">'
7858: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
7859: .' '
7860: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
7861: ,'<a href="'.$helplink.'">','</a>')
7862: .'</p><br />';
1.627 raeburn 7863: }
1.576 raeburn 7864: }
7865: }
7866:
1.556 raeburn 7867: $newuserscript = <<"ENDSCRIPT";
7868:
1.570 raeburn 7869: function setSearch(createnew,callingForm) {
1.556 raeburn 7870: if (createnew == 1) {
1.570 raeburn 7871: for (var i=0; i<callingForm.srchby.length; i++) {
7872: if (callingForm.srchby.options[i].value == 'uname') {
7873: callingForm.srchby.selectedIndex = i;
1.556 raeburn 7874: }
7875: }
1.570 raeburn 7876: for (var i=0; i<callingForm.srchin.length; i++) {
7877: if ( callingForm.srchin.options[i].value == 'dom') {
7878: callingForm.srchin.selectedIndex = i;
1.556 raeburn 7879: }
7880: }
1.570 raeburn 7881: for (var i=0; i<callingForm.srchtype.length; i++) {
7882: if (callingForm.srchtype.options[i].value == 'exact') {
7883: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 7884: }
7885: }
1.570 raeburn 7886: for (var i=0; i<callingForm.srchdomain.length; i++) {
7887: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
7888: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 7889: }
7890: }
7891: }
7892: }
7893: ENDSCRIPT
1.558 albertel 7894:
1.556 raeburn 7895: }
7896:
1.555 raeburn 7897: my $output = <<"END_BLOCK";
1.556 raeburn 7898: <script type="text/javascript">
1.824 bisitz 7899: // <![CDATA[
1.570 raeburn 7900: function validateEntry(callingForm) {
1.558 albertel 7901:
1.556 raeburn 7902: var checkok = 1;
1.558 albertel 7903: var srchin;
1.570 raeburn 7904: for (var i=0; i<callingForm.srchin.length; i++) {
7905: if ( callingForm.srchin[i].checked ) {
7906: srchin = callingForm.srchin[i].value;
1.558 albertel 7907: }
7908: }
7909:
1.570 raeburn 7910: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7911: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7912: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7913: var srchterm = callingForm.srchterm.value;
7914: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7915: var msg = "";
7916:
7917: if (srchterm == "") {
7918: checkok = 0;
1.571 raeburn 7919: msg += "$lt{'youm'}\\n";
1.556 raeburn 7920: }
7921:
1.569 raeburn 7922: if (srchtype== 'begins') {
7923: if (srchterm.length < 2) {
7924: checkok = 0;
1.571 raeburn 7925: msg += "$lt{'thte'}\\n";
1.569 raeburn 7926: }
7927: }
7928:
1.556 raeburn 7929: if (srchtype== 'contains') {
7930: if (srchterm.length < 3) {
7931: checkok = 0;
1.571 raeburn 7932: msg += "$lt{'thet'}\\n";
1.556 raeburn 7933: }
7934: }
7935: if (srchin == 'instd') {
7936: if (srchdomain == '') {
7937: checkok = 0;
1.571 raeburn 7938: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7939: }
7940: }
7941: if (srchin == 'dom') {
7942: if (srchdomain == '') {
7943: checkok = 0;
1.571 raeburn 7944: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7945: }
7946: }
7947: if (srchby == 'lastfirst') {
7948: if (srchterm.indexOf(",") == -1) {
7949: checkok = 0;
1.571 raeburn 7950: msg += "$lt{'whus'}\\n";
1.556 raeburn 7951: }
7952: if (srchterm.indexOf(",") == srchterm.length -1) {
7953: checkok = 0;
1.571 raeburn 7954: msg += "$lt{'whse'}\\n";
1.556 raeburn 7955: }
7956: }
7957: if (checkok == 0) {
1.571 raeburn 7958: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7959: return;
7960: }
7961: if (checkok == 1) {
1.570 raeburn 7962: callingForm.submit();
1.556 raeburn 7963: }
7964: }
7965:
7966: $newuserscript
7967:
1.824 bisitz 7968: // ]]>
1.556 raeburn 7969: </script>
1.558 albertel 7970:
7971: $new_user_create
7972:
1.555 raeburn 7973: END_BLOCK
1.558 albertel 7974:
1.876 raeburn 7975: $output .= &Apache::lonhtmlcommon::start_pick_box().
7976: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
7977: $domform.
7978: &Apache::lonhtmlcommon::row_closure().
7979: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
7980: $srchbysel.
7981: $srchtypesel.
7982: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
7983: $srchinsel.
7984: &Apache::lonhtmlcommon::row_closure(1).
7985: &Apache::lonhtmlcommon::end_pick_box().
7986: '<br />';
1.555 raeburn 7987: return $output;
7988: }
7989:
1.612 raeburn 7990: sub user_rule_check {
1.615 raeburn 7991: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 7992: my $response;
7993: if (ref($usershash) eq 'HASH') {
7994: foreach my $user (keys(%{$usershash})) {
7995: my ($uname,$udom) = split(/:/,$user);
7996: next if ($udom eq '' || $uname eq '');
1.615 raeburn 7997: my ($id,$newuser);
1.612 raeburn 7998: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 7999: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 8000: $id = $usershash->{$user}->{'id'};
8001: }
8002: my $inst_response;
8003: if (ref($checks) eq 'HASH') {
8004: if (defined($checks->{'username'})) {
1.615 raeburn 8005: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 8006: &Apache::lonnet::get_instuser($udom,$uname);
8007: } elsif (defined($checks->{'id'})) {
1.615 raeburn 8008: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 8009: &Apache::lonnet::get_instuser($udom,undef,$id);
8010: }
1.615 raeburn 8011: } else {
8012: ($inst_response,%{$inst_results->{$user}}) =
8013: &Apache::lonnet::get_instuser($udom,$uname);
8014: return;
1.612 raeburn 8015: }
1.615 raeburn 8016: if (!$got_rules->{$udom}) {
1.612 raeburn 8017: my %domconfig = &Apache::lonnet::get_dom('configuration',
8018: ['usercreation'],$udom);
8019: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 8020: foreach my $item ('username','id') {
1.612 raeburn 8021: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
8022: $$curr_rules{$udom}{$item} =
8023: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 8024: }
8025: }
8026: }
1.615 raeburn 8027: $got_rules->{$udom} = 1;
1.585 raeburn 8028: }
1.612 raeburn 8029: foreach my $item (keys(%{$checks})) {
8030: if (ref($$curr_rules{$udom}) eq 'HASH') {
8031: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
8032: if (@{$$curr_rules{$udom}{$item}} > 0) {
8033: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
8034: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
8035: if ($rule_check{$rule}) {
8036: $$rulematch{$user}{$item} = $rule;
8037: if ($inst_response eq 'ok') {
1.615 raeburn 8038: if (ref($inst_results) eq 'HASH') {
8039: if (ref($inst_results->{$user}) eq 'HASH') {
8040: if (keys(%{$inst_results->{$user}}) == 0) {
8041: $$alerts{$item}{$udom}{$uname} = 1;
8042: }
1.612 raeburn 8043: }
8044: }
1.615 raeburn 8045: }
8046: last;
1.585 raeburn 8047: }
8048: }
8049: }
8050: }
8051: }
8052: }
8053: }
8054: }
1.612 raeburn 8055: return;
8056: }
8057:
8058: sub user_rule_formats {
8059: my ($domain,$domdesc,$curr_rules,$check) = @_;
8060: my %text = (
8061: 'username' => 'Usernames',
8062: 'id' => 'IDs',
8063: );
8064: my $output;
8065: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
8066: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
8067: if (@{$ruleorder} > 0) {
8068: $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>';
8069: foreach my $rule (@{$ruleorder}) {
8070: if (ref($curr_rules) eq 'ARRAY') {
8071: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
8072: if (ref($rules->{$rule}) eq 'HASH') {
8073: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
8074: $rules->{$rule}{'desc'}.'</li>';
8075: }
8076: }
8077: }
8078: }
8079: $output .= '</ul>';
8080: }
8081: }
8082: return $output;
8083: }
8084:
8085: sub instrule_disallow_msg {
1.615 raeburn 8086: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 8087: my $response;
8088: my %text = (
8089: item => 'username',
8090: items => 'usernames',
8091: match => 'matches',
8092: do => 'does',
8093: action => 'a username',
8094: one => 'one',
8095: );
8096: if ($count > 1) {
8097: $text{'item'} = 'usernames';
8098: $text{'match'} ='match';
8099: $text{'do'} = 'do';
8100: $text{'action'} = 'usernames',
8101: $text{'one'} = 'ones';
8102: }
8103: if ($checkitem eq 'id') {
8104: $text{'items'} = 'IDs';
8105: $text{'item'} = 'ID';
8106: $text{'action'} = 'an ID';
1.615 raeburn 8107: if ($count > 1) {
8108: $text{'item'} = 'IDs';
8109: $text{'action'} = 'IDs';
8110: }
1.612 raeburn 8111: }
1.674 bisitz 8112: $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 8113: if ($mode eq 'upload') {
8114: if ($checkitem eq 'username') {
8115: $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'}.");
8116: } elsif ($checkitem eq 'id') {
1.674 bisitz 8117: $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 8118: }
1.669 raeburn 8119: } elsif ($mode eq 'selfcreate') {
8120: if ($checkitem eq 'id') {
8121: $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.");
8122: }
1.615 raeburn 8123: } else {
8124: if ($checkitem eq 'username') {
8125: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
8126: } elsif ($checkitem eq 'id') {
8127: $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.");
8128: }
1.612 raeburn 8129: }
8130: return $response;
1.585 raeburn 8131: }
8132:
1.624 raeburn 8133: sub personal_data_fieldtitles {
8134: my %fieldtitles = &Apache::lonlocal::texthash (
8135: id => 'Student/Employee ID',
8136: permanentemail => 'E-mail address',
8137: lastname => 'Last Name',
8138: firstname => 'First Name',
8139: middlename => 'Middle Name',
8140: generation => 'Generation',
8141: gen => 'Generation',
1.765 raeburn 8142: inststatus => 'Affiliation',
1.624 raeburn 8143: );
8144: return %fieldtitles;
8145: }
8146:
1.642 raeburn 8147: sub sorted_inst_types {
8148: my ($dom) = @_;
8149: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
8150: my $othertitle = &mt('All users');
8151: if ($env{'request.course.id'}) {
1.668 raeburn 8152: $othertitle = &mt('Any users');
1.642 raeburn 8153: }
8154: my @types;
8155: if (ref($order) eq 'ARRAY') {
8156: @types = @{$order};
8157: }
8158: if (@types == 0) {
8159: if (ref($usertypes) eq 'HASH') {
8160: @types = sort(keys(%{$usertypes}));
8161: }
8162: }
8163: if (keys(%{$usertypes}) > 0) {
8164: $othertitle = &mt('Other users');
8165: }
8166: return ($othertitle,$usertypes,\@types);
8167: }
8168:
1.645 raeburn 8169: sub get_institutional_codes {
8170: my ($settings,$allcourses,$LC_code) = @_;
8171: # Get complete list of course sections to update
8172: my @currsections = ();
8173: my @currxlists = ();
8174: my $coursecode = $$settings{'internal.coursecode'};
8175:
8176: if ($$settings{'internal.sectionnums'} ne '') {
8177: @currsections = split(/,/,$$settings{'internal.sectionnums'});
8178: }
8179:
8180: if ($$settings{'internal.crosslistings'} ne '') {
8181: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
8182: }
8183:
8184: if (@currxlists > 0) {
8185: foreach (@currxlists) {
8186: if (m/^([^:]+):(\w*)$/) {
8187: unless (grep/^$1$/,@{$allcourses}) {
8188: push @{$allcourses},$1;
8189: $$LC_code{$1} = $2;
8190: }
8191: }
8192: }
8193: }
8194:
8195: if (@currsections > 0) {
8196: foreach (@currsections) {
8197: if (m/^(\w+):(\w*)$/) {
8198: my $sec = $coursecode.$1;
8199: my $lc_sec = $2;
8200: unless (grep/^$sec$/,@{$allcourses}) {
8201: push @{$allcourses},$sec;
8202: $$LC_code{$sec} = $lc_sec;
8203: }
8204: }
8205: }
8206: }
8207: return;
8208: }
8209:
1.112 bowersj2 8210: =pod
8211:
1.780 raeburn 8212: =head1 Slot Helpers
8213:
8214: =over 4
8215:
8216: =item * sorted_slots()
8217:
8218: Sorts an array of slot names in order of slot start time (earliest first).
8219:
8220: Inputs:
8221:
8222: =over 4
8223:
8224: slotsarr - Reference to array of unsorted slot names.
8225:
8226: slots - Reference to hash of hash, where outer hash keys are slot names.
8227:
1.549 albertel 8228: =back
8229:
1.780 raeburn 8230: Returns:
8231:
8232: =over 4
8233:
8234: sorted - An array of slot names sorted by the start time of the slot.
8235:
8236: =back
8237:
8238: =back
8239:
8240: =cut
8241:
8242:
8243: sub sorted_slots {
8244: my ($slotsarr,$slots) = @_;
8245: my @sorted;
8246: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
8247: @sorted =
8248: sort {
8249: if (ref($slots->{$a}) && ref($slots->{$b})) {
8250: return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
8251: }
8252: if (ref($slots->{$a})) { return -1;}
8253: if (ref($slots->{$b})) { return 1;}
8254: return 0;
8255: } @{$slotsarr};
8256: }
8257: return @sorted;
8258: }
8259:
8260:
8261: =pod
8262:
1.549 albertel 8263: =head1 HTTP Helpers
8264:
8265: =over 4
8266:
1.648 raeburn 8267: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 8268:
1.258 albertel 8269: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 8270: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 8271: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 8272:
8273: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
8274: $possible_names is an ref to an array of form element names. As an example:
8275: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 8276: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 8277:
8278: =cut
1.1 albertel 8279:
1.6 albertel 8280: sub get_unprocessed_cgi {
1.25 albertel 8281: my ($query,$possible_names)= @_;
1.26 matthew 8282: # $Apache::lonxml::debug=1;
1.356 albertel 8283: foreach my $pair (split(/&/,$query)) {
8284: my ($name, $value) = split(/=/,$pair);
1.369 www 8285: $name = &unescape($name);
1.25 albertel 8286: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
8287: $value =~ tr/+/ /;
8288: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 8289: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 8290: }
1.16 harris41 8291: }
1.6 albertel 8292: }
8293:
1.112 bowersj2 8294: =pod
8295:
1.648 raeburn 8296: =item * &cacheheader()
1.112 bowersj2 8297:
8298: returns cache-controlling header code
8299:
8300: =cut
8301:
1.7 albertel 8302: sub cacheheader {
1.258 albertel 8303: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 8304: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
8305: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 8306: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
8307: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 8308: return $output;
1.7 albertel 8309: }
8310:
1.112 bowersj2 8311: =pod
8312:
1.648 raeburn 8313: =item * &no_cache($r)
1.112 bowersj2 8314:
8315: specifies header code to not have cache
8316:
8317: =cut
8318:
1.9 albertel 8319: sub no_cache {
1.216 albertel 8320: my ($r) = @_;
8321: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 8322: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 8323: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
8324: $r->no_cache(1);
8325: $r->header_out("Expires" => $date);
8326: $r->header_out("Pragma" => "no-cache");
1.123 www 8327: }
8328:
8329: sub content_type {
1.181 albertel 8330: my ($r,$type,$charset) = @_;
1.299 foxr 8331: if ($r) {
8332: # Note that printout.pl calls this with undef for $r.
8333: &no_cache($r);
8334: }
1.258 albertel 8335: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 8336: unless ($charset) {
8337: $charset=&Apache::lonlocal::current_encoding;
8338: }
8339: if ($charset) { $type.='; charset='.$charset; }
8340: if ($r) {
8341: $r->content_type($type);
8342: } else {
8343: print("Content-type: $type\n\n");
8344: }
1.9 albertel 8345: }
1.25 albertel 8346:
1.112 bowersj2 8347: =pod
8348:
1.648 raeburn 8349: =item * &add_to_env($name,$value)
1.112 bowersj2 8350:
1.258 albertel 8351: adds $name to the %env hash with value
1.112 bowersj2 8352: $value, if $name already exists, the entry is converted to an array
8353: reference and $value is added to the array.
8354:
8355: =cut
8356:
1.25 albertel 8357: sub add_to_env {
8358: my ($name,$value)=@_;
1.258 albertel 8359: if (defined($env{$name})) {
8360: if (ref($env{$name})) {
1.25 albertel 8361: #already have multiple values
1.258 albertel 8362: push(@{ $env{$name} },$value);
1.25 albertel 8363: } else {
8364: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 8365: my $first=$env{$name};
8366: undef($env{$name});
8367: push(@{ $env{$name} },$first,$value);
1.25 albertel 8368: }
8369: } else {
1.258 albertel 8370: $env{$name}=$value;
1.25 albertel 8371: }
1.31 albertel 8372: }
1.149 albertel 8373:
8374: =pod
8375:
1.648 raeburn 8376: =item * &get_env_multiple($name)
1.149 albertel 8377:
1.258 albertel 8378: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 8379: values may be defined and end up as an array ref.
8380:
8381: returns an array of values
8382:
8383: =cut
8384:
8385: sub get_env_multiple {
8386: my ($name) = @_;
8387: my @values;
1.258 albertel 8388: if (defined($env{$name})) {
1.149 albertel 8389: # exists is it an array
1.258 albertel 8390: if (ref($env{$name})) {
8391: @values=@{ $env{$name} };
1.149 albertel 8392: } else {
1.258 albertel 8393: $values[0]=$env{$name};
1.149 albertel 8394: }
8395: }
8396: return(@values);
8397: }
8398:
1.660 raeburn 8399: sub ask_for_embedded_content {
8400: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
8401: my $upload_output = '
8402: <form name="upload_embedded" action="'.$actionurl.'"
8403: method="post" enctype="multipart/form-data">';
8404: $upload_output .= $state;
1.661 raeburn 8405: $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660 raeburn 8406:
8407: my $num = 0;
8408: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
8409: $upload_output .= &start_data_table_row().
8410: '<td>'.$embed_file.'</td><td>';
8411: if ($args->{'ignore_remote_references'}
8412: && $embed_file =~ m{^\w+://}) {
8413: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
8414: } elsif ($args->{'error_on_invalid_names'}
8415: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
8416:
8417: $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
8418:
8419: } else {
8420: $upload_output .='
1.661 raeburn 8421: <input name="embedded_item_'.$num.'" type="file" value="" />
1.660 raeburn 8422: <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
8423: my $attrib = join(':',@{$$allfiles{$embed_file}});
8424: $upload_output .=
8425: "\n\t\t".
8426: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
8427: $attrib.'" />';
8428: if (exists($$codebase{$embed_file})) {
8429: $upload_output .=
8430: "\n\t\t".
8431: '<input name="codebase_'.$num.'" type="hidden" value="'.
8432: &escape($$codebase{$embed_file}).'" />';
8433: }
8434: }
8435: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
8436: $num++;
8437: }
8438: $upload_output .= &Apache::loncommon::end_data_table().'<br />
8439: <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
8440: <input type ="submit" value="'.&mt('Upload Listed Files').'" />
8441: '.&mt('(only files for which a location has been provided will be uploaded)').'
8442: </form>';
8443: return $upload_output;
8444: }
8445:
1.661 raeburn 8446: sub upload_embedded {
8447: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
8448: $current_disk_usage) = @_;
8449: my $output;
8450: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
8451: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
8452: my $orig_uploaded_filename =
8453: $env{'form.embedded_item_'.$i.'.filename'};
8454:
8455: $env{'form.embedded_orig_'.$i} =
8456: &unescape($env{'form.embedded_orig_'.$i});
8457: my ($path,$fname) =
8458: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
8459: # no path, whole string is fname
8460: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
8461:
8462: $path = $env{'form.currentpath'}.$path;
8463: $fname = &Apache::lonnet::clean_filename($fname);
8464: # See if there is anything left
8465: next if ($fname eq '');
8466:
8467: # Check if file already exists as a file or directory.
8468: my ($state,$msg);
8469: if ($context eq 'portfolio') {
8470: my $port_path = $dirpath;
8471: if ($group ne '') {
8472: $port_path = "groups/$group/$port_path";
8473: }
8474: ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
8475: $dir_root,$port_path,$disk_quota,
8476: $current_disk_usage,$uname,$udom);
8477: if ($state eq 'will_exceed_quota'
8478: || $state eq 'file_locked'
8479: || $state eq 'file_exists' ) {
8480: $output .= $msg;
8481: next;
8482: }
8483: } elsif (($context eq 'author') || ($context eq 'testbank')) {
8484: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
8485: if ($state eq 'exists') {
8486: $output .= $msg;
8487: next;
8488: }
8489: }
8490: # Check if extension is valid
8491: if (($fname =~ /\.(\w+)$/) &&
8492: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
8493: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
8494: next;
8495: } elsif (($fname =~ /\.(\w+)$/) &&
8496: (!defined(&Apache::loncommon::fileembstyle($1)))) {
8497: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
8498: next;
8499: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
8500: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
8501: next;
8502: }
8503:
8504: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
8505: if ($context eq 'portfolio') {
8506: my $result=
8507: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
8508: $dirpath.$path);
8509: if ($result !~ m|^/uploaded/|) {
8510: $output .= '<span class="LC_error">'
8511: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
8512: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
8513: .'</span><br />';
8514: next;
8515: } else {
8516: $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
8517: $path.$fname.'</span>').'</p>';
8518: }
8519: } else {
8520: # Save the file
8521: my $target = $env{'form.embedded_item_'.$i};
8522: my $fullpath = $dir_root.$dirpath.'/'.$path;
8523: my $dest = $fullpath.$fname;
8524: my $url = $url_root.$dirpath.'/'.$path.$fname;
8525: my @parts=split(/\//,$fullpath);
8526: my $count;
8527: my $filepath = $dir_root;
8528: for ($count=4;$count<=$#parts;$count++) {
8529: $filepath .= "/$parts[$count]";
8530: if ((-e $filepath)!=1) {
8531: mkdir($filepath,0770);
8532: }
8533: }
8534: my $fh;
8535: if (!open($fh,'>'.$dest)) {
8536: &Apache::lonnet::logthis('Failed to create '.$dest);
8537: $output .= '<span class="LC_error">'.
8538: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8539: '</span><br />';
8540: } else {
8541: if (!print $fh $env{'form.embedded_item_'.$i}) {
8542: &Apache::lonnet::logthis('Failed to write to '.$dest);
8543: $output .= '<span class="LC_error">'.
8544: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8545: '</span><br />';
8546: } else {
8547: if ($context eq 'testbank') {
8548: $output .= &mt('Embedded file uploaded successfully:').
8549: ' <a href="'.$url.'">'.
8550: $orig_uploaded_filename.'</a><br />';
8551: } else {
1.705 tempelho 8552: $output .= '<span class=\"LC_fontsize_large\">'.
1.661 raeburn 8553: &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705 tempelho 8554: $orig_uploaded_filename.'</a>').'</span><br />';
1.661 raeburn 8555: }
8556: }
8557: close($fh);
8558: }
8559: }
8560: }
8561: return $output;
8562: }
8563:
8564: sub check_for_existing {
8565: my ($path,$fname,$element) = @_;
8566: my ($state,$msg);
8567: if (-d $path.'/'.$fname) {
8568: $state = 'exists';
8569: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8570: } elsif (-e $path.'/'.$fname) {
8571: $state = 'exists';
8572: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8573: }
8574: if ($state eq 'exists') {
8575: $msg = '<span class="LC_error">'.$msg.'</span><br />';
8576: }
8577: return ($state,$msg);
8578: }
8579:
8580: sub check_for_upload {
8581: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
8582: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
8583: my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
8584: my $getpropath = 1;
8585: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
8586: $getpropath);
8587: my $found_file = 0;
8588: my $locked_file = 0;
8589: foreach my $line (@dir_list) {
8590: my ($file_name)=split(/\&/,$line,2);
8591: if ($file_name eq $fname){
8592: $file_name = $path.$file_name;
8593: if ($group ne '') {
8594: $file_name = $group.$file_name;
8595: }
8596: $found_file = 1;
8597: if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
8598: $locked_file = 1;
8599: }
8600: }
8601: }
8602: if (($current_disk_usage + $filesize) > $disk_quota){
8603: my $msg = '<span class="LC_error">'.
8604: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
8605: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
8606: return ('will_exceed_quota',$msg);
8607: } elsif ($found_file) {
8608: if ($locked_file) {
8609: my $msg = '<span class="LC_error">';
8610: $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>');
8611: $msg .= '</span><br />';
8612: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
8613: return ('file_locked',$msg);
8614: } else {
8615: my $msg = '<span class="LC_error">';
8616: $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'});
8617: $msg .= '</span>';
8618: $msg .= '<br />';
8619: $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
8620: return ('file_exists',$msg);
8621: }
8622: }
8623: }
8624:
1.31 albertel 8625:
1.41 ng 8626: =pod
1.45 matthew 8627:
1.464 albertel 8628: =back
1.41 ng 8629:
1.112 bowersj2 8630: =head1 CSV Upload/Handling functions
1.38 albertel 8631:
1.41 ng 8632: =over 4
8633:
1.648 raeburn 8634: =item * &upfile_store($r)
1.41 ng 8635:
8636: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 8637: needs $env{'form.upfile'}
1.41 ng 8638: returns $datatoken to be put into hidden field
8639:
8640: =cut
1.31 albertel 8641:
8642: sub upfile_store {
8643: my $r=shift;
1.258 albertel 8644: $env{'form.upfile'}=~s/\r/\n/gs;
8645: $env{'form.upfile'}=~s/\f/\n/gs;
8646: $env{'form.upfile'}=~s/\n+/\n/gs;
8647: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 8648:
1.258 albertel 8649: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
8650: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 8651: {
1.158 raeburn 8652: my $datafile = $r->dir_config('lonDaemons').
8653: '/tmp/'.$datatoken.'.tmp';
8654: if ( open(my $fh,">$datafile") ) {
1.258 albertel 8655: print $fh $env{'form.upfile'};
1.158 raeburn 8656: close($fh);
8657: }
1.31 albertel 8658: }
8659: return $datatoken;
8660: }
8661:
1.56 matthew 8662: =pod
8663:
1.648 raeburn 8664: =item * &load_tmp_file($r)
1.41 ng 8665:
8666: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 8667: needs $env{'form.datatoken'},
8668: sets $env{'form.upfile'} to the contents of the file
1.41 ng 8669:
8670: =cut
1.31 albertel 8671:
8672: sub load_tmp_file {
8673: my $r=shift;
8674: my @studentdata=();
8675: {
1.158 raeburn 8676: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 8677: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 8678: if ( open(my $fh,"<$studentfile") ) {
8679: @studentdata=<$fh>;
8680: close($fh);
8681: }
1.31 albertel 8682: }
1.258 albertel 8683: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 8684: }
8685:
1.56 matthew 8686: =pod
8687:
1.648 raeburn 8688: =item * &upfile_record_sep()
1.41 ng 8689:
8690: Separate uploaded file into records
8691: returns array of records,
1.258 albertel 8692: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 8693:
8694: =cut
1.31 albertel 8695:
8696: sub upfile_record_sep {
1.258 albertel 8697: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 8698: } else {
1.248 albertel 8699: my @records;
1.258 albertel 8700: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 8701: if ($line=~/^\s*$/) { next; }
8702: push(@records,$line);
8703: }
8704: return @records;
1.31 albertel 8705: }
8706: }
8707:
1.56 matthew 8708: =pod
8709:
1.648 raeburn 8710: =item * &record_sep($record)
1.41 ng 8711:
1.258 albertel 8712: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 8713:
8714: =cut
8715:
1.263 www 8716: sub takeleft {
8717: my $index=shift;
8718: return substr('0000'.$index,-4,4);
8719: }
8720:
1.31 albertel 8721: sub record_sep {
8722: my $record=shift;
8723: my %components=();
1.258 albertel 8724: if ($env{'form.upfiletype'} eq 'xml') {
8725: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 8726: my $i=0;
1.356 albertel 8727: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 8728: $field=~s/^(\"|\')//;
8729: $field=~s/(\"|\')$//;
1.263 www 8730: $components{&takeleft($i)}=$field;
1.31 albertel 8731: $i++;
8732: }
1.258 albertel 8733: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 8734: my $i=0;
1.356 albertel 8735: foreach my $field (split(/\t/,$record)) {
1.31 albertel 8736: $field=~s/^(\"|\')//;
8737: $field=~s/(\"|\')$//;
1.263 www 8738: $components{&takeleft($i)}=$field;
1.31 albertel 8739: $i++;
8740: }
8741: } else {
1.561 www 8742: my $separator=',';
1.480 banghart 8743: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 8744: $separator=';';
1.480 banghart 8745: }
1.31 albertel 8746: my $i=0;
1.561 www 8747: # the character we are looking for to indicate the end of a quote or a record
8748: my $looking_for=$separator;
8749: # do not add the characters to the fields
8750: my $ignore=0;
8751: # we just encountered a separator (or the beginning of the record)
8752: my $just_found_separator=1;
8753: # store the field we are working on here
8754: my $field='';
8755: # work our way through all characters in record
8756: foreach my $character ($record=~/(.)/g) {
8757: if ($character eq $looking_for) {
8758: if ($character ne $separator) {
8759: # Found the end of a quote, again looking for separator
8760: $looking_for=$separator;
8761: $ignore=1;
8762: } else {
8763: # Found a separator, store away what we got
8764: $components{&takeleft($i)}=$field;
8765: $i++;
8766: $just_found_separator=1;
8767: $ignore=0;
8768: $field='';
8769: }
8770: next;
8771: }
8772: # single or double quotation marks after a separator indicate beginning of a quote
8773: # we are now looking for the end of the quote and need to ignore separators
8774: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
8775: $looking_for=$character;
8776: next;
8777: }
8778: # ignore would be true after we reached the end of a quote
8779: if ($ignore) { next; }
8780: if (($just_found_separator) && ($character=~/\s/)) { next; }
8781: $field.=$character;
8782: $just_found_separator=0;
1.31 albertel 8783: }
1.561 www 8784: # catch the very last entry, since we never encountered the separator
8785: $components{&takeleft($i)}=$field;
1.31 albertel 8786: }
8787: return %components;
8788: }
8789:
1.144 matthew 8790: ######################################################
8791: ######################################################
8792:
1.56 matthew 8793: =pod
8794:
1.648 raeburn 8795: =item * &upfile_select_html()
1.41 ng 8796:
1.144 matthew 8797: Return HTML code to select a file from the users machine and specify
8798: the file type.
1.41 ng 8799:
8800: =cut
8801:
1.144 matthew 8802: ######################################################
8803: ######################################################
1.31 albertel 8804: sub upfile_select_html {
1.144 matthew 8805: my %Types = (
8806: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 8807: semisv => &mt('Semicolon separated values'),
1.144 matthew 8808: space => &mt('Space separated'),
8809: tab => &mt('Tabulator separated'),
8810: # xml => &mt('HTML/XML'),
8811: );
8812: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 8813: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 8814: foreach my $type (sort(keys(%Types))) {
8815: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
8816: }
8817: $Str .= "</select>\n";
8818: return $Str;
1.31 albertel 8819: }
8820:
1.301 albertel 8821: sub get_samples {
8822: my ($records,$toget) = @_;
8823: my @samples=({});
8824: my $got=0;
8825: foreach my $rec (@$records) {
8826: my %temp = &record_sep($rec);
8827: if (! grep(/\S/, values(%temp))) { next; }
8828: if (%temp) {
8829: $samples[$got]=\%temp;
8830: $got++;
8831: if ($got == $toget) { last; }
8832: }
8833: }
8834: return \@samples;
8835: }
8836:
1.144 matthew 8837: ######################################################
8838: ######################################################
8839:
1.56 matthew 8840: =pod
8841:
1.648 raeburn 8842: =item * &csv_print_samples($r,$records)
1.41 ng 8843:
8844: Prints a table of sample values from each column uploaded $r is an
8845: Apache Request ref, $records is an arrayref from
8846: &Apache::loncommon::upfile_record_sep
8847:
8848: =cut
8849:
1.144 matthew 8850: ######################################################
8851: ######################################################
1.31 albertel 8852: sub csv_print_samples {
8853: my ($r,$records) = @_;
1.662 bisitz 8854: my $samples = &get_samples($records,5);
1.301 albertel 8855:
1.594 raeburn 8856: $r->print(&mt('Samples').'<br />'.&start_data_table().
8857: &start_data_table_header_row());
1.356 albertel 8858: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 8859: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 8860: $r->print(&end_data_table_header_row());
1.301 albertel 8861: foreach my $hash (@$samples) {
1.594 raeburn 8862: $r->print(&start_data_table_row());
1.356 albertel 8863: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 8864: $r->print('<td>');
1.356 albertel 8865: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 8866: $r->print('</td>');
8867: }
1.594 raeburn 8868: $r->print(&end_data_table_row());
1.31 albertel 8869: }
1.594 raeburn 8870: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 8871: }
8872:
1.144 matthew 8873: ######################################################
8874: ######################################################
8875:
1.56 matthew 8876: =pod
8877:
1.648 raeburn 8878: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 8879:
8880: Prints a table to create associations between values and table columns.
1.144 matthew 8881:
1.41 ng 8882: $r is an Apache Request ref,
8883: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 8884: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 8885:
8886: =cut
8887:
1.144 matthew 8888: ######################################################
8889: ######################################################
1.31 albertel 8890: sub csv_print_select_table {
8891: my ($r,$records,$d) = @_;
1.301 albertel 8892: my $i=0;
8893: my $samples = &get_samples($records,1);
1.144 matthew 8894: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 8895: &start_data_table().&start_data_table_header_row().
1.144 matthew 8896: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 8897: '<th>'.&mt('Column').'</th>'.
8898: &end_data_table_header_row()."\n");
1.356 albertel 8899: foreach my $array_ref (@$d) {
8900: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 8901: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 8902:
1.875 bisitz 8903: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 8904: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 8905: $r->print('<option value="none"></option>');
1.356 albertel 8906: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8907: $r->print('<option value="'.$sample.'"'.
8908: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 8909: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 8910: }
1.594 raeburn 8911: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 8912: $i++;
8913: }
1.594 raeburn 8914: $r->print(&end_data_table());
1.31 albertel 8915: $i--;
8916: return $i;
8917: }
1.56 matthew 8918:
1.144 matthew 8919: ######################################################
8920: ######################################################
8921:
1.56 matthew 8922: =pod
1.31 albertel 8923:
1.648 raeburn 8924: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 8925:
8926: Prints a table of sample values from the upload and can make associate samples to internal names.
8927:
8928: $r is an Apache Request ref,
8929: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
8930: $d is an array of 2 element arrays (internal name, displayed name)
8931:
8932: =cut
8933:
1.144 matthew 8934: ######################################################
8935: ######################################################
1.31 albertel 8936: sub csv_samples_select_table {
8937: my ($r,$records,$d) = @_;
8938: my $i=0;
1.144 matthew 8939: #
1.662 bisitz 8940: my $max_samples = 5;
8941: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 8942: $r->print(&start_data_table().
8943: &start_data_table_header_row().'<th>'.
8944: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
8945: &end_data_table_header_row());
1.301 albertel 8946:
8947: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 8948: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 8949: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 8950: foreach my $option (@$d) {
8951: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 8952: $r->print('<option value="'.$value.'"'.
1.253 albertel 8953: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 8954: $display.'</option>');
1.31 albertel 8955: }
8956: $r->print('</select></td><td>');
1.662 bisitz 8957: foreach my $line (0..($max_samples-1)) {
1.301 albertel 8958: if (defined($samples->[$line]{$key})) {
8959: $r->print($samples->[$line]{$key}."<br />\n");
8960: }
8961: }
1.594 raeburn 8962: $r->print('</td>'.&end_data_table_row());
1.31 albertel 8963: $i++;
8964: }
1.594 raeburn 8965: $r->print(&end_data_table());
1.31 albertel 8966: $i--;
8967: return($i);
1.115 matthew 8968: }
8969:
1.144 matthew 8970: ######################################################
8971: ######################################################
8972:
1.115 matthew 8973: =pod
8974:
1.648 raeburn 8975: =item * &clean_excel_name($name)
1.115 matthew 8976:
8977: Returns a replacement for $name which does not contain any illegal characters.
8978:
8979: =cut
8980:
1.144 matthew 8981: ######################################################
8982: ######################################################
1.115 matthew 8983: sub clean_excel_name {
8984: my ($name) = @_;
8985: $name =~ s/[:\*\?\/\\]//g;
8986: if (length($name) > 31) {
8987: $name = substr($name,0,31);
8988: }
8989: return $name;
1.25 albertel 8990: }
1.84 albertel 8991:
1.85 albertel 8992: =pod
8993:
1.648 raeburn 8994: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 8995:
8996: Returns either 1 or undef
8997:
8998: 1 if the part is to be hidden, undef if it is to be shown
8999:
9000: Arguments are:
9001:
9002: $id the id of the part to be checked
9003: $symb, optional the symb of the resource to check
9004: $udom, optional the domain of the user to check for
9005: $uname, optional the username of the user to check for
9006:
9007: =cut
1.84 albertel 9008:
9009: sub check_if_partid_hidden {
9010: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 9011: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 9012: $symb,$udom,$uname);
1.141 albertel 9013: my $truth=1;
9014: #if the string starts with !, then the list is the list to show not hide
9015: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 9016: my @hiddenlist=split(/,/,$hiddenparts);
9017: foreach my $checkid (@hiddenlist) {
1.141 albertel 9018: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 9019: }
1.141 albertel 9020: return !$truth;
1.84 albertel 9021: }
1.127 matthew 9022:
1.138 matthew 9023:
9024: ############################################################
9025: ############################################################
9026:
9027: =pod
9028:
1.157 matthew 9029: =back
9030:
1.138 matthew 9031: =head1 cgi-bin script and graphing routines
9032:
1.157 matthew 9033: =over 4
9034:
1.648 raeburn 9035: =item * &get_cgi_id()
1.138 matthew 9036:
9037: Inputs: none
9038:
9039: Returns an id which can be used to pass environment variables
9040: to various cgi-bin scripts. These environment variables will
9041: be removed from the users environment after a given time by
9042: the routine &Apache::lonnet::transfer_profile_to_env.
9043:
9044: =cut
9045:
9046: ############################################################
9047: ############################################################
1.152 albertel 9048: my $uniq=0;
1.136 matthew 9049: sub get_cgi_id {
1.154 albertel 9050: $uniq=($uniq+1)%100000;
1.280 albertel 9051: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 9052: }
9053:
1.127 matthew 9054: ############################################################
9055: ############################################################
9056:
9057: =pod
9058:
1.648 raeburn 9059: =item * &DrawBarGraph()
1.127 matthew 9060:
1.138 matthew 9061: Facilitates the plotting of data in a (stacked) bar graph.
9062: Puts plot definition data into the users environment in order for
9063: graph.png to plot it. Returns an <img> tag for the plot.
9064: The bars on the plot are labeled '1','2',...,'n'.
9065:
9066: Inputs:
9067:
9068: =over 4
9069:
9070: =item $Title: string, the title of the plot
9071:
9072: =item $xlabel: string, text describing the X-axis of the plot
9073:
9074: =item $ylabel: string, text describing the Y-axis of the plot
9075:
9076: =item $Max: scalar, the maximum Y value to use in the plot
9077: If $Max is < any data point, the graph will not be rendered.
9078:
1.140 matthew 9079: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 9080: they are plotted. If undefined, default values will be used.
9081:
1.178 matthew 9082: =item $labels: array ref holding the labels to use on the x-axis for the bars.
9083:
1.138 matthew 9084: =item @Values: An array of array references. Each array reference holds data
9085: to be plotted in a stacked bar chart.
9086:
1.239 matthew 9087: =item If the final element of @Values is a hash reference the key/value
9088: pairs will be added to the graph definition.
9089:
1.138 matthew 9090: =back
9091:
9092: Returns:
9093:
9094: An <img> tag which references graph.png and the appropriate identifying
9095: information for the plot.
9096:
1.127 matthew 9097: =cut
9098:
9099: ############################################################
9100: ############################################################
1.134 matthew 9101: sub DrawBarGraph {
1.178 matthew 9102: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 9103: #
9104: if (! defined($colors)) {
9105: $colors = ['#33ff00',
9106: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
9107: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
9108: ];
9109: }
1.228 matthew 9110: my $extra_settings = {};
9111: if (ref($Values[-1]) eq 'HASH') {
9112: $extra_settings = pop(@Values);
9113: }
1.127 matthew 9114: #
1.136 matthew 9115: my $identifier = &get_cgi_id();
9116: my $id = 'cgi.'.$identifier;
1.129 matthew 9117: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 9118: return '';
9119: }
1.225 matthew 9120: #
9121: my @Labels;
9122: if (defined($labels)) {
9123: @Labels = @$labels;
9124: } else {
9125: for (my $i=0;$i<@{$Values[0]};$i++) {
9126: push (@Labels,$i+1);
9127: }
9128: }
9129: #
1.129 matthew 9130: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 9131: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 9132: my %ValuesHash;
9133: my $NumSets=1;
9134: foreach my $array (@Values) {
9135: next if (! ref($array));
1.136 matthew 9136: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 9137: join(',',@$array);
1.129 matthew 9138: }
1.127 matthew 9139: #
1.136 matthew 9140: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 9141: if ($NumBars < 3) {
9142: $width = 120+$NumBars*32;
1.220 matthew 9143: $xskip = 1;
1.225 matthew 9144: $bar_width = 30;
9145: } elsif ($NumBars < 5) {
9146: $width = 120+$NumBars*20;
9147: $xskip = 1;
9148: $bar_width = 20;
1.220 matthew 9149: } elsif ($NumBars < 10) {
1.136 matthew 9150: $width = 120+$NumBars*15;
9151: $xskip = 1;
9152: $bar_width = 15;
9153: } elsif ($NumBars <= 25) {
9154: $width = 120+$NumBars*11;
9155: $xskip = 5;
9156: $bar_width = 8;
9157: } elsif ($NumBars <= 50) {
9158: $width = 120+$NumBars*8;
9159: $xskip = 5;
9160: $bar_width = 4;
9161: } else {
9162: $width = 120+$NumBars*8;
9163: $xskip = 5;
9164: $bar_width = 4;
9165: }
9166: #
1.137 matthew 9167: $Max = 1 if ($Max < 1);
9168: if ( int($Max) < $Max ) {
9169: $Max++;
9170: $Max = int($Max);
9171: }
1.127 matthew 9172: $Title = '' if (! defined($Title));
9173: $xlabel = '' if (! defined($xlabel));
9174: $ylabel = '' if (! defined($ylabel));
1.369 www 9175: $ValuesHash{$id.'.title'} = &escape($Title);
9176: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
9177: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 9178: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 9179: $ValuesHash{$id.'.NumBars'} = $NumBars;
9180: $ValuesHash{$id.'.NumSets'} = $NumSets;
9181: $ValuesHash{$id.'.PlotType'} = 'bar';
9182: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9183: $ValuesHash{$id.'.height'} = $height;
9184: $ValuesHash{$id.'.width'} = $width;
9185: $ValuesHash{$id.'.xskip'} = $xskip;
9186: $ValuesHash{$id.'.bar_width'} = $bar_width;
9187: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 9188: #
1.228 matthew 9189: # Deal with other parameters
9190: while (my ($key,$value) = each(%$extra_settings)) {
9191: $ValuesHash{$id.'.'.$key} = $value;
9192: }
9193: #
1.646 raeburn 9194: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 9195: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9196: }
9197:
9198: ############################################################
9199: ############################################################
9200:
9201: =pod
9202:
1.648 raeburn 9203: =item * &DrawXYGraph()
1.137 matthew 9204:
1.138 matthew 9205: Facilitates the plotting of data in an XY graph.
9206: Puts plot definition data into the users environment in order for
9207: graph.png to plot it. Returns an <img> tag for the plot.
9208:
9209: Inputs:
9210:
9211: =over 4
9212:
9213: =item $Title: string, the title of the plot
9214:
9215: =item $xlabel: string, text describing the X-axis of the plot
9216:
9217: =item $ylabel: string, text describing the Y-axis of the plot
9218:
9219: =item $Max: scalar, the maximum Y value to use in the plot
9220: If $Max is < any data point, the graph will not be rendered.
9221:
9222: =item $colors: Array ref containing the hex color codes for the data to be
9223: plotted in. If undefined, default values will be used.
9224:
9225: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9226:
9227: =item $Ydata: Array ref containing Array refs.
1.185 www 9228: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 9229:
9230: =item %Values: hash indicating or overriding any default values which are
9231: passed to graph.png.
9232: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9233:
9234: =back
9235:
9236: Returns:
9237:
9238: An <img> tag which references graph.png and the appropriate identifying
9239: information for the plot.
9240:
1.137 matthew 9241: =cut
9242:
9243: ############################################################
9244: ############################################################
9245: sub DrawXYGraph {
9246: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
9247: #
9248: # Create the identifier for the graph
9249: my $identifier = &get_cgi_id();
9250: my $id = 'cgi.'.$identifier;
9251: #
9252: $Title = '' if (! defined($Title));
9253: $xlabel = '' if (! defined($xlabel));
9254: $ylabel = '' if (! defined($ylabel));
9255: my %ValuesHash =
9256: (
1.369 www 9257: $id.'.title' => &escape($Title),
9258: $id.'.xlabel' => &escape($xlabel),
9259: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 9260: $id.'.y_max_value'=> $Max,
9261: $id.'.labels' => join(',',@$Xlabels),
9262: $id.'.PlotType' => 'XY',
9263: );
9264: #
9265: if (defined($colors) && ref($colors) eq 'ARRAY') {
9266: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9267: }
9268: #
9269: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
9270: return '';
9271: }
9272: my $NumSets=1;
1.138 matthew 9273: foreach my $array (@{$Ydata}){
1.137 matthew 9274: next if (! ref($array));
9275: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
9276: }
1.138 matthew 9277: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 9278: #
9279: # Deal with other parameters
9280: while (my ($key,$value) = each(%Values)) {
9281: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 9282: }
9283: #
1.646 raeburn 9284: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 9285: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9286: }
9287:
9288: ############################################################
9289: ############################################################
9290:
9291: =pod
9292:
1.648 raeburn 9293: =item * &DrawXYYGraph()
1.138 matthew 9294:
9295: Facilitates the plotting of data in an XY graph with two Y axes.
9296: Puts plot definition data into the users environment in order for
9297: graph.png to plot it. Returns an <img> tag for the plot.
9298:
9299: Inputs:
9300:
9301: =over 4
9302:
9303: =item $Title: string, the title of the plot
9304:
9305: =item $xlabel: string, text describing the X-axis of the plot
9306:
9307: =item $ylabel: string, text describing the Y-axis of the plot
9308:
9309: =item $colors: Array ref containing the hex color codes for the data to be
9310: plotted in. If undefined, default values will be used.
9311:
9312: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9313:
9314: =item $Ydata1: The first data set
9315:
9316: =item $Min1: The minimum value of the left Y-axis
9317:
9318: =item $Max1: The maximum value of the left Y-axis
9319:
9320: =item $Ydata2: The second data set
9321:
9322: =item $Min2: The minimum value of the right Y-axis
9323:
9324: =item $Max2: The maximum value of the left Y-axis
9325:
9326: =item %Values: hash indicating or overriding any default values which are
9327: passed to graph.png.
9328: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9329:
9330: =back
9331:
9332: Returns:
9333:
9334: An <img> tag which references graph.png and the appropriate identifying
9335: information for the plot.
1.136 matthew 9336:
9337: =cut
9338:
9339: ############################################################
9340: ############################################################
1.137 matthew 9341: sub DrawXYYGraph {
9342: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
9343: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 9344: #
9345: # Create the identifier for the graph
9346: my $identifier = &get_cgi_id();
9347: my $id = 'cgi.'.$identifier;
9348: #
9349: $Title = '' if (! defined($Title));
9350: $xlabel = '' if (! defined($xlabel));
9351: $ylabel = '' if (! defined($ylabel));
9352: my %ValuesHash =
9353: (
1.369 www 9354: $id.'.title' => &escape($Title),
9355: $id.'.xlabel' => &escape($xlabel),
9356: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 9357: $id.'.labels' => join(',',@$Xlabels),
9358: $id.'.PlotType' => 'XY',
9359: $id.'.NumSets' => 2,
1.137 matthew 9360: $id.'.two_axes' => 1,
9361: $id.'.y1_max_value' => $Max1,
9362: $id.'.y1_min_value' => $Min1,
9363: $id.'.y2_max_value' => $Max2,
9364: $id.'.y2_min_value' => $Min2,
1.136 matthew 9365: );
9366: #
1.137 matthew 9367: if (defined($colors) && ref($colors) eq 'ARRAY') {
9368: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9369: }
9370: #
9371: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
9372: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 9373: return '';
9374: }
9375: my $NumSets=1;
1.137 matthew 9376: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 9377: next if (! ref($array));
9378: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 9379: }
9380: #
9381: # Deal with other parameters
9382: while (my ($key,$value) = each(%Values)) {
9383: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 9384: }
9385: #
1.646 raeburn 9386: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 9387: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 9388: }
9389:
9390: ############################################################
9391: ############################################################
9392:
9393: =pod
9394:
1.157 matthew 9395: =back
9396:
1.139 matthew 9397: =head1 Statistics helper routines?
9398:
9399: Bad place for them but what the hell.
9400:
1.157 matthew 9401: =over 4
9402:
1.648 raeburn 9403: =item * &chartlink()
1.139 matthew 9404:
9405: Returns a link to the chart for a specific student.
9406:
9407: Inputs:
9408:
9409: =over 4
9410:
9411: =item $linktext: The text of the link
9412:
9413: =item $sname: The students username
9414:
9415: =item $sdomain: The students domain
9416:
9417: =back
9418:
1.157 matthew 9419: =back
9420:
1.139 matthew 9421: =cut
9422:
9423: ############################################################
9424: ############################################################
9425: sub chartlink {
9426: my ($linktext, $sname, $sdomain) = @_;
9427: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 9428: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 9429: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 9430: '">'.$linktext.'</a>';
1.153 matthew 9431: }
9432:
9433: #######################################################
9434: #######################################################
9435:
9436: =pod
9437:
9438: =head1 Course Environment Routines
1.157 matthew 9439:
9440: =over 4
1.153 matthew 9441:
1.648 raeburn 9442: =item * &restore_course_settings()
1.153 matthew 9443:
1.648 raeburn 9444: =item * &store_course_settings()
1.153 matthew 9445:
9446: Restores/Store indicated form parameters from the course environment.
9447: Will not overwrite existing values of the form parameters.
9448:
9449: Inputs:
9450: a scalar describing the data (e.g. 'chart', 'problem_analysis')
9451:
9452: a hash ref describing the data to be stored. For example:
9453:
9454: %Save_Parameters = ('Status' => 'scalar',
9455: 'chartoutputmode' => 'scalar',
9456: 'chartoutputdata' => 'scalar',
9457: 'Section' => 'array',
1.373 raeburn 9458: 'Group' => 'array',
1.153 matthew 9459: 'StudentData' => 'array',
9460: 'Maps' => 'array');
9461:
9462: Returns: both routines return nothing
9463:
1.631 raeburn 9464: =back
9465:
1.153 matthew 9466: =cut
9467:
9468: #######################################################
9469: #######################################################
9470: sub store_course_settings {
1.496 albertel 9471: return &store_settings($env{'request.course.id'},@_);
9472: }
9473:
9474: sub store_settings {
1.153 matthew 9475: # save to the environment
9476: # appenv the same items, just to be safe
1.300 albertel 9477: my $udom = $env{'user.domain'};
9478: my $uname = $env{'user.name'};
1.496 albertel 9479: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9480: my %SaveHash;
9481: my %AppHash;
9482: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 9483: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 9484: my $envname = 'environment.'.$basename;
1.258 albertel 9485: if (exists($env{'form.'.$setting})) {
1.153 matthew 9486: # Save this value away
9487: if ($type eq 'scalar' &&
1.258 albertel 9488: (! exists($env{$envname}) ||
9489: $env{$envname} ne $env{'form.'.$setting})) {
9490: $SaveHash{$basename} = $env{'form.'.$setting};
9491: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 9492: } elsif ($type eq 'array') {
9493: my $stored_form;
1.258 albertel 9494: if (ref($env{'form.'.$setting})) {
1.153 matthew 9495: $stored_form = join(',',
9496: map {
1.369 www 9497: &escape($_);
1.258 albertel 9498: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 9499: } else {
9500: $stored_form =
1.369 www 9501: &escape($env{'form.'.$setting});
1.153 matthew 9502: }
9503: # Determine if the array contents are the same.
1.258 albertel 9504: if ($stored_form ne $env{$envname}) {
1.153 matthew 9505: $SaveHash{$basename} = $stored_form;
9506: $AppHash{$envname} = $stored_form;
9507: }
9508: }
9509: }
9510: }
9511: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 9512: $udom,$uname);
1.153 matthew 9513: if ($put_result !~ /^(ok|delayed)/) {
9514: &Apache::lonnet::logthis('unable to save form parameters, '.
9515: 'got error:'.$put_result);
9516: }
9517: # Make sure these settings stick around in this session, too
1.646 raeburn 9518: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 9519: return;
9520: }
9521:
9522: sub restore_course_settings {
1.499 albertel 9523: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 9524: }
9525:
9526: sub restore_settings {
9527: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9528: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 9529: next if (exists($env{'form.'.$setting}));
1.496 albertel 9530: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 9531: '.'.$setting;
1.258 albertel 9532: if (exists($env{$envname})) {
1.153 matthew 9533: if ($type eq 'scalar') {
1.258 albertel 9534: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 9535: } elsif ($type eq 'array') {
1.258 albertel 9536: $env{'form.'.$setting} = [
1.153 matthew 9537: map {
1.369 www 9538: &unescape($_);
1.258 albertel 9539: } split(',',$env{$envname})
1.153 matthew 9540: ];
9541: }
9542: }
9543: }
1.127 matthew 9544: }
9545:
1.618 raeburn 9546: #######################################################
9547: #######################################################
9548:
9549: =pod
9550:
9551: =head1 Domain E-mail Routines
9552:
9553: =over 4
9554:
1.648 raeburn 9555: =item * &build_recipient_list()
1.618 raeburn 9556:
1.884 raeburn 9557: Build recipient lists for five types of e-mail:
1.766 raeburn 9558: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884 raeburn 9559: (d) Help requests, (e) Course requests needing approval, generated by
9560: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
9561: loncoursequeueadmin.pm respectively.
1.618 raeburn 9562:
9563: Inputs:
1.619 raeburn 9564: defmail (scalar - email address of default recipient),
1.618 raeburn 9565: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 9566: defdom (domain for which to retrieve configuration settings),
9567: origmail (scalar - email address of recipient from loncapa.conf,
9568: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 9569:
1.655 raeburn 9570: Returns: comma separated list of addresses to which to send e-mail.
9571:
9572: =back
1.618 raeburn 9573:
9574: =cut
9575:
9576: ############################################################
9577: ############################################################
9578: sub build_recipient_list {
1.619 raeburn 9579: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 9580: my @recipients;
9581: my $otheremails;
9582: my %domconfig =
9583: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
9584: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 9585: if (exists($domconfig{'contacts'}{$mailing})) {
9586: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
9587: my @contacts = ('adminemail','supportemail');
9588: foreach my $item (@contacts) {
9589: if ($domconfig{'contacts'}{$mailing}{$item}) {
9590: my $addr = $domconfig{'contacts'}{$item};
9591: if (!grep(/^\Q$addr\E$/,@recipients)) {
9592: push(@recipients,$addr);
9593: }
1.619 raeburn 9594: }
1.766 raeburn 9595: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 9596: }
9597: }
1.766 raeburn 9598: } elsif ($origmail ne '') {
9599: push(@recipients,$origmail);
1.618 raeburn 9600: }
1.619 raeburn 9601: } elsif ($origmail ne '') {
9602: push(@recipients,$origmail);
1.618 raeburn 9603: }
1.688 raeburn 9604: if (defined($defmail)) {
9605: if ($defmail ne '') {
9606: push(@recipients,$defmail);
9607: }
1.618 raeburn 9608: }
9609: if ($otheremails) {
1.619 raeburn 9610: my @others;
9611: if ($otheremails =~ /,/) {
9612: @others = split(/,/,$otheremails);
1.618 raeburn 9613: } else {
1.619 raeburn 9614: push(@others,$otheremails);
9615: }
9616: foreach my $addr (@others) {
9617: if (!grep(/^\Q$addr\E$/,@recipients)) {
9618: push(@recipients,$addr);
9619: }
1.618 raeburn 9620: }
9621: }
1.619 raeburn 9622: my $recipientlist = join(',',@recipients);
1.618 raeburn 9623: return $recipientlist;
9624: }
9625:
1.127 matthew 9626: ############################################################
9627: ############################################################
1.154 albertel 9628:
1.655 raeburn 9629: =pod
9630:
9631: =head1 Course Catalog Routines
9632:
9633: =over 4
9634:
9635: =item * &gather_categories()
9636:
9637: Converts category definitions - keys of categories hash stored in
9638: coursecategories in configuration.db on the primary library server in a
9639: domain - to an array. Also generates javascript and idx hash used to
9640: generate Domain Coordinator interface for editing Course Categories.
9641:
9642: Inputs:
1.663 raeburn 9643:
1.655 raeburn 9644: categories (reference to hash of category definitions).
1.663 raeburn 9645:
1.655 raeburn 9646: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9647: categories and subcategories).
1.663 raeburn 9648:
1.655 raeburn 9649: idx (reference to hash of counters used in Domain Coordinator interface for
9650: editing Course Categories).
1.663 raeburn 9651:
1.655 raeburn 9652: jsarray (reference to array of categories used to create Javascript arrays for
9653: Domain Coordinator interface for editing Course Categories).
9654:
9655: Returns: nothing
9656:
9657: Side effects: populates cats, idx and jsarray.
9658:
9659: =cut
9660:
9661: sub gather_categories {
9662: my ($categories,$cats,$idx,$jsarray) = @_;
9663: my %counters;
9664: my $num = 0;
9665: foreach my $item (keys(%{$categories})) {
9666: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
9667: if ($container eq '' && $depth == 0) {
9668: $cats->[$depth][$categories->{$item}] = $cat;
9669: } else {
9670: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
9671: }
9672: my ($escitem,$tail) = split(/:/,$item,2);
9673: if ($counters{$tail} eq '') {
9674: $counters{$tail} = $num;
9675: $num ++;
9676: }
9677: if (ref($idx) eq 'HASH') {
9678: $idx->{$item} = $counters{$tail};
9679: }
9680: if (ref($jsarray) eq 'ARRAY') {
9681: push(@{$jsarray->[$counters{$tail}]},$item);
9682: }
9683: }
9684: return;
9685: }
9686:
9687: =pod
9688:
9689: =item * &extract_categories()
9690:
9691: Used to generate breadcrumb trails for course categories.
9692:
9693: Inputs:
1.663 raeburn 9694:
1.655 raeburn 9695: categories (reference to hash of category definitions).
1.663 raeburn 9696:
1.655 raeburn 9697: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9698: categories and subcategories).
1.663 raeburn 9699:
1.655 raeburn 9700: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 9701:
1.655 raeburn 9702: allitems (reference to hash - key is category key
9703: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9704:
1.655 raeburn 9705: idx (reference to hash of counters used in Domain Coordinator interface for
9706: editing Course Categories).
1.663 raeburn 9707:
1.655 raeburn 9708: jsarray (reference to array of categories used to create Javascript arrays for
9709: Domain Coordinator interface for editing Course Categories).
9710:
1.665 raeburn 9711: subcats (reference to hash of arrays containing all subcategories within each
9712: category, -recursive)
9713:
1.655 raeburn 9714: Returns: nothing
9715:
9716: Side effects: populates trails and allitems hash references.
9717:
9718: =cut
9719:
9720: sub extract_categories {
1.665 raeburn 9721: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 9722: if (ref($categories) eq 'HASH') {
9723: &gather_categories($categories,$cats,$idx,$jsarray);
9724: if (ref($cats->[0]) eq 'ARRAY') {
9725: for (my $i=0; $i<@{$cats->[0]}; $i++) {
9726: my $name = $cats->[0][$i];
9727: my $item = &escape($name).'::0';
9728: my $trailstr;
9729: if ($name eq 'instcode') {
9730: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 9731: } elsif ($name eq 'communities') {
9732: $trailstr = &mt('Communities');
1.655 raeburn 9733: } else {
9734: $trailstr = $name;
9735: }
9736: if ($allitems->{$item} eq '') {
9737: push(@{$trails},$trailstr);
9738: $allitems->{$item} = scalar(@{$trails})-1;
9739: }
9740: my @parents = ($name);
9741: if (ref($cats->[1]{$name}) eq 'ARRAY') {
9742: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
9743: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 9744: if (ref($subcats) eq 'HASH') {
9745: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
9746: }
9747: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
9748: }
9749: } else {
9750: if (ref($subcats) eq 'HASH') {
9751: $subcats->{$item} = [];
1.655 raeburn 9752: }
9753: }
9754: }
9755: }
9756: }
9757: return;
9758: }
9759:
9760: =pod
9761:
9762: =item *&recurse_categories()
9763:
9764: Recursively used to generate breadcrumb trails for course categories.
9765:
9766: Inputs:
1.663 raeburn 9767:
1.655 raeburn 9768: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9769: categories and subcategories).
1.663 raeburn 9770:
1.655 raeburn 9771: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 9772:
9773: category (current course category, for which breadcrumb trail is being generated).
9774:
9775: trails (reference to array of breadcrumb trails for each category).
9776:
1.655 raeburn 9777: allitems (reference to hash - key is category key
9778: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9779:
1.655 raeburn 9780: parents (array containing containers directories for current category,
9781: back to top level).
9782:
9783: Returns: nothing
9784:
9785: Side effects: populates trails and allitems hash references
9786:
9787: =cut
9788:
9789: sub recurse_categories {
1.665 raeburn 9790: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 9791: my $shallower = $depth - 1;
9792: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
9793: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
9794: my $name = $cats->[$depth]{$category}[$k];
9795: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9796: my $trailstr = join(' -> ',(@{$parents},$category));
9797: if ($allitems->{$item} eq '') {
9798: push(@{$trails},$trailstr);
9799: $allitems->{$item} = scalar(@{$trails})-1;
9800: }
9801: my $deeper = $depth+1;
9802: push(@{$parents},$category);
1.665 raeburn 9803: if (ref($subcats) eq 'HASH') {
9804: my $subcat = &escape($name).':'.$category.':'.$depth;
9805: for (my $j=@{$parents}; $j>=0; $j--) {
9806: my $higher;
9807: if ($j > 0) {
9808: $higher = &escape($parents->[$j]).':'.
9809: &escape($parents->[$j-1]).':'.$j;
9810: } else {
9811: $higher = &escape($parents->[$j]).'::'.$j;
9812: }
9813: push(@{$subcats->{$higher}},$subcat);
9814: }
9815: }
9816: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
9817: $subcats);
1.655 raeburn 9818: pop(@{$parents});
9819: }
9820: } else {
9821: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9822: my $trailstr = join(' -> ',(@{$parents},$category));
9823: if ($allitems->{$item} eq '') {
9824: push(@{$trails},$trailstr);
9825: $allitems->{$item} = scalar(@{$trails})-1;
9826: }
9827: }
9828: return;
9829: }
9830:
1.663 raeburn 9831: =pod
9832:
9833: =item *&assign_categories_table()
9834:
9835: Create a datatable for display of hierarchical categories in a domain,
9836: with checkboxes to allow a course to be categorized.
9837:
9838: Inputs:
9839:
9840: cathash - reference to hash of categories defined for the domain (from
9841: configuration.db)
9842:
9843: currcat - scalar with an & separated list of categories assigned to a course.
9844:
1.919 raeburn 9845: type - scalar contains course type (Course or Community).
9846:
1.663 raeburn 9847: Returns: $output (markup to be displayed)
9848:
9849: =cut
9850:
9851: sub assign_categories_table {
1.919 raeburn 9852: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 9853: my $output;
9854: if (ref($cathash) eq 'HASH') {
9855: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
9856: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
9857: $maxdepth = scalar(@cats);
9858: if (@cats > 0) {
9859: my $itemcount = 0;
9860: if (ref($cats[0]) eq 'ARRAY') {
9861: my @currcategories;
9862: if ($currcat ne '') {
9863: @currcategories = split('&',$currcat);
9864: }
1.919 raeburn 9865: my $table;
1.663 raeburn 9866: for (my $i=0; $i<@{$cats[0]}; $i++) {
9867: my $parent = $cats[0][$i];
1.919 raeburn 9868: next if ($parent eq 'instcode');
9869: if ($type eq 'Community') {
9870: next unless ($parent eq 'communities');
9871: } else {
9872: next if ($parent eq 'communities');
9873: }
1.663 raeburn 9874: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9875: my $item = &escape($parent).'::0';
9876: my $checked = '';
9877: if (@currcategories > 0) {
9878: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 9879: $checked = ' checked="checked"';
1.663 raeburn 9880: }
9881: }
1.919 raeburn 9882: my $parent_title = $parent;
9883: if ($parent eq 'communities') {
9884: $parent_title = &mt('Communities');
9885: }
9886: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
9887: '<input type="checkbox" name="usecategory" value="'.
9888: $item.'"'.$checked.' />'.$parent_title.'</span>'.
9889: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 9890: my $depth = 1;
9891: push(@path,$parent);
1.919 raeburn 9892: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 9893: pop(@path);
1.919 raeburn 9894: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 9895: $itemcount ++;
9896: }
1.919 raeburn 9897: if ($itemcount) {
9898: $output = &Apache::loncommon::start_data_table().
9899: $table.
9900: &Apache::loncommon::end_data_table();
9901: }
1.663 raeburn 9902: }
9903: }
9904: }
9905: return $output;
9906: }
9907:
9908: =pod
9909:
9910: =item *&assign_category_rows()
9911:
9912: Create a datatable row for display of nested categories in a domain,
9913: with checkboxes to allow a course to be categorized,called recursively.
9914:
9915: Inputs:
9916:
9917: itemcount - track row number for alternating colors
9918:
9919: cats - reference to array of arrays/hashes which encapsulates hierarchy of
9920: categories and subcategories.
9921:
9922: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
9923:
9924: parent - parent of current category item
9925:
9926: path - Array containing all categories back up through the hierarchy from the
9927: current category to the top level.
9928:
9929: currcategories - reference to array of current categories assigned to the course
9930:
9931: Returns: $output (markup to be displayed).
9932:
9933: =cut
9934:
9935: sub assign_category_rows {
9936: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
9937: my ($text,$name,$item,$chgstr);
9938: if (ref($cats) eq 'ARRAY') {
9939: my $maxdepth = scalar(@{$cats});
9940: if (ref($cats->[$depth]) eq 'HASH') {
9941: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
9942: my $numchildren = @{$cats->[$depth]{$parent}};
9943: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9944: $text .= '<td><table class="LC_datatable">';
9945: for (my $j=0; $j<$numchildren; $j++) {
9946: $name = $cats->[$depth]{$parent}[$j];
9947: $item = &escape($name).':'.&escape($parent).':'.$depth;
9948: my $deeper = $depth+1;
9949: my $checked = '';
9950: if (ref($currcategories) eq 'ARRAY') {
9951: if (@{$currcategories} > 0) {
9952: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 9953: $checked = ' checked="checked"';
1.663 raeburn 9954: }
9955: }
9956: }
1.664 raeburn 9957: $text .= '<tr><td><span class="LC_nobreak"><label>'.
9958: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 9959: $item.'"'.$checked.' />'.$name.'</label></span>'.
9960: '<input type="hidden" name="catname" value="'.$name.'" />'.
9961: '</td><td>';
1.663 raeburn 9962: if (ref($path) eq 'ARRAY') {
9963: push(@{$path},$name);
9964: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
9965: pop(@{$path});
9966: }
9967: $text .= '</td></tr>';
9968: }
9969: $text .= '</table></td>';
9970: }
9971: }
9972: }
9973: return $text;
9974: }
9975:
1.655 raeburn 9976: ############################################################
9977: ############################################################
9978:
9979:
1.443 albertel 9980: sub commit_customrole {
1.664 raeburn 9981: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 9982: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 9983: ($start?', '.&mt('starting').' '.localtime($start):'').
9984: ($end?', ending '.localtime($end):'').': <b>'.
9985: &Apache::lonnet::assigncustomrole(
1.664 raeburn 9986: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 9987: '</b><br />';
9988: return $output;
9989: }
9990:
9991: sub commit_standardrole {
1.541 raeburn 9992: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
9993: my ($output,$logmsg,$linefeed);
9994: if ($context eq 'auto') {
9995: $linefeed = "\n";
9996: } else {
9997: $linefeed = "<br />\n";
9998: }
1.443 albertel 9999: if ($three eq 'st') {
1.541 raeburn 10000: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
10001: $one,$two,$sec,$context);
10002: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 10003: ($result eq 'unknown_course') || ($result eq 'refused')) {
10004: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 10005: } else {
1.541 raeburn 10006: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 10007: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 10008: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
10009: if ($context eq 'auto') {
10010: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
10011: } else {
10012: $output .= '<b>'.$result.'</b>'.$linefeed.
10013: &mt('Add to classlist').': <b>ok</b>';
10014: }
10015: $output .= $linefeed;
1.443 albertel 10016: }
10017: } else {
10018: $output = &mt('Assigning').' '.$three.' in '.$url.
10019: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 10020: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 10021: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 10022: if ($context eq 'auto') {
10023: $output .= $result.$linefeed;
10024: } else {
10025: $output .= '<b>'.$result.'</b>'.$linefeed;
10026: }
1.443 albertel 10027: }
10028: return $output;
10029: }
10030:
10031: sub commit_studentrole {
1.541 raeburn 10032: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 10033: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 10034: if ($context eq 'auto') {
10035: $linefeed = "\n";
10036: } else {
10037: $linefeed = '<br />'."\n";
10038: }
1.443 albertel 10039: if (defined($one) && defined($two)) {
10040: my $cid=$one.'_'.$two;
10041: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
10042: my $secchange = 0;
10043: my $expire_role_result;
10044: my $modify_section_result;
1.628 raeburn 10045: if ($oldsec ne '-1') {
10046: if ($oldsec ne $sec) {
1.443 albertel 10047: $secchange = 1;
1.628 raeburn 10048: my $now = time;
1.443 albertel 10049: my $uurl='/'.$cid;
10050: $uurl=~s/\_/\//g;
10051: if ($oldsec) {
10052: $uurl.='/'.$oldsec;
10053: }
1.626 raeburn 10054: $oldsecurl = $uurl;
1.628 raeburn 10055: $expire_role_result =
1.652 raeburn 10056: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 10057: if ($env{'request.course.sec'} ne '') {
10058: if ($expire_role_result eq 'refused') {
10059: my @roles = ('st');
10060: my @statuses = ('previous');
10061: my @roledoms = ($one);
10062: my $withsec = 1;
10063: my %roleshash =
10064: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
10065: \@statuses,\@roles,\@roledoms,$withsec);
10066: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
10067: my ($oldstart,$oldend) =
10068: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
10069: if ($oldend > 0 && $oldend <= $now) {
10070: $expire_role_result = 'ok';
10071: }
10072: }
10073: }
10074: }
1.443 albertel 10075: $result = $expire_role_result;
10076: }
10077: }
10078: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 10079: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 10080: if ($modify_section_result =~ /^ok/) {
10081: if ($secchange == 1) {
1.628 raeburn 10082: if ($sec eq '') {
10083: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
10084: } else {
10085: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
10086: }
1.443 albertel 10087: } elsif ($oldsec eq '-1') {
1.628 raeburn 10088: if ($sec eq '') {
10089: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
10090: } else {
10091: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
10092: }
1.443 albertel 10093: } else {
1.628 raeburn 10094: if ($sec eq '') {
10095: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
10096: } else {
10097: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
10098: }
1.443 albertel 10099: }
10100: } else {
1.628 raeburn 10101: if ($secchange) {
10102: $$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;
10103: } else {
10104: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
10105: }
1.443 albertel 10106: }
10107: $result = $modify_section_result;
10108: } elsif ($secchange == 1) {
1.628 raeburn 10109: if ($oldsec eq '') {
10110: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
10111: } else {
10112: $$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;
10113: }
1.626 raeburn 10114: if ($expire_role_result eq 'refused') {
10115: my $newsecurl = '/'.$cid;
10116: $newsecurl =~ s/\_/\//g;
10117: if ($sec ne '') {
10118: $newsecurl.='/'.$sec;
10119: }
10120: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
10121: if ($sec eq '') {
10122: $$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;
10123: } else {
10124: $$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;
10125: }
10126: }
10127: }
1.443 albertel 10128: }
10129: } else {
1.626 raeburn 10130: $$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 10131: $result = "error: incomplete course id\n";
10132: }
10133: return $result;
10134: }
10135:
10136: ############################################################
10137: ############################################################
10138:
1.566 albertel 10139: sub check_clone {
1.578 raeburn 10140: my ($args,$linefeed) = @_;
1.566 albertel 10141: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
10142: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
10143: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
10144: my $clonemsg;
10145: my $can_clone = 0;
1.944 raeburn 10146: my $lctype = lc($args->{'crstype'});
1.908 raeburn 10147: if ($lctype ne 'community') {
10148: $lctype = 'course';
10149: }
1.566 albertel 10150: if ($clonehome eq 'no_host') {
1.944 raeburn 10151: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10152: $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'});
10153: } else {
10154: $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'});
10155: }
1.566 albertel 10156: } else {
10157: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944 raeburn 10158: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10159: if ($clonedesc{'type'} ne 'Community') {
10160: $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'});
10161: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10162: }
10163: }
1.882 raeburn 10164: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
10165: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 10166: $can_clone = 1;
10167: } else {
10168: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
10169: $args->{'clonedomain'},$args->{'clonecourse'});
10170: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 10171: if (grep(/^\*$/,@cloners)) {
10172: $can_clone = 1;
10173: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
10174: $can_clone = 1;
10175: } else {
1.908 raeburn 10176: my $ccrole = 'cc';
1.944 raeburn 10177: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10178: $ccrole = 'co';
10179: }
1.578 raeburn 10180: my %roleshash =
10181: &Apache::lonnet::get_my_roles($args->{'ccuname'},
10182: $args->{'ccdomain'},
1.908 raeburn 10183: 'userroles',['active'],[$ccrole],
1.578 raeburn 10184: [$args->{'clonedomain'}]);
1.908 raeburn 10185: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942 raeburn 10186: $can_clone = 1;
10187: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
10188: $can_clone = 1;
10189: } else {
1.944 raeburn 10190: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10191: $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'});
10192: } else {
10193: $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'});
10194: }
1.578 raeburn 10195: }
1.566 albertel 10196: }
1.578 raeburn 10197: }
1.566 albertel 10198: }
10199: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10200: }
10201:
1.444 albertel 10202: sub construct_course {
1.885 raeburn 10203: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444 albertel 10204: my $outcome;
1.541 raeburn 10205: my $linefeed = '<br />'."\n";
10206: if ($context eq 'auto') {
10207: $linefeed = "\n";
10208: }
1.566 albertel 10209:
10210: #
10211: # Are we cloning?
10212: #
10213: my ($can_clone, $clonemsg, $cloneid, $clonehome);
10214: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 10215: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 10216: if ($context ne 'auto') {
1.578 raeburn 10217: if ($clonemsg ne '') {
10218: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
10219: }
1.566 albertel 10220: }
10221: $outcome .= $clonemsg.$linefeed;
10222:
10223: if (!$can_clone) {
10224: return (0,$outcome);
10225: }
10226: }
10227:
1.444 albertel 10228: #
10229: # Open course
10230: #
10231: my $crstype = lc($args->{'crstype'});
10232: my %cenv=();
10233: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
10234: $args->{'cdescr'},
10235: $args->{'curl'},
10236: $args->{'course_home'},
10237: $args->{'nonstandard'},
10238: $args->{'crscode'},
10239: $args->{'ccuname'}.':'.
10240: $args->{'ccdomain'},
1.882 raeburn 10241: $args->{'crstype'},
1.885 raeburn 10242: $cnum,$context,$category);
1.444 albertel 10243:
10244: # Note: The testing routines depend on this being output; see
10245: # Utils::Course. This needs to at least be output as a comment
10246: # if anyone ever decides to not show this, and Utils::Course::new
10247: # will need to be suitably modified.
1.541 raeburn 10248: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943 raeburn 10249: if ($$courseid =~ /^error:/) {
10250: return (0,$outcome);
10251: }
10252:
1.444 albertel 10253: #
10254: # Check if created correctly
10255: #
1.479 albertel 10256: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 10257: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 10258: if ($crsuhome eq 'no_host') {
10259: $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
10260: return (0,$outcome);
10261: }
1.541 raeburn 10262: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 10263:
1.444 albertel 10264: #
1.566 albertel 10265: # Do the cloning
10266: #
10267: if ($can_clone && $cloneid) {
10268: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
10269: if ($context ne 'auto') {
10270: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
10271: }
10272: $outcome .= $clonemsg.$linefeed;
10273: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 10274: # Copy all files
1.637 www 10275: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 10276: # Restore URL
1.566 albertel 10277: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 10278: # Restore title
1.566 albertel 10279: $cenv{'description'}=$oldcenv{'description'};
1.444 albertel 10280: # Mark as cloned
1.566 albertel 10281: $cenv{'clonedfrom'}=$cloneid;
1.638 www 10282: # Need to clone grading mode
10283: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
10284: $cenv{'grading'}=$newenv{'grading'};
10285: # Do not clone these environment entries
10286: &Apache::lonnet::del('environment',
10287: ['default_enrollment_start_date',
10288: 'default_enrollment_end_date',
10289: 'question.email',
10290: 'policy.email',
10291: 'comment.email',
10292: 'pch.users.denied',
1.725 raeburn 10293: 'plc.users.denied',
10294: 'hidefromcat',
10295: 'categories'],
1.638 www 10296: $$crsudom,$$crsunum);
1.444 albertel 10297: }
1.566 albertel 10298:
1.444 albertel 10299: #
10300: # Set environment (will override cloned, if existing)
10301: #
10302: my @sections = ();
10303: my @xlists = ();
10304: if ($args->{'crstype'}) {
10305: $cenv{'type'}=$args->{'crstype'};
10306: }
10307: if ($args->{'crsid'}) {
10308: $cenv{'courseid'}=$args->{'crsid'};
10309: }
10310: if ($args->{'crscode'}) {
10311: $cenv{'internal.coursecode'}=$args->{'crscode'};
10312: }
10313: if ($args->{'crsquota'} ne '') {
10314: $cenv{'internal.coursequota'}=$args->{'crsquota'};
10315: } else {
10316: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
10317: }
10318: if ($args->{'ccuname'}) {
10319: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
10320: ':'.$args->{'ccdomain'};
10321: } else {
10322: $cenv{'internal.courseowner'} = $args->{'curruser'};
10323: }
10324: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
10325: if ($args->{'crssections'}) {
10326: $cenv{'internal.sectionnums'} = '';
10327: if ($args->{'crssections'} =~ m/,/) {
10328: @sections = split/,/,$args->{'crssections'};
10329: } else {
10330: $sections[0] = $args->{'crssections'};
10331: }
10332: if (@sections > 0) {
10333: foreach my $item (@sections) {
10334: my ($sec,$gp) = split/:/,$item;
10335: my $class = $args->{'crscode'}.$sec;
10336: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
10337: $cenv{'internal.sectionnums'} .= $item.',';
10338: unless ($addcheck eq 'ok') {
10339: push @badclasses, $class;
10340: }
10341: }
10342: $cenv{'internal.sectionnums'} =~ s/,$//;
10343: }
10344: }
10345: # do not hide course coordinator from staff listing,
10346: # even if privileged
10347: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10348: # add crosslistings
10349: if ($args->{'crsxlist'}) {
10350: $cenv{'internal.crosslistings'}='';
10351: if ($args->{'crsxlist'} =~ m/,/) {
10352: @xlists = split/,/,$args->{'crsxlist'};
10353: } else {
10354: $xlists[0] = $args->{'crsxlist'};
10355: }
10356: if (@xlists > 0) {
10357: foreach my $item (@xlists) {
10358: my ($xl,$gp) = split/:/,$item;
10359: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
10360: $cenv{'internal.crosslistings'} .= $item.',';
10361: unless ($addcheck eq 'ok') {
10362: push @badclasses, $xl;
10363: }
10364: }
10365: $cenv{'internal.crosslistings'} =~ s/,$//;
10366: }
10367: }
10368: if ($args->{'autoadds'}) {
10369: $cenv{'internal.autoadds'}=$args->{'autoadds'};
10370: }
10371: if ($args->{'autodrops'}) {
10372: $cenv{'internal.autodrops'}=$args->{'autodrops'};
10373: }
10374: # check for notification of enrollment changes
10375: my @notified = ();
10376: if ($args->{'notify_owner'}) {
10377: if ($args->{'ccuname'} ne '') {
10378: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
10379: }
10380: }
10381: if ($args->{'notify_dc'}) {
10382: if ($uname ne '') {
1.630 raeburn 10383: push(@notified,$uname.':'.$udom);
1.444 albertel 10384: }
10385: }
10386: if (@notified > 0) {
10387: my $notifylist;
10388: if (@notified > 1) {
10389: $notifylist = join(',',@notified);
10390: } else {
10391: $notifylist = $notified[0];
10392: }
10393: $cenv{'internal.notifylist'} = $notifylist;
10394: }
10395: if (@badclasses > 0) {
10396: my %lt=&Apache::lonlocal::texthash(
10397: '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',
10398: 'dnhr' => 'does not have rights to access enrollment in these classes',
10399: 'adby' => 'as determined by the policies of your institution on access to official classlists'
10400: );
1.541 raeburn 10401: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
10402: ' ('.$lt{'adby'}.')';
10403: if ($context eq 'auto') {
10404: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 10405: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 10406: foreach my $item (@badclasses) {
10407: if ($context eq 'auto') {
10408: $outcome .= " - $item\n";
10409: } else {
10410: $outcome .= "<li>$item</li>\n";
10411: }
10412: }
10413: if ($context eq 'auto') {
10414: $outcome .= $linefeed;
10415: } else {
1.566 albertel 10416: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 10417: }
10418: }
1.444 albertel 10419: }
10420: if ($args->{'no_end_date'}) {
10421: $args->{'endaccess'} = 0;
10422: }
10423: $cenv{'internal.autostart'}=$args->{'enrollstart'};
10424: $cenv{'internal.autoend'}=$args->{'enrollend'};
10425: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
10426: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
10427: if ($args->{'showphotos'}) {
10428: $cenv{'internal.showphotos'}=$args->{'showphotos'};
10429: }
10430: $cenv{'internal.authtype'} = $args->{'authtype'};
10431: $cenv{'internal.autharg'} = $args->{'autharg'};
10432: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
10433: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 10434: 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');
10435: if ($context eq 'auto') {
10436: $outcome .= $krb_msg;
10437: } else {
1.566 albertel 10438: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 10439: }
10440: $outcome .= $linefeed;
1.444 albertel 10441: }
10442: }
10443: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
10444: if ($args->{'setpolicy'}) {
10445: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10446: }
10447: if ($args->{'setcontent'}) {
10448: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10449: }
10450: }
10451: if ($args->{'reshome'}) {
10452: $cenv{'reshome'}=$args->{'reshome'}.'/';
10453: $cenv{'reshome'}=~s/\/+$/\//;
10454: }
10455: #
10456: # course has keyed access
10457: #
10458: if ($args->{'setkeys'}) {
10459: $cenv{'keyaccess'}='yes';
10460: }
10461: # if specified, key authority is not course, but user
10462: # only active if keyaccess is yes
10463: if ($args->{'keyauth'}) {
1.487 albertel 10464: my ($user,$domain) = split(':',$args->{'keyauth'});
10465: $user = &LONCAPA::clean_username($user);
10466: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 10467: if ($user ne '' && $domain ne '') {
1.487 albertel 10468: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 10469: }
10470: }
10471:
10472: if ($args->{'disresdis'}) {
10473: $cenv{'pch.roles.denied'}='st';
10474: }
10475: if ($args->{'disablechat'}) {
10476: $cenv{'plc.roles.denied'}='st';
10477: }
10478:
10479: # Record we've not yet viewed the Course Initialization Helper for this
10480: # course
10481: $cenv{'course.helper.not.run'} = 1;
10482: #
10483: # Use new Randomseed
10484: #
10485: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
10486: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
10487: #
10488: # The encryption code and receipt prefix for this course
10489: #
10490: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
10491: $cenv{'internal.encpref'}=100+int(9*rand(99));
10492: #
10493: # By default, use standard grading
10494: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
10495:
1.541 raeburn 10496: $outcome .= $linefeed.&mt('Setting environment').': '.
10497: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10498: #
10499: # Open all assignments
10500: #
10501: if ($args->{'openall'}) {
10502: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
10503: my %storecontent = ($storeunder => time,
10504: $storeunder.'.type' => 'date_start');
10505:
10506: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 10507: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10508: }
10509: #
10510: # Set first page
10511: #
10512: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
10513: || ($cloneid)) {
1.445 albertel 10514: use LONCAPA::map;
1.444 albertel 10515: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 10516:
10517: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
10518: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
10519:
1.444 albertel 10520: $outcome .= ($fatal?$errtext:'read ok').' - ';
10521: my $title; my $url;
10522: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 10523: $title=&mt('Syllabus');
1.444 albertel 10524: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
10525: } else {
1.690 bisitz 10526: $title=&mt('Navigate Contents');
1.444 albertel 10527: $url='/adm/navmaps';
10528: }
1.445 albertel 10529:
10530: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
10531: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
10532:
10533: if ($errtext) { $fatal=2; }
1.541 raeburn 10534: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 10535: }
1.566 albertel 10536:
10537: return (1,$outcome);
1.444 albertel 10538: }
10539:
10540: ############################################################
10541: ############################################################
10542:
1.378 raeburn 10543: sub course_type {
10544: my ($cid) = @_;
10545: if (!defined($cid)) {
10546: $cid = $env{'request.course.id'};
10547: }
1.404 albertel 10548: if (defined($env{'course.'.$cid.'.type'})) {
10549: return $env{'course.'.$cid.'.type'};
1.378 raeburn 10550: } else {
10551: return 'Course';
1.377 raeburn 10552: }
10553: }
1.156 albertel 10554:
1.406 raeburn 10555: sub group_term {
10556: my $crstype = &course_type();
10557: my %names = (
10558: 'Course' => 'group',
1.865 raeburn 10559: 'Community' => 'group',
1.406 raeburn 10560: );
10561: return $names{$crstype};
10562: }
10563:
1.902 raeburn 10564: sub course_types {
10565: my @types = ('official','unofficial','community');
10566: my %typename = (
10567: official => 'Official course',
10568: unofficial => 'Unofficial course',
10569: community => 'Community',
10570: );
10571: return (\@types,\%typename);
10572: }
10573:
1.156 albertel 10574: sub icon {
10575: my ($file)=@_;
1.505 albertel 10576: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 10577: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 10578: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 10579: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
10580: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
10581: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10582: $curfext.".gif") {
10583: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10584: $curfext.".gif";
10585: }
10586: }
1.249 albertel 10587: return &lonhttpdurl($iconname);
1.154 albertel 10588: }
1.84 albertel 10589:
1.575 albertel 10590: sub lonhttpdurl {
1.692 www 10591: #
10592: # Had been used for "small fry" static images on separate port 8080.
10593: # Modify here if lightweight http functionality desired again.
10594: # Currently eliminated due to increasing firewall issues.
10595: #
1.575 albertel 10596: my ($url)=@_;
1.692 www 10597: return $url;
1.215 albertel 10598: }
10599:
1.213 albertel 10600: sub connection_aborted {
10601: my ($r)=@_;
10602: $r->print(" ");$r->rflush();
10603: my $c = $r->connection;
10604: return $c->aborted();
10605: }
10606:
1.221 foxr 10607: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 10608: # strings as 'strings'.
10609: sub escape_single {
1.221 foxr 10610: my ($input) = @_;
1.223 albertel 10611: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 10612: $input =~ s/\'/\\\'/g; # Esacpe the 's....
10613: return $input;
10614: }
1.223 albertel 10615:
1.222 foxr 10616: # Same as escape_single, but escape's "'s This
10617: # can be used for "strings"
10618: sub escape_double {
10619: my ($input) = @_;
10620: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
10621: $input =~ s/\"/\\\"/g; # Esacpe the "s....
10622: return $input;
10623: }
1.223 albertel 10624:
1.222 foxr 10625: # Escapes the last element of a full URL.
10626: sub escape_url {
10627: my ($url) = @_;
1.238 raeburn 10628: my @urlslices = split(/\//, $url,-1);
1.369 www 10629: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 10630: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 10631: }
1.462 albertel 10632:
1.820 raeburn 10633: sub compare_arrays {
10634: my ($arrayref1,$arrayref2) = @_;
10635: my (@difference,%count);
10636: @difference = ();
10637: %count = ();
10638: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
10639: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
10640: foreach my $element (keys(%count)) {
10641: if ($count{$element} == 1) {
10642: push(@difference,$element);
10643: }
10644: }
10645: }
10646: return @difference;
10647: }
10648:
1.817 bisitz 10649: # -------------------------------------------------------- Initialize user login
1.462 albertel 10650: sub init_user_environment {
1.463 albertel 10651: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 10652: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
10653:
10654: my $public=($username eq 'public' && $domain eq 'public');
10655:
10656: # See if old ID present, if so, remove
10657:
10658: my ($filename,$cookie,$userroles);
10659: my $now=time;
10660:
10661: if ($public) {
10662: my $max_public=100;
10663: my $oldest;
10664: my $oldest_time=0;
10665: for(my $next=1;$next<=$max_public;$next++) {
10666: if (-e $lonids."/publicuser_$next.id") {
10667: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
10668: if ($mtime<$oldest_time || !$oldest_time) {
10669: $oldest_time=$mtime;
10670: $oldest=$next;
10671: }
10672: } else {
10673: $cookie="publicuser_$next";
10674: last;
10675: }
10676: }
10677: if (!$cookie) { $cookie="publicuser_$oldest"; }
10678: } else {
1.463 albertel 10679: # if this isn't a robot, kill any existing non-robot sessions
10680: if (!$args->{'robot'}) {
10681: opendir(DIR,$lonids);
10682: while ($filename=readdir(DIR)) {
10683: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
10684: unlink($lonids.'/'.$filename);
10685: }
1.462 albertel 10686: }
1.463 albertel 10687: closedir(DIR);
1.462 albertel 10688: }
10689: # Give them a new cookie
1.463 albertel 10690: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 10691: : $now.$$.int(rand(10000)));
1.463 albertel 10692: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 10693:
10694: # Initialize roles
10695:
10696: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
10697: }
10698: # ------------------------------------ Check browser type and MathML capability
10699:
10700: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
10701: $clientunicode,$clientos) = &decode_user_agent($r);
10702:
10703: # ------------------------------------------------------------- Get environment
10704:
10705: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
10706: my ($tmp) = keys(%userenv);
10707: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
10708: # default remote control to off
10709: if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
10710: } else {
10711: undef(%userenv);
10712: }
10713: if (($userenv{'interface'}) && (!$form->{'interface'})) {
10714: $form->{'interface'}=$userenv{'interface'};
10715: }
10716: $env{'environment.remote'}=$userenv{'remote'};
10717: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
10718:
10719: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 10720: foreach my $option ('interface','localpath','localres') {
10721: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 10722: }
10723: # --------------------------------------------------------- Write first profile
10724:
10725: {
10726: my %initial_env =
10727: ("user.name" => $username,
10728: "user.domain" => $domain,
10729: "user.home" => $authhost,
10730: "browser.type" => $clientbrowser,
10731: "browser.version" => $clientversion,
10732: "browser.mathml" => $clientmathml,
10733: "browser.unicode" => $clientunicode,
10734: "browser.os" => $clientos,
10735: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
10736: "request.course.fn" => '',
10737: "request.course.uri" => '',
10738: "request.course.sec" => '',
10739: "request.role" => 'cm',
10740: "request.role.adv" => $env{'user.adv'},
10741: "request.host" => $ENV{'REMOTE_ADDR'},);
10742:
10743: if ($form->{'localpath'}) {
10744: $initial_env{"browser.localpath"} = $form->{'localpath'};
10745: $initial_env{"browser.localres"} = $form->{'localres'};
10746: }
10747:
10748: if ($public) {
10749: $initial_env{"environment.remote"} = "off";
10750: }
10751: if ($form->{'interface'}) {
10752: $form->{'interface'}=~s/\W//gs;
10753: $initial_env{"browser.interface"} = $form->{'interface'};
10754: $env{'browser.interface'}=$form->{'interface'};
10755: }
10756:
1.724 raeburn 10757: foreach my $tool ('aboutme','blog','portfolio') {
10758: $userenv{'availabletools.'.$tool} =
10759: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
10760: }
10761:
1.864 raeburn 10762: foreach my $crstype ('official','unofficial','community') {
1.765 raeburn 10763: $userenv{'canrequest.'.$crstype} =
10764: &Apache::lonnet::usertools_access($username,$domain,$crstype,
10765: 'reload','requestcourses');
10766: }
10767:
1.462 albertel 10768: $env{'user.environment'} = "$lonids/$cookie.id";
10769:
10770: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
10771: &GDBM_WRCREAT(),0640)) {
10772: &_add_to_env(\%disk_env,\%initial_env);
10773: &_add_to_env(\%disk_env,\%userenv,'environment.');
10774: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 10775: if (ref($args->{'extra_env'})) {
10776: &_add_to_env(\%disk_env,$args->{'extra_env'});
10777: }
1.462 albertel 10778: untie(%disk_env);
10779: } else {
1.705 tempelho 10780: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
10781: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 10782: return 'error: '.$!;
10783: }
10784: }
10785: $env{'request.role'}='cm';
10786: $env{'request.role.adv'}=$env{'user.adv'};
10787: $env{'browser.type'}=$clientbrowser;
10788:
10789: return $cookie;
10790:
10791: }
10792:
10793: sub _add_to_env {
10794: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 10795: if (ref($env_data) eq 'HASH') {
10796: while (my ($key,$value) = each(%$env_data)) {
10797: $idf->{$prefix.$key} = $value;
10798: $env{$prefix.$key} = $value;
10799: }
1.462 albertel 10800: }
10801: }
10802:
1.685 tempelho 10803: # --- Get the symbolic name of a problem and the url
10804: sub get_symb {
10805: my ($request,$silent) = @_;
1.726 raeburn 10806: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 10807: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
10808: if ($symb eq '') {
10809: if (!$silent) {
10810: $request->print("Unable to handle ambiguous references:$url:.");
10811: return ();
10812: }
10813: }
10814: &Apache::lonenc::check_decrypt(\$symb);
10815: return ($symb);
10816: }
10817:
10818: # --------------------------------------------------------------Get annotation
10819:
10820: sub get_annotation {
10821: my ($symb,$enc) = @_;
10822:
10823: my $key = $symb;
10824: if (!$enc) {
10825: $key =
10826: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
10827: }
10828: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
10829: return $annotation{$key};
10830: }
10831:
10832: sub clean_symb {
1.731 raeburn 10833: my ($symb,$delete_enc) = @_;
1.685 tempelho 10834:
10835: &Apache::lonenc::check_decrypt(\$symb);
10836: my $enc = $env{'request.enc'};
1.731 raeburn 10837: if ($delete_enc) {
1.730 raeburn 10838: delete($env{'request.enc'});
10839: }
1.685 tempelho 10840:
10841: return ($symb,$enc);
10842: }
1.462 albertel 10843:
1.41 ng 10844: =pod
10845:
10846: =back
10847:
1.112 bowersj2 10848: =cut
1.41 ng 10849:
1.112 bowersj2 10850: 1;
10851: __END__;
1.41 ng 10852:
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