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