Annotation of loncom/interface/loncommon.pm, revision 1.1017
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1017 ! raeburn 4: # $Id: loncommon.pm,v 1.1016 2011/08/03 18:25:11 raeburn Exp $
1.10 albertel 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.1 albertel 28:
29: # Makes a table out of the previous attempts
1.2 albertel 30: # Inputs result_from_symbread, user, domain, course_id
1.16 harris41 31: # Reads in non-network-related .tab files
1.1 albertel 32:
1.35 matthew 33: # POD header:
34:
1.45 matthew 35: =pod
36:
1.35 matthew 37: =head1 NAME
38:
39: Apache::loncommon - pile of common routines
40:
41: =head1 SYNOPSIS
42:
1.112 bowersj2 43: Common routines for manipulating connections, student answers,
44: domains, common Javascript fragments, etc.
1.35 matthew 45:
1.112 bowersj2 46: =head1 OVERVIEW
1.35 matthew 47:
1.112 bowersj2 48: A collection of commonly used subroutines that don't have a natural
49: home anywhere else. This collection helps remove
1.35 matthew 50: redundancy from other modules and increase efficiency of memory usage.
51:
52: =cut
53:
54: # End of POD header
1.1 albertel 55: package Apache::loncommon;
56:
57: use strict;
1.258 albertel 58: use Apache::lonnet;
1.46 matthew 59: use GDBM_File;
1.51 www 60: use POSIX qw(strftime mktime);
1.82 www 61: use Apache::lonmenu();
1.498 albertel 62: use Apache::lonenc();
1.117 www 63: use Apache::lonlocal;
1.685 tempelho 64: use Apache::lonnet();
1.139 matthew 65: use HTML::Entities;
1.334 albertel 66: use Apache::lonhtmlcommon();
67: use Apache::loncoursedata();
1.344 albertel 68: use Apache::lontexconvert();
1.444 albertel 69: use Apache::lonclonecourse();
1.479 albertel 70: use LONCAPA qw(:DEFAULT :match);
1.657 raeburn 71: use DateTime::TimeZone;
1.687 raeburn 72: use DateTime::Locale::Catalog;
1.117 www 73:
1.517 raeburn 74: # ---------------------------------------------- Designs
75: use vars qw(%defaultdesign);
76:
1.22 www 77: my $readit;
78:
1.517 raeburn 79:
1.157 matthew 80: ##
81: ## Global Variables
82: ##
1.46 matthew 83:
1.643 foxr 84:
85: # ----------------------------------------------- SSI with retries:
86: #
87:
88: =pod
89:
1.648 raeburn 90: =head1 Server Side include with retries:
1.643 foxr 91:
92: =over 4
93:
1.648 raeburn 94: =item * &ssi_with_retries(resource,retries form)
1.643 foxr 95:
96: Performs an ssi with some number of retries. Retries continue either
97: until the result is ok or until the retry count supplied by the
98: caller is exhausted.
99:
100: Inputs:
1.648 raeburn 101:
102: =over 4
103:
1.643 foxr 104: resource - Identifies the resource to insert.
1.648 raeburn 105:
1.643 foxr 106: retries - Count of the number of retries allowed.
1.648 raeburn 107:
1.643 foxr 108: form - Hash that identifies the rendering options.
109:
1.648 raeburn 110: =back
111:
112: Returns:
113:
114: =over 4
115:
1.643 foxr 116: content - The content of the response. If retries were exhausted this is empty.
1.648 raeburn 117:
1.643 foxr 118: response - The response from the last attempt (which may or may not have been successful.
119:
1.648 raeburn 120: =back
121:
122: =back
123:
1.643 foxr 124: =cut
125:
126: sub ssi_with_retries {
127: my ($resource, $retries, %form) = @_;
128:
129:
130: my $ok = 0; # True if we got a good response.
131: my $content;
132: my $response;
133:
134: # Try to get the ssi done. within the retries count:
135:
136: do {
137: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
138: $ok = $response->is_success;
1.650 www 139: if (!$ok) {
140: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
141: }
1.643 foxr 142: $retries--;
143: } while (!$ok && ($retries > 0));
144:
145: if (!$ok) {
146: $content = ''; # On error return an empty content.
147: }
148: return ($content, $response);
149:
150: }
151:
152:
153:
1.20 www 154: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 155: my %language;
1.124 www 156: my %supported_language;
1.12 harris41 157: my %cprtag;
1.192 taceyjo1 158: my %scprtag;
1.351 www 159: my %fe; my %fd; my %fm;
1.41 ng 160: my %category_extensions;
1.12 harris41 161:
1.46 matthew 162: # ---------------------------------------------- Thesaurus variables
1.144 matthew 163: #
164: # %Keywords:
165: # A hash used by &keyword to determine if a word is considered a keyword.
166: # $thesaurus_db_file
167: # Scalar containing the full path to the thesaurus database.
1.46 matthew 168:
169: my %Keywords;
170: my $thesaurus_db_file;
171:
1.144 matthew 172: #
173: # Initialize values from language.tab, copyright.tab, filetypes.tab,
174: # thesaurus.tab, and filecategories.tab.
175: #
1.18 www 176: BEGIN {
1.46 matthew 177: # Variable initialization
178: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
179: #
1.22 www 180: unless ($readit) {
1.12 harris41 181: # ------------------------------------------------------------------- languages
182: {
1.158 raeburn 183: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
184: '/language.tab';
185: if ( open(my $fh,"<$langtabfile") ) {
1.356 albertel 186: while (my $line = <$fh>) {
187: next if ($line=~/^\#/);
188: chomp($line);
189: my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
1.158 raeburn 190: $language{$key}=$val.' - '.$enc;
191: if ($sup) {
192: $supported_language{$key}=$sup;
193: }
194: }
195: close($fh);
196: }
1.12 harris41 197: }
198: # ------------------------------------------------------------------ copyrights
199: {
1.158 raeburn 200: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
201: '/copyright.tab';
202: if ( open (my $fh,"<$copyrightfile") ) {
1.356 albertel 203: while (my $line = <$fh>) {
204: next if ($line=~/^\#/);
205: chomp($line);
206: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 207: $cprtag{$key}=$val;
208: }
209: close($fh);
210: }
1.12 harris41 211: }
1.351 www 212: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 213: {
214: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
215: '/source_copyright.tab';
216: if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356 albertel 217: while (my $line = <$fh>) {
218: next if ($line =~ /^\#/);
219: chomp($line);
220: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 221: $scprtag{$key}=$val;
222: }
223: close($fh);
224: }
225: }
1.63 www 226:
1.517 raeburn 227: # -------------------------------------------------------------- default domain designs
1.63 www 228: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 229: my $designfile = $designdir.'/default.tab';
230: if ( open (my $fh,"<$designfile") ) {
231: while (my $line = <$fh>) {
232: next if ($line =~ /^\#/);
233: chomp($line);
234: my ($key,$val)=(split(/\=/,$line));
235: if ($val) { $defaultdesign{$key}=$val; }
236: }
237: close($fh);
1.63 www 238: }
239:
1.15 harris41 240: # ------------------------------------------------------------- file categories
241: {
1.158 raeburn 242: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
243: '/filecategories.tab';
244: if ( open (my $fh,"<$categoryfile") ) {
1.356 albertel 245: while (my $line = <$fh>) {
246: next if ($line =~ /^\#/);
247: chomp($line);
248: my ($extension,$category)=(split(/\s+/,$line,2));
1.158 raeburn 249: push @{$category_extensions{lc($category)}},$extension;
250: }
251: close($fh);
252: }
253:
1.15 harris41 254: }
1.12 harris41 255: # ------------------------------------------------------------------ file types
256: {
1.158 raeburn 257: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
258: '/filetypes.tab';
259: if ( open (my $fh,"<$typesfile") ) {
1.356 albertel 260: while (my $line = <$fh>) {
261: next if ($line =~ /^\#/);
262: chomp($line);
263: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 264: if ($descr ne '') {
265: $fe{$ending}=lc($emb);
266: $fd{$ending}=$descr;
1.351 www 267: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 268: }
269: }
270: close($fh);
271: }
1.12 harris41 272: }
1.22 www 273: &Apache::lonnet::logthis(
1.705 tempelho 274: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 275: $readit=1;
1.46 matthew 276: } # end of unless($readit)
1.32 matthew 277:
278: }
1.112 bowersj2 279:
1.42 matthew 280: ###############################################################
281: ## HTML and Javascript Helper Functions ##
282: ###############################################################
283:
284: =pod
285:
1.112 bowersj2 286: =head1 HTML and Javascript Functions
1.42 matthew 287:
1.112 bowersj2 288: =over 4
289:
1.648 raeburn 290: =item * &browser_and_searcher_javascript()
1.112 bowersj2 291:
292: X<browsing, javascript>X<searching, javascript>Returns a string
293: containing javascript with two functions, C<openbrowser> and
294: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
295: tags.
1.42 matthew 296:
1.648 raeburn 297: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 298:
299: inputs: formname, elementname, only, omit
300:
301: formname and elementname indicate the name of the html form and name of
302: the element that the results of the browsing selection are to be placed in.
303:
304: Specifying 'only' will restrict the browser to displaying only files
1.185 www 305: with the given extension. Can be a comma separated list.
1.42 matthew 306:
307: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 308: with the given extension. Can be a comma separated list.
1.42 matthew 309:
1.648 raeburn 310: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 311:
312: Inputs: formname, elementname
313:
314: formname and elementname specify the name of the html form and the name
315: of the element the selection from the search results will be placed in.
1.542 raeburn 316:
1.42 matthew 317: =cut
318:
319: sub browser_and_searcher_javascript {
1.199 albertel 320: my ($mode)=@_;
321: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 322: my $resurl=&escape_single(&lastresurl());
1.42 matthew 323: return <<END;
1.219 albertel 324: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 325: var editbrowser = null;
1.135 albertel 326: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 327: var url = '$resurl/?';
1.42 matthew 328: if (editbrowser == null) {
329: url += 'launch=1&';
330: }
331: url += 'catalogmode=interactive&';
1.199 albertel 332: url += 'mode=$mode&';
1.611 albertel 333: url += 'inhibitmenu=yes&';
1.42 matthew 334: url += 'form=' + formname + '&';
335: if (only != null) {
336: url += 'only=' + only + '&';
1.217 albertel 337: } else {
338: url += 'only=&';
339: }
1.42 matthew 340: if (omit != null) {
341: url += 'omit=' + omit + '&';
1.217 albertel 342: } else {
343: url += 'omit=&';
344: }
1.135 albertel 345: if (titleelement != null) {
346: url += 'titleelement=' + titleelement + '&';
1.217 albertel 347: } else {
348: url += 'titleelement=&';
349: }
1.42 matthew 350: url += 'element=' + elementname + '';
351: var title = 'Browser';
1.435 albertel 352: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 353: options += ',width=700,height=600';
354: editbrowser = open(url,title,options,'1');
355: editbrowser.focus();
356: }
357: var editsearcher;
1.135 albertel 358: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 359: var url = '/adm/searchcat?';
360: if (editsearcher == null) {
361: url += 'launch=1&';
362: }
363: url += 'catalogmode=interactive&';
1.199 albertel 364: url += 'mode=$mode&';
1.42 matthew 365: url += 'form=' + formname + '&';
1.135 albertel 366: if (titleelement != null) {
367: url += 'titleelement=' + titleelement + '&';
1.217 albertel 368: } else {
369: url += 'titleelement=&';
370: }
1.42 matthew 371: url += 'element=' + elementname + '';
372: var title = 'Search';
1.435 albertel 373: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 374: options += ',width=700,height=600';
375: editsearcher = open(url,title,options,'1');
376: editsearcher.focus();
377: }
1.219 albertel 378: // END LON-CAPA Internal -->
1.42 matthew 379: END
1.170 www 380: }
381:
382: sub lastresurl {
1.258 albertel 383: if ($env{'environment.lastresurl'}) {
384: return $env{'environment.lastresurl'}
1.170 www 385: } else {
386: return '/res';
387: }
388: }
389:
390: sub storeresurl {
391: my $resurl=&Apache::lonnet::clutter(shift);
392: unless ($resurl=~/^\/res/) { return 0; }
393: $resurl=~s/\/$//;
394: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 395: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 396: return 1;
1.42 matthew 397: }
398:
1.74 www 399: sub studentbrowser_javascript {
1.111 www 400: unless (
1.258 albertel 401: (($env{'request.course.id'}) &&
1.302 albertel 402: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
403: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
404: '/'.$env{'request.course.sec'})
405: ))
1.258 albertel 406: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 407: ) { return ''; }
1.74 www 408: return (<<'ENDSTDBRW');
1.776 bisitz 409: <script type="text/javascript" language="Javascript">
1.824 bisitz 410: // <![CDATA[
1.74 www 411: var stdeditbrowser;
1.999 www 412: function openstdbrowser(formname,uname,udom,clicker,roleflag,ignorefilter,courseadvonly) {
1.74 www 413: var url = '/adm/pickstudent?';
414: var filter;
1.558 albertel 415: if (!ignorefilter) {
416: eval('filter=document.'+formname+'.'+uname+'.value;');
417: }
1.74 www 418: if (filter != null) {
419: if (filter != '') {
420: url += 'filter='+filter+'&';
421: }
422: }
423: url += 'form=' + formname + '&unameelement='+uname+
1.999 www 424: '&udomelement='+udom+
425: '&clicker='+clicker;
1.111 www 426: if (roleflag) { url+="&roles=1"; }
1.793 raeburn 427: if (courseadvonly) { url+="&courseadvonly=1"; }
1.102 www 428: var title = 'Student_Browser';
1.74 www 429: var options = 'scrollbars=1,resizable=1,menubar=0';
430: options += ',width=700,height=600';
431: stdeditbrowser = open(url,title,options,'1');
432: stdeditbrowser.focus();
433: }
1.824 bisitz 434: // ]]>
1.74 www 435: </script>
436: ENDSTDBRW
437: }
1.42 matthew 438:
1.1003 www 439: sub resourcebrowser_javascript {
440: unless ($env{'request.course.id'}) { return ''; }
1.1004 www 441: return (<<'ENDRESBRW');
1.1003 www 442: <script type="text/javascript" language="Javascript">
443: // <![CDATA[
444: var reseditbrowser;
1.1004 www 445: function openresbrowser(formname,reslink) {
1.1005 www 446: var url = '/adm/pickresource?form='+formname+'&reslink='+reslink;
1.1003 www 447: var title = 'Resource_Browser';
448: var options = 'scrollbars=1,resizable=1,menubar=0';
1.1005 www 449: options += ',width=700,height=500';
1.1004 www 450: reseditbrowser = open(url,title,options,'1');
451: reseditbrowser.focus();
1.1003 www 452: }
453: // ]]>
454: </script>
1.1004 www 455: ENDRESBRW
1.1003 www 456: }
457:
1.74 www 458: sub selectstudent_link {
1.999 www 459: my ($form,$unameele,$udomele,$courseadvonly,$clickerid)=@_;
460: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
461: &Apache::lonhtmlcommon::entity_encode($unameele)."','".
462: &Apache::lonhtmlcommon::entity_encode($udomele)."'";
1.258 albertel 463: if ($env{'request.course.id'}) {
1.302 albertel 464: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
465: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
466: '/'.$env{'request.course.sec'})) {
1.111 www 467: return '';
468: }
1.999 www 469: $callargs.=",'".&Apache::lonhtmlcommon::entity_encode($clickerid)."'";
1.793 raeburn 470: if ($courseadvonly) {
471: $callargs .= ",'',1,1";
472: }
473: return '<span class="LC_nobreak">'.
474: '<a href="javascript:openstdbrowser('.$callargs.');">'.
475: &mt('Select User').'</a></span>';
1.74 www 476: }
1.258 albertel 477: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.1012 www 478: $callargs .= ",'',1";
1.793 raeburn 479: return '<span class="LC_nobreak">'.
480: '<a href="javascript:openstdbrowser('.$callargs.');">'.
481: &mt('Select User').'</a></span>';
1.111 www 482: }
483: return '';
1.91 www 484: }
485:
1.1004 www 486: sub selectresource_link {
487: my ($form,$reslink,$arg)=@_;
488:
489: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
490: &Apache::lonhtmlcommon::entity_encode($reslink)."'";
491: unless ($env{'request.course.id'}) { return $arg; }
492: return '<span class="LC_nobreak">'.
493: '<a href="javascript:openresbrowser('.$callargs.');">'.
494: $arg.'</a></span>';
495: }
496:
497:
498:
1.653 raeburn 499: sub authorbrowser_javascript {
500: return <<"ENDAUTHORBRW";
1.776 bisitz 501: <script type="text/javascript" language="JavaScript">
1.824 bisitz 502: // <![CDATA[
1.653 raeburn 503: var stdeditbrowser;
504:
505: function openauthorbrowser(formname,udom) {
506: var url = '/adm/pickauthor?';
507: url += 'form='+formname+'&roledom='+udom;
508: var title = 'Author_Browser';
509: var options = 'scrollbars=1,resizable=1,menubar=0';
510: options += ',width=700,height=600';
511: stdeditbrowser = open(url,title,options,'1');
512: stdeditbrowser.focus();
513: }
514:
1.824 bisitz 515: // ]]>
1.653 raeburn 516: </script>
517: ENDAUTHORBRW
518: }
519:
1.91 www 520: sub coursebrowser_javascript {
1.909 raeburn 521: my ($domainfilter,$sec_element,$formname,$role_element,$crstype) = @_;
1.932 raeburn 522: my $wintitle = 'Course_Browser';
1.931 raeburn 523: if ($crstype eq 'Community') {
1.932 raeburn 524: $wintitle = 'Community_Browser';
1.909 raeburn 525: }
1.876 raeburn 526: my $id_functions = &javascript_index_functions();
527: my $output = '
1.776 bisitz 528: <script type="text/javascript" language="JavaScript">
1.824 bisitz 529: // <![CDATA[
1.468 raeburn 530: var stdeditbrowser;'."\n";
1.876 raeburn 531:
532: $output .= <<"ENDSTDBRW";
1.909 raeburn 533: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91 www 534: var url = '/adm/pickcourse?';
1.895 raeburn 535: var formid = getFormIdByName(formname);
1.876 raeburn 536: var domainfilter = getDomainFromSelectbox(formname,udom);
1.128 albertel 537: if (domainfilter != null) {
538: if (domainfilter != '') {
539: url += 'domainfilter='+domainfilter+'&';
540: }
541: }
1.91 www 542: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 543: '&cdomelement='+udom+
544: '&cnameelement='+desc;
1.468 raeburn 545: if (extra_element !=null && extra_element != '') {
1.594 raeburn 546: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 547: url += '&roleelement='+extra_element;
548: if (domainfilter == null || domainfilter == '') {
549: url += '&domainfilter='+extra_element;
550: }
1.234 raeburn 551: }
1.468 raeburn 552: else {
553: if (formname == 'portform') {
554: url += '&setroles='+extra_element;
1.800 raeburn 555: } else {
556: if (formname == 'rules') {
557: url += '&fixeddom='+extra_element;
558: }
1.468 raeburn 559: }
560: }
1.230 raeburn 561: }
1.909 raeburn 562: if (type != null && type != '') {
563: url += '&type='+type;
564: }
565: if (type_elem != null && type_elem != '') {
566: url += '&typeelement='+type_elem;
567: }
1.872 raeburn 568: if (formname == 'ccrs') {
569: var ownername = document.forms[formid].ccuname.value;
570: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
571: url += '&cloner='+ownername+':'+ownerdom;
572: }
1.293 raeburn 573: if (multflag !=null && multflag != '') {
574: url += '&multiple='+multflag;
575: }
1.909 raeburn 576: var title = '$wintitle';
1.91 www 577: var options = 'scrollbars=1,resizable=1,menubar=0';
578: options += ',width=700,height=600';
579: stdeditbrowser = open(url,title,options,'1');
580: stdeditbrowser.focus();
581: }
1.876 raeburn 582: $id_functions
583: ENDSTDBRW
1.905 raeburn 584: if (($sec_element ne '') || ($role_element ne '')) {
585: $output .= &setsec_javascript($sec_element,$formname,$role_element);
1.876 raeburn 586: }
587: $output .= '
588: // ]]>
589: </script>';
590: return $output;
591: }
592:
593: sub javascript_index_functions {
594: return <<"ENDJS";
595:
596: function getFormIdByName(formname) {
597: for (var i=0;i<document.forms.length;i++) {
598: if (document.forms[i].name == formname) {
599: return i;
600: }
601: }
602: return -1;
603: }
604:
605: function getIndexByName(formid,item) {
606: for (var i=0;i<document.forms[formid].elements.length;i++) {
607: if (document.forms[formid].elements[i].name == item) {
608: return i;
609: }
610: }
611: return -1;
612: }
1.468 raeburn 613:
1.876 raeburn 614: function getDomainFromSelectbox(formname,udom) {
615: var userdom;
616: var formid = getFormIdByName(formname);
617: if (formid > -1) {
618: var domid = getIndexByName(formid,udom);
619: if (domid > -1) {
620: if (document.forms[formid].elements[domid].type == 'select-one') {
621: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
622: }
623: if (document.forms[formid].elements[domid].type == 'hidden') {
624: userdom=document.forms[formid].elements[domid].value;
1.468 raeburn 625: }
626: }
627: }
1.876 raeburn 628: return userdom;
629: }
630:
631: ENDJS
1.468 raeburn 632:
1.876 raeburn 633: }
634:
1.1017 ! raeburn 635: sub javascript_array_indexof {
! 636: return <<ENDJS;
! 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.871 raeburn 850: }
1.787 bisitz 851: return '<span class="LC_nobreak">'
852: ."<a href='"
853: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
854: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 855: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 856: ."'>".$linktext.'</a>'
1.787 bisitz 857: .'</span>';
1.74 www 858: }
1.42 matthew 859:
1.653 raeburn 860: sub selectauthor_link {
861: my ($form,$udom)=@_;
862: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
863: &mt('Select Author').'</a>';
864: }
865:
1.876 raeburn 866: sub selectuser_link {
1.881 raeburn 867: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 868: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 869: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 870: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 871: ');">'.$linktext.'</a>';
1.876 raeburn 872: }
873:
1.273 raeburn 874: sub check_uncheck_jscript {
875: my $jscript = <<"ENDSCRT";
876: function checkAll(field) {
877: if (field.length > 0) {
878: for (i = 0; i < field.length; i++) {
879: field[i].checked = true ;
880: }
881: } else {
882: field.checked = true
883: }
884: }
885:
886: function uncheckAll(field) {
887: if (field.length > 0) {
888: for (i = 0; i < field.length; i++) {
889: field[i].checked = false ;
1.543 albertel 890: }
891: } else {
1.273 raeburn 892: field.checked = false ;
893: }
894: }
895: ENDSCRT
896: return $jscript;
897: }
898:
1.656 www 899: sub select_timezone {
1.659 raeburn 900: my ($name,$selected,$onchange,$includeempty)=@_;
901: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
902: if ($includeempty) {
903: $output .= '<option value=""';
904: if (($selected eq '') || ($selected eq 'local')) {
905: $output .= ' selected="selected" ';
906: }
907: $output .= '> </option>';
908: }
1.657 raeburn 909: my @timezones = DateTime::TimeZone->all_names;
910: foreach my $tzone (@timezones) {
911: $output.= '<option value="'.$tzone.'"';
912: if ($tzone eq $selected) {
913: $output.=' selected="selected"';
914: }
915: $output.=">$tzone</option>\n";
1.656 www 916: }
917: $output.="</select>";
918: return $output;
919: }
1.273 raeburn 920:
1.687 raeburn 921: sub select_datelocale {
922: my ($name,$selected,$onchange,$includeempty)=@_;
923: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
924: if ($includeempty) {
925: $output .= '<option value=""';
926: if ($selected eq '') {
927: $output .= ' selected="selected" ';
928: }
929: $output .= '> </option>';
930: }
931: my (@possibles,%locale_names);
932: my @locales = DateTime::Locale::Catalog::Locales;
933: foreach my $locale (@locales) {
934: if (ref($locale) eq 'HASH') {
935: my $id = $locale->{'id'};
936: if ($id ne '') {
937: my $en_terr = $locale->{'en_territory'};
938: my $native_terr = $locale->{'native_territory'};
1.695 raeburn 939: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 940: if (grep(/^en$/,@languages) || !@languages) {
941: if ($en_terr ne '') {
942: $locale_names{$id} = '('.$en_terr.')';
943: } elsif ($native_terr ne '') {
944: $locale_names{$id} = $native_terr;
945: }
946: } else {
947: if ($native_terr ne '') {
948: $locale_names{$id} = $native_terr.' ';
949: } elsif ($en_terr ne '') {
950: $locale_names{$id} = '('.$en_terr.')';
951: }
952: }
953: push (@possibles,$id);
954: }
955: }
956: }
957: foreach my $item (sort(@possibles)) {
958: $output.= '<option value="'.$item.'"';
959: if ($item eq $selected) {
960: $output.=' selected="selected"';
961: }
962: $output.=">$item";
963: if ($locale_names{$item} ne '') {
964: $output.=" $locale_names{$item}</option>\n";
965: }
966: $output.="</option>\n";
967: }
968: $output.="</select>";
969: return $output;
970: }
971:
1.792 raeburn 972: sub select_language {
973: my ($name,$selected,$includeempty) = @_;
974: my %langchoices;
975: if ($includeempty) {
976: %langchoices = ('' => 'No language preference');
977: }
978: foreach my $id (&languageids()) {
979: my $code = &supportedlanguagecode($id);
980: if ($code) {
981: $langchoices{$code} = &plainlanguagedescription($id);
982: }
983: }
1.970 raeburn 984: return &select_form($selected,$name,\%langchoices);
1.792 raeburn 985: }
986:
1.42 matthew 987: =pod
1.36 matthew 988:
1.648 raeburn 989: =item * &linked_select_forms(...)
1.36 matthew 990:
991: linked_select_forms returns a string containing a <script></script> block
992: and html for two <select> menus. The select menus will be linked in that
993: changing the value of the first menu will result in new values being placed
994: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 995: order unless a defined order is provided.
1.36 matthew 996:
997: linked_select_forms takes the following ordered inputs:
998:
999: =over 4
1000:
1.112 bowersj2 1001: =item * $formname, the name of the <form> tag
1.36 matthew 1002:
1.112 bowersj2 1003: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 1004:
1.112 bowersj2 1005: =item * $firstdefault, the default value for the first menu
1.36 matthew 1006:
1.112 bowersj2 1007: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 1008:
1.112 bowersj2 1009: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 1010:
1.112 bowersj2 1011: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 1012:
1.609 raeburn 1013: =item * $menuorder, the order of values in the first menu
1014:
1.41 ng 1015: =back
1016:
1.36 matthew 1017: Below is an example of such a hash. Only the 'text', 'default', and
1018: 'select2' keys must appear as stated. keys(%menu) are the possible
1019: values for the first select menu. The text that coincides with the
1.41 ng 1020: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 1021: and text for the second menu are given in the hash pointed to by
1022: $menu{$choice1}->{'select2'}.
1023:
1.112 bowersj2 1024: my %menu = ( A1 => { text =>"Choice A1" ,
1025: default => "B3",
1026: select2 => {
1027: B1 => "Choice B1",
1028: B2 => "Choice B2",
1029: B3 => "Choice B3",
1030: B4 => "Choice B4"
1.609 raeburn 1031: },
1032: order => ['B4','B3','B1','B2'],
1.112 bowersj2 1033: },
1034: A2 => { text =>"Choice A2" ,
1035: default => "C2",
1036: select2 => {
1037: C1 => "Choice C1",
1038: C2 => "Choice C2",
1039: C3 => "Choice C3"
1.609 raeburn 1040: },
1041: order => ['C2','C1','C3'],
1.112 bowersj2 1042: },
1043: A3 => { text =>"Choice A3" ,
1044: default => "D6",
1045: select2 => {
1046: D1 => "Choice D1",
1047: D2 => "Choice D2",
1048: D3 => "Choice D3",
1049: D4 => "Choice D4",
1050: D5 => "Choice D5",
1051: D6 => "Choice D6",
1052: D7 => "Choice D7"
1.609 raeburn 1053: },
1054: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 1055: }
1056: );
1.36 matthew 1057:
1058: =cut
1059:
1060: sub linked_select_forms {
1061: my ($formname,
1062: $middletext,
1063: $firstdefault,
1064: $firstselectname,
1065: $secondselectname,
1.609 raeburn 1066: $hashref,
1067: $menuorder,
1.36 matthew 1068: ) = @_;
1069: my $second = "document.$formname.$secondselectname";
1070: my $first = "document.$formname.$firstselectname";
1071: # output the javascript to do the changing
1072: my $result = '';
1.776 bisitz 1073: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 1074: $result.="// <![CDATA[\n";
1.36 matthew 1075: $result.="var select2data = new Object();\n";
1076: $" = '","';
1077: my $debug = '';
1078: foreach my $s1 (sort(keys(%$hashref))) {
1079: $result.="select2data.d_$s1 = new Object();\n";
1080: $result.="select2data.d_$s1.def = new String('".
1081: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 1082: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 1083: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1084: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1085: @s2values = @{$hashref->{$s1}->{'order'}};
1086: }
1.36 matthew 1087: $result.="\"@s2values\");\n";
1088: $result.="select2data.d_$s1.texts = new Array(";
1089: my @s2texts;
1090: foreach my $value (@s2values) {
1091: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
1092: }
1093: $result.="\"@s2texts\");\n";
1094: }
1095: $"=' ';
1096: $result.= <<"END";
1097:
1098: function select1_changed() {
1099: // Determine new choice
1100: var newvalue = "d_" + $first.value;
1101: // update select2
1102: var values = select2data[newvalue].values;
1103: var texts = select2data[newvalue].texts;
1104: var select2def = select2data[newvalue].def;
1105: var i;
1106: // out with the old
1107: for (i = 0; i < $second.options.length; i++) {
1108: $second.options[i] = null;
1109: }
1110: // in with the nuclear
1111: for (i=0;i<values.length; i++) {
1112: $second.options[i] = new Option(values[i]);
1.143 matthew 1113: $second.options[i].value = values[i];
1.36 matthew 1114: $second.options[i].text = texts[i];
1115: if (values[i] == select2def) {
1116: $second.options[i].selected = true;
1117: }
1118: }
1119: }
1.824 bisitz 1120: // ]]>
1.36 matthew 1121: </script>
1122: END
1123: # output the initial values for the selection lists
1124: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609 raeburn 1125: my @order = sort(keys(%{$hashref}));
1126: if (ref($menuorder) eq 'ARRAY') {
1127: @order = @{$menuorder};
1128: }
1129: foreach my $value (@order) {
1.36 matthew 1130: $result.=" <option value=\"$value\" ";
1.253 albertel 1131: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1132: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1133: }
1134: $result .= "</select>\n";
1135: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1136: $result .= $middletext;
1137: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
1138: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1139:
1140: my @secondorder = sort(keys(%select2));
1141: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1142: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1143: }
1144: foreach my $value (@secondorder) {
1.36 matthew 1145: $result.=" <option value=\"$value\" ";
1.253 albertel 1146: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1147: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1148: }
1149: $result .= "</select>\n";
1150: # return $debug;
1151: return $result;
1152: } # end of sub linked_select_forms {
1153:
1.45 matthew 1154: =pod
1.44 bowersj2 1155:
1.973 raeburn 1156: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid)
1.44 bowersj2 1157:
1.112 bowersj2 1158: Returns a string corresponding to an HTML link to the given help
1159: $topic, where $topic corresponds to the name of a .tex file in
1160: /home/httpd/html/adm/help/tex, with underscores replaced by
1161: spaces.
1162:
1163: $text will optionally be linked to the same topic, allowing you to
1164: link text in addition to the graphic. If you do not want to link
1165: text, but wish to specify one of the later parameters, pass an
1166: empty string.
1167:
1168: $stayOnPage is a value that will be interpreted as a boolean. If true,
1169: the link will not open a new window. If false, the link will open
1170: a new window using Javascript. (Default is false.)
1171:
1172: $width and $height are optional numerical parameters that will
1173: override the width and height of the popped up window, which may
1.973 raeburn 1174: be useful for certain help topics with big pictures included.
1175:
1176: $imgid is the id of the img tag used for the help icon. This may be
1177: used in a javascript call to switch the image src. See
1178: lonhtmlcommon::htmlareaselectactive() for an example.
1.44 bowersj2 1179:
1180: =cut
1181:
1182: sub help_open_topic {
1.973 raeburn 1183: my ($topic, $text, $stayOnPage, $width, $height, $imgid) = @_;
1.48 bowersj2 1184: $text = "" if (not defined $text);
1.44 bowersj2 1185: $stayOnPage = 0 if (not defined $stayOnPage);
1186: $width = 350 if (not defined $width);
1187: $height = 400 if (not defined $height);
1188: my $filename = $topic;
1189: $filename =~ s/ /_/g;
1190:
1.48 bowersj2 1191: my $template = "";
1192: my $link;
1.572 banghart 1193:
1.159 www 1194: $topic=~s/\W/\_/g;
1.44 bowersj2 1195:
1.572 banghart 1196: if (!$stayOnPage) {
1.72 bowersj2 1197: $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 1198: } else {
1.48 bowersj2 1199: $link = "/adm/help/${filename}.hlp";
1200: }
1201:
1202: # Add the text
1.755 neumanie 1203: if ($text ne "") {
1.763 bisitz 1204: $template.='<span class="LC_help_open_topic">'
1205: .'<a target="_top" href="'.$link.'">'
1206: .$text.'</a>';
1.48 bowersj2 1207: }
1208:
1.763 bisitz 1209: # (Always) Add the graphic
1.179 matthew 1210: my $title = &mt('Online Help');
1.667 raeburn 1211: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973 raeburn 1212: if ($imgid ne '') {
1213: $imgid = ' id="'.$imgid.'"';
1214: }
1.763 bisitz 1215: $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
1216: .'<img src="'.$helpicon.'" border="0"'
1217: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973 raeburn 1218: .' title="'.$title.'" style="vertical-align:middle;"'.$imgid
1.763 bisitz 1219: .' /></a>';
1220: if ($text ne "") {
1221: $template.='</span>';
1222: }
1.44 bowersj2 1223: return $template;
1224:
1.106 bowersj2 1225: }
1226:
1227: # This is a quicky function for Latex cheatsheet editing, since it
1228: # appears in at least four places
1229: sub helpLatexCheatsheet {
1.732 raeburn 1230: my ($topic,$text,$not_author) = @_;
1231: my $out;
1.106 bowersj2 1232: my $addOther = '';
1.732 raeburn 1233: if ($topic) {
1.763 bisitz 1234: $addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
1235: undef, undef, 600).
1236: '</span> ';
1237: }
1238: $out = '<span>' # Start cheatsheet
1239: .$addOther
1240: .'<span>'
1241: .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
1242: undef,undef,600)
1243: .'</span> <span>'
1244: .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
1245: undef,undef,600)
1246: .'</span>';
1.732 raeburn 1247: unless ($not_author) {
1.763 bisitz 1248: $out .= ' <span>'
1249: .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
1250: undef,undef,600)
1251: .'</span>';
1.732 raeburn 1252: }
1.763 bisitz 1253: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1254: return $out;
1.172 www 1255: }
1256:
1.430 albertel 1257: sub general_help {
1258: my $helptopic='Student_Intro';
1259: if ($env{'request.role'}=~/^(ca|au)/) {
1260: $helptopic='Authoring_Intro';
1.907 raeburn 1261: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1262: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1263: } elsif ($env{'request.role'}=~/^dc/) {
1264: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1265: }
1266: return $helptopic;
1267: }
1268:
1269: sub update_help_link {
1270: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1271: my $origurl = $ENV{'REQUEST_URI'};
1272: $origurl=~s|^/~|/priv/|;
1273: my $timestamp = time;
1274: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1275: $$datum = &escape($$datum);
1276: }
1277:
1278: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1279: my $output .= <<"ENDOUTPUT";
1280: <script type="text/javascript">
1.824 bisitz 1281: // <![CDATA[
1.430 albertel 1282: banner_link = '$banner_link';
1.824 bisitz 1283: // ]]>
1.430 albertel 1284: </script>
1285: ENDOUTPUT
1286: return $output;
1287: }
1288:
1289: # now just updates the help link and generates a blue icon
1.193 raeburn 1290: sub help_open_menu {
1.430 albertel 1291: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1292: = @_;
1.949 droeschl 1293: $stayOnPage = 1;
1.430 albertel 1294: my $output;
1295: if ($component_help) {
1296: if (!$text) {
1297: $output=&help_open_topic($component_help,undef,$stayOnPage,
1298: $width,$height);
1299: } else {
1300: my $help_text;
1301: $help_text=&unescape($topic);
1302: $output='<table><tr><td>'.
1303: &help_open_topic($component_help,$help_text,$stayOnPage,
1304: $width,$height).'</td></tr></table>';
1305: }
1306: }
1307: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1308: return $output.$banner_link;
1309: }
1310:
1311: sub top_nav_help {
1312: my ($text) = @_;
1.436 albertel 1313: $text = &mt($text);
1.949 droeschl 1314: my $stay_on_page = 1;
1315:
1.572 banghart 1316: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1317: : "javascript:helpMenu('open')";
1.572 banghart 1318: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1319:
1.201 raeburn 1320: my $title = &mt('Get help');
1.436 albertel 1321:
1322: return <<"END";
1323: $banner_link
1324: <a href="$link" title="$title">$text</a>
1325: END
1326: }
1327:
1328: sub help_menu_js {
1329: my ($text) = @_;
1.949 droeschl 1330: my $stayOnPage = 1;
1.436 albertel 1331: my $width = 620;
1332: my $height = 600;
1.430 albertel 1333: my $helptopic=&general_help();
1334: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1335: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1336: my $start_page =
1337: &Apache::loncommon::start_page('Help Menu', undef,
1338: {'frameset' => 1,
1339: 'js_ready' => 1,
1340: 'add_entries' => {
1341: 'border' => '0',
1.579 raeburn 1342: 'rows' => "110,*",},});
1.331 albertel 1343: my $end_page =
1344: &Apache::loncommon::end_page({'frameset' => 1,
1345: 'js_ready' => 1,});
1346:
1.436 albertel 1347: my $template .= <<"ENDTEMPLATE";
1348: <script type="text/javascript">
1.877 bisitz 1349: // <![CDATA[
1.253 albertel 1350: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1351: var banner_link = '';
1.243 raeburn 1352: function helpMenu(target) {
1353: var caller = this;
1354: if (target == 'open') {
1355: var newWindow = null;
1356: try {
1.262 albertel 1357: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1358: }
1359: catch(error) {
1360: writeHelp(caller);
1361: return;
1362: }
1363: if (newWindow) {
1364: caller = newWindow;
1365: }
1.193 raeburn 1366: }
1.243 raeburn 1367: writeHelp(caller);
1368: return;
1369: }
1370: function writeHelp(caller) {
1.430 albertel 1371: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243 raeburn 1372: caller.document.close()
1373: caller.focus()
1.193 raeburn 1374: }
1.877 bisitz 1375: // END LON-CAPA Internal -->
1.253 albertel 1376: // ]]>
1.436 albertel 1377: </script>
1.193 raeburn 1378: ENDTEMPLATE
1379: return $template;
1380: }
1381:
1.172 www 1382: sub help_open_bug {
1383: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1384: unless ($env{'user.adv'}) { return ''; }
1.172 www 1385: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1386: $text = "" if (not defined $text);
1387: $stayOnPage=1;
1.184 albertel 1388: $width = 600 if (not defined $width);
1389: $height = 600 if (not defined $height);
1.172 www 1390:
1391: $topic=~s/\W+/\+/g;
1392: my $link='';
1393: my $template='';
1.379 albertel 1394: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1395: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1396: if (!$stayOnPage)
1397: {
1398: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1399: }
1400: else
1401: {
1402: $link = $url;
1403: }
1404: # Add the text
1405: if ($text ne "")
1406: {
1407: $template .=
1408: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1409: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1410: }
1411:
1412: # Add the graphic
1.179 matthew 1413: my $title = &mt('Report a Bug');
1.215 albertel 1414: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1415: $template .= <<"ENDTEMPLATE";
1.436 albertel 1416: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1417: ENDTEMPLATE
1418: if ($text ne '') { $template.='</td></tr></table>' };
1419: return $template;
1420:
1421: }
1422:
1423: sub help_open_faq {
1424: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1425: unless ($env{'user.adv'}) { return ''; }
1.172 www 1426: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1427: $text = "" if (not defined $text);
1428: $stayOnPage=1;
1429: $width = 350 if (not defined $width);
1430: $height = 400 if (not defined $height);
1431:
1432: $topic=~s/\W+/\+/g;
1433: my $link='';
1434: my $template='';
1435: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1436: if (!$stayOnPage)
1437: {
1438: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1439: }
1440: else
1441: {
1442: $link = $url;
1443: }
1444:
1445: # Add the text
1446: if ($text ne "")
1447: {
1448: $template .=
1.173 www 1449: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1450: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1451: }
1452:
1453: # Add the graphic
1.179 matthew 1454: my $title = &mt('View the FAQ');
1.215 albertel 1455: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1456: $template .= <<"ENDTEMPLATE";
1.436 albertel 1457: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1458: ENDTEMPLATE
1459: if ($text ne '') { $template.='</td></tr></table>' };
1460: return $template;
1461:
1.44 bowersj2 1462: }
1.37 matthew 1463:
1.180 matthew 1464: ###############################################################
1465: ###############################################################
1466:
1.45 matthew 1467: =pod
1468:
1.648 raeburn 1469: =item * &change_content_javascript():
1.256 matthew 1470:
1471: This and the next function allow you to create small sections of an
1472: otherwise static HTML page that you can update on the fly with
1473: Javascript, even in Netscape 4.
1474:
1475: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1476: must be written to the HTML page once. It will prove the Javascript
1477: function "change(name, content)". Calling the change function with the
1478: name of the section
1479: you want to update, matching the name passed to C<changable_area>, and
1480: the new content you want to put in there, will put the content into
1481: that area.
1482:
1483: B<Note>: Netscape 4 only reserves enough space for the changable area
1484: to contain room for the original contents. You need to "make space"
1485: for whatever changes you wish to make, and be B<sure> to check your
1486: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1487: it's adequate for updating a one-line status display, but little more.
1488: This script will set the space to 100% width, so you only need to
1489: worry about height in Netscape 4.
1490:
1491: Modern browsers are much less limiting, and if you can commit to the
1492: user not using Netscape 4, this feature may be used freely with
1493: pretty much any HTML.
1494:
1495: =cut
1496:
1497: sub change_content_javascript {
1498: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1499: if ($env{'browser.type'} eq 'netscape' &&
1500: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1501: return (<<NETSCAPE4);
1502: function change(name, content) {
1503: doc = document.layers[name+"___escape"].layers[0].document;
1504: doc.open();
1505: doc.write(content);
1506: doc.close();
1507: }
1508: NETSCAPE4
1509: } else {
1510: # Otherwise, we need to use semi-standards-compliant code
1511: # (technically, "innerHTML" isn't standard but the equivalent
1512: # is really scary, and every useful browser supports it
1513: return (<<DOMBASED);
1514: function change(name, content) {
1515: element = document.getElementById(name);
1516: element.innerHTML = content;
1517: }
1518: DOMBASED
1519: }
1520: }
1521:
1522: =pod
1523:
1.648 raeburn 1524: =item * &changable_area($name,$origContent):
1.256 matthew 1525:
1526: This provides a "changable area" that can be modified on the fly via
1527: the Javascript code provided in C<change_content_javascript>. $name is
1528: the name you will use to reference the area later; do not repeat the
1529: same name on a given HTML page more then once. $origContent is what
1530: the area will originally contain, which can be left blank.
1531:
1532: =cut
1533:
1534: sub changable_area {
1535: my ($name, $origContent) = @_;
1536:
1.258 albertel 1537: if ($env{'browser.type'} eq 'netscape' &&
1538: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1539: # If this is netscape 4, we need to use the Layer tag
1540: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1541: } else {
1542: return "<span id='$name'>$origContent</span>";
1543: }
1544: }
1545:
1546: =pod
1547:
1.648 raeburn 1548: =item * &viewport_geometry_js
1.590 raeburn 1549:
1550: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1551:
1552: =cut
1553:
1554:
1555: sub viewport_geometry_js {
1556: return <<"GEOMETRY";
1557: var Geometry = {};
1558: function init_geometry() {
1559: if (Geometry.init) { return };
1560: Geometry.init=1;
1561: if (window.innerHeight) {
1562: Geometry.getViewportHeight = function() { return window.innerHeight; };
1563: Geometry.getViewportWidth = function() { return window.innerWidth; };
1564: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1565: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1566: }
1567: else if (document.documentElement && document.documentElement.clientHeight) {
1568: Geometry.getViewportHeight =
1569: function() { return document.documentElement.clientHeight; };
1570: Geometry.getViewportWidth =
1571: function() { return document.documentElement.clientWidth; };
1572:
1573: Geometry.getHorizontalScroll =
1574: function() { return document.documentElement.scrollLeft; };
1575: Geometry.getVerticalScroll =
1576: function() { return document.documentElement.scrollTop; };
1577: }
1578: else if (document.body.clientHeight) {
1579: Geometry.getViewportHeight =
1580: function() { return document.body.clientHeight; };
1581: Geometry.getViewportWidth =
1582: function() { return document.body.clientWidth; };
1583: Geometry.getHorizontalScroll =
1584: function() { return document.body.scrollLeft; };
1585: Geometry.getVerticalScroll =
1586: function() { return document.body.scrollTop; };
1587: }
1588: }
1589:
1590: GEOMETRY
1591: }
1592:
1593: =pod
1594:
1.648 raeburn 1595: =item * &viewport_size_js()
1.590 raeburn 1596:
1597: 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.
1598:
1599: =cut
1600:
1601: sub viewport_size_js {
1602: my $geometry = &viewport_geometry_js();
1603: return <<"DIMS";
1604:
1605: $geometry
1606:
1607: function getViewportDims(width,height) {
1608: init_geometry();
1609: width.value = Geometry.getViewportWidth();
1610: height.value = Geometry.getViewportHeight();
1611: return;
1612: }
1613:
1614: DIMS
1615: }
1616:
1617: =pod
1618:
1.648 raeburn 1619: =item * &resize_textarea_js()
1.565 albertel 1620:
1621: emits the needed javascript to resize a textarea to be as big as possible
1622:
1623: creates a function resize_textrea that takes two IDs first should be
1624: the id of the element to resize, second should be the id of a div that
1625: surrounds everything that comes after the textarea, this routine needs
1626: to be attached to the <body> for the onload and onresize events.
1627:
1.648 raeburn 1628: =back
1.565 albertel 1629:
1630: =cut
1631:
1632: sub resize_textarea_js {
1.590 raeburn 1633: my $geometry = &viewport_geometry_js();
1.565 albertel 1634: return <<"RESIZE";
1635: <script type="text/javascript">
1.824 bisitz 1636: // <![CDATA[
1.590 raeburn 1637: $geometry
1.565 albertel 1638:
1.588 albertel 1639: function getX(element) {
1640: var x = 0;
1641: while (element) {
1642: x += element.offsetLeft;
1643: element = element.offsetParent;
1644: }
1645: return x;
1646: }
1647: function getY(element) {
1648: var y = 0;
1649: while (element) {
1650: y += element.offsetTop;
1651: element = element.offsetParent;
1652: }
1653: return y;
1654: }
1655:
1656:
1.565 albertel 1657: function resize_textarea(textarea_id,bottom_id) {
1658: init_geometry();
1659: var textarea = document.getElementById(textarea_id);
1660: //alert(textarea);
1661:
1.588 albertel 1662: var textarea_top = getY(textarea);
1.565 albertel 1663: var textarea_height = textarea.offsetHeight;
1664: var bottom = document.getElementById(bottom_id);
1.588 albertel 1665: var bottom_top = getY(bottom);
1.565 albertel 1666: var bottom_height = bottom.offsetHeight;
1667: var window_height = Geometry.getViewportHeight();
1.588 albertel 1668: var fudge = 23;
1.565 albertel 1669: var new_height = window_height-fudge-textarea_top-bottom_height;
1670: if (new_height < 300) {
1671: new_height = 300;
1672: }
1673: textarea.style.height=new_height+'px';
1674: }
1.824 bisitz 1675: // ]]>
1.565 albertel 1676: </script>
1677: RESIZE
1678:
1679: }
1680:
1681: =pod
1682:
1.256 matthew 1683: =head1 Excel and CSV file utility routines
1684:
1685: =over 4
1686:
1687: =cut
1688:
1689: ###############################################################
1690: ###############################################################
1691:
1692: =pod
1693:
1.648 raeburn 1694: =item * &csv_translate($text)
1.37 matthew 1695:
1.185 www 1696: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1697: format.
1698:
1699: =cut
1700:
1.180 matthew 1701: ###############################################################
1702: ###############################################################
1.37 matthew 1703: sub csv_translate {
1704: my $text = shift;
1705: $text =~ s/\"/\"\"/g;
1.209 albertel 1706: $text =~ s/\n/ /g;
1.37 matthew 1707: return $text;
1708: }
1.180 matthew 1709:
1710: ###############################################################
1711: ###############################################################
1712:
1713: =pod
1714:
1.648 raeburn 1715: =item * &define_excel_formats()
1.180 matthew 1716:
1717: Define some commonly used Excel cell formats.
1718:
1719: Currently supported formats:
1720:
1721: =over 4
1722:
1723: =item header
1724:
1725: =item bold
1726:
1727: =item h1
1728:
1729: =item h2
1730:
1731: =item h3
1732:
1.256 matthew 1733: =item h4
1734:
1735: =item i
1736:
1.180 matthew 1737: =item date
1738:
1739: =back
1740:
1741: Inputs: $workbook
1742:
1743: Returns: $format, a hash reference.
1744:
1745: =cut
1746:
1747: ###############################################################
1748: ###############################################################
1749: sub define_excel_formats {
1750: my ($workbook) = @_;
1751: my $format;
1752: $format->{'header'} = $workbook->add_format(bold => 1,
1753: bottom => 1,
1754: align => 'center');
1755: $format->{'bold'} = $workbook->add_format(bold=>1);
1756: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1757: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1758: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1759: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1760: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1761: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1762: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1763: return $format;
1764: }
1765:
1766: ###############################################################
1767: ###############################################################
1.113 bowersj2 1768:
1769: =pod
1770:
1.648 raeburn 1771: =item * &create_workbook()
1.255 matthew 1772:
1773: Create an Excel worksheet. If it fails, output message on the
1774: request object and return undefs.
1775:
1776: Inputs: Apache request object
1777:
1778: Returns (undef) on failure,
1779: Excel worksheet object, scalar with filename, and formats
1780: from &Apache::loncommon::define_excel_formats on success
1781:
1782: =cut
1783:
1784: ###############################################################
1785: ###############################################################
1786: sub create_workbook {
1787: my ($r) = @_;
1788: #
1789: # Create the excel spreadsheet
1790: my $filename = '/prtspool/'.
1.258 albertel 1791: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1792: time.'_'.rand(1000000000).'.xls';
1793: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1794: if (! defined($workbook)) {
1795: $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928 bisitz 1796: $r->print(
1797: '<p class="LC_error">'
1798: .&mt('Problems occurred in creating the new Excel file.')
1799: .' '.&mt('This error has been logged.')
1800: .' '.&mt('Please alert your LON-CAPA administrator.')
1801: .'</p>'
1802: );
1.255 matthew 1803: return (undef);
1804: }
1805: #
1.1014 foxr 1806: $workbook->set_tempdir(LONCAPA::tempdir());
1.255 matthew 1807: #
1808: my $format = &Apache::loncommon::define_excel_formats($workbook);
1809: return ($workbook,$filename,$format);
1810: }
1811:
1812: ###############################################################
1813: ###############################################################
1814:
1815: =pod
1816:
1.648 raeburn 1817: =item * &create_text_file()
1.113 bowersj2 1818:
1.542 raeburn 1819: Create a file to write to and eventually make available to the user.
1.256 matthew 1820: If file creation fails, outputs an error message on the request object and
1821: return undefs.
1.113 bowersj2 1822:
1.256 matthew 1823: Inputs: Apache request object, and file suffix
1.113 bowersj2 1824:
1.256 matthew 1825: Returns (undef) on failure,
1826: Filehandle and filename on success.
1.113 bowersj2 1827:
1828: =cut
1829:
1.256 matthew 1830: ###############################################################
1831: ###############################################################
1832: sub create_text_file {
1833: my ($r,$suffix) = @_;
1834: if (! defined($suffix)) { $suffix = 'txt'; };
1835: my $fh;
1836: my $filename = '/prtspool/'.
1.258 albertel 1837: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1838: time.'_'.rand(1000000000).'.'.$suffix;
1839: $fh = Apache::File->new('>/home/httpd'.$filename);
1840: if (! defined($fh)) {
1841: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 1842: $r->print(
1843: '<p class="LC_error">'
1844: .&mt('Problems occurred in creating the output file.')
1845: .' '.&mt('This error has been logged.')
1846: .' '.&mt('Please alert your LON-CAPA administrator.')
1847: .'</p>'
1848: );
1.113 bowersj2 1849: }
1.256 matthew 1850: return ($fh,$filename)
1.113 bowersj2 1851: }
1852:
1853:
1.256 matthew 1854: =pod
1.113 bowersj2 1855:
1856: =back
1857:
1858: =cut
1.37 matthew 1859:
1860: ###############################################################
1.33 matthew 1861: ## Home server <option> list generating code ##
1862: ###############################################################
1.35 matthew 1863:
1.169 www 1864: # ------------------------------------------
1865:
1866: sub domain_select {
1867: my ($name,$value,$multiple)=@_;
1868: my %domains=map {
1.514 albertel 1869: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1870: } &Apache::lonnet::all_domains();
1.169 www 1871: if ($multiple) {
1872: $domains{''}=&mt('Any domain');
1.550 albertel 1873: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1874: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1875: } else {
1.550 albertel 1876: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970 raeburn 1877: return &select_form($name,$value,\%domains);
1.169 www 1878: }
1879: }
1880:
1.282 albertel 1881: #-------------------------------------------
1882:
1883: =pod
1884:
1.519 raeburn 1885: =head1 Routines for form select boxes
1886:
1887: =over 4
1888:
1.648 raeburn 1889: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1890:
1891: Returns a string containing a <select> element int multiple mode
1892:
1893:
1894: Args:
1895: $name - name of the <select> element
1.506 raeburn 1896: $value - scalar or array ref of values that should already be selected
1.282 albertel 1897: $size - number of rows long the select element is
1.283 albertel 1898: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1899: (shown text should already have been &mt())
1.506 raeburn 1900: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1901:
1.282 albertel 1902: =cut
1903:
1904: #-------------------------------------------
1.169 www 1905: sub multiple_select_form {
1.284 albertel 1906: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1907: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1908: my $output='';
1.191 matthew 1909: if (! defined($size)) {
1910: $size = 4;
1.283 albertel 1911: if (scalar(keys(%$hash))<4) {
1912: $size = scalar(keys(%$hash));
1.191 matthew 1913: }
1914: }
1.734 bisitz 1915: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1916: my @order;
1.506 raeburn 1917: if (ref($order) eq 'ARRAY') {
1918: @order = @{$order};
1919: } else {
1920: @order = sort(keys(%$hash));
1.501 banghart 1921: }
1922: if (exists($$hash{'select_form_order'})) {
1923: @order = @{$$hash{'select_form_order'}};
1924: }
1925:
1.284 albertel 1926: foreach my $key (@order) {
1.356 albertel 1927: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1928: $output.='selected="selected" ' if ($selected{$key});
1929: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1930: }
1931: $output.="</select>\n";
1932: return $output;
1933: }
1934:
1.88 www 1935: #-------------------------------------------
1936:
1937: =pod
1938:
1.970 raeburn 1939: =item * &select_form($defdom,$name,$hashref,$onchange)
1.88 www 1940:
1941: Returns a string containing a <select name='$name' size='1'> form to
1.970 raeburn 1942: allow a user to select options from a ref to a hash containing:
1943: option_name => displayed text. An optional $onchange can include
1944: a javascript onchange item, e.g., onchange="this.form.submit();"
1945:
1.88 www 1946: See lonrights.pm for an example invocation and use.
1947:
1948: =cut
1949:
1950: #-------------------------------------------
1951: sub select_form {
1.970 raeburn 1952: my ($def,$name,$hashref,$onchange) = @_;
1953: return unless (ref($hashref) eq 'HASH');
1954: if ($onchange) {
1955: $onchange = ' onchange="'.$onchange.'"';
1956: }
1957: my $selectform = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.128 albertel 1958: my @keys;
1.970 raeburn 1959: if (exists($hashref->{'select_form_order'})) {
1960: @keys=@{$hashref->{'select_form_order'}};
1.128 albertel 1961: } else {
1.970 raeburn 1962: @keys=sort(keys(%{$hashref}));
1.128 albertel 1963: }
1.356 albertel 1964: foreach my $key (@keys) {
1965: $selectform.=
1966: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1967: ($key eq $def ? 'selected="selected" ' : '').
1.970 raeburn 1968: ">".$hashref->{$key}."</option>\n";
1.88 www 1969: }
1970: $selectform.="</select>";
1971: return $selectform;
1972: }
1973:
1.475 www 1974: # For display filters
1975:
1976: sub display_filter {
1977: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1978: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714 bisitz 1979: return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475 www 1980: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1981: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 1982: '</label></span> <span class="LC_nobreak">'.
1.475 www 1983: &mt('Filter [_1]',
1.477 www 1984: &select_form($env{'form.displayfilter'},
1985: 'displayfilter',
1.970 raeburn 1986: {'currentfolder' => 'Current folder/page',
1.477 www 1987: 'containing' => 'Containing phrase',
1.970 raeburn 1988: 'none' => 'None'})).
1.714 bisitz 1989: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475 www 1990: }
1991:
1.167 www 1992: sub gradeleveldescription {
1993: my $gradelevel=shift;
1994: my %gradelevels=(0 => 'Not specified',
1995: 1 => 'Grade 1',
1996: 2 => 'Grade 2',
1997: 3 => 'Grade 3',
1998: 4 => 'Grade 4',
1999: 5 => 'Grade 5',
2000: 6 => 'Grade 6',
2001: 7 => 'Grade 7',
2002: 8 => 'Grade 8',
2003: 9 => 'Grade 9',
2004: 10 => 'Grade 10',
2005: 11 => 'Grade 11',
2006: 12 => 'Grade 12',
2007: 13 => 'Grade 13',
2008: 14 => '100 Level',
2009: 15 => '200 Level',
2010: 16 => '300 Level',
2011: 17 => '400 Level',
2012: 18 => 'Graduate Level');
2013: return &mt($gradelevels{$gradelevel});
2014: }
2015:
1.163 www 2016: sub select_level_form {
2017: my ($deflevel,$name)=@_;
2018: unless ($deflevel) { $deflevel=0; }
1.167 www 2019: my $selectform = "<select name=\"$name\" size=\"1\">\n";
2020: for (my $i=0; $i<=18; $i++) {
2021: $selectform.="<option value=\"$i\" ".
1.253 albertel 2022: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 2023: ">".&gradeleveldescription($i)."</option>\n";
2024: }
2025: $selectform.="</select>";
2026: return $selectform;
1.163 www 2027: }
1.167 www 2028:
1.35 matthew 2029: #-------------------------------------------
2030:
1.45 matthew 2031: =pod
2032:
1.910 raeburn 2033: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35 matthew 2034:
2035: Returns a string containing a <select name='$name' size='1'> form to
2036: allow a user to select the domain to preform an operation in.
2037: See loncreateuser.pm for an example invocation and use.
2038:
1.90 www 2039: If the $includeempty flag is set, it also includes an empty choice ("no domain
2040: selected");
2041:
1.743 raeburn 2042: If the $showdomdesc flag is set, the domain name is followed by the domain description.
2043:
1.910 raeburn 2044: 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.
2045:
2046: The optional $incdoms is a reference to an array of domains which will be the only available options.
1.563 raeburn 2047:
1.35 matthew 2048: =cut
2049:
2050: #-------------------------------------------
1.34 matthew 2051: sub select_dom_form {
1.910 raeburn 2052: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.872 raeburn 2053: if ($onchange) {
1.874 raeburn 2054: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 2055: }
1.910 raeburn 2056: my @domains;
2057: if (ref($incdoms) eq 'ARRAY') {
2058: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
2059: } else {
2060: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
2061: }
1.90 www 2062: if ($includeempty) { @domains=('',@domains); }
1.743 raeburn 2063: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 2064: foreach my $dom (@domains) {
2065: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 2066: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
2067: if ($showdomdesc) {
2068: if ($dom ne '') {
2069: my $domdesc = &Apache::lonnet::domain($dom,'description');
2070: if ($domdesc ne '') {
2071: $selectdomain .= ' ('.$domdesc.')';
2072: }
2073: }
2074: }
2075: $selectdomain .= "</option>\n";
1.34 matthew 2076: }
2077: $selectdomain.="</select>";
2078: return $selectdomain;
2079: }
2080:
1.35 matthew 2081: #-------------------------------------------
2082:
1.45 matthew 2083: =pod
2084:
1.648 raeburn 2085: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 2086:
1.586 raeburn 2087: input: 4 arguments (two required, two optional) -
2088: $domain - domain of new user
2089: $name - name of form element
2090: $default - Value of 'default' causes a default item to be first
2091: option, and selected by default.
2092: $hide - Value of 'hide' causes hiding of the name of the server,
2093: if 1 server found, or default, if 0 found.
1.594 raeburn 2094: output: returns 2 items:
1.586 raeburn 2095: (a) form element which contains either:
2096: (i) <select name="$name">
2097: <option value="$hostid1">$hostid $servers{$hostid}</option>
2098: <option value="$hostid2">$hostid $servers{$hostid}</option>
2099: </select>
2100: form item if there are multiple library servers in $domain, or
2101: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2102: if there is only one library server in $domain.
2103:
2104: (b) number of library servers found.
2105:
2106: See loncreateuser.pm for example of use.
1.35 matthew 2107:
2108: =cut
2109:
2110: #-------------------------------------------
1.586 raeburn 2111: sub home_server_form_item {
2112: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2113: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2114: my $result;
2115: my $numlib = keys(%servers);
2116: if ($numlib > 1) {
2117: $result .= '<select name="'.$name.'" />'."\n";
2118: if ($default) {
1.804 bisitz 2119: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 2120: '</option>'."\n";
2121: }
2122: foreach my $hostid (sort(keys(%servers))) {
2123: $result.= '<option value="'.$hostid.'">'.
2124: $hostid.' '.$servers{$hostid}."</option>\n";
2125: }
2126: $result .= '</select>'."\n";
2127: } elsif ($numlib == 1) {
2128: my $hostid;
2129: foreach my $item (keys(%servers)) {
2130: $hostid = $item;
2131: }
2132: $result .= '<input type="hidden" name="'.$name.'" value="'.
2133: $hostid.'" />';
2134: if (!$hide) {
2135: $result .= $hostid.' '.$servers{$hostid};
2136: }
2137: $result .= "\n";
2138: } elsif ($default) {
2139: $result .= '<input type="hidden" name="'.$name.
2140: '" value="default" />';
2141: if (!$hide) {
2142: $result .= &mt('default');
2143: }
2144: $result .= "\n";
1.33 matthew 2145: }
1.586 raeburn 2146: return ($result,$numlib);
1.33 matthew 2147: }
1.112 bowersj2 2148:
2149: =pod
2150:
1.534 albertel 2151: =back
2152:
1.112 bowersj2 2153: =cut
1.87 matthew 2154:
2155: ###############################################################
1.112 bowersj2 2156: ## Decoding User Agent ##
1.87 matthew 2157: ###############################################################
2158:
2159: =pod
2160:
1.112 bowersj2 2161: =head1 Decoding the User Agent
2162:
2163: =over 4
2164:
2165: =item * &decode_user_agent()
1.87 matthew 2166:
2167: Inputs: $r
2168:
2169: Outputs:
2170:
2171: =over 4
2172:
1.112 bowersj2 2173: =item * $httpbrowser
1.87 matthew 2174:
1.112 bowersj2 2175: =item * $clientbrowser
1.87 matthew 2176:
1.112 bowersj2 2177: =item * $clientversion
1.87 matthew 2178:
1.112 bowersj2 2179: =item * $clientmathml
1.87 matthew 2180:
1.112 bowersj2 2181: =item * $clientunicode
1.87 matthew 2182:
1.112 bowersj2 2183: =item * $clientos
1.87 matthew 2184:
2185: =back
2186:
1.157 matthew 2187: =back
2188:
1.87 matthew 2189: =cut
2190:
2191: ###############################################################
2192: ###############################################################
2193: sub decode_user_agent {
1.247 albertel 2194: my ($r)=@_;
1.87 matthew 2195: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2196: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2197: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2198: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2199: my $clientbrowser='unknown';
2200: my $clientversion='0';
2201: my $clientmathml='';
2202: my $clientunicode='0';
2203: for (my $i=0;$i<=$#browsertype;$i++) {
2204: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
2205: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2206: $clientbrowser=$bname;
2207: $httpbrowser=~/$vreg/i;
2208: $clientversion=$1;
2209: $clientmathml=($clientversion>=$minv);
2210: $clientunicode=($clientversion>=$univ);
2211: }
2212: }
2213: my $clientos='unknown';
2214: if (($httpbrowser=~/linux/i) ||
2215: ($httpbrowser=~/unix/i) ||
2216: ($httpbrowser=~/ux/i) ||
2217: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2218: if (($httpbrowser=~/vax/i) ||
2219: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2220: if ($httpbrowser=~/next/i) { $clientos='next'; }
2221: if (($httpbrowser=~/mac/i) ||
2222: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
2223: if ($httpbrowser=~/win/i) { $clientos='win'; }
2224: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
2225: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
2226: $clientunicode,$clientos,);
2227: }
2228:
1.32 matthew 2229: ###############################################################
2230: ## Authentication changing form generation subroutines ##
2231: ###############################################################
2232: ##
2233: ## All of the authform_xxxxxxx subroutines take their inputs in a
2234: ## hash, and have reasonable default values.
2235: ##
2236: ## formname = the name given in the <form> tag.
1.35 matthew 2237: #-------------------------------------------
2238:
1.45 matthew 2239: =pod
2240:
1.112 bowersj2 2241: =head1 Authentication Routines
2242:
2243: =over 4
2244:
1.648 raeburn 2245: =item * &authform_xxxxxx()
1.35 matthew 2246:
2247: The authform_xxxxxx subroutines provide javascript and html forms which
2248: handle some of the conveniences required for authentication forms.
2249: This is not an optimal method, but it works.
2250:
2251: =over 4
2252:
1.112 bowersj2 2253: =item * authform_header
1.35 matthew 2254:
1.112 bowersj2 2255: =item * authform_authorwarning
1.35 matthew 2256:
1.112 bowersj2 2257: =item * authform_nochange
1.35 matthew 2258:
1.112 bowersj2 2259: =item * authform_kerberos
1.35 matthew 2260:
1.112 bowersj2 2261: =item * authform_internal
1.35 matthew 2262:
1.112 bowersj2 2263: =item * authform_filesystem
1.35 matthew 2264:
2265: =back
2266:
1.648 raeburn 2267: See loncreateuser.pm for invocation and use examples.
1.157 matthew 2268:
1.35 matthew 2269: =cut
2270:
2271: #-------------------------------------------
1.32 matthew 2272: sub authform_header{
2273: my %in = (
2274: formname => 'cu',
1.80 albertel 2275: kerb_def_dom => '',
1.32 matthew 2276: @_,
2277: );
2278: $in{'formname'} = 'document.' . $in{'formname'};
2279: my $result='';
1.80 albertel 2280:
2281: #---------------------------------------------- Code for upper case translation
2282: my $Javascript_toUpperCase;
2283: unless ($in{kerb_def_dom}) {
2284: $Javascript_toUpperCase =<<"END";
2285: switch (choice) {
2286: case 'krb': currentform.elements[choicearg].value =
2287: currentform.elements[choicearg].value.toUpperCase();
2288: break;
2289: default:
2290: }
2291: END
2292: } else {
2293: $Javascript_toUpperCase = "";
2294: }
2295:
1.165 raeburn 2296: my $radioval = "'nochange'";
1.591 raeburn 2297: if (defined($in{'curr_authtype'})) {
2298: if ($in{'curr_authtype'} ne '') {
2299: $radioval = "'".$in{'curr_authtype'}."arg'";
2300: }
1.174 matthew 2301: }
1.165 raeburn 2302: my $argfield = 'null';
1.591 raeburn 2303: if (defined($in{'mode'})) {
1.165 raeburn 2304: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2305: if (defined($in{'curr_autharg'})) {
2306: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2307: $argfield = "'$in{'curr_autharg'}'";
2308: }
2309: }
2310: }
2311: }
2312:
1.32 matthew 2313: $result.=<<"END";
2314: var current = new Object();
1.165 raeburn 2315: current.radiovalue = $radioval;
2316: current.argfield = $argfield;
1.32 matthew 2317:
2318: function changed_radio(choice,currentform) {
2319: var choicearg = choice + 'arg';
2320: // If a radio button in changed, we need to change the argfield
2321: if (current.radiovalue != choice) {
2322: current.radiovalue = choice;
2323: if (current.argfield != null) {
2324: currentform.elements[current.argfield].value = '';
2325: }
2326: if (choice == 'nochange') {
2327: current.argfield = null;
2328: } else {
2329: current.argfield = choicearg;
2330: switch(choice) {
2331: case 'krb':
2332: currentform.elements[current.argfield].value =
2333: "$in{'kerb_def_dom'}";
2334: break;
2335: default:
2336: break;
2337: }
2338: }
2339: }
2340: return;
2341: }
1.22 www 2342:
1.32 matthew 2343: function changed_text(choice,currentform) {
2344: var choicearg = choice + 'arg';
2345: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2346: $Javascript_toUpperCase
1.32 matthew 2347: // clear old field
2348: if ((current.argfield != choicearg) && (current.argfield != null)) {
2349: currentform.elements[current.argfield].value = '';
2350: }
2351: current.argfield = choicearg;
2352: }
2353: set_auth_radio_buttons(choice,currentform);
2354: return;
1.20 www 2355: }
1.32 matthew 2356:
2357: function set_auth_radio_buttons(newvalue,currentform) {
1.986 raeburn 2358: var numauthchoices = currentform.login.length;
2359: if (typeof numauthchoices == "undefined") {
2360: return;
2361: }
1.32 matthew 2362: var i=0;
1.986 raeburn 2363: while (i < numauthchoices) {
1.32 matthew 2364: if (currentform.login[i].value == newvalue) { break; }
2365: i++;
2366: }
1.986 raeburn 2367: if (i == numauthchoices) {
1.32 matthew 2368: return;
2369: }
2370: current.radiovalue = newvalue;
2371: currentform.login[i].checked = true;
2372: return;
2373: }
2374: END
2375: return $result;
2376: }
2377:
2378: sub authform_authorwarning{
2379: my $result='';
1.144 matthew 2380: $result='<i>'.
2381: &mt('As a general rule, only authors or co-authors should be '.
2382: 'filesystem authenticated '.
2383: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2384: return $result;
2385: }
2386:
2387: sub authform_nochange{
2388: my %in = (
2389: formname => 'document.cu',
2390: kerb_def_dom => 'MSU.EDU',
2391: @_,
2392: );
1.586 raeburn 2393: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2394: my $result;
2395: if (keys(%can_assign) == 0) {
2396: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2397: } else {
2398: $result = '<label>'.&mt('[_1] Do not change login data',
2399: '<input type="radio" name="login" value="nochange" '.
2400: 'checked="checked" onclick="'.
1.281 albertel 2401: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2402: '</label>';
1.586 raeburn 2403: }
1.32 matthew 2404: return $result;
2405: }
2406:
1.591 raeburn 2407: sub authform_kerberos {
1.32 matthew 2408: my %in = (
2409: formname => 'document.cu',
2410: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2411: kerb_def_auth => 'krb4',
1.32 matthew 2412: @_,
2413: );
1.586 raeburn 2414: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2415: $autharg,$jscall);
2416: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2417: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2418: $check5 = ' checked="checked"';
1.80 albertel 2419: } else {
1.772 bisitz 2420: $check4 = ' checked="checked"';
1.80 albertel 2421: }
1.165 raeburn 2422: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2423: if (defined($in{'curr_authtype'})) {
2424: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2425: $krbcheck = ' checked="checked"';
1.623 raeburn 2426: if (defined($in{'mode'})) {
2427: if ($in{'mode'} eq 'modifyuser') {
2428: $krbcheck = '';
2429: }
2430: }
1.591 raeburn 2431: if (defined($in{'curr_kerb_ver'})) {
2432: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2433: $check5 = ' checked="checked"';
1.591 raeburn 2434: $check4 = '';
2435: } else {
1.772 bisitz 2436: $check4 = ' checked="checked"';
1.591 raeburn 2437: $check5 = '';
2438: }
1.586 raeburn 2439: }
1.591 raeburn 2440: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2441: $krbarg = $in{'curr_autharg'};
2442: }
1.586 raeburn 2443: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2444: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2445: $result =
2446: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2447: $in{'curr_autharg'},$krbver);
2448: } else {
2449: $result =
2450: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2451: }
2452: return $result;
2453: }
2454: }
2455: } else {
2456: if ($authnum == 1) {
1.784 bisitz 2457: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2458: }
2459: }
1.586 raeburn 2460: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2461: return;
1.587 raeburn 2462: } elsif ($authtype eq '') {
1.591 raeburn 2463: if (defined($in{'mode'})) {
1.587 raeburn 2464: if ($in{'mode'} eq 'modifycourse') {
2465: if ($authnum == 1) {
1.784 bisitz 2466: $authtype = '<input type="hidden" name="login" value="krb" />';
1.587 raeburn 2467: }
2468: }
2469: }
1.586 raeburn 2470: }
2471: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2472: if ($authtype eq '') {
2473: $authtype = '<input type="radio" name="login" value="krb" '.
2474: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2475: $krbcheck.' />';
2476: }
2477: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2478: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2479: $in{'curr_authtype'} eq 'krb5') ||
2480: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2481: $in{'curr_authtype'} eq 'krb4')) {
2482: $result .= &mt
1.144 matthew 2483: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2484: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2485: '<label>'.$authtype,
1.281 albertel 2486: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2487: 'value="'.$krbarg.'" '.
1.144 matthew 2488: 'onchange="'.$jscall.'" />',
1.281 albertel 2489: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2490: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2491: '</label>');
1.586 raeburn 2492: } elsif ($can_assign{'krb4'}) {
2493: $result .= &mt
2494: ('[_1] Kerberos authenticated with domain [_2] '.
2495: '[_3] Version 4 [_4]',
2496: '<label>'.$authtype,
2497: '</label><input type="text" size="10" name="krbarg" '.
2498: 'value="'.$krbarg.'" '.
2499: 'onchange="'.$jscall.'" />',
2500: '<label><input type="hidden" name="krbver" value="4" />',
2501: '</label>');
2502: } elsif ($can_assign{'krb5'}) {
2503: $result .= &mt
2504: ('[_1] Kerberos authenticated with domain [_2] '.
2505: '[_3] Version 5 [_4]',
2506: '<label>'.$authtype,
2507: '</label><input type="text" size="10" name="krbarg" '.
2508: 'value="'.$krbarg.'" '.
2509: 'onchange="'.$jscall.'" />',
2510: '<label><input type="hidden" name="krbver" value="5" />',
2511: '</label>');
2512: }
1.32 matthew 2513: return $result;
2514: }
2515:
2516: sub authform_internal{
1.586 raeburn 2517: my %in = (
1.32 matthew 2518: formname => 'document.cu',
2519: kerb_def_dom => 'MSU.EDU',
2520: @_,
2521: );
1.586 raeburn 2522: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2523: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2524: if (defined($in{'curr_authtype'})) {
2525: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2526: if ($can_assign{'int'}) {
1.772 bisitz 2527: $intcheck = 'checked="checked" ';
1.623 raeburn 2528: if (defined($in{'mode'})) {
2529: if ($in{'mode'} eq 'modifyuser') {
2530: $intcheck = '';
2531: }
2532: }
1.591 raeburn 2533: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2534: $intarg = $in{'curr_autharg'};
2535: }
2536: } else {
2537: $result = &mt('Currently internally authenticated.');
2538: return $result;
1.165 raeburn 2539: }
2540: }
1.586 raeburn 2541: } else {
2542: if ($authnum == 1) {
1.784 bisitz 2543: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 2544: }
2545: }
2546: if (!$can_assign{'int'}) {
2547: return;
1.587 raeburn 2548: } elsif ($authtype eq '') {
1.591 raeburn 2549: if (defined($in{'mode'})) {
1.587 raeburn 2550: if ($in{'mode'} eq 'modifycourse') {
2551: if ($authnum == 1) {
1.784 bisitz 2552: $authtype = '<input type="hidden" name="login" value="int" />';
1.587 raeburn 2553: }
2554: }
2555: }
1.165 raeburn 2556: }
1.586 raeburn 2557: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2558: if ($authtype eq '') {
2559: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2560: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2561: }
1.605 bisitz 2562: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2563: $intarg.'" onchange="'.$jscall.'" />';
2564: $result = &mt
1.144 matthew 2565: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2566: '<label>'.$authtype,'</label>'.$autharg);
1.824 bisitz 2567: $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 2568: return $result;
2569: }
2570:
2571: sub authform_local{
2572: my %in = (
2573: formname => 'document.cu',
2574: kerb_def_dom => 'MSU.EDU',
2575: @_,
2576: );
1.586 raeburn 2577: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2578: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2579: if (defined($in{'curr_authtype'})) {
2580: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2581: if ($can_assign{'loc'}) {
1.772 bisitz 2582: $loccheck = 'checked="checked" ';
1.623 raeburn 2583: if (defined($in{'mode'})) {
2584: if ($in{'mode'} eq 'modifyuser') {
2585: $loccheck = '';
2586: }
2587: }
1.591 raeburn 2588: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2589: $locarg = $in{'curr_autharg'};
2590: }
2591: } else {
2592: $result = &mt('Currently using local (institutional) authentication.');
2593: return $result;
1.165 raeburn 2594: }
2595: }
1.586 raeburn 2596: } else {
2597: if ($authnum == 1) {
1.784 bisitz 2598: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 2599: }
2600: }
2601: if (!$can_assign{'loc'}) {
2602: return;
1.587 raeburn 2603: } elsif ($authtype eq '') {
1.591 raeburn 2604: if (defined($in{'mode'})) {
1.587 raeburn 2605: if ($in{'mode'} eq 'modifycourse') {
2606: if ($authnum == 1) {
1.784 bisitz 2607: $authtype = '<input type="hidden" name="login" value="loc" />';
1.587 raeburn 2608: }
2609: }
2610: }
1.165 raeburn 2611: }
1.586 raeburn 2612: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2613: if ($authtype eq '') {
2614: $authtype = '<input type="radio" name="login" value="loc" '.
2615: $loccheck.' onchange="'.$jscall.'" onclick="'.
2616: $jscall.'" />';
2617: }
2618: $autharg = '<input type="text" size="10" name="locarg" value="'.
2619: $locarg.'" onchange="'.$jscall.'" />';
2620: $result = &mt('[_1] Local Authentication with argument [_2]',
2621: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2622: return $result;
2623: }
2624:
2625: sub authform_filesystem{
2626: my %in = (
2627: formname => 'document.cu',
2628: kerb_def_dom => 'MSU.EDU',
2629: @_,
2630: );
1.586 raeburn 2631: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2632: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2633: if (defined($in{'curr_authtype'})) {
2634: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2635: if ($can_assign{'fsys'}) {
1.772 bisitz 2636: $fsyscheck = 'checked="checked" ';
1.623 raeburn 2637: if (defined($in{'mode'})) {
2638: if ($in{'mode'} eq 'modifyuser') {
2639: $fsyscheck = '';
2640: }
2641: }
1.586 raeburn 2642: } else {
2643: $result = &mt('Currently Filesystem Authenticated.');
2644: return $result;
2645: }
2646: }
2647: } else {
2648: if ($authnum == 1) {
1.784 bisitz 2649: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 2650: }
2651: }
2652: if (!$can_assign{'fsys'}) {
2653: return;
1.587 raeburn 2654: } elsif ($authtype eq '') {
1.591 raeburn 2655: if (defined($in{'mode'})) {
1.587 raeburn 2656: if ($in{'mode'} eq 'modifycourse') {
2657: if ($authnum == 1) {
1.784 bisitz 2658: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587 raeburn 2659: }
2660: }
2661: }
1.586 raeburn 2662: }
2663: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2664: if ($authtype eq '') {
2665: $authtype = '<input type="radio" name="login" value="fsys" '.
2666: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2667: $jscall.'" />';
2668: }
2669: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2670: ' onchange="'.$jscall.'" />';
2671: $result = &mt
1.144 matthew 2672: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2673: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2674: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2675: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2676: 'onchange="'.$jscall.'" />');
1.32 matthew 2677: return $result;
2678: }
2679:
1.586 raeburn 2680: sub get_assignable_auth {
2681: my ($dom) = @_;
2682: if ($dom eq '') {
2683: $dom = $env{'request.role.domain'};
2684: }
2685: my %can_assign = (
2686: krb4 => 1,
2687: krb5 => 1,
2688: int => 1,
2689: loc => 1,
2690: );
2691: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2692: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2693: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2694: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2695: my $context;
2696: if ($env{'request.role'} =~ /^au/) {
2697: $context = 'author';
2698: } elsif ($env{'request.role'} =~ /^dc/) {
2699: $context = 'domain';
2700: } elsif ($env{'request.course.id'}) {
2701: $context = 'course';
2702: }
2703: if ($context) {
2704: if (ref($authhash->{$context}) eq 'HASH') {
2705: %can_assign = %{$authhash->{$context}};
2706: }
2707: }
2708: }
2709: }
2710: my $authnum = 0;
2711: foreach my $key (keys(%can_assign)) {
2712: if ($can_assign{$key}) {
2713: $authnum ++;
2714: }
2715: }
2716: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2717: $authnum --;
2718: }
2719: return ($authnum,%can_assign);
2720: }
2721:
1.80 albertel 2722: ###############################################################
2723: ## Get Kerberos Defaults for Domain ##
2724: ###############################################################
2725: ##
2726: ## Returns default kerberos version and an associated argument
2727: ## as listed in file domain.tab. If not listed, provides
2728: ## appropriate default domain and kerberos version.
2729: ##
2730: #-------------------------------------------
2731:
2732: =pod
2733:
1.648 raeburn 2734: =item * &get_kerberos_defaults()
1.80 albertel 2735:
2736: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2737: version and domain. If not found, it defaults to version 4 and the
2738: domain of the server.
1.80 albertel 2739:
1.648 raeburn 2740: =over 4
2741:
1.80 albertel 2742: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2743:
1.648 raeburn 2744: =back
2745:
2746: =back
2747:
1.80 albertel 2748: =cut
2749:
2750: #-------------------------------------------
2751: sub get_kerberos_defaults {
2752: my $domain=shift;
1.641 raeburn 2753: my ($krbdef,$krbdefdom);
2754: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2755: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2756: $krbdef = $domdefaults{'auth_def'};
2757: $krbdefdom = $domdefaults{'auth_arg_def'};
2758: } else {
1.80 albertel 2759: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2760: my $krbdefdom=$1;
2761: $krbdefdom=~tr/a-z/A-Z/;
2762: $krbdef = "krb4";
2763: }
2764: return ($krbdef,$krbdefdom);
2765: }
1.112 bowersj2 2766:
1.32 matthew 2767:
1.46 matthew 2768: ###############################################################
2769: ## Thesaurus Functions ##
2770: ###############################################################
1.20 www 2771:
1.46 matthew 2772: =pod
1.20 www 2773:
1.112 bowersj2 2774: =head1 Thesaurus Functions
2775:
2776: =over 4
2777:
1.648 raeburn 2778: =item * &initialize_keywords()
1.46 matthew 2779:
2780: Initializes the package variable %Keywords if it is empty. Uses the
2781: package variable $thesaurus_db_file.
2782:
2783: =cut
2784:
2785: ###################################################
2786:
2787: sub initialize_keywords {
2788: return 1 if (scalar keys(%Keywords));
2789: # If we are here, %Keywords is empty, so fill it up
2790: # Make sure the file we need exists...
2791: if (! -e $thesaurus_db_file) {
2792: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2793: " failed because it does not exist");
2794: return 0;
2795: }
2796: # Set up the hash as a database
2797: my %thesaurus_db;
2798: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2799: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2800: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2801: $thesaurus_db_file);
2802: return 0;
2803: }
2804: # Get the average number of appearances of a word.
2805: my $avecount = $thesaurus_db{'average.count'};
2806: # Put keywords (those that appear > average) into %Keywords
2807: while (my ($word,$data)=each (%thesaurus_db)) {
2808: my ($count,undef) = split /:/,$data;
2809: $Keywords{$word}++ if ($count > $avecount);
2810: }
2811: untie %thesaurus_db;
2812: # Remove special values from %Keywords.
1.356 albertel 2813: foreach my $value ('total.count','average.count') {
2814: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2815: }
1.46 matthew 2816: return 1;
2817: }
2818:
2819: ###################################################
2820:
2821: =pod
2822:
1.648 raeburn 2823: =item * &keyword($word)
1.46 matthew 2824:
2825: Returns true if $word is a keyword. A keyword is a word that appears more
2826: than the average number of times in the thesaurus database. Calls
2827: &initialize_keywords
2828:
2829: =cut
2830:
2831: ###################################################
1.20 www 2832:
2833: sub keyword {
1.46 matthew 2834: return if (!&initialize_keywords());
2835: my $word=lc(shift());
2836: $word=~s/\W//g;
2837: return exists($Keywords{$word});
1.20 www 2838: }
1.46 matthew 2839:
2840: ###############################################################
2841:
2842: =pod
1.20 www 2843:
1.648 raeburn 2844: =item * &get_related_words()
1.46 matthew 2845:
1.160 matthew 2846: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2847: an array of words. If the keyword is not in the thesaurus, an empty array
2848: will be returned. The order of the words returned is determined by the
2849: database which holds them.
2850:
2851: Uses global $thesaurus_db_file.
2852:
2853: =cut
2854:
2855: ###############################################################
2856: sub get_related_words {
2857: my $keyword = shift;
2858: my %thesaurus_db;
2859: if (! -e $thesaurus_db_file) {
2860: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2861: "failed because the file does not exist");
2862: return ();
2863: }
2864: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2865: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2866: return ();
2867: }
2868: my @Words=();
1.429 www 2869: my $count=0;
1.46 matthew 2870: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2871: # The first element is the number of times
2872: # the word appears. We do not need it now.
1.429 www 2873: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2874: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2875: my $threshold=$mostfrequentcount/10;
2876: foreach my $possibleword (@RelatedWords) {
2877: my ($word,$wordcount)=split(/\,/,$possibleword);
2878: if ($wordcount>$threshold) {
2879: push(@Words,$word);
2880: $count++;
2881: if ($count>10) { last; }
2882: }
1.20 www 2883: }
2884: }
1.46 matthew 2885: untie %thesaurus_db;
2886: return @Words;
1.14 harris41 2887: }
1.46 matthew 2888:
1.112 bowersj2 2889: =pod
2890:
2891: =back
2892:
2893: =cut
1.61 www 2894:
2895: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2896: =pod
2897:
1.112 bowersj2 2898: =head1 User Name Functions
2899:
2900: =over 4
2901:
1.648 raeburn 2902: =item * &plainname($uname,$udom,$first)
1.81 albertel 2903:
1.112 bowersj2 2904: Takes a users logon name and returns it as a string in
1.226 albertel 2905: "first middle last generation" form
2906: if $first is set to 'lastname' then it returns it as
2907: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2908:
2909: =cut
1.61 www 2910:
1.295 www 2911:
1.81 albertel 2912: ###############################################################
1.61 www 2913: sub plainname {
1.226 albertel 2914: my ($uname,$udom,$first)=@_;
1.537 albertel 2915: return if (!defined($uname) || !defined($udom));
1.295 www 2916: my %names=&getnames($uname,$udom);
1.226 albertel 2917: my $name=&Apache::lonnet::format_name($names{'firstname'},
2918: $names{'middlename'},
2919: $names{'lastname'},
2920: $names{'generation'},$first);
2921: $name=~s/^\s+//;
1.62 www 2922: $name=~s/\s+$//;
2923: $name=~s/\s+/ /g;
1.353 albertel 2924: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2925: return $name;
1.61 www 2926: }
1.66 www 2927:
2928: # -------------------------------------------------------------------- Nickname
1.81 albertel 2929: =pod
2930:
1.648 raeburn 2931: =item * &nickname($uname,$udom)
1.81 albertel 2932:
2933: Gets a users name and returns it as a string as
2934:
2935: ""nickname""
1.66 www 2936:
1.81 albertel 2937: if the user has a nickname or
2938:
2939: "first middle last generation"
2940:
2941: if the user does not
2942:
2943: =cut
1.66 www 2944:
2945: sub nickname {
2946: my ($uname,$udom)=@_;
1.537 albertel 2947: return if (!defined($uname) || !defined($udom));
1.295 www 2948: my %names=&getnames($uname,$udom);
1.68 albertel 2949: my $name=$names{'nickname'};
1.66 www 2950: if ($name) {
2951: $name='"'.$name.'"';
2952: } else {
2953: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2954: $names{'lastname'}.' '.$names{'generation'};
2955: $name=~s/\s+$//;
2956: $name=~s/\s+/ /g;
2957: }
2958: return $name;
2959: }
2960:
1.295 www 2961: sub getnames {
2962: my ($uname,$udom)=@_;
1.537 albertel 2963: return if (!defined($uname) || !defined($udom));
1.433 albertel 2964: if ($udom eq 'public' && $uname eq 'public') {
2965: return ('lastname' => &mt('Public'));
2966: }
1.295 www 2967: my $id=$uname.':'.$udom;
2968: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2969: if ($cached) {
2970: return %{$names};
2971: } else {
2972: my %loadnames=&Apache::lonnet::get('environment',
2973: ['firstname','middlename','lastname','generation','nickname'],
2974: $udom,$uname);
2975: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2976: return %loadnames;
2977: }
2978: }
1.61 www 2979:
1.542 raeburn 2980: # -------------------------------------------------------------------- getemails
1.648 raeburn 2981:
1.542 raeburn 2982: =pod
2983:
1.648 raeburn 2984: =item * &getemails($uname,$udom)
1.542 raeburn 2985:
2986: Gets a user's email information and returns it as a hash with keys:
2987: notification, critnotification, permanentemail
2988:
2989: For notification and critnotification, values are comma-separated lists
1.648 raeburn 2990: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 2991:
1.648 raeburn 2992:
1.542 raeburn 2993: =cut
2994:
1.648 raeburn 2995:
1.466 albertel 2996: sub getemails {
2997: my ($uname,$udom)=@_;
2998: if ($udom eq 'public' && $uname eq 'public') {
2999: return;
3000: }
1.467 www 3001: if (!$udom) { $udom=$env{'user.domain'}; }
3002: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 3003: my $id=$uname.':'.$udom;
3004: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
3005: if ($cached) {
3006: return %{$names};
3007: } else {
3008: my %loadnames=&Apache::lonnet::get('environment',
3009: ['notification','critnotification',
3010: 'permanentemail'],
3011: $udom,$uname);
3012: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
3013: return %loadnames;
3014: }
3015: }
3016:
1.551 albertel 3017: sub flush_email_cache {
3018: my ($uname,$udom)=@_;
3019: if (!$udom) { $udom =$env{'user.domain'}; }
3020: if (!$uname) { $uname=$env{'user.name'}; }
3021: return if ($udom eq 'public' && $uname eq 'public');
3022: my $id=$uname.':'.$udom;
3023: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
3024: }
3025:
1.728 raeburn 3026: # -------------------------------------------------------------------- getlangs
3027:
3028: =pod
3029:
3030: =item * &getlangs($uname,$udom)
3031:
3032: Gets a user's language preference and returns it as a hash with key:
3033: language.
3034:
3035: =cut
3036:
3037:
3038: sub getlangs {
3039: my ($uname,$udom) = @_;
3040: if (!$udom) { $udom =$env{'user.domain'}; }
3041: if (!$uname) { $uname=$env{'user.name'}; }
3042: my $id=$uname.':'.$udom;
3043: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
3044: if ($cached) {
3045: return %{$langs};
3046: } else {
3047: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
3048: $udom,$uname);
3049: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
3050: return %loadlangs;
3051: }
3052: }
3053:
3054: sub flush_langs_cache {
3055: my ($uname,$udom)=@_;
3056: if (!$udom) { $udom =$env{'user.domain'}; }
3057: if (!$uname) { $uname=$env{'user.name'}; }
3058: return if ($udom eq 'public' && $uname eq 'public');
3059: my $id=$uname.':'.$udom;
3060: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
3061: }
3062:
1.61 www 3063: # ------------------------------------------------------------------ Screenname
1.81 albertel 3064:
3065: =pod
3066:
1.648 raeburn 3067: =item * &screenname($uname,$udom)
1.81 albertel 3068:
3069: Gets a users screenname and returns it as a string
3070:
3071: =cut
1.61 www 3072:
3073: sub screenname {
3074: my ($uname,$udom)=@_;
1.258 albertel 3075: if ($uname eq $env{'user.name'} &&
3076: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 3077: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 3078: return $names{'screenname'};
1.62 www 3079: }
3080:
1.212 albertel 3081:
1.802 bisitz 3082: # ------------------------------------------------------------- Confirm Wrapper
3083: =pod
3084:
3085: =item confirmwrapper
3086:
3087: Wrap messages about completion of operation in box
3088:
3089: =cut
3090:
3091: sub confirmwrapper {
3092: my ($message)=@_;
3093: if ($message) {
3094: return "\n".'<div class="LC_confirm_box">'."\n"
3095: .$message."\n"
3096: .'</div>'."\n";
3097: } else {
3098: return $message;
3099: }
3100: }
3101:
1.62 www 3102: # ------------------------------------------------------------- Message Wrapper
3103:
3104: sub messagewrapper {
1.369 www 3105: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 3106: return
1.441 albertel 3107: '<a href="/adm/email?compose=individual&'.
3108: 'recname='.$username.'&recdom='.$domain.
3109: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 3110: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 3111: }
1.802 bisitz 3112:
1.74 www 3113: # --------------------------------------------------------------- Notes Wrapper
3114:
3115: sub noteswrapper {
3116: my ($link,$un,$do)=@_;
3117: return
1.896 amueller 3118: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 3119: }
1.802 bisitz 3120:
1.62 www 3121: # ------------------------------------------------------------- Aboutme Wrapper
3122:
3123: sub aboutmewrapper {
1.166 www 3124: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 3125: if (!defined($username) && !defined($domain)) {
3126: return;
3127: }
1.892 amueller 3128: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.756 weissno 3129: ($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 3130: }
3131:
3132: # ------------------------------------------------------------ Syllabus Wrapper
3133:
3134: sub syllabuswrapper {
1.707 bisitz 3135: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 3136: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 3137: }
1.14 harris41 3138:
1.802 bisitz 3139: # -----------------------------------------------------------------------------
3140:
1.208 matthew 3141: sub track_student_link {
1.887 raeburn 3142: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 3143: my $link ="/adm/trackstudent?";
1.208 matthew 3144: my $title = 'View recent activity';
3145: if (defined($sname) && $sname !~ /^\s*$/ &&
3146: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 3147: $link .= "selected_student=$sname:$sdom";
1.208 matthew 3148: $title .= ' of this student';
1.268 albertel 3149: }
1.208 matthew 3150: if (defined($target) && $target !~ /^\s*$/) {
3151: $target = qq{target="$target"};
3152: } else {
3153: $target = '';
3154: }
1.268 albertel 3155: if ($start) { $link.='&start='.$start; }
1.887 raeburn 3156: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 3157: $title = &mt($title);
3158: $linktext = &mt($linktext);
1.448 albertel 3159: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
3160: &help_open_topic('View_recent_activity');
1.208 matthew 3161: }
3162:
1.781 raeburn 3163: sub slot_reservations_link {
3164: my ($linktext,$sname,$sdom,$target) = @_;
3165: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
3166: my $title = 'View slot reservation history';
3167: if (defined($sname) && $sname !~ /^\s*$/ &&
3168: defined($sdom) && $sdom !~ /^\s*$/) {
3169: $link .= "&uname=$sname&udom=$sdom";
3170: $title .= ' of this student';
3171: }
3172: if (defined($target) && $target !~ /^\s*$/) {
3173: $target = qq{target="$target"};
3174: } else {
3175: $target = '';
3176: }
3177: $title = &mt($title);
3178: $linktext = &mt($linktext);
3179: return qq{<a href="$link" title="$title" $target>$linktext</a>};
3180: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
3181:
3182: }
3183:
1.508 www 3184: # ===================================================== Display a student photo
3185:
3186:
1.509 albertel 3187: sub student_image_tag {
1.508 www 3188: my ($domain,$user)=@_;
3189: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
3190: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
3191: return '<img src="'.$imgsrc.'" align="right" />';
3192: } else {
3193: return '';
3194: }
3195: }
3196:
1.112 bowersj2 3197: =pod
3198:
3199: =back
3200:
3201: =head1 Access .tab File Data
3202:
3203: =over 4
3204:
1.648 raeburn 3205: =item * &languageids()
1.112 bowersj2 3206:
3207: returns list of all language ids
3208:
3209: =cut
3210:
1.14 harris41 3211: sub languageids {
1.16 harris41 3212: return sort(keys(%language));
1.14 harris41 3213: }
3214:
1.112 bowersj2 3215: =pod
3216:
1.648 raeburn 3217: =item * &languagedescription()
1.112 bowersj2 3218:
3219: returns description of a specified language id
3220:
3221: =cut
3222:
1.14 harris41 3223: sub languagedescription {
1.125 www 3224: my $code=shift;
3225: return ($supported_language{$code}?'* ':'').
3226: $language{$code}.
1.126 www 3227: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 3228: }
3229:
3230: sub plainlanguagedescription {
3231: my $code=shift;
3232: return $language{$code};
3233: }
3234:
3235: sub supportedlanguagecode {
3236: my $code=shift;
3237: return $supported_language{$code};
1.97 www 3238: }
3239:
1.112 bowersj2 3240: =pod
3241:
1.648 raeburn 3242: =item * ©rightids()
1.112 bowersj2 3243:
3244: returns list of all copyrights
3245:
3246: =cut
3247:
3248: sub copyrightids {
3249: return sort(keys(%cprtag));
3250: }
3251:
3252: =pod
3253:
1.648 raeburn 3254: =item * ©rightdescription()
1.112 bowersj2 3255:
3256: returns description of a specified copyright id
3257:
3258: =cut
3259:
3260: sub copyrightdescription {
1.166 www 3261: return &mt($cprtag{shift(@_)});
1.112 bowersj2 3262: }
1.197 matthew 3263:
3264: =pod
3265:
1.648 raeburn 3266: =item * &source_copyrightids()
1.192 taceyjo1 3267:
3268: returns list of all source copyrights
3269:
3270: =cut
3271:
3272: sub source_copyrightids {
3273: return sort(keys(%scprtag));
3274: }
3275:
3276: =pod
3277:
1.648 raeburn 3278: =item * &source_copyrightdescription()
1.192 taceyjo1 3279:
3280: returns description of a specified source copyright id
3281:
3282: =cut
3283:
3284: sub source_copyrightdescription {
3285: return &mt($scprtag{shift(@_)});
3286: }
1.112 bowersj2 3287:
3288: =pod
3289:
1.648 raeburn 3290: =item * &filecategories()
1.112 bowersj2 3291:
3292: returns list of all file categories
3293:
3294: =cut
3295:
3296: sub filecategories {
3297: return sort(keys(%category_extensions));
3298: }
3299:
3300: =pod
3301:
1.648 raeburn 3302: =item * &filecategorytypes()
1.112 bowersj2 3303:
3304: returns list of file types belonging to a given file
3305: category
3306:
3307: =cut
3308:
3309: sub filecategorytypes {
1.356 albertel 3310: my ($cat) = @_;
3311: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 3312: }
3313:
3314: =pod
3315:
1.648 raeburn 3316: =item * &fileembstyle()
1.112 bowersj2 3317:
3318: returns embedding style for a specified file type
3319:
3320: =cut
3321:
3322: sub fileembstyle {
3323: return $fe{lc(shift(@_))};
1.169 www 3324: }
3325:
1.351 www 3326: sub filemimetype {
3327: return $fm{lc(shift(@_))};
3328: }
3329:
1.169 www 3330:
3331: sub filecategoryselect {
3332: my ($name,$value)=@_;
1.189 matthew 3333: return &select_form($value,$name,
1.970 raeburn 3334: {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112 bowersj2 3335: }
3336:
3337: =pod
3338:
1.648 raeburn 3339: =item * &filedescription()
1.112 bowersj2 3340:
3341: returns description for a specified file type
3342:
3343: =cut
3344:
3345: sub filedescription {
1.188 matthew 3346: my $file_description = $fd{lc(shift())};
3347: $file_description =~ s:([\[\]]):~$1:g;
3348: return &mt($file_description);
1.112 bowersj2 3349: }
3350:
3351: =pod
3352:
1.648 raeburn 3353: =item * &filedescriptionex()
1.112 bowersj2 3354:
3355: returns description for a specified file type with
3356: extra formatting
3357:
3358: =cut
3359:
3360: sub filedescriptionex {
3361: my $ex=shift;
1.188 matthew 3362: my $file_description = $fd{lc($ex)};
3363: $file_description =~ s:([\[\]]):~$1:g;
3364: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3365: }
3366:
3367: # End of .tab access
3368: =pod
3369:
3370: =back
3371:
3372: =cut
3373:
3374: # ------------------------------------------------------------------ File Types
3375: sub fileextensions {
3376: return sort(keys(%fe));
3377: }
3378:
1.97 www 3379: # ----------------------------------------------------------- Display Languages
3380: # returns a hash with all desired display languages
3381: #
3382:
3383: sub display_languages {
3384: my %languages=();
1.695 raeburn 3385: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3386: $languages{$lang}=1;
1.97 www 3387: }
3388: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3389: if ($env{'form.displaylanguage'}) {
1.356 albertel 3390: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3391: $languages{$lang}=1;
1.97 www 3392: }
3393: }
3394: return %languages;
1.14 harris41 3395: }
3396:
1.582 albertel 3397: sub languages {
3398: my ($possible_langs) = @_;
1.695 raeburn 3399: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3400: if (!ref($possible_langs)) {
3401: if( wantarray ) {
3402: return @preferred_langs;
3403: } else {
3404: return $preferred_langs[0];
3405: }
3406: }
3407: my %possibilities = map { $_ => 1 } (@$possible_langs);
3408: my @preferred_possibilities;
3409: foreach my $preferred_lang (@preferred_langs) {
3410: if (exists($possibilities{$preferred_lang})) {
3411: push(@preferred_possibilities, $preferred_lang);
3412: }
3413: }
3414: if( wantarray ) {
3415: return @preferred_possibilities;
3416: }
3417: return $preferred_possibilities[0];
3418: }
3419:
1.742 raeburn 3420: sub user_lang {
3421: my ($touname,$toudom,$fromcid) = @_;
3422: my @userlangs;
3423: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3424: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3425: $env{'course.'.$fromcid.'.languages'}));
3426: } else {
3427: my %langhash = &getlangs($touname,$toudom);
3428: if ($langhash{'languages'} ne '') {
3429: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3430: } else {
3431: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3432: if ($domdefs{'lang_def'} ne '') {
3433: @userlangs = ($domdefs{'lang_def'});
3434: }
3435: }
3436: }
3437: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3438: my $user_lh = Apache::localize->get_handle(@languages);
3439: return $user_lh;
3440: }
3441:
3442:
1.112 bowersj2 3443: ###############################################################
3444: ## Student Answer Attempts ##
3445: ###############################################################
3446:
3447: =pod
3448:
3449: =head1 Alternate Problem Views
3450:
3451: =over 4
3452:
1.648 raeburn 3453: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3454: $getattempt, $regexp, $gradesub)
3455:
3456: Return string with previous attempt on problem. Arguments:
3457:
3458: =over 4
3459:
3460: =item * $symb: Problem, including path
3461:
3462: =item * $username: username of the desired student
3463:
3464: =item * $domain: domain of the desired student
1.14 harris41 3465:
1.112 bowersj2 3466: =item * $course: Course ID
1.14 harris41 3467:
1.112 bowersj2 3468: =item * $getattempt: Leave blank for all attempts, otherwise put
3469: something
1.14 harris41 3470:
1.112 bowersj2 3471: =item * $regexp: if string matches this regexp, the string will be
3472: sent to $gradesub
1.14 harris41 3473:
1.112 bowersj2 3474: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3475:
1.112 bowersj2 3476: =back
1.14 harris41 3477:
1.112 bowersj2 3478: The output string is a table containing all desired attempts, if any.
1.16 harris41 3479:
1.112 bowersj2 3480: =cut
1.1 albertel 3481:
3482: sub get_previous_attempt {
1.43 ng 3483: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3484: my $prevattempts='';
1.43 ng 3485: no strict 'refs';
1.1 albertel 3486: if ($symb) {
1.3 albertel 3487: my (%returnhash)=
3488: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3489: if ($returnhash{'version'}) {
3490: my %lasthash=();
3491: my $version;
3492: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3493: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3494: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3495: }
1.1 albertel 3496: }
1.596 albertel 3497: $prevattempts=&start_data_table().&start_data_table_header_row();
3498: $prevattempts.='<th>'.&mt('History').'</th>';
1.978 raeburn 3499: my (%typeparts,%lasthidden);
1.945 raeburn 3500: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 3501: foreach my $key (sort(keys(%lasthash))) {
3502: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3503: if ($#parts > 0) {
1.31 albertel 3504: my $data=$parts[-1];
1.989 raeburn 3505: next if ($data eq 'foilorder');
1.31 albertel 3506: pop(@parts);
1.1010 www 3507: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.945 raeburn 3508: if ($data eq 'type') {
3509: unless ($showsurv) {
3510: my $id = join(',',@parts);
3511: $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978 raeburn 3512: if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
3513: $lasthidden{$ign.'.'.$id} = 1;
3514: }
1.945 raeburn 3515: }
1.1010 www 3516: }
1.31 albertel 3517: } else {
1.41 ng 3518: if ($#parts == 0) {
3519: $prevattempts.='<th>'.$parts[0].'</th>';
3520: } else {
3521: $prevattempts.='<th>'.$ign.'</th>';
3522: }
1.31 albertel 3523: }
1.16 harris41 3524: }
1.596 albertel 3525: $prevattempts.=&end_data_table_header_row();
1.40 ng 3526: if ($getattempt eq '') {
3527: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.945 raeburn 3528: my @hidden;
3529: if (%typeparts) {
3530: foreach my $id (keys(%typeparts)) {
3531: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
3532: push(@hidden,$id);
3533: }
3534: }
3535: }
3536: $prevattempts.=&start_data_table_row().
3537: '<td>'.&mt('Transaction [_1]',$version).'</td>';
3538: if (@hidden) {
3539: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3540: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3541: my $hide;
3542: foreach my $id (@hidden) {
3543: if ($key =~ /^\Q$id\E/) {
3544: $hide = 1;
3545: last;
3546: }
3547: }
3548: if ($hide) {
3549: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3550: if (($data eq 'award') || ($data eq 'awarddetail')) {
3551: my $value = &format_previous_attempt_value($key,
3552: $returnhash{$version.':'.$key});
3553: $prevattempts.='<td>'.$value.' </td>';
3554: } else {
3555: $prevattempts.='<td> </td>';
3556: }
3557: } else {
3558: if ($key =~ /\./) {
3559: my $value = &format_previous_attempt_value($key,
3560: $returnhash{$version.':'.$key});
3561: $prevattempts.='<td>'.$value.' </td>';
3562: } else {
3563: $prevattempts.='<td> </td>';
3564: }
3565: }
3566: }
3567: } else {
3568: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3569: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3570: my $value = &format_previous_attempt_value($key,
3571: $returnhash{$version.':'.$key});
3572: $prevattempts.='<td>'.$value.' </td>';
3573: }
3574: }
3575: $prevattempts.=&end_data_table_row();
1.40 ng 3576: }
1.1 albertel 3577: }
1.945 raeburn 3578: my @currhidden = keys(%lasthidden);
1.596 albertel 3579: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3580: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3581: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3582: if (%typeparts) {
3583: my $hidden;
3584: foreach my $id (@currhidden) {
3585: if ($key =~ /^\Q$id\E/) {
3586: $hidden = 1;
3587: last;
3588: }
3589: }
3590: if ($hidden) {
3591: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3592: if (($data eq 'award') || ($data eq 'awarddetail')) {
3593: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3594: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3595: $value = &$gradesub($value);
3596: }
3597: $prevattempts.='<td>'.$value.' </td>';
3598: } else {
3599: $prevattempts.='<td> </td>';
3600: }
3601: } else {
3602: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3603: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3604: $value = &$gradesub($value);
3605: }
3606: $prevattempts.='<td>'.$value.' </td>';
3607: }
3608: } else {
3609: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3610: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3611: $value = &$gradesub($value);
3612: }
3613: $prevattempts.='<td>'.$value.' </td>';
3614: }
1.16 harris41 3615: }
1.596 albertel 3616: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3617: } else {
1.596 albertel 3618: $prevattempts=
3619: &start_data_table().&start_data_table_row().
3620: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3621: &end_data_table_row().&end_data_table();
1.1 albertel 3622: }
3623: } else {
1.596 albertel 3624: $prevattempts=
3625: &start_data_table().&start_data_table_row().
3626: '<td>'.&mt('No data.').'</td>'.
3627: &end_data_table_row().&end_data_table();
1.1 albertel 3628: }
1.10 albertel 3629: }
3630:
1.581 albertel 3631: sub format_previous_attempt_value {
3632: my ($key,$value) = @_;
1.1011 www 3633: if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.581 albertel 3634: $value = &Apache::lonlocal::locallocaltime($value);
3635: } elsif (ref($value) eq 'ARRAY') {
3636: $value = '('.join(', ', @{ $value }).')';
1.988 raeburn 3637: } elsif ($key =~ /answerstring$/) {
3638: my %answers = &Apache::lonnet::str2hash($value);
3639: my @anskeys = sort(keys(%answers));
3640: if (@anskeys == 1) {
3641: my $answer = $answers{$anskeys[0]};
1.1001 raeburn 3642: if ($answer =~ m{\0}) {
3643: $answer =~ s{\0}{,}g;
1.988 raeburn 3644: }
3645: my $tag_internal_answer_name = 'INTERNAL';
3646: if ($anskeys[0] eq $tag_internal_answer_name) {
3647: $value = $answer;
3648: } else {
3649: $value = $anskeys[0].'='.$answer;
3650: }
3651: } else {
3652: foreach my $ans (@anskeys) {
3653: my $answer = $answers{$ans};
1.1001 raeburn 3654: if ($answer =~ m{\0}) {
3655: $answer =~ s{\0}{,}g;
1.988 raeburn 3656: }
3657: $value .= $ans.'='.$answer.'<br />';;
3658: }
3659: }
1.581 albertel 3660: } else {
3661: $value = &unescape($value);
3662: }
3663: return $value;
3664: }
3665:
3666:
1.107 albertel 3667: sub relative_to_absolute {
3668: my ($url,$output)=@_;
3669: my $parser=HTML::TokeParser->new(\$output);
3670: my $token;
3671: my $thisdir=$url;
3672: my @rlinks=();
3673: while ($token=$parser->get_token) {
3674: if ($token->[0] eq 'S') {
3675: if ($token->[1] eq 'a') {
3676: if ($token->[2]->{'href'}) {
3677: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3678: }
3679: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3680: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3681: } elsif ($token->[1] eq 'base') {
3682: $thisdir=$token->[2]->{'href'};
3683: }
3684: }
3685: }
3686: $thisdir=~s-/[^/]*$--;
1.356 albertel 3687: foreach my $link (@rlinks) {
1.726 raeburn 3688: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3689: ($link=~/^\//) ||
3690: ($link=~/^javascript:/i) ||
3691: ($link=~/^mailto:/i) ||
3692: ($link=~/^\#/)) {
3693: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3694: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3695: }
3696: }
3697: # -------------------------------------------------- Deal with Applet codebases
3698: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3699: return $output;
3700: }
3701:
1.112 bowersj2 3702: =pod
3703:
1.648 raeburn 3704: =item * &get_student_view()
1.112 bowersj2 3705:
3706: show a snapshot of what student was looking at
3707:
3708: =cut
3709:
1.10 albertel 3710: sub get_student_view {
1.186 albertel 3711: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3712: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3713: my (%form);
1.10 albertel 3714: my @elements=('symb','courseid','domain','username');
3715: foreach my $element (@elements) {
1.186 albertel 3716: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3717: }
1.186 albertel 3718: if (defined($moreenv)) {
3719: %form=(%form,%{$moreenv});
3720: }
1.236 albertel 3721: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3722: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3723: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3724: $userview=~s/\<body[^\>]*\>//gi;
3725: $userview=~s/\<\/body\>//gi;
3726: $userview=~s/\<html\>//gi;
3727: $userview=~s/\<\/html\>//gi;
3728: $userview=~s/\<head\>//gi;
3729: $userview=~s/\<\/head\>//gi;
3730: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3731: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3732: if (wantarray) {
3733: return ($userview,$response);
3734: } else {
3735: return $userview;
3736: }
3737: }
3738:
3739: sub get_student_view_with_retries {
3740: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3741:
3742: my $ok = 0; # True if we got a good response.
3743: my $content;
3744: my $response;
3745:
3746: # Try to get the student_view done. within the retries count:
3747:
3748: do {
3749: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3750: $ok = $response->is_success;
3751: if (!$ok) {
3752: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3753: }
3754: $retries--;
3755: } while (!$ok && ($retries > 0));
3756:
3757: if (!$ok) {
3758: $content = ''; # On error return an empty content.
3759: }
1.651 www 3760: if (wantarray) {
3761: return ($content, $response);
3762: } else {
3763: return $content;
3764: }
1.11 albertel 3765: }
3766:
1.112 bowersj2 3767: =pod
3768:
1.648 raeburn 3769: =item * &get_student_answers()
1.112 bowersj2 3770:
3771: show a snapshot of how student was answering problem
3772:
3773: =cut
3774:
1.11 albertel 3775: sub get_student_answers {
1.100 sakharuk 3776: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3777: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3778: my (%moreenv);
1.11 albertel 3779: my @elements=('symb','courseid','domain','username');
3780: foreach my $element (@elements) {
1.186 albertel 3781: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3782: }
1.186 albertel 3783: $moreenv{'grade_target'}='answer';
3784: %moreenv=(%form,%moreenv);
1.497 raeburn 3785: $feedurl = &Apache::lonnet::clutter($feedurl);
3786: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3787: return $userview;
1.1 albertel 3788: }
1.116 albertel 3789:
3790: =pod
3791:
3792: =item * &submlink()
3793:
1.242 albertel 3794: Inputs: $text $uname $udom $symb $target
1.116 albertel 3795:
3796: Returns: A link to grades.pm such as to see the SUBM view of a student
3797:
3798: =cut
3799:
3800: ###############################################
3801: sub submlink {
1.242 albertel 3802: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3803: if (!($uname && $udom)) {
3804: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3805: &Apache::lonnet::whichuser($symb);
1.116 albertel 3806: if (!$symb) { $symb=$cursymb; }
3807: }
1.254 matthew 3808: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3809: $symb=&escape($symb);
1.960 bisitz 3810: if ($target) { $target=" target=\"$target\""; }
3811: return
3812: '<a href="/adm/grades?command=submission'.
3813: '&symb='.$symb.
3814: '&student='.$uname.
3815: '&userdom='.$udom.'"'.
3816: $target.'>'.$text.'</a>';
1.242 albertel 3817: }
3818: ##############################################
3819:
3820: =pod
3821:
3822: =item * &pgrdlink()
3823:
3824: Inputs: $text $uname $udom $symb $target
3825:
3826: Returns: A link to grades.pm such as to see the PGRD view of a student
3827:
3828: =cut
3829:
3830: ###############################################
3831: sub pgrdlink {
3832: my $link=&submlink(@_);
3833: $link=~s/(&command=submission)/$1&showgrading=yes/;
3834: return $link;
3835: }
3836: ##############################################
3837:
3838: =pod
3839:
3840: =item * &pprmlink()
3841:
3842: Inputs: $text $uname $udom $symb $target
3843:
3844: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3845: student and a specific resource
1.242 albertel 3846:
3847: =cut
3848:
3849: ###############################################
3850: sub pprmlink {
3851: my ($text,$uname,$udom,$symb,$target)=@_;
3852: if (!($uname && $udom)) {
3853: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3854: &Apache::lonnet::whichuser($symb);
1.242 albertel 3855: if (!$symb) { $symb=$cursymb; }
3856: }
1.254 matthew 3857: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3858: $symb=&escape($symb);
1.242 albertel 3859: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3860: return '<a href="/adm/parmset?command=set&'.
3861: 'symb='.$symb.'&uname='.$uname.
3862: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3863: }
3864: ##############################################
1.37 matthew 3865:
1.112 bowersj2 3866: =pod
3867:
3868: =back
3869:
3870: =cut
3871:
1.37 matthew 3872: ###############################################
1.51 www 3873:
3874:
3875: sub timehash {
1.687 raeburn 3876: my ($thistime) = @_;
3877: my $timezone = &Apache::lonlocal::gettimezone();
3878: my $dt = DateTime->from_epoch(epoch => $thistime)
3879: ->set_time_zone($timezone);
3880: my $wday = $dt->day_of_week();
3881: if ($wday == 7) { $wday = 0; }
3882: return ( 'second' => $dt->second(),
3883: 'minute' => $dt->minute(),
3884: 'hour' => $dt->hour(),
3885: 'day' => $dt->day_of_month(),
3886: 'month' => $dt->month(),
3887: 'year' => $dt->year(),
3888: 'weekday' => $wday,
3889: 'dayyear' => $dt->day_of_year(),
3890: 'dlsav' => $dt->is_dst() );
1.51 www 3891: }
3892:
1.370 www 3893: sub utc_string {
3894: my ($date)=@_;
1.371 www 3895: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3896: }
3897:
1.51 www 3898: sub maketime {
3899: my %th=@_;
1.687 raeburn 3900: my ($epoch_time,$timezone,$dt);
3901: $timezone = &Apache::lonlocal::gettimezone();
3902: eval {
3903: $dt = DateTime->new( year => $th{'year'},
3904: month => $th{'month'},
3905: day => $th{'day'},
3906: hour => $th{'hour'},
3907: minute => $th{'minute'},
3908: second => $th{'second'},
3909: time_zone => $timezone,
3910: );
3911: };
3912: if (!$@) {
3913: $epoch_time = $dt->epoch;
3914: if ($epoch_time) {
3915: return $epoch_time;
3916: }
3917: }
1.51 www 3918: return POSIX::mktime(
3919: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3920: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3921: }
3922:
3923: #########################################
1.51 www 3924:
3925: sub findallcourses {
1.482 raeburn 3926: my ($roles,$uname,$udom) = @_;
1.355 albertel 3927: my %roles;
3928: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3929: my %courses;
1.51 www 3930: my $now=time;
1.482 raeburn 3931: if (!defined($uname)) {
3932: $uname = $env{'user.name'};
3933: }
3934: if (!defined($udom)) {
3935: $udom = $env{'user.domain'};
3936: }
3937: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.982 raeburn 3938: my $extra = &Apache::lonnet::freeze_escape({'skipcheck' => 1});
3939: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname,'.',undef,
3940: $extra);
1.482 raeburn 3941: if (!%roles) {
3942: %roles = (
3943: cc => 1,
1.907 raeburn 3944: co => 1,
1.482 raeburn 3945: in => 1,
3946: ep => 1,
3947: ta => 1,
3948: cr => 1,
3949: st => 1,
3950: );
3951: }
3952: foreach my $entry (keys(%roleshash)) {
3953: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3954: if ($trole =~ /^cr/) {
3955: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3956: } else {
3957: next if (!exists($roles{$trole}));
3958: }
3959: if ($tend) {
3960: next if ($tend < $now);
3961: }
3962: if ($tstart) {
3963: next if ($tstart > $now);
3964: }
3965: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3966: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3967: if ($secpart eq '') {
3968: ($cnum,$role) = split(/_/,$cnumpart);
3969: $sec = 'none';
3970: $realsec = '';
3971: } else {
3972: $cnum = $cnumpart;
3973: ($sec,$role) = split(/_/,$secpart);
3974: $realsec = $sec;
1.490 raeburn 3975: }
1.482 raeburn 3976: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3977: }
3978: } else {
3979: foreach my $key (keys(%env)) {
1.483 albertel 3980: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3981: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3982: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3983: next if ($role eq 'ca' || $role eq 'aa');
3984: next if (%roles && !exists($roles{$role}));
3985: my ($starttime,$endtime)=split(/\./,$env{$key});
3986: my $active=1;
3987: if ($starttime) {
3988: if ($now<$starttime) { $active=0; }
3989: }
3990: if ($endtime) {
3991: if ($now>$endtime) { $active=0; }
3992: }
3993: if ($active) {
3994: if ($sec eq '') {
3995: $sec = 'none';
3996: }
3997: $courses{$cdom.'_'.$cnum}{$sec} =
3998: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 3999: }
4000: }
1.51 www 4001: }
4002: }
1.474 raeburn 4003: return %courses;
1.51 www 4004: }
1.37 matthew 4005:
1.54 www 4006: ###############################################
1.474 raeburn 4007:
4008: sub blockcheck {
1.482 raeburn 4009: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 4010:
4011: if (!defined($udom)) {
4012: $udom = $env{'user.domain'};
4013: }
4014: if (!defined($uname)) {
4015: $uname = $env{'user.name'};
4016: }
4017:
4018: # If uname and udom are for a course, check for blocks in the course.
4019:
4020: if (&Apache::lonnet::is_course($udom,$uname)) {
4021: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 4022: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 4023: return ($startblock,$endblock);
4024: }
1.474 raeburn 4025:
1.502 raeburn 4026: my $startblock = 0;
4027: my $endblock = 0;
1.482 raeburn 4028: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 4029:
1.490 raeburn 4030: # If uname is for a user, and activity is course-specific, i.e.,
4031: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 4032:
1.490 raeburn 4033: if (($activity eq 'boards' || $activity eq 'chat' ||
4034: $activity eq 'groups') && ($env{'request.course.id'})) {
4035: foreach my $key (keys(%live_courses)) {
4036: if ($key ne $env{'request.course.id'}) {
4037: delete($live_courses{$key});
4038: }
4039: }
4040: }
4041:
4042: my $otheruser = 0;
4043: my %own_courses;
4044: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
4045: # Resource belongs to user other than current user.
4046: $otheruser = 1;
4047: # Gather courses for current user
4048: %own_courses =
4049: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
4050: }
4051:
4052: # Gather active course roles - course coordinator, instructor,
4053: # exam proctor, ta, student, or custom role.
1.474 raeburn 4054:
4055: foreach my $course (keys(%live_courses)) {
1.482 raeburn 4056: my ($cdom,$cnum);
4057: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
4058: $cdom = $env{'course.'.$course.'.domain'};
4059: $cnum = $env{'course.'.$course.'.num'};
4060: } else {
1.490 raeburn 4061: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 4062: }
4063: my $no_ownblock = 0;
4064: my $no_userblock = 0;
1.533 raeburn 4065: if ($otheruser && $activity ne 'com') {
1.490 raeburn 4066: # Check if current user has 'evb' priv for this
4067: if (defined($own_courses{$course})) {
4068: foreach my $sec (keys(%{$own_courses{$course}})) {
4069: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
4070: if ($sec ne 'none') {
4071: $checkrole .= '/'.$sec;
4072: }
4073: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4074: $no_ownblock = 1;
4075: last;
4076: }
4077: }
4078: }
4079: # if they have 'evb' priv and are currently not playing student
4080: next if (($no_ownblock) &&
4081: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
4082: }
1.474 raeburn 4083: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 4084: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 4085: if ($sec ne 'none') {
1.482 raeburn 4086: $checkrole .= '/'.$sec;
1.474 raeburn 4087: }
1.490 raeburn 4088: if ($otheruser) {
4089: # Resource belongs to user other than current user.
4090: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 4091: my ($trole,$tdom,$tnum,$tsec);
4092: my $entry = $live_courses{$course}{$sec};
4093: if ($entry =~ /^cr/) {
4094: ($trole,$tdom,$tnum,$tsec) =
4095: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
4096: } else {
4097: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
4098: }
4099: my ($spec,$area,$trest,%allroles,%userroles);
4100: $area = '/'.$tdom.'/'.$tnum;
4101: $trest = $tnum;
4102: if ($tsec ne '') {
4103: $area .= '/'.$tsec;
4104: $trest .= '/'.$tsec;
4105: }
4106: $spec = $trole.'.'.$area;
4107: if ($trole =~ /^cr/) {
4108: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
4109: $tdom,$spec,$trest,$area);
4110: } else {
4111: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
4112: $tdom,$spec,$trest,$area);
4113: }
4114: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 4115: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
4116: if ($1) {
4117: $no_userblock = 1;
4118: last;
4119: }
4120: }
1.490 raeburn 4121: } else {
4122: # Resource belongs to current user
4123: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 4124: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4125: $no_ownblock = 1;
4126: last;
4127: }
1.474 raeburn 4128: }
4129: }
4130: # if they have the evb priv and are currently not playing student
1.482 raeburn 4131: next if (($no_ownblock) &&
1.491 albertel 4132: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 4133: next if ($no_userblock);
1.474 raeburn 4134:
1.866 kalberla 4135: # Retrieve blocking times and identity of locker for course
1.490 raeburn 4136: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 4137:
4138: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
4139: if (($start != 0) &&
4140: (($startblock == 0) || ($startblock > $start))) {
4141: $startblock = $start;
4142: }
4143: if (($end != 0) &&
4144: (($endblock == 0) || ($endblock < $end))) {
4145: $endblock = $end;
4146: }
1.490 raeburn 4147: }
4148: return ($startblock,$endblock);
4149: }
4150:
4151: sub get_blocks {
4152: my ($setters,$activity,$cdom,$cnum) = @_;
4153: my $startblock = 0;
4154: my $endblock = 0;
4155: my $course = $cdom.'_'.$cnum;
4156: $setters->{$course} = {};
4157: $setters->{$course}{'staff'} = [];
4158: $setters->{$course}{'times'} = [];
4159: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
4160: foreach my $record (keys(%records)) {
4161: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
4162: if ($start <= time && $end >= time) {
4163: my ($staff_name,$staff_dom,$title,$blocks) =
4164: &parse_block_record($records{$record});
4165: if ($blocks->{$activity} eq 'on') {
4166: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
4167: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 4168: if ( ($startblock == 0) || ($startblock > $start) ) {
4169: $startblock = $start;
1.490 raeburn 4170: }
1.491 albertel 4171: if ( ($endblock == 0) || ($endblock < $end) ) {
4172: $endblock = $end;
1.474 raeburn 4173: }
4174: }
4175: }
4176: }
4177: return ($startblock,$endblock);
4178: }
4179:
4180: sub parse_block_record {
4181: my ($record) = @_;
4182: my ($setuname,$setudom,$title,$blocks);
4183: if (ref($record) eq 'HASH') {
4184: ($setuname,$setudom) = split(/:/,$record->{'setter'});
4185: $title = &unescape($record->{'event'});
4186: $blocks = $record->{'blocks'};
4187: } else {
4188: my @data = split(/:/,$record,3);
4189: if (scalar(@data) eq 2) {
4190: $title = $data[1];
4191: ($setuname,$setudom) = split(/@/,$data[0]);
4192: } else {
4193: ($setuname,$setudom,$title) = @data;
4194: }
4195: $blocks = { 'com' => 'on' };
4196: }
4197: return ($setuname,$setudom,$title,$blocks);
4198: }
4199:
1.854 kalberla 4200: sub blocking_status {
4201: my ($activity,$uname,$udom) = @_;
1.867 kalberla 4202: my %setters;
1.890 droeschl 4203:
4204: # check for active blocking
1.867 kalberla 4205: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
1.854 kalberla 4206:
1.890 droeschl 4207: my $blocked = $startblock && $endblock ? 1 : 0;
4208:
4209: # caller just wants to know whether a block is active
4210: if (!wantarray) { return $blocked; }
4211:
4212: # build a link to a popup window containing the details
4213: my $querystring = "?activity=$activity";
4214: # $uname and $udom decide whose portfolio the user is trying to look at
4215: $querystring .= "&udom=$udom" if $udom;
4216: $querystring .= "&uname=$uname" if $uname;
4217:
4218: my $output .= <<'END_MYBLOCK';
1.854 kalberla 4219: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
4220: var options = "width=" + w + ",height=" + h + ",";
4221: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
4222: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
4223: var newWin = window.open(url, wdwName, options);
4224: newWin.focus();
4225: }
1.890 droeschl 4226: END_MYBLOCK
1.854 kalberla 4227:
1.890 droeschl 4228: $output = Apache::lonhtmlcommon::scripttag($output);
4229:
1.854 kalberla 4230: my $popupUrl = "/adm/blockingstatus/$querystring";
1.890 droeschl 4231: my $text = mt('Communication Blocked');
4232:
1.867 kalberla 4233: $output .= <<"END_BLOCK";
4234: <div class='LC_comblock'>
1.869 kalberla 4235: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4236: title='$text'>
4237: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
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'>$text</a>
1.867 kalberla 4240: </div>
4241:
4242: END_BLOCK
1.474 raeburn 4243:
1.854 kalberla 4244: return ($blocked, $output);
4245: }
1.490 raeburn 4246:
1.60 matthew 4247: ###############################################
4248:
1.682 raeburn 4249: sub check_ip_acc {
4250: my ($acc)=@_;
4251: &Apache::lonxml::debug("acc is $acc");
4252: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
4253: return 1;
4254: }
4255: my $allowed=0;
4256: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
4257:
4258: my $name;
4259: foreach my $pattern (split(',',$acc)) {
4260: $pattern =~ s/^\s*//;
4261: $pattern =~ s/\s*$//;
4262: if ($pattern =~ /\*$/) {
4263: #35.8.*
4264: $pattern=~s/\*//;
4265: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4266: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
4267: #35.8.3.[34-56]
4268: my $low=$2;
4269: my $high=$3;
4270: $pattern=$1;
4271: if ($ip =~ /^\Q$pattern\E/) {
4272: my $last=(split(/\./,$ip))[3];
4273: if ($last <=$high && $last >=$low) { $allowed=1; }
4274: }
4275: } elsif ($pattern =~ /^\*/) {
4276: #*.msu.edu
4277: $pattern=~s/\*//;
4278: if (!defined($name)) {
4279: use Socket;
4280: my $netaddr=inet_aton($ip);
4281: ($name)=gethostbyaddr($netaddr,AF_INET);
4282: }
4283: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4284: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
4285: #127.0.0.1
4286: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4287: } else {
4288: #some.name.com
4289: if (!defined($name)) {
4290: use Socket;
4291: my $netaddr=inet_aton($ip);
4292: ($name)=gethostbyaddr($netaddr,AF_INET);
4293: }
4294: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4295: }
4296: if ($allowed) { last; }
4297: }
4298: return $allowed;
4299: }
4300:
4301: ###############################################
4302:
1.60 matthew 4303: =pod
4304:
1.112 bowersj2 4305: =head1 Domain Template Functions
4306:
4307: =over 4
4308:
4309: =item * &determinedomain()
1.60 matthew 4310:
4311: Inputs: $domain (usually will be undef)
4312:
1.63 www 4313: Returns: Determines which domain should be used for designs
1.60 matthew 4314:
4315: =cut
1.54 www 4316:
1.60 matthew 4317: ###############################################
1.63 www 4318: sub determinedomain {
4319: my $domain=shift;
1.531 albertel 4320: if (! $domain) {
1.60 matthew 4321: # Determine domain if we have not been given one
1.893 raeburn 4322: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 4323: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
4324: if ($env{'request.role.domain'}) {
4325: $domain=$env{'request.role.domain'};
1.60 matthew 4326: }
4327: }
1.63 www 4328: return $domain;
4329: }
4330: ###############################################
1.517 raeburn 4331:
1.518 albertel 4332: sub devalidate_domconfig_cache {
4333: my ($udom)=@_;
4334: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
4335: }
4336:
4337: # ---------------------- Get domain configuration for a domain
4338: sub get_domainconf {
4339: my ($udom) = @_;
4340: my $cachetime=1800;
4341: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
4342: if (defined($cached)) { return %{$result}; }
4343:
4344: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 4345: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 4346: my (%designhash,%legacy);
1.518 albertel 4347: if (keys(%domconfig) > 0) {
4348: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 4349: if (keys(%{$domconfig{'login'}})) {
4350: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 4351: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.946 raeburn 4352: if ($key eq 'loginvia') {
4353: if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') {
1.1013 raeburn 4354: foreach my $hostname (keys(%{$domconfig{'login'}{'loginvia'}})) {
1.948 raeburn 4355: if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') {
4356: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
4357: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
4358: $designhash{$udom.'.login.loginvia'} = $server;
4359: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
4360:
4361: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
4362: } else {
1.1013 raeburn 4363: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
1.948 raeburn 4364: }
4365: if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) {
4366: $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'};
4367: }
1.946 raeburn 4368: }
4369: }
4370: }
4371: }
4372: } else {
4373: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
4374: $designhash{$udom.'.login.'.$key.'_'.$img} =
4375: $domconfig{'login'}{$key}{$img};
4376: }
1.699 raeburn 4377: }
4378: } else {
4379: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
4380: }
1.632 raeburn 4381: }
4382: } else {
4383: $legacy{'login'} = 1;
1.518 albertel 4384: }
1.632 raeburn 4385: } else {
4386: $legacy{'login'} = 1;
1.518 albertel 4387: }
4388: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 4389: if (keys(%{$domconfig{'rolecolors'}})) {
4390: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
4391: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
4392: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
4393: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
4394: }
1.518 albertel 4395: }
4396: }
1.632 raeburn 4397: } else {
4398: $legacy{'rolecolors'} = 1;
1.518 albertel 4399: }
1.632 raeburn 4400: } else {
4401: $legacy{'rolecolors'} = 1;
1.518 albertel 4402: }
1.948 raeburn 4403: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
4404: if ($domconfig{'autoenroll'}{'co-owners'}) {
4405: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
4406: }
4407: }
1.632 raeburn 4408: if (keys(%legacy) > 0) {
4409: my %legacyhash = &get_legacy_domconf($udom);
4410: foreach my $item (keys(%legacyhash)) {
4411: if ($item =~ /^\Q$udom\E\.login/) {
4412: if ($legacy{'login'}) {
4413: $designhash{$item} = $legacyhash{$item};
4414: }
4415: } else {
4416: if ($legacy{'rolecolors'}) {
4417: $designhash{$item} = $legacyhash{$item};
4418: }
1.518 albertel 4419: }
4420: }
4421: }
1.632 raeburn 4422: } else {
4423: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4424: }
4425: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4426: $cachetime);
4427: return %designhash;
4428: }
4429:
1.632 raeburn 4430: sub get_legacy_domconf {
4431: my ($udom) = @_;
4432: my %legacyhash;
4433: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4434: my $designfile = $designdir.'/'.$udom.'.tab';
4435: if (-e $designfile) {
4436: if ( open (my $fh,"<$designfile") ) {
4437: while (my $line = <$fh>) {
4438: next if ($line =~ /^\#/);
4439: chomp($line);
4440: my ($key,$val)=(split(/\=/,$line));
4441: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4442: }
4443: close($fh);
4444: }
4445: }
4446: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
4447: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4448: }
4449: return %legacyhash;
4450: }
4451:
1.63 www 4452: =pod
4453:
1.112 bowersj2 4454: =item * &domainlogo()
1.63 www 4455:
4456: Inputs: $domain (usually will be undef)
4457:
4458: Returns: A link to a domain logo, if the domain logo exists.
4459: If the domain logo does not exist, a description of the domain.
4460:
4461: =cut
1.112 bowersj2 4462:
1.63 www 4463: ###############################################
4464: sub domainlogo {
1.517 raeburn 4465: my $domain = &determinedomain(shift);
1.518 albertel 4466: my %designhash = &get_domainconf($domain);
1.517 raeburn 4467: # See if there is a logo
4468: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4469: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4470: if ($imgsrc =~ m{^/(adm|res)/}) {
4471: if ($imgsrc =~ m{^/res/}) {
4472: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4473: &Apache::lonnet::repcopy($local_name);
4474: }
4475: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4476: }
4477: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4478: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4479: return &Apache::lonnet::domain($domain,'description');
1.59 www 4480: } else {
1.60 matthew 4481: return '';
1.59 www 4482: }
4483: }
1.63 www 4484: ##############################################
4485:
4486: =pod
4487:
1.112 bowersj2 4488: =item * &designparm()
1.63 www 4489:
4490: Inputs: $which parameter; $domain (usually will be undef)
4491:
4492: Returns: value of designparamter $which
4493:
4494: =cut
1.112 bowersj2 4495:
1.397 albertel 4496:
1.400 albertel 4497: ##############################################
1.397 albertel 4498: sub designparm {
4499: my ($which,$domain)=@_;
4500: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 4501: return $env{'environment.color.'.$which};
1.96 www 4502: }
1.63 www 4503: $domain=&determinedomain($domain);
1.1016 raeburn 4504: my %domdesign;
4505: unless ($domain eq 'public') {
4506: %domdesign = &get_domainconf($domain);
4507: }
1.520 raeburn 4508: my $output;
1.517 raeburn 4509: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 4510: $output = $domdesign{$domain.'.'.$which};
1.63 www 4511: } else {
1.520 raeburn 4512: $output = $defaultdesign{$which};
4513: }
4514: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4515: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4516: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 4517: if ($output =~ m{^/res/}) {
4518: my $local_name = &Apache::lonnet::filelocation('',$output);
4519: &Apache::lonnet::repcopy($local_name);
4520: }
1.520 raeburn 4521: $output = &lonhttpdurl($output);
4522: }
1.63 www 4523: }
1.520 raeburn 4524: return $output;
1.63 www 4525: }
1.59 www 4526:
1.822 bisitz 4527: ##############################################
4528: =pod
4529:
1.832 bisitz 4530: =item * &authorspace()
4531:
4532: Inputs: ./.
4533:
4534: Returns: Path to the Construction Space of the current user's
4535: accessed author space
4536: The author space will be that of the current user
4537: when accessing the own author space
4538: and that of the co-author/assistent co-author
4539: when accessing the co-author's/assistent co-author's
4540: space
4541:
4542: =cut
4543:
4544: sub authorspace {
4545: my $caname = '';
4546: if ($env{'request.role'} =~ /^ca|^aa/) {
4547: (undef,$caname) =
4548: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
4549: } else {
4550: $caname = $env{'user.name'};
4551: }
4552: return '/priv/'.$caname.'/';
4553: }
4554:
4555: ##############################################
4556: =pod
4557:
1.822 bisitz 4558: =item * &head_subbox()
4559:
4560: Inputs: $content (contains HTML code with page functions, etc.)
4561:
4562: Returns: HTML div with $content
4563: To be included in page header
4564:
4565: =cut
4566:
4567: sub head_subbox {
4568: my ($content)=@_;
4569: my $output =
1.993 raeburn 4570: '<div class="LC_head_subbox">'
1.822 bisitz 4571: .$content
4572: .'</div>'
4573: }
4574:
4575: ##############################################
4576: =pod
4577:
4578: =item * &CSTR_pageheader()
4579:
4580: Inputs: ./.
4581:
4582: Returns: HTML div with CSTR path and recent box
4583: To be included on Construction Space pages
4584:
4585: =cut
4586:
4587: sub CSTR_pageheader {
4588: # this is for resources; directories have customtitle, and crumbs
4589: # and select recent are created in lonpubdir.pm
4590: my ($uname,$thisdisfn)=
4591: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
4592: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4593: $formaction=~s/\/+/\//g;
4594:
4595: my $parentpath = '';
4596: my $lastitem = '';
4597: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4598: $parentpath = $1;
4599: $lastitem = $2;
4600: } else {
4601: $lastitem = $thisdisfn;
4602: }
1.921 bisitz 4603:
4604: my $output =
1.822 bisitz 4605: '<div>'
4606: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
4607: .'<b>'.&mt('Construction Space:').'</b> '
4608: .'<form name="dirs" method="post" action="'.$formaction
1.921 bisitz 4609: .'" target="_top">' #FIXME lonpubdir: target="_parent"
4610: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv',undef,undef);
4611:
4612: if ($lastitem) {
4613: $output .=
4614: '<span class="LC_filename">'
4615: .$lastitem
4616: .'</span>';
4617: }
4618: $output .=
4619: '<br />'
1.822 bisitz 4620: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
4621: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4622: .'</form>'
4623: .&Apache::lonmenu::constspaceform()
4624: .'</div>';
1.921 bisitz 4625:
4626: return $output;
1.822 bisitz 4627: }
4628:
1.60 matthew 4629: ###############################################
4630: ###############################################
4631:
4632: =pod
4633:
1.112 bowersj2 4634: =back
4635:
1.549 albertel 4636: =head1 HTML Helpers
1.112 bowersj2 4637:
4638: =over 4
4639:
4640: =item * &bodytag()
1.60 matthew 4641:
4642: Returns a uniform header for LON-CAPA web pages.
4643:
4644: Inputs:
4645:
1.112 bowersj2 4646: =over 4
4647:
4648: =item * $title, A title to be displayed on the page.
4649:
4650: =item * $function, the current role (can be undef).
4651:
4652: =item * $addentries, extra parameters for the <body> tag.
4653:
4654: =item * $bodyonly, if defined, only return the <body> tag.
4655:
4656: =item * $domain, if defined, force a given domain.
4657:
4658: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4659: text interface only)
1.60 matthew 4660:
1.814 bisitz 4661: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
4662: navigational links
1.317 albertel 4663:
1.338 albertel 4664: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4665:
1.460 albertel 4666: =item * $args, optional argument valid values are
4667: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4668: inherit_jsmath -> when creating popup window in a page,
4669: should it have jsmath forced on by the
4670: current page
1.460 albertel 4671:
1.112 bowersj2 4672: =back
4673:
1.60 matthew 4674: Returns: A uniform header for LON-CAPA web pages.
4675: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4676: If $bodyonly is undef or zero, an html string containing a <body> tag and
4677: other decorations will be returned.
4678:
4679: =cut
4680:
1.54 www 4681: sub bodytag {
1.831 bisitz 4682: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.962 droeschl 4683: $no_nav_bar,$bgcolor,$args)=@_;
1.339 albertel 4684:
1.954 raeburn 4685: my $public;
4686: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
4687: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
4688: $public = 1;
4689: }
1.460 albertel 4690: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4691:
1.183 matthew 4692: $function = &get_users_function() if (!$function);
1.339 albertel 4693: my $img = &designparm($function.'.img',$domain);
4694: my $font = &designparm($function.'.font',$domain);
4695: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4696:
1.803 bisitz 4697: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 4698: 'bgcolor' => $pgbg,
1.339 albertel 4699: 'text' => $font,
4700: 'alink' => &designparm($function.'.alink',$domain),
4701: 'vlink' => &designparm($function.'.vlink',$domain),
4702: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4703: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4704:
1.63 www 4705: # role and realm
1.378 raeburn 4706: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4707: if ($role eq 'ca') {
1.479 albertel 4708: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4709: $realm = &plainname($rname,$rdom);
1.378 raeburn 4710: }
1.55 www 4711: # realm
1.258 albertel 4712: if ($env{'request.course.id'}) {
1.378 raeburn 4713: if ($env{'request.role'} !~ /^cr/) {
4714: $role = &Apache::lonnet::plaintext($role,&course_type());
4715: }
1.898 raeburn 4716: if ($env{'request.course.sec'}) {
4717: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
4718: }
1.359 albertel 4719: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4720: } else {
4721: $role = &Apache::lonnet::plaintext($role);
1.54 www 4722: }
1.433 albertel 4723:
1.359 albertel 4724: if (!$realm) { $realm=' '; }
1.330 albertel 4725:
1.438 albertel 4726: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4727:
1.101 www 4728: # construct main body tag
1.359 albertel 4729: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4730: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4731:
1.530 albertel 4732: if ($bodyonly) {
1.60 matthew 4733: return $bodytag;
1.798 tempelho 4734: }
1.359 albertel 4735:
1.410 albertel 4736: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.954 raeburn 4737: if ($public) {
1.433 albertel 4738: undef($role);
1.434 albertel 4739: } else {
4740: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4741: }
1.359 albertel 4742:
1.762 bisitz 4743: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 4744: #
4745: # Extra info if you are the DC
4746: my $dc_info = '';
4747: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4748: $env{'course.'.$env{'request.course.id'}.
4749: '.domain'}.'/'})) {
4750: my $cid = $env{'request.course.id'};
1.917 raeburn 4751: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4752: $dc_info =~ s/\s+$//;
1.359 albertel 4753: }
4754:
1.898 raeburn 4755: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853 droeschl 4756: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
4757:
1.916 droeschl 4758: if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') {
4759: return $bodytag;
4760: }
1.903 droeschl 4761:
4762: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
4763:
4764: # if ($env{'request.state'} eq 'construct') {
4765: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
4766: # }
4767:
1.359 albertel 4768:
4769:
1.916 droeschl 4770: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917 raeburn 4771: if ($dc_info) {
4772: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
4773: }
1.916 droeschl 4774: $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
4775: <em>$realm</em> $dc_info</div>|;
1.903 droeschl 4776: return $bodytag;
4777: }
1.894 droeschl 4778:
1.927 raeburn 4779: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
4780: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
4781: }
1.916 droeschl 4782:
1.903 droeschl 4783: $bodytag .= Apache::lonhtmlcommon::scripttag(
4784: Apache::lonmenu::utilityfunctions(), 'start');
1.816 bisitz 4785:
1.903 droeschl 4786: $bodytag .= Apache::lonmenu::primary_menu();
1.852 droeschl 4787:
1.917 raeburn 4788: if ($dc_info) {
4789: $dc_info = &dc_courseid_toggle($dc_info);
4790: }
4791: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 4792:
1.903 droeschl 4793: #don't show menus for public users
1.954 raeburn 4794: if (!$public){
1.903 droeschl 4795: $bodytag .= Apache::lonmenu::secondary_menu();
4796: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 4797: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
4798: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 4799: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.920 raeburn 4800: $args->{'bread_crumbs'});
4801: } elsif ($forcereg) {
4802: $bodytag .= &Apache::lonmenu::innerregister($forcereg);
4803: }
1.903 droeschl 4804: }else{
4805: # this is to seperate menu from content when there's no secondary
4806: # menu. Especially needed for public accessible ressources.
4807: $bodytag .= '<hr style="clear:both" />';
4808: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 4809: }
1.903 droeschl 4810:
1.235 raeburn 4811: return $bodytag;
1.182 matthew 4812: }
4813:
1.917 raeburn 4814: sub dc_courseid_toggle {
4815: my ($dc_info) = @_;
1.980 raeburn 4816: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.917 raeburn 4817: '<a href="javascript:showCourseID();">'.
4818: &mt('(More ...)').'</a></span>'.
4819: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
4820: }
4821:
1.330 albertel 4822: sub make_attr_string {
4823: my ($register,$attr_ref) = @_;
4824:
4825: if ($attr_ref && !ref($attr_ref)) {
4826: die("addentries Must be a hash ref ".
4827: join(':',caller(1))." ".
4828: join(':',caller(0))." ");
4829: }
4830:
4831: if ($register) {
1.339 albertel 4832: my ($on_load,$on_unload);
4833: foreach my $key (keys(%{$attr_ref})) {
4834: if (lc($key) eq 'onload') {
4835: $on_load.=$attr_ref->{$key}.';';
4836: delete($attr_ref->{$key});
4837:
4838: } elsif (lc($key) eq 'onunload') {
4839: $on_unload.=$attr_ref->{$key}.';';
4840: delete($attr_ref->{$key});
4841: }
4842: }
1.953 droeschl 4843: $attr_ref->{'onload'} = $on_load;
4844: $attr_ref->{'onunload'}= $on_unload;
1.330 albertel 4845: }
1.339 albertel 4846:
1.330 albertel 4847: my $attr_string;
4848: foreach my $attr (keys(%$attr_ref)) {
4849: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4850: }
4851: return $attr_string;
4852: }
4853:
4854:
1.182 matthew 4855: ###############################################
1.251 albertel 4856: ###############################################
4857:
4858: =pod
4859:
4860: =item * &endbodytag()
4861:
4862: Returns a uniform footer for LON-CAPA web pages.
4863:
1.635 raeburn 4864: Inputs: 1 - optional reference to an args hash
4865: If in the hash, key for noredirectlink has a value which evaluates to true,
4866: a 'Continue' link is not displayed if the page contains an
4867: internal redirect in the <head></head> section,
4868: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4869:
4870: =cut
4871:
4872: sub endbodytag {
1.635 raeburn 4873: my ($args) = @_;
1.251 albertel 4874: my $endbodytag='</body>';
1.269 albertel 4875: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4876: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4877: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4878: $endbodytag=
4879: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4880: &mt('Continue').'</a>'.
4881: $endbodytag;
4882: }
1.315 albertel 4883: }
1.251 albertel 4884: return $endbodytag;
4885: }
4886:
1.352 albertel 4887: =pod
4888:
4889: =item * &standard_css()
4890:
4891: Returns a style sheet
4892:
4893: Inputs: (all optional)
4894: domain -> force to color decorate a page for a specific
4895: domain
4896: function -> force usage of a specific rolish color scheme
4897: bgcolor -> override the default page bgcolor
4898:
4899: =cut
4900:
1.343 albertel 4901: sub standard_css {
1.345 albertel 4902: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4903: $function = &get_users_function() if (!$function);
4904: my $img = &designparm($function.'.img', $domain);
4905: my $tabbg = &designparm($function.'.tabbg', $domain);
4906: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 4907: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 4908: #second colour for later usage
1.345 albertel 4909: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4910: my $pgbg_or_bgcolor =
4911: $bgcolor ||
1.352 albertel 4912: &designparm($function.'.pgbg', $domain);
1.382 albertel 4913: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4914: my $alink = &designparm($function.'.alink', $domain);
4915: my $vlink = &designparm($function.'.vlink', $domain);
4916: my $link = &designparm($function.'.link', $domain);
4917:
1.602 albertel 4918: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4919: my $mono = 'monospace';
1.850 bisitz 4920: my $data_table_head = $sidebg;
4921: my $data_table_light = '#FAFAFA';
4922: my $data_table_dark = '#F0F0F0';
1.470 banghart 4923: my $data_table_darker = '#CCCCCC';
1.349 albertel 4924: my $data_table_highlight = '#FFFF00';
1.352 albertel 4925: my $mail_new = '#FFBB77';
4926: my $mail_new_hover = '#DD9955';
4927: my $mail_read = '#BBBB77';
4928: my $mail_read_hover = '#999944';
4929: my $mail_replied = '#AAAA88';
4930: my $mail_replied_hover = '#888855';
4931: my $mail_other = '#99BBBB';
4932: my $mail_other_hover = '#669999';
1.391 albertel 4933: my $table_header = '#DDDDDD';
1.489 raeburn 4934: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 4935: my $lg_border_color = '#C8C8C8';
1.952 onken 4936: my $button_hover = '#BF2317';
1.392 albertel 4937:
1.608 albertel 4938: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 4939: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
4940: : '0 3px 0 4px';
1.448 albertel 4941:
1.523 albertel 4942:
1.343 albertel 4943: return <<END;
1.947 droeschl 4944:
4945: /* needed for iframe to allow 100% height in FF */
4946: body, html {
4947: margin: 0;
4948: padding: 0 0.5%;
4949: height: 99%; /* to avoid scrollbars */
4950: }
4951:
1.795 www 4952: body {
1.911 bisitz 4953: font-family: $sans;
4954: line-height:130%;
4955: font-size:0.83em;
4956: color:$font;
1.795 www 4957: }
4958:
1.959 onken 4959: a:focus,
4960: a:focus img {
1.795 www 4961: color: red;
1.911 bisitz 4962: background: yellow;
1.795 www 4963: }
1.698 harmsja 4964:
1.911 bisitz 4965: form, .inline {
4966: display: inline;
1.795 www 4967: }
1.721 harmsja 4968:
1.795 www 4969: .LC_right {
1.911 bisitz 4970: text-align:right;
1.795 www 4971: }
4972:
4973: .LC_middle {
1.911 bisitz 4974: vertical-align:middle;
1.795 www 4975: }
1.721 harmsja 4976:
1.911 bisitz 4977: .LC_400Box {
4978: width:400px;
4979: }
1.721 harmsja 4980:
1.947 droeschl 4981: .LC_iframecontainer {
4982: width: 98%;
4983: margin: 0;
4984: position: fixed;
4985: top: 8.5em;
4986: bottom: 0;
4987: }
4988:
4989: .LC_iframecontainer iframe{
4990: border: none;
4991: width: 100%;
4992: height: 100%;
4993: }
4994:
1.778 bisitz 4995: .LC_filename {
4996: font-family: $mono;
4997: white-space:pre;
1.921 bisitz 4998: font-size: 120%;
1.778 bisitz 4999: }
5000:
5001: .LC_fileicon {
5002: border: none;
5003: height: 1.3em;
5004: vertical-align: text-bottom;
5005: margin-right: 0.3em;
5006: text-decoration:none;
5007: }
5008:
1.1008 www 5009: .LC_setting {
5010: text-decoration:underline;
5011: }
5012:
1.350 albertel 5013: .LC_error {
5014: color: red;
5015: font-size: larger;
5016: }
1.795 www 5017:
1.457 albertel 5018: .LC_warning,
5019: .LC_diff_removed {
1.733 bisitz 5020: color: red;
1.394 albertel 5021: }
1.532 albertel 5022:
5023: .LC_info,
1.457 albertel 5024: .LC_success,
5025: .LC_diff_added {
1.350 albertel 5026: color: green;
5027: }
1.795 www 5028:
1.802 bisitz 5029: div.LC_confirm_box {
5030: background-color: #FAFAFA;
5031: border: 1px solid $lg_border_color;
5032: margin-right: 0;
5033: padding: 5px;
5034: }
5035:
5036: div.LC_confirm_box .LC_error img,
5037: div.LC_confirm_box .LC_success img {
5038: vertical-align: middle;
5039: }
5040:
1.440 albertel 5041: .LC_icon {
1.771 droeschl 5042: border: none;
1.790 droeschl 5043: vertical-align: middle;
1.771 droeschl 5044: }
5045:
1.543 albertel 5046: .LC_docs_spacer {
5047: width: 25px;
5048: height: 1px;
1.771 droeschl 5049: border: none;
1.543 albertel 5050: }
1.346 albertel 5051:
1.532 albertel 5052: .LC_internal_info {
1.735 bisitz 5053: color: #999999;
1.532 albertel 5054: }
5055:
1.794 www 5056: .LC_discussion {
1.911 bisitz 5057: background: $tabbg;
5058: border: 1px solid black;
5059: margin: 2px;
1.794 www 5060: }
5061:
5062: .LC_disc_action_links_bar {
1.911 bisitz 5063: background: $tabbg;
5064: border: none;
5065: margin: 4px;
1.794 www 5066: }
5067:
5068: .LC_disc_action_left {
1.911 bisitz 5069: text-align: left;
1.794 www 5070: }
5071:
5072: .LC_disc_action_right {
1.911 bisitz 5073: text-align: right;
1.794 www 5074: }
5075:
5076: .LC_disc_new_item {
1.911 bisitz 5077: background: white;
5078: border: 2px solid red;
5079: margin: 2px;
1.794 www 5080: }
5081:
5082: .LC_disc_old_item {
1.911 bisitz 5083: background: white;
5084: border: 1px solid black;
5085: margin: 2px;
1.794 www 5086: }
5087:
1.458 albertel 5088: table.LC_pastsubmission {
5089: border: 1px solid black;
5090: margin: 2px;
5091: }
5092:
1.924 bisitz 5093: table#LC_menubuttons {
1.345 albertel 5094: width: 100%;
5095: background: $pgbg;
1.392 albertel 5096: border: 2px;
1.402 albertel 5097: border-collapse: separate;
1.803 bisitz 5098: padding: 0;
1.345 albertel 5099: }
1.392 albertel 5100:
1.801 tempelho 5101: table#LC_title_bar a {
5102: color: $fontmenu;
5103: }
1.836 bisitz 5104:
1.807 droeschl 5105: table#LC_title_bar {
1.819 tempelho 5106: clear: both;
1.836 bisitz 5107: display: none;
1.807 droeschl 5108: }
5109:
1.795 www 5110: table#LC_title_bar,
1.933 droeschl 5111: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 5112: table#LC_title_bar.LC_with_remote {
1.359 albertel 5113: width: 100%;
1.392 albertel 5114: border-color: $pgbg;
5115: border-style: solid;
5116: border-width: $border;
1.379 albertel 5117: background: $pgbg;
1.801 tempelho 5118: color: $fontmenu;
1.392 albertel 5119: border-collapse: collapse;
1.803 bisitz 5120: padding: 0;
1.819 tempelho 5121: margin: 0;
1.359 albertel 5122: }
1.795 www 5123:
1.933 droeschl 5124: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 5125: margin: 0;
5126: padding: 0;
1.933 droeschl 5127: position: relative;
5128: list-style: none;
1.913 droeschl 5129: }
1.933 droeschl 5130: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 5131: display: inline;
5132: }
1.933 droeschl 5133:
5134: .LC_breadcrumb_tools_navigation {
1.913 droeschl 5135: padding: 0;
1.933 droeschl 5136: margin: 0;
5137: float: left;
1.913 droeschl 5138: }
1.933 droeschl 5139: .LC_breadcrumb_tools_tools {
5140: padding: 0;
5141: margin: 0;
1.913 droeschl 5142: float: right;
5143: }
5144:
1.359 albertel 5145: table#LC_title_bar td {
5146: background: $tabbg;
5147: }
1.795 www 5148:
1.911 bisitz 5149: table#LC_menubuttons img {
1.803 bisitz 5150: border: none;
1.346 albertel 5151: }
1.795 www 5152:
1.842 droeschl 5153: .LC_breadcrumbs_component {
1.911 bisitz 5154: float: right;
5155: margin: 0 1em;
1.357 albertel 5156: }
1.842 droeschl 5157: .LC_breadcrumbs_component img {
1.911 bisitz 5158: vertical-align: middle;
1.777 tempelho 5159: }
1.795 www 5160:
1.383 albertel 5161: td.LC_table_cell_checkbox {
5162: text-align: center;
5163: }
1.795 www 5164:
5165: .LC_fontsize_small {
1.911 bisitz 5166: font-size: 70%;
1.705 tempelho 5167: }
5168:
1.844 bisitz 5169: #LC_breadcrumbs {
1.911 bisitz 5170: clear:both;
5171: background: $sidebg;
5172: border-bottom: 1px solid $lg_border_color;
5173: line-height: 2.5em;
1.933 droeschl 5174: overflow: hidden;
1.911 bisitz 5175: margin: 0;
5176: padding: 0;
1.995 raeburn 5177: text-align: left;
1.819 tempelho 5178: }
1.862 bisitz 5179:
1.993 raeburn 5180: .LC_head_subbox {
1.911 bisitz 5181: clear:both;
5182: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 5183: border: 1px solid $sidebg;
5184: margin: 0 0 10px 0;
1.966 bisitz 5185: padding: 3px;
1.995 raeburn 5186: text-align: left;
1.822 bisitz 5187: }
5188:
1.795 www 5189: .LC_fontsize_medium {
1.911 bisitz 5190: font-size: 85%;
1.705 tempelho 5191: }
5192:
1.795 www 5193: .LC_fontsize_large {
1.911 bisitz 5194: font-size: 120%;
1.705 tempelho 5195: }
5196:
1.346 albertel 5197: .LC_menubuttons_inline_text {
5198: color: $font;
1.698 harmsja 5199: font-size: 90%;
1.701 harmsja 5200: padding-left:3px;
1.346 albertel 5201: }
5202:
1.934 droeschl 5203: .LC_menubuttons_inline_text img{
5204: vertical-align: middle;
5205: }
5206:
1.951 onken 5207: li.LC_menubuttons_inline_text img,a {
5208: cursor:pointer;
1.1002 droeschl 5209: text-decoration: none;
1.951 onken 5210: }
5211:
1.526 www 5212: .LC_menubuttons_link {
5213: text-decoration: none;
5214: }
1.795 www 5215:
1.522 albertel 5216: .LC_menubuttons_category {
1.521 www 5217: color: $font;
1.526 www 5218: background: $pgbg;
1.521 www 5219: font-size: larger;
5220: font-weight: bold;
5221: }
5222:
1.346 albertel 5223: td.LC_menubuttons_text {
1.911 bisitz 5224: color: $font;
1.346 albertel 5225: }
1.706 harmsja 5226:
1.346 albertel 5227: .LC_current_location {
5228: background: $tabbg;
5229: }
1.795 www 5230:
1.938 bisitz 5231: table.LC_data_table {
1.347 albertel 5232: border: 1px solid #000000;
1.402 albertel 5233: border-collapse: separate;
1.426 albertel 5234: border-spacing: 1px;
1.610 albertel 5235: background: $pgbg;
1.347 albertel 5236: }
1.795 www 5237:
1.422 albertel 5238: .LC_data_table_dense {
5239: font-size: small;
5240: }
1.795 www 5241:
1.507 raeburn 5242: table.LC_nested_outer {
5243: border: 1px solid #000000;
1.589 raeburn 5244: border-collapse: collapse;
1.803 bisitz 5245: border-spacing: 0;
1.507 raeburn 5246: width: 100%;
5247: }
1.795 www 5248:
1.879 raeburn 5249: table.LC_innerpickbox,
1.507 raeburn 5250: table.LC_nested {
1.803 bisitz 5251: border: none;
1.589 raeburn 5252: border-collapse: collapse;
1.803 bisitz 5253: border-spacing: 0;
1.507 raeburn 5254: width: 100%;
5255: }
1.795 www 5256:
1.911 bisitz 5257: table.LC_data_table tr th,
5258: table.LC_calendar tr th,
1.879 raeburn 5259: table.LC_prior_tries tr th,
5260: table.LC_innerpickbox tr th {
1.349 albertel 5261: font-weight: bold;
5262: background-color: $data_table_head;
1.801 tempelho 5263: color:$fontmenu;
1.701 harmsja 5264: font-size:90%;
1.347 albertel 5265: }
1.795 www 5266:
1.879 raeburn 5267: table.LC_innerpickbox tr th,
5268: table.LC_innerpickbox tr td {
5269: vertical-align: top;
5270: }
5271:
1.711 raeburn 5272: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 5273: background-color: #CCCCCC;
1.711 raeburn 5274: font-weight: bold;
5275: text-align: left;
5276: }
1.795 www 5277:
1.912 bisitz 5278: table.LC_data_table tr.LC_odd_row > td {
5279: background-color: $data_table_light;
5280: padding: 2px;
5281: vertical-align: top;
5282: }
5283:
1.809 bisitz 5284: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 5285: background-color: $data_table_light;
1.912 bisitz 5286: vertical-align: top;
5287: }
5288:
5289: table.LC_data_table tr.LC_even_row > td {
5290: background-color: $data_table_dark;
1.425 albertel 5291: padding: 2px;
1.900 bisitz 5292: vertical-align: top;
1.347 albertel 5293: }
1.795 www 5294:
1.809 bisitz 5295: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 5296: background-color: $data_table_dark;
1.900 bisitz 5297: vertical-align: top;
1.347 albertel 5298: }
1.795 www 5299:
1.425 albertel 5300: table.LC_data_table tr.LC_data_table_highlight td {
5301: background-color: $data_table_darker;
5302: }
1.795 www 5303:
1.639 raeburn 5304: table.LC_data_table tr td.LC_leftcol_header {
5305: background-color: $data_table_head;
5306: font-weight: bold;
5307: }
1.795 www 5308:
1.451 albertel 5309: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5310: table.LC_nested tr.LC_empty_row td {
1.421 albertel 5311: font-weight: bold;
5312: font-style: italic;
5313: text-align: center;
5314: padding: 8px;
1.347 albertel 5315: }
1.795 www 5316:
1.940 bisitz 5317: table.LC_data_table tr.LC_empty_row td {
5318: background-color: $sidebg;
5319: }
5320:
5321: table.LC_nested tr.LC_empty_row td {
5322: background-color: #FFFFFF;
5323: }
5324:
1.890 droeschl 5325: table.LC_caption {
5326: }
5327:
1.507 raeburn 5328: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5329: padding: 4ex
5330: }
1.795 www 5331:
1.507 raeburn 5332: table.LC_nested_outer tr th {
5333: font-weight: bold;
1.801 tempelho 5334: color:$fontmenu;
1.507 raeburn 5335: background-color: $data_table_head;
1.701 harmsja 5336: font-size: small;
1.507 raeburn 5337: border-bottom: 1px solid #000000;
5338: }
1.795 www 5339:
1.507 raeburn 5340: table.LC_nested_outer tr td.LC_subheader {
5341: background-color: $data_table_head;
5342: font-weight: bold;
5343: font-size: small;
5344: border-bottom: 1px solid #000000;
5345: text-align: right;
1.451 albertel 5346: }
1.795 www 5347:
1.507 raeburn 5348: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5349: background-color: #CCCCCC;
1.451 albertel 5350: font-weight: bold;
5351: font-size: small;
1.507 raeburn 5352: text-align: center;
5353: }
1.795 www 5354:
1.589 raeburn 5355: table.LC_nested tr.LC_info_row td.LC_left_item,
5356: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5357: text-align: left;
1.451 albertel 5358: }
1.795 www 5359:
1.507 raeburn 5360: table.LC_nested td {
1.735 bisitz 5361: background-color: #FFFFFF;
1.451 albertel 5362: font-size: small;
1.507 raeburn 5363: }
1.795 www 5364:
1.507 raeburn 5365: table.LC_nested_outer tr th.LC_right_item,
5366: table.LC_nested tr.LC_info_row td.LC_right_item,
5367: table.LC_nested tr.LC_odd_row td.LC_right_item,
5368: table.LC_nested tr td.LC_right_item {
1.451 albertel 5369: text-align: right;
5370: }
5371:
1.507 raeburn 5372: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5373: background-color: #EEEEEE;
1.451 albertel 5374: }
5375:
1.473 raeburn 5376: table.LC_createuser {
5377: }
5378:
5379: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5380: font-size: small;
1.473 raeburn 5381: }
5382:
5383: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5384: background-color: #CCCCCC;
1.473 raeburn 5385: font-weight: bold;
5386: text-align: center;
5387: }
5388:
1.349 albertel 5389: table.LC_calendar {
5390: border: 1px solid #000000;
5391: border-collapse: collapse;
1.917 raeburn 5392: width: 98%;
1.349 albertel 5393: }
1.795 www 5394:
1.349 albertel 5395: table.LC_calendar_pickdate {
5396: font-size: xx-small;
5397: }
1.795 www 5398:
1.349 albertel 5399: table.LC_calendar tr td {
5400: border: 1px solid #000000;
5401: vertical-align: top;
1.917 raeburn 5402: width: 14%;
1.349 albertel 5403: }
1.795 www 5404:
1.349 albertel 5405: table.LC_calendar tr td.LC_calendar_day_empty {
5406: background-color: $data_table_dark;
5407: }
1.795 www 5408:
1.779 bisitz 5409: table.LC_calendar tr td.LC_calendar_day_current {
5410: background-color: $data_table_highlight;
1.777 tempelho 5411: }
1.795 www 5412:
1.938 bisitz 5413: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 5414: background-color: $mail_new;
5415: }
1.795 www 5416:
1.938 bisitz 5417: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 5418: background-color: $mail_new_hover;
5419: }
1.795 www 5420:
1.938 bisitz 5421: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 5422: background-color: $mail_read;
5423: }
1.795 www 5424:
1.938 bisitz 5425: /*
5426: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 5427: background-color: $mail_read_hover;
5428: }
1.938 bisitz 5429: */
1.795 www 5430:
1.938 bisitz 5431: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 5432: background-color: $mail_replied;
5433: }
1.795 www 5434:
1.938 bisitz 5435: /*
5436: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 5437: background-color: $mail_replied_hover;
5438: }
1.938 bisitz 5439: */
1.795 www 5440:
1.938 bisitz 5441: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 5442: background-color: $mail_other;
5443: }
1.795 www 5444:
1.938 bisitz 5445: /*
5446: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 5447: background-color: $mail_other_hover;
5448: }
1.938 bisitz 5449: */
1.494 raeburn 5450:
1.777 tempelho 5451: table.LC_data_table tr > td.LC_browser_file,
5452: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 5453: background: #AAEE77;
1.389 albertel 5454: }
1.795 www 5455:
1.777 tempelho 5456: table.LC_data_table tr > td.LC_browser_file_locked,
5457: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5458: background: #FFAA99;
1.387 albertel 5459: }
1.795 www 5460:
1.777 tempelho 5461: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 5462: background: #888888;
1.779 bisitz 5463: }
1.795 www 5464:
1.777 tempelho 5465: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5466: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 5467: background: #F8F866;
1.777 tempelho 5468: }
1.795 www 5469:
1.696 bisitz 5470: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 5471: background: #E0E8FF;
1.387 albertel 5472: }
1.696 bisitz 5473:
1.707 bisitz 5474: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 5475: /* background: #77FF77; */
1.707 bisitz 5476: }
1.795 www 5477:
1.707 bisitz 5478: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 5479: border-right: 8px solid #FFFF77;
1.707 bisitz 5480: }
1.795 www 5481:
1.707 bisitz 5482: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 5483: border-right: 8px solid #FFAA77;
1.707 bisitz 5484: }
1.795 www 5485:
1.707 bisitz 5486: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 5487: border-right: 8px solid #FF7777;
1.707 bisitz 5488: }
1.795 www 5489:
1.707 bisitz 5490: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 5491: border-right: 8px solid #AAFF77;
1.707 bisitz 5492: }
1.795 www 5493:
1.707 bisitz 5494: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 5495: border-right: 8px solid #11CC55;
1.707 bisitz 5496: }
5497:
1.388 albertel 5498: span.LC_current_location {
1.701 harmsja 5499: font-size:larger;
1.388 albertel 5500: background: $pgbg;
5501: }
1.387 albertel 5502:
1.395 albertel 5503: span.LC_parm_menu_item {
5504: font-size: larger;
5505: }
1.795 www 5506:
1.395 albertel 5507: span.LC_parm_scope_all {
5508: color: red;
5509: }
1.795 www 5510:
1.395 albertel 5511: span.LC_parm_scope_folder {
5512: color: green;
5513: }
1.795 www 5514:
1.395 albertel 5515: span.LC_parm_scope_resource {
5516: color: orange;
5517: }
1.795 www 5518:
1.395 albertel 5519: span.LC_parm_part {
5520: color: blue;
5521: }
1.795 www 5522:
1.911 bisitz 5523: span.LC_parm_folder,
5524: span.LC_parm_symb {
1.395 albertel 5525: font-size: x-small;
5526: font-family: $mono;
5527: color: #AAAAAA;
5528: }
5529:
1.977 bisitz 5530: ul.LC_parm_parmlist li {
5531: display: inline-block;
5532: padding: 0.3em 0.8em;
5533: vertical-align: top;
5534: width: 150px;
5535: border-top:1px solid $lg_border_color;
5536: }
5537:
1.795 www 5538: td.LC_parm_overview_level_menu,
5539: td.LC_parm_overview_map_menu,
5540: td.LC_parm_overview_parm_selectors,
5541: td.LC_parm_overview_restrictions {
1.396 albertel 5542: border: 1px solid black;
5543: border-collapse: collapse;
5544: }
1.795 www 5545:
1.396 albertel 5546: table.LC_parm_overview_restrictions td {
5547: border-width: 1px 4px 1px 4px;
5548: border-style: solid;
5549: border-color: $pgbg;
5550: text-align: center;
5551: }
1.795 www 5552:
1.396 albertel 5553: table.LC_parm_overview_restrictions th {
5554: background: $tabbg;
5555: border-width: 1px 4px 1px 4px;
5556: border-style: solid;
5557: border-color: $pgbg;
5558: }
1.795 www 5559:
1.398 albertel 5560: table#LC_helpmenu {
1.803 bisitz 5561: border: none;
1.398 albertel 5562: height: 55px;
1.803 bisitz 5563: border-spacing: 0;
1.398 albertel 5564: }
5565:
5566: table#LC_helpmenu fieldset legend {
5567: font-size: larger;
5568: }
1.795 www 5569:
1.397 albertel 5570: table#LC_helpmenu_links {
5571: width: 100%;
5572: border: 1px solid black;
5573: background: $pgbg;
1.803 bisitz 5574: padding: 0;
1.397 albertel 5575: border-spacing: 1px;
5576: }
1.795 www 5577:
1.397 albertel 5578: table#LC_helpmenu_links tr td {
5579: padding: 1px;
5580: background: $tabbg;
1.399 albertel 5581: text-align: center;
5582: font-weight: bold;
1.397 albertel 5583: }
1.396 albertel 5584:
1.795 www 5585: table#LC_helpmenu_links a:link,
5586: table#LC_helpmenu_links a:visited,
1.397 albertel 5587: table#LC_helpmenu_links a:active {
5588: text-decoration: none;
5589: color: $font;
5590: }
1.795 www 5591:
1.397 albertel 5592: table#LC_helpmenu_links a:hover {
5593: text-decoration: underline;
5594: color: $vlink;
5595: }
1.396 albertel 5596:
1.417 albertel 5597: .LC_chrt_popup_exists {
5598: border: 1px solid #339933;
5599: margin: -1px;
5600: }
1.795 www 5601:
1.417 albertel 5602: .LC_chrt_popup_up {
5603: border: 1px solid yellow;
5604: margin: -1px;
5605: }
1.795 www 5606:
1.417 albertel 5607: .LC_chrt_popup {
5608: border: 1px solid #8888FF;
5609: background: #CCCCFF;
5610: }
1.795 www 5611:
1.421 albertel 5612: table.LC_pick_box {
5613: border-collapse: separate;
5614: background: white;
5615: border: 1px solid black;
5616: border-spacing: 1px;
5617: }
1.795 www 5618:
1.421 albertel 5619: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 5620: background: $sidebg;
1.421 albertel 5621: font-weight: bold;
1.900 bisitz 5622: text-align: left;
1.740 bisitz 5623: vertical-align: top;
1.421 albertel 5624: width: 184px;
5625: padding: 8px;
5626: }
1.795 www 5627:
1.579 raeburn 5628: table.LC_pick_box td.LC_pick_box_value {
5629: text-align: left;
5630: padding: 8px;
5631: }
1.795 www 5632:
1.579 raeburn 5633: table.LC_pick_box td.LC_pick_box_select {
5634: text-align: left;
5635: padding: 8px;
5636: }
1.795 www 5637:
1.424 albertel 5638: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 5639: padding: 0;
1.421 albertel 5640: height: 1px;
5641: background: black;
5642: }
1.795 www 5643:
1.421 albertel 5644: table.LC_pick_box td.LC_pick_box_submit {
5645: text-align: right;
5646: }
1.795 www 5647:
1.579 raeburn 5648: table.LC_pick_box td.LC_evenrow_value {
5649: text-align: left;
5650: padding: 8px;
5651: background-color: $data_table_light;
5652: }
1.795 www 5653:
1.579 raeburn 5654: table.LC_pick_box td.LC_oddrow_value {
5655: text-align: left;
5656: padding: 8px;
5657: background-color: $data_table_light;
5658: }
1.795 www 5659:
1.579 raeburn 5660: span.LC_helpform_receipt_cat {
5661: font-weight: bold;
5662: }
1.795 www 5663:
1.424 albertel 5664: table.LC_group_priv_box {
5665: background: white;
5666: border: 1px solid black;
5667: border-spacing: 1px;
5668: }
1.795 www 5669:
1.424 albertel 5670: table.LC_group_priv_box td.LC_pick_box_title {
5671: background: $tabbg;
5672: font-weight: bold;
5673: text-align: right;
5674: width: 184px;
5675: }
1.795 www 5676:
1.424 albertel 5677: table.LC_group_priv_box td.LC_groups_fixed {
5678: background: $data_table_light;
5679: text-align: center;
5680: }
1.795 www 5681:
1.424 albertel 5682: table.LC_group_priv_box td.LC_groups_optional {
5683: background: $data_table_dark;
5684: text-align: center;
5685: }
1.795 www 5686:
1.424 albertel 5687: table.LC_group_priv_box td.LC_groups_functionality {
5688: background: $data_table_darker;
5689: text-align: center;
5690: font-weight: bold;
5691: }
1.795 www 5692:
1.424 albertel 5693: table.LC_group_priv td {
5694: text-align: left;
1.803 bisitz 5695: padding: 0;
1.424 albertel 5696: }
5697:
5698: .LC_navbuttons {
5699: margin: 2ex 0ex 2ex 0ex;
5700: }
1.795 www 5701:
1.423 albertel 5702: .LC_topic_bar {
5703: font-weight: bold;
5704: background: $tabbg;
1.918 wenzelju 5705: margin: 1em 0em 1em 2em;
1.805 bisitz 5706: padding: 3px;
1.918 wenzelju 5707: font-size: 1.2em;
1.423 albertel 5708: }
1.795 www 5709:
1.423 albertel 5710: .LC_topic_bar span {
1.918 wenzelju 5711: left: 0.5em;
5712: position: absolute;
1.423 albertel 5713: vertical-align: middle;
1.918 wenzelju 5714: font-size: 1.2em;
1.423 albertel 5715: }
1.795 www 5716:
1.423 albertel 5717: table.LC_course_group_status {
5718: margin: 20px;
5719: }
1.795 www 5720:
1.423 albertel 5721: table.LC_status_selector td {
5722: vertical-align: top;
5723: text-align: center;
1.424 albertel 5724: padding: 4px;
5725: }
1.795 www 5726:
1.599 albertel 5727: div.LC_feedback_link {
1.616 albertel 5728: clear: both;
1.829 kalberla 5729: background: $sidebg;
1.779 bisitz 5730: width: 100%;
1.829 kalberla 5731: padding-bottom: 10px;
5732: border: 1px $tabbg solid;
1.833 kalberla 5733: height: 22px;
5734: line-height: 22px;
5735: padding-top: 5px;
5736: }
5737:
5738: div.LC_feedback_link img {
5739: height: 22px;
1.867 kalberla 5740: vertical-align:middle;
1.829 kalberla 5741: }
5742:
1.911 bisitz 5743: div.LC_feedback_link a {
1.829 kalberla 5744: text-decoration: none;
1.489 raeburn 5745: }
1.795 www 5746:
1.867 kalberla 5747: div.LC_comblock {
1.911 bisitz 5748: display:inline;
1.867 kalberla 5749: color:$font;
5750: font-size:90%;
5751: }
5752:
5753: div.LC_feedback_link div.LC_comblock {
5754: padding-left:5px;
5755: }
5756:
5757: div.LC_feedback_link div.LC_comblock a {
5758: color:$font;
5759: }
5760:
1.489 raeburn 5761: span.LC_feedback_link {
1.858 bisitz 5762: /* background: $feedback_link_bg; */
1.599 albertel 5763: font-size: larger;
5764: }
1.795 www 5765:
1.599 albertel 5766: span.LC_message_link {
1.858 bisitz 5767: /* background: $feedback_link_bg; */
1.599 albertel 5768: font-size: larger;
5769: position: absolute;
5770: right: 1em;
1.489 raeburn 5771: }
1.421 albertel 5772:
1.515 albertel 5773: table.LC_prior_tries {
1.524 albertel 5774: border: 1px solid #000000;
5775: border-collapse: separate;
5776: border-spacing: 1px;
1.515 albertel 5777: }
1.523 albertel 5778:
1.515 albertel 5779: table.LC_prior_tries td {
1.524 albertel 5780: padding: 2px;
1.515 albertel 5781: }
1.523 albertel 5782:
5783: .LC_answer_correct {
1.795 www 5784: background: lightgreen;
5785: color: darkgreen;
5786: padding: 6px;
1.523 albertel 5787: }
1.795 www 5788:
1.523 albertel 5789: .LC_answer_charged_try {
1.797 www 5790: background: #FFAAAA;
1.795 www 5791: color: darkred;
5792: padding: 6px;
1.523 albertel 5793: }
1.795 www 5794:
1.779 bisitz 5795: .LC_answer_not_charged_try,
1.523 albertel 5796: .LC_answer_no_grade,
5797: .LC_answer_late {
1.795 www 5798: background: lightyellow;
1.523 albertel 5799: color: black;
1.795 www 5800: padding: 6px;
1.523 albertel 5801: }
1.795 www 5802:
1.523 albertel 5803: .LC_answer_previous {
1.795 www 5804: background: lightblue;
5805: color: darkblue;
5806: padding: 6px;
1.523 albertel 5807: }
1.795 www 5808:
1.779 bisitz 5809: .LC_answer_no_message {
1.777 tempelho 5810: background: #FFFFFF;
5811: color: black;
1.795 www 5812: padding: 6px;
1.779 bisitz 5813: }
1.795 www 5814:
1.779 bisitz 5815: .LC_answer_unknown {
5816: background: orange;
5817: color: black;
1.795 www 5818: padding: 6px;
1.777 tempelho 5819: }
1.795 www 5820:
1.529 albertel 5821: span.LC_prior_numerical,
5822: span.LC_prior_string,
5823: span.LC_prior_custom,
5824: span.LC_prior_reaction,
5825: span.LC_prior_math {
1.925 bisitz 5826: font-family: $mono;
1.523 albertel 5827: white-space: pre;
5828: }
5829:
1.525 albertel 5830: span.LC_prior_string {
1.925 bisitz 5831: font-family: $mono;
1.525 albertel 5832: white-space: pre;
5833: }
5834:
1.523 albertel 5835: table.LC_prior_option {
5836: width: 100%;
5837: border-collapse: collapse;
5838: }
1.795 www 5839:
1.911 bisitz 5840: table.LC_prior_rank,
1.795 www 5841: table.LC_prior_match {
1.528 albertel 5842: border-collapse: collapse;
5843: }
1.795 www 5844:
1.528 albertel 5845: table.LC_prior_option tr td,
5846: table.LC_prior_rank tr td,
5847: table.LC_prior_match tr td {
1.524 albertel 5848: border: 1px solid #000000;
1.515 albertel 5849: }
5850:
1.855 bisitz 5851: .LC_nobreak {
1.544 albertel 5852: white-space: nowrap;
1.519 raeburn 5853: }
5854:
1.576 raeburn 5855: span.LC_cusr_emph {
5856: font-style: italic;
5857: }
5858:
1.633 raeburn 5859: span.LC_cusr_subheading {
5860: font-weight: normal;
5861: font-size: 85%;
5862: }
5863:
1.861 bisitz 5864: div.LC_docs_entry_move {
1.859 bisitz 5865: border: 1px solid #BBBBBB;
1.545 albertel 5866: background: #DDDDDD;
1.861 bisitz 5867: width: 22px;
1.859 bisitz 5868: padding: 1px;
5869: margin: 0;
1.545 albertel 5870: }
5871:
1.861 bisitz 5872: table.LC_data_table tr > td.LC_docs_entry_commands,
5873: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 5874: background: #DDDDDD;
5875: font-size: x-small;
5876: }
1.795 www 5877:
1.861 bisitz 5878: .LC_docs_entry_parameter {
5879: white-space: nowrap;
5880: }
5881:
1.544 albertel 5882: .LC_docs_copy {
1.545 albertel 5883: color: #000099;
1.544 albertel 5884: }
1.795 www 5885:
1.544 albertel 5886: .LC_docs_cut {
1.545 albertel 5887: color: #550044;
1.544 albertel 5888: }
1.795 www 5889:
1.544 albertel 5890: .LC_docs_rename {
1.545 albertel 5891: color: #009900;
1.544 albertel 5892: }
1.795 www 5893:
1.544 albertel 5894: .LC_docs_remove {
1.545 albertel 5895: color: #990000;
5896: }
5897:
1.547 albertel 5898: .LC_docs_reinit_warn,
5899: .LC_docs_ext_edit {
5900: font-size: x-small;
5901: }
5902:
1.545 albertel 5903: table.LC_docs_adddocs td,
5904: table.LC_docs_adddocs th {
5905: border: 1px solid #BBBBBB;
5906: padding: 4px;
5907: background: #DDDDDD;
1.543 albertel 5908: }
5909:
1.584 albertel 5910: table.LC_sty_begin {
5911: background: #BBFFBB;
5912: }
1.795 www 5913:
1.584 albertel 5914: table.LC_sty_end {
5915: background: #FFBBBB;
5916: }
5917:
1.589 raeburn 5918: table.LC_double_column {
1.803 bisitz 5919: border-width: 0;
1.589 raeburn 5920: border-collapse: collapse;
5921: width: 100%;
5922: padding: 2px;
5923: }
5924:
5925: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5926: top: 2px;
1.589 raeburn 5927: left: 2px;
5928: width: 47%;
5929: vertical-align: top;
5930: }
5931:
5932: table.LC_double_column tr td.LC_right_col {
5933: top: 2px;
1.779 bisitz 5934: right: 2px;
1.589 raeburn 5935: width: 47%;
5936: vertical-align: top;
5937: }
5938:
1.591 raeburn 5939: div.LC_left_float {
5940: float: left;
5941: padding-right: 5%;
1.597 albertel 5942: padding-bottom: 4px;
1.591 raeburn 5943: }
5944:
5945: div.LC_clear_float_header {
1.597 albertel 5946: padding-bottom: 2px;
1.591 raeburn 5947: }
5948:
5949: div.LC_clear_float_footer {
1.597 albertel 5950: padding-top: 10px;
1.591 raeburn 5951: clear: both;
5952: }
5953:
1.597 albertel 5954: div.LC_grade_show_user {
1.941 bisitz 5955: /* border-left: 5px solid $sidebg; */
5956: border-top: 5px solid #000000;
5957: margin: 50px 0 0 0;
1.936 bisitz 5958: padding: 15px 0 5px 10px;
1.597 albertel 5959: }
1.795 www 5960:
1.936 bisitz 5961: div.LC_grade_show_user_odd_row {
1.941 bisitz 5962: /* border-left: 5px solid #000000; */
5963: }
5964:
5965: div.LC_grade_show_user div.LC_Box {
5966: margin-right: 50px;
1.597 albertel 5967: }
5968:
5969: div.LC_grade_submissions,
5970: div.LC_grade_message_center,
1.936 bisitz 5971: div.LC_grade_info_links {
1.597 albertel 5972: margin: 5px;
5973: width: 99%;
5974: background: #FFFFFF;
5975: }
1.795 www 5976:
1.597 albertel 5977: div.LC_grade_submissions_header,
1.936 bisitz 5978: div.LC_grade_message_center_header {
1.705 tempelho 5979: font-weight: bold;
5980: font-size: large;
1.597 albertel 5981: }
1.795 www 5982:
1.597 albertel 5983: div.LC_grade_submissions_body,
1.936 bisitz 5984: div.LC_grade_message_center_body {
1.597 albertel 5985: border: 1px solid black;
5986: width: 99%;
5987: background: #FFFFFF;
5988: }
1.795 www 5989:
1.613 albertel 5990: table.LC_scantron_action {
5991: width: 100%;
5992: }
1.795 www 5993:
1.613 albertel 5994: table.LC_scantron_action tr th {
1.698 harmsja 5995: font-weight:bold;
5996: font-style:normal;
1.613 albertel 5997: }
1.795 www 5998:
1.779 bisitz 5999: .LC_edit_problem_header,
1.614 albertel 6000: div.LC_edit_problem_footer {
1.705 tempelho 6001: font-weight: normal;
6002: font-size: medium;
1.602 albertel 6003: margin: 2px;
1.600 albertel 6004: }
1.795 www 6005:
1.600 albertel 6006: div.LC_edit_problem_header,
1.602 albertel 6007: div.LC_edit_problem_header div,
1.614 albertel 6008: div.LC_edit_problem_footer,
6009: div.LC_edit_problem_footer div,
1.602 albertel 6010: div.LC_edit_problem_editxml_header,
6011: div.LC_edit_problem_editxml_header div {
1.600 albertel 6012: margin-top: 5px;
6013: }
1.795 www 6014:
1.600 albertel 6015: div.LC_edit_problem_header_title {
1.705 tempelho 6016: font-weight: bold;
6017: font-size: larger;
1.602 albertel 6018: background: $tabbg;
6019: padding: 3px;
6020: }
1.795 www 6021:
1.602 albertel 6022: table.LC_edit_problem_header_title {
6023: width: 100%;
1.600 albertel 6024: background: $tabbg;
1.602 albertel 6025: }
6026:
6027: div.LC_edit_problem_discards {
6028: float: left;
6029: padding-bottom: 5px;
6030: }
1.795 www 6031:
1.602 albertel 6032: div.LC_edit_problem_saves {
6033: float: right;
6034: padding-bottom: 5px;
1.600 albertel 6035: }
1.795 www 6036:
1.911 bisitz 6037: img.stift {
1.803 bisitz 6038: border-width: 0;
6039: vertical-align: middle;
1.677 riegler 6040: }
1.680 riegler 6041:
1.923 bisitz 6042: table td.LC_mainmenu_col_fieldset {
1.680 riegler 6043: vertical-align: top;
1.777 tempelho 6044: }
1.795 www 6045:
1.716 raeburn 6046: div.LC_createcourse {
1.911 bisitz 6047: margin: 10px 10px 10px 10px;
1.716 raeburn 6048: }
6049:
1.917 raeburn 6050: .LC_dccid {
6051: margin: 0.2em 0 0 0;
6052: padding: 0;
6053: font-size: 90%;
6054: display:none;
6055: }
6056:
1.698 harmsja 6057: a:hover,
1.897 wenzelju 6058: ol.LC_primary_menu a:hover,
1.721 harmsja 6059: ol#LC_MenuBreadcrumbs a:hover,
6060: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 6061: ul#LC_secondary_menu a:hover,
1.721 harmsja 6062: .LC_FormSectionClearButton input:hover
1.795 www 6063: ul.LC_TabContent li:hover a {
1.952 onken 6064: color:$button_hover;
1.911 bisitz 6065: text-decoration:none;
1.693 droeschl 6066: }
6067:
1.779 bisitz 6068: h1 {
1.911 bisitz 6069: padding: 0;
6070: line-height:130%;
1.693 droeschl 6071: }
1.698 harmsja 6072:
1.911 bisitz 6073: h2,
6074: h3,
6075: h4,
6076: h5,
6077: h6 {
6078: margin: 5px 0 5px 0;
6079: padding: 0;
6080: line-height:130%;
1.693 droeschl 6081: }
1.795 www 6082:
6083: .LC_hcell {
1.911 bisitz 6084: padding:3px 15px 3px 15px;
6085: margin: 0;
6086: background-color:$tabbg;
6087: color:$fontmenu;
6088: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 6089: }
1.795 www 6090:
1.840 bisitz 6091: .LC_Box > .LC_hcell {
1.911 bisitz 6092: margin: 0 -10px 10px -10px;
1.835 bisitz 6093: }
6094:
1.721 harmsja 6095: .LC_noBorder {
1.911 bisitz 6096: border: 0;
1.698 harmsja 6097: }
1.693 droeschl 6098:
1.721 harmsja 6099: .LC_FormSectionClearButton input {
1.911 bisitz 6100: background-color:transparent;
6101: border: none;
6102: cursor:pointer;
6103: text-decoration:underline;
1.693 droeschl 6104: }
1.763 bisitz 6105:
6106: .LC_help_open_topic {
1.911 bisitz 6107: color: #FFFFFF;
6108: background-color: #EEEEFF;
6109: margin: 1px;
6110: padding: 4px;
6111: border: 1px solid #000033;
6112: white-space: nowrap;
6113: /* vertical-align: middle; */
1.759 neumanie 6114: }
1.693 droeschl 6115:
1.911 bisitz 6116: dl,
6117: ul,
6118: div,
6119: fieldset {
6120: margin: 10px 10px 10px 0;
6121: /* overflow: hidden; */
1.693 droeschl 6122: }
1.795 www 6123:
1.838 bisitz 6124: fieldset > legend {
1.911 bisitz 6125: font-weight: bold;
6126: padding: 0 5px 0 5px;
1.838 bisitz 6127: }
6128:
1.813 bisitz 6129: #LC_nav_bar {
1.911 bisitz 6130: float: left;
1.995 raeburn 6131: background-color: $pgbg_or_bgcolor;
1.966 bisitz 6132: margin: 0 0 2px 0;
1.807 droeschl 6133: }
6134:
1.916 droeschl 6135: #LC_realm {
6136: margin: 0.2em 0 0 0;
6137: padding: 0;
6138: font-weight: bold;
6139: text-align: center;
1.995 raeburn 6140: background-color: $pgbg_or_bgcolor;
1.916 droeschl 6141: }
6142:
1.911 bisitz 6143: #LC_nav_bar em {
6144: font-weight: bold;
6145: font-style: normal;
1.807 droeschl 6146: }
6147:
1.897 wenzelju 6148: ol.LC_primary_menu {
1.911 bisitz 6149: float: right;
1.934 droeschl 6150: margin: 0;
1.995 raeburn 6151: background-color: $pgbg_or_bgcolor;
1.807 droeschl 6152: }
6153:
1.852 droeschl 6154: ol#LC_PathBreadcrumbs {
1.911 bisitz 6155: margin: 0;
1.693 droeschl 6156: }
6157:
1.897 wenzelju 6158: ol.LC_primary_menu li {
1.911 bisitz 6159: display: inline;
6160: padding: 5px 5px 0 10px;
6161: vertical-align: top;
1.693 droeschl 6162: }
6163:
1.897 wenzelju 6164: ol.LC_primary_menu li img {
1.911 bisitz 6165: vertical-align: bottom;
1.934 droeschl 6166: height: 1.1em;
1.693 droeschl 6167: }
6168:
1.897 wenzelju 6169: ol.LC_primary_menu a {
1.911 bisitz 6170: color: RGB(80, 80, 80);
6171: text-decoration: none;
1.693 droeschl 6172: }
1.795 www 6173:
1.949 droeschl 6174: ol.LC_primary_menu a.LC_new_message {
6175: font-weight:bold;
6176: color: darkred;
6177: }
6178:
1.975 raeburn 6179: ol.LC_docs_parameters {
6180: margin-left: 0;
6181: padding: 0;
6182: list-style: none;
6183: }
6184:
6185: ol.LC_docs_parameters li {
6186: margin: 0;
6187: padding-right: 20px;
6188: display: inline;
6189: }
6190:
1.976 raeburn 6191: ol.LC_docs_parameters li:before {
6192: content: "\\002022 \\0020";
6193: }
6194:
6195: li.LC_docs_parameters_title {
6196: font-weight: bold;
6197: }
6198:
6199: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
6200: content: "";
6201: }
6202:
1.897 wenzelju 6203: ul#LC_secondary_menu {
1.911 bisitz 6204: clear: both;
6205: color: $fontmenu;
6206: background: $tabbg;
6207: list-style: none;
6208: padding: 0;
6209: margin: 0;
6210: width: 100%;
1.995 raeburn 6211: text-align: left;
1.808 droeschl 6212: }
6213:
1.897 wenzelju 6214: ul#LC_secondary_menu li {
1.911 bisitz 6215: font-weight: bold;
6216: line-height: 1.8em;
6217: padding: 0 0.8em;
6218: border-right: 1px solid black;
6219: display: inline;
6220: vertical-align: middle;
1.807 droeschl 6221: }
6222:
1.847 tempelho 6223: ul.LC_TabContent {
1.911 bisitz 6224: display:block;
6225: background: $sidebg;
6226: border-bottom: solid 1px $lg_border_color;
6227: list-style:none;
6228: margin: 0 -10px;
6229: padding: 0;
1.693 droeschl 6230: }
6231:
1.795 www 6232: ul.LC_TabContent li,
6233: ul.LC_TabContentBigger li {
1.911 bisitz 6234: float:left;
1.741 harmsja 6235: }
1.795 www 6236:
1.897 wenzelju 6237: ul#LC_secondary_menu li a {
1.911 bisitz 6238: color: $fontmenu;
6239: text-decoration: none;
1.693 droeschl 6240: }
1.795 www 6241:
1.721 harmsja 6242: ul.LC_TabContent {
1.952 onken 6243: min-height:20px;
1.721 harmsja 6244: }
1.795 www 6245:
6246: ul.LC_TabContent li {
1.911 bisitz 6247: vertical-align:middle;
1.959 onken 6248: padding: 0 16px 0 10px;
1.911 bisitz 6249: background-color:$tabbg;
6250: border-bottom:solid 1px $lg_border_color;
1.952 onken 6251: border-right: solid 1px $font;
1.721 harmsja 6252: }
1.795 www 6253:
1.847 tempelho 6254: ul.LC_TabContent .right {
1.911 bisitz 6255: float:right;
1.847 tempelho 6256: }
6257:
1.911 bisitz 6258: ul.LC_TabContent li a,
6259: ul.LC_TabContent li {
6260: color:rgb(47,47,47);
6261: text-decoration:none;
6262: font-size:95%;
6263: font-weight:bold;
1.952 onken 6264: min-height:20px;
6265: }
6266:
1.959 onken 6267: ul.LC_TabContent li a:hover,
6268: ul.LC_TabContent li a:focus {
1.952 onken 6269: color: $button_hover;
1.959 onken 6270: background:none;
6271: outline:none;
1.952 onken 6272: }
6273:
6274: ul.LC_TabContent li:hover {
6275: color: $button_hover;
6276: cursor:pointer;
1.721 harmsja 6277: }
1.795 www 6278:
1.911 bisitz 6279: ul.LC_TabContent li.active {
1.952 onken 6280: color: $font;
1.911 bisitz 6281: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 6282: border-bottom:solid 1px #FFFFFF;
6283: cursor: default;
1.744 ehlerst 6284: }
1.795 www 6285:
1.959 onken 6286: ul.LC_TabContent li.active a {
6287: color:$font;
6288: background:#FFFFFF;
6289: outline: none;
6290: }
1.870 tempelho 6291: #maincoursedoc {
1.911 bisitz 6292: clear:both;
1.870 tempelho 6293: }
6294:
6295: ul.LC_TabContentBigger {
1.911 bisitz 6296: display:block;
6297: list-style:none;
6298: padding: 0;
1.870 tempelho 6299: }
6300:
1.795 www 6301: ul.LC_TabContentBigger li {
1.911 bisitz 6302: vertical-align:bottom;
6303: height: 30px;
6304: font-size:110%;
6305: font-weight:bold;
6306: color: #737373;
1.841 tempelho 6307: }
6308:
1.957 onken 6309: ul.LC_TabContentBigger li.active {
6310: position: relative;
6311: top: 1px;
6312: }
6313:
1.870 tempelho 6314: ul.LC_TabContentBigger li a {
1.911 bisitz 6315: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6316: height: 30px;
6317: line-height: 30px;
6318: text-align: center;
6319: display: block;
6320: text-decoration: none;
1.958 onken 6321: outline: none;
1.741 harmsja 6322: }
1.795 www 6323:
1.870 tempelho 6324: ul.LC_TabContentBigger li.active a {
1.911 bisitz 6325: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6326: color:$font;
1.744 ehlerst 6327: }
1.795 www 6328:
1.870 tempelho 6329: ul.LC_TabContentBigger li b {
1.911 bisitz 6330: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
6331: display: block;
6332: float: left;
6333: padding: 0 30px;
1.957 onken 6334: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 6335: }
6336:
1.956 onken 6337: ul.LC_TabContentBigger li:hover b {
6338: color:$button_hover;
6339: }
6340:
1.870 tempelho 6341: ul.LC_TabContentBigger li.active b {
1.911 bisitz 6342: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
6343: color:$font;
1.957 onken 6344: border: 0;
1.741 harmsja 6345: }
1.693 droeschl 6346:
1.870 tempelho 6347:
1.862 bisitz 6348: ul.LC_CourseBreadcrumbs {
6349: background: $sidebg;
6350: line-height: 32px;
6351: padding-left: 10px;
6352: margin: 0 0 10px 0;
6353: list-style-position: inside;
6354:
6355: }
6356:
1.911 bisitz 6357: ol#LC_MenuBreadcrumbs,
1.862 bisitz 6358: ol#LC_PathBreadcrumbs {
1.911 bisitz 6359: padding-left: 10px;
6360: margin: 0;
1.933 droeschl 6361: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 6362: }
6363:
1.911 bisitz 6364: ol#LC_MenuBreadcrumbs li,
6365: ol#LC_PathBreadcrumbs li,
1.862 bisitz 6366: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 6367: display: inline;
1.933 droeschl 6368: white-space: normal;
1.693 droeschl 6369: }
6370:
1.823 bisitz 6371: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 6372: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 6373: text-decoration: none;
6374: font-size:90%;
1.693 droeschl 6375: }
1.795 www 6376:
1.969 droeschl 6377: ol#LC_MenuBreadcrumbs h1 {
6378: display: inline;
6379: font-size: 90%;
6380: line-height: 2.5em;
6381: margin: 0;
6382: padding: 0;
6383: }
6384:
1.795 www 6385: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 6386: text-decoration:none;
6387: font-size:100%;
6388: font-weight:bold;
1.693 droeschl 6389: }
1.795 www 6390:
1.840 bisitz 6391: .LC_Box {
1.911 bisitz 6392: border: solid 1px $lg_border_color;
6393: padding: 0 10px 10px 10px;
1.746 neumanie 6394: }
1.795 www 6395:
6396: .LC_AboutMe_Image {
1.911 bisitz 6397: float:left;
6398: margin-right:10px;
1.747 neumanie 6399: }
1.795 www 6400:
6401: .LC_Clear_AboutMe_Image {
1.911 bisitz 6402: clear:left;
1.747 neumanie 6403: }
1.795 www 6404:
1.721 harmsja 6405: dl.LC_ListStyleClean dt {
1.911 bisitz 6406: padding-right: 5px;
6407: display: table-header-group;
1.693 droeschl 6408: }
6409:
1.721 harmsja 6410: dl.LC_ListStyleClean dd {
1.911 bisitz 6411: display: table-row;
1.693 droeschl 6412: }
6413:
1.721 harmsja 6414: .LC_ListStyleClean,
6415: .LC_ListStyleSimple,
6416: .LC_ListStyleNormal,
1.795 www 6417: .LC_ListStyleSpecial {
1.911 bisitz 6418: /* display:block; */
6419: list-style-position: inside;
6420: list-style-type: none;
6421: overflow: hidden;
6422: padding: 0;
1.693 droeschl 6423: }
6424:
1.721 harmsja 6425: .LC_ListStyleSimple li,
6426: .LC_ListStyleSimple dd,
6427: .LC_ListStyleNormal li,
6428: .LC_ListStyleNormal dd,
6429: .LC_ListStyleSpecial li,
1.795 www 6430: .LC_ListStyleSpecial dd {
1.911 bisitz 6431: margin: 0;
6432: padding: 5px 5px 5px 10px;
6433: clear: both;
1.693 droeschl 6434: }
6435:
1.721 harmsja 6436: .LC_ListStyleClean li,
6437: .LC_ListStyleClean dd {
1.911 bisitz 6438: padding-top: 0;
6439: padding-bottom: 0;
1.693 droeschl 6440: }
6441:
1.721 harmsja 6442: .LC_ListStyleSimple dd,
1.795 www 6443: .LC_ListStyleSimple li {
1.911 bisitz 6444: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6445: }
6446:
1.721 harmsja 6447: .LC_ListStyleSpecial li,
6448: .LC_ListStyleSpecial dd {
1.911 bisitz 6449: list-style-type: none;
6450: background-color: RGB(220, 220, 220);
6451: margin-bottom: 4px;
1.693 droeschl 6452: }
6453:
1.721 harmsja 6454: table.LC_SimpleTable {
1.911 bisitz 6455: margin:5px;
6456: border:solid 1px $lg_border_color;
1.795 www 6457: }
1.693 droeschl 6458:
1.721 harmsja 6459: table.LC_SimpleTable tr {
1.911 bisitz 6460: padding: 0;
6461: border:solid 1px $lg_border_color;
1.693 droeschl 6462: }
1.795 www 6463:
6464: table.LC_SimpleTable thead {
1.911 bisitz 6465: background:rgb(220,220,220);
1.693 droeschl 6466: }
6467:
1.721 harmsja 6468: div.LC_columnSection {
1.911 bisitz 6469: display: block;
6470: clear: both;
6471: overflow: hidden;
6472: margin: 0;
1.693 droeschl 6473: }
6474:
1.721 harmsja 6475: div.LC_columnSection>* {
1.911 bisitz 6476: float: left;
6477: margin: 10px 20px 10px 0;
6478: overflow:hidden;
1.693 droeschl 6479: }
1.721 harmsja 6480:
1.795 www 6481: table em {
1.911 bisitz 6482: font-weight: bold;
6483: font-style: normal;
1.748 schulted 6484: }
1.795 www 6485:
1.779 bisitz 6486: table.LC_tableBrowseRes,
1.795 www 6487: table.LC_tableOfContent {
1.911 bisitz 6488: border:none;
6489: border-spacing: 1px;
6490: padding: 3px;
6491: background-color: #FFFFFF;
6492: font-size: 90%;
1.753 droeschl 6493: }
1.789 droeschl 6494:
1.911 bisitz 6495: table.LC_tableOfContent {
6496: border-collapse: collapse;
1.789 droeschl 6497: }
6498:
1.771 droeschl 6499: table.LC_tableBrowseRes a,
1.768 schulted 6500: table.LC_tableOfContent a {
1.911 bisitz 6501: background-color: transparent;
6502: text-decoration: none;
1.753 droeschl 6503: }
6504:
1.795 www 6505: table.LC_tableOfContent img {
1.911 bisitz 6506: border: none;
6507: height: 1.3em;
6508: vertical-align: text-bottom;
6509: margin-right: 0.3em;
1.753 droeschl 6510: }
1.757 schulted 6511:
1.795 www 6512: a#LC_content_toolbar_firsthomework {
1.911 bisitz 6513: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 6514: }
6515:
1.795 www 6516: a#LC_content_toolbar_everything {
1.911 bisitz 6517: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 6518: }
6519:
1.795 www 6520: a#LC_content_toolbar_uncompleted {
1.911 bisitz 6521: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 6522: }
6523:
1.795 www 6524: #LC_content_toolbar_clearbubbles {
1.911 bisitz 6525: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 6526: }
6527:
1.795 www 6528: a#LC_content_toolbar_changefolder {
1.911 bisitz 6529: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 6530: }
6531:
1.795 www 6532: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 6533: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 6534: }
6535:
1.795 www 6536: ul#LC_toolbar li a:hover {
1.911 bisitz 6537: background-position: bottom center;
1.757 schulted 6538: }
6539:
1.795 www 6540: ul#LC_toolbar {
1.911 bisitz 6541: padding: 0;
6542: margin: 2px;
6543: list-style:none;
6544: position:relative;
6545: background-color:white;
1.757 schulted 6546: }
6547:
1.795 www 6548: ul#LC_toolbar li {
1.911 bisitz 6549: border:1px solid white;
6550: padding: 0;
6551: margin: 0;
6552: float: left;
6553: display:inline;
6554: vertical-align:middle;
6555: }
1.757 schulted 6556:
1.783 amueller 6557:
1.795 www 6558: a.LC_toolbarItem {
1.911 bisitz 6559: display:block;
6560: padding: 0;
6561: margin: 0;
6562: height: 32px;
6563: width: 32px;
6564: color:white;
6565: border: none;
6566: background-repeat:no-repeat;
6567: background-color:transparent;
1.757 schulted 6568: }
6569:
1.915 droeschl 6570: ul.LC_funclist {
6571: margin: 0;
6572: padding: 0.5em 1em 0.5em 0;
6573: }
6574:
1.933 droeschl 6575: ul.LC_funclist > li:first-child {
6576: font-weight:bold;
6577: margin-left:0.8em;
6578: }
6579:
1.915 droeschl 6580: ul.LC_funclist + ul.LC_funclist {
6581: /*
6582: left border as a seperator if we have more than
6583: one list
6584: */
6585: border-left: 1px solid $sidebg;
6586: /*
6587: this hides the left border behind the border of the
6588: outer box if element is wrapped to the next 'line'
6589: */
6590: margin-left: -1px;
6591: }
6592:
1.843 bisitz 6593: ul.LC_funclist li {
1.915 droeschl 6594: display: inline;
1.782 bisitz 6595: white-space: nowrap;
1.915 droeschl 6596: margin: 0 0 0 25px;
6597: line-height: 150%;
1.782 bisitz 6598: }
6599:
1.974 wenzelju 6600: .LC_hidden {
6601: display: none;
6602: }
6603:
1.343 albertel 6604: END
6605: }
6606:
1.306 albertel 6607: =pod
6608:
6609: =item * &headtag()
6610:
6611: Returns a uniform footer for LON-CAPA web pages.
6612:
1.307 albertel 6613: Inputs: $title - optional title for the head
6614: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 6615: $args - optional arguments
1.319 albertel 6616: force_register - if is true call registerurl so the remote is
6617: informed
1.415 albertel 6618: redirect -> array ref of
6619: 1- seconds before redirect occurs
6620: 2- url to redirect to
6621: 3- whether the side effect should occur
1.315 albertel 6622: (side effect of setting
6623: $env{'internal.head.redirect'} to the url
6624: redirected too)
1.352 albertel 6625: domain -> force to color decorate a page for a specific
6626: domain
6627: function -> force usage of a specific rolish color scheme
6628: bgcolor -> override the default page bgcolor
1.460 albertel 6629: no_auto_mt_title
6630: -> prevent &mt()ing the title arg
1.464 albertel 6631:
1.306 albertel 6632: =cut
6633:
6634: sub headtag {
1.313 albertel 6635: my ($title,$head_extra,$args) = @_;
1.306 albertel 6636:
1.363 albertel 6637: my $function = $args->{'function'} || &get_users_function();
6638: my $domain = $args->{'domain'} || &determinedomain();
6639: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 6640: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 6641: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 6642: #time(),
1.418 albertel 6643: $env{'environment.color.timestamp'},
1.363 albertel 6644: $function,$domain,$bgcolor);
6645:
1.369 www 6646: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 6647:
1.308 albertel 6648: my $result =
6649: '<head>'.
1.461 albertel 6650: &font_settings();
1.319 albertel 6651:
1.461 albertel 6652: if (!$args->{'frameset'}) {
6653: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
6654: }
1.962 droeschl 6655: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
6656: $result .= Apache::lonxml::display_title();
1.319 albertel 6657: }
1.436 albertel 6658: if (!$args->{'no_nav_bar'}
6659: && !$args->{'only_body'}
6660: && !$args->{'frameset'}) {
6661: $result .= &help_menu_js();
6662: }
1.319 albertel 6663:
1.314 albertel 6664: if (ref($args->{'redirect'})) {
1.414 albertel 6665: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 6666: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 6667: if (!$inhibit_continue) {
6668: $env{'internal.head.redirect'} = $url;
6669: }
1.313 albertel 6670: $result.=<<ADDMETA
6671: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 6672: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 6673: ADDMETA
6674: }
1.306 albertel 6675: if (!defined($title)) {
6676: $title = 'The LearningOnline Network with CAPA';
6677: }
1.460 albertel 6678: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
6679: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 6680: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
6681: .$head_extra;
1.962 droeschl 6682: return $result.'</head>';
1.306 albertel 6683: }
6684:
6685: =pod
6686:
1.340 albertel 6687: =item * &font_settings()
6688:
6689: Returns neccessary <meta> to set the proper encoding
6690:
6691: Inputs: none
6692:
6693: =cut
6694:
6695: sub font_settings {
6696: my $headerstring='';
1.647 www 6697: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 6698: $headerstring.=
6699: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
6700: }
6701: return $headerstring;
6702: }
6703:
1.341 albertel 6704: =pod
6705:
6706: =item * &xml_begin()
6707:
6708: Returns the needed doctype and <html>
6709:
6710: Inputs: none
6711:
6712: =cut
6713:
6714: sub xml_begin {
6715: my $output='';
6716:
6717: if ($env{'browser.mathml'}) {
6718: $output='<?xml version="1.0"?>'
6719: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
6720: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
6721:
6722: # .'<!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">] >'
6723: .'<!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">'
6724: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
6725: .'xmlns="http://www.w3.org/1999/xhtml">';
6726: } else {
1.849 bisitz 6727: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
6728: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341 albertel 6729: }
6730: return $output;
6731: }
1.340 albertel 6732:
6733: =pod
6734:
1.306 albertel 6735: =item * &start_page()
6736:
6737: Returns a complete <html> .. <body> section for LON-CAPA web pages.
6738:
1.648 raeburn 6739: Inputs:
6740:
6741: =over 4
6742:
6743: $title - optional title for the page
6744:
6745: $head_extra - optional extra HTML to incude inside the <head>
6746:
6747: $args - additional optional args supported are:
6748:
6749: =over 8
6750:
6751: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 6752: arg on
1.814 bisitz 6753: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 6754: add_entries -> additional attributes to add to the <body>
6755: domain -> force to color decorate a page for a
1.317 albertel 6756: specific domain
1.648 raeburn 6757: function -> force usage of a specific rolish color
1.317 albertel 6758: scheme
1.648 raeburn 6759: redirect -> see &headtag()
6760: bgcolor -> override the default page bg color
6761: js_ready -> return a string ready for being used in
1.317 albertel 6762: a javascript writeln
1.648 raeburn 6763: html_encode -> return a string ready for being used in
1.320 albertel 6764: a html attribute
1.648 raeburn 6765: force_register -> if is true will turn on the &bodytag()
1.317 albertel 6766: $forcereg arg
1.648 raeburn 6767: frameset -> if true will start with a <frameset>
1.330 albertel 6768: rather than <body>
1.648 raeburn 6769: skip_phases -> hash ref of
1.338 albertel 6770: head -> skip the <html><head> generation
6771: body -> skip all <body> generation
1.648 raeburn 6772: no_auto_mt_title -> prevent &mt()ing the title arg
6773: inherit_jsmath -> when creating popup window in a page,
6774: should it have jsmath forced on by the
6775: current page
1.867 kalberla 6776: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 6777: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.361 albertel 6778:
1.648 raeburn 6779: =back
1.460 albertel 6780:
1.648 raeburn 6781: =back
1.562 albertel 6782:
1.306 albertel 6783: =cut
6784:
6785: sub start_page {
1.309 albertel 6786: my ($title,$head_extra,$args) = @_;
1.318 albertel 6787: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.964 droeschl 6788: #SD
6789: #I don't see why we copy certain elements of %$args to %head_args
6790: #head args is passed to headtag() and this routine only reads those
6791: #keys that are needed. There doesn't happen any writes or any processing
6792: #of other keys.
6793: #proposal: just pass $args to headtag instead of \%head_args and delete
6794: #marked lines
6795: #<- MARK
1.313 albertel 6796: my %head_args;
1.352 albertel 6797: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6798: 'bgcolor','frameset','no_nav_bar','only_body',
6799: 'no_auto_mt_title') {
1.319 albertel 6800: if (defined($args->{$arg})) {
1.324 raeburn 6801: $head_args{$arg} = $args->{$arg};
1.319 albertel 6802: }
1.313 albertel 6803: }
1.964 droeschl 6804: #MARK ->
1.319 albertel 6805:
1.315 albertel 6806: $env{'internal.start_page'}++;
1.338 albertel 6807: my $result;
1.964 droeschl 6808:
1.338 albertel 6809: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.964 droeschl 6810: $result .=
6811: &xml_begin() . &headtag($title,$head_extra,\%head_args);
6812: #replace prev line by
6813: # &xml_begin() . &headtag($title, $head_extra, $args);
1.338 albertel 6814: }
6815:
6816: if (! exists($args->{'skip_phases'}{'body'}) ) {
6817: if ($args->{'frameset'}) {
6818: my $attr_string = &make_attr_string($args->{'force_register'},
6819: $args->{'add_entries'});
6820: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 6821: } else {
6822: $result .=
6823: &bodytag($title,
6824: $args->{'function'}, $args->{'add_entries'},
6825: $args->{'only_body'}, $args->{'domain'},
6826: $args->{'force_register'}, $args->{'no_nav_bar'},
1.962 droeschl 6827: $args->{'bgcolor'}, $args);
1.831 bisitz 6828: }
1.330 albertel 6829: }
1.338 albertel 6830:
1.315 albertel 6831: if ($args->{'js_ready'}) {
1.713 kaisler 6832: $result = &js_ready($result);
1.315 albertel 6833: }
1.320 albertel 6834: if ($args->{'html_encode'}) {
1.713 kaisler 6835: $result = &html_encode($result);
6836: }
6837:
1.813 bisitz 6838: # Preparation for new and consistent functionlist at top of screen
6839: # if ($args->{'functionlist'}) {
6840: # $result .= &build_functionlist();
6841: #}
6842:
1.964 droeschl 6843: # Don't add anything more if only_body wanted or in const space
6844: return $result if $args->{'only_body'}
6845: || $env{'request.state'} eq 'construct';
1.813 bisitz 6846:
6847: #Breadcrumbs
1.758 kaisler 6848: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
6849: &Apache::lonhtmlcommon::clear_breadcrumbs();
6850: #if any br links exists, add them to the breadcrumbs
6851: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6852: foreach my $crumb (@{$args->{'bread_crumbs'}}){
6853: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
6854: }
6855: }
6856:
6857: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
6858: if(exists($args->{'bread_crumbs_component'})){
6859: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
6860: }else{
6861: $result .= &Apache::lonhtmlcommon::breadcrumbs();
6862: }
1.320 albertel 6863: }
1.315 albertel 6864: return $result;
1.306 albertel 6865: }
6866:
6867: sub end_page {
1.315 albertel 6868: my ($args) = @_;
6869: $env{'internal.end_page'}++;
1.330 albertel 6870: my $result;
1.335 albertel 6871: if ($args->{'discussion'}) {
6872: my ($target,$parser);
6873: if (ref($args->{'discussion'})) {
6874: ($target,$parser) =($args->{'discussion'}{'target'},
6875: $args->{'discussion'}{'parser'});
6876: }
6877: $result .= &Apache::lonxml::xmlend($target,$parser);
6878: }
6879:
1.330 albertel 6880: if ($args->{'frameset'}) {
6881: $result .= '</frameset>';
6882: } else {
1.635 raeburn 6883: $result .= &endbodytag($args);
1.330 albertel 6884: }
6885: $result .= "\n</html>";
6886:
1.315 albertel 6887: if ($args->{'js_ready'}) {
1.317 albertel 6888: $result = &js_ready($result);
1.315 albertel 6889: }
1.335 albertel 6890:
1.320 albertel 6891: if ($args->{'html_encode'}) {
6892: $result = &html_encode($result);
6893: }
1.335 albertel 6894:
1.315 albertel 6895: return $result;
6896: }
6897:
1.320 albertel 6898: sub html_encode {
6899: my ($result) = @_;
6900:
1.322 albertel 6901: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6902:
6903: return $result;
6904: }
1.317 albertel 6905: sub js_ready {
6906: my ($result) = @_;
6907:
1.323 albertel 6908: $result =~ s/[\n\r]/ /xmsg;
6909: $result =~ s/\\/\\\\/xmsg;
6910: $result =~ s/'/\\'/xmsg;
1.372 albertel 6911: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6912:
6913: return $result;
6914: }
6915:
1.315 albertel 6916: sub validate_page {
6917: if ( exists($env{'internal.start_page'})
1.316 albertel 6918: && $env{'internal.start_page'} > 1) {
6919: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6920: $env{'internal.start_page'}.' '.
1.316 albertel 6921: $ENV{'request.filename'});
1.315 albertel 6922: }
6923: if ( exists($env{'internal.end_page'})
1.316 albertel 6924: && $env{'internal.end_page'} > 1) {
6925: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6926: $env{'internal.end_page'}.' '.
1.316 albertel 6927: $env{'request.filename'});
1.315 albertel 6928: }
6929: if ( exists($env{'internal.start_page'})
6930: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6931: &Apache::lonnet::logthis('start_page called without end_page '.
6932: $env{'request.filename'});
1.315 albertel 6933: }
6934: if ( ! exists($env{'internal.start_page'})
6935: && exists($env{'internal.end_page'})) {
1.316 albertel 6936: &Apache::lonnet::logthis('end_page called without start_page'.
6937: $env{'request.filename'});
1.315 albertel 6938: }
1.306 albertel 6939: }
1.315 albertel 6940:
1.996 www 6941:
6942: sub start_scrollbox {
1.998 raeburn 6943: my ($outerwidth,$width,$height)=@_;
6944: unless ($outerwidth) { $outerwidth='520px'; }
6945: unless ($width) { $width='500px'; }
6946: unless ($height) { $height='200px'; }
6947: return "<table style='width: $outerwidth; border: 1px solid black;'><tr><td style='width: $width;' bgcolor='#FFFFFF'><div style='overflow:auto; width:$width; height: $height;'>";
1.996 www 6948: }
6949:
6950: sub end_scrollbox {
1.998 raeburn 6951: return '</td></tr></table>';
1.996 www 6952: }
6953:
1.318 albertel 6954: sub simple_error_page {
6955: my ($r,$title,$msg) = @_;
6956: my $page =
6957: &Apache::loncommon::start_page($title).
6958: &mt($msg).
6959: &Apache::loncommon::end_page();
6960: if (ref($r)) {
6961: $r->print($page);
1.327 albertel 6962: return;
1.318 albertel 6963: }
6964: return $page;
6965: }
1.347 albertel 6966:
6967: {
1.610 albertel 6968: my @row_count;
1.961 onken 6969:
6970: sub start_data_table_count {
6971: unshift(@row_count, 0);
6972: return;
6973: }
6974:
6975: sub end_data_table_count {
6976: shift(@row_count);
6977: return;
6978: }
6979:
1.347 albertel 6980: sub start_data_table {
1.422 albertel 6981: my ($add_class) = @_;
6982: my $css_class = (join(' ','LC_data_table',$add_class));
1.961 onken 6983: &start_data_table_count();
1.422 albertel 6984: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 6985: }
6986:
6987: sub end_data_table {
1.961 onken 6988: &end_data_table_count();
1.389 albertel 6989: return '</table>'."\n";;
1.347 albertel 6990: }
6991:
6992: sub start_data_table_row {
1.974 wenzelju 6993: my ($add_class, $id) = @_;
1.610 albertel 6994: $row_count[0]++;
6995: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 6996: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 6997: $id = (' id="'.$id.'"') unless ($id eq '');
6998: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 6999: }
1.471 banghart 7000:
7001: sub continue_data_table_row {
1.974 wenzelju 7002: my ($add_class, $id) = @_;
1.610 albertel 7003: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 7004: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
7005: $id = (' id="'.$id.'"') unless ($id eq '');
7006: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 7007: }
1.347 albertel 7008:
7009: sub end_data_table_row {
1.389 albertel 7010: return '</tr>'."\n";;
1.347 albertel 7011: }
1.367 www 7012:
1.421 albertel 7013: sub start_data_table_empty_row {
1.707 bisitz 7014: # $row_count[0]++;
1.421 albertel 7015: return '<tr class="LC_empty_row" >'."\n";;
7016: }
7017:
7018: sub end_data_table_empty_row {
7019: return '</tr>'."\n";;
7020: }
7021:
1.367 www 7022: sub start_data_table_header_row {
1.389 albertel 7023: return '<tr class="LC_header_row">'."\n";;
1.367 www 7024: }
7025:
7026: sub end_data_table_header_row {
1.389 albertel 7027: return '</tr>'."\n";;
1.367 www 7028: }
1.890 droeschl 7029:
7030: sub data_table_caption {
7031: my $caption = shift;
7032: return "<caption class=\"LC_caption\">$caption</caption>";
7033: }
1.347 albertel 7034: }
7035:
1.548 albertel 7036: =pod
7037:
7038: =item * &inhibit_menu_check($arg)
7039:
7040: Checks for a inhibitmenu state and generates output to preserve it
7041:
7042: Inputs: $arg - can be any of
7043: - undef - in which case the return value is a string
7044: to add into arguments list of a uri
7045: - 'input' - in which case the return value is a HTML
7046: <form> <input> field of type hidden to
7047: preserve the value
7048: - a url - in which case the return value is the url with
7049: the neccesary cgi args added to preserve the
7050: inhibitmenu state
7051: - a ref to a url - no return value, but the string is
7052: updated to include the neccessary cgi
7053: args to preserve the inhibitmenu state
7054:
7055: =cut
7056:
7057: sub inhibit_menu_check {
7058: my ($arg) = @_;
7059: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
7060: if ($arg eq 'input') {
7061: if ($env{'form.inhibitmenu'}) {
7062: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
7063: } else {
7064: return
7065: }
7066: }
7067: if ($env{'form.inhibitmenu'}) {
7068: if (ref($arg)) {
7069: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7070: } elsif ($arg eq '') {
7071: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
7072: } else {
7073: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7074: }
7075: }
7076: if (!ref($arg)) {
7077: return $arg;
7078: }
7079: }
7080:
1.251 albertel 7081: ###############################################
1.182 matthew 7082:
7083: =pod
7084:
1.549 albertel 7085: =back
7086:
7087: =head1 User Information Routines
7088:
7089: =over 4
7090:
1.405 albertel 7091: =item * &get_users_function()
1.182 matthew 7092:
7093: Used by &bodytag to determine the current users primary role.
7094: Returns either 'student','coordinator','admin', or 'author'.
7095:
7096: =cut
7097:
7098: ###############################################
7099: sub get_users_function {
1.815 tempelho 7100: my $function = 'norole';
1.818 tempelho 7101: if ($env{'request.role'}=~/^(st)/) {
7102: $function='student';
7103: }
1.907 raeburn 7104: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 7105: $function='coordinator';
7106: }
1.258 albertel 7107: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 7108: $function='admin';
7109: }
1.826 bisitz 7110: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182 matthew 7111: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
7112: $function='author';
7113: }
7114: return $function;
1.54 www 7115: }
1.99 www 7116:
7117: ###############################################
7118:
1.233 raeburn 7119: =pod
7120:
1.821 raeburn 7121: =item * &show_course()
7122:
7123: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
7124: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
7125:
7126: Inputs:
7127: None
7128:
7129: Outputs:
7130: Scalar: 1 if 'Course' to be used, 0 otherwise.
7131:
7132: =cut
7133:
7134: ###############################################
7135: sub show_course {
7136: my $course = !$env{'user.adv'};
7137: if (!$env{'user.adv'}) {
7138: foreach my $env (keys(%env)) {
7139: next if ($env !~ m/^user\.priv\./);
7140: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
7141: $course = 0;
7142: last;
7143: }
7144: }
7145: }
7146: return $course;
7147: }
7148:
7149: ###############################################
7150:
7151: =pod
7152:
1.542 raeburn 7153: =item * &check_user_status()
1.274 raeburn 7154:
7155: Determines current status of supplied role for a
7156: specific user. Roles can be active, previous or future.
7157:
7158: Inputs:
7159: user's domain, user's username, course's domain,
1.375 raeburn 7160: course's number, optional section ID.
1.274 raeburn 7161:
7162: Outputs:
7163: role status: active, previous or future.
7164:
7165: =cut
7166:
7167: sub check_user_status {
1.412 raeburn 7168: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.982 raeburn 7169: my $extra = &Apache::lonnet::freeze_escape({'skipcheck' => 1});
7170: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname,'.',undef,$extra);
1.274 raeburn 7171: my @uroles = keys %userinfo;
7172: my $srchstr;
7173: my $active_chk = 'none';
1.412 raeburn 7174: my $now = time;
1.274 raeburn 7175: if (@uroles > 0) {
1.908 raeburn 7176: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 7177: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
7178: } else {
1.412 raeburn 7179: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
7180: }
7181: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 7182: my $role_end = 0;
7183: my $role_start = 0;
7184: $active_chk = 'active';
1.412 raeburn 7185: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
7186: $role_end = $1;
7187: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
7188: $role_start = $1;
1.274 raeburn 7189: }
7190: }
7191: if ($role_start > 0) {
1.412 raeburn 7192: if ($now < $role_start) {
1.274 raeburn 7193: $active_chk = 'future';
7194: }
7195: }
7196: if ($role_end > 0) {
1.412 raeburn 7197: if ($now > $role_end) {
1.274 raeburn 7198: $active_chk = 'previous';
7199: }
7200: }
7201: }
7202: }
7203: return $active_chk;
7204: }
7205:
7206: ###############################################
7207:
7208: =pod
7209:
1.405 albertel 7210: =item * &get_sections()
1.233 raeburn 7211:
7212: Determines all the sections for a course including
7213: sections with students and sections containing other roles.
1.419 raeburn 7214: Incoming parameters:
7215:
7216: 1. domain
7217: 2. course number
7218: 3. reference to array containing roles for which sections should
7219: be gathered (optional).
7220: 4. reference to array containing status types for which sections
7221: should be gathered (optional).
7222:
7223: If the third argument is undefined, sections are gathered for any role.
7224: If the fourth argument is undefined, sections are gathered for any status.
7225: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 7226:
1.374 raeburn 7227: Returns section hash (keys are section IDs, values are
7228: number of users in each section), subject to the
1.419 raeburn 7229: optional roles filter, optional status filter
1.233 raeburn 7230:
7231: =cut
7232:
7233: ###############################################
7234: sub get_sections {
1.419 raeburn 7235: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 7236: if (!defined($cdom) || !defined($cnum)) {
7237: my $cid = $env{'request.course.id'};
7238:
7239: return if (!defined($cid));
7240:
7241: $cdom = $env{'course.'.$cid.'.domain'};
7242: $cnum = $env{'course.'.$cid.'.num'};
7243: }
7244:
7245: my %sectioncount;
1.419 raeburn 7246: my $now = time;
1.240 albertel 7247:
1.366 albertel 7248: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 7249: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 7250: my $sec_index = &Apache::loncoursedata::CL_SECTION();
7251: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 7252: my $start_index = &Apache::loncoursedata::CL_START();
7253: my $end_index = &Apache::loncoursedata::CL_END();
7254: my $status;
1.366 albertel 7255: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 7256: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
7257: $data->[$status_index],
7258: $data->[$start_index],
7259: $data->[$end_index]);
7260: if ($stu_status eq 'Active') {
7261: $status = 'active';
7262: } elsif ($end < $now) {
7263: $status = 'previous';
7264: } elsif ($start > $now) {
7265: $status = 'future';
7266: }
7267: if ($section ne '-1' && $section !~ /^\s*$/) {
7268: if ((!defined($possible_status)) || (($status ne '') &&
7269: (grep/^\Q$status\E$/,@{$possible_status}))) {
7270: $sectioncount{$section}++;
7271: }
1.240 albertel 7272: }
7273: }
7274: }
7275: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7276: foreach my $user (sort(keys(%courseroles))) {
7277: if ($user !~ /^(\w{2})/) { next; }
7278: my ($role) = ($user =~ /^(\w{2})/);
7279: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 7280: my ($section,$status);
1.240 albertel 7281: if ($role eq 'cr' &&
7282: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
7283: $section=$1;
7284: }
7285: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
7286: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 7287: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
7288: if ($end == -1 && $start == -1) {
7289: next; #deleted role
7290: }
7291: if (!defined($possible_status)) {
7292: $sectioncount{$section}++;
7293: } else {
7294: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
7295: $status = 'active';
7296: } elsif ($end < $now) {
7297: $status = 'future';
7298: } elsif ($start > $now) {
7299: $status = 'previous';
7300: }
7301: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
7302: $sectioncount{$section}++;
7303: }
7304: }
1.233 raeburn 7305: }
1.366 albertel 7306: return %sectioncount;
1.233 raeburn 7307: }
7308:
1.274 raeburn 7309: ###############################################
1.294 raeburn 7310:
7311: =pod
1.405 albertel 7312:
7313: =item * &get_course_users()
7314:
1.275 raeburn 7315: Retrieves usernames:domains for users in the specified course
7316: with specific role(s), and access status.
7317:
7318: Incoming parameters:
1.277 albertel 7319: 1. course domain
7320: 2. course number
7321: 3. access status: users must have - either active,
1.275 raeburn 7322: previous, future, or all.
1.277 albertel 7323: 4. reference to array of permissible roles
1.288 raeburn 7324: 5. reference to array of section restrictions (optional)
7325: 6. reference to results object (hash of hashes).
7326: 7. reference to optional userdata hash
1.609 raeburn 7327: 8. reference to optional statushash
1.630 raeburn 7328: 9. flag if privileged users (except those set to unhide in
7329: course settings) should be excluded
1.609 raeburn 7330: Keys of top level results hash are roles.
1.275 raeburn 7331: Keys of inner hashes are username:domain, with
7332: values set to access type.
1.288 raeburn 7333: Optional userdata hash returns an array with arguments in the
7334: same order as loncoursedata::get_classlist() for student data.
7335:
1.609 raeburn 7336: Optional statushash returns
7337:
1.288 raeburn 7338: Entries for end, start, section and status are blank because
7339: of the possibility of multiple values for non-student roles.
7340:
1.275 raeburn 7341: =cut
1.405 albertel 7342:
1.275 raeburn 7343: ###############################################
1.405 albertel 7344:
1.275 raeburn 7345: sub get_course_users {
1.630 raeburn 7346: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 7347: my %idx = ();
1.419 raeburn 7348: my %seclists;
1.288 raeburn 7349:
7350: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
7351: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
7352: $idx{end} = &Apache::loncoursedata::CL_END();
7353: $idx{start} = &Apache::loncoursedata::CL_START();
7354: $idx{id} = &Apache::loncoursedata::CL_ID();
7355: $idx{section} = &Apache::loncoursedata::CL_SECTION();
7356: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
7357: $idx{status} = &Apache::loncoursedata::CL_STATUS();
7358:
1.290 albertel 7359: if (grep(/^st$/,@{$roles})) {
1.276 albertel 7360: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 7361: my $now = time;
1.277 albertel 7362: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 7363: my $match = 0;
1.412 raeburn 7364: my $secmatch = 0;
1.419 raeburn 7365: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 7366: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 7367: if ($section eq '') {
7368: $section = 'none';
7369: }
1.291 albertel 7370: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7371: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7372: $secmatch = 1;
7373: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 7374: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7375: $secmatch = 1;
7376: }
7377: } else {
1.419 raeburn 7378: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 7379: $secmatch = 1;
7380: }
1.290 albertel 7381: }
1.412 raeburn 7382: if (!$secmatch) {
7383: next;
7384: }
1.419 raeburn 7385: }
1.275 raeburn 7386: if (defined($$types{'active'})) {
1.288 raeburn 7387: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 7388: push(@{$$users{st}{$student}},'active');
1.288 raeburn 7389: $match = 1;
1.275 raeburn 7390: }
7391: }
7392: if (defined($$types{'previous'})) {
1.609 raeburn 7393: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 7394: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 7395: $match = 1;
1.275 raeburn 7396: }
7397: }
7398: if (defined($$types{'future'})) {
1.609 raeburn 7399: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 7400: push(@{$$users{st}{$student}},'future');
1.288 raeburn 7401: $match = 1;
1.275 raeburn 7402: }
7403: }
1.609 raeburn 7404: if ($match) {
7405: push(@{$seclists{$student}},$section);
7406: if (ref($userdata) eq 'HASH') {
7407: $$userdata{$student} = $$classlist{$student};
7408: }
7409: if (ref($statushash) eq 'HASH') {
7410: $statushash->{$student}{'st'}{$section} = $status;
7411: }
1.288 raeburn 7412: }
1.275 raeburn 7413: }
7414: }
1.412 raeburn 7415: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 7416: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7417: my $now = time;
1.609 raeburn 7418: my %displaystatus = ( previous => 'Expired',
7419: active => 'Active',
7420: future => 'Future',
7421: );
1.630 raeburn 7422: my %nothide;
7423: if ($hidepriv) {
7424: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
7425: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
7426: if ($user !~ /:/) {
7427: $nothide{join(':',split(/[\@]/,$user))}=1;
7428: } else {
7429: $nothide{$user} = 1;
7430: }
7431: }
7432: }
1.439 raeburn 7433: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 7434: my $match = 0;
1.412 raeburn 7435: my $secmatch = 0;
1.439 raeburn 7436: my $status;
1.412 raeburn 7437: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 7438: $user =~ s/:$//;
1.439 raeburn 7439: my ($end,$start) = split(/:/,$coursepersonnel{$person});
7440: if ($end == -1 || $start == -1) {
7441: next;
7442: }
7443: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
7444: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 7445: my ($uname,$udom) = split(/:/,$user);
7446: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7447: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7448: $secmatch = 1;
7449: } elsif ($usec eq '') {
1.420 albertel 7450: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7451: $secmatch = 1;
7452: }
7453: } else {
7454: if (grep(/^\Q$usec\E$/,@{$sections})) {
7455: $secmatch = 1;
7456: }
7457: }
7458: if (!$secmatch) {
7459: next;
7460: }
1.288 raeburn 7461: }
1.419 raeburn 7462: if ($usec eq '') {
7463: $usec = 'none';
7464: }
1.275 raeburn 7465: if ($uname ne '' && $udom ne '') {
1.630 raeburn 7466: if ($hidepriv) {
7467: if ((&Apache::lonnet::privileged($uname,$udom)) &&
7468: (!$nothide{$uname.':'.$udom})) {
7469: next;
7470: }
7471: }
1.503 raeburn 7472: if ($end > 0 && $end < $now) {
1.439 raeburn 7473: $status = 'previous';
7474: } elsif ($start > $now) {
7475: $status = 'future';
7476: } else {
7477: $status = 'active';
7478: }
1.277 albertel 7479: foreach my $type (keys(%{$types})) {
1.275 raeburn 7480: if ($status eq $type) {
1.420 albertel 7481: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 7482: push(@{$$users{$role}{$user}},$type);
7483: }
1.288 raeburn 7484: $match = 1;
7485: }
7486: }
1.419 raeburn 7487: if (($match) && (ref($userdata) eq 'HASH')) {
7488: if (!exists($$userdata{$uname.':'.$udom})) {
7489: &get_user_info($udom,$uname,\%idx,$userdata);
7490: }
1.420 albertel 7491: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 7492: push(@{$seclists{$uname.':'.$udom}},$usec);
7493: }
1.609 raeburn 7494: if (ref($statushash) eq 'HASH') {
7495: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
7496: }
1.275 raeburn 7497: }
7498: }
7499: }
7500: }
1.290 albertel 7501: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 7502: if ((defined($cdom)) && (defined($cnum))) {
7503: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
7504: if ( defined($csettings{'internal.courseowner'}) ) {
7505: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 7506: next if ($owner eq '');
7507: my ($ownername,$ownerdom);
7508: if ($owner =~ /^([^:]+):([^:]+)$/) {
7509: $ownername = $1;
7510: $ownerdom = $2;
7511: } else {
7512: $ownername = $owner;
7513: $ownerdom = $cdom;
7514: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 7515: }
7516: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 7517: if (defined($userdata) &&
1.609 raeburn 7518: !exists($$userdata{$owner})) {
7519: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
7520: if (!grep(/^none$/,@{$seclists{$owner}})) {
7521: push(@{$seclists{$owner}},'none');
7522: }
7523: if (ref($statushash) eq 'HASH') {
7524: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 7525: }
1.290 albertel 7526: }
1.279 raeburn 7527: }
7528: }
7529: }
1.419 raeburn 7530: foreach my $user (keys(%seclists)) {
7531: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
7532: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
7533: }
1.275 raeburn 7534: }
7535: return;
7536: }
7537:
1.288 raeburn 7538: sub get_user_info {
7539: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 7540: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
7541: &plainname($uname,$udom,'lastname');
1.291 albertel 7542: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 7543: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 7544: my %idhash = &Apache::lonnet::idrget($udom,($uname));
7545: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 7546: return;
7547: }
1.275 raeburn 7548:
1.472 raeburn 7549: ###############################################
7550:
7551: =pod
7552:
7553: =item * &get_user_quota()
7554:
7555: Retrieves quota assigned for storage of portfolio files for a user
7556:
7557: Incoming parameters:
7558: 1. user's username
7559: 2. user's domain
7560:
7561: Returns:
1.536 raeburn 7562: 1. Disk quota (in Mb) assigned to student.
7563: 2. (Optional) Type of setting: custom or default
7564: (individually assigned or default for user's
7565: institutional status).
7566: 3. (Optional) - User's institutional status (e.g., faculty, staff
7567: or student - types as defined in localenroll::inst_usertypes
7568: for user's domain, which determines default quota for user.
7569: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 7570:
7571: If a value has been stored in the user's environment,
1.536 raeburn 7572: it will return that, otherwise it returns the maximal default
7573: defined for the user's instituional status(es) in the domain.
1.472 raeburn 7574:
7575: =cut
7576:
7577: ###############################################
7578:
7579:
7580: sub get_user_quota {
7581: my ($uname,$udom) = @_;
1.536 raeburn 7582: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 7583: if (!defined($udom)) {
7584: $udom = $env{'user.domain'};
7585: }
7586: if (!defined($uname)) {
7587: $uname = $env{'user.name'};
7588: }
7589: if (($udom eq '' || $uname eq '') ||
7590: ($udom eq 'public') && ($uname eq 'public')) {
7591: $quota = 0;
1.536 raeburn 7592: $quotatype = 'default';
7593: $defquota = 0;
1.472 raeburn 7594: } else {
1.536 raeburn 7595: my $inststatus;
1.472 raeburn 7596: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
7597: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 7598: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 7599: } else {
1.536 raeburn 7600: my %userenv =
7601: &Apache::lonnet::get('environment',['portfolioquota',
7602: 'inststatus'],$udom,$uname);
1.472 raeburn 7603: my ($tmp) = keys(%userenv);
7604: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7605: $quota = $userenv{'portfolioquota'};
1.536 raeburn 7606: $inststatus = $userenv{'inststatus'};
1.472 raeburn 7607: } else {
7608: undef(%userenv);
7609: }
7610: }
1.536 raeburn 7611: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 7612: if ($quota eq '') {
1.536 raeburn 7613: $quota = $defquota;
7614: $quotatype = 'default';
7615: } else {
7616: $quotatype = 'custom';
1.472 raeburn 7617: }
7618: }
1.536 raeburn 7619: if (wantarray) {
7620: return ($quota,$quotatype,$settingstatus,$defquota);
7621: } else {
7622: return $quota;
7623: }
1.472 raeburn 7624: }
7625:
7626: ###############################################
7627:
7628: =pod
7629:
7630: =item * &default_quota()
7631:
1.536 raeburn 7632: Retrieves default quota assigned for storage of user portfolio files,
7633: given an (optional) user's institutional status.
1.472 raeburn 7634:
7635: Incoming parameters:
7636: 1. domain
1.536 raeburn 7637: 2. (Optional) institutional status(es). This is a : separated list of
7638: status types (e.g., faculty, staff, student etc.)
7639: which apply to the user for whom the default is being retrieved.
7640: If the institutional status string in undefined, the domain
7641: default quota will be returned.
1.472 raeburn 7642:
7643: Returns:
7644: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 7645: 2. (Optional) institutional type which determined the value of the
7646: default quota.
1.472 raeburn 7647:
7648: If a value has been stored in the domain's configuration db,
7649: it will return that, otherwise it returns 20 (for backwards
7650: compatibility with domains which have not set up a configuration
7651: db file; the original statically defined portfolio quota was 20 Mb).
7652:
1.536 raeburn 7653: If the user's status includes multiple types (e.g., staff and student),
7654: the largest default quota which applies to the user determines the
7655: default quota returned.
7656:
1.780 raeburn 7657: =back
7658:
1.472 raeburn 7659: =cut
7660:
7661: ###############################################
7662:
7663:
7664: sub default_quota {
1.536 raeburn 7665: my ($udom,$inststatus) = @_;
7666: my ($defquota,$settingstatus);
7667: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 7668: ['quotas'],$udom);
7669: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 7670: if ($inststatus ne '') {
1.765 raeburn 7671: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 7672: foreach my $item (@statuses) {
1.711 raeburn 7673: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7674: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
7675: if ($defquota eq '') {
7676: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7677: $settingstatus = $item;
7678: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
7679: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7680: $settingstatus = $item;
7681: }
7682: }
7683: } else {
7684: if ($quotahash{'quotas'}{$item} ne '') {
7685: if ($defquota eq '') {
7686: $defquota = $quotahash{'quotas'}{$item};
7687: $settingstatus = $item;
7688: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
7689: $defquota = $quotahash{'quotas'}{$item};
7690: $settingstatus = $item;
7691: }
1.536 raeburn 7692: }
7693: }
7694: }
7695: }
7696: if ($defquota eq '') {
1.711 raeburn 7697: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7698: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
7699: } else {
7700: $defquota = $quotahash{'quotas'}{'default'};
7701: }
1.536 raeburn 7702: $settingstatus = 'default';
7703: }
7704: } else {
7705: $settingstatus = 'default';
7706: $defquota = 20;
7707: }
7708: if (wantarray) {
7709: return ($defquota,$settingstatus);
1.472 raeburn 7710: } else {
1.536 raeburn 7711: return $defquota;
1.472 raeburn 7712: }
7713: }
7714:
1.384 raeburn 7715: sub get_secgrprole_info {
7716: my ($cdom,$cnum,$needroles,$type) = @_;
7717: my %sections_count = &get_sections($cdom,$cnum);
7718: my @sections = (sort {$a <=> $b} keys(%sections_count));
7719: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
7720: my @groups = sort(keys(%curr_groups));
7721: my $allroles = [];
7722: my $rolehash;
7723: my $accesshash = {
7724: active => 'Currently has access',
7725: future => 'Will have future access',
7726: previous => 'Previously had access',
7727: };
7728: if ($needroles) {
7729: $rolehash = {'all' => 'all'};
1.385 albertel 7730: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7731: if (&Apache::lonnet::error(%user_roles)) {
7732: undef(%user_roles);
7733: }
7734: foreach my $item (keys(%user_roles)) {
1.384 raeburn 7735: my ($role)=split(/\:/,$item,2);
7736: if ($role eq 'cr') { next; }
7737: if ($role =~ /^cr/) {
7738: $$rolehash{$role} = (split('/',$role))[3];
7739: } else {
7740: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
7741: }
7742: }
7743: foreach my $key (sort(keys(%{$rolehash}))) {
7744: push(@{$allroles},$key);
7745: }
7746: push (@{$allroles},'st');
7747: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
7748: }
7749: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
7750: }
7751:
1.555 raeburn 7752: sub user_picker {
1.994 raeburn 7753: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context) = @_;
1.555 raeburn 7754: my $currdom = $dom;
7755: my %curr_selected = (
7756: srchin => 'dom',
1.580 raeburn 7757: srchby => 'lastname',
1.555 raeburn 7758: );
7759: my $srchterm;
1.625 raeburn 7760: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 7761: if ($srch->{'srchby'} ne '') {
7762: $curr_selected{'srchby'} = $srch->{'srchby'};
7763: }
7764: if ($srch->{'srchin'} ne '') {
7765: $curr_selected{'srchin'} = $srch->{'srchin'};
7766: }
7767: if ($srch->{'srchtype'} ne '') {
7768: $curr_selected{'srchtype'} = $srch->{'srchtype'};
7769: }
7770: if ($srch->{'srchdomain'} ne '') {
7771: $currdom = $srch->{'srchdomain'};
7772: }
7773: $srchterm = $srch->{'srchterm'};
7774: }
7775: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 7776: 'usr' => 'Search criteria',
1.563 raeburn 7777: 'doma' => 'Domain/institution to search',
1.558 albertel 7778: 'uname' => 'username',
7779: 'lastname' => 'last name',
1.555 raeburn 7780: 'lastfirst' => 'last name, first name',
1.558 albertel 7781: 'crs' => 'in this course',
1.576 raeburn 7782: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 7783: 'alc' => 'all LON-CAPA',
1.573 raeburn 7784: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 7785: 'exact' => 'is',
7786: 'contains' => 'contains',
1.569 raeburn 7787: 'begins' => 'begins with',
1.571 raeburn 7788: 'youm' => "You must include some text to search for.",
7789: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
7790: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
7791: 'yomc' => "You must choose a domain when using an institutional directory search.",
7792: 'ymcd' => "You must choose a domain when using a domain search.",
7793: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
7794: 'whse' => "When searching by last,first you must include at least one character in the first name.",
7795: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 7796: );
1.563 raeburn 7797: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
7798: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 7799:
7800: my @srchins = ('crs','dom','alc','instd');
7801:
7802: foreach my $option (@srchins) {
7803: # FIXME 'alc' option unavailable until
7804: # loncreateuser::print_user_query_page()
7805: # has been completed.
7806: next if ($option eq 'alc');
1.880 raeburn 7807: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 7808: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 7809: if ($curr_selected{'srchin'} eq $option) {
7810: $srchinsel .= '
7811: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7812: } else {
7813: $srchinsel .= '
7814: <option value="'.$option.'">'.$lt{$option}.'</option>';
7815: }
1.555 raeburn 7816: }
1.563 raeburn 7817: $srchinsel .= "\n </select>\n";
1.555 raeburn 7818:
7819: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 7820: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 7821: if ($curr_selected{'srchby'} eq $option) {
7822: $srchbysel .= '
7823: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7824: } else {
7825: $srchbysel .= '
7826: <option value="'.$option.'">'.$lt{$option}.'</option>';
7827: }
7828: }
7829: $srchbysel .= "\n </select>\n";
7830:
7831: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 7832: foreach my $option ('begins','contains','exact') {
1.555 raeburn 7833: if ($curr_selected{'srchtype'} eq $option) {
7834: $srchtypesel .= '
7835: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7836: } else {
7837: $srchtypesel .= '
7838: <option value="'.$option.'">'.$lt{$option}.'</option>';
7839: }
7840: }
7841: $srchtypesel .= "\n </select>\n";
7842:
1.558 albertel 7843: my ($newuserscript,$new_user_create);
1.994 raeburn 7844: my $context_dom = $env{'request.role.domain'};
7845: if ($context eq 'requestcrs') {
7846: if ($env{'form.coursedom'} ne '') {
7847: $context_dom = $env{'form.coursedom'};
7848: }
7849: }
1.556 raeburn 7850: if ($forcenewuser) {
1.576 raeburn 7851: if (ref($srch) eq 'HASH') {
1.994 raeburn 7852: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 7853: if ($cancreate) {
7854: $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>';
7855: } else {
1.799 bisitz 7856: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 7857: my %usertypetext = (
7858: official => 'institutional',
7859: unofficial => 'non-institutional',
7860: );
1.799 bisitz 7861: $new_user_create = '<p class="LC_warning">'
7862: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
7863: .' '
7864: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
7865: ,'<a href="'.$helplink.'">','</a>')
7866: .'</p><br />';
1.627 raeburn 7867: }
1.576 raeburn 7868: }
7869: }
7870:
1.556 raeburn 7871: $newuserscript = <<"ENDSCRIPT";
7872:
1.570 raeburn 7873: function setSearch(createnew,callingForm) {
1.556 raeburn 7874: if (createnew == 1) {
1.570 raeburn 7875: for (var i=0; i<callingForm.srchby.length; i++) {
7876: if (callingForm.srchby.options[i].value == 'uname') {
7877: callingForm.srchby.selectedIndex = i;
1.556 raeburn 7878: }
7879: }
1.570 raeburn 7880: for (var i=0; i<callingForm.srchin.length; i++) {
7881: if ( callingForm.srchin.options[i].value == 'dom') {
7882: callingForm.srchin.selectedIndex = i;
1.556 raeburn 7883: }
7884: }
1.570 raeburn 7885: for (var i=0; i<callingForm.srchtype.length; i++) {
7886: if (callingForm.srchtype.options[i].value == 'exact') {
7887: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 7888: }
7889: }
1.570 raeburn 7890: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 7891: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 7892: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 7893: }
7894: }
7895: }
7896: }
7897: ENDSCRIPT
1.558 albertel 7898:
1.556 raeburn 7899: }
7900:
1.555 raeburn 7901: my $output = <<"END_BLOCK";
1.556 raeburn 7902: <script type="text/javascript">
1.824 bisitz 7903: // <![CDATA[
1.570 raeburn 7904: function validateEntry(callingForm) {
1.558 albertel 7905:
1.556 raeburn 7906: var checkok = 1;
1.558 albertel 7907: var srchin;
1.570 raeburn 7908: for (var i=0; i<callingForm.srchin.length; i++) {
7909: if ( callingForm.srchin[i].checked ) {
7910: srchin = callingForm.srchin[i].value;
1.558 albertel 7911: }
7912: }
7913:
1.570 raeburn 7914: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7915: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7916: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7917: var srchterm = callingForm.srchterm.value;
7918: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7919: var msg = "";
7920:
7921: if (srchterm == "") {
7922: checkok = 0;
1.571 raeburn 7923: msg += "$lt{'youm'}\\n";
1.556 raeburn 7924: }
7925:
1.569 raeburn 7926: if (srchtype== 'begins') {
7927: if (srchterm.length < 2) {
7928: checkok = 0;
1.571 raeburn 7929: msg += "$lt{'thte'}\\n";
1.569 raeburn 7930: }
7931: }
7932:
1.556 raeburn 7933: if (srchtype== 'contains') {
7934: if (srchterm.length < 3) {
7935: checkok = 0;
1.571 raeburn 7936: msg += "$lt{'thet'}\\n";
1.556 raeburn 7937: }
7938: }
7939: if (srchin == 'instd') {
7940: if (srchdomain == '') {
7941: checkok = 0;
1.571 raeburn 7942: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7943: }
7944: }
7945: if (srchin == 'dom') {
7946: if (srchdomain == '') {
7947: checkok = 0;
1.571 raeburn 7948: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7949: }
7950: }
7951: if (srchby == 'lastfirst') {
7952: if (srchterm.indexOf(",") == -1) {
7953: checkok = 0;
1.571 raeburn 7954: msg += "$lt{'whus'}\\n";
1.556 raeburn 7955: }
7956: if (srchterm.indexOf(",") == srchterm.length -1) {
7957: checkok = 0;
1.571 raeburn 7958: msg += "$lt{'whse'}\\n";
1.556 raeburn 7959: }
7960: }
7961: if (checkok == 0) {
1.571 raeburn 7962: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7963: return;
7964: }
7965: if (checkok == 1) {
1.570 raeburn 7966: callingForm.submit();
1.556 raeburn 7967: }
7968: }
7969:
7970: $newuserscript
7971:
1.824 bisitz 7972: // ]]>
1.556 raeburn 7973: </script>
1.558 albertel 7974:
7975: $new_user_create
7976:
1.555 raeburn 7977: END_BLOCK
1.558 albertel 7978:
1.876 raeburn 7979: $output .= &Apache::lonhtmlcommon::start_pick_box().
7980: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
7981: $domform.
7982: &Apache::lonhtmlcommon::row_closure().
7983: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
7984: $srchbysel.
7985: $srchtypesel.
7986: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
7987: $srchinsel.
7988: &Apache::lonhtmlcommon::row_closure(1).
7989: &Apache::lonhtmlcommon::end_pick_box().
7990: '<br />';
1.555 raeburn 7991: return $output;
7992: }
7993:
1.612 raeburn 7994: sub user_rule_check {
1.615 raeburn 7995: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 7996: my $response;
7997: if (ref($usershash) eq 'HASH') {
7998: foreach my $user (keys(%{$usershash})) {
7999: my ($uname,$udom) = split(/:/,$user);
8000: next if ($udom eq '' || $uname eq '');
1.615 raeburn 8001: my ($id,$newuser);
1.612 raeburn 8002: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 8003: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 8004: $id = $usershash->{$user}->{'id'};
8005: }
8006: my $inst_response;
8007: if (ref($checks) eq 'HASH') {
8008: if (defined($checks->{'username'})) {
1.615 raeburn 8009: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 8010: &Apache::lonnet::get_instuser($udom,$uname);
8011: } elsif (defined($checks->{'id'})) {
1.615 raeburn 8012: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 8013: &Apache::lonnet::get_instuser($udom,undef,$id);
8014: }
1.615 raeburn 8015: } else {
8016: ($inst_response,%{$inst_results->{$user}}) =
8017: &Apache::lonnet::get_instuser($udom,$uname);
8018: return;
1.612 raeburn 8019: }
1.615 raeburn 8020: if (!$got_rules->{$udom}) {
1.612 raeburn 8021: my %domconfig = &Apache::lonnet::get_dom('configuration',
8022: ['usercreation'],$udom);
8023: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 8024: foreach my $item ('username','id') {
1.612 raeburn 8025: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
8026: $$curr_rules{$udom}{$item} =
8027: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 8028: }
8029: }
8030: }
1.615 raeburn 8031: $got_rules->{$udom} = 1;
1.585 raeburn 8032: }
1.612 raeburn 8033: foreach my $item (keys(%{$checks})) {
8034: if (ref($$curr_rules{$udom}) eq 'HASH') {
8035: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
8036: if (@{$$curr_rules{$udom}{$item}} > 0) {
8037: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
8038: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
8039: if ($rule_check{$rule}) {
8040: $$rulematch{$user}{$item} = $rule;
8041: if ($inst_response eq 'ok') {
1.615 raeburn 8042: if (ref($inst_results) eq 'HASH') {
8043: if (ref($inst_results->{$user}) eq 'HASH') {
8044: if (keys(%{$inst_results->{$user}}) == 0) {
8045: $$alerts{$item}{$udom}{$uname} = 1;
8046: }
1.612 raeburn 8047: }
8048: }
1.615 raeburn 8049: }
8050: last;
1.585 raeburn 8051: }
8052: }
8053: }
8054: }
8055: }
8056: }
8057: }
8058: }
1.612 raeburn 8059: return;
8060: }
8061:
8062: sub user_rule_formats {
8063: my ($domain,$domdesc,$curr_rules,$check) = @_;
8064: my %text = (
8065: 'username' => 'Usernames',
8066: 'id' => 'IDs',
8067: );
8068: my $output;
8069: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
8070: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
8071: if (@{$ruleorder} > 0) {
8072: $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>';
8073: foreach my $rule (@{$ruleorder}) {
8074: if (ref($curr_rules) eq 'ARRAY') {
8075: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
8076: if (ref($rules->{$rule}) eq 'HASH') {
8077: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
8078: $rules->{$rule}{'desc'}.'</li>';
8079: }
8080: }
8081: }
8082: }
8083: $output .= '</ul>';
8084: }
8085: }
8086: return $output;
8087: }
8088:
8089: sub instrule_disallow_msg {
1.615 raeburn 8090: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 8091: my $response;
8092: my %text = (
8093: item => 'username',
8094: items => 'usernames',
8095: match => 'matches',
8096: do => 'does',
8097: action => 'a username',
8098: one => 'one',
8099: );
8100: if ($count > 1) {
8101: $text{'item'} = 'usernames';
8102: $text{'match'} ='match';
8103: $text{'do'} = 'do';
8104: $text{'action'} = 'usernames',
8105: $text{'one'} = 'ones';
8106: }
8107: if ($checkitem eq 'id') {
8108: $text{'items'} = 'IDs';
8109: $text{'item'} = 'ID';
8110: $text{'action'} = 'an ID';
1.615 raeburn 8111: if ($count > 1) {
8112: $text{'item'} = 'IDs';
8113: $text{'action'} = 'IDs';
8114: }
1.612 raeburn 8115: }
1.674 bisitz 8116: $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 8117: if ($mode eq 'upload') {
8118: if ($checkitem eq 'username') {
8119: $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'}.");
8120: } elsif ($checkitem eq 'id') {
1.674 bisitz 8121: $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 8122: }
1.669 raeburn 8123: } elsif ($mode eq 'selfcreate') {
8124: if ($checkitem eq 'id') {
8125: $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.");
8126: }
1.615 raeburn 8127: } else {
8128: if ($checkitem eq 'username') {
8129: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
8130: } elsif ($checkitem eq 'id') {
8131: $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.");
8132: }
1.612 raeburn 8133: }
8134: return $response;
1.585 raeburn 8135: }
8136:
1.624 raeburn 8137: sub personal_data_fieldtitles {
8138: my %fieldtitles = &Apache::lonlocal::texthash (
8139: id => 'Student/Employee ID',
8140: permanentemail => 'E-mail address',
8141: lastname => 'Last Name',
8142: firstname => 'First Name',
8143: middlename => 'Middle Name',
8144: generation => 'Generation',
8145: gen => 'Generation',
1.765 raeburn 8146: inststatus => 'Affiliation',
1.624 raeburn 8147: );
8148: return %fieldtitles;
8149: }
8150:
1.642 raeburn 8151: sub sorted_inst_types {
8152: my ($dom) = @_;
8153: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
8154: my $othertitle = &mt('All users');
8155: if ($env{'request.course.id'}) {
1.668 raeburn 8156: $othertitle = &mt('Any users');
1.642 raeburn 8157: }
8158: my @types;
8159: if (ref($order) eq 'ARRAY') {
8160: @types = @{$order};
8161: }
8162: if (@types == 0) {
8163: if (ref($usertypes) eq 'HASH') {
8164: @types = sort(keys(%{$usertypes}));
8165: }
8166: }
8167: if (keys(%{$usertypes}) > 0) {
8168: $othertitle = &mt('Other users');
8169: }
8170: return ($othertitle,$usertypes,\@types);
8171: }
8172:
1.645 raeburn 8173: sub get_institutional_codes {
8174: my ($settings,$allcourses,$LC_code) = @_;
8175: # Get complete list of course sections to update
8176: my @currsections = ();
8177: my @currxlists = ();
8178: my $coursecode = $$settings{'internal.coursecode'};
8179:
8180: if ($$settings{'internal.sectionnums'} ne '') {
8181: @currsections = split(/,/,$$settings{'internal.sectionnums'});
8182: }
8183:
8184: if ($$settings{'internal.crosslistings'} ne '') {
8185: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
8186: }
8187:
8188: if (@currxlists > 0) {
8189: foreach (@currxlists) {
8190: if (m/^([^:]+):(\w*)$/) {
8191: unless (grep/^$1$/,@{$allcourses}) {
8192: push @{$allcourses},$1;
8193: $$LC_code{$1} = $2;
8194: }
8195: }
8196: }
8197: }
8198:
8199: if (@currsections > 0) {
8200: foreach (@currsections) {
8201: if (m/^(\w+):(\w*)$/) {
8202: my $sec = $coursecode.$1;
8203: my $lc_sec = $2;
8204: unless (grep/^$sec$/,@{$allcourses}) {
8205: push @{$allcourses},$sec;
8206: $$LC_code{$sec} = $lc_sec;
8207: }
8208: }
8209: }
8210: }
8211: return;
8212: }
8213:
1.971 raeburn 8214: sub get_standard_codeitems {
8215: return ('Year','Semester','Department','Number','Section');
8216: }
8217:
1.112 bowersj2 8218: =pod
8219:
1.780 raeburn 8220: =head1 Slot Helpers
8221:
8222: =over 4
8223:
8224: =item * sorted_slots()
8225:
8226: Sorts an array of slot names in order of slot start time (earliest first).
8227:
8228: Inputs:
8229:
8230: =over 4
8231:
8232: slotsarr - Reference to array of unsorted slot names.
8233:
8234: slots - Reference to hash of hash, where outer hash keys are slot names.
8235:
1.549 albertel 8236: =back
8237:
1.780 raeburn 8238: Returns:
8239:
8240: =over 4
8241:
8242: sorted - An array of slot names sorted by the start time of the slot.
8243:
8244: =back
8245:
8246: =back
8247:
8248: =cut
8249:
8250:
8251: sub sorted_slots {
8252: my ($slotsarr,$slots) = @_;
8253: my @sorted;
8254: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
8255: @sorted =
8256: sort {
8257: if (ref($slots->{$a}) && ref($slots->{$b})) {
8258: return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
8259: }
8260: if (ref($slots->{$a})) { return -1;}
8261: if (ref($slots->{$b})) { return 1;}
8262: return 0;
8263: } @{$slotsarr};
8264: }
8265: return @sorted;
8266: }
8267:
8268:
8269: =pod
8270:
1.549 albertel 8271: =head1 HTTP Helpers
8272:
8273: =over 4
8274:
1.648 raeburn 8275: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 8276:
1.258 albertel 8277: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 8278: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 8279: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 8280:
8281: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
8282: $possible_names is an ref to an array of form element names. As an example:
8283: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 8284: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 8285:
8286: =cut
1.1 albertel 8287:
1.6 albertel 8288: sub get_unprocessed_cgi {
1.25 albertel 8289: my ($query,$possible_names)= @_;
1.26 matthew 8290: # $Apache::lonxml::debug=1;
1.356 albertel 8291: foreach my $pair (split(/&/,$query)) {
8292: my ($name, $value) = split(/=/,$pair);
1.369 www 8293: $name = &unescape($name);
1.25 albertel 8294: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
8295: $value =~ tr/+/ /;
8296: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 8297: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 8298: }
1.16 harris41 8299: }
1.6 albertel 8300: }
8301:
1.112 bowersj2 8302: =pod
8303:
1.648 raeburn 8304: =item * &cacheheader()
1.112 bowersj2 8305:
8306: returns cache-controlling header code
8307:
8308: =cut
8309:
1.7 albertel 8310: sub cacheheader {
1.258 albertel 8311: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 8312: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
8313: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 8314: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
8315: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 8316: return $output;
1.7 albertel 8317: }
8318:
1.112 bowersj2 8319: =pod
8320:
1.648 raeburn 8321: =item * &no_cache($r)
1.112 bowersj2 8322:
8323: specifies header code to not have cache
8324:
8325: =cut
8326:
1.9 albertel 8327: sub no_cache {
1.216 albertel 8328: my ($r) = @_;
8329: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 8330: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 8331: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
8332: $r->no_cache(1);
8333: $r->header_out("Expires" => $date);
8334: $r->header_out("Pragma" => "no-cache");
1.123 www 8335: }
8336:
8337: sub content_type {
1.181 albertel 8338: my ($r,$type,$charset) = @_;
1.299 foxr 8339: if ($r) {
8340: # Note that printout.pl calls this with undef for $r.
8341: &no_cache($r);
8342: }
1.258 albertel 8343: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 8344: unless ($charset) {
8345: $charset=&Apache::lonlocal::current_encoding;
8346: }
8347: if ($charset) { $type.='; charset='.$charset; }
8348: if ($r) {
8349: $r->content_type($type);
8350: } else {
8351: print("Content-type: $type\n\n");
8352: }
1.9 albertel 8353: }
1.25 albertel 8354:
1.112 bowersj2 8355: =pod
8356:
1.648 raeburn 8357: =item * &add_to_env($name,$value)
1.112 bowersj2 8358:
1.258 albertel 8359: adds $name to the %env hash with value
1.112 bowersj2 8360: $value, if $name already exists, the entry is converted to an array
8361: reference and $value is added to the array.
8362:
8363: =cut
8364:
1.25 albertel 8365: sub add_to_env {
8366: my ($name,$value)=@_;
1.258 albertel 8367: if (defined($env{$name})) {
8368: if (ref($env{$name})) {
1.25 albertel 8369: #already have multiple values
1.258 albertel 8370: push(@{ $env{$name} },$value);
1.25 albertel 8371: } else {
8372: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 8373: my $first=$env{$name};
8374: undef($env{$name});
8375: push(@{ $env{$name} },$first,$value);
1.25 albertel 8376: }
8377: } else {
1.258 albertel 8378: $env{$name}=$value;
1.25 albertel 8379: }
1.31 albertel 8380: }
1.149 albertel 8381:
8382: =pod
8383:
1.648 raeburn 8384: =item * &get_env_multiple($name)
1.149 albertel 8385:
1.258 albertel 8386: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 8387: values may be defined and end up as an array ref.
8388:
8389: returns an array of values
8390:
8391: =cut
8392:
8393: sub get_env_multiple {
8394: my ($name) = @_;
8395: my @values;
1.258 albertel 8396: if (defined($env{$name})) {
1.149 albertel 8397: # exists is it an array
1.258 albertel 8398: if (ref($env{$name})) {
8399: @values=@{ $env{$name} };
1.149 albertel 8400: } else {
1.258 albertel 8401: $values[0]=$env{$name};
1.149 albertel 8402: }
8403: }
8404: return(@values);
8405: }
8406:
1.660 raeburn 8407: sub ask_for_embedded_content {
8408: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.987 raeburn 8409: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges);
1.660 raeburn 8410: my $num = 0;
1.987 raeburn 8411: my $numremref = 0;
8412: my $numinvalid = 0;
8413: my $numpathchg = 0;
8414: my $numexisting = 0;
8415: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath);
1.984 raeburn 8416: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
8417: my $current_path='/';
8418: if ($env{'form.currentpath'}) {
8419: $current_path = $env{'form.currentpath'};
8420: }
8421: if ($actionurl eq '/adm/coursegrp_portfolio') {
8422: $udom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8423: $uname = $env{'course.'.$env{'request.course.id'}.'.num'};
8424: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
8425: } else {
8426: $udom = $env{'user.domain'};
8427: $uname = $env{'user.name'};
8428: $url = '/userfiles/portfolio';
8429: }
1.987 raeburn 8430: $toplevel = $url.'/';
1.984 raeburn 8431: $url .= $current_path;
8432: $getpropath = 1;
1.987 raeburn 8433: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
8434: ($actionurl eq '/adm/imsimport')) {
1.984 raeburn 8435: ($uname,my $rest) = ($args->{'current_path'} =~ m{/priv/($match_username)/?(.*)$});
1.987 raeburn 8436: $url = '/home/'.$uname.'/public_html/';
8437: $toplevel = $url;
1.984 raeburn 8438: if ($rest ne '') {
1.987 raeburn 8439: $url .= $rest;
8440: }
8441: } elsif ($actionurl eq '/adm/coursedocs') {
8442: if (ref($args) eq 'HASH') {
8443: $url = $args->{'docs_url'};
8444: $toplevel = $url;
8445: }
8446: }
8447: my $now = time();
8448: foreach my $embed_file (keys(%{$allfiles})) {
8449: my $absolutepath;
8450: if ($embed_file =~ m{^\w+://}) {
8451: $newfiles{$embed_file} = 1;
8452: $mapping{$embed_file} = $embed_file;
8453: } else {
8454: if ($embed_file =~ m{^/}) {
8455: $absolutepath = $embed_file;
8456: $embed_file =~ s{^(/+)}{};
8457: }
8458: if ($embed_file =~ m{/}) {
8459: my ($path,$fname) = ($embed_file =~ m{^(.+)/([^/]*)$});
8460: $path = &check_for_traversal($path,$url,$toplevel);
8461: my $item = $fname;
8462: if ($path ne '') {
8463: $item = $path.'/'.$fname;
8464: $subdependencies{$path}{$fname} = 1;
8465: } else {
8466: $dependencies{$item} = 1;
8467: }
8468: if ($absolutepath) {
8469: $mapping{$item} = $absolutepath;
8470: } else {
8471: $mapping{$item} = $embed_file;
8472: }
8473: } else {
8474: $dependencies{$embed_file} = 1;
8475: if ($absolutepath) {
8476: $mapping{$embed_file} = $absolutepath;
8477: } else {
8478: $mapping{$embed_file} = $embed_file;
8479: }
8480: }
1.984 raeburn 8481: }
8482: }
8483: foreach my $path (keys(%subdependencies)) {
8484: my %currsubfile;
8485: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
8486: my @subdir_list = &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
8487: foreach my $line (@subdir_list) {
8488: my ($file_name,$rest) = split(/\&/,$line,2);
8489: $currsubfile{$file_name} = 1;
8490: }
1.987 raeburn 8491: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 8492: if (opendir(my $dir,$url.'/'.$path)) {
8493: my @subdir_list = grep(!/^\./,readdir($dir));
8494: map {$currsubfile{$_} = 1;} @subdir_list;
8495: }
8496: }
8497: foreach my $file (keys(%{$subdependencies{$path}})) {
1.987 raeburn 8498: if ($currsubfile{$file}) {
8499: my $item = $path.'/'.$file;
8500: unless ($mapping{$item} eq $item) {
8501: $pathchanges{$item} = 1;
8502: }
8503: $existing{$item} = 1;
8504: $numexisting ++;
8505: } else {
8506: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 8507: }
8508: }
8509: }
1.987 raeburn 8510: my %currfile;
1.984 raeburn 8511: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
8512: my @dir_list = &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
8513: foreach my $line (@dir_list) {
8514: my ($file_name,$rest) = split(/\&/,$line,2);
8515: $currfile{$file_name} = 1;
8516: }
1.987 raeburn 8517: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 8518: if (opendir(my $dir,$url)) {
1.987 raeburn 8519: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 8520: map {$currfile{$_} = 1;} @dir_list;
8521: }
8522: }
8523: foreach my $file (keys(%dependencies)) {
1.987 raeburn 8524: if ($currfile{$file}) {
8525: unless ($mapping{$file} eq $file) {
8526: $pathchanges{$file} = 1;
8527: }
8528: $existing{$file} = 1;
8529: $numexisting ++;
8530: } else {
1.984 raeburn 8531: $newfiles{$file} = 1;
8532: }
8533: }
8534: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.660 raeburn 8535: $upload_output .= &start_data_table_row().
1.987 raeburn 8536: '<td><span class="LC_filename">'.$embed_file.'</span>';
8537: unless ($mapping{$embed_file} eq $embed_file) {
8538: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.&mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
8539: }
8540: $upload_output .= '</td><td>';
1.660 raeburn 8541: if ($args->{'ignore_remote_references'}
8542: && $embed_file =~ m{^\w+://}) {
8543: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
1.987 raeburn 8544: $numremref++;
1.660 raeburn 8545: } elsif ($args->{'error_on_invalid_names'}
8546: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
8547:
1.987 raeburn 8548: $upload_output.='<span class="LC_warning">'.&mt('Invalid characters').'</span>';
8549: $numinvalid++;
1.660 raeburn 8550: } else {
1.987 raeburn 8551: $upload_output .= &embedded_file_element('upload_embedded',$num,
8552: $embed_file,\%mapping,
8553: $allfiles,$codebase);
8554: $num++;
8555: }
8556: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
8557: }
8558: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
8559: $upload_output .= &start_data_table_row().
8560: '<td><span class="LC_filename">'.$embed_file.'</span></td>'.
8561: '<td><span class="LC_warning">'.&mt('Already exists').'</span></td>'.
8562: &Apache::loncommon::end_data_table_row()."\n";
8563: }
8564: if ($upload_output) {
8565: $upload_output = &start_data_table().
8566: $upload_output.
8567: &end_data_table()."\n";
8568: }
8569: my $applies = 0;
8570: if ($numremref) {
8571: $applies ++;
8572: }
8573: if ($numinvalid) {
8574: $applies ++;
8575: }
8576: if ($numexisting) {
8577: $applies ++;
8578: }
8579: if ($num) {
8580: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
8581: ' method="post" enctype="multipart/form-data">'."\n".
8582: $state.
8583: '<h3>'.&mt('Upload embedded files').
8584: ':</h3>'.$upload_output.'<br />'."\n".
8585: '<input type ="hidden" name="number_embedded_items" value="'.
8586: $num.'" />'."\n";
8587: if ($actionurl eq '') {
8588: $output .= '<input type="hidden" name="phase" value="three" />';
8589: }
8590: } elsif ($applies) {
8591: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
8592: if ($applies > 1) {
8593: $output .=
8594: &mt('No files need to be uploaded, as one of the following applies to each reference:').'<ul>';
8595: if ($numremref) {
8596: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
8597: }
8598: if ($numinvalid) {
8599: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
8600: }
8601: if ($numexisting) {
8602: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
8603: }
8604: $output .= '</ul><br />';
8605: } elsif ($numremref) {
8606: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
8607: } elsif ($numinvalid) {
8608: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
8609: } elsif ($numexisting) {
8610: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
8611: }
8612: $output .= $upload_output.'<br />';
8613: }
8614: my ($pathchange_output,$chgcount);
8615: $chgcount = $num;
8616: if (keys(%pathchanges) > 0) {
8617: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
8618: if ($num) {
8619: $output .= &embedded_file_element('pathchange',$chgcount,
8620: $embed_file,\%mapping,
8621: $allfiles,$codebase);
8622: } else {
8623: $pathchange_output .=
8624: &start_data_table_row().
8625: '<td><input type ="checkbox" name="namechange" value="'.
8626: $chgcount.'" checked="checked" /></td>'.
8627: '<td>'.$mapping{$embed_file}.'</td>'.
8628: '<td>'.$embed_file.
8629: &embedded_file_element('pathchange',$numpathchg,$embed_file,
8630: \%mapping,$allfiles,$codebase).
8631: '</td>'.&end_data_table_row();
1.660 raeburn 8632: }
1.987 raeburn 8633: $numpathchg ++;
8634: $chgcount ++;
1.660 raeburn 8635: }
8636: }
1.984 raeburn 8637: if ($num) {
1.987 raeburn 8638: if ($numpathchg) {
8639: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
8640: $numpathchg.'" />'."\n";
8641: }
8642: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
8643: ($actionurl eq '/adm/imsimport')) {
8644: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
8645: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
8646: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
8647: }
8648: $output .= '<input type ="submit" value="'.&mt('Upload Listed Files').'" />'."\n".
8649: &mt('(only files for which a location has been provided will be uploaded)').'</form>'."\n";
8650: } elsif ($numpathchg) {
8651: my %pathchange = ();
8652: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
8653: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
8654: $output .= '<p>'.&mt('or').'</p>';
8655: }
8656: }
8657: return ($output,$num,$numpathchg);
8658: }
8659:
8660: sub embedded_file_element {
8661: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase) = @_;
8662: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
8663: (ref($codebase) eq 'HASH'));
8664: my $output;
8665: if ($context eq 'upload_embedded') {
8666: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
8667: }
8668: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
8669: &escape($embed_file).'" />';
8670: unless (($context eq 'upload_embedded') &&
8671: ($mapping->{$embed_file} eq $embed_file)) {
8672: $output .='
8673: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
8674: }
8675: my $attrib;
8676: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
8677: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
8678: }
8679: $output .=
8680: "\n\t\t".
8681: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
8682: $attrib.'" />';
8683: if (exists($codebase->{$mapping->{$embed_file}})) {
8684: $output .=
8685: "\n\t\t".
8686: '<input name="codebase_'.$num.'" type="hidden" value="'.
8687: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 8688: }
1.987 raeburn 8689: return $output;
1.660 raeburn 8690: }
8691:
1.661 raeburn 8692: sub upload_embedded {
8693: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 8694: $current_disk_usage,$hiddenstate,$actionurl) = @_;
8695: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 8696: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
8697: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
8698: my $orig_uploaded_filename =
8699: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 8700: foreach my $type ('orig','ref','attrib','codebase') {
8701: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
8702: $env{'form.embedded_'.$type.'_'.$i} =
8703: &unescape($env{'form.embedded_'.$type.'_'.$i});
8704: }
8705: }
1.661 raeburn 8706: my ($path,$fname) =
8707: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
8708: # no path, whole string is fname
8709: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
8710: $fname = &Apache::lonnet::clean_filename($fname);
8711: # See if there is anything left
8712: next if ($fname eq '');
8713:
8714: # Check if file already exists as a file or directory.
8715: my ($state,$msg);
8716: if ($context eq 'portfolio') {
8717: my $port_path = $dirpath;
8718: if ($group ne '') {
8719: $port_path = "groups/$group/$port_path";
8720: }
1.987 raeburn 8721: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
8722: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 8723: $dir_root,$port_path,$disk_quota,
8724: $current_disk_usage,$uname,$udom);
8725: if ($state eq 'will_exceed_quota'
1.984 raeburn 8726: || $state eq 'file_locked') {
1.661 raeburn 8727: $output .= $msg;
8728: next;
8729: }
8730: } elsif (($context eq 'author') || ($context eq 'testbank')) {
8731: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
8732: if ($state eq 'exists') {
8733: $output .= $msg;
8734: next;
8735: }
8736: }
8737: # Check if extension is valid
8738: if (($fname =~ /\.(\w+)$/) &&
8739: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.987 raeburn 8740: $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 8741: next;
8742: } elsif (($fname =~ /\.(\w+)$/) &&
8743: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 8744: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 8745: next;
8746: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.987 raeburn 8747: $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 8748: next;
8749: }
8750:
8751: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
8752: if ($context eq 'portfolio') {
1.984 raeburn 8753: my $result;
8754: if ($state eq 'existingfile') {
8755: $result=
8756: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.987 raeburn 8757: $dirpath.$env{'form.currentpath'}.$path);
1.661 raeburn 8758: } else {
1.984 raeburn 8759: $result=
8760: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 8761: $dirpath.
8762: $env{'form.currentpath'}.$path);
1.984 raeburn 8763: if ($result !~ m|^/uploaded/|) {
8764: $output .= '<span class="LC_error">'
8765: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
8766: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
8767: .'</span><br />';
8768: next;
8769: } else {
1.987 raeburn 8770: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
8771: $path.$fname.'</span>').'<br />';
1.984 raeburn 8772: }
1.661 raeburn 8773: }
1.987 raeburn 8774: } elsif ($context eq 'coursedoc') {
8775: my $result =
8776: &Apache::lonnet::userfileupload('embedded_item_'.$i,'coursedoc',
8777: $dirpath.'/'.$path);
8778: if ($result !~ m|^/uploaded/|) {
8779: $output .= '<span class="LC_error">'
8780: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
8781: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
8782: .'</span><br />';
8783: next;
8784: } else {
8785: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
8786: $path.$fname.'</span>').'<br />';
8787: }
1.661 raeburn 8788: } else {
8789: # Save the file
8790: my $target = $env{'form.embedded_item_'.$i};
8791: my $fullpath = $dir_root.$dirpath.'/'.$path;
8792: my $dest = $fullpath.$fname;
8793: my $url = $url_root.$dirpath.'/'.$path.$fname;
8794: my @parts=split(/\//,$fullpath);
8795: my $count;
8796: my $filepath = $dir_root;
8797: for ($count=4;$count<=$#parts;$count++) {
8798: $filepath .= "/$parts[$count]";
8799: if ((-e $filepath)!=1) {
8800: mkdir($filepath,0770);
8801: }
8802: }
8803: my $fh;
8804: if (!open($fh,'>'.$dest)) {
8805: &Apache::lonnet::logthis('Failed to create '.$dest);
8806: $output .= '<span class="LC_error">'.
8807: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8808: '</span><br />';
8809: } else {
8810: if (!print $fh $env{'form.embedded_item_'.$i}) {
8811: &Apache::lonnet::logthis('Failed to write to '.$dest);
8812: $output .= '<span class="LC_error">'.
8813: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8814: '</span><br />';
8815: } else {
1.987 raeburn 8816: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
8817: $url.'</span>').'<br />';
8818: unless ($context eq 'testbank') {
8819: $footer .= &mt('View embedded file: [_1]',
8820: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
8821: }
8822: }
8823: close($fh);
8824: }
8825: }
8826: if ($env{'form.embedded_ref_'.$i}) {
8827: $pathchange{$i} = 1;
8828: }
8829: }
8830: if ($output) {
8831: $output = '<p>'.$output.'</p>';
8832: }
8833: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
8834: $returnflag = 'ok';
8835: if (keys(%pathchange) > 0) {
8836: if ($context eq 'portfolio') {
8837: $output .= '<p>'.&mt('or').'</p>';
8838: } elsif ($context eq 'testbank') {
1.988 raeburn 8839: $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 8840: $returnflag = 'modify_orightml';
8841: }
8842: }
8843: return ($output.$footer,$returnflag);
8844: }
8845:
8846: sub modify_html_form {
8847: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
8848: my $end = 0;
8849: my $modifyform;
8850: if ($context eq 'upload_embedded') {
8851: return unless (ref($pathchange) eq 'HASH');
8852: if ($env{'form.number_embedded_items'}) {
8853: $end += $env{'form.number_embedded_items'};
8854: }
8855: if ($env{'form.number_pathchange_items'}) {
8856: $end += $env{'form.number_pathchange_items'};
8857: }
8858: if ($end) {
8859: for (my $i=0; $i<$end; $i++) {
8860: if ($i < $env{'form.number_embedded_items'}) {
8861: next unless($pathchange->{$i});
8862: }
8863: $modifyform .=
8864: &start_data_table_row().
8865: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
8866: 'checked="checked" /></td>'.
8867: '<td>'.$env{'form.embedded_ref_'.$i}.
8868: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
8869: &escape($env{'form.embedded_ref_'.$i}).'" />'.
8870: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
8871: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
8872: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
8873: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
8874: '<td>'.$env{'form.embedded_orig_'.$i}.
8875: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
8876: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
8877: &end_data_table_row();
8878: }
8879: }
8880: } else {
8881: $modifyform = $pathchgtable;
8882: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
8883: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
8884: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
8885: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
8886: }
8887: }
8888: if ($modifyform) {
8889: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
8890: '<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".
8891: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
8892: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
8893: '</ol></p>'."\n".'<p>'.
8894: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
8895: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
8896: &start_data_table()."\n".
8897: &start_data_table_header_row().
8898: '<th>'.&mt('Change?').'</th>'.
8899: '<th>'.&mt('Current reference').'</th>'.
8900: '<th>'.&mt('Required reference').'</th>'.
8901: &end_data_table_header_row()."\n".
8902: $modifyform.
8903: &end_data_table().'<br />'."\n".$hiddenstate.
8904: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
8905: '</form>'."\n";
8906: }
8907: return;
8908: }
8909:
8910: sub modify_html_refs {
8911: my ($context,$dirpath,$uname,$udom,$dir_root) = @_;
8912: my $container;
8913: if ($context eq 'portfolio') {
8914: $container = $env{'form.container'};
8915: } elsif ($context eq 'coursedoc') {
8916: $container = $env{'form.primaryurl'};
8917: } else {
8918: $container = $env{'form.filename'};
8919: $container =~ s{^/priv/(\Q$uname\E)/(.*)}{/home/$1/public_html/$2};
8920: }
8921: my (%allfiles,%codebase,$output,$content);
8922: my @changes = &get_env_multiple('form.namechange');
8923: return unless (@changes > 0);
8924: if (($context eq 'portfolio') || ($context eq 'coursedoc')) {
8925: return unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/});
8926: $content = &Apache::lonnet::getfile($container);
8927: return if ($content eq '-1');
8928: } else {
8929: return unless ($container =~ /^\Q$dir_root\E/);
8930: if (open(my $fh,"<$container")) {
8931: $content = join('', <$fh>);
8932: close($fh);
8933: } else {
8934: return;
8935: }
8936: }
8937: my ($count,$codebasecount) = (0,0);
8938: my $mm = new File::MMagic;
8939: my $mime_type = $mm->checktype_contents($content);
8940: if ($mime_type eq 'text/html') {
8941: my $parse_result =
8942: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
8943: \%codebase,\$content);
8944: if ($parse_result eq 'ok') {
8945: foreach my $i (@changes) {
8946: my $orig = &unescape($env{'form.embedded_orig_'.$i});
8947: my $ref = &unescape($env{'form.embedded_ref_'.$i});
8948: if ($allfiles{$ref}) {
8949: my $newname = $orig;
8950: my ($attrib_regexp,$codebase);
1.1006 raeburn 8951: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 8952: if ($attrib_regexp =~ /:/) {
8953: $attrib_regexp =~ s/\:/|/g;
8954: }
8955: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
8956: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
8957: $count += $numchg;
8958: }
8959: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 8960: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 8961: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
8962: $codebasecount ++;
8963: }
8964: }
8965: }
8966: if ($count || $codebasecount) {
8967: my $saveresult;
8968: if ($context eq 'portfolio' || $context eq 'coursedoc') {
8969: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
8970: if ($url eq $container) {
8971: my ($fname) = ($container =~ m{/([^/]+)$});
8972: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
8973: $count,'<span class="LC_filename">'.
8974: $fname.'</span>').'</p>';
8975: } else {
8976: $output = '<p class="LC_error">'.
8977: &mt('Error: update failed for: [_1].',
8978: '<span class="LC_filename">'.
8979: $container.'</span>').'</p>';
8980: }
8981: } else {
8982: if (open(my $fh,">$container")) {
8983: print $fh $content;
8984: close($fh);
8985: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
8986: $count,'<span class="LC_filename">'.
8987: $container.'</span>').'</p>';
1.661 raeburn 8988: } else {
1.987 raeburn 8989: $output = '<p class="LC_error">'.
8990: &mt('Error: could not update [_1].',
8991: '<span class="LC_filename">'.
8992: $container.'</span>').'</p>';
1.661 raeburn 8993: }
8994: }
8995: }
1.987 raeburn 8996: } else {
8997: &logthis('Failed to parse '.$container.
8998: ' to modify references: '.$parse_result);
1.661 raeburn 8999: }
9000: }
9001: return $output;
9002: }
9003:
9004: sub check_for_existing {
9005: my ($path,$fname,$element) = @_;
9006: my ($state,$msg);
9007: if (-d $path.'/'.$fname) {
9008: $state = 'exists';
9009: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
9010: } elsif (-e $path.'/'.$fname) {
9011: $state = 'exists';
9012: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
9013: }
9014: if ($state eq 'exists') {
9015: $msg = '<span class="LC_error">'.$msg.'</span><br />';
9016: }
9017: return ($state,$msg);
9018: }
9019:
9020: sub check_for_upload {
9021: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
9022: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 9023: my $filesize = length($env{'form.'.$element});
9024: if (!$filesize) {
9025: my $msg = '<span class="LC_error">'.
9026: &mt('Unable to upload [_1]. (size = [_2] bytes)',
9027: '<span class="LC_filename">'.$fname.'</span>',
9028: $filesize).'<br />'.
1.1007 raeburn 9029: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 9030: '</span>';
9031: return ('zero_bytes',$msg);
9032: }
9033: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 9034: my $getpropath = 1;
9035: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
9036: $getpropath);
9037: my $found_file = 0;
9038: my $locked_file = 0;
1.991 raeburn 9039: my @lockers;
9040: my $navmap;
9041: if ($env{'request.course.id'}) {
9042: $navmap = Apache::lonnavmaps::navmap->new();
9043: }
1.661 raeburn 9044: foreach my $line (@dir_list) {
1.984 raeburn 9045: my ($file_name,$rest)=split(/\&/,$line,2);
1.661 raeburn 9046: if ($file_name eq $fname){
9047: $file_name = $path.$file_name;
9048: if ($group ne '') {
9049: $file_name = $group.$file_name;
9050: }
9051: $found_file = 1;
1.991 raeburn 9052: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
9053: foreach my $lock (@lockers) {
9054: if (ref($lock) eq 'ARRAY') {
9055: my ($symb,$crsid) = @{$lock};
9056: if ($crsid eq $env{'request.course.id'}) {
9057: if (ref($navmap)) {
9058: my $res = $navmap->getBySymb($symb);
9059: foreach my $part (@{$res->parts()}) {
9060: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
9061: unless (($slot_status == $res->RESERVED) ||
9062: ($slot_status == $res->RESERVED_LOCATION)) {
9063: $locked_file = 1;
9064: }
9065: }
9066: } else {
9067: $locked_file = 1;
9068: }
9069: } else {
9070: $locked_file = 1;
9071: }
9072: }
9073: }
1.984 raeburn 9074: } else {
9075: my @info = split(/\&/,$rest);
9076: my $currsize = $info[6]/1000;
9077: if ($currsize < $filesize) {
9078: my $extra = $filesize - $currsize;
9079: if (($current_disk_usage + $extra) > $disk_quota) {
9080: my $msg = '<span class="LC_error">'.
9081: &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.',
9082: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</span>'.
9083: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
9084: $disk_quota,$current_disk_usage);
9085: return ('will_exceed_quota',$msg);
9086: }
9087: }
1.661 raeburn 9088: }
9089: }
9090: }
9091: if (($current_disk_usage + $filesize) > $disk_quota){
9092: my $msg = '<span class="LC_error">'.
9093: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
9094: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
9095: return ('will_exceed_quota',$msg);
9096: } elsif ($found_file) {
9097: if ($locked_file) {
9098: my $msg = '<span class="LC_error">';
9099: $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>');
9100: $msg .= '</span><br />';
9101: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
9102: return ('file_locked',$msg);
9103: } else {
9104: my $msg = '<span class="LC_error">';
1.984 raeburn 9105: $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 9106: $msg .= '</span>';
1.984 raeburn 9107: return ('existingfile',$msg);
1.661 raeburn 9108: }
9109: }
9110: }
9111:
1.987 raeburn 9112: sub check_for_traversal {
9113: my ($path,$url,$toplevel) = @_;
9114: my @parts=split(/\//,$path);
9115: my $cleanpath;
9116: my $fullpath = $url;
9117: for (my $i=0;$i<@parts;$i++) {
9118: next if ($parts[$i] eq '.');
9119: if ($parts[$i] eq '..') {
9120: $fullpath =~ s{([^/]+/)$}{};
9121: } else {
9122: $fullpath .= $parts[$i].'/';
9123: }
9124: }
9125: if ($fullpath =~ /^\Q$url\E(.*)$/) {
9126: $cleanpath = $1;
9127: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
9128: my $curr_toprel = $1;
9129: my @parts = split(/\//,$curr_toprel);
9130: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
9131: my @urlparts = split(/\//,$url_toprel);
9132: my $doubledots;
9133: my $startdiff = -1;
9134: for (my $i=0; $i<@urlparts; $i++) {
9135: if ($startdiff == -1) {
9136: unless ($urlparts[$i] eq $parts[$i]) {
9137: $startdiff = $i;
9138: $doubledots .= '../';
9139: }
9140: } else {
9141: $doubledots .= '../';
9142: }
9143: }
9144: if ($startdiff > -1) {
9145: $cleanpath = $doubledots;
9146: for (my $i=$startdiff; $i<@parts; $i++) {
9147: $cleanpath .= $parts[$i].'/';
9148: }
9149: }
9150: }
9151: $cleanpath =~ s{(/)$}{};
9152: return $cleanpath;
9153: }
1.31 albertel 9154:
1.41 ng 9155: =pod
1.45 matthew 9156:
1.1015 raeburn 9157: =item * &get_turnedin_filepath()
9158:
9159: Determines path in a user's portfolio file for storage of files uploaded
9160: to a specific essayresponse or dropbox item.
9161:
9162: Inputs: 3 required + 1 optional.
9163: $symb is symb for resource, $uname and $udom are for current user (required).
9164: $caller is optional (can be "submission", if routine is called when storing
9165: an upoaded file when "Submit Answer" button was pressed).
9166:
9167: Returns array containing $path and $multiresp.
9168: $path is path in portfolio. $multiresp is 1 if this resource contains more
9169: than one file upload item. Callers of routine should append partid as a
9170: subdirectory to $path in cases where $multiresp is 1.
9171:
9172: Called by: homework/essayresponse.pm and homework/structuretags.pm
9173:
9174: =cut
9175:
9176: sub get_turnedin_filepath {
9177: my ($symb,$uname,$udom,$caller) = @_;
9178: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
9179: my $turnindir;
9180: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
9181: $turnindir = $userhash{'turnindir'};
9182: my ($path,$multiresp);
9183: if ($turnindir eq '') {
9184: if ($caller eq 'submission') {
9185: $turnindir = &mt('turned in');
9186: $turnindir =~ s/\W+/_/g;
9187: my %newhash = (
9188: 'turnindir' => $turnindir,
9189: );
9190: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
9191: }
9192: }
9193: if ($turnindir ne '') {
9194: $path = '/'.$turnindir.'/';
9195: my ($multipart,$turnin,@pathitems);
9196: my $navmap = Apache::lonnavmaps::navmap->new();
9197: if (defined($navmap)) {
9198: my $mapres = $navmap->getResourceByUrl($map);
9199: if (ref($mapres)) {
9200: my $pcslist = $mapres->map_hierarchy();
9201: if ($pcslist ne '') {
9202: foreach my $pc (split(/,/,$pcslist)) {
9203: my $res = $navmap->getByMapPc($pc);
9204: if (ref($res)) {
9205: my $title = $res->compTitle();
9206: $title =~ s/\W+/_/g;
9207: if ($title ne '') {
9208: push(@pathitems,$title);
9209: }
9210: }
9211: }
9212: }
9213: my $maptitle = $mapres->compTitle();
9214: $maptitle =~ s/\W+/_/g;
9215: if ($maptitle ne '') {
9216: push(@pathitems,$maptitle);
9217: }
9218: unless ($env{'request.state'} eq 'construct') {
9219: my $res = $navmap->getBySymb($symb);
9220: if (ref($res)) {
9221: my $partlist = $res->parts();
9222: my $totaluploads = 0;
9223: if (ref($partlist) eq 'ARRAY') {
9224: foreach my $part (@{$partlist}) {
9225: my @types = $res->responseType($part);
9226: my @ids = $res->responseIds($part);
9227: for (my $i=0; $i < scalar(@ids); $i++) {
9228: if ($types[$i] eq 'essay') {
9229: my $partid = $part.'_'.$ids[$i];
9230: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
9231: $totaluploads ++;
9232: }
9233: }
9234: }
9235: }
9236: if ($totaluploads > 1) {
9237: $multiresp = 1;
9238: }
9239: }
9240: }
9241: }
9242: } else {
9243: return;
9244: }
9245: } else {
9246: return;
9247: }
9248: my $restitle=&Apache::lonnet::gettitle($symb);
9249: $restitle =~ s/\W+/_/g;
9250: if ($restitle eq '') {
9251: $restitle = ($resurl =~ m{/[^/]+$});
9252: if ($restitle eq '') {
9253: $restitle = time;
9254: }
9255: }
9256: push(@pathitems,$restitle);
9257: $path .= join('/',@pathitems);
9258: }
9259: return ($path,$multiresp);
9260: }
9261:
9262: =pod
9263:
1.464 albertel 9264: =back
1.41 ng 9265:
1.112 bowersj2 9266: =head1 CSV Upload/Handling functions
1.38 albertel 9267:
1.41 ng 9268: =over 4
9269:
1.648 raeburn 9270: =item * &upfile_store($r)
1.41 ng 9271:
9272: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 9273: needs $env{'form.upfile'}
1.41 ng 9274: returns $datatoken to be put into hidden field
9275:
9276: =cut
1.31 albertel 9277:
9278: sub upfile_store {
9279: my $r=shift;
1.258 albertel 9280: $env{'form.upfile'}=~s/\r/\n/gs;
9281: $env{'form.upfile'}=~s/\f/\n/gs;
9282: $env{'form.upfile'}=~s/\n+/\n/gs;
9283: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 9284:
1.258 albertel 9285: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
9286: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 9287: {
1.158 raeburn 9288: my $datafile = $r->dir_config('lonDaemons').
9289: '/tmp/'.$datatoken.'.tmp';
9290: if ( open(my $fh,">$datafile") ) {
1.258 albertel 9291: print $fh $env{'form.upfile'};
1.158 raeburn 9292: close($fh);
9293: }
1.31 albertel 9294: }
9295: return $datatoken;
9296: }
9297:
1.56 matthew 9298: =pod
9299:
1.648 raeburn 9300: =item * &load_tmp_file($r)
1.41 ng 9301:
9302: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 9303: needs $env{'form.datatoken'},
9304: sets $env{'form.upfile'} to the contents of the file
1.41 ng 9305:
9306: =cut
1.31 albertel 9307:
9308: sub load_tmp_file {
9309: my $r=shift;
9310: my @studentdata=();
9311: {
1.158 raeburn 9312: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 9313: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 9314: if ( open(my $fh,"<$studentfile") ) {
9315: @studentdata=<$fh>;
9316: close($fh);
9317: }
1.31 albertel 9318: }
1.258 albertel 9319: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 9320: }
9321:
1.56 matthew 9322: =pod
9323:
1.648 raeburn 9324: =item * &upfile_record_sep()
1.41 ng 9325:
9326: Separate uploaded file into records
9327: returns array of records,
1.258 albertel 9328: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 9329:
9330: =cut
1.31 albertel 9331:
9332: sub upfile_record_sep {
1.258 albertel 9333: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 9334: } else {
1.248 albertel 9335: my @records;
1.258 albertel 9336: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 9337: if ($line=~/^\s*$/) { next; }
9338: push(@records,$line);
9339: }
9340: return @records;
1.31 albertel 9341: }
9342: }
9343:
1.56 matthew 9344: =pod
9345:
1.648 raeburn 9346: =item * &record_sep($record)
1.41 ng 9347:
1.258 albertel 9348: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 9349:
9350: =cut
9351:
1.263 www 9352: sub takeleft {
9353: my $index=shift;
9354: return substr('0000'.$index,-4,4);
9355: }
9356:
1.31 albertel 9357: sub record_sep {
9358: my $record=shift;
9359: my %components=();
1.258 albertel 9360: if ($env{'form.upfiletype'} eq 'xml') {
9361: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 9362: my $i=0;
1.356 albertel 9363: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 9364: $field=~s/^(\"|\')//;
9365: $field=~s/(\"|\')$//;
1.263 www 9366: $components{&takeleft($i)}=$field;
1.31 albertel 9367: $i++;
9368: }
1.258 albertel 9369: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 9370: my $i=0;
1.356 albertel 9371: foreach my $field (split(/\t/,$record)) {
1.31 albertel 9372: $field=~s/^(\"|\')//;
9373: $field=~s/(\"|\')$//;
1.263 www 9374: $components{&takeleft($i)}=$field;
1.31 albertel 9375: $i++;
9376: }
9377: } else {
1.561 www 9378: my $separator=',';
1.480 banghart 9379: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 9380: $separator=';';
1.480 banghart 9381: }
1.31 albertel 9382: my $i=0;
1.561 www 9383: # the character we are looking for to indicate the end of a quote or a record
9384: my $looking_for=$separator;
9385: # do not add the characters to the fields
9386: my $ignore=0;
9387: # we just encountered a separator (or the beginning of the record)
9388: my $just_found_separator=1;
9389: # store the field we are working on here
9390: my $field='';
9391: # work our way through all characters in record
9392: foreach my $character ($record=~/(.)/g) {
9393: if ($character eq $looking_for) {
9394: if ($character ne $separator) {
9395: # Found the end of a quote, again looking for separator
9396: $looking_for=$separator;
9397: $ignore=1;
9398: } else {
9399: # Found a separator, store away what we got
9400: $components{&takeleft($i)}=$field;
9401: $i++;
9402: $just_found_separator=1;
9403: $ignore=0;
9404: $field='';
9405: }
9406: next;
9407: }
9408: # single or double quotation marks after a separator indicate beginning of a quote
9409: # we are now looking for the end of the quote and need to ignore separators
9410: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
9411: $looking_for=$character;
9412: next;
9413: }
9414: # ignore would be true after we reached the end of a quote
9415: if ($ignore) { next; }
9416: if (($just_found_separator) && ($character=~/\s/)) { next; }
9417: $field.=$character;
9418: $just_found_separator=0;
1.31 albertel 9419: }
1.561 www 9420: # catch the very last entry, since we never encountered the separator
9421: $components{&takeleft($i)}=$field;
1.31 albertel 9422: }
9423: return %components;
9424: }
9425:
1.144 matthew 9426: ######################################################
9427: ######################################################
9428:
1.56 matthew 9429: =pod
9430:
1.648 raeburn 9431: =item * &upfile_select_html()
1.41 ng 9432:
1.144 matthew 9433: Return HTML code to select a file from the users machine and specify
9434: the file type.
1.41 ng 9435:
9436: =cut
9437:
1.144 matthew 9438: ######################################################
9439: ######################################################
1.31 albertel 9440: sub upfile_select_html {
1.144 matthew 9441: my %Types = (
9442: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 9443: semisv => &mt('Semicolon separated values'),
1.144 matthew 9444: space => &mt('Space separated'),
9445: tab => &mt('Tabulator separated'),
9446: # xml => &mt('HTML/XML'),
9447: );
9448: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 9449: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 9450: foreach my $type (sort(keys(%Types))) {
9451: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
9452: }
9453: $Str .= "</select>\n";
9454: return $Str;
1.31 albertel 9455: }
9456:
1.301 albertel 9457: sub get_samples {
9458: my ($records,$toget) = @_;
9459: my @samples=({});
9460: my $got=0;
9461: foreach my $rec (@$records) {
9462: my %temp = &record_sep($rec);
9463: if (! grep(/\S/, values(%temp))) { next; }
9464: if (%temp) {
9465: $samples[$got]=\%temp;
9466: $got++;
9467: if ($got == $toget) { last; }
9468: }
9469: }
9470: return \@samples;
9471: }
9472:
1.144 matthew 9473: ######################################################
9474: ######################################################
9475:
1.56 matthew 9476: =pod
9477:
1.648 raeburn 9478: =item * &csv_print_samples($r,$records)
1.41 ng 9479:
9480: Prints a table of sample values from each column uploaded $r is an
9481: Apache Request ref, $records is an arrayref from
9482: &Apache::loncommon::upfile_record_sep
9483:
9484: =cut
9485:
1.144 matthew 9486: ######################################################
9487: ######################################################
1.31 albertel 9488: sub csv_print_samples {
9489: my ($r,$records) = @_;
1.662 bisitz 9490: my $samples = &get_samples($records,5);
1.301 albertel 9491:
1.594 raeburn 9492: $r->print(&mt('Samples').'<br />'.&start_data_table().
9493: &start_data_table_header_row());
1.356 albertel 9494: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 9495: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 9496: $r->print(&end_data_table_header_row());
1.301 albertel 9497: foreach my $hash (@$samples) {
1.594 raeburn 9498: $r->print(&start_data_table_row());
1.356 albertel 9499: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 9500: $r->print('<td>');
1.356 albertel 9501: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 9502: $r->print('</td>');
9503: }
1.594 raeburn 9504: $r->print(&end_data_table_row());
1.31 albertel 9505: }
1.594 raeburn 9506: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 9507: }
9508:
1.144 matthew 9509: ######################################################
9510: ######################################################
9511:
1.56 matthew 9512: =pod
9513:
1.648 raeburn 9514: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 9515:
9516: Prints a table to create associations between values and table columns.
1.144 matthew 9517:
1.41 ng 9518: $r is an Apache Request ref,
9519: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 9520: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 9521:
9522: =cut
9523:
1.144 matthew 9524: ######################################################
9525: ######################################################
1.31 albertel 9526: sub csv_print_select_table {
9527: my ($r,$records,$d) = @_;
1.301 albertel 9528: my $i=0;
9529: my $samples = &get_samples($records,1);
1.144 matthew 9530: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 9531: &start_data_table().&start_data_table_header_row().
1.144 matthew 9532: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 9533: '<th>'.&mt('Column').'</th>'.
9534: &end_data_table_header_row()."\n");
1.356 albertel 9535: foreach my $array_ref (@$d) {
9536: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 9537: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 9538:
1.875 bisitz 9539: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 9540: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 9541: $r->print('<option value="none"></option>');
1.356 albertel 9542: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
9543: $r->print('<option value="'.$sample.'"'.
9544: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 9545: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 9546: }
1.594 raeburn 9547: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 9548: $i++;
9549: }
1.594 raeburn 9550: $r->print(&end_data_table());
1.31 albertel 9551: $i--;
9552: return $i;
9553: }
1.56 matthew 9554:
1.144 matthew 9555: ######################################################
9556: ######################################################
9557:
1.56 matthew 9558: =pod
1.31 albertel 9559:
1.648 raeburn 9560: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 9561:
9562: Prints a table of sample values from the upload and can make associate samples to internal names.
9563:
9564: $r is an Apache Request ref,
9565: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
9566: $d is an array of 2 element arrays (internal name, displayed name)
9567:
9568: =cut
9569:
1.144 matthew 9570: ######################################################
9571: ######################################################
1.31 albertel 9572: sub csv_samples_select_table {
9573: my ($r,$records,$d) = @_;
9574: my $i=0;
1.144 matthew 9575: #
1.662 bisitz 9576: my $max_samples = 5;
9577: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 9578: $r->print(&start_data_table().
9579: &start_data_table_header_row().'<th>'.
9580: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
9581: &end_data_table_header_row());
1.301 albertel 9582:
9583: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 9584: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 9585: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 9586: foreach my $option (@$d) {
9587: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 9588: $r->print('<option value="'.$value.'"'.
1.253 albertel 9589: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 9590: $display.'</option>');
1.31 albertel 9591: }
9592: $r->print('</select></td><td>');
1.662 bisitz 9593: foreach my $line (0..($max_samples-1)) {
1.301 albertel 9594: if (defined($samples->[$line]{$key})) {
9595: $r->print($samples->[$line]{$key}."<br />\n");
9596: }
9597: }
1.594 raeburn 9598: $r->print('</td>'.&end_data_table_row());
1.31 albertel 9599: $i++;
9600: }
1.594 raeburn 9601: $r->print(&end_data_table());
1.31 albertel 9602: $i--;
9603: return($i);
1.115 matthew 9604: }
9605:
1.144 matthew 9606: ######################################################
9607: ######################################################
9608:
1.115 matthew 9609: =pod
9610:
1.648 raeburn 9611: =item * &clean_excel_name($name)
1.115 matthew 9612:
9613: Returns a replacement for $name which does not contain any illegal characters.
9614:
9615: =cut
9616:
1.144 matthew 9617: ######################################################
9618: ######################################################
1.115 matthew 9619: sub clean_excel_name {
9620: my ($name) = @_;
9621: $name =~ s/[:\*\?\/\\]//g;
9622: if (length($name) > 31) {
9623: $name = substr($name,0,31);
9624: }
9625: return $name;
1.25 albertel 9626: }
1.84 albertel 9627:
1.85 albertel 9628: =pod
9629:
1.648 raeburn 9630: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 9631:
9632: Returns either 1 or undef
9633:
9634: 1 if the part is to be hidden, undef if it is to be shown
9635:
9636: Arguments are:
9637:
9638: $id the id of the part to be checked
9639: $symb, optional the symb of the resource to check
9640: $udom, optional the domain of the user to check for
9641: $uname, optional the username of the user to check for
9642:
9643: =cut
1.84 albertel 9644:
9645: sub check_if_partid_hidden {
9646: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 9647: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 9648: $symb,$udom,$uname);
1.141 albertel 9649: my $truth=1;
9650: #if the string starts with !, then the list is the list to show not hide
9651: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 9652: my @hiddenlist=split(/,/,$hiddenparts);
9653: foreach my $checkid (@hiddenlist) {
1.141 albertel 9654: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 9655: }
1.141 albertel 9656: return !$truth;
1.84 albertel 9657: }
1.127 matthew 9658:
1.138 matthew 9659:
9660: ############################################################
9661: ############################################################
9662:
9663: =pod
9664:
1.157 matthew 9665: =back
9666:
1.138 matthew 9667: =head1 cgi-bin script and graphing routines
9668:
1.157 matthew 9669: =over 4
9670:
1.648 raeburn 9671: =item * &get_cgi_id()
1.138 matthew 9672:
9673: Inputs: none
9674:
9675: Returns an id which can be used to pass environment variables
9676: to various cgi-bin scripts. These environment variables will
9677: be removed from the users environment after a given time by
9678: the routine &Apache::lonnet::transfer_profile_to_env.
9679:
9680: =cut
9681:
9682: ############################################################
9683: ############################################################
1.152 albertel 9684: my $uniq=0;
1.136 matthew 9685: sub get_cgi_id {
1.154 albertel 9686: $uniq=($uniq+1)%100000;
1.280 albertel 9687: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 9688: }
9689:
1.127 matthew 9690: ############################################################
9691: ############################################################
9692:
9693: =pod
9694:
1.648 raeburn 9695: =item * &DrawBarGraph()
1.127 matthew 9696:
1.138 matthew 9697: Facilitates the plotting of data in a (stacked) bar graph.
9698: Puts plot definition data into the users environment in order for
9699: graph.png to plot it. Returns an <img> tag for the plot.
9700: The bars on the plot are labeled '1','2',...,'n'.
9701:
9702: Inputs:
9703:
9704: =over 4
9705:
9706: =item $Title: string, the title of the plot
9707:
9708: =item $xlabel: string, text describing the X-axis of the plot
9709:
9710: =item $ylabel: string, text describing the Y-axis of the plot
9711:
9712: =item $Max: scalar, the maximum Y value to use in the plot
9713: If $Max is < any data point, the graph will not be rendered.
9714:
1.140 matthew 9715: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 9716: they are plotted. If undefined, default values will be used.
9717:
1.178 matthew 9718: =item $labels: array ref holding the labels to use on the x-axis for the bars.
9719:
1.138 matthew 9720: =item @Values: An array of array references. Each array reference holds data
9721: to be plotted in a stacked bar chart.
9722:
1.239 matthew 9723: =item If the final element of @Values is a hash reference the key/value
9724: pairs will be added to the graph definition.
9725:
1.138 matthew 9726: =back
9727:
9728: Returns:
9729:
9730: An <img> tag which references graph.png and the appropriate identifying
9731: information for the plot.
9732:
1.127 matthew 9733: =cut
9734:
9735: ############################################################
9736: ############################################################
1.134 matthew 9737: sub DrawBarGraph {
1.178 matthew 9738: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 9739: #
9740: if (! defined($colors)) {
9741: $colors = ['#33ff00',
9742: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
9743: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
9744: ];
9745: }
1.228 matthew 9746: my $extra_settings = {};
9747: if (ref($Values[-1]) eq 'HASH') {
9748: $extra_settings = pop(@Values);
9749: }
1.127 matthew 9750: #
1.136 matthew 9751: my $identifier = &get_cgi_id();
9752: my $id = 'cgi.'.$identifier;
1.129 matthew 9753: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 9754: return '';
9755: }
1.225 matthew 9756: #
9757: my @Labels;
9758: if (defined($labels)) {
9759: @Labels = @$labels;
9760: } else {
9761: for (my $i=0;$i<@{$Values[0]};$i++) {
9762: push (@Labels,$i+1);
9763: }
9764: }
9765: #
1.129 matthew 9766: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 9767: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 9768: my %ValuesHash;
9769: my $NumSets=1;
9770: foreach my $array (@Values) {
9771: next if (! ref($array));
1.136 matthew 9772: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 9773: join(',',@$array);
1.129 matthew 9774: }
1.127 matthew 9775: #
1.136 matthew 9776: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 9777: if ($NumBars < 3) {
9778: $width = 120+$NumBars*32;
1.220 matthew 9779: $xskip = 1;
1.225 matthew 9780: $bar_width = 30;
9781: } elsif ($NumBars < 5) {
9782: $width = 120+$NumBars*20;
9783: $xskip = 1;
9784: $bar_width = 20;
1.220 matthew 9785: } elsif ($NumBars < 10) {
1.136 matthew 9786: $width = 120+$NumBars*15;
9787: $xskip = 1;
9788: $bar_width = 15;
9789: } elsif ($NumBars <= 25) {
9790: $width = 120+$NumBars*11;
9791: $xskip = 5;
9792: $bar_width = 8;
9793: } elsif ($NumBars <= 50) {
9794: $width = 120+$NumBars*8;
9795: $xskip = 5;
9796: $bar_width = 4;
9797: } else {
9798: $width = 120+$NumBars*8;
9799: $xskip = 5;
9800: $bar_width = 4;
9801: }
9802: #
1.137 matthew 9803: $Max = 1 if ($Max < 1);
9804: if ( int($Max) < $Max ) {
9805: $Max++;
9806: $Max = int($Max);
9807: }
1.127 matthew 9808: $Title = '' if (! defined($Title));
9809: $xlabel = '' if (! defined($xlabel));
9810: $ylabel = '' if (! defined($ylabel));
1.369 www 9811: $ValuesHash{$id.'.title'} = &escape($Title);
9812: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
9813: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 9814: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 9815: $ValuesHash{$id.'.NumBars'} = $NumBars;
9816: $ValuesHash{$id.'.NumSets'} = $NumSets;
9817: $ValuesHash{$id.'.PlotType'} = 'bar';
9818: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9819: $ValuesHash{$id.'.height'} = $height;
9820: $ValuesHash{$id.'.width'} = $width;
9821: $ValuesHash{$id.'.xskip'} = $xskip;
9822: $ValuesHash{$id.'.bar_width'} = $bar_width;
9823: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 9824: #
1.228 matthew 9825: # Deal with other parameters
9826: while (my ($key,$value) = each(%$extra_settings)) {
9827: $ValuesHash{$id.'.'.$key} = $value;
9828: }
9829: #
1.646 raeburn 9830: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 9831: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9832: }
9833:
9834: ############################################################
9835: ############################################################
9836:
9837: =pod
9838:
1.648 raeburn 9839: =item * &DrawXYGraph()
1.137 matthew 9840:
1.138 matthew 9841: Facilitates the plotting of data in an XY graph.
9842: Puts plot definition data into the users environment in order for
9843: graph.png to plot it. Returns an <img> tag for the plot.
9844:
9845: Inputs:
9846:
9847: =over 4
9848:
9849: =item $Title: string, the title of the plot
9850:
9851: =item $xlabel: string, text describing the X-axis of the plot
9852:
9853: =item $ylabel: string, text describing the Y-axis of the plot
9854:
9855: =item $Max: scalar, the maximum Y value to use in the plot
9856: If $Max is < any data point, the graph will not be rendered.
9857:
9858: =item $colors: Array ref containing the hex color codes for the data to be
9859: plotted in. If undefined, default values will be used.
9860:
9861: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9862:
9863: =item $Ydata: Array ref containing Array refs.
1.185 www 9864: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 9865:
9866: =item %Values: hash indicating or overriding any default values which are
9867: passed to graph.png.
9868: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9869:
9870: =back
9871:
9872: Returns:
9873:
9874: An <img> tag which references graph.png and the appropriate identifying
9875: information for the plot.
9876:
1.137 matthew 9877: =cut
9878:
9879: ############################################################
9880: ############################################################
9881: sub DrawXYGraph {
9882: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
9883: #
9884: # Create the identifier for the graph
9885: my $identifier = &get_cgi_id();
9886: my $id = 'cgi.'.$identifier;
9887: #
9888: $Title = '' if (! defined($Title));
9889: $xlabel = '' if (! defined($xlabel));
9890: $ylabel = '' if (! defined($ylabel));
9891: my %ValuesHash =
9892: (
1.369 www 9893: $id.'.title' => &escape($Title),
9894: $id.'.xlabel' => &escape($xlabel),
9895: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 9896: $id.'.y_max_value'=> $Max,
9897: $id.'.labels' => join(',',@$Xlabels),
9898: $id.'.PlotType' => 'XY',
9899: );
9900: #
9901: if (defined($colors) && ref($colors) eq 'ARRAY') {
9902: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9903: }
9904: #
9905: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
9906: return '';
9907: }
9908: my $NumSets=1;
1.138 matthew 9909: foreach my $array (@{$Ydata}){
1.137 matthew 9910: next if (! ref($array));
9911: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
9912: }
1.138 matthew 9913: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 9914: #
9915: # Deal with other parameters
9916: while (my ($key,$value) = each(%Values)) {
9917: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 9918: }
9919: #
1.646 raeburn 9920: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 9921: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9922: }
9923:
9924: ############################################################
9925: ############################################################
9926:
9927: =pod
9928:
1.648 raeburn 9929: =item * &DrawXYYGraph()
1.138 matthew 9930:
9931: Facilitates the plotting of data in an XY graph with two Y axes.
9932: Puts plot definition data into the users environment in order for
9933: graph.png to plot it. Returns an <img> tag for the plot.
9934:
9935: Inputs:
9936:
9937: =over 4
9938:
9939: =item $Title: string, the title of the plot
9940:
9941: =item $xlabel: string, text describing the X-axis of the plot
9942:
9943: =item $ylabel: string, text describing the Y-axis of the plot
9944:
9945: =item $colors: Array ref containing the hex color codes for the data to be
9946: plotted in. If undefined, default values will be used.
9947:
9948: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9949:
9950: =item $Ydata1: The first data set
9951:
9952: =item $Min1: The minimum value of the left Y-axis
9953:
9954: =item $Max1: The maximum value of the left Y-axis
9955:
9956: =item $Ydata2: The second data set
9957:
9958: =item $Min2: The minimum value of the right Y-axis
9959:
9960: =item $Max2: The maximum value of the left Y-axis
9961:
9962: =item %Values: hash indicating or overriding any default values which are
9963: passed to graph.png.
9964: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9965:
9966: =back
9967:
9968: Returns:
9969:
9970: An <img> tag which references graph.png and the appropriate identifying
9971: information for the plot.
1.136 matthew 9972:
9973: =cut
9974:
9975: ############################################################
9976: ############################################################
1.137 matthew 9977: sub DrawXYYGraph {
9978: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
9979: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 9980: #
9981: # Create the identifier for the graph
9982: my $identifier = &get_cgi_id();
9983: my $id = 'cgi.'.$identifier;
9984: #
9985: $Title = '' if (! defined($Title));
9986: $xlabel = '' if (! defined($xlabel));
9987: $ylabel = '' if (! defined($ylabel));
9988: my %ValuesHash =
9989: (
1.369 www 9990: $id.'.title' => &escape($Title),
9991: $id.'.xlabel' => &escape($xlabel),
9992: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 9993: $id.'.labels' => join(',',@$Xlabels),
9994: $id.'.PlotType' => 'XY',
9995: $id.'.NumSets' => 2,
1.137 matthew 9996: $id.'.two_axes' => 1,
9997: $id.'.y1_max_value' => $Max1,
9998: $id.'.y1_min_value' => $Min1,
9999: $id.'.y2_max_value' => $Max2,
10000: $id.'.y2_min_value' => $Min2,
1.136 matthew 10001: );
10002: #
1.137 matthew 10003: if (defined($colors) && ref($colors) eq 'ARRAY') {
10004: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
10005: }
10006: #
10007: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
10008: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 10009: return '';
10010: }
10011: my $NumSets=1;
1.137 matthew 10012: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 10013: next if (! ref($array));
10014: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 10015: }
10016: #
10017: # Deal with other parameters
10018: while (my ($key,$value) = each(%Values)) {
10019: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 10020: }
10021: #
1.646 raeburn 10022: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 10023: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 10024: }
10025:
10026: ############################################################
10027: ############################################################
10028:
10029: =pod
10030:
1.157 matthew 10031: =back
10032:
1.139 matthew 10033: =head1 Statistics helper routines?
10034:
10035: Bad place for them but what the hell.
10036:
1.157 matthew 10037: =over 4
10038:
1.648 raeburn 10039: =item * &chartlink()
1.139 matthew 10040:
10041: Returns a link to the chart for a specific student.
10042:
10043: Inputs:
10044:
10045: =over 4
10046:
10047: =item $linktext: The text of the link
10048:
10049: =item $sname: The students username
10050:
10051: =item $sdomain: The students domain
10052:
10053: =back
10054:
1.157 matthew 10055: =back
10056:
1.139 matthew 10057: =cut
10058:
10059: ############################################################
10060: ############################################################
10061: sub chartlink {
10062: my ($linktext, $sname, $sdomain) = @_;
10063: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 10064: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 10065: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 10066: '">'.$linktext.'</a>';
1.153 matthew 10067: }
10068:
10069: #######################################################
10070: #######################################################
10071:
10072: =pod
10073:
10074: =head1 Course Environment Routines
1.157 matthew 10075:
10076: =over 4
1.153 matthew 10077:
1.648 raeburn 10078: =item * &restore_course_settings()
1.153 matthew 10079:
1.648 raeburn 10080: =item * &store_course_settings()
1.153 matthew 10081:
10082: Restores/Store indicated form parameters from the course environment.
10083: Will not overwrite existing values of the form parameters.
10084:
10085: Inputs:
10086: a scalar describing the data (e.g. 'chart', 'problem_analysis')
10087:
10088: a hash ref describing the data to be stored. For example:
10089:
10090: %Save_Parameters = ('Status' => 'scalar',
10091: 'chartoutputmode' => 'scalar',
10092: 'chartoutputdata' => 'scalar',
10093: 'Section' => 'array',
1.373 raeburn 10094: 'Group' => 'array',
1.153 matthew 10095: 'StudentData' => 'array',
10096: 'Maps' => 'array');
10097:
10098: Returns: both routines return nothing
10099:
1.631 raeburn 10100: =back
10101:
1.153 matthew 10102: =cut
10103:
10104: #######################################################
10105: #######################################################
10106: sub store_course_settings {
1.496 albertel 10107: return &store_settings($env{'request.course.id'},@_);
10108: }
10109:
10110: sub store_settings {
1.153 matthew 10111: # save to the environment
10112: # appenv the same items, just to be safe
1.300 albertel 10113: my $udom = $env{'user.domain'};
10114: my $uname = $env{'user.name'};
1.496 albertel 10115: my ($context,$prefix,$Settings) = @_;
1.153 matthew 10116: my %SaveHash;
10117: my %AppHash;
10118: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 10119: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 10120: my $envname = 'environment.'.$basename;
1.258 albertel 10121: if (exists($env{'form.'.$setting})) {
1.153 matthew 10122: # Save this value away
10123: if ($type eq 'scalar' &&
1.258 albertel 10124: (! exists($env{$envname}) ||
10125: $env{$envname} ne $env{'form.'.$setting})) {
10126: $SaveHash{$basename} = $env{'form.'.$setting};
10127: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 10128: } elsif ($type eq 'array') {
10129: my $stored_form;
1.258 albertel 10130: if (ref($env{'form.'.$setting})) {
1.153 matthew 10131: $stored_form = join(',',
10132: map {
1.369 www 10133: &escape($_);
1.258 albertel 10134: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 10135: } else {
10136: $stored_form =
1.369 www 10137: &escape($env{'form.'.$setting});
1.153 matthew 10138: }
10139: # Determine if the array contents are the same.
1.258 albertel 10140: if ($stored_form ne $env{$envname}) {
1.153 matthew 10141: $SaveHash{$basename} = $stored_form;
10142: $AppHash{$envname} = $stored_form;
10143: }
10144: }
10145: }
10146: }
10147: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 10148: $udom,$uname);
1.153 matthew 10149: if ($put_result !~ /^(ok|delayed)/) {
10150: &Apache::lonnet::logthis('unable to save form parameters, '.
10151: 'got error:'.$put_result);
10152: }
10153: # Make sure these settings stick around in this session, too
1.646 raeburn 10154: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 10155: return;
10156: }
10157:
10158: sub restore_course_settings {
1.499 albertel 10159: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 10160: }
10161:
10162: sub restore_settings {
10163: my ($context,$prefix,$Settings) = @_;
1.153 matthew 10164: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 10165: next if (exists($env{'form.'.$setting}));
1.496 albertel 10166: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 10167: '.'.$setting;
1.258 albertel 10168: if (exists($env{$envname})) {
1.153 matthew 10169: if ($type eq 'scalar') {
1.258 albertel 10170: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 10171: } elsif ($type eq 'array') {
1.258 albertel 10172: $env{'form.'.$setting} = [
1.153 matthew 10173: map {
1.369 www 10174: &unescape($_);
1.258 albertel 10175: } split(',',$env{$envname})
1.153 matthew 10176: ];
10177: }
10178: }
10179: }
1.127 matthew 10180: }
10181:
1.618 raeburn 10182: #######################################################
10183: #######################################################
10184:
10185: =pod
10186:
10187: =head1 Domain E-mail Routines
10188:
10189: =over 4
10190:
1.648 raeburn 10191: =item * &build_recipient_list()
1.618 raeburn 10192:
1.884 raeburn 10193: Build recipient lists for five types of e-mail:
1.766 raeburn 10194: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884 raeburn 10195: (d) Help requests, (e) Course requests needing approval, generated by
10196: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
10197: loncoursequeueadmin.pm respectively.
1.618 raeburn 10198:
10199: Inputs:
1.619 raeburn 10200: defmail (scalar - email address of default recipient),
1.618 raeburn 10201: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 10202: defdom (domain for which to retrieve configuration settings),
10203: origmail (scalar - email address of recipient from loncapa.conf,
10204: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 10205:
1.655 raeburn 10206: Returns: comma separated list of addresses to which to send e-mail.
10207:
10208: =back
1.618 raeburn 10209:
10210: =cut
10211:
10212: ############################################################
10213: ############################################################
10214: sub build_recipient_list {
1.619 raeburn 10215: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 10216: my @recipients;
10217: my $otheremails;
10218: my %domconfig =
10219: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
10220: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 10221: if (exists($domconfig{'contacts'}{$mailing})) {
10222: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
10223: my @contacts = ('adminemail','supportemail');
10224: foreach my $item (@contacts) {
10225: if ($domconfig{'contacts'}{$mailing}{$item}) {
10226: my $addr = $domconfig{'contacts'}{$item};
10227: if (!grep(/^\Q$addr\E$/,@recipients)) {
10228: push(@recipients,$addr);
10229: }
1.619 raeburn 10230: }
1.766 raeburn 10231: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 10232: }
10233: }
1.766 raeburn 10234: } elsif ($origmail ne '') {
10235: push(@recipients,$origmail);
1.618 raeburn 10236: }
1.619 raeburn 10237: } elsif ($origmail ne '') {
10238: push(@recipients,$origmail);
1.618 raeburn 10239: }
1.688 raeburn 10240: if (defined($defmail)) {
10241: if ($defmail ne '') {
10242: push(@recipients,$defmail);
10243: }
1.618 raeburn 10244: }
10245: if ($otheremails) {
1.619 raeburn 10246: my @others;
10247: if ($otheremails =~ /,/) {
10248: @others = split(/,/,$otheremails);
1.618 raeburn 10249: } else {
1.619 raeburn 10250: push(@others,$otheremails);
10251: }
10252: foreach my $addr (@others) {
10253: if (!grep(/^\Q$addr\E$/,@recipients)) {
10254: push(@recipients,$addr);
10255: }
1.618 raeburn 10256: }
10257: }
1.619 raeburn 10258: my $recipientlist = join(',',@recipients);
1.618 raeburn 10259: return $recipientlist;
10260: }
10261:
1.127 matthew 10262: ############################################################
10263: ############################################################
1.154 albertel 10264:
1.655 raeburn 10265: =pod
10266:
10267: =head1 Course Catalog Routines
10268:
10269: =over 4
10270:
10271: =item * &gather_categories()
10272:
10273: Converts category definitions - keys of categories hash stored in
10274: coursecategories in configuration.db on the primary library server in a
10275: domain - to an array. Also generates javascript and idx hash used to
10276: generate Domain Coordinator interface for editing Course Categories.
10277:
10278: Inputs:
1.663 raeburn 10279:
1.655 raeburn 10280: categories (reference to hash of category definitions).
1.663 raeburn 10281:
1.655 raeburn 10282: cats (reference to array of arrays/hashes which encapsulates hierarchy of
10283: categories and subcategories).
1.663 raeburn 10284:
1.655 raeburn 10285: idx (reference to hash of counters used in Domain Coordinator interface for
10286: editing Course Categories).
1.663 raeburn 10287:
1.655 raeburn 10288: jsarray (reference to array of categories used to create Javascript arrays for
10289: Domain Coordinator interface for editing Course Categories).
10290:
10291: Returns: nothing
10292:
10293: Side effects: populates cats, idx and jsarray.
10294:
10295: =cut
10296:
10297: sub gather_categories {
10298: my ($categories,$cats,$idx,$jsarray) = @_;
10299: my %counters;
10300: my $num = 0;
10301: foreach my $item (keys(%{$categories})) {
10302: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
10303: if ($container eq '' && $depth == 0) {
10304: $cats->[$depth][$categories->{$item}] = $cat;
10305: } else {
10306: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
10307: }
10308: my ($escitem,$tail) = split(/:/,$item,2);
10309: if ($counters{$tail} eq '') {
10310: $counters{$tail} = $num;
10311: $num ++;
10312: }
10313: if (ref($idx) eq 'HASH') {
10314: $idx->{$item} = $counters{$tail};
10315: }
10316: if (ref($jsarray) eq 'ARRAY') {
10317: push(@{$jsarray->[$counters{$tail}]},$item);
10318: }
10319: }
10320: return;
10321: }
10322:
10323: =pod
10324:
10325: =item * &extract_categories()
10326:
10327: Used to generate breadcrumb trails for course categories.
10328:
10329: Inputs:
1.663 raeburn 10330:
1.655 raeburn 10331: categories (reference to hash of category definitions).
1.663 raeburn 10332:
1.655 raeburn 10333: cats (reference to array of arrays/hashes which encapsulates hierarchy of
10334: categories and subcategories).
1.663 raeburn 10335:
1.655 raeburn 10336: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 10337:
1.655 raeburn 10338: allitems (reference to hash - key is category key
10339: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 10340:
1.655 raeburn 10341: idx (reference to hash of counters used in Domain Coordinator interface for
10342: editing Course Categories).
1.663 raeburn 10343:
1.655 raeburn 10344: jsarray (reference to array of categories used to create Javascript arrays for
10345: Domain Coordinator interface for editing Course Categories).
10346:
1.665 raeburn 10347: subcats (reference to hash of arrays containing all subcategories within each
10348: category, -recursive)
10349:
1.655 raeburn 10350: Returns: nothing
10351:
10352: Side effects: populates trails and allitems hash references.
10353:
10354: =cut
10355:
10356: sub extract_categories {
1.665 raeburn 10357: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 10358: if (ref($categories) eq 'HASH') {
10359: &gather_categories($categories,$cats,$idx,$jsarray);
10360: if (ref($cats->[0]) eq 'ARRAY') {
10361: for (my $i=0; $i<@{$cats->[0]}; $i++) {
10362: my $name = $cats->[0][$i];
10363: my $item = &escape($name).'::0';
10364: my $trailstr;
10365: if ($name eq 'instcode') {
10366: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 10367: } elsif ($name eq 'communities') {
10368: $trailstr = &mt('Communities');
1.655 raeburn 10369: } else {
10370: $trailstr = $name;
10371: }
10372: if ($allitems->{$item} eq '') {
10373: push(@{$trails},$trailstr);
10374: $allitems->{$item} = scalar(@{$trails})-1;
10375: }
10376: my @parents = ($name);
10377: if (ref($cats->[1]{$name}) eq 'ARRAY') {
10378: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
10379: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 10380: if (ref($subcats) eq 'HASH') {
10381: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
10382: }
10383: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
10384: }
10385: } else {
10386: if (ref($subcats) eq 'HASH') {
10387: $subcats->{$item} = [];
1.655 raeburn 10388: }
10389: }
10390: }
10391: }
10392: }
10393: return;
10394: }
10395:
10396: =pod
10397:
10398: =item *&recurse_categories()
10399:
10400: Recursively used to generate breadcrumb trails for course categories.
10401:
10402: Inputs:
1.663 raeburn 10403:
1.655 raeburn 10404: cats (reference to array of arrays/hashes which encapsulates hierarchy of
10405: categories and subcategories).
1.663 raeburn 10406:
1.655 raeburn 10407: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 10408:
10409: category (current course category, for which breadcrumb trail is being generated).
10410:
10411: trails (reference to array of breadcrumb trails for each category).
10412:
1.655 raeburn 10413: allitems (reference to hash - key is category key
10414: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 10415:
1.655 raeburn 10416: parents (array containing containers directories for current category,
10417: back to top level).
10418:
10419: Returns: nothing
10420:
10421: Side effects: populates trails and allitems hash references
10422:
10423: =cut
10424:
10425: sub recurse_categories {
1.665 raeburn 10426: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 10427: my $shallower = $depth - 1;
10428: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
10429: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
10430: my $name = $cats->[$depth]{$category}[$k];
10431: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
10432: my $trailstr = join(' -> ',(@{$parents},$category));
10433: if ($allitems->{$item} eq '') {
10434: push(@{$trails},$trailstr);
10435: $allitems->{$item} = scalar(@{$trails})-1;
10436: }
10437: my $deeper = $depth+1;
10438: push(@{$parents},$category);
1.665 raeburn 10439: if (ref($subcats) eq 'HASH') {
10440: my $subcat = &escape($name).':'.$category.':'.$depth;
10441: for (my $j=@{$parents}; $j>=0; $j--) {
10442: my $higher;
10443: if ($j > 0) {
10444: $higher = &escape($parents->[$j]).':'.
10445: &escape($parents->[$j-1]).':'.$j;
10446: } else {
10447: $higher = &escape($parents->[$j]).'::'.$j;
10448: }
10449: push(@{$subcats->{$higher}},$subcat);
10450: }
10451: }
10452: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
10453: $subcats);
1.655 raeburn 10454: pop(@{$parents});
10455: }
10456: } else {
10457: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
10458: my $trailstr = join(' -> ',(@{$parents},$category));
10459: if ($allitems->{$item} eq '') {
10460: push(@{$trails},$trailstr);
10461: $allitems->{$item} = scalar(@{$trails})-1;
10462: }
10463: }
10464: return;
10465: }
10466:
1.663 raeburn 10467: =pod
10468:
10469: =item *&assign_categories_table()
10470:
10471: Create a datatable for display of hierarchical categories in a domain,
10472: with checkboxes to allow a course to be categorized.
10473:
10474: Inputs:
10475:
10476: cathash - reference to hash of categories defined for the domain (from
10477: configuration.db)
10478:
10479: currcat - scalar with an & separated list of categories assigned to a course.
10480:
1.919 raeburn 10481: type - scalar contains course type (Course or Community).
10482:
1.663 raeburn 10483: Returns: $output (markup to be displayed)
10484:
10485: =cut
10486:
10487: sub assign_categories_table {
1.919 raeburn 10488: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 10489: my $output;
10490: if (ref($cathash) eq 'HASH') {
10491: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
10492: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
10493: $maxdepth = scalar(@cats);
10494: if (@cats > 0) {
10495: my $itemcount = 0;
10496: if (ref($cats[0]) eq 'ARRAY') {
10497: my @currcategories;
10498: if ($currcat ne '') {
10499: @currcategories = split('&',$currcat);
10500: }
1.919 raeburn 10501: my $table;
1.663 raeburn 10502: for (my $i=0; $i<@{$cats[0]}; $i++) {
10503: my $parent = $cats[0][$i];
1.919 raeburn 10504: next if ($parent eq 'instcode');
10505: if ($type eq 'Community') {
10506: next unless ($parent eq 'communities');
10507: } else {
10508: next if ($parent eq 'communities');
10509: }
1.663 raeburn 10510: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
10511: my $item = &escape($parent).'::0';
10512: my $checked = '';
10513: if (@currcategories > 0) {
10514: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 10515: $checked = ' checked="checked"';
1.663 raeburn 10516: }
10517: }
1.919 raeburn 10518: my $parent_title = $parent;
10519: if ($parent eq 'communities') {
10520: $parent_title = &mt('Communities');
10521: }
10522: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
10523: '<input type="checkbox" name="usecategory" value="'.
10524: $item.'"'.$checked.' />'.$parent_title.'</span>'.
10525: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 10526: my $depth = 1;
10527: push(@path,$parent);
1.919 raeburn 10528: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 10529: pop(@path);
1.919 raeburn 10530: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 10531: $itemcount ++;
10532: }
1.919 raeburn 10533: if ($itemcount) {
10534: $output = &Apache::loncommon::start_data_table().
10535: $table.
10536: &Apache::loncommon::end_data_table();
10537: }
1.663 raeburn 10538: }
10539: }
10540: }
10541: return $output;
10542: }
10543:
10544: =pod
10545:
10546: =item *&assign_category_rows()
10547:
10548: Create a datatable row for display of nested categories in a domain,
10549: with checkboxes to allow a course to be categorized,called recursively.
10550:
10551: Inputs:
10552:
10553: itemcount - track row number for alternating colors
10554:
10555: cats - reference to array of arrays/hashes which encapsulates hierarchy of
10556: categories and subcategories.
10557:
10558: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
10559:
10560: parent - parent of current category item
10561:
10562: path - Array containing all categories back up through the hierarchy from the
10563: current category to the top level.
10564:
10565: currcategories - reference to array of current categories assigned to the course
10566:
10567: Returns: $output (markup to be displayed).
10568:
10569: =cut
10570:
10571: sub assign_category_rows {
10572: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
10573: my ($text,$name,$item,$chgstr);
10574: if (ref($cats) eq 'ARRAY') {
10575: my $maxdepth = scalar(@{$cats});
10576: if (ref($cats->[$depth]) eq 'HASH') {
10577: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
10578: my $numchildren = @{$cats->[$depth]{$parent}};
10579: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
10580: $text .= '<td><table class="LC_datatable">';
10581: for (my $j=0; $j<$numchildren; $j++) {
10582: $name = $cats->[$depth]{$parent}[$j];
10583: $item = &escape($name).':'.&escape($parent).':'.$depth;
10584: my $deeper = $depth+1;
10585: my $checked = '';
10586: if (ref($currcategories) eq 'ARRAY') {
10587: if (@{$currcategories} > 0) {
10588: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 10589: $checked = ' checked="checked"';
1.663 raeburn 10590: }
10591: }
10592: }
1.664 raeburn 10593: $text .= '<tr><td><span class="LC_nobreak"><label>'.
10594: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 10595: $item.'"'.$checked.' />'.$name.'</label></span>'.
10596: '<input type="hidden" name="catname" value="'.$name.'" />'.
10597: '</td><td>';
1.663 raeburn 10598: if (ref($path) eq 'ARRAY') {
10599: push(@{$path},$name);
10600: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
10601: pop(@{$path});
10602: }
10603: $text .= '</td></tr>';
10604: }
10605: $text .= '</table></td>';
10606: }
10607: }
10608: }
10609: return $text;
10610: }
10611:
1.655 raeburn 10612: ############################################################
10613: ############################################################
10614:
10615:
1.443 albertel 10616: sub commit_customrole {
1.664 raeburn 10617: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 10618: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 10619: ($start?', '.&mt('starting').' '.localtime($start):'').
10620: ($end?', ending '.localtime($end):'').': <b>'.
10621: &Apache::lonnet::assigncustomrole(
1.664 raeburn 10622: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 10623: '</b><br />';
10624: return $output;
10625: }
10626:
10627: sub commit_standardrole {
1.541 raeburn 10628: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
10629: my ($output,$logmsg,$linefeed);
10630: if ($context eq 'auto') {
10631: $linefeed = "\n";
10632: } else {
10633: $linefeed = "<br />\n";
10634: }
1.443 albertel 10635: if ($three eq 'st') {
1.541 raeburn 10636: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
10637: $one,$two,$sec,$context);
10638: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 10639: ($result eq 'unknown_course') || ($result eq 'refused')) {
10640: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 10641: } else {
1.541 raeburn 10642: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 10643: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 10644: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
10645: if ($context eq 'auto') {
10646: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
10647: } else {
10648: $output .= '<b>'.$result.'</b>'.$linefeed.
10649: &mt('Add to classlist').': <b>ok</b>';
10650: }
10651: $output .= $linefeed;
1.443 albertel 10652: }
10653: } else {
10654: $output = &mt('Assigning').' '.$three.' in '.$url.
10655: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 10656: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 10657: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 10658: if ($context eq 'auto') {
10659: $output .= $result.$linefeed;
10660: } else {
10661: $output .= '<b>'.$result.'</b>'.$linefeed;
10662: }
1.443 albertel 10663: }
10664: return $output;
10665: }
10666:
10667: sub commit_studentrole {
1.541 raeburn 10668: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 10669: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 10670: if ($context eq 'auto') {
10671: $linefeed = "\n";
10672: } else {
10673: $linefeed = '<br />'."\n";
10674: }
1.443 albertel 10675: if (defined($one) && defined($two)) {
10676: my $cid=$one.'_'.$two;
10677: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
10678: my $secchange = 0;
10679: my $expire_role_result;
10680: my $modify_section_result;
1.628 raeburn 10681: if ($oldsec ne '-1') {
10682: if ($oldsec ne $sec) {
1.443 albertel 10683: $secchange = 1;
1.628 raeburn 10684: my $now = time;
1.443 albertel 10685: my $uurl='/'.$cid;
10686: $uurl=~s/\_/\//g;
10687: if ($oldsec) {
10688: $uurl.='/'.$oldsec;
10689: }
1.626 raeburn 10690: $oldsecurl = $uurl;
1.628 raeburn 10691: $expire_role_result =
1.652 raeburn 10692: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 10693: if ($env{'request.course.sec'} ne '') {
10694: if ($expire_role_result eq 'refused') {
10695: my @roles = ('st');
10696: my @statuses = ('previous');
10697: my @roledoms = ($one);
10698: my $withsec = 1;
10699: my %roleshash =
10700: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
10701: \@statuses,\@roles,\@roledoms,$withsec);
10702: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
10703: my ($oldstart,$oldend) =
10704: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
10705: if ($oldend > 0 && $oldend <= $now) {
10706: $expire_role_result = 'ok';
10707: }
10708: }
10709: }
10710: }
1.443 albertel 10711: $result = $expire_role_result;
10712: }
10713: }
10714: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 10715: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 10716: if ($modify_section_result =~ /^ok/) {
10717: if ($secchange == 1) {
1.628 raeburn 10718: if ($sec eq '') {
10719: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
10720: } else {
10721: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
10722: }
1.443 albertel 10723: } elsif ($oldsec eq '-1') {
1.628 raeburn 10724: if ($sec eq '') {
10725: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
10726: } else {
10727: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
10728: }
1.443 albertel 10729: } else {
1.628 raeburn 10730: if ($sec eq '') {
10731: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
10732: } else {
10733: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
10734: }
1.443 albertel 10735: }
10736: } else {
1.628 raeburn 10737: if ($secchange) {
10738: $$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;
10739: } else {
10740: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
10741: }
1.443 albertel 10742: }
10743: $result = $modify_section_result;
10744: } elsif ($secchange == 1) {
1.628 raeburn 10745: if ($oldsec eq '') {
10746: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
10747: } else {
10748: $$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;
10749: }
1.626 raeburn 10750: if ($expire_role_result eq 'refused') {
10751: my $newsecurl = '/'.$cid;
10752: $newsecurl =~ s/\_/\//g;
10753: if ($sec ne '') {
10754: $newsecurl.='/'.$sec;
10755: }
10756: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
10757: if ($sec eq '') {
10758: $$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;
10759: } else {
10760: $$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;
10761: }
10762: }
10763: }
1.443 albertel 10764: }
10765: } else {
1.626 raeburn 10766: $$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 10767: $result = "error: incomplete course id\n";
10768: }
10769: return $result;
10770: }
10771:
10772: ############################################################
10773: ############################################################
10774:
1.566 albertel 10775: sub check_clone {
1.578 raeburn 10776: my ($args,$linefeed) = @_;
1.566 albertel 10777: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
10778: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
10779: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
10780: my $clonemsg;
10781: my $can_clone = 0;
1.944 raeburn 10782: my $lctype = lc($args->{'crstype'});
1.908 raeburn 10783: if ($lctype ne 'community') {
10784: $lctype = 'course';
10785: }
1.566 albertel 10786: if ($clonehome eq 'no_host') {
1.944 raeburn 10787: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10788: $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'});
10789: } else {
10790: $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'});
10791: }
1.566 albertel 10792: } else {
10793: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944 raeburn 10794: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10795: if ($clonedesc{'type'} ne 'Community') {
10796: $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'});
10797: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10798: }
10799: }
1.882 raeburn 10800: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
10801: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 10802: $can_clone = 1;
10803: } else {
10804: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
10805: $args->{'clonedomain'},$args->{'clonecourse'});
10806: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 10807: if (grep(/^\*$/,@cloners)) {
10808: $can_clone = 1;
10809: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
10810: $can_clone = 1;
10811: } else {
1.908 raeburn 10812: my $ccrole = 'cc';
1.944 raeburn 10813: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10814: $ccrole = 'co';
10815: }
1.578 raeburn 10816: my %roleshash =
10817: &Apache::lonnet::get_my_roles($args->{'ccuname'},
10818: $args->{'ccdomain'},
1.908 raeburn 10819: 'userroles',['active'],[$ccrole],
1.578 raeburn 10820: [$args->{'clonedomain'}]);
1.908 raeburn 10821: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942 raeburn 10822: $can_clone = 1;
10823: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
10824: $can_clone = 1;
10825: } else {
1.944 raeburn 10826: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10827: $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'});
10828: } else {
10829: $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'});
10830: }
1.578 raeburn 10831: }
1.566 albertel 10832: }
1.578 raeburn 10833: }
1.566 albertel 10834: }
10835: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10836: }
10837:
1.444 albertel 10838: sub construct_course {
1.885 raeburn 10839: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444 albertel 10840: my $outcome;
1.541 raeburn 10841: my $linefeed = '<br />'."\n";
10842: if ($context eq 'auto') {
10843: $linefeed = "\n";
10844: }
1.566 albertel 10845:
10846: #
10847: # Are we cloning?
10848: #
10849: my ($can_clone, $clonemsg, $cloneid, $clonehome);
10850: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 10851: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 10852: if ($context ne 'auto') {
1.578 raeburn 10853: if ($clonemsg ne '') {
10854: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
10855: }
1.566 albertel 10856: }
10857: $outcome .= $clonemsg.$linefeed;
10858:
10859: if (!$can_clone) {
10860: return (0,$outcome);
10861: }
10862: }
10863:
1.444 albertel 10864: #
10865: # Open course
10866: #
10867: my $crstype = lc($args->{'crstype'});
10868: my %cenv=();
10869: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
10870: $args->{'cdescr'},
10871: $args->{'curl'},
10872: $args->{'course_home'},
10873: $args->{'nonstandard'},
10874: $args->{'crscode'},
10875: $args->{'ccuname'}.':'.
10876: $args->{'ccdomain'},
1.882 raeburn 10877: $args->{'crstype'},
1.885 raeburn 10878: $cnum,$context,$category);
1.444 albertel 10879:
10880: # Note: The testing routines depend on this being output; see
10881: # Utils::Course. This needs to at least be output as a comment
10882: # if anyone ever decides to not show this, and Utils::Course::new
10883: # will need to be suitably modified.
1.541 raeburn 10884: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943 raeburn 10885: if ($$courseid =~ /^error:/) {
10886: return (0,$outcome);
10887: }
10888:
1.444 albertel 10889: #
10890: # Check if created correctly
10891: #
1.479 albertel 10892: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 10893: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 10894: if ($crsuhome eq 'no_host') {
10895: $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
10896: return (0,$outcome);
10897: }
1.541 raeburn 10898: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 10899:
1.444 albertel 10900: #
1.566 albertel 10901: # Do the cloning
10902: #
10903: if ($can_clone && $cloneid) {
10904: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
10905: if ($context ne 'auto') {
10906: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
10907: }
10908: $outcome .= $clonemsg.$linefeed;
10909: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 10910: # Copy all files
1.637 www 10911: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 10912: # Restore URL
1.566 albertel 10913: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 10914: # Restore title
1.566 albertel 10915: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 10916: # Restore creation date, creator and creation context.
10917: $cenv{'internal.created'}=$oldcenv{'internal.created'};
10918: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
10919: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 10920: # Mark as cloned
1.566 albertel 10921: $cenv{'clonedfrom'}=$cloneid;
1.638 www 10922: # Need to clone grading mode
10923: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
10924: $cenv{'grading'}=$newenv{'grading'};
10925: # Do not clone these environment entries
10926: &Apache::lonnet::del('environment',
10927: ['default_enrollment_start_date',
10928: 'default_enrollment_end_date',
10929: 'question.email',
10930: 'policy.email',
10931: 'comment.email',
10932: 'pch.users.denied',
1.725 raeburn 10933: 'plc.users.denied',
10934: 'hidefromcat',
10935: 'categories'],
1.638 www 10936: $$crsudom,$$crsunum);
1.444 albertel 10937: }
1.566 albertel 10938:
1.444 albertel 10939: #
10940: # Set environment (will override cloned, if existing)
10941: #
10942: my @sections = ();
10943: my @xlists = ();
10944: if ($args->{'crstype'}) {
10945: $cenv{'type'}=$args->{'crstype'};
10946: }
10947: if ($args->{'crsid'}) {
10948: $cenv{'courseid'}=$args->{'crsid'};
10949: }
10950: if ($args->{'crscode'}) {
10951: $cenv{'internal.coursecode'}=$args->{'crscode'};
10952: }
10953: if ($args->{'crsquota'} ne '') {
10954: $cenv{'internal.coursequota'}=$args->{'crsquota'};
10955: } else {
10956: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
10957: }
10958: if ($args->{'ccuname'}) {
10959: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
10960: ':'.$args->{'ccdomain'};
10961: } else {
10962: $cenv{'internal.courseowner'} = $args->{'curruser'};
10963: }
10964: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
10965: if ($args->{'crssections'}) {
10966: $cenv{'internal.sectionnums'} = '';
10967: if ($args->{'crssections'} =~ m/,/) {
10968: @sections = split/,/,$args->{'crssections'};
10969: } else {
10970: $sections[0] = $args->{'crssections'};
10971: }
10972: if (@sections > 0) {
10973: foreach my $item (@sections) {
10974: my ($sec,$gp) = split/:/,$item;
10975: my $class = $args->{'crscode'}.$sec;
10976: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
10977: $cenv{'internal.sectionnums'} .= $item.',';
10978: unless ($addcheck eq 'ok') {
10979: push @badclasses, $class;
10980: }
10981: }
10982: $cenv{'internal.sectionnums'} =~ s/,$//;
10983: }
10984: }
10985: # do not hide course coordinator from staff listing,
10986: # even if privileged
10987: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10988: # add crosslistings
10989: if ($args->{'crsxlist'}) {
10990: $cenv{'internal.crosslistings'}='';
10991: if ($args->{'crsxlist'} =~ m/,/) {
10992: @xlists = split/,/,$args->{'crsxlist'};
10993: } else {
10994: $xlists[0] = $args->{'crsxlist'};
10995: }
10996: if (@xlists > 0) {
10997: foreach my $item (@xlists) {
10998: my ($xl,$gp) = split/:/,$item;
10999: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
11000: $cenv{'internal.crosslistings'} .= $item.',';
11001: unless ($addcheck eq 'ok') {
11002: push @badclasses, $xl;
11003: }
11004: }
11005: $cenv{'internal.crosslistings'} =~ s/,$//;
11006: }
11007: }
11008: if ($args->{'autoadds'}) {
11009: $cenv{'internal.autoadds'}=$args->{'autoadds'};
11010: }
11011: if ($args->{'autodrops'}) {
11012: $cenv{'internal.autodrops'}=$args->{'autodrops'};
11013: }
11014: # check for notification of enrollment changes
11015: my @notified = ();
11016: if ($args->{'notify_owner'}) {
11017: if ($args->{'ccuname'} ne '') {
11018: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
11019: }
11020: }
11021: if ($args->{'notify_dc'}) {
11022: if ($uname ne '') {
1.630 raeburn 11023: push(@notified,$uname.':'.$udom);
1.444 albertel 11024: }
11025: }
11026: if (@notified > 0) {
11027: my $notifylist;
11028: if (@notified > 1) {
11029: $notifylist = join(',',@notified);
11030: } else {
11031: $notifylist = $notified[0];
11032: }
11033: $cenv{'internal.notifylist'} = $notifylist;
11034: }
11035: if (@badclasses > 0) {
11036: my %lt=&Apache::lonlocal::texthash(
11037: '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',
11038: 'dnhr' => 'does not have rights to access enrollment in these classes',
11039: 'adby' => 'as determined by the policies of your institution on access to official classlists'
11040: );
1.541 raeburn 11041: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
11042: ' ('.$lt{'adby'}.')';
11043: if ($context eq 'auto') {
11044: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 11045: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 11046: foreach my $item (@badclasses) {
11047: if ($context eq 'auto') {
11048: $outcome .= " - $item\n";
11049: } else {
11050: $outcome .= "<li>$item</li>\n";
11051: }
11052: }
11053: if ($context eq 'auto') {
11054: $outcome .= $linefeed;
11055: } else {
1.566 albertel 11056: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 11057: }
11058: }
1.444 albertel 11059: }
11060: if ($args->{'no_end_date'}) {
11061: $args->{'endaccess'} = 0;
11062: }
11063: $cenv{'internal.autostart'}=$args->{'enrollstart'};
11064: $cenv{'internal.autoend'}=$args->{'enrollend'};
11065: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
11066: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
11067: if ($args->{'showphotos'}) {
11068: $cenv{'internal.showphotos'}=$args->{'showphotos'};
11069: }
11070: $cenv{'internal.authtype'} = $args->{'authtype'};
11071: $cenv{'internal.autharg'} = $args->{'autharg'};
11072: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
11073: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 11074: 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');
11075: if ($context eq 'auto') {
11076: $outcome .= $krb_msg;
11077: } else {
1.566 albertel 11078: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 11079: }
11080: $outcome .= $linefeed;
1.444 albertel 11081: }
11082: }
11083: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
11084: if ($args->{'setpolicy'}) {
11085: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
11086: }
11087: if ($args->{'setcontent'}) {
11088: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
11089: }
11090: }
11091: if ($args->{'reshome'}) {
11092: $cenv{'reshome'}=$args->{'reshome'}.'/';
11093: $cenv{'reshome'}=~s/\/+$/\//;
11094: }
11095: #
11096: # course has keyed access
11097: #
11098: if ($args->{'setkeys'}) {
11099: $cenv{'keyaccess'}='yes';
11100: }
11101: # if specified, key authority is not course, but user
11102: # only active if keyaccess is yes
11103: if ($args->{'keyauth'}) {
1.487 albertel 11104: my ($user,$domain) = split(':',$args->{'keyauth'});
11105: $user = &LONCAPA::clean_username($user);
11106: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 11107: if ($user ne '' && $domain ne '') {
1.487 albertel 11108: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 11109: }
11110: }
11111:
11112: if ($args->{'disresdis'}) {
11113: $cenv{'pch.roles.denied'}='st';
11114: }
11115: if ($args->{'disablechat'}) {
11116: $cenv{'plc.roles.denied'}='st';
11117: }
11118:
11119: # Record we've not yet viewed the Course Initialization Helper for this
11120: # course
11121: $cenv{'course.helper.not.run'} = 1;
11122: #
11123: # Use new Randomseed
11124: #
11125: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
11126: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
11127: #
11128: # The encryption code and receipt prefix for this course
11129: #
11130: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
11131: $cenv{'internal.encpref'}=100+int(9*rand(99));
11132: #
11133: # By default, use standard grading
11134: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
11135:
1.541 raeburn 11136: $outcome .= $linefeed.&mt('Setting environment').': '.
11137: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 11138: #
11139: # Open all assignments
11140: #
11141: if ($args->{'openall'}) {
11142: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
11143: my %storecontent = ($storeunder => time,
11144: $storeunder.'.type' => 'date_start');
11145:
11146: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 11147: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 11148: }
11149: #
11150: # Set first page
11151: #
11152: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
11153: || ($cloneid)) {
1.445 albertel 11154: use LONCAPA::map;
1.444 albertel 11155: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 11156:
11157: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
11158: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
11159:
1.444 albertel 11160: $outcome .= ($fatal?$errtext:'read ok').' - ';
11161: my $title; my $url;
11162: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 11163: $title=&mt('Syllabus');
1.444 albertel 11164: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
11165: } else {
1.963 raeburn 11166: $title=&mt('Table of Contents');
1.444 albertel 11167: $url='/adm/navmaps';
11168: }
1.445 albertel 11169:
11170: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
11171: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
11172:
11173: if ($errtext) { $fatal=2; }
1.541 raeburn 11174: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 11175: }
1.566 albertel 11176:
11177: return (1,$outcome);
1.444 albertel 11178: }
11179:
11180: ############################################################
11181: ############################################################
11182:
1.953 droeschl 11183: #SD
11184: # only Community and Course, or anything else?
1.378 raeburn 11185: sub course_type {
11186: my ($cid) = @_;
11187: if (!defined($cid)) {
11188: $cid = $env{'request.course.id'};
11189: }
1.404 albertel 11190: if (defined($env{'course.'.$cid.'.type'})) {
11191: return $env{'course.'.$cid.'.type'};
1.378 raeburn 11192: } else {
11193: return 'Course';
1.377 raeburn 11194: }
11195: }
1.156 albertel 11196:
1.406 raeburn 11197: sub group_term {
11198: my $crstype = &course_type();
11199: my %names = (
11200: 'Course' => 'group',
1.865 raeburn 11201: 'Community' => 'group',
1.406 raeburn 11202: );
11203: return $names{$crstype};
11204: }
11205:
1.902 raeburn 11206: sub course_types {
11207: my @types = ('official','unofficial','community');
11208: my %typename = (
11209: official => 'Official course',
11210: unofficial => 'Unofficial course',
11211: community => 'Community',
11212: );
11213: return (\@types,\%typename);
11214: }
11215:
1.156 albertel 11216: sub icon {
11217: my ($file)=@_;
1.505 albertel 11218: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 11219: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 11220: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 11221: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
11222: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
11223: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
11224: $curfext.".gif") {
11225: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
11226: $curfext.".gif";
11227: }
11228: }
1.249 albertel 11229: return &lonhttpdurl($iconname);
1.154 albertel 11230: }
1.84 albertel 11231:
1.575 albertel 11232: sub lonhttpdurl {
1.692 www 11233: #
11234: # Had been used for "small fry" static images on separate port 8080.
11235: # Modify here if lightweight http functionality desired again.
11236: # Currently eliminated due to increasing firewall issues.
11237: #
1.575 albertel 11238: my ($url)=@_;
1.692 www 11239: return $url;
1.215 albertel 11240: }
11241:
1.213 albertel 11242: sub connection_aborted {
11243: my ($r)=@_;
11244: $r->print(" ");$r->rflush();
11245: my $c = $r->connection;
11246: return $c->aborted();
11247: }
11248:
1.221 foxr 11249: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 11250: # strings as 'strings'.
11251: sub escape_single {
1.221 foxr 11252: my ($input) = @_;
1.223 albertel 11253: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 11254: $input =~ s/\'/\\\'/g; # Esacpe the 's....
11255: return $input;
11256: }
1.223 albertel 11257:
1.222 foxr 11258: # Same as escape_single, but escape's "'s This
11259: # can be used for "strings"
11260: sub escape_double {
11261: my ($input) = @_;
11262: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
11263: $input =~ s/\"/\\\"/g; # Esacpe the "s....
11264: return $input;
11265: }
1.223 albertel 11266:
1.222 foxr 11267: # Escapes the last element of a full URL.
11268: sub escape_url {
11269: my ($url) = @_;
1.238 raeburn 11270: my @urlslices = split(/\//, $url,-1);
1.369 www 11271: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 11272: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 11273: }
1.462 albertel 11274:
1.820 raeburn 11275: sub compare_arrays {
11276: my ($arrayref1,$arrayref2) = @_;
11277: my (@difference,%count);
11278: @difference = ();
11279: %count = ();
11280: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
11281: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
11282: foreach my $element (keys(%count)) {
11283: if ($count{$element} == 1) {
11284: push(@difference,$element);
11285: }
11286: }
11287: }
11288: return @difference;
11289: }
11290:
1.817 bisitz 11291: # -------------------------------------------------------- Initialize user login
1.462 albertel 11292: sub init_user_environment {
1.463 albertel 11293: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 11294: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
11295:
11296: my $public=($username eq 'public' && $domain eq 'public');
11297:
11298: # See if old ID present, if so, remove
11299:
11300: my ($filename,$cookie,$userroles);
11301: my $now=time;
11302:
11303: if ($public) {
11304: my $max_public=100;
11305: my $oldest;
11306: my $oldest_time=0;
11307: for(my $next=1;$next<=$max_public;$next++) {
11308: if (-e $lonids."/publicuser_$next.id") {
11309: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
11310: if ($mtime<$oldest_time || !$oldest_time) {
11311: $oldest_time=$mtime;
11312: $oldest=$next;
11313: }
11314: } else {
11315: $cookie="publicuser_$next";
11316: last;
11317: }
11318: }
11319: if (!$cookie) { $cookie="publicuser_$oldest"; }
11320: } else {
1.463 albertel 11321: # if this isn't a robot, kill any existing non-robot sessions
11322: if (!$args->{'robot'}) {
11323: opendir(DIR,$lonids);
11324: while ($filename=readdir(DIR)) {
11325: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
11326: unlink($lonids.'/'.$filename);
11327: }
1.462 albertel 11328: }
1.463 albertel 11329: closedir(DIR);
1.462 albertel 11330: }
11331: # Give them a new cookie
1.463 albertel 11332: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 11333: : $now.$$.int(rand(10000)));
1.463 albertel 11334: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 11335:
11336: # Initialize roles
11337:
11338: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
11339: }
11340: # ------------------------------------ Check browser type and MathML capability
11341:
11342: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
11343: $clientunicode,$clientos) = &decode_user_agent($r);
11344:
11345: # ------------------------------------------------------------- Get environment
11346:
11347: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
11348: my ($tmp) = keys(%userenv);
11349: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
11350: } else {
11351: undef(%userenv);
11352: }
11353: if (($userenv{'interface'}) && (!$form->{'interface'})) {
11354: $form->{'interface'}=$userenv{'interface'};
11355: }
11356: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
11357:
11358: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 11359: foreach my $option ('interface','localpath','localres') {
11360: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 11361: }
11362: # --------------------------------------------------------- Write first profile
11363:
11364: {
11365: my %initial_env =
11366: ("user.name" => $username,
11367: "user.domain" => $domain,
11368: "user.home" => $authhost,
11369: "browser.type" => $clientbrowser,
11370: "browser.version" => $clientversion,
11371: "browser.mathml" => $clientmathml,
11372: "browser.unicode" => $clientunicode,
11373: "browser.os" => $clientos,
11374: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
11375: "request.course.fn" => '',
11376: "request.course.uri" => '',
11377: "request.course.sec" => '',
11378: "request.role" => 'cm',
11379: "request.role.adv" => $env{'user.adv'},
11380: "request.host" => $ENV{'REMOTE_ADDR'},);
11381:
11382: if ($form->{'localpath'}) {
11383: $initial_env{"browser.localpath"} = $form->{'localpath'};
11384: $initial_env{"browser.localres"} = $form->{'localres'};
11385: }
11386:
11387: if ($form->{'interface'}) {
11388: $form->{'interface'}=~s/\W//gs;
11389: $initial_env{"browser.interface"} = $form->{'interface'};
11390: $env{'browser.interface'}=$form->{'interface'};
11391: }
11392:
1.981 raeburn 11393: my %is_adv = ( is_adv => $env{'user.adv'} );
1.1016 raeburn 11394: my %domdef;
11395: unless ($domain eq 'public') {
11396: %domdef = &Apache::lonnet::get_domain_defaults($domain);
11397: }
1.980 raeburn 11398:
1.724 raeburn 11399: foreach my $tool ('aboutme','blog','portfolio') {
11400: $userenv{'availabletools.'.$tool} =
1.980 raeburn 11401: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
11402: undef,\%userenv,\%domdef,\%is_adv);
1.724 raeburn 11403: }
11404:
1.864 raeburn 11405: foreach my $crstype ('official','unofficial','community') {
1.765 raeburn 11406: $userenv{'canrequest.'.$crstype} =
11407: &Apache::lonnet::usertools_access($username,$domain,$crstype,
1.980 raeburn 11408: 'reload','requestcourses',
11409: \%userenv,\%domdef,\%is_adv);
1.765 raeburn 11410: }
11411:
1.462 albertel 11412: $env{'user.environment'} = "$lonids/$cookie.id";
11413:
11414: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
11415: &GDBM_WRCREAT(),0640)) {
11416: &_add_to_env(\%disk_env,\%initial_env);
11417: &_add_to_env(\%disk_env,\%userenv,'environment.');
11418: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 11419: if (ref($args->{'extra_env'})) {
11420: &_add_to_env(\%disk_env,$args->{'extra_env'});
11421: }
1.462 albertel 11422: untie(%disk_env);
11423: } else {
1.705 tempelho 11424: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
11425: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 11426: return 'error: '.$!;
11427: }
11428: }
11429: $env{'request.role'}='cm';
11430: $env{'request.role.adv'}=$env{'user.adv'};
11431: $env{'browser.type'}=$clientbrowser;
11432:
11433: return $cookie;
11434:
11435: }
11436:
11437: sub _add_to_env {
11438: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 11439: if (ref($env_data) eq 'HASH') {
11440: while (my ($key,$value) = each(%$env_data)) {
11441: $idf->{$prefix.$key} = $value;
11442: $env{$prefix.$key} = $value;
11443: }
1.462 albertel 11444: }
11445: }
11446:
1.685 tempelho 11447: # --- Get the symbolic name of a problem and the url
11448: sub get_symb {
11449: my ($request,$silent) = @_;
1.726 raeburn 11450: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 11451: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
11452: if ($symb eq '') {
11453: if (!$silent) {
11454: $request->print("Unable to handle ambiguous references:$url:.");
11455: return ();
11456: }
11457: }
11458: &Apache::lonenc::check_decrypt(\$symb);
11459: return ($symb);
11460: }
11461:
11462: # --------------------------------------------------------------Get annotation
11463:
11464: sub get_annotation {
11465: my ($symb,$enc) = @_;
11466:
11467: my $key = $symb;
11468: if (!$enc) {
11469: $key =
11470: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
11471: }
11472: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
11473: return $annotation{$key};
11474: }
11475:
11476: sub clean_symb {
1.731 raeburn 11477: my ($symb,$delete_enc) = @_;
1.685 tempelho 11478:
11479: &Apache::lonenc::check_decrypt(\$symb);
11480: my $enc = $env{'request.enc'};
1.731 raeburn 11481: if ($delete_enc) {
1.730 raeburn 11482: delete($env{'request.enc'});
11483: }
1.685 tempelho 11484:
11485: return ($symb,$enc);
11486: }
1.462 albertel 11487:
1.990 raeburn 11488: sub build_release_hashes {
11489: my ($checkparms,$checkresponsetypes,$checkcrstypes,$anonsurvey,$randomizetry) = @_;
11490: return unless((ref($checkparms) eq 'HASH') && (ref($checkresponsetypes) eq 'HASH') &&
11491: (ref($checkcrstypes) eq 'HASH') && (ref($anonsurvey) eq 'HASH') &&
11492: (ref($randomizetry) eq 'HASH'));
11493: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
11494: my ($item,$name,$value) = split(/:/,$key);
11495: if ($item eq 'parameter') {
11496: if (ref($checkparms->{$name}) eq 'ARRAY') {
11497: unless(grep(/^\Q$name\E$/,@{$checkparms->{$name}})) {
11498: push(@{$checkparms->{$name}},$value);
11499: }
11500: } else {
11501: push(@{$checkparms->{$name}},$value);
11502: }
11503: } elsif ($item eq 'resourcetag') {
11504: if ($name eq 'responsetype') {
11505: $checkresponsetypes->{$value} = $Apache::lonnet::needsrelease{$key}
11506: }
11507: } elsif ($item eq 'course') {
11508: if ($name eq 'crstype') {
11509: $checkcrstypes->{$value} = $Apache::lonnet::needsrelease{$key};
11510: }
11511: }
11512: }
11513: ($anonsurvey->{major},$anonsurvey->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:anonsurvey'});
11514: ($randomizetry->{major},$randomizetry->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:randomizetry'});
11515: return;
11516: }
11517:
1.41 ng 11518: =pod
11519:
11520: =back
11521:
1.112 bowersj2 11522: =cut
1.41 ng 11523:
1.112 bowersj2 11524: 1;
11525: __END__;
1.41 ng 11526:
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