Annotation of loncom/interface/loncommon.pm, revision 1.1014
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1014 ! foxr 4: # $Id: loncommon.pm,v 1.1013 2011/06/13 17:40:58 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.999 www 412: function openstdbrowser(formname,uname,udom,clicker,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+
1.999 www 424: '&udomelement='+udom+
425: '&clicker='+clicker;
1.111 www 426: if (roleflag) { url+="&roles=1"; }
1.793 raeburn 427: if (courseadvonly) { url+="&courseadvonly=1"; }
1.102 www 428: var title = 'Student_Browser';
1.74 www 429: var options = 'scrollbars=1,resizable=1,menubar=0';
430: options += ',width=700,height=600';
431: stdeditbrowser = open(url,title,options,'1');
432: stdeditbrowser.focus();
433: }
1.824 bisitz 434: // ]]>
1.74 www 435: </script>
436: ENDSTDBRW
437: }
1.42 matthew 438:
1.1003 www 439: sub resourcebrowser_javascript {
440: unless ($env{'request.course.id'}) { return ''; }
1.1004 www 441: return (<<'ENDRESBRW');
1.1003 www 442: <script type="text/javascript" language="Javascript">
443: // <![CDATA[
444: var reseditbrowser;
1.1004 www 445: function openresbrowser(formname,reslink) {
1.1005 www 446: var url = '/adm/pickresource?form='+formname+'&reslink='+reslink;
1.1003 www 447: var title = 'Resource_Browser';
448: var options = 'scrollbars=1,resizable=1,menubar=0';
1.1005 www 449: options += ',width=700,height=500';
1.1004 www 450: reseditbrowser = open(url,title,options,'1');
451: reseditbrowser.focus();
1.1003 www 452: }
453: // ]]>
454: </script>
1.1004 www 455: ENDRESBRW
1.1003 www 456: }
457:
1.74 www 458: sub selectstudent_link {
1.999 www 459: my ($form,$unameele,$udomele,$courseadvonly,$clickerid)=@_;
460: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
461: &Apache::lonhtmlcommon::entity_encode($unameele)."','".
462: &Apache::lonhtmlcommon::entity_encode($udomele)."'";
1.258 albertel 463: if ($env{'request.course.id'}) {
1.302 albertel 464: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
465: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
466: '/'.$env{'request.course.sec'})) {
1.111 www 467: return '';
468: }
1.999 www 469: $callargs.=",'".&Apache::lonhtmlcommon::entity_encode($clickerid)."'";
1.793 raeburn 470: if ($courseadvonly) {
471: $callargs .= ",'',1,1";
472: }
473: return '<span class="LC_nobreak">'.
474: '<a href="javascript:openstdbrowser('.$callargs.');">'.
475: &mt('Select User').'</a></span>';
1.74 www 476: }
1.258 albertel 477: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.1012 www 478: $callargs .= ",'',1";
1.793 raeburn 479: return '<span class="LC_nobreak">'.
480: '<a href="javascript:openstdbrowser('.$callargs.');">'.
481: &mt('Select User').'</a></span>';
1.111 www 482: }
483: return '';
1.91 www 484: }
485:
1.1004 www 486: sub selectresource_link {
487: my ($form,$reslink,$arg)=@_;
488:
489: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
490: &Apache::lonhtmlcommon::entity_encode($reslink)."'";
491: unless ($env{'request.course.id'}) { return $arg; }
492: return '<span class="LC_nobreak">'.
493: '<a href="javascript:openresbrowser('.$callargs.');">'.
494: $arg.'</a></span>';
495: }
496:
497:
498:
1.653 raeburn 499: sub authorbrowser_javascript {
500: return <<"ENDAUTHORBRW";
1.776 bisitz 501: <script type="text/javascript" language="JavaScript">
1.824 bisitz 502: // <![CDATA[
1.653 raeburn 503: var stdeditbrowser;
504:
505: function openauthorbrowser(formname,udom) {
506: var url = '/adm/pickauthor?';
507: url += 'form='+formname+'&roledom='+udom;
508: var title = 'Author_Browser';
509: var options = 'scrollbars=1,resizable=1,menubar=0';
510: options += ',width=700,height=600';
511: stdeditbrowser = open(url,title,options,'1');
512: stdeditbrowser.focus();
513: }
514:
1.824 bisitz 515: // ]]>
1.653 raeburn 516: </script>
517: ENDAUTHORBRW
518: }
519:
1.91 www 520: sub coursebrowser_javascript {
1.909 raeburn 521: my ($domainfilter,$sec_element,$formname,$role_element,$crstype) = @_;
1.932 raeburn 522: my $wintitle = 'Course_Browser';
1.931 raeburn 523: if ($crstype eq 'Community') {
1.932 raeburn 524: $wintitle = 'Community_Browser';
1.909 raeburn 525: }
1.876 raeburn 526: my $id_functions = &javascript_index_functions();
527: my $output = '
1.776 bisitz 528: <script type="text/javascript" language="JavaScript">
1.824 bisitz 529: // <![CDATA[
1.468 raeburn 530: var stdeditbrowser;'."\n";
1.876 raeburn 531:
532: $output .= <<"ENDSTDBRW";
1.909 raeburn 533: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91 www 534: var url = '/adm/pickcourse?';
1.895 raeburn 535: var formid = getFormIdByName(formname);
1.876 raeburn 536: var domainfilter = getDomainFromSelectbox(formname,udom);
1.128 albertel 537: if (domainfilter != null) {
538: if (domainfilter != '') {
539: url += 'domainfilter='+domainfilter+'&';
540: }
541: }
1.91 www 542: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 543: '&cdomelement='+udom+
544: '&cnameelement='+desc;
1.468 raeburn 545: if (extra_element !=null && extra_element != '') {
1.594 raeburn 546: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 547: url += '&roleelement='+extra_element;
548: if (domainfilter == null || domainfilter == '') {
549: url += '&domainfilter='+extra_element;
550: }
1.234 raeburn 551: }
1.468 raeburn 552: else {
553: if (formname == 'portform') {
554: url += '&setroles='+extra_element;
1.800 raeburn 555: } else {
556: if (formname == 'rules') {
557: url += '&fixeddom='+extra_element;
558: }
1.468 raeburn 559: }
560: }
1.230 raeburn 561: }
1.909 raeburn 562: if (type != null && type != '') {
563: url += '&type='+type;
564: }
565: if (type_elem != null && type_elem != '') {
566: url += '&typeelement='+type_elem;
567: }
1.872 raeburn 568: if (formname == 'ccrs') {
569: var ownername = document.forms[formid].ccuname.value;
570: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
571: url += '&cloner='+ownername+':'+ownerdom;
572: }
1.293 raeburn 573: if (multflag !=null && multflag != '') {
574: url += '&multiple='+multflag;
575: }
1.909 raeburn 576: var title = '$wintitle';
1.91 www 577: var options = 'scrollbars=1,resizable=1,menubar=0';
578: options += ',width=700,height=600';
579: stdeditbrowser = open(url,title,options,'1');
580: stdeditbrowser.focus();
581: }
1.876 raeburn 582: $id_functions
583: ENDSTDBRW
1.905 raeburn 584: if (($sec_element ne '') || ($role_element ne '')) {
585: $output .= &setsec_javascript($sec_element,$formname,$role_element);
1.876 raeburn 586: }
587: $output .= '
588: // ]]>
589: </script>';
590: return $output;
591: }
592:
593: sub javascript_index_functions {
594: return <<"ENDJS";
595:
596: function getFormIdByName(formname) {
597: for (var i=0;i<document.forms.length;i++) {
598: if (document.forms[i].name == formname) {
599: return i;
600: }
601: }
602: return -1;
603: }
604:
605: function getIndexByName(formid,item) {
606: for (var i=0;i<document.forms[formid].elements.length;i++) {
607: if (document.forms[formid].elements[i].name == item) {
608: return i;
609: }
610: }
611: return -1;
612: }
1.468 raeburn 613:
1.876 raeburn 614: function getDomainFromSelectbox(formname,udom) {
615: var userdom;
616: var formid = getFormIdByName(formname);
617: if (formid > -1) {
618: var domid = getIndexByName(formid,udom);
619: if (domid > -1) {
620: if (document.forms[formid].elements[domid].type == 'select-one') {
621: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
622: }
623: if (document.forms[formid].elements[domid].type == 'hidden') {
624: userdom=document.forms[formid].elements[domid].value;
1.468 raeburn 625: }
626: }
627: }
1.876 raeburn 628: return userdom;
629: }
630:
631: ENDJS
1.468 raeburn 632:
1.876 raeburn 633: }
634:
635: sub userbrowser_javascript {
636: my $id_functions = &javascript_index_functions();
637: return <<"ENDUSERBRW";
638:
1.888 raeburn 639: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876 raeburn 640: var url = '/adm/pickuser?';
641: var userdom = getDomainFromSelectbox(formname,udom);
642: if (userdom != null) {
643: if (userdom != '') {
644: url += 'srchdom='+userdom+'&';
645: }
646: }
647: url += 'form=' + formname + '&unameelement='+uname+
648: '&udomelement='+udom+
649: '&ulastelement='+ulast+
650: '&ufirstelement='+ufirst+
651: '&uemailelement='+uemail+
1.881 raeburn 652: '&hideudomelement='+hideudom+
653: '&coursedom='+crsdom;
1.888 raeburn 654: if ((caller != null) && (caller != undefined)) {
655: url += '&caller='+caller;
656: }
1.876 raeburn 657: var title = 'User_Browser';
658: var options = 'scrollbars=1,resizable=1,menubar=0';
659: options += ',width=700,height=600';
660: var stdeditbrowser = open(url,title,options,'1');
661: stdeditbrowser.focus();
662: }
663:
1.888 raeburn 664: function fix_domain (formname,udom,origdom,uname) {
1.876 raeburn 665: var formid = getFormIdByName(formname);
666: if (formid > -1) {
1.888 raeburn 667: var unameid = getIndexByName(formid,uname);
1.876 raeburn 668: var domid = getIndexByName(formid,udom);
669: var hidedomid = getIndexByName(formid,origdom);
670: if (hidedomid > -1) {
671: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888 raeburn 672: var unameval = document.forms[formid].elements[unameid].value;
673: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
674: if (domid > -1) {
675: var slct = document.forms[formid].elements[domid];
676: if (slct.type == 'select-one') {
677: var i;
678: for (i=0;i<slct.length;i++) {
679: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
680: }
681: }
682: if (slct.type == 'hidden') {
683: slct.value = fixeddom;
1.876 raeburn 684: }
685: }
1.468 raeburn 686: }
687: }
688: }
1.876 raeburn 689: return;
690: }
691:
692: $id_functions
693: ENDUSERBRW
1.468 raeburn 694: }
695:
696: sub setsec_javascript {
1.905 raeburn 697: my ($sec_element,$formname,$role_element) = @_;
698: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
699: $communityrolestr);
700: if ($role_element ne '') {
701: my @allroles = ('st','ta','ep','in','ad');
702: foreach my $crstype ('Course','Community') {
703: if ($crstype eq 'Community') {
704: foreach my $role (@allroles) {
705: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
706: }
707: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
708: } else {
709: foreach my $role (@allroles) {
710: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
711: }
712: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
713: }
714: }
715: $rolestr = '"'.join('","',@allroles).'"';
716: $courserolestr = '"'.join('","',@courserolenames).'"';
717: $communityrolestr = '"'.join('","',@communityrolenames).'"';
718: }
1.468 raeburn 719: my $setsections = qq|
720: function setSect(sectionlist) {
1.629 raeburn 721: var sectionsArray = new Array();
722: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
723: sectionsArray = sectionlist.split(",");
724: }
1.468 raeburn 725: var numSections = sectionsArray.length;
726: document.$formname.$sec_element.length = 0;
727: if (numSections == 0) {
728: document.$formname.$sec_element.multiple=false;
729: document.$formname.$sec_element.size=1;
730: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
731: } else {
732: if (numSections == 1) {
733: document.$formname.$sec_element.multiple=false;
734: document.$formname.$sec_element.size=1;
735: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
736: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
737: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
738: } else {
739: for (var i=0; i<numSections; i++) {
740: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
741: }
742: document.$formname.$sec_element.multiple=true
743: if (numSections < 3) {
744: document.$formname.$sec_element.size=numSections;
745: } else {
746: document.$formname.$sec_element.size=3;
747: }
748: document.$formname.$sec_element.options[0].selected = false
749: }
750: }
1.91 www 751: }
1.905 raeburn 752:
753: function setRole(crstype) {
1.468 raeburn 754: |;
1.905 raeburn 755: if ($role_element eq '') {
756: $setsections .= ' return;
757: }
758: ';
759: } else {
760: $setsections .= qq|
761: var elementLength = document.$formname.$role_element.length;
762: var allroles = Array($rolestr);
763: var courserolenames = Array($courserolestr);
764: var communityrolenames = Array($communityrolestr);
765: if (elementLength != undefined) {
766: if (document.$formname.$role_element.options[5].value == 'cc') {
767: if (crstype == 'Course') {
768: return;
769: } else {
770: allroles[5] = 'co';
771: for (var i=0; i<6; i++) {
772: document.$formname.$role_element.options[i].value = allroles[i];
773: document.$formname.$role_element.options[i].text = communityrolenames[i];
774: }
775: }
776: } else {
777: if (crstype == 'Community') {
778: return;
779: } else {
780: allroles[5] = 'cc';
781: for (var i=0; i<6; i++) {
782: document.$formname.$role_element.options[i].value = allroles[i];
783: document.$formname.$role_element.options[i].text = courserolenames[i];
784: }
785: }
786: }
787: }
788: return;
789: }
790: |;
791: }
1.468 raeburn 792: return $setsections;
793: }
794:
1.91 www 795: sub selectcourse_link {
1.909 raeburn 796: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
797: $typeelement) = @_;
798: my $type = $selecttype;
1.871 raeburn 799: my $linktext = &mt('Select Course');
800: if ($selecttype eq 'Community') {
1.909 raeburn 801: $linktext = &mt('Select Community');
1.906 raeburn 802: } elsif ($selecttype eq 'Course/Community') {
803: $linktext = &mt('Select Course/Community');
1.909 raeburn 804: $type = '';
1.871 raeburn 805: }
1.787 bisitz 806: return '<span class="LC_nobreak">'
807: ."<a href='"
808: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
809: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 810: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 811: ."'>".$linktext.'</a>'
1.787 bisitz 812: .'</span>';
1.74 www 813: }
1.42 matthew 814:
1.653 raeburn 815: sub selectauthor_link {
816: my ($form,$udom)=@_;
817: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
818: &mt('Select Author').'</a>';
819: }
820:
1.876 raeburn 821: sub selectuser_link {
1.881 raeburn 822: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 823: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 824: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 825: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 826: ');">'.$linktext.'</a>';
1.876 raeburn 827: }
828:
1.273 raeburn 829: sub check_uncheck_jscript {
830: my $jscript = <<"ENDSCRT";
831: function checkAll(field) {
832: if (field.length > 0) {
833: for (i = 0; i < field.length; i++) {
834: field[i].checked = true ;
835: }
836: } else {
837: field.checked = true
838: }
839: }
840:
841: function uncheckAll(field) {
842: if (field.length > 0) {
843: for (i = 0; i < field.length; i++) {
844: field[i].checked = false ;
1.543 albertel 845: }
846: } else {
1.273 raeburn 847: field.checked = false ;
848: }
849: }
850: ENDSCRT
851: return $jscript;
852: }
853:
1.656 www 854: sub select_timezone {
1.659 raeburn 855: my ($name,$selected,$onchange,$includeempty)=@_;
856: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
857: if ($includeempty) {
858: $output .= '<option value=""';
859: if (($selected eq '') || ($selected eq 'local')) {
860: $output .= ' selected="selected" ';
861: }
862: $output .= '> </option>';
863: }
1.657 raeburn 864: my @timezones = DateTime::TimeZone->all_names;
865: foreach my $tzone (@timezones) {
866: $output.= '<option value="'.$tzone.'"';
867: if ($tzone eq $selected) {
868: $output.=' selected="selected"';
869: }
870: $output.=">$tzone</option>\n";
1.656 www 871: }
872: $output.="</select>";
873: return $output;
874: }
1.273 raeburn 875:
1.687 raeburn 876: sub select_datelocale {
877: my ($name,$selected,$onchange,$includeempty)=@_;
878: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
879: if ($includeempty) {
880: $output .= '<option value=""';
881: if ($selected eq '') {
882: $output .= ' selected="selected" ';
883: }
884: $output .= '> </option>';
885: }
886: my (@possibles,%locale_names);
887: my @locales = DateTime::Locale::Catalog::Locales;
888: foreach my $locale (@locales) {
889: if (ref($locale) eq 'HASH') {
890: my $id = $locale->{'id'};
891: if ($id ne '') {
892: my $en_terr = $locale->{'en_territory'};
893: my $native_terr = $locale->{'native_territory'};
1.695 raeburn 894: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 895: if (grep(/^en$/,@languages) || !@languages) {
896: if ($en_terr ne '') {
897: $locale_names{$id} = '('.$en_terr.')';
898: } elsif ($native_terr ne '') {
899: $locale_names{$id} = $native_terr;
900: }
901: } else {
902: if ($native_terr ne '') {
903: $locale_names{$id} = $native_terr.' ';
904: } elsif ($en_terr ne '') {
905: $locale_names{$id} = '('.$en_terr.')';
906: }
907: }
908: push (@possibles,$id);
909: }
910: }
911: }
912: foreach my $item (sort(@possibles)) {
913: $output.= '<option value="'.$item.'"';
914: if ($item eq $selected) {
915: $output.=' selected="selected"';
916: }
917: $output.=">$item";
918: if ($locale_names{$item} ne '') {
919: $output.=" $locale_names{$item}</option>\n";
920: }
921: $output.="</option>\n";
922: }
923: $output.="</select>";
924: return $output;
925: }
926:
1.792 raeburn 927: sub select_language {
928: my ($name,$selected,$includeempty) = @_;
929: my %langchoices;
930: if ($includeempty) {
931: %langchoices = ('' => 'No language preference');
932: }
933: foreach my $id (&languageids()) {
934: my $code = &supportedlanguagecode($id);
935: if ($code) {
936: $langchoices{$code} = &plainlanguagedescription($id);
937: }
938: }
1.970 raeburn 939: return &select_form($selected,$name,\%langchoices);
1.792 raeburn 940: }
941:
1.42 matthew 942: =pod
1.36 matthew 943:
1.648 raeburn 944: =item * &linked_select_forms(...)
1.36 matthew 945:
946: linked_select_forms returns a string containing a <script></script> block
947: and html for two <select> menus. The select menus will be linked in that
948: changing the value of the first menu will result in new values being placed
949: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 950: order unless a defined order is provided.
1.36 matthew 951:
952: linked_select_forms takes the following ordered inputs:
953:
954: =over 4
955:
1.112 bowersj2 956: =item * $formname, the name of the <form> tag
1.36 matthew 957:
1.112 bowersj2 958: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 959:
1.112 bowersj2 960: =item * $firstdefault, the default value for the first menu
1.36 matthew 961:
1.112 bowersj2 962: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 963:
1.112 bowersj2 964: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 965:
1.112 bowersj2 966: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 967:
1.609 raeburn 968: =item * $menuorder, the order of values in the first menu
969:
1.41 ng 970: =back
971:
1.36 matthew 972: Below is an example of such a hash. Only the 'text', 'default', and
973: 'select2' keys must appear as stated. keys(%menu) are the possible
974: values for the first select menu. The text that coincides with the
1.41 ng 975: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 976: and text for the second menu are given in the hash pointed to by
977: $menu{$choice1}->{'select2'}.
978:
1.112 bowersj2 979: my %menu = ( A1 => { text =>"Choice A1" ,
980: default => "B3",
981: select2 => {
982: B1 => "Choice B1",
983: B2 => "Choice B2",
984: B3 => "Choice B3",
985: B4 => "Choice B4"
1.609 raeburn 986: },
987: order => ['B4','B3','B1','B2'],
1.112 bowersj2 988: },
989: A2 => { text =>"Choice A2" ,
990: default => "C2",
991: select2 => {
992: C1 => "Choice C1",
993: C2 => "Choice C2",
994: C3 => "Choice C3"
1.609 raeburn 995: },
996: order => ['C2','C1','C3'],
1.112 bowersj2 997: },
998: A3 => { text =>"Choice A3" ,
999: default => "D6",
1000: select2 => {
1001: D1 => "Choice D1",
1002: D2 => "Choice D2",
1003: D3 => "Choice D3",
1004: D4 => "Choice D4",
1005: D5 => "Choice D5",
1006: D6 => "Choice D6",
1007: D7 => "Choice D7"
1.609 raeburn 1008: },
1009: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 1010: }
1011: );
1.36 matthew 1012:
1013: =cut
1014:
1015: sub linked_select_forms {
1016: my ($formname,
1017: $middletext,
1018: $firstdefault,
1019: $firstselectname,
1020: $secondselectname,
1.609 raeburn 1021: $hashref,
1022: $menuorder,
1.36 matthew 1023: ) = @_;
1024: my $second = "document.$formname.$secondselectname";
1025: my $first = "document.$formname.$firstselectname";
1026: # output the javascript to do the changing
1027: my $result = '';
1.776 bisitz 1028: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 1029: $result.="// <![CDATA[\n";
1.36 matthew 1030: $result.="var select2data = new Object();\n";
1031: $" = '","';
1032: my $debug = '';
1033: foreach my $s1 (sort(keys(%$hashref))) {
1034: $result.="select2data.d_$s1 = new Object();\n";
1035: $result.="select2data.d_$s1.def = new String('".
1036: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 1037: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 1038: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1039: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1040: @s2values = @{$hashref->{$s1}->{'order'}};
1041: }
1.36 matthew 1042: $result.="\"@s2values\");\n";
1043: $result.="select2data.d_$s1.texts = new Array(";
1044: my @s2texts;
1045: foreach my $value (@s2values) {
1046: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
1047: }
1048: $result.="\"@s2texts\");\n";
1049: }
1050: $"=' ';
1051: $result.= <<"END";
1052:
1053: function select1_changed() {
1054: // Determine new choice
1055: var newvalue = "d_" + $first.value;
1056: // update select2
1057: var values = select2data[newvalue].values;
1058: var texts = select2data[newvalue].texts;
1059: var select2def = select2data[newvalue].def;
1060: var i;
1061: // out with the old
1062: for (i = 0; i < $second.options.length; i++) {
1063: $second.options[i] = null;
1064: }
1065: // in with the nuclear
1066: for (i=0;i<values.length; i++) {
1067: $second.options[i] = new Option(values[i]);
1.143 matthew 1068: $second.options[i].value = values[i];
1.36 matthew 1069: $second.options[i].text = texts[i];
1070: if (values[i] == select2def) {
1071: $second.options[i].selected = true;
1072: }
1073: }
1074: }
1.824 bisitz 1075: // ]]>
1.36 matthew 1076: </script>
1077: END
1078: # output the initial values for the selection lists
1079: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609 raeburn 1080: my @order = sort(keys(%{$hashref}));
1081: if (ref($menuorder) eq 'ARRAY') {
1082: @order = @{$menuorder};
1083: }
1084: foreach my $value (@order) {
1.36 matthew 1085: $result.=" <option value=\"$value\" ";
1.253 albertel 1086: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1087: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1088: }
1089: $result .= "</select>\n";
1090: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1091: $result .= $middletext;
1092: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
1093: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1094:
1095: my @secondorder = sort(keys(%select2));
1096: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1097: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1098: }
1099: foreach my $value (@secondorder) {
1.36 matthew 1100: $result.=" <option value=\"$value\" ";
1.253 albertel 1101: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1102: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1103: }
1104: $result .= "</select>\n";
1105: # return $debug;
1106: return $result;
1107: } # end of sub linked_select_forms {
1108:
1.45 matthew 1109: =pod
1.44 bowersj2 1110:
1.973 raeburn 1111: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid)
1.44 bowersj2 1112:
1.112 bowersj2 1113: Returns a string corresponding to an HTML link to the given help
1114: $topic, where $topic corresponds to the name of a .tex file in
1115: /home/httpd/html/adm/help/tex, with underscores replaced by
1116: spaces.
1117:
1118: $text will optionally be linked to the same topic, allowing you to
1119: link text in addition to the graphic. If you do not want to link
1120: text, but wish to specify one of the later parameters, pass an
1121: empty string.
1122:
1123: $stayOnPage is a value that will be interpreted as a boolean. If true,
1124: the link will not open a new window. If false, the link will open
1125: a new window using Javascript. (Default is false.)
1126:
1127: $width and $height are optional numerical parameters that will
1128: override the width and height of the popped up window, which may
1.973 raeburn 1129: be useful for certain help topics with big pictures included.
1130:
1131: $imgid is the id of the img tag used for the help icon. This may be
1132: used in a javascript call to switch the image src. See
1133: lonhtmlcommon::htmlareaselectactive() for an example.
1.44 bowersj2 1134:
1135: =cut
1136:
1137: sub help_open_topic {
1.973 raeburn 1138: my ($topic, $text, $stayOnPage, $width, $height, $imgid) = @_;
1.48 bowersj2 1139: $text = "" if (not defined $text);
1.44 bowersj2 1140: $stayOnPage = 0 if (not defined $stayOnPage);
1141: $width = 350 if (not defined $width);
1142: $height = 400 if (not defined $height);
1143: my $filename = $topic;
1144: $filename =~ s/ /_/g;
1145:
1.48 bowersj2 1146: my $template = "";
1147: my $link;
1.572 banghart 1148:
1.159 www 1149: $topic=~s/\W/\_/g;
1.44 bowersj2 1150:
1.572 banghart 1151: if (!$stayOnPage) {
1.72 bowersj2 1152: $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 1153: } else {
1.48 bowersj2 1154: $link = "/adm/help/${filename}.hlp";
1155: }
1156:
1157: # Add the text
1.755 neumanie 1158: if ($text ne "") {
1.763 bisitz 1159: $template.='<span class="LC_help_open_topic">'
1160: .'<a target="_top" href="'.$link.'">'
1161: .$text.'</a>';
1.48 bowersj2 1162: }
1163:
1.763 bisitz 1164: # (Always) Add the graphic
1.179 matthew 1165: my $title = &mt('Online Help');
1.667 raeburn 1166: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973 raeburn 1167: if ($imgid ne '') {
1168: $imgid = ' id="'.$imgid.'"';
1169: }
1.763 bisitz 1170: $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
1171: .'<img src="'.$helpicon.'" border="0"'
1172: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973 raeburn 1173: .' title="'.$title.'" style="vertical-align:middle;"'.$imgid
1.763 bisitz 1174: .' /></a>';
1175: if ($text ne "") {
1176: $template.='</span>';
1177: }
1.44 bowersj2 1178: return $template;
1179:
1.106 bowersj2 1180: }
1181:
1182: # This is a quicky function for Latex cheatsheet editing, since it
1183: # appears in at least four places
1184: sub helpLatexCheatsheet {
1.732 raeburn 1185: my ($topic,$text,$not_author) = @_;
1186: my $out;
1.106 bowersj2 1187: my $addOther = '';
1.732 raeburn 1188: if ($topic) {
1.763 bisitz 1189: $addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
1190: undef, undef, 600).
1191: '</span> ';
1192: }
1193: $out = '<span>' # Start cheatsheet
1194: .$addOther
1195: .'<span>'
1196: .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
1197: undef,undef,600)
1198: .'</span> <span>'
1199: .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
1200: undef,undef,600)
1201: .'</span>';
1.732 raeburn 1202: unless ($not_author) {
1.763 bisitz 1203: $out .= ' <span>'
1204: .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
1205: undef,undef,600)
1206: .'</span>';
1.732 raeburn 1207: }
1.763 bisitz 1208: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1209: return $out;
1.172 www 1210: }
1211:
1.430 albertel 1212: sub general_help {
1213: my $helptopic='Student_Intro';
1214: if ($env{'request.role'}=~/^(ca|au)/) {
1215: $helptopic='Authoring_Intro';
1.907 raeburn 1216: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1217: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1218: } elsif ($env{'request.role'}=~/^dc/) {
1219: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1220: }
1221: return $helptopic;
1222: }
1223:
1224: sub update_help_link {
1225: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1226: my $origurl = $ENV{'REQUEST_URI'};
1227: $origurl=~s|^/~|/priv/|;
1228: my $timestamp = time;
1229: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1230: $$datum = &escape($$datum);
1231: }
1232:
1233: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1234: my $output .= <<"ENDOUTPUT";
1235: <script type="text/javascript">
1.824 bisitz 1236: // <![CDATA[
1.430 albertel 1237: banner_link = '$banner_link';
1.824 bisitz 1238: // ]]>
1.430 albertel 1239: </script>
1240: ENDOUTPUT
1241: return $output;
1242: }
1243:
1244: # now just updates the help link and generates a blue icon
1.193 raeburn 1245: sub help_open_menu {
1.430 albertel 1246: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1247: = @_;
1.949 droeschl 1248: $stayOnPage = 1;
1.430 albertel 1249: my $output;
1250: if ($component_help) {
1251: if (!$text) {
1252: $output=&help_open_topic($component_help,undef,$stayOnPage,
1253: $width,$height);
1254: } else {
1255: my $help_text;
1256: $help_text=&unescape($topic);
1257: $output='<table><tr><td>'.
1258: &help_open_topic($component_help,$help_text,$stayOnPage,
1259: $width,$height).'</td></tr></table>';
1260: }
1261: }
1262: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1263: return $output.$banner_link;
1264: }
1265:
1266: sub top_nav_help {
1267: my ($text) = @_;
1.436 albertel 1268: $text = &mt($text);
1.949 droeschl 1269: my $stay_on_page = 1;
1270:
1.572 banghart 1271: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1272: : "javascript:helpMenu('open')";
1.572 banghart 1273: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1274:
1.201 raeburn 1275: my $title = &mt('Get help');
1.436 albertel 1276:
1277: return <<"END";
1278: $banner_link
1279: <a href="$link" title="$title">$text</a>
1280: END
1281: }
1282:
1283: sub help_menu_js {
1284: my ($text) = @_;
1.949 droeschl 1285: my $stayOnPage = 1;
1.436 albertel 1286: my $width = 620;
1287: my $height = 600;
1.430 albertel 1288: my $helptopic=&general_help();
1289: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1290: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1291: my $start_page =
1292: &Apache::loncommon::start_page('Help Menu', undef,
1293: {'frameset' => 1,
1294: 'js_ready' => 1,
1295: 'add_entries' => {
1296: 'border' => '0',
1.579 raeburn 1297: 'rows' => "110,*",},});
1.331 albertel 1298: my $end_page =
1299: &Apache::loncommon::end_page({'frameset' => 1,
1300: 'js_ready' => 1,});
1301:
1.436 albertel 1302: my $template .= <<"ENDTEMPLATE";
1303: <script type="text/javascript">
1.877 bisitz 1304: // <![CDATA[
1.253 albertel 1305: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1306: var banner_link = '';
1.243 raeburn 1307: function helpMenu(target) {
1308: var caller = this;
1309: if (target == 'open') {
1310: var newWindow = null;
1311: try {
1.262 albertel 1312: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1313: }
1314: catch(error) {
1315: writeHelp(caller);
1316: return;
1317: }
1318: if (newWindow) {
1319: caller = newWindow;
1320: }
1.193 raeburn 1321: }
1.243 raeburn 1322: writeHelp(caller);
1323: return;
1324: }
1325: function writeHelp(caller) {
1.430 albertel 1326: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243 raeburn 1327: caller.document.close()
1328: caller.focus()
1.193 raeburn 1329: }
1.877 bisitz 1330: // END LON-CAPA Internal -->
1.253 albertel 1331: // ]]>
1.436 albertel 1332: </script>
1.193 raeburn 1333: ENDTEMPLATE
1334: return $template;
1335: }
1336:
1.172 www 1337: sub help_open_bug {
1338: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1339: unless ($env{'user.adv'}) { return ''; }
1.172 www 1340: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1341: $text = "" if (not defined $text);
1342: $stayOnPage=1;
1.184 albertel 1343: $width = 600 if (not defined $width);
1344: $height = 600 if (not defined $height);
1.172 www 1345:
1346: $topic=~s/\W+/\+/g;
1347: my $link='';
1348: my $template='';
1.379 albertel 1349: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1350: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1351: if (!$stayOnPage)
1352: {
1353: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1354: }
1355: else
1356: {
1357: $link = $url;
1358: }
1359: # Add the text
1360: if ($text ne "")
1361: {
1362: $template .=
1363: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1364: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1365: }
1366:
1367: # Add the graphic
1.179 matthew 1368: my $title = &mt('Report a Bug');
1.215 albertel 1369: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1370: $template .= <<"ENDTEMPLATE";
1.436 albertel 1371: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1372: ENDTEMPLATE
1373: if ($text ne '') { $template.='</td></tr></table>' };
1374: return $template;
1375:
1376: }
1377:
1378: sub help_open_faq {
1379: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1380: unless ($env{'user.adv'}) { return ''; }
1.172 www 1381: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1382: $text = "" if (not defined $text);
1383: $stayOnPage=1;
1384: $width = 350 if (not defined $width);
1385: $height = 400 if (not defined $height);
1386:
1387: $topic=~s/\W+/\+/g;
1388: my $link='';
1389: my $template='';
1390: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1391: if (!$stayOnPage)
1392: {
1393: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1394: }
1395: else
1396: {
1397: $link = $url;
1398: }
1399:
1400: # Add the text
1401: if ($text ne "")
1402: {
1403: $template .=
1.173 www 1404: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1405: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1406: }
1407:
1408: # Add the graphic
1.179 matthew 1409: my $title = &mt('View the FAQ');
1.215 albertel 1410: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1411: $template .= <<"ENDTEMPLATE";
1.436 albertel 1412: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1413: ENDTEMPLATE
1414: if ($text ne '') { $template.='</td></tr></table>' };
1415: return $template;
1416:
1.44 bowersj2 1417: }
1.37 matthew 1418:
1.180 matthew 1419: ###############################################################
1420: ###############################################################
1421:
1.45 matthew 1422: =pod
1423:
1.648 raeburn 1424: =item * &change_content_javascript():
1.256 matthew 1425:
1426: This and the next function allow you to create small sections of an
1427: otherwise static HTML page that you can update on the fly with
1428: Javascript, even in Netscape 4.
1429:
1430: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1431: must be written to the HTML page once. It will prove the Javascript
1432: function "change(name, content)". Calling the change function with the
1433: name of the section
1434: you want to update, matching the name passed to C<changable_area>, and
1435: the new content you want to put in there, will put the content into
1436: that area.
1437:
1438: B<Note>: Netscape 4 only reserves enough space for the changable area
1439: to contain room for the original contents. You need to "make space"
1440: for whatever changes you wish to make, and be B<sure> to check your
1441: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1442: it's adequate for updating a one-line status display, but little more.
1443: This script will set the space to 100% width, so you only need to
1444: worry about height in Netscape 4.
1445:
1446: Modern browsers are much less limiting, and if you can commit to the
1447: user not using Netscape 4, this feature may be used freely with
1448: pretty much any HTML.
1449:
1450: =cut
1451:
1452: sub change_content_javascript {
1453: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1454: if ($env{'browser.type'} eq 'netscape' &&
1455: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1456: return (<<NETSCAPE4);
1457: function change(name, content) {
1458: doc = document.layers[name+"___escape"].layers[0].document;
1459: doc.open();
1460: doc.write(content);
1461: doc.close();
1462: }
1463: NETSCAPE4
1464: } else {
1465: # Otherwise, we need to use semi-standards-compliant code
1466: # (technically, "innerHTML" isn't standard but the equivalent
1467: # is really scary, and every useful browser supports it
1468: return (<<DOMBASED);
1469: function change(name, content) {
1470: element = document.getElementById(name);
1471: element.innerHTML = content;
1472: }
1473: DOMBASED
1474: }
1475: }
1476:
1477: =pod
1478:
1.648 raeburn 1479: =item * &changable_area($name,$origContent):
1.256 matthew 1480:
1481: This provides a "changable area" that can be modified on the fly via
1482: the Javascript code provided in C<change_content_javascript>. $name is
1483: the name you will use to reference the area later; do not repeat the
1484: same name on a given HTML page more then once. $origContent is what
1485: the area will originally contain, which can be left blank.
1486:
1487: =cut
1488:
1489: sub changable_area {
1490: my ($name, $origContent) = @_;
1491:
1.258 albertel 1492: if ($env{'browser.type'} eq 'netscape' &&
1493: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1494: # If this is netscape 4, we need to use the Layer tag
1495: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1496: } else {
1497: return "<span id='$name'>$origContent</span>";
1498: }
1499: }
1500:
1501: =pod
1502:
1.648 raeburn 1503: =item * &viewport_geometry_js
1.590 raeburn 1504:
1505: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1506:
1507: =cut
1508:
1509:
1510: sub viewport_geometry_js {
1511: return <<"GEOMETRY";
1512: var Geometry = {};
1513: function init_geometry() {
1514: if (Geometry.init) { return };
1515: Geometry.init=1;
1516: if (window.innerHeight) {
1517: Geometry.getViewportHeight = function() { return window.innerHeight; };
1518: Geometry.getViewportWidth = function() { return window.innerWidth; };
1519: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1520: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1521: }
1522: else if (document.documentElement && document.documentElement.clientHeight) {
1523: Geometry.getViewportHeight =
1524: function() { return document.documentElement.clientHeight; };
1525: Geometry.getViewportWidth =
1526: function() { return document.documentElement.clientWidth; };
1527:
1528: Geometry.getHorizontalScroll =
1529: function() { return document.documentElement.scrollLeft; };
1530: Geometry.getVerticalScroll =
1531: function() { return document.documentElement.scrollTop; };
1532: }
1533: else if (document.body.clientHeight) {
1534: Geometry.getViewportHeight =
1535: function() { return document.body.clientHeight; };
1536: Geometry.getViewportWidth =
1537: function() { return document.body.clientWidth; };
1538: Geometry.getHorizontalScroll =
1539: function() { return document.body.scrollLeft; };
1540: Geometry.getVerticalScroll =
1541: function() { return document.body.scrollTop; };
1542: }
1543: }
1544:
1545: GEOMETRY
1546: }
1547:
1548: =pod
1549:
1.648 raeburn 1550: =item * &viewport_size_js()
1.590 raeburn 1551:
1552: 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.
1553:
1554: =cut
1555:
1556: sub viewport_size_js {
1557: my $geometry = &viewport_geometry_js();
1558: return <<"DIMS";
1559:
1560: $geometry
1561:
1562: function getViewportDims(width,height) {
1563: init_geometry();
1564: width.value = Geometry.getViewportWidth();
1565: height.value = Geometry.getViewportHeight();
1566: return;
1567: }
1568:
1569: DIMS
1570: }
1571:
1572: =pod
1573:
1.648 raeburn 1574: =item * &resize_textarea_js()
1.565 albertel 1575:
1576: emits the needed javascript to resize a textarea to be as big as possible
1577:
1578: creates a function resize_textrea that takes two IDs first should be
1579: the id of the element to resize, second should be the id of a div that
1580: surrounds everything that comes after the textarea, this routine needs
1581: to be attached to the <body> for the onload and onresize events.
1582:
1.648 raeburn 1583: =back
1.565 albertel 1584:
1585: =cut
1586:
1587: sub resize_textarea_js {
1.590 raeburn 1588: my $geometry = &viewport_geometry_js();
1.565 albertel 1589: return <<"RESIZE";
1590: <script type="text/javascript">
1.824 bisitz 1591: // <![CDATA[
1.590 raeburn 1592: $geometry
1.565 albertel 1593:
1.588 albertel 1594: function getX(element) {
1595: var x = 0;
1596: while (element) {
1597: x += element.offsetLeft;
1598: element = element.offsetParent;
1599: }
1600: return x;
1601: }
1602: function getY(element) {
1603: var y = 0;
1604: while (element) {
1605: y += element.offsetTop;
1606: element = element.offsetParent;
1607: }
1608: return y;
1609: }
1610:
1611:
1.565 albertel 1612: function resize_textarea(textarea_id,bottom_id) {
1613: init_geometry();
1614: var textarea = document.getElementById(textarea_id);
1615: //alert(textarea);
1616:
1.588 albertel 1617: var textarea_top = getY(textarea);
1.565 albertel 1618: var textarea_height = textarea.offsetHeight;
1619: var bottom = document.getElementById(bottom_id);
1.588 albertel 1620: var bottom_top = getY(bottom);
1.565 albertel 1621: var bottom_height = bottom.offsetHeight;
1622: var window_height = Geometry.getViewportHeight();
1.588 albertel 1623: var fudge = 23;
1.565 albertel 1624: var new_height = window_height-fudge-textarea_top-bottom_height;
1625: if (new_height < 300) {
1626: new_height = 300;
1627: }
1628: textarea.style.height=new_height+'px';
1629: }
1.824 bisitz 1630: // ]]>
1.565 albertel 1631: </script>
1632: RESIZE
1633:
1634: }
1635:
1636: =pod
1637:
1.256 matthew 1638: =head1 Excel and CSV file utility routines
1639:
1640: =over 4
1641:
1642: =cut
1643:
1644: ###############################################################
1645: ###############################################################
1646:
1647: =pod
1648:
1.648 raeburn 1649: =item * &csv_translate($text)
1.37 matthew 1650:
1.185 www 1651: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1652: format.
1653:
1654: =cut
1655:
1.180 matthew 1656: ###############################################################
1657: ###############################################################
1.37 matthew 1658: sub csv_translate {
1659: my $text = shift;
1660: $text =~ s/\"/\"\"/g;
1.209 albertel 1661: $text =~ s/\n/ /g;
1.37 matthew 1662: return $text;
1663: }
1.180 matthew 1664:
1665: ###############################################################
1666: ###############################################################
1667:
1668: =pod
1669:
1.648 raeburn 1670: =item * &define_excel_formats()
1.180 matthew 1671:
1672: Define some commonly used Excel cell formats.
1673:
1674: Currently supported formats:
1675:
1676: =over 4
1677:
1678: =item header
1679:
1680: =item bold
1681:
1682: =item h1
1683:
1684: =item h2
1685:
1686: =item h3
1687:
1.256 matthew 1688: =item h4
1689:
1690: =item i
1691:
1.180 matthew 1692: =item date
1693:
1694: =back
1695:
1696: Inputs: $workbook
1697:
1698: Returns: $format, a hash reference.
1699:
1700: =cut
1701:
1702: ###############################################################
1703: ###############################################################
1704: sub define_excel_formats {
1705: my ($workbook) = @_;
1706: my $format;
1707: $format->{'header'} = $workbook->add_format(bold => 1,
1708: bottom => 1,
1709: align => 'center');
1710: $format->{'bold'} = $workbook->add_format(bold=>1);
1711: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1712: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1713: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1714: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1715: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1716: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1717: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1718: return $format;
1719: }
1720:
1721: ###############################################################
1722: ###############################################################
1.113 bowersj2 1723:
1724: =pod
1725:
1.648 raeburn 1726: =item * &create_workbook()
1.255 matthew 1727:
1728: Create an Excel worksheet. If it fails, output message on the
1729: request object and return undefs.
1730:
1731: Inputs: Apache request object
1732:
1733: Returns (undef) on failure,
1734: Excel worksheet object, scalar with filename, and formats
1735: from &Apache::loncommon::define_excel_formats on success
1736:
1737: =cut
1738:
1739: ###############################################################
1740: ###############################################################
1741: sub create_workbook {
1742: my ($r) = @_;
1743: #
1744: # Create the excel spreadsheet
1745: my $filename = '/prtspool/'.
1.258 albertel 1746: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1747: time.'_'.rand(1000000000).'.xls';
1748: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1749: if (! defined($workbook)) {
1750: $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928 bisitz 1751: $r->print(
1752: '<p class="LC_error">'
1753: .&mt('Problems occurred in creating the new Excel file.')
1754: .' '.&mt('This error has been logged.')
1755: .' '.&mt('Please alert your LON-CAPA administrator.')
1756: .'</p>'
1757: );
1.255 matthew 1758: return (undef);
1759: }
1760: #
1.1014 ! foxr 1761: $workbook->set_tempdir(LONCAPA::tempdir());
1.255 matthew 1762: #
1763: my $format = &Apache::loncommon::define_excel_formats($workbook);
1764: return ($workbook,$filename,$format);
1765: }
1766:
1767: ###############################################################
1768: ###############################################################
1769:
1770: =pod
1771:
1.648 raeburn 1772: =item * &create_text_file()
1.113 bowersj2 1773:
1.542 raeburn 1774: Create a file to write to and eventually make available to the user.
1.256 matthew 1775: If file creation fails, outputs an error message on the request object and
1776: return undefs.
1.113 bowersj2 1777:
1.256 matthew 1778: Inputs: Apache request object, and file suffix
1.113 bowersj2 1779:
1.256 matthew 1780: Returns (undef) on failure,
1781: Filehandle and filename on success.
1.113 bowersj2 1782:
1783: =cut
1784:
1.256 matthew 1785: ###############################################################
1786: ###############################################################
1787: sub create_text_file {
1788: my ($r,$suffix) = @_;
1789: if (! defined($suffix)) { $suffix = 'txt'; };
1790: my $fh;
1791: my $filename = '/prtspool/'.
1.258 albertel 1792: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1793: time.'_'.rand(1000000000).'.'.$suffix;
1794: $fh = Apache::File->new('>/home/httpd'.$filename);
1795: if (! defined($fh)) {
1796: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 1797: $r->print(
1798: '<p class="LC_error">'
1799: .&mt('Problems occurred in creating the output file.')
1800: .' '.&mt('This error has been logged.')
1801: .' '.&mt('Please alert your LON-CAPA administrator.')
1802: .'</p>'
1803: );
1.113 bowersj2 1804: }
1.256 matthew 1805: return ($fh,$filename)
1.113 bowersj2 1806: }
1807:
1808:
1.256 matthew 1809: =pod
1.113 bowersj2 1810:
1811: =back
1812:
1813: =cut
1.37 matthew 1814:
1815: ###############################################################
1.33 matthew 1816: ## Home server <option> list generating code ##
1817: ###############################################################
1.35 matthew 1818:
1.169 www 1819: # ------------------------------------------
1820:
1821: sub domain_select {
1822: my ($name,$value,$multiple)=@_;
1823: my %domains=map {
1.514 albertel 1824: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1825: } &Apache::lonnet::all_domains();
1.169 www 1826: if ($multiple) {
1827: $domains{''}=&mt('Any domain');
1.550 albertel 1828: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1829: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1830: } else {
1.550 albertel 1831: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970 raeburn 1832: return &select_form($name,$value,\%domains);
1.169 www 1833: }
1834: }
1835:
1.282 albertel 1836: #-------------------------------------------
1837:
1838: =pod
1839:
1.519 raeburn 1840: =head1 Routines for form select boxes
1841:
1842: =over 4
1843:
1.648 raeburn 1844: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1845:
1846: Returns a string containing a <select> element int multiple mode
1847:
1848:
1849: Args:
1850: $name - name of the <select> element
1.506 raeburn 1851: $value - scalar or array ref of values that should already be selected
1.282 albertel 1852: $size - number of rows long the select element is
1.283 albertel 1853: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1854: (shown text should already have been &mt())
1.506 raeburn 1855: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1856:
1.282 albertel 1857: =cut
1858:
1859: #-------------------------------------------
1.169 www 1860: sub multiple_select_form {
1.284 albertel 1861: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1862: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1863: my $output='';
1.191 matthew 1864: if (! defined($size)) {
1865: $size = 4;
1.283 albertel 1866: if (scalar(keys(%$hash))<4) {
1867: $size = scalar(keys(%$hash));
1.191 matthew 1868: }
1869: }
1.734 bisitz 1870: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1871: my @order;
1.506 raeburn 1872: if (ref($order) eq 'ARRAY') {
1873: @order = @{$order};
1874: } else {
1875: @order = sort(keys(%$hash));
1.501 banghart 1876: }
1877: if (exists($$hash{'select_form_order'})) {
1878: @order = @{$$hash{'select_form_order'}};
1879: }
1880:
1.284 albertel 1881: foreach my $key (@order) {
1.356 albertel 1882: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1883: $output.='selected="selected" ' if ($selected{$key});
1884: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1885: }
1886: $output.="</select>\n";
1887: return $output;
1888: }
1889:
1.88 www 1890: #-------------------------------------------
1891:
1892: =pod
1893:
1.970 raeburn 1894: =item * &select_form($defdom,$name,$hashref,$onchange)
1.88 www 1895:
1896: Returns a string containing a <select name='$name' size='1'> form to
1.970 raeburn 1897: allow a user to select options from a ref to a hash containing:
1898: option_name => displayed text. An optional $onchange can include
1899: a javascript onchange item, e.g., onchange="this.form.submit();"
1900:
1.88 www 1901: See lonrights.pm for an example invocation and use.
1902:
1903: =cut
1904:
1905: #-------------------------------------------
1906: sub select_form {
1.970 raeburn 1907: my ($def,$name,$hashref,$onchange) = @_;
1908: return unless (ref($hashref) eq 'HASH');
1909: if ($onchange) {
1910: $onchange = ' onchange="'.$onchange.'"';
1911: }
1912: my $selectform = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.128 albertel 1913: my @keys;
1.970 raeburn 1914: if (exists($hashref->{'select_form_order'})) {
1915: @keys=@{$hashref->{'select_form_order'}};
1.128 albertel 1916: } else {
1.970 raeburn 1917: @keys=sort(keys(%{$hashref}));
1.128 albertel 1918: }
1.356 albertel 1919: foreach my $key (@keys) {
1920: $selectform.=
1921: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1922: ($key eq $def ? 'selected="selected" ' : '').
1.970 raeburn 1923: ">".$hashref->{$key}."</option>\n";
1.88 www 1924: }
1925: $selectform.="</select>";
1926: return $selectform;
1927: }
1928:
1.475 www 1929: # For display filters
1930:
1931: sub display_filter {
1932: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1933: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714 bisitz 1934: return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475 www 1935: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1936: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 1937: '</label></span> <span class="LC_nobreak">'.
1.475 www 1938: &mt('Filter [_1]',
1.477 www 1939: &select_form($env{'form.displayfilter'},
1940: 'displayfilter',
1.970 raeburn 1941: {'currentfolder' => 'Current folder/page',
1.477 www 1942: 'containing' => 'Containing phrase',
1.970 raeburn 1943: 'none' => 'None'})).
1.714 bisitz 1944: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475 www 1945: }
1946:
1.167 www 1947: sub gradeleveldescription {
1948: my $gradelevel=shift;
1949: my %gradelevels=(0 => 'Not specified',
1950: 1 => 'Grade 1',
1951: 2 => 'Grade 2',
1952: 3 => 'Grade 3',
1953: 4 => 'Grade 4',
1954: 5 => 'Grade 5',
1955: 6 => 'Grade 6',
1956: 7 => 'Grade 7',
1957: 8 => 'Grade 8',
1958: 9 => 'Grade 9',
1959: 10 => 'Grade 10',
1960: 11 => 'Grade 11',
1961: 12 => 'Grade 12',
1962: 13 => 'Grade 13',
1963: 14 => '100 Level',
1964: 15 => '200 Level',
1965: 16 => '300 Level',
1966: 17 => '400 Level',
1967: 18 => 'Graduate Level');
1968: return &mt($gradelevels{$gradelevel});
1969: }
1970:
1.163 www 1971: sub select_level_form {
1972: my ($deflevel,$name)=@_;
1973: unless ($deflevel) { $deflevel=0; }
1.167 www 1974: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1975: for (my $i=0; $i<=18; $i++) {
1976: $selectform.="<option value=\"$i\" ".
1.253 albertel 1977: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1978: ">".&gradeleveldescription($i)."</option>\n";
1979: }
1980: $selectform.="</select>";
1981: return $selectform;
1.163 www 1982: }
1.167 www 1983:
1.35 matthew 1984: #-------------------------------------------
1985:
1.45 matthew 1986: =pod
1987:
1.910 raeburn 1988: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35 matthew 1989:
1990: Returns a string containing a <select name='$name' size='1'> form to
1991: allow a user to select the domain to preform an operation in.
1992: See loncreateuser.pm for an example invocation and use.
1993:
1.90 www 1994: If the $includeempty flag is set, it also includes an empty choice ("no domain
1995: selected");
1996:
1.743 raeburn 1997: If the $showdomdesc flag is set, the domain name is followed by the domain description.
1998:
1.910 raeburn 1999: 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.
2000:
2001: The optional $incdoms is a reference to an array of domains which will be the only available options.
1.563 raeburn 2002:
1.35 matthew 2003: =cut
2004:
2005: #-------------------------------------------
1.34 matthew 2006: sub select_dom_form {
1.910 raeburn 2007: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.872 raeburn 2008: if ($onchange) {
1.874 raeburn 2009: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 2010: }
1.910 raeburn 2011: my @domains;
2012: if (ref($incdoms) eq 'ARRAY') {
2013: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
2014: } else {
2015: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
2016: }
1.90 www 2017: if ($includeempty) { @domains=('',@domains); }
1.743 raeburn 2018: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 2019: foreach my $dom (@domains) {
2020: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 2021: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
2022: if ($showdomdesc) {
2023: if ($dom ne '') {
2024: my $domdesc = &Apache::lonnet::domain($dom,'description');
2025: if ($domdesc ne '') {
2026: $selectdomain .= ' ('.$domdesc.')';
2027: }
2028: }
2029: }
2030: $selectdomain .= "</option>\n";
1.34 matthew 2031: }
2032: $selectdomain.="</select>";
2033: return $selectdomain;
2034: }
2035:
1.35 matthew 2036: #-------------------------------------------
2037:
1.45 matthew 2038: =pod
2039:
1.648 raeburn 2040: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 2041:
1.586 raeburn 2042: input: 4 arguments (two required, two optional) -
2043: $domain - domain of new user
2044: $name - name of form element
2045: $default - Value of 'default' causes a default item to be first
2046: option, and selected by default.
2047: $hide - Value of 'hide' causes hiding of the name of the server,
2048: if 1 server found, or default, if 0 found.
1.594 raeburn 2049: output: returns 2 items:
1.586 raeburn 2050: (a) form element which contains either:
2051: (i) <select name="$name">
2052: <option value="$hostid1">$hostid $servers{$hostid}</option>
2053: <option value="$hostid2">$hostid $servers{$hostid}</option>
2054: </select>
2055: form item if there are multiple library servers in $domain, or
2056: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2057: if there is only one library server in $domain.
2058:
2059: (b) number of library servers found.
2060:
2061: See loncreateuser.pm for example of use.
1.35 matthew 2062:
2063: =cut
2064:
2065: #-------------------------------------------
1.586 raeburn 2066: sub home_server_form_item {
2067: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2068: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2069: my $result;
2070: my $numlib = keys(%servers);
2071: if ($numlib > 1) {
2072: $result .= '<select name="'.$name.'" />'."\n";
2073: if ($default) {
1.804 bisitz 2074: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 2075: '</option>'."\n";
2076: }
2077: foreach my $hostid (sort(keys(%servers))) {
2078: $result.= '<option value="'.$hostid.'">'.
2079: $hostid.' '.$servers{$hostid}."</option>\n";
2080: }
2081: $result .= '</select>'."\n";
2082: } elsif ($numlib == 1) {
2083: my $hostid;
2084: foreach my $item (keys(%servers)) {
2085: $hostid = $item;
2086: }
2087: $result .= '<input type="hidden" name="'.$name.'" value="'.
2088: $hostid.'" />';
2089: if (!$hide) {
2090: $result .= $hostid.' '.$servers{$hostid};
2091: }
2092: $result .= "\n";
2093: } elsif ($default) {
2094: $result .= '<input type="hidden" name="'.$name.
2095: '" value="default" />';
2096: if (!$hide) {
2097: $result .= &mt('default');
2098: }
2099: $result .= "\n";
1.33 matthew 2100: }
1.586 raeburn 2101: return ($result,$numlib);
1.33 matthew 2102: }
1.112 bowersj2 2103:
2104: =pod
2105:
1.534 albertel 2106: =back
2107:
1.112 bowersj2 2108: =cut
1.87 matthew 2109:
2110: ###############################################################
1.112 bowersj2 2111: ## Decoding User Agent ##
1.87 matthew 2112: ###############################################################
2113:
2114: =pod
2115:
1.112 bowersj2 2116: =head1 Decoding the User Agent
2117:
2118: =over 4
2119:
2120: =item * &decode_user_agent()
1.87 matthew 2121:
2122: Inputs: $r
2123:
2124: Outputs:
2125:
2126: =over 4
2127:
1.112 bowersj2 2128: =item * $httpbrowser
1.87 matthew 2129:
1.112 bowersj2 2130: =item * $clientbrowser
1.87 matthew 2131:
1.112 bowersj2 2132: =item * $clientversion
1.87 matthew 2133:
1.112 bowersj2 2134: =item * $clientmathml
1.87 matthew 2135:
1.112 bowersj2 2136: =item * $clientunicode
1.87 matthew 2137:
1.112 bowersj2 2138: =item * $clientos
1.87 matthew 2139:
2140: =back
2141:
1.157 matthew 2142: =back
2143:
1.87 matthew 2144: =cut
2145:
2146: ###############################################################
2147: ###############################################################
2148: sub decode_user_agent {
1.247 albertel 2149: my ($r)=@_;
1.87 matthew 2150: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2151: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2152: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2153: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2154: my $clientbrowser='unknown';
2155: my $clientversion='0';
2156: my $clientmathml='';
2157: my $clientunicode='0';
2158: for (my $i=0;$i<=$#browsertype;$i++) {
2159: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
2160: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2161: $clientbrowser=$bname;
2162: $httpbrowser=~/$vreg/i;
2163: $clientversion=$1;
2164: $clientmathml=($clientversion>=$minv);
2165: $clientunicode=($clientversion>=$univ);
2166: }
2167: }
2168: my $clientos='unknown';
2169: if (($httpbrowser=~/linux/i) ||
2170: ($httpbrowser=~/unix/i) ||
2171: ($httpbrowser=~/ux/i) ||
2172: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2173: if (($httpbrowser=~/vax/i) ||
2174: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2175: if ($httpbrowser=~/next/i) { $clientos='next'; }
2176: if (($httpbrowser=~/mac/i) ||
2177: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
2178: if ($httpbrowser=~/win/i) { $clientos='win'; }
2179: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
2180: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
2181: $clientunicode,$clientos,);
2182: }
2183:
1.32 matthew 2184: ###############################################################
2185: ## Authentication changing form generation subroutines ##
2186: ###############################################################
2187: ##
2188: ## All of the authform_xxxxxxx subroutines take their inputs in a
2189: ## hash, and have reasonable default values.
2190: ##
2191: ## formname = the name given in the <form> tag.
1.35 matthew 2192: #-------------------------------------------
2193:
1.45 matthew 2194: =pod
2195:
1.112 bowersj2 2196: =head1 Authentication Routines
2197:
2198: =over 4
2199:
1.648 raeburn 2200: =item * &authform_xxxxxx()
1.35 matthew 2201:
2202: The authform_xxxxxx subroutines provide javascript and html forms which
2203: handle some of the conveniences required for authentication forms.
2204: This is not an optimal method, but it works.
2205:
2206: =over 4
2207:
1.112 bowersj2 2208: =item * authform_header
1.35 matthew 2209:
1.112 bowersj2 2210: =item * authform_authorwarning
1.35 matthew 2211:
1.112 bowersj2 2212: =item * authform_nochange
1.35 matthew 2213:
1.112 bowersj2 2214: =item * authform_kerberos
1.35 matthew 2215:
1.112 bowersj2 2216: =item * authform_internal
1.35 matthew 2217:
1.112 bowersj2 2218: =item * authform_filesystem
1.35 matthew 2219:
2220: =back
2221:
1.648 raeburn 2222: See loncreateuser.pm for invocation and use examples.
1.157 matthew 2223:
1.35 matthew 2224: =cut
2225:
2226: #-------------------------------------------
1.32 matthew 2227: sub authform_header{
2228: my %in = (
2229: formname => 'cu',
1.80 albertel 2230: kerb_def_dom => '',
1.32 matthew 2231: @_,
2232: );
2233: $in{'formname'} = 'document.' . $in{'formname'};
2234: my $result='';
1.80 albertel 2235:
2236: #---------------------------------------------- Code for upper case translation
2237: my $Javascript_toUpperCase;
2238: unless ($in{kerb_def_dom}) {
2239: $Javascript_toUpperCase =<<"END";
2240: switch (choice) {
2241: case 'krb': currentform.elements[choicearg].value =
2242: currentform.elements[choicearg].value.toUpperCase();
2243: break;
2244: default:
2245: }
2246: END
2247: } else {
2248: $Javascript_toUpperCase = "";
2249: }
2250:
1.165 raeburn 2251: my $radioval = "'nochange'";
1.591 raeburn 2252: if (defined($in{'curr_authtype'})) {
2253: if ($in{'curr_authtype'} ne '') {
2254: $radioval = "'".$in{'curr_authtype'}."arg'";
2255: }
1.174 matthew 2256: }
1.165 raeburn 2257: my $argfield = 'null';
1.591 raeburn 2258: if (defined($in{'mode'})) {
1.165 raeburn 2259: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2260: if (defined($in{'curr_autharg'})) {
2261: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2262: $argfield = "'$in{'curr_autharg'}'";
2263: }
2264: }
2265: }
2266: }
2267:
1.32 matthew 2268: $result.=<<"END";
2269: var current = new Object();
1.165 raeburn 2270: current.radiovalue = $radioval;
2271: current.argfield = $argfield;
1.32 matthew 2272:
2273: function changed_radio(choice,currentform) {
2274: var choicearg = choice + 'arg';
2275: // If a radio button in changed, we need to change the argfield
2276: if (current.radiovalue != choice) {
2277: current.radiovalue = choice;
2278: if (current.argfield != null) {
2279: currentform.elements[current.argfield].value = '';
2280: }
2281: if (choice == 'nochange') {
2282: current.argfield = null;
2283: } else {
2284: current.argfield = choicearg;
2285: switch(choice) {
2286: case 'krb':
2287: currentform.elements[current.argfield].value =
2288: "$in{'kerb_def_dom'}";
2289: break;
2290: default:
2291: break;
2292: }
2293: }
2294: }
2295: return;
2296: }
1.22 www 2297:
1.32 matthew 2298: function changed_text(choice,currentform) {
2299: var choicearg = choice + 'arg';
2300: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2301: $Javascript_toUpperCase
1.32 matthew 2302: // clear old field
2303: if ((current.argfield != choicearg) && (current.argfield != null)) {
2304: currentform.elements[current.argfield].value = '';
2305: }
2306: current.argfield = choicearg;
2307: }
2308: set_auth_radio_buttons(choice,currentform);
2309: return;
1.20 www 2310: }
1.32 matthew 2311:
2312: function set_auth_radio_buttons(newvalue,currentform) {
1.986 raeburn 2313: var numauthchoices = currentform.login.length;
2314: if (typeof numauthchoices == "undefined") {
2315: return;
2316: }
1.32 matthew 2317: var i=0;
1.986 raeburn 2318: while (i < numauthchoices) {
1.32 matthew 2319: if (currentform.login[i].value == newvalue) { break; }
2320: i++;
2321: }
1.986 raeburn 2322: if (i == numauthchoices) {
1.32 matthew 2323: return;
2324: }
2325: current.radiovalue = newvalue;
2326: currentform.login[i].checked = true;
2327: return;
2328: }
2329: END
2330: return $result;
2331: }
2332:
2333: sub authform_authorwarning{
2334: my $result='';
1.144 matthew 2335: $result='<i>'.
2336: &mt('As a general rule, only authors or co-authors should be '.
2337: 'filesystem authenticated '.
2338: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2339: return $result;
2340: }
2341:
2342: sub authform_nochange{
2343: my %in = (
2344: formname => 'document.cu',
2345: kerb_def_dom => 'MSU.EDU',
2346: @_,
2347: );
1.586 raeburn 2348: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2349: my $result;
2350: if (keys(%can_assign) == 0) {
2351: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2352: } else {
2353: $result = '<label>'.&mt('[_1] Do not change login data',
2354: '<input type="radio" name="login" value="nochange" '.
2355: 'checked="checked" onclick="'.
1.281 albertel 2356: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2357: '</label>';
1.586 raeburn 2358: }
1.32 matthew 2359: return $result;
2360: }
2361:
1.591 raeburn 2362: sub authform_kerberos {
1.32 matthew 2363: my %in = (
2364: formname => 'document.cu',
2365: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2366: kerb_def_auth => 'krb4',
1.32 matthew 2367: @_,
2368: );
1.586 raeburn 2369: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2370: $autharg,$jscall);
2371: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2372: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2373: $check5 = ' checked="checked"';
1.80 albertel 2374: } else {
1.772 bisitz 2375: $check4 = ' checked="checked"';
1.80 albertel 2376: }
1.165 raeburn 2377: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2378: if (defined($in{'curr_authtype'})) {
2379: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2380: $krbcheck = ' checked="checked"';
1.623 raeburn 2381: if (defined($in{'mode'})) {
2382: if ($in{'mode'} eq 'modifyuser') {
2383: $krbcheck = '';
2384: }
2385: }
1.591 raeburn 2386: if (defined($in{'curr_kerb_ver'})) {
2387: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2388: $check5 = ' checked="checked"';
1.591 raeburn 2389: $check4 = '';
2390: } else {
1.772 bisitz 2391: $check4 = ' checked="checked"';
1.591 raeburn 2392: $check5 = '';
2393: }
1.586 raeburn 2394: }
1.591 raeburn 2395: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2396: $krbarg = $in{'curr_autharg'};
2397: }
1.586 raeburn 2398: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2399: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2400: $result =
2401: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2402: $in{'curr_autharg'},$krbver);
2403: } else {
2404: $result =
2405: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2406: }
2407: return $result;
2408: }
2409: }
2410: } else {
2411: if ($authnum == 1) {
1.784 bisitz 2412: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2413: }
2414: }
1.586 raeburn 2415: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2416: return;
1.587 raeburn 2417: } elsif ($authtype eq '') {
1.591 raeburn 2418: if (defined($in{'mode'})) {
1.587 raeburn 2419: if ($in{'mode'} eq 'modifycourse') {
2420: if ($authnum == 1) {
1.784 bisitz 2421: $authtype = '<input type="hidden" name="login" value="krb" />';
1.587 raeburn 2422: }
2423: }
2424: }
1.586 raeburn 2425: }
2426: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2427: if ($authtype eq '') {
2428: $authtype = '<input type="radio" name="login" value="krb" '.
2429: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2430: $krbcheck.' />';
2431: }
2432: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2433: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2434: $in{'curr_authtype'} eq 'krb5') ||
2435: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2436: $in{'curr_authtype'} eq 'krb4')) {
2437: $result .= &mt
1.144 matthew 2438: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2439: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2440: '<label>'.$authtype,
1.281 albertel 2441: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2442: 'value="'.$krbarg.'" '.
1.144 matthew 2443: 'onchange="'.$jscall.'" />',
1.281 albertel 2444: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2445: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2446: '</label>');
1.586 raeburn 2447: } elsif ($can_assign{'krb4'}) {
2448: $result .= &mt
2449: ('[_1] Kerberos authenticated with domain [_2] '.
2450: '[_3] Version 4 [_4]',
2451: '<label>'.$authtype,
2452: '</label><input type="text" size="10" name="krbarg" '.
2453: 'value="'.$krbarg.'" '.
2454: 'onchange="'.$jscall.'" />',
2455: '<label><input type="hidden" name="krbver" value="4" />',
2456: '</label>');
2457: } elsif ($can_assign{'krb5'}) {
2458: $result .= &mt
2459: ('[_1] Kerberos authenticated with domain [_2] '.
2460: '[_3] Version 5 [_4]',
2461: '<label>'.$authtype,
2462: '</label><input type="text" size="10" name="krbarg" '.
2463: 'value="'.$krbarg.'" '.
2464: 'onchange="'.$jscall.'" />',
2465: '<label><input type="hidden" name="krbver" value="5" />',
2466: '</label>');
2467: }
1.32 matthew 2468: return $result;
2469: }
2470:
2471: sub authform_internal{
1.586 raeburn 2472: my %in = (
1.32 matthew 2473: formname => 'document.cu',
2474: kerb_def_dom => 'MSU.EDU',
2475: @_,
2476: );
1.586 raeburn 2477: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2478: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2479: if (defined($in{'curr_authtype'})) {
2480: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2481: if ($can_assign{'int'}) {
1.772 bisitz 2482: $intcheck = 'checked="checked" ';
1.623 raeburn 2483: if (defined($in{'mode'})) {
2484: if ($in{'mode'} eq 'modifyuser') {
2485: $intcheck = '';
2486: }
2487: }
1.591 raeburn 2488: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2489: $intarg = $in{'curr_autharg'};
2490: }
2491: } else {
2492: $result = &mt('Currently internally authenticated.');
2493: return $result;
1.165 raeburn 2494: }
2495: }
1.586 raeburn 2496: } else {
2497: if ($authnum == 1) {
1.784 bisitz 2498: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 2499: }
2500: }
2501: if (!$can_assign{'int'}) {
2502: return;
1.587 raeburn 2503: } elsif ($authtype eq '') {
1.591 raeburn 2504: if (defined($in{'mode'})) {
1.587 raeburn 2505: if ($in{'mode'} eq 'modifycourse') {
2506: if ($authnum == 1) {
1.784 bisitz 2507: $authtype = '<input type="hidden" name="login" value="int" />';
1.587 raeburn 2508: }
2509: }
2510: }
1.165 raeburn 2511: }
1.586 raeburn 2512: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2513: if ($authtype eq '') {
2514: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2515: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2516: }
1.605 bisitz 2517: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2518: $intarg.'" onchange="'.$jscall.'" />';
2519: $result = &mt
1.144 matthew 2520: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2521: '<label>'.$authtype,'</label>'.$autharg);
1.824 bisitz 2522: $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 2523: return $result;
2524: }
2525:
2526: sub authform_local{
2527: my %in = (
2528: formname => 'document.cu',
2529: kerb_def_dom => 'MSU.EDU',
2530: @_,
2531: );
1.586 raeburn 2532: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2533: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2534: if (defined($in{'curr_authtype'})) {
2535: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2536: if ($can_assign{'loc'}) {
1.772 bisitz 2537: $loccheck = 'checked="checked" ';
1.623 raeburn 2538: if (defined($in{'mode'})) {
2539: if ($in{'mode'} eq 'modifyuser') {
2540: $loccheck = '';
2541: }
2542: }
1.591 raeburn 2543: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2544: $locarg = $in{'curr_autharg'};
2545: }
2546: } else {
2547: $result = &mt('Currently using local (institutional) authentication.');
2548: return $result;
1.165 raeburn 2549: }
2550: }
1.586 raeburn 2551: } else {
2552: if ($authnum == 1) {
1.784 bisitz 2553: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 2554: }
2555: }
2556: if (!$can_assign{'loc'}) {
2557: return;
1.587 raeburn 2558: } elsif ($authtype eq '') {
1.591 raeburn 2559: if (defined($in{'mode'})) {
1.587 raeburn 2560: if ($in{'mode'} eq 'modifycourse') {
2561: if ($authnum == 1) {
1.784 bisitz 2562: $authtype = '<input type="hidden" name="login" value="loc" />';
1.587 raeburn 2563: }
2564: }
2565: }
1.165 raeburn 2566: }
1.586 raeburn 2567: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2568: if ($authtype eq '') {
2569: $authtype = '<input type="radio" name="login" value="loc" '.
2570: $loccheck.' onchange="'.$jscall.'" onclick="'.
2571: $jscall.'" />';
2572: }
2573: $autharg = '<input type="text" size="10" name="locarg" value="'.
2574: $locarg.'" onchange="'.$jscall.'" />';
2575: $result = &mt('[_1] Local Authentication with argument [_2]',
2576: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2577: return $result;
2578: }
2579:
2580: sub authform_filesystem{
2581: my %in = (
2582: formname => 'document.cu',
2583: kerb_def_dom => 'MSU.EDU',
2584: @_,
2585: );
1.586 raeburn 2586: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2587: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2588: if (defined($in{'curr_authtype'})) {
2589: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2590: if ($can_assign{'fsys'}) {
1.772 bisitz 2591: $fsyscheck = 'checked="checked" ';
1.623 raeburn 2592: if (defined($in{'mode'})) {
2593: if ($in{'mode'} eq 'modifyuser') {
2594: $fsyscheck = '';
2595: }
2596: }
1.586 raeburn 2597: } else {
2598: $result = &mt('Currently Filesystem Authenticated.');
2599: return $result;
2600: }
2601: }
2602: } else {
2603: if ($authnum == 1) {
1.784 bisitz 2604: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 2605: }
2606: }
2607: if (!$can_assign{'fsys'}) {
2608: return;
1.587 raeburn 2609: } elsif ($authtype eq '') {
1.591 raeburn 2610: if (defined($in{'mode'})) {
1.587 raeburn 2611: if ($in{'mode'} eq 'modifycourse') {
2612: if ($authnum == 1) {
1.784 bisitz 2613: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587 raeburn 2614: }
2615: }
2616: }
1.586 raeburn 2617: }
2618: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2619: if ($authtype eq '') {
2620: $authtype = '<input type="radio" name="login" value="fsys" '.
2621: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2622: $jscall.'" />';
2623: }
2624: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2625: ' onchange="'.$jscall.'" />';
2626: $result = &mt
1.144 matthew 2627: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2628: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2629: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2630: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2631: 'onchange="'.$jscall.'" />');
1.32 matthew 2632: return $result;
2633: }
2634:
1.586 raeburn 2635: sub get_assignable_auth {
2636: my ($dom) = @_;
2637: if ($dom eq '') {
2638: $dom = $env{'request.role.domain'};
2639: }
2640: my %can_assign = (
2641: krb4 => 1,
2642: krb5 => 1,
2643: int => 1,
2644: loc => 1,
2645: );
2646: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2647: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2648: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2649: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2650: my $context;
2651: if ($env{'request.role'} =~ /^au/) {
2652: $context = 'author';
2653: } elsif ($env{'request.role'} =~ /^dc/) {
2654: $context = 'domain';
2655: } elsif ($env{'request.course.id'}) {
2656: $context = 'course';
2657: }
2658: if ($context) {
2659: if (ref($authhash->{$context}) eq 'HASH') {
2660: %can_assign = %{$authhash->{$context}};
2661: }
2662: }
2663: }
2664: }
2665: my $authnum = 0;
2666: foreach my $key (keys(%can_assign)) {
2667: if ($can_assign{$key}) {
2668: $authnum ++;
2669: }
2670: }
2671: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2672: $authnum --;
2673: }
2674: return ($authnum,%can_assign);
2675: }
2676:
1.80 albertel 2677: ###############################################################
2678: ## Get Kerberos Defaults for Domain ##
2679: ###############################################################
2680: ##
2681: ## Returns default kerberos version and an associated argument
2682: ## as listed in file domain.tab. If not listed, provides
2683: ## appropriate default domain and kerberos version.
2684: ##
2685: #-------------------------------------------
2686:
2687: =pod
2688:
1.648 raeburn 2689: =item * &get_kerberos_defaults()
1.80 albertel 2690:
2691: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2692: version and domain. If not found, it defaults to version 4 and the
2693: domain of the server.
1.80 albertel 2694:
1.648 raeburn 2695: =over 4
2696:
1.80 albertel 2697: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2698:
1.648 raeburn 2699: =back
2700:
2701: =back
2702:
1.80 albertel 2703: =cut
2704:
2705: #-------------------------------------------
2706: sub get_kerberos_defaults {
2707: my $domain=shift;
1.641 raeburn 2708: my ($krbdef,$krbdefdom);
2709: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2710: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2711: $krbdef = $domdefaults{'auth_def'};
2712: $krbdefdom = $domdefaults{'auth_arg_def'};
2713: } else {
1.80 albertel 2714: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2715: my $krbdefdom=$1;
2716: $krbdefdom=~tr/a-z/A-Z/;
2717: $krbdef = "krb4";
2718: }
2719: return ($krbdef,$krbdefdom);
2720: }
1.112 bowersj2 2721:
1.32 matthew 2722:
1.46 matthew 2723: ###############################################################
2724: ## Thesaurus Functions ##
2725: ###############################################################
1.20 www 2726:
1.46 matthew 2727: =pod
1.20 www 2728:
1.112 bowersj2 2729: =head1 Thesaurus Functions
2730:
2731: =over 4
2732:
1.648 raeburn 2733: =item * &initialize_keywords()
1.46 matthew 2734:
2735: Initializes the package variable %Keywords if it is empty. Uses the
2736: package variable $thesaurus_db_file.
2737:
2738: =cut
2739:
2740: ###################################################
2741:
2742: sub initialize_keywords {
2743: return 1 if (scalar keys(%Keywords));
2744: # If we are here, %Keywords is empty, so fill it up
2745: # Make sure the file we need exists...
2746: if (! -e $thesaurus_db_file) {
2747: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2748: " failed because it does not exist");
2749: return 0;
2750: }
2751: # Set up the hash as a database
2752: my %thesaurus_db;
2753: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2754: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2755: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2756: $thesaurus_db_file);
2757: return 0;
2758: }
2759: # Get the average number of appearances of a word.
2760: my $avecount = $thesaurus_db{'average.count'};
2761: # Put keywords (those that appear > average) into %Keywords
2762: while (my ($word,$data)=each (%thesaurus_db)) {
2763: my ($count,undef) = split /:/,$data;
2764: $Keywords{$word}++ if ($count > $avecount);
2765: }
2766: untie %thesaurus_db;
2767: # Remove special values from %Keywords.
1.356 albertel 2768: foreach my $value ('total.count','average.count') {
2769: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2770: }
1.46 matthew 2771: return 1;
2772: }
2773:
2774: ###################################################
2775:
2776: =pod
2777:
1.648 raeburn 2778: =item * &keyword($word)
1.46 matthew 2779:
2780: Returns true if $word is a keyword. A keyword is a word that appears more
2781: than the average number of times in the thesaurus database. Calls
2782: &initialize_keywords
2783:
2784: =cut
2785:
2786: ###################################################
1.20 www 2787:
2788: sub keyword {
1.46 matthew 2789: return if (!&initialize_keywords());
2790: my $word=lc(shift());
2791: $word=~s/\W//g;
2792: return exists($Keywords{$word});
1.20 www 2793: }
1.46 matthew 2794:
2795: ###############################################################
2796:
2797: =pod
1.20 www 2798:
1.648 raeburn 2799: =item * &get_related_words()
1.46 matthew 2800:
1.160 matthew 2801: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2802: an array of words. If the keyword is not in the thesaurus, an empty array
2803: will be returned. The order of the words returned is determined by the
2804: database which holds them.
2805:
2806: Uses global $thesaurus_db_file.
2807:
2808: =cut
2809:
2810: ###############################################################
2811: sub get_related_words {
2812: my $keyword = shift;
2813: my %thesaurus_db;
2814: if (! -e $thesaurus_db_file) {
2815: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2816: "failed because the file does not exist");
2817: return ();
2818: }
2819: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2820: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2821: return ();
2822: }
2823: my @Words=();
1.429 www 2824: my $count=0;
1.46 matthew 2825: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2826: # The first element is the number of times
2827: # the word appears. We do not need it now.
1.429 www 2828: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2829: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2830: my $threshold=$mostfrequentcount/10;
2831: foreach my $possibleword (@RelatedWords) {
2832: my ($word,$wordcount)=split(/\,/,$possibleword);
2833: if ($wordcount>$threshold) {
2834: push(@Words,$word);
2835: $count++;
2836: if ($count>10) { last; }
2837: }
1.20 www 2838: }
2839: }
1.46 matthew 2840: untie %thesaurus_db;
2841: return @Words;
1.14 harris41 2842: }
1.46 matthew 2843:
1.112 bowersj2 2844: =pod
2845:
2846: =back
2847:
2848: =cut
1.61 www 2849:
2850: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2851: =pod
2852:
1.112 bowersj2 2853: =head1 User Name Functions
2854:
2855: =over 4
2856:
1.648 raeburn 2857: =item * &plainname($uname,$udom,$first)
1.81 albertel 2858:
1.112 bowersj2 2859: Takes a users logon name and returns it as a string in
1.226 albertel 2860: "first middle last generation" form
2861: if $first is set to 'lastname' then it returns it as
2862: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2863:
2864: =cut
1.61 www 2865:
1.295 www 2866:
1.81 albertel 2867: ###############################################################
1.61 www 2868: sub plainname {
1.226 albertel 2869: my ($uname,$udom,$first)=@_;
1.537 albertel 2870: return if (!defined($uname) || !defined($udom));
1.295 www 2871: my %names=&getnames($uname,$udom);
1.226 albertel 2872: my $name=&Apache::lonnet::format_name($names{'firstname'},
2873: $names{'middlename'},
2874: $names{'lastname'},
2875: $names{'generation'},$first);
2876: $name=~s/^\s+//;
1.62 www 2877: $name=~s/\s+$//;
2878: $name=~s/\s+/ /g;
1.353 albertel 2879: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2880: return $name;
1.61 www 2881: }
1.66 www 2882:
2883: # -------------------------------------------------------------------- Nickname
1.81 albertel 2884: =pod
2885:
1.648 raeburn 2886: =item * &nickname($uname,$udom)
1.81 albertel 2887:
2888: Gets a users name and returns it as a string as
2889:
2890: ""nickname""
1.66 www 2891:
1.81 albertel 2892: if the user has a nickname or
2893:
2894: "first middle last generation"
2895:
2896: if the user does not
2897:
2898: =cut
1.66 www 2899:
2900: sub nickname {
2901: my ($uname,$udom)=@_;
1.537 albertel 2902: return if (!defined($uname) || !defined($udom));
1.295 www 2903: my %names=&getnames($uname,$udom);
1.68 albertel 2904: my $name=$names{'nickname'};
1.66 www 2905: if ($name) {
2906: $name='"'.$name.'"';
2907: } else {
2908: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2909: $names{'lastname'}.' '.$names{'generation'};
2910: $name=~s/\s+$//;
2911: $name=~s/\s+/ /g;
2912: }
2913: return $name;
2914: }
2915:
1.295 www 2916: sub getnames {
2917: my ($uname,$udom)=@_;
1.537 albertel 2918: return if (!defined($uname) || !defined($udom));
1.433 albertel 2919: if ($udom eq 'public' && $uname eq 'public') {
2920: return ('lastname' => &mt('Public'));
2921: }
1.295 www 2922: my $id=$uname.':'.$udom;
2923: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2924: if ($cached) {
2925: return %{$names};
2926: } else {
2927: my %loadnames=&Apache::lonnet::get('environment',
2928: ['firstname','middlename','lastname','generation','nickname'],
2929: $udom,$uname);
2930: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2931: return %loadnames;
2932: }
2933: }
1.61 www 2934:
1.542 raeburn 2935: # -------------------------------------------------------------------- getemails
1.648 raeburn 2936:
1.542 raeburn 2937: =pod
2938:
1.648 raeburn 2939: =item * &getemails($uname,$udom)
1.542 raeburn 2940:
2941: Gets a user's email information and returns it as a hash with keys:
2942: notification, critnotification, permanentemail
2943:
2944: For notification and critnotification, values are comma-separated lists
1.648 raeburn 2945: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 2946:
1.648 raeburn 2947:
1.542 raeburn 2948: =cut
2949:
1.648 raeburn 2950:
1.466 albertel 2951: sub getemails {
2952: my ($uname,$udom)=@_;
2953: if ($udom eq 'public' && $uname eq 'public') {
2954: return;
2955: }
1.467 www 2956: if (!$udom) { $udom=$env{'user.domain'}; }
2957: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 2958: my $id=$uname.':'.$udom;
2959: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2960: if ($cached) {
2961: return %{$names};
2962: } else {
2963: my %loadnames=&Apache::lonnet::get('environment',
2964: ['notification','critnotification',
2965: 'permanentemail'],
2966: $udom,$uname);
2967: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2968: return %loadnames;
2969: }
2970: }
2971:
1.551 albertel 2972: sub flush_email_cache {
2973: my ($uname,$udom)=@_;
2974: if (!$udom) { $udom =$env{'user.domain'}; }
2975: if (!$uname) { $uname=$env{'user.name'}; }
2976: return if ($udom eq 'public' && $uname eq 'public');
2977: my $id=$uname.':'.$udom;
2978: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2979: }
2980:
1.728 raeburn 2981: # -------------------------------------------------------------------- getlangs
2982:
2983: =pod
2984:
2985: =item * &getlangs($uname,$udom)
2986:
2987: Gets a user's language preference and returns it as a hash with key:
2988: language.
2989:
2990: =cut
2991:
2992:
2993: sub getlangs {
2994: my ($uname,$udom) = @_;
2995: if (!$udom) { $udom =$env{'user.domain'}; }
2996: if (!$uname) { $uname=$env{'user.name'}; }
2997: my $id=$uname.':'.$udom;
2998: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
2999: if ($cached) {
3000: return %{$langs};
3001: } else {
3002: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
3003: $udom,$uname);
3004: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
3005: return %loadlangs;
3006: }
3007: }
3008:
3009: sub flush_langs_cache {
3010: my ($uname,$udom)=@_;
3011: if (!$udom) { $udom =$env{'user.domain'}; }
3012: if (!$uname) { $uname=$env{'user.name'}; }
3013: return if ($udom eq 'public' && $uname eq 'public');
3014: my $id=$uname.':'.$udom;
3015: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
3016: }
3017:
1.61 www 3018: # ------------------------------------------------------------------ Screenname
1.81 albertel 3019:
3020: =pod
3021:
1.648 raeburn 3022: =item * &screenname($uname,$udom)
1.81 albertel 3023:
3024: Gets a users screenname and returns it as a string
3025:
3026: =cut
1.61 www 3027:
3028: sub screenname {
3029: my ($uname,$udom)=@_;
1.258 albertel 3030: if ($uname eq $env{'user.name'} &&
3031: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 3032: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 3033: return $names{'screenname'};
1.62 www 3034: }
3035:
1.212 albertel 3036:
1.802 bisitz 3037: # ------------------------------------------------------------- Confirm Wrapper
3038: =pod
3039:
3040: =item confirmwrapper
3041:
3042: Wrap messages about completion of operation in box
3043:
3044: =cut
3045:
3046: sub confirmwrapper {
3047: my ($message)=@_;
3048: if ($message) {
3049: return "\n".'<div class="LC_confirm_box">'."\n"
3050: .$message."\n"
3051: .'</div>'."\n";
3052: } else {
3053: return $message;
3054: }
3055: }
3056:
1.62 www 3057: # ------------------------------------------------------------- Message Wrapper
3058:
3059: sub messagewrapper {
1.369 www 3060: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 3061: return
1.441 albertel 3062: '<a href="/adm/email?compose=individual&'.
3063: 'recname='.$username.'&recdom='.$domain.
3064: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 3065: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 3066: }
1.802 bisitz 3067:
1.74 www 3068: # --------------------------------------------------------------- Notes Wrapper
3069:
3070: sub noteswrapper {
3071: my ($link,$un,$do)=@_;
3072: return
1.896 amueller 3073: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 3074: }
1.802 bisitz 3075:
1.62 www 3076: # ------------------------------------------------------------- Aboutme Wrapper
3077:
3078: sub aboutmewrapper {
1.166 www 3079: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 3080: if (!defined($username) && !defined($domain)) {
3081: return;
3082: }
1.892 amueller 3083: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.756 weissno 3084: ($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 3085: }
3086:
3087: # ------------------------------------------------------------ Syllabus Wrapper
3088:
3089: sub syllabuswrapper {
1.707 bisitz 3090: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 3091: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 3092: }
1.14 harris41 3093:
1.802 bisitz 3094: # -----------------------------------------------------------------------------
3095:
1.208 matthew 3096: sub track_student_link {
1.887 raeburn 3097: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 3098: my $link ="/adm/trackstudent?";
1.208 matthew 3099: my $title = 'View recent activity';
3100: if (defined($sname) && $sname !~ /^\s*$/ &&
3101: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 3102: $link .= "selected_student=$sname:$sdom";
1.208 matthew 3103: $title .= ' of this student';
1.268 albertel 3104: }
1.208 matthew 3105: if (defined($target) && $target !~ /^\s*$/) {
3106: $target = qq{target="$target"};
3107: } else {
3108: $target = '';
3109: }
1.268 albertel 3110: if ($start) { $link.='&start='.$start; }
1.887 raeburn 3111: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 3112: $title = &mt($title);
3113: $linktext = &mt($linktext);
1.448 albertel 3114: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
3115: &help_open_topic('View_recent_activity');
1.208 matthew 3116: }
3117:
1.781 raeburn 3118: sub slot_reservations_link {
3119: my ($linktext,$sname,$sdom,$target) = @_;
3120: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
3121: my $title = 'View slot reservation history';
3122: if (defined($sname) && $sname !~ /^\s*$/ &&
3123: defined($sdom) && $sdom !~ /^\s*$/) {
3124: $link .= "&uname=$sname&udom=$sdom";
3125: $title .= ' of this student';
3126: }
3127: if (defined($target) && $target !~ /^\s*$/) {
3128: $target = qq{target="$target"};
3129: } else {
3130: $target = '';
3131: }
3132: $title = &mt($title);
3133: $linktext = &mt($linktext);
3134: return qq{<a href="$link" title="$title" $target>$linktext</a>};
3135: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
3136:
3137: }
3138:
1.508 www 3139: # ===================================================== Display a student photo
3140:
3141:
1.509 albertel 3142: sub student_image_tag {
1.508 www 3143: my ($domain,$user)=@_;
3144: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
3145: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
3146: return '<img src="'.$imgsrc.'" align="right" />';
3147: } else {
3148: return '';
3149: }
3150: }
3151:
1.112 bowersj2 3152: =pod
3153:
3154: =back
3155:
3156: =head1 Access .tab File Data
3157:
3158: =over 4
3159:
1.648 raeburn 3160: =item * &languageids()
1.112 bowersj2 3161:
3162: returns list of all language ids
3163:
3164: =cut
3165:
1.14 harris41 3166: sub languageids {
1.16 harris41 3167: return sort(keys(%language));
1.14 harris41 3168: }
3169:
1.112 bowersj2 3170: =pod
3171:
1.648 raeburn 3172: =item * &languagedescription()
1.112 bowersj2 3173:
3174: returns description of a specified language id
3175:
3176: =cut
3177:
1.14 harris41 3178: sub languagedescription {
1.125 www 3179: my $code=shift;
3180: return ($supported_language{$code}?'* ':'').
3181: $language{$code}.
1.126 www 3182: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 3183: }
3184:
3185: sub plainlanguagedescription {
3186: my $code=shift;
3187: return $language{$code};
3188: }
3189:
3190: sub supportedlanguagecode {
3191: my $code=shift;
3192: return $supported_language{$code};
1.97 www 3193: }
3194:
1.112 bowersj2 3195: =pod
3196:
1.648 raeburn 3197: =item * ©rightids()
1.112 bowersj2 3198:
3199: returns list of all copyrights
3200:
3201: =cut
3202:
3203: sub copyrightids {
3204: return sort(keys(%cprtag));
3205: }
3206:
3207: =pod
3208:
1.648 raeburn 3209: =item * ©rightdescription()
1.112 bowersj2 3210:
3211: returns description of a specified copyright id
3212:
3213: =cut
3214:
3215: sub copyrightdescription {
1.166 www 3216: return &mt($cprtag{shift(@_)});
1.112 bowersj2 3217: }
1.197 matthew 3218:
3219: =pod
3220:
1.648 raeburn 3221: =item * &source_copyrightids()
1.192 taceyjo1 3222:
3223: returns list of all source copyrights
3224:
3225: =cut
3226:
3227: sub source_copyrightids {
3228: return sort(keys(%scprtag));
3229: }
3230:
3231: =pod
3232:
1.648 raeburn 3233: =item * &source_copyrightdescription()
1.192 taceyjo1 3234:
3235: returns description of a specified source copyright id
3236:
3237: =cut
3238:
3239: sub source_copyrightdescription {
3240: return &mt($scprtag{shift(@_)});
3241: }
1.112 bowersj2 3242:
3243: =pod
3244:
1.648 raeburn 3245: =item * &filecategories()
1.112 bowersj2 3246:
3247: returns list of all file categories
3248:
3249: =cut
3250:
3251: sub filecategories {
3252: return sort(keys(%category_extensions));
3253: }
3254:
3255: =pod
3256:
1.648 raeburn 3257: =item * &filecategorytypes()
1.112 bowersj2 3258:
3259: returns list of file types belonging to a given file
3260: category
3261:
3262: =cut
3263:
3264: sub filecategorytypes {
1.356 albertel 3265: my ($cat) = @_;
3266: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 3267: }
3268:
3269: =pod
3270:
1.648 raeburn 3271: =item * &fileembstyle()
1.112 bowersj2 3272:
3273: returns embedding style for a specified file type
3274:
3275: =cut
3276:
3277: sub fileembstyle {
3278: return $fe{lc(shift(@_))};
1.169 www 3279: }
3280:
1.351 www 3281: sub filemimetype {
3282: return $fm{lc(shift(@_))};
3283: }
3284:
1.169 www 3285:
3286: sub filecategoryselect {
3287: my ($name,$value)=@_;
1.189 matthew 3288: return &select_form($value,$name,
1.970 raeburn 3289: {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112 bowersj2 3290: }
3291:
3292: =pod
3293:
1.648 raeburn 3294: =item * &filedescription()
1.112 bowersj2 3295:
3296: returns description for a specified file type
3297:
3298: =cut
3299:
3300: sub filedescription {
1.188 matthew 3301: my $file_description = $fd{lc(shift())};
3302: $file_description =~ s:([\[\]]):~$1:g;
3303: return &mt($file_description);
1.112 bowersj2 3304: }
3305:
3306: =pod
3307:
1.648 raeburn 3308: =item * &filedescriptionex()
1.112 bowersj2 3309:
3310: returns description for a specified file type with
3311: extra formatting
3312:
3313: =cut
3314:
3315: sub filedescriptionex {
3316: my $ex=shift;
1.188 matthew 3317: my $file_description = $fd{lc($ex)};
3318: $file_description =~ s:([\[\]]):~$1:g;
3319: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3320: }
3321:
3322: # End of .tab access
3323: =pod
3324:
3325: =back
3326:
3327: =cut
3328:
3329: # ------------------------------------------------------------------ File Types
3330: sub fileextensions {
3331: return sort(keys(%fe));
3332: }
3333:
1.97 www 3334: # ----------------------------------------------------------- Display Languages
3335: # returns a hash with all desired display languages
3336: #
3337:
3338: sub display_languages {
3339: my %languages=();
1.695 raeburn 3340: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3341: $languages{$lang}=1;
1.97 www 3342: }
3343: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3344: if ($env{'form.displaylanguage'}) {
1.356 albertel 3345: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3346: $languages{$lang}=1;
1.97 www 3347: }
3348: }
3349: return %languages;
1.14 harris41 3350: }
3351:
1.582 albertel 3352: sub languages {
3353: my ($possible_langs) = @_;
1.695 raeburn 3354: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3355: if (!ref($possible_langs)) {
3356: if( wantarray ) {
3357: return @preferred_langs;
3358: } else {
3359: return $preferred_langs[0];
3360: }
3361: }
3362: my %possibilities = map { $_ => 1 } (@$possible_langs);
3363: my @preferred_possibilities;
3364: foreach my $preferred_lang (@preferred_langs) {
3365: if (exists($possibilities{$preferred_lang})) {
3366: push(@preferred_possibilities, $preferred_lang);
3367: }
3368: }
3369: if( wantarray ) {
3370: return @preferred_possibilities;
3371: }
3372: return $preferred_possibilities[0];
3373: }
3374:
1.742 raeburn 3375: sub user_lang {
3376: my ($touname,$toudom,$fromcid) = @_;
3377: my @userlangs;
3378: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3379: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3380: $env{'course.'.$fromcid.'.languages'}));
3381: } else {
3382: my %langhash = &getlangs($touname,$toudom);
3383: if ($langhash{'languages'} ne '') {
3384: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3385: } else {
3386: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3387: if ($domdefs{'lang_def'} ne '') {
3388: @userlangs = ($domdefs{'lang_def'});
3389: }
3390: }
3391: }
3392: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3393: my $user_lh = Apache::localize->get_handle(@languages);
3394: return $user_lh;
3395: }
3396:
3397:
1.112 bowersj2 3398: ###############################################################
3399: ## Student Answer Attempts ##
3400: ###############################################################
3401:
3402: =pod
3403:
3404: =head1 Alternate Problem Views
3405:
3406: =over 4
3407:
1.648 raeburn 3408: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3409: $getattempt, $regexp, $gradesub)
3410:
3411: Return string with previous attempt on problem. Arguments:
3412:
3413: =over 4
3414:
3415: =item * $symb: Problem, including path
3416:
3417: =item * $username: username of the desired student
3418:
3419: =item * $domain: domain of the desired student
1.14 harris41 3420:
1.112 bowersj2 3421: =item * $course: Course ID
1.14 harris41 3422:
1.112 bowersj2 3423: =item * $getattempt: Leave blank for all attempts, otherwise put
3424: something
1.14 harris41 3425:
1.112 bowersj2 3426: =item * $regexp: if string matches this regexp, the string will be
3427: sent to $gradesub
1.14 harris41 3428:
1.112 bowersj2 3429: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3430:
1.112 bowersj2 3431: =back
1.14 harris41 3432:
1.112 bowersj2 3433: The output string is a table containing all desired attempts, if any.
1.16 harris41 3434:
1.112 bowersj2 3435: =cut
1.1 albertel 3436:
3437: sub get_previous_attempt {
1.43 ng 3438: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3439: my $prevattempts='';
1.43 ng 3440: no strict 'refs';
1.1 albertel 3441: if ($symb) {
1.3 albertel 3442: my (%returnhash)=
3443: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3444: if ($returnhash{'version'}) {
3445: my %lasthash=();
3446: my $version;
3447: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3448: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3449: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3450: }
1.1 albertel 3451: }
1.596 albertel 3452: $prevattempts=&start_data_table().&start_data_table_header_row();
3453: $prevattempts.='<th>'.&mt('History').'</th>';
1.978 raeburn 3454: my (%typeparts,%lasthidden);
1.945 raeburn 3455: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 3456: foreach my $key (sort(keys(%lasthash))) {
3457: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3458: if ($#parts > 0) {
1.31 albertel 3459: my $data=$parts[-1];
1.989 raeburn 3460: next if ($data eq 'foilorder');
1.31 albertel 3461: pop(@parts);
1.1010 www 3462: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.945 raeburn 3463: if ($data eq 'type') {
3464: unless ($showsurv) {
3465: my $id = join(',',@parts);
3466: $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978 raeburn 3467: if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
3468: $lasthidden{$ign.'.'.$id} = 1;
3469: }
1.945 raeburn 3470: }
1.1010 www 3471: }
1.31 albertel 3472: } else {
1.41 ng 3473: if ($#parts == 0) {
3474: $prevattempts.='<th>'.$parts[0].'</th>';
3475: } else {
3476: $prevattempts.='<th>'.$ign.'</th>';
3477: }
1.31 albertel 3478: }
1.16 harris41 3479: }
1.596 albertel 3480: $prevattempts.=&end_data_table_header_row();
1.40 ng 3481: if ($getattempt eq '') {
3482: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.945 raeburn 3483: my @hidden;
3484: if (%typeparts) {
3485: foreach my $id (keys(%typeparts)) {
3486: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
3487: push(@hidden,$id);
3488: }
3489: }
3490: }
3491: $prevattempts.=&start_data_table_row().
3492: '<td>'.&mt('Transaction [_1]',$version).'</td>';
3493: if (@hidden) {
3494: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3495: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3496: my $hide;
3497: foreach my $id (@hidden) {
3498: if ($key =~ /^\Q$id\E/) {
3499: $hide = 1;
3500: last;
3501: }
3502: }
3503: if ($hide) {
3504: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3505: if (($data eq 'award') || ($data eq 'awarddetail')) {
3506: my $value = &format_previous_attempt_value($key,
3507: $returnhash{$version.':'.$key});
3508: $prevattempts.='<td>'.$value.' </td>';
3509: } else {
3510: $prevattempts.='<td> </td>';
3511: }
3512: } else {
3513: if ($key =~ /\./) {
3514: my $value = &format_previous_attempt_value($key,
3515: $returnhash{$version.':'.$key});
3516: $prevattempts.='<td>'.$value.' </td>';
3517: } else {
3518: $prevattempts.='<td> </td>';
3519: }
3520: }
3521: }
3522: } else {
3523: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3524: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3525: my $value = &format_previous_attempt_value($key,
3526: $returnhash{$version.':'.$key});
3527: $prevattempts.='<td>'.$value.' </td>';
3528: }
3529: }
3530: $prevattempts.=&end_data_table_row();
1.40 ng 3531: }
1.1 albertel 3532: }
1.945 raeburn 3533: my @currhidden = keys(%lasthidden);
1.596 albertel 3534: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3535: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3536: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3537: if (%typeparts) {
3538: my $hidden;
3539: foreach my $id (@currhidden) {
3540: if ($key =~ /^\Q$id\E/) {
3541: $hidden = 1;
3542: last;
3543: }
3544: }
3545: if ($hidden) {
3546: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3547: if (($data eq 'award') || ($data eq 'awarddetail')) {
3548: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3549: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3550: $value = &$gradesub($value);
3551: }
3552: $prevattempts.='<td>'.$value.' </td>';
3553: } else {
3554: $prevattempts.='<td> </td>';
3555: }
3556: } else {
3557: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3558: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3559: $value = &$gradesub($value);
3560: }
3561: $prevattempts.='<td>'.$value.' </td>';
3562: }
3563: } else {
3564: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3565: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3566: $value = &$gradesub($value);
3567: }
3568: $prevattempts.='<td>'.$value.' </td>';
3569: }
1.16 harris41 3570: }
1.596 albertel 3571: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3572: } else {
1.596 albertel 3573: $prevattempts=
3574: &start_data_table().&start_data_table_row().
3575: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3576: &end_data_table_row().&end_data_table();
1.1 albertel 3577: }
3578: } else {
1.596 albertel 3579: $prevattempts=
3580: &start_data_table().&start_data_table_row().
3581: '<td>'.&mt('No data.').'</td>'.
3582: &end_data_table_row().&end_data_table();
1.1 albertel 3583: }
1.10 albertel 3584: }
3585:
1.581 albertel 3586: sub format_previous_attempt_value {
3587: my ($key,$value) = @_;
1.1011 www 3588: if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.581 albertel 3589: $value = &Apache::lonlocal::locallocaltime($value);
3590: } elsif (ref($value) eq 'ARRAY') {
3591: $value = '('.join(', ', @{ $value }).')';
1.988 raeburn 3592: } elsif ($key =~ /answerstring$/) {
3593: my %answers = &Apache::lonnet::str2hash($value);
3594: my @anskeys = sort(keys(%answers));
3595: if (@anskeys == 1) {
3596: my $answer = $answers{$anskeys[0]};
1.1001 raeburn 3597: if ($answer =~ m{\0}) {
3598: $answer =~ s{\0}{,}g;
1.988 raeburn 3599: }
3600: my $tag_internal_answer_name = 'INTERNAL';
3601: if ($anskeys[0] eq $tag_internal_answer_name) {
3602: $value = $answer;
3603: } else {
3604: $value = $anskeys[0].'='.$answer;
3605: }
3606: } else {
3607: foreach my $ans (@anskeys) {
3608: my $answer = $answers{$ans};
1.1001 raeburn 3609: if ($answer =~ m{\0}) {
3610: $answer =~ s{\0}{,}g;
1.988 raeburn 3611: }
3612: $value .= $ans.'='.$answer.'<br />';;
3613: }
3614: }
1.581 albertel 3615: } else {
3616: $value = &unescape($value);
3617: }
3618: return $value;
3619: }
3620:
3621:
1.107 albertel 3622: sub relative_to_absolute {
3623: my ($url,$output)=@_;
3624: my $parser=HTML::TokeParser->new(\$output);
3625: my $token;
3626: my $thisdir=$url;
3627: my @rlinks=();
3628: while ($token=$parser->get_token) {
3629: if ($token->[0] eq 'S') {
3630: if ($token->[1] eq 'a') {
3631: if ($token->[2]->{'href'}) {
3632: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3633: }
3634: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3635: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3636: } elsif ($token->[1] eq 'base') {
3637: $thisdir=$token->[2]->{'href'};
3638: }
3639: }
3640: }
3641: $thisdir=~s-/[^/]*$--;
1.356 albertel 3642: foreach my $link (@rlinks) {
1.726 raeburn 3643: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3644: ($link=~/^\//) ||
3645: ($link=~/^javascript:/i) ||
3646: ($link=~/^mailto:/i) ||
3647: ($link=~/^\#/)) {
3648: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3649: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3650: }
3651: }
3652: # -------------------------------------------------- Deal with Applet codebases
3653: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3654: return $output;
3655: }
3656:
1.112 bowersj2 3657: =pod
3658:
1.648 raeburn 3659: =item * &get_student_view()
1.112 bowersj2 3660:
3661: show a snapshot of what student was looking at
3662:
3663: =cut
3664:
1.10 albertel 3665: sub get_student_view {
1.186 albertel 3666: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3667: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3668: my (%form);
1.10 albertel 3669: my @elements=('symb','courseid','domain','username');
3670: foreach my $element (@elements) {
1.186 albertel 3671: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3672: }
1.186 albertel 3673: if (defined($moreenv)) {
3674: %form=(%form,%{$moreenv});
3675: }
1.236 albertel 3676: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3677: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3678: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3679: $userview=~s/\<body[^\>]*\>//gi;
3680: $userview=~s/\<\/body\>//gi;
3681: $userview=~s/\<html\>//gi;
3682: $userview=~s/\<\/html\>//gi;
3683: $userview=~s/\<head\>//gi;
3684: $userview=~s/\<\/head\>//gi;
3685: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3686: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3687: if (wantarray) {
3688: return ($userview,$response);
3689: } else {
3690: return $userview;
3691: }
3692: }
3693:
3694: sub get_student_view_with_retries {
3695: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3696:
3697: my $ok = 0; # True if we got a good response.
3698: my $content;
3699: my $response;
3700:
3701: # Try to get the student_view done. within the retries count:
3702:
3703: do {
3704: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3705: $ok = $response->is_success;
3706: if (!$ok) {
3707: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3708: }
3709: $retries--;
3710: } while (!$ok && ($retries > 0));
3711:
3712: if (!$ok) {
3713: $content = ''; # On error return an empty content.
3714: }
1.651 www 3715: if (wantarray) {
3716: return ($content, $response);
3717: } else {
3718: return $content;
3719: }
1.11 albertel 3720: }
3721:
1.112 bowersj2 3722: =pod
3723:
1.648 raeburn 3724: =item * &get_student_answers()
1.112 bowersj2 3725:
3726: show a snapshot of how student was answering problem
3727:
3728: =cut
3729:
1.11 albertel 3730: sub get_student_answers {
1.100 sakharuk 3731: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3732: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3733: my (%moreenv);
1.11 albertel 3734: my @elements=('symb','courseid','domain','username');
3735: foreach my $element (@elements) {
1.186 albertel 3736: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3737: }
1.186 albertel 3738: $moreenv{'grade_target'}='answer';
3739: %moreenv=(%form,%moreenv);
1.497 raeburn 3740: $feedurl = &Apache::lonnet::clutter($feedurl);
3741: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3742: return $userview;
1.1 albertel 3743: }
1.116 albertel 3744:
3745: =pod
3746:
3747: =item * &submlink()
3748:
1.242 albertel 3749: Inputs: $text $uname $udom $symb $target
1.116 albertel 3750:
3751: Returns: A link to grades.pm such as to see the SUBM view of a student
3752:
3753: =cut
3754:
3755: ###############################################
3756: sub submlink {
1.242 albertel 3757: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3758: if (!($uname && $udom)) {
3759: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3760: &Apache::lonnet::whichuser($symb);
1.116 albertel 3761: if (!$symb) { $symb=$cursymb; }
3762: }
1.254 matthew 3763: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3764: $symb=&escape($symb);
1.960 bisitz 3765: if ($target) { $target=" target=\"$target\""; }
3766: return
3767: '<a href="/adm/grades?command=submission'.
3768: '&symb='.$symb.
3769: '&student='.$uname.
3770: '&userdom='.$udom.'"'.
3771: $target.'>'.$text.'</a>';
1.242 albertel 3772: }
3773: ##############################################
3774:
3775: =pod
3776:
3777: =item * &pgrdlink()
3778:
3779: Inputs: $text $uname $udom $symb $target
3780:
3781: Returns: A link to grades.pm such as to see the PGRD view of a student
3782:
3783: =cut
3784:
3785: ###############################################
3786: sub pgrdlink {
3787: my $link=&submlink(@_);
3788: $link=~s/(&command=submission)/$1&showgrading=yes/;
3789: return $link;
3790: }
3791: ##############################################
3792:
3793: =pod
3794:
3795: =item * &pprmlink()
3796:
3797: Inputs: $text $uname $udom $symb $target
3798:
3799: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3800: student and a specific resource
1.242 albertel 3801:
3802: =cut
3803:
3804: ###############################################
3805: sub pprmlink {
3806: my ($text,$uname,$udom,$symb,$target)=@_;
3807: if (!($uname && $udom)) {
3808: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3809: &Apache::lonnet::whichuser($symb);
1.242 albertel 3810: if (!$symb) { $symb=$cursymb; }
3811: }
1.254 matthew 3812: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3813: $symb=&escape($symb);
1.242 albertel 3814: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3815: return '<a href="/adm/parmset?command=set&'.
3816: 'symb='.$symb.'&uname='.$uname.
3817: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3818: }
3819: ##############################################
1.37 matthew 3820:
1.112 bowersj2 3821: =pod
3822:
3823: =back
3824:
3825: =cut
3826:
1.37 matthew 3827: ###############################################
1.51 www 3828:
3829:
3830: sub timehash {
1.687 raeburn 3831: my ($thistime) = @_;
3832: my $timezone = &Apache::lonlocal::gettimezone();
3833: my $dt = DateTime->from_epoch(epoch => $thistime)
3834: ->set_time_zone($timezone);
3835: my $wday = $dt->day_of_week();
3836: if ($wday == 7) { $wday = 0; }
3837: return ( 'second' => $dt->second(),
3838: 'minute' => $dt->minute(),
3839: 'hour' => $dt->hour(),
3840: 'day' => $dt->day_of_month(),
3841: 'month' => $dt->month(),
3842: 'year' => $dt->year(),
3843: 'weekday' => $wday,
3844: 'dayyear' => $dt->day_of_year(),
3845: 'dlsav' => $dt->is_dst() );
1.51 www 3846: }
3847:
1.370 www 3848: sub utc_string {
3849: my ($date)=@_;
1.371 www 3850: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3851: }
3852:
1.51 www 3853: sub maketime {
3854: my %th=@_;
1.687 raeburn 3855: my ($epoch_time,$timezone,$dt);
3856: $timezone = &Apache::lonlocal::gettimezone();
3857: eval {
3858: $dt = DateTime->new( year => $th{'year'},
3859: month => $th{'month'},
3860: day => $th{'day'},
3861: hour => $th{'hour'},
3862: minute => $th{'minute'},
3863: second => $th{'second'},
3864: time_zone => $timezone,
3865: );
3866: };
3867: if (!$@) {
3868: $epoch_time = $dt->epoch;
3869: if ($epoch_time) {
3870: return $epoch_time;
3871: }
3872: }
1.51 www 3873: return POSIX::mktime(
3874: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3875: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3876: }
3877:
3878: #########################################
1.51 www 3879:
3880: sub findallcourses {
1.482 raeburn 3881: my ($roles,$uname,$udom) = @_;
1.355 albertel 3882: my %roles;
3883: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3884: my %courses;
1.51 www 3885: my $now=time;
1.482 raeburn 3886: if (!defined($uname)) {
3887: $uname = $env{'user.name'};
3888: }
3889: if (!defined($udom)) {
3890: $udom = $env{'user.domain'};
3891: }
3892: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.982 raeburn 3893: my $extra = &Apache::lonnet::freeze_escape({'skipcheck' => 1});
3894: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname,'.',undef,
3895: $extra);
1.482 raeburn 3896: if (!%roles) {
3897: %roles = (
3898: cc => 1,
1.907 raeburn 3899: co => 1,
1.482 raeburn 3900: in => 1,
3901: ep => 1,
3902: ta => 1,
3903: cr => 1,
3904: st => 1,
3905: );
3906: }
3907: foreach my $entry (keys(%roleshash)) {
3908: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3909: if ($trole =~ /^cr/) {
3910: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3911: } else {
3912: next if (!exists($roles{$trole}));
3913: }
3914: if ($tend) {
3915: next if ($tend < $now);
3916: }
3917: if ($tstart) {
3918: next if ($tstart > $now);
3919: }
3920: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3921: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3922: if ($secpart eq '') {
3923: ($cnum,$role) = split(/_/,$cnumpart);
3924: $sec = 'none';
3925: $realsec = '';
3926: } else {
3927: $cnum = $cnumpart;
3928: ($sec,$role) = split(/_/,$secpart);
3929: $realsec = $sec;
1.490 raeburn 3930: }
1.482 raeburn 3931: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3932: }
3933: } else {
3934: foreach my $key (keys(%env)) {
1.483 albertel 3935: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3936: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3937: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3938: next if ($role eq 'ca' || $role eq 'aa');
3939: next if (%roles && !exists($roles{$role}));
3940: my ($starttime,$endtime)=split(/\./,$env{$key});
3941: my $active=1;
3942: if ($starttime) {
3943: if ($now<$starttime) { $active=0; }
3944: }
3945: if ($endtime) {
3946: if ($now>$endtime) { $active=0; }
3947: }
3948: if ($active) {
3949: if ($sec eq '') {
3950: $sec = 'none';
3951: }
3952: $courses{$cdom.'_'.$cnum}{$sec} =
3953: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 3954: }
3955: }
1.51 www 3956: }
3957: }
1.474 raeburn 3958: return %courses;
1.51 www 3959: }
1.37 matthew 3960:
1.54 www 3961: ###############################################
1.474 raeburn 3962:
3963: sub blockcheck {
1.482 raeburn 3964: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 3965:
3966: if (!defined($udom)) {
3967: $udom = $env{'user.domain'};
3968: }
3969: if (!defined($uname)) {
3970: $uname = $env{'user.name'};
3971: }
3972:
3973: # If uname and udom are for a course, check for blocks in the course.
3974:
3975: if (&Apache::lonnet::is_course($udom,$uname)) {
3976: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 3977: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 3978: return ($startblock,$endblock);
3979: }
1.474 raeburn 3980:
1.502 raeburn 3981: my $startblock = 0;
3982: my $endblock = 0;
1.482 raeburn 3983: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 3984:
1.490 raeburn 3985: # If uname is for a user, and activity is course-specific, i.e.,
3986: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3987:
1.490 raeburn 3988: if (($activity eq 'boards' || $activity eq 'chat' ||
3989: $activity eq 'groups') && ($env{'request.course.id'})) {
3990: foreach my $key (keys(%live_courses)) {
3991: if ($key ne $env{'request.course.id'}) {
3992: delete($live_courses{$key});
3993: }
3994: }
3995: }
3996:
3997: my $otheruser = 0;
3998: my %own_courses;
3999: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
4000: # Resource belongs to user other than current user.
4001: $otheruser = 1;
4002: # Gather courses for current user
4003: %own_courses =
4004: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
4005: }
4006:
4007: # Gather active course roles - course coordinator, instructor,
4008: # exam proctor, ta, student, or custom role.
1.474 raeburn 4009:
4010: foreach my $course (keys(%live_courses)) {
1.482 raeburn 4011: my ($cdom,$cnum);
4012: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
4013: $cdom = $env{'course.'.$course.'.domain'};
4014: $cnum = $env{'course.'.$course.'.num'};
4015: } else {
1.490 raeburn 4016: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 4017: }
4018: my $no_ownblock = 0;
4019: my $no_userblock = 0;
1.533 raeburn 4020: if ($otheruser && $activity ne 'com') {
1.490 raeburn 4021: # Check if current user has 'evb' priv for this
4022: if (defined($own_courses{$course})) {
4023: foreach my $sec (keys(%{$own_courses{$course}})) {
4024: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
4025: if ($sec ne 'none') {
4026: $checkrole .= '/'.$sec;
4027: }
4028: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4029: $no_ownblock = 1;
4030: last;
4031: }
4032: }
4033: }
4034: # if they have 'evb' priv and are currently not playing student
4035: next if (($no_ownblock) &&
4036: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
4037: }
1.474 raeburn 4038: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 4039: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 4040: if ($sec ne 'none') {
1.482 raeburn 4041: $checkrole .= '/'.$sec;
1.474 raeburn 4042: }
1.490 raeburn 4043: if ($otheruser) {
4044: # Resource belongs to user other than current user.
4045: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 4046: my ($trole,$tdom,$tnum,$tsec);
4047: my $entry = $live_courses{$course}{$sec};
4048: if ($entry =~ /^cr/) {
4049: ($trole,$tdom,$tnum,$tsec) =
4050: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
4051: } else {
4052: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
4053: }
4054: my ($spec,$area,$trest,%allroles,%userroles);
4055: $area = '/'.$tdom.'/'.$tnum;
4056: $trest = $tnum;
4057: if ($tsec ne '') {
4058: $area .= '/'.$tsec;
4059: $trest .= '/'.$tsec;
4060: }
4061: $spec = $trole.'.'.$area;
4062: if ($trole =~ /^cr/) {
4063: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
4064: $tdom,$spec,$trest,$area);
4065: } else {
4066: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
4067: $tdom,$spec,$trest,$area);
4068: }
4069: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 4070: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
4071: if ($1) {
4072: $no_userblock = 1;
4073: last;
4074: }
4075: }
1.490 raeburn 4076: } else {
4077: # Resource belongs to current user
4078: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 4079: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4080: $no_ownblock = 1;
4081: last;
4082: }
1.474 raeburn 4083: }
4084: }
4085: # if they have the evb priv and are currently not playing student
1.482 raeburn 4086: next if (($no_ownblock) &&
1.491 albertel 4087: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 4088: next if ($no_userblock);
1.474 raeburn 4089:
1.866 kalberla 4090: # Retrieve blocking times and identity of locker for course
1.490 raeburn 4091: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 4092:
4093: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
4094: if (($start != 0) &&
4095: (($startblock == 0) || ($startblock > $start))) {
4096: $startblock = $start;
4097: }
4098: if (($end != 0) &&
4099: (($endblock == 0) || ($endblock < $end))) {
4100: $endblock = $end;
4101: }
1.490 raeburn 4102: }
4103: return ($startblock,$endblock);
4104: }
4105:
4106: sub get_blocks {
4107: my ($setters,$activity,$cdom,$cnum) = @_;
4108: my $startblock = 0;
4109: my $endblock = 0;
4110: my $course = $cdom.'_'.$cnum;
4111: $setters->{$course} = {};
4112: $setters->{$course}{'staff'} = [];
4113: $setters->{$course}{'times'} = [];
4114: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
4115: foreach my $record (keys(%records)) {
4116: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
4117: if ($start <= time && $end >= time) {
4118: my ($staff_name,$staff_dom,$title,$blocks) =
4119: &parse_block_record($records{$record});
4120: if ($blocks->{$activity} eq 'on') {
4121: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
4122: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 4123: if ( ($startblock == 0) || ($startblock > $start) ) {
4124: $startblock = $start;
1.490 raeburn 4125: }
1.491 albertel 4126: if ( ($endblock == 0) || ($endblock < $end) ) {
4127: $endblock = $end;
1.474 raeburn 4128: }
4129: }
4130: }
4131: }
4132: return ($startblock,$endblock);
4133: }
4134:
4135: sub parse_block_record {
4136: my ($record) = @_;
4137: my ($setuname,$setudom,$title,$blocks);
4138: if (ref($record) eq 'HASH') {
4139: ($setuname,$setudom) = split(/:/,$record->{'setter'});
4140: $title = &unescape($record->{'event'});
4141: $blocks = $record->{'blocks'};
4142: } else {
4143: my @data = split(/:/,$record,3);
4144: if (scalar(@data) eq 2) {
4145: $title = $data[1];
4146: ($setuname,$setudom) = split(/@/,$data[0]);
4147: } else {
4148: ($setuname,$setudom,$title) = @data;
4149: }
4150: $blocks = { 'com' => 'on' };
4151: }
4152: return ($setuname,$setudom,$title,$blocks);
4153: }
4154:
1.854 kalberla 4155: sub blocking_status {
4156: my ($activity,$uname,$udom) = @_;
1.867 kalberla 4157: my %setters;
1.890 droeschl 4158:
4159: # check for active blocking
1.867 kalberla 4160: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
1.854 kalberla 4161:
1.890 droeschl 4162: my $blocked = $startblock && $endblock ? 1 : 0;
4163:
4164: # caller just wants to know whether a block is active
4165: if (!wantarray) { return $blocked; }
4166:
4167: # build a link to a popup window containing the details
4168: my $querystring = "?activity=$activity";
4169: # $uname and $udom decide whose portfolio the user is trying to look at
4170: $querystring .= "&udom=$udom" if $udom;
4171: $querystring .= "&uname=$uname" if $uname;
4172:
4173: my $output .= <<'END_MYBLOCK';
1.854 kalberla 4174: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
4175: var options = "width=" + w + ",height=" + h + ",";
4176: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
4177: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
4178: var newWin = window.open(url, wdwName, options);
4179: newWin.focus();
4180: }
1.890 droeschl 4181: END_MYBLOCK
1.854 kalberla 4182:
1.890 droeschl 4183: $output = Apache::lonhtmlcommon::scripttag($output);
4184:
1.854 kalberla 4185: my $popupUrl = "/adm/blockingstatus/$querystring";
1.890 droeschl 4186: my $text = mt('Communication Blocked');
4187:
1.867 kalberla 4188: $output .= <<"END_BLOCK";
4189: <div class='LC_comblock'>
1.869 kalberla 4190: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4191: title='$text'>
4192: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 4193: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4194: title='$text'>$text</a>
1.867 kalberla 4195: </div>
4196:
4197: END_BLOCK
1.474 raeburn 4198:
1.854 kalberla 4199: return ($blocked, $output);
4200: }
1.490 raeburn 4201:
1.60 matthew 4202: ###############################################
4203:
1.682 raeburn 4204: sub check_ip_acc {
4205: my ($acc)=@_;
4206: &Apache::lonxml::debug("acc is $acc");
4207: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
4208: return 1;
4209: }
4210: my $allowed=0;
4211: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
4212:
4213: my $name;
4214: foreach my $pattern (split(',',$acc)) {
4215: $pattern =~ s/^\s*//;
4216: $pattern =~ s/\s*$//;
4217: if ($pattern =~ /\*$/) {
4218: #35.8.*
4219: $pattern=~s/\*//;
4220: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4221: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
4222: #35.8.3.[34-56]
4223: my $low=$2;
4224: my $high=$3;
4225: $pattern=$1;
4226: if ($ip =~ /^\Q$pattern\E/) {
4227: my $last=(split(/\./,$ip))[3];
4228: if ($last <=$high && $last >=$low) { $allowed=1; }
4229: }
4230: } elsif ($pattern =~ /^\*/) {
4231: #*.msu.edu
4232: $pattern=~s/\*//;
4233: if (!defined($name)) {
4234: use Socket;
4235: my $netaddr=inet_aton($ip);
4236: ($name)=gethostbyaddr($netaddr,AF_INET);
4237: }
4238: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4239: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
4240: #127.0.0.1
4241: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4242: } else {
4243: #some.name.com
4244: if (!defined($name)) {
4245: use Socket;
4246: my $netaddr=inet_aton($ip);
4247: ($name)=gethostbyaddr($netaddr,AF_INET);
4248: }
4249: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4250: }
4251: if ($allowed) { last; }
4252: }
4253: return $allowed;
4254: }
4255:
4256: ###############################################
4257:
1.60 matthew 4258: =pod
4259:
1.112 bowersj2 4260: =head1 Domain Template Functions
4261:
4262: =over 4
4263:
4264: =item * &determinedomain()
1.60 matthew 4265:
4266: Inputs: $domain (usually will be undef)
4267:
1.63 www 4268: Returns: Determines which domain should be used for designs
1.60 matthew 4269:
4270: =cut
1.54 www 4271:
1.60 matthew 4272: ###############################################
1.63 www 4273: sub determinedomain {
4274: my $domain=shift;
1.531 albertel 4275: if (! $domain) {
1.60 matthew 4276: # Determine domain if we have not been given one
1.893 raeburn 4277: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 4278: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
4279: if ($env{'request.role.domain'}) {
4280: $domain=$env{'request.role.domain'};
1.60 matthew 4281: }
4282: }
1.63 www 4283: return $domain;
4284: }
4285: ###############################################
1.517 raeburn 4286:
1.518 albertel 4287: sub devalidate_domconfig_cache {
4288: my ($udom)=@_;
4289: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
4290: }
4291:
4292: # ---------------------- Get domain configuration for a domain
4293: sub get_domainconf {
4294: my ($udom) = @_;
4295: my $cachetime=1800;
4296: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
4297: if (defined($cached)) { return %{$result}; }
4298:
4299: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 4300: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 4301: my (%designhash,%legacy);
1.518 albertel 4302: if (keys(%domconfig) > 0) {
4303: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 4304: if (keys(%{$domconfig{'login'}})) {
4305: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 4306: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.946 raeburn 4307: if ($key eq 'loginvia') {
4308: if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') {
1.1013 raeburn 4309: foreach my $hostname (keys(%{$domconfig{'login'}{'loginvia'}})) {
1.948 raeburn 4310: if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') {
4311: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
4312: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
4313: $designhash{$udom.'.login.loginvia'} = $server;
4314: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
4315:
4316: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
4317: } else {
1.1013 raeburn 4318: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
1.948 raeburn 4319: }
4320: if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) {
4321: $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'};
4322: }
1.946 raeburn 4323: }
4324: }
4325: }
4326: }
4327: } else {
4328: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
4329: $designhash{$udom.'.login.'.$key.'_'.$img} =
4330: $domconfig{'login'}{$key}{$img};
4331: }
1.699 raeburn 4332: }
4333: } else {
4334: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
4335: }
1.632 raeburn 4336: }
4337: } else {
4338: $legacy{'login'} = 1;
1.518 albertel 4339: }
1.632 raeburn 4340: } else {
4341: $legacy{'login'} = 1;
1.518 albertel 4342: }
4343: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 4344: if (keys(%{$domconfig{'rolecolors'}})) {
4345: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
4346: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
4347: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
4348: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
4349: }
1.518 albertel 4350: }
4351: }
1.632 raeburn 4352: } else {
4353: $legacy{'rolecolors'} = 1;
1.518 albertel 4354: }
1.632 raeburn 4355: } else {
4356: $legacy{'rolecolors'} = 1;
1.518 albertel 4357: }
1.948 raeburn 4358: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
4359: if ($domconfig{'autoenroll'}{'co-owners'}) {
4360: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
4361: }
4362: }
1.632 raeburn 4363: if (keys(%legacy) > 0) {
4364: my %legacyhash = &get_legacy_domconf($udom);
4365: foreach my $item (keys(%legacyhash)) {
4366: if ($item =~ /^\Q$udom\E\.login/) {
4367: if ($legacy{'login'}) {
4368: $designhash{$item} = $legacyhash{$item};
4369: }
4370: } else {
4371: if ($legacy{'rolecolors'}) {
4372: $designhash{$item} = $legacyhash{$item};
4373: }
1.518 albertel 4374: }
4375: }
4376: }
1.632 raeburn 4377: } else {
4378: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4379: }
4380: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4381: $cachetime);
4382: return %designhash;
4383: }
4384:
1.632 raeburn 4385: sub get_legacy_domconf {
4386: my ($udom) = @_;
4387: my %legacyhash;
4388: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4389: my $designfile = $designdir.'/'.$udom.'.tab';
4390: if (-e $designfile) {
4391: if ( open (my $fh,"<$designfile") ) {
4392: while (my $line = <$fh>) {
4393: next if ($line =~ /^\#/);
4394: chomp($line);
4395: my ($key,$val)=(split(/\=/,$line));
4396: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4397: }
4398: close($fh);
4399: }
4400: }
4401: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
4402: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4403: }
4404: return %legacyhash;
4405: }
4406:
1.63 www 4407: =pod
4408:
1.112 bowersj2 4409: =item * &domainlogo()
1.63 www 4410:
4411: Inputs: $domain (usually will be undef)
4412:
4413: Returns: A link to a domain logo, if the domain logo exists.
4414: If the domain logo does not exist, a description of the domain.
4415:
4416: =cut
1.112 bowersj2 4417:
1.63 www 4418: ###############################################
4419: sub domainlogo {
1.517 raeburn 4420: my $domain = &determinedomain(shift);
1.518 albertel 4421: my %designhash = &get_domainconf($domain);
1.517 raeburn 4422: # See if there is a logo
4423: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4424: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4425: if ($imgsrc =~ m{^/(adm|res)/}) {
4426: if ($imgsrc =~ m{^/res/}) {
4427: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4428: &Apache::lonnet::repcopy($local_name);
4429: }
4430: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4431: }
4432: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4433: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4434: return &Apache::lonnet::domain($domain,'description');
1.59 www 4435: } else {
1.60 matthew 4436: return '';
1.59 www 4437: }
4438: }
1.63 www 4439: ##############################################
4440:
4441: =pod
4442:
1.112 bowersj2 4443: =item * &designparm()
1.63 www 4444:
4445: Inputs: $which parameter; $domain (usually will be undef)
4446:
4447: Returns: value of designparamter $which
4448:
4449: =cut
1.112 bowersj2 4450:
1.397 albertel 4451:
1.400 albertel 4452: ##############################################
1.397 albertel 4453: sub designparm {
4454: my ($which,$domain)=@_;
4455: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 4456: return $env{'environment.color.'.$which};
1.96 www 4457: }
1.63 www 4458: $domain=&determinedomain($domain);
1.518 albertel 4459: my %domdesign = &get_domainconf($domain);
1.520 raeburn 4460: my $output;
1.517 raeburn 4461: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 4462: $output = $domdesign{$domain.'.'.$which};
1.63 www 4463: } else {
1.520 raeburn 4464: $output = $defaultdesign{$which};
4465: }
4466: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4467: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4468: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 4469: if ($output =~ m{^/res/}) {
4470: my $local_name = &Apache::lonnet::filelocation('',$output);
4471: &Apache::lonnet::repcopy($local_name);
4472: }
1.520 raeburn 4473: $output = &lonhttpdurl($output);
4474: }
1.63 www 4475: }
1.520 raeburn 4476: return $output;
1.63 www 4477: }
1.59 www 4478:
1.822 bisitz 4479: ##############################################
4480: =pod
4481:
1.832 bisitz 4482: =item * &authorspace()
4483:
4484: Inputs: ./.
4485:
4486: Returns: Path to the Construction Space of the current user's
4487: accessed author space
4488: The author space will be that of the current user
4489: when accessing the own author space
4490: and that of the co-author/assistent co-author
4491: when accessing the co-author's/assistent co-author's
4492: space
4493:
4494: =cut
4495:
4496: sub authorspace {
4497: my $caname = '';
4498: if ($env{'request.role'} =~ /^ca|^aa/) {
4499: (undef,$caname) =
4500: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
4501: } else {
4502: $caname = $env{'user.name'};
4503: }
4504: return '/priv/'.$caname.'/';
4505: }
4506:
4507: ##############################################
4508: =pod
4509:
1.822 bisitz 4510: =item * &head_subbox()
4511:
4512: Inputs: $content (contains HTML code with page functions, etc.)
4513:
4514: Returns: HTML div with $content
4515: To be included in page header
4516:
4517: =cut
4518:
4519: sub head_subbox {
4520: my ($content)=@_;
4521: my $output =
1.993 raeburn 4522: '<div class="LC_head_subbox">'
1.822 bisitz 4523: .$content
4524: .'</div>'
4525: }
4526:
4527: ##############################################
4528: =pod
4529:
4530: =item * &CSTR_pageheader()
4531:
4532: Inputs: ./.
4533:
4534: Returns: HTML div with CSTR path and recent box
4535: To be included on Construction Space pages
4536:
4537: =cut
4538:
4539: sub CSTR_pageheader {
4540: # this is for resources; directories have customtitle, and crumbs
4541: # and select recent are created in lonpubdir.pm
4542: my ($uname,$thisdisfn)=
4543: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
4544: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4545: $formaction=~s/\/+/\//g;
4546:
4547: my $parentpath = '';
4548: my $lastitem = '';
4549: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4550: $parentpath = $1;
4551: $lastitem = $2;
4552: } else {
4553: $lastitem = $thisdisfn;
4554: }
1.921 bisitz 4555:
4556: my $output =
1.822 bisitz 4557: '<div>'
4558: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
4559: .'<b>'.&mt('Construction Space:').'</b> '
4560: .'<form name="dirs" method="post" action="'.$formaction
1.921 bisitz 4561: .'" target="_top">' #FIXME lonpubdir: target="_parent"
4562: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv',undef,undef);
4563:
4564: if ($lastitem) {
4565: $output .=
4566: '<span class="LC_filename">'
4567: .$lastitem
4568: .'</span>';
4569: }
4570: $output .=
4571: '<br />'
1.822 bisitz 4572: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
4573: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4574: .'</form>'
4575: .&Apache::lonmenu::constspaceform()
4576: .'</div>';
1.921 bisitz 4577:
4578: return $output;
1.822 bisitz 4579: }
4580:
1.60 matthew 4581: ###############################################
4582: ###############################################
4583:
4584: =pod
4585:
1.112 bowersj2 4586: =back
4587:
1.549 albertel 4588: =head1 HTML Helpers
1.112 bowersj2 4589:
4590: =over 4
4591:
4592: =item * &bodytag()
1.60 matthew 4593:
4594: Returns a uniform header for LON-CAPA web pages.
4595:
4596: Inputs:
4597:
1.112 bowersj2 4598: =over 4
4599:
4600: =item * $title, A title to be displayed on the page.
4601:
4602: =item * $function, the current role (can be undef).
4603:
4604: =item * $addentries, extra parameters for the <body> tag.
4605:
4606: =item * $bodyonly, if defined, only return the <body> tag.
4607:
4608: =item * $domain, if defined, force a given domain.
4609:
4610: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4611: text interface only)
1.60 matthew 4612:
1.814 bisitz 4613: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
4614: navigational links
1.317 albertel 4615:
1.338 albertel 4616: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4617:
1.460 albertel 4618: =item * $args, optional argument valid values are
4619: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4620: inherit_jsmath -> when creating popup window in a page,
4621: should it have jsmath forced on by the
4622: current page
1.460 albertel 4623:
1.112 bowersj2 4624: =back
4625:
1.60 matthew 4626: Returns: A uniform header for LON-CAPA web pages.
4627: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4628: If $bodyonly is undef or zero, an html string containing a <body> tag and
4629: other decorations will be returned.
4630:
4631: =cut
4632:
1.54 www 4633: sub bodytag {
1.831 bisitz 4634: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.962 droeschl 4635: $no_nav_bar,$bgcolor,$args)=@_;
1.339 albertel 4636:
1.954 raeburn 4637: my $public;
4638: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
4639: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
4640: $public = 1;
4641: }
1.460 albertel 4642: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4643:
1.183 matthew 4644: $function = &get_users_function() if (!$function);
1.339 albertel 4645: my $img = &designparm($function.'.img',$domain);
4646: my $font = &designparm($function.'.font',$domain);
4647: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4648:
1.803 bisitz 4649: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 4650: 'bgcolor' => $pgbg,
1.339 albertel 4651: 'text' => $font,
4652: 'alink' => &designparm($function.'.alink',$domain),
4653: 'vlink' => &designparm($function.'.vlink',$domain),
4654: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4655: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4656:
1.63 www 4657: # role and realm
1.378 raeburn 4658: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4659: if ($role eq 'ca') {
1.479 albertel 4660: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4661: $realm = &plainname($rname,$rdom);
1.378 raeburn 4662: }
1.55 www 4663: # realm
1.258 albertel 4664: if ($env{'request.course.id'}) {
1.378 raeburn 4665: if ($env{'request.role'} !~ /^cr/) {
4666: $role = &Apache::lonnet::plaintext($role,&course_type());
4667: }
1.898 raeburn 4668: if ($env{'request.course.sec'}) {
4669: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
4670: }
1.359 albertel 4671: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4672: } else {
4673: $role = &Apache::lonnet::plaintext($role);
1.54 www 4674: }
1.433 albertel 4675:
1.359 albertel 4676: if (!$realm) { $realm=' '; }
1.330 albertel 4677:
1.438 albertel 4678: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4679:
1.101 www 4680: # construct main body tag
1.359 albertel 4681: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4682: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4683:
1.530 albertel 4684: if ($bodyonly) {
1.60 matthew 4685: return $bodytag;
1.798 tempelho 4686: }
1.359 albertel 4687:
1.410 albertel 4688: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.954 raeburn 4689: if ($public) {
1.433 albertel 4690: undef($role);
1.434 albertel 4691: } else {
4692: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4693: }
1.359 albertel 4694:
1.762 bisitz 4695: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 4696: #
4697: # Extra info if you are the DC
4698: my $dc_info = '';
4699: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4700: $env{'course.'.$env{'request.course.id'}.
4701: '.domain'}.'/'})) {
4702: my $cid = $env{'request.course.id'};
1.917 raeburn 4703: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4704: $dc_info =~ s/\s+$//;
1.359 albertel 4705: }
4706:
1.898 raeburn 4707: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853 droeschl 4708: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
4709:
1.916 droeschl 4710: if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') {
4711: return $bodytag;
4712: }
1.903 droeschl 4713:
4714: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
4715:
4716: # if ($env{'request.state'} eq 'construct') {
4717: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
4718: # }
4719:
1.359 albertel 4720:
4721:
1.916 droeschl 4722: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917 raeburn 4723: if ($dc_info) {
4724: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
4725: }
1.916 droeschl 4726: $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
4727: <em>$realm</em> $dc_info</div>|;
1.903 droeschl 4728: return $bodytag;
4729: }
1.894 droeschl 4730:
1.927 raeburn 4731: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
4732: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
4733: }
1.916 droeschl 4734:
1.903 droeschl 4735: $bodytag .= Apache::lonhtmlcommon::scripttag(
4736: Apache::lonmenu::utilityfunctions(), 'start');
1.816 bisitz 4737:
1.903 droeschl 4738: $bodytag .= Apache::lonmenu::primary_menu();
1.852 droeschl 4739:
1.917 raeburn 4740: if ($dc_info) {
4741: $dc_info = &dc_courseid_toggle($dc_info);
4742: }
4743: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 4744:
1.903 droeschl 4745: #don't show menus for public users
1.954 raeburn 4746: if (!$public){
1.903 droeschl 4747: $bodytag .= Apache::lonmenu::secondary_menu();
4748: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 4749: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
4750: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 4751: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.920 raeburn 4752: $args->{'bread_crumbs'});
4753: } elsif ($forcereg) {
4754: $bodytag .= &Apache::lonmenu::innerregister($forcereg);
4755: }
1.903 droeschl 4756: }else{
4757: # this is to seperate menu from content when there's no secondary
4758: # menu. Especially needed for public accessible ressources.
4759: $bodytag .= '<hr style="clear:both" />';
4760: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 4761: }
1.903 droeschl 4762:
1.235 raeburn 4763: return $bodytag;
1.182 matthew 4764: }
4765:
1.917 raeburn 4766: sub dc_courseid_toggle {
4767: my ($dc_info) = @_;
1.980 raeburn 4768: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.917 raeburn 4769: '<a href="javascript:showCourseID();">'.
4770: &mt('(More ...)').'</a></span>'.
4771: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
4772: }
4773:
1.330 albertel 4774: sub make_attr_string {
4775: my ($register,$attr_ref) = @_;
4776:
4777: if ($attr_ref && !ref($attr_ref)) {
4778: die("addentries Must be a hash ref ".
4779: join(':',caller(1))." ".
4780: join(':',caller(0))." ");
4781: }
4782:
4783: if ($register) {
1.339 albertel 4784: my ($on_load,$on_unload);
4785: foreach my $key (keys(%{$attr_ref})) {
4786: if (lc($key) eq 'onload') {
4787: $on_load.=$attr_ref->{$key}.';';
4788: delete($attr_ref->{$key});
4789:
4790: } elsif (lc($key) eq 'onunload') {
4791: $on_unload.=$attr_ref->{$key}.';';
4792: delete($attr_ref->{$key});
4793: }
4794: }
1.953 droeschl 4795: $attr_ref->{'onload'} = $on_load;
4796: $attr_ref->{'onunload'}= $on_unload;
1.330 albertel 4797: }
1.339 albertel 4798:
1.330 albertel 4799: my $attr_string;
4800: foreach my $attr (keys(%$attr_ref)) {
4801: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4802: }
4803: return $attr_string;
4804: }
4805:
4806:
1.182 matthew 4807: ###############################################
1.251 albertel 4808: ###############################################
4809:
4810: =pod
4811:
4812: =item * &endbodytag()
4813:
4814: Returns a uniform footer for LON-CAPA web pages.
4815:
1.635 raeburn 4816: Inputs: 1 - optional reference to an args hash
4817: If in the hash, key for noredirectlink has a value which evaluates to true,
4818: a 'Continue' link is not displayed if the page contains an
4819: internal redirect in the <head></head> section,
4820: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4821:
4822: =cut
4823:
4824: sub endbodytag {
1.635 raeburn 4825: my ($args) = @_;
1.251 albertel 4826: my $endbodytag='</body>';
1.269 albertel 4827: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4828: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4829: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4830: $endbodytag=
4831: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4832: &mt('Continue').'</a>'.
4833: $endbodytag;
4834: }
1.315 albertel 4835: }
1.251 albertel 4836: return $endbodytag;
4837: }
4838:
1.352 albertel 4839: =pod
4840:
4841: =item * &standard_css()
4842:
4843: Returns a style sheet
4844:
4845: Inputs: (all optional)
4846: domain -> force to color decorate a page for a specific
4847: domain
4848: function -> force usage of a specific rolish color scheme
4849: bgcolor -> override the default page bgcolor
4850:
4851: =cut
4852:
1.343 albertel 4853: sub standard_css {
1.345 albertel 4854: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4855: $function = &get_users_function() if (!$function);
4856: my $img = &designparm($function.'.img', $domain);
4857: my $tabbg = &designparm($function.'.tabbg', $domain);
4858: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 4859: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 4860: #second colour for later usage
1.345 albertel 4861: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4862: my $pgbg_or_bgcolor =
4863: $bgcolor ||
1.352 albertel 4864: &designparm($function.'.pgbg', $domain);
1.382 albertel 4865: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4866: my $alink = &designparm($function.'.alink', $domain);
4867: my $vlink = &designparm($function.'.vlink', $domain);
4868: my $link = &designparm($function.'.link', $domain);
4869:
1.602 albertel 4870: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4871: my $mono = 'monospace';
1.850 bisitz 4872: my $data_table_head = $sidebg;
4873: my $data_table_light = '#FAFAFA';
4874: my $data_table_dark = '#F0F0F0';
1.470 banghart 4875: my $data_table_darker = '#CCCCCC';
1.349 albertel 4876: my $data_table_highlight = '#FFFF00';
1.352 albertel 4877: my $mail_new = '#FFBB77';
4878: my $mail_new_hover = '#DD9955';
4879: my $mail_read = '#BBBB77';
4880: my $mail_read_hover = '#999944';
4881: my $mail_replied = '#AAAA88';
4882: my $mail_replied_hover = '#888855';
4883: my $mail_other = '#99BBBB';
4884: my $mail_other_hover = '#669999';
1.391 albertel 4885: my $table_header = '#DDDDDD';
1.489 raeburn 4886: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 4887: my $lg_border_color = '#C8C8C8';
1.952 onken 4888: my $button_hover = '#BF2317';
1.392 albertel 4889:
1.608 albertel 4890: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 4891: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
4892: : '0 3px 0 4px';
1.448 albertel 4893:
1.523 albertel 4894:
1.343 albertel 4895: return <<END;
1.947 droeschl 4896:
4897: /* needed for iframe to allow 100% height in FF */
4898: body, html {
4899: margin: 0;
4900: padding: 0 0.5%;
4901: height: 99%; /* to avoid scrollbars */
4902: }
4903:
1.795 www 4904: body {
1.911 bisitz 4905: font-family: $sans;
4906: line-height:130%;
4907: font-size:0.83em;
4908: color:$font;
1.795 www 4909: }
4910:
1.959 onken 4911: a:focus,
4912: a:focus img {
1.795 www 4913: color: red;
1.911 bisitz 4914: background: yellow;
1.795 www 4915: }
1.698 harmsja 4916:
1.911 bisitz 4917: form, .inline {
4918: display: inline;
1.795 www 4919: }
1.721 harmsja 4920:
1.795 www 4921: .LC_right {
1.911 bisitz 4922: text-align:right;
1.795 www 4923: }
4924:
4925: .LC_middle {
1.911 bisitz 4926: vertical-align:middle;
1.795 www 4927: }
1.721 harmsja 4928:
1.911 bisitz 4929: .LC_400Box {
4930: width:400px;
4931: }
1.721 harmsja 4932:
1.947 droeschl 4933: .LC_iframecontainer {
4934: width: 98%;
4935: margin: 0;
4936: position: fixed;
4937: top: 8.5em;
4938: bottom: 0;
4939: }
4940:
4941: .LC_iframecontainer iframe{
4942: border: none;
4943: width: 100%;
4944: height: 100%;
4945: }
4946:
1.778 bisitz 4947: .LC_filename {
4948: font-family: $mono;
4949: white-space:pre;
1.921 bisitz 4950: font-size: 120%;
1.778 bisitz 4951: }
4952:
4953: .LC_fileicon {
4954: border: none;
4955: height: 1.3em;
4956: vertical-align: text-bottom;
4957: margin-right: 0.3em;
4958: text-decoration:none;
4959: }
4960:
1.1008 www 4961: .LC_setting {
4962: text-decoration:underline;
4963: }
4964:
1.350 albertel 4965: .LC_error {
4966: color: red;
4967: font-size: larger;
4968: }
1.795 www 4969:
1.457 albertel 4970: .LC_warning,
4971: .LC_diff_removed {
1.733 bisitz 4972: color: red;
1.394 albertel 4973: }
1.532 albertel 4974:
4975: .LC_info,
1.457 albertel 4976: .LC_success,
4977: .LC_diff_added {
1.350 albertel 4978: color: green;
4979: }
1.795 www 4980:
1.802 bisitz 4981: div.LC_confirm_box {
4982: background-color: #FAFAFA;
4983: border: 1px solid $lg_border_color;
4984: margin-right: 0;
4985: padding: 5px;
4986: }
4987:
4988: div.LC_confirm_box .LC_error img,
4989: div.LC_confirm_box .LC_success img {
4990: vertical-align: middle;
4991: }
4992:
1.440 albertel 4993: .LC_icon {
1.771 droeschl 4994: border: none;
1.790 droeschl 4995: vertical-align: middle;
1.771 droeschl 4996: }
4997:
1.543 albertel 4998: .LC_docs_spacer {
4999: width: 25px;
5000: height: 1px;
1.771 droeschl 5001: border: none;
1.543 albertel 5002: }
1.346 albertel 5003:
1.532 albertel 5004: .LC_internal_info {
1.735 bisitz 5005: color: #999999;
1.532 albertel 5006: }
5007:
1.794 www 5008: .LC_discussion {
1.911 bisitz 5009: background: $tabbg;
5010: border: 1px solid black;
5011: margin: 2px;
1.794 www 5012: }
5013:
5014: .LC_disc_action_links_bar {
1.911 bisitz 5015: background: $tabbg;
5016: border: none;
5017: margin: 4px;
1.794 www 5018: }
5019:
5020: .LC_disc_action_left {
1.911 bisitz 5021: text-align: left;
1.794 www 5022: }
5023:
5024: .LC_disc_action_right {
1.911 bisitz 5025: text-align: right;
1.794 www 5026: }
5027:
5028: .LC_disc_new_item {
1.911 bisitz 5029: background: white;
5030: border: 2px solid red;
5031: margin: 2px;
1.794 www 5032: }
5033:
5034: .LC_disc_old_item {
1.911 bisitz 5035: background: white;
5036: border: 1px solid black;
5037: margin: 2px;
1.794 www 5038: }
5039:
1.458 albertel 5040: table.LC_pastsubmission {
5041: border: 1px solid black;
5042: margin: 2px;
5043: }
5044:
1.924 bisitz 5045: table#LC_menubuttons {
1.345 albertel 5046: width: 100%;
5047: background: $pgbg;
1.392 albertel 5048: border: 2px;
1.402 albertel 5049: border-collapse: separate;
1.803 bisitz 5050: padding: 0;
1.345 albertel 5051: }
1.392 albertel 5052:
1.801 tempelho 5053: table#LC_title_bar a {
5054: color: $fontmenu;
5055: }
1.836 bisitz 5056:
1.807 droeschl 5057: table#LC_title_bar {
1.819 tempelho 5058: clear: both;
1.836 bisitz 5059: display: none;
1.807 droeschl 5060: }
5061:
1.795 www 5062: table#LC_title_bar,
1.933 droeschl 5063: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 5064: table#LC_title_bar.LC_with_remote {
1.359 albertel 5065: width: 100%;
1.392 albertel 5066: border-color: $pgbg;
5067: border-style: solid;
5068: border-width: $border;
1.379 albertel 5069: background: $pgbg;
1.801 tempelho 5070: color: $fontmenu;
1.392 albertel 5071: border-collapse: collapse;
1.803 bisitz 5072: padding: 0;
1.819 tempelho 5073: margin: 0;
1.359 albertel 5074: }
1.795 www 5075:
1.933 droeschl 5076: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 5077: margin: 0;
5078: padding: 0;
1.933 droeschl 5079: position: relative;
5080: list-style: none;
1.913 droeschl 5081: }
1.933 droeschl 5082: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 5083: display: inline;
5084: }
1.933 droeschl 5085:
5086: .LC_breadcrumb_tools_navigation {
1.913 droeschl 5087: padding: 0;
1.933 droeschl 5088: margin: 0;
5089: float: left;
1.913 droeschl 5090: }
1.933 droeschl 5091: .LC_breadcrumb_tools_tools {
5092: padding: 0;
5093: margin: 0;
1.913 droeschl 5094: float: right;
5095: }
5096:
1.359 albertel 5097: table#LC_title_bar td {
5098: background: $tabbg;
5099: }
1.795 www 5100:
1.911 bisitz 5101: table#LC_menubuttons img {
1.803 bisitz 5102: border: none;
1.346 albertel 5103: }
1.795 www 5104:
1.842 droeschl 5105: .LC_breadcrumbs_component {
1.911 bisitz 5106: float: right;
5107: margin: 0 1em;
1.357 albertel 5108: }
1.842 droeschl 5109: .LC_breadcrumbs_component img {
1.911 bisitz 5110: vertical-align: middle;
1.777 tempelho 5111: }
1.795 www 5112:
1.383 albertel 5113: td.LC_table_cell_checkbox {
5114: text-align: center;
5115: }
1.795 www 5116:
5117: .LC_fontsize_small {
1.911 bisitz 5118: font-size: 70%;
1.705 tempelho 5119: }
5120:
1.844 bisitz 5121: #LC_breadcrumbs {
1.911 bisitz 5122: clear:both;
5123: background: $sidebg;
5124: border-bottom: 1px solid $lg_border_color;
5125: line-height: 2.5em;
1.933 droeschl 5126: overflow: hidden;
1.911 bisitz 5127: margin: 0;
5128: padding: 0;
1.995 raeburn 5129: text-align: left;
1.819 tempelho 5130: }
1.862 bisitz 5131:
1.993 raeburn 5132: .LC_head_subbox {
1.911 bisitz 5133: clear:both;
5134: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 5135: border: 1px solid $sidebg;
5136: margin: 0 0 10px 0;
1.966 bisitz 5137: padding: 3px;
1.995 raeburn 5138: text-align: left;
1.822 bisitz 5139: }
5140:
1.795 www 5141: .LC_fontsize_medium {
1.911 bisitz 5142: font-size: 85%;
1.705 tempelho 5143: }
5144:
1.795 www 5145: .LC_fontsize_large {
1.911 bisitz 5146: font-size: 120%;
1.705 tempelho 5147: }
5148:
1.346 albertel 5149: .LC_menubuttons_inline_text {
5150: color: $font;
1.698 harmsja 5151: font-size: 90%;
1.701 harmsja 5152: padding-left:3px;
1.346 albertel 5153: }
5154:
1.934 droeschl 5155: .LC_menubuttons_inline_text img{
5156: vertical-align: middle;
5157: }
5158:
1.951 onken 5159: li.LC_menubuttons_inline_text img,a {
5160: cursor:pointer;
1.1002 droeschl 5161: text-decoration: none;
1.951 onken 5162: }
5163:
1.526 www 5164: .LC_menubuttons_link {
5165: text-decoration: none;
5166: }
1.795 www 5167:
1.522 albertel 5168: .LC_menubuttons_category {
1.521 www 5169: color: $font;
1.526 www 5170: background: $pgbg;
1.521 www 5171: font-size: larger;
5172: font-weight: bold;
5173: }
5174:
1.346 albertel 5175: td.LC_menubuttons_text {
1.911 bisitz 5176: color: $font;
1.346 albertel 5177: }
1.706 harmsja 5178:
1.346 albertel 5179: .LC_current_location {
5180: background: $tabbg;
5181: }
1.795 www 5182:
1.938 bisitz 5183: table.LC_data_table {
1.347 albertel 5184: border: 1px solid #000000;
1.402 albertel 5185: border-collapse: separate;
1.426 albertel 5186: border-spacing: 1px;
1.610 albertel 5187: background: $pgbg;
1.347 albertel 5188: }
1.795 www 5189:
1.422 albertel 5190: .LC_data_table_dense {
5191: font-size: small;
5192: }
1.795 www 5193:
1.507 raeburn 5194: table.LC_nested_outer {
5195: border: 1px solid #000000;
1.589 raeburn 5196: border-collapse: collapse;
1.803 bisitz 5197: border-spacing: 0;
1.507 raeburn 5198: width: 100%;
5199: }
1.795 www 5200:
1.879 raeburn 5201: table.LC_innerpickbox,
1.507 raeburn 5202: table.LC_nested {
1.803 bisitz 5203: border: none;
1.589 raeburn 5204: border-collapse: collapse;
1.803 bisitz 5205: border-spacing: 0;
1.507 raeburn 5206: width: 100%;
5207: }
1.795 www 5208:
1.911 bisitz 5209: table.LC_data_table tr th,
5210: table.LC_calendar tr th,
1.879 raeburn 5211: table.LC_prior_tries tr th,
5212: table.LC_innerpickbox tr th {
1.349 albertel 5213: font-weight: bold;
5214: background-color: $data_table_head;
1.801 tempelho 5215: color:$fontmenu;
1.701 harmsja 5216: font-size:90%;
1.347 albertel 5217: }
1.795 www 5218:
1.879 raeburn 5219: table.LC_innerpickbox tr th,
5220: table.LC_innerpickbox tr td {
5221: vertical-align: top;
5222: }
5223:
1.711 raeburn 5224: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 5225: background-color: #CCCCCC;
1.711 raeburn 5226: font-weight: bold;
5227: text-align: left;
5228: }
1.795 www 5229:
1.912 bisitz 5230: table.LC_data_table tr.LC_odd_row > td {
5231: background-color: $data_table_light;
5232: padding: 2px;
5233: vertical-align: top;
5234: }
5235:
1.809 bisitz 5236: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 5237: background-color: $data_table_light;
1.912 bisitz 5238: vertical-align: top;
5239: }
5240:
5241: table.LC_data_table tr.LC_even_row > td {
5242: background-color: $data_table_dark;
1.425 albertel 5243: padding: 2px;
1.900 bisitz 5244: vertical-align: top;
1.347 albertel 5245: }
1.795 www 5246:
1.809 bisitz 5247: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 5248: background-color: $data_table_dark;
1.900 bisitz 5249: vertical-align: top;
1.347 albertel 5250: }
1.795 www 5251:
1.425 albertel 5252: table.LC_data_table tr.LC_data_table_highlight td {
5253: background-color: $data_table_darker;
5254: }
1.795 www 5255:
1.639 raeburn 5256: table.LC_data_table tr td.LC_leftcol_header {
5257: background-color: $data_table_head;
5258: font-weight: bold;
5259: }
1.795 www 5260:
1.451 albertel 5261: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5262: table.LC_nested tr.LC_empty_row td {
1.421 albertel 5263: font-weight: bold;
5264: font-style: italic;
5265: text-align: center;
5266: padding: 8px;
1.347 albertel 5267: }
1.795 www 5268:
1.940 bisitz 5269: table.LC_data_table tr.LC_empty_row td {
5270: background-color: $sidebg;
5271: }
5272:
5273: table.LC_nested tr.LC_empty_row td {
5274: background-color: #FFFFFF;
5275: }
5276:
1.890 droeschl 5277: table.LC_caption {
5278: }
5279:
1.507 raeburn 5280: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5281: padding: 4ex
5282: }
1.795 www 5283:
1.507 raeburn 5284: table.LC_nested_outer tr th {
5285: font-weight: bold;
1.801 tempelho 5286: color:$fontmenu;
1.507 raeburn 5287: background-color: $data_table_head;
1.701 harmsja 5288: font-size: small;
1.507 raeburn 5289: border-bottom: 1px solid #000000;
5290: }
1.795 www 5291:
1.507 raeburn 5292: table.LC_nested_outer tr td.LC_subheader {
5293: background-color: $data_table_head;
5294: font-weight: bold;
5295: font-size: small;
5296: border-bottom: 1px solid #000000;
5297: text-align: right;
1.451 albertel 5298: }
1.795 www 5299:
1.507 raeburn 5300: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5301: background-color: #CCCCCC;
1.451 albertel 5302: font-weight: bold;
5303: font-size: small;
1.507 raeburn 5304: text-align: center;
5305: }
1.795 www 5306:
1.589 raeburn 5307: table.LC_nested tr.LC_info_row td.LC_left_item,
5308: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5309: text-align: left;
1.451 albertel 5310: }
1.795 www 5311:
1.507 raeburn 5312: table.LC_nested td {
1.735 bisitz 5313: background-color: #FFFFFF;
1.451 albertel 5314: font-size: small;
1.507 raeburn 5315: }
1.795 www 5316:
1.507 raeburn 5317: table.LC_nested_outer tr th.LC_right_item,
5318: table.LC_nested tr.LC_info_row td.LC_right_item,
5319: table.LC_nested tr.LC_odd_row td.LC_right_item,
5320: table.LC_nested tr td.LC_right_item {
1.451 albertel 5321: text-align: right;
5322: }
5323:
1.507 raeburn 5324: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5325: background-color: #EEEEEE;
1.451 albertel 5326: }
5327:
1.473 raeburn 5328: table.LC_createuser {
5329: }
5330:
5331: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5332: font-size: small;
1.473 raeburn 5333: }
5334:
5335: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5336: background-color: #CCCCCC;
1.473 raeburn 5337: font-weight: bold;
5338: text-align: center;
5339: }
5340:
1.349 albertel 5341: table.LC_calendar {
5342: border: 1px solid #000000;
5343: border-collapse: collapse;
1.917 raeburn 5344: width: 98%;
1.349 albertel 5345: }
1.795 www 5346:
1.349 albertel 5347: table.LC_calendar_pickdate {
5348: font-size: xx-small;
5349: }
1.795 www 5350:
1.349 albertel 5351: table.LC_calendar tr td {
5352: border: 1px solid #000000;
5353: vertical-align: top;
1.917 raeburn 5354: width: 14%;
1.349 albertel 5355: }
1.795 www 5356:
1.349 albertel 5357: table.LC_calendar tr td.LC_calendar_day_empty {
5358: background-color: $data_table_dark;
5359: }
1.795 www 5360:
1.779 bisitz 5361: table.LC_calendar tr td.LC_calendar_day_current {
5362: background-color: $data_table_highlight;
1.777 tempelho 5363: }
1.795 www 5364:
1.938 bisitz 5365: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 5366: background-color: $mail_new;
5367: }
1.795 www 5368:
1.938 bisitz 5369: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 5370: background-color: $mail_new_hover;
5371: }
1.795 www 5372:
1.938 bisitz 5373: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 5374: background-color: $mail_read;
5375: }
1.795 www 5376:
1.938 bisitz 5377: /*
5378: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 5379: background-color: $mail_read_hover;
5380: }
1.938 bisitz 5381: */
1.795 www 5382:
1.938 bisitz 5383: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 5384: background-color: $mail_replied;
5385: }
1.795 www 5386:
1.938 bisitz 5387: /*
5388: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 5389: background-color: $mail_replied_hover;
5390: }
1.938 bisitz 5391: */
1.795 www 5392:
1.938 bisitz 5393: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 5394: background-color: $mail_other;
5395: }
1.795 www 5396:
1.938 bisitz 5397: /*
5398: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 5399: background-color: $mail_other_hover;
5400: }
1.938 bisitz 5401: */
1.494 raeburn 5402:
1.777 tempelho 5403: table.LC_data_table tr > td.LC_browser_file,
5404: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 5405: background: #AAEE77;
1.389 albertel 5406: }
1.795 www 5407:
1.777 tempelho 5408: table.LC_data_table tr > td.LC_browser_file_locked,
5409: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5410: background: #FFAA99;
1.387 albertel 5411: }
1.795 www 5412:
1.777 tempelho 5413: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 5414: background: #888888;
1.779 bisitz 5415: }
1.795 www 5416:
1.777 tempelho 5417: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5418: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 5419: background: #F8F866;
1.777 tempelho 5420: }
1.795 www 5421:
1.696 bisitz 5422: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 5423: background: #E0E8FF;
1.387 albertel 5424: }
1.696 bisitz 5425:
1.707 bisitz 5426: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 5427: /* background: #77FF77; */
1.707 bisitz 5428: }
1.795 www 5429:
1.707 bisitz 5430: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 5431: border-right: 8px solid #FFFF77;
1.707 bisitz 5432: }
1.795 www 5433:
1.707 bisitz 5434: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 5435: border-right: 8px solid #FFAA77;
1.707 bisitz 5436: }
1.795 www 5437:
1.707 bisitz 5438: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 5439: border-right: 8px solid #FF7777;
1.707 bisitz 5440: }
1.795 www 5441:
1.707 bisitz 5442: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 5443: border-right: 8px solid #AAFF77;
1.707 bisitz 5444: }
1.795 www 5445:
1.707 bisitz 5446: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 5447: border-right: 8px solid #11CC55;
1.707 bisitz 5448: }
5449:
1.388 albertel 5450: span.LC_current_location {
1.701 harmsja 5451: font-size:larger;
1.388 albertel 5452: background: $pgbg;
5453: }
1.387 albertel 5454:
1.395 albertel 5455: span.LC_parm_menu_item {
5456: font-size: larger;
5457: }
1.795 www 5458:
1.395 albertel 5459: span.LC_parm_scope_all {
5460: color: red;
5461: }
1.795 www 5462:
1.395 albertel 5463: span.LC_parm_scope_folder {
5464: color: green;
5465: }
1.795 www 5466:
1.395 albertel 5467: span.LC_parm_scope_resource {
5468: color: orange;
5469: }
1.795 www 5470:
1.395 albertel 5471: span.LC_parm_part {
5472: color: blue;
5473: }
1.795 www 5474:
1.911 bisitz 5475: span.LC_parm_folder,
5476: span.LC_parm_symb {
1.395 albertel 5477: font-size: x-small;
5478: font-family: $mono;
5479: color: #AAAAAA;
5480: }
5481:
1.977 bisitz 5482: ul.LC_parm_parmlist li {
5483: display: inline-block;
5484: padding: 0.3em 0.8em;
5485: vertical-align: top;
5486: width: 150px;
5487: border-top:1px solid $lg_border_color;
5488: }
5489:
1.795 www 5490: td.LC_parm_overview_level_menu,
5491: td.LC_parm_overview_map_menu,
5492: td.LC_parm_overview_parm_selectors,
5493: td.LC_parm_overview_restrictions {
1.396 albertel 5494: border: 1px solid black;
5495: border-collapse: collapse;
5496: }
1.795 www 5497:
1.396 albertel 5498: table.LC_parm_overview_restrictions td {
5499: border-width: 1px 4px 1px 4px;
5500: border-style: solid;
5501: border-color: $pgbg;
5502: text-align: center;
5503: }
1.795 www 5504:
1.396 albertel 5505: table.LC_parm_overview_restrictions th {
5506: background: $tabbg;
5507: border-width: 1px 4px 1px 4px;
5508: border-style: solid;
5509: border-color: $pgbg;
5510: }
1.795 www 5511:
1.398 albertel 5512: table#LC_helpmenu {
1.803 bisitz 5513: border: none;
1.398 albertel 5514: height: 55px;
1.803 bisitz 5515: border-spacing: 0;
1.398 albertel 5516: }
5517:
5518: table#LC_helpmenu fieldset legend {
5519: font-size: larger;
5520: }
1.795 www 5521:
1.397 albertel 5522: table#LC_helpmenu_links {
5523: width: 100%;
5524: border: 1px solid black;
5525: background: $pgbg;
1.803 bisitz 5526: padding: 0;
1.397 albertel 5527: border-spacing: 1px;
5528: }
1.795 www 5529:
1.397 albertel 5530: table#LC_helpmenu_links tr td {
5531: padding: 1px;
5532: background: $tabbg;
1.399 albertel 5533: text-align: center;
5534: font-weight: bold;
1.397 albertel 5535: }
1.396 albertel 5536:
1.795 www 5537: table#LC_helpmenu_links a:link,
5538: table#LC_helpmenu_links a:visited,
1.397 albertel 5539: table#LC_helpmenu_links a:active {
5540: text-decoration: none;
5541: color: $font;
5542: }
1.795 www 5543:
1.397 albertel 5544: table#LC_helpmenu_links a:hover {
5545: text-decoration: underline;
5546: color: $vlink;
5547: }
1.396 albertel 5548:
1.417 albertel 5549: .LC_chrt_popup_exists {
5550: border: 1px solid #339933;
5551: margin: -1px;
5552: }
1.795 www 5553:
1.417 albertel 5554: .LC_chrt_popup_up {
5555: border: 1px solid yellow;
5556: margin: -1px;
5557: }
1.795 www 5558:
1.417 albertel 5559: .LC_chrt_popup {
5560: border: 1px solid #8888FF;
5561: background: #CCCCFF;
5562: }
1.795 www 5563:
1.421 albertel 5564: table.LC_pick_box {
5565: border-collapse: separate;
5566: background: white;
5567: border: 1px solid black;
5568: border-spacing: 1px;
5569: }
1.795 www 5570:
1.421 albertel 5571: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 5572: background: $sidebg;
1.421 albertel 5573: font-weight: bold;
1.900 bisitz 5574: text-align: left;
1.740 bisitz 5575: vertical-align: top;
1.421 albertel 5576: width: 184px;
5577: padding: 8px;
5578: }
1.795 www 5579:
1.579 raeburn 5580: table.LC_pick_box td.LC_pick_box_value {
5581: text-align: left;
5582: padding: 8px;
5583: }
1.795 www 5584:
1.579 raeburn 5585: table.LC_pick_box td.LC_pick_box_select {
5586: text-align: left;
5587: padding: 8px;
5588: }
1.795 www 5589:
1.424 albertel 5590: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 5591: padding: 0;
1.421 albertel 5592: height: 1px;
5593: background: black;
5594: }
1.795 www 5595:
1.421 albertel 5596: table.LC_pick_box td.LC_pick_box_submit {
5597: text-align: right;
5598: }
1.795 www 5599:
1.579 raeburn 5600: table.LC_pick_box td.LC_evenrow_value {
5601: text-align: left;
5602: padding: 8px;
5603: background-color: $data_table_light;
5604: }
1.795 www 5605:
1.579 raeburn 5606: table.LC_pick_box td.LC_oddrow_value {
5607: text-align: left;
5608: padding: 8px;
5609: background-color: $data_table_light;
5610: }
1.795 www 5611:
1.579 raeburn 5612: span.LC_helpform_receipt_cat {
5613: font-weight: bold;
5614: }
1.795 www 5615:
1.424 albertel 5616: table.LC_group_priv_box {
5617: background: white;
5618: border: 1px solid black;
5619: border-spacing: 1px;
5620: }
1.795 www 5621:
1.424 albertel 5622: table.LC_group_priv_box td.LC_pick_box_title {
5623: background: $tabbg;
5624: font-weight: bold;
5625: text-align: right;
5626: width: 184px;
5627: }
1.795 www 5628:
1.424 albertel 5629: table.LC_group_priv_box td.LC_groups_fixed {
5630: background: $data_table_light;
5631: text-align: center;
5632: }
1.795 www 5633:
1.424 albertel 5634: table.LC_group_priv_box td.LC_groups_optional {
5635: background: $data_table_dark;
5636: text-align: center;
5637: }
1.795 www 5638:
1.424 albertel 5639: table.LC_group_priv_box td.LC_groups_functionality {
5640: background: $data_table_darker;
5641: text-align: center;
5642: font-weight: bold;
5643: }
1.795 www 5644:
1.424 albertel 5645: table.LC_group_priv td {
5646: text-align: left;
1.803 bisitz 5647: padding: 0;
1.424 albertel 5648: }
5649:
5650: .LC_navbuttons {
5651: margin: 2ex 0ex 2ex 0ex;
5652: }
1.795 www 5653:
1.423 albertel 5654: .LC_topic_bar {
5655: font-weight: bold;
5656: background: $tabbg;
1.918 wenzelju 5657: margin: 1em 0em 1em 2em;
1.805 bisitz 5658: padding: 3px;
1.918 wenzelju 5659: font-size: 1.2em;
1.423 albertel 5660: }
1.795 www 5661:
1.423 albertel 5662: .LC_topic_bar span {
1.918 wenzelju 5663: left: 0.5em;
5664: position: absolute;
1.423 albertel 5665: vertical-align: middle;
1.918 wenzelju 5666: font-size: 1.2em;
1.423 albertel 5667: }
1.795 www 5668:
1.423 albertel 5669: table.LC_course_group_status {
5670: margin: 20px;
5671: }
1.795 www 5672:
1.423 albertel 5673: table.LC_status_selector td {
5674: vertical-align: top;
5675: text-align: center;
1.424 albertel 5676: padding: 4px;
5677: }
1.795 www 5678:
1.599 albertel 5679: div.LC_feedback_link {
1.616 albertel 5680: clear: both;
1.829 kalberla 5681: background: $sidebg;
1.779 bisitz 5682: width: 100%;
1.829 kalberla 5683: padding-bottom: 10px;
5684: border: 1px $tabbg solid;
1.833 kalberla 5685: height: 22px;
5686: line-height: 22px;
5687: padding-top: 5px;
5688: }
5689:
5690: div.LC_feedback_link img {
5691: height: 22px;
1.867 kalberla 5692: vertical-align:middle;
1.829 kalberla 5693: }
5694:
1.911 bisitz 5695: div.LC_feedback_link a {
1.829 kalberla 5696: text-decoration: none;
1.489 raeburn 5697: }
1.795 www 5698:
1.867 kalberla 5699: div.LC_comblock {
1.911 bisitz 5700: display:inline;
1.867 kalberla 5701: color:$font;
5702: font-size:90%;
5703: }
5704:
5705: div.LC_feedback_link div.LC_comblock {
5706: padding-left:5px;
5707: }
5708:
5709: div.LC_feedback_link div.LC_comblock a {
5710: color:$font;
5711: }
5712:
1.489 raeburn 5713: span.LC_feedback_link {
1.858 bisitz 5714: /* background: $feedback_link_bg; */
1.599 albertel 5715: font-size: larger;
5716: }
1.795 www 5717:
1.599 albertel 5718: span.LC_message_link {
1.858 bisitz 5719: /* background: $feedback_link_bg; */
1.599 albertel 5720: font-size: larger;
5721: position: absolute;
5722: right: 1em;
1.489 raeburn 5723: }
1.421 albertel 5724:
1.515 albertel 5725: table.LC_prior_tries {
1.524 albertel 5726: border: 1px solid #000000;
5727: border-collapse: separate;
5728: border-spacing: 1px;
1.515 albertel 5729: }
1.523 albertel 5730:
1.515 albertel 5731: table.LC_prior_tries td {
1.524 albertel 5732: padding: 2px;
1.515 albertel 5733: }
1.523 albertel 5734:
5735: .LC_answer_correct {
1.795 www 5736: background: lightgreen;
5737: color: darkgreen;
5738: padding: 6px;
1.523 albertel 5739: }
1.795 www 5740:
1.523 albertel 5741: .LC_answer_charged_try {
1.797 www 5742: background: #FFAAAA;
1.795 www 5743: color: darkred;
5744: padding: 6px;
1.523 albertel 5745: }
1.795 www 5746:
1.779 bisitz 5747: .LC_answer_not_charged_try,
1.523 albertel 5748: .LC_answer_no_grade,
5749: .LC_answer_late {
1.795 www 5750: background: lightyellow;
1.523 albertel 5751: color: black;
1.795 www 5752: padding: 6px;
1.523 albertel 5753: }
1.795 www 5754:
1.523 albertel 5755: .LC_answer_previous {
1.795 www 5756: background: lightblue;
5757: color: darkblue;
5758: padding: 6px;
1.523 albertel 5759: }
1.795 www 5760:
1.779 bisitz 5761: .LC_answer_no_message {
1.777 tempelho 5762: background: #FFFFFF;
5763: color: black;
1.795 www 5764: padding: 6px;
1.779 bisitz 5765: }
1.795 www 5766:
1.779 bisitz 5767: .LC_answer_unknown {
5768: background: orange;
5769: color: black;
1.795 www 5770: padding: 6px;
1.777 tempelho 5771: }
1.795 www 5772:
1.529 albertel 5773: span.LC_prior_numerical,
5774: span.LC_prior_string,
5775: span.LC_prior_custom,
5776: span.LC_prior_reaction,
5777: span.LC_prior_math {
1.925 bisitz 5778: font-family: $mono;
1.523 albertel 5779: white-space: pre;
5780: }
5781:
1.525 albertel 5782: span.LC_prior_string {
1.925 bisitz 5783: font-family: $mono;
1.525 albertel 5784: white-space: pre;
5785: }
5786:
1.523 albertel 5787: table.LC_prior_option {
5788: width: 100%;
5789: border-collapse: collapse;
5790: }
1.795 www 5791:
1.911 bisitz 5792: table.LC_prior_rank,
1.795 www 5793: table.LC_prior_match {
1.528 albertel 5794: border-collapse: collapse;
5795: }
1.795 www 5796:
1.528 albertel 5797: table.LC_prior_option tr td,
5798: table.LC_prior_rank tr td,
5799: table.LC_prior_match tr td {
1.524 albertel 5800: border: 1px solid #000000;
1.515 albertel 5801: }
5802:
1.855 bisitz 5803: .LC_nobreak {
1.544 albertel 5804: white-space: nowrap;
1.519 raeburn 5805: }
5806:
1.576 raeburn 5807: span.LC_cusr_emph {
5808: font-style: italic;
5809: }
5810:
1.633 raeburn 5811: span.LC_cusr_subheading {
5812: font-weight: normal;
5813: font-size: 85%;
5814: }
5815:
1.861 bisitz 5816: div.LC_docs_entry_move {
1.859 bisitz 5817: border: 1px solid #BBBBBB;
1.545 albertel 5818: background: #DDDDDD;
1.861 bisitz 5819: width: 22px;
1.859 bisitz 5820: padding: 1px;
5821: margin: 0;
1.545 albertel 5822: }
5823:
1.861 bisitz 5824: table.LC_data_table tr > td.LC_docs_entry_commands,
5825: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 5826: background: #DDDDDD;
5827: font-size: x-small;
5828: }
1.795 www 5829:
1.861 bisitz 5830: .LC_docs_entry_parameter {
5831: white-space: nowrap;
5832: }
5833:
1.544 albertel 5834: .LC_docs_copy {
1.545 albertel 5835: color: #000099;
1.544 albertel 5836: }
1.795 www 5837:
1.544 albertel 5838: .LC_docs_cut {
1.545 albertel 5839: color: #550044;
1.544 albertel 5840: }
1.795 www 5841:
1.544 albertel 5842: .LC_docs_rename {
1.545 albertel 5843: color: #009900;
1.544 albertel 5844: }
1.795 www 5845:
1.544 albertel 5846: .LC_docs_remove {
1.545 albertel 5847: color: #990000;
5848: }
5849:
1.547 albertel 5850: .LC_docs_reinit_warn,
5851: .LC_docs_ext_edit {
5852: font-size: x-small;
5853: }
5854:
1.545 albertel 5855: table.LC_docs_adddocs td,
5856: table.LC_docs_adddocs th {
5857: border: 1px solid #BBBBBB;
5858: padding: 4px;
5859: background: #DDDDDD;
1.543 albertel 5860: }
5861:
1.584 albertel 5862: table.LC_sty_begin {
5863: background: #BBFFBB;
5864: }
1.795 www 5865:
1.584 albertel 5866: table.LC_sty_end {
5867: background: #FFBBBB;
5868: }
5869:
1.589 raeburn 5870: table.LC_double_column {
1.803 bisitz 5871: border-width: 0;
1.589 raeburn 5872: border-collapse: collapse;
5873: width: 100%;
5874: padding: 2px;
5875: }
5876:
5877: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5878: top: 2px;
1.589 raeburn 5879: left: 2px;
5880: width: 47%;
5881: vertical-align: top;
5882: }
5883:
5884: table.LC_double_column tr td.LC_right_col {
5885: top: 2px;
1.779 bisitz 5886: right: 2px;
1.589 raeburn 5887: width: 47%;
5888: vertical-align: top;
5889: }
5890:
1.591 raeburn 5891: div.LC_left_float {
5892: float: left;
5893: padding-right: 5%;
1.597 albertel 5894: padding-bottom: 4px;
1.591 raeburn 5895: }
5896:
5897: div.LC_clear_float_header {
1.597 albertel 5898: padding-bottom: 2px;
1.591 raeburn 5899: }
5900:
5901: div.LC_clear_float_footer {
1.597 albertel 5902: padding-top: 10px;
1.591 raeburn 5903: clear: both;
5904: }
5905:
1.597 albertel 5906: div.LC_grade_show_user {
1.941 bisitz 5907: /* border-left: 5px solid $sidebg; */
5908: border-top: 5px solid #000000;
5909: margin: 50px 0 0 0;
1.936 bisitz 5910: padding: 15px 0 5px 10px;
1.597 albertel 5911: }
1.795 www 5912:
1.936 bisitz 5913: div.LC_grade_show_user_odd_row {
1.941 bisitz 5914: /* border-left: 5px solid #000000; */
5915: }
5916:
5917: div.LC_grade_show_user div.LC_Box {
5918: margin-right: 50px;
1.597 albertel 5919: }
5920:
5921: div.LC_grade_submissions,
5922: div.LC_grade_message_center,
1.936 bisitz 5923: div.LC_grade_info_links {
1.597 albertel 5924: margin: 5px;
5925: width: 99%;
5926: background: #FFFFFF;
5927: }
1.795 www 5928:
1.597 albertel 5929: div.LC_grade_submissions_header,
1.936 bisitz 5930: div.LC_grade_message_center_header {
1.705 tempelho 5931: font-weight: bold;
5932: font-size: large;
1.597 albertel 5933: }
1.795 www 5934:
1.597 albertel 5935: div.LC_grade_submissions_body,
1.936 bisitz 5936: div.LC_grade_message_center_body {
1.597 albertel 5937: border: 1px solid black;
5938: width: 99%;
5939: background: #FFFFFF;
5940: }
1.795 www 5941:
1.613 albertel 5942: table.LC_scantron_action {
5943: width: 100%;
5944: }
1.795 www 5945:
1.613 albertel 5946: table.LC_scantron_action tr th {
1.698 harmsja 5947: font-weight:bold;
5948: font-style:normal;
1.613 albertel 5949: }
1.795 www 5950:
1.779 bisitz 5951: .LC_edit_problem_header,
1.614 albertel 5952: div.LC_edit_problem_footer {
1.705 tempelho 5953: font-weight: normal;
5954: font-size: medium;
1.602 albertel 5955: margin: 2px;
1.600 albertel 5956: }
1.795 www 5957:
1.600 albertel 5958: div.LC_edit_problem_header,
1.602 albertel 5959: div.LC_edit_problem_header div,
1.614 albertel 5960: div.LC_edit_problem_footer,
5961: div.LC_edit_problem_footer div,
1.602 albertel 5962: div.LC_edit_problem_editxml_header,
5963: div.LC_edit_problem_editxml_header div {
1.600 albertel 5964: margin-top: 5px;
5965: }
1.795 www 5966:
1.600 albertel 5967: div.LC_edit_problem_header_title {
1.705 tempelho 5968: font-weight: bold;
5969: font-size: larger;
1.602 albertel 5970: background: $tabbg;
5971: padding: 3px;
5972: }
1.795 www 5973:
1.602 albertel 5974: table.LC_edit_problem_header_title {
5975: width: 100%;
1.600 albertel 5976: background: $tabbg;
1.602 albertel 5977: }
5978:
5979: div.LC_edit_problem_discards {
5980: float: left;
5981: padding-bottom: 5px;
5982: }
1.795 www 5983:
1.602 albertel 5984: div.LC_edit_problem_saves {
5985: float: right;
5986: padding-bottom: 5px;
1.600 albertel 5987: }
1.795 www 5988:
1.911 bisitz 5989: img.stift {
1.803 bisitz 5990: border-width: 0;
5991: vertical-align: middle;
1.677 riegler 5992: }
1.680 riegler 5993:
1.923 bisitz 5994: table td.LC_mainmenu_col_fieldset {
1.680 riegler 5995: vertical-align: top;
1.777 tempelho 5996: }
1.795 www 5997:
1.716 raeburn 5998: div.LC_createcourse {
1.911 bisitz 5999: margin: 10px 10px 10px 10px;
1.716 raeburn 6000: }
6001:
1.917 raeburn 6002: .LC_dccid {
6003: margin: 0.2em 0 0 0;
6004: padding: 0;
6005: font-size: 90%;
6006: display:none;
6007: }
6008:
1.698 harmsja 6009: a:hover,
1.897 wenzelju 6010: ol.LC_primary_menu a:hover,
1.721 harmsja 6011: ol#LC_MenuBreadcrumbs a:hover,
6012: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 6013: ul#LC_secondary_menu a:hover,
1.721 harmsja 6014: .LC_FormSectionClearButton input:hover
1.795 www 6015: ul.LC_TabContent li:hover a {
1.952 onken 6016: color:$button_hover;
1.911 bisitz 6017: text-decoration:none;
1.693 droeschl 6018: }
6019:
1.779 bisitz 6020: h1 {
1.911 bisitz 6021: padding: 0;
6022: line-height:130%;
1.693 droeschl 6023: }
1.698 harmsja 6024:
1.911 bisitz 6025: h2,
6026: h3,
6027: h4,
6028: h5,
6029: h6 {
6030: margin: 5px 0 5px 0;
6031: padding: 0;
6032: line-height:130%;
1.693 droeschl 6033: }
1.795 www 6034:
6035: .LC_hcell {
1.911 bisitz 6036: padding:3px 15px 3px 15px;
6037: margin: 0;
6038: background-color:$tabbg;
6039: color:$fontmenu;
6040: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 6041: }
1.795 www 6042:
1.840 bisitz 6043: .LC_Box > .LC_hcell {
1.911 bisitz 6044: margin: 0 -10px 10px -10px;
1.835 bisitz 6045: }
6046:
1.721 harmsja 6047: .LC_noBorder {
1.911 bisitz 6048: border: 0;
1.698 harmsja 6049: }
1.693 droeschl 6050:
1.721 harmsja 6051: .LC_FormSectionClearButton input {
1.911 bisitz 6052: background-color:transparent;
6053: border: none;
6054: cursor:pointer;
6055: text-decoration:underline;
1.693 droeschl 6056: }
1.763 bisitz 6057:
6058: .LC_help_open_topic {
1.911 bisitz 6059: color: #FFFFFF;
6060: background-color: #EEEEFF;
6061: margin: 1px;
6062: padding: 4px;
6063: border: 1px solid #000033;
6064: white-space: nowrap;
6065: /* vertical-align: middle; */
1.759 neumanie 6066: }
1.693 droeschl 6067:
1.911 bisitz 6068: dl,
6069: ul,
6070: div,
6071: fieldset {
6072: margin: 10px 10px 10px 0;
6073: /* overflow: hidden; */
1.693 droeschl 6074: }
1.795 www 6075:
1.838 bisitz 6076: fieldset > legend {
1.911 bisitz 6077: font-weight: bold;
6078: padding: 0 5px 0 5px;
1.838 bisitz 6079: }
6080:
1.813 bisitz 6081: #LC_nav_bar {
1.911 bisitz 6082: float: left;
1.995 raeburn 6083: background-color: $pgbg_or_bgcolor;
1.966 bisitz 6084: margin: 0 0 2px 0;
1.807 droeschl 6085: }
6086:
1.916 droeschl 6087: #LC_realm {
6088: margin: 0.2em 0 0 0;
6089: padding: 0;
6090: font-weight: bold;
6091: text-align: center;
1.995 raeburn 6092: background-color: $pgbg_or_bgcolor;
1.916 droeschl 6093: }
6094:
1.911 bisitz 6095: #LC_nav_bar em {
6096: font-weight: bold;
6097: font-style: normal;
1.807 droeschl 6098: }
6099:
1.897 wenzelju 6100: ol.LC_primary_menu {
1.911 bisitz 6101: float: right;
1.934 droeschl 6102: margin: 0;
1.995 raeburn 6103: background-color: $pgbg_or_bgcolor;
1.807 droeschl 6104: }
6105:
1.852 droeschl 6106: ol#LC_PathBreadcrumbs {
1.911 bisitz 6107: margin: 0;
1.693 droeschl 6108: }
6109:
1.897 wenzelju 6110: ol.LC_primary_menu li {
1.911 bisitz 6111: display: inline;
6112: padding: 5px 5px 0 10px;
6113: vertical-align: top;
1.693 droeschl 6114: }
6115:
1.897 wenzelju 6116: ol.LC_primary_menu li img {
1.911 bisitz 6117: vertical-align: bottom;
1.934 droeschl 6118: height: 1.1em;
1.693 droeschl 6119: }
6120:
1.897 wenzelju 6121: ol.LC_primary_menu a {
1.911 bisitz 6122: color: RGB(80, 80, 80);
6123: text-decoration: none;
1.693 droeschl 6124: }
1.795 www 6125:
1.949 droeschl 6126: ol.LC_primary_menu a.LC_new_message {
6127: font-weight:bold;
6128: color: darkred;
6129: }
6130:
1.975 raeburn 6131: ol.LC_docs_parameters {
6132: margin-left: 0;
6133: padding: 0;
6134: list-style: none;
6135: }
6136:
6137: ol.LC_docs_parameters li {
6138: margin: 0;
6139: padding-right: 20px;
6140: display: inline;
6141: }
6142:
1.976 raeburn 6143: ol.LC_docs_parameters li:before {
6144: content: "\\002022 \\0020";
6145: }
6146:
6147: li.LC_docs_parameters_title {
6148: font-weight: bold;
6149: }
6150:
6151: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
6152: content: "";
6153: }
6154:
1.897 wenzelju 6155: ul#LC_secondary_menu {
1.911 bisitz 6156: clear: both;
6157: color: $fontmenu;
6158: background: $tabbg;
6159: list-style: none;
6160: padding: 0;
6161: margin: 0;
6162: width: 100%;
1.995 raeburn 6163: text-align: left;
1.808 droeschl 6164: }
6165:
1.897 wenzelju 6166: ul#LC_secondary_menu li {
1.911 bisitz 6167: font-weight: bold;
6168: line-height: 1.8em;
6169: padding: 0 0.8em;
6170: border-right: 1px solid black;
6171: display: inline;
6172: vertical-align: middle;
1.807 droeschl 6173: }
6174:
1.847 tempelho 6175: ul.LC_TabContent {
1.911 bisitz 6176: display:block;
6177: background: $sidebg;
6178: border-bottom: solid 1px $lg_border_color;
6179: list-style:none;
6180: margin: 0 -10px;
6181: padding: 0;
1.693 droeschl 6182: }
6183:
1.795 www 6184: ul.LC_TabContent li,
6185: ul.LC_TabContentBigger li {
1.911 bisitz 6186: float:left;
1.741 harmsja 6187: }
1.795 www 6188:
1.897 wenzelju 6189: ul#LC_secondary_menu li a {
1.911 bisitz 6190: color: $fontmenu;
6191: text-decoration: none;
1.693 droeschl 6192: }
1.795 www 6193:
1.721 harmsja 6194: ul.LC_TabContent {
1.952 onken 6195: min-height:20px;
1.721 harmsja 6196: }
1.795 www 6197:
6198: ul.LC_TabContent li {
1.911 bisitz 6199: vertical-align:middle;
1.959 onken 6200: padding: 0 16px 0 10px;
1.911 bisitz 6201: background-color:$tabbg;
6202: border-bottom:solid 1px $lg_border_color;
1.952 onken 6203: border-right: solid 1px $font;
1.721 harmsja 6204: }
1.795 www 6205:
1.847 tempelho 6206: ul.LC_TabContent .right {
1.911 bisitz 6207: float:right;
1.847 tempelho 6208: }
6209:
1.911 bisitz 6210: ul.LC_TabContent li a,
6211: ul.LC_TabContent li {
6212: color:rgb(47,47,47);
6213: text-decoration:none;
6214: font-size:95%;
6215: font-weight:bold;
1.952 onken 6216: min-height:20px;
6217: }
6218:
1.959 onken 6219: ul.LC_TabContent li a:hover,
6220: ul.LC_TabContent li a:focus {
1.952 onken 6221: color: $button_hover;
1.959 onken 6222: background:none;
6223: outline:none;
1.952 onken 6224: }
6225:
6226: ul.LC_TabContent li:hover {
6227: color: $button_hover;
6228: cursor:pointer;
1.721 harmsja 6229: }
1.795 www 6230:
1.911 bisitz 6231: ul.LC_TabContent li.active {
1.952 onken 6232: color: $font;
1.911 bisitz 6233: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 6234: border-bottom:solid 1px #FFFFFF;
6235: cursor: default;
1.744 ehlerst 6236: }
1.795 www 6237:
1.959 onken 6238: ul.LC_TabContent li.active a {
6239: color:$font;
6240: background:#FFFFFF;
6241: outline: none;
6242: }
1.870 tempelho 6243: #maincoursedoc {
1.911 bisitz 6244: clear:both;
1.870 tempelho 6245: }
6246:
6247: ul.LC_TabContentBigger {
1.911 bisitz 6248: display:block;
6249: list-style:none;
6250: padding: 0;
1.870 tempelho 6251: }
6252:
1.795 www 6253: ul.LC_TabContentBigger li {
1.911 bisitz 6254: vertical-align:bottom;
6255: height: 30px;
6256: font-size:110%;
6257: font-weight:bold;
6258: color: #737373;
1.841 tempelho 6259: }
6260:
1.957 onken 6261: ul.LC_TabContentBigger li.active {
6262: position: relative;
6263: top: 1px;
6264: }
6265:
1.870 tempelho 6266: ul.LC_TabContentBigger li a {
1.911 bisitz 6267: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6268: height: 30px;
6269: line-height: 30px;
6270: text-align: center;
6271: display: block;
6272: text-decoration: none;
1.958 onken 6273: outline: none;
1.741 harmsja 6274: }
1.795 www 6275:
1.870 tempelho 6276: ul.LC_TabContentBigger li.active a {
1.911 bisitz 6277: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6278: color:$font;
1.744 ehlerst 6279: }
1.795 www 6280:
1.870 tempelho 6281: ul.LC_TabContentBigger li b {
1.911 bisitz 6282: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
6283: display: block;
6284: float: left;
6285: padding: 0 30px;
1.957 onken 6286: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 6287: }
6288:
1.956 onken 6289: ul.LC_TabContentBigger li:hover b {
6290: color:$button_hover;
6291: }
6292:
1.870 tempelho 6293: ul.LC_TabContentBigger li.active b {
1.911 bisitz 6294: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
6295: color:$font;
1.957 onken 6296: border: 0;
1.741 harmsja 6297: }
1.693 droeschl 6298:
1.870 tempelho 6299:
1.862 bisitz 6300: ul.LC_CourseBreadcrumbs {
6301: background: $sidebg;
6302: line-height: 32px;
6303: padding-left: 10px;
6304: margin: 0 0 10px 0;
6305: list-style-position: inside;
6306:
6307: }
6308:
1.911 bisitz 6309: ol#LC_MenuBreadcrumbs,
1.862 bisitz 6310: ol#LC_PathBreadcrumbs {
1.911 bisitz 6311: padding-left: 10px;
6312: margin: 0;
1.933 droeschl 6313: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 6314: }
6315:
1.911 bisitz 6316: ol#LC_MenuBreadcrumbs li,
6317: ol#LC_PathBreadcrumbs li,
1.862 bisitz 6318: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 6319: display: inline;
1.933 droeschl 6320: white-space: normal;
1.693 droeschl 6321: }
6322:
1.823 bisitz 6323: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 6324: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 6325: text-decoration: none;
6326: font-size:90%;
1.693 droeschl 6327: }
1.795 www 6328:
1.969 droeschl 6329: ol#LC_MenuBreadcrumbs h1 {
6330: display: inline;
6331: font-size: 90%;
6332: line-height: 2.5em;
6333: margin: 0;
6334: padding: 0;
6335: }
6336:
1.795 www 6337: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 6338: text-decoration:none;
6339: font-size:100%;
6340: font-weight:bold;
1.693 droeschl 6341: }
1.795 www 6342:
1.840 bisitz 6343: .LC_Box {
1.911 bisitz 6344: border: solid 1px $lg_border_color;
6345: padding: 0 10px 10px 10px;
1.746 neumanie 6346: }
1.795 www 6347:
6348: .LC_AboutMe_Image {
1.911 bisitz 6349: float:left;
6350: margin-right:10px;
1.747 neumanie 6351: }
1.795 www 6352:
6353: .LC_Clear_AboutMe_Image {
1.911 bisitz 6354: clear:left;
1.747 neumanie 6355: }
1.795 www 6356:
1.721 harmsja 6357: dl.LC_ListStyleClean dt {
1.911 bisitz 6358: padding-right: 5px;
6359: display: table-header-group;
1.693 droeschl 6360: }
6361:
1.721 harmsja 6362: dl.LC_ListStyleClean dd {
1.911 bisitz 6363: display: table-row;
1.693 droeschl 6364: }
6365:
1.721 harmsja 6366: .LC_ListStyleClean,
6367: .LC_ListStyleSimple,
6368: .LC_ListStyleNormal,
1.795 www 6369: .LC_ListStyleSpecial {
1.911 bisitz 6370: /* display:block; */
6371: list-style-position: inside;
6372: list-style-type: none;
6373: overflow: hidden;
6374: padding: 0;
1.693 droeschl 6375: }
6376:
1.721 harmsja 6377: .LC_ListStyleSimple li,
6378: .LC_ListStyleSimple dd,
6379: .LC_ListStyleNormal li,
6380: .LC_ListStyleNormal dd,
6381: .LC_ListStyleSpecial li,
1.795 www 6382: .LC_ListStyleSpecial dd {
1.911 bisitz 6383: margin: 0;
6384: padding: 5px 5px 5px 10px;
6385: clear: both;
1.693 droeschl 6386: }
6387:
1.721 harmsja 6388: .LC_ListStyleClean li,
6389: .LC_ListStyleClean dd {
1.911 bisitz 6390: padding-top: 0;
6391: padding-bottom: 0;
1.693 droeschl 6392: }
6393:
1.721 harmsja 6394: .LC_ListStyleSimple dd,
1.795 www 6395: .LC_ListStyleSimple li {
1.911 bisitz 6396: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6397: }
6398:
1.721 harmsja 6399: .LC_ListStyleSpecial li,
6400: .LC_ListStyleSpecial dd {
1.911 bisitz 6401: list-style-type: none;
6402: background-color: RGB(220, 220, 220);
6403: margin-bottom: 4px;
1.693 droeschl 6404: }
6405:
1.721 harmsja 6406: table.LC_SimpleTable {
1.911 bisitz 6407: margin:5px;
6408: border:solid 1px $lg_border_color;
1.795 www 6409: }
1.693 droeschl 6410:
1.721 harmsja 6411: table.LC_SimpleTable tr {
1.911 bisitz 6412: padding: 0;
6413: border:solid 1px $lg_border_color;
1.693 droeschl 6414: }
1.795 www 6415:
6416: table.LC_SimpleTable thead {
1.911 bisitz 6417: background:rgb(220,220,220);
1.693 droeschl 6418: }
6419:
1.721 harmsja 6420: div.LC_columnSection {
1.911 bisitz 6421: display: block;
6422: clear: both;
6423: overflow: hidden;
6424: margin: 0;
1.693 droeschl 6425: }
6426:
1.721 harmsja 6427: div.LC_columnSection>* {
1.911 bisitz 6428: float: left;
6429: margin: 10px 20px 10px 0;
6430: overflow:hidden;
1.693 droeschl 6431: }
1.721 harmsja 6432:
1.795 www 6433: table em {
1.911 bisitz 6434: font-weight: bold;
6435: font-style: normal;
1.748 schulted 6436: }
1.795 www 6437:
1.779 bisitz 6438: table.LC_tableBrowseRes,
1.795 www 6439: table.LC_tableOfContent {
1.911 bisitz 6440: border:none;
6441: border-spacing: 1px;
6442: padding: 3px;
6443: background-color: #FFFFFF;
6444: font-size: 90%;
1.753 droeschl 6445: }
1.789 droeschl 6446:
1.911 bisitz 6447: table.LC_tableOfContent {
6448: border-collapse: collapse;
1.789 droeschl 6449: }
6450:
1.771 droeschl 6451: table.LC_tableBrowseRes a,
1.768 schulted 6452: table.LC_tableOfContent a {
1.911 bisitz 6453: background-color: transparent;
6454: text-decoration: none;
1.753 droeschl 6455: }
6456:
1.795 www 6457: table.LC_tableOfContent img {
1.911 bisitz 6458: border: none;
6459: height: 1.3em;
6460: vertical-align: text-bottom;
6461: margin-right: 0.3em;
1.753 droeschl 6462: }
1.757 schulted 6463:
1.795 www 6464: a#LC_content_toolbar_firsthomework {
1.911 bisitz 6465: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 6466: }
6467:
1.795 www 6468: a#LC_content_toolbar_everything {
1.911 bisitz 6469: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 6470: }
6471:
1.795 www 6472: a#LC_content_toolbar_uncompleted {
1.911 bisitz 6473: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 6474: }
6475:
1.795 www 6476: #LC_content_toolbar_clearbubbles {
1.911 bisitz 6477: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 6478: }
6479:
1.795 www 6480: a#LC_content_toolbar_changefolder {
1.911 bisitz 6481: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 6482: }
6483:
1.795 www 6484: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 6485: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 6486: }
6487:
1.795 www 6488: ul#LC_toolbar li a:hover {
1.911 bisitz 6489: background-position: bottom center;
1.757 schulted 6490: }
6491:
1.795 www 6492: ul#LC_toolbar {
1.911 bisitz 6493: padding: 0;
6494: margin: 2px;
6495: list-style:none;
6496: position:relative;
6497: background-color:white;
1.757 schulted 6498: }
6499:
1.795 www 6500: ul#LC_toolbar li {
1.911 bisitz 6501: border:1px solid white;
6502: padding: 0;
6503: margin: 0;
6504: float: left;
6505: display:inline;
6506: vertical-align:middle;
6507: }
1.757 schulted 6508:
1.783 amueller 6509:
1.795 www 6510: a.LC_toolbarItem {
1.911 bisitz 6511: display:block;
6512: padding: 0;
6513: margin: 0;
6514: height: 32px;
6515: width: 32px;
6516: color:white;
6517: border: none;
6518: background-repeat:no-repeat;
6519: background-color:transparent;
1.757 schulted 6520: }
6521:
1.915 droeschl 6522: ul.LC_funclist {
6523: margin: 0;
6524: padding: 0.5em 1em 0.5em 0;
6525: }
6526:
1.933 droeschl 6527: ul.LC_funclist > li:first-child {
6528: font-weight:bold;
6529: margin-left:0.8em;
6530: }
6531:
1.915 droeschl 6532: ul.LC_funclist + ul.LC_funclist {
6533: /*
6534: left border as a seperator if we have more than
6535: one list
6536: */
6537: border-left: 1px solid $sidebg;
6538: /*
6539: this hides the left border behind the border of the
6540: outer box if element is wrapped to the next 'line'
6541: */
6542: margin-left: -1px;
6543: }
6544:
1.843 bisitz 6545: ul.LC_funclist li {
1.915 droeschl 6546: display: inline;
1.782 bisitz 6547: white-space: nowrap;
1.915 droeschl 6548: margin: 0 0 0 25px;
6549: line-height: 150%;
1.782 bisitz 6550: }
6551:
1.974 wenzelju 6552: .LC_hidden {
6553: display: none;
6554: }
6555:
1.343 albertel 6556: END
6557: }
6558:
1.306 albertel 6559: =pod
6560:
6561: =item * &headtag()
6562:
6563: Returns a uniform footer for LON-CAPA web pages.
6564:
1.307 albertel 6565: Inputs: $title - optional title for the head
6566: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 6567: $args - optional arguments
1.319 albertel 6568: force_register - if is true call registerurl so the remote is
6569: informed
1.415 albertel 6570: redirect -> array ref of
6571: 1- seconds before redirect occurs
6572: 2- url to redirect to
6573: 3- whether the side effect should occur
1.315 albertel 6574: (side effect of setting
6575: $env{'internal.head.redirect'} to the url
6576: redirected too)
1.352 albertel 6577: domain -> force to color decorate a page for a specific
6578: domain
6579: function -> force usage of a specific rolish color scheme
6580: bgcolor -> override the default page bgcolor
1.460 albertel 6581: no_auto_mt_title
6582: -> prevent &mt()ing the title arg
1.464 albertel 6583:
1.306 albertel 6584: =cut
6585:
6586: sub headtag {
1.313 albertel 6587: my ($title,$head_extra,$args) = @_;
1.306 albertel 6588:
1.363 albertel 6589: my $function = $args->{'function'} || &get_users_function();
6590: my $domain = $args->{'domain'} || &determinedomain();
6591: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 6592: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 6593: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 6594: #time(),
1.418 albertel 6595: $env{'environment.color.timestamp'},
1.363 albertel 6596: $function,$domain,$bgcolor);
6597:
1.369 www 6598: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 6599:
1.308 albertel 6600: my $result =
6601: '<head>'.
1.461 albertel 6602: &font_settings();
1.319 albertel 6603:
1.461 albertel 6604: if (!$args->{'frameset'}) {
6605: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
6606: }
1.962 droeschl 6607: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
6608: $result .= Apache::lonxml::display_title();
1.319 albertel 6609: }
1.436 albertel 6610: if (!$args->{'no_nav_bar'}
6611: && !$args->{'only_body'}
6612: && !$args->{'frameset'}) {
6613: $result .= &help_menu_js();
6614: }
1.319 albertel 6615:
1.314 albertel 6616: if (ref($args->{'redirect'})) {
1.414 albertel 6617: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 6618: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 6619: if (!$inhibit_continue) {
6620: $env{'internal.head.redirect'} = $url;
6621: }
1.313 albertel 6622: $result.=<<ADDMETA
6623: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 6624: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 6625: ADDMETA
6626: }
1.306 albertel 6627: if (!defined($title)) {
6628: $title = 'The LearningOnline Network with CAPA';
6629: }
1.460 albertel 6630: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
6631: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 6632: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
6633: .$head_extra;
1.962 droeschl 6634: return $result.'</head>';
1.306 albertel 6635: }
6636:
6637: =pod
6638:
1.340 albertel 6639: =item * &font_settings()
6640:
6641: Returns neccessary <meta> to set the proper encoding
6642:
6643: Inputs: none
6644:
6645: =cut
6646:
6647: sub font_settings {
6648: my $headerstring='';
1.647 www 6649: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 6650: $headerstring.=
6651: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
6652: }
6653: return $headerstring;
6654: }
6655:
1.341 albertel 6656: =pod
6657:
6658: =item * &xml_begin()
6659:
6660: Returns the needed doctype and <html>
6661:
6662: Inputs: none
6663:
6664: =cut
6665:
6666: sub xml_begin {
6667: my $output='';
6668:
6669: if ($env{'browser.mathml'}) {
6670: $output='<?xml version="1.0"?>'
6671: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
6672: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
6673:
6674: # .'<!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">] >'
6675: .'<!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">'
6676: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
6677: .'xmlns="http://www.w3.org/1999/xhtml">';
6678: } else {
1.849 bisitz 6679: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
6680: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341 albertel 6681: }
6682: return $output;
6683: }
1.340 albertel 6684:
6685: =pod
6686:
1.306 albertel 6687: =item * &start_page()
6688:
6689: Returns a complete <html> .. <body> section for LON-CAPA web pages.
6690:
1.648 raeburn 6691: Inputs:
6692:
6693: =over 4
6694:
6695: $title - optional title for the page
6696:
6697: $head_extra - optional extra HTML to incude inside the <head>
6698:
6699: $args - additional optional args supported are:
6700:
6701: =over 8
6702:
6703: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 6704: arg on
1.814 bisitz 6705: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 6706: add_entries -> additional attributes to add to the <body>
6707: domain -> force to color decorate a page for a
1.317 albertel 6708: specific domain
1.648 raeburn 6709: function -> force usage of a specific rolish color
1.317 albertel 6710: scheme
1.648 raeburn 6711: redirect -> see &headtag()
6712: bgcolor -> override the default page bg color
6713: js_ready -> return a string ready for being used in
1.317 albertel 6714: a javascript writeln
1.648 raeburn 6715: html_encode -> return a string ready for being used in
1.320 albertel 6716: a html attribute
1.648 raeburn 6717: force_register -> if is true will turn on the &bodytag()
1.317 albertel 6718: $forcereg arg
1.648 raeburn 6719: frameset -> if true will start with a <frameset>
1.330 albertel 6720: rather than <body>
1.648 raeburn 6721: skip_phases -> hash ref of
1.338 albertel 6722: head -> skip the <html><head> generation
6723: body -> skip all <body> generation
1.648 raeburn 6724: no_auto_mt_title -> prevent &mt()ing the title arg
6725: inherit_jsmath -> when creating popup window in a page,
6726: should it have jsmath forced on by the
6727: current page
1.867 kalberla 6728: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 6729: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.361 albertel 6730:
1.648 raeburn 6731: =back
1.460 albertel 6732:
1.648 raeburn 6733: =back
1.562 albertel 6734:
1.306 albertel 6735: =cut
6736:
6737: sub start_page {
1.309 albertel 6738: my ($title,$head_extra,$args) = @_;
1.318 albertel 6739: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.964 droeschl 6740: #SD
6741: #I don't see why we copy certain elements of %$args to %head_args
6742: #head args is passed to headtag() and this routine only reads those
6743: #keys that are needed. There doesn't happen any writes or any processing
6744: #of other keys.
6745: #proposal: just pass $args to headtag instead of \%head_args and delete
6746: #marked lines
6747: #<- MARK
1.313 albertel 6748: my %head_args;
1.352 albertel 6749: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6750: 'bgcolor','frameset','no_nav_bar','only_body',
6751: 'no_auto_mt_title') {
1.319 albertel 6752: if (defined($args->{$arg})) {
1.324 raeburn 6753: $head_args{$arg} = $args->{$arg};
1.319 albertel 6754: }
1.313 albertel 6755: }
1.964 droeschl 6756: #MARK ->
1.319 albertel 6757:
1.315 albertel 6758: $env{'internal.start_page'}++;
1.338 albertel 6759: my $result;
1.964 droeschl 6760:
1.338 albertel 6761: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.964 droeschl 6762: $result .=
6763: &xml_begin() . &headtag($title,$head_extra,\%head_args);
6764: #replace prev line by
6765: # &xml_begin() . &headtag($title, $head_extra, $args);
1.338 albertel 6766: }
6767:
6768: if (! exists($args->{'skip_phases'}{'body'}) ) {
6769: if ($args->{'frameset'}) {
6770: my $attr_string = &make_attr_string($args->{'force_register'},
6771: $args->{'add_entries'});
6772: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 6773: } else {
6774: $result .=
6775: &bodytag($title,
6776: $args->{'function'}, $args->{'add_entries'},
6777: $args->{'only_body'}, $args->{'domain'},
6778: $args->{'force_register'}, $args->{'no_nav_bar'},
1.962 droeschl 6779: $args->{'bgcolor'}, $args);
1.831 bisitz 6780: }
1.330 albertel 6781: }
1.338 albertel 6782:
1.315 albertel 6783: if ($args->{'js_ready'}) {
1.713 kaisler 6784: $result = &js_ready($result);
1.315 albertel 6785: }
1.320 albertel 6786: if ($args->{'html_encode'}) {
1.713 kaisler 6787: $result = &html_encode($result);
6788: }
6789:
1.813 bisitz 6790: # Preparation for new and consistent functionlist at top of screen
6791: # if ($args->{'functionlist'}) {
6792: # $result .= &build_functionlist();
6793: #}
6794:
1.964 droeschl 6795: # Don't add anything more if only_body wanted or in const space
6796: return $result if $args->{'only_body'}
6797: || $env{'request.state'} eq 'construct';
1.813 bisitz 6798:
6799: #Breadcrumbs
1.758 kaisler 6800: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
6801: &Apache::lonhtmlcommon::clear_breadcrumbs();
6802: #if any br links exists, add them to the breadcrumbs
6803: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6804: foreach my $crumb (@{$args->{'bread_crumbs'}}){
6805: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
6806: }
6807: }
6808:
6809: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
6810: if(exists($args->{'bread_crumbs_component'})){
6811: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
6812: }else{
6813: $result .= &Apache::lonhtmlcommon::breadcrumbs();
6814: }
1.320 albertel 6815: }
1.315 albertel 6816: return $result;
1.306 albertel 6817: }
6818:
6819: sub end_page {
1.315 albertel 6820: my ($args) = @_;
6821: $env{'internal.end_page'}++;
1.330 albertel 6822: my $result;
1.335 albertel 6823: if ($args->{'discussion'}) {
6824: my ($target,$parser);
6825: if (ref($args->{'discussion'})) {
6826: ($target,$parser) =($args->{'discussion'}{'target'},
6827: $args->{'discussion'}{'parser'});
6828: }
6829: $result .= &Apache::lonxml::xmlend($target,$parser);
6830: }
6831:
1.330 albertel 6832: if ($args->{'frameset'}) {
6833: $result .= '</frameset>';
6834: } else {
1.635 raeburn 6835: $result .= &endbodytag($args);
1.330 albertel 6836: }
6837: $result .= "\n</html>";
6838:
1.315 albertel 6839: if ($args->{'js_ready'}) {
1.317 albertel 6840: $result = &js_ready($result);
1.315 albertel 6841: }
1.335 albertel 6842:
1.320 albertel 6843: if ($args->{'html_encode'}) {
6844: $result = &html_encode($result);
6845: }
1.335 albertel 6846:
1.315 albertel 6847: return $result;
6848: }
6849:
1.320 albertel 6850: sub html_encode {
6851: my ($result) = @_;
6852:
1.322 albertel 6853: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6854:
6855: return $result;
6856: }
1.317 albertel 6857: sub js_ready {
6858: my ($result) = @_;
6859:
1.323 albertel 6860: $result =~ s/[\n\r]/ /xmsg;
6861: $result =~ s/\\/\\\\/xmsg;
6862: $result =~ s/'/\\'/xmsg;
1.372 albertel 6863: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6864:
6865: return $result;
6866: }
6867:
1.315 albertel 6868: sub validate_page {
6869: if ( exists($env{'internal.start_page'})
1.316 albertel 6870: && $env{'internal.start_page'} > 1) {
6871: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6872: $env{'internal.start_page'}.' '.
1.316 albertel 6873: $ENV{'request.filename'});
1.315 albertel 6874: }
6875: if ( exists($env{'internal.end_page'})
1.316 albertel 6876: && $env{'internal.end_page'} > 1) {
6877: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6878: $env{'internal.end_page'}.' '.
1.316 albertel 6879: $env{'request.filename'});
1.315 albertel 6880: }
6881: if ( exists($env{'internal.start_page'})
6882: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6883: &Apache::lonnet::logthis('start_page called without end_page '.
6884: $env{'request.filename'});
1.315 albertel 6885: }
6886: if ( ! exists($env{'internal.start_page'})
6887: && exists($env{'internal.end_page'})) {
1.316 albertel 6888: &Apache::lonnet::logthis('end_page called without start_page'.
6889: $env{'request.filename'});
1.315 albertel 6890: }
1.306 albertel 6891: }
1.315 albertel 6892:
1.996 www 6893:
6894: sub start_scrollbox {
1.998 raeburn 6895: my ($outerwidth,$width,$height)=@_;
6896: unless ($outerwidth) { $outerwidth='520px'; }
6897: unless ($width) { $width='500px'; }
6898: unless ($height) { $height='200px'; }
6899: return "<table style='width: $outerwidth; border: 1px solid black;'><tr><td style='width: $width;' bgcolor='#FFFFFF'><div style='overflow:auto; width:$width; height: $height;'>";
1.996 www 6900: }
6901:
6902: sub end_scrollbox {
1.998 raeburn 6903: return '</td></tr></table>';
1.996 www 6904: }
6905:
1.318 albertel 6906: sub simple_error_page {
6907: my ($r,$title,$msg) = @_;
6908: my $page =
6909: &Apache::loncommon::start_page($title).
6910: &mt($msg).
6911: &Apache::loncommon::end_page();
6912: if (ref($r)) {
6913: $r->print($page);
1.327 albertel 6914: return;
1.318 albertel 6915: }
6916: return $page;
6917: }
1.347 albertel 6918:
6919: {
1.610 albertel 6920: my @row_count;
1.961 onken 6921:
6922: sub start_data_table_count {
6923: unshift(@row_count, 0);
6924: return;
6925: }
6926:
6927: sub end_data_table_count {
6928: shift(@row_count);
6929: return;
6930: }
6931:
1.347 albertel 6932: sub start_data_table {
1.422 albertel 6933: my ($add_class) = @_;
6934: my $css_class = (join(' ','LC_data_table',$add_class));
1.961 onken 6935: &start_data_table_count();
1.422 albertel 6936: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 6937: }
6938:
6939: sub end_data_table {
1.961 onken 6940: &end_data_table_count();
1.389 albertel 6941: return '</table>'."\n";;
1.347 albertel 6942: }
6943:
6944: sub start_data_table_row {
1.974 wenzelju 6945: my ($add_class, $id) = @_;
1.610 albertel 6946: $row_count[0]++;
6947: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 6948: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 6949: $id = (' id="'.$id.'"') unless ($id eq '');
6950: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 6951: }
1.471 banghart 6952:
6953: sub continue_data_table_row {
1.974 wenzelju 6954: my ($add_class, $id) = @_;
1.610 albertel 6955: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 6956: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
6957: $id = (' id="'.$id.'"') unless ($id eq '');
6958: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 6959: }
1.347 albertel 6960:
6961: sub end_data_table_row {
1.389 albertel 6962: return '</tr>'."\n";;
1.347 albertel 6963: }
1.367 www 6964:
1.421 albertel 6965: sub start_data_table_empty_row {
1.707 bisitz 6966: # $row_count[0]++;
1.421 albertel 6967: return '<tr class="LC_empty_row" >'."\n";;
6968: }
6969:
6970: sub end_data_table_empty_row {
6971: return '</tr>'."\n";;
6972: }
6973:
1.367 www 6974: sub start_data_table_header_row {
1.389 albertel 6975: return '<tr class="LC_header_row">'."\n";;
1.367 www 6976: }
6977:
6978: sub end_data_table_header_row {
1.389 albertel 6979: return '</tr>'."\n";;
1.367 www 6980: }
1.890 droeschl 6981:
6982: sub data_table_caption {
6983: my $caption = shift;
6984: return "<caption class=\"LC_caption\">$caption</caption>";
6985: }
1.347 albertel 6986: }
6987:
1.548 albertel 6988: =pod
6989:
6990: =item * &inhibit_menu_check($arg)
6991:
6992: Checks for a inhibitmenu state and generates output to preserve it
6993:
6994: Inputs: $arg - can be any of
6995: - undef - in which case the return value is a string
6996: to add into arguments list of a uri
6997: - 'input' - in which case the return value is a HTML
6998: <form> <input> field of type hidden to
6999: preserve the value
7000: - a url - in which case the return value is the url with
7001: the neccesary cgi args added to preserve the
7002: inhibitmenu state
7003: - a ref to a url - no return value, but the string is
7004: updated to include the neccessary cgi
7005: args to preserve the inhibitmenu state
7006:
7007: =cut
7008:
7009: sub inhibit_menu_check {
7010: my ($arg) = @_;
7011: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
7012: if ($arg eq 'input') {
7013: if ($env{'form.inhibitmenu'}) {
7014: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
7015: } else {
7016: return
7017: }
7018: }
7019: if ($env{'form.inhibitmenu'}) {
7020: if (ref($arg)) {
7021: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7022: } elsif ($arg eq '') {
7023: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
7024: } else {
7025: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7026: }
7027: }
7028: if (!ref($arg)) {
7029: return $arg;
7030: }
7031: }
7032:
1.251 albertel 7033: ###############################################
1.182 matthew 7034:
7035: =pod
7036:
1.549 albertel 7037: =back
7038:
7039: =head1 User Information Routines
7040:
7041: =over 4
7042:
1.405 albertel 7043: =item * &get_users_function()
1.182 matthew 7044:
7045: Used by &bodytag to determine the current users primary role.
7046: Returns either 'student','coordinator','admin', or 'author'.
7047:
7048: =cut
7049:
7050: ###############################################
7051: sub get_users_function {
1.815 tempelho 7052: my $function = 'norole';
1.818 tempelho 7053: if ($env{'request.role'}=~/^(st)/) {
7054: $function='student';
7055: }
1.907 raeburn 7056: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 7057: $function='coordinator';
7058: }
1.258 albertel 7059: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 7060: $function='admin';
7061: }
1.826 bisitz 7062: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182 matthew 7063: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
7064: $function='author';
7065: }
7066: return $function;
1.54 www 7067: }
1.99 www 7068:
7069: ###############################################
7070:
1.233 raeburn 7071: =pod
7072:
1.821 raeburn 7073: =item * &show_course()
7074:
7075: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
7076: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
7077:
7078: Inputs:
7079: None
7080:
7081: Outputs:
7082: Scalar: 1 if 'Course' to be used, 0 otherwise.
7083:
7084: =cut
7085:
7086: ###############################################
7087: sub show_course {
7088: my $course = !$env{'user.adv'};
7089: if (!$env{'user.adv'}) {
7090: foreach my $env (keys(%env)) {
7091: next if ($env !~ m/^user\.priv\./);
7092: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
7093: $course = 0;
7094: last;
7095: }
7096: }
7097: }
7098: return $course;
7099: }
7100:
7101: ###############################################
7102:
7103: =pod
7104:
1.542 raeburn 7105: =item * &check_user_status()
1.274 raeburn 7106:
7107: Determines current status of supplied role for a
7108: specific user. Roles can be active, previous or future.
7109:
7110: Inputs:
7111: user's domain, user's username, course's domain,
1.375 raeburn 7112: course's number, optional section ID.
1.274 raeburn 7113:
7114: Outputs:
7115: role status: active, previous or future.
7116:
7117: =cut
7118:
7119: sub check_user_status {
1.412 raeburn 7120: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.982 raeburn 7121: my $extra = &Apache::lonnet::freeze_escape({'skipcheck' => 1});
7122: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname,'.',undef,$extra);
1.274 raeburn 7123: my @uroles = keys %userinfo;
7124: my $srchstr;
7125: my $active_chk = 'none';
1.412 raeburn 7126: my $now = time;
1.274 raeburn 7127: if (@uroles > 0) {
1.908 raeburn 7128: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 7129: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
7130: } else {
1.412 raeburn 7131: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
7132: }
7133: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 7134: my $role_end = 0;
7135: my $role_start = 0;
7136: $active_chk = 'active';
1.412 raeburn 7137: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
7138: $role_end = $1;
7139: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
7140: $role_start = $1;
1.274 raeburn 7141: }
7142: }
7143: if ($role_start > 0) {
1.412 raeburn 7144: if ($now < $role_start) {
1.274 raeburn 7145: $active_chk = 'future';
7146: }
7147: }
7148: if ($role_end > 0) {
1.412 raeburn 7149: if ($now > $role_end) {
1.274 raeburn 7150: $active_chk = 'previous';
7151: }
7152: }
7153: }
7154: }
7155: return $active_chk;
7156: }
7157:
7158: ###############################################
7159:
7160: =pod
7161:
1.405 albertel 7162: =item * &get_sections()
1.233 raeburn 7163:
7164: Determines all the sections for a course including
7165: sections with students and sections containing other roles.
1.419 raeburn 7166: Incoming parameters:
7167:
7168: 1. domain
7169: 2. course number
7170: 3. reference to array containing roles for which sections should
7171: be gathered (optional).
7172: 4. reference to array containing status types for which sections
7173: should be gathered (optional).
7174:
7175: If the third argument is undefined, sections are gathered for any role.
7176: If the fourth argument is undefined, sections are gathered for any status.
7177: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 7178:
1.374 raeburn 7179: Returns section hash (keys are section IDs, values are
7180: number of users in each section), subject to the
1.419 raeburn 7181: optional roles filter, optional status filter
1.233 raeburn 7182:
7183: =cut
7184:
7185: ###############################################
7186: sub get_sections {
1.419 raeburn 7187: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 7188: if (!defined($cdom) || !defined($cnum)) {
7189: my $cid = $env{'request.course.id'};
7190:
7191: return if (!defined($cid));
7192:
7193: $cdom = $env{'course.'.$cid.'.domain'};
7194: $cnum = $env{'course.'.$cid.'.num'};
7195: }
7196:
7197: my %sectioncount;
1.419 raeburn 7198: my $now = time;
1.240 albertel 7199:
1.366 albertel 7200: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 7201: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 7202: my $sec_index = &Apache::loncoursedata::CL_SECTION();
7203: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 7204: my $start_index = &Apache::loncoursedata::CL_START();
7205: my $end_index = &Apache::loncoursedata::CL_END();
7206: my $status;
1.366 albertel 7207: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 7208: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
7209: $data->[$status_index],
7210: $data->[$start_index],
7211: $data->[$end_index]);
7212: if ($stu_status eq 'Active') {
7213: $status = 'active';
7214: } elsif ($end < $now) {
7215: $status = 'previous';
7216: } elsif ($start > $now) {
7217: $status = 'future';
7218: }
7219: if ($section ne '-1' && $section !~ /^\s*$/) {
7220: if ((!defined($possible_status)) || (($status ne '') &&
7221: (grep/^\Q$status\E$/,@{$possible_status}))) {
7222: $sectioncount{$section}++;
7223: }
1.240 albertel 7224: }
7225: }
7226: }
7227: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7228: foreach my $user (sort(keys(%courseroles))) {
7229: if ($user !~ /^(\w{2})/) { next; }
7230: my ($role) = ($user =~ /^(\w{2})/);
7231: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 7232: my ($section,$status);
1.240 albertel 7233: if ($role eq 'cr' &&
7234: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
7235: $section=$1;
7236: }
7237: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
7238: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 7239: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
7240: if ($end == -1 && $start == -1) {
7241: next; #deleted role
7242: }
7243: if (!defined($possible_status)) {
7244: $sectioncount{$section}++;
7245: } else {
7246: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
7247: $status = 'active';
7248: } elsif ($end < $now) {
7249: $status = 'future';
7250: } elsif ($start > $now) {
7251: $status = 'previous';
7252: }
7253: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
7254: $sectioncount{$section}++;
7255: }
7256: }
1.233 raeburn 7257: }
1.366 albertel 7258: return %sectioncount;
1.233 raeburn 7259: }
7260:
1.274 raeburn 7261: ###############################################
1.294 raeburn 7262:
7263: =pod
1.405 albertel 7264:
7265: =item * &get_course_users()
7266:
1.275 raeburn 7267: Retrieves usernames:domains for users in the specified course
7268: with specific role(s), and access status.
7269:
7270: Incoming parameters:
1.277 albertel 7271: 1. course domain
7272: 2. course number
7273: 3. access status: users must have - either active,
1.275 raeburn 7274: previous, future, or all.
1.277 albertel 7275: 4. reference to array of permissible roles
1.288 raeburn 7276: 5. reference to array of section restrictions (optional)
7277: 6. reference to results object (hash of hashes).
7278: 7. reference to optional userdata hash
1.609 raeburn 7279: 8. reference to optional statushash
1.630 raeburn 7280: 9. flag if privileged users (except those set to unhide in
7281: course settings) should be excluded
1.609 raeburn 7282: Keys of top level results hash are roles.
1.275 raeburn 7283: Keys of inner hashes are username:domain, with
7284: values set to access type.
1.288 raeburn 7285: Optional userdata hash returns an array with arguments in the
7286: same order as loncoursedata::get_classlist() for student data.
7287:
1.609 raeburn 7288: Optional statushash returns
7289:
1.288 raeburn 7290: Entries for end, start, section and status are blank because
7291: of the possibility of multiple values for non-student roles.
7292:
1.275 raeburn 7293: =cut
1.405 albertel 7294:
1.275 raeburn 7295: ###############################################
1.405 albertel 7296:
1.275 raeburn 7297: sub get_course_users {
1.630 raeburn 7298: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 7299: my %idx = ();
1.419 raeburn 7300: my %seclists;
1.288 raeburn 7301:
7302: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
7303: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
7304: $idx{end} = &Apache::loncoursedata::CL_END();
7305: $idx{start} = &Apache::loncoursedata::CL_START();
7306: $idx{id} = &Apache::loncoursedata::CL_ID();
7307: $idx{section} = &Apache::loncoursedata::CL_SECTION();
7308: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
7309: $idx{status} = &Apache::loncoursedata::CL_STATUS();
7310:
1.290 albertel 7311: if (grep(/^st$/,@{$roles})) {
1.276 albertel 7312: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 7313: my $now = time;
1.277 albertel 7314: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 7315: my $match = 0;
1.412 raeburn 7316: my $secmatch = 0;
1.419 raeburn 7317: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 7318: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 7319: if ($section eq '') {
7320: $section = 'none';
7321: }
1.291 albertel 7322: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7323: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7324: $secmatch = 1;
7325: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 7326: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7327: $secmatch = 1;
7328: }
7329: } else {
1.419 raeburn 7330: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 7331: $secmatch = 1;
7332: }
1.290 albertel 7333: }
1.412 raeburn 7334: if (!$secmatch) {
7335: next;
7336: }
1.419 raeburn 7337: }
1.275 raeburn 7338: if (defined($$types{'active'})) {
1.288 raeburn 7339: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 7340: push(@{$$users{st}{$student}},'active');
1.288 raeburn 7341: $match = 1;
1.275 raeburn 7342: }
7343: }
7344: if (defined($$types{'previous'})) {
1.609 raeburn 7345: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 7346: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 7347: $match = 1;
1.275 raeburn 7348: }
7349: }
7350: if (defined($$types{'future'})) {
1.609 raeburn 7351: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 7352: push(@{$$users{st}{$student}},'future');
1.288 raeburn 7353: $match = 1;
1.275 raeburn 7354: }
7355: }
1.609 raeburn 7356: if ($match) {
7357: push(@{$seclists{$student}},$section);
7358: if (ref($userdata) eq 'HASH') {
7359: $$userdata{$student} = $$classlist{$student};
7360: }
7361: if (ref($statushash) eq 'HASH') {
7362: $statushash->{$student}{'st'}{$section} = $status;
7363: }
1.288 raeburn 7364: }
1.275 raeburn 7365: }
7366: }
1.412 raeburn 7367: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 7368: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7369: my $now = time;
1.609 raeburn 7370: my %displaystatus = ( previous => 'Expired',
7371: active => 'Active',
7372: future => 'Future',
7373: );
1.630 raeburn 7374: my %nothide;
7375: if ($hidepriv) {
7376: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
7377: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
7378: if ($user !~ /:/) {
7379: $nothide{join(':',split(/[\@]/,$user))}=1;
7380: } else {
7381: $nothide{$user} = 1;
7382: }
7383: }
7384: }
1.439 raeburn 7385: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 7386: my $match = 0;
1.412 raeburn 7387: my $secmatch = 0;
1.439 raeburn 7388: my $status;
1.412 raeburn 7389: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 7390: $user =~ s/:$//;
1.439 raeburn 7391: my ($end,$start) = split(/:/,$coursepersonnel{$person});
7392: if ($end == -1 || $start == -1) {
7393: next;
7394: }
7395: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
7396: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 7397: my ($uname,$udom) = split(/:/,$user);
7398: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7399: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7400: $secmatch = 1;
7401: } elsif ($usec eq '') {
1.420 albertel 7402: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7403: $secmatch = 1;
7404: }
7405: } else {
7406: if (grep(/^\Q$usec\E$/,@{$sections})) {
7407: $secmatch = 1;
7408: }
7409: }
7410: if (!$secmatch) {
7411: next;
7412: }
1.288 raeburn 7413: }
1.419 raeburn 7414: if ($usec eq '') {
7415: $usec = 'none';
7416: }
1.275 raeburn 7417: if ($uname ne '' && $udom ne '') {
1.630 raeburn 7418: if ($hidepriv) {
7419: if ((&Apache::lonnet::privileged($uname,$udom)) &&
7420: (!$nothide{$uname.':'.$udom})) {
7421: next;
7422: }
7423: }
1.503 raeburn 7424: if ($end > 0 && $end < $now) {
1.439 raeburn 7425: $status = 'previous';
7426: } elsif ($start > $now) {
7427: $status = 'future';
7428: } else {
7429: $status = 'active';
7430: }
1.277 albertel 7431: foreach my $type (keys(%{$types})) {
1.275 raeburn 7432: if ($status eq $type) {
1.420 albertel 7433: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 7434: push(@{$$users{$role}{$user}},$type);
7435: }
1.288 raeburn 7436: $match = 1;
7437: }
7438: }
1.419 raeburn 7439: if (($match) && (ref($userdata) eq 'HASH')) {
7440: if (!exists($$userdata{$uname.':'.$udom})) {
7441: &get_user_info($udom,$uname,\%idx,$userdata);
7442: }
1.420 albertel 7443: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 7444: push(@{$seclists{$uname.':'.$udom}},$usec);
7445: }
1.609 raeburn 7446: if (ref($statushash) eq 'HASH') {
7447: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
7448: }
1.275 raeburn 7449: }
7450: }
7451: }
7452: }
1.290 albertel 7453: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 7454: if ((defined($cdom)) && (defined($cnum))) {
7455: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
7456: if ( defined($csettings{'internal.courseowner'}) ) {
7457: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 7458: next if ($owner eq '');
7459: my ($ownername,$ownerdom);
7460: if ($owner =~ /^([^:]+):([^:]+)$/) {
7461: $ownername = $1;
7462: $ownerdom = $2;
7463: } else {
7464: $ownername = $owner;
7465: $ownerdom = $cdom;
7466: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 7467: }
7468: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 7469: if (defined($userdata) &&
1.609 raeburn 7470: !exists($$userdata{$owner})) {
7471: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
7472: if (!grep(/^none$/,@{$seclists{$owner}})) {
7473: push(@{$seclists{$owner}},'none');
7474: }
7475: if (ref($statushash) eq 'HASH') {
7476: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 7477: }
1.290 albertel 7478: }
1.279 raeburn 7479: }
7480: }
7481: }
1.419 raeburn 7482: foreach my $user (keys(%seclists)) {
7483: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
7484: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
7485: }
1.275 raeburn 7486: }
7487: return;
7488: }
7489:
1.288 raeburn 7490: sub get_user_info {
7491: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 7492: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
7493: &plainname($uname,$udom,'lastname');
1.291 albertel 7494: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 7495: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 7496: my %idhash = &Apache::lonnet::idrget($udom,($uname));
7497: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 7498: return;
7499: }
1.275 raeburn 7500:
1.472 raeburn 7501: ###############################################
7502:
7503: =pod
7504:
7505: =item * &get_user_quota()
7506:
7507: Retrieves quota assigned for storage of portfolio files for a user
7508:
7509: Incoming parameters:
7510: 1. user's username
7511: 2. user's domain
7512:
7513: Returns:
1.536 raeburn 7514: 1. Disk quota (in Mb) assigned to student.
7515: 2. (Optional) Type of setting: custom or default
7516: (individually assigned or default for user's
7517: institutional status).
7518: 3. (Optional) - User's institutional status (e.g., faculty, staff
7519: or student - types as defined in localenroll::inst_usertypes
7520: for user's domain, which determines default quota for user.
7521: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 7522:
7523: If a value has been stored in the user's environment,
1.536 raeburn 7524: it will return that, otherwise it returns the maximal default
7525: defined for the user's instituional status(es) in the domain.
1.472 raeburn 7526:
7527: =cut
7528:
7529: ###############################################
7530:
7531:
7532: sub get_user_quota {
7533: my ($uname,$udom) = @_;
1.536 raeburn 7534: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 7535: if (!defined($udom)) {
7536: $udom = $env{'user.domain'};
7537: }
7538: if (!defined($uname)) {
7539: $uname = $env{'user.name'};
7540: }
7541: if (($udom eq '' || $uname eq '') ||
7542: ($udom eq 'public') && ($uname eq 'public')) {
7543: $quota = 0;
1.536 raeburn 7544: $quotatype = 'default';
7545: $defquota = 0;
1.472 raeburn 7546: } else {
1.536 raeburn 7547: my $inststatus;
1.472 raeburn 7548: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
7549: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 7550: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 7551: } else {
1.536 raeburn 7552: my %userenv =
7553: &Apache::lonnet::get('environment',['portfolioquota',
7554: 'inststatus'],$udom,$uname);
1.472 raeburn 7555: my ($tmp) = keys(%userenv);
7556: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7557: $quota = $userenv{'portfolioquota'};
1.536 raeburn 7558: $inststatus = $userenv{'inststatus'};
1.472 raeburn 7559: } else {
7560: undef(%userenv);
7561: }
7562: }
1.536 raeburn 7563: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 7564: if ($quota eq '') {
1.536 raeburn 7565: $quota = $defquota;
7566: $quotatype = 'default';
7567: } else {
7568: $quotatype = 'custom';
1.472 raeburn 7569: }
7570: }
1.536 raeburn 7571: if (wantarray) {
7572: return ($quota,$quotatype,$settingstatus,$defquota);
7573: } else {
7574: return $quota;
7575: }
1.472 raeburn 7576: }
7577:
7578: ###############################################
7579:
7580: =pod
7581:
7582: =item * &default_quota()
7583:
1.536 raeburn 7584: Retrieves default quota assigned for storage of user portfolio files,
7585: given an (optional) user's institutional status.
1.472 raeburn 7586:
7587: Incoming parameters:
7588: 1. domain
1.536 raeburn 7589: 2. (Optional) institutional status(es). This is a : separated list of
7590: status types (e.g., faculty, staff, student etc.)
7591: which apply to the user for whom the default is being retrieved.
7592: If the institutional status string in undefined, the domain
7593: default quota will be returned.
1.472 raeburn 7594:
7595: Returns:
7596: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 7597: 2. (Optional) institutional type which determined the value of the
7598: default quota.
1.472 raeburn 7599:
7600: If a value has been stored in the domain's configuration db,
7601: it will return that, otherwise it returns 20 (for backwards
7602: compatibility with domains which have not set up a configuration
7603: db file; the original statically defined portfolio quota was 20 Mb).
7604:
1.536 raeburn 7605: If the user's status includes multiple types (e.g., staff and student),
7606: the largest default quota which applies to the user determines the
7607: default quota returned.
7608:
1.780 raeburn 7609: =back
7610:
1.472 raeburn 7611: =cut
7612:
7613: ###############################################
7614:
7615:
7616: sub default_quota {
1.536 raeburn 7617: my ($udom,$inststatus) = @_;
7618: my ($defquota,$settingstatus);
7619: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 7620: ['quotas'],$udom);
7621: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 7622: if ($inststatus ne '') {
1.765 raeburn 7623: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 7624: foreach my $item (@statuses) {
1.711 raeburn 7625: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7626: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
7627: if ($defquota eq '') {
7628: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7629: $settingstatus = $item;
7630: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
7631: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7632: $settingstatus = $item;
7633: }
7634: }
7635: } else {
7636: if ($quotahash{'quotas'}{$item} ne '') {
7637: if ($defquota eq '') {
7638: $defquota = $quotahash{'quotas'}{$item};
7639: $settingstatus = $item;
7640: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
7641: $defquota = $quotahash{'quotas'}{$item};
7642: $settingstatus = $item;
7643: }
1.536 raeburn 7644: }
7645: }
7646: }
7647: }
7648: if ($defquota eq '') {
1.711 raeburn 7649: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7650: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
7651: } else {
7652: $defquota = $quotahash{'quotas'}{'default'};
7653: }
1.536 raeburn 7654: $settingstatus = 'default';
7655: }
7656: } else {
7657: $settingstatus = 'default';
7658: $defquota = 20;
7659: }
7660: if (wantarray) {
7661: return ($defquota,$settingstatus);
1.472 raeburn 7662: } else {
1.536 raeburn 7663: return $defquota;
1.472 raeburn 7664: }
7665: }
7666:
1.384 raeburn 7667: sub get_secgrprole_info {
7668: my ($cdom,$cnum,$needroles,$type) = @_;
7669: my %sections_count = &get_sections($cdom,$cnum);
7670: my @sections = (sort {$a <=> $b} keys(%sections_count));
7671: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
7672: my @groups = sort(keys(%curr_groups));
7673: my $allroles = [];
7674: my $rolehash;
7675: my $accesshash = {
7676: active => 'Currently has access',
7677: future => 'Will have future access',
7678: previous => 'Previously had access',
7679: };
7680: if ($needroles) {
7681: $rolehash = {'all' => 'all'};
1.385 albertel 7682: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7683: if (&Apache::lonnet::error(%user_roles)) {
7684: undef(%user_roles);
7685: }
7686: foreach my $item (keys(%user_roles)) {
1.384 raeburn 7687: my ($role)=split(/\:/,$item,2);
7688: if ($role eq 'cr') { next; }
7689: if ($role =~ /^cr/) {
7690: $$rolehash{$role} = (split('/',$role))[3];
7691: } else {
7692: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
7693: }
7694: }
7695: foreach my $key (sort(keys(%{$rolehash}))) {
7696: push(@{$allroles},$key);
7697: }
7698: push (@{$allroles},'st');
7699: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
7700: }
7701: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
7702: }
7703:
1.555 raeburn 7704: sub user_picker {
1.994 raeburn 7705: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context) = @_;
1.555 raeburn 7706: my $currdom = $dom;
7707: my %curr_selected = (
7708: srchin => 'dom',
1.580 raeburn 7709: srchby => 'lastname',
1.555 raeburn 7710: );
7711: my $srchterm;
1.625 raeburn 7712: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 7713: if ($srch->{'srchby'} ne '') {
7714: $curr_selected{'srchby'} = $srch->{'srchby'};
7715: }
7716: if ($srch->{'srchin'} ne '') {
7717: $curr_selected{'srchin'} = $srch->{'srchin'};
7718: }
7719: if ($srch->{'srchtype'} ne '') {
7720: $curr_selected{'srchtype'} = $srch->{'srchtype'};
7721: }
7722: if ($srch->{'srchdomain'} ne '') {
7723: $currdom = $srch->{'srchdomain'};
7724: }
7725: $srchterm = $srch->{'srchterm'};
7726: }
7727: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 7728: 'usr' => 'Search criteria',
1.563 raeburn 7729: 'doma' => 'Domain/institution to search',
1.558 albertel 7730: 'uname' => 'username',
7731: 'lastname' => 'last name',
1.555 raeburn 7732: 'lastfirst' => 'last name, first name',
1.558 albertel 7733: 'crs' => 'in this course',
1.576 raeburn 7734: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 7735: 'alc' => 'all LON-CAPA',
1.573 raeburn 7736: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 7737: 'exact' => 'is',
7738: 'contains' => 'contains',
1.569 raeburn 7739: 'begins' => 'begins with',
1.571 raeburn 7740: 'youm' => "You must include some text to search for.",
7741: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
7742: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
7743: 'yomc' => "You must choose a domain when using an institutional directory search.",
7744: 'ymcd' => "You must choose a domain when using a domain search.",
7745: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
7746: 'whse' => "When searching by last,first you must include at least one character in the first name.",
7747: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 7748: );
1.563 raeburn 7749: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
7750: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 7751:
7752: my @srchins = ('crs','dom','alc','instd');
7753:
7754: foreach my $option (@srchins) {
7755: # FIXME 'alc' option unavailable until
7756: # loncreateuser::print_user_query_page()
7757: # has been completed.
7758: next if ($option eq 'alc');
1.880 raeburn 7759: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 7760: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 7761: if ($curr_selected{'srchin'} eq $option) {
7762: $srchinsel .= '
7763: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7764: } else {
7765: $srchinsel .= '
7766: <option value="'.$option.'">'.$lt{$option}.'</option>';
7767: }
1.555 raeburn 7768: }
1.563 raeburn 7769: $srchinsel .= "\n </select>\n";
1.555 raeburn 7770:
7771: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 7772: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 7773: if ($curr_selected{'srchby'} eq $option) {
7774: $srchbysel .= '
7775: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7776: } else {
7777: $srchbysel .= '
7778: <option value="'.$option.'">'.$lt{$option}.'</option>';
7779: }
7780: }
7781: $srchbysel .= "\n </select>\n";
7782:
7783: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 7784: foreach my $option ('begins','contains','exact') {
1.555 raeburn 7785: if ($curr_selected{'srchtype'} eq $option) {
7786: $srchtypesel .= '
7787: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7788: } else {
7789: $srchtypesel .= '
7790: <option value="'.$option.'">'.$lt{$option}.'</option>';
7791: }
7792: }
7793: $srchtypesel .= "\n </select>\n";
7794:
1.558 albertel 7795: my ($newuserscript,$new_user_create);
1.994 raeburn 7796: my $context_dom = $env{'request.role.domain'};
7797: if ($context eq 'requestcrs') {
7798: if ($env{'form.coursedom'} ne '') {
7799: $context_dom = $env{'form.coursedom'};
7800: }
7801: }
1.556 raeburn 7802: if ($forcenewuser) {
1.576 raeburn 7803: if (ref($srch) eq 'HASH') {
1.994 raeburn 7804: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 7805: if ($cancreate) {
7806: $new_user_create = '<p> <input type="submit" name="forcenew" value="'.&HTML::Entities::encode(&mt('Make new user "[_1]"',$srchterm),'<>&"').'" onclick="javascript:setSearch(\'1\','.$caller.');" /> </p>';
7807: } else {
1.799 bisitz 7808: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 7809: my %usertypetext = (
7810: official => 'institutional',
7811: unofficial => 'non-institutional',
7812: );
1.799 bisitz 7813: $new_user_create = '<p class="LC_warning">'
7814: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
7815: .' '
7816: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
7817: ,'<a href="'.$helplink.'">','</a>')
7818: .'</p><br />';
1.627 raeburn 7819: }
1.576 raeburn 7820: }
7821: }
7822:
1.556 raeburn 7823: $newuserscript = <<"ENDSCRIPT";
7824:
1.570 raeburn 7825: function setSearch(createnew,callingForm) {
1.556 raeburn 7826: if (createnew == 1) {
1.570 raeburn 7827: for (var i=0; i<callingForm.srchby.length; i++) {
7828: if (callingForm.srchby.options[i].value == 'uname') {
7829: callingForm.srchby.selectedIndex = i;
1.556 raeburn 7830: }
7831: }
1.570 raeburn 7832: for (var i=0; i<callingForm.srchin.length; i++) {
7833: if ( callingForm.srchin.options[i].value == 'dom') {
7834: callingForm.srchin.selectedIndex = i;
1.556 raeburn 7835: }
7836: }
1.570 raeburn 7837: for (var i=0; i<callingForm.srchtype.length; i++) {
7838: if (callingForm.srchtype.options[i].value == 'exact') {
7839: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 7840: }
7841: }
1.570 raeburn 7842: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 7843: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 7844: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 7845: }
7846: }
7847: }
7848: }
7849: ENDSCRIPT
1.558 albertel 7850:
1.556 raeburn 7851: }
7852:
1.555 raeburn 7853: my $output = <<"END_BLOCK";
1.556 raeburn 7854: <script type="text/javascript">
1.824 bisitz 7855: // <![CDATA[
1.570 raeburn 7856: function validateEntry(callingForm) {
1.558 albertel 7857:
1.556 raeburn 7858: var checkok = 1;
1.558 albertel 7859: var srchin;
1.570 raeburn 7860: for (var i=0; i<callingForm.srchin.length; i++) {
7861: if ( callingForm.srchin[i].checked ) {
7862: srchin = callingForm.srchin[i].value;
1.558 albertel 7863: }
7864: }
7865:
1.570 raeburn 7866: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7867: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7868: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7869: var srchterm = callingForm.srchterm.value;
7870: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7871: var msg = "";
7872:
7873: if (srchterm == "") {
7874: checkok = 0;
1.571 raeburn 7875: msg += "$lt{'youm'}\\n";
1.556 raeburn 7876: }
7877:
1.569 raeburn 7878: if (srchtype== 'begins') {
7879: if (srchterm.length < 2) {
7880: checkok = 0;
1.571 raeburn 7881: msg += "$lt{'thte'}\\n";
1.569 raeburn 7882: }
7883: }
7884:
1.556 raeburn 7885: if (srchtype== 'contains') {
7886: if (srchterm.length < 3) {
7887: checkok = 0;
1.571 raeburn 7888: msg += "$lt{'thet'}\\n";
1.556 raeburn 7889: }
7890: }
7891: if (srchin == 'instd') {
7892: if (srchdomain == '') {
7893: checkok = 0;
1.571 raeburn 7894: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7895: }
7896: }
7897: if (srchin == 'dom') {
7898: if (srchdomain == '') {
7899: checkok = 0;
1.571 raeburn 7900: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7901: }
7902: }
7903: if (srchby == 'lastfirst') {
7904: if (srchterm.indexOf(",") == -1) {
7905: checkok = 0;
1.571 raeburn 7906: msg += "$lt{'whus'}\\n";
1.556 raeburn 7907: }
7908: if (srchterm.indexOf(",") == srchterm.length -1) {
7909: checkok = 0;
1.571 raeburn 7910: msg += "$lt{'whse'}\\n";
1.556 raeburn 7911: }
7912: }
7913: if (checkok == 0) {
1.571 raeburn 7914: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7915: return;
7916: }
7917: if (checkok == 1) {
1.570 raeburn 7918: callingForm.submit();
1.556 raeburn 7919: }
7920: }
7921:
7922: $newuserscript
7923:
1.824 bisitz 7924: // ]]>
1.556 raeburn 7925: </script>
1.558 albertel 7926:
7927: $new_user_create
7928:
1.555 raeburn 7929: END_BLOCK
1.558 albertel 7930:
1.876 raeburn 7931: $output .= &Apache::lonhtmlcommon::start_pick_box().
7932: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
7933: $domform.
7934: &Apache::lonhtmlcommon::row_closure().
7935: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
7936: $srchbysel.
7937: $srchtypesel.
7938: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
7939: $srchinsel.
7940: &Apache::lonhtmlcommon::row_closure(1).
7941: &Apache::lonhtmlcommon::end_pick_box().
7942: '<br />';
1.555 raeburn 7943: return $output;
7944: }
7945:
1.612 raeburn 7946: sub user_rule_check {
1.615 raeburn 7947: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 7948: my $response;
7949: if (ref($usershash) eq 'HASH') {
7950: foreach my $user (keys(%{$usershash})) {
7951: my ($uname,$udom) = split(/:/,$user);
7952: next if ($udom eq '' || $uname eq '');
1.615 raeburn 7953: my ($id,$newuser);
1.612 raeburn 7954: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 7955: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 7956: $id = $usershash->{$user}->{'id'};
7957: }
7958: my $inst_response;
7959: if (ref($checks) eq 'HASH') {
7960: if (defined($checks->{'username'})) {
1.615 raeburn 7961: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7962: &Apache::lonnet::get_instuser($udom,$uname);
7963: } elsif (defined($checks->{'id'})) {
1.615 raeburn 7964: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7965: &Apache::lonnet::get_instuser($udom,undef,$id);
7966: }
1.615 raeburn 7967: } else {
7968: ($inst_response,%{$inst_results->{$user}}) =
7969: &Apache::lonnet::get_instuser($udom,$uname);
7970: return;
1.612 raeburn 7971: }
1.615 raeburn 7972: if (!$got_rules->{$udom}) {
1.612 raeburn 7973: my %domconfig = &Apache::lonnet::get_dom('configuration',
7974: ['usercreation'],$udom);
7975: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 7976: foreach my $item ('username','id') {
1.612 raeburn 7977: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
7978: $$curr_rules{$udom}{$item} =
7979: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 7980: }
7981: }
7982: }
1.615 raeburn 7983: $got_rules->{$udom} = 1;
1.585 raeburn 7984: }
1.612 raeburn 7985: foreach my $item (keys(%{$checks})) {
7986: if (ref($$curr_rules{$udom}) eq 'HASH') {
7987: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
7988: if (@{$$curr_rules{$udom}{$item}} > 0) {
7989: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
7990: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
7991: if ($rule_check{$rule}) {
7992: $$rulematch{$user}{$item} = $rule;
7993: if ($inst_response eq 'ok') {
1.615 raeburn 7994: if (ref($inst_results) eq 'HASH') {
7995: if (ref($inst_results->{$user}) eq 'HASH') {
7996: if (keys(%{$inst_results->{$user}}) == 0) {
7997: $$alerts{$item}{$udom}{$uname} = 1;
7998: }
1.612 raeburn 7999: }
8000: }
1.615 raeburn 8001: }
8002: last;
1.585 raeburn 8003: }
8004: }
8005: }
8006: }
8007: }
8008: }
8009: }
8010: }
1.612 raeburn 8011: return;
8012: }
8013:
8014: sub user_rule_formats {
8015: my ($domain,$domdesc,$curr_rules,$check) = @_;
8016: my %text = (
8017: 'username' => 'Usernames',
8018: 'id' => 'IDs',
8019: );
8020: my $output;
8021: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
8022: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
8023: if (@{$ruleorder} > 0) {
8024: $output = '<br />'.&mt("$text{$check} with the following format(s) may <span class=\"LC_cusr_emph\">only</span> be used for verified users at [_1]:",$domdesc).' <ul>';
8025: foreach my $rule (@{$ruleorder}) {
8026: if (ref($curr_rules) eq 'ARRAY') {
8027: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
8028: if (ref($rules->{$rule}) eq 'HASH') {
8029: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
8030: $rules->{$rule}{'desc'}.'</li>';
8031: }
8032: }
8033: }
8034: }
8035: $output .= '</ul>';
8036: }
8037: }
8038: return $output;
8039: }
8040:
8041: sub instrule_disallow_msg {
1.615 raeburn 8042: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 8043: my $response;
8044: my %text = (
8045: item => 'username',
8046: items => 'usernames',
8047: match => 'matches',
8048: do => 'does',
8049: action => 'a username',
8050: one => 'one',
8051: );
8052: if ($count > 1) {
8053: $text{'item'} = 'usernames';
8054: $text{'match'} ='match';
8055: $text{'do'} = 'do';
8056: $text{'action'} = 'usernames',
8057: $text{'one'} = 'ones';
8058: }
8059: if ($checkitem eq 'id') {
8060: $text{'items'} = 'IDs';
8061: $text{'item'} = 'ID';
8062: $text{'action'} = 'an ID';
1.615 raeburn 8063: if ($count > 1) {
8064: $text{'item'} = 'IDs';
8065: $text{'action'} = 'IDs';
8066: }
1.612 raeburn 8067: }
1.674 bisitz 8068: $response = &mt("The $text{'item'} you chose $text{'match'} the format of $text{'items'} defined for [_1], but the $text{'item'} $text{'do'} not exist in the institutional directory.",'<span class="LC_cusr_emph">'.$domdesc.'</span>').'<br />';
1.615 raeburn 8069: if ($mode eq 'upload') {
8070: if ($checkitem eq 'username') {
8071: $response .= &mt("You will need to modify your upload file so it will include $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
8072: } elsif ($checkitem eq 'id') {
1.674 bisitz 8073: $response .= &mt("Either upload a file which includes $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or when associating fields with data columns, omit an association for the Student/Employee ID field.");
1.615 raeburn 8074: }
1.669 raeburn 8075: } elsif ($mode eq 'selfcreate') {
8076: if ($checkitem eq 'id') {
8077: $response .= &mt("You must either choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or leave the ID field blank.");
8078: }
1.615 raeburn 8079: } else {
8080: if ($checkitem eq 'username') {
8081: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
8082: } elsif ($checkitem eq 'id') {
8083: $response .= &mt("You must either choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or leave the ID field blank.");
8084: }
1.612 raeburn 8085: }
8086: return $response;
1.585 raeburn 8087: }
8088:
1.624 raeburn 8089: sub personal_data_fieldtitles {
8090: my %fieldtitles = &Apache::lonlocal::texthash (
8091: id => 'Student/Employee ID',
8092: permanentemail => 'E-mail address',
8093: lastname => 'Last Name',
8094: firstname => 'First Name',
8095: middlename => 'Middle Name',
8096: generation => 'Generation',
8097: gen => 'Generation',
1.765 raeburn 8098: inststatus => 'Affiliation',
1.624 raeburn 8099: );
8100: return %fieldtitles;
8101: }
8102:
1.642 raeburn 8103: sub sorted_inst_types {
8104: my ($dom) = @_;
8105: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
8106: my $othertitle = &mt('All users');
8107: if ($env{'request.course.id'}) {
1.668 raeburn 8108: $othertitle = &mt('Any users');
1.642 raeburn 8109: }
8110: my @types;
8111: if (ref($order) eq 'ARRAY') {
8112: @types = @{$order};
8113: }
8114: if (@types == 0) {
8115: if (ref($usertypes) eq 'HASH') {
8116: @types = sort(keys(%{$usertypes}));
8117: }
8118: }
8119: if (keys(%{$usertypes}) > 0) {
8120: $othertitle = &mt('Other users');
8121: }
8122: return ($othertitle,$usertypes,\@types);
8123: }
8124:
1.645 raeburn 8125: sub get_institutional_codes {
8126: my ($settings,$allcourses,$LC_code) = @_;
8127: # Get complete list of course sections to update
8128: my @currsections = ();
8129: my @currxlists = ();
8130: my $coursecode = $$settings{'internal.coursecode'};
8131:
8132: if ($$settings{'internal.sectionnums'} ne '') {
8133: @currsections = split(/,/,$$settings{'internal.sectionnums'});
8134: }
8135:
8136: if ($$settings{'internal.crosslistings'} ne '') {
8137: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
8138: }
8139:
8140: if (@currxlists > 0) {
8141: foreach (@currxlists) {
8142: if (m/^([^:]+):(\w*)$/) {
8143: unless (grep/^$1$/,@{$allcourses}) {
8144: push @{$allcourses},$1;
8145: $$LC_code{$1} = $2;
8146: }
8147: }
8148: }
8149: }
8150:
8151: if (@currsections > 0) {
8152: foreach (@currsections) {
8153: if (m/^(\w+):(\w*)$/) {
8154: my $sec = $coursecode.$1;
8155: my $lc_sec = $2;
8156: unless (grep/^$sec$/,@{$allcourses}) {
8157: push @{$allcourses},$sec;
8158: $$LC_code{$sec} = $lc_sec;
8159: }
8160: }
8161: }
8162: }
8163: return;
8164: }
8165:
1.971 raeburn 8166: sub get_standard_codeitems {
8167: return ('Year','Semester','Department','Number','Section');
8168: }
8169:
1.112 bowersj2 8170: =pod
8171:
1.780 raeburn 8172: =head1 Slot Helpers
8173:
8174: =over 4
8175:
8176: =item * sorted_slots()
8177:
8178: Sorts an array of slot names in order of slot start time (earliest first).
8179:
8180: Inputs:
8181:
8182: =over 4
8183:
8184: slotsarr - Reference to array of unsorted slot names.
8185:
8186: slots - Reference to hash of hash, where outer hash keys are slot names.
8187:
1.549 albertel 8188: =back
8189:
1.780 raeburn 8190: Returns:
8191:
8192: =over 4
8193:
8194: sorted - An array of slot names sorted by the start time of the slot.
8195:
8196: =back
8197:
8198: =back
8199:
8200: =cut
8201:
8202:
8203: sub sorted_slots {
8204: my ($slotsarr,$slots) = @_;
8205: my @sorted;
8206: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
8207: @sorted =
8208: sort {
8209: if (ref($slots->{$a}) && ref($slots->{$b})) {
8210: return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
8211: }
8212: if (ref($slots->{$a})) { return -1;}
8213: if (ref($slots->{$b})) { return 1;}
8214: return 0;
8215: } @{$slotsarr};
8216: }
8217: return @sorted;
8218: }
8219:
8220:
8221: =pod
8222:
1.549 albertel 8223: =head1 HTTP Helpers
8224:
8225: =over 4
8226:
1.648 raeburn 8227: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 8228:
1.258 albertel 8229: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 8230: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 8231: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 8232:
8233: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
8234: $possible_names is an ref to an array of form element names. As an example:
8235: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 8236: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 8237:
8238: =cut
1.1 albertel 8239:
1.6 albertel 8240: sub get_unprocessed_cgi {
1.25 albertel 8241: my ($query,$possible_names)= @_;
1.26 matthew 8242: # $Apache::lonxml::debug=1;
1.356 albertel 8243: foreach my $pair (split(/&/,$query)) {
8244: my ($name, $value) = split(/=/,$pair);
1.369 www 8245: $name = &unescape($name);
1.25 albertel 8246: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
8247: $value =~ tr/+/ /;
8248: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 8249: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 8250: }
1.16 harris41 8251: }
1.6 albertel 8252: }
8253:
1.112 bowersj2 8254: =pod
8255:
1.648 raeburn 8256: =item * &cacheheader()
1.112 bowersj2 8257:
8258: returns cache-controlling header code
8259:
8260: =cut
8261:
1.7 albertel 8262: sub cacheheader {
1.258 albertel 8263: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 8264: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
8265: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 8266: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
8267: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 8268: return $output;
1.7 albertel 8269: }
8270:
1.112 bowersj2 8271: =pod
8272:
1.648 raeburn 8273: =item * &no_cache($r)
1.112 bowersj2 8274:
8275: specifies header code to not have cache
8276:
8277: =cut
8278:
1.9 albertel 8279: sub no_cache {
1.216 albertel 8280: my ($r) = @_;
8281: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 8282: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 8283: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
8284: $r->no_cache(1);
8285: $r->header_out("Expires" => $date);
8286: $r->header_out("Pragma" => "no-cache");
1.123 www 8287: }
8288:
8289: sub content_type {
1.181 albertel 8290: my ($r,$type,$charset) = @_;
1.299 foxr 8291: if ($r) {
8292: # Note that printout.pl calls this with undef for $r.
8293: &no_cache($r);
8294: }
1.258 albertel 8295: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 8296: unless ($charset) {
8297: $charset=&Apache::lonlocal::current_encoding;
8298: }
8299: if ($charset) { $type.='; charset='.$charset; }
8300: if ($r) {
8301: $r->content_type($type);
8302: } else {
8303: print("Content-type: $type\n\n");
8304: }
1.9 albertel 8305: }
1.25 albertel 8306:
1.112 bowersj2 8307: =pod
8308:
1.648 raeburn 8309: =item * &add_to_env($name,$value)
1.112 bowersj2 8310:
1.258 albertel 8311: adds $name to the %env hash with value
1.112 bowersj2 8312: $value, if $name already exists, the entry is converted to an array
8313: reference and $value is added to the array.
8314:
8315: =cut
8316:
1.25 albertel 8317: sub add_to_env {
8318: my ($name,$value)=@_;
1.258 albertel 8319: if (defined($env{$name})) {
8320: if (ref($env{$name})) {
1.25 albertel 8321: #already have multiple values
1.258 albertel 8322: push(@{ $env{$name} },$value);
1.25 albertel 8323: } else {
8324: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 8325: my $first=$env{$name};
8326: undef($env{$name});
8327: push(@{ $env{$name} },$first,$value);
1.25 albertel 8328: }
8329: } else {
1.258 albertel 8330: $env{$name}=$value;
1.25 albertel 8331: }
1.31 albertel 8332: }
1.149 albertel 8333:
8334: =pod
8335:
1.648 raeburn 8336: =item * &get_env_multiple($name)
1.149 albertel 8337:
1.258 albertel 8338: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 8339: values may be defined and end up as an array ref.
8340:
8341: returns an array of values
8342:
8343: =cut
8344:
8345: sub get_env_multiple {
8346: my ($name) = @_;
8347: my @values;
1.258 albertel 8348: if (defined($env{$name})) {
1.149 albertel 8349: # exists is it an array
1.258 albertel 8350: if (ref($env{$name})) {
8351: @values=@{ $env{$name} };
1.149 albertel 8352: } else {
1.258 albertel 8353: $values[0]=$env{$name};
1.149 albertel 8354: }
8355: }
8356: return(@values);
8357: }
8358:
1.660 raeburn 8359: sub ask_for_embedded_content {
8360: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.987 raeburn 8361: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges);
1.660 raeburn 8362: my $num = 0;
1.987 raeburn 8363: my $numremref = 0;
8364: my $numinvalid = 0;
8365: my $numpathchg = 0;
8366: my $numexisting = 0;
8367: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath);
1.984 raeburn 8368: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
8369: my $current_path='/';
8370: if ($env{'form.currentpath'}) {
8371: $current_path = $env{'form.currentpath'};
8372: }
8373: if ($actionurl eq '/adm/coursegrp_portfolio') {
8374: $udom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8375: $uname = $env{'course.'.$env{'request.course.id'}.'.num'};
8376: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
8377: } else {
8378: $udom = $env{'user.domain'};
8379: $uname = $env{'user.name'};
8380: $url = '/userfiles/portfolio';
8381: }
1.987 raeburn 8382: $toplevel = $url.'/';
1.984 raeburn 8383: $url .= $current_path;
8384: $getpropath = 1;
1.987 raeburn 8385: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
8386: ($actionurl eq '/adm/imsimport')) {
1.984 raeburn 8387: ($uname,my $rest) = ($args->{'current_path'} =~ m{/priv/($match_username)/?(.*)$});
1.987 raeburn 8388: $url = '/home/'.$uname.'/public_html/';
8389: $toplevel = $url;
1.984 raeburn 8390: if ($rest ne '') {
1.987 raeburn 8391: $url .= $rest;
8392: }
8393: } elsif ($actionurl eq '/adm/coursedocs') {
8394: if (ref($args) eq 'HASH') {
8395: $url = $args->{'docs_url'};
8396: $toplevel = $url;
8397: }
8398: }
8399: my $now = time();
8400: foreach my $embed_file (keys(%{$allfiles})) {
8401: my $absolutepath;
8402: if ($embed_file =~ m{^\w+://}) {
8403: $newfiles{$embed_file} = 1;
8404: $mapping{$embed_file} = $embed_file;
8405: } else {
8406: if ($embed_file =~ m{^/}) {
8407: $absolutepath = $embed_file;
8408: $embed_file =~ s{^(/+)}{};
8409: }
8410: if ($embed_file =~ m{/}) {
8411: my ($path,$fname) = ($embed_file =~ m{^(.+)/([^/]*)$});
8412: $path = &check_for_traversal($path,$url,$toplevel);
8413: my $item = $fname;
8414: if ($path ne '') {
8415: $item = $path.'/'.$fname;
8416: $subdependencies{$path}{$fname} = 1;
8417: } else {
8418: $dependencies{$item} = 1;
8419: }
8420: if ($absolutepath) {
8421: $mapping{$item} = $absolutepath;
8422: } else {
8423: $mapping{$item} = $embed_file;
8424: }
8425: } else {
8426: $dependencies{$embed_file} = 1;
8427: if ($absolutepath) {
8428: $mapping{$embed_file} = $absolutepath;
8429: } else {
8430: $mapping{$embed_file} = $embed_file;
8431: }
8432: }
1.984 raeburn 8433: }
8434: }
8435: foreach my $path (keys(%subdependencies)) {
8436: my %currsubfile;
8437: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
8438: my @subdir_list = &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
8439: foreach my $line (@subdir_list) {
8440: my ($file_name,$rest) = split(/\&/,$line,2);
8441: $currsubfile{$file_name} = 1;
8442: }
1.987 raeburn 8443: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 8444: if (opendir(my $dir,$url.'/'.$path)) {
8445: my @subdir_list = grep(!/^\./,readdir($dir));
8446: map {$currsubfile{$_} = 1;} @subdir_list;
8447: }
8448: }
8449: foreach my $file (keys(%{$subdependencies{$path}})) {
1.987 raeburn 8450: if ($currsubfile{$file}) {
8451: my $item = $path.'/'.$file;
8452: unless ($mapping{$item} eq $item) {
8453: $pathchanges{$item} = 1;
8454: }
8455: $existing{$item} = 1;
8456: $numexisting ++;
8457: } else {
8458: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 8459: }
8460: }
8461: }
1.987 raeburn 8462: my %currfile;
1.984 raeburn 8463: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
8464: my @dir_list = &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
8465: foreach my $line (@dir_list) {
8466: my ($file_name,$rest) = split(/\&/,$line,2);
8467: $currfile{$file_name} = 1;
8468: }
1.987 raeburn 8469: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 8470: if (opendir(my $dir,$url)) {
1.987 raeburn 8471: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 8472: map {$currfile{$_} = 1;} @dir_list;
8473: }
8474: }
8475: foreach my $file (keys(%dependencies)) {
1.987 raeburn 8476: if ($currfile{$file}) {
8477: unless ($mapping{$file} eq $file) {
8478: $pathchanges{$file} = 1;
8479: }
8480: $existing{$file} = 1;
8481: $numexisting ++;
8482: } else {
1.984 raeburn 8483: $newfiles{$file} = 1;
8484: }
8485: }
8486: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.660 raeburn 8487: $upload_output .= &start_data_table_row().
1.987 raeburn 8488: '<td><span class="LC_filename">'.$embed_file.'</span>';
8489: unless ($mapping{$embed_file} eq $embed_file) {
8490: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.&mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
8491: }
8492: $upload_output .= '</td><td>';
1.660 raeburn 8493: if ($args->{'ignore_remote_references'}
8494: && $embed_file =~ m{^\w+://}) {
8495: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
1.987 raeburn 8496: $numremref++;
1.660 raeburn 8497: } elsif ($args->{'error_on_invalid_names'}
8498: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
8499:
1.987 raeburn 8500: $upload_output.='<span class="LC_warning">'.&mt('Invalid characters').'</span>';
8501: $numinvalid++;
1.660 raeburn 8502: } else {
1.987 raeburn 8503: $upload_output .= &embedded_file_element('upload_embedded',$num,
8504: $embed_file,\%mapping,
8505: $allfiles,$codebase);
8506: $num++;
8507: }
8508: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
8509: }
8510: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
8511: $upload_output .= &start_data_table_row().
8512: '<td><span class="LC_filename">'.$embed_file.'</span></td>'.
8513: '<td><span class="LC_warning">'.&mt('Already exists').'</span></td>'.
8514: &Apache::loncommon::end_data_table_row()."\n";
8515: }
8516: if ($upload_output) {
8517: $upload_output = &start_data_table().
8518: $upload_output.
8519: &end_data_table()."\n";
8520: }
8521: my $applies = 0;
8522: if ($numremref) {
8523: $applies ++;
8524: }
8525: if ($numinvalid) {
8526: $applies ++;
8527: }
8528: if ($numexisting) {
8529: $applies ++;
8530: }
8531: if ($num) {
8532: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
8533: ' method="post" enctype="multipart/form-data">'."\n".
8534: $state.
8535: '<h3>'.&mt('Upload embedded files').
8536: ':</h3>'.$upload_output.'<br />'."\n".
8537: '<input type ="hidden" name="number_embedded_items" value="'.
8538: $num.'" />'."\n";
8539: if ($actionurl eq '') {
8540: $output .= '<input type="hidden" name="phase" value="three" />';
8541: }
8542: } elsif ($applies) {
8543: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
8544: if ($applies > 1) {
8545: $output .=
8546: &mt('No files need to be uploaded, as one of the following applies to each reference:').'<ul>';
8547: if ($numremref) {
8548: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
8549: }
8550: if ($numinvalid) {
8551: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
8552: }
8553: if ($numexisting) {
8554: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
8555: }
8556: $output .= '</ul><br />';
8557: } elsif ($numremref) {
8558: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
8559: } elsif ($numinvalid) {
8560: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
8561: } elsif ($numexisting) {
8562: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
8563: }
8564: $output .= $upload_output.'<br />';
8565: }
8566: my ($pathchange_output,$chgcount);
8567: $chgcount = $num;
8568: if (keys(%pathchanges) > 0) {
8569: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
8570: if ($num) {
8571: $output .= &embedded_file_element('pathchange',$chgcount,
8572: $embed_file,\%mapping,
8573: $allfiles,$codebase);
8574: } else {
8575: $pathchange_output .=
8576: &start_data_table_row().
8577: '<td><input type ="checkbox" name="namechange" value="'.
8578: $chgcount.'" checked="checked" /></td>'.
8579: '<td>'.$mapping{$embed_file}.'</td>'.
8580: '<td>'.$embed_file.
8581: &embedded_file_element('pathchange',$numpathchg,$embed_file,
8582: \%mapping,$allfiles,$codebase).
8583: '</td>'.&end_data_table_row();
1.660 raeburn 8584: }
1.987 raeburn 8585: $numpathchg ++;
8586: $chgcount ++;
1.660 raeburn 8587: }
8588: }
1.984 raeburn 8589: if ($num) {
1.987 raeburn 8590: if ($numpathchg) {
8591: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
8592: $numpathchg.'" />'."\n";
8593: }
8594: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
8595: ($actionurl eq '/adm/imsimport')) {
8596: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
8597: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
8598: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
8599: }
8600: $output .= '<input type ="submit" value="'.&mt('Upload Listed Files').'" />'."\n".
8601: &mt('(only files for which a location has been provided will be uploaded)').'</form>'."\n";
8602: } elsif ($numpathchg) {
8603: my %pathchange = ();
8604: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
8605: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
8606: $output .= '<p>'.&mt('or').'</p>';
8607: }
8608: }
8609: return ($output,$num,$numpathchg);
8610: }
8611:
8612: sub embedded_file_element {
8613: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase) = @_;
8614: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
8615: (ref($codebase) eq 'HASH'));
8616: my $output;
8617: if ($context eq 'upload_embedded') {
8618: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
8619: }
8620: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
8621: &escape($embed_file).'" />';
8622: unless (($context eq 'upload_embedded') &&
8623: ($mapping->{$embed_file} eq $embed_file)) {
8624: $output .='
8625: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
8626: }
8627: my $attrib;
8628: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
8629: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
8630: }
8631: $output .=
8632: "\n\t\t".
8633: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
8634: $attrib.'" />';
8635: if (exists($codebase->{$mapping->{$embed_file}})) {
8636: $output .=
8637: "\n\t\t".
8638: '<input name="codebase_'.$num.'" type="hidden" value="'.
8639: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 8640: }
1.987 raeburn 8641: return $output;
1.660 raeburn 8642: }
8643:
1.661 raeburn 8644: sub upload_embedded {
8645: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 8646: $current_disk_usage,$hiddenstate,$actionurl) = @_;
8647: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 8648: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
8649: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
8650: my $orig_uploaded_filename =
8651: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 8652: foreach my $type ('orig','ref','attrib','codebase') {
8653: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
8654: $env{'form.embedded_'.$type.'_'.$i} =
8655: &unescape($env{'form.embedded_'.$type.'_'.$i});
8656: }
8657: }
1.661 raeburn 8658: my ($path,$fname) =
8659: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
8660: # no path, whole string is fname
8661: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
8662: $fname = &Apache::lonnet::clean_filename($fname);
8663: # See if there is anything left
8664: next if ($fname eq '');
8665:
8666: # Check if file already exists as a file or directory.
8667: my ($state,$msg);
8668: if ($context eq 'portfolio') {
8669: my $port_path = $dirpath;
8670: if ($group ne '') {
8671: $port_path = "groups/$group/$port_path";
8672: }
1.987 raeburn 8673: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
8674: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 8675: $dir_root,$port_path,$disk_quota,
8676: $current_disk_usage,$uname,$udom);
8677: if ($state eq 'will_exceed_quota'
1.984 raeburn 8678: || $state eq 'file_locked') {
1.661 raeburn 8679: $output .= $msg;
8680: next;
8681: }
8682: } elsif (($context eq 'author') || ($context eq 'testbank')) {
8683: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
8684: if ($state eq 'exists') {
8685: $output .= $msg;
8686: next;
8687: }
8688: }
8689: # Check if extension is valid
8690: if (($fname =~ /\.(\w+)$/) &&
8691: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.987 raeburn 8692: $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 8693: next;
8694: } elsif (($fname =~ /\.(\w+)$/) &&
8695: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 8696: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 8697: next;
8698: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.987 raeburn 8699: $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 8700: next;
8701: }
8702:
8703: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
8704: if ($context eq 'portfolio') {
1.984 raeburn 8705: my $result;
8706: if ($state eq 'existingfile') {
8707: $result=
8708: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.987 raeburn 8709: $dirpath.$env{'form.currentpath'}.$path);
1.661 raeburn 8710: } else {
1.984 raeburn 8711: $result=
8712: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 8713: $dirpath.
8714: $env{'form.currentpath'}.$path);
1.984 raeburn 8715: if ($result !~ m|^/uploaded/|) {
8716: $output .= '<span class="LC_error">'
8717: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
8718: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
8719: .'</span><br />';
8720: next;
8721: } else {
1.987 raeburn 8722: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
8723: $path.$fname.'</span>').'<br />';
1.984 raeburn 8724: }
1.661 raeburn 8725: }
1.987 raeburn 8726: } elsif ($context eq 'coursedoc') {
8727: my $result =
8728: &Apache::lonnet::userfileupload('embedded_item_'.$i,'coursedoc',
8729: $dirpath.'/'.$path);
8730: if ($result !~ m|^/uploaded/|) {
8731: $output .= '<span class="LC_error">'
8732: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
8733: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
8734: .'</span><br />';
8735: next;
8736: } else {
8737: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
8738: $path.$fname.'</span>').'<br />';
8739: }
1.661 raeburn 8740: } else {
8741: # Save the file
8742: my $target = $env{'form.embedded_item_'.$i};
8743: my $fullpath = $dir_root.$dirpath.'/'.$path;
8744: my $dest = $fullpath.$fname;
8745: my $url = $url_root.$dirpath.'/'.$path.$fname;
8746: my @parts=split(/\//,$fullpath);
8747: my $count;
8748: my $filepath = $dir_root;
8749: for ($count=4;$count<=$#parts;$count++) {
8750: $filepath .= "/$parts[$count]";
8751: if ((-e $filepath)!=1) {
8752: mkdir($filepath,0770);
8753: }
8754: }
8755: my $fh;
8756: if (!open($fh,'>'.$dest)) {
8757: &Apache::lonnet::logthis('Failed to create '.$dest);
8758: $output .= '<span class="LC_error">'.
8759: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8760: '</span><br />';
8761: } else {
8762: if (!print $fh $env{'form.embedded_item_'.$i}) {
8763: &Apache::lonnet::logthis('Failed to write to '.$dest);
8764: $output .= '<span class="LC_error">'.
8765: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8766: '</span><br />';
8767: } else {
1.987 raeburn 8768: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
8769: $url.'</span>').'<br />';
8770: unless ($context eq 'testbank') {
8771: $footer .= &mt('View embedded file: [_1]',
8772: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
8773: }
8774: }
8775: close($fh);
8776: }
8777: }
8778: if ($env{'form.embedded_ref_'.$i}) {
8779: $pathchange{$i} = 1;
8780: }
8781: }
8782: if ($output) {
8783: $output = '<p>'.$output.'</p>';
8784: }
8785: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
8786: $returnflag = 'ok';
8787: if (keys(%pathchange) > 0) {
8788: if ($context eq 'portfolio') {
8789: $output .= '<p>'.&mt('or').'</p>';
8790: } elsif ($context eq 'testbank') {
1.988 raeburn 8791: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).','<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987 raeburn 8792: $returnflag = 'modify_orightml';
8793: }
8794: }
8795: return ($output.$footer,$returnflag);
8796: }
8797:
8798: sub modify_html_form {
8799: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
8800: my $end = 0;
8801: my $modifyform;
8802: if ($context eq 'upload_embedded') {
8803: return unless (ref($pathchange) eq 'HASH');
8804: if ($env{'form.number_embedded_items'}) {
8805: $end += $env{'form.number_embedded_items'};
8806: }
8807: if ($env{'form.number_pathchange_items'}) {
8808: $end += $env{'form.number_pathchange_items'};
8809: }
8810: if ($end) {
8811: for (my $i=0; $i<$end; $i++) {
8812: if ($i < $env{'form.number_embedded_items'}) {
8813: next unless($pathchange->{$i});
8814: }
8815: $modifyform .=
8816: &start_data_table_row().
8817: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
8818: 'checked="checked" /></td>'.
8819: '<td>'.$env{'form.embedded_ref_'.$i}.
8820: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
8821: &escape($env{'form.embedded_ref_'.$i}).'" />'.
8822: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
8823: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
8824: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
8825: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
8826: '<td>'.$env{'form.embedded_orig_'.$i}.
8827: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
8828: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
8829: &end_data_table_row();
8830: }
8831: }
8832: } else {
8833: $modifyform = $pathchgtable;
8834: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
8835: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
8836: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
8837: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
8838: }
8839: }
8840: if ($modifyform) {
8841: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
8842: '<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".
8843: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
8844: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
8845: '</ol></p>'."\n".'<p>'.
8846: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
8847: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
8848: &start_data_table()."\n".
8849: &start_data_table_header_row().
8850: '<th>'.&mt('Change?').'</th>'.
8851: '<th>'.&mt('Current reference').'</th>'.
8852: '<th>'.&mt('Required reference').'</th>'.
8853: &end_data_table_header_row()."\n".
8854: $modifyform.
8855: &end_data_table().'<br />'."\n".$hiddenstate.
8856: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
8857: '</form>'."\n";
8858: }
8859: return;
8860: }
8861:
8862: sub modify_html_refs {
8863: my ($context,$dirpath,$uname,$udom,$dir_root) = @_;
8864: my $container;
8865: if ($context eq 'portfolio') {
8866: $container = $env{'form.container'};
8867: } elsif ($context eq 'coursedoc') {
8868: $container = $env{'form.primaryurl'};
8869: } else {
8870: $container = $env{'form.filename'};
8871: $container =~ s{^/priv/(\Q$uname\E)/(.*)}{/home/$1/public_html/$2};
8872: }
8873: my (%allfiles,%codebase,$output,$content);
8874: my @changes = &get_env_multiple('form.namechange');
8875: return unless (@changes > 0);
8876: if (($context eq 'portfolio') || ($context eq 'coursedoc')) {
8877: return unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/});
8878: $content = &Apache::lonnet::getfile($container);
8879: return if ($content eq '-1');
8880: } else {
8881: return unless ($container =~ /^\Q$dir_root\E/);
8882: if (open(my $fh,"<$container")) {
8883: $content = join('', <$fh>);
8884: close($fh);
8885: } else {
8886: return;
8887: }
8888: }
8889: my ($count,$codebasecount) = (0,0);
8890: my $mm = new File::MMagic;
8891: my $mime_type = $mm->checktype_contents($content);
8892: if ($mime_type eq 'text/html') {
8893: my $parse_result =
8894: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
8895: \%codebase,\$content);
8896: if ($parse_result eq 'ok') {
8897: foreach my $i (@changes) {
8898: my $orig = &unescape($env{'form.embedded_orig_'.$i});
8899: my $ref = &unescape($env{'form.embedded_ref_'.$i});
8900: if ($allfiles{$ref}) {
8901: my $newname = $orig;
8902: my ($attrib_regexp,$codebase);
1.1006 raeburn 8903: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 8904: if ($attrib_regexp =~ /:/) {
8905: $attrib_regexp =~ s/\:/|/g;
8906: }
8907: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
8908: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
8909: $count += $numchg;
8910: }
8911: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 8912: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 8913: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
8914: $codebasecount ++;
8915: }
8916: }
8917: }
8918: if ($count || $codebasecount) {
8919: my $saveresult;
8920: if ($context eq 'portfolio' || $context eq 'coursedoc') {
8921: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
8922: if ($url eq $container) {
8923: my ($fname) = ($container =~ m{/([^/]+)$});
8924: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
8925: $count,'<span class="LC_filename">'.
8926: $fname.'</span>').'</p>';
8927: } else {
8928: $output = '<p class="LC_error">'.
8929: &mt('Error: update failed for: [_1].',
8930: '<span class="LC_filename">'.
8931: $container.'</span>').'</p>';
8932: }
8933: } else {
8934: if (open(my $fh,">$container")) {
8935: print $fh $content;
8936: close($fh);
8937: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
8938: $count,'<span class="LC_filename">'.
8939: $container.'</span>').'</p>';
1.661 raeburn 8940: } else {
1.987 raeburn 8941: $output = '<p class="LC_error">'.
8942: &mt('Error: could not update [_1].',
8943: '<span class="LC_filename">'.
8944: $container.'</span>').'</p>';
1.661 raeburn 8945: }
8946: }
8947: }
1.987 raeburn 8948: } else {
8949: &logthis('Failed to parse '.$container.
8950: ' to modify references: '.$parse_result);
1.661 raeburn 8951: }
8952: }
8953: return $output;
8954: }
8955:
8956: sub check_for_existing {
8957: my ($path,$fname,$element) = @_;
8958: my ($state,$msg);
8959: if (-d $path.'/'.$fname) {
8960: $state = 'exists';
8961: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8962: } elsif (-e $path.'/'.$fname) {
8963: $state = 'exists';
8964: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8965: }
8966: if ($state eq 'exists') {
8967: $msg = '<span class="LC_error">'.$msg.'</span><br />';
8968: }
8969: return ($state,$msg);
8970: }
8971:
8972: sub check_for_upload {
8973: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
8974: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 8975: my $filesize = length($env{'form.'.$element});
8976: if (!$filesize) {
8977: my $msg = '<span class="LC_error">'.
8978: &mt('Unable to upload [_1]. (size = [_2] bytes)',
8979: '<span class="LC_filename">'.$fname.'</span>',
8980: $filesize).'<br />'.
1.1007 raeburn 8981: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 8982: '</span>';
8983: return ('zero_bytes',$msg);
8984: }
8985: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 8986: my $getpropath = 1;
8987: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
8988: $getpropath);
8989: my $found_file = 0;
8990: my $locked_file = 0;
1.991 raeburn 8991: my @lockers;
8992: my $navmap;
8993: if ($env{'request.course.id'}) {
8994: $navmap = Apache::lonnavmaps::navmap->new();
8995: }
1.661 raeburn 8996: foreach my $line (@dir_list) {
1.984 raeburn 8997: my ($file_name,$rest)=split(/\&/,$line,2);
1.661 raeburn 8998: if ($file_name eq $fname){
8999: $file_name = $path.$file_name;
9000: if ($group ne '') {
9001: $file_name = $group.$file_name;
9002: }
9003: $found_file = 1;
1.991 raeburn 9004: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
9005: foreach my $lock (@lockers) {
9006: if (ref($lock) eq 'ARRAY') {
9007: my ($symb,$crsid) = @{$lock};
9008: if ($crsid eq $env{'request.course.id'}) {
9009: if (ref($navmap)) {
9010: my $res = $navmap->getBySymb($symb);
9011: foreach my $part (@{$res->parts()}) {
9012: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
9013: unless (($slot_status == $res->RESERVED) ||
9014: ($slot_status == $res->RESERVED_LOCATION)) {
9015: $locked_file = 1;
9016: }
9017: }
9018: } else {
9019: $locked_file = 1;
9020: }
9021: } else {
9022: $locked_file = 1;
9023: }
9024: }
9025: }
1.984 raeburn 9026: } else {
9027: my @info = split(/\&/,$rest);
9028: my $currsize = $info[6]/1000;
9029: if ($currsize < $filesize) {
9030: my $extra = $filesize - $currsize;
9031: if (($current_disk_usage + $extra) > $disk_quota) {
9032: my $msg = '<span class="LC_error">'.
9033: &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.',
9034: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</span>'.
9035: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
9036: $disk_quota,$current_disk_usage);
9037: return ('will_exceed_quota',$msg);
9038: }
9039: }
1.661 raeburn 9040: }
9041: }
9042: }
9043: if (($current_disk_usage + $filesize) > $disk_quota){
9044: my $msg = '<span class="LC_error">'.
9045: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
9046: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
9047: return ('will_exceed_quota',$msg);
9048: } elsif ($found_file) {
9049: if ($locked_file) {
9050: my $msg = '<span class="LC_error">';
9051: $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>');
9052: $msg .= '</span><br />';
9053: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
9054: return ('file_locked',$msg);
9055: } else {
9056: my $msg = '<span class="LC_error">';
1.984 raeburn 9057: $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 9058: $msg .= '</span>';
1.984 raeburn 9059: return ('existingfile',$msg);
1.661 raeburn 9060: }
9061: }
9062: }
9063:
1.987 raeburn 9064: sub check_for_traversal {
9065: my ($path,$url,$toplevel) = @_;
9066: my @parts=split(/\//,$path);
9067: my $cleanpath;
9068: my $fullpath = $url;
9069: for (my $i=0;$i<@parts;$i++) {
9070: next if ($parts[$i] eq '.');
9071: if ($parts[$i] eq '..') {
9072: $fullpath =~ s{([^/]+/)$}{};
9073: } else {
9074: $fullpath .= $parts[$i].'/';
9075: }
9076: }
9077: if ($fullpath =~ /^\Q$url\E(.*)$/) {
9078: $cleanpath = $1;
9079: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
9080: my $curr_toprel = $1;
9081: my @parts = split(/\//,$curr_toprel);
9082: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
9083: my @urlparts = split(/\//,$url_toprel);
9084: my $doubledots;
9085: my $startdiff = -1;
9086: for (my $i=0; $i<@urlparts; $i++) {
9087: if ($startdiff == -1) {
9088: unless ($urlparts[$i] eq $parts[$i]) {
9089: $startdiff = $i;
9090: $doubledots .= '../';
9091: }
9092: } else {
9093: $doubledots .= '../';
9094: }
9095: }
9096: if ($startdiff > -1) {
9097: $cleanpath = $doubledots;
9098: for (my $i=$startdiff; $i<@parts; $i++) {
9099: $cleanpath .= $parts[$i].'/';
9100: }
9101: }
9102: }
9103: $cleanpath =~ s{(/)$}{};
9104: return $cleanpath;
9105: }
1.31 albertel 9106:
1.41 ng 9107: =pod
1.45 matthew 9108:
1.464 albertel 9109: =back
1.41 ng 9110:
1.112 bowersj2 9111: =head1 CSV Upload/Handling functions
1.38 albertel 9112:
1.41 ng 9113: =over 4
9114:
1.648 raeburn 9115: =item * &upfile_store($r)
1.41 ng 9116:
9117: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 9118: needs $env{'form.upfile'}
1.41 ng 9119: returns $datatoken to be put into hidden field
9120:
9121: =cut
1.31 albertel 9122:
9123: sub upfile_store {
9124: my $r=shift;
1.258 albertel 9125: $env{'form.upfile'}=~s/\r/\n/gs;
9126: $env{'form.upfile'}=~s/\f/\n/gs;
9127: $env{'form.upfile'}=~s/\n+/\n/gs;
9128: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 9129:
1.258 albertel 9130: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
9131: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 9132: {
1.158 raeburn 9133: my $datafile = $r->dir_config('lonDaemons').
9134: '/tmp/'.$datatoken.'.tmp';
9135: if ( open(my $fh,">$datafile") ) {
1.258 albertel 9136: print $fh $env{'form.upfile'};
1.158 raeburn 9137: close($fh);
9138: }
1.31 albertel 9139: }
9140: return $datatoken;
9141: }
9142:
1.56 matthew 9143: =pod
9144:
1.648 raeburn 9145: =item * &load_tmp_file($r)
1.41 ng 9146:
9147: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 9148: needs $env{'form.datatoken'},
9149: sets $env{'form.upfile'} to the contents of the file
1.41 ng 9150:
9151: =cut
1.31 albertel 9152:
9153: sub load_tmp_file {
9154: my $r=shift;
9155: my @studentdata=();
9156: {
1.158 raeburn 9157: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 9158: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 9159: if ( open(my $fh,"<$studentfile") ) {
9160: @studentdata=<$fh>;
9161: close($fh);
9162: }
1.31 albertel 9163: }
1.258 albertel 9164: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 9165: }
9166:
1.56 matthew 9167: =pod
9168:
1.648 raeburn 9169: =item * &upfile_record_sep()
1.41 ng 9170:
9171: Separate uploaded file into records
9172: returns array of records,
1.258 albertel 9173: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 9174:
9175: =cut
1.31 albertel 9176:
9177: sub upfile_record_sep {
1.258 albertel 9178: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 9179: } else {
1.248 albertel 9180: my @records;
1.258 albertel 9181: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 9182: if ($line=~/^\s*$/) { next; }
9183: push(@records,$line);
9184: }
9185: return @records;
1.31 albertel 9186: }
9187: }
9188:
1.56 matthew 9189: =pod
9190:
1.648 raeburn 9191: =item * &record_sep($record)
1.41 ng 9192:
1.258 albertel 9193: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 9194:
9195: =cut
9196:
1.263 www 9197: sub takeleft {
9198: my $index=shift;
9199: return substr('0000'.$index,-4,4);
9200: }
9201:
1.31 albertel 9202: sub record_sep {
9203: my $record=shift;
9204: my %components=();
1.258 albertel 9205: if ($env{'form.upfiletype'} eq 'xml') {
9206: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 9207: my $i=0;
1.356 albertel 9208: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 9209: $field=~s/^(\"|\')//;
9210: $field=~s/(\"|\')$//;
1.263 www 9211: $components{&takeleft($i)}=$field;
1.31 albertel 9212: $i++;
9213: }
1.258 albertel 9214: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 9215: my $i=0;
1.356 albertel 9216: foreach my $field (split(/\t/,$record)) {
1.31 albertel 9217: $field=~s/^(\"|\')//;
9218: $field=~s/(\"|\')$//;
1.263 www 9219: $components{&takeleft($i)}=$field;
1.31 albertel 9220: $i++;
9221: }
9222: } else {
1.561 www 9223: my $separator=',';
1.480 banghart 9224: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 9225: $separator=';';
1.480 banghart 9226: }
1.31 albertel 9227: my $i=0;
1.561 www 9228: # the character we are looking for to indicate the end of a quote or a record
9229: my $looking_for=$separator;
9230: # do not add the characters to the fields
9231: my $ignore=0;
9232: # we just encountered a separator (or the beginning of the record)
9233: my $just_found_separator=1;
9234: # store the field we are working on here
9235: my $field='';
9236: # work our way through all characters in record
9237: foreach my $character ($record=~/(.)/g) {
9238: if ($character eq $looking_for) {
9239: if ($character ne $separator) {
9240: # Found the end of a quote, again looking for separator
9241: $looking_for=$separator;
9242: $ignore=1;
9243: } else {
9244: # Found a separator, store away what we got
9245: $components{&takeleft($i)}=$field;
9246: $i++;
9247: $just_found_separator=1;
9248: $ignore=0;
9249: $field='';
9250: }
9251: next;
9252: }
9253: # single or double quotation marks after a separator indicate beginning of a quote
9254: # we are now looking for the end of the quote and need to ignore separators
9255: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
9256: $looking_for=$character;
9257: next;
9258: }
9259: # ignore would be true after we reached the end of a quote
9260: if ($ignore) { next; }
9261: if (($just_found_separator) && ($character=~/\s/)) { next; }
9262: $field.=$character;
9263: $just_found_separator=0;
1.31 albertel 9264: }
1.561 www 9265: # catch the very last entry, since we never encountered the separator
9266: $components{&takeleft($i)}=$field;
1.31 albertel 9267: }
9268: return %components;
9269: }
9270:
1.144 matthew 9271: ######################################################
9272: ######################################################
9273:
1.56 matthew 9274: =pod
9275:
1.648 raeburn 9276: =item * &upfile_select_html()
1.41 ng 9277:
1.144 matthew 9278: Return HTML code to select a file from the users machine and specify
9279: the file type.
1.41 ng 9280:
9281: =cut
9282:
1.144 matthew 9283: ######################################################
9284: ######################################################
1.31 albertel 9285: sub upfile_select_html {
1.144 matthew 9286: my %Types = (
9287: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 9288: semisv => &mt('Semicolon separated values'),
1.144 matthew 9289: space => &mt('Space separated'),
9290: tab => &mt('Tabulator separated'),
9291: # xml => &mt('HTML/XML'),
9292: );
9293: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 9294: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 9295: foreach my $type (sort(keys(%Types))) {
9296: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
9297: }
9298: $Str .= "</select>\n";
9299: return $Str;
1.31 albertel 9300: }
9301:
1.301 albertel 9302: sub get_samples {
9303: my ($records,$toget) = @_;
9304: my @samples=({});
9305: my $got=0;
9306: foreach my $rec (@$records) {
9307: my %temp = &record_sep($rec);
9308: if (! grep(/\S/, values(%temp))) { next; }
9309: if (%temp) {
9310: $samples[$got]=\%temp;
9311: $got++;
9312: if ($got == $toget) { last; }
9313: }
9314: }
9315: return \@samples;
9316: }
9317:
1.144 matthew 9318: ######################################################
9319: ######################################################
9320:
1.56 matthew 9321: =pod
9322:
1.648 raeburn 9323: =item * &csv_print_samples($r,$records)
1.41 ng 9324:
9325: Prints a table of sample values from each column uploaded $r is an
9326: Apache Request ref, $records is an arrayref from
9327: &Apache::loncommon::upfile_record_sep
9328:
9329: =cut
9330:
1.144 matthew 9331: ######################################################
9332: ######################################################
1.31 albertel 9333: sub csv_print_samples {
9334: my ($r,$records) = @_;
1.662 bisitz 9335: my $samples = &get_samples($records,5);
1.301 albertel 9336:
1.594 raeburn 9337: $r->print(&mt('Samples').'<br />'.&start_data_table().
9338: &start_data_table_header_row());
1.356 albertel 9339: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 9340: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 9341: $r->print(&end_data_table_header_row());
1.301 albertel 9342: foreach my $hash (@$samples) {
1.594 raeburn 9343: $r->print(&start_data_table_row());
1.356 albertel 9344: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 9345: $r->print('<td>');
1.356 albertel 9346: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 9347: $r->print('</td>');
9348: }
1.594 raeburn 9349: $r->print(&end_data_table_row());
1.31 albertel 9350: }
1.594 raeburn 9351: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 9352: }
9353:
1.144 matthew 9354: ######################################################
9355: ######################################################
9356:
1.56 matthew 9357: =pod
9358:
1.648 raeburn 9359: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 9360:
9361: Prints a table to create associations between values and table columns.
1.144 matthew 9362:
1.41 ng 9363: $r is an Apache Request ref,
9364: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 9365: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 9366:
9367: =cut
9368:
1.144 matthew 9369: ######################################################
9370: ######################################################
1.31 albertel 9371: sub csv_print_select_table {
9372: my ($r,$records,$d) = @_;
1.301 albertel 9373: my $i=0;
9374: my $samples = &get_samples($records,1);
1.144 matthew 9375: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 9376: &start_data_table().&start_data_table_header_row().
1.144 matthew 9377: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 9378: '<th>'.&mt('Column').'</th>'.
9379: &end_data_table_header_row()."\n");
1.356 albertel 9380: foreach my $array_ref (@$d) {
9381: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 9382: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 9383:
1.875 bisitz 9384: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 9385: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 9386: $r->print('<option value="none"></option>');
1.356 albertel 9387: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
9388: $r->print('<option value="'.$sample.'"'.
9389: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 9390: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 9391: }
1.594 raeburn 9392: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 9393: $i++;
9394: }
1.594 raeburn 9395: $r->print(&end_data_table());
1.31 albertel 9396: $i--;
9397: return $i;
9398: }
1.56 matthew 9399:
1.144 matthew 9400: ######################################################
9401: ######################################################
9402:
1.56 matthew 9403: =pod
1.31 albertel 9404:
1.648 raeburn 9405: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 9406:
9407: Prints a table of sample values from the upload and can make associate samples to internal names.
9408:
9409: $r is an Apache Request ref,
9410: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
9411: $d is an array of 2 element arrays (internal name, displayed name)
9412:
9413: =cut
9414:
1.144 matthew 9415: ######################################################
9416: ######################################################
1.31 albertel 9417: sub csv_samples_select_table {
9418: my ($r,$records,$d) = @_;
9419: my $i=0;
1.144 matthew 9420: #
1.662 bisitz 9421: my $max_samples = 5;
9422: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 9423: $r->print(&start_data_table().
9424: &start_data_table_header_row().'<th>'.
9425: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
9426: &end_data_table_header_row());
1.301 albertel 9427:
9428: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 9429: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 9430: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 9431: foreach my $option (@$d) {
9432: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 9433: $r->print('<option value="'.$value.'"'.
1.253 albertel 9434: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 9435: $display.'</option>');
1.31 albertel 9436: }
9437: $r->print('</select></td><td>');
1.662 bisitz 9438: foreach my $line (0..($max_samples-1)) {
1.301 albertel 9439: if (defined($samples->[$line]{$key})) {
9440: $r->print($samples->[$line]{$key}."<br />\n");
9441: }
9442: }
1.594 raeburn 9443: $r->print('</td>'.&end_data_table_row());
1.31 albertel 9444: $i++;
9445: }
1.594 raeburn 9446: $r->print(&end_data_table());
1.31 albertel 9447: $i--;
9448: return($i);
1.115 matthew 9449: }
9450:
1.144 matthew 9451: ######################################################
9452: ######################################################
9453:
1.115 matthew 9454: =pod
9455:
1.648 raeburn 9456: =item * &clean_excel_name($name)
1.115 matthew 9457:
9458: Returns a replacement for $name which does not contain any illegal characters.
9459:
9460: =cut
9461:
1.144 matthew 9462: ######################################################
9463: ######################################################
1.115 matthew 9464: sub clean_excel_name {
9465: my ($name) = @_;
9466: $name =~ s/[:\*\?\/\\]//g;
9467: if (length($name) > 31) {
9468: $name = substr($name,0,31);
9469: }
9470: return $name;
1.25 albertel 9471: }
1.84 albertel 9472:
1.85 albertel 9473: =pod
9474:
1.648 raeburn 9475: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 9476:
9477: Returns either 1 or undef
9478:
9479: 1 if the part is to be hidden, undef if it is to be shown
9480:
9481: Arguments are:
9482:
9483: $id the id of the part to be checked
9484: $symb, optional the symb of the resource to check
9485: $udom, optional the domain of the user to check for
9486: $uname, optional the username of the user to check for
9487:
9488: =cut
1.84 albertel 9489:
9490: sub check_if_partid_hidden {
9491: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 9492: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 9493: $symb,$udom,$uname);
1.141 albertel 9494: my $truth=1;
9495: #if the string starts with !, then the list is the list to show not hide
9496: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 9497: my @hiddenlist=split(/,/,$hiddenparts);
9498: foreach my $checkid (@hiddenlist) {
1.141 albertel 9499: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 9500: }
1.141 albertel 9501: return !$truth;
1.84 albertel 9502: }
1.127 matthew 9503:
1.138 matthew 9504:
9505: ############################################################
9506: ############################################################
9507:
9508: =pod
9509:
1.157 matthew 9510: =back
9511:
1.138 matthew 9512: =head1 cgi-bin script and graphing routines
9513:
1.157 matthew 9514: =over 4
9515:
1.648 raeburn 9516: =item * &get_cgi_id()
1.138 matthew 9517:
9518: Inputs: none
9519:
9520: Returns an id which can be used to pass environment variables
9521: to various cgi-bin scripts. These environment variables will
9522: be removed from the users environment after a given time by
9523: the routine &Apache::lonnet::transfer_profile_to_env.
9524:
9525: =cut
9526:
9527: ############################################################
9528: ############################################################
1.152 albertel 9529: my $uniq=0;
1.136 matthew 9530: sub get_cgi_id {
1.154 albertel 9531: $uniq=($uniq+1)%100000;
1.280 albertel 9532: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 9533: }
9534:
1.127 matthew 9535: ############################################################
9536: ############################################################
9537:
9538: =pod
9539:
1.648 raeburn 9540: =item * &DrawBarGraph()
1.127 matthew 9541:
1.138 matthew 9542: Facilitates the plotting of data in a (stacked) bar graph.
9543: Puts plot definition data into the users environment in order for
9544: graph.png to plot it. Returns an <img> tag for the plot.
9545: The bars on the plot are labeled '1','2',...,'n'.
9546:
9547: Inputs:
9548:
9549: =over 4
9550:
9551: =item $Title: string, the title of the plot
9552:
9553: =item $xlabel: string, text describing the X-axis of the plot
9554:
9555: =item $ylabel: string, text describing the Y-axis of the plot
9556:
9557: =item $Max: scalar, the maximum Y value to use in the plot
9558: If $Max is < any data point, the graph will not be rendered.
9559:
1.140 matthew 9560: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 9561: they are plotted. If undefined, default values will be used.
9562:
1.178 matthew 9563: =item $labels: array ref holding the labels to use on the x-axis for the bars.
9564:
1.138 matthew 9565: =item @Values: An array of array references. Each array reference holds data
9566: to be plotted in a stacked bar chart.
9567:
1.239 matthew 9568: =item If the final element of @Values is a hash reference the key/value
9569: pairs will be added to the graph definition.
9570:
1.138 matthew 9571: =back
9572:
9573: Returns:
9574:
9575: An <img> tag which references graph.png and the appropriate identifying
9576: information for the plot.
9577:
1.127 matthew 9578: =cut
9579:
9580: ############################################################
9581: ############################################################
1.134 matthew 9582: sub DrawBarGraph {
1.178 matthew 9583: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 9584: #
9585: if (! defined($colors)) {
9586: $colors = ['#33ff00',
9587: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
9588: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
9589: ];
9590: }
1.228 matthew 9591: my $extra_settings = {};
9592: if (ref($Values[-1]) eq 'HASH') {
9593: $extra_settings = pop(@Values);
9594: }
1.127 matthew 9595: #
1.136 matthew 9596: my $identifier = &get_cgi_id();
9597: my $id = 'cgi.'.$identifier;
1.129 matthew 9598: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 9599: return '';
9600: }
1.225 matthew 9601: #
9602: my @Labels;
9603: if (defined($labels)) {
9604: @Labels = @$labels;
9605: } else {
9606: for (my $i=0;$i<@{$Values[0]};$i++) {
9607: push (@Labels,$i+1);
9608: }
9609: }
9610: #
1.129 matthew 9611: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 9612: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 9613: my %ValuesHash;
9614: my $NumSets=1;
9615: foreach my $array (@Values) {
9616: next if (! ref($array));
1.136 matthew 9617: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 9618: join(',',@$array);
1.129 matthew 9619: }
1.127 matthew 9620: #
1.136 matthew 9621: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 9622: if ($NumBars < 3) {
9623: $width = 120+$NumBars*32;
1.220 matthew 9624: $xskip = 1;
1.225 matthew 9625: $bar_width = 30;
9626: } elsif ($NumBars < 5) {
9627: $width = 120+$NumBars*20;
9628: $xskip = 1;
9629: $bar_width = 20;
1.220 matthew 9630: } elsif ($NumBars < 10) {
1.136 matthew 9631: $width = 120+$NumBars*15;
9632: $xskip = 1;
9633: $bar_width = 15;
9634: } elsif ($NumBars <= 25) {
9635: $width = 120+$NumBars*11;
9636: $xskip = 5;
9637: $bar_width = 8;
9638: } elsif ($NumBars <= 50) {
9639: $width = 120+$NumBars*8;
9640: $xskip = 5;
9641: $bar_width = 4;
9642: } else {
9643: $width = 120+$NumBars*8;
9644: $xskip = 5;
9645: $bar_width = 4;
9646: }
9647: #
1.137 matthew 9648: $Max = 1 if ($Max < 1);
9649: if ( int($Max) < $Max ) {
9650: $Max++;
9651: $Max = int($Max);
9652: }
1.127 matthew 9653: $Title = '' if (! defined($Title));
9654: $xlabel = '' if (! defined($xlabel));
9655: $ylabel = '' if (! defined($ylabel));
1.369 www 9656: $ValuesHash{$id.'.title'} = &escape($Title);
9657: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
9658: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 9659: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 9660: $ValuesHash{$id.'.NumBars'} = $NumBars;
9661: $ValuesHash{$id.'.NumSets'} = $NumSets;
9662: $ValuesHash{$id.'.PlotType'} = 'bar';
9663: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9664: $ValuesHash{$id.'.height'} = $height;
9665: $ValuesHash{$id.'.width'} = $width;
9666: $ValuesHash{$id.'.xskip'} = $xskip;
9667: $ValuesHash{$id.'.bar_width'} = $bar_width;
9668: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 9669: #
1.228 matthew 9670: # Deal with other parameters
9671: while (my ($key,$value) = each(%$extra_settings)) {
9672: $ValuesHash{$id.'.'.$key} = $value;
9673: }
9674: #
1.646 raeburn 9675: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 9676: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9677: }
9678:
9679: ############################################################
9680: ############################################################
9681:
9682: =pod
9683:
1.648 raeburn 9684: =item * &DrawXYGraph()
1.137 matthew 9685:
1.138 matthew 9686: Facilitates the plotting of data in an XY graph.
9687: Puts plot definition data into the users environment in order for
9688: graph.png to plot it. Returns an <img> tag for the plot.
9689:
9690: Inputs:
9691:
9692: =over 4
9693:
9694: =item $Title: string, the title of the plot
9695:
9696: =item $xlabel: string, text describing the X-axis of the plot
9697:
9698: =item $ylabel: string, text describing the Y-axis of the plot
9699:
9700: =item $Max: scalar, the maximum Y value to use in the plot
9701: If $Max is < any data point, the graph will not be rendered.
9702:
9703: =item $colors: Array ref containing the hex color codes for the data to be
9704: plotted in. If undefined, default values will be used.
9705:
9706: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9707:
9708: =item $Ydata: Array ref containing Array refs.
1.185 www 9709: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 9710:
9711: =item %Values: hash indicating or overriding any default values which are
9712: passed to graph.png.
9713: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9714:
9715: =back
9716:
9717: Returns:
9718:
9719: An <img> tag which references graph.png and the appropriate identifying
9720: information for the plot.
9721:
1.137 matthew 9722: =cut
9723:
9724: ############################################################
9725: ############################################################
9726: sub DrawXYGraph {
9727: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
9728: #
9729: # Create the identifier for the graph
9730: my $identifier = &get_cgi_id();
9731: my $id = 'cgi.'.$identifier;
9732: #
9733: $Title = '' if (! defined($Title));
9734: $xlabel = '' if (! defined($xlabel));
9735: $ylabel = '' if (! defined($ylabel));
9736: my %ValuesHash =
9737: (
1.369 www 9738: $id.'.title' => &escape($Title),
9739: $id.'.xlabel' => &escape($xlabel),
9740: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 9741: $id.'.y_max_value'=> $Max,
9742: $id.'.labels' => join(',',@$Xlabels),
9743: $id.'.PlotType' => 'XY',
9744: );
9745: #
9746: if (defined($colors) && ref($colors) eq 'ARRAY') {
9747: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9748: }
9749: #
9750: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
9751: return '';
9752: }
9753: my $NumSets=1;
1.138 matthew 9754: foreach my $array (@{$Ydata}){
1.137 matthew 9755: next if (! ref($array));
9756: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
9757: }
1.138 matthew 9758: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 9759: #
9760: # Deal with other parameters
9761: while (my ($key,$value) = each(%Values)) {
9762: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 9763: }
9764: #
1.646 raeburn 9765: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 9766: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9767: }
9768:
9769: ############################################################
9770: ############################################################
9771:
9772: =pod
9773:
1.648 raeburn 9774: =item * &DrawXYYGraph()
1.138 matthew 9775:
9776: Facilitates the plotting of data in an XY graph with two Y axes.
9777: Puts plot definition data into the users environment in order for
9778: graph.png to plot it. Returns an <img> tag for the plot.
9779:
9780: Inputs:
9781:
9782: =over 4
9783:
9784: =item $Title: string, the title of the plot
9785:
9786: =item $xlabel: string, text describing the X-axis of the plot
9787:
9788: =item $ylabel: string, text describing the Y-axis of the plot
9789:
9790: =item $colors: Array ref containing the hex color codes for the data to be
9791: plotted in. If undefined, default values will be used.
9792:
9793: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9794:
9795: =item $Ydata1: The first data set
9796:
9797: =item $Min1: The minimum value of the left Y-axis
9798:
9799: =item $Max1: The maximum value of the left Y-axis
9800:
9801: =item $Ydata2: The second data set
9802:
9803: =item $Min2: The minimum value of the right Y-axis
9804:
9805: =item $Max2: The maximum value of the left Y-axis
9806:
9807: =item %Values: hash indicating or overriding any default values which are
9808: passed to graph.png.
9809: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9810:
9811: =back
9812:
9813: Returns:
9814:
9815: An <img> tag which references graph.png and the appropriate identifying
9816: information for the plot.
1.136 matthew 9817:
9818: =cut
9819:
9820: ############################################################
9821: ############################################################
1.137 matthew 9822: sub DrawXYYGraph {
9823: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
9824: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 9825: #
9826: # Create the identifier for the graph
9827: my $identifier = &get_cgi_id();
9828: my $id = 'cgi.'.$identifier;
9829: #
9830: $Title = '' if (! defined($Title));
9831: $xlabel = '' if (! defined($xlabel));
9832: $ylabel = '' if (! defined($ylabel));
9833: my %ValuesHash =
9834: (
1.369 www 9835: $id.'.title' => &escape($Title),
9836: $id.'.xlabel' => &escape($xlabel),
9837: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 9838: $id.'.labels' => join(',',@$Xlabels),
9839: $id.'.PlotType' => 'XY',
9840: $id.'.NumSets' => 2,
1.137 matthew 9841: $id.'.two_axes' => 1,
9842: $id.'.y1_max_value' => $Max1,
9843: $id.'.y1_min_value' => $Min1,
9844: $id.'.y2_max_value' => $Max2,
9845: $id.'.y2_min_value' => $Min2,
1.136 matthew 9846: );
9847: #
1.137 matthew 9848: if (defined($colors) && ref($colors) eq 'ARRAY') {
9849: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9850: }
9851: #
9852: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
9853: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 9854: return '';
9855: }
9856: my $NumSets=1;
1.137 matthew 9857: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 9858: next if (! ref($array));
9859: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 9860: }
9861: #
9862: # Deal with other parameters
9863: while (my ($key,$value) = each(%Values)) {
9864: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 9865: }
9866: #
1.646 raeburn 9867: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 9868: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 9869: }
9870:
9871: ############################################################
9872: ############################################################
9873:
9874: =pod
9875:
1.157 matthew 9876: =back
9877:
1.139 matthew 9878: =head1 Statistics helper routines?
9879:
9880: Bad place for them but what the hell.
9881:
1.157 matthew 9882: =over 4
9883:
1.648 raeburn 9884: =item * &chartlink()
1.139 matthew 9885:
9886: Returns a link to the chart for a specific student.
9887:
9888: Inputs:
9889:
9890: =over 4
9891:
9892: =item $linktext: The text of the link
9893:
9894: =item $sname: The students username
9895:
9896: =item $sdomain: The students domain
9897:
9898: =back
9899:
1.157 matthew 9900: =back
9901:
1.139 matthew 9902: =cut
9903:
9904: ############################################################
9905: ############################################################
9906: sub chartlink {
9907: my ($linktext, $sname, $sdomain) = @_;
9908: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 9909: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 9910: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 9911: '">'.$linktext.'</a>';
1.153 matthew 9912: }
9913:
9914: #######################################################
9915: #######################################################
9916:
9917: =pod
9918:
9919: =head1 Course Environment Routines
1.157 matthew 9920:
9921: =over 4
1.153 matthew 9922:
1.648 raeburn 9923: =item * &restore_course_settings()
1.153 matthew 9924:
1.648 raeburn 9925: =item * &store_course_settings()
1.153 matthew 9926:
9927: Restores/Store indicated form parameters from the course environment.
9928: Will not overwrite existing values of the form parameters.
9929:
9930: Inputs:
9931: a scalar describing the data (e.g. 'chart', 'problem_analysis')
9932:
9933: a hash ref describing the data to be stored. For example:
9934:
9935: %Save_Parameters = ('Status' => 'scalar',
9936: 'chartoutputmode' => 'scalar',
9937: 'chartoutputdata' => 'scalar',
9938: 'Section' => 'array',
1.373 raeburn 9939: 'Group' => 'array',
1.153 matthew 9940: 'StudentData' => 'array',
9941: 'Maps' => 'array');
9942:
9943: Returns: both routines return nothing
9944:
1.631 raeburn 9945: =back
9946:
1.153 matthew 9947: =cut
9948:
9949: #######################################################
9950: #######################################################
9951: sub store_course_settings {
1.496 albertel 9952: return &store_settings($env{'request.course.id'},@_);
9953: }
9954:
9955: sub store_settings {
1.153 matthew 9956: # save to the environment
9957: # appenv the same items, just to be safe
1.300 albertel 9958: my $udom = $env{'user.domain'};
9959: my $uname = $env{'user.name'};
1.496 albertel 9960: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9961: my %SaveHash;
9962: my %AppHash;
9963: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 9964: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 9965: my $envname = 'environment.'.$basename;
1.258 albertel 9966: if (exists($env{'form.'.$setting})) {
1.153 matthew 9967: # Save this value away
9968: if ($type eq 'scalar' &&
1.258 albertel 9969: (! exists($env{$envname}) ||
9970: $env{$envname} ne $env{'form.'.$setting})) {
9971: $SaveHash{$basename} = $env{'form.'.$setting};
9972: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 9973: } elsif ($type eq 'array') {
9974: my $stored_form;
1.258 albertel 9975: if (ref($env{'form.'.$setting})) {
1.153 matthew 9976: $stored_form = join(',',
9977: map {
1.369 www 9978: &escape($_);
1.258 albertel 9979: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 9980: } else {
9981: $stored_form =
1.369 www 9982: &escape($env{'form.'.$setting});
1.153 matthew 9983: }
9984: # Determine if the array contents are the same.
1.258 albertel 9985: if ($stored_form ne $env{$envname}) {
1.153 matthew 9986: $SaveHash{$basename} = $stored_form;
9987: $AppHash{$envname} = $stored_form;
9988: }
9989: }
9990: }
9991: }
9992: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 9993: $udom,$uname);
1.153 matthew 9994: if ($put_result !~ /^(ok|delayed)/) {
9995: &Apache::lonnet::logthis('unable to save form parameters, '.
9996: 'got error:'.$put_result);
9997: }
9998: # Make sure these settings stick around in this session, too
1.646 raeburn 9999: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 10000: return;
10001: }
10002:
10003: sub restore_course_settings {
1.499 albertel 10004: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 10005: }
10006:
10007: sub restore_settings {
10008: my ($context,$prefix,$Settings) = @_;
1.153 matthew 10009: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 10010: next if (exists($env{'form.'.$setting}));
1.496 albertel 10011: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 10012: '.'.$setting;
1.258 albertel 10013: if (exists($env{$envname})) {
1.153 matthew 10014: if ($type eq 'scalar') {
1.258 albertel 10015: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 10016: } elsif ($type eq 'array') {
1.258 albertel 10017: $env{'form.'.$setting} = [
1.153 matthew 10018: map {
1.369 www 10019: &unescape($_);
1.258 albertel 10020: } split(',',$env{$envname})
1.153 matthew 10021: ];
10022: }
10023: }
10024: }
1.127 matthew 10025: }
10026:
1.618 raeburn 10027: #######################################################
10028: #######################################################
10029:
10030: =pod
10031:
10032: =head1 Domain E-mail Routines
10033:
10034: =over 4
10035:
1.648 raeburn 10036: =item * &build_recipient_list()
1.618 raeburn 10037:
1.884 raeburn 10038: Build recipient lists for five types of e-mail:
1.766 raeburn 10039: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884 raeburn 10040: (d) Help requests, (e) Course requests needing approval, generated by
10041: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
10042: loncoursequeueadmin.pm respectively.
1.618 raeburn 10043:
10044: Inputs:
1.619 raeburn 10045: defmail (scalar - email address of default recipient),
1.618 raeburn 10046: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 10047: defdom (domain for which to retrieve configuration settings),
10048: origmail (scalar - email address of recipient from loncapa.conf,
10049: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 10050:
1.655 raeburn 10051: Returns: comma separated list of addresses to which to send e-mail.
10052:
10053: =back
1.618 raeburn 10054:
10055: =cut
10056:
10057: ############################################################
10058: ############################################################
10059: sub build_recipient_list {
1.619 raeburn 10060: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 10061: my @recipients;
10062: my $otheremails;
10063: my %domconfig =
10064: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
10065: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 10066: if (exists($domconfig{'contacts'}{$mailing})) {
10067: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
10068: my @contacts = ('adminemail','supportemail');
10069: foreach my $item (@contacts) {
10070: if ($domconfig{'contacts'}{$mailing}{$item}) {
10071: my $addr = $domconfig{'contacts'}{$item};
10072: if (!grep(/^\Q$addr\E$/,@recipients)) {
10073: push(@recipients,$addr);
10074: }
1.619 raeburn 10075: }
1.766 raeburn 10076: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 10077: }
10078: }
1.766 raeburn 10079: } elsif ($origmail ne '') {
10080: push(@recipients,$origmail);
1.618 raeburn 10081: }
1.619 raeburn 10082: } elsif ($origmail ne '') {
10083: push(@recipients,$origmail);
1.618 raeburn 10084: }
1.688 raeburn 10085: if (defined($defmail)) {
10086: if ($defmail ne '') {
10087: push(@recipients,$defmail);
10088: }
1.618 raeburn 10089: }
10090: if ($otheremails) {
1.619 raeburn 10091: my @others;
10092: if ($otheremails =~ /,/) {
10093: @others = split(/,/,$otheremails);
1.618 raeburn 10094: } else {
1.619 raeburn 10095: push(@others,$otheremails);
10096: }
10097: foreach my $addr (@others) {
10098: if (!grep(/^\Q$addr\E$/,@recipients)) {
10099: push(@recipients,$addr);
10100: }
1.618 raeburn 10101: }
10102: }
1.619 raeburn 10103: my $recipientlist = join(',',@recipients);
1.618 raeburn 10104: return $recipientlist;
10105: }
10106:
1.127 matthew 10107: ############################################################
10108: ############################################################
1.154 albertel 10109:
1.655 raeburn 10110: =pod
10111:
10112: =head1 Course Catalog Routines
10113:
10114: =over 4
10115:
10116: =item * &gather_categories()
10117:
10118: Converts category definitions - keys of categories hash stored in
10119: coursecategories in configuration.db on the primary library server in a
10120: domain - to an array. Also generates javascript and idx hash used to
10121: generate Domain Coordinator interface for editing Course Categories.
10122:
10123: Inputs:
1.663 raeburn 10124:
1.655 raeburn 10125: categories (reference to hash of category definitions).
1.663 raeburn 10126:
1.655 raeburn 10127: cats (reference to array of arrays/hashes which encapsulates hierarchy of
10128: categories and subcategories).
1.663 raeburn 10129:
1.655 raeburn 10130: idx (reference to hash of counters used in Domain Coordinator interface for
10131: editing Course Categories).
1.663 raeburn 10132:
1.655 raeburn 10133: jsarray (reference to array of categories used to create Javascript arrays for
10134: Domain Coordinator interface for editing Course Categories).
10135:
10136: Returns: nothing
10137:
10138: Side effects: populates cats, idx and jsarray.
10139:
10140: =cut
10141:
10142: sub gather_categories {
10143: my ($categories,$cats,$idx,$jsarray) = @_;
10144: my %counters;
10145: my $num = 0;
10146: foreach my $item (keys(%{$categories})) {
10147: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
10148: if ($container eq '' && $depth == 0) {
10149: $cats->[$depth][$categories->{$item}] = $cat;
10150: } else {
10151: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
10152: }
10153: my ($escitem,$tail) = split(/:/,$item,2);
10154: if ($counters{$tail} eq '') {
10155: $counters{$tail} = $num;
10156: $num ++;
10157: }
10158: if (ref($idx) eq 'HASH') {
10159: $idx->{$item} = $counters{$tail};
10160: }
10161: if (ref($jsarray) eq 'ARRAY') {
10162: push(@{$jsarray->[$counters{$tail}]},$item);
10163: }
10164: }
10165: return;
10166: }
10167:
10168: =pod
10169:
10170: =item * &extract_categories()
10171:
10172: Used to generate breadcrumb trails for course categories.
10173:
10174: Inputs:
1.663 raeburn 10175:
1.655 raeburn 10176: categories (reference to hash of category definitions).
1.663 raeburn 10177:
1.655 raeburn 10178: cats (reference to array of arrays/hashes which encapsulates hierarchy of
10179: categories and subcategories).
1.663 raeburn 10180:
1.655 raeburn 10181: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 10182:
1.655 raeburn 10183: allitems (reference to hash - key is category key
10184: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 10185:
1.655 raeburn 10186: idx (reference to hash of counters used in Domain Coordinator interface for
10187: editing Course Categories).
1.663 raeburn 10188:
1.655 raeburn 10189: jsarray (reference to array of categories used to create Javascript arrays for
10190: Domain Coordinator interface for editing Course Categories).
10191:
1.665 raeburn 10192: subcats (reference to hash of arrays containing all subcategories within each
10193: category, -recursive)
10194:
1.655 raeburn 10195: Returns: nothing
10196:
10197: Side effects: populates trails and allitems hash references.
10198:
10199: =cut
10200:
10201: sub extract_categories {
1.665 raeburn 10202: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 10203: if (ref($categories) eq 'HASH') {
10204: &gather_categories($categories,$cats,$idx,$jsarray);
10205: if (ref($cats->[0]) eq 'ARRAY') {
10206: for (my $i=0; $i<@{$cats->[0]}; $i++) {
10207: my $name = $cats->[0][$i];
10208: my $item = &escape($name).'::0';
10209: my $trailstr;
10210: if ($name eq 'instcode') {
10211: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 10212: } elsif ($name eq 'communities') {
10213: $trailstr = &mt('Communities');
1.655 raeburn 10214: } else {
10215: $trailstr = $name;
10216: }
10217: if ($allitems->{$item} eq '') {
10218: push(@{$trails},$trailstr);
10219: $allitems->{$item} = scalar(@{$trails})-1;
10220: }
10221: my @parents = ($name);
10222: if (ref($cats->[1]{$name}) eq 'ARRAY') {
10223: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
10224: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 10225: if (ref($subcats) eq 'HASH') {
10226: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
10227: }
10228: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
10229: }
10230: } else {
10231: if (ref($subcats) eq 'HASH') {
10232: $subcats->{$item} = [];
1.655 raeburn 10233: }
10234: }
10235: }
10236: }
10237: }
10238: return;
10239: }
10240:
10241: =pod
10242:
10243: =item *&recurse_categories()
10244:
10245: Recursively used to generate breadcrumb trails for course categories.
10246:
10247: Inputs:
1.663 raeburn 10248:
1.655 raeburn 10249: cats (reference to array of arrays/hashes which encapsulates hierarchy of
10250: categories and subcategories).
1.663 raeburn 10251:
1.655 raeburn 10252: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 10253:
10254: category (current course category, for which breadcrumb trail is being generated).
10255:
10256: trails (reference to array of breadcrumb trails for each category).
10257:
1.655 raeburn 10258: allitems (reference to hash - key is category key
10259: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 10260:
1.655 raeburn 10261: parents (array containing containers directories for current category,
10262: back to top level).
10263:
10264: Returns: nothing
10265:
10266: Side effects: populates trails and allitems hash references
10267:
10268: =cut
10269:
10270: sub recurse_categories {
1.665 raeburn 10271: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 10272: my $shallower = $depth - 1;
10273: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
10274: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
10275: my $name = $cats->[$depth]{$category}[$k];
10276: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
10277: my $trailstr = join(' -> ',(@{$parents},$category));
10278: if ($allitems->{$item} eq '') {
10279: push(@{$trails},$trailstr);
10280: $allitems->{$item} = scalar(@{$trails})-1;
10281: }
10282: my $deeper = $depth+1;
10283: push(@{$parents},$category);
1.665 raeburn 10284: if (ref($subcats) eq 'HASH') {
10285: my $subcat = &escape($name).':'.$category.':'.$depth;
10286: for (my $j=@{$parents}; $j>=0; $j--) {
10287: my $higher;
10288: if ($j > 0) {
10289: $higher = &escape($parents->[$j]).':'.
10290: &escape($parents->[$j-1]).':'.$j;
10291: } else {
10292: $higher = &escape($parents->[$j]).'::'.$j;
10293: }
10294: push(@{$subcats->{$higher}},$subcat);
10295: }
10296: }
10297: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
10298: $subcats);
1.655 raeburn 10299: pop(@{$parents});
10300: }
10301: } else {
10302: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
10303: my $trailstr = join(' -> ',(@{$parents},$category));
10304: if ($allitems->{$item} eq '') {
10305: push(@{$trails},$trailstr);
10306: $allitems->{$item} = scalar(@{$trails})-1;
10307: }
10308: }
10309: return;
10310: }
10311:
1.663 raeburn 10312: =pod
10313:
10314: =item *&assign_categories_table()
10315:
10316: Create a datatable for display of hierarchical categories in a domain,
10317: with checkboxes to allow a course to be categorized.
10318:
10319: Inputs:
10320:
10321: cathash - reference to hash of categories defined for the domain (from
10322: configuration.db)
10323:
10324: currcat - scalar with an & separated list of categories assigned to a course.
10325:
1.919 raeburn 10326: type - scalar contains course type (Course or Community).
10327:
1.663 raeburn 10328: Returns: $output (markup to be displayed)
10329:
10330: =cut
10331:
10332: sub assign_categories_table {
1.919 raeburn 10333: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 10334: my $output;
10335: if (ref($cathash) eq 'HASH') {
10336: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
10337: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
10338: $maxdepth = scalar(@cats);
10339: if (@cats > 0) {
10340: my $itemcount = 0;
10341: if (ref($cats[0]) eq 'ARRAY') {
10342: my @currcategories;
10343: if ($currcat ne '') {
10344: @currcategories = split('&',$currcat);
10345: }
1.919 raeburn 10346: my $table;
1.663 raeburn 10347: for (my $i=0; $i<@{$cats[0]}; $i++) {
10348: my $parent = $cats[0][$i];
1.919 raeburn 10349: next if ($parent eq 'instcode');
10350: if ($type eq 'Community') {
10351: next unless ($parent eq 'communities');
10352: } else {
10353: next if ($parent eq 'communities');
10354: }
1.663 raeburn 10355: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
10356: my $item = &escape($parent).'::0';
10357: my $checked = '';
10358: if (@currcategories > 0) {
10359: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 10360: $checked = ' checked="checked"';
1.663 raeburn 10361: }
10362: }
1.919 raeburn 10363: my $parent_title = $parent;
10364: if ($parent eq 'communities') {
10365: $parent_title = &mt('Communities');
10366: }
10367: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
10368: '<input type="checkbox" name="usecategory" value="'.
10369: $item.'"'.$checked.' />'.$parent_title.'</span>'.
10370: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 10371: my $depth = 1;
10372: push(@path,$parent);
1.919 raeburn 10373: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 10374: pop(@path);
1.919 raeburn 10375: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 10376: $itemcount ++;
10377: }
1.919 raeburn 10378: if ($itemcount) {
10379: $output = &Apache::loncommon::start_data_table().
10380: $table.
10381: &Apache::loncommon::end_data_table();
10382: }
1.663 raeburn 10383: }
10384: }
10385: }
10386: return $output;
10387: }
10388:
10389: =pod
10390:
10391: =item *&assign_category_rows()
10392:
10393: Create a datatable row for display of nested categories in a domain,
10394: with checkboxes to allow a course to be categorized,called recursively.
10395:
10396: Inputs:
10397:
10398: itemcount - track row number for alternating colors
10399:
10400: cats - reference to array of arrays/hashes which encapsulates hierarchy of
10401: categories and subcategories.
10402:
10403: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
10404:
10405: parent - parent of current category item
10406:
10407: path - Array containing all categories back up through the hierarchy from the
10408: current category to the top level.
10409:
10410: currcategories - reference to array of current categories assigned to the course
10411:
10412: Returns: $output (markup to be displayed).
10413:
10414: =cut
10415:
10416: sub assign_category_rows {
10417: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
10418: my ($text,$name,$item,$chgstr);
10419: if (ref($cats) eq 'ARRAY') {
10420: my $maxdepth = scalar(@{$cats});
10421: if (ref($cats->[$depth]) eq 'HASH') {
10422: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
10423: my $numchildren = @{$cats->[$depth]{$parent}};
10424: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
10425: $text .= '<td><table class="LC_datatable">';
10426: for (my $j=0; $j<$numchildren; $j++) {
10427: $name = $cats->[$depth]{$parent}[$j];
10428: $item = &escape($name).':'.&escape($parent).':'.$depth;
10429: my $deeper = $depth+1;
10430: my $checked = '';
10431: if (ref($currcategories) eq 'ARRAY') {
10432: if (@{$currcategories} > 0) {
10433: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 10434: $checked = ' checked="checked"';
1.663 raeburn 10435: }
10436: }
10437: }
1.664 raeburn 10438: $text .= '<tr><td><span class="LC_nobreak"><label>'.
10439: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 10440: $item.'"'.$checked.' />'.$name.'</label></span>'.
10441: '<input type="hidden" name="catname" value="'.$name.'" />'.
10442: '</td><td>';
1.663 raeburn 10443: if (ref($path) eq 'ARRAY') {
10444: push(@{$path},$name);
10445: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
10446: pop(@{$path});
10447: }
10448: $text .= '</td></tr>';
10449: }
10450: $text .= '</table></td>';
10451: }
10452: }
10453: }
10454: return $text;
10455: }
10456:
1.655 raeburn 10457: ############################################################
10458: ############################################################
10459:
10460:
1.443 albertel 10461: sub commit_customrole {
1.664 raeburn 10462: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 10463: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 10464: ($start?', '.&mt('starting').' '.localtime($start):'').
10465: ($end?', ending '.localtime($end):'').': <b>'.
10466: &Apache::lonnet::assigncustomrole(
1.664 raeburn 10467: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 10468: '</b><br />';
10469: return $output;
10470: }
10471:
10472: sub commit_standardrole {
1.541 raeburn 10473: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
10474: my ($output,$logmsg,$linefeed);
10475: if ($context eq 'auto') {
10476: $linefeed = "\n";
10477: } else {
10478: $linefeed = "<br />\n";
10479: }
1.443 albertel 10480: if ($three eq 'st') {
1.541 raeburn 10481: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
10482: $one,$two,$sec,$context);
10483: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 10484: ($result eq 'unknown_course') || ($result eq 'refused')) {
10485: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 10486: } else {
1.541 raeburn 10487: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 10488: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 10489: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
10490: if ($context eq 'auto') {
10491: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
10492: } else {
10493: $output .= '<b>'.$result.'</b>'.$linefeed.
10494: &mt('Add to classlist').': <b>ok</b>';
10495: }
10496: $output .= $linefeed;
1.443 albertel 10497: }
10498: } else {
10499: $output = &mt('Assigning').' '.$three.' in '.$url.
10500: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 10501: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 10502: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 10503: if ($context eq 'auto') {
10504: $output .= $result.$linefeed;
10505: } else {
10506: $output .= '<b>'.$result.'</b>'.$linefeed;
10507: }
1.443 albertel 10508: }
10509: return $output;
10510: }
10511:
10512: sub commit_studentrole {
1.541 raeburn 10513: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 10514: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 10515: if ($context eq 'auto') {
10516: $linefeed = "\n";
10517: } else {
10518: $linefeed = '<br />'."\n";
10519: }
1.443 albertel 10520: if (defined($one) && defined($two)) {
10521: my $cid=$one.'_'.$two;
10522: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
10523: my $secchange = 0;
10524: my $expire_role_result;
10525: my $modify_section_result;
1.628 raeburn 10526: if ($oldsec ne '-1') {
10527: if ($oldsec ne $sec) {
1.443 albertel 10528: $secchange = 1;
1.628 raeburn 10529: my $now = time;
1.443 albertel 10530: my $uurl='/'.$cid;
10531: $uurl=~s/\_/\//g;
10532: if ($oldsec) {
10533: $uurl.='/'.$oldsec;
10534: }
1.626 raeburn 10535: $oldsecurl = $uurl;
1.628 raeburn 10536: $expire_role_result =
1.652 raeburn 10537: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 10538: if ($env{'request.course.sec'} ne '') {
10539: if ($expire_role_result eq 'refused') {
10540: my @roles = ('st');
10541: my @statuses = ('previous');
10542: my @roledoms = ($one);
10543: my $withsec = 1;
10544: my %roleshash =
10545: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
10546: \@statuses,\@roles,\@roledoms,$withsec);
10547: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
10548: my ($oldstart,$oldend) =
10549: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
10550: if ($oldend > 0 && $oldend <= $now) {
10551: $expire_role_result = 'ok';
10552: }
10553: }
10554: }
10555: }
1.443 albertel 10556: $result = $expire_role_result;
10557: }
10558: }
10559: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 10560: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 10561: if ($modify_section_result =~ /^ok/) {
10562: if ($secchange == 1) {
1.628 raeburn 10563: if ($sec eq '') {
10564: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
10565: } else {
10566: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
10567: }
1.443 albertel 10568: } elsif ($oldsec eq '-1') {
1.628 raeburn 10569: if ($sec eq '') {
10570: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
10571: } else {
10572: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
10573: }
1.443 albertel 10574: } else {
1.628 raeburn 10575: if ($sec eq '') {
10576: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
10577: } else {
10578: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
10579: }
1.443 albertel 10580: }
10581: } else {
1.628 raeburn 10582: if ($secchange) {
10583: $$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;
10584: } else {
10585: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
10586: }
1.443 albertel 10587: }
10588: $result = $modify_section_result;
10589: } elsif ($secchange == 1) {
1.628 raeburn 10590: if ($oldsec eq '') {
10591: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
10592: } else {
10593: $$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;
10594: }
1.626 raeburn 10595: if ($expire_role_result eq 'refused') {
10596: my $newsecurl = '/'.$cid;
10597: $newsecurl =~ s/\_/\//g;
10598: if ($sec ne '') {
10599: $newsecurl.='/'.$sec;
10600: }
10601: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
10602: if ($sec eq '') {
10603: $$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;
10604: } else {
10605: $$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;
10606: }
10607: }
10608: }
1.443 albertel 10609: }
10610: } else {
1.626 raeburn 10611: $$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 10612: $result = "error: incomplete course id\n";
10613: }
10614: return $result;
10615: }
10616:
10617: ############################################################
10618: ############################################################
10619:
1.566 albertel 10620: sub check_clone {
1.578 raeburn 10621: my ($args,$linefeed) = @_;
1.566 albertel 10622: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
10623: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
10624: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
10625: my $clonemsg;
10626: my $can_clone = 0;
1.944 raeburn 10627: my $lctype = lc($args->{'crstype'});
1.908 raeburn 10628: if ($lctype ne 'community') {
10629: $lctype = 'course';
10630: }
1.566 albertel 10631: if ($clonehome eq 'no_host') {
1.944 raeburn 10632: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10633: $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'});
10634: } else {
10635: $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'});
10636: }
1.566 albertel 10637: } else {
10638: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944 raeburn 10639: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10640: if ($clonedesc{'type'} ne 'Community') {
10641: $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'});
10642: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10643: }
10644: }
1.882 raeburn 10645: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
10646: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 10647: $can_clone = 1;
10648: } else {
10649: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
10650: $args->{'clonedomain'},$args->{'clonecourse'});
10651: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 10652: if (grep(/^\*$/,@cloners)) {
10653: $can_clone = 1;
10654: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
10655: $can_clone = 1;
10656: } else {
1.908 raeburn 10657: my $ccrole = 'cc';
1.944 raeburn 10658: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10659: $ccrole = 'co';
10660: }
1.578 raeburn 10661: my %roleshash =
10662: &Apache::lonnet::get_my_roles($args->{'ccuname'},
10663: $args->{'ccdomain'},
1.908 raeburn 10664: 'userroles',['active'],[$ccrole],
1.578 raeburn 10665: [$args->{'clonedomain'}]);
1.908 raeburn 10666: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942 raeburn 10667: $can_clone = 1;
10668: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
10669: $can_clone = 1;
10670: } else {
1.944 raeburn 10671: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10672: $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'});
10673: } else {
10674: $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'});
10675: }
1.578 raeburn 10676: }
1.566 albertel 10677: }
1.578 raeburn 10678: }
1.566 albertel 10679: }
10680: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10681: }
10682:
1.444 albertel 10683: sub construct_course {
1.885 raeburn 10684: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444 albertel 10685: my $outcome;
1.541 raeburn 10686: my $linefeed = '<br />'."\n";
10687: if ($context eq 'auto') {
10688: $linefeed = "\n";
10689: }
1.566 albertel 10690:
10691: #
10692: # Are we cloning?
10693: #
10694: my ($can_clone, $clonemsg, $cloneid, $clonehome);
10695: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 10696: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 10697: if ($context ne 'auto') {
1.578 raeburn 10698: if ($clonemsg ne '') {
10699: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
10700: }
1.566 albertel 10701: }
10702: $outcome .= $clonemsg.$linefeed;
10703:
10704: if (!$can_clone) {
10705: return (0,$outcome);
10706: }
10707: }
10708:
1.444 albertel 10709: #
10710: # Open course
10711: #
10712: my $crstype = lc($args->{'crstype'});
10713: my %cenv=();
10714: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
10715: $args->{'cdescr'},
10716: $args->{'curl'},
10717: $args->{'course_home'},
10718: $args->{'nonstandard'},
10719: $args->{'crscode'},
10720: $args->{'ccuname'}.':'.
10721: $args->{'ccdomain'},
1.882 raeburn 10722: $args->{'crstype'},
1.885 raeburn 10723: $cnum,$context,$category);
1.444 albertel 10724:
10725: # Note: The testing routines depend on this being output; see
10726: # Utils::Course. This needs to at least be output as a comment
10727: # if anyone ever decides to not show this, and Utils::Course::new
10728: # will need to be suitably modified.
1.541 raeburn 10729: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943 raeburn 10730: if ($$courseid =~ /^error:/) {
10731: return (0,$outcome);
10732: }
10733:
1.444 albertel 10734: #
10735: # Check if created correctly
10736: #
1.479 albertel 10737: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 10738: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 10739: if ($crsuhome eq 'no_host') {
10740: $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
10741: return (0,$outcome);
10742: }
1.541 raeburn 10743: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 10744:
1.444 albertel 10745: #
1.566 albertel 10746: # Do the cloning
10747: #
10748: if ($can_clone && $cloneid) {
10749: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
10750: if ($context ne 'auto') {
10751: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
10752: }
10753: $outcome .= $clonemsg.$linefeed;
10754: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 10755: # Copy all files
1.637 www 10756: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 10757: # Restore URL
1.566 albertel 10758: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 10759: # Restore title
1.566 albertel 10760: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 10761: # Restore creation date, creator and creation context.
10762: $cenv{'internal.created'}=$oldcenv{'internal.created'};
10763: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
10764: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 10765: # Mark as cloned
1.566 albertel 10766: $cenv{'clonedfrom'}=$cloneid;
1.638 www 10767: # Need to clone grading mode
10768: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
10769: $cenv{'grading'}=$newenv{'grading'};
10770: # Do not clone these environment entries
10771: &Apache::lonnet::del('environment',
10772: ['default_enrollment_start_date',
10773: 'default_enrollment_end_date',
10774: 'question.email',
10775: 'policy.email',
10776: 'comment.email',
10777: 'pch.users.denied',
1.725 raeburn 10778: 'plc.users.denied',
10779: 'hidefromcat',
10780: 'categories'],
1.638 www 10781: $$crsudom,$$crsunum);
1.444 albertel 10782: }
1.566 albertel 10783:
1.444 albertel 10784: #
10785: # Set environment (will override cloned, if existing)
10786: #
10787: my @sections = ();
10788: my @xlists = ();
10789: if ($args->{'crstype'}) {
10790: $cenv{'type'}=$args->{'crstype'};
10791: }
10792: if ($args->{'crsid'}) {
10793: $cenv{'courseid'}=$args->{'crsid'};
10794: }
10795: if ($args->{'crscode'}) {
10796: $cenv{'internal.coursecode'}=$args->{'crscode'};
10797: }
10798: if ($args->{'crsquota'} ne '') {
10799: $cenv{'internal.coursequota'}=$args->{'crsquota'};
10800: } else {
10801: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
10802: }
10803: if ($args->{'ccuname'}) {
10804: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
10805: ':'.$args->{'ccdomain'};
10806: } else {
10807: $cenv{'internal.courseowner'} = $args->{'curruser'};
10808: }
10809: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
10810: if ($args->{'crssections'}) {
10811: $cenv{'internal.sectionnums'} = '';
10812: if ($args->{'crssections'} =~ m/,/) {
10813: @sections = split/,/,$args->{'crssections'};
10814: } else {
10815: $sections[0] = $args->{'crssections'};
10816: }
10817: if (@sections > 0) {
10818: foreach my $item (@sections) {
10819: my ($sec,$gp) = split/:/,$item;
10820: my $class = $args->{'crscode'}.$sec;
10821: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
10822: $cenv{'internal.sectionnums'} .= $item.',';
10823: unless ($addcheck eq 'ok') {
10824: push @badclasses, $class;
10825: }
10826: }
10827: $cenv{'internal.sectionnums'} =~ s/,$//;
10828: }
10829: }
10830: # do not hide course coordinator from staff listing,
10831: # even if privileged
10832: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10833: # add crosslistings
10834: if ($args->{'crsxlist'}) {
10835: $cenv{'internal.crosslistings'}='';
10836: if ($args->{'crsxlist'} =~ m/,/) {
10837: @xlists = split/,/,$args->{'crsxlist'};
10838: } else {
10839: $xlists[0] = $args->{'crsxlist'};
10840: }
10841: if (@xlists > 0) {
10842: foreach my $item (@xlists) {
10843: my ($xl,$gp) = split/:/,$item;
10844: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
10845: $cenv{'internal.crosslistings'} .= $item.',';
10846: unless ($addcheck eq 'ok') {
10847: push @badclasses, $xl;
10848: }
10849: }
10850: $cenv{'internal.crosslistings'} =~ s/,$//;
10851: }
10852: }
10853: if ($args->{'autoadds'}) {
10854: $cenv{'internal.autoadds'}=$args->{'autoadds'};
10855: }
10856: if ($args->{'autodrops'}) {
10857: $cenv{'internal.autodrops'}=$args->{'autodrops'};
10858: }
10859: # check for notification of enrollment changes
10860: my @notified = ();
10861: if ($args->{'notify_owner'}) {
10862: if ($args->{'ccuname'} ne '') {
10863: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
10864: }
10865: }
10866: if ($args->{'notify_dc'}) {
10867: if ($uname ne '') {
1.630 raeburn 10868: push(@notified,$uname.':'.$udom);
1.444 albertel 10869: }
10870: }
10871: if (@notified > 0) {
10872: my $notifylist;
10873: if (@notified > 1) {
10874: $notifylist = join(',',@notified);
10875: } else {
10876: $notifylist = $notified[0];
10877: }
10878: $cenv{'internal.notifylist'} = $notifylist;
10879: }
10880: if (@badclasses > 0) {
10881: my %lt=&Apache::lonlocal::texthash(
10882: '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',
10883: 'dnhr' => 'does not have rights to access enrollment in these classes',
10884: 'adby' => 'as determined by the policies of your institution on access to official classlists'
10885: );
1.541 raeburn 10886: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
10887: ' ('.$lt{'adby'}.')';
10888: if ($context eq 'auto') {
10889: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 10890: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 10891: foreach my $item (@badclasses) {
10892: if ($context eq 'auto') {
10893: $outcome .= " - $item\n";
10894: } else {
10895: $outcome .= "<li>$item</li>\n";
10896: }
10897: }
10898: if ($context eq 'auto') {
10899: $outcome .= $linefeed;
10900: } else {
1.566 albertel 10901: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 10902: }
10903: }
1.444 albertel 10904: }
10905: if ($args->{'no_end_date'}) {
10906: $args->{'endaccess'} = 0;
10907: }
10908: $cenv{'internal.autostart'}=$args->{'enrollstart'};
10909: $cenv{'internal.autoend'}=$args->{'enrollend'};
10910: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
10911: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
10912: if ($args->{'showphotos'}) {
10913: $cenv{'internal.showphotos'}=$args->{'showphotos'};
10914: }
10915: $cenv{'internal.authtype'} = $args->{'authtype'};
10916: $cenv{'internal.autharg'} = $args->{'autharg'};
10917: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
10918: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 10919: 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');
10920: if ($context eq 'auto') {
10921: $outcome .= $krb_msg;
10922: } else {
1.566 albertel 10923: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 10924: }
10925: $outcome .= $linefeed;
1.444 albertel 10926: }
10927: }
10928: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
10929: if ($args->{'setpolicy'}) {
10930: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10931: }
10932: if ($args->{'setcontent'}) {
10933: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10934: }
10935: }
10936: if ($args->{'reshome'}) {
10937: $cenv{'reshome'}=$args->{'reshome'}.'/';
10938: $cenv{'reshome'}=~s/\/+$/\//;
10939: }
10940: #
10941: # course has keyed access
10942: #
10943: if ($args->{'setkeys'}) {
10944: $cenv{'keyaccess'}='yes';
10945: }
10946: # if specified, key authority is not course, but user
10947: # only active if keyaccess is yes
10948: if ($args->{'keyauth'}) {
1.487 albertel 10949: my ($user,$domain) = split(':',$args->{'keyauth'});
10950: $user = &LONCAPA::clean_username($user);
10951: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 10952: if ($user ne '' && $domain ne '') {
1.487 albertel 10953: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 10954: }
10955: }
10956:
10957: if ($args->{'disresdis'}) {
10958: $cenv{'pch.roles.denied'}='st';
10959: }
10960: if ($args->{'disablechat'}) {
10961: $cenv{'plc.roles.denied'}='st';
10962: }
10963:
10964: # Record we've not yet viewed the Course Initialization Helper for this
10965: # course
10966: $cenv{'course.helper.not.run'} = 1;
10967: #
10968: # Use new Randomseed
10969: #
10970: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
10971: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
10972: #
10973: # The encryption code and receipt prefix for this course
10974: #
10975: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
10976: $cenv{'internal.encpref'}=100+int(9*rand(99));
10977: #
10978: # By default, use standard grading
10979: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
10980:
1.541 raeburn 10981: $outcome .= $linefeed.&mt('Setting environment').': '.
10982: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10983: #
10984: # Open all assignments
10985: #
10986: if ($args->{'openall'}) {
10987: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
10988: my %storecontent = ($storeunder => time,
10989: $storeunder.'.type' => 'date_start');
10990:
10991: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 10992: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10993: }
10994: #
10995: # Set first page
10996: #
10997: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
10998: || ($cloneid)) {
1.445 albertel 10999: use LONCAPA::map;
1.444 albertel 11000: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 11001:
11002: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
11003: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
11004:
1.444 albertel 11005: $outcome .= ($fatal?$errtext:'read ok').' - ';
11006: my $title; my $url;
11007: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 11008: $title=&mt('Syllabus');
1.444 albertel 11009: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
11010: } else {
1.963 raeburn 11011: $title=&mt('Table of Contents');
1.444 albertel 11012: $url='/adm/navmaps';
11013: }
1.445 albertel 11014:
11015: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
11016: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
11017:
11018: if ($errtext) { $fatal=2; }
1.541 raeburn 11019: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 11020: }
1.566 albertel 11021:
11022: return (1,$outcome);
1.444 albertel 11023: }
11024:
11025: ############################################################
11026: ############################################################
11027:
1.953 droeschl 11028: #SD
11029: # only Community and Course, or anything else?
1.378 raeburn 11030: sub course_type {
11031: my ($cid) = @_;
11032: if (!defined($cid)) {
11033: $cid = $env{'request.course.id'};
11034: }
1.404 albertel 11035: if (defined($env{'course.'.$cid.'.type'})) {
11036: return $env{'course.'.$cid.'.type'};
1.378 raeburn 11037: } else {
11038: return 'Course';
1.377 raeburn 11039: }
11040: }
1.156 albertel 11041:
1.406 raeburn 11042: sub group_term {
11043: my $crstype = &course_type();
11044: my %names = (
11045: 'Course' => 'group',
1.865 raeburn 11046: 'Community' => 'group',
1.406 raeburn 11047: );
11048: return $names{$crstype};
11049: }
11050:
1.902 raeburn 11051: sub course_types {
11052: my @types = ('official','unofficial','community');
11053: my %typename = (
11054: official => 'Official course',
11055: unofficial => 'Unofficial course',
11056: community => 'Community',
11057: );
11058: return (\@types,\%typename);
11059: }
11060:
1.156 albertel 11061: sub icon {
11062: my ($file)=@_;
1.505 albertel 11063: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 11064: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 11065: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 11066: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
11067: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
11068: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
11069: $curfext.".gif") {
11070: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
11071: $curfext.".gif";
11072: }
11073: }
1.249 albertel 11074: return &lonhttpdurl($iconname);
1.154 albertel 11075: }
1.84 albertel 11076:
1.575 albertel 11077: sub lonhttpdurl {
1.692 www 11078: #
11079: # Had been used for "small fry" static images on separate port 8080.
11080: # Modify here if lightweight http functionality desired again.
11081: # Currently eliminated due to increasing firewall issues.
11082: #
1.575 albertel 11083: my ($url)=@_;
1.692 www 11084: return $url;
1.215 albertel 11085: }
11086:
1.213 albertel 11087: sub connection_aborted {
11088: my ($r)=@_;
11089: $r->print(" ");$r->rflush();
11090: my $c = $r->connection;
11091: return $c->aborted();
11092: }
11093:
1.221 foxr 11094: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 11095: # strings as 'strings'.
11096: sub escape_single {
1.221 foxr 11097: my ($input) = @_;
1.223 albertel 11098: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 11099: $input =~ s/\'/\\\'/g; # Esacpe the 's....
11100: return $input;
11101: }
1.223 albertel 11102:
1.222 foxr 11103: # Same as escape_single, but escape's "'s This
11104: # can be used for "strings"
11105: sub escape_double {
11106: my ($input) = @_;
11107: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
11108: $input =~ s/\"/\\\"/g; # Esacpe the "s....
11109: return $input;
11110: }
1.223 albertel 11111:
1.222 foxr 11112: # Escapes the last element of a full URL.
11113: sub escape_url {
11114: my ($url) = @_;
1.238 raeburn 11115: my @urlslices = split(/\//, $url,-1);
1.369 www 11116: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 11117: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 11118: }
1.462 albertel 11119:
1.820 raeburn 11120: sub compare_arrays {
11121: my ($arrayref1,$arrayref2) = @_;
11122: my (@difference,%count);
11123: @difference = ();
11124: %count = ();
11125: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
11126: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
11127: foreach my $element (keys(%count)) {
11128: if ($count{$element} == 1) {
11129: push(@difference,$element);
11130: }
11131: }
11132: }
11133: return @difference;
11134: }
11135:
1.817 bisitz 11136: # -------------------------------------------------------- Initialize user login
1.462 albertel 11137: sub init_user_environment {
1.463 albertel 11138: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 11139: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
11140:
11141: my $public=($username eq 'public' && $domain eq 'public');
11142:
11143: # See if old ID present, if so, remove
11144:
11145: my ($filename,$cookie,$userroles);
11146: my $now=time;
11147:
11148: if ($public) {
11149: my $max_public=100;
11150: my $oldest;
11151: my $oldest_time=0;
11152: for(my $next=1;$next<=$max_public;$next++) {
11153: if (-e $lonids."/publicuser_$next.id") {
11154: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
11155: if ($mtime<$oldest_time || !$oldest_time) {
11156: $oldest_time=$mtime;
11157: $oldest=$next;
11158: }
11159: } else {
11160: $cookie="publicuser_$next";
11161: last;
11162: }
11163: }
11164: if (!$cookie) { $cookie="publicuser_$oldest"; }
11165: } else {
1.463 albertel 11166: # if this isn't a robot, kill any existing non-robot sessions
11167: if (!$args->{'robot'}) {
11168: opendir(DIR,$lonids);
11169: while ($filename=readdir(DIR)) {
11170: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
11171: unlink($lonids.'/'.$filename);
11172: }
1.462 albertel 11173: }
1.463 albertel 11174: closedir(DIR);
1.462 albertel 11175: }
11176: # Give them a new cookie
1.463 albertel 11177: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 11178: : $now.$$.int(rand(10000)));
1.463 albertel 11179: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 11180:
11181: # Initialize roles
11182:
11183: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
11184: }
11185: # ------------------------------------ Check browser type and MathML capability
11186:
11187: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
11188: $clientunicode,$clientos) = &decode_user_agent($r);
11189:
11190: # ------------------------------------------------------------- Get environment
11191:
11192: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
11193: my ($tmp) = keys(%userenv);
11194: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
11195: } else {
11196: undef(%userenv);
11197: }
11198: if (($userenv{'interface'}) && (!$form->{'interface'})) {
11199: $form->{'interface'}=$userenv{'interface'};
11200: }
11201: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
11202:
11203: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 11204: foreach my $option ('interface','localpath','localres') {
11205: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 11206: }
11207: # --------------------------------------------------------- Write first profile
11208:
11209: {
11210: my %initial_env =
11211: ("user.name" => $username,
11212: "user.domain" => $domain,
11213: "user.home" => $authhost,
11214: "browser.type" => $clientbrowser,
11215: "browser.version" => $clientversion,
11216: "browser.mathml" => $clientmathml,
11217: "browser.unicode" => $clientunicode,
11218: "browser.os" => $clientos,
11219: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
11220: "request.course.fn" => '',
11221: "request.course.uri" => '',
11222: "request.course.sec" => '',
11223: "request.role" => 'cm',
11224: "request.role.adv" => $env{'user.adv'},
11225: "request.host" => $ENV{'REMOTE_ADDR'},);
11226:
11227: if ($form->{'localpath'}) {
11228: $initial_env{"browser.localpath"} = $form->{'localpath'};
11229: $initial_env{"browser.localres"} = $form->{'localres'};
11230: }
11231:
11232: if ($form->{'interface'}) {
11233: $form->{'interface'}=~s/\W//gs;
11234: $initial_env{"browser.interface"} = $form->{'interface'};
11235: $env{'browser.interface'}=$form->{'interface'};
11236: }
11237:
1.981 raeburn 11238: my %is_adv = ( is_adv => $env{'user.adv'} );
1.980 raeburn 11239: my %domdef = &Apache::lonnet::get_domain_defaults($domain);
11240:
1.724 raeburn 11241: foreach my $tool ('aboutme','blog','portfolio') {
11242: $userenv{'availabletools.'.$tool} =
1.980 raeburn 11243: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
11244: undef,\%userenv,\%domdef,\%is_adv);
1.724 raeburn 11245: }
11246:
1.864 raeburn 11247: foreach my $crstype ('official','unofficial','community') {
1.765 raeburn 11248: $userenv{'canrequest.'.$crstype} =
11249: &Apache::lonnet::usertools_access($username,$domain,$crstype,
1.980 raeburn 11250: 'reload','requestcourses',
11251: \%userenv,\%domdef,\%is_adv);
1.765 raeburn 11252: }
11253:
1.462 albertel 11254: $env{'user.environment'} = "$lonids/$cookie.id";
11255:
11256: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
11257: &GDBM_WRCREAT(),0640)) {
11258: &_add_to_env(\%disk_env,\%initial_env);
11259: &_add_to_env(\%disk_env,\%userenv,'environment.');
11260: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 11261: if (ref($args->{'extra_env'})) {
11262: &_add_to_env(\%disk_env,$args->{'extra_env'});
11263: }
1.462 albertel 11264: untie(%disk_env);
11265: } else {
1.705 tempelho 11266: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
11267: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 11268: return 'error: '.$!;
11269: }
11270: }
11271: $env{'request.role'}='cm';
11272: $env{'request.role.adv'}=$env{'user.adv'};
11273: $env{'browser.type'}=$clientbrowser;
11274:
11275: return $cookie;
11276:
11277: }
11278:
11279: sub _add_to_env {
11280: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 11281: if (ref($env_data) eq 'HASH') {
11282: while (my ($key,$value) = each(%$env_data)) {
11283: $idf->{$prefix.$key} = $value;
11284: $env{$prefix.$key} = $value;
11285: }
1.462 albertel 11286: }
11287: }
11288:
1.685 tempelho 11289: # --- Get the symbolic name of a problem and the url
11290: sub get_symb {
11291: my ($request,$silent) = @_;
1.726 raeburn 11292: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 11293: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
11294: if ($symb eq '') {
11295: if (!$silent) {
11296: $request->print("Unable to handle ambiguous references:$url:.");
11297: return ();
11298: }
11299: }
11300: &Apache::lonenc::check_decrypt(\$symb);
11301: return ($symb);
11302: }
11303:
11304: # --------------------------------------------------------------Get annotation
11305:
11306: sub get_annotation {
11307: my ($symb,$enc) = @_;
11308:
11309: my $key = $symb;
11310: if (!$enc) {
11311: $key =
11312: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
11313: }
11314: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
11315: return $annotation{$key};
11316: }
11317:
11318: sub clean_symb {
1.731 raeburn 11319: my ($symb,$delete_enc) = @_;
1.685 tempelho 11320:
11321: &Apache::lonenc::check_decrypt(\$symb);
11322: my $enc = $env{'request.enc'};
1.731 raeburn 11323: if ($delete_enc) {
1.730 raeburn 11324: delete($env{'request.enc'});
11325: }
1.685 tempelho 11326:
11327: return ($symb,$enc);
11328: }
1.462 albertel 11329:
1.990 raeburn 11330: sub build_release_hashes {
11331: my ($checkparms,$checkresponsetypes,$checkcrstypes,$anonsurvey,$randomizetry) = @_;
11332: return unless((ref($checkparms) eq 'HASH') && (ref($checkresponsetypes) eq 'HASH') &&
11333: (ref($checkcrstypes) eq 'HASH') && (ref($anonsurvey) eq 'HASH') &&
11334: (ref($randomizetry) eq 'HASH'));
11335: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
11336: my ($item,$name,$value) = split(/:/,$key);
11337: if ($item eq 'parameter') {
11338: if (ref($checkparms->{$name}) eq 'ARRAY') {
11339: unless(grep(/^\Q$name\E$/,@{$checkparms->{$name}})) {
11340: push(@{$checkparms->{$name}},$value);
11341: }
11342: } else {
11343: push(@{$checkparms->{$name}},$value);
11344: }
11345: } elsif ($item eq 'resourcetag') {
11346: if ($name eq 'responsetype') {
11347: $checkresponsetypes->{$value} = $Apache::lonnet::needsrelease{$key}
11348: }
11349: } elsif ($item eq 'course') {
11350: if ($name eq 'crstype') {
11351: $checkcrstypes->{$value} = $Apache::lonnet::needsrelease{$key};
11352: }
11353: }
11354: }
11355: ($anonsurvey->{major},$anonsurvey->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:anonsurvey'});
11356: ($randomizetry->{major},$randomizetry->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:randomizetry'});
11357: return;
11358: }
11359:
1.41 ng 11360: =pod
11361:
11362: =back
11363:
1.112 bowersj2 11364: =cut
1.41 ng 11365:
1.112 bowersj2 11366: 1;
11367: __END__;
1.41 ng 11368:
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