Annotation of loncom/interface/loncommon.pm, revision 1.987
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.987 ! raeburn 4: # $Id: loncommon.pm,v 1.986 2010/11/14 18:53: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.970 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.973 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
1.973 raeburn 1093: be useful for certain help topics with big pictures included.
1094:
1095: $imgid is the id of the img tag used for the help icon. This may be
1096: used in a javascript call to switch the image src. See
1097: lonhtmlcommon::htmlareaselectactive() for an example.
1.44 bowersj2 1098:
1099: =cut
1100:
1101: sub help_open_topic {
1.973 raeburn 1102: my ($topic, $text, $stayOnPage, $width, $height, $imgid) = @_;
1.48 bowersj2 1103: $text = "" if (not defined $text);
1.44 bowersj2 1104: $stayOnPage = 0 if (not defined $stayOnPage);
1105: $width = 350 if (not defined $width);
1106: $height = 400 if (not defined $height);
1107: my $filename = $topic;
1108: $filename =~ s/ /_/g;
1109:
1.48 bowersj2 1110: my $template = "";
1111: my $link;
1.572 banghart 1112:
1.159 www 1113: $topic=~s/\W/\_/g;
1.44 bowersj2 1114:
1.572 banghart 1115: if (!$stayOnPage) {
1.72 bowersj2 1116: $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 1117: } else {
1.48 bowersj2 1118: $link = "/adm/help/${filename}.hlp";
1119: }
1120:
1121: # Add the text
1.755 neumanie 1122: if ($text ne "") {
1.763 bisitz 1123: $template.='<span class="LC_help_open_topic">'
1124: .'<a target="_top" href="'.$link.'">'
1125: .$text.'</a>';
1.48 bowersj2 1126: }
1127:
1.763 bisitz 1128: # (Always) Add the graphic
1.179 matthew 1129: my $title = &mt('Online Help');
1.667 raeburn 1130: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973 raeburn 1131: if ($imgid ne '') {
1132: $imgid = ' id="'.$imgid.'"';
1133: }
1.763 bisitz 1134: $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
1135: .'<img src="'.$helpicon.'" border="0"'
1136: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973 raeburn 1137: .' title="'.$title.'" style="vertical-align:middle;"'.$imgid
1.763 bisitz 1138: .' /></a>';
1139: if ($text ne "") {
1140: $template.='</span>';
1141: }
1.44 bowersj2 1142: return $template;
1143:
1.106 bowersj2 1144: }
1145:
1146: # This is a quicky function for Latex cheatsheet editing, since it
1147: # appears in at least four places
1148: sub helpLatexCheatsheet {
1.732 raeburn 1149: my ($topic,$text,$not_author) = @_;
1150: my $out;
1.106 bowersj2 1151: my $addOther = '';
1.732 raeburn 1152: if ($topic) {
1.763 bisitz 1153: $addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
1154: undef, undef, 600).
1155: '</span> ';
1156: }
1157: $out = '<span>' # Start cheatsheet
1158: .$addOther
1159: .'<span>'
1160: .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
1161: undef,undef,600)
1162: .'</span> <span>'
1163: .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
1164: undef,undef,600)
1165: .'</span>';
1.732 raeburn 1166: unless ($not_author) {
1.763 bisitz 1167: $out .= ' <span>'
1168: .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
1169: undef,undef,600)
1170: .'</span>';
1.732 raeburn 1171: }
1.763 bisitz 1172: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1173: return $out;
1.172 www 1174: }
1175:
1.430 albertel 1176: sub general_help {
1177: my $helptopic='Student_Intro';
1178: if ($env{'request.role'}=~/^(ca|au)/) {
1179: $helptopic='Authoring_Intro';
1.907 raeburn 1180: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1181: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1182: } elsif ($env{'request.role'}=~/^dc/) {
1183: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1184: }
1185: return $helptopic;
1186: }
1187:
1188: sub update_help_link {
1189: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1190: my $origurl = $ENV{'REQUEST_URI'};
1191: $origurl=~s|^/~|/priv/|;
1192: my $timestamp = time;
1193: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1194: $$datum = &escape($$datum);
1195: }
1196:
1197: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1198: my $output .= <<"ENDOUTPUT";
1199: <script type="text/javascript">
1.824 bisitz 1200: // <![CDATA[
1.430 albertel 1201: banner_link = '$banner_link';
1.824 bisitz 1202: // ]]>
1.430 albertel 1203: </script>
1204: ENDOUTPUT
1205: return $output;
1206: }
1207:
1208: # now just updates the help link and generates a blue icon
1.193 raeburn 1209: sub help_open_menu {
1.430 albertel 1210: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1211: = @_;
1.949 droeschl 1212: $stayOnPage = 1;
1.430 albertel 1213: my $output;
1214: if ($component_help) {
1215: if (!$text) {
1216: $output=&help_open_topic($component_help,undef,$stayOnPage,
1217: $width,$height);
1218: } else {
1219: my $help_text;
1220: $help_text=&unescape($topic);
1221: $output='<table><tr><td>'.
1222: &help_open_topic($component_help,$help_text,$stayOnPage,
1223: $width,$height).'</td></tr></table>';
1224: }
1225: }
1226: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1227: return $output.$banner_link;
1228: }
1229:
1230: sub top_nav_help {
1231: my ($text) = @_;
1.436 albertel 1232: $text = &mt($text);
1.949 droeschl 1233: my $stay_on_page = 1;
1234:
1.572 banghart 1235: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1236: : "javascript:helpMenu('open')";
1.572 banghart 1237: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1238:
1.201 raeburn 1239: my $title = &mt('Get help');
1.436 albertel 1240:
1241: return <<"END";
1242: $banner_link
1243: <a href="$link" title="$title">$text</a>
1244: END
1245: }
1246:
1247: sub help_menu_js {
1248: my ($text) = @_;
1.949 droeschl 1249: my $stayOnPage = 1;
1.436 albertel 1250: my $width = 620;
1251: my $height = 600;
1.430 albertel 1252: my $helptopic=&general_help();
1253: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1254: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1255: my $start_page =
1256: &Apache::loncommon::start_page('Help Menu', undef,
1257: {'frameset' => 1,
1258: 'js_ready' => 1,
1259: 'add_entries' => {
1260: 'border' => '0',
1.579 raeburn 1261: 'rows' => "110,*",},});
1.331 albertel 1262: my $end_page =
1263: &Apache::loncommon::end_page({'frameset' => 1,
1264: 'js_ready' => 1,});
1265:
1.436 albertel 1266: my $template .= <<"ENDTEMPLATE";
1267: <script type="text/javascript">
1.877 bisitz 1268: // <![CDATA[
1.253 albertel 1269: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1270: var banner_link = '';
1.243 raeburn 1271: function helpMenu(target) {
1272: var caller = this;
1273: if (target == 'open') {
1274: var newWindow = null;
1275: try {
1.262 albertel 1276: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1277: }
1278: catch(error) {
1279: writeHelp(caller);
1280: return;
1281: }
1282: if (newWindow) {
1283: caller = newWindow;
1284: }
1.193 raeburn 1285: }
1.243 raeburn 1286: writeHelp(caller);
1287: return;
1288: }
1289: function writeHelp(caller) {
1.430 albertel 1290: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243 raeburn 1291: caller.document.close()
1292: caller.focus()
1.193 raeburn 1293: }
1.877 bisitz 1294: // END LON-CAPA Internal -->
1.253 albertel 1295: // ]]>
1.436 albertel 1296: </script>
1.193 raeburn 1297: ENDTEMPLATE
1298: return $template;
1299: }
1300:
1.172 www 1301: sub help_open_bug {
1302: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1303: unless ($env{'user.adv'}) { return ''; }
1.172 www 1304: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1305: $text = "" if (not defined $text);
1306: $stayOnPage=1;
1.184 albertel 1307: $width = 600 if (not defined $width);
1308: $height = 600 if (not defined $height);
1.172 www 1309:
1310: $topic=~s/\W+/\+/g;
1311: my $link='';
1312: my $template='';
1.379 albertel 1313: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1314: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1315: if (!$stayOnPage)
1316: {
1317: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1318: }
1319: else
1320: {
1321: $link = $url;
1322: }
1323: # Add the text
1324: if ($text ne "")
1325: {
1326: $template .=
1327: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1328: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1329: }
1330:
1331: # Add the graphic
1.179 matthew 1332: my $title = &mt('Report a Bug');
1.215 albertel 1333: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1334: $template .= <<"ENDTEMPLATE";
1.436 albertel 1335: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1336: ENDTEMPLATE
1337: if ($text ne '') { $template.='</td></tr></table>' };
1338: return $template;
1339:
1340: }
1341:
1342: sub help_open_faq {
1343: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1344: unless ($env{'user.adv'}) { return ''; }
1.172 www 1345: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1346: $text = "" if (not defined $text);
1347: $stayOnPage=1;
1348: $width = 350 if (not defined $width);
1349: $height = 400 if (not defined $height);
1350:
1351: $topic=~s/\W+/\+/g;
1352: my $link='';
1353: my $template='';
1354: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1355: if (!$stayOnPage)
1356: {
1357: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1358: }
1359: else
1360: {
1361: $link = $url;
1362: }
1363:
1364: # Add the text
1365: if ($text ne "")
1366: {
1367: $template .=
1.173 www 1368: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1369: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1370: }
1371:
1372: # Add the graphic
1.179 matthew 1373: my $title = &mt('View the FAQ');
1.215 albertel 1374: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1375: $template .= <<"ENDTEMPLATE";
1.436 albertel 1376: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1377: ENDTEMPLATE
1378: if ($text ne '') { $template.='</td></tr></table>' };
1379: return $template;
1380:
1.44 bowersj2 1381: }
1.37 matthew 1382:
1.180 matthew 1383: ###############################################################
1384: ###############################################################
1385:
1.45 matthew 1386: =pod
1387:
1.648 raeburn 1388: =item * &change_content_javascript():
1.256 matthew 1389:
1390: This and the next function allow you to create small sections of an
1391: otherwise static HTML page that you can update on the fly with
1392: Javascript, even in Netscape 4.
1393:
1394: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1395: must be written to the HTML page once. It will prove the Javascript
1396: function "change(name, content)". Calling the change function with the
1397: name of the section
1398: you want to update, matching the name passed to C<changable_area>, and
1399: the new content you want to put in there, will put the content into
1400: that area.
1401:
1402: B<Note>: Netscape 4 only reserves enough space for the changable area
1403: to contain room for the original contents. You need to "make space"
1404: for whatever changes you wish to make, and be B<sure> to check your
1405: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1406: it's adequate for updating a one-line status display, but little more.
1407: This script will set the space to 100% width, so you only need to
1408: worry about height in Netscape 4.
1409:
1410: Modern browsers are much less limiting, and if you can commit to the
1411: user not using Netscape 4, this feature may be used freely with
1412: pretty much any HTML.
1413:
1414: =cut
1415:
1416: sub change_content_javascript {
1417: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1418: if ($env{'browser.type'} eq 'netscape' &&
1419: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1420: return (<<NETSCAPE4);
1421: function change(name, content) {
1422: doc = document.layers[name+"___escape"].layers[0].document;
1423: doc.open();
1424: doc.write(content);
1425: doc.close();
1426: }
1427: NETSCAPE4
1428: } else {
1429: # Otherwise, we need to use semi-standards-compliant code
1430: # (technically, "innerHTML" isn't standard but the equivalent
1431: # is really scary, and every useful browser supports it
1432: return (<<DOMBASED);
1433: function change(name, content) {
1434: element = document.getElementById(name);
1435: element.innerHTML = content;
1436: }
1437: DOMBASED
1438: }
1439: }
1440:
1441: =pod
1442:
1.648 raeburn 1443: =item * &changable_area($name,$origContent):
1.256 matthew 1444:
1445: This provides a "changable area" that can be modified on the fly via
1446: the Javascript code provided in C<change_content_javascript>. $name is
1447: the name you will use to reference the area later; do not repeat the
1448: same name on a given HTML page more then once. $origContent is what
1449: the area will originally contain, which can be left blank.
1450:
1451: =cut
1452:
1453: sub changable_area {
1454: my ($name, $origContent) = @_;
1455:
1.258 albertel 1456: if ($env{'browser.type'} eq 'netscape' &&
1457: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1458: # If this is netscape 4, we need to use the Layer tag
1459: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1460: } else {
1461: return "<span id='$name'>$origContent</span>";
1462: }
1463: }
1464:
1465: =pod
1466:
1.648 raeburn 1467: =item * &viewport_geometry_js
1.590 raeburn 1468:
1469: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1470:
1471: =cut
1472:
1473:
1474: sub viewport_geometry_js {
1475: return <<"GEOMETRY";
1476: var Geometry = {};
1477: function init_geometry() {
1478: if (Geometry.init) { return };
1479: Geometry.init=1;
1480: if (window.innerHeight) {
1481: Geometry.getViewportHeight = function() { return window.innerHeight; };
1482: Geometry.getViewportWidth = function() { return window.innerWidth; };
1483: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1484: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1485: }
1486: else if (document.documentElement && document.documentElement.clientHeight) {
1487: Geometry.getViewportHeight =
1488: function() { return document.documentElement.clientHeight; };
1489: Geometry.getViewportWidth =
1490: function() { return document.documentElement.clientWidth; };
1491:
1492: Geometry.getHorizontalScroll =
1493: function() { return document.documentElement.scrollLeft; };
1494: Geometry.getVerticalScroll =
1495: function() { return document.documentElement.scrollTop; };
1496: }
1497: else if (document.body.clientHeight) {
1498: Geometry.getViewportHeight =
1499: function() { return document.body.clientHeight; };
1500: Geometry.getViewportWidth =
1501: function() { return document.body.clientWidth; };
1502: Geometry.getHorizontalScroll =
1503: function() { return document.body.scrollLeft; };
1504: Geometry.getVerticalScroll =
1505: function() { return document.body.scrollTop; };
1506: }
1507: }
1508:
1509: GEOMETRY
1510: }
1511:
1512: =pod
1513:
1.648 raeburn 1514: =item * &viewport_size_js()
1.590 raeburn 1515:
1516: 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.
1517:
1518: =cut
1519:
1520: sub viewport_size_js {
1521: my $geometry = &viewport_geometry_js();
1522: return <<"DIMS";
1523:
1524: $geometry
1525:
1526: function getViewportDims(width,height) {
1527: init_geometry();
1528: width.value = Geometry.getViewportWidth();
1529: height.value = Geometry.getViewportHeight();
1530: return;
1531: }
1532:
1533: DIMS
1534: }
1535:
1536: =pod
1537:
1.648 raeburn 1538: =item * &resize_textarea_js()
1.565 albertel 1539:
1540: emits the needed javascript to resize a textarea to be as big as possible
1541:
1542: creates a function resize_textrea that takes two IDs first should be
1543: the id of the element to resize, second should be the id of a div that
1544: surrounds everything that comes after the textarea, this routine needs
1545: to be attached to the <body> for the onload and onresize events.
1546:
1.648 raeburn 1547: =back
1.565 albertel 1548:
1549: =cut
1550:
1551: sub resize_textarea_js {
1.590 raeburn 1552: my $geometry = &viewport_geometry_js();
1.565 albertel 1553: return <<"RESIZE";
1554: <script type="text/javascript">
1.824 bisitz 1555: // <![CDATA[
1.590 raeburn 1556: $geometry
1.565 albertel 1557:
1.588 albertel 1558: function getX(element) {
1559: var x = 0;
1560: while (element) {
1561: x += element.offsetLeft;
1562: element = element.offsetParent;
1563: }
1564: return x;
1565: }
1566: function getY(element) {
1567: var y = 0;
1568: while (element) {
1569: y += element.offsetTop;
1570: element = element.offsetParent;
1571: }
1572: return y;
1573: }
1574:
1575:
1.565 albertel 1576: function resize_textarea(textarea_id,bottom_id) {
1577: init_geometry();
1578: var textarea = document.getElementById(textarea_id);
1579: //alert(textarea);
1580:
1.588 albertel 1581: var textarea_top = getY(textarea);
1.565 albertel 1582: var textarea_height = textarea.offsetHeight;
1583: var bottom = document.getElementById(bottom_id);
1.588 albertel 1584: var bottom_top = getY(bottom);
1.565 albertel 1585: var bottom_height = bottom.offsetHeight;
1586: var window_height = Geometry.getViewportHeight();
1.588 albertel 1587: var fudge = 23;
1.565 albertel 1588: var new_height = window_height-fudge-textarea_top-bottom_height;
1589: if (new_height < 300) {
1590: new_height = 300;
1591: }
1592: textarea.style.height=new_height+'px';
1593: }
1.824 bisitz 1594: // ]]>
1.565 albertel 1595: </script>
1596: RESIZE
1597:
1598: }
1599:
1600: =pod
1601:
1.256 matthew 1602: =head1 Excel and CSV file utility routines
1603:
1604: =over 4
1605:
1606: =cut
1607:
1608: ###############################################################
1609: ###############################################################
1610:
1611: =pod
1612:
1.648 raeburn 1613: =item * &csv_translate($text)
1.37 matthew 1614:
1.185 www 1615: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1616: format.
1617:
1618: =cut
1619:
1.180 matthew 1620: ###############################################################
1621: ###############################################################
1.37 matthew 1622: sub csv_translate {
1623: my $text = shift;
1624: $text =~ s/\"/\"\"/g;
1.209 albertel 1625: $text =~ s/\n/ /g;
1.37 matthew 1626: return $text;
1627: }
1.180 matthew 1628:
1629: ###############################################################
1630: ###############################################################
1631:
1632: =pod
1633:
1.648 raeburn 1634: =item * &define_excel_formats()
1.180 matthew 1635:
1636: Define some commonly used Excel cell formats.
1637:
1638: Currently supported formats:
1639:
1640: =over 4
1641:
1642: =item header
1643:
1644: =item bold
1645:
1646: =item h1
1647:
1648: =item h2
1649:
1650: =item h3
1651:
1.256 matthew 1652: =item h4
1653:
1654: =item i
1655:
1.180 matthew 1656: =item date
1657:
1658: =back
1659:
1660: Inputs: $workbook
1661:
1662: Returns: $format, a hash reference.
1663:
1664: =cut
1665:
1666: ###############################################################
1667: ###############################################################
1668: sub define_excel_formats {
1669: my ($workbook) = @_;
1670: my $format;
1671: $format->{'header'} = $workbook->add_format(bold => 1,
1672: bottom => 1,
1673: align => 'center');
1674: $format->{'bold'} = $workbook->add_format(bold=>1);
1675: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1676: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1677: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1678: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1679: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1680: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1681: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1682: return $format;
1683: }
1684:
1685: ###############################################################
1686: ###############################################################
1.113 bowersj2 1687:
1688: =pod
1689:
1.648 raeburn 1690: =item * &create_workbook()
1.255 matthew 1691:
1692: Create an Excel worksheet. If it fails, output message on the
1693: request object and return undefs.
1694:
1695: Inputs: Apache request object
1696:
1697: Returns (undef) on failure,
1698: Excel worksheet object, scalar with filename, and formats
1699: from &Apache::loncommon::define_excel_formats on success
1700:
1701: =cut
1702:
1703: ###############################################################
1704: ###############################################################
1705: sub create_workbook {
1706: my ($r) = @_;
1707: #
1708: # Create the excel spreadsheet
1709: my $filename = '/prtspool/'.
1.258 albertel 1710: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1711: time.'_'.rand(1000000000).'.xls';
1712: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1713: if (! defined($workbook)) {
1714: $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928 bisitz 1715: $r->print(
1716: '<p class="LC_error">'
1717: .&mt('Problems occurred in creating the new Excel file.')
1718: .' '.&mt('This error has been logged.')
1719: .' '.&mt('Please alert your LON-CAPA administrator.')
1720: .'</p>'
1721: );
1.255 matthew 1722: return (undef);
1723: }
1724: #
1725: $workbook->set_tempdir('/home/httpd/perl/tmp');
1726: #
1727: my $format = &Apache::loncommon::define_excel_formats($workbook);
1728: return ($workbook,$filename,$format);
1729: }
1730:
1731: ###############################################################
1732: ###############################################################
1733:
1734: =pod
1735:
1.648 raeburn 1736: =item * &create_text_file()
1.113 bowersj2 1737:
1.542 raeburn 1738: Create a file to write to and eventually make available to the user.
1.256 matthew 1739: If file creation fails, outputs an error message on the request object and
1740: return undefs.
1.113 bowersj2 1741:
1.256 matthew 1742: Inputs: Apache request object, and file suffix
1.113 bowersj2 1743:
1.256 matthew 1744: Returns (undef) on failure,
1745: Filehandle and filename on success.
1.113 bowersj2 1746:
1747: =cut
1748:
1.256 matthew 1749: ###############################################################
1750: ###############################################################
1751: sub create_text_file {
1752: my ($r,$suffix) = @_;
1753: if (! defined($suffix)) { $suffix = 'txt'; };
1754: my $fh;
1755: my $filename = '/prtspool/'.
1.258 albertel 1756: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1757: time.'_'.rand(1000000000).'.'.$suffix;
1758: $fh = Apache::File->new('>/home/httpd'.$filename);
1759: if (! defined($fh)) {
1760: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 1761: $r->print(
1762: '<p class="LC_error">'
1763: .&mt('Problems occurred in creating the output file.')
1764: .' '.&mt('This error has been logged.')
1765: .' '.&mt('Please alert your LON-CAPA administrator.')
1766: .'</p>'
1767: );
1.113 bowersj2 1768: }
1.256 matthew 1769: return ($fh,$filename)
1.113 bowersj2 1770: }
1771:
1772:
1.256 matthew 1773: =pod
1.113 bowersj2 1774:
1775: =back
1776:
1777: =cut
1.37 matthew 1778:
1779: ###############################################################
1.33 matthew 1780: ## Home server <option> list generating code ##
1781: ###############################################################
1.35 matthew 1782:
1.169 www 1783: # ------------------------------------------
1784:
1785: sub domain_select {
1786: my ($name,$value,$multiple)=@_;
1787: my %domains=map {
1.514 albertel 1788: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1789: } &Apache::lonnet::all_domains();
1.169 www 1790: if ($multiple) {
1791: $domains{''}=&mt('Any domain');
1.550 albertel 1792: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1793: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1794: } else {
1.550 albertel 1795: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970 raeburn 1796: return &select_form($name,$value,\%domains);
1.169 www 1797: }
1798: }
1799:
1.282 albertel 1800: #-------------------------------------------
1801:
1802: =pod
1803:
1.519 raeburn 1804: =head1 Routines for form select boxes
1805:
1806: =over 4
1807:
1.648 raeburn 1808: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1809:
1810: Returns a string containing a <select> element int multiple mode
1811:
1812:
1813: Args:
1814: $name - name of the <select> element
1.506 raeburn 1815: $value - scalar or array ref of values that should already be selected
1.282 albertel 1816: $size - number of rows long the select element is
1.283 albertel 1817: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1818: (shown text should already have been &mt())
1.506 raeburn 1819: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1820:
1.282 albertel 1821: =cut
1822:
1823: #-------------------------------------------
1.169 www 1824: sub multiple_select_form {
1.284 albertel 1825: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1826: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1827: my $output='';
1.191 matthew 1828: if (! defined($size)) {
1829: $size = 4;
1.283 albertel 1830: if (scalar(keys(%$hash))<4) {
1831: $size = scalar(keys(%$hash));
1.191 matthew 1832: }
1833: }
1.734 bisitz 1834: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1835: my @order;
1.506 raeburn 1836: if (ref($order) eq 'ARRAY') {
1837: @order = @{$order};
1838: } else {
1839: @order = sort(keys(%$hash));
1.501 banghart 1840: }
1841: if (exists($$hash{'select_form_order'})) {
1842: @order = @{$$hash{'select_form_order'}};
1843: }
1844:
1.284 albertel 1845: foreach my $key (@order) {
1.356 albertel 1846: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1847: $output.='selected="selected" ' if ($selected{$key});
1848: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1849: }
1850: $output.="</select>\n";
1851: return $output;
1852: }
1853:
1.88 www 1854: #-------------------------------------------
1855:
1856: =pod
1857:
1.970 raeburn 1858: =item * &select_form($defdom,$name,$hashref,$onchange)
1.88 www 1859:
1860: Returns a string containing a <select name='$name' size='1'> form to
1.970 raeburn 1861: allow a user to select options from a ref to a hash containing:
1862: option_name => displayed text. An optional $onchange can include
1863: a javascript onchange item, e.g., onchange="this.form.submit();"
1864:
1.88 www 1865: See lonrights.pm for an example invocation and use.
1866:
1867: =cut
1868:
1869: #-------------------------------------------
1870: sub select_form {
1.970 raeburn 1871: my ($def,$name,$hashref,$onchange) = @_;
1872: return unless (ref($hashref) eq 'HASH');
1873: if ($onchange) {
1874: $onchange = ' onchange="'.$onchange.'"';
1875: }
1876: my $selectform = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.128 albertel 1877: my @keys;
1.970 raeburn 1878: if (exists($hashref->{'select_form_order'})) {
1879: @keys=@{$hashref->{'select_form_order'}};
1.128 albertel 1880: } else {
1.970 raeburn 1881: @keys=sort(keys(%{$hashref}));
1.128 albertel 1882: }
1.356 albertel 1883: foreach my $key (@keys) {
1884: $selectform.=
1885: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1886: ($key eq $def ? 'selected="selected" ' : '').
1.970 raeburn 1887: ">".$hashref->{$key}."</option>\n";
1.88 www 1888: }
1889: $selectform.="</select>";
1890: return $selectform;
1891: }
1892:
1.475 www 1893: # For display filters
1894:
1895: sub display_filter {
1896: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1897: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714 bisitz 1898: return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475 www 1899: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1900: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 1901: '</label></span> <span class="LC_nobreak">'.
1.475 www 1902: &mt('Filter [_1]',
1.477 www 1903: &select_form($env{'form.displayfilter'},
1904: 'displayfilter',
1.970 raeburn 1905: {'currentfolder' => 'Current folder/page',
1.477 www 1906: 'containing' => 'Containing phrase',
1.970 raeburn 1907: 'none' => 'None'})).
1.714 bisitz 1908: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475 www 1909: }
1910:
1.167 www 1911: sub gradeleveldescription {
1912: my $gradelevel=shift;
1913: my %gradelevels=(0 => 'Not specified',
1914: 1 => 'Grade 1',
1915: 2 => 'Grade 2',
1916: 3 => 'Grade 3',
1917: 4 => 'Grade 4',
1918: 5 => 'Grade 5',
1919: 6 => 'Grade 6',
1920: 7 => 'Grade 7',
1921: 8 => 'Grade 8',
1922: 9 => 'Grade 9',
1923: 10 => 'Grade 10',
1924: 11 => 'Grade 11',
1925: 12 => 'Grade 12',
1926: 13 => 'Grade 13',
1927: 14 => '100 Level',
1928: 15 => '200 Level',
1929: 16 => '300 Level',
1930: 17 => '400 Level',
1931: 18 => 'Graduate Level');
1932: return &mt($gradelevels{$gradelevel});
1933: }
1934:
1.163 www 1935: sub select_level_form {
1936: my ($deflevel,$name)=@_;
1937: unless ($deflevel) { $deflevel=0; }
1.167 www 1938: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1939: for (my $i=0; $i<=18; $i++) {
1940: $selectform.="<option value=\"$i\" ".
1.253 albertel 1941: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1942: ">".&gradeleveldescription($i)."</option>\n";
1943: }
1944: $selectform.="</select>";
1945: return $selectform;
1.163 www 1946: }
1.167 www 1947:
1.35 matthew 1948: #-------------------------------------------
1949:
1.45 matthew 1950: =pod
1951:
1.910 raeburn 1952: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35 matthew 1953:
1954: Returns a string containing a <select name='$name' size='1'> form to
1955: allow a user to select the domain to preform an operation in.
1956: See loncreateuser.pm for an example invocation and use.
1957:
1.90 www 1958: If the $includeempty flag is set, it also includes an empty choice ("no domain
1959: selected");
1960:
1.743 raeburn 1961: If the $showdomdesc flag is set, the domain name is followed by the domain description.
1962:
1.910 raeburn 1963: The optional $onchange argument specifies what should occur if the domain selector is changed, e.g., 'this.form.submit()' if the form is to be automatically submitted.
1964:
1965: The optional $incdoms is a reference to an array of domains which will be the only available options.
1.563 raeburn 1966:
1.35 matthew 1967: =cut
1968:
1969: #-------------------------------------------
1.34 matthew 1970: sub select_dom_form {
1.910 raeburn 1971: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.872 raeburn 1972: if ($onchange) {
1.874 raeburn 1973: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 1974: }
1.910 raeburn 1975: my @domains;
1976: if (ref($incdoms) eq 'ARRAY') {
1977: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
1978: } else {
1979: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1980: }
1.90 www 1981: if ($includeempty) { @domains=('',@domains); }
1.743 raeburn 1982: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 1983: foreach my $dom (@domains) {
1984: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 1985: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
1986: if ($showdomdesc) {
1987: if ($dom ne '') {
1988: my $domdesc = &Apache::lonnet::domain($dom,'description');
1989: if ($domdesc ne '') {
1990: $selectdomain .= ' ('.$domdesc.')';
1991: }
1992: }
1993: }
1994: $selectdomain .= "</option>\n";
1.34 matthew 1995: }
1996: $selectdomain.="</select>";
1997: return $selectdomain;
1998: }
1999:
1.35 matthew 2000: #-------------------------------------------
2001:
1.45 matthew 2002: =pod
2003:
1.648 raeburn 2004: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 2005:
1.586 raeburn 2006: input: 4 arguments (two required, two optional) -
2007: $domain - domain of new user
2008: $name - name of form element
2009: $default - Value of 'default' causes a default item to be first
2010: option, and selected by default.
2011: $hide - Value of 'hide' causes hiding of the name of the server,
2012: if 1 server found, or default, if 0 found.
1.594 raeburn 2013: output: returns 2 items:
1.586 raeburn 2014: (a) form element which contains either:
2015: (i) <select name="$name">
2016: <option value="$hostid1">$hostid $servers{$hostid}</option>
2017: <option value="$hostid2">$hostid $servers{$hostid}</option>
2018: </select>
2019: form item if there are multiple library servers in $domain, or
2020: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2021: if there is only one library server in $domain.
2022:
2023: (b) number of library servers found.
2024:
2025: See loncreateuser.pm for example of use.
1.35 matthew 2026:
2027: =cut
2028:
2029: #-------------------------------------------
1.586 raeburn 2030: sub home_server_form_item {
2031: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2032: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2033: my $result;
2034: my $numlib = keys(%servers);
2035: if ($numlib > 1) {
2036: $result .= '<select name="'.$name.'" />'."\n";
2037: if ($default) {
1.804 bisitz 2038: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 2039: '</option>'."\n";
2040: }
2041: foreach my $hostid (sort(keys(%servers))) {
2042: $result.= '<option value="'.$hostid.'">'.
2043: $hostid.' '.$servers{$hostid}."</option>\n";
2044: }
2045: $result .= '</select>'."\n";
2046: } elsif ($numlib == 1) {
2047: my $hostid;
2048: foreach my $item (keys(%servers)) {
2049: $hostid = $item;
2050: }
2051: $result .= '<input type="hidden" name="'.$name.'" value="'.
2052: $hostid.'" />';
2053: if (!$hide) {
2054: $result .= $hostid.' '.$servers{$hostid};
2055: }
2056: $result .= "\n";
2057: } elsif ($default) {
2058: $result .= '<input type="hidden" name="'.$name.
2059: '" value="default" />';
2060: if (!$hide) {
2061: $result .= &mt('default');
2062: }
2063: $result .= "\n";
1.33 matthew 2064: }
1.586 raeburn 2065: return ($result,$numlib);
1.33 matthew 2066: }
1.112 bowersj2 2067:
2068: =pod
2069:
1.534 albertel 2070: =back
2071:
1.112 bowersj2 2072: =cut
1.87 matthew 2073:
2074: ###############################################################
1.112 bowersj2 2075: ## Decoding User Agent ##
1.87 matthew 2076: ###############################################################
2077:
2078: =pod
2079:
1.112 bowersj2 2080: =head1 Decoding the User Agent
2081:
2082: =over 4
2083:
2084: =item * &decode_user_agent()
1.87 matthew 2085:
2086: Inputs: $r
2087:
2088: Outputs:
2089:
2090: =over 4
2091:
1.112 bowersj2 2092: =item * $httpbrowser
1.87 matthew 2093:
1.112 bowersj2 2094: =item * $clientbrowser
1.87 matthew 2095:
1.112 bowersj2 2096: =item * $clientversion
1.87 matthew 2097:
1.112 bowersj2 2098: =item * $clientmathml
1.87 matthew 2099:
1.112 bowersj2 2100: =item * $clientunicode
1.87 matthew 2101:
1.112 bowersj2 2102: =item * $clientos
1.87 matthew 2103:
2104: =back
2105:
1.157 matthew 2106: =back
2107:
1.87 matthew 2108: =cut
2109:
2110: ###############################################################
2111: ###############################################################
2112: sub decode_user_agent {
1.247 albertel 2113: my ($r)=@_;
1.87 matthew 2114: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2115: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2116: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2117: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2118: my $clientbrowser='unknown';
2119: my $clientversion='0';
2120: my $clientmathml='';
2121: my $clientunicode='0';
2122: for (my $i=0;$i<=$#browsertype;$i++) {
2123: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
2124: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2125: $clientbrowser=$bname;
2126: $httpbrowser=~/$vreg/i;
2127: $clientversion=$1;
2128: $clientmathml=($clientversion>=$minv);
2129: $clientunicode=($clientversion>=$univ);
2130: }
2131: }
2132: my $clientos='unknown';
2133: if (($httpbrowser=~/linux/i) ||
2134: ($httpbrowser=~/unix/i) ||
2135: ($httpbrowser=~/ux/i) ||
2136: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2137: if (($httpbrowser=~/vax/i) ||
2138: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2139: if ($httpbrowser=~/next/i) { $clientos='next'; }
2140: if (($httpbrowser=~/mac/i) ||
2141: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
2142: if ($httpbrowser=~/win/i) { $clientos='win'; }
2143: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
2144: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
2145: $clientunicode,$clientos,);
2146: }
2147:
1.32 matthew 2148: ###############################################################
2149: ## Authentication changing form generation subroutines ##
2150: ###############################################################
2151: ##
2152: ## All of the authform_xxxxxxx subroutines take their inputs in a
2153: ## hash, and have reasonable default values.
2154: ##
2155: ## formname = the name given in the <form> tag.
1.35 matthew 2156: #-------------------------------------------
2157:
1.45 matthew 2158: =pod
2159:
1.112 bowersj2 2160: =head1 Authentication Routines
2161:
2162: =over 4
2163:
1.648 raeburn 2164: =item * &authform_xxxxxx()
1.35 matthew 2165:
2166: The authform_xxxxxx subroutines provide javascript and html forms which
2167: handle some of the conveniences required for authentication forms.
2168: This is not an optimal method, but it works.
2169:
2170: =over 4
2171:
1.112 bowersj2 2172: =item * authform_header
1.35 matthew 2173:
1.112 bowersj2 2174: =item * authform_authorwarning
1.35 matthew 2175:
1.112 bowersj2 2176: =item * authform_nochange
1.35 matthew 2177:
1.112 bowersj2 2178: =item * authform_kerberos
1.35 matthew 2179:
1.112 bowersj2 2180: =item * authform_internal
1.35 matthew 2181:
1.112 bowersj2 2182: =item * authform_filesystem
1.35 matthew 2183:
2184: =back
2185:
1.648 raeburn 2186: See loncreateuser.pm for invocation and use examples.
1.157 matthew 2187:
1.35 matthew 2188: =cut
2189:
2190: #-------------------------------------------
1.32 matthew 2191: sub authform_header{
2192: my %in = (
2193: formname => 'cu',
1.80 albertel 2194: kerb_def_dom => '',
1.32 matthew 2195: @_,
2196: );
2197: $in{'formname'} = 'document.' . $in{'formname'};
2198: my $result='';
1.80 albertel 2199:
2200: #---------------------------------------------- Code for upper case translation
2201: my $Javascript_toUpperCase;
2202: unless ($in{kerb_def_dom}) {
2203: $Javascript_toUpperCase =<<"END";
2204: switch (choice) {
2205: case 'krb': currentform.elements[choicearg].value =
2206: currentform.elements[choicearg].value.toUpperCase();
2207: break;
2208: default:
2209: }
2210: END
2211: } else {
2212: $Javascript_toUpperCase = "";
2213: }
2214:
1.165 raeburn 2215: my $radioval = "'nochange'";
1.591 raeburn 2216: if (defined($in{'curr_authtype'})) {
2217: if ($in{'curr_authtype'} ne '') {
2218: $radioval = "'".$in{'curr_authtype'}."arg'";
2219: }
1.174 matthew 2220: }
1.165 raeburn 2221: my $argfield = 'null';
1.591 raeburn 2222: if (defined($in{'mode'})) {
1.165 raeburn 2223: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2224: if (defined($in{'curr_autharg'})) {
2225: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2226: $argfield = "'$in{'curr_autharg'}'";
2227: }
2228: }
2229: }
2230: }
2231:
1.32 matthew 2232: $result.=<<"END";
2233: var current = new Object();
1.165 raeburn 2234: current.radiovalue = $radioval;
2235: current.argfield = $argfield;
1.32 matthew 2236:
2237: function changed_radio(choice,currentform) {
2238: var choicearg = choice + 'arg';
2239: // If a radio button in changed, we need to change the argfield
2240: if (current.radiovalue != choice) {
2241: current.radiovalue = choice;
2242: if (current.argfield != null) {
2243: currentform.elements[current.argfield].value = '';
2244: }
2245: if (choice == 'nochange') {
2246: current.argfield = null;
2247: } else {
2248: current.argfield = choicearg;
2249: switch(choice) {
2250: case 'krb':
2251: currentform.elements[current.argfield].value =
2252: "$in{'kerb_def_dom'}";
2253: break;
2254: default:
2255: break;
2256: }
2257: }
2258: }
2259: return;
2260: }
1.22 www 2261:
1.32 matthew 2262: function changed_text(choice,currentform) {
2263: var choicearg = choice + 'arg';
2264: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2265: $Javascript_toUpperCase
1.32 matthew 2266: // clear old field
2267: if ((current.argfield != choicearg) && (current.argfield != null)) {
2268: currentform.elements[current.argfield].value = '';
2269: }
2270: current.argfield = choicearg;
2271: }
2272: set_auth_radio_buttons(choice,currentform);
2273: return;
1.20 www 2274: }
1.32 matthew 2275:
2276: function set_auth_radio_buttons(newvalue,currentform) {
1.986 raeburn 2277: var numauthchoices = currentform.login.length;
2278: if (typeof numauthchoices == "undefined") {
2279: return;
2280: }
1.32 matthew 2281: var i=0;
1.986 raeburn 2282: while (i < numauthchoices) {
1.32 matthew 2283: if (currentform.login[i].value == newvalue) { break; }
2284: i++;
2285: }
1.986 raeburn 2286: if (i == numauthchoices) {
1.32 matthew 2287: return;
2288: }
2289: current.radiovalue = newvalue;
2290: currentform.login[i].checked = true;
2291: return;
2292: }
2293: END
2294: return $result;
2295: }
2296:
2297: sub authform_authorwarning{
2298: my $result='';
1.144 matthew 2299: $result='<i>'.
2300: &mt('As a general rule, only authors or co-authors should be '.
2301: 'filesystem authenticated '.
2302: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2303: return $result;
2304: }
2305:
2306: sub authform_nochange{
2307: my %in = (
2308: formname => 'document.cu',
2309: kerb_def_dom => 'MSU.EDU',
2310: @_,
2311: );
1.586 raeburn 2312: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2313: my $result;
2314: if (keys(%can_assign) == 0) {
2315: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2316: } else {
2317: $result = '<label>'.&mt('[_1] Do not change login data',
2318: '<input type="radio" name="login" value="nochange" '.
2319: 'checked="checked" onclick="'.
1.281 albertel 2320: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2321: '</label>';
1.586 raeburn 2322: }
1.32 matthew 2323: return $result;
2324: }
2325:
1.591 raeburn 2326: sub authform_kerberos {
1.32 matthew 2327: my %in = (
2328: formname => 'document.cu',
2329: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2330: kerb_def_auth => 'krb4',
1.32 matthew 2331: @_,
2332: );
1.586 raeburn 2333: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2334: $autharg,$jscall);
2335: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2336: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2337: $check5 = ' checked="checked"';
1.80 albertel 2338: } else {
1.772 bisitz 2339: $check4 = ' checked="checked"';
1.80 albertel 2340: }
1.165 raeburn 2341: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2342: if (defined($in{'curr_authtype'})) {
2343: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2344: $krbcheck = ' checked="checked"';
1.623 raeburn 2345: if (defined($in{'mode'})) {
2346: if ($in{'mode'} eq 'modifyuser') {
2347: $krbcheck = '';
2348: }
2349: }
1.591 raeburn 2350: if (defined($in{'curr_kerb_ver'})) {
2351: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2352: $check5 = ' checked="checked"';
1.591 raeburn 2353: $check4 = '';
2354: } else {
1.772 bisitz 2355: $check4 = ' checked="checked"';
1.591 raeburn 2356: $check5 = '';
2357: }
1.586 raeburn 2358: }
1.591 raeburn 2359: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2360: $krbarg = $in{'curr_autharg'};
2361: }
1.586 raeburn 2362: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2363: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2364: $result =
2365: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2366: $in{'curr_autharg'},$krbver);
2367: } else {
2368: $result =
2369: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2370: }
2371: return $result;
2372: }
2373: }
2374: } else {
2375: if ($authnum == 1) {
1.784 bisitz 2376: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2377: }
2378: }
1.586 raeburn 2379: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2380: return;
1.587 raeburn 2381: } elsif ($authtype eq '') {
1.591 raeburn 2382: if (defined($in{'mode'})) {
1.587 raeburn 2383: if ($in{'mode'} eq 'modifycourse') {
2384: if ($authnum == 1) {
1.784 bisitz 2385: $authtype = '<input type="hidden" name="login" value="krb" />';
1.587 raeburn 2386: }
2387: }
2388: }
1.586 raeburn 2389: }
2390: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2391: if ($authtype eq '') {
2392: $authtype = '<input type="radio" name="login" value="krb" '.
2393: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2394: $krbcheck.' />';
2395: }
2396: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2397: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2398: $in{'curr_authtype'} eq 'krb5') ||
2399: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2400: $in{'curr_authtype'} eq 'krb4')) {
2401: $result .= &mt
1.144 matthew 2402: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2403: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2404: '<label>'.$authtype,
1.281 albertel 2405: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2406: 'value="'.$krbarg.'" '.
1.144 matthew 2407: 'onchange="'.$jscall.'" />',
1.281 albertel 2408: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2409: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2410: '</label>');
1.586 raeburn 2411: } elsif ($can_assign{'krb4'}) {
2412: $result .= &mt
2413: ('[_1] Kerberos authenticated with domain [_2] '.
2414: '[_3] Version 4 [_4]',
2415: '<label>'.$authtype,
2416: '</label><input type="text" size="10" name="krbarg" '.
2417: 'value="'.$krbarg.'" '.
2418: 'onchange="'.$jscall.'" />',
2419: '<label><input type="hidden" name="krbver" value="4" />',
2420: '</label>');
2421: } elsif ($can_assign{'krb5'}) {
2422: $result .= &mt
2423: ('[_1] Kerberos authenticated with domain [_2] '.
2424: '[_3] Version 5 [_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="5" />',
2430: '</label>');
2431: }
1.32 matthew 2432: return $result;
2433: }
2434:
2435: sub authform_internal{
1.586 raeburn 2436: my %in = (
1.32 matthew 2437: formname => 'document.cu',
2438: kerb_def_dom => 'MSU.EDU',
2439: @_,
2440: );
1.586 raeburn 2441: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2442: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2443: if (defined($in{'curr_authtype'})) {
2444: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2445: if ($can_assign{'int'}) {
1.772 bisitz 2446: $intcheck = 'checked="checked" ';
1.623 raeburn 2447: if (defined($in{'mode'})) {
2448: if ($in{'mode'} eq 'modifyuser') {
2449: $intcheck = '';
2450: }
2451: }
1.591 raeburn 2452: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2453: $intarg = $in{'curr_autharg'};
2454: }
2455: } else {
2456: $result = &mt('Currently internally authenticated.');
2457: return $result;
1.165 raeburn 2458: }
2459: }
1.586 raeburn 2460: } else {
2461: if ($authnum == 1) {
1.784 bisitz 2462: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 2463: }
2464: }
2465: if (!$can_assign{'int'}) {
2466: return;
1.587 raeburn 2467: } elsif ($authtype eq '') {
1.591 raeburn 2468: if (defined($in{'mode'})) {
1.587 raeburn 2469: if ($in{'mode'} eq 'modifycourse') {
2470: if ($authnum == 1) {
1.784 bisitz 2471: $authtype = '<input type="hidden" name="login" value="int" />';
1.587 raeburn 2472: }
2473: }
2474: }
1.165 raeburn 2475: }
1.586 raeburn 2476: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2477: if ($authtype eq '') {
2478: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2479: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2480: }
1.605 bisitz 2481: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2482: $intarg.'" onchange="'.$jscall.'" />';
2483: $result = &mt
1.144 matthew 2484: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2485: '<label>'.$authtype,'</label>'.$autharg);
1.824 bisitz 2486: $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 2487: return $result;
2488: }
2489:
2490: sub authform_local{
2491: my %in = (
2492: formname => 'document.cu',
2493: kerb_def_dom => 'MSU.EDU',
2494: @_,
2495: );
1.586 raeburn 2496: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2497: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2498: if (defined($in{'curr_authtype'})) {
2499: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2500: if ($can_assign{'loc'}) {
1.772 bisitz 2501: $loccheck = 'checked="checked" ';
1.623 raeburn 2502: if (defined($in{'mode'})) {
2503: if ($in{'mode'} eq 'modifyuser') {
2504: $loccheck = '';
2505: }
2506: }
1.591 raeburn 2507: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2508: $locarg = $in{'curr_autharg'};
2509: }
2510: } else {
2511: $result = &mt('Currently using local (institutional) authentication.');
2512: return $result;
1.165 raeburn 2513: }
2514: }
1.586 raeburn 2515: } else {
2516: if ($authnum == 1) {
1.784 bisitz 2517: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 2518: }
2519: }
2520: if (!$can_assign{'loc'}) {
2521: return;
1.587 raeburn 2522: } elsif ($authtype eq '') {
1.591 raeburn 2523: if (defined($in{'mode'})) {
1.587 raeburn 2524: if ($in{'mode'} eq 'modifycourse') {
2525: if ($authnum == 1) {
1.784 bisitz 2526: $authtype = '<input type="hidden" name="login" value="loc" />';
1.587 raeburn 2527: }
2528: }
2529: }
1.165 raeburn 2530: }
1.586 raeburn 2531: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2532: if ($authtype eq '') {
2533: $authtype = '<input type="radio" name="login" value="loc" '.
2534: $loccheck.' onchange="'.$jscall.'" onclick="'.
2535: $jscall.'" />';
2536: }
2537: $autharg = '<input type="text" size="10" name="locarg" value="'.
2538: $locarg.'" onchange="'.$jscall.'" />';
2539: $result = &mt('[_1] Local Authentication with argument [_2]',
2540: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2541: return $result;
2542: }
2543:
2544: sub authform_filesystem{
2545: my %in = (
2546: formname => 'document.cu',
2547: kerb_def_dom => 'MSU.EDU',
2548: @_,
2549: );
1.586 raeburn 2550: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2551: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2552: if (defined($in{'curr_authtype'})) {
2553: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2554: if ($can_assign{'fsys'}) {
1.772 bisitz 2555: $fsyscheck = 'checked="checked" ';
1.623 raeburn 2556: if (defined($in{'mode'})) {
2557: if ($in{'mode'} eq 'modifyuser') {
2558: $fsyscheck = '';
2559: }
2560: }
1.586 raeburn 2561: } else {
2562: $result = &mt('Currently Filesystem Authenticated.');
2563: return $result;
2564: }
2565: }
2566: } else {
2567: if ($authnum == 1) {
1.784 bisitz 2568: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 2569: }
2570: }
2571: if (!$can_assign{'fsys'}) {
2572: return;
1.587 raeburn 2573: } elsif ($authtype eq '') {
1.591 raeburn 2574: if (defined($in{'mode'})) {
1.587 raeburn 2575: if ($in{'mode'} eq 'modifycourse') {
2576: if ($authnum == 1) {
1.784 bisitz 2577: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587 raeburn 2578: }
2579: }
2580: }
1.586 raeburn 2581: }
2582: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2583: if ($authtype eq '') {
2584: $authtype = '<input type="radio" name="login" value="fsys" '.
2585: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2586: $jscall.'" />';
2587: }
2588: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2589: ' onchange="'.$jscall.'" />';
2590: $result = &mt
1.144 matthew 2591: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2592: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2593: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2594: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2595: 'onchange="'.$jscall.'" />');
1.32 matthew 2596: return $result;
2597: }
2598:
1.586 raeburn 2599: sub get_assignable_auth {
2600: my ($dom) = @_;
2601: if ($dom eq '') {
2602: $dom = $env{'request.role.domain'};
2603: }
2604: my %can_assign = (
2605: krb4 => 1,
2606: krb5 => 1,
2607: int => 1,
2608: loc => 1,
2609: );
2610: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2611: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2612: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2613: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2614: my $context;
2615: if ($env{'request.role'} =~ /^au/) {
2616: $context = 'author';
2617: } elsif ($env{'request.role'} =~ /^dc/) {
2618: $context = 'domain';
2619: } elsif ($env{'request.course.id'}) {
2620: $context = 'course';
2621: }
2622: if ($context) {
2623: if (ref($authhash->{$context}) eq 'HASH') {
2624: %can_assign = %{$authhash->{$context}};
2625: }
2626: }
2627: }
2628: }
2629: my $authnum = 0;
2630: foreach my $key (keys(%can_assign)) {
2631: if ($can_assign{$key}) {
2632: $authnum ++;
2633: }
2634: }
2635: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2636: $authnum --;
2637: }
2638: return ($authnum,%can_assign);
2639: }
2640:
1.80 albertel 2641: ###############################################################
2642: ## Get Kerberos Defaults for Domain ##
2643: ###############################################################
2644: ##
2645: ## Returns default kerberos version and an associated argument
2646: ## as listed in file domain.tab. If not listed, provides
2647: ## appropriate default domain and kerberos version.
2648: ##
2649: #-------------------------------------------
2650:
2651: =pod
2652:
1.648 raeburn 2653: =item * &get_kerberos_defaults()
1.80 albertel 2654:
2655: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2656: version and domain. If not found, it defaults to version 4 and the
2657: domain of the server.
1.80 albertel 2658:
1.648 raeburn 2659: =over 4
2660:
1.80 albertel 2661: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2662:
1.648 raeburn 2663: =back
2664:
2665: =back
2666:
1.80 albertel 2667: =cut
2668:
2669: #-------------------------------------------
2670: sub get_kerberos_defaults {
2671: my $domain=shift;
1.641 raeburn 2672: my ($krbdef,$krbdefdom);
2673: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2674: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2675: $krbdef = $domdefaults{'auth_def'};
2676: $krbdefdom = $domdefaults{'auth_arg_def'};
2677: } else {
1.80 albertel 2678: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2679: my $krbdefdom=$1;
2680: $krbdefdom=~tr/a-z/A-Z/;
2681: $krbdef = "krb4";
2682: }
2683: return ($krbdef,$krbdefdom);
2684: }
1.112 bowersj2 2685:
1.32 matthew 2686:
1.46 matthew 2687: ###############################################################
2688: ## Thesaurus Functions ##
2689: ###############################################################
1.20 www 2690:
1.46 matthew 2691: =pod
1.20 www 2692:
1.112 bowersj2 2693: =head1 Thesaurus Functions
2694:
2695: =over 4
2696:
1.648 raeburn 2697: =item * &initialize_keywords()
1.46 matthew 2698:
2699: Initializes the package variable %Keywords if it is empty. Uses the
2700: package variable $thesaurus_db_file.
2701:
2702: =cut
2703:
2704: ###################################################
2705:
2706: sub initialize_keywords {
2707: return 1 if (scalar keys(%Keywords));
2708: # If we are here, %Keywords is empty, so fill it up
2709: # Make sure the file we need exists...
2710: if (! -e $thesaurus_db_file) {
2711: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2712: " failed because it does not exist");
2713: return 0;
2714: }
2715: # Set up the hash as a database
2716: my %thesaurus_db;
2717: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2718: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2719: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2720: $thesaurus_db_file);
2721: return 0;
2722: }
2723: # Get the average number of appearances of a word.
2724: my $avecount = $thesaurus_db{'average.count'};
2725: # Put keywords (those that appear > average) into %Keywords
2726: while (my ($word,$data)=each (%thesaurus_db)) {
2727: my ($count,undef) = split /:/,$data;
2728: $Keywords{$word}++ if ($count > $avecount);
2729: }
2730: untie %thesaurus_db;
2731: # Remove special values from %Keywords.
1.356 albertel 2732: foreach my $value ('total.count','average.count') {
2733: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2734: }
1.46 matthew 2735: return 1;
2736: }
2737:
2738: ###################################################
2739:
2740: =pod
2741:
1.648 raeburn 2742: =item * &keyword($word)
1.46 matthew 2743:
2744: Returns true if $word is a keyword. A keyword is a word that appears more
2745: than the average number of times in the thesaurus database. Calls
2746: &initialize_keywords
2747:
2748: =cut
2749:
2750: ###################################################
1.20 www 2751:
2752: sub keyword {
1.46 matthew 2753: return if (!&initialize_keywords());
2754: my $word=lc(shift());
2755: $word=~s/\W//g;
2756: return exists($Keywords{$word});
1.20 www 2757: }
1.46 matthew 2758:
2759: ###############################################################
2760:
2761: =pod
1.20 www 2762:
1.648 raeburn 2763: =item * &get_related_words()
1.46 matthew 2764:
1.160 matthew 2765: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2766: an array of words. If the keyword is not in the thesaurus, an empty array
2767: will be returned. The order of the words returned is determined by the
2768: database which holds them.
2769:
2770: Uses global $thesaurus_db_file.
2771:
2772: =cut
2773:
2774: ###############################################################
2775: sub get_related_words {
2776: my $keyword = shift;
2777: my %thesaurus_db;
2778: if (! -e $thesaurus_db_file) {
2779: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2780: "failed because the file does not exist");
2781: return ();
2782: }
2783: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2784: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2785: return ();
2786: }
2787: my @Words=();
1.429 www 2788: my $count=0;
1.46 matthew 2789: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2790: # The first element is the number of times
2791: # the word appears. We do not need it now.
1.429 www 2792: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2793: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2794: my $threshold=$mostfrequentcount/10;
2795: foreach my $possibleword (@RelatedWords) {
2796: my ($word,$wordcount)=split(/\,/,$possibleword);
2797: if ($wordcount>$threshold) {
2798: push(@Words,$word);
2799: $count++;
2800: if ($count>10) { last; }
2801: }
1.20 www 2802: }
2803: }
1.46 matthew 2804: untie %thesaurus_db;
2805: return @Words;
1.14 harris41 2806: }
1.46 matthew 2807:
1.112 bowersj2 2808: =pod
2809:
2810: =back
2811:
2812: =cut
1.61 www 2813:
2814: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2815: =pod
2816:
1.112 bowersj2 2817: =head1 User Name Functions
2818:
2819: =over 4
2820:
1.648 raeburn 2821: =item * &plainname($uname,$udom,$first)
1.81 albertel 2822:
1.112 bowersj2 2823: Takes a users logon name and returns it as a string in
1.226 albertel 2824: "first middle last generation" form
2825: if $first is set to 'lastname' then it returns it as
2826: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2827:
2828: =cut
1.61 www 2829:
1.295 www 2830:
1.81 albertel 2831: ###############################################################
1.61 www 2832: sub plainname {
1.226 albertel 2833: my ($uname,$udom,$first)=@_;
1.537 albertel 2834: return if (!defined($uname) || !defined($udom));
1.295 www 2835: my %names=&getnames($uname,$udom);
1.226 albertel 2836: my $name=&Apache::lonnet::format_name($names{'firstname'},
2837: $names{'middlename'},
2838: $names{'lastname'},
2839: $names{'generation'},$first);
2840: $name=~s/^\s+//;
1.62 www 2841: $name=~s/\s+$//;
2842: $name=~s/\s+/ /g;
1.353 albertel 2843: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2844: return $name;
1.61 www 2845: }
1.66 www 2846:
2847: # -------------------------------------------------------------------- Nickname
1.81 albertel 2848: =pod
2849:
1.648 raeburn 2850: =item * &nickname($uname,$udom)
1.81 albertel 2851:
2852: Gets a users name and returns it as a string as
2853:
2854: ""nickname""
1.66 www 2855:
1.81 albertel 2856: if the user has a nickname or
2857:
2858: "first middle last generation"
2859:
2860: if the user does not
2861:
2862: =cut
1.66 www 2863:
2864: sub nickname {
2865: my ($uname,$udom)=@_;
1.537 albertel 2866: return if (!defined($uname) || !defined($udom));
1.295 www 2867: my %names=&getnames($uname,$udom);
1.68 albertel 2868: my $name=$names{'nickname'};
1.66 www 2869: if ($name) {
2870: $name='"'.$name.'"';
2871: } else {
2872: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2873: $names{'lastname'}.' '.$names{'generation'};
2874: $name=~s/\s+$//;
2875: $name=~s/\s+/ /g;
2876: }
2877: return $name;
2878: }
2879:
1.295 www 2880: sub getnames {
2881: my ($uname,$udom)=@_;
1.537 albertel 2882: return if (!defined($uname) || !defined($udom));
1.433 albertel 2883: if ($udom eq 'public' && $uname eq 'public') {
2884: return ('lastname' => &mt('Public'));
2885: }
1.295 www 2886: my $id=$uname.':'.$udom;
2887: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2888: if ($cached) {
2889: return %{$names};
2890: } else {
2891: my %loadnames=&Apache::lonnet::get('environment',
2892: ['firstname','middlename','lastname','generation','nickname'],
2893: $udom,$uname);
2894: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2895: return %loadnames;
2896: }
2897: }
1.61 www 2898:
1.542 raeburn 2899: # -------------------------------------------------------------------- getemails
1.648 raeburn 2900:
1.542 raeburn 2901: =pod
2902:
1.648 raeburn 2903: =item * &getemails($uname,$udom)
1.542 raeburn 2904:
2905: Gets a user's email information and returns it as a hash with keys:
2906: notification, critnotification, permanentemail
2907:
2908: For notification and critnotification, values are comma-separated lists
1.648 raeburn 2909: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 2910:
1.648 raeburn 2911:
1.542 raeburn 2912: =cut
2913:
1.648 raeburn 2914:
1.466 albertel 2915: sub getemails {
2916: my ($uname,$udom)=@_;
2917: if ($udom eq 'public' && $uname eq 'public') {
2918: return;
2919: }
1.467 www 2920: if (!$udom) { $udom=$env{'user.domain'}; }
2921: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 2922: my $id=$uname.':'.$udom;
2923: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2924: if ($cached) {
2925: return %{$names};
2926: } else {
2927: my %loadnames=&Apache::lonnet::get('environment',
2928: ['notification','critnotification',
2929: 'permanentemail'],
2930: $udom,$uname);
2931: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2932: return %loadnames;
2933: }
2934: }
2935:
1.551 albertel 2936: sub flush_email_cache {
2937: my ($uname,$udom)=@_;
2938: if (!$udom) { $udom =$env{'user.domain'}; }
2939: if (!$uname) { $uname=$env{'user.name'}; }
2940: return if ($udom eq 'public' && $uname eq 'public');
2941: my $id=$uname.':'.$udom;
2942: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2943: }
2944:
1.728 raeburn 2945: # -------------------------------------------------------------------- getlangs
2946:
2947: =pod
2948:
2949: =item * &getlangs($uname,$udom)
2950:
2951: Gets a user's language preference and returns it as a hash with key:
2952: language.
2953:
2954: =cut
2955:
2956:
2957: sub getlangs {
2958: my ($uname,$udom) = @_;
2959: if (!$udom) { $udom =$env{'user.domain'}; }
2960: if (!$uname) { $uname=$env{'user.name'}; }
2961: my $id=$uname.':'.$udom;
2962: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
2963: if ($cached) {
2964: return %{$langs};
2965: } else {
2966: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
2967: $udom,$uname);
2968: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
2969: return %loadlangs;
2970: }
2971: }
2972:
2973: sub flush_langs_cache {
2974: my ($uname,$udom)=@_;
2975: if (!$udom) { $udom =$env{'user.domain'}; }
2976: if (!$uname) { $uname=$env{'user.name'}; }
2977: return if ($udom eq 'public' && $uname eq 'public');
2978: my $id=$uname.':'.$udom;
2979: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
2980: }
2981:
1.61 www 2982: # ------------------------------------------------------------------ Screenname
1.81 albertel 2983:
2984: =pod
2985:
1.648 raeburn 2986: =item * &screenname($uname,$udom)
1.81 albertel 2987:
2988: Gets a users screenname and returns it as a string
2989:
2990: =cut
1.61 www 2991:
2992: sub screenname {
2993: my ($uname,$udom)=@_;
1.258 albertel 2994: if ($uname eq $env{'user.name'} &&
2995: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 2996: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 2997: return $names{'screenname'};
1.62 www 2998: }
2999:
1.212 albertel 3000:
1.802 bisitz 3001: # ------------------------------------------------------------- Confirm Wrapper
3002: =pod
3003:
3004: =item confirmwrapper
3005:
3006: Wrap messages about completion of operation in box
3007:
3008: =cut
3009:
3010: sub confirmwrapper {
3011: my ($message)=@_;
3012: if ($message) {
3013: return "\n".'<div class="LC_confirm_box">'."\n"
3014: .$message."\n"
3015: .'</div>'."\n";
3016: } else {
3017: return $message;
3018: }
3019: }
3020:
1.62 www 3021: # ------------------------------------------------------------- Message Wrapper
3022:
3023: sub messagewrapper {
1.369 www 3024: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 3025: return
1.441 albertel 3026: '<a href="/adm/email?compose=individual&'.
3027: 'recname='.$username.'&recdom='.$domain.
3028: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 3029: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 3030: }
1.802 bisitz 3031:
1.74 www 3032: # --------------------------------------------------------------- Notes Wrapper
3033:
3034: sub noteswrapper {
3035: my ($link,$un,$do)=@_;
3036: return
1.896 amueller 3037: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 3038: }
1.802 bisitz 3039:
1.62 www 3040: # ------------------------------------------------------------- Aboutme Wrapper
3041:
3042: sub aboutmewrapper {
1.166 www 3043: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 3044: if (!defined($username) && !defined($domain)) {
3045: return;
3046: }
1.892 amueller 3047: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.756 weissno 3048: ($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 3049: }
3050:
3051: # ------------------------------------------------------------ Syllabus Wrapper
3052:
3053: sub syllabuswrapper {
1.707 bisitz 3054: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 3055: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 3056: }
1.14 harris41 3057:
1.802 bisitz 3058: # -----------------------------------------------------------------------------
3059:
1.208 matthew 3060: sub track_student_link {
1.887 raeburn 3061: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 3062: my $link ="/adm/trackstudent?";
1.208 matthew 3063: my $title = 'View recent activity';
3064: if (defined($sname) && $sname !~ /^\s*$/ &&
3065: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 3066: $link .= "selected_student=$sname:$sdom";
1.208 matthew 3067: $title .= ' of this student';
1.268 albertel 3068: }
1.208 matthew 3069: if (defined($target) && $target !~ /^\s*$/) {
3070: $target = qq{target="$target"};
3071: } else {
3072: $target = '';
3073: }
1.268 albertel 3074: if ($start) { $link.='&start='.$start; }
1.887 raeburn 3075: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 3076: $title = &mt($title);
3077: $linktext = &mt($linktext);
1.448 albertel 3078: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
3079: &help_open_topic('View_recent_activity');
1.208 matthew 3080: }
3081:
1.781 raeburn 3082: sub slot_reservations_link {
3083: my ($linktext,$sname,$sdom,$target) = @_;
3084: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
3085: my $title = 'View slot reservation history';
3086: if (defined($sname) && $sname !~ /^\s*$/ &&
3087: defined($sdom) && $sdom !~ /^\s*$/) {
3088: $link .= "&uname=$sname&udom=$sdom";
3089: $title .= ' of this student';
3090: }
3091: if (defined($target) && $target !~ /^\s*$/) {
3092: $target = qq{target="$target"};
3093: } else {
3094: $target = '';
3095: }
3096: $title = &mt($title);
3097: $linktext = &mt($linktext);
3098: return qq{<a href="$link" title="$title" $target>$linktext</a>};
3099: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
3100:
3101: }
3102:
1.508 www 3103: # ===================================================== Display a student photo
3104:
3105:
1.509 albertel 3106: sub student_image_tag {
1.508 www 3107: my ($domain,$user)=@_;
3108: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
3109: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
3110: return '<img src="'.$imgsrc.'" align="right" />';
3111: } else {
3112: return '';
3113: }
3114: }
3115:
1.112 bowersj2 3116: =pod
3117:
3118: =back
3119:
3120: =head1 Access .tab File Data
3121:
3122: =over 4
3123:
1.648 raeburn 3124: =item * &languageids()
1.112 bowersj2 3125:
3126: returns list of all language ids
3127:
3128: =cut
3129:
1.14 harris41 3130: sub languageids {
1.16 harris41 3131: return sort(keys(%language));
1.14 harris41 3132: }
3133:
1.112 bowersj2 3134: =pod
3135:
1.648 raeburn 3136: =item * &languagedescription()
1.112 bowersj2 3137:
3138: returns description of a specified language id
3139:
3140: =cut
3141:
1.14 harris41 3142: sub languagedescription {
1.125 www 3143: my $code=shift;
3144: return ($supported_language{$code}?'* ':'').
3145: $language{$code}.
1.126 www 3146: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 3147: }
3148:
3149: sub plainlanguagedescription {
3150: my $code=shift;
3151: return $language{$code};
3152: }
3153:
3154: sub supportedlanguagecode {
3155: my $code=shift;
3156: return $supported_language{$code};
1.97 www 3157: }
3158:
1.112 bowersj2 3159: =pod
3160:
1.648 raeburn 3161: =item * ©rightids()
1.112 bowersj2 3162:
3163: returns list of all copyrights
3164:
3165: =cut
3166:
3167: sub copyrightids {
3168: return sort(keys(%cprtag));
3169: }
3170:
3171: =pod
3172:
1.648 raeburn 3173: =item * ©rightdescription()
1.112 bowersj2 3174:
3175: returns description of a specified copyright id
3176:
3177: =cut
3178:
3179: sub copyrightdescription {
1.166 www 3180: return &mt($cprtag{shift(@_)});
1.112 bowersj2 3181: }
1.197 matthew 3182:
3183: =pod
3184:
1.648 raeburn 3185: =item * &source_copyrightids()
1.192 taceyjo1 3186:
3187: returns list of all source copyrights
3188:
3189: =cut
3190:
3191: sub source_copyrightids {
3192: return sort(keys(%scprtag));
3193: }
3194:
3195: =pod
3196:
1.648 raeburn 3197: =item * &source_copyrightdescription()
1.192 taceyjo1 3198:
3199: returns description of a specified source copyright id
3200:
3201: =cut
3202:
3203: sub source_copyrightdescription {
3204: return &mt($scprtag{shift(@_)});
3205: }
1.112 bowersj2 3206:
3207: =pod
3208:
1.648 raeburn 3209: =item * &filecategories()
1.112 bowersj2 3210:
3211: returns list of all file categories
3212:
3213: =cut
3214:
3215: sub filecategories {
3216: return sort(keys(%category_extensions));
3217: }
3218:
3219: =pod
3220:
1.648 raeburn 3221: =item * &filecategorytypes()
1.112 bowersj2 3222:
3223: returns list of file types belonging to a given file
3224: category
3225:
3226: =cut
3227:
3228: sub filecategorytypes {
1.356 albertel 3229: my ($cat) = @_;
3230: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 3231: }
3232:
3233: =pod
3234:
1.648 raeburn 3235: =item * &fileembstyle()
1.112 bowersj2 3236:
3237: returns embedding style for a specified file type
3238:
3239: =cut
3240:
3241: sub fileembstyle {
3242: return $fe{lc(shift(@_))};
1.169 www 3243: }
3244:
1.351 www 3245: sub filemimetype {
3246: return $fm{lc(shift(@_))};
3247: }
3248:
1.169 www 3249:
3250: sub filecategoryselect {
3251: my ($name,$value)=@_;
1.189 matthew 3252: return &select_form($value,$name,
1.970 raeburn 3253: {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112 bowersj2 3254: }
3255:
3256: =pod
3257:
1.648 raeburn 3258: =item * &filedescription()
1.112 bowersj2 3259:
3260: returns description for a specified file type
3261:
3262: =cut
3263:
3264: sub filedescription {
1.188 matthew 3265: my $file_description = $fd{lc(shift())};
3266: $file_description =~ s:([\[\]]):~$1:g;
3267: return &mt($file_description);
1.112 bowersj2 3268: }
3269:
3270: =pod
3271:
1.648 raeburn 3272: =item * &filedescriptionex()
1.112 bowersj2 3273:
3274: returns description for a specified file type with
3275: extra formatting
3276:
3277: =cut
3278:
3279: sub filedescriptionex {
3280: my $ex=shift;
1.188 matthew 3281: my $file_description = $fd{lc($ex)};
3282: $file_description =~ s:([\[\]]):~$1:g;
3283: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3284: }
3285:
3286: # End of .tab access
3287: =pod
3288:
3289: =back
3290:
3291: =cut
3292:
3293: # ------------------------------------------------------------------ File Types
3294: sub fileextensions {
3295: return sort(keys(%fe));
3296: }
3297:
1.97 www 3298: # ----------------------------------------------------------- Display Languages
3299: # returns a hash with all desired display languages
3300: #
3301:
3302: sub display_languages {
3303: my %languages=();
1.695 raeburn 3304: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3305: $languages{$lang}=1;
1.97 www 3306: }
3307: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3308: if ($env{'form.displaylanguage'}) {
1.356 albertel 3309: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3310: $languages{$lang}=1;
1.97 www 3311: }
3312: }
3313: return %languages;
1.14 harris41 3314: }
3315:
1.582 albertel 3316: sub languages {
3317: my ($possible_langs) = @_;
1.695 raeburn 3318: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3319: if (!ref($possible_langs)) {
3320: if( wantarray ) {
3321: return @preferred_langs;
3322: } else {
3323: return $preferred_langs[0];
3324: }
3325: }
3326: my %possibilities = map { $_ => 1 } (@$possible_langs);
3327: my @preferred_possibilities;
3328: foreach my $preferred_lang (@preferred_langs) {
3329: if (exists($possibilities{$preferred_lang})) {
3330: push(@preferred_possibilities, $preferred_lang);
3331: }
3332: }
3333: if( wantarray ) {
3334: return @preferred_possibilities;
3335: }
3336: return $preferred_possibilities[0];
3337: }
3338:
1.742 raeburn 3339: sub user_lang {
3340: my ($touname,$toudom,$fromcid) = @_;
3341: my @userlangs;
3342: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3343: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3344: $env{'course.'.$fromcid.'.languages'}));
3345: } else {
3346: my %langhash = &getlangs($touname,$toudom);
3347: if ($langhash{'languages'} ne '') {
3348: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3349: } else {
3350: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3351: if ($domdefs{'lang_def'} ne '') {
3352: @userlangs = ($domdefs{'lang_def'});
3353: }
3354: }
3355: }
3356: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3357: my $user_lh = Apache::localize->get_handle(@languages);
3358: return $user_lh;
3359: }
3360:
3361:
1.112 bowersj2 3362: ###############################################################
3363: ## Student Answer Attempts ##
3364: ###############################################################
3365:
3366: =pod
3367:
3368: =head1 Alternate Problem Views
3369:
3370: =over 4
3371:
1.648 raeburn 3372: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3373: $getattempt, $regexp, $gradesub)
3374:
3375: Return string with previous attempt on problem. Arguments:
3376:
3377: =over 4
3378:
3379: =item * $symb: Problem, including path
3380:
3381: =item * $username: username of the desired student
3382:
3383: =item * $domain: domain of the desired student
1.14 harris41 3384:
1.112 bowersj2 3385: =item * $course: Course ID
1.14 harris41 3386:
1.112 bowersj2 3387: =item * $getattempt: Leave blank for all attempts, otherwise put
3388: something
1.14 harris41 3389:
1.112 bowersj2 3390: =item * $regexp: if string matches this regexp, the string will be
3391: sent to $gradesub
1.14 harris41 3392:
1.112 bowersj2 3393: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3394:
1.112 bowersj2 3395: =back
1.14 harris41 3396:
1.112 bowersj2 3397: The output string is a table containing all desired attempts, if any.
1.16 harris41 3398:
1.112 bowersj2 3399: =cut
1.1 albertel 3400:
3401: sub get_previous_attempt {
1.43 ng 3402: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3403: my $prevattempts='';
1.43 ng 3404: no strict 'refs';
1.1 albertel 3405: if ($symb) {
1.3 albertel 3406: my (%returnhash)=
3407: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3408: if ($returnhash{'version'}) {
3409: my %lasthash=();
3410: my $version;
3411: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3412: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3413: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3414: }
1.1 albertel 3415: }
1.596 albertel 3416: $prevattempts=&start_data_table().&start_data_table_header_row();
3417: $prevattempts.='<th>'.&mt('History').'</th>';
1.978 raeburn 3418: my (%typeparts,%lasthidden);
1.945 raeburn 3419: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 3420: foreach my $key (sort(keys(%lasthash))) {
3421: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3422: if ($#parts > 0) {
1.31 albertel 3423: my $data=$parts[-1];
3424: pop(@parts);
1.945 raeburn 3425: if ($data eq 'type') {
3426: unless ($showsurv) {
3427: my $id = join(',',@parts);
3428: $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978 raeburn 3429: if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
3430: $lasthidden{$ign.'.'.$id} = 1;
3431: }
1.945 raeburn 3432: }
3433: delete($lasthash{$key});
3434: } else {
3435: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
3436: }
1.31 albertel 3437: } else {
1.41 ng 3438: if ($#parts == 0) {
3439: $prevattempts.='<th>'.$parts[0].'</th>';
3440: } else {
3441: $prevattempts.='<th>'.$ign.'</th>';
3442: }
1.31 albertel 3443: }
1.16 harris41 3444: }
1.596 albertel 3445: $prevattempts.=&end_data_table_header_row();
1.40 ng 3446: if ($getattempt eq '') {
3447: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.945 raeburn 3448: my @hidden;
3449: if (%typeparts) {
3450: foreach my $id (keys(%typeparts)) {
3451: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
3452: push(@hidden,$id);
3453: }
3454: }
3455: }
3456: $prevattempts.=&start_data_table_row().
3457: '<td>'.&mt('Transaction [_1]',$version).'</td>';
3458: if (@hidden) {
3459: foreach my $key (sort(keys(%lasthash))) {
3460: my $hide;
3461: foreach my $id (@hidden) {
3462: if ($key =~ /^\Q$id\E/) {
3463: $hide = 1;
3464: last;
3465: }
3466: }
3467: if ($hide) {
3468: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3469: if (($data eq 'award') || ($data eq 'awarddetail')) {
3470: my $value = &format_previous_attempt_value($key,
3471: $returnhash{$version.':'.$key});
3472: $prevattempts.='<td>'.$value.' </td>';
3473: } else {
3474: $prevattempts.='<td> </td>';
3475: }
3476: } else {
3477: if ($key =~ /\./) {
3478: my $value = &format_previous_attempt_value($key,
3479: $returnhash{$version.':'.$key});
3480: $prevattempts.='<td>'.$value.' </td>';
3481: } else {
3482: $prevattempts.='<td> </td>';
3483: }
3484: }
3485: }
3486: } else {
3487: foreach my $key (sort(keys(%lasthash))) {
3488: my $value = &format_previous_attempt_value($key,
3489: $returnhash{$version.':'.$key});
3490: $prevattempts.='<td>'.$value.' </td>';
3491: }
3492: }
3493: $prevattempts.=&end_data_table_row();
1.40 ng 3494: }
1.1 albertel 3495: }
1.945 raeburn 3496: my @currhidden = keys(%lasthidden);
1.596 albertel 3497: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3498: foreach my $key (sort(keys(%lasthash))) {
1.945 raeburn 3499: if (%typeparts) {
3500: my $hidden;
3501: foreach my $id (@currhidden) {
3502: if ($key =~ /^\Q$id\E/) {
3503: $hidden = 1;
3504: last;
3505: }
3506: }
3507: if ($hidden) {
3508: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3509: if (($data eq 'award') || ($data eq 'awarddetail')) {
3510: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3511: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3512: $value = &$gradesub($value);
3513: }
3514: $prevattempts.='<td>'.$value.' </td>';
3515: } else {
3516: $prevattempts.='<td> </td>';
3517: }
3518: } else {
3519: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3520: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3521: $value = &$gradesub($value);
3522: }
3523: $prevattempts.='<td>'.$value.' </td>';
3524: }
3525: } else {
3526: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3527: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3528: $value = &$gradesub($value);
3529: }
3530: $prevattempts.='<td>'.$value.' </td>';
3531: }
1.16 harris41 3532: }
1.596 albertel 3533: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3534: } else {
1.596 albertel 3535: $prevattempts=
3536: &start_data_table().&start_data_table_row().
3537: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3538: &end_data_table_row().&end_data_table();
1.1 albertel 3539: }
3540: } else {
1.596 albertel 3541: $prevattempts=
3542: &start_data_table().&start_data_table_row().
3543: '<td>'.&mt('No data.').'</td>'.
3544: &end_data_table_row().&end_data_table();
1.1 albertel 3545: }
1.10 albertel 3546: }
3547:
1.581 albertel 3548: sub format_previous_attempt_value {
3549: my ($key,$value) = @_;
3550: if ($key =~ /timestamp/) {
3551: $value = &Apache::lonlocal::locallocaltime($value);
3552: } elsif (ref($value) eq 'ARRAY') {
3553: $value = '('.join(', ', @{ $value }).')';
3554: } else {
3555: $value = &unescape($value);
3556: }
3557: return $value;
3558: }
3559:
3560:
1.107 albertel 3561: sub relative_to_absolute {
3562: my ($url,$output)=@_;
3563: my $parser=HTML::TokeParser->new(\$output);
3564: my $token;
3565: my $thisdir=$url;
3566: my @rlinks=();
3567: while ($token=$parser->get_token) {
3568: if ($token->[0] eq 'S') {
3569: if ($token->[1] eq 'a') {
3570: if ($token->[2]->{'href'}) {
3571: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3572: }
3573: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3574: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3575: } elsif ($token->[1] eq 'base') {
3576: $thisdir=$token->[2]->{'href'};
3577: }
3578: }
3579: }
3580: $thisdir=~s-/[^/]*$--;
1.356 albertel 3581: foreach my $link (@rlinks) {
1.726 raeburn 3582: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3583: ($link=~/^\//) ||
3584: ($link=~/^javascript:/i) ||
3585: ($link=~/^mailto:/i) ||
3586: ($link=~/^\#/)) {
3587: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3588: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3589: }
3590: }
3591: # -------------------------------------------------- Deal with Applet codebases
3592: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3593: return $output;
3594: }
3595:
1.112 bowersj2 3596: =pod
3597:
1.648 raeburn 3598: =item * &get_student_view()
1.112 bowersj2 3599:
3600: show a snapshot of what student was looking at
3601:
3602: =cut
3603:
1.10 albertel 3604: sub get_student_view {
1.186 albertel 3605: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3606: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3607: my (%form);
1.10 albertel 3608: my @elements=('symb','courseid','domain','username');
3609: foreach my $element (@elements) {
1.186 albertel 3610: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3611: }
1.186 albertel 3612: if (defined($moreenv)) {
3613: %form=(%form,%{$moreenv});
3614: }
1.236 albertel 3615: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3616: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3617: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3618: $userview=~s/\<body[^\>]*\>//gi;
3619: $userview=~s/\<\/body\>//gi;
3620: $userview=~s/\<html\>//gi;
3621: $userview=~s/\<\/html\>//gi;
3622: $userview=~s/\<head\>//gi;
3623: $userview=~s/\<\/head\>//gi;
3624: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3625: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3626: if (wantarray) {
3627: return ($userview,$response);
3628: } else {
3629: return $userview;
3630: }
3631: }
3632:
3633: sub get_student_view_with_retries {
3634: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3635:
3636: my $ok = 0; # True if we got a good response.
3637: my $content;
3638: my $response;
3639:
3640: # Try to get the student_view done. within the retries count:
3641:
3642: do {
3643: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3644: $ok = $response->is_success;
3645: if (!$ok) {
3646: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3647: }
3648: $retries--;
3649: } while (!$ok && ($retries > 0));
3650:
3651: if (!$ok) {
3652: $content = ''; # On error return an empty content.
3653: }
1.651 www 3654: if (wantarray) {
3655: return ($content, $response);
3656: } else {
3657: return $content;
3658: }
1.11 albertel 3659: }
3660:
1.112 bowersj2 3661: =pod
3662:
1.648 raeburn 3663: =item * &get_student_answers()
1.112 bowersj2 3664:
3665: show a snapshot of how student was answering problem
3666:
3667: =cut
3668:
1.11 albertel 3669: sub get_student_answers {
1.100 sakharuk 3670: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3671: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3672: my (%moreenv);
1.11 albertel 3673: my @elements=('symb','courseid','domain','username');
3674: foreach my $element (@elements) {
1.186 albertel 3675: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3676: }
1.186 albertel 3677: $moreenv{'grade_target'}='answer';
3678: %moreenv=(%form,%moreenv);
1.497 raeburn 3679: $feedurl = &Apache::lonnet::clutter($feedurl);
3680: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3681: return $userview;
1.1 albertel 3682: }
1.116 albertel 3683:
3684: =pod
3685:
3686: =item * &submlink()
3687:
1.242 albertel 3688: Inputs: $text $uname $udom $symb $target
1.116 albertel 3689:
3690: Returns: A link to grades.pm such as to see the SUBM view of a student
3691:
3692: =cut
3693:
3694: ###############################################
3695: sub submlink {
1.242 albertel 3696: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3697: if (!($uname && $udom)) {
3698: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3699: &Apache::lonnet::whichuser($symb);
1.116 albertel 3700: if (!$symb) { $symb=$cursymb; }
3701: }
1.254 matthew 3702: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3703: $symb=&escape($symb);
1.960 bisitz 3704: if ($target) { $target=" target=\"$target\""; }
3705: return
3706: '<a href="/adm/grades?command=submission'.
3707: '&symb='.$symb.
3708: '&student='.$uname.
3709: '&userdom='.$udom.'"'.
3710: $target.'>'.$text.'</a>';
1.242 albertel 3711: }
3712: ##############################################
3713:
3714: =pod
3715:
3716: =item * &pgrdlink()
3717:
3718: Inputs: $text $uname $udom $symb $target
3719:
3720: Returns: A link to grades.pm such as to see the PGRD view of a student
3721:
3722: =cut
3723:
3724: ###############################################
3725: sub pgrdlink {
3726: my $link=&submlink(@_);
3727: $link=~s/(&command=submission)/$1&showgrading=yes/;
3728: return $link;
3729: }
3730: ##############################################
3731:
3732: =pod
3733:
3734: =item * &pprmlink()
3735:
3736: Inputs: $text $uname $udom $symb $target
3737:
3738: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3739: student and a specific resource
1.242 albertel 3740:
3741: =cut
3742:
3743: ###############################################
3744: sub pprmlink {
3745: my ($text,$uname,$udom,$symb,$target)=@_;
3746: if (!($uname && $udom)) {
3747: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3748: &Apache::lonnet::whichuser($symb);
1.242 albertel 3749: if (!$symb) { $symb=$cursymb; }
3750: }
1.254 matthew 3751: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3752: $symb=&escape($symb);
1.242 albertel 3753: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3754: return '<a href="/adm/parmset?command=set&'.
3755: 'symb='.$symb.'&uname='.$uname.
3756: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3757: }
3758: ##############################################
1.37 matthew 3759:
1.112 bowersj2 3760: =pod
3761:
3762: =back
3763:
3764: =cut
3765:
1.37 matthew 3766: ###############################################
1.51 www 3767:
3768:
3769: sub timehash {
1.687 raeburn 3770: my ($thistime) = @_;
3771: my $timezone = &Apache::lonlocal::gettimezone();
3772: my $dt = DateTime->from_epoch(epoch => $thistime)
3773: ->set_time_zone($timezone);
3774: my $wday = $dt->day_of_week();
3775: if ($wday == 7) { $wday = 0; }
3776: return ( 'second' => $dt->second(),
3777: 'minute' => $dt->minute(),
3778: 'hour' => $dt->hour(),
3779: 'day' => $dt->day_of_month(),
3780: 'month' => $dt->month(),
3781: 'year' => $dt->year(),
3782: 'weekday' => $wday,
3783: 'dayyear' => $dt->day_of_year(),
3784: 'dlsav' => $dt->is_dst() );
1.51 www 3785: }
3786:
1.370 www 3787: sub utc_string {
3788: my ($date)=@_;
1.371 www 3789: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3790: }
3791:
1.51 www 3792: sub maketime {
3793: my %th=@_;
1.687 raeburn 3794: my ($epoch_time,$timezone,$dt);
3795: $timezone = &Apache::lonlocal::gettimezone();
3796: eval {
3797: $dt = DateTime->new( year => $th{'year'},
3798: month => $th{'month'},
3799: day => $th{'day'},
3800: hour => $th{'hour'},
3801: minute => $th{'minute'},
3802: second => $th{'second'},
3803: time_zone => $timezone,
3804: );
3805: };
3806: if (!$@) {
3807: $epoch_time = $dt->epoch;
3808: if ($epoch_time) {
3809: return $epoch_time;
3810: }
3811: }
1.51 www 3812: return POSIX::mktime(
3813: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3814: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3815: }
3816:
3817: #########################################
1.51 www 3818:
3819: sub findallcourses {
1.482 raeburn 3820: my ($roles,$uname,$udom) = @_;
1.355 albertel 3821: my %roles;
3822: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3823: my %courses;
1.51 www 3824: my $now=time;
1.482 raeburn 3825: if (!defined($uname)) {
3826: $uname = $env{'user.name'};
3827: }
3828: if (!defined($udom)) {
3829: $udom = $env{'user.domain'};
3830: }
3831: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.982 raeburn 3832: my $extra = &Apache::lonnet::freeze_escape({'skipcheck' => 1});
3833: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname,'.',undef,
3834: $extra);
1.482 raeburn 3835: if (!%roles) {
3836: %roles = (
3837: cc => 1,
1.907 raeburn 3838: co => 1,
1.482 raeburn 3839: in => 1,
3840: ep => 1,
3841: ta => 1,
3842: cr => 1,
3843: st => 1,
3844: );
3845: }
3846: foreach my $entry (keys(%roleshash)) {
3847: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3848: if ($trole =~ /^cr/) {
3849: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3850: } else {
3851: next if (!exists($roles{$trole}));
3852: }
3853: if ($tend) {
3854: next if ($tend < $now);
3855: }
3856: if ($tstart) {
3857: next if ($tstart > $now);
3858: }
3859: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3860: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3861: if ($secpart eq '') {
3862: ($cnum,$role) = split(/_/,$cnumpart);
3863: $sec = 'none';
3864: $realsec = '';
3865: } else {
3866: $cnum = $cnumpart;
3867: ($sec,$role) = split(/_/,$secpart);
3868: $realsec = $sec;
1.490 raeburn 3869: }
1.482 raeburn 3870: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3871: }
3872: } else {
3873: foreach my $key (keys(%env)) {
1.483 albertel 3874: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3875: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3876: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3877: next if ($role eq 'ca' || $role eq 'aa');
3878: next if (%roles && !exists($roles{$role}));
3879: my ($starttime,$endtime)=split(/\./,$env{$key});
3880: my $active=1;
3881: if ($starttime) {
3882: if ($now<$starttime) { $active=0; }
3883: }
3884: if ($endtime) {
3885: if ($now>$endtime) { $active=0; }
3886: }
3887: if ($active) {
3888: if ($sec eq '') {
3889: $sec = 'none';
3890: }
3891: $courses{$cdom.'_'.$cnum}{$sec} =
3892: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 3893: }
3894: }
1.51 www 3895: }
3896: }
1.474 raeburn 3897: return %courses;
1.51 www 3898: }
1.37 matthew 3899:
1.54 www 3900: ###############################################
1.474 raeburn 3901:
3902: sub blockcheck {
1.482 raeburn 3903: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 3904:
3905: if (!defined($udom)) {
3906: $udom = $env{'user.domain'};
3907: }
3908: if (!defined($uname)) {
3909: $uname = $env{'user.name'};
3910: }
3911:
3912: # If uname and udom are for a course, check for blocks in the course.
3913:
3914: if (&Apache::lonnet::is_course($udom,$uname)) {
3915: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 3916: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 3917: return ($startblock,$endblock);
3918: }
1.474 raeburn 3919:
1.502 raeburn 3920: my $startblock = 0;
3921: my $endblock = 0;
1.482 raeburn 3922: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 3923:
1.490 raeburn 3924: # If uname is for a user, and activity is course-specific, i.e.,
3925: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3926:
1.490 raeburn 3927: if (($activity eq 'boards' || $activity eq 'chat' ||
3928: $activity eq 'groups') && ($env{'request.course.id'})) {
3929: foreach my $key (keys(%live_courses)) {
3930: if ($key ne $env{'request.course.id'}) {
3931: delete($live_courses{$key});
3932: }
3933: }
3934: }
3935:
3936: my $otheruser = 0;
3937: my %own_courses;
3938: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3939: # Resource belongs to user other than current user.
3940: $otheruser = 1;
3941: # Gather courses for current user
3942: %own_courses =
3943: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3944: }
3945:
3946: # Gather active course roles - course coordinator, instructor,
3947: # exam proctor, ta, student, or custom role.
1.474 raeburn 3948:
3949: foreach my $course (keys(%live_courses)) {
1.482 raeburn 3950: my ($cdom,$cnum);
3951: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3952: $cdom = $env{'course.'.$course.'.domain'};
3953: $cnum = $env{'course.'.$course.'.num'};
3954: } else {
1.490 raeburn 3955: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 3956: }
3957: my $no_ownblock = 0;
3958: my $no_userblock = 0;
1.533 raeburn 3959: if ($otheruser && $activity ne 'com') {
1.490 raeburn 3960: # Check if current user has 'evb' priv for this
3961: if (defined($own_courses{$course})) {
3962: foreach my $sec (keys(%{$own_courses{$course}})) {
3963: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3964: if ($sec ne 'none') {
3965: $checkrole .= '/'.$sec;
3966: }
3967: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3968: $no_ownblock = 1;
3969: last;
3970: }
3971: }
3972: }
3973: # if they have 'evb' priv and are currently not playing student
3974: next if (($no_ownblock) &&
3975: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
3976: }
1.474 raeburn 3977: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 3978: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 3979: if ($sec ne 'none') {
1.482 raeburn 3980: $checkrole .= '/'.$sec;
1.474 raeburn 3981: }
1.490 raeburn 3982: if ($otheruser) {
3983: # Resource belongs to user other than current user.
3984: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 3985: my ($trole,$tdom,$tnum,$tsec);
3986: my $entry = $live_courses{$course}{$sec};
3987: if ($entry =~ /^cr/) {
3988: ($trole,$tdom,$tnum,$tsec) =
3989: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
3990: } else {
3991: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
3992: }
3993: my ($spec,$area,$trest,%allroles,%userroles);
3994: $area = '/'.$tdom.'/'.$tnum;
3995: $trest = $tnum;
3996: if ($tsec ne '') {
3997: $area .= '/'.$tsec;
3998: $trest .= '/'.$tsec;
3999: }
4000: $spec = $trole.'.'.$area;
4001: if ($trole =~ /^cr/) {
4002: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
4003: $tdom,$spec,$trest,$area);
4004: } else {
4005: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
4006: $tdom,$spec,$trest,$area);
4007: }
4008: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 4009: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
4010: if ($1) {
4011: $no_userblock = 1;
4012: last;
4013: }
4014: }
1.490 raeburn 4015: } else {
4016: # Resource belongs to current user
4017: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 4018: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4019: $no_ownblock = 1;
4020: last;
4021: }
1.474 raeburn 4022: }
4023: }
4024: # if they have the evb priv and are currently not playing student
1.482 raeburn 4025: next if (($no_ownblock) &&
1.491 albertel 4026: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 4027: next if ($no_userblock);
1.474 raeburn 4028:
1.866 kalberla 4029: # Retrieve blocking times and identity of locker for course
1.490 raeburn 4030: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 4031:
4032: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
4033: if (($start != 0) &&
4034: (($startblock == 0) || ($startblock > $start))) {
4035: $startblock = $start;
4036: }
4037: if (($end != 0) &&
4038: (($endblock == 0) || ($endblock < $end))) {
4039: $endblock = $end;
4040: }
1.490 raeburn 4041: }
4042: return ($startblock,$endblock);
4043: }
4044:
4045: sub get_blocks {
4046: my ($setters,$activity,$cdom,$cnum) = @_;
4047: my $startblock = 0;
4048: my $endblock = 0;
4049: my $course = $cdom.'_'.$cnum;
4050: $setters->{$course} = {};
4051: $setters->{$course}{'staff'} = [];
4052: $setters->{$course}{'times'} = [];
4053: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
4054: foreach my $record (keys(%records)) {
4055: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
4056: if ($start <= time && $end >= time) {
4057: my ($staff_name,$staff_dom,$title,$blocks) =
4058: &parse_block_record($records{$record});
4059: if ($blocks->{$activity} eq 'on') {
4060: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
4061: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 4062: if ( ($startblock == 0) || ($startblock > $start) ) {
4063: $startblock = $start;
1.490 raeburn 4064: }
1.491 albertel 4065: if ( ($endblock == 0) || ($endblock < $end) ) {
4066: $endblock = $end;
1.474 raeburn 4067: }
4068: }
4069: }
4070: }
4071: return ($startblock,$endblock);
4072: }
4073:
4074: sub parse_block_record {
4075: my ($record) = @_;
4076: my ($setuname,$setudom,$title,$blocks);
4077: if (ref($record) eq 'HASH') {
4078: ($setuname,$setudom) = split(/:/,$record->{'setter'});
4079: $title = &unescape($record->{'event'});
4080: $blocks = $record->{'blocks'};
4081: } else {
4082: my @data = split(/:/,$record,3);
4083: if (scalar(@data) eq 2) {
4084: $title = $data[1];
4085: ($setuname,$setudom) = split(/@/,$data[0]);
4086: } else {
4087: ($setuname,$setudom,$title) = @data;
4088: }
4089: $blocks = { 'com' => 'on' };
4090: }
4091: return ($setuname,$setudom,$title,$blocks);
4092: }
4093:
1.854 kalberla 4094: sub blocking_status {
4095: my ($activity,$uname,$udom) = @_;
1.867 kalberla 4096: my %setters;
1.890 droeschl 4097:
4098: # check for active blocking
1.867 kalberla 4099: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
1.854 kalberla 4100:
1.890 droeschl 4101: my $blocked = $startblock && $endblock ? 1 : 0;
4102:
4103: # caller just wants to know whether a block is active
4104: if (!wantarray) { return $blocked; }
4105:
4106: # build a link to a popup window containing the details
4107: my $querystring = "?activity=$activity";
4108: # $uname and $udom decide whose portfolio the user is trying to look at
4109: $querystring .= "&udom=$udom" if $udom;
4110: $querystring .= "&uname=$uname" if $uname;
4111:
4112: my $output .= <<'END_MYBLOCK';
1.854 kalberla 4113: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
4114: var options = "width=" + w + ",height=" + h + ",";
4115: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
4116: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
4117: var newWin = window.open(url, wdwName, options);
4118: newWin.focus();
4119: }
1.890 droeschl 4120: END_MYBLOCK
1.854 kalberla 4121:
1.890 droeschl 4122: $output = Apache::lonhtmlcommon::scripttag($output);
4123:
1.854 kalberla 4124: my $popupUrl = "/adm/blockingstatus/$querystring";
1.890 droeschl 4125: my $text = mt('Communication Blocked');
4126:
1.867 kalberla 4127: $output .= <<"END_BLOCK";
4128: <div class='LC_comblock'>
1.869 kalberla 4129: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4130: title='$text'>
4131: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 4132: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4133: title='$text'>$text</a>
1.867 kalberla 4134: </div>
4135:
4136: END_BLOCK
1.474 raeburn 4137:
1.854 kalberla 4138: return ($blocked, $output);
4139: }
1.490 raeburn 4140:
1.60 matthew 4141: ###############################################
4142:
1.682 raeburn 4143: sub check_ip_acc {
4144: my ($acc)=@_;
4145: &Apache::lonxml::debug("acc is $acc");
4146: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
4147: return 1;
4148: }
4149: my $allowed=0;
4150: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
4151:
4152: my $name;
4153: foreach my $pattern (split(',',$acc)) {
4154: $pattern =~ s/^\s*//;
4155: $pattern =~ s/\s*$//;
4156: if ($pattern =~ /\*$/) {
4157: #35.8.*
4158: $pattern=~s/\*//;
4159: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4160: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
4161: #35.8.3.[34-56]
4162: my $low=$2;
4163: my $high=$3;
4164: $pattern=$1;
4165: if ($ip =~ /^\Q$pattern\E/) {
4166: my $last=(split(/\./,$ip))[3];
4167: if ($last <=$high && $last >=$low) { $allowed=1; }
4168: }
4169: } elsif ($pattern =~ /^\*/) {
4170: #*.msu.edu
4171: $pattern=~s/\*//;
4172: if (!defined($name)) {
4173: use Socket;
4174: my $netaddr=inet_aton($ip);
4175: ($name)=gethostbyaddr($netaddr,AF_INET);
4176: }
4177: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4178: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
4179: #127.0.0.1
4180: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4181: } else {
4182: #some.name.com
4183: if (!defined($name)) {
4184: use Socket;
4185: my $netaddr=inet_aton($ip);
4186: ($name)=gethostbyaddr($netaddr,AF_INET);
4187: }
4188: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4189: }
4190: if ($allowed) { last; }
4191: }
4192: return $allowed;
4193: }
4194:
4195: ###############################################
4196:
1.60 matthew 4197: =pod
4198:
1.112 bowersj2 4199: =head1 Domain Template Functions
4200:
4201: =over 4
4202:
4203: =item * &determinedomain()
1.60 matthew 4204:
4205: Inputs: $domain (usually will be undef)
4206:
1.63 www 4207: Returns: Determines which domain should be used for designs
1.60 matthew 4208:
4209: =cut
1.54 www 4210:
1.60 matthew 4211: ###############################################
1.63 www 4212: sub determinedomain {
4213: my $domain=shift;
1.531 albertel 4214: if (! $domain) {
1.60 matthew 4215: # Determine domain if we have not been given one
1.893 raeburn 4216: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 4217: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
4218: if ($env{'request.role.domain'}) {
4219: $domain=$env{'request.role.domain'};
1.60 matthew 4220: }
4221: }
1.63 www 4222: return $domain;
4223: }
4224: ###############################################
1.517 raeburn 4225:
1.518 albertel 4226: sub devalidate_domconfig_cache {
4227: my ($udom)=@_;
4228: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
4229: }
4230:
4231: # ---------------------- Get domain configuration for a domain
4232: sub get_domainconf {
4233: my ($udom) = @_;
4234: my $cachetime=1800;
4235: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
4236: if (defined($cached)) { return %{$result}; }
4237:
4238: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 4239: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 4240: my (%designhash,%legacy);
1.518 albertel 4241: if (keys(%domconfig) > 0) {
4242: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 4243: if (keys(%{$domconfig{'login'}})) {
4244: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 4245: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.946 raeburn 4246: if ($key eq 'loginvia') {
4247: if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') {
4248: my @ids = &Apache::lonnet::current_machine_ids();
4249: foreach my $hostname (@ids) {
1.948 raeburn 4250: if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') {
4251: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
4252: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
4253: $designhash{$udom.'.login.loginvia'} = $server;
4254: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
4255:
4256: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
4257: } else {
4258: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
4259: }
4260: if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) {
4261: $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'};
4262: }
1.946 raeburn 4263: }
4264: }
4265: }
4266: }
4267: } else {
4268: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
4269: $designhash{$udom.'.login.'.$key.'_'.$img} =
4270: $domconfig{'login'}{$key}{$img};
4271: }
1.699 raeburn 4272: }
4273: } else {
4274: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
4275: }
1.632 raeburn 4276: }
4277: } else {
4278: $legacy{'login'} = 1;
1.518 albertel 4279: }
1.632 raeburn 4280: } else {
4281: $legacy{'login'} = 1;
1.518 albertel 4282: }
4283: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 4284: if (keys(%{$domconfig{'rolecolors'}})) {
4285: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
4286: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
4287: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
4288: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
4289: }
1.518 albertel 4290: }
4291: }
1.632 raeburn 4292: } else {
4293: $legacy{'rolecolors'} = 1;
1.518 albertel 4294: }
1.632 raeburn 4295: } else {
4296: $legacy{'rolecolors'} = 1;
1.518 albertel 4297: }
1.948 raeburn 4298: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
4299: if ($domconfig{'autoenroll'}{'co-owners'}) {
4300: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
4301: }
4302: }
1.632 raeburn 4303: if (keys(%legacy) > 0) {
4304: my %legacyhash = &get_legacy_domconf($udom);
4305: foreach my $item (keys(%legacyhash)) {
4306: if ($item =~ /^\Q$udom\E\.login/) {
4307: if ($legacy{'login'}) {
4308: $designhash{$item} = $legacyhash{$item};
4309: }
4310: } else {
4311: if ($legacy{'rolecolors'}) {
4312: $designhash{$item} = $legacyhash{$item};
4313: }
1.518 albertel 4314: }
4315: }
4316: }
1.632 raeburn 4317: } else {
4318: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4319: }
4320: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4321: $cachetime);
4322: return %designhash;
4323: }
4324:
1.632 raeburn 4325: sub get_legacy_domconf {
4326: my ($udom) = @_;
4327: my %legacyhash;
4328: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4329: my $designfile = $designdir.'/'.$udom.'.tab';
4330: if (-e $designfile) {
4331: if ( open (my $fh,"<$designfile") ) {
4332: while (my $line = <$fh>) {
4333: next if ($line =~ /^\#/);
4334: chomp($line);
4335: my ($key,$val)=(split(/\=/,$line));
4336: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4337: }
4338: close($fh);
4339: }
4340: }
4341: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
4342: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4343: }
4344: return %legacyhash;
4345: }
4346:
1.63 www 4347: =pod
4348:
1.112 bowersj2 4349: =item * &domainlogo()
1.63 www 4350:
4351: Inputs: $domain (usually will be undef)
4352:
4353: Returns: A link to a domain logo, if the domain logo exists.
4354: If the domain logo does not exist, a description of the domain.
4355:
4356: =cut
1.112 bowersj2 4357:
1.63 www 4358: ###############################################
4359: sub domainlogo {
1.517 raeburn 4360: my $domain = &determinedomain(shift);
1.518 albertel 4361: my %designhash = &get_domainconf($domain);
1.517 raeburn 4362: # See if there is a logo
4363: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4364: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4365: if ($imgsrc =~ m{^/(adm|res)/}) {
4366: if ($imgsrc =~ m{^/res/}) {
4367: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4368: &Apache::lonnet::repcopy($local_name);
4369: }
4370: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4371: }
4372: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4373: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4374: return &Apache::lonnet::domain($domain,'description');
1.59 www 4375: } else {
1.60 matthew 4376: return '';
1.59 www 4377: }
4378: }
1.63 www 4379: ##############################################
4380:
4381: =pod
4382:
1.112 bowersj2 4383: =item * &designparm()
1.63 www 4384:
4385: Inputs: $which parameter; $domain (usually will be undef)
4386:
4387: Returns: value of designparamter $which
4388:
4389: =cut
1.112 bowersj2 4390:
1.397 albertel 4391:
1.400 albertel 4392: ##############################################
1.397 albertel 4393: sub designparm {
4394: my ($which,$domain)=@_;
4395: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 4396: return $env{'environment.color.'.$which};
1.96 www 4397: }
1.63 www 4398: $domain=&determinedomain($domain);
1.518 albertel 4399: my %domdesign = &get_domainconf($domain);
1.520 raeburn 4400: my $output;
1.517 raeburn 4401: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 4402: $output = $domdesign{$domain.'.'.$which};
1.63 www 4403: } else {
1.520 raeburn 4404: $output = $defaultdesign{$which};
4405: }
4406: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4407: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4408: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 4409: if ($output =~ m{^/res/}) {
4410: my $local_name = &Apache::lonnet::filelocation('',$output);
4411: &Apache::lonnet::repcopy($local_name);
4412: }
1.520 raeburn 4413: $output = &lonhttpdurl($output);
4414: }
1.63 www 4415: }
1.520 raeburn 4416: return $output;
1.63 www 4417: }
1.59 www 4418:
1.822 bisitz 4419: ##############################################
4420: =pod
4421:
1.832 bisitz 4422: =item * &authorspace()
4423:
4424: Inputs: ./.
4425:
4426: Returns: Path to the Construction Space of the current user's
4427: accessed author space
4428: The author space will be that of the current user
4429: when accessing the own author space
4430: and that of the co-author/assistent co-author
4431: when accessing the co-author's/assistent co-author's
4432: space
4433:
4434: =cut
4435:
4436: sub authorspace {
4437: my $caname = '';
4438: if ($env{'request.role'} =~ /^ca|^aa/) {
4439: (undef,$caname) =
4440: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
4441: } else {
4442: $caname = $env{'user.name'};
4443: }
4444: return '/priv/'.$caname.'/';
4445: }
4446:
4447: ##############################################
4448: =pod
4449:
1.822 bisitz 4450: =item * &head_subbox()
4451:
4452: Inputs: $content (contains HTML code with page functions, etc.)
4453:
4454: Returns: HTML div with $content
4455: To be included in page header
4456:
4457: =cut
4458:
4459: sub head_subbox {
4460: my ($content)=@_;
4461: my $output =
1.844 bisitz 4462: '<div id="LC_head_subbox">'
1.822 bisitz 4463: .$content
4464: .'</div>'
4465: }
4466:
4467: ##############################################
4468: =pod
4469:
4470: =item * &CSTR_pageheader()
4471:
4472: Inputs: ./.
4473:
4474: Returns: HTML div with CSTR path and recent box
4475: To be included on Construction Space pages
4476:
4477: =cut
4478:
4479: sub CSTR_pageheader {
4480: # this is for resources; directories have customtitle, and crumbs
4481: # and select recent are created in lonpubdir.pm
4482: my ($uname,$thisdisfn)=
4483: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
4484: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4485: $formaction=~s/\/+/\//g;
4486:
4487: my $parentpath = '';
4488: my $lastitem = '';
4489: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4490: $parentpath = $1;
4491: $lastitem = $2;
4492: } else {
4493: $lastitem = $thisdisfn;
4494: }
1.921 bisitz 4495:
4496: my $output =
1.822 bisitz 4497: '<div>'
4498: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
4499: .'<b>'.&mt('Construction Space:').'</b> '
4500: .'<form name="dirs" method="post" action="'.$formaction
1.921 bisitz 4501: .'" target="_top">' #FIXME lonpubdir: target="_parent"
4502: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv',undef,undef);
4503:
4504: if ($lastitem) {
4505: $output .=
4506: '<span class="LC_filename">'
4507: .$lastitem
4508: .'</span>';
4509: }
4510: $output .=
4511: '<br />'
1.822 bisitz 4512: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
4513: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4514: .'</form>'
4515: .&Apache::lonmenu::constspaceform()
4516: .'</div>';
1.921 bisitz 4517:
4518: return $output;
1.822 bisitz 4519: }
4520:
1.60 matthew 4521: ###############################################
4522: ###############################################
4523:
4524: =pod
4525:
1.112 bowersj2 4526: =back
4527:
1.549 albertel 4528: =head1 HTML Helpers
1.112 bowersj2 4529:
4530: =over 4
4531:
4532: =item * &bodytag()
1.60 matthew 4533:
4534: Returns a uniform header for LON-CAPA web pages.
4535:
4536: Inputs:
4537:
1.112 bowersj2 4538: =over 4
4539:
4540: =item * $title, A title to be displayed on the page.
4541:
4542: =item * $function, the current role (can be undef).
4543:
4544: =item * $addentries, extra parameters for the <body> tag.
4545:
4546: =item * $bodyonly, if defined, only return the <body> tag.
4547:
4548: =item * $domain, if defined, force a given domain.
4549:
4550: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4551: text interface only)
1.60 matthew 4552:
1.814 bisitz 4553: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
4554: navigational links
1.317 albertel 4555:
1.338 albertel 4556: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4557:
1.460 albertel 4558: =item * $args, optional argument valid values are
4559: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4560: inherit_jsmath -> when creating popup window in a page,
4561: should it have jsmath forced on by the
4562: current page
1.460 albertel 4563:
1.112 bowersj2 4564: =back
4565:
1.60 matthew 4566: Returns: A uniform header for LON-CAPA web pages.
4567: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4568: If $bodyonly is undef or zero, an html string containing a <body> tag and
4569: other decorations will be returned.
4570:
4571: =cut
4572:
1.54 www 4573: sub bodytag {
1.831 bisitz 4574: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.962 droeschl 4575: $no_nav_bar,$bgcolor,$args)=@_;
1.339 albertel 4576:
1.954 raeburn 4577: my $public;
4578: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
4579: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
4580: $public = 1;
4581: }
1.460 albertel 4582: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4583:
1.183 matthew 4584: $function = &get_users_function() if (!$function);
1.339 albertel 4585: my $img = &designparm($function.'.img',$domain);
4586: my $font = &designparm($function.'.font',$domain);
4587: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4588:
1.803 bisitz 4589: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 4590: 'bgcolor' => $pgbg,
1.339 albertel 4591: 'text' => $font,
4592: 'alink' => &designparm($function.'.alink',$domain),
4593: 'vlink' => &designparm($function.'.vlink',$domain),
4594: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4595: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4596:
1.63 www 4597: # role and realm
1.378 raeburn 4598: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4599: if ($role eq 'ca') {
1.479 albertel 4600: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4601: $realm = &plainname($rname,$rdom);
1.378 raeburn 4602: }
1.55 www 4603: # realm
1.258 albertel 4604: if ($env{'request.course.id'}) {
1.378 raeburn 4605: if ($env{'request.role'} !~ /^cr/) {
4606: $role = &Apache::lonnet::plaintext($role,&course_type());
4607: }
1.898 raeburn 4608: if ($env{'request.course.sec'}) {
4609: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
4610: }
1.359 albertel 4611: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4612: } else {
4613: $role = &Apache::lonnet::plaintext($role);
1.54 www 4614: }
1.433 albertel 4615:
1.359 albertel 4616: if (!$realm) { $realm=' '; }
1.330 albertel 4617:
1.438 albertel 4618: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4619:
1.101 www 4620: # construct main body tag
1.359 albertel 4621: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4622: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4623:
1.530 albertel 4624: if ($bodyonly) {
1.60 matthew 4625: return $bodytag;
1.798 tempelho 4626: }
1.359 albertel 4627:
1.410 albertel 4628: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.954 raeburn 4629: if ($public) {
1.433 albertel 4630: undef($role);
1.434 albertel 4631: } else {
4632: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4633: }
1.359 albertel 4634:
1.762 bisitz 4635: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 4636: #
4637: # Extra info if you are the DC
4638: my $dc_info = '';
4639: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4640: $env{'course.'.$env{'request.course.id'}.
4641: '.domain'}.'/'})) {
4642: my $cid = $env{'request.course.id'};
1.917 raeburn 4643: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4644: $dc_info =~ s/\s+$//;
1.359 albertel 4645: }
4646:
1.898 raeburn 4647: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853 droeschl 4648: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
4649:
1.916 droeschl 4650: if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') {
4651: return $bodytag;
4652: }
1.903 droeschl 4653:
4654: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
4655:
4656: # if ($env{'request.state'} eq 'construct') {
4657: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
4658: # }
4659:
1.359 albertel 4660:
4661:
1.916 droeschl 4662: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917 raeburn 4663: if ($dc_info) {
4664: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
4665: }
1.916 droeschl 4666: $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
4667: <em>$realm</em> $dc_info</div>|;
1.903 droeschl 4668: return $bodytag;
4669: }
1.894 droeschl 4670:
1.927 raeburn 4671: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
4672: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
4673: }
1.916 droeschl 4674:
1.903 droeschl 4675: $bodytag .= Apache::lonhtmlcommon::scripttag(
4676: Apache::lonmenu::utilityfunctions(), 'start');
1.816 bisitz 4677:
1.903 droeschl 4678: $bodytag .= Apache::lonmenu::primary_menu();
1.852 droeschl 4679:
1.917 raeburn 4680: if ($dc_info) {
4681: $dc_info = &dc_courseid_toggle($dc_info);
4682: }
4683: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 4684:
1.903 droeschl 4685: #don't show menus for public users
1.954 raeburn 4686: if (!$public){
1.903 droeschl 4687: $bodytag .= Apache::lonmenu::secondary_menu();
4688: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 4689: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
4690: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 4691: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.920 raeburn 4692: $args->{'bread_crumbs'});
4693: } elsif ($forcereg) {
4694: $bodytag .= &Apache::lonmenu::innerregister($forcereg);
4695: }
1.903 droeschl 4696: }else{
4697: # this is to seperate menu from content when there's no secondary
4698: # menu. Especially needed for public accessible ressources.
4699: $bodytag .= '<hr style="clear:both" />';
4700: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 4701: }
1.903 droeschl 4702:
1.235 raeburn 4703: return $bodytag;
1.182 matthew 4704: }
4705:
1.917 raeburn 4706: sub dc_courseid_toggle {
4707: my ($dc_info) = @_;
1.980 raeburn 4708: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.917 raeburn 4709: '<a href="javascript:showCourseID();">'.
4710: &mt('(More ...)').'</a></span>'.
4711: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
4712: }
4713:
1.330 albertel 4714: sub make_attr_string {
4715: my ($register,$attr_ref) = @_;
4716:
4717: if ($attr_ref && !ref($attr_ref)) {
4718: die("addentries Must be a hash ref ".
4719: join(':',caller(1))." ".
4720: join(':',caller(0))." ");
4721: }
4722:
4723: if ($register) {
1.339 albertel 4724: my ($on_load,$on_unload);
4725: foreach my $key (keys(%{$attr_ref})) {
4726: if (lc($key) eq 'onload') {
4727: $on_load.=$attr_ref->{$key}.';';
4728: delete($attr_ref->{$key});
4729:
4730: } elsif (lc($key) eq 'onunload') {
4731: $on_unload.=$attr_ref->{$key}.';';
4732: delete($attr_ref->{$key});
4733: }
4734: }
1.953 droeschl 4735: $attr_ref->{'onload'} = $on_load;
4736: $attr_ref->{'onunload'}= $on_unload;
1.330 albertel 4737: }
1.339 albertel 4738:
1.330 albertel 4739: my $attr_string;
4740: foreach my $attr (keys(%$attr_ref)) {
4741: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4742: }
4743: return $attr_string;
4744: }
4745:
4746:
1.182 matthew 4747: ###############################################
1.251 albertel 4748: ###############################################
4749:
4750: =pod
4751:
4752: =item * &endbodytag()
4753:
4754: Returns a uniform footer for LON-CAPA web pages.
4755:
1.635 raeburn 4756: Inputs: 1 - optional reference to an args hash
4757: If in the hash, key for noredirectlink has a value which evaluates to true,
4758: a 'Continue' link is not displayed if the page contains an
4759: internal redirect in the <head></head> section,
4760: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4761:
4762: =cut
4763:
4764: sub endbodytag {
1.635 raeburn 4765: my ($args) = @_;
1.251 albertel 4766: my $endbodytag='</body>';
1.269 albertel 4767: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4768: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4769: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4770: $endbodytag=
4771: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4772: &mt('Continue').'</a>'.
4773: $endbodytag;
4774: }
1.315 albertel 4775: }
1.251 albertel 4776: return $endbodytag;
4777: }
4778:
1.352 albertel 4779: =pod
4780:
4781: =item * &standard_css()
4782:
4783: Returns a style sheet
4784:
4785: Inputs: (all optional)
4786: domain -> force to color decorate a page for a specific
4787: domain
4788: function -> force usage of a specific rolish color scheme
4789: bgcolor -> override the default page bgcolor
4790:
4791: =cut
4792:
1.343 albertel 4793: sub standard_css {
1.345 albertel 4794: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4795: $function = &get_users_function() if (!$function);
4796: my $img = &designparm($function.'.img', $domain);
4797: my $tabbg = &designparm($function.'.tabbg', $domain);
4798: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 4799: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 4800: #second colour for later usage
1.345 albertel 4801: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4802: my $pgbg_or_bgcolor =
4803: $bgcolor ||
1.352 albertel 4804: &designparm($function.'.pgbg', $domain);
1.382 albertel 4805: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4806: my $alink = &designparm($function.'.alink', $domain);
4807: my $vlink = &designparm($function.'.vlink', $domain);
4808: my $link = &designparm($function.'.link', $domain);
4809:
1.602 albertel 4810: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4811: my $mono = 'monospace';
1.850 bisitz 4812: my $data_table_head = $sidebg;
4813: my $data_table_light = '#FAFAFA';
4814: my $data_table_dark = '#F0F0F0';
1.470 banghart 4815: my $data_table_darker = '#CCCCCC';
1.349 albertel 4816: my $data_table_highlight = '#FFFF00';
1.352 albertel 4817: my $mail_new = '#FFBB77';
4818: my $mail_new_hover = '#DD9955';
4819: my $mail_read = '#BBBB77';
4820: my $mail_read_hover = '#999944';
4821: my $mail_replied = '#AAAA88';
4822: my $mail_replied_hover = '#888855';
4823: my $mail_other = '#99BBBB';
4824: my $mail_other_hover = '#669999';
1.391 albertel 4825: my $table_header = '#DDDDDD';
1.489 raeburn 4826: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 4827: my $lg_border_color = '#C8C8C8';
1.952 onken 4828: my $button_hover = '#BF2317';
1.392 albertel 4829:
1.608 albertel 4830: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 4831: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
4832: : '0 3px 0 4px';
1.448 albertel 4833:
1.523 albertel 4834:
1.343 albertel 4835: return <<END;
1.947 droeschl 4836:
4837: /* needed for iframe to allow 100% height in FF */
4838: body, html {
4839: margin: 0;
4840: padding: 0 0.5%;
4841: height: 99%; /* to avoid scrollbars */
4842: }
4843:
1.795 www 4844: body {
1.911 bisitz 4845: font-family: $sans;
4846: line-height:130%;
4847: font-size:0.83em;
4848: color:$font;
1.795 www 4849: }
4850:
1.959 onken 4851: a:focus,
4852: a:focus img {
1.795 www 4853: color: red;
1.911 bisitz 4854: background: yellow;
1.795 www 4855: }
1.698 harmsja 4856:
1.911 bisitz 4857: form, .inline {
4858: display: inline;
1.795 www 4859: }
1.721 harmsja 4860:
1.795 www 4861: .LC_right {
1.911 bisitz 4862: text-align:right;
1.795 www 4863: }
4864:
4865: .LC_middle {
1.911 bisitz 4866: vertical-align:middle;
1.795 www 4867: }
1.721 harmsja 4868:
1.911 bisitz 4869: .LC_400Box {
4870: width:400px;
4871: }
1.721 harmsja 4872:
1.947 droeschl 4873: .LC_iframecontainer {
4874: width: 98%;
4875: margin: 0;
4876: position: fixed;
4877: top: 8.5em;
4878: bottom: 0;
4879: }
4880:
4881: .LC_iframecontainer iframe{
4882: border: none;
4883: width: 100%;
4884: height: 100%;
4885: }
4886:
1.778 bisitz 4887: .LC_filename {
4888: font-family: $mono;
4889: white-space:pre;
1.921 bisitz 4890: font-size: 120%;
1.778 bisitz 4891: }
4892:
4893: .LC_fileicon {
4894: border: none;
4895: height: 1.3em;
4896: vertical-align: text-bottom;
4897: margin-right: 0.3em;
4898: text-decoration:none;
4899: }
4900:
1.350 albertel 4901: .LC_error {
4902: color: red;
4903: font-size: larger;
4904: }
1.795 www 4905:
1.457 albertel 4906: .LC_warning,
4907: .LC_diff_removed {
1.733 bisitz 4908: color: red;
1.394 albertel 4909: }
1.532 albertel 4910:
4911: .LC_info,
1.457 albertel 4912: .LC_success,
4913: .LC_diff_added {
1.350 albertel 4914: color: green;
4915: }
1.795 www 4916:
1.802 bisitz 4917: div.LC_confirm_box {
4918: background-color: #FAFAFA;
4919: border: 1px solid $lg_border_color;
4920: margin-right: 0;
4921: padding: 5px;
4922: }
4923:
4924: div.LC_confirm_box .LC_error img,
4925: div.LC_confirm_box .LC_success img {
4926: vertical-align: middle;
4927: }
4928:
1.440 albertel 4929: .LC_icon {
1.771 droeschl 4930: border: none;
1.790 droeschl 4931: vertical-align: middle;
1.771 droeschl 4932: }
4933:
1.543 albertel 4934: .LC_docs_spacer {
4935: width: 25px;
4936: height: 1px;
1.771 droeschl 4937: border: none;
1.543 albertel 4938: }
1.346 albertel 4939:
1.532 albertel 4940: .LC_internal_info {
1.735 bisitz 4941: color: #999999;
1.532 albertel 4942: }
4943:
1.794 www 4944: .LC_discussion {
1.911 bisitz 4945: background: $tabbg;
4946: border: 1px solid black;
4947: margin: 2px;
1.794 www 4948: }
4949:
4950: .LC_disc_action_links_bar {
1.911 bisitz 4951: background: $tabbg;
4952: border: none;
4953: margin: 4px;
1.794 www 4954: }
4955:
4956: .LC_disc_action_left {
1.911 bisitz 4957: text-align: left;
1.794 www 4958: }
4959:
4960: .LC_disc_action_right {
1.911 bisitz 4961: text-align: right;
1.794 www 4962: }
4963:
4964: .LC_disc_new_item {
1.911 bisitz 4965: background: white;
4966: border: 2px solid red;
4967: margin: 2px;
1.794 www 4968: }
4969:
4970: .LC_disc_old_item {
1.911 bisitz 4971: background: white;
4972: border: 1px solid black;
4973: margin: 2px;
1.794 www 4974: }
4975:
1.458 albertel 4976: table.LC_pastsubmission {
4977: border: 1px solid black;
4978: margin: 2px;
4979: }
4980:
1.924 bisitz 4981: table#LC_menubuttons {
1.345 albertel 4982: width: 100%;
4983: background: $pgbg;
1.392 albertel 4984: border: 2px;
1.402 albertel 4985: border-collapse: separate;
1.803 bisitz 4986: padding: 0;
1.345 albertel 4987: }
1.392 albertel 4988:
1.801 tempelho 4989: table#LC_title_bar a {
4990: color: $fontmenu;
4991: }
1.836 bisitz 4992:
1.807 droeschl 4993: table#LC_title_bar {
1.819 tempelho 4994: clear: both;
1.836 bisitz 4995: display: none;
1.807 droeschl 4996: }
4997:
1.795 www 4998: table#LC_title_bar,
1.933 droeschl 4999: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 5000: table#LC_title_bar.LC_with_remote {
1.359 albertel 5001: width: 100%;
1.392 albertel 5002: border-color: $pgbg;
5003: border-style: solid;
5004: border-width: $border;
1.379 albertel 5005: background: $pgbg;
1.801 tempelho 5006: color: $fontmenu;
1.392 albertel 5007: border-collapse: collapse;
1.803 bisitz 5008: padding: 0;
1.819 tempelho 5009: margin: 0;
1.359 albertel 5010: }
1.795 www 5011:
1.933 droeschl 5012: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 5013: margin: 0;
5014: padding: 0;
1.933 droeschl 5015: position: relative;
5016: list-style: none;
1.913 droeschl 5017: }
1.933 droeschl 5018: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 5019: display: inline;
5020: }
1.933 droeschl 5021:
5022: .LC_breadcrumb_tools_navigation {
1.913 droeschl 5023: padding: 0;
1.933 droeschl 5024: margin: 0;
5025: float: left;
1.913 droeschl 5026: }
1.933 droeschl 5027: .LC_breadcrumb_tools_tools {
5028: padding: 0;
5029: margin: 0;
1.913 droeschl 5030: float: right;
5031: }
5032:
1.359 albertel 5033: table#LC_title_bar td {
5034: background: $tabbg;
5035: }
1.795 www 5036:
1.911 bisitz 5037: table#LC_menubuttons img {
1.803 bisitz 5038: border: none;
1.346 albertel 5039: }
1.795 www 5040:
1.842 droeschl 5041: .LC_breadcrumbs_component {
1.911 bisitz 5042: float: right;
5043: margin: 0 1em;
1.357 albertel 5044: }
1.842 droeschl 5045: .LC_breadcrumbs_component img {
1.911 bisitz 5046: vertical-align: middle;
1.777 tempelho 5047: }
1.795 www 5048:
1.383 albertel 5049: td.LC_table_cell_checkbox {
5050: text-align: center;
5051: }
1.795 www 5052:
5053: .LC_fontsize_small {
1.911 bisitz 5054: font-size: 70%;
1.705 tempelho 5055: }
5056:
1.844 bisitz 5057: #LC_breadcrumbs {
1.911 bisitz 5058: clear:both;
5059: background: $sidebg;
5060: border-bottom: 1px solid $lg_border_color;
5061: line-height: 2.5em;
1.933 droeschl 5062: overflow: hidden;
1.911 bisitz 5063: margin: 0;
5064: padding: 0;
1.819 tempelho 5065: }
1.862 bisitz 5066:
1.844 bisitz 5067: #LC_head_subbox {
1.911 bisitz 5068: clear:both;
5069: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 5070: border: 1px solid $sidebg;
5071: margin: 0 0 10px 0;
1.966 bisitz 5072: padding: 3px;
1.822 bisitz 5073: }
5074:
1.795 www 5075: .LC_fontsize_medium {
1.911 bisitz 5076: font-size: 85%;
1.705 tempelho 5077: }
5078:
1.795 www 5079: .LC_fontsize_large {
1.911 bisitz 5080: font-size: 120%;
1.705 tempelho 5081: }
5082:
1.346 albertel 5083: .LC_menubuttons_inline_text {
5084: color: $font;
1.698 harmsja 5085: font-size: 90%;
1.701 harmsja 5086: padding-left:3px;
1.346 albertel 5087: }
5088:
1.934 droeschl 5089: .LC_menubuttons_inline_text img{
5090: vertical-align: middle;
5091: }
5092:
1.951 onken 5093: li.LC_menubuttons_inline_text img,a {
5094: cursor:pointer;
5095: }
5096:
1.526 www 5097: .LC_menubuttons_link {
5098: text-decoration: none;
5099: }
1.795 www 5100:
1.522 albertel 5101: .LC_menubuttons_category {
1.521 www 5102: color: $font;
1.526 www 5103: background: $pgbg;
1.521 www 5104: font-size: larger;
5105: font-weight: bold;
5106: }
5107:
1.346 albertel 5108: td.LC_menubuttons_text {
1.911 bisitz 5109: color: $font;
1.346 albertel 5110: }
1.706 harmsja 5111:
1.346 albertel 5112: .LC_current_location {
5113: background: $tabbg;
5114: }
1.795 www 5115:
1.938 bisitz 5116: table.LC_data_table {
1.347 albertel 5117: border: 1px solid #000000;
1.402 albertel 5118: border-collapse: separate;
1.426 albertel 5119: border-spacing: 1px;
1.610 albertel 5120: background: $pgbg;
1.347 albertel 5121: }
1.795 www 5122:
1.422 albertel 5123: .LC_data_table_dense {
5124: font-size: small;
5125: }
1.795 www 5126:
1.507 raeburn 5127: table.LC_nested_outer {
5128: border: 1px solid #000000;
1.589 raeburn 5129: border-collapse: collapse;
1.803 bisitz 5130: border-spacing: 0;
1.507 raeburn 5131: width: 100%;
5132: }
1.795 www 5133:
1.879 raeburn 5134: table.LC_innerpickbox,
1.507 raeburn 5135: table.LC_nested {
1.803 bisitz 5136: border: none;
1.589 raeburn 5137: border-collapse: collapse;
1.803 bisitz 5138: border-spacing: 0;
1.507 raeburn 5139: width: 100%;
5140: }
1.795 www 5141:
1.930 faziophi 5142: .ui-accordion,
5143: .ui-accordion table.LC_data_table,
5144: .ui-accordion table.LC_nested_outer{
5145: border: 0px;
5146: border-spacing: 0px;
5147: margin: 3px;
5148: }
5149:
1.911 bisitz 5150: table.LC_data_table tr th,
5151: table.LC_calendar tr th,
1.879 raeburn 5152: table.LC_prior_tries tr th,
5153: table.LC_innerpickbox tr th {
1.349 albertel 5154: font-weight: bold;
5155: background-color: $data_table_head;
1.801 tempelho 5156: color:$fontmenu;
1.701 harmsja 5157: font-size:90%;
1.347 albertel 5158: }
1.795 www 5159:
1.879 raeburn 5160: table.LC_innerpickbox tr th,
5161: table.LC_innerpickbox tr td {
5162: vertical-align: top;
5163: }
5164:
1.711 raeburn 5165: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 5166: background-color: #CCCCCC;
1.711 raeburn 5167: font-weight: bold;
5168: text-align: left;
5169: }
1.795 www 5170:
1.912 bisitz 5171: table.LC_data_table tr.LC_odd_row > td {
5172: background-color: $data_table_light;
5173: padding: 2px;
5174: vertical-align: top;
5175: }
5176:
1.809 bisitz 5177: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 5178: background-color: $data_table_light;
1.912 bisitz 5179: vertical-align: top;
5180: }
5181:
5182: table.LC_data_table tr.LC_even_row > td {
5183: background-color: $data_table_dark;
1.425 albertel 5184: padding: 2px;
1.900 bisitz 5185: vertical-align: top;
1.347 albertel 5186: }
1.795 www 5187:
1.809 bisitz 5188: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 5189: background-color: $data_table_dark;
1.900 bisitz 5190: vertical-align: top;
1.347 albertel 5191: }
1.795 www 5192:
1.425 albertel 5193: table.LC_data_table tr.LC_data_table_highlight td {
5194: background-color: $data_table_darker;
5195: }
1.795 www 5196:
1.639 raeburn 5197: table.LC_data_table tr td.LC_leftcol_header {
5198: background-color: $data_table_head;
5199: font-weight: bold;
5200: }
1.795 www 5201:
1.451 albertel 5202: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5203: table.LC_nested tr.LC_empty_row td {
1.421 albertel 5204: font-weight: bold;
5205: font-style: italic;
5206: text-align: center;
5207: padding: 8px;
1.347 albertel 5208: }
1.795 www 5209:
1.940 bisitz 5210: table.LC_data_table tr.LC_empty_row td {
5211: background-color: $sidebg;
5212: }
5213:
5214: table.LC_nested tr.LC_empty_row td {
5215: background-color: #FFFFFF;
5216: }
5217:
1.890 droeschl 5218: table.LC_caption {
5219: }
5220:
1.507 raeburn 5221: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5222: padding: 4ex
5223: }
1.795 www 5224:
1.507 raeburn 5225: table.LC_nested_outer tr th {
5226: font-weight: bold;
1.801 tempelho 5227: color:$fontmenu;
1.507 raeburn 5228: background-color: $data_table_head;
1.701 harmsja 5229: font-size: small;
1.507 raeburn 5230: border-bottom: 1px solid #000000;
5231: }
1.795 www 5232:
1.507 raeburn 5233: table.LC_nested_outer tr td.LC_subheader {
5234: background-color: $data_table_head;
5235: font-weight: bold;
5236: font-size: small;
5237: border-bottom: 1px solid #000000;
5238: text-align: right;
1.451 albertel 5239: }
1.795 www 5240:
1.507 raeburn 5241: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5242: background-color: #CCCCCC;
1.451 albertel 5243: font-weight: bold;
5244: font-size: small;
1.507 raeburn 5245: text-align: center;
5246: }
1.795 www 5247:
1.589 raeburn 5248: table.LC_nested tr.LC_info_row td.LC_left_item,
5249: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5250: text-align: left;
1.451 albertel 5251: }
1.795 www 5252:
1.507 raeburn 5253: table.LC_nested td {
1.735 bisitz 5254: background-color: #FFFFFF;
1.451 albertel 5255: font-size: small;
1.507 raeburn 5256: }
1.795 www 5257:
1.507 raeburn 5258: table.LC_nested_outer tr th.LC_right_item,
5259: table.LC_nested tr.LC_info_row td.LC_right_item,
5260: table.LC_nested tr.LC_odd_row td.LC_right_item,
5261: table.LC_nested tr td.LC_right_item {
1.451 albertel 5262: text-align: right;
5263: }
5264:
1.930 faziophi 5265: .ui-accordion table.LC_nested tr.LC_odd_row td.LC_left_item,
5266: .ui-accordion table.LC_nested tr.LC_even_row td.LC_left_item {
5267: text-align: right;
5268: width: 40%;
5269: padding-right:10px;
5270: vertical-align: top;
5271: padding: 5px;
5272: }
5273:
5274: .ui-accordion table.LC_nested tr.LC_odd_row td.LC_right_item,
5275: .ui-accordion table.LC_nested tr.LC_even_row td.LC_right_item {
5276: text-align: left;
5277: width: 60%;
5278: padding: 2px 4px;
5279: }
5280:
1.507 raeburn 5281: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5282: background-color: #EEEEEE;
1.451 albertel 5283: }
5284:
1.473 raeburn 5285: table.LC_createuser {
5286: }
5287:
5288: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5289: font-size: small;
1.473 raeburn 5290: }
5291:
5292: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5293: background-color: #CCCCCC;
1.473 raeburn 5294: font-weight: bold;
5295: text-align: center;
5296: }
5297:
1.349 albertel 5298: table.LC_calendar {
5299: border: 1px solid #000000;
5300: border-collapse: collapse;
1.917 raeburn 5301: width: 98%;
1.349 albertel 5302: }
1.795 www 5303:
1.349 albertel 5304: table.LC_calendar_pickdate {
5305: font-size: xx-small;
5306: }
1.795 www 5307:
1.349 albertel 5308: table.LC_calendar tr td {
5309: border: 1px solid #000000;
5310: vertical-align: top;
1.917 raeburn 5311: width: 14%;
1.349 albertel 5312: }
1.795 www 5313:
1.349 albertel 5314: table.LC_calendar tr td.LC_calendar_day_empty {
5315: background-color: $data_table_dark;
5316: }
1.795 www 5317:
1.779 bisitz 5318: table.LC_calendar tr td.LC_calendar_day_current {
5319: background-color: $data_table_highlight;
1.777 tempelho 5320: }
1.795 www 5321:
1.938 bisitz 5322: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 5323: background-color: $mail_new;
5324: }
1.795 www 5325:
1.938 bisitz 5326: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 5327: background-color: $mail_new_hover;
5328: }
1.795 www 5329:
1.938 bisitz 5330: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 5331: background-color: $mail_read;
5332: }
1.795 www 5333:
1.938 bisitz 5334: /*
5335: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 5336: background-color: $mail_read_hover;
5337: }
1.938 bisitz 5338: */
1.795 www 5339:
1.938 bisitz 5340: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 5341: background-color: $mail_replied;
5342: }
1.795 www 5343:
1.938 bisitz 5344: /*
5345: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 5346: background-color: $mail_replied_hover;
5347: }
1.938 bisitz 5348: */
1.795 www 5349:
1.938 bisitz 5350: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 5351: background-color: $mail_other;
5352: }
1.795 www 5353:
1.938 bisitz 5354: /*
5355: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 5356: background-color: $mail_other_hover;
5357: }
1.938 bisitz 5358: */
1.494 raeburn 5359:
1.777 tempelho 5360: table.LC_data_table tr > td.LC_browser_file,
5361: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 5362: background: #AAEE77;
1.389 albertel 5363: }
1.795 www 5364:
1.777 tempelho 5365: table.LC_data_table tr > td.LC_browser_file_locked,
5366: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5367: background: #FFAA99;
1.387 albertel 5368: }
1.795 www 5369:
1.777 tempelho 5370: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 5371: background: #888888;
1.779 bisitz 5372: }
1.795 www 5373:
1.777 tempelho 5374: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5375: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 5376: background: #F8F866;
1.777 tempelho 5377: }
1.795 www 5378:
1.696 bisitz 5379: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 5380: background: #E0E8FF;
1.387 albertel 5381: }
1.696 bisitz 5382:
1.707 bisitz 5383: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 5384: /* background: #77FF77; */
1.707 bisitz 5385: }
1.795 www 5386:
1.707 bisitz 5387: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 5388: border-right: 8px solid #FFFF77;
1.707 bisitz 5389: }
1.795 www 5390:
1.707 bisitz 5391: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 5392: border-right: 8px solid #FFAA77;
1.707 bisitz 5393: }
1.795 www 5394:
1.707 bisitz 5395: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 5396: border-right: 8px solid #FF7777;
1.707 bisitz 5397: }
1.795 www 5398:
1.707 bisitz 5399: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 5400: border-right: 8px solid #AAFF77;
1.707 bisitz 5401: }
1.795 www 5402:
1.707 bisitz 5403: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 5404: border-right: 8px solid #11CC55;
1.707 bisitz 5405: }
5406:
1.388 albertel 5407: span.LC_current_location {
1.701 harmsja 5408: font-size:larger;
1.388 albertel 5409: background: $pgbg;
5410: }
1.387 albertel 5411:
1.395 albertel 5412: span.LC_parm_menu_item {
5413: font-size: larger;
5414: }
1.795 www 5415:
1.395 albertel 5416: span.LC_parm_scope_all {
5417: color: red;
5418: }
1.795 www 5419:
1.395 albertel 5420: span.LC_parm_scope_folder {
5421: color: green;
5422: }
1.795 www 5423:
1.395 albertel 5424: span.LC_parm_scope_resource {
5425: color: orange;
5426: }
1.795 www 5427:
1.395 albertel 5428: span.LC_parm_part {
5429: color: blue;
5430: }
1.795 www 5431:
1.911 bisitz 5432: span.LC_parm_folder,
5433: span.LC_parm_symb {
1.395 albertel 5434: font-size: x-small;
5435: font-family: $mono;
5436: color: #AAAAAA;
5437: }
5438:
1.977 bisitz 5439: ul.LC_parm_parmlist li {
5440: display: inline-block;
5441: padding: 0.3em 0.8em;
5442: vertical-align: top;
5443: width: 150px;
5444: border-top:1px solid $lg_border_color;
5445: }
5446:
1.795 www 5447: td.LC_parm_overview_level_menu,
5448: td.LC_parm_overview_map_menu,
5449: td.LC_parm_overview_parm_selectors,
5450: td.LC_parm_overview_restrictions {
1.396 albertel 5451: border: 1px solid black;
5452: border-collapse: collapse;
5453: }
1.795 www 5454:
1.396 albertel 5455: table.LC_parm_overview_restrictions td {
5456: border-width: 1px 4px 1px 4px;
5457: border-style: solid;
5458: border-color: $pgbg;
5459: text-align: center;
5460: }
1.795 www 5461:
1.396 albertel 5462: table.LC_parm_overview_restrictions th {
5463: background: $tabbg;
5464: border-width: 1px 4px 1px 4px;
5465: border-style: solid;
5466: border-color: $pgbg;
5467: }
1.795 www 5468:
1.398 albertel 5469: table#LC_helpmenu {
1.803 bisitz 5470: border: none;
1.398 albertel 5471: height: 55px;
1.803 bisitz 5472: border-spacing: 0;
1.398 albertel 5473: }
5474:
5475: table#LC_helpmenu fieldset legend {
5476: font-size: larger;
5477: }
1.795 www 5478:
1.397 albertel 5479: table#LC_helpmenu_links {
5480: width: 100%;
5481: border: 1px solid black;
5482: background: $pgbg;
1.803 bisitz 5483: padding: 0;
1.397 albertel 5484: border-spacing: 1px;
5485: }
1.795 www 5486:
1.397 albertel 5487: table#LC_helpmenu_links tr td {
5488: padding: 1px;
5489: background: $tabbg;
1.399 albertel 5490: text-align: center;
5491: font-weight: bold;
1.397 albertel 5492: }
1.396 albertel 5493:
1.795 www 5494: table#LC_helpmenu_links a:link,
5495: table#LC_helpmenu_links a:visited,
1.397 albertel 5496: table#LC_helpmenu_links a:active {
5497: text-decoration: none;
5498: color: $font;
5499: }
1.795 www 5500:
1.397 albertel 5501: table#LC_helpmenu_links a:hover {
5502: text-decoration: underline;
5503: color: $vlink;
5504: }
1.396 albertel 5505:
1.417 albertel 5506: .LC_chrt_popup_exists {
5507: border: 1px solid #339933;
5508: margin: -1px;
5509: }
1.795 www 5510:
1.417 albertel 5511: .LC_chrt_popup_up {
5512: border: 1px solid yellow;
5513: margin: -1px;
5514: }
1.795 www 5515:
1.417 albertel 5516: .LC_chrt_popup {
5517: border: 1px solid #8888FF;
5518: background: #CCCCFF;
5519: }
1.795 www 5520:
1.421 albertel 5521: table.LC_pick_box {
5522: border-collapse: separate;
5523: background: white;
5524: border: 1px solid black;
5525: border-spacing: 1px;
5526: }
1.795 www 5527:
1.421 albertel 5528: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 5529: background: $sidebg;
1.421 albertel 5530: font-weight: bold;
1.900 bisitz 5531: text-align: left;
1.740 bisitz 5532: vertical-align: top;
1.421 albertel 5533: width: 184px;
5534: padding: 8px;
5535: }
1.795 www 5536:
1.579 raeburn 5537: table.LC_pick_box td.LC_pick_box_value {
5538: text-align: left;
5539: padding: 8px;
5540: }
1.795 www 5541:
1.579 raeburn 5542: table.LC_pick_box td.LC_pick_box_select {
5543: text-align: left;
5544: padding: 8px;
5545: }
1.795 www 5546:
1.424 albertel 5547: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 5548: padding: 0;
1.421 albertel 5549: height: 1px;
5550: background: black;
5551: }
1.795 www 5552:
1.421 albertel 5553: table.LC_pick_box td.LC_pick_box_submit {
5554: text-align: right;
5555: }
1.795 www 5556:
1.579 raeburn 5557: table.LC_pick_box td.LC_evenrow_value {
5558: text-align: left;
5559: padding: 8px;
5560: background-color: $data_table_light;
5561: }
1.795 www 5562:
1.579 raeburn 5563: table.LC_pick_box td.LC_oddrow_value {
5564: text-align: left;
5565: padding: 8px;
5566: background-color: $data_table_light;
5567: }
1.795 www 5568:
1.579 raeburn 5569: span.LC_helpform_receipt_cat {
5570: font-weight: bold;
5571: }
1.795 www 5572:
1.424 albertel 5573: table.LC_group_priv_box {
5574: background: white;
5575: border: 1px solid black;
5576: border-spacing: 1px;
5577: }
1.795 www 5578:
1.424 albertel 5579: table.LC_group_priv_box td.LC_pick_box_title {
5580: background: $tabbg;
5581: font-weight: bold;
5582: text-align: right;
5583: width: 184px;
5584: }
1.795 www 5585:
1.424 albertel 5586: table.LC_group_priv_box td.LC_groups_fixed {
5587: background: $data_table_light;
5588: text-align: center;
5589: }
1.795 www 5590:
1.424 albertel 5591: table.LC_group_priv_box td.LC_groups_optional {
5592: background: $data_table_dark;
5593: text-align: center;
5594: }
1.795 www 5595:
1.424 albertel 5596: table.LC_group_priv_box td.LC_groups_functionality {
5597: background: $data_table_darker;
5598: text-align: center;
5599: font-weight: bold;
5600: }
1.795 www 5601:
1.424 albertel 5602: table.LC_group_priv td {
5603: text-align: left;
1.803 bisitz 5604: padding: 0;
1.424 albertel 5605: }
5606:
5607: .LC_navbuttons {
5608: margin: 2ex 0ex 2ex 0ex;
5609: }
1.795 www 5610:
1.423 albertel 5611: .LC_topic_bar {
5612: font-weight: bold;
5613: background: $tabbg;
1.918 wenzelju 5614: margin: 1em 0em 1em 2em;
1.805 bisitz 5615: padding: 3px;
1.918 wenzelju 5616: font-size: 1.2em;
1.423 albertel 5617: }
1.795 www 5618:
1.423 albertel 5619: .LC_topic_bar span {
1.918 wenzelju 5620: left: 0.5em;
5621: position: absolute;
1.423 albertel 5622: vertical-align: middle;
1.918 wenzelju 5623: font-size: 1.2em;
1.423 albertel 5624: }
1.795 www 5625:
1.423 albertel 5626: table.LC_course_group_status {
5627: margin: 20px;
5628: }
1.795 www 5629:
1.423 albertel 5630: table.LC_status_selector td {
5631: vertical-align: top;
5632: text-align: center;
1.424 albertel 5633: padding: 4px;
5634: }
1.795 www 5635:
1.599 albertel 5636: div.LC_feedback_link {
1.616 albertel 5637: clear: both;
1.829 kalberla 5638: background: $sidebg;
1.779 bisitz 5639: width: 100%;
1.829 kalberla 5640: padding-bottom: 10px;
5641: border: 1px $tabbg solid;
1.833 kalberla 5642: height: 22px;
5643: line-height: 22px;
5644: padding-top: 5px;
5645: }
5646:
5647: div.LC_feedback_link img {
5648: height: 22px;
1.867 kalberla 5649: vertical-align:middle;
1.829 kalberla 5650: }
5651:
1.911 bisitz 5652: div.LC_feedback_link a {
1.829 kalberla 5653: text-decoration: none;
1.489 raeburn 5654: }
1.795 www 5655:
1.867 kalberla 5656: div.LC_comblock {
1.911 bisitz 5657: display:inline;
1.867 kalberla 5658: color:$font;
5659: font-size:90%;
5660: }
5661:
5662: div.LC_feedback_link div.LC_comblock {
5663: padding-left:5px;
5664: }
5665:
5666: div.LC_feedback_link div.LC_comblock a {
5667: color:$font;
5668: }
5669:
1.489 raeburn 5670: span.LC_feedback_link {
1.858 bisitz 5671: /* background: $feedback_link_bg; */
1.599 albertel 5672: font-size: larger;
5673: }
1.795 www 5674:
1.599 albertel 5675: span.LC_message_link {
1.858 bisitz 5676: /* background: $feedback_link_bg; */
1.599 albertel 5677: font-size: larger;
5678: position: absolute;
5679: right: 1em;
1.489 raeburn 5680: }
1.421 albertel 5681:
1.515 albertel 5682: table.LC_prior_tries {
1.524 albertel 5683: border: 1px solid #000000;
5684: border-collapse: separate;
5685: border-spacing: 1px;
1.515 albertel 5686: }
1.523 albertel 5687:
1.515 albertel 5688: table.LC_prior_tries td {
1.524 albertel 5689: padding: 2px;
1.515 albertel 5690: }
1.523 albertel 5691:
5692: .LC_answer_correct {
1.795 www 5693: background: lightgreen;
5694: color: darkgreen;
5695: padding: 6px;
1.523 albertel 5696: }
1.795 www 5697:
1.523 albertel 5698: .LC_answer_charged_try {
1.797 www 5699: background: #FFAAAA;
1.795 www 5700: color: darkred;
5701: padding: 6px;
1.523 albertel 5702: }
1.795 www 5703:
1.779 bisitz 5704: .LC_answer_not_charged_try,
1.523 albertel 5705: .LC_answer_no_grade,
5706: .LC_answer_late {
1.795 www 5707: background: lightyellow;
1.523 albertel 5708: color: black;
1.795 www 5709: padding: 6px;
1.523 albertel 5710: }
1.795 www 5711:
1.523 albertel 5712: .LC_answer_previous {
1.795 www 5713: background: lightblue;
5714: color: darkblue;
5715: padding: 6px;
1.523 albertel 5716: }
1.795 www 5717:
1.779 bisitz 5718: .LC_answer_no_message {
1.777 tempelho 5719: background: #FFFFFF;
5720: color: black;
1.795 www 5721: padding: 6px;
1.779 bisitz 5722: }
1.795 www 5723:
1.779 bisitz 5724: .LC_answer_unknown {
5725: background: orange;
5726: color: black;
1.795 www 5727: padding: 6px;
1.777 tempelho 5728: }
1.795 www 5729:
1.529 albertel 5730: span.LC_prior_numerical,
5731: span.LC_prior_string,
5732: span.LC_prior_custom,
5733: span.LC_prior_reaction,
5734: span.LC_prior_math {
1.925 bisitz 5735: font-family: $mono;
1.523 albertel 5736: white-space: pre;
5737: }
5738:
1.525 albertel 5739: span.LC_prior_string {
1.925 bisitz 5740: font-family: $mono;
1.525 albertel 5741: white-space: pre;
5742: }
5743:
1.523 albertel 5744: table.LC_prior_option {
5745: width: 100%;
5746: border-collapse: collapse;
5747: }
1.795 www 5748:
1.911 bisitz 5749: table.LC_prior_rank,
1.795 www 5750: table.LC_prior_match {
1.528 albertel 5751: border-collapse: collapse;
5752: }
1.795 www 5753:
1.528 albertel 5754: table.LC_prior_option tr td,
5755: table.LC_prior_rank tr td,
5756: table.LC_prior_match tr td {
1.524 albertel 5757: border: 1px solid #000000;
1.515 albertel 5758: }
5759:
1.855 bisitz 5760: .LC_nobreak {
1.544 albertel 5761: white-space: nowrap;
1.519 raeburn 5762: }
5763:
1.576 raeburn 5764: span.LC_cusr_emph {
5765: font-style: italic;
5766: }
5767:
1.633 raeburn 5768: span.LC_cusr_subheading {
5769: font-weight: normal;
5770: font-size: 85%;
5771: }
5772:
1.861 bisitz 5773: div.LC_docs_entry_move {
1.859 bisitz 5774: border: 1px solid #BBBBBB;
1.545 albertel 5775: background: #DDDDDD;
1.861 bisitz 5776: width: 22px;
1.859 bisitz 5777: padding: 1px;
5778: margin: 0;
1.545 albertel 5779: }
5780:
1.861 bisitz 5781: table.LC_data_table tr > td.LC_docs_entry_commands,
5782: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 5783: background: #DDDDDD;
5784: font-size: x-small;
5785: }
1.795 www 5786:
1.861 bisitz 5787: .LC_docs_entry_parameter {
5788: white-space: nowrap;
5789: }
5790:
1.544 albertel 5791: .LC_docs_copy {
1.545 albertel 5792: color: #000099;
1.544 albertel 5793: }
1.795 www 5794:
1.544 albertel 5795: .LC_docs_cut {
1.545 albertel 5796: color: #550044;
1.544 albertel 5797: }
1.795 www 5798:
1.544 albertel 5799: .LC_docs_rename {
1.545 albertel 5800: color: #009900;
1.544 albertel 5801: }
1.795 www 5802:
1.544 albertel 5803: .LC_docs_remove {
1.545 albertel 5804: color: #990000;
5805: }
5806:
1.547 albertel 5807: .LC_docs_reinit_warn,
5808: .LC_docs_ext_edit {
5809: font-size: x-small;
5810: }
5811:
1.545 albertel 5812: table.LC_docs_adddocs td,
5813: table.LC_docs_adddocs th {
5814: border: 1px solid #BBBBBB;
5815: padding: 4px;
5816: background: #DDDDDD;
1.543 albertel 5817: }
5818:
1.584 albertel 5819: table.LC_sty_begin {
5820: background: #BBFFBB;
5821: }
1.795 www 5822:
1.584 albertel 5823: table.LC_sty_end {
5824: background: #FFBBBB;
5825: }
5826:
1.589 raeburn 5827: table.LC_double_column {
1.803 bisitz 5828: border-width: 0;
1.589 raeburn 5829: border-collapse: collapse;
5830: width: 100%;
5831: padding: 2px;
5832: }
5833:
5834: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5835: top: 2px;
1.589 raeburn 5836: left: 2px;
5837: width: 47%;
5838: vertical-align: top;
5839: }
5840:
5841: table.LC_double_column tr td.LC_right_col {
5842: top: 2px;
1.779 bisitz 5843: right: 2px;
1.589 raeburn 5844: width: 47%;
5845: vertical-align: top;
5846: }
5847:
1.591 raeburn 5848: div.LC_left_float {
5849: float: left;
5850: padding-right: 5%;
1.597 albertel 5851: padding-bottom: 4px;
1.591 raeburn 5852: }
5853:
5854: div.LC_clear_float_header {
1.597 albertel 5855: padding-bottom: 2px;
1.591 raeburn 5856: }
5857:
5858: div.LC_clear_float_footer {
1.597 albertel 5859: padding-top: 10px;
1.591 raeburn 5860: clear: both;
5861: }
5862:
1.597 albertel 5863: div.LC_grade_show_user {
1.941 bisitz 5864: /* border-left: 5px solid $sidebg; */
5865: border-top: 5px solid #000000;
5866: margin: 50px 0 0 0;
1.936 bisitz 5867: padding: 15px 0 5px 10px;
1.597 albertel 5868: }
1.795 www 5869:
1.936 bisitz 5870: div.LC_grade_show_user_odd_row {
1.941 bisitz 5871: /* border-left: 5px solid #000000; */
5872: }
5873:
5874: div.LC_grade_show_user div.LC_Box {
5875: margin-right: 50px;
1.597 albertel 5876: }
5877:
5878: div.LC_grade_submissions,
5879: div.LC_grade_message_center,
1.936 bisitz 5880: div.LC_grade_info_links {
1.597 albertel 5881: margin: 5px;
5882: width: 99%;
5883: background: #FFFFFF;
5884: }
1.795 www 5885:
1.597 albertel 5886: div.LC_grade_submissions_header,
1.936 bisitz 5887: div.LC_grade_message_center_header {
1.705 tempelho 5888: font-weight: bold;
5889: font-size: large;
1.597 albertel 5890: }
1.795 www 5891:
1.597 albertel 5892: div.LC_grade_submissions_body,
1.936 bisitz 5893: div.LC_grade_message_center_body {
1.597 albertel 5894: border: 1px solid black;
5895: width: 99%;
5896: background: #FFFFFF;
5897: }
1.795 www 5898:
1.613 albertel 5899: table.LC_scantron_action {
5900: width: 100%;
5901: }
1.795 www 5902:
1.613 albertel 5903: table.LC_scantron_action tr th {
1.698 harmsja 5904: font-weight:bold;
5905: font-style:normal;
1.613 albertel 5906: }
1.795 www 5907:
1.779 bisitz 5908: .LC_edit_problem_header,
1.614 albertel 5909: div.LC_edit_problem_footer {
1.705 tempelho 5910: font-weight: normal;
5911: font-size: medium;
1.602 albertel 5912: margin: 2px;
1.600 albertel 5913: }
1.795 www 5914:
1.600 albertel 5915: div.LC_edit_problem_header,
1.602 albertel 5916: div.LC_edit_problem_header div,
1.614 albertel 5917: div.LC_edit_problem_footer,
5918: div.LC_edit_problem_footer div,
1.602 albertel 5919: div.LC_edit_problem_editxml_header,
5920: div.LC_edit_problem_editxml_header div {
1.600 albertel 5921: margin-top: 5px;
5922: }
1.795 www 5923:
1.600 albertel 5924: div.LC_edit_problem_header_title {
1.705 tempelho 5925: font-weight: bold;
5926: font-size: larger;
1.602 albertel 5927: background: $tabbg;
5928: padding: 3px;
5929: }
1.795 www 5930:
1.602 albertel 5931: table.LC_edit_problem_header_title {
5932: width: 100%;
1.600 albertel 5933: background: $tabbg;
1.602 albertel 5934: }
5935:
5936: div.LC_edit_problem_discards {
5937: float: left;
5938: padding-bottom: 5px;
5939: }
1.795 www 5940:
1.602 albertel 5941: div.LC_edit_problem_saves {
5942: float: right;
5943: padding-bottom: 5px;
1.600 albertel 5944: }
1.795 www 5945:
1.911 bisitz 5946: img.stift {
1.803 bisitz 5947: border-width: 0;
5948: vertical-align: middle;
1.677 riegler 5949: }
1.680 riegler 5950:
1.923 bisitz 5951: table td.LC_mainmenu_col_fieldset {
1.680 riegler 5952: vertical-align: top;
1.777 tempelho 5953: }
1.795 www 5954:
1.716 raeburn 5955: div.LC_createcourse {
1.911 bisitz 5956: margin: 10px 10px 10px 10px;
1.716 raeburn 5957: }
5958:
1.917 raeburn 5959: .LC_dccid {
5960: margin: 0.2em 0 0 0;
5961: padding: 0;
5962: font-size: 90%;
5963: display:none;
5964: }
5965:
1.698 harmsja 5966: a:hover,
1.897 wenzelju 5967: ol.LC_primary_menu a:hover,
1.721 harmsja 5968: ol#LC_MenuBreadcrumbs a:hover,
5969: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 5970: ul#LC_secondary_menu a:hover,
1.721 harmsja 5971: .LC_FormSectionClearButton input:hover
1.795 www 5972: ul.LC_TabContent li:hover a {
1.952 onken 5973: color:$button_hover;
1.911 bisitz 5974: text-decoration:none;
1.693 droeschl 5975: }
5976:
1.779 bisitz 5977: h1 {
1.911 bisitz 5978: padding: 0;
5979: line-height:130%;
1.693 droeschl 5980: }
1.698 harmsja 5981:
1.911 bisitz 5982: h2,
5983: h3,
5984: h4,
5985: h5,
5986: h6 {
5987: margin: 5px 0 5px 0;
5988: padding: 0;
5989: line-height:130%;
1.693 droeschl 5990: }
1.795 www 5991:
5992: .LC_hcell {
1.911 bisitz 5993: padding:3px 15px 3px 15px;
5994: margin: 0;
5995: background-color:$tabbg;
5996: color:$fontmenu;
5997: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 5998: }
1.795 www 5999:
1.840 bisitz 6000: .LC_Box > .LC_hcell {
1.911 bisitz 6001: margin: 0 -10px 10px -10px;
1.835 bisitz 6002: }
6003:
1.721 harmsja 6004: .LC_noBorder {
1.911 bisitz 6005: border: 0;
1.698 harmsja 6006: }
1.693 droeschl 6007:
1.721 harmsja 6008: .LC_FormSectionClearButton input {
1.911 bisitz 6009: background-color:transparent;
6010: border: none;
6011: cursor:pointer;
6012: text-decoration:underline;
1.693 droeschl 6013: }
1.763 bisitz 6014:
6015: .LC_help_open_topic {
1.911 bisitz 6016: color: #FFFFFF;
6017: background-color: #EEEEFF;
6018: margin: 1px;
6019: padding: 4px;
6020: border: 1px solid #000033;
6021: white-space: nowrap;
6022: /* vertical-align: middle; */
1.759 neumanie 6023: }
1.693 droeschl 6024:
1.911 bisitz 6025: dl,
6026: ul,
6027: div,
6028: fieldset {
6029: margin: 10px 10px 10px 0;
6030: /* overflow: hidden; */
1.693 droeschl 6031: }
1.795 www 6032:
1.838 bisitz 6033: fieldset > legend {
1.911 bisitz 6034: font-weight: bold;
6035: padding: 0 5px 0 5px;
1.838 bisitz 6036: }
6037:
1.813 bisitz 6038: #LC_nav_bar {
1.911 bisitz 6039: float: left;
1.966 bisitz 6040: margin: 0 0 2px 0;
1.807 droeschl 6041: }
6042:
1.916 droeschl 6043: #LC_realm {
6044: margin: 0.2em 0 0 0;
6045: padding: 0;
6046: font-weight: bold;
6047: text-align: center;
6048: }
6049:
1.911 bisitz 6050: #LC_nav_bar em {
6051: font-weight: bold;
6052: font-style: normal;
1.807 droeschl 6053: }
6054:
1.897 wenzelju 6055: ol.LC_primary_menu {
1.911 bisitz 6056: float: right;
1.934 droeschl 6057: margin: 0;
1.807 droeschl 6058: }
6059:
1.852 droeschl 6060: ol#LC_PathBreadcrumbs {
1.911 bisitz 6061: margin: 0;
1.693 droeschl 6062: }
6063:
1.897 wenzelju 6064: ol.LC_primary_menu li {
1.911 bisitz 6065: display: inline;
6066: padding: 5px 5px 0 10px;
6067: vertical-align: top;
1.693 droeschl 6068: }
6069:
1.897 wenzelju 6070: ol.LC_primary_menu li img {
1.911 bisitz 6071: vertical-align: bottom;
1.934 droeschl 6072: height: 1.1em;
1.693 droeschl 6073: }
6074:
1.897 wenzelju 6075: ol.LC_primary_menu a {
1.911 bisitz 6076: color: RGB(80, 80, 80);
6077: text-decoration: none;
1.693 droeschl 6078: }
1.795 www 6079:
1.949 droeschl 6080: ol.LC_primary_menu a.LC_new_message {
6081: font-weight:bold;
6082: color: darkred;
6083: }
6084:
1.975 raeburn 6085: ol.LC_docs_parameters {
6086: margin-left: 0;
6087: padding: 0;
6088: list-style: none;
6089: }
6090:
6091: ol.LC_docs_parameters li {
6092: margin: 0;
6093: padding-right: 20px;
6094: display: inline;
6095: }
6096:
1.976 raeburn 6097: ol.LC_docs_parameters li:before {
6098: content: "\\002022 \\0020";
6099: }
6100:
6101: li.LC_docs_parameters_title {
6102: font-weight: bold;
6103: }
6104:
6105: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
6106: content: "";
6107: }
6108:
1.897 wenzelju 6109: ul#LC_secondary_menu {
1.911 bisitz 6110: clear: both;
6111: color: $fontmenu;
6112: background: $tabbg;
6113: list-style: none;
6114: padding: 0;
6115: margin: 0;
6116: width: 100%;
1.808 droeschl 6117: }
6118:
1.897 wenzelju 6119: ul#LC_secondary_menu li {
1.911 bisitz 6120: font-weight: bold;
6121: line-height: 1.8em;
6122: padding: 0 0.8em;
6123: border-right: 1px solid black;
6124: display: inline;
6125: vertical-align: middle;
1.807 droeschl 6126: }
6127:
1.847 tempelho 6128: ul.LC_TabContent {
1.911 bisitz 6129: display:block;
6130: background: $sidebg;
6131: border-bottom: solid 1px $lg_border_color;
6132: list-style:none;
6133: margin: 0 -10px;
6134: padding: 0;
1.693 droeschl 6135: }
6136:
1.795 www 6137: ul.LC_TabContent li,
6138: ul.LC_TabContentBigger li {
1.911 bisitz 6139: float:left;
1.741 harmsja 6140: }
1.795 www 6141:
1.897 wenzelju 6142: ul#LC_secondary_menu li a {
1.911 bisitz 6143: color: $fontmenu;
6144: text-decoration: none;
1.693 droeschl 6145: }
1.795 www 6146:
1.721 harmsja 6147: ul.LC_TabContent {
1.952 onken 6148: min-height:20px;
1.721 harmsja 6149: }
1.795 www 6150:
6151: ul.LC_TabContent li {
1.911 bisitz 6152: vertical-align:middle;
1.959 onken 6153: padding: 0 16px 0 10px;
1.911 bisitz 6154: background-color:$tabbg;
6155: border-bottom:solid 1px $lg_border_color;
1.952 onken 6156: border-right: solid 1px $font;
1.721 harmsja 6157: }
1.795 www 6158:
1.847 tempelho 6159: ul.LC_TabContent .right {
1.911 bisitz 6160: float:right;
1.847 tempelho 6161: }
6162:
1.911 bisitz 6163: ul.LC_TabContent li a,
6164: ul.LC_TabContent li {
6165: color:rgb(47,47,47);
6166: text-decoration:none;
6167: font-size:95%;
6168: font-weight:bold;
1.952 onken 6169: min-height:20px;
6170: }
6171:
1.959 onken 6172: ul.LC_TabContent li a:hover,
6173: ul.LC_TabContent li a:focus {
1.952 onken 6174: color: $button_hover;
1.959 onken 6175: background:none;
6176: outline:none;
1.952 onken 6177: }
6178:
6179: ul.LC_TabContent li:hover {
6180: color: $button_hover;
6181: cursor:pointer;
1.721 harmsja 6182: }
1.795 www 6183:
1.911 bisitz 6184: ul.LC_TabContent li.active {
1.952 onken 6185: color: $font;
1.911 bisitz 6186: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 6187: border-bottom:solid 1px #FFFFFF;
6188: cursor: default;
1.744 ehlerst 6189: }
1.795 www 6190:
1.959 onken 6191: ul.LC_TabContent li.active a {
6192: color:$font;
6193: background:#FFFFFF;
6194: outline: none;
6195: }
1.870 tempelho 6196: #maincoursedoc {
1.911 bisitz 6197: clear:both;
1.870 tempelho 6198: }
6199:
6200: ul.LC_TabContentBigger {
1.911 bisitz 6201: display:block;
6202: list-style:none;
6203: padding: 0;
1.870 tempelho 6204: }
6205:
1.795 www 6206: ul.LC_TabContentBigger li {
1.911 bisitz 6207: vertical-align:bottom;
6208: height: 30px;
6209: font-size:110%;
6210: font-weight:bold;
6211: color: #737373;
1.841 tempelho 6212: }
6213:
1.957 onken 6214: ul.LC_TabContentBigger li.active {
6215: position: relative;
6216: top: 1px;
6217: }
6218:
1.870 tempelho 6219: ul.LC_TabContentBigger li a {
1.911 bisitz 6220: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6221: height: 30px;
6222: line-height: 30px;
6223: text-align: center;
6224: display: block;
6225: text-decoration: none;
1.958 onken 6226: outline: none;
1.741 harmsja 6227: }
1.795 www 6228:
1.870 tempelho 6229: ul.LC_TabContentBigger li.active a {
1.911 bisitz 6230: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6231: color:$font;
1.744 ehlerst 6232: }
1.795 www 6233:
1.870 tempelho 6234: ul.LC_TabContentBigger li b {
1.911 bisitz 6235: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
6236: display: block;
6237: float: left;
6238: padding: 0 30px;
1.957 onken 6239: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 6240: }
6241:
1.956 onken 6242: ul.LC_TabContentBigger li:hover b {
6243: color:$button_hover;
6244: }
6245:
1.870 tempelho 6246: ul.LC_TabContentBigger li.active b {
1.911 bisitz 6247: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
6248: color:$font;
1.957 onken 6249: border: 0;
1.956 onken 6250: cursor:default;
1.741 harmsja 6251: }
1.693 droeschl 6252:
1.870 tempelho 6253:
1.862 bisitz 6254: ul.LC_CourseBreadcrumbs {
6255: background: $sidebg;
6256: line-height: 32px;
6257: padding-left: 10px;
6258: margin: 0 0 10px 0;
6259: list-style-position: inside;
6260:
6261: }
6262:
1.911 bisitz 6263: ol#LC_MenuBreadcrumbs,
1.862 bisitz 6264: ol#LC_PathBreadcrumbs {
1.911 bisitz 6265: padding-left: 10px;
6266: margin: 0;
1.933 droeschl 6267: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 6268: }
6269:
1.911 bisitz 6270: ol#LC_MenuBreadcrumbs li,
6271: ol#LC_PathBreadcrumbs li,
1.862 bisitz 6272: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 6273: display: inline;
1.933 droeschl 6274: white-space: normal;
1.693 droeschl 6275: }
6276:
1.823 bisitz 6277: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 6278: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 6279: text-decoration: none;
6280: font-size:90%;
1.693 droeschl 6281: }
1.795 www 6282:
1.969 droeschl 6283: ol#LC_MenuBreadcrumbs h1 {
6284: display: inline;
6285: font-size: 90%;
6286: line-height: 2.5em;
6287: margin: 0;
6288: padding: 0;
6289: }
6290:
1.795 www 6291: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 6292: text-decoration:none;
6293: font-size:100%;
6294: font-weight:bold;
1.693 droeschl 6295: }
1.795 www 6296:
1.840 bisitz 6297: .LC_Box {
1.911 bisitz 6298: border: solid 1px $lg_border_color;
6299: padding: 0 10px 10px 10px;
1.746 neumanie 6300: }
1.795 www 6301:
6302: .LC_AboutMe_Image {
1.911 bisitz 6303: float:left;
6304: margin-right:10px;
1.747 neumanie 6305: }
1.795 www 6306:
6307: .LC_Clear_AboutMe_Image {
1.911 bisitz 6308: clear:left;
1.747 neumanie 6309: }
1.795 www 6310:
1.721 harmsja 6311: dl.LC_ListStyleClean dt {
1.911 bisitz 6312: padding-right: 5px;
6313: display: table-header-group;
1.693 droeschl 6314: }
6315:
1.721 harmsja 6316: dl.LC_ListStyleClean dd {
1.911 bisitz 6317: display: table-row;
1.693 droeschl 6318: }
6319:
1.721 harmsja 6320: .LC_ListStyleClean,
6321: .LC_ListStyleSimple,
6322: .LC_ListStyleNormal,
1.795 www 6323: .LC_ListStyleSpecial {
1.911 bisitz 6324: /* display:block; */
6325: list-style-position: inside;
6326: list-style-type: none;
6327: overflow: hidden;
6328: padding: 0;
1.693 droeschl 6329: }
6330:
1.721 harmsja 6331: .LC_ListStyleSimple li,
6332: .LC_ListStyleSimple dd,
6333: .LC_ListStyleNormal li,
6334: .LC_ListStyleNormal dd,
6335: .LC_ListStyleSpecial li,
1.795 www 6336: .LC_ListStyleSpecial dd {
1.911 bisitz 6337: margin: 0;
6338: padding: 5px 5px 5px 10px;
6339: clear: both;
1.693 droeschl 6340: }
6341:
1.721 harmsja 6342: .LC_ListStyleClean li,
6343: .LC_ListStyleClean dd {
1.911 bisitz 6344: padding-top: 0;
6345: padding-bottom: 0;
1.693 droeschl 6346: }
6347:
1.721 harmsja 6348: .LC_ListStyleSimple dd,
1.795 www 6349: .LC_ListStyleSimple li {
1.911 bisitz 6350: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6351: }
6352:
1.721 harmsja 6353: .LC_ListStyleSpecial li,
6354: .LC_ListStyleSpecial dd {
1.911 bisitz 6355: list-style-type: none;
6356: background-color: RGB(220, 220, 220);
6357: margin-bottom: 4px;
1.693 droeschl 6358: }
6359:
1.721 harmsja 6360: table.LC_SimpleTable {
1.911 bisitz 6361: margin:5px;
6362: border:solid 1px $lg_border_color;
1.795 www 6363: }
1.693 droeschl 6364:
1.721 harmsja 6365: table.LC_SimpleTable tr {
1.911 bisitz 6366: padding: 0;
6367: border:solid 1px $lg_border_color;
1.693 droeschl 6368: }
1.795 www 6369:
6370: table.LC_SimpleTable thead {
1.911 bisitz 6371: background:rgb(220,220,220);
1.693 droeschl 6372: }
6373:
1.721 harmsja 6374: div.LC_columnSection {
1.911 bisitz 6375: display: block;
6376: clear: both;
6377: overflow: hidden;
6378: margin: 0;
1.693 droeschl 6379: }
6380:
1.721 harmsja 6381: div.LC_columnSection>* {
1.911 bisitz 6382: float: left;
6383: margin: 10px 20px 10px 0;
6384: overflow:hidden;
1.693 droeschl 6385: }
1.721 harmsja 6386:
1.795 www 6387: table em {
1.911 bisitz 6388: font-weight: bold;
6389: font-style: normal;
1.748 schulted 6390: }
1.795 www 6391:
1.779 bisitz 6392: table.LC_tableBrowseRes,
1.795 www 6393: table.LC_tableOfContent {
1.911 bisitz 6394: border:none;
6395: border-spacing: 1px;
6396: padding: 3px;
6397: background-color: #FFFFFF;
6398: font-size: 90%;
1.753 droeschl 6399: }
1.789 droeschl 6400:
1.911 bisitz 6401: table.LC_tableOfContent {
6402: border-collapse: collapse;
1.789 droeschl 6403: }
6404:
1.771 droeschl 6405: table.LC_tableBrowseRes a,
1.768 schulted 6406: table.LC_tableOfContent a {
1.911 bisitz 6407: background-color: transparent;
6408: text-decoration: none;
1.753 droeschl 6409: }
6410:
1.795 www 6411: table.LC_tableOfContent img {
1.911 bisitz 6412: border: none;
6413: height: 1.3em;
6414: vertical-align: text-bottom;
6415: margin-right: 0.3em;
1.753 droeschl 6416: }
1.757 schulted 6417:
1.795 www 6418: a#LC_content_toolbar_firsthomework {
1.911 bisitz 6419: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 6420: }
6421:
1.795 www 6422: a#LC_content_toolbar_everything {
1.911 bisitz 6423: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 6424: }
6425:
1.795 www 6426: a#LC_content_toolbar_uncompleted {
1.911 bisitz 6427: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 6428: }
6429:
1.795 www 6430: #LC_content_toolbar_clearbubbles {
1.911 bisitz 6431: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 6432: }
6433:
1.795 www 6434: a#LC_content_toolbar_changefolder {
1.911 bisitz 6435: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 6436: }
6437:
1.795 www 6438: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 6439: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 6440: }
6441:
1.795 www 6442: ul#LC_toolbar li a:hover {
1.911 bisitz 6443: background-position: bottom center;
1.757 schulted 6444: }
6445:
1.795 www 6446: ul#LC_toolbar {
1.911 bisitz 6447: padding: 0;
6448: margin: 2px;
6449: list-style:none;
6450: position:relative;
6451: background-color:white;
1.757 schulted 6452: }
6453:
1.795 www 6454: ul#LC_toolbar li {
1.911 bisitz 6455: border:1px solid white;
6456: padding: 0;
6457: margin: 0;
6458: float: left;
6459: display:inline;
6460: vertical-align:middle;
6461: }
1.757 schulted 6462:
1.783 amueller 6463:
1.795 www 6464: a.LC_toolbarItem {
1.911 bisitz 6465: display:block;
6466: padding: 0;
6467: margin: 0;
6468: height: 32px;
6469: width: 32px;
6470: color:white;
6471: border: none;
6472: background-repeat:no-repeat;
6473: background-color:transparent;
1.757 schulted 6474: }
6475:
1.915 droeschl 6476: ul.LC_funclist {
6477: margin: 0;
6478: padding: 0.5em 1em 0.5em 0;
6479: }
6480:
1.933 droeschl 6481: ul.LC_funclist > li:first-child {
6482: font-weight:bold;
6483: margin-left:0.8em;
6484: }
6485:
1.915 droeschl 6486: ul.LC_funclist + ul.LC_funclist {
6487: /*
6488: left border as a seperator if we have more than
6489: one list
6490: */
6491: border-left: 1px solid $sidebg;
6492: /*
6493: this hides the left border behind the border of the
6494: outer box if element is wrapped to the next 'line'
6495: */
6496: margin-left: -1px;
6497: }
6498:
1.843 bisitz 6499: ul.LC_funclist li {
1.915 droeschl 6500: display: inline;
1.782 bisitz 6501: white-space: nowrap;
1.915 droeschl 6502: margin: 0 0 0 25px;
6503: line-height: 150%;
1.782 bisitz 6504: }
6505:
1.930 faziophi 6506: .ui-accordion .LC_advanced_toggle {
6507: float: right;
6508: font-size: 90%;
6509: padding: 0px 4px
6510: }
1.757 schulted 6511:
1.974 wenzelju 6512: .LC_hidden {
6513: display: none;
6514: }
6515:
1.343 albertel 6516: END
6517: }
6518:
1.306 albertel 6519: =pod
6520:
6521: =item * &headtag()
6522:
6523: Returns a uniform footer for LON-CAPA web pages.
6524:
1.307 albertel 6525: Inputs: $title - optional title for the head
6526: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 6527: $args - optional arguments
1.319 albertel 6528: force_register - if is true call registerurl so the remote is
6529: informed
1.415 albertel 6530: redirect -> array ref of
6531: 1- seconds before redirect occurs
6532: 2- url to redirect to
6533: 3- whether the side effect should occur
1.315 albertel 6534: (side effect of setting
6535: $env{'internal.head.redirect'} to the url
6536: redirected too)
1.352 albertel 6537: domain -> force to color decorate a page for a specific
6538: domain
6539: function -> force usage of a specific rolish color scheme
6540: bgcolor -> override the default page bgcolor
1.460 albertel 6541: no_auto_mt_title
6542: -> prevent &mt()ing the title arg
1.464 albertel 6543:
1.306 albertel 6544: =cut
6545:
6546: sub headtag {
1.313 albertel 6547: my ($title,$head_extra,$args) = @_;
1.306 albertel 6548:
1.363 albertel 6549: my $function = $args->{'function'} || &get_users_function();
6550: my $domain = $args->{'domain'} || &determinedomain();
6551: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 6552: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 6553: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 6554: #time(),
1.418 albertel 6555: $env{'environment.color.timestamp'},
1.363 albertel 6556: $function,$domain,$bgcolor);
6557:
1.369 www 6558: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 6559:
1.308 albertel 6560: my $result =
6561: '<head>'.
1.461 albertel 6562: &font_settings();
1.319 albertel 6563:
1.461 albertel 6564: if (!$args->{'frameset'}) {
6565: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
6566: }
1.962 droeschl 6567: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
6568: $result .= Apache::lonxml::display_title();
1.319 albertel 6569: }
1.436 albertel 6570: if (!$args->{'no_nav_bar'}
6571: && !$args->{'only_body'}
6572: && !$args->{'frameset'}) {
6573: $result .= &help_menu_js();
6574: }
1.319 albertel 6575:
1.314 albertel 6576: if (ref($args->{'redirect'})) {
1.414 albertel 6577: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 6578: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 6579: if (!$inhibit_continue) {
6580: $env{'internal.head.redirect'} = $url;
6581: }
1.313 albertel 6582: $result.=<<ADDMETA
6583: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 6584: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 6585: ADDMETA
6586: }
1.306 albertel 6587: if (!defined($title)) {
6588: $title = 'The LearningOnline Network with CAPA';
6589: }
1.460 albertel 6590: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
6591: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 6592: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
6593: .$head_extra;
1.962 droeschl 6594: return $result.'</head>';
1.306 albertel 6595: }
6596:
6597: =pod
6598:
1.340 albertel 6599: =item * &font_settings()
6600:
6601: Returns neccessary <meta> to set the proper encoding
6602:
6603: Inputs: none
6604:
6605: =cut
6606:
6607: sub font_settings {
6608: my $headerstring='';
1.647 www 6609: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 6610: $headerstring.=
6611: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
6612: }
6613: return $headerstring;
6614: }
6615:
1.341 albertel 6616: =pod
6617:
6618: =item * &xml_begin()
6619:
6620: Returns the needed doctype and <html>
6621:
6622: Inputs: none
6623:
6624: =cut
6625:
6626: sub xml_begin {
6627: my $output='';
6628:
6629: if ($env{'browser.mathml'}) {
6630: $output='<?xml version="1.0"?>'
6631: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
6632: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
6633:
6634: # .'<!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">] >'
6635: .'<!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">'
6636: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
6637: .'xmlns="http://www.w3.org/1999/xhtml">';
6638: } else {
1.849 bisitz 6639: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
6640: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341 albertel 6641: }
6642: return $output;
6643: }
1.340 albertel 6644:
6645: =pod
6646:
1.306 albertel 6647: =item * &start_page()
6648:
6649: Returns a complete <html> .. <body> section for LON-CAPA web pages.
6650:
1.648 raeburn 6651: Inputs:
6652:
6653: =over 4
6654:
6655: $title - optional title for the page
6656:
6657: $head_extra - optional extra HTML to incude inside the <head>
6658:
6659: $args - additional optional args supported are:
6660:
6661: =over 8
6662:
6663: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 6664: arg on
1.814 bisitz 6665: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 6666: add_entries -> additional attributes to add to the <body>
6667: domain -> force to color decorate a page for a
1.317 albertel 6668: specific domain
1.648 raeburn 6669: function -> force usage of a specific rolish color
1.317 albertel 6670: scheme
1.648 raeburn 6671: redirect -> see &headtag()
6672: bgcolor -> override the default page bg color
6673: js_ready -> return a string ready for being used in
1.317 albertel 6674: a javascript writeln
1.648 raeburn 6675: html_encode -> return a string ready for being used in
1.320 albertel 6676: a html attribute
1.648 raeburn 6677: force_register -> if is true will turn on the &bodytag()
1.317 albertel 6678: $forcereg arg
1.648 raeburn 6679: frameset -> if true will start with a <frameset>
1.330 albertel 6680: rather than <body>
1.648 raeburn 6681: skip_phases -> hash ref of
1.338 albertel 6682: head -> skip the <html><head> generation
6683: body -> skip all <body> generation
1.648 raeburn 6684: no_auto_mt_title -> prevent &mt()ing the title arg
6685: inherit_jsmath -> when creating popup window in a page,
6686: should it have jsmath forced on by the
6687: current page
1.867 kalberla 6688: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 6689: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.361 albertel 6690:
1.648 raeburn 6691: =back
1.460 albertel 6692:
1.648 raeburn 6693: =back
1.562 albertel 6694:
1.306 albertel 6695: =cut
6696:
6697: sub start_page {
1.309 albertel 6698: my ($title,$head_extra,$args) = @_;
1.318 albertel 6699: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.964 droeschl 6700: #SD
6701: #I don't see why we copy certain elements of %$args to %head_args
6702: #head args is passed to headtag() and this routine only reads those
6703: #keys that are needed. There doesn't happen any writes or any processing
6704: #of other keys.
6705: #proposal: just pass $args to headtag instead of \%head_args and delete
6706: #marked lines
6707: #<- MARK
1.313 albertel 6708: my %head_args;
1.352 albertel 6709: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6710: 'bgcolor','frameset','no_nav_bar','only_body',
6711: 'no_auto_mt_title') {
1.319 albertel 6712: if (defined($args->{$arg})) {
1.324 raeburn 6713: $head_args{$arg} = $args->{$arg};
1.319 albertel 6714: }
1.313 albertel 6715: }
1.964 droeschl 6716: #MARK ->
1.319 albertel 6717:
1.315 albertel 6718: $env{'internal.start_page'}++;
1.338 albertel 6719: my $result;
1.964 droeschl 6720:
1.338 albertel 6721: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.964 droeschl 6722: $result .=
6723: &xml_begin() . &headtag($title,$head_extra,\%head_args);
6724: #replace prev line by
6725: # &xml_begin() . &headtag($title, $head_extra, $args);
1.338 albertel 6726: }
6727:
6728: if (! exists($args->{'skip_phases'}{'body'}) ) {
6729: if ($args->{'frameset'}) {
6730: my $attr_string = &make_attr_string($args->{'force_register'},
6731: $args->{'add_entries'});
6732: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 6733: } else {
6734: $result .=
6735: &bodytag($title,
6736: $args->{'function'}, $args->{'add_entries'},
6737: $args->{'only_body'}, $args->{'domain'},
6738: $args->{'force_register'}, $args->{'no_nav_bar'},
1.962 droeschl 6739: $args->{'bgcolor'}, $args);
1.831 bisitz 6740: }
1.330 albertel 6741: }
1.338 albertel 6742:
1.315 albertel 6743: if ($args->{'js_ready'}) {
1.713 kaisler 6744: $result = &js_ready($result);
1.315 albertel 6745: }
1.320 albertel 6746: if ($args->{'html_encode'}) {
1.713 kaisler 6747: $result = &html_encode($result);
6748: }
6749:
1.813 bisitz 6750: # Preparation for new and consistent functionlist at top of screen
6751: # if ($args->{'functionlist'}) {
6752: # $result .= &build_functionlist();
6753: #}
6754:
1.964 droeschl 6755: # Don't add anything more if only_body wanted or in const space
6756: return $result if $args->{'only_body'}
6757: || $env{'request.state'} eq 'construct';
1.813 bisitz 6758:
6759: #Breadcrumbs
1.758 kaisler 6760: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
6761: &Apache::lonhtmlcommon::clear_breadcrumbs();
6762: #if any br links exists, add them to the breadcrumbs
6763: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6764: foreach my $crumb (@{$args->{'bread_crumbs'}}){
6765: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
6766: }
6767: }
6768:
6769: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
6770: if(exists($args->{'bread_crumbs_component'})){
6771: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
6772: }else{
6773: $result .= &Apache::lonhtmlcommon::breadcrumbs();
6774: }
1.320 albertel 6775: }
1.315 albertel 6776: return $result;
1.306 albertel 6777: }
6778:
6779: sub end_page {
1.315 albertel 6780: my ($args) = @_;
6781: $env{'internal.end_page'}++;
1.330 albertel 6782: my $result;
1.335 albertel 6783: if ($args->{'discussion'}) {
6784: my ($target,$parser);
6785: if (ref($args->{'discussion'})) {
6786: ($target,$parser) =($args->{'discussion'}{'target'},
6787: $args->{'discussion'}{'parser'});
6788: }
6789: $result .= &Apache::lonxml::xmlend($target,$parser);
6790: }
6791:
1.330 albertel 6792: if ($args->{'frameset'}) {
6793: $result .= '</frameset>';
6794: } else {
1.635 raeburn 6795: $result .= &endbodytag($args);
1.330 albertel 6796: }
6797: $result .= "\n</html>";
6798:
1.315 albertel 6799: if ($args->{'js_ready'}) {
1.317 albertel 6800: $result = &js_ready($result);
1.315 albertel 6801: }
1.335 albertel 6802:
1.320 albertel 6803: if ($args->{'html_encode'}) {
6804: $result = &html_encode($result);
6805: }
1.335 albertel 6806:
1.315 albertel 6807: return $result;
6808: }
6809:
1.320 albertel 6810: sub html_encode {
6811: my ($result) = @_;
6812:
1.322 albertel 6813: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6814:
6815: return $result;
6816: }
1.317 albertel 6817: sub js_ready {
6818: my ($result) = @_;
6819:
1.323 albertel 6820: $result =~ s/[\n\r]/ /xmsg;
6821: $result =~ s/\\/\\\\/xmsg;
6822: $result =~ s/'/\\'/xmsg;
1.372 albertel 6823: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6824:
6825: return $result;
6826: }
6827:
1.315 albertel 6828: sub validate_page {
6829: if ( exists($env{'internal.start_page'})
1.316 albertel 6830: && $env{'internal.start_page'} > 1) {
6831: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6832: $env{'internal.start_page'}.' '.
1.316 albertel 6833: $ENV{'request.filename'});
1.315 albertel 6834: }
6835: if ( exists($env{'internal.end_page'})
1.316 albertel 6836: && $env{'internal.end_page'} > 1) {
6837: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6838: $env{'internal.end_page'}.' '.
1.316 albertel 6839: $env{'request.filename'});
1.315 albertel 6840: }
6841: if ( exists($env{'internal.start_page'})
6842: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6843: &Apache::lonnet::logthis('start_page called without end_page '.
6844: $env{'request.filename'});
1.315 albertel 6845: }
6846: if ( ! exists($env{'internal.start_page'})
6847: && exists($env{'internal.end_page'})) {
1.316 albertel 6848: &Apache::lonnet::logthis('end_page called without start_page'.
6849: $env{'request.filename'});
1.315 albertel 6850: }
1.306 albertel 6851: }
1.315 albertel 6852:
1.318 albertel 6853: sub simple_error_page {
6854: my ($r,$title,$msg) = @_;
6855: my $page =
6856: &Apache::loncommon::start_page($title).
6857: &mt($msg).
6858: &Apache::loncommon::end_page();
6859: if (ref($r)) {
6860: $r->print($page);
1.327 albertel 6861: return;
1.318 albertel 6862: }
6863: return $page;
6864: }
1.347 albertel 6865:
6866: {
1.610 albertel 6867: my @row_count;
1.961 onken 6868:
6869: sub start_data_table_count {
6870: unshift(@row_count, 0);
6871: return;
6872: }
6873:
6874: sub end_data_table_count {
6875: shift(@row_count);
6876: return;
6877: }
6878:
1.347 albertel 6879: sub start_data_table {
1.422 albertel 6880: my ($add_class) = @_;
6881: my $css_class = (join(' ','LC_data_table',$add_class));
1.961 onken 6882: &start_data_table_count();
1.422 albertel 6883: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 6884: }
6885:
6886: sub end_data_table {
1.961 onken 6887: &end_data_table_count();
1.389 albertel 6888: return '</table>'."\n";;
1.347 albertel 6889: }
6890:
6891: sub start_data_table_row {
1.974 wenzelju 6892: my ($add_class, $id) = @_;
1.610 albertel 6893: $row_count[0]++;
6894: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 6895: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 6896: $id = (' id="'.$id.'"') unless ($id eq '');
6897: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 6898: }
1.471 banghart 6899:
6900: sub continue_data_table_row {
1.974 wenzelju 6901: my ($add_class, $id) = @_;
1.610 albertel 6902: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 6903: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
6904: $id = (' id="'.$id.'"') unless ($id eq '');
6905: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 6906: }
1.347 albertel 6907:
6908: sub end_data_table_row {
1.389 albertel 6909: return '</tr>'."\n";;
1.347 albertel 6910: }
1.367 www 6911:
1.421 albertel 6912: sub start_data_table_empty_row {
1.707 bisitz 6913: # $row_count[0]++;
1.421 albertel 6914: return '<tr class="LC_empty_row" >'."\n";;
6915: }
6916:
6917: sub end_data_table_empty_row {
6918: return '</tr>'."\n";;
6919: }
6920:
1.367 www 6921: sub start_data_table_header_row {
1.389 albertel 6922: return '<tr class="LC_header_row">'."\n";;
1.367 www 6923: }
6924:
6925: sub end_data_table_header_row {
1.389 albertel 6926: return '</tr>'."\n";;
1.367 www 6927: }
1.890 droeschl 6928:
6929: sub data_table_caption {
6930: my $caption = shift;
6931: return "<caption class=\"LC_caption\">$caption</caption>";
6932: }
1.347 albertel 6933: }
6934:
1.548 albertel 6935: =pod
6936:
6937: =item * &inhibit_menu_check($arg)
6938:
6939: Checks for a inhibitmenu state and generates output to preserve it
6940:
6941: Inputs: $arg - can be any of
6942: - undef - in which case the return value is a string
6943: to add into arguments list of a uri
6944: - 'input' - in which case the return value is a HTML
6945: <form> <input> field of type hidden to
6946: preserve the value
6947: - a url - in which case the return value is the url with
6948: the neccesary cgi args added to preserve the
6949: inhibitmenu state
6950: - a ref to a url - no return value, but the string is
6951: updated to include the neccessary cgi
6952: args to preserve the inhibitmenu state
6953:
6954: =cut
6955:
6956: sub inhibit_menu_check {
6957: my ($arg) = @_;
6958: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6959: if ($arg eq 'input') {
6960: if ($env{'form.inhibitmenu'}) {
6961: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
6962: } else {
6963: return
6964: }
6965: }
6966: if ($env{'form.inhibitmenu'}) {
6967: if (ref($arg)) {
6968: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6969: } elsif ($arg eq '') {
6970: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
6971: } else {
6972: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6973: }
6974: }
6975: if (!ref($arg)) {
6976: return $arg;
6977: }
6978: }
6979:
1.251 albertel 6980: ###############################################
1.182 matthew 6981:
6982: =pod
6983:
1.549 albertel 6984: =back
6985:
6986: =head1 User Information Routines
6987:
6988: =over 4
6989:
1.405 albertel 6990: =item * &get_users_function()
1.182 matthew 6991:
6992: Used by &bodytag to determine the current users primary role.
6993: Returns either 'student','coordinator','admin', or 'author'.
6994:
6995: =cut
6996:
6997: ###############################################
6998: sub get_users_function {
1.815 tempelho 6999: my $function = 'norole';
1.818 tempelho 7000: if ($env{'request.role'}=~/^(st)/) {
7001: $function='student';
7002: }
1.907 raeburn 7003: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 7004: $function='coordinator';
7005: }
1.258 albertel 7006: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 7007: $function='admin';
7008: }
1.826 bisitz 7009: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182 matthew 7010: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
7011: $function='author';
7012: }
7013: return $function;
1.54 www 7014: }
1.99 www 7015:
7016: ###############################################
7017:
1.233 raeburn 7018: =pod
7019:
1.821 raeburn 7020: =item * &show_course()
7021:
7022: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
7023: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
7024:
7025: Inputs:
7026: None
7027:
7028: Outputs:
7029: Scalar: 1 if 'Course' to be used, 0 otherwise.
7030:
7031: =cut
7032:
7033: ###############################################
7034: sub show_course {
7035: my $course = !$env{'user.adv'};
7036: if (!$env{'user.adv'}) {
7037: foreach my $env (keys(%env)) {
7038: next if ($env !~ m/^user\.priv\./);
7039: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
7040: $course = 0;
7041: last;
7042: }
7043: }
7044: }
7045: return $course;
7046: }
7047:
7048: ###############################################
7049:
7050: =pod
7051:
1.542 raeburn 7052: =item * &check_user_status()
1.274 raeburn 7053:
7054: Determines current status of supplied role for a
7055: specific user. Roles can be active, previous or future.
7056:
7057: Inputs:
7058: user's domain, user's username, course's domain,
1.375 raeburn 7059: course's number, optional section ID.
1.274 raeburn 7060:
7061: Outputs:
7062: role status: active, previous or future.
7063:
7064: =cut
7065:
7066: sub check_user_status {
1.412 raeburn 7067: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.982 raeburn 7068: my $extra = &Apache::lonnet::freeze_escape({'skipcheck' => 1});
7069: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname,'.',undef,$extra);
1.274 raeburn 7070: my @uroles = keys %userinfo;
7071: my $srchstr;
7072: my $active_chk = 'none';
1.412 raeburn 7073: my $now = time;
1.274 raeburn 7074: if (@uroles > 0) {
1.908 raeburn 7075: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 7076: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
7077: } else {
1.412 raeburn 7078: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
7079: }
7080: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 7081: my $role_end = 0;
7082: my $role_start = 0;
7083: $active_chk = 'active';
1.412 raeburn 7084: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
7085: $role_end = $1;
7086: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
7087: $role_start = $1;
1.274 raeburn 7088: }
7089: }
7090: if ($role_start > 0) {
1.412 raeburn 7091: if ($now < $role_start) {
1.274 raeburn 7092: $active_chk = 'future';
7093: }
7094: }
7095: if ($role_end > 0) {
1.412 raeburn 7096: if ($now > $role_end) {
1.274 raeburn 7097: $active_chk = 'previous';
7098: }
7099: }
7100: }
7101: }
7102: return $active_chk;
7103: }
7104:
7105: ###############################################
7106:
7107: =pod
7108:
1.405 albertel 7109: =item * &get_sections()
1.233 raeburn 7110:
7111: Determines all the sections for a course including
7112: sections with students and sections containing other roles.
1.419 raeburn 7113: Incoming parameters:
7114:
7115: 1. domain
7116: 2. course number
7117: 3. reference to array containing roles for which sections should
7118: be gathered (optional).
7119: 4. reference to array containing status types for which sections
7120: should be gathered (optional).
7121:
7122: If the third argument is undefined, sections are gathered for any role.
7123: If the fourth argument is undefined, sections are gathered for any status.
7124: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 7125:
1.374 raeburn 7126: Returns section hash (keys are section IDs, values are
7127: number of users in each section), subject to the
1.419 raeburn 7128: optional roles filter, optional status filter
1.233 raeburn 7129:
7130: =cut
7131:
7132: ###############################################
7133: sub get_sections {
1.419 raeburn 7134: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 7135: if (!defined($cdom) || !defined($cnum)) {
7136: my $cid = $env{'request.course.id'};
7137:
7138: return if (!defined($cid));
7139:
7140: $cdom = $env{'course.'.$cid.'.domain'};
7141: $cnum = $env{'course.'.$cid.'.num'};
7142: }
7143:
7144: my %sectioncount;
1.419 raeburn 7145: my $now = time;
1.240 albertel 7146:
1.366 albertel 7147: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 7148: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 7149: my $sec_index = &Apache::loncoursedata::CL_SECTION();
7150: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 7151: my $start_index = &Apache::loncoursedata::CL_START();
7152: my $end_index = &Apache::loncoursedata::CL_END();
7153: my $status;
1.366 albertel 7154: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 7155: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
7156: $data->[$status_index],
7157: $data->[$start_index],
7158: $data->[$end_index]);
7159: if ($stu_status eq 'Active') {
7160: $status = 'active';
7161: } elsif ($end < $now) {
7162: $status = 'previous';
7163: } elsif ($start > $now) {
7164: $status = 'future';
7165: }
7166: if ($section ne '-1' && $section !~ /^\s*$/) {
7167: if ((!defined($possible_status)) || (($status ne '') &&
7168: (grep/^\Q$status\E$/,@{$possible_status}))) {
7169: $sectioncount{$section}++;
7170: }
1.240 albertel 7171: }
7172: }
7173: }
7174: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7175: foreach my $user (sort(keys(%courseroles))) {
7176: if ($user !~ /^(\w{2})/) { next; }
7177: my ($role) = ($user =~ /^(\w{2})/);
7178: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 7179: my ($section,$status);
1.240 albertel 7180: if ($role eq 'cr' &&
7181: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
7182: $section=$1;
7183: }
7184: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
7185: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 7186: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
7187: if ($end == -1 && $start == -1) {
7188: next; #deleted role
7189: }
7190: if (!defined($possible_status)) {
7191: $sectioncount{$section}++;
7192: } else {
7193: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
7194: $status = 'active';
7195: } elsif ($end < $now) {
7196: $status = 'future';
7197: } elsif ($start > $now) {
7198: $status = 'previous';
7199: }
7200: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
7201: $sectioncount{$section}++;
7202: }
7203: }
1.233 raeburn 7204: }
1.366 albertel 7205: return %sectioncount;
1.233 raeburn 7206: }
7207:
1.274 raeburn 7208: ###############################################
1.294 raeburn 7209:
7210: =pod
1.405 albertel 7211:
7212: =item * &get_course_users()
7213:
1.275 raeburn 7214: Retrieves usernames:domains for users in the specified course
7215: with specific role(s), and access status.
7216:
7217: Incoming parameters:
1.277 albertel 7218: 1. course domain
7219: 2. course number
7220: 3. access status: users must have - either active,
1.275 raeburn 7221: previous, future, or all.
1.277 albertel 7222: 4. reference to array of permissible roles
1.288 raeburn 7223: 5. reference to array of section restrictions (optional)
7224: 6. reference to results object (hash of hashes).
7225: 7. reference to optional userdata hash
1.609 raeburn 7226: 8. reference to optional statushash
1.630 raeburn 7227: 9. flag if privileged users (except those set to unhide in
7228: course settings) should be excluded
1.609 raeburn 7229: Keys of top level results hash are roles.
1.275 raeburn 7230: Keys of inner hashes are username:domain, with
7231: values set to access type.
1.288 raeburn 7232: Optional userdata hash returns an array with arguments in the
7233: same order as loncoursedata::get_classlist() for student data.
7234:
1.609 raeburn 7235: Optional statushash returns
7236:
1.288 raeburn 7237: Entries for end, start, section and status are blank because
7238: of the possibility of multiple values for non-student roles.
7239:
1.275 raeburn 7240: =cut
1.405 albertel 7241:
1.275 raeburn 7242: ###############################################
1.405 albertel 7243:
1.275 raeburn 7244: sub get_course_users {
1.630 raeburn 7245: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 7246: my %idx = ();
1.419 raeburn 7247: my %seclists;
1.288 raeburn 7248:
7249: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
7250: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
7251: $idx{end} = &Apache::loncoursedata::CL_END();
7252: $idx{start} = &Apache::loncoursedata::CL_START();
7253: $idx{id} = &Apache::loncoursedata::CL_ID();
7254: $idx{section} = &Apache::loncoursedata::CL_SECTION();
7255: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
7256: $idx{status} = &Apache::loncoursedata::CL_STATUS();
7257:
1.290 albertel 7258: if (grep(/^st$/,@{$roles})) {
1.276 albertel 7259: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 7260: my $now = time;
1.277 albertel 7261: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 7262: my $match = 0;
1.412 raeburn 7263: my $secmatch = 0;
1.419 raeburn 7264: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 7265: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 7266: if ($section eq '') {
7267: $section = 'none';
7268: }
1.291 albertel 7269: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7270: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7271: $secmatch = 1;
7272: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 7273: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7274: $secmatch = 1;
7275: }
7276: } else {
1.419 raeburn 7277: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 7278: $secmatch = 1;
7279: }
1.290 albertel 7280: }
1.412 raeburn 7281: if (!$secmatch) {
7282: next;
7283: }
1.419 raeburn 7284: }
1.275 raeburn 7285: if (defined($$types{'active'})) {
1.288 raeburn 7286: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 7287: push(@{$$users{st}{$student}},'active');
1.288 raeburn 7288: $match = 1;
1.275 raeburn 7289: }
7290: }
7291: if (defined($$types{'previous'})) {
1.609 raeburn 7292: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 7293: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 7294: $match = 1;
1.275 raeburn 7295: }
7296: }
7297: if (defined($$types{'future'})) {
1.609 raeburn 7298: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 7299: push(@{$$users{st}{$student}},'future');
1.288 raeburn 7300: $match = 1;
1.275 raeburn 7301: }
7302: }
1.609 raeburn 7303: if ($match) {
7304: push(@{$seclists{$student}},$section);
7305: if (ref($userdata) eq 'HASH') {
7306: $$userdata{$student} = $$classlist{$student};
7307: }
7308: if (ref($statushash) eq 'HASH') {
7309: $statushash->{$student}{'st'}{$section} = $status;
7310: }
1.288 raeburn 7311: }
1.275 raeburn 7312: }
7313: }
1.412 raeburn 7314: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 7315: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7316: my $now = time;
1.609 raeburn 7317: my %displaystatus = ( previous => 'Expired',
7318: active => 'Active',
7319: future => 'Future',
7320: );
1.630 raeburn 7321: my %nothide;
7322: if ($hidepriv) {
7323: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
7324: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
7325: if ($user !~ /:/) {
7326: $nothide{join(':',split(/[\@]/,$user))}=1;
7327: } else {
7328: $nothide{$user} = 1;
7329: }
7330: }
7331: }
1.439 raeburn 7332: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 7333: my $match = 0;
1.412 raeburn 7334: my $secmatch = 0;
1.439 raeburn 7335: my $status;
1.412 raeburn 7336: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 7337: $user =~ s/:$//;
1.439 raeburn 7338: my ($end,$start) = split(/:/,$coursepersonnel{$person});
7339: if ($end == -1 || $start == -1) {
7340: next;
7341: }
7342: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
7343: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 7344: my ($uname,$udom) = split(/:/,$user);
7345: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7346: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7347: $secmatch = 1;
7348: } elsif ($usec eq '') {
1.420 albertel 7349: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7350: $secmatch = 1;
7351: }
7352: } else {
7353: if (grep(/^\Q$usec\E$/,@{$sections})) {
7354: $secmatch = 1;
7355: }
7356: }
7357: if (!$secmatch) {
7358: next;
7359: }
1.288 raeburn 7360: }
1.419 raeburn 7361: if ($usec eq '') {
7362: $usec = 'none';
7363: }
1.275 raeburn 7364: if ($uname ne '' && $udom ne '') {
1.630 raeburn 7365: if ($hidepriv) {
7366: if ((&Apache::lonnet::privileged($uname,$udom)) &&
7367: (!$nothide{$uname.':'.$udom})) {
7368: next;
7369: }
7370: }
1.503 raeburn 7371: if ($end > 0 && $end < $now) {
1.439 raeburn 7372: $status = 'previous';
7373: } elsif ($start > $now) {
7374: $status = 'future';
7375: } else {
7376: $status = 'active';
7377: }
1.277 albertel 7378: foreach my $type (keys(%{$types})) {
1.275 raeburn 7379: if ($status eq $type) {
1.420 albertel 7380: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 7381: push(@{$$users{$role}{$user}},$type);
7382: }
1.288 raeburn 7383: $match = 1;
7384: }
7385: }
1.419 raeburn 7386: if (($match) && (ref($userdata) eq 'HASH')) {
7387: if (!exists($$userdata{$uname.':'.$udom})) {
7388: &get_user_info($udom,$uname,\%idx,$userdata);
7389: }
1.420 albertel 7390: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 7391: push(@{$seclists{$uname.':'.$udom}},$usec);
7392: }
1.609 raeburn 7393: if (ref($statushash) eq 'HASH') {
7394: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
7395: }
1.275 raeburn 7396: }
7397: }
7398: }
7399: }
1.290 albertel 7400: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 7401: if ((defined($cdom)) && (defined($cnum))) {
7402: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
7403: if ( defined($csettings{'internal.courseowner'}) ) {
7404: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 7405: next if ($owner eq '');
7406: my ($ownername,$ownerdom);
7407: if ($owner =~ /^([^:]+):([^:]+)$/) {
7408: $ownername = $1;
7409: $ownerdom = $2;
7410: } else {
7411: $ownername = $owner;
7412: $ownerdom = $cdom;
7413: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 7414: }
7415: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 7416: if (defined($userdata) &&
1.609 raeburn 7417: !exists($$userdata{$owner})) {
7418: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
7419: if (!grep(/^none$/,@{$seclists{$owner}})) {
7420: push(@{$seclists{$owner}},'none');
7421: }
7422: if (ref($statushash) eq 'HASH') {
7423: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 7424: }
1.290 albertel 7425: }
1.279 raeburn 7426: }
7427: }
7428: }
1.419 raeburn 7429: foreach my $user (keys(%seclists)) {
7430: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
7431: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
7432: }
1.275 raeburn 7433: }
7434: return;
7435: }
7436:
1.288 raeburn 7437: sub get_user_info {
7438: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 7439: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
7440: &plainname($uname,$udom,'lastname');
1.291 albertel 7441: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 7442: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 7443: my %idhash = &Apache::lonnet::idrget($udom,($uname));
7444: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 7445: return;
7446: }
1.275 raeburn 7447:
1.472 raeburn 7448: ###############################################
7449:
7450: =pod
7451:
7452: =item * &get_user_quota()
7453:
7454: Retrieves quota assigned for storage of portfolio files for a user
7455:
7456: Incoming parameters:
7457: 1. user's username
7458: 2. user's domain
7459:
7460: Returns:
1.536 raeburn 7461: 1. Disk quota (in Mb) assigned to student.
7462: 2. (Optional) Type of setting: custom or default
7463: (individually assigned or default for user's
7464: institutional status).
7465: 3. (Optional) - User's institutional status (e.g., faculty, staff
7466: or student - types as defined in localenroll::inst_usertypes
7467: for user's domain, which determines default quota for user.
7468: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 7469:
7470: If a value has been stored in the user's environment,
1.536 raeburn 7471: it will return that, otherwise it returns the maximal default
7472: defined for the user's instituional status(es) in the domain.
1.472 raeburn 7473:
7474: =cut
7475:
7476: ###############################################
7477:
7478:
7479: sub get_user_quota {
7480: my ($uname,$udom) = @_;
1.536 raeburn 7481: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 7482: if (!defined($udom)) {
7483: $udom = $env{'user.domain'};
7484: }
7485: if (!defined($uname)) {
7486: $uname = $env{'user.name'};
7487: }
7488: if (($udom eq '' || $uname eq '') ||
7489: ($udom eq 'public') && ($uname eq 'public')) {
7490: $quota = 0;
1.536 raeburn 7491: $quotatype = 'default';
7492: $defquota = 0;
1.472 raeburn 7493: } else {
1.536 raeburn 7494: my $inststatus;
1.472 raeburn 7495: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
7496: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 7497: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 7498: } else {
1.536 raeburn 7499: my %userenv =
7500: &Apache::lonnet::get('environment',['portfolioquota',
7501: 'inststatus'],$udom,$uname);
1.472 raeburn 7502: my ($tmp) = keys(%userenv);
7503: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7504: $quota = $userenv{'portfolioquota'};
1.536 raeburn 7505: $inststatus = $userenv{'inststatus'};
1.472 raeburn 7506: } else {
7507: undef(%userenv);
7508: }
7509: }
1.536 raeburn 7510: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 7511: if ($quota eq '') {
1.536 raeburn 7512: $quota = $defquota;
7513: $quotatype = 'default';
7514: } else {
7515: $quotatype = 'custom';
1.472 raeburn 7516: }
7517: }
1.536 raeburn 7518: if (wantarray) {
7519: return ($quota,$quotatype,$settingstatus,$defquota);
7520: } else {
7521: return $quota;
7522: }
1.472 raeburn 7523: }
7524:
7525: ###############################################
7526:
7527: =pod
7528:
7529: =item * &default_quota()
7530:
1.536 raeburn 7531: Retrieves default quota assigned for storage of user portfolio files,
7532: given an (optional) user's institutional status.
1.472 raeburn 7533:
7534: Incoming parameters:
7535: 1. domain
1.536 raeburn 7536: 2. (Optional) institutional status(es). This is a : separated list of
7537: status types (e.g., faculty, staff, student etc.)
7538: which apply to the user for whom the default is being retrieved.
7539: If the institutional status string in undefined, the domain
7540: default quota will be returned.
1.472 raeburn 7541:
7542: Returns:
7543: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 7544: 2. (Optional) institutional type which determined the value of the
7545: default quota.
1.472 raeburn 7546:
7547: If a value has been stored in the domain's configuration db,
7548: it will return that, otherwise it returns 20 (for backwards
7549: compatibility with domains which have not set up a configuration
7550: db file; the original statically defined portfolio quota was 20 Mb).
7551:
1.536 raeburn 7552: If the user's status includes multiple types (e.g., staff and student),
7553: the largest default quota which applies to the user determines the
7554: default quota returned.
7555:
1.780 raeburn 7556: =back
7557:
1.472 raeburn 7558: =cut
7559:
7560: ###############################################
7561:
7562:
7563: sub default_quota {
1.536 raeburn 7564: my ($udom,$inststatus) = @_;
7565: my ($defquota,$settingstatus);
7566: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 7567: ['quotas'],$udom);
7568: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 7569: if ($inststatus ne '') {
1.765 raeburn 7570: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 7571: foreach my $item (@statuses) {
1.711 raeburn 7572: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7573: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
7574: if ($defquota eq '') {
7575: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7576: $settingstatus = $item;
7577: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
7578: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7579: $settingstatus = $item;
7580: }
7581: }
7582: } else {
7583: if ($quotahash{'quotas'}{$item} ne '') {
7584: if ($defquota eq '') {
7585: $defquota = $quotahash{'quotas'}{$item};
7586: $settingstatus = $item;
7587: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
7588: $defquota = $quotahash{'quotas'}{$item};
7589: $settingstatus = $item;
7590: }
1.536 raeburn 7591: }
7592: }
7593: }
7594: }
7595: if ($defquota eq '') {
1.711 raeburn 7596: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7597: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
7598: } else {
7599: $defquota = $quotahash{'quotas'}{'default'};
7600: }
1.536 raeburn 7601: $settingstatus = 'default';
7602: }
7603: } else {
7604: $settingstatus = 'default';
7605: $defquota = 20;
7606: }
7607: if (wantarray) {
7608: return ($defquota,$settingstatus);
1.472 raeburn 7609: } else {
1.536 raeburn 7610: return $defquota;
1.472 raeburn 7611: }
7612: }
7613:
1.384 raeburn 7614: sub get_secgrprole_info {
7615: my ($cdom,$cnum,$needroles,$type) = @_;
7616: my %sections_count = &get_sections($cdom,$cnum);
7617: my @sections = (sort {$a <=> $b} keys(%sections_count));
7618: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
7619: my @groups = sort(keys(%curr_groups));
7620: my $allroles = [];
7621: my $rolehash;
7622: my $accesshash = {
7623: active => 'Currently has access',
7624: future => 'Will have future access',
7625: previous => 'Previously had access',
7626: };
7627: if ($needroles) {
7628: $rolehash = {'all' => 'all'};
1.385 albertel 7629: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7630: if (&Apache::lonnet::error(%user_roles)) {
7631: undef(%user_roles);
7632: }
7633: foreach my $item (keys(%user_roles)) {
1.384 raeburn 7634: my ($role)=split(/\:/,$item,2);
7635: if ($role eq 'cr') { next; }
7636: if ($role =~ /^cr/) {
7637: $$rolehash{$role} = (split('/',$role))[3];
7638: } else {
7639: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
7640: }
7641: }
7642: foreach my $key (sort(keys(%{$rolehash}))) {
7643: push(@{$allroles},$key);
7644: }
7645: push (@{$allroles},'st');
7646: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
7647: }
7648: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
7649: }
7650:
1.555 raeburn 7651: sub user_picker {
1.627 raeburn 7652: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555 raeburn 7653: my $currdom = $dom;
7654: my %curr_selected = (
7655: srchin => 'dom',
1.580 raeburn 7656: srchby => 'lastname',
1.555 raeburn 7657: );
7658: my $srchterm;
1.625 raeburn 7659: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 7660: if ($srch->{'srchby'} ne '') {
7661: $curr_selected{'srchby'} = $srch->{'srchby'};
7662: }
7663: if ($srch->{'srchin'} ne '') {
7664: $curr_selected{'srchin'} = $srch->{'srchin'};
7665: }
7666: if ($srch->{'srchtype'} ne '') {
7667: $curr_selected{'srchtype'} = $srch->{'srchtype'};
7668: }
7669: if ($srch->{'srchdomain'} ne '') {
7670: $currdom = $srch->{'srchdomain'};
7671: }
7672: $srchterm = $srch->{'srchterm'};
7673: }
7674: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 7675: 'usr' => 'Search criteria',
1.563 raeburn 7676: 'doma' => 'Domain/institution to search',
1.558 albertel 7677: 'uname' => 'username',
7678: 'lastname' => 'last name',
1.555 raeburn 7679: 'lastfirst' => 'last name, first name',
1.558 albertel 7680: 'crs' => 'in this course',
1.576 raeburn 7681: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 7682: 'alc' => 'all LON-CAPA',
1.573 raeburn 7683: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 7684: 'exact' => 'is',
7685: 'contains' => 'contains',
1.569 raeburn 7686: 'begins' => 'begins with',
1.571 raeburn 7687: 'youm' => "You must include some text to search for.",
7688: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
7689: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
7690: 'yomc' => "You must choose a domain when using an institutional directory search.",
7691: 'ymcd' => "You must choose a domain when using a domain search.",
7692: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
7693: 'whse' => "When searching by last,first you must include at least one character in the first name.",
7694: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 7695: );
1.563 raeburn 7696: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
7697: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 7698:
7699: my @srchins = ('crs','dom','alc','instd');
7700:
7701: foreach my $option (@srchins) {
7702: # FIXME 'alc' option unavailable until
7703: # loncreateuser::print_user_query_page()
7704: # has been completed.
7705: next if ($option eq 'alc');
1.880 raeburn 7706: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 7707: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 7708: if ($curr_selected{'srchin'} eq $option) {
7709: $srchinsel .= '
7710: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7711: } else {
7712: $srchinsel .= '
7713: <option value="'.$option.'">'.$lt{$option}.'</option>';
7714: }
1.555 raeburn 7715: }
1.563 raeburn 7716: $srchinsel .= "\n </select>\n";
1.555 raeburn 7717:
7718: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 7719: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 7720: if ($curr_selected{'srchby'} eq $option) {
7721: $srchbysel .= '
7722: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7723: } else {
7724: $srchbysel .= '
7725: <option value="'.$option.'">'.$lt{$option}.'</option>';
7726: }
7727: }
7728: $srchbysel .= "\n </select>\n";
7729:
7730: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 7731: foreach my $option ('begins','contains','exact') {
1.555 raeburn 7732: if ($curr_selected{'srchtype'} eq $option) {
7733: $srchtypesel .= '
7734: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7735: } else {
7736: $srchtypesel .= '
7737: <option value="'.$option.'">'.$lt{$option}.'</option>';
7738: }
7739: }
7740: $srchtypesel .= "\n </select>\n";
7741:
1.558 albertel 7742: my ($newuserscript,$new_user_create);
1.556 raeburn 7743:
7744: if ($forcenewuser) {
1.576 raeburn 7745: if (ref($srch) eq 'HASH') {
7746: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627 raeburn 7747: if ($cancreate) {
7748: $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>';
7749: } else {
1.799 bisitz 7750: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 7751: my %usertypetext = (
7752: official => 'institutional',
7753: unofficial => 'non-institutional',
7754: );
1.799 bisitz 7755: $new_user_create = '<p class="LC_warning">'
7756: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
7757: .' '
7758: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
7759: ,'<a href="'.$helplink.'">','</a>')
7760: .'</p><br />';
1.627 raeburn 7761: }
1.576 raeburn 7762: }
7763: }
7764:
1.556 raeburn 7765: $newuserscript = <<"ENDSCRIPT";
7766:
1.570 raeburn 7767: function setSearch(createnew,callingForm) {
1.556 raeburn 7768: if (createnew == 1) {
1.570 raeburn 7769: for (var i=0; i<callingForm.srchby.length; i++) {
7770: if (callingForm.srchby.options[i].value == 'uname') {
7771: callingForm.srchby.selectedIndex = i;
1.556 raeburn 7772: }
7773: }
1.570 raeburn 7774: for (var i=0; i<callingForm.srchin.length; i++) {
7775: if ( callingForm.srchin.options[i].value == 'dom') {
7776: callingForm.srchin.selectedIndex = i;
1.556 raeburn 7777: }
7778: }
1.570 raeburn 7779: for (var i=0; i<callingForm.srchtype.length; i++) {
7780: if (callingForm.srchtype.options[i].value == 'exact') {
7781: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 7782: }
7783: }
1.570 raeburn 7784: for (var i=0; i<callingForm.srchdomain.length; i++) {
7785: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
7786: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 7787: }
7788: }
7789: }
7790: }
7791: ENDSCRIPT
1.558 albertel 7792:
1.556 raeburn 7793: }
7794:
1.555 raeburn 7795: my $output = <<"END_BLOCK";
1.556 raeburn 7796: <script type="text/javascript">
1.824 bisitz 7797: // <![CDATA[
1.570 raeburn 7798: function validateEntry(callingForm) {
1.558 albertel 7799:
1.556 raeburn 7800: var checkok = 1;
1.558 albertel 7801: var srchin;
1.570 raeburn 7802: for (var i=0; i<callingForm.srchin.length; i++) {
7803: if ( callingForm.srchin[i].checked ) {
7804: srchin = callingForm.srchin[i].value;
1.558 albertel 7805: }
7806: }
7807:
1.570 raeburn 7808: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7809: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7810: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7811: var srchterm = callingForm.srchterm.value;
7812: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7813: var msg = "";
7814:
7815: if (srchterm == "") {
7816: checkok = 0;
1.571 raeburn 7817: msg += "$lt{'youm'}\\n";
1.556 raeburn 7818: }
7819:
1.569 raeburn 7820: if (srchtype== 'begins') {
7821: if (srchterm.length < 2) {
7822: checkok = 0;
1.571 raeburn 7823: msg += "$lt{'thte'}\\n";
1.569 raeburn 7824: }
7825: }
7826:
1.556 raeburn 7827: if (srchtype== 'contains') {
7828: if (srchterm.length < 3) {
7829: checkok = 0;
1.571 raeburn 7830: msg += "$lt{'thet'}\\n";
1.556 raeburn 7831: }
7832: }
7833: if (srchin == 'instd') {
7834: if (srchdomain == '') {
7835: checkok = 0;
1.571 raeburn 7836: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7837: }
7838: }
7839: if (srchin == 'dom') {
7840: if (srchdomain == '') {
7841: checkok = 0;
1.571 raeburn 7842: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7843: }
7844: }
7845: if (srchby == 'lastfirst') {
7846: if (srchterm.indexOf(",") == -1) {
7847: checkok = 0;
1.571 raeburn 7848: msg += "$lt{'whus'}\\n";
1.556 raeburn 7849: }
7850: if (srchterm.indexOf(",") == srchterm.length -1) {
7851: checkok = 0;
1.571 raeburn 7852: msg += "$lt{'whse'}\\n";
1.556 raeburn 7853: }
7854: }
7855: if (checkok == 0) {
1.571 raeburn 7856: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7857: return;
7858: }
7859: if (checkok == 1) {
1.570 raeburn 7860: callingForm.submit();
1.556 raeburn 7861: }
7862: }
7863:
7864: $newuserscript
7865:
1.824 bisitz 7866: // ]]>
1.556 raeburn 7867: </script>
1.558 albertel 7868:
7869: $new_user_create
7870:
1.555 raeburn 7871: END_BLOCK
1.558 albertel 7872:
1.876 raeburn 7873: $output .= &Apache::lonhtmlcommon::start_pick_box().
7874: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
7875: $domform.
7876: &Apache::lonhtmlcommon::row_closure().
7877: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
7878: $srchbysel.
7879: $srchtypesel.
7880: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
7881: $srchinsel.
7882: &Apache::lonhtmlcommon::row_closure(1).
7883: &Apache::lonhtmlcommon::end_pick_box().
7884: '<br />';
1.555 raeburn 7885: return $output;
7886: }
7887:
1.612 raeburn 7888: sub user_rule_check {
1.615 raeburn 7889: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 7890: my $response;
7891: if (ref($usershash) eq 'HASH') {
7892: foreach my $user (keys(%{$usershash})) {
7893: my ($uname,$udom) = split(/:/,$user);
7894: next if ($udom eq '' || $uname eq '');
1.615 raeburn 7895: my ($id,$newuser);
1.612 raeburn 7896: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 7897: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 7898: $id = $usershash->{$user}->{'id'};
7899: }
7900: my $inst_response;
7901: if (ref($checks) eq 'HASH') {
7902: if (defined($checks->{'username'})) {
1.615 raeburn 7903: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7904: &Apache::lonnet::get_instuser($udom,$uname);
7905: } elsif (defined($checks->{'id'})) {
1.615 raeburn 7906: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7907: &Apache::lonnet::get_instuser($udom,undef,$id);
7908: }
1.615 raeburn 7909: } else {
7910: ($inst_response,%{$inst_results->{$user}}) =
7911: &Apache::lonnet::get_instuser($udom,$uname);
7912: return;
1.612 raeburn 7913: }
1.615 raeburn 7914: if (!$got_rules->{$udom}) {
1.612 raeburn 7915: my %domconfig = &Apache::lonnet::get_dom('configuration',
7916: ['usercreation'],$udom);
7917: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 7918: foreach my $item ('username','id') {
1.612 raeburn 7919: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
7920: $$curr_rules{$udom}{$item} =
7921: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 7922: }
7923: }
7924: }
1.615 raeburn 7925: $got_rules->{$udom} = 1;
1.585 raeburn 7926: }
1.612 raeburn 7927: foreach my $item (keys(%{$checks})) {
7928: if (ref($$curr_rules{$udom}) eq 'HASH') {
7929: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
7930: if (@{$$curr_rules{$udom}{$item}} > 0) {
7931: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
7932: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
7933: if ($rule_check{$rule}) {
7934: $$rulematch{$user}{$item} = $rule;
7935: if ($inst_response eq 'ok') {
1.615 raeburn 7936: if (ref($inst_results) eq 'HASH') {
7937: if (ref($inst_results->{$user}) eq 'HASH') {
7938: if (keys(%{$inst_results->{$user}}) == 0) {
7939: $$alerts{$item}{$udom}{$uname} = 1;
7940: }
1.612 raeburn 7941: }
7942: }
1.615 raeburn 7943: }
7944: last;
1.585 raeburn 7945: }
7946: }
7947: }
7948: }
7949: }
7950: }
7951: }
7952: }
1.612 raeburn 7953: return;
7954: }
7955:
7956: sub user_rule_formats {
7957: my ($domain,$domdesc,$curr_rules,$check) = @_;
7958: my %text = (
7959: 'username' => 'Usernames',
7960: 'id' => 'IDs',
7961: );
7962: my $output;
7963: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
7964: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
7965: if (@{$ruleorder} > 0) {
7966: $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>';
7967: foreach my $rule (@{$ruleorder}) {
7968: if (ref($curr_rules) eq 'ARRAY') {
7969: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
7970: if (ref($rules->{$rule}) eq 'HASH') {
7971: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
7972: $rules->{$rule}{'desc'}.'</li>';
7973: }
7974: }
7975: }
7976: }
7977: $output .= '</ul>';
7978: }
7979: }
7980: return $output;
7981: }
7982:
7983: sub instrule_disallow_msg {
1.615 raeburn 7984: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 7985: my $response;
7986: my %text = (
7987: item => 'username',
7988: items => 'usernames',
7989: match => 'matches',
7990: do => 'does',
7991: action => 'a username',
7992: one => 'one',
7993: );
7994: if ($count > 1) {
7995: $text{'item'} = 'usernames';
7996: $text{'match'} ='match';
7997: $text{'do'} = 'do';
7998: $text{'action'} = 'usernames',
7999: $text{'one'} = 'ones';
8000: }
8001: if ($checkitem eq 'id') {
8002: $text{'items'} = 'IDs';
8003: $text{'item'} = 'ID';
8004: $text{'action'} = 'an ID';
1.615 raeburn 8005: if ($count > 1) {
8006: $text{'item'} = 'IDs';
8007: $text{'action'} = 'IDs';
8008: }
1.612 raeburn 8009: }
1.674 bisitz 8010: $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 8011: if ($mode eq 'upload') {
8012: if ($checkitem eq 'username') {
8013: $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'}.");
8014: } elsif ($checkitem eq 'id') {
1.674 bisitz 8015: $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 8016: }
1.669 raeburn 8017: } elsif ($mode eq 'selfcreate') {
8018: if ($checkitem eq 'id') {
8019: $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.");
8020: }
1.615 raeburn 8021: } else {
8022: if ($checkitem eq 'username') {
8023: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
8024: } elsif ($checkitem eq 'id') {
8025: $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.");
8026: }
1.612 raeburn 8027: }
8028: return $response;
1.585 raeburn 8029: }
8030:
1.624 raeburn 8031: sub personal_data_fieldtitles {
8032: my %fieldtitles = &Apache::lonlocal::texthash (
8033: id => 'Student/Employee ID',
8034: permanentemail => 'E-mail address',
8035: lastname => 'Last Name',
8036: firstname => 'First Name',
8037: middlename => 'Middle Name',
8038: generation => 'Generation',
8039: gen => 'Generation',
1.765 raeburn 8040: inststatus => 'Affiliation',
1.624 raeburn 8041: );
8042: return %fieldtitles;
8043: }
8044:
1.642 raeburn 8045: sub sorted_inst_types {
8046: my ($dom) = @_;
8047: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
8048: my $othertitle = &mt('All users');
8049: if ($env{'request.course.id'}) {
1.668 raeburn 8050: $othertitle = &mt('Any users');
1.642 raeburn 8051: }
8052: my @types;
8053: if (ref($order) eq 'ARRAY') {
8054: @types = @{$order};
8055: }
8056: if (@types == 0) {
8057: if (ref($usertypes) eq 'HASH') {
8058: @types = sort(keys(%{$usertypes}));
8059: }
8060: }
8061: if (keys(%{$usertypes}) > 0) {
8062: $othertitle = &mt('Other users');
8063: }
8064: return ($othertitle,$usertypes,\@types);
8065: }
8066:
1.645 raeburn 8067: sub get_institutional_codes {
8068: my ($settings,$allcourses,$LC_code) = @_;
8069: # Get complete list of course sections to update
8070: my @currsections = ();
8071: my @currxlists = ();
8072: my $coursecode = $$settings{'internal.coursecode'};
8073:
8074: if ($$settings{'internal.sectionnums'} ne '') {
8075: @currsections = split(/,/,$$settings{'internal.sectionnums'});
8076: }
8077:
8078: if ($$settings{'internal.crosslistings'} ne '') {
8079: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
8080: }
8081:
8082: if (@currxlists > 0) {
8083: foreach (@currxlists) {
8084: if (m/^([^:]+):(\w*)$/) {
8085: unless (grep/^$1$/,@{$allcourses}) {
8086: push @{$allcourses},$1;
8087: $$LC_code{$1} = $2;
8088: }
8089: }
8090: }
8091: }
8092:
8093: if (@currsections > 0) {
8094: foreach (@currsections) {
8095: if (m/^(\w+):(\w*)$/) {
8096: my $sec = $coursecode.$1;
8097: my $lc_sec = $2;
8098: unless (grep/^$sec$/,@{$allcourses}) {
8099: push @{$allcourses},$sec;
8100: $$LC_code{$sec} = $lc_sec;
8101: }
8102: }
8103: }
8104: }
8105: return;
8106: }
8107:
1.971 raeburn 8108: sub get_standard_codeitems {
8109: return ('Year','Semester','Department','Number','Section');
8110: }
8111:
1.112 bowersj2 8112: =pod
8113:
1.780 raeburn 8114: =head1 Slot Helpers
8115:
8116: =over 4
8117:
8118: =item * sorted_slots()
8119:
8120: Sorts an array of slot names in order of slot start time (earliest first).
8121:
8122: Inputs:
8123:
8124: =over 4
8125:
8126: slotsarr - Reference to array of unsorted slot names.
8127:
8128: slots - Reference to hash of hash, where outer hash keys are slot names.
8129:
1.549 albertel 8130: =back
8131:
1.780 raeburn 8132: Returns:
8133:
8134: =over 4
8135:
8136: sorted - An array of slot names sorted by the start time of the slot.
8137:
8138: =back
8139:
8140: =back
8141:
8142: =cut
8143:
8144:
8145: sub sorted_slots {
8146: my ($slotsarr,$slots) = @_;
8147: my @sorted;
8148: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
8149: @sorted =
8150: sort {
8151: if (ref($slots->{$a}) && ref($slots->{$b})) {
8152: return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
8153: }
8154: if (ref($slots->{$a})) { return -1;}
8155: if (ref($slots->{$b})) { return 1;}
8156: return 0;
8157: } @{$slotsarr};
8158: }
8159: return @sorted;
8160: }
8161:
8162:
8163: =pod
8164:
1.549 albertel 8165: =head1 HTTP Helpers
8166:
8167: =over 4
8168:
1.648 raeburn 8169: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 8170:
1.258 albertel 8171: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 8172: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 8173: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 8174:
8175: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
8176: $possible_names is an ref to an array of form element names. As an example:
8177: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 8178: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 8179:
8180: =cut
1.1 albertel 8181:
1.6 albertel 8182: sub get_unprocessed_cgi {
1.25 albertel 8183: my ($query,$possible_names)= @_;
1.26 matthew 8184: # $Apache::lonxml::debug=1;
1.356 albertel 8185: foreach my $pair (split(/&/,$query)) {
8186: my ($name, $value) = split(/=/,$pair);
1.369 www 8187: $name = &unescape($name);
1.25 albertel 8188: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
8189: $value =~ tr/+/ /;
8190: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 8191: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 8192: }
1.16 harris41 8193: }
1.6 albertel 8194: }
8195:
1.112 bowersj2 8196: =pod
8197:
1.648 raeburn 8198: =item * &cacheheader()
1.112 bowersj2 8199:
8200: returns cache-controlling header code
8201:
8202: =cut
8203:
1.7 albertel 8204: sub cacheheader {
1.258 albertel 8205: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 8206: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
8207: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 8208: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
8209: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 8210: return $output;
1.7 albertel 8211: }
8212:
1.112 bowersj2 8213: =pod
8214:
1.648 raeburn 8215: =item * &no_cache($r)
1.112 bowersj2 8216:
8217: specifies header code to not have cache
8218:
8219: =cut
8220:
1.9 albertel 8221: sub no_cache {
1.216 albertel 8222: my ($r) = @_;
8223: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 8224: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 8225: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
8226: $r->no_cache(1);
8227: $r->header_out("Expires" => $date);
8228: $r->header_out("Pragma" => "no-cache");
1.123 www 8229: }
8230:
8231: sub content_type {
1.181 albertel 8232: my ($r,$type,$charset) = @_;
1.299 foxr 8233: if ($r) {
8234: # Note that printout.pl calls this with undef for $r.
8235: &no_cache($r);
8236: }
1.258 albertel 8237: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 8238: unless ($charset) {
8239: $charset=&Apache::lonlocal::current_encoding;
8240: }
8241: if ($charset) { $type.='; charset='.$charset; }
8242: if ($r) {
8243: $r->content_type($type);
8244: } else {
8245: print("Content-type: $type\n\n");
8246: }
1.9 albertel 8247: }
1.25 albertel 8248:
1.112 bowersj2 8249: =pod
8250:
1.648 raeburn 8251: =item * &add_to_env($name,$value)
1.112 bowersj2 8252:
1.258 albertel 8253: adds $name to the %env hash with value
1.112 bowersj2 8254: $value, if $name already exists, the entry is converted to an array
8255: reference and $value is added to the array.
8256:
8257: =cut
8258:
1.25 albertel 8259: sub add_to_env {
8260: my ($name,$value)=@_;
1.258 albertel 8261: if (defined($env{$name})) {
8262: if (ref($env{$name})) {
1.25 albertel 8263: #already have multiple values
1.258 albertel 8264: push(@{ $env{$name} },$value);
1.25 albertel 8265: } else {
8266: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 8267: my $first=$env{$name};
8268: undef($env{$name});
8269: push(@{ $env{$name} },$first,$value);
1.25 albertel 8270: }
8271: } else {
1.258 albertel 8272: $env{$name}=$value;
1.25 albertel 8273: }
1.31 albertel 8274: }
1.149 albertel 8275:
8276: =pod
8277:
1.648 raeburn 8278: =item * &get_env_multiple($name)
1.149 albertel 8279:
1.258 albertel 8280: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 8281: values may be defined and end up as an array ref.
8282:
8283: returns an array of values
8284:
8285: =cut
8286:
8287: sub get_env_multiple {
8288: my ($name) = @_;
8289: my @values;
1.258 albertel 8290: if (defined($env{$name})) {
1.149 albertel 8291: # exists is it an array
1.258 albertel 8292: if (ref($env{$name})) {
8293: @values=@{ $env{$name} };
1.149 albertel 8294: } else {
1.258 albertel 8295: $values[0]=$env{$name};
1.149 albertel 8296: }
8297: }
8298: return(@values);
8299: }
8300:
1.660 raeburn 8301: sub ask_for_embedded_content {
8302: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.987 ! raeburn 8303: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges);
1.660 raeburn 8304: my $num = 0;
1.987 ! raeburn 8305: my $numremref = 0;
! 8306: my $numinvalid = 0;
! 8307: my $numpathchg = 0;
! 8308: my $numexisting = 0;
! 8309: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath);
1.984 raeburn 8310: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
8311: my $current_path='/';
8312: if ($env{'form.currentpath'}) {
8313: $current_path = $env{'form.currentpath'};
8314: }
8315: if ($actionurl eq '/adm/coursegrp_portfolio') {
8316: $udom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8317: $uname = $env{'course.'.$env{'request.course.id'}.'.num'};
8318: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
8319: } else {
8320: $udom = $env{'user.domain'};
8321: $uname = $env{'user.name'};
8322: $url = '/userfiles/portfolio';
8323: }
1.987 ! raeburn 8324: $toplevel = $url.'/';
1.984 raeburn 8325: $url .= $current_path;
8326: $getpropath = 1;
1.987 ! raeburn 8327: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
! 8328: ($actionurl eq '/adm/imsimport')) {
1.984 raeburn 8329: ($uname,my $rest) = ($args->{'current_path'} =~ m{/priv/($match_username)/?(.*)$});
1.987 ! raeburn 8330: $url = '/home/'.$uname.'/public_html/';
! 8331: $toplevel = $url;
1.984 raeburn 8332: if ($rest ne '') {
1.987 ! raeburn 8333: $url .= $rest;
! 8334: }
! 8335: } elsif ($actionurl eq '/adm/coursedocs') {
! 8336: if (ref($args) eq 'HASH') {
! 8337: $url = $args->{'docs_url'};
! 8338: $toplevel = $url;
! 8339: }
! 8340: }
! 8341: my $now = time();
! 8342: foreach my $embed_file (keys(%{$allfiles})) {
! 8343: my $absolutepath;
! 8344: if ($embed_file =~ m{^\w+://}) {
! 8345: $newfiles{$embed_file} = 1;
! 8346: $mapping{$embed_file} = $embed_file;
! 8347: } else {
! 8348: if ($embed_file =~ m{^/}) {
! 8349: $absolutepath = $embed_file;
! 8350: $embed_file =~ s{^(/+)}{};
! 8351: }
! 8352: if ($embed_file =~ m{/}) {
! 8353: my ($path,$fname) = ($embed_file =~ m{^(.+)/([^/]*)$});
! 8354: $path = &check_for_traversal($path,$url,$toplevel);
! 8355: my $item = $fname;
! 8356: if ($path ne '') {
! 8357: $item = $path.'/'.$fname;
! 8358: $subdependencies{$path}{$fname} = 1;
! 8359: } else {
! 8360: $dependencies{$item} = 1;
! 8361: }
! 8362: if ($absolutepath) {
! 8363: $mapping{$item} = $absolutepath;
! 8364: } else {
! 8365: $mapping{$item} = $embed_file;
! 8366: }
! 8367: } else {
! 8368: $dependencies{$embed_file} = 1;
! 8369: if ($absolutepath) {
! 8370: $mapping{$embed_file} = $absolutepath;
! 8371: } else {
! 8372: $mapping{$embed_file} = $embed_file;
! 8373: }
! 8374: }
1.984 raeburn 8375: }
8376: }
8377: foreach my $path (keys(%subdependencies)) {
8378: my %currsubfile;
8379: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
8380: my @subdir_list = &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
8381: foreach my $line (@subdir_list) {
8382: my ($file_name,$rest) = split(/\&/,$line,2);
8383: $currsubfile{$file_name} = 1;
8384: }
1.987 ! raeburn 8385: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 8386: if (opendir(my $dir,$url.'/'.$path)) {
8387: my @subdir_list = grep(!/^\./,readdir($dir));
8388: map {$currsubfile{$_} = 1;} @subdir_list;
8389: }
8390: }
8391: foreach my $file (keys(%{$subdependencies{$path}})) {
1.987 ! raeburn 8392: if ($currsubfile{$file}) {
! 8393: my $item = $path.'/'.$file;
! 8394: unless ($mapping{$item} eq $item) {
! 8395: $pathchanges{$item} = 1;
! 8396: }
! 8397: $existing{$item} = 1;
! 8398: $numexisting ++;
! 8399: } else {
! 8400: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 8401: }
8402: }
8403: }
1.987 ! raeburn 8404: my %currfile;
1.984 raeburn 8405: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
8406: my @dir_list = &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
8407: foreach my $line (@dir_list) {
8408: my ($file_name,$rest) = split(/\&/,$line,2);
8409: $currfile{$file_name} = 1;
8410: }
1.987 ! raeburn 8411: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 8412: if (opendir(my $dir,$url)) {
1.987 ! raeburn 8413: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 8414: map {$currfile{$_} = 1;} @dir_list;
8415: }
8416: }
8417: foreach my $file (keys(%dependencies)) {
1.987 ! raeburn 8418: if ($currfile{$file}) {
! 8419: unless ($mapping{$file} eq $file) {
! 8420: $pathchanges{$file} = 1;
! 8421: }
! 8422: $existing{$file} = 1;
! 8423: $numexisting ++;
! 8424: } else {
1.984 raeburn 8425: $newfiles{$file} = 1;
8426: }
8427: }
8428: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.660 raeburn 8429: $upload_output .= &start_data_table_row().
1.987 ! raeburn 8430: '<td><span class="LC_filename">'.$embed_file.'</span>';
! 8431: unless ($mapping{$embed_file} eq $embed_file) {
! 8432: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.&mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
! 8433: }
! 8434: $upload_output .= '</td><td>';
1.660 raeburn 8435: if ($args->{'ignore_remote_references'}
8436: && $embed_file =~ m{^\w+://}) {
8437: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
1.987 ! raeburn 8438: $numremref++;
1.660 raeburn 8439: } elsif ($args->{'error_on_invalid_names'}
8440: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
8441:
1.987 ! raeburn 8442: $upload_output.='<span class="LC_warning">'.&mt('Invalid characters').'</span>';
! 8443: $numinvalid++;
1.660 raeburn 8444: } else {
1.987 ! raeburn 8445: $upload_output .= &embedded_file_element('upload_embedded',$num,
! 8446: $embed_file,\%mapping,
! 8447: $allfiles,$codebase);
! 8448: $num++;
! 8449: }
! 8450: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
! 8451: }
! 8452: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
! 8453: $upload_output .= &start_data_table_row().
! 8454: '<td><span class="LC_filename">'.$embed_file.'</span></td>'.
! 8455: '<td><span class="LC_warning">'.&mt('Already exists').'</span></td>'.
! 8456: &Apache::loncommon::end_data_table_row()."\n";
! 8457: }
! 8458: if ($upload_output) {
! 8459: $upload_output = &start_data_table().
! 8460: $upload_output.
! 8461: &end_data_table()."\n";
! 8462: }
! 8463: my $applies = 0;
! 8464: if ($numremref) {
! 8465: $applies ++;
! 8466: }
! 8467: if ($numinvalid) {
! 8468: $applies ++;
! 8469: }
! 8470: if ($numexisting) {
! 8471: $applies ++;
! 8472: }
! 8473: if ($num) {
! 8474: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
! 8475: ' method="post" enctype="multipart/form-data">'."\n".
! 8476: $state.
! 8477: '<h3>'.&mt('Upload embedded files').
! 8478: ':</h3>'.$upload_output.'<br />'."\n".
! 8479: '<input type ="hidden" name="number_embedded_items" value="'.
! 8480: $num.'" />'."\n";
! 8481: if ($actionurl eq '') {
! 8482: $output .= '<input type="hidden" name="phase" value="three" />';
! 8483: }
! 8484: } elsif ($applies) {
! 8485: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
! 8486: if ($applies > 1) {
! 8487: $output .=
! 8488: &mt('No files need to be uploaded, as one of the following applies to each reference:').'<ul>';
! 8489: if ($numremref) {
! 8490: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
! 8491: }
! 8492: if ($numinvalid) {
! 8493: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
! 8494: }
! 8495: if ($numexisting) {
! 8496: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
! 8497: }
! 8498: $output .= '</ul><br />';
! 8499: } elsif ($numremref) {
! 8500: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
! 8501: } elsif ($numinvalid) {
! 8502: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
! 8503: } elsif ($numexisting) {
! 8504: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
! 8505: }
! 8506: $output .= $upload_output.'<br />';
! 8507: }
! 8508: my ($pathchange_output,$chgcount);
! 8509: $chgcount = $num;
! 8510: if (keys(%pathchanges) > 0) {
! 8511: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
! 8512: if ($num) {
! 8513: $output .= &embedded_file_element('pathchange',$chgcount,
! 8514: $embed_file,\%mapping,
! 8515: $allfiles,$codebase);
! 8516: } else {
! 8517: $pathchange_output .=
! 8518: &start_data_table_row().
! 8519: '<td><input type ="checkbox" name="namechange" value="'.
! 8520: $chgcount.'" checked="checked" /></td>'.
! 8521: '<td>'.$mapping{$embed_file}.'</td>'.
! 8522: '<td>'.$embed_file.
! 8523: &embedded_file_element('pathchange',$numpathchg,$embed_file,
! 8524: \%mapping,$allfiles,$codebase).
! 8525: '</td>'.&end_data_table_row();
1.660 raeburn 8526: }
1.987 ! raeburn 8527: $numpathchg ++;
! 8528: $chgcount ++;
1.660 raeburn 8529: }
8530: }
1.984 raeburn 8531: if ($num) {
1.987 ! raeburn 8532: if ($numpathchg) {
! 8533: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
! 8534: $numpathchg.'" />'."\n";
! 8535: }
! 8536: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
! 8537: ($actionurl eq '/adm/imsimport')) {
! 8538: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
! 8539: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
! 8540: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
! 8541: }
! 8542: $output .= '<input type ="submit" value="'.&mt('Upload Listed Files').'" />'."\n".
! 8543: &mt('(only files for which a location has been provided will be uploaded)').'</form>'."\n";
! 8544: } elsif ($numpathchg) {
! 8545: my %pathchange = ();
! 8546: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
! 8547: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
! 8548: $output .= '<p>'.&mt('or').'</p>';
! 8549: }
! 8550: }
! 8551: return ($output,$num,$numpathchg);
! 8552: }
! 8553:
! 8554: sub embedded_file_element {
! 8555: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase) = @_;
! 8556: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
! 8557: (ref($codebase) eq 'HASH'));
! 8558: my $output;
! 8559: if ($context eq 'upload_embedded') {
! 8560: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
! 8561: }
! 8562: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
! 8563: &escape($embed_file).'" />';
! 8564: unless (($context eq 'upload_embedded') &&
! 8565: ($mapping->{$embed_file} eq $embed_file)) {
! 8566: $output .='
! 8567: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
! 8568: }
! 8569: my $attrib;
! 8570: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
! 8571: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
! 8572: }
! 8573: $output .=
! 8574: "\n\t\t".
! 8575: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
! 8576: $attrib.'" />';
! 8577: if (exists($codebase->{$mapping->{$embed_file}})) {
! 8578: $output .=
! 8579: "\n\t\t".
! 8580: '<input name="codebase_'.$num.'" type="hidden" value="'.
! 8581: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 8582: }
1.987 ! raeburn 8583: return $output;
1.660 raeburn 8584: }
8585:
1.661 raeburn 8586: sub upload_embedded {
8587: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 ! raeburn 8588: $current_disk_usage,$hiddenstate,$actionurl) = @_;
! 8589: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 8590: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
8591: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
8592: my $orig_uploaded_filename =
8593: $env{'form.embedded_item_'.$i.'.filename'};
1.987 ! raeburn 8594: foreach my $type ('orig','ref','attrib','codebase') {
! 8595: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
! 8596: $env{'form.embedded_'.$type.'_'.$i} =
! 8597: &unescape($env{'form.embedded_'.$type.'_'.$i});
! 8598: }
! 8599: }
1.661 raeburn 8600: my ($path,$fname) =
8601: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
8602: # no path, whole string is fname
8603: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
8604: $fname = &Apache::lonnet::clean_filename($fname);
8605: # See if there is anything left
8606: next if ($fname eq '');
8607:
8608: # Check if file already exists as a file or directory.
8609: my ($state,$msg);
8610: if ($context eq 'portfolio') {
8611: my $port_path = $dirpath;
8612: if ($group ne '') {
8613: $port_path = "groups/$group/$port_path";
8614: }
1.987 ! raeburn 8615: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
! 8616: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 8617: $dir_root,$port_path,$disk_quota,
8618: $current_disk_usage,$uname,$udom);
8619: if ($state eq 'will_exceed_quota'
1.984 raeburn 8620: || $state eq 'file_locked') {
1.661 raeburn 8621: $output .= $msg;
8622: next;
8623: }
8624: } elsif (($context eq 'author') || ($context eq 'testbank')) {
8625: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
8626: if ($state eq 'exists') {
8627: $output .= $msg;
8628: next;
8629: }
8630: }
8631: # Check if extension is valid
8632: if (($fname =~ /\.(\w+)$/) &&
8633: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.987 ! raeburn 8634: $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 8635: next;
8636: } elsif (($fname =~ /\.(\w+)$/) &&
8637: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 ! raeburn 8638: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 8639: next;
8640: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.987 ! raeburn 8641: $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 8642: next;
8643: }
8644:
8645: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
8646: if ($context eq 'portfolio') {
1.984 raeburn 8647: my $result;
8648: if ($state eq 'existingfile') {
8649: $result=
8650: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.987 ! raeburn 8651: $dirpath.$env{'form.currentpath'}.$path);
1.661 raeburn 8652: } else {
1.984 raeburn 8653: $result=
8654: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 ! raeburn 8655: $dirpath.
! 8656: $env{'form.currentpath'}.$path);
1.984 raeburn 8657: if ($result !~ m|^/uploaded/|) {
8658: $output .= '<span class="LC_error">'
8659: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
8660: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
8661: .'</span><br />';
8662: next;
8663: } else {
1.987 ! raeburn 8664: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
! 8665: $path.$fname.'</span>').'<br />';
1.984 raeburn 8666: }
1.661 raeburn 8667: }
1.987 ! raeburn 8668: } elsif ($context eq 'coursedoc') {
! 8669: my $result =
! 8670: &Apache::lonnet::userfileupload('embedded_item_'.$i,'coursedoc',
! 8671: $dirpath.'/'.$path);
! 8672: if ($result !~ m|^/uploaded/|) {
! 8673: $output .= '<span class="LC_error">'
! 8674: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
! 8675: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
! 8676: .'</span><br />';
! 8677: next;
! 8678: } else {
! 8679: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
! 8680: $path.$fname.'</span>').'<br />';
! 8681: }
1.661 raeburn 8682: } else {
8683: # Save the file
8684: my $target = $env{'form.embedded_item_'.$i};
8685: my $fullpath = $dir_root.$dirpath.'/'.$path;
8686: my $dest = $fullpath.$fname;
8687: my $url = $url_root.$dirpath.'/'.$path.$fname;
8688: my @parts=split(/\//,$fullpath);
8689: my $count;
8690: my $filepath = $dir_root;
8691: for ($count=4;$count<=$#parts;$count++) {
8692: $filepath .= "/$parts[$count]";
8693: if ((-e $filepath)!=1) {
8694: mkdir($filepath,0770);
8695: }
8696: }
8697: my $fh;
8698: if (!open($fh,'>'.$dest)) {
8699: &Apache::lonnet::logthis('Failed to create '.$dest);
8700: $output .= '<span class="LC_error">'.
8701: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8702: '</span><br />';
8703: } else {
8704: if (!print $fh $env{'form.embedded_item_'.$i}) {
8705: &Apache::lonnet::logthis('Failed to write to '.$dest);
8706: $output .= '<span class="LC_error">'.
8707: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8708: '</span><br />';
8709: } else {
1.987 ! raeburn 8710: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
! 8711: $url.'</span>').'<br />';
! 8712: unless ($context eq 'testbank') {
! 8713: $footer .= &mt('View embedded file: [_1]',
! 8714: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
! 8715: }
! 8716: }
! 8717: close($fh);
! 8718: }
! 8719: }
! 8720: if ($env{'form.embedded_ref_'.$i}) {
! 8721: $pathchange{$i} = 1;
! 8722: }
! 8723: }
! 8724: if ($output) {
! 8725: $output = '<p>'.$output.'</p>';
! 8726: }
! 8727: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
! 8728: $returnflag = 'ok';
! 8729: if (keys(%pathchange) > 0) {
! 8730: if ($context eq 'portfolio') {
! 8731: $output .= '<p>'.&mt('or').'</p>';
! 8732: } elsif ($context eq 'testbank') {
! 8733: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the references(s).','<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
! 8734: $returnflag = 'modify_orightml';
! 8735: }
! 8736: }
! 8737: return ($output.$footer,$returnflag);
! 8738: }
! 8739:
! 8740: sub modify_html_form {
! 8741: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
! 8742: my $end = 0;
! 8743: my $modifyform;
! 8744: if ($context eq 'upload_embedded') {
! 8745: return unless (ref($pathchange) eq 'HASH');
! 8746: if ($env{'form.number_embedded_items'}) {
! 8747: $end += $env{'form.number_embedded_items'};
! 8748: }
! 8749: if ($env{'form.number_pathchange_items'}) {
! 8750: $end += $env{'form.number_pathchange_items'};
! 8751: }
! 8752: if ($end) {
! 8753: for (my $i=0; $i<$end; $i++) {
! 8754: if ($i < $env{'form.number_embedded_items'}) {
! 8755: next unless($pathchange->{$i});
! 8756: }
! 8757: $modifyform .=
! 8758: &start_data_table_row().
! 8759: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
! 8760: 'checked="checked" /></td>'.
! 8761: '<td>'.$env{'form.embedded_ref_'.$i}.
! 8762: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
! 8763: &escape($env{'form.embedded_ref_'.$i}).'" />'.
! 8764: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
! 8765: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
! 8766: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
! 8767: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
! 8768: '<td>'.$env{'form.embedded_orig_'.$i}.
! 8769: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
! 8770: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
! 8771: &end_data_table_row();
! 8772: }
! 8773: }
! 8774: } else {
! 8775: $modifyform = $pathchgtable;
! 8776: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
! 8777: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
! 8778: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
! 8779: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
! 8780: }
! 8781: }
! 8782: if ($modifyform) {
! 8783: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
! 8784: '<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".
! 8785: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
! 8786: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
! 8787: '</ol></p>'."\n".'<p>'.
! 8788: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
! 8789: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
! 8790: &start_data_table()."\n".
! 8791: &start_data_table_header_row().
! 8792: '<th>'.&mt('Change?').'</th>'.
! 8793: '<th>'.&mt('Current reference').'</th>'.
! 8794: '<th>'.&mt('Required reference').'</th>'.
! 8795: &end_data_table_header_row()."\n".
! 8796: $modifyform.
! 8797: &end_data_table().'<br />'."\n".$hiddenstate.
! 8798: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
! 8799: '</form>'."\n";
! 8800: }
! 8801: return;
! 8802: }
! 8803:
! 8804: sub modify_html_refs {
! 8805: my ($context,$dirpath,$uname,$udom,$dir_root) = @_;
! 8806: my $container;
! 8807: if ($context eq 'portfolio') {
! 8808: $container = $env{'form.container'};
! 8809: } elsif ($context eq 'coursedoc') {
! 8810: $container = $env{'form.primaryurl'};
! 8811: } else {
! 8812: $container = $env{'form.filename'};
! 8813: $container =~ s{^/priv/(\Q$uname\E)/(.*)}{/home/$1/public_html/$2};
! 8814: }
! 8815: my (%allfiles,%codebase,$output,$content);
! 8816: my @changes = &get_env_multiple('form.namechange');
! 8817: return unless (@changes > 0);
! 8818: if (($context eq 'portfolio') || ($context eq 'coursedoc')) {
! 8819: return unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/});
! 8820: $content = &Apache::lonnet::getfile($container);
! 8821: return if ($content eq '-1');
! 8822: } else {
! 8823: return unless ($container =~ /^\Q$dir_root\E/);
! 8824: if (open(my $fh,"<$container")) {
! 8825: $content = join('', <$fh>);
! 8826: close($fh);
! 8827: } else {
! 8828: return;
! 8829: }
! 8830: }
! 8831: my ($count,$codebasecount) = (0,0);
! 8832: my $mm = new File::MMagic;
! 8833: my $mime_type = $mm->checktype_contents($content);
! 8834: if ($mime_type eq 'text/html') {
! 8835: my $parse_result =
! 8836: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
! 8837: \%codebase,\$content);
! 8838: if ($parse_result eq 'ok') {
! 8839: foreach my $i (@changes) {
! 8840: my $orig = &unescape($env{'form.embedded_orig_'.$i});
! 8841: my $ref = &unescape($env{'form.embedded_ref_'.$i});
! 8842: if ($allfiles{$ref}) {
! 8843: my $newname = $orig;
! 8844: my ($attrib_regexp,$codebase);
! 8845: my $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
! 8846: if ($attrib_regexp =~ /:/) {
! 8847: $attrib_regexp =~ s/\:/|/g;
! 8848: }
! 8849: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
! 8850: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
! 8851: $count += $numchg;
! 8852: }
! 8853: if ($env{'form.embedded_codebase_'.$i} ne '') {
! 8854: my $codebase = &unescape($env{'form.embedded_codebase_'.$i});
! 8855: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
! 8856: $codebasecount ++;
! 8857: }
! 8858: }
! 8859: }
! 8860: if ($count || $codebasecount) {
! 8861: my $saveresult;
! 8862: if ($context eq 'portfolio' || $context eq 'coursedoc') {
! 8863: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
! 8864: if ($url eq $container) {
! 8865: my ($fname) = ($container =~ m{/([^/]+)$});
! 8866: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
! 8867: $count,'<span class="LC_filename">'.
! 8868: $fname.'</span>').'</p>';
! 8869: } else {
! 8870: $output = '<p class="LC_error">'.
! 8871: &mt('Error: update failed for: [_1].',
! 8872: '<span class="LC_filename">'.
! 8873: $container.'</span>').'</p>';
! 8874: }
! 8875: } else {
! 8876: if (open(my $fh,">$container")) {
! 8877: print $fh $content;
! 8878: close($fh);
! 8879: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
! 8880: $count,'<span class="LC_filename">'.
! 8881: $container.'</span>').'</p>';
1.661 raeburn 8882: } else {
1.987 ! raeburn 8883: $output = '<p class="LC_error">'.
! 8884: &mt('Error: could not update [_1].',
! 8885: '<span class="LC_filename">'.
! 8886: $container.'</span>').'</p>';
1.661 raeburn 8887: }
8888: }
8889: }
1.987 ! raeburn 8890: } else {
! 8891: &logthis('Failed to parse '.$container.
! 8892: ' to modify references: '.$parse_result);
1.661 raeburn 8893: }
8894: }
8895: return $output;
8896: }
8897:
8898: sub check_for_existing {
8899: my ($path,$fname,$element) = @_;
8900: my ($state,$msg);
8901: if (-d $path.'/'.$fname) {
8902: $state = 'exists';
8903: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8904: } elsif (-e $path.'/'.$fname) {
8905: $state = 'exists';
8906: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8907: }
8908: if ($state eq 'exists') {
8909: $msg = '<span class="LC_error">'.$msg.'</span><br />';
8910: }
8911: return ($state,$msg);
8912: }
8913:
8914: sub check_for_upload {
8915: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
8916: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 8917: my $filesize = length($env{'form.'.$element});
8918: if (!$filesize) {
8919: my $msg = '<span class="LC_error">'.
8920: &mt('Unable to upload [_1]. (size = [_2] bytes)',
8921: '<span class="LC_filename">'.$fname.'</span>',
8922: $filesize).'<br />'.
8923: &mt('Either the file you uploaded was empty, or your web browser was unable to read its contents.').'<br />';
8924: '</span>';
8925: return ('zero_bytes',$msg);
8926: }
8927: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 8928: my $getpropath = 1;
8929: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
8930: $getpropath);
8931: my $found_file = 0;
8932: my $locked_file = 0;
8933: foreach my $line (@dir_list) {
1.984 raeburn 8934: my ($file_name,$rest)=split(/\&/,$line,2);
1.661 raeburn 8935: if ($file_name eq $fname){
8936: $file_name = $path.$file_name;
8937: if ($group ne '') {
8938: $file_name = $group.$file_name;
8939: }
8940: $found_file = 1;
8941: if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
8942: $locked_file = 1;
1.984 raeburn 8943: } else {
8944: my @info = split(/\&/,$rest);
8945: my $currsize = $info[6]/1000;
8946: if ($currsize < $filesize) {
8947: my $extra = $filesize - $currsize;
8948: if (($current_disk_usage + $extra) > $disk_quota) {
8949: my $msg = '<span class="LC_error">'.
8950: &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.',
8951: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</span>'.
8952: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
8953: $disk_quota,$current_disk_usage);
8954: return ('will_exceed_quota',$msg);
8955: }
8956: }
1.661 raeburn 8957: }
8958: }
8959: }
8960: if (($current_disk_usage + $filesize) > $disk_quota){
8961: my $msg = '<span class="LC_error">'.
8962: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
8963: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
8964: return ('will_exceed_quota',$msg);
8965: } elsif ($found_file) {
8966: if ($locked_file) {
8967: my $msg = '<span class="LC_error">';
8968: $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>');
8969: $msg .= '</span><br />';
8970: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
8971: return ('file_locked',$msg);
8972: } else {
8973: my $msg = '<span class="LC_error">';
1.984 raeburn 8974: $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 8975: $msg .= '</span>';
1.984 raeburn 8976: return ('existingfile',$msg);
1.661 raeburn 8977: }
8978: }
8979: }
8980:
1.987 ! raeburn 8981: sub check_for_traversal {
! 8982: my ($path,$url,$toplevel) = @_;
! 8983: my @parts=split(/\//,$path);
! 8984: my $cleanpath;
! 8985: my $fullpath = $url;
! 8986: for (my $i=0;$i<@parts;$i++) {
! 8987: next if ($parts[$i] eq '.');
! 8988: if ($parts[$i] eq '..') {
! 8989: $fullpath =~ s{([^/]+/)$}{};
! 8990: } else {
! 8991: $fullpath .= $parts[$i].'/';
! 8992: }
! 8993: }
! 8994: if ($fullpath =~ /^\Q$url\E(.*)$/) {
! 8995: $cleanpath = $1;
! 8996: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
! 8997: my $curr_toprel = $1;
! 8998: my @parts = split(/\//,$curr_toprel);
! 8999: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
! 9000: my @urlparts = split(/\//,$url_toprel);
! 9001: my $doubledots;
! 9002: my $startdiff = -1;
! 9003: for (my $i=0; $i<@urlparts; $i++) {
! 9004: if ($startdiff == -1) {
! 9005: unless ($urlparts[$i] eq $parts[$i]) {
! 9006: $startdiff = $i;
! 9007: $doubledots .= '../';
! 9008: }
! 9009: } else {
! 9010: $doubledots .= '../';
! 9011: }
! 9012: }
! 9013: if ($startdiff > -1) {
! 9014: $cleanpath = $doubledots;
! 9015: for (my $i=$startdiff; $i<@parts; $i++) {
! 9016: $cleanpath .= $parts[$i].'/';
! 9017: }
! 9018: }
! 9019: }
! 9020: $cleanpath =~ s{(/)$}{};
! 9021: return $cleanpath;
! 9022: }
1.31 albertel 9023:
1.41 ng 9024: =pod
1.45 matthew 9025:
1.464 albertel 9026: =back
1.41 ng 9027:
1.112 bowersj2 9028: =head1 CSV Upload/Handling functions
1.38 albertel 9029:
1.41 ng 9030: =over 4
9031:
1.648 raeburn 9032: =item * &upfile_store($r)
1.41 ng 9033:
9034: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 9035: needs $env{'form.upfile'}
1.41 ng 9036: returns $datatoken to be put into hidden field
9037:
9038: =cut
1.31 albertel 9039:
9040: sub upfile_store {
9041: my $r=shift;
1.258 albertel 9042: $env{'form.upfile'}=~s/\r/\n/gs;
9043: $env{'form.upfile'}=~s/\f/\n/gs;
9044: $env{'form.upfile'}=~s/\n+/\n/gs;
9045: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 9046:
1.258 albertel 9047: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
9048: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 9049: {
1.158 raeburn 9050: my $datafile = $r->dir_config('lonDaemons').
9051: '/tmp/'.$datatoken.'.tmp';
9052: if ( open(my $fh,">$datafile") ) {
1.258 albertel 9053: print $fh $env{'form.upfile'};
1.158 raeburn 9054: close($fh);
9055: }
1.31 albertel 9056: }
9057: return $datatoken;
9058: }
9059:
1.56 matthew 9060: =pod
9061:
1.648 raeburn 9062: =item * &load_tmp_file($r)
1.41 ng 9063:
9064: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 9065: needs $env{'form.datatoken'},
9066: sets $env{'form.upfile'} to the contents of the file
1.41 ng 9067:
9068: =cut
1.31 albertel 9069:
9070: sub load_tmp_file {
9071: my $r=shift;
9072: my @studentdata=();
9073: {
1.158 raeburn 9074: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 9075: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 9076: if ( open(my $fh,"<$studentfile") ) {
9077: @studentdata=<$fh>;
9078: close($fh);
9079: }
1.31 albertel 9080: }
1.258 albertel 9081: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 9082: }
9083:
1.56 matthew 9084: =pod
9085:
1.648 raeburn 9086: =item * &upfile_record_sep()
1.41 ng 9087:
9088: Separate uploaded file into records
9089: returns array of records,
1.258 albertel 9090: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 9091:
9092: =cut
1.31 albertel 9093:
9094: sub upfile_record_sep {
1.258 albertel 9095: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 9096: } else {
1.248 albertel 9097: my @records;
1.258 albertel 9098: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 9099: if ($line=~/^\s*$/) { next; }
9100: push(@records,$line);
9101: }
9102: return @records;
1.31 albertel 9103: }
9104: }
9105:
1.56 matthew 9106: =pod
9107:
1.648 raeburn 9108: =item * &record_sep($record)
1.41 ng 9109:
1.258 albertel 9110: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 9111:
9112: =cut
9113:
1.263 www 9114: sub takeleft {
9115: my $index=shift;
9116: return substr('0000'.$index,-4,4);
9117: }
9118:
1.31 albertel 9119: sub record_sep {
9120: my $record=shift;
9121: my %components=();
1.258 albertel 9122: if ($env{'form.upfiletype'} eq 'xml') {
9123: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 9124: my $i=0;
1.356 albertel 9125: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 9126: $field=~s/^(\"|\')//;
9127: $field=~s/(\"|\')$//;
1.263 www 9128: $components{&takeleft($i)}=$field;
1.31 albertel 9129: $i++;
9130: }
1.258 albertel 9131: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 9132: my $i=0;
1.356 albertel 9133: foreach my $field (split(/\t/,$record)) {
1.31 albertel 9134: $field=~s/^(\"|\')//;
9135: $field=~s/(\"|\')$//;
1.263 www 9136: $components{&takeleft($i)}=$field;
1.31 albertel 9137: $i++;
9138: }
9139: } else {
1.561 www 9140: my $separator=',';
1.480 banghart 9141: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 9142: $separator=';';
1.480 banghart 9143: }
1.31 albertel 9144: my $i=0;
1.561 www 9145: # the character we are looking for to indicate the end of a quote or a record
9146: my $looking_for=$separator;
9147: # do not add the characters to the fields
9148: my $ignore=0;
9149: # we just encountered a separator (or the beginning of the record)
9150: my $just_found_separator=1;
9151: # store the field we are working on here
9152: my $field='';
9153: # work our way through all characters in record
9154: foreach my $character ($record=~/(.)/g) {
9155: if ($character eq $looking_for) {
9156: if ($character ne $separator) {
9157: # Found the end of a quote, again looking for separator
9158: $looking_for=$separator;
9159: $ignore=1;
9160: } else {
9161: # Found a separator, store away what we got
9162: $components{&takeleft($i)}=$field;
9163: $i++;
9164: $just_found_separator=1;
9165: $ignore=0;
9166: $field='';
9167: }
9168: next;
9169: }
9170: # single or double quotation marks after a separator indicate beginning of a quote
9171: # we are now looking for the end of the quote and need to ignore separators
9172: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
9173: $looking_for=$character;
9174: next;
9175: }
9176: # ignore would be true after we reached the end of a quote
9177: if ($ignore) { next; }
9178: if (($just_found_separator) && ($character=~/\s/)) { next; }
9179: $field.=$character;
9180: $just_found_separator=0;
1.31 albertel 9181: }
1.561 www 9182: # catch the very last entry, since we never encountered the separator
9183: $components{&takeleft($i)}=$field;
1.31 albertel 9184: }
9185: return %components;
9186: }
9187:
1.144 matthew 9188: ######################################################
9189: ######################################################
9190:
1.56 matthew 9191: =pod
9192:
1.648 raeburn 9193: =item * &upfile_select_html()
1.41 ng 9194:
1.144 matthew 9195: Return HTML code to select a file from the users machine and specify
9196: the file type.
1.41 ng 9197:
9198: =cut
9199:
1.144 matthew 9200: ######################################################
9201: ######################################################
1.31 albertel 9202: sub upfile_select_html {
1.144 matthew 9203: my %Types = (
9204: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 9205: semisv => &mt('Semicolon separated values'),
1.144 matthew 9206: space => &mt('Space separated'),
9207: tab => &mt('Tabulator separated'),
9208: # xml => &mt('HTML/XML'),
9209: );
9210: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 9211: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 9212: foreach my $type (sort(keys(%Types))) {
9213: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
9214: }
9215: $Str .= "</select>\n";
9216: return $Str;
1.31 albertel 9217: }
9218:
1.301 albertel 9219: sub get_samples {
9220: my ($records,$toget) = @_;
9221: my @samples=({});
9222: my $got=0;
9223: foreach my $rec (@$records) {
9224: my %temp = &record_sep($rec);
9225: if (! grep(/\S/, values(%temp))) { next; }
9226: if (%temp) {
9227: $samples[$got]=\%temp;
9228: $got++;
9229: if ($got == $toget) { last; }
9230: }
9231: }
9232: return \@samples;
9233: }
9234:
1.144 matthew 9235: ######################################################
9236: ######################################################
9237:
1.56 matthew 9238: =pod
9239:
1.648 raeburn 9240: =item * &csv_print_samples($r,$records)
1.41 ng 9241:
9242: Prints a table of sample values from each column uploaded $r is an
9243: Apache Request ref, $records is an arrayref from
9244: &Apache::loncommon::upfile_record_sep
9245:
9246: =cut
9247:
1.144 matthew 9248: ######################################################
9249: ######################################################
1.31 albertel 9250: sub csv_print_samples {
9251: my ($r,$records) = @_;
1.662 bisitz 9252: my $samples = &get_samples($records,5);
1.301 albertel 9253:
1.594 raeburn 9254: $r->print(&mt('Samples').'<br />'.&start_data_table().
9255: &start_data_table_header_row());
1.356 albertel 9256: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 9257: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 9258: $r->print(&end_data_table_header_row());
1.301 albertel 9259: foreach my $hash (@$samples) {
1.594 raeburn 9260: $r->print(&start_data_table_row());
1.356 albertel 9261: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 9262: $r->print('<td>');
1.356 albertel 9263: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 9264: $r->print('</td>');
9265: }
1.594 raeburn 9266: $r->print(&end_data_table_row());
1.31 albertel 9267: }
1.594 raeburn 9268: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 9269: }
9270:
1.144 matthew 9271: ######################################################
9272: ######################################################
9273:
1.56 matthew 9274: =pod
9275:
1.648 raeburn 9276: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 9277:
9278: Prints a table to create associations between values and table columns.
1.144 matthew 9279:
1.41 ng 9280: $r is an Apache Request ref,
9281: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 9282: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 9283:
9284: =cut
9285:
1.144 matthew 9286: ######################################################
9287: ######################################################
1.31 albertel 9288: sub csv_print_select_table {
9289: my ($r,$records,$d) = @_;
1.301 albertel 9290: my $i=0;
9291: my $samples = &get_samples($records,1);
1.144 matthew 9292: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 9293: &start_data_table().&start_data_table_header_row().
1.144 matthew 9294: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 9295: '<th>'.&mt('Column').'</th>'.
9296: &end_data_table_header_row()."\n");
1.356 albertel 9297: foreach my $array_ref (@$d) {
9298: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 9299: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 9300:
1.875 bisitz 9301: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 9302: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 9303: $r->print('<option value="none"></option>');
1.356 albertel 9304: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
9305: $r->print('<option value="'.$sample.'"'.
9306: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 9307: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 9308: }
1.594 raeburn 9309: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 9310: $i++;
9311: }
1.594 raeburn 9312: $r->print(&end_data_table());
1.31 albertel 9313: $i--;
9314: return $i;
9315: }
1.56 matthew 9316:
1.144 matthew 9317: ######################################################
9318: ######################################################
9319:
1.56 matthew 9320: =pod
1.31 albertel 9321:
1.648 raeburn 9322: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 9323:
9324: Prints a table of sample values from the upload and can make associate samples to internal names.
9325:
9326: $r is an Apache Request ref,
9327: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
9328: $d is an array of 2 element arrays (internal name, displayed name)
9329:
9330: =cut
9331:
1.144 matthew 9332: ######################################################
9333: ######################################################
1.31 albertel 9334: sub csv_samples_select_table {
9335: my ($r,$records,$d) = @_;
9336: my $i=0;
1.144 matthew 9337: #
1.662 bisitz 9338: my $max_samples = 5;
9339: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 9340: $r->print(&start_data_table().
9341: &start_data_table_header_row().'<th>'.
9342: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
9343: &end_data_table_header_row());
1.301 albertel 9344:
9345: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 9346: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 9347: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 9348: foreach my $option (@$d) {
9349: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 9350: $r->print('<option value="'.$value.'"'.
1.253 albertel 9351: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 9352: $display.'</option>');
1.31 albertel 9353: }
9354: $r->print('</select></td><td>');
1.662 bisitz 9355: foreach my $line (0..($max_samples-1)) {
1.301 albertel 9356: if (defined($samples->[$line]{$key})) {
9357: $r->print($samples->[$line]{$key}."<br />\n");
9358: }
9359: }
1.594 raeburn 9360: $r->print('</td>'.&end_data_table_row());
1.31 albertel 9361: $i++;
9362: }
1.594 raeburn 9363: $r->print(&end_data_table());
1.31 albertel 9364: $i--;
9365: return($i);
1.115 matthew 9366: }
9367:
1.144 matthew 9368: ######################################################
9369: ######################################################
9370:
1.115 matthew 9371: =pod
9372:
1.648 raeburn 9373: =item * &clean_excel_name($name)
1.115 matthew 9374:
9375: Returns a replacement for $name which does not contain any illegal characters.
9376:
9377: =cut
9378:
1.144 matthew 9379: ######################################################
9380: ######################################################
1.115 matthew 9381: sub clean_excel_name {
9382: my ($name) = @_;
9383: $name =~ s/[:\*\?\/\\]//g;
9384: if (length($name) > 31) {
9385: $name = substr($name,0,31);
9386: }
9387: return $name;
1.25 albertel 9388: }
1.84 albertel 9389:
1.85 albertel 9390: =pod
9391:
1.648 raeburn 9392: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 9393:
9394: Returns either 1 or undef
9395:
9396: 1 if the part is to be hidden, undef if it is to be shown
9397:
9398: Arguments are:
9399:
9400: $id the id of the part to be checked
9401: $symb, optional the symb of the resource to check
9402: $udom, optional the domain of the user to check for
9403: $uname, optional the username of the user to check for
9404:
9405: =cut
1.84 albertel 9406:
9407: sub check_if_partid_hidden {
9408: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 9409: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 9410: $symb,$udom,$uname);
1.141 albertel 9411: my $truth=1;
9412: #if the string starts with !, then the list is the list to show not hide
9413: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 9414: my @hiddenlist=split(/,/,$hiddenparts);
9415: foreach my $checkid (@hiddenlist) {
1.141 albertel 9416: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 9417: }
1.141 albertel 9418: return !$truth;
1.84 albertel 9419: }
1.127 matthew 9420:
1.138 matthew 9421:
9422: ############################################################
9423: ############################################################
9424:
9425: =pod
9426:
1.157 matthew 9427: =back
9428:
1.138 matthew 9429: =head1 cgi-bin script and graphing routines
9430:
1.157 matthew 9431: =over 4
9432:
1.648 raeburn 9433: =item * &get_cgi_id()
1.138 matthew 9434:
9435: Inputs: none
9436:
9437: Returns an id which can be used to pass environment variables
9438: to various cgi-bin scripts. These environment variables will
9439: be removed from the users environment after a given time by
9440: the routine &Apache::lonnet::transfer_profile_to_env.
9441:
9442: =cut
9443:
9444: ############################################################
9445: ############################################################
1.152 albertel 9446: my $uniq=0;
1.136 matthew 9447: sub get_cgi_id {
1.154 albertel 9448: $uniq=($uniq+1)%100000;
1.280 albertel 9449: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 9450: }
9451:
1.127 matthew 9452: ############################################################
9453: ############################################################
9454:
9455: =pod
9456:
1.648 raeburn 9457: =item * &DrawBarGraph()
1.127 matthew 9458:
1.138 matthew 9459: Facilitates the plotting of data in a (stacked) bar graph.
9460: Puts plot definition data into the users environment in order for
9461: graph.png to plot it. Returns an <img> tag for the plot.
9462: The bars on the plot are labeled '1','2',...,'n'.
9463:
9464: Inputs:
9465:
9466: =over 4
9467:
9468: =item $Title: string, the title of the plot
9469:
9470: =item $xlabel: string, text describing the X-axis of the plot
9471:
9472: =item $ylabel: string, text describing the Y-axis of the plot
9473:
9474: =item $Max: scalar, the maximum Y value to use in the plot
9475: If $Max is < any data point, the graph will not be rendered.
9476:
1.140 matthew 9477: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 9478: they are plotted. If undefined, default values will be used.
9479:
1.178 matthew 9480: =item $labels: array ref holding the labels to use on the x-axis for the bars.
9481:
1.138 matthew 9482: =item @Values: An array of array references. Each array reference holds data
9483: to be plotted in a stacked bar chart.
9484:
1.239 matthew 9485: =item If the final element of @Values is a hash reference the key/value
9486: pairs will be added to the graph definition.
9487:
1.138 matthew 9488: =back
9489:
9490: Returns:
9491:
9492: An <img> tag which references graph.png and the appropriate identifying
9493: information for the plot.
9494:
1.127 matthew 9495: =cut
9496:
9497: ############################################################
9498: ############################################################
1.134 matthew 9499: sub DrawBarGraph {
1.178 matthew 9500: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 9501: #
9502: if (! defined($colors)) {
9503: $colors = ['#33ff00',
9504: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
9505: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
9506: ];
9507: }
1.228 matthew 9508: my $extra_settings = {};
9509: if (ref($Values[-1]) eq 'HASH') {
9510: $extra_settings = pop(@Values);
9511: }
1.127 matthew 9512: #
1.136 matthew 9513: my $identifier = &get_cgi_id();
9514: my $id = 'cgi.'.$identifier;
1.129 matthew 9515: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 9516: return '';
9517: }
1.225 matthew 9518: #
9519: my @Labels;
9520: if (defined($labels)) {
9521: @Labels = @$labels;
9522: } else {
9523: for (my $i=0;$i<@{$Values[0]};$i++) {
9524: push (@Labels,$i+1);
9525: }
9526: }
9527: #
1.129 matthew 9528: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 9529: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 9530: my %ValuesHash;
9531: my $NumSets=1;
9532: foreach my $array (@Values) {
9533: next if (! ref($array));
1.136 matthew 9534: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 9535: join(',',@$array);
1.129 matthew 9536: }
1.127 matthew 9537: #
1.136 matthew 9538: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 9539: if ($NumBars < 3) {
9540: $width = 120+$NumBars*32;
1.220 matthew 9541: $xskip = 1;
1.225 matthew 9542: $bar_width = 30;
9543: } elsif ($NumBars < 5) {
9544: $width = 120+$NumBars*20;
9545: $xskip = 1;
9546: $bar_width = 20;
1.220 matthew 9547: } elsif ($NumBars < 10) {
1.136 matthew 9548: $width = 120+$NumBars*15;
9549: $xskip = 1;
9550: $bar_width = 15;
9551: } elsif ($NumBars <= 25) {
9552: $width = 120+$NumBars*11;
9553: $xskip = 5;
9554: $bar_width = 8;
9555: } elsif ($NumBars <= 50) {
9556: $width = 120+$NumBars*8;
9557: $xskip = 5;
9558: $bar_width = 4;
9559: } else {
9560: $width = 120+$NumBars*8;
9561: $xskip = 5;
9562: $bar_width = 4;
9563: }
9564: #
1.137 matthew 9565: $Max = 1 if ($Max < 1);
9566: if ( int($Max) < $Max ) {
9567: $Max++;
9568: $Max = int($Max);
9569: }
1.127 matthew 9570: $Title = '' if (! defined($Title));
9571: $xlabel = '' if (! defined($xlabel));
9572: $ylabel = '' if (! defined($ylabel));
1.369 www 9573: $ValuesHash{$id.'.title'} = &escape($Title);
9574: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
9575: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 9576: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 9577: $ValuesHash{$id.'.NumBars'} = $NumBars;
9578: $ValuesHash{$id.'.NumSets'} = $NumSets;
9579: $ValuesHash{$id.'.PlotType'} = 'bar';
9580: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9581: $ValuesHash{$id.'.height'} = $height;
9582: $ValuesHash{$id.'.width'} = $width;
9583: $ValuesHash{$id.'.xskip'} = $xskip;
9584: $ValuesHash{$id.'.bar_width'} = $bar_width;
9585: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 9586: #
1.228 matthew 9587: # Deal with other parameters
9588: while (my ($key,$value) = each(%$extra_settings)) {
9589: $ValuesHash{$id.'.'.$key} = $value;
9590: }
9591: #
1.646 raeburn 9592: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 9593: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9594: }
9595:
9596: ############################################################
9597: ############################################################
9598:
9599: =pod
9600:
1.648 raeburn 9601: =item * &DrawXYGraph()
1.137 matthew 9602:
1.138 matthew 9603: Facilitates the plotting of data in an XY graph.
9604: Puts plot definition data into the users environment in order for
9605: graph.png to plot it. Returns an <img> tag for the plot.
9606:
9607: Inputs:
9608:
9609: =over 4
9610:
9611: =item $Title: string, the title of the plot
9612:
9613: =item $xlabel: string, text describing the X-axis of the plot
9614:
9615: =item $ylabel: string, text describing the Y-axis of the plot
9616:
9617: =item $Max: scalar, the maximum Y value to use in the plot
9618: If $Max is < any data point, the graph will not be rendered.
9619:
9620: =item $colors: Array ref containing the hex color codes for the data to be
9621: plotted in. If undefined, default values will be used.
9622:
9623: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9624:
9625: =item $Ydata: Array ref containing Array refs.
1.185 www 9626: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 9627:
9628: =item %Values: hash indicating or overriding any default values which are
9629: passed to graph.png.
9630: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9631:
9632: =back
9633:
9634: Returns:
9635:
9636: An <img> tag which references graph.png and the appropriate identifying
9637: information for the plot.
9638:
1.137 matthew 9639: =cut
9640:
9641: ############################################################
9642: ############################################################
9643: sub DrawXYGraph {
9644: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
9645: #
9646: # Create the identifier for the graph
9647: my $identifier = &get_cgi_id();
9648: my $id = 'cgi.'.$identifier;
9649: #
9650: $Title = '' if (! defined($Title));
9651: $xlabel = '' if (! defined($xlabel));
9652: $ylabel = '' if (! defined($ylabel));
9653: my %ValuesHash =
9654: (
1.369 www 9655: $id.'.title' => &escape($Title),
9656: $id.'.xlabel' => &escape($xlabel),
9657: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 9658: $id.'.y_max_value'=> $Max,
9659: $id.'.labels' => join(',',@$Xlabels),
9660: $id.'.PlotType' => 'XY',
9661: );
9662: #
9663: if (defined($colors) && ref($colors) eq 'ARRAY') {
9664: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9665: }
9666: #
9667: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
9668: return '';
9669: }
9670: my $NumSets=1;
1.138 matthew 9671: foreach my $array (@{$Ydata}){
1.137 matthew 9672: next if (! ref($array));
9673: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
9674: }
1.138 matthew 9675: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 9676: #
9677: # Deal with other parameters
9678: while (my ($key,$value) = each(%Values)) {
9679: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 9680: }
9681: #
1.646 raeburn 9682: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 9683: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9684: }
9685:
9686: ############################################################
9687: ############################################################
9688:
9689: =pod
9690:
1.648 raeburn 9691: =item * &DrawXYYGraph()
1.138 matthew 9692:
9693: Facilitates the plotting of data in an XY graph with two Y axes.
9694: Puts plot definition data into the users environment in order for
9695: graph.png to plot it. Returns an <img> tag for the plot.
9696:
9697: Inputs:
9698:
9699: =over 4
9700:
9701: =item $Title: string, the title of the plot
9702:
9703: =item $xlabel: string, text describing the X-axis of the plot
9704:
9705: =item $ylabel: string, text describing the Y-axis of the plot
9706:
9707: =item $colors: Array ref containing the hex color codes for the data to be
9708: plotted in. If undefined, default values will be used.
9709:
9710: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9711:
9712: =item $Ydata1: The first data set
9713:
9714: =item $Min1: The minimum value of the left Y-axis
9715:
9716: =item $Max1: The maximum value of the left Y-axis
9717:
9718: =item $Ydata2: The second data set
9719:
9720: =item $Min2: The minimum value of the right Y-axis
9721:
9722: =item $Max2: The maximum value of the left Y-axis
9723:
9724: =item %Values: hash indicating or overriding any default values which are
9725: passed to graph.png.
9726: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9727:
9728: =back
9729:
9730: Returns:
9731:
9732: An <img> tag which references graph.png and the appropriate identifying
9733: information for the plot.
1.136 matthew 9734:
9735: =cut
9736:
9737: ############################################################
9738: ############################################################
1.137 matthew 9739: sub DrawXYYGraph {
9740: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
9741: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 9742: #
9743: # Create the identifier for the graph
9744: my $identifier = &get_cgi_id();
9745: my $id = 'cgi.'.$identifier;
9746: #
9747: $Title = '' if (! defined($Title));
9748: $xlabel = '' if (! defined($xlabel));
9749: $ylabel = '' if (! defined($ylabel));
9750: my %ValuesHash =
9751: (
1.369 www 9752: $id.'.title' => &escape($Title),
9753: $id.'.xlabel' => &escape($xlabel),
9754: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 9755: $id.'.labels' => join(',',@$Xlabels),
9756: $id.'.PlotType' => 'XY',
9757: $id.'.NumSets' => 2,
1.137 matthew 9758: $id.'.two_axes' => 1,
9759: $id.'.y1_max_value' => $Max1,
9760: $id.'.y1_min_value' => $Min1,
9761: $id.'.y2_max_value' => $Max2,
9762: $id.'.y2_min_value' => $Min2,
1.136 matthew 9763: );
9764: #
1.137 matthew 9765: if (defined($colors) && ref($colors) eq 'ARRAY') {
9766: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9767: }
9768: #
9769: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
9770: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 9771: return '';
9772: }
9773: my $NumSets=1;
1.137 matthew 9774: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 9775: next if (! ref($array));
9776: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 9777: }
9778: #
9779: # Deal with other parameters
9780: while (my ($key,$value) = each(%Values)) {
9781: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 9782: }
9783: #
1.646 raeburn 9784: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 9785: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 9786: }
9787:
9788: ############################################################
9789: ############################################################
9790:
9791: =pod
9792:
1.157 matthew 9793: =back
9794:
1.139 matthew 9795: =head1 Statistics helper routines?
9796:
9797: Bad place for them but what the hell.
9798:
1.157 matthew 9799: =over 4
9800:
1.648 raeburn 9801: =item * &chartlink()
1.139 matthew 9802:
9803: Returns a link to the chart for a specific student.
9804:
9805: Inputs:
9806:
9807: =over 4
9808:
9809: =item $linktext: The text of the link
9810:
9811: =item $sname: The students username
9812:
9813: =item $sdomain: The students domain
9814:
9815: =back
9816:
1.157 matthew 9817: =back
9818:
1.139 matthew 9819: =cut
9820:
9821: ############################################################
9822: ############################################################
9823: sub chartlink {
9824: my ($linktext, $sname, $sdomain) = @_;
9825: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 9826: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 9827: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 9828: '">'.$linktext.'</a>';
1.153 matthew 9829: }
9830:
9831: #######################################################
9832: #######################################################
9833:
9834: =pod
9835:
9836: =head1 Course Environment Routines
1.157 matthew 9837:
9838: =over 4
1.153 matthew 9839:
1.648 raeburn 9840: =item * &restore_course_settings()
1.153 matthew 9841:
1.648 raeburn 9842: =item * &store_course_settings()
1.153 matthew 9843:
9844: Restores/Store indicated form parameters from the course environment.
9845: Will not overwrite existing values of the form parameters.
9846:
9847: Inputs:
9848: a scalar describing the data (e.g. 'chart', 'problem_analysis')
9849:
9850: a hash ref describing the data to be stored. For example:
9851:
9852: %Save_Parameters = ('Status' => 'scalar',
9853: 'chartoutputmode' => 'scalar',
9854: 'chartoutputdata' => 'scalar',
9855: 'Section' => 'array',
1.373 raeburn 9856: 'Group' => 'array',
1.153 matthew 9857: 'StudentData' => 'array',
9858: 'Maps' => 'array');
9859:
9860: Returns: both routines return nothing
9861:
1.631 raeburn 9862: =back
9863:
1.153 matthew 9864: =cut
9865:
9866: #######################################################
9867: #######################################################
9868: sub store_course_settings {
1.496 albertel 9869: return &store_settings($env{'request.course.id'},@_);
9870: }
9871:
9872: sub store_settings {
1.153 matthew 9873: # save to the environment
9874: # appenv the same items, just to be safe
1.300 albertel 9875: my $udom = $env{'user.domain'};
9876: my $uname = $env{'user.name'};
1.496 albertel 9877: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9878: my %SaveHash;
9879: my %AppHash;
9880: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 9881: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 9882: my $envname = 'environment.'.$basename;
1.258 albertel 9883: if (exists($env{'form.'.$setting})) {
1.153 matthew 9884: # Save this value away
9885: if ($type eq 'scalar' &&
1.258 albertel 9886: (! exists($env{$envname}) ||
9887: $env{$envname} ne $env{'form.'.$setting})) {
9888: $SaveHash{$basename} = $env{'form.'.$setting};
9889: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 9890: } elsif ($type eq 'array') {
9891: my $stored_form;
1.258 albertel 9892: if (ref($env{'form.'.$setting})) {
1.153 matthew 9893: $stored_form = join(',',
9894: map {
1.369 www 9895: &escape($_);
1.258 albertel 9896: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 9897: } else {
9898: $stored_form =
1.369 www 9899: &escape($env{'form.'.$setting});
1.153 matthew 9900: }
9901: # Determine if the array contents are the same.
1.258 albertel 9902: if ($stored_form ne $env{$envname}) {
1.153 matthew 9903: $SaveHash{$basename} = $stored_form;
9904: $AppHash{$envname} = $stored_form;
9905: }
9906: }
9907: }
9908: }
9909: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 9910: $udom,$uname);
1.153 matthew 9911: if ($put_result !~ /^(ok|delayed)/) {
9912: &Apache::lonnet::logthis('unable to save form parameters, '.
9913: 'got error:'.$put_result);
9914: }
9915: # Make sure these settings stick around in this session, too
1.646 raeburn 9916: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 9917: return;
9918: }
9919:
9920: sub restore_course_settings {
1.499 albertel 9921: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 9922: }
9923:
9924: sub restore_settings {
9925: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9926: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 9927: next if (exists($env{'form.'.$setting}));
1.496 albertel 9928: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 9929: '.'.$setting;
1.258 albertel 9930: if (exists($env{$envname})) {
1.153 matthew 9931: if ($type eq 'scalar') {
1.258 albertel 9932: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 9933: } elsif ($type eq 'array') {
1.258 albertel 9934: $env{'form.'.$setting} = [
1.153 matthew 9935: map {
1.369 www 9936: &unescape($_);
1.258 albertel 9937: } split(',',$env{$envname})
1.153 matthew 9938: ];
9939: }
9940: }
9941: }
1.127 matthew 9942: }
9943:
1.618 raeburn 9944: #######################################################
9945: #######################################################
9946:
9947: =pod
9948:
9949: =head1 Domain E-mail Routines
9950:
9951: =over 4
9952:
1.648 raeburn 9953: =item * &build_recipient_list()
1.618 raeburn 9954:
1.884 raeburn 9955: Build recipient lists for five types of e-mail:
1.766 raeburn 9956: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884 raeburn 9957: (d) Help requests, (e) Course requests needing approval, generated by
9958: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
9959: loncoursequeueadmin.pm respectively.
1.618 raeburn 9960:
9961: Inputs:
1.619 raeburn 9962: defmail (scalar - email address of default recipient),
1.618 raeburn 9963: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 9964: defdom (domain for which to retrieve configuration settings),
9965: origmail (scalar - email address of recipient from loncapa.conf,
9966: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 9967:
1.655 raeburn 9968: Returns: comma separated list of addresses to which to send e-mail.
9969:
9970: =back
1.618 raeburn 9971:
9972: =cut
9973:
9974: ############################################################
9975: ############################################################
9976: sub build_recipient_list {
1.619 raeburn 9977: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 9978: my @recipients;
9979: my $otheremails;
9980: my %domconfig =
9981: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
9982: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 9983: if (exists($domconfig{'contacts'}{$mailing})) {
9984: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
9985: my @contacts = ('adminemail','supportemail');
9986: foreach my $item (@contacts) {
9987: if ($domconfig{'contacts'}{$mailing}{$item}) {
9988: my $addr = $domconfig{'contacts'}{$item};
9989: if (!grep(/^\Q$addr\E$/,@recipients)) {
9990: push(@recipients,$addr);
9991: }
1.619 raeburn 9992: }
1.766 raeburn 9993: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 9994: }
9995: }
1.766 raeburn 9996: } elsif ($origmail ne '') {
9997: push(@recipients,$origmail);
1.618 raeburn 9998: }
1.619 raeburn 9999: } elsif ($origmail ne '') {
10000: push(@recipients,$origmail);
1.618 raeburn 10001: }
1.688 raeburn 10002: if (defined($defmail)) {
10003: if ($defmail ne '') {
10004: push(@recipients,$defmail);
10005: }
1.618 raeburn 10006: }
10007: if ($otheremails) {
1.619 raeburn 10008: my @others;
10009: if ($otheremails =~ /,/) {
10010: @others = split(/,/,$otheremails);
1.618 raeburn 10011: } else {
1.619 raeburn 10012: push(@others,$otheremails);
10013: }
10014: foreach my $addr (@others) {
10015: if (!grep(/^\Q$addr\E$/,@recipients)) {
10016: push(@recipients,$addr);
10017: }
1.618 raeburn 10018: }
10019: }
1.619 raeburn 10020: my $recipientlist = join(',',@recipients);
1.618 raeburn 10021: return $recipientlist;
10022: }
10023:
1.127 matthew 10024: ############################################################
10025: ############################################################
1.154 albertel 10026:
1.655 raeburn 10027: =pod
10028:
10029: =head1 Course Catalog Routines
10030:
10031: =over 4
10032:
10033: =item * &gather_categories()
10034:
10035: Converts category definitions - keys of categories hash stored in
10036: coursecategories in configuration.db on the primary library server in a
10037: domain - to an array. Also generates javascript and idx hash used to
10038: generate Domain Coordinator interface for editing Course Categories.
10039:
10040: Inputs:
1.663 raeburn 10041:
1.655 raeburn 10042: categories (reference to hash of category definitions).
1.663 raeburn 10043:
1.655 raeburn 10044: cats (reference to array of arrays/hashes which encapsulates hierarchy of
10045: categories and subcategories).
1.663 raeburn 10046:
1.655 raeburn 10047: idx (reference to hash of counters used in Domain Coordinator interface for
10048: editing Course Categories).
1.663 raeburn 10049:
1.655 raeburn 10050: jsarray (reference to array of categories used to create Javascript arrays for
10051: Domain Coordinator interface for editing Course Categories).
10052:
10053: Returns: nothing
10054:
10055: Side effects: populates cats, idx and jsarray.
10056:
10057: =cut
10058:
10059: sub gather_categories {
10060: my ($categories,$cats,$idx,$jsarray) = @_;
10061: my %counters;
10062: my $num = 0;
10063: foreach my $item (keys(%{$categories})) {
10064: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
10065: if ($container eq '' && $depth == 0) {
10066: $cats->[$depth][$categories->{$item}] = $cat;
10067: } else {
10068: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
10069: }
10070: my ($escitem,$tail) = split(/:/,$item,2);
10071: if ($counters{$tail} eq '') {
10072: $counters{$tail} = $num;
10073: $num ++;
10074: }
10075: if (ref($idx) eq 'HASH') {
10076: $idx->{$item} = $counters{$tail};
10077: }
10078: if (ref($jsarray) eq 'ARRAY') {
10079: push(@{$jsarray->[$counters{$tail}]},$item);
10080: }
10081: }
10082: return;
10083: }
10084:
10085: =pod
10086:
10087: =item * &extract_categories()
10088:
10089: Used to generate breadcrumb trails for course categories.
10090:
10091: Inputs:
1.663 raeburn 10092:
1.655 raeburn 10093: categories (reference to hash of category definitions).
1.663 raeburn 10094:
1.655 raeburn 10095: cats (reference to array of arrays/hashes which encapsulates hierarchy of
10096: categories and subcategories).
1.663 raeburn 10097:
1.655 raeburn 10098: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 10099:
1.655 raeburn 10100: allitems (reference to hash - key is category key
10101: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 10102:
1.655 raeburn 10103: idx (reference to hash of counters used in Domain Coordinator interface for
10104: editing Course Categories).
1.663 raeburn 10105:
1.655 raeburn 10106: jsarray (reference to array of categories used to create Javascript arrays for
10107: Domain Coordinator interface for editing Course Categories).
10108:
1.665 raeburn 10109: subcats (reference to hash of arrays containing all subcategories within each
10110: category, -recursive)
10111:
1.655 raeburn 10112: Returns: nothing
10113:
10114: Side effects: populates trails and allitems hash references.
10115:
10116: =cut
10117:
10118: sub extract_categories {
1.665 raeburn 10119: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 10120: if (ref($categories) eq 'HASH') {
10121: &gather_categories($categories,$cats,$idx,$jsarray);
10122: if (ref($cats->[0]) eq 'ARRAY') {
10123: for (my $i=0; $i<@{$cats->[0]}; $i++) {
10124: my $name = $cats->[0][$i];
10125: my $item = &escape($name).'::0';
10126: my $trailstr;
10127: if ($name eq 'instcode') {
10128: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 10129: } elsif ($name eq 'communities') {
10130: $trailstr = &mt('Communities');
1.655 raeburn 10131: } else {
10132: $trailstr = $name;
10133: }
10134: if ($allitems->{$item} eq '') {
10135: push(@{$trails},$trailstr);
10136: $allitems->{$item} = scalar(@{$trails})-1;
10137: }
10138: my @parents = ($name);
10139: if (ref($cats->[1]{$name}) eq 'ARRAY') {
10140: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
10141: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 10142: if (ref($subcats) eq 'HASH') {
10143: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
10144: }
10145: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
10146: }
10147: } else {
10148: if (ref($subcats) eq 'HASH') {
10149: $subcats->{$item} = [];
1.655 raeburn 10150: }
10151: }
10152: }
10153: }
10154: }
10155: return;
10156: }
10157:
10158: =pod
10159:
10160: =item *&recurse_categories()
10161:
10162: Recursively used to generate breadcrumb trails for course categories.
10163:
10164: Inputs:
1.663 raeburn 10165:
1.655 raeburn 10166: cats (reference to array of arrays/hashes which encapsulates hierarchy of
10167: categories and subcategories).
1.663 raeburn 10168:
1.655 raeburn 10169: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 10170:
10171: category (current course category, for which breadcrumb trail is being generated).
10172:
10173: trails (reference to array of breadcrumb trails for each category).
10174:
1.655 raeburn 10175: allitems (reference to hash - key is category key
10176: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 10177:
1.655 raeburn 10178: parents (array containing containers directories for current category,
10179: back to top level).
10180:
10181: Returns: nothing
10182:
10183: Side effects: populates trails and allitems hash references
10184:
10185: =cut
10186:
10187: sub recurse_categories {
1.665 raeburn 10188: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 10189: my $shallower = $depth - 1;
10190: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
10191: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
10192: my $name = $cats->[$depth]{$category}[$k];
10193: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
10194: my $trailstr = join(' -> ',(@{$parents},$category));
10195: if ($allitems->{$item} eq '') {
10196: push(@{$trails},$trailstr);
10197: $allitems->{$item} = scalar(@{$trails})-1;
10198: }
10199: my $deeper = $depth+1;
10200: push(@{$parents},$category);
1.665 raeburn 10201: if (ref($subcats) eq 'HASH') {
10202: my $subcat = &escape($name).':'.$category.':'.$depth;
10203: for (my $j=@{$parents}; $j>=0; $j--) {
10204: my $higher;
10205: if ($j > 0) {
10206: $higher = &escape($parents->[$j]).':'.
10207: &escape($parents->[$j-1]).':'.$j;
10208: } else {
10209: $higher = &escape($parents->[$j]).'::'.$j;
10210: }
10211: push(@{$subcats->{$higher}},$subcat);
10212: }
10213: }
10214: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
10215: $subcats);
1.655 raeburn 10216: pop(@{$parents});
10217: }
10218: } else {
10219: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
10220: my $trailstr = join(' -> ',(@{$parents},$category));
10221: if ($allitems->{$item} eq '') {
10222: push(@{$trails},$trailstr);
10223: $allitems->{$item} = scalar(@{$trails})-1;
10224: }
10225: }
10226: return;
10227: }
10228:
1.663 raeburn 10229: =pod
10230:
10231: =item *&assign_categories_table()
10232:
10233: Create a datatable for display of hierarchical categories in a domain,
10234: with checkboxes to allow a course to be categorized.
10235:
10236: Inputs:
10237:
10238: cathash - reference to hash of categories defined for the domain (from
10239: configuration.db)
10240:
10241: currcat - scalar with an & separated list of categories assigned to a course.
10242:
1.919 raeburn 10243: type - scalar contains course type (Course or Community).
10244:
1.663 raeburn 10245: Returns: $output (markup to be displayed)
10246:
10247: =cut
10248:
10249: sub assign_categories_table {
1.919 raeburn 10250: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 10251: my $output;
10252: if (ref($cathash) eq 'HASH') {
10253: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
10254: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
10255: $maxdepth = scalar(@cats);
10256: if (@cats > 0) {
10257: my $itemcount = 0;
10258: if (ref($cats[0]) eq 'ARRAY') {
10259: my @currcategories;
10260: if ($currcat ne '') {
10261: @currcategories = split('&',$currcat);
10262: }
1.919 raeburn 10263: my $table;
1.663 raeburn 10264: for (my $i=0; $i<@{$cats[0]}; $i++) {
10265: my $parent = $cats[0][$i];
1.919 raeburn 10266: next if ($parent eq 'instcode');
10267: if ($type eq 'Community') {
10268: next unless ($parent eq 'communities');
10269: } else {
10270: next if ($parent eq 'communities');
10271: }
1.663 raeburn 10272: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
10273: my $item = &escape($parent).'::0';
10274: my $checked = '';
10275: if (@currcategories > 0) {
10276: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 10277: $checked = ' checked="checked"';
1.663 raeburn 10278: }
10279: }
1.919 raeburn 10280: my $parent_title = $parent;
10281: if ($parent eq 'communities') {
10282: $parent_title = &mt('Communities');
10283: }
10284: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
10285: '<input type="checkbox" name="usecategory" value="'.
10286: $item.'"'.$checked.' />'.$parent_title.'</span>'.
10287: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 10288: my $depth = 1;
10289: push(@path,$parent);
1.919 raeburn 10290: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 10291: pop(@path);
1.919 raeburn 10292: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 10293: $itemcount ++;
10294: }
1.919 raeburn 10295: if ($itemcount) {
10296: $output = &Apache::loncommon::start_data_table().
10297: $table.
10298: &Apache::loncommon::end_data_table();
10299: }
1.663 raeburn 10300: }
10301: }
10302: }
10303: return $output;
10304: }
10305:
10306: =pod
10307:
10308: =item *&assign_category_rows()
10309:
10310: Create a datatable row for display of nested categories in a domain,
10311: with checkboxes to allow a course to be categorized,called recursively.
10312:
10313: Inputs:
10314:
10315: itemcount - track row number for alternating colors
10316:
10317: cats - reference to array of arrays/hashes which encapsulates hierarchy of
10318: categories and subcategories.
10319:
10320: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
10321:
10322: parent - parent of current category item
10323:
10324: path - Array containing all categories back up through the hierarchy from the
10325: current category to the top level.
10326:
10327: currcategories - reference to array of current categories assigned to the course
10328:
10329: Returns: $output (markup to be displayed).
10330:
10331: =cut
10332:
10333: sub assign_category_rows {
10334: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
10335: my ($text,$name,$item,$chgstr);
10336: if (ref($cats) eq 'ARRAY') {
10337: my $maxdepth = scalar(@{$cats});
10338: if (ref($cats->[$depth]) eq 'HASH') {
10339: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
10340: my $numchildren = @{$cats->[$depth]{$parent}};
10341: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
10342: $text .= '<td><table class="LC_datatable">';
10343: for (my $j=0; $j<$numchildren; $j++) {
10344: $name = $cats->[$depth]{$parent}[$j];
10345: $item = &escape($name).':'.&escape($parent).':'.$depth;
10346: my $deeper = $depth+1;
10347: my $checked = '';
10348: if (ref($currcategories) eq 'ARRAY') {
10349: if (@{$currcategories} > 0) {
10350: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 10351: $checked = ' checked="checked"';
1.663 raeburn 10352: }
10353: }
10354: }
1.664 raeburn 10355: $text .= '<tr><td><span class="LC_nobreak"><label>'.
10356: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 10357: $item.'"'.$checked.' />'.$name.'</label></span>'.
10358: '<input type="hidden" name="catname" value="'.$name.'" />'.
10359: '</td><td>';
1.663 raeburn 10360: if (ref($path) eq 'ARRAY') {
10361: push(@{$path},$name);
10362: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
10363: pop(@{$path});
10364: }
10365: $text .= '</td></tr>';
10366: }
10367: $text .= '</table></td>';
10368: }
10369: }
10370: }
10371: return $text;
10372: }
10373:
1.655 raeburn 10374: ############################################################
10375: ############################################################
10376:
10377:
1.443 albertel 10378: sub commit_customrole {
1.664 raeburn 10379: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 10380: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 10381: ($start?', '.&mt('starting').' '.localtime($start):'').
10382: ($end?', ending '.localtime($end):'').': <b>'.
10383: &Apache::lonnet::assigncustomrole(
1.664 raeburn 10384: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 10385: '</b><br />';
10386: return $output;
10387: }
10388:
10389: sub commit_standardrole {
1.541 raeburn 10390: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
10391: my ($output,$logmsg,$linefeed);
10392: if ($context eq 'auto') {
10393: $linefeed = "\n";
10394: } else {
10395: $linefeed = "<br />\n";
10396: }
1.443 albertel 10397: if ($three eq 'st') {
1.541 raeburn 10398: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
10399: $one,$two,$sec,$context);
10400: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 10401: ($result eq 'unknown_course') || ($result eq 'refused')) {
10402: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 10403: } else {
1.541 raeburn 10404: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 10405: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 10406: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
10407: if ($context eq 'auto') {
10408: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
10409: } else {
10410: $output .= '<b>'.$result.'</b>'.$linefeed.
10411: &mt('Add to classlist').': <b>ok</b>';
10412: }
10413: $output .= $linefeed;
1.443 albertel 10414: }
10415: } else {
10416: $output = &mt('Assigning').' '.$three.' in '.$url.
10417: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 10418: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 10419: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 10420: if ($context eq 'auto') {
10421: $output .= $result.$linefeed;
10422: } else {
10423: $output .= '<b>'.$result.'</b>'.$linefeed;
10424: }
1.443 albertel 10425: }
10426: return $output;
10427: }
10428:
10429: sub commit_studentrole {
1.541 raeburn 10430: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 10431: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 10432: if ($context eq 'auto') {
10433: $linefeed = "\n";
10434: } else {
10435: $linefeed = '<br />'."\n";
10436: }
1.443 albertel 10437: if (defined($one) && defined($two)) {
10438: my $cid=$one.'_'.$two;
10439: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
10440: my $secchange = 0;
10441: my $expire_role_result;
10442: my $modify_section_result;
1.628 raeburn 10443: if ($oldsec ne '-1') {
10444: if ($oldsec ne $sec) {
1.443 albertel 10445: $secchange = 1;
1.628 raeburn 10446: my $now = time;
1.443 albertel 10447: my $uurl='/'.$cid;
10448: $uurl=~s/\_/\//g;
10449: if ($oldsec) {
10450: $uurl.='/'.$oldsec;
10451: }
1.626 raeburn 10452: $oldsecurl = $uurl;
1.628 raeburn 10453: $expire_role_result =
1.652 raeburn 10454: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 10455: if ($env{'request.course.sec'} ne '') {
10456: if ($expire_role_result eq 'refused') {
10457: my @roles = ('st');
10458: my @statuses = ('previous');
10459: my @roledoms = ($one);
10460: my $withsec = 1;
10461: my %roleshash =
10462: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
10463: \@statuses,\@roles,\@roledoms,$withsec);
10464: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
10465: my ($oldstart,$oldend) =
10466: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
10467: if ($oldend > 0 && $oldend <= $now) {
10468: $expire_role_result = 'ok';
10469: }
10470: }
10471: }
10472: }
1.443 albertel 10473: $result = $expire_role_result;
10474: }
10475: }
10476: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 10477: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 10478: if ($modify_section_result =~ /^ok/) {
10479: if ($secchange == 1) {
1.628 raeburn 10480: if ($sec eq '') {
10481: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
10482: } else {
10483: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
10484: }
1.443 albertel 10485: } elsif ($oldsec eq '-1') {
1.628 raeburn 10486: if ($sec eq '') {
10487: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
10488: } else {
10489: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
10490: }
1.443 albertel 10491: } else {
1.628 raeburn 10492: if ($sec eq '') {
10493: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
10494: } else {
10495: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
10496: }
1.443 albertel 10497: }
10498: } else {
1.628 raeburn 10499: if ($secchange) {
10500: $$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;
10501: } else {
10502: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
10503: }
1.443 albertel 10504: }
10505: $result = $modify_section_result;
10506: } elsif ($secchange == 1) {
1.628 raeburn 10507: if ($oldsec eq '') {
10508: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
10509: } else {
10510: $$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;
10511: }
1.626 raeburn 10512: if ($expire_role_result eq 'refused') {
10513: my $newsecurl = '/'.$cid;
10514: $newsecurl =~ s/\_/\//g;
10515: if ($sec ne '') {
10516: $newsecurl.='/'.$sec;
10517: }
10518: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
10519: if ($sec eq '') {
10520: $$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;
10521: } else {
10522: $$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;
10523: }
10524: }
10525: }
1.443 albertel 10526: }
10527: } else {
1.626 raeburn 10528: $$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 10529: $result = "error: incomplete course id\n";
10530: }
10531: return $result;
10532: }
10533:
10534: ############################################################
10535: ############################################################
10536:
1.566 albertel 10537: sub check_clone {
1.578 raeburn 10538: my ($args,$linefeed) = @_;
1.566 albertel 10539: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
10540: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
10541: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
10542: my $clonemsg;
10543: my $can_clone = 0;
1.944 raeburn 10544: my $lctype = lc($args->{'crstype'});
1.908 raeburn 10545: if ($lctype ne 'community') {
10546: $lctype = 'course';
10547: }
1.566 albertel 10548: if ($clonehome eq 'no_host') {
1.944 raeburn 10549: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10550: $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'});
10551: } else {
10552: $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'});
10553: }
1.566 albertel 10554: } else {
10555: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944 raeburn 10556: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10557: if ($clonedesc{'type'} ne 'Community') {
10558: $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'});
10559: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10560: }
10561: }
1.882 raeburn 10562: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
10563: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 10564: $can_clone = 1;
10565: } else {
10566: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
10567: $args->{'clonedomain'},$args->{'clonecourse'});
10568: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 10569: if (grep(/^\*$/,@cloners)) {
10570: $can_clone = 1;
10571: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
10572: $can_clone = 1;
10573: } else {
1.908 raeburn 10574: my $ccrole = 'cc';
1.944 raeburn 10575: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10576: $ccrole = 'co';
10577: }
1.578 raeburn 10578: my %roleshash =
10579: &Apache::lonnet::get_my_roles($args->{'ccuname'},
10580: $args->{'ccdomain'},
1.908 raeburn 10581: 'userroles',['active'],[$ccrole],
1.578 raeburn 10582: [$args->{'clonedomain'}]);
1.908 raeburn 10583: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942 raeburn 10584: $can_clone = 1;
10585: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
10586: $can_clone = 1;
10587: } else {
1.944 raeburn 10588: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10589: $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'});
10590: } else {
10591: $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'});
10592: }
1.578 raeburn 10593: }
1.566 albertel 10594: }
1.578 raeburn 10595: }
1.566 albertel 10596: }
10597: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10598: }
10599:
1.444 albertel 10600: sub construct_course {
1.885 raeburn 10601: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444 albertel 10602: my $outcome;
1.541 raeburn 10603: my $linefeed = '<br />'."\n";
10604: if ($context eq 'auto') {
10605: $linefeed = "\n";
10606: }
1.566 albertel 10607:
10608: #
10609: # Are we cloning?
10610: #
10611: my ($can_clone, $clonemsg, $cloneid, $clonehome);
10612: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 10613: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 10614: if ($context ne 'auto') {
1.578 raeburn 10615: if ($clonemsg ne '') {
10616: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
10617: }
1.566 albertel 10618: }
10619: $outcome .= $clonemsg.$linefeed;
10620:
10621: if (!$can_clone) {
10622: return (0,$outcome);
10623: }
10624: }
10625:
1.444 albertel 10626: #
10627: # Open course
10628: #
10629: my $crstype = lc($args->{'crstype'});
10630: my %cenv=();
10631: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
10632: $args->{'cdescr'},
10633: $args->{'curl'},
10634: $args->{'course_home'},
10635: $args->{'nonstandard'},
10636: $args->{'crscode'},
10637: $args->{'ccuname'}.':'.
10638: $args->{'ccdomain'},
1.882 raeburn 10639: $args->{'crstype'},
1.885 raeburn 10640: $cnum,$context,$category);
1.444 albertel 10641:
10642: # Note: The testing routines depend on this being output; see
10643: # Utils::Course. This needs to at least be output as a comment
10644: # if anyone ever decides to not show this, and Utils::Course::new
10645: # will need to be suitably modified.
1.541 raeburn 10646: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943 raeburn 10647: if ($$courseid =~ /^error:/) {
10648: return (0,$outcome);
10649: }
10650:
1.444 albertel 10651: #
10652: # Check if created correctly
10653: #
1.479 albertel 10654: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 10655: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 10656: if ($crsuhome eq 'no_host') {
10657: $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
10658: return (0,$outcome);
10659: }
1.541 raeburn 10660: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 10661:
1.444 albertel 10662: #
1.566 albertel 10663: # Do the cloning
10664: #
10665: if ($can_clone && $cloneid) {
10666: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
10667: if ($context ne 'auto') {
10668: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
10669: }
10670: $outcome .= $clonemsg.$linefeed;
10671: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 10672: # Copy all files
1.637 www 10673: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 10674: # Restore URL
1.566 albertel 10675: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 10676: # Restore title
1.566 albertel 10677: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 10678: # Restore creation date, creator and creation context.
10679: $cenv{'internal.created'}=$oldcenv{'internal.created'};
10680: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
10681: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 10682: # Mark as cloned
1.566 albertel 10683: $cenv{'clonedfrom'}=$cloneid;
1.638 www 10684: # Need to clone grading mode
10685: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
10686: $cenv{'grading'}=$newenv{'grading'};
10687: # Do not clone these environment entries
10688: &Apache::lonnet::del('environment',
10689: ['default_enrollment_start_date',
10690: 'default_enrollment_end_date',
10691: 'question.email',
10692: 'policy.email',
10693: 'comment.email',
10694: 'pch.users.denied',
1.725 raeburn 10695: 'plc.users.denied',
10696: 'hidefromcat',
10697: 'categories'],
1.638 www 10698: $$crsudom,$$crsunum);
1.444 albertel 10699: }
1.566 albertel 10700:
1.444 albertel 10701: #
10702: # Set environment (will override cloned, if existing)
10703: #
10704: my @sections = ();
10705: my @xlists = ();
10706: if ($args->{'crstype'}) {
10707: $cenv{'type'}=$args->{'crstype'};
10708: }
10709: if ($args->{'crsid'}) {
10710: $cenv{'courseid'}=$args->{'crsid'};
10711: }
10712: if ($args->{'crscode'}) {
10713: $cenv{'internal.coursecode'}=$args->{'crscode'};
10714: }
10715: if ($args->{'crsquota'} ne '') {
10716: $cenv{'internal.coursequota'}=$args->{'crsquota'};
10717: } else {
10718: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
10719: }
10720: if ($args->{'ccuname'}) {
10721: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
10722: ':'.$args->{'ccdomain'};
10723: } else {
10724: $cenv{'internal.courseowner'} = $args->{'curruser'};
10725: }
10726: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
10727: if ($args->{'crssections'}) {
10728: $cenv{'internal.sectionnums'} = '';
10729: if ($args->{'crssections'} =~ m/,/) {
10730: @sections = split/,/,$args->{'crssections'};
10731: } else {
10732: $sections[0] = $args->{'crssections'};
10733: }
10734: if (@sections > 0) {
10735: foreach my $item (@sections) {
10736: my ($sec,$gp) = split/:/,$item;
10737: my $class = $args->{'crscode'}.$sec;
10738: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
10739: $cenv{'internal.sectionnums'} .= $item.',';
10740: unless ($addcheck eq 'ok') {
10741: push @badclasses, $class;
10742: }
10743: }
10744: $cenv{'internal.sectionnums'} =~ s/,$//;
10745: }
10746: }
10747: # do not hide course coordinator from staff listing,
10748: # even if privileged
10749: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10750: # add crosslistings
10751: if ($args->{'crsxlist'}) {
10752: $cenv{'internal.crosslistings'}='';
10753: if ($args->{'crsxlist'} =~ m/,/) {
10754: @xlists = split/,/,$args->{'crsxlist'};
10755: } else {
10756: $xlists[0] = $args->{'crsxlist'};
10757: }
10758: if (@xlists > 0) {
10759: foreach my $item (@xlists) {
10760: my ($xl,$gp) = split/:/,$item;
10761: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
10762: $cenv{'internal.crosslistings'} .= $item.',';
10763: unless ($addcheck eq 'ok') {
10764: push @badclasses, $xl;
10765: }
10766: }
10767: $cenv{'internal.crosslistings'} =~ s/,$//;
10768: }
10769: }
10770: if ($args->{'autoadds'}) {
10771: $cenv{'internal.autoadds'}=$args->{'autoadds'};
10772: }
10773: if ($args->{'autodrops'}) {
10774: $cenv{'internal.autodrops'}=$args->{'autodrops'};
10775: }
10776: # check for notification of enrollment changes
10777: my @notified = ();
10778: if ($args->{'notify_owner'}) {
10779: if ($args->{'ccuname'} ne '') {
10780: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
10781: }
10782: }
10783: if ($args->{'notify_dc'}) {
10784: if ($uname ne '') {
1.630 raeburn 10785: push(@notified,$uname.':'.$udom);
1.444 albertel 10786: }
10787: }
10788: if (@notified > 0) {
10789: my $notifylist;
10790: if (@notified > 1) {
10791: $notifylist = join(',',@notified);
10792: } else {
10793: $notifylist = $notified[0];
10794: }
10795: $cenv{'internal.notifylist'} = $notifylist;
10796: }
10797: if (@badclasses > 0) {
10798: my %lt=&Apache::lonlocal::texthash(
10799: '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',
10800: 'dnhr' => 'does not have rights to access enrollment in these classes',
10801: 'adby' => 'as determined by the policies of your institution on access to official classlists'
10802: );
1.541 raeburn 10803: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
10804: ' ('.$lt{'adby'}.')';
10805: if ($context eq 'auto') {
10806: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 10807: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 10808: foreach my $item (@badclasses) {
10809: if ($context eq 'auto') {
10810: $outcome .= " - $item\n";
10811: } else {
10812: $outcome .= "<li>$item</li>\n";
10813: }
10814: }
10815: if ($context eq 'auto') {
10816: $outcome .= $linefeed;
10817: } else {
1.566 albertel 10818: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 10819: }
10820: }
1.444 albertel 10821: }
10822: if ($args->{'no_end_date'}) {
10823: $args->{'endaccess'} = 0;
10824: }
10825: $cenv{'internal.autostart'}=$args->{'enrollstart'};
10826: $cenv{'internal.autoend'}=$args->{'enrollend'};
10827: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
10828: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
10829: if ($args->{'showphotos'}) {
10830: $cenv{'internal.showphotos'}=$args->{'showphotos'};
10831: }
10832: $cenv{'internal.authtype'} = $args->{'authtype'};
10833: $cenv{'internal.autharg'} = $args->{'autharg'};
10834: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
10835: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 10836: 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');
10837: if ($context eq 'auto') {
10838: $outcome .= $krb_msg;
10839: } else {
1.566 albertel 10840: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 10841: }
10842: $outcome .= $linefeed;
1.444 albertel 10843: }
10844: }
10845: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
10846: if ($args->{'setpolicy'}) {
10847: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10848: }
10849: if ($args->{'setcontent'}) {
10850: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10851: }
10852: }
10853: if ($args->{'reshome'}) {
10854: $cenv{'reshome'}=$args->{'reshome'}.'/';
10855: $cenv{'reshome'}=~s/\/+$/\//;
10856: }
10857: #
10858: # course has keyed access
10859: #
10860: if ($args->{'setkeys'}) {
10861: $cenv{'keyaccess'}='yes';
10862: }
10863: # if specified, key authority is not course, but user
10864: # only active if keyaccess is yes
10865: if ($args->{'keyauth'}) {
1.487 albertel 10866: my ($user,$domain) = split(':',$args->{'keyauth'});
10867: $user = &LONCAPA::clean_username($user);
10868: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 10869: if ($user ne '' && $domain ne '') {
1.487 albertel 10870: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 10871: }
10872: }
10873:
10874: if ($args->{'disresdis'}) {
10875: $cenv{'pch.roles.denied'}='st';
10876: }
10877: if ($args->{'disablechat'}) {
10878: $cenv{'plc.roles.denied'}='st';
10879: }
10880:
10881: # Record we've not yet viewed the Course Initialization Helper for this
10882: # course
10883: $cenv{'course.helper.not.run'} = 1;
10884: #
10885: # Use new Randomseed
10886: #
10887: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
10888: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
10889: #
10890: # The encryption code and receipt prefix for this course
10891: #
10892: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
10893: $cenv{'internal.encpref'}=100+int(9*rand(99));
10894: #
10895: # By default, use standard grading
10896: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
10897:
1.541 raeburn 10898: $outcome .= $linefeed.&mt('Setting environment').': '.
10899: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10900: #
10901: # Open all assignments
10902: #
10903: if ($args->{'openall'}) {
10904: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
10905: my %storecontent = ($storeunder => time,
10906: $storeunder.'.type' => 'date_start');
10907:
10908: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 10909: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10910: }
10911: #
10912: # Set first page
10913: #
10914: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
10915: || ($cloneid)) {
1.445 albertel 10916: use LONCAPA::map;
1.444 albertel 10917: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 10918:
10919: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
10920: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
10921:
1.444 albertel 10922: $outcome .= ($fatal?$errtext:'read ok').' - ';
10923: my $title; my $url;
10924: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 10925: $title=&mt('Syllabus');
1.444 albertel 10926: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
10927: } else {
1.963 raeburn 10928: $title=&mt('Table of Contents');
1.444 albertel 10929: $url='/adm/navmaps';
10930: }
1.445 albertel 10931:
10932: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
10933: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
10934:
10935: if ($errtext) { $fatal=2; }
1.541 raeburn 10936: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 10937: }
1.566 albertel 10938:
10939: return (1,$outcome);
1.444 albertel 10940: }
10941:
10942: ############################################################
10943: ############################################################
10944:
1.953 droeschl 10945: #SD
10946: # only Community and Course, or anything else?
1.378 raeburn 10947: sub course_type {
10948: my ($cid) = @_;
10949: if (!defined($cid)) {
10950: $cid = $env{'request.course.id'};
10951: }
1.404 albertel 10952: if (defined($env{'course.'.$cid.'.type'})) {
10953: return $env{'course.'.$cid.'.type'};
1.378 raeburn 10954: } else {
10955: return 'Course';
1.377 raeburn 10956: }
10957: }
1.156 albertel 10958:
1.406 raeburn 10959: sub group_term {
10960: my $crstype = &course_type();
10961: my %names = (
10962: 'Course' => 'group',
1.865 raeburn 10963: 'Community' => 'group',
1.406 raeburn 10964: );
10965: return $names{$crstype};
10966: }
10967:
1.902 raeburn 10968: sub course_types {
10969: my @types = ('official','unofficial','community');
10970: my %typename = (
10971: official => 'Official course',
10972: unofficial => 'Unofficial course',
10973: community => 'Community',
10974: );
10975: return (\@types,\%typename);
10976: }
10977:
1.156 albertel 10978: sub icon {
10979: my ($file)=@_;
1.505 albertel 10980: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 10981: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 10982: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 10983: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
10984: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
10985: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10986: $curfext.".gif") {
10987: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10988: $curfext.".gif";
10989: }
10990: }
1.249 albertel 10991: return &lonhttpdurl($iconname);
1.154 albertel 10992: }
1.84 albertel 10993:
1.575 albertel 10994: sub lonhttpdurl {
1.692 www 10995: #
10996: # Had been used for "small fry" static images on separate port 8080.
10997: # Modify here if lightweight http functionality desired again.
10998: # Currently eliminated due to increasing firewall issues.
10999: #
1.575 albertel 11000: my ($url)=@_;
1.692 www 11001: return $url;
1.215 albertel 11002: }
11003:
1.213 albertel 11004: sub connection_aborted {
11005: my ($r)=@_;
11006: $r->print(" ");$r->rflush();
11007: my $c = $r->connection;
11008: return $c->aborted();
11009: }
11010:
1.221 foxr 11011: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 11012: # strings as 'strings'.
11013: sub escape_single {
1.221 foxr 11014: my ($input) = @_;
1.223 albertel 11015: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 11016: $input =~ s/\'/\\\'/g; # Esacpe the 's....
11017: return $input;
11018: }
1.223 albertel 11019:
1.222 foxr 11020: # Same as escape_single, but escape's "'s This
11021: # can be used for "strings"
11022: sub escape_double {
11023: my ($input) = @_;
11024: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
11025: $input =~ s/\"/\\\"/g; # Esacpe the "s....
11026: return $input;
11027: }
1.223 albertel 11028:
1.222 foxr 11029: # Escapes the last element of a full URL.
11030: sub escape_url {
11031: my ($url) = @_;
1.238 raeburn 11032: my @urlslices = split(/\//, $url,-1);
1.369 www 11033: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 11034: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 11035: }
1.462 albertel 11036:
1.820 raeburn 11037: sub compare_arrays {
11038: my ($arrayref1,$arrayref2) = @_;
11039: my (@difference,%count);
11040: @difference = ();
11041: %count = ();
11042: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
11043: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
11044: foreach my $element (keys(%count)) {
11045: if ($count{$element} == 1) {
11046: push(@difference,$element);
11047: }
11048: }
11049: }
11050: return @difference;
11051: }
11052:
1.817 bisitz 11053: # -------------------------------------------------------- Initialize user login
1.462 albertel 11054: sub init_user_environment {
1.463 albertel 11055: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 11056: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
11057:
11058: my $public=($username eq 'public' && $domain eq 'public');
11059:
11060: # See if old ID present, if so, remove
11061:
11062: my ($filename,$cookie,$userroles);
11063: my $now=time;
11064:
11065: if ($public) {
11066: my $max_public=100;
11067: my $oldest;
11068: my $oldest_time=0;
11069: for(my $next=1;$next<=$max_public;$next++) {
11070: if (-e $lonids."/publicuser_$next.id") {
11071: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
11072: if ($mtime<$oldest_time || !$oldest_time) {
11073: $oldest_time=$mtime;
11074: $oldest=$next;
11075: }
11076: } else {
11077: $cookie="publicuser_$next";
11078: last;
11079: }
11080: }
11081: if (!$cookie) { $cookie="publicuser_$oldest"; }
11082: } else {
1.463 albertel 11083: # if this isn't a robot, kill any existing non-robot sessions
11084: if (!$args->{'robot'}) {
11085: opendir(DIR,$lonids);
11086: while ($filename=readdir(DIR)) {
11087: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
11088: unlink($lonids.'/'.$filename);
11089: }
1.462 albertel 11090: }
1.463 albertel 11091: closedir(DIR);
1.462 albertel 11092: }
11093: # Give them a new cookie
1.463 albertel 11094: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 11095: : $now.$$.int(rand(10000)));
1.463 albertel 11096: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 11097:
11098: # Initialize roles
11099:
11100: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
11101: }
11102: # ------------------------------------ Check browser type and MathML capability
11103:
11104: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
11105: $clientunicode,$clientos) = &decode_user_agent($r);
11106:
11107: # ------------------------------------------------------------- Get environment
11108:
11109: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
11110: my ($tmp) = keys(%userenv);
11111: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
11112: } else {
11113: undef(%userenv);
11114: }
11115: if (($userenv{'interface'}) && (!$form->{'interface'})) {
11116: $form->{'interface'}=$userenv{'interface'};
11117: }
11118: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
11119:
11120: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 11121: foreach my $option ('interface','localpath','localres') {
11122: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 11123: }
11124: # --------------------------------------------------------- Write first profile
11125:
11126: {
11127: my %initial_env =
11128: ("user.name" => $username,
11129: "user.domain" => $domain,
11130: "user.home" => $authhost,
11131: "browser.type" => $clientbrowser,
11132: "browser.version" => $clientversion,
11133: "browser.mathml" => $clientmathml,
11134: "browser.unicode" => $clientunicode,
11135: "browser.os" => $clientos,
11136: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
11137: "request.course.fn" => '',
11138: "request.course.uri" => '',
11139: "request.course.sec" => '',
11140: "request.role" => 'cm',
11141: "request.role.adv" => $env{'user.adv'},
11142: "request.host" => $ENV{'REMOTE_ADDR'},);
11143:
11144: if ($form->{'localpath'}) {
11145: $initial_env{"browser.localpath"} = $form->{'localpath'};
11146: $initial_env{"browser.localres"} = $form->{'localres'};
11147: }
11148:
11149: if ($form->{'interface'}) {
11150: $form->{'interface'}=~s/\W//gs;
11151: $initial_env{"browser.interface"} = $form->{'interface'};
11152: $env{'browser.interface'}=$form->{'interface'};
11153: }
11154:
1.981 raeburn 11155: my %is_adv = ( is_adv => $env{'user.adv'} );
1.980 raeburn 11156: my %domdef = &Apache::lonnet::get_domain_defaults($domain);
11157:
1.724 raeburn 11158: foreach my $tool ('aboutme','blog','portfolio') {
11159: $userenv{'availabletools.'.$tool} =
1.980 raeburn 11160: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
11161: undef,\%userenv,\%domdef,\%is_adv);
1.724 raeburn 11162: }
11163:
1.864 raeburn 11164: foreach my $crstype ('official','unofficial','community') {
1.765 raeburn 11165: $userenv{'canrequest.'.$crstype} =
11166: &Apache::lonnet::usertools_access($username,$domain,$crstype,
1.980 raeburn 11167: 'reload','requestcourses',
11168: \%userenv,\%domdef,\%is_adv);
1.765 raeburn 11169: }
11170:
1.462 albertel 11171: $env{'user.environment'} = "$lonids/$cookie.id";
11172:
11173: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
11174: &GDBM_WRCREAT(),0640)) {
11175: &_add_to_env(\%disk_env,\%initial_env);
11176: &_add_to_env(\%disk_env,\%userenv,'environment.');
11177: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 11178: if (ref($args->{'extra_env'})) {
11179: &_add_to_env(\%disk_env,$args->{'extra_env'});
11180: }
1.462 albertel 11181: untie(%disk_env);
11182: } else {
1.705 tempelho 11183: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
11184: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 11185: return 'error: '.$!;
11186: }
11187: }
11188: $env{'request.role'}='cm';
11189: $env{'request.role.adv'}=$env{'user.adv'};
11190: $env{'browser.type'}=$clientbrowser;
11191:
11192: return $cookie;
11193:
11194: }
11195:
11196: sub _add_to_env {
11197: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 11198: if (ref($env_data) eq 'HASH') {
11199: while (my ($key,$value) = each(%$env_data)) {
11200: $idf->{$prefix.$key} = $value;
11201: $env{$prefix.$key} = $value;
11202: }
1.462 albertel 11203: }
11204: }
11205:
1.685 tempelho 11206: # --- Get the symbolic name of a problem and the url
11207: sub get_symb {
11208: my ($request,$silent) = @_;
1.726 raeburn 11209: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 11210: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
11211: if ($symb eq '') {
11212: if (!$silent) {
11213: $request->print("Unable to handle ambiguous references:$url:.");
11214: return ();
11215: }
11216: }
11217: &Apache::lonenc::check_decrypt(\$symb);
11218: return ($symb);
11219: }
11220:
11221: # --------------------------------------------------------------Get annotation
11222:
11223: sub get_annotation {
11224: my ($symb,$enc) = @_;
11225:
11226: my $key = $symb;
11227: if (!$enc) {
11228: $key =
11229: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
11230: }
11231: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
11232: return $annotation{$key};
11233: }
11234:
11235: sub clean_symb {
1.731 raeburn 11236: my ($symb,$delete_enc) = @_;
1.685 tempelho 11237:
11238: &Apache::lonenc::check_decrypt(\$symb);
11239: my $enc = $env{'request.enc'};
1.731 raeburn 11240: if ($delete_enc) {
1.730 raeburn 11241: delete($env{'request.enc'});
11242: }
1.685 tempelho 11243:
11244: return ($symb,$enc);
11245: }
1.462 albertel 11246:
1.41 ng 11247: =pod
11248:
11249: =back
11250:
1.112 bowersj2 11251: =cut
1.41 ng 11252:
1.112 bowersj2 11253: 1;
11254: __END__;
1.41 ng 11255:
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