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