Annotation of loncom/interface/loncommon.pm, revision 1.1020
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1020 ! raeburn 4: # $Id: loncommon.pm,v 1.1019 2011/09/01 02:32:50 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: }
4449: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
4450: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4451: }
4452: return %legacyhash;
4453: }
4454:
1.63 www 4455: =pod
4456:
1.112 bowersj2 4457: =item * &domainlogo()
1.63 www 4458:
4459: Inputs: $domain (usually will be undef)
4460:
4461: Returns: A link to a domain logo, if the domain logo exists.
4462: If the domain logo does not exist, a description of the domain.
4463:
4464: =cut
1.112 bowersj2 4465:
1.63 www 4466: ###############################################
4467: sub domainlogo {
1.517 raeburn 4468: my $domain = &determinedomain(shift);
1.518 albertel 4469: my %designhash = &get_domainconf($domain);
1.517 raeburn 4470: # See if there is a logo
4471: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4472: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4473: if ($imgsrc =~ m{^/(adm|res)/}) {
4474: if ($imgsrc =~ m{^/res/}) {
4475: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4476: &Apache::lonnet::repcopy($local_name);
4477: }
4478: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4479: }
4480: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4481: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4482: return &Apache::lonnet::domain($domain,'description');
1.59 www 4483: } else {
1.60 matthew 4484: return '';
1.59 www 4485: }
4486: }
1.63 www 4487: ##############################################
4488:
4489: =pod
4490:
1.112 bowersj2 4491: =item * &designparm()
1.63 www 4492:
4493: Inputs: $which parameter; $domain (usually will be undef)
4494:
4495: Returns: value of designparamter $which
4496:
4497: =cut
1.112 bowersj2 4498:
1.397 albertel 4499:
1.400 albertel 4500: ##############################################
1.397 albertel 4501: sub designparm {
4502: my ($which,$domain)=@_;
4503: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 4504: return $env{'environment.color.'.$which};
1.96 www 4505: }
1.63 www 4506: $domain=&determinedomain($domain);
1.1016 raeburn 4507: my %domdesign;
4508: unless ($domain eq 'public') {
4509: %domdesign = &get_domainconf($domain);
4510: }
1.520 raeburn 4511: my $output;
1.517 raeburn 4512: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 4513: $output = $domdesign{$domain.'.'.$which};
1.63 www 4514: } else {
1.520 raeburn 4515: $output = $defaultdesign{$which};
4516: }
4517: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4518: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4519: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 4520: if ($output =~ m{^/res/}) {
4521: my $local_name = &Apache::lonnet::filelocation('',$output);
4522: &Apache::lonnet::repcopy($local_name);
4523: }
1.520 raeburn 4524: $output = &lonhttpdurl($output);
4525: }
1.63 www 4526: }
1.520 raeburn 4527: return $output;
1.63 www 4528: }
1.59 www 4529:
1.822 bisitz 4530: ##############################################
4531: =pod
4532:
1.832 bisitz 4533: =item * &authorspace()
4534:
4535: Inputs: ./.
4536:
4537: Returns: Path to the Construction Space of the current user's
4538: accessed author space
4539: The author space will be that of the current user
4540: when accessing the own author space
4541: and that of the co-author/assistent co-author
4542: when accessing the co-author's/assistent co-author's
4543: space
4544:
4545: =cut
4546:
4547: sub authorspace {
4548: my $caname = '';
4549: if ($env{'request.role'} =~ /^ca|^aa/) {
4550: (undef,$caname) =
4551: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
4552: } else {
4553: $caname = $env{'user.name'};
4554: }
4555: return '/priv/'.$caname.'/';
4556: }
4557:
4558: ##############################################
4559: =pod
4560:
1.822 bisitz 4561: =item * &head_subbox()
4562:
4563: Inputs: $content (contains HTML code with page functions, etc.)
4564:
4565: Returns: HTML div with $content
4566: To be included in page header
4567:
4568: =cut
4569:
4570: sub head_subbox {
4571: my ($content)=@_;
4572: my $output =
1.993 raeburn 4573: '<div class="LC_head_subbox">'
1.822 bisitz 4574: .$content
4575: .'</div>'
4576: }
4577:
4578: ##############################################
4579: =pod
4580:
4581: =item * &CSTR_pageheader()
4582:
4583: Inputs: ./.
4584:
4585: Returns: HTML div with CSTR path and recent box
4586: To be included on Construction Space pages
4587:
4588: =cut
4589:
4590: sub CSTR_pageheader {
4591: # this is for resources; directories have customtitle, and crumbs
4592: # and select recent are created in lonpubdir.pm
4593: my ($uname,$thisdisfn)=
4594: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
4595: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4596: $formaction=~s/\/+/\//g;
4597:
4598: my $parentpath = '';
4599: my $lastitem = '';
4600: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4601: $parentpath = $1;
4602: $lastitem = $2;
4603: } else {
4604: $lastitem = $thisdisfn;
4605: }
1.921 bisitz 4606:
4607: my $output =
1.822 bisitz 4608: '<div>'
4609: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
4610: .'<b>'.&mt('Construction Space:').'</b> '
4611: .'<form name="dirs" method="post" action="'.$formaction
1.921 bisitz 4612: .'" target="_top">' #FIXME lonpubdir: target="_parent"
4613: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv',undef,undef);
4614:
4615: if ($lastitem) {
4616: $output .=
4617: '<span class="LC_filename">'
4618: .$lastitem
4619: .'</span>';
4620: }
4621: $output .=
4622: '<br />'
1.822 bisitz 4623: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
4624: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4625: .'</form>'
4626: .&Apache::lonmenu::constspaceform()
4627: .'</div>';
1.921 bisitz 4628:
4629: return $output;
1.822 bisitz 4630: }
4631:
1.60 matthew 4632: ###############################################
4633: ###############################################
4634:
4635: =pod
4636:
1.112 bowersj2 4637: =back
4638:
1.549 albertel 4639: =head1 HTML Helpers
1.112 bowersj2 4640:
4641: =over 4
4642:
4643: =item * &bodytag()
1.60 matthew 4644:
4645: Returns a uniform header for LON-CAPA web pages.
4646:
4647: Inputs:
4648:
1.112 bowersj2 4649: =over 4
4650:
4651: =item * $title, A title to be displayed on the page.
4652:
4653: =item * $function, the current role (can be undef).
4654:
4655: =item * $addentries, extra parameters for the <body> tag.
4656:
4657: =item * $bodyonly, if defined, only return the <body> tag.
4658:
4659: =item * $domain, if defined, force a given domain.
4660:
4661: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4662: text interface only)
1.60 matthew 4663:
1.814 bisitz 4664: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
4665: navigational links
1.317 albertel 4666:
1.338 albertel 4667: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4668:
1.460 albertel 4669: =item * $args, optional argument valid values are
4670: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4671: inherit_jsmath -> when creating popup window in a page,
4672: should it have jsmath forced on by the
4673: current page
1.460 albertel 4674:
1.112 bowersj2 4675: =back
4676:
1.60 matthew 4677: Returns: A uniform header for LON-CAPA web pages.
4678: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4679: If $bodyonly is undef or zero, an html string containing a <body> tag and
4680: other decorations will be returned.
4681:
4682: =cut
4683:
1.54 www 4684: sub bodytag {
1.831 bisitz 4685: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.962 droeschl 4686: $no_nav_bar,$bgcolor,$args)=@_;
1.339 albertel 4687:
1.954 raeburn 4688: my $public;
4689: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
4690: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
4691: $public = 1;
4692: }
1.460 albertel 4693: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4694:
1.183 matthew 4695: $function = &get_users_function() if (!$function);
1.339 albertel 4696: my $img = &designparm($function.'.img',$domain);
4697: my $font = &designparm($function.'.font',$domain);
4698: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4699:
1.803 bisitz 4700: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 4701: 'bgcolor' => $pgbg,
1.339 albertel 4702: 'text' => $font,
4703: 'alink' => &designparm($function.'.alink',$domain),
4704: 'vlink' => &designparm($function.'.vlink',$domain),
4705: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4706: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4707:
1.63 www 4708: # role and realm
1.378 raeburn 4709: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4710: if ($role eq 'ca') {
1.479 albertel 4711: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4712: $realm = &plainname($rname,$rdom);
1.378 raeburn 4713: }
1.55 www 4714: # realm
1.258 albertel 4715: if ($env{'request.course.id'}) {
1.378 raeburn 4716: if ($env{'request.role'} !~ /^cr/) {
4717: $role = &Apache::lonnet::plaintext($role,&course_type());
4718: }
1.898 raeburn 4719: if ($env{'request.course.sec'}) {
4720: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
4721: }
1.359 albertel 4722: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4723: } else {
4724: $role = &Apache::lonnet::plaintext($role);
1.54 www 4725: }
1.433 albertel 4726:
1.359 albertel 4727: if (!$realm) { $realm=' '; }
1.330 albertel 4728:
1.438 albertel 4729: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4730:
1.101 www 4731: # construct main body tag
1.359 albertel 4732: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4733: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4734:
1.530 albertel 4735: if ($bodyonly) {
1.60 matthew 4736: return $bodytag;
1.798 tempelho 4737: }
1.359 albertel 4738:
1.410 albertel 4739: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.954 raeburn 4740: if ($public) {
1.433 albertel 4741: undef($role);
1.434 albertel 4742: } else {
4743: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4744: }
1.359 albertel 4745:
1.762 bisitz 4746: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 4747: #
4748: # Extra info if you are the DC
4749: my $dc_info = '';
4750: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4751: $env{'course.'.$env{'request.course.id'}.
4752: '.domain'}.'/'})) {
4753: my $cid = $env{'request.course.id'};
1.917 raeburn 4754: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4755: $dc_info =~ s/\s+$//;
1.359 albertel 4756: }
4757:
1.898 raeburn 4758: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853 droeschl 4759: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
4760:
1.916 droeschl 4761: if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') {
4762: return $bodytag;
4763: }
1.903 droeschl 4764:
4765: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
4766:
4767: # if ($env{'request.state'} eq 'construct') {
4768: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
4769: # }
4770:
1.359 albertel 4771:
4772:
1.916 droeschl 4773: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917 raeburn 4774: if ($dc_info) {
4775: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
4776: }
1.916 droeschl 4777: $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
4778: <em>$realm</em> $dc_info</div>|;
1.903 droeschl 4779: return $bodytag;
4780: }
1.894 droeschl 4781:
1.927 raeburn 4782: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
4783: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
4784: }
1.916 droeschl 4785:
1.903 droeschl 4786: $bodytag .= Apache::lonhtmlcommon::scripttag(
4787: Apache::lonmenu::utilityfunctions(), 'start');
1.816 bisitz 4788:
1.903 droeschl 4789: $bodytag .= Apache::lonmenu::primary_menu();
1.852 droeschl 4790:
1.917 raeburn 4791: if ($dc_info) {
4792: $dc_info = &dc_courseid_toggle($dc_info);
4793: }
4794: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 4795:
1.903 droeschl 4796: #don't show menus for public users
1.954 raeburn 4797: if (!$public){
1.903 droeschl 4798: $bodytag .= Apache::lonmenu::secondary_menu();
4799: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 4800: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
4801: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 4802: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.920 raeburn 4803: $args->{'bread_crumbs'});
4804: } elsif ($forcereg) {
4805: $bodytag .= &Apache::lonmenu::innerregister($forcereg);
4806: }
1.903 droeschl 4807: }else{
4808: # this is to seperate menu from content when there's no secondary
4809: # menu. Especially needed for public accessible ressources.
4810: $bodytag .= '<hr style="clear:both" />';
4811: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 4812: }
1.903 droeschl 4813:
1.235 raeburn 4814: return $bodytag;
1.182 matthew 4815: }
4816:
1.917 raeburn 4817: sub dc_courseid_toggle {
4818: my ($dc_info) = @_;
1.980 raeburn 4819: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.917 raeburn 4820: '<a href="javascript:showCourseID();">'.
4821: &mt('(More ...)').'</a></span>'.
4822: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
4823: }
4824:
1.330 albertel 4825: sub make_attr_string {
4826: my ($register,$attr_ref) = @_;
4827:
4828: if ($attr_ref && !ref($attr_ref)) {
4829: die("addentries Must be a hash ref ".
4830: join(':',caller(1))." ".
4831: join(':',caller(0))." ");
4832: }
4833:
4834: if ($register) {
1.339 albertel 4835: my ($on_load,$on_unload);
4836: foreach my $key (keys(%{$attr_ref})) {
4837: if (lc($key) eq 'onload') {
4838: $on_load.=$attr_ref->{$key}.';';
4839: delete($attr_ref->{$key});
4840:
4841: } elsif (lc($key) eq 'onunload') {
4842: $on_unload.=$attr_ref->{$key}.';';
4843: delete($attr_ref->{$key});
4844: }
4845: }
1.953 droeschl 4846: $attr_ref->{'onload'} = $on_load;
4847: $attr_ref->{'onunload'}= $on_unload;
1.330 albertel 4848: }
1.339 albertel 4849:
1.330 albertel 4850: my $attr_string;
4851: foreach my $attr (keys(%$attr_ref)) {
4852: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4853: }
4854: return $attr_string;
4855: }
4856:
4857:
1.182 matthew 4858: ###############################################
1.251 albertel 4859: ###############################################
4860:
4861: =pod
4862:
4863: =item * &endbodytag()
4864:
4865: Returns a uniform footer for LON-CAPA web pages.
4866:
1.635 raeburn 4867: Inputs: 1 - optional reference to an args hash
4868: If in the hash, key for noredirectlink has a value which evaluates to true,
4869: a 'Continue' link is not displayed if the page contains an
4870: internal redirect in the <head></head> section,
4871: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4872:
4873: =cut
4874:
4875: sub endbodytag {
1.635 raeburn 4876: my ($args) = @_;
1.251 albertel 4877: my $endbodytag='</body>';
1.269 albertel 4878: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4879: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4880: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4881: $endbodytag=
4882: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4883: &mt('Continue').'</a>'.
4884: $endbodytag;
4885: }
1.315 albertel 4886: }
1.251 albertel 4887: return $endbodytag;
4888: }
4889:
1.352 albertel 4890: =pod
4891:
4892: =item * &standard_css()
4893:
4894: Returns a style sheet
4895:
4896: Inputs: (all optional)
4897: domain -> force to color decorate a page for a specific
4898: domain
4899: function -> force usage of a specific rolish color scheme
4900: bgcolor -> override the default page bgcolor
4901:
4902: =cut
4903:
1.343 albertel 4904: sub standard_css {
1.345 albertel 4905: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4906: $function = &get_users_function() if (!$function);
4907: my $img = &designparm($function.'.img', $domain);
4908: my $tabbg = &designparm($function.'.tabbg', $domain);
4909: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 4910: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 4911: #second colour for later usage
1.345 albertel 4912: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4913: my $pgbg_or_bgcolor =
4914: $bgcolor ||
1.352 albertel 4915: &designparm($function.'.pgbg', $domain);
1.382 albertel 4916: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4917: my $alink = &designparm($function.'.alink', $domain);
4918: my $vlink = &designparm($function.'.vlink', $domain);
4919: my $link = &designparm($function.'.link', $domain);
4920:
1.602 albertel 4921: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4922: my $mono = 'monospace';
1.850 bisitz 4923: my $data_table_head = $sidebg;
4924: my $data_table_light = '#FAFAFA';
4925: my $data_table_dark = '#F0F0F0';
1.470 banghart 4926: my $data_table_darker = '#CCCCCC';
1.349 albertel 4927: my $data_table_highlight = '#FFFF00';
1.352 albertel 4928: my $mail_new = '#FFBB77';
4929: my $mail_new_hover = '#DD9955';
4930: my $mail_read = '#BBBB77';
4931: my $mail_read_hover = '#999944';
4932: my $mail_replied = '#AAAA88';
4933: my $mail_replied_hover = '#888855';
4934: my $mail_other = '#99BBBB';
4935: my $mail_other_hover = '#669999';
1.391 albertel 4936: my $table_header = '#DDDDDD';
1.489 raeburn 4937: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 4938: my $lg_border_color = '#C8C8C8';
1.952 onken 4939: my $button_hover = '#BF2317';
1.392 albertel 4940:
1.608 albertel 4941: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 4942: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
4943: : '0 3px 0 4px';
1.448 albertel 4944:
1.523 albertel 4945:
1.343 albertel 4946: return <<END;
1.947 droeschl 4947:
4948: /* needed for iframe to allow 100% height in FF */
4949: body, html {
4950: margin: 0;
4951: padding: 0 0.5%;
4952: height: 99%; /* to avoid scrollbars */
4953: }
4954:
1.795 www 4955: body {
1.911 bisitz 4956: font-family: $sans;
4957: line-height:130%;
4958: font-size:0.83em;
4959: color:$font;
1.795 www 4960: }
4961:
1.959 onken 4962: a:focus,
4963: a:focus img {
1.795 www 4964: color: red;
1.911 bisitz 4965: background: yellow;
1.795 www 4966: }
1.698 harmsja 4967:
1.911 bisitz 4968: form, .inline {
4969: display: inline;
1.795 www 4970: }
1.721 harmsja 4971:
1.795 www 4972: .LC_right {
1.911 bisitz 4973: text-align:right;
1.795 www 4974: }
4975:
4976: .LC_middle {
1.911 bisitz 4977: vertical-align:middle;
1.795 www 4978: }
1.721 harmsja 4979:
1.911 bisitz 4980: .LC_400Box {
4981: width:400px;
4982: }
1.721 harmsja 4983:
1.947 droeschl 4984: .LC_iframecontainer {
4985: width: 98%;
4986: margin: 0;
4987: position: fixed;
4988: top: 8.5em;
4989: bottom: 0;
4990: }
4991:
4992: .LC_iframecontainer iframe{
4993: border: none;
4994: width: 100%;
4995: height: 100%;
4996: }
4997:
1.778 bisitz 4998: .LC_filename {
4999: font-family: $mono;
5000: white-space:pre;
1.921 bisitz 5001: font-size: 120%;
1.778 bisitz 5002: }
5003:
5004: .LC_fileicon {
5005: border: none;
5006: height: 1.3em;
5007: vertical-align: text-bottom;
5008: margin-right: 0.3em;
5009: text-decoration:none;
5010: }
5011:
1.1008 www 5012: .LC_setting {
5013: text-decoration:underline;
5014: }
5015:
1.350 albertel 5016: .LC_error {
5017: color: red;
5018: font-size: larger;
5019: }
1.795 www 5020:
1.457 albertel 5021: .LC_warning,
5022: .LC_diff_removed {
1.733 bisitz 5023: color: red;
1.394 albertel 5024: }
1.532 albertel 5025:
5026: .LC_info,
1.457 albertel 5027: .LC_success,
5028: .LC_diff_added {
1.350 albertel 5029: color: green;
5030: }
1.795 www 5031:
1.802 bisitz 5032: div.LC_confirm_box {
5033: background-color: #FAFAFA;
5034: border: 1px solid $lg_border_color;
5035: margin-right: 0;
5036: padding: 5px;
5037: }
5038:
5039: div.LC_confirm_box .LC_error img,
5040: div.LC_confirm_box .LC_success img {
5041: vertical-align: middle;
5042: }
5043:
1.440 albertel 5044: .LC_icon {
1.771 droeschl 5045: border: none;
1.790 droeschl 5046: vertical-align: middle;
1.771 droeschl 5047: }
5048:
1.543 albertel 5049: .LC_docs_spacer {
5050: width: 25px;
5051: height: 1px;
1.771 droeschl 5052: border: none;
1.543 albertel 5053: }
1.346 albertel 5054:
1.532 albertel 5055: .LC_internal_info {
1.735 bisitz 5056: color: #999999;
1.532 albertel 5057: }
5058:
1.794 www 5059: .LC_discussion {
1.911 bisitz 5060: background: $tabbg;
5061: border: 1px solid black;
5062: margin: 2px;
1.794 www 5063: }
5064:
5065: .LC_disc_action_links_bar {
1.911 bisitz 5066: background: $tabbg;
5067: border: none;
5068: margin: 4px;
1.794 www 5069: }
5070:
5071: .LC_disc_action_left {
1.911 bisitz 5072: text-align: left;
1.794 www 5073: }
5074:
5075: .LC_disc_action_right {
1.911 bisitz 5076: text-align: right;
1.794 www 5077: }
5078:
5079: .LC_disc_new_item {
1.911 bisitz 5080: background: white;
5081: border: 2px solid red;
5082: margin: 2px;
1.794 www 5083: }
5084:
5085: .LC_disc_old_item {
1.911 bisitz 5086: background: white;
5087: border: 1px solid black;
5088: margin: 2px;
1.794 www 5089: }
5090:
1.458 albertel 5091: table.LC_pastsubmission {
5092: border: 1px solid black;
5093: margin: 2px;
5094: }
5095:
1.924 bisitz 5096: table#LC_menubuttons {
1.345 albertel 5097: width: 100%;
5098: background: $pgbg;
1.392 albertel 5099: border: 2px;
1.402 albertel 5100: border-collapse: separate;
1.803 bisitz 5101: padding: 0;
1.345 albertel 5102: }
1.392 albertel 5103:
1.801 tempelho 5104: table#LC_title_bar a {
5105: color: $fontmenu;
5106: }
1.836 bisitz 5107:
1.807 droeschl 5108: table#LC_title_bar {
1.819 tempelho 5109: clear: both;
1.836 bisitz 5110: display: none;
1.807 droeschl 5111: }
5112:
1.795 www 5113: table#LC_title_bar,
1.933 droeschl 5114: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 5115: table#LC_title_bar.LC_with_remote {
1.359 albertel 5116: width: 100%;
1.392 albertel 5117: border-color: $pgbg;
5118: border-style: solid;
5119: border-width: $border;
1.379 albertel 5120: background: $pgbg;
1.801 tempelho 5121: color: $fontmenu;
1.392 albertel 5122: border-collapse: collapse;
1.803 bisitz 5123: padding: 0;
1.819 tempelho 5124: margin: 0;
1.359 albertel 5125: }
1.795 www 5126:
1.933 droeschl 5127: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 5128: margin: 0;
5129: padding: 0;
1.933 droeschl 5130: position: relative;
5131: list-style: none;
1.913 droeschl 5132: }
1.933 droeschl 5133: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 5134: display: inline;
5135: }
1.933 droeschl 5136:
5137: .LC_breadcrumb_tools_navigation {
1.913 droeschl 5138: padding: 0;
1.933 droeschl 5139: margin: 0;
5140: float: left;
1.913 droeschl 5141: }
1.933 droeschl 5142: .LC_breadcrumb_tools_tools {
5143: padding: 0;
5144: margin: 0;
1.913 droeschl 5145: float: right;
5146: }
5147:
1.359 albertel 5148: table#LC_title_bar td {
5149: background: $tabbg;
5150: }
1.795 www 5151:
1.911 bisitz 5152: table#LC_menubuttons img {
1.803 bisitz 5153: border: none;
1.346 albertel 5154: }
1.795 www 5155:
1.842 droeschl 5156: .LC_breadcrumbs_component {
1.911 bisitz 5157: float: right;
5158: margin: 0 1em;
1.357 albertel 5159: }
1.842 droeschl 5160: .LC_breadcrumbs_component img {
1.911 bisitz 5161: vertical-align: middle;
1.777 tempelho 5162: }
1.795 www 5163:
1.383 albertel 5164: td.LC_table_cell_checkbox {
5165: text-align: center;
5166: }
1.795 www 5167:
5168: .LC_fontsize_small {
1.911 bisitz 5169: font-size: 70%;
1.705 tempelho 5170: }
5171:
1.844 bisitz 5172: #LC_breadcrumbs {
1.911 bisitz 5173: clear:both;
5174: background: $sidebg;
5175: border-bottom: 1px solid $lg_border_color;
5176: line-height: 2.5em;
1.933 droeschl 5177: overflow: hidden;
1.911 bisitz 5178: margin: 0;
5179: padding: 0;
1.995 raeburn 5180: text-align: left;
1.819 tempelho 5181: }
1.862 bisitz 5182:
1.993 raeburn 5183: .LC_head_subbox {
1.911 bisitz 5184: clear:both;
5185: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 5186: border: 1px solid $sidebg;
5187: margin: 0 0 10px 0;
1.966 bisitz 5188: padding: 3px;
1.995 raeburn 5189: text-align: left;
1.822 bisitz 5190: }
5191:
1.795 www 5192: .LC_fontsize_medium {
1.911 bisitz 5193: font-size: 85%;
1.705 tempelho 5194: }
5195:
1.795 www 5196: .LC_fontsize_large {
1.911 bisitz 5197: font-size: 120%;
1.705 tempelho 5198: }
5199:
1.346 albertel 5200: .LC_menubuttons_inline_text {
5201: color: $font;
1.698 harmsja 5202: font-size: 90%;
1.701 harmsja 5203: padding-left:3px;
1.346 albertel 5204: }
5205:
1.934 droeschl 5206: .LC_menubuttons_inline_text img{
5207: vertical-align: middle;
5208: }
5209:
1.951 onken 5210: li.LC_menubuttons_inline_text img,a {
5211: cursor:pointer;
1.1002 droeschl 5212: text-decoration: none;
1.951 onken 5213: }
5214:
1.526 www 5215: .LC_menubuttons_link {
5216: text-decoration: none;
5217: }
1.795 www 5218:
1.522 albertel 5219: .LC_menubuttons_category {
1.521 www 5220: color: $font;
1.526 www 5221: background: $pgbg;
1.521 www 5222: font-size: larger;
5223: font-weight: bold;
5224: }
5225:
1.346 albertel 5226: td.LC_menubuttons_text {
1.911 bisitz 5227: color: $font;
1.346 albertel 5228: }
1.706 harmsja 5229:
1.346 albertel 5230: .LC_current_location {
5231: background: $tabbg;
5232: }
1.795 www 5233:
1.938 bisitz 5234: table.LC_data_table {
1.347 albertel 5235: border: 1px solid #000000;
1.402 albertel 5236: border-collapse: separate;
1.426 albertel 5237: border-spacing: 1px;
1.610 albertel 5238: background: $pgbg;
1.347 albertel 5239: }
1.795 www 5240:
1.422 albertel 5241: .LC_data_table_dense {
5242: font-size: small;
5243: }
1.795 www 5244:
1.507 raeburn 5245: table.LC_nested_outer {
5246: border: 1px solid #000000;
1.589 raeburn 5247: border-collapse: collapse;
1.803 bisitz 5248: border-spacing: 0;
1.507 raeburn 5249: width: 100%;
5250: }
1.795 www 5251:
1.879 raeburn 5252: table.LC_innerpickbox,
1.507 raeburn 5253: table.LC_nested {
1.803 bisitz 5254: border: none;
1.589 raeburn 5255: border-collapse: collapse;
1.803 bisitz 5256: border-spacing: 0;
1.507 raeburn 5257: width: 100%;
5258: }
1.795 www 5259:
1.911 bisitz 5260: table.LC_data_table tr th,
5261: table.LC_calendar tr th,
1.879 raeburn 5262: table.LC_prior_tries tr th,
5263: table.LC_innerpickbox tr th {
1.349 albertel 5264: font-weight: bold;
5265: background-color: $data_table_head;
1.801 tempelho 5266: color:$fontmenu;
1.701 harmsja 5267: font-size:90%;
1.347 albertel 5268: }
1.795 www 5269:
1.879 raeburn 5270: table.LC_innerpickbox tr th,
5271: table.LC_innerpickbox tr td {
5272: vertical-align: top;
5273: }
5274:
1.711 raeburn 5275: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 5276: background-color: #CCCCCC;
1.711 raeburn 5277: font-weight: bold;
5278: text-align: left;
5279: }
1.795 www 5280:
1.912 bisitz 5281: table.LC_data_table tr.LC_odd_row > td {
5282: background-color: $data_table_light;
5283: padding: 2px;
5284: vertical-align: top;
5285: }
5286:
1.809 bisitz 5287: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 5288: background-color: $data_table_light;
1.912 bisitz 5289: vertical-align: top;
5290: }
5291:
5292: table.LC_data_table tr.LC_even_row > td {
5293: background-color: $data_table_dark;
1.425 albertel 5294: padding: 2px;
1.900 bisitz 5295: vertical-align: top;
1.347 albertel 5296: }
1.795 www 5297:
1.809 bisitz 5298: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 5299: background-color: $data_table_dark;
1.900 bisitz 5300: vertical-align: top;
1.347 albertel 5301: }
1.795 www 5302:
1.425 albertel 5303: table.LC_data_table tr.LC_data_table_highlight td {
5304: background-color: $data_table_darker;
5305: }
1.795 www 5306:
1.639 raeburn 5307: table.LC_data_table tr td.LC_leftcol_header {
5308: background-color: $data_table_head;
5309: font-weight: bold;
5310: }
1.795 www 5311:
1.451 albertel 5312: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5313: table.LC_nested tr.LC_empty_row td {
1.421 albertel 5314: font-weight: bold;
5315: font-style: italic;
5316: text-align: center;
5317: padding: 8px;
1.347 albertel 5318: }
1.795 www 5319:
1.940 bisitz 5320: table.LC_data_table tr.LC_empty_row td {
5321: background-color: $sidebg;
5322: }
5323:
5324: table.LC_nested tr.LC_empty_row td {
5325: background-color: #FFFFFF;
5326: }
5327:
1.890 droeschl 5328: table.LC_caption {
5329: }
5330:
1.507 raeburn 5331: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5332: padding: 4ex
5333: }
1.795 www 5334:
1.507 raeburn 5335: table.LC_nested_outer tr th {
5336: font-weight: bold;
1.801 tempelho 5337: color:$fontmenu;
1.507 raeburn 5338: background-color: $data_table_head;
1.701 harmsja 5339: font-size: small;
1.507 raeburn 5340: border-bottom: 1px solid #000000;
5341: }
1.795 www 5342:
1.507 raeburn 5343: table.LC_nested_outer tr td.LC_subheader {
5344: background-color: $data_table_head;
5345: font-weight: bold;
5346: font-size: small;
5347: border-bottom: 1px solid #000000;
5348: text-align: right;
1.451 albertel 5349: }
1.795 www 5350:
1.507 raeburn 5351: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5352: background-color: #CCCCCC;
1.451 albertel 5353: font-weight: bold;
5354: font-size: small;
1.507 raeburn 5355: text-align: center;
5356: }
1.795 www 5357:
1.589 raeburn 5358: table.LC_nested tr.LC_info_row td.LC_left_item,
5359: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5360: text-align: left;
1.451 albertel 5361: }
1.795 www 5362:
1.507 raeburn 5363: table.LC_nested td {
1.735 bisitz 5364: background-color: #FFFFFF;
1.451 albertel 5365: font-size: small;
1.507 raeburn 5366: }
1.795 www 5367:
1.507 raeburn 5368: table.LC_nested_outer tr th.LC_right_item,
5369: table.LC_nested tr.LC_info_row td.LC_right_item,
5370: table.LC_nested tr.LC_odd_row td.LC_right_item,
5371: table.LC_nested tr td.LC_right_item {
1.451 albertel 5372: text-align: right;
5373: }
5374:
1.507 raeburn 5375: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5376: background-color: #EEEEEE;
1.451 albertel 5377: }
5378:
1.473 raeburn 5379: table.LC_createuser {
5380: }
5381:
5382: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5383: font-size: small;
1.473 raeburn 5384: }
5385:
5386: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5387: background-color: #CCCCCC;
1.473 raeburn 5388: font-weight: bold;
5389: text-align: center;
5390: }
5391:
1.349 albertel 5392: table.LC_calendar {
5393: border: 1px solid #000000;
5394: border-collapse: collapse;
1.917 raeburn 5395: width: 98%;
1.349 albertel 5396: }
1.795 www 5397:
1.349 albertel 5398: table.LC_calendar_pickdate {
5399: font-size: xx-small;
5400: }
1.795 www 5401:
1.349 albertel 5402: table.LC_calendar tr td {
5403: border: 1px solid #000000;
5404: vertical-align: top;
1.917 raeburn 5405: width: 14%;
1.349 albertel 5406: }
1.795 www 5407:
1.349 albertel 5408: table.LC_calendar tr td.LC_calendar_day_empty {
5409: background-color: $data_table_dark;
5410: }
1.795 www 5411:
1.779 bisitz 5412: table.LC_calendar tr td.LC_calendar_day_current {
5413: background-color: $data_table_highlight;
1.777 tempelho 5414: }
1.795 www 5415:
1.938 bisitz 5416: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 5417: background-color: $mail_new;
5418: }
1.795 www 5419:
1.938 bisitz 5420: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 5421: background-color: $mail_new_hover;
5422: }
1.795 www 5423:
1.938 bisitz 5424: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 5425: background-color: $mail_read;
5426: }
1.795 www 5427:
1.938 bisitz 5428: /*
5429: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 5430: background-color: $mail_read_hover;
5431: }
1.938 bisitz 5432: */
1.795 www 5433:
1.938 bisitz 5434: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 5435: background-color: $mail_replied;
5436: }
1.795 www 5437:
1.938 bisitz 5438: /*
5439: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 5440: background-color: $mail_replied_hover;
5441: }
1.938 bisitz 5442: */
1.795 www 5443:
1.938 bisitz 5444: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 5445: background-color: $mail_other;
5446: }
1.795 www 5447:
1.938 bisitz 5448: /*
5449: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 5450: background-color: $mail_other_hover;
5451: }
1.938 bisitz 5452: */
1.494 raeburn 5453:
1.777 tempelho 5454: table.LC_data_table tr > td.LC_browser_file,
5455: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 5456: background: #AAEE77;
1.389 albertel 5457: }
1.795 www 5458:
1.777 tempelho 5459: table.LC_data_table tr > td.LC_browser_file_locked,
5460: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5461: background: #FFAA99;
1.387 albertel 5462: }
1.795 www 5463:
1.777 tempelho 5464: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 5465: background: #888888;
1.779 bisitz 5466: }
1.795 www 5467:
1.777 tempelho 5468: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5469: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 5470: background: #F8F866;
1.777 tempelho 5471: }
1.795 www 5472:
1.696 bisitz 5473: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 5474: background: #E0E8FF;
1.387 albertel 5475: }
1.696 bisitz 5476:
1.707 bisitz 5477: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 5478: /* background: #77FF77; */
1.707 bisitz 5479: }
1.795 www 5480:
1.707 bisitz 5481: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 5482: border-right: 8px solid #FFFF77;
1.707 bisitz 5483: }
1.795 www 5484:
1.707 bisitz 5485: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 5486: border-right: 8px solid #FFAA77;
1.707 bisitz 5487: }
1.795 www 5488:
1.707 bisitz 5489: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 5490: border-right: 8px solid #FF7777;
1.707 bisitz 5491: }
1.795 www 5492:
1.707 bisitz 5493: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 5494: border-right: 8px solid #AAFF77;
1.707 bisitz 5495: }
1.795 www 5496:
1.707 bisitz 5497: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 5498: border-right: 8px solid #11CC55;
1.707 bisitz 5499: }
5500:
1.388 albertel 5501: span.LC_current_location {
1.701 harmsja 5502: font-size:larger;
1.388 albertel 5503: background: $pgbg;
5504: }
1.387 albertel 5505:
1.395 albertel 5506: span.LC_parm_menu_item {
5507: font-size: larger;
5508: }
1.795 www 5509:
1.395 albertel 5510: span.LC_parm_scope_all {
5511: color: red;
5512: }
1.795 www 5513:
1.395 albertel 5514: span.LC_parm_scope_folder {
5515: color: green;
5516: }
1.795 www 5517:
1.395 albertel 5518: span.LC_parm_scope_resource {
5519: color: orange;
5520: }
1.795 www 5521:
1.395 albertel 5522: span.LC_parm_part {
5523: color: blue;
5524: }
1.795 www 5525:
1.911 bisitz 5526: span.LC_parm_folder,
5527: span.LC_parm_symb {
1.395 albertel 5528: font-size: x-small;
5529: font-family: $mono;
5530: color: #AAAAAA;
5531: }
5532:
1.977 bisitz 5533: ul.LC_parm_parmlist li {
5534: display: inline-block;
5535: padding: 0.3em 0.8em;
5536: vertical-align: top;
5537: width: 150px;
5538: border-top:1px solid $lg_border_color;
5539: }
5540:
1.795 www 5541: td.LC_parm_overview_level_menu,
5542: td.LC_parm_overview_map_menu,
5543: td.LC_parm_overview_parm_selectors,
5544: td.LC_parm_overview_restrictions {
1.396 albertel 5545: border: 1px solid black;
5546: border-collapse: collapse;
5547: }
1.795 www 5548:
1.396 albertel 5549: table.LC_parm_overview_restrictions td {
5550: border-width: 1px 4px 1px 4px;
5551: border-style: solid;
5552: border-color: $pgbg;
5553: text-align: center;
5554: }
1.795 www 5555:
1.396 albertel 5556: table.LC_parm_overview_restrictions th {
5557: background: $tabbg;
5558: border-width: 1px 4px 1px 4px;
5559: border-style: solid;
5560: border-color: $pgbg;
5561: }
1.795 www 5562:
1.398 albertel 5563: table#LC_helpmenu {
1.803 bisitz 5564: border: none;
1.398 albertel 5565: height: 55px;
1.803 bisitz 5566: border-spacing: 0;
1.398 albertel 5567: }
5568:
5569: table#LC_helpmenu fieldset legend {
5570: font-size: larger;
5571: }
1.795 www 5572:
1.397 albertel 5573: table#LC_helpmenu_links {
5574: width: 100%;
5575: border: 1px solid black;
5576: background: $pgbg;
1.803 bisitz 5577: padding: 0;
1.397 albertel 5578: border-spacing: 1px;
5579: }
1.795 www 5580:
1.397 albertel 5581: table#LC_helpmenu_links tr td {
5582: padding: 1px;
5583: background: $tabbg;
1.399 albertel 5584: text-align: center;
5585: font-weight: bold;
1.397 albertel 5586: }
1.396 albertel 5587:
1.795 www 5588: table#LC_helpmenu_links a:link,
5589: table#LC_helpmenu_links a:visited,
1.397 albertel 5590: table#LC_helpmenu_links a:active {
5591: text-decoration: none;
5592: color: $font;
5593: }
1.795 www 5594:
1.397 albertel 5595: table#LC_helpmenu_links a:hover {
5596: text-decoration: underline;
5597: color: $vlink;
5598: }
1.396 albertel 5599:
1.417 albertel 5600: .LC_chrt_popup_exists {
5601: border: 1px solid #339933;
5602: margin: -1px;
5603: }
1.795 www 5604:
1.417 albertel 5605: .LC_chrt_popup_up {
5606: border: 1px solid yellow;
5607: margin: -1px;
5608: }
1.795 www 5609:
1.417 albertel 5610: .LC_chrt_popup {
5611: border: 1px solid #8888FF;
5612: background: #CCCCFF;
5613: }
1.795 www 5614:
1.421 albertel 5615: table.LC_pick_box {
5616: border-collapse: separate;
5617: background: white;
5618: border: 1px solid black;
5619: border-spacing: 1px;
5620: }
1.795 www 5621:
1.421 albertel 5622: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 5623: background: $sidebg;
1.421 albertel 5624: font-weight: bold;
1.900 bisitz 5625: text-align: left;
1.740 bisitz 5626: vertical-align: top;
1.421 albertel 5627: width: 184px;
5628: padding: 8px;
5629: }
1.795 www 5630:
1.579 raeburn 5631: table.LC_pick_box td.LC_pick_box_value {
5632: text-align: left;
5633: padding: 8px;
5634: }
1.795 www 5635:
1.579 raeburn 5636: table.LC_pick_box td.LC_pick_box_select {
5637: text-align: left;
5638: padding: 8px;
5639: }
1.795 www 5640:
1.424 albertel 5641: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 5642: padding: 0;
1.421 albertel 5643: height: 1px;
5644: background: black;
5645: }
1.795 www 5646:
1.421 albertel 5647: table.LC_pick_box td.LC_pick_box_submit {
5648: text-align: right;
5649: }
1.795 www 5650:
1.579 raeburn 5651: table.LC_pick_box td.LC_evenrow_value {
5652: text-align: left;
5653: padding: 8px;
5654: background-color: $data_table_light;
5655: }
1.795 www 5656:
1.579 raeburn 5657: table.LC_pick_box td.LC_oddrow_value {
5658: text-align: left;
5659: padding: 8px;
5660: background-color: $data_table_light;
5661: }
1.795 www 5662:
1.579 raeburn 5663: span.LC_helpform_receipt_cat {
5664: font-weight: bold;
5665: }
1.795 www 5666:
1.424 albertel 5667: table.LC_group_priv_box {
5668: background: white;
5669: border: 1px solid black;
5670: border-spacing: 1px;
5671: }
1.795 www 5672:
1.424 albertel 5673: table.LC_group_priv_box td.LC_pick_box_title {
5674: background: $tabbg;
5675: font-weight: bold;
5676: text-align: right;
5677: width: 184px;
5678: }
1.795 www 5679:
1.424 albertel 5680: table.LC_group_priv_box td.LC_groups_fixed {
5681: background: $data_table_light;
5682: text-align: center;
5683: }
1.795 www 5684:
1.424 albertel 5685: table.LC_group_priv_box td.LC_groups_optional {
5686: background: $data_table_dark;
5687: text-align: center;
5688: }
1.795 www 5689:
1.424 albertel 5690: table.LC_group_priv_box td.LC_groups_functionality {
5691: background: $data_table_darker;
5692: text-align: center;
5693: font-weight: bold;
5694: }
1.795 www 5695:
1.424 albertel 5696: table.LC_group_priv td {
5697: text-align: left;
1.803 bisitz 5698: padding: 0;
1.424 albertel 5699: }
5700:
5701: .LC_navbuttons {
5702: margin: 2ex 0ex 2ex 0ex;
5703: }
1.795 www 5704:
1.423 albertel 5705: .LC_topic_bar {
5706: font-weight: bold;
5707: background: $tabbg;
1.918 wenzelju 5708: margin: 1em 0em 1em 2em;
1.805 bisitz 5709: padding: 3px;
1.918 wenzelju 5710: font-size: 1.2em;
1.423 albertel 5711: }
1.795 www 5712:
1.423 albertel 5713: .LC_topic_bar span {
1.918 wenzelju 5714: left: 0.5em;
5715: position: absolute;
1.423 albertel 5716: vertical-align: middle;
1.918 wenzelju 5717: font-size: 1.2em;
1.423 albertel 5718: }
1.795 www 5719:
1.423 albertel 5720: table.LC_course_group_status {
5721: margin: 20px;
5722: }
1.795 www 5723:
1.423 albertel 5724: table.LC_status_selector td {
5725: vertical-align: top;
5726: text-align: center;
1.424 albertel 5727: padding: 4px;
5728: }
1.795 www 5729:
1.599 albertel 5730: div.LC_feedback_link {
1.616 albertel 5731: clear: both;
1.829 kalberla 5732: background: $sidebg;
1.779 bisitz 5733: width: 100%;
1.829 kalberla 5734: padding-bottom: 10px;
5735: border: 1px $tabbg solid;
1.833 kalberla 5736: height: 22px;
5737: line-height: 22px;
5738: padding-top: 5px;
5739: }
5740:
5741: div.LC_feedback_link img {
5742: height: 22px;
1.867 kalberla 5743: vertical-align:middle;
1.829 kalberla 5744: }
5745:
1.911 bisitz 5746: div.LC_feedback_link a {
1.829 kalberla 5747: text-decoration: none;
1.489 raeburn 5748: }
1.795 www 5749:
1.867 kalberla 5750: div.LC_comblock {
1.911 bisitz 5751: display:inline;
1.867 kalberla 5752: color:$font;
5753: font-size:90%;
5754: }
5755:
5756: div.LC_feedback_link div.LC_comblock {
5757: padding-left:5px;
5758: }
5759:
5760: div.LC_feedback_link div.LC_comblock a {
5761: color:$font;
5762: }
5763:
1.489 raeburn 5764: span.LC_feedback_link {
1.858 bisitz 5765: /* background: $feedback_link_bg; */
1.599 albertel 5766: font-size: larger;
5767: }
1.795 www 5768:
1.599 albertel 5769: span.LC_message_link {
1.858 bisitz 5770: /* background: $feedback_link_bg; */
1.599 albertel 5771: font-size: larger;
5772: position: absolute;
5773: right: 1em;
1.489 raeburn 5774: }
1.421 albertel 5775:
1.515 albertel 5776: table.LC_prior_tries {
1.524 albertel 5777: border: 1px solid #000000;
5778: border-collapse: separate;
5779: border-spacing: 1px;
1.515 albertel 5780: }
1.523 albertel 5781:
1.515 albertel 5782: table.LC_prior_tries td {
1.524 albertel 5783: padding: 2px;
1.515 albertel 5784: }
1.523 albertel 5785:
5786: .LC_answer_correct {
1.795 www 5787: background: lightgreen;
5788: color: darkgreen;
5789: padding: 6px;
1.523 albertel 5790: }
1.795 www 5791:
1.523 albertel 5792: .LC_answer_charged_try {
1.797 www 5793: background: #FFAAAA;
1.795 www 5794: color: darkred;
5795: padding: 6px;
1.523 albertel 5796: }
1.795 www 5797:
1.779 bisitz 5798: .LC_answer_not_charged_try,
1.523 albertel 5799: .LC_answer_no_grade,
5800: .LC_answer_late {
1.795 www 5801: background: lightyellow;
1.523 albertel 5802: color: black;
1.795 www 5803: padding: 6px;
1.523 albertel 5804: }
1.795 www 5805:
1.523 albertel 5806: .LC_answer_previous {
1.795 www 5807: background: lightblue;
5808: color: darkblue;
5809: padding: 6px;
1.523 albertel 5810: }
1.795 www 5811:
1.779 bisitz 5812: .LC_answer_no_message {
1.777 tempelho 5813: background: #FFFFFF;
5814: color: black;
1.795 www 5815: padding: 6px;
1.779 bisitz 5816: }
1.795 www 5817:
1.779 bisitz 5818: .LC_answer_unknown {
5819: background: orange;
5820: color: black;
1.795 www 5821: padding: 6px;
1.777 tempelho 5822: }
1.795 www 5823:
1.529 albertel 5824: span.LC_prior_numerical,
5825: span.LC_prior_string,
5826: span.LC_prior_custom,
5827: span.LC_prior_reaction,
5828: span.LC_prior_math {
1.925 bisitz 5829: font-family: $mono;
1.523 albertel 5830: white-space: pre;
5831: }
5832:
1.525 albertel 5833: span.LC_prior_string {
1.925 bisitz 5834: font-family: $mono;
1.525 albertel 5835: white-space: pre;
5836: }
5837:
1.523 albertel 5838: table.LC_prior_option {
5839: width: 100%;
5840: border-collapse: collapse;
5841: }
1.795 www 5842:
1.911 bisitz 5843: table.LC_prior_rank,
1.795 www 5844: table.LC_prior_match {
1.528 albertel 5845: border-collapse: collapse;
5846: }
1.795 www 5847:
1.528 albertel 5848: table.LC_prior_option tr td,
5849: table.LC_prior_rank tr td,
5850: table.LC_prior_match tr td {
1.524 albertel 5851: border: 1px solid #000000;
1.515 albertel 5852: }
5853:
1.855 bisitz 5854: .LC_nobreak {
1.544 albertel 5855: white-space: nowrap;
1.519 raeburn 5856: }
5857:
1.576 raeburn 5858: span.LC_cusr_emph {
5859: font-style: italic;
5860: }
5861:
1.633 raeburn 5862: span.LC_cusr_subheading {
5863: font-weight: normal;
5864: font-size: 85%;
5865: }
5866:
1.861 bisitz 5867: div.LC_docs_entry_move {
1.859 bisitz 5868: border: 1px solid #BBBBBB;
1.545 albertel 5869: background: #DDDDDD;
1.861 bisitz 5870: width: 22px;
1.859 bisitz 5871: padding: 1px;
5872: margin: 0;
1.545 albertel 5873: }
5874:
1.861 bisitz 5875: table.LC_data_table tr > td.LC_docs_entry_commands,
5876: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 5877: background: #DDDDDD;
5878: font-size: x-small;
5879: }
1.795 www 5880:
1.861 bisitz 5881: .LC_docs_entry_parameter {
5882: white-space: nowrap;
5883: }
5884:
1.544 albertel 5885: .LC_docs_copy {
1.545 albertel 5886: color: #000099;
1.544 albertel 5887: }
1.795 www 5888:
1.544 albertel 5889: .LC_docs_cut {
1.545 albertel 5890: color: #550044;
1.544 albertel 5891: }
1.795 www 5892:
1.544 albertel 5893: .LC_docs_rename {
1.545 albertel 5894: color: #009900;
1.544 albertel 5895: }
1.795 www 5896:
1.544 albertel 5897: .LC_docs_remove {
1.545 albertel 5898: color: #990000;
5899: }
5900:
1.547 albertel 5901: .LC_docs_reinit_warn,
5902: .LC_docs_ext_edit {
5903: font-size: x-small;
5904: }
5905:
1.545 albertel 5906: table.LC_docs_adddocs td,
5907: table.LC_docs_adddocs th {
5908: border: 1px solid #BBBBBB;
5909: padding: 4px;
5910: background: #DDDDDD;
1.543 albertel 5911: }
5912:
1.584 albertel 5913: table.LC_sty_begin {
5914: background: #BBFFBB;
5915: }
1.795 www 5916:
1.584 albertel 5917: table.LC_sty_end {
5918: background: #FFBBBB;
5919: }
5920:
1.589 raeburn 5921: table.LC_double_column {
1.803 bisitz 5922: border-width: 0;
1.589 raeburn 5923: border-collapse: collapse;
5924: width: 100%;
5925: padding: 2px;
5926: }
5927:
5928: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5929: top: 2px;
1.589 raeburn 5930: left: 2px;
5931: width: 47%;
5932: vertical-align: top;
5933: }
5934:
5935: table.LC_double_column tr td.LC_right_col {
5936: top: 2px;
1.779 bisitz 5937: right: 2px;
1.589 raeburn 5938: width: 47%;
5939: vertical-align: top;
5940: }
5941:
1.591 raeburn 5942: div.LC_left_float {
5943: float: left;
5944: padding-right: 5%;
1.597 albertel 5945: padding-bottom: 4px;
1.591 raeburn 5946: }
5947:
5948: div.LC_clear_float_header {
1.597 albertel 5949: padding-bottom: 2px;
1.591 raeburn 5950: }
5951:
5952: div.LC_clear_float_footer {
1.597 albertel 5953: padding-top: 10px;
1.591 raeburn 5954: clear: both;
5955: }
5956:
1.597 albertel 5957: div.LC_grade_show_user {
1.941 bisitz 5958: /* border-left: 5px solid $sidebg; */
5959: border-top: 5px solid #000000;
5960: margin: 50px 0 0 0;
1.936 bisitz 5961: padding: 15px 0 5px 10px;
1.597 albertel 5962: }
1.795 www 5963:
1.936 bisitz 5964: div.LC_grade_show_user_odd_row {
1.941 bisitz 5965: /* border-left: 5px solid #000000; */
5966: }
5967:
5968: div.LC_grade_show_user div.LC_Box {
5969: margin-right: 50px;
1.597 albertel 5970: }
5971:
5972: div.LC_grade_submissions,
5973: div.LC_grade_message_center,
1.936 bisitz 5974: div.LC_grade_info_links {
1.597 albertel 5975: margin: 5px;
5976: width: 99%;
5977: background: #FFFFFF;
5978: }
1.795 www 5979:
1.597 albertel 5980: div.LC_grade_submissions_header,
1.936 bisitz 5981: div.LC_grade_message_center_header {
1.705 tempelho 5982: font-weight: bold;
5983: font-size: large;
1.597 albertel 5984: }
1.795 www 5985:
1.597 albertel 5986: div.LC_grade_submissions_body,
1.936 bisitz 5987: div.LC_grade_message_center_body {
1.597 albertel 5988: border: 1px solid black;
5989: width: 99%;
5990: background: #FFFFFF;
5991: }
1.795 www 5992:
1.613 albertel 5993: table.LC_scantron_action {
5994: width: 100%;
5995: }
1.795 www 5996:
1.613 albertel 5997: table.LC_scantron_action tr th {
1.698 harmsja 5998: font-weight:bold;
5999: font-style:normal;
1.613 albertel 6000: }
1.795 www 6001:
1.779 bisitz 6002: .LC_edit_problem_header,
1.614 albertel 6003: div.LC_edit_problem_footer {
1.705 tempelho 6004: font-weight: normal;
6005: font-size: medium;
1.602 albertel 6006: margin: 2px;
1.600 albertel 6007: }
1.795 www 6008:
1.600 albertel 6009: div.LC_edit_problem_header,
1.602 albertel 6010: div.LC_edit_problem_header div,
1.614 albertel 6011: div.LC_edit_problem_footer,
6012: div.LC_edit_problem_footer div,
1.602 albertel 6013: div.LC_edit_problem_editxml_header,
6014: div.LC_edit_problem_editxml_header div {
1.600 albertel 6015: margin-top: 5px;
6016: }
1.795 www 6017:
1.600 albertel 6018: div.LC_edit_problem_header_title {
1.705 tempelho 6019: font-weight: bold;
6020: font-size: larger;
1.602 albertel 6021: background: $tabbg;
6022: padding: 3px;
6023: }
1.795 www 6024:
1.602 albertel 6025: table.LC_edit_problem_header_title {
6026: width: 100%;
1.600 albertel 6027: background: $tabbg;
1.602 albertel 6028: }
6029:
6030: div.LC_edit_problem_discards {
6031: float: left;
6032: padding-bottom: 5px;
6033: }
1.795 www 6034:
1.602 albertel 6035: div.LC_edit_problem_saves {
6036: float: right;
6037: padding-bottom: 5px;
1.600 albertel 6038: }
1.795 www 6039:
1.911 bisitz 6040: img.stift {
1.803 bisitz 6041: border-width: 0;
6042: vertical-align: middle;
1.677 riegler 6043: }
1.680 riegler 6044:
1.923 bisitz 6045: table td.LC_mainmenu_col_fieldset {
1.680 riegler 6046: vertical-align: top;
1.777 tempelho 6047: }
1.795 www 6048:
1.716 raeburn 6049: div.LC_createcourse {
1.911 bisitz 6050: margin: 10px 10px 10px 10px;
1.716 raeburn 6051: }
6052:
1.917 raeburn 6053: .LC_dccid {
6054: margin: 0.2em 0 0 0;
6055: padding: 0;
6056: font-size: 90%;
6057: display:none;
6058: }
6059:
1.698 harmsja 6060: a:hover,
1.897 wenzelju 6061: ol.LC_primary_menu a:hover,
1.721 harmsja 6062: ol#LC_MenuBreadcrumbs a:hover,
6063: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 6064: ul#LC_secondary_menu a:hover,
1.721 harmsja 6065: .LC_FormSectionClearButton input:hover
1.795 www 6066: ul.LC_TabContent li:hover a {
1.952 onken 6067: color:$button_hover;
1.911 bisitz 6068: text-decoration:none;
1.693 droeschl 6069: }
6070:
1.779 bisitz 6071: h1 {
1.911 bisitz 6072: padding: 0;
6073: line-height:130%;
1.693 droeschl 6074: }
1.698 harmsja 6075:
1.911 bisitz 6076: h2,
6077: h3,
6078: h4,
6079: h5,
6080: h6 {
6081: margin: 5px 0 5px 0;
6082: padding: 0;
6083: line-height:130%;
1.693 droeschl 6084: }
1.795 www 6085:
6086: .LC_hcell {
1.911 bisitz 6087: padding:3px 15px 3px 15px;
6088: margin: 0;
6089: background-color:$tabbg;
6090: color:$fontmenu;
6091: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 6092: }
1.795 www 6093:
1.840 bisitz 6094: .LC_Box > .LC_hcell {
1.911 bisitz 6095: margin: 0 -10px 10px -10px;
1.835 bisitz 6096: }
6097:
1.721 harmsja 6098: .LC_noBorder {
1.911 bisitz 6099: border: 0;
1.698 harmsja 6100: }
1.693 droeschl 6101:
1.721 harmsja 6102: .LC_FormSectionClearButton input {
1.911 bisitz 6103: background-color:transparent;
6104: border: none;
6105: cursor:pointer;
6106: text-decoration:underline;
1.693 droeschl 6107: }
1.763 bisitz 6108:
6109: .LC_help_open_topic {
1.911 bisitz 6110: color: #FFFFFF;
6111: background-color: #EEEEFF;
6112: margin: 1px;
6113: padding: 4px;
6114: border: 1px solid #000033;
6115: white-space: nowrap;
6116: /* vertical-align: middle; */
1.759 neumanie 6117: }
1.693 droeschl 6118:
1.911 bisitz 6119: dl,
6120: ul,
6121: div,
6122: fieldset {
6123: margin: 10px 10px 10px 0;
6124: /* overflow: hidden; */
1.693 droeschl 6125: }
1.795 www 6126:
1.838 bisitz 6127: fieldset > legend {
1.911 bisitz 6128: font-weight: bold;
6129: padding: 0 5px 0 5px;
1.838 bisitz 6130: }
6131:
1.813 bisitz 6132: #LC_nav_bar {
1.911 bisitz 6133: float: left;
1.995 raeburn 6134: background-color: $pgbg_or_bgcolor;
1.966 bisitz 6135: margin: 0 0 2px 0;
1.807 droeschl 6136: }
6137:
1.916 droeschl 6138: #LC_realm {
6139: margin: 0.2em 0 0 0;
6140: padding: 0;
6141: font-weight: bold;
6142: text-align: center;
1.995 raeburn 6143: background-color: $pgbg_or_bgcolor;
1.916 droeschl 6144: }
6145:
1.911 bisitz 6146: #LC_nav_bar em {
6147: font-weight: bold;
6148: font-style: normal;
1.807 droeschl 6149: }
6150:
1.897 wenzelju 6151: ol.LC_primary_menu {
1.911 bisitz 6152: float: right;
1.934 droeschl 6153: margin: 0;
1.995 raeburn 6154: background-color: $pgbg_or_bgcolor;
1.807 droeschl 6155: }
6156:
1.852 droeschl 6157: ol#LC_PathBreadcrumbs {
1.911 bisitz 6158: margin: 0;
1.693 droeschl 6159: }
6160:
1.897 wenzelju 6161: ol.LC_primary_menu li {
1.911 bisitz 6162: display: inline;
6163: padding: 5px 5px 0 10px;
6164: vertical-align: top;
1.693 droeschl 6165: }
6166:
1.897 wenzelju 6167: ol.LC_primary_menu li img {
1.911 bisitz 6168: vertical-align: bottom;
1.934 droeschl 6169: height: 1.1em;
1.693 droeschl 6170: }
6171:
1.897 wenzelju 6172: ol.LC_primary_menu a {
1.911 bisitz 6173: color: RGB(80, 80, 80);
6174: text-decoration: none;
1.693 droeschl 6175: }
1.795 www 6176:
1.949 droeschl 6177: ol.LC_primary_menu a.LC_new_message {
6178: font-weight:bold;
6179: color: darkred;
6180: }
6181:
1.975 raeburn 6182: ol.LC_docs_parameters {
6183: margin-left: 0;
6184: padding: 0;
6185: list-style: none;
6186: }
6187:
6188: ol.LC_docs_parameters li {
6189: margin: 0;
6190: padding-right: 20px;
6191: display: inline;
6192: }
6193:
1.976 raeburn 6194: ol.LC_docs_parameters li:before {
6195: content: "\\002022 \\0020";
6196: }
6197:
6198: li.LC_docs_parameters_title {
6199: font-weight: bold;
6200: }
6201:
6202: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
6203: content: "";
6204: }
6205:
1.897 wenzelju 6206: ul#LC_secondary_menu {
1.911 bisitz 6207: clear: both;
6208: color: $fontmenu;
6209: background: $tabbg;
6210: list-style: none;
6211: padding: 0;
6212: margin: 0;
6213: width: 100%;
1.995 raeburn 6214: text-align: left;
1.808 droeschl 6215: }
6216:
1.897 wenzelju 6217: ul#LC_secondary_menu li {
1.911 bisitz 6218: font-weight: bold;
6219: line-height: 1.8em;
6220: padding: 0 0.8em;
6221: border-right: 1px solid black;
6222: display: inline;
6223: vertical-align: middle;
1.807 droeschl 6224: }
6225:
1.847 tempelho 6226: ul.LC_TabContent {
1.911 bisitz 6227: display:block;
6228: background: $sidebg;
6229: border-bottom: solid 1px $lg_border_color;
6230: list-style:none;
1.1020 ! raeburn 6231: margin: -1px -10px 0 -10px;
1.911 bisitz 6232: padding: 0;
1.693 droeschl 6233: }
6234:
1.795 www 6235: ul.LC_TabContent li,
6236: ul.LC_TabContentBigger li {
1.911 bisitz 6237: float:left;
1.741 harmsja 6238: }
1.795 www 6239:
1.897 wenzelju 6240: ul#LC_secondary_menu li a {
1.911 bisitz 6241: color: $fontmenu;
6242: text-decoration: none;
1.693 droeschl 6243: }
1.795 www 6244:
1.721 harmsja 6245: ul.LC_TabContent {
1.952 onken 6246: min-height:20px;
1.721 harmsja 6247: }
1.795 www 6248:
6249: ul.LC_TabContent li {
1.911 bisitz 6250: vertical-align:middle;
1.959 onken 6251: padding: 0 16px 0 10px;
1.911 bisitz 6252: background-color:$tabbg;
6253: border-bottom:solid 1px $lg_border_color;
1.1020 ! raeburn 6254: border-left: solid 1px $font;
1.721 harmsja 6255: }
1.795 www 6256:
1.847 tempelho 6257: ul.LC_TabContent .right {
1.911 bisitz 6258: float:right;
1.847 tempelho 6259: }
6260:
1.911 bisitz 6261: ul.LC_TabContent li a,
6262: ul.LC_TabContent li {
6263: color:rgb(47,47,47);
6264: text-decoration:none;
6265: font-size:95%;
6266: font-weight:bold;
1.952 onken 6267: min-height:20px;
6268: }
6269:
1.959 onken 6270: ul.LC_TabContent li a:hover,
6271: ul.LC_TabContent li a:focus {
1.952 onken 6272: color: $button_hover;
1.959 onken 6273: background:none;
6274: outline:none;
1.952 onken 6275: }
6276:
6277: ul.LC_TabContent li:hover {
6278: color: $button_hover;
6279: cursor:pointer;
1.721 harmsja 6280: }
1.795 www 6281:
1.911 bisitz 6282: ul.LC_TabContent li.active {
1.952 onken 6283: color: $font;
1.911 bisitz 6284: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 6285: border-bottom:solid 1px #FFFFFF;
6286: cursor: default;
1.744 ehlerst 6287: }
1.795 www 6288:
1.959 onken 6289: ul.LC_TabContent li.active a {
6290: color:$font;
6291: background:#FFFFFF;
6292: outline: none;
6293: }
1.870 tempelho 6294: #maincoursedoc {
1.911 bisitz 6295: clear:both;
1.870 tempelho 6296: }
6297:
6298: ul.LC_TabContentBigger {
1.911 bisitz 6299: display:block;
6300: list-style:none;
6301: padding: 0;
1.870 tempelho 6302: }
6303:
1.795 www 6304: ul.LC_TabContentBigger li {
1.911 bisitz 6305: vertical-align:bottom;
6306: height: 30px;
6307: font-size:110%;
6308: font-weight:bold;
6309: color: #737373;
1.841 tempelho 6310: }
6311:
1.957 onken 6312: ul.LC_TabContentBigger li.active {
6313: position: relative;
6314: top: 1px;
6315: }
6316:
1.870 tempelho 6317: ul.LC_TabContentBigger li a {
1.911 bisitz 6318: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6319: height: 30px;
6320: line-height: 30px;
6321: text-align: center;
6322: display: block;
6323: text-decoration: none;
1.958 onken 6324: outline: none;
1.741 harmsja 6325: }
1.795 www 6326:
1.870 tempelho 6327: ul.LC_TabContentBigger li.active a {
1.911 bisitz 6328: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6329: color:$font;
1.744 ehlerst 6330: }
1.795 www 6331:
1.870 tempelho 6332: ul.LC_TabContentBigger li b {
1.911 bisitz 6333: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
6334: display: block;
6335: float: left;
6336: padding: 0 30px;
1.957 onken 6337: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 6338: }
6339:
1.956 onken 6340: ul.LC_TabContentBigger li:hover b {
6341: color:$button_hover;
6342: }
6343:
1.870 tempelho 6344: ul.LC_TabContentBigger li.active b {
1.911 bisitz 6345: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
6346: color:$font;
1.957 onken 6347: border: 0;
1.741 harmsja 6348: }
1.693 droeschl 6349:
1.870 tempelho 6350:
1.862 bisitz 6351: ul.LC_CourseBreadcrumbs {
6352: background: $sidebg;
1.1020 ! raeburn 6353: height: 2em;
1.862 bisitz 6354: padding-left: 10px;
1.1020 ! raeburn 6355: margin: 0;
1.862 bisitz 6356: list-style-position: inside;
6357: }
6358:
1.911 bisitz 6359: ol#LC_MenuBreadcrumbs,
1.862 bisitz 6360: ol#LC_PathBreadcrumbs {
1.911 bisitz 6361: padding-left: 10px;
6362: margin: 0;
1.933 droeschl 6363: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 6364: }
6365:
1.911 bisitz 6366: ol#LC_MenuBreadcrumbs li,
6367: ol#LC_PathBreadcrumbs li,
1.862 bisitz 6368: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 6369: display: inline;
1.933 droeschl 6370: white-space: normal;
1.693 droeschl 6371: }
6372:
1.823 bisitz 6373: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 6374: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 6375: text-decoration: none;
6376: font-size:90%;
1.693 droeschl 6377: }
1.795 www 6378:
1.969 droeschl 6379: ol#LC_MenuBreadcrumbs h1 {
6380: display: inline;
6381: font-size: 90%;
6382: line-height: 2.5em;
6383: margin: 0;
6384: padding: 0;
6385: }
6386:
1.795 www 6387: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 6388: text-decoration:none;
6389: font-size:100%;
6390: font-weight:bold;
1.693 droeschl 6391: }
1.795 www 6392:
1.840 bisitz 6393: .LC_Box {
1.911 bisitz 6394: border: solid 1px $lg_border_color;
6395: padding: 0 10px 10px 10px;
1.746 neumanie 6396: }
1.795 www 6397:
1.1020 ! raeburn 6398: .LC_DocsBox {
! 6399: border: solid 1px $lg_border_color;
! 6400: padding: 0 0 10px 10px;
! 6401: }
! 6402:
1.795 www 6403: .LC_AboutMe_Image {
1.911 bisitz 6404: float:left;
6405: margin-right:10px;
1.747 neumanie 6406: }
1.795 www 6407:
6408: .LC_Clear_AboutMe_Image {
1.911 bisitz 6409: clear:left;
1.747 neumanie 6410: }
1.795 www 6411:
1.721 harmsja 6412: dl.LC_ListStyleClean dt {
1.911 bisitz 6413: padding-right: 5px;
6414: display: table-header-group;
1.693 droeschl 6415: }
6416:
1.721 harmsja 6417: dl.LC_ListStyleClean dd {
1.911 bisitz 6418: display: table-row;
1.693 droeschl 6419: }
6420:
1.721 harmsja 6421: .LC_ListStyleClean,
6422: .LC_ListStyleSimple,
6423: .LC_ListStyleNormal,
1.795 www 6424: .LC_ListStyleSpecial {
1.911 bisitz 6425: /* display:block; */
6426: list-style-position: inside;
6427: list-style-type: none;
6428: overflow: hidden;
6429: padding: 0;
1.693 droeschl 6430: }
6431:
1.721 harmsja 6432: .LC_ListStyleSimple li,
6433: .LC_ListStyleSimple dd,
6434: .LC_ListStyleNormal li,
6435: .LC_ListStyleNormal dd,
6436: .LC_ListStyleSpecial li,
1.795 www 6437: .LC_ListStyleSpecial dd {
1.911 bisitz 6438: margin: 0;
6439: padding: 5px 5px 5px 10px;
6440: clear: both;
1.693 droeschl 6441: }
6442:
1.721 harmsja 6443: .LC_ListStyleClean li,
6444: .LC_ListStyleClean dd {
1.911 bisitz 6445: padding-top: 0;
6446: padding-bottom: 0;
1.693 droeschl 6447: }
6448:
1.721 harmsja 6449: .LC_ListStyleSimple dd,
1.795 www 6450: .LC_ListStyleSimple li {
1.911 bisitz 6451: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6452: }
6453:
1.721 harmsja 6454: .LC_ListStyleSpecial li,
6455: .LC_ListStyleSpecial dd {
1.911 bisitz 6456: list-style-type: none;
6457: background-color: RGB(220, 220, 220);
6458: margin-bottom: 4px;
1.693 droeschl 6459: }
6460:
1.721 harmsja 6461: table.LC_SimpleTable {
1.911 bisitz 6462: margin:5px;
6463: border:solid 1px $lg_border_color;
1.795 www 6464: }
1.693 droeschl 6465:
1.721 harmsja 6466: table.LC_SimpleTable tr {
1.911 bisitz 6467: padding: 0;
6468: border:solid 1px $lg_border_color;
1.693 droeschl 6469: }
1.795 www 6470:
6471: table.LC_SimpleTable thead {
1.911 bisitz 6472: background:rgb(220,220,220);
1.693 droeschl 6473: }
6474:
1.721 harmsja 6475: div.LC_columnSection {
1.911 bisitz 6476: display: block;
6477: clear: both;
6478: overflow: hidden;
6479: margin: 0;
1.693 droeschl 6480: }
6481:
1.721 harmsja 6482: div.LC_columnSection>* {
1.911 bisitz 6483: float: left;
6484: margin: 10px 20px 10px 0;
6485: overflow:hidden;
1.693 droeschl 6486: }
1.721 harmsja 6487:
1.795 www 6488: table em {
1.911 bisitz 6489: font-weight: bold;
6490: font-style: normal;
1.748 schulted 6491: }
1.795 www 6492:
1.779 bisitz 6493: table.LC_tableBrowseRes,
1.795 www 6494: table.LC_tableOfContent {
1.911 bisitz 6495: border:none;
6496: border-spacing: 1px;
6497: padding: 3px;
6498: background-color: #FFFFFF;
6499: font-size: 90%;
1.753 droeschl 6500: }
1.789 droeschl 6501:
1.911 bisitz 6502: table.LC_tableOfContent {
6503: border-collapse: collapse;
1.789 droeschl 6504: }
6505:
1.771 droeschl 6506: table.LC_tableBrowseRes a,
1.768 schulted 6507: table.LC_tableOfContent a {
1.911 bisitz 6508: background-color: transparent;
6509: text-decoration: none;
1.753 droeschl 6510: }
6511:
1.795 www 6512: table.LC_tableOfContent img {
1.911 bisitz 6513: border: none;
6514: height: 1.3em;
6515: vertical-align: text-bottom;
6516: margin-right: 0.3em;
1.753 droeschl 6517: }
1.757 schulted 6518:
1.795 www 6519: a#LC_content_toolbar_firsthomework {
1.911 bisitz 6520: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 6521: }
6522:
1.795 www 6523: a#LC_content_toolbar_everything {
1.911 bisitz 6524: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 6525: }
6526:
1.795 www 6527: a#LC_content_toolbar_uncompleted {
1.911 bisitz 6528: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 6529: }
6530:
1.795 www 6531: #LC_content_toolbar_clearbubbles {
1.911 bisitz 6532: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 6533: }
6534:
1.795 www 6535: a#LC_content_toolbar_changefolder {
1.911 bisitz 6536: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 6537: }
6538:
1.795 www 6539: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 6540: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 6541: }
6542:
1.795 www 6543: ul#LC_toolbar li a:hover {
1.911 bisitz 6544: background-position: bottom center;
1.757 schulted 6545: }
6546:
1.795 www 6547: ul#LC_toolbar {
1.911 bisitz 6548: padding: 0;
6549: margin: 2px;
6550: list-style:none;
6551: position:relative;
6552: background-color:white;
1.757 schulted 6553: }
6554:
1.795 www 6555: ul#LC_toolbar li {
1.911 bisitz 6556: border:1px solid white;
6557: padding: 0;
6558: margin: 0;
6559: float: left;
6560: display:inline;
6561: vertical-align:middle;
6562: }
1.757 schulted 6563:
1.783 amueller 6564:
1.795 www 6565: a.LC_toolbarItem {
1.911 bisitz 6566: display:block;
6567: padding: 0;
6568: margin: 0;
6569: height: 32px;
6570: width: 32px;
6571: color:white;
6572: border: none;
6573: background-repeat:no-repeat;
6574: background-color:transparent;
1.757 schulted 6575: }
6576:
1.915 droeschl 6577: ul.LC_funclist {
6578: margin: 0;
6579: padding: 0.5em 1em 0.5em 0;
6580: }
6581:
1.933 droeschl 6582: ul.LC_funclist > li:first-child {
6583: font-weight:bold;
6584: margin-left:0.8em;
6585: }
6586:
1.915 droeschl 6587: ul.LC_funclist + ul.LC_funclist {
6588: /*
6589: left border as a seperator if we have more than
6590: one list
6591: */
6592: border-left: 1px solid $sidebg;
6593: /*
6594: this hides the left border behind the border of the
6595: outer box if element is wrapped to the next 'line'
6596: */
6597: margin-left: -1px;
6598: }
6599:
1.843 bisitz 6600: ul.LC_funclist li {
1.915 droeschl 6601: display: inline;
1.782 bisitz 6602: white-space: nowrap;
1.915 droeschl 6603: margin: 0 0 0 25px;
6604: line-height: 150%;
1.782 bisitz 6605: }
6606:
1.974 wenzelju 6607: .LC_hidden {
6608: display: none;
6609: }
6610:
1.343 albertel 6611: END
6612: }
6613:
1.306 albertel 6614: =pod
6615:
6616: =item * &headtag()
6617:
6618: Returns a uniform footer for LON-CAPA web pages.
6619:
1.307 albertel 6620: Inputs: $title - optional title for the head
6621: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 6622: $args - optional arguments
1.319 albertel 6623: force_register - if is true call registerurl so the remote is
6624: informed
1.415 albertel 6625: redirect -> array ref of
6626: 1- seconds before redirect occurs
6627: 2- url to redirect to
6628: 3- whether the side effect should occur
1.315 albertel 6629: (side effect of setting
6630: $env{'internal.head.redirect'} to the url
6631: redirected too)
1.352 albertel 6632: domain -> force to color decorate a page for a specific
6633: domain
6634: function -> force usage of a specific rolish color scheme
6635: bgcolor -> override the default page bgcolor
1.460 albertel 6636: no_auto_mt_title
6637: -> prevent &mt()ing the title arg
1.464 albertel 6638:
1.306 albertel 6639: =cut
6640:
6641: sub headtag {
1.313 albertel 6642: my ($title,$head_extra,$args) = @_;
1.306 albertel 6643:
1.363 albertel 6644: my $function = $args->{'function'} || &get_users_function();
6645: my $domain = $args->{'domain'} || &determinedomain();
6646: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 6647: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 6648: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 6649: #time(),
1.418 albertel 6650: $env{'environment.color.timestamp'},
1.363 albertel 6651: $function,$domain,$bgcolor);
6652:
1.369 www 6653: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 6654:
1.308 albertel 6655: my $result =
6656: '<head>'.
1.461 albertel 6657: &font_settings();
1.319 albertel 6658:
1.461 albertel 6659: if (!$args->{'frameset'}) {
6660: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
6661: }
1.962 droeschl 6662: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
6663: $result .= Apache::lonxml::display_title();
1.319 albertel 6664: }
1.436 albertel 6665: if (!$args->{'no_nav_bar'}
6666: && !$args->{'only_body'}
6667: && !$args->{'frameset'}) {
6668: $result .= &help_menu_js();
6669: }
1.319 albertel 6670:
1.314 albertel 6671: if (ref($args->{'redirect'})) {
1.414 albertel 6672: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 6673: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 6674: if (!$inhibit_continue) {
6675: $env{'internal.head.redirect'} = $url;
6676: }
1.313 albertel 6677: $result.=<<ADDMETA
6678: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 6679: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 6680: ADDMETA
6681: }
1.306 albertel 6682: if (!defined($title)) {
6683: $title = 'The LearningOnline Network with CAPA';
6684: }
1.460 albertel 6685: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
6686: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 6687: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
6688: .$head_extra;
1.962 droeschl 6689: return $result.'</head>';
1.306 albertel 6690: }
6691:
6692: =pod
6693:
1.340 albertel 6694: =item * &font_settings()
6695:
6696: Returns neccessary <meta> to set the proper encoding
6697:
6698: Inputs: none
6699:
6700: =cut
6701:
6702: sub font_settings {
6703: my $headerstring='';
1.647 www 6704: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 6705: $headerstring.=
6706: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
6707: }
6708: return $headerstring;
6709: }
6710:
1.341 albertel 6711: =pod
6712:
6713: =item * &xml_begin()
6714:
6715: Returns the needed doctype and <html>
6716:
6717: Inputs: none
6718:
6719: =cut
6720:
6721: sub xml_begin {
6722: my $output='';
6723:
6724: if ($env{'browser.mathml'}) {
6725: $output='<?xml version="1.0"?>'
6726: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
6727: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
6728:
6729: # .'<!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">] >'
6730: .'<!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">'
6731: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
6732: .'xmlns="http://www.w3.org/1999/xhtml">';
6733: } else {
1.849 bisitz 6734: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
6735: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341 albertel 6736: }
6737: return $output;
6738: }
1.340 albertel 6739:
6740: =pod
6741:
1.306 albertel 6742: =item * &start_page()
6743:
6744: Returns a complete <html> .. <body> section for LON-CAPA web pages.
6745:
1.648 raeburn 6746: Inputs:
6747:
6748: =over 4
6749:
6750: $title - optional title for the page
6751:
6752: $head_extra - optional extra HTML to incude inside the <head>
6753:
6754: $args - additional optional args supported are:
6755:
6756: =over 8
6757:
6758: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 6759: arg on
1.814 bisitz 6760: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 6761: add_entries -> additional attributes to add to the <body>
6762: domain -> force to color decorate a page for a
1.317 albertel 6763: specific domain
1.648 raeburn 6764: function -> force usage of a specific rolish color
1.317 albertel 6765: scheme
1.648 raeburn 6766: redirect -> see &headtag()
6767: bgcolor -> override the default page bg color
6768: js_ready -> return a string ready for being used in
1.317 albertel 6769: a javascript writeln
1.648 raeburn 6770: html_encode -> return a string ready for being used in
1.320 albertel 6771: a html attribute
1.648 raeburn 6772: force_register -> if is true will turn on the &bodytag()
1.317 albertel 6773: $forcereg arg
1.648 raeburn 6774: frameset -> if true will start with a <frameset>
1.330 albertel 6775: rather than <body>
1.648 raeburn 6776: skip_phases -> hash ref of
1.338 albertel 6777: head -> skip the <html><head> generation
6778: body -> skip all <body> generation
1.648 raeburn 6779: no_auto_mt_title -> prevent &mt()ing the title arg
6780: inherit_jsmath -> when creating popup window in a page,
6781: should it have jsmath forced on by the
6782: current page
1.867 kalberla 6783: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 6784: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.361 albertel 6785:
1.648 raeburn 6786: =back
1.460 albertel 6787:
1.648 raeburn 6788: =back
1.562 albertel 6789:
1.306 albertel 6790: =cut
6791:
6792: sub start_page {
1.309 albertel 6793: my ($title,$head_extra,$args) = @_;
1.318 albertel 6794: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.964 droeschl 6795: #SD
6796: #I don't see why we copy certain elements of %$args to %head_args
6797: #head args is passed to headtag() and this routine only reads those
6798: #keys that are needed. There doesn't happen any writes or any processing
6799: #of other keys.
6800: #proposal: just pass $args to headtag instead of \%head_args and delete
6801: #marked lines
6802: #<- MARK
1.313 albertel 6803: my %head_args;
1.352 albertel 6804: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6805: 'bgcolor','frameset','no_nav_bar','only_body',
6806: 'no_auto_mt_title') {
1.319 albertel 6807: if (defined($args->{$arg})) {
1.324 raeburn 6808: $head_args{$arg} = $args->{$arg};
1.319 albertel 6809: }
1.313 albertel 6810: }
1.964 droeschl 6811: #MARK ->
1.319 albertel 6812:
1.315 albertel 6813: $env{'internal.start_page'}++;
1.338 albertel 6814: my $result;
1.964 droeschl 6815:
1.338 albertel 6816: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.964 droeschl 6817: $result .=
6818: &xml_begin() . &headtag($title,$head_extra,\%head_args);
6819: #replace prev line by
6820: # &xml_begin() . &headtag($title, $head_extra, $args);
1.338 albertel 6821: }
6822:
6823: if (! exists($args->{'skip_phases'}{'body'}) ) {
6824: if ($args->{'frameset'}) {
6825: my $attr_string = &make_attr_string($args->{'force_register'},
6826: $args->{'add_entries'});
6827: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 6828: } else {
6829: $result .=
6830: &bodytag($title,
6831: $args->{'function'}, $args->{'add_entries'},
6832: $args->{'only_body'}, $args->{'domain'},
6833: $args->{'force_register'}, $args->{'no_nav_bar'},
1.962 droeschl 6834: $args->{'bgcolor'}, $args);
1.831 bisitz 6835: }
1.330 albertel 6836: }
1.338 albertel 6837:
1.315 albertel 6838: if ($args->{'js_ready'}) {
1.713 kaisler 6839: $result = &js_ready($result);
1.315 albertel 6840: }
1.320 albertel 6841: if ($args->{'html_encode'}) {
1.713 kaisler 6842: $result = &html_encode($result);
6843: }
6844:
1.813 bisitz 6845: # Preparation for new and consistent functionlist at top of screen
6846: # if ($args->{'functionlist'}) {
6847: # $result .= &build_functionlist();
6848: #}
6849:
1.964 droeschl 6850: # Don't add anything more if only_body wanted or in const space
6851: return $result if $args->{'only_body'}
6852: || $env{'request.state'} eq 'construct';
1.813 bisitz 6853:
6854: #Breadcrumbs
1.758 kaisler 6855: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
6856: &Apache::lonhtmlcommon::clear_breadcrumbs();
6857: #if any br links exists, add them to the breadcrumbs
6858: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6859: foreach my $crumb (@{$args->{'bread_crumbs'}}){
6860: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
6861: }
6862: }
6863:
6864: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
6865: if(exists($args->{'bread_crumbs_component'})){
6866: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
6867: }else{
6868: $result .= &Apache::lonhtmlcommon::breadcrumbs();
6869: }
1.320 albertel 6870: }
1.315 albertel 6871: return $result;
1.306 albertel 6872: }
6873:
6874: sub end_page {
1.315 albertel 6875: my ($args) = @_;
6876: $env{'internal.end_page'}++;
1.330 albertel 6877: my $result;
1.335 albertel 6878: if ($args->{'discussion'}) {
6879: my ($target,$parser);
6880: if (ref($args->{'discussion'})) {
6881: ($target,$parser) =($args->{'discussion'}{'target'},
6882: $args->{'discussion'}{'parser'});
6883: }
6884: $result .= &Apache::lonxml::xmlend($target,$parser);
6885: }
6886:
1.330 albertel 6887: if ($args->{'frameset'}) {
6888: $result .= '</frameset>';
6889: } else {
1.635 raeburn 6890: $result .= &endbodytag($args);
1.330 albertel 6891: }
6892: $result .= "\n</html>";
6893:
1.315 albertel 6894: if ($args->{'js_ready'}) {
1.317 albertel 6895: $result = &js_ready($result);
1.315 albertel 6896: }
1.335 albertel 6897:
1.320 albertel 6898: if ($args->{'html_encode'}) {
6899: $result = &html_encode($result);
6900: }
1.335 albertel 6901:
1.315 albertel 6902: return $result;
6903: }
6904:
1.320 albertel 6905: sub html_encode {
6906: my ($result) = @_;
6907:
1.322 albertel 6908: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6909:
6910: return $result;
6911: }
1.317 albertel 6912: sub js_ready {
6913: my ($result) = @_;
6914:
1.323 albertel 6915: $result =~ s/[\n\r]/ /xmsg;
6916: $result =~ s/\\/\\\\/xmsg;
6917: $result =~ s/'/\\'/xmsg;
1.372 albertel 6918: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6919:
6920: return $result;
6921: }
6922:
1.315 albertel 6923: sub validate_page {
6924: if ( exists($env{'internal.start_page'})
1.316 albertel 6925: && $env{'internal.start_page'} > 1) {
6926: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6927: $env{'internal.start_page'}.' '.
1.316 albertel 6928: $ENV{'request.filename'});
1.315 albertel 6929: }
6930: if ( exists($env{'internal.end_page'})
1.316 albertel 6931: && $env{'internal.end_page'} > 1) {
6932: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6933: $env{'internal.end_page'}.' '.
1.316 albertel 6934: $env{'request.filename'});
1.315 albertel 6935: }
6936: if ( exists($env{'internal.start_page'})
6937: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6938: &Apache::lonnet::logthis('start_page called without end_page '.
6939: $env{'request.filename'});
1.315 albertel 6940: }
6941: if ( ! exists($env{'internal.start_page'})
6942: && exists($env{'internal.end_page'})) {
1.316 albertel 6943: &Apache::lonnet::logthis('end_page called without start_page'.
6944: $env{'request.filename'});
1.315 albertel 6945: }
1.306 albertel 6946: }
1.315 albertel 6947:
1.996 www 6948:
6949: sub start_scrollbox {
1.1018 raeburn 6950: my ($outerwidth,$width,$height,$id)=@_;
1.998 raeburn 6951: unless ($outerwidth) { $outerwidth='520px'; }
6952: unless ($width) { $width='500px'; }
6953: unless ($height) { $height='200px'; }
1.1020 ! raeburn 6954: my ($table_id,$div_id);
1.1018 raeburn 6955: if ($id ne '') {
1.1020 ! raeburn 6956: $table_id = " id='table_$id'";
! 6957: $div_id = " id='div_$id'";
1.1018 raeburn 6958: }
1.1020 ! raeburn 6959: 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 6960: }
6961:
6962: sub end_scrollbox {
1.998 raeburn 6963: return '</td></tr></table>';
1.996 www 6964: }
6965:
1.318 albertel 6966: sub simple_error_page {
6967: my ($r,$title,$msg) = @_;
6968: my $page =
6969: &Apache::loncommon::start_page($title).
6970: &mt($msg).
6971: &Apache::loncommon::end_page();
6972: if (ref($r)) {
6973: $r->print($page);
1.327 albertel 6974: return;
1.318 albertel 6975: }
6976: return $page;
6977: }
1.347 albertel 6978:
6979: {
1.610 albertel 6980: my @row_count;
1.961 onken 6981:
6982: sub start_data_table_count {
6983: unshift(@row_count, 0);
6984: return;
6985: }
6986:
6987: sub end_data_table_count {
6988: shift(@row_count);
6989: return;
6990: }
6991:
1.347 albertel 6992: sub start_data_table {
1.1018 raeburn 6993: my ($add_class,$id) = @_;
1.422 albertel 6994: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 6995: my $table_id;
6996: if (defined($id)) {
6997: $table_id = ' id="'.$id.'"';
6998: }
1.961 onken 6999: &start_data_table_count();
1.1018 raeburn 7000: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 7001: }
7002:
7003: sub end_data_table {
1.961 onken 7004: &end_data_table_count();
1.389 albertel 7005: return '</table>'."\n";;
1.347 albertel 7006: }
7007:
7008: sub start_data_table_row {
1.974 wenzelju 7009: my ($add_class, $id) = @_;
1.610 albertel 7010: $row_count[0]++;
7011: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 7012: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 7013: $id = (' id="'.$id.'"') unless ($id eq '');
7014: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 7015: }
1.471 banghart 7016:
7017: sub continue_data_table_row {
1.974 wenzelju 7018: my ($add_class, $id) = @_;
1.610 albertel 7019: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 7020: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
7021: $id = (' id="'.$id.'"') unless ($id eq '');
7022: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 7023: }
1.347 albertel 7024:
7025: sub end_data_table_row {
1.389 albertel 7026: return '</tr>'."\n";;
1.347 albertel 7027: }
1.367 www 7028:
1.421 albertel 7029: sub start_data_table_empty_row {
1.707 bisitz 7030: # $row_count[0]++;
1.421 albertel 7031: return '<tr class="LC_empty_row" >'."\n";;
7032: }
7033:
7034: sub end_data_table_empty_row {
7035: return '</tr>'."\n";;
7036: }
7037:
1.367 www 7038: sub start_data_table_header_row {
1.389 albertel 7039: return '<tr class="LC_header_row">'."\n";;
1.367 www 7040: }
7041:
7042: sub end_data_table_header_row {
1.389 albertel 7043: return '</tr>'."\n";;
1.367 www 7044: }
1.890 droeschl 7045:
7046: sub data_table_caption {
7047: my $caption = shift;
7048: return "<caption class=\"LC_caption\">$caption</caption>";
7049: }
1.347 albertel 7050: }
7051:
1.548 albertel 7052: =pod
7053:
7054: =item * &inhibit_menu_check($arg)
7055:
7056: Checks for a inhibitmenu state and generates output to preserve it
7057:
7058: Inputs: $arg - can be any of
7059: - undef - in which case the return value is a string
7060: to add into arguments list of a uri
7061: - 'input' - in which case the return value is a HTML
7062: <form> <input> field of type hidden to
7063: preserve the value
7064: - a url - in which case the return value is the url with
7065: the neccesary cgi args added to preserve the
7066: inhibitmenu state
7067: - a ref to a url - no return value, but the string is
7068: updated to include the neccessary cgi
7069: args to preserve the inhibitmenu state
7070:
7071: =cut
7072:
7073: sub inhibit_menu_check {
7074: my ($arg) = @_;
7075: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
7076: if ($arg eq 'input') {
7077: if ($env{'form.inhibitmenu'}) {
7078: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
7079: } else {
7080: return
7081: }
7082: }
7083: if ($env{'form.inhibitmenu'}) {
7084: if (ref($arg)) {
7085: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7086: } elsif ($arg eq '') {
7087: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
7088: } else {
7089: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7090: }
7091: }
7092: if (!ref($arg)) {
7093: return $arg;
7094: }
7095: }
7096:
1.251 albertel 7097: ###############################################
1.182 matthew 7098:
7099: =pod
7100:
1.549 albertel 7101: =back
7102:
7103: =head1 User Information Routines
7104:
7105: =over 4
7106:
1.405 albertel 7107: =item * &get_users_function()
1.182 matthew 7108:
7109: Used by &bodytag to determine the current users primary role.
7110: Returns either 'student','coordinator','admin', or 'author'.
7111:
7112: =cut
7113:
7114: ###############################################
7115: sub get_users_function {
1.815 tempelho 7116: my $function = 'norole';
1.818 tempelho 7117: if ($env{'request.role'}=~/^(st)/) {
7118: $function='student';
7119: }
1.907 raeburn 7120: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 7121: $function='coordinator';
7122: }
1.258 albertel 7123: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 7124: $function='admin';
7125: }
1.826 bisitz 7126: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182 matthew 7127: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
7128: $function='author';
7129: }
7130: return $function;
1.54 www 7131: }
1.99 www 7132:
7133: ###############################################
7134:
1.233 raeburn 7135: =pod
7136:
1.821 raeburn 7137: =item * &show_course()
7138:
7139: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
7140: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
7141:
7142: Inputs:
7143: None
7144:
7145: Outputs:
7146: Scalar: 1 if 'Course' to be used, 0 otherwise.
7147:
7148: =cut
7149:
7150: ###############################################
7151: sub show_course {
7152: my $course = !$env{'user.adv'};
7153: if (!$env{'user.adv'}) {
7154: foreach my $env (keys(%env)) {
7155: next if ($env !~ m/^user\.priv\./);
7156: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
7157: $course = 0;
7158: last;
7159: }
7160: }
7161: }
7162: return $course;
7163: }
7164:
7165: ###############################################
7166:
7167: =pod
7168:
1.542 raeburn 7169: =item * &check_user_status()
1.274 raeburn 7170:
7171: Determines current status of supplied role for a
7172: specific user. Roles can be active, previous or future.
7173:
7174: Inputs:
7175: user's domain, user's username, course's domain,
1.375 raeburn 7176: course's number, optional section ID.
1.274 raeburn 7177:
7178: Outputs:
7179: role status: active, previous or future.
7180:
7181: =cut
7182:
7183: sub check_user_status {
1.412 raeburn 7184: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.982 raeburn 7185: my $extra = &Apache::lonnet::freeze_escape({'skipcheck' => 1});
7186: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname,'.',undef,$extra);
1.274 raeburn 7187: my @uroles = keys %userinfo;
7188: my $srchstr;
7189: my $active_chk = 'none';
1.412 raeburn 7190: my $now = time;
1.274 raeburn 7191: if (@uroles > 0) {
1.908 raeburn 7192: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 7193: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
7194: } else {
1.412 raeburn 7195: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
7196: }
7197: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 7198: my $role_end = 0;
7199: my $role_start = 0;
7200: $active_chk = 'active';
1.412 raeburn 7201: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
7202: $role_end = $1;
7203: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
7204: $role_start = $1;
1.274 raeburn 7205: }
7206: }
7207: if ($role_start > 0) {
1.412 raeburn 7208: if ($now < $role_start) {
1.274 raeburn 7209: $active_chk = 'future';
7210: }
7211: }
7212: if ($role_end > 0) {
1.412 raeburn 7213: if ($now > $role_end) {
1.274 raeburn 7214: $active_chk = 'previous';
7215: }
7216: }
7217: }
7218: }
7219: return $active_chk;
7220: }
7221:
7222: ###############################################
7223:
7224: =pod
7225:
1.405 albertel 7226: =item * &get_sections()
1.233 raeburn 7227:
7228: Determines all the sections for a course including
7229: sections with students and sections containing other roles.
1.419 raeburn 7230: Incoming parameters:
7231:
7232: 1. domain
7233: 2. course number
7234: 3. reference to array containing roles for which sections should
7235: be gathered (optional).
7236: 4. reference to array containing status types for which sections
7237: should be gathered (optional).
7238:
7239: If the third argument is undefined, sections are gathered for any role.
7240: If the fourth argument is undefined, sections are gathered for any status.
7241: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 7242:
1.374 raeburn 7243: Returns section hash (keys are section IDs, values are
7244: number of users in each section), subject to the
1.419 raeburn 7245: optional roles filter, optional status filter
1.233 raeburn 7246:
7247: =cut
7248:
7249: ###############################################
7250: sub get_sections {
1.419 raeburn 7251: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 7252: if (!defined($cdom) || !defined($cnum)) {
7253: my $cid = $env{'request.course.id'};
7254:
7255: return if (!defined($cid));
7256:
7257: $cdom = $env{'course.'.$cid.'.domain'};
7258: $cnum = $env{'course.'.$cid.'.num'};
7259: }
7260:
7261: my %sectioncount;
1.419 raeburn 7262: my $now = time;
1.240 albertel 7263:
1.366 albertel 7264: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 7265: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 7266: my $sec_index = &Apache::loncoursedata::CL_SECTION();
7267: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 7268: my $start_index = &Apache::loncoursedata::CL_START();
7269: my $end_index = &Apache::loncoursedata::CL_END();
7270: my $status;
1.366 albertel 7271: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 7272: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
7273: $data->[$status_index],
7274: $data->[$start_index],
7275: $data->[$end_index]);
7276: if ($stu_status eq 'Active') {
7277: $status = 'active';
7278: } elsif ($end < $now) {
7279: $status = 'previous';
7280: } elsif ($start > $now) {
7281: $status = 'future';
7282: }
7283: if ($section ne '-1' && $section !~ /^\s*$/) {
7284: if ((!defined($possible_status)) || (($status ne '') &&
7285: (grep/^\Q$status\E$/,@{$possible_status}))) {
7286: $sectioncount{$section}++;
7287: }
1.240 albertel 7288: }
7289: }
7290: }
7291: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7292: foreach my $user (sort(keys(%courseroles))) {
7293: if ($user !~ /^(\w{2})/) { next; }
7294: my ($role) = ($user =~ /^(\w{2})/);
7295: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 7296: my ($section,$status);
1.240 albertel 7297: if ($role eq 'cr' &&
7298: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
7299: $section=$1;
7300: }
7301: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
7302: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 7303: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
7304: if ($end == -1 && $start == -1) {
7305: next; #deleted role
7306: }
7307: if (!defined($possible_status)) {
7308: $sectioncount{$section}++;
7309: } else {
7310: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
7311: $status = 'active';
7312: } elsif ($end < $now) {
7313: $status = 'future';
7314: } elsif ($start > $now) {
7315: $status = 'previous';
7316: }
7317: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
7318: $sectioncount{$section}++;
7319: }
7320: }
1.233 raeburn 7321: }
1.366 albertel 7322: return %sectioncount;
1.233 raeburn 7323: }
7324:
1.274 raeburn 7325: ###############################################
1.294 raeburn 7326:
7327: =pod
1.405 albertel 7328:
7329: =item * &get_course_users()
7330:
1.275 raeburn 7331: Retrieves usernames:domains for users in the specified course
7332: with specific role(s), and access status.
7333:
7334: Incoming parameters:
1.277 albertel 7335: 1. course domain
7336: 2. course number
7337: 3. access status: users must have - either active,
1.275 raeburn 7338: previous, future, or all.
1.277 albertel 7339: 4. reference to array of permissible roles
1.288 raeburn 7340: 5. reference to array of section restrictions (optional)
7341: 6. reference to results object (hash of hashes).
7342: 7. reference to optional userdata hash
1.609 raeburn 7343: 8. reference to optional statushash
1.630 raeburn 7344: 9. flag if privileged users (except those set to unhide in
7345: course settings) should be excluded
1.609 raeburn 7346: Keys of top level results hash are roles.
1.275 raeburn 7347: Keys of inner hashes are username:domain, with
7348: values set to access type.
1.288 raeburn 7349: Optional userdata hash returns an array with arguments in the
7350: same order as loncoursedata::get_classlist() for student data.
7351:
1.609 raeburn 7352: Optional statushash returns
7353:
1.288 raeburn 7354: Entries for end, start, section and status are blank because
7355: of the possibility of multiple values for non-student roles.
7356:
1.275 raeburn 7357: =cut
1.405 albertel 7358:
1.275 raeburn 7359: ###############################################
1.405 albertel 7360:
1.275 raeburn 7361: sub get_course_users {
1.630 raeburn 7362: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 7363: my %idx = ();
1.419 raeburn 7364: my %seclists;
1.288 raeburn 7365:
7366: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
7367: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
7368: $idx{end} = &Apache::loncoursedata::CL_END();
7369: $idx{start} = &Apache::loncoursedata::CL_START();
7370: $idx{id} = &Apache::loncoursedata::CL_ID();
7371: $idx{section} = &Apache::loncoursedata::CL_SECTION();
7372: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
7373: $idx{status} = &Apache::loncoursedata::CL_STATUS();
7374:
1.290 albertel 7375: if (grep(/^st$/,@{$roles})) {
1.276 albertel 7376: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 7377: my $now = time;
1.277 albertel 7378: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 7379: my $match = 0;
1.412 raeburn 7380: my $secmatch = 0;
1.419 raeburn 7381: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 7382: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 7383: if ($section eq '') {
7384: $section = 'none';
7385: }
1.291 albertel 7386: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7387: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7388: $secmatch = 1;
7389: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 7390: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7391: $secmatch = 1;
7392: }
7393: } else {
1.419 raeburn 7394: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 7395: $secmatch = 1;
7396: }
1.290 albertel 7397: }
1.412 raeburn 7398: if (!$secmatch) {
7399: next;
7400: }
1.419 raeburn 7401: }
1.275 raeburn 7402: if (defined($$types{'active'})) {
1.288 raeburn 7403: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 7404: push(@{$$users{st}{$student}},'active');
1.288 raeburn 7405: $match = 1;
1.275 raeburn 7406: }
7407: }
7408: if (defined($$types{'previous'})) {
1.609 raeburn 7409: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 7410: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 7411: $match = 1;
1.275 raeburn 7412: }
7413: }
7414: if (defined($$types{'future'})) {
1.609 raeburn 7415: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 7416: push(@{$$users{st}{$student}},'future');
1.288 raeburn 7417: $match = 1;
1.275 raeburn 7418: }
7419: }
1.609 raeburn 7420: if ($match) {
7421: push(@{$seclists{$student}},$section);
7422: if (ref($userdata) eq 'HASH') {
7423: $$userdata{$student} = $$classlist{$student};
7424: }
7425: if (ref($statushash) eq 'HASH') {
7426: $statushash->{$student}{'st'}{$section} = $status;
7427: }
1.288 raeburn 7428: }
1.275 raeburn 7429: }
7430: }
1.412 raeburn 7431: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 7432: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7433: my $now = time;
1.609 raeburn 7434: my %displaystatus = ( previous => 'Expired',
7435: active => 'Active',
7436: future => 'Future',
7437: );
1.630 raeburn 7438: my %nothide;
7439: if ($hidepriv) {
7440: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
7441: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
7442: if ($user !~ /:/) {
7443: $nothide{join(':',split(/[\@]/,$user))}=1;
7444: } else {
7445: $nothide{$user} = 1;
7446: }
7447: }
7448: }
1.439 raeburn 7449: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 7450: my $match = 0;
1.412 raeburn 7451: my $secmatch = 0;
1.439 raeburn 7452: my $status;
1.412 raeburn 7453: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 7454: $user =~ s/:$//;
1.439 raeburn 7455: my ($end,$start) = split(/:/,$coursepersonnel{$person});
7456: if ($end == -1 || $start == -1) {
7457: next;
7458: }
7459: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
7460: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 7461: my ($uname,$udom) = split(/:/,$user);
7462: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7463: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7464: $secmatch = 1;
7465: } elsif ($usec eq '') {
1.420 albertel 7466: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7467: $secmatch = 1;
7468: }
7469: } else {
7470: if (grep(/^\Q$usec\E$/,@{$sections})) {
7471: $secmatch = 1;
7472: }
7473: }
7474: if (!$secmatch) {
7475: next;
7476: }
1.288 raeburn 7477: }
1.419 raeburn 7478: if ($usec eq '') {
7479: $usec = 'none';
7480: }
1.275 raeburn 7481: if ($uname ne '' && $udom ne '') {
1.630 raeburn 7482: if ($hidepriv) {
7483: if ((&Apache::lonnet::privileged($uname,$udom)) &&
7484: (!$nothide{$uname.':'.$udom})) {
7485: next;
7486: }
7487: }
1.503 raeburn 7488: if ($end > 0 && $end < $now) {
1.439 raeburn 7489: $status = 'previous';
7490: } elsif ($start > $now) {
7491: $status = 'future';
7492: } else {
7493: $status = 'active';
7494: }
1.277 albertel 7495: foreach my $type (keys(%{$types})) {
1.275 raeburn 7496: if ($status eq $type) {
1.420 albertel 7497: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 7498: push(@{$$users{$role}{$user}},$type);
7499: }
1.288 raeburn 7500: $match = 1;
7501: }
7502: }
1.419 raeburn 7503: if (($match) && (ref($userdata) eq 'HASH')) {
7504: if (!exists($$userdata{$uname.':'.$udom})) {
7505: &get_user_info($udom,$uname,\%idx,$userdata);
7506: }
1.420 albertel 7507: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 7508: push(@{$seclists{$uname.':'.$udom}},$usec);
7509: }
1.609 raeburn 7510: if (ref($statushash) eq 'HASH') {
7511: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
7512: }
1.275 raeburn 7513: }
7514: }
7515: }
7516: }
1.290 albertel 7517: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 7518: if ((defined($cdom)) && (defined($cnum))) {
7519: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
7520: if ( defined($csettings{'internal.courseowner'}) ) {
7521: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 7522: next if ($owner eq '');
7523: my ($ownername,$ownerdom);
7524: if ($owner =~ /^([^:]+):([^:]+)$/) {
7525: $ownername = $1;
7526: $ownerdom = $2;
7527: } else {
7528: $ownername = $owner;
7529: $ownerdom = $cdom;
7530: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 7531: }
7532: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 7533: if (defined($userdata) &&
1.609 raeburn 7534: !exists($$userdata{$owner})) {
7535: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
7536: if (!grep(/^none$/,@{$seclists{$owner}})) {
7537: push(@{$seclists{$owner}},'none');
7538: }
7539: if (ref($statushash) eq 'HASH') {
7540: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 7541: }
1.290 albertel 7542: }
1.279 raeburn 7543: }
7544: }
7545: }
1.419 raeburn 7546: foreach my $user (keys(%seclists)) {
7547: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
7548: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
7549: }
1.275 raeburn 7550: }
7551: return;
7552: }
7553:
1.288 raeburn 7554: sub get_user_info {
7555: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 7556: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
7557: &plainname($uname,$udom,'lastname');
1.291 albertel 7558: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 7559: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 7560: my %idhash = &Apache::lonnet::idrget($udom,($uname));
7561: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 7562: return;
7563: }
1.275 raeburn 7564:
1.472 raeburn 7565: ###############################################
7566:
7567: =pod
7568:
7569: =item * &get_user_quota()
7570:
7571: Retrieves quota assigned for storage of portfolio files for a user
7572:
7573: Incoming parameters:
7574: 1. user's username
7575: 2. user's domain
7576:
7577: Returns:
1.536 raeburn 7578: 1. Disk quota (in Mb) assigned to student.
7579: 2. (Optional) Type of setting: custom or default
7580: (individually assigned or default for user's
7581: institutional status).
7582: 3. (Optional) - User's institutional status (e.g., faculty, staff
7583: or student - types as defined in localenroll::inst_usertypes
7584: for user's domain, which determines default quota for user.
7585: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 7586:
7587: If a value has been stored in the user's environment,
1.536 raeburn 7588: it will return that, otherwise it returns the maximal default
7589: defined for the user's instituional status(es) in the domain.
1.472 raeburn 7590:
7591: =cut
7592:
7593: ###############################################
7594:
7595:
7596: sub get_user_quota {
7597: my ($uname,$udom) = @_;
1.536 raeburn 7598: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 7599: if (!defined($udom)) {
7600: $udom = $env{'user.domain'};
7601: }
7602: if (!defined($uname)) {
7603: $uname = $env{'user.name'};
7604: }
7605: if (($udom eq '' || $uname eq '') ||
7606: ($udom eq 'public') && ($uname eq 'public')) {
7607: $quota = 0;
1.536 raeburn 7608: $quotatype = 'default';
7609: $defquota = 0;
1.472 raeburn 7610: } else {
1.536 raeburn 7611: my $inststatus;
1.472 raeburn 7612: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
7613: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 7614: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 7615: } else {
1.536 raeburn 7616: my %userenv =
7617: &Apache::lonnet::get('environment',['portfolioquota',
7618: 'inststatus'],$udom,$uname);
1.472 raeburn 7619: my ($tmp) = keys(%userenv);
7620: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7621: $quota = $userenv{'portfolioquota'};
1.536 raeburn 7622: $inststatus = $userenv{'inststatus'};
1.472 raeburn 7623: } else {
7624: undef(%userenv);
7625: }
7626: }
1.536 raeburn 7627: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 7628: if ($quota eq '') {
1.536 raeburn 7629: $quota = $defquota;
7630: $quotatype = 'default';
7631: } else {
7632: $quotatype = 'custom';
1.472 raeburn 7633: }
7634: }
1.536 raeburn 7635: if (wantarray) {
7636: return ($quota,$quotatype,$settingstatus,$defquota);
7637: } else {
7638: return $quota;
7639: }
1.472 raeburn 7640: }
7641:
7642: ###############################################
7643:
7644: =pod
7645:
7646: =item * &default_quota()
7647:
1.536 raeburn 7648: Retrieves default quota assigned for storage of user portfolio files,
7649: given an (optional) user's institutional status.
1.472 raeburn 7650:
7651: Incoming parameters:
7652: 1. domain
1.536 raeburn 7653: 2. (Optional) institutional status(es). This is a : separated list of
7654: status types (e.g., faculty, staff, student etc.)
7655: which apply to the user for whom the default is being retrieved.
7656: If the institutional status string in undefined, the domain
7657: default quota will be returned.
1.472 raeburn 7658:
7659: Returns:
7660: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 7661: 2. (Optional) institutional type which determined the value of the
7662: default quota.
1.472 raeburn 7663:
7664: If a value has been stored in the domain's configuration db,
7665: it will return that, otherwise it returns 20 (for backwards
7666: compatibility with domains which have not set up a configuration
7667: db file; the original statically defined portfolio quota was 20 Mb).
7668:
1.536 raeburn 7669: If the user's status includes multiple types (e.g., staff and student),
7670: the largest default quota which applies to the user determines the
7671: default quota returned.
7672:
1.780 raeburn 7673: =back
7674:
1.472 raeburn 7675: =cut
7676:
7677: ###############################################
7678:
7679:
7680: sub default_quota {
1.536 raeburn 7681: my ($udom,$inststatus) = @_;
7682: my ($defquota,$settingstatus);
7683: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 7684: ['quotas'],$udom);
7685: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 7686: if ($inststatus ne '') {
1.765 raeburn 7687: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 7688: foreach my $item (@statuses) {
1.711 raeburn 7689: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7690: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
7691: if ($defquota eq '') {
7692: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7693: $settingstatus = $item;
7694: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
7695: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7696: $settingstatus = $item;
7697: }
7698: }
7699: } else {
7700: if ($quotahash{'quotas'}{$item} ne '') {
7701: if ($defquota eq '') {
7702: $defquota = $quotahash{'quotas'}{$item};
7703: $settingstatus = $item;
7704: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
7705: $defquota = $quotahash{'quotas'}{$item};
7706: $settingstatus = $item;
7707: }
1.536 raeburn 7708: }
7709: }
7710: }
7711: }
7712: if ($defquota eq '') {
1.711 raeburn 7713: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7714: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
7715: } else {
7716: $defquota = $quotahash{'quotas'}{'default'};
7717: }
1.536 raeburn 7718: $settingstatus = 'default';
7719: }
7720: } else {
7721: $settingstatus = 'default';
7722: $defquota = 20;
7723: }
7724: if (wantarray) {
7725: return ($defquota,$settingstatus);
1.472 raeburn 7726: } else {
1.536 raeburn 7727: return $defquota;
1.472 raeburn 7728: }
7729: }
7730:
1.384 raeburn 7731: sub get_secgrprole_info {
7732: my ($cdom,$cnum,$needroles,$type) = @_;
7733: my %sections_count = &get_sections($cdom,$cnum);
7734: my @sections = (sort {$a <=> $b} keys(%sections_count));
7735: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
7736: my @groups = sort(keys(%curr_groups));
7737: my $allroles = [];
7738: my $rolehash;
7739: my $accesshash = {
7740: active => 'Currently has access',
7741: future => 'Will have future access',
7742: previous => 'Previously had access',
7743: };
7744: if ($needroles) {
7745: $rolehash = {'all' => 'all'};
1.385 albertel 7746: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7747: if (&Apache::lonnet::error(%user_roles)) {
7748: undef(%user_roles);
7749: }
7750: foreach my $item (keys(%user_roles)) {
1.384 raeburn 7751: my ($role)=split(/\:/,$item,2);
7752: if ($role eq 'cr') { next; }
7753: if ($role =~ /^cr/) {
7754: $$rolehash{$role} = (split('/',$role))[3];
7755: } else {
7756: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
7757: }
7758: }
7759: foreach my $key (sort(keys(%{$rolehash}))) {
7760: push(@{$allroles},$key);
7761: }
7762: push (@{$allroles},'st');
7763: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
7764: }
7765: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
7766: }
7767:
1.555 raeburn 7768: sub user_picker {
1.994 raeburn 7769: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context) = @_;
1.555 raeburn 7770: my $currdom = $dom;
7771: my %curr_selected = (
7772: srchin => 'dom',
1.580 raeburn 7773: srchby => 'lastname',
1.555 raeburn 7774: );
7775: my $srchterm;
1.625 raeburn 7776: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 7777: if ($srch->{'srchby'} ne '') {
7778: $curr_selected{'srchby'} = $srch->{'srchby'};
7779: }
7780: if ($srch->{'srchin'} ne '') {
7781: $curr_selected{'srchin'} = $srch->{'srchin'};
7782: }
7783: if ($srch->{'srchtype'} ne '') {
7784: $curr_selected{'srchtype'} = $srch->{'srchtype'};
7785: }
7786: if ($srch->{'srchdomain'} ne '') {
7787: $currdom = $srch->{'srchdomain'};
7788: }
7789: $srchterm = $srch->{'srchterm'};
7790: }
7791: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 7792: 'usr' => 'Search criteria',
1.563 raeburn 7793: 'doma' => 'Domain/institution to search',
1.558 albertel 7794: 'uname' => 'username',
7795: 'lastname' => 'last name',
1.555 raeburn 7796: 'lastfirst' => 'last name, first name',
1.558 albertel 7797: 'crs' => 'in this course',
1.576 raeburn 7798: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 7799: 'alc' => 'all LON-CAPA',
1.573 raeburn 7800: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 7801: 'exact' => 'is',
7802: 'contains' => 'contains',
1.569 raeburn 7803: 'begins' => 'begins with',
1.571 raeburn 7804: 'youm' => "You must include some text to search for.",
7805: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
7806: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
7807: 'yomc' => "You must choose a domain when using an institutional directory search.",
7808: 'ymcd' => "You must choose a domain when using a domain search.",
7809: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
7810: 'whse' => "When searching by last,first you must include at least one character in the first name.",
7811: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 7812: );
1.563 raeburn 7813: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
7814: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 7815:
7816: my @srchins = ('crs','dom','alc','instd');
7817:
7818: foreach my $option (@srchins) {
7819: # FIXME 'alc' option unavailable until
7820: # loncreateuser::print_user_query_page()
7821: # has been completed.
7822: next if ($option eq 'alc');
1.880 raeburn 7823: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 7824: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 7825: if ($curr_selected{'srchin'} eq $option) {
7826: $srchinsel .= '
7827: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7828: } else {
7829: $srchinsel .= '
7830: <option value="'.$option.'">'.$lt{$option}.'</option>';
7831: }
1.555 raeburn 7832: }
1.563 raeburn 7833: $srchinsel .= "\n </select>\n";
1.555 raeburn 7834:
7835: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 7836: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 7837: if ($curr_selected{'srchby'} eq $option) {
7838: $srchbysel .= '
7839: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7840: } else {
7841: $srchbysel .= '
7842: <option value="'.$option.'">'.$lt{$option}.'</option>';
7843: }
7844: }
7845: $srchbysel .= "\n </select>\n";
7846:
7847: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 7848: foreach my $option ('begins','contains','exact') {
1.555 raeburn 7849: if ($curr_selected{'srchtype'} eq $option) {
7850: $srchtypesel .= '
7851: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7852: } else {
7853: $srchtypesel .= '
7854: <option value="'.$option.'">'.$lt{$option}.'</option>';
7855: }
7856: }
7857: $srchtypesel .= "\n </select>\n";
7858:
1.558 albertel 7859: my ($newuserscript,$new_user_create);
1.994 raeburn 7860: my $context_dom = $env{'request.role.domain'};
7861: if ($context eq 'requestcrs') {
7862: if ($env{'form.coursedom'} ne '') {
7863: $context_dom = $env{'form.coursedom'};
7864: }
7865: }
1.556 raeburn 7866: if ($forcenewuser) {
1.576 raeburn 7867: if (ref($srch) eq 'HASH') {
1.994 raeburn 7868: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 7869: if ($cancreate) {
7870: $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>';
7871: } else {
1.799 bisitz 7872: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 7873: my %usertypetext = (
7874: official => 'institutional',
7875: unofficial => 'non-institutional',
7876: );
1.799 bisitz 7877: $new_user_create = '<p class="LC_warning">'
7878: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
7879: .' '
7880: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
7881: ,'<a href="'.$helplink.'">','</a>')
7882: .'</p><br />';
1.627 raeburn 7883: }
1.576 raeburn 7884: }
7885: }
7886:
1.556 raeburn 7887: $newuserscript = <<"ENDSCRIPT";
7888:
1.570 raeburn 7889: function setSearch(createnew,callingForm) {
1.556 raeburn 7890: if (createnew == 1) {
1.570 raeburn 7891: for (var i=0; i<callingForm.srchby.length; i++) {
7892: if (callingForm.srchby.options[i].value == 'uname') {
7893: callingForm.srchby.selectedIndex = i;
1.556 raeburn 7894: }
7895: }
1.570 raeburn 7896: for (var i=0; i<callingForm.srchin.length; i++) {
7897: if ( callingForm.srchin.options[i].value == 'dom') {
7898: callingForm.srchin.selectedIndex = i;
1.556 raeburn 7899: }
7900: }
1.570 raeburn 7901: for (var i=0; i<callingForm.srchtype.length; i++) {
7902: if (callingForm.srchtype.options[i].value == 'exact') {
7903: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 7904: }
7905: }
1.570 raeburn 7906: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 7907: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 7908: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 7909: }
7910: }
7911: }
7912: }
7913: ENDSCRIPT
1.558 albertel 7914:
1.556 raeburn 7915: }
7916:
1.555 raeburn 7917: my $output = <<"END_BLOCK";
1.556 raeburn 7918: <script type="text/javascript">
1.824 bisitz 7919: // <![CDATA[
1.570 raeburn 7920: function validateEntry(callingForm) {
1.558 albertel 7921:
1.556 raeburn 7922: var checkok = 1;
1.558 albertel 7923: var srchin;
1.570 raeburn 7924: for (var i=0; i<callingForm.srchin.length; i++) {
7925: if ( callingForm.srchin[i].checked ) {
7926: srchin = callingForm.srchin[i].value;
1.558 albertel 7927: }
7928: }
7929:
1.570 raeburn 7930: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7931: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7932: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7933: var srchterm = callingForm.srchterm.value;
7934: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7935: var msg = "";
7936:
7937: if (srchterm == "") {
7938: checkok = 0;
1.571 raeburn 7939: msg += "$lt{'youm'}\\n";
1.556 raeburn 7940: }
7941:
1.569 raeburn 7942: if (srchtype== 'begins') {
7943: if (srchterm.length < 2) {
7944: checkok = 0;
1.571 raeburn 7945: msg += "$lt{'thte'}\\n";
1.569 raeburn 7946: }
7947: }
7948:
1.556 raeburn 7949: if (srchtype== 'contains') {
7950: if (srchterm.length < 3) {
7951: checkok = 0;
1.571 raeburn 7952: msg += "$lt{'thet'}\\n";
1.556 raeburn 7953: }
7954: }
7955: if (srchin == 'instd') {
7956: if (srchdomain == '') {
7957: checkok = 0;
1.571 raeburn 7958: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7959: }
7960: }
7961: if (srchin == 'dom') {
7962: if (srchdomain == '') {
7963: checkok = 0;
1.571 raeburn 7964: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7965: }
7966: }
7967: if (srchby == 'lastfirst') {
7968: if (srchterm.indexOf(",") == -1) {
7969: checkok = 0;
1.571 raeburn 7970: msg += "$lt{'whus'}\\n";
1.556 raeburn 7971: }
7972: if (srchterm.indexOf(",") == srchterm.length -1) {
7973: checkok = 0;
1.571 raeburn 7974: msg += "$lt{'whse'}\\n";
1.556 raeburn 7975: }
7976: }
7977: if (checkok == 0) {
1.571 raeburn 7978: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7979: return;
7980: }
7981: if (checkok == 1) {
1.570 raeburn 7982: callingForm.submit();
1.556 raeburn 7983: }
7984: }
7985:
7986: $newuserscript
7987:
1.824 bisitz 7988: // ]]>
1.556 raeburn 7989: </script>
1.558 albertel 7990:
7991: $new_user_create
7992:
1.555 raeburn 7993: END_BLOCK
1.558 albertel 7994:
1.876 raeburn 7995: $output .= &Apache::lonhtmlcommon::start_pick_box().
7996: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
7997: $domform.
7998: &Apache::lonhtmlcommon::row_closure().
7999: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
8000: $srchbysel.
8001: $srchtypesel.
8002: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
8003: $srchinsel.
8004: &Apache::lonhtmlcommon::row_closure(1).
8005: &Apache::lonhtmlcommon::end_pick_box().
8006: '<br />';
1.555 raeburn 8007: return $output;
8008: }
8009:
1.612 raeburn 8010: sub user_rule_check {
1.615 raeburn 8011: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 8012: my $response;
8013: if (ref($usershash) eq 'HASH') {
8014: foreach my $user (keys(%{$usershash})) {
8015: my ($uname,$udom) = split(/:/,$user);
8016: next if ($udom eq '' || $uname eq '');
1.615 raeburn 8017: my ($id,$newuser);
1.612 raeburn 8018: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 8019: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 8020: $id = $usershash->{$user}->{'id'};
8021: }
8022: my $inst_response;
8023: if (ref($checks) eq 'HASH') {
8024: if (defined($checks->{'username'})) {
1.615 raeburn 8025: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 8026: &Apache::lonnet::get_instuser($udom,$uname);
8027: } elsif (defined($checks->{'id'})) {
1.615 raeburn 8028: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 8029: &Apache::lonnet::get_instuser($udom,undef,$id);
8030: }
1.615 raeburn 8031: } else {
8032: ($inst_response,%{$inst_results->{$user}}) =
8033: &Apache::lonnet::get_instuser($udom,$uname);
8034: return;
1.612 raeburn 8035: }
1.615 raeburn 8036: if (!$got_rules->{$udom}) {
1.612 raeburn 8037: my %domconfig = &Apache::lonnet::get_dom('configuration',
8038: ['usercreation'],$udom);
8039: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 8040: foreach my $item ('username','id') {
1.612 raeburn 8041: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
8042: $$curr_rules{$udom}{$item} =
8043: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 8044: }
8045: }
8046: }
1.615 raeburn 8047: $got_rules->{$udom} = 1;
1.585 raeburn 8048: }
1.612 raeburn 8049: foreach my $item (keys(%{$checks})) {
8050: if (ref($$curr_rules{$udom}) eq 'HASH') {
8051: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
8052: if (@{$$curr_rules{$udom}{$item}} > 0) {
8053: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
8054: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
8055: if ($rule_check{$rule}) {
8056: $$rulematch{$user}{$item} = $rule;
8057: if ($inst_response eq 'ok') {
1.615 raeburn 8058: if (ref($inst_results) eq 'HASH') {
8059: if (ref($inst_results->{$user}) eq 'HASH') {
8060: if (keys(%{$inst_results->{$user}}) == 0) {
8061: $$alerts{$item}{$udom}{$uname} = 1;
8062: }
1.612 raeburn 8063: }
8064: }
1.615 raeburn 8065: }
8066: last;
1.585 raeburn 8067: }
8068: }
8069: }
8070: }
8071: }
8072: }
8073: }
8074: }
1.612 raeburn 8075: return;
8076: }
8077:
8078: sub user_rule_formats {
8079: my ($domain,$domdesc,$curr_rules,$check) = @_;
8080: my %text = (
8081: 'username' => 'Usernames',
8082: 'id' => 'IDs',
8083: );
8084: my $output;
8085: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
8086: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
8087: if (@{$ruleorder} > 0) {
8088: $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>';
8089: foreach my $rule (@{$ruleorder}) {
8090: if (ref($curr_rules) eq 'ARRAY') {
8091: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
8092: if (ref($rules->{$rule}) eq 'HASH') {
8093: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
8094: $rules->{$rule}{'desc'}.'</li>';
8095: }
8096: }
8097: }
8098: }
8099: $output .= '</ul>';
8100: }
8101: }
8102: return $output;
8103: }
8104:
8105: sub instrule_disallow_msg {
1.615 raeburn 8106: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 8107: my $response;
8108: my %text = (
8109: item => 'username',
8110: items => 'usernames',
8111: match => 'matches',
8112: do => 'does',
8113: action => 'a username',
8114: one => 'one',
8115: );
8116: if ($count > 1) {
8117: $text{'item'} = 'usernames';
8118: $text{'match'} ='match';
8119: $text{'do'} = 'do';
8120: $text{'action'} = 'usernames',
8121: $text{'one'} = 'ones';
8122: }
8123: if ($checkitem eq 'id') {
8124: $text{'items'} = 'IDs';
8125: $text{'item'} = 'ID';
8126: $text{'action'} = 'an ID';
1.615 raeburn 8127: if ($count > 1) {
8128: $text{'item'} = 'IDs';
8129: $text{'action'} = 'IDs';
8130: }
1.612 raeburn 8131: }
1.674 bisitz 8132: $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 8133: if ($mode eq 'upload') {
8134: if ($checkitem eq 'username') {
8135: $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'}.");
8136: } elsif ($checkitem eq 'id') {
1.674 bisitz 8137: $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 8138: }
1.669 raeburn 8139: } elsif ($mode eq 'selfcreate') {
8140: if ($checkitem eq 'id') {
8141: $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.");
8142: }
1.615 raeburn 8143: } else {
8144: if ($checkitem eq 'username') {
8145: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
8146: } elsif ($checkitem eq 'id') {
8147: $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.");
8148: }
1.612 raeburn 8149: }
8150: return $response;
1.585 raeburn 8151: }
8152:
1.624 raeburn 8153: sub personal_data_fieldtitles {
8154: my %fieldtitles = &Apache::lonlocal::texthash (
8155: id => 'Student/Employee ID',
8156: permanentemail => 'E-mail address',
8157: lastname => 'Last Name',
8158: firstname => 'First Name',
8159: middlename => 'Middle Name',
8160: generation => 'Generation',
8161: gen => 'Generation',
1.765 raeburn 8162: inststatus => 'Affiliation',
1.624 raeburn 8163: );
8164: return %fieldtitles;
8165: }
8166:
1.642 raeburn 8167: sub sorted_inst_types {
8168: my ($dom) = @_;
8169: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
8170: my $othertitle = &mt('All users');
8171: if ($env{'request.course.id'}) {
1.668 raeburn 8172: $othertitle = &mt('Any users');
1.642 raeburn 8173: }
8174: my @types;
8175: if (ref($order) eq 'ARRAY') {
8176: @types = @{$order};
8177: }
8178: if (@types == 0) {
8179: if (ref($usertypes) eq 'HASH') {
8180: @types = sort(keys(%{$usertypes}));
8181: }
8182: }
8183: if (keys(%{$usertypes}) > 0) {
8184: $othertitle = &mt('Other users');
8185: }
8186: return ($othertitle,$usertypes,\@types);
8187: }
8188:
1.645 raeburn 8189: sub get_institutional_codes {
8190: my ($settings,$allcourses,$LC_code) = @_;
8191: # Get complete list of course sections to update
8192: my @currsections = ();
8193: my @currxlists = ();
8194: my $coursecode = $$settings{'internal.coursecode'};
8195:
8196: if ($$settings{'internal.sectionnums'} ne '') {
8197: @currsections = split(/,/,$$settings{'internal.sectionnums'});
8198: }
8199:
8200: if ($$settings{'internal.crosslistings'} ne '') {
8201: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
8202: }
8203:
8204: if (@currxlists > 0) {
8205: foreach (@currxlists) {
8206: if (m/^([^:]+):(\w*)$/) {
8207: unless (grep/^$1$/,@{$allcourses}) {
8208: push @{$allcourses},$1;
8209: $$LC_code{$1} = $2;
8210: }
8211: }
8212: }
8213: }
8214:
8215: if (@currsections > 0) {
8216: foreach (@currsections) {
8217: if (m/^(\w+):(\w*)$/) {
8218: my $sec = $coursecode.$1;
8219: my $lc_sec = $2;
8220: unless (grep/^$sec$/,@{$allcourses}) {
8221: push @{$allcourses},$sec;
8222: $$LC_code{$sec} = $lc_sec;
8223: }
8224: }
8225: }
8226: }
8227: return;
8228: }
8229:
1.971 raeburn 8230: sub get_standard_codeitems {
8231: return ('Year','Semester','Department','Number','Section');
8232: }
8233:
1.112 bowersj2 8234: =pod
8235:
1.780 raeburn 8236: =head1 Slot Helpers
8237:
8238: =over 4
8239:
8240: =item * sorted_slots()
8241:
8242: Sorts an array of slot names in order of slot start time (earliest first).
8243:
8244: Inputs:
8245:
8246: =over 4
8247:
8248: slotsarr - Reference to array of unsorted slot names.
8249:
8250: slots - Reference to hash of hash, where outer hash keys are slot names.
8251:
1.549 albertel 8252: =back
8253:
1.780 raeburn 8254: Returns:
8255:
8256: =over 4
8257:
8258: sorted - An array of slot names sorted by the start time of the slot.
8259:
8260: =back
8261:
8262: =back
8263:
8264: =cut
8265:
8266:
8267: sub sorted_slots {
8268: my ($slotsarr,$slots) = @_;
8269: my @sorted;
8270: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
8271: @sorted =
8272: sort {
8273: if (ref($slots->{$a}) && ref($slots->{$b})) {
8274: return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
8275: }
8276: if (ref($slots->{$a})) { return -1;}
8277: if (ref($slots->{$b})) { return 1;}
8278: return 0;
8279: } @{$slotsarr};
8280: }
8281: return @sorted;
8282: }
8283:
8284:
8285: =pod
8286:
1.549 albertel 8287: =head1 HTTP Helpers
8288:
8289: =over 4
8290:
1.648 raeburn 8291: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 8292:
1.258 albertel 8293: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 8294: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 8295: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 8296:
8297: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
8298: $possible_names is an ref to an array of form element names. As an example:
8299: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 8300: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 8301:
8302: =cut
1.1 albertel 8303:
1.6 albertel 8304: sub get_unprocessed_cgi {
1.25 albertel 8305: my ($query,$possible_names)= @_;
1.26 matthew 8306: # $Apache::lonxml::debug=1;
1.356 albertel 8307: foreach my $pair (split(/&/,$query)) {
8308: my ($name, $value) = split(/=/,$pair);
1.369 www 8309: $name = &unescape($name);
1.25 albertel 8310: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
8311: $value =~ tr/+/ /;
8312: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 8313: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 8314: }
1.16 harris41 8315: }
1.6 albertel 8316: }
8317:
1.112 bowersj2 8318: =pod
8319:
1.648 raeburn 8320: =item * &cacheheader()
1.112 bowersj2 8321:
8322: returns cache-controlling header code
8323:
8324: =cut
8325:
1.7 albertel 8326: sub cacheheader {
1.258 albertel 8327: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 8328: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
8329: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 8330: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
8331: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 8332: return $output;
1.7 albertel 8333: }
8334:
1.112 bowersj2 8335: =pod
8336:
1.648 raeburn 8337: =item * &no_cache($r)
1.112 bowersj2 8338:
8339: specifies header code to not have cache
8340:
8341: =cut
8342:
1.9 albertel 8343: sub no_cache {
1.216 albertel 8344: my ($r) = @_;
8345: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 8346: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 8347: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
8348: $r->no_cache(1);
8349: $r->header_out("Expires" => $date);
8350: $r->header_out("Pragma" => "no-cache");
1.123 www 8351: }
8352:
8353: sub content_type {
1.181 albertel 8354: my ($r,$type,$charset) = @_;
1.299 foxr 8355: if ($r) {
8356: # Note that printout.pl calls this with undef for $r.
8357: &no_cache($r);
8358: }
1.258 albertel 8359: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 8360: unless ($charset) {
8361: $charset=&Apache::lonlocal::current_encoding;
8362: }
8363: if ($charset) { $type.='; charset='.$charset; }
8364: if ($r) {
8365: $r->content_type($type);
8366: } else {
8367: print("Content-type: $type\n\n");
8368: }
1.9 albertel 8369: }
1.25 albertel 8370:
1.112 bowersj2 8371: =pod
8372:
1.648 raeburn 8373: =item * &add_to_env($name,$value)
1.112 bowersj2 8374:
1.258 albertel 8375: adds $name to the %env hash with value
1.112 bowersj2 8376: $value, if $name already exists, the entry is converted to an array
8377: reference and $value is added to the array.
8378:
8379: =cut
8380:
1.25 albertel 8381: sub add_to_env {
8382: my ($name,$value)=@_;
1.258 albertel 8383: if (defined($env{$name})) {
8384: if (ref($env{$name})) {
1.25 albertel 8385: #already have multiple values
1.258 albertel 8386: push(@{ $env{$name} },$value);
1.25 albertel 8387: } else {
8388: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 8389: my $first=$env{$name};
8390: undef($env{$name});
8391: push(@{ $env{$name} },$first,$value);
1.25 albertel 8392: }
8393: } else {
1.258 albertel 8394: $env{$name}=$value;
1.25 albertel 8395: }
1.31 albertel 8396: }
1.149 albertel 8397:
8398: =pod
8399:
1.648 raeburn 8400: =item * &get_env_multiple($name)
1.149 albertel 8401:
1.258 albertel 8402: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 8403: values may be defined and end up as an array ref.
8404:
8405: returns an array of values
8406:
8407: =cut
8408:
8409: sub get_env_multiple {
8410: my ($name) = @_;
8411: my @values;
1.258 albertel 8412: if (defined($env{$name})) {
1.149 albertel 8413: # exists is it an array
1.258 albertel 8414: if (ref($env{$name})) {
8415: @values=@{ $env{$name} };
1.149 albertel 8416: } else {
1.258 albertel 8417: $values[0]=$env{$name};
1.149 albertel 8418: }
8419: }
8420: return(@values);
8421: }
8422:
1.660 raeburn 8423: sub ask_for_embedded_content {
8424: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.987 raeburn 8425: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges);
1.660 raeburn 8426: my $num = 0;
1.987 raeburn 8427: my $numremref = 0;
8428: my $numinvalid = 0;
8429: my $numpathchg = 0;
8430: my $numexisting = 0;
8431: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath);
1.984 raeburn 8432: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
8433: my $current_path='/';
8434: if ($env{'form.currentpath'}) {
8435: $current_path = $env{'form.currentpath'};
8436: }
8437: if ($actionurl eq '/adm/coursegrp_portfolio') {
8438: $udom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8439: $uname = $env{'course.'.$env{'request.course.id'}.'.num'};
8440: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
8441: } else {
8442: $udom = $env{'user.domain'};
8443: $uname = $env{'user.name'};
8444: $url = '/userfiles/portfolio';
8445: }
1.987 raeburn 8446: $toplevel = $url.'/';
1.984 raeburn 8447: $url .= $current_path;
8448: $getpropath = 1;
1.987 raeburn 8449: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
8450: ($actionurl eq '/adm/imsimport')) {
1.984 raeburn 8451: ($uname,my $rest) = ($args->{'current_path'} =~ m{/priv/($match_username)/?(.*)$});
1.987 raeburn 8452: $url = '/home/'.$uname.'/public_html/';
8453: $toplevel = $url;
1.984 raeburn 8454: if ($rest ne '') {
1.987 raeburn 8455: $url .= $rest;
8456: }
8457: } elsif ($actionurl eq '/adm/coursedocs') {
8458: if (ref($args) eq 'HASH') {
8459: $url = $args->{'docs_url'};
8460: $toplevel = $url;
8461: }
8462: }
8463: my $now = time();
8464: foreach my $embed_file (keys(%{$allfiles})) {
8465: my $absolutepath;
8466: if ($embed_file =~ m{^\w+://}) {
8467: $newfiles{$embed_file} = 1;
8468: $mapping{$embed_file} = $embed_file;
8469: } else {
8470: if ($embed_file =~ m{^/}) {
8471: $absolutepath = $embed_file;
8472: $embed_file =~ s{^(/+)}{};
8473: }
8474: if ($embed_file =~ m{/}) {
8475: my ($path,$fname) = ($embed_file =~ m{^(.+)/([^/]*)$});
8476: $path = &check_for_traversal($path,$url,$toplevel);
8477: my $item = $fname;
8478: if ($path ne '') {
8479: $item = $path.'/'.$fname;
8480: $subdependencies{$path}{$fname} = 1;
8481: } else {
8482: $dependencies{$item} = 1;
8483: }
8484: if ($absolutepath) {
8485: $mapping{$item} = $absolutepath;
8486: } else {
8487: $mapping{$item} = $embed_file;
8488: }
8489: } else {
8490: $dependencies{$embed_file} = 1;
8491: if ($absolutepath) {
8492: $mapping{$embed_file} = $absolutepath;
8493: } else {
8494: $mapping{$embed_file} = $embed_file;
8495: }
8496: }
1.984 raeburn 8497: }
8498: }
8499: foreach my $path (keys(%subdependencies)) {
8500: my %currsubfile;
8501: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
8502: my @subdir_list = &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
8503: foreach my $line (@subdir_list) {
8504: my ($file_name,$rest) = split(/\&/,$line,2);
8505: $currsubfile{$file_name} = 1;
8506: }
1.987 raeburn 8507: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 8508: if (opendir(my $dir,$url.'/'.$path)) {
8509: my @subdir_list = grep(!/^\./,readdir($dir));
8510: map {$currsubfile{$_} = 1;} @subdir_list;
8511: }
8512: }
8513: foreach my $file (keys(%{$subdependencies{$path}})) {
1.987 raeburn 8514: if ($currsubfile{$file}) {
8515: my $item = $path.'/'.$file;
8516: unless ($mapping{$item} eq $item) {
8517: $pathchanges{$item} = 1;
8518: }
8519: $existing{$item} = 1;
8520: $numexisting ++;
8521: } else {
8522: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 8523: }
8524: }
8525: }
1.987 raeburn 8526: my %currfile;
1.984 raeburn 8527: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
8528: my @dir_list = &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
8529: foreach my $line (@dir_list) {
8530: my ($file_name,$rest) = split(/\&/,$line,2);
8531: $currfile{$file_name} = 1;
8532: }
1.987 raeburn 8533: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 8534: if (opendir(my $dir,$url)) {
1.987 raeburn 8535: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 8536: map {$currfile{$_} = 1;} @dir_list;
8537: }
8538: }
8539: foreach my $file (keys(%dependencies)) {
1.987 raeburn 8540: if ($currfile{$file}) {
8541: unless ($mapping{$file} eq $file) {
8542: $pathchanges{$file} = 1;
8543: }
8544: $existing{$file} = 1;
8545: $numexisting ++;
8546: } else {
1.984 raeburn 8547: $newfiles{$file} = 1;
8548: }
8549: }
8550: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.660 raeburn 8551: $upload_output .= &start_data_table_row().
1.987 raeburn 8552: '<td><span class="LC_filename">'.$embed_file.'</span>';
8553: unless ($mapping{$embed_file} eq $embed_file) {
8554: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.&mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
8555: }
8556: $upload_output .= '</td><td>';
1.660 raeburn 8557: if ($args->{'ignore_remote_references'}
8558: && $embed_file =~ m{^\w+://}) {
8559: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
1.987 raeburn 8560: $numremref++;
1.660 raeburn 8561: } elsif ($args->{'error_on_invalid_names'}
8562: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
8563:
1.987 raeburn 8564: $upload_output.='<span class="LC_warning">'.&mt('Invalid characters').'</span>';
8565: $numinvalid++;
1.660 raeburn 8566: } else {
1.987 raeburn 8567: $upload_output .= &embedded_file_element('upload_embedded',$num,
8568: $embed_file,\%mapping,
8569: $allfiles,$codebase);
8570: $num++;
8571: }
8572: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
8573: }
8574: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
8575: $upload_output .= &start_data_table_row().
8576: '<td><span class="LC_filename">'.$embed_file.'</span></td>'.
8577: '<td><span class="LC_warning">'.&mt('Already exists').'</span></td>'.
8578: &Apache::loncommon::end_data_table_row()."\n";
8579: }
8580: if ($upload_output) {
8581: $upload_output = &start_data_table().
8582: $upload_output.
8583: &end_data_table()."\n";
8584: }
8585: my $applies = 0;
8586: if ($numremref) {
8587: $applies ++;
8588: }
8589: if ($numinvalid) {
8590: $applies ++;
8591: }
8592: if ($numexisting) {
8593: $applies ++;
8594: }
8595: if ($num) {
8596: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
8597: ' method="post" enctype="multipart/form-data">'."\n".
8598: $state.
8599: '<h3>'.&mt('Upload embedded files').
8600: ':</h3>'.$upload_output.'<br />'."\n".
8601: '<input type ="hidden" name="number_embedded_items" value="'.
8602: $num.'" />'."\n";
8603: if ($actionurl eq '') {
8604: $output .= '<input type="hidden" name="phase" value="three" />';
8605: }
8606: } elsif ($applies) {
8607: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
8608: if ($applies > 1) {
8609: $output .=
8610: &mt('No files need to be uploaded, as one of the following applies to each reference:').'<ul>';
8611: if ($numremref) {
8612: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
8613: }
8614: if ($numinvalid) {
8615: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
8616: }
8617: if ($numexisting) {
8618: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
8619: }
8620: $output .= '</ul><br />';
8621: } elsif ($numremref) {
8622: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
8623: } elsif ($numinvalid) {
8624: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
8625: } elsif ($numexisting) {
8626: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
8627: }
8628: $output .= $upload_output.'<br />';
8629: }
8630: my ($pathchange_output,$chgcount);
8631: $chgcount = $num;
8632: if (keys(%pathchanges) > 0) {
8633: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
8634: if ($num) {
8635: $output .= &embedded_file_element('pathchange',$chgcount,
8636: $embed_file,\%mapping,
8637: $allfiles,$codebase);
8638: } else {
8639: $pathchange_output .=
8640: &start_data_table_row().
8641: '<td><input type ="checkbox" name="namechange" value="'.
8642: $chgcount.'" checked="checked" /></td>'.
8643: '<td>'.$mapping{$embed_file}.'</td>'.
8644: '<td>'.$embed_file.
8645: &embedded_file_element('pathchange',$numpathchg,$embed_file,
8646: \%mapping,$allfiles,$codebase).
8647: '</td>'.&end_data_table_row();
1.660 raeburn 8648: }
1.987 raeburn 8649: $numpathchg ++;
8650: $chgcount ++;
1.660 raeburn 8651: }
8652: }
1.984 raeburn 8653: if ($num) {
1.987 raeburn 8654: if ($numpathchg) {
8655: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
8656: $numpathchg.'" />'."\n";
8657: }
8658: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
8659: ($actionurl eq '/adm/imsimport')) {
8660: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
8661: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
8662: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
8663: }
8664: $output .= '<input type ="submit" value="'.&mt('Upload Listed Files').'" />'."\n".
8665: &mt('(only files for which a location has been provided will be uploaded)').'</form>'."\n";
8666: } elsif ($numpathchg) {
8667: my %pathchange = ();
8668: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
8669: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
8670: $output .= '<p>'.&mt('or').'</p>';
8671: }
8672: }
8673: return ($output,$num,$numpathchg);
8674: }
8675:
8676: sub embedded_file_element {
8677: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase) = @_;
8678: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
8679: (ref($codebase) eq 'HASH'));
8680: my $output;
8681: if ($context eq 'upload_embedded') {
8682: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
8683: }
8684: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
8685: &escape($embed_file).'" />';
8686: unless (($context eq 'upload_embedded') &&
8687: ($mapping->{$embed_file} eq $embed_file)) {
8688: $output .='
8689: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
8690: }
8691: my $attrib;
8692: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
8693: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
8694: }
8695: $output .=
8696: "\n\t\t".
8697: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
8698: $attrib.'" />';
8699: if (exists($codebase->{$mapping->{$embed_file}})) {
8700: $output .=
8701: "\n\t\t".
8702: '<input name="codebase_'.$num.'" type="hidden" value="'.
8703: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 8704: }
1.987 raeburn 8705: return $output;
1.660 raeburn 8706: }
8707:
1.661 raeburn 8708: sub upload_embedded {
8709: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 8710: $current_disk_usage,$hiddenstate,$actionurl) = @_;
8711: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 8712: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
8713: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
8714: my $orig_uploaded_filename =
8715: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 8716: foreach my $type ('orig','ref','attrib','codebase') {
8717: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
8718: $env{'form.embedded_'.$type.'_'.$i} =
8719: &unescape($env{'form.embedded_'.$type.'_'.$i});
8720: }
8721: }
1.661 raeburn 8722: my ($path,$fname) =
8723: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
8724: # no path, whole string is fname
8725: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
8726: $fname = &Apache::lonnet::clean_filename($fname);
8727: # See if there is anything left
8728: next if ($fname eq '');
8729:
8730: # Check if file already exists as a file or directory.
8731: my ($state,$msg);
8732: if ($context eq 'portfolio') {
8733: my $port_path = $dirpath;
8734: if ($group ne '') {
8735: $port_path = "groups/$group/$port_path";
8736: }
1.987 raeburn 8737: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
8738: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 8739: $dir_root,$port_path,$disk_quota,
8740: $current_disk_usage,$uname,$udom);
8741: if ($state eq 'will_exceed_quota'
1.984 raeburn 8742: || $state eq 'file_locked') {
1.661 raeburn 8743: $output .= $msg;
8744: next;
8745: }
8746: } elsif (($context eq 'author') || ($context eq 'testbank')) {
8747: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
8748: if ($state eq 'exists') {
8749: $output .= $msg;
8750: next;
8751: }
8752: }
8753: # Check if extension is valid
8754: if (($fname =~ /\.(\w+)$/) &&
8755: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.987 raeburn 8756: $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 8757: next;
8758: } elsif (($fname =~ /\.(\w+)$/) &&
8759: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 8760: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 8761: next;
8762: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.987 raeburn 8763: $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 8764: next;
8765: }
8766:
8767: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
8768: if ($context eq 'portfolio') {
1.984 raeburn 8769: my $result;
8770: if ($state eq 'existingfile') {
8771: $result=
8772: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.987 raeburn 8773: $dirpath.$env{'form.currentpath'}.$path);
1.661 raeburn 8774: } else {
1.984 raeburn 8775: $result=
8776: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 8777: $dirpath.
8778: $env{'form.currentpath'}.$path);
1.984 raeburn 8779: if ($result !~ m|^/uploaded/|) {
8780: $output .= '<span class="LC_error">'
8781: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
8782: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
8783: .'</span><br />';
8784: next;
8785: } else {
1.987 raeburn 8786: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
8787: $path.$fname.'</span>').'<br />';
1.984 raeburn 8788: }
1.661 raeburn 8789: }
1.987 raeburn 8790: } elsif ($context eq 'coursedoc') {
8791: my $result =
8792: &Apache::lonnet::userfileupload('embedded_item_'.$i,'coursedoc',
8793: $dirpath.'/'.$path);
8794: if ($result !~ m|^/uploaded/|) {
8795: $output .= '<span class="LC_error">'
8796: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
8797: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
8798: .'</span><br />';
8799: next;
8800: } else {
8801: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
8802: $path.$fname.'</span>').'<br />';
8803: }
1.661 raeburn 8804: } else {
8805: # Save the file
8806: my $target = $env{'form.embedded_item_'.$i};
8807: my $fullpath = $dir_root.$dirpath.'/'.$path;
8808: my $dest = $fullpath.$fname;
8809: my $url = $url_root.$dirpath.'/'.$path.$fname;
8810: my @parts=split(/\//,$fullpath);
8811: my $count;
8812: my $filepath = $dir_root;
8813: for ($count=4;$count<=$#parts;$count++) {
8814: $filepath .= "/$parts[$count]";
8815: if ((-e $filepath)!=1) {
8816: mkdir($filepath,0770);
8817: }
8818: }
8819: my $fh;
8820: if (!open($fh,'>'.$dest)) {
8821: &Apache::lonnet::logthis('Failed to create '.$dest);
8822: $output .= '<span class="LC_error">'.
8823: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8824: '</span><br />';
8825: } else {
8826: if (!print $fh $env{'form.embedded_item_'.$i}) {
8827: &Apache::lonnet::logthis('Failed to write to '.$dest);
8828: $output .= '<span class="LC_error">'.
8829: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8830: '</span><br />';
8831: } else {
1.987 raeburn 8832: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
8833: $url.'</span>').'<br />';
8834: unless ($context eq 'testbank') {
8835: $footer .= &mt('View embedded file: [_1]',
8836: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
8837: }
8838: }
8839: close($fh);
8840: }
8841: }
8842: if ($env{'form.embedded_ref_'.$i}) {
8843: $pathchange{$i} = 1;
8844: }
8845: }
8846: if ($output) {
8847: $output = '<p>'.$output.'</p>';
8848: }
8849: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
8850: $returnflag = 'ok';
8851: if (keys(%pathchange) > 0) {
8852: if ($context eq 'portfolio') {
8853: $output .= '<p>'.&mt('or').'</p>';
8854: } elsif ($context eq 'testbank') {
1.988 raeburn 8855: $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 8856: $returnflag = 'modify_orightml';
8857: }
8858: }
8859: return ($output.$footer,$returnflag);
8860: }
8861:
8862: sub modify_html_form {
8863: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
8864: my $end = 0;
8865: my $modifyform;
8866: if ($context eq 'upload_embedded') {
8867: return unless (ref($pathchange) eq 'HASH');
8868: if ($env{'form.number_embedded_items'}) {
8869: $end += $env{'form.number_embedded_items'};
8870: }
8871: if ($env{'form.number_pathchange_items'}) {
8872: $end += $env{'form.number_pathchange_items'};
8873: }
8874: if ($end) {
8875: for (my $i=0; $i<$end; $i++) {
8876: if ($i < $env{'form.number_embedded_items'}) {
8877: next unless($pathchange->{$i});
8878: }
8879: $modifyform .=
8880: &start_data_table_row().
8881: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
8882: 'checked="checked" /></td>'.
8883: '<td>'.$env{'form.embedded_ref_'.$i}.
8884: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
8885: &escape($env{'form.embedded_ref_'.$i}).'" />'.
8886: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
8887: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
8888: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
8889: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
8890: '<td>'.$env{'form.embedded_orig_'.$i}.
8891: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
8892: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
8893: &end_data_table_row();
8894: }
8895: }
8896: } else {
8897: $modifyform = $pathchgtable;
8898: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
8899: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
8900: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
8901: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
8902: }
8903: }
8904: if ($modifyform) {
8905: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
8906: '<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".
8907: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
8908: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
8909: '</ol></p>'."\n".'<p>'.
8910: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
8911: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
8912: &start_data_table()."\n".
8913: &start_data_table_header_row().
8914: '<th>'.&mt('Change?').'</th>'.
8915: '<th>'.&mt('Current reference').'</th>'.
8916: '<th>'.&mt('Required reference').'</th>'.
8917: &end_data_table_header_row()."\n".
8918: $modifyform.
8919: &end_data_table().'<br />'."\n".$hiddenstate.
8920: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
8921: '</form>'."\n";
8922: }
8923: return;
8924: }
8925:
8926: sub modify_html_refs {
8927: my ($context,$dirpath,$uname,$udom,$dir_root) = @_;
8928: my $container;
8929: if ($context eq 'portfolio') {
8930: $container = $env{'form.container'};
8931: } elsif ($context eq 'coursedoc') {
8932: $container = $env{'form.primaryurl'};
8933: } else {
8934: $container = $env{'form.filename'};
8935: $container =~ s{^/priv/(\Q$uname\E)/(.*)}{/home/$1/public_html/$2};
8936: }
8937: my (%allfiles,%codebase,$output,$content);
8938: my @changes = &get_env_multiple('form.namechange');
8939: return unless (@changes > 0);
8940: if (($context eq 'portfolio') || ($context eq 'coursedoc')) {
8941: return unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/});
8942: $content = &Apache::lonnet::getfile($container);
8943: return if ($content eq '-1');
8944: } else {
8945: return unless ($container =~ /^\Q$dir_root\E/);
8946: if (open(my $fh,"<$container")) {
8947: $content = join('', <$fh>);
8948: close($fh);
8949: } else {
8950: return;
8951: }
8952: }
8953: my ($count,$codebasecount) = (0,0);
8954: my $mm = new File::MMagic;
8955: my $mime_type = $mm->checktype_contents($content);
8956: if ($mime_type eq 'text/html') {
8957: my $parse_result =
8958: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
8959: \%codebase,\$content);
8960: if ($parse_result eq 'ok') {
8961: foreach my $i (@changes) {
8962: my $orig = &unescape($env{'form.embedded_orig_'.$i});
8963: my $ref = &unescape($env{'form.embedded_ref_'.$i});
8964: if ($allfiles{$ref}) {
8965: my $newname = $orig;
8966: my ($attrib_regexp,$codebase);
1.1006 raeburn 8967: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 8968: if ($attrib_regexp =~ /:/) {
8969: $attrib_regexp =~ s/\:/|/g;
8970: }
8971: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
8972: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
8973: $count += $numchg;
8974: }
8975: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 8976: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 8977: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
8978: $codebasecount ++;
8979: }
8980: }
8981: }
8982: if ($count || $codebasecount) {
8983: my $saveresult;
8984: if ($context eq 'portfolio' || $context eq 'coursedoc') {
8985: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
8986: if ($url eq $container) {
8987: my ($fname) = ($container =~ m{/([^/]+)$});
8988: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
8989: $count,'<span class="LC_filename">'.
8990: $fname.'</span>').'</p>';
8991: } else {
8992: $output = '<p class="LC_error">'.
8993: &mt('Error: update failed for: [_1].',
8994: '<span class="LC_filename">'.
8995: $container.'</span>').'</p>';
8996: }
8997: } else {
8998: if (open(my $fh,">$container")) {
8999: print $fh $content;
9000: close($fh);
9001: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
9002: $count,'<span class="LC_filename">'.
9003: $container.'</span>').'</p>';
1.661 raeburn 9004: } else {
1.987 raeburn 9005: $output = '<p class="LC_error">'.
9006: &mt('Error: could not update [_1].',
9007: '<span class="LC_filename">'.
9008: $container.'</span>').'</p>';
1.661 raeburn 9009: }
9010: }
9011: }
1.987 raeburn 9012: } else {
9013: &logthis('Failed to parse '.$container.
9014: ' to modify references: '.$parse_result);
1.661 raeburn 9015: }
9016: }
9017: return $output;
9018: }
9019:
9020: sub check_for_existing {
9021: my ($path,$fname,$element) = @_;
9022: my ($state,$msg);
9023: if (-d $path.'/'.$fname) {
9024: $state = 'exists';
9025: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
9026: } elsif (-e $path.'/'.$fname) {
9027: $state = 'exists';
9028: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
9029: }
9030: if ($state eq 'exists') {
9031: $msg = '<span class="LC_error">'.$msg.'</span><br />';
9032: }
9033: return ($state,$msg);
9034: }
9035:
9036: sub check_for_upload {
9037: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
9038: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 9039: my $filesize = length($env{'form.'.$element});
9040: if (!$filesize) {
9041: my $msg = '<span class="LC_error">'.
9042: &mt('Unable to upload [_1]. (size = [_2] bytes)',
9043: '<span class="LC_filename">'.$fname.'</span>',
9044: $filesize).'<br />'.
1.1007 raeburn 9045: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 9046: '</span>';
9047: return ('zero_bytes',$msg);
9048: }
9049: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 9050: my $getpropath = 1;
9051: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
9052: $getpropath);
9053: my $found_file = 0;
9054: my $locked_file = 0;
1.991 raeburn 9055: my @lockers;
9056: my $navmap;
9057: if ($env{'request.course.id'}) {
9058: $navmap = Apache::lonnavmaps::navmap->new();
9059: }
1.661 raeburn 9060: foreach my $line (@dir_list) {
1.984 raeburn 9061: my ($file_name,$rest)=split(/\&/,$line,2);
1.661 raeburn 9062: if ($file_name eq $fname){
9063: $file_name = $path.$file_name;
9064: if ($group ne '') {
9065: $file_name = $group.$file_name;
9066: }
9067: $found_file = 1;
1.991 raeburn 9068: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
9069: foreach my $lock (@lockers) {
9070: if (ref($lock) eq 'ARRAY') {
9071: my ($symb,$crsid) = @{$lock};
9072: if ($crsid eq $env{'request.course.id'}) {
9073: if (ref($navmap)) {
9074: my $res = $navmap->getBySymb($symb);
9075: foreach my $part (@{$res->parts()}) {
9076: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
9077: unless (($slot_status == $res->RESERVED) ||
9078: ($slot_status == $res->RESERVED_LOCATION)) {
9079: $locked_file = 1;
9080: }
9081: }
9082: } else {
9083: $locked_file = 1;
9084: }
9085: } else {
9086: $locked_file = 1;
9087: }
9088: }
9089: }
1.984 raeburn 9090: } else {
9091: my @info = split(/\&/,$rest);
9092: my $currsize = $info[6]/1000;
9093: if ($currsize < $filesize) {
9094: my $extra = $filesize - $currsize;
9095: if (($current_disk_usage + $extra) > $disk_quota) {
9096: my $msg = '<span class="LC_error">'.
9097: &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.',
9098: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</span>'.
9099: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
9100: $disk_quota,$current_disk_usage);
9101: return ('will_exceed_quota',$msg);
9102: }
9103: }
1.661 raeburn 9104: }
9105: }
9106: }
9107: if (($current_disk_usage + $filesize) > $disk_quota){
9108: my $msg = '<span class="LC_error">'.
9109: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
9110: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
9111: return ('will_exceed_quota',$msg);
9112: } elsif ($found_file) {
9113: if ($locked_file) {
9114: my $msg = '<span class="LC_error">';
9115: $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>');
9116: $msg .= '</span><br />';
9117: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
9118: return ('file_locked',$msg);
9119: } else {
9120: my $msg = '<span class="LC_error">';
1.984 raeburn 9121: $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 9122: $msg .= '</span>';
1.984 raeburn 9123: return ('existingfile',$msg);
1.661 raeburn 9124: }
9125: }
9126: }
9127:
1.987 raeburn 9128: sub check_for_traversal {
9129: my ($path,$url,$toplevel) = @_;
9130: my @parts=split(/\//,$path);
9131: my $cleanpath;
9132: my $fullpath = $url;
9133: for (my $i=0;$i<@parts;$i++) {
9134: next if ($parts[$i] eq '.');
9135: if ($parts[$i] eq '..') {
9136: $fullpath =~ s{([^/]+/)$}{};
9137: } else {
9138: $fullpath .= $parts[$i].'/';
9139: }
9140: }
9141: if ($fullpath =~ /^\Q$url\E(.*)$/) {
9142: $cleanpath = $1;
9143: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
9144: my $curr_toprel = $1;
9145: my @parts = split(/\//,$curr_toprel);
9146: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
9147: my @urlparts = split(/\//,$url_toprel);
9148: my $doubledots;
9149: my $startdiff = -1;
9150: for (my $i=0; $i<@urlparts; $i++) {
9151: if ($startdiff == -1) {
9152: unless ($urlparts[$i] eq $parts[$i]) {
9153: $startdiff = $i;
9154: $doubledots .= '../';
9155: }
9156: } else {
9157: $doubledots .= '../';
9158: }
9159: }
9160: if ($startdiff > -1) {
9161: $cleanpath = $doubledots;
9162: for (my $i=$startdiff; $i<@parts; $i++) {
9163: $cleanpath .= $parts[$i].'/';
9164: }
9165: }
9166: }
9167: $cleanpath =~ s{(/)$}{};
9168: return $cleanpath;
9169: }
1.31 albertel 9170:
1.41 ng 9171: =pod
1.45 matthew 9172:
1.1015 raeburn 9173: =item * &get_turnedin_filepath()
9174:
9175: Determines path in a user's portfolio file for storage of files uploaded
9176: to a specific essayresponse or dropbox item.
9177:
9178: Inputs: 3 required + 1 optional.
9179: $symb is symb for resource, $uname and $udom are for current user (required).
9180: $caller is optional (can be "submission", if routine is called when storing
9181: an upoaded file when "Submit Answer" button was pressed).
9182:
9183: Returns array containing $path and $multiresp.
9184: $path is path in portfolio. $multiresp is 1 if this resource contains more
9185: than one file upload item. Callers of routine should append partid as a
9186: subdirectory to $path in cases where $multiresp is 1.
9187:
9188: Called by: homework/essayresponse.pm and homework/structuretags.pm
9189:
9190: =cut
9191:
9192: sub get_turnedin_filepath {
9193: my ($symb,$uname,$udom,$caller) = @_;
9194: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
9195: my $turnindir;
9196: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
9197: $turnindir = $userhash{'turnindir'};
9198: my ($path,$multiresp);
9199: if ($turnindir eq '') {
9200: if ($caller eq 'submission') {
9201: $turnindir = &mt('turned in');
9202: $turnindir =~ s/\W+/_/g;
9203: my %newhash = (
9204: 'turnindir' => $turnindir,
9205: );
9206: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
9207: }
9208: }
9209: if ($turnindir ne '') {
9210: $path = '/'.$turnindir.'/';
9211: my ($multipart,$turnin,@pathitems);
9212: my $navmap = Apache::lonnavmaps::navmap->new();
9213: if (defined($navmap)) {
9214: my $mapres = $navmap->getResourceByUrl($map);
9215: if (ref($mapres)) {
9216: my $pcslist = $mapres->map_hierarchy();
9217: if ($pcslist ne '') {
9218: foreach my $pc (split(/,/,$pcslist)) {
9219: my $res = $navmap->getByMapPc($pc);
9220: if (ref($res)) {
9221: my $title = $res->compTitle();
9222: $title =~ s/\W+/_/g;
9223: if ($title ne '') {
9224: push(@pathitems,$title);
9225: }
9226: }
9227: }
9228: }
9229: my $maptitle = $mapres->compTitle();
9230: $maptitle =~ s/\W+/_/g;
9231: if ($maptitle ne '') {
9232: push(@pathitems,$maptitle);
9233: }
9234: unless ($env{'request.state'} eq 'construct') {
9235: my $res = $navmap->getBySymb($symb);
9236: if (ref($res)) {
9237: my $partlist = $res->parts();
9238: my $totaluploads = 0;
9239: if (ref($partlist) eq 'ARRAY') {
9240: foreach my $part (@{$partlist}) {
9241: my @types = $res->responseType($part);
9242: my @ids = $res->responseIds($part);
9243: for (my $i=0; $i < scalar(@ids); $i++) {
9244: if ($types[$i] eq 'essay') {
9245: my $partid = $part.'_'.$ids[$i];
9246: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
9247: $totaluploads ++;
9248: }
9249: }
9250: }
9251: }
9252: if ($totaluploads > 1) {
9253: $multiresp = 1;
9254: }
9255: }
9256: }
9257: }
9258: } else {
9259: return;
9260: }
9261: } else {
9262: return;
9263: }
9264: my $restitle=&Apache::lonnet::gettitle($symb);
9265: $restitle =~ s/\W+/_/g;
9266: if ($restitle eq '') {
9267: $restitle = ($resurl =~ m{/[^/]+$});
9268: if ($restitle eq '') {
9269: $restitle = time;
9270: }
9271: }
9272: push(@pathitems,$restitle);
9273: $path .= join('/',@pathitems);
9274: }
9275: return ($path,$multiresp);
9276: }
9277:
9278: =pod
9279:
1.464 albertel 9280: =back
1.41 ng 9281:
1.112 bowersj2 9282: =head1 CSV Upload/Handling functions
1.38 albertel 9283:
1.41 ng 9284: =over 4
9285:
1.648 raeburn 9286: =item * &upfile_store($r)
1.41 ng 9287:
9288: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 9289: needs $env{'form.upfile'}
1.41 ng 9290: returns $datatoken to be put into hidden field
9291:
9292: =cut
1.31 albertel 9293:
9294: sub upfile_store {
9295: my $r=shift;
1.258 albertel 9296: $env{'form.upfile'}=~s/\r/\n/gs;
9297: $env{'form.upfile'}=~s/\f/\n/gs;
9298: $env{'form.upfile'}=~s/\n+/\n/gs;
9299: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 9300:
1.258 albertel 9301: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
9302: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 9303: {
1.158 raeburn 9304: my $datafile = $r->dir_config('lonDaemons').
9305: '/tmp/'.$datatoken.'.tmp';
9306: if ( open(my $fh,">$datafile") ) {
1.258 albertel 9307: print $fh $env{'form.upfile'};
1.158 raeburn 9308: close($fh);
9309: }
1.31 albertel 9310: }
9311: return $datatoken;
9312: }
9313:
1.56 matthew 9314: =pod
9315:
1.648 raeburn 9316: =item * &load_tmp_file($r)
1.41 ng 9317:
9318: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 9319: needs $env{'form.datatoken'},
9320: sets $env{'form.upfile'} to the contents of the file
1.41 ng 9321:
9322: =cut
1.31 albertel 9323:
9324: sub load_tmp_file {
9325: my $r=shift;
9326: my @studentdata=();
9327: {
1.158 raeburn 9328: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 9329: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 9330: if ( open(my $fh,"<$studentfile") ) {
9331: @studentdata=<$fh>;
9332: close($fh);
9333: }
1.31 albertel 9334: }
1.258 albertel 9335: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 9336: }
9337:
1.56 matthew 9338: =pod
9339:
1.648 raeburn 9340: =item * &upfile_record_sep()
1.41 ng 9341:
9342: Separate uploaded file into records
9343: returns array of records,
1.258 albertel 9344: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 9345:
9346: =cut
1.31 albertel 9347:
9348: sub upfile_record_sep {
1.258 albertel 9349: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 9350: } else {
1.248 albertel 9351: my @records;
1.258 albertel 9352: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 9353: if ($line=~/^\s*$/) { next; }
9354: push(@records,$line);
9355: }
9356: return @records;
1.31 albertel 9357: }
9358: }
9359:
1.56 matthew 9360: =pod
9361:
1.648 raeburn 9362: =item * &record_sep($record)
1.41 ng 9363:
1.258 albertel 9364: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 9365:
9366: =cut
9367:
1.263 www 9368: sub takeleft {
9369: my $index=shift;
9370: return substr('0000'.$index,-4,4);
9371: }
9372:
1.31 albertel 9373: sub record_sep {
9374: my $record=shift;
9375: my %components=();
1.258 albertel 9376: if ($env{'form.upfiletype'} eq 'xml') {
9377: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 9378: my $i=0;
1.356 albertel 9379: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 9380: $field=~s/^(\"|\')//;
9381: $field=~s/(\"|\')$//;
1.263 www 9382: $components{&takeleft($i)}=$field;
1.31 albertel 9383: $i++;
9384: }
1.258 albertel 9385: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 9386: my $i=0;
1.356 albertel 9387: foreach my $field (split(/\t/,$record)) {
1.31 albertel 9388: $field=~s/^(\"|\')//;
9389: $field=~s/(\"|\')$//;
1.263 www 9390: $components{&takeleft($i)}=$field;
1.31 albertel 9391: $i++;
9392: }
9393: } else {
1.561 www 9394: my $separator=',';
1.480 banghart 9395: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 9396: $separator=';';
1.480 banghart 9397: }
1.31 albertel 9398: my $i=0;
1.561 www 9399: # the character we are looking for to indicate the end of a quote or a record
9400: my $looking_for=$separator;
9401: # do not add the characters to the fields
9402: my $ignore=0;
9403: # we just encountered a separator (or the beginning of the record)
9404: my $just_found_separator=1;
9405: # store the field we are working on here
9406: my $field='';
9407: # work our way through all characters in record
9408: foreach my $character ($record=~/(.)/g) {
9409: if ($character eq $looking_for) {
9410: if ($character ne $separator) {
9411: # Found the end of a quote, again looking for separator
9412: $looking_for=$separator;
9413: $ignore=1;
9414: } else {
9415: # Found a separator, store away what we got
9416: $components{&takeleft($i)}=$field;
9417: $i++;
9418: $just_found_separator=1;
9419: $ignore=0;
9420: $field='';
9421: }
9422: next;
9423: }
9424: # single or double quotation marks after a separator indicate beginning of a quote
9425: # we are now looking for the end of the quote and need to ignore separators
9426: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
9427: $looking_for=$character;
9428: next;
9429: }
9430: # ignore would be true after we reached the end of a quote
9431: if ($ignore) { next; }
9432: if (($just_found_separator) && ($character=~/\s/)) { next; }
9433: $field.=$character;
9434: $just_found_separator=0;
1.31 albertel 9435: }
1.561 www 9436: # catch the very last entry, since we never encountered the separator
9437: $components{&takeleft($i)}=$field;
1.31 albertel 9438: }
9439: return %components;
9440: }
9441:
1.144 matthew 9442: ######################################################
9443: ######################################################
9444:
1.56 matthew 9445: =pod
9446:
1.648 raeburn 9447: =item * &upfile_select_html()
1.41 ng 9448:
1.144 matthew 9449: Return HTML code to select a file from the users machine and specify
9450: the file type.
1.41 ng 9451:
9452: =cut
9453:
1.144 matthew 9454: ######################################################
9455: ######################################################
1.31 albertel 9456: sub upfile_select_html {
1.144 matthew 9457: my %Types = (
9458: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 9459: semisv => &mt('Semicolon separated values'),
1.144 matthew 9460: space => &mt('Space separated'),
9461: tab => &mt('Tabulator separated'),
9462: # xml => &mt('HTML/XML'),
9463: );
9464: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 9465: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 9466: foreach my $type (sort(keys(%Types))) {
9467: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
9468: }
9469: $Str .= "</select>\n";
9470: return $Str;
1.31 albertel 9471: }
9472:
1.301 albertel 9473: sub get_samples {
9474: my ($records,$toget) = @_;
9475: my @samples=({});
9476: my $got=0;
9477: foreach my $rec (@$records) {
9478: my %temp = &record_sep($rec);
9479: if (! grep(/\S/, values(%temp))) { next; }
9480: if (%temp) {
9481: $samples[$got]=\%temp;
9482: $got++;
9483: if ($got == $toget) { last; }
9484: }
9485: }
9486: return \@samples;
9487: }
9488:
1.144 matthew 9489: ######################################################
9490: ######################################################
9491:
1.56 matthew 9492: =pod
9493:
1.648 raeburn 9494: =item * &csv_print_samples($r,$records)
1.41 ng 9495:
9496: Prints a table of sample values from each column uploaded $r is an
9497: Apache Request ref, $records is an arrayref from
9498: &Apache::loncommon::upfile_record_sep
9499:
9500: =cut
9501:
1.144 matthew 9502: ######################################################
9503: ######################################################
1.31 albertel 9504: sub csv_print_samples {
9505: my ($r,$records) = @_;
1.662 bisitz 9506: my $samples = &get_samples($records,5);
1.301 albertel 9507:
1.594 raeburn 9508: $r->print(&mt('Samples').'<br />'.&start_data_table().
9509: &start_data_table_header_row());
1.356 albertel 9510: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 9511: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 9512: $r->print(&end_data_table_header_row());
1.301 albertel 9513: foreach my $hash (@$samples) {
1.594 raeburn 9514: $r->print(&start_data_table_row());
1.356 albertel 9515: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 9516: $r->print('<td>');
1.356 albertel 9517: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 9518: $r->print('</td>');
9519: }
1.594 raeburn 9520: $r->print(&end_data_table_row());
1.31 albertel 9521: }
1.594 raeburn 9522: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 9523: }
9524:
1.144 matthew 9525: ######################################################
9526: ######################################################
9527:
1.56 matthew 9528: =pod
9529:
1.648 raeburn 9530: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 9531:
9532: Prints a table to create associations between values and table columns.
1.144 matthew 9533:
1.41 ng 9534: $r is an Apache Request ref,
9535: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 9536: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 9537:
9538: =cut
9539:
1.144 matthew 9540: ######################################################
9541: ######################################################
1.31 albertel 9542: sub csv_print_select_table {
9543: my ($r,$records,$d) = @_;
1.301 albertel 9544: my $i=0;
9545: my $samples = &get_samples($records,1);
1.144 matthew 9546: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 9547: &start_data_table().&start_data_table_header_row().
1.144 matthew 9548: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 9549: '<th>'.&mt('Column').'</th>'.
9550: &end_data_table_header_row()."\n");
1.356 albertel 9551: foreach my $array_ref (@$d) {
9552: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 9553: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 9554:
1.875 bisitz 9555: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 9556: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 9557: $r->print('<option value="none"></option>');
1.356 albertel 9558: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
9559: $r->print('<option value="'.$sample.'"'.
9560: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 9561: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 9562: }
1.594 raeburn 9563: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 9564: $i++;
9565: }
1.594 raeburn 9566: $r->print(&end_data_table());
1.31 albertel 9567: $i--;
9568: return $i;
9569: }
1.56 matthew 9570:
1.144 matthew 9571: ######################################################
9572: ######################################################
9573:
1.56 matthew 9574: =pod
1.31 albertel 9575:
1.648 raeburn 9576: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 9577:
9578: Prints a table of sample values from the upload and can make associate samples to internal names.
9579:
9580: $r is an Apache Request ref,
9581: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
9582: $d is an array of 2 element arrays (internal name, displayed name)
9583:
9584: =cut
9585:
1.144 matthew 9586: ######################################################
9587: ######################################################
1.31 albertel 9588: sub csv_samples_select_table {
9589: my ($r,$records,$d) = @_;
9590: my $i=0;
1.144 matthew 9591: #
1.662 bisitz 9592: my $max_samples = 5;
9593: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 9594: $r->print(&start_data_table().
9595: &start_data_table_header_row().'<th>'.
9596: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
9597: &end_data_table_header_row());
1.301 albertel 9598:
9599: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 9600: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 9601: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 9602: foreach my $option (@$d) {
9603: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 9604: $r->print('<option value="'.$value.'"'.
1.253 albertel 9605: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 9606: $display.'</option>');
1.31 albertel 9607: }
9608: $r->print('</select></td><td>');
1.662 bisitz 9609: foreach my $line (0..($max_samples-1)) {
1.301 albertel 9610: if (defined($samples->[$line]{$key})) {
9611: $r->print($samples->[$line]{$key}."<br />\n");
9612: }
9613: }
1.594 raeburn 9614: $r->print('</td>'.&end_data_table_row());
1.31 albertel 9615: $i++;
9616: }
1.594 raeburn 9617: $r->print(&end_data_table());
1.31 albertel 9618: $i--;
9619: return($i);
1.115 matthew 9620: }
9621:
1.144 matthew 9622: ######################################################
9623: ######################################################
9624:
1.115 matthew 9625: =pod
9626:
1.648 raeburn 9627: =item * &clean_excel_name($name)
1.115 matthew 9628:
9629: Returns a replacement for $name which does not contain any illegal characters.
9630:
9631: =cut
9632:
1.144 matthew 9633: ######################################################
9634: ######################################################
1.115 matthew 9635: sub clean_excel_name {
9636: my ($name) = @_;
9637: $name =~ s/[:\*\?\/\\]//g;
9638: if (length($name) > 31) {
9639: $name = substr($name,0,31);
9640: }
9641: return $name;
1.25 albertel 9642: }
1.84 albertel 9643:
1.85 albertel 9644: =pod
9645:
1.648 raeburn 9646: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 9647:
9648: Returns either 1 or undef
9649:
9650: 1 if the part is to be hidden, undef if it is to be shown
9651:
9652: Arguments are:
9653:
9654: $id the id of the part to be checked
9655: $symb, optional the symb of the resource to check
9656: $udom, optional the domain of the user to check for
9657: $uname, optional the username of the user to check for
9658:
9659: =cut
1.84 albertel 9660:
9661: sub check_if_partid_hidden {
9662: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 9663: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 9664: $symb,$udom,$uname);
1.141 albertel 9665: my $truth=1;
9666: #if the string starts with !, then the list is the list to show not hide
9667: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 9668: my @hiddenlist=split(/,/,$hiddenparts);
9669: foreach my $checkid (@hiddenlist) {
1.141 albertel 9670: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 9671: }
1.141 albertel 9672: return !$truth;
1.84 albertel 9673: }
1.127 matthew 9674:
1.138 matthew 9675:
9676: ############################################################
9677: ############################################################
9678:
9679: =pod
9680:
1.157 matthew 9681: =back
9682:
1.138 matthew 9683: =head1 cgi-bin script and graphing routines
9684:
1.157 matthew 9685: =over 4
9686:
1.648 raeburn 9687: =item * &get_cgi_id()
1.138 matthew 9688:
9689: Inputs: none
9690:
9691: Returns an id which can be used to pass environment variables
9692: to various cgi-bin scripts. These environment variables will
9693: be removed from the users environment after a given time by
9694: the routine &Apache::lonnet::transfer_profile_to_env.
9695:
9696: =cut
9697:
9698: ############################################################
9699: ############################################################
1.152 albertel 9700: my $uniq=0;
1.136 matthew 9701: sub get_cgi_id {
1.154 albertel 9702: $uniq=($uniq+1)%100000;
1.280 albertel 9703: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 9704: }
9705:
1.127 matthew 9706: ############################################################
9707: ############################################################
9708:
9709: =pod
9710:
1.648 raeburn 9711: =item * &DrawBarGraph()
1.127 matthew 9712:
1.138 matthew 9713: Facilitates the plotting of data in a (stacked) bar graph.
9714: Puts plot definition data into the users environment in order for
9715: graph.png to plot it. Returns an <img> tag for the plot.
9716: The bars on the plot are labeled '1','2',...,'n'.
9717:
9718: Inputs:
9719:
9720: =over 4
9721:
9722: =item $Title: string, the title of the plot
9723:
9724: =item $xlabel: string, text describing the X-axis of the plot
9725:
9726: =item $ylabel: string, text describing the Y-axis of the plot
9727:
9728: =item $Max: scalar, the maximum Y value to use in the plot
9729: If $Max is < any data point, the graph will not be rendered.
9730:
1.140 matthew 9731: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 9732: they are plotted. If undefined, default values will be used.
9733:
1.178 matthew 9734: =item $labels: array ref holding the labels to use on the x-axis for the bars.
9735:
1.138 matthew 9736: =item @Values: An array of array references. Each array reference holds data
9737: to be plotted in a stacked bar chart.
9738:
1.239 matthew 9739: =item If the final element of @Values is a hash reference the key/value
9740: pairs will be added to the graph definition.
9741:
1.138 matthew 9742: =back
9743:
9744: Returns:
9745:
9746: An <img> tag which references graph.png and the appropriate identifying
9747: information for the plot.
9748:
1.127 matthew 9749: =cut
9750:
9751: ############################################################
9752: ############################################################
1.134 matthew 9753: sub DrawBarGraph {
1.178 matthew 9754: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 9755: #
9756: if (! defined($colors)) {
9757: $colors = ['#33ff00',
9758: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
9759: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
9760: ];
9761: }
1.228 matthew 9762: my $extra_settings = {};
9763: if (ref($Values[-1]) eq 'HASH') {
9764: $extra_settings = pop(@Values);
9765: }
1.127 matthew 9766: #
1.136 matthew 9767: my $identifier = &get_cgi_id();
9768: my $id = 'cgi.'.$identifier;
1.129 matthew 9769: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 9770: return '';
9771: }
1.225 matthew 9772: #
9773: my @Labels;
9774: if (defined($labels)) {
9775: @Labels = @$labels;
9776: } else {
9777: for (my $i=0;$i<@{$Values[0]};$i++) {
9778: push (@Labels,$i+1);
9779: }
9780: }
9781: #
1.129 matthew 9782: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 9783: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 9784: my %ValuesHash;
9785: my $NumSets=1;
9786: foreach my $array (@Values) {
9787: next if (! ref($array));
1.136 matthew 9788: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 9789: join(',',@$array);
1.129 matthew 9790: }
1.127 matthew 9791: #
1.136 matthew 9792: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 9793: if ($NumBars < 3) {
9794: $width = 120+$NumBars*32;
1.220 matthew 9795: $xskip = 1;
1.225 matthew 9796: $bar_width = 30;
9797: } elsif ($NumBars < 5) {
9798: $width = 120+$NumBars*20;
9799: $xskip = 1;
9800: $bar_width = 20;
1.220 matthew 9801: } elsif ($NumBars < 10) {
1.136 matthew 9802: $width = 120+$NumBars*15;
9803: $xskip = 1;
9804: $bar_width = 15;
9805: } elsif ($NumBars <= 25) {
9806: $width = 120+$NumBars*11;
9807: $xskip = 5;
9808: $bar_width = 8;
9809: } elsif ($NumBars <= 50) {
9810: $width = 120+$NumBars*8;
9811: $xskip = 5;
9812: $bar_width = 4;
9813: } else {
9814: $width = 120+$NumBars*8;
9815: $xskip = 5;
9816: $bar_width = 4;
9817: }
9818: #
1.137 matthew 9819: $Max = 1 if ($Max < 1);
9820: if ( int($Max) < $Max ) {
9821: $Max++;
9822: $Max = int($Max);
9823: }
1.127 matthew 9824: $Title = '' if (! defined($Title));
9825: $xlabel = '' if (! defined($xlabel));
9826: $ylabel = '' if (! defined($ylabel));
1.369 www 9827: $ValuesHash{$id.'.title'} = &escape($Title);
9828: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
9829: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 9830: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 9831: $ValuesHash{$id.'.NumBars'} = $NumBars;
9832: $ValuesHash{$id.'.NumSets'} = $NumSets;
9833: $ValuesHash{$id.'.PlotType'} = 'bar';
9834: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9835: $ValuesHash{$id.'.height'} = $height;
9836: $ValuesHash{$id.'.width'} = $width;
9837: $ValuesHash{$id.'.xskip'} = $xskip;
9838: $ValuesHash{$id.'.bar_width'} = $bar_width;
9839: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 9840: #
1.228 matthew 9841: # Deal with other parameters
9842: while (my ($key,$value) = each(%$extra_settings)) {
9843: $ValuesHash{$id.'.'.$key} = $value;
9844: }
9845: #
1.646 raeburn 9846: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 9847: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9848: }
9849:
9850: ############################################################
9851: ############################################################
9852:
9853: =pod
9854:
1.648 raeburn 9855: =item * &DrawXYGraph()
1.137 matthew 9856:
1.138 matthew 9857: Facilitates the plotting of data in an XY graph.
9858: Puts plot definition data into the users environment in order for
9859: graph.png to plot it. Returns an <img> tag for the plot.
9860:
9861: Inputs:
9862:
9863: =over 4
9864:
9865: =item $Title: string, the title of the plot
9866:
9867: =item $xlabel: string, text describing the X-axis of the plot
9868:
9869: =item $ylabel: string, text describing the Y-axis of the plot
9870:
9871: =item $Max: scalar, the maximum Y value to use in the plot
9872: If $Max is < any data point, the graph will not be rendered.
9873:
9874: =item $colors: Array ref containing the hex color codes for the data to be
9875: plotted in. If undefined, default values will be used.
9876:
9877: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9878:
9879: =item $Ydata: Array ref containing Array refs.
1.185 www 9880: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 9881:
9882: =item %Values: hash indicating or overriding any default values which are
9883: passed to graph.png.
9884: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9885:
9886: =back
9887:
9888: Returns:
9889:
9890: An <img> tag which references graph.png and the appropriate identifying
9891: information for the plot.
9892:
1.137 matthew 9893: =cut
9894:
9895: ############################################################
9896: ############################################################
9897: sub DrawXYGraph {
9898: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
9899: #
9900: # Create the identifier for the graph
9901: my $identifier = &get_cgi_id();
9902: my $id = 'cgi.'.$identifier;
9903: #
9904: $Title = '' if (! defined($Title));
9905: $xlabel = '' if (! defined($xlabel));
9906: $ylabel = '' if (! defined($ylabel));
9907: my %ValuesHash =
9908: (
1.369 www 9909: $id.'.title' => &escape($Title),
9910: $id.'.xlabel' => &escape($xlabel),
9911: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 9912: $id.'.y_max_value'=> $Max,
9913: $id.'.labels' => join(',',@$Xlabels),
9914: $id.'.PlotType' => 'XY',
9915: );
9916: #
9917: if (defined($colors) && ref($colors) eq 'ARRAY') {
9918: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9919: }
9920: #
9921: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
9922: return '';
9923: }
9924: my $NumSets=1;
1.138 matthew 9925: foreach my $array (@{$Ydata}){
1.137 matthew 9926: next if (! ref($array));
9927: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
9928: }
1.138 matthew 9929: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 9930: #
9931: # Deal with other parameters
9932: while (my ($key,$value) = each(%Values)) {
9933: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 9934: }
9935: #
1.646 raeburn 9936: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 9937: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9938: }
9939:
9940: ############################################################
9941: ############################################################
9942:
9943: =pod
9944:
1.648 raeburn 9945: =item * &DrawXYYGraph()
1.138 matthew 9946:
9947: Facilitates the plotting of data in an XY graph with two Y axes.
9948: Puts plot definition data into the users environment in order for
9949: graph.png to plot it. Returns an <img> tag for the plot.
9950:
9951: Inputs:
9952:
9953: =over 4
9954:
9955: =item $Title: string, the title of the plot
9956:
9957: =item $xlabel: string, text describing the X-axis of the plot
9958:
9959: =item $ylabel: string, text describing the Y-axis of the plot
9960:
9961: =item $colors: Array ref containing the hex color codes for the data to be
9962: plotted in. If undefined, default values will be used.
9963:
9964: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9965:
9966: =item $Ydata1: The first data set
9967:
9968: =item $Min1: The minimum value of the left Y-axis
9969:
9970: =item $Max1: The maximum value of the left Y-axis
9971:
9972: =item $Ydata2: The second data set
9973:
9974: =item $Min2: The minimum value of the right Y-axis
9975:
9976: =item $Max2: The maximum value of the left Y-axis
9977:
9978: =item %Values: hash indicating or overriding any default values which are
9979: passed to graph.png.
9980: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9981:
9982: =back
9983:
9984: Returns:
9985:
9986: An <img> tag which references graph.png and the appropriate identifying
9987: information for the plot.
1.136 matthew 9988:
9989: =cut
9990:
9991: ############################################################
9992: ############################################################
1.137 matthew 9993: sub DrawXYYGraph {
9994: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
9995: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 9996: #
9997: # Create the identifier for the graph
9998: my $identifier = &get_cgi_id();
9999: my $id = 'cgi.'.$identifier;
10000: #
10001: $Title = '' if (! defined($Title));
10002: $xlabel = '' if (! defined($xlabel));
10003: $ylabel = '' if (! defined($ylabel));
10004: my %ValuesHash =
10005: (
1.369 www 10006: $id.'.title' => &escape($Title),
10007: $id.'.xlabel' => &escape($xlabel),
10008: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 10009: $id.'.labels' => join(',',@$Xlabels),
10010: $id.'.PlotType' => 'XY',
10011: $id.'.NumSets' => 2,
1.137 matthew 10012: $id.'.two_axes' => 1,
10013: $id.'.y1_max_value' => $Max1,
10014: $id.'.y1_min_value' => $Min1,
10015: $id.'.y2_max_value' => $Max2,
10016: $id.'.y2_min_value' => $Min2,
1.136 matthew 10017: );
10018: #
1.137 matthew 10019: if (defined($colors) && ref($colors) eq 'ARRAY') {
10020: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
10021: }
10022: #
10023: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
10024: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 10025: return '';
10026: }
10027: my $NumSets=1;
1.137 matthew 10028: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 10029: next if (! ref($array));
10030: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 10031: }
10032: #
10033: # Deal with other parameters
10034: while (my ($key,$value) = each(%Values)) {
10035: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 10036: }
10037: #
1.646 raeburn 10038: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 10039: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 10040: }
10041:
10042: ############################################################
10043: ############################################################
10044:
10045: =pod
10046:
1.157 matthew 10047: =back
10048:
1.139 matthew 10049: =head1 Statistics helper routines?
10050:
10051: Bad place for them but what the hell.
10052:
1.157 matthew 10053: =over 4
10054:
1.648 raeburn 10055: =item * &chartlink()
1.139 matthew 10056:
10057: Returns a link to the chart for a specific student.
10058:
10059: Inputs:
10060:
10061: =over 4
10062:
10063: =item $linktext: The text of the link
10064:
10065: =item $sname: The students username
10066:
10067: =item $sdomain: The students domain
10068:
10069: =back
10070:
1.157 matthew 10071: =back
10072:
1.139 matthew 10073: =cut
10074:
10075: ############################################################
10076: ############################################################
10077: sub chartlink {
10078: my ($linktext, $sname, $sdomain) = @_;
10079: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 10080: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 10081: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 10082: '">'.$linktext.'</a>';
1.153 matthew 10083: }
10084:
10085: #######################################################
10086: #######################################################
10087:
10088: =pod
10089:
10090: =head1 Course Environment Routines
1.157 matthew 10091:
10092: =over 4
1.153 matthew 10093:
1.648 raeburn 10094: =item * &restore_course_settings()
1.153 matthew 10095:
1.648 raeburn 10096: =item * &store_course_settings()
1.153 matthew 10097:
10098: Restores/Store indicated form parameters from the course environment.
10099: Will not overwrite existing values of the form parameters.
10100:
10101: Inputs:
10102: a scalar describing the data (e.g. 'chart', 'problem_analysis')
10103:
10104: a hash ref describing the data to be stored. For example:
10105:
10106: %Save_Parameters = ('Status' => 'scalar',
10107: 'chartoutputmode' => 'scalar',
10108: 'chartoutputdata' => 'scalar',
10109: 'Section' => 'array',
1.373 raeburn 10110: 'Group' => 'array',
1.153 matthew 10111: 'StudentData' => 'array',
10112: 'Maps' => 'array');
10113:
10114: Returns: both routines return nothing
10115:
1.631 raeburn 10116: =back
10117:
1.153 matthew 10118: =cut
10119:
10120: #######################################################
10121: #######################################################
10122: sub store_course_settings {
1.496 albertel 10123: return &store_settings($env{'request.course.id'},@_);
10124: }
10125:
10126: sub store_settings {
1.153 matthew 10127: # save to the environment
10128: # appenv the same items, just to be safe
1.300 albertel 10129: my $udom = $env{'user.domain'};
10130: my $uname = $env{'user.name'};
1.496 albertel 10131: my ($context,$prefix,$Settings) = @_;
1.153 matthew 10132: my %SaveHash;
10133: my %AppHash;
10134: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 10135: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 10136: my $envname = 'environment.'.$basename;
1.258 albertel 10137: if (exists($env{'form.'.$setting})) {
1.153 matthew 10138: # Save this value away
10139: if ($type eq 'scalar' &&
1.258 albertel 10140: (! exists($env{$envname}) ||
10141: $env{$envname} ne $env{'form.'.$setting})) {
10142: $SaveHash{$basename} = $env{'form.'.$setting};
10143: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 10144: } elsif ($type eq 'array') {
10145: my $stored_form;
1.258 albertel 10146: if (ref($env{'form.'.$setting})) {
1.153 matthew 10147: $stored_form = join(',',
10148: map {
1.369 www 10149: &escape($_);
1.258 albertel 10150: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 10151: } else {
10152: $stored_form =
1.369 www 10153: &escape($env{'form.'.$setting});
1.153 matthew 10154: }
10155: # Determine if the array contents are the same.
1.258 albertel 10156: if ($stored_form ne $env{$envname}) {
1.153 matthew 10157: $SaveHash{$basename} = $stored_form;
10158: $AppHash{$envname} = $stored_form;
10159: }
10160: }
10161: }
10162: }
10163: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 10164: $udom,$uname);
1.153 matthew 10165: if ($put_result !~ /^(ok|delayed)/) {
10166: &Apache::lonnet::logthis('unable to save form parameters, '.
10167: 'got error:'.$put_result);
10168: }
10169: # Make sure these settings stick around in this session, too
1.646 raeburn 10170: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 10171: return;
10172: }
10173:
10174: sub restore_course_settings {
1.499 albertel 10175: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 10176: }
10177:
10178: sub restore_settings {
10179: my ($context,$prefix,$Settings) = @_;
1.153 matthew 10180: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 10181: next if (exists($env{'form.'.$setting}));
1.496 albertel 10182: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 10183: '.'.$setting;
1.258 albertel 10184: if (exists($env{$envname})) {
1.153 matthew 10185: if ($type eq 'scalar') {
1.258 albertel 10186: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 10187: } elsif ($type eq 'array') {
1.258 albertel 10188: $env{'form.'.$setting} = [
1.153 matthew 10189: map {
1.369 www 10190: &unescape($_);
1.258 albertel 10191: } split(',',$env{$envname})
1.153 matthew 10192: ];
10193: }
10194: }
10195: }
1.127 matthew 10196: }
10197:
1.618 raeburn 10198: #######################################################
10199: #######################################################
10200:
10201: =pod
10202:
10203: =head1 Domain E-mail Routines
10204:
10205: =over 4
10206:
1.648 raeburn 10207: =item * &build_recipient_list()
1.618 raeburn 10208:
1.884 raeburn 10209: Build recipient lists for five types of e-mail:
1.766 raeburn 10210: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884 raeburn 10211: (d) Help requests, (e) Course requests needing approval, generated by
10212: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
10213: loncoursequeueadmin.pm respectively.
1.618 raeburn 10214:
10215: Inputs:
1.619 raeburn 10216: defmail (scalar - email address of default recipient),
1.618 raeburn 10217: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 10218: defdom (domain for which to retrieve configuration settings),
10219: origmail (scalar - email address of recipient from loncapa.conf,
10220: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 10221:
1.655 raeburn 10222: Returns: comma separated list of addresses to which to send e-mail.
10223:
10224: =back
1.618 raeburn 10225:
10226: =cut
10227:
10228: ############################################################
10229: ############################################################
10230: sub build_recipient_list {
1.619 raeburn 10231: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 10232: my @recipients;
10233: my $otheremails;
10234: my %domconfig =
10235: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
10236: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 10237: if (exists($domconfig{'contacts'}{$mailing})) {
10238: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
10239: my @contacts = ('adminemail','supportemail');
10240: foreach my $item (@contacts) {
10241: if ($domconfig{'contacts'}{$mailing}{$item}) {
10242: my $addr = $domconfig{'contacts'}{$item};
10243: if (!grep(/^\Q$addr\E$/,@recipients)) {
10244: push(@recipients,$addr);
10245: }
1.619 raeburn 10246: }
1.766 raeburn 10247: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 10248: }
10249: }
1.766 raeburn 10250: } elsif ($origmail ne '') {
10251: push(@recipients,$origmail);
1.618 raeburn 10252: }
1.619 raeburn 10253: } elsif ($origmail ne '') {
10254: push(@recipients,$origmail);
1.618 raeburn 10255: }
1.688 raeburn 10256: if (defined($defmail)) {
10257: if ($defmail ne '') {
10258: push(@recipients,$defmail);
10259: }
1.618 raeburn 10260: }
10261: if ($otheremails) {
1.619 raeburn 10262: my @others;
10263: if ($otheremails =~ /,/) {
10264: @others = split(/,/,$otheremails);
1.618 raeburn 10265: } else {
1.619 raeburn 10266: push(@others,$otheremails);
10267: }
10268: foreach my $addr (@others) {
10269: if (!grep(/^\Q$addr\E$/,@recipients)) {
10270: push(@recipients,$addr);
10271: }
1.618 raeburn 10272: }
10273: }
1.619 raeburn 10274: my $recipientlist = join(',',@recipients);
1.618 raeburn 10275: return $recipientlist;
10276: }
10277:
1.127 matthew 10278: ############################################################
10279: ############################################################
1.154 albertel 10280:
1.655 raeburn 10281: =pod
10282:
10283: =head1 Course Catalog Routines
10284:
10285: =over 4
10286:
10287: =item * &gather_categories()
10288:
10289: Converts category definitions - keys of categories hash stored in
10290: coursecategories in configuration.db on the primary library server in a
10291: domain - to an array. Also generates javascript and idx hash used to
10292: generate Domain Coordinator interface for editing Course Categories.
10293:
10294: Inputs:
1.663 raeburn 10295:
1.655 raeburn 10296: categories (reference to hash of category definitions).
1.663 raeburn 10297:
1.655 raeburn 10298: cats (reference to array of arrays/hashes which encapsulates hierarchy of
10299: categories and subcategories).
1.663 raeburn 10300:
1.655 raeburn 10301: idx (reference to hash of counters used in Domain Coordinator interface for
10302: editing Course Categories).
1.663 raeburn 10303:
1.655 raeburn 10304: jsarray (reference to array of categories used to create Javascript arrays for
10305: Domain Coordinator interface for editing Course Categories).
10306:
10307: Returns: nothing
10308:
10309: Side effects: populates cats, idx and jsarray.
10310:
10311: =cut
10312:
10313: sub gather_categories {
10314: my ($categories,$cats,$idx,$jsarray) = @_;
10315: my %counters;
10316: my $num = 0;
10317: foreach my $item (keys(%{$categories})) {
10318: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
10319: if ($container eq '' && $depth == 0) {
10320: $cats->[$depth][$categories->{$item}] = $cat;
10321: } else {
10322: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
10323: }
10324: my ($escitem,$tail) = split(/:/,$item,2);
10325: if ($counters{$tail} eq '') {
10326: $counters{$tail} = $num;
10327: $num ++;
10328: }
10329: if (ref($idx) eq 'HASH') {
10330: $idx->{$item} = $counters{$tail};
10331: }
10332: if (ref($jsarray) eq 'ARRAY') {
10333: push(@{$jsarray->[$counters{$tail}]},$item);
10334: }
10335: }
10336: return;
10337: }
10338:
10339: =pod
10340:
10341: =item * &extract_categories()
10342:
10343: Used to generate breadcrumb trails for course categories.
10344:
10345: Inputs:
1.663 raeburn 10346:
1.655 raeburn 10347: categories (reference to hash of category definitions).
1.663 raeburn 10348:
1.655 raeburn 10349: cats (reference to array of arrays/hashes which encapsulates hierarchy of
10350: categories and subcategories).
1.663 raeburn 10351:
1.655 raeburn 10352: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 10353:
1.655 raeburn 10354: allitems (reference to hash - key is category key
10355: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 10356:
1.655 raeburn 10357: idx (reference to hash of counters used in Domain Coordinator interface for
10358: editing Course Categories).
1.663 raeburn 10359:
1.655 raeburn 10360: jsarray (reference to array of categories used to create Javascript arrays for
10361: Domain Coordinator interface for editing Course Categories).
10362:
1.665 raeburn 10363: subcats (reference to hash of arrays containing all subcategories within each
10364: category, -recursive)
10365:
1.655 raeburn 10366: Returns: nothing
10367:
10368: Side effects: populates trails and allitems hash references.
10369:
10370: =cut
10371:
10372: sub extract_categories {
1.665 raeburn 10373: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 10374: if (ref($categories) eq 'HASH') {
10375: &gather_categories($categories,$cats,$idx,$jsarray);
10376: if (ref($cats->[0]) eq 'ARRAY') {
10377: for (my $i=0; $i<@{$cats->[0]}; $i++) {
10378: my $name = $cats->[0][$i];
10379: my $item = &escape($name).'::0';
10380: my $trailstr;
10381: if ($name eq 'instcode') {
10382: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 10383: } elsif ($name eq 'communities') {
10384: $trailstr = &mt('Communities');
1.655 raeburn 10385: } else {
10386: $trailstr = $name;
10387: }
10388: if ($allitems->{$item} eq '') {
10389: push(@{$trails},$trailstr);
10390: $allitems->{$item} = scalar(@{$trails})-1;
10391: }
10392: my @parents = ($name);
10393: if (ref($cats->[1]{$name}) eq 'ARRAY') {
10394: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
10395: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 10396: if (ref($subcats) eq 'HASH') {
10397: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
10398: }
10399: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
10400: }
10401: } else {
10402: if (ref($subcats) eq 'HASH') {
10403: $subcats->{$item} = [];
1.655 raeburn 10404: }
10405: }
10406: }
10407: }
10408: }
10409: return;
10410: }
10411:
10412: =pod
10413:
10414: =item *&recurse_categories()
10415:
10416: Recursively used to generate breadcrumb trails for course categories.
10417:
10418: Inputs:
1.663 raeburn 10419:
1.655 raeburn 10420: cats (reference to array of arrays/hashes which encapsulates hierarchy of
10421: categories and subcategories).
1.663 raeburn 10422:
1.655 raeburn 10423: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 10424:
10425: category (current course category, for which breadcrumb trail is being generated).
10426:
10427: trails (reference to array of breadcrumb trails for each category).
10428:
1.655 raeburn 10429: allitems (reference to hash - key is category key
10430: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 10431:
1.655 raeburn 10432: parents (array containing containers directories for current category,
10433: back to top level).
10434:
10435: Returns: nothing
10436:
10437: Side effects: populates trails and allitems hash references
10438:
10439: =cut
10440:
10441: sub recurse_categories {
1.665 raeburn 10442: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 10443: my $shallower = $depth - 1;
10444: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
10445: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
10446: my $name = $cats->[$depth]{$category}[$k];
10447: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
10448: my $trailstr = join(' -> ',(@{$parents},$category));
10449: if ($allitems->{$item} eq '') {
10450: push(@{$trails},$trailstr);
10451: $allitems->{$item} = scalar(@{$trails})-1;
10452: }
10453: my $deeper = $depth+1;
10454: push(@{$parents},$category);
1.665 raeburn 10455: if (ref($subcats) eq 'HASH') {
10456: my $subcat = &escape($name).':'.$category.':'.$depth;
10457: for (my $j=@{$parents}; $j>=0; $j--) {
10458: my $higher;
10459: if ($j > 0) {
10460: $higher = &escape($parents->[$j]).':'.
10461: &escape($parents->[$j-1]).':'.$j;
10462: } else {
10463: $higher = &escape($parents->[$j]).'::'.$j;
10464: }
10465: push(@{$subcats->{$higher}},$subcat);
10466: }
10467: }
10468: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
10469: $subcats);
1.655 raeburn 10470: pop(@{$parents});
10471: }
10472: } else {
10473: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
10474: my $trailstr = join(' -> ',(@{$parents},$category));
10475: if ($allitems->{$item} eq '') {
10476: push(@{$trails},$trailstr);
10477: $allitems->{$item} = scalar(@{$trails})-1;
10478: }
10479: }
10480: return;
10481: }
10482:
1.663 raeburn 10483: =pod
10484:
10485: =item *&assign_categories_table()
10486:
10487: Create a datatable for display of hierarchical categories in a domain,
10488: with checkboxes to allow a course to be categorized.
10489:
10490: Inputs:
10491:
10492: cathash - reference to hash of categories defined for the domain (from
10493: configuration.db)
10494:
10495: currcat - scalar with an & separated list of categories assigned to a course.
10496:
1.919 raeburn 10497: type - scalar contains course type (Course or Community).
10498:
1.663 raeburn 10499: Returns: $output (markup to be displayed)
10500:
10501: =cut
10502:
10503: sub assign_categories_table {
1.919 raeburn 10504: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 10505: my $output;
10506: if (ref($cathash) eq 'HASH') {
10507: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
10508: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
10509: $maxdepth = scalar(@cats);
10510: if (@cats > 0) {
10511: my $itemcount = 0;
10512: if (ref($cats[0]) eq 'ARRAY') {
10513: my @currcategories;
10514: if ($currcat ne '') {
10515: @currcategories = split('&',$currcat);
10516: }
1.919 raeburn 10517: my $table;
1.663 raeburn 10518: for (my $i=0; $i<@{$cats[0]}; $i++) {
10519: my $parent = $cats[0][$i];
1.919 raeburn 10520: next if ($parent eq 'instcode');
10521: if ($type eq 'Community') {
10522: next unless ($parent eq 'communities');
10523: } else {
10524: next if ($parent eq 'communities');
10525: }
1.663 raeburn 10526: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
10527: my $item = &escape($parent).'::0';
10528: my $checked = '';
10529: if (@currcategories > 0) {
10530: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 10531: $checked = ' checked="checked"';
1.663 raeburn 10532: }
10533: }
1.919 raeburn 10534: my $parent_title = $parent;
10535: if ($parent eq 'communities') {
10536: $parent_title = &mt('Communities');
10537: }
10538: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
10539: '<input type="checkbox" name="usecategory" value="'.
10540: $item.'"'.$checked.' />'.$parent_title.'</span>'.
10541: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 10542: my $depth = 1;
10543: push(@path,$parent);
1.919 raeburn 10544: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 10545: pop(@path);
1.919 raeburn 10546: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 10547: $itemcount ++;
10548: }
1.919 raeburn 10549: if ($itemcount) {
10550: $output = &Apache::loncommon::start_data_table().
10551: $table.
10552: &Apache::loncommon::end_data_table();
10553: }
1.663 raeburn 10554: }
10555: }
10556: }
10557: return $output;
10558: }
10559:
10560: =pod
10561:
10562: =item *&assign_category_rows()
10563:
10564: Create a datatable row for display of nested categories in a domain,
10565: with checkboxes to allow a course to be categorized,called recursively.
10566:
10567: Inputs:
10568:
10569: itemcount - track row number for alternating colors
10570:
10571: cats - reference to array of arrays/hashes which encapsulates hierarchy of
10572: categories and subcategories.
10573:
10574: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
10575:
10576: parent - parent of current category item
10577:
10578: path - Array containing all categories back up through the hierarchy from the
10579: current category to the top level.
10580:
10581: currcategories - reference to array of current categories assigned to the course
10582:
10583: Returns: $output (markup to be displayed).
10584:
10585: =cut
10586:
10587: sub assign_category_rows {
10588: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
10589: my ($text,$name,$item,$chgstr);
10590: if (ref($cats) eq 'ARRAY') {
10591: my $maxdepth = scalar(@{$cats});
10592: if (ref($cats->[$depth]) eq 'HASH') {
10593: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
10594: my $numchildren = @{$cats->[$depth]{$parent}};
10595: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
10596: $text .= '<td><table class="LC_datatable">';
10597: for (my $j=0; $j<$numchildren; $j++) {
10598: $name = $cats->[$depth]{$parent}[$j];
10599: $item = &escape($name).':'.&escape($parent).':'.$depth;
10600: my $deeper = $depth+1;
10601: my $checked = '';
10602: if (ref($currcategories) eq 'ARRAY') {
10603: if (@{$currcategories} > 0) {
10604: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 10605: $checked = ' checked="checked"';
1.663 raeburn 10606: }
10607: }
10608: }
1.664 raeburn 10609: $text .= '<tr><td><span class="LC_nobreak"><label>'.
10610: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 10611: $item.'"'.$checked.' />'.$name.'</label></span>'.
10612: '<input type="hidden" name="catname" value="'.$name.'" />'.
10613: '</td><td>';
1.663 raeburn 10614: if (ref($path) eq 'ARRAY') {
10615: push(@{$path},$name);
10616: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
10617: pop(@{$path});
10618: }
10619: $text .= '</td></tr>';
10620: }
10621: $text .= '</table></td>';
10622: }
10623: }
10624: }
10625: return $text;
10626: }
10627:
1.655 raeburn 10628: ############################################################
10629: ############################################################
10630:
10631:
1.443 albertel 10632: sub commit_customrole {
1.664 raeburn 10633: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 10634: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 10635: ($start?', '.&mt('starting').' '.localtime($start):'').
10636: ($end?', ending '.localtime($end):'').': <b>'.
10637: &Apache::lonnet::assigncustomrole(
1.664 raeburn 10638: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 10639: '</b><br />';
10640: return $output;
10641: }
10642:
10643: sub commit_standardrole {
1.541 raeburn 10644: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
10645: my ($output,$logmsg,$linefeed);
10646: if ($context eq 'auto') {
10647: $linefeed = "\n";
10648: } else {
10649: $linefeed = "<br />\n";
10650: }
1.443 albertel 10651: if ($three eq 'st') {
1.541 raeburn 10652: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
10653: $one,$two,$sec,$context);
10654: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 10655: ($result eq 'unknown_course') || ($result eq 'refused')) {
10656: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 10657: } else {
1.541 raeburn 10658: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 10659: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 10660: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
10661: if ($context eq 'auto') {
10662: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
10663: } else {
10664: $output .= '<b>'.$result.'</b>'.$linefeed.
10665: &mt('Add to classlist').': <b>ok</b>';
10666: }
10667: $output .= $linefeed;
1.443 albertel 10668: }
10669: } else {
10670: $output = &mt('Assigning').' '.$three.' in '.$url.
10671: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 10672: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 10673: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 10674: if ($context eq 'auto') {
10675: $output .= $result.$linefeed;
10676: } else {
10677: $output .= '<b>'.$result.'</b>'.$linefeed;
10678: }
1.443 albertel 10679: }
10680: return $output;
10681: }
10682:
10683: sub commit_studentrole {
1.541 raeburn 10684: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 10685: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 10686: if ($context eq 'auto') {
10687: $linefeed = "\n";
10688: } else {
10689: $linefeed = '<br />'."\n";
10690: }
1.443 albertel 10691: if (defined($one) && defined($two)) {
10692: my $cid=$one.'_'.$two;
10693: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
10694: my $secchange = 0;
10695: my $expire_role_result;
10696: my $modify_section_result;
1.628 raeburn 10697: if ($oldsec ne '-1') {
10698: if ($oldsec ne $sec) {
1.443 albertel 10699: $secchange = 1;
1.628 raeburn 10700: my $now = time;
1.443 albertel 10701: my $uurl='/'.$cid;
10702: $uurl=~s/\_/\//g;
10703: if ($oldsec) {
10704: $uurl.='/'.$oldsec;
10705: }
1.626 raeburn 10706: $oldsecurl = $uurl;
1.628 raeburn 10707: $expire_role_result =
1.652 raeburn 10708: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 10709: if ($env{'request.course.sec'} ne '') {
10710: if ($expire_role_result eq 'refused') {
10711: my @roles = ('st');
10712: my @statuses = ('previous');
10713: my @roledoms = ($one);
10714: my $withsec = 1;
10715: my %roleshash =
10716: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
10717: \@statuses,\@roles,\@roledoms,$withsec);
10718: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
10719: my ($oldstart,$oldend) =
10720: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
10721: if ($oldend > 0 && $oldend <= $now) {
10722: $expire_role_result = 'ok';
10723: }
10724: }
10725: }
10726: }
1.443 albertel 10727: $result = $expire_role_result;
10728: }
10729: }
10730: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 10731: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 10732: if ($modify_section_result =~ /^ok/) {
10733: if ($secchange == 1) {
1.628 raeburn 10734: if ($sec eq '') {
10735: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
10736: } else {
10737: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
10738: }
1.443 albertel 10739: } elsif ($oldsec eq '-1') {
1.628 raeburn 10740: if ($sec eq '') {
10741: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
10742: } else {
10743: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
10744: }
1.443 albertel 10745: } else {
1.628 raeburn 10746: if ($sec eq '') {
10747: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
10748: } else {
10749: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
10750: }
1.443 albertel 10751: }
10752: } else {
1.628 raeburn 10753: if ($secchange) {
10754: $$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;
10755: } else {
10756: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
10757: }
1.443 albertel 10758: }
10759: $result = $modify_section_result;
10760: } elsif ($secchange == 1) {
1.628 raeburn 10761: if ($oldsec eq '') {
10762: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
10763: } else {
10764: $$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;
10765: }
1.626 raeburn 10766: if ($expire_role_result eq 'refused') {
10767: my $newsecurl = '/'.$cid;
10768: $newsecurl =~ s/\_/\//g;
10769: if ($sec ne '') {
10770: $newsecurl.='/'.$sec;
10771: }
10772: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
10773: if ($sec eq '') {
10774: $$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;
10775: } else {
10776: $$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;
10777: }
10778: }
10779: }
1.443 albertel 10780: }
10781: } else {
1.626 raeburn 10782: $$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 10783: $result = "error: incomplete course id\n";
10784: }
10785: return $result;
10786: }
10787:
10788: ############################################################
10789: ############################################################
10790:
1.566 albertel 10791: sub check_clone {
1.578 raeburn 10792: my ($args,$linefeed) = @_;
1.566 albertel 10793: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
10794: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
10795: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
10796: my $clonemsg;
10797: my $can_clone = 0;
1.944 raeburn 10798: my $lctype = lc($args->{'crstype'});
1.908 raeburn 10799: if ($lctype ne 'community') {
10800: $lctype = 'course';
10801: }
1.566 albertel 10802: if ($clonehome eq 'no_host') {
1.944 raeburn 10803: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10804: $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'});
10805: } else {
10806: $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'});
10807: }
1.566 albertel 10808: } else {
10809: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944 raeburn 10810: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10811: if ($clonedesc{'type'} ne 'Community') {
10812: $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'});
10813: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10814: }
10815: }
1.882 raeburn 10816: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
10817: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 10818: $can_clone = 1;
10819: } else {
10820: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
10821: $args->{'clonedomain'},$args->{'clonecourse'});
10822: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 10823: if (grep(/^\*$/,@cloners)) {
10824: $can_clone = 1;
10825: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
10826: $can_clone = 1;
10827: } else {
1.908 raeburn 10828: my $ccrole = 'cc';
1.944 raeburn 10829: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10830: $ccrole = 'co';
10831: }
1.578 raeburn 10832: my %roleshash =
10833: &Apache::lonnet::get_my_roles($args->{'ccuname'},
10834: $args->{'ccdomain'},
1.908 raeburn 10835: 'userroles',['active'],[$ccrole],
1.578 raeburn 10836: [$args->{'clonedomain'}]);
1.908 raeburn 10837: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942 raeburn 10838: $can_clone = 1;
10839: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
10840: $can_clone = 1;
10841: } else {
1.944 raeburn 10842: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10843: $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'});
10844: } else {
10845: $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'});
10846: }
1.578 raeburn 10847: }
1.566 albertel 10848: }
1.578 raeburn 10849: }
1.566 albertel 10850: }
10851: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10852: }
10853:
1.444 albertel 10854: sub construct_course {
1.885 raeburn 10855: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444 albertel 10856: my $outcome;
1.541 raeburn 10857: my $linefeed = '<br />'."\n";
10858: if ($context eq 'auto') {
10859: $linefeed = "\n";
10860: }
1.566 albertel 10861:
10862: #
10863: # Are we cloning?
10864: #
10865: my ($can_clone, $clonemsg, $cloneid, $clonehome);
10866: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 10867: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 10868: if ($context ne 'auto') {
1.578 raeburn 10869: if ($clonemsg ne '') {
10870: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
10871: }
1.566 albertel 10872: }
10873: $outcome .= $clonemsg.$linefeed;
10874:
10875: if (!$can_clone) {
10876: return (0,$outcome);
10877: }
10878: }
10879:
1.444 albertel 10880: #
10881: # Open course
10882: #
10883: my $crstype = lc($args->{'crstype'});
10884: my %cenv=();
10885: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
10886: $args->{'cdescr'},
10887: $args->{'curl'},
10888: $args->{'course_home'},
10889: $args->{'nonstandard'},
10890: $args->{'crscode'},
10891: $args->{'ccuname'}.':'.
10892: $args->{'ccdomain'},
1.882 raeburn 10893: $args->{'crstype'},
1.885 raeburn 10894: $cnum,$context,$category);
1.444 albertel 10895:
10896: # Note: The testing routines depend on this being output; see
10897: # Utils::Course. This needs to at least be output as a comment
10898: # if anyone ever decides to not show this, and Utils::Course::new
10899: # will need to be suitably modified.
1.541 raeburn 10900: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943 raeburn 10901: if ($$courseid =~ /^error:/) {
10902: return (0,$outcome);
10903: }
10904:
1.444 albertel 10905: #
10906: # Check if created correctly
10907: #
1.479 albertel 10908: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 10909: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 10910: if ($crsuhome eq 'no_host') {
10911: $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
10912: return (0,$outcome);
10913: }
1.541 raeburn 10914: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 10915:
1.444 albertel 10916: #
1.566 albertel 10917: # Do the cloning
10918: #
10919: if ($can_clone && $cloneid) {
10920: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
10921: if ($context ne 'auto') {
10922: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
10923: }
10924: $outcome .= $clonemsg.$linefeed;
10925: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 10926: # Copy all files
1.637 www 10927: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 10928: # Restore URL
1.566 albertel 10929: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 10930: # Restore title
1.566 albertel 10931: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 10932: # Restore creation date, creator and creation context.
10933: $cenv{'internal.created'}=$oldcenv{'internal.created'};
10934: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
10935: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 10936: # Mark as cloned
1.566 albertel 10937: $cenv{'clonedfrom'}=$cloneid;
1.638 www 10938: # Need to clone grading mode
10939: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
10940: $cenv{'grading'}=$newenv{'grading'};
10941: # Do not clone these environment entries
10942: &Apache::lonnet::del('environment',
10943: ['default_enrollment_start_date',
10944: 'default_enrollment_end_date',
10945: 'question.email',
10946: 'policy.email',
10947: 'comment.email',
10948: 'pch.users.denied',
1.725 raeburn 10949: 'plc.users.denied',
10950: 'hidefromcat',
10951: 'categories'],
1.638 www 10952: $$crsudom,$$crsunum);
1.444 albertel 10953: }
1.566 albertel 10954:
1.444 albertel 10955: #
10956: # Set environment (will override cloned, if existing)
10957: #
10958: my @sections = ();
10959: my @xlists = ();
10960: if ($args->{'crstype'}) {
10961: $cenv{'type'}=$args->{'crstype'};
10962: }
10963: if ($args->{'crsid'}) {
10964: $cenv{'courseid'}=$args->{'crsid'};
10965: }
10966: if ($args->{'crscode'}) {
10967: $cenv{'internal.coursecode'}=$args->{'crscode'};
10968: }
10969: if ($args->{'crsquota'} ne '') {
10970: $cenv{'internal.coursequota'}=$args->{'crsquota'};
10971: } else {
10972: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
10973: }
10974: if ($args->{'ccuname'}) {
10975: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
10976: ':'.$args->{'ccdomain'};
10977: } else {
10978: $cenv{'internal.courseowner'} = $args->{'curruser'};
10979: }
10980: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
10981: if ($args->{'crssections'}) {
10982: $cenv{'internal.sectionnums'} = '';
10983: if ($args->{'crssections'} =~ m/,/) {
10984: @sections = split/,/,$args->{'crssections'};
10985: } else {
10986: $sections[0] = $args->{'crssections'};
10987: }
10988: if (@sections > 0) {
10989: foreach my $item (@sections) {
10990: my ($sec,$gp) = split/:/,$item;
10991: my $class = $args->{'crscode'}.$sec;
10992: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
10993: $cenv{'internal.sectionnums'} .= $item.',';
10994: unless ($addcheck eq 'ok') {
10995: push @badclasses, $class;
10996: }
10997: }
10998: $cenv{'internal.sectionnums'} =~ s/,$//;
10999: }
11000: }
11001: # do not hide course coordinator from staff listing,
11002: # even if privileged
11003: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
11004: # add crosslistings
11005: if ($args->{'crsxlist'}) {
11006: $cenv{'internal.crosslistings'}='';
11007: if ($args->{'crsxlist'} =~ m/,/) {
11008: @xlists = split/,/,$args->{'crsxlist'};
11009: } else {
11010: $xlists[0] = $args->{'crsxlist'};
11011: }
11012: if (@xlists > 0) {
11013: foreach my $item (@xlists) {
11014: my ($xl,$gp) = split/:/,$item;
11015: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
11016: $cenv{'internal.crosslistings'} .= $item.',';
11017: unless ($addcheck eq 'ok') {
11018: push @badclasses, $xl;
11019: }
11020: }
11021: $cenv{'internal.crosslistings'} =~ s/,$//;
11022: }
11023: }
11024: if ($args->{'autoadds'}) {
11025: $cenv{'internal.autoadds'}=$args->{'autoadds'};
11026: }
11027: if ($args->{'autodrops'}) {
11028: $cenv{'internal.autodrops'}=$args->{'autodrops'};
11029: }
11030: # check for notification of enrollment changes
11031: my @notified = ();
11032: if ($args->{'notify_owner'}) {
11033: if ($args->{'ccuname'} ne '') {
11034: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
11035: }
11036: }
11037: if ($args->{'notify_dc'}) {
11038: if ($uname ne '') {
1.630 raeburn 11039: push(@notified,$uname.':'.$udom);
1.444 albertel 11040: }
11041: }
11042: if (@notified > 0) {
11043: my $notifylist;
11044: if (@notified > 1) {
11045: $notifylist = join(',',@notified);
11046: } else {
11047: $notifylist = $notified[0];
11048: }
11049: $cenv{'internal.notifylist'} = $notifylist;
11050: }
11051: if (@badclasses > 0) {
11052: my %lt=&Apache::lonlocal::texthash(
11053: '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',
11054: 'dnhr' => 'does not have rights to access enrollment in these classes',
11055: 'adby' => 'as determined by the policies of your institution on access to official classlists'
11056: );
1.541 raeburn 11057: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
11058: ' ('.$lt{'adby'}.')';
11059: if ($context eq 'auto') {
11060: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 11061: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 11062: foreach my $item (@badclasses) {
11063: if ($context eq 'auto') {
11064: $outcome .= " - $item\n";
11065: } else {
11066: $outcome .= "<li>$item</li>\n";
11067: }
11068: }
11069: if ($context eq 'auto') {
11070: $outcome .= $linefeed;
11071: } else {
1.566 albertel 11072: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 11073: }
11074: }
1.444 albertel 11075: }
11076: if ($args->{'no_end_date'}) {
11077: $args->{'endaccess'} = 0;
11078: }
11079: $cenv{'internal.autostart'}=$args->{'enrollstart'};
11080: $cenv{'internal.autoend'}=$args->{'enrollend'};
11081: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
11082: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
11083: if ($args->{'showphotos'}) {
11084: $cenv{'internal.showphotos'}=$args->{'showphotos'};
11085: }
11086: $cenv{'internal.authtype'} = $args->{'authtype'};
11087: $cenv{'internal.autharg'} = $args->{'autharg'};
11088: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
11089: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 11090: 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');
11091: if ($context eq 'auto') {
11092: $outcome .= $krb_msg;
11093: } else {
1.566 albertel 11094: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 11095: }
11096: $outcome .= $linefeed;
1.444 albertel 11097: }
11098: }
11099: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
11100: if ($args->{'setpolicy'}) {
11101: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
11102: }
11103: if ($args->{'setcontent'}) {
11104: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
11105: }
11106: }
11107: if ($args->{'reshome'}) {
11108: $cenv{'reshome'}=$args->{'reshome'}.'/';
11109: $cenv{'reshome'}=~s/\/+$/\//;
11110: }
11111: #
11112: # course has keyed access
11113: #
11114: if ($args->{'setkeys'}) {
11115: $cenv{'keyaccess'}='yes';
11116: }
11117: # if specified, key authority is not course, but user
11118: # only active if keyaccess is yes
11119: if ($args->{'keyauth'}) {
1.487 albertel 11120: my ($user,$domain) = split(':',$args->{'keyauth'});
11121: $user = &LONCAPA::clean_username($user);
11122: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 11123: if ($user ne '' && $domain ne '') {
1.487 albertel 11124: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 11125: }
11126: }
11127:
11128: if ($args->{'disresdis'}) {
11129: $cenv{'pch.roles.denied'}='st';
11130: }
11131: if ($args->{'disablechat'}) {
11132: $cenv{'plc.roles.denied'}='st';
11133: }
11134:
11135: # Record we've not yet viewed the Course Initialization Helper for this
11136: # course
11137: $cenv{'course.helper.not.run'} = 1;
11138: #
11139: # Use new Randomseed
11140: #
11141: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
11142: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
11143: #
11144: # The encryption code and receipt prefix for this course
11145: #
11146: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
11147: $cenv{'internal.encpref'}=100+int(9*rand(99));
11148: #
11149: # By default, use standard grading
11150: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
11151:
1.541 raeburn 11152: $outcome .= $linefeed.&mt('Setting environment').': '.
11153: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 11154: #
11155: # Open all assignments
11156: #
11157: if ($args->{'openall'}) {
11158: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
11159: my %storecontent = ($storeunder => time,
11160: $storeunder.'.type' => 'date_start');
11161:
11162: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 11163: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 11164: }
11165: #
11166: # Set first page
11167: #
11168: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
11169: || ($cloneid)) {
1.445 albertel 11170: use LONCAPA::map;
1.444 albertel 11171: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 11172:
11173: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
11174: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
11175:
1.444 albertel 11176: $outcome .= ($fatal?$errtext:'read ok').' - ';
11177: my $title; my $url;
11178: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 11179: $title=&mt('Syllabus');
1.444 albertel 11180: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
11181: } else {
1.963 raeburn 11182: $title=&mt('Table of Contents');
1.444 albertel 11183: $url='/adm/navmaps';
11184: }
1.445 albertel 11185:
11186: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
11187: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
11188:
11189: if ($errtext) { $fatal=2; }
1.541 raeburn 11190: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 11191: }
1.566 albertel 11192:
11193: return (1,$outcome);
1.444 albertel 11194: }
11195:
11196: ############################################################
11197: ############################################################
11198:
1.953 droeschl 11199: #SD
11200: # only Community and Course, or anything else?
1.378 raeburn 11201: sub course_type {
11202: my ($cid) = @_;
11203: if (!defined($cid)) {
11204: $cid = $env{'request.course.id'};
11205: }
1.404 albertel 11206: if (defined($env{'course.'.$cid.'.type'})) {
11207: return $env{'course.'.$cid.'.type'};
1.378 raeburn 11208: } else {
11209: return 'Course';
1.377 raeburn 11210: }
11211: }
1.156 albertel 11212:
1.406 raeburn 11213: sub group_term {
11214: my $crstype = &course_type();
11215: my %names = (
11216: 'Course' => 'group',
1.865 raeburn 11217: 'Community' => 'group',
1.406 raeburn 11218: );
11219: return $names{$crstype};
11220: }
11221:
1.902 raeburn 11222: sub course_types {
11223: my @types = ('official','unofficial','community');
11224: my %typename = (
11225: official => 'Official course',
11226: unofficial => 'Unofficial course',
11227: community => 'Community',
11228: );
11229: return (\@types,\%typename);
11230: }
11231:
1.156 albertel 11232: sub icon {
11233: my ($file)=@_;
1.505 albertel 11234: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 11235: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 11236: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 11237: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
11238: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
11239: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
11240: $curfext.".gif") {
11241: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
11242: $curfext.".gif";
11243: }
11244: }
1.249 albertel 11245: return &lonhttpdurl($iconname);
1.154 albertel 11246: }
1.84 albertel 11247:
1.575 albertel 11248: sub lonhttpdurl {
1.692 www 11249: #
11250: # Had been used for "small fry" static images on separate port 8080.
11251: # Modify here if lightweight http functionality desired again.
11252: # Currently eliminated due to increasing firewall issues.
11253: #
1.575 albertel 11254: my ($url)=@_;
1.692 www 11255: return $url;
1.215 albertel 11256: }
11257:
1.213 albertel 11258: sub connection_aborted {
11259: my ($r)=@_;
11260: $r->print(" ");$r->rflush();
11261: my $c = $r->connection;
11262: return $c->aborted();
11263: }
11264:
1.221 foxr 11265: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 11266: # strings as 'strings'.
11267: sub escape_single {
1.221 foxr 11268: my ($input) = @_;
1.223 albertel 11269: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 11270: $input =~ s/\'/\\\'/g; # Esacpe the 's....
11271: return $input;
11272: }
1.223 albertel 11273:
1.222 foxr 11274: # Same as escape_single, but escape's "'s This
11275: # can be used for "strings"
11276: sub escape_double {
11277: my ($input) = @_;
11278: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
11279: $input =~ s/\"/\\\"/g; # Esacpe the "s....
11280: return $input;
11281: }
1.223 albertel 11282:
1.222 foxr 11283: # Escapes the last element of a full URL.
11284: sub escape_url {
11285: my ($url) = @_;
1.238 raeburn 11286: my @urlslices = split(/\//, $url,-1);
1.369 www 11287: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 11288: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 11289: }
1.462 albertel 11290:
1.820 raeburn 11291: sub compare_arrays {
11292: my ($arrayref1,$arrayref2) = @_;
11293: my (@difference,%count);
11294: @difference = ();
11295: %count = ();
11296: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
11297: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
11298: foreach my $element (keys(%count)) {
11299: if ($count{$element} == 1) {
11300: push(@difference,$element);
11301: }
11302: }
11303: }
11304: return @difference;
11305: }
11306:
1.817 bisitz 11307: # -------------------------------------------------------- Initialize user login
1.462 albertel 11308: sub init_user_environment {
1.463 albertel 11309: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 11310: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
11311:
11312: my $public=($username eq 'public' && $domain eq 'public');
11313:
11314: # See if old ID present, if so, remove
11315:
11316: my ($filename,$cookie,$userroles);
11317: my $now=time;
11318:
11319: if ($public) {
11320: my $max_public=100;
11321: my $oldest;
11322: my $oldest_time=0;
11323: for(my $next=1;$next<=$max_public;$next++) {
11324: if (-e $lonids."/publicuser_$next.id") {
11325: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
11326: if ($mtime<$oldest_time || !$oldest_time) {
11327: $oldest_time=$mtime;
11328: $oldest=$next;
11329: }
11330: } else {
11331: $cookie="publicuser_$next";
11332: last;
11333: }
11334: }
11335: if (!$cookie) { $cookie="publicuser_$oldest"; }
11336: } else {
1.463 albertel 11337: # if this isn't a robot, kill any existing non-robot sessions
11338: if (!$args->{'robot'}) {
11339: opendir(DIR,$lonids);
11340: while ($filename=readdir(DIR)) {
11341: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
11342: unlink($lonids.'/'.$filename);
11343: }
1.462 albertel 11344: }
1.463 albertel 11345: closedir(DIR);
1.462 albertel 11346: }
11347: # Give them a new cookie
1.463 albertel 11348: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 11349: : $now.$$.int(rand(10000)));
1.463 albertel 11350: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 11351:
11352: # Initialize roles
11353:
11354: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
11355: }
11356: # ------------------------------------ Check browser type and MathML capability
11357:
11358: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
11359: $clientunicode,$clientos) = &decode_user_agent($r);
11360:
11361: # ------------------------------------------------------------- Get environment
11362:
11363: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
11364: my ($tmp) = keys(%userenv);
11365: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
11366: } else {
11367: undef(%userenv);
11368: }
11369: if (($userenv{'interface'}) && (!$form->{'interface'})) {
11370: $form->{'interface'}=$userenv{'interface'};
11371: }
11372: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
11373:
11374: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 11375: foreach my $option ('interface','localpath','localres') {
11376: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 11377: }
11378: # --------------------------------------------------------- Write first profile
11379:
11380: {
11381: my %initial_env =
11382: ("user.name" => $username,
11383: "user.domain" => $domain,
11384: "user.home" => $authhost,
11385: "browser.type" => $clientbrowser,
11386: "browser.version" => $clientversion,
11387: "browser.mathml" => $clientmathml,
11388: "browser.unicode" => $clientunicode,
11389: "browser.os" => $clientos,
11390: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
11391: "request.course.fn" => '',
11392: "request.course.uri" => '',
11393: "request.course.sec" => '',
11394: "request.role" => 'cm',
11395: "request.role.adv" => $env{'user.adv'},
11396: "request.host" => $ENV{'REMOTE_ADDR'},);
11397:
11398: if ($form->{'localpath'}) {
11399: $initial_env{"browser.localpath"} = $form->{'localpath'};
11400: $initial_env{"browser.localres"} = $form->{'localres'};
11401: }
11402:
11403: if ($form->{'interface'}) {
11404: $form->{'interface'}=~s/\W//gs;
11405: $initial_env{"browser.interface"} = $form->{'interface'};
11406: $env{'browser.interface'}=$form->{'interface'};
11407: }
11408:
1.981 raeburn 11409: my %is_adv = ( is_adv => $env{'user.adv'} );
1.1016 raeburn 11410: my %domdef;
11411: unless ($domain eq 'public') {
11412: %domdef = &Apache::lonnet::get_domain_defaults($domain);
11413: }
1.980 raeburn 11414:
1.724 raeburn 11415: foreach my $tool ('aboutme','blog','portfolio') {
11416: $userenv{'availabletools.'.$tool} =
1.980 raeburn 11417: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
11418: undef,\%userenv,\%domdef,\%is_adv);
1.724 raeburn 11419: }
11420:
1.864 raeburn 11421: foreach my $crstype ('official','unofficial','community') {
1.765 raeburn 11422: $userenv{'canrequest.'.$crstype} =
11423: &Apache::lonnet::usertools_access($username,$domain,$crstype,
1.980 raeburn 11424: 'reload','requestcourses',
11425: \%userenv,\%domdef,\%is_adv);
1.765 raeburn 11426: }
11427:
1.462 albertel 11428: $env{'user.environment'} = "$lonids/$cookie.id";
11429:
11430: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
11431: &GDBM_WRCREAT(),0640)) {
11432: &_add_to_env(\%disk_env,\%initial_env);
11433: &_add_to_env(\%disk_env,\%userenv,'environment.');
11434: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 11435: if (ref($args->{'extra_env'})) {
11436: &_add_to_env(\%disk_env,$args->{'extra_env'});
11437: }
1.462 albertel 11438: untie(%disk_env);
11439: } else {
1.705 tempelho 11440: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
11441: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 11442: return 'error: '.$!;
11443: }
11444: }
11445: $env{'request.role'}='cm';
11446: $env{'request.role.adv'}=$env{'user.adv'};
11447: $env{'browser.type'}=$clientbrowser;
11448:
11449: return $cookie;
11450:
11451: }
11452:
11453: sub _add_to_env {
11454: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 11455: if (ref($env_data) eq 'HASH') {
11456: while (my ($key,$value) = each(%$env_data)) {
11457: $idf->{$prefix.$key} = $value;
11458: $env{$prefix.$key} = $value;
11459: }
1.462 albertel 11460: }
11461: }
11462:
1.685 tempelho 11463: # --- Get the symbolic name of a problem and the url
11464: sub get_symb {
11465: my ($request,$silent) = @_;
1.726 raeburn 11466: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 11467: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
11468: if ($symb eq '') {
11469: if (!$silent) {
11470: $request->print("Unable to handle ambiguous references:$url:.");
11471: return ();
11472: }
11473: }
11474: &Apache::lonenc::check_decrypt(\$symb);
11475: return ($symb);
11476: }
11477:
11478: # --------------------------------------------------------------Get annotation
11479:
11480: sub get_annotation {
11481: my ($symb,$enc) = @_;
11482:
11483: my $key = $symb;
11484: if (!$enc) {
11485: $key =
11486: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
11487: }
11488: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
11489: return $annotation{$key};
11490: }
11491:
11492: sub clean_symb {
1.731 raeburn 11493: my ($symb,$delete_enc) = @_;
1.685 tempelho 11494:
11495: &Apache::lonenc::check_decrypt(\$symb);
11496: my $enc = $env{'request.enc'};
1.731 raeburn 11497: if ($delete_enc) {
1.730 raeburn 11498: delete($env{'request.enc'});
11499: }
1.685 tempelho 11500:
11501: return ($symb,$enc);
11502: }
1.462 albertel 11503:
1.990 raeburn 11504: sub build_release_hashes {
11505: my ($checkparms,$checkresponsetypes,$checkcrstypes,$anonsurvey,$randomizetry) = @_;
11506: return unless((ref($checkparms) eq 'HASH') && (ref($checkresponsetypes) eq 'HASH') &&
11507: (ref($checkcrstypes) eq 'HASH') && (ref($anonsurvey) eq 'HASH') &&
11508: (ref($randomizetry) eq 'HASH'));
11509: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
11510: my ($item,$name,$value) = split(/:/,$key);
11511: if ($item eq 'parameter') {
11512: if (ref($checkparms->{$name}) eq 'ARRAY') {
11513: unless(grep(/^\Q$name\E$/,@{$checkparms->{$name}})) {
11514: push(@{$checkparms->{$name}},$value);
11515: }
11516: } else {
11517: push(@{$checkparms->{$name}},$value);
11518: }
11519: } elsif ($item eq 'resourcetag') {
11520: if ($name eq 'responsetype') {
11521: $checkresponsetypes->{$value} = $Apache::lonnet::needsrelease{$key}
11522: }
11523: } elsif ($item eq 'course') {
11524: if ($name eq 'crstype') {
11525: $checkcrstypes->{$value} = $Apache::lonnet::needsrelease{$key};
11526: }
11527: }
11528: }
11529: ($anonsurvey->{major},$anonsurvey->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:anonsurvey'});
11530: ($randomizetry->{major},$randomizetry->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:randomizetry'});
11531: return;
11532: }
11533:
1.41 ng 11534: =pod
11535:
11536: =back
11537:
1.112 bowersj2 11538: =cut
1.41 ng 11539:
1.112 bowersj2 11540: 1;
11541: __END__;
1.41 ng 11542:
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