Annotation of loncom/interface/loncommon.pm, revision 1.1028
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1028 ! raeburn 4: # $Id: loncommon.pm,v 1.1027 2011/11/02 23:05:07 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 {
1.1018 raeburn 636: return <<ENDJS;
1.1017 raeburn 637: <script type="text/javascript" language="JavaScript">
638: // <![CDATA[
639:
640: if (!Array.prototype.indexOf) {
641: Array.prototype.indexOf = function (searchElement /*, fromIndex */ ) {
642: "use strict";
643: if (this === void 0 || this === null) {
644: throw new TypeError();
645: }
646: var t = Object(this);
647: var len = t.length >>> 0;
648: if (len === 0) {
649: return -1;
650: }
651: var n = 0;
652: if (arguments.length > 0) {
653: n = Number(arguments[1]);
654: if (n !== n) { // shortcut for verifying if it's NaN
655: n = 0;
656: } else if (n !== 0 && n !== (1 / 0) && n !== -(1 / 0)) {
657: n = (n > 0 || -1) * Math.floor(Math.abs(n));
658: }
659: }
660: if (n >= len) {
661: return -1;
662: }
663: var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
664: for (; k < len; k++) {
665: if (k in t && t[k] === searchElement) {
666: return k;
667: }
668: }
669: return -1;
670: }
671: }
672:
673: // ]]>
674: </script>
675:
676: ENDJS
677:
678: }
679:
1.876 raeburn 680: sub userbrowser_javascript {
681: my $id_functions = &javascript_index_functions();
682: return <<"ENDUSERBRW";
683:
1.888 raeburn 684: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876 raeburn 685: var url = '/adm/pickuser?';
686: var userdom = getDomainFromSelectbox(formname,udom);
687: if (userdom != null) {
688: if (userdom != '') {
689: url += 'srchdom='+userdom+'&';
690: }
691: }
692: url += 'form=' + formname + '&unameelement='+uname+
693: '&udomelement='+udom+
694: '&ulastelement='+ulast+
695: '&ufirstelement='+ufirst+
696: '&uemailelement='+uemail+
1.881 raeburn 697: '&hideudomelement='+hideudom+
698: '&coursedom='+crsdom;
1.888 raeburn 699: if ((caller != null) && (caller != undefined)) {
700: url += '&caller='+caller;
701: }
1.876 raeburn 702: var title = 'User_Browser';
703: var options = 'scrollbars=1,resizable=1,menubar=0';
704: options += ',width=700,height=600';
705: var stdeditbrowser = open(url,title,options,'1');
706: stdeditbrowser.focus();
707: }
708:
1.888 raeburn 709: function fix_domain (formname,udom,origdom,uname) {
1.876 raeburn 710: var formid = getFormIdByName(formname);
711: if (formid > -1) {
1.888 raeburn 712: var unameid = getIndexByName(formid,uname);
1.876 raeburn 713: var domid = getIndexByName(formid,udom);
714: var hidedomid = getIndexByName(formid,origdom);
715: if (hidedomid > -1) {
716: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888 raeburn 717: var unameval = document.forms[formid].elements[unameid].value;
718: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
719: if (domid > -1) {
720: var slct = document.forms[formid].elements[domid];
721: if (slct.type == 'select-one') {
722: var i;
723: for (i=0;i<slct.length;i++) {
724: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
725: }
726: }
727: if (slct.type == 'hidden') {
728: slct.value = fixeddom;
1.876 raeburn 729: }
730: }
1.468 raeburn 731: }
732: }
733: }
1.876 raeburn 734: return;
735: }
736:
737: $id_functions
738: ENDUSERBRW
1.468 raeburn 739: }
740:
741: sub setsec_javascript {
1.905 raeburn 742: my ($sec_element,$formname,$role_element) = @_;
743: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
744: $communityrolestr);
745: if ($role_element ne '') {
746: my @allroles = ('st','ta','ep','in','ad');
747: foreach my $crstype ('Course','Community') {
748: if ($crstype eq 'Community') {
749: foreach my $role (@allroles) {
750: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
751: }
752: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
753: } else {
754: foreach my $role (@allroles) {
755: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
756: }
757: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
758: }
759: }
760: $rolestr = '"'.join('","',@allroles).'"';
761: $courserolestr = '"'.join('","',@courserolenames).'"';
762: $communityrolestr = '"'.join('","',@communityrolenames).'"';
763: }
1.468 raeburn 764: my $setsections = qq|
765: function setSect(sectionlist) {
1.629 raeburn 766: var sectionsArray = new Array();
767: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
768: sectionsArray = sectionlist.split(",");
769: }
1.468 raeburn 770: var numSections = sectionsArray.length;
771: document.$formname.$sec_element.length = 0;
772: if (numSections == 0) {
773: document.$formname.$sec_element.multiple=false;
774: document.$formname.$sec_element.size=1;
775: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
776: } else {
777: if (numSections == 1) {
778: document.$formname.$sec_element.multiple=false;
779: document.$formname.$sec_element.size=1;
780: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
781: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
782: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
783: } else {
784: for (var i=0; i<numSections; i++) {
785: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
786: }
787: document.$formname.$sec_element.multiple=true
788: if (numSections < 3) {
789: document.$formname.$sec_element.size=numSections;
790: } else {
791: document.$formname.$sec_element.size=3;
792: }
793: document.$formname.$sec_element.options[0].selected = false
794: }
795: }
1.91 www 796: }
1.905 raeburn 797:
798: function setRole(crstype) {
1.468 raeburn 799: |;
1.905 raeburn 800: if ($role_element eq '') {
801: $setsections .= ' return;
802: }
803: ';
804: } else {
805: $setsections .= qq|
806: var elementLength = document.$formname.$role_element.length;
807: var allroles = Array($rolestr);
808: var courserolenames = Array($courserolestr);
809: var communityrolenames = Array($communityrolestr);
810: if (elementLength != undefined) {
811: if (document.$formname.$role_element.options[5].value == 'cc') {
812: if (crstype == 'Course') {
813: return;
814: } else {
815: allroles[5] = 'co';
816: for (var i=0; i<6; i++) {
817: document.$formname.$role_element.options[i].value = allroles[i];
818: document.$formname.$role_element.options[i].text = communityrolenames[i];
819: }
820: }
821: } else {
822: if (crstype == 'Community') {
823: return;
824: } else {
825: allroles[5] = 'cc';
826: for (var i=0; i<6; i++) {
827: document.$formname.$role_element.options[i].value = allroles[i];
828: document.$formname.$role_element.options[i].text = courserolenames[i];
829: }
830: }
831: }
832: }
833: return;
834: }
835: |;
836: }
1.468 raeburn 837: return $setsections;
838: }
839:
1.91 www 840: sub selectcourse_link {
1.909 raeburn 841: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
842: $typeelement) = @_;
843: my $type = $selecttype;
1.871 raeburn 844: my $linktext = &mt('Select Course');
845: if ($selecttype eq 'Community') {
1.909 raeburn 846: $linktext = &mt('Select Community');
1.906 raeburn 847: } elsif ($selecttype eq 'Course/Community') {
848: $linktext = &mt('Select Course/Community');
1.909 raeburn 849: $type = '';
1.1019 raeburn 850: } elsif ($selecttype eq 'Select') {
851: $linktext = &mt('Select');
852: $type = '';
1.871 raeburn 853: }
1.787 bisitz 854: return '<span class="LC_nobreak">'
855: ."<a href='"
856: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
857: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 858: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 859: ."'>".$linktext.'</a>'
1.787 bisitz 860: .'</span>';
1.74 www 861: }
1.42 matthew 862:
1.653 raeburn 863: sub selectauthor_link {
864: my ($form,$udom)=@_;
865: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
866: &mt('Select Author').'</a>';
867: }
868:
1.876 raeburn 869: sub selectuser_link {
1.881 raeburn 870: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 871: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 872: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 873: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 874: ');">'.$linktext.'</a>';
1.876 raeburn 875: }
876:
1.273 raeburn 877: sub check_uncheck_jscript {
878: my $jscript = <<"ENDSCRT";
879: function checkAll(field) {
880: if (field.length > 0) {
881: for (i = 0; i < field.length; i++) {
882: field[i].checked = true ;
883: }
884: } else {
885: field.checked = true
886: }
887: }
888:
889: function uncheckAll(field) {
890: if (field.length > 0) {
891: for (i = 0; i < field.length; i++) {
892: field[i].checked = false ;
1.543 albertel 893: }
894: } else {
1.273 raeburn 895: field.checked = false ;
896: }
897: }
898: ENDSCRT
899: return $jscript;
900: }
901:
1.656 www 902: sub select_timezone {
1.659 raeburn 903: my ($name,$selected,$onchange,$includeempty)=@_;
904: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
905: if ($includeempty) {
906: $output .= '<option value=""';
907: if (($selected eq '') || ($selected eq 'local')) {
908: $output .= ' selected="selected" ';
909: }
910: $output .= '> </option>';
911: }
1.657 raeburn 912: my @timezones = DateTime::TimeZone->all_names;
913: foreach my $tzone (@timezones) {
914: $output.= '<option value="'.$tzone.'"';
915: if ($tzone eq $selected) {
916: $output.=' selected="selected"';
917: }
918: $output.=">$tzone</option>\n";
1.656 www 919: }
920: $output.="</select>";
921: return $output;
922: }
1.273 raeburn 923:
1.687 raeburn 924: sub select_datelocale {
925: my ($name,$selected,$onchange,$includeempty)=@_;
926: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
927: if ($includeempty) {
928: $output .= '<option value=""';
929: if ($selected eq '') {
930: $output .= ' selected="selected" ';
931: }
932: $output .= '> </option>';
933: }
934: my (@possibles,%locale_names);
935: my @locales = DateTime::Locale::Catalog::Locales;
936: foreach my $locale (@locales) {
937: if (ref($locale) eq 'HASH') {
938: my $id = $locale->{'id'};
939: if ($id ne '') {
940: my $en_terr = $locale->{'en_territory'};
941: my $native_terr = $locale->{'native_territory'};
1.695 raeburn 942: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 943: if (grep(/^en$/,@languages) || !@languages) {
944: if ($en_terr ne '') {
945: $locale_names{$id} = '('.$en_terr.')';
946: } elsif ($native_terr ne '') {
947: $locale_names{$id} = $native_terr;
948: }
949: } else {
950: if ($native_terr ne '') {
951: $locale_names{$id} = $native_terr.' ';
952: } elsif ($en_terr ne '') {
953: $locale_names{$id} = '('.$en_terr.')';
954: }
955: }
956: push (@possibles,$id);
957: }
958: }
959: }
960: foreach my $item (sort(@possibles)) {
961: $output.= '<option value="'.$item.'"';
962: if ($item eq $selected) {
963: $output.=' selected="selected"';
964: }
965: $output.=">$item";
966: if ($locale_names{$item} ne '') {
967: $output.=" $locale_names{$item}</option>\n";
968: }
969: $output.="</option>\n";
970: }
971: $output.="</select>";
972: return $output;
973: }
974:
1.792 raeburn 975: sub select_language {
976: my ($name,$selected,$includeempty) = @_;
977: my %langchoices;
978: if ($includeempty) {
979: %langchoices = ('' => 'No language preference');
980: }
981: foreach my $id (&languageids()) {
982: my $code = &supportedlanguagecode($id);
983: if ($code) {
984: $langchoices{$code} = &plainlanguagedescription($id);
985: }
986: }
1.970 raeburn 987: return &select_form($selected,$name,\%langchoices);
1.792 raeburn 988: }
989:
1.42 matthew 990: =pod
1.36 matthew 991:
1.648 raeburn 992: =item * &linked_select_forms(...)
1.36 matthew 993:
994: linked_select_forms returns a string containing a <script></script> block
995: and html for two <select> menus. The select menus will be linked in that
996: changing the value of the first menu will result in new values being placed
997: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 998: order unless a defined order is provided.
1.36 matthew 999:
1000: linked_select_forms takes the following ordered inputs:
1001:
1002: =over 4
1003:
1.112 bowersj2 1004: =item * $formname, the name of the <form> tag
1.36 matthew 1005:
1.112 bowersj2 1006: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 1007:
1.112 bowersj2 1008: =item * $firstdefault, the default value for the first menu
1.36 matthew 1009:
1.112 bowersj2 1010: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 1011:
1.112 bowersj2 1012: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 1013:
1.112 bowersj2 1014: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 1015:
1.609 raeburn 1016: =item * $menuorder, the order of values in the first menu
1017:
1.41 ng 1018: =back
1019:
1.36 matthew 1020: Below is an example of such a hash. Only the 'text', 'default', and
1021: 'select2' keys must appear as stated. keys(%menu) are the possible
1022: values for the first select menu. The text that coincides with the
1.41 ng 1023: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 1024: and text for the second menu are given in the hash pointed to by
1025: $menu{$choice1}->{'select2'}.
1026:
1.112 bowersj2 1027: my %menu = ( A1 => { text =>"Choice A1" ,
1028: default => "B3",
1029: select2 => {
1030: B1 => "Choice B1",
1031: B2 => "Choice B2",
1032: B3 => "Choice B3",
1033: B4 => "Choice B4"
1.609 raeburn 1034: },
1035: order => ['B4','B3','B1','B2'],
1.112 bowersj2 1036: },
1037: A2 => { text =>"Choice A2" ,
1038: default => "C2",
1039: select2 => {
1040: C1 => "Choice C1",
1041: C2 => "Choice C2",
1042: C3 => "Choice C3"
1.609 raeburn 1043: },
1044: order => ['C2','C1','C3'],
1.112 bowersj2 1045: },
1046: A3 => { text =>"Choice A3" ,
1047: default => "D6",
1048: select2 => {
1049: D1 => "Choice D1",
1050: D2 => "Choice D2",
1051: D3 => "Choice D3",
1052: D4 => "Choice D4",
1053: D5 => "Choice D5",
1054: D6 => "Choice D6",
1055: D7 => "Choice D7"
1.609 raeburn 1056: },
1057: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 1058: }
1059: );
1.36 matthew 1060:
1061: =cut
1062:
1063: sub linked_select_forms {
1064: my ($formname,
1065: $middletext,
1066: $firstdefault,
1067: $firstselectname,
1068: $secondselectname,
1.609 raeburn 1069: $hashref,
1070: $menuorder,
1.36 matthew 1071: ) = @_;
1072: my $second = "document.$formname.$secondselectname";
1073: my $first = "document.$formname.$firstselectname";
1074: # output the javascript to do the changing
1075: my $result = '';
1.776 bisitz 1076: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 1077: $result.="// <![CDATA[\n";
1.36 matthew 1078: $result.="var select2data = new Object();\n";
1079: $" = '","';
1080: my $debug = '';
1081: foreach my $s1 (sort(keys(%$hashref))) {
1082: $result.="select2data.d_$s1 = new Object();\n";
1083: $result.="select2data.d_$s1.def = new String('".
1084: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 1085: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 1086: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1087: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1088: @s2values = @{$hashref->{$s1}->{'order'}};
1089: }
1.36 matthew 1090: $result.="\"@s2values\");\n";
1091: $result.="select2data.d_$s1.texts = new Array(";
1092: my @s2texts;
1093: foreach my $value (@s2values) {
1094: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
1095: }
1096: $result.="\"@s2texts\");\n";
1097: }
1098: $"=' ';
1099: $result.= <<"END";
1100:
1101: function select1_changed() {
1102: // Determine new choice
1103: var newvalue = "d_" + $first.value;
1104: // update select2
1105: var values = select2data[newvalue].values;
1106: var texts = select2data[newvalue].texts;
1107: var select2def = select2data[newvalue].def;
1108: var i;
1109: // out with the old
1110: for (i = 0; i < $second.options.length; i++) {
1111: $second.options[i] = null;
1112: }
1113: // in with the nuclear
1114: for (i=0;i<values.length; i++) {
1115: $second.options[i] = new Option(values[i]);
1.143 matthew 1116: $second.options[i].value = values[i];
1.36 matthew 1117: $second.options[i].text = texts[i];
1118: if (values[i] == select2def) {
1119: $second.options[i].selected = true;
1120: }
1121: }
1122: }
1.824 bisitz 1123: // ]]>
1.36 matthew 1124: </script>
1125: END
1126: # output the initial values for the selection lists
1127: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609 raeburn 1128: my @order = sort(keys(%{$hashref}));
1129: if (ref($menuorder) eq 'ARRAY') {
1130: @order = @{$menuorder};
1131: }
1132: foreach my $value (@order) {
1.36 matthew 1133: $result.=" <option value=\"$value\" ";
1.253 albertel 1134: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1135: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1136: }
1137: $result .= "</select>\n";
1138: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1139: $result .= $middletext;
1140: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
1141: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1142:
1143: my @secondorder = sort(keys(%select2));
1144: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1145: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1146: }
1147: foreach my $value (@secondorder) {
1.36 matthew 1148: $result.=" <option value=\"$value\" ";
1.253 albertel 1149: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1150: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1151: }
1152: $result .= "</select>\n";
1153: # return $debug;
1154: return $result;
1155: } # end of sub linked_select_forms {
1156:
1.45 matthew 1157: =pod
1.44 bowersj2 1158:
1.973 raeburn 1159: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid)
1.44 bowersj2 1160:
1.112 bowersj2 1161: Returns a string corresponding to an HTML link to the given help
1162: $topic, where $topic corresponds to the name of a .tex file in
1163: /home/httpd/html/adm/help/tex, with underscores replaced by
1164: spaces.
1165:
1166: $text will optionally be linked to the same topic, allowing you to
1167: link text in addition to the graphic. If you do not want to link
1168: text, but wish to specify one of the later parameters, pass an
1169: empty string.
1170:
1171: $stayOnPage is a value that will be interpreted as a boolean. If true,
1172: the link will not open a new window. If false, the link will open
1173: a new window using Javascript. (Default is false.)
1174:
1175: $width and $height are optional numerical parameters that will
1176: override the width and height of the popped up window, which may
1.973 raeburn 1177: be useful for certain help topics with big pictures included.
1178:
1179: $imgid is the id of the img tag used for the help icon. This may be
1180: used in a javascript call to switch the image src. See
1181: lonhtmlcommon::htmlareaselectactive() for an example.
1.44 bowersj2 1182:
1183: =cut
1184:
1185: sub help_open_topic {
1.973 raeburn 1186: my ($topic, $text, $stayOnPage, $width, $height, $imgid) = @_;
1.48 bowersj2 1187: $text = "" if (not defined $text);
1.44 bowersj2 1188: $stayOnPage = 0 if (not defined $stayOnPage);
1189: $width = 350 if (not defined $width);
1190: $height = 400 if (not defined $height);
1191: my $filename = $topic;
1192: $filename =~ s/ /_/g;
1193:
1.48 bowersj2 1194: my $template = "";
1195: my $link;
1.572 banghart 1196:
1.159 www 1197: $topic=~s/\W/\_/g;
1.44 bowersj2 1198:
1.572 banghart 1199: if (!$stayOnPage) {
1.72 bowersj2 1200: $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1.572 banghart 1201: } else {
1.48 bowersj2 1202: $link = "/adm/help/${filename}.hlp";
1203: }
1204:
1205: # Add the text
1.755 neumanie 1206: if ($text ne "") {
1.763 bisitz 1207: $template.='<span class="LC_help_open_topic">'
1208: .'<a target="_top" href="'.$link.'">'
1209: .$text.'</a>';
1.48 bowersj2 1210: }
1211:
1.763 bisitz 1212: # (Always) Add the graphic
1.179 matthew 1213: my $title = &mt('Online Help');
1.667 raeburn 1214: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973 raeburn 1215: if ($imgid ne '') {
1216: $imgid = ' id="'.$imgid.'"';
1217: }
1.763 bisitz 1218: $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
1219: .'<img src="'.$helpicon.'" border="0"'
1220: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973 raeburn 1221: .' title="'.$title.'" style="vertical-align:middle;"'.$imgid
1.763 bisitz 1222: .' /></a>';
1223: if ($text ne "") {
1224: $template.='</span>';
1225: }
1.44 bowersj2 1226: return $template;
1227:
1.106 bowersj2 1228: }
1229:
1230: # This is a quicky function for Latex cheatsheet editing, since it
1231: # appears in at least four places
1232: sub helpLatexCheatsheet {
1.732 raeburn 1233: my ($topic,$text,$not_author) = @_;
1234: my $out;
1.106 bowersj2 1235: my $addOther = '';
1.732 raeburn 1236: if ($topic) {
1.763 bisitz 1237: $addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
1238: undef, undef, 600).
1239: '</span> ';
1240: }
1241: $out = '<span>' # Start cheatsheet
1242: .$addOther
1243: .'<span>'
1244: .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
1245: undef,undef,600)
1246: .'</span> <span>'
1247: .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
1248: undef,undef,600)
1249: .'</span>';
1.732 raeburn 1250: unless ($not_author) {
1.763 bisitz 1251: $out .= ' <span>'
1252: .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
1253: undef,undef,600)
1254: .'</span>';
1.732 raeburn 1255: }
1.763 bisitz 1256: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1257: return $out;
1.172 www 1258: }
1259:
1.430 albertel 1260: sub general_help {
1261: my $helptopic='Student_Intro';
1262: if ($env{'request.role'}=~/^(ca|au)/) {
1263: $helptopic='Authoring_Intro';
1.907 raeburn 1264: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1265: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1266: } elsif ($env{'request.role'}=~/^dc/) {
1267: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1268: }
1269: return $helptopic;
1270: }
1271:
1272: sub update_help_link {
1273: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1274: my $origurl = $ENV{'REQUEST_URI'};
1275: $origurl=~s|^/~|/priv/|;
1276: my $timestamp = time;
1277: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1278: $$datum = &escape($$datum);
1279: }
1280:
1281: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1282: my $output .= <<"ENDOUTPUT";
1283: <script type="text/javascript">
1.824 bisitz 1284: // <![CDATA[
1.430 albertel 1285: banner_link = '$banner_link';
1.824 bisitz 1286: // ]]>
1.430 albertel 1287: </script>
1288: ENDOUTPUT
1289: return $output;
1290: }
1291:
1292: # now just updates the help link and generates a blue icon
1.193 raeburn 1293: sub help_open_menu {
1.430 albertel 1294: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1295: = @_;
1.949 droeschl 1296: $stayOnPage = 1;
1.430 albertel 1297: my $output;
1298: if ($component_help) {
1299: if (!$text) {
1300: $output=&help_open_topic($component_help,undef,$stayOnPage,
1301: $width,$height);
1302: } else {
1303: my $help_text;
1304: $help_text=&unescape($topic);
1305: $output='<table><tr><td>'.
1306: &help_open_topic($component_help,$help_text,$stayOnPage,
1307: $width,$height).'</td></tr></table>';
1308: }
1309: }
1310: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1311: return $output.$banner_link;
1312: }
1313:
1314: sub top_nav_help {
1315: my ($text) = @_;
1.436 albertel 1316: $text = &mt($text);
1.949 droeschl 1317: my $stay_on_page = 1;
1318:
1.572 banghart 1319: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1320: : "javascript:helpMenu('open')";
1.572 banghart 1321: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1322:
1.201 raeburn 1323: my $title = &mt('Get help');
1.436 albertel 1324:
1325: return <<"END";
1326: $banner_link
1327: <a href="$link" title="$title">$text</a>
1328: END
1329: }
1330:
1331: sub help_menu_js {
1332: my ($text) = @_;
1.949 droeschl 1333: my $stayOnPage = 1;
1.436 albertel 1334: my $width = 620;
1335: my $height = 600;
1.430 albertel 1336: my $helptopic=&general_help();
1337: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1338: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1339: my $start_page =
1340: &Apache::loncommon::start_page('Help Menu', undef,
1341: {'frameset' => 1,
1342: 'js_ready' => 1,
1343: 'add_entries' => {
1344: 'border' => '0',
1.579 raeburn 1345: 'rows' => "110,*",},});
1.331 albertel 1346: my $end_page =
1347: &Apache::loncommon::end_page({'frameset' => 1,
1348: 'js_ready' => 1,});
1349:
1.436 albertel 1350: my $template .= <<"ENDTEMPLATE";
1351: <script type="text/javascript">
1.877 bisitz 1352: // <![CDATA[
1.253 albertel 1353: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1354: var banner_link = '';
1.243 raeburn 1355: function helpMenu(target) {
1356: var caller = this;
1357: if (target == 'open') {
1358: var newWindow = null;
1359: try {
1.262 albertel 1360: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1361: }
1362: catch(error) {
1363: writeHelp(caller);
1364: return;
1365: }
1366: if (newWindow) {
1367: caller = newWindow;
1368: }
1.193 raeburn 1369: }
1.243 raeburn 1370: writeHelp(caller);
1371: return;
1372: }
1373: function writeHelp(caller) {
1.430 albertel 1374: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243 raeburn 1375: caller.document.close()
1376: caller.focus()
1.193 raeburn 1377: }
1.877 bisitz 1378: // END LON-CAPA Internal -->
1.253 albertel 1379: // ]]>
1.436 albertel 1380: </script>
1.193 raeburn 1381: ENDTEMPLATE
1382: return $template;
1383: }
1384:
1.172 www 1385: sub help_open_bug {
1386: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1387: unless ($env{'user.adv'}) { return ''; }
1.172 www 1388: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1389: $text = "" if (not defined $text);
1390: $stayOnPage=1;
1.184 albertel 1391: $width = 600 if (not defined $width);
1392: $height = 600 if (not defined $height);
1.172 www 1393:
1394: $topic=~s/\W+/\+/g;
1395: my $link='';
1396: my $template='';
1.379 albertel 1397: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1398: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1399: if (!$stayOnPage)
1400: {
1401: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1402: }
1403: else
1404: {
1405: $link = $url;
1406: }
1407: # Add the text
1408: if ($text ne "")
1409: {
1410: $template .=
1411: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1412: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1413: }
1414:
1415: # Add the graphic
1.179 matthew 1416: my $title = &mt('Report a Bug');
1.215 albertel 1417: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1418: $template .= <<"ENDTEMPLATE";
1.436 albertel 1419: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1420: ENDTEMPLATE
1421: if ($text ne '') { $template.='</td></tr></table>' };
1422: return $template;
1423:
1424: }
1425:
1426: sub help_open_faq {
1427: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1428: unless ($env{'user.adv'}) { return ''; }
1.172 www 1429: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1430: $text = "" if (not defined $text);
1431: $stayOnPage=1;
1432: $width = 350 if (not defined $width);
1433: $height = 400 if (not defined $height);
1434:
1435: $topic=~s/\W+/\+/g;
1436: my $link='';
1437: my $template='';
1438: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1439: if (!$stayOnPage)
1440: {
1441: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1442: }
1443: else
1444: {
1445: $link = $url;
1446: }
1447:
1448: # Add the text
1449: if ($text ne "")
1450: {
1451: $template .=
1.173 www 1452: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1453: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1454: }
1455:
1456: # Add the graphic
1.179 matthew 1457: my $title = &mt('View the FAQ');
1.215 albertel 1458: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1459: $template .= <<"ENDTEMPLATE";
1.436 albertel 1460: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1461: ENDTEMPLATE
1462: if ($text ne '') { $template.='</td></tr></table>' };
1463: return $template;
1464:
1.44 bowersj2 1465: }
1.37 matthew 1466:
1.180 matthew 1467: ###############################################################
1468: ###############################################################
1469:
1.45 matthew 1470: =pod
1471:
1.648 raeburn 1472: =item * &change_content_javascript():
1.256 matthew 1473:
1474: This and the next function allow you to create small sections of an
1475: otherwise static HTML page that you can update on the fly with
1476: Javascript, even in Netscape 4.
1477:
1478: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1479: must be written to the HTML page once. It will prove the Javascript
1480: function "change(name, content)". Calling the change function with the
1481: name of the section
1482: you want to update, matching the name passed to C<changable_area>, and
1483: the new content you want to put in there, will put the content into
1484: that area.
1485:
1486: B<Note>: Netscape 4 only reserves enough space for the changable area
1487: to contain room for the original contents. You need to "make space"
1488: for whatever changes you wish to make, and be B<sure> to check your
1489: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1490: it's adequate for updating a one-line status display, but little more.
1491: This script will set the space to 100% width, so you only need to
1492: worry about height in Netscape 4.
1493:
1494: Modern browsers are much less limiting, and if you can commit to the
1495: user not using Netscape 4, this feature may be used freely with
1496: pretty much any HTML.
1497:
1498: =cut
1499:
1500: sub change_content_javascript {
1501: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1502: if ($env{'browser.type'} eq 'netscape' &&
1503: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1504: return (<<NETSCAPE4);
1505: function change(name, content) {
1506: doc = document.layers[name+"___escape"].layers[0].document;
1507: doc.open();
1508: doc.write(content);
1509: doc.close();
1510: }
1511: NETSCAPE4
1512: } else {
1513: # Otherwise, we need to use semi-standards-compliant code
1514: # (technically, "innerHTML" isn't standard but the equivalent
1515: # is really scary, and every useful browser supports it
1516: return (<<DOMBASED);
1517: function change(name, content) {
1518: element = document.getElementById(name);
1519: element.innerHTML = content;
1520: }
1521: DOMBASED
1522: }
1523: }
1524:
1525: =pod
1526:
1.648 raeburn 1527: =item * &changable_area($name,$origContent):
1.256 matthew 1528:
1529: This provides a "changable area" that can be modified on the fly via
1530: the Javascript code provided in C<change_content_javascript>. $name is
1531: the name you will use to reference the area later; do not repeat the
1532: same name on a given HTML page more then once. $origContent is what
1533: the area will originally contain, which can be left blank.
1534:
1535: =cut
1536:
1537: sub changable_area {
1538: my ($name, $origContent) = @_;
1539:
1.258 albertel 1540: if ($env{'browser.type'} eq 'netscape' &&
1541: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1542: # If this is netscape 4, we need to use the Layer tag
1543: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1544: } else {
1545: return "<span id='$name'>$origContent</span>";
1546: }
1547: }
1548:
1549: =pod
1550:
1.648 raeburn 1551: =item * &viewport_geometry_js
1.590 raeburn 1552:
1553: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1554:
1555: =cut
1556:
1557:
1558: sub viewport_geometry_js {
1559: return <<"GEOMETRY";
1560: var Geometry = {};
1561: function init_geometry() {
1562: if (Geometry.init) { return };
1563: Geometry.init=1;
1564: if (window.innerHeight) {
1565: Geometry.getViewportHeight = function() { return window.innerHeight; };
1566: Geometry.getViewportWidth = function() { return window.innerWidth; };
1567: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1568: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1569: }
1570: else if (document.documentElement && document.documentElement.clientHeight) {
1571: Geometry.getViewportHeight =
1572: function() { return document.documentElement.clientHeight; };
1573: Geometry.getViewportWidth =
1574: function() { return document.documentElement.clientWidth; };
1575:
1576: Geometry.getHorizontalScroll =
1577: function() { return document.documentElement.scrollLeft; };
1578: Geometry.getVerticalScroll =
1579: function() { return document.documentElement.scrollTop; };
1580: }
1581: else if (document.body.clientHeight) {
1582: Geometry.getViewportHeight =
1583: function() { return document.body.clientHeight; };
1584: Geometry.getViewportWidth =
1585: function() { return document.body.clientWidth; };
1586: Geometry.getHorizontalScroll =
1587: function() { return document.body.scrollLeft; };
1588: Geometry.getVerticalScroll =
1589: function() { return document.body.scrollTop; };
1590: }
1591: }
1592:
1593: GEOMETRY
1594: }
1595:
1596: =pod
1597:
1.648 raeburn 1598: =item * &viewport_size_js()
1.590 raeburn 1599:
1600: Provides a javascript function to set values of two form elements - width and height (elements are passed in as arguments to the javascript function) to the dimensions of the user's browser window.
1601:
1602: =cut
1603:
1604: sub viewport_size_js {
1605: my $geometry = &viewport_geometry_js();
1606: return <<"DIMS";
1607:
1608: $geometry
1609:
1610: function getViewportDims(width,height) {
1611: init_geometry();
1612: width.value = Geometry.getViewportWidth();
1613: height.value = Geometry.getViewportHeight();
1614: return;
1615: }
1616:
1617: DIMS
1618: }
1619:
1620: =pod
1621:
1.648 raeburn 1622: =item * &resize_textarea_js()
1.565 albertel 1623:
1624: emits the needed javascript to resize a textarea to be as big as possible
1625:
1626: creates a function resize_textrea that takes two IDs first should be
1627: the id of the element to resize, second should be the id of a div that
1628: surrounds everything that comes after the textarea, this routine needs
1629: to be attached to the <body> for the onload and onresize events.
1630:
1.648 raeburn 1631: =back
1.565 albertel 1632:
1633: =cut
1634:
1635: sub resize_textarea_js {
1.590 raeburn 1636: my $geometry = &viewport_geometry_js();
1.565 albertel 1637: return <<"RESIZE";
1638: <script type="text/javascript">
1.824 bisitz 1639: // <![CDATA[
1.590 raeburn 1640: $geometry
1.565 albertel 1641:
1.588 albertel 1642: function getX(element) {
1643: var x = 0;
1644: while (element) {
1645: x += element.offsetLeft;
1646: element = element.offsetParent;
1647: }
1648: return x;
1649: }
1650: function getY(element) {
1651: var y = 0;
1652: while (element) {
1653: y += element.offsetTop;
1654: element = element.offsetParent;
1655: }
1656: return y;
1657: }
1658:
1659:
1.565 albertel 1660: function resize_textarea(textarea_id,bottom_id) {
1661: init_geometry();
1662: var textarea = document.getElementById(textarea_id);
1663: //alert(textarea);
1664:
1.588 albertel 1665: var textarea_top = getY(textarea);
1.565 albertel 1666: var textarea_height = textarea.offsetHeight;
1667: var bottom = document.getElementById(bottom_id);
1.588 albertel 1668: var bottom_top = getY(bottom);
1.565 albertel 1669: var bottom_height = bottom.offsetHeight;
1670: var window_height = Geometry.getViewportHeight();
1.588 albertel 1671: var fudge = 23;
1.565 albertel 1672: var new_height = window_height-fudge-textarea_top-bottom_height;
1673: if (new_height < 300) {
1674: new_height = 300;
1675: }
1676: textarea.style.height=new_height+'px';
1677: }
1.824 bisitz 1678: // ]]>
1.565 albertel 1679: </script>
1680: RESIZE
1681:
1682: }
1683:
1684: =pod
1685:
1.256 matthew 1686: =head1 Excel and CSV file utility routines
1687:
1688: =over 4
1689:
1690: =cut
1691:
1692: ###############################################################
1693: ###############################################################
1694:
1695: =pod
1696:
1.648 raeburn 1697: =item * &csv_translate($text)
1.37 matthew 1698:
1.185 www 1699: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1700: format.
1701:
1702: =cut
1703:
1.180 matthew 1704: ###############################################################
1705: ###############################################################
1.37 matthew 1706: sub csv_translate {
1707: my $text = shift;
1708: $text =~ s/\"/\"\"/g;
1.209 albertel 1709: $text =~ s/\n/ /g;
1.37 matthew 1710: return $text;
1711: }
1.180 matthew 1712:
1713: ###############################################################
1714: ###############################################################
1715:
1716: =pod
1717:
1.648 raeburn 1718: =item * &define_excel_formats()
1.180 matthew 1719:
1720: Define some commonly used Excel cell formats.
1721:
1722: Currently supported formats:
1723:
1724: =over 4
1725:
1726: =item header
1727:
1728: =item bold
1729:
1730: =item h1
1731:
1732: =item h2
1733:
1734: =item h3
1735:
1.256 matthew 1736: =item h4
1737:
1738: =item i
1739:
1.180 matthew 1740: =item date
1741:
1742: =back
1743:
1744: Inputs: $workbook
1745:
1746: Returns: $format, a hash reference.
1747:
1748: =cut
1749:
1750: ###############################################################
1751: ###############################################################
1752: sub define_excel_formats {
1753: my ($workbook) = @_;
1754: my $format;
1755: $format->{'header'} = $workbook->add_format(bold => 1,
1756: bottom => 1,
1757: align => 'center');
1758: $format->{'bold'} = $workbook->add_format(bold=>1);
1759: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1760: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1761: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1762: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1763: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1764: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1765: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1766: return $format;
1767: }
1768:
1769: ###############################################################
1770: ###############################################################
1.113 bowersj2 1771:
1772: =pod
1773:
1.648 raeburn 1774: =item * &create_workbook()
1.255 matthew 1775:
1776: Create an Excel worksheet. If it fails, output message on the
1777: request object and return undefs.
1778:
1779: Inputs: Apache request object
1780:
1781: Returns (undef) on failure,
1782: Excel worksheet object, scalar with filename, and formats
1783: from &Apache::loncommon::define_excel_formats on success
1784:
1785: =cut
1786:
1787: ###############################################################
1788: ###############################################################
1789: sub create_workbook {
1790: my ($r) = @_;
1791: #
1792: # Create the excel spreadsheet
1793: my $filename = '/prtspool/'.
1.258 albertel 1794: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1795: time.'_'.rand(1000000000).'.xls';
1796: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1797: if (! defined($workbook)) {
1798: $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928 bisitz 1799: $r->print(
1800: '<p class="LC_error">'
1801: .&mt('Problems occurred in creating the new Excel file.')
1802: .' '.&mt('This error has been logged.')
1803: .' '.&mt('Please alert your LON-CAPA administrator.')
1804: .'</p>'
1805: );
1.255 matthew 1806: return (undef);
1807: }
1808: #
1.1014 foxr 1809: $workbook->set_tempdir(LONCAPA::tempdir());
1.255 matthew 1810: #
1811: my $format = &Apache::loncommon::define_excel_formats($workbook);
1812: return ($workbook,$filename,$format);
1813: }
1814:
1815: ###############################################################
1816: ###############################################################
1817:
1818: =pod
1819:
1.648 raeburn 1820: =item * &create_text_file()
1.113 bowersj2 1821:
1.542 raeburn 1822: Create a file to write to and eventually make available to the user.
1.256 matthew 1823: If file creation fails, outputs an error message on the request object and
1824: return undefs.
1.113 bowersj2 1825:
1.256 matthew 1826: Inputs: Apache request object, and file suffix
1.113 bowersj2 1827:
1.256 matthew 1828: Returns (undef) on failure,
1829: Filehandle and filename on success.
1.113 bowersj2 1830:
1831: =cut
1832:
1.256 matthew 1833: ###############################################################
1834: ###############################################################
1835: sub create_text_file {
1836: my ($r,$suffix) = @_;
1837: if (! defined($suffix)) { $suffix = 'txt'; };
1838: my $fh;
1839: my $filename = '/prtspool/'.
1.258 albertel 1840: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1841: time.'_'.rand(1000000000).'.'.$suffix;
1842: $fh = Apache::File->new('>/home/httpd'.$filename);
1843: if (! defined($fh)) {
1844: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 1845: $r->print(
1846: '<p class="LC_error">'
1847: .&mt('Problems occurred in creating the output file.')
1848: .' '.&mt('This error has been logged.')
1849: .' '.&mt('Please alert your LON-CAPA administrator.')
1850: .'</p>'
1851: );
1.113 bowersj2 1852: }
1.256 matthew 1853: return ($fh,$filename)
1.113 bowersj2 1854: }
1855:
1856:
1.256 matthew 1857: =pod
1.113 bowersj2 1858:
1859: =back
1860:
1861: =cut
1.37 matthew 1862:
1863: ###############################################################
1.33 matthew 1864: ## Home server <option> list generating code ##
1865: ###############################################################
1.35 matthew 1866:
1.169 www 1867: # ------------------------------------------
1868:
1869: sub domain_select {
1870: my ($name,$value,$multiple)=@_;
1871: my %domains=map {
1.514 albertel 1872: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1873: } &Apache::lonnet::all_domains();
1.169 www 1874: if ($multiple) {
1875: $domains{''}=&mt('Any domain');
1.550 albertel 1876: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1877: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1878: } else {
1.550 albertel 1879: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970 raeburn 1880: return &select_form($name,$value,\%domains);
1.169 www 1881: }
1882: }
1883:
1.282 albertel 1884: #-------------------------------------------
1885:
1886: =pod
1887:
1.519 raeburn 1888: =head1 Routines for form select boxes
1889:
1890: =over 4
1891:
1.648 raeburn 1892: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1893:
1894: Returns a string containing a <select> element int multiple mode
1895:
1896:
1897: Args:
1898: $name - name of the <select> element
1.506 raeburn 1899: $value - scalar or array ref of values that should already be selected
1.282 albertel 1900: $size - number of rows long the select element is
1.283 albertel 1901: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1902: (shown text should already have been &mt())
1.506 raeburn 1903: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1904:
1.282 albertel 1905: =cut
1906:
1907: #-------------------------------------------
1.169 www 1908: sub multiple_select_form {
1.284 albertel 1909: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1910: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1911: my $output='';
1.191 matthew 1912: if (! defined($size)) {
1913: $size = 4;
1.283 albertel 1914: if (scalar(keys(%$hash))<4) {
1915: $size = scalar(keys(%$hash));
1.191 matthew 1916: }
1917: }
1.734 bisitz 1918: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1919: my @order;
1.506 raeburn 1920: if (ref($order) eq 'ARRAY') {
1921: @order = @{$order};
1922: } else {
1923: @order = sort(keys(%$hash));
1.501 banghart 1924: }
1925: if (exists($$hash{'select_form_order'})) {
1926: @order = @{$$hash{'select_form_order'}};
1927: }
1928:
1.284 albertel 1929: foreach my $key (@order) {
1.356 albertel 1930: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1931: $output.='selected="selected" ' if ($selected{$key});
1932: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1933: }
1934: $output.="</select>\n";
1935: return $output;
1936: }
1937:
1.88 www 1938: #-------------------------------------------
1939:
1940: =pod
1941:
1.970 raeburn 1942: =item * &select_form($defdom,$name,$hashref,$onchange)
1.88 www 1943:
1944: Returns a string containing a <select name='$name' size='1'> form to
1.970 raeburn 1945: allow a user to select options from a ref to a hash containing:
1946: option_name => displayed text. An optional $onchange can include
1947: a javascript onchange item, e.g., onchange="this.form.submit();"
1948:
1.88 www 1949: See lonrights.pm for an example invocation and use.
1950:
1951: =cut
1952:
1953: #-------------------------------------------
1954: sub select_form {
1.970 raeburn 1955: my ($def,$name,$hashref,$onchange) = @_;
1956: return unless (ref($hashref) eq 'HASH');
1957: if ($onchange) {
1958: $onchange = ' onchange="'.$onchange.'"';
1959: }
1960: my $selectform = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.128 albertel 1961: my @keys;
1.970 raeburn 1962: if (exists($hashref->{'select_form_order'})) {
1963: @keys=@{$hashref->{'select_form_order'}};
1.128 albertel 1964: } else {
1.970 raeburn 1965: @keys=sort(keys(%{$hashref}));
1.128 albertel 1966: }
1.356 albertel 1967: foreach my $key (@keys) {
1968: $selectform.=
1969: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1970: ($key eq $def ? 'selected="selected" ' : '').
1.970 raeburn 1971: ">".$hashref->{$key}."</option>\n";
1.88 www 1972: }
1973: $selectform.="</select>";
1974: return $selectform;
1975: }
1976:
1.475 www 1977: # For display filters
1978:
1979: sub display_filter {
1980: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1981: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714 bisitz 1982: return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475 www 1983: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1984: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 1985: '</label></span> <span class="LC_nobreak">'.
1.475 www 1986: &mt('Filter [_1]',
1.477 www 1987: &select_form($env{'form.displayfilter'},
1988: 'displayfilter',
1.970 raeburn 1989: {'currentfolder' => 'Current folder/page',
1.477 www 1990: 'containing' => 'Containing phrase',
1.970 raeburn 1991: 'none' => 'None'})).
1.714 bisitz 1992: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475 www 1993: }
1994:
1.167 www 1995: sub gradeleveldescription {
1996: my $gradelevel=shift;
1997: my %gradelevels=(0 => 'Not specified',
1998: 1 => 'Grade 1',
1999: 2 => 'Grade 2',
2000: 3 => 'Grade 3',
2001: 4 => 'Grade 4',
2002: 5 => 'Grade 5',
2003: 6 => 'Grade 6',
2004: 7 => 'Grade 7',
2005: 8 => 'Grade 8',
2006: 9 => 'Grade 9',
2007: 10 => 'Grade 10',
2008: 11 => 'Grade 11',
2009: 12 => 'Grade 12',
2010: 13 => 'Grade 13',
2011: 14 => '100 Level',
2012: 15 => '200 Level',
2013: 16 => '300 Level',
2014: 17 => '400 Level',
2015: 18 => 'Graduate Level');
2016: return &mt($gradelevels{$gradelevel});
2017: }
2018:
1.163 www 2019: sub select_level_form {
2020: my ($deflevel,$name)=@_;
2021: unless ($deflevel) { $deflevel=0; }
1.167 www 2022: my $selectform = "<select name=\"$name\" size=\"1\">\n";
2023: for (my $i=0; $i<=18; $i++) {
2024: $selectform.="<option value=\"$i\" ".
1.253 albertel 2025: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 2026: ">".&gradeleveldescription($i)."</option>\n";
2027: }
2028: $selectform.="</select>";
2029: return $selectform;
1.163 www 2030: }
1.167 www 2031:
1.35 matthew 2032: #-------------------------------------------
2033:
1.45 matthew 2034: =pod
2035:
1.910 raeburn 2036: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35 matthew 2037:
2038: Returns a string containing a <select name='$name' size='1'> form to
2039: allow a user to select the domain to preform an operation in.
2040: See loncreateuser.pm for an example invocation and use.
2041:
1.90 www 2042: If the $includeempty flag is set, it also includes an empty choice ("no domain
2043: selected");
2044:
1.743 raeburn 2045: If the $showdomdesc flag is set, the domain name is followed by the domain description.
2046:
1.910 raeburn 2047: The optional $onchange argument specifies what should occur if the domain selector is changed, e.g., 'this.form.submit()' if the form is to be automatically submitted.
2048:
2049: The optional $incdoms is a reference to an array of domains which will be the only available options.
1.563 raeburn 2050:
1.35 matthew 2051: =cut
2052:
2053: #-------------------------------------------
1.34 matthew 2054: sub select_dom_form {
1.910 raeburn 2055: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.872 raeburn 2056: if ($onchange) {
1.874 raeburn 2057: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 2058: }
1.910 raeburn 2059: my @domains;
2060: if (ref($incdoms) eq 'ARRAY') {
2061: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
2062: } else {
2063: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
2064: }
1.90 www 2065: if ($includeempty) { @domains=('',@domains); }
1.743 raeburn 2066: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 2067: foreach my $dom (@domains) {
2068: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 2069: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
2070: if ($showdomdesc) {
2071: if ($dom ne '') {
2072: my $domdesc = &Apache::lonnet::domain($dom,'description');
2073: if ($domdesc ne '') {
2074: $selectdomain .= ' ('.$domdesc.')';
2075: }
2076: }
2077: }
2078: $selectdomain .= "</option>\n";
1.34 matthew 2079: }
2080: $selectdomain.="</select>";
2081: return $selectdomain;
2082: }
2083:
1.35 matthew 2084: #-------------------------------------------
2085:
1.45 matthew 2086: =pod
2087:
1.648 raeburn 2088: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 2089:
1.586 raeburn 2090: input: 4 arguments (two required, two optional) -
2091: $domain - domain of new user
2092: $name - name of form element
2093: $default - Value of 'default' causes a default item to be first
2094: option, and selected by default.
2095: $hide - Value of 'hide' causes hiding of the name of the server,
2096: if 1 server found, or default, if 0 found.
1.594 raeburn 2097: output: returns 2 items:
1.586 raeburn 2098: (a) form element which contains either:
2099: (i) <select name="$name">
2100: <option value="$hostid1">$hostid $servers{$hostid}</option>
2101: <option value="$hostid2">$hostid $servers{$hostid}</option>
2102: </select>
2103: form item if there are multiple library servers in $domain, or
2104: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2105: if there is only one library server in $domain.
2106:
2107: (b) number of library servers found.
2108:
2109: See loncreateuser.pm for example of use.
1.35 matthew 2110:
2111: =cut
2112:
2113: #-------------------------------------------
1.586 raeburn 2114: sub home_server_form_item {
2115: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2116: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2117: my $result;
2118: my $numlib = keys(%servers);
2119: if ($numlib > 1) {
2120: $result .= '<select name="'.$name.'" />'."\n";
2121: if ($default) {
1.804 bisitz 2122: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 2123: '</option>'."\n";
2124: }
2125: foreach my $hostid (sort(keys(%servers))) {
2126: $result.= '<option value="'.$hostid.'">'.
2127: $hostid.' '.$servers{$hostid}."</option>\n";
2128: }
2129: $result .= '</select>'."\n";
2130: } elsif ($numlib == 1) {
2131: my $hostid;
2132: foreach my $item (keys(%servers)) {
2133: $hostid = $item;
2134: }
2135: $result .= '<input type="hidden" name="'.$name.'" value="'.
2136: $hostid.'" />';
2137: if (!$hide) {
2138: $result .= $hostid.' '.$servers{$hostid};
2139: }
2140: $result .= "\n";
2141: } elsif ($default) {
2142: $result .= '<input type="hidden" name="'.$name.
2143: '" value="default" />';
2144: if (!$hide) {
2145: $result .= &mt('default');
2146: }
2147: $result .= "\n";
1.33 matthew 2148: }
1.586 raeburn 2149: return ($result,$numlib);
1.33 matthew 2150: }
1.112 bowersj2 2151:
2152: =pod
2153:
1.534 albertel 2154: =back
2155:
1.112 bowersj2 2156: =cut
1.87 matthew 2157:
2158: ###############################################################
1.112 bowersj2 2159: ## Decoding User Agent ##
1.87 matthew 2160: ###############################################################
2161:
2162: =pod
2163:
1.112 bowersj2 2164: =head1 Decoding the User Agent
2165:
2166: =over 4
2167:
2168: =item * &decode_user_agent()
1.87 matthew 2169:
2170: Inputs: $r
2171:
2172: Outputs:
2173:
2174: =over 4
2175:
1.112 bowersj2 2176: =item * $httpbrowser
1.87 matthew 2177:
1.112 bowersj2 2178: =item * $clientbrowser
1.87 matthew 2179:
1.112 bowersj2 2180: =item * $clientversion
1.87 matthew 2181:
1.112 bowersj2 2182: =item * $clientmathml
1.87 matthew 2183:
1.112 bowersj2 2184: =item * $clientunicode
1.87 matthew 2185:
1.112 bowersj2 2186: =item * $clientos
1.87 matthew 2187:
2188: =back
2189:
1.157 matthew 2190: =back
2191:
1.87 matthew 2192: =cut
2193:
2194: ###############################################################
2195: ###############################################################
2196: sub decode_user_agent {
1.247 albertel 2197: my ($r)=@_;
1.87 matthew 2198: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2199: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2200: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2201: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2202: my $clientbrowser='unknown';
2203: my $clientversion='0';
2204: my $clientmathml='';
2205: my $clientunicode='0';
2206: for (my $i=0;$i<=$#browsertype;$i++) {
2207: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
2208: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2209: $clientbrowser=$bname;
2210: $httpbrowser=~/$vreg/i;
2211: $clientversion=$1;
2212: $clientmathml=($clientversion>=$minv);
2213: $clientunicode=($clientversion>=$univ);
2214: }
2215: }
2216: my $clientos='unknown';
2217: if (($httpbrowser=~/linux/i) ||
2218: ($httpbrowser=~/unix/i) ||
2219: ($httpbrowser=~/ux/i) ||
2220: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2221: if (($httpbrowser=~/vax/i) ||
2222: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2223: if ($httpbrowser=~/next/i) { $clientos='next'; }
2224: if (($httpbrowser=~/mac/i) ||
2225: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
2226: if ($httpbrowser=~/win/i) { $clientos='win'; }
2227: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
2228: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
2229: $clientunicode,$clientos,);
2230: }
2231:
1.32 matthew 2232: ###############################################################
2233: ## Authentication changing form generation subroutines ##
2234: ###############################################################
2235: ##
2236: ## All of the authform_xxxxxxx subroutines take their inputs in a
2237: ## hash, and have reasonable default values.
2238: ##
2239: ## formname = the name given in the <form> tag.
1.35 matthew 2240: #-------------------------------------------
2241:
1.45 matthew 2242: =pod
2243:
1.112 bowersj2 2244: =head1 Authentication Routines
2245:
2246: =over 4
2247:
1.648 raeburn 2248: =item * &authform_xxxxxx()
1.35 matthew 2249:
2250: The authform_xxxxxx subroutines provide javascript and html forms which
2251: handle some of the conveniences required for authentication forms.
2252: This is not an optimal method, but it works.
2253:
2254: =over 4
2255:
1.112 bowersj2 2256: =item * authform_header
1.35 matthew 2257:
1.112 bowersj2 2258: =item * authform_authorwarning
1.35 matthew 2259:
1.112 bowersj2 2260: =item * authform_nochange
1.35 matthew 2261:
1.112 bowersj2 2262: =item * authform_kerberos
1.35 matthew 2263:
1.112 bowersj2 2264: =item * authform_internal
1.35 matthew 2265:
1.112 bowersj2 2266: =item * authform_filesystem
1.35 matthew 2267:
2268: =back
2269:
1.648 raeburn 2270: See loncreateuser.pm for invocation and use examples.
1.157 matthew 2271:
1.35 matthew 2272: =cut
2273:
2274: #-------------------------------------------
1.32 matthew 2275: sub authform_header{
2276: my %in = (
2277: formname => 'cu',
1.80 albertel 2278: kerb_def_dom => '',
1.32 matthew 2279: @_,
2280: );
2281: $in{'formname'} = 'document.' . $in{'formname'};
2282: my $result='';
1.80 albertel 2283:
2284: #---------------------------------------------- Code for upper case translation
2285: my $Javascript_toUpperCase;
2286: unless ($in{kerb_def_dom}) {
2287: $Javascript_toUpperCase =<<"END";
2288: switch (choice) {
2289: case 'krb': currentform.elements[choicearg].value =
2290: currentform.elements[choicearg].value.toUpperCase();
2291: break;
2292: default:
2293: }
2294: END
2295: } else {
2296: $Javascript_toUpperCase = "";
2297: }
2298:
1.165 raeburn 2299: my $radioval = "'nochange'";
1.591 raeburn 2300: if (defined($in{'curr_authtype'})) {
2301: if ($in{'curr_authtype'} ne '') {
2302: $radioval = "'".$in{'curr_authtype'}."arg'";
2303: }
1.174 matthew 2304: }
1.165 raeburn 2305: my $argfield = 'null';
1.591 raeburn 2306: if (defined($in{'mode'})) {
1.165 raeburn 2307: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2308: if (defined($in{'curr_autharg'})) {
2309: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2310: $argfield = "'$in{'curr_autharg'}'";
2311: }
2312: }
2313: }
2314: }
2315:
1.32 matthew 2316: $result.=<<"END";
2317: var current = new Object();
1.165 raeburn 2318: current.radiovalue = $radioval;
2319: current.argfield = $argfield;
1.32 matthew 2320:
2321: function changed_radio(choice,currentform) {
2322: var choicearg = choice + 'arg';
2323: // If a radio button in changed, we need to change the argfield
2324: if (current.radiovalue != choice) {
2325: current.radiovalue = choice;
2326: if (current.argfield != null) {
2327: currentform.elements[current.argfield].value = '';
2328: }
2329: if (choice == 'nochange') {
2330: current.argfield = null;
2331: } else {
2332: current.argfield = choicearg;
2333: switch(choice) {
2334: case 'krb':
2335: currentform.elements[current.argfield].value =
2336: "$in{'kerb_def_dom'}";
2337: break;
2338: default:
2339: break;
2340: }
2341: }
2342: }
2343: return;
2344: }
1.22 www 2345:
1.32 matthew 2346: function changed_text(choice,currentform) {
2347: var choicearg = choice + 'arg';
2348: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2349: $Javascript_toUpperCase
1.32 matthew 2350: // clear old field
2351: if ((current.argfield != choicearg) && (current.argfield != null)) {
2352: currentform.elements[current.argfield].value = '';
2353: }
2354: current.argfield = choicearg;
2355: }
2356: set_auth_radio_buttons(choice,currentform);
2357: return;
1.20 www 2358: }
1.32 matthew 2359:
2360: function set_auth_radio_buttons(newvalue,currentform) {
1.986 raeburn 2361: var numauthchoices = currentform.login.length;
2362: if (typeof numauthchoices == "undefined") {
2363: return;
2364: }
1.32 matthew 2365: var i=0;
1.986 raeburn 2366: while (i < numauthchoices) {
1.32 matthew 2367: if (currentform.login[i].value == newvalue) { break; }
2368: i++;
2369: }
1.986 raeburn 2370: if (i == numauthchoices) {
1.32 matthew 2371: return;
2372: }
2373: current.radiovalue = newvalue;
2374: currentform.login[i].checked = true;
2375: return;
2376: }
2377: END
2378: return $result;
2379: }
2380:
2381: sub authform_authorwarning{
2382: my $result='';
1.144 matthew 2383: $result='<i>'.
2384: &mt('As a general rule, only authors or co-authors should be '.
2385: 'filesystem authenticated '.
2386: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2387: return $result;
2388: }
2389:
2390: sub authform_nochange{
2391: my %in = (
2392: formname => 'document.cu',
2393: kerb_def_dom => 'MSU.EDU',
2394: @_,
2395: );
1.586 raeburn 2396: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2397: my $result;
2398: if (keys(%can_assign) == 0) {
2399: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2400: } else {
2401: $result = '<label>'.&mt('[_1] Do not change login data',
2402: '<input type="radio" name="login" value="nochange" '.
2403: 'checked="checked" onclick="'.
1.281 albertel 2404: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2405: '</label>';
1.586 raeburn 2406: }
1.32 matthew 2407: return $result;
2408: }
2409:
1.591 raeburn 2410: sub authform_kerberos {
1.32 matthew 2411: my %in = (
2412: formname => 'document.cu',
2413: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2414: kerb_def_auth => 'krb4',
1.32 matthew 2415: @_,
2416: );
1.586 raeburn 2417: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2418: $autharg,$jscall);
2419: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2420: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2421: $check5 = ' checked="checked"';
1.80 albertel 2422: } else {
1.772 bisitz 2423: $check4 = ' checked="checked"';
1.80 albertel 2424: }
1.165 raeburn 2425: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2426: if (defined($in{'curr_authtype'})) {
2427: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2428: $krbcheck = ' checked="checked"';
1.623 raeburn 2429: if (defined($in{'mode'})) {
2430: if ($in{'mode'} eq 'modifyuser') {
2431: $krbcheck = '';
2432: }
2433: }
1.591 raeburn 2434: if (defined($in{'curr_kerb_ver'})) {
2435: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2436: $check5 = ' checked="checked"';
1.591 raeburn 2437: $check4 = '';
2438: } else {
1.772 bisitz 2439: $check4 = ' checked="checked"';
1.591 raeburn 2440: $check5 = '';
2441: }
1.586 raeburn 2442: }
1.591 raeburn 2443: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2444: $krbarg = $in{'curr_autharg'};
2445: }
1.586 raeburn 2446: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2447: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2448: $result =
2449: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2450: $in{'curr_autharg'},$krbver);
2451: } else {
2452: $result =
2453: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2454: }
2455: return $result;
2456: }
2457: }
2458: } else {
2459: if ($authnum == 1) {
1.784 bisitz 2460: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2461: }
2462: }
1.586 raeburn 2463: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2464: return;
1.587 raeburn 2465: } elsif ($authtype eq '') {
1.591 raeburn 2466: if (defined($in{'mode'})) {
1.587 raeburn 2467: if ($in{'mode'} eq 'modifycourse') {
2468: if ($authnum == 1) {
1.784 bisitz 2469: $authtype = '<input type="hidden" name="login" value="krb" />';
1.587 raeburn 2470: }
2471: }
2472: }
1.586 raeburn 2473: }
2474: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2475: if ($authtype eq '') {
2476: $authtype = '<input type="radio" name="login" value="krb" '.
2477: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2478: $krbcheck.' />';
2479: }
2480: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2481: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2482: $in{'curr_authtype'} eq 'krb5') ||
2483: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2484: $in{'curr_authtype'} eq 'krb4')) {
2485: $result .= &mt
1.144 matthew 2486: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2487: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2488: '<label>'.$authtype,
1.281 albertel 2489: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2490: 'value="'.$krbarg.'" '.
1.144 matthew 2491: 'onchange="'.$jscall.'" />',
1.281 albertel 2492: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2493: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2494: '</label>');
1.586 raeburn 2495: } elsif ($can_assign{'krb4'}) {
2496: $result .= &mt
2497: ('[_1] Kerberos authenticated with domain [_2] '.
2498: '[_3] Version 4 [_4]',
2499: '<label>'.$authtype,
2500: '</label><input type="text" size="10" name="krbarg" '.
2501: 'value="'.$krbarg.'" '.
2502: 'onchange="'.$jscall.'" />',
2503: '<label><input type="hidden" name="krbver" value="4" />',
2504: '</label>');
2505: } elsif ($can_assign{'krb5'}) {
2506: $result .= &mt
2507: ('[_1] Kerberos authenticated with domain [_2] '.
2508: '[_3] Version 5 [_4]',
2509: '<label>'.$authtype,
2510: '</label><input type="text" size="10" name="krbarg" '.
2511: 'value="'.$krbarg.'" '.
2512: 'onchange="'.$jscall.'" />',
2513: '<label><input type="hidden" name="krbver" value="5" />',
2514: '</label>');
2515: }
1.32 matthew 2516: return $result;
2517: }
2518:
2519: sub authform_internal{
1.586 raeburn 2520: my %in = (
1.32 matthew 2521: formname => 'document.cu',
2522: kerb_def_dom => 'MSU.EDU',
2523: @_,
2524: );
1.586 raeburn 2525: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2526: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2527: if (defined($in{'curr_authtype'})) {
2528: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2529: if ($can_assign{'int'}) {
1.772 bisitz 2530: $intcheck = 'checked="checked" ';
1.623 raeburn 2531: if (defined($in{'mode'})) {
2532: if ($in{'mode'} eq 'modifyuser') {
2533: $intcheck = '';
2534: }
2535: }
1.591 raeburn 2536: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2537: $intarg = $in{'curr_autharg'};
2538: }
2539: } else {
2540: $result = &mt('Currently internally authenticated.');
2541: return $result;
1.165 raeburn 2542: }
2543: }
1.586 raeburn 2544: } else {
2545: if ($authnum == 1) {
1.784 bisitz 2546: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 2547: }
2548: }
2549: if (!$can_assign{'int'}) {
2550: return;
1.587 raeburn 2551: } elsif ($authtype eq '') {
1.591 raeburn 2552: if (defined($in{'mode'})) {
1.587 raeburn 2553: if ($in{'mode'} eq 'modifycourse') {
2554: if ($authnum == 1) {
1.784 bisitz 2555: $authtype = '<input type="hidden" name="login" value="int" />';
1.587 raeburn 2556: }
2557: }
2558: }
1.165 raeburn 2559: }
1.586 raeburn 2560: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2561: if ($authtype eq '') {
2562: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2563: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2564: }
1.605 bisitz 2565: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2566: $intarg.'" onchange="'.$jscall.'" />';
2567: $result = &mt
1.144 matthew 2568: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2569: '<label>'.$authtype,'</label>'.$autharg);
1.824 bisitz 2570: $result.="<label><input type=\"checkbox\" name=\"visible\" onclick='if (this.checked) { this.form.intarg.type=\"text\" } else { this.form.intarg.type=\"password\" }' />".&mt('Visible input').'</label>';
1.32 matthew 2571: return $result;
2572: }
2573:
2574: sub authform_local{
2575: my %in = (
2576: formname => 'document.cu',
2577: kerb_def_dom => 'MSU.EDU',
2578: @_,
2579: );
1.586 raeburn 2580: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2581: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2582: if (defined($in{'curr_authtype'})) {
2583: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2584: if ($can_assign{'loc'}) {
1.772 bisitz 2585: $loccheck = 'checked="checked" ';
1.623 raeburn 2586: if (defined($in{'mode'})) {
2587: if ($in{'mode'} eq 'modifyuser') {
2588: $loccheck = '';
2589: }
2590: }
1.591 raeburn 2591: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2592: $locarg = $in{'curr_autharg'};
2593: }
2594: } else {
2595: $result = &mt('Currently using local (institutional) authentication.');
2596: return $result;
1.165 raeburn 2597: }
2598: }
1.586 raeburn 2599: } else {
2600: if ($authnum == 1) {
1.784 bisitz 2601: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 2602: }
2603: }
2604: if (!$can_assign{'loc'}) {
2605: return;
1.587 raeburn 2606: } elsif ($authtype eq '') {
1.591 raeburn 2607: if (defined($in{'mode'})) {
1.587 raeburn 2608: if ($in{'mode'} eq 'modifycourse') {
2609: if ($authnum == 1) {
1.784 bisitz 2610: $authtype = '<input type="hidden" name="login" value="loc" />';
1.587 raeburn 2611: }
2612: }
2613: }
1.165 raeburn 2614: }
1.586 raeburn 2615: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2616: if ($authtype eq '') {
2617: $authtype = '<input type="radio" name="login" value="loc" '.
2618: $loccheck.' onchange="'.$jscall.'" onclick="'.
2619: $jscall.'" />';
2620: }
2621: $autharg = '<input type="text" size="10" name="locarg" value="'.
2622: $locarg.'" onchange="'.$jscall.'" />';
2623: $result = &mt('[_1] Local Authentication with argument [_2]',
2624: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2625: return $result;
2626: }
2627:
2628: sub authform_filesystem{
2629: my %in = (
2630: formname => 'document.cu',
2631: kerb_def_dom => 'MSU.EDU',
2632: @_,
2633: );
1.586 raeburn 2634: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2635: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2636: if (defined($in{'curr_authtype'})) {
2637: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2638: if ($can_assign{'fsys'}) {
1.772 bisitz 2639: $fsyscheck = 'checked="checked" ';
1.623 raeburn 2640: if (defined($in{'mode'})) {
2641: if ($in{'mode'} eq 'modifyuser') {
2642: $fsyscheck = '';
2643: }
2644: }
1.586 raeburn 2645: } else {
2646: $result = &mt('Currently Filesystem Authenticated.');
2647: return $result;
2648: }
2649: }
2650: } else {
2651: if ($authnum == 1) {
1.784 bisitz 2652: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 2653: }
2654: }
2655: if (!$can_assign{'fsys'}) {
2656: return;
1.587 raeburn 2657: } elsif ($authtype eq '') {
1.591 raeburn 2658: if (defined($in{'mode'})) {
1.587 raeburn 2659: if ($in{'mode'} eq 'modifycourse') {
2660: if ($authnum == 1) {
1.784 bisitz 2661: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587 raeburn 2662: }
2663: }
2664: }
1.586 raeburn 2665: }
2666: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2667: if ($authtype eq '') {
2668: $authtype = '<input type="radio" name="login" value="fsys" '.
2669: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2670: $jscall.'" />';
2671: }
2672: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2673: ' onchange="'.$jscall.'" />';
2674: $result = &mt
1.144 matthew 2675: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2676: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2677: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2678: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2679: 'onchange="'.$jscall.'" />');
1.32 matthew 2680: return $result;
2681: }
2682:
1.586 raeburn 2683: sub get_assignable_auth {
2684: my ($dom) = @_;
2685: if ($dom eq '') {
2686: $dom = $env{'request.role.domain'};
2687: }
2688: my %can_assign = (
2689: krb4 => 1,
2690: krb5 => 1,
2691: int => 1,
2692: loc => 1,
2693: );
2694: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2695: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2696: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2697: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2698: my $context;
2699: if ($env{'request.role'} =~ /^au/) {
2700: $context = 'author';
2701: } elsif ($env{'request.role'} =~ /^dc/) {
2702: $context = 'domain';
2703: } elsif ($env{'request.course.id'}) {
2704: $context = 'course';
2705: }
2706: if ($context) {
2707: if (ref($authhash->{$context}) eq 'HASH') {
2708: %can_assign = %{$authhash->{$context}};
2709: }
2710: }
2711: }
2712: }
2713: my $authnum = 0;
2714: foreach my $key (keys(%can_assign)) {
2715: if ($can_assign{$key}) {
2716: $authnum ++;
2717: }
2718: }
2719: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2720: $authnum --;
2721: }
2722: return ($authnum,%can_assign);
2723: }
2724:
1.80 albertel 2725: ###############################################################
2726: ## Get Kerberos Defaults for Domain ##
2727: ###############################################################
2728: ##
2729: ## Returns default kerberos version and an associated argument
2730: ## as listed in file domain.tab. If not listed, provides
2731: ## appropriate default domain and kerberos version.
2732: ##
2733: #-------------------------------------------
2734:
2735: =pod
2736:
1.648 raeburn 2737: =item * &get_kerberos_defaults()
1.80 albertel 2738:
2739: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2740: version and domain. If not found, it defaults to version 4 and the
2741: domain of the server.
1.80 albertel 2742:
1.648 raeburn 2743: =over 4
2744:
1.80 albertel 2745: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2746:
1.648 raeburn 2747: =back
2748:
2749: =back
2750:
1.80 albertel 2751: =cut
2752:
2753: #-------------------------------------------
2754: sub get_kerberos_defaults {
2755: my $domain=shift;
1.641 raeburn 2756: my ($krbdef,$krbdefdom);
2757: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2758: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2759: $krbdef = $domdefaults{'auth_def'};
2760: $krbdefdom = $domdefaults{'auth_arg_def'};
2761: } else {
1.80 albertel 2762: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2763: my $krbdefdom=$1;
2764: $krbdefdom=~tr/a-z/A-Z/;
2765: $krbdef = "krb4";
2766: }
2767: return ($krbdef,$krbdefdom);
2768: }
1.112 bowersj2 2769:
1.32 matthew 2770:
1.46 matthew 2771: ###############################################################
2772: ## Thesaurus Functions ##
2773: ###############################################################
1.20 www 2774:
1.46 matthew 2775: =pod
1.20 www 2776:
1.112 bowersj2 2777: =head1 Thesaurus Functions
2778:
2779: =over 4
2780:
1.648 raeburn 2781: =item * &initialize_keywords()
1.46 matthew 2782:
2783: Initializes the package variable %Keywords if it is empty. Uses the
2784: package variable $thesaurus_db_file.
2785:
2786: =cut
2787:
2788: ###################################################
2789:
2790: sub initialize_keywords {
2791: return 1 if (scalar keys(%Keywords));
2792: # If we are here, %Keywords is empty, so fill it up
2793: # Make sure the file we need exists...
2794: if (! -e $thesaurus_db_file) {
2795: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2796: " failed because it does not exist");
2797: return 0;
2798: }
2799: # Set up the hash as a database
2800: my %thesaurus_db;
2801: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2802: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2803: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2804: $thesaurus_db_file);
2805: return 0;
2806: }
2807: # Get the average number of appearances of a word.
2808: my $avecount = $thesaurus_db{'average.count'};
2809: # Put keywords (those that appear > average) into %Keywords
2810: while (my ($word,$data)=each (%thesaurus_db)) {
2811: my ($count,undef) = split /:/,$data;
2812: $Keywords{$word}++ if ($count > $avecount);
2813: }
2814: untie %thesaurus_db;
2815: # Remove special values from %Keywords.
1.356 albertel 2816: foreach my $value ('total.count','average.count') {
2817: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2818: }
1.46 matthew 2819: return 1;
2820: }
2821:
2822: ###################################################
2823:
2824: =pod
2825:
1.648 raeburn 2826: =item * &keyword($word)
1.46 matthew 2827:
2828: Returns true if $word is a keyword. A keyword is a word that appears more
2829: than the average number of times in the thesaurus database. Calls
2830: &initialize_keywords
2831:
2832: =cut
2833:
2834: ###################################################
1.20 www 2835:
2836: sub keyword {
1.46 matthew 2837: return if (!&initialize_keywords());
2838: my $word=lc(shift());
2839: $word=~s/\W//g;
2840: return exists($Keywords{$word});
1.20 www 2841: }
1.46 matthew 2842:
2843: ###############################################################
2844:
2845: =pod
1.20 www 2846:
1.648 raeburn 2847: =item * &get_related_words()
1.46 matthew 2848:
1.160 matthew 2849: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2850: an array of words. If the keyword is not in the thesaurus, an empty array
2851: will be returned. The order of the words returned is determined by the
2852: database which holds them.
2853:
2854: Uses global $thesaurus_db_file.
2855:
2856: =cut
2857:
2858: ###############################################################
2859: sub get_related_words {
2860: my $keyword = shift;
2861: my %thesaurus_db;
2862: if (! -e $thesaurus_db_file) {
2863: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2864: "failed because the file does not exist");
2865: return ();
2866: }
2867: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2868: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2869: return ();
2870: }
2871: my @Words=();
1.429 www 2872: my $count=0;
1.46 matthew 2873: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2874: # The first element is the number of times
2875: # the word appears. We do not need it now.
1.429 www 2876: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2877: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2878: my $threshold=$mostfrequentcount/10;
2879: foreach my $possibleword (@RelatedWords) {
2880: my ($word,$wordcount)=split(/\,/,$possibleword);
2881: if ($wordcount>$threshold) {
2882: push(@Words,$word);
2883: $count++;
2884: if ($count>10) { last; }
2885: }
1.20 www 2886: }
2887: }
1.46 matthew 2888: untie %thesaurus_db;
2889: return @Words;
1.14 harris41 2890: }
1.46 matthew 2891:
1.112 bowersj2 2892: =pod
2893:
2894: =back
2895:
2896: =cut
1.61 www 2897:
2898: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2899: =pod
2900:
1.112 bowersj2 2901: =head1 User Name Functions
2902:
2903: =over 4
2904:
1.648 raeburn 2905: =item * &plainname($uname,$udom,$first)
1.81 albertel 2906:
1.112 bowersj2 2907: Takes a users logon name and returns it as a string in
1.226 albertel 2908: "first middle last generation" form
2909: if $first is set to 'lastname' then it returns it as
2910: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2911:
2912: =cut
1.61 www 2913:
1.295 www 2914:
1.81 albertel 2915: ###############################################################
1.61 www 2916: sub plainname {
1.226 albertel 2917: my ($uname,$udom,$first)=@_;
1.537 albertel 2918: return if (!defined($uname) || !defined($udom));
1.295 www 2919: my %names=&getnames($uname,$udom);
1.226 albertel 2920: my $name=&Apache::lonnet::format_name($names{'firstname'},
2921: $names{'middlename'},
2922: $names{'lastname'},
2923: $names{'generation'},$first);
2924: $name=~s/^\s+//;
1.62 www 2925: $name=~s/\s+$//;
2926: $name=~s/\s+/ /g;
1.353 albertel 2927: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2928: return $name;
1.61 www 2929: }
1.66 www 2930:
2931: # -------------------------------------------------------------------- Nickname
1.81 albertel 2932: =pod
2933:
1.648 raeburn 2934: =item * &nickname($uname,$udom)
1.81 albertel 2935:
2936: Gets a users name and returns it as a string as
2937:
2938: ""nickname""
1.66 www 2939:
1.81 albertel 2940: if the user has a nickname or
2941:
2942: "first middle last generation"
2943:
2944: if the user does not
2945:
2946: =cut
1.66 www 2947:
2948: sub nickname {
2949: my ($uname,$udom)=@_;
1.537 albertel 2950: return if (!defined($uname) || !defined($udom));
1.295 www 2951: my %names=&getnames($uname,$udom);
1.68 albertel 2952: my $name=$names{'nickname'};
1.66 www 2953: if ($name) {
2954: $name='"'.$name.'"';
2955: } else {
2956: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2957: $names{'lastname'}.' '.$names{'generation'};
2958: $name=~s/\s+$//;
2959: $name=~s/\s+/ /g;
2960: }
2961: return $name;
2962: }
2963:
1.295 www 2964: sub getnames {
2965: my ($uname,$udom)=@_;
1.537 albertel 2966: return if (!defined($uname) || !defined($udom));
1.433 albertel 2967: if ($udom eq 'public' && $uname eq 'public') {
2968: return ('lastname' => &mt('Public'));
2969: }
1.295 www 2970: my $id=$uname.':'.$udom;
2971: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2972: if ($cached) {
2973: return %{$names};
2974: } else {
2975: my %loadnames=&Apache::lonnet::get('environment',
2976: ['firstname','middlename','lastname','generation','nickname'],
2977: $udom,$uname);
2978: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2979: return %loadnames;
2980: }
2981: }
1.61 www 2982:
1.542 raeburn 2983: # -------------------------------------------------------------------- getemails
1.648 raeburn 2984:
1.542 raeburn 2985: =pod
2986:
1.648 raeburn 2987: =item * &getemails($uname,$udom)
1.542 raeburn 2988:
2989: Gets a user's email information and returns it as a hash with keys:
2990: notification, critnotification, permanentemail
2991:
2992: For notification and critnotification, values are comma-separated lists
1.648 raeburn 2993: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 2994:
1.648 raeburn 2995:
1.542 raeburn 2996: =cut
2997:
1.648 raeburn 2998:
1.466 albertel 2999: sub getemails {
3000: my ($uname,$udom)=@_;
3001: if ($udom eq 'public' && $uname eq 'public') {
3002: return;
3003: }
1.467 www 3004: if (!$udom) { $udom=$env{'user.domain'}; }
3005: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 3006: my $id=$uname.':'.$udom;
3007: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
3008: if ($cached) {
3009: return %{$names};
3010: } else {
3011: my %loadnames=&Apache::lonnet::get('environment',
3012: ['notification','critnotification',
3013: 'permanentemail'],
3014: $udom,$uname);
3015: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
3016: return %loadnames;
3017: }
3018: }
3019:
1.551 albertel 3020: sub flush_email_cache {
3021: my ($uname,$udom)=@_;
3022: if (!$udom) { $udom =$env{'user.domain'}; }
3023: if (!$uname) { $uname=$env{'user.name'}; }
3024: return if ($udom eq 'public' && $uname eq 'public');
3025: my $id=$uname.':'.$udom;
3026: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
3027: }
3028:
1.728 raeburn 3029: # -------------------------------------------------------------------- getlangs
3030:
3031: =pod
3032:
3033: =item * &getlangs($uname,$udom)
3034:
3035: Gets a user's language preference and returns it as a hash with key:
3036: language.
3037:
3038: =cut
3039:
3040:
3041: sub getlangs {
3042: my ($uname,$udom) = @_;
3043: if (!$udom) { $udom =$env{'user.domain'}; }
3044: if (!$uname) { $uname=$env{'user.name'}; }
3045: my $id=$uname.':'.$udom;
3046: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
3047: if ($cached) {
3048: return %{$langs};
3049: } else {
3050: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
3051: $udom,$uname);
3052: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
3053: return %loadlangs;
3054: }
3055: }
3056:
3057: sub flush_langs_cache {
3058: my ($uname,$udom)=@_;
3059: if (!$udom) { $udom =$env{'user.domain'}; }
3060: if (!$uname) { $uname=$env{'user.name'}; }
3061: return if ($udom eq 'public' && $uname eq 'public');
3062: my $id=$uname.':'.$udom;
3063: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
3064: }
3065:
1.61 www 3066: # ------------------------------------------------------------------ Screenname
1.81 albertel 3067:
3068: =pod
3069:
1.648 raeburn 3070: =item * &screenname($uname,$udom)
1.81 albertel 3071:
3072: Gets a users screenname and returns it as a string
3073:
3074: =cut
1.61 www 3075:
3076: sub screenname {
3077: my ($uname,$udom)=@_;
1.258 albertel 3078: if ($uname eq $env{'user.name'} &&
3079: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 3080: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 3081: return $names{'screenname'};
1.62 www 3082: }
3083:
1.212 albertel 3084:
1.802 bisitz 3085: # ------------------------------------------------------------- Confirm Wrapper
3086: =pod
3087:
3088: =item confirmwrapper
3089:
3090: Wrap messages about completion of operation in box
3091:
3092: =cut
3093:
3094: sub confirmwrapper {
3095: my ($message)=@_;
3096: if ($message) {
3097: return "\n".'<div class="LC_confirm_box">'."\n"
3098: .$message."\n"
3099: .'</div>'."\n";
3100: } else {
3101: return $message;
3102: }
3103: }
3104:
1.62 www 3105: # ------------------------------------------------------------- Message Wrapper
3106:
3107: sub messagewrapper {
1.369 www 3108: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 3109: return
1.441 albertel 3110: '<a href="/adm/email?compose=individual&'.
3111: 'recname='.$username.'&recdom='.$domain.
3112: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 3113: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 3114: }
1.802 bisitz 3115:
1.74 www 3116: # --------------------------------------------------------------- Notes Wrapper
3117:
3118: sub noteswrapper {
3119: my ($link,$un,$do)=@_;
3120: return
1.896 amueller 3121: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 3122: }
1.802 bisitz 3123:
1.62 www 3124: # ------------------------------------------------------------- Aboutme Wrapper
3125:
3126: sub aboutmewrapper {
1.166 www 3127: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 3128: if (!defined($username) && !defined($domain)) {
3129: return;
3130: }
1.892 amueller 3131: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.756 weissno 3132: ($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 3133: }
3134:
3135: # ------------------------------------------------------------ Syllabus Wrapper
3136:
3137: sub syllabuswrapper {
1.707 bisitz 3138: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 3139: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 3140: }
1.14 harris41 3141:
1.802 bisitz 3142: # -----------------------------------------------------------------------------
3143:
1.208 matthew 3144: sub track_student_link {
1.887 raeburn 3145: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 3146: my $link ="/adm/trackstudent?";
1.208 matthew 3147: my $title = 'View recent activity';
3148: if (defined($sname) && $sname !~ /^\s*$/ &&
3149: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 3150: $link .= "selected_student=$sname:$sdom";
1.208 matthew 3151: $title .= ' of this student';
1.268 albertel 3152: }
1.208 matthew 3153: if (defined($target) && $target !~ /^\s*$/) {
3154: $target = qq{target="$target"};
3155: } else {
3156: $target = '';
3157: }
1.268 albertel 3158: if ($start) { $link.='&start='.$start; }
1.887 raeburn 3159: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 3160: $title = &mt($title);
3161: $linktext = &mt($linktext);
1.448 albertel 3162: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
3163: &help_open_topic('View_recent_activity');
1.208 matthew 3164: }
3165:
1.781 raeburn 3166: sub slot_reservations_link {
3167: my ($linktext,$sname,$sdom,$target) = @_;
3168: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
3169: my $title = 'View slot reservation history';
3170: if (defined($sname) && $sname !~ /^\s*$/ &&
3171: defined($sdom) && $sdom !~ /^\s*$/) {
3172: $link .= "&uname=$sname&udom=$sdom";
3173: $title .= ' of this student';
3174: }
3175: if (defined($target) && $target !~ /^\s*$/) {
3176: $target = qq{target="$target"};
3177: } else {
3178: $target = '';
3179: }
3180: $title = &mt($title);
3181: $linktext = &mt($linktext);
3182: return qq{<a href="$link" title="$title" $target>$linktext</a>};
3183: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
3184:
3185: }
3186:
1.508 www 3187: # ===================================================== Display a student photo
3188:
3189:
1.509 albertel 3190: sub student_image_tag {
1.508 www 3191: my ($domain,$user)=@_;
3192: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
3193: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
3194: return '<img src="'.$imgsrc.'" align="right" />';
3195: } else {
3196: return '';
3197: }
3198: }
3199:
1.112 bowersj2 3200: =pod
3201:
3202: =back
3203:
3204: =head1 Access .tab File Data
3205:
3206: =over 4
3207:
1.648 raeburn 3208: =item * &languageids()
1.112 bowersj2 3209:
3210: returns list of all language ids
3211:
3212: =cut
3213:
1.14 harris41 3214: sub languageids {
1.16 harris41 3215: return sort(keys(%language));
1.14 harris41 3216: }
3217:
1.112 bowersj2 3218: =pod
3219:
1.648 raeburn 3220: =item * &languagedescription()
1.112 bowersj2 3221:
3222: returns description of a specified language id
3223:
3224: =cut
3225:
1.14 harris41 3226: sub languagedescription {
1.125 www 3227: my $code=shift;
3228: return ($supported_language{$code}?'* ':'').
3229: $language{$code}.
1.126 www 3230: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 3231: }
3232:
3233: sub plainlanguagedescription {
3234: my $code=shift;
3235: return $language{$code};
3236: }
3237:
3238: sub supportedlanguagecode {
3239: my $code=shift;
3240: return $supported_language{$code};
1.97 www 3241: }
3242:
1.112 bowersj2 3243: =pod
3244:
1.648 raeburn 3245: =item * ©rightids()
1.112 bowersj2 3246:
3247: returns list of all copyrights
3248:
3249: =cut
3250:
3251: sub copyrightids {
3252: return sort(keys(%cprtag));
3253: }
3254:
3255: =pod
3256:
1.648 raeburn 3257: =item * ©rightdescription()
1.112 bowersj2 3258:
3259: returns description of a specified copyright id
3260:
3261: =cut
3262:
3263: sub copyrightdescription {
1.166 www 3264: return &mt($cprtag{shift(@_)});
1.112 bowersj2 3265: }
1.197 matthew 3266:
3267: =pod
3268:
1.648 raeburn 3269: =item * &source_copyrightids()
1.192 taceyjo1 3270:
3271: returns list of all source copyrights
3272:
3273: =cut
3274:
3275: sub source_copyrightids {
3276: return sort(keys(%scprtag));
3277: }
3278:
3279: =pod
3280:
1.648 raeburn 3281: =item * &source_copyrightdescription()
1.192 taceyjo1 3282:
3283: returns description of a specified source copyright id
3284:
3285: =cut
3286:
3287: sub source_copyrightdescription {
3288: return &mt($scprtag{shift(@_)});
3289: }
1.112 bowersj2 3290:
3291: =pod
3292:
1.648 raeburn 3293: =item * &filecategories()
1.112 bowersj2 3294:
3295: returns list of all file categories
3296:
3297: =cut
3298:
3299: sub filecategories {
3300: return sort(keys(%category_extensions));
3301: }
3302:
3303: =pod
3304:
1.648 raeburn 3305: =item * &filecategorytypes()
1.112 bowersj2 3306:
3307: returns list of file types belonging to a given file
3308: category
3309:
3310: =cut
3311:
3312: sub filecategorytypes {
1.356 albertel 3313: my ($cat) = @_;
3314: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 3315: }
3316:
3317: =pod
3318:
1.648 raeburn 3319: =item * &fileembstyle()
1.112 bowersj2 3320:
3321: returns embedding style for a specified file type
3322:
3323: =cut
3324:
3325: sub fileembstyle {
3326: return $fe{lc(shift(@_))};
1.169 www 3327: }
3328:
1.351 www 3329: sub filemimetype {
3330: return $fm{lc(shift(@_))};
3331: }
3332:
1.169 www 3333:
3334: sub filecategoryselect {
3335: my ($name,$value)=@_;
1.189 matthew 3336: return &select_form($value,$name,
1.970 raeburn 3337: {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112 bowersj2 3338: }
3339:
3340: =pod
3341:
1.648 raeburn 3342: =item * &filedescription()
1.112 bowersj2 3343:
3344: returns description for a specified file type
3345:
3346: =cut
3347:
3348: sub filedescription {
1.188 matthew 3349: my $file_description = $fd{lc(shift())};
3350: $file_description =~ s:([\[\]]):~$1:g;
3351: return &mt($file_description);
1.112 bowersj2 3352: }
3353:
3354: =pod
3355:
1.648 raeburn 3356: =item * &filedescriptionex()
1.112 bowersj2 3357:
3358: returns description for a specified file type with
3359: extra formatting
3360:
3361: =cut
3362:
3363: sub filedescriptionex {
3364: my $ex=shift;
1.188 matthew 3365: my $file_description = $fd{lc($ex)};
3366: $file_description =~ s:([\[\]]):~$1:g;
3367: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3368: }
3369:
3370: # End of .tab access
3371: =pod
3372:
3373: =back
3374:
3375: =cut
3376:
3377: # ------------------------------------------------------------------ File Types
3378: sub fileextensions {
3379: return sort(keys(%fe));
3380: }
3381:
1.97 www 3382: # ----------------------------------------------------------- Display Languages
3383: # returns a hash with all desired display languages
3384: #
3385:
3386: sub display_languages {
3387: my %languages=();
1.695 raeburn 3388: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3389: $languages{$lang}=1;
1.97 www 3390: }
3391: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3392: if ($env{'form.displaylanguage'}) {
1.356 albertel 3393: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3394: $languages{$lang}=1;
1.97 www 3395: }
3396: }
3397: return %languages;
1.14 harris41 3398: }
3399:
1.582 albertel 3400: sub languages {
3401: my ($possible_langs) = @_;
1.695 raeburn 3402: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3403: if (!ref($possible_langs)) {
3404: if( wantarray ) {
3405: return @preferred_langs;
3406: } else {
3407: return $preferred_langs[0];
3408: }
3409: }
3410: my %possibilities = map { $_ => 1 } (@$possible_langs);
3411: my @preferred_possibilities;
3412: foreach my $preferred_lang (@preferred_langs) {
3413: if (exists($possibilities{$preferred_lang})) {
3414: push(@preferred_possibilities, $preferred_lang);
3415: }
3416: }
3417: if( wantarray ) {
3418: return @preferred_possibilities;
3419: }
3420: return $preferred_possibilities[0];
3421: }
3422:
1.742 raeburn 3423: sub user_lang {
3424: my ($touname,$toudom,$fromcid) = @_;
3425: my @userlangs;
3426: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3427: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3428: $env{'course.'.$fromcid.'.languages'}));
3429: } else {
3430: my %langhash = &getlangs($touname,$toudom);
3431: if ($langhash{'languages'} ne '') {
3432: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3433: } else {
3434: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3435: if ($domdefs{'lang_def'} ne '') {
3436: @userlangs = ($domdefs{'lang_def'});
3437: }
3438: }
3439: }
3440: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3441: my $user_lh = Apache::localize->get_handle(@languages);
3442: return $user_lh;
3443: }
3444:
3445:
1.112 bowersj2 3446: ###############################################################
3447: ## Student Answer Attempts ##
3448: ###############################################################
3449:
3450: =pod
3451:
3452: =head1 Alternate Problem Views
3453:
3454: =over 4
3455:
1.648 raeburn 3456: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3457: $getattempt, $regexp, $gradesub)
3458:
3459: Return string with previous attempt on problem. Arguments:
3460:
3461: =over 4
3462:
3463: =item * $symb: Problem, including path
3464:
3465: =item * $username: username of the desired student
3466:
3467: =item * $domain: domain of the desired student
1.14 harris41 3468:
1.112 bowersj2 3469: =item * $course: Course ID
1.14 harris41 3470:
1.112 bowersj2 3471: =item * $getattempt: Leave blank for all attempts, otherwise put
3472: something
1.14 harris41 3473:
1.112 bowersj2 3474: =item * $regexp: if string matches this regexp, the string will be
3475: sent to $gradesub
1.14 harris41 3476:
1.112 bowersj2 3477: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3478:
1.112 bowersj2 3479: =back
1.14 harris41 3480:
1.112 bowersj2 3481: The output string is a table containing all desired attempts, if any.
1.16 harris41 3482:
1.112 bowersj2 3483: =cut
1.1 albertel 3484:
3485: sub get_previous_attempt {
1.43 ng 3486: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3487: my $prevattempts='';
1.43 ng 3488: no strict 'refs';
1.1 albertel 3489: if ($symb) {
1.3 albertel 3490: my (%returnhash)=
3491: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3492: if ($returnhash{'version'}) {
3493: my %lasthash=();
3494: my $version;
3495: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3496: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3497: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3498: }
1.1 albertel 3499: }
1.596 albertel 3500: $prevattempts=&start_data_table().&start_data_table_header_row();
3501: $prevattempts.='<th>'.&mt('History').'</th>';
1.978 raeburn 3502: my (%typeparts,%lasthidden);
1.945 raeburn 3503: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 3504: foreach my $key (sort(keys(%lasthash))) {
3505: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3506: if ($#parts > 0) {
1.31 albertel 3507: my $data=$parts[-1];
1.989 raeburn 3508: next if ($data eq 'foilorder');
1.31 albertel 3509: pop(@parts);
1.1010 www 3510: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.945 raeburn 3511: if ($data eq 'type') {
3512: unless ($showsurv) {
3513: my $id = join(',',@parts);
3514: $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978 raeburn 3515: if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
3516: $lasthidden{$ign.'.'.$id} = 1;
3517: }
1.945 raeburn 3518: }
1.1010 www 3519: }
1.31 albertel 3520: } else {
1.41 ng 3521: if ($#parts == 0) {
3522: $prevattempts.='<th>'.$parts[0].'</th>';
3523: } else {
3524: $prevattempts.='<th>'.$ign.'</th>';
3525: }
1.31 albertel 3526: }
1.16 harris41 3527: }
1.596 albertel 3528: $prevattempts.=&end_data_table_header_row();
1.40 ng 3529: if ($getattempt eq '') {
3530: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.945 raeburn 3531: my @hidden;
3532: if (%typeparts) {
3533: foreach my $id (keys(%typeparts)) {
3534: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
3535: push(@hidden,$id);
3536: }
3537: }
3538: }
3539: $prevattempts.=&start_data_table_row().
3540: '<td>'.&mt('Transaction [_1]',$version).'</td>';
3541: if (@hidden) {
3542: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3543: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3544: my $hide;
3545: foreach my $id (@hidden) {
3546: if ($key =~ /^\Q$id\E/) {
3547: $hide = 1;
3548: last;
3549: }
3550: }
3551: if ($hide) {
3552: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3553: if (($data eq 'award') || ($data eq 'awarddetail')) {
3554: my $value = &format_previous_attempt_value($key,
3555: $returnhash{$version.':'.$key});
3556: $prevattempts.='<td>'.$value.' </td>';
3557: } else {
3558: $prevattempts.='<td> </td>';
3559: }
3560: } else {
3561: if ($key =~ /\./) {
3562: my $value = &format_previous_attempt_value($key,
3563: $returnhash{$version.':'.$key});
3564: $prevattempts.='<td>'.$value.' </td>';
3565: } else {
3566: $prevattempts.='<td> </td>';
3567: }
3568: }
3569: }
3570: } else {
3571: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3572: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3573: my $value = &format_previous_attempt_value($key,
3574: $returnhash{$version.':'.$key});
3575: $prevattempts.='<td>'.$value.' </td>';
3576: }
3577: }
3578: $prevattempts.=&end_data_table_row();
1.40 ng 3579: }
1.1 albertel 3580: }
1.945 raeburn 3581: my @currhidden = keys(%lasthidden);
1.596 albertel 3582: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3583: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3584: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3585: if (%typeparts) {
3586: my $hidden;
3587: foreach my $id (@currhidden) {
3588: if ($key =~ /^\Q$id\E/) {
3589: $hidden = 1;
3590: last;
3591: }
3592: }
3593: if ($hidden) {
3594: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3595: if (($data eq 'award') || ($data eq 'awarddetail')) {
3596: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3597: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3598: $value = &$gradesub($value);
3599: }
3600: $prevattempts.='<td>'.$value.' </td>';
3601: } else {
3602: $prevattempts.='<td> </td>';
3603: }
3604: } else {
3605: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3606: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3607: $value = &$gradesub($value);
3608: }
3609: $prevattempts.='<td>'.$value.' </td>';
3610: }
3611: } else {
3612: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3613: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3614: $value = &$gradesub($value);
3615: }
3616: $prevattempts.='<td>'.$value.' </td>';
3617: }
1.16 harris41 3618: }
1.596 albertel 3619: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3620: } else {
1.596 albertel 3621: $prevattempts=
3622: &start_data_table().&start_data_table_row().
3623: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3624: &end_data_table_row().&end_data_table();
1.1 albertel 3625: }
3626: } else {
1.596 albertel 3627: $prevattempts=
3628: &start_data_table().&start_data_table_row().
3629: '<td>'.&mt('No data.').'</td>'.
3630: &end_data_table_row().&end_data_table();
1.1 albertel 3631: }
1.10 albertel 3632: }
3633:
1.581 albertel 3634: sub format_previous_attempt_value {
3635: my ($key,$value) = @_;
1.1011 www 3636: if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.581 albertel 3637: $value = &Apache::lonlocal::locallocaltime($value);
3638: } elsif (ref($value) eq 'ARRAY') {
3639: $value = '('.join(', ', @{ $value }).')';
1.988 raeburn 3640: } elsif ($key =~ /answerstring$/) {
3641: my %answers = &Apache::lonnet::str2hash($value);
3642: my @anskeys = sort(keys(%answers));
3643: if (@anskeys == 1) {
3644: my $answer = $answers{$anskeys[0]};
1.1001 raeburn 3645: if ($answer =~ m{\0}) {
3646: $answer =~ s{\0}{,}g;
1.988 raeburn 3647: }
3648: my $tag_internal_answer_name = 'INTERNAL';
3649: if ($anskeys[0] eq $tag_internal_answer_name) {
3650: $value = $answer;
3651: } else {
3652: $value = $anskeys[0].'='.$answer;
3653: }
3654: } else {
3655: foreach my $ans (@anskeys) {
3656: my $answer = $answers{$ans};
1.1001 raeburn 3657: if ($answer =~ m{\0}) {
3658: $answer =~ s{\0}{,}g;
1.988 raeburn 3659: }
3660: $value .= $ans.'='.$answer.'<br />';;
3661: }
3662: }
1.581 albertel 3663: } else {
3664: $value = &unescape($value);
3665: }
3666: return $value;
3667: }
3668:
3669:
1.107 albertel 3670: sub relative_to_absolute {
3671: my ($url,$output)=@_;
3672: my $parser=HTML::TokeParser->new(\$output);
3673: my $token;
3674: my $thisdir=$url;
3675: my @rlinks=();
3676: while ($token=$parser->get_token) {
3677: if ($token->[0] eq 'S') {
3678: if ($token->[1] eq 'a') {
3679: if ($token->[2]->{'href'}) {
3680: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3681: }
3682: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3683: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3684: } elsif ($token->[1] eq 'base') {
3685: $thisdir=$token->[2]->{'href'};
3686: }
3687: }
3688: }
3689: $thisdir=~s-/[^/]*$--;
1.356 albertel 3690: foreach my $link (@rlinks) {
1.726 raeburn 3691: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3692: ($link=~/^\//) ||
3693: ($link=~/^javascript:/i) ||
3694: ($link=~/^mailto:/i) ||
3695: ($link=~/^\#/)) {
3696: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3697: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3698: }
3699: }
3700: # -------------------------------------------------- Deal with Applet codebases
3701: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3702: return $output;
3703: }
3704:
1.112 bowersj2 3705: =pod
3706:
1.648 raeburn 3707: =item * &get_student_view()
1.112 bowersj2 3708:
3709: show a snapshot of what student was looking at
3710:
3711: =cut
3712:
1.10 albertel 3713: sub get_student_view {
1.186 albertel 3714: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3715: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3716: my (%form);
1.10 albertel 3717: my @elements=('symb','courseid','domain','username');
3718: foreach my $element (@elements) {
1.186 albertel 3719: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3720: }
1.186 albertel 3721: if (defined($moreenv)) {
3722: %form=(%form,%{$moreenv});
3723: }
1.236 albertel 3724: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3725: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3726: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3727: $userview=~s/\<body[^\>]*\>//gi;
3728: $userview=~s/\<\/body\>//gi;
3729: $userview=~s/\<html\>//gi;
3730: $userview=~s/\<\/html\>//gi;
3731: $userview=~s/\<head\>//gi;
3732: $userview=~s/\<\/head\>//gi;
3733: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3734: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3735: if (wantarray) {
3736: return ($userview,$response);
3737: } else {
3738: return $userview;
3739: }
3740: }
3741:
3742: sub get_student_view_with_retries {
3743: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3744:
3745: my $ok = 0; # True if we got a good response.
3746: my $content;
3747: my $response;
3748:
3749: # Try to get the student_view done. within the retries count:
3750:
3751: do {
3752: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3753: $ok = $response->is_success;
3754: if (!$ok) {
3755: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3756: }
3757: $retries--;
3758: } while (!$ok && ($retries > 0));
3759:
3760: if (!$ok) {
3761: $content = ''; # On error return an empty content.
3762: }
1.651 www 3763: if (wantarray) {
3764: return ($content, $response);
3765: } else {
3766: return $content;
3767: }
1.11 albertel 3768: }
3769:
1.112 bowersj2 3770: =pod
3771:
1.648 raeburn 3772: =item * &get_student_answers()
1.112 bowersj2 3773:
3774: show a snapshot of how student was answering problem
3775:
3776: =cut
3777:
1.11 albertel 3778: sub get_student_answers {
1.100 sakharuk 3779: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3780: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3781: my (%moreenv);
1.11 albertel 3782: my @elements=('symb','courseid','domain','username');
3783: foreach my $element (@elements) {
1.186 albertel 3784: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3785: }
1.186 albertel 3786: $moreenv{'grade_target'}='answer';
3787: %moreenv=(%form,%moreenv);
1.497 raeburn 3788: $feedurl = &Apache::lonnet::clutter($feedurl);
3789: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3790: return $userview;
1.1 albertel 3791: }
1.116 albertel 3792:
3793: =pod
3794:
3795: =item * &submlink()
3796:
1.242 albertel 3797: Inputs: $text $uname $udom $symb $target
1.116 albertel 3798:
3799: Returns: A link to grades.pm such as to see the SUBM view of a student
3800:
3801: =cut
3802:
3803: ###############################################
3804: sub submlink {
1.242 albertel 3805: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3806: if (!($uname && $udom)) {
3807: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3808: &Apache::lonnet::whichuser($symb);
1.116 albertel 3809: if (!$symb) { $symb=$cursymb; }
3810: }
1.254 matthew 3811: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3812: $symb=&escape($symb);
1.960 bisitz 3813: if ($target) { $target=" target=\"$target\""; }
3814: return
3815: '<a href="/adm/grades?command=submission'.
3816: '&symb='.$symb.
3817: '&student='.$uname.
3818: '&userdom='.$udom.'"'.
3819: $target.'>'.$text.'</a>';
1.242 albertel 3820: }
3821: ##############################################
3822:
3823: =pod
3824:
3825: =item * &pgrdlink()
3826:
3827: Inputs: $text $uname $udom $symb $target
3828:
3829: Returns: A link to grades.pm such as to see the PGRD view of a student
3830:
3831: =cut
3832:
3833: ###############################################
3834: sub pgrdlink {
3835: my $link=&submlink(@_);
3836: $link=~s/(&command=submission)/$1&showgrading=yes/;
3837: return $link;
3838: }
3839: ##############################################
3840:
3841: =pod
3842:
3843: =item * &pprmlink()
3844:
3845: Inputs: $text $uname $udom $symb $target
3846:
3847: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3848: student and a specific resource
1.242 albertel 3849:
3850: =cut
3851:
3852: ###############################################
3853: sub pprmlink {
3854: my ($text,$uname,$udom,$symb,$target)=@_;
3855: if (!($uname && $udom)) {
3856: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3857: &Apache::lonnet::whichuser($symb);
1.242 albertel 3858: if (!$symb) { $symb=$cursymb; }
3859: }
1.254 matthew 3860: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3861: $symb=&escape($symb);
1.242 albertel 3862: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3863: return '<a href="/adm/parmset?command=set&'.
3864: 'symb='.$symb.'&uname='.$uname.
3865: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3866: }
3867: ##############################################
1.37 matthew 3868:
1.112 bowersj2 3869: =pod
3870:
3871: =back
3872:
3873: =cut
3874:
1.37 matthew 3875: ###############################################
1.51 www 3876:
3877:
3878: sub timehash {
1.687 raeburn 3879: my ($thistime) = @_;
3880: my $timezone = &Apache::lonlocal::gettimezone();
3881: my $dt = DateTime->from_epoch(epoch => $thistime)
3882: ->set_time_zone($timezone);
3883: my $wday = $dt->day_of_week();
3884: if ($wday == 7) { $wday = 0; }
3885: return ( 'second' => $dt->second(),
3886: 'minute' => $dt->minute(),
3887: 'hour' => $dt->hour(),
3888: 'day' => $dt->day_of_month(),
3889: 'month' => $dt->month(),
3890: 'year' => $dt->year(),
3891: 'weekday' => $wday,
3892: 'dayyear' => $dt->day_of_year(),
3893: 'dlsav' => $dt->is_dst() );
1.51 www 3894: }
3895:
1.370 www 3896: sub utc_string {
3897: my ($date)=@_;
1.371 www 3898: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3899: }
3900:
1.51 www 3901: sub maketime {
3902: my %th=@_;
1.687 raeburn 3903: my ($epoch_time,$timezone,$dt);
3904: $timezone = &Apache::lonlocal::gettimezone();
3905: eval {
3906: $dt = DateTime->new( year => $th{'year'},
3907: month => $th{'month'},
3908: day => $th{'day'},
3909: hour => $th{'hour'},
3910: minute => $th{'minute'},
3911: second => $th{'second'},
3912: time_zone => $timezone,
3913: );
3914: };
3915: if (!$@) {
3916: $epoch_time = $dt->epoch;
3917: if ($epoch_time) {
3918: return $epoch_time;
3919: }
3920: }
1.51 www 3921: return POSIX::mktime(
3922: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3923: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3924: }
3925:
3926: #########################################
1.51 www 3927:
3928: sub findallcourses {
1.482 raeburn 3929: my ($roles,$uname,$udom) = @_;
1.355 albertel 3930: my %roles;
3931: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3932: my %courses;
1.51 www 3933: my $now=time;
1.482 raeburn 3934: if (!defined($uname)) {
3935: $uname = $env{'user.name'};
3936: }
3937: if (!defined($udom)) {
3938: $udom = $env{'user.domain'};
3939: }
3940: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.982 raeburn 3941: my $extra = &Apache::lonnet::freeze_escape({'skipcheck' => 1});
3942: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname,'.',undef,
3943: $extra);
1.482 raeburn 3944: if (!%roles) {
3945: %roles = (
3946: cc => 1,
1.907 raeburn 3947: co => 1,
1.482 raeburn 3948: in => 1,
3949: ep => 1,
3950: ta => 1,
3951: cr => 1,
3952: st => 1,
3953: );
3954: }
3955: foreach my $entry (keys(%roleshash)) {
3956: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3957: if ($trole =~ /^cr/) {
3958: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3959: } else {
3960: next if (!exists($roles{$trole}));
3961: }
3962: if ($tend) {
3963: next if ($tend < $now);
3964: }
3965: if ($tstart) {
3966: next if ($tstart > $now);
3967: }
3968: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3969: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3970: if ($secpart eq '') {
3971: ($cnum,$role) = split(/_/,$cnumpart);
3972: $sec = 'none';
3973: $realsec = '';
3974: } else {
3975: $cnum = $cnumpart;
3976: ($sec,$role) = split(/_/,$secpart);
3977: $realsec = $sec;
1.490 raeburn 3978: }
1.482 raeburn 3979: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3980: }
3981: } else {
3982: foreach my $key (keys(%env)) {
1.483 albertel 3983: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3984: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3985: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3986: next if ($role eq 'ca' || $role eq 'aa');
3987: next if (%roles && !exists($roles{$role}));
3988: my ($starttime,$endtime)=split(/\./,$env{$key});
3989: my $active=1;
3990: if ($starttime) {
3991: if ($now<$starttime) { $active=0; }
3992: }
3993: if ($endtime) {
3994: if ($now>$endtime) { $active=0; }
3995: }
3996: if ($active) {
3997: if ($sec eq '') {
3998: $sec = 'none';
3999: }
4000: $courses{$cdom.'_'.$cnum}{$sec} =
4001: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 4002: }
4003: }
1.51 www 4004: }
4005: }
1.474 raeburn 4006: return %courses;
1.51 www 4007: }
1.37 matthew 4008:
1.54 www 4009: ###############################################
1.474 raeburn 4010:
4011: sub blockcheck {
1.482 raeburn 4012: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 4013:
4014: if (!defined($udom)) {
4015: $udom = $env{'user.domain'};
4016: }
4017: if (!defined($uname)) {
4018: $uname = $env{'user.name'};
4019: }
4020:
4021: # If uname and udom are for a course, check for blocks in the course.
4022:
4023: if (&Apache::lonnet::is_course($udom,$uname)) {
4024: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 4025: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 4026: return ($startblock,$endblock);
4027: }
1.474 raeburn 4028:
1.502 raeburn 4029: my $startblock = 0;
4030: my $endblock = 0;
1.482 raeburn 4031: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 4032:
1.490 raeburn 4033: # If uname is for a user, and activity is course-specific, i.e.,
4034: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 4035:
1.490 raeburn 4036: if (($activity eq 'boards' || $activity eq 'chat' ||
4037: $activity eq 'groups') && ($env{'request.course.id'})) {
4038: foreach my $key (keys(%live_courses)) {
4039: if ($key ne $env{'request.course.id'}) {
4040: delete($live_courses{$key});
4041: }
4042: }
4043: }
4044:
4045: my $otheruser = 0;
4046: my %own_courses;
4047: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
4048: # Resource belongs to user other than current user.
4049: $otheruser = 1;
4050: # Gather courses for current user
4051: %own_courses =
4052: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
4053: }
4054:
4055: # Gather active course roles - course coordinator, instructor,
4056: # exam proctor, ta, student, or custom role.
1.474 raeburn 4057:
4058: foreach my $course (keys(%live_courses)) {
1.482 raeburn 4059: my ($cdom,$cnum);
4060: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
4061: $cdom = $env{'course.'.$course.'.domain'};
4062: $cnum = $env{'course.'.$course.'.num'};
4063: } else {
1.490 raeburn 4064: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 4065: }
4066: my $no_ownblock = 0;
4067: my $no_userblock = 0;
1.533 raeburn 4068: if ($otheruser && $activity ne 'com') {
1.490 raeburn 4069: # Check if current user has 'evb' priv for this
4070: if (defined($own_courses{$course})) {
4071: foreach my $sec (keys(%{$own_courses{$course}})) {
4072: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
4073: if ($sec ne 'none') {
4074: $checkrole .= '/'.$sec;
4075: }
4076: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4077: $no_ownblock = 1;
4078: last;
4079: }
4080: }
4081: }
4082: # if they have 'evb' priv and are currently not playing student
4083: next if (($no_ownblock) &&
4084: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
4085: }
1.474 raeburn 4086: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 4087: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 4088: if ($sec ne 'none') {
1.482 raeburn 4089: $checkrole .= '/'.$sec;
1.474 raeburn 4090: }
1.490 raeburn 4091: if ($otheruser) {
4092: # Resource belongs to user other than current user.
4093: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 4094: my ($trole,$tdom,$tnum,$tsec);
4095: my $entry = $live_courses{$course}{$sec};
4096: if ($entry =~ /^cr/) {
4097: ($trole,$tdom,$tnum,$tsec) =
4098: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
4099: } else {
4100: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
4101: }
4102: my ($spec,$area,$trest,%allroles,%userroles);
4103: $area = '/'.$tdom.'/'.$tnum;
4104: $trest = $tnum;
4105: if ($tsec ne '') {
4106: $area .= '/'.$tsec;
4107: $trest .= '/'.$tsec;
4108: }
4109: $spec = $trole.'.'.$area;
4110: if ($trole =~ /^cr/) {
4111: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
4112: $tdom,$spec,$trest,$area);
4113: } else {
4114: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
4115: $tdom,$spec,$trest,$area);
4116: }
4117: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 4118: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
4119: if ($1) {
4120: $no_userblock = 1;
4121: last;
4122: }
4123: }
1.490 raeburn 4124: } else {
4125: # Resource belongs to current user
4126: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 4127: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4128: $no_ownblock = 1;
4129: last;
4130: }
1.474 raeburn 4131: }
4132: }
4133: # if they have the evb priv and are currently not playing student
1.482 raeburn 4134: next if (($no_ownblock) &&
1.491 albertel 4135: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 4136: next if ($no_userblock);
1.474 raeburn 4137:
1.866 kalberla 4138: # Retrieve blocking times and identity of locker for course
1.490 raeburn 4139: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 4140:
4141: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
4142: if (($start != 0) &&
4143: (($startblock == 0) || ($startblock > $start))) {
4144: $startblock = $start;
4145: }
4146: if (($end != 0) &&
4147: (($endblock == 0) || ($endblock < $end))) {
4148: $endblock = $end;
4149: }
1.490 raeburn 4150: }
4151: return ($startblock,$endblock);
4152: }
4153:
4154: sub get_blocks {
4155: my ($setters,$activity,$cdom,$cnum) = @_;
4156: my $startblock = 0;
4157: my $endblock = 0;
4158: my $course = $cdom.'_'.$cnum;
4159: $setters->{$course} = {};
4160: $setters->{$course}{'staff'} = [];
4161: $setters->{$course}{'times'} = [];
4162: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
4163: foreach my $record (keys(%records)) {
4164: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
4165: if ($start <= time && $end >= time) {
4166: my ($staff_name,$staff_dom,$title,$blocks) =
4167: &parse_block_record($records{$record});
4168: if ($blocks->{$activity} eq 'on') {
4169: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
4170: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 4171: if ( ($startblock == 0) || ($startblock > $start) ) {
4172: $startblock = $start;
1.490 raeburn 4173: }
1.491 albertel 4174: if ( ($endblock == 0) || ($endblock < $end) ) {
4175: $endblock = $end;
1.474 raeburn 4176: }
4177: }
4178: }
4179: }
4180: return ($startblock,$endblock);
4181: }
4182:
4183: sub parse_block_record {
4184: my ($record) = @_;
4185: my ($setuname,$setudom,$title,$blocks);
4186: if (ref($record) eq 'HASH') {
4187: ($setuname,$setudom) = split(/:/,$record->{'setter'});
4188: $title = &unescape($record->{'event'});
4189: $blocks = $record->{'blocks'};
4190: } else {
4191: my @data = split(/:/,$record,3);
4192: if (scalar(@data) eq 2) {
4193: $title = $data[1];
4194: ($setuname,$setudom) = split(/@/,$data[0]);
4195: } else {
4196: ($setuname,$setudom,$title) = @data;
4197: }
4198: $blocks = { 'com' => 'on' };
4199: }
4200: return ($setuname,$setudom,$title,$blocks);
4201: }
4202:
1.854 kalberla 4203: sub blocking_status {
4204: my ($activity,$uname,$udom) = @_;
1.867 kalberla 4205: my %setters;
1.890 droeschl 4206:
4207: # check for active blocking
1.867 kalberla 4208: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
1.854 kalberla 4209:
1.890 droeschl 4210: my $blocked = $startblock && $endblock ? 1 : 0;
4211:
4212: # caller just wants to know whether a block is active
4213: if (!wantarray) { return $blocked; }
4214:
4215: # build a link to a popup window containing the details
4216: my $querystring = "?activity=$activity";
4217: # $uname and $udom decide whose portfolio the user is trying to look at
4218: $querystring .= "&udom=$udom" if $udom;
4219: $querystring .= "&uname=$uname" if $uname;
4220:
4221: my $output .= <<'END_MYBLOCK';
1.854 kalberla 4222: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
4223: var options = "width=" + w + ",height=" + h + ",";
4224: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
4225: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
4226: var newWin = window.open(url, wdwName, options);
4227: newWin.focus();
4228: }
1.890 droeschl 4229: END_MYBLOCK
1.854 kalberla 4230:
1.890 droeschl 4231: $output = Apache::lonhtmlcommon::scripttag($output);
4232:
1.854 kalberla 4233: my $popupUrl = "/adm/blockingstatus/$querystring";
1.890 droeschl 4234: my $text = mt('Communication Blocked');
4235:
1.867 kalberla 4236: $output .= <<"END_BLOCK";
4237: <div class='LC_comblock'>
1.869 kalberla 4238: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4239: title='$text'>
4240: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 4241: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4242: title='$text'>$text</a>
1.867 kalberla 4243: </div>
4244:
4245: END_BLOCK
1.474 raeburn 4246:
1.854 kalberla 4247: return ($blocked, $output);
4248: }
1.490 raeburn 4249:
1.60 matthew 4250: ###############################################
4251:
1.682 raeburn 4252: sub check_ip_acc {
4253: my ($acc)=@_;
4254: &Apache::lonxml::debug("acc is $acc");
4255: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
4256: return 1;
4257: }
4258: my $allowed=0;
4259: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
4260:
4261: my $name;
4262: foreach my $pattern (split(',',$acc)) {
4263: $pattern =~ s/^\s*//;
4264: $pattern =~ s/\s*$//;
4265: if ($pattern =~ /\*$/) {
4266: #35.8.*
4267: $pattern=~s/\*//;
4268: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4269: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
4270: #35.8.3.[34-56]
4271: my $low=$2;
4272: my $high=$3;
4273: $pattern=$1;
4274: if ($ip =~ /^\Q$pattern\E/) {
4275: my $last=(split(/\./,$ip))[3];
4276: if ($last <=$high && $last >=$low) { $allowed=1; }
4277: }
4278: } elsif ($pattern =~ /^\*/) {
4279: #*.msu.edu
4280: $pattern=~s/\*//;
4281: if (!defined($name)) {
4282: use Socket;
4283: my $netaddr=inet_aton($ip);
4284: ($name)=gethostbyaddr($netaddr,AF_INET);
4285: }
4286: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4287: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
4288: #127.0.0.1
4289: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4290: } else {
4291: #some.name.com
4292: if (!defined($name)) {
4293: use Socket;
4294: my $netaddr=inet_aton($ip);
4295: ($name)=gethostbyaddr($netaddr,AF_INET);
4296: }
4297: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4298: }
4299: if ($allowed) { last; }
4300: }
4301: return $allowed;
4302: }
4303:
4304: ###############################################
4305:
1.60 matthew 4306: =pod
4307:
1.112 bowersj2 4308: =head1 Domain Template Functions
4309:
4310: =over 4
4311:
4312: =item * &determinedomain()
1.60 matthew 4313:
4314: Inputs: $domain (usually will be undef)
4315:
1.63 www 4316: Returns: Determines which domain should be used for designs
1.60 matthew 4317:
4318: =cut
1.54 www 4319:
1.60 matthew 4320: ###############################################
1.63 www 4321: sub determinedomain {
4322: my $domain=shift;
1.531 albertel 4323: if (! $domain) {
1.60 matthew 4324: # Determine domain if we have not been given one
1.893 raeburn 4325: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 4326: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
4327: if ($env{'request.role.domain'}) {
4328: $domain=$env{'request.role.domain'};
1.60 matthew 4329: }
4330: }
1.63 www 4331: return $domain;
4332: }
4333: ###############################################
1.517 raeburn 4334:
1.518 albertel 4335: sub devalidate_domconfig_cache {
4336: my ($udom)=@_;
4337: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
4338: }
4339:
4340: # ---------------------- Get domain configuration for a domain
4341: sub get_domainconf {
4342: my ($udom) = @_;
4343: my $cachetime=1800;
4344: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
4345: if (defined($cached)) { return %{$result}; }
4346:
4347: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 4348: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 4349: my (%designhash,%legacy);
1.518 albertel 4350: if (keys(%domconfig) > 0) {
4351: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 4352: if (keys(%{$domconfig{'login'}})) {
4353: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 4354: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.946 raeburn 4355: if ($key eq 'loginvia') {
4356: if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') {
1.1013 raeburn 4357: foreach my $hostname (keys(%{$domconfig{'login'}{'loginvia'}})) {
1.948 raeburn 4358: if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') {
4359: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
4360: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
4361: $designhash{$udom.'.login.loginvia'} = $server;
4362: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
4363:
4364: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
4365: } else {
1.1013 raeburn 4366: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
1.948 raeburn 4367: }
4368: if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) {
4369: $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'};
4370: }
1.946 raeburn 4371: }
4372: }
4373: }
4374: }
4375: } else {
4376: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
4377: $designhash{$udom.'.login.'.$key.'_'.$img} =
4378: $domconfig{'login'}{$key}{$img};
4379: }
1.699 raeburn 4380: }
4381: } else {
4382: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
4383: }
1.632 raeburn 4384: }
4385: } else {
4386: $legacy{'login'} = 1;
1.518 albertel 4387: }
1.632 raeburn 4388: } else {
4389: $legacy{'login'} = 1;
1.518 albertel 4390: }
4391: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 4392: if (keys(%{$domconfig{'rolecolors'}})) {
4393: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
4394: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
4395: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
4396: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
4397: }
1.518 albertel 4398: }
4399: }
1.632 raeburn 4400: } else {
4401: $legacy{'rolecolors'} = 1;
1.518 albertel 4402: }
1.632 raeburn 4403: } else {
4404: $legacy{'rolecolors'} = 1;
1.518 albertel 4405: }
1.948 raeburn 4406: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
4407: if ($domconfig{'autoenroll'}{'co-owners'}) {
4408: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
4409: }
4410: }
1.632 raeburn 4411: if (keys(%legacy) > 0) {
4412: my %legacyhash = &get_legacy_domconf($udom);
4413: foreach my $item (keys(%legacyhash)) {
4414: if ($item =~ /^\Q$udom\E\.login/) {
4415: if ($legacy{'login'}) {
4416: $designhash{$item} = $legacyhash{$item};
4417: }
4418: } else {
4419: if ($legacy{'rolecolors'}) {
4420: $designhash{$item} = $legacyhash{$item};
4421: }
1.518 albertel 4422: }
4423: }
4424: }
1.632 raeburn 4425: } else {
4426: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4427: }
4428: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4429: $cachetime);
4430: return %designhash;
4431: }
4432:
1.632 raeburn 4433: sub get_legacy_domconf {
4434: my ($udom) = @_;
4435: my %legacyhash;
4436: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4437: my $designfile = $designdir.'/'.$udom.'.tab';
4438: if (-e $designfile) {
4439: if ( open (my $fh,"<$designfile") ) {
4440: while (my $line = <$fh>) {
4441: next if ($line =~ /^\#/);
4442: chomp($line);
4443: my ($key,$val)=(split(/\=/,$line));
4444: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4445: }
4446: close($fh);
4447: }
4448: }
1.1026 raeburn 4449: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632 raeburn 4450: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4451: }
4452: return %legacyhash;
4453: }
4454:
1.63 www 4455: =pod
4456:
1.112 bowersj2 4457: =item * &domainlogo()
1.63 www 4458:
4459: Inputs: $domain (usually will be undef)
4460:
4461: Returns: A link to a domain logo, if the domain logo exists.
4462: If the domain logo does not exist, a description of the domain.
4463:
4464: =cut
1.112 bowersj2 4465:
1.63 www 4466: ###############################################
4467: sub domainlogo {
1.517 raeburn 4468: my $domain = &determinedomain(shift);
1.518 albertel 4469: my %designhash = &get_domainconf($domain);
1.517 raeburn 4470: # See if there is a logo
4471: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4472: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4473: if ($imgsrc =~ m{^/(adm|res)/}) {
4474: if ($imgsrc =~ m{^/res/}) {
4475: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4476: &Apache::lonnet::repcopy($local_name);
4477: }
4478: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4479: }
4480: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4481: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4482: return &Apache::lonnet::domain($domain,'description');
1.59 www 4483: } else {
1.60 matthew 4484: return '';
1.59 www 4485: }
4486: }
1.63 www 4487: ##############################################
4488:
4489: =pod
4490:
1.112 bowersj2 4491: =item * &designparm()
1.63 www 4492:
4493: Inputs: $which parameter; $domain (usually will be undef)
4494:
4495: Returns: value of designparamter $which
4496:
4497: =cut
1.112 bowersj2 4498:
1.397 albertel 4499:
1.400 albertel 4500: ##############################################
1.397 albertel 4501: sub designparm {
4502: my ($which,$domain)=@_;
4503: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 4504: return $env{'environment.color.'.$which};
1.96 www 4505: }
1.63 www 4506: $domain=&determinedomain($domain);
1.1016 raeburn 4507: my %domdesign;
4508: unless ($domain eq 'public') {
4509: %domdesign = &get_domainconf($domain);
4510: }
1.520 raeburn 4511: my $output;
1.517 raeburn 4512: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 4513: $output = $domdesign{$domain.'.'.$which};
1.63 www 4514: } else {
1.520 raeburn 4515: $output = $defaultdesign{$which};
4516: }
4517: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4518: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4519: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 4520: if ($output =~ m{^/res/}) {
4521: my $local_name = &Apache::lonnet::filelocation('',$output);
4522: &Apache::lonnet::repcopy($local_name);
4523: }
1.520 raeburn 4524: $output = &lonhttpdurl($output);
4525: }
1.63 www 4526: }
1.520 raeburn 4527: return $output;
1.63 www 4528: }
1.59 www 4529:
1.822 bisitz 4530: ##############################################
4531: =pod
4532:
1.832 bisitz 4533: =item * &authorspace()
4534:
1.1028 ! raeburn 4535: Inputs: $url (usually will be undef).
1.832 bisitz 4536:
1.1028 ! raeburn 4537: Returns: Path to Construction Space containing the resource or
! 4538: directory being viewed (or for which action is being taken).
! 4539: If $url is provided, and begins /priv/<domain>/<uname>
! 4540: the path will be that portion of the $context argument.
! 4541: Otherwise the path will be for the author space of the current
! 4542: user when the current role is author, or for that of the
! 4543: co-author/assistant co-author space when the current role
! 4544: is co-author or assistant co-author.
1.832 bisitz 4545:
4546: =cut
4547:
4548: sub authorspace {
1.1028 ! raeburn 4549: my ($url) = @_;
! 4550: if ($url ne '') {
! 4551: if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
! 4552: return $1;
! 4553: }
! 4554: }
1.832 bisitz 4555: my $caname = '';
1.1024 www 4556: my $cadom = '';
1.1028 ! raeburn 4557: if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024 www 4558: ($cadom,$caname) =
1.832 bisitz 4559: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028 ! raeburn 4560: } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832 bisitz 4561: $caname = $env{'user.name'};
1.1024 www 4562: $cadom = $env{'user.domain'};
1.832 bisitz 4563: }
1.1028 ! raeburn 4564: if (($caname ne '') && ($cadom ne '')) {
! 4565: return "/priv/$cadom/$caname/";
! 4566: }
! 4567: return;
1.832 bisitz 4568: }
4569:
4570: ##############################################
4571: =pod
4572:
1.822 bisitz 4573: =item * &head_subbox()
4574:
4575: Inputs: $content (contains HTML code with page functions, etc.)
4576:
4577: Returns: HTML div with $content
4578: To be included in page header
4579:
4580: =cut
4581:
4582: sub head_subbox {
4583: my ($content)=@_;
4584: my $output =
1.993 raeburn 4585: '<div class="LC_head_subbox">'
1.822 bisitz 4586: .$content
4587: .'</div>'
4588: }
4589:
4590: ##############################################
4591: =pod
4592:
4593: =item * &CSTR_pageheader()
4594:
1.1026 raeburn 4595: Input: (optional) filename from which breadcrumb trail is built.
4596: In most cases no input as needed, as $env{'request.filename'}
4597: is appropriate for use in building the breadcrumb trail.
1.822 bisitz 4598:
4599: Returns: HTML div with CSTR path and recent box
4600: To be included on Construction Space pages
4601:
4602: =cut
4603:
4604: sub CSTR_pageheader {
1.1026 raeburn 4605: my ($trailfile) = @_;
4606: if ($trailfile eq '') {
4607: $trailfile = $env{'request.filename'};
4608: }
4609:
4610: # this is for resources; directories have customtitle, and crumbs
4611: # and select recent are created in lonpubdir.pm
4612:
4613: my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022 www 4614: my ($udom,$uname,$thisdisfn)=
1.1026 raeburn 4615: ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)/(.*)$});
4616: my $formaction = "/priv/$udom/$uname/$thisdisfn";
4617: $formaction =~ s{/+}{/}g;
1.822 bisitz 4618:
4619: my $parentpath = '';
4620: my $lastitem = '';
4621: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4622: $parentpath = $1;
4623: $lastitem = $2;
4624: } else {
4625: $lastitem = $thisdisfn;
4626: }
1.921 bisitz 4627:
4628: my $output =
1.822 bisitz 4629: '<div>'
4630: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
4631: .'<b>'.&mt('Construction Space:').'</b> '
4632: .'<form name="dirs" method="post" action="'.$formaction
1.921 bisitz 4633: .'" target="_top">' #FIXME lonpubdir: target="_parent"
1.1024 www 4634: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv/'.$udom,undef,undef);
1.921 bisitz 4635:
4636: if ($lastitem) {
4637: $output .=
4638: '<span class="LC_filename">'
4639: .$lastitem
4640: .'</span>';
4641: }
4642: $output .=
4643: '<br />'
1.822 bisitz 4644: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
4645: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4646: .'</form>'
4647: .&Apache::lonmenu::constspaceform()
4648: .'</div>';
1.921 bisitz 4649:
4650: return $output;
1.822 bisitz 4651: }
4652:
1.60 matthew 4653: ###############################################
4654: ###############################################
4655:
4656: =pod
4657:
1.112 bowersj2 4658: =back
4659:
1.549 albertel 4660: =head1 HTML Helpers
1.112 bowersj2 4661:
4662: =over 4
4663:
4664: =item * &bodytag()
1.60 matthew 4665:
4666: Returns a uniform header for LON-CAPA web pages.
4667:
4668: Inputs:
4669:
1.112 bowersj2 4670: =over 4
4671:
4672: =item * $title, A title to be displayed on the page.
4673:
4674: =item * $function, the current role (can be undef).
4675:
4676: =item * $addentries, extra parameters for the <body> tag.
4677:
4678: =item * $bodyonly, if defined, only return the <body> tag.
4679:
4680: =item * $domain, if defined, force a given domain.
4681:
4682: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4683: text interface only)
1.60 matthew 4684:
1.814 bisitz 4685: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
4686: navigational links
1.317 albertel 4687:
1.338 albertel 4688: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4689:
1.460 albertel 4690: =item * $args, optional argument valid values are
4691: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4692: inherit_jsmath -> when creating popup window in a page,
4693: should it have jsmath forced on by the
4694: current page
1.460 albertel 4695:
1.112 bowersj2 4696: =back
4697:
1.60 matthew 4698: Returns: A uniform header for LON-CAPA web pages.
4699: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4700: If $bodyonly is undef or zero, an html string containing a <body> tag and
4701: other decorations will be returned.
4702:
4703: =cut
4704:
1.54 www 4705: sub bodytag {
1.831 bisitz 4706: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.962 droeschl 4707: $no_nav_bar,$bgcolor,$args)=@_;
1.339 albertel 4708:
1.954 raeburn 4709: my $public;
4710: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
4711: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
4712: $public = 1;
4713: }
1.460 albertel 4714: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4715:
1.183 matthew 4716: $function = &get_users_function() if (!$function);
1.339 albertel 4717: my $img = &designparm($function.'.img',$domain);
4718: my $font = &designparm($function.'.font',$domain);
4719: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4720:
1.803 bisitz 4721: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 4722: 'bgcolor' => $pgbg,
1.339 albertel 4723: 'text' => $font,
4724: 'alink' => &designparm($function.'.alink',$domain),
4725: 'vlink' => &designparm($function.'.vlink',$domain),
4726: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4727: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4728:
1.63 www 4729: # role and realm
1.378 raeburn 4730: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4731: if ($role eq 'ca') {
1.479 albertel 4732: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4733: $realm = &plainname($rname,$rdom);
1.378 raeburn 4734: }
1.55 www 4735: # realm
1.258 albertel 4736: if ($env{'request.course.id'}) {
1.378 raeburn 4737: if ($env{'request.role'} !~ /^cr/) {
4738: $role = &Apache::lonnet::plaintext($role,&course_type());
4739: }
1.898 raeburn 4740: if ($env{'request.course.sec'}) {
4741: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
4742: }
1.359 albertel 4743: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4744: } else {
4745: $role = &Apache::lonnet::plaintext($role);
1.54 www 4746: }
1.433 albertel 4747:
1.359 albertel 4748: if (!$realm) { $realm=' '; }
1.330 albertel 4749:
1.438 albertel 4750: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4751:
1.101 www 4752: # construct main body tag
1.359 albertel 4753: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4754: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4755:
1.530 albertel 4756: if ($bodyonly) {
1.60 matthew 4757: return $bodytag;
1.798 tempelho 4758: }
1.359 albertel 4759:
1.410 albertel 4760: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.954 raeburn 4761: if ($public) {
1.433 albertel 4762: undef($role);
1.434 albertel 4763: } else {
4764: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4765: }
1.359 albertel 4766:
1.762 bisitz 4767: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 4768: #
4769: # Extra info if you are the DC
4770: my $dc_info = '';
4771: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4772: $env{'course.'.$env{'request.course.id'}.
4773: '.domain'}.'/'})) {
4774: my $cid = $env{'request.course.id'};
1.917 raeburn 4775: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4776: $dc_info =~ s/\s+$//;
1.359 albertel 4777: }
4778:
1.898 raeburn 4779: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853 droeschl 4780: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
4781:
1.916 droeschl 4782: if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') {
4783: return $bodytag;
4784: }
1.903 droeschl 4785:
4786: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
4787:
4788: # if ($env{'request.state'} eq 'construct') {
4789: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
4790: # }
4791:
1.359 albertel 4792:
4793:
1.916 droeschl 4794: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917 raeburn 4795: if ($dc_info) {
4796: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
4797: }
1.916 droeschl 4798: $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
4799: <em>$realm</em> $dc_info</div>|;
1.903 droeschl 4800: return $bodytag;
4801: }
1.894 droeschl 4802:
1.927 raeburn 4803: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
4804: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
4805: }
1.916 droeschl 4806:
1.903 droeschl 4807: $bodytag .= Apache::lonhtmlcommon::scripttag(
4808: Apache::lonmenu::utilityfunctions(), 'start');
1.816 bisitz 4809:
1.903 droeschl 4810: $bodytag .= Apache::lonmenu::primary_menu();
1.852 droeschl 4811:
1.917 raeburn 4812: if ($dc_info) {
4813: $dc_info = &dc_courseid_toggle($dc_info);
4814: }
4815: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 4816:
1.903 droeschl 4817: #don't show menus for public users
1.954 raeburn 4818: if (!$public){
1.903 droeschl 4819: $bodytag .= Apache::lonmenu::secondary_menu();
4820: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 4821: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
4822: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 4823: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.920 raeburn 4824: $args->{'bread_crumbs'});
4825: } elsif ($forcereg) {
4826: $bodytag .= &Apache::lonmenu::innerregister($forcereg);
4827: }
1.903 droeschl 4828: }else{
4829: # this is to seperate menu from content when there's no secondary
4830: # menu. Especially needed for public accessible ressources.
4831: $bodytag .= '<hr style="clear:both" />';
4832: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 4833: }
1.903 droeschl 4834:
1.235 raeburn 4835: return $bodytag;
1.182 matthew 4836: }
4837:
1.917 raeburn 4838: sub dc_courseid_toggle {
4839: my ($dc_info) = @_;
1.980 raeburn 4840: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.917 raeburn 4841: '<a href="javascript:showCourseID();">'.
4842: &mt('(More ...)').'</a></span>'.
4843: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
4844: }
4845:
1.330 albertel 4846: sub make_attr_string {
4847: my ($register,$attr_ref) = @_;
4848:
4849: if ($attr_ref && !ref($attr_ref)) {
4850: die("addentries Must be a hash ref ".
4851: join(':',caller(1))." ".
4852: join(':',caller(0))." ");
4853: }
4854:
4855: if ($register) {
1.339 albertel 4856: my ($on_load,$on_unload);
4857: foreach my $key (keys(%{$attr_ref})) {
4858: if (lc($key) eq 'onload') {
4859: $on_load.=$attr_ref->{$key}.';';
4860: delete($attr_ref->{$key});
4861:
4862: } elsif (lc($key) eq 'onunload') {
4863: $on_unload.=$attr_ref->{$key}.';';
4864: delete($attr_ref->{$key});
4865: }
4866: }
1.953 droeschl 4867: $attr_ref->{'onload'} = $on_load;
4868: $attr_ref->{'onunload'}= $on_unload;
1.330 albertel 4869: }
1.339 albertel 4870:
1.330 albertel 4871: my $attr_string;
4872: foreach my $attr (keys(%$attr_ref)) {
4873: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4874: }
4875: return $attr_string;
4876: }
4877:
4878:
1.182 matthew 4879: ###############################################
1.251 albertel 4880: ###############################################
4881:
4882: =pod
4883:
4884: =item * &endbodytag()
4885:
4886: Returns a uniform footer for LON-CAPA web pages.
4887:
1.635 raeburn 4888: Inputs: 1 - optional reference to an args hash
4889: If in the hash, key for noredirectlink has a value which evaluates to true,
4890: a 'Continue' link is not displayed if the page contains an
4891: internal redirect in the <head></head> section,
4892: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4893:
4894: =cut
4895:
4896: sub endbodytag {
1.635 raeburn 4897: my ($args) = @_;
1.251 albertel 4898: my $endbodytag='</body>';
1.269 albertel 4899: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4900: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4901: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4902: $endbodytag=
4903: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4904: &mt('Continue').'</a>'.
4905: $endbodytag;
4906: }
1.315 albertel 4907: }
1.251 albertel 4908: return $endbodytag;
4909: }
4910:
1.352 albertel 4911: =pod
4912:
4913: =item * &standard_css()
4914:
4915: Returns a style sheet
4916:
4917: Inputs: (all optional)
4918: domain -> force to color decorate a page for a specific
4919: domain
4920: function -> force usage of a specific rolish color scheme
4921: bgcolor -> override the default page bgcolor
4922:
4923: =cut
4924:
1.343 albertel 4925: sub standard_css {
1.345 albertel 4926: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4927: $function = &get_users_function() if (!$function);
4928: my $img = &designparm($function.'.img', $domain);
4929: my $tabbg = &designparm($function.'.tabbg', $domain);
4930: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 4931: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 4932: #second colour for later usage
1.345 albertel 4933: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4934: my $pgbg_or_bgcolor =
4935: $bgcolor ||
1.352 albertel 4936: &designparm($function.'.pgbg', $domain);
1.382 albertel 4937: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4938: my $alink = &designparm($function.'.alink', $domain);
4939: my $vlink = &designparm($function.'.vlink', $domain);
4940: my $link = &designparm($function.'.link', $domain);
4941:
1.602 albertel 4942: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4943: my $mono = 'monospace';
1.850 bisitz 4944: my $data_table_head = $sidebg;
4945: my $data_table_light = '#FAFAFA';
4946: my $data_table_dark = '#F0F0F0';
1.470 banghart 4947: my $data_table_darker = '#CCCCCC';
1.349 albertel 4948: my $data_table_highlight = '#FFFF00';
1.352 albertel 4949: my $mail_new = '#FFBB77';
4950: my $mail_new_hover = '#DD9955';
4951: my $mail_read = '#BBBB77';
4952: my $mail_read_hover = '#999944';
4953: my $mail_replied = '#AAAA88';
4954: my $mail_replied_hover = '#888855';
4955: my $mail_other = '#99BBBB';
4956: my $mail_other_hover = '#669999';
1.391 albertel 4957: my $table_header = '#DDDDDD';
1.489 raeburn 4958: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 4959: my $lg_border_color = '#C8C8C8';
1.952 onken 4960: my $button_hover = '#BF2317';
1.392 albertel 4961:
1.608 albertel 4962: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 4963: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
4964: : '0 3px 0 4px';
1.448 albertel 4965:
1.523 albertel 4966:
1.343 albertel 4967: return <<END;
1.947 droeschl 4968:
4969: /* needed for iframe to allow 100% height in FF */
4970: body, html {
4971: margin: 0;
4972: padding: 0 0.5%;
4973: height: 99%; /* to avoid scrollbars */
4974: }
4975:
1.795 www 4976: body {
1.911 bisitz 4977: font-family: $sans;
4978: line-height:130%;
4979: font-size:0.83em;
4980: color:$font;
1.795 www 4981: }
4982:
1.959 onken 4983: a:focus,
4984: a:focus img {
1.795 www 4985: color: red;
1.911 bisitz 4986: background: yellow;
1.795 www 4987: }
1.698 harmsja 4988:
1.911 bisitz 4989: form, .inline {
4990: display: inline;
1.795 www 4991: }
1.721 harmsja 4992:
1.795 www 4993: .LC_right {
1.911 bisitz 4994: text-align:right;
1.795 www 4995: }
4996:
4997: .LC_middle {
1.911 bisitz 4998: vertical-align:middle;
1.795 www 4999: }
1.721 harmsja 5000:
1.911 bisitz 5001: .LC_400Box {
5002: width:400px;
5003: }
1.721 harmsja 5004:
1.947 droeschl 5005: .LC_iframecontainer {
5006: width: 98%;
5007: margin: 0;
5008: position: fixed;
5009: top: 8.5em;
5010: bottom: 0;
5011: }
5012:
5013: .LC_iframecontainer iframe{
5014: border: none;
5015: width: 100%;
5016: height: 100%;
5017: }
5018:
1.778 bisitz 5019: .LC_filename {
5020: font-family: $mono;
5021: white-space:pre;
1.921 bisitz 5022: font-size: 120%;
1.778 bisitz 5023: }
5024:
5025: .LC_fileicon {
5026: border: none;
5027: height: 1.3em;
5028: vertical-align: text-bottom;
5029: margin-right: 0.3em;
5030: text-decoration:none;
5031: }
5032:
1.1008 www 5033: .LC_setting {
5034: text-decoration:underline;
5035: }
5036:
1.350 albertel 5037: .LC_error {
5038: color: red;
5039: font-size: larger;
5040: }
1.795 www 5041:
1.457 albertel 5042: .LC_warning,
5043: .LC_diff_removed {
1.733 bisitz 5044: color: red;
1.394 albertel 5045: }
1.532 albertel 5046:
5047: .LC_info,
1.457 albertel 5048: .LC_success,
5049: .LC_diff_added {
1.350 albertel 5050: color: green;
5051: }
1.795 www 5052:
1.802 bisitz 5053: div.LC_confirm_box {
5054: background-color: #FAFAFA;
5055: border: 1px solid $lg_border_color;
5056: margin-right: 0;
5057: padding: 5px;
5058: }
5059:
5060: div.LC_confirm_box .LC_error img,
5061: div.LC_confirm_box .LC_success img {
5062: vertical-align: middle;
5063: }
5064:
1.440 albertel 5065: .LC_icon {
1.771 droeschl 5066: border: none;
1.790 droeschl 5067: vertical-align: middle;
1.771 droeschl 5068: }
5069:
1.543 albertel 5070: .LC_docs_spacer {
5071: width: 25px;
5072: height: 1px;
1.771 droeschl 5073: border: none;
1.543 albertel 5074: }
1.346 albertel 5075:
1.532 albertel 5076: .LC_internal_info {
1.735 bisitz 5077: color: #999999;
1.532 albertel 5078: }
5079:
1.794 www 5080: .LC_discussion {
1.911 bisitz 5081: background: $tabbg;
5082: border: 1px solid black;
5083: margin: 2px;
1.794 www 5084: }
5085:
5086: .LC_disc_action_links_bar {
1.911 bisitz 5087: background: $tabbg;
5088: border: none;
5089: margin: 4px;
1.794 www 5090: }
5091:
5092: .LC_disc_action_left {
1.911 bisitz 5093: text-align: left;
1.794 www 5094: }
5095:
5096: .LC_disc_action_right {
1.911 bisitz 5097: text-align: right;
1.794 www 5098: }
5099:
5100: .LC_disc_new_item {
1.911 bisitz 5101: background: white;
5102: border: 2px solid red;
5103: margin: 2px;
1.794 www 5104: }
5105:
5106: .LC_disc_old_item {
1.911 bisitz 5107: background: white;
5108: border: 1px solid black;
5109: margin: 2px;
1.794 www 5110: }
5111:
1.458 albertel 5112: table.LC_pastsubmission {
5113: border: 1px solid black;
5114: margin: 2px;
5115: }
5116:
1.924 bisitz 5117: table#LC_menubuttons {
1.345 albertel 5118: width: 100%;
5119: background: $pgbg;
1.392 albertel 5120: border: 2px;
1.402 albertel 5121: border-collapse: separate;
1.803 bisitz 5122: padding: 0;
1.345 albertel 5123: }
1.392 albertel 5124:
1.801 tempelho 5125: table#LC_title_bar a {
5126: color: $fontmenu;
5127: }
1.836 bisitz 5128:
1.807 droeschl 5129: table#LC_title_bar {
1.819 tempelho 5130: clear: both;
1.836 bisitz 5131: display: none;
1.807 droeschl 5132: }
5133:
1.795 www 5134: table#LC_title_bar,
1.933 droeschl 5135: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 5136: table#LC_title_bar.LC_with_remote {
1.359 albertel 5137: width: 100%;
1.392 albertel 5138: border-color: $pgbg;
5139: border-style: solid;
5140: border-width: $border;
1.379 albertel 5141: background: $pgbg;
1.801 tempelho 5142: color: $fontmenu;
1.392 albertel 5143: border-collapse: collapse;
1.803 bisitz 5144: padding: 0;
1.819 tempelho 5145: margin: 0;
1.359 albertel 5146: }
1.795 www 5147:
1.933 droeschl 5148: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 5149: margin: 0;
5150: padding: 0;
1.933 droeschl 5151: position: relative;
5152: list-style: none;
1.913 droeschl 5153: }
1.933 droeschl 5154: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 5155: display: inline;
5156: }
1.933 droeschl 5157:
5158: .LC_breadcrumb_tools_navigation {
1.913 droeschl 5159: padding: 0;
1.933 droeschl 5160: margin: 0;
5161: float: left;
1.913 droeschl 5162: }
1.933 droeschl 5163: .LC_breadcrumb_tools_tools {
5164: padding: 0;
5165: margin: 0;
1.913 droeschl 5166: float: right;
5167: }
5168:
1.359 albertel 5169: table#LC_title_bar td {
5170: background: $tabbg;
5171: }
1.795 www 5172:
1.911 bisitz 5173: table#LC_menubuttons img {
1.803 bisitz 5174: border: none;
1.346 albertel 5175: }
1.795 www 5176:
1.842 droeschl 5177: .LC_breadcrumbs_component {
1.911 bisitz 5178: float: right;
5179: margin: 0 1em;
1.357 albertel 5180: }
1.842 droeschl 5181: .LC_breadcrumbs_component img {
1.911 bisitz 5182: vertical-align: middle;
1.777 tempelho 5183: }
1.795 www 5184:
1.383 albertel 5185: td.LC_table_cell_checkbox {
5186: text-align: center;
5187: }
1.795 www 5188:
5189: .LC_fontsize_small {
1.911 bisitz 5190: font-size: 70%;
1.705 tempelho 5191: }
5192:
1.844 bisitz 5193: #LC_breadcrumbs {
1.911 bisitz 5194: clear:both;
5195: background: $sidebg;
5196: border-bottom: 1px solid $lg_border_color;
5197: line-height: 2.5em;
1.933 droeschl 5198: overflow: hidden;
1.911 bisitz 5199: margin: 0;
5200: padding: 0;
1.995 raeburn 5201: text-align: left;
1.819 tempelho 5202: }
1.862 bisitz 5203:
1.993 raeburn 5204: .LC_head_subbox {
1.911 bisitz 5205: clear:both;
5206: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 5207: border: 1px solid $sidebg;
5208: margin: 0 0 10px 0;
1.966 bisitz 5209: padding: 3px;
1.995 raeburn 5210: text-align: left;
1.822 bisitz 5211: }
5212:
1.795 www 5213: .LC_fontsize_medium {
1.911 bisitz 5214: font-size: 85%;
1.705 tempelho 5215: }
5216:
1.795 www 5217: .LC_fontsize_large {
1.911 bisitz 5218: font-size: 120%;
1.705 tempelho 5219: }
5220:
1.346 albertel 5221: .LC_menubuttons_inline_text {
5222: color: $font;
1.698 harmsja 5223: font-size: 90%;
1.701 harmsja 5224: padding-left:3px;
1.346 albertel 5225: }
5226:
1.934 droeschl 5227: .LC_menubuttons_inline_text img{
5228: vertical-align: middle;
5229: }
5230:
1.951 onken 5231: li.LC_menubuttons_inline_text img,a {
5232: cursor:pointer;
1.1002 droeschl 5233: text-decoration: none;
1.951 onken 5234: }
5235:
1.526 www 5236: .LC_menubuttons_link {
5237: text-decoration: none;
5238: }
1.795 www 5239:
1.522 albertel 5240: .LC_menubuttons_category {
1.521 www 5241: color: $font;
1.526 www 5242: background: $pgbg;
1.521 www 5243: font-size: larger;
5244: font-weight: bold;
5245: }
5246:
1.346 albertel 5247: td.LC_menubuttons_text {
1.911 bisitz 5248: color: $font;
1.346 albertel 5249: }
1.706 harmsja 5250:
1.346 albertel 5251: .LC_current_location {
5252: background: $tabbg;
5253: }
1.795 www 5254:
1.938 bisitz 5255: table.LC_data_table {
1.347 albertel 5256: border: 1px solid #000000;
1.402 albertel 5257: border-collapse: separate;
1.426 albertel 5258: border-spacing: 1px;
1.610 albertel 5259: background: $pgbg;
1.347 albertel 5260: }
1.795 www 5261:
1.422 albertel 5262: .LC_data_table_dense {
5263: font-size: small;
5264: }
1.795 www 5265:
1.507 raeburn 5266: table.LC_nested_outer {
5267: border: 1px solid #000000;
1.589 raeburn 5268: border-collapse: collapse;
1.803 bisitz 5269: border-spacing: 0;
1.507 raeburn 5270: width: 100%;
5271: }
1.795 www 5272:
1.879 raeburn 5273: table.LC_innerpickbox,
1.507 raeburn 5274: table.LC_nested {
1.803 bisitz 5275: border: none;
1.589 raeburn 5276: border-collapse: collapse;
1.803 bisitz 5277: border-spacing: 0;
1.507 raeburn 5278: width: 100%;
5279: }
1.795 www 5280:
1.911 bisitz 5281: table.LC_data_table tr th,
5282: table.LC_calendar tr th,
1.879 raeburn 5283: table.LC_prior_tries tr th,
5284: table.LC_innerpickbox tr th {
1.349 albertel 5285: font-weight: bold;
5286: background-color: $data_table_head;
1.801 tempelho 5287: color:$fontmenu;
1.701 harmsja 5288: font-size:90%;
1.347 albertel 5289: }
1.795 www 5290:
1.879 raeburn 5291: table.LC_innerpickbox tr th,
5292: table.LC_innerpickbox tr td {
5293: vertical-align: top;
5294: }
5295:
1.711 raeburn 5296: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 5297: background-color: #CCCCCC;
1.711 raeburn 5298: font-weight: bold;
5299: text-align: left;
5300: }
1.795 www 5301:
1.912 bisitz 5302: table.LC_data_table tr.LC_odd_row > td {
5303: background-color: $data_table_light;
5304: padding: 2px;
5305: vertical-align: top;
5306: }
5307:
1.809 bisitz 5308: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 5309: background-color: $data_table_light;
1.912 bisitz 5310: vertical-align: top;
5311: }
5312:
5313: table.LC_data_table tr.LC_even_row > td {
5314: background-color: $data_table_dark;
1.425 albertel 5315: padding: 2px;
1.900 bisitz 5316: vertical-align: top;
1.347 albertel 5317: }
1.795 www 5318:
1.809 bisitz 5319: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 5320: background-color: $data_table_dark;
1.900 bisitz 5321: vertical-align: top;
1.347 albertel 5322: }
1.795 www 5323:
1.425 albertel 5324: table.LC_data_table tr.LC_data_table_highlight td {
5325: background-color: $data_table_darker;
5326: }
1.795 www 5327:
1.639 raeburn 5328: table.LC_data_table tr td.LC_leftcol_header {
5329: background-color: $data_table_head;
5330: font-weight: bold;
5331: }
1.795 www 5332:
1.451 albertel 5333: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5334: table.LC_nested tr.LC_empty_row td {
1.421 albertel 5335: font-weight: bold;
5336: font-style: italic;
5337: text-align: center;
5338: padding: 8px;
1.347 albertel 5339: }
1.795 www 5340:
1.940 bisitz 5341: table.LC_data_table tr.LC_empty_row td {
5342: background-color: $sidebg;
5343: }
5344:
5345: table.LC_nested tr.LC_empty_row td {
5346: background-color: #FFFFFF;
5347: }
5348:
1.890 droeschl 5349: table.LC_caption {
5350: }
5351:
1.507 raeburn 5352: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5353: padding: 4ex
5354: }
1.795 www 5355:
1.507 raeburn 5356: table.LC_nested_outer tr th {
5357: font-weight: bold;
1.801 tempelho 5358: color:$fontmenu;
1.507 raeburn 5359: background-color: $data_table_head;
1.701 harmsja 5360: font-size: small;
1.507 raeburn 5361: border-bottom: 1px solid #000000;
5362: }
1.795 www 5363:
1.507 raeburn 5364: table.LC_nested_outer tr td.LC_subheader {
5365: background-color: $data_table_head;
5366: font-weight: bold;
5367: font-size: small;
5368: border-bottom: 1px solid #000000;
5369: text-align: right;
1.451 albertel 5370: }
1.795 www 5371:
1.507 raeburn 5372: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5373: background-color: #CCCCCC;
1.451 albertel 5374: font-weight: bold;
5375: font-size: small;
1.507 raeburn 5376: text-align: center;
5377: }
1.795 www 5378:
1.589 raeburn 5379: table.LC_nested tr.LC_info_row td.LC_left_item,
5380: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5381: text-align: left;
1.451 albertel 5382: }
1.795 www 5383:
1.507 raeburn 5384: table.LC_nested td {
1.735 bisitz 5385: background-color: #FFFFFF;
1.451 albertel 5386: font-size: small;
1.507 raeburn 5387: }
1.795 www 5388:
1.507 raeburn 5389: table.LC_nested_outer tr th.LC_right_item,
5390: table.LC_nested tr.LC_info_row td.LC_right_item,
5391: table.LC_nested tr.LC_odd_row td.LC_right_item,
5392: table.LC_nested tr td.LC_right_item {
1.451 albertel 5393: text-align: right;
5394: }
5395:
1.507 raeburn 5396: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5397: background-color: #EEEEEE;
1.451 albertel 5398: }
5399:
1.473 raeburn 5400: table.LC_createuser {
5401: }
5402:
5403: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5404: font-size: small;
1.473 raeburn 5405: }
5406:
5407: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5408: background-color: #CCCCCC;
1.473 raeburn 5409: font-weight: bold;
5410: text-align: center;
5411: }
5412:
1.349 albertel 5413: table.LC_calendar {
5414: border: 1px solid #000000;
5415: border-collapse: collapse;
1.917 raeburn 5416: width: 98%;
1.349 albertel 5417: }
1.795 www 5418:
1.349 albertel 5419: table.LC_calendar_pickdate {
5420: font-size: xx-small;
5421: }
1.795 www 5422:
1.349 albertel 5423: table.LC_calendar tr td {
5424: border: 1px solid #000000;
5425: vertical-align: top;
1.917 raeburn 5426: width: 14%;
1.349 albertel 5427: }
1.795 www 5428:
1.349 albertel 5429: table.LC_calendar tr td.LC_calendar_day_empty {
5430: background-color: $data_table_dark;
5431: }
1.795 www 5432:
1.779 bisitz 5433: table.LC_calendar tr td.LC_calendar_day_current {
5434: background-color: $data_table_highlight;
1.777 tempelho 5435: }
1.795 www 5436:
1.938 bisitz 5437: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 5438: background-color: $mail_new;
5439: }
1.795 www 5440:
1.938 bisitz 5441: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 5442: background-color: $mail_new_hover;
5443: }
1.795 www 5444:
1.938 bisitz 5445: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 5446: background-color: $mail_read;
5447: }
1.795 www 5448:
1.938 bisitz 5449: /*
5450: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 5451: background-color: $mail_read_hover;
5452: }
1.938 bisitz 5453: */
1.795 www 5454:
1.938 bisitz 5455: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 5456: background-color: $mail_replied;
5457: }
1.795 www 5458:
1.938 bisitz 5459: /*
5460: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 5461: background-color: $mail_replied_hover;
5462: }
1.938 bisitz 5463: */
1.795 www 5464:
1.938 bisitz 5465: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 5466: background-color: $mail_other;
5467: }
1.795 www 5468:
1.938 bisitz 5469: /*
5470: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 5471: background-color: $mail_other_hover;
5472: }
1.938 bisitz 5473: */
1.494 raeburn 5474:
1.777 tempelho 5475: table.LC_data_table tr > td.LC_browser_file,
5476: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 5477: background: #AAEE77;
1.389 albertel 5478: }
1.795 www 5479:
1.777 tempelho 5480: table.LC_data_table tr > td.LC_browser_file_locked,
5481: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5482: background: #FFAA99;
1.387 albertel 5483: }
1.795 www 5484:
1.777 tempelho 5485: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 5486: background: #888888;
1.779 bisitz 5487: }
1.795 www 5488:
1.777 tempelho 5489: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5490: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 5491: background: #F8F866;
1.777 tempelho 5492: }
1.795 www 5493:
1.696 bisitz 5494: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 5495: background: #E0E8FF;
1.387 albertel 5496: }
1.696 bisitz 5497:
1.707 bisitz 5498: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 5499: /* background: #77FF77; */
1.707 bisitz 5500: }
1.795 www 5501:
1.707 bisitz 5502: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 5503: border-right: 8px solid #FFFF77;
1.707 bisitz 5504: }
1.795 www 5505:
1.707 bisitz 5506: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 5507: border-right: 8px solid #FFAA77;
1.707 bisitz 5508: }
1.795 www 5509:
1.707 bisitz 5510: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 5511: border-right: 8px solid #FF7777;
1.707 bisitz 5512: }
1.795 www 5513:
1.707 bisitz 5514: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 5515: border-right: 8px solid #AAFF77;
1.707 bisitz 5516: }
1.795 www 5517:
1.707 bisitz 5518: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 5519: border-right: 8px solid #11CC55;
1.707 bisitz 5520: }
5521:
1.388 albertel 5522: span.LC_current_location {
1.701 harmsja 5523: font-size:larger;
1.388 albertel 5524: background: $pgbg;
5525: }
1.387 albertel 5526:
1.395 albertel 5527: span.LC_parm_menu_item {
5528: font-size: larger;
5529: }
1.795 www 5530:
1.395 albertel 5531: span.LC_parm_scope_all {
5532: color: red;
5533: }
1.795 www 5534:
1.395 albertel 5535: span.LC_parm_scope_folder {
5536: color: green;
5537: }
1.795 www 5538:
1.395 albertel 5539: span.LC_parm_scope_resource {
5540: color: orange;
5541: }
1.795 www 5542:
1.395 albertel 5543: span.LC_parm_part {
5544: color: blue;
5545: }
1.795 www 5546:
1.911 bisitz 5547: span.LC_parm_folder,
5548: span.LC_parm_symb {
1.395 albertel 5549: font-size: x-small;
5550: font-family: $mono;
5551: color: #AAAAAA;
5552: }
5553:
1.977 bisitz 5554: ul.LC_parm_parmlist li {
5555: display: inline-block;
5556: padding: 0.3em 0.8em;
5557: vertical-align: top;
5558: width: 150px;
5559: border-top:1px solid $lg_border_color;
5560: }
5561:
1.795 www 5562: td.LC_parm_overview_level_menu,
5563: td.LC_parm_overview_map_menu,
5564: td.LC_parm_overview_parm_selectors,
5565: td.LC_parm_overview_restrictions {
1.396 albertel 5566: border: 1px solid black;
5567: border-collapse: collapse;
5568: }
1.795 www 5569:
1.396 albertel 5570: table.LC_parm_overview_restrictions td {
5571: border-width: 1px 4px 1px 4px;
5572: border-style: solid;
5573: border-color: $pgbg;
5574: text-align: center;
5575: }
1.795 www 5576:
1.396 albertel 5577: table.LC_parm_overview_restrictions th {
5578: background: $tabbg;
5579: border-width: 1px 4px 1px 4px;
5580: border-style: solid;
5581: border-color: $pgbg;
5582: }
1.795 www 5583:
1.398 albertel 5584: table#LC_helpmenu {
1.803 bisitz 5585: border: none;
1.398 albertel 5586: height: 55px;
1.803 bisitz 5587: border-spacing: 0;
1.398 albertel 5588: }
5589:
5590: table#LC_helpmenu fieldset legend {
5591: font-size: larger;
5592: }
1.795 www 5593:
1.397 albertel 5594: table#LC_helpmenu_links {
5595: width: 100%;
5596: border: 1px solid black;
5597: background: $pgbg;
1.803 bisitz 5598: padding: 0;
1.397 albertel 5599: border-spacing: 1px;
5600: }
1.795 www 5601:
1.397 albertel 5602: table#LC_helpmenu_links tr td {
5603: padding: 1px;
5604: background: $tabbg;
1.399 albertel 5605: text-align: center;
5606: font-weight: bold;
1.397 albertel 5607: }
1.396 albertel 5608:
1.795 www 5609: table#LC_helpmenu_links a:link,
5610: table#LC_helpmenu_links a:visited,
1.397 albertel 5611: table#LC_helpmenu_links a:active {
5612: text-decoration: none;
5613: color: $font;
5614: }
1.795 www 5615:
1.397 albertel 5616: table#LC_helpmenu_links a:hover {
5617: text-decoration: underline;
5618: color: $vlink;
5619: }
1.396 albertel 5620:
1.417 albertel 5621: .LC_chrt_popup_exists {
5622: border: 1px solid #339933;
5623: margin: -1px;
5624: }
1.795 www 5625:
1.417 albertel 5626: .LC_chrt_popup_up {
5627: border: 1px solid yellow;
5628: margin: -1px;
5629: }
1.795 www 5630:
1.417 albertel 5631: .LC_chrt_popup {
5632: border: 1px solid #8888FF;
5633: background: #CCCCFF;
5634: }
1.795 www 5635:
1.421 albertel 5636: table.LC_pick_box {
5637: border-collapse: separate;
5638: background: white;
5639: border: 1px solid black;
5640: border-spacing: 1px;
5641: }
1.795 www 5642:
1.421 albertel 5643: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 5644: background: $sidebg;
1.421 albertel 5645: font-weight: bold;
1.900 bisitz 5646: text-align: left;
1.740 bisitz 5647: vertical-align: top;
1.421 albertel 5648: width: 184px;
5649: padding: 8px;
5650: }
1.795 www 5651:
1.579 raeburn 5652: table.LC_pick_box td.LC_pick_box_value {
5653: text-align: left;
5654: padding: 8px;
5655: }
1.795 www 5656:
1.579 raeburn 5657: table.LC_pick_box td.LC_pick_box_select {
5658: text-align: left;
5659: padding: 8px;
5660: }
1.795 www 5661:
1.424 albertel 5662: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 5663: padding: 0;
1.421 albertel 5664: height: 1px;
5665: background: black;
5666: }
1.795 www 5667:
1.421 albertel 5668: table.LC_pick_box td.LC_pick_box_submit {
5669: text-align: right;
5670: }
1.795 www 5671:
1.579 raeburn 5672: table.LC_pick_box td.LC_evenrow_value {
5673: text-align: left;
5674: padding: 8px;
5675: background-color: $data_table_light;
5676: }
1.795 www 5677:
1.579 raeburn 5678: table.LC_pick_box td.LC_oddrow_value {
5679: text-align: left;
5680: padding: 8px;
5681: background-color: $data_table_light;
5682: }
1.795 www 5683:
1.579 raeburn 5684: span.LC_helpform_receipt_cat {
5685: font-weight: bold;
5686: }
1.795 www 5687:
1.424 albertel 5688: table.LC_group_priv_box {
5689: background: white;
5690: border: 1px solid black;
5691: border-spacing: 1px;
5692: }
1.795 www 5693:
1.424 albertel 5694: table.LC_group_priv_box td.LC_pick_box_title {
5695: background: $tabbg;
5696: font-weight: bold;
5697: text-align: right;
5698: width: 184px;
5699: }
1.795 www 5700:
1.424 albertel 5701: table.LC_group_priv_box td.LC_groups_fixed {
5702: background: $data_table_light;
5703: text-align: center;
5704: }
1.795 www 5705:
1.424 albertel 5706: table.LC_group_priv_box td.LC_groups_optional {
5707: background: $data_table_dark;
5708: text-align: center;
5709: }
1.795 www 5710:
1.424 albertel 5711: table.LC_group_priv_box td.LC_groups_functionality {
5712: background: $data_table_darker;
5713: text-align: center;
5714: font-weight: bold;
5715: }
1.795 www 5716:
1.424 albertel 5717: table.LC_group_priv td {
5718: text-align: left;
1.803 bisitz 5719: padding: 0;
1.424 albertel 5720: }
5721:
5722: .LC_navbuttons {
5723: margin: 2ex 0ex 2ex 0ex;
5724: }
1.795 www 5725:
1.423 albertel 5726: .LC_topic_bar {
5727: font-weight: bold;
5728: background: $tabbg;
1.918 wenzelju 5729: margin: 1em 0em 1em 2em;
1.805 bisitz 5730: padding: 3px;
1.918 wenzelju 5731: font-size: 1.2em;
1.423 albertel 5732: }
1.795 www 5733:
1.423 albertel 5734: .LC_topic_bar span {
1.918 wenzelju 5735: left: 0.5em;
5736: position: absolute;
1.423 albertel 5737: vertical-align: middle;
1.918 wenzelju 5738: font-size: 1.2em;
1.423 albertel 5739: }
1.795 www 5740:
1.423 albertel 5741: table.LC_course_group_status {
5742: margin: 20px;
5743: }
1.795 www 5744:
1.423 albertel 5745: table.LC_status_selector td {
5746: vertical-align: top;
5747: text-align: center;
1.424 albertel 5748: padding: 4px;
5749: }
1.795 www 5750:
1.599 albertel 5751: div.LC_feedback_link {
1.616 albertel 5752: clear: both;
1.829 kalberla 5753: background: $sidebg;
1.779 bisitz 5754: width: 100%;
1.829 kalberla 5755: padding-bottom: 10px;
5756: border: 1px $tabbg solid;
1.833 kalberla 5757: height: 22px;
5758: line-height: 22px;
5759: padding-top: 5px;
5760: }
5761:
5762: div.LC_feedback_link img {
5763: height: 22px;
1.867 kalberla 5764: vertical-align:middle;
1.829 kalberla 5765: }
5766:
1.911 bisitz 5767: div.LC_feedback_link a {
1.829 kalberla 5768: text-decoration: none;
1.489 raeburn 5769: }
1.795 www 5770:
1.867 kalberla 5771: div.LC_comblock {
1.911 bisitz 5772: display:inline;
1.867 kalberla 5773: color:$font;
5774: font-size:90%;
5775: }
5776:
5777: div.LC_feedback_link div.LC_comblock {
5778: padding-left:5px;
5779: }
5780:
5781: div.LC_feedback_link div.LC_comblock a {
5782: color:$font;
5783: }
5784:
1.489 raeburn 5785: span.LC_feedback_link {
1.858 bisitz 5786: /* background: $feedback_link_bg; */
1.599 albertel 5787: font-size: larger;
5788: }
1.795 www 5789:
1.599 albertel 5790: span.LC_message_link {
1.858 bisitz 5791: /* background: $feedback_link_bg; */
1.599 albertel 5792: font-size: larger;
5793: position: absolute;
5794: right: 1em;
1.489 raeburn 5795: }
1.421 albertel 5796:
1.515 albertel 5797: table.LC_prior_tries {
1.524 albertel 5798: border: 1px solid #000000;
5799: border-collapse: separate;
5800: border-spacing: 1px;
1.515 albertel 5801: }
1.523 albertel 5802:
1.515 albertel 5803: table.LC_prior_tries td {
1.524 albertel 5804: padding: 2px;
1.515 albertel 5805: }
1.523 albertel 5806:
5807: .LC_answer_correct {
1.795 www 5808: background: lightgreen;
5809: color: darkgreen;
5810: padding: 6px;
1.523 albertel 5811: }
1.795 www 5812:
1.523 albertel 5813: .LC_answer_charged_try {
1.797 www 5814: background: #FFAAAA;
1.795 www 5815: color: darkred;
5816: padding: 6px;
1.523 albertel 5817: }
1.795 www 5818:
1.779 bisitz 5819: .LC_answer_not_charged_try,
1.523 albertel 5820: .LC_answer_no_grade,
5821: .LC_answer_late {
1.795 www 5822: background: lightyellow;
1.523 albertel 5823: color: black;
1.795 www 5824: padding: 6px;
1.523 albertel 5825: }
1.795 www 5826:
1.523 albertel 5827: .LC_answer_previous {
1.795 www 5828: background: lightblue;
5829: color: darkblue;
5830: padding: 6px;
1.523 albertel 5831: }
1.795 www 5832:
1.779 bisitz 5833: .LC_answer_no_message {
1.777 tempelho 5834: background: #FFFFFF;
5835: color: black;
1.795 www 5836: padding: 6px;
1.779 bisitz 5837: }
1.795 www 5838:
1.779 bisitz 5839: .LC_answer_unknown {
5840: background: orange;
5841: color: black;
1.795 www 5842: padding: 6px;
1.777 tempelho 5843: }
1.795 www 5844:
1.529 albertel 5845: span.LC_prior_numerical,
5846: span.LC_prior_string,
5847: span.LC_prior_custom,
5848: span.LC_prior_reaction,
5849: span.LC_prior_math {
1.925 bisitz 5850: font-family: $mono;
1.523 albertel 5851: white-space: pre;
5852: }
5853:
1.525 albertel 5854: span.LC_prior_string {
1.925 bisitz 5855: font-family: $mono;
1.525 albertel 5856: white-space: pre;
5857: }
5858:
1.523 albertel 5859: table.LC_prior_option {
5860: width: 100%;
5861: border-collapse: collapse;
5862: }
1.795 www 5863:
1.911 bisitz 5864: table.LC_prior_rank,
1.795 www 5865: table.LC_prior_match {
1.528 albertel 5866: border-collapse: collapse;
5867: }
1.795 www 5868:
1.528 albertel 5869: table.LC_prior_option tr td,
5870: table.LC_prior_rank tr td,
5871: table.LC_prior_match tr td {
1.524 albertel 5872: border: 1px solid #000000;
1.515 albertel 5873: }
5874:
1.855 bisitz 5875: .LC_nobreak {
1.544 albertel 5876: white-space: nowrap;
1.519 raeburn 5877: }
5878:
1.576 raeburn 5879: span.LC_cusr_emph {
5880: font-style: italic;
5881: }
5882:
1.633 raeburn 5883: span.LC_cusr_subheading {
5884: font-weight: normal;
5885: font-size: 85%;
5886: }
5887:
1.861 bisitz 5888: div.LC_docs_entry_move {
1.859 bisitz 5889: border: 1px solid #BBBBBB;
1.545 albertel 5890: background: #DDDDDD;
1.861 bisitz 5891: width: 22px;
1.859 bisitz 5892: padding: 1px;
5893: margin: 0;
1.545 albertel 5894: }
5895:
1.861 bisitz 5896: table.LC_data_table tr > td.LC_docs_entry_commands,
5897: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 5898: background: #DDDDDD;
5899: font-size: x-small;
5900: }
1.795 www 5901:
1.861 bisitz 5902: .LC_docs_entry_parameter {
5903: white-space: nowrap;
5904: }
5905:
1.544 albertel 5906: .LC_docs_copy {
1.545 albertel 5907: color: #000099;
1.544 albertel 5908: }
1.795 www 5909:
1.544 albertel 5910: .LC_docs_cut {
1.545 albertel 5911: color: #550044;
1.544 albertel 5912: }
1.795 www 5913:
1.544 albertel 5914: .LC_docs_rename {
1.545 albertel 5915: color: #009900;
1.544 albertel 5916: }
1.795 www 5917:
1.544 albertel 5918: .LC_docs_remove {
1.545 albertel 5919: color: #990000;
5920: }
5921:
1.547 albertel 5922: .LC_docs_reinit_warn,
5923: .LC_docs_ext_edit {
5924: font-size: x-small;
5925: }
5926:
1.545 albertel 5927: table.LC_docs_adddocs td,
5928: table.LC_docs_adddocs th {
5929: border: 1px solid #BBBBBB;
5930: padding: 4px;
5931: background: #DDDDDD;
1.543 albertel 5932: }
5933:
1.584 albertel 5934: table.LC_sty_begin {
5935: background: #BBFFBB;
5936: }
1.795 www 5937:
1.584 albertel 5938: table.LC_sty_end {
5939: background: #FFBBBB;
5940: }
5941:
1.589 raeburn 5942: table.LC_double_column {
1.803 bisitz 5943: border-width: 0;
1.589 raeburn 5944: border-collapse: collapse;
5945: width: 100%;
5946: padding: 2px;
5947: }
5948:
5949: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5950: top: 2px;
1.589 raeburn 5951: left: 2px;
5952: width: 47%;
5953: vertical-align: top;
5954: }
5955:
5956: table.LC_double_column tr td.LC_right_col {
5957: top: 2px;
1.779 bisitz 5958: right: 2px;
1.589 raeburn 5959: width: 47%;
5960: vertical-align: top;
5961: }
5962:
1.591 raeburn 5963: div.LC_left_float {
5964: float: left;
5965: padding-right: 5%;
1.597 albertel 5966: padding-bottom: 4px;
1.591 raeburn 5967: }
5968:
5969: div.LC_clear_float_header {
1.597 albertel 5970: padding-bottom: 2px;
1.591 raeburn 5971: }
5972:
5973: div.LC_clear_float_footer {
1.597 albertel 5974: padding-top: 10px;
1.591 raeburn 5975: clear: both;
5976: }
5977:
1.597 albertel 5978: div.LC_grade_show_user {
1.941 bisitz 5979: /* border-left: 5px solid $sidebg; */
5980: border-top: 5px solid #000000;
5981: margin: 50px 0 0 0;
1.936 bisitz 5982: padding: 15px 0 5px 10px;
1.597 albertel 5983: }
1.795 www 5984:
1.936 bisitz 5985: div.LC_grade_show_user_odd_row {
1.941 bisitz 5986: /* border-left: 5px solid #000000; */
5987: }
5988:
5989: div.LC_grade_show_user div.LC_Box {
5990: margin-right: 50px;
1.597 albertel 5991: }
5992:
5993: div.LC_grade_submissions,
5994: div.LC_grade_message_center,
1.936 bisitz 5995: div.LC_grade_info_links {
1.597 albertel 5996: margin: 5px;
5997: width: 99%;
5998: background: #FFFFFF;
5999: }
1.795 www 6000:
1.597 albertel 6001: div.LC_grade_submissions_header,
1.936 bisitz 6002: div.LC_grade_message_center_header {
1.705 tempelho 6003: font-weight: bold;
6004: font-size: large;
1.597 albertel 6005: }
1.795 www 6006:
1.597 albertel 6007: div.LC_grade_submissions_body,
1.936 bisitz 6008: div.LC_grade_message_center_body {
1.597 albertel 6009: border: 1px solid black;
6010: width: 99%;
6011: background: #FFFFFF;
6012: }
1.795 www 6013:
1.613 albertel 6014: table.LC_scantron_action {
6015: width: 100%;
6016: }
1.795 www 6017:
1.613 albertel 6018: table.LC_scantron_action tr th {
1.698 harmsja 6019: font-weight:bold;
6020: font-style:normal;
1.613 albertel 6021: }
1.795 www 6022:
1.779 bisitz 6023: .LC_edit_problem_header,
1.614 albertel 6024: div.LC_edit_problem_footer {
1.705 tempelho 6025: font-weight: normal;
6026: font-size: medium;
1.602 albertel 6027: margin: 2px;
1.600 albertel 6028: }
1.795 www 6029:
1.600 albertel 6030: div.LC_edit_problem_header,
1.602 albertel 6031: div.LC_edit_problem_header div,
1.614 albertel 6032: div.LC_edit_problem_footer,
6033: div.LC_edit_problem_footer div,
1.602 albertel 6034: div.LC_edit_problem_editxml_header,
6035: div.LC_edit_problem_editxml_header div {
1.600 albertel 6036: margin-top: 5px;
6037: }
1.795 www 6038:
1.600 albertel 6039: div.LC_edit_problem_header_title {
1.705 tempelho 6040: font-weight: bold;
6041: font-size: larger;
1.602 albertel 6042: background: $tabbg;
6043: padding: 3px;
6044: }
1.795 www 6045:
1.602 albertel 6046: table.LC_edit_problem_header_title {
6047: width: 100%;
1.600 albertel 6048: background: $tabbg;
1.602 albertel 6049: }
6050:
6051: div.LC_edit_problem_discards {
6052: float: left;
6053: padding-bottom: 5px;
6054: }
1.795 www 6055:
1.602 albertel 6056: div.LC_edit_problem_saves {
6057: float: right;
6058: padding-bottom: 5px;
1.600 albertel 6059: }
1.795 www 6060:
1.911 bisitz 6061: img.stift {
1.803 bisitz 6062: border-width: 0;
6063: vertical-align: middle;
1.677 riegler 6064: }
1.680 riegler 6065:
1.923 bisitz 6066: table td.LC_mainmenu_col_fieldset {
1.680 riegler 6067: vertical-align: top;
1.777 tempelho 6068: }
1.795 www 6069:
1.716 raeburn 6070: div.LC_createcourse {
1.911 bisitz 6071: margin: 10px 10px 10px 10px;
1.716 raeburn 6072: }
6073:
1.917 raeburn 6074: .LC_dccid {
6075: margin: 0.2em 0 0 0;
6076: padding: 0;
6077: font-size: 90%;
6078: display:none;
6079: }
6080:
1.698 harmsja 6081: a:hover,
1.897 wenzelju 6082: ol.LC_primary_menu a:hover,
1.721 harmsja 6083: ol#LC_MenuBreadcrumbs a:hover,
6084: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 6085: ul#LC_secondary_menu a:hover,
1.721 harmsja 6086: .LC_FormSectionClearButton input:hover
1.795 www 6087: ul.LC_TabContent li:hover a {
1.952 onken 6088: color:$button_hover;
1.911 bisitz 6089: text-decoration:none;
1.693 droeschl 6090: }
6091:
1.779 bisitz 6092: h1 {
1.911 bisitz 6093: padding: 0;
6094: line-height:130%;
1.693 droeschl 6095: }
1.698 harmsja 6096:
1.911 bisitz 6097: h2,
6098: h3,
6099: h4,
6100: h5,
6101: h6 {
6102: margin: 5px 0 5px 0;
6103: padding: 0;
6104: line-height:130%;
1.693 droeschl 6105: }
1.795 www 6106:
6107: .LC_hcell {
1.911 bisitz 6108: padding:3px 15px 3px 15px;
6109: margin: 0;
6110: background-color:$tabbg;
6111: color:$fontmenu;
6112: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 6113: }
1.795 www 6114:
1.840 bisitz 6115: .LC_Box > .LC_hcell {
1.911 bisitz 6116: margin: 0 -10px 10px -10px;
1.835 bisitz 6117: }
6118:
1.721 harmsja 6119: .LC_noBorder {
1.911 bisitz 6120: border: 0;
1.698 harmsja 6121: }
1.693 droeschl 6122:
1.721 harmsja 6123: .LC_FormSectionClearButton input {
1.911 bisitz 6124: background-color:transparent;
6125: border: none;
6126: cursor:pointer;
6127: text-decoration:underline;
1.693 droeschl 6128: }
1.763 bisitz 6129:
6130: .LC_help_open_topic {
1.911 bisitz 6131: color: #FFFFFF;
6132: background-color: #EEEEFF;
6133: margin: 1px;
6134: padding: 4px;
6135: border: 1px solid #000033;
6136: white-space: nowrap;
6137: /* vertical-align: middle; */
1.759 neumanie 6138: }
1.693 droeschl 6139:
1.911 bisitz 6140: dl,
6141: ul,
6142: div,
6143: fieldset {
6144: margin: 10px 10px 10px 0;
6145: /* overflow: hidden; */
1.693 droeschl 6146: }
1.795 www 6147:
1.838 bisitz 6148: fieldset > legend {
1.911 bisitz 6149: font-weight: bold;
6150: padding: 0 5px 0 5px;
1.838 bisitz 6151: }
6152:
1.813 bisitz 6153: #LC_nav_bar {
1.911 bisitz 6154: float: left;
1.995 raeburn 6155: background-color: $pgbg_or_bgcolor;
1.966 bisitz 6156: margin: 0 0 2px 0;
1.807 droeschl 6157: }
6158:
1.916 droeschl 6159: #LC_realm {
6160: margin: 0.2em 0 0 0;
6161: padding: 0;
6162: font-weight: bold;
6163: text-align: center;
1.995 raeburn 6164: background-color: $pgbg_or_bgcolor;
1.916 droeschl 6165: }
6166:
1.911 bisitz 6167: #LC_nav_bar em {
6168: font-weight: bold;
6169: font-style: normal;
1.807 droeschl 6170: }
6171:
1.897 wenzelju 6172: ol.LC_primary_menu {
1.911 bisitz 6173: float: right;
1.934 droeschl 6174: margin: 0;
1.995 raeburn 6175: background-color: $pgbg_or_bgcolor;
1.807 droeschl 6176: }
6177:
1.852 droeschl 6178: ol#LC_PathBreadcrumbs {
1.911 bisitz 6179: margin: 0;
1.693 droeschl 6180: }
6181:
1.897 wenzelju 6182: ol.LC_primary_menu li {
1.911 bisitz 6183: display: inline;
6184: padding: 5px 5px 0 10px;
6185: vertical-align: top;
1.693 droeschl 6186: }
6187:
1.897 wenzelju 6188: ol.LC_primary_menu li img {
1.911 bisitz 6189: vertical-align: bottom;
1.934 droeschl 6190: height: 1.1em;
1.693 droeschl 6191: }
6192:
1.897 wenzelju 6193: ol.LC_primary_menu a {
1.911 bisitz 6194: color: RGB(80, 80, 80);
6195: text-decoration: none;
1.693 droeschl 6196: }
1.795 www 6197:
1.949 droeschl 6198: ol.LC_primary_menu a.LC_new_message {
6199: font-weight:bold;
6200: color: darkred;
6201: }
6202:
1.975 raeburn 6203: ol.LC_docs_parameters {
6204: margin-left: 0;
6205: padding: 0;
6206: list-style: none;
6207: }
6208:
6209: ol.LC_docs_parameters li {
6210: margin: 0;
6211: padding-right: 20px;
6212: display: inline;
6213: }
6214:
1.976 raeburn 6215: ol.LC_docs_parameters li:before {
6216: content: "\\002022 \\0020";
6217: }
6218:
6219: li.LC_docs_parameters_title {
6220: font-weight: bold;
6221: }
6222:
6223: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
6224: content: "";
6225: }
6226:
1.897 wenzelju 6227: ul#LC_secondary_menu {
1.911 bisitz 6228: clear: both;
6229: color: $fontmenu;
6230: background: $tabbg;
6231: list-style: none;
6232: padding: 0;
6233: margin: 0;
6234: width: 100%;
1.995 raeburn 6235: text-align: left;
1.808 droeschl 6236: }
6237:
1.897 wenzelju 6238: ul#LC_secondary_menu li {
1.911 bisitz 6239: font-weight: bold;
6240: line-height: 1.8em;
6241: padding: 0 0.8em;
6242: border-right: 1px solid black;
6243: display: inline;
6244: vertical-align: middle;
1.807 droeschl 6245: }
6246:
1.847 tempelho 6247: ul.LC_TabContent {
1.911 bisitz 6248: display:block;
6249: background: $sidebg;
6250: border-bottom: solid 1px $lg_border_color;
6251: list-style:none;
1.1020 raeburn 6252: margin: -1px -10px 0 -10px;
1.911 bisitz 6253: padding: 0;
1.693 droeschl 6254: }
6255:
1.795 www 6256: ul.LC_TabContent li,
6257: ul.LC_TabContentBigger li {
1.911 bisitz 6258: float:left;
1.741 harmsja 6259: }
1.795 www 6260:
1.897 wenzelju 6261: ul#LC_secondary_menu li a {
1.911 bisitz 6262: color: $fontmenu;
6263: text-decoration: none;
1.693 droeschl 6264: }
1.795 www 6265:
1.721 harmsja 6266: ul.LC_TabContent {
1.952 onken 6267: min-height:20px;
1.721 harmsja 6268: }
1.795 www 6269:
6270: ul.LC_TabContent li {
1.911 bisitz 6271: vertical-align:middle;
1.959 onken 6272: padding: 0 16px 0 10px;
1.911 bisitz 6273: background-color:$tabbg;
6274: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 6275: border-left: solid 1px $font;
1.721 harmsja 6276: }
1.795 www 6277:
1.847 tempelho 6278: ul.LC_TabContent .right {
1.911 bisitz 6279: float:right;
1.847 tempelho 6280: }
6281:
1.911 bisitz 6282: ul.LC_TabContent li a,
6283: ul.LC_TabContent li {
6284: color:rgb(47,47,47);
6285: text-decoration:none;
6286: font-size:95%;
6287: font-weight:bold;
1.952 onken 6288: min-height:20px;
6289: }
6290:
1.959 onken 6291: ul.LC_TabContent li a:hover,
6292: ul.LC_TabContent li a:focus {
1.952 onken 6293: color: $button_hover;
1.959 onken 6294: background:none;
6295: outline:none;
1.952 onken 6296: }
6297:
6298: ul.LC_TabContent li:hover {
6299: color: $button_hover;
6300: cursor:pointer;
1.721 harmsja 6301: }
1.795 www 6302:
1.911 bisitz 6303: ul.LC_TabContent li.active {
1.952 onken 6304: color: $font;
1.911 bisitz 6305: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 6306: border-bottom:solid 1px #FFFFFF;
6307: cursor: default;
1.744 ehlerst 6308: }
1.795 www 6309:
1.959 onken 6310: ul.LC_TabContent li.active a {
6311: color:$font;
6312: background:#FFFFFF;
6313: outline: none;
6314: }
1.870 tempelho 6315: #maincoursedoc {
1.911 bisitz 6316: clear:both;
1.870 tempelho 6317: }
6318:
6319: ul.LC_TabContentBigger {
1.911 bisitz 6320: display:block;
6321: list-style:none;
6322: padding: 0;
1.870 tempelho 6323: }
6324:
1.795 www 6325: ul.LC_TabContentBigger li {
1.911 bisitz 6326: vertical-align:bottom;
6327: height: 30px;
6328: font-size:110%;
6329: font-weight:bold;
6330: color: #737373;
1.841 tempelho 6331: }
6332:
1.957 onken 6333: ul.LC_TabContentBigger li.active {
6334: position: relative;
6335: top: 1px;
6336: }
6337:
1.870 tempelho 6338: ul.LC_TabContentBigger li a {
1.911 bisitz 6339: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6340: height: 30px;
6341: line-height: 30px;
6342: text-align: center;
6343: display: block;
6344: text-decoration: none;
1.958 onken 6345: outline: none;
1.741 harmsja 6346: }
1.795 www 6347:
1.870 tempelho 6348: ul.LC_TabContentBigger li.active a {
1.911 bisitz 6349: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6350: color:$font;
1.744 ehlerst 6351: }
1.795 www 6352:
1.870 tempelho 6353: ul.LC_TabContentBigger li b {
1.911 bisitz 6354: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
6355: display: block;
6356: float: left;
6357: padding: 0 30px;
1.957 onken 6358: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 6359: }
6360:
1.956 onken 6361: ul.LC_TabContentBigger li:hover b {
6362: color:$button_hover;
6363: }
6364:
1.870 tempelho 6365: ul.LC_TabContentBigger li.active b {
1.911 bisitz 6366: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
6367: color:$font;
1.957 onken 6368: border: 0;
1.741 harmsja 6369: }
1.693 droeschl 6370:
1.870 tempelho 6371:
1.862 bisitz 6372: ul.LC_CourseBreadcrumbs {
6373: background: $sidebg;
1.1020 raeburn 6374: height: 2em;
1.862 bisitz 6375: padding-left: 10px;
1.1020 raeburn 6376: margin: 0;
1.862 bisitz 6377: list-style-position: inside;
6378: }
6379:
1.911 bisitz 6380: ol#LC_MenuBreadcrumbs,
1.862 bisitz 6381: ol#LC_PathBreadcrumbs {
1.911 bisitz 6382: padding-left: 10px;
6383: margin: 0;
1.933 droeschl 6384: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 6385: }
6386:
1.911 bisitz 6387: ol#LC_MenuBreadcrumbs li,
6388: ol#LC_PathBreadcrumbs li,
1.862 bisitz 6389: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 6390: display: inline;
1.933 droeschl 6391: white-space: normal;
1.693 droeschl 6392: }
6393:
1.823 bisitz 6394: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 6395: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 6396: text-decoration: none;
6397: font-size:90%;
1.693 droeschl 6398: }
1.795 www 6399:
1.969 droeschl 6400: ol#LC_MenuBreadcrumbs h1 {
6401: display: inline;
6402: font-size: 90%;
6403: line-height: 2.5em;
6404: margin: 0;
6405: padding: 0;
6406: }
6407:
1.795 www 6408: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 6409: text-decoration:none;
6410: font-size:100%;
6411: font-weight:bold;
1.693 droeschl 6412: }
1.795 www 6413:
1.840 bisitz 6414: .LC_Box {
1.911 bisitz 6415: border: solid 1px $lg_border_color;
6416: padding: 0 10px 10px 10px;
1.746 neumanie 6417: }
1.795 www 6418:
1.1020 raeburn 6419: .LC_DocsBox {
6420: border: solid 1px $lg_border_color;
6421: padding: 0 0 10px 10px;
6422: }
6423:
1.795 www 6424: .LC_AboutMe_Image {
1.911 bisitz 6425: float:left;
6426: margin-right:10px;
1.747 neumanie 6427: }
1.795 www 6428:
6429: .LC_Clear_AboutMe_Image {
1.911 bisitz 6430: clear:left;
1.747 neumanie 6431: }
1.795 www 6432:
1.721 harmsja 6433: dl.LC_ListStyleClean dt {
1.911 bisitz 6434: padding-right: 5px;
6435: display: table-header-group;
1.693 droeschl 6436: }
6437:
1.721 harmsja 6438: dl.LC_ListStyleClean dd {
1.911 bisitz 6439: display: table-row;
1.693 droeschl 6440: }
6441:
1.721 harmsja 6442: .LC_ListStyleClean,
6443: .LC_ListStyleSimple,
6444: .LC_ListStyleNormal,
1.795 www 6445: .LC_ListStyleSpecial {
1.911 bisitz 6446: /* display:block; */
6447: list-style-position: inside;
6448: list-style-type: none;
6449: overflow: hidden;
6450: padding: 0;
1.693 droeschl 6451: }
6452:
1.721 harmsja 6453: .LC_ListStyleSimple li,
6454: .LC_ListStyleSimple dd,
6455: .LC_ListStyleNormal li,
6456: .LC_ListStyleNormal dd,
6457: .LC_ListStyleSpecial li,
1.795 www 6458: .LC_ListStyleSpecial dd {
1.911 bisitz 6459: margin: 0;
6460: padding: 5px 5px 5px 10px;
6461: clear: both;
1.693 droeschl 6462: }
6463:
1.721 harmsja 6464: .LC_ListStyleClean li,
6465: .LC_ListStyleClean dd {
1.911 bisitz 6466: padding-top: 0;
6467: padding-bottom: 0;
1.693 droeschl 6468: }
6469:
1.721 harmsja 6470: .LC_ListStyleSimple dd,
1.795 www 6471: .LC_ListStyleSimple li {
1.911 bisitz 6472: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6473: }
6474:
1.721 harmsja 6475: .LC_ListStyleSpecial li,
6476: .LC_ListStyleSpecial dd {
1.911 bisitz 6477: list-style-type: none;
6478: background-color: RGB(220, 220, 220);
6479: margin-bottom: 4px;
1.693 droeschl 6480: }
6481:
1.721 harmsja 6482: table.LC_SimpleTable {
1.911 bisitz 6483: margin:5px;
6484: border:solid 1px $lg_border_color;
1.795 www 6485: }
1.693 droeschl 6486:
1.721 harmsja 6487: table.LC_SimpleTable tr {
1.911 bisitz 6488: padding: 0;
6489: border:solid 1px $lg_border_color;
1.693 droeschl 6490: }
1.795 www 6491:
6492: table.LC_SimpleTable thead {
1.911 bisitz 6493: background:rgb(220,220,220);
1.693 droeschl 6494: }
6495:
1.721 harmsja 6496: div.LC_columnSection {
1.911 bisitz 6497: display: block;
6498: clear: both;
6499: overflow: hidden;
6500: margin: 0;
1.693 droeschl 6501: }
6502:
1.721 harmsja 6503: div.LC_columnSection>* {
1.911 bisitz 6504: float: left;
6505: margin: 10px 20px 10px 0;
6506: overflow:hidden;
1.693 droeschl 6507: }
1.721 harmsja 6508:
1.795 www 6509: table em {
1.911 bisitz 6510: font-weight: bold;
6511: font-style: normal;
1.748 schulted 6512: }
1.795 www 6513:
1.779 bisitz 6514: table.LC_tableBrowseRes,
1.795 www 6515: table.LC_tableOfContent {
1.911 bisitz 6516: border:none;
6517: border-spacing: 1px;
6518: padding: 3px;
6519: background-color: #FFFFFF;
6520: font-size: 90%;
1.753 droeschl 6521: }
1.789 droeschl 6522:
1.911 bisitz 6523: table.LC_tableOfContent {
6524: border-collapse: collapse;
1.789 droeschl 6525: }
6526:
1.771 droeschl 6527: table.LC_tableBrowseRes a,
1.768 schulted 6528: table.LC_tableOfContent a {
1.911 bisitz 6529: background-color: transparent;
6530: text-decoration: none;
1.753 droeschl 6531: }
6532:
1.795 www 6533: table.LC_tableOfContent img {
1.911 bisitz 6534: border: none;
6535: height: 1.3em;
6536: vertical-align: text-bottom;
6537: margin-right: 0.3em;
1.753 droeschl 6538: }
1.757 schulted 6539:
1.795 www 6540: a#LC_content_toolbar_firsthomework {
1.911 bisitz 6541: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 6542: }
6543:
1.795 www 6544: a#LC_content_toolbar_everything {
1.911 bisitz 6545: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 6546: }
6547:
1.795 www 6548: a#LC_content_toolbar_uncompleted {
1.911 bisitz 6549: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 6550: }
6551:
1.795 www 6552: #LC_content_toolbar_clearbubbles {
1.911 bisitz 6553: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 6554: }
6555:
1.795 www 6556: a#LC_content_toolbar_changefolder {
1.911 bisitz 6557: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 6558: }
6559:
1.795 www 6560: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 6561: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 6562: }
6563:
1.795 www 6564: ul#LC_toolbar li a:hover {
1.911 bisitz 6565: background-position: bottom center;
1.757 schulted 6566: }
6567:
1.795 www 6568: ul#LC_toolbar {
1.911 bisitz 6569: padding: 0;
6570: margin: 2px;
6571: list-style:none;
6572: position:relative;
6573: background-color:white;
1.757 schulted 6574: }
6575:
1.795 www 6576: ul#LC_toolbar li {
1.911 bisitz 6577: border:1px solid white;
6578: padding: 0;
6579: margin: 0;
6580: float: left;
6581: display:inline;
6582: vertical-align:middle;
6583: }
1.757 schulted 6584:
1.783 amueller 6585:
1.795 www 6586: a.LC_toolbarItem {
1.911 bisitz 6587: display:block;
6588: padding: 0;
6589: margin: 0;
6590: height: 32px;
6591: width: 32px;
6592: color:white;
6593: border: none;
6594: background-repeat:no-repeat;
6595: background-color:transparent;
1.757 schulted 6596: }
6597:
1.915 droeschl 6598: ul.LC_funclist {
6599: margin: 0;
6600: padding: 0.5em 1em 0.5em 0;
6601: }
6602:
1.933 droeschl 6603: ul.LC_funclist > li:first-child {
6604: font-weight:bold;
6605: margin-left:0.8em;
6606: }
6607:
1.915 droeschl 6608: ul.LC_funclist + ul.LC_funclist {
6609: /*
6610: left border as a seperator if we have more than
6611: one list
6612: */
6613: border-left: 1px solid $sidebg;
6614: /*
6615: this hides the left border behind the border of the
6616: outer box if element is wrapped to the next 'line'
6617: */
6618: margin-left: -1px;
6619: }
6620:
1.843 bisitz 6621: ul.LC_funclist li {
1.915 droeschl 6622: display: inline;
1.782 bisitz 6623: white-space: nowrap;
1.915 droeschl 6624: margin: 0 0 0 25px;
6625: line-height: 150%;
1.782 bisitz 6626: }
6627:
1.974 wenzelju 6628: .LC_hidden {
6629: display: none;
6630: }
6631:
1.343 albertel 6632: END
6633: }
6634:
1.306 albertel 6635: =pod
6636:
6637: =item * &headtag()
6638:
6639: Returns a uniform footer for LON-CAPA web pages.
6640:
1.307 albertel 6641: Inputs: $title - optional title for the head
6642: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 6643: $args - optional arguments
1.319 albertel 6644: force_register - if is true call registerurl so the remote is
6645: informed
1.415 albertel 6646: redirect -> array ref of
6647: 1- seconds before redirect occurs
6648: 2- url to redirect to
6649: 3- whether the side effect should occur
1.315 albertel 6650: (side effect of setting
6651: $env{'internal.head.redirect'} to the url
6652: redirected too)
1.352 albertel 6653: domain -> force to color decorate a page for a specific
6654: domain
6655: function -> force usage of a specific rolish color scheme
6656: bgcolor -> override the default page bgcolor
1.460 albertel 6657: no_auto_mt_title
6658: -> prevent &mt()ing the title arg
1.464 albertel 6659:
1.306 albertel 6660: =cut
6661:
6662: sub headtag {
1.313 albertel 6663: my ($title,$head_extra,$args) = @_;
1.306 albertel 6664:
1.363 albertel 6665: my $function = $args->{'function'} || &get_users_function();
6666: my $domain = $args->{'domain'} || &determinedomain();
6667: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 6668: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 6669: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 6670: #time(),
1.418 albertel 6671: $env{'environment.color.timestamp'},
1.363 albertel 6672: $function,$domain,$bgcolor);
6673:
1.369 www 6674: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 6675:
1.308 albertel 6676: my $result =
6677: '<head>'.
1.461 albertel 6678: &font_settings();
1.319 albertel 6679:
1.461 albertel 6680: if (!$args->{'frameset'}) {
6681: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
6682: }
1.962 droeschl 6683: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
6684: $result .= Apache::lonxml::display_title();
1.319 albertel 6685: }
1.436 albertel 6686: if (!$args->{'no_nav_bar'}
6687: && !$args->{'only_body'}
6688: && !$args->{'frameset'}) {
6689: $result .= &help_menu_js();
6690: }
1.319 albertel 6691:
1.314 albertel 6692: if (ref($args->{'redirect'})) {
1.414 albertel 6693: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 6694: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 6695: if (!$inhibit_continue) {
6696: $env{'internal.head.redirect'} = $url;
6697: }
1.313 albertel 6698: $result.=<<ADDMETA
6699: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 6700: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 6701: ADDMETA
6702: }
1.306 albertel 6703: if (!defined($title)) {
6704: $title = 'The LearningOnline Network with CAPA';
6705: }
1.460 albertel 6706: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
6707: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 6708: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
6709: .$head_extra;
1.962 droeschl 6710: return $result.'</head>';
1.306 albertel 6711: }
6712:
6713: =pod
6714:
1.340 albertel 6715: =item * &font_settings()
6716:
6717: Returns neccessary <meta> to set the proper encoding
6718:
6719: Inputs: none
6720:
6721: =cut
6722:
6723: sub font_settings {
6724: my $headerstring='';
1.647 www 6725: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 6726: $headerstring.=
6727: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
6728: }
6729: return $headerstring;
6730: }
6731:
1.341 albertel 6732: =pod
6733:
6734: =item * &xml_begin()
6735:
6736: Returns the needed doctype and <html>
6737:
6738: Inputs: none
6739:
6740: =cut
6741:
6742: sub xml_begin {
6743: my $output='';
6744:
6745: if ($env{'browser.mathml'}) {
6746: $output='<?xml version="1.0"?>'
6747: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
6748: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
6749:
6750: # .'<!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">] >'
6751: .'<!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">'
6752: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
6753: .'xmlns="http://www.w3.org/1999/xhtml">';
6754: } else {
1.849 bisitz 6755: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
6756: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341 albertel 6757: }
6758: return $output;
6759: }
1.340 albertel 6760:
6761: =pod
6762:
1.306 albertel 6763: =item * &start_page()
6764:
6765: Returns a complete <html> .. <body> section for LON-CAPA web pages.
6766:
1.648 raeburn 6767: Inputs:
6768:
6769: =over 4
6770:
6771: $title - optional title for the page
6772:
6773: $head_extra - optional extra HTML to incude inside the <head>
6774:
6775: $args - additional optional args supported are:
6776:
6777: =over 8
6778:
6779: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 6780: arg on
1.814 bisitz 6781: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 6782: add_entries -> additional attributes to add to the <body>
6783: domain -> force to color decorate a page for a
1.317 albertel 6784: specific domain
1.648 raeburn 6785: function -> force usage of a specific rolish color
1.317 albertel 6786: scheme
1.648 raeburn 6787: redirect -> see &headtag()
6788: bgcolor -> override the default page bg color
6789: js_ready -> return a string ready for being used in
1.317 albertel 6790: a javascript writeln
1.648 raeburn 6791: html_encode -> return a string ready for being used in
1.320 albertel 6792: a html attribute
1.648 raeburn 6793: force_register -> if is true will turn on the &bodytag()
1.317 albertel 6794: $forcereg arg
1.648 raeburn 6795: frameset -> if true will start with a <frameset>
1.330 albertel 6796: rather than <body>
1.648 raeburn 6797: skip_phases -> hash ref of
1.338 albertel 6798: head -> skip the <html><head> generation
6799: body -> skip all <body> generation
1.648 raeburn 6800: no_auto_mt_title -> prevent &mt()ing the title arg
6801: inherit_jsmath -> when creating popup window in a page,
6802: should it have jsmath forced on by the
6803: current page
1.867 kalberla 6804: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 6805: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.361 albertel 6806:
1.648 raeburn 6807: =back
1.460 albertel 6808:
1.648 raeburn 6809: =back
1.562 albertel 6810:
1.306 albertel 6811: =cut
6812:
6813: sub start_page {
1.309 albertel 6814: my ($title,$head_extra,$args) = @_;
1.318 albertel 6815: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.964 droeschl 6816: #SD
6817: #I don't see why we copy certain elements of %$args to %head_args
6818: #head args is passed to headtag() and this routine only reads those
6819: #keys that are needed. There doesn't happen any writes or any processing
6820: #of other keys.
6821: #proposal: just pass $args to headtag instead of \%head_args and delete
6822: #marked lines
6823: #<- MARK
1.313 albertel 6824: my %head_args;
1.352 albertel 6825: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6826: 'bgcolor','frameset','no_nav_bar','only_body',
6827: 'no_auto_mt_title') {
1.319 albertel 6828: if (defined($args->{$arg})) {
1.324 raeburn 6829: $head_args{$arg} = $args->{$arg};
1.319 albertel 6830: }
1.313 albertel 6831: }
1.964 droeschl 6832: #MARK ->
1.319 albertel 6833:
1.315 albertel 6834: $env{'internal.start_page'}++;
1.338 albertel 6835: my $result;
1.964 droeschl 6836:
1.338 albertel 6837: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.964 droeschl 6838: $result .=
6839: &xml_begin() . &headtag($title,$head_extra,\%head_args);
6840: #replace prev line by
6841: # &xml_begin() . &headtag($title, $head_extra, $args);
1.338 albertel 6842: }
6843:
6844: if (! exists($args->{'skip_phases'}{'body'}) ) {
6845: if ($args->{'frameset'}) {
6846: my $attr_string = &make_attr_string($args->{'force_register'},
6847: $args->{'add_entries'});
6848: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 6849: } else {
6850: $result .=
6851: &bodytag($title,
6852: $args->{'function'}, $args->{'add_entries'},
6853: $args->{'only_body'}, $args->{'domain'},
6854: $args->{'force_register'}, $args->{'no_nav_bar'},
1.962 droeschl 6855: $args->{'bgcolor'}, $args);
1.831 bisitz 6856: }
1.330 albertel 6857: }
1.338 albertel 6858:
1.315 albertel 6859: if ($args->{'js_ready'}) {
1.713 kaisler 6860: $result = &js_ready($result);
1.315 albertel 6861: }
1.320 albertel 6862: if ($args->{'html_encode'}) {
1.713 kaisler 6863: $result = &html_encode($result);
6864: }
6865:
1.813 bisitz 6866: # Preparation for new and consistent functionlist at top of screen
6867: # if ($args->{'functionlist'}) {
6868: # $result .= &build_functionlist();
6869: #}
6870:
1.964 droeschl 6871: # Don't add anything more if only_body wanted or in const space
6872: return $result if $args->{'only_body'}
6873: || $env{'request.state'} eq 'construct';
1.813 bisitz 6874:
6875: #Breadcrumbs
1.758 kaisler 6876: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
6877: &Apache::lonhtmlcommon::clear_breadcrumbs();
6878: #if any br links exists, add them to the breadcrumbs
6879: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6880: foreach my $crumb (@{$args->{'bread_crumbs'}}){
6881: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
6882: }
6883: }
6884:
6885: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
6886: if(exists($args->{'bread_crumbs_component'})){
6887: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
6888: }else{
6889: $result .= &Apache::lonhtmlcommon::breadcrumbs();
6890: }
1.320 albertel 6891: }
1.315 albertel 6892: return $result;
1.306 albertel 6893: }
6894:
6895: sub end_page {
1.315 albertel 6896: my ($args) = @_;
6897: $env{'internal.end_page'}++;
1.330 albertel 6898: my $result;
1.335 albertel 6899: if ($args->{'discussion'}) {
6900: my ($target,$parser);
6901: if (ref($args->{'discussion'})) {
6902: ($target,$parser) =($args->{'discussion'}{'target'},
6903: $args->{'discussion'}{'parser'});
6904: }
6905: $result .= &Apache::lonxml::xmlend($target,$parser);
6906: }
6907:
1.330 albertel 6908: if ($args->{'frameset'}) {
6909: $result .= '</frameset>';
6910: } else {
1.635 raeburn 6911: $result .= &endbodytag($args);
1.330 albertel 6912: }
6913: $result .= "\n</html>";
6914:
1.315 albertel 6915: if ($args->{'js_ready'}) {
1.317 albertel 6916: $result = &js_ready($result);
1.315 albertel 6917: }
1.335 albertel 6918:
1.320 albertel 6919: if ($args->{'html_encode'}) {
6920: $result = &html_encode($result);
6921: }
1.335 albertel 6922:
1.315 albertel 6923: return $result;
6924: }
6925:
1.320 albertel 6926: sub html_encode {
6927: my ($result) = @_;
6928:
1.322 albertel 6929: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6930:
6931: return $result;
6932: }
1.317 albertel 6933: sub js_ready {
6934: my ($result) = @_;
6935:
1.323 albertel 6936: $result =~ s/[\n\r]/ /xmsg;
6937: $result =~ s/\\/\\\\/xmsg;
6938: $result =~ s/'/\\'/xmsg;
1.372 albertel 6939: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6940:
6941: return $result;
6942: }
6943:
1.315 albertel 6944: sub validate_page {
6945: if ( exists($env{'internal.start_page'})
1.316 albertel 6946: && $env{'internal.start_page'} > 1) {
6947: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6948: $env{'internal.start_page'}.' '.
1.316 albertel 6949: $ENV{'request.filename'});
1.315 albertel 6950: }
6951: if ( exists($env{'internal.end_page'})
1.316 albertel 6952: && $env{'internal.end_page'} > 1) {
6953: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6954: $env{'internal.end_page'}.' '.
1.316 albertel 6955: $env{'request.filename'});
1.315 albertel 6956: }
6957: if ( exists($env{'internal.start_page'})
6958: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6959: &Apache::lonnet::logthis('start_page called without end_page '.
6960: $env{'request.filename'});
1.315 albertel 6961: }
6962: if ( ! exists($env{'internal.start_page'})
6963: && exists($env{'internal.end_page'})) {
1.316 albertel 6964: &Apache::lonnet::logthis('end_page called without start_page'.
6965: $env{'request.filename'});
1.315 albertel 6966: }
1.306 albertel 6967: }
1.315 albertel 6968:
1.996 www 6969:
6970: sub start_scrollbox {
1.1018 raeburn 6971: my ($outerwidth,$width,$height,$id)=@_;
1.998 raeburn 6972: unless ($outerwidth) { $outerwidth='520px'; }
6973: unless ($width) { $width='500px'; }
6974: unless ($height) { $height='200px'; }
1.1020 raeburn 6975: my ($table_id,$div_id);
1.1018 raeburn 6976: if ($id ne '') {
1.1020 raeburn 6977: $table_id = " id='table_$id'";
6978: $div_id = " id='div_$id'";
1.1018 raeburn 6979: }
1.1020 raeburn 6980: return "<table style='width: $outerwidth; border: 1px solid none;'$table_id><tr><td style='width: $width;' bgcolor='#FFFFFF'><div style='overflow:auto; width:$width; height: $height;'$div_id>";
1.996 www 6981: }
6982:
6983: sub end_scrollbox {
1.998 raeburn 6984: return '</td></tr></table>';
1.996 www 6985: }
6986:
1.318 albertel 6987: sub simple_error_page {
6988: my ($r,$title,$msg) = @_;
6989: my $page =
6990: &Apache::loncommon::start_page($title).
6991: &mt($msg).
6992: &Apache::loncommon::end_page();
6993: if (ref($r)) {
6994: $r->print($page);
1.327 albertel 6995: return;
1.318 albertel 6996: }
6997: return $page;
6998: }
1.347 albertel 6999:
7000: {
1.610 albertel 7001: my @row_count;
1.961 onken 7002:
7003: sub start_data_table_count {
7004: unshift(@row_count, 0);
7005: return;
7006: }
7007:
7008: sub end_data_table_count {
7009: shift(@row_count);
7010: return;
7011: }
7012:
1.347 albertel 7013: sub start_data_table {
1.1018 raeburn 7014: my ($add_class,$id) = @_;
1.422 albertel 7015: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 7016: my $table_id;
7017: if (defined($id)) {
7018: $table_id = ' id="'.$id.'"';
7019: }
1.961 onken 7020: &start_data_table_count();
1.1018 raeburn 7021: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 7022: }
7023:
7024: sub end_data_table {
1.961 onken 7025: &end_data_table_count();
1.389 albertel 7026: return '</table>'."\n";;
1.347 albertel 7027: }
7028:
7029: sub start_data_table_row {
1.974 wenzelju 7030: my ($add_class, $id) = @_;
1.610 albertel 7031: $row_count[0]++;
7032: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 7033: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 7034: $id = (' id="'.$id.'"') unless ($id eq '');
7035: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 7036: }
1.471 banghart 7037:
7038: sub continue_data_table_row {
1.974 wenzelju 7039: my ($add_class, $id) = @_;
1.610 albertel 7040: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 7041: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
7042: $id = (' id="'.$id.'"') unless ($id eq '');
7043: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 7044: }
1.347 albertel 7045:
7046: sub end_data_table_row {
1.389 albertel 7047: return '</tr>'."\n";;
1.347 albertel 7048: }
1.367 www 7049:
1.421 albertel 7050: sub start_data_table_empty_row {
1.707 bisitz 7051: # $row_count[0]++;
1.421 albertel 7052: return '<tr class="LC_empty_row" >'."\n";;
7053: }
7054:
7055: sub end_data_table_empty_row {
7056: return '</tr>'."\n";;
7057: }
7058:
1.367 www 7059: sub start_data_table_header_row {
1.389 albertel 7060: return '<tr class="LC_header_row">'."\n";;
1.367 www 7061: }
7062:
7063: sub end_data_table_header_row {
1.389 albertel 7064: return '</tr>'."\n";;
1.367 www 7065: }
1.890 droeschl 7066:
7067: sub data_table_caption {
7068: my $caption = shift;
7069: return "<caption class=\"LC_caption\">$caption</caption>";
7070: }
1.347 albertel 7071: }
7072:
1.548 albertel 7073: =pod
7074:
7075: =item * &inhibit_menu_check($arg)
7076:
7077: Checks for a inhibitmenu state and generates output to preserve it
7078:
7079: Inputs: $arg - can be any of
7080: - undef - in which case the return value is a string
7081: to add into arguments list of a uri
7082: - 'input' - in which case the return value is a HTML
7083: <form> <input> field of type hidden to
7084: preserve the value
7085: - a url - in which case the return value is the url with
7086: the neccesary cgi args added to preserve the
7087: inhibitmenu state
7088: - a ref to a url - no return value, but the string is
7089: updated to include the neccessary cgi
7090: args to preserve the inhibitmenu state
7091:
7092: =cut
7093:
7094: sub inhibit_menu_check {
7095: my ($arg) = @_;
7096: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
7097: if ($arg eq 'input') {
7098: if ($env{'form.inhibitmenu'}) {
7099: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
7100: } else {
7101: return
7102: }
7103: }
7104: if ($env{'form.inhibitmenu'}) {
7105: if (ref($arg)) {
7106: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7107: } elsif ($arg eq '') {
7108: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
7109: } else {
7110: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7111: }
7112: }
7113: if (!ref($arg)) {
7114: return $arg;
7115: }
7116: }
7117:
1.251 albertel 7118: ###############################################
1.182 matthew 7119:
7120: =pod
7121:
1.549 albertel 7122: =back
7123:
7124: =head1 User Information Routines
7125:
7126: =over 4
7127:
1.405 albertel 7128: =item * &get_users_function()
1.182 matthew 7129:
7130: Used by &bodytag to determine the current users primary role.
7131: Returns either 'student','coordinator','admin', or 'author'.
7132:
7133: =cut
7134:
7135: ###############################################
7136: sub get_users_function {
1.815 tempelho 7137: my $function = 'norole';
1.818 tempelho 7138: if ($env{'request.role'}=~/^(st)/) {
7139: $function='student';
7140: }
1.907 raeburn 7141: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 7142: $function='coordinator';
7143: }
1.258 albertel 7144: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 7145: $function='admin';
7146: }
1.826 bisitz 7147: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025 raeburn 7148: ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182 matthew 7149: $function='author';
7150: }
7151: return $function;
1.54 www 7152: }
1.99 www 7153:
7154: ###############################################
7155:
1.233 raeburn 7156: =pod
7157:
1.821 raeburn 7158: =item * &show_course()
7159:
7160: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
7161: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
7162:
7163: Inputs:
7164: None
7165:
7166: Outputs:
7167: Scalar: 1 if 'Course' to be used, 0 otherwise.
7168:
7169: =cut
7170:
7171: ###############################################
7172: sub show_course {
7173: my $course = !$env{'user.adv'};
7174: if (!$env{'user.adv'}) {
7175: foreach my $env (keys(%env)) {
7176: next if ($env !~ m/^user\.priv\./);
7177: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
7178: $course = 0;
7179: last;
7180: }
7181: }
7182: }
7183: return $course;
7184: }
7185:
7186: ###############################################
7187:
7188: =pod
7189:
1.542 raeburn 7190: =item * &check_user_status()
1.274 raeburn 7191:
7192: Determines current status of supplied role for a
7193: specific user. Roles can be active, previous or future.
7194:
7195: Inputs:
7196: user's domain, user's username, course's domain,
1.375 raeburn 7197: course's number, optional section ID.
1.274 raeburn 7198:
7199: Outputs:
7200: role status: active, previous or future.
7201:
7202: =cut
7203:
7204: sub check_user_status {
1.412 raeburn 7205: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.982 raeburn 7206: my $extra = &Apache::lonnet::freeze_escape({'skipcheck' => 1});
7207: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname,'.',undef,$extra);
1.274 raeburn 7208: my @uroles = keys %userinfo;
7209: my $srchstr;
7210: my $active_chk = 'none';
1.412 raeburn 7211: my $now = time;
1.274 raeburn 7212: if (@uroles > 0) {
1.908 raeburn 7213: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 7214: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
7215: } else {
1.412 raeburn 7216: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
7217: }
7218: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 7219: my $role_end = 0;
7220: my $role_start = 0;
7221: $active_chk = 'active';
1.412 raeburn 7222: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
7223: $role_end = $1;
7224: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
7225: $role_start = $1;
1.274 raeburn 7226: }
7227: }
7228: if ($role_start > 0) {
1.412 raeburn 7229: if ($now < $role_start) {
1.274 raeburn 7230: $active_chk = 'future';
7231: }
7232: }
7233: if ($role_end > 0) {
1.412 raeburn 7234: if ($now > $role_end) {
1.274 raeburn 7235: $active_chk = 'previous';
7236: }
7237: }
7238: }
7239: }
7240: return $active_chk;
7241: }
7242:
7243: ###############################################
7244:
7245: =pod
7246:
1.405 albertel 7247: =item * &get_sections()
1.233 raeburn 7248:
7249: Determines all the sections for a course including
7250: sections with students and sections containing other roles.
1.419 raeburn 7251: Incoming parameters:
7252:
7253: 1. domain
7254: 2. course number
7255: 3. reference to array containing roles for which sections should
7256: be gathered (optional).
7257: 4. reference to array containing status types for which sections
7258: should be gathered (optional).
7259:
7260: If the third argument is undefined, sections are gathered for any role.
7261: If the fourth argument is undefined, sections are gathered for any status.
7262: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 7263:
1.374 raeburn 7264: Returns section hash (keys are section IDs, values are
7265: number of users in each section), subject to the
1.419 raeburn 7266: optional roles filter, optional status filter
1.233 raeburn 7267:
7268: =cut
7269:
7270: ###############################################
7271: sub get_sections {
1.419 raeburn 7272: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 7273: if (!defined($cdom) || !defined($cnum)) {
7274: my $cid = $env{'request.course.id'};
7275:
7276: return if (!defined($cid));
7277:
7278: $cdom = $env{'course.'.$cid.'.domain'};
7279: $cnum = $env{'course.'.$cid.'.num'};
7280: }
7281:
7282: my %sectioncount;
1.419 raeburn 7283: my $now = time;
1.240 albertel 7284:
1.366 albertel 7285: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 7286: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 7287: my $sec_index = &Apache::loncoursedata::CL_SECTION();
7288: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 7289: my $start_index = &Apache::loncoursedata::CL_START();
7290: my $end_index = &Apache::loncoursedata::CL_END();
7291: my $status;
1.366 albertel 7292: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 7293: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
7294: $data->[$status_index],
7295: $data->[$start_index],
7296: $data->[$end_index]);
7297: if ($stu_status eq 'Active') {
7298: $status = 'active';
7299: } elsif ($end < $now) {
7300: $status = 'previous';
7301: } elsif ($start > $now) {
7302: $status = 'future';
7303: }
7304: if ($section ne '-1' && $section !~ /^\s*$/) {
7305: if ((!defined($possible_status)) || (($status ne '') &&
7306: (grep/^\Q$status\E$/,@{$possible_status}))) {
7307: $sectioncount{$section}++;
7308: }
1.240 albertel 7309: }
7310: }
7311: }
7312: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7313: foreach my $user (sort(keys(%courseroles))) {
7314: if ($user !~ /^(\w{2})/) { next; }
7315: my ($role) = ($user =~ /^(\w{2})/);
7316: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 7317: my ($section,$status);
1.240 albertel 7318: if ($role eq 'cr' &&
7319: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
7320: $section=$1;
7321: }
7322: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
7323: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 7324: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
7325: if ($end == -1 && $start == -1) {
7326: next; #deleted role
7327: }
7328: if (!defined($possible_status)) {
7329: $sectioncount{$section}++;
7330: } else {
7331: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
7332: $status = 'active';
7333: } elsif ($end < $now) {
7334: $status = 'future';
7335: } elsif ($start > $now) {
7336: $status = 'previous';
7337: }
7338: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
7339: $sectioncount{$section}++;
7340: }
7341: }
1.233 raeburn 7342: }
1.366 albertel 7343: return %sectioncount;
1.233 raeburn 7344: }
7345:
1.274 raeburn 7346: ###############################################
1.294 raeburn 7347:
7348: =pod
1.405 albertel 7349:
7350: =item * &get_course_users()
7351:
1.275 raeburn 7352: Retrieves usernames:domains for users in the specified course
7353: with specific role(s), and access status.
7354:
7355: Incoming parameters:
1.277 albertel 7356: 1. course domain
7357: 2. course number
7358: 3. access status: users must have - either active,
1.275 raeburn 7359: previous, future, or all.
1.277 albertel 7360: 4. reference to array of permissible roles
1.288 raeburn 7361: 5. reference to array of section restrictions (optional)
7362: 6. reference to results object (hash of hashes).
7363: 7. reference to optional userdata hash
1.609 raeburn 7364: 8. reference to optional statushash
1.630 raeburn 7365: 9. flag if privileged users (except those set to unhide in
7366: course settings) should be excluded
1.609 raeburn 7367: Keys of top level results hash are roles.
1.275 raeburn 7368: Keys of inner hashes are username:domain, with
7369: values set to access type.
1.288 raeburn 7370: Optional userdata hash returns an array with arguments in the
7371: same order as loncoursedata::get_classlist() for student data.
7372:
1.609 raeburn 7373: Optional statushash returns
7374:
1.288 raeburn 7375: Entries for end, start, section and status are blank because
7376: of the possibility of multiple values for non-student roles.
7377:
1.275 raeburn 7378: =cut
1.405 albertel 7379:
1.275 raeburn 7380: ###############################################
1.405 albertel 7381:
1.275 raeburn 7382: sub get_course_users {
1.630 raeburn 7383: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 7384: my %idx = ();
1.419 raeburn 7385: my %seclists;
1.288 raeburn 7386:
7387: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
7388: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
7389: $idx{end} = &Apache::loncoursedata::CL_END();
7390: $idx{start} = &Apache::loncoursedata::CL_START();
7391: $idx{id} = &Apache::loncoursedata::CL_ID();
7392: $idx{section} = &Apache::loncoursedata::CL_SECTION();
7393: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
7394: $idx{status} = &Apache::loncoursedata::CL_STATUS();
7395:
1.290 albertel 7396: if (grep(/^st$/,@{$roles})) {
1.276 albertel 7397: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 7398: my $now = time;
1.277 albertel 7399: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 7400: my $match = 0;
1.412 raeburn 7401: my $secmatch = 0;
1.419 raeburn 7402: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 7403: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 7404: if ($section eq '') {
7405: $section = 'none';
7406: }
1.291 albertel 7407: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7408: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7409: $secmatch = 1;
7410: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 7411: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7412: $secmatch = 1;
7413: }
7414: } else {
1.419 raeburn 7415: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 7416: $secmatch = 1;
7417: }
1.290 albertel 7418: }
1.412 raeburn 7419: if (!$secmatch) {
7420: next;
7421: }
1.419 raeburn 7422: }
1.275 raeburn 7423: if (defined($$types{'active'})) {
1.288 raeburn 7424: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 7425: push(@{$$users{st}{$student}},'active');
1.288 raeburn 7426: $match = 1;
1.275 raeburn 7427: }
7428: }
7429: if (defined($$types{'previous'})) {
1.609 raeburn 7430: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 7431: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 7432: $match = 1;
1.275 raeburn 7433: }
7434: }
7435: if (defined($$types{'future'})) {
1.609 raeburn 7436: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 7437: push(@{$$users{st}{$student}},'future');
1.288 raeburn 7438: $match = 1;
1.275 raeburn 7439: }
7440: }
1.609 raeburn 7441: if ($match) {
7442: push(@{$seclists{$student}},$section);
7443: if (ref($userdata) eq 'HASH') {
7444: $$userdata{$student} = $$classlist{$student};
7445: }
7446: if (ref($statushash) eq 'HASH') {
7447: $statushash->{$student}{'st'}{$section} = $status;
7448: }
1.288 raeburn 7449: }
1.275 raeburn 7450: }
7451: }
1.412 raeburn 7452: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 7453: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7454: my $now = time;
1.609 raeburn 7455: my %displaystatus = ( previous => 'Expired',
7456: active => 'Active',
7457: future => 'Future',
7458: );
1.630 raeburn 7459: my %nothide;
7460: if ($hidepriv) {
7461: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
7462: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
7463: if ($user !~ /:/) {
7464: $nothide{join(':',split(/[\@]/,$user))}=1;
7465: } else {
7466: $nothide{$user} = 1;
7467: }
7468: }
7469: }
1.439 raeburn 7470: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 7471: my $match = 0;
1.412 raeburn 7472: my $secmatch = 0;
1.439 raeburn 7473: my $status;
1.412 raeburn 7474: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 7475: $user =~ s/:$//;
1.439 raeburn 7476: my ($end,$start) = split(/:/,$coursepersonnel{$person});
7477: if ($end == -1 || $start == -1) {
7478: next;
7479: }
7480: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
7481: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 7482: my ($uname,$udom) = split(/:/,$user);
7483: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7484: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7485: $secmatch = 1;
7486: } elsif ($usec eq '') {
1.420 albertel 7487: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7488: $secmatch = 1;
7489: }
7490: } else {
7491: if (grep(/^\Q$usec\E$/,@{$sections})) {
7492: $secmatch = 1;
7493: }
7494: }
7495: if (!$secmatch) {
7496: next;
7497: }
1.288 raeburn 7498: }
1.419 raeburn 7499: if ($usec eq '') {
7500: $usec = 'none';
7501: }
1.275 raeburn 7502: if ($uname ne '' && $udom ne '') {
1.630 raeburn 7503: if ($hidepriv) {
7504: if ((&Apache::lonnet::privileged($uname,$udom)) &&
7505: (!$nothide{$uname.':'.$udom})) {
7506: next;
7507: }
7508: }
1.503 raeburn 7509: if ($end > 0 && $end < $now) {
1.439 raeburn 7510: $status = 'previous';
7511: } elsif ($start > $now) {
7512: $status = 'future';
7513: } else {
7514: $status = 'active';
7515: }
1.277 albertel 7516: foreach my $type (keys(%{$types})) {
1.275 raeburn 7517: if ($status eq $type) {
1.420 albertel 7518: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 7519: push(@{$$users{$role}{$user}},$type);
7520: }
1.288 raeburn 7521: $match = 1;
7522: }
7523: }
1.419 raeburn 7524: if (($match) && (ref($userdata) eq 'HASH')) {
7525: if (!exists($$userdata{$uname.':'.$udom})) {
7526: &get_user_info($udom,$uname,\%idx,$userdata);
7527: }
1.420 albertel 7528: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 7529: push(@{$seclists{$uname.':'.$udom}},$usec);
7530: }
1.609 raeburn 7531: if (ref($statushash) eq 'HASH') {
7532: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
7533: }
1.275 raeburn 7534: }
7535: }
7536: }
7537: }
1.290 albertel 7538: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 7539: if ((defined($cdom)) && (defined($cnum))) {
7540: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
7541: if ( defined($csettings{'internal.courseowner'}) ) {
7542: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 7543: next if ($owner eq '');
7544: my ($ownername,$ownerdom);
7545: if ($owner =~ /^([^:]+):([^:]+)$/) {
7546: $ownername = $1;
7547: $ownerdom = $2;
7548: } else {
7549: $ownername = $owner;
7550: $ownerdom = $cdom;
7551: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 7552: }
7553: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 7554: if (defined($userdata) &&
1.609 raeburn 7555: !exists($$userdata{$owner})) {
7556: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
7557: if (!grep(/^none$/,@{$seclists{$owner}})) {
7558: push(@{$seclists{$owner}},'none');
7559: }
7560: if (ref($statushash) eq 'HASH') {
7561: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 7562: }
1.290 albertel 7563: }
1.279 raeburn 7564: }
7565: }
7566: }
1.419 raeburn 7567: foreach my $user (keys(%seclists)) {
7568: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
7569: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
7570: }
1.275 raeburn 7571: }
7572: return;
7573: }
7574:
1.288 raeburn 7575: sub get_user_info {
7576: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 7577: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
7578: &plainname($uname,$udom,'lastname');
1.291 albertel 7579: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 7580: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 7581: my %idhash = &Apache::lonnet::idrget($udom,($uname));
7582: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 7583: return;
7584: }
1.275 raeburn 7585:
1.472 raeburn 7586: ###############################################
7587:
7588: =pod
7589:
7590: =item * &get_user_quota()
7591:
7592: Retrieves quota assigned for storage of portfolio files for a user
7593:
7594: Incoming parameters:
7595: 1. user's username
7596: 2. user's domain
7597:
7598: Returns:
1.536 raeburn 7599: 1. Disk quota (in Mb) assigned to student.
7600: 2. (Optional) Type of setting: custom or default
7601: (individually assigned or default for user's
7602: institutional status).
7603: 3. (Optional) - User's institutional status (e.g., faculty, staff
7604: or student - types as defined in localenroll::inst_usertypes
7605: for user's domain, which determines default quota for user.
7606: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 7607:
7608: If a value has been stored in the user's environment,
1.536 raeburn 7609: it will return that, otherwise it returns the maximal default
7610: defined for the user's instituional status(es) in the domain.
1.472 raeburn 7611:
7612: =cut
7613:
7614: ###############################################
7615:
7616:
7617: sub get_user_quota {
7618: my ($uname,$udom) = @_;
1.536 raeburn 7619: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 7620: if (!defined($udom)) {
7621: $udom = $env{'user.domain'};
7622: }
7623: if (!defined($uname)) {
7624: $uname = $env{'user.name'};
7625: }
7626: if (($udom eq '' || $uname eq '') ||
7627: ($udom eq 'public') && ($uname eq 'public')) {
7628: $quota = 0;
1.536 raeburn 7629: $quotatype = 'default';
7630: $defquota = 0;
1.472 raeburn 7631: } else {
1.536 raeburn 7632: my $inststatus;
1.472 raeburn 7633: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
7634: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 7635: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 7636: } else {
1.536 raeburn 7637: my %userenv =
7638: &Apache::lonnet::get('environment',['portfolioquota',
7639: 'inststatus'],$udom,$uname);
1.472 raeburn 7640: my ($tmp) = keys(%userenv);
7641: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7642: $quota = $userenv{'portfolioquota'};
1.536 raeburn 7643: $inststatus = $userenv{'inststatus'};
1.472 raeburn 7644: } else {
7645: undef(%userenv);
7646: }
7647: }
1.536 raeburn 7648: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 7649: if ($quota eq '') {
1.536 raeburn 7650: $quota = $defquota;
7651: $quotatype = 'default';
7652: } else {
7653: $quotatype = 'custom';
1.472 raeburn 7654: }
7655: }
1.536 raeburn 7656: if (wantarray) {
7657: return ($quota,$quotatype,$settingstatus,$defquota);
7658: } else {
7659: return $quota;
7660: }
1.472 raeburn 7661: }
7662:
7663: ###############################################
7664:
7665: =pod
7666:
7667: =item * &default_quota()
7668:
1.536 raeburn 7669: Retrieves default quota assigned for storage of user portfolio files,
7670: given an (optional) user's institutional status.
1.472 raeburn 7671:
7672: Incoming parameters:
7673: 1. domain
1.536 raeburn 7674: 2. (Optional) institutional status(es). This is a : separated list of
7675: status types (e.g., faculty, staff, student etc.)
7676: which apply to the user for whom the default is being retrieved.
7677: If the institutional status string in undefined, the domain
7678: default quota will be returned.
1.472 raeburn 7679:
7680: Returns:
7681: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 7682: 2. (Optional) institutional type which determined the value of the
7683: default quota.
1.472 raeburn 7684:
7685: If a value has been stored in the domain's configuration db,
7686: it will return that, otherwise it returns 20 (for backwards
7687: compatibility with domains which have not set up a configuration
7688: db file; the original statically defined portfolio quota was 20 Mb).
7689:
1.536 raeburn 7690: If the user's status includes multiple types (e.g., staff and student),
7691: the largest default quota which applies to the user determines the
7692: default quota returned.
7693:
1.780 raeburn 7694: =back
7695:
1.472 raeburn 7696: =cut
7697:
7698: ###############################################
7699:
7700:
7701: sub default_quota {
1.536 raeburn 7702: my ($udom,$inststatus) = @_;
7703: my ($defquota,$settingstatus);
7704: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 7705: ['quotas'],$udom);
7706: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 7707: if ($inststatus ne '') {
1.765 raeburn 7708: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 7709: foreach my $item (@statuses) {
1.711 raeburn 7710: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7711: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
7712: if ($defquota eq '') {
7713: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7714: $settingstatus = $item;
7715: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
7716: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7717: $settingstatus = $item;
7718: }
7719: }
7720: } else {
7721: if ($quotahash{'quotas'}{$item} ne '') {
7722: if ($defquota eq '') {
7723: $defquota = $quotahash{'quotas'}{$item};
7724: $settingstatus = $item;
7725: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
7726: $defquota = $quotahash{'quotas'}{$item};
7727: $settingstatus = $item;
7728: }
1.536 raeburn 7729: }
7730: }
7731: }
7732: }
7733: if ($defquota eq '') {
1.711 raeburn 7734: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7735: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
7736: } else {
7737: $defquota = $quotahash{'quotas'}{'default'};
7738: }
1.536 raeburn 7739: $settingstatus = 'default';
7740: }
7741: } else {
7742: $settingstatus = 'default';
7743: $defquota = 20;
7744: }
7745: if (wantarray) {
7746: return ($defquota,$settingstatus);
1.472 raeburn 7747: } else {
1.536 raeburn 7748: return $defquota;
1.472 raeburn 7749: }
7750: }
7751:
1.384 raeburn 7752: sub get_secgrprole_info {
7753: my ($cdom,$cnum,$needroles,$type) = @_;
7754: my %sections_count = &get_sections($cdom,$cnum);
7755: my @sections = (sort {$a <=> $b} keys(%sections_count));
7756: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
7757: my @groups = sort(keys(%curr_groups));
7758: my $allroles = [];
7759: my $rolehash;
7760: my $accesshash = {
7761: active => 'Currently has access',
7762: future => 'Will have future access',
7763: previous => 'Previously had access',
7764: };
7765: if ($needroles) {
7766: $rolehash = {'all' => 'all'};
1.385 albertel 7767: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7768: if (&Apache::lonnet::error(%user_roles)) {
7769: undef(%user_roles);
7770: }
7771: foreach my $item (keys(%user_roles)) {
1.384 raeburn 7772: my ($role)=split(/\:/,$item,2);
7773: if ($role eq 'cr') { next; }
7774: if ($role =~ /^cr/) {
7775: $$rolehash{$role} = (split('/',$role))[3];
7776: } else {
7777: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
7778: }
7779: }
7780: foreach my $key (sort(keys(%{$rolehash}))) {
7781: push(@{$allroles},$key);
7782: }
7783: push (@{$allroles},'st');
7784: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
7785: }
7786: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
7787: }
7788:
1.555 raeburn 7789: sub user_picker {
1.994 raeburn 7790: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context) = @_;
1.555 raeburn 7791: my $currdom = $dom;
7792: my %curr_selected = (
7793: srchin => 'dom',
1.580 raeburn 7794: srchby => 'lastname',
1.555 raeburn 7795: );
7796: my $srchterm;
1.625 raeburn 7797: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 7798: if ($srch->{'srchby'} ne '') {
7799: $curr_selected{'srchby'} = $srch->{'srchby'};
7800: }
7801: if ($srch->{'srchin'} ne '') {
7802: $curr_selected{'srchin'} = $srch->{'srchin'};
7803: }
7804: if ($srch->{'srchtype'} ne '') {
7805: $curr_selected{'srchtype'} = $srch->{'srchtype'};
7806: }
7807: if ($srch->{'srchdomain'} ne '') {
7808: $currdom = $srch->{'srchdomain'};
7809: }
7810: $srchterm = $srch->{'srchterm'};
7811: }
7812: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 7813: 'usr' => 'Search criteria',
1.563 raeburn 7814: 'doma' => 'Domain/institution to search',
1.558 albertel 7815: 'uname' => 'username',
7816: 'lastname' => 'last name',
1.555 raeburn 7817: 'lastfirst' => 'last name, first name',
1.558 albertel 7818: 'crs' => 'in this course',
1.576 raeburn 7819: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 7820: 'alc' => 'all LON-CAPA',
1.573 raeburn 7821: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 7822: 'exact' => 'is',
7823: 'contains' => 'contains',
1.569 raeburn 7824: 'begins' => 'begins with',
1.571 raeburn 7825: 'youm' => "You must include some text to search for.",
7826: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
7827: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
7828: 'yomc' => "You must choose a domain when using an institutional directory search.",
7829: 'ymcd' => "You must choose a domain when using a domain search.",
7830: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
7831: 'whse' => "When searching by last,first you must include at least one character in the first name.",
7832: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 7833: );
1.563 raeburn 7834: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
7835: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 7836:
7837: my @srchins = ('crs','dom','alc','instd');
7838:
7839: foreach my $option (@srchins) {
7840: # FIXME 'alc' option unavailable until
7841: # loncreateuser::print_user_query_page()
7842: # has been completed.
7843: next if ($option eq 'alc');
1.880 raeburn 7844: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 7845: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 7846: if ($curr_selected{'srchin'} eq $option) {
7847: $srchinsel .= '
7848: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7849: } else {
7850: $srchinsel .= '
7851: <option value="'.$option.'">'.$lt{$option}.'</option>';
7852: }
1.555 raeburn 7853: }
1.563 raeburn 7854: $srchinsel .= "\n </select>\n";
1.555 raeburn 7855:
7856: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 7857: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 7858: if ($curr_selected{'srchby'} eq $option) {
7859: $srchbysel .= '
7860: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7861: } else {
7862: $srchbysel .= '
7863: <option value="'.$option.'">'.$lt{$option}.'</option>';
7864: }
7865: }
7866: $srchbysel .= "\n </select>\n";
7867:
7868: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 7869: foreach my $option ('begins','contains','exact') {
1.555 raeburn 7870: if ($curr_selected{'srchtype'} eq $option) {
7871: $srchtypesel .= '
7872: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7873: } else {
7874: $srchtypesel .= '
7875: <option value="'.$option.'">'.$lt{$option}.'</option>';
7876: }
7877: }
7878: $srchtypesel .= "\n </select>\n";
7879:
1.558 albertel 7880: my ($newuserscript,$new_user_create);
1.994 raeburn 7881: my $context_dom = $env{'request.role.domain'};
7882: if ($context eq 'requestcrs') {
7883: if ($env{'form.coursedom'} ne '') {
7884: $context_dom = $env{'form.coursedom'};
7885: }
7886: }
1.556 raeburn 7887: if ($forcenewuser) {
1.576 raeburn 7888: if (ref($srch) eq 'HASH') {
1.994 raeburn 7889: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 7890: if ($cancreate) {
7891: $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>';
7892: } else {
1.799 bisitz 7893: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 7894: my %usertypetext = (
7895: official => 'institutional',
7896: unofficial => 'non-institutional',
7897: );
1.799 bisitz 7898: $new_user_create = '<p class="LC_warning">'
7899: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
7900: .' '
7901: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
7902: ,'<a href="'.$helplink.'">','</a>')
7903: .'</p><br />';
1.627 raeburn 7904: }
1.576 raeburn 7905: }
7906: }
7907:
1.556 raeburn 7908: $newuserscript = <<"ENDSCRIPT";
7909:
1.570 raeburn 7910: function setSearch(createnew,callingForm) {
1.556 raeburn 7911: if (createnew == 1) {
1.570 raeburn 7912: for (var i=0; i<callingForm.srchby.length; i++) {
7913: if (callingForm.srchby.options[i].value == 'uname') {
7914: callingForm.srchby.selectedIndex = i;
1.556 raeburn 7915: }
7916: }
1.570 raeburn 7917: for (var i=0; i<callingForm.srchin.length; i++) {
7918: if ( callingForm.srchin.options[i].value == 'dom') {
7919: callingForm.srchin.selectedIndex = i;
1.556 raeburn 7920: }
7921: }
1.570 raeburn 7922: for (var i=0; i<callingForm.srchtype.length; i++) {
7923: if (callingForm.srchtype.options[i].value == 'exact') {
7924: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 7925: }
7926: }
1.570 raeburn 7927: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 7928: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 7929: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 7930: }
7931: }
7932: }
7933: }
7934: ENDSCRIPT
1.558 albertel 7935:
1.556 raeburn 7936: }
7937:
1.555 raeburn 7938: my $output = <<"END_BLOCK";
1.556 raeburn 7939: <script type="text/javascript">
1.824 bisitz 7940: // <![CDATA[
1.570 raeburn 7941: function validateEntry(callingForm) {
1.558 albertel 7942:
1.556 raeburn 7943: var checkok = 1;
1.558 albertel 7944: var srchin;
1.570 raeburn 7945: for (var i=0; i<callingForm.srchin.length; i++) {
7946: if ( callingForm.srchin[i].checked ) {
7947: srchin = callingForm.srchin[i].value;
1.558 albertel 7948: }
7949: }
7950:
1.570 raeburn 7951: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7952: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7953: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7954: var srchterm = callingForm.srchterm.value;
7955: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7956: var msg = "";
7957:
7958: if (srchterm == "") {
7959: checkok = 0;
1.571 raeburn 7960: msg += "$lt{'youm'}\\n";
1.556 raeburn 7961: }
7962:
1.569 raeburn 7963: if (srchtype== 'begins') {
7964: if (srchterm.length < 2) {
7965: checkok = 0;
1.571 raeburn 7966: msg += "$lt{'thte'}\\n";
1.569 raeburn 7967: }
7968: }
7969:
1.556 raeburn 7970: if (srchtype== 'contains') {
7971: if (srchterm.length < 3) {
7972: checkok = 0;
1.571 raeburn 7973: msg += "$lt{'thet'}\\n";
1.556 raeburn 7974: }
7975: }
7976: if (srchin == 'instd') {
7977: if (srchdomain == '') {
7978: checkok = 0;
1.571 raeburn 7979: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7980: }
7981: }
7982: if (srchin == 'dom') {
7983: if (srchdomain == '') {
7984: checkok = 0;
1.571 raeburn 7985: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7986: }
7987: }
7988: if (srchby == 'lastfirst') {
7989: if (srchterm.indexOf(",") == -1) {
7990: checkok = 0;
1.571 raeburn 7991: msg += "$lt{'whus'}\\n";
1.556 raeburn 7992: }
7993: if (srchterm.indexOf(",") == srchterm.length -1) {
7994: checkok = 0;
1.571 raeburn 7995: msg += "$lt{'whse'}\\n";
1.556 raeburn 7996: }
7997: }
7998: if (checkok == 0) {
1.571 raeburn 7999: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 8000: return;
8001: }
8002: if (checkok == 1) {
1.570 raeburn 8003: callingForm.submit();
1.556 raeburn 8004: }
8005: }
8006:
8007: $newuserscript
8008:
1.824 bisitz 8009: // ]]>
1.556 raeburn 8010: </script>
1.558 albertel 8011:
8012: $new_user_create
8013:
1.555 raeburn 8014: END_BLOCK
1.558 albertel 8015:
1.876 raeburn 8016: $output .= &Apache::lonhtmlcommon::start_pick_box().
8017: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
8018: $domform.
8019: &Apache::lonhtmlcommon::row_closure().
8020: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
8021: $srchbysel.
8022: $srchtypesel.
8023: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
8024: $srchinsel.
8025: &Apache::lonhtmlcommon::row_closure(1).
8026: &Apache::lonhtmlcommon::end_pick_box().
8027: '<br />';
1.555 raeburn 8028: return $output;
8029: }
8030:
1.612 raeburn 8031: sub user_rule_check {
1.615 raeburn 8032: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 8033: my $response;
8034: if (ref($usershash) eq 'HASH') {
8035: foreach my $user (keys(%{$usershash})) {
8036: my ($uname,$udom) = split(/:/,$user);
8037: next if ($udom eq '' || $uname eq '');
1.615 raeburn 8038: my ($id,$newuser);
1.612 raeburn 8039: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 8040: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 8041: $id = $usershash->{$user}->{'id'};
8042: }
8043: my $inst_response;
8044: if (ref($checks) eq 'HASH') {
8045: if (defined($checks->{'username'})) {
1.615 raeburn 8046: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 8047: &Apache::lonnet::get_instuser($udom,$uname);
8048: } elsif (defined($checks->{'id'})) {
1.615 raeburn 8049: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 8050: &Apache::lonnet::get_instuser($udom,undef,$id);
8051: }
1.615 raeburn 8052: } else {
8053: ($inst_response,%{$inst_results->{$user}}) =
8054: &Apache::lonnet::get_instuser($udom,$uname);
8055: return;
1.612 raeburn 8056: }
1.615 raeburn 8057: if (!$got_rules->{$udom}) {
1.612 raeburn 8058: my %domconfig = &Apache::lonnet::get_dom('configuration',
8059: ['usercreation'],$udom);
8060: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 8061: foreach my $item ('username','id') {
1.612 raeburn 8062: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
8063: $$curr_rules{$udom}{$item} =
8064: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 8065: }
8066: }
8067: }
1.615 raeburn 8068: $got_rules->{$udom} = 1;
1.585 raeburn 8069: }
1.612 raeburn 8070: foreach my $item (keys(%{$checks})) {
8071: if (ref($$curr_rules{$udom}) eq 'HASH') {
8072: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
8073: if (@{$$curr_rules{$udom}{$item}} > 0) {
8074: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
8075: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
8076: if ($rule_check{$rule}) {
8077: $$rulematch{$user}{$item} = $rule;
8078: if ($inst_response eq 'ok') {
1.615 raeburn 8079: if (ref($inst_results) eq 'HASH') {
8080: if (ref($inst_results->{$user}) eq 'HASH') {
8081: if (keys(%{$inst_results->{$user}}) == 0) {
8082: $$alerts{$item}{$udom}{$uname} = 1;
8083: }
1.612 raeburn 8084: }
8085: }
1.615 raeburn 8086: }
8087: last;
1.585 raeburn 8088: }
8089: }
8090: }
8091: }
8092: }
8093: }
8094: }
8095: }
1.612 raeburn 8096: return;
8097: }
8098:
8099: sub user_rule_formats {
8100: my ($domain,$domdesc,$curr_rules,$check) = @_;
8101: my %text = (
8102: 'username' => 'Usernames',
8103: 'id' => 'IDs',
8104: );
8105: my $output;
8106: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
8107: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
8108: if (@{$ruleorder} > 0) {
8109: $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>';
8110: foreach my $rule (@{$ruleorder}) {
8111: if (ref($curr_rules) eq 'ARRAY') {
8112: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
8113: if (ref($rules->{$rule}) eq 'HASH') {
8114: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
8115: $rules->{$rule}{'desc'}.'</li>';
8116: }
8117: }
8118: }
8119: }
8120: $output .= '</ul>';
8121: }
8122: }
8123: return $output;
8124: }
8125:
8126: sub instrule_disallow_msg {
1.615 raeburn 8127: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 8128: my $response;
8129: my %text = (
8130: item => 'username',
8131: items => 'usernames',
8132: match => 'matches',
8133: do => 'does',
8134: action => 'a username',
8135: one => 'one',
8136: );
8137: if ($count > 1) {
8138: $text{'item'} = 'usernames';
8139: $text{'match'} ='match';
8140: $text{'do'} = 'do';
8141: $text{'action'} = 'usernames',
8142: $text{'one'} = 'ones';
8143: }
8144: if ($checkitem eq 'id') {
8145: $text{'items'} = 'IDs';
8146: $text{'item'} = 'ID';
8147: $text{'action'} = 'an ID';
1.615 raeburn 8148: if ($count > 1) {
8149: $text{'item'} = 'IDs';
8150: $text{'action'} = 'IDs';
8151: }
1.612 raeburn 8152: }
1.674 bisitz 8153: $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 8154: if ($mode eq 'upload') {
8155: if ($checkitem eq 'username') {
8156: $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'}.");
8157: } elsif ($checkitem eq 'id') {
1.674 bisitz 8158: $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 8159: }
1.669 raeburn 8160: } elsif ($mode eq 'selfcreate') {
8161: if ($checkitem eq 'id') {
8162: $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.");
8163: }
1.615 raeburn 8164: } else {
8165: if ($checkitem eq 'username') {
8166: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
8167: } elsif ($checkitem eq 'id') {
8168: $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.");
8169: }
1.612 raeburn 8170: }
8171: return $response;
1.585 raeburn 8172: }
8173:
1.624 raeburn 8174: sub personal_data_fieldtitles {
8175: my %fieldtitles = &Apache::lonlocal::texthash (
8176: id => 'Student/Employee ID',
8177: permanentemail => 'E-mail address',
8178: lastname => 'Last Name',
8179: firstname => 'First Name',
8180: middlename => 'Middle Name',
8181: generation => 'Generation',
8182: gen => 'Generation',
1.765 raeburn 8183: inststatus => 'Affiliation',
1.624 raeburn 8184: );
8185: return %fieldtitles;
8186: }
8187:
1.642 raeburn 8188: sub sorted_inst_types {
8189: my ($dom) = @_;
8190: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
8191: my $othertitle = &mt('All users');
8192: if ($env{'request.course.id'}) {
1.668 raeburn 8193: $othertitle = &mt('Any users');
1.642 raeburn 8194: }
8195: my @types;
8196: if (ref($order) eq 'ARRAY') {
8197: @types = @{$order};
8198: }
8199: if (@types == 0) {
8200: if (ref($usertypes) eq 'HASH') {
8201: @types = sort(keys(%{$usertypes}));
8202: }
8203: }
8204: if (keys(%{$usertypes}) > 0) {
8205: $othertitle = &mt('Other users');
8206: }
8207: return ($othertitle,$usertypes,\@types);
8208: }
8209:
1.645 raeburn 8210: sub get_institutional_codes {
8211: my ($settings,$allcourses,$LC_code) = @_;
8212: # Get complete list of course sections to update
8213: my @currsections = ();
8214: my @currxlists = ();
8215: my $coursecode = $$settings{'internal.coursecode'};
8216:
8217: if ($$settings{'internal.sectionnums'} ne '') {
8218: @currsections = split(/,/,$$settings{'internal.sectionnums'});
8219: }
8220:
8221: if ($$settings{'internal.crosslistings'} ne '') {
8222: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
8223: }
8224:
8225: if (@currxlists > 0) {
8226: foreach (@currxlists) {
8227: if (m/^([^:]+):(\w*)$/) {
8228: unless (grep/^$1$/,@{$allcourses}) {
8229: push @{$allcourses},$1;
8230: $$LC_code{$1} = $2;
8231: }
8232: }
8233: }
8234: }
8235:
8236: if (@currsections > 0) {
8237: foreach (@currsections) {
8238: if (m/^(\w+):(\w*)$/) {
8239: my $sec = $coursecode.$1;
8240: my $lc_sec = $2;
8241: unless (grep/^$sec$/,@{$allcourses}) {
8242: push @{$allcourses},$sec;
8243: $$LC_code{$sec} = $lc_sec;
8244: }
8245: }
8246: }
8247: }
8248: return;
8249: }
8250:
1.971 raeburn 8251: sub get_standard_codeitems {
8252: return ('Year','Semester','Department','Number','Section');
8253: }
8254:
1.112 bowersj2 8255: =pod
8256:
1.780 raeburn 8257: =head1 Slot Helpers
8258:
8259: =over 4
8260:
8261: =item * sorted_slots()
8262:
8263: Sorts an array of slot names in order of slot start time (earliest first).
8264:
8265: Inputs:
8266:
8267: =over 4
8268:
8269: slotsarr - Reference to array of unsorted slot names.
8270:
8271: slots - Reference to hash of hash, where outer hash keys are slot names.
8272:
1.549 albertel 8273: =back
8274:
1.780 raeburn 8275: Returns:
8276:
8277: =over 4
8278:
8279: sorted - An array of slot names sorted by the start time of the slot.
8280:
8281: =back
8282:
8283: =back
8284:
8285: =cut
8286:
8287:
8288: sub sorted_slots {
8289: my ($slotsarr,$slots) = @_;
8290: my @sorted;
8291: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
8292: @sorted =
8293: sort {
8294: if (ref($slots->{$a}) && ref($slots->{$b})) {
8295: return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
8296: }
8297: if (ref($slots->{$a})) { return -1;}
8298: if (ref($slots->{$b})) { return 1;}
8299: return 0;
8300: } @{$slotsarr};
8301: }
8302: return @sorted;
8303: }
8304:
8305:
8306: =pod
8307:
1.549 albertel 8308: =head1 HTTP Helpers
8309:
8310: =over 4
8311:
1.648 raeburn 8312: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 8313:
1.258 albertel 8314: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 8315: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 8316: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 8317:
8318: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
8319: $possible_names is an ref to an array of form element names. As an example:
8320: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 8321: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 8322:
8323: =cut
1.1 albertel 8324:
1.6 albertel 8325: sub get_unprocessed_cgi {
1.25 albertel 8326: my ($query,$possible_names)= @_;
1.26 matthew 8327: # $Apache::lonxml::debug=1;
1.356 albertel 8328: foreach my $pair (split(/&/,$query)) {
8329: my ($name, $value) = split(/=/,$pair);
1.369 www 8330: $name = &unescape($name);
1.25 albertel 8331: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
8332: $value =~ tr/+/ /;
8333: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 8334: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 8335: }
1.16 harris41 8336: }
1.6 albertel 8337: }
8338:
1.112 bowersj2 8339: =pod
8340:
1.648 raeburn 8341: =item * &cacheheader()
1.112 bowersj2 8342:
8343: returns cache-controlling header code
8344:
8345: =cut
8346:
1.7 albertel 8347: sub cacheheader {
1.258 albertel 8348: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 8349: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
8350: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 8351: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
8352: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 8353: return $output;
1.7 albertel 8354: }
8355:
1.112 bowersj2 8356: =pod
8357:
1.648 raeburn 8358: =item * &no_cache($r)
1.112 bowersj2 8359:
8360: specifies header code to not have cache
8361:
8362: =cut
8363:
1.9 albertel 8364: sub no_cache {
1.216 albertel 8365: my ($r) = @_;
8366: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 8367: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 8368: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
8369: $r->no_cache(1);
8370: $r->header_out("Expires" => $date);
8371: $r->header_out("Pragma" => "no-cache");
1.123 www 8372: }
8373:
8374: sub content_type {
1.181 albertel 8375: my ($r,$type,$charset) = @_;
1.299 foxr 8376: if ($r) {
8377: # Note that printout.pl calls this with undef for $r.
8378: &no_cache($r);
8379: }
1.258 albertel 8380: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 8381: unless ($charset) {
8382: $charset=&Apache::lonlocal::current_encoding;
8383: }
8384: if ($charset) { $type.='; charset='.$charset; }
8385: if ($r) {
8386: $r->content_type($type);
8387: } else {
8388: print("Content-type: $type\n\n");
8389: }
1.9 albertel 8390: }
1.25 albertel 8391:
1.112 bowersj2 8392: =pod
8393:
1.648 raeburn 8394: =item * &add_to_env($name,$value)
1.112 bowersj2 8395:
1.258 albertel 8396: adds $name to the %env hash with value
1.112 bowersj2 8397: $value, if $name already exists, the entry is converted to an array
8398: reference and $value is added to the array.
8399:
8400: =cut
8401:
1.25 albertel 8402: sub add_to_env {
8403: my ($name,$value)=@_;
1.258 albertel 8404: if (defined($env{$name})) {
8405: if (ref($env{$name})) {
1.25 albertel 8406: #already have multiple values
1.258 albertel 8407: push(@{ $env{$name} },$value);
1.25 albertel 8408: } else {
8409: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 8410: my $first=$env{$name};
8411: undef($env{$name});
8412: push(@{ $env{$name} },$first,$value);
1.25 albertel 8413: }
8414: } else {
1.258 albertel 8415: $env{$name}=$value;
1.25 albertel 8416: }
1.31 albertel 8417: }
1.149 albertel 8418:
8419: =pod
8420:
1.648 raeburn 8421: =item * &get_env_multiple($name)
1.149 albertel 8422:
1.258 albertel 8423: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 8424: values may be defined and end up as an array ref.
8425:
8426: returns an array of values
8427:
8428: =cut
8429:
8430: sub get_env_multiple {
8431: my ($name) = @_;
8432: my @values;
1.258 albertel 8433: if (defined($env{$name})) {
1.149 albertel 8434: # exists is it an array
1.258 albertel 8435: if (ref($env{$name})) {
8436: @values=@{ $env{$name} };
1.149 albertel 8437: } else {
1.258 albertel 8438: $values[0]=$env{$name};
1.149 albertel 8439: }
8440: }
8441: return(@values);
8442: }
8443:
1.660 raeburn 8444: sub ask_for_embedded_content {
8445: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.987 raeburn 8446: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges);
1.660 raeburn 8447: my $num = 0;
1.987 raeburn 8448: my $numremref = 0;
8449: my $numinvalid = 0;
8450: my $numpathchg = 0;
8451: my $numexisting = 0;
8452: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath);
1.984 raeburn 8453: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
8454: my $current_path='/';
8455: if ($env{'form.currentpath'}) {
8456: $current_path = $env{'form.currentpath'};
8457: }
8458: if ($actionurl eq '/adm/coursegrp_portfolio') {
8459: $udom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8460: $uname = $env{'course.'.$env{'request.course.id'}.'.num'};
8461: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
8462: } else {
8463: $udom = $env{'user.domain'};
8464: $uname = $env{'user.name'};
8465: $url = '/userfiles/portfolio';
8466: }
1.987 raeburn 8467: $toplevel = $url.'/';
1.984 raeburn 8468: $url .= $current_path;
8469: $getpropath = 1;
1.987 raeburn 8470: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
8471: ($actionurl eq '/adm/imsimport')) {
1.1022 www 8472: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026 raeburn 8473: $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987 raeburn 8474: $toplevel = $url;
1.984 raeburn 8475: if ($rest ne '') {
1.987 raeburn 8476: $url .= $rest;
8477: }
8478: } elsif ($actionurl eq '/adm/coursedocs') {
8479: if (ref($args) eq 'HASH') {
8480: $url = $args->{'docs_url'};
8481: $toplevel = $url;
8482: }
8483: }
8484: my $now = time();
8485: foreach my $embed_file (keys(%{$allfiles})) {
8486: my $absolutepath;
8487: if ($embed_file =~ m{^\w+://}) {
8488: $newfiles{$embed_file} = 1;
8489: $mapping{$embed_file} = $embed_file;
8490: } else {
8491: if ($embed_file =~ m{^/}) {
8492: $absolutepath = $embed_file;
8493: $embed_file =~ s{^(/+)}{};
8494: }
8495: if ($embed_file =~ m{/}) {
8496: my ($path,$fname) = ($embed_file =~ m{^(.+)/([^/]*)$});
8497: $path = &check_for_traversal($path,$url,$toplevel);
8498: my $item = $fname;
8499: if ($path ne '') {
8500: $item = $path.'/'.$fname;
8501: $subdependencies{$path}{$fname} = 1;
8502: } else {
8503: $dependencies{$item} = 1;
8504: }
8505: if ($absolutepath) {
8506: $mapping{$item} = $absolutepath;
8507: } else {
8508: $mapping{$item} = $embed_file;
8509: }
8510: } else {
8511: $dependencies{$embed_file} = 1;
8512: if ($absolutepath) {
8513: $mapping{$embed_file} = $absolutepath;
8514: } else {
8515: $mapping{$embed_file} = $embed_file;
8516: }
8517: }
1.984 raeburn 8518: }
8519: }
8520: foreach my $path (keys(%subdependencies)) {
8521: my %currsubfile;
8522: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 8523: my ($sublistref,$listerror) =
8524: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
8525: if (ref($sublistref) eq 'ARRAY') {
8526: foreach my $line (@{$sublistref}) {
8527: my ($file_name,$rest) = split(/\&/,$line,2);
8528: $currsubfile{$file_name} = 1;
8529: }
1.984 raeburn 8530: }
1.987 raeburn 8531: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 8532: if (opendir(my $dir,$url.'/'.$path)) {
8533: my @subdir_list = grep(!/^\./,readdir($dir));
8534: map {$currsubfile{$_} = 1;} @subdir_list;
8535: }
8536: }
8537: foreach my $file (keys(%{$subdependencies{$path}})) {
1.987 raeburn 8538: if ($currsubfile{$file}) {
8539: my $item = $path.'/'.$file;
8540: unless ($mapping{$item} eq $item) {
8541: $pathchanges{$item} = 1;
8542: }
8543: $existing{$item} = 1;
8544: $numexisting ++;
8545: } else {
8546: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 8547: }
8548: }
8549: }
1.987 raeburn 8550: my %currfile;
1.984 raeburn 8551: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 8552: my ($dirlistref,$listerror) =
8553: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
8554: if (ref($dirlistref) eq 'ARRAY') {
8555: foreach my $line (@{$dirlistref}) {
8556: my ($file_name,$rest) = split(/\&/,$line,2);
8557: $currfile{$file_name} = 1;
8558: }
1.984 raeburn 8559: }
1.987 raeburn 8560: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 8561: if (opendir(my $dir,$url)) {
1.987 raeburn 8562: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 8563: map {$currfile{$_} = 1;} @dir_list;
8564: }
8565: }
8566: foreach my $file (keys(%dependencies)) {
1.987 raeburn 8567: if ($currfile{$file}) {
8568: unless ($mapping{$file} eq $file) {
8569: $pathchanges{$file} = 1;
8570: }
8571: $existing{$file} = 1;
8572: $numexisting ++;
8573: } else {
1.984 raeburn 8574: $newfiles{$file} = 1;
8575: }
8576: }
8577: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.660 raeburn 8578: $upload_output .= &start_data_table_row().
1.987 raeburn 8579: '<td><span class="LC_filename">'.$embed_file.'</span>';
8580: unless ($mapping{$embed_file} eq $embed_file) {
8581: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.&mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
8582: }
8583: $upload_output .= '</td><td>';
1.660 raeburn 8584: if ($args->{'ignore_remote_references'}
8585: && $embed_file =~ m{^\w+://}) {
8586: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
1.987 raeburn 8587: $numremref++;
1.660 raeburn 8588: } elsif ($args->{'error_on_invalid_names'}
8589: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
8590:
1.987 raeburn 8591: $upload_output.='<span class="LC_warning">'.&mt('Invalid characters').'</span>';
8592: $numinvalid++;
1.660 raeburn 8593: } else {
1.987 raeburn 8594: $upload_output .= &embedded_file_element('upload_embedded',$num,
8595: $embed_file,\%mapping,
8596: $allfiles,$codebase);
8597: $num++;
8598: }
8599: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
8600: }
8601: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
8602: $upload_output .= &start_data_table_row().
8603: '<td><span class="LC_filename">'.$embed_file.'</span></td>'.
8604: '<td><span class="LC_warning">'.&mt('Already exists').'</span></td>'.
8605: &Apache::loncommon::end_data_table_row()."\n";
8606: }
8607: if ($upload_output) {
8608: $upload_output = &start_data_table().
8609: $upload_output.
8610: &end_data_table()."\n";
8611: }
8612: my $applies = 0;
8613: if ($numremref) {
8614: $applies ++;
8615: }
8616: if ($numinvalid) {
8617: $applies ++;
8618: }
8619: if ($numexisting) {
8620: $applies ++;
8621: }
8622: if ($num) {
8623: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
8624: ' method="post" enctype="multipart/form-data">'."\n".
8625: $state.
8626: '<h3>'.&mt('Upload embedded files').
8627: ':</h3>'.$upload_output.'<br />'."\n".
8628: '<input type ="hidden" name="number_embedded_items" value="'.
8629: $num.'" />'."\n";
8630: if ($actionurl eq '') {
8631: $output .= '<input type="hidden" name="phase" value="three" />';
8632: }
8633: } elsif ($applies) {
8634: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
8635: if ($applies > 1) {
8636: $output .=
8637: &mt('No files need to be uploaded, as one of the following applies to each reference:').'<ul>';
8638: if ($numremref) {
8639: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
8640: }
8641: if ($numinvalid) {
8642: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
8643: }
8644: if ($numexisting) {
8645: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
8646: }
8647: $output .= '</ul><br />';
8648: } elsif ($numremref) {
8649: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
8650: } elsif ($numinvalid) {
8651: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
8652: } elsif ($numexisting) {
8653: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
8654: }
8655: $output .= $upload_output.'<br />';
8656: }
8657: my ($pathchange_output,$chgcount);
8658: $chgcount = $num;
8659: if (keys(%pathchanges) > 0) {
8660: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
8661: if ($num) {
8662: $output .= &embedded_file_element('pathchange',$chgcount,
8663: $embed_file,\%mapping,
8664: $allfiles,$codebase);
8665: } else {
8666: $pathchange_output .=
8667: &start_data_table_row().
8668: '<td><input type ="checkbox" name="namechange" value="'.
8669: $chgcount.'" checked="checked" /></td>'.
8670: '<td>'.$mapping{$embed_file}.'</td>'.
8671: '<td>'.$embed_file.
8672: &embedded_file_element('pathchange',$numpathchg,$embed_file,
8673: \%mapping,$allfiles,$codebase).
8674: '</td>'.&end_data_table_row();
1.660 raeburn 8675: }
1.987 raeburn 8676: $numpathchg ++;
8677: $chgcount ++;
1.660 raeburn 8678: }
8679: }
1.984 raeburn 8680: if ($num) {
1.987 raeburn 8681: if ($numpathchg) {
8682: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
8683: $numpathchg.'" />'."\n";
8684: }
8685: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
8686: ($actionurl eq '/adm/imsimport')) {
8687: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
8688: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
8689: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
8690: }
8691: $output .= '<input type ="submit" value="'.&mt('Upload Listed Files').'" />'."\n".
8692: &mt('(only files for which a location has been provided will be uploaded)').'</form>'."\n";
8693: } elsif ($numpathchg) {
8694: my %pathchange = ();
8695: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
8696: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
8697: $output .= '<p>'.&mt('or').'</p>';
8698: }
8699: }
8700: return ($output,$num,$numpathchg);
8701: }
8702:
8703: sub embedded_file_element {
8704: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase) = @_;
8705: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
8706: (ref($codebase) eq 'HASH'));
8707: my $output;
8708: if ($context eq 'upload_embedded') {
8709: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
8710: }
8711: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
8712: &escape($embed_file).'" />';
8713: unless (($context eq 'upload_embedded') &&
8714: ($mapping->{$embed_file} eq $embed_file)) {
8715: $output .='
8716: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
8717: }
8718: my $attrib;
8719: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
8720: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
8721: }
8722: $output .=
8723: "\n\t\t".
8724: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
8725: $attrib.'" />';
8726: if (exists($codebase->{$mapping->{$embed_file}})) {
8727: $output .=
8728: "\n\t\t".
8729: '<input name="codebase_'.$num.'" type="hidden" value="'.
8730: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 8731: }
1.987 raeburn 8732: return $output;
1.660 raeburn 8733: }
8734:
1.661 raeburn 8735: sub upload_embedded {
8736: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 8737: $current_disk_usage,$hiddenstate,$actionurl) = @_;
8738: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 8739: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
8740: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
8741: my $orig_uploaded_filename =
8742: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 8743: foreach my $type ('orig','ref','attrib','codebase') {
8744: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
8745: $env{'form.embedded_'.$type.'_'.$i} =
8746: &unescape($env{'form.embedded_'.$type.'_'.$i});
8747: }
8748: }
1.661 raeburn 8749: my ($path,$fname) =
8750: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
8751: # no path, whole string is fname
8752: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
8753: $fname = &Apache::lonnet::clean_filename($fname);
8754: # See if there is anything left
8755: next if ($fname eq '');
8756:
8757: # Check if file already exists as a file or directory.
8758: my ($state,$msg);
8759: if ($context eq 'portfolio') {
8760: my $port_path = $dirpath;
8761: if ($group ne '') {
8762: $port_path = "groups/$group/$port_path";
8763: }
1.987 raeburn 8764: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
8765: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 8766: $dir_root,$port_path,$disk_quota,
8767: $current_disk_usage,$uname,$udom);
8768: if ($state eq 'will_exceed_quota'
1.984 raeburn 8769: || $state eq 'file_locked') {
1.661 raeburn 8770: $output .= $msg;
8771: next;
8772: }
8773: } elsif (($context eq 'author') || ($context eq 'testbank')) {
8774: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
8775: if ($state eq 'exists') {
8776: $output .= $msg;
8777: next;
8778: }
8779: }
8780: # Check if extension is valid
8781: if (($fname =~ /\.(\w+)$/) &&
8782: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.987 raeburn 8783: $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 8784: next;
8785: } elsif (($fname =~ /\.(\w+)$/) &&
8786: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 8787: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 8788: next;
8789: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.987 raeburn 8790: $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 8791: next;
8792: }
8793:
8794: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
8795: if ($context eq 'portfolio') {
1.984 raeburn 8796: my $result;
8797: if ($state eq 'existingfile') {
8798: $result=
8799: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.987 raeburn 8800: $dirpath.$env{'form.currentpath'}.$path);
1.661 raeburn 8801: } else {
1.984 raeburn 8802: $result=
8803: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 8804: $dirpath.
8805: $env{'form.currentpath'}.$path);
1.984 raeburn 8806: if ($result !~ m|^/uploaded/|) {
8807: $output .= '<span class="LC_error">'
8808: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
8809: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
8810: .'</span><br />';
8811: next;
8812: } else {
1.987 raeburn 8813: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
8814: $path.$fname.'</span>').'<br />';
1.984 raeburn 8815: }
1.661 raeburn 8816: }
1.987 raeburn 8817: } elsif ($context eq 'coursedoc') {
8818: my $result =
8819: &Apache::lonnet::userfileupload('embedded_item_'.$i,'coursedoc',
8820: $dirpath.'/'.$path);
8821: if ($result !~ m|^/uploaded/|) {
8822: $output .= '<span class="LC_error">'
8823: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
8824: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
8825: .'</span><br />';
8826: next;
8827: } else {
8828: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
8829: $path.$fname.'</span>').'<br />';
8830: }
1.661 raeburn 8831: } else {
8832: # Save the file
8833: my $target = $env{'form.embedded_item_'.$i};
8834: my $fullpath = $dir_root.$dirpath.'/'.$path;
8835: my $dest = $fullpath.$fname;
8836: my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027 raeburn 8837: my @parts=split(/\//,"$dirpath/$path");
1.661 raeburn 8838: my $count;
8839: my $filepath = $dir_root;
1.1027 raeburn 8840: foreach my $subdir (@parts) {
8841: $filepath .= "/$subdir";
8842: if (!-e $filepath) {
1.661 raeburn 8843: mkdir($filepath,0770);
8844: }
8845: }
8846: my $fh;
8847: if (!open($fh,'>'.$dest)) {
8848: &Apache::lonnet::logthis('Failed to create '.$dest);
8849: $output .= '<span class="LC_error">'.
8850: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8851: '</span><br />';
8852: } else {
8853: if (!print $fh $env{'form.embedded_item_'.$i}) {
8854: &Apache::lonnet::logthis('Failed to write to '.$dest);
8855: $output .= '<span class="LC_error">'.
8856: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8857: '</span><br />';
8858: } else {
1.987 raeburn 8859: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
8860: $url.'</span>').'<br />';
8861: unless ($context eq 'testbank') {
8862: $footer .= &mt('View embedded file: [_1]',
8863: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
8864: }
8865: }
8866: close($fh);
8867: }
8868: }
8869: if ($env{'form.embedded_ref_'.$i}) {
8870: $pathchange{$i} = 1;
8871: }
8872: }
8873: if ($output) {
8874: $output = '<p>'.$output.'</p>';
8875: }
8876: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
8877: $returnflag = 'ok';
8878: if (keys(%pathchange) > 0) {
8879: if ($context eq 'portfolio') {
8880: $output .= '<p>'.&mt('or').'</p>';
8881: } elsif ($context eq 'testbank') {
1.988 raeburn 8882: $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 8883: $returnflag = 'modify_orightml';
8884: }
8885: }
8886: return ($output.$footer,$returnflag);
8887: }
8888:
8889: sub modify_html_form {
8890: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
8891: my $end = 0;
8892: my $modifyform;
8893: if ($context eq 'upload_embedded') {
8894: return unless (ref($pathchange) eq 'HASH');
8895: if ($env{'form.number_embedded_items'}) {
8896: $end += $env{'form.number_embedded_items'};
8897: }
8898: if ($env{'form.number_pathchange_items'}) {
8899: $end += $env{'form.number_pathchange_items'};
8900: }
8901: if ($end) {
8902: for (my $i=0; $i<$end; $i++) {
8903: if ($i < $env{'form.number_embedded_items'}) {
8904: next unless($pathchange->{$i});
8905: }
8906: $modifyform .=
8907: &start_data_table_row().
8908: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
8909: 'checked="checked" /></td>'.
8910: '<td>'.$env{'form.embedded_ref_'.$i}.
8911: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
8912: &escape($env{'form.embedded_ref_'.$i}).'" />'.
8913: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
8914: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
8915: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
8916: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
8917: '<td>'.$env{'form.embedded_orig_'.$i}.
8918: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
8919: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
8920: &end_data_table_row();
8921: }
8922: }
8923: } else {
8924: $modifyform = $pathchgtable;
8925: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
8926: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
8927: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
8928: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
8929: }
8930: }
8931: if ($modifyform) {
8932: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
8933: '<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".
8934: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
8935: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
8936: '</ol></p>'."\n".'<p>'.
8937: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
8938: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
8939: &start_data_table()."\n".
8940: &start_data_table_header_row().
8941: '<th>'.&mt('Change?').'</th>'.
8942: '<th>'.&mt('Current reference').'</th>'.
8943: '<th>'.&mt('Required reference').'</th>'.
8944: &end_data_table_header_row()."\n".
8945: $modifyform.
8946: &end_data_table().'<br />'."\n".$hiddenstate.
8947: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
8948: '</form>'."\n";
8949: }
8950: return;
8951: }
8952:
8953: sub modify_html_refs {
8954: my ($context,$dirpath,$uname,$udom,$dir_root) = @_;
8955: my $container;
8956: if ($context eq 'portfolio') {
8957: $container = $env{'form.container'};
8958: } elsif ($context eq 'coursedoc') {
8959: $container = $env{'form.primaryurl'};
8960: } else {
1.1027 raeburn 8961: $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987 raeburn 8962: }
8963: my (%allfiles,%codebase,$output,$content);
8964: my @changes = &get_env_multiple('form.namechange');
8965: return unless (@changes > 0);
8966: if (($context eq 'portfolio') || ($context eq 'coursedoc')) {
8967: return unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/});
8968: $content = &Apache::lonnet::getfile($container);
8969: return if ($content eq '-1');
8970: } else {
8971: return unless ($container =~ /^\Q$dir_root\E/);
8972: if (open(my $fh,"<$container")) {
8973: $content = join('', <$fh>);
8974: close($fh);
8975: } else {
8976: return;
8977: }
8978: }
8979: my ($count,$codebasecount) = (0,0);
8980: my $mm = new File::MMagic;
8981: my $mime_type = $mm->checktype_contents($content);
8982: if ($mime_type eq 'text/html') {
8983: my $parse_result =
8984: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
8985: \%codebase,\$content);
8986: if ($parse_result eq 'ok') {
8987: foreach my $i (@changes) {
8988: my $orig = &unescape($env{'form.embedded_orig_'.$i});
8989: my $ref = &unescape($env{'form.embedded_ref_'.$i});
8990: if ($allfiles{$ref}) {
8991: my $newname = $orig;
8992: my ($attrib_regexp,$codebase);
1.1006 raeburn 8993: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 8994: if ($attrib_regexp =~ /:/) {
8995: $attrib_regexp =~ s/\:/|/g;
8996: }
8997: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
8998: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
8999: $count += $numchg;
9000: }
9001: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 9002: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 9003: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
9004: $codebasecount ++;
9005: }
9006: }
9007: }
9008: if ($count || $codebasecount) {
9009: my $saveresult;
9010: if ($context eq 'portfolio' || $context eq 'coursedoc') {
9011: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
9012: if ($url eq $container) {
9013: my ($fname) = ($container =~ m{/([^/]+)$});
9014: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
9015: $count,'<span class="LC_filename">'.
9016: $fname.'</span>').'</p>';
9017: } else {
9018: $output = '<p class="LC_error">'.
9019: &mt('Error: update failed for: [_1].',
9020: '<span class="LC_filename">'.
9021: $container.'</span>').'</p>';
9022: }
9023: } else {
9024: if (open(my $fh,">$container")) {
9025: print $fh $content;
9026: close($fh);
9027: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
9028: $count,'<span class="LC_filename">'.
9029: $container.'</span>').'</p>';
1.661 raeburn 9030: } else {
1.987 raeburn 9031: $output = '<p class="LC_error">'.
9032: &mt('Error: could not update [_1].',
9033: '<span class="LC_filename">'.
9034: $container.'</span>').'</p>';
1.661 raeburn 9035: }
9036: }
9037: }
1.987 raeburn 9038: } else {
9039: &logthis('Failed to parse '.$container.
9040: ' to modify references: '.$parse_result);
1.661 raeburn 9041: }
9042: }
9043: return $output;
9044: }
9045:
9046: sub check_for_existing {
9047: my ($path,$fname,$element) = @_;
9048: my ($state,$msg);
9049: if (-d $path.'/'.$fname) {
9050: $state = 'exists';
9051: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
9052: } elsif (-e $path.'/'.$fname) {
9053: $state = 'exists';
9054: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
9055: }
9056: if ($state eq 'exists') {
9057: $msg = '<span class="LC_error">'.$msg.'</span><br />';
9058: }
9059: return ($state,$msg);
9060: }
9061:
9062: sub check_for_upload {
9063: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
9064: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 9065: my $filesize = length($env{'form.'.$element});
9066: if (!$filesize) {
9067: my $msg = '<span class="LC_error">'.
9068: &mt('Unable to upload [_1]. (size = [_2] bytes)',
9069: '<span class="LC_filename">'.$fname.'</span>',
9070: $filesize).'<br />'.
1.1007 raeburn 9071: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 9072: '</span>';
9073: return ('zero_bytes',$msg);
9074: }
9075: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 9076: my $getpropath = 1;
1.1021 raeburn 9077: my ($dirlistref,$listerror) =
9078: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 9079: my $found_file = 0;
9080: my $locked_file = 0;
1.991 raeburn 9081: my @lockers;
9082: my $navmap;
9083: if ($env{'request.course.id'}) {
9084: $navmap = Apache::lonnavmaps::navmap->new();
9085: }
1.1021 raeburn 9086: if (ref($dirlistref) eq 'ARRAY') {
9087: foreach my $line (@{$dirlistref}) {
9088: my ($file_name,$rest)=split(/\&/,$line,2);
9089: if ($file_name eq $fname){
9090: $file_name = $path.$file_name;
9091: if ($group ne '') {
9092: $file_name = $group.$file_name;
9093: }
9094: $found_file = 1;
9095: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
9096: foreach my $lock (@lockers) {
9097: if (ref($lock) eq 'ARRAY') {
9098: my ($symb,$crsid) = @{$lock};
9099: if ($crsid eq $env{'request.course.id'}) {
9100: if (ref($navmap)) {
9101: my $res = $navmap->getBySymb($symb);
9102: foreach my $part (@{$res->parts()}) {
9103: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
9104: unless (($slot_status == $res->RESERVED) ||
9105: ($slot_status == $res->RESERVED_LOCATION)) {
9106: $locked_file = 1;
9107: }
1.991 raeburn 9108: }
1.1021 raeburn 9109: } else {
9110: $locked_file = 1;
1.991 raeburn 9111: }
9112: } else {
9113: $locked_file = 1;
9114: }
9115: }
1.1021 raeburn 9116: }
9117: } else {
9118: my @info = split(/\&/,$rest);
9119: my $currsize = $info[6]/1000;
9120: if ($currsize < $filesize) {
9121: my $extra = $filesize - $currsize;
9122: if (($current_disk_usage + $extra) > $disk_quota) {
9123: my $msg = '<span class="LC_error">'.
9124: &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.',
9125: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</span>'.
9126: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
9127: $disk_quota,$current_disk_usage);
9128: return ('will_exceed_quota',$msg);
9129: }
1.984 raeburn 9130: }
9131: }
1.661 raeburn 9132: }
9133: }
9134: }
9135: if (($current_disk_usage + $filesize) > $disk_quota){
9136: my $msg = '<span class="LC_error">'.
9137: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
9138: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
9139: return ('will_exceed_quota',$msg);
9140: } elsif ($found_file) {
9141: if ($locked_file) {
9142: my $msg = '<span class="LC_error">';
9143: $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>');
9144: $msg .= '</span><br />';
9145: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
9146: return ('file_locked',$msg);
9147: } else {
9148: my $msg = '<span class="LC_error">';
1.984 raeburn 9149: $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 9150: $msg .= '</span>';
1.984 raeburn 9151: return ('existingfile',$msg);
1.661 raeburn 9152: }
9153: }
9154: }
9155:
1.987 raeburn 9156: sub check_for_traversal {
9157: my ($path,$url,$toplevel) = @_;
9158: my @parts=split(/\//,$path);
9159: my $cleanpath;
9160: my $fullpath = $url;
9161: for (my $i=0;$i<@parts;$i++) {
9162: next if ($parts[$i] eq '.');
9163: if ($parts[$i] eq '..') {
9164: $fullpath =~ s{([^/]+/)$}{};
9165: } else {
9166: $fullpath .= $parts[$i].'/';
9167: }
9168: }
9169: if ($fullpath =~ /^\Q$url\E(.*)$/) {
9170: $cleanpath = $1;
9171: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
9172: my $curr_toprel = $1;
9173: my @parts = split(/\//,$curr_toprel);
9174: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
9175: my @urlparts = split(/\//,$url_toprel);
9176: my $doubledots;
9177: my $startdiff = -1;
9178: for (my $i=0; $i<@urlparts; $i++) {
9179: if ($startdiff == -1) {
9180: unless ($urlparts[$i] eq $parts[$i]) {
9181: $startdiff = $i;
9182: $doubledots .= '../';
9183: }
9184: } else {
9185: $doubledots .= '../';
9186: }
9187: }
9188: if ($startdiff > -1) {
9189: $cleanpath = $doubledots;
9190: for (my $i=$startdiff; $i<@parts; $i++) {
9191: $cleanpath .= $parts[$i].'/';
9192: }
9193: }
9194: }
9195: $cleanpath =~ s{(/)$}{};
9196: return $cleanpath;
9197: }
1.31 albertel 9198:
1.41 ng 9199: =pod
1.45 matthew 9200:
1.1015 raeburn 9201: =item * &get_turnedin_filepath()
9202:
9203: Determines path in a user's portfolio file for storage of files uploaded
9204: to a specific essayresponse or dropbox item.
9205:
9206: Inputs: 3 required + 1 optional.
9207: $symb is symb for resource, $uname and $udom are for current user (required).
9208: $caller is optional (can be "submission", if routine is called when storing
9209: an upoaded file when "Submit Answer" button was pressed).
9210:
9211: Returns array containing $path and $multiresp.
9212: $path is path in portfolio. $multiresp is 1 if this resource contains more
9213: than one file upload item. Callers of routine should append partid as a
9214: subdirectory to $path in cases where $multiresp is 1.
9215:
9216: Called by: homework/essayresponse.pm and homework/structuretags.pm
9217:
9218: =cut
9219:
9220: sub get_turnedin_filepath {
9221: my ($symb,$uname,$udom,$caller) = @_;
9222: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
9223: my $turnindir;
9224: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
9225: $turnindir = $userhash{'turnindir'};
9226: my ($path,$multiresp);
9227: if ($turnindir eq '') {
9228: if ($caller eq 'submission') {
9229: $turnindir = &mt('turned in');
9230: $turnindir =~ s/\W+/_/g;
9231: my %newhash = (
9232: 'turnindir' => $turnindir,
9233: );
9234: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
9235: }
9236: }
9237: if ($turnindir ne '') {
9238: $path = '/'.$turnindir.'/';
9239: my ($multipart,$turnin,@pathitems);
9240: my $navmap = Apache::lonnavmaps::navmap->new();
9241: if (defined($navmap)) {
9242: my $mapres = $navmap->getResourceByUrl($map);
9243: if (ref($mapres)) {
9244: my $pcslist = $mapres->map_hierarchy();
9245: if ($pcslist ne '') {
9246: foreach my $pc (split(/,/,$pcslist)) {
9247: my $res = $navmap->getByMapPc($pc);
9248: if (ref($res)) {
9249: my $title = $res->compTitle();
9250: $title =~ s/\W+/_/g;
9251: if ($title ne '') {
9252: push(@pathitems,$title);
9253: }
9254: }
9255: }
9256: }
9257: my $maptitle = $mapres->compTitle();
9258: $maptitle =~ s/\W+/_/g;
9259: if ($maptitle ne '') {
9260: push(@pathitems,$maptitle);
9261: }
9262: unless ($env{'request.state'} eq 'construct') {
9263: my $res = $navmap->getBySymb($symb);
9264: if (ref($res)) {
9265: my $partlist = $res->parts();
9266: my $totaluploads = 0;
9267: if (ref($partlist) eq 'ARRAY') {
9268: foreach my $part (@{$partlist}) {
9269: my @types = $res->responseType($part);
9270: my @ids = $res->responseIds($part);
9271: for (my $i=0; $i < scalar(@ids); $i++) {
9272: if ($types[$i] eq 'essay') {
9273: my $partid = $part.'_'.$ids[$i];
9274: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
9275: $totaluploads ++;
9276: }
9277: }
9278: }
9279: }
9280: if ($totaluploads > 1) {
9281: $multiresp = 1;
9282: }
9283: }
9284: }
9285: }
9286: } else {
9287: return;
9288: }
9289: } else {
9290: return;
9291: }
9292: my $restitle=&Apache::lonnet::gettitle($symb);
9293: $restitle =~ s/\W+/_/g;
9294: if ($restitle eq '') {
9295: $restitle = ($resurl =~ m{/[^/]+$});
9296: if ($restitle eq '') {
9297: $restitle = time;
9298: }
9299: }
9300: push(@pathitems,$restitle);
9301: $path .= join('/',@pathitems);
9302: }
9303: return ($path,$multiresp);
9304: }
9305:
9306: =pod
9307:
1.464 albertel 9308: =back
1.41 ng 9309:
1.112 bowersj2 9310: =head1 CSV Upload/Handling functions
1.38 albertel 9311:
1.41 ng 9312: =over 4
9313:
1.648 raeburn 9314: =item * &upfile_store($r)
1.41 ng 9315:
9316: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 9317: needs $env{'form.upfile'}
1.41 ng 9318: returns $datatoken to be put into hidden field
9319:
9320: =cut
1.31 albertel 9321:
9322: sub upfile_store {
9323: my $r=shift;
1.258 albertel 9324: $env{'form.upfile'}=~s/\r/\n/gs;
9325: $env{'form.upfile'}=~s/\f/\n/gs;
9326: $env{'form.upfile'}=~s/\n+/\n/gs;
9327: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 9328:
1.258 albertel 9329: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
9330: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 9331: {
1.158 raeburn 9332: my $datafile = $r->dir_config('lonDaemons').
9333: '/tmp/'.$datatoken.'.tmp';
9334: if ( open(my $fh,">$datafile") ) {
1.258 albertel 9335: print $fh $env{'form.upfile'};
1.158 raeburn 9336: close($fh);
9337: }
1.31 albertel 9338: }
9339: return $datatoken;
9340: }
9341:
1.56 matthew 9342: =pod
9343:
1.648 raeburn 9344: =item * &load_tmp_file($r)
1.41 ng 9345:
9346: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 9347: needs $env{'form.datatoken'},
9348: sets $env{'form.upfile'} to the contents of the file
1.41 ng 9349:
9350: =cut
1.31 albertel 9351:
9352: sub load_tmp_file {
9353: my $r=shift;
9354: my @studentdata=();
9355: {
1.158 raeburn 9356: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 9357: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 9358: if ( open(my $fh,"<$studentfile") ) {
9359: @studentdata=<$fh>;
9360: close($fh);
9361: }
1.31 albertel 9362: }
1.258 albertel 9363: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 9364: }
9365:
1.56 matthew 9366: =pod
9367:
1.648 raeburn 9368: =item * &upfile_record_sep()
1.41 ng 9369:
9370: Separate uploaded file into records
9371: returns array of records,
1.258 albertel 9372: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 9373:
9374: =cut
1.31 albertel 9375:
9376: sub upfile_record_sep {
1.258 albertel 9377: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 9378: } else {
1.248 albertel 9379: my @records;
1.258 albertel 9380: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 9381: if ($line=~/^\s*$/) { next; }
9382: push(@records,$line);
9383: }
9384: return @records;
1.31 albertel 9385: }
9386: }
9387:
1.56 matthew 9388: =pod
9389:
1.648 raeburn 9390: =item * &record_sep($record)
1.41 ng 9391:
1.258 albertel 9392: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 9393:
9394: =cut
9395:
1.263 www 9396: sub takeleft {
9397: my $index=shift;
9398: return substr('0000'.$index,-4,4);
9399: }
9400:
1.31 albertel 9401: sub record_sep {
9402: my $record=shift;
9403: my %components=();
1.258 albertel 9404: if ($env{'form.upfiletype'} eq 'xml') {
9405: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 9406: my $i=0;
1.356 albertel 9407: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 9408: $field=~s/^(\"|\')//;
9409: $field=~s/(\"|\')$//;
1.263 www 9410: $components{&takeleft($i)}=$field;
1.31 albertel 9411: $i++;
9412: }
1.258 albertel 9413: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 9414: my $i=0;
1.356 albertel 9415: foreach my $field (split(/\t/,$record)) {
1.31 albertel 9416: $field=~s/^(\"|\')//;
9417: $field=~s/(\"|\')$//;
1.263 www 9418: $components{&takeleft($i)}=$field;
1.31 albertel 9419: $i++;
9420: }
9421: } else {
1.561 www 9422: my $separator=',';
1.480 banghart 9423: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 9424: $separator=';';
1.480 banghart 9425: }
1.31 albertel 9426: my $i=0;
1.561 www 9427: # the character we are looking for to indicate the end of a quote or a record
9428: my $looking_for=$separator;
9429: # do not add the characters to the fields
9430: my $ignore=0;
9431: # we just encountered a separator (or the beginning of the record)
9432: my $just_found_separator=1;
9433: # store the field we are working on here
9434: my $field='';
9435: # work our way through all characters in record
9436: foreach my $character ($record=~/(.)/g) {
9437: if ($character eq $looking_for) {
9438: if ($character ne $separator) {
9439: # Found the end of a quote, again looking for separator
9440: $looking_for=$separator;
9441: $ignore=1;
9442: } else {
9443: # Found a separator, store away what we got
9444: $components{&takeleft($i)}=$field;
9445: $i++;
9446: $just_found_separator=1;
9447: $ignore=0;
9448: $field='';
9449: }
9450: next;
9451: }
9452: # single or double quotation marks after a separator indicate beginning of a quote
9453: # we are now looking for the end of the quote and need to ignore separators
9454: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
9455: $looking_for=$character;
9456: next;
9457: }
9458: # ignore would be true after we reached the end of a quote
9459: if ($ignore) { next; }
9460: if (($just_found_separator) && ($character=~/\s/)) { next; }
9461: $field.=$character;
9462: $just_found_separator=0;
1.31 albertel 9463: }
1.561 www 9464: # catch the very last entry, since we never encountered the separator
9465: $components{&takeleft($i)}=$field;
1.31 albertel 9466: }
9467: return %components;
9468: }
9469:
1.144 matthew 9470: ######################################################
9471: ######################################################
9472:
1.56 matthew 9473: =pod
9474:
1.648 raeburn 9475: =item * &upfile_select_html()
1.41 ng 9476:
1.144 matthew 9477: Return HTML code to select a file from the users machine and specify
9478: the file type.
1.41 ng 9479:
9480: =cut
9481:
1.144 matthew 9482: ######################################################
9483: ######################################################
1.31 albertel 9484: sub upfile_select_html {
1.144 matthew 9485: my %Types = (
9486: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 9487: semisv => &mt('Semicolon separated values'),
1.144 matthew 9488: space => &mt('Space separated'),
9489: tab => &mt('Tabulator separated'),
9490: # xml => &mt('HTML/XML'),
9491: );
9492: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 9493: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 9494: foreach my $type (sort(keys(%Types))) {
9495: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
9496: }
9497: $Str .= "</select>\n";
9498: return $Str;
1.31 albertel 9499: }
9500:
1.301 albertel 9501: sub get_samples {
9502: my ($records,$toget) = @_;
9503: my @samples=({});
9504: my $got=0;
9505: foreach my $rec (@$records) {
9506: my %temp = &record_sep($rec);
9507: if (! grep(/\S/, values(%temp))) { next; }
9508: if (%temp) {
9509: $samples[$got]=\%temp;
9510: $got++;
9511: if ($got == $toget) { last; }
9512: }
9513: }
9514: return \@samples;
9515: }
9516:
1.144 matthew 9517: ######################################################
9518: ######################################################
9519:
1.56 matthew 9520: =pod
9521:
1.648 raeburn 9522: =item * &csv_print_samples($r,$records)
1.41 ng 9523:
9524: Prints a table of sample values from each column uploaded $r is an
9525: Apache Request ref, $records is an arrayref from
9526: &Apache::loncommon::upfile_record_sep
9527:
9528: =cut
9529:
1.144 matthew 9530: ######################################################
9531: ######################################################
1.31 albertel 9532: sub csv_print_samples {
9533: my ($r,$records) = @_;
1.662 bisitz 9534: my $samples = &get_samples($records,5);
1.301 albertel 9535:
1.594 raeburn 9536: $r->print(&mt('Samples').'<br />'.&start_data_table().
9537: &start_data_table_header_row());
1.356 albertel 9538: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 9539: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 9540: $r->print(&end_data_table_header_row());
1.301 albertel 9541: foreach my $hash (@$samples) {
1.594 raeburn 9542: $r->print(&start_data_table_row());
1.356 albertel 9543: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 9544: $r->print('<td>');
1.356 albertel 9545: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 9546: $r->print('</td>');
9547: }
1.594 raeburn 9548: $r->print(&end_data_table_row());
1.31 albertel 9549: }
1.594 raeburn 9550: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 9551: }
9552:
1.144 matthew 9553: ######################################################
9554: ######################################################
9555:
1.56 matthew 9556: =pod
9557:
1.648 raeburn 9558: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 9559:
9560: Prints a table to create associations between values and table columns.
1.144 matthew 9561:
1.41 ng 9562: $r is an Apache Request ref,
9563: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 9564: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 9565:
9566: =cut
9567:
1.144 matthew 9568: ######################################################
9569: ######################################################
1.31 albertel 9570: sub csv_print_select_table {
9571: my ($r,$records,$d) = @_;
1.301 albertel 9572: my $i=0;
9573: my $samples = &get_samples($records,1);
1.144 matthew 9574: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 9575: &start_data_table().&start_data_table_header_row().
1.144 matthew 9576: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 9577: '<th>'.&mt('Column').'</th>'.
9578: &end_data_table_header_row()."\n");
1.356 albertel 9579: foreach my $array_ref (@$d) {
9580: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 9581: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 9582:
1.875 bisitz 9583: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 9584: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 9585: $r->print('<option value="none"></option>');
1.356 albertel 9586: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
9587: $r->print('<option value="'.$sample.'"'.
9588: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 9589: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 9590: }
1.594 raeburn 9591: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 9592: $i++;
9593: }
1.594 raeburn 9594: $r->print(&end_data_table());
1.31 albertel 9595: $i--;
9596: return $i;
9597: }
1.56 matthew 9598:
1.144 matthew 9599: ######################################################
9600: ######################################################
9601:
1.56 matthew 9602: =pod
1.31 albertel 9603:
1.648 raeburn 9604: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 9605:
9606: Prints a table of sample values from the upload and can make associate samples to internal names.
9607:
9608: $r is an Apache Request ref,
9609: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
9610: $d is an array of 2 element arrays (internal name, displayed name)
9611:
9612: =cut
9613:
1.144 matthew 9614: ######################################################
9615: ######################################################
1.31 albertel 9616: sub csv_samples_select_table {
9617: my ($r,$records,$d) = @_;
9618: my $i=0;
1.144 matthew 9619: #
1.662 bisitz 9620: my $max_samples = 5;
9621: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 9622: $r->print(&start_data_table().
9623: &start_data_table_header_row().'<th>'.
9624: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
9625: &end_data_table_header_row());
1.301 albertel 9626:
9627: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 9628: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 9629: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 9630: foreach my $option (@$d) {
9631: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 9632: $r->print('<option value="'.$value.'"'.
1.253 albertel 9633: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 9634: $display.'</option>');
1.31 albertel 9635: }
9636: $r->print('</select></td><td>');
1.662 bisitz 9637: foreach my $line (0..($max_samples-1)) {
1.301 albertel 9638: if (defined($samples->[$line]{$key})) {
9639: $r->print($samples->[$line]{$key}."<br />\n");
9640: }
9641: }
1.594 raeburn 9642: $r->print('</td>'.&end_data_table_row());
1.31 albertel 9643: $i++;
9644: }
1.594 raeburn 9645: $r->print(&end_data_table());
1.31 albertel 9646: $i--;
9647: return($i);
1.115 matthew 9648: }
9649:
1.144 matthew 9650: ######################################################
9651: ######################################################
9652:
1.115 matthew 9653: =pod
9654:
1.648 raeburn 9655: =item * &clean_excel_name($name)
1.115 matthew 9656:
9657: Returns a replacement for $name which does not contain any illegal characters.
9658:
9659: =cut
9660:
1.144 matthew 9661: ######################################################
9662: ######################################################
1.115 matthew 9663: sub clean_excel_name {
9664: my ($name) = @_;
9665: $name =~ s/[:\*\?\/\\]//g;
9666: if (length($name) > 31) {
9667: $name = substr($name,0,31);
9668: }
9669: return $name;
1.25 albertel 9670: }
1.84 albertel 9671:
1.85 albertel 9672: =pod
9673:
1.648 raeburn 9674: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 9675:
9676: Returns either 1 or undef
9677:
9678: 1 if the part is to be hidden, undef if it is to be shown
9679:
9680: Arguments are:
9681:
9682: $id the id of the part to be checked
9683: $symb, optional the symb of the resource to check
9684: $udom, optional the domain of the user to check for
9685: $uname, optional the username of the user to check for
9686:
9687: =cut
1.84 albertel 9688:
9689: sub check_if_partid_hidden {
9690: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 9691: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 9692: $symb,$udom,$uname);
1.141 albertel 9693: my $truth=1;
9694: #if the string starts with !, then the list is the list to show not hide
9695: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 9696: my @hiddenlist=split(/,/,$hiddenparts);
9697: foreach my $checkid (@hiddenlist) {
1.141 albertel 9698: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 9699: }
1.141 albertel 9700: return !$truth;
1.84 albertel 9701: }
1.127 matthew 9702:
1.138 matthew 9703:
9704: ############################################################
9705: ############################################################
9706:
9707: =pod
9708:
1.157 matthew 9709: =back
9710:
1.138 matthew 9711: =head1 cgi-bin script and graphing routines
9712:
1.157 matthew 9713: =over 4
9714:
1.648 raeburn 9715: =item * &get_cgi_id()
1.138 matthew 9716:
9717: Inputs: none
9718:
9719: Returns an id which can be used to pass environment variables
9720: to various cgi-bin scripts. These environment variables will
9721: be removed from the users environment after a given time by
9722: the routine &Apache::lonnet::transfer_profile_to_env.
9723:
9724: =cut
9725:
9726: ############################################################
9727: ############################################################
1.152 albertel 9728: my $uniq=0;
1.136 matthew 9729: sub get_cgi_id {
1.154 albertel 9730: $uniq=($uniq+1)%100000;
1.280 albertel 9731: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 9732: }
9733:
1.127 matthew 9734: ############################################################
9735: ############################################################
9736:
9737: =pod
9738:
1.648 raeburn 9739: =item * &DrawBarGraph()
1.127 matthew 9740:
1.138 matthew 9741: Facilitates the plotting of data in a (stacked) bar graph.
9742: Puts plot definition data into the users environment in order for
9743: graph.png to plot it. Returns an <img> tag for the plot.
9744: The bars on the plot are labeled '1','2',...,'n'.
9745:
9746: Inputs:
9747:
9748: =over 4
9749:
9750: =item $Title: string, the title of the plot
9751:
9752: =item $xlabel: string, text describing the X-axis of the plot
9753:
9754: =item $ylabel: string, text describing the Y-axis of the plot
9755:
9756: =item $Max: scalar, the maximum Y value to use in the plot
9757: If $Max is < any data point, the graph will not be rendered.
9758:
1.140 matthew 9759: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 9760: they are plotted. If undefined, default values will be used.
9761:
1.178 matthew 9762: =item $labels: array ref holding the labels to use on the x-axis for the bars.
9763:
1.138 matthew 9764: =item @Values: An array of array references. Each array reference holds data
9765: to be plotted in a stacked bar chart.
9766:
1.239 matthew 9767: =item If the final element of @Values is a hash reference the key/value
9768: pairs will be added to the graph definition.
9769:
1.138 matthew 9770: =back
9771:
9772: Returns:
9773:
9774: An <img> tag which references graph.png and the appropriate identifying
9775: information for the plot.
9776:
1.127 matthew 9777: =cut
9778:
9779: ############################################################
9780: ############################################################
1.134 matthew 9781: sub DrawBarGraph {
1.178 matthew 9782: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 9783: #
9784: if (! defined($colors)) {
9785: $colors = ['#33ff00',
9786: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
9787: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
9788: ];
9789: }
1.228 matthew 9790: my $extra_settings = {};
9791: if (ref($Values[-1]) eq 'HASH') {
9792: $extra_settings = pop(@Values);
9793: }
1.127 matthew 9794: #
1.136 matthew 9795: my $identifier = &get_cgi_id();
9796: my $id = 'cgi.'.$identifier;
1.129 matthew 9797: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 9798: return '';
9799: }
1.225 matthew 9800: #
9801: my @Labels;
9802: if (defined($labels)) {
9803: @Labels = @$labels;
9804: } else {
9805: for (my $i=0;$i<@{$Values[0]};$i++) {
9806: push (@Labels,$i+1);
9807: }
9808: }
9809: #
1.129 matthew 9810: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 9811: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 9812: my %ValuesHash;
9813: my $NumSets=1;
9814: foreach my $array (@Values) {
9815: next if (! ref($array));
1.136 matthew 9816: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 9817: join(',',@$array);
1.129 matthew 9818: }
1.127 matthew 9819: #
1.136 matthew 9820: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 9821: if ($NumBars < 3) {
9822: $width = 120+$NumBars*32;
1.220 matthew 9823: $xskip = 1;
1.225 matthew 9824: $bar_width = 30;
9825: } elsif ($NumBars < 5) {
9826: $width = 120+$NumBars*20;
9827: $xskip = 1;
9828: $bar_width = 20;
1.220 matthew 9829: } elsif ($NumBars < 10) {
1.136 matthew 9830: $width = 120+$NumBars*15;
9831: $xskip = 1;
9832: $bar_width = 15;
9833: } elsif ($NumBars <= 25) {
9834: $width = 120+$NumBars*11;
9835: $xskip = 5;
9836: $bar_width = 8;
9837: } elsif ($NumBars <= 50) {
9838: $width = 120+$NumBars*8;
9839: $xskip = 5;
9840: $bar_width = 4;
9841: } else {
9842: $width = 120+$NumBars*8;
9843: $xskip = 5;
9844: $bar_width = 4;
9845: }
9846: #
1.137 matthew 9847: $Max = 1 if ($Max < 1);
9848: if ( int($Max) < $Max ) {
9849: $Max++;
9850: $Max = int($Max);
9851: }
1.127 matthew 9852: $Title = '' if (! defined($Title));
9853: $xlabel = '' if (! defined($xlabel));
9854: $ylabel = '' if (! defined($ylabel));
1.369 www 9855: $ValuesHash{$id.'.title'} = &escape($Title);
9856: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
9857: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 9858: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 9859: $ValuesHash{$id.'.NumBars'} = $NumBars;
9860: $ValuesHash{$id.'.NumSets'} = $NumSets;
9861: $ValuesHash{$id.'.PlotType'} = 'bar';
9862: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9863: $ValuesHash{$id.'.height'} = $height;
9864: $ValuesHash{$id.'.width'} = $width;
9865: $ValuesHash{$id.'.xskip'} = $xskip;
9866: $ValuesHash{$id.'.bar_width'} = $bar_width;
9867: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 9868: #
1.228 matthew 9869: # Deal with other parameters
9870: while (my ($key,$value) = each(%$extra_settings)) {
9871: $ValuesHash{$id.'.'.$key} = $value;
9872: }
9873: #
1.646 raeburn 9874: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 9875: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9876: }
9877:
9878: ############################################################
9879: ############################################################
9880:
9881: =pod
9882:
1.648 raeburn 9883: =item * &DrawXYGraph()
1.137 matthew 9884:
1.138 matthew 9885: Facilitates the plotting of data in an XY graph.
9886: Puts plot definition data into the users environment in order for
9887: graph.png to plot it. Returns an <img> tag for the plot.
9888:
9889: Inputs:
9890:
9891: =over 4
9892:
9893: =item $Title: string, the title of the plot
9894:
9895: =item $xlabel: string, text describing the X-axis of the plot
9896:
9897: =item $ylabel: string, text describing the Y-axis of the plot
9898:
9899: =item $Max: scalar, the maximum Y value to use in the plot
9900: If $Max is < any data point, the graph will not be rendered.
9901:
9902: =item $colors: Array ref containing the hex color codes for the data to be
9903: plotted in. If undefined, default values will be used.
9904:
9905: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9906:
9907: =item $Ydata: Array ref containing Array refs.
1.185 www 9908: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 9909:
9910: =item %Values: hash indicating or overriding any default values which are
9911: passed to graph.png.
9912: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9913:
9914: =back
9915:
9916: Returns:
9917:
9918: An <img> tag which references graph.png and the appropriate identifying
9919: information for the plot.
9920:
1.137 matthew 9921: =cut
9922:
9923: ############################################################
9924: ############################################################
9925: sub DrawXYGraph {
9926: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
9927: #
9928: # Create the identifier for the graph
9929: my $identifier = &get_cgi_id();
9930: my $id = 'cgi.'.$identifier;
9931: #
9932: $Title = '' if (! defined($Title));
9933: $xlabel = '' if (! defined($xlabel));
9934: $ylabel = '' if (! defined($ylabel));
9935: my %ValuesHash =
9936: (
1.369 www 9937: $id.'.title' => &escape($Title),
9938: $id.'.xlabel' => &escape($xlabel),
9939: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 9940: $id.'.y_max_value'=> $Max,
9941: $id.'.labels' => join(',',@$Xlabels),
9942: $id.'.PlotType' => 'XY',
9943: );
9944: #
9945: if (defined($colors) && ref($colors) eq 'ARRAY') {
9946: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9947: }
9948: #
9949: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
9950: return '';
9951: }
9952: my $NumSets=1;
1.138 matthew 9953: foreach my $array (@{$Ydata}){
1.137 matthew 9954: next if (! ref($array));
9955: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
9956: }
1.138 matthew 9957: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 9958: #
9959: # Deal with other parameters
9960: while (my ($key,$value) = each(%Values)) {
9961: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 9962: }
9963: #
1.646 raeburn 9964: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 9965: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9966: }
9967:
9968: ############################################################
9969: ############################################################
9970:
9971: =pod
9972:
1.648 raeburn 9973: =item * &DrawXYYGraph()
1.138 matthew 9974:
9975: Facilitates the plotting of data in an XY graph with two Y axes.
9976: Puts plot definition data into the users environment in order for
9977: graph.png to plot it. Returns an <img> tag for the plot.
9978:
9979: Inputs:
9980:
9981: =over 4
9982:
9983: =item $Title: string, the title of the plot
9984:
9985: =item $xlabel: string, text describing the X-axis of the plot
9986:
9987: =item $ylabel: string, text describing the Y-axis of the plot
9988:
9989: =item $colors: Array ref containing the hex color codes for the data to be
9990: plotted in. If undefined, default values will be used.
9991:
9992: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9993:
9994: =item $Ydata1: The first data set
9995:
9996: =item $Min1: The minimum value of the left Y-axis
9997:
9998: =item $Max1: The maximum value of the left Y-axis
9999:
10000: =item $Ydata2: The second data set
10001:
10002: =item $Min2: The minimum value of the right Y-axis
10003:
10004: =item $Max2: The maximum value of the left Y-axis
10005:
10006: =item %Values: hash indicating or overriding any default values which are
10007: passed to graph.png.
10008: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
10009:
10010: =back
10011:
10012: Returns:
10013:
10014: An <img> tag which references graph.png and the appropriate identifying
10015: information for the plot.
1.136 matthew 10016:
10017: =cut
10018:
10019: ############################################################
10020: ############################################################
1.137 matthew 10021: sub DrawXYYGraph {
10022: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
10023: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 10024: #
10025: # Create the identifier for the graph
10026: my $identifier = &get_cgi_id();
10027: my $id = 'cgi.'.$identifier;
10028: #
10029: $Title = '' if (! defined($Title));
10030: $xlabel = '' if (! defined($xlabel));
10031: $ylabel = '' if (! defined($ylabel));
10032: my %ValuesHash =
10033: (
1.369 www 10034: $id.'.title' => &escape($Title),
10035: $id.'.xlabel' => &escape($xlabel),
10036: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 10037: $id.'.labels' => join(',',@$Xlabels),
10038: $id.'.PlotType' => 'XY',
10039: $id.'.NumSets' => 2,
1.137 matthew 10040: $id.'.two_axes' => 1,
10041: $id.'.y1_max_value' => $Max1,
10042: $id.'.y1_min_value' => $Min1,
10043: $id.'.y2_max_value' => $Max2,
10044: $id.'.y2_min_value' => $Min2,
1.136 matthew 10045: );
10046: #
1.137 matthew 10047: if (defined($colors) && ref($colors) eq 'ARRAY') {
10048: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
10049: }
10050: #
10051: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
10052: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 10053: return '';
10054: }
10055: my $NumSets=1;
1.137 matthew 10056: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 10057: next if (! ref($array));
10058: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 10059: }
10060: #
10061: # Deal with other parameters
10062: while (my ($key,$value) = each(%Values)) {
10063: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 10064: }
10065: #
1.646 raeburn 10066: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 10067: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 10068: }
10069:
10070: ############################################################
10071: ############################################################
10072:
10073: =pod
10074:
1.157 matthew 10075: =back
10076:
1.139 matthew 10077: =head1 Statistics helper routines?
10078:
10079: Bad place for them but what the hell.
10080:
1.157 matthew 10081: =over 4
10082:
1.648 raeburn 10083: =item * &chartlink()
1.139 matthew 10084:
10085: Returns a link to the chart for a specific student.
10086:
10087: Inputs:
10088:
10089: =over 4
10090:
10091: =item $linktext: The text of the link
10092:
10093: =item $sname: The students username
10094:
10095: =item $sdomain: The students domain
10096:
10097: =back
10098:
1.157 matthew 10099: =back
10100:
1.139 matthew 10101: =cut
10102:
10103: ############################################################
10104: ############################################################
10105: sub chartlink {
10106: my ($linktext, $sname, $sdomain) = @_;
10107: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 10108: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 10109: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 10110: '">'.$linktext.'</a>';
1.153 matthew 10111: }
10112:
10113: #######################################################
10114: #######################################################
10115:
10116: =pod
10117:
10118: =head1 Course Environment Routines
1.157 matthew 10119:
10120: =over 4
1.153 matthew 10121:
1.648 raeburn 10122: =item * &restore_course_settings()
1.153 matthew 10123:
1.648 raeburn 10124: =item * &store_course_settings()
1.153 matthew 10125:
10126: Restores/Store indicated form parameters from the course environment.
10127: Will not overwrite existing values of the form parameters.
10128:
10129: Inputs:
10130: a scalar describing the data (e.g. 'chart', 'problem_analysis')
10131:
10132: a hash ref describing the data to be stored. For example:
10133:
10134: %Save_Parameters = ('Status' => 'scalar',
10135: 'chartoutputmode' => 'scalar',
10136: 'chartoutputdata' => 'scalar',
10137: 'Section' => 'array',
1.373 raeburn 10138: 'Group' => 'array',
1.153 matthew 10139: 'StudentData' => 'array',
10140: 'Maps' => 'array');
10141:
10142: Returns: both routines return nothing
10143:
1.631 raeburn 10144: =back
10145:
1.153 matthew 10146: =cut
10147:
10148: #######################################################
10149: #######################################################
10150: sub store_course_settings {
1.496 albertel 10151: return &store_settings($env{'request.course.id'},@_);
10152: }
10153:
10154: sub store_settings {
1.153 matthew 10155: # save to the environment
10156: # appenv the same items, just to be safe
1.300 albertel 10157: my $udom = $env{'user.domain'};
10158: my $uname = $env{'user.name'};
1.496 albertel 10159: my ($context,$prefix,$Settings) = @_;
1.153 matthew 10160: my %SaveHash;
10161: my %AppHash;
10162: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 10163: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 10164: my $envname = 'environment.'.$basename;
1.258 albertel 10165: if (exists($env{'form.'.$setting})) {
1.153 matthew 10166: # Save this value away
10167: if ($type eq 'scalar' &&
1.258 albertel 10168: (! exists($env{$envname}) ||
10169: $env{$envname} ne $env{'form.'.$setting})) {
10170: $SaveHash{$basename} = $env{'form.'.$setting};
10171: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 10172: } elsif ($type eq 'array') {
10173: my $stored_form;
1.258 albertel 10174: if (ref($env{'form.'.$setting})) {
1.153 matthew 10175: $stored_form = join(',',
10176: map {
1.369 www 10177: &escape($_);
1.258 albertel 10178: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 10179: } else {
10180: $stored_form =
1.369 www 10181: &escape($env{'form.'.$setting});
1.153 matthew 10182: }
10183: # Determine if the array contents are the same.
1.258 albertel 10184: if ($stored_form ne $env{$envname}) {
1.153 matthew 10185: $SaveHash{$basename} = $stored_form;
10186: $AppHash{$envname} = $stored_form;
10187: }
10188: }
10189: }
10190: }
10191: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 10192: $udom,$uname);
1.153 matthew 10193: if ($put_result !~ /^(ok|delayed)/) {
10194: &Apache::lonnet::logthis('unable to save form parameters, '.
10195: 'got error:'.$put_result);
10196: }
10197: # Make sure these settings stick around in this session, too
1.646 raeburn 10198: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 10199: return;
10200: }
10201:
10202: sub restore_course_settings {
1.499 albertel 10203: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 10204: }
10205:
10206: sub restore_settings {
10207: my ($context,$prefix,$Settings) = @_;
1.153 matthew 10208: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 10209: next if (exists($env{'form.'.$setting}));
1.496 albertel 10210: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 10211: '.'.$setting;
1.258 albertel 10212: if (exists($env{$envname})) {
1.153 matthew 10213: if ($type eq 'scalar') {
1.258 albertel 10214: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 10215: } elsif ($type eq 'array') {
1.258 albertel 10216: $env{'form.'.$setting} = [
1.153 matthew 10217: map {
1.369 www 10218: &unescape($_);
1.258 albertel 10219: } split(',',$env{$envname})
1.153 matthew 10220: ];
10221: }
10222: }
10223: }
1.127 matthew 10224: }
10225:
1.618 raeburn 10226: #######################################################
10227: #######################################################
10228:
10229: =pod
10230:
10231: =head1 Domain E-mail Routines
10232:
10233: =over 4
10234:
1.648 raeburn 10235: =item * &build_recipient_list()
1.618 raeburn 10236:
1.884 raeburn 10237: Build recipient lists for five types of e-mail:
1.766 raeburn 10238: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884 raeburn 10239: (d) Help requests, (e) Course requests needing approval, generated by
10240: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
10241: loncoursequeueadmin.pm respectively.
1.618 raeburn 10242:
10243: Inputs:
1.619 raeburn 10244: defmail (scalar - email address of default recipient),
1.618 raeburn 10245: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 10246: defdom (domain for which to retrieve configuration settings),
10247: origmail (scalar - email address of recipient from loncapa.conf,
10248: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 10249:
1.655 raeburn 10250: Returns: comma separated list of addresses to which to send e-mail.
10251:
10252: =back
1.618 raeburn 10253:
10254: =cut
10255:
10256: ############################################################
10257: ############################################################
10258: sub build_recipient_list {
1.619 raeburn 10259: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 10260: my @recipients;
10261: my $otheremails;
10262: my %domconfig =
10263: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
10264: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 10265: if (exists($domconfig{'contacts'}{$mailing})) {
10266: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
10267: my @contacts = ('adminemail','supportemail');
10268: foreach my $item (@contacts) {
10269: if ($domconfig{'contacts'}{$mailing}{$item}) {
10270: my $addr = $domconfig{'contacts'}{$item};
10271: if (!grep(/^\Q$addr\E$/,@recipients)) {
10272: push(@recipients,$addr);
10273: }
1.619 raeburn 10274: }
1.766 raeburn 10275: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 10276: }
10277: }
1.766 raeburn 10278: } elsif ($origmail ne '') {
10279: push(@recipients,$origmail);
1.618 raeburn 10280: }
1.619 raeburn 10281: } elsif ($origmail ne '') {
10282: push(@recipients,$origmail);
1.618 raeburn 10283: }
1.688 raeburn 10284: if (defined($defmail)) {
10285: if ($defmail ne '') {
10286: push(@recipients,$defmail);
10287: }
1.618 raeburn 10288: }
10289: if ($otheremails) {
1.619 raeburn 10290: my @others;
10291: if ($otheremails =~ /,/) {
10292: @others = split(/,/,$otheremails);
1.618 raeburn 10293: } else {
1.619 raeburn 10294: push(@others,$otheremails);
10295: }
10296: foreach my $addr (@others) {
10297: if (!grep(/^\Q$addr\E$/,@recipients)) {
10298: push(@recipients,$addr);
10299: }
1.618 raeburn 10300: }
10301: }
1.619 raeburn 10302: my $recipientlist = join(',',@recipients);
1.618 raeburn 10303: return $recipientlist;
10304: }
10305:
1.127 matthew 10306: ############################################################
10307: ############################################################
1.154 albertel 10308:
1.655 raeburn 10309: =pod
10310:
10311: =head1 Course Catalog Routines
10312:
10313: =over 4
10314:
10315: =item * &gather_categories()
10316:
10317: Converts category definitions - keys of categories hash stored in
10318: coursecategories in configuration.db on the primary library server in a
10319: domain - to an array. Also generates javascript and idx hash used to
10320: generate Domain Coordinator interface for editing Course Categories.
10321:
10322: Inputs:
1.663 raeburn 10323:
1.655 raeburn 10324: categories (reference to hash of category definitions).
1.663 raeburn 10325:
1.655 raeburn 10326: cats (reference to array of arrays/hashes which encapsulates hierarchy of
10327: categories and subcategories).
1.663 raeburn 10328:
1.655 raeburn 10329: idx (reference to hash of counters used in Domain Coordinator interface for
10330: editing Course Categories).
1.663 raeburn 10331:
1.655 raeburn 10332: jsarray (reference to array of categories used to create Javascript arrays for
10333: Domain Coordinator interface for editing Course Categories).
10334:
10335: Returns: nothing
10336:
10337: Side effects: populates cats, idx and jsarray.
10338:
10339: =cut
10340:
10341: sub gather_categories {
10342: my ($categories,$cats,$idx,$jsarray) = @_;
10343: my %counters;
10344: my $num = 0;
10345: foreach my $item (keys(%{$categories})) {
10346: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
10347: if ($container eq '' && $depth == 0) {
10348: $cats->[$depth][$categories->{$item}] = $cat;
10349: } else {
10350: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
10351: }
10352: my ($escitem,$tail) = split(/:/,$item,2);
10353: if ($counters{$tail} eq '') {
10354: $counters{$tail} = $num;
10355: $num ++;
10356: }
10357: if (ref($idx) eq 'HASH') {
10358: $idx->{$item} = $counters{$tail};
10359: }
10360: if (ref($jsarray) eq 'ARRAY') {
10361: push(@{$jsarray->[$counters{$tail}]},$item);
10362: }
10363: }
10364: return;
10365: }
10366:
10367: =pod
10368:
10369: =item * &extract_categories()
10370:
10371: Used to generate breadcrumb trails for course categories.
10372:
10373: Inputs:
1.663 raeburn 10374:
1.655 raeburn 10375: categories (reference to hash of category definitions).
1.663 raeburn 10376:
1.655 raeburn 10377: cats (reference to array of arrays/hashes which encapsulates hierarchy of
10378: categories and subcategories).
1.663 raeburn 10379:
1.655 raeburn 10380: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 10381:
1.655 raeburn 10382: allitems (reference to hash - key is category key
10383: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 10384:
1.655 raeburn 10385: idx (reference to hash of counters used in Domain Coordinator interface for
10386: editing Course Categories).
1.663 raeburn 10387:
1.655 raeburn 10388: jsarray (reference to array of categories used to create Javascript arrays for
10389: Domain Coordinator interface for editing Course Categories).
10390:
1.665 raeburn 10391: subcats (reference to hash of arrays containing all subcategories within each
10392: category, -recursive)
10393:
1.655 raeburn 10394: Returns: nothing
10395:
10396: Side effects: populates trails and allitems hash references.
10397:
10398: =cut
10399:
10400: sub extract_categories {
1.665 raeburn 10401: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 10402: if (ref($categories) eq 'HASH') {
10403: &gather_categories($categories,$cats,$idx,$jsarray);
10404: if (ref($cats->[0]) eq 'ARRAY') {
10405: for (my $i=0; $i<@{$cats->[0]}; $i++) {
10406: my $name = $cats->[0][$i];
10407: my $item = &escape($name).'::0';
10408: my $trailstr;
10409: if ($name eq 'instcode') {
10410: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 10411: } elsif ($name eq 'communities') {
10412: $trailstr = &mt('Communities');
1.655 raeburn 10413: } else {
10414: $trailstr = $name;
10415: }
10416: if ($allitems->{$item} eq '') {
10417: push(@{$trails},$trailstr);
10418: $allitems->{$item} = scalar(@{$trails})-1;
10419: }
10420: my @parents = ($name);
10421: if (ref($cats->[1]{$name}) eq 'ARRAY') {
10422: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
10423: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 10424: if (ref($subcats) eq 'HASH') {
10425: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
10426: }
10427: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
10428: }
10429: } else {
10430: if (ref($subcats) eq 'HASH') {
10431: $subcats->{$item} = [];
1.655 raeburn 10432: }
10433: }
10434: }
10435: }
10436: }
10437: return;
10438: }
10439:
10440: =pod
10441:
10442: =item *&recurse_categories()
10443:
10444: Recursively used to generate breadcrumb trails for course categories.
10445:
10446: Inputs:
1.663 raeburn 10447:
1.655 raeburn 10448: cats (reference to array of arrays/hashes which encapsulates hierarchy of
10449: categories and subcategories).
1.663 raeburn 10450:
1.655 raeburn 10451: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 10452:
10453: category (current course category, for which breadcrumb trail is being generated).
10454:
10455: trails (reference to array of breadcrumb trails for each category).
10456:
1.655 raeburn 10457: allitems (reference to hash - key is category key
10458: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 10459:
1.655 raeburn 10460: parents (array containing containers directories for current category,
10461: back to top level).
10462:
10463: Returns: nothing
10464:
10465: Side effects: populates trails and allitems hash references
10466:
10467: =cut
10468:
10469: sub recurse_categories {
1.665 raeburn 10470: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 10471: my $shallower = $depth - 1;
10472: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
10473: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
10474: my $name = $cats->[$depth]{$category}[$k];
10475: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
10476: my $trailstr = join(' -> ',(@{$parents},$category));
10477: if ($allitems->{$item} eq '') {
10478: push(@{$trails},$trailstr);
10479: $allitems->{$item} = scalar(@{$trails})-1;
10480: }
10481: my $deeper = $depth+1;
10482: push(@{$parents},$category);
1.665 raeburn 10483: if (ref($subcats) eq 'HASH') {
10484: my $subcat = &escape($name).':'.$category.':'.$depth;
10485: for (my $j=@{$parents}; $j>=0; $j--) {
10486: my $higher;
10487: if ($j > 0) {
10488: $higher = &escape($parents->[$j]).':'.
10489: &escape($parents->[$j-1]).':'.$j;
10490: } else {
10491: $higher = &escape($parents->[$j]).'::'.$j;
10492: }
10493: push(@{$subcats->{$higher}},$subcat);
10494: }
10495: }
10496: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
10497: $subcats);
1.655 raeburn 10498: pop(@{$parents});
10499: }
10500: } else {
10501: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
10502: my $trailstr = join(' -> ',(@{$parents},$category));
10503: if ($allitems->{$item} eq '') {
10504: push(@{$trails},$trailstr);
10505: $allitems->{$item} = scalar(@{$trails})-1;
10506: }
10507: }
10508: return;
10509: }
10510:
1.663 raeburn 10511: =pod
10512:
10513: =item *&assign_categories_table()
10514:
10515: Create a datatable for display of hierarchical categories in a domain,
10516: with checkboxes to allow a course to be categorized.
10517:
10518: Inputs:
10519:
10520: cathash - reference to hash of categories defined for the domain (from
10521: configuration.db)
10522:
10523: currcat - scalar with an & separated list of categories assigned to a course.
10524:
1.919 raeburn 10525: type - scalar contains course type (Course or Community).
10526:
1.663 raeburn 10527: Returns: $output (markup to be displayed)
10528:
10529: =cut
10530:
10531: sub assign_categories_table {
1.919 raeburn 10532: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 10533: my $output;
10534: if (ref($cathash) eq 'HASH') {
10535: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
10536: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
10537: $maxdepth = scalar(@cats);
10538: if (@cats > 0) {
10539: my $itemcount = 0;
10540: if (ref($cats[0]) eq 'ARRAY') {
10541: my @currcategories;
10542: if ($currcat ne '') {
10543: @currcategories = split('&',$currcat);
10544: }
1.919 raeburn 10545: my $table;
1.663 raeburn 10546: for (my $i=0; $i<@{$cats[0]}; $i++) {
10547: my $parent = $cats[0][$i];
1.919 raeburn 10548: next if ($parent eq 'instcode');
10549: if ($type eq 'Community') {
10550: next unless ($parent eq 'communities');
10551: } else {
10552: next if ($parent eq 'communities');
10553: }
1.663 raeburn 10554: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
10555: my $item = &escape($parent).'::0';
10556: my $checked = '';
10557: if (@currcategories > 0) {
10558: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 10559: $checked = ' checked="checked"';
1.663 raeburn 10560: }
10561: }
1.919 raeburn 10562: my $parent_title = $parent;
10563: if ($parent eq 'communities') {
10564: $parent_title = &mt('Communities');
10565: }
10566: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
10567: '<input type="checkbox" name="usecategory" value="'.
10568: $item.'"'.$checked.' />'.$parent_title.'</span>'.
10569: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 10570: my $depth = 1;
10571: push(@path,$parent);
1.919 raeburn 10572: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 10573: pop(@path);
1.919 raeburn 10574: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 10575: $itemcount ++;
10576: }
1.919 raeburn 10577: if ($itemcount) {
10578: $output = &Apache::loncommon::start_data_table().
10579: $table.
10580: &Apache::loncommon::end_data_table();
10581: }
1.663 raeburn 10582: }
10583: }
10584: }
10585: return $output;
10586: }
10587:
10588: =pod
10589:
10590: =item *&assign_category_rows()
10591:
10592: Create a datatable row for display of nested categories in a domain,
10593: with checkboxes to allow a course to be categorized,called recursively.
10594:
10595: Inputs:
10596:
10597: itemcount - track row number for alternating colors
10598:
10599: cats - reference to array of arrays/hashes which encapsulates hierarchy of
10600: categories and subcategories.
10601:
10602: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
10603:
10604: parent - parent of current category item
10605:
10606: path - Array containing all categories back up through the hierarchy from the
10607: current category to the top level.
10608:
10609: currcategories - reference to array of current categories assigned to the course
10610:
10611: Returns: $output (markup to be displayed).
10612:
10613: =cut
10614:
10615: sub assign_category_rows {
10616: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
10617: my ($text,$name,$item,$chgstr);
10618: if (ref($cats) eq 'ARRAY') {
10619: my $maxdepth = scalar(@{$cats});
10620: if (ref($cats->[$depth]) eq 'HASH') {
10621: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
10622: my $numchildren = @{$cats->[$depth]{$parent}};
10623: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
10624: $text .= '<td><table class="LC_datatable">';
10625: for (my $j=0; $j<$numchildren; $j++) {
10626: $name = $cats->[$depth]{$parent}[$j];
10627: $item = &escape($name).':'.&escape($parent).':'.$depth;
10628: my $deeper = $depth+1;
10629: my $checked = '';
10630: if (ref($currcategories) eq 'ARRAY') {
10631: if (@{$currcategories} > 0) {
10632: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 10633: $checked = ' checked="checked"';
1.663 raeburn 10634: }
10635: }
10636: }
1.664 raeburn 10637: $text .= '<tr><td><span class="LC_nobreak"><label>'.
10638: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 10639: $item.'"'.$checked.' />'.$name.'</label></span>'.
10640: '<input type="hidden" name="catname" value="'.$name.'" />'.
10641: '</td><td>';
1.663 raeburn 10642: if (ref($path) eq 'ARRAY') {
10643: push(@{$path},$name);
10644: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
10645: pop(@{$path});
10646: }
10647: $text .= '</td></tr>';
10648: }
10649: $text .= '</table></td>';
10650: }
10651: }
10652: }
10653: return $text;
10654: }
10655:
1.655 raeburn 10656: ############################################################
10657: ############################################################
10658:
10659:
1.443 albertel 10660: sub commit_customrole {
1.664 raeburn 10661: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 10662: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 10663: ($start?', '.&mt('starting').' '.localtime($start):'').
10664: ($end?', ending '.localtime($end):'').': <b>'.
10665: &Apache::lonnet::assigncustomrole(
1.664 raeburn 10666: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 10667: '</b><br />';
10668: return $output;
10669: }
10670:
10671: sub commit_standardrole {
1.541 raeburn 10672: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
10673: my ($output,$logmsg,$linefeed);
10674: if ($context eq 'auto') {
10675: $linefeed = "\n";
10676: } else {
10677: $linefeed = "<br />\n";
10678: }
1.443 albertel 10679: if ($three eq 'st') {
1.541 raeburn 10680: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
10681: $one,$two,$sec,$context);
10682: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 10683: ($result eq 'unknown_course') || ($result eq 'refused')) {
10684: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 10685: } else {
1.541 raeburn 10686: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 10687: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 10688: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
10689: if ($context eq 'auto') {
10690: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
10691: } else {
10692: $output .= '<b>'.$result.'</b>'.$linefeed.
10693: &mt('Add to classlist').': <b>ok</b>';
10694: }
10695: $output .= $linefeed;
1.443 albertel 10696: }
10697: } else {
10698: $output = &mt('Assigning').' '.$three.' in '.$url.
10699: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 10700: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 10701: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 10702: if ($context eq 'auto') {
10703: $output .= $result.$linefeed;
10704: } else {
10705: $output .= '<b>'.$result.'</b>'.$linefeed;
10706: }
1.443 albertel 10707: }
10708: return $output;
10709: }
10710:
10711: sub commit_studentrole {
1.541 raeburn 10712: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 10713: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 10714: if ($context eq 'auto') {
10715: $linefeed = "\n";
10716: } else {
10717: $linefeed = '<br />'."\n";
10718: }
1.443 albertel 10719: if (defined($one) && defined($two)) {
10720: my $cid=$one.'_'.$two;
10721: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
10722: my $secchange = 0;
10723: my $expire_role_result;
10724: my $modify_section_result;
1.628 raeburn 10725: if ($oldsec ne '-1') {
10726: if ($oldsec ne $sec) {
1.443 albertel 10727: $secchange = 1;
1.628 raeburn 10728: my $now = time;
1.443 albertel 10729: my $uurl='/'.$cid;
10730: $uurl=~s/\_/\//g;
10731: if ($oldsec) {
10732: $uurl.='/'.$oldsec;
10733: }
1.626 raeburn 10734: $oldsecurl = $uurl;
1.628 raeburn 10735: $expire_role_result =
1.652 raeburn 10736: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 10737: if ($env{'request.course.sec'} ne '') {
10738: if ($expire_role_result eq 'refused') {
10739: my @roles = ('st');
10740: my @statuses = ('previous');
10741: my @roledoms = ($one);
10742: my $withsec = 1;
10743: my %roleshash =
10744: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
10745: \@statuses,\@roles,\@roledoms,$withsec);
10746: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
10747: my ($oldstart,$oldend) =
10748: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
10749: if ($oldend > 0 && $oldend <= $now) {
10750: $expire_role_result = 'ok';
10751: }
10752: }
10753: }
10754: }
1.443 albertel 10755: $result = $expire_role_result;
10756: }
10757: }
10758: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 10759: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 10760: if ($modify_section_result =~ /^ok/) {
10761: if ($secchange == 1) {
1.628 raeburn 10762: if ($sec eq '') {
10763: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
10764: } else {
10765: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
10766: }
1.443 albertel 10767: } elsif ($oldsec eq '-1') {
1.628 raeburn 10768: if ($sec eq '') {
10769: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
10770: } else {
10771: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
10772: }
1.443 albertel 10773: } else {
1.628 raeburn 10774: if ($sec eq '') {
10775: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
10776: } else {
10777: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
10778: }
1.443 albertel 10779: }
10780: } else {
1.628 raeburn 10781: if ($secchange) {
10782: $$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;
10783: } else {
10784: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
10785: }
1.443 albertel 10786: }
10787: $result = $modify_section_result;
10788: } elsif ($secchange == 1) {
1.628 raeburn 10789: if ($oldsec eq '') {
10790: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
10791: } else {
10792: $$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;
10793: }
1.626 raeburn 10794: if ($expire_role_result eq 'refused') {
10795: my $newsecurl = '/'.$cid;
10796: $newsecurl =~ s/\_/\//g;
10797: if ($sec ne '') {
10798: $newsecurl.='/'.$sec;
10799: }
10800: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
10801: if ($sec eq '') {
10802: $$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;
10803: } else {
10804: $$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;
10805: }
10806: }
10807: }
1.443 albertel 10808: }
10809: } else {
1.626 raeburn 10810: $$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 10811: $result = "error: incomplete course id\n";
10812: }
10813: return $result;
10814: }
10815:
10816: ############################################################
10817: ############################################################
10818:
1.566 albertel 10819: sub check_clone {
1.578 raeburn 10820: my ($args,$linefeed) = @_;
1.566 albertel 10821: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
10822: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
10823: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
10824: my $clonemsg;
10825: my $can_clone = 0;
1.944 raeburn 10826: my $lctype = lc($args->{'crstype'});
1.908 raeburn 10827: if ($lctype ne 'community') {
10828: $lctype = 'course';
10829: }
1.566 albertel 10830: if ($clonehome eq 'no_host') {
1.944 raeburn 10831: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10832: $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'});
10833: } else {
10834: $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'});
10835: }
1.566 albertel 10836: } else {
10837: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944 raeburn 10838: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10839: if ($clonedesc{'type'} ne 'Community') {
10840: $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'});
10841: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10842: }
10843: }
1.882 raeburn 10844: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
10845: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 10846: $can_clone = 1;
10847: } else {
10848: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
10849: $args->{'clonedomain'},$args->{'clonecourse'});
10850: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 10851: if (grep(/^\*$/,@cloners)) {
10852: $can_clone = 1;
10853: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
10854: $can_clone = 1;
10855: } else {
1.908 raeburn 10856: my $ccrole = 'cc';
1.944 raeburn 10857: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10858: $ccrole = 'co';
10859: }
1.578 raeburn 10860: my %roleshash =
10861: &Apache::lonnet::get_my_roles($args->{'ccuname'},
10862: $args->{'ccdomain'},
1.908 raeburn 10863: 'userroles',['active'],[$ccrole],
1.578 raeburn 10864: [$args->{'clonedomain'}]);
1.908 raeburn 10865: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942 raeburn 10866: $can_clone = 1;
10867: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
10868: $can_clone = 1;
10869: } else {
1.944 raeburn 10870: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10871: $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'});
10872: } else {
10873: $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'});
10874: }
1.578 raeburn 10875: }
1.566 albertel 10876: }
1.578 raeburn 10877: }
1.566 albertel 10878: }
10879: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10880: }
10881:
1.444 albertel 10882: sub construct_course {
1.885 raeburn 10883: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444 albertel 10884: my $outcome;
1.541 raeburn 10885: my $linefeed = '<br />'."\n";
10886: if ($context eq 'auto') {
10887: $linefeed = "\n";
10888: }
1.566 albertel 10889:
10890: #
10891: # Are we cloning?
10892: #
10893: my ($can_clone, $clonemsg, $cloneid, $clonehome);
10894: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 10895: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 10896: if ($context ne 'auto') {
1.578 raeburn 10897: if ($clonemsg ne '') {
10898: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
10899: }
1.566 albertel 10900: }
10901: $outcome .= $clonemsg.$linefeed;
10902:
10903: if (!$can_clone) {
10904: return (0,$outcome);
10905: }
10906: }
10907:
1.444 albertel 10908: #
10909: # Open course
10910: #
10911: my $crstype = lc($args->{'crstype'});
10912: my %cenv=();
10913: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
10914: $args->{'cdescr'},
10915: $args->{'curl'},
10916: $args->{'course_home'},
10917: $args->{'nonstandard'},
10918: $args->{'crscode'},
10919: $args->{'ccuname'}.':'.
10920: $args->{'ccdomain'},
1.882 raeburn 10921: $args->{'crstype'},
1.885 raeburn 10922: $cnum,$context,$category);
1.444 albertel 10923:
10924: # Note: The testing routines depend on this being output; see
10925: # Utils::Course. This needs to at least be output as a comment
10926: # if anyone ever decides to not show this, and Utils::Course::new
10927: # will need to be suitably modified.
1.541 raeburn 10928: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943 raeburn 10929: if ($$courseid =~ /^error:/) {
10930: return (0,$outcome);
10931: }
10932:
1.444 albertel 10933: #
10934: # Check if created correctly
10935: #
1.479 albertel 10936: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 10937: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 10938: if ($crsuhome eq 'no_host') {
10939: $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
10940: return (0,$outcome);
10941: }
1.541 raeburn 10942: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 10943:
1.444 albertel 10944: #
1.566 albertel 10945: # Do the cloning
10946: #
10947: if ($can_clone && $cloneid) {
10948: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
10949: if ($context ne 'auto') {
10950: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
10951: }
10952: $outcome .= $clonemsg.$linefeed;
10953: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 10954: # Copy all files
1.637 www 10955: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 10956: # Restore URL
1.566 albertel 10957: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 10958: # Restore title
1.566 albertel 10959: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 10960: # Restore creation date, creator and creation context.
10961: $cenv{'internal.created'}=$oldcenv{'internal.created'};
10962: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
10963: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 10964: # Mark as cloned
1.566 albertel 10965: $cenv{'clonedfrom'}=$cloneid;
1.638 www 10966: # Need to clone grading mode
10967: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
10968: $cenv{'grading'}=$newenv{'grading'};
10969: # Do not clone these environment entries
10970: &Apache::lonnet::del('environment',
10971: ['default_enrollment_start_date',
10972: 'default_enrollment_end_date',
10973: 'question.email',
10974: 'policy.email',
10975: 'comment.email',
10976: 'pch.users.denied',
1.725 raeburn 10977: 'plc.users.denied',
10978: 'hidefromcat',
10979: 'categories'],
1.638 www 10980: $$crsudom,$$crsunum);
1.444 albertel 10981: }
1.566 albertel 10982:
1.444 albertel 10983: #
10984: # Set environment (will override cloned, if existing)
10985: #
10986: my @sections = ();
10987: my @xlists = ();
10988: if ($args->{'crstype'}) {
10989: $cenv{'type'}=$args->{'crstype'};
10990: }
10991: if ($args->{'crsid'}) {
10992: $cenv{'courseid'}=$args->{'crsid'};
10993: }
10994: if ($args->{'crscode'}) {
10995: $cenv{'internal.coursecode'}=$args->{'crscode'};
10996: }
10997: if ($args->{'crsquota'} ne '') {
10998: $cenv{'internal.coursequota'}=$args->{'crsquota'};
10999: } else {
11000: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
11001: }
11002: if ($args->{'ccuname'}) {
11003: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
11004: ':'.$args->{'ccdomain'};
11005: } else {
11006: $cenv{'internal.courseowner'} = $args->{'curruser'};
11007: }
11008: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
11009: if ($args->{'crssections'}) {
11010: $cenv{'internal.sectionnums'} = '';
11011: if ($args->{'crssections'} =~ m/,/) {
11012: @sections = split/,/,$args->{'crssections'};
11013: } else {
11014: $sections[0] = $args->{'crssections'};
11015: }
11016: if (@sections > 0) {
11017: foreach my $item (@sections) {
11018: my ($sec,$gp) = split/:/,$item;
11019: my $class = $args->{'crscode'}.$sec;
11020: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
11021: $cenv{'internal.sectionnums'} .= $item.',';
11022: unless ($addcheck eq 'ok') {
11023: push @badclasses, $class;
11024: }
11025: }
11026: $cenv{'internal.sectionnums'} =~ s/,$//;
11027: }
11028: }
11029: # do not hide course coordinator from staff listing,
11030: # even if privileged
11031: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
11032: # add crosslistings
11033: if ($args->{'crsxlist'}) {
11034: $cenv{'internal.crosslistings'}='';
11035: if ($args->{'crsxlist'} =~ m/,/) {
11036: @xlists = split/,/,$args->{'crsxlist'};
11037: } else {
11038: $xlists[0] = $args->{'crsxlist'};
11039: }
11040: if (@xlists > 0) {
11041: foreach my $item (@xlists) {
11042: my ($xl,$gp) = split/:/,$item;
11043: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
11044: $cenv{'internal.crosslistings'} .= $item.',';
11045: unless ($addcheck eq 'ok') {
11046: push @badclasses, $xl;
11047: }
11048: }
11049: $cenv{'internal.crosslistings'} =~ s/,$//;
11050: }
11051: }
11052: if ($args->{'autoadds'}) {
11053: $cenv{'internal.autoadds'}=$args->{'autoadds'};
11054: }
11055: if ($args->{'autodrops'}) {
11056: $cenv{'internal.autodrops'}=$args->{'autodrops'};
11057: }
11058: # check for notification of enrollment changes
11059: my @notified = ();
11060: if ($args->{'notify_owner'}) {
11061: if ($args->{'ccuname'} ne '') {
11062: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
11063: }
11064: }
11065: if ($args->{'notify_dc'}) {
11066: if ($uname ne '') {
1.630 raeburn 11067: push(@notified,$uname.':'.$udom);
1.444 albertel 11068: }
11069: }
11070: if (@notified > 0) {
11071: my $notifylist;
11072: if (@notified > 1) {
11073: $notifylist = join(',',@notified);
11074: } else {
11075: $notifylist = $notified[0];
11076: }
11077: $cenv{'internal.notifylist'} = $notifylist;
11078: }
11079: if (@badclasses > 0) {
11080: my %lt=&Apache::lonlocal::texthash(
11081: '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',
11082: 'dnhr' => 'does not have rights to access enrollment in these classes',
11083: 'adby' => 'as determined by the policies of your institution on access to official classlists'
11084: );
1.541 raeburn 11085: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
11086: ' ('.$lt{'adby'}.')';
11087: if ($context eq 'auto') {
11088: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 11089: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 11090: foreach my $item (@badclasses) {
11091: if ($context eq 'auto') {
11092: $outcome .= " - $item\n";
11093: } else {
11094: $outcome .= "<li>$item</li>\n";
11095: }
11096: }
11097: if ($context eq 'auto') {
11098: $outcome .= $linefeed;
11099: } else {
1.566 albertel 11100: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 11101: }
11102: }
1.444 albertel 11103: }
11104: if ($args->{'no_end_date'}) {
11105: $args->{'endaccess'} = 0;
11106: }
11107: $cenv{'internal.autostart'}=$args->{'enrollstart'};
11108: $cenv{'internal.autoend'}=$args->{'enrollend'};
11109: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
11110: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
11111: if ($args->{'showphotos'}) {
11112: $cenv{'internal.showphotos'}=$args->{'showphotos'};
11113: }
11114: $cenv{'internal.authtype'} = $args->{'authtype'};
11115: $cenv{'internal.autharg'} = $args->{'autharg'};
11116: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
11117: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 11118: 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');
11119: if ($context eq 'auto') {
11120: $outcome .= $krb_msg;
11121: } else {
1.566 albertel 11122: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 11123: }
11124: $outcome .= $linefeed;
1.444 albertel 11125: }
11126: }
11127: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
11128: if ($args->{'setpolicy'}) {
11129: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
11130: }
11131: if ($args->{'setcontent'}) {
11132: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
11133: }
11134: }
11135: if ($args->{'reshome'}) {
11136: $cenv{'reshome'}=$args->{'reshome'}.'/';
11137: $cenv{'reshome'}=~s/\/+$/\//;
11138: }
11139: #
11140: # course has keyed access
11141: #
11142: if ($args->{'setkeys'}) {
11143: $cenv{'keyaccess'}='yes';
11144: }
11145: # if specified, key authority is not course, but user
11146: # only active if keyaccess is yes
11147: if ($args->{'keyauth'}) {
1.487 albertel 11148: my ($user,$domain) = split(':',$args->{'keyauth'});
11149: $user = &LONCAPA::clean_username($user);
11150: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 11151: if ($user ne '' && $domain ne '') {
1.487 albertel 11152: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 11153: }
11154: }
11155:
11156: if ($args->{'disresdis'}) {
11157: $cenv{'pch.roles.denied'}='st';
11158: }
11159: if ($args->{'disablechat'}) {
11160: $cenv{'plc.roles.denied'}='st';
11161: }
11162:
11163: # Record we've not yet viewed the Course Initialization Helper for this
11164: # course
11165: $cenv{'course.helper.not.run'} = 1;
11166: #
11167: # Use new Randomseed
11168: #
11169: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
11170: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
11171: #
11172: # The encryption code and receipt prefix for this course
11173: #
11174: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
11175: $cenv{'internal.encpref'}=100+int(9*rand(99));
11176: #
11177: # By default, use standard grading
11178: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
11179:
1.541 raeburn 11180: $outcome .= $linefeed.&mt('Setting environment').': '.
11181: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 11182: #
11183: # Open all assignments
11184: #
11185: if ($args->{'openall'}) {
11186: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
11187: my %storecontent = ($storeunder => time,
11188: $storeunder.'.type' => 'date_start');
11189:
11190: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 11191: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 11192: }
11193: #
11194: # Set first page
11195: #
11196: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
11197: || ($cloneid)) {
1.445 albertel 11198: use LONCAPA::map;
1.444 albertel 11199: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 11200:
11201: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
11202: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
11203:
1.444 albertel 11204: $outcome .= ($fatal?$errtext:'read ok').' - ';
11205: my $title; my $url;
11206: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 11207: $title=&mt('Syllabus');
1.444 albertel 11208: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
11209: } else {
1.963 raeburn 11210: $title=&mt('Table of Contents');
1.444 albertel 11211: $url='/adm/navmaps';
11212: }
1.445 albertel 11213:
11214: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
11215: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
11216:
11217: if ($errtext) { $fatal=2; }
1.541 raeburn 11218: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 11219: }
1.566 albertel 11220:
11221: return (1,$outcome);
1.444 albertel 11222: }
11223:
11224: ############################################################
11225: ############################################################
11226:
1.953 droeschl 11227: #SD
11228: # only Community and Course, or anything else?
1.378 raeburn 11229: sub course_type {
11230: my ($cid) = @_;
11231: if (!defined($cid)) {
11232: $cid = $env{'request.course.id'};
11233: }
1.404 albertel 11234: if (defined($env{'course.'.$cid.'.type'})) {
11235: return $env{'course.'.$cid.'.type'};
1.378 raeburn 11236: } else {
11237: return 'Course';
1.377 raeburn 11238: }
11239: }
1.156 albertel 11240:
1.406 raeburn 11241: sub group_term {
11242: my $crstype = &course_type();
11243: my %names = (
11244: 'Course' => 'group',
1.865 raeburn 11245: 'Community' => 'group',
1.406 raeburn 11246: );
11247: return $names{$crstype};
11248: }
11249:
1.902 raeburn 11250: sub course_types {
11251: my @types = ('official','unofficial','community');
11252: my %typename = (
11253: official => 'Official course',
11254: unofficial => 'Unofficial course',
11255: community => 'Community',
11256: );
11257: return (\@types,\%typename);
11258: }
11259:
1.156 albertel 11260: sub icon {
11261: my ($file)=@_;
1.505 albertel 11262: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 11263: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 11264: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 11265: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
11266: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
11267: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
11268: $curfext.".gif") {
11269: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
11270: $curfext.".gif";
11271: }
11272: }
1.249 albertel 11273: return &lonhttpdurl($iconname);
1.154 albertel 11274: }
1.84 albertel 11275:
1.575 albertel 11276: sub lonhttpdurl {
1.692 www 11277: #
11278: # Had been used for "small fry" static images on separate port 8080.
11279: # Modify here if lightweight http functionality desired again.
11280: # Currently eliminated due to increasing firewall issues.
11281: #
1.575 albertel 11282: my ($url)=@_;
1.692 www 11283: return $url;
1.215 albertel 11284: }
11285:
1.213 albertel 11286: sub connection_aborted {
11287: my ($r)=@_;
11288: $r->print(" ");$r->rflush();
11289: my $c = $r->connection;
11290: return $c->aborted();
11291: }
11292:
1.221 foxr 11293: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 11294: # strings as 'strings'.
11295: sub escape_single {
1.221 foxr 11296: my ($input) = @_;
1.223 albertel 11297: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 11298: $input =~ s/\'/\\\'/g; # Esacpe the 's....
11299: return $input;
11300: }
1.223 albertel 11301:
1.222 foxr 11302: # Same as escape_single, but escape's "'s This
11303: # can be used for "strings"
11304: sub escape_double {
11305: my ($input) = @_;
11306: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
11307: $input =~ s/\"/\\\"/g; # Esacpe the "s....
11308: return $input;
11309: }
1.223 albertel 11310:
1.222 foxr 11311: # Escapes the last element of a full URL.
11312: sub escape_url {
11313: my ($url) = @_;
1.238 raeburn 11314: my @urlslices = split(/\//, $url,-1);
1.369 www 11315: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 11316: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 11317: }
1.462 albertel 11318:
1.820 raeburn 11319: sub compare_arrays {
11320: my ($arrayref1,$arrayref2) = @_;
11321: my (@difference,%count);
11322: @difference = ();
11323: %count = ();
11324: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
11325: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
11326: foreach my $element (keys(%count)) {
11327: if ($count{$element} == 1) {
11328: push(@difference,$element);
11329: }
11330: }
11331: }
11332: return @difference;
11333: }
11334:
1.817 bisitz 11335: # -------------------------------------------------------- Initialize user login
1.462 albertel 11336: sub init_user_environment {
1.463 albertel 11337: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 11338: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
11339:
11340: my $public=($username eq 'public' && $domain eq 'public');
11341:
11342: # See if old ID present, if so, remove
11343:
11344: my ($filename,$cookie,$userroles);
11345: my $now=time;
11346:
11347: if ($public) {
11348: my $max_public=100;
11349: my $oldest;
11350: my $oldest_time=0;
11351: for(my $next=1;$next<=$max_public;$next++) {
11352: if (-e $lonids."/publicuser_$next.id") {
11353: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
11354: if ($mtime<$oldest_time || !$oldest_time) {
11355: $oldest_time=$mtime;
11356: $oldest=$next;
11357: }
11358: } else {
11359: $cookie="publicuser_$next";
11360: last;
11361: }
11362: }
11363: if (!$cookie) { $cookie="publicuser_$oldest"; }
11364: } else {
1.463 albertel 11365: # if this isn't a robot, kill any existing non-robot sessions
11366: if (!$args->{'robot'}) {
11367: opendir(DIR,$lonids);
11368: while ($filename=readdir(DIR)) {
11369: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
11370: unlink($lonids.'/'.$filename);
11371: }
1.462 albertel 11372: }
1.463 albertel 11373: closedir(DIR);
1.462 albertel 11374: }
11375: # Give them a new cookie
1.463 albertel 11376: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 11377: : $now.$$.int(rand(10000)));
1.463 albertel 11378: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 11379:
11380: # Initialize roles
11381:
11382: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
11383: }
11384: # ------------------------------------ Check browser type and MathML capability
11385:
11386: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
11387: $clientunicode,$clientos) = &decode_user_agent($r);
11388:
11389: # ------------------------------------------------------------- Get environment
11390:
11391: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
11392: my ($tmp) = keys(%userenv);
11393: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
11394: } else {
11395: undef(%userenv);
11396: }
11397: if (($userenv{'interface'}) && (!$form->{'interface'})) {
11398: $form->{'interface'}=$userenv{'interface'};
11399: }
11400: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
11401:
11402: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 11403: foreach my $option ('interface','localpath','localres') {
11404: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 11405: }
11406: # --------------------------------------------------------- Write first profile
11407:
11408: {
11409: my %initial_env =
11410: ("user.name" => $username,
11411: "user.domain" => $domain,
11412: "user.home" => $authhost,
11413: "browser.type" => $clientbrowser,
11414: "browser.version" => $clientversion,
11415: "browser.mathml" => $clientmathml,
11416: "browser.unicode" => $clientunicode,
11417: "browser.os" => $clientos,
11418: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
11419: "request.course.fn" => '',
11420: "request.course.uri" => '',
11421: "request.course.sec" => '',
11422: "request.role" => 'cm',
11423: "request.role.adv" => $env{'user.adv'},
11424: "request.host" => $ENV{'REMOTE_ADDR'},);
11425:
11426: if ($form->{'localpath'}) {
11427: $initial_env{"browser.localpath"} = $form->{'localpath'};
11428: $initial_env{"browser.localres"} = $form->{'localres'};
11429: }
11430:
11431: if ($form->{'interface'}) {
11432: $form->{'interface'}=~s/\W//gs;
11433: $initial_env{"browser.interface"} = $form->{'interface'};
11434: $env{'browser.interface'}=$form->{'interface'};
11435: }
11436:
1.981 raeburn 11437: my %is_adv = ( is_adv => $env{'user.adv'} );
1.1016 raeburn 11438: my %domdef;
11439: unless ($domain eq 'public') {
11440: %domdef = &Apache::lonnet::get_domain_defaults($domain);
11441: }
1.980 raeburn 11442:
1.724 raeburn 11443: foreach my $tool ('aboutme','blog','portfolio') {
11444: $userenv{'availabletools.'.$tool} =
1.980 raeburn 11445: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
11446: undef,\%userenv,\%domdef,\%is_adv);
1.724 raeburn 11447: }
11448:
1.864 raeburn 11449: foreach my $crstype ('official','unofficial','community') {
1.765 raeburn 11450: $userenv{'canrequest.'.$crstype} =
11451: &Apache::lonnet::usertools_access($username,$domain,$crstype,
1.980 raeburn 11452: 'reload','requestcourses',
11453: \%userenv,\%domdef,\%is_adv);
1.765 raeburn 11454: }
11455:
1.462 albertel 11456: $env{'user.environment'} = "$lonids/$cookie.id";
11457:
11458: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
11459: &GDBM_WRCREAT(),0640)) {
11460: &_add_to_env(\%disk_env,\%initial_env);
11461: &_add_to_env(\%disk_env,\%userenv,'environment.');
11462: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 11463: if (ref($args->{'extra_env'})) {
11464: &_add_to_env(\%disk_env,$args->{'extra_env'});
11465: }
1.462 albertel 11466: untie(%disk_env);
11467: } else {
1.705 tempelho 11468: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
11469: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 11470: return 'error: '.$!;
11471: }
11472: }
11473: $env{'request.role'}='cm';
11474: $env{'request.role.adv'}=$env{'user.adv'};
11475: $env{'browser.type'}=$clientbrowser;
11476:
11477: return $cookie;
11478:
11479: }
11480:
11481: sub _add_to_env {
11482: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 11483: if (ref($env_data) eq 'HASH') {
11484: while (my ($key,$value) = each(%$env_data)) {
11485: $idf->{$prefix.$key} = $value;
11486: $env{$prefix.$key} = $value;
11487: }
1.462 albertel 11488: }
11489: }
11490:
1.685 tempelho 11491: # --- Get the symbolic name of a problem and the url
11492: sub get_symb {
11493: my ($request,$silent) = @_;
1.726 raeburn 11494: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 11495: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
11496: if ($symb eq '') {
11497: if (!$silent) {
11498: $request->print("Unable to handle ambiguous references:$url:.");
11499: return ();
11500: }
11501: }
11502: &Apache::lonenc::check_decrypt(\$symb);
11503: return ($symb);
11504: }
11505:
11506: # --------------------------------------------------------------Get annotation
11507:
11508: sub get_annotation {
11509: my ($symb,$enc) = @_;
11510:
11511: my $key = $symb;
11512: if (!$enc) {
11513: $key =
11514: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
11515: }
11516: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
11517: return $annotation{$key};
11518: }
11519:
11520: sub clean_symb {
1.731 raeburn 11521: my ($symb,$delete_enc) = @_;
1.685 tempelho 11522:
11523: &Apache::lonenc::check_decrypt(\$symb);
11524: my $enc = $env{'request.enc'};
1.731 raeburn 11525: if ($delete_enc) {
1.730 raeburn 11526: delete($env{'request.enc'});
11527: }
1.685 tempelho 11528:
11529: return ($symb,$enc);
11530: }
1.462 albertel 11531:
1.990 raeburn 11532: sub build_release_hashes {
11533: my ($checkparms,$checkresponsetypes,$checkcrstypes,$anonsurvey,$randomizetry) = @_;
11534: return unless((ref($checkparms) eq 'HASH') && (ref($checkresponsetypes) eq 'HASH') &&
11535: (ref($checkcrstypes) eq 'HASH') && (ref($anonsurvey) eq 'HASH') &&
11536: (ref($randomizetry) eq 'HASH'));
11537: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
11538: my ($item,$name,$value) = split(/:/,$key);
11539: if ($item eq 'parameter') {
11540: if (ref($checkparms->{$name}) eq 'ARRAY') {
11541: unless(grep(/^\Q$name\E$/,@{$checkparms->{$name}})) {
11542: push(@{$checkparms->{$name}},$value);
11543: }
11544: } else {
11545: push(@{$checkparms->{$name}},$value);
11546: }
11547: } elsif ($item eq 'resourcetag') {
11548: if ($name eq 'responsetype') {
11549: $checkresponsetypes->{$value} = $Apache::lonnet::needsrelease{$key}
11550: }
11551: } elsif ($item eq 'course') {
11552: if ($name eq 'crstype') {
11553: $checkcrstypes->{$value} = $Apache::lonnet::needsrelease{$key};
11554: }
11555: }
11556: }
11557: ($anonsurvey->{major},$anonsurvey->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:anonsurvey'});
11558: ($randomizetry->{major},$randomizetry->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:randomizetry'});
11559: return;
11560: }
11561:
1.41 ng 11562: =pod
11563:
11564: =back
11565:
1.112 bowersj2 11566: =cut
1.41 ng 11567:
1.112 bowersj2 11568: 1;
11569: __END__;
1.41 ng 11570:
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