Annotation of loncom/interface/loncommon.pm, revision 1.948.2.25
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.948.2.25! raeburn 4: # $Id: loncommon.pm,v 1.948.2.24 2011/01/12 04:58:54 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: }
1.948.2.7 raeburn 903: return &select_form($selected,$name,\%langchoices);
1.792 raeburn 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.948.2.7 raeburn 1075: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid)
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.948.2.7 raeburn 1098: my ($topic, $text, $stayOnPage, $width, $height, $imgid) = @_;
1.48 bowersj2 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.948.2.7 raeburn 1127: if ($imgid ne '') {
1128: $imgid = ' id="'.$imgid.'"';
1129: }
1.763 bisitz 1130: $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
1131: .'<img src="'.$helpicon.'" border="0"'
1132: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.948.2.7 raeburn 1133: .' title="'.$title.'" style="vertical-align:middle;"'.$imgid
1.763 bisitz 1134: .' /></a>';
1.948.2.7 raeburn 1135: if ($text ne "") {
1.763 bisitz 1136: $template.='</span>';
1137: }
1.44 bowersj2 1138: return $template;
1139:
1.106 bowersj2 1140: }
1141:
1142: # This is a quicky function for Latex cheatsheet editing, since it
1143: # appears in at least four places
1144: sub helpLatexCheatsheet {
1.732 raeburn 1145: my ($topic,$text,$not_author) = @_;
1146: my $out;
1.106 bowersj2 1147: my $addOther = '';
1.732 raeburn 1148: if ($topic) {
1.763 bisitz 1149: $addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
1150: undef, undef, 600).
1151: '</span> ';
1152: }
1153: $out = '<span>' # Start cheatsheet
1154: .$addOther
1155: .'<span>'
1156: .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
1157: undef,undef,600)
1158: .'</span> <span>'
1159: .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
1160: undef,undef,600)
1161: .'</span>';
1.732 raeburn 1162: unless ($not_author) {
1.763 bisitz 1163: $out .= ' <span>'
1164: .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
1165: undef,undef,600)
1166: .'</span>';
1.732 raeburn 1167: }
1.763 bisitz 1168: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1169: return $out;
1.172 www 1170: }
1171:
1.430 albertel 1172: sub general_help {
1173: my $helptopic='Student_Intro';
1174: if ($env{'request.role'}=~/^(ca|au)/) {
1175: $helptopic='Authoring_Intro';
1.907 raeburn 1176: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1177: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1178: } elsif ($env{'request.role'}=~/^dc/) {
1179: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1180: }
1181: return $helptopic;
1182: }
1183:
1184: sub update_help_link {
1185: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1186: my $origurl = $ENV{'REQUEST_URI'};
1187: $origurl=~s|^/~|/priv/|;
1188: my $timestamp = time;
1189: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1190: $$datum = &escape($$datum);
1191: }
1192:
1193: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1194: my $output .= <<"ENDOUTPUT";
1195: <script type="text/javascript">
1.824 bisitz 1196: // <![CDATA[
1.430 albertel 1197: banner_link = '$banner_link';
1.824 bisitz 1198: // ]]>
1.430 albertel 1199: </script>
1200: ENDOUTPUT
1201: return $output;
1202: }
1203:
1204: # now just updates the help link and generates a blue icon
1.193 raeburn 1205: sub help_open_menu {
1.430 albertel 1206: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1207: = @_;
1.430 albertel 1208: $stayOnPage = 0 if (not defined $stayOnPage);
1.572 banghart 1209: # only use pop-up help (stayOnPage == 0)
1.552 banghart 1210: # if environment.remote is on (using remote control UI)
1.798 tempelho 1211: if ($env{'environment.remote'} eq 'off' ) {
1.552 banghart 1212: $stayOnPage=1;
1.430 albertel 1213: }
1214: my $output;
1215: if ($component_help) {
1216: if (!$text) {
1217: $output=&help_open_topic($component_help,undef,$stayOnPage,
1218: $width,$height);
1219: } else {
1220: my $help_text;
1221: $help_text=&unescape($topic);
1222: $output='<table><tr><td>'.
1223: &help_open_topic($component_help,$help_text,$stayOnPage,
1224: $width,$height).'</td></tr></table>';
1225: }
1226: }
1227: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1228: return $output.$banner_link;
1229: }
1230:
1231: sub top_nav_help {
1232: my ($text) = @_;
1.436 albertel 1233: $text = &mt($text);
1.572 banghart 1234: my $stay_on_page =
1.798 tempelho 1235: ($env{'environment.remote'} eq 'off' );
1.572 banghart 1236: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1237: : "javascript:helpMenu('open')";
1.572 banghart 1238: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1239:
1.201 raeburn 1240: my $title = &mt('Get help');
1.436 albertel 1241:
1242: return <<"END";
1243: $banner_link
1244: <a href="$link" title="$title">$text</a>
1245: END
1246: }
1247:
1248: sub help_menu_js {
1249: my ($text) = @_;
1250:
1251: my $stayOnPage =
1.798 tempelho 1252: ($env{'environment.remote'} eq 'off' );
1.436 albertel 1253:
1254: my $width = 620;
1255: my $height = 600;
1.430 albertel 1256: my $helptopic=&general_help();
1257: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1258: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1259: my $start_page =
1260: &Apache::loncommon::start_page('Help Menu', undef,
1261: {'frameset' => 1,
1262: 'js_ready' => 1,
1263: 'add_entries' => {
1264: 'border' => '0',
1.579 raeburn 1265: 'rows' => "110,*",},});
1.331 albertel 1266: my $end_page =
1267: &Apache::loncommon::end_page({'frameset' => 1,
1268: 'js_ready' => 1,});
1269:
1.436 albertel 1270: my $template .= <<"ENDTEMPLATE";
1271: <script type="text/javascript">
1.877 bisitz 1272: // <![CDATA[
1.253 albertel 1273: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1274: var banner_link = '';
1.243 raeburn 1275: function helpMenu(target) {
1276: var caller = this;
1277: if (target == 'open') {
1278: var newWindow = null;
1279: try {
1.262 albertel 1280: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1281: }
1282: catch(error) {
1283: writeHelp(caller);
1284: return;
1285: }
1286: if (newWindow) {
1287: caller = newWindow;
1288: }
1.193 raeburn 1289: }
1.243 raeburn 1290: writeHelp(caller);
1291: return;
1292: }
1293: function writeHelp(caller) {
1.430 albertel 1294: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243 raeburn 1295: caller.document.close()
1296: caller.focus()
1.193 raeburn 1297: }
1.877 bisitz 1298: // END LON-CAPA Internal -->
1.253 albertel 1299: // ]]>
1.436 albertel 1300: </script>
1.193 raeburn 1301: ENDTEMPLATE
1302: return $template;
1303: }
1304:
1.172 www 1305: sub help_open_bug {
1306: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1307: unless ($env{'user.adv'}) { return ''; }
1.172 www 1308: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1309: $text = "" if (not defined $text);
1310: $stayOnPage = 0 if (not defined $stayOnPage);
1.798 tempelho 1311: if ($env{'environment.remote'} eq 'off' ) {
1.172 www 1312: $stayOnPage=1;
1313: }
1.184 albertel 1314: $width = 600 if (not defined $width);
1315: $height = 600 if (not defined $height);
1.172 www 1316:
1317: $topic=~s/\W+/\+/g;
1318: my $link='';
1319: my $template='';
1.379 albertel 1320: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1321: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1322: if (!$stayOnPage)
1323: {
1324: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1325: }
1326: else
1327: {
1328: $link = $url;
1329: }
1330: # Add the text
1331: if ($text ne "")
1332: {
1333: $template .=
1334: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1335: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1336: }
1337:
1338: # Add the graphic
1.179 matthew 1339: my $title = &mt('Report a Bug');
1.215 albertel 1340: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1341: $template .= <<"ENDTEMPLATE";
1.436 albertel 1342: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1343: ENDTEMPLATE
1344: if ($text ne '') { $template.='</td></tr></table>' };
1345: return $template;
1346:
1347: }
1348:
1349: sub help_open_faq {
1350: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1351: unless ($env{'user.adv'}) { return ''; }
1.172 www 1352: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1353: $text = "" if (not defined $text);
1354: $stayOnPage = 0 if (not defined $stayOnPage);
1.798 tempelho 1355: if ($env{'environment.remote'} eq 'off' ) {
1.172 www 1356: $stayOnPage=1;
1357: }
1358: $width = 350 if (not defined $width);
1359: $height = 400 if (not defined $height);
1360:
1361: $topic=~s/\W+/\+/g;
1362: my $link='';
1363: my $template='';
1364: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1365: if (!$stayOnPage)
1366: {
1367: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1368: }
1369: else
1370: {
1371: $link = $url;
1372: }
1373:
1374: # Add the text
1375: if ($text ne "")
1376: {
1377: $template .=
1.173 www 1378: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1379: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1380: }
1381:
1382: # Add the graphic
1.179 matthew 1383: my $title = &mt('View the FAQ');
1.215 albertel 1384: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1385: $template .= <<"ENDTEMPLATE";
1.436 albertel 1386: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1387: ENDTEMPLATE
1388: if ($text ne '') { $template.='</td></tr></table>' };
1389: return $template;
1390:
1.44 bowersj2 1391: }
1.37 matthew 1392:
1.180 matthew 1393: ###############################################################
1394: ###############################################################
1395:
1.45 matthew 1396: =pod
1397:
1.648 raeburn 1398: =item * &change_content_javascript():
1.256 matthew 1399:
1400: This and the next function allow you to create small sections of an
1401: otherwise static HTML page that you can update on the fly with
1402: Javascript, even in Netscape 4.
1403:
1404: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1405: must be written to the HTML page once. It will prove the Javascript
1406: function "change(name, content)". Calling the change function with the
1407: name of the section
1408: you want to update, matching the name passed to C<changable_area>, and
1409: the new content you want to put in there, will put the content into
1410: that area.
1411:
1412: B<Note>: Netscape 4 only reserves enough space for the changable area
1413: to contain room for the original contents. You need to "make space"
1414: for whatever changes you wish to make, and be B<sure> to check your
1415: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1416: it's adequate for updating a one-line status display, but little more.
1417: This script will set the space to 100% width, so you only need to
1418: worry about height in Netscape 4.
1419:
1420: Modern browsers are much less limiting, and if you can commit to the
1421: user not using Netscape 4, this feature may be used freely with
1422: pretty much any HTML.
1423:
1424: =cut
1425:
1426: sub change_content_javascript {
1427: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1428: if ($env{'browser.type'} eq 'netscape' &&
1429: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1430: return (<<NETSCAPE4);
1431: function change(name, content) {
1432: doc = document.layers[name+"___escape"].layers[0].document;
1433: doc.open();
1434: doc.write(content);
1435: doc.close();
1436: }
1437: NETSCAPE4
1438: } else {
1439: # Otherwise, we need to use semi-standards-compliant code
1440: # (technically, "innerHTML" isn't standard but the equivalent
1441: # is really scary, and every useful browser supports it
1442: return (<<DOMBASED);
1443: function change(name, content) {
1444: element = document.getElementById(name);
1445: element.innerHTML = content;
1446: }
1447: DOMBASED
1448: }
1449: }
1450:
1451: =pod
1452:
1.648 raeburn 1453: =item * &changable_area($name,$origContent):
1.256 matthew 1454:
1455: This provides a "changable area" that can be modified on the fly via
1456: the Javascript code provided in C<change_content_javascript>. $name is
1457: the name you will use to reference the area later; do not repeat the
1458: same name on a given HTML page more then once. $origContent is what
1459: the area will originally contain, which can be left blank.
1460:
1461: =cut
1462:
1463: sub changable_area {
1464: my ($name, $origContent) = @_;
1465:
1.258 albertel 1466: if ($env{'browser.type'} eq 'netscape' &&
1467: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1468: # If this is netscape 4, we need to use the Layer tag
1469: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1470: } else {
1471: return "<span id='$name'>$origContent</span>";
1472: }
1473: }
1474:
1475: =pod
1476:
1.648 raeburn 1477: =item * &viewport_geometry_js
1.590 raeburn 1478:
1479: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1480:
1481: =cut
1482:
1483:
1484: sub viewport_geometry_js {
1485: return <<"GEOMETRY";
1486: var Geometry = {};
1487: function init_geometry() {
1488: if (Geometry.init) { return };
1489: Geometry.init=1;
1490: if (window.innerHeight) {
1491: Geometry.getViewportHeight = function() { return window.innerHeight; };
1492: Geometry.getViewportWidth = function() { return window.innerWidth; };
1493: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1494: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1495: }
1496: else if (document.documentElement && document.documentElement.clientHeight) {
1497: Geometry.getViewportHeight =
1498: function() { return document.documentElement.clientHeight; };
1499: Geometry.getViewportWidth =
1500: function() { return document.documentElement.clientWidth; };
1501:
1502: Geometry.getHorizontalScroll =
1503: function() { return document.documentElement.scrollLeft; };
1504: Geometry.getVerticalScroll =
1505: function() { return document.documentElement.scrollTop; };
1506: }
1507: else if (document.body.clientHeight) {
1508: Geometry.getViewportHeight =
1509: function() { return document.body.clientHeight; };
1510: Geometry.getViewportWidth =
1511: function() { return document.body.clientWidth; };
1512: Geometry.getHorizontalScroll =
1513: function() { return document.body.scrollLeft; };
1514: Geometry.getVerticalScroll =
1515: function() { return document.body.scrollTop; };
1516: }
1517: }
1518:
1519: GEOMETRY
1520: }
1521:
1522: =pod
1523:
1.648 raeburn 1524: =item * &viewport_size_js()
1.590 raeburn 1525:
1526: 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.
1527:
1528: =cut
1529:
1530: sub viewport_size_js {
1531: my $geometry = &viewport_geometry_js();
1532: return <<"DIMS";
1533:
1534: $geometry
1535:
1536: function getViewportDims(width,height) {
1537: init_geometry();
1538: width.value = Geometry.getViewportWidth();
1539: height.value = Geometry.getViewportHeight();
1540: return;
1541: }
1542:
1543: DIMS
1544: }
1545:
1546: =pod
1547:
1.648 raeburn 1548: =item * &resize_textarea_js()
1.565 albertel 1549:
1550: emits the needed javascript to resize a textarea to be as big as possible
1551:
1552: creates a function resize_textrea that takes two IDs first should be
1553: the id of the element to resize, second should be the id of a div that
1554: surrounds everything that comes after the textarea, this routine needs
1555: to be attached to the <body> for the onload and onresize events.
1556:
1.648 raeburn 1557: =back
1.565 albertel 1558:
1559: =cut
1560:
1561: sub resize_textarea_js {
1.590 raeburn 1562: my $geometry = &viewport_geometry_js();
1.565 albertel 1563: return <<"RESIZE";
1564: <script type="text/javascript">
1.824 bisitz 1565: // <![CDATA[
1.590 raeburn 1566: $geometry
1.565 albertel 1567:
1.588 albertel 1568: function getX(element) {
1569: var x = 0;
1570: while (element) {
1571: x += element.offsetLeft;
1572: element = element.offsetParent;
1573: }
1574: return x;
1575: }
1576: function getY(element) {
1577: var y = 0;
1578: while (element) {
1579: y += element.offsetTop;
1580: element = element.offsetParent;
1581: }
1582: return y;
1583: }
1584:
1585:
1.565 albertel 1586: function resize_textarea(textarea_id,bottom_id) {
1587: init_geometry();
1588: var textarea = document.getElementById(textarea_id);
1589: //alert(textarea);
1590:
1.588 albertel 1591: var textarea_top = getY(textarea);
1.565 albertel 1592: var textarea_height = textarea.offsetHeight;
1593: var bottom = document.getElementById(bottom_id);
1.588 albertel 1594: var bottom_top = getY(bottom);
1.565 albertel 1595: var bottom_height = bottom.offsetHeight;
1596: var window_height = Geometry.getViewportHeight();
1.588 albertel 1597: var fudge = 23;
1.565 albertel 1598: var new_height = window_height-fudge-textarea_top-bottom_height;
1599: if (new_height < 300) {
1600: new_height = 300;
1601: }
1602: textarea.style.height=new_height+'px';
1603: }
1.824 bisitz 1604: // ]]>
1.565 albertel 1605: </script>
1606: RESIZE
1607:
1608: }
1609:
1610: =pod
1611:
1.256 matthew 1612: =head1 Excel and CSV file utility routines
1613:
1614: =over 4
1615:
1616: =cut
1617:
1618: ###############################################################
1619: ###############################################################
1620:
1621: =pod
1622:
1.648 raeburn 1623: =item * &csv_translate($text)
1.37 matthew 1624:
1.185 www 1625: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1626: format.
1627:
1628: =cut
1629:
1.180 matthew 1630: ###############################################################
1631: ###############################################################
1.37 matthew 1632: sub csv_translate {
1633: my $text = shift;
1634: $text =~ s/\"/\"\"/g;
1.209 albertel 1635: $text =~ s/\n/ /g;
1.37 matthew 1636: return $text;
1637: }
1.180 matthew 1638:
1639: ###############################################################
1640: ###############################################################
1641:
1642: =pod
1643:
1.648 raeburn 1644: =item * &define_excel_formats()
1.180 matthew 1645:
1646: Define some commonly used Excel cell formats.
1647:
1648: Currently supported formats:
1649:
1650: =over 4
1651:
1652: =item header
1653:
1654: =item bold
1655:
1656: =item h1
1657:
1658: =item h2
1659:
1660: =item h3
1661:
1.256 matthew 1662: =item h4
1663:
1664: =item i
1665:
1.180 matthew 1666: =item date
1667:
1668: =back
1669:
1670: Inputs: $workbook
1671:
1672: Returns: $format, a hash reference.
1673:
1674: =cut
1675:
1676: ###############################################################
1677: ###############################################################
1678: sub define_excel_formats {
1679: my ($workbook) = @_;
1680: my $format;
1681: $format->{'header'} = $workbook->add_format(bold => 1,
1682: bottom => 1,
1683: align => 'center');
1684: $format->{'bold'} = $workbook->add_format(bold=>1);
1685: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1686: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1687: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1688: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1689: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1690: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1691: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1692: return $format;
1693: }
1694:
1695: ###############################################################
1696: ###############################################################
1.113 bowersj2 1697:
1698: =pod
1699:
1.648 raeburn 1700: =item * &create_workbook()
1.255 matthew 1701:
1702: Create an Excel worksheet. If it fails, output message on the
1703: request object and return undefs.
1704:
1705: Inputs: Apache request object
1706:
1707: Returns (undef) on failure,
1708: Excel worksheet object, scalar with filename, and formats
1709: from &Apache::loncommon::define_excel_formats on success
1710:
1711: =cut
1712:
1713: ###############################################################
1714: ###############################################################
1715: sub create_workbook {
1716: my ($r) = @_;
1717: #
1718: # Create the excel spreadsheet
1719: my $filename = '/prtspool/'.
1.258 albertel 1720: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1721: time.'_'.rand(1000000000).'.xls';
1722: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1723: if (! defined($workbook)) {
1724: $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928 bisitz 1725: $r->print(
1726: '<p class="LC_error">'
1727: .&mt('Problems occurred in creating the new Excel file.')
1728: .' '.&mt('This error has been logged.')
1729: .' '.&mt('Please alert your LON-CAPA administrator.')
1730: .'</p>'
1731: );
1.255 matthew 1732: return (undef);
1733: }
1734: #
1735: $workbook->set_tempdir('/home/httpd/perl/tmp');
1736: #
1737: my $format = &Apache::loncommon::define_excel_formats($workbook);
1738: return ($workbook,$filename,$format);
1739: }
1740:
1741: ###############################################################
1742: ###############################################################
1743:
1744: =pod
1745:
1.648 raeburn 1746: =item * &create_text_file()
1.113 bowersj2 1747:
1.542 raeburn 1748: Create a file to write to and eventually make available to the user.
1.256 matthew 1749: If file creation fails, outputs an error message on the request object and
1750: return undefs.
1.113 bowersj2 1751:
1.256 matthew 1752: Inputs: Apache request object, and file suffix
1.113 bowersj2 1753:
1.256 matthew 1754: Returns (undef) on failure,
1755: Filehandle and filename on success.
1.113 bowersj2 1756:
1757: =cut
1758:
1.256 matthew 1759: ###############################################################
1760: ###############################################################
1761: sub create_text_file {
1762: my ($r,$suffix) = @_;
1763: if (! defined($suffix)) { $suffix = 'txt'; };
1764: my $fh;
1765: my $filename = '/prtspool/'.
1.258 albertel 1766: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1767: time.'_'.rand(1000000000).'.'.$suffix;
1768: $fh = Apache::File->new('>/home/httpd'.$filename);
1769: if (! defined($fh)) {
1770: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 1771: $r->print(
1772: '<p class="LC_error">'
1773: .&mt('Problems occurred in creating the output file.')
1774: .' '.&mt('This error has been logged.')
1775: .' '.&mt('Please alert your LON-CAPA administrator.')
1776: .'</p>'
1777: );
1.113 bowersj2 1778: }
1.256 matthew 1779: return ($fh,$filename)
1.113 bowersj2 1780: }
1781:
1782:
1.256 matthew 1783: =pod
1.113 bowersj2 1784:
1785: =back
1786:
1787: =cut
1.37 matthew 1788:
1789: ###############################################################
1.33 matthew 1790: ## Home server <option> list generating code ##
1791: ###############################################################
1.35 matthew 1792:
1.169 www 1793: # ------------------------------------------
1794:
1795: sub domain_select {
1796: my ($name,$value,$multiple)=@_;
1797: my %domains=map {
1.514 albertel 1798: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1799: } &Apache::lonnet::all_domains();
1.169 www 1800: if ($multiple) {
1801: $domains{''}=&mt('Any domain');
1.550 albertel 1802: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1803: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1804: } else {
1.550 albertel 1805: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.948.2.7 raeburn 1806: return &select_form($name,$value,\%domains);
1.169 www 1807: }
1808: }
1809:
1.282 albertel 1810: #-------------------------------------------
1811:
1812: =pod
1813:
1.519 raeburn 1814: =head1 Routines for form select boxes
1815:
1816: =over 4
1817:
1.648 raeburn 1818: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1819:
1820: Returns a string containing a <select> element int multiple mode
1821:
1822:
1823: Args:
1824: $name - name of the <select> element
1.506 raeburn 1825: $value - scalar or array ref of values that should already be selected
1.282 albertel 1826: $size - number of rows long the select element is
1.283 albertel 1827: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1828: (shown text should already have been &mt())
1.506 raeburn 1829: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1830:
1.282 albertel 1831: =cut
1832:
1833: #-------------------------------------------
1.169 www 1834: sub multiple_select_form {
1.284 albertel 1835: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1836: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1837: my $output='';
1.191 matthew 1838: if (! defined($size)) {
1839: $size = 4;
1.283 albertel 1840: if (scalar(keys(%$hash))<4) {
1841: $size = scalar(keys(%$hash));
1.191 matthew 1842: }
1843: }
1.734 bisitz 1844: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1845: my @order;
1.506 raeburn 1846: if (ref($order) eq 'ARRAY') {
1847: @order = @{$order};
1848: } else {
1849: @order = sort(keys(%$hash));
1.501 banghart 1850: }
1851: if (exists($$hash{'select_form_order'})) {
1852: @order = @{$$hash{'select_form_order'}};
1853: }
1854:
1.284 albertel 1855: foreach my $key (@order) {
1.356 albertel 1856: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1857: $output.='selected="selected" ' if ($selected{$key});
1858: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1859: }
1860: $output.="</select>\n";
1861: return $output;
1862: }
1863:
1.88 www 1864: #-------------------------------------------
1865:
1866: =pod
1867:
1.948.2.7 raeburn 1868: =item * &select_form($defdom,$name,$hashref,$onchange)
1.88 www 1869:
1870: Returns a string containing a <select name='$name' size='1'> form to
1.948.2.7 raeburn 1871: allow a user to select options from a ref to a hash containing:
1872: option_name => displayed text. An optional $onchange can include
1873: a javascript onchange item, e.g., onchange="this.form.submit();"
1874:
1.88 www 1875: See lonrights.pm for an example invocation and use.
1876:
1877: =cut
1878:
1879: #-------------------------------------------
1880: sub select_form {
1.948.2.7 raeburn 1881: my ($def,$name,$hashref,$onchange) = @_;
1882: return unless (ref($hashref) eq 'HASH');
1883: if ($onchange) {
1884: $onchange = ' onchange="'.$onchange.'"';
1885: }
1886: my $selectform = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.128 albertel 1887: my @keys;
1.948.2.7 raeburn 1888: if (exists($hashref->{'select_form_order'})) {
1889: @keys=@{$hashref->{'select_form_order'}};
1.128 albertel 1890: } else {
1.948.2.7 raeburn 1891: @keys=sort(keys(%{$hashref}));
1.128 albertel 1892: }
1.356 albertel 1893: foreach my $key (@keys) {
1894: $selectform.=
1895: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1896: ($key eq $def ? 'selected="selected" ' : '').
1.948.2.7 raeburn 1897: ">".$hashref->{$key}."</option>\n";
1.88 www 1898: }
1899: $selectform.="</select>";
1900: return $selectform;
1901: }
1902:
1.475 www 1903: # For display filters
1904:
1905: sub display_filter {
1906: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1907: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714 bisitz 1908: return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475 www 1909: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1910: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 1911: '</label></span> <span class="LC_nobreak">'.
1.475 www 1912: &mt('Filter [_1]',
1.477 www 1913: &select_form($env{'form.displayfilter'},
1914: 'displayfilter',
1.948.2.7 raeburn 1915: {'currentfolder' => 'Current folder/page',
1.477 www 1916: 'containing' => 'Containing phrase',
1.948.2.7 raeburn 1917: 'none' => 'None'})).
1.714 bisitz 1918: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475 www 1919: }
1920:
1.167 www 1921: sub gradeleveldescription {
1922: my $gradelevel=shift;
1923: my %gradelevels=(0 => 'Not specified',
1924: 1 => 'Grade 1',
1925: 2 => 'Grade 2',
1926: 3 => 'Grade 3',
1927: 4 => 'Grade 4',
1928: 5 => 'Grade 5',
1929: 6 => 'Grade 6',
1930: 7 => 'Grade 7',
1931: 8 => 'Grade 8',
1932: 9 => 'Grade 9',
1933: 10 => 'Grade 10',
1934: 11 => 'Grade 11',
1935: 12 => 'Grade 12',
1936: 13 => 'Grade 13',
1937: 14 => '100 Level',
1938: 15 => '200 Level',
1939: 16 => '300 Level',
1940: 17 => '400 Level',
1941: 18 => 'Graduate Level');
1942: return &mt($gradelevels{$gradelevel});
1943: }
1944:
1.163 www 1945: sub select_level_form {
1946: my ($deflevel,$name)=@_;
1947: unless ($deflevel) { $deflevel=0; }
1.167 www 1948: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1949: for (my $i=0; $i<=18; $i++) {
1950: $selectform.="<option value=\"$i\" ".
1.253 albertel 1951: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1952: ">".&gradeleveldescription($i)."</option>\n";
1953: }
1954: $selectform.="</select>";
1955: return $selectform;
1.163 www 1956: }
1.167 www 1957:
1.35 matthew 1958: #-------------------------------------------
1959:
1.45 matthew 1960: =pod
1961:
1.910 raeburn 1962: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35 matthew 1963:
1964: Returns a string containing a <select name='$name' size='1'> form to
1965: allow a user to select the domain to preform an operation in.
1966: See loncreateuser.pm for an example invocation and use.
1967:
1.90 www 1968: If the $includeempty flag is set, it also includes an empty choice ("no domain
1969: selected");
1970:
1.743 raeburn 1971: If the $showdomdesc flag is set, the domain name is followed by the domain description.
1972:
1.910 raeburn 1973: 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.
1974:
1975: The optional $incdoms is a reference to an array of domains which will be the only available options.
1.563 raeburn 1976:
1.35 matthew 1977: =cut
1978:
1979: #-------------------------------------------
1.34 matthew 1980: sub select_dom_form {
1.910 raeburn 1981: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.872 raeburn 1982: if ($onchange) {
1.874 raeburn 1983: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 1984: }
1.910 raeburn 1985: my @domains;
1986: if (ref($incdoms) eq 'ARRAY') {
1987: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
1988: } else {
1989: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1990: }
1.90 www 1991: if ($includeempty) { @domains=('',@domains); }
1.743 raeburn 1992: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 1993: foreach my $dom (@domains) {
1994: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 1995: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
1996: if ($showdomdesc) {
1997: if ($dom ne '') {
1998: my $domdesc = &Apache::lonnet::domain($dom,'description');
1999: if ($domdesc ne '') {
2000: $selectdomain .= ' ('.$domdesc.')';
2001: }
2002: }
2003: }
2004: $selectdomain .= "</option>\n";
1.34 matthew 2005: }
2006: $selectdomain.="</select>";
2007: return $selectdomain;
2008: }
2009:
1.35 matthew 2010: #-------------------------------------------
2011:
1.45 matthew 2012: =pod
2013:
1.648 raeburn 2014: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 2015:
1.586 raeburn 2016: input: 4 arguments (two required, two optional) -
2017: $domain - domain of new user
2018: $name - name of form element
2019: $default - Value of 'default' causes a default item to be first
2020: option, and selected by default.
2021: $hide - Value of 'hide' causes hiding of the name of the server,
2022: if 1 server found, or default, if 0 found.
1.594 raeburn 2023: output: returns 2 items:
1.586 raeburn 2024: (a) form element which contains either:
2025: (i) <select name="$name">
2026: <option value="$hostid1">$hostid $servers{$hostid}</option>
2027: <option value="$hostid2">$hostid $servers{$hostid}</option>
2028: </select>
2029: form item if there are multiple library servers in $domain, or
2030: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2031: if there is only one library server in $domain.
2032:
2033: (b) number of library servers found.
2034:
2035: See loncreateuser.pm for example of use.
1.35 matthew 2036:
2037: =cut
2038:
2039: #-------------------------------------------
1.586 raeburn 2040: sub home_server_form_item {
2041: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2042: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2043: my $result;
2044: my $numlib = keys(%servers);
2045: if ($numlib > 1) {
2046: $result .= '<select name="'.$name.'" />'."\n";
2047: if ($default) {
1.804 bisitz 2048: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 2049: '</option>'."\n";
2050: }
2051: foreach my $hostid (sort(keys(%servers))) {
2052: $result.= '<option value="'.$hostid.'">'.
2053: $hostid.' '.$servers{$hostid}."</option>\n";
2054: }
2055: $result .= '</select>'."\n";
2056: } elsif ($numlib == 1) {
2057: my $hostid;
2058: foreach my $item (keys(%servers)) {
2059: $hostid = $item;
2060: }
2061: $result .= '<input type="hidden" name="'.$name.'" value="'.
2062: $hostid.'" />';
2063: if (!$hide) {
2064: $result .= $hostid.' '.$servers{$hostid};
2065: }
2066: $result .= "\n";
2067: } elsif ($default) {
2068: $result .= '<input type="hidden" name="'.$name.
2069: '" value="default" />';
2070: if (!$hide) {
2071: $result .= &mt('default');
2072: }
2073: $result .= "\n";
1.33 matthew 2074: }
1.586 raeburn 2075: return ($result,$numlib);
1.33 matthew 2076: }
1.112 bowersj2 2077:
2078: =pod
2079:
1.534 albertel 2080: =back
2081:
1.112 bowersj2 2082: =cut
1.87 matthew 2083:
2084: ###############################################################
1.112 bowersj2 2085: ## Decoding User Agent ##
1.87 matthew 2086: ###############################################################
2087:
2088: =pod
2089:
1.112 bowersj2 2090: =head1 Decoding the User Agent
2091:
2092: =over 4
2093:
2094: =item * &decode_user_agent()
1.87 matthew 2095:
2096: Inputs: $r
2097:
2098: Outputs:
2099:
2100: =over 4
2101:
1.112 bowersj2 2102: =item * $httpbrowser
1.87 matthew 2103:
1.112 bowersj2 2104: =item * $clientbrowser
1.87 matthew 2105:
1.112 bowersj2 2106: =item * $clientversion
1.87 matthew 2107:
1.112 bowersj2 2108: =item * $clientmathml
1.87 matthew 2109:
1.112 bowersj2 2110: =item * $clientunicode
1.87 matthew 2111:
1.112 bowersj2 2112: =item * $clientos
1.87 matthew 2113:
2114: =back
2115:
1.157 matthew 2116: =back
2117:
1.87 matthew 2118: =cut
2119:
2120: ###############################################################
2121: ###############################################################
2122: sub decode_user_agent {
1.247 albertel 2123: my ($r)=@_;
1.87 matthew 2124: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2125: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2126: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2127: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2128: my $clientbrowser='unknown';
2129: my $clientversion='0';
2130: my $clientmathml='';
2131: my $clientunicode='0';
2132: for (my $i=0;$i<=$#browsertype;$i++) {
2133: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
2134: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2135: $clientbrowser=$bname;
2136: $httpbrowser=~/$vreg/i;
2137: $clientversion=$1;
2138: $clientmathml=($clientversion>=$minv);
2139: $clientunicode=($clientversion>=$univ);
2140: }
2141: }
2142: my $clientos='unknown';
2143: if (($httpbrowser=~/linux/i) ||
2144: ($httpbrowser=~/unix/i) ||
2145: ($httpbrowser=~/ux/i) ||
2146: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2147: if (($httpbrowser=~/vax/i) ||
2148: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2149: if ($httpbrowser=~/next/i) { $clientos='next'; }
2150: if (($httpbrowser=~/mac/i) ||
2151: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
2152: if ($httpbrowser=~/win/i) { $clientos='win'; }
2153: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
2154: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
2155: $clientunicode,$clientos,);
2156: }
2157:
1.32 matthew 2158: ###############################################################
2159: ## Authentication changing form generation subroutines ##
2160: ###############################################################
2161: ##
2162: ## All of the authform_xxxxxxx subroutines take their inputs in a
2163: ## hash, and have reasonable default values.
2164: ##
2165: ## formname = the name given in the <form> tag.
1.35 matthew 2166: #-------------------------------------------
2167:
1.45 matthew 2168: =pod
2169:
1.112 bowersj2 2170: =head1 Authentication Routines
2171:
2172: =over 4
2173:
1.648 raeburn 2174: =item * &authform_xxxxxx()
1.35 matthew 2175:
2176: The authform_xxxxxx subroutines provide javascript and html forms which
2177: handle some of the conveniences required for authentication forms.
2178: This is not an optimal method, but it works.
2179:
2180: =over 4
2181:
1.112 bowersj2 2182: =item * authform_header
1.35 matthew 2183:
1.112 bowersj2 2184: =item * authform_authorwarning
1.35 matthew 2185:
1.112 bowersj2 2186: =item * authform_nochange
1.35 matthew 2187:
1.112 bowersj2 2188: =item * authform_kerberos
1.35 matthew 2189:
1.112 bowersj2 2190: =item * authform_internal
1.35 matthew 2191:
1.112 bowersj2 2192: =item * authform_filesystem
1.35 matthew 2193:
2194: =back
2195:
1.648 raeburn 2196: See loncreateuser.pm for invocation and use examples.
1.157 matthew 2197:
1.35 matthew 2198: =cut
2199:
2200: #-------------------------------------------
1.32 matthew 2201: sub authform_header{
2202: my %in = (
2203: formname => 'cu',
1.80 albertel 2204: kerb_def_dom => '',
1.32 matthew 2205: @_,
2206: );
2207: $in{'formname'} = 'document.' . $in{'formname'};
2208: my $result='';
1.80 albertel 2209:
2210: #---------------------------------------------- Code for upper case translation
2211: my $Javascript_toUpperCase;
2212: unless ($in{kerb_def_dom}) {
2213: $Javascript_toUpperCase =<<"END";
2214: switch (choice) {
2215: case 'krb': currentform.elements[choicearg].value =
2216: currentform.elements[choicearg].value.toUpperCase();
2217: break;
2218: default:
2219: }
2220: END
2221: } else {
2222: $Javascript_toUpperCase = "";
2223: }
2224:
1.165 raeburn 2225: my $radioval = "'nochange'";
1.591 raeburn 2226: if (defined($in{'curr_authtype'})) {
2227: if ($in{'curr_authtype'} ne '') {
2228: $radioval = "'".$in{'curr_authtype'}."arg'";
2229: }
1.174 matthew 2230: }
1.165 raeburn 2231: my $argfield = 'null';
1.591 raeburn 2232: if (defined($in{'mode'})) {
1.165 raeburn 2233: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2234: if (defined($in{'curr_autharg'})) {
2235: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2236: $argfield = "'$in{'curr_autharg'}'";
2237: }
2238: }
2239: }
2240: }
2241:
1.32 matthew 2242: $result.=<<"END";
2243: var current = new Object();
1.165 raeburn 2244: current.radiovalue = $radioval;
2245: current.argfield = $argfield;
1.32 matthew 2246:
2247: function changed_radio(choice,currentform) {
2248: var choicearg = choice + 'arg';
2249: // If a radio button in changed, we need to change the argfield
2250: if (current.radiovalue != choice) {
2251: current.radiovalue = choice;
2252: if (current.argfield != null) {
2253: currentform.elements[current.argfield].value = '';
2254: }
2255: if (choice == 'nochange') {
2256: current.argfield = null;
2257: } else {
2258: current.argfield = choicearg;
2259: switch(choice) {
2260: case 'krb':
2261: currentform.elements[current.argfield].value =
2262: "$in{'kerb_def_dom'}";
2263: break;
2264: default:
2265: break;
2266: }
2267: }
2268: }
2269: return;
2270: }
1.22 www 2271:
1.32 matthew 2272: function changed_text(choice,currentform) {
2273: var choicearg = choice + 'arg';
2274: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2275: $Javascript_toUpperCase
1.32 matthew 2276: // clear old field
2277: if ((current.argfield != choicearg) && (current.argfield != null)) {
2278: currentform.elements[current.argfield].value = '';
2279: }
2280: current.argfield = choicearg;
2281: }
2282: set_auth_radio_buttons(choice,currentform);
2283: return;
1.20 www 2284: }
1.32 matthew 2285:
2286: function set_auth_radio_buttons(newvalue,currentform) {
1.948.2.13 raeburn 2287: var numauthchoices = currentform.login.length;
2288: if (typeof numauthchoices == "undefined") {
2289: return;
2290: }
1.32 matthew 2291: var i=0;
1.948.2.17 raeburn 2292: while (i < numauthchoices) {
1.32 matthew 2293: if (currentform.login[i].value == newvalue) { break; }
2294: i++;
2295: }
1.948.2.13 raeburn 2296: if (i == numauthchoices) {
1.32 matthew 2297: return;
2298: }
2299: current.radiovalue = newvalue;
2300: currentform.login[i].checked = true;
2301: return;
2302: }
2303: END
2304: return $result;
2305: }
2306:
2307: sub authform_authorwarning{
2308: my $result='';
1.144 matthew 2309: $result='<i>'.
2310: &mt('As a general rule, only authors or co-authors should be '.
2311: 'filesystem authenticated '.
2312: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2313: return $result;
2314: }
2315:
2316: sub authform_nochange{
2317: my %in = (
2318: formname => 'document.cu',
2319: kerb_def_dom => 'MSU.EDU',
2320: @_,
2321: );
1.586 raeburn 2322: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2323: my $result;
2324: if (keys(%can_assign) == 0) {
2325: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2326: } else {
2327: $result = '<label>'.&mt('[_1] Do not change login data',
2328: '<input type="radio" name="login" value="nochange" '.
2329: 'checked="checked" onclick="'.
1.281 albertel 2330: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2331: '</label>';
1.586 raeburn 2332: }
1.32 matthew 2333: return $result;
2334: }
2335:
1.591 raeburn 2336: sub authform_kerberos {
1.32 matthew 2337: my %in = (
2338: formname => 'document.cu',
2339: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2340: kerb_def_auth => 'krb4',
1.32 matthew 2341: @_,
2342: );
1.586 raeburn 2343: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2344: $autharg,$jscall);
2345: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2346: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2347: $check5 = ' checked="checked"';
1.80 albertel 2348: } else {
1.772 bisitz 2349: $check4 = ' checked="checked"';
1.80 albertel 2350: }
1.165 raeburn 2351: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2352: if (defined($in{'curr_authtype'})) {
2353: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2354: $krbcheck = ' checked="checked"';
1.623 raeburn 2355: if (defined($in{'mode'})) {
2356: if ($in{'mode'} eq 'modifyuser') {
2357: $krbcheck = '';
2358: }
2359: }
1.591 raeburn 2360: if (defined($in{'curr_kerb_ver'})) {
2361: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2362: $check5 = ' checked="checked"';
1.591 raeburn 2363: $check4 = '';
2364: } else {
1.772 bisitz 2365: $check4 = ' checked="checked"';
1.591 raeburn 2366: $check5 = '';
2367: }
1.586 raeburn 2368: }
1.591 raeburn 2369: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2370: $krbarg = $in{'curr_autharg'};
2371: }
1.586 raeburn 2372: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2373: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2374: $result =
2375: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2376: $in{'curr_autharg'},$krbver);
2377: } else {
2378: $result =
2379: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2380: }
2381: return $result;
2382: }
2383: }
2384: } else {
2385: if ($authnum == 1) {
1.784 bisitz 2386: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2387: }
2388: }
1.586 raeburn 2389: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2390: return;
1.587 raeburn 2391: } elsif ($authtype eq '') {
1.591 raeburn 2392: if (defined($in{'mode'})) {
1.587 raeburn 2393: if ($in{'mode'} eq 'modifycourse') {
2394: if ($authnum == 1) {
1.784 bisitz 2395: $authtype = '<input type="hidden" name="login" value="krb" />';
1.587 raeburn 2396: }
2397: }
2398: }
1.586 raeburn 2399: }
2400: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2401: if ($authtype eq '') {
2402: $authtype = '<input type="radio" name="login" value="krb" '.
2403: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2404: $krbcheck.' />';
2405: }
2406: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2407: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2408: $in{'curr_authtype'} eq 'krb5') ||
2409: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2410: $in{'curr_authtype'} eq 'krb4')) {
2411: $result .= &mt
1.144 matthew 2412: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2413: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2414: '<label>'.$authtype,
1.281 albertel 2415: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2416: 'value="'.$krbarg.'" '.
1.144 matthew 2417: 'onchange="'.$jscall.'" />',
1.281 albertel 2418: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2419: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2420: '</label>');
1.586 raeburn 2421: } elsif ($can_assign{'krb4'}) {
2422: $result .= &mt
2423: ('[_1] Kerberos authenticated with domain [_2] '.
2424: '[_3] Version 4 [_4]',
2425: '<label>'.$authtype,
2426: '</label><input type="text" size="10" name="krbarg" '.
2427: 'value="'.$krbarg.'" '.
2428: 'onchange="'.$jscall.'" />',
2429: '<label><input type="hidden" name="krbver" value="4" />',
2430: '</label>');
2431: } elsif ($can_assign{'krb5'}) {
2432: $result .= &mt
2433: ('[_1] Kerberos authenticated with domain [_2] '.
2434: '[_3] Version 5 [_4]',
2435: '<label>'.$authtype,
2436: '</label><input type="text" size="10" name="krbarg" '.
2437: 'value="'.$krbarg.'" '.
2438: 'onchange="'.$jscall.'" />',
2439: '<label><input type="hidden" name="krbver" value="5" />',
2440: '</label>');
2441: }
1.32 matthew 2442: return $result;
2443: }
2444:
2445: sub authform_internal{
1.586 raeburn 2446: my %in = (
1.32 matthew 2447: formname => 'document.cu',
2448: kerb_def_dom => 'MSU.EDU',
2449: @_,
2450: );
1.586 raeburn 2451: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2452: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2453: if (defined($in{'curr_authtype'})) {
2454: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2455: if ($can_assign{'int'}) {
1.772 bisitz 2456: $intcheck = 'checked="checked" ';
1.623 raeburn 2457: if (defined($in{'mode'})) {
2458: if ($in{'mode'} eq 'modifyuser') {
2459: $intcheck = '';
2460: }
2461: }
1.591 raeburn 2462: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2463: $intarg = $in{'curr_autharg'};
2464: }
2465: } else {
2466: $result = &mt('Currently internally authenticated.');
2467: return $result;
1.165 raeburn 2468: }
2469: }
1.586 raeburn 2470: } else {
2471: if ($authnum == 1) {
1.784 bisitz 2472: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 2473: }
2474: }
2475: if (!$can_assign{'int'}) {
2476: return;
1.587 raeburn 2477: } elsif ($authtype eq '') {
1.591 raeburn 2478: if (defined($in{'mode'})) {
1.587 raeburn 2479: if ($in{'mode'} eq 'modifycourse') {
2480: if ($authnum == 1) {
1.784 bisitz 2481: $authtype = '<input type="hidden" name="login" value="int" />';
1.587 raeburn 2482: }
2483: }
2484: }
1.165 raeburn 2485: }
1.586 raeburn 2486: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2487: if ($authtype eq '') {
2488: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2489: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2490: }
1.605 bisitz 2491: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2492: $intarg.'" onchange="'.$jscall.'" />';
2493: $result = &mt
1.144 matthew 2494: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2495: '<label>'.$authtype,'</label>'.$autharg);
1.824 bisitz 2496: $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 2497: return $result;
2498: }
2499:
2500: sub authform_local{
2501: my %in = (
2502: formname => 'document.cu',
2503: kerb_def_dom => 'MSU.EDU',
2504: @_,
2505: );
1.586 raeburn 2506: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2507: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2508: if (defined($in{'curr_authtype'})) {
2509: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2510: if ($can_assign{'loc'}) {
1.772 bisitz 2511: $loccheck = 'checked="checked" ';
1.623 raeburn 2512: if (defined($in{'mode'})) {
2513: if ($in{'mode'} eq 'modifyuser') {
2514: $loccheck = '';
2515: }
2516: }
1.591 raeburn 2517: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2518: $locarg = $in{'curr_autharg'};
2519: }
2520: } else {
2521: $result = &mt('Currently using local (institutional) authentication.');
2522: return $result;
1.165 raeburn 2523: }
2524: }
1.586 raeburn 2525: } else {
2526: if ($authnum == 1) {
1.784 bisitz 2527: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 2528: }
2529: }
2530: if (!$can_assign{'loc'}) {
2531: return;
1.587 raeburn 2532: } elsif ($authtype eq '') {
1.591 raeburn 2533: if (defined($in{'mode'})) {
1.587 raeburn 2534: if ($in{'mode'} eq 'modifycourse') {
2535: if ($authnum == 1) {
1.784 bisitz 2536: $authtype = '<input type="hidden" name="login" value="loc" />';
1.587 raeburn 2537: }
2538: }
2539: }
1.165 raeburn 2540: }
1.586 raeburn 2541: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2542: if ($authtype eq '') {
2543: $authtype = '<input type="radio" name="login" value="loc" '.
2544: $loccheck.' onchange="'.$jscall.'" onclick="'.
2545: $jscall.'" />';
2546: }
2547: $autharg = '<input type="text" size="10" name="locarg" value="'.
2548: $locarg.'" onchange="'.$jscall.'" />';
2549: $result = &mt('[_1] Local Authentication with argument [_2]',
2550: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2551: return $result;
2552: }
2553:
2554: sub authform_filesystem{
2555: my %in = (
2556: formname => 'document.cu',
2557: kerb_def_dom => 'MSU.EDU',
2558: @_,
2559: );
1.586 raeburn 2560: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2561: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2562: if (defined($in{'curr_authtype'})) {
2563: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2564: if ($can_assign{'fsys'}) {
1.772 bisitz 2565: $fsyscheck = 'checked="checked" ';
1.623 raeburn 2566: if (defined($in{'mode'})) {
2567: if ($in{'mode'} eq 'modifyuser') {
2568: $fsyscheck = '';
2569: }
2570: }
1.586 raeburn 2571: } else {
2572: $result = &mt('Currently Filesystem Authenticated.');
2573: return $result;
2574: }
2575: }
2576: } else {
2577: if ($authnum == 1) {
1.784 bisitz 2578: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 2579: }
2580: }
2581: if (!$can_assign{'fsys'}) {
2582: return;
1.587 raeburn 2583: } elsif ($authtype eq '') {
1.591 raeburn 2584: if (defined($in{'mode'})) {
1.587 raeburn 2585: if ($in{'mode'} eq 'modifycourse') {
2586: if ($authnum == 1) {
1.784 bisitz 2587: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587 raeburn 2588: }
2589: }
2590: }
1.586 raeburn 2591: }
2592: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2593: if ($authtype eq '') {
2594: $authtype = '<input type="radio" name="login" value="fsys" '.
2595: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2596: $jscall.'" />';
2597: }
2598: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2599: ' onchange="'.$jscall.'" />';
2600: $result = &mt
1.144 matthew 2601: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2602: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2603: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2604: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2605: 'onchange="'.$jscall.'" />');
1.32 matthew 2606: return $result;
2607: }
2608:
1.586 raeburn 2609: sub get_assignable_auth {
2610: my ($dom) = @_;
2611: if ($dom eq '') {
2612: $dom = $env{'request.role.domain'};
2613: }
2614: my %can_assign = (
2615: krb4 => 1,
2616: krb5 => 1,
2617: int => 1,
2618: loc => 1,
2619: );
2620: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2621: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2622: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2623: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2624: my $context;
2625: if ($env{'request.role'} =~ /^au/) {
2626: $context = 'author';
2627: } elsif ($env{'request.role'} =~ /^dc/) {
2628: $context = 'domain';
2629: } elsif ($env{'request.course.id'}) {
2630: $context = 'course';
2631: }
2632: if ($context) {
2633: if (ref($authhash->{$context}) eq 'HASH') {
2634: %can_assign = %{$authhash->{$context}};
2635: }
2636: }
2637: }
2638: }
2639: my $authnum = 0;
2640: foreach my $key (keys(%can_assign)) {
2641: if ($can_assign{$key}) {
2642: $authnum ++;
2643: }
2644: }
2645: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2646: $authnum --;
2647: }
2648: return ($authnum,%can_assign);
2649: }
2650:
1.80 albertel 2651: ###############################################################
2652: ## Get Kerberos Defaults for Domain ##
2653: ###############################################################
2654: ##
2655: ## Returns default kerberos version and an associated argument
2656: ## as listed in file domain.tab. If not listed, provides
2657: ## appropriate default domain and kerberos version.
2658: ##
2659: #-------------------------------------------
2660:
2661: =pod
2662:
1.648 raeburn 2663: =item * &get_kerberos_defaults()
1.80 albertel 2664:
2665: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2666: version and domain. If not found, it defaults to version 4 and the
2667: domain of the server.
1.80 albertel 2668:
1.648 raeburn 2669: =over 4
2670:
1.80 albertel 2671: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2672:
1.648 raeburn 2673: =back
2674:
2675: =back
2676:
1.80 albertel 2677: =cut
2678:
2679: #-------------------------------------------
2680: sub get_kerberos_defaults {
2681: my $domain=shift;
1.641 raeburn 2682: my ($krbdef,$krbdefdom);
2683: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2684: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2685: $krbdef = $domdefaults{'auth_def'};
2686: $krbdefdom = $domdefaults{'auth_arg_def'};
2687: } else {
1.80 albertel 2688: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2689: my $krbdefdom=$1;
2690: $krbdefdom=~tr/a-z/A-Z/;
2691: $krbdef = "krb4";
2692: }
2693: return ($krbdef,$krbdefdom);
2694: }
1.112 bowersj2 2695:
1.32 matthew 2696:
1.46 matthew 2697: ###############################################################
2698: ## Thesaurus Functions ##
2699: ###############################################################
1.20 www 2700:
1.46 matthew 2701: =pod
1.20 www 2702:
1.112 bowersj2 2703: =head1 Thesaurus Functions
2704:
2705: =over 4
2706:
1.648 raeburn 2707: =item * &initialize_keywords()
1.46 matthew 2708:
2709: Initializes the package variable %Keywords if it is empty. Uses the
2710: package variable $thesaurus_db_file.
2711:
2712: =cut
2713:
2714: ###################################################
2715:
2716: sub initialize_keywords {
2717: return 1 if (scalar keys(%Keywords));
2718: # If we are here, %Keywords is empty, so fill it up
2719: # Make sure the file we need exists...
2720: if (! -e $thesaurus_db_file) {
2721: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2722: " failed because it does not exist");
2723: return 0;
2724: }
2725: # Set up the hash as a database
2726: my %thesaurus_db;
2727: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2728: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2729: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2730: $thesaurus_db_file);
2731: return 0;
2732: }
2733: # Get the average number of appearances of a word.
2734: my $avecount = $thesaurus_db{'average.count'};
2735: # Put keywords (those that appear > average) into %Keywords
2736: while (my ($word,$data)=each (%thesaurus_db)) {
2737: my ($count,undef) = split /:/,$data;
2738: $Keywords{$word}++ if ($count > $avecount);
2739: }
2740: untie %thesaurus_db;
2741: # Remove special values from %Keywords.
1.356 albertel 2742: foreach my $value ('total.count','average.count') {
2743: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2744: }
1.46 matthew 2745: return 1;
2746: }
2747:
2748: ###################################################
2749:
2750: =pod
2751:
1.648 raeburn 2752: =item * &keyword($word)
1.46 matthew 2753:
2754: Returns true if $word is a keyword. A keyword is a word that appears more
2755: than the average number of times in the thesaurus database. Calls
2756: &initialize_keywords
2757:
2758: =cut
2759:
2760: ###################################################
1.20 www 2761:
2762: sub keyword {
1.46 matthew 2763: return if (!&initialize_keywords());
2764: my $word=lc(shift());
2765: $word=~s/\W//g;
2766: return exists($Keywords{$word});
1.20 www 2767: }
1.46 matthew 2768:
2769: ###############################################################
2770:
2771: =pod
1.20 www 2772:
1.648 raeburn 2773: =item * &get_related_words()
1.46 matthew 2774:
1.160 matthew 2775: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2776: an array of words. If the keyword is not in the thesaurus, an empty array
2777: will be returned. The order of the words returned is determined by the
2778: database which holds them.
2779:
2780: Uses global $thesaurus_db_file.
2781:
2782: =cut
2783:
2784: ###############################################################
2785: sub get_related_words {
2786: my $keyword = shift;
2787: my %thesaurus_db;
2788: if (! -e $thesaurus_db_file) {
2789: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2790: "failed because the file does not exist");
2791: return ();
2792: }
2793: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2794: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2795: return ();
2796: }
2797: my @Words=();
1.429 www 2798: my $count=0;
1.46 matthew 2799: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2800: # The first element is the number of times
2801: # the word appears. We do not need it now.
1.429 www 2802: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2803: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2804: my $threshold=$mostfrequentcount/10;
2805: foreach my $possibleword (@RelatedWords) {
2806: my ($word,$wordcount)=split(/\,/,$possibleword);
2807: if ($wordcount>$threshold) {
2808: push(@Words,$word);
2809: $count++;
2810: if ($count>10) { last; }
2811: }
1.20 www 2812: }
2813: }
1.46 matthew 2814: untie %thesaurus_db;
2815: return @Words;
1.14 harris41 2816: }
1.46 matthew 2817:
1.112 bowersj2 2818: =pod
2819:
2820: =back
2821:
2822: =cut
1.61 www 2823:
2824: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2825: =pod
2826:
1.112 bowersj2 2827: =head1 User Name Functions
2828:
2829: =over 4
2830:
1.648 raeburn 2831: =item * &plainname($uname,$udom,$first)
1.81 albertel 2832:
1.112 bowersj2 2833: Takes a users logon name and returns it as a string in
1.226 albertel 2834: "first middle last generation" form
2835: if $first is set to 'lastname' then it returns it as
2836: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2837:
2838: =cut
1.61 www 2839:
1.295 www 2840:
1.81 albertel 2841: ###############################################################
1.61 www 2842: sub plainname {
1.226 albertel 2843: my ($uname,$udom,$first)=@_;
1.537 albertel 2844: return if (!defined($uname) || !defined($udom));
1.295 www 2845: my %names=&getnames($uname,$udom);
1.226 albertel 2846: my $name=&Apache::lonnet::format_name($names{'firstname'},
2847: $names{'middlename'},
2848: $names{'lastname'},
2849: $names{'generation'},$first);
2850: $name=~s/^\s+//;
1.62 www 2851: $name=~s/\s+$//;
2852: $name=~s/\s+/ /g;
1.353 albertel 2853: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2854: return $name;
1.61 www 2855: }
1.66 www 2856:
2857: # -------------------------------------------------------------------- Nickname
1.81 albertel 2858: =pod
2859:
1.648 raeburn 2860: =item * &nickname($uname,$udom)
1.81 albertel 2861:
2862: Gets a users name and returns it as a string as
2863:
2864: ""nickname""
1.66 www 2865:
1.81 albertel 2866: if the user has a nickname or
2867:
2868: "first middle last generation"
2869:
2870: if the user does not
2871:
2872: =cut
1.66 www 2873:
2874: sub nickname {
2875: my ($uname,$udom)=@_;
1.537 albertel 2876: return if (!defined($uname) || !defined($udom));
1.295 www 2877: my %names=&getnames($uname,$udom);
1.68 albertel 2878: my $name=$names{'nickname'};
1.66 www 2879: if ($name) {
2880: $name='"'.$name.'"';
2881: } else {
2882: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2883: $names{'lastname'}.' '.$names{'generation'};
2884: $name=~s/\s+$//;
2885: $name=~s/\s+/ /g;
2886: }
2887: return $name;
2888: }
2889:
1.295 www 2890: sub getnames {
2891: my ($uname,$udom)=@_;
1.537 albertel 2892: return if (!defined($uname) || !defined($udom));
1.433 albertel 2893: if ($udom eq 'public' && $uname eq 'public') {
2894: return ('lastname' => &mt('Public'));
2895: }
1.295 www 2896: my $id=$uname.':'.$udom;
2897: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2898: if ($cached) {
2899: return %{$names};
2900: } else {
2901: my %loadnames=&Apache::lonnet::get('environment',
2902: ['firstname','middlename','lastname','generation','nickname'],
2903: $udom,$uname);
2904: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2905: return %loadnames;
2906: }
2907: }
1.61 www 2908:
1.542 raeburn 2909: # -------------------------------------------------------------------- getemails
1.648 raeburn 2910:
1.542 raeburn 2911: =pod
2912:
1.648 raeburn 2913: =item * &getemails($uname,$udom)
1.542 raeburn 2914:
2915: Gets a user's email information and returns it as a hash with keys:
2916: notification, critnotification, permanentemail
2917:
2918: For notification and critnotification, values are comma-separated lists
1.648 raeburn 2919: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 2920:
1.648 raeburn 2921:
1.542 raeburn 2922: =cut
2923:
1.648 raeburn 2924:
1.466 albertel 2925: sub getemails {
2926: my ($uname,$udom)=@_;
2927: if ($udom eq 'public' && $uname eq 'public') {
2928: return;
2929: }
1.467 www 2930: if (!$udom) { $udom=$env{'user.domain'}; }
2931: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 2932: my $id=$uname.':'.$udom;
2933: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2934: if ($cached) {
2935: return %{$names};
2936: } else {
2937: my %loadnames=&Apache::lonnet::get('environment',
2938: ['notification','critnotification',
2939: 'permanentemail'],
2940: $udom,$uname);
2941: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2942: return %loadnames;
2943: }
2944: }
2945:
1.551 albertel 2946: sub flush_email_cache {
2947: my ($uname,$udom)=@_;
2948: if (!$udom) { $udom =$env{'user.domain'}; }
2949: if (!$uname) { $uname=$env{'user.name'}; }
2950: return if ($udom eq 'public' && $uname eq 'public');
2951: my $id=$uname.':'.$udom;
2952: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2953: }
2954:
1.728 raeburn 2955: # -------------------------------------------------------------------- getlangs
2956:
2957: =pod
2958:
2959: =item * &getlangs($uname,$udom)
2960:
2961: Gets a user's language preference and returns it as a hash with key:
2962: language.
2963:
2964: =cut
2965:
2966:
2967: sub getlangs {
2968: my ($uname,$udom) = @_;
2969: if (!$udom) { $udom =$env{'user.domain'}; }
2970: if (!$uname) { $uname=$env{'user.name'}; }
2971: my $id=$uname.':'.$udom;
2972: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
2973: if ($cached) {
2974: return %{$langs};
2975: } else {
2976: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
2977: $udom,$uname);
2978: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
2979: return %loadlangs;
2980: }
2981: }
2982:
2983: sub flush_langs_cache {
2984: my ($uname,$udom)=@_;
2985: if (!$udom) { $udom =$env{'user.domain'}; }
2986: if (!$uname) { $uname=$env{'user.name'}; }
2987: return if ($udom eq 'public' && $uname eq 'public');
2988: my $id=$uname.':'.$udom;
2989: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
2990: }
2991:
1.61 www 2992: # ------------------------------------------------------------------ Screenname
1.81 albertel 2993:
2994: =pod
2995:
1.648 raeburn 2996: =item * &screenname($uname,$udom)
1.81 albertel 2997:
2998: Gets a users screenname and returns it as a string
2999:
3000: =cut
1.61 www 3001:
3002: sub screenname {
3003: my ($uname,$udom)=@_;
1.258 albertel 3004: if ($uname eq $env{'user.name'} &&
3005: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 3006: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 3007: return $names{'screenname'};
1.62 www 3008: }
3009:
1.212 albertel 3010:
1.802 bisitz 3011: # ------------------------------------------------------------- Confirm Wrapper
3012: =pod
3013:
3014: =item confirmwrapper
3015:
3016: Wrap messages about completion of operation in box
3017:
3018: =cut
3019:
3020: sub confirmwrapper {
3021: my ($message)=@_;
3022: if ($message) {
3023: return "\n".'<div class="LC_confirm_box">'."\n"
3024: .$message."\n"
3025: .'</div>'."\n";
3026: } else {
3027: return $message;
3028: }
3029: }
3030:
1.62 www 3031: # ------------------------------------------------------------- Message Wrapper
3032:
3033: sub messagewrapper {
1.369 www 3034: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 3035: return
1.441 albertel 3036: '<a href="/adm/email?compose=individual&'.
3037: 'recname='.$username.'&recdom='.$domain.
3038: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 3039: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 3040: }
1.802 bisitz 3041:
1.74 www 3042: # --------------------------------------------------------------- Notes Wrapper
3043:
3044: sub noteswrapper {
3045: my ($link,$un,$do)=@_;
3046: return
1.896 amueller 3047: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 3048: }
1.802 bisitz 3049:
1.62 www 3050: # ------------------------------------------------------------- Aboutme Wrapper
3051:
3052: sub aboutmewrapper {
1.166 www 3053: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 3054: if (!defined($username) && !defined($domain)) {
3055: return;
3056: }
1.892 amueller 3057: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.756 weissno 3058: ($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 3059: }
3060:
3061: # ------------------------------------------------------------ Syllabus Wrapper
3062:
3063: sub syllabuswrapper {
1.707 bisitz 3064: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 3065: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 3066: }
1.14 harris41 3067:
1.802 bisitz 3068: # -----------------------------------------------------------------------------
3069:
1.208 matthew 3070: sub track_student_link {
1.887 raeburn 3071: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 3072: my $link ="/adm/trackstudent?";
1.208 matthew 3073: my $title = 'View recent activity';
3074: if (defined($sname) && $sname !~ /^\s*$/ &&
3075: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 3076: $link .= "selected_student=$sname:$sdom";
1.208 matthew 3077: $title .= ' of this student';
1.268 albertel 3078: }
1.208 matthew 3079: if (defined($target) && $target !~ /^\s*$/) {
3080: $target = qq{target="$target"};
3081: } else {
3082: $target = '';
3083: }
1.268 albertel 3084: if ($start) { $link.='&start='.$start; }
1.887 raeburn 3085: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 3086: $title = &mt($title);
3087: $linktext = &mt($linktext);
1.448 albertel 3088: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
3089: &help_open_topic('View_recent_activity');
1.208 matthew 3090: }
3091:
1.781 raeburn 3092: sub slot_reservations_link {
3093: my ($linktext,$sname,$sdom,$target) = @_;
3094: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
3095: my $title = 'View slot reservation history';
3096: if (defined($sname) && $sname !~ /^\s*$/ &&
3097: defined($sdom) && $sdom !~ /^\s*$/) {
3098: $link .= "&uname=$sname&udom=$sdom";
3099: $title .= ' of this student';
3100: }
3101: if (defined($target) && $target !~ /^\s*$/) {
3102: $target = qq{target="$target"};
3103: } else {
3104: $target = '';
3105: }
3106: $title = &mt($title);
3107: $linktext = &mt($linktext);
3108: return qq{<a href="$link" title="$title" $target>$linktext</a>};
3109: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
3110:
3111: }
3112:
1.508 www 3113: # ===================================================== Display a student photo
3114:
3115:
1.509 albertel 3116: sub student_image_tag {
1.508 www 3117: my ($domain,$user)=@_;
3118: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
3119: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
3120: return '<img src="'.$imgsrc.'" align="right" />';
3121: } else {
3122: return '';
3123: }
3124: }
3125:
1.112 bowersj2 3126: =pod
3127:
3128: =back
3129:
3130: =head1 Access .tab File Data
3131:
3132: =over 4
3133:
1.648 raeburn 3134: =item * &languageids()
1.112 bowersj2 3135:
3136: returns list of all language ids
3137:
3138: =cut
3139:
1.14 harris41 3140: sub languageids {
1.16 harris41 3141: return sort(keys(%language));
1.14 harris41 3142: }
3143:
1.112 bowersj2 3144: =pod
3145:
1.648 raeburn 3146: =item * &languagedescription()
1.112 bowersj2 3147:
3148: returns description of a specified language id
3149:
3150: =cut
3151:
1.14 harris41 3152: sub languagedescription {
1.125 www 3153: my $code=shift;
3154: return ($supported_language{$code}?'* ':'').
3155: $language{$code}.
1.126 www 3156: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 3157: }
3158:
3159: sub plainlanguagedescription {
3160: my $code=shift;
3161: return $language{$code};
3162: }
3163:
3164: sub supportedlanguagecode {
3165: my $code=shift;
3166: return $supported_language{$code};
1.97 www 3167: }
3168:
1.112 bowersj2 3169: =pod
3170:
1.648 raeburn 3171: =item * ©rightids()
1.112 bowersj2 3172:
3173: returns list of all copyrights
3174:
3175: =cut
3176:
3177: sub copyrightids {
3178: return sort(keys(%cprtag));
3179: }
3180:
3181: =pod
3182:
1.648 raeburn 3183: =item * ©rightdescription()
1.112 bowersj2 3184:
3185: returns description of a specified copyright id
3186:
3187: =cut
3188:
3189: sub copyrightdescription {
1.166 www 3190: return &mt($cprtag{shift(@_)});
1.112 bowersj2 3191: }
1.197 matthew 3192:
3193: =pod
3194:
1.648 raeburn 3195: =item * &source_copyrightids()
1.192 taceyjo1 3196:
3197: returns list of all source copyrights
3198:
3199: =cut
3200:
3201: sub source_copyrightids {
3202: return sort(keys(%scprtag));
3203: }
3204:
3205: =pod
3206:
1.648 raeburn 3207: =item * &source_copyrightdescription()
1.192 taceyjo1 3208:
3209: returns description of a specified source copyright id
3210:
3211: =cut
3212:
3213: sub source_copyrightdescription {
3214: return &mt($scprtag{shift(@_)});
3215: }
1.112 bowersj2 3216:
3217: =pod
3218:
1.648 raeburn 3219: =item * &filecategories()
1.112 bowersj2 3220:
3221: returns list of all file categories
3222:
3223: =cut
3224:
3225: sub filecategories {
3226: return sort(keys(%category_extensions));
3227: }
3228:
3229: =pod
3230:
1.648 raeburn 3231: =item * &filecategorytypes()
1.112 bowersj2 3232:
3233: returns list of file types belonging to a given file
3234: category
3235:
3236: =cut
3237:
3238: sub filecategorytypes {
1.356 albertel 3239: my ($cat) = @_;
3240: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 3241: }
3242:
3243: =pod
3244:
1.648 raeburn 3245: =item * &fileembstyle()
1.112 bowersj2 3246:
3247: returns embedding style for a specified file type
3248:
3249: =cut
3250:
3251: sub fileembstyle {
3252: return $fe{lc(shift(@_))};
1.169 www 3253: }
3254:
1.351 www 3255: sub filemimetype {
3256: return $fm{lc(shift(@_))};
3257: }
3258:
1.169 www 3259:
3260: sub filecategoryselect {
3261: my ($name,$value)=@_;
1.189 matthew 3262: return &select_form($value,$name,
1.948.2.7 raeburn 3263: {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112 bowersj2 3264: }
3265:
3266: =pod
3267:
1.648 raeburn 3268: =item * &filedescription()
1.112 bowersj2 3269:
3270: returns description for a specified file type
3271:
3272: =cut
3273:
3274: sub filedescription {
1.188 matthew 3275: my $file_description = $fd{lc(shift())};
3276: $file_description =~ s:([\[\]]):~$1:g;
3277: return &mt($file_description);
1.112 bowersj2 3278: }
3279:
3280: =pod
3281:
1.648 raeburn 3282: =item * &filedescriptionex()
1.112 bowersj2 3283:
3284: returns description for a specified file type with
3285: extra formatting
3286:
3287: =cut
3288:
3289: sub filedescriptionex {
3290: my $ex=shift;
1.188 matthew 3291: my $file_description = $fd{lc($ex)};
3292: $file_description =~ s:([\[\]]):~$1:g;
3293: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3294: }
3295:
3296: # End of .tab access
3297: =pod
3298:
3299: =back
3300:
3301: =cut
3302:
3303: # ------------------------------------------------------------------ File Types
3304: sub fileextensions {
3305: return sort(keys(%fe));
3306: }
3307:
1.97 www 3308: # ----------------------------------------------------------- Display Languages
3309: # returns a hash with all desired display languages
3310: #
3311:
3312: sub display_languages {
3313: my %languages=();
1.695 raeburn 3314: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3315: $languages{$lang}=1;
1.97 www 3316: }
3317: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3318: if ($env{'form.displaylanguage'}) {
1.356 albertel 3319: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3320: $languages{$lang}=1;
1.97 www 3321: }
3322: }
3323: return %languages;
1.14 harris41 3324: }
3325:
1.582 albertel 3326: sub languages {
3327: my ($possible_langs) = @_;
1.695 raeburn 3328: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3329: if (!ref($possible_langs)) {
3330: if( wantarray ) {
3331: return @preferred_langs;
3332: } else {
3333: return $preferred_langs[0];
3334: }
3335: }
3336: my %possibilities = map { $_ => 1 } (@$possible_langs);
3337: my @preferred_possibilities;
3338: foreach my $preferred_lang (@preferred_langs) {
3339: if (exists($possibilities{$preferred_lang})) {
3340: push(@preferred_possibilities, $preferred_lang);
3341: }
3342: }
3343: if( wantarray ) {
3344: return @preferred_possibilities;
3345: }
3346: return $preferred_possibilities[0];
3347: }
3348:
1.742 raeburn 3349: sub user_lang {
3350: my ($touname,$toudom,$fromcid) = @_;
3351: my @userlangs;
3352: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3353: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3354: $env{'course.'.$fromcid.'.languages'}));
3355: } else {
3356: my %langhash = &getlangs($touname,$toudom);
3357: if ($langhash{'languages'} ne '') {
3358: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3359: } else {
3360: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3361: if ($domdefs{'lang_def'} ne '') {
3362: @userlangs = ($domdefs{'lang_def'});
3363: }
3364: }
3365: }
3366: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3367: my $user_lh = Apache::localize->get_handle(@languages);
3368: return $user_lh;
3369: }
3370:
3371:
1.112 bowersj2 3372: ###############################################################
3373: ## Student Answer Attempts ##
3374: ###############################################################
3375:
3376: =pod
3377:
3378: =head1 Alternate Problem Views
3379:
3380: =over 4
3381:
1.648 raeburn 3382: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3383: $getattempt, $regexp, $gradesub)
3384:
3385: Return string with previous attempt on problem. Arguments:
3386:
3387: =over 4
3388:
3389: =item * $symb: Problem, including path
3390:
3391: =item * $username: username of the desired student
3392:
3393: =item * $domain: domain of the desired student
1.14 harris41 3394:
1.112 bowersj2 3395: =item * $course: Course ID
1.14 harris41 3396:
1.112 bowersj2 3397: =item * $getattempt: Leave blank for all attempts, otherwise put
3398: something
1.14 harris41 3399:
1.112 bowersj2 3400: =item * $regexp: if string matches this regexp, the string will be
3401: sent to $gradesub
1.14 harris41 3402:
1.112 bowersj2 3403: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3404:
1.112 bowersj2 3405: =back
1.14 harris41 3406:
1.112 bowersj2 3407: The output string is a table containing all desired attempts, if any.
1.16 harris41 3408:
1.112 bowersj2 3409: =cut
1.1 albertel 3410:
3411: sub get_previous_attempt {
1.43 ng 3412: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3413: my $prevattempts='';
1.43 ng 3414: no strict 'refs';
1.1 albertel 3415: if ($symb) {
1.3 albertel 3416: my (%returnhash)=
3417: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3418: if ($returnhash{'version'}) {
3419: my %lasthash=();
3420: my $version;
3421: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3422: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3423: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3424: }
1.1 albertel 3425: }
1.596 albertel 3426: $prevattempts=&start_data_table().&start_data_table_header_row();
3427: $prevattempts.='<th>'.&mt('History').'</th>';
1.948.2.8 raeburn 3428: my (%typeparts,%lasthidden);
1.945 raeburn 3429: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 3430: foreach my $key (sort(keys(%lasthash))) {
3431: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3432: if ($#parts > 0) {
1.31 albertel 3433: my $data=$parts[-1];
1.948.2.15 raeburn 3434: next if ($data eq 'foilorder');
1.31 albertel 3435: pop(@parts);
1.945 raeburn 3436: if ($data eq 'type') {
3437: unless ($showsurv) {
3438: my $id = join(',',@parts);
3439: $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.948.2.8 raeburn 3440: if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
3441: $lasthidden{$ign.'.'.$id} = 1;
3442: }
1.945 raeburn 3443: }
3444: delete($lasthash{$key});
3445: } else {
3446: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
3447: }
1.31 albertel 3448: } else {
1.41 ng 3449: if ($#parts == 0) {
3450: $prevattempts.='<th>'.$parts[0].'</th>';
3451: } else {
3452: $prevattempts.='<th>'.$ign.'</th>';
3453: }
1.31 albertel 3454: }
1.16 harris41 3455: }
1.596 albertel 3456: $prevattempts.=&end_data_table_header_row();
1.40 ng 3457: if ($getattempt eq '') {
3458: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.945 raeburn 3459: my @hidden;
3460: if (%typeparts) {
3461: foreach my $id (keys(%typeparts)) {
3462: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
3463: push(@hidden,$id);
3464: }
3465: }
3466: }
3467: $prevattempts.=&start_data_table_row().
3468: '<td>'.&mt('Transaction [_1]',$version).'</td>';
3469: if (@hidden) {
3470: foreach my $key (sort(keys(%lasthash))) {
1.948.2.15 raeburn 3471: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3472: my $hide;
3473: foreach my $id (@hidden) {
3474: if ($key =~ /^\Q$id\E/) {
3475: $hide = 1;
3476: last;
3477: }
3478: }
3479: if ($hide) {
3480: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3481: if (($data eq 'award') || ($data eq 'awarddetail')) {
3482: my $value = &format_previous_attempt_value($key,
3483: $returnhash{$version.':'.$key});
3484: $prevattempts.='<td>'.$value.' </td>';
3485: } else {
3486: $prevattempts.='<td> </td>';
3487: }
3488: } else {
3489: if ($key =~ /\./) {
3490: my $value = &format_previous_attempt_value($key,
3491: $returnhash{$version.':'.$key});
3492: $prevattempts.='<td>'.$value.' </td>';
3493: } else {
3494: $prevattempts.='<td> </td>';
3495: }
3496: }
3497: }
3498: } else {
3499: foreach my $key (sort(keys(%lasthash))) {
1.948.2.15 raeburn 3500: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3501: my $value = &format_previous_attempt_value($key,
3502: $returnhash{$version.':'.$key});
3503: $prevattempts.='<td>'.$value.' </td>';
3504: }
3505: }
3506: $prevattempts.=&end_data_table_row();
1.40 ng 3507: }
1.1 albertel 3508: }
1.945 raeburn 3509: my @currhidden = keys(%lasthidden);
1.596 albertel 3510: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3511: foreach my $key (sort(keys(%lasthash))) {
1.948.2.15 raeburn 3512: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3513: if (%typeparts) {
3514: my $hidden;
3515: foreach my $id (@currhidden) {
3516: if ($key =~ /^\Q$id\E/) {
3517: $hidden = 1;
3518: last;
3519: }
3520: }
3521: if ($hidden) {
3522: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3523: if (($data eq 'award') || ($data eq 'awarddetail')) {
3524: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3525: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3526: $value = &$gradesub($value);
3527: }
3528: $prevattempts.='<td>'.$value.' </td>';
3529: } else {
3530: $prevattempts.='<td> </td>';
3531: }
3532: } else {
3533: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3534: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3535: $value = &$gradesub($value);
3536: }
3537: $prevattempts.='<td>'.$value.' </td>';
3538: }
3539: } else {
3540: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3541: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3542: $value = &$gradesub($value);
3543: }
3544: $prevattempts.='<td>'.$value.' </td>';
3545: }
1.16 harris41 3546: }
1.596 albertel 3547: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3548: } else {
1.596 albertel 3549: $prevattempts=
3550: &start_data_table().&start_data_table_row().
3551: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3552: &end_data_table_row().&end_data_table();
1.1 albertel 3553: }
3554: } else {
1.596 albertel 3555: $prevattempts=
3556: &start_data_table().&start_data_table_row().
3557: '<td>'.&mt('No data.').'</td>'.
3558: &end_data_table_row().&end_data_table();
1.1 albertel 3559: }
1.10 albertel 3560: }
3561:
1.581 albertel 3562: sub format_previous_attempt_value {
3563: my ($key,$value) = @_;
3564: if ($key =~ /timestamp/) {
3565: $value = &Apache::lonlocal::locallocaltime($value);
3566: } elsif (ref($value) eq 'ARRAY') {
3567: $value = '('.join(', ', @{ $value }).')';
1.948.2.14 raeburn 3568: } elsif ($key =~ /answerstring$/) {
3569: my %answers = &Apache::lonnet::str2hash($value);
3570: my @anskeys = sort(keys(%answers));
3571: if (@anskeys == 1) {
3572: my $answer = $answers{$anskeys[0]};
3573: if ($answer =~ m{\Q\0\E}) {
3574: $answer =~ s{\Q\0\E}{, }g;
3575: }
3576: my $tag_internal_answer_name = 'INTERNAL';
3577: if ($anskeys[0] eq $tag_internal_answer_name) {
3578: $value = $answer;
3579: } else {
3580: $value = $anskeys[0].'='.$answer;
3581: }
3582: } else {
3583: foreach my $ans (@anskeys) {
3584: my $answer = $answers{$ans};
3585: if ($answer =~ m{\Q\0\E}) {
3586: $answer =~ s{\Q\0\E}{, }g;
3587: }
3588: $value .= $ans.'='.$answer.'<br />';;
3589: }
3590: }
1.581 albertel 3591: } else {
3592: $value = &unescape($value);
3593: }
3594: return $value;
3595: }
3596:
3597:
1.107 albertel 3598: sub relative_to_absolute {
3599: my ($url,$output)=@_;
3600: my $parser=HTML::TokeParser->new(\$output);
3601: my $token;
3602: my $thisdir=$url;
3603: my @rlinks=();
3604: while ($token=$parser->get_token) {
3605: if ($token->[0] eq 'S') {
3606: if ($token->[1] eq 'a') {
3607: if ($token->[2]->{'href'}) {
3608: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3609: }
3610: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3611: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3612: } elsif ($token->[1] eq 'base') {
3613: $thisdir=$token->[2]->{'href'};
3614: }
3615: }
3616: }
3617: $thisdir=~s-/[^/]*$--;
1.356 albertel 3618: foreach my $link (@rlinks) {
1.726 raeburn 3619: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3620: ($link=~/^\//) ||
3621: ($link=~/^javascript:/i) ||
3622: ($link=~/^mailto:/i) ||
3623: ($link=~/^\#/)) {
3624: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3625: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3626: }
3627: }
3628: # -------------------------------------------------- Deal with Applet codebases
3629: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3630: return $output;
3631: }
3632:
1.112 bowersj2 3633: =pod
3634:
1.648 raeburn 3635: =item * &get_student_view()
1.112 bowersj2 3636:
3637: show a snapshot of what student was looking at
3638:
3639: =cut
3640:
1.10 albertel 3641: sub get_student_view {
1.186 albertel 3642: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3643: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3644: my (%form);
1.10 albertel 3645: my @elements=('symb','courseid','domain','username');
3646: foreach my $element (@elements) {
1.186 albertel 3647: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3648: }
1.186 albertel 3649: if (defined($moreenv)) {
3650: %form=(%form,%{$moreenv});
3651: }
1.236 albertel 3652: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3653: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3654: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3655: $userview=~s/\<body[^\>]*\>//gi;
3656: $userview=~s/\<\/body\>//gi;
3657: $userview=~s/\<html\>//gi;
3658: $userview=~s/\<\/html\>//gi;
3659: $userview=~s/\<head\>//gi;
3660: $userview=~s/\<\/head\>//gi;
3661: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3662: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3663: if (wantarray) {
3664: return ($userview,$response);
3665: } else {
3666: return $userview;
3667: }
3668: }
3669:
3670: sub get_student_view_with_retries {
3671: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3672:
3673: my $ok = 0; # True if we got a good response.
3674: my $content;
3675: my $response;
3676:
3677: # Try to get the student_view done. within the retries count:
3678:
3679: do {
3680: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3681: $ok = $response->is_success;
3682: if (!$ok) {
3683: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3684: }
3685: $retries--;
3686: } while (!$ok && ($retries > 0));
3687:
3688: if (!$ok) {
3689: $content = ''; # On error return an empty content.
3690: }
1.651 www 3691: if (wantarray) {
3692: return ($content, $response);
3693: } else {
3694: return $content;
3695: }
1.11 albertel 3696: }
3697:
1.112 bowersj2 3698: =pod
3699:
1.648 raeburn 3700: =item * &get_student_answers()
1.112 bowersj2 3701:
3702: show a snapshot of how student was answering problem
3703:
3704: =cut
3705:
1.11 albertel 3706: sub get_student_answers {
1.100 sakharuk 3707: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3708: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3709: my (%moreenv);
1.11 albertel 3710: my @elements=('symb','courseid','domain','username');
3711: foreach my $element (@elements) {
1.186 albertel 3712: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3713: }
1.186 albertel 3714: $moreenv{'grade_target'}='answer';
3715: %moreenv=(%form,%moreenv);
1.497 raeburn 3716: $feedurl = &Apache::lonnet::clutter($feedurl);
3717: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3718: return $userview;
1.1 albertel 3719: }
1.116 albertel 3720:
3721: =pod
3722:
3723: =item * &submlink()
3724:
1.242 albertel 3725: Inputs: $text $uname $udom $symb $target
1.116 albertel 3726:
3727: Returns: A link to grades.pm such as to see the SUBM view of a student
3728:
3729: =cut
3730:
3731: ###############################################
3732: sub submlink {
1.242 albertel 3733: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3734: if (!($uname && $udom)) {
3735: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3736: &Apache::lonnet::whichuser($symb);
1.116 albertel 3737: if (!$symb) { $symb=$cursymb; }
3738: }
1.254 matthew 3739: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3740: $symb=&escape($symb);
1.948.2.4 raeburn 3741: if ($target) { $target=" target=\"$target\""; }
3742: return
3743: '<a href="/adm/grades?command=submission'.
3744: '&symb='.$symb.
3745: '&student='.$uname.
3746: '&userdom='.$udom.'"'.
3747: $target.'>'.$text.'</a>';
1.242 albertel 3748: }
3749: ##############################################
3750:
3751: =pod
3752:
3753: =item * &pgrdlink()
3754:
3755: Inputs: $text $uname $udom $symb $target
3756:
3757: Returns: A link to grades.pm such as to see the PGRD view of a student
3758:
3759: =cut
3760:
3761: ###############################################
3762: sub pgrdlink {
3763: my $link=&submlink(@_);
3764: $link=~s/(&command=submission)/$1&showgrading=yes/;
3765: return $link;
3766: }
3767: ##############################################
3768:
3769: =pod
3770:
3771: =item * &pprmlink()
3772:
3773: Inputs: $text $uname $udom $symb $target
3774:
3775: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3776: student and a specific resource
1.242 albertel 3777:
3778: =cut
3779:
3780: ###############################################
3781: sub pprmlink {
3782: my ($text,$uname,$udom,$symb,$target)=@_;
3783: if (!($uname && $udom)) {
3784: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3785: &Apache::lonnet::whichuser($symb);
1.242 albertel 3786: if (!$symb) { $symb=$cursymb; }
3787: }
1.254 matthew 3788: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3789: $symb=&escape($symb);
1.242 albertel 3790: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3791: return '<a href="/adm/parmset?command=set&'.
3792: 'symb='.$symb.'&uname='.$uname.
3793: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3794: }
3795: ##############################################
1.37 matthew 3796:
1.112 bowersj2 3797: =pod
3798:
3799: =back
3800:
3801: =cut
3802:
1.37 matthew 3803: ###############################################
1.51 www 3804:
3805:
3806: sub timehash {
1.687 raeburn 3807: my ($thistime) = @_;
3808: my $timezone = &Apache::lonlocal::gettimezone();
3809: my $dt = DateTime->from_epoch(epoch => $thistime)
3810: ->set_time_zone($timezone);
3811: my $wday = $dt->day_of_week();
3812: if ($wday == 7) { $wday = 0; }
3813: return ( 'second' => $dt->second(),
3814: 'minute' => $dt->minute(),
3815: 'hour' => $dt->hour(),
3816: 'day' => $dt->day_of_month(),
3817: 'month' => $dt->month(),
3818: 'year' => $dt->year(),
3819: 'weekday' => $wday,
3820: 'dayyear' => $dt->day_of_year(),
3821: 'dlsav' => $dt->is_dst() );
1.51 www 3822: }
3823:
1.370 www 3824: sub utc_string {
3825: my ($date)=@_;
1.371 www 3826: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3827: }
3828:
1.51 www 3829: sub maketime {
3830: my %th=@_;
1.687 raeburn 3831: my ($epoch_time,$timezone,$dt);
3832: $timezone = &Apache::lonlocal::gettimezone();
3833: eval {
3834: $dt = DateTime->new( year => $th{'year'},
3835: month => $th{'month'},
3836: day => $th{'day'},
3837: hour => $th{'hour'},
3838: minute => $th{'minute'},
3839: second => $th{'second'},
3840: time_zone => $timezone,
3841: );
3842: };
3843: if (!$@) {
3844: $epoch_time = $dt->epoch;
3845: if ($epoch_time) {
3846: return $epoch_time;
3847: }
3848: }
1.51 www 3849: return POSIX::mktime(
3850: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3851: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3852: }
3853:
3854: #########################################
1.51 www 3855:
3856: sub findallcourses {
1.482 raeburn 3857: my ($roles,$uname,$udom) = @_;
1.355 albertel 3858: my %roles;
3859: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3860: my %courses;
1.51 www 3861: my $now=time;
1.482 raeburn 3862: if (!defined($uname)) {
3863: $uname = $env{'user.name'};
3864: }
3865: if (!defined($udom)) {
3866: $udom = $env{'user.domain'};
3867: }
3868: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.948.2.11 raeburn 3869: my $extra = &Apache::lonnet::freeze_escape({'skipcheck' => 1});
3870: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname,'.',undef,
3871: $extra);
1.482 raeburn 3872: if (!%roles) {
3873: %roles = (
3874: cc => 1,
1.907 raeburn 3875: co => 1,
1.482 raeburn 3876: in => 1,
3877: ep => 1,
3878: ta => 1,
3879: cr => 1,
3880: st => 1,
3881: );
3882: }
3883: foreach my $entry (keys(%roleshash)) {
3884: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3885: if ($trole =~ /^cr/) {
3886: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3887: } else {
3888: next if (!exists($roles{$trole}));
3889: }
3890: if ($tend) {
3891: next if ($tend < $now);
3892: }
3893: if ($tstart) {
3894: next if ($tstart > $now);
3895: }
3896: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3897: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3898: if ($secpart eq '') {
3899: ($cnum,$role) = split(/_/,$cnumpart);
3900: $sec = 'none';
3901: $realsec = '';
3902: } else {
3903: $cnum = $cnumpart;
3904: ($sec,$role) = split(/_/,$secpart);
3905: $realsec = $sec;
1.490 raeburn 3906: }
1.482 raeburn 3907: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3908: }
3909: } else {
3910: foreach my $key (keys(%env)) {
1.483 albertel 3911: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3912: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3913: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3914: next if ($role eq 'ca' || $role eq 'aa');
3915: next if (%roles && !exists($roles{$role}));
3916: my ($starttime,$endtime)=split(/\./,$env{$key});
3917: my $active=1;
3918: if ($starttime) {
3919: if ($now<$starttime) { $active=0; }
3920: }
3921: if ($endtime) {
3922: if ($now>$endtime) { $active=0; }
3923: }
3924: if ($active) {
3925: if ($sec eq '') {
3926: $sec = 'none';
3927: }
3928: $courses{$cdom.'_'.$cnum}{$sec} =
3929: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 3930: }
3931: }
1.51 www 3932: }
3933: }
1.474 raeburn 3934: return %courses;
1.51 www 3935: }
1.37 matthew 3936:
1.54 www 3937: ###############################################
1.474 raeburn 3938:
3939: sub blockcheck {
1.482 raeburn 3940: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 3941:
3942: if (!defined($udom)) {
3943: $udom = $env{'user.domain'};
3944: }
3945: if (!defined($uname)) {
3946: $uname = $env{'user.name'};
3947: }
3948:
3949: # If uname and udom are for a course, check for blocks in the course.
3950:
3951: if (&Apache::lonnet::is_course($udom,$uname)) {
3952: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 3953: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 3954: return ($startblock,$endblock);
3955: }
1.474 raeburn 3956:
1.502 raeburn 3957: my $startblock = 0;
3958: my $endblock = 0;
1.482 raeburn 3959: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 3960:
1.490 raeburn 3961: # If uname is for a user, and activity is course-specific, i.e.,
3962: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3963:
1.490 raeburn 3964: if (($activity eq 'boards' || $activity eq 'chat' ||
3965: $activity eq 'groups') && ($env{'request.course.id'})) {
3966: foreach my $key (keys(%live_courses)) {
3967: if ($key ne $env{'request.course.id'}) {
3968: delete($live_courses{$key});
3969: }
3970: }
3971: }
3972:
3973: my $otheruser = 0;
3974: my %own_courses;
3975: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3976: # Resource belongs to user other than current user.
3977: $otheruser = 1;
3978: # Gather courses for current user
3979: %own_courses =
3980: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3981: }
3982:
3983: # Gather active course roles - course coordinator, instructor,
3984: # exam proctor, ta, student, or custom role.
1.474 raeburn 3985:
3986: foreach my $course (keys(%live_courses)) {
1.482 raeburn 3987: my ($cdom,$cnum);
3988: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3989: $cdom = $env{'course.'.$course.'.domain'};
3990: $cnum = $env{'course.'.$course.'.num'};
3991: } else {
1.490 raeburn 3992: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 3993: }
3994: my $no_ownblock = 0;
3995: my $no_userblock = 0;
1.533 raeburn 3996: if ($otheruser && $activity ne 'com') {
1.490 raeburn 3997: # Check if current user has 'evb' priv for this
3998: if (defined($own_courses{$course})) {
3999: foreach my $sec (keys(%{$own_courses{$course}})) {
4000: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
4001: if ($sec ne 'none') {
4002: $checkrole .= '/'.$sec;
4003: }
4004: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4005: $no_ownblock = 1;
4006: last;
4007: }
4008: }
4009: }
4010: # if they have 'evb' priv and are currently not playing student
4011: next if (($no_ownblock) &&
4012: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
4013: }
1.474 raeburn 4014: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 4015: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 4016: if ($sec ne 'none') {
1.482 raeburn 4017: $checkrole .= '/'.$sec;
1.474 raeburn 4018: }
1.490 raeburn 4019: if ($otheruser) {
4020: # Resource belongs to user other than current user.
4021: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 4022: my ($trole,$tdom,$tnum,$tsec);
4023: my $entry = $live_courses{$course}{$sec};
4024: if ($entry =~ /^cr/) {
4025: ($trole,$tdom,$tnum,$tsec) =
4026: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
4027: } else {
4028: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
4029: }
4030: my ($spec,$area,$trest,%allroles,%userroles);
4031: $area = '/'.$tdom.'/'.$tnum;
4032: $trest = $tnum;
4033: if ($tsec ne '') {
4034: $area .= '/'.$tsec;
4035: $trest .= '/'.$tsec;
4036: }
4037: $spec = $trole.'.'.$area;
4038: if ($trole =~ /^cr/) {
4039: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
4040: $tdom,$spec,$trest,$area);
4041: } else {
4042: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
4043: $tdom,$spec,$trest,$area);
4044: }
4045: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 4046: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
4047: if ($1) {
4048: $no_userblock = 1;
4049: last;
4050: }
4051: }
1.490 raeburn 4052: } else {
4053: # Resource belongs to current user
4054: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 4055: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4056: $no_ownblock = 1;
4057: last;
4058: }
1.474 raeburn 4059: }
4060: }
4061: # if they have the evb priv and are currently not playing student
1.482 raeburn 4062: next if (($no_ownblock) &&
1.491 albertel 4063: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 4064: next if ($no_userblock);
1.474 raeburn 4065:
1.866 kalberla 4066: # Retrieve blocking times and identity of locker for course
1.490 raeburn 4067: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 4068:
4069: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
4070: if (($start != 0) &&
4071: (($startblock == 0) || ($startblock > $start))) {
4072: $startblock = $start;
4073: }
4074: if (($end != 0) &&
4075: (($endblock == 0) || ($endblock < $end))) {
4076: $endblock = $end;
4077: }
1.490 raeburn 4078: }
4079: return ($startblock,$endblock);
4080: }
4081:
4082: sub get_blocks {
4083: my ($setters,$activity,$cdom,$cnum) = @_;
4084: my $startblock = 0;
4085: my $endblock = 0;
4086: my $course = $cdom.'_'.$cnum;
4087: $setters->{$course} = {};
4088: $setters->{$course}{'staff'} = [];
4089: $setters->{$course}{'times'} = [];
4090: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
4091: foreach my $record (keys(%records)) {
4092: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
4093: if ($start <= time && $end >= time) {
4094: my ($staff_name,$staff_dom,$title,$blocks) =
4095: &parse_block_record($records{$record});
4096: if ($blocks->{$activity} eq 'on') {
4097: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
4098: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 4099: if ( ($startblock == 0) || ($startblock > $start) ) {
4100: $startblock = $start;
1.490 raeburn 4101: }
1.491 albertel 4102: if ( ($endblock == 0) || ($endblock < $end) ) {
4103: $endblock = $end;
1.474 raeburn 4104: }
4105: }
4106: }
4107: }
4108: return ($startblock,$endblock);
4109: }
4110:
4111: sub parse_block_record {
4112: my ($record) = @_;
4113: my ($setuname,$setudom,$title,$blocks);
4114: if (ref($record) eq 'HASH') {
4115: ($setuname,$setudom) = split(/:/,$record->{'setter'});
4116: $title = &unescape($record->{'event'});
4117: $blocks = $record->{'blocks'};
4118: } else {
4119: my @data = split(/:/,$record,3);
4120: if (scalar(@data) eq 2) {
4121: $title = $data[1];
4122: ($setuname,$setudom) = split(/@/,$data[0]);
4123: } else {
4124: ($setuname,$setudom,$title) = @data;
4125: }
4126: $blocks = { 'com' => 'on' };
4127: }
4128: return ($setuname,$setudom,$title,$blocks);
4129: }
4130:
1.854 kalberla 4131: sub blocking_status {
4132: my ($activity,$uname,$udom) = @_;
1.867 kalberla 4133: my %setters;
1.890 droeschl 4134:
4135: # check for active blocking
1.867 kalberla 4136: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
1.854 kalberla 4137:
1.890 droeschl 4138: my $blocked = $startblock && $endblock ? 1 : 0;
4139:
4140: # caller just wants to know whether a block is active
4141: if (!wantarray) { return $blocked; }
4142:
4143: # build a link to a popup window containing the details
4144: my $querystring = "?activity=$activity";
4145: # $uname and $udom decide whose portfolio the user is trying to look at
4146: $querystring .= "&udom=$udom" if $udom;
4147: $querystring .= "&uname=$uname" if $uname;
4148:
4149: my $output .= <<'END_MYBLOCK';
1.854 kalberla 4150: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
4151: var options = "width=" + w + ",height=" + h + ",";
4152: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
4153: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
4154: var newWin = window.open(url, wdwName, options);
4155: newWin.focus();
4156: }
1.890 droeschl 4157: END_MYBLOCK
1.854 kalberla 4158:
1.890 droeschl 4159: $output = Apache::lonhtmlcommon::scripttag($output);
4160:
1.854 kalberla 4161: my $popupUrl = "/adm/blockingstatus/$querystring";
1.890 droeschl 4162: my $text = mt('Communication Blocked');
4163:
1.867 kalberla 4164: $output .= <<"END_BLOCK";
4165: <div class='LC_comblock'>
1.869 kalberla 4166: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4167: title='$text'>
4168: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 4169: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4170: title='$text'>$text</a>
1.867 kalberla 4171: </div>
4172:
4173: END_BLOCK
1.474 raeburn 4174:
1.854 kalberla 4175: return ($blocked, $output);
4176: }
1.490 raeburn 4177:
1.60 matthew 4178: ###############################################
4179:
1.682 raeburn 4180: sub check_ip_acc {
4181: my ($acc)=@_;
4182: &Apache::lonxml::debug("acc is $acc");
4183: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
4184: return 1;
4185: }
4186: my $allowed=0;
4187: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
4188:
4189: my $name;
4190: foreach my $pattern (split(',',$acc)) {
4191: $pattern =~ s/^\s*//;
4192: $pattern =~ s/\s*$//;
4193: if ($pattern =~ /\*$/) {
4194: #35.8.*
4195: $pattern=~s/\*//;
4196: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4197: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
4198: #35.8.3.[34-56]
4199: my $low=$2;
4200: my $high=$3;
4201: $pattern=$1;
4202: if ($ip =~ /^\Q$pattern\E/) {
4203: my $last=(split(/\./,$ip))[3];
4204: if ($last <=$high && $last >=$low) { $allowed=1; }
4205: }
4206: } elsif ($pattern =~ /^\*/) {
4207: #*.msu.edu
4208: $pattern=~s/\*//;
4209: if (!defined($name)) {
4210: use Socket;
4211: my $netaddr=inet_aton($ip);
4212: ($name)=gethostbyaddr($netaddr,AF_INET);
4213: }
4214: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4215: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
4216: #127.0.0.1
4217: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4218: } else {
4219: #some.name.com
4220: if (!defined($name)) {
4221: use Socket;
4222: my $netaddr=inet_aton($ip);
4223: ($name)=gethostbyaddr($netaddr,AF_INET);
4224: }
4225: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4226: }
4227: if ($allowed) { last; }
4228: }
4229: return $allowed;
4230: }
4231:
4232: ###############################################
4233:
1.60 matthew 4234: =pod
4235:
1.112 bowersj2 4236: =head1 Domain Template Functions
4237:
4238: =over 4
4239:
4240: =item * &determinedomain()
1.60 matthew 4241:
4242: Inputs: $domain (usually will be undef)
4243:
1.63 www 4244: Returns: Determines which domain should be used for designs
1.60 matthew 4245:
4246: =cut
1.54 www 4247:
1.60 matthew 4248: ###############################################
1.63 www 4249: sub determinedomain {
4250: my $domain=shift;
1.531 albertel 4251: if (! $domain) {
1.60 matthew 4252: # Determine domain if we have not been given one
1.893 raeburn 4253: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 4254: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
4255: if ($env{'request.role.domain'}) {
4256: $domain=$env{'request.role.domain'};
1.60 matthew 4257: }
4258: }
1.63 www 4259: return $domain;
4260: }
4261: ###############################################
1.517 raeburn 4262:
1.518 albertel 4263: sub devalidate_domconfig_cache {
4264: my ($udom)=@_;
4265: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
4266: }
4267:
4268: # ---------------------- Get domain configuration for a domain
4269: sub get_domainconf {
4270: my ($udom) = @_;
4271: my $cachetime=1800;
4272: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
4273: if (defined($cached)) { return %{$result}; }
4274:
4275: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 4276: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 4277: my (%designhash,%legacy);
1.518 albertel 4278: if (keys(%domconfig) > 0) {
4279: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 4280: if (keys(%{$domconfig{'login'}})) {
4281: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 4282: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.946 raeburn 4283: if ($key eq 'loginvia') {
4284: if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') {
4285: my @ids = &Apache::lonnet::current_machine_ids();
4286: foreach my $hostname (@ids) {
1.948 raeburn 4287: if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') {
4288: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
4289: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
4290: $designhash{$udom.'.login.loginvia'} = $server;
4291: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
4292:
4293: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
4294: } else {
4295: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
4296: }
4297: if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) {
4298: $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'};
4299: }
1.946 raeburn 4300: }
4301: }
4302: }
4303: }
4304: } else {
4305: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
4306: $designhash{$udom.'.login.'.$key.'_'.$img} =
4307: $domconfig{'login'}{$key}{$img};
4308: }
1.699 raeburn 4309: }
4310: } else {
4311: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
4312: }
1.632 raeburn 4313: }
4314: } else {
4315: $legacy{'login'} = 1;
1.518 albertel 4316: }
1.632 raeburn 4317: } else {
4318: $legacy{'login'} = 1;
1.518 albertel 4319: }
4320: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 4321: if (keys(%{$domconfig{'rolecolors'}})) {
4322: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
4323: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
4324: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
4325: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
4326: }
1.518 albertel 4327: }
4328: }
1.632 raeburn 4329: } else {
4330: $legacy{'rolecolors'} = 1;
1.518 albertel 4331: }
1.632 raeburn 4332: } else {
4333: $legacy{'rolecolors'} = 1;
1.518 albertel 4334: }
1.948 raeburn 4335: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
4336: if ($domconfig{'autoenroll'}{'co-owners'}) {
4337: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
4338: }
4339: }
1.632 raeburn 4340: if (keys(%legacy) > 0) {
4341: my %legacyhash = &get_legacy_domconf($udom);
4342: foreach my $item (keys(%legacyhash)) {
4343: if ($item =~ /^\Q$udom\E\.login/) {
4344: if ($legacy{'login'}) {
4345: $designhash{$item} = $legacyhash{$item};
4346: }
4347: } else {
4348: if ($legacy{'rolecolors'}) {
4349: $designhash{$item} = $legacyhash{$item};
4350: }
1.518 albertel 4351: }
4352: }
4353: }
1.632 raeburn 4354: } else {
4355: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4356: }
4357: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4358: $cachetime);
4359: return %designhash;
4360: }
4361:
1.632 raeburn 4362: sub get_legacy_domconf {
4363: my ($udom) = @_;
4364: my %legacyhash;
4365: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4366: my $designfile = $designdir.'/'.$udom.'.tab';
4367: if (-e $designfile) {
4368: if ( open (my $fh,"<$designfile") ) {
4369: while (my $line = <$fh>) {
4370: next if ($line =~ /^\#/);
4371: chomp($line);
4372: my ($key,$val)=(split(/\=/,$line));
4373: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4374: }
4375: close($fh);
4376: }
4377: }
4378: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
4379: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4380: }
4381: return %legacyhash;
4382: }
4383:
1.63 www 4384: =pod
4385:
1.112 bowersj2 4386: =item * &domainlogo()
1.63 www 4387:
4388: Inputs: $domain (usually will be undef)
4389:
4390: Returns: A link to a domain logo, if the domain logo exists.
4391: If the domain logo does not exist, a description of the domain.
4392:
4393: =cut
1.112 bowersj2 4394:
1.63 www 4395: ###############################################
4396: sub domainlogo {
1.517 raeburn 4397: my $domain = &determinedomain(shift);
1.518 albertel 4398: my %designhash = &get_domainconf($domain);
1.517 raeburn 4399: # See if there is a logo
4400: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4401: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4402: if ($imgsrc =~ m{^/(adm|res)/}) {
4403: if ($imgsrc =~ m{^/res/}) {
4404: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4405: &Apache::lonnet::repcopy($local_name);
4406: }
4407: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4408: }
4409: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4410: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4411: return &Apache::lonnet::domain($domain,'description');
1.59 www 4412: } else {
1.60 matthew 4413: return '';
1.59 www 4414: }
4415: }
1.63 www 4416: ##############################################
4417:
4418: =pod
4419:
1.112 bowersj2 4420: =item * &designparm()
1.63 www 4421:
4422: Inputs: $which parameter; $domain (usually will be undef)
4423:
4424: Returns: value of designparamter $which
4425:
4426: =cut
1.112 bowersj2 4427:
1.397 albertel 4428:
1.400 albertel 4429: ##############################################
1.397 albertel 4430: sub designparm {
4431: my ($which,$domain)=@_;
4432: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 4433: return $env{'environment.color.'.$which};
1.96 www 4434: }
1.63 www 4435: $domain=&determinedomain($domain);
1.518 albertel 4436: my %domdesign = &get_domainconf($domain);
1.520 raeburn 4437: my $output;
1.517 raeburn 4438: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 4439: $output = $domdesign{$domain.'.'.$which};
1.63 www 4440: } else {
1.520 raeburn 4441: $output = $defaultdesign{$which};
4442: }
4443: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4444: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4445: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 4446: if ($output =~ m{^/res/}) {
4447: my $local_name = &Apache::lonnet::filelocation('',$output);
4448: &Apache::lonnet::repcopy($local_name);
4449: }
1.520 raeburn 4450: $output = &lonhttpdurl($output);
4451: }
1.63 www 4452: }
1.520 raeburn 4453: return $output;
1.63 www 4454: }
1.59 www 4455:
1.822 bisitz 4456: ##############################################
4457: =pod
4458:
1.832 bisitz 4459: =item * &authorspace()
4460:
4461: Inputs: ./.
4462:
4463: Returns: Path to the Construction Space of the current user's
4464: accessed author space
4465: The author space will be that of the current user
4466: when accessing the own author space
4467: and that of the co-author/assistent co-author
4468: when accessing the co-author's/assistent co-author's
4469: space
4470:
4471: =cut
4472:
4473: sub authorspace {
4474: my $caname = '';
4475: if ($env{'request.role'} =~ /^ca|^aa/) {
4476: (undef,$caname) =
4477: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
4478: } else {
4479: $caname = $env{'user.name'};
4480: }
4481: return '/priv/'.$caname.'/';
4482: }
4483:
4484: ##############################################
4485: =pod
4486:
1.822 bisitz 4487: =item * &head_subbox()
4488:
4489: Inputs: $content (contains HTML code with page functions, etc.)
4490:
4491: Returns: HTML div with $content
4492: To be included in page header
4493:
4494: =cut
4495:
4496: sub head_subbox {
4497: my ($content)=@_;
4498: my $output =
1.948.2.22 raeburn 4499: '<div class="LC_head_subbox">'
1.822 bisitz 4500: .$content
4501: .'</div>'
4502: }
4503:
4504: ##############################################
4505: =pod
4506:
4507: =item * &CSTR_pageheader()
4508:
4509: Inputs: ./.
4510:
4511: Returns: HTML div with CSTR path and recent box
4512: To be included on Construction Space pages
4513:
4514: =cut
4515:
4516: sub CSTR_pageheader {
4517: # this is for resources; directories have customtitle, and crumbs
4518: # and select recent are created in lonpubdir.pm
4519: my ($uname,$thisdisfn)=
4520: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
4521: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4522: $formaction=~s/\/+/\//g;
4523:
4524: my $parentpath = '';
4525: my $lastitem = '';
4526: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4527: $parentpath = $1;
4528: $lastitem = $2;
4529: } else {
4530: $lastitem = $thisdisfn;
4531: }
1.921 bisitz 4532:
4533: my $output =
1.822 bisitz 4534: '<div>'
4535: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
4536: .'<b>'.&mt('Construction Space:').'</b> '
4537: .'<form name="dirs" method="post" action="'.$formaction
1.921 bisitz 4538: .'" target="_top">' #FIXME lonpubdir: target="_parent"
4539: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv',undef,undef);
4540:
4541: if ($lastitem) {
4542: $output .=
4543: '<span class="LC_filename">'
4544: .$lastitem
4545: .'</span>';
4546: }
4547: $output .=
4548: '<br />'
1.822 bisitz 4549: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
4550: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4551: .'</form>'
4552: .&Apache::lonmenu::constspaceform()
4553: .'</div>';
1.921 bisitz 4554:
4555: return $output;
1.822 bisitz 4556: }
4557:
1.60 matthew 4558: ###############################################
4559: ###############################################
4560:
4561: =pod
4562:
1.112 bowersj2 4563: =back
4564:
1.549 albertel 4565: =head1 HTML Helpers
1.112 bowersj2 4566:
4567: =over 4
4568:
4569: =item * &bodytag()
1.60 matthew 4570:
4571: Returns a uniform header for LON-CAPA web pages.
4572:
4573: Inputs:
4574:
1.112 bowersj2 4575: =over 4
4576:
4577: =item * $title, A title to be displayed on the page.
4578:
4579: =item * $function, the current role (can be undef).
4580:
4581: =item * $addentries, extra parameters for the <body> tag.
4582:
4583: =item * $bodyonly, if defined, only return the <body> tag.
4584:
4585: =item * $domain, if defined, force a given domain.
4586:
4587: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4588: text interface only)
1.60 matthew 4589:
1.814 bisitz 4590: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
4591: navigational links
1.317 albertel 4592:
1.338 albertel 4593: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4594:
1.361 albertel 4595: =item * $no_inline_link, if true and in remote mode, don't show the
4596: 'Switch To Inline Menu' link
4597:
1.460 albertel 4598: =item * $args, optional argument valid values are
4599: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4600: inherit_jsmath -> when creating popup window in a page,
4601: should it have jsmath forced on by the
4602: current page
1.460 albertel 4603:
1.112 bowersj2 4604: =back
4605:
1.60 matthew 4606: Returns: A uniform header for LON-CAPA web pages.
4607: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4608: If $bodyonly is undef or zero, an html string containing a <body> tag and
4609: other decorations will be returned.
4610:
4611: =cut
4612:
1.54 www 4613: sub bodytag {
1.831 bisitz 4614: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.816 bisitz 4615: $no_nav_bar,$bgcolor,$no_inline_link,$args)=@_;
1.339 albertel 4616:
1.948.2.2 raeburn 4617: my $public;
4618: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
4619: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
4620: $public = 1;
4621: }
1.460 albertel 4622: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4623:
1.183 matthew 4624: $function = &get_users_function() if (!$function);
1.339 albertel 4625: my $img = &designparm($function.'.img',$domain);
4626: my $font = &designparm($function.'.font',$domain);
4627: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4628:
1.803 bisitz 4629: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 4630: 'bgcolor' => $pgbg,
1.339 albertel 4631: 'text' => $font,
4632: 'alink' => &designparm($function.'.alink',$domain),
4633: 'vlink' => &designparm($function.'.vlink',$domain),
4634: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4635: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4636:
1.63 www 4637: # role and realm
1.378 raeburn 4638: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4639: if ($role eq 'ca') {
1.479 albertel 4640: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4641: $realm = &plainname($rname,$rdom);
1.378 raeburn 4642: }
1.55 www 4643: # realm
1.258 albertel 4644: if ($env{'request.course.id'}) {
1.378 raeburn 4645: if ($env{'request.role'} !~ /^cr/) {
4646: $role = &Apache::lonnet::plaintext($role,&course_type());
4647: }
1.898 raeburn 4648: if ($env{'request.course.sec'}) {
4649: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
4650: }
1.359 albertel 4651: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4652: } else {
4653: $role = &Apache::lonnet::plaintext($role);
1.54 www 4654: }
1.433 albertel 4655:
1.359 albertel 4656: if (!$realm) { $realm=' '; }
1.55 www 4657: # Set messages
1.60 matthew 4658: my $messages=&domainlogo($domain);
1.330 albertel 4659:
1.438 albertel 4660: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4661:
1.101 www 4662: # construct main body tag
1.359 albertel 4663: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4664: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4665:
1.530 albertel 4666: if ($bodyonly) {
1.60 matthew 4667: return $bodytag;
1.798 tempelho 4668: }
1.359 albertel 4669:
1.410 albertel 4670: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.948.2.2 raeburn 4671: if ($public) {
1.433 albertel 4672: undef($role);
1.434 albertel 4673: } else {
4674: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4675: }
1.948.2.2 raeburn 4676:
1.762 bisitz 4677: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 4678: #
4679: # Extra info if you are the DC
4680: my $dc_info = '';
4681: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4682: $env{'course.'.$env{'request.course.id'}.
4683: '.domain'}.'/'})) {
4684: my $cid = $env{'request.course.id'};
1.917 raeburn 4685: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4686: $dc_info =~ s/\s+$//;
1.359 albertel 4687: }
4688:
1.898 raeburn 4689: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853 droeschl 4690: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
4691:
1.948.2.19 raeburn 4692: if ($env{'environment.remote'} ne 'on') {
1.359 albertel 4693: # No Remote
1.916 droeschl 4694: if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') {
1.948.2.19 raeburn 4695: return $bodytag;
4696: }
1.903 droeschl 4697:
4698: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
4699:
4700: # if ($env{'request.state'} eq 'construct') {
4701: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
4702: # }
4703:
1.359 albertel 4704:
4705:
1.916 droeschl 4706: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917 raeburn 4707: if ($dc_info) {
4708: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
4709: }
1.916 droeschl 4710: $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
4711: <em>$realm</em> $dc_info</div>|;
1.903 droeschl 4712: return $bodytag;
4713: }
1.948.2.19 raeburn 4714: if (($env{'request.noversionuri'} =~ m{^/adm/navmaps}) &&
4715: ($env{'environment.remotenavmap'} eq 'on')) {
4716: return $bodytag;
4717: }
1.894 droeschl 4718:
1.927 raeburn 4719: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
4720: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
4721: }
1.916 droeschl 4722:
1.903 droeschl 4723: $bodytag .= Apache::lonhtmlcommon::scripttag(
4724: Apache::lonmenu::utilityfunctions(), 'start');
1.816 bisitz 4725:
1.903 droeschl 4726: $bodytag .= Apache::lonmenu::primary_menu();
1.852 droeschl 4727:
1.917 raeburn 4728: if ($dc_info) {
4729: $dc_info = &dc_courseid_toggle($dc_info);
4730: }
4731: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 4732:
1.903 droeschl 4733: #don't show menus for public users
1.948.2.2 raeburn 4734: if (!$public){
1.903 droeschl 4735: $bodytag .= Apache::lonmenu::secondary_menu();
4736: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 4737: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
4738: if ($env{'request.state'} eq 'construct') {
4739: $bodytag .= &Apache::lonmenu::innerregister($forcereg,'',
4740: $args->{'bread_crumbs'});
4741: } elsif ($forcereg) {
4742: $bodytag .= &Apache::lonmenu::innerregister($forcereg);
4743: }
1.903 droeschl 4744: }else{
4745: # this is to seperate menu from content when there's no secondary
4746: # menu. Especially needed for public accessible ressources.
4747: $bodytag .= '<hr style="clear:both" />';
4748: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 4749: }
1.903 droeschl 4750:
1.235 raeburn 4751: return $bodytag;
1.94 www 4752: }
1.95 www 4753:
1.93 www 4754: #
1.95 www 4755: # Top frame rendering, Remote is up
1.93 www 4756: #
1.359 albertel 4757:
1.517 raeburn 4758: my $imgsrc = $img;
4759: if ($img =~ /^\/adm/) {
1.575 albertel 4760: $imgsrc = &lonhttpdurl($img);
1.517 raeburn 4761: }
4762: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359 albertel 4763:
1.305 www 4764: # Explicit link to get inline menu
1.361 albertel 4765: my $menu= ($no_inline_link?''
1.883 droeschl 4766: :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
1.917 raeburn 4767:
4768: if ($dc_info) {
4769: $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
4770: }
4771:
1.948.2.25! raeburn 4772: unless ($env{'form.inhibitmenu'}) {
! 4773: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>
! 4774: <ol class="LC_primary_menu LC_right">
! 4775: <li>$menu</li>
! 4776: </ol><div id="LC_realm"> $realm $dc_info</div>|;
! 4777: }
! 4778:
1.94 www 4779: return(<<ENDBODY);
1.60 matthew 4780: $bodytag
1.359 albertel 4781: <table id="LC_title_bar" class="LC_with_remote">
1.791 tempelho 4782: <tr><td>$upperleft</td>
4783: <td>$messages </td>
1.54 www 4784: </tr>
1.359 albertel 4785: <tr><td>$titleinfo $dc_info $menu</td>
1.368 albertel 4786: </tr>
1.356 albertel 4787: </table>
1.54 www 4788: ENDBODY
1.182 matthew 4789: }
4790:
1.917 raeburn 4791: sub dc_courseid_toggle {
4792: my ($dc_info) = @_;
1.948.2.10 raeburn 4793: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.917 raeburn 4794: '<a href="javascript:showCourseID();">'.
4795: &mt('(More ...)').'</a></span>'.
4796: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
4797: }
4798:
1.330 albertel 4799: sub make_attr_string {
4800: my ($register,$attr_ref) = @_;
4801:
4802: if ($attr_ref && !ref($attr_ref)) {
4803: die("addentries Must be a hash ref ".
4804: join(':',caller(1))." ".
4805: join(':',caller(0))." ");
4806: }
4807:
4808: if ($register) {
1.339 albertel 4809: my ($on_load,$on_unload);
4810: foreach my $key (keys(%{$attr_ref})) {
4811: if (lc($key) eq 'onload') {
4812: $on_load.=$attr_ref->{$key}.';';
4813: delete($attr_ref->{$key});
4814:
4815: } elsif (lc($key) eq 'onunload') {
4816: $on_unload.=$attr_ref->{$key}.';';
4817: delete($attr_ref->{$key});
4818: }
4819: }
4820: $attr_ref->{'onload'} =
4821: &Apache::lonmenu::loadevents(). $on_load;
4822: $attr_ref->{'onunload'}=
4823: &Apache::lonmenu::unloadevents().$on_unload;
4824: }
4825:
4826: # Accessibility font enhance
4827: if ($env{'browser.fontenhance'} eq 'on') {
4828: my $style;
4829: foreach my $key (keys(%{$attr_ref})) {
4830: if (lc($key) eq 'style') {
4831: $style.=$attr_ref->{$key}.';';
4832: delete($attr_ref->{$key});
4833: }
4834: }
4835: $attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330 albertel 4836: }
1.339 albertel 4837:
1.330 albertel 4838: my $attr_string;
4839: foreach my $attr (keys(%$attr_ref)) {
4840: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4841: }
4842: return $attr_string;
4843: }
4844:
4845:
1.182 matthew 4846: ###############################################
1.251 albertel 4847: ###############################################
4848:
4849: =pod
4850:
4851: =item * &endbodytag()
4852:
4853: Returns a uniform footer for LON-CAPA web pages.
4854:
1.635 raeburn 4855: Inputs: 1 - optional reference to an args hash
4856: If in the hash, key for noredirectlink has a value which evaluates to true,
4857: a 'Continue' link is not displayed if the page contains an
4858: internal redirect in the <head></head> section,
4859: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4860:
4861: =cut
4862:
4863: sub endbodytag {
1.635 raeburn 4864: my ($args) = @_;
1.251 albertel 4865: my $endbodytag='</body>';
1.269 albertel 4866: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4867: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4868: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4869: $endbodytag=
4870: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4871: &mt('Continue').'</a>'.
4872: $endbodytag;
4873: }
1.315 albertel 4874: }
1.251 albertel 4875: return $endbodytag;
4876: }
4877:
1.352 albertel 4878: =pod
4879:
4880: =item * &standard_css()
4881:
4882: Returns a style sheet
4883:
4884: Inputs: (all optional)
4885: domain -> force to color decorate a page for a specific
4886: domain
4887: function -> force usage of a specific rolish color scheme
4888: bgcolor -> override the default page bgcolor
4889:
4890: =cut
4891:
1.343 albertel 4892: sub standard_css {
1.345 albertel 4893: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4894: $function = &get_users_function() if (!$function);
4895: my $img = &designparm($function.'.img', $domain);
4896: my $tabbg = &designparm($function.'.tabbg', $domain);
4897: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 4898: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 4899: #second colour for later usage
1.345 albertel 4900: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4901: my $pgbg_or_bgcolor =
4902: $bgcolor ||
1.352 albertel 4903: &designparm($function.'.pgbg', $domain);
1.382 albertel 4904: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4905: my $alink = &designparm($function.'.alink', $domain);
4906: my $vlink = &designparm($function.'.vlink', $domain);
4907: my $link = &designparm($function.'.link', $domain);
4908:
1.602 albertel 4909: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4910: my $mono = 'monospace';
1.850 bisitz 4911: my $data_table_head = $sidebg;
4912: my $data_table_light = '#FAFAFA';
4913: my $data_table_dark = '#F0F0F0';
1.470 banghart 4914: my $data_table_darker = '#CCCCCC';
1.349 albertel 4915: my $data_table_highlight = '#FFFF00';
1.352 albertel 4916: my $mail_new = '#FFBB77';
4917: my $mail_new_hover = '#DD9955';
4918: my $mail_read = '#BBBB77';
4919: my $mail_read_hover = '#999944';
4920: my $mail_replied = '#AAAA88';
4921: my $mail_replied_hover = '#888855';
4922: my $mail_other = '#99BBBB';
4923: my $mail_other_hover = '#669999';
1.391 albertel 4924: my $table_header = '#DDDDDD';
1.489 raeburn 4925: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 4926: my $lg_border_color = '#C8C8C8';
1.948.2.1 raeburn 4927: my $button_hover = '#BF2317';
1.392 albertel 4928:
1.608 albertel 4929: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 4930: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
4931: : '0 3px 0 4px';
1.448 albertel 4932:
1.343 albertel 4933: return <<END;
1.947 droeschl 4934:
4935: /* needed for iframe to allow 100% height in FF */
4936: body, html {
4937: margin: 0;
4938: padding: 0 0.5%;
4939: height: 99%; /* to avoid scrollbars */
4940: }
4941:
1.795 www 4942: body {
1.911 bisitz 4943: font-family: $sans;
4944: line-height:130%;
4945: font-size:0.83em;
4946: color:$font;
1.795 www 4947: }
4948:
1.948.2.9 raeburn 4949: a:focus,
4950: a:focus img {
1.795 www 4951: color: red;
1.911 bisitz 4952: background: yellow;
1.795 www 4953: }
1.698 harmsja 4954:
1.911 bisitz 4955: form, .inline {
4956: display: inline;
1.795 www 4957: }
1.721 harmsja 4958:
1.795 www 4959: .LC_right {
1.911 bisitz 4960: text-align:right;
1.795 www 4961: }
4962:
4963: .LC_middle {
1.911 bisitz 4964: vertical-align:middle;
1.795 www 4965: }
1.721 harmsja 4966:
1.911 bisitz 4967: .LC_400Box {
4968: width:400px;
4969: }
1.721 harmsja 4970:
1.947 droeschl 4971: .LC_iframecontainer {
4972: width: 98%;
4973: margin: 0;
4974: position: fixed;
4975: top: 8.5em;
4976: bottom: 0;
4977: }
4978:
4979: .LC_iframecontainer iframe{
4980: border: none;
4981: width: 100%;
4982: height: 100%;
4983: }
4984:
1.778 bisitz 4985: .LC_filename {
4986: font-family: $mono;
4987: white-space:pre;
1.921 bisitz 4988: font-size: 120%;
1.778 bisitz 4989: }
4990:
4991: .LC_fileicon {
4992: border: none;
4993: height: 1.3em;
4994: vertical-align: text-bottom;
4995: margin-right: 0.3em;
4996: text-decoration:none;
4997: }
4998:
1.350 albertel 4999: .LC_error {
5000: color: red;
5001: font-size: larger;
5002: }
1.795 www 5003:
1.457 albertel 5004: .LC_warning,
5005: .LC_diff_removed {
1.733 bisitz 5006: color: red;
1.394 albertel 5007: }
1.532 albertel 5008:
5009: .LC_info,
1.457 albertel 5010: .LC_success,
5011: .LC_diff_added {
1.350 albertel 5012: color: green;
5013: }
1.795 www 5014:
1.802 bisitz 5015: div.LC_confirm_box {
5016: background-color: #FAFAFA;
5017: border: 1px solid $lg_border_color;
5018: margin-right: 0;
5019: padding: 5px;
5020: }
5021:
5022: div.LC_confirm_box .LC_error img,
5023: div.LC_confirm_box .LC_success img {
5024: vertical-align: middle;
5025: }
5026:
1.440 albertel 5027: .LC_icon {
1.771 droeschl 5028: border: none;
1.790 droeschl 5029: vertical-align: middle;
1.771 droeschl 5030: }
5031:
1.543 albertel 5032: .LC_docs_spacer {
5033: width: 25px;
5034: height: 1px;
1.771 droeschl 5035: border: none;
1.543 albertel 5036: }
1.346 albertel 5037:
1.532 albertel 5038: .LC_internal_info {
1.735 bisitz 5039: color: #999999;
1.532 albertel 5040: }
5041:
1.794 www 5042: .LC_discussion {
1.911 bisitz 5043: background: $tabbg;
5044: border: 1px solid black;
5045: margin: 2px;
1.794 www 5046: }
5047:
5048: .LC_disc_action_links_bar {
1.911 bisitz 5049: background: $tabbg;
5050: border: none;
5051: margin: 4px;
1.794 www 5052: }
5053:
5054: .LC_disc_action_left {
1.911 bisitz 5055: text-align: left;
1.794 www 5056: }
5057:
5058: .LC_disc_action_right {
1.911 bisitz 5059: text-align: right;
1.794 www 5060: }
5061:
5062: .LC_disc_new_item {
1.911 bisitz 5063: background: white;
5064: border: 2px solid red;
5065: margin: 2px;
1.794 www 5066: }
5067:
5068: .LC_disc_old_item {
1.911 bisitz 5069: background: white;
5070: border: 1px solid black;
5071: margin: 2px;
1.794 www 5072: }
5073:
1.458 albertel 5074: table.LC_pastsubmission {
5075: border: 1px solid black;
5076: margin: 2px;
5077: }
5078:
1.924 bisitz 5079: table#LC_menubuttons {
1.345 albertel 5080: width: 100%;
5081: background: $pgbg;
1.392 albertel 5082: border: 2px;
1.402 albertel 5083: border-collapse: separate;
1.803 bisitz 5084: padding: 0;
1.345 albertel 5085: }
1.392 albertel 5086:
1.801 tempelho 5087: table#LC_title_bar a {
5088: color: $fontmenu;
5089: }
1.836 bisitz 5090:
1.807 droeschl 5091: table#LC_title_bar {
1.819 tempelho 5092: clear: both;
1.836 bisitz 5093: display: none;
1.807 droeschl 5094: }
5095:
1.795 www 5096: table#LC_title_bar,
1.933 droeschl 5097: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 5098: table#LC_title_bar.LC_with_remote {
1.359 albertel 5099: width: 100%;
1.392 albertel 5100: border-color: $pgbg;
5101: border-style: solid;
5102: border-width: $border;
1.379 albertel 5103: background: $pgbg;
1.801 tempelho 5104: color: $fontmenu;
1.392 albertel 5105: border-collapse: collapse;
1.803 bisitz 5106: padding: 0;
1.819 tempelho 5107: margin: 0;
1.359 albertel 5108: }
1.795 www 5109:
1.933 droeschl 5110: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 5111: margin: 0;
5112: padding: 0;
1.933 droeschl 5113: position: relative;
5114: list-style: none;
1.913 droeschl 5115: }
1.933 droeschl 5116: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 5117: display: inline;
5118: }
1.933 droeschl 5119:
5120: .LC_breadcrumb_tools_navigation {
1.913 droeschl 5121: padding: 0;
1.933 droeschl 5122: margin: 0;
5123: float: left;
1.913 droeschl 5124: }
1.933 droeschl 5125: .LC_breadcrumb_tools_tools {
5126: padding: 0;
5127: margin: 0;
1.913 droeschl 5128: float: right;
5129: }
5130:
1.359 albertel 5131: table#LC_title_bar td {
5132: background: $tabbg;
5133: }
1.795 www 5134:
1.911 bisitz 5135: table#LC_menubuttons img {
1.803 bisitz 5136: border: none;
1.346 albertel 5137: }
1.795 www 5138:
1.842 droeschl 5139: .LC_breadcrumbs_component {
1.911 bisitz 5140: float: right;
5141: margin: 0 1em;
1.357 albertel 5142: }
1.842 droeschl 5143: .LC_breadcrumbs_component img {
1.911 bisitz 5144: vertical-align: middle;
1.777 tempelho 5145: }
1.795 www 5146:
1.383 albertel 5147: td.LC_table_cell_checkbox {
5148: text-align: center;
5149: }
1.795 www 5150:
5151: .LC_fontsize_small {
1.911 bisitz 5152: font-size: 70%;
1.705 tempelho 5153: }
5154:
1.844 bisitz 5155: #LC_breadcrumbs {
1.911 bisitz 5156: clear:both;
5157: background: $sidebg;
5158: border-bottom: 1px solid $lg_border_color;
5159: line-height: 2.5em;
1.933 droeschl 5160: overflow: hidden;
1.911 bisitz 5161: margin: 0;
5162: padding: 0;
1.948.2.24 raeburn 5163: text-align: left;
1.819 tempelho 5164: }
1.862 bisitz 5165:
1.839 droeschl 5166: /* Preliminary fix to hide breadcrumbs inside remote control window */
1.844 bisitz 5167: #LC_remote #LC_breadcrumbs {
1.911 bisitz 5168: display:none;
1.839 droeschl 5169: }
1.819 tempelho 5170:
1.948.2.22 raeburn 5171: .LC_head_subbox {
1.911 bisitz 5172: clear:both;
5173: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 5174: border: 1px solid $sidebg;
5175: margin: 0 0 10px 0;
1.948.2.6 raeburn 5176: padding: 3px;
1.948.2.24 raeburn 5177: text-align: left;
1.822 bisitz 5178: }
5179:
1.795 www 5180: .LC_fontsize_medium {
1.911 bisitz 5181: font-size: 85%;
1.705 tempelho 5182: }
5183:
1.795 www 5184: .LC_fontsize_large {
1.911 bisitz 5185: font-size: 120%;
1.705 tempelho 5186: }
5187:
1.346 albertel 5188: .LC_menubuttons_inline_text {
5189: color: $font;
1.698 harmsja 5190: font-size: 90%;
1.701 harmsja 5191: padding-left:3px;
1.346 albertel 5192: }
5193:
1.934 droeschl 5194: .LC_menubuttons_inline_text img{
5195: vertical-align: middle;
5196: }
5197:
1.948.2.1 raeburn 5198: li.LC_menubuttons_inline_text img,a {
5199: cursor:pointer;
5200: }
5201:
1.526 www 5202: .LC_menubuttons_link {
5203: text-decoration: none;
5204: }
1.795 www 5205:
1.522 albertel 5206: .LC_menubuttons_category {
1.521 www 5207: color: $font;
1.526 www 5208: background: $pgbg;
1.521 www 5209: font-size: larger;
5210: font-weight: bold;
5211: }
5212:
1.346 albertel 5213: td.LC_menubuttons_text {
1.911 bisitz 5214: color: $font;
1.346 albertel 5215: }
1.706 harmsja 5216:
1.346 albertel 5217: .LC_current_location {
5218: background: $tabbg;
5219: }
1.795 www 5220:
1.938 bisitz 5221: table.LC_data_table {
1.347 albertel 5222: border: 1px solid #000000;
1.402 albertel 5223: border-collapse: separate;
1.426 albertel 5224: border-spacing: 1px;
1.610 albertel 5225: background: $pgbg;
1.347 albertel 5226: }
1.795 www 5227:
1.422 albertel 5228: .LC_data_table_dense {
5229: font-size: small;
5230: }
1.795 www 5231:
1.507 raeburn 5232: table.LC_nested_outer {
5233: border: 1px solid #000000;
1.589 raeburn 5234: border-collapse: collapse;
1.803 bisitz 5235: border-spacing: 0;
1.507 raeburn 5236: width: 100%;
5237: }
1.795 www 5238:
1.879 raeburn 5239: table.LC_innerpickbox,
1.507 raeburn 5240: table.LC_nested {
1.803 bisitz 5241: border: none;
1.589 raeburn 5242: border-collapse: collapse;
1.803 bisitz 5243: border-spacing: 0;
1.507 raeburn 5244: width: 100%;
5245: }
1.795 www 5246:
1.930 faziophi 5247: .ui-accordion,
5248: .ui-accordion table.LC_data_table,
5249: .ui-accordion table.LC_nested_outer{
5250: border: 0px;
5251: border-spacing: 0px;
5252: margin: 3px;
5253: }
5254:
1.911 bisitz 5255: table.LC_data_table tr th,
5256: table.LC_calendar tr th,
1.879 raeburn 5257: table.LC_prior_tries tr th,
5258: table.LC_innerpickbox tr th {
1.349 albertel 5259: font-weight: bold;
5260: background-color: $data_table_head;
1.801 tempelho 5261: color:$fontmenu;
1.701 harmsja 5262: font-size:90%;
1.347 albertel 5263: }
1.795 www 5264:
1.879 raeburn 5265: table.LC_innerpickbox tr th,
5266: table.LC_innerpickbox tr td {
5267: vertical-align: top;
5268: }
5269:
1.711 raeburn 5270: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 5271: background-color: #CCCCCC;
1.711 raeburn 5272: font-weight: bold;
5273: text-align: left;
5274: }
1.795 www 5275:
1.912 bisitz 5276: table.LC_data_table tr.LC_odd_row > td {
5277: background-color: $data_table_light;
5278: padding: 2px;
5279: vertical-align: top;
5280: }
5281:
1.809 bisitz 5282: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 5283: background-color: $data_table_light;
1.912 bisitz 5284: vertical-align: top;
5285: }
5286:
5287: table.LC_data_table tr.LC_even_row > td {
5288: background-color: $data_table_dark;
1.425 albertel 5289: padding: 2px;
1.900 bisitz 5290: vertical-align: top;
1.347 albertel 5291: }
1.795 www 5292:
1.809 bisitz 5293: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 5294: background-color: $data_table_dark;
1.900 bisitz 5295: vertical-align: top;
1.347 albertel 5296: }
1.795 www 5297:
1.425 albertel 5298: table.LC_data_table tr.LC_data_table_highlight td {
5299: background-color: $data_table_darker;
5300: }
1.795 www 5301:
1.639 raeburn 5302: table.LC_data_table tr td.LC_leftcol_header {
5303: background-color: $data_table_head;
5304: font-weight: bold;
5305: }
1.795 www 5306:
1.451 albertel 5307: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5308: table.LC_nested tr.LC_empty_row td {
1.421 albertel 5309: font-weight: bold;
5310: font-style: italic;
5311: text-align: center;
5312: padding: 8px;
1.347 albertel 5313: }
1.795 www 5314:
1.940 bisitz 5315: table.LC_data_table tr.LC_empty_row td {
5316: background-color: $sidebg;
5317: }
5318:
5319: table.LC_nested tr.LC_empty_row td {
5320: background-color: #FFFFFF;
5321: }
5322:
1.890 droeschl 5323: table.LC_caption {
5324: }
5325:
1.507 raeburn 5326: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5327: padding: 4ex
5328: }
1.795 www 5329:
1.507 raeburn 5330: table.LC_nested_outer tr th {
5331: font-weight: bold;
1.801 tempelho 5332: color:$fontmenu;
1.507 raeburn 5333: background-color: $data_table_head;
1.701 harmsja 5334: font-size: small;
1.507 raeburn 5335: border-bottom: 1px solid #000000;
5336: }
1.795 www 5337:
1.507 raeburn 5338: table.LC_nested_outer tr td.LC_subheader {
5339: background-color: $data_table_head;
5340: font-weight: bold;
5341: font-size: small;
5342: border-bottom: 1px solid #000000;
5343: text-align: right;
1.451 albertel 5344: }
1.795 www 5345:
1.507 raeburn 5346: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5347: background-color: #CCCCCC;
1.451 albertel 5348: font-weight: bold;
5349: font-size: small;
1.507 raeburn 5350: text-align: center;
5351: }
1.795 www 5352:
1.589 raeburn 5353: table.LC_nested tr.LC_info_row td.LC_left_item,
5354: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5355: text-align: left;
1.451 albertel 5356: }
1.795 www 5357:
1.507 raeburn 5358: table.LC_nested td {
1.735 bisitz 5359: background-color: #FFFFFF;
1.451 albertel 5360: font-size: small;
1.507 raeburn 5361: }
1.795 www 5362:
1.507 raeburn 5363: table.LC_nested_outer tr th.LC_right_item,
5364: table.LC_nested tr.LC_info_row td.LC_right_item,
5365: table.LC_nested tr.LC_odd_row td.LC_right_item,
5366: table.LC_nested tr td.LC_right_item {
1.451 albertel 5367: text-align: right;
5368: }
5369:
1.930 faziophi 5370: .ui-accordion table.LC_nested tr.LC_odd_row td.LC_left_item,
5371: .ui-accordion table.LC_nested tr.LC_even_row td.LC_left_item {
5372: text-align: right;
5373: width: 40%;
5374: padding-right:10px;
5375: vertical-align: top;
5376: padding: 5px;
5377: }
5378:
5379: .ui-accordion table.LC_nested tr.LC_odd_row td.LC_right_item,
5380: .ui-accordion table.LC_nested tr.LC_even_row td.LC_right_item {
5381: text-align: left;
5382: width: 60%;
5383: padding: 2px 4px;
5384: }
5385:
1.507 raeburn 5386: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5387: background-color: #EEEEEE;
1.451 albertel 5388: }
5389:
1.473 raeburn 5390: table.LC_createuser {
5391: }
5392:
5393: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5394: font-size: small;
1.473 raeburn 5395: }
5396:
5397: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5398: background-color: #CCCCCC;
1.473 raeburn 5399: font-weight: bold;
5400: text-align: center;
5401: }
5402:
1.349 albertel 5403: table.LC_calendar {
5404: border: 1px solid #000000;
5405: border-collapse: collapse;
1.917 raeburn 5406: width: 98%;
1.349 albertel 5407: }
1.795 www 5408:
1.349 albertel 5409: table.LC_calendar_pickdate {
5410: font-size: xx-small;
5411: }
1.795 www 5412:
1.349 albertel 5413: table.LC_calendar tr td {
5414: border: 1px solid #000000;
5415: vertical-align: top;
1.917 raeburn 5416: width: 14%;
1.349 albertel 5417: }
1.795 www 5418:
1.349 albertel 5419: table.LC_calendar tr td.LC_calendar_day_empty {
5420: background-color: $data_table_dark;
5421: }
1.795 www 5422:
1.779 bisitz 5423: table.LC_calendar tr td.LC_calendar_day_current {
5424: background-color: $data_table_highlight;
1.777 tempelho 5425: }
1.795 www 5426:
1.938 bisitz 5427: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 5428: background-color: $mail_new;
5429: }
1.795 www 5430:
1.938 bisitz 5431: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 5432: background-color: $mail_new_hover;
5433: }
1.795 www 5434:
1.938 bisitz 5435: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 5436: background-color: $mail_read;
5437: }
1.795 www 5438:
1.938 bisitz 5439: /*
5440: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 5441: background-color: $mail_read_hover;
5442: }
1.938 bisitz 5443: */
1.795 www 5444:
1.938 bisitz 5445: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 5446: background-color: $mail_replied;
5447: }
1.795 www 5448:
1.938 bisitz 5449: /*
5450: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 5451: background-color: $mail_replied_hover;
5452: }
1.938 bisitz 5453: */
1.795 www 5454:
1.938 bisitz 5455: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 5456: background-color: $mail_other;
5457: }
1.795 www 5458:
1.938 bisitz 5459: /*
5460: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 5461: background-color: $mail_other_hover;
5462: }
1.938 bisitz 5463: */
1.494 raeburn 5464:
1.777 tempelho 5465: table.LC_data_table tr > td.LC_browser_file,
5466: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 5467: background: #AAEE77;
1.389 albertel 5468: }
1.795 www 5469:
1.777 tempelho 5470: table.LC_data_table tr > td.LC_browser_file_locked,
5471: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5472: background: #FFAA99;
1.387 albertel 5473: }
1.795 www 5474:
1.777 tempelho 5475: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 5476: background: #888888;
1.779 bisitz 5477: }
1.795 www 5478:
1.777 tempelho 5479: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5480: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 5481: background: #F8F866;
1.777 tempelho 5482: }
1.795 www 5483:
1.696 bisitz 5484: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 5485: background: #E0E8FF;
1.387 albertel 5486: }
1.696 bisitz 5487:
1.707 bisitz 5488: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 5489: /* background: #77FF77; */
1.707 bisitz 5490: }
1.795 www 5491:
1.707 bisitz 5492: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 5493: border-right: 8px solid #FFFF77;
1.707 bisitz 5494: }
1.795 www 5495:
1.707 bisitz 5496: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 5497: border-right: 8px solid #FFAA77;
1.707 bisitz 5498: }
1.795 www 5499:
1.707 bisitz 5500: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 5501: border-right: 8px solid #FF7777;
1.707 bisitz 5502: }
1.795 www 5503:
1.707 bisitz 5504: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 5505: border-right: 8px solid #AAFF77;
1.707 bisitz 5506: }
1.795 www 5507:
1.707 bisitz 5508: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 5509: border-right: 8px solid #11CC55;
1.707 bisitz 5510: }
5511:
1.388 albertel 5512: span.LC_current_location {
1.701 harmsja 5513: font-size:larger;
1.388 albertel 5514: background: $pgbg;
5515: }
1.387 albertel 5516:
1.395 albertel 5517: span.LC_parm_menu_item {
5518: font-size: larger;
5519: }
1.795 www 5520:
1.395 albertel 5521: span.LC_parm_scope_all {
5522: color: red;
5523: }
1.795 www 5524:
1.395 albertel 5525: span.LC_parm_scope_folder {
5526: color: green;
5527: }
1.795 www 5528:
1.395 albertel 5529: span.LC_parm_scope_resource {
5530: color: orange;
5531: }
1.795 www 5532:
1.395 albertel 5533: span.LC_parm_part {
5534: color: blue;
5535: }
1.795 www 5536:
1.911 bisitz 5537: span.LC_parm_folder,
5538: span.LC_parm_symb {
1.395 albertel 5539: font-size: x-small;
5540: font-family: $mono;
5541: color: #AAAAAA;
5542: }
5543:
1.948.2.8 raeburn 5544: ul.LC_parm_parmlist li {
5545: display: inline-block;
5546: padding: 0.3em 0.8em;
5547: vertical-align: top;
5548: width: 150px;
5549: border-top:1px solid $lg_border_color;
5550: }
5551:
1.795 www 5552: td.LC_parm_overview_level_menu,
5553: td.LC_parm_overview_map_menu,
5554: td.LC_parm_overview_parm_selectors,
5555: td.LC_parm_overview_restrictions {
1.396 albertel 5556: border: 1px solid black;
5557: border-collapse: collapse;
5558: }
1.795 www 5559:
1.396 albertel 5560: table.LC_parm_overview_restrictions td {
5561: border-width: 1px 4px 1px 4px;
5562: border-style: solid;
5563: border-color: $pgbg;
5564: text-align: center;
5565: }
1.795 www 5566:
1.396 albertel 5567: table.LC_parm_overview_restrictions th {
5568: background: $tabbg;
5569: border-width: 1px 4px 1px 4px;
5570: border-style: solid;
5571: border-color: $pgbg;
5572: }
1.795 www 5573:
1.398 albertel 5574: table#LC_helpmenu {
1.803 bisitz 5575: border: none;
1.398 albertel 5576: height: 55px;
1.803 bisitz 5577: border-spacing: 0;
1.398 albertel 5578: }
5579:
5580: table#LC_helpmenu fieldset legend {
5581: font-size: larger;
5582: }
1.795 www 5583:
1.397 albertel 5584: table#LC_helpmenu_links {
5585: width: 100%;
5586: border: 1px solid black;
5587: background: $pgbg;
1.803 bisitz 5588: padding: 0;
1.397 albertel 5589: border-spacing: 1px;
5590: }
1.795 www 5591:
1.397 albertel 5592: table#LC_helpmenu_links tr td {
5593: padding: 1px;
5594: background: $tabbg;
1.399 albertel 5595: text-align: center;
5596: font-weight: bold;
1.397 albertel 5597: }
1.396 albertel 5598:
1.795 www 5599: table#LC_helpmenu_links a:link,
5600: table#LC_helpmenu_links a:visited,
1.397 albertel 5601: table#LC_helpmenu_links a:active {
5602: text-decoration: none;
5603: color: $font;
5604: }
1.795 www 5605:
1.397 albertel 5606: table#LC_helpmenu_links a:hover {
5607: text-decoration: underline;
5608: color: $vlink;
5609: }
1.396 albertel 5610:
1.417 albertel 5611: .LC_chrt_popup_exists {
5612: border: 1px solid #339933;
5613: margin: -1px;
5614: }
1.795 www 5615:
1.417 albertel 5616: .LC_chrt_popup_up {
5617: border: 1px solid yellow;
5618: margin: -1px;
5619: }
1.795 www 5620:
1.417 albertel 5621: .LC_chrt_popup {
5622: border: 1px solid #8888FF;
5623: background: #CCCCFF;
5624: }
1.795 www 5625:
1.421 albertel 5626: table.LC_pick_box {
5627: border-collapse: separate;
5628: background: white;
5629: border: 1px solid black;
5630: border-spacing: 1px;
5631: }
1.795 www 5632:
1.421 albertel 5633: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 5634: background: $sidebg;
1.421 albertel 5635: font-weight: bold;
1.900 bisitz 5636: text-align: left;
1.740 bisitz 5637: vertical-align: top;
1.421 albertel 5638: width: 184px;
5639: padding: 8px;
5640: }
1.795 www 5641:
1.579 raeburn 5642: table.LC_pick_box td.LC_pick_box_value {
5643: text-align: left;
5644: padding: 8px;
5645: }
1.795 www 5646:
1.579 raeburn 5647: table.LC_pick_box td.LC_pick_box_select {
5648: text-align: left;
5649: padding: 8px;
5650: }
1.795 www 5651:
1.424 albertel 5652: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 5653: padding: 0;
1.421 albertel 5654: height: 1px;
5655: background: black;
5656: }
1.795 www 5657:
1.421 albertel 5658: table.LC_pick_box td.LC_pick_box_submit {
5659: text-align: right;
5660: }
1.795 www 5661:
1.579 raeburn 5662: table.LC_pick_box td.LC_evenrow_value {
5663: text-align: left;
5664: padding: 8px;
5665: background-color: $data_table_light;
5666: }
1.795 www 5667:
1.579 raeburn 5668: table.LC_pick_box td.LC_oddrow_value {
5669: text-align: left;
5670: padding: 8px;
5671: background-color: $data_table_light;
5672: }
1.795 www 5673:
1.579 raeburn 5674: span.LC_helpform_receipt_cat {
5675: font-weight: bold;
5676: }
1.795 www 5677:
1.424 albertel 5678: table.LC_group_priv_box {
5679: background: white;
5680: border: 1px solid black;
5681: border-spacing: 1px;
5682: }
1.795 www 5683:
1.424 albertel 5684: table.LC_group_priv_box td.LC_pick_box_title {
5685: background: $tabbg;
5686: font-weight: bold;
5687: text-align: right;
5688: width: 184px;
5689: }
1.795 www 5690:
1.424 albertel 5691: table.LC_group_priv_box td.LC_groups_fixed {
5692: background: $data_table_light;
5693: text-align: center;
5694: }
1.795 www 5695:
1.424 albertel 5696: table.LC_group_priv_box td.LC_groups_optional {
5697: background: $data_table_dark;
5698: text-align: center;
5699: }
1.795 www 5700:
1.424 albertel 5701: table.LC_group_priv_box td.LC_groups_functionality {
5702: background: $data_table_darker;
5703: text-align: center;
5704: font-weight: bold;
5705: }
1.795 www 5706:
1.424 albertel 5707: table.LC_group_priv td {
5708: text-align: left;
1.803 bisitz 5709: padding: 0;
1.424 albertel 5710: }
5711:
1.421 albertel 5712: table.LC_notify_front_page {
5713: background: white;
5714: border: 1px solid black;
5715: padding: 8px;
5716: }
1.795 www 5717:
1.421 albertel 5718: table.LC_notify_front_page td {
5719: padding: 8px;
5720: }
1.795 www 5721:
1.424 albertel 5722: .LC_navbuttons {
5723: margin: 2ex 0ex 2ex 0ex;
5724: }
1.795 www 5725:
1.423 albertel 5726: .LC_topic_bar {
5727: font-weight: bold;
5728: background: $tabbg;
1.918 wenzelju 5729: margin: 1em 0em 1em 2em;
1.805 bisitz 5730: padding: 3px;
1.918 wenzelju 5731: font-size: 1.2em;
1.423 albertel 5732: }
1.795 www 5733:
1.423 albertel 5734: .LC_topic_bar span {
1.918 wenzelju 5735: left: 0.5em;
5736: position: absolute;
1.423 albertel 5737: vertical-align: middle;
1.918 wenzelju 5738: font-size: 1.2em;
1.423 albertel 5739: }
1.795 www 5740:
1.423 albertel 5741: table.LC_course_group_status {
5742: margin: 20px;
5743: }
1.795 www 5744:
1.423 albertel 5745: table.LC_status_selector td {
5746: vertical-align: top;
5747: text-align: center;
1.424 albertel 5748: padding: 4px;
5749: }
1.795 www 5750:
1.599 albertel 5751: div.LC_feedback_link {
1.616 albertel 5752: clear: both;
1.829 kalberla 5753: background: $sidebg;
1.779 bisitz 5754: width: 100%;
1.829 kalberla 5755: padding-bottom: 10px;
5756: border: 1px $tabbg solid;
1.833 kalberla 5757: height: 22px;
5758: line-height: 22px;
5759: padding-top: 5px;
5760: }
5761:
5762: div.LC_feedback_link img {
5763: height: 22px;
1.867 kalberla 5764: vertical-align:middle;
1.829 kalberla 5765: }
5766:
1.911 bisitz 5767: div.LC_feedback_link a {
1.829 kalberla 5768: text-decoration: none;
1.489 raeburn 5769: }
1.795 www 5770:
1.867 kalberla 5771: div.LC_comblock {
1.911 bisitz 5772: display:inline;
1.867 kalberla 5773: color:$font;
5774: font-size:90%;
5775: }
5776:
5777: div.LC_feedback_link div.LC_comblock {
5778: padding-left:5px;
5779: }
5780:
5781: div.LC_feedback_link div.LC_comblock a {
5782: color:$font;
5783: }
5784:
1.489 raeburn 5785: span.LC_feedback_link {
1.858 bisitz 5786: /* background: $feedback_link_bg; */
1.599 albertel 5787: font-size: larger;
5788: }
1.795 www 5789:
1.599 albertel 5790: span.LC_message_link {
1.858 bisitz 5791: /* background: $feedback_link_bg; */
1.599 albertel 5792: font-size: larger;
5793: position: absolute;
5794: right: 1em;
1.489 raeburn 5795: }
1.421 albertel 5796:
1.515 albertel 5797: table.LC_prior_tries {
1.524 albertel 5798: border: 1px solid #000000;
5799: border-collapse: separate;
5800: border-spacing: 1px;
1.515 albertel 5801: }
1.523 albertel 5802:
1.515 albertel 5803: table.LC_prior_tries td {
1.524 albertel 5804: padding: 2px;
1.515 albertel 5805: }
1.523 albertel 5806:
5807: .LC_answer_correct {
1.795 www 5808: background: lightgreen;
5809: color: darkgreen;
5810: padding: 6px;
1.523 albertel 5811: }
1.795 www 5812:
1.523 albertel 5813: .LC_answer_charged_try {
1.797 www 5814: background: #FFAAAA;
1.795 www 5815: color: darkred;
5816: padding: 6px;
1.523 albertel 5817: }
1.795 www 5818:
1.779 bisitz 5819: .LC_answer_not_charged_try,
1.523 albertel 5820: .LC_answer_no_grade,
5821: .LC_answer_late {
1.795 www 5822: background: lightyellow;
1.523 albertel 5823: color: black;
1.795 www 5824: padding: 6px;
1.523 albertel 5825: }
1.795 www 5826:
1.523 albertel 5827: .LC_answer_previous {
1.795 www 5828: background: lightblue;
5829: color: darkblue;
5830: padding: 6px;
1.523 albertel 5831: }
1.795 www 5832:
1.779 bisitz 5833: .LC_answer_no_message {
1.777 tempelho 5834: background: #FFFFFF;
5835: color: black;
1.795 www 5836: padding: 6px;
1.779 bisitz 5837: }
1.795 www 5838:
1.779 bisitz 5839: .LC_answer_unknown {
5840: background: orange;
5841: color: black;
1.795 www 5842: padding: 6px;
1.777 tempelho 5843: }
1.795 www 5844:
1.529 albertel 5845: span.LC_prior_numerical,
5846: span.LC_prior_string,
5847: span.LC_prior_custom,
5848: span.LC_prior_reaction,
5849: span.LC_prior_math {
1.925 bisitz 5850: font-family: $mono;
1.523 albertel 5851: white-space: pre;
5852: }
5853:
1.525 albertel 5854: span.LC_prior_string {
1.925 bisitz 5855: font-family: $mono;
1.525 albertel 5856: white-space: pre;
5857: }
5858:
1.523 albertel 5859: table.LC_prior_option {
5860: width: 100%;
5861: border-collapse: collapse;
5862: }
1.795 www 5863:
1.911 bisitz 5864: table.LC_prior_rank,
1.795 www 5865: table.LC_prior_match {
1.528 albertel 5866: border-collapse: collapse;
5867: }
1.795 www 5868:
1.528 albertel 5869: table.LC_prior_option tr td,
5870: table.LC_prior_rank tr td,
5871: table.LC_prior_match tr td {
1.524 albertel 5872: border: 1px solid #000000;
1.515 albertel 5873: }
5874:
1.855 bisitz 5875: .LC_nobreak {
1.544 albertel 5876: white-space: nowrap;
1.519 raeburn 5877: }
5878:
1.576 raeburn 5879: span.LC_cusr_emph {
5880: font-style: italic;
5881: }
5882:
1.633 raeburn 5883: span.LC_cusr_subheading {
5884: font-weight: normal;
5885: font-size: 85%;
5886: }
5887:
1.861 bisitz 5888: div.LC_docs_entry_move {
1.859 bisitz 5889: border: 1px solid #BBBBBB;
1.545 albertel 5890: background: #DDDDDD;
1.861 bisitz 5891: width: 22px;
1.859 bisitz 5892: padding: 1px;
5893: margin: 0;
1.545 albertel 5894: }
5895:
1.861 bisitz 5896: table.LC_data_table tr > td.LC_docs_entry_commands,
5897: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 5898: background: #DDDDDD;
5899: font-size: x-small;
5900: }
1.795 www 5901:
1.861 bisitz 5902: .LC_docs_entry_parameter {
5903: white-space: nowrap;
5904: }
5905:
1.544 albertel 5906: .LC_docs_copy {
1.545 albertel 5907: color: #000099;
1.544 albertel 5908: }
1.795 www 5909:
1.544 albertel 5910: .LC_docs_cut {
1.545 albertel 5911: color: #550044;
1.544 albertel 5912: }
1.795 www 5913:
1.544 albertel 5914: .LC_docs_rename {
1.545 albertel 5915: color: #009900;
1.544 albertel 5916: }
1.795 www 5917:
1.544 albertel 5918: .LC_docs_remove {
1.545 albertel 5919: color: #990000;
5920: }
5921:
1.547 albertel 5922: .LC_docs_reinit_warn,
5923: .LC_docs_ext_edit {
5924: font-size: x-small;
5925: }
5926:
1.545 albertel 5927: table.LC_docs_adddocs td,
5928: table.LC_docs_adddocs th {
5929: border: 1px solid #BBBBBB;
5930: padding: 4px;
5931: background: #DDDDDD;
1.543 albertel 5932: }
5933:
1.584 albertel 5934: table.LC_sty_begin {
5935: background: #BBFFBB;
5936: }
1.795 www 5937:
1.584 albertel 5938: table.LC_sty_end {
5939: background: #FFBBBB;
5940: }
5941:
1.589 raeburn 5942: table.LC_double_column {
1.803 bisitz 5943: border-width: 0;
1.589 raeburn 5944: border-collapse: collapse;
5945: width: 100%;
5946: padding: 2px;
5947: }
5948:
5949: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5950: top: 2px;
1.589 raeburn 5951: left: 2px;
5952: width: 47%;
5953: vertical-align: top;
5954: }
5955:
5956: table.LC_double_column tr td.LC_right_col {
5957: top: 2px;
1.779 bisitz 5958: right: 2px;
1.589 raeburn 5959: width: 47%;
5960: vertical-align: top;
5961: }
5962:
1.591 raeburn 5963: div.LC_left_float {
5964: float: left;
5965: padding-right: 5%;
1.597 albertel 5966: padding-bottom: 4px;
1.591 raeburn 5967: }
5968:
5969: div.LC_clear_float_header {
1.597 albertel 5970: padding-bottom: 2px;
1.591 raeburn 5971: }
5972:
5973: div.LC_clear_float_footer {
1.597 albertel 5974: padding-top: 10px;
1.591 raeburn 5975: clear: both;
5976: }
5977:
1.597 albertel 5978: div.LC_grade_show_user {
1.941 bisitz 5979: /* border-left: 5px solid $sidebg; */
5980: border-top: 5px solid #000000;
5981: margin: 50px 0 0 0;
1.936 bisitz 5982: padding: 15px 0 5px 10px;
1.597 albertel 5983: }
1.795 www 5984:
1.936 bisitz 5985: div.LC_grade_show_user_odd_row {
1.941 bisitz 5986: /* border-left: 5px solid #000000; */
5987: }
5988:
5989: div.LC_grade_show_user div.LC_Box {
5990: margin-right: 50px;
1.597 albertel 5991: }
5992:
5993: div.LC_grade_submissions,
5994: div.LC_grade_message_center,
1.936 bisitz 5995: div.LC_grade_info_links {
1.597 albertel 5996: margin: 5px;
5997: width: 99%;
5998: background: #FFFFFF;
5999: }
1.795 www 6000:
1.597 albertel 6001: div.LC_grade_submissions_header,
1.936 bisitz 6002: div.LC_grade_message_center_header {
1.705 tempelho 6003: font-weight: bold;
6004: font-size: large;
1.597 albertel 6005: }
1.795 www 6006:
1.597 albertel 6007: div.LC_grade_submissions_body,
1.936 bisitz 6008: div.LC_grade_message_center_body {
1.597 albertel 6009: border: 1px solid black;
6010: width: 99%;
6011: background: #FFFFFF;
6012: }
1.795 www 6013:
1.613 albertel 6014: table.LC_scantron_action {
6015: width: 100%;
6016: }
1.795 www 6017:
1.613 albertel 6018: table.LC_scantron_action tr th {
1.698 harmsja 6019: font-weight:bold;
6020: font-style:normal;
1.613 albertel 6021: }
1.795 www 6022:
1.779 bisitz 6023: .LC_edit_problem_header,
1.614 albertel 6024: div.LC_edit_problem_footer {
1.705 tempelho 6025: font-weight: normal;
6026: font-size: medium;
1.602 albertel 6027: margin: 2px;
1.600 albertel 6028: }
1.795 www 6029:
1.600 albertel 6030: div.LC_edit_problem_header,
1.602 albertel 6031: div.LC_edit_problem_header div,
1.614 albertel 6032: div.LC_edit_problem_footer,
6033: div.LC_edit_problem_footer div,
1.602 albertel 6034: div.LC_edit_problem_editxml_header,
6035: div.LC_edit_problem_editxml_header div {
1.600 albertel 6036: margin-top: 5px;
6037: }
1.795 www 6038:
1.600 albertel 6039: div.LC_edit_problem_header_title {
1.705 tempelho 6040: font-weight: bold;
6041: font-size: larger;
1.602 albertel 6042: background: $tabbg;
6043: padding: 3px;
6044: }
1.795 www 6045:
1.602 albertel 6046: table.LC_edit_problem_header_title {
6047: width: 100%;
1.600 albertel 6048: background: $tabbg;
1.602 albertel 6049: }
6050:
6051: div.LC_edit_problem_discards {
6052: float: left;
6053: padding-bottom: 5px;
6054: }
1.795 www 6055:
1.602 albertel 6056: div.LC_edit_problem_saves {
6057: float: right;
6058: padding-bottom: 5px;
1.600 albertel 6059: }
1.795 www 6060:
1.911 bisitz 6061: img.stift {
1.803 bisitz 6062: border-width: 0;
6063: vertical-align: middle;
1.677 riegler 6064: }
1.680 riegler 6065:
1.923 bisitz 6066: table td.LC_mainmenu_col_fieldset {
1.680 riegler 6067: vertical-align: top;
1.777 tempelho 6068: }
1.795 www 6069:
1.716 raeburn 6070: div.LC_createcourse {
1.911 bisitz 6071: margin: 10px 10px 10px 10px;
1.716 raeburn 6072: }
6073:
1.917 raeburn 6074: .LC_dccid {
6075: margin: 0.2em 0 0 0;
6076: padding: 0;
6077: font-size: 90%;
6078: display:none;
6079: }
6080:
1.698 harmsja 6081: a:hover,
1.897 wenzelju 6082: ol.LC_primary_menu a:hover,
1.721 harmsja 6083: ol#LC_MenuBreadcrumbs a:hover,
6084: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 6085: ul#LC_secondary_menu a:hover,
1.721 harmsja 6086: .LC_FormSectionClearButton input:hover
1.795 www 6087: ul.LC_TabContent li:hover a {
1.948.2.1 raeburn 6088: color:$button_hover;
1.911 bisitz 6089: text-decoration:none;
1.693 droeschl 6090: }
6091:
1.779 bisitz 6092: h1 {
1.911 bisitz 6093: padding: 0;
6094: line-height:130%;
1.693 droeschl 6095: }
1.698 harmsja 6096:
1.911 bisitz 6097: h2,
6098: h3,
6099: h4,
6100: h5,
6101: h6 {
6102: margin: 5px 0 5px 0;
6103: padding: 0;
6104: line-height:130%;
1.693 droeschl 6105: }
1.795 www 6106:
6107: .LC_hcell {
1.911 bisitz 6108: padding:3px 15px 3px 15px;
6109: margin: 0;
6110: background-color:$tabbg;
6111: color:$fontmenu;
6112: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 6113: }
1.795 www 6114:
1.840 bisitz 6115: .LC_Box > .LC_hcell {
1.911 bisitz 6116: margin: 0 -10px 10px -10px;
1.835 bisitz 6117: }
6118:
1.721 harmsja 6119: .LC_noBorder {
1.911 bisitz 6120: border: 0;
1.698 harmsja 6121: }
1.693 droeschl 6122:
1.721 harmsja 6123: .LC_FormSectionClearButton input {
1.911 bisitz 6124: background-color:transparent;
6125: border: none;
6126: cursor:pointer;
6127: text-decoration:underline;
1.693 droeschl 6128: }
1.763 bisitz 6129:
6130: .LC_help_open_topic {
1.911 bisitz 6131: color: #FFFFFF;
6132: background-color: #EEEEFF;
6133: margin: 1px;
6134: padding: 4px;
6135: border: 1px solid #000033;
6136: white-space: nowrap;
6137: /* vertical-align: middle; */
1.759 neumanie 6138: }
1.693 droeschl 6139:
1.911 bisitz 6140: dl,
6141: ul,
6142: div,
6143: fieldset {
6144: margin: 10px 10px 10px 0;
6145: /* overflow: hidden; */
1.693 droeschl 6146: }
1.795 www 6147:
1.838 bisitz 6148: fieldset > legend {
1.911 bisitz 6149: font-weight: bold;
6150: padding: 0 5px 0 5px;
1.838 bisitz 6151: }
6152:
1.813 bisitz 6153: #LC_nav_bar {
1.911 bisitz 6154: float: left;
1.948.2.24 raeburn 6155: background-color: $pgbg_or_bgcolor;
1.948.2.6 raeburn 6156: margin: 0 0 2px 0;
1.807 droeschl 6157: }
6158:
1.916 droeschl 6159: #LC_realm {
6160: margin: 0.2em 0 0 0;
6161: padding: 0;
6162: font-weight: bold;
6163: text-align: center;
1.948.2.24 raeburn 6164: background-color: $pgbg_or_bgcolor;
1.916 droeschl 6165: }
6166:
1.911 bisitz 6167: #LC_nav_bar em {
6168: font-weight: bold;
6169: font-style: normal;
1.807 droeschl 6170: }
6171:
1.948.2.6 raeburn 6172: /* Preliminary fix to hide nav_bar inside bookmarks window */
6173: #LC_bookmarks #LC_nav_bar {
6174: display:none;
6175: }
6176:
1.897 wenzelju 6177: ol.LC_primary_menu {
1.911 bisitz 6178: float: right;
1.934 droeschl 6179: margin: 0;
1.948.2.24 raeburn 6180: background-color: $pgbg_or_bgcolor;
1.807 droeschl 6181: }
6182:
1.929 wenzelju 6183: span.LC_new_message{
6184: font-weight:bold;
6185: color: darkred;
6186: }
6187:
1.852 droeschl 6188: ol#LC_PathBreadcrumbs {
1.911 bisitz 6189: margin: 0;
1.693 droeschl 6190: }
6191:
1.897 wenzelju 6192: ol.LC_primary_menu li {
1.911 bisitz 6193: display: inline;
6194: padding: 5px 5px 0 10px;
6195: vertical-align: top;
1.693 droeschl 6196: }
6197:
1.897 wenzelju 6198: ol.LC_primary_menu li img {
1.911 bisitz 6199: vertical-align: bottom;
1.934 droeschl 6200: height: 1.1em;
1.693 droeschl 6201: }
6202:
1.897 wenzelju 6203: ol.LC_primary_menu a {
1.911 bisitz 6204: color: RGB(80, 80, 80);
6205: text-decoration: none;
1.693 droeschl 6206: }
1.795 www 6207:
1.948.2.7 raeburn 6208: ol.LC_docs_parameters {
6209: margin-left: 0;
6210: padding: 0;
6211: list-style: none;
6212: }
6213:
6214: ol.LC_docs_parameters li {
6215: margin: 0;
6216: padding-right: 20px;
6217: display: inline;
6218: }
6219:
6220: ol.LC_docs_parameters li:before {
6221: content: "\\002022 \\0020";
6222: }
6223:
6224: li.LC_docs_parameters_title {
6225: font-weight: bold;
6226: }
6227:
6228: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
6229: content: "";
6230: }
6231:
1.897 wenzelju 6232: ul#LC_secondary_menu {
1.911 bisitz 6233: clear: both;
6234: color: $fontmenu;
6235: background: $tabbg;
6236: list-style: none;
6237: padding: 0;
6238: margin: 0;
6239: width: 100%;
1.948.2.24 raeburn 6240: text-align: left;
1.808 droeschl 6241: }
6242:
1.897 wenzelju 6243: ul#LC_secondary_menu li {
1.911 bisitz 6244: font-weight: bold;
6245: line-height: 1.8em;
6246: padding: 0 0.8em;
6247: border-right: 1px solid black;
6248: display: inline;
6249: vertical-align: middle;
1.807 droeschl 6250: }
6251:
1.847 tempelho 6252: ul.LC_TabContent {
1.911 bisitz 6253: display:block;
6254: background: $sidebg;
6255: border-bottom: solid 1px $lg_border_color;
6256: list-style:none;
6257: margin: 0 -10px;
6258: padding: 0;
1.693 droeschl 6259: }
6260:
1.795 www 6261: ul.LC_TabContent li,
6262: ul.LC_TabContentBigger li {
1.911 bisitz 6263: float:left;
1.741 harmsja 6264: }
1.795 www 6265:
1.897 wenzelju 6266: ul#LC_secondary_menu li a {
1.911 bisitz 6267: color: $fontmenu;
6268: text-decoration: none;
1.693 droeschl 6269: }
1.795 www 6270:
1.721 harmsja 6271: ul.LC_TabContent {
1.948.2.1 raeburn 6272: min-height:20px;
1.721 harmsja 6273: }
1.795 www 6274:
6275: ul.LC_TabContent li {
1.911 bisitz 6276: vertical-align:middle;
1.948.2.3 raeburn 6277: padding: 0 16px 0 10px;
1.911 bisitz 6278: background-color:$tabbg;
6279: border-bottom:solid 1px $lg_border_color;
1.948.2.1 raeburn 6280: border-right: solid 1px $font;
1.721 harmsja 6281: }
1.795 www 6282:
1.847 tempelho 6283: ul.LC_TabContent .right {
1.911 bisitz 6284: float:right;
1.847 tempelho 6285: }
6286:
1.911 bisitz 6287: ul.LC_TabContent li a,
6288: ul.LC_TabContent li {
6289: color:rgb(47,47,47);
6290: text-decoration:none;
6291: font-size:95%;
6292: font-weight:bold;
1.948.2.1 raeburn 6293: min-height:20px;
6294: }
6295:
1.948.2.3 raeburn 6296: ul.LC_TabContent li a:hover,
6297: ul.LC_TabContent li a:focus {
1.948.2.1 raeburn 6298: color: $button_hover;
1.948.2.3 raeburn 6299: background:none;
6300: outline:none;
1.948.2.1 raeburn 6301: }
6302:
6303: ul.LC_TabContent li:hover {
6304: color: $button_hover;
6305: cursor:pointer;
1.721 harmsja 6306: }
1.795 www 6307:
1.911 bisitz 6308: ul.LC_TabContent li.active {
1.948.2.1 raeburn 6309: color: $font;
1.911 bisitz 6310: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.948.2.1 raeburn 6311: border-bottom:solid 1px #FFFFFF;
6312: cursor: default;
1.744 ehlerst 6313: }
1.795 www 6314:
1.948.2.3 raeburn 6315: ul.LC_TabContent li.active a {
6316: color:$font;
6317: background:#FFFFFF;
6318: outline: none;
6319: }
1.870 tempelho 6320: #maincoursedoc {
1.911 bisitz 6321: clear:both;
1.870 tempelho 6322: }
6323:
6324: ul.LC_TabContentBigger {
1.911 bisitz 6325: display:block;
6326: list-style:none;
6327: padding: 0;
1.870 tempelho 6328: }
6329:
1.795 www 6330: ul.LC_TabContentBigger li {
1.911 bisitz 6331: vertical-align:bottom;
6332: height: 30px;
6333: font-size:110%;
6334: font-weight:bold;
6335: color: #737373;
1.841 tempelho 6336: }
6337:
1.948.2.3 raeburn 6338: ul.LC_TabContentBigger li.active {
6339: position: relative;
6340: top: 1px;
6341: }
1.870 tempelho 6342:
6343: ul.LC_TabContentBigger li a {
1.911 bisitz 6344: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6345: height: 30px;
6346: line-height: 30px;
6347: text-align: center;
6348: display: block;
6349: text-decoration: none;
1.948.2.3 raeburn 6350: outline: none;
1.741 harmsja 6351: }
1.795 www 6352:
1.870 tempelho 6353: ul.LC_TabContentBigger li.active a {
1.911 bisitz 6354: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6355: color:$font;
1.744 ehlerst 6356: }
1.795 www 6357:
1.870 tempelho 6358: ul.LC_TabContentBigger li b {
1.911 bisitz 6359: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
6360: display: block;
6361: float: left;
6362: padding: 0 30px;
1.948.2.3 raeburn 6363: border-bottom: 1px solid $lg_border_color;
6364: }
6365:
6366: ul.LC_TabContentBigger li:hover b {
6367: color:$button_hover;
1.870 tempelho 6368: }
6369:
6370: ul.LC_TabContentBigger li.active b {
1.911 bisitz 6371: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
6372: color:$font;
1.948.2.3 raeburn 6373: border: 0;
6374: cursor:default;
1.741 harmsja 6375: }
1.693 droeschl 6376:
1.862 bisitz 6377: ul.LC_CourseBreadcrumbs {
6378: background: $sidebg;
6379: line-height: 32px;
6380: padding-left: 10px;
6381: margin: 0 0 10px 0;
6382: list-style-position: inside;
6383:
6384: }
6385:
1.911 bisitz 6386: ol#LC_MenuBreadcrumbs,
1.862 bisitz 6387: ol#LC_PathBreadcrumbs {
1.911 bisitz 6388: padding-left: 10px;
6389: margin: 0;
1.933 droeschl 6390: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 6391: }
6392:
1.911 bisitz 6393: ol#LC_MenuBreadcrumbs li,
6394: ol#LC_PathBreadcrumbs li,
1.862 bisitz 6395: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 6396: display: inline;
1.933 droeschl 6397: white-space: normal;
1.693 droeschl 6398: }
6399:
1.823 bisitz 6400: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 6401: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 6402: text-decoration: none;
6403: font-size:90%;
1.693 droeschl 6404: }
1.795 www 6405:
1.948.2.7 raeburn 6406: ol#LC_MenuBreadcrumbs h1 {
6407: display: inline;
6408: font-size: 90%;
6409: line-height: 2.5em;
6410: margin: 0;
6411: padding: 0;
6412: }
6413:
1.795 www 6414: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 6415: text-decoration:none;
6416: font-size:100%;
6417: font-weight:bold;
1.693 droeschl 6418: }
1.795 www 6419:
1.840 bisitz 6420: .LC_Box {
1.911 bisitz 6421: border: solid 1px $lg_border_color;
6422: padding: 0 10px 10px 10px;
1.746 neumanie 6423: }
1.795 www 6424:
6425: .LC_AboutMe_Image {
1.911 bisitz 6426: float:left;
6427: margin-right:10px;
1.747 neumanie 6428: }
1.795 www 6429:
6430: .LC_Clear_AboutMe_Image {
1.911 bisitz 6431: clear:left;
1.747 neumanie 6432: }
1.795 www 6433:
1.721 harmsja 6434: dl.LC_ListStyleClean dt {
1.911 bisitz 6435: padding-right: 5px;
6436: display: table-header-group;
1.693 droeschl 6437: }
6438:
1.721 harmsja 6439: dl.LC_ListStyleClean dd {
1.911 bisitz 6440: display: table-row;
1.693 droeschl 6441: }
6442:
1.721 harmsja 6443: .LC_ListStyleClean,
6444: .LC_ListStyleSimple,
6445: .LC_ListStyleNormal,
1.795 www 6446: .LC_ListStyleSpecial {
1.911 bisitz 6447: /* display:block; */
6448: list-style-position: inside;
6449: list-style-type: none;
6450: overflow: hidden;
6451: padding: 0;
1.693 droeschl 6452: }
6453:
1.721 harmsja 6454: .LC_ListStyleSimple li,
6455: .LC_ListStyleSimple dd,
6456: .LC_ListStyleNormal li,
6457: .LC_ListStyleNormal dd,
6458: .LC_ListStyleSpecial li,
1.795 www 6459: .LC_ListStyleSpecial dd {
1.911 bisitz 6460: margin: 0;
6461: padding: 5px 5px 5px 10px;
6462: clear: both;
1.693 droeschl 6463: }
6464:
1.721 harmsja 6465: .LC_ListStyleClean li,
6466: .LC_ListStyleClean dd {
1.911 bisitz 6467: padding-top: 0;
6468: padding-bottom: 0;
1.693 droeschl 6469: }
6470:
1.721 harmsja 6471: .LC_ListStyleSimple dd,
1.795 www 6472: .LC_ListStyleSimple li {
1.911 bisitz 6473: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6474: }
6475:
1.721 harmsja 6476: .LC_ListStyleSpecial li,
6477: .LC_ListStyleSpecial dd {
1.911 bisitz 6478: list-style-type: none;
6479: background-color: RGB(220, 220, 220);
6480: margin-bottom: 4px;
1.693 droeschl 6481: }
6482:
1.721 harmsja 6483: table.LC_SimpleTable {
1.911 bisitz 6484: margin:5px;
6485: border:solid 1px $lg_border_color;
1.795 www 6486: }
1.693 droeschl 6487:
1.721 harmsja 6488: table.LC_SimpleTable tr {
1.911 bisitz 6489: padding: 0;
6490: border:solid 1px $lg_border_color;
1.693 droeschl 6491: }
1.795 www 6492:
6493: table.LC_SimpleTable thead {
1.911 bisitz 6494: background:rgb(220,220,220);
1.693 droeschl 6495: }
6496:
1.721 harmsja 6497: div.LC_columnSection {
1.911 bisitz 6498: display: block;
6499: clear: both;
6500: overflow: hidden;
6501: margin: 0;
1.693 droeschl 6502: }
6503:
1.721 harmsja 6504: div.LC_columnSection>* {
1.911 bisitz 6505: float: left;
6506: margin: 10px 20px 10px 0;
6507: overflow:hidden;
1.693 droeschl 6508: }
1.721 harmsja 6509:
1.795 www 6510: table em {
1.911 bisitz 6511: font-weight: bold;
6512: font-style: normal;
1.748 schulted 6513: }
1.795 www 6514:
1.779 bisitz 6515: table.LC_tableBrowseRes,
1.795 www 6516: table.LC_tableOfContent {
1.911 bisitz 6517: border:none;
6518: border-spacing: 1px;
6519: padding: 3px;
6520: background-color: #FFFFFF;
6521: font-size: 90%;
1.753 droeschl 6522: }
1.789 droeschl 6523:
1.911 bisitz 6524: table.LC_tableOfContent {
6525: border-collapse: collapse;
1.789 droeschl 6526: }
6527:
1.771 droeschl 6528: table.LC_tableBrowseRes a,
1.768 schulted 6529: table.LC_tableOfContent a {
1.911 bisitz 6530: background-color: transparent;
6531: text-decoration: none;
1.753 droeschl 6532: }
6533:
1.795 www 6534: table.LC_tableOfContent img {
1.911 bisitz 6535: border: none;
6536: height: 1.3em;
6537: vertical-align: text-bottom;
6538: margin-right: 0.3em;
1.753 droeschl 6539: }
1.757 schulted 6540:
1.795 www 6541: a#LC_content_toolbar_firsthomework {
1.911 bisitz 6542: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 6543: }
6544:
1.795 www 6545: a#LC_content_toolbar_launchnav {
1.911 bisitz 6546: background-image:url(/res/adm/pages/start-navigation.gif);
1.774 ehlerst 6547: }
6548:
1.795 www 6549: a#LC_content_toolbar_closenav {
1.911 bisitz 6550: background-image:url(/res/adm/pages/close-navigation.gif);
1.774 ehlerst 6551: }
6552:
1.795 www 6553: a#LC_content_toolbar_everything {
1.911 bisitz 6554: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 6555: }
6556:
1.795 www 6557: a#LC_content_toolbar_uncompleted {
1.911 bisitz 6558: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 6559: }
6560:
1.795 www 6561: #LC_content_toolbar_clearbubbles {
1.911 bisitz 6562: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 6563: }
6564:
1.795 www 6565: a#LC_content_toolbar_changefolder {
1.911 bisitz 6566: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 6567: }
6568:
1.795 www 6569: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 6570: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 6571: }
6572:
1.795 www 6573: ul#LC_toolbar li a:hover {
1.911 bisitz 6574: background-position: bottom center;
1.757 schulted 6575: }
6576:
1.795 www 6577: ul#LC_toolbar {
1.911 bisitz 6578: padding: 0;
6579: margin: 2px;
6580: list-style:none;
6581: position:relative;
6582: background-color:white;
1.757 schulted 6583: }
6584:
1.795 www 6585: ul#LC_toolbar li {
1.911 bisitz 6586: border:1px solid white;
6587: padding: 0;
6588: margin: 0;
6589: float: left;
6590: display:inline;
6591: vertical-align:middle;
6592: }
1.757 schulted 6593:
1.783 amueller 6594:
1.795 www 6595: a.LC_toolbarItem {
1.911 bisitz 6596: display:block;
6597: padding: 0;
6598: margin: 0;
6599: height: 32px;
6600: width: 32px;
6601: color:white;
6602: border: none;
6603: background-repeat:no-repeat;
6604: background-color:transparent;
1.757 schulted 6605: }
6606:
1.915 droeschl 6607: ul.LC_funclist {
6608: margin: 0;
6609: padding: 0.5em 1em 0.5em 0;
6610: }
6611:
1.933 droeschl 6612: ul.LC_funclist > li:first-child {
6613: font-weight:bold;
6614: margin-left:0.8em;
6615: }
6616:
1.915 droeschl 6617: ul.LC_funclist + ul.LC_funclist {
6618: /*
6619: left border as a seperator if we have more than
6620: one list
6621: */
6622: border-left: 1px solid $sidebg;
6623: /*
6624: this hides the left border behind the border of the
6625: outer box if element is wrapped to the next 'line'
6626: */
6627: margin-left: -1px;
6628: }
6629:
1.843 bisitz 6630: ul.LC_funclist li {
1.915 droeschl 6631: display: inline;
1.782 bisitz 6632: white-space: nowrap;
1.915 droeschl 6633: margin: 0 0 0 25px;
6634: line-height: 150%;
1.782 bisitz 6635: }
6636:
1.930 faziophi 6637: .ui-accordion .LC_advanced_toggle {
6638: float: right;
6639: font-size: 90%;
6640: padding: 0px 4px
6641: }
1.757 schulted 6642:
1.343 albertel 6643: END
6644: }
6645:
1.306 albertel 6646: =pod
6647:
6648: =item * &headtag()
6649:
6650: Returns a uniform footer for LON-CAPA web pages.
6651:
1.307 albertel 6652: Inputs: $title - optional title for the head
6653: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 6654: $args - optional arguments
1.319 albertel 6655: force_register - if is true call registerurl so the remote is
6656: informed
1.415 albertel 6657: redirect -> array ref of
6658: 1- seconds before redirect occurs
6659: 2- url to redirect to
6660: 3- whether the side effect should occur
1.315 albertel 6661: (side effect of setting
6662: $env{'internal.head.redirect'} to the url
6663: redirected too)
1.352 albertel 6664: domain -> force to color decorate a page for a specific
6665: domain
6666: function -> force usage of a specific rolish color scheme
6667: bgcolor -> override the default page bgcolor
1.460 albertel 6668: no_auto_mt_title
6669: -> prevent &mt()ing the title arg
1.464 albertel 6670:
1.306 albertel 6671: =cut
6672:
6673: sub headtag {
1.313 albertel 6674: my ($title,$head_extra,$args) = @_;
1.306 albertel 6675:
1.363 albertel 6676: my $function = $args->{'function'} || &get_users_function();
6677: my $domain = $args->{'domain'} || &determinedomain();
6678: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 6679: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 6680: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 6681: #time(),
1.418 albertel 6682: $env{'environment.color.timestamp'},
1.363 albertel 6683: $function,$domain,$bgcolor);
6684:
1.369 www 6685: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 6686:
1.308 albertel 6687: my $result =
6688: '<head>'.
1.461 albertel 6689: &font_settings();
1.319 albertel 6690:
1.461 albertel 6691: if (!$args->{'frameset'}) {
6692: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
6693: }
1.319 albertel 6694: if ($args->{'force_register'}) {
6695: $result .= &Apache::lonmenu::registerurl(1);
6696: }
1.436 albertel 6697: if (!$args->{'no_nav_bar'}
6698: && !$args->{'only_body'}
6699: && !$args->{'frameset'}) {
6700: $result .= &help_menu_js();
6701: }
1.319 albertel 6702:
1.314 albertel 6703: if (ref($args->{'redirect'})) {
1.414 albertel 6704: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 6705: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 6706: if (!$inhibit_continue) {
6707: $env{'internal.head.redirect'} = $url;
6708: }
1.313 albertel 6709: $result.=<<ADDMETA
6710: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 6711: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 6712: ADDMETA
6713: }
1.306 albertel 6714: if (!defined($title)) {
6715: $title = 'The LearningOnline Network with CAPA';
6716: }
1.460 albertel 6717: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
6718: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 6719: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
6720: .$head_extra;
1.306 albertel 6721: return $result;
6722: }
6723:
6724: =pod
6725:
1.340 albertel 6726: =item * &font_settings()
6727:
6728: Returns neccessary <meta> to set the proper encoding
6729:
6730: Inputs: none
6731:
6732: =cut
6733:
6734: sub font_settings {
6735: my $headerstring='';
1.647 www 6736: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 6737: $headerstring.=
6738: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
6739: }
6740: return $headerstring;
6741: }
6742:
1.341 albertel 6743: =pod
6744:
6745: =item * &xml_begin()
6746:
6747: Returns the needed doctype and <html>
6748:
6749: Inputs: none
6750:
6751: =cut
6752:
6753: sub xml_begin {
6754: my $output='';
6755:
6756: if ($env{'browser.mathml'}) {
6757: $output='<?xml version="1.0"?>'
6758: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
6759: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
6760:
6761: # .'<!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">] >'
6762: .'<!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">'
6763: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
6764: .'xmlns="http://www.w3.org/1999/xhtml">';
6765: } else {
1.849 bisitz 6766: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
6767: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341 albertel 6768: }
6769: return $output;
6770: }
1.340 albertel 6771:
6772: =pod
6773:
1.306 albertel 6774: =item * &endheadtag()
6775:
6776: Returns a uniform </head> for LON-CAPA web pages.
6777:
6778: Inputs: none
6779:
6780: =cut
6781:
6782: sub endheadtag {
6783: return '</head>';
6784: }
6785:
6786: =pod
6787:
6788: =item * &head()
6789:
6790: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
6791:
1.648 raeburn 6792: Inputs:
6793:
6794: =over 4
6795:
6796: $title - optional title for the page
6797:
6798: $head_extra - optional extra HTML to put inside the <head>
6799:
6800: =back
1.405 albertel 6801:
1.306 albertel 6802: =cut
6803:
6804: sub head {
1.325 albertel 6805: my ($title,$head_extra,$args) = @_;
6806: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 6807: }
6808:
6809: =pod
6810:
6811: =item * &start_page()
6812:
6813: Returns a complete <html> .. <body> section for LON-CAPA web pages.
6814:
1.648 raeburn 6815: Inputs:
6816:
6817: =over 4
6818:
6819: $title - optional title for the page
6820:
6821: $head_extra - optional extra HTML to incude inside the <head>
6822:
6823: $args - additional optional args supported are:
6824:
6825: =over 8
6826:
6827: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 6828: arg on
1.814 bisitz 6829: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 6830: add_entries -> additional attributes to add to the <body>
6831: domain -> force to color decorate a page for a
1.317 albertel 6832: specific domain
1.648 raeburn 6833: function -> force usage of a specific rolish color
1.317 albertel 6834: scheme
1.648 raeburn 6835: redirect -> see &headtag()
6836: bgcolor -> override the default page bg color
6837: js_ready -> return a string ready for being used in
1.317 albertel 6838: a javascript writeln
1.648 raeburn 6839: html_encode -> return a string ready for being used in
1.320 albertel 6840: a html attribute
1.648 raeburn 6841: force_register -> if is true will turn on the &bodytag()
1.317 albertel 6842: $forcereg arg
1.648 raeburn 6843: frameset -> if true will start with a <frameset>
1.330 albertel 6844: rather than <body>
1.648 raeburn 6845: skip_phases -> hash ref of
1.338 albertel 6846: head -> skip the <html><head> generation
6847: body -> skip all <body> generation
1.648 raeburn 6848: no_inline_link -> if true and in remote mode, don't show the
1.361 albertel 6849: 'Switch To Inline Menu' link
1.648 raeburn 6850: no_auto_mt_title -> prevent &mt()ing the title arg
6851: inherit_jsmath -> when creating popup window in a page,
6852: should it have jsmath forced on by the
6853: current page
1.867 kalberla 6854: bread_crumbs -> Array containing breadcrumbs
1.948.2.12 raeburn 6855: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.361 albertel 6856:
1.648 raeburn 6857: =back
1.460 albertel 6858:
1.648 raeburn 6859: =back
1.562 albertel 6860:
1.306 albertel 6861: =cut
6862:
6863: sub start_page {
1.309 albertel 6864: my ($title,$head_extra,$args) = @_;
1.318 albertel 6865: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 6866: my %head_args;
1.352 albertel 6867: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6868: 'bgcolor','frameset','no_nav_bar','only_body',
6869: 'no_auto_mt_title') {
1.319 albertel 6870: if (defined($args->{$arg})) {
1.324 raeburn 6871: $head_args{$arg} = $args->{$arg};
1.319 albertel 6872: }
1.313 albertel 6873: }
1.319 albertel 6874:
1.315 albertel 6875: $env{'internal.start_page'}++;
1.338 albertel 6876: my $result;
6877: if (! exists($args->{'skip_phases'}{'head'}) ) {
6878: $result.=
1.341 albertel 6879: &xml_begin().
1.338 albertel 6880: &headtag($title,$head_extra,\%head_args).&endheadtag();
6881: }
6882:
6883: if (! exists($args->{'skip_phases'}{'body'}) ) {
6884: if ($args->{'frameset'}) {
6885: my $attr_string = &make_attr_string($args->{'force_register'},
6886: $args->{'add_entries'});
6887: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 6888: } else {
6889: $result .=
6890: &bodytag($title,
6891: $args->{'function'}, $args->{'add_entries'},
6892: $args->{'only_body'}, $args->{'domain'},
6893: $args->{'force_register'}, $args->{'no_nav_bar'},
6894: $args->{'bgcolor'}, $args->{'no_inline_link'},
6895: $args);
6896: }
1.330 albertel 6897: }
1.338 albertel 6898:
1.315 albertel 6899: if ($args->{'js_ready'}) {
1.713 kaisler 6900: $result = &js_ready($result);
1.315 albertel 6901: }
1.320 albertel 6902: if ($args->{'html_encode'}) {
1.713 kaisler 6903: $result = &html_encode($result);
6904: }
6905:
1.813 bisitz 6906: # Preparation for new and consistent functionlist at top of screen
6907: # if ($args->{'functionlist'}) {
6908: # $result .= &build_functionlist();
6909: #}
6910:
6911: # Don't add anything more if only_body wanted
6912: return $result if $args->{'only_body'};
6913:
1.920 raeburn 6914: #Breadcrumbs for Construction Space provided by &bodytag.
6915: if (($env{'environment.remote'} eq 'off') && ($env{'request.state'} eq 'construct')) {
6916: return $result;
6917: }
6918:
1.813 bisitz 6919: #Breadcrumbs
1.758 kaisler 6920: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
6921: &Apache::lonhtmlcommon::clear_breadcrumbs();
6922: #if any br links exists, add them to the breadcrumbs
6923: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6924: foreach my $crumb (@{$args->{'bread_crumbs'}}){
6925: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
6926: }
6927: }
6928:
6929: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
6930: if(exists($args->{'bread_crumbs_component'})){
6931: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
6932: }else{
6933: $result .= &Apache::lonhtmlcommon::breadcrumbs();
6934: }
1.320 albertel 6935: }
1.315 albertel 6936: return $result;
1.306 albertel 6937: }
6938:
1.330 albertel 6939:
1.306 albertel 6940: =pod
6941:
6942: =item * &head()
6943:
6944: Returns a complete </body></html> section for LON-CAPA web pages.
6945:
1.315 albertel 6946: Inputs: $args - additional optional args supported are:
6947: js_ready -> return a string ready for being used in
6948: a javascript writeln
1.320 albertel 6949: html_encode -> return a string ready for being used in
6950: a html attribute
1.330 albertel 6951: frameset -> if true will start with a <frameset>
6952: rather than <body>
1.493 albertel 6953: dicsussion -> if true will get discussion from
6954: lonxml::xmlend
6955: (you can pass the target and parser arguments
6956: through optional 'target' and 'parser' args
6957: to this routine)
1.306 albertel 6958:
6959: =cut
6960:
6961: sub end_page {
1.315 albertel 6962: my ($args) = @_;
6963: $env{'internal.end_page'}++;
1.330 albertel 6964: my $result;
1.335 albertel 6965: if ($args->{'discussion'}) {
6966: my ($target,$parser);
6967: if (ref($args->{'discussion'})) {
6968: ($target,$parser) =($args->{'discussion'}{'target'},
6969: $args->{'discussion'}{'parser'});
6970: }
6971: $result .= &Apache::lonxml::xmlend($target,$parser);
6972: }
6973:
1.330 albertel 6974: if ($args->{'frameset'}) {
6975: $result .= '</frameset>';
6976: } else {
1.635 raeburn 6977: $result .= &endbodytag($args);
1.330 albertel 6978: }
6979: $result .= "\n</html>";
6980:
1.315 albertel 6981: if ($args->{'js_ready'}) {
1.317 albertel 6982: $result = &js_ready($result);
1.315 albertel 6983: }
1.335 albertel 6984:
1.320 albertel 6985: if ($args->{'html_encode'}) {
6986: $result = &html_encode($result);
6987: }
1.335 albertel 6988:
1.315 albertel 6989: return $result;
6990: }
6991:
1.320 albertel 6992: sub html_encode {
6993: my ($result) = @_;
6994:
1.322 albertel 6995: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6996:
6997: return $result;
6998: }
1.317 albertel 6999: sub js_ready {
7000: my ($result) = @_;
7001:
1.323 albertel 7002: $result =~ s/[\n\r]/ /xmsg;
7003: $result =~ s/\\/\\\\/xmsg;
7004: $result =~ s/'/\\'/xmsg;
1.372 albertel 7005: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 7006:
7007: return $result;
7008: }
7009:
1.315 albertel 7010: sub validate_page {
7011: if ( exists($env{'internal.start_page'})
1.316 albertel 7012: && $env{'internal.start_page'} > 1) {
7013: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 7014: $env{'internal.start_page'}.' '.
1.316 albertel 7015: $ENV{'request.filename'});
1.315 albertel 7016: }
7017: if ( exists($env{'internal.end_page'})
1.316 albertel 7018: && $env{'internal.end_page'} > 1) {
7019: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 7020: $env{'internal.end_page'}.' '.
1.316 albertel 7021: $env{'request.filename'});
1.315 albertel 7022: }
7023: if ( exists($env{'internal.start_page'})
7024: && ! exists($env{'internal.end_page'})) {
1.316 albertel 7025: &Apache::lonnet::logthis('start_page called without end_page '.
7026: $env{'request.filename'});
1.315 albertel 7027: }
7028: if ( ! exists($env{'internal.start_page'})
7029: && exists($env{'internal.end_page'})) {
1.316 albertel 7030: &Apache::lonnet::logthis('end_page called without start_page'.
7031: $env{'request.filename'});
1.315 albertel 7032: }
1.306 albertel 7033: }
1.315 albertel 7034:
1.318 albertel 7035: sub simple_error_page {
7036: my ($r,$title,$msg) = @_;
7037: my $page =
7038: &Apache::loncommon::start_page($title).
7039: &mt($msg).
7040: &Apache::loncommon::end_page();
7041: if (ref($r)) {
7042: $r->print($page);
1.327 albertel 7043: return;
1.318 albertel 7044: }
7045: return $page;
7046: }
1.347 albertel 7047:
7048: {
1.610 albertel 7049: my @row_count;
1.948.2.5 raeburn 7050:
7051: sub start_data_table_count {
7052: unshift(@row_count, 0);
7053: return;
7054: }
7055:
7056: sub end_data_table_count {
7057: shift(@row_count);
7058: return;
7059: }
7060:
1.347 albertel 7061: sub start_data_table {
1.422 albertel 7062: my ($add_class) = @_;
7063: my $css_class = (join(' ','LC_data_table',$add_class));
1.948.2.5 raeburn 7064: &start_data_table_count();
1.422 albertel 7065: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 7066: }
7067:
7068: sub end_data_table {
1.948.2.5 raeburn 7069: &end_data_table_count();
1.389 albertel 7070: return '</table>'."\n";;
1.347 albertel 7071: }
7072:
7073: sub start_data_table_row {
1.422 albertel 7074: my ($add_class) = @_;
1.610 albertel 7075: $row_count[0]++;
7076: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 7077: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.422 albertel 7078: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 7079: }
1.471 banghart 7080:
7081: sub continue_data_table_row {
7082: my ($add_class) = @_;
1.610 albertel 7083: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 7084: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');;
1.471 banghart 7085: return '<tr class="'.$css_class.'">'."\n";;
7086: }
1.347 albertel 7087:
7088: sub end_data_table_row {
1.389 albertel 7089: return '</tr>'."\n";;
1.347 albertel 7090: }
1.367 www 7091:
1.421 albertel 7092: sub start_data_table_empty_row {
1.707 bisitz 7093: # $row_count[0]++;
1.421 albertel 7094: return '<tr class="LC_empty_row" >'."\n";;
7095: }
7096:
7097: sub end_data_table_empty_row {
7098: return '</tr>'."\n";;
7099: }
7100:
1.367 www 7101: sub start_data_table_header_row {
1.389 albertel 7102: return '<tr class="LC_header_row">'."\n";;
1.367 www 7103: }
7104:
7105: sub end_data_table_header_row {
1.389 albertel 7106: return '</tr>'."\n";;
1.367 www 7107: }
1.890 droeschl 7108:
7109: sub data_table_caption {
7110: my $caption = shift;
7111: return "<caption class=\"LC_caption\">$caption</caption>";
7112: }
1.347 albertel 7113: }
7114:
1.548 albertel 7115: =pod
7116:
7117: =item * &inhibit_menu_check($arg)
7118:
7119: Checks for a inhibitmenu state and generates output to preserve it
7120:
7121: Inputs: $arg - can be any of
7122: - undef - in which case the return value is a string
7123: to add into arguments list of a uri
7124: - 'input' - in which case the return value is a HTML
7125: <form> <input> field of type hidden to
7126: preserve the value
7127: - a url - in which case the return value is the url with
7128: the neccesary cgi args added to preserve the
7129: inhibitmenu state
7130: - a ref to a url - no return value, but the string is
7131: updated to include the neccessary cgi
7132: args to preserve the inhibitmenu state
7133:
7134: =cut
7135:
7136: sub inhibit_menu_check {
7137: my ($arg) = @_;
7138: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
7139: if ($arg eq 'input') {
7140: if ($env{'form.inhibitmenu'}) {
7141: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
7142: } else {
7143: return
7144: }
7145: }
7146: if ($env{'form.inhibitmenu'}) {
7147: if (ref($arg)) {
7148: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7149: } elsif ($arg eq '') {
7150: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
7151: } else {
7152: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7153: }
7154: }
7155: if (!ref($arg)) {
7156: return $arg;
7157: }
7158: }
7159:
1.251 albertel 7160: ###############################################
1.182 matthew 7161:
7162: =pod
7163:
1.549 albertel 7164: =back
7165:
7166: =head1 User Information Routines
7167:
7168: =over 4
7169:
1.405 albertel 7170: =item * &get_users_function()
1.182 matthew 7171:
7172: Used by &bodytag to determine the current users primary role.
7173: Returns either 'student','coordinator','admin', or 'author'.
7174:
7175: =cut
7176:
7177: ###############################################
7178: sub get_users_function {
1.815 tempelho 7179: my $function = 'norole';
1.818 tempelho 7180: if ($env{'request.role'}=~/^(st)/) {
7181: $function='student';
7182: }
1.907 raeburn 7183: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 7184: $function='coordinator';
7185: }
1.258 albertel 7186: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 7187: $function='admin';
7188: }
1.826 bisitz 7189: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182 matthew 7190: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
7191: $function='author';
7192: }
7193: return $function;
1.54 www 7194: }
1.99 www 7195:
7196: ###############################################
7197:
1.233 raeburn 7198: =pod
7199:
1.821 raeburn 7200: =item * &show_course()
7201:
7202: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
7203: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
7204:
7205: Inputs:
7206: None
7207:
7208: Outputs:
7209: Scalar: 1 if 'Course' to be used, 0 otherwise.
7210:
7211: =cut
7212:
7213: ###############################################
7214: sub show_course {
7215: my $course = !$env{'user.adv'};
7216: if (!$env{'user.adv'}) {
7217: foreach my $env (keys(%env)) {
7218: next if ($env !~ m/^user\.priv\./);
7219: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
7220: $course = 0;
7221: last;
7222: }
7223: }
7224: }
7225: return $course;
7226: }
7227:
7228: ###############################################
7229:
7230: =pod
7231:
1.542 raeburn 7232: =item * &check_user_status()
1.274 raeburn 7233:
7234: Determines current status of supplied role for a
7235: specific user. Roles can be active, previous or future.
7236:
7237: Inputs:
7238: user's domain, user's username, course's domain,
1.375 raeburn 7239: course's number, optional section ID.
1.274 raeburn 7240:
7241: Outputs:
7242: role status: active, previous or future.
7243:
7244: =cut
7245:
7246: sub check_user_status {
1.412 raeburn 7247: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.948.2.11 raeburn 7248: my $extra = &Apache::lonnet::freeze_escape({'skipcheck' => 1});
7249: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname,'.',undef,$extra);
1.274 raeburn 7250: my @uroles = keys %userinfo;
7251: my $srchstr;
7252: my $active_chk = 'none';
1.412 raeburn 7253: my $now = time;
1.274 raeburn 7254: if (@uroles > 0) {
1.908 raeburn 7255: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 7256: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
7257: } else {
1.412 raeburn 7258: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
7259: }
7260: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 7261: my $role_end = 0;
7262: my $role_start = 0;
7263: $active_chk = 'active';
1.412 raeburn 7264: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
7265: $role_end = $1;
7266: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
7267: $role_start = $1;
1.274 raeburn 7268: }
7269: }
7270: if ($role_start > 0) {
1.412 raeburn 7271: if ($now < $role_start) {
1.274 raeburn 7272: $active_chk = 'future';
7273: }
7274: }
7275: if ($role_end > 0) {
1.412 raeburn 7276: if ($now > $role_end) {
1.274 raeburn 7277: $active_chk = 'previous';
7278: }
7279: }
7280: }
7281: }
7282: return $active_chk;
7283: }
7284:
7285: ###############################################
7286:
7287: =pod
7288:
1.405 albertel 7289: =item * &get_sections()
1.233 raeburn 7290:
7291: Determines all the sections for a course including
7292: sections with students and sections containing other roles.
1.419 raeburn 7293: Incoming parameters:
7294:
7295: 1. domain
7296: 2. course number
7297: 3. reference to array containing roles for which sections should
7298: be gathered (optional).
7299: 4. reference to array containing status types for which sections
7300: should be gathered (optional).
7301:
7302: If the third argument is undefined, sections are gathered for any role.
7303: If the fourth argument is undefined, sections are gathered for any status.
7304: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 7305:
1.374 raeburn 7306: Returns section hash (keys are section IDs, values are
7307: number of users in each section), subject to the
1.419 raeburn 7308: optional roles filter, optional status filter
1.233 raeburn 7309:
7310: =cut
7311:
7312: ###############################################
7313: sub get_sections {
1.419 raeburn 7314: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 7315: if (!defined($cdom) || !defined($cnum)) {
7316: my $cid = $env{'request.course.id'};
7317:
7318: return if (!defined($cid));
7319:
7320: $cdom = $env{'course.'.$cid.'.domain'};
7321: $cnum = $env{'course.'.$cid.'.num'};
7322: }
7323:
7324: my %sectioncount;
1.419 raeburn 7325: my $now = time;
1.240 albertel 7326:
1.366 albertel 7327: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 7328: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 7329: my $sec_index = &Apache::loncoursedata::CL_SECTION();
7330: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 7331: my $start_index = &Apache::loncoursedata::CL_START();
7332: my $end_index = &Apache::loncoursedata::CL_END();
7333: my $status;
1.366 albertel 7334: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 7335: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
7336: $data->[$status_index],
7337: $data->[$start_index],
7338: $data->[$end_index]);
7339: if ($stu_status eq 'Active') {
7340: $status = 'active';
7341: } elsif ($end < $now) {
7342: $status = 'previous';
7343: } elsif ($start > $now) {
7344: $status = 'future';
7345: }
7346: if ($section ne '-1' && $section !~ /^\s*$/) {
7347: if ((!defined($possible_status)) || (($status ne '') &&
7348: (grep/^\Q$status\E$/,@{$possible_status}))) {
7349: $sectioncount{$section}++;
7350: }
1.240 albertel 7351: }
7352: }
7353: }
7354: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7355: foreach my $user (sort(keys(%courseroles))) {
7356: if ($user !~ /^(\w{2})/) { next; }
7357: my ($role) = ($user =~ /^(\w{2})/);
7358: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 7359: my ($section,$status);
1.240 albertel 7360: if ($role eq 'cr' &&
7361: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
7362: $section=$1;
7363: }
7364: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
7365: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 7366: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
7367: if ($end == -1 && $start == -1) {
7368: next; #deleted role
7369: }
7370: if (!defined($possible_status)) {
7371: $sectioncount{$section}++;
7372: } else {
7373: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
7374: $status = 'active';
7375: } elsif ($end < $now) {
7376: $status = 'future';
7377: } elsif ($start > $now) {
7378: $status = 'previous';
7379: }
7380: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
7381: $sectioncount{$section}++;
7382: }
7383: }
1.233 raeburn 7384: }
1.366 albertel 7385: return %sectioncount;
1.233 raeburn 7386: }
7387:
1.274 raeburn 7388: ###############################################
1.294 raeburn 7389:
7390: =pod
1.405 albertel 7391:
7392: =item * &get_course_users()
7393:
1.275 raeburn 7394: Retrieves usernames:domains for users in the specified course
7395: with specific role(s), and access status.
7396:
7397: Incoming parameters:
1.277 albertel 7398: 1. course domain
7399: 2. course number
7400: 3. access status: users must have - either active,
1.275 raeburn 7401: previous, future, or all.
1.277 albertel 7402: 4. reference to array of permissible roles
1.288 raeburn 7403: 5. reference to array of section restrictions (optional)
7404: 6. reference to results object (hash of hashes).
7405: 7. reference to optional userdata hash
1.609 raeburn 7406: 8. reference to optional statushash
1.630 raeburn 7407: 9. flag if privileged users (except those set to unhide in
7408: course settings) should be excluded
1.609 raeburn 7409: Keys of top level results hash are roles.
1.275 raeburn 7410: Keys of inner hashes are username:domain, with
7411: values set to access type.
1.288 raeburn 7412: Optional userdata hash returns an array with arguments in the
7413: same order as loncoursedata::get_classlist() for student data.
7414:
1.609 raeburn 7415: Optional statushash returns
7416:
1.288 raeburn 7417: Entries for end, start, section and status are blank because
7418: of the possibility of multiple values for non-student roles.
7419:
1.275 raeburn 7420: =cut
1.405 albertel 7421:
1.275 raeburn 7422: ###############################################
1.405 albertel 7423:
1.275 raeburn 7424: sub get_course_users {
1.630 raeburn 7425: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 7426: my %idx = ();
1.419 raeburn 7427: my %seclists;
1.288 raeburn 7428:
7429: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
7430: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
7431: $idx{end} = &Apache::loncoursedata::CL_END();
7432: $idx{start} = &Apache::loncoursedata::CL_START();
7433: $idx{id} = &Apache::loncoursedata::CL_ID();
7434: $idx{section} = &Apache::loncoursedata::CL_SECTION();
7435: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
7436: $idx{status} = &Apache::loncoursedata::CL_STATUS();
7437:
1.290 albertel 7438: if (grep(/^st$/,@{$roles})) {
1.276 albertel 7439: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 7440: my $now = time;
1.277 albertel 7441: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 7442: my $match = 0;
1.412 raeburn 7443: my $secmatch = 0;
1.419 raeburn 7444: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 7445: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 7446: if ($section eq '') {
7447: $section = 'none';
7448: }
1.291 albertel 7449: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7450: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7451: $secmatch = 1;
7452: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 7453: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7454: $secmatch = 1;
7455: }
7456: } else {
1.419 raeburn 7457: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 7458: $secmatch = 1;
7459: }
1.290 albertel 7460: }
1.412 raeburn 7461: if (!$secmatch) {
7462: next;
7463: }
1.419 raeburn 7464: }
1.275 raeburn 7465: if (defined($$types{'active'})) {
1.288 raeburn 7466: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 7467: push(@{$$users{st}{$student}},'active');
1.288 raeburn 7468: $match = 1;
1.275 raeburn 7469: }
7470: }
7471: if (defined($$types{'previous'})) {
1.609 raeburn 7472: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 7473: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 7474: $match = 1;
1.275 raeburn 7475: }
7476: }
7477: if (defined($$types{'future'})) {
1.609 raeburn 7478: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 7479: push(@{$$users{st}{$student}},'future');
1.288 raeburn 7480: $match = 1;
1.275 raeburn 7481: }
7482: }
1.609 raeburn 7483: if ($match) {
7484: push(@{$seclists{$student}},$section);
7485: if (ref($userdata) eq 'HASH') {
7486: $$userdata{$student} = $$classlist{$student};
7487: }
7488: if (ref($statushash) eq 'HASH') {
7489: $statushash->{$student}{'st'}{$section} = $status;
7490: }
1.288 raeburn 7491: }
1.275 raeburn 7492: }
7493: }
1.412 raeburn 7494: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 7495: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7496: my $now = time;
1.609 raeburn 7497: my %displaystatus = ( previous => 'Expired',
7498: active => 'Active',
7499: future => 'Future',
7500: );
1.630 raeburn 7501: my %nothide;
7502: if ($hidepriv) {
7503: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
7504: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
7505: if ($user !~ /:/) {
7506: $nothide{join(':',split(/[\@]/,$user))}=1;
7507: } else {
7508: $nothide{$user} = 1;
7509: }
7510: }
7511: }
1.439 raeburn 7512: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 7513: my $match = 0;
1.412 raeburn 7514: my $secmatch = 0;
1.439 raeburn 7515: my $status;
1.412 raeburn 7516: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 7517: $user =~ s/:$//;
1.439 raeburn 7518: my ($end,$start) = split(/:/,$coursepersonnel{$person});
7519: if ($end == -1 || $start == -1) {
7520: next;
7521: }
7522: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
7523: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 7524: my ($uname,$udom) = split(/:/,$user);
7525: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7526: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7527: $secmatch = 1;
7528: } elsif ($usec eq '') {
1.420 albertel 7529: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7530: $secmatch = 1;
7531: }
7532: } else {
7533: if (grep(/^\Q$usec\E$/,@{$sections})) {
7534: $secmatch = 1;
7535: }
7536: }
7537: if (!$secmatch) {
7538: next;
7539: }
1.288 raeburn 7540: }
1.419 raeburn 7541: if ($usec eq '') {
7542: $usec = 'none';
7543: }
1.275 raeburn 7544: if ($uname ne '' && $udom ne '') {
1.630 raeburn 7545: if ($hidepriv) {
7546: if ((&Apache::lonnet::privileged($uname,$udom)) &&
7547: (!$nothide{$uname.':'.$udom})) {
7548: next;
7549: }
7550: }
1.503 raeburn 7551: if ($end > 0 && $end < $now) {
1.439 raeburn 7552: $status = 'previous';
7553: } elsif ($start > $now) {
7554: $status = 'future';
7555: } else {
7556: $status = 'active';
7557: }
1.277 albertel 7558: foreach my $type (keys(%{$types})) {
1.275 raeburn 7559: if ($status eq $type) {
1.420 albertel 7560: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 7561: push(@{$$users{$role}{$user}},$type);
7562: }
1.288 raeburn 7563: $match = 1;
7564: }
7565: }
1.419 raeburn 7566: if (($match) && (ref($userdata) eq 'HASH')) {
7567: if (!exists($$userdata{$uname.':'.$udom})) {
7568: &get_user_info($udom,$uname,\%idx,$userdata);
7569: }
1.420 albertel 7570: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 7571: push(@{$seclists{$uname.':'.$udom}},$usec);
7572: }
1.609 raeburn 7573: if (ref($statushash) eq 'HASH') {
7574: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
7575: }
1.275 raeburn 7576: }
7577: }
7578: }
7579: }
1.290 albertel 7580: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 7581: if ((defined($cdom)) && (defined($cnum))) {
7582: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
7583: if ( defined($csettings{'internal.courseowner'}) ) {
7584: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 7585: next if ($owner eq '');
7586: my ($ownername,$ownerdom);
7587: if ($owner =~ /^([^:]+):([^:]+)$/) {
7588: $ownername = $1;
7589: $ownerdom = $2;
7590: } else {
7591: $ownername = $owner;
7592: $ownerdom = $cdom;
7593: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 7594: }
7595: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 7596: if (defined($userdata) &&
1.609 raeburn 7597: !exists($$userdata{$owner})) {
7598: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
7599: if (!grep(/^none$/,@{$seclists{$owner}})) {
7600: push(@{$seclists{$owner}},'none');
7601: }
7602: if (ref($statushash) eq 'HASH') {
7603: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 7604: }
1.290 albertel 7605: }
1.279 raeburn 7606: }
7607: }
7608: }
1.419 raeburn 7609: foreach my $user (keys(%seclists)) {
7610: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
7611: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
7612: }
1.275 raeburn 7613: }
7614: return;
7615: }
7616:
1.288 raeburn 7617: sub get_user_info {
7618: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 7619: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
7620: &plainname($uname,$udom,'lastname');
1.291 albertel 7621: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 7622: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 7623: my %idhash = &Apache::lonnet::idrget($udom,($uname));
7624: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 7625: return;
7626: }
1.275 raeburn 7627:
1.472 raeburn 7628: ###############################################
7629:
7630: =pod
7631:
7632: =item * &get_user_quota()
7633:
7634: Retrieves quota assigned for storage of portfolio files for a user
7635:
7636: Incoming parameters:
7637: 1. user's username
7638: 2. user's domain
7639:
7640: Returns:
1.536 raeburn 7641: 1. Disk quota (in Mb) assigned to student.
7642: 2. (Optional) Type of setting: custom or default
7643: (individually assigned or default for user's
7644: institutional status).
7645: 3. (Optional) - User's institutional status (e.g., faculty, staff
7646: or student - types as defined in localenroll::inst_usertypes
7647: for user's domain, which determines default quota for user.
7648: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 7649:
7650: If a value has been stored in the user's environment,
1.536 raeburn 7651: it will return that, otherwise it returns the maximal default
7652: defined for the user's instituional status(es) in the domain.
1.472 raeburn 7653:
7654: =cut
7655:
7656: ###############################################
7657:
7658:
7659: sub get_user_quota {
7660: my ($uname,$udom) = @_;
1.536 raeburn 7661: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 7662: if (!defined($udom)) {
7663: $udom = $env{'user.domain'};
7664: }
7665: if (!defined($uname)) {
7666: $uname = $env{'user.name'};
7667: }
7668: if (($udom eq '' || $uname eq '') ||
7669: ($udom eq 'public') && ($uname eq 'public')) {
7670: $quota = 0;
1.536 raeburn 7671: $quotatype = 'default';
7672: $defquota = 0;
1.472 raeburn 7673: } else {
1.536 raeburn 7674: my $inststatus;
1.472 raeburn 7675: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
7676: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 7677: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 7678: } else {
1.536 raeburn 7679: my %userenv =
7680: &Apache::lonnet::get('environment',['portfolioquota',
7681: 'inststatus'],$udom,$uname);
1.472 raeburn 7682: my ($tmp) = keys(%userenv);
7683: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7684: $quota = $userenv{'portfolioquota'};
1.536 raeburn 7685: $inststatus = $userenv{'inststatus'};
1.472 raeburn 7686: } else {
7687: undef(%userenv);
7688: }
7689: }
1.536 raeburn 7690: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 7691: if ($quota eq '') {
1.536 raeburn 7692: $quota = $defquota;
7693: $quotatype = 'default';
7694: } else {
7695: $quotatype = 'custom';
1.472 raeburn 7696: }
7697: }
1.536 raeburn 7698: if (wantarray) {
7699: return ($quota,$quotatype,$settingstatus,$defquota);
7700: } else {
7701: return $quota;
7702: }
1.472 raeburn 7703: }
7704:
7705: ###############################################
7706:
7707: =pod
7708:
7709: =item * &default_quota()
7710:
1.536 raeburn 7711: Retrieves default quota assigned for storage of user portfolio files,
7712: given an (optional) user's institutional status.
1.472 raeburn 7713:
7714: Incoming parameters:
7715: 1. domain
1.536 raeburn 7716: 2. (Optional) institutional status(es). This is a : separated list of
7717: status types (e.g., faculty, staff, student etc.)
7718: which apply to the user for whom the default is being retrieved.
7719: If the institutional status string in undefined, the domain
7720: default quota will be returned.
1.472 raeburn 7721:
7722: Returns:
7723: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 7724: 2. (Optional) institutional type which determined the value of the
7725: default quota.
1.472 raeburn 7726:
7727: If a value has been stored in the domain's configuration db,
7728: it will return that, otherwise it returns 20 (for backwards
7729: compatibility with domains which have not set up a configuration
7730: db file; the original statically defined portfolio quota was 20 Mb).
7731:
1.536 raeburn 7732: If the user's status includes multiple types (e.g., staff and student),
7733: the largest default quota which applies to the user determines the
7734: default quota returned.
7735:
1.780 raeburn 7736: =back
7737:
1.472 raeburn 7738: =cut
7739:
7740: ###############################################
7741:
7742:
7743: sub default_quota {
1.536 raeburn 7744: my ($udom,$inststatus) = @_;
7745: my ($defquota,$settingstatus);
7746: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 7747: ['quotas'],$udom);
7748: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 7749: if ($inststatus ne '') {
1.765 raeburn 7750: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 7751: foreach my $item (@statuses) {
1.711 raeburn 7752: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7753: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
7754: if ($defquota eq '') {
7755: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7756: $settingstatus = $item;
7757: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
7758: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7759: $settingstatus = $item;
7760: }
7761: }
7762: } else {
7763: if ($quotahash{'quotas'}{$item} ne '') {
7764: if ($defquota eq '') {
7765: $defquota = $quotahash{'quotas'}{$item};
7766: $settingstatus = $item;
7767: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
7768: $defquota = $quotahash{'quotas'}{$item};
7769: $settingstatus = $item;
7770: }
1.536 raeburn 7771: }
7772: }
7773: }
7774: }
7775: if ($defquota eq '') {
1.711 raeburn 7776: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7777: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
7778: } else {
7779: $defquota = $quotahash{'quotas'}{'default'};
7780: }
1.536 raeburn 7781: $settingstatus = 'default';
7782: }
7783: } else {
7784: $settingstatus = 'default';
7785: $defquota = 20;
7786: }
7787: if (wantarray) {
7788: return ($defquota,$settingstatus);
1.472 raeburn 7789: } else {
1.536 raeburn 7790: return $defquota;
1.472 raeburn 7791: }
7792: }
7793:
1.384 raeburn 7794: sub get_secgrprole_info {
7795: my ($cdom,$cnum,$needroles,$type) = @_;
7796: my %sections_count = &get_sections($cdom,$cnum);
7797: my @sections = (sort {$a <=> $b} keys(%sections_count));
7798: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
7799: my @groups = sort(keys(%curr_groups));
7800: my $allroles = [];
7801: my $rolehash;
7802: my $accesshash = {
7803: active => 'Currently has access',
7804: future => 'Will have future access',
7805: previous => 'Previously had access',
7806: };
7807: if ($needroles) {
7808: $rolehash = {'all' => 'all'};
1.385 albertel 7809: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7810: if (&Apache::lonnet::error(%user_roles)) {
7811: undef(%user_roles);
7812: }
7813: foreach my $item (keys(%user_roles)) {
1.384 raeburn 7814: my ($role)=split(/\:/,$item,2);
7815: if ($role eq 'cr') { next; }
7816: if ($role =~ /^cr/) {
7817: $$rolehash{$role} = (split('/',$role))[3];
7818: } else {
7819: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
7820: }
7821: }
7822: foreach my $key (sort(keys(%{$rolehash}))) {
7823: push(@{$allroles},$key);
7824: }
7825: push (@{$allroles},'st');
7826: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
7827: }
7828: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
7829: }
7830:
1.555 raeburn 7831: sub user_picker {
1.948.2.23 raeburn 7832: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context) = @_;
1.555 raeburn 7833: my $currdom = $dom;
7834: my %curr_selected = (
7835: srchin => 'dom',
1.580 raeburn 7836: srchby => 'lastname',
1.555 raeburn 7837: );
7838: my $srchterm;
1.625 raeburn 7839: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 7840: if ($srch->{'srchby'} ne '') {
7841: $curr_selected{'srchby'} = $srch->{'srchby'};
7842: }
7843: if ($srch->{'srchin'} ne '') {
7844: $curr_selected{'srchin'} = $srch->{'srchin'};
7845: }
7846: if ($srch->{'srchtype'} ne '') {
7847: $curr_selected{'srchtype'} = $srch->{'srchtype'};
7848: }
7849: if ($srch->{'srchdomain'} ne '') {
7850: $currdom = $srch->{'srchdomain'};
7851: }
7852: $srchterm = $srch->{'srchterm'};
7853: }
7854: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 7855: 'usr' => 'Search criteria',
1.563 raeburn 7856: 'doma' => 'Domain/institution to search',
1.558 albertel 7857: 'uname' => 'username',
7858: 'lastname' => 'last name',
1.555 raeburn 7859: 'lastfirst' => 'last name, first name',
1.558 albertel 7860: 'crs' => 'in this course',
1.576 raeburn 7861: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 7862: 'alc' => 'all LON-CAPA',
1.573 raeburn 7863: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 7864: 'exact' => 'is',
7865: 'contains' => 'contains',
1.569 raeburn 7866: 'begins' => 'begins with',
1.571 raeburn 7867: 'youm' => "You must include some text to search for.",
7868: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
7869: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
7870: 'yomc' => "You must choose a domain when using an institutional directory search.",
7871: 'ymcd' => "You must choose a domain when using a domain search.",
7872: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
7873: 'whse' => "When searching by last,first you must include at least one character in the first name.",
7874: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 7875: );
1.563 raeburn 7876: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
7877: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 7878:
7879: my @srchins = ('crs','dom','alc','instd');
7880:
7881: foreach my $option (@srchins) {
7882: # FIXME 'alc' option unavailable until
7883: # loncreateuser::print_user_query_page()
7884: # has been completed.
7885: next if ($option eq 'alc');
1.880 raeburn 7886: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 7887: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 7888: if ($curr_selected{'srchin'} eq $option) {
7889: $srchinsel .= '
7890: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7891: } else {
7892: $srchinsel .= '
7893: <option value="'.$option.'">'.$lt{$option}.'</option>';
7894: }
1.555 raeburn 7895: }
1.563 raeburn 7896: $srchinsel .= "\n </select>\n";
1.555 raeburn 7897:
7898: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 7899: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 7900: if ($curr_selected{'srchby'} eq $option) {
7901: $srchbysel .= '
7902: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7903: } else {
7904: $srchbysel .= '
7905: <option value="'.$option.'">'.$lt{$option}.'</option>';
7906: }
7907: }
7908: $srchbysel .= "\n </select>\n";
7909:
7910: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 7911: foreach my $option ('begins','contains','exact') {
1.555 raeburn 7912: if ($curr_selected{'srchtype'} eq $option) {
7913: $srchtypesel .= '
7914: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7915: } else {
7916: $srchtypesel .= '
7917: <option value="'.$option.'">'.$lt{$option}.'</option>';
7918: }
7919: }
7920: $srchtypesel .= "\n </select>\n";
7921:
1.558 albertel 7922: my ($newuserscript,$new_user_create);
1.948.2.23 raeburn 7923: my $context_dom = $env{'request.role.domain'};
7924: if ($context eq 'requestcrs') {
7925: if ($env{'form.coursedom'} ne '') {
7926: $context_dom = $env{'form.coursedom'};
7927: }
7928: }
1.556 raeburn 7929: if ($forcenewuser) {
1.576 raeburn 7930: if (ref($srch) eq 'HASH') {
1.948.2.23 raeburn 7931: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 7932: if ($cancreate) {
7933: $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>';
7934: } else {
1.799 bisitz 7935: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 7936: my %usertypetext = (
7937: official => 'institutional',
7938: unofficial => 'non-institutional',
7939: );
1.799 bisitz 7940: $new_user_create = '<p class="LC_warning">'
7941: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
7942: .' '
7943: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
7944: ,'<a href="'.$helplink.'">','</a>')
7945: .'</p><br />';
1.627 raeburn 7946: }
1.576 raeburn 7947: }
7948: }
7949:
1.556 raeburn 7950: $newuserscript = <<"ENDSCRIPT";
7951:
1.570 raeburn 7952: function setSearch(createnew,callingForm) {
1.556 raeburn 7953: if (createnew == 1) {
1.570 raeburn 7954: for (var i=0; i<callingForm.srchby.length; i++) {
7955: if (callingForm.srchby.options[i].value == 'uname') {
7956: callingForm.srchby.selectedIndex = i;
1.556 raeburn 7957: }
7958: }
1.570 raeburn 7959: for (var i=0; i<callingForm.srchin.length; i++) {
7960: if ( callingForm.srchin.options[i].value == 'dom') {
7961: callingForm.srchin.selectedIndex = i;
1.556 raeburn 7962: }
7963: }
1.570 raeburn 7964: for (var i=0; i<callingForm.srchtype.length; i++) {
7965: if (callingForm.srchtype.options[i].value == 'exact') {
7966: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 7967: }
7968: }
1.570 raeburn 7969: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.948.2.23 raeburn 7970: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 7971: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 7972: }
7973: }
7974: }
7975: }
7976: ENDSCRIPT
1.558 albertel 7977:
1.556 raeburn 7978: }
7979:
1.555 raeburn 7980: my $output = <<"END_BLOCK";
1.556 raeburn 7981: <script type="text/javascript">
1.824 bisitz 7982: // <![CDATA[
1.570 raeburn 7983: function validateEntry(callingForm) {
1.558 albertel 7984:
1.556 raeburn 7985: var checkok = 1;
1.558 albertel 7986: var srchin;
1.570 raeburn 7987: for (var i=0; i<callingForm.srchin.length; i++) {
7988: if ( callingForm.srchin[i].checked ) {
7989: srchin = callingForm.srchin[i].value;
1.558 albertel 7990: }
7991: }
7992:
1.570 raeburn 7993: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7994: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7995: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7996: var srchterm = callingForm.srchterm.value;
7997: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7998: var msg = "";
7999:
8000: if (srchterm == "") {
8001: checkok = 0;
1.571 raeburn 8002: msg += "$lt{'youm'}\\n";
1.556 raeburn 8003: }
8004:
1.569 raeburn 8005: if (srchtype== 'begins') {
8006: if (srchterm.length < 2) {
8007: checkok = 0;
1.571 raeburn 8008: msg += "$lt{'thte'}\\n";
1.569 raeburn 8009: }
8010: }
8011:
1.556 raeburn 8012: if (srchtype== 'contains') {
8013: if (srchterm.length < 3) {
8014: checkok = 0;
1.571 raeburn 8015: msg += "$lt{'thet'}\\n";
1.556 raeburn 8016: }
8017: }
8018: if (srchin == 'instd') {
8019: if (srchdomain == '') {
8020: checkok = 0;
1.571 raeburn 8021: msg += "$lt{'yomc'}\\n";
1.556 raeburn 8022: }
8023: }
8024: if (srchin == 'dom') {
8025: if (srchdomain == '') {
8026: checkok = 0;
1.571 raeburn 8027: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 8028: }
8029: }
8030: if (srchby == 'lastfirst') {
8031: if (srchterm.indexOf(",") == -1) {
8032: checkok = 0;
1.571 raeburn 8033: msg += "$lt{'whus'}\\n";
1.556 raeburn 8034: }
8035: if (srchterm.indexOf(",") == srchterm.length -1) {
8036: checkok = 0;
1.571 raeburn 8037: msg += "$lt{'whse'}\\n";
1.556 raeburn 8038: }
8039: }
8040: if (checkok == 0) {
1.571 raeburn 8041: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 8042: return;
8043: }
8044: if (checkok == 1) {
1.570 raeburn 8045: callingForm.submit();
1.556 raeburn 8046: }
8047: }
8048:
8049: $newuserscript
8050:
1.824 bisitz 8051: // ]]>
1.556 raeburn 8052: </script>
1.558 albertel 8053:
8054: $new_user_create
8055:
1.555 raeburn 8056: END_BLOCK
1.558 albertel 8057:
1.876 raeburn 8058: $output .= &Apache::lonhtmlcommon::start_pick_box().
8059: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
8060: $domform.
8061: &Apache::lonhtmlcommon::row_closure().
8062: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
8063: $srchbysel.
8064: $srchtypesel.
8065: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
8066: $srchinsel.
8067: &Apache::lonhtmlcommon::row_closure(1).
8068: &Apache::lonhtmlcommon::end_pick_box().
8069: '<br />';
1.555 raeburn 8070: return $output;
8071: }
8072:
1.612 raeburn 8073: sub user_rule_check {
1.615 raeburn 8074: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 8075: my $response;
8076: if (ref($usershash) eq 'HASH') {
8077: foreach my $user (keys(%{$usershash})) {
8078: my ($uname,$udom) = split(/:/,$user);
8079: next if ($udom eq '' || $uname eq '');
1.615 raeburn 8080: my ($id,$newuser);
1.612 raeburn 8081: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 8082: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 8083: $id = $usershash->{$user}->{'id'};
8084: }
8085: my $inst_response;
8086: if (ref($checks) eq 'HASH') {
8087: if (defined($checks->{'username'})) {
1.615 raeburn 8088: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 8089: &Apache::lonnet::get_instuser($udom,$uname);
8090: } elsif (defined($checks->{'id'})) {
1.615 raeburn 8091: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 8092: &Apache::lonnet::get_instuser($udom,undef,$id);
8093: }
1.615 raeburn 8094: } else {
8095: ($inst_response,%{$inst_results->{$user}}) =
8096: &Apache::lonnet::get_instuser($udom,$uname);
8097: return;
1.612 raeburn 8098: }
1.615 raeburn 8099: if (!$got_rules->{$udom}) {
1.612 raeburn 8100: my %domconfig = &Apache::lonnet::get_dom('configuration',
8101: ['usercreation'],$udom);
8102: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 8103: foreach my $item ('username','id') {
1.612 raeburn 8104: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
8105: $$curr_rules{$udom}{$item} =
8106: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 8107: }
8108: }
8109: }
1.615 raeburn 8110: $got_rules->{$udom} = 1;
1.585 raeburn 8111: }
1.612 raeburn 8112: foreach my $item (keys(%{$checks})) {
8113: if (ref($$curr_rules{$udom}) eq 'HASH') {
8114: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
8115: if (@{$$curr_rules{$udom}{$item}} > 0) {
8116: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
8117: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
8118: if ($rule_check{$rule}) {
8119: $$rulematch{$user}{$item} = $rule;
8120: if ($inst_response eq 'ok') {
1.615 raeburn 8121: if (ref($inst_results) eq 'HASH') {
8122: if (ref($inst_results->{$user}) eq 'HASH') {
8123: if (keys(%{$inst_results->{$user}}) == 0) {
8124: $$alerts{$item}{$udom}{$uname} = 1;
8125: }
1.612 raeburn 8126: }
8127: }
1.615 raeburn 8128: }
8129: last;
1.585 raeburn 8130: }
8131: }
8132: }
8133: }
8134: }
8135: }
8136: }
8137: }
1.612 raeburn 8138: return;
8139: }
8140:
8141: sub user_rule_formats {
8142: my ($domain,$domdesc,$curr_rules,$check) = @_;
8143: my %text = (
8144: 'username' => 'Usernames',
8145: 'id' => 'IDs',
8146: );
8147: my $output;
8148: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
8149: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
8150: if (@{$ruleorder} > 0) {
8151: $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>';
8152: foreach my $rule (@{$ruleorder}) {
8153: if (ref($curr_rules) eq 'ARRAY') {
8154: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
8155: if (ref($rules->{$rule}) eq 'HASH') {
8156: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
8157: $rules->{$rule}{'desc'}.'</li>';
8158: }
8159: }
8160: }
8161: }
8162: $output .= '</ul>';
8163: }
8164: }
8165: return $output;
8166: }
8167:
8168: sub instrule_disallow_msg {
1.615 raeburn 8169: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 8170: my $response;
8171: my %text = (
8172: item => 'username',
8173: items => 'usernames',
8174: match => 'matches',
8175: do => 'does',
8176: action => 'a username',
8177: one => 'one',
8178: );
8179: if ($count > 1) {
8180: $text{'item'} = 'usernames';
8181: $text{'match'} ='match';
8182: $text{'do'} = 'do';
8183: $text{'action'} = 'usernames',
8184: $text{'one'} = 'ones';
8185: }
8186: if ($checkitem eq 'id') {
8187: $text{'items'} = 'IDs';
8188: $text{'item'} = 'ID';
8189: $text{'action'} = 'an ID';
1.615 raeburn 8190: if ($count > 1) {
8191: $text{'item'} = 'IDs';
8192: $text{'action'} = 'IDs';
8193: }
1.612 raeburn 8194: }
1.674 bisitz 8195: $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 8196: if ($mode eq 'upload') {
8197: if ($checkitem eq 'username') {
8198: $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'}.");
8199: } elsif ($checkitem eq 'id') {
1.674 bisitz 8200: $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 8201: }
1.669 raeburn 8202: } elsif ($mode eq 'selfcreate') {
8203: if ($checkitem eq 'id') {
8204: $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.");
8205: }
1.615 raeburn 8206: } else {
8207: if ($checkitem eq 'username') {
8208: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
8209: } elsif ($checkitem eq 'id') {
8210: $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.");
8211: }
1.612 raeburn 8212: }
8213: return $response;
1.585 raeburn 8214: }
8215:
1.624 raeburn 8216: sub personal_data_fieldtitles {
8217: my %fieldtitles = &Apache::lonlocal::texthash (
8218: id => 'Student/Employee ID',
8219: permanentemail => 'E-mail address',
8220: lastname => 'Last Name',
8221: firstname => 'First Name',
8222: middlename => 'Middle Name',
8223: generation => 'Generation',
8224: gen => 'Generation',
1.765 raeburn 8225: inststatus => 'Affiliation',
1.624 raeburn 8226: );
8227: return %fieldtitles;
8228: }
8229:
1.642 raeburn 8230: sub sorted_inst_types {
8231: my ($dom) = @_;
8232: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
8233: my $othertitle = &mt('All users');
8234: if ($env{'request.course.id'}) {
1.668 raeburn 8235: $othertitle = &mt('Any users');
1.642 raeburn 8236: }
8237: my @types;
8238: if (ref($order) eq 'ARRAY') {
8239: @types = @{$order};
8240: }
8241: if (@types == 0) {
8242: if (ref($usertypes) eq 'HASH') {
8243: @types = sort(keys(%{$usertypes}));
8244: }
8245: }
8246: if (keys(%{$usertypes}) > 0) {
8247: $othertitle = &mt('Other users');
8248: }
8249: return ($othertitle,$usertypes,\@types);
8250: }
8251:
1.645 raeburn 8252: sub get_institutional_codes {
8253: my ($settings,$allcourses,$LC_code) = @_;
8254: # Get complete list of course sections to update
8255: my @currsections = ();
8256: my @currxlists = ();
8257: my $coursecode = $$settings{'internal.coursecode'};
8258:
8259: if ($$settings{'internal.sectionnums'} ne '') {
8260: @currsections = split(/,/,$$settings{'internal.sectionnums'});
8261: }
8262:
8263: if ($$settings{'internal.crosslistings'} ne '') {
8264: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
8265: }
8266:
8267: if (@currxlists > 0) {
8268: foreach (@currxlists) {
8269: if (m/^([^:]+):(\w*)$/) {
8270: unless (grep/^$1$/,@{$allcourses}) {
8271: push @{$allcourses},$1;
8272: $$LC_code{$1} = $2;
8273: }
8274: }
8275: }
8276: }
8277:
8278: if (@currsections > 0) {
8279: foreach (@currsections) {
8280: if (m/^(\w+):(\w*)$/) {
8281: my $sec = $coursecode.$1;
8282: my $lc_sec = $2;
8283: unless (grep/^$sec$/,@{$allcourses}) {
8284: push @{$allcourses},$sec;
8285: $$LC_code{$sec} = $lc_sec;
8286: }
8287: }
8288: }
8289: }
8290: return;
8291: }
8292:
1.948.2.7 raeburn 8293: sub get_standard_codeitems {
8294: return ('Year','Semester','Department','Number','Section');
8295: }
8296:
1.112 bowersj2 8297: =pod
8298:
1.780 raeburn 8299: =head1 Slot Helpers
8300:
8301: =over 4
8302:
8303: =item * sorted_slots()
8304:
8305: Sorts an array of slot names in order of slot start time (earliest first).
8306:
8307: Inputs:
8308:
8309: =over 4
8310:
8311: slotsarr - Reference to array of unsorted slot names.
8312:
8313: slots - Reference to hash of hash, where outer hash keys are slot names.
8314:
1.549 albertel 8315: =back
8316:
1.780 raeburn 8317: Returns:
8318:
8319: =over 4
8320:
8321: sorted - An array of slot names sorted by the start time of the slot.
8322:
8323: =back
8324:
8325: =back
8326:
8327: =cut
8328:
8329:
8330: sub sorted_slots {
8331: my ($slotsarr,$slots) = @_;
8332: my @sorted;
8333: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
8334: @sorted =
8335: sort {
8336: if (ref($slots->{$a}) && ref($slots->{$b})) {
8337: return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
8338: }
8339: if (ref($slots->{$a})) { return -1;}
8340: if (ref($slots->{$b})) { return 1;}
8341: return 0;
8342: } @{$slotsarr};
8343: }
8344: return @sorted;
8345: }
8346:
8347:
8348: =pod
8349:
1.549 albertel 8350: =head1 HTTP Helpers
8351:
8352: =over 4
8353:
1.648 raeburn 8354: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 8355:
1.258 albertel 8356: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 8357: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 8358: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 8359:
8360: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
8361: $possible_names is an ref to an array of form element names. As an example:
8362: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 8363: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 8364:
8365: =cut
1.1 albertel 8366:
1.6 albertel 8367: sub get_unprocessed_cgi {
1.25 albertel 8368: my ($query,$possible_names)= @_;
1.26 matthew 8369: # $Apache::lonxml::debug=1;
1.356 albertel 8370: foreach my $pair (split(/&/,$query)) {
8371: my ($name, $value) = split(/=/,$pair);
1.369 www 8372: $name = &unescape($name);
1.25 albertel 8373: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
8374: $value =~ tr/+/ /;
8375: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 8376: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 8377: }
1.16 harris41 8378: }
1.6 albertel 8379: }
8380:
1.112 bowersj2 8381: =pod
8382:
1.648 raeburn 8383: =item * &cacheheader()
1.112 bowersj2 8384:
8385: returns cache-controlling header code
8386:
8387: =cut
8388:
1.7 albertel 8389: sub cacheheader {
1.258 albertel 8390: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 8391: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
8392: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 8393: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
8394: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 8395: return $output;
1.7 albertel 8396: }
8397:
1.112 bowersj2 8398: =pod
8399:
1.648 raeburn 8400: =item * &no_cache($r)
1.112 bowersj2 8401:
8402: specifies header code to not have cache
8403:
8404: =cut
8405:
1.9 albertel 8406: sub no_cache {
1.216 albertel 8407: my ($r) = @_;
8408: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 8409: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 8410: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
8411: $r->no_cache(1);
8412: $r->header_out("Expires" => $date);
8413: $r->header_out("Pragma" => "no-cache");
1.123 www 8414: }
8415:
8416: sub content_type {
1.181 albertel 8417: my ($r,$type,$charset) = @_;
1.299 foxr 8418: if ($r) {
8419: # Note that printout.pl calls this with undef for $r.
8420: &no_cache($r);
8421: }
1.258 albertel 8422: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 8423: unless ($charset) {
8424: $charset=&Apache::lonlocal::current_encoding;
8425: }
8426: if ($charset) { $type.='; charset='.$charset; }
8427: if ($r) {
8428: $r->content_type($type);
8429: } else {
8430: print("Content-type: $type\n\n");
8431: }
1.9 albertel 8432: }
1.25 albertel 8433:
1.112 bowersj2 8434: =pod
8435:
1.648 raeburn 8436: =item * &add_to_env($name,$value)
1.112 bowersj2 8437:
1.258 albertel 8438: adds $name to the %env hash with value
1.112 bowersj2 8439: $value, if $name already exists, the entry is converted to an array
8440: reference and $value is added to the array.
8441:
8442: =cut
8443:
1.25 albertel 8444: sub add_to_env {
8445: my ($name,$value)=@_;
1.258 albertel 8446: if (defined($env{$name})) {
8447: if (ref($env{$name})) {
1.25 albertel 8448: #already have multiple values
1.258 albertel 8449: push(@{ $env{$name} },$value);
1.25 albertel 8450: } else {
8451: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 8452: my $first=$env{$name};
8453: undef($env{$name});
8454: push(@{ $env{$name} },$first,$value);
1.25 albertel 8455: }
8456: } else {
1.258 albertel 8457: $env{$name}=$value;
1.25 albertel 8458: }
1.31 albertel 8459: }
1.149 albertel 8460:
8461: =pod
8462:
1.648 raeburn 8463: =item * &get_env_multiple($name)
1.149 albertel 8464:
1.258 albertel 8465: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 8466: values may be defined and end up as an array ref.
8467:
8468: returns an array of values
8469:
8470: =cut
8471:
8472: sub get_env_multiple {
8473: my ($name) = @_;
8474: my @values;
1.258 albertel 8475: if (defined($env{$name})) {
1.149 albertel 8476: # exists is it an array
1.258 albertel 8477: if (ref($env{$name})) {
8478: @values=@{ $env{$name} };
1.149 albertel 8479: } else {
1.258 albertel 8480: $values[0]=$env{$name};
1.149 albertel 8481: }
8482: }
8483: return(@values);
8484: }
8485:
1.660 raeburn 8486: sub ask_for_embedded_content {
8487: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.948.2.17 raeburn 8488: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges);
1.660 raeburn 8489: my $num = 0;
1.948.2.17 raeburn 8490: my $numremref = 0;
8491: my $numinvalid = 0;
8492: my $numpathchg = 0;
8493: my $numexisting = 0;
8494: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath);
1.948.2.12 raeburn 8495: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
8496: my $current_path='/';
8497: if ($env{'form.currentpath'}) {
8498: $current_path = $env{'form.currentpath'};
8499: }
8500: if ($actionurl eq '/adm/coursegrp_portfolio') {
8501: $udom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8502: $uname = $env{'course.'.$env{'request.course.id'}.'.num'};
8503: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
8504: } else {
8505: $udom = $env{'user.domain'};
8506: $uname = $env{'user.name'};
8507: $url = '/userfiles/portfolio';
8508: }
1.948.2.17 raeburn 8509: $toplevel = $url.'/';
1.948.2.12 raeburn 8510: $url .= $current_path;
8511: $getpropath = 1;
1.948.2.17 raeburn 8512: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
8513: ($actionurl eq '/adm/imsimport')) {
1.948.2.12 raeburn 8514: ($uname,my $rest) = ($args->{'current_path'} =~ m{/priv/($match_username)/?(.*)$});
1.948.2.17 raeburn 8515: $url = '/home/'.$uname.'/public_html/';
8516: $toplevel = $url;
1.948.2.12 raeburn 8517: if ($rest ne '') {
1.948.2.17 raeburn 8518: $url .= $rest;
8519: }
8520: } elsif ($actionurl eq '/adm/coursedocs') {
8521: if (ref($args) eq 'HASH') {
8522: $url = $args->{'docs_url'};
8523: $toplevel = $url;
8524: }
8525: }
8526: my $now = time();
8527: foreach my $embed_file (keys(%{$allfiles})) {
8528: my $absolutepath;
8529: if ($embed_file =~ m{^\w+://}) {
8530: $newfiles{$embed_file} = 1;
8531: $mapping{$embed_file} = $embed_file;
8532: } else {
8533: if ($embed_file =~ m{^/}) {
8534: $absolutepath = $embed_file;
8535: $embed_file =~ s{^(/+)}{};
8536: }
8537: if ($embed_file =~ m{/}) {
8538: my ($path,$fname) = ($embed_file =~ m{^(.+)/([^/]*)$});
8539: $path = &check_for_traversal($path,$url,$toplevel);
8540: my $item = $fname;
8541: if ($path ne '') {
8542: $item = $path.'/'.$fname;
8543: $subdependencies{$path}{$fname} = 1;
8544: } else {
8545: $dependencies{$item} = 1;
8546: }
8547: if ($absolutepath) {
8548: $mapping{$item} = $absolutepath;
8549: } else {
8550: $mapping{$item} = $embed_file;
8551: }
8552: } else {
8553: $dependencies{$embed_file} = 1;
8554: if ($absolutepath) {
8555: $mapping{$embed_file} = $absolutepath;
8556: } else {
8557: $mapping{$embed_file} = $embed_file;
8558: }
8559: }
1.948.2.12 raeburn 8560: }
8561: }
8562: foreach my $path (keys(%subdependencies)) {
8563: my %currsubfile;
8564: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
8565: my @subdir_list = &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
8566: foreach my $line (@subdir_list) {
8567: my ($file_name,$rest) = split(/\&/,$line,2);
8568: $currsubfile{$file_name} = 1;
8569: }
1.948.2.17 raeburn 8570: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.948.2.12 raeburn 8571: if (opendir(my $dir,$url.'/'.$path)) {
8572: my @subdir_list = grep(!/^\./,readdir($dir));
8573: map {$currsubfile{$_} = 1;} @subdir_list;
8574: }
8575: }
8576: foreach my $file (keys(%{$subdependencies{$path}})) {
1.948.2.17 raeburn 8577: if ($currsubfile{$file}) {
8578: my $item = $path.'/'.$file;
8579: unless ($mapping{$item} eq $item) {
8580: $pathchanges{$item} = 1;
8581: }
8582: $existing{$item} = 1;
8583: $numexisting ++;
8584: } else {
8585: $newfiles{$path.'/'.$file} = 1;
1.948.2.12 raeburn 8586: }
8587: }
8588: }
1.948.2.17 raeburn 8589: my %currfile;
1.948.2.12 raeburn 8590: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
8591: my @dir_list = &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
8592: foreach my $line (@dir_list) {
8593: my ($file_name,$rest) = split(/\&/,$line,2);
8594: $currfile{$file_name} = 1;
8595: }
1.948.2.17 raeburn 8596: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.948.2.12 raeburn 8597: if (opendir(my $dir,$url)) {
1.948.2.17 raeburn 8598: my @dir_list = grep(!/^\./,readdir($dir));
1.948.2.12 raeburn 8599: map {$currfile{$_} = 1;} @dir_list;
8600: }
8601: }
8602: foreach my $file (keys(%dependencies)) {
1.948.2.17 raeburn 8603: if ($currfile{$file}) {
8604: unless ($mapping{$file} eq $file) {
8605: $pathchanges{$file} = 1;
8606: }
8607: $existing{$file} = 1;
8608: $numexisting ++;
8609: } else {
1.948.2.12 raeburn 8610: $newfiles{$file} = 1;
8611: }
8612: }
8613: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.660 raeburn 8614: $upload_output .= &start_data_table_row().
1.948.2.17 raeburn 8615: '<td><span class="LC_filename">'.$embed_file.'</span>';
8616: unless ($mapping{$embed_file} eq $embed_file) {
8617: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.&mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
8618: }
8619: $upload_output .= '</td><td>';
1.660 raeburn 8620: if ($args->{'ignore_remote_references'}
8621: && $embed_file =~ m{^\w+://}) {
8622: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
1.948.2.17 raeburn 8623: $numremref++;
1.660 raeburn 8624: } elsif ($args->{'error_on_invalid_names'}
8625: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
8626:
1.948.2.17 raeburn 8627: $upload_output.='<span class="LC_warning">'.&mt('Invalid characters').'</span>';
8628: $numinvalid++;
1.660 raeburn 8629: } else {
1.948.2.17 raeburn 8630: $upload_output .= &embedded_file_element('upload_embedded',$num,
8631: $embed_file,\%mapping,
8632: $allfiles,$codebase);
8633: $num++;
1.660 raeburn 8634: }
1.948.2.12 raeburn 8635: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
1.660 raeburn 8636: }
1.948.2.17 raeburn 8637: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
8638: $upload_output .= &start_data_table_row().
8639: '<td><span class="LC_filename">'.$embed_file.'</span></td>'.
8640: '<td><span class="LC_warning">'.&mt('Already exists').'</span></td>'.
8641: &Apache::loncommon::end_data_table_row()."\n";
8642: }
8643: if ($upload_output) {
8644: $upload_output = &start_data_table().
1.948.2.12 raeburn 8645: $upload_output.
1.948.2.17 raeburn 8646: &end_data_table()."\n";
8647: }
8648: my $applies = 0;
8649: if ($numremref) {
8650: $applies ++;
8651: }
8652: if ($numinvalid) {
8653: $applies ++;
8654: }
8655: if ($numexisting) {
8656: $applies ++;
8657: }
8658: if ($num) {
8659: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
8660: ' method="post" enctype="multipart/form-data">'."\n".
8661: $state.
8662: '<h3>'.&mt('Upload embedded files').
8663: ':</h3>'.$upload_output.'<br />'."\n".
8664: '<input type ="hidden" name="number_embedded_items" value="'.
8665: $num.'" />'."\n";
8666: if ($actionurl eq '') {
8667: $output .= '<input type="hidden" name="phase" value="three" />';
8668: }
8669: } elsif ($applies) {
8670: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
8671: if ($applies > 1) {
8672: $output .=
8673: &mt('No files need to be uploaded, as one of the following applies to each reference:').'<ul>';
8674: if ($numremref) {
8675: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
8676: }
8677: if ($numinvalid) {
8678: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
8679: }
8680: if ($numexisting) {
8681: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
8682: }
8683: $output .= '</ul><br />';
8684: } elsif ($numremref) {
8685: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
8686: } elsif ($numinvalid) {
8687: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
8688: } elsif ($numexisting) {
8689: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
8690: }
8691: $output .= $upload_output.'<br />';
8692: }
8693: my ($pathchange_output,$chgcount);
8694: $chgcount = $num;
8695: if (keys(%pathchanges) > 0) {
8696: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
8697: if ($num) {
8698: $output .= &embedded_file_element('pathchange',$chgcount,
8699: $embed_file,\%mapping,
8700: $allfiles,$codebase);
8701: } else {
8702: $pathchange_output .=
8703: &start_data_table_row().
8704: '<td><input type ="checkbox" name="namechange" value="'.
8705: $chgcount.'" checked="checked" /></td>'.
8706: '<td>'.$mapping{$embed_file}.'</td>'.
8707: '<td>'.$embed_file.
8708: &embedded_file_element('pathchange',$numpathchg,$embed_file,
8709: \%mapping,$allfiles,$codebase).
8710: '</td>'.&end_data_table_row();
8711: }
8712: $numpathchg ++;
8713: $chgcount ++;
8714: }
8715: }
8716: if ($num) {
8717: if ($numpathchg) {
8718: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
8719: $numpathchg.'" />'."\n";
8720: }
8721: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
8722: ($actionurl eq '/adm/imsimport')) {
8723: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
8724: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
8725: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
8726: }
8727: $output .= '<input type ="submit" value="'.&mt('Upload Listed Files').'" />'."\n".
8728: &mt('(only files for which a location has been provided will be uploaded)').'</form>'."\n";
8729: } elsif ($numpathchg) {
8730: my %pathchange = ();
8731: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
8732: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
8733: $output .= '<p>'.&mt('or').'</p>';
8734: }
8735: }
8736: return ($output,$num,$numpathchg);
8737: }
8738:
8739: sub embedded_file_element {
8740: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase) = @_;
8741: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
8742: (ref($codebase) eq 'HASH'));
8743: my $output;
8744: if ($context eq 'upload_embedded') {
8745: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
8746: }
8747: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
8748: &escape($embed_file).'" />';
8749: unless (($context eq 'upload_embedded') &&
8750: ($mapping->{$embed_file} eq $embed_file)) {
8751: $output .='
8752: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
8753: }
8754: my $attrib;
8755: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
8756: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
1.948.2.12 raeburn 8757: }
1.948.2.17 raeburn 8758: $output .=
8759: "\n\t\t".
8760: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
8761: $attrib.'" />';
8762: if (exists($codebase->{$mapping->{$embed_file}})) {
8763: $output .=
8764: "\n\t\t".
8765: '<input name="codebase_'.$num.'" type="hidden" value="'.
8766: &escape($codebase->{$mapping->{$embed_file}}).'" />';
8767: }
8768: return $output;
1.660 raeburn 8769: }
8770:
1.661 raeburn 8771: sub upload_embedded {
8772: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.948.2.17 raeburn 8773: $current_disk_usage,$hiddenstate,$actionurl) = @_;
8774: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 8775: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
8776: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
8777: my $orig_uploaded_filename =
8778: $env{'form.embedded_item_'.$i.'.filename'};
1.948.2.17 raeburn 8779: foreach my $type ('orig','ref','attrib','codebase') {
8780: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
8781: $env{'form.embedded_'.$type.'_'.$i} =
8782: &unescape($env{'form.embedded_'.$type.'_'.$i});
8783: }
8784: }
1.661 raeburn 8785: my ($path,$fname) =
8786: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
8787: # no path, whole string is fname
8788: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
8789: $fname = &Apache::lonnet::clean_filename($fname);
8790: # See if there is anything left
8791: next if ($fname eq '');
8792:
8793: # Check if file already exists as a file or directory.
8794: my ($state,$msg);
8795: if ($context eq 'portfolio') {
8796: my $port_path = $dirpath;
8797: if ($group ne '') {
8798: $port_path = "groups/$group/$port_path";
8799: }
1.948.2.17 raeburn 8800: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
8801: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 8802: $dir_root,$port_path,$disk_quota,
8803: $current_disk_usage,$uname,$udom);
8804: if ($state eq 'will_exceed_quota'
1.948.2.12 raeburn 8805: || $state eq 'file_locked') {
1.661 raeburn 8806: $output .= $msg;
8807: next;
8808: }
8809: } elsif (($context eq 'author') || ($context eq 'testbank')) {
8810: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
8811: if ($state eq 'exists') {
8812: $output .= $msg;
8813: next;
8814: }
8815: }
8816: # Check if extension is valid
8817: if (($fname =~ /\.(\w+)$/) &&
8818: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.948.2.17 raeburn 8819: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1).'<br />';
1.661 raeburn 8820: next;
8821: } elsif (($fname =~ /\.(\w+)$/) &&
8822: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.948.2.17 raeburn 8823: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 8824: next;
8825: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.948.2.17 raeburn 8826: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2).'<br />';
1.661 raeburn 8827: next;
8828: }
8829:
8830: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
8831: if ($context eq 'portfolio') {
1.948.2.12 raeburn 8832: my $result;
8833: if ($state eq 'existingfile') {
8834: $result=
8835: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.948.2.17 raeburn 8836: $dirpath.$env{'form.currentpath'}.$path);
1.661 raeburn 8837: } else {
1.948.2.12 raeburn 8838: $result=
8839: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.948.2.17 raeburn 8840: $dirpath.
8841: $env{'form.currentpath'}.$path);
1.948.2.12 raeburn 8842: if ($result !~ m|^/uploaded/|) {
8843: $output .= '<span class="LC_error">'
8844: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
8845: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
8846: .'</span><br />';
8847: next;
8848: } else {
1.948.2.17 raeburn 8849: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
8850: $path.$fname.'</span>').'<br />';
1.948.2.12 raeburn 8851: }
1.661 raeburn 8852: }
1.948.2.17 raeburn 8853: } elsif ($context eq 'coursedoc') {
8854: my $result =
8855: &Apache::lonnet::userfileupload('embedded_item_'.$i,'coursedoc',
8856: $dirpath.'/'.$path);
8857: if ($result !~ m|^/uploaded/|) {
8858: $output .= '<span class="LC_error">'
8859: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
8860: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
8861: .'</span><br />';
8862: next;
8863: } else {
8864: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
8865: $path.$fname.'</span>').'<br />';
8866: }
1.661 raeburn 8867: } else {
8868: # Save the file
8869: my $target = $env{'form.embedded_item_'.$i};
8870: my $fullpath = $dir_root.$dirpath.'/'.$path;
8871: my $dest = $fullpath.$fname;
8872: my $url = $url_root.$dirpath.'/'.$path.$fname;
8873: my @parts=split(/\//,$fullpath);
8874: my $count;
8875: my $filepath = $dir_root;
8876: for ($count=4;$count<=$#parts;$count++) {
8877: $filepath .= "/$parts[$count]";
8878: if ((-e $filepath)!=1) {
8879: mkdir($filepath,0770);
8880: }
8881: }
8882: my $fh;
8883: if (!open($fh,'>'.$dest)) {
8884: &Apache::lonnet::logthis('Failed to create '.$dest);
8885: $output .= '<span class="LC_error">'.
8886: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8887: '</span><br />';
8888: } else {
8889: if (!print $fh $env{'form.embedded_item_'.$i}) {
8890: &Apache::lonnet::logthis('Failed to write to '.$dest);
8891: $output .= '<span class="LC_error">'.
8892: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8893: '</span><br />';
8894: } else {
1.948.2.17 raeburn 8895: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
8896: $url.'</span>').'<br />';
8897: unless ($context eq 'testbank') {
8898: $footer .= &mt('View embedded file: [_1]',
8899: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
1.661 raeburn 8900: }
8901: }
8902: close($fh);
8903: }
8904: }
1.948.2.17 raeburn 8905: if ($env{'form.embedded_ref_'.$i}) {
8906: $pathchange{$i} = 1;
8907: }
1.948.2.18 raeburn 8908: }
1.948.2.17 raeburn 8909: if ($output) {
8910: $output = '<p>'.$output.'</p>';
8911: }
8912: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
8913: $returnflag = 'ok';
8914: if (keys(%pathchange) > 0) {
8915: if ($context eq 'portfolio') {
8916: $output .= '<p>'.&mt('or').'</p>';
8917: } elsif ($context eq 'testbank') {
8918: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).','<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
8919: $returnflag = 'modify_orightml';
8920: }
8921: }
8922: return ($output.$footer,$returnflag);
8923: }
8924:
8925: sub modify_html_form {
8926: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
8927: my $end = 0;
8928: my $modifyform;
8929: if ($context eq 'upload_embedded') {
8930: return unless (ref($pathchange) eq 'HASH');
8931: if ($env{'form.number_embedded_items'}) {
8932: $end += $env{'form.number_embedded_items'};
8933: }
8934: if ($env{'form.number_pathchange_items'}) {
8935: $end += $env{'form.number_pathchange_items'};
8936: }
8937: if ($end) {
8938: for (my $i=0; $i<$end; $i++) {
8939: if ($i < $env{'form.number_embedded_items'}) {
8940: next unless($pathchange->{$i});
8941: }
8942: $modifyform .=
8943: &start_data_table_row().
8944: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
8945: 'checked="checked" /></td>'.
8946: '<td>'.$env{'form.embedded_ref_'.$i}.
8947: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
8948: &escape($env{'form.embedded_ref_'.$i}).'" />'.
8949: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
8950: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
8951: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
8952: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
8953: '<td>'.$env{'form.embedded_orig_'.$i}.
8954: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
8955: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
8956: &end_data_table_row();
8957: }
8958: }
8959: } else {
8960: $modifyform = $pathchgtable;
8961: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
8962: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
8963: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
8964: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
8965: }
8966: }
8967: if ($modifyform) {
8968: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
8969: '<p>'.&mt('Changes need to be made to the reference(s) used for one or more of the dependencies, if your HTML file is to work correctly:').'<ol>'."\n".
8970: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
8971: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
8972: '</ol></p>'."\n".'<p>'.
8973: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
8974: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
8975: &start_data_table()."\n".
8976: &start_data_table_header_row().
8977: '<th>'.&mt('Change?').'</th>'.
8978: '<th>'.&mt('Current reference').'</th>'.
8979: '<th>'.&mt('Required reference').'</th>'.
8980: &end_data_table_header_row()."\n".
8981: $modifyform.
8982: &end_data_table().'<br />'."\n".$hiddenstate.
8983: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
8984: '</form>'."\n";
8985: }
8986: return;
8987: }
8988:
8989: sub modify_html_refs {
8990: my ($context,$dirpath,$uname,$udom,$dir_root) = @_;
8991: my $container;
8992: if ($context eq 'portfolio') {
8993: $container = $env{'form.container'};
8994: } elsif ($context eq 'coursedoc') {
8995: $container = $env{'form.primaryurl'};
8996: } else {
8997: $container = $env{'form.filename'};
8998: $container =~ s{^/priv/(\Q$uname\E)/(.*)}{/home/$1/public_html/$2};
8999: }
9000: my (%allfiles,%codebase,$output,$content);
9001: my @changes = &get_env_multiple('form.namechange');
9002: return unless (@changes > 0);
9003: if (($context eq 'portfolio') || ($context eq 'coursedoc')) {
9004: return unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/});
9005: $content = &Apache::lonnet::getfile($container);
9006: return if ($content eq '-1');
9007: } else {
9008: return unless ($container =~ /^\Q$dir_root\E/);
9009: if (open(my $fh,"<$container")) {
9010: $content = join('', <$fh>);
9011: close($fh);
9012: } else {
9013: return;
9014: }
9015: }
9016: my ($count,$codebasecount) = (0,0);
9017: my $mm = new File::MMagic;
9018: my $mime_type = $mm->checktype_contents($content);
9019: if ($mime_type eq 'text/html') {
9020: my $parse_result =
9021: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
9022: \%codebase,\$content);
9023: if ($parse_result eq 'ok') {
9024: foreach my $i (@changes) {
9025: my $orig = &unescape($env{'form.embedded_orig_'.$i});
9026: my $ref = &unescape($env{'form.embedded_ref_'.$i});
9027: if ($allfiles{$ref}) {
9028: my $newname = $orig;
9029: my ($attrib_regexp,$codebase);
9030: my $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
9031: if ($attrib_regexp =~ /:/) {
9032: $attrib_regexp =~ s/\:/|/g;
9033: }
9034: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
9035: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
9036: $count += $numchg;
9037: }
9038: if ($env{'form.embedded_codebase_'.$i} ne '') {
9039: my $codebase = &unescape($env{'form.embedded_codebase_'.$i});
9040: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
9041: $codebasecount ++;
9042: }
9043: }
9044: }
9045: if ($count || $codebasecount) {
9046: my $saveresult;
9047: if ($context eq 'portfolio' || $context eq 'coursedoc') {
9048: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
9049: if ($url eq $container) {
9050: my ($fname) = ($container =~ m{/([^/]+)$});
9051: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
9052: $count,'<span class="LC_filename">'.
9053: $fname.'</span>').'</p>';
9054: } else {
9055: $output = '<p class="LC_error">'.
9056: &mt('Error: update failed for: [_1].',
9057: '<span class="LC_filename">'.
9058: $container.'</span>').'</p>';
9059: }
9060: } else {
9061: if (open(my $fh,">$container")) {
9062: print $fh $content;
9063: close($fh);
9064: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
9065: $count,'<span class="LC_filename">'.
9066: $container.'</span>').'</p>';
9067: } else {
9068: $output = '<p class="LC_error">'.
9069: &mt('Error: could not update [_1].',
9070: '<span class="LC_filename">'.
9071: $container.'</span>').'</p>';
9072: }
9073: }
9074: }
9075: } else {
9076: &logthis('Failed to parse '.$container.
9077: ' to modify references: '.$parse_result);
9078: }
1.661 raeburn 9079: }
9080: return $output;
9081: }
9082:
9083: sub check_for_existing {
9084: my ($path,$fname,$element) = @_;
9085: my ($state,$msg);
9086: if (-d $path.'/'.$fname) {
9087: $state = 'exists';
9088: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
9089: } elsif (-e $path.'/'.$fname) {
9090: $state = 'exists';
9091: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
9092: }
9093: if ($state eq 'exists') {
9094: $msg = '<span class="LC_error">'.$msg.'</span><br />';
9095: }
9096: return ($state,$msg);
9097: }
9098:
9099: sub check_for_upload {
9100: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
9101: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.948.2.12 raeburn 9102: my $filesize = length($env{'form.'.$element});
9103: if (!$filesize) {
9104: my $msg = '<span class="LC_error">'.
9105: &mt('Unable to upload [_1]. (size = [_2] bytes)',
9106: '<span class="LC_filename">'.$fname.'</span>',
9107: $filesize).'<br />'.
1.948.2.21 raeburn 9108: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />';
1.948.2.12 raeburn 9109: '</span>';
9110: return ('zero_bytes',$msg);
9111: }
9112: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 9113: my $getpropath = 1;
9114: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
9115: $getpropath);
9116: my $found_file = 0;
9117: my $locked_file = 0;
1.948.2.20 raeburn 9118: my @lockers;
9119: my $navmap;
9120: if ($env{'request.course.id'}) {
9121: $navmap = Apache::lonnavmaps::navmap->new();
9122: }
1.661 raeburn 9123: foreach my $line (@dir_list) {
1.948.2.12 raeburn 9124: my ($file_name,$rest)=split(/\&/,$line,2);
1.661 raeburn 9125: if ($file_name eq $fname){
9126: $file_name = $path.$file_name;
9127: if ($group ne '') {
9128: $file_name = $group.$file_name;
9129: }
9130: $found_file = 1;
1.948.2.20 raeburn 9131: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
9132: foreach my $lock (@lockers) {
9133: if (ref($lock) eq 'ARRAY') {
9134: my ($symb,$crsid) = @{$lock};
9135: if ($crsid eq $env{'request.course.id'}) {
9136: if (ref($navmap)) {
9137: my $res = $navmap->getBySymb($symb);
9138: foreach my $part (@{$res->parts()}) {
9139: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
9140: unless (($slot_status == $res->RESERVED) ||
9141: ($slot_status == $res->RESERVED_LOCATION)) {
9142: $locked_file = 1;
9143: }
9144: }
9145: } else {
9146: $locked_file = 1;
9147: }
9148: } else {
9149: $locked_file = 1;
9150: }
9151: }
9152: }
1.948.2.12 raeburn 9153: } else {
9154: my @info = split(/\&/,$rest);
9155: my $currsize = $info[6]/1000;
9156: if ($currsize < $filesize) {
9157: my $extra = $filesize - $currsize;
9158: if (($current_disk_usage + $extra) > $disk_quota) {
9159: my $msg = '<span class="LC_error">'.
9160: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded if existing (smaller) file with same name (size = [_3] kilobytes) is replaced.',
9161: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</span>'.
9162: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
9163: $disk_quota,$current_disk_usage);
9164: return ('will_exceed_quota',$msg);
9165: }
9166: }
1.661 raeburn 9167: }
9168: }
9169: }
9170: if (($current_disk_usage + $filesize) > $disk_quota){
9171: my $msg = '<span class="LC_error">'.
9172: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
9173: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
9174: return ('will_exceed_quota',$msg);
9175: } elsif ($found_file) {
9176: if ($locked_file) {
9177: my $msg = '<span class="LC_error">';
9178: $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>');
9179: $msg .= '</span><br />';
9180: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
9181: return ('file_locked',$msg);
9182: } else {
9183: my $msg = '<span class="LC_error">';
1.948.2.12 raeburn 9184: $msg .= &mt(' A file by that name: [_1] was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$port_path.$env{'form.currentpath'});
1.661 raeburn 9185: $msg .= '</span>';
1.948.2.12 raeburn 9186: return ('existingfile',$msg);
1.661 raeburn 9187: }
9188: }
9189: }
9190:
1.948.2.17 raeburn 9191: sub check_for_traversal {
9192: my ($path,$url,$toplevel) = @_;
9193: my @parts=split(/\//,$path);
9194: my $cleanpath;
9195: my $fullpath = $url;
9196: for (my $i=0;$i<@parts;$i++) {
9197: next if ($parts[$i] eq '.');
9198: if ($parts[$i] eq '..') {
9199: $fullpath =~ s{([^/]+/)$}{};
9200: } else {
9201: $fullpath .= $parts[$i].'/';
9202: }
9203: }
9204: if ($fullpath =~ /^\Q$url\E(.*)$/) {
9205: $cleanpath = $1;
9206: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
9207: my $curr_toprel = $1;
9208: my @parts = split(/\//,$curr_toprel);
9209: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
9210: my @urlparts = split(/\//,$url_toprel);
9211: my $doubledots;
9212: my $startdiff = -1;
9213: for (my $i=0; $i<@urlparts; $i++) {
9214: if ($startdiff == -1) {
9215: unless ($urlparts[$i] eq $parts[$i]) {
9216: $startdiff = $i;
9217: $doubledots .= '../';
9218: }
9219: } else {
9220: $doubledots .= '../';
9221: }
9222: }
9223: if ($startdiff > -1) {
9224: $cleanpath = $doubledots;
9225: for (my $i=$startdiff; $i<@parts; $i++) {
9226: $cleanpath .= $parts[$i].'/';
9227: }
9228: }
9229: }
9230: $cleanpath =~ s{(/)$}{};
9231: return $cleanpath;
9232: }
1.31 albertel 9233:
1.41 ng 9234: =pod
1.45 matthew 9235:
1.464 albertel 9236: =back
1.41 ng 9237:
1.112 bowersj2 9238: =head1 CSV Upload/Handling functions
1.38 albertel 9239:
1.41 ng 9240: =over 4
9241:
1.648 raeburn 9242: =item * &upfile_store($r)
1.41 ng 9243:
9244: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 9245: needs $env{'form.upfile'}
1.41 ng 9246: returns $datatoken to be put into hidden field
9247:
9248: =cut
1.31 albertel 9249:
9250: sub upfile_store {
9251: my $r=shift;
1.258 albertel 9252: $env{'form.upfile'}=~s/\r/\n/gs;
9253: $env{'form.upfile'}=~s/\f/\n/gs;
9254: $env{'form.upfile'}=~s/\n+/\n/gs;
9255: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 9256:
1.258 albertel 9257: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
9258: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 9259: {
1.158 raeburn 9260: my $datafile = $r->dir_config('lonDaemons').
9261: '/tmp/'.$datatoken.'.tmp';
9262: if ( open(my $fh,">$datafile") ) {
1.258 albertel 9263: print $fh $env{'form.upfile'};
1.158 raeburn 9264: close($fh);
9265: }
1.31 albertel 9266: }
9267: return $datatoken;
9268: }
9269:
1.56 matthew 9270: =pod
9271:
1.648 raeburn 9272: =item * &load_tmp_file($r)
1.41 ng 9273:
9274: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 9275: needs $env{'form.datatoken'},
9276: sets $env{'form.upfile'} to the contents of the file
1.41 ng 9277:
9278: =cut
1.31 albertel 9279:
9280: sub load_tmp_file {
9281: my $r=shift;
9282: my @studentdata=();
9283: {
1.158 raeburn 9284: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 9285: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 9286: if ( open(my $fh,"<$studentfile") ) {
9287: @studentdata=<$fh>;
9288: close($fh);
9289: }
1.31 albertel 9290: }
1.258 albertel 9291: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 9292: }
9293:
1.56 matthew 9294: =pod
9295:
1.648 raeburn 9296: =item * &upfile_record_sep()
1.41 ng 9297:
9298: Separate uploaded file into records
9299: returns array of records,
1.258 albertel 9300: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 9301:
9302: =cut
1.31 albertel 9303:
9304: sub upfile_record_sep {
1.258 albertel 9305: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 9306: } else {
1.248 albertel 9307: my @records;
1.258 albertel 9308: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 9309: if ($line=~/^\s*$/) { next; }
9310: push(@records,$line);
9311: }
9312: return @records;
1.31 albertel 9313: }
9314: }
9315:
1.56 matthew 9316: =pod
9317:
1.648 raeburn 9318: =item * &record_sep($record)
1.41 ng 9319:
1.258 albertel 9320: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 9321:
9322: =cut
9323:
1.263 www 9324: sub takeleft {
9325: my $index=shift;
9326: return substr('0000'.$index,-4,4);
9327: }
9328:
1.31 albertel 9329: sub record_sep {
9330: my $record=shift;
9331: my %components=();
1.258 albertel 9332: if ($env{'form.upfiletype'} eq 'xml') {
9333: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 9334: my $i=0;
1.356 albertel 9335: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 9336: $field=~s/^(\"|\')//;
9337: $field=~s/(\"|\')$//;
1.263 www 9338: $components{&takeleft($i)}=$field;
1.31 albertel 9339: $i++;
9340: }
1.258 albertel 9341: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 9342: my $i=0;
1.356 albertel 9343: foreach my $field (split(/\t/,$record)) {
1.31 albertel 9344: $field=~s/^(\"|\')//;
9345: $field=~s/(\"|\')$//;
1.263 www 9346: $components{&takeleft($i)}=$field;
1.31 albertel 9347: $i++;
9348: }
9349: } else {
1.561 www 9350: my $separator=',';
1.480 banghart 9351: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 9352: $separator=';';
1.480 banghart 9353: }
1.31 albertel 9354: my $i=0;
1.561 www 9355: # the character we are looking for to indicate the end of a quote or a record
9356: my $looking_for=$separator;
9357: # do not add the characters to the fields
9358: my $ignore=0;
9359: # we just encountered a separator (or the beginning of the record)
9360: my $just_found_separator=1;
9361: # store the field we are working on here
9362: my $field='';
9363: # work our way through all characters in record
9364: foreach my $character ($record=~/(.)/g) {
9365: if ($character eq $looking_for) {
9366: if ($character ne $separator) {
9367: # Found the end of a quote, again looking for separator
9368: $looking_for=$separator;
9369: $ignore=1;
9370: } else {
9371: # Found a separator, store away what we got
9372: $components{&takeleft($i)}=$field;
9373: $i++;
9374: $just_found_separator=1;
9375: $ignore=0;
9376: $field='';
9377: }
9378: next;
9379: }
9380: # single or double quotation marks after a separator indicate beginning of a quote
9381: # we are now looking for the end of the quote and need to ignore separators
9382: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
9383: $looking_for=$character;
9384: next;
9385: }
9386: # ignore would be true after we reached the end of a quote
9387: if ($ignore) { next; }
9388: if (($just_found_separator) && ($character=~/\s/)) { next; }
9389: $field.=$character;
9390: $just_found_separator=0;
1.31 albertel 9391: }
1.561 www 9392: # catch the very last entry, since we never encountered the separator
9393: $components{&takeleft($i)}=$field;
1.31 albertel 9394: }
9395: return %components;
9396: }
9397:
1.144 matthew 9398: ######################################################
9399: ######################################################
9400:
1.56 matthew 9401: =pod
9402:
1.648 raeburn 9403: =item * &upfile_select_html()
1.41 ng 9404:
1.144 matthew 9405: Return HTML code to select a file from the users machine and specify
9406: the file type.
1.41 ng 9407:
9408: =cut
9409:
1.144 matthew 9410: ######################################################
9411: ######################################################
1.31 albertel 9412: sub upfile_select_html {
1.144 matthew 9413: my %Types = (
9414: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 9415: semisv => &mt('Semicolon separated values'),
1.144 matthew 9416: space => &mt('Space separated'),
9417: tab => &mt('Tabulator separated'),
9418: # xml => &mt('HTML/XML'),
9419: );
9420: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 9421: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 9422: foreach my $type (sort(keys(%Types))) {
9423: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
9424: }
9425: $Str .= "</select>\n";
9426: return $Str;
1.31 albertel 9427: }
9428:
1.301 albertel 9429: sub get_samples {
9430: my ($records,$toget) = @_;
9431: my @samples=({});
9432: my $got=0;
9433: foreach my $rec (@$records) {
9434: my %temp = &record_sep($rec);
9435: if (! grep(/\S/, values(%temp))) { next; }
9436: if (%temp) {
9437: $samples[$got]=\%temp;
9438: $got++;
9439: if ($got == $toget) { last; }
9440: }
9441: }
9442: return \@samples;
9443: }
9444:
1.144 matthew 9445: ######################################################
9446: ######################################################
9447:
1.56 matthew 9448: =pod
9449:
1.648 raeburn 9450: =item * &csv_print_samples($r,$records)
1.41 ng 9451:
9452: Prints a table of sample values from each column uploaded $r is an
9453: Apache Request ref, $records is an arrayref from
9454: &Apache::loncommon::upfile_record_sep
9455:
9456: =cut
9457:
1.144 matthew 9458: ######################################################
9459: ######################################################
1.31 albertel 9460: sub csv_print_samples {
9461: my ($r,$records) = @_;
1.662 bisitz 9462: my $samples = &get_samples($records,5);
1.301 albertel 9463:
1.594 raeburn 9464: $r->print(&mt('Samples').'<br />'.&start_data_table().
9465: &start_data_table_header_row());
1.356 albertel 9466: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 9467: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 9468: $r->print(&end_data_table_header_row());
1.301 albertel 9469: foreach my $hash (@$samples) {
1.594 raeburn 9470: $r->print(&start_data_table_row());
1.356 albertel 9471: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 9472: $r->print('<td>');
1.356 albertel 9473: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 9474: $r->print('</td>');
9475: }
1.594 raeburn 9476: $r->print(&end_data_table_row());
1.31 albertel 9477: }
1.594 raeburn 9478: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 9479: }
9480:
1.144 matthew 9481: ######################################################
9482: ######################################################
9483:
1.56 matthew 9484: =pod
9485:
1.648 raeburn 9486: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 9487:
9488: Prints a table to create associations between values and table columns.
1.144 matthew 9489:
1.41 ng 9490: $r is an Apache Request ref,
9491: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 9492: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 9493:
9494: =cut
9495:
1.144 matthew 9496: ######################################################
9497: ######################################################
1.31 albertel 9498: sub csv_print_select_table {
9499: my ($r,$records,$d) = @_;
1.301 albertel 9500: my $i=0;
9501: my $samples = &get_samples($records,1);
1.144 matthew 9502: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 9503: &start_data_table().&start_data_table_header_row().
1.144 matthew 9504: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 9505: '<th>'.&mt('Column').'</th>'.
9506: &end_data_table_header_row()."\n");
1.356 albertel 9507: foreach my $array_ref (@$d) {
9508: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 9509: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 9510:
1.875 bisitz 9511: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 9512: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 9513: $r->print('<option value="none"></option>');
1.356 albertel 9514: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
9515: $r->print('<option value="'.$sample.'"'.
9516: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 9517: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 9518: }
1.594 raeburn 9519: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 9520: $i++;
9521: }
1.594 raeburn 9522: $r->print(&end_data_table());
1.31 albertel 9523: $i--;
9524: return $i;
9525: }
1.56 matthew 9526:
1.144 matthew 9527: ######################################################
9528: ######################################################
9529:
1.56 matthew 9530: =pod
1.31 albertel 9531:
1.648 raeburn 9532: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 9533:
9534: Prints a table of sample values from the upload and can make associate samples to internal names.
9535:
9536: $r is an Apache Request ref,
9537: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
9538: $d is an array of 2 element arrays (internal name, displayed name)
9539:
9540: =cut
9541:
1.144 matthew 9542: ######################################################
9543: ######################################################
1.31 albertel 9544: sub csv_samples_select_table {
9545: my ($r,$records,$d) = @_;
9546: my $i=0;
1.144 matthew 9547: #
1.662 bisitz 9548: my $max_samples = 5;
9549: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 9550: $r->print(&start_data_table().
9551: &start_data_table_header_row().'<th>'.
9552: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
9553: &end_data_table_header_row());
1.301 albertel 9554:
9555: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 9556: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 9557: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 9558: foreach my $option (@$d) {
9559: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 9560: $r->print('<option value="'.$value.'"'.
1.253 albertel 9561: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 9562: $display.'</option>');
1.31 albertel 9563: }
9564: $r->print('</select></td><td>');
1.662 bisitz 9565: foreach my $line (0..($max_samples-1)) {
1.301 albertel 9566: if (defined($samples->[$line]{$key})) {
9567: $r->print($samples->[$line]{$key}."<br />\n");
9568: }
9569: }
1.594 raeburn 9570: $r->print('</td>'.&end_data_table_row());
1.31 albertel 9571: $i++;
9572: }
1.594 raeburn 9573: $r->print(&end_data_table());
1.31 albertel 9574: $i--;
9575: return($i);
1.115 matthew 9576: }
9577:
1.144 matthew 9578: ######################################################
9579: ######################################################
9580:
1.115 matthew 9581: =pod
9582:
1.648 raeburn 9583: =item * &clean_excel_name($name)
1.115 matthew 9584:
9585: Returns a replacement for $name which does not contain any illegal characters.
9586:
9587: =cut
9588:
1.144 matthew 9589: ######################################################
9590: ######################################################
1.115 matthew 9591: sub clean_excel_name {
9592: my ($name) = @_;
9593: $name =~ s/[:\*\?\/\\]//g;
9594: if (length($name) > 31) {
9595: $name = substr($name,0,31);
9596: }
9597: return $name;
1.25 albertel 9598: }
1.84 albertel 9599:
1.85 albertel 9600: =pod
9601:
1.648 raeburn 9602: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 9603:
9604: Returns either 1 or undef
9605:
9606: 1 if the part is to be hidden, undef if it is to be shown
9607:
9608: Arguments are:
9609:
9610: $id the id of the part to be checked
9611: $symb, optional the symb of the resource to check
9612: $udom, optional the domain of the user to check for
9613: $uname, optional the username of the user to check for
9614:
9615: =cut
1.84 albertel 9616:
9617: sub check_if_partid_hidden {
9618: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 9619: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 9620: $symb,$udom,$uname);
1.141 albertel 9621: my $truth=1;
9622: #if the string starts with !, then the list is the list to show not hide
9623: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 9624: my @hiddenlist=split(/,/,$hiddenparts);
9625: foreach my $checkid (@hiddenlist) {
1.141 albertel 9626: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 9627: }
1.141 albertel 9628: return !$truth;
1.84 albertel 9629: }
1.127 matthew 9630:
1.138 matthew 9631:
9632: ############################################################
9633: ############################################################
9634:
9635: =pod
9636:
1.157 matthew 9637: =back
9638:
1.138 matthew 9639: =head1 cgi-bin script and graphing routines
9640:
1.157 matthew 9641: =over 4
9642:
1.648 raeburn 9643: =item * &get_cgi_id()
1.138 matthew 9644:
9645: Inputs: none
9646:
9647: Returns an id which can be used to pass environment variables
9648: to various cgi-bin scripts. These environment variables will
9649: be removed from the users environment after a given time by
9650: the routine &Apache::lonnet::transfer_profile_to_env.
9651:
9652: =cut
9653:
9654: ############################################################
9655: ############################################################
1.152 albertel 9656: my $uniq=0;
1.136 matthew 9657: sub get_cgi_id {
1.154 albertel 9658: $uniq=($uniq+1)%100000;
1.280 albertel 9659: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 9660: }
9661:
1.127 matthew 9662: ############################################################
9663: ############################################################
9664:
9665: =pod
9666:
1.648 raeburn 9667: =item * &DrawBarGraph()
1.127 matthew 9668:
1.138 matthew 9669: Facilitates the plotting of data in a (stacked) bar graph.
9670: Puts plot definition data into the users environment in order for
9671: graph.png to plot it. Returns an <img> tag for the plot.
9672: The bars on the plot are labeled '1','2',...,'n'.
9673:
9674: Inputs:
9675:
9676: =over 4
9677:
9678: =item $Title: string, the title of the plot
9679:
9680: =item $xlabel: string, text describing the X-axis of the plot
9681:
9682: =item $ylabel: string, text describing the Y-axis of the plot
9683:
9684: =item $Max: scalar, the maximum Y value to use in the plot
9685: If $Max is < any data point, the graph will not be rendered.
9686:
1.140 matthew 9687: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 9688: they are plotted. If undefined, default values will be used.
9689:
1.178 matthew 9690: =item $labels: array ref holding the labels to use on the x-axis for the bars.
9691:
1.138 matthew 9692: =item @Values: An array of array references. Each array reference holds data
9693: to be plotted in a stacked bar chart.
9694:
1.239 matthew 9695: =item If the final element of @Values is a hash reference the key/value
9696: pairs will be added to the graph definition.
9697:
1.138 matthew 9698: =back
9699:
9700: Returns:
9701:
9702: An <img> tag which references graph.png and the appropriate identifying
9703: information for the plot.
9704:
1.127 matthew 9705: =cut
9706:
9707: ############################################################
9708: ############################################################
1.134 matthew 9709: sub DrawBarGraph {
1.178 matthew 9710: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 9711: #
9712: if (! defined($colors)) {
9713: $colors = ['#33ff00',
9714: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
9715: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
9716: ];
9717: }
1.228 matthew 9718: my $extra_settings = {};
9719: if (ref($Values[-1]) eq 'HASH') {
9720: $extra_settings = pop(@Values);
9721: }
1.127 matthew 9722: #
1.136 matthew 9723: my $identifier = &get_cgi_id();
9724: my $id = 'cgi.'.$identifier;
1.129 matthew 9725: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 9726: return '';
9727: }
1.225 matthew 9728: #
9729: my @Labels;
9730: if (defined($labels)) {
9731: @Labels = @$labels;
9732: } else {
9733: for (my $i=0;$i<@{$Values[0]};$i++) {
9734: push (@Labels,$i+1);
9735: }
9736: }
9737: #
1.129 matthew 9738: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 9739: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 9740: my %ValuesHash;
9741: my $NumSets=1;
9742: foreach my $array (@Values) {
9743: next if (! ref($array));
1.136 matthew 9744: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 9745: join(',',@$array);
1.129 matthew 9746: }
1.127 matthew 9747: #
1.136 matthew 9748: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 9749: if ($NumBars < 3) {
9750: $width = 120+$NumBars*32;
1.220 matthew 9751: $xskip = 1;
1.225 matthew 9752: $bar_width = 30;
9753: } elsif ($NumBars < 5) {
9754: $width = 120+$NumBars*20;
9755: $xskip = 1;
9756: $bar_width = 20;
1.220 matthew 9757: } elsif ($NumBars < 10) {
1.136 matthew 9758: $width = 120+$NumBars*15;
9759: $xskip = 1;
9760: $bar_width = 15;
9761: } elsif ($NumBars <= 25) {
9762: $width = 120+$NumBars*11;
9763: $xskip = 5;
9764: $bar_width = 8;
9765: } elsif ($NumBars <= 50) {
9766: $width = 120+$NumBars*8;
9767: $xskip = 5;
9768: $bar_width = 4;
9769: } else {
9770: $width = 120+$NumBars*8;
9771: $xskip = 5;
9772: $bar_width = 4;
9773: }
9774: #
1.137 matthew 9775: $Max = 1 if ($Max < 1);
9776: if ( int($Max) < $Max ) {
9777: $Max++;
9778: $Max = int($Max);
9779: }
1.127 matthew 9780: $Title = '' if (! defined($Title));
9781: $xlabel = '' if (! defined($xlabel));
9782: $ylabel = '' if (! defined($ylabel));
1.369 www 9783: $ValuesHash{$id.'.title'} = &escape($Title);
9784: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
9785: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 9786: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 9787: $ValuesHash{$id.'.NumBars'} = $NumBars;
9788: $ValuesHash{$id.'.NumSets'} = $NumSets;
9789: $ValuesHash{$id.'.PlotType'} = 'bar';
9790: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9791: $ValuesHash{$id.'.height'} = $height;
9792: $ValuesHash{$id.'.width'} = $width;
9793: $ValuesHash{$id.'.xskip'} = $xskip;
9794: $ValuesHash{$id.'.bar_width'} = $bar_width;
9795: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 9796: #
1.228 matthew 9797: # Deal with other parameters
9798: while (my ($key,$value) = each(%$extra_settings)) {
9799: $ValuesHash{$id.'.'.$key} = $value;
9800: }
9801: #
1.646 raeburn 9802: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 9803: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9804: }
9805:
9806: ############################################################
9807: ############################################################
9808:
9809: =pod
9810:
1.648 raeburn 9811: =item * &DrawXYGraph()
1.137 matthew 9812:
1.138 matthew 9813: Facilitates the plotting of data in an XY graph.
9814: Puts plot definition data into the users environment in order for
9815: graph.png to plot it. Returns an <img> tag for the plot.
9816:
9817: Inputs:
9818:
9819: =over 4
9820:
9821: =item $Title: string, the title of the plot
9822:
9823: =item $xlabel: string, text describing the X-axis of the plot
9824:
9825: =item $ylabel: string, text describing the Y-axis of the plot
9826:
9827: =item $Max: scalar, the maximum Y value to use in the plot
9828: If $Max is < any data point, the graph will not be rendered.
9829:
9830: =item $colors: Array ref containing the hex color codes for the data to be
9831: plotted in. If undefined, default values will be used.
9832:
9833: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9834:
9835: =item $Ydata: Array ref containing Array refs.
1.185 www 9836: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 9837:
9838: =item %Values: hash indicating or overriding any default values which are
9839: passed to graph.png.
9840: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9841:
9842: =back
9843:
9844: Returns:
9845:
9846: An <img> tag which references graph.png and the appropriate identifying
9847: information for the plot.
9848:
1.137 matthew 9849: =cut
9850:
9851: ############################################################
9852: ############################################################
9853: sub DrawXYGraph {
9854: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
9855: #
9856: # Create the identifier for the graph
9857: my $identifier = &get_cgi_id();
9858: my $id = 'cgi.'.$identifier;
9859: #
9860: $Title = '' if (! defined($Title));
9861: $xlabel = '' if (! defined($xlabel));
9862: $ylabel = '' if (! defined($ylabel));
9863: my %ValuesHash =
9864: (
1.369 www 9865: $id.'.title' => &escape($Title),
9866: $id.'.xlabel' => &escape($xlabel),
9867: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 9868: $id.'.y_max_value'=> $Max,
9869: $id.'.labels' => join(',',@$Xlabels),
9870: $id.'.PlotType' => 'XY',
9871: );
9872: #
9873: if (defined($colors) && ref($colors) eq 'ARRAY') {
9874: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9875: }
9876: #
9877: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
9878: return '';
9879: }
9880: my $NumSets=1;
1.138 matthew 9881: foreach my $array (@{$Ydata}){
1.137 matthew 9882: next if (! ref($array));
9883: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
9884: }
1.138 matthew 9885: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 9886: #
9887: # Deal with other parameters
9888: while (my ($key,$value) = each(%Values)) {
9889: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 9890: }
9891: #
1.646 raeburn 9892: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 9893: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9894: }
9895:
9896: ############################################################
9897: ############################################################
9898:
9899: =pod
9900:
1.648 raeburn 9901: =item * &DrawXYYGraph()
1.138 matthew 9902:
9903: Facilitates the plotting of data in an XY graph with two Y axes.
9904: Puts plot definition data into the users environment in order for
9905: graph.png to plot it. Returns an <img> tag for the plot.
9906:
9907: Inputs:
9908:
9909: =over 4
9910:
9911: =item $Title: string, the title of the plot
9912:
9913: =item $xlabel: string, text describing the X-axis of the plot
9914:
9915: =item $ylabel: string, text describing the Y-axis of the plot
9916:
9917: =item $colors: Array ref containing the hex color codes for the data to be
9918: plotted in. If undefined, default values will be used.
9919:
9920: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9921:
9922: =item $Ydata1: The first data set
9923:
9924: =item $Min1: The minimum value of the left Y-axis
9925:
9926: =item $Max1: The maximum value of the left Y-axis
9927:
9928: =item $Ydata2: The second data set
9929:
9930: =item $Min2: The minimum value of the right Y-axis
9931:
9932: =item $Max2: The maximum value of the left Y-axis
9933:
9934: =item %Values: hash indicating or overriding any default values which are
9935: passed to graph.png.
9936: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9937:
9938: =back
9939:
9940: Returns:
9941:
9942: An <img> tag which references graph.png and the appropriate identifying
9943: information for the plot.
1.136 matthew 9944:
9945: =cut
9946:
9947: ############################################################
9948: ############################################################
1.137 matthew 9949: sub DrawXYYGraph {
9950: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
9951: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 9952: #
9953: # Create the identifier for the graph
9954: my $identifier = &get_cgi_id();
9955: my $id = 'cgi.'.$identifier;
9956: #
9957: $Title = '' if (! defined($Title));
9958: $xlabel = '' if (! defined($xlabel));
9959: $ylabel = '' if (! defined($ylabel));
9960: my %ValuesHash =
9961: (
1.369 www 9962: $id.'.title' => &escape($Title),
9963: $id.'.xlabel' => &escape($xlabel),
9964: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 9965: $id.'.labels' => join(',',@$Xlabels),
9966: $id.'.PlotType' => 'XY',
9967: $id.'.NumSets' => 2,
1.137 matthew 9968: $id.'.two_axes' => 1,
9969: $id.'.y1_max_value' => $Max1,
9970: $id.'.y1_min_value' => $Min1,
9971: $id.'.y2_max_value' => $Max2,
9972: $id.'.y2_min_value' => $Min2,
1.136 matthew 9973: );
9974: #
1.137 matthew 9975: if (defined($colors) && ref($colors) eq 'ARRAY') {
9976: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9977: }
9978: #
9979: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
9980: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 9981: return '';
9982: }
9983: my $NumSets=1;
1.137 matthew 9984: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 9985: next if (! ref($array));
9986: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 9987: }
9988: #
9989: # Deal with other parameters
9990: while (my ($key,$value) = each(%Values)) {
9991: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 9992: }
9993: #
1.646 raeburn 9994: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 9995: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 9996: }
9997:
9998: ############################################################
9999: ############################################################
10000:
10001: =pod
10002:
1.157 matthew 10003: =back
10004:
1.139 matthew 10005: =head1 Statistics helper routines?
10006:
10007: Bad place for them but what the hell.
10008:
1.157 matthew 10009: =over 4
10010:
1.648 raeburn 10011: =item * &chartlink()
1.139 matthew 10012:
10013: Returns a link to the chart for a specific student.
10014:
10015: Inputs:
10016:
10017: =over 4
10018:
10019: =item $linktext: The text of the link
10020:
10021: =item $sname: The students username
10022:
10023: =item $sdomain: The students domain
10024:
10025: =back
10026:
1.157 matthew 10027: =back
10028:
1.139 matthew 10029: =cut
10030:
10031: ############################################################
10032: ############################################################
10033: sub chartlink {
10034: my ($linktext, $sname, $sdomain) = @_;
10035: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 10036: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 10037: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 10038: '">'.$linktext.'</a>';
1.153 matthew 10039: }
10040:
10041: #######################################################
10042: #######################################################
10043:
10044: =pod
10045:
10046: =head1 Course Environment Routines
1.157 matthew 10047:
10048: =over 4
1.153 matthew 10049:
1.648 raeburn 10050: =item * &restore_course_settings()
1.153 matthew 10051:
1.648 raeburn 10052: =item * &store_course_settings()
1.153 matthew 10053:
10054: Restores/Store indicated form parameters from the course environment.
10055: Will not overwrite existing values of the form parameters.
10056:
10057: Inputs:
10058: a scalar describing the data (e.g. 'chart', 'problem_analysis')
10059:
10060: a hash ref describing the data to be stored. For example:
10061:
10062: %Save_Parameters = ('Status' => 'scalar',
10063: 'chartoutputmode' => 'scalar',
10064: 'chartoutputdata' => 'scalar',
10065: 'Section' => 'array',
1.373 raeburn 10066: 'Group' => 'array',
1.153 matthew 10067: 'StudentData' => 'array',
10068: 'Maps' => 'array');
10069:
10070: Returns: both routines return nothing
10071:
1.631 raeburn 10072: =back
10073:
1.153 matthew 10074: =cut
10075:
10076: #######################################################
10077: #######################################################
10078: sub store_course_settings {
1.496 albertel 10079: return &store_settings($env{'request.course.id'},@_);
10080: }
10081:
10082: sub store_settings {
1.153 matthew 10083: # save to the environment
10084: # appenv the same items, just to be safe
1.300 albertel 10085: my $udom = $env{'user.domain'};
10086: my $uname = $env{'user.name'};
1.496 albertel 10087: my ($context,$prefix,$Settings) = @_;
1.153 matthew 10088: my %SaveHash;
10089: my %AppHash;
10090: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 10091: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 10092: my $envname = 'environment.'.$basename;
1.258 albertel 10093: if (exists($env{'form.'.$setting})) {
1.153 matthew 10094: # Save this value away
10095: if ($type eq 'scalar' &&
1.258 albertel 10096: (! exists($env{$envname}) ||
10097: $env{$envname} ne $env{'form.'.$setting})) {
10098: $SaveHash{$basename} = $env{'form.'.$setting};
10099: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 10100: } elsif ($type eq 'array') {
10101: my $stored_form;
1.258 albertel 10102: if (ref($env{'form.'.$setting})) {
1.153 matthew 10103: $stored_form = join(',',
10104: map {
1.369 www 10105: &escape($_);
1.258 albertel 10106: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 10107: } else {
10108: $stored_form =
1.369 www 10109: &escape($env{'form.'.$setting});
1.153 matthew 10110: }
10111: # Determine if the array contents are the same.
1.258 albertel 10112: if ($stored_form ne $env{$envname}) {
1.153 matthew 10113: $SaveHash{$basename} = $stored_form;
10114: $AppHash{$envname} = $stored_form;
10115: }
10116: }
10117: }
10118: }
10119: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 10120: $udom,$uname);
1.153 matthew 10121: if ($put_result !~ /^(ok|delayed)/) {
10122: &Apache::lonnet::logthis('unable to save form parameters, '.
10123: 'got error:'.$put_result);
10124: }
10125: # Make sure these settings stick around in this session, too
1.646 raeburn 10126: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 10127: return;
10128: }
10129:
10130: sub restore_course_settings {
1.499 albertel 10131: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 10132: }
10133:
10134: sub restore_settings {
10135: my ($context,$prefix,$Settings) = @_;
1.153 matthew 10136: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 10137: next if (exists($env{'form.'.$setting}));
1.496 albertel 10138: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 10139: '.'.$setting;
1.258 albertel 10140: if (exists($env{$envname})) {
1.153 matthew 10141: if ($type eq 'scalar') {
1.258 albertel 10142: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 10143: } elsif ($type eq 'array') {
1.258 albertel 10144: $env{'form.'.$setting} = [
1.153 matthew 10145: map {
1.369 www 10146: &unescape($_);
1.258 albertel 10147: } split(',',$env{$envname})
1.153 matthew 10148: ];
10149: }
10150: }
10151: }
1.127 matthew 10152: }
10153:
1.618 raeburn 10154: #######################################################
10155: #######################################################
10156:
10157: =pod
10158:
10159: =head1 Domain E-mail Routines
10160:
10161: =over 4
10162:
1.648 raeburn 10163: =item * &build_recipient_list()
1.618 raeburn 10164:
1.884 raeburn 10165: Build recipient lists for five types of e-mail:
1.766 raeburn 10166: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884 raeburn 10167: (d) Help requests, (e) Course requests needing approval, generated by
10168: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
10169: loncoursequeueadmin.pm respectively.
1.618 raeburn 10170:
10171: Inputs:
1.619 raeburn 10172: defmail (scalar - email address of default recipient),
1.618 raeburn 10173: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 10174: defdom (domain for which to retrieve configuration settings),
10175: origmail (scalar - email address of recipient from loncapa.conf,
10176: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 10177:
1.655 raeburn 10178: Returns: comma separated list of addresses to which to send e-mail.
10179:
10180: =back
1.618 raeburn 10181:
10182: =cut
10183:
10184: ############################################################
10185: ############################################################
10186: sub build_recipient_list {
1.619 raeburn 10187: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 10188: my @recipients;
10189: my $otheremails;
10190: my %domconfig =
10191: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
10192: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 10193: if (exists($domconfig{'contacts'}{$mailing})) {
10194: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
10195: my @contacts = ('adminemail','supportemail');
10196: foreach my $item (@contacts) {
10197: if ($domconfig{'contacts'}{$mailing}{$item}) {
10198: my $addr = $domconfig{'contacts'}{$item};
10199: if (!grep(/^\Q$addr\E$/,@recipients)) {
10200: push(@recipients,$addr);
10201: }
1.619 raeburn 10202: }
1.766 raeburn 10203: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 10204: }
10205: }
1.766 raeburn 10206: } elsif ($origmail ne '') {
10207: push(@recipients,$origmail);
1.618 raeburn 10208: }
1.619 raeburn 10209: } elsif ($origmail ne '') {
10210: push(@recipients,$origmail);
1.618 raeburn 10211: }
1.688 raeburn 10212: if (defined($defmail)) {
10213: if ($defmail ne '') {
10214: push(@recipients,$defmail);
10215: }
1.618 raeburn 10216: }
10217: if ($otheremails) {
1.619 raeburn 10218: my @others;
10219: if ($otheremails =~ /,/) {
10220: @others = split(/,/,$otheremails);
1.618 raeburn 10221: } else {
1.619 raeburn 10222: push(@others,$otheremails);
10223: }
10224: foreach my $addr (@others) {
10225: if (!grep(/^\Q$addr\E$/,@recipients)) {
10226: push(@recipients,$addr);
10227: }
1.618 raeburn 10228: }
10229: }
1.619 raeburn 10230: my $recipientlist = join(',',@recipients);
1.618 raeburn 10231: return $recipientlist;
10232: }
10233:
1.127 matthew 10234: ############################################################
10235: ############################################################
1.154 albertel 10236:
1.655 raeburn 10237: =pod
10238:
10239: =head1 Course Catalog Routines
10240:
10241: =over 4
10242:
10243: =item * &gather_categories()
10244:
10245: Converts category definitions - keys of categories hash stored in
10246: coursecategories in configuration.db on the primary library server in a
10247: domain - to an array. Also generates javascript and idx hash used to
10248: generate Domain Coordinator interface for editing Course Categories.
10249:
10250: Inputs:
1.663 raeburn 10251:
1.655 raeburn 10252: categories (reference to hash of category definitions).
1.663 raeburn 10253:
1.655 raeburn 10254: cats (reference to array of arrays/hashes which encapsulates hierarchy of
10255: categories and subcategories).
1.663 raeburn 10256:
1.655 raeburn 10257: idx (reference to hash of counters used in Domain Coordinator interface for
10258: editing Course Categories).
1.663 raeburn 10259:
1.655 raeburn 10260: jsarray (reference to array of categories used to create Javascript arrays for
10261: Domain Coordinator interface for editing Course Categories).
10262:
10263: Returns: nothing
10264:
10265: Side effects: populates cats, idx and jsarray.
10266:
10267: =cut
10268:
10269: sub gather_categories {
10270: my ($categories,$cats,$idx,$jsarray) = @_;
10271: my %counters;
10272: my $num = 0;
10273: foreach my $item (keys(%{$categories})) {
10274: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
10275: if ($container eq '' && $depth == 0) {
10276: $cats->[$depth][$categories->{$item}] = $cat;
10277: } else {
10278: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
10279: }
10280: my ($escitem,$tail) = split(/:/,$item,2);
10281: if ($counters{$tail} eq '') {
10282: $counters{$tail} = $num;
10283: $num ++;
10284: }
10285: if (ref($idx) eq 'HASH') {
10286: $idx->{$item} = $counters{$tail};
10287: }
10288: if (ref($jsarray) eq 'ARRAY') {
10289: push(@{$jsarray->[$counters{$tail}]},$item);
10290: }
10291: }
10292: return;
10293: }
10294:
10295: =pod
10296:
10297: =item * &extract_categories()
10298:
10299: Used to generate breadcrumb trails for course categories.
10300:
10301: Inputs:
1.663 raeburn 10302:
1.655 raeburn 10303: categories (reference to hash of category definitions).
1.663 raeburn 10304:
1.655 raeburn 10305: cats (reference to array of arrays/hashes which encapsulates hierarchy of
10306: categories and subcategories).
1.663 raeburn 10307:
1.655 raeburn 10308: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 10309:
1.655 raeburn 10310: allitems (reference to hash - key is category key
10311: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 10312:
1.655 raeburn 10313: idx (reference to hash of counters used in Domain Coordinator interface for
10314: editing Course Categories).
1.663 raeburn 10315:
1.655 raeburn 10316: jsarray (reference to array of categories used to create Javascript arrays for
10317: Domain Coordinator interface for editing Course Categories).
10318:
1.665 raeburn 10319: subcats (reference to hash of arrays containing all subcategories within each
10320: category, -recursive)
10321:
1.655 raeburn 10322: Returns: nothing
10323:
10324: Side effects: populates trails and allitems hash references.
10325:
10326: =cut
10327:
10328: sub extract_categories {
1.665 raeburn 10329: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 10330: if (ref($categories) eq 'HASH') {
10331: &gather_categories($categories,$cats,$idx,$jsarray);
10332: if (ref($cats->[0]) eq 'ARRAY') {
10333: for (my $i=0; $i<@{$cats->[0]}; $i++) {
10334: my $name = $cats->[0][$i];
10335: my $item = &escape($name).'::0';
10336: my $trailstr;
10337: if ($name eq 'instcode') {
10338: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 10339: } elsif ($name eq 'communities') {
10340: $trailstr = &mt('Communities');
1.655 raeburn 10341: } else {
10342: $trailstr = $name;
10343: }
10344: if ($allitems->{$item} eq '') {
10345: push(@{$trails},$trailstr);
10346: $allitems->{$item} = scalar(@{$trails})-1;
10347: }
10348: my @parents = ($name);
10349: if (ref($cats->[1]{$name}) eq 'ARRAY') {
10350: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
10351: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 10352: if (ref($subcats) eq 'HASH') {
10353: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
10354: }
10355: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
10356: }
10357: } else {
10358: if (ref($subcats) eq 'HASH') {
10359: $subcats->{$item} = [];
1.655 raeburn 10360: }
10361: }
10362: }
10363: }
10364: }
10365: return;
10366: }
10367:
10368: =pod
10369:
10370: =item *&recurse_categories()
10371:
10372: Recursively used to generate breadcrumb trails for course categories.
10373:
10374: Inputs:
1.663 raeburn 10375:
1.655 raeburn 10376: cats (reference to array of arrays/hashes which encapsulates hierarchy of
10377: categories and subcategories).
1.663 raeburn 10378:
1.655 raeburn 10379: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 10380:
10381: category (current course category, for which breadcrumb trail is being generated).
10382:
10383: trails (reference to array of breadcrumb trails for each category).
10384:
1.655 raeburn 10385: allitems (reference to hash - key is category key
10386: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 10387:
1.655 raeburn 10388: parents (array containing containers directories for current category,
10389: back to top level).
10390:
10391: Returns: nothing
10392:
10393: Side effects: populates trails and allitems hash references
10394:
10395: =cut
10396:
10397: sub recurse_categories {
1.665 raeburn 10398: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 10399: my $shallower = $depth - 1;
10400: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
10401: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
10402: my $name = $cats->[$depth]{$category}[$k];
10403: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
10404: my $trailstr = join(' -> ',(@{$parents},$category));
10405: if ($allitems->{$item} eq '') {
10406: push(@{$trails},$trailstr);
10407: $allitems->{$item} = scalar(@{$trails})-1;
10408: }
10409: my $deeper = $depth+1;
10410: push(@{$parents},$category);
1.665 raeburn 10411: if (ref($subcats) eq 'HASH') {
10412: my $subcat = &escape($name).':'.$category.':'.$depth;
10413: for (my $j=@{$parents}; $j>=0; $j--) {
10414: my $higher;
10415: if ($j > 0) {
10416: $higher = &escape($parents->[$j]).':'.
10417: &escape($parents->[$j-1]).':'.$j;
10418: } else {
10419: $higher = &escape($parents->[$j]).'::'.$j;
10420: }
10421: push(@{$subcats->{$higher}},$subcat);
10422: }
10423: }
10424: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
10425: $subcats);
1.655 raeburn 10426: pop(@{$parents});
10427: }
10428: } else {
10429: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
10430: my $trailstr = join(' -> ',(@{$parents},$category));
10431: if ($allitems->{$item} eq '') {
10432: push(@{$trails},$trailstr);
10433: $allitems->{$item} = scalar(@{$trails})-1;
10434: }
10435: }
10436: return;
10437: }
10438:
1.663 raeburn 10439: =pod
10440:
10441: =item *&assign_categories_table()
10442:
10443: Create a datatable for display of hierarchical categories in a domain,
10444: with checkboxes to allow a course to be categorized.
10445:
10446: Inputs:
10447:
10448: cathash - reference to hash of categories defined for the domain (from
10449: configuration.db)
10450:
10451: currcat - scalar with an & separated list of categories assigned to a course.
10452:
1.919 raeburn 10453: type - scalar contains course type (Course or Community).
10454:
1.663 raeburn 10455: Returns: $output (markup to be displayed)
10456:
10457: =cut
10458:
10459: sub assign_categories_table {
1.919 raeburn 10460: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 10461: my $output;
10462: if (ref($cathash) eq 'HASH') {
10463: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
10464: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
10465: $maxdepth = scalar(@cats);
10466: if (@cats > 0) {
10467: my $itemcount = 0;
10468: if (ref($cats[0]) eq 'ARRAY') {
10469: my @currcategories;
10470: if ($currcat ne '') {
10471: @currcategories = split('&',$currcat);
10472: }
1.919 raeburn 10473: my $table;
1.663 raeburn 10474: for (my $i=0; $i<@{$cats[0]}; $i++) {
10475: my $parent = $cats[0][$i];
1.919 raeburn 10476: next if ($parent eq 'instcode');
10477: if ($type eq 'Community') {
10478: next unless ($parent eq 'communities');
10479: } else {
10480: next if ($parent eq 'communities');
10481: }
1.663 raeburn 10482: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
10483: my $item = &escape($parent).'::0';
10484: my $checked = '';
10485: if (@currcategories > 0) {
10486: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 10487: $checked = ' checked="checked"';
1.663 raeburn 10488: }
10489: }
1.919 raeburn 10490: my $parent_title = $parent;
10491: if ($parent eq 'communities') {
10492: $parent_title = &mt('Communities');
10493: }
10494: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
10495: '<input type="checkbox" name="usecategory" value="'.
10496: $item.'"'.$checked.' />'.$parent_title.'</span>'.
10497: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 10498: my $depth = 1;
10499: push(@path,$parent);
1.919 raeburn 10500: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 10501: pop(@path);
1.919 raeburn 10502: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 10503: $itemcount ++;
10504: }
1.919 raeburn 10505: if ($itemcount) {
10506: $output = &Apache::loncommon::start_data_table().
10507: $table.
10508: &Apache::loncommon::end_data_table();
10509: }
1.663 raeburn 10510: }
10511: }
10512: }
10513: return $output;
10514: }
10515:
10516: =pod
10517:
10518: =item *&assign_category_rows()
10519:
10520: Create a datatable row for display of nested categories in a domain,
10521: with checkboxes to allow a course to be categorized,called recursively.
10522:
10523: Inputs:
10524:
10525: itemcount - track row number for alternating colors
10526:
10527: cats - reference to array of arrays/hashes which encapsulates hierarchy of
10528: categories and subcategories.
10529:
10530: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
10531:
10532: parent - parent of current category item
10533:
10534: path - Array containing all categories back up through the hierarchy from the
10535: current category to the top level.
10536:
10537: currcategories - reference to array of current categories assigned to the course
10538:
10539: Returns: $output (markup to be displayed).
10540:
10541: =cut
10542:
10543: sub assign_category_rows {
10544: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
10545: my ($text,$name,$item,$chgstr);
10546: if (ref($cats) eq 'ARRAY') {
10547: my $maxdepth = scalar(@{$cats});
10548: if (ref($cats->[$depth]) eq 'HASH') {
10549: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
10550: my $numchildren = @{$cats->[$depth]{$parent}};
10551: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
10552: $text .= '<td><table class="LC_datatable">';
10553: for (my $j=0; $j<$numchildren; $j++) {
10554: $name = $cats->[$depth]{$parent}[$j];
10555: $item = &escape($name).':'.&escape($parent).':'.$depth;
10556: my $deeper = $depth+1;
10557: my $checked = '';
10558: if (ref($currcategories) eq 'ARRAY') {
10559: if (@{$currcategories} > 0) {
10560: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 10561: $checked = ' checked="checked"';
1.663 raeburn 10562: }
10563: }
10564: }
1.664 raeburn 10565: $text .= '<tr><td><span class="LC_nobreak"><label>'.
10566: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 10567: $item.'"'.$checked.' />'.$name.'</label></span>'.
10568: '<input type="hidden" name="catname" value="'.$name.'" />'.
10569: '</td><td>';
1.663 raeburn 10570: if (ref($path) eq 'ARRAY') {
10571: push(@{$path},$name);
10572: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
10573: pop(@{$path});
10574: }
10575: $text .= '</td></tr>';
10576: }
10577: $text .= '</table></td>';
10578: }
10579: }
10580: }
10581: return $text;
10582: }
10583:
1.655 raeburn 10584: ############################################################
10585: ############################################################
10586:
10587:
1.443 albertel 10588: sub commit_customrole {
1.664 raeburn 10589: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 10590: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 10591: ($start?', '.&mt('starting').' '.localtime($start):'').
10592: ($end?', ending '.localtime($end):'').': <b>'.
10593: &Apache::lonnet::assigncustomrole(
1.664 raeburn 10594: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 10595: '</b><br />';
10596: return $output;
10597: }
10598:
10599: sub commit_standardrole {
1.541 raeburn 10600: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
10601: my ($output,$logmsg,$linefeed);
10602: if ($context eq 'auto') {
10603: $linefeed = "\n";
10604: } else {
10605: $linefeed = "<br />\n";
10606: }
1.443 albertel 10607: if ($three eq 'st') {
1.541 raeburn 10608: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
10609: $one,$two,$sec,$context);
10610: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 10611: ($result eq 'unknown_course') || ($result eq 'refused')) {
10612: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 10613: } else {
1.541 raeburn 10614: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 10615: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 10616: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
10617: if ($context eq 'auto') {
10618: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
10619: } else {
10620: $output .= '<b>'.$result.'</b>'.$linefeed.
10621: &mt('Add to classlist').': <b>ok</b>';
10622: }
10623: $output .= $linefeed;
1.443 albertel 10624: }
10625: } else {
10626: $output = &mt('Assigning').' '.$three.' in '.$url.
10627: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 10628: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 10629: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 10630: if ($context eq 'auto') {
10631: $output .= $result.$linefeed;
10632: } else {
10633: $output .= '<b>'.$result.'</b>'.$linefeed;
10634: }
1.443 albertel 10635: }
10636: return $output;
10637: }
10638:
10639: sub commit_studentrole {
1.541 raeburn 10640: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 10641: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 10642: if ($context eq 'auto') {
10643: $linefeed = "\n";
10644: } else {
10645: $linefeed = '<br />'."\n";
10646: }
1.443 albertel 10647: if (defined($one) && defined($two)) {
10648: my $cid=$one.'_'.$two;
10649: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
10650: my $secchange = 0;
10651: my $expire_role_result;
10652: my $modify_section_result;
1.628 raeburn 10653: if ($oldsec ne '-1') {
10654: if ($oldsec ne $sec) {
1.443 albertel 10655: $secchange = 1;
1.628 raeburn 10656: my $now = time;
1.443 albertel 10657: my $uurl='/'.$cid;
10658: $uurl=~s/\_/\//g;
10659: if ($oldsec) {
10660: $uurl.='/'.$oldsec;
10661: }
1.626 raeburn 10662: $oldsecurl = $uurl;
1.628 raeburn 10663: $expire_role_result =
1.652 raeburn 10664: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 10665: if ($env{'request.course.sec'} ne '') {
10666: if ($expire_role_result eq 'refused') {
10667: my @roles = ('st');
10668: my @statuses = ('previous');
10669: my @roledoms = ($one);
10670: my $withsec = 1;
10671: my %roleshash =
10672: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
10673: \@statuses,\@roles,\@roledoms,$withsec);
10674: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
10675: my ($oldstart,$oldend) =
10676: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
10677: if ($oldend > 0 && $oldend <= $now) {
10678: $expire_role_result = 'ok';
10679: }
10680: }
10681: }
10682: }
1.443 albertel 10683: $result = $expire_role_result;
10684: }
10685: }
10686: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 10687: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 10688: if ($modify_section_result =~ /^ok/) {
10689: if ($secchange == 1) {
1.628 raeburn 10690: if ($sec eq '') {
10691: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
10692: } else {
10693: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
10694: }
1.443 albertel 10695: } elsif ($oldsec eq '-1') {
1.628 raeburn 10696: if ($sec eq '') {
10697: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
10698: } else {
10699: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
10700: }
1.443 albertel 10701: } else {
1.628 raeburn 10702: if ($sec eq '') {
10703: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
10704: } else {
10705: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
10706: }
1.443 albertel 10707: }
10708: } else {
1.628 raeburn 10709: if ($secchange) {
10710: $$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;
10711: } else {
10712: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
10713: }
1.443 albertel 10714: }
10715: $result = $modify_section_result;
10716: } elsif ($secchange == 1) {
1.628 raeburn 10717: if ($oldsec eq '') {
10718: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
10719: } else {
10720: $$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;
10721: }
1.626 raeburn 10722: if ($expire_role_result eq 'refused') {
10723: my $newsecurl = '/'.$cid;
10724: $newsecurl =~ s/\_/\//g;
10725: if ($sec ne '') {
10726: $newsecurl.='/'.$sec;
10727: }
10728: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
10729: if ($sec eq '') {
10730: $$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;
10731: } else {
10732: $$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;
10733: }
10734: }
10735: }
1.443 albertel 10736: }
10737: } else {
1.626 raeburn 10738: $$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 10739: $result = "error: incomplete course id\n";
10740: }
10741: return $result;
10742: }
10743:
10744: ############################################################
10745: ############################################################
10746:
1.566 albertel 10747: sub check_clone {
1.578 raeburn 10748: my ($args,$linefeed) = @_;
1.566 albertel 10749: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
10750: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
10751: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
10752: my $clonemsg;
10753: my $can_clone = 0;
1.944 raeburn 10754: my $lctype = lc($args->{'crstype'});
1.908 raeburn 10755: if ($lctype ne 'community') {
10756: $lctype = 'course';
10757: }
1.566 albertel 10758: if ($clonehome eq 'no_host') {
1.944 raeburn 10759: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10760: $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'});
10761: } else {
10762: $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'});
10763: }
1.566 albertel 10764: } else {
10765: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944 raeburn 10766: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10767: if ($clonedesc{'type'} ne 'Community') {
10768: $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'});
10769: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10770: }
10771: }
1.882 raeburn 10772: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
10773: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 10774: $can_clone = 1;
10775: } else {
10776: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
10777: $args->{'clonedomain'},$args->{'clonecourse'});
10778: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 10779: if (grep(/^\*$/,@cloners)) {
10780: $can_clone = 1;
10781: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
10782: $can_clone = 1;
10783: } else {
1.908 raeburn 10784: my $ccrole = 'cc';
1.944 raeburn 10785: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10786: $ccrole = 'co';
10787: }
1.578 raeburn 10788: my %roleshash =
10789: &Apache::lonnet::get_my_roles($args->{'ccuname'},
10790: $args->{'ccdomain'},
1.908 raeburn 10791: 'userroles',['active'],[$ccrole],
1.578 raeburn 10792: [$args->{'clonedomain'}]);
1.908 raeburn 10793: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942 raeburn 10794: $can_clone = 1;
10795: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
10796: $can_clone = 1;
10797: } else {
1.944 raeburn 10798: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10799: $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'});
10800: } else {
10801: $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'});
10802: }
1.578 raeburn 10803: }
1.566 albertel 10804: }
1.578 raeburn 10805: }
1.566 albertel 10806: }
10807: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10808: }
10809:
1.444 albertel 10810: sub construct_course {
1.885 raeburn 10811: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444 albertel 10812: my $outcome;
1.541 raeburn 10813: my $linefeed = '<br />'."\n";
10814: if ($context eq 'auto') {
10815: $linefeed = "\n";
10816: }
1.566 albertel 10817:
10818: #
10819: # Are we cloning?
10820: #
10821: my ($can_clone, $clonemsg, $cloneid, $clonehome);
10822: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 10823: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 10824: if ($context ne 'auto') {
1.578 raeburn 10825: if ($clonemsg ne '') {
10826: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
10827: }
1.566 albertel 10828: }
10829: $outcome .= $clonemsg.$linefeed;
10830:
10831: if (!$can_clone) {
10832: return (0,$outcome);
10833: }
10834: }
10835:
1.444 albertel 10836: #
10837: # Open course
10838: #
10839: my $crstype = lc($args->{'crstype'});
10840: my %cenv=();
10841: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
10842: $args->{'cdescr'},
10843: $args->{'curl'},
10844: $args->{'course_home'},
10845: $args->{'nonstandard'},
10846: $args->{'crscode'},
10847: $args->{'ccuname'}.':'.
10848: $args->{'ccdomain'},
1.882 raeburn 10849: $args->{'crstype'},
1.885 raeburn 10850: $cnum,$context,$category);
1.444 albertel 10851:
10852: # Note: The testing routines depend on this being output; see
10853: # Utils::Course. This needs to at least be output as a comment
10854: # if anyone ever decides to not show this, and Utils::Course::new
10855: # will need to be suitably modified.
1.541 raeburn 10856: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943 raeburn 10857: if ($$courseid =~ /^error:/) {
10858: return (0,$outcome);
10859: }
10860:
1.444 albertel 10861: #
10862: # Check if created correctly
10863: #
1.479 albertel 10864: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 10865: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 10866: if ($crsuhome eq 'no_host') {
10867: $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
10868: return (0,$outcome);
10869: }
1.541 raeburn 10870: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 10871:
1.444 albertel 10872: #
1.566 albertel 10873: # Do the cloning
10874: #
10875: if ($can_clone && $cloneid) {
10876: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
10877: if ($context ne 'auto') {
10878: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
10879: }
10880: $outcome .= $clonemsg.$linefeed;
10881: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 10882: # Copy all files
1.637 www 10883: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 10884: # Restore URL
1.566 albertel 10885: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 10886: # Restore title
1.566 albertel 10887: $cenv{'description'}=$oldcenv{'description'};
1.948.2.2 raeburn 10888: # Restore creation date, creator and creation context.
10889: $cenv{'internal.created'}=$oldcenv{'internal.created'};
10890: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
10891: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 10892: # Mark as cloned
1.566 albertel 10893: $cenv{'clonedfrom'}=$cloneid;
1.638 www 10894: # Need to clone grading mode
10895: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
10896: $cenv{'grading'}=$newenv{'grading'};
10897: # Do not clone these environment entries
10898: &Apache::lonnet::del('environment',
10899: ['default_enrollment_start_date',
10900: 'default_enrollment_end_date',
10901: 'question.email',
10902: 'policy.email',
10903: 'comment.email',
10904: 'pch.users.denied',
1.725 raeburn 10905: 'plc.users.denied',
10906: 'hidefromcat',
10907: 'categories'],
1.638 www 10908: $$crsudom,$$crsunum);
1.444 albertel 10909: }
1.566 albertel 10910:
1.444 albertel 10911: #
10912: # Set environment (will override cloned, if existing)
10913: #
10914: my @sections = ();
10915: my @xlists = ();
10916: if ($args->{'crstype'}) {
10917: $cenv{'type'}=$args->{'crstype'};
10918: }
10919: if ($args->{'crsid'}) {
10920: $cenv{'courseid'}=$args->{'crsid'};
10921: }
10922: if ($args->{'crscode'}) {
10923: $cenv{'internal.coursecode'}=$args->{'crscode'};
10924: }
10925: if ($args->{'crsquota'} ne '') {
10926: $cenv{'internal.coursequota'}=$args->{'crsquota'};
10927: } else {
10928: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
10929: }
10930: if ($args->{'ccuname'}) {
10931: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
10932: ':'.$args->{'ccdomain'};
10933: } else {
10934: $cenv{'internal.courseowner'} = $args->{'curruser'};
10935: }
10936: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
10937: if ($args->{'crssections'}) {
10938: $cenv{'internal.sectionnums'} = '';
10939: if ($args->{'crssections'} =~ m/,/) {
10940: @sections = split/,/,$args->{'crssections'};
10941: } else {
10942: $sections[0] = $args->{'crssections'};
10943: }
10944: if (@sections > 0) {
10945: foreach my $item (@sections) {
10946: my ($sec,$gp) = split/:/,$item;
10947: my $class = $args->{'crscode'}.$sec;
10948: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
10949: $cenv{'internal.sectionnums'} .= $item.',';
10950: unless ($addcheck eq 'ok') {
10951: push @badclasses, $class;
10952: }
10953: }
10954: $cenv{'internal.sectionnums'} =~ s/,$//;
10955: }
10956: }
10957: # do not hide course coordinator from staff listing,
10958: # even if privileged
10959: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10960: # add crosslistings
10961: if ($args->{'crsxlist'}) {
10962: $cenv{'internal.crosslistings'}='';
10963: if ($args->{'crsxlist'} =~ m/,/) {
10964: @xlists = split/,/,$args->{'crsxlist'};
10965: } else {
10966: $xlists[0] = $args->{'crsxlist'};
10967: }
10968: if (@xlists > 0) {
10969: foreach my $item (@xlists) {
10970: my ($xl,$gp) = split/:/,$item;
10971: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
10972: $cenv{'internal.crosslistings'} .= $item.',';
10973: unless ($addcheck eq 'ok') {
10974: push @badclasses, $xl;
10975: }
10976: }
10977: $cenv{'internal.crosslistings'} =~ s/,$//;
10978: }
10979: }
10980: if ($args->{'autoadds'}) {
10981: $cenv{'internal.autoadds'}=$args->{'autoadds'};
10982: }
10983: if ($args->{'autodrops'}) {
10984: $cenv{'internal.autodrops'}=$args->{'autodrops'};
10985: }
10986: # check for notification of enrollment changes
10987: my @notified = ();
10988: if ($args->{'notify_owner'}) {
10989: if ($args->{'ccuname'} ne '') {
10990: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
10991: }
10992: }
10993: if ($args->{'notify_dc'}) {
10994: if ($uname ne '') {
1.630 raeburn 10995: push(@notified,$uname.':'.$udom);
1.444 albertel 10996: }
10997: }
10998: if (@notified > 0) {
10999: my $notifylist;
11000: if (@notified > 1) {
11001: $notifylist = join(',',@notified);
11002: } else {
11003: $notifylist = $notified[0];
11004: }
11005: $cenv{'internal.notifylist'} = $notifylist;
11006: }
11007: if (@badclasses > 0) {
11008: my %lt=&Apache::lonlocal::texthash(
11009: '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',
11010: 'dnhr' => 'does not have rights to access enrollment in these classes',
11011: 'adby' => 'as determined by the policies of your institution on access to official classlists'
11012: );
1.541 raeburn 11013: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
11014: ' ('.$lt{'adby'}.')';
11015: if ($context eq 'auto') {
11016: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 11017: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 11018: foreach my $item (@badclasses) {
11019: if ($context eq 'auto') {
11020: $outcome .= " - $item\n";
11021: } else {
11022: $outcome .= "<li>$item</li>\n";
11023: }
11024: }
11025: if ($context eq 'auto') {
11026: $outcome .= $linefeed;
11027: } else {
1.566 albertel 11028: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 11029: }
11030: }
1.444 albertel 11031: }
11032: if ($args->{'no_end_date'}) {
11033: $args->{'endaccess'} = 0;
11034: }
11035: $cenv{'internal.autostart'}=$args->{'enrollstart'};
11036: $cenv{'internal.autoend'}=$args->{'enrollend'};
11037: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
11038: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
11039: if ($args->{'showphotos'}) {
11040: $cenv{'internal.showphotos'}=$args->{'showphotos'};
11041: }
11042: $cenv{'internal.authtype'} = $args->{'authtype'};
11043: $cenv{'internal.autharg'} = $args->{'autharg'};
11044: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
11045: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 11046: 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');
11047: if ($context eq 'auto') {
11048: $outcome .= $krb_msg;
11049: } else {
1.566 albertel 11050: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 11051: }
11052: $outcome .= $linefeed;
1.444 albertel 11053: }
11054: }
11055: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
11056: if ($args->{'setpolicy'}) {
11057: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
11058: }
11059: if ($args->{'setcontent'}) {
11060: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
11061: }
11062: }
11063: if ($args->{'reshome'}) {
11064: $cenv{'reshome'}=$args->{'reshome'}.'/';
11065: $cenv{'reshome'}=~s/\/+$/\//;
11066: }
11067: #
11068: # course has keyed access
11069: #
11070: if ($args->{'setkeys'}) {
11071: $cenv{'keyaccess'}='yes';
11072: }
11073: # if specified, key authority is not course, but user
11074: # only active if keyaccess is yes
11075: if ($args->{'keyauth'}) {
1.487 albertel 11076: my ($user,$domain) = split(':',$args->{'keyauth'});
11077: $user = &LONCAPA::clean_username($user);
11078: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 11079: if ($user ne '' && $domain ne '') {
1.487 albertel 11080: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 11081: }
11082: }
11083:
11084: if ($args->{'disresdis'}) {
11085: $cenv{'pch.roles.denied'}='st';
11086: }
11087: if ($args->{'disablechat'}) {
11088: $cenv{'plc.roles.denied'}='st';
11089: }
11090:
11091: # Record we've not yet viewed the Course Initialization Helper for this
11092: # course
11093: $cenv{'course.helper.not.run'} = 1;
11094: #
11095: # Use new Randomseed
11096: #
11097: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
11098: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
11099: #
11100: # The encryption code and receipt prefix for this course
11101: #
11102: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
11103: $cenv{'internal.encpref'}=100+int(9*rand(99));
11104: #
11105: # By default, use standard grading
11106: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
11107:
1.541 raeburn 11108: $outcome .= $linefeed.&mt('Setting environment').': '.
11109: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 11110: #
11111: # Open all assignments
11112: #
11113: if ($args->{'openall'}) {
11114: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
11115: my %storecontent = ($storeunder => time,
11116: $storeunder.'.type' => 'date_start');
11117:
11118: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 11119: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 11120: }
11121: #
11122: # Set first page
11123: #
11124: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
11125: || ($cloneid)) {
1.445 albertel 11126: use LONCAPA::map;
1.444 albertel 11127: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 11128:
11129: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
11130: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
11131:
1.444 albertel 11132: $outcome .= ($fatal?$errtext:'read ok').' - ';
11133: my $title; my $url;
11134: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 11135: $title=&mt('Syllabus');
1.444 albertel 11136: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
11137: } else {
1.948.2.5 raeburn 11138: $title=&mt('Table of Contents');
1.444 albertel 11139: $url='/adm/navmaps';
11140: }
1.445 albertel 11141:
11142: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
11143: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
11144:
11145: if ($errtext) { $fatal=2; }
1.541 raeburn 11146: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 11147: }
1.566 albertel 11148:
11149: return (1,$outcome);
1.444 albertel 11150: }
11151:
11152: ############################################################
11153: ############################################################
11154:
1.378 raeburn 11155: sub course_type {
11156: my ($cid) = @_;
11157: if (!defined($cid)) {
11158: $cid = $env{'request.course.id'};
11159: }
1.404 albertel 11160: if (defined($env{'course.'.$cid.'.type'})) {
11161: return $env{'course.'.$cid.'.type'};
1.378 raeburn 11162: } else {
11163: return 'Course';
1.377 raeburn 11164: }
11165: }
1.156 albertel 11166:
1.406 raeburn 11167: sub group_term {
11168: my $crstype = &course_type();
11169: my %names = (
11170: 'Course' => 'group',
1.865 raeburn 11171: 'Community' => 'group',
1.406 raeburn 11172: );
11173: return $names{$crstype};
11174: }
11175:
1.902 raeburn 11176: sub course_types {
11177: my @types = ('official','unofficial','community');
11178: my %typename = (
11179: official => 'Official course',
11180: unofficial => 'Unofficial course',
11181: community => 'Community',
11182: );
11183: return (\@types,\%typename);
11184: }
11185:
1.156 albertel 11186: sub icon {
11187: my ($file)=@_;
1.505 albertel 11188: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 11189: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 11190: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 11191: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
11192: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
11193: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
11194: $curfext.".gif") {
11195: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
11196: $curfext.".gif";
11197: }
11198: }
1.249 albertel 11199: return &lonhttpdurl($iconname);
1.154 albertel 11200: }
1.84 albertel 11201:
1.575 albertel 11202: sub lonhttpdurl {
1.692 www 11203: #
11204: # Had been used for "small fry" static images on separate port 8080.
11205: # Modify here if lightweight http functionality desired again.
11206: # Currently eliminated due to increasing firewall issues.
11207: #
1.575 albertel 11208: my ($url)=@_;
1.692 www 11209: return $url;
1.215 albertel 11210: }
11211:
1.213 albertel 11212: sub connection_aborted {
11213: my ($r)=@_;
11214: $r->print(" ");$r->rflush();
11215: my $c = $r->connection;
11216: return $c->aborted();
11217: }
11218:
1.221 foxr 11219: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 11220: # strings as 'strings'.
11221: sub escape_single {
1.221 foxr 11222: my ($input) = @_;
1.223 albertel 11223: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 11224: $input =~ s/\'/\\\'/g; # Esacpe the 's....
11225: return $input;
11226: }
1.223 albertel 11227:
1.222 foxr 11228: # Same as escape_single, but escape's "'s This
11229: # can be used for "strings"
11230: sub escape_double {
11231: my ($input) = @_;
11232: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
11233: $input =~ s/\"/\\\"/g; # Esacpe the "s....
11234: return $input;
11235: }
1.223 albertel 11236:
1.222 foxr 11237: # Escapes the last element of a full URL.
11238: sub escape_url {
11239: my ($url) = @_;
1.238 raeburn 11240: my @urlslices = split(/\//, $url,-1);
1.369 www 11241: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 11242: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 11243: }
1.462 albertel 11244:
1.820 raeburn 11245: sub compare_arrays {
11246: my ($arrayref1,$arrayref2) = @_;
11247: my (@difference,%count);
11248: @difference = ();
11249: %count = ();
11250: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
11251: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
11252: foreach my $element (keys(%count)) {
11253: if ($count{$element} == 1) {
11254: push(@difference,$element);
11255: }
11256: }
11257: }
11258: return @difference;
11259: }
11260:
1.817 bisitz 11261: # -------------------------------------------------------- Initialize user login
1.462 albertel 11262: sub init_user_environment {
1.463 albertel 11263: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 11264: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
11265:
11266: my $public=($username eq 'public' && $domain eq 'public');
11267:
11268: # See if old ID present, if so, remove
11269:
11270: my ($filename,$cookie,$userroles);
11271: my $now=time;
11272:
11273: if ($public) {
11274: my $max_public=100;
11275: my $oldest;
11276: my $oldest_time=0;
11277: for(my $next=1;$next<=$max_public;$next++) {
11278: if (-e $lonids."/publicuser_$next.id") {
11279: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
11280: if ($mtime<$oldest_time || !$oldest_time) {
11281: $oldest_time=$mtime;
11282: $oldest=$next;
11283: }
11284: } else {
11285: $cookie="publicuser_$next";
11286: last;
11287: }
11288: }
11289: if (!$cookie) { $cookie="publicuser_$oldest"; }
11290: } else {
1.463 albertel 11291: # if this isn't a robot, kill any existing non-robot sessions
11292: if (!$args->{'robot'}) {
11293: opendir(DIR,$lonids);
11294: while ($filename=readdir(DIR)) {
11295: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
11296: unlink($lonids.'/'.$filename);
11297: }
1.462 albertel 11298: }
1.463 albertel 11299: closedir(DIR);
1.462 albertel 11300: }
11301: # Give them a new cookie
1.463 albertel 11302: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 11303: : $now.$$.int(rand(10000)));
1.463 albertel 11304: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 11305:
11306: # Initialize roles
11307:
11308: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
11309: }
11310: # ------------------------------------ Check browser type and MathML capability
11311:
11312: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
11313: $clientunicode,$clientos) = &decode_user_agent($r);
11314:
11315: # ------------------------------------------------------------- Get environment
11316:
11317: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
11318: my ($tmp) = keys(%userenv);
11319: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
11320: # default remote control to off
11321: if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
11322: } else {
11323: undef(%userenv);
11324: }
11325: if (($userenv{'interface'}) && (!$form->{'interface'})) {
11326: $form->{'interface'}=$userenv{'interface'};
11327: }
11328: $env{'environment.remote'}=$userenv{'remote'};
11329: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
11330:
11331: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 11332: foreach my $option ('interface','localpath','localres') {
11333: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 11334: }
11335: # --------------------------------------------------------- Write first profile
11336:
11337: {
11338: my %initial_env =
11339: ("user.name" => $username,
11340: "user.domain" => $domain,
11341: "user.home" => $authhost,
11342: "browser.type" => $clientbrowser,
11343: "browser.version" => $clientversion,
11344: "browser.mathml" => $clientmathml,
11345: "browser.unicode" => $clientunicode,
11346: "browser.os" => $clientos,
11347: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
11348: "request.course.fn" => '',
11349: "request.course.uri" => '',
11350: "request.course.sec" => '',
11351: "request.role" => 'cm',
11352: "request.role.adv" => $env{'user.adv'},
11353: "request.host" => $ENV{'REMOTE_ADDR'},);
11354:
11355: if ($form->{'localpath'}) {
11356: $initial_env{"browser.localpath"} = $form->{'localpath'};
11357: $initial_env{"browser.localres"} = $form->{'localres'};
11358: }
11359:
11360: if ($public) {
11361: $initial_env{"environment.remote"} = "off";
11362: }
11363: if ($form->{'interface'}) {
11364: $form->{'interface'}=~s/\W//gs;
11365: $initial_env{"browser.interface"} = $form->{'interface'};
11366: $env{'browser.interface'}=$form->{'interface'};
11367: }
1.948.2.11 raeburn 11368: my %is_adv = ( is_adv => $env{'user.adv'} );
1.948.2.10 raeburn 11369: my %domdef = &Apache::lonnet::get_domain_defaults($domain);
1.462 albertel 11370:
1.724 raeburn 11371: foreach my $tool ('aboutme','blog','portfolio') {
11372: $userenv{'availabletools.'.$tool} =
1.948.2.10 raeburn 11373: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
11374: undef,\%userenv,\%domdef,\%is_adv);
1.724 raeburn 11375: }
11376:
1.864 raeburn 11377: foreach my $crstype ('official','unofficial','community') {
1.765 raeburn 11378: $userenv{'canrequest.'.$crstype} =
11379: &Apache::lonnet::usertools_access($username,$domain,$crstype,
1.948.2.10 raeburn 11380: 'reload','requestcourses',
11381: \%userenv,\%domdef,\%is_adv);
1.765 raeburn 11382: }
11383:
1.462 albertel 11384: $env{'user.environment'} = "$lonids/$cookie.id";
11385:
11386: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
11387: &GDBM_WRCREAT(),0640)) {
11388: &_add_to_env(\%disk_env,\%initial_env);
11389: &_add_to_env(\%disk_env,\%userenv,'environment.');
11390: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 11391: if (ref($args->{'extra_env'})) {
11392: &_add_to_env(\%disk_env,$args->{'extra_env'});
11393: }
1.462 albertel 11394: untie(%disk_env);
11395: } else {
1.705 tempelho 11396: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
11397: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 11398: return 'error: '.$!;
11399: }
11400: }
11401: $env{'request.role'}='cm';
11402: $env{'request.role.adv'}=$env{'user.adv'};
11403: $env{'browser.type'}=$clientbrowser;
11404:
11405: return $cookie;
11406:
11407: }
11408:
11409: sub _add_to_env {
11410: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 11411: if (ref($env_data) eq 'HASH') {
11412: while (my ($key,$value) = each(%$env_data)) {
11413: $idf->{$prefix.$key} = $value;
11414: $env{$prefix.$key} = $value;
11415: }
1.462 albertel 11416: }
11417: }
11418:
1.685 tempelho 11419: # --- Get the symbolic name of a problem and the url
11420: sub get_symb {
11421: my ($request,$silent) = @_;
1.726 raeburn 11422: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 11423: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
11424: if ($symb eq '') {
11425: if (!$silent) {
11426: $request->print("Unable to handle ambiguous references:$url:.");
11427: return ();
11428: }
11429: }
11430: &Apache::lonenc::check_decrypt(\$symb);
11431: return ($symb);
11432: }
11433:
11434: # --------------------------------------------------------------Get annotation
11435:
11436: sub get_annotation {
11437: my ($symb,$enc) = @_;
11438:
11439: my $key = $symb;
11440: if (!$enc) {
11441: $key =
11442: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
11443: }
11444: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
11445: return $annotation{$key};
11446: }
11447:
11448: sub clean_symb {
1.731 raeburn 11449: my ($symb,$delete_enc) = @_;
1.685 tempelho 11450:
11451: &Apache::lonenc::check_decrypt(\$symb);
11452: my $enc = $env{'request.enc'};
1.731 raeburn 11453: if ($delete_enc) {
1.730 raeburn 11454: delete($env{'request.enc'});
11455: }
1.685 tempelho 11456:
11457: return ($symb,$enc);
11458: }
1.462 albertel 11459:
1.948.2.16 raeburn 11460: sub build_release_hashes {
11461: my ($checkparms,$checkresponsetypes,$checkcrstypes,$anonsurvey,$randomizetry) = @_;
11462: return unless((ref($checkparms) eq 'HASH') && (ref($checkresponsetypes) eq 'HASH') &&
11463: (ref($checkcrstypes) eq 'HASH') && (ref($anonsurvey) eq 'HASH') &&
11464: (ref($randomizetry) eq 'HASH'));
11465: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
11466: my ($item,$name,$value) = split(/:/,$key);
11467: if ($item eq 'parameter') {
11468: if (ref($checkparms->{$name}) eq 'ARRAY') {
11469: unless(grep(/^\Q$name\E$/,@{$checkparms->{$name}})) {
11470: push(@{$checkparms->{$name}},$value);
11471: }
11472: } else {
11473: push(@{$checkparms->{$name}},$value);
11474: }
11475: } elsif ($item eq 'resourcetag') {
11476: if ($name eq 'responsetype') {
11477: $checkresponsetypes->{$value} = $Apache::lonnet::needsrelease{$key}
11478: }
11479: } elsif ($item eq 'course') {
11480: if ($name eq 'crstype') {
11481: $checkcrstypes->{$value} = $Apache::lonnet::needsrelease{$key};
11482: }
11483: }
11484: }
11485: ($anonsurvey->{major},$anonsurvey->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:anonsurvey'});
11486: ($randomizetry->{major},$randomizetry->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:randomizetry'});
11487: return;
11488: }
11489:
1.41 ng 11490: =pod
11491:
11492: =back
11493:
1.112 bowersj2 11494: =cut
1.41 ng 11495:
1.112 bowersj2 11496: 1;
11497: __END__;
1.41 ng 11498:
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