Annotation of loncom/interface/loncommon.pm, revision 1.1024
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1024 ! www 4: # $Id: loncommon.pm,v 1.1023 2011/10/24 22:02:41 www 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:
1.1017 raeburn 635: sub javascript_array_indexof {
1.1018 raeburn 636: return <<ENDJS;
1.1017 raeburn 637: <script type="text/javascript" language="JavaScript">
638: // <![CDATA[
639:
640: if (!Array.prototype.indexOf) {
641: Array.prototype.indexOf = function (searchElement /*, fromIndex */ ) {
642: "use strict";
643: if (this === void 0 || this === null) {
644: throw new TypeError();
645: }
646: var t = Object(this);
647: var len = t.length >>> 0;
648: if (len === 0) {
649: return -1;
650: }
651: var n = 0;
652: if (arguments.length > 0) {
653: n = Number(arguments[1]);
654: if (n !== n) { // shortcut for verifying if it's NaN
655: n = 0;
656: } else if (n !== 0 && n !== (1 / 0) && n !== -(1 / 0)) {
657: n = (n > 0 || -1) * Math.floor(Math.abs(n));
658: }
659: }
660: if (n >= len) {
661: return -1;
662: }
663: var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
664: for (; k < len; k++) {
665: if (k in t && t[k] === searchElement) {
666: return k;
667: }
668: }
669: return -1;
670: }
671: }
672:
673: // ]]>
674: </script>
675:
676: ENDJS
677:
678: }
679:
1.876 raeburn 680: sub userbrowser_javascript {
681: my $id_functions = &javascript_index_functions();
682: return <<"ENDUSERBRW";
683:
1.888 raeburn 684: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876 raeburn 685: var url = '/adm/pickuser?';
686: var userdom = getDomainFromSelectbox(formname,udom);
687: if (userdom != null) {
688: if (userdom != '') {
689: url += 'srchdom='+userdom+'&';
690: }
691: }
692: url += 'form=' + formname + '&unameelement='+uname+
693: '&udomelement='+udom+
694: '&ulastelement='+ulast+
695: '&ufirstelement='+ufirst+
696: '&uemailelement='+uemail+
1.881 raeburn 697: '&hideudomelement='+hideudom+
698: '&coursedom='+crsdom;
1.888 raeburn 699: if ((caller != null) && (caller != undefined)) {
700: url += '&caller='+caller;
701: }
1.876 raeburn 702: var title = 'User_Browser';
703: var options = 'scrollbars=1,resizable=1,menubar=0';
704: options += ',width=700,height=600';
705: var stdeditbrowser = open(url,title,options,'1');
706: stdeditbrowser.focus();
707: }
708:
1.888 raeburn 709: function fix_domain (formname,udom,origdom,uname) {
1.876 raeburn 710: var formid = getFormIdByName(formname);
711: if (formid > -1) {
1.888 raeburn 712: var unameid = getIndexByName(formid,uname);
1.876 raeburn 713: var domid = getIndexByName(formid,udom);
714: var hidedomid = getIndexByName(formid,origdom);
715: if (hidedomid > -1) {
716: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888 raeburn 717: var unameval = document.forms[formid].elements[unameid].value;
718: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
719: if (domid > -1) {
720: var slct = document.forms[formid].elements[domid];
721: if (slct.type == 'select-one') {
722: var i;
723: for (i=0;i<slct.length;i++) {
724: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
725: }
726: }
727: if (slct.type == 'hidden') {
728: slct.value = fixeddom;
1.876 raeburn 729: }
730: }
1.468 raeburn 731: }
732: }
733: }
1.876 raeburn 734: return;
735: }
736:
737: $id_functions
738: ENDUSERBRW
1.468 raeburn 739: }
740:
741: sub setsec_javascript {
1.905 raeburn 742: my ($sec_element,$formname,$role_element) = @_;
743: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
744: $communityrolestr);
745: if ($role_element ne '') {
746: my @allroles = ('st','ta','ep','in','ad');
747: foreach my $crstype ('Course','Community') {
748: if ($crstype eq 'Community') {
749: foreach my $role (@allroles) {
750: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
751: }
752: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
753: } else {
754: foreach my $role (@allroles) {
755: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
756: }
757: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
758: }
759: }
760: $rolestr = '"'.join('","',@allroles).'"';
761: $courserolestr = '"'.join('","',@courserolenames).'"';
762: $communityrolestr = '"'.join('","',@communityrolenames).'"';
763: }
1.468 raeburn 764: my $setsections = qq|
765: function setSect(sectionlist) {
1.629 raeburn 766: var sectionsArray = new Array();
767: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
768: sectionsArray = sectionlist.split(",");
769: }
1.468 raeburn 770: var numSections = sectionsArray.length;
771: document.$formname.$sec_element.length = 0;
772: if (numSections == 0) {
773: document.$formname.$sec_element.multiple=false;
774: document.$formname.$sec_element.size=1;
775: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
776: } else {
777: if (numSections == 1) {
778: document.$formname.$sec_element.multiple=false;
779: document.$formname.$sec_element.size=1;
780: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
781: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
782: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
783: } else {
784: for (var i=0; i<numSections; i++) {
785: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
786: }
787: document.$formname.$sec_element.multiple=true
788: if (numSections < 3) {
789: document.$formname.$sec_element.size=numSections;
790: } else {
791: document.$formname.$sec_element.size=3;
792: }
793: document.$formname.$sec_element.options[0].selected = false
794: }
795: }
1.91 www 796: }
1.905 raeburn 797:
798: function setRole(crstype) {
1.468 raeburn 799: |;
1.905 raeburn 800: if ($role_element eq '') {
801: $setsections .= ' return;
802: }
803: ';
804: } else {
805: $setsections .= qq|
806: var elementLength = document.$formname.$role_element.length;
807: var allroles = Array($rolestr);
808: var courserolenames = Array($courserolestr);
809: var communityrolenames = Array($communityrolestr);
810: if (elementLength != undefined) {
811: if (document.$formname.$role_element.options[5].value == 'cc') {
812: if (crstype == 'Course') {
813: return;
814: } else {
815: allroles[5] = 'co';
816: for (var i=0; i<6; i++) {
817: document.$formname.$role_element.options[i].value = allroles[i];
818: document.$formname.$role_element.options[i].text = communityrolenames[i];
819: }
820: }
821: } else {
822: if (crstype == 'Community') {
823: return;
824: } else {
825: allroles[5] = 'cc';
826: for (var i=0; i<6; i++) {
827: document.$formname.$role_element.options[i].value = allroles[i];
828: document.$formname.$role_element.options[i].text = courserolenames[i];
829: }
830: }
831: }
832: }
833: return;
834: }
835: |;
836: }
1.468 raeburn 837: return $setsections;
838: }
839:
1.91 www 840: sub selectcourse_link {
1.909 raeburn 841: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
842: $typeelement) = @_;
843: my $type = $selecttype;
1.871 raeburn 844: my $linktext = &mt('Select Course');
845: if ($selecttype eq 'Community') {
1.909 raeburn 846: $linktext = &mt('Select Community');
1.906 raeburn 847: } elsif ($selecttype eq 'Course/Community') {
848: $linktext = &mt('Select Course/Community');
1.909 raeburn 849: $type = '';
1.1019 raeburn 850: } elsif ($selecttype eq 'Select') {
851: $linktext = &mt('Select');
852: $type = '';
1.871 raeburn 853: }
1.787 bisitz 854: return '<span class="LC_nobreak">'
855: ."<a href='"
856: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
857: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 858: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 859: ."'>".$linktext.'</a>'
1.787 bisitz 860: .'</span>';
1.74 www 861: }
1.42 matthew 862:
1.653 raeburn 863: sub selectauthor_link {
864: my ($form,$udom)=@_;
865: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
866: &mt('Select Author').'</a>';
867: }
868:
1.876 raeburn 869: sub selectuser_link {
1.881 raeburn 870: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 871: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 872: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 873: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 874: ');">'.$linktext.'</a>';
1.876 raeburn 875: }
876:
1.273 raeburn 877: sub check_uncheck_jscript {
878: my $jscript = <<"ENDSCRT";
879: function checkAll(field) {
880: if (field.length > 0) {
881: for (i = 0; i < field.length; i++) {
882: field[i].checked = true ;
883: }
884: } else {
885: field.checked = true
886: }
887: }
888:
889: function uncheckAll(field) {
890: if (field.length > 0) {
891: for (i = 0; i < field.length; i++) {
892: field[i].checked = false ;
1.543 albertel 893: }
894: } else {
1.273 raeburn 895: field.checked = false ;
896: }
897: }
898: ENDSCRT
899: return $jscript;
900: }
901:
1.656 www 902: sub select_timezone {
1.659 raeburn 903: my ($name,$selected,$onchange,$includeempty)=@_;
904: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
905: if ($includeempty) {
906: $output .= '<option value=""';
907: if (($selected eq '') || ($selected eq 'local')) {
908: $output .= ' selected="selected" ';
909: }
910: $output .= '> </option>';
911: }
1.657 raeburn 912: my @timezones = DateTime::TimeZone->all_names;
913: foreach my $tzone (@timezones) {
914: $output.= '<option value="'.$tzone.'"';
915: if ($tzone eq $selected) {
916: $output.=' selected="selected"';
917: }
918: $output.=">$tzone</option>\n";
1.656 www 919: }
920: $output.="</select>";
921: return $output;
922: }
1.273 raeburn 923:
1.687 raeburn 924: sub select_datelocale {
925: my ($name,$selected,$onchange,$includeempty)=@_;
926: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
927: if ($includeempty) {
928: $output .= '<option value=""';
929: if ($selected eq '') {
930: $output .= ' selected="selected" ';
931: }
932: $output .= '> </option>';
933: }
934: my (@possibles,%locale_names);
935: my @locales = DateTime::Locale::Catalog::Locales;
936: foreach my $locale (@locales) {
937: if (ref($locale) eq 'HASH') {
938: my $id = $locale->{'id'};
939: if ($id ne '') {
940: my $en_terr = $locale->{'en_territory'};
941: my $native_terr = $locale->{'native_territory'};
1.695 raeburn 942: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 943: if (grep(/^en$/,@languages) || !@languages) {
944: if ($en_terr ne '') {
945: $locale_names{$id} = '('.$en_terr.')';
946: } elsif ($native_terr ne '') {
947: $locale_names{$id} = $native_terr;
948: }
949: } else {
950: if ($native_terr ne '') {
951: $locale_names{$id} = $native_terr.' ';
952: } elsif ($en_terr ne '') {
953: $locale_names{$id} = '('.$en_terr.')';
954: }
955: }
956: push (@possibles,$id);
957: }
958: }
959: }
960: foreach my $item (sort(@possibles)) {
961: $output.= '<option value="'.$item.'"';
962: if ($item eq $selected) {
963: $output.=' selected="selected"';
964: }
965: $output.=">$item";
966: if ($locale_names{$item} ne '') {
967: $output.=" $locale_names{$item}</option>\n";
968: }
969: $output.="</option>\n";
970: }
971: $output.="</select>";
972: return $output;
973: }
974:
1.792 raeburn 975: sub select_language {
976: my ($name,$selected,$includeempty) = @_;
977: my %langchoices;
978: if ($includeempty) {
979: %langchoices = ('' => 'No language preference');
980: }
981: foreach my $id (&languageids()) {
982: my $code = &supportedlanguagecode($id);
983: if ($code) {
984: $langchoices{$code} = &plainlanguagedescription($id);
985: }
986: }
1.970 raeburn 987: return &select_form($selected,$name,\%langchoices);
1.792 raeburn 988: }
989:
1.42 matthew 990: =pod
1.36 matthew 991:
1.648 raeburn 992: =item * &linked_select_forms(...)
1.36 matthew 993:
994: linked_select_forms returns a string containing a <script></script> block
995: and html for two <select> menus. The select menus will be linked in that
996: changing the value of the first menu will result in new values being placed
997: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 998: order unless a defined order is provided.
1.36 matthew 999:
1000: linked_select_forms takes the following ordered inputs:
1001:
1002: =over 4
1003:
1.112 bowersj2 1004: =item * $formname, the name of the <form> tag
1.36 matthew 1005:
1.112 bowersj2 1006: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 1007:
1.112 bowersj2 1008: =item * $firstdefault, the default value for the first menu
1.36 matthew 1009:
1.112 bowersj2 1010: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 1011:
1.112 bowersj2 1012: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 1013:
1.112 bowersj2 1014: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 1015:
1.609 raeburn 1016: =item * $menuorder, the order of values in the first menu
1017:
1.41 ng 1018: =back
1019:
1.36 matthew 1020: Below is an example of such a hash. Only the 'text', 'default', and
1021: 'select2' keys must appear as stated. keys(%menu) are the possible
1022: values for the first select menu. The text that coincides with the
1.41 ng 1023: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 1024: and text for the second menu are given in the hash pointed to by
1025: $menu{$choice1}->{'select2'}.
1026:
1.112 bowersj2 1027: my %menu = ( A1 => { text =>"Choice A1" ,
1028: default => "B3",
1029: select2 => {
1030: B1 => "Choice B1",
1031: B2 => "Choice B2",
1032: B3 => "Choice B3",
1033: B4 => "Choice B4"
1.609 raeburn 1034: },
1035: order => ['B4','B3','B1','B2'],
1.112 bowersj2 1036: },
1037: A2 => { text =>"Choice A2" ,
1038: default => "C2",
1039: select2 => {
1040: C1 => "Choice C1",
1041: C2 => "Choice C2",
1042: C3 => "Choice C3"
1.609 raeburn 1043: },
1044: order => ['C2','C1','C3'],
1.112 bowersj2 1045: },
1046: A3 => { text =>"Choice A3" ,
1047: default => "D6",
1048: select2 => {
1049: D1 => "Choice D1",
1050: D2 => "Choice D2",
1051: D3 => "Choice D3",
1052: D4 => "Choice D4",
1053: D5 => "Choice D5",
1054: D6 => "Choice D6",
1055: D7 => "Choice D7"
1.609 raeburn 1056: },
1057: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 1058: }
1059: );
1.36 matthew 1060:
1061: =cut
1062:
1063: sub linked_select_forms {
1064: my ($formname,
1065: $middletext,
1066: $firstdefault,
1067: $firstselectname,
1068: $secondselectname,
1.609 raeburn 1069: $hashref,
1070: $menuorder,
1.36 matthew 1071: ) = @_;
1072: my $second = "document.$formname.$secondselectname";
1073: my $first = "document.$formname.$firstselectname";
1074: # output the javascript to do the changing
1075: my $result = '';
1.776 bisitz 1076: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 1077: $result.="// <![CDATA[\n";
1.36 matthew 1078: $result.="var select2data = new Object();\n";
1079: $" = '","';
1080: my $debug = '';
1081: foreach my $s1 (sort(keys(%$hashref))) {
1082: $result.="select2data.d_$s1 = new Object();\n";
1083: $result.="select2data.d_$s1.def = new String('".
1084: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 1085: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 1086: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1087: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1088: @s2values = @{$hashref->{$s1}->{'order'}};
1089: }
1.36 matthew 1090: $result.="\"@s2values\");\n";
1091: $result.="select2data.d_$s1.texts = new Array(";
1092: my @s2texts;
1093: foreach my $value (@s2values) {
1094: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
1095: }
1096: $result.="\"@s2texts\");\n";
1097: }
1098: $"=' ';
1099: $result.= <<"END";
1100:
1101: function select1_changed() {
1102: // Determine new choice
1103: var newvalue = "d_" + $first.value;
1104: // update select2
1105: var values = select2data[newvalue].values;
1106: var texts = select2data[newvalue].texts;
1107: var select2def = select2data[newvalue].def;
1108: var i;
1109: // out with the old
1110: for (i = 0; i < $second.options.length; i++) {
1111: $second.options[i] = null;
1112: }
1113: // in with the nuclear
1114: for (i=0;i<values.length; i++) {
1115: $second.options[i] = new Option(values[i]);
1.143 matthew 1116: $second.options[i].value = values[i];
1.36 matthew 1117: $second.options[i].text = texts[i];
1118: if (values[i] == select2def) {
1119: $second.options[i].selected = true;
1120: }
1121: }
1122: }
1.824 bisitz 1123: // ]]>
1.36 matthew 1124: </script>
1125: END
1126: # output the initial values for the selection lists
1127: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609 raeburn 1128: my @order = sort(keys(%{$hashref}));
1129: if (ref($menuorder) eq 'ARRAY') {
1130: @order = @{$menuorder};
1131: }
1132: foreach my $value (@order) {
1.36 matthew 1133: $result.=" <option value=\"$value\" ";
1.253 albertel 1134: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1135: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1136: }
1137: $result .= "</select>\n";
1138: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1139: $result .= $middletext;
1140: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
1141: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1142:
1143: my @secondorder = sort(keys(%select2));
1144: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1145: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1146: }
1147: foreach my $value (@secondorder) {
1.36 matthew 1148: $result.=" <option value=\"$value\" ";
1.253 albertel 1149: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1150: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1151: }
1152: $result .= "</select>\n";
1153: # return $debug;
1154: return $result;
1155: } # end of sub linked_select_forms {
1156:
1.45 matthew 1157: =pod
1.44 bowersj2 1158:
1.973 raeburn 1159: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid)
1.44 bowersj2 1160:
1.112 bowersj2 1161: Returns a string corresponding to an HTML link to the given help
1162: $topic, where $topic corresponds to the name of a .tex file in
1163: /home/httpd/html/adm/help/tex, with underscores replaced by
1164: spaces.
1165:
1166: $text will optionally be linked to the same topic, allowing you to
1167: link text in addition to the graphic. If you do not want to link
1168: text, but wish to specify one of the later parameters, pass an
1169: empty string.
1170:
1171: $stayOnPage is a value that will be interpreted as a boolean. If true,
1172: the link will not open a new window. If false, the link will open
1173: a new window using Javascript. (Default is false.)
1174:
1175: $width and $height are optional numerical parameters that will
1176: override the width and height of the popped up window, which may
1.973 raeburn 1177: be useful for certain help topics with big pictures included.
1178:
1179: $imgid is the id of the img tag used for the help icon. This may be
1180: used in a javascript call to switch the image src. See
1181: lonhtmlcommon::htmlareaselectactive() for an example.
1.44 bowersj2 1182:
1183: =cut
1184:
1185: sub help_open_topic {
1.973 raeburn 1186: my ($topic, $text, $stayOnPage, $width, $height, $imgid) = @_;
1.48 bowersj2 1187: $text = "" if (not defined $text);
1.44 bowersj2 1188: $stayOnPage = 0 if (not defined $stayOnPage);
1189: $width = 350 if (not defined $width);
1190: $height = 400 if (not defined $height);
1191: my $filename = $topic;
1192: $filename =~ s/ /_/g;
1193:
1.48 bowersj2 1194: my $template = "";
1195: my $link;
1.572 banghart 1196:
1.159 www 1197: $topic=~s/\W/\_/g;
1.44 bowersj2 1198:
1.572 banghart 1199: if (!$stayOnPage) {
1.72 bowersj2 1200: $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 1201: } else {
1.48 bowersj2 1202: $link = "/adm/help/${filename}.hlp";
1203: }
1204:
1205: # Add the text
1.755 neumanie 1206: if ($text ne "") {
1.763 bisitz 1207: $template.='<span class="LC_help_open_topic">'
1208: .'<a target="_top" href="'.$link.'">'
1209: .$text.'</a>';
1.48 bowersj2 1210: }
1211:
1.763 bisitz 1212: # (Always) Add the graphic
1.179 matthew 1213: my $title = &mt('Online Help');
1.667 raeburn 1214: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973 raeburn 1215: if ($imgid ne '') {
1216: $imgid = ' id="'.$imgid.'"';
1217: }
1.763 bisitz 1218: $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
1219: .'<img src="'.$helpicon.'" border="0"'
1220: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973 raeburn 1221: .' title="'.$title.'" style="vertical-align:middle;"'.$imgid
1.763 bisitz 1222: .' /></a>';
1223: if ($text ne "") {
1224: $template.='</span>';
1225: }
1.44 bowersj2 1226: return $template;
1227:
1.106 bowersj2 1228: }
1229:
1230: # This is a quicky function for Latex cheatsheet editing, since it
1231: # appears in at least four places
1232: sub helpLatexCheatsheet {
1.732 raeburn 1233: my ($topic,$text,$not_author) = @_;
1234: my $out;
1.106 bowersj2 1235: my $addOther = '';
1.732 raeburn 1236: if ($topic) {
1.763 bisitz 1237: $addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
1238: undef, undef, 600).
1239: '</span> ';
1240: }
1241: $out = '<span>' # Start cheatsheet
1242: .$addOther
1243: .'<span>'
1244: .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
1245: undef,undef,600)
1246: .'</span> <span>'
1247: .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
1248: undef,undef,600)
1249: .'</span>';
1.732 raeburn 1250: unless ($not_author) {
1.763 bisitz 1251: $out .= ' <span>'
1252: .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
1253: undef,undef,600)
1254: .'</span>';
1.732 raeburn 1255: }
1.763 bisitz 1256: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1257: return $out;
1.172 www 1258: }
1259:
1.430 albertel 1260: sub general_help {
1261: my $helptopic='Student_Intro';
1262: if ($env{'request.role'}=~/^(ca|au)/) {
1263: $helptopic='Authoring_Intro';
1.907 raeburn 1264: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1265: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1266: } elsif ($env{'request.role'}=~/^dc/) {
1267: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1268: }
1269: return $helptopic;
1270: }
1271:
1272: sub update_help_link {
1273: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1274: my $origurl = $ENV{'REQUEST_URI'};
1275: $origurl=~s|^/~|/priv/|;
1276: my $timestamp = time;
1277: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1278: $$datum = &escape($$datum);
1279: }
1280:
1281: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1282: my $output .= <<"ENDOUTPUT";
1283: <script type="text/javascript">
1.824 bisitz 1284: // <![CDATA[
1.430 albertel 1285: banner_link = '$banner_link';
1.824 bisitz 1286: // ]]>
1.430 albertel 1287: </script>
1288: ENDOUTPUT
1289: return $output;
1290: }
1291:
1292: # now just updates the help link and generates a blue icon
1.193 raeburn 1293: sub help_open_menu {
1.430 albertel 1294: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1295: = @_;
1.949 droeschl 1296: $stayOnPage = 1;
1.430 albertel 1297: my $output;
1298: if ($component_help) {
1299: if (!$text) {
1300: $output=&help_open_topic($component_help,undef,$stayOnPage,
1301: $width,$height);
1302: } else {
1303: my $help_text;
1304: $help_text=&unescape($topic);
1305: $output='<table><tr><td>'.
1306: &help_open_topic($component_help,$help_text,$stayOnPage,
1307: $width,$height).'</td></tr></table>';
1308: }
1309: }
1310: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1311: return $output.$banner_link;
1312: }
1313:
1314: sub top_nav_help {
1315: my ($text) = @_;
1.436 albertel 1316: $text = &mt($text);
1.949 droeschl 1317: my $stay_on_page = 1;
1318:
1.572 banghart 1319: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1320: : "javascript:helpMenu('open')";
1.572 banghart 1321: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1322:
1.201 raeburn 1323: my $title = &mt('Get help');
1.436 albertel 1324:
1325: return <<"END";
1326: $banner_link
1327: <a href="$link" title="$title">$text</a>
1328: END
1329: }
1330:
1331: sub help_menu_js {
1332: my ($text) = @_;
1.949 droeschl 1333: my $stayOnPage = 1;
1.436 albertel 1334: my $width = 620;
1335: my $height = 600;
1.430 albertel 1336: my $helptopic=&general_help();
1337: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1338: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1339: my $start_page =
1340: &Apache::loncommon::start_page('Help Menu', undef,
1341: {'frameset' => 1,
1342: 'js_ready' => 1,
1343: 'add_entries' => {
1344: 'border' => '0',
1.579 raeburn 1345: 'rows' => "110,*",},});
1.331 albertel 1346: my $end_page =
1347: &Apache::loncommon::end_page({'frameset' => 1,
1348: 'js_ready' => 1,});
1349:
1.436 albertel 1350: my $template .= <<"ENDTEMPLATE";
1351: <script type="text/javascript">
1.877 bisitz 1352: // <![CDATA[
1.253 albertel 1353: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1354: var banner_link = '';
1.243 raeburn 1355: function helpMenu(target) {
1356: var caller = this;
1357: if (target == 'open') {
1358: var newWindow = null;
1359: try {
1.262 albertel 1360: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1361: }
1362: catch(error) {
1363: writeHelp(caller);
1364: return;
1365: }
1366: if (newWindow) {
1367: caller = newWindow;
1368: }
1.193 raeburn 1369: }
1.243 raeburn 1370: writeHelp(caller);
1371: return;
1372: }
1373: function writeHelp(caller) {
1.430 albertel 1374: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243 raeburn 1375: caller.document.close()
1376: caller.focus()
1.193 raeburn 1377: }
1.877 bisitz 1378: // END LON-CAPA Internal -->
1.253 albertel 1379: // ]]>
1.436 albertel 1380: </script>
1.193 raeburn 1381: ENDTEMPLATE
1382: return $template;
1383: }
1384:
1.172 www 1385: sub help_open_bug {
1386: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1387: unless ($env{'user.adv'}) { return ''; }
1.172 www 1388: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1389: $text = "" if (not defined $text);
1390: $stayOnPage=1;
1.184 albertel 1391: $width = 600 if (not defined $width);
1392: $height = 600 if (not defined $height);
1.172 www 1393:
1394: $topic=~s/\W+/\+/g;
1395: my $link='';
1396: my $template='';
1.379 albertel 1397: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1398: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1399: if (!$stayOnPage)
1400: {
1401: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1402: }
1403: else
1404: {
1405: $link = $url;
1406: }
1407: # Add the text
1408: if ($text ne "")
1409: {
1410: $template .=
1411: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1412: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1413: }
1414:
1415: # Add the graphic
1.179 matthew 1416: my $title = &mt('Report a Bug');
1.215 albertel 1417: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1418: $template .= <<"ENDTEMPLATE";
1.436 albertel 1419: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1420: ENDTEMPLATE
1421: if ($text ne '') { $template.='</td></tr></table>' };
1422: return $template;
1423:
1424: }
1425:
1426: sub help_open_faq {
1427: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1428: unless ($env{'user.adv'}) { return ''; }
1.172 www 1429: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1430: $text = "" if (not defined $text);
1431: $stayOnPage=1;
1432: $width = 350 if (not defined $width);
1433: $height = 400 if (not defined $height);
1434:
1435: $topic=~s/\W+/\+/g;
1436: my $link='';
1437: my $template='';
1438: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1439: if (!$stayOnPage)
1440: {
1441: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1442: }
1443: else
1444: {
1445: $link = $url;
1446: }
1447:
1448: # Add the text
1449: if ($text ne "")
1450: {
1451: $template .=
1.173 www 1452: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1453: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1454: }
1455:
1456: # Add the graphic
1.179 matthew 1457: my $title = &mt('View the FAQ');
1.215 albertel 1458: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1459: $template .= <<"ENDTEMPLATE";
1.436 albertel 1460: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1461: ENDTEMPLATE
1462: if ($text ne '') { $template.='</td></tr></table>' };
1463: return $template;
1464:
1.44 bowersj2 1465: }
1.37 matthew 1466:
1.180 matthew 1467: ###############################################################
1468: ###############################################################
1469:
1.45 matthew 1470: =pod
1471:
1.648 raeburn 1472: =item * &change_content_javascript():
1.256 matthew 1473:
1474: This and the next function allow you to create small sections of an
1475: otherwise static HTML page that you can update on the fly with
1476: Javascript, even in Netscape 4.
1477:
1478: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1479: must be written to the HTML page once. It will prove the Javascript
1480: function "change(name, content)". Calling the change function with the
1481: name of the section
1482: you want to update, matching the name passed to C<changable_area>, and
1483: the new content you want to put in there, will put the content into
1484: that area.
1485:
1486: B<Note>: Netscape 4 only reserves enough space for the changable area
1487: to contain room for the original contents. You need to "make space"
1488: for whatever changes you wish to make, and be B<sure> to check your
1489: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1490: it's adequate for updating a one-line status display, but little more.
1491: This script will set the space to 100% width, so you only need to
1492: worry about height in Netscape 4.
1493:
1494: Modern browsers are much less limiting, and if you can commit to the
1495: user not using Netscape 4, this feature may be used freely with
1496: pretty much any HTML.
1497:
1498: =cut
1499:
1500: sub change_content_javascript {
1501: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1502: if ($env{'browser.type'} eq 'netscape' &&
1503: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1504: return (<<NETSCAPE4);
1505: function change(name, content) {
1506: doc = document.layers[name+"___escape"].layers[0].document;
1507: doc.open();
1508: doc.write(content);
1509: doc.close();
1510: }
1511: NETSCAPE4
1512: } else {
1513: # Otherwise, we need to use semi-standards-compliant code
1514: # (technically, "innerHTML" isn't standard but the equivalent
1515: # is really scary, and every useful browser supports it
1516: return (<<DOMBASED);
1517: function change(name, content) {
1518: element = document.getElementById(name);
1519: element.innerHTML = content;
1520: }
1521: DOMBASED
1522: }
1523: }
1524:
1525: =pod
1526:
1.648 raeburn 1527: =item * &changable_area($name,$origContent):
1.256 matthew 1528:
1529: This provides a "changable area" that can be modified on the fly via
1530: the Javascript code provided in C<change_content_javascript>. $name is
1531: the name you will use to reference the area later; do not repeat the
1532: same name on a given HTML page more then once. $origContent is what
1533: the area will originally contain, which can be left blank.
1534:
1535: =cut
1536:
1537: sub changable_area {
1538: my ($name, $origContent) = @_;
1539:
1.258 albertel 1540: if ($env{'browser.type'} eq 'netscape' &&
1541: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1542: # If this is netscape 4, we need to use the Layer tag
1543: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1544: } else {
1545: return "<span id='$name'>$origContent</span>";
1546: }
1547: }
1548:
1549: =pod
1550:
1.648 raeburn 1551: =item * &viewport_geometry_js
1.590 raeburn 1552:
1553: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1554:
1555: =cut
1556:
1557:
1558: sub viewport_geometry_js {
1559: return <<"GEOMETRY";
1560: var Geometry = {};
1561: function init_geometry() {
1562: if (Geometry.init) { return };
1563: Geometry.init=1;
1564: if (window.innerHeight) {
1565: Geometry.getViewportHeight = function() { return window.innerHeight; };
1566: Geometry.getViewportWidth = function() { return window.innerWidth; };
1567: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1568: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1569: }
1570: else if (document.documentElement && document.documentElement.clientHeight) {
1571: Geometry.getViewportHeight =
1572: function() { return document.documentElement.clientHeight; };
1573: Geometry.getViewportWidth =
1574: function() { return document.documentElement.clientWidth; };
1575:
1576: Geometry.getHorizontalScroll =
1577: function() { return document.documentElement.scrollLeft; };
1578: Geometry.getVerticalScroll =
1579: function() { return document.documentElement.scrollTop; };
1580: }
1581: else if (document.body.clientHeight) {
1582: Geometry.getViewportHeight =
1583: function() { return document.body.clientHeight; };
1584: Geometry.getViewportWidth =
1585: function() { return document.body.clientWidth; };
1586: Geometry.getHorizontalScroll =
1587: function() { return document.body.scrollLeft; };
1588: Geometry.getVerticalScroll =
1589: function() { return document.body.scrollTop; };
1590: }
1591: }
1592:
1593: GEOMETRY
1594: }
1595:
1596: =pod
1597:
1.648 raeburn 1598: =item * &viewport_size_js()
1.590 raeburn 1599:
1600: 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.
1601:
1602: =cut
1603:
1604: sub viewport_size_js {
1605: my $geometry = &viewport_geometry_js();
1606: return <<"DIMS";
1607:
1608: $geometry
1609:
1610: function getViewportDims(width,height) {
1611: init_geometry();
1612: width.value = Geometry.getViewportWidth();
1613: height.value = Geometry.getViewportHeight();
1614: return;
1615: }
1616:
1617: DIMS
1618: }
1619:
1620: =pod
1621:
1.648 raeburn 1622: =item * &resize_textarea_js()
1.565 albertel 1623:
1624: emits the needed javascript to resize a textarea to be as big as possible
1625:
1626: creates a function resize_textrea that takes two IDs first should be
1627: the id of the element to resize, second should be the id of a div that
1628: surrounds everything that comes after the textarea, this routine needs
1629: to be attached to the <body> for the onload and onresize events.
1630:
1.648 raeburn 1631: =back
1.565 albertel 1632:
1633: =cut
1634:
1635: sub resize_textarea_js {
1.590 raeburn 1636: my $geometry = &viewport_geometry_js();
1.565 albertel 1637: return <<"RESIZE";
1638: <script type="text/javascript">
1.824 bisitz 1639: // <![CDATA[
1.590 raeburn 1640: $geometry
1.565 albertel 1641:
1.588 albertel 1642: function getX(element) {
1643: var x = 0;
1644: while (element) {
1645: x += element.offsetLeft;
1646: element = element.offsetParent;
1647: }
1648: return x;
1649: }
1650: function getY(element) {
1651: var y = 0;
1652: while (element) {
1653: y += element.offsetTop;
1654: element = element.offsetParent;
1655: }
1656: return y;
1657: }
1658:
1659:
1.565 albertel 1660: function resize_textarea(textarea_id,bottom_id) {
1661: init_geometry();
1662: var textarea = document.getElementById(textarea_id);
1663: //alert(textarea);
1664:
1.588 albertel 1665: var textarea_top = getY(textarea);
1.565 albertel 1666: var textarea_height = textarea.offsetHeight;
1667: var bottom = document.getElementById(bottom_id);
1.588 albertel 1668: var bottom_top = getY(bottom);
1.565 albertel 1669: var bottom_height = bottom.offsetHeight;
1670: var window_height = Geometry.getViewportHeight();
1.588 albertel 1671: var fudge = 23;
1.565 albertel 1672: var new_height = window_height-fudge-textarea_top-bottom_height;
1673: if (new_height < 300) {
1674: new_height = 300;
1675: }
1676: textarea.style.height=new_height+'px';
1677: }
1.824 bisitz 1678: // ]]>
1.565 albertel 1679: </script>
1680: RESIZE
1681:
1682: }
1683:
1684: =pod
1685:
1.256 matthew 1686: =head1 Excel and CSV file utility routines
1687:
1688: =over 4
1689:
1690: =cut
1691:
1692: ###############################################################
1693: ###############################################################
1694:
1695: =pod
1696:
1.648 raeburn 1697: =item * &csv_translate($text)
1.37 matthew 1698:
1.185 www 1699: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1700: format.
1701:
1702: =cut
1703:
1.180 matthew 1704: ###############################################################
1705: ###############################################################
1.37 matthew 1706: sub csv_translate {
1707: my $text = shift;
1708: $text =~ s/\"/\"\"/g;
1.209 albertel 1709: $text =~ s/\n/ /g;
1.37 matthew 1710: return $text;
1711: }
1.180 matthew 1712:
1713: ###############################################################
1714: ###############################################################
1715:
1716: =pod
1717:
1.648 raeburn 1718: =item * &define_excel_formats()
1.180 matthew 1719:
1720: Define some commonly used Excel cell formats.
1721:
1722: Currently supported formats:
1723:
1724: =over 4
1725:
1726: =item header
1727:
1728: =item bold
1729:
1730: =item h1
1731:
1732: =item h2
1733:
1734: =item h3
1735:
1.256 matthew 1736: =item h4
1737:
1738: =item i
1739:
1.180 matthew 1740: =item date
1741:
1742: =back
1743:
1744: Inputs: $workbook
1745:
1746: Returns: $format, a hash reference.
1747:
1748: =cut
1749:
1750: ###############################################################
1751: ###############################################################
1752: sub define_excel_formats {
1753: my ($workbook) = @_;
1754: my $format;
1755: $format->{'header'} = $workbook->add_format(bold => 1,
1756: bottom => 1,
1757: align => 'center');
1758: $format->{'bold'} = $workbook->add_format(bold=>1);
1759: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1760: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1761: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1762: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1763: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1764: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1765: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1766: return $format;
1767: }
1768:
1769: ###############################################################
1770: ###############################################################
1.113 bowersj2 1771:
1772: =pod
1773:
1.648 raeburn 1774: =item * &create_workbook()
1.255 matthew 1775:
1776: Create an Excel worksheet. If it fails, output message on the
1777: request object and return undefs.
1778:
1779: Inputs: Apache request object
1780:
1781: Returns (undef) on failure,
1782: Excel worksheet object, scalar with filename, and formats
1783: from &Apache::loncommon::define_excel_formats on success
1784:
1785: =cut
1786:
1787: ###############################################################
1788: ###############################################################
1789: sub create_workbook {
1790: my ($r) = @_;
1791: #
1792: # Create the excel spreadsheet
1793: my $filename = '/prtspool/'.
1.258 albertel 1794: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1795: time.'_'.rand(1000000000).'.xls';
1796: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1797: if (! defined($workbook)) {
1798: $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928 bisitz 1799: $r->print(
1800: '<p class="LC_error">'
1801: .&mt('Problems occurred in creating the new Excel file.')
1802: .' '.&mt('This error has been logged.')
1803: .' '.&mt('Please alert your LON-CAPA administrator.')
1804: .'</p>'
1805: );
1.255 matthew 1806: return (undef);
1807: }
1808: #
1.1014 foxr 1809: $workbook->set_tempdir(LONCAPA::tempdir());
1.255 matthew 1810: #
1811: my $format = &Apache::loncommon::define_excel_formats($workbook);
1812: return ($workbook,$filename,$format);
1813: }
1814:
1815: ###############################################################
1816: ###############################################################
1817:
1818: =pod
1819:
1.648 raeburn 1820: =item * &create_text_file()
1.113 bowersj2 1821:
1.542 raeburn 1822: Create a file to write to and eventually make available to the user.
1.256 matthew 1823: If file creation fails, outputs an error message on the request object and
1824: return undefs.
1.113 bowersj2 1825:
1.256 matthew 1826: Inputs: Apache request object, and file suffix
1.113 bowersj2 1827:
1.256 matthew 1828: Returns (undef) on failure,
1829: Filehandle and filename on success.
1.113 bowersj2 1830:
1831: =cut
1832:
1.256 matthew 1833: ###############################################################
1834: ###############################################################
1835: sub create_text_file {
1836: my ($r,$suffix) = @_;
1837: if (! defined($suffix)) { $suffix = 'txt'; };
1838: my $fh;
1839: my $filename = '/prtspool/'.
1.258 albertel 1840: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1841: time.'_'.rand(1000000000).'.'.$suffix;
1842: $fh = Apache::File->new('>/home/httpd'.$filename);
1843: if (! defined($fh)) {
1844: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 1845: $r->print(
1846: '<p class="LC_error">'
1847: .&mt('Problems occurred in creating the output file.')
1848: .' '.&mt('This error has been logged.')
1849: .' '.&mt('Please alert your LON-CAPA administrator.')
1850: .'</p>'
1851: );
1.113 bowersj2 1852: }
1.256 matthew 1853: return ($fh,$filename)
1.113 bowersj2 1854: }
1855:
1856:
1.256 matthew 1857: =pod
1.113 bowersj2 1858:
1859: =back
1860:
1861: =cut
1.37 matthew 1862:
1863: ###############################################################
1.33 matthew 1864: ## Home server <option> list generating code ##
1865: ###############################################################
1.35 matthew 1866:
1.169 www 1867: # ------------------------------------------
1868:
1869: sub domain_select {
1870: my ($name,$value,$multiple)=@_;
1871: my %domains=map {
1.514 albertel 1872: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1873: } &Apache::lonnet::all_domains();
1.169 www 1874: if ($multiple) {
1875: $domains{''}=&mt('Any domain');
1.550 albertel 1876: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1877: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1878: } else {
1.550 albertel 1879: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970 raeburn 1880: return &select_form($name,$value,\%domains);
1.169 www 1881: }
1882: }
1883:
1.282 albertel 1884: #-------------------------------------------
1885:
1886: =pod
1887:
1.519 raeburn 1888: =head1 Routines for form select boxes
1889:
1890: =over 4
1891:
1.648 raeburn 1892: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1893:
1894: Returns a string containing a <select> element int multiple mode
1895:
1896:
1897: Args:
1898: $name - name of the <select> element
1.506 raeburn 1899: $value - scalar or array ref of values that should already be selected
1.282 albertel 1900: $size - number of rows long the select element is
1.283 albertel 1901: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1902: (shown text should already have been &mt())
1.506 raeburn 1903: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1904:
1.282 albertel 1905: =cut
1906:
1907: #-------------------------------------------
1.169 www 1908: sub multiple_select_form {
1.284 albertel 1909: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1910: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1911: my $output='';
1.191 matthew 1912: if (! defined($size)) {
1913: $size = 4;
1.283 albertel 1914: if (scalar(keys(%$hash))<4) {
1915: $size = scalar(keys(%$hash));
1.191 matthew 1916: }
1917: }
1.734 bisitz 1918: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1919: my @order;
1.506 raeburn 1920: if (ref($order) eq 'ARRAY') {
1921: @order = @{$order};
1922: } else {
1923: @order = sort(keys(%$hash));
1.501 banghart 1924: }
1925: if (exists($$hash{'select_form_order'})) {
1926: @order = @{$$hash{'select_form_order'}};
1927: }
1928:
1.284 albertel 1929: foreach my $key (@order) {
1.356 albertel 1930: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1931: $output.='selected="selected" ' if ($selected{$key});
1932: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1933: }
1934: $output.="</select>\n";
1935: return $output;
1936: }
1937:
1.88 www 1938: #-------------------------------------------
1939:
1940: =pod
1941:
1.970 raeburn 1942: =item * &select_form($defdom,$name,$hashref,$onchange)
1.88 www 1943:
1944: Returns a string containing a <select name='$name' size='1'> form to
1.970 raeburn 1945: allow a user to select options from a ref to a hash containing:
1946: option_name => displayed text. An optional $onchange can include
1947: a javascript onchange item, e.g., onchange="this.form.submit();"
1948:
1.88 www 1949: See lonrights.pm for an example invocation and use.
1950:
1951: =cut
1952:
1953: #-------------------------------------------
1954: sub select_form {
1.970 raeburn 1955: my ($def,$name,$hashref,$onchange) = @_;
1956: return unless (ref($hashref) eq 'HASH');
1957: if ($onchange) {
1958: $onchange = ' onchange="'.$onchange.'"';
1959: }
1960: my $selectform = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.128 albertel 1961: my @keys;
1.970 raeburn 1962: if (exists($hashref->{'select_form_order'})) {
1963: @keys=@{$hashref->{'select_form_order'}};
1.128 albertel 1964: } else {
1.970 raeburn 1965: @keys=sort(keys(%{$hashref}));
1.128 albertel 1966: }
1.356 albertel 1967: foreach my $key (@keys) {
1968: $selectform.=
1969: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1970: ($key eq $def ? 'selected="selected" ' : '').
1.970 raeburn 1971: ">".$hashref->{$key}."</option>\n";
1.88 www 1972: }
1973: $selectform.="</select>";
1974: return $selectform;
1975: }
1976:
1.475 www 1977: # For display filters
1978:
1979: sub display_filter {
1980: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1981: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714 bisitz 1982: return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475 www 1983: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1984: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 1985: '</label></span> <span class="LC_nobreak">'.
1.475 www 1986: &mt('Filter [_1]',
1.477 www 1987: &select_form($env{'form.displayfilter'},
1988: 'displayfilter',
1.970 raeburn 1989: {'currentfolder' => 'Current folder/page',
1.477 www 1990: 'containing' => 'Containing phrase',
1.970 raeburn 1991: 'none' => 'None'})).
1.714 bisitz 1992: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475 www 1993: }
1994:
1.167 www 1995: sub gradeleveldescription {
1996: my $gradelevel=shift;
1997: my %gradelevels=(0 => 'Not specified',
1998: 1 => 'Grade 1',
1999: 2 => 'Grade 2',
2000: 3 => 'Grade 3',
2001: 4 => 'Grade 4',
2002: 5 => 'Grade 5',
2003: 6 => 'Grade 6',
2004: 7 => 'Grade 7',
2005: 8 => 'Grade 8',
2006: 9 => 'Grade 9',
2007: 10 => 'Grade 10',
2008: 11 => 'Grade 11',
2009: 12 => 'Grade 12',
2010: 13 => 'Grade 13',
2011: 14 => '100 Level',
2012: 15 => '200 Level',
2013: 16 => '300 Level',
2014: 17 => '400 Level',
2015: 18 => 'Graduate Level');
2016: return &mt($gradelevels{$gradelevel});
2017: }
2018:
1.163 www 2019: sub select_level_form {
2020: my ($deflevel,$name)=@_;
2021: unless ($deflevel) { $deflevel=0; }
1.167 www 2022: my $selectform = "<select name=\"$name\" size=\"1\">\n";
2023: for (my $i=0; $i<=18; $i++) {
2024: $selectform.="<option value=\"$i\" ".
1.253 albertel 2025: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 2026: ">".&gradeleveldescription($i)."</option>\n";
2027: }
2028: $selectform.="</select>";
2029: return $selectform;
1.163 www 2030: }
1.167 www 2031:
1.35 matthew 2032: #-------------------------------------------
2033:
1.45 matthew 2034: =pod
2035:
1.910 raeburn 2036: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35 matthew 2037:
2038: Returns a string containing a <select name='$name' size='1'> form to
2039: allow a user to select the domain to preform an operation in.
2040: See loncreateuser.pm for an example invocation and use.
2041:
1.90 www 2042: If the $includeempty flag is set, it also includes an empty choice ("no domain
2043: selected");
2044:
1.743 raeburn 2045: If the $showdomdesc flag is set, the domain name is followed by the domain description.
2046:
1.910 raeburn 2047: 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.
2048:
2049: The optional $incdoms is a reference to an array of domains which will be the only available options.
1.563 raeburn 2050:
1.35 matthew 2051: =cut
2052:
2053: #-------------------------------------------
1.34 matthew 2054: sub select_dom_form {
1.910 raeburn 2055: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.872 raeburn 2056: if ($onchange) {
1.874 raeburn 2057: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 2058: }
1.910 raeburn 2059: my @domains;
2060: if (ref($incdoms) eq 'ARRAY') {
2061: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
2062: } else {
2063: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
2064: }
1.90 www 2065: if ($includeempty) { @domains=('',@domains); }
1.743 raeburn 2066: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 2067: foreach my $dom (@domains) {
2068: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 2069: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
2070: if ($showdomdesc) {
2071: if ($dom ne '') {
2072: my $domdesc = &Apache::lonnet::domain($dom,'description');
2073: if ($domdesc ne '') {
2074: $selectdomain .= ' ('.$domdesc.')';
2075: }
2076: }
2077: }
2078: $selectdomain .= "</option>\n";
1.34 matthew 2079: }
2080: $selectdomain.="</select>";
2081: return $selectdomain;
2082: }
2083:
1.35 matthew 2084: #-------------------------------------------
2085:
1.45 matthew 2086: =pod
2087:
1.648 raeburn 2088: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 2089:
1.586 raeburn 2090: input: 4 arguments (two required, two optional) -
2091: $domain - domain of new user
2092: $name - name of form element
2093: $default - Value of 'default' causes a default item to be first
2094: option, and selected by default.
2095: $hide - Value of 'hide' causes hiding of the name of the server,
2096: if 1 server found, or default, if 0 found.
1.594 raeburn 2097: output: returns 2 items:
1.586 raeburn 2098: (a) form element which contains either:
2099: (i) <select name="$name">
2100: <option value="$hostid1">$hostid $servers{$hostid}</option>
2101: <option value="$hostid2">$hostid $servers{$hostid}</option>
2102: </select>
2103: form item if there are multiple library servers in $domain, or
2104: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2105: if there is only one library server in $domain.
2106:
2107: (b) number of library servers found.
2108:
2109: See loncreateuser.pm for example of use.
1.35 matthew 2110:
2111: =cut
2112:
2113: #-------------------------------------------
1.586 raeburn 2114: sub home_server_form_item {
2115: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2116: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2117: my $result;
2118: my $numlib = keys(%servers);
2119: if ($numlib > 1) {
2120: $result .= '<select name="'.$name.'" />'."\n";
2121: if ($default) {
1.804 bisitz 2122: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 2123: '</option>'."\n";
2124: }
2125: foreach my $hostid (sort(keys(%servers))) {
2126: $result.= '<option value="'.$hostid.'">'.
2127: $hostid.' '.$servers{$hostid}."</option>\n";
2128: }
2129: $result .= '</select>'."\n";
2130: } elsif ($numlib == 1) {
2131: my $hostid;
2132: foreach my $item (keys(%servers)) {
2133: $hostid = $item;
2134: }
2135: $result .= '<input type="hidden" name="'.$name.'" value="'.
2136: $hostid.'" />';
2137: if (!$hide) {
2138: $result .= $hostid.' '.$servers{$hostid};
2139: }
2140: $result .= "\n";
2141: } elsif ($default) {
2142: $result .= '<input type="hidden" name="'.$name.
2143: '" value="default" />';
2144: if (!$hide) {
2145: $result .= &mt('default');
2146: }
2147: $result .= "\n";
1.33 matthew 2148: }
1.586 raeburn 2149: return ($result,$numlib);
1.33 matthew 2150: }
1.112 bowersj2 2151:
2152: =pod
2153:
1.534 albertel 2154: =back
2155:
1.112 bowersj2 2156: =cut
1.87 matthew 2157:
2158: ###############################################################
1.112 bowersj2 2159: ## Decoding User Agent ##
1.87 matthew 2160: ###############################################################
2161:
2162: =pod
2163:
1.112 bowersj2 2164: =head1 Decoding the User Agent
2165:
2166: =over 4
2167:
2168: =item * &decode_user_agent()
1.87 matthew 2169:
2170: Inputs: $r
2171:
2172: Outputs:
2173:
2174: =over 4
2175:
1.112 bowersj2 2176: =item * $httpbrowser
1.87 matthew 2177:
1.112 bowersj2 2178: =item * $clientbrowser
1.87 matthew 2179:
1.112 bowersj2 2180: =item * $clientversion
1.87 matthew 2181:
1.112 bowersj2 2182: =item * $clientmathml
1.87 matthew 2183:
1.112 bowersj2 2184: =item * $clientunicode
1.87 matthew 2185:
1.112 bowersj2 2186: =item * $clientos
1.87 matthew 2187:
2188: =back
2189:
1.157 matthew 2190: =back
2191:
1.87 matthew 2192: =cut
2193:
2194: ###############################################################
2195: ###############################################################
2196: sub decode_user_agent {
1.247 albertel 2197: my ($r)=@_;
1.87 matthew 2198: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2199: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2200: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2201: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2202: my $clientbrowser='unknown';
2203: my $clientversion='0';
2204: my $clientmathml='';
2205: my $clientunicode='0';
2206: for (my $i=0;$i<=$#browsertype;$i++) {
2207: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
2208: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2209: $clientbrowser=$bname;
2210: $httpbrowser=~/$vreg/i;
2211: $clientversion=$1;
2212: $clientmathml=($clientversion>=$minv);
2213: $clientunicode=($clientversion>=$univ);
2214: }
2215: }
2216: my $clientos='unknown';
2217: if (($httpbrowser=~/linux/i) ||
2218: ($httpbrowser=~/unix/i) ||
2219: ($httpbrowser=~/ux/i) ||
2220: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2221: if (($httpbrowser=~/vax/i) ||
2222: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2223: if ($httpbrowser=~/next/i) { $clientos='next'; }
2224: if (($httpbrowser=~/mac/i) ||
2225: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
2226: if ($httpbrowser=~/win/i) { $clientos='win'; }
2227: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
2228: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
2229: $clientunicode,$clientos,);
2230: }
2231:
1.32 matthew 2232: ###############################################################
2233: ## Authentication changing form generation subroutines ##
2234: ###############################################################
2235: ##
2236: ## All of the authform_xxxxxxx subroutines take their inputs in a
2237: ## hash, and have reasonable default values.
2238: ##
2239: ## formname = the name given in the <form> tag.
1.35 matthew 2240: #-------------------------------------------
2241:
1.45 matthew 2242: =pod
2243:
1.112 bowersj2 2244: =head1 Authentication Routines
2245:
2246: =over 4
2247:
1.648 raeburn 2248: =item * &authform_xxxxxx()
1.35 matthew 2249:
2250: The authform_xxxxxx subroutines provide javascript and html forms which
2251: handle some of the conveniences required for authentication forms.
2252: This is not an optimal method, but it works.
2253:
2254: =over 4
2255:
1.112 bowersj2 2256: =item * authform_header
1.35 matthew 2257:
1.112 bowersj2 2258: =item * authform_authorwarning
1.35 matthew 2259:
1.112 bowersj2 2260: =item * authform_nochange
1.35 matthew 2261:
1.112 bowersj2 2262: =item * authform_kerberos
1.35 matthew 2263:
1.112 bowersj2 2264: =item * authform_internal
1.35 matthew 2265:
1.112 bowersj2 2266: =item * authform_filesystem
1.35 matthew 2267:
2268: =back
2269:
1.648 raeburn 2270: See loncreateuser.pm for invocation and use examples.
1.157 matthew 2271:
1.35 matthew 2272: =cut
2273:
2274: #-------------------------------------------
1.32 matthew 2275: sub authform_header{
2276: my %in = (
2277: formname => 'cu',
1.80 albertel 2278: kerb_def_dom => '',
1.32 matthew 2279: @_,
2280: );
2281: $in{'formname'} = 'document.' . $in{'formname'};
2282: my $result='';
1.80 albertel 2283:
2284: #---------------------------------------------- Code for upper case translation
2285: my $Javascript_toUpperCase;
2286: unless ($in{kerb_def_dom}) {
2287: $Javascript_toUpperCase =<<"END";
2288: switch (choice) {
2289: case 'krb': currentform.elements[choicearg].value =
2290: currentform.elements[choicearg].value.toUpperCase();
2291: break;
2292: default:
2293: }
2294: END
2295: } else {
2296: $Javascript_toUpperCase = "";
2297: }
2298:
1.165 raeburn 2299: my $radioval = "'nochange'";
1.591 raeburn 2300: if (defined($in{'curr_authtype'})) {
2301: if ($in{'curr_authtype'} ne '') {
2302: $radioval = "'".$in{'curr_authtype'}."arg'";
2303: }
1.174 matthew 2304: }
1.165 raeburn 2305: my $argfield = 'null';
1.591 raeburn 2306: if (defined($in{'mode'})) {
1.165 raeburn 2307: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2308: if (defined($in{'curr_autharg'})) {
2309: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2310: $argfield = "'$in{'curr_autharg'}'";
2311: }
2312: }
2313: }
2314: }
2315:
1.32 matthew 2316: $result.=<<"END";
2317: var current = new Object();
1.165 raeburn 2318: current.radiovalue = $radioval;
2319: current.argfield = $argfield;
1.32 matthew 2320:
2321: function changed_radio(choice,currentform) {
2322: var choicearg = choice + 'arg';
2323: // If a radio button in changed, we need to change the argfield
2324: if (current.radiovalue != choice) {
2325: current.radiovalue = choice;
2326: if (current.argfield != null) {
2327: currentform.elements[current.argfield].value = '';
2328: }
2329: if (choice == 'nochange') {
2330: current.argfield = null;
2331: } else {
2332: current.argfield = choicearg;
2333: switch(choice) {
2334: case 'krb':
2335: currentform.elements[current.argfield].value =
2336: "$in{'kerb_def_dom'}";
2337: break;
2338: default:
2339: break;
2340: }
2341: }
2342: }
2343: return;
2344: }
1.22 www 2345:
1.32 matthew 2346: function changed_text(choice,currentform) {
2347: var choicearg = choice + 'arg';
2348: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2349: $Javascript_toUpperCase
1.32 matthew 2350: // clear old field
2351: if ((current.argfield != choicearg) && (current.argfield != null)) {
2352: currentform.elements[current.argfield].value = '';
2353: }
2354: current.argfield = choicearg;
2355: }
2356: set_auth_radio_buttons(choice,currentform);
2357: return;
1.20 www 2358: }
1.32 matthew 2359:
2360: function set_auth_radio_buttons(newvalue,currentform) {
1.986 raeburn 2361: var numauthchoices = currentform.login.length;
2362: if (typeof numauthchoices == "undefined") {
2363: return;
2364: }
1.32 matthew 2365: var i=0;
1.986 raeburn 2366: while (i < numauthchoices) {
1.32 matthew 2367: if (currentform.login[i].value == newvalue) { break; }
2368: i++;
2369: }
1.986 raeburn 2370: if (i == numauthchoices) {
1.32 matthew 2371: return;
2372: }
2373: current.radiovalue = newvalue;
2374: currentform.login[i].checked = true;
2375: return;
2376: }
2377: END
2378: return $result;
2379: }
2380:
2381: sub authform_authorwarning{
2382: my $result='';
1.144 matthew 2383: $result='<i>'.
2384: &mt('As a general rule, only authors or co-authors should be '.
2385: 'filesystem authenticated '.
2386: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2387: return $result;
2388: }
2389:
2390: sub authform_nochange{
2391: my %in = (
2392: formname => 'document.cu',
2393: kerb_def_dom => 'MSU.EDU',
2394: @_,
2395: );
1.586 raeburn 2396: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2397: my $result;
2398: if (keys(%can_assign) == 0) {
2399: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2400: } else {
2401: $result = '<label>'.&mt('[_1] Do not change login data',
2402: '<input type="radio" name="login" value="nochange" '.
2403: 'checked="checked" onclick="'.
1.281 albertel 2404: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2405: '</label>';
1.586 raeburn 2406: }
1.32 matthew 2407: return $result;
2408: }
2409:
1.591 raeburn 2410: sub authform_kerberos {
1.32 matthew 2411: my %in = (
2412: formname => 'document.cu',
2413: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2414: kerb_def_auth => 'krb4',
1.32 matthew 2415: @_,
2416: );
1.586 raeburn 2417: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2418: $autharg,$jscall);
2419: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2420: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2421: $check5 = ' checked="checked"';
1.80 albertel 2422: } else {
1.772 bisitz 2423: $check4 = ' checked="checked"';
1.80 albertel 2424: }
1.165 raeburn 2425: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2426: if (defined($in{'curr_authtype'})) {
2427: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2428: $krbcheck = ' checked="checked"';
1.623 raeburn 2429: if (defined($in{'mode'})) {
2430: if ($in{'mode'} eq 'modifyuser') {
2431: $krbcheck = '';
2432: }
2433: }
1.591 raeburn 2434: if (defined($in{'curr_kerb_ver'})) {
2435: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2436: $check5 = ' checked="checked"';
1.591 raeburn 2437: $check4 = '';
2438: } else {
1.772 bisitz 2439: $check4 = ' checked="checked"';
1.591 raeburn 2440: $check5 = '';
2441: }
1.586 raeburn 2442: }
1.591 raeburn 2443: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2444: $krbarg = $in{'curr_autharg'};
2445: }
1.586 raeburn 2446: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2447: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2448: $result =
2449: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2450: $in{'curr_autharg'},$krbver);
2451: } else {
2452: $result =
2453: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2454: }
2455: return $result;
2456: }
2457: }
2458: } else {
2459: if ($authnum == 1) {
1.784 bisitz 2460: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2461: }
2462: }
1.586 raeburn 2463: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2464: return;
1.587 raeburn 2465: } elsif ($authtype eq '') {
1.591 raeburn 2466: if (defined($in{'mode'})) {
1.587 raeburn 2467: if ($in{'mode'} eq 'modifycourse') {
2468: if ($authnum == 1) {
1.784 bisitz 2469: $authtype = '<input type="hidden" name="login" value="krb" />';
1.587 raeburn 2470: }
2471: }
2472: }
1.586 raeburn 2473: }
2474: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2475: if ($authtype eq '') {
2476: $authtype = '<input type="radio" name="login" value="krb" '.
2477: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2478: $krbcheck.' />';
2479: }
2480: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2481: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2482: $in{'curr_authtype'} eq 'krb5') ||
2483: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2484: $in{'curr_authtype'} eq 'krb4')) {
2485: $result .= &mt
1.144 matthew 2486: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2487: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2488: '<label>'.$authtype,
1.281 albertel 2489: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2490: 'value="'.$krbarg.'" '.
1.144 matthew 2491: 'onchange="'.$jscall.'" />',
1.281 albertel 2492: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2493: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2494: '</label>');
1.586 raeburn 2495: } elsif ($can_assign{'krb4'}) {
2496: $result .= &mt
2497: ('[_1] Kerberos authenticated with domain [_2] '.
2498: '[_3] Version 4 [_4]',
2499: '<label>'.$authtype,
2500: '</label><input type="text" size="10" name="krbarg" '.
2501: 'value="'.$krbarg.'" '.
2502: 'onchange="'.$jscall.'" />',
2503: '<label><input type="hidden" name="krbver" value="4" />',
2504: '</label>');
2505: } elsif ($can_assign{'krb5'}) {
2506: $result .= &mt
2507: ('[_1] Kerberos authenticated with domain [_2] '.
2508: '[_3] Version 5 [_4]',
2509: '<label>'.$authtype,
2510: '</label><input type="text" size="10" name="krbarg" '.
2511: 'value="'.$krbarg.'" '.
2512: 'onchange="'.$jscall.'" />',
2513: '<label><input type="hidden" name="krbver" value="5" />',
2514: '</label>');
2515: }
1.32 matthew 2516: return $result;
2517: }
2518:
2519: sub authform_internal{
1.586 raeburn 2520: my %in = (
1.32 matthew 2521: formname => 'document.cu',
2522: kerb_def_dom => 'MSU.EDU',
2523: @_,
2524: );
1.586 raeburn 2525: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2526: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2527: if (defined($in{'curr_authtype'})) {
2528: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2529: if ($can_assign{'int'}) {
1.772 bisitz 2530: $intcheck = 'checked="checked" ';
1.623 raeburn 2531: if (defined($in{'mode'})) {
2532: if ($in{'mode'} eq 'modifyuser') {
2533: $intcheck = '';
2534: }
2535: }
1.591 raeburn 2536: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2537: $intarg = $in{'curr_autharg'};
2538: }
2539: } else {
2540: $result = &mt('Currently internally authenticated.');
2541: return $result;
1.165 raeburn 2542: }
2543: }
1.586 raeburn 2544: } else {
2545: if ($authnum == 1) {
1.784 bisitz 2546: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 2547: }
2548: }
2549: if (!$can_assign{'int'}) {
2550: return;
1.587 raeburn 2551: } elsif ($authtype eq '') {
1.591 raeburn 2552: if (defined($in{'mode'})) {
1.587 raeburn 2553: if ($in{'mode'} eq 'modifycourse') {
2554: if ($authnum == 1) {
1.784 bisitz 2555: $authtype = '<input type="hidden" name="login" value="int" />';
1.587 raeburn 2556: }
2557: }
2558: }
1.165 raeburn 2559: }
1.586 raeburn 2560: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2561: if ($authtype eq '') {
2562: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2563: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2564: }
1.605 bisitz 2565: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2566: $intarg.'" onchange="'.$jscall.'" />';
2567: $result = &mt
1.144 matthew 2568: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2569: '<label>'.$authtype,'</label>'.$autharg);
1.824 bisitz 2570: $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 2571: return $result;
2572: }
2573:
2574: sub authform_local{
2575: my %in = (
2576: formname => 'document.cu',
2577: kerb_def_dom => 'MSU.EDU',
2578: @_,
2579: );
1.586 raeburn 2580: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2581: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2582: if (defined($in{'curr_authtype'})) {
2583: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2584: if ($can_assign{'loc'}) {
1.772 bisitz 2585: $loccheck = 'checked="checked" ';
1.623 raeburn 2586: if (defined($in{'mode'})) {
2587: if ($in{'mode'} eq 'modifyuser') {
2588: $loccheck = '';
2589: }
2590: }
1.591 raeburn 2591: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2592: $locarg = $in{'curr_autharg'};
2593: }
2594: } else {
2595: $result = &mt('Currently using local (institutional) authentication.');
2596: return $result;
1.165 raeburn 2597: }
2598: }
1.586 raeburn 2599: } else {
2600: if ($authnum == 1) {
1.784 bisitz 2601: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 2602: }
2603: }
2604: if (!$can_assign{'loc'}) {
2605: return;
1.587 raeburn 2606: } elsif ($authtype eq '') {
1.591 raeburn 2607: if (defined($in{'mode'})) {
1.587 raeburn 2608: if ($in{'mode'} eq 'modifycourse') {
2609: if ($authnum == 1) {
1.784 bisitz 2610: $authtype = '<input type="hidden" name="login" value="loc" />';
1.587 raeburn 2611: }
2612: }
2613: }
1.165 raeburn 2614: }
1.586 raeburn 2615: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2616: if ($authtype eq '') {
2617: $authtype = '<input type="radio" name="login" value="loc" '.
2618: $loccheck.' onchange="'.$jscall.'" onclick="'.
2619: $jscall.'" />';
2620: }
2621: $autharg = '<input type="text" size="10" name="locarg" value="'.
2622: $locarg.'" onchange="'.$jscall.'" />';
2623: $result = &mt('[_1] Local Authentication with argument [_2]',
2624: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2625: return $result;
2626: }
2627:
2628: sub authform_filesystem{
2629: my %in = (
2630: formname => 'document.cu',
2631: kerb_def_dom => 'MSU.EDU',
2632: @_,
2633: );
1.586 raeburn 2634: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2635: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2636: if (defined($in{'curr_authtype'})) {
2637: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2638: if ($can_assign{'fsys'}) {
1.772 bisitz 2639: $fsyscheck = 'checked="checked" ';
1.623 raeburn 2640: if (defined($in{'mode'})) {
2641: if ($in{'mode'} eq 'modifyuser') {
2642: $fsyscheck = '';
2643: }
2644: }
1.586 raeburn 2645: } else {
2646: $result = &mt('Currently Filesystem Authenticated.');
2647: return $result;
2648: }
2649: }
2650: } else {
2651: if ($authnum == 1) {
1.784 bisitz 2652: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 2653: }
2654: }
2655: if (!$can_assign{'fsys'}) {
2656: return;
1.587 raeburn 2657: } elsif ($authtype eq '') {
1.591 raeburn 2658: if (defined($in{'mode'})) {
1.587 raeburn 2659: if ($in{'mode'} eq 'modifycourse') {
2660: if ($authnum == 1) {
1.784 bisitz 2661: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587 raeburn 2662: }
2663: }
2664: }
1.586 raeburn 2665: }
2666: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2667: if ($authtype eq '') {
2668: $authtype = '<input type="radio" name="login" value="fsys" '.
2669: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2670: $jscall.'" />';
2671: }
2672: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2673: ' onchange="'.$jscall.'" />';
2674: $result = &mt
1.144 matthew 2675: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2676: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2677: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2678: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2679: 'onchange="'.$jscall.'" />');
1.32 matthew 2680: return $result;
2681: }
2682:
1.586 raeburn 2683: sub get_assignable_auth {
2684: my ($dom) = @_;
2685: if ($dom eq '') {
2686: $dom = $env{'request.role.domain'};
2687: }
2688: my %can_assign = (
2689: krb4 => 1,
2690: krb5 => 1,
2691: int => 1,
2692: loc => 1,
2693: );
2694: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2695: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2696: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2697: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2698: my $context;
2699: if ($env{'request.role'} =~ /^au/) {
2700: $context = 'author';
2701: } elsif ($env{'request.role'} =~ /^dc/) {
2702: $context = 'domain';
2703: } elsif ($env{'request.course.id'}) {
2704: $context = 'course';
2705: }
2706: if ($context) {
2707: if (ref($authhash->{$context}) eq 'HASH') {
2708: %can_assign = %{$authhash->{$context}};
2709: }
2710: }
2711: }
2712: }
2713: my $authnum = 0;
2714: foreach my $key (keys(%can_assign)) {
2715: if ($can_assign{$key}) {
2716: $authnum ++;
2717: }
2718: }
2719: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2720: $authnum --;
2721: }
2722: return ($authnum,%can_assign);
2723: }
2724:
1.80 albertel 2725: ###############################################################
2726: ## Get Kerberos Defaults for Domain ##
2727: ###############################################################
2728: ##
2729: ## Returns default kerberos version and an associated argument
2730: ## as listed in file domain.tab. If not listed, provides
2731: ## appropriate default domain and kerberos version.
2732: ##
2733: #-------------------------------------------
2734:
2735: =pod
2736:
1.648 raeburn 2737: =item * &get_kerberos_defaults()
1.80 albertel 2738:
2739: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2740: version and domain. If not found, it defaults to version 4 and the
2741: domain of the server.
1.80 albertel 2742:
1.648 raeburn 2743: =over 4
2744:
1.80 albertel 2745: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2746:
1.648 raeburn 2747: =back
2748:
2749: =back
2750:
1.80 albertel 2751: =cut
2752:
2753: #-------------------------------------------
2754: sub get_kerberos_defaults {
2755: my $domain=shift;
1.641 raeburn 2756: my ($krbdef,$krbdefdom);
2757: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2758: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2759: $krbdef = $domdefaults{'auth_def'};
2760: $krbdefdom = $domdefaults{'auth_arg_def'};
2761: } else {
1.80 albertel 2762: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2763: my $krbdefdom=$1;
2764: $krbdefdom=~tr/a-z/A-Z/;
2765: $krbdef = "krb4";
2766: }
2767: return ($krbdef,$krbdefdom);
2768: }
1.112 bowersj2 2769:
1.32 matthew 2770:
1.46 matthew 2771: ###############################################################
2772: ## Thesaurus Functions ##
2773: ###############################################################
1.20 www 2774:
1.46 matthew 2775: =pod
1.20 www 2776:
1.112 bowersj2 2777: =head1 Thesaurus Functions
2778:
2779: =over 4
2780:
1.648 raeburn 2781: =item * &initialize_keywords()
1.46 matthew 2782:
2783: Initializes the package variable %Keywords if it is empty. Uses the
2784: package variable $thesaurus_db_file.
2785:
2786: =cut
2787:
2788: ###################################################
2789:
2790: sub initialize_keywords {
2791: return 1 if (scalar keys(%Keywords));
2792: # If we are here, %Keywords is empty, so fill it up
2793: # Make sure the file we need exists...
2794: if (! -e $thesaurus_db_file) {
2795: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2796: " failed because it does not exist");
2797: return 0;
2798: }
2799: # Set up the hash as a database
2800: my %thesaurus_db;
2801: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2802: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2803: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2804: $thesaurus_db_file);
2805: return 0;
2806: }
2807: # Get the average number of appearances of a word.
2808: my $avecount = $thesaurus_db{'average.count'};
2809: # Put keywords (those that appear > average) into %Keywords
2810: while (my ($word,$data)=each (%thesaurus_db)) {
2811: my ($count,undef) = split /:/,$data;
2812: $Keywords{$word}++ if ($count > $avecount);
2813: }
2814: untie %thesaurus_db;
2815: # Remove special values from %Keywords.
1.356 albertel 2816: foreach my $value ('total.count','average.count') {
2817: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2818: }
1.46 matthew 2819: return 1;
2820: }
2821:
2822: ###################################################
2823:
2824: =pod
2825:
1.648 raeburn 2826: =item * &keyword($word)
1.46 matthew 2827:
2828: Returns true if $word is a keyword. A keyword is a word that appears more
2829: than the average number of times in the thesaurus database. Calls
2830: &initialize_keywords
2831:
2832: =cut
2833:
2834: ###################################################
1.20 www 2835:
2836: sub keyword {
1.46 matthew 2837: return if (!&initialize_keywords());
2838: my $word=lc(shift());
2839: $word=~s/\W//g;
2840: return exists($Keywords{$word});
1.20 www 2841: }
1.46 matthew 2842:
2843: ###############################################################
2844:
2845: =pod
1.20 www 2846:
1.648 raeburn 2847: =item * &get_related_words()
1.46 matthew 2848:
1.160 matthew 2849: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2850: an array of words. If the keyword is not in the thesaurus, an empty array
2851: will be returned. The order of the words returned is determined by the
2852: database which holds them.
2853:
2854: Uses global $thesaurus_db_file.
2855:
2856: =cut
2857:
2858: ###############################################################
2859: sub get_related_words {
2860: my $keyword = shift;
2861: my %thesaurus_db;
2862: if (! -e $thesaurus_db_file) {
2863: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2864: "failed because the file does not exist");
2865: return ();
2866: }
2867: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2868: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2869: return ();
2870: }
2871: my @Words=();
1.429 www 2872: my $count=0;
1.46 matthew 2873: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2874: # The first element is the number of times
2875: # the word appears. We do not need it now.
1.429 www 2876: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2877: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2878: my $threshold=$mostfrequentcount/10;
2879: foreach my $possibleword (@RelatedWords) {
2880: my ($word,$wordcount)=split(/\,/,$possibleword);
2881: if ($wordcount>$threshold) {
2882: push(@Words,$word);
2883: $count++;
2884: if ($count>10) { last; }
2885: }
1.20 www 2886: }
2887: }
1.46 matthew 2888: untie %thesaurus_db;
2889: return @Words;
1.14 harris41 2890: }
1.46 matthew 2891:
1.112 bowersj2 2892: =pod
2893:
2894: =back
2895:
2896: =cut
1.61 www 2897:
2898: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2899: =pod
2900:
1.112 bowersj2 2901: =head1 User Name Functions
2902:
2903: =over 4
2904:
1.648 raeburn 2905: =item * &plainname($uname,$udom,$first)
1.81 albertel 2906:
1.112 bowersj2 2907: Takes a users logon name and returns it as a string in
1.226 albertel 2908: "first middle last generation" form
2909: if $first is set to 'lastname' then it returns it as
2910: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2911:
2912: =cut
1.61 www 2913:
1.295 www 2914:
1.81 albertel 2915: ###############################################################
1.61 www 2916: sub plainname {
1.226 albertel 2917: my ($uname,$udom,$first)=@_;
1.537 albertel 2918: return if (!defined($uname) || !defined($udom));
1.295 www 2919: my %names=&getnames($uname,$udom);
1.226 albertel 2920: my $name=&Apache::lonnet::format_name($names{'firstname'},
2921: $names{'middlename'},
2922: $names{'lastname'},
2923: $names{'generation'},$first);
2924: $name=~s/^\s+//;
1.62 www 2925: $name=~s/\s+$//;
2926: $name=~s/\s+/ /g;
1.353 albertel 2927: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2928: return $name;
1.61 www 2929: }
1.66 www 2930:
2931: # -------------------------------------------------------------------- Nickname
1.81 albertel 2932: =pod
2933:
1.648 raeburn 2934: =item * &nickname($uname,$udom)
1.81 albertel 2935:
2936: Gets a users name and returns it as a string as
2937:
2938: ""nickname""
1.66 www 2939:
1.81 albertel 2940: if the user has a nickname or
2941:
2942: "first middle last generation"
2943:
2944: if the user does not
2945:
2946: =cut
1.66 www 2947:
2948: sub nickname {
2949: my ($uname,$udom)=@_;
1.537 albertel 2950: return if (!defined($uname) || !defined($udom));
1.295 www 2951: my %names=&getnames($uname,$udom);
1.68 albertel 2952: my $name=$names{'nickname'};
1.66 www 2953: if ($name) {
2954: $name='"'.$name.'"';
2955: } else {
2956: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2957: $names{'lastname'}.' '.$names{'generation'};
2958: $name=~s/\s+$//;
2959: $name=~s/\s+/ /g;
2960: }
2961: return $name;
2962: }
2963:
1.295 www 2964: sub getnames {
2965: my ($uname,$udom)=@_;
1.537 albertel 2966: return if (!defined($uname) || !defined($udom));
1.433 albertel 2967: if ($udom eq 'public' && $uname eq 'public') {
2968: return ('lastname' => &mt('Public'));
2969: }
1.295 www 2970: my $id=$uname.':'.$udom;
2971: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2972: if ($cached) {
2973: return %{$names};
2974: } else {
2975: my %loadnames=&Apache::lonnet::get('environment',
2976: ['firstname','middlename','lastname','generation','nickname'],
2977: $udom,$uname);
2978: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2979: return %loadnames;
2980: }
2981: }
1.61 www 2982:
1.542 raeburn 2983: # -------------------------------------------------------------------- getemails
1.648 raeburn 2984:
1.542 raeburn 2985: =pod
2986:
1.648 raeburn 2987: =item * &getemails($uname,$udom)
1.542 raeburn 2988:
2989: Gets a user's email information and returns it as a hash with keys:
2990: notification, critnotification, permanentemail
2991:
2992: For notification and critnotification, values are comma-separated lists
1.648 raeburn 2993: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 2994:
1.648 raeburn 2995:
1.542 raeburn 2996: =cut
2997:
1.648 raeburn 2998:
1.466 albertel 2999: sub getemails {
3000: my ($uname,$udom)=@_;
3001: if ($udom eq 'public' && $uname eq 'public') {
3002: return;
3003: }
1.467 www 3004: if (!$udom) { $udom=$env{'user.domain'}; }
3005: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 3006: my $id=$uname.':'.$udom;
3007: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
3008: if ($cached) {
3009: return %{$names};
3010: } else {
3011: my %loadnames=&Apache::lonnet::get('environment',
3012: ['notification','critnotification',
3013: 'permanentemail'],
3014: $udom,$uname);
3015: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
3016: return %loadnames;
3017: }
3018: }
3019:
1.551 albertel 3020: sub flush_email_cache {
3021: my ($uname,$udom)=@_;
3022: if (!$udom) { $udom =$env{'user.domain'}; }
3023: if (!$uname) { $uname=$env{'user.name'}; }
3024: return if ($udom eq 'public' && $uname eq 'public');
3025: my $id=$uname.':'.$udom;
3026: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
3027: }
3028:
1.728 raeburn 3029: # -------------------------------------------------------------------- getlangs
3030:
3031: =pod
3032:
3033: =item * &getlangs($uname,$udom)
3034:
3035: Gets a user's language preference and returns it as a hash with key:
3036: language.
3037:
3038: =cut
3039:
3040:
3041: sub getlangs {
3042: my ($uname,$udom) = @_;
3043: if (!$udom) { $udom =$env{'user.domain'}; }
3044: if (!$uname) { $uname=$env{'user.name'}; }
3045: my $id=$uname.':'.$udom;
3046: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
3047: if ($cached) {
3048: return %{$langs};
3049: } else {
3050: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
3051: $udom,$uname);
3052: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
3053: return %loadlangs;
3054: }
3055: }
3056:
3057: sub flush_langs_cache {
3058: my ($uname,$udom)=@_;
3059: if (!$udom) { $udom =$env{'user.domain'}; }
3060: if (!$uname) { $uname=$env{'user.name'}; }
3061: return if ($udom eq 'public' && $uname eq 'public');
3062: my $id=$uname.':'.$udom;
3063: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
3064: }
3065:
1.61 www 3066: # ------------------------------------------------------------------ Screenname
1.81 albertel 3067:
3068: =pod
3069:
1.648 raeburn 3070: =item * &screenname($uname,$udom)
1.81 albertel 3071:
3072: Gets a users screenname and returns it as a string
3073:
3074: =cut
1.61 www 3075:
3076: sub screenname {
3077: my ($uname,$udom)=@_;
1.258 albertel 3078: if ($uname eq $env{'user.name'} &&
3079: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 3080: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 3081: return $names{'screenname'};
1.62 www 3082: }
3083:
1.212 albertel 3084:
1.802 bisitz 3085: # ------------------------------------------------------------- Confirm Wrapper
3086: =pod
3087:
3088: =item confirmwrapper
3089:
3090: Wrap messages about completion of operation in box
3091:
3092: =cut
3093:
3094: sub confirmwrapper {
3095: my ($message)=@_;
3096: if ($message) {
3097: return "\n".'<div class="LC_confirm_box">'."\n"
3098: .$message."\n"
3099: .'</div>'."\n";
3100: } else {
3101: return $message;
3102: }
3103: }
3104:
1.62 www 3105: # ------------------------------------------------------------- Message Wrapper
3106:
3107: sub messagewrapper {
1.369 www 3108: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 3109: return
1.441 albertel 3110: '<a href="/adm/email?compose=individual&'.
3111: 'recname='.$username.'&recdom='.$domain.
3112: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 3113: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 3114: }
1.802 bisitz 3115:
1.74 www 3116: # --------------------------------------------------------------- Notes Wrapper
3117:
3118: sub noteswrapper {
3119: my ($link,$un,$do)=@_;
3120: return
1.896 amueller 3121: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 3122: }
1.802 bisitz 3123:
1.62 www 3124: # ------------------------------------------------------------- Aboutme Wrapper
3125:
3126: sub aboutmewrapper {
1.166 www 3127: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 3128: if (!defined($username) && !defined($domain)) {
3129: return;
3130: }
1.892 amueller 3131: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.756 weissno 3132: ($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 3133: }
3134:
3135: # ------------------------------------------------------------ Syllabus Wrapper
3136:
3137: sub syllabuswrapper {
1.707 bisitz 3138: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 3139: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 3140: }
1.14 harris41 3141:
1.802 bisitz 3142: # -----------------------------------------------------------------------------
3143:
1.208 matthew 3144: sub track_student_link {
1.887 raeburn 3145: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 3146: my $link ="/adm/trackstudent?";
1.208 matthew 3147: my $title = 'View recent activity';
3148: if (defined($sname) && $sname !~ /^\s*$/ &&
3149: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 3150: $link .= "selected_student=$sname:$sdom";
1.208 matthew 3151: $title .= ' of this student';
1.268 albertel 3152: }
1.208 matthew 3153: if (defined($target) && $target !~ /^\s*$/) {
3154: $target = qq{target="$target"};
3155: } else {
3156: $target = '';
3157: }
1.268 albertel 3158: if ($start) { $link.='&start='.$start; }
1.887 raeburn 3159: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 3160: $title = &mt($title);
3161: $linktext = &mt($linktext);
1.448 albertel 3162: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
3163: &help_open_topic('View_recent_activity');
1.208 matthew 3164: }
3165:
1.781 raeburn 3166: sub slot_reservations_link {
3167: my ($linktext,$sname,$sdom,$target) = @_;
3168: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
3169: my $title = 'View slot reservation history';
3170: if (defined($sname) && $sname !~ /^\s*$/ &&
3171: defined($sdom) && $sdom !~ /^\s*$/) {
3172: $link .= "&uname=$sname&udom=$sdom";
3173: $title .= ' of this student';
3174: }
3175: if (defined($target) && $target !~ /^\s*$/) {
3176: $target = qq{target="$target"};
3177: } else {
3178: $target = '';
3179: }
3180: $title = &mt($title);
3181: $linktext = &mt($linktext);
3182: return qq{<a href="$link" title="$title" $target>$linktext</a>};
3183: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
3184:
3185: }
3186:
1.508 www 3187: # ===================================================== Display a student photo
3188:
3189:
1.509 albertel 3190: sub student_image_tag {
1.508 www 3191: my ($domain,$user)=@_;
3192: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
3193: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
3194: return '<img src="'.$imgsrc.'" align="right" />';
3195: } else {
3196: return '';
3197: }
3198: }
3199:
1.112 bowersj2 3200: =pod
3201:
3202: =back
3203:
3204: =head1 Access .tab File Data
3205:
3206: =over 4
3207:
1.648 raeburn 3208: =item * &languageids()
1.112 bowersj2 3209:
3210: returns list of all language ids
3211:
3212: =cut
3213:
1.14 harris41 3214: sub languageids {
1.16 harris41 3215: return sort(keys(%language));
1.14 harris41 3216: }
3217:
1.112 bowersj2 3218: =pod
3219:
1.648 raeburn 3220: =item * &languagedescription()
1.112 bowersj2 3221:
3222: returns description of a specified language id
3223:
3224: =cut
3225:
1.14 harris41 3226: sub languagedescription {
1.125 www 3227: my $code=shift;
3228: return ($supported_language{$code}?'* ':'').
3229: $language{$code}.
1.126 www 3230: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 3231: }
3232:
3233: sub plainlanguagedescription {
3234: my $code=shift;
3235: return $language{$code};
3236: }
3237:
3238: sub supportedlanguagecode {
3239: my $code=shift;
3240: return $supported_language{$code};
1.97 www 3241: }
3242:
1.112 bowersj2 3243: =pod
3244:
1.648 raeburn 3245: =item * ©rightids()
1.112 bowersj2 3246:
3247: returns list of all copyrights
3248:
3249: =cut
3250:
3251: sub copyrightids {
3252: return sort(keys(%cprtag));
3253: }
3254:
3255: =pod
3256:
1.648 raeburn 3257: =item * ©rightdescription()
1.112 bowersj2 3258:
3259: returns description of a specified copyright id
3260:
3261: =cut
3262:
3263: sub copyrightdescription {
1.166 www 3264: return &mt($cprtag{shift(@_)});
1.112 bowersj2 3265: }
1.197 matthew 3266:
3267: =pod
3268:
1.648 raeburn 3269: =item * &source_copyrightids()
1.192 taceyjo1 3270:
3271: returns list of all source copyrights
3272:
3273: =cut
3274:
3275: sub source_copyrightids {
3276: return sort(keys(%scprtag));
3277: }
3278:
3279: =pod
3280:
1.648 raeburn 3281: =item * &source_copyrightdescription()
1.192 taceyjo1 3282:
3283: returns description of a specified source copyright id
3284:
3285: =cut
3286:
3287: sub source_copyrightdescription {
3288: return &mt($scprtag{shift(@_)});
3289: }
1.112 bowersj2 3290:
3291: =pod
3292:
1.648 raeburn 3293: =item * &filecategories()
1.112 bowersj2 3294:
3295: returns list of all file categories
3296:
3297: =cut
3298:
3299: sub filecategories {
3300: return sort(keys(%category_extensions));
3301: }
3302:
3303: =pod
3304:
1.648 raeburn 3305: =item * &filecategorytypes()
1.112 bowersj2 3306:
3307: returns list of file types belonging to a given file
3308: category
3309:
3310: =cut
3311:
3312: sub filecategorytypes {
1.356 albertel 3313: my ($cat) = @_;
3314: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 3315: }
3316:
3317: =pod
3318:
1.648 raeburn 3319: =item * &fileembstyle()
1.112 bowersj2 3320:
3321: returns embedding style for a specified file type
3322:
3323: =cut
3324:
3325: sub fileembstyle {
3326: return $fe{lc(shift(@_))};
1.169 www 3327: }
3328:
1.351 www 3329: sub filemimetype {
3330: return $fm{lc(shift(@_))};
3331: }
3332:
1.169 www 3333:
3334: sub filecategoryselect {
3335: my ($name,$value)=@_;
1.189 matthew 3336: return &select_form($value,$name,
1.970 raeburn 3337: {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112 bowersj2 3338: }
3339:
3340: =pod
3341:
1.648 raeburn 3342: =item * &filedescription()
1.112 bowersj2 3343:
3344: returns description for a specified file type
3345:
3346: =cut
3347:
3348: sub filedescription {
1.188 matthew 3349: my $file_description = $fd{lc(shift())};
3350: $file_description =~ s:([\[\]]):~$1:g;
3351: return &mt($file_description);
1.112 bowersj2 3352: }
3353:
3354: =pod
3355:
1.648 raeburn 3356: =item * &filedescriptionex()
1.112 bowersj2 3357:
3358: returns description for a specified file type with
3359: extra formatting
3360:
3361: =cut
3362:
3363: sub filedescriptionex {
3364: my $ex=shift;
1.188 matthew 3365: my $file_description = $fd{lc($ex)};
3366: $file_description =~ s:([\[\]]):~$1:g;
3367: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3368: }
3369:
3370: # End of .tab access
3371: =pod
3372:
3373: =back
3374:
3375: =cut
3376:
3377: # ------------------------------------------------------------------ File Types
3378: sub fileextensions {
3379: return sort(keys(%fe));
3380: }
3381:
1.97 www 3382: # ----------------------------------------------------------- Display Languages
3383: # returns a hash with all desired display languages
3384: #
3385:
3386: sub display_languages {
3387: my %languages=();
1.695 raeburn 3388: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3389: $languages{$lang}=1;
1.97 www 3390: }
3391: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3392: if ($env{'form.displaylanguage'}) {
1.356 albertel 3393: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3394: $languages{$lang}=1;
1.97 www 3395: }
3396: }
3397: return %languages;
1.14 harris41 3398: }
3399:
1.582 albertel 3400: sub languages {
3401: my ($possible_langs) = @_;
1.695 raeburn 3402: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3403: if (!ref($possible_langs)) {
3404: if( wantarray ) {
3405: return @preferred_langs;
3406: } else {
3407: return $preferred_langs[0];
3408: }
3409: }
3410: my %possibilities = map { $_ => 1 } (@$possible_langs);
3411: my @preferred_possibilities;
3412: foreach my $preferred_lang (@preferred_langs) {
3413: if (exists($possibilities{$preferred_lang})) {
3414: push(@preferred_possibilities, $preferred_lang);
3415: }
3416: }
3417: if( wantarray ) {
3418: return @preferred_possibilities;
3419: }
3420: return $preferred_possibilities[0];
3421: }
3422:
1.742 raeburn 3423: sub user_lang {
3424: my ($touname,$toudom,$fromcid) = @_;
3425: my @userlangs;
3426: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3427: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3428: $env{'course.'.$fromcid.'.languages'}));
3429: } else {
3430: my %langhash = &getlangs($touname,$toudom);
3431: if ($langhash{'languages'} ne '') {
3432: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3433: } else {
3434: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3435: if ($domdefs{'lang_def'} ne '') {
3436: @userlangs = ($domdefs{'lang_def'});
3437: }
3438: }
3439: }
3440: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3441: my $user_lh = Apache::localize->get_handle(@languages);
3442: return $user_lh;
3443: }
3444:
3445:
1.112 bowersj2 3446: ###############################################################
3447: ## Student Answer Attempts ##
3448: ###############################################################
3449:
3450: =pod
3451:
3452: =head1 Alternate Problem Views
3453:
3454: =over 4
3455:
1.648 raeburn 3456: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3457: $getattempt, $regexp, $gradesub)
3458:
3459: Return string with previous attempt on problem. Arguments:
3460:
3461: =over 4
3462:
3463: =item * $symb: Problem, including path
3464:
3465: =item * $username: username of the desired student
3466:
3467: =item * $domain: domain of the desired student
1.14 harris41 3468:
1.112 bowersj2 3469: =item * $course: Course ID
1.14 harris41 3470:
1.112 bowersj2 3471: =item * $getattempt: Leave blank for all attempts, otherwise put
3472: something
1.14 harris41 3473:
1.112 bowersj2 3474: =item * $regexp: if string matches this regexp, the string will be
3475: sent to $gradesub
1.14 harris41 3476:
1.112 bowersj2 3477: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3478:
1.112 bowersj2 3479: =back
1.14 harris41 3480:
1.112 bowersj2 3481: The output string is a table containing all desired attempts, if any.
1.16 harris41 3482:
1.112 bowersj2 3483: =cut
1.1 albertel 3484:
3485: sub get_previous_attempt {
1.43 ng 3486: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3487: my $prevattempts='';
1.43 ng 3488: no strict 'refs';
1.1 albertel 3489: if ($symb) {
1.3 albertel 3490: my (%returnhash)=
3491: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3492: if ($returnhash{'version'}) {
3493: my %lasthash=();
3494: my $version;
3495: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3496: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3497: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3498: }
1.1 albertel 3499: }
1.596 albertel 3500: $prevattempts=&start_data_table().&start_data_table_header_row();
3501: $prevattempts.='<th>'.&mt('History').'</th>';
1.978 raeburn 3502: my (%typeparts,%lasthidden);
1.945 raeburn 3503: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 3504: foreach my $key (sort(keys(%lasthash))) {
3505: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3506: if ($#parts > 0) {
1.31 albertel 3507: my $data=$parts[-1];
1.989 raeburn 3508: next if ($data eq 'foilorder');
1.31 albertel 3509: pop(@parts);
1.1010 www 3510: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.945 raeburn 3511: if ($data eq 'type') {
3512: unless ($showsurv) {
3513: my $id = join(',',@parts);
3514: $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978 raeburn 3515: if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
3516: $lasthidden{$ign.'.'.$id} = 1;
3517: }
1.945 raeburn 3518: }
1.1010 www 3519: }
1.31 albertel 3520: } else {
1.41 ng 3521: if ($#parts == 0) {
3522: $prevattempts.='<th>'.$parts[0].'</th>';
3523: } else {
3524: $prevattempts.='<th>'.$ign.'</th>';
3525: }
1.31 albertel 3526: }
1.16 harris41 3527: }
1.596 albertel 3528: $prevattempts.=&end_data_table_header_row();
1.40 ng 3529: if ($getattempt eq '') {
3530: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.945 raeburn 3531: my @hidden;
3532: if (%typeparts) {
3533: foreach my $id (keys(%typeparts)) {
3534: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
3535: push(@hidden,$id);
3536: }
3537: }
3538: }
3539: $prevattempts.=&start_data_table_row().
3540: '<td>'.&mt('Transaction [_1]',$version).'</td>';
3541: if (@hidden) {
3542: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3543: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3544: my $hide;
3545: foreach my $id (@hidden) {
3546: if ($key =~ /^\Q$id\E/) {
3547: $hide = 1;
3548: last;
3549: }
3550: }
3551: if ($hide) {
3552: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3553: if (($data eq 'award') || ($data eq 'awarddetail')) {
3554: my $value = &format_previous_attempt_value($key,
3555: $returnhash{$version.':'.$key});
3556: $prevattempts.='<td>'.$value.' </td>';
3557: } else {
3558: $prevattempts.='<td> </td>';
3559: }
3560: } else {
3561: if ($key =~ /\./) {
3562: my $value = &format_previous_attempt_value($key,
3563: $returnhash{$version.':'.$key});
3564: $prevattempts.='<td>'.$value.' </td>';
3565: } else {
3566: $prevattempts.='<td> </td>';
3567: }
3568: }
3569: }
3570: } else {
3571: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3572: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3573: my $value = &format_previous_attempt_value($key,
3574: $returnhash{$version.':'.$key});
3575: $prevattempts.='<td>'.$value.' </td>';
3576: }
3577: }
3578: $prevattempts.=&end_data_table_row();
1.40 ng 3579: }
1.1 albertel 3580: }
1.945 raeburn 3581: my @currhidden = keys(%lasthidden);
1.596 albertel 3582: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3583: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3584: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3585: if (%typeparts) {
3586: my $hidden;
3587: foreach my $id (@currhidden) {
3588: if ($key =~ /^\Q$id\E/) {
3589: $hidden = 1;
3590: last;
3591: }
3592: }
3593: if ($hidden) {
3594: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3595: if (($data eq 'award') || ($data eq 'awarddetail')) {
3596: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3597: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3598: $value = &$gradesub($value);
3599: }
3600: $prevattempts.='<td>'.$value.' </td>';
3601: } else {
3602: $prevattempts.='<td> </td>';
3603: }
3604: } else {
3605: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3606: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3607: $value = &$gradesub($value);
3608: }
3609: $prevattempts.='<td>'.$value.' </td>';
3610: }
3611: } else {
3612: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3613: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3614: $value = &$gradesub($value);
3615: }
3616: $prevattempts.='<td>'.$value.' </td>';
3617: }
1.16 harris41 3618: }
1.596 albertel 3619: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3620: } else {
1.596 albertel 3621: $prevattempts=
3622: &start_data_table().&start_data_table_row().
3623: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3624: &end_data_table_row().&end_data_table();
1.1 albertel 3625: }
3626: } else {
1.596 albertel 3627: $prevattempts=
3628: &start_data_table().&start_data_table_row().
3629: '<td>'.&mt('No data.').'</td>'.
3630: &end_data_table_row().&end_data_table();
1.1 albertel 3631: }
1.10 albertel 3632: }
3633:
1.581 albertel 3634: sub format_previous_attempt_value {
3635: my ($key,$value) = @_;
1.1011 www 3636: if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.581 albertel 3637: $value = &Apache::lonlocal::locallocaltime($value);
3638: } elsif (ref($value) eq 'ARRAY') {
3639: $value = '('.join(', ', @{ $value }).')';
1.988 raeburn 3640: } elsif ($key =~ /answerstring$/) {
3641: my %answers = &Apache::lonnet::str2hash($value);
3642: my @anskeys = sort(keys(%answers));
3643: if (@anskeys == 1) {
3644: my $answer = $answers{$anskeys[0]};
1.1001 raeburn 3645: if ($answer =~ m{\0}) {
3646: $answer =~ s{\0}{,}g;
1.988 raeburn 3647: }
3648: my $tag_internal_answer_name = 'INTERNAL';
3649: if ($anskeys[0] eq $tag_internal_answer_name) {
3650: $value = $answer;
3651: } else {
3652: $value = $anskeys[0].'='.$answer;
3653: }
3654: } else {
3655: foreach my $ans (@anskeys) {
3656: my $answer = $answers{$ans};
1.1001 raeburn 3657: if ($answer =~ m{\0}) {
3658: $answer =~ s{\0}{,}g;
1.988 raeburn 3659: }
3660: $value .= $ans.'='.$answer.'<br />';;
3661: }
3662: }
1.581 albertel 3663: } else {
3664: $value = &unescape($value);
3665: }
3666: return $value;
3667: }
3668:
3669:
1.107 albertel 3670: sub relative_to_absolute {
3671: my ($url,$output)=@_;
3672: my $parser=HTML::TokeParser->new(\$output);
3673: my $token;
3674: my $thisdir=$url;
3675: my @rlinks=();
3676: while ($token=$parser->get_token) {
3677: if ($token->[0] eq 'S') {
3678: if ($token->[1] eq 'a') {
3679: if ($token->[2]->{'href'}) {
3680: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3681: }
3682: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3683: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3684: } elsif ($token->[1] eq 'base') {
3685: $thisdir=$token->[2]->{'href'};
3686: }
3687: }
3688: }
3689: $thisdir=~s-/[^/]*$--;
1.356 albertel 3690: foreach my $link (@rlinks) {
1.726 raeburn 3691: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3692: ($link=~/^\//) ||
3693: ($link=~/^javascript:/i) ||
3694: ($link=~/^mailto:/i) ||
3695: ($link=~/^\#/)) {
3696: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3697: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3698: }
3699: }
3700: # -------------------------------------------------- Deal with Applet codebases
3701: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3702: return $output;
3703: }
3704:
1.112 bowersj2 3705: =pod
3706:
1.648 raeburn 3707: =item * &get_student_view()
1.112 bowersj2 3708:
3709: show a snapshot of what student was looking at
3710:
3711: =cut
3712:
1.10 albertel 3713: sub get_student_view {
1.186 albertel 3714: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3715: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3716: my (%form);
1.10 albertel 3717: my @elements=('symb','courseid','domain','username');
3718: foreach my $element (@elements) {
1.186 albertel 3719: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3720: }
1.186 albertel 3721: if (defined($moreenv)) {
3722: %form=(%form,%{$moreenv});
3723: }
1.236 albertel 3724: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3725: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3726: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3727: $userview=~s/\<body[^\>]*\>//gi;
3728: $userview=~s/\<\/body\>//gi;
3729: $userview=~s/\<html\>//gi;
3730: $userview=~s/\<\/html\>//gi;
3731: $userview=~s/\<head\>//gi;
3732: $userview=~s/\<\/head\>//gi;
3733: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3734: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3735: if (wantarray) {
3736: return ($userview,$response);
3737: } else {
3738: return $userview;
3739: }
3740: }
3741:
3742: sub get_student_view_with_retries {
3743: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3744:
3745: my $ok = 0; # True if we got a good response.
3746: my $content;
3747: my $response;
3748:
3749: # Try to get the student_view done. within the retries count:
3750:
3751: do {
3752: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3753: $ok = $response->is_success;
3754: if (!$ok) {
3755: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3756: }
3757: $retries--;
3758: } while (!$ok && ($retries > 0));
3759:
3760: if (!$ok) {
3761: $content = ''; # On error return an empty content.
3762: }
1.651 www 3763: if (wantarray) {
3764: return ($content, $response);
3765: } else {
3766: return $content;
3767: }
1.11 albertel 3768: }
3769:
1.112 bowersj2 3770: =pod
3771:
1.648 raeburn 3772: =item * &get_student_answers()
1.112 bowersj2 3773:
3774: show a snapshot of how student was answering problem
3775:
3776: =cut
3777:
1.11 albertel 3778: sub get_student_answers {
1.100 sakharuk 3779: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3780: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3781: my (%moreenv);
1.11 albertel 3782: my @elements=('symb','courseid','domain','username');
3783: foreach my $element (@elements) {
1.186 albertel 3784: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3785: }
1.186 albertel 3786: $moreenv{'grade_target'}='answer';
3787: %moreenv=(%form,%moreenv);
1.497 raeburn 3788: $feedurl = &Apache::lonnet::clutter($feedurl);
3789: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3790: return $userview;
1.1 albertel 3791: }
1.116 albertel 3792:
3793: =pod
3794:
3795: =item * &submlink()
3796:
1.242 albertel 3797: Inputs: $text $uname $udom $symb $target
1.116 albertel 3798:
3799: Returns: A link to grades.pm such as to see the SUBM view of a student
3800:
3801: =cut
3802:
3803: ###############################################
3804: sub submlink {
1.242 albertel 3805: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3806: if (!($uname && $udom)) {
3807: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3808: &Apache::lonnet::whichuser($symb);
1.116 albertel 3809: if (!$symb) { $symb=$cursymb; }
3810: }
1.254 matthew 3811: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3812: $symb=&escape($symb);
1.960 bisitz 3813: if ($target) { $target=" target=\"$target\""; }
3814: return
3815: '<a href="/adm/grades?command=submission'.
3816: '&symb='.$symb.
3817: '&student='.$uname.
3818: '&userdom='.$udom.'"'.
3819: $target.'>'.$text.'</a>';
1.242 albertel 3820: }
3821: ##############################################
3822:
3823: =pod
3824:
3825: =item * &pgrdlink()
3826:
3827: Inputs: $text $uname $udom $symb $target
3828:
3829: Returns: A link to grades.pm such as to see the PGRD view of a student
3830:
3831: =cut
3832:
3833: ###############################################
3834: sub pgrdlink {
3835: my $link=&submlink(@_);
3836: $link=~s/(&command=submission)/$1&showgrading=yes/;
3837: return $link;
3838: }
3839: ##############################################
3840:
3841: =pod
3842:
3843: =item * &pprmlink()
3844:
3845: Inputs: $text $uname $udom $symb $target
3846:
3847: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3848: student and a specific resource
1.242 albertel 3849:
3850: =cut
3851:
3852: ###############################################
3853: sub pprmlink {
3854: my ($text,$uname,$udom,$symb,$target)=@_;
3855: if (!($uname && $udom)) {
3856: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3857: &Apache::lonnet::whichuser($symb);
1.242 albertel 3858: if (!$symb) { $symb=$cursymb; }
3859: }
1.254 matthew 3860: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3861: $symb=&escape($symb);
1.242 albertel 3862: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3863: return '<a href="/adm/parmset?command=set&'.
3864: 'symb='.$symb.'&uname='.$uname.
3865: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3866: }
3867: ##############################################
1.37 matthew 3868:
1.112 bowersj2 3869: =pod
3870:
3871: =back
3872:
3873: =cut
3874:
1.37 matthew 3875: ###############################################
1.51 www 3876:
3877:
3878: sub timehash {
1.687 raeburn 3879: my ($thistime) = @_;
3880: my $timezone = &Apache::lonlocal::gettimezone();
3881: my $dt = DateTime->from_epoch(epoch => $thistime)
3882: ->set_time_zone($timezone);
3883: my $wday = $dt->day_of_week();
3884: if ($wday == 7) { $wday = 0; }
3885: return ( 'second' => $dt->second(),
3886: 'minute' => $dt->minute(),
3887: 'hour' => $dt->hour(),
3888: 'day' => $dt->day_of_month(),
3889: 'month' => $dt->month(),
3890: 'year' => $dt->year(),
3891: 'weekday' => $wday,
3892: 'dayyear' => $dt->day_of_year(),
3893: 'dlsav' => $dt->is_dst() );
1.51 www 3894: }
3895:
1.370 www 3896: sub utc_string {
3897: my ($date)=@_;
1.371 www 3898: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3899: }
3900:
1.51 www 3901: sub maketime {
3902: my %th=@_;
1.687 raeburn 3903: my ($epoch_time,$timezone,$dt);
3904: $timezone = &Apache::lonlocal::gettimezone();
3905: eval {
3906: $dt = DateTime->new( year => $th{'year'},
3907: month => $th{'month'},
3908: day => $th{'day'},
3909: hour => $th{'hour'},
3910: minute => $th{'minute'},
3911: second => $th{'second'},
3912: time_zone => $timezone,
3913: );
3914: };
3915: if (!$@) {
3916: $epoch_time = $dt->epoch;
3917: if ($epoch_time) {
3918: return $epoch_time;
3919: }
3920: }
1.51 www 3921: return POSIX::mktime(
3922: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3923: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3924: }
3925:
3926: #########################################
1.51 www 3927:
3928: sub findallcourses {
1.482 raeburn 3929: my ($roles,$uname,$udom) = @_;
1.355 albertel 3930: my %roles;
3931: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3932: my %courses;
1.51 www 3933: my $now=time;
1.482 raeburn 3934: if (!defined($uname)) {
3935: $uname = $env{'user.name'};
3936: }
3937: if (!defined($udom)) {
3938: $udom = $env{'user.domain'};
3939: }
3940: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.982 raeburn 3941: my $extra = &Apache::lonnet::freeze_escape({'skipcheck' => 1});
3942: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname,'.',undef,
3943: $extra);
1.482 raeburn 3944: if (!%roles) {
3945: %roles = (
3946: cc => 1,
1.907 raeburn 3947: co => 1,
1.482 raeburn 3948: in => 1,
3949: ep => 1,
3950: ta => 1,
3951: cr => 1,
3952: st => 1,
3953: );
3954: }
3955: foreach my $entry (keys(%roleshash)) {
3956: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3957: if ($trole =~ /^cr/) {
3958: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3959: } else {
3960: next if (!exists($roles{$trole}));
3961: }
3962: if ($tend) {
3963: next if ($tend < $now);
3964: }
3965: if ($tstart) {
3966: next if ($tstart > $now);
3967: }
3968: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3969: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3970: if ($secpart eq '') {
3971: ($cnum,$role) = split(/_/,$cnumpart);
3972: $sec = 'none';
3973: $realsec = '';
3974: } else {
3975: $cnum = $cnumpart;
3976: ($sec,$role) = split(/_/,$secpart);
3977: $realsec = $sec;
1.490 raeburn 3978: }
1.482 raeburn 3979: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3980: }
3981: } else {
3982: foreach my $key (keys(%env)) {
1.483 albertel 3983: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3984: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3985: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3986: next if ($role eq 'ca' || $role eq 'aa');
3987: next if (%roles && !exists($roles{$role}));
3988: my ($starttime,$endtime)=split(/\./,$env{$key});
3989: my $active=1;
3990: if ($starttime) {
3991: if ($now<$starttime) { $active=0; }
3992: }
3993: if ($endtime) {
3994: if ($now>$endtime) { $active=0; }
3995: }
3996: if ($active) {
3997: if ($sec eq '') {
3998: $sec = 'none';
3999: }
4000: $courses{$cdom.'_'.$cnum}{$sec} =
4001: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 4002: }
4003: }
1.51 www 4004: }
4005: }
1.474 raeburn 4006: return %courses;
1.51 www 4007: }
1.37 matthew 4008:
1.54 www 4009: ###############################################
1.474 raeburn 4010:
4011: sub blockcheck {
1.482 raeburn 4012: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 4013:
4014: if (!defined($udom)) {
4015: $udom = $env{'user.domain'};
4016: }
4017: if (!defined($uname)) {
4018: $uname = $env{'user.name'};
4019: }
4020:
4021: # If uname and udom are for a course, check for blocks in the course.
4022:
4023: if (&Apache::lonnet::is_course($udom,$uname)) {
4024: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 4025: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 4026: return ($startblock,$endblock);
4027: }
1.474 raeburn 4028:
1.502 raeburn 4029: my $startblock = 0;
4030: my $endblock = 0;
1.482 raeburn 4031: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 4032:
1.490 raeburn 4033: # If uname is for a user, and activity is course-specific, i.e.,
4034: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 4035:
1.490 raeburn 4036: if (($activity eq 'boards' || $activity eq 'chat' ||
4037: $activity eq 'groups') && ($env{'request.course.id'})) {
4038: foreach my $key (keys(%live_courses)) {
4039: if ($key ne $env{'request.course.id'}) {
4040: delete($live_courses{$key});
4041: }
4042: }
4043: }
4044:
4045: my $otheruser = 0;
4046: my %own_courses;
4047: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
4048: # Resource belongs to user other than current user.
4049: $otheruser = 1;
4050: # Gather courses for current user
4051: %own_courses =
4052: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
4053: }
4054:
4055: # Gather active course roles - course coordinator, instructor,
4056: # exam proctor, ta, student, or custom role.
1.474 raeburn 4057:
4058: foreach my $course (keys(%live_courses)) {
1.482 raeburn 4059: my ($cdom,$cnum);
4060: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
4061: $cdom = $env{'course.'.$course.'.domain'};
4062: $cnum = $env{'course.'.$course.'.num'};
4063: } else {
1.490 raeburn 4064: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 4065: }
4066: my $no_ownblock = 0;
4067: my $no_userblock = 0;
1.533 raeburn 4068: if ($otheruser && $activity ne 'com') {
1.490 raeburn 4069: # Check if current user has 'evb' priv for this
4070: if (defined($own_courses{$course})) {
4071: foreach my $sec (keys(%{$own_courses{$course}})) {
4072: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
4073: if ($sec ne 'none') {
4074: $checkrole .= '/'.$sec;
4075: }
4076: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4077: $no_ownblock = 1;
4078: last;
4079: }
4080: }
4081: }
4082: # if they have 'evb' priv and are currently not playing student
4083: next if (($no_ownblock) &&
4084: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
4085: }
1.474 raeburn 4086: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 4087: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 4088: if ($sec ne 'none') {
1.482 raeburn 4089: $checkrole .= '/'.$sec;
1.474 raeburn 4090: }
1.490 raeburn 4091: if ($otheruser) {
4092: # Resource belongs to user other than current user.
4093: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 4094: my ($trole,$tdom,$tnum,$tsec);
4095: my $entry = $live_courses{$course}{$sec};
4096: if ($entry =~ /^cr/) {
4097: ($trole,$tdom,$tnum,$tsec) =
4098: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
4099: } else {
4100: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
4101: }
4102: my ($spec,$area,$trest,%allroles,%userroles);
4103: $area = '/'.$tdom.'/'.$tnum;
4104: $trest = $tnum;
4105: if ($tsec ne '') {
4106: $area .= '/'.$tsec;
4107: $trest .= '/'.$tsec;
4108: }
4109: $spec = $trole.'.'.$area;
4110: if ($trole =~ /^cr/) {
4111: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
4112: $tdom,$spec,$trest,$area);
4113: } else {
4114: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
4115: $tdom,$spec,$trest,$area);
4116: }
4117: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 4118: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
4119: if ($1) {
4120: $no_userblock = 1;
4121: last;
4122: }
4123: }
1.490 raeburn 4124: } else {
4125: # Resource belongs to current user
4126: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 4127: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4128: $no_ownblock = 1;
4129: last;
4130: }
1.474 raeburn 4131: }
4132: }
4133: # if they have the evb priv and are currently not playing student
1.482 raeburn 4134: next if (($no_ownblock) &&
1.491 albertel 4135: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 4136: next if ($no_userblock);
1.474 raeburn 4137:
1.866 kalberla 4138: # Retrieve blocking times and identity of locker for course
1.490 raeburn 4139: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 4140:
4141: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
4142: if (($start != 0) &&
4143: (($startblock == 0) || ($startblock > $start))) {
4144: $startblock = $start;
4145: }
4146: if (($end != 0) &&
4147: (($endblock == 0) || ($endblock < $end))) {
4148: $endblock = $end;
4149: }
1.490 raeburn 4150: }
4151: return ($startblock,$endblock);
4152: }
4153:
4154: sub get_blocks {
4155: my ($setters,$activity,$cdom,$cnum) = @_;
4156: my $startblock = 0;
4157: my $endblock = 0;
4158: my $course = $cdom.'_'.$cnum;
4159: $setters->{$course} = {};
4160: $setters->{$course}{'staff'} = [];
4161: $setters->{$course}{'times'} = [];
4162: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
4163: foreach my $record (keys(%records)) {
4164: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
4165: if ($start <= time && $end >= time) {
4166: my ($staff_name,$staff_dom,$title,$blocks) =
4167: &parse_block_record($records{$record});
4168: if ($blocks->{$activity} eq 'on') {
4169: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
4170: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 4171: if ( ($startblock == 0) || ($startblock > $start) ) {
4172: $startblock = $start;
1.490 raeburn 4173: }
1.491 albertel 4174: if ( ($endblock == 0) || ($endblock < $end) ) {
4175: $endblock = $end;
1.474 raeburn 4176: }
4177: }
4178: }
4179: }
4180: return ($startblock,$endblock);
4181: }
4182:
4183: sub parse_block_record {
4184: my ($record) = @_;
4185: my ($setuname,$setudom,$title,$blocks);
4186: if (ref($record) eq 'HASH') {
4187: ($setuname,$setudom) = split(/:/,$record->{'setter'});
4188: $title = &unescape($record->{'event'});
4189: $blocks = $record->{'blocks'};
4190: } else {
4191: my @data = split(/:/,$record,3);
4192: if (scalar(@data) eq 2) {
4193: $title = $data[1];
4194: ($setuname,$setudom) = split(/@/,$data[0]);
4195: } else {
4196: ($setuname,$setudom,$title) = @data;
4197: }
4198: $blocks = { 'com' => 'on' };
4199: }
4200: return ($setuname,$setudom,$title,$blocks);
4201: }
4202:
1.854 kalberla 4203: sub blocking_status {
4204: my ($activity,$uname,$udom) = @_;
1.867 kalberla 4205: my %setters;
1.890 droeschl 4206:
4207: # check for active blocking
1.867 kalberla 4208: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
1.854 kalberla 4209:
1.890 droeschl 4210: my $blocked = $startblock && $endblock ? 1 : 0;
4211:
4212: # caller just wants to know whether a block is active
4213: if (!wantarray) { return $blocked; }
4214:
4215: # build a link to a popup window containing the details
4216: my $querystring = "?activity=$activity";
4217: # $uname and $udom decide whose portfolio the user is trying to look at
4218: $querystring .= "&udom=$udom" if $udom;
4219: $querystring .= "&uname=$uname" if $uname;
4220:
4221: my $output .= <<'END_MYBLOCK';
1.854 kalberla 4222: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
4223: var options = "width=" + w + ",height=" + h + ",";
4224: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
4225: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
4226: var newWin = window.open(url, wdwName, options);
4227: newWin.focus();
4228: }
1.890 droeschl 4229: END_MYBLOCK
1.854 kalberla 4230:
1.890 droeschl 4231: $output = Apache::lonhtmlcommon::scripttag($output);
4232:
1.854 kalberla 4233: my $popupUrl = "/adm/blockingstatus/$querystring";
1.890 droeschl 4234: my $text = mt('Communication Blocked');
4235:
1.867 kalberla 4236: $output .= <<"END_BLOCK";
4237: <div class='LC_comblock'>
1.869 kalberla 4238: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4239: title='$text'>
4240: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 4241: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4242: title='$text'>$text</a>
1.867 kalberla 4243: </div>
4244:
4245: END_BLOCK
1.474 raeburn 4246:
1.854 kalberla 4247: return ($blocked, $output);
4248: }
1.490 raeburn 4249:
1.60 matthew 4250: ###############################################
4251:
1.682 raeburn 4252: sub check_ip_acc {
4253: my ($acc)=@_;
4254: &Apache::lonxml::debug("acc is $acc");
4255: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
4256: return 1;
4257: }
4258: my $allowed=0;
4259: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
4260:
4261: my $name;
4262: foreach my $pattern (split(',',$acc)) {
4263: $pattern =~ s/^\s*//;
4264: $pattern =~ s/\s*$//;
4265: if ($pattern =~ /\*$/) {
4266: #35.8.*
4267: $pattern=~s/\*//;
4268: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4269: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
4270: #35.8.3.[34-56]
4271: my $low=$2;
4272: my $high=$3;
4273: $pattern=$1;
4274: if ($ip =~ /^\Q$pattern\E/) {
4275: my $last=(split(/\./,$ip))[3];
4276: if ($last <=$high && $last >=$low) { $allowed=1; }
4277: }
4278: } elsif ($pattern =~ /^\*/) {
4279: #*.msu.edu
4280: $pattern=~s/\*//;
4281: if (!defined($name)) {
4282: use Socket;
4283: my $netaddr=inet_aton($ip);
4284: ($name)=gethostbyaddr($netaddr,AF_INET);
4285: }
4286: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4287: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
4288: #127.0.0.1
4289: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4290: } else {
4291: #some.name.com
4292: if (!defined($name)) {
4293: use Socket;
4294: my $netaddr=inet_aton($ip);
4295: ($name)=gethostbyaddr($netaddr,AF_INET);
4296: }
4297: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4298: }
4299: if ($allowed) { last; }
4300: }
4301: return $allowed;
4302: }
4303:
4304: ###############################################
4305:
1.60 matthew 4306: =pod
4307:
1.112 bowersj2 4308: =head1 Domain Template Functions
4309:
4310: =over 4
4311:
4312: =item * &determinedomain()
1.60 matthew 4313:
4314: Inputs: $domain (usually will be undef)
4315:
1.63 www 4316: Returns: Determines which domain should be used for designs
1.60 matthew 4317:
4318: =cut
1.54 www 4319:
1.60 matthew 4320: ###############################################
1.63 www 4321: sub determinedomain {
4322: my $domain=shift;
1.531 albertel 4323: if (! $domain) {
1.60 matthew 4324: # Determine domain if we have not been given one
1.893 raeburn 4325: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 4326: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
4327: if ($env{'request.role.domain'}) {
4328: $domain=$env{'request.role.domain'};
1.60 matthew 4329: }
4330: }
1.63 www 4331: return $domain;
4332: }
4333: ###############################################
1.517 raeburn 4334:
1.518 albertel 4335: sub devalidate_domconfig_cache {
4336: my ($udom)=@_;
4337: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
4338: }
4339:
4340: # ---------------------- Get domain configuration for a domain
4341: sub get_domainconf {
4342: my ($udom) = @_;
4343: my $cachetime=1800;
4344: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
4345: if (defined($cached)) { return %{$result}; }
4346:
4347: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 4348: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 4349: my (%designhash,%legacy);
1.518 albertel 4350: if (keys(%domconfig) > 0) {
4351: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 4352: if (keys(%{$domconfig{'login'}})) {
4353: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 4354: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.946 raeburn 4355: if ($key eq 'loginvia') {
4356: if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') {
1.1013 raeburn 4357: foreach my $hostname (keys(%{$domconfig{'login'}{'loginvia'}})) {
1.948 raeburn 4358: if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') {
4359: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
4360: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
4361: $designhash{$udom.'.login.loginvia'} = $server;
4362: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
4363:
4364: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
4365: } else {
1.1013 raeburn 4366: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
1.948 raeburn 4367: }
4368: if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) {
4369: $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'};
4370: }
1.946 raeburn 4371: }
4372: }
4373: }
4374: }
4375: } else {
4376: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
4377: $designhash{$udom.'.login.'.$key.'_'.$img} =
4378: $domconfig{'login'}{$key}{$img};
4379: }
1.699 raeburn 4380: }
4381: } else {
4382: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
4383: }
1.632 raeburn 4384: }
4385: } else {
4386: $legacy{'login'} = 1;
1.518 albertel 4387: }
1.632 raeburn 4388: } else {
4389: $legacy{'login'} = 1;
1.518 albertel 4390: }
4391: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 4392: if (keys(%{$domconfig{'rolecolors'}})) {
4393: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
4394: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
4395: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
4396: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
4397: }
1.518 albertel 4398: }
4399: }
1.632 raeburn 4400: } else {
4401: $legacy{'rolecolors'} = 1;
1.518 albertel 4402: }
1.632 raeburn 4403: } else {
4404: $legacy{'rolecolors'} = 1;
1.518 albertel 4405: }
1.948 raeburn 4406: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
4407: if ($domconfig{'autoenroll'}{'co-owners'}) {
4408: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
4409: }
4410: }
1.632 raeburn 4411: if (keys(%legacy) > 0) {
4412: my %legacyhash = &get_legacy_domconf($udom);
4413: foreach my $item (keys(%legacyhash)) {
4414: if ($item =~ /^\Q$udom\E\.login/) {
4415: if ($legacy{'login'}) {
4416: $designhash{$item} = $legacyhash{$item};
4417: }
4418: } else {
4419: if ($legacy{'rolecolors'}) {
4420: $designhash{$item} = $legacyhash{$item};
4421: }
1.518 albertel 4422: }
4423: }
4424: }
1.632 raeburn 4425: } else {
4426: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4427: }
4428: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4429: $cachetime);
4430: return %designhash;
4431: }
4432:
1.632 raeburn 4433: sub get_legacy_domconf {
4434: my ($udom) = @_;
4435: my %legacyhash;
4436: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4437: my $designfile = $designdir.'/'.$udom.'.tab';
4438: if (-e $designfile) {
4439: if ( open (my $fh,"<$designfile") ) {
4440: while (my $line = <$fh>) {
4441: next if ($line =~ /^\#/);
4442: chomp($line);
4443: my ($key,$val)=(split(/\=/,$line));
4444: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4445: }
4446: close($fh);
4447: }
4448: }
4449: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
4450: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4451: }
4452: return %legacyhash;
4453: }
4454:
1.63 www 4455: =pod
4456:
1.112 bowersj2 4457: =item * &domainlogo()
1.63 www 4458:
4459: Inputs: $domain (usually will be undef)
4460:
4461: Returns: A link to a domain logo, if the domain logo exists.
4462: If the domain logo does not exist, a description of the domain.
4463:
4464: =cut
1.112 bowersj2 4465:
1.63 www 4466: ###############################################
4467: sub domainlogo {
1.517 raeburn 4468: my $domain = &determinedomain(shift);
1.518 albertel 4469: my %designhash = &get_domainconf($domain);
1.517 raeburn 4470: # See if there is a logo
4471: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4472: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4473: if ($imgsrc =~ m{^/(adm|res)/}) {
4474: if ($imgsrc =~ m{^/res/}) {
4475: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4476: &Apache::lonnet::repcopy($local_name);
4477: }
4478: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4479: }
4480: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4481: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4482: return &Apache::lonnet::domain($domain,'description');
1.59 www 4483: } else {
1.60 matthew 4484: return '';
1.59 www 4485: }
4486: }
1.63 www 4487: ##############################################
4488:
4489: =pod
4490:
1.112 bowersj2 4491: =item * &designparm()
1.63 www 4492:
4493: Inputs: $which parameter; $domain (usually will be undef)
4494:
4495: Returns: value of designparamter $which
4496:
4497: =cut
1.112 bowersj2 4498:
1.397 albertel 4499:
1.400 albertel 4500: ##############################################
1.397 albertel 4501: sub designparm {
4502: my ($which,$domain)=@_;
4503: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 4504: return $env{'environment.color.'.$which};
1.96 www 4505: }
1.63 www 4506: $domain=&determinedomain($domain);
1.1016 raeburn 4507: my %domdesign;
4508: unless ($domain eq 'public') {
4509: %domdesign = &get_domainconf($domain);
4510: }
1.520 raeburn 4511: my $output;
1.517 raeburn 4512: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 4513: $output = $domdesign{$domain.'.'.$which};
1.63 www 4514: } else {
1.520 raeburn 4515: $output = $defaultdesign{$which};
4516: }
4517: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4518: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4519: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 4520: if ($output =~ m{^/res/}) {
4521: my $local_name = &Apache::lonnet::filelocation('',$output);
4522: &Apache::lonnet::repcopy($local_name);
4523: }
1.520 raeburn 4524: $output = &lonhttpdurl($output);
4525: }
1.63 www 4526: }
1.520 raeburn 4527: return $output;
1.63 www 4528: }
1.59 www 4529:
1.822 bisitz 4530: ##############################################
4531: =pod
4532:
1.832 bisitz 4533: =item * &authorspace()
4534:
4535: Inputs: ./.
4536:
4537: Returns: Path to the Construction Space of the current user's
4538: accessed author space
4539: The author space will be that of the current user
4540: when accessing the own author space
4541: and that of the co-author/assistent co-author
4542: when accessing the co-author's/assistent co-author's
4543: space
4544:
4545: =cut
4546:
4547: sub authorspace {
4548: my $caname = '';
1.1024 ! www 4549: my $cadom = '';
1.832 bisitz 4550: if ($env{'request.role'} =~ /^ca|^aa/) {
1.1024 ! www 4551: ($cadom,$caname) =
1.832 bisitz 4552: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
4553: } else {
4554: $caname = $env{'user.name'};
1.1024 ! www 4555: $cadom = $env{'user.domain'};
1.832 bisitz 4556: }
1.1024 ! www 4557: return '/priv/'.$cadom.'/'.$caname.'/';
1.832 bisitz 4558: }
4559:
4560: ##############################################
4561: =pod
4562:
1.822 bisitz 4563: =item * &head_subbox()
4564:
4565: Inputs: $content (contains HTML code with page functions, etc.)
4566:
4567: Returns: HTML div with $content
4568: To be included in page header
4569:
4570: =cut
4571:
4572: sub head_subbox {
4573: my ($content)=@_;
4574: my $output =
1.993 raeburn 4575: '<div class="LC_head_subbox">'
1.822 bisitz 4576: .$content
4577: .'</div>'
4578: }
4579:
4580: ##############################################
4581: =pod
4582:
4583: =item * &CSTR_pageheader()
4584:
4585: Inputs: ./.
4586:
4587: Returns: HTML div with CSTR path and recent box
4588: To be included on Construction Space pages
4589:
4590: =cut
4591:
4592: sub CSTR_pageheader {
4593: # this is for resources; directories have customtitle, and crumbs
4594: # and select recent are created in lonpubdir.pm
1.1022 www 4595: my ($udom,$uname,$thisdisfn)=
4596: ($env{'request.filename'} =~ m|^/home/httpd/html/priv/([^/]+)/([^/]+)/(.*)$|);
4597: my $formaction='/priv/'.$udom.'/'.$uname.'/'.$thisdisfn;
1.822 bisitz 4598: $formaction=~s/\/+/\//g;
4599:
4600: my $parentpath = '';
4601: my $lastitem = '';
4602: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4603: $parentpath = $1;
4604: $lastitem = $2;
4605: } else {
4606: $lastitem = $thisdisfn;
4607: }
1.921 bisitz 4608:
4609: my $output =
1.822 bisitz 4610: '<div>'
4611: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
4612: .'<b>'.&mt('Construction Space:').'</b> '
4613: .'<form name="dirs" method="post" action="'.$formaction
1.921 bisitz 4614: .'" target="_top">' #FIXME lonpubdir: target="_parent"
1.1024 ! www 4615: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv/'.$udom,undef,undef);
1.921 bisitz 4616:
4617: if ($lastitem) {
4618: $output .=
4619: '<span class="LC_filename">'
4620: .$lastitem
4621: .'</span>';
4622: }
4623: $output .=
4624: '<br />'
1.822 bisitz 4625: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
4626: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4627: .'</form>'
4628: .&Apache::lonmenu::constspaceform()
4629: .'</div>';
1.921 bisitz 4630:
4631: return $output;
1.822 bisitz 4632: }
4633:
1.60 matthew 4634: ###############################################
4635: ###############################################
4636:
4637: =pod
4638:
1.112 bowersj2 4639: =back
4640:
1.549 albertel 4641: =head1 HTML Helpers
1.112 bowersj2 4642:
4643: =over 4
4644:
4645: =item * &bodytag()
1.60 matthew 4646:
4647: Returns a uniform header for LON-CAPA web pages.
4648:
4649: Inputs:
4650:
1.112 bowersj2 4651: =over 4
4652:
4653: =item * $title, A title to be displayed on the page.
4654:
4655: =item * $function, the current role (can be undef).
4656:
4657: =item * $addentries, extra parameters for the <body> tag.
4658:
4659: =item * $bodyonly, if defined, only return the <body> tag.
4660:
4661: =item * $domain, if defined, force a given domain.
4662:
4663: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4664: text interface only)
1.60 matthew 4665:
1.814 bisitz 4666: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
4667: navigational links
1.317 albertel 4668:
1.338 albertel 4669: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4670:
1.460 albertel 4671: =item * $args, optional argument valid values are
4672: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4673: inherit_jsmath -> when creating popup window in a page,
4674: should it have jsmath forced on by the
4675: current page
1.460 albertel 4676:
1.112 bowersj2 4677: =back
4678:
1.60 matthew 4679: Returns: A uniform header for LON-CAPA web pages.
4680: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4681: If $bodyonly is undef or zero, an html string containing a <body> tag and
4682: other decorations will be returned.
4683:
4684: =cut
4685:
1.54 www 4686: sub bodytag {
1.831 bisitz 4687: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.962 droeschl 4688: $no_nav_bar,$bgcolor,$args)=@_;
1.339 albertel 4689:
1.954 raeburn 4690: my $public;
4691: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
4692: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
4693: $public = 1;
4694: }
1.460 albertel 4695: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4696:
1.183 matthew 4697: $function = &get_users_function() if (!$function);
1.339 albertel 4698: my $img = &designparm($function.'.img',$domain);
4699: my $font = &designparm($function.'.font',$domain);
4700: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4701:
1.803 bisitz 4702: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 4703: 'bgcolor' => $pgbg,
1.339 albertel 4704: 'text' => $font,
4705: 'alink' => &designparm($function.'.alink',$domain),
4706: 'vlink' => &designparm($function.'.vlink',$domain),
4707: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4708: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4709:
1.63 www 4710: # role and realm
1.378 raeburn 4711: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4712: if ($role eq 'ca') {
1.479 albertel 4713: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4714: $realm = &plainname($rname,$rdom);
1.378 raeburn 4715: }
1.55 www 4716: # realm
1.258 albertel 4717: if ($env{'request.course.id'}) {
1.378 raeburn 4718: if ($env{'request.role'} !~ /^cr/) {
4719: $role = &Apache::lonnet::plaintext($role,&course_type());
4720: }
1.898 raeburn 4721: if ($env{'request.course.sec'}) {
4722: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
4723: }
1.359 albertel 4724: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4725: } else {
4726: $role = &Apache::lonnet::plaintext($role);
1.54 www 4727: }
1.433 albertel 4728:
1.359 albertel 4729: if (!$realm) { $realm=' '; }
1.330 albertel 4730:
1.438 albertel 4731: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4732:
1.101 www 4733: # construct main body tag
1.359 albertel 4734: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4735: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4736:
1.530 albertel 4737: if ($bodyonly) {
1.60 matthew 4738: return $bodytag;
1.798 tempelho 4739: }
1.359 albertel 4740:
1.410 albertel 4741: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.954 raeburn 4742: if ($public) {
1.433 albertel 4743: undef($role);
1.434 albertel 4744: } else {
4745: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4746: }
1.359 albertel 4747:
1.762 bisitz 4748: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 4749: #
4750: # Extra info if you are the DC
4751: my $dc_info = '';
4752: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4753: $env{'course.'.$env{'request.course.id'}.
4754: '.domain'}.'/'})) {
4755: my $cid = $env{'request.course.id'};
1.917 raeburn 4756: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4757: $dc_info =~ s/\s+$//;
1.359 albertel 4758: }
4759:
1.898 raeburn 4760: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853 droeschl 4761: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
4762:
1.916 droeschl 4763: if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') {
4764: return $bodytag;
4765: }
1.903 droeschl 4766:
4767: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
4768:
4769: # if ($env{'request.state'} eq 'construct') {
4770: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
4771: # }
4772:
1.359 albertel 4773:
4774:
1.916 droeschl 4775: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917 raeburn 4776: if ($dc_info) {
4777: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
4778: }
1.916 droeschl 4779: $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
4780: <em>$realm</em> $dc_info</div>|;
1.903 droeschl 4781: return $bodytag;
4782: }
1.894 droeschl 4783:
1.927 raeburn 4784: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
4785: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
4786: }
1.916 droeschl 4787:
1.903 droeschl 4788: $bodytag .= Apache::lonhtmlcommon::scripttag(
4789: Apache::lonmenu::utilityfunctions(), 'start');
1.816 bisitz 4790:
1.903 droeschl 4791: $bodytag .= Apache::lonmenu::primary_menu();
1.852 droeschl 4792:
1.917 raeburn 4793: if ($dc_info) {
4794: $dc_info = &dc_courseid_toggle($dc_info);
4795: }
4796: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 4797:
1.903 droeschl 4798: #don't show menus for public users
1.954 raeburn 4799: if (!$public){
1.903 droeschl 4800: $bodytag .= Apache::lonmenu::secondary_menu();
4801: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 4802: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
4803: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 4804: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.920 raeburn 4805: $args->{'bread_crumbs'});
4806: } elsif ($forcereg) {
4807: $bodytag .= &Apache::lonmenu::innerregister($forcereg);
4808: }
1.903 droeschl 4809: }else{
4810: # this is to seperate menu from content when there's no secondary
4811: # menu. Especially needed for public accessible ressources.
4812: $bodytag .= '<hr style="clear:both" />';
4813: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 4814: }
1.903 droeschl 4815:
1.235 raeburn 4816: return $bodytag;
1.182 matthew 4817: }
4818:
1.917 raeburn 4819: sub dc_courseid_toggle {
4820: my ($dc_info) = @_;
1.980 raeburn 4821: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.917 raeburn 4822: '<a href="javascript:showCourseID();">'.
4823: &mt('(More ...)').'</a></span>'.
4824: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
4825: }
4826:
1.330 albertel 4827: sub make_attr_string {
4828: my ($register,$attr_ref) = @_;
4829:
4830: if ($attr_ref && !ref($attr_ref)) {
4831: die("addentries Must be a hash ref ".
4832: join(':',caller(1))." ".
4833: join(':',caller(0))." ");
4834: }
4835:
4836: if ($register) {
1.339 albertel 4837: my ($on_load,$on_unload);
4838: foreach my $key (keys(%{$attr_ref})) {
4839: if (lc($key) eq 'onload') {
4840: $on_load.=$attr_ref->{$key}.';';
4841: delete($attr_ref->{$key});
4842:
4843: } elsif (lc($key) eq 'onunload') {
4844: $on_unload.=$attr_ref->{$key}.';';
4845: delete($attr_ref->{$key});
4846: }
4847: }
1.953 droeschl 4848: $attr_ref->{'onload'} = $on_load;
4849: $attr_ref->{'onunload'}= $on_unload;
1.330 albertel 4850: }
1.339 albertel 4851:
1.330 albertel 4852: my $attr_string;
4853: foreach my $attr (keys(%$attr_ref)) {
4854: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4855: }
4856: return $attr_string;
4857: }
4858:
4859:
1.182 matthew 4860: ###############################################
1.251 albertel 4861: ###############################################
4862:
4863: =pod
4864:
4865: =item * &endbodytag()
4866:
4867: Returns a uniform footer for LON-CAPA web pages.
4868:
1.635 raeburn 4869: Inputs: 1 - optional reference to an args hash
4870: If in the hash, key for noredirectlink has a value which evaluates to true,
4871: a 'Continue' link is not displayed if the page contains an
4872: internal redirect in the <head></head> section,
4873: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4874:
4875: =cut
4876:
4877: sub endbodytag {
1.635 raeburn 4878: my ($args) = @_;
1.251 albertel 4879: my $endbodytag='</body>';
1.269 albertel 4880: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4881: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4882: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4883: $endbodytag=
4884: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4885: &mt('Continue').'</a>'.
4886: $endbodytag;
4887: }
1.315 albertel 4888: }
1.251 albertel 4889: return $endbodytag;
4890: }
4891:
1.352 albertel 4892: =pod
4893:
4894: =item * &standard_css()
4895:
4896: Returns a style sheet
4897:
4898: Inputs: (all optional)
4899: domain -> force to color decorate a page for a specific
4900: domain
4901: function -> force usage of a specific rolish color scheme
4902: bgcolor -> override the default page bgcolor
4903:
4904: =cut
4905:
1.343 albertel 4906: sub standard_css {
1.345 albertel 4907: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4908: $function = &get_users_function() if (!$function);
4909: my $img = &designparm($function.'.img', $domain);
4910: my $tabbg = &designparm($function.'.tabbg', $domain);
4911: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 4912: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 4913: #second colour for later usage
1.345 albertel 4914: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4915: my $pgbg_or_bgcolor =
4916: $bgcolor ||
1.352 albertel 4917: &designparm($function.'.pgbg', $domain);
1.382 albertel 4918: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4919: my $alink = &designparm($function.'.alink', $domain);
4920: my $vlink = &designparm($function.'.vlink', $domain);
4921: my $link = &designparm($function.'.link', $domain);
4922:
1.602 albertel 4923: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4924: my $mono = 'monospace';
1.850 bisitz 4925: my $data_table_head = $sidebg;
4926: my $data_table_light = '#FAFAFA';
4927: my $data_table_dark = '#F0F0F0';
1.470 banghart 4928: my $data_table_darker = '#CCCCCC';
1.349 albertel 4929: my $data_table_highlight = '#FFFF00';
1.352 albertel 4930: my $mail_new = '#FFBB77';
4931: my $mail_new_hover = '#DD9955';
4932: my $mail_read = '#BBBB77';
4933: my $mail_read_hover = '#999944';
4934: my $mail_replied = '#AAAA88';
4935: my $mail_replied_hover = '#888855';
4936: my $mail_other = '#99BBBB';
4937: my $mail_other_hover = '#669999';
1.391 albertel 4938: my $table_header = '#DDDDDD';
1.489 raeburn 4939: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 4940: my $lg_border_color = '#C8C8C8';
1.952 onken 4941: my $button_hover = '#BF2317';
1.392 albertel 4942:
1.608 albertel 4943: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 4944: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
4945: : '0 3px 0 4px';
1.448 albertel 4946:
1.523 albertel 4947:
1.343 albertel 4948: return <<END;
1.947 droeschl 4949:
4950: /* needed for iframe to allow 100% height in FF */
4951: body, html {
4952: margin: 0;
4953: padding: 0 0.5%;
4954: height: 99%; /* to avoid scrollbars */
4955: }
4956:
1.795 www 4957: body {
1.911 bisitz 4958: font-family: $sans;
4959: line-height:130%;
4960: font-size:0.83em;
4961: color:$font;
1.795 www 4962: }
4963:
1.959 onken 4964: a:focus,
4965: a:focus img {
1.795 www 4966: color: red;
1.911 bisitz 4967: background: yellow;
1.795 www 4968: }
1.698 harmsja 4969:
1.911 bisitz 4970: form, .inline {
4971: display: inline;
1.795 www 4972: }
1.721 harmsja 4973:
1.795 www 4974: .LC_right {
1.911 bisitz 4975: text-align:right;
1.795 www 4976: }
4977:
4978: .LC_middle {
1.911 bisitz 4979: vertical-align:middle;
1.795 www 4980: }
1.721 harmsja 4981:
1.911 bisitz 4982: .LC_400Box {
4983: width:400px;
4984: }
1.721 harmsja 4985:
1.947 droeschl 4986: .LC_iframecontainer {
4987: width: 98%;
4988: margin: 0;
4989: position: fixed;
4990: top: 8.5em;
4991: bottom: 0;
4992: }
4993:
4994: .LC_iframecontainer iframe{
4995: border: none;
4996: width: 100%;
4997: height: 100%;
4998: }
4999:
1.778 bisitz 5000: .LC_filename {
5001: font-family: $mono;
5002: white-space:pre;
1.921 bisitz 5003: font-size: 120%;
1.778 bisitz 5004: }
5005:
5006: .LC_fileicon {
5007: border: none;
5008: height: 1.3em;
5009: vertical-align: text-bottom;
5010: margin-right: 0.3em;
5011: text-decoration:none;
5012: }
5013:
1.1008 www 5014: .LC_setting {
5015: text-decoration:underline;
5016: }
5017:
1.350 albertel 5018: .LC_error {
5019: color: red;
5020: font-size: larger;
5021: }
1.795 www 5022:
1.457 albertel 5023: .LC_warning,
5024: .LC_diff_removed {
1.733 bisitz 5025: color: red;
1.394 albertel 5026: }
1.532 albertel 5027:
5028: .LC_info,
1.457 albertel 5029: .LC_success,
5030: .LC_diff_added {
1.350 albertel 5031: color: green;
5032: }
1.795 www 5033:
1.802 bisitz 5034: div.LC_confirm_box {
5035: background-color: #FAFAFA;
5036: border: 1px solid $lg_border_color;
5037: margin-right: 0;
5038: padding: 5px;
5039: }
5040:
5041: div.LC_confirm_box .LC_error img,
5042: div.LC_confirm_box .LC_success img {
5043: vertical-align: middle;
5044: }
5045:
1.440 albertel 5046: .LC_icon {
1.771 droeschl 5047: border: none;
1.790 droeschl 5048: vertical-align: middle;
1.771 droeschl 5049: }
5050:
1.543 albertel 5051: .LC_docs_spacer {
5052: width: 25px;
5053: height: 1px;
1.771 droeschl 5054: border: none;
1.543 albertel 5055: }
1.346 albertel 5056:
1.532 albertel 5057: .LC_internal_info {
1.735 bisitz 5058: color: #999999;
1.532 albertel 5059: }
5060:
1.794 www 5061: .LC_discussion {
1.911 bisitz 5062: background: $tabbg;
5063: border: 1px solid black;
5064: margin: 2px;
1.794 www 5065: }
5066:
5067: .LC_disc_action_links_bar {
1.911 bisitz 5068: background: $tabbg;
5069: border: none;
5070: margin: 4px;
1.794 www 5071: }
5072:
5073: .LC_disc_action_left {
1.911 bisitz 5074: text-align: left;
1.794 www 5075: }
5076:
5077: .LC_disc_action_right {
1.911 bisitz 5078: text-align: right;
1.794 www 5079: }
5080:
5081: .LC_disc_new_item {
1.911 bisitz 5082: background: white;
5083: border: 2px solid red;
5084: margin: 2px;
1.794 www 5085: }
5086:
5087: .LC_disc_old_item {
1.911 bisitz 5088: background: white;
5089: border: 1px solid black;
5090: margin: 2px;
1.794 www 5091: }
5092:
1.458 albertel 5093: table.LC_pastsubmission {
5094: border: 1px solid black;
5095: margin: 2px;
5096: }
5097:
1.924 bisitz 5098: table#LC_menubuttons {
1.345 albertel 5099: width: 100%;
5100: background: $pgbg;
1.392 albertel 5101: border: 2px;
1.402 albertel 5102: border-collapse: separate;
1.803 bisitz 5103: padding: 0;
1.345 albertel 5104: }
1.392 albertel 5105:
1.801 tempelho 5106: table#LC_title_bar a {
5107: color: $fontmenu;
5108: }
1.836 bisitz 5109:
1.807 droeschl 5110: table#LC_title_bar {
1.819 tempelho 5111: clear: both;
1.836 bisitz 5112: display: none;
1.807 droeschl 5113: }
5114:
1.795 www 5115: table#LC_title_bar,
1.933 droeschl 5116: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 5117: table#LC_title_bar.LC_with_remote {
1.359 albertel 5118: width: 100%;
1.392 albertel 5119: border-color: $pgbg;
5120: border-style: solid;
5121: border-width: $border;
1.379 albertel 5122: background: $pgbg;
1.801 tempelho 5123: color: $fontmenu;
1.392 albertel 5124: border-collapse: collapse;
1.803 bisitz 5125: padding: 0;
1.819 tempelho 5126: margin: 0;
1.359 albertel 5127: }
1.795 www 5128:
1.933 droeschl 5129: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 5130: margin: 0;
5131: padding: 0;
1.933 droeschl 5132: position: relative;
5133: list-style: none;
1.913 droeschl 5134: }
1.933 droeschl 5135: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 5136: display: inline;
5137: }
1.933 droeschl 5138:
5139: .LC_breadcrumb_tools_navigation {
1.913 droeschl 5140: padding: 0;
1.933 droeschl 5141: margin: 0;
5142: float: left;
1.913 droeschl 5143: }
1.933 droeschl 5144: .LC_breadcrumb_tools_tools {
5145: padding: 0;
5146: margin: 0;
1.913 droeschl 5147: float: right;
5148: }
5149:
1.359 albertel 5150: table#LC_title_bar td {
5151: background: $tabbg;
5152: }
1.795 www 5153:
1.911 bisitz 5154: table#LC_menubuttons img {
1.803 bisitz 5155: border: none;
1.346 albertel 5156: }
1.795 www 5157:
1.842 droeschl 5158: .LC_breadcrumbs_component {
1.911 bisitz 5159: float: right;
5160: margin: 0 1em;
1.357 albertel 5161: }
1.842 droeschl 5162: .LC_breadcrumbs_component img {
1.911 bisitz 5163: vertical-align: middle;
1.777 tempelho 5164: }
1.795 www 5165:
1.383 albertel 5166: td.LC_table_cell_checkbox {
5167: text-align: center;
5168: }
1.795 www 5169:
5170: .LC_fontsize_small {
1.911 bisitz 5171: font-size: 70%;
1.705 tempelho 5172: }
5173:
1.844 bisitz 5174: #LC_breadcrumbs {
1.911 bisitz 5175: clear:both;
5176: background: $sidebg;
5177: border-bottom: 1px solid $lg_border_color;
5178: line-height: 2.5em;
1.933 droeschl 5179: overflow: hidden;
1.911 bisitz 5180: margin: 0;
5181: padding: 0;
1.995 raeburn 5182: text-align: left;
1.819 tempelho 5183: }
1.862 bisitz 5184:
1.993 raeburn 5185: .LC_head_subbox {
1.911 bisitz 5186: clear:both;
5187: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 5188: border: 1px solid $sidebg;
5189: margin: 0 0 10px 0;
1.966 bisitz 5190: padding: 3px;
1.995 raeburn 5191: text-align: left;
1.822 bisitz 5192: }
5193:
1.795 www 5194: .LC_fontsize_medium {
1.911 bisitz 5195: font-size: 85%;
1.705 tempelho 5196: }
5197:
1.795 www 5198: .LC_fontsize_large {
1.911 bisitz 5199: font-size: 120%;
1.705 tempelho 5200: }
5201:
1.346 albertel 5202: .LC_menubuttons_inline_text {
5203: color: $font;
1.698 harmsja 5204: font-size: 90%;
1.701 harmsja 5205: padding-left:3px;
1.346 albertel 5206: }
5207:
1.934 droeschl 5208: .LC_menubuttons_inline_text img{
5209: vertical-align: middle;
5210: }
5211:
1.951 onken 5212: li.LC_menubuttons_inline_text img,a {
5213: cursor:pointer;
1.1002 droeschl 5214: text-decoration: none;
1.951 onken 5215: }
5216:
1.526 www 5217: .LC_menubuttons_link {
5218: text-decoration: none;
5219: }
1.795 www 5220:
1.522 albertel 5221: .LC_menubuttons_category {
1.521 www 5222: color: $font;
1.526 www 5223: background: $pgbg;
1.521 www 5224: font-size: larger;
5225: font-weight: bold;
5226: }
5227:
1.346 albertel 5228: td.LC_menubuttons_text {
1.911 bisitz 5229: color: $font;
1.346 albertel 5230: }
1.706 harmsja 5231:
1.346 albertel 5232: .LC_current_location {
5233: background: $tabbg;
5234: }
1.795 www 5235:
1.938 bisitz 5236: table.LC_data_table {
1.347 albertel 5237: border: 1px solid #000000;
1.402 albertel 5238: border-collapse: separate;
1.426 albertel 5239: border-spacing: 1px;
1.610 albertel 5240: background: $pgbg;
1.347 albertel 5241: }
1.795 www 5242:
1.422 albertel 5243: .LC_data_table_dense {
5244: font-size: small;
5245: }
1.795 www 5246:
1.507 raeburn 5247: table.LC_nested_outer {
5248: border: 1px solid #000000;
1.589 raeburn 5249: border-collapse: collapse;
1.803 bisitz 5250: border-spacing: 0;
1.507 raeburn 5251: width: 100%;
5252: }
1.795 www 5253:
1.879 raeburn 5254: table.LC_innerpickbox,
1.507 raeburn 5255: table.LC_nested {
1.803 bisitz 5256: border: none;
1.589 raeburn 5257: border-collapse: collapse;
1.803 bisitz 5258: border-spacing: 0;
1.507 raeburn 5259: width: 100%;
5260: }
1.795 www 5261:
1.911 bisitz 5262: table.LC_data_table tr th,
5263: table.LC_calendar tr th,
1.879 raeburn 5264: table.LC_prior_tries tr th,
5265: table.LC_innerpickbox tr th {
1.349 albertel 5266: font-weight: bold;
5267: background-color: $data_table_head;
1.801 tempelho 5268: color:$fontmenu;
1.701 harmsja 5269: font-size:90%;
1.347 albertel 5270: }
1.795 www 5271:
1.879 raeburn 5272: table.LC_innerpickbox tr th,
5273: table.LC_innerpickbox tr td {
5274: vertical-align: top;
5275: }
5276:
1.711 raeburn 5277: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 5278: background-color: #CCCCCC;
1.711 raeburn 5279: font-weight: bold;
5280: text-align: left;
5281: }
1.795 www 5282:
1.912 bisitz 5283: table.LC_data_table tr.LC_odd_row > td {
5284: background-color: $data_table_light;
5285: padding: 2px;
5286: vertical-align: top;
5287: }
5288:
1.809 bisitz 5289: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 5290: background-color: $data_table_light;
1.912 bisitz 5291: vertical-align: top;
5292: }
5293:
5294: table.LC_data_table tr.LC_even_row > td {
5295: background-color: $data_table_dark;
1.425 albertel 5296: padding: 2px;
1.900 bisitz 5297: vertical-align: top;
1.347 albertel 5298: }
1.795 www 5299:
1.809 bisitz 5300: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 5301: background-color: $data_table_dark;
1.900 bisitz 5302: vertical-align: top;
1.347 albertel 5303: }
1.795 www 5304:
1.425 albertel 5305: table.LC_data_table tr.LC_data_table_highlight td {
5306: background-color: $data_table_darker;
5307: }
1.795 www 5308:
1.639 raeburn 5309: table.LC_data_table tr td.LC_leftcol_header {
5310: background-color: $data_table_head;
5311: font-weight: bold;
5312: }
1.795 www 5313:
1.451 albertel 5314: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5315: table.LC_nested tr.LC_empty_row td {
1.421 albertel 5316: font-weight: bold;
5317: font-style: italic;
5318: text-align: center;
5319: padding: 8px;
1.347 albertel 5320: }
1.795 www 5321:
1.940 bisitz 5322: table.LC_data_table tr.LC_empty_row td {
5323: background-color: $sidebg;
5324: }
5325:
5326: table.LC_nested tr.LC_empty_row td {
5327: background-color: #FFFFFF;
5328: }
5329:
1.890 droeschl 5330: table.LC_caption {
5331: }
5332:
1.507 raeburn 5333: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5334: padding: 4ex
5335: }
1.795 www 5336:
1.507 raeburn 5337: table.LC_nested_outer tr th {
5338: font-weight: bold;
1.801 tempelho 5339: color:$fontmenu;
1.507 raeburn 5340: background-color: $data_table_head;
1.701 harmsja 5341: font-size: small;
1.507 raeburn 5342: border-bottom: 1px solid #000000;
5343: }
1.795 www 5344:
1.507 raeburn 5345: table.LC_nested_outer tr td.LC_subheader {
5346: background-color: $data_table_head;
5347: font-weight: bold;
5348: font-size: small;
5349: border-bottom: 1px solid #000000;
5350: text-align: right;
1.451 albertel 5351: }
1.795 www 5352:
1.507 raeburn 5353: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5354: background-color: #CCCCCC;
1.451 albertel 5355: font-weight: bold;
5356: font-size: small;
1.507 raeburn 5357: text-align: center;
5358: }
1.795 www 5359:
1.589 raeburn 5360: table.LC_nested tr.LC_info_row td.LC_left_item,
5361: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5362: text-align: left;
1.451 albertel 5363: }
1.795 www 5364:
1.507 raeburn 5365: table.LC_nested td {
1.735 bisitz 5366: background-color: #FFFFFF;
1.451 albertel 5367: font-size: small;
1.507 raeburn 5368: }
1.795 www 5369:
1.507 raeburn 5370: table.LC_nested_outer tr th.LC_right_item,
5371: table.LC_nested tr.LC_info_row td.LC_right_item,
5372: table.LC_nested tr.LC_odd_row td.LC_right_item,
5373: table.LC_nested tr td.LC_right_item {
1.451 albertel 5374: text-align: right;
5375: }
5376:
1.507 raeburn 5377: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5378: background-color: #EEEEEE;
1.451 albertel 5379: }
5380:
1.473 raeburn 5381: table.LC_createuser {
5382: }
5383:
5384: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5385: font-size: small;
1.473 raeburn 5386: }
5387:
5388: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5389: background-color: #CCCCCC;
1.473 raeburn 5390: font-weight: bold;
5391: text-align: center;
5392: }
5393:
1.349 albertel 5394: table.LC_calendar {
5395: border: 1px solid #000000;
5396: border-collapse: collapse;
1.917 raeburn 5397: width: 98%;
1.349 albertel 5398: }
1.795 www 5399:
1.349 albertel 5400: table.LC_calendar_pickdate {
5401: font-size: xx-small;
5402: }
1.795 www 5403:
1.349 albertel 5404: table.LC_calendar tr td {
5405: border: 1px solid #000000;
5406: vertical-align: top;
1.917 raeburn 5407: width: 14%;
1.349 albertel 5408: }
1.795 www 5409:
1.349 albertel 5410: table.LC_calendar tr td.LC_calendar_day_empty {
5411: background-color: $data_table_dark;
5412: }
1.795 www 5413:
1.779 bisitz 5414: table.LC_calendar tr td.LC_calendar_day_current {
5415: background-color: $data_table_highlight;
1.777 tempelho 5416: }
1.795 www 5417:
1.938 bisitz 5418: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 5419: background-color: $mail_new;
5420: }
1.795 www 5421:
1.938 bisitz 5422: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 5423: background-color: $mail_new_hover;
5424: }
1.795 www 5425:
1.938 bisitz 5426: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 5427: background-color: $mail_read;
5428: }
1.795 www 5429:
1.938 bisitz 5430: /*
5431: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 5432: background-color: $mail_read_hover;
5433: }
1.938 bisitz 5434: */
1.795 www 5435:
1.938 bisitz 5436: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 5437: background-color: $mail_replied;
5438: }
1.795 www 5439:
1.938 bisitz 5440: /*
5441: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 5442: background-color: $mail_replied_hover;
5443: }
1.938 bisitz 5444: */
1.795 www 5445:
1.938 bisitz 5446: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 5447: background-color: $mail_other;
5448: }
1.795 www 5449:
1.938 bisitz 5450: /*
5451: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 5452: background-color: $mail_other_hover;
5453: }
1.938 bisitz 5454: */
1.494 raeburn 5455:
1.777 tempelho 5456: table.LC_data_table tr > td.LC_browser_file,
5457: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 5458: background: #AAEE77;
1.389 albertel 5459: }
1.795 www 5460:
1.777 tempelho 5461: table.LC_data_table tr > td.LC_browser_file_locked,
5462: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5463: background: #FFAA99;
1.387 albertel 5464: }
1.795 www 5465:
1.777 tempelho 5466: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 5467: background: #888888;
1.779 bisitz 5468: }
1.795 www 5469:
1.777 tempelho 5470: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5471: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 5472: background: #F8F866;
1.777 tempelho 5473: }
1.795 www 5474:
1.696 bisitz 5475: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 5476: background: #E0E8FF;
1.387 albertel 5477: }
1.696 bisitz 5478:
1.707 bisitz 5479: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 5480: /* background: #77FF77; */
1.707 bisitz 5481: }
1.795 www 5482:
1.707 bisitz 5483: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 5484: border-right: 8px solid #FFFF77;
1.707 bisitz 5485: }
1.795 www 5486:
1.707 bisitz 5487: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 5488: border-right: 8px solid #FFAA77;
1.707 bisitz 5489: }
1.795 www 5490:
1.707 bisitz 5491: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 5492: border-right: 8px solid #FF7777;
1.707 bisitz 5493: }
1.795 www 5494:
1.707 bisitz 5495: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 5496: border-right: 8px solid #AAFF77;
1.707 bisitz 5497: }
1.795 www 5498:
1.707 bisitz 5499: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 5500: border-right: 8px solid #11CC55;
1.707 bisitz 5501: }
5502:
1.388 albertel 5503: span.LC_current_location {
1.701 harmsja 5504: font-size:larger;
1.388 albertel 5505: background: $pgbg;
5506: }
1.387 albertel 5507:
1.395 albertel 5508: span.LC_parm_menu_item {
5509: font-size: larger;
5510: }
1.795 www 5511:
1.395 albertel 5512: span.LC_parm_scope_all {
5513: color: red;
5514: }
1.795 www 5515:
1.395 albertel 5516: span.LC_parm_scope_folder {
5517: color: green;
5518: }
1.795 www 5519:
1.395 albertel 5520: span.LC_parm_scope_resource {
5521: color: orange;
5522: }
1.795 www 5523:
1.395 albertel 5524: span.LC_parm_part {
5525: color: blue;
5526: }
1.795 www 5527:
1.911 bisitz 5528: span.LC_parm_folder,
5529: span.LC_parm_symb {
1.395 albertel 5530: font-size: x-small;
5531: font-family: $mono;
5532: color: #AAAAAA;
5533: }
5534:
1.977 bisitz 5535: ul.LC_parm_parmlist li {
5536: display: inline-block;
5537: padding: 0.3em 0.8em;
5538: vertical-align: top;
5539: width: 150px;
5540: border-top:1px solid $lg_border_color;
5541: }
5542:
1.795 www 5543: td.LC_parm_overview_level_menu,
5544: td.LC_parm_overview_map_menu,
5545: td.LC_parm_overview_parm_selectors,
5546: td.LC_parm_overview_restrictions {
1.396 albertel 5547: border: 1px solid black;
5548: border-collapse: collapse;
5549: }
1.795 www 5550:
1.396 albertel 5551: table.LC_parm_overview_restrictions td {
5552: border-width: 1px 4px 1px 4px;
5553: border-style: solid;
5554: border-color: $pgbg;
5555: text-align: center;
5556: }
1.795 www 5557:
1.396 albertel 5558: table.LC_parm_overview_restrictions th {
5559: background: $tabbg;
5560: border-width: 1px 4px 1px 4px;
5561: border-style: solid;
5562: border-color: $pgbg;
5563: }
1.795 www 5564:
1.398 albertel 5565: table#LC_helpmenu {
1.803 bisitz 5566: border: none;
1.398 albertel 5567: height: 55px;
1.803 bisitz 5568: border-spacing: 0;
1.398 albertel 5569: }
5570:
5571: table#LC_helpmenu fieldset legend {
5572: font-size: larger;
5573: }
1.795 www 5574:
1.397 albertel 5575: table#LC_helpmenu_links {
5576: width: 100%;
5577: border: 1px solid black;
5578: background: $pgbg;
1.803 bisitz 5579: padding: 0;
1.397 albertel 5580: border-spacing: 1px;
5581: }
1.795 www 5582:
1.397 albertel 5583: table#LC_helpmenu_links tr td {
5584: padding: 1px;
5585: background: $tabbg;
1.399 albertel 5586: text-align: center;
5587: font-weight: bold;
1.397 albertel 5588: }
1.396 albertel 5589:
1.795 www 5590: table#LC_helpmenu_links a:link,
5591: table#LC_helpmenu_links a:visited,
1.397 albertel 5592: table#LC_helpmenu_links a:active {
5593: text-decoration: none;
5594: color: $font;
5595: }
1.795 www 5596:
1.397 albertel 5597: table#LC_helpmenu_links a:hover {
5598: text-decoration: underline;
5599: color: $vlink;
5600: }
1.396 albertel 5601:
1.417 albertel 5602: .LC_chrt_popup_exists {
5603: border: 1px solid #339933;
5604: margin: -1px;
5605: }
1.795 www 5606:
1.417 albertel 5607: .LC_chrt_popup_up {
5608: border: 1px solid yellow;
5609: margin: -1px;
5610: }
1.795 www 5611:
1.417 albertel 5612: .LC_chrt_popup {
5613: border: 1px solid #8888FF;
5614: background: #CCCCFF;
5615: }
1.795 www 5616:
1.421 albertel 5617: table.LC_pick_box {
5618: border-collapse: separate;
5619: background: white;
5620: border: 1px solid black;
5621: border-spacing: 1px;
5622: }
1.795 www 5623:
1.421 albertel 5624: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 5625: background: $sidebg;
1.421 albertel 5626: font-weight: bold;
1.900 bisitz 5627: text-align: left;
1.740 bisitz 5628: vertical-align: top;
1.421 albertel 5629: width: 184px;
5630: padding: 8px;
5631: }
1.795 www 5632:
1.579 raeburn 5633: table.LC_pick_box td.LC_pick_box_value {
5634: text-align: left;
5635: padding: 8px;
5636: }
1.795 www 5637:
1.579 raeburn 5638: table.LC_pick_box td.LC_pick_box_select {
5639: text-align: left;
5640: padding: 8px;
5641: }
1.795 www 5642:
1.424 albertel 5643: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 5644: padding: 0;
1.421 albertel 5645: height: 1px;
5646: background: black;
5647: }
1.795 www 5648:
1.421 albertel 5649: table.LC_pick_box td.LC_pick_box_submit {
5650: text-align: right;
5651: }
1.795 www 5652:
1.579 raeburn 5653: table.LC_pick_box td.LC_evenrow_value {
5654: text-align: left;
5655: padding: 8px;
5656: background-color: $data_table_light;
5657: }
1.795 www 5658:
1.579 raeburn 5659: table.LC_pick_box td.LC_oddrow_value {
5660: text-align: left;
5661: padding: 8px;
5662: background-color: $data_table_light;
5663: }
1.795 www 5664:
1.579 raeburn 5665: span.LC_helpform_receipt_cat {
5666: font-weight: bold;
5667: }
1.795 www 5668:
1.424 albertel 5669: table.LC_group_priv_box {
5670: background: white;
5671: border: 1px solid black;
5672: border-spacing: 1px;
5673: }
1.795 www 5674:
1.424 albertel 5675: table.LC_group_priv_box td.LC_pick_box_title {
5676: background: $tabbg;
5677: font-weight: bold;
5678: text-align: right;
5679: width: 184px;
5680: }
1.795 www 5681:
1.424 albertel 5682: table.LC_group_priv_box td.LC_groups_fixed {
5683: background: $data_table_light;
5684: text-align: center;
5685: }
1.795 www 5686:
1.424 albertel 5687: table.LC_group_priv_box td.LC_groups_optional {
5688: background: $data_table_dark;
5689: text-align: center;
5690: }
1.795 www 5691:
1.424 albertel 5692: table.LC_group_priv_box td.LC_groups_functionality {
5693: background: $data_table_darker;
5694: text-align: center;
5695: font-weight: bold;
5696: }
1.795 www 5697:
1.424 albertel 5698: table.LC_group_priv td {
5699: text-align: left;
1.803 bisitz 5700: padding: 0;
1.424 albertel 5701: }
5702:
5703: .LC_navbuttons {
5704: margin: 2ex 0ex 2ex 0ex;
5705: }
1.795 www 5706:
1.423 albertel 5707: .LC_topic_bar {
5708: font-weight: bold;
5709: background: $tabbg;
1.918 wenzelju 5710: margin: 1em 0em 1em 2em;
1.805 bisitz 5711: padding: 3px;
1.918 wenzelju 5712: font-size: 1.2em;
1.423 albertel 5713: }
1.795 www 5714:
1.423 albertel 5715: .LC_topic_bar span {
1.918 wenzelju 5716: left: 0.5em;
5717: position: absolute;
1.423 albertel 5718: vertical-align: middle;
1.918 wenzelju 5719: font-size: 1.2em;
1.423 albertel 5720: }
1.795 www 5721:
1.423 albertel 5722: table.LC_course_group_status {
5723: margin: 20px;
5724: }
1.795 www 5725:
1.423 albertel 5726: table.LC_status_selector td {
5727: vertical-align: top;
5728: text-align: center;
1.424 albertel 5729: padding: 4px;
5730: }
1.795 www 5731:
1.599 albertel 5732: div.LC_feedback_link {
1.616 albertel 5733: clear: both;
1.829 kalberla 5734: background: $sidebg;
1.779 bisitz 5735: width: 100%;
1.829 kalberla 5736: padding-bottom: 10px;
5737: border: 1px $tabbg solid;
1.833 kalberla 5738: height: 22px;
5739: line-height: 22px;
5740: padding-top: 5px;
5741: }
5742:
5743: div.LC_feedback_link img {
5744: height: 22px;
1.867 kalberla 5745: vertical-align:middle;
1.829 kalberla 5746: }
5747:
1.911 bisitz 5748: div.LC_feedback_link a {
1.829 kalberla 5749: text-decoration: none;
1.489 raeburn 5750: }
1.795 www 5751:
1.867 kalberla 5752: div.LC_comblock {
1.911 bisitz 5753: display:inline;
1.867 kalberla 5754: color:$font;
5755: font-size:90%;
5756: }
5757:
5758: div.LC_feedback_link div.LC_comblock {
5759: padding-left:5px;
5760: }
5761:
5762: div.LC_feedback_link div.LC_comblock a {
5763: color:$font;
5764: }
5765:
1.489 raeburn 5766: span.LC_feedback_link {
1.858 bisitz 5767: /* background: $feedback_link_bg; */
1.599 albertel 5768: font-size: larger;
5769: }
1.795 www 5770:
1.599 albertel 5771: span.LC_message_link {
1.858 bisitz 5772: /* background: $feedback_link_bg; */
1.599 albertel 5773: font-size: larger;
5774: position: absolute;
5775: right: 1em;
1.489 raeburn 5776: }
1.421 albertel 5777:
1.515 albertel 5778: table.LC_prior_tries {
1.524 albertel 5779: border: 1px solid #000000;
5780: border-collapse: separate;
5781: border-spacing: 1px;
1.515 albertel 5782: }
1.523 albertel 5783:
1.515 albertel 5784: table.LC_prior_tries td {
1.524 albertel 5785: padding: 2px;
1.515 albertel 5786: }
1.523 albertel 5787:
5788: .LC_answer_correct {
1.795 www 5789: background: lightgreen;
5790: color: darkgreen;
5791: padding: 6px;
1.523 albertel 5792: }
1.795 www 5793:
1.523 albertel 5794: .LC_answer_charged_try {
1.797 www 5795: background: #FFAAAA;
1.795 www 5796: color: darkred;
5797: padding: 6px;
1.523 albertel 5798: }
1.795 www 5799:
1.779 bisitz 5800: .LC_answer_not_charged_try,
1.523 albertel 5801: .LC_answer_no_grade,
5802: .LC_answer_late {
1.795 www 5803: background: lightyellow;
1.523 albertel 5804: color: black;
1.795 www 5805: padding: 6px;
1.523 albertel 5806: }
1.795 www 5807:
1.523 albertel 5808: .LC_answer_previous {
1.795 www 5809: background: lightblue;
5810: color: darkblue;
5811: padding: 6px;
1.523 albertel 5812: }
1.795 www 5813:
1.779 bisitz 5814: .LC_answer_no_message {
1.777 tempelho 5815: background: #FFFFFF;
5816: color: black;
1.795 www 5817: padding: 6px;
1.779 bisitz 5818: }
1.795 www 5819:
1.779 bisitz 5820: .LC_answer_unknown {
5821: background: orange;
5822: color: black;
1.795 www 5823: padding: 6px;
1.777 tempelho 5824: }
1.795 www 5825:
1.529 albertel 5826: span.LC_prior_numerical,
5827: span.LC_prior_string,
5828: span.LC_prior_custom,
5829: span.LC_prior_reaction,
5830: span.LC_prior_math {
1.925 bisitz 5831: font-family: $mono;
1.523 albertel 5832: white-space: pre;
5833: }
5834:
1.525 albertel 5835: span.LC_prior_string {
1.925 bisitz 5836: font-family: $mono;
1.525 albertel 5837: white-space: pre;
5838: }
5839:
1.523 albertel 5840: table.LC_prior_option {
5841: width: 100%;
5842: border-collapse: collapse;
5843: }
1.795 www 5844:
1.911 bisitz 5845: table.LC_prior_rank,
1.795 www 5846: table.LC_prior_match {
1.528 albertel 5847: border-collapse: collapse;
5848: }
1.795 www 5849:
1.528 albertel 5850: table.LC_prior_option tr td,
5851: table.LC_prior_rank tr td,
5852: table.LC_prior_match tr td {
1.524 albertel 5853: border: 1px solid #000000;
1.515 albertel 5854: }
5855:
1.855 bisitz 5856: .LC_nobreak {
1.544 albertel 5857: white-space: nowrap;
1.519 raeburn 5858: }
5859:
1.576 raeburn 5860: span.LC_cusr_emph {
5861: font-style: italic;
5862: }
5863:
1.633 raeburn 5864: span.LC_cusr_subheading {
5865: font-weight: normal;
5866: font-size: 85%;
5867: }
5868:
1.861 bisitz 5869: div.LC_docs_entry_move {
1.859 bisitz 5870: border: 1px solid #BBBBBB;
1.545 albertel 5871: background: #DDDDDD;
1.861 bisitz 5872: width: 22px;
1.859 bisitz 5873: padding: 1px;
5874: margin: 0;
1.545 albertel 5875: }
5876:
1.861 bisitz 5877: table.LC_data_table tr > td.LC_docs_entry_commands,
5878: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 5879: background: #DDDDDD;
5880: font-size: x-small;
5881: }
1.795 www 5882:
1.861 bisitz 5883: .LC_docs_entry_parameter {
5884: white-space: nowrap;
5885: }
5886:
1.544 albertel 5887: .LC_docs_copy {
1.545 albertel 5888: color: #000099;
1.544 albertel 5889: }
1.795 www 5890:
1.544 albertel 5891: .LC_docs_cut {
1.545 albertel 5892: color: #550044;
1.544 albertel 5893: }
1.795 www 5894:
1.544 albertel 5895: .LC_docs_rename {
1.545 albertel 5896: color: #009900;
1.544 albertel 5897: }
1.795 www 5898:
1.544 albertel 5899: .LC_docs_remove {
1.545 albertel 5900: color: #990000;
5901: }
5902:
1.547 albertel 5903: .LC_docs_reinit_warn,
5904: .LC_docs_ext_edit {
5905: font-size: x-small;
5906: }
5907:
1.545 albertel 5908: table.LC_docs_adddocs td,
5909: table.LC_docs_adddocs th {
5910: border: 1px solid #BBBBBB;
5911: padding: 4px;
5912: background: #DDDDDD;
1.543 albertel 5913: }
5914:
1.584 albertel 5915: table.LC_sty_begin {
5916: background: #BBFFBB;
5917: }
1.795 www 5918:
1.584 albertel 5919: table.LC_sty_end {
5920: background: #FFBBBB;
5921: }
5922:
1.589 raeburn 5923: table.LC_double_column {
1.803 bisitz 5924: border-width: 0;
1.589 raeburn 5925: border-collapse: collapse;
5926: width: 100%;
5927: padding: 2px;
5928: }
5929:
5930: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5931: top: 2px;
1.589 raeburn 5932: left: 2px;
5933: width: 47%;
5934: vertical-align: top;
5935: }
5936:
5937: table.LC_double_column tr td.LC_right_col {
5938: top: 2px;
1.779 bisitz 5939: right: 2px;
1.589 raeburn 5940: width: 47%;
5941: vertical-align: top;
5942: }
5943:
1.591 raeburn 5944: div.LC_left_float {
5945: float: left;
5946: padding-right: 5%;
1.597 albertel 5947: padding-bottom: 4px;
1.591 raeburn 5948: }
5949:
5950: div.LC_clear_float_header {
1.597 albertel 5951: padding-bottom: 2px;
1.591 raeburn 5952: }
5953:
5954: div.LC_clear_float_footer {
1.597 albertel 5955: padding-top: 10px;
1.591 raeburn 5956: clear: both;
5957: }
5958:
1.597 albertel 5959: div.LC_grade_show_user {
1.941 bisitz 5960: /* border-left: 5px solid $sidebg; */
5961: border-top: 5px solid #000000;
5962: margin: 50px 0 0 0;
1.936 bisitz 5963: padding: 15px 0 5px 10px;
1.597 albertel 5964: }
1.795 www 5965:
1.936 bisitz 5966: div.LC_grade_show_user_odd_row {
1.941 bisitz 5967: /* border-left: 5px solid #000000; */
5968: }
5969:
5970: div.LC_grade_show_user div.LC_Box {
5971: margin-right: 50px;
1.597 albertel 5972: }
5973:
5974: div.LC_grade_submissions,
5975: div.LC_grade_message_center,
1.936 bisitz 5976: div.LC_grade_info_links {
1.597 albertel 5977: margin: 5px;
5978: width: 99%;
5979: background: #FFFFFF;
5980: }
1.795 www 5981:
1.597 albertel 5982: div.LC_grade_submissions_header,
1.936 bisitz 5983: div.LC_grade_message_center_header {
1.705 tempelho 5984: font-weight: bold;
5985: font-size: large;
1.597 albertel 5986: }
1.795 www 5987:
1.597 albertel 5988: div.LC_grade_submissions_body,
1.936 bisitz 5989: div.LC_grade_message_center_body {
1.597 albertel 5990: border: 1px solid black;
5991: width: 99%;
5992: background: #FFFFFF;
5993: }
1.795 www 5994:
1.613 albertel 5995: table.LC_scantron_action {
5996: width: 100%;
5997: }
1.795 www 5998:
1.613 albertel 5999: table.LC_scantron_action tr th {
1.698 harmsja 6000: font-weight:bold;
6001: font-style:normal;
1.613 albertel 6002: }
1.795 www 6003:
1.779 bisitz 6004: .LC_edit_problem_header,
1.614 albertel 6005: div.LC_edit_problem_footer {
1.705 tempelho 6006: font-weight: normal;
6007: font-size: medium;
1.602 albertel 6008: margin: 2px;
1.600 albertel 6009: }
1.795 www 6010:
1.600 albertel 6011: div.LC_edit_problem_header,
1.602 albertel 6012: div.LC_edit_problem_header div,
1.614 albertel 6013: div.LC_edit_problem_footer,
6014: div.LC_edit_problem_footer div,
1.602 albertel 6015: div.LC_edit_problem_editxml_header,
6016: div.LC_edit_problem_editxml_header div {
1.600 albertel 6017: margin-top: 5px;
6018: }
1.795 www 6019:
1.600 albertel 6020: div.LC_edit_problem_header_title {
1.705 tempelho 6021: font-weight: bold;
6022: font-size: larger;
1.602 albertel 6023: background: $tabbg;
6024: padding: 3px;
6025: }
1.795 www 6026:
1.602 albertel 6027: table.LC_edit_problem_header_title {
6028: width: 100%;
1.600 albertel 6029: background: $tabbg;
1.602 albertel 6030: }
6031:
6032: div.LC_edit_problem_discards {
6033: float: left;
6034: padding-bottom: 5px;
6035: }
1.795 www 6036:
1.602 albertel 6037: div.LC_edit_problem_saves {
6038: float: right;
6039: padding-bottom: 5px;
1.600 albertel 6040: }
1.795 www 6041:
1.911 bisitz 6042: img.stift {
1.803 bisitz 6043: border-width: 0;
6044: vertical-align: middle;
1.677 riegler 6045: }
1.680 riegler 6046:
1.923 bisitz 6047: table td.LC_mainmenu_col_fieldset {
1.680 riegler 6048: vertical-align: top;
1.777 tempelho 6049: }
1.795 www 6050:
1.716 raeburn 6051: div.LC_createcourse {
1.911 bisitz 6052: margin: 10px 10px 10px 10px;
1.716 raeburn 6053: }
6054:
1.917 raeburn 6055: .LC_dccid {
6056: margin: 0.2em 0 0 0;
6057: padding: 0;
6058: font-size: 90%;
6059: display:none;
6060: }
6061:
1.698 harmsja 6062: a:hover,
1.897 wenzelju 6063: ol.LC_primary_menu a:hover,
1.721 harmsja 6064: ol#LC_MenuBreadcrumbs a:hover,
6065: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 6066: ul#LC_secondary_menu a:hover,
1.721 harmsja 6067: .LC_FormSectionClearButton input:hover
1.795 www 6068: ul.LC_TabContent li:hover a {
1.952 onken 6069: color:$button_hover;
1.911 bisitz 6070: text-decoration:none;
1.693 droeschl 6071: }
6072:
1.779 bisitz 6073: h1 {
1.911 bisitz 6074: padding: 0;
6075: line-height:130%;
1.693 droeschl 6076: }
1.698 harmsja 6077:
1.911 bisitz 6078: h2,
6079: h3,
6080: h4,
6081: h5,
6082: h6 {
6083: margin: 5px 0 5px 0;
6084: padding: 0;
6085: line-height:130%;
1.693 droeschl 6086: }
1.795 www 6087:
6088: .LC_hcell {
1.911 bisitz 6089: padding:3px 15px 3px 15px;
6090: margin: 0;
6091: background-color:$tabbg;
6092: color:$fontmenu;
6093: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 6094: }
1.795 www 6095:
1.840 bisitz 6096: .LC_Box > .LC_hcell {
1.911 bisitz 6097: margin: 0 -10px 10px -10px;
1.835 bisitz 6098: }
6099:
1.721 harmsja 6100: .LC_noBorder {
1.911 bisitz 6101: border: 0;
1.698 harmsja 6102: }
1.693 droeschl 6103:
1.721 harmsja 6104: .LC_FormSectionClearButton input {
1.911 bisitz 6105: background-color:transparent;
6106: border: none;
6107: cursor:pointer;
6108: text-decoration:underline;
1.693 droeschl 6109: }
1.763 bisitz 6110:
6111: .LC_help_open_topic {
1.911 bisitz 6112: color: #FFFFFF;
6113: background-color: #EEEEFF;
6114: margin: 1px;
6115: padding: 4px;
6116: border: 1px solid #000033;
6117: white-space: nowrap;
6118: /* vertical-align: middle; */
1.759 neumanie 6119: }
1.693 droeschl 6120:
1.911 bisitz 6121: dl,
6122: ul,
6123: div,
6124: fieldset {
6125: margin: 10px 10px 10px 0;
6126: /* overflow: hidden; */
1.693 droeschl 6127: }
1.795 www 6128:
1.838 bisitz 6129: fieldset > legend {
1.911 bisitz 6130: font-weight: bold;
6131: padding: 0 5px 0 5px;
1.838 bisitz 6132: }
6133:
1.813 bisitz 6134: #LC_nav_bar {
1.911 bisitz 6135: float: left;
1.995 raeburn 6136: background-color: $pgbg_or_bgcolor;
1.966 bisitz 6137: margin: 0 0 2px 0;
1.807 droeschl 6138: }
6139:
1.916 droeschl 6140: #LC_realm {
6141: margin: 0.2em 0 0 0;
6142: padding: 0;
6143: font-weight: bold;
6144: text-align: center;
1.995 raeburn 6145: background-color: $pgbg_or_bgcolor;
1.916 droeschl 6146: }
6147:
1.911 bisitz 6148: #LC_nav_bar em {
6149: font-weight: bold;
6150: font-style: normal;
1.807 droeschl 6151: }
6152:
1.897 wenzelju 6153: ol.LC_primary_menu {
1.911 bisitz 6154: float: right;
1.934 droeschl 6155: margin: 0;
1.995 raeburn 6156: background-color: $pgbg_or_bgcolor;
1.807 droeschl 6157: }
6158:
1.852 droeschl 6159: ol#LC_PathBreadcrumbs {
1.911 bisitz 6160: margin: 0;
1.693 droeschl 6161: }
6162:
1.897 wenzelju 6163: ol.LC_primary_menu li {
1.911 bisitz 6164: display: inline;
6165: padding: 5px 5px 0 10px;
6166: vertical-align: top;
1.693 droeschl 6167: }
6168:
1.897 wenzelju 6169: ol.LC_primary_menu li img {
1.911 bisitz 6170: vertical-align: bottom;
1.934 droeschl 6171: height: 1.1em;
1.693 droeschl 6172: }
6173:
1.897 wenzelju 6174: ol.LC_primary_menu a {
1.911 bisitz 6175: color: RGB(80, 80, 80);
6176: text-decoration: none;
1.693 droeschl 6177: }
1.795 www 6178:
1.949 droeschl 6179: ol.LC_primary_menu a.LC_new_message {
6180: font-weight:bold;
6181: color: darkred;
6182: }
6183:
1.975 raeburn 6184: ol.LC_docs_parameters {
6185: margin-left: 0;
6186: padding: 0;
6187: list-style: none;
6188: }
6189:
6190: ol.LC_docs_parameters li {
6191: margin: 0;
6192: padding-right: 20px;
6193: display: inline;
6194: }
6195:
1.976 raeburn 6196: ol.LC_docs_parameters li:before {
6197: content: "\\002022 \\0020";
6198: }
6199:
6200: li.LC_docs_parameters_title {
6201: font-weight: bold;
6202: }
6203:
6204: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
6205: content: "";
6206: }
6207:
1.897 wenzelju 6208: ul#LC_secondary_menu {
1.911 bisitz 6209: clear: both;
6210: color: $fontmenu;
6211: background: $tabbg;
6212: list-style: none;
6213: padding: 0;
6214: margin: 0;
6215: width: 100%;
1.995 raeburn 6216: text-align: left;
1.808 droeschl 6217: }
6218:
1.897 wenzelju 6219: ul#LC_secondary_menu li {
1.911 bisitz 6220: font-weight: bold;
6221: line-height: 1.8em;
6222: padding: 0 0.8em;
6223: border-right: 1px solid black;
6224: display: inline;
6225: vertical-align: middle;
1.807 droeschl 6226: }
6227:
1.847 tempelho 6228: ul.LC_TabContent {
1.911 bisitz 6229: display:block;
6230: background: $sidebg;
6231: border-bottom: solid 1px $lg_border_color;
6232: list-style:none;
1.1020 raeburn 6233: margin: -1px -10px 0 -10px;
1.911 bisitz 6234: padding: 0;
1.693 droeschl 6235: }
6236:
1.795 www 6237: ul.LC_TabContent li,
6238: ul.LC_TabContentBigger li {
1.911 bisitz 6239: float:left;
1.741 harmsja 6240: }
1.795 www 6241:
1.897 wenzelju 6242: ul#LC_secondary_menu li a {
1.911 bisitz 6243: color: $fontmenu;
6244: text-decoration: none;
1.693 droeschl 6245: }
1.795 www 6246:
1.721 harmsja 6247: ul.LC_TabContent {
1.952 onken 6248: min-height:20px;
1.721 harmsja 6249: }
1.795 www 6250:
6251: ul.LC_TabContent li {
1.911 bisitz 6252: vertical-align:middle;
1.959 onken 6253: padding: 0 16px 0 10px;
1.911 bisitz 6254: background-color:$tabbg;
6255: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 6256: border-left: solid 1px $font;
1.721 harmsja 6257: }
1.795 www 6258:
1.847 tempelho 6259: ul.LC_TabContent .right {
1.911 bisitz 6260: float:right;
1.847 tempelho 6261: }
6262:
1.911 bisitz 6263: ul.LC_TabContent li a,
6264: ul.LC_TabContent li {
6265: color:rgb(47,47,47);
6266: text-decoration:none;
6267: font-size:95%;
6268: font-weight:bold;
1.952 onken 6269: min-height:20px;
6270: }
6271:
1.959 onken 6272: ul.LC_TabContent li a:hover,
6273: ul.LC_TabContent li a:focus {
1.952 onken 6274: color: $button_hover;
1.959 onken 6275: background:none;
6276: outline:none;
1.952 onken 6277: }
6278:
6279: ul.LC_TabContent li:hover {
6280: color: $button_hover;
6281: cursor:pointer;
1.721 harmsja 6282: }
1.795 www 6283:
1.911 bisitz 6284: ul.LC_TabContent li.active {
1.952 onken 6285: color: $font;
1.911 bisitz 6286: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 6287: border-bottom:solid 1px #FFFFFF;
6288: cursor: default;
1.744 ehlerst 6289: }
1.795 www 6290:
1.959 onken 6291: ul.LC_TabContent li.active a {
6292: color:$font;
6293: background:#FFFFFF;
6294: outline: none;
6295: }
1.870 tempelho 6296: #maincoursedoc {
1.911 bisitz 6297: clear:both;
1.870 tempelho 6298: }
6299:
6300: ul.LC_TabContentBigger {
1.911 bisitz 6301: display:block;
6302: list-style:none;
6303: padding: 0;
1.870 tempelho 6304: }
6305:
1.795 www 6306: ul.LC_TabContentBigger li {
1.911 bisitz 6307: vertical-align:bottom;
6308: height: 30px;
6309: font-size:110%;
6310: font-weight:bold;
6311: color: #737373;
1.841 tempelho 6312: }
6313:
1.957 onken 6314: ul.LC_TabContentBigger li.active {
6315: position: relative;
6316: top: 1px;
6317: }
6318:
1.870 tempelho 6319: ul.LC_TabContentBigger li a {
1.911 bisitz 6320: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6321: height: 30px;
6322: line-height: 30px;
6323: text-align: center;
6324: display: block;
6325: text-decoration: none;
1.958 onken 6326: outline: none;
1.741 harmsja 6327: }
1.795 www 6328:
1.870 tempelho 6329: ul.LC_TabContentBigger li.active a {
1.911 bisitz 6330: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6331: color:$font;
1.744 ehlerst 6332: }
1.795 www 6333:
1.870 tempelho 6334: ul.LC_TabContentBigger li b {
1.911 bisitz 6335: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
6336: display: block;
6337: float: left;
6338: padding: 0 30px;
1.957 onken 6339: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 6340: }
6341:
1.956 onken 6342: ul.LC_TabContentBigger li:hover b {
6343: color:$button_hover;
6344: }
6345:
1.870 tempelho 6346: ul.LC_TabContentBigger li.active b {
1.911 bisitz 6347: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
6348: color:$font;
1.957 onken 6349: border: 0;
1.741 harmsja 6350: }
1.693 droeschl 6351:
1.870 tempelho 6352:
1.862 bisitz 6353: ul.LC_CourseBreadcrumbs {
6354: background: $sidebg;
1.1020 raeburn 6355: height: 2em;
1.862 bisitz 6356: padding-left: 10px;
1.1020 raeburn 6357: margin: 0;
1.862 bisitz 6358: list-style-position: inside;
6359: }
6360:
1.911 bisitz 6361: ol#LC_MenuBreadcrumbs,
1.862 bisitz 6362: ol#LC_PathBreadcrumbs {
1.911 bisitz 6363: padding-left: 10px;
6364: margin: 0;
1.933 droeschl 6365: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 6366: }
6367:
1.911 bisitz 6368: ol#LC_MenuBreadcrumbs li,
6369: ol#LC_PathBreadcrumbs li,
1.862 bisitz 6370: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 6371: display: inline;
1.933 droeschl 6372: white-space: normal;
1.693 droeschl 6373: }
6374:
1.823 bisitz 6375: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 6376: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 6377: text-decoration: none;
6378: font-size:90%;
1.693 droeschl 6379: }
1.795 www 6380:
1.969 droeschl 6381: ol#LC_MenuBreadcrumbs h1 {
6382: display: inline;
6383: font-size: 90%;
6384: line-height: 2.5em;
6385: margin: 0;
6386: padding: 0;
6387: }
6388:
1.795 www 6389: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 6390: text-decoration:none;
6391: font-size:100%;
6392: font-weight:bold;
1.693 droeschl 6393: }
1.795 www 6394:
1.840 bisitz 6395: .LC_Box {
1.911 bisitz 6396: border: solid 1px $lg_border_color;
6397: padding: 0 10px 10px 10px;
1.746 neumanie 6398: }
1.795 www 6399:
1.1020 raeburn 6400: .LC_DocsBox {
6401: border: solid 1px $lg_border_color;
6402: padding: 0 0 10px 10px;
6403: }
6404:
1.795 www 6405: .LC_AboutMe_Image {
1.911 bisitz 6406: float:left;
6407: margin-right:10px;
1.747 neumanie 6408: }
1.795 www 6409:
6410: .LC_Clear_AboutMe_Image {
1.911 bisitz 6411: clear:left;
1.747 neumanie 6412: }
1.795 www 6413:
1.721 harmsja 6414: dl.LC_ListStyleClean dt {
1.911 bisitz 6415: padding-right: 5px;
6416: display: table-header-group;
1.693 droeschl 6417: }
6418:
1.721 harmsja 6419: dl.LC_ListStyleClean dd {
1.911 bisitz 6420: display: table-row;
1.693 droeschl 6421: }
6422:
1.721 harmsja 6423: .LC_ListStyleClean,
6424: .LC_ListStyleSimple,
6425: .LC_ListStyleNormal,
1.795 www 6426: .LC_ListStyleSpecial {
1.911 bisitz 6427: /* display:block; */
6428: list-style-position: inside;
6429: list-style-type: none;
6430: overflow: hidden;
6431: padding: 0;
1.693 droeschl 6432: }
6433:
1.721 harmsja 6434: .LC_ListStyleSimple li,
6435: .LC_ListStyleSimple dd,
6436: .LC_ListStyleNormal li,
6437: .LC_ListStyleNormal dd,
6438: .LC_ListStyleSpecial li,
1.795 www 6439: .LC_ListStyleSpecial dd {
1.911 bisitz 6440: margin: 0;
6441: padding: 5px 5px 5px 10px;
6442: clear: both;
1.693 droeschl 6443: }
6444:
1.721 harmsja 6445: .LC_ListStyleClean li,
6446: .LC_ListStyleClean dd {
1.911 bisitz 6447: padding-top: 0;
6448: padding-bottom: 0;
1.693 droeschl 6449: }
6450:
1.721 harmsja 6451: .LC_ListStyleSimple dd,
1.795 www 6452: .LC_ListStyleSimple li {
1.911 bisitz 6453: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6454: }
6455:
1.721 harmsja 6456: .LC_ListStyleSpecial li,
6457: .LC_ListStyleSpecial dd {
1.911 bisitz 6458: list-style-type: none;
6459: background-color: RGB(220, 220, 220);
6460: margin-bottom: 4px;
1.693 droeschl 6461: }
6462:
1.721 harmsja 6463: table.LC_SimpleTable {
1.911 bisitz 6464: margin:5px;
6465: border:solid 1px $lg_border_color;
1.795 www 6466: }
1.693 droeschl 6467:
1.721 harmsja 6468: table.LC_SimpleTable tr {
1.911 bisitz 6469: padding: 0;
6470: border:solid 1px $lg_border_color;
1.693 droeschl 6471: }
1.795 www 6472:
6473: table.LC_SimpleTable thead {
1.911 bisitz 6474: background:rgb(220,220,220);
1.693 droeschl 6475: }
6476:
1.721 harmsja 6477: div.LC_columnSection {
1.911 bisitz 6478: display: block;
6479: clear: both;
6480: overflow: hidden;
6481: margin: 0;
1.693 droeschl 6482: }
6483:
1.721 harmsja 6484: div.LC_columnSection>* {
1.911 bisitz 6485: float: left;
6486: margin: 10px 20px 10px 0;
6487: overflow:hidden;
1.693 droeschl 6488: }
1.721 harmsja 6489:
1.795 www 6490: table em {
1.911 bisitz 6491: font-weight: bold;
6492: font-style: normal;
1.748 schulted 6493: }
1.795 www 6494:
1.779 bisitz 6495: table.LC_tableBrowseRes,
1.795 www 6496: table.LC_tableOfContent {
1.911 bisitz 6497: border:none;
6498: border-spacing: 1px;
6499: padding: 3px;
6500: background-color: #FFFFFF;
6501: font-size: 90%;
1.753 droeschl 6502: }
1.789 droeschl 6503:
1.911 bisitz 6504: table.LC_tableOfContent {
6505: border-collapse: collapse;
1.789 droeschl 6506: }
6507:
1.771 droeschl 6508: table.LC_tableBrowseRes a,
1.768 schulted 6509: table.LC_tableOfContent a {
1.911 bisitz 6510: background-color: transparent;
6511: text-decoration: none;
1.753 droeschl 6512: }
6513:
1.795 www 6514: table.LC_tableOfContent img {
1.911 bisitz 6515: border: none;
6516: height: 1.3em;
6517: vertical-align: text-bottom;
6518: margin-right: 0.3em;
1.753 droeschl 6519: }
1.757 schulted 6520:
1.795 www 6521: a#LC_content_toolbar_firsthomework {
1.911 bisitz 6522: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 6523: }
6524:
1.795 www 6525: a#LC_content_toolbar_everything {
1.911 bisitz 6526: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 6527: }
6528:
1.795 www 6529: a#LC_content_toolbar_uncompleted {
1.911 bisitz 6530: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 6531: }
6532:
1.795 www 6533: #LC_content_toolbar_clearbubbles {
1.911 bisitz 6534: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 6535: }
6536:
1.795 www 6537: a#LC_content_toolbar_changefolder {
1.911 bisitz 6538: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 6539: }
6540:
1.795 www 6541: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 6542: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 6543: }
6544:
1.795 www 6545: ul#LC_toolbar li a:hover {
1.911 bisitz 6546: background-position: bottom center;
1.757 schulted 6547: }
6548:
1.795 www 6549: ul#LC_toolbar {
1.911 bisitz 6550: padding: 0;
6551: margin: 2px;
6552: list-style:none;
6553: position:relative;
6554: background-color:white;
1.757 schulted 6555: }
6556:
1.795 www 6557: ul#LC_toolbar li {
1.911 bisitz 6558: border:1px solid white;
6559: padding: 0;
6560: margin: 0;
6561: float: left;
6562: display:inline;
6563: vertical-align:middle;
6564: }
1.757 schulted 6565:
1.783 amueller 6566:
1.795 www 6567: a.LC_toolbarItem {
1.911 bisitz 6568: display:block;
6569: padding: 0;
6570: margin: 0;
6571: height: 32px;
6572: width: 32px;
6573: color:white;
6574: border: none;
6575: background-repeat:no-repeat;
6576: background-color:transparent;
1.757 schulted 6577: }
6578:
1.915 droeschl 6579: ul.LC_funclist {
6580: margin: 0;
6581: padding: 0.5em 1em 0.5em 0;
6582: }
6583:
1.933 droeschl 6584: ul.LC_funclist > li:first-child {
6585: font-weight:bold;
6586: margin-left:0.8em;
6587: }
6588:
1.915 droeschl 6589: ul.LC_funclist + ul.LC_funclist {
6590: /*
6591: left border as a seperator if we have more than
6592: one list
6593: */
6594: border-left: 1px solid $sidebg;
6595: /*
6596: this hides the left border behind the border of the
6597: outer box if element is wrapped to the next 'line'
6598: */
6599: margin-left: -1px;
6600: }
6601:
1.843 bisitz 6602: ul.LC_funclist li {
1.915 droeschl 6603: display: inline;
1.782 bisitz 6604: white-space: nowrap;
1.915 droeschl 6605: margin: 0 0 0 25px;
6606: line-height: 150%;
1.782 bisitz 6607: }
6608:
1.974 wenzelju 6609: .LC_hidden {
6610: display: none;
6611: }
6612:
1.343 albertel 6613: END
6614: }
6615:
1.306 albertel 6616: =pod
6617:
6618: =item * &headtag()
6619:
6620: Returns a uniform footer for LON-CAPA web pages.
6621:
1.307 albertel 6622: Inputs: $title - optional title for the head
6623: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 6624: $args - optional arguments
1.319 albertel 6625: force_register - if is true call registerurl so the remote is
6626: informed
1.415 albertel 6627: redirect -> array ref of
6628: 1- seconds before redirect occurs
6629: 2- url to redirect to
6630: 3- whether the side effect should occur
1.315 albertel 6631: (side effect of setting
6632: $env{'internal.head.redirect'} to the url
6633: redirected too)
1.352 albertel 6634: domain -> force to color decorate a page for a specific
6635: domain
6636: function -> force usage of a specific rolish color scheme
6637: bgcolor -> override the default page bgcolor
1.460 albertel 6638: no_auto_mt_title
6639: -> prevent &mt()ing the title arg
1.464 albertel 6640:
1.306 albertel 6641: =cut
6642:
6643: sub headtag {
1.313 albertel 6644: my ($title,$head_extra,$args) = @_;
1.306 albertel 6645:
1.363 albertel 6646: my $function = $args->{'function'} || &get_users_function();
6647: my $domain = $args->{'domain'} || &determinedomain();
6648: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 6649: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 6650: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 6651: #time(),
1.418 albertel 6652: $env{'environment.color.timestamp'},
1.363 albertel 6653: $function,$domain,$bgcolor);
6654:
1.369 www 6655: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 6656:
1.308 albertel 6657: my $result =
6658: '<head>'.
1.461 albertel 6659: &font_settings();
1.319 albertel 6660:
1.461 albertel 6661: if (!$args->{'frameset'}) {
6662: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
6663: }
1.962 droeschl 6664: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
6665: $result .= Apache::lonxml::display_title();
1.319 albertel 6666: }
1.436 albertel 6667: if (!$args->{'no_nav_bar'}
6668: && !$args->{'only_body'}
6669: && !$args->{'frameset'}) {
6670: $result .= &help_menu_js();
6671: }
1.319 albertel 6672:
1.314 albertel 6673: if (ref($args->{'redirect'})) {
1.414 albertel 6674: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 6675: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 6676: if (!$inhibit_continue) {
6677: $env{'internal.head.redirect'} = $url;
6678: }
1.313 albertel 6679: $result.=<<ADDMETA
6680: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 6681: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 6682: ADDMETA
6683: }
1.306 albertel 6684: if (!defined($title)) {
6685: $title = 'The LearningOnline Network with CAPA';
6686: }
1.460 albertel 6687: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
6688: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 6689: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
6690: .$head_extra;
1.962 droeschl 6691: return $result.'</head>';
1.306 albertel 6692: }
6693:
6694: =pod
6695:
1.340 albertel 6696: =item * &font_settings()
6697:
6698: Returns neccessary <meta> to set the proper encoding
6699:
6700: Inputs: none
6701:
6702: =cut
6703:
6704: sub font_settings {
6705: my $headerstring='';
1.647 www 6706: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 6707: $headerstring.=
6708: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
6709: }
6710: return $headerstring;
6711: }
6712:
1.341 albertel 6713: =pod
6714:
6715: =item * &xml_begin()
6716:
6717: Returns the needed doctype and <html>
6718:
6719: Inputs: none
6720:
6721: =cut
6722:
6723: sub xml_begin {
6724: my $output='';
6725:
6726: if ($env{'browser.mathml'}) {
6727: $output='<?xml version="1.0"?>'
6728: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
6729: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
6730:
6731: # .'<!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">] >'
6732: .'<!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">'
6733: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
6734: .'xmlns="http://www.w3.org/1999/xhtml">';
6735: } else {
1.849 bisitz 6736: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
6737: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341 albertel 6738: }
6739: return $output;
6740: }
1.340 albertel 6741:
6742: =pod
6743:
1.306 albertel 6744: =item * &start_page()
6745:
6746: Returns a complete <html> .. <body> section for LON-CAPA web pages.
6747:
1.648 raeburn 6748: Inputs:
6749:
6750: =over 4
6751:
6752: $title - optional title for the page
6753:
6754: $head_extra - optional extra HTML to incude inside the <head>
6755:
6756: $args - additional optional args supported are:
6757:
6758: =over 8
6759:
6760: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 6761: arg on
1.814 bisitz 6762: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 6763: add_entries -> additional attributes to add to the <body>
6764: domain -> force to color decorate a page for a
1.317 albertel 6765: specific domain
1.648 raeburn 6766: function -> force usage of a specific rolish color
1.317 albertel 6767: scheme
1.648 raeburn 6768: redirect -> see &headtag()
6769: bgcolor -> override the default page bg color
6770: js_ready -> return a string ready for being used in
1.317 albertel 6771: a javascript writeln
1.648 raeburn 6772: html_encode -> return a string ready for being used in
1.320 albertel 6773: a html attribute
1.648 raeburn 6774: force_register -> if is true will turn on the &bodytag()
1.317 albertel 6775: $forcereg arg
1.648 raeburn 6776: frameset -> if true will start with a <frameset>
1.330 albertel 6777: rather than <body>
1.648 raeburn 6778: skip_phases -> hash ref of
1.338 albertel 6779: head -> skip the <html><head> generation
6780: body -> skip all <body> generation
1.648 raeburn 6781: no_auto_mt_title -> prevent &mt()ing the title arg
6782: inherit_jsmath -> when creating popup window in a page,
6783: should it have jsmath forced on by the
6784: current page
1.867 kalberla 6785: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 6786: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.361 albertel 6787:
1.648 raeburn 6788: =back
1.460 albertel 6789:
1.648 raeburn 6790: =back
1.562 albertel 6791:
1.306 albertel 6792: =cut
6793:
6794: sub start_page {
1.309 albertel 6795: my ($title,$head_extra,$args) = @_;
1.318 albertel 6796: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.964 droeschl 6797: #SD
6798: #I don't see why we copy certain elements of %$args to %head_args
6799: #head args is passed to headtag() and this routine only reads those
6800: #keys that are needed. There doesn't happen any writes or any processing
6801: #of other keys.
6802: #proposal: just pass $args to headtag instead of \%head_args and delete
6803: #marked lines
6804: #<- MARK
1.313 albertel 6805: my %head_args;
1.352 albertel 6806: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6807: 'bgcolor','frameset','no_nav_bar','only_body',
6808: 'no_auto_mt_title') {
1.319 albertel 6809: if (defined($args->{$arg})) {
1.324 raeburn 6810: $head_args{$arg} = $args->{$arg};
1.319 albertel 6811: }
1.313 albertel 6812: }
1.964 droeschl 6813: #MARK ->
1.319 albertel 6814:
1.315 albertel 6815: $env{'internal.start_page'}++;
1.338 albertel 6816: my $result;
1.964 droeschl 6817:
1.338 albertel 6818: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.964 droeschl 6819: $result .=
6820: &xml_begin() . &headtag($title,$head_extra,\%head_args);
6821: #replace prev line by
6822: # &xml_begin() . &headtag($title, $head_extra, $args);
1.338 albertel 6823: }
6824:
6825: if (! exists($args->{'skip_phases'}{'body'}) ) {
6826: if ($args->{'frameset'}) {
6827: my $attr_string = &make_attr_string($args->{'force_register'},
6828: $args->{'add_entries'});
6829: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 6830: } else {
6831: $result .=
6832: &bodytag($title,
6833: $args->{'function'}, $args->{'add_entries'},
6834: $args->{'only_body'}, $args->{'domain'},
6835: $args->{'force_register'}, $args->{'no_nav_bar'},
1.962 droeschl 6836: $args->{'bgcolor'}, $args);
1.831 bisitz 6837: }
1.330 albertel 6838: }
1.338 albertel 6839:
1.315 albertel 6840: if ($args->{'js_ready'}) {
1.713 kaisler 6841: $result = &js_ready($result);
1.315 albertel 6842: }
1.320 albertel 6843: if ($args->{'html_encode'}) {
1.713 kaisler 6844: $result = &html_encode($result);
6845: }
6846:
1.813 bisitz 6847: # Preparation for new and consistent functionlist at top of screen
6848: # if ($args->{'functionlist'}) {
6849: # $result .= &build_functionlist();
6850: #}
6851:
1.964 droeschl 6852: # Don't add anything more if only_body wanted or in const space
6853: return $result if $args->{'only_body'}
6854: || $env{'request.state'} eq 'construct';
1.813 bisitz 6855:
6856: #Breadcrumbs
1.758 kaisler 6857: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
6858: &Apache::lonhtmlcommon::clear_breadcrumbs();
6859: #if any br links exists, add them to the breadcrumbs
6860: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6861: foreach my $crumb (@{$args->{'bread_crumbs'}}){
6862: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
6863: }
6864: }
6865:
6866: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
6867: if(exists($args->{'bread_crumbs_component'})){
6868: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
6869: }else{
6870: $result .= &Apache::lonhtmlcommon::breadcrumbs();
6871: }
1.320 albertel 6872: }
1.315 albertel 6873: return $result;
1.306 albertel 6874: }
6875:
6876: sub end_page {
1.315 albertel 6877: my ($args) = @_;
6878: $env{'internal.end_page'}++;
1.330 albertel 6879: my $result;
1.335 albertel 6880: if ($args->{'discussion'}) {
6881: my ($target,$parser);
6882: if (ref($args->{'discussion'})) {
6883: ($target,$parser) =($args->{'discussion'}{'target'},
6884: $args->{'discussion'}{'parser'});
6885: }
6886: $result .= &Apache::lonxml::xmlend($target,$parser);
6887: }
6888:
1.330 albertel 6889: if ($args->{'frameset'}) {
6890: $result .= '</frameset>';
6891: } else {
1.635 raeburn 6892: $result .= &endbodytag($args);
1.330 albertel 6893: }
6894: $result .= "\n</html>";
6895:
1.315 albertel 6896: if ($args->{'js_ready'}) {
1.317 albertel 6897: $result = &js_ready($result);
1.315 albertel 6898: }
1.335 albertel 6899:
1.320 albertel 6900: if ($args->{'html_encode'}) {
6901: $result = &html_encode($result);
6902: }
1.335 albertel 6903:
1.315 albertel 6904: return $result;
6905: }
6906:
1.320 albertel 6907: sub html_encode {
6908: my ($result) = @_;
6909:
1.322 albertel 6910: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6911:
6912: return $result;
6913: }
1.317 albertel 6914: sub js_ready {
6915: my ($result) = @_;
6916:
1.323 albertel 6917: $result =~ s/[\n\r]/ /xmsg;
6918: $result =~ s/\\/\\\\/xmsg;
6919: $result =~ s/'/\\'/xmsg;
1.372 albertel 6920: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6921:
6922: return $result;
6923: }
6924:
1.315 albertel 6925: sub validate_page {
6926: if ( exists($env{'internal.start_page'})
1.316 albertel 6927: && $env{'internal.start_page'} > 1) {
6928: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6929: $env{'internal.start_page'}.' '.
1.316 albertel 6930: $ENV{'request.filename'});
1.315 albertel 6931: }
6932: if ( exists($env{'internal.end_page'})
1.316 albertel 6933: && $env{'internal.end_page'} > 1) {
6934: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6935: $env{'internal.end_page'}.' '.
1.316 albertel 6936: $env{'request.filename'});
1.315 albertel 6937: }
6938: if ( exists($env{'internal.start_page'})
6939: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6940: &Apache::lonnet::logthis('start_page called without end_page '.
6941: $env{'request.filename'});
1.315 albertel 6942: }
6943: if ( ! exists($env{'internal.start_page'})
6944: && exists($env{'internal.end_page'})) {
1.316 albertel 6945: &Apache::lonnet::logthis('end_page called without start_page'.
6946: $env{'request.filename'});
1.315 albertel 6947: }
1.306 albertel 6948: }
1.315 albertel 6949:
1.996 www 6950:
6951: sub start_scrollbox {
1.1018 raeburn 6952: my ($outerwidth,$width,$height,$id)=@_;
1.998 raeburn 6953: unless ($outerwidth) { $outerwidth='520px'; }
6954: unless ($width) { $width='500px'; }
6955: unless ($height) { $height='200px'; }
1.1020 raeburn 6956: my ($table_id,$div_id);
1.1018 raeburn 6957: if ($id ne '') {
1.1020 raeburn 6958: $table_id = " id='table_$id'";
6959: $div_id = " id='div_$id'";
1.1018 raeburn 6960: }
1.1020 raeburn 6961: return "<table style='width: $outerwidth; border: 1px solid none;'$table_id><tr><td style='width: $width;' bgcolor='#FFFFFF'><div style='overflow:auto; width:$width; height: $height;'$div_id>";
1.996 www 6962: }
6963:
6964: sub end_scrollbox {
1.998 raeburn 6965: return '</td></tr></table>';
1.996 www 6966: }
6967:
1.318 albertel 6968: sub simple_error_page {
6969: my ($r,$title,$msg) = @_;
6970: my $page =
6971: &Apache::loncommon::start_page($title).
6972: &mt($msg).
6973: &Apache::loncommon::end_page();
6974: if (ref($r)) {
6975: $r->print($page);
1.327 albertel 6976: return;
1.318 albertel 6977: }
6978: return $page;
6979: }
1.347 albertel 6980:
6981: {
1.610 albertel 6982: my @row_count;
1.961 onken 6983:
6984: sub start_data_table_count {
6985: unshift(@row_count, 0);
6986: return;
6987: }
6988:
6989: sub end_data_table_count {
6990: shift(@row_count);
6991: return;
6992: }
6993:
1.347 albertel 6994: sub start_data_table {
1.1018 raeburn 6995: my ($add_class,$id) = @_;
1.422 albertel 6996: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 6997: my $table_id;
6998: if (defined($id)) {
6999: $table_id = ' id="'.$id.'"';
7000: }
1.961 onken 7001: &start_data_table_count();
1.1018 raeburn 7002: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 7003: }
7004:
7005: sub end_data_table {
1.961 onken 7006: &end_data_table_count();
1.389 albertel 7007: return '</table>'."\n";;
1.347 albertel 7008: }
7009:
7010: sub start_data_table_row {
1.974 wenzelju 7011: my ($add_class, $id) = @_;
1.610 albertel 7012: $row_count[0]++;
7013: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 7014: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 7015: $id = (' id="'.$id.'"') unless ($id eq '');
7016: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 7017: }
1.471 banghart 7018:
7019: sub continue_data_table_row {
1.974 wenzelju 7020: my ($add_class, $id) = @_;
1.610 albertel 7021: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 7022: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
7023: $id = (' id="'.$id.'"') unless ($id eq '');
7024: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 7025: }
1.347 albertel 7026:
7027: sub end_data_table_row {
1.389 albertel 7028: return '</tr>'."\n";;
1.347 albertel 7029: }
1.367 www 7030:
1.421 albertel 7031: sub start_data_table_empty_row {
1.707 bisitz 7032: # $row_count[0]++;
1.421 albertel 7033: return '<tr class="LC_empty_row" >'."\n";;
7034: }
7035:
7036: sub end_data_table_empty_row {
7037: return '</tr>'."\n";;
7038: }
7039:
1.367 www 7040: sub start_data_table_header_row {
1.389 albertel 7041: return '<tr class="LC_header_row">'."\n";;
1.367 www 7042: }
7043:
7044: sub end_data_table_header_row {
1.389 albertel 7045: return '</tr>'."\n";;
1.367 www 7046: }
1.890 droeschl 7047:
7048: sub data_table_caption {
7049: my $caption = shift;
7050: return "<caption class=\"LC_caption\">$caption</caption>";
7051: }
1.347 albertel 7052: }
7053:
1.548 albertel 7054: =pod
7055:
7056: =item * &inhibit_menu_check($arg)
7057:
7058: Checks for a inhibitmenu state and generates output to preserve it
7059:
7060: Inputs: $arg - can be any of
7061: - undef - in which case the return value is a string
7062: to add into arguments list of a uri
7063: - 'input' - in which case the return value is a HTML
7064: <form> <input> field of type hidden to
7065: preserve the value
7066: - a url - in which case the return value is the url with
7067: the neccesary cgi args added to preserve the
7068: inhibitmenu state
7069: - a ref to a url - no return value, but the string is
7070: updated to include the neccessary cgi
7071: args to preserve the inhibitmenu state
7072:
7073: =cut
7074:
7075: sub inhibit_menu_check {
7076: my ($arg) = @_;
7077: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
7078: if ($arg eq 'input') {
7079: if ($env{'form.inhibitmenu'}) {
7080: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
7081: } else {
7082: return
7083: }
7084: }
7085: if ($env{'form.inhibitmenu'}) {
7086: if (ref($arg)) {
7087: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7088: } elsif ($arg eq '') {
7089: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
7090: } else {
7091: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7092: }
7093: }
7094: if (!ref($arg)) {
7095: return $arg;
7096: }
7097: }
7098:
1.251 albertel 7099: ###############################################
1.182 matthew 7100:
7101: =pod
7102:
1.549 albertel 7103: =back
7104:
7105: =head1 User Information Routines
7106:
7107: =over 4
7108:
1.405 albertel 7109: =item * &get_users_function()
1.182 matthew 7110:
7111: Used by &bodytag to determine the current users primary role.
7112: Returns either 'student','coordinator','admin', or 'author'.
7113:
7114: =cut
7115:
7116: ###############################################
7117: sub get_users_function {
1.815 tempelho 7118: my $function = 'norole';
1.818 tempelho 7119: if ($env{'request.role'}=~/^(st)/) {
7120: $function='student';
7121: }
1.907 raeburn 7122: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 7123: $function='coordinator';
7124: }
1.258 albertel 7125: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 7126: $function='admin';
7127: }
1.826 bisitz 7128: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182 matthew 7129: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
7130: $function='author';
7131: }
7132: return $function;
1.54 www 7133: }
1.99 www 7134:
7135: ###############################################
7136:
1.233 raeburn 7137: =pod
7138:
1.821 raeburn 7139: =item * &show_course()
7140:
7141: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
7142: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
7143:
7144: Inputs:
7145: None
7146:
7147: Outputs:
7148: Scalar: 1 if 'Course' to be used, 0 otherwise.
7149:
7150: =cut
7151:
7152: ###############################################
7153: sub show_course {
7154: my $course = !$env{'user.adv'};
7155: if (!$env{'user.adv'}) {
7156: foreach my $env (keys(%env)) {
7157: next if ($env !~ m/^user\.priv\./);
7158: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
7159: $course = 0;
7160: last;
7161: }
7162: }
7163: }
7164: return $course;
7165: }
7166:
7167: ###############################################
7168:
7169: =pod
7170:
1.542 raeburn 7171: =item * &check_user_status()
1.274 raeburn 7172:
7173: Determines current status of supplied role for a
7174: specific user. Roles can be active, previous or future.
7175:
7176: Inputs:
7177: user's domain, user's username, course's domain,
1.375 raeburn 7178: course's number, optional section ID.
1.274 raeburn 7179:
7180: Outputs:
7181: role status: active, previous or future.
7182:
7183: =cut
7184:
7185: sub check_user_status {
1.412 raeburn 7186: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.982 raeburn 7187: my $extra = &Apache::lonnet::freeze_escape({'skipcheck' => 1});
7188: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname,'.',undef,$extra);
1.274 raeburn 7189: my @uroles = keys %userinfo;
7190: my $srchstr;
7191: my $active_chk = 'none';
1.412 raeburn 7192: my $now = time;
1.274 raeburn 7193: if (@uroles > 0) {
1.908 raeburn 7194: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 7195: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
7196: } else {
1.412 raeburn 7197: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
7198: }
7199: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 7200: my $role_end = 0;
7201: my $role_start = 0;
7202: $active_chk = 'active';
1.412 raeburn 7203: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
7204: $role_end = $1;
7205: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
7206: $role_start = $1;
1.274 raeburn 7207: }
7208: }
7209: if ($role_start > 0) {
1.412 raeburn 7210: if ($now < $role_start) {
1.274 raeburn 7211: $active_chk = 'future';
7212: }
7213: }
7214: if ($role_end > 0) {
1.412 raeburn 7215: if ($now > $role_end) {
1.274 raeburn 7216: $active_chk = 'previous';
7217: }
7218: }
7219: }
7220: }
7221: return $active_chk;
7222: }
7223:
7224: ###############################################
7225:
7226: =pod
7227:
1.405 albertel 7228: =item * &get_sections()
1.233 raeburn 7229:
7230: Determines all the sections for a course including
7231: sections with students and sections containing other roles.
1.419 raeburn 7232: Incoming parameters:
7233:
7234: 1. domain
7235: 2. course number
7236: 3. reference to array containing roles for which sections should
7237: be gathered (optional).
7238: 4. reference to array containing status types for which sections
7239: should be gathered (optional).
7240:
7241: If the third argument is undefined, sections are gathered for any role.
7242: If the fourth argument is undefined, sections are gathered for any status.
7243: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 7244:
1.374 raeburn 7245: Returns section hash (keys are section IDs, values are
7246: number of users in each section), subject to the
1.419 raeburn 7247: optional roles filter, optional status filter
1.233 raeburn 7248:
7249: =cut
7250:
7251: ###############################################
7252: sub get_sections {
1.419 raeburn 7253: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 7254: if (!defined($cdom) || !defined($cnum)) {
7255: my $cid = $env{'request.course.id'};
7256:
7257: return if (!defined($cid));
7258:
7259: $cdom = $env{'course.'.$cid.'.domain'};
7260: $cnum = $env{'course.'.$cid.'.num'};
7261: }
7262:
7263: my %sectioncount;
1.419 raeburn 7264: my $now = time;
1.240 albertel 7265:
1.366 albertel 7266: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 7267: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 7268: my $sec_index = &Apache::loncoursedata::CL_SECTION();
7269: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 7270: my $start_index = &Apache::loncoursedata::CL_START();
7271: my $end_index = &Apache::loncoursedata::CL_END();
7272: my $status;
1.366 albertel 7273: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 7274: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
7275: $data->[$status_index],
7276: $data->[$start_index],
7277: $data->[$end_index]);
7278: if ($stu_status eq 'Active') {
7279: $status = 'active';
7280: } elsif ($end < $now) {
7281: $status = 'previous';
7282: } elsif ($start > $now) {
7283: $status = 'future';
7284: }
7285: if ($section ne '-1' && $section !~ /^\s*$/) {
7286: if ((!defined($possible_status)) || (($status ne '') &&
7287: (grep/^\Q$status\E$/,@{$possible_status}))) {
7288: $sectioncount{$section}++;
7289: }
1.240 albertel 7290: }
7291: }
7292: }
7293: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7294: foreach my $user (sort(keys(%courseroles))) {
7295: if ($user !~ /^(\w{2})/) { next; }
7296: my ($role) = ($user =~ /^(\w{2})/);
7297: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 7298: my ($section,$status);
1.240 albertel 7299: if ($role eq 'cr' &&
7300: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
7301: $section=$1;
7302: }
7303: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
7304: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 7305: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
7306: if ($end == -1 && $start == -1) {
7307: next; #deleted role
7308: }
7309: if (!defined($possible_status)) {
7310: $sectioncount{$section}++;
7311: } else {
7312: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
7313: $status = 'active';
7314: } elsif ($end < $now) {
7315: $status = 'future';
7316: } elsif ($start > $now) {
7317: $status = 'previous';
7318: }
7319: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
7320: $sectioncount{$section}++;
7321: }
7322: }
1.233 raeburn 7323: }
1.366 albertel 7324: return %sectioncount;
1.233 raeburn 7325: }
7326:
1.274 raeburn 7327: ###############################################
1.294 raeburn 7328:
7329: =pod
1.405 albertel 7330:
7331: =item * &get_course_users()
7332:
1.275 raeburn 7333: Retrieves usernames:domains for users in the specified course
7334: with specific role(s), and access status.
7335:
7336: Incoming parameters:
1.277 albertel 7337: 1. course domain
7338: 2. course number
7339: 3. access status: users must have - either active,
1.275 raeburn 7340: previous, future, or all.
1.277 albertel 7341: 4. reference to array of permissible roles
1.288 raeburn 7342: 5. reference to array of section restrictions (optional)
7343: 6. reference to results object (hash of hashes).
7344: 7. reference to optional userdata hash
1.609 raeburn 7345: 8. reference to optional statushash
1.630 raeburn 7346: 9. flag if privileged users (except those set to unhide in
7347: course settings) should be excluded
1.609 raeburn 7348: Keys of top level results hash are roles.
1.275 raeburn 7349: Keys of inner hashes are username:domain, with
7350: values set to access type.
1.288 raeburn 7351: Optional userdata hash returns an array with arguments in the
7352: same order as loncoursedata::get_classlist() for student data.
7353:
1.609 raeburn 7354: Optional statushash returns
7355:
1.288 raeburn 7356: Entries for end, start, section and status are blank because
7357: of the possibility of multiple values for non-student roles.
7358:
1.275 raeburn 7359: =cut
1.405 albertel 7360:
1.275 raeburn 7361: ###############################################
1.405 albertel 7362:
1.275 raeburn 7363: sub get_course_users {
1.630 raeburn 7364: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 7365: my %idx = ();
1.419 raeburn 7366: my %seclists;
1.288 raeburn 7367:
7368: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
7369: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
7370: $idx{end} = &Apache::loncoursedata::CL_END();
7371: $idx{start} = &Apache::loncoursedata::CL_START();
7372: $idx{id} = &Apache::loncoursedata::CL_ID();
7373: $idx{section} = &Apache::loncoursedata::CL_SECTION();
7374: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
7375: $idx{status} = &Apache::loncoursedata::CL_STATUS();
7376:
1.290 albertel 7377: if (grep(/^st$/,@{$roles})) {
1.276 albertel 7378: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 7379: my $now = time;
1.277 albertel 7380: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 7381: my $match = 0;
1.412 raeburn 7382: my $secmatch = 0;
1.419 raeburn 7383: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 7384: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 7385: if ($section eq '') {
7386: $section = 'none';
7387: }
1.291 albertel 7388: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7389: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7390: $secmatch = 1;
7391: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 7392: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7393: $secmatch = 1;
7394: }
7395: } else {
1.419 raeburn 7396: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 7397: $secmatch = 1;
7398: }
1.290 albertel 7399: }
1.412 raeburn 7400: if (!$secmatch) {
7401: next;
7402: }
1.419 raeburn 7403: }
1.275 raeburn 7404: if (defined($$types{'active'})) {
1.288 raeburn 7405: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 7406: push(@{$$users{st}{$student}},'active');
1.288 raeburn 7407: $match = 1;
1.275 raeburn 7408: }
7409: }
7410: if (defined($$types{'previous'})) {
1.609 raeburn 7411: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 7412: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 7413: $match = 1;
1.275 raeburn 7414: }
7415: }
7416: if (defined($$types{'future'})) {
1.609 raeburn 7417: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 7418: push(@{$$users{st}{$student}},'future');
1.288 raeburn 7419: $match = 1;
1.275 raeburn 7420: }
7421: }
1.609 raeburn 7422: if ($match) {
7423: push(@{$seclists{$student}},$section);
7424: if (ref($userdata) eq 'HASH') {
7425: $$userdata{$student} = $$classlist{$student};
7426: }
7427: if (ref($statushash) eq 'HASH') {
7428: $statushash->{$student}{'st'}{$section} = $status;
7429: }
1.288 raeburn 7430: }
1.275 raeburn 7431: }
7432: }
1.412 raeburn 7433: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 7434: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7435: my $now = time;
1.609 raeburn 7436: my %displaystatus = ( previous => 'Expired',
7437: active => 'Active',
7438: future => 'Future',
7439: );
1.630 raeburn 7440: my %nothide;
7441: if ($hidepriv) {
7442: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
7443: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
7444: if ($user !~ /:/) {
7445: $nothide{join(':',split(/[\@]/,$user))}=1;
7446: } else {
7447: $nothide{$user} = 1;
7448: }
7449: }
7450: }
1.439 raeburn 7451: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 7452: my $match = 0;
1.412 raeburn 7453: my $secmatch = 0;
1.439 raeburn 7454: my $status;
1.412 raeburn 7455: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 7456: $user =~ s/:$//;
1.439 raeburn 7457: my ($end,$start) = split(/:/,$coursepersonnel{$person});
7458: if ($end == -1 || $start == -1) {
7459: next;
7460: }
7461: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
7462: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 7463: my ($uname,$udom) = split(/:/,$user);
7464: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7465: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7466: $secmatch = 1;
7467: } elsif ($usec eq '') {
1.420 albertel 7468: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7469: $secmatch = 1;
7470: }
7471: } else {
7472: if (grep(/^\Q$usec\E$/,@{$sections})) {
7473: $secmatch = 1;
7474: }
7475: }
7476: if (!$secmatch) {
7477: next;
7478: }
1.288 raeburn 7479: }
1.419 raeburn 7480: if ($usec eq '') {
7481: $usec = 'none';
7482: }
1.275 raeburn 7483: if ($uname ne '' && $udom ne '') {
1.630 raeburn 7484: if ($hidepriv) {
7485: if ((&Apache::lonnet::privileged($uname,$udom)) &&
7486: (!$nothide{$uname.':'.$udom})) {
7487: next;
7488: }
7489: }
1.503 raeburn 7490: if ($end > 0 && $end < $now) {
1.439 raeburn 7491: $status = 'previous';
7492: } elsif ($start > $now) {
7493: $status = 'future';
7494: } else {
7495: $status = 'active';
7496: }
1.277 albertel 7497: foreach my $type (keys(%{$types})) {
1.275 raeburn 7498: if ($status eq $type) {
1.420 albertel 7499: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 7500: push(@{$$users{$role}{$user}},$type);
7501: }
1.288 raeburn 7502: $match = 1;
7503: }
7504: }
1.419 raeburn 7505: if (($match) && (ref($userdata) eq 'HASH')) {
7506: if (!exists($$userdata{$uname.':'.$udom})) {
7507: &get_user_info($udom,$uname,\%idx,$userdata);
7508: }
1.420 albertel 7509: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 7510: push(@{$seclists{$uname.':'.$udom}},$usec);
7511: }
1.609 raeburn 7512: if (ref($statushash) eq 'HASH') {
7513: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
7514: }
1.275 raeburn 7515: }
7516: }
7517: }
7518: }
1.290 albertel 7519: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 7520: if ((defined($cdom)) && (defined($cnum))) {
7521: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
7522: if ( defined($csettings{'internal.courseowner'}) ) {
7523: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 7524: next if ($owner eq '');
7525: my ($ownername,$ownerdom);
7526: if ($owner =~ /^([^:]+):([^:]+)$/) {
7527: $ownername = $1;
7528: $ownerdom = $2;
7529: } else {
7530: $ownername = $owner;
7531: $ownerdom = $cdom;
7532: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 7533: }
7534: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 7535: if (defined($userdata) &&
1.609 raeburn 7536: !exists($$userdata{$owner})) {
7537: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
7538: if (!grep(/^none$/,@{$seclists{$owner}})) {
7539: push(@{$seclists{$owner}},'none');
7540: }
7541: if (ref($statushash) eq 'HASH') {
7542: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 7543: }
1.290 albertel 7544: }
1.279 raeburn 7545: }
7546: }
7547: }
1.419 raeburn 7548: foreach my $user (keys(%seclists)) {
7549: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
7550: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
7551: }
1.275 raeburn 7552: }
7553: return;
7554: }
7555:
1.288 raeburn 7556: sub get_user_info {
7557: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 7558: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
7559: &plainname($uname,$udom,'lastname');
1.291 albertel 7560: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 7561: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 7562: my %idhash = &Apache::lonnet::idrget($udom,($uname));
7563: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 7564: return;
7565: }
1.275 raeburn 7566:
1.472 raeburn 7567: ###############################################
7568:
7569: =pod
7570:
7571: =item * &get_user_quota()
7572:
7573: Retrieves quota assigned for storage of portfolio files for a user
7574:
7575: Incoming parameters:
7576: 1. user's username
7577: 2. user's domain
7578:
7579: Returns:
1.536 raeburn 7580: 1. Disk quota (in Mb) assigned to student.
7581: 2. (Optional) Type of setting: custom or default
7582: (individually assigned or default for user's
7583: institutional status).
7584: 3. (Optional) - User's institutional status (e.g., faculty, staff
7585: or student - types as defined in localenroll::inst_usertypes
7586: for user's domain, which determines default quota for user.
7587: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 7588:
7589: If a value has been stored in the user's environment,
1.536 raeburn 7590: it will return that, otherwise it returns the maximal default
7591: defined for the user's instituional status(es) in the domain.
1.472 raeburn 7592:
7593: =cut
7594:
7595: ###############################################
7596:
7597:
7598: sub get_user_quota {
7599: my ($uname,$udom) = @_;
1.536 raeburn 7600: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 7601: if (!defined($udom)) {
7602: $udom = $env{'user.domain'};
7603: }
7604: if (!defined($uname)) {
7605: $uname = $env{'user.name'};
7606: }
7607: if (($udom eq '' || $uname eq '') ||
7608: ($udom eq 'public') && ($uname eq 'public')) {
7609: $quota = 0;
1.536 raeburn 7610: $quotatype = 'default';
7611: $defquota = 0;
1.472 raeburn 7612: } else {
1.536 raeburn 7613: my $inststatus;
1.472 raeburn 7614: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
7615: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 7616: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 7617: } else {
1.536 raeburn 7618: my %userenv =
7619: &Apache::lonnet::get('environment',['portfolioquota',
7620: 'inststatus'],$udom,$uname);
1.472 raeburn 7621: my ($tmp) = keys(%userenv);
7622: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7623: $quota = $userenv{'portfolioquota'};
1.536 raeburn 7624: $inststatus = $userenv{'inststatus'};
1.472 raeburn 7625: } else {
7626: undef(%userenv);
7627: }
7628: }
1.536 raeburn 7629: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 7630: if ($quota eq '') {
1.536 raeburn 7631: $quota = $defquota;
7632: $quotatype = 'default';
7633: } else {
7634: $quotatype = 'custom';
1.472 raeburn 7635: }
7636: }
1.536 raeburn 7637: if (wantarray) {
7638: return ($quota,$quotatype,$settingstatus,$defquota);
7639: } else {
7640: return $quota;
7641: }
1.472 raeburn 7642: }
7643:
7644: ###############################################
7645:
7646: =pod
7647:
7648: =item * &default_quota()
7649:
1.536 raeburn 7650: Retrieves default quota assigned for storage of user portfolio files,
7651: given an (optional) user's institutional status.
1.472 raeburn 7652:
7653: Incoming parameters:
7654: 1. domain
1.536 raeburn 7655: 2. (Optional) institutional status(es). This is a : separated list of
7656: status types (e.g., faculty, staff, student etc.)
7657: which apply to the user for whom the default is being retrieved.
7658: If the institutional status string in undefined, the domain
7659: default quota will be returned.
1.472 raeburn 7660:
7661: Returns:
7662: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 7663: 2. (Optional) institutional type which determined the value of the
7664: default quota.
1.472 raeburn 7665:
7666: If a value has been stored in the domain's configuration db,
7667: it will return that, otherwise it returns 20 (for backwards
7668: compatibility with domains which have not set up a configuration
7669: db file; the original statically defined portfolio quota was 20 Mb).
7670:
1.536 raeburn 7671: If the user's status includes multiple types (e.g., staff and student),
7672: the largest default quota which applies to the user determines the
7673: default quota returned.
7674:
1.780 raeburn 7675: =back
7676:
1.472 raeburn 7677: =cut
7678:
7679: ###############################################
7680:
7681:
7682: sub default_quota {
1.536 raeburn 7683: my ($udom,$inststatus) = @_;
7684: my ($defquota,$settingstatus);
7685: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 7686: ['quotas'],$udom);
7687: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 7688: if ($inststatus ne '') {
1.765 raeburn 7689: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 7690: foreach my $item (@statuses) {
1.711 raeburn 7691: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7692: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
7693: if ($defquota eq '') {
7694: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7695: $settingstatus = $item;
7696: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
7697: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7698: $settingstatus = $item;
7699: }
7700: }
7701: } else {
7702: if ($quotahash{'quotas'}{$item} ne '') {
7703: if ($defquota eq '') {
7704: $defquota = $quotahash{'quotas'}{$item};
7705: $settingstatus = $item;
7706: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
7707: $defquota = $quotahash{'quotas'}{$item};
7708: $settingstatus = $item;
7709: }
1.536 raeburn 7710: }
7711: }
7712: }
7713: }
7714: if ($defquota eq '') {
1.711 raeburn 7715: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7716: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
7717: } else {
7718: $defquota = $quotahash{'quotas'}{'default'};
7719: }
1.536 raeburn 7720: $settingstatus = 'default';
7721: }
7722: } else {
7723: $settingstatus = 'default';
7724: $defquota = 20;
7725: }
7726: if (wantarray) {
7727: return ($defquota,$settingstatus);
1.472 raeburn 7728: } else {
1.536 raeburn 7729: return $defquota;
1.472 raeburn 7730: }
7731: }
7732:
1.384 raeburn 7733: sub get_secgrprole_info {
7734: my ($cdom,$cnum,$needroles,$type) = @_;
7735: my %sections_count = &get_sections($cdom,$cnum);
7736: my @sections = (sort {$a <=> $b} keys(%sections_count));
7737: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
7738: my @groups = sort(keys(%curr_groups));
7739: my $allroles = [];
7740: my $rolehash;
7741: my $accesshash = {
7742: active => 'Currently has access',
7743: future => 'Will have future access',
7744: previous => 'Previously had access',
7745: };
7746: if ($needroles) {
7747: $rolehash = {'all' => 'all'};
1.385 albertel 7748: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7749: if (&Apache::lonnet::error(%user_roles)) {
7750: undef(%user_roles);
7751: }
7752: foreach my $item (keys(%user_roles)) {
1.384 raeburn 7753: my ($role)=split(/\:/,$item,2);
7754: if ($role eq 'cr') { next; }
7755: if ($role =~ /^cr/) {
7756: $$rolehash{$role} = (split('/',$role))[3];
7757: } else {
7758: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
7759: }
7760: }
7761: foreach my $key (sort(keys(%{$rolehash}))) {
7762: push(@{$allroles},$key);
7763: }
7764: push (@{$allroles},'st');
7765: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
7766: }
7767: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
7768: }
7769:
1.555 raeburn 7770: sub user_picker {
1.994 raeburn 7771: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context) = @_;
1.555 raeburn 7772: my $currdom = $dom;
7773: my %curr_selected = (
7774: srchin => 'dom',
1.580 raeburn 7775: srchby => 'lastname',
1.555 raeburn 7776: );
7777: my $srchterm;
1.625 raeburn 7778: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 7779: if ($srch->{'srchby'} ne '') {
7780: $curr_selected{'srchby'} = $srch->{'srchby'};
7781: }
7782: if ($srch->{'srchin'} ne '') {
7783: $curr_selected{'srchin'} = $srch->{'srchin'};
7784: }
7785: if ($srch->{'srchtype'} ne '') {
7786: $curr_selected{'srchtype'} = $srch->{'srchtype'};
7787: }
7788: if ($srch->{'srchdomain'} ne '') {
7789: $currdom = $srch->{'srchdomain'};
7790: }
7791: $srchterm = $srch->{'srchterm'};
7792: }
7793: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 7794: 'usr' => 'Search criteria',
1.563 raeburn 7795: 'doma' => 'Domain/institution to search',
1.558 albertel 7796: 'uname' => 'username',
7797: 'lastname' => 'last name',
1.555 raeburn 7798: 'lastfirst' => 'last name, first name',
1.558 albertel 7799: 'crs' => 'in this course',
1.576 raeburn 7800: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 7801: 'alc' => 'all LON-CAPA',
1.573 raeburn 7802: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 7803: 'exact' => 'is',
7804: 'contains' => 'contains',
1.569 raeburn 7805: 'begins' => 'begins with',
1.571 raeburn 7806: 'youm' => "You must include some text to search for.",
7807: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
7808: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
7809: 'yomc' => "You must choose a domain when using an institutional directory search.",
7810: 'ymcd' => "You must choose a domain when using a domain search.",
7811: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
7812: 'whse' => "When searching by last,first you must include at least one character in the first name.",
7813: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 7814: );
1.563 raeburn 7815: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
7816: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 7817:
7818: my @srchins = ('crs','dom','alc','instd');
7819:
7820: foreach my $option (@srchins) {
7821: # FIXME 'alc' option unavailable until
7822: # loncreateuser::print_user_query_page()
7823: # has been completed.
7824: next if ($option eq 'alc');
1.880 raeburn 7825: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 7826: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 7827: if ($curr_selected{'srchin'} eq $option) {
7828: $srchinsel .= '
7829: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7830: } else {
7831: $srchinsel .= '
7832: <option value="'.$option.'">'.$lt{$option}.'</option>';
7833: }
1.555 raeburn 7834: }
1.563 raeburn 7835: $srchinsel .= "\n </select>\n";
1.555 raeburn 7836:
7837: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 7838: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 7839: if ($curr_selected{'srchby'} eq $option) {
7840: $srchbysel .= '
7841: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7842: } else {
7843: $srchbysel .= '
7844: <option value="'.$option.'">'.$lt{$option}.'</option>';
7845: }
7846: }
7847: $srchbysel .= "\n </select>\n";
7848:
7849: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 7850: foreach my $option ('begins','contains','exact') {
1.555 raeburn 7851: if ($curr_selected{'srchtype'} eq $option) {
7852: $srchtypesel .= '
7853: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7854: } else {
7855: $srchtypesel .= '
7856: <option value="'.$option.'">'.$lt{$option}.'</option>';
7857: }
7858: }
7859: $srchtypesel .= "\n </select>\n";
7860:
1.558 albertel 7861: my ($newuserscript,$new_user_create);
1.994 raeburn 7862: my $context_dom = $env{'request.role.domain'};
7863: if ($context eq 'requestcrs') {
7864: if ($env{'form.coursedom'} ne '') {
7865: $context_dom = $env{'form.coursedom'};
7866: }
7867: }
1.556 raeburn 7868: if ($forcenewuser) {
1.576 raeburn 7869: if (ref($srch) eq 'HASH') {
1.994 raeburn 7870: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 7871: if ($cancreate) {
7872: $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>';
7873: } else {
1.799 bisitz 7874: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 7875: my %usertypetext = (
7876: official => 'institutional',
7877: unofficial => 'non-institutional',
7878: );
1.799 bisitz 7879: $new_user_create = '<p class="LC_warning">'
7880: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
7881: .' '
7882: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
7883: ,'<a href="'.$helplink.'">','</a>')
7884: .'</p><br />';
1.627 raeburn 7885: }
1.576 raeburn 7886: }
7887: }
7888:
1.556 raeburn 7889: $newuserscript = <<"ENDSCRIPT";
7890:
1.570 raeburn 7891: function setSearch(createnew,callingForm) {
1.556 raeburn 7892: if (createnew == 1) {
1.570 raeburn 7893: for (var i=0; i<callingForm.srchby.length; i++) {
7894: if (callingForm.srchby.options[i].value == 'uname') {
7895: callingForm.srchby.selectedIndex = i;
1.556 raeburn 7896: }
7897: }
1.570 raeburn 7898: for (var i=0; i<callingForm.srchin.length; i++) {
7899: if ( callingForm.srchin.options[i].value == 'dom') {
7900: callingForm.srchin.selectedIndex = i;
1.556 raeburn 7901: }
7902: }
1.570 raeburn 7903: for (var i=0; i<callingForm.srchtype.length; i++) {
7904: if (callingForm.srchtype.options[i].value == 'exact') {
7905: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 7906: }
7907: }
1.570 raeburn 7908: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 7909: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 7910: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 7911: }
7912: }
7913: }
7914: }
7915: ENDSCRIPT
1.558 albertel 7916:
1.556 raeburn 7917: }
7918:
1.555 raeburn 7919: my $output = <<"END_BLOCK";
1.556 raeburn 7920: <script type="text/javascript">
1.824 bisitz 7921: // <![CDATA[
1.570 raeburn 7922: function validateEntry(callingForm) {
1.558 albertel 7923:
1.556 raeburn 7924: var checkok = 1;
1.558 albertel 7925: var srchin;
1.570 raeburn 7926: for (var i=0; i<callingForm.srchin.length; i++) {
7927: if ( callingForm.srchin[i].checked ) {
7928: srchin = callingForm.srchin[i].value;
1.558 albertel 7929: }
7930: }
7931:
1.570 raeburn 7932: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7933: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7934: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7935: var srchterm = callingForm.srchterm.value;
7936: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7937: var msg = "";
7938:
7939: if (srchterm == "") {
7940: checkok = 0;
1.571 raeburn 7941: msg += "$lt{'youm'}\\n";
1.556 raeburn 7942: }
7943:
1.569 raeburn 7944: if (srchtype== 'begins') {
7945: if (srchterm.length < 2) {
7946: checkok = 0;
1.571 raeburn 7947: msg += "$lt{'thte'}\\n";
1.569 raeburn 7948: }
7949: }
7950:
1.556 raeburn 7951: if (srchtype== 'contains') {
7952: if (srchterm.length < 3) {
7953: checkok = 0;
1.571 raeburn 7954: msg += "$lt{'thet'}\\n";
1.556 raeburn 7955: }
7956: }
7957: if (srchin == 'instd') {
7958: if (srchdomain == '') {
7959: checkok = 0;
1.571 raeburn 7960: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7961: }
7962: }
7963: if (srchin == 'dom') {
7964: if (srchdomain == '') {
7965: checkok = 0;
1.571 raeburn 7966: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7967: }
7968: }
7969: if (srchby == 'lastfirst') {
7970: if (srchterm.indexOf(",") == -1) {
7971: checkok = 0;
1.571 raeburn 7972: msg += "$lt{'whus'}\\n";
1.556 raeburn 7973: }
7974: if (srchterm.indexOf(",") == srchterm.length -1) {
7975: checkok = 0;
1.571 raeburn 7976: msg += "$lt{'whse'}\\n";
1.556 raeburn 7977: }
7978: }
7979: if (checkok == 0) {
1.571 raeburn 7980: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7981: return;
7982: }
7983: if (checkok == 1) {
1.570 raeburn 7984: callingForm.submit();
1.556 raeburn 7985: }
7986: }
7987:
7988: $newuserscript
7989:
1.824 bisitz 7990: // ]]>
1.556 raeburn 7991: </script>
1.558 albertel 7992:
7993: $new_user_create
7994:
1.555 raeburn 7995: END_BLOCK
1.558 albertel 7996:
1.876 raeburn 7997: $output .= &Apache::lonhtmlcommon::start_pick_box().
7998: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
7999: $domform.
8000: &Apache::lonhtmlcommon::row_closure().
8001: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
8002: $srchbysel.
8003: $srchtypesel.
8004: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
8005: $srchinsel.
8006: &Apache::lonhtmlcommon::row_closure(1).
8007: &Apache::lonhtmlcommon::end_pick_box().
8008: '<br />';
1.555 raeburn 8009: return $output;
8010: }
8011:
1.612 raeburn 8012: sub user_rule_check {
1.615 raeburn 8013: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 8014: my $response;
8015: if (ref($usershash) eq 'HASH') {
8016: foreach my $user (keys(%{$usershash})) {
8017: my ($uname,$udom) = split(/:/,$user);
8018: next if ($udom eq '' || $uname eq '');
1.615 raeburn 8019: my ($id,$newuser);
1.612 raeburn 8020: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 8021: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 8022: $id = $usershash->{$user}->{'id'};
8023: }
8024: my $inst_response;
8025: if (ref($checks) eq 'HASH') {
8026: if (defined($checks->{'username'})) {
1.615 raeburn 8027: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 8028: &Apache::lonnet::get_instuser($udom,$uname);
8029: } elsif (defined($checks->{'id'})) {
1.615 raeburn 8030: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 8031: &Apache::lonnet::get_instuser($udom,undef,$id);
8032: }
1.615 raeburn 8033: } else {
8034: ($inst_response,%{$inst_results->{$user}}) =
8035: &Apache::lonnet::get_instuser($udom,$uname);
8036: return;
1.612 raeburn 8037: }
1.615 raeburn 8038: if (!$got_rules->{$udom}) {
1.612 raeburn 8039: my %domconfig = &Apache::lonnet::get_dom('configuration',
8040: ['usercreation'],$udom);
8041: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 8042: foreach my $item ('username','id') {
1.612 raeburn 8043: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
8044: $$curr_rules{$udom}{$item} =
8045: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 8046: }
8047: }
8048: }
1.615 raeburn 8049: $got_rules->{$udom} = 1;
1.585 raeburn 8050: }
1.612 raeburn 8051: foreach my $item (keys(%{$checks})) {
8052: if (ref($$curr_rules{$udom}) eq 'HASH') {
8053: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
8054: if (@{$$curr_rules{$udom}{$item}} > 0) {
8055: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
8056: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
8057: if ($rule_check{$rule}) {
8058: $$rulematch{$user}{$item} = $rule;
8059: if ($inst_response eq 'ok') {
1.615 raeburn 8060: if (ref($inst_results) eq 'HASH') {
8061: if (ref($inst_results->{$user}) eq 'HASH') {
8062: if (keys(%{$inst_results->{$user}}) == 0) {
8063: $$alerts{$item}{$udom}{$uname} = 1;
8064: }
1.612 raeburn 8065: }
8066: }
1.615 raeburn 8067: }
8068: last;
1.585 raeburn 8069: }
8070: }
8071: }
8072: }
8073: }
8074: }
8075: }
8076: }
1.612 raeburn 8077: return;
8078: }
8079:
8080: sub user_rule_formats {
8081: my ($domain,$domdesc,$curr_rules,$check) = @_;
8082: my %text = (
8083: 'username' => 'Usernames',
8084: 'id' => 'IDs',
8085: );
8086: my $output;
8087: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
8088: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
8089: if (@{$ruleorder} > 0) {
8090: $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>';
8091: foreach my $rule (@{$ruleorder}) {
8092: if (ref($curr_rules) eq 'ARRAY') {
8093: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
8094: if (ref($rules->{$rule}) eq 'HASH') {
8095: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
8096: $rules->{$rule}{'desc'}.'</li>';
8097: }
8098: }
8099: }
8100: }
8101: $output .= '</ul>';
8102: }
8103: }
8104: return $output;
8105: }
8106:
8107: sub instrule_disallow_msg {
1.615 raeburn 8108: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 8109: my $response;
8110: my %text = (
8111: item => 'username',
8112: items => 'usernames',
8113: match => 'matches',
8114: do => 'does',
8115: action => 'a username',
8116: one => 'one',
8117: );
8118: if ($count > 1) {
8119: $text{'item'} = 'usernames';
8120: $text{'match'} ='match';
8121: $text{'do'} = 'do';
8122: $text{'action'} = 'usernames',
8123: $text{'one'} = 'ones';
8124: }
8125: if ($checkitem eq 'id') {
8126: $text{'items'} = 'IDs';
8127: $text{'item'} = 'ID';
8128: $text{'action'} = 'an ID';
1.615 raeburn 8129: if ($count > 1) {
8130: $text{'item'} = 'IDs';
8131: $text{'action'} = 'IDs';
8132: }
1.612 raeburn 8133: }
1.674 bisitz 8134: $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 8135: if ($mode eq 'upload') {
8136: if ($checkitem eq 'username') {
8137: $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'}.");
8138: } elsif ($checkitem eq 'id') {
1.674 bisitz 8139: $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 8140: }
1.669 raeburn 8141: } elsif ($mode eq 'selfcreate') {
8142: if ($checkitem eq 'id') {
8143: $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.");
8144: }
1.615 raeburn 8145: } else {
8146: if ($checkitem eq 'username') {
8147: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
8148: } elsif ($checkitem eq 'id') {
8149: $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.");
8150: }
1.612 raeburn 8151: }
8152: return $response;
1.585 raeburn 8153: }
8154:
1.624 raeburn 8155: sub personal_data_fieldtitles {
8156: my %fieldtitles = &Apache::lonlocal::texthash (
8157: id => 'Student/Employee ID',
8158: permanentemail => 'E-mail address',
8159: lastname => 'Last Name',
8160: firstname => 'First Name',
8161: middlename => 'Middle Name',
8162: generation => 'Generation',
8163: gen => 'Generation',
1.765 raeburn 8164: inststatus => 'Affiliation',
1.624 raeburn 8165: );
8166: return %fieldtitles;
8167: }
8168:
1.642 raeburn 8169: sub sorted_inst_types {
8170: my ($dom) = @_;
8171: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
8172: my $othertitle = &mt('All users');
8173: if ($env{'request.course.id'}) {
1.668 raeburn 8174: $othertitle = &mt('Any users');
1.642 raeburn 8175: }
8176: my @types;
8177: if (ref($order) eq 'ARRAY') {
8178: @types = @{$order};
8179: }
8180: if (@types == 0) {
8181: if (ref($usertypes) eq 'HASH') {
8182: @types = sort(keys(%{$usertypes}));
8183: }
8184: }
8185: if (keys(%{$usertypes}) > 0) {
8186: $othertitle = &mt('Other users');
8187: }
8188: return ($othertitle,$usertypes,\@types);
8189: }
8190:
1.645 raeburn 8191: sub get_institutional_codes {
8192: my ($settings,$allcourses,$LC_code) = @_;
8193: # Get complete list of course sections to update
8194: my @currsections = ();
8195: my @currxlists = ();
8196: my $coursecode = $$settings{'internal.coursecode'};
8197:
8198: if ($$settings{'internal.sectionnums'} ne '') {
8199: @currsections = split(/,/,$$settings{'internal.sectionnums'});
8200: }
8201:
8202: if ($$settings{'internal.crosslistings'} ne '') {
8203: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
8204: }
8205:
8206: if (@currxlists > 0) {
8207: foreach (@currxlists) {
8208: if (m/^([^:]+):(\w*)$/) {
8209: unless (grep/^$1$/,@{$allcourses}) {
8210: push @{$allcourses},$1;
8211: $$LC_code{$1} = $2;
8212: }
8213: }
8214: }
8215: }
8216:
8217: if (@currsections > 0) {
8218: foreach (@currsections) {
8219: if (m/^(\w+):(\w*)$/) {
8220: my $sec = $coursecode.$1;
8221: my $lc_sec = $2;
8222: unless (grep/^$sec$/,@{$allcourses}) {
8223: push @{$allcourses},$sec;
8224: $$LC_code{$sec} = $lc_sec;
8225: }
8226: }
8227: }
8228: }
8229: return;
8230: }
8231:
1.971 raeburn 8232: sub get_standard_codeitems {
8233: return ('Year','Semester','Department','Number','Section');
8234: }
8235:
1.112 bowersj2 8236: =pod
8237:
1.780 raeburn 8238: =head1 Slot Helpers
8239:
8240: =over 4
8241:
8242: =item * sorted_slots()
8243:
8244: Sorts an array of slot names in order of slot start time (earliest first).
8245:
8246: Inputs:
8247:
8248: =over 4
8249:
8250: slotsarr - Reference to array of unsorted slot names.
8251:
8252: slots - Reference to hash of hash, where outer hash keys are slot names.
8253:
1.549 albertel 8254: =back
8255:
1.780 raeburn 8256: Returns:
8257:
8258: =over 4
8259:
8260: sorted - An array of slot names sorted by the start time of the slot.
8261:
8262: =back
8263:
8264: =back
8265:
8266: =cut
8267:
8268:
8269: sub sorted_slots {
8270: my ($slotsarr,$slots) = @_;
8271: my @sorted;
8272: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
8273: @sorted =
8274: sort {
8275: if (ref($slots->{$a}) && ref($slots->{$b})) {
8276: return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
8277: }
8278: if (ref($slots->{$a})) { return -1;}
8279: if (ref($slots->{$b})) { return 1;}
8280: return 0;
8281: } @{$slotsarr};
8282: }
8283: return @sorted;
8284: }
8285:
8286:
8287: =pod
8288:
1.549 albertel 8289: =head1 HTTP Helpers
8290:
8291: =over 4
8292:
1.648 raeburn 8293: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 8294:
1.258 albertel 8295: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 8296: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 8297: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 8298:
8299: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
8300: $possible_names is an ref to an array of form element names. As an example:
8301: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 8302: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 8303:
8304: =cut
1.1 albertel 8305:
1.6 albertel 8306: sub get_unprocessed_cgi {
1.25 albertel 8307: my ($query,$possible_names)= @_;
1.26 matthew 8308: # $Apache::lonxml::debug=1;
1.356 albertel 8309: foreach my $pair (split(/&/,$query)) {
8310: my ($name, $value) = split(/=/,$pair);
1.369 www 8311: $name = &unescape($name);
1.25 albertel 8312: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
8313: $value =~ tr/+/ /;
8314: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 8315: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 8316: }
1.16 harris41 8317: }
1.6 albertel 8318: }
8319:
1.112 bowersj2 8320: =pod
8321:
1.648 raeburn 8322: =item * &cacheheader()
1.112 bowersj2 8323:
8324: returns cache-controlling header code
8325:
8326: =cut
8327:
1.7 albertel 8328: sub cacheheader {
1.258 albertel 8329: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 8330: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
8331: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 8332: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
8333: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 8334: return $output;
1.7 albertel 8335: }
8336:
1.112 bowersj2 8337: =pod
8338:
1.648 raeburn 8339: =item * &no_cache($r)
1.112 bowersj2 8340:
8341: specifies header code to not have cache
8342:
8343: =cut
8344:
1.9 albertel 8345: sub no_cache {
1.216 albertel 8346: my ($r) = @_;
8347: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 8348: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 8349: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
8350: $r->no_cache(1);
8351: $r->header_out("Expires" => $date);
8352: $r->header_out("Pragma" => "no-cache");
1.123 www 8353: }
8354:
8355: sub content_type {
1.181 albertel 8356: my ($r,$type,$charset) = @_;
1.299 foxr 8357: if ($r) {
8358: # Note that printout.pl calls this with undef for $r.
8359: &no_cache($r);
8360: }
1.258 albertel 8361: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 8362: unless ($charset) {
8363: $charset=&Apache::lonlocal::current_encoding;
8364: }
8365: if ($charset) { $type.='; charset='.$charset; }
8366: if ($r) {
8367: $r->content_type($type);
8368: } else {
8369: print("Content-type: $type\n\n");
8370: }
1.9 albertel 8371: }
1.25 albertel 8372:
1.112 bowersj2 8373: =pod
8374:
1.648 raeburn 8375: =item * &add_to_env($name,$value)
1.112 bowersj2 8376:
1.258 albertel 8377: adds $name to the %env hash with value
1.112 bowersj2 8378: $value, if $name already exists, the entry is converted to an array
8379: reference and $value is added to the array.
8380:
8381: =cut
8382:
1.25 albertel 8383: sub add_to_env {
8384: my ($name,$value)=@_;
1.258 albertel 8385: if (defined($env{$name})) {
8386: if (ref($env{$name})) {
1.25 albertel 8387: #already have multiple values
1.258 albertel 8388: push(@{ $env{$name} },$value);
1.25 albertel 8389: } else {
8390: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 8391: my $first=$env{$name};
8392: undef($env{$name});
8393: push(@{ $env{$name} },$first,$value);
1.25 albertel 8394: }
8395: } else {
1.258 albertel 8396: $env{$name}=$value;
1.25 albertel 8397: }
1.31 albertel 8398: }
1.149 albertel 8399:
8400: =pod
8401:
1.648 raeburn 8402: =item * &get_env_multiple($name)
1.149 albertel 8403:
1.258 albertel 8404: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 8405: values may be defined and end up as an array ref.
8406:
8407: returns an array of values
8408:
8409: =cut
8410:
8411: sub get_env_multiple {
8412: my ($name) = @_;
8413: my @values;
1.258 albertel 8414: if (defined($env{$name})) {
1.149 albertel 8415: # exists is it an array
1.258 albertel 8416: if (ref($env{$name})) {
8417: @values=@{ $env{$name} };
1.149 albertel 8418: } else {
1.258 albertel 8419: $values[0]=$env{$name};
1.149 albertel 8420: }
8421: }
8422: return(@values);
8423: }
8424:
1.660 raeburn 8425: sub ask_for_embedded_content {
8426: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.987 raeburn 8427: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges);
1.660 raeburn 8428: my $num = 0;
1.987 raeburn 8429: my $numremref = 0;
8430: my $numinvalid = 0;
8431: my $numpathchg = 0;
8432: my $numexisting = 0;
8433: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath);
1.984 raeburn 8434: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
8435: my $current_path='/';
8436: if ($env{'form.currentpath'}) {
8437: $current_path = $env{'form.currentpath'};
8438: }
8439: if ($actionurl eq '/adm/coursegrp_portfolio') {
8440: $udom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8441: $uname = $env{'course.'.$env{'request.course.id'}.'.num'};
8442: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
8443: } else {
8444: $udom = $env{'user.domain'};
8445: $uname = $env{'user.name'};
8446: $url = '/userfiles/portfolio';
8447: }
1.987 raeburn 8448: $toplevel = $url.'/';
1.984 raeburn 8449: $url .= $current_path;
8450: $getpropath = 1;
1.987 raeburn 8451: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
8452: ($actionurl eq '/adm/imsimport')) {
1.1022 www 8453: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
8454: $url = '/home/httpd/html/priv/'.$udom.'/'.$uname.'/';
1.987 raeburn 8455: $toplevel = $url;
1.984 raeburn 8456: if ($rest ne '') {
1.987 raeburn 8457: $url .= $rest;
8458: }
8459: } elsif ($actionurl eq '/adm/coursedocs') {
8460: if (ref($args) eq 'HASH') {
8461: $url = $args->{'docs_url'};
8462: $toplevel = $url;
8463: }
8464: }
8465: my $now = time();
8466: foreach my $embed_file (keys(%{$allfiles})) {
8467: my $absolutepath;
8468: if ($embed_file =~ m{^\w+://}) {
8469: $newfiles{$embed_file} = 1;
8470: $mapping{$embed_file} = $embed_file;
8471: } else {
8472: if ($embed_file =~ m{^/}) {
8473: $absolutepath = $embed_file;
8474: $embed_file =~ s{^(/+)}{};
8475: }
8476: if ($embed_file =~ m{/}) {
8477: my ($path,$fname) = ($embed_file =~ m{^(.+)/([^/]*)$});
8478: $path = &check_for_traversal($path,$url,$toplevel);
8479: my $item = $fname;
8480: if ($path ne '') {
8481: $item = $path.'/'.$fname;
8482: $subdependencies{$path}{$fname} = 1;
8483: } else {
8484: $dependencies{$item} = 1;
8485: }
8486: if ($absolutepath) {
8487: $mapping{$item} = $absolutepath;
8488: } else {
8489: $mapping{$item} = $embed_file;
8490: }
8491: } else {
8492: $dependencies{$embed_file} = 1;
8493: if ($absolutepath) {
8494: $mapping{$embed_file} = $absolutepath;
8495: } else {
8496: $mapping{$embed_file} = $embed_file;
8497: }
8498: }
1.984 raeburn 8499: }
8500: }
8501: foreach my $path (keys(%subdependencies)) {
8502: my %currsubfile;
8503: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 8504: my ($sublistref,$listerror) =
8505: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
8506: if (ref($sublistref) eq 'ARRAY') {
8507: foreach my $line (@{$sublistref}) {
8508: my ($file_name,$rest) = split(/\&/,$line,2);
8509: $currsubfile{$file_name} = 1;
8510: }
1.984 raeburn 8511: }
1.987 raeburn 8512: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 8513: if (opendir(my $dir,$url.'/'.$path)) {
8514: my @subdir_list = grep(!/^\./,readdir($dir));
8515: map {$currsubfile{$_} = 1;} @subdir_list;
8516: }
8517: }
8518: foreach my $file (keys(%{$subdependencies{$path}})) {
1.987 raeburn 8519: if ($currsubfile{$file}) {
8520: my $item = $path.'/'.$file;
8521: unless ($mapping{$item} eq $item) {
8522: $pathchanges{$item} = 1;
8523: }
8524: $existing{$item} = 1;
8525: $numexisting ++;
8526: } else {
8527: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 8528: }
8529: }
8530: }
1.987 raeburn 8531: my %currfile;
1.984 raeburn 8532: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 8533: my ($dirlistref,$listerror) =
8534: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
8535: if (ref($dirlistref) eq 'ARRAY') {
8536: foreach my $line (@{$dirlistref}) {
8537: my ($file_name,$rest) = split(/\&/,$line,2);
8538: $currfile{$file_name} = 1;
8539: }
1.984 raeburn 8540: }
1.987 raeburn 8541: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 8542: if (opendir(my $dir,$url)) {
1.987 raeburn 8543: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 8544: map {$currfile{$_} = 1;} @dir_list;
8545: }
8546: }
8547: foreach my $file (keys(%dependencies)) {
1.987 raeburn 8548: if ($currfile{$file}) {
8549: unless ($mapping{$file} eq $file) {
8550: $pathchanges{$file} = 1;
8551: }
8552: $existing{$file} = 1;
8553: $numexisting ++;
8554: } else {
1.984 raeburn 8555: $newfiles{$file} = 1;
8556: }
8557: }
8558: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.660 raeburn 8559: $upload_output .= &start_data_table_row().
1.987 raeburn 8560: '<td><span class="LC_filename">'.$embed_file.'</span>';
8561: unless ($mapping{$embed_file} eq $embed_file) {
8562: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.&mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
8563: }
8564: $upload_output .= '</td><td>';
1.660 raeburn 8565: if ($args->{'ignore_remote_references'}
8566: && $embed_file =~ m{^\w+://}) {
8567: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
1.987 raeburn 8568: $numremref++;
1.660 raeburn 8569: } elsif ($args->{'error_on_invalid_names'}
8570: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
8571:
1.987 raeburn 8572: $upload_output.='<span class="LC_warning">'.&mt('Invalid characters').'</span>';
8573: $numinvalid++;
1.660 raeburn 8574: } else {
1.987 raeburn 8575: $upload_output .= &embedded_file_element('upload_embedded',$num,
8576: $embed_file,\%mapping,
8577: $allfiles,$codebase);
8578: $num++;
8579: }
8580: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
8581: }
8582: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
8583: $upload_output .= &start_data_table_row().
8584: '<td><span class="LC_filename">'.$embed_file.'</span></td>'.
8585: '<td><span class="LC_warning">'.&mt('Already exists').'</span></td>'.
8586: &Apache::loncommon::end_data_table_row()."\n";
8587: }
8588: if ($upload_output) {
8589: $upload_output = &start_data_table().
8590: $upload_output.
8591: &end_data_table()."\n";
8592: }
8593: my $applies = 0;
8594: if ($numremref) {
8595: $applies ++;
8596: }
8597: if ($numinvalid) {
8598: $applies ++;
8599: }
8600: if ($numexisting) {
8601: $applies ++;
8602: }
8603: if ($num) {
8604: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
8605: ' method="post" enctype="multipart/form-data">'."\n".
8606: $state.
8607: '<h3>'.&mt('Upload embedded files').
8608: ':</h3>'.$upload_output.'<br />'."\n".
8609: '<input type ="hidden" name="number_embedded_items" value="'.
8610: $num.'" />'."\n";
8611: if ($actionurl eq '') {
8612: $output .= '<input type="hidden" name="phase" value="three" />';
8613: }
8614: } elsif ($applies) {
8615: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
8616: if ($applies > 1) {
8617: $output .=
8618: &mt('No files need to be uploaded, as one of the following applies to each reference:').'<ul>';
8619: if ($numremref) {
8620: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
8621: }
8622: if ($numinvalid) {
8623: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
8624: }
8625: if ($numexisting) {
8626: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
8627: }
8628: $output .= '</ul><br />';
8629: } elsif ($numremref) {
8630: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
8631: } elsif ($numinvalid) {
8632: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
8633: } elsif ($numexisting) {
8634: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
8635: }
8636: $output .= $upload_output.'<br />';
8637: }
8638: my ($pathchange_output,$chgcount);
8639: $chgcount = $num;
8640: if (keys(%pathchanges) > 0) {
8641: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
8642: if ($num) {
8643: $output .= &embedded_file_element('pathchange',$chgcount,
8644: $embed_file,\%mapping,
8645: $allfiles,$codebase);
8646: } else {
8647: $pathchange_output .=
8648: &start_data_table_row().
8649: '<td><input type ="checkbox" name="namechange" value="'.
8650: $chgcount.'" checked="checked" /></td>'.
8651: '<td>'.$mapping{$embed_file}.'</td>'.
8652: '<td>'.$embed_file.
8653: &embedded_file_element('pathchange',$numpathchg,$embed_file,
8654: \%mapping,$allfiles,$codebase).
8655: '</td>'.&end_data_table_row();
1.660 raeburn 8656: }
1.987 raeburn 8657: $numpathchg ++;
8658: $chgcount ++;
1.660 raeburn 8659: }
8660: }
1.984 raeburn 8661: if ($num) {
1.987 raeburn 8662: if ($numpathchg) {
8663: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
8664: $numpathchg.'" />'."\n";
8665: }
8666: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
8667: ($actionurl eq '/adm/imsimport')) {
8668: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
8669: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
8670: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
8671: }
8672: $output .= '<input type ="submit" value="'.&mt('Upload Listed Files').'" />'."\n".
8673: &mt('(only files for which a location has been provided will be uploaded)').'</form>'."\n";
8674: } elsif ($numpathchg) {
8675: my %pathchange = ();
8676: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
8677: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
8678: $output .= '<p>'.&mt('or').'</p>';
8679: }
8680: }
8681: return ($output,$num,$numpathchg);
8682: }
8683:
8684: sub embedded_file_element {
8685: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase) = @_;
8686: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
8687: (ref($codebase) eq 'HASH'));
8688: my $output;
8689: if ($context eq 'upload_embedded') {
8690: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
8691: }
8692: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
8693: &escape($embed_file).'" />';
8694: unless (($context eq 'upload_embedded') &&
8695: ($mapping->{$embed_file} eq $embed_file)) {
8696: $output .='
8697: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
8698: }
8699: my $attrib;
8700: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
8701: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
8702: }
8703: $output .=
8704: "\n\t\t".
8705: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
8706: $attrib.'" />';
8707: if (exists($codebase->{$mapping->{$embed_file}})) {
8708: $output .=
8709: "\n\t\t".
8710: '<input name="codebase_'.$num.'" type="hidden" value="'.
8711: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 8712: }
1.987 raeburn 8713: return $output;
1.660 raeburn 8714: }
8715:
1.661 raeburn 8716: sub upload_embedded {
8717: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 8718: $current_disk_usage,$hiddenstate,$actionurl) = @_;
8719: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 8720: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
8721: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
8722: my $orig_uploaded_filename =
8723: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 8724: foreach my $type ('orig','ref','attrib','codebase') {
8725: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
8726: $env{'form.embedded_'.$type.'_'.$i} =
8727: &unescape($env{'form.embedded_'.$type.'_'.$i});
8728: }
8729: }
1.661 raeburn 8730: my ($path,$fname) =
8731: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
8732: # no path, whole string is fname
8733: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
8734: $fname = &Apache::lonnet::clean_filename($fname);
8735: # See if there is anything left
8736: next if ($fname eq '');
8737:
8738: # Check if file already exists as a file or directory.
8739: my ($state,$msg);
8740: if ($context eq 'portfolio') {
8741: my $port_path = $dirpath;
8742: if ($group ne '') {
8743: $port_path = "groups/$group/$port_path";
8744: }
1.987 raeburn 8745: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
8746: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 8747: $dir_root,$port_path,$disk_quota,
8748: $current_disk_usage,$uname,$udom);
8749: if ($state eq 'will_exceed_quota'
1.984 raeburn 8750: || $state eq 'file_locked') {
1.661 raeburn 8751: $output .= $msg;
8752: next;
8753: }
8754: } elsif (($context eq 'author') || ($context eq 'testbank')) {
8755: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
8756: if ($state eq 'exists') {
8757: $output .= $msg;
8758: next;
8759: }
8760: }
8761: # Check if extension is valid
8762: if (($fname =~ /\.(\w+)$/) &&
8763: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.987 raeburn 8764: $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 8765: next;
8766: } elsif (($fname =~ /\.(\w+)$/) &&
8767: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 8768: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 8769: next;
8770: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.987 raeburn 8771: $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 8772: next;
8773: }
8774:
8775: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
8776: if ($context eq 'portfolio') {
1.984 raeburn 8777: my $result;
8778: if ($state eq 'existingfile') {
8779: $result=
8780: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.987 raeburn 8781: $dirpath.$env{'form.currentpath'}.$path);
1.661 raeburn 8782: } else {
1.984 raeburn 8783: $result=
8784: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 8785: $dirpath.
8786: $env{'form.currentpath'}.$path);
1.984 raeburn 8787: if ($result !~ m|^/uploaded/|) {
8788: $output .= '<span class="LC_error">'
8789: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
8790: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
8791: .'</span><br />';
8792: next;
8793: } else {
1.987 raeburn 8794: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
8795: $path.$fname.'</span>').'<br />';
1.984 raeburn 8796: }
1.661 raeburn 8797: }
1.987 raeburn 8798: } elsif ($context eq 'coursedoc') {
8799: my $result =
8800: &Apache::lonnet::userfileupload('embedded_item_'.$i,'coursedoc',
8801: $dirpath.'/'.$path);
8802: if ($result !~ m|^/uploaded/|) {
8803: $output .= '<span class="LC_error">'
8804: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
8805: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
8806: .'</span><br />';
8807: next;
8808: } else {
8809: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
8810: $path.$fname.'</span>').'<br />';
8811: }
1.661 raeburn 8812: } else {
8813: # Save the file
8814: my $target = $env{'form.embedded_item_'.$i};
8815: my $fullpath = $dir_root.$dirpath.'/'.$path;
8816: my $dest = $fullpath.$fname;
8817: my $url = $url_root.$dirpath.'/'.$path.$fname;
8818: my @parts=split(/\//,$fullpath);
8819: my $count;
8820: my $filepath = $dir_root;
8821: for ($count=4;$count<=$#parts;$count++) {
8822: $filepath .= "/$parts[$count]";
8823: if ((-e $filepath)!=1) {
8824: mkdir($filepath,0770);
8825: }
8826: }
8827: my $fh;
8828: if (!open($fh,'>'.$dest)) {
8829: &Apache::lonnet::logthis('Failed to create '.$dest);
8830: $output .= '<span class="LC_error">'.
8831: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8832: '</span><br />';
8833: } else {
8834: if (!print $fh $env{'form.embedded_item_'.$i}) {
8835: &Apache::lonnet::logthis('Failed to write to '.$dest);
8836: $output .= '<span class="LC_error">'.
8837: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8838: '</span><br />';
8839: } else {
1.987 raeburn 8840: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
8841: $url.'</span>').'<br />';
8842: unless ($context eq 'testbank') {
8843: $footer .= &mt('View embedded file: [_1]',
8844: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
8845: }
8846: }
8847: close($fh);
8848: }
8849: }
8850: if ($env{'form.embedded_ref_'.$i}) {
8851: $pathchange{$i} = 1;
8852: }
8853: }
8854: if ($output) {
8855: $output = '<p>'.$output.'</p>';
8856: }
8857: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
8858: $returnflag = 'ok';
8859: if (keys(%pathchange) > 0) {
8860: if ($context eq 'portfolio') {
8861: $output .= '<p>'.&mt('or').'</p>';
8862: } elsif ($context eq 'testbank') {
1.988 raeburn 8863: $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 8864: $returnflag = 'modify_orightml';
8865: }
8866: }
8867: return ($output.$footer,$returnflag);
8868: }
8869:
8870: sub modify_html_form {
8871: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
8872: my $end = 0;
8873: my $modifyform;
8874: if ($context eq 'upload_embedded') {
8875: return unless (ref($pathchange) eq 'HASH');
8876: if ($env{'form.number_embedded_items'}) {
8877: $end += $env{'form.number_embedded_items'};
8878: }
8879: if ($env{'form.number_pathchange_items'}) {
8880: $end += $env{'form.number_pathchange_items'};
8881: }
8882: if ($end) {
8883: for (my $i=0; $i<$end; $i++) {
8884: if ($i < $env{'form.number_embedded_items'}) {
8885: next unless($pathchange->{$i});
8886: }
8887: $modifyform .=
8888: &start_data_table_row().
8889: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
8890: 'checked="checked" /></td>'.
8891: '<td>'.$env{'form.embedded_ref_'.$i}.
8892: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
8893: &escape($env{'form.embedded_ref_'.$i}).'" />'.
8894: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
8895: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
8896: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
8897: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
8898: '<td>'.$env{'form.embedded_orig_'.$i}.
8899: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
8900: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
8901: &end_data_table_row();
8902: }
8903: }
8904: } else {
8905: $modifyform = $pathchgtable;
8906: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
8907: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
8908: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
8909: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
8910: }
8911: }
8912: if ($modifyform) {
8913: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
8914: '<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".
8915: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
8916: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
8917: '</ol></p>'."\n".'<p>'.
8918: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
8919: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
8920: &start_data_table()."\n".
8921: &start_data_table_header_row().
8922: '<th>'.&mt('Change?').'</th>'.
8923: '<th>'.&mt('Current reference').'</th>'.
8924: '<th>'.&mt('Required reference').'</th>'.
8925: &end_data_table_header_row()."\n".
8926: $modifyform.
8927: &end_data_table().'<br />'."\n".$hiddenstate.
8928: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
8929: '</form>'."\n";
8930: }
8931: return;
8932: }
8933:
8934: sub modify_html_refs {
8935: my ($context,$dirpath,$uname,$udom,$dir_root) = @_;
8936: my $container;
8937: if ($context eq 'portfolio') {
8938: $container = $env{'form.container'};
8939: } elsif ($context eq 'coursedoc') {
8940: $container = $env{'form.primaryurl'};
8941: } else {
8942: $container = $env{'form.filename'};
8943: }
8944: my (%allfiles,%codebase,$output,$content);
8945: my @changes = &get_env_multiple('form.namechange');
8946: return unless (@changes > 0);
8947: if (($context eq 'portfolio') || ($context eq 'coursedoc')) {
8948: return unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/});
8949: $content = &Apache::lonnet::getfile($container);
8950: return if ($content eq '-1');
8951: } else {
8952: return unless ($container =~ /^\Q$dir_root\E/);
8953: if (open(my $fh,"<$container")) {
8954: $content = join('', <$fh>);
8955: close($fh);
8956: } else {
8957: return;
8958: }
8959: }
8960: my ($count,$codebasecount) = (0,0);
8961: my $mm = new File::MMagic;
8962: my $mime_type = $mm->checktype_contents($content);
8963: if ($mime_type eq 'text/html') {
8964: my $parse_result =
8965: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
8966: \%codebase,\$content);
8967: if ($parse_result eq 'ok') {
8968: foreach my $i (@changes) {
8969: my $orig = &unescape($env{'form.embedded_orig_'.$i});
8970: my $ref = &unescape($env{'form.embedded_ref_'.$i});
8971: if ($allfiles{$ref}) {
8972: my $newname = $orig;
8973: my ($attrib_regexp,$codebase);
1.1006 raeburn 8974: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 8975: if ($attrib_regexp =~ /:/) {
8976: $attrib_regexp =~ s/\:/|/g;
8977: }
8978: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
8979: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
8980: $count += $numchg;
8981: }
8982: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 8983: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 8984: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
8985: $codebasecount ++;
8986: }
8987: }
8988: }
8989: if ($count || $codebasecount) {
8990: my $saveresult;
8991: if ($context eq 'portfolio' || $context eq 'coursedoc') {
8992: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
8993: if ($url eq $container) {
8994: my ($fname) = ($container =~ m{/([^/]+)$});
8995: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
8996: $count,'<span class="LC_filename">'.
8997: $fname.'</span>').'</p>';
8998: } else {
8999: $output = '<p class="LC_error">'.
9000: &mt('Error: update failed for: [_1].',
9001: '<span class="LC_filename">'.
9002: $container.'</span>').'</p>';
9003: }
9004: } else {
9005: if (open(my $fh,">$container")) {
9006: print $fh $content;
9007: close($fh);
9008: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
9009: $count,'<span class="LC_filename">'.
9010: $container.'</span>').'</p>';
1.661 raeburn 9011: } else {
1.987 raeburn 9012: $output = '<p class="LC_error">'.
9013: &mt('Error: could not update [_1].',
9014: '<span class="LC_filename">'.
9015: $container.'</span>').'</p>';
1.661 raeburn 9016: }
9017: }
9018: }
1.987 raeburn 9019: } else {
9020: &logthis('Failed to parse '.$container.
9021: ' to modify references: '.$parse_result);
1.661 raeburn 9022: }
9023: }
9024: return $output;
9025: }
9026:
9027: sub check_for_existing {
9028: my ($path,$fname,$element) = @_;
9029: my ($state,$msg);
9030: if (-d $path.'/'.$fname) {
9031: $state = 'exists';
9032: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
9033: } elsif (-e $path.'/'.$fname) {
9034: $state = 'exists';
9035: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
9036: }
9037: if ($state eq 'exists') {
9038: $msg = '<span class="LC_error">'.$msg.'</span><br />';
9039: }
9040: return ($state,$msg);
9041: }
9042:
9043: sub check_for_upload {
9044: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
9045: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 9046: my $filesize = length($env{'form.'.$element});
9047: if (!$filesize) {
9048: my $msg = '<span class="LC_error">'.
9049: &mt('Unable to upload [_1]. (size = [_2] bytes)',
9050: '<span class="LC_filename">'.$fname.'</span>',
9051: $filesize).'<br />'.
1.1007 raeburn 9052: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 9053: '</span>';
9054: return ('zero_bytes',$msg);
9055: }
9056: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 9057: my $getpropath = 1;
1.1021 raeburn 9058: my ($dirlistref,$listerror) =
9059: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 9060: my $found_file = 0;
9061: my $locked_file = 0;
1.991 raeburn 9062: my @lockers;
9063: my $navmap;
9064: if ($env{'request.course.id'}) {
9065: $navmap = Apache::lonnavmaps::navmap->new();
9066: }
1.1021 raeburn 9067: if (ref($dirlistref) eq 'ARRAY') {
9068: foreach my $line (@{$dirlistref}) {
9069: my ($file_name,$rest)=split(/\&/,$line,2);
9070: if ($file_name eq $fname){
9071: $file_name = $path.$file_name;
9072: if ($group ne '') {
9073: $file_name = $group.$file_name;
9074: }
9075: $found_file = 1;
9076: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
9077: foreach my $lock (@lockers) {
9078: if (ref($lock) eq 'ARRAY') {
9079: my ($symb,$crsid) = @{$lock};
9080: if ($crsid eq $env{'request.course.id'}) {
9081: if (ref($navmap)) {
9082: my $res = $navmap->getBySymb($symb);
9083: foreach my $part (@{$res->parts()}) {
9084: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
9085: unless (($slot_status == $res->RESERVED) ||
9086: ($slot_status == $res->RESERVED_LOCATION)) {
9087: $locked_file = 1;
9088: }
1.991 raeburn 9089: }
1.1021 raeburn 9090: } else {
9091: $locked_file = 1;
1.991 raeburn 9092: }
9093: } else {
9094: $locked_file = 1;
9095: }
9096: }
1.1021 raeburn 9097: }
9098: } else {
9099: my @info = split(/\&/,$rest);
9100: my $currsize = $info[6]/1000;
9101: if ($currsize < $filesize) {
9102: my $extra = $filesize - $currsize;
9103: if (($current_disk_usage + $extra) > $disk_quota) {
9104: my $msg = '<span class="LC_error">'.
9105: &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.',
9106: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</span>'.
9107: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
9108: $disk_quota,$current_disk_usage);
9109: return ('will_exceed_quota',$msg);
9110: }
1.984 raeburn 9111: }
9112: }
1.661 raeburn 9113: }
9114: }
9115: }
9116: if (($current_disk_usage + $filesize) > $disk_quota){
9117: my $msg = '<span class="LC_error">'.
9118: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
9119: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
9120: return ('will_exceed_quota',$msg);
9121: } elsif ($found_file) {
9122: if ($locked_file) {
9123: my $msg = '<span class="LC_error">';
9124: $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>');
9125: $msg .= '</span><br />';
9126: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
9127: return ('file_locked',$msg);
9128: } else {
9129: my $msg = '<span class="LC_error">';
1.984 raeburn 9130: $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 9131: $msg .= '</span>';
1.984 raeburn 9132: return ('existingfile',$msg);
1.661 raeburn 9133: }
9134: }
9135: }
9136:
1.987 raeburn 9137: sub check_for_traversal {
9138: my ($path,$url,$toplevel) = @_;
9139: my @parts=split(/\//,$path);
9140: my $cleanpath;
9141: my $fullpath = $url;
9142: for (my $i=0;$i<@parts;$i++) {
9143: next if ($parts[$i] eq '.');
9144: if ($parts[$i] eq '..') {
9145: $fullpath =~ s{([^/]+/)$}{};
9146: } else {
9147: $fullpath .= $parts[$i].'/';
9148: }
9149: }
9150: if ($fullpath =~ /^\Q$url\E(.*)$/) {
9151: $cleanpath = $1;
9152: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
9153: my $curr_toprel = $1;
9154: my @parts = split(/\//,$curr_toprel);
9155: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
9156: my @urlparts = split(/\//,$url_toprel);
9157: my $doubledots;
9158: my $startdiff = -1;
9159: for (my $i=0; $i<@urlparts; $i++) {
9160: if ($startdiff == -1) {
9161: unless ($urlparts[$i] eq $parts[$i]) {
9162: $startdiff = $i;
9163: $doubledots .= '../';
9164: }
9165: } else {
9166: $doubledots .= '../';
9167: }
9168: }
9169: if ($startdiff > -1) {
9170: $cleanpath = $doubledots;
9171: for (my $i=$startdiff; $i<@parts; $i++) {
9172: $cleanpath .= $parts[$i].'/';
9173: }
9174: }
9175: }
9176: $cleanpath =~ s{(/)$}{};
9177: return $cleanpath;
9178: }
1.31 albertel 9179:
1.41 ng 9180: =pod
1.45 matthew 9181:
1.1015 raeburn 9182: =item * &get_turnedin_filepath()
9183:
9184: Determines path in a user's portfolio file for storage of files uploaded
9185: to a specific essayresponse or dropbox item.
9186:
9187: Inputs: 3 required + 1 optional.
9188: $symb is symb for resource, $uname and $udom are for current user (required).
9189: $caller is optional (can be "submission", if routine is called when storing
9190: an upoaded file when "Submit Answer" button was pressed).
9191:
9192: Returns array containing $path and $multiresp.
9193: $path is path in portfolio. $multiresp is 1 if this resource contains more
9194: than one file upload item. Callers of routine should append partid as a
9195: subdirectory to $path in cases where $multiresp is 1.
9196:
9197: Called by: homework/essayresponse.pm and homework/structuretags.pm
9198:
9199: =cut
9200:
9201: sub get_turnedin_filepath {
9202: my ($symb,$uname,$udom,$caller) = @_;
9203: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
9204: my $turnindir;
9205: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
9206: $turnindir = $userhash{'turnindir'};
9207: my ($path,$multiresp);
9208: if ($turnindir eq '') {
9209: if ($caller eq 'submission') {
9210: $turnindir = &mt('turned in');
9211: $turnindir =~ s/\W+/_/g;
9212: my %newhash = (
9213: 'turnindir' => $turnindir,
9214: );
9215: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
9216: }
9217: }
9218: if ($turnindir ne '') {
9219: $path = '/'.$turnindir.'/';
9220: my ($multipart,$turnin,@pathitems);
9221: my $navmap = Apache::lonnavmaps::navmap->new();
9222: if (defined($navmap)) {
9223: my $mapres = $navmap->getResourceByUrl($map);
9224: if (ref($mapres)) {
9225: my $pcslist = $mapres->map_hierarchy();
9226: if ($pcslist ne '') {
9227: foreach my $pc (split(/,/,$pcslist)) {
9228: my $res = $navmap->getByMapPc($pc);
9229: if (ref($res)) {
9230: my $title = $res->compTitle();
9231: $title =~ s/\W+/_/g;
9232: if ($title ne '') {
9233: push(@pathitems,$title);
9234: }
9235: }
9236: }
9237: }
9238: my $maptitle = $mapres->compTitle();
9239: $maptitle =~ s/\W+/_/g;
9240: if ($maptitle ne '') {
9241: push(@pathitems,$maptitle);
9242: }
9243: unless ($env{'request.state'} eq 'construct') {
9244: my $res = $navmap->getBySymb($symb);
9245: if (ref($res)) {
9246: my $partlist = $res->parts();
9247: my $totaluploads = 0;
9248: if (ref($partlist) eq 'ARRAY') {
9249: foreach my $part (@{$partlist}) {
9250: my @types = $res->responseType($part);
9251: my @ids = $res->responseIds($part);
9252: for (my $i=0; $i < scalar(@ids); $i++) {
9253: if ($types[$i] eq 'essay') {
9254: my $partid = $part.'_'.$ids[$i];
9255: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
9256: $totaluploads ++;
9257: }
9258: }
9259: }
9260: }
9261: if ($totaluploads > 1) {
9262: $multiresp = 1;
9263: }
9264: }
9265: }
9266: }
9267: } else {
9268: return;
9269: }
9270: } else {
9271: return;
9272: }
9273: my $restitle=&Apache::lonnet::gettitle($symb);
9274: $restitle =~ s/\W+/_/g;
9275: if ($restitle eq '') {
9276: $restitle = ($resurl =~ m{/[^/]+$});
9277: if ($restitle eq '') {
9278: $restitle = time;
9279: }
9280: }
9281: push(@pathitems,$restitle);
9282: $path .= join('/',@pathitems);
9283: }
9284: return ($path,$multiresp);
9285: }
9286:
9287: =pod
9288:
1.464 albertel 9289: =back
1.41 ng 9290:
1.112 bowersj2 9291: =head1 CSV Upload/Handling functions
1.38 albertel 9292:
1.41 ng 9293: =over 4
9294:
1.648 raeburn 9295: =item * &upfile_store($r)
1.41 ng 9296:
9297: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 9298: needs $env{'form.upfile'}
1.41 ng 9299: returns $datatoken to be put into hidden field
9300:
9301: =cut
1.31 albertel 9302:
9303: sub upfile_store {
9304: my $r=shift;
1.258 albertel 9305: $env{'form.upfile'}=~s/\r/\n/gs;
9306: $env{'form.upfile'}=~s/\f/\n/gs;
9307: $env{'form.upfile'}=~s/\n+/\n/gs;
9308: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 9309:
1.258 albertel 9310: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
9311: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 9312: {
1.158 raeburn 9313: my $datafile = $r->dir_config('lonDaemons').
9314: '/tmp/'.$datatoken.'.tmp';
9315: if ( open(my $fh,">$datafile") ) {
1.258 albertel 9316: print $fh $env{'form.upfile'};
1.158 raeburn 9317: close($fh);
9318: }
1.31 albertel 9319: }
9320: return $datatoken;
9321: }
9322:
1.56 matthew 9323: =pod
9324:
1.648 raeburn 9325: =item * &load_tmp_file($r)
1.41 ng 9326:
9327: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 9328: needs $env{'form.datatoken'},
9329: sets $env{'form.upfile'} to the contents of the file
1.41 ng 9330:
9331: =cut
1.31 albertel 9332:
9333: sub load_tmp_file {
9334: my $r=shift;
9335: my @studentdata=();
9336: {
1.158 raeburn 9337: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 9338: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 9339: if ( open(my $fh,"<$studentfile") ) {
9340: @studentdata=<$fh>;
9341: close($fh);
9342: }
1.31 albertel 9343: }
1.258 albertel 9344: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 9345: }
9346:
1.56 matthew 9347: =pod
9348:
1.648 raeburn 9349: =item * &upfile_record_sep()
1.41 ng 9350:
9351: Separate uploaded file into records
9352: returns array of records,
1.258 albertel 9353: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 9354:
9355: =cut
1.31 albertel 9356:
9357: sub upfile_record_sep {
1.258 albertel 9358: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 9359: } else {
1.248 albertel 9360: my @records;
1.258 albertel 9361: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 9362: if ($line=~/^\s*$/) { next; }
9363: push(@records,$line);
9364: }
9365: return @records;
1.31 albertel 9366: }
9367: }
9368:
1.56 matthew 9369: =pod
9370:
1.648 raeburn 9371: =item * &record_sep($record)
1.41 ng 9372:
1.258 albertel 9373: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 9374:
9375: =cut
9376:
1.263 www 9377: sub takeleft {
9378: my $index=shift;
9379: return substr('0000'.$index,-4,4);
9380: }
9381:
1.31 albertel 9382: sub record_sep {
9383: my $record=shift;
9384: my %components=();
1.258 albertel 9385: if ($env{'form.upfiletype'} eq 'xml') {
9386: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 9387: my $i=0;
1.356 albertel 9388: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 9389: $field=~s/^(\"|\')//;
9390: $field=~s/(\"|\')$//;
1.263 www 9391: $components{&takeleft($i)}=$field;
1.31 albertel 9392: $i++;
9393: }
1.258 albertel 9394: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 9395: my $i=0;
1.356 albertel 9396: foreach my $field (split(/\t/,$record)) {
1.31 albertel 9397: $field=~s/^(\"|\')//;
9398: $field=~s/(\"|\')$//;
1.263 www 9399: $components{&takeleft($i)}=$field;
1.31 albertel 9400: $i++;
9401: }
9402: } else {
1.561 www 9403: my $separator=',';
1.480 banghart 9404: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 9405: $separator=';';
1.480 banghart 9406: }
1.31 albertel 9407: my $i=0;
1.561 www 9408: # the character we are looking for to indicate the end of a quote or a record
9409: my $looking_for=$separator;
9410: # do not add the characters to the fields
9411: my $ignore=0;
9412: # we just encountered a separator (or the beginning of the record)
9413: my $just_found_separator=1;
9414: # store the field we are working on here
9415: my $field='';
9416: # work our way through all characters in record
9417: foreach my $character ($record=~/(.)/g) {
9418: if ($character eq $looking_for) {
9419: if ($character ne $separator) {
9420: # Found the end of a quote, again looking for separator
9421: $looking_for=$separator;
9422: $ignore=1;
9423: } else {
9424: # Found a separator, store away what we got
9425: $components{&takeleft($i)}=$field;
9426: $i++;
9427: $just_found_separator=1;
9428: $ignore=0;
9429: $field='';
9430: }
9431: next;
9432: }
9433: # single or double quotation marks after a separator indicate beginning of a quote
9434: # we are now looking for the end of the quote and need to ignore separators
9435: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
9436: $looking_for=$character;
9437: next;
9438: }
9439: # ignore would be true after we reached the end of a quote
9440: if ($ignore) { next; }
9441: if (($just_found_separator) && ($character=~/\s/)) { next; }
9442: $field.=$character;
9443: $just_found_separator=0;
1.31 albertel 9444: }
1.561 www 9445: # catch the very last entry, since we never encountered the separator
9446: $components{&takeleft($i)}=$field;
1.31 albertel 9447: }
9448: return %components;
9449: }
9450:
1.144 matthew 9451: ######################################################
9452: ######################################################
9453:
1.56 matthew 9454: =pod
9455:
1.648 raeburn 9456: =item * &upfile_select_html()
1.41 ng 9457:
1.144 matthew 9458: Return HTML code to select a file from the users machine and specify
9459: the file type.
1.41 ng 9460:
9461: =cut
9462:
1.144 matthew 9463: ######################################################
9464: ######################################################
1.31 albertel 9465: sub upfile_select_html {
1.144 matthew 9466: my %Types = (
9467: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 9468: semisv => &mt('Semicolon separated values'),
1.144 matthew 9469: space => &mt('Space separated'),
9470: tab => &mt('Tabulator separated'),
9471: # xml => &mt('HTML/XML'),
9472: );
9473: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 9474: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 9475: foreach my $type (sort(keys(%Types))) {
9476: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
9477: }
9478: $Str .= "</select>\n";
9479: return $Str;
1.31 albertel 9480: }
9481:
1.301 albertel 9482: sub get_samples {
9483: my ($records,$toget) = @_;
9484: my @samples=({});
9485: my $got=0;
9486: foreach my $rec (@$records) {
9487: my %temp = &record_sep($rec);
9488: if (! grep(/\S/, values(%temp))) { next; }
9489: if (%temp) {
9490: $samples[$got]=\%temp;
9491: $got++;
9492: if ($got == $toget) { last; }
9493: }
9494: }
9495: return \@samples;
9496: }
9497:
1.144 matthew 9498: ######################################################
9499: ######################################################
9500:
1.56 matthew 9501: =pod
9502:
1.648 raeburn 9503: =item * &csv_print_samples($r,$records)
1.41 ng 9504:
9505: Prints a table of sample values from each column uploaded $r is an
9506: Apache Request ref, $records is an arrayref from
9507: &Apache::loncommon::upfile_record_sep
9508:
9509: =cut
9510:
1.144 matthew 9511: ######################################################
9512: ######################################################
1.31 albertel 9513: sub csv_print_samples {
9514: my ($r,$records) = @_;
1.662 bisitz 9515: my $samples = &get_samples($records,5);
1.301 albertel 9516:
1.594 raeburn 9517: $r->print(&mt('Samples').'<br />'.&start_data_table().
9518: &start_data_table_header_row());
1.356 albertel 9519: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 9520: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 9521: $r->print(&end_data_table_header_row());
1.301 albertel 9522: foreach my $hash (@$samples) {
1.594 raeburn 9523: $r->print(&start_data_table_row());
1.356 albertel 9524: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 9525: $r->print('<td>');
1.356 albertel 9526: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 9527: $r->print('</td>');
9528: }
1.594 raeburn 9529: $r->print(&end_data_table_row());
1.31 albertel 9530: }
1.594 raeburn 9531: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 9532: }
9533:
1.144 matthew 9534: ######################################################
9535: ######################################################
9536:
1.56 matthew 9537: =pod
9538:
1.648 raeburn 9539: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 9540:
9541: Prints a table to create associations between values and table columns.
1.144 matthew 9542:
1.41 ng 9543: $r is an Apache Request ref,
9544: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 9545: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 9546:
9547: =cut
9548:
1.144 matthew 9549: ######################################################
9550: ######################################################
1.31 albertel 9551: sub csv_print_select_table {
9552: my ($r,$records,$d) = @_;
1.301 albertel 9553: my $i=0;
9554: my $samples = &get_samples($records,1);
1.144 matthew 9555: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 9556: &start_data_table().&start_data_table_header_row().
1.144 matthew 9557: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 9558: '<th>'.&mt('Column').'</th>'.
9559: &end_data_table_header_row()."\n");
1.356 albertel 9560: foreach my $array_ref (@$d) {
9561: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 9562: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 9563:
1.875 bisitz 9564: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 9565: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 9566: $r->print('<option value="none"></option>');
1.356 albertel 9567: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
9568: $r->print('<option value="'.$sample.'"'.
9569: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 9570: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 9571: }
1.594 raeburn 9572: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 9573: $i++;
9574: }
1.594 raeburn 9575: $r->print(&end_data_table());
1.31 albertel 9576: $i--;
9577: return $i;
9578: }
1.56 matthew 9579:
1.144 matthew 9580: ######################################################
9581: ######################################################
9582:
1.56 matthew 9583: =pod
1.31 albertel 9584:
1.648 raeburn 9585: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 9586:
9587: Prints a table of sample values from the upload and can make associate samples to internal names.
9588:
9589: $r is an Apache Request ref,
9590: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
9591: $d is an array of 2 element arrays (internal name, displayed name)
9592:
9593: =cut
9594:
1.144 matthew 9595: ######################################################
9596: ######################################################
1.31 albertel 9597: sub csv_samples_select_table {
9598: my ($r,$records,$d) = @_;
9599: my $i=0;
1.144 matthew 9600: #
1.662 bisitz 9601: my $max_samples = 5;
9602: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 9603: $r->print(&start_data_table().
9604: &start_data_table_header_row().'<th>'.
9605: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
9606: &end_data_table_header_row());
1.301 albertel 9607:
9608: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 9609: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 9610: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 9611: foreach my $option (@$d) {
9612: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 9613: $r->print('<option value="'.$value.'"'.
1.253 albertel 9614: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 9615: $display.'</option>');
1.31 albertel 9616: }
9617: $r->print('</select></td><td>');
1.662 bisitz 9618: foreach my $line (0..($max_samples-1)) {
1.301 albertel 9619: if (defined($samples->[$line]{$key})) {
9620: $r->print($samples->[$line]{$key}."<br />\n");
9621: }
9622: }
1.594 raeburn 9623: $r->print('</td>'.&end_data_table_row());
1.31 albertel 9624: $i++;
9625: }
1.594 raeburn 9626: $r->print(&end_data_table());
1.31 albertel 9627: $i--;
9628: return($i);
1.115 matthew 9629: }
9630:
1.144 matthew 9631: ######################################################
9632: ######################################################
9633:
1.115 matthew 9634: =pod
9635:
1.648 raeburn 9636: =item * &clean_excel_name($name)
1.115 matthew 9637:
9638: Returns a replacement for $name which does not contain any illegal characters.
9639:
9640: =cut
9641:
1.144 matthew 9642: ######################################################
9643: ######################################################
1.115 matthew 9644: sub clean_excel_name {
9645: my ($name) = @_;
9646: $name =~ s/[:\*\?\/\\]//g;
9647: if (length($name) > 31) {
9648: $name = substr($name,0,31);
9649: }
9650: return $name;
1.25 albertel 9651: }
1.84 albertel 9652:
1.85 albertel 9653: =pod
9654:
1.648 raeburn 9655: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 9656:
9657: Returns either 1 or undef
9658:
9659: 1 if the part is to be hidden, undef if it is to be shown
9660:
9661: Arguments are:
9662:
9663: $id the id of the part to be checked
9664: $symb, optional the symb of the resource to check
9665: $udom, optional the domain of the user to check for
9666: $uname, optional the username of the user to check for
9667:
9668: =cut
1.84 albertel 9669:
9670: sub check_if_partid_hidden {
9671: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 9672: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 9673: $symb,$udom,$uname);
1.141 albertel 9674: my $truth=1;
9675: #if the string starts with !, then the list is the list to show not hide
9676: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 9677: my @hiddenlist=split(/,/,$hiddenparts);
9678: foreach my $checkid (@hiddenlist) {
1.141 albertel 9679: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 9680: }
1.141 albertel 9681: return !$truth;
1.84 albertel 9682: }
1.127 matthew 9683:
1.138 matthew 9684:
9685: ############################################################
9686: ############################################################
9687:
9688: =pod
9689:
1.157 matthew 9690: =back
9691:
1.138 matthew 9692: =head1 cgi-bin script and graphing routines
9693:
1.157 matthew 9694: =over 4
9695:
1.648 raeburn 9696: =item * &get_cgi_id()
1.138 matthew 9697:
9698: Inputs: none
9699:
9700: Returns an id which can be used to pass environment variables
9701: to various cgi-bin scripts. These environment variables will
9702: be removed from the users environment after a given time by
9703: the routine &Apache::lonnet::transfer_profile_to_env.
9704:
9705: =cut
9706:
9707: ############################################################
9708: ############################################################
1.152 albertel 9709: my $uniq=0;
1.136 matthew 9710: sub get_cgi_id {
1.154 albertel 9711: $uniq=($uniq+1)%100000;
1.280 albertel 9712: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 9713: }
9714:
1.127 matthew 9715: ############################################################
9716: ############################################################
9717:
9718: =pod
9719:
1.648 raeburn 9720: =item * &DrawBarGraph()
1.127 matthew 9721:
1.138 matthew 9722: Facilitates the plotting of data in a (stacked) bar graph.
9723: Puts plot definition data into the users environment in order for
9724: graph.png to plot it. Returns an <img> tag for the plot.
9725: The bars on the plot are labeled '1','2',...,'n'.
9726:
9727: Inputs:
9728:
9729: =over 4
9730:
9731: =item $Title: string, the title of the plot
9732:
9733: =item $xlabel: string, text describing the X-axis of the plot
9734:
9735: =item $ylabel: string, text describing the Y-axis of the plot
9736:
9737: =item $Max: scalar, the maximum Y value to use in the plot
9738: If $Max is < any data point, the graph will not be rendered.
9739:
1.140 matthew 9740: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 9741: they are plotted. If undefined, default values will be used.
9742:
1.178 matthew 9743: =item $labels: array ref holding the labels to use on the x-axis for the bars.
9744:
1.138 matthew 9745: =item @Values: An array of array references. Each array reference holds data
9746: to be plotted in a stacked bar chart.
9747:
1.239 matthew 9748: =item If the final element of @Values is a hash reference the key/value
9749: pairs will be added to the graph definition.
9750:
1.138 matthew 9751: =back
9752:
9753: Returns:
9754:
9755: An <img> tag which references graph.png and the appropriate identifying
9756: information for the plot.
9757:
1.127 matthew 9758: =cut
9759:
9760: ############################################################
9761: ############################################################
1.134 matthew 9762: sub DrawBarGraph {
1.178 matthew 9763: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 9764: #
9765: if (! defined($colors)) {
9766: $colors = ['#33ff00',
9767: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
9768: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
9769: ];
9770: }
1.228 matthew 9771: my $extra_settings = {};
9772: if (ref($Values[-1]) eq 'HASH') {
9773: $extra_settings = pop(@Values);
9774: }
1.127 matthew 9775: #
1.136 matthew 9776: my $identifier = &get_cgi_id();
9777: my $id = 'cgi.'.$identifier;
1.129 matthew 9778: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 9779: return '';
9780: }
1.225 matthew 9781: #
9782: my @Labels;
9783: if (defined($labels)) {
9784: @Labels = @$labels;
9785: } else {
9786: for (my $i=0;$i<@{$Values[0]};$i++) {
9787: push (@Labels,$i+1);
9788: }
9789: }
9790: #
1.129 matthew 9791: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 9792: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 9793: my %ValuesHash;
9794: my $NumSets=1;
9795: foreach my $array (@Values) {
9796: next if (! ref($array));
1.136 matthew 9797: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 9798: join(',',@$array);
1.129 matthew 9799: }
1.127 matthew 9800: #
1.136 matthew 9801: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 9802: if ($NumBars < 3) {
9803: $width = 120+$NumBars*32;
1.220 matthew 9804: $xskip = 1;
1.225 matthew 9805: $bar_width = 30;
9806: } elsif ($NumBars < 5) {
9807: $width = 120+$NumBars*20;
9808: $xskip = 1;
9809: $bar_width = 20;
1.220 matthew 9810: } elsif ($NumBars < 10) {
1.136 matthew 9811: $width = 120+$NumBars*15;
9812: $xskip = 1;
9813: $bar_width = 15;
9814: } elsif ($NumBars <= 25) {
9815: $width = 120+$NumBars*11;
9816: $xskip = 5;
9817: $bar_width = 8;
9818: } elsif ($NumBars <= 50) {
9819: $width = 120+$NumBars*8;
9820: $xskip = 5;
9821: $bar_width = 4;
9822: } else {
9823: $width = 120+$NumBars*8;
9824: $xskip = 5;
9825: $bar_width = 4;
9826: }
9827: #
1.137 matthew 9828: $Max = 1 if ($Max < 1);
9829: if ( int($Max) < $Max ) {
9830: $Max++;
9831: $Max = int($Max);
9832: }
1.127 matthew 9833: $Title = '' if (! defined($Title));
9834: $xlabel = '' if (! defined($xlabel));
9835: $ylabel = '' if (! defined($ylabel));
1.369 www 9836: $ValuesHash{$id.'.title'} = &escape($Title);
9837: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
9838: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 9839: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 9840: $ValuesHash{$id.'.NumBars'} = $NumBars;
9841: $ValuesHash{$id.'.NumSets'} = $NumSets;
9842: $ValuesHash{$id.'.PlotType'} = 'bar';
9843: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9844: $ValuesHash{$id.'.height'} = $height;
9845: $ValuesHash{$id.'.width'} = $width;
9846: $ValuesHash{$id.'.xskip'} = $xskip;
9847: $ValuesHash{$id.'.bar_width'} = $bar_width;
9848: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 9849: #
1.228 matthew 9850: # Deal with other parameters
9851: while (my ($key,$value) = each(%$extra_settings)) {
9852: $ValuesHash{$id.'.'.$key} = $value;
9853: }
9854: #
1.646 raeburn 9855: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 9856: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9857: }
9858:
9859: ############################################################
9860: ############################################################
9861:
9862: =pod
9863:
1.648 raeburn 9864: =item * &DrawXYGraph()
1.137 matthew 9865:
1.138 matthew 9866: Facilitates the plotting of data in an XY graph.
9867: Puts plot definition data into the users environment in order for
9868: graph.png to plot it. Returns an <img> tag for the plot.
9869:
9870: Inputs:
9871:
9872: =over 4
9873:
9874: =item $Title: string, the title of the plot
9875:
9876: =item $xlabel: string, text describing the X-axis of the plot
9877:
9878: =item $ylabel: string, text describing the Y-axis of the plot
9879:
9880: =item $Max: scalar, the maximum Y value to use in the plot
9881: If $Max is < any data point, the graph will not be rendered.
9882:
9883: =item $colors: Array ref containing the hex color codes for the data to be
9884: plotted in. If undefined, default values will be used.
9885:
9886: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9887:
9888: =item $Ydata: Array ref containing Array refs.
1.185 www 9889: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 9890:
9891: =item %Values: hash indicating or overriding any default values which are
9892: passed to graph.png.
9893: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9894:
9895: =back
9896:
9897: Returns:
9898:
9899: An <img> tag which references graph.png and the appropriate identifying
9900: information for the plot.
9901:
1.137 matthew 9902: =cut
9903:
9904: ############################################################
9905: ############################################################
9906: sub DrawXYGraph {
9907: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
9908: #
9909: # Create the identifier for the graph
9910: my $identifier = &get_cgi_id();
9911: my $id = 'cgi.'.$identifier;
9912: #
9913: $Title = '' if (! defined($Title));
9914: $xlabel = '' if (! defined($xlabel));
9915: $ylabel = '' if (! defined($ylabel));
9916: my %ValuesHash =
9917: (
1.369 www 9918: $id.'.title' => &escape($Title),
9919: $id.'.xlabel' => &escape($xlabel),
9920: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 9921: $id.'.y_max_value'=> $Max,
9922: $id.'.labels' => join(',',@$Xlabels),
9923: $id.'.PlotType' => 'XY',
9924: );
9925: #
9926: if (defined($colors) && ref($colors) eq 'ARRAY') {
9927: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9928: }
9929: #
9930: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
9931: return '';
9932: }
9933: my $NumSets=1;
1.138 matthew 9934: foreach my $array (@{$Ydata}){
1.137 matthew 9935: next if (! ref($array));
9936: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
9937: }
1.138 matthew 9938: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 9939: #
9940: # Deal with other parameters
9941: while (my ($key,$value) = each(%Values)) {
9942: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 9943: }
9944: #
1.646 raeburn 9945: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 9946: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9947: }
9948:
9949: ############################################################
9950: ############################################################
9951:
9952: =pod
9953:
1.648 raeburn 9954: =item * &DrawXYYGraph()
1.138 matthew 9955:
9956: Facilitates the plotting of data in an XY graph with two Y axes.
9957: Puts plot definition data into the users environment in order for
9958: graph.png to plot it. Returns an <img> tag for the plot.
9959:
9960: Inputs:
9961:
9962: =over 4
9963:
9964: =item $Title: string, the title of the plot
9965:
9966: =item $xlabel: string, text describing the X-axis of the plot
9967:
9968: =item $ylabel: string, text describing the Y-axis of the plot
9969:
9970: =item $colors: Array ref containing the hex color codes for the data to be
9971: plotted in. If undefined, default values will be used.
9972:
9973: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9974:
9975: =item $Ydata1: The first data set
9976:
9977: =item $Min1: The minimum value of the left Y-axis
9978:
9979: =item $Max1: The maximum value of the left Y-axis
9980:
9981: =item $Ydata2: The second data set
9982:
9983: =item $Min2: The minimum value of the right Y-axis
9984:
9985: =item $Max2: The maximum value of the left Y-axis
9986:
9987: =item %Values: hash indicating or overriding any default values which are
9988: passed to graph.png.
9989: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9990:
9991: =back
9992:
9993: Returns:
9994:
9995: An <img> tag which references graph.png and the appropriate identifying
9996: information for the plot.
1.136 matthew 9997:
9998: =cut
9999:
10000: ############################################################
10001: ############################################################
1.137 matthew 10002: sub DrawXYYGraph {
10003: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
10004: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 10005: #
10006: # Create the identifier for the graph
10007: my $identifier = &get_cgi_id();
10008: my $id = 'cgi.'.$identifier;
10009: #
10010: $Title = '' if (! defined($Title));
10011: $xlabel = '' if (! defined($xlabel));
10012: $ylabel = '' if (! defined($ylabel));
10013: my %ValuesHash =
10014: (
1.369 www 10015: $id.'.title' => &escape($Title),
10016: $id.'.xlabel' => &escape($xlabel),
10017: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 10018: $id.'.labels' => join(',',@$Xlabels),
10019: $id.'.PlotType' => 'XY',
10020: $id.'.NumSets' => 2,
1.137 matthew 10021: $id.'.two_axes' => 1,
10022: $id.'.y1_max_value' => $Max1,
10023: $id.'.y1_min_value' => $Min1,
10024: $id.'.y2_max_value' => $Max2,
10025: $id.'.y2_min_value' => $Min2,
1.136 matthew 10026: );
10027: #
1.137 matthew 10028: if (defined($colors) && ref($colors) eq 'ARRAY') {
10029: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
10030: }
10031: #
10032: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
10033: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 10034: return '';
10035: }
10036: my $NumSets=1;
1.137 matthew 10037: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 10038: next if (! ref($array));
10039: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 10040: }
10041: #
10042: # Deal with other parameters
10043: while (my ($key,$value) = each(%Values)) {
10044: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 10045: }
10046: #
1.646 raeburn 10047: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 10048: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 10049: }
10050:
10051: ############################################################
10052: ############################################################
10053:
10054: =pod
10055:
1.157 matthew 10056: =back
10057:
1.139 matthew 10058: =head1 Statistics helper routines?
10059:
10060: Bad place for them but what the hell.
10061:
1.157 matthew 10062: =over 4
10063:
1.648 raeburn 10064: =item * &chartlink()
1.139 matthew 10065:
10066: Returns a link to the chart for a specific student.
10067:
10068: Inputs:
10069:
10070: =over 4
10071:
10072: =item $linktext: The text of the link
10073:
10074: =item $sname: The students username
10075:
10076: =item $sdomain: The students domain
10077:
10078: =back
10079:
1.157 matthew 10080: =back
10081:
1.139 matthew 10082: =cut
10083:
10084: ############################################################
10085: ############################################################
10086: sub chartlink {
10087: my ($linktext, $sname, $sdomain) = @_;
10088: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 10089: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 10090: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 10091: '">'.$linktext.'</a>';
1.153 matthew 10092: }
10093:
10094: #######################################################
10095: #######################################################
10096:
10097: =pod
10098:
10099: =head1 Course Environment Routines
1.157 matthew 10100:
10101: =over 4
1.153 matthew 10102:
1.648 raeburn 10103: =item * &restore_course_settings()
1.153 matthew 10104:
1.648 raeburn 10105: =item * &store_course_settings()
1.153 matthew 10106:
10107: Restores/Store indicated form parameters from the course environment.
10108: Will not overwrite existing values of the form parameters.
10109:
10110: Inputs:
10111: a scalar describing the data (e.g. 'chart', 'problem_analysis')
10112:
10113: a hash ref describing the data to be stored. For example:
10114:
10115: %Save_Parameters = ('Status' => 'scalar',
10116: 'chartoutputmode' => 'scalar',
10117: 'chartoutputdata' => 'scalar',
10118: 'Section' => 'array',
1.373 raeburn 10119: 'Group' => 'array',
1.153 matthew 10120: 'StudentData' => 'array',
10121: 'Maps' => 'array');
10122:
10123: Returns: both routines return nothing
10124:
1.631 raeburn 10125: =back
10126:
1.153 matthew 10127: =cut
10128:
10129: #######################################################
10130: #######################################################
10131: sub store_course_settings {
1.496 albertel 10132: return &store_settings($env{'request.course.id'},@_);
10133: }
10134:
10135: sub store_settings {
1.153 matthew 10136: # save to the environment
10137: # appenv the same items, just to be safe
1.300 albertel 10138: my $udom = $env{'user.domain'};
10139: my $uname = $env{'user.name'};
1.496 albertel 10140: my ($context,$prefix,$Settings) = @_;
1.153 matthew 10141: my %SaveHash;
10142: my %AppHash;
10143: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 10144: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 10145: my $envname = 'environment.'.$basename;
1.258 albertel 10146: if (exists($env{'form.'.$setting})) {
1.153 matthew 10147: # Save this value away
10148: if ($type eq 'scalar' &&
1.258 albertel 10149: (! exists($env{$envname}) ||
10150: $env{$envname} ne $env{'form.'.$setting})) {
10151: $SaveHash{$basename} = $env{'form.'.$setting};
10152: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 10153: } elsif ($type eq 'array') {
10154: my $stored_form;
1.258 albertel 10155: if (ref($env{'form.'.$setting})) {
1.153 matthew 10156: $stored_form = join(',',
10157: map {
1.369 www 10158: &escape($_);
1.258 albertel 10159: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 10160: } else {
10161: $stored_form =
1.369 www 10162: &escape($env{'form.'.$setting});
1.153 matthew 10163: }
10164: # Determine if the array contents are the same.
1.258 albertel 10165: if ($stored_form ne $env{$envname}) {
1.153 matthew 10166: $SaveHash{$basename} = $stored_form;
10167: $AppHash{$envname} = $stored_form;
10168: }
10169: }
10170: }
10171: }
10172: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 10173: $udom,$uname);
1.153 matthew 10174: if ($put_result !~ /^(ok|delayed)/) {
10175: &Apache::lonnet::logthis('unable to save form parameters, '.
10176: 'got error:'.$put_result);
10177: }
10178: # Make sure these settings stick around in this session, too
1.646 raeburn 10179: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 10180: return;
10181: }
10182:
10183: sub restore_course_settings {
1.499 albertel 10184: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 10185: }
10186:
10187: sub restore_settings {
10188: my ($context,$prefix,$Settings) = @_;
1.153 matthew 10189: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 10190: next if (exists($env{'form.'.$setting}));
1.496 albertel 10191: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 10192: '.'.$setting;
1.258 albertel 10193: if (exists($env{$envname})) {
1.153 matthew 10194: if ($type eq 'scalar') {
1.258 albertel 10195: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 10196: } elsif ($type eq 'array') {
1.258 albertel 10197: $env{'form.'.$setting} = [
1.153 matthew 10198: map {
1.369 www 10199: &unescape($_);
1.258 albertel 10200: } split(',',$env{$envname})
1.153 matthew 10201: ];
10202: }
10203: }
10204: }
1.127 matthew 10205: }
10206:
1.618 raeburn 10207: #######################################################
10208: #######################################################
10209:
10210: =pod
10211:
10212: =head1 Domain E-mail Routines
10213:
10214: =over 4
10215:
1.648 raeburn 10216: =item * &build_recipient_list()
1.618 raeburn 10217:
1.884 raeburn 10218: Build recipient lists for five types of e-mail:
1.766 raeburn 10219: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884 raeburn 10220: (d) Help requests, (e) Course requests needing approval, generated by
10221: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
10222: loncoursequeueadmin.pm respectively.
1.618 raeburn 10223:
10224: Inputs:
1.619 raeburn 10225: defmail (scalar - email address of default recipient),
1.618 raeburn 10226: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 10227: defdom (domain for which to retrieve configuration settings),
10228: origmail (scalar - email address of recipient from loncapa.conf,
10229: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 10230:
1.655 raeburn 10231: Returns: comma separated list of addresses to which to send e-mail.
10232:
10233: =back
1.618 raeburn 10234:
10235: =cut
10236:
10237: ############################################################
10238: ############################################################
10239: sub build_recipient_list {
1.619 raeburn 10240: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 10241: my @recipients;
10242: my $otheremails;
10243: my %domconfig =
10244: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
10245: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 10246: if (exists($domconfig{'contacts'}{$mailing})) {
10247: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
10248: my @contacts = ('adminemail','supportemail');
10249: foreach my $item (@contacts) {
10250: if ($domconfig{'contacts'}{$mailing}{$item}) {
10251: my $addr = $domconfig{'contacts'}{$item};
10252: if (!grep(/^\Q$addr\E$/,@recipients)) {
10253: push(@recipients,$addr);
10254: }
1.619 raeburn 10255: }
1.766 raeburn 10256: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 10257: }
10258: }
1.766 raeburn 10259: } elsif ($origmail ne '') {
10260: push(@recipients,$origmail);
1.618 raeburn 10261: }
1.619 raeburn 10262: } elsif ($origmail ne '') {
10263: push(@recipients,$origmail);
1.618 raeburn 10264: }
1.688 raeburn 10265: if (defined($defmail)) {
10266: if ($defmail ne '') {
10267: push(@recipients,$defmail);
10268: }
1.618 raeburn 10269: }
10270: if ($otheremails) {
1.619 raeburn 10271: my @others;
10272: if ($otheremails =~ /,/) {
10273: @others = split(/,/,$otheremails);
1.618 raeburn 10274: } else {
1.619 raeburn 10275: push(@others,$otheremails);
10276: }
10277: foreach my $addr (@others) {
10278: if (!grep(/^\Q$addr\E$/,@recipients)) {
10279: push(@recipients,$addr);
10280: }
1.618 raeburn 10281: }
10282: }
1.619 raeburn 10283: my $recipientlist = join(',',@recipients);
1.618 raeburn 10284: return $recipientlist;
10285: }
10286:
1.127 matthew 10287: ############################################################
10288: ############################################################
1.154 albertel 10289:
1.655 raeburn 10290: =pod
10291:
10292: =head1 Course Catalog Routines
10293:
10294: =over 4
10295:
10296: =item * &gather_categories()
10297:
10298: Converts category definitions - keys of categories hash stored in
10299: coursecategories in configuration.db on the primary library server in a
10300: domain - to an array. Also generates javascript and idx hash used to
10301: generate Domain Coordinator interface for editing Course Categories.
10302:
10303: Inputs:
1.663 raeburn 10304:
1.655 raeburn 10305: categories (reference to hash of category definitions).
1.663 raeburn 10306:
1.655 raeburn 10307: cats (reference to array of arrays/hashes which encapsulates hierarchy of
10308: categories and subcategories).
1.663 raeburn 10309:
1.655 raeburn 10310: idx (reference to hash of counters used in Domain Coordinator interface for
10311: editing Course Categories).
1.663 raeburn 10312:
1.655 raeburn 10313: jsarray (reference to array of categories used to create Javascript arrays for
10314: Domain Coordinator interface for editing Course Categories).
10315:
10316: Returns: nothing
10317:
10318: Side effects: populates cats, idx and jsarray.
10319:
10320: =cut
10321:
10322: sub gather_categories {
10323: my ($categories,$cats,$idx,$jsarray) = @_;
10324: my %counters;
10325: my $num = 0;
10326: foreach my $item (keys(%{$categories})) {
10327: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
10328: if ($container eq '' && $depth == 0) {
10329: $cats->[$depth][$categories->{$item}] = $cat;
10330: } else {
10331: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
10332: }
10333: my ($escitem,$tail) = split(/:/,$item,2);
10334: if ($counters{$tail} eq '') {
10335: $counters{$tail} = $num;
10336: $num ++;
10337: }
10338: if (ref($idx) eq 'HASH') {
10339: $idx->{$item} = $counters{$tail};
10340: }
10341: if (ref($jsarray) eq 'ARRAY') {
10342: push(@{$jsarray->[$counters{$tail}]},$item);
10343: }
10344: }
10345: return;
10346: }
10347:
10348: =pod
10349:
10350: =item * &extract_categories()
10351:
10352: Used to generate breadcrumb trails for course categories.
10353:
10354: Inputs:
1.663 raeburn 10355:
1.655 raeburn 10356: categories (reference to hash of category definitions).
1.663 raeburn 10357:
1.655 raeburn 10358: cats (reference to array of arrays/hashes which encapsulates hierarchy of
10359: categories and subcategories).
1.663 raeburn 10360:
1.655 raeburn 10361: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 10362:
1.655 raeburn 10363: allitems (reference to hash - key is category key
10364: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 10365:
1.655 raeburn 10366: idx (reference to hash of counters used in Domain Coordinator interface for
10367: editing Course Categories).
1.663 raeburn 10368:
1.655 raeburn 10369: jsarray (reference to array of categories used to create Javascript arrays for
10370: Domain Coordinator interface for editing Course Categories).
10371:
1.665 raeburn 10372: subcats (reference to hash of arrays containing all subcategories within each
10373: category, -recursive)
10374:
1.655 raeburn 10375: Returns: nothing
10376:
10377: Side effects: populates trails and allitems hash references.
10378:
10379: =cut
10380:
10381: sub extract_categories {
1.665 raeburn 10382: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 10383: if (ref($categories) eq 'HASH') {
10384: &gather_categories($categories,$cats,$idx,$jsarray);
10385: if (ref($cats->[0]) eq 'ARRAY') {
10386: for (my $i=0; $i<@{$cats->[0]}; $i++) {
10387: my $name = $cats->[0][$i];
10388: my $item = &escape($name).'::0';
10389: my $trailstr;
10390: if ($name eq 'instcode') {
10391: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 10392: } elsif ($name eq 'communities') {
10393: $trailstr = &mt('Communities');
1.655 raeburn 10394: } else {
10395: $trailstr = $name;
10396: }
10397: if ($allitems->{$item} eq '') {
10398: push(@{$trails},$trailstr);
10399: $allitems->{$item} = scalar(@{$trails})-1;
10400: }
10401: my @parents = ($name);
10402: if (ref($cats->[1]{$name}) eq 'ARRAY') {
10403: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
10404: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 10405: if (ref($subcats) eq 'HASH') {
10406: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
10407: }
10408: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
10409: }
10410: } else {
10411: if (ref($subcats) eq 'HASH') {
10412: $subcats->{$item} = [];
1.655 raeburn 10413: }
10414: }
10415: }
10416: }
10417: }
10418: return;
10419: }
10420:
10421: =pod
10422:
10423: =item *&recurse_categories()
10424:
10425: Recursively used to generate breadcrumb trails for course categories.
10426:
10427: Inputs:
1.663 raeburn 10428:
1.655 raeburn 10429: cats (reference to array of arrays/hashes which encapsulates hierarchy of
10430: categories and subcategories).
1.663 raeburn 10431:
1.655 raeburn 10432: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 10433:
10434: category (current course category, for which breadcrumb trail is being generated).
10435:
10436: trails (reference to array of breadcrumb trails for each category).
10437:
1.655 raeburn 10438: allitems (reference to hash - key is category key
10439: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 10440:
1.655 raeburn 10441: parents (array containing containers directories for current category,
10442: back to top level).
10443:
10444: Returns: nothing
10445:
10446: Side effects: populates trails and allitems hash references
10447:
10448: =cut
10449:
10450: sub recurse_categories {
1.665 raeburn 10451: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 10452: my $shallower = $depth - 1;
10453: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
10454: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
10455: my $name = $cats->[$depth]{$category}[$k];
10456: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
10457: my $trailstr = join(' -> ',(@{$parents},$category));
10458: if ($allitems->{$item} eq '') {
10459: push(@{$trails},$trailstr);
10460: $allitems->{$item} = scalar(@{$trails})-1;
10461: }
10462: my $deeper = $depth+1;
10463: push(@{$parents},$category);
1.665 raeburn 10464: if (ref($subcats) eq 'HASH') {
10465: my $subcat = &escape($name).':'.$category.':'.$depth;
10466: for (my $j=@{$parents}; $j>=0; $j--) {
10467: my $higher;
10468: if ($j > 0) {
10469: $higher = &escape($parents->[$j]).':'.
10470: &escape($parents->[$j-1]).':'.$j;
10471: } else {
10472: $higher = &escape($parents->[$j]).'::'.$j;
10473: }
10474: push(@{$subcats->{$higher}},$subcat);
10475: }
10476: }
10477: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
10478: $subcats);
1.655 raeburn 10479: pop(@{$parents});
10480: }
10481: } else {
10482: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
10483: my $trailstr = join(' -> ',(@{$parents},$category));
10484: if ($allitems->{$item} eq '') {
10485: push(@{$trails},$trailstr);
10486: $allitems->{$item} = scalar(@{$trails})-1;
10487: }
10488: }
10489: return;
10490: }
10491:
1.663 raeburn 10492: =pod
10493:
10494: =item *&assign_categories_table()
10495:
10496: Create a datatable for display of hierarchical categories in a domain,
10497: with checkboxes to allow a course to be categorized.
10498:
10499: Inputs:
10500:
10501: cathash - reference to hash of categories defined for the domain (from
10502: configuration.db)
10503:
10504: currcat - scalar with an & separated list of categories assigned to a course.
10505:
1.919 raeburn 10506: type - scalar contains course type (Course or Community).
10507:
1.663 raeburn 10508: Returns: $output (markup to be displayed)
10509:
10510: =cut
10511:
10512: sub assign_categories_table {
1.919 raeburn 10513: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 10514: my $output;
10515: if (ref($cathash) eq 'HASH') {
10516: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
10517: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
10518: $maxdepth = scalar(@cats);
10519: if (@cats > 0) {
10520: my $itemcount = 0;
10521: if (ref($cats[0]) eq 'ARRAY') {
10522: my @currcategories;
10523: if ($currcat ne '') {
10524: @currcategories = split('&',$currcat);
10525: }
1.919 raeburn 10526: my $table;
1.663 raeburn 10527: for (my $i=0; $i<@{$cats[0]}; $i++) {
10528: my $parent = $cats[0][$i];
1.919 raeburn 10529: next if ($parent eq 'instcode');
10530: if ($type eq 'Community') {
10531: next unless ($parent eq 'communities');
10532: } else {
10533: next if ($parent eq 'communities');
10534: }
1.663 raeburn 10535: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
10536: my $item = &escape($parent).'::0';
10537: my $checked = '';
10538: if (@currcategories > 0) {
10539: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 10540: $checked = ' checked="checked"';
1.663 raeburn 10541: }
10542: }
1.919 raeburn 10543: my $parent_title = $parent;
10544: if ($parent eq 'communities') {
10545: $parent_title = &mt('Communities');
10546: }
10547: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
10548: '<input type="checkbox" name="usecategory" value="'.
10549: $item.'"'.$checked.' />'.$parent_title.'</span>'.
10550: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 10551: my $depth = 1;
10552: push(@path,$parent);
1.919 raeburn 10553: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 10554: pop(@path);
1.919 raeburn 10555: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 10556: $itemcount ++;
10557: }
1.919 raeburn 10558: if ($itemcount) {
10559: $output = &Apache::loncommon::start_data_table().
10560: $table.
10561: &Apache::loncommon::end_data_table();
10562: }
1.663 raeburn 10563: }
10564: }
10565: }
10566: return $output;
10567: }
10568:
10569: =pod
10570:
10571: =item *&assign_category_rows()
10572:
10573: Create a datatable row for display of nested categories in a domain,
10574: with checkboxes to allow a course to be categorized,called recursively.
10575:
10576: Inputs:
10577:
10578: itemcount - track row number for alternating colors
10579:
10580: cats - reference to array of arrays/hashes which encapsulates hierarchy of
10581: categories and subcategories.
10582:
10583: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
10584:
10585: parent - parent of current category item
10586:
10587: path - Array containing all categories back up through the hierarchy from the
10588: current category to the top level.
10589:
10590: currcategories - reference to array of current categories assigned to the course
10591:
10592: Returns: $output (markup to be displayed).
10593:
10594: =cut
10595:
10596: sub assign_category_rows {
10597: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
10598: my ($text,$name,$item,$chgstr);
10599: if (ref($cats) eq 'ARRAY') {
10600: my $maxdepth = scalar(@{$cats});
10601: if (ref($cats->[$depth]) eq 'HASH') {
10602: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
10603: my $numchildren = @{$cats->[$depth]{$parent}};
10604: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
10605: $text .= '<td><table class="LC_datatable">';
10606: for (my $j=0; $j<$numchildren; $j++) {
10607: $name = $cats->[$depth]{$parent}[$j];
10608: $item = &escape($name).':'.&escape($parent).':'.$depth;
10609: my $deeper = $depth+1;
10610: my $checked = '';
10611: if (ref($currcategories) eq 'ARRAY') {
10612: if (@{$currcategories} > 0) {
10613: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 10614: $checked = ' checked="checked"';
1.663 raeburn 10615: }
10616: }
10617: }
1.664 raeburn 10618: $text .= '<tr><td><span class="LC_nobreak"><label>'.
10619: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 10620: $item.'"'.$checked.' />'.$name.'</label></span>'.
10621: '<input type="hidden" name="catname" value="'.$name.'" />'.
10622: '</td><td>';
1.663 raeburn 10623: if (ref($path) eq 'ARRAY') {
10624: push(@{$path},$name);
10625: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
10626: pop(@{$path});
10627: }
10628: $text .= '</td></tr>';
10629: }
10630: $text .= '</table></td>';
10631: }
10632: }
10633: }
10634: return $text;
10635: }
10636:
1.655 raeburn 10637: ############################################################
10638: ############################################################
10639:
10640:
1.443 albertel 10641: sub commit_customrole {
1.664 raeburn 10642: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 10643: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 10644: ($start?', '.&mt('starting').' '.localtime($start):'').
10645: ($end?', ending '.localtime($end):'').': <b>'.
10646: &Apache::lonnet::assigncustomrole(
1.664 raeburn 10647: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 10648: '</b><br />';
10649: return $output;
10650: }
10651:
10652: sub commit_standardrole {
1.541 raeburn 10653: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
10654: my ($output,$logmsg,$linefeed);
10655: if ($context eq 'auto') {
10656: $linefeed = "\n";
10657: } else {
10658: $linefeed = "<br />\n";
10659: }
1.443 albertel 10660: if ($three eq 'st') {
1.541 raeburn 10661: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
10662: $one,$two,$sec,$context);
10663: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 10664: ($result eq 'unknown_course') || ($result eq 'refused')) {
10665: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 10666: } else {
1.541 raeburn 10667: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 10668: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 10669: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
10670: if ($context eq 'auto') {
10671: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
10672: } else {
10673: $output .= '<b>'.$result.'</b>'.$linefeed.
10674: &mt('Add to classlist').': <b>ok</b>';
10675: }
10676: $output .= $linefeed;
1.443 albertel 10677: }
10678: } else {
10679: $output = &mt('Assigning').' '.$three.' in '.$url.
10680: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 10681: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 10682: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 10683: if ($context eq 'auto') {
10684: $output .= $result.$linefeed;
10685: } else {
10686: $output .= '<b>'.$result.'</b>'.$linefeed;
10687: }
1.443 albertel 10688: }
10689: return $output;
10690: }
10691:
10692: sub commit_studentrole {
1.541 raeburn 10693: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 10694: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 10695: if ($context eq 'auto') {
10696: $linefeed = "\n";
10697: } else {
10698: $linefeed = '<br />'."\n";
10699: }
1.443 albertel 10700: if (defined($one) && defined($two)) {
10701: my $cid=$one.'_'.$two;
10702: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
10703: my $secchange = 0;
10704: my $expire_role_result;
10705: my $modify_section_result;
1.628 raeburn 10706: if ($oldsec ne '-1') {
10707: if ($oldsec ne $sec) {
1.443 albertel 10708: $secchange = 1;
1.628 raeburn 10709: my $now = time;
1.443 albertel 10710: my $uurl='/'.$cid;
10711: $uurl=~s/\_/\//g;
10712: if ($oldsec) {
10713: $uurl.='/'.$oldsec;
10714: }
1.626 raeburn 10715: $oldsecurl = $uurl;
1.628 raeburn 10716: $expire_role_result =
1.652 raeburn 10717: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 10718: if ($env{'request.course.sec'} ne '') {
10719: if ($expire_role_result eq 'refused') {
10720: my @roles = ('st');
10721: my @statuses = ('previous');
10722: my @roledoms = ($one);
10723: my $withsec = 1;
10724: my %roleshash =
10725: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
10726: \@statuses,\@roles,\@roledoms,$withsec);
10727: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
10728: my ($oldstart,$oldend) =
10729: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
10730: if ($oldend > 0 && $oldend <= $now) {
10731: $expire_role_result = 'ok';
10732: }
10733: }
10734: }
10735: }
1.443 albertel 10736: $result = $expire_role_result;
10737: }
10738: }
10739: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 10740: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 10741: if ($modify_section_result =~ /^ok/) {
10742: if ($secchange == 1) {
1.628 raeburn 10743: if ($sec eq '') {
10744: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
10745: } else {
10746: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
10747: }
1.443 albertel 10748: } elsif ($oldsec eq '-1') {
1.628 raeburn 10749: if ($sec eq '') {
10750: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
10751: } else {
10752: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
10753: }
1.443 albertel 10754: } else {
1.628 raeburn 10755: if ($sec eq '') {
10756: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
10757: } else {
10758: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
10759: }
1.443 albertel 10760: }
10761: } else {
1.628 raeburn 10762: if ($secchange) {
10763: $$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;
10764: } else {
10765: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
10766: }
1.443 albertel 10767: }
10768: $result = $modify_section_result;
10769: } elsif ($secchange == 1) {
1.628 raeburn 10770: if ($oldsec eq '') {
10771: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
10772: } else {
10773: $$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;
10774: }
1.626 raeburn 10775: if ($expire_role_result eq 'refused') {
10776: my $newsecurl = '/'.$cid;
10777: $newsecurl =~ s/\_/\//g;
10778: if ($sec ne '') {
10779: $newsecurl.='/'.$sec;
10780: }
10781: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
10782: if ($sec eq '') {
10783: $$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;
10784: } else {
10785: $$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;
10786: }
10787: }
10788: }
1.443 albertel 10789: }
10790: } else {
1.626 raeburn 10791: $$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 10792: $result = "error: incomplete course id\n";
10793: }
10794: return $result;
10795: }
10796:
10797: ############################################################
10798: ############################################################
10799:
1.566 albertel 10800: sub check_clone {
1.578 raeburn 10801: my ($args,$linefeed) = @_;
1.566 albertel 10802: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
10803: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
10804: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
10805: my $clonemsg;
10806: my $can_clone = 0;
1.944 raeburn 10807: my $lctype = lc($args->{'crstype'});
1.908 raeburn 10808: if ($lctype ne 'community') {
10809: $lctype = 'course';
10810: }
1.566 albertel 10811: if ($clonehome eq 'no_host') {
1.944 raeburn 10812: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10813: $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'});
10814: } else {
10815: $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'});
10816: }
1.566 albertel 10817: } else {
10818: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944 raeburn 10819: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10820: if ($clonedesc{'type'} ne 'Community') {
10821: $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'});
10822: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10823: }
10824: }
1.882 raeburn 10825: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
10826: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 10827: $can_clone = 1;
10828: } else {
10829: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
10830: $args->{'clonedomain'},$args->{'clonecourse'});
10831: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 10832: if (grep(/^\*$/,@cloners)) {
10833: $can_clone = 1;
10834: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
10835: $can_clone = 1;
10836: } else {
1.908 raeburn 10837: my $ccrole = 'cc';
1.944 raeburn 10838: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10839: $ccrole = 'co';
10840: }
1.578 raeburn 10841: my %roleshash =
10842: &Apache::lonnet::get_my_roles($args->{'ccuname'},
10843: $args->{'ccdomain'},
1.908 raeburn 10844: 'userroles',['active'],[$ccrole],
1.578 raeburn 10845: [$args->{'clonedomain'}]);
1.908 raeburn 10846: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942 raeburn 10847: $can_clone = 1;
10848: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
10849: $can_clone = 1;
10850: } else {
1.944 raeburn 10851: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10852: $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'});
10853: } else {
10854: $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'});
10855: }
1.578 raeburn 10856: }
1.566 albertel 10857: }
1.578 raeburn 10858: }
1.566 albertel 10859: }
10860: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10861: }
10862:
1.444 albertel 10863: sub construct_course {
1.885 raeburn 10864: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444 albertel 10865: my $outcome;
1.541 raeburn 10866: my $linefeed = '<br />'."\n";
10867: if ($context eq 'auto') {
10868: $linefeed = "\n";
10869: }
1.566 albertel 10870:
10871: #
10872: # Are we cloning?
10873: #
10874: my ($can_clone, $clonemsg, $cloneid, $clonehome);
10875: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 10876: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 10877: if ($context ne 'auto') {
1.578 raeburn 10878: if ($clonemsg ne '') {
10879: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
10880: }
1.566 albertel 10881: }
10882: $outcome .= $clonemsg.$linefeed;
10883:
10884: if (!$can_clone) {
10885: return (0,$outcome);
10886: }
10887: }
10888:
1.444 albertel 10889: #
10890: # Open course
10891: #
10892: my $crstype = lc($args->{'crstype'});
10893: my %cenv=();
10894: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
10895: $args->{'cdescr'},
10896: $args->{'curl'},
10897: $args->{'course_home'},
10898: $args->{'nonstandard'},
10899: $args->{'crscode'},
10900: $args->{'ccuname'}.':'.
10901: $args->{'ccdomain'},
1.882 raeburn 10902: $args->{'crstype'},
1.885 raeburn 10903: $cnum,$context,$category);
1.444 albertel 10904:
10905: # Note: The testing routines depend on this being output; see
10906: # Utils::Course. This needs to at least be output as a comment
10907: # if anyone ever decides to not show this, and Utils::Course::new
10908: # will need to be suitably modified.
1.541 raeburn 10909: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943 raeburn 10910: if ($$courseid =~ /^error:/) {
10911: return (0,$outcome);
10912: }
10913:
1.444 albertel 10914: #
10915: # Check if created correctly
10916: #
1.479 albertel 10917: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 10918: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 10919: if ($crsuhome eq 'no_host') {
10920: $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
10921: return (0,$outcome);
10922: }
1.541 raeburn 10923: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 10924:
1.444 albertel 10925: #
1.566 albertel 10926: # Do the cloning
10927: #
10928: if ($can_clone && $cloneid) {
10929: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
10930: if ($context ne 'auto') {
10931: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
10932: }
10933: $outcome .= $clonemsg.$linefeed;
10934: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 10935: # Copy all files
1.637 www 10936: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 10937: # Restore URL
1.566 albertel 10938: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 10939: # Restore title
1.566 albertel 10940: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 10941: # Restore creation date, creator and creation context.
10942: $cenv{'internal.created'}=$oldcenv{'internal.created'};
10943: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
10944: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 10945: # Mark as cloned
1.566 albertel 10946: $cenv{'clonedfrom'}=$cloneid;
1.638 www 10947: # Need to clone grading mode
10948: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
10949: $cenv{'grading'}=$newenv{'grading'};
10950: # Do not clone these environment entries
10951: &Apache::lonnet::del('environment',
10952: ['default_enrollment_start_date',
10953: 'default_enrollment_end_date',
10954: 'question.email',
10955: 'policy.email',
10956: 'comment.email',
10957: 'pch.users.denied',
1.725 raeburn 10958: 'plc.users.denied',
10959: 'hidefromcat',
10960: 'categories'],
1.638 www 10961: $$crsudom,$$crsunum);
1.444 albertel 10962: }
1.566 albertel 10963:
1.444 albertel 10964: #
10965: # Set environment (will override cloned, if existing)
10966: #
10967: my @sections = ();
10968: my @xlists = ();
10969: if ($args->{'crstype'}) {
10970: $cenv{'type'}=$args->{'crstype'};
10971: }
10972: if ($args->{'crsid'}) {
10973: $cenv{'courseid'}=$args->{'crsid'};
10974: }
10975: if ($args->{'crscode'}) {
10976: $cenv{'internal.coursecode'}=$args->{'crscode'};
10977: }
10978: if ($args->{'crsquota'} ne '') {
10979: $cenv{'internal.coursequota'}=$args->{'crsquota'};
10980: } else {
10981: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
10982: }
10983: if ($args->{'ccuname'}) {
10984: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
10985: ':'.$args->{'ccdomain'};
10986: } else {
10987: $cenv{'internal.courseowner'} = $args->{'curruser'};
10988: }
10989: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
10990: if ($args->{'crssections'}) {
10991: $cenv{'internal.sectionnums'} = '';
10992: if ($args->{'crssections'} =~ m/,/) {
10993: @sections = split/,/,$args->{'crssections'};
10994: } else {
10995: $sections[0] = $args->{'crssections'};
10996: }
10997: if (@sections > 0) {
10998: foreach my $item (@sections) {
10999: my ($sec,$gp) = split/:/,$item;
11000: my $class = $args->{'crscode'}.$sec;
11001: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
11002: $cenv{'internal.sectionnums'} .= $item.',';
11003: unless ($addcheck eq 'ok') {
11004: push @badclasses, $class;
11005: }
11006: }
11007: $cenv{'internal.sectionnums'} =~ s/,$//;
11008: }
11009: }
11010: # do not hide course coordinator from staff listing,
11011: # even if privileged
11012: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
11013: # add crosslistings
11014: if ($args->{'crsxlist'}) {
11015: $cenv{'internal.crosslistings'}='';
11016: if ($args->{'crsxlist'} =~ m/,/) {
11017: @xlists = split/,/,$args->{'crsxlist'};
11018: } else {
11019: $xlists[0] = $args->{'crsxlist'};
11020: }
11021: if (@xlists > 0) {
11022: foreach my $item (@xlists) {
11023: my ($xl,$gp) = split/:/,$item;
11024: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
11025: $cenv{'internal.crosslistings'} .= $item.',';
11026: unless ($addcheck eq 'ok') {
11027: push @badclasses, $xl;
11028: }
11029: }
11030: $cenv{'internal.crosslistings'} =~ s/,$//;
11031: }
11032: }
11033: if ($args->{'autoadds'}) {
11034: $cenv{'internal.autoadds'}=$args->{'autoadds'};
11035: }
11036: if ($args->{'autodrops'}) {
11037: $cenv{'internal.autodrops'}=$args->{'autodrops'};
11038: }
11039: # check for notification of enrollment changes
11040: my @notified = ();
11041: if ($args->{'notify_owner'}) {
11042: if ($args->{'ccuname'} ne '') {
11043: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
11044: }
11045: }
11046: if ($args->{'notify_dc'}) {
11047: if ($uname ne '') {
1.630 raeburn 11048: push(@notified,$uname.':'.$udom);
1.444 albertel 11049: }
11050: }
11051: if (@notified > 0) {
11052: my $notifylist;
11053: if (@notified > 1) {
11054: $notifylist = join(',',@notified);
11055: } else {
11056: $notifylist = $notified[0];
11057: }
11058: $cenv{'internal.notifylist'} = $notifylist;
11059: }
11060: if (@badclasses > 0) {
11061: my %lt=&Apache::lonlocal::texthash(
11062: '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',
11063: 'dnhr' => 'does not have rights to access enrollment in these classes',
11064: 'adby' => 'as determined by the policies of your institution on access to official classlists'
11065: );
1.541 raeburn 11066: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
11067: ' ('.$lt{'adby'}.')';
11068: if ($context eq 'auto') {
11069: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 11070: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 11071: foreach my $item (@badclasses) {
11072: if ($context eq 'auto') {
11073: $outcome .= " - $item\n";
11074: } else {
11075: $outcome .= "<li>$item</li>\n";
11076: }
11077: }
11078: if ($context eq 'auto') {
11079: $outcome .= $linefeed;
11080: } else {
1.566 albertel 11081: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 11082: }
11083: }
1.444 albertel 11084: }
11085: if ($args->{'no_end_date'}) {
11086: $args->{'endaccess'} = 0;
11087: }
11088: $cenv{'internal.autostart'}=$args->{'enrollstart'};
11089: $cenv{'internal.autoend'}=$args->{'enrollend'};
11090: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
11091: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
11092: if ($args->{'showphotos'}) {
11093: $cenv{'internal.showphotos'}=$args->{'showphotos'};
11094: }
11095: $cenv{'internal.authtype'} = $args->{'authtype'};
11096: $cenv{'internal.autharg'} = $args->{'autharg'};
11097: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
11098: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 11099: 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');
11100: if ($context eq 'auto') {
11101: $outcome .= $krb_msg;
11102: } else {
1.566 albertel 11103: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 11104: }
11105: $outcome .= $linefeed;
1.444 albertel 11106: }
11107: }
11108: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
11109: if ($args->{'setpolicy'}) {
11110: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
11111: }
11112: if ($args->{'setcontent'}) {
11113: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
11114: }
11115: }
11116: if ($args->{'reshome'}) {
11117: $cenv{'reshome'}=$args->{'reshome'}.'/';
11118: $cenv{'reshome'}=~s/\/+$/\//;
11119: }
11120: #
11121: # course has keyed access
11122: #
11123: if ($args->{'setkeys'}) {
11124: $cenv{'keyaccess'}='yes';
11125: }
11126: # if specified, key authority is not course, but user
11127: # only active if keyaccess is yes
11128: if ($args->{'keyauth'}) {
1.487 albertel 11129: my ($user,$domain) = split(':',$args->{'keyauth'});
11130: $user = &LONCAPA::clean_username($user);
11131: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 11132: if ($user ne '' && $domain ne '') {
1.487 albertel 11133: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 11134: }
11135: }
11136:
11137: if ($args->{'disresdis'}) {
11138: $cenv{'pch.roles.denied'}='st';
11139: }
11140: if ($args->{'disablechat'}) {
11141: $cenv{'plc.roles.denied'}='st';
11142: }
11143:
11144: # Record we've not yet viewed the Course Initialization Helper for this
11145: # course
11146: $cenv{'course.helper.not.run'} = 1;
11147: #
11148: # Use new Randomseed
11149: #
11150: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
11151: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
11152: #
11153: # The encryption code and receipt prefix for this course
11154: #
11155: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
11156: $cenv{'internal.encpref'}=100+int(9*rand(99));
11157: #
11158: # By default, use standard grading
11159: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
11160:
1.541 raeburn 11161: $outcome .= $linefeed.&mt('Setting environment').': '.
11162: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 11163: #
11164: # Open all assignments
11165: #
11166: if ($args->{'openall'}) {
11167: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
11168: my %storecontent = ($storeunder => time,
11169: $storeunder.'.type' => 'date_start');
11170:
11171: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 11172: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 11173: }
11174: #
11175: # Set first page
11176: #
11177: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
11178: || ($cloneid)) {
1.445 albertel 11179: use LONCAPA::map;
1.444 albertel 11180: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 11181:
11182: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
11183: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
11184:
1.444 albertel 11185: $outcome .= ($fatal?$errtext:'read ok').' - ';
11186: my $title; my $url;
11187: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 11188: $title=&mt('Syllabus');
1.444 albertel 11189: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
11190: } else {
1.963 raeburn 11191: $title=&mt('Table of Contents');
1.444 albertel 11192: $url='/adm/navmaps';
11193: }
1.445 albertel 11194:
11195: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
11196: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
11197:
11198: if ($errtext) { $fatal=2; }
1.541 raeburn 11199: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 11200: }
1.566 albertel 11201:
11202: return (1,$outcome);
1.444 albertel 11203: }
11204:
11205: ############################################################
11206: ############################################################
11207:
1.953 droeschl 11208: #SD
11209: # only Community and Course, or anything else?
1.378 raeburn 11210: sub course_type {
11211: my ($cid) = @_;
11212: if (!defined($cid)) {
11213: $cid = $env{'request.course.id'};
11214: }
1.404 albertel 11215: if (defined($env{'course.'.$cid.'.type'})) {
11216: return $env{'course.'.$cid.'.type'};
1.378 raeburn 11217: } else {
11218: return 'Course';
1.377 raeburn 11219: }
11220: }
1.156 albertel 11221:
1.406 raeburn 11222: sub group_term {
11223: my $crstype = &course_type();
11224: my %names = (
11225: 'Course' => 'group',
1.865 raeburn 11226: 'Community' => 'group',
1.406 raeburn 11227: );
11228: return $names{$crstype};
11229: }
11230:
1.902 raeburn 11231: sub course_types {
11232: my @types = ('official','unofficial','community');
11233: my %typename = (
11234: official => 'Official course',
11235: unofficial => 'Unofficial course',
11236: community => 'Community',
11237: );
11238: return (\@types,\%typename);
11239: }
11240:
1.156 albertel 11241: sub icon {
11242: my ($file)=@_;
1.505 albertel 11243: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 11244: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 11245: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 11246: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
11247: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
11248: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
11249: $curfext.".gif") {
11250: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
11251: $curfext.".gif";
11252: }
11253: }
1.249 albertel 11254: return &lonhttpdurl($iconname);
1.154 albertel 11255: }
1.84 albertel 11256:
1.575 albertel 11257: sub lonhttpdurl {
1.692 www 11258: #
11259: # Had been used for "small fry" static images on separate port 8080.
11260: # Modify here if lightweight http functionality desired again.
11261: # Currently eliminated due to increasing firewall issues.
11262: #
1.575 albertel 11263: my ($url)=@_;
1.692 www 11264: return $url;
1.215 albertel 11265: }
11266:
1.213 albertel 11267: sub connection_aborted {
11268: my ($r)=@_;
11269: $r->print(" ");$r->rflush();
11270: my $c = $r->connection;
11271: return $c->aborted();
11272: }
11273:
1.221 foxr 11274: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 11275: # strings as 'strings'.
11276: sub escape_single {
1.221 foxr 11277: my ($input) = @_;
1.223 albertel 11278: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 11279: $input =~ s/\'/\\\'/g; # Esacpe the 's....
11280: return $input;
11281: }
1.223 albertel 11282:
1.222 foxr 11283: # Same as escape_single, but escape's "'s This
11284: # can be used for "strings"
11285: sub escape_double {
11286: my ($input) = @_;
11287: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
11288: $input =~ s/\"/\\\"/g; # Esacpe the "s....
11289: return $input;
11290: }
1.223 albertel 11291:
1.222 foxr 11292: # Escapes the last element of a full URL.
11293: sub escape_url {
11294: my ($url) = @_;
1.238 raeburn 11295: my @urlslices = split(/\//, $url,-1);
1.369 www 11296: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 11297: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 11298: }
1.462 albertel 11299:
1.820 raeburn 11300: sub compare_arrays {
11301: my ($arrayref1,$arrayref2) = @_;
11302: my (@difference,%count);
11303: @difference = ();
11304: %count = ();
11305: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
11306: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
11307: foreach my $element (keys(%count)) {
11308: if ($count{$element} == 1) {
11309: push(@difference,$element);
11310: }
11311: }
11312: }
11313: return @difference;
11314: }
11315:
1.817 bisitz 11316: # -------------------------------------------------------- Initialize user login
1.462 albertel 11317: sub init_user_environment {
1.463 albertel 11318: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 11319: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
11320:
11321: my $public=($username eq 'public' && $domain eq 'public');
11322:
11323: # See if old ID present, if so, remove
11324:
11325: my ($filename,$cookie,$userroles);
11326: my $now=time;
11327:
11328: if ($public) {
11329: my $max_public=100;
11330: my $oldest;
11331: my $oldest_time=0;
11332: for(my $next=1;$next<=$max_public;$next++) {
11333: if (-e $lonids."/publicuser_$next.id") {
11334: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
11335: if ($mtime<$oldest_time || !$oldest_time) {
11336: $oldest_time=$mtime;
11337: $oldest=$next;
11338: }
11339: } else {
11340: $cookie="publicuser_$next";
11341: last;
11342: }
11343: }
11344: if (!$cookie) { $cookie="publicuser_$oldest"; }
11345: } else {
1.463 albertel 11346: # if this isn't a robot, kill any existing non-robot sessions
11347: if (!$args->{'robot'}) {
11348: opendir(DIR,$lonids);
11349: while ($filename=readdir(DIR)) {
11350: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
11351: unlink($lonids.'/'.$filename);
11352: }
1.462 albertel 11353: }
1.463 albertel 11354: closedir(DIR);
1.462 albertel 11355: }
11356: # Give them a new cookie
1.463 albertel 11357: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 11358: : $now.$$.int(rand(10000)));
1.463 albertel 11359: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 11360:
11361: # Initialize roles
11362:
11363: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
11364: }
11365: # ------------------------------------ Check browser type and MathML capability
11366:
11367: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
11368: $clientunicode,$clientos) = &decode_user_agent($r);
11369:
11370: # ------------------------------------------------------------- Get environment
11371:
11372: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
11373: my ($tmp) = keys(%userenv);
11374: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
11375: } else {
11376: undef(%userenv);
11377: }
11378: if (($userenv{'interface'}) && (!$form->{'interface'})) {
11379: $form->{'interface'}=$userenv{'interface'};
11380: }
11381: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
11382:
11383: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 11384: foreach my $option ('interface','localpath','localres') {
11385: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 11386: }
11387: # --------------------------------------------------------- Write first profile
11388:
11389: {
11390: my %initial_env =
11391: ("user.name" => $username,
11392: "user.domain" => $domain,
11393: "user.home" => $authhost,
11394: "browser.type" => $clientbrowser,
11395: "browser.version" => $clientversion,
11396: "browser.mathml" => $clientmathml,
11397: "browser.unicode" => $clientunicode,
11398: "browser.os" => $clientos,
11399: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
11400: "request.course.fn" => '',
11401: "request.course.uri" => '',
11402: "request.course.sec" => '',
11403: "request.role" => 'cm',
11404: "request.role.adv" => $env{'user.adv'},
11405: "request.host" => $ENV{'REMOTE_ADDR'},);
11406:
11407: if ($form->{'localpath'}) {
11408: $initial_env{"browser.localpath"} = $form->{'localpath'};
11409: $initial_env{"browser.localres"} = $form->{'localres'};
11410: }
11411:
11412: if ($form->{'interface'}) {
11413: $form->{'interface'}=~s/\W//gs;
11414: $initial_env{"browser.interface"} = $form->{'interface'};
11415: $env{'browser.interface'}=$form->{'interface'};
11416: }
11417:
1.981 raeburn 11418: my %is_adv = ( is_adv => $env{'user.adv'} );
1.1016 raeburn 11419: my %domdef;
11420: unless ($domain eq 'public') {
11421: %domdef = &Apache::lonnet::get_domain_defaults($domain);
11422: }
1.980 raeburn 11423:
1.724 raeburn 11424: foreach my $tool ('aboutme','blog','portfolio') {
11425: $userenv{'availabletools.'.$tool} =
1.980 raeburn 11426: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
11427: undef,\%userenv,\%domdef,\%is_adv);
1.724 raeburn 11428: }
11429:
1.864 raeburn 11430: foreach my $crstype ('official','unofficial','community') {
1.765 raeburn 11431: $userenv{'canrequest.'.$crstype} =
11432: &Apache::lonnet::usertools_access($username,$domain,$crstype,
1.980 raeburn 11433: 'reload','requestcourses',
11434: \%userenv,\%domdef,\%is_adv);
1.765 raeburn 11435: }
11436:
1.462 albertel 11437: $env{'user.environment'} = "$lonids/$cookie.id";
11438:
11439: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
11440: &GDBM_WRCREAT(),0640)) {
11441: &_add_to_env(\%disk_env,\%initial_env);
11442: &_add_to_env(\%disk_env,\%userenv,'environment.');
11443: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 11444: if (ref($args->{'extra_env'})) {
11445: &_add_to_env(\%disk_env,$args->{'extra_env'});
11446: }
1.462 albertel 11447: untie(%disk_env);
11448: } else {
1.705 tempelho 11449: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
11450: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 11451: return 'error: '.$!;
11452: }
11453: }
11454: $env{'request.role'}='cm';
11455: $env{'request.role.adv'}=$env{'user.adv'};
11456: $env{'browser.type'}=$clientbrowser;
11457:
11458: return $cookie;
11459:
11460: }
11461:
11462: sub _add_to_env {
11463: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 11464: if (ref($env_data) eq 'HASH') {
11465: while (my ($key,$value) = each(%$env_data)) {
11466: $idf->{$prefix.$key} = $value;
11467: $env{$prefix.$key} = $value;
11468: }
1.462 albertel 11469: }
11470: }
11471:
1.685 tempelho 11472: # --- Get the symbolic name of a problem and the url
11473: sub get_symb {
11474: my ($request,$silent) = @_;
1.726 raeburn 11475: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 11476: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
11477: if ($symb eq '') {
11478: if (!$silent) {
11479: $request->print("Unable to handle ambiguous references:$url:.");
11480: return ();
11481: }
11482: }
11483: &Apache::lonenc::check_decrypt(\$symb);
11484: return ($symb);
11485: }
11486:
11487: # --------------------------------------------------------------Get annotation
11488:
11489: sub get_annotation {
11490: my ($symb,$enc) = @_;
11491:
11492: my $key = $symb;
11493: if (!$enc) {
11494: $key =
11495: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
11496: }
11497: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
11498: return $annotation{$key};
11499: }
11500:
11501: sub clean_symb {
1.731 raeburn 11502: my ($symb,$delete_enc) = @_;
1.685 tempelho 11503:
11504: &Apache::lonenc::check_decrypt(\$symb);
11505: my $enc = $env{'request.enc'};
1.731 raeburn 11506: if ($delete_enc) {
1.730 raeburn 11507: delete($env{'request.enc'});
11508: }
1.685 tempelho 11509:
11510: return ($symb,$enc);
11511: }
1.462 albertel 11512:
1.990 raeburn 11513: sub build_release_hashes {
11514: my ($checkparms,$checkresponsetypes,$checkcrstypes,$anonsurvey,$randomizetry) = @_;
11515: return unless((ref($checkparms) eq 'HASH') && (ref($checkresponsetypes) eq 'HASH') &&
11516: (ref($checkcrstypes) eq 'HASH') && (ref($anonsurvey) eq 'HASH') &&
11517: (ref($randomizetry) eq 'HASH'));
11518: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
11519: my ($item,$name,$value) = split(/:/,$key);
11520: if ($item eq 'parameter') {
11521: if (ref($checkparms->{$name}) eq 'ARRAY') {
11522: unless(grep(/^\Q$name\E$/,@{$checkparms->{$name}})) {
11523: push(@{$checkparms->{$name}},$value);
11524: }
11525: } else {
11526: push(@{$checkparms->{$name}},$value);
11527: }
11528: } elsif ($item eq 'resourcetag') {
11529: if ($name eq 'responsetype') {
11530: $checkresponsetypes->{$value} = $Apache::lonnet::needsrelease{$key}
11531: }
11532: } elsif ($item eq 'course') {
11533: if ($name eq 'crstype') {
11534: $checkcrstypes->{$value} = $Apache::lonnet::needsrelease{$key};
11535: }
11536: }
11537: }
11538: ($anonsurvey->{major},$anonsurvey->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:anonsurvey'});
11539: ($randomizetry->{major},$randomizetry->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:randomizetry'});
11540: return;
11541: }
11542:
1.41 ng 11543: =pod
11544:
11545: =back
11546:
1.112 bowersj2 11547: =cut
1.41 ng 11548:
1.112 bowersj2 11549: 1;
11550: __END__;
1.41 ng 11551:
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