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