Annotation of loncom/interface/loncommon.pm, revision 1.1004
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1004 ! www 4: # $Id: loncommon.pm,v 1.1003 2011/05/03 21:38:40 www Exp $
1.10 albertel 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.1 albertel 28:
29: # Makes a table out of the previous attempts
1.2 albertel 30: # Inputs result_from_symbread, user, domain, course_id
1.16 harris41 31: # Reads in non-network-related .tab files
1.1 albertel 32:
1.35 matthew 33: # POD header:
34:
1.45 matthew 35: =pod
36:
1.35 matthew 37: =head1 NAME
38:
39: Apache::loncommon - pile of common routines
40:
41: =head1 SYNOPSIS
42:
1.112 bowersj2 43: Common routines for manipulating connections, student answers,
44: domains, common Javascript fragments, etc.
1.35 matthew 45:
1.112 bowersj2 46: =head1 OVERVIEW
1.35 matthew 47:
1.112 bowersj2 48: A collection of commonly used subroutines that don't have a natural
49: home anywhere else. This collection helps remove
1.35 matthew 50: redundancy from other modules and increase efficiency of memory usage.
51:
52: =cut
53:
54: # End of POD header
1.1 albertel 55: package Apache::loncommon;
56:
57: use strict;
1.258 albertel 58: use Apache::lonnet;
1.46 matthew 59: use GDBM_File;
1.51 www 60: use POSIX qw(strftime mktime);
1.82 www 61: use Apache::lonmenu();
1.498 albertel 62: use Apache::lonenc();
1.117 www 63: use Apache::lonlocal;
1.685 tempelho 64: use Apache::lonnet();
1.139 matthew 65: use HTML::Entities;
1.334 albertel 66: use Apache::lonhtmlcommon();
67: use Apache::loncoursedata();
1.344 albertel 68: use Apache::lontexconvert();
1.444 albertel 69: use Apache::lonclonecourse();
1.479 albertel 70: use LONCAPA qw(:DEFAULT :match);
1.657 raeburn 71: use DateTime::TimeZone;
1.687 raeburn 72: use DateTime::Locale::Catalog;
1.117 www 73:
1.517 raeburn 74: # ---------------------------------------------- Designs
75: use vars qw(%defaultdesign);
76:
1.22 www 77: my $readit;
78:
1.517 raeburn 79:
1.157 matthew 80: ##
81: ## Global Variables
82: ##
1.46 matthew 83:
1.643 foxr 84:
85: # ----------------------------------------------- SSI with retries:
86: #
87:
88: =pod
89:
1.648 raeburn 90: =head1 Server Side include with retries:
1.643 foxr 91:
92: =over 4
93:
1.648 raeburn 94: =item * &ssi_with_retries(resource,retries form)
1.643 foxr 95:
96: Performs an ssi with some number of retries. Retries continue either
97: until the result is ok or until the retry count supplied by the
98: caller is exhausted.
99:
100: Inputs:
1.648 raeburn 101:
102: =over 4
103:
1.643 foxr 104: resource - Identifies the resource to insert.
1.648 raeburn 105:
1.643 foxr 106: retries - Count of the number of retries allowed.
1.648 raeburn 107:
1.643 foxr 108: form - Hash that identifies the rendering options.
109:
1.648 raeburn 110: =back
111:
112: Returns:
113:
114: =over 4
115:
1.643 foxr 116: content - The content of the response. If retries were exhausted this is empty.
1.648 raeburn 117:
1.643 foxr 118: response - The response from the last attempt (which may or may not have been successful.
119:
1.648 raeburn 120: =back
121:
122: =back
123:
1.643 foxr 124: =cut
125:
126: sub ssi_with_retries {
127: my ($resource, $retries, %form) = @_;
128:
129:
130: my $ok = 0; # True if we got a good response.
131: my $content;
132: my $response;
133:
134: # Try to get the ssi done. within the retries count:
135:
136: do {
137: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
138: $ok = $response->is_success;
1.650 www 139: if (!$ok) {
140: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
141: }
1.643 foxr 142: $retries--;
143: } while (!$ok && ($retries > 0));
144:
145: if (!$ok) {
146: $content = ''; # On error return an empty content.
147: }
148: return ($content, $response);
149:
150: }
151:
152:
153:
1.20 www 154: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 155: my %language;
1.124 www 156: my %supported_language;
1.12 harris41 157: my %cprtag;
1.192 taceyjo1 158: my %scprtag;
1.351 www 159: my %fe; my %fd; my %fm;
1.41 ng 160: my %category_extensions;
1.12 harris41 161:
1.46 matthew 162: # ---------------------------------------------- Thesaurus variables
1.144 matthew 163: #
164: # %Keywords:
165: # A hash used by &keyword to determine if a word is considered a keyword.
166: # $thesaurus_db_file
167: # Scalar containing the full path to the thesaurus database.
1.46 matthew 168:
169: my %Keywords;
170: my $thesaurus_db_file;
171:
1.144 matthew 172: #
173: # Initialize values from language.tab, copyright.tab, filetypes.tab,
174: # thesaurus.tab, and filecategories.tab.
175: #
1.18 www 176: BEGIN {
1.46 matthew 177: # Variable initialization
178: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
179: #
1.22 www 180: unless ($readit) {
1.12 harris41 181: # ------------------------------------------------------------------- languages
182: {
1.158 raeburn 183: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
184: '/language.tab';
185: if ( open(my $fh,"<$langtabfile") ) {
1.356 albertel 186: while (my $line = <$fh>) {
187: next if ($line=~/^\#/);
188: chomp($line);
189: my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
1.158 raeburn 190: $language{$key}=$val.' - '.$enc;
191: if ($sup) {
192: $supported_language{$key}=$sup;
193: }
194: }
195: close($fh);
196: }
1.12 harris41 197: }
198: # ------------------------------------------------------------------ copyrights
199: {
1.158 raeburn 200: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
201: '/copyright.tab';
202: if ( open (my $fh,"<$copyrightfile") ) {
1.356 albertel 203: while (my $line = <$fh>) {
204: next if ($line=~/^\#/);
205: chomp($line);
206: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 207: $cprtag{$key}=$val;
208: }
209: close($fh);
210: }
1.12 harris41 211: }
1.351 www 212: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 213: {
214: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
215: '/source_copyright.tab';
216: if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356 albertel 217: while (my $line = <$fh>) {
218: next if ($line =~ /^\#/);
219: chomp($line);
220: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 221: $scprtag{$key}=$val;
222: }
223: close($fh);
224: }
225: }
1.63 www 226:
1.517 raeburn 227: # -------------------------------------------------------------- default domain designs
1.63 www 228: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 229: my $designfile = $designdir.'/default.tab';
230: if ( open (my $fh,"<$designfile") ) {
231: while (my $line = <$fh>) {
232: next if ($line =~ /^\#/);
233: chomp($line);
234: my ($key,$val)=(split(/\=/,$line));
235: if ($val) { $defaultdesign{$key}=$val; }
236: }
237: close($fh);
1.63 www 238: }
239:
1.15 harris41 240: # ------------------------------------------------------------- file categories
241: {
1.158 raeburn 242: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
243: '/filecategories.tab';
244: if ( open (my $fh,"<$categoryfile") ) {
1.356 albertel 245: while (my $line = <$fh>) {
246: next if ($line =~ /^\#/);
247: chomp($line);
248: my ($extension,$category)=(split(/\s+/,$line,2));
1.158 raeburn 249: push @{$category_extensions{lc($category)}},$extension;
250: }
251: close($fh);
252: }
253:
1.15 harris41 254: }
1.12 harris41 255: # ------------------------------------------------------------------ file types
256: {
1.158 raeburn 257: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
258: '/filetypes.tab';
259: if ( open (my $fh,"<$typesfile") ) {
1.356 albertel 260: while (my $line = <$fh>) {
261: next if ($line =~ /^\#/);
262: chomp($line);
263: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 264: if ($descr ne '') {
265: $fe{$ending}=lc($emb);
266: $fd{$ending}=$descr;
1.351 www 267: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 268: }
269: }
270: close($fh);
271: }
1.12 harris41 272: }
1.22 www 273: &Apache::lonnet::logthis(
1.705 tempelho 274: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 275: $readit=1;
1.46 matthew 276: } # end of unless($readit)
1.32 matthew 277:
278: }
1.112 bowersj2 279:
1.42 matthew 280: ###############################################################
281: ## HTML and Javascript Helper Functions ##
282: ###############################################################
283:
284: =pod
285:
1.112 bowersj2 286: =head1 HTML and Javascript Functions
1.42 matthew 287:
1.112 bowersj2 288: =over 4
289:
1.648 raeburn 290: =item * &browser_and_searcher_javascript()
1.112 bowersj2 291:
292: X<browsing, javascript>X<searching, javascript>Returns a string
293: containing javascript with two functions, C<openbrowser> and
294: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
295: tags.
1.42 matthew 296:
1.648 raeburn 297: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 298:
299: inputs: formname, elementname, only, omit
300:
301: formname and elementname indicate the name of the html form and name of
302: the element that the results of the browsing selection are to be placed in.
303:
304: Specifying 'only' will restrict the browser to displaying only files
1.185 www 305: with the given extension. Can be a comma separated list.
1.42 matthew 306:
307: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 308: with the given extension. Can be a comma separated list.
1.42 matthew 309:
1.648 raeburn 310: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 311:
312: Inputs: formname, elementname
313:
314: formname and elementname specify the name of the html form and the name
315: of the element the selection from the search results will be placed in.
1.542 raeburn 316:
1.42 matthew 317: =cut
318:
319: sub browser_and_searcher_javascript {
1.199 albertel 320: my ($mode)=@_;
321: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 322: my $resurl=&escape_single(&lastresurl());
1.42 matthew 323: return <<END;
1.219 albertel 324: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 325: var editbrowser = null;
1.135 albertel 326: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 327: var url = '$resurl/?';
1.42 matthew 328: if (editbrowser == null) {
329: url += 'launch=1&';
330: }
331: url += 'catalogmode=interactive&';
1.199 albertel 332: url += 'mode=$mode&';
1.611 albertel 333: url += 'inhibitmenu=yes&';
1.42 matthew 334: url += 'form=' + formname + '&';
335: if (only != null) {
336: url += 'only=' + only + '&';
1.217 albertel 337: } else {
338: url += 'only=&';
339: }
1.42 matthew 340: if (omit != null) {
341: url += 'omit=' + omit + '&';
1.217 albertel 342: } else {
343: url += 'omit=&';
344: }
1.135 albertel 345: if (titleelement != null) {
346: url += 'titleelement=' + titleelement + '&';
1.217 albertel 347: } else {
348: url += 'titleelement=&';
349: }
1.42 matthew 350: url += 'element=' + elementname + '';
351: var title = 'Browser';
1.435 albertel 352: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 353: options += ',width=700,height=600';
354: editbrowser = open(url,title,options,'1');
355: editbrowser.focus();
356: }
357: var editsearcher;
1.135 albertel 358: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 359: var url = '/adm/searchcat?';
360: if (editsearcher == null) {
361: url += 'launch=1&';
362: }
363: url += 'catalogmode=interactive&';
1.199 albertel 364: url += 'mode=$mode&';
1.42 matthew 365: url += 'form=' + formname + '&';
1.135 albertel 366: if (titleelement != null) {
367: url += 'titleelement=' + titleelement + '&';
1.217 albertel 368: } else {
369: url += 'titleelement=&';
370: }
1.42 matthew 371: url += 'element=' + elementname + '';
372: var title = 'Search';
1.435 albertel 373: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 374: options += ',width=700,height=600';
375: editsearcher = open(url,title,options,'1');
376: editsearcher.focus();
377: }
1.219 albertel 378: // END LON-CAPA Internal -->
1.42 matthew 379: END
1.170 www 380: }
381:
382: sub lastresurl {
1.258 albertel 383: if ($env{'environment.lastresurl'}) {
384: return $env{'environment.lastresurl'}
1.170 www 385: } else {
386: return '/res';
387: }
388: }
389:
390: sub storeresurl {
391: my $resurl=&Apache::lonnet::clutter(shift);
392: unless ($resurl=~/^\/res/) { return 0; }
393: $resurl=~s/\/$//;
394: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 395: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 396: return 1;
1.42 matthew 397: }
398:
1.74 www 399: sub studentbrowser_javascript {
1.111 www 400: unless (
1.258 albertel 401: (($env{'request.course.id'}) &&
1.302 albertel 402: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
403: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
404: '/'.$env{'request.course.sec'})
405: ))
1.258 albertel 406: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 407: ) { return ''; }
1.74 www 408: return (<<'ENDSTDBRW');
1.776 bisitz 409: <script type="text/javascript" language="Javascript">
1.824 bisitz 410: // <![CDATA[
1.74 www 411: var stdeditbrowser;
1.999 www 412: function openstdbrowser(formname,uname,udom,clicker,roleflag,ignorefilter,courseadvonly) {
1.74 www 413: var url = '/adm/pickstudent?';
414: var filter;
1.558 albertel 415: if (!ignorefilter) {
416: eval('filter=document.'+formname+'.'+uname+'.value;');
417: }
1.74 www 418: if (filter != null) {
419: if (filter != '') {
420: url += 'filter='+filter+'&';
421: }
422: }
423: url += 'form=' + formname + '&unameelement='+uname+
1.999 www 424: '&udomelement='+udom+
425: '&clicker='+clicker;
1.111 www 426: if (roleflag) { url+="&roles=1"; }
1.793 raeburn 427: if (courseadvonly) { url+="&courseadvonly=1"; }
1.102 www 428: var title = 'Student_Browser';
1.74 www 429: var options = 'scrollbars=1,resizable=1,menubar=0';
430: options += ',width=700,height=600';
431: stdeditbrowser = open(url,title,options,'1');
432: stdeditbrowser.focus();
433: }
1.824 bisitz 434: // ]]>
1.74 www 435: </script>
436: ENDSTDBRW
437: }
1.42 matthew 438:
1.1003 www 439: sub resourcebrowser_javascript {
440: unless ($env{'request.course.id'}) { return ''; }
1.1004 ! www 441: return (<<'ENDRESBRW');
1.1003 www 442: <script type="text/javascript" language="Javascript">
443: // <![CDATA[
444: var reseditbrowser;
1.1004 ! www 445: function openresbrowser(formname,reslink) {
! 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';
449: options += ',width=700,height=600';
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.793 raeburn 478: $callargs .= ",1";
479: return '<span class="LC_nobreak">'.
480: '<a href="javascript:openstdbrowser('.$callargs.');">'.
481: &mt('Select User').'</a></span>';
1.111 www 482: }
483: return '';
1.91 www 484: }
485:
1.1004 ! www 486: sub selectresource_link {
! 487: my ($form,$reslink,$arg)=@_;
! 488:
! 489: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
! 490: &Apache::lonhtmlcommon::entity_encode($reslink)."'";
! 491: unless ($env{'request.course.id'}) { return $arg; }
! 492: return '<span class="LC_nobreak">'.
! 493: '<a href="javascript:openresbrowser('.$callargs.');">'.
! 494: $arg.'</a></span>';
! 495: }
! 496:
! 497:
! 498:
1.653 raeburn 499: sub authorbrowser_javascript {
500: return <<"ENDAUTHORBRW";
1.776 bisitz 501: <script type="text/javascript" language="JavaScript">
1.824 bisitz 502: // <![CDATA[
1.653 raeburn 503: var stdeditbrowser;
504:
505: function openauthorbrowser(formname,udom) {
506: var url = '/adm/pickauthor?';
507: url += 'form='+formname+'&roledom='+udom;
508: var title = 'Author_Browser';
509: var options = 'scrollbars=1,resizable=1,menubar=0';
510: options += ',width=700,height=600';
511: stdeditbrowser = open(url,title,options,'1');
512: stdeditbrowser.focus();
513: }
514:
1.824 bisitz 515: // ]]>
1.653 raeburn 516: </script>
517: ENDAUTHORBRW
518: }
519:
1.91 www 520: sub coursebrowser_javascript {
1.909 raeburn 521: my ($domainfilter,$sec_element,$formname,$role_element,$crstype) = @_;
1.932 raeburn 522: my $wintitle = 'Course_Browser';
1.931 raeburn 523: if ($crstype eq 'Community') {
1.932 raeburn 524: $wintitle = 'Community_Browser';
1.909 raeburn 525: }
1.876 raeburn 526: my $id_functions = &javascript_index_functions();
527: my $output = '
1.776 bisitz 528: <script type="text/javascript" language="JavaScript">
1.824 bisitz 529: // <![CDATA[
1.468 raeburn 530: var stdeditbrowser;'."\n";
1.876 raeburn 531:
532: $output .= <<"ENDSTDBRW";
1.909 raeburn 533: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91 www 534: var url = '/adm/pickcourse?';
1.895 raeburn 535: var formid = getFormIdByName(formname);
1.876 raeburn 536: var domainfilter = getDomainFromSelectbox(formname,udom);
1.128 albertel 537: if (domainfilter != null) {
538: if (domainfilter != '') {
539: url += 'domainfilter='+domainfilter+'&';
540: }
541: }
1.91 www 542: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 543: '&cdomelement='+udom+
544: '&cnameelement='+desc;
1.468 raeburn 545: if (extra_element !=null && extra_element != '') {
1.594 raeburn 546: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 547: url += '&roleelement='+extra_element;
548: if (domainfilter == null || domainfilter == '') {
549: url += '&domainfilter='+extra_element;
550: }
1.234 raeburn 551: }
1.468 raeburn 552: else {
553: if (formname == 'portform') {
554: url += '&setroles='+extra_element;
1.800 raeburn 555: } else {
556: if (formname == 'rules') {
557: url += '&fixeddom='+extra_element;
558: }
1.468 raeburn 559: }
560: }
1.230 raeburn 561: }
1.909 raeburn 562: if (type != null && type != '') {
563: url += '&type='+type;
564: }
565: if (type_elem != null && type_elem != '') {
566: url += '&typeelement='+type_elem;
567: }
1.872 raeburn 568: if (formname == 'ccrs') {
569: var ownername = document.forms[formid].ccuname.value;
570: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
571: url += '&cloner='+ownername+':'+ownerdom;
572: }
1.293 raeburn 573: if (multflag !=null && multflag != '') {
574: url += '&multiple='+multflag;
575: }
1.909 raeburn 576: var title = '$wintitle';
1.91 www 577: var options = 'scrollbars=1,resizable=1,menubar=0';
578: options += ',width=700,height=600';
579: stdeditbrowser = open(url,title,options,'1');
580: stdeditbrowser.focus();
581: }
1.876 raeburn 582: $id_functions
583: ENDSTDBRW
1.905 raeburn 584: if (($sec_element ne '') || ($role_element ne '')) {
585: $output .= &setsec_javascript($sec_element,$formname,$role_element);
1.876 raeburn 586: }
587: $output .= '
588: // ]]>
589: </script>';
590: return $output;
591: }
592:
593: sub javascript_index_functions {
594: return <<"ENDJS";
595:
596: function getFormIdByName(formname) {
597: for (var i=0;i<document.forms.length;i++) {
598: if (document.forms[i].name == formname) {
599: return i;
600: }
601: }
602: return -1;
603: }
604:
605: function getIndexByName(formid,item) {
606: for (var i=0;i<document.forms[formid].elements.length;i++) {
607: if (document.forms[formid].elements[i].name == item) {
608: return i;
609: }
610: }
611: return -1;
612: }
1.468 raeburn 613:
1.876 raeburn 614: function getDomainFromSelectbox(formname,udom) {
615: var userdom;
616: var formid = getFormIdByName(formname);
617: if (formid > -1) {
618: var domid = getIndexByName(formid,udom);
619: if (domid > -1) {
620: if (document.forms[formid].elements[domid].type == 'select-one') {
621: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
622: }
623: if (document.forms[formid].elements[domid].type == 'hidden') {
624: userdom=document.forms[formid].elements[domid].value;
1.468 raeburn 625: }
626: }
627: }
1.876 raeburn 628: return userdom;
629: }
630:
631: ENDJS
1.468 raeburn 632:
1.876 raeburn 633: }
634:
635: sub userbrowser_javascript {
636: my $id_functions = &javascript_index_functions();
637: return <<"ENDUSERBRW";
638:
1.888 raeburn 639: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876 raeburn 640: var url = '/adm/pickuser?';
641: var userdom = getDomainFromSelectbox(formname,udom);
642: if (userdom != null) {
643: if (userdom != '') {
644: url += 'srchdom='+userdom+'&';
645: }
646: }
647: url += 'form=' + formname + '&unameelement='+uname+
648: '&udomelement='+udom+
649: '&ulastelement='+ulast+
650: '&ufirstelement='+ufirst+
651: '&uemailelement='+uemail+
1.881 raeburn 652: '&hideudomelement='+hideudom+
653: '&coursedom='+crsdom;
1.888 raeburn 654: if ((caller != null) && (caller != undefined)) {
655: url += '&caller='+caller;
656: }
1.876 raeburn 657: var title = 'User_Browser';
658: var options = 'scrollbars=1,resizable=1,menubar=0';
659: options += ',width=700,height=600';
660: var stdeditbrowser = open(url,title,options,'1');
661: stdeditbrowser.focus();
662: }
663:
1.888 raeburn 664: function fix_domain (formname,udom,origdom,uname) {
1.876 raeburn 665: var formid = getFormIdByName(formname);
666: if (formid > -1) {
1.888 raeburn 667: var unameid = getIndexByName(formid,uname);
1.876 raeburn 668: var domid = getIndexByName(formid,udom);
669: var hidedomid = getIndexByName(formid,origdom);
670: if (hidedomid > -1) {
671: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888 raeburn 672: var unameval = document.forms[formid].elements[unameid].value;
673: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
674: if (domid > -1) {
675: var slct = document.forms[formid].elements[domid];
676: if (slct.type == 'select-one') {
677: var i;
678: for (i=0;i<slct.length;i++) {
679: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
680: }
681: }
682: if (slct.type == 'hidden') {
683: slct.value = fixeddom;
1.876 raeburn 684: }
685: }
1.468 raeburn 686: }
687: }
688: }
1.876 raeburn 689: return;
690: }
691:
692: $id_functions
693: ENDUSERBRW
1.468 raeburn 694: }
695:
696: sub setsec_javascript {
1.905 raeburn 697: my ($sec_element,$formname,$role_element) = @_;
698: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
699: $communityrolestr);
700: if ($role_element ne '') {
701: my @allroles = ('st','ta','ep','in','ad');
702: foreach my $crstype ('Course','Community') {
703: if ($crstype eq 'Community') {
704: foreach my $role (@allroles) {
705: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
706: }
707: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
708: } else {
709: foreach my $role (@allroles) {
710: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
711: }
712: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
713: }
714: }
715: $rolestr = '"'.join('","',@allroles).'"';
716: $courserolestr = '"'.join('","',@courserolenames).'"';
717: $communityrolestr = '"'.join('","',@communityrolenames).'"';
718: }
1.468 raeburn 719: my $setsections = qq|
720: function setSect(sectionlist) {
1.629 raeburn 721: var sectionsArray = new Array();
722: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
723: sectionsArray = sectionlist.split(",");
724: }
1.468 raeburn 725: var numSections = sectionsArray.length;
726: document.$formname.$sec_element.length = 0;
727: if (numSections == 0) {
728: document.$formname.$sec_element.multiple=false;
729: document.$formname.$sec_element.size=1;
730: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
731: } else {
732: if (numSections == 1) {
733: document.$formname.$sec_element.multiple=false;
734: document.$formname.$sec_element.size=1;
735: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
736: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
737: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
738: } else {
739: for (var i=0; i<numSections; i++) {
740: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
741: }
742: document.$formname.$sec_element.multiple=true
743: if (numSections < 3) {
744: document.$formname.$sec_element.size=numSections;
745: } else {
746: document.$formname.$sec_element.size=3;
747: }
748: document.$formname.$sec_element.options[0].selected = false
749: }
750: }
1.91 www 751: }
1.905 raeburn 752:
753: function setRole(crstype) {
1.468 raeburn 754: |;
1.905 raeburn 755: if ($role_element eq '') {
756: $setsections .= ' return;
757: }
758: ';
759: } else {
760: $setsections .= qq|
761: var elementLength = document.$formname.$role_element.length;
762: var allroles = Array($rolestr);
763: var courserolenames = Array($courserolestr);
764: var communityrolenames = Array($communityrolestr);
765: if (elementLength != undefined) {
766: if (document.$formname.$role_element.options[5].value == 'cc') {
767: if (crstype == 'Course') {
768: return;
769: } else {
770: allroles[5] = 'co';
771: for (var i=0; i<6; i++) {
772: document.$formname.$role_element.options[i].value = allroles[i];
773: document.$formname.$role_element.options[i].text = communityrolenames[i];
774: }
775: }
776: } else {
777: if (crstype == 'Community') {
778: return;
779: } else {
780: allroles[5] = 'cc';
781: for (var i=0; i<6; i++) {
782: document.$formname.$role_element.options[i].value = allroles[i];
783: document.$formname.$role_element.options[i].text = courserolenames[i];
784: }
785: }
786: }
787: }
788: return;
789: }
790: |;
791: }
1.468 raeburn 792: return $setsections;
793: }
794:
1.91 www 795: sub selectcourse_link {
1.909 raeburn 796: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
797: $typeelement) = @_;
798: my $type = $selecttype;
1.871 raeburn 799: my $linktext = &mt('Select Course');
800: if ($selecttype eq 'Community') {
1.909 raeburn 801: $linktext = &mt('Select Community');
1.906 raeburn 802: } elsif ($selecttype eq 'Course/Community') {
803: $linktext = &mt('Select Course/Community');
1.909 raeburn 804: $type = '';
1.871 raeburn 805: }
1.787 bisitz 806: return '<span class="LC_nobreak">'
807: ."<a href='"
808: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
809: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 810: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 811: ."'>".$linktext.'</a>'
1.787 bisitz 812: .'</span>';
1.74 www 813: }
1.42 matthew 814:
1.653 raeburn 815: sub selectauthor_link {
816: my ($form,$udom)=@_;
817: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
818: &mt('Select Author').'</a>';
819: }
820:
1.876 raeburn 821: sub selectuser_link {
1.881 raeburn 822: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 823: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 824: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 825: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 826: ');">'.$linktext.'</a>';
1.876 raeburn 827: }
828:
1.273 raeburn 829: sub check_uncheck_jscript {
830: my $jscript = <<"ENDSCRT";
831: function checkAll(field) {
832: if (field.length > 0) {
833: for (i = 0; i < field.length; i++) {
834: field[i].checked = true ;
835: }
836: } else {
837: field.checked = true
838: }
839: }
840:
841: function uncheckAll(field) {
842: if (field.length > 0) {
843: for (i = 0; i < field.length; i++) {
844: field[i].checked = false ;
1.543 albertel 845: }
846: } else {
1.273 raeburn 847: field.checked = false ;
848: }
849: }
850: ENDSCRT
851: return $jscript;
852: }
853:
1.656 www 854: sub select_timezone {
1.659 raeburn 855: my ($name,$selected,$onchange,$includeempty)=@_;
856: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
857: if ($includeempty) {
858: $output .= '<option value=""';
859: if (($selected eq '') || ($selected eq 'local')) {
860: $output .= ' selected="selected" ';
861: }
862: $output .= '> </option>';
863: }
1.657 raeburn 864: my @timezones = DateTime::TimeZone->all_names;
865: foreach my $tzone (@timezones) {
866: $output.= '<option value="'.$tzone.'"';
867: if ($tzone eq $selected) {
868: $output.=' selected="selected"';
869: }
870: $output.=">$tzone</option>\n";
1.656 www 871: }
872: $output.="</select>";
873: return $output;
874: }
1.273 raeburn 875:
1.687 raeburn 876: sub select_datelocale {
877: my ($name,$selected,$onchange,$includeempty)=@_;
878: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
879: if ($includeempty) {
880: $output .= '<option value=""';
881: if ($selected eq '') {
882: $output .= ' selected="selected" ';
883: }
884: $output .= '> </option>';
885: }
886: my (@possibles,%locale_names);
887: my @locales = DateTime::Locale::Catalog::Locales;
888: foreach my $locale (@locales) {
889: if (ref($locale) eq 'HASH') {
890: my $id = $locale->{'id'};
891: if ($id ne '') {
892: my $en_terr = $locale->{'en_territory'};
893: my $native_terr = $locale->{'native_territory'};
1.695 raeburn 894: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 895: if (grep(/^en$/,@languages) || !@languages) {
896: if ($en_terr ne '') {
897: $locale_names{$id} = '('.$en_terr.')';
898: } elsif ($native_terr ne '') {
899: $locale_names{$id} = $native_terr;
900: }
901: } else {
902: if ($native_terr ne '') {
903: $locale_names{$id} = $native_terr.' ';
904: } elsif ($en_terr ne '') {
905: $locale_names{$id} = '('.$en_terr.')';
906: }
907: }
908: push (@possibles,$id);
909: }
910: }
911: }
912: foreach my $item (sort(@possibles)) {
913: $output.= '<option value="'.$item.'"';
914: if ($item eq $selected) {
915: $output.=' selected="selected"';
916: }
917: $output.=">$item";
918: if ($locale_names{$item} ne '') {
919: $output.=" $locale_names{$item}</option>\n";
920: }
921: $output.="</option>\n";
922: }
923: $output.="</select>";
924: return $output;
925: }
926:
1.792 raeburn 927: sub select_language {
928: my ($name,$selected,$includeempty) = @_;
929: my %langchoices;
930: if ($includeempty) {
931: %langchoices = ('' => 'No language preference');
932: }
933: foreach my $id (&languageids()) {
934: my $code = &supportedlanguagecode($id);
935: if ($code) {
936: $langchoices{$code} = &plainlanguagedescription($id);
937: }
938: }
1.970 raeburn 939: return &select_form($selected,$name,\%langchoices);
1.792 raeburn 940: }
941:
1.42 matthew 942: =pod
1.36 matthew 943:
1.648 raeburn 944: =item * &linked_select_forms(...)
1.36 matthew 945:
946: linked_select_forms returns a string containing a <script></script> block
947: and html for two <select> menus. The select menus will be linked in that
948: changing the value of the first menu will result in new values being placed
949: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 950: order unless a defined order is provided.
1.36 matthew 951:
952: linked_select_forms takes the following ordered inputs:
953:
954: =over 4
955:
1.112 bowersj2 956: =item * $formname, the name of the <form> tag
1.36 matthew 957:
1.112 bowersj2 958: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 959:
1.112 bowersj2 960: =item * $firstdefault, the default value for the first menu
1.36 matthew 961:
1.112 bowersj2 962: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 963:
1.112 bowersj2 964: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 965:
1.112 bowersj2 966: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 967:
1.609 raeburn 968: =item * $menuorder, the order of values in the first menu
969:
1.41 ng 970: =back
971:
1.36 matthew 972: Below is an example of such a hash. Only the 'text', 'default', and
973: 'select2' keys must appear as stated. keys(%menu) are the possible
974: values for the first select menu. The text that coincides with the
1.41 ng 975: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 976: and text for the second menu are given in the hash pointed to by
977: $menu{$choice1}->{'select2'}.
978:
1.112 bowersj2 979: my %menu = ( A1 => { text =>"Choice A1" ,
980: default => "B3",
981: select2 => {
982: B1 => "Choice B1",
983: B2 => "Choice B2",
984: B3 => "Choice B3",
985: B4 => "Choice B4"
1.609 raeburn 986: },
987: order => ['B4','B3','B1','B2'],
1.112 bowersj2 988: },
989: A2 => { text =>"Choice A2" ,
990: default => "C2",
991: select2 => {
992: C1 => "Choice C1",
993: C2 => "Choice C2",
994: C3 => "Choice C3"
1.609 raeburn 995: },
996: order => ['C2','C1','C3'],
1.112 bowersj2 997: },
998: A3 => { text =>"Choice A3" ,
999: default => "D6",
1000: select2 => {
1001: D1 => "Choice D1",
1002: D2 => "Choice D2",
1003: D3 => "Choice D3",
1004: D4 => "Choice D4",
1005: D5 => "Choice D5",
1006: D6 => "Choice D6",
1007: D7 => "Choice D7"
1.609 raeburn 1008: },
1009: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 1010: }
1011: );
1.36 matthew 1012:
1013: =cut
1014:
1015: sub linked_select_forms {
1016: my ($formname,
1017: $middletext,
1018: $firstdefault,
1019: $firstselectname,
1020: $secondselectname,
1.609 raeburn 1021: $hashref,
1022: $menuorder,
1.36 matthew 1023: ) = @_;
1024: my $second = "document.$formname.$secondselectname";
1025: my $first = "document.$formname.$firstselectname";
1026: # output the javascript to do the changing
1027: my $result = '';
1.776 bisitz 1028: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 1029: $result.="// <![CDATA[\n";
1.36 matthew 1030: $result.="var select2data = new Object();\n";
1031: $" = '","';
1032: my $debug = '';
1033: foreach my $s1 (sort(keys(%$hashref))) {
1034: $result.="select2data.d_$s1 = new Object();\n";
1035: $result.="select2data.d_$s1.def = new String('".
1036: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 1037: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 1038: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1039: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1040: @s2values = @{$hashref->{$s1}->{'order'}};
1041: }
1.36 matthew 1042: $result.="\"@s2values\");\n";
1043: $result.="select2data.d_$s1.texts = new Array(";
1044: my @s2texts;
1045: foreach my $value (@s2values) {
1046: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
1047: }
1048: $result.="\"@s2texts\");\n";
1049: }
1050: $"=' ';
1051: $result.= <<"END";
1052:
1053: function select1_changed() {
1054: // Determine new choice
1055: var newvalue = "d_" + $first.value;
1056: // update select2
1057: var values = select2data[newvalue].values;
1058: var texts = select2data[newvalue].texts;
1059: var select2def = select2data[newvalue].def;
1060: var i;
1061: // out with the old
1062: for (i = 0; i < $second.options.length; i++) {
1063: $second.options[i] = null;
1064: }
1065: // in with the nuclear
1066: for (i=0;i<values.length; i++) {
1067: $second.options[i] = new Option(values[i]);
1.143 matthew 1068: $second.options[i].value = values[i];
1.36 matthew 1069: $second.options[i].text = texts[i];
1070: if (values[i] == select2def) {
1071: $second.options[i].selected = true;
1072: }
1073: }
1074: }
1.824 bisitz 1075: // ]]>
1.36 matthew 1076: </script>
1077: END
1078: # output the initial values for the selection lists
1079: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609 raeburn 1080: my @order = sort(keys(%{$hashref}));
1081: if (ref($menuorder) eq 'ARRAY') {
1082: @order = @{$menuorder};
1083: }
1084: foreach my $value (@order) {
1.36 matthew 1085: $result.=" <option value=\"$value\" ";
1.253 albertel 1086: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1087: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1088: }
1089: $result .= "</select>\n";
1090: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1091: $result .= $middletext;
1092: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
1093: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1094:
1095: my @secondorder = sort(keys(%select2));
1096: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1097: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1098: }
1099: foreach my $value (@secondorder) {
1.36 matthew 1100: $result.=" <option value=\"$value\" ";
1.253 albertel 1101: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1102: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1103: }
1104: $result .= "</select>\n";
1105: # return $debug;
1106: return $result;
1107: } # end of sub linked_select_forms {
1108:
1.45 matthew 1109: =pod
1.44 bowersj2 1110:
1.973 raeburn 1111: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid)
1.44 bowersj2 1112:
1.112 bowersj2 1113: Returns a string corresponding to an HTML link to the given help
1114: $topic, where $topic corresponds to the name of a .tex file in
1115: /home/httpd/html/adm/help/tex, with underscores replaced by
1116: spaces.
1117:
1118: $text will optionally be linked to the same topic, allowing you to
1119: link text in addition to the graphic. If you do not want to link
1120: text, but wish to specify one of the later parameters, pass an
1121: empty string.
1122:
1123: $stayOnPage is a value that will be interpreted as a boolean. If true,
1124: the link will not open a new window. If false, the link will open
1125: a new window using Javascript. (Default is false.)
1126:
1127: $width and $height are optional numerical parameters that will
1128: override the width and height of the popped up window, which may
1.973 raeburn 1129: be useful for certain help topics with big pictures included.
1130:
1131: $imgid is the id of the img tag used for the help icon. This may be
1132: used in a javascript call to switch the image src. See
1133: lonhtmlcommon::htmlareaselectactive() for an example.
1.44 bowersj2 1134:
1135: =cut
1136:
1137: sub help_open_topic {
1.973 raeburn 1138: my ($topic, $text, $stayOnPage, $width, $height, $imgid) = @_;
1.48 bowersj2 1139: $text = "" if (not defined $text);
1.44 bowersj2 1140: $stayOnPage = 0 if (not defined $stayOnPage);
1141: $width = 350 if (not defined $width);
1142: $height = 400 if (not defined $height);
1143: my $filename = $topic;
1144: $filename =~ s/ /_/g;
1145:
1.48 bowersj2 1146: my $template = "";
1147: my $link;
1.572 banghart 1148:
1.159 www 1149: $topic=~s/\W/\_/g;
1.44 bowersj2 1150:
1.572 banghart 1151: if (!$stayOnPage) {
1.72 bowersj2 1152: $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1.572 banghart 1153: } else {
1.48 bowersj2 1154: $link = "/adm/help/${filename}.hlp";
1155: }
1156:
1157: # Add the text
1.755 neumanie 1158: if ($text ne "") {
1.763 bisitz 1159: $template.='<span class="LC_help_open_topic">'
1160: .'<a target="_top" href="'.$link.'">'
1161: .$text.'</a>';
1.48 bowersj2 1162: }
1163:
1.763 bisitz 1164: # (Always) Add the graphic
1.179 matthew 1165: my $title = &mt('Online Help');
1.667 raeburn 1166: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973 raeburn 1167: if ($imgid ne '') {
1168: $imgid = ' id="'.$imgid.'"';
1169: }
1.763 bisitz 1170: $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
1171: .'<img src="'.$helpicon.'" border="0"'
1172: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973 raeburn 1173: .' title="'.$title.'" style="vertical-align:middle;"'.$imgid
1.763 bisitz 1174: .' /></a>';
1175: if ($text ne "") {
1176: $template.='</span>';
1177: }
1.44 bowersj2 1178: return $template;
1179:
1.106 bowersj2 1180: }
1181:
1182: # This is a quicky function for Latex cheatsheet editing, since it
1183: # appears in at least four places
1184: sub helpLatexCheatsheet {
1.732 raeburn 1185: my ($topic,$text,$not_author) = @_;
1186: my $out;
1.106 bowersj2 1187: my $addOther = '';
1.732 raeburn 1188: if ($topic) {
1.763 bisitz 1189: $addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
1190: undef, undef, 600).
1191: '</span> ';
1192: }
1193: $out = '<span>' # Start cheatsheet
1194: .$addOther
1195: .'<span>'
1196: .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
1197: undef,undef,600)
1198: .'</span> <span>'
1199: .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
1200: undef,undef,600)
1201: .'</span>';
1.732 raeburn 1202: unless ($not_author) {
1.763 bisitz 1203: $out .= ' <span>'
1204: .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
1205: undef,undef,600)
1206: .'</span>';
1.732 raeburn 1207: }
1.763 bisitz 1208: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1209: return $out;
1.172 www 1210: }
1211:
1.430 albertel 1212: sub general_help {
1213: my $helptopic='Student_Intro';
1214: if ($env{'request.role'}=~/^(ca|au)/) {
1215: $helptopic='Authoring_Intro';
1.907 raeburn 1216: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1217: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1218: } elsif ($env{'request.role'}=~/^dc/) {
1219: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1220: }
1221: return $helptopic;
1222: }
1223:
1224: sub update_help_link {
1225: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1226: my $origurl = $ENV{'REQUEST_URI'};
1227: $origurl=~s|^/~|/priv/|;
1228: my $timestamp = time;
1229: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1230: $$datum = &escape($$datum);
1231: }
1232:
1233: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1234: my $output .= <<"ENDOUTPUT";
1235: <script type="text/javascript">
1.824 bisitz 1236: // <![CDATA[
1.430 albertel 1237: banner_link = '$banner_link';
1.824 bisitz 1238: // ]]>
1.430 albertel 1239: </script>
1240: ENDOUTPUT
1241: return $output;
1242: }
1243:
1244: # now just updates the help link and generates a blue icon
1.193 raeburn 1245: sub help_open_menu {
1.430 albertel 1246: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1247: = @_;
1.949 droeschl 1248: $stayOnPage = 1;
1.430 albertel 1249: my $output;
1250: if ($component_help) {
1251: if (!$text) {
1252: $output=&help_open_topic($component_help,undef,$stayOnPage,
1253: $width,$height);
1254: } else {
1255: my $help_text;
1256: $help_text=&unescape($topic);
1257: $output='<table><tr><td>'.
1258: &help_open_topic($component_help,$help_text,$stayOnPage,
1259: $width,$height).'</td></tr></table>';
1260: }
1261: }
1262: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1263: return $output.$banner_link;
1264: }
1265:
1266: sub top_nav_help {
1267: my ($text) = @_;
1.436 albertel 1268: $text = &mt($text);
1.949 droeschl 1269: my $stay_on_page = 1;
1270:
1.572 banghart 1271: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1272: : "javascript:helpMenu('open')";
1.572 banghart 1273: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1274:
1.201 raeburn 1275: my $title = &mt('Get help');
1.436 albertel 1276:
1277: return <<"END";
1278: $banner_link
1279: <a href="$link" title="$title">$text</a>
1280: END
1281: }
1282:
1283: sub help_menu_js {
1284: my ($text) = @_;
1.949 droeschl 1285: my $stayOnPage = 1;
1.436 albertel 1286: my $width = 620;
1287: my $height = 600;
1.430 albertel 1288: my $helptopic=&general_help();
1289: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1290: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1291: my $start_page =
1292: &Apache::loncommon::start_page('Help Menu', undef,
1293: {'frameset' => 1,
1294: 'js_ready' => 1,
1295: 'add_entries' => {
1296: 'border' => '0',
1.579 raeburn 1297: 'rows' => "110,*",},});
1.331 albertel 1298: my $end_page =
1299: &Apache::loncommon::end_page({'frameset' => 1,
1300: 'js_ready' => 1,});
1301:
1.436 albertel 1302: my $template .= <<"ENDTEMPLATE";
1303: <script type="text/javascript">
1.877 bisitz 1304: // <![CDATA[
1.253 albertel 1305: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1306: var banner_link = '';
1.243 raeburn 1307: function helpMenu(target) {
1308: var caller = this;
1309: if (target == 'open') {
1310: var newWindow = null;
1311: try {
1.262 albertel 1312: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1313: }
1314: catch(error) {
1315: writeHelp(caller);
1316: return;
1317: }
1318: if (newWindow) {
1319: caller = newWindow;
1320: }
1.193 raeburn 1321: }
1.243 raeburn 1322: writeHelp(caller);
1323: return;
1324: }
1325: function writeHelp(caller) {
1.430 albertel 1326: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243 raeburn 1327: caller.document.close()
1328: caller.focus()
1.193 raeburn 1329: }
1.877 bisitz 1330: // END LON-CAPA Internal -->
1.253 albertel 1331: // ]]>
1.436 albertel 1332: </script>
1.193 raeburn 1333: ENDTEMPLATE
1334: return $template;
1335: }
1336:
1.172 www 1337: sub help_open_bug {
1338: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1339: unless ($env{'user.adv'}) { return ''; }
1.172 www 1340: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1341: $text = "" if (not defined $text);
1342: $stayOnPage=1;
1.184 albertel 1343: $width = 600 if (not defined $width);
1344: $height = 600 if (not defined $height);
1.172 www 1345:
1346: $topic=~s/\W+/\+/g;
1347: my $link='';
1348: my $template='';
1.379 albertel 1349: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1350: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1351: if (!$stayOnPage)
1352: {
1353: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1354: }
1355: else
1356: {
1357: $link = $url;
1358: }
1359: # Add the text
1360: if ($text ne "")
1361: {
1362: $template .=
1363: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1364: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1365: }
1366:
1367: # Add the graphic
1.179 matthew 1368: my $title = &mt('Report a Bug');
1.215 albertel 1369: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1370: $template .= <<"ENDTEMPLATE";
1.436 albertel 1371: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1372: ENDTEMPLATE
1373: if ($text ne '') { $template.='</td></tr></table>' };
1374: return $template;
1375:
1376: }
1377:
1378: sub help_open_faq {
1379: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1380: unless ($env{'user.adv'}) { return ''; }
1.172 www 1381: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1382: $text = "" if (not defined $text);
1383: $stayOnPage=1;
1384: $width = 350 if (not defined $width);
1385: $height = 400 if (not defined $height);
1386:
1387: $topic=~s/\W+/\+/g;
1388: my $link='';
1389: my $template='';
1390: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1391: if (!$stayOnPage)
1392: {
1393: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1394: }
1395: else
1396: {
1397: $link = $url;
1398: }
1399:
1400: # Add the text
1401: if ($text ne "")
1402: {
1403: $template .=
1.173 www 1404: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1405: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1406: }
1407:
1408: # Add the graphic
1.179 matthew 1409: my $title = &mt('View the FAQ');
1.215 albertel 1410: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1411: $template .= <<"ENDTEMPLATE";
1.436 albertel 1412: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1413: ENDTEMPLATE
1414: if ($text ne '') { $template.='</td></tr></table>' };
1415: return $template;
1416:
1.44 bowersj2 1417: }
1.37 matthew 1418:
1.180 matthew 1419: ###############################################################
1420: ###############################################################
1421:
1.45 matthew 1422: =pod
1423:
1.648 raeburn 1424: =item * &change_content_javascript():
1.256 matthew 1425:
1426: This and the next function allow you to create small sections of an
1427: otherwise static HTML page that you can update on the fly with
1428: Javascript, even in Netscape 4.
1429:
1430: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1431: must be written to the HTML page once. It will prove the Javascript
1432: function "change(name, content)". Calling the change function with the
1433: name of the section
1434: you want to update, matching the name passed to C<changable_area>, and
1435: the new content you want to put in there, will put the content into
1436: that area.
1437:
1438: B<Note>: Netscape 4 only reserves enough space for the changable area
1439: to contain room for the original contents. You need to "make space"
1440: for whatever changes you wish to make, and be B<sure> to check your
1441: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1442: it's adequate for updating a one-line status display, but little more.
1443: This script will set the space to 100% width, so you only need to
1444: worry about height in Netscape 4.
1445:
1446: Modern browsers are much less limiting, and if you can commit to the
1447: user not using Netscape 4, this feature may be used freely with
1448: pretty much any HTML.
1449:
1450: =cut
1451:
1452: sub change_content_javascript {
1453: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1454: if ($env{'browser.type'} eq 'netscape' &&
1455: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1456: return (<<NETSCAPE4);
1457: function change(name, content) {
1458: doc = document.layers[name+"___escape"].layers[0].document;
1459: doc.open();
1460: doc.write(content);
1461: doc.close();
1462: }
1463: NETSCAPE4
1464: } else {
1465: # Otherwise, we need to use semi-standards-compliant code
1466: # (technically, "innerHTML" isn't standard but the equivalent
1467: # is really scary, and every useful browser supports it
1468: return (<<DOMBASED);
1469: function change(name, content) {
1470: element = document.getElementById(name);
1471: element.innerHTML = content;
1472: }
1473: DOMBASED
1474: }
1475: }
1476:
1477: =pod
1478:
1.648 raeburn 1479: =item * &changable_area($name,$origContent):
1.256 matthew 1480:
1481: This provides a "changable area" that can be modified on the fly via
1482: the Javascript code provided in C<change_content_javascript>. $name is
1483: the name you will use to reference the area later; do not repeat the
1484: same name on a given HTML page more then once. $origContent is what
1485: the area will originally contain, which can be left blank.
1486:
1487: =cut
1488:
1489: sub changable_area {
1490: my ($name, $origContent) = @_;
1491:
1.258 albertel 1492: if ($env{'browser.type'} eq 'netscape' &&
1493: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1494: # If this is netscape 4, we need to use the Layer tag
1495: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1496: } else {
1497: return "<span id='$name'>$origContent</span>";
1498: }
1499: }
1500:
1501: =pod
1502:
1.648 raeburn 1503: =item * &viewport_geometry_js
1.590 raeburn 1504:
1505: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1506:
1507: =cut
1508:
1509:
1510: sub viewport_geometry_js {
1511: return <<"GEOMETRY";
1512: var Geometry = {};
1513: function init_geometry() {
1514: if (Geometry.init) { return };
1515: Geometry.init=1;
1516: if (window.innerHeight) {
1517: Geometry.getViewportHeight = function() { return window.innerHeight; };
1518: Geometry.getViewportWidth = function() { return window.innerWidth; };
1519: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1520: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1521: }
1522: else if (document.documentElement && document.documentElement.clientHeight) {
1523: Geometry.getViewportHeight =
1524: function() { return document.documentElement.clientHeight; };
1525: Geometry.getViewportWidth =
1526: function() { return document.documentElement.clientWidth; };
1527:
1528: Geometry.getHorizontalScroll =
1529: function() { return document.documentElement.scrollLeft; };
1530: Geometry.getVerticalScroll =
1531: function() { return document.documentElement.scrollTop; };
1532: }
1533: else if (document.body.clientHeight) {
1534: Geometry.getViewportHeight =
1535: function() { return document.body.clientHeight; };
1536: Geometry.getViewportWidth =
1537: function() { return document.body.clientWidth; };
1538: Geometry.getHorizontalScroll =
1539: function() { return document.body.scrollLeft; };
1540: Geometry.getVerticalScroll =
1541: function() { return document.body.scrollTop; };
1542: }
1543: }
1544:
1545: GEOMETRY
1546: }
1547:
1548: =pod
1549:
1.648 raeburn 1550: =item * &viewport_size_js()
1.590 raeburn 1551:
1552: Provides a javascript function to set values of two form elements - width and height (elements are passed in as arguments to the javascript function) to the dimensions of the user's browser window.
1553:
1554: =cut
1555:
1556: sub viewport_size_js {
1557: my $geometry = &viewport_geometry_js();
1558: return <<"DIMS";
1559:
1560: $geometry
1561:
1562: function getViewportDims(width,height) {
1563: init_geometry();
1564: width.value = Geometry.getViewportWidth();
1565: height.value = Geometry.getViewportHeight();
1566: return;
1567: }
1568:
1569: DIMS
1570: }
1571:
1572: =pod
1573:
1.648 raeburn 1574: =item * &resize_textarea_js()
1.565 albertel 1575:
1576: emits the needed javascript to resize a textarea to be as big as possible
1577:
1578: creates a function resize_textrea that takes two IDs first should be
1579: the id of the element to resize, second should be the id of a div that
1580: surrounds everything that comes after the textarea, this routine needs
1581: to be attached to the <body> for the onload and onresize events.
1582:
1.648 raeburn 1583: =back
1.565 albertel 1584:
1585: =cut
1586:
1587: sub resize_textarea_js {
1.590 raeburn 1588: my $geometry = &viewport_geometry_js();
1.565 albertel 1589: return <<"RESIZE";
1590: <script type="text/javascript">
1.824 bisitz 1591: // <![CDATA[
1.590 raeburn 1592: $geometry
1.565 albertel 1593:
1.588 albertel 1594: function getX(element) {
1595: var x = 0;
1596: while (element) {
1597: x += element.offsetLeft;
1598: element = element.offsetParent;
1599: }
1600: return x;
1601: }
1602: function getY(element) {
1603: var y = 0;
1604: while (element) {
1605: y += element.offsetTop;
1606: element = element.offsetParent;
1607: }
1608: return y;
1609: }
1610:
1611:
1.565 albertel 1612: function resize_textarea(textarea_id,bottom_id) {
1613: init_geometry();
1614: var textarea = document.getElementById(textarea_id);
1615: //alert(textarea);
1616:
1.588 albertel 1617: var textarea_top = getY(textarea);
1.565 albertel 1618: var textarea_height = textarea.offsetHeight;
1619: var bottom = document.getElementById(bottom_id);
1.588 albertel 1620: var bottom_top = getY(bottom);
1.565 albertel 1621: var bottom_height = bottom.offsetHeight;
1622: var window_height = Geometry.getViewportHeight();
1.588 albertel 1623: var fudge = 23;
1.565 albertel 1624: var new_height = window_height-fudge-textarea_top-bottom_height;
1625: if (new_height < 300) {
1626: new_height = 300;
1627: }
1628: textarea.style.height=new_height+'px';
1629: }
1.824 bisitz 1630: // ]]>
1.565 albertel 1631: </script>
1632: RESIZE
1633:
1634: }
1635:
1636: =pod
1637:
1.256 matthew 1638: =head1 Excel and CSV file utility routines
1639:
1640: =over 4
1641:
1642: =cut
1643:
1644: ###############################################################
1645: ###############################################################
1646:
1647: =pod
1648:
1.648 raeburn 1649: =item * &csv_translate($text)
1.37 matthew 1650:
1.185 www 1651: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1652: format.
1653:
1654: =cut
1655:
1.180 matthew 1656: ###############################################################
1657: ###############################################################
1.37 matthew 1658: sub csv_translate {
1659: my $text = shift;
1660: $text =~ s/\"/\"\"/g;
1.209 albertel 1661: $text =~ s/\n/ /g;
1.37 matthew 1662: return $text;
1663: }
1.180 matthew 1664:
1665: ###############################################################
1666: ###############################################################
1667:
1668: =pod
1669:
1.648 raeburn 1670: =item * &define_excel_formats()
1.180 matthew 1671:
1672: Define some commonly used Excel cell formats.
1673:
1674: Currently supported formats:
1675:
1676: =over 4
1677:
1678: =item header
1679:
1680: =item bold
1681:
1682: =item h1
1683:
1684: =item h2
1685:
1686: =item h3
1687:
1.256 matthew 1688: =item h4
1689:
1690: =item i
1691:
1.180 matthew 1692: =item date
1693:
1694: =back
1695:
1696: Inputs: $workbook
1697:
1698: Returns: $format, a hash reference.
1699:
1700: =cut
1701:
1702: ###############################################################
1703: ###############################################################
1704: sub define_excel_formats {
1705: my ($workbook) = @_;
1706: my $format;
1707: $format->{'header'} = $workbook->add_format(bold => 1,
1708: bottom => 1,
1709: align => 'center');
1710: $format->{'bold'} = $workbook->add_format(bold=>1);
1711: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1712: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1713: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1714: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1715: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1716: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1717: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1718: return $format;
1719: }
1720:
1721: ###############################################################
1722: ###############################################################
1.113 bowersj2 1723:
1724: =pod
1725:
1.648 raeburn 1726: =item * &create_workbook()
1.255 matthew 1727:
1728: Create an Excel worksheet. If it fails, output message on the
1729: request object and return undefs.
1730:
1731: Inputs: Apache request object
1732:
1733: Returns (undef) on failure,
1734: Excel worksheet object, scalar with filename, and formats
1735: from &Apache::loncommon::define_excel_formats on success
1736:
1737: =cut
1738:
1739: ###############################################################
1740: ###############################################################
1741: sub create_workbook {
1742: my ($r) = @_;
1743: #
1744: # Create the excel spreadsheet
1745: my $filename = '/prtspool/'.
1.258 albertel 1746: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1747: time.'_'.rand(1000000000).'.xls';
1748: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1749: if (! defined($workbook)) {
1750: $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928 bisitz 1751: $r->print(
1752: '<p class="LC_error">'
1753: .&mt('Problems occurred in creating the new Excel file.')
1754: .' '.&mt('This error has been logged.')
1755: .' '.&mt('Please alert your LON-CAPA administrator.')
1756: .'</p>'
1757: );
1.255 matthew 1758: return (undef);
1759: }
1760: #
1761: $workbook->set_tempdir('/home/httpd/perl/tmp');
1762: #
1763: my $format = &Apache::loncommon::define_excel_formats($workbook);
1764: return ($workbook,$filename,$format);
1765: }
1766:
1767: ###############################################################
1768: ###############################################################
1769:
1770: =pod
1771:
1.648 raeburn 1772: =item * &create_text_file()
1.113 bowersj2 1773:
1.542 raeburn 1774: Create a file to write to and eventually make available to the user.
1.256 matthew 1775: If file creation fails, outputs an error message on the request object and
1776: return undefs.
1.113 bowersj2 1777:
1.256 matthew 1778: Inputs: Apache request object, and file suffix
1.113 bowersj2 1779:
1.256 matthew 1780: Returns (undef) on failure,
1781: Filehandle and filename on success.
1.113 bowersj2 1782:
1783: =cut
1784:
1.256 matthew 1785: ###############################################################
1786: ###############################################################
1787: sub create_text_file {
1788: my ($r,$suffix) = @_;
1789: if (! defined($suffix)) { $suffix = 'txt'; };
1790: my $fh;
1791: my $filename = '/prtspool/'.
1.258 albertel 1792: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1793: time.'_'.rand(1000000000).'.'.$suffix;
1794: $fh = Apache::File->new('>/home/httpd'.$filename);
1795: if (! defined($fh)) {
1796: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 1797: $r->print(
1798: '<p class="LC_error">'
1799: .&mt('Problems occurred in creating the output file.')
1800: .' '.&mt('This error has been logged.')
1801: .' '.&mt('Please alert your LON-CAPA administrator.')
1802: .'</p>'
1803: );
1.113 bowersj2 1804: }
1.256 matthew 1805: return ($fh,$filename)
1.113 bowersj2 1806: }
1807:
1808:
1.256 matthew 1809: =pod
1.113 bowersj2 1810:
1811: =back
1812:
1813: =cut
1.37 matthew 1814:
1815: ###############################################################
1.33 matthew 1816: ## Home server <option> list generating code ##
1817: ###############################################################
1.35 matthew 1818:
1.169 www 1819: # ------------------------------------------
1820:
1821: sub domain_select {
1822: my ($name,$value,$multiple)=@_;
1823: my %domains=map {
1.514 albertel 1824: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1825: } &Apache::lonnet::all_domains();
1.169 www 1826: if ($multiple) {
1827: $domains{''}=&mt('Any domain');
1.550 albertel 1828: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1829: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1830: } else {
1.550 albertel 1831: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970 raeburn 1832: return &select_form($name,$value,\%domains);
1.169 www 1833: }
1834: }
1835:
1.282 albertel 1836: #-------------------------------------------
1837:
1838: =pod
1839:
1.519 raeburn 1840: =head1 Routines for form select boxes
1841:
1842: =over 4
1843:
1.648 raeburn 1844: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1845:
1846: Returns a string containing a <select> element int multiple mode
1847:
1848:
1849: Args:
1850: $name - name of the <select> element
1.506 raeburn 1851: $value - scalar or array ref of values that should already be selected
1.282 albertel 1852: $size - number of rows long the select element is
1.283 albertel 1853: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1854: (shown text should already have been &mt())
1.506 raeburn 1855: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1856:
1.282 albertel 1857: =cut
1858:
1859: #-------------------------------------------
1.169 www 1860: sub multiple_select_form {
1.284 albertel 1861: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1862: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1863: my $output='';
1.191 matthew 1864: if (! defined($size)) {
1865: $size = 4;
1.283 albertel 1866: if (scalar(keys(%$hash))<4) {
1867: $size = scalar(keys(%$hash));
1.191 matthew 1868: }
1869: }
1.734 bisitz 1870: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1871: my @order;
1.506 raeburn 1872: if (ref($order) eq 'ARRAY') {
1873: @order = @{$order};
1874: } else {
1875: @order = sort(keys(%$hash));
1.501 banghart 1876: }
1877: if (exists($$hash{'select_form_order'})) {
1878: @order = @{$$hash{'select_form_order'}};
1879: }
1880:
1.284 albertel 1881: foreach my $key (@order) {
1.356 albertel 1882: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1883: $output.='selected="selected" ' if ($selected{$key});
1884: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1885: }
1886: $output.="</select>\n";
1887: return $output;
1888: }
1889:
1.88 www 1890: #-------------------------------------------
1891:
1892: =pod
1893:
1.970 raeburn 1894: =item * &select_form($defdom,$name,$hashref,$onchange)
1.88 www 1895:
1896: Returns a string containing a <select name='$name' size='1'> form to
1.970 raeburn 1897: allow a user to select options from a ref to a hash containing:
1898: option_name => displayed text. An optional $onchange can include
1899: a javascript onchange item, e.g., onchange="this.form.submit();"
1900:
1.88 www 1901: See lonrights.pm for an example invocation and use.
1902:
1903: =cut
1904:
1905: #-------------------------------------------
1906: sub select_form {
1.970 raeburn 1907: my ($def,$name,$hashref,$onchange) = @_;
1908: return unless (ref($hashref) eq 'HASH');
1909: if ($onchange) {
1910: $onchange = ' onchange="'.$onchange.'"';
1911: }
1912: my $selectform = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.128 albertel 1913: my @keys;
1.970 raeburn 1914: if (exists($hashref->{'select_form_order'})) {
1915: @keys=@{$hashref->{'select_form_order'}};
1.128 albertel 1916: } else {
1.970 raeburn 1917: @keys=sort(keys(%{$hashref}));
1.128 albertel 1918: }
1.356 albertel 1919: foreach my $key (@keys) {
1920: $selectform.=
1921: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1922: ($key eq $def ? 'selected="selected" ' : '').
1.970 raeburn 1923: ">".$hashref->{$key}."</option>\n";
1.88 www 1924: }
1925: $selectform.="</select>";
1926: return $selectform;
1927: }
1928:
1.475 www 1929: # For display filters
1930:
1931: sub display_filter {
1932: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1933: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714 bisitz 1934: return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475 www 1935: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1936: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 1937: '</label></span> <span class="LC_nobreak">'.
1.475 www 1938: &mt('Filter [_1]',
1.477 www 1939: &select_form($env{'form.displayfilter'},
1940: 'displayfilter',
1.970 raeburn 1941: {'currentfolder' => 'Current folder/page',
1.477 www 1942: 'containing' => 'Containing phrase',
1.970 raeburn 1943: 'none' => 'None'})).
1.714 bisitz 1944: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475 www 1945: }
1946:
1.167 www 1947: sub gradeleveldescription {
1948: my $gradelevel=shift;
1949: my %gradelevels=(0 => 'Not specified',
1950: 1 => 'Grade 1',
1951: 2 => 'Grade 2',
1952: 3 => 'Grade 3',
1953: 4 => 'Grade 4',
1954: 5 => 'Grade 5',
1955: 6 => 'Grade 6',
1956: 7 => 'Grade 7',
1957: 8 => 'Grade 8',
1958: 9 => 'Grade 9',
1959: 10 => 'Grade 10',
1960: 11 => 'Grade 11',
1961: 12 => 'Grade 12',
1962: 13 => 'Grade 13',
1963: 14 => '100 Level',
1964: 15 => '200 Level',
1965: 16 => '300 Level',
1966: 17 => '400 Level',
1967: 18 => 'Graduate Level');
1968: return &mt($gradelevels{$gradelevel});
1969: }
1970:
1.163 www 1971: sub select_level_form {
1972: my ($deflevel,$name)=@_;
1973: unless ($deflevel) { $deflevel=0; }
1.167 www 1974: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1975: for (my $i=0; $i<=18; $i++) {
1976: $selectform.="<option value=\"$i\" ".
1.253 albertel 1977: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1978: ">".&gradeleveldescription($i)."</option>\n";
1979: }
1980: $selectform.="</select>";
1981: return $selectform;
1.163 www 1982: }
1.167 www 1983:
1.35 matthew 1984: #-------------------------------------------
1985:
1.45 matthew 1986: =pod
1987:
1.910 raeburn 1988: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35 matthew 1989:
1990: Returns a string containing a <select name='$name' size='1'> form to
1991: allow a user to select the domain to preform an operation in.
1992: See loncreateuser.pm for an example invocation and use.
1993:
1.90 www 1994: If the $includeempty flag is set, it also includes an empty choice ("no domain
1995: selected");
1996:
1.743 raeburn 1997: If the $showdomdesc flag is set, the domain name is followed by the domain description.
1998:
1.910 raeburn 1999: The optional $onchange argument specifies what should occur if the domain selector is changed, e.g., 'this.form.submit()' if the form is to be automatically submitted.
2000:
2001: The optional $incdoms is a reference to an array of domains which will be the only available options.
1.563 raeburn 2002:
1.35 matthew 2003: =cut
2004:
2005: #-------------------------------------------
1.34 matthew 2006: sub select_dom_form {
1.910 raeburn 2007: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.872 raeburn 2008: if ($onchange) {
1.874 raeburn 2009: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 2010: }
1.910 raeburn 2011: my @domains;
2012: if (ref($incdoms) eq 'ARRAY') {
2013: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
2014: } else {
2015: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
2016: }
1.90 www 2017: if ($includeempty) { @domains=('',@domains); }
1.743 raeburn 2018: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 2019: foreach my $dom (@domains) {
2020: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 2021: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
2022: if ($showdomdesc) {
2023: if ($dom ne '') {
2024: my $domdesc = &Apache::lonnet::domain($dom,'description');
2025: if ($domdesc ne '') {
2026: $selectdomain .= ' ('.$domdesc.')';
2027: }
2028: }
2029: }
2030: $selectdomain .= "</option>\n";
1.34 matthew 2031: }
2032: $selectdomain.="</select>";
2033: return $selectdomain;
2034: }
2035:
1.35 matthew 2036: #-------------------------------------------
2037:
1.45 matthew 2038: =pod
2039:
1.648 raeburn 2040: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 2041:
1.586 raeburn 2042: input: 4 arguments (two required, two optional) -
2043: $domain - domain of new user
2044: $name - name of form element
2045: $default - Value of 'default' causes a default item to be first
2046: option, and selected by default.
2047: $hide - Value of 'hide' causes hiding of the name of the server,
2048: if 1 server found, or default, if 0 found.
1.594 raeburn 2049: output: returns 2 items:
1.586 raeburn 2050: (a) form element which contains either:
2051: (i) <select name="$name">
2052: <option value="$hostid1">$hostid $servers{$hostid}</option>
2053: <option value="$hostid2">$hostid $servers{$hostid}</option>
2054: </select>
2055: form item if there are multiple library servers in $domain, or
2056: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2057: if there is only one library server in $domain.
2058:
2059: (b) number of library servers found.
2060:
2061: See loncreateuser.pm for example of use.
1.35 matthew 2062:
2063: =cut
2064:
2065: #-------------------------------------------
1.586 raeburn 2066: sub home_server_form_item {
2067: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2068: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2069: my $result;
2070: my $numlib = keys(%servers);
2071: if ($numlib > 1) {
2072: $result .= '<select name="'.$name.'" />'."\n";
2073: if ($default) {
1.804 bisitz 2074: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 2075: '</option>'."\n";
2076: }
2077: foreach my $hostid (sort(keys(%servers))) {
2078: $result.= '<option value="'.$hostid.'">'.
2079: $hostid.' '.$servers{$hostid}."</option>\n";
2080: }
2081: $result .= '</select>'."\n";
2082: } elsif ($numlib == 1) {
2083: my $hostid;
2084: foreach my $item (keys(%servers)) {
2085: $hostid = $item;
2086: }
2087: $result .= '<input type="hidden" name="'.$name.'" value="'.
2088: $hostid.'" />';
2089: if (!$hide) {
2090: $result .= $hostid.' '.$servers{$hostid};
2091: }
2092: $result .= "\n";
2093: } elsif ($default) {
2094: $result .= '<input type="hidden" name="'.$name.
2095: '" value="default" />';
2096: if (!$hide) {
2097: $result .= &mt('default');
2098: }
2099: $result .= "\n";
1.33 matthew 2100: }
1.586 raeburn 2101: return ($result,$numlib);
1.33 matthew 2102: }
1.112 bowersj2 2103:
2104: =pod
2105:
1.534 albertel 2106: =back
2107:
1.112 bowersj2 2108: =cut
1.87 matthew 2109:
2110: ###############################################################
1.112 bowersj2 2111: ## Decoding User Agent ##
1.87 matthew 2112: ###############################################################
2113:
2114: =pod
2115:
1.112 bowersj2 2116: =head1 Decoding the User Agent
2117:
2118: =over 4
2119:
2120: =item * &decode_user_agent()
1.87 matthew 2121:
2122: Inputs: $r
2123:
2124: Outputs:
2125:
2126: =over 4
2127:
1.112 bowersj2 2128: =item * $httpbrowser
1.87 matthew 2129:
1.112 bowersj2 2130: =item * $clientbrowser
1.87 matthew 2131:
1.112 bowersj2 2132: =item * $clientversion
1.87 matthew 2133:
1.112 bowersj2 2134: =item * $clientmathml
1.87 matthew 2135:
1.112 bowersj2 2136: =item * $clientunicode
1.87 matthew 2137:
1.112 bowersj2 2138: =item * $clientos
1.87 matthew 2139:
2140: =back
2141:
1.157 matthew 2142: =back
2143:
1.87 matthew 2144: =cut
2145:
2146: ###############################################################
2147: ###############################################################
2148: sub decode_user_agent {
1.247 albertel 2149: my ($r)=@_;
1.87 matthew 2150: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2151: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2152: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2153: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2154: my $clientbrowser='unknown';
2155: my $clientversion='0';
2156: my $clientmathml='';
2157: my $clientunicode='0';
2158: for (my $i=0;$i<=$#browsertype;$i++) {
2159: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
2160: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2161: $clientbrowser=$bname;
2162: $httpbrowser=~/$vreg/i;
2163: $clientversion=$1;
2164: $clientmathml=($clientversion>=$minv);
2165: $clientunicode=($clientversion>=$univ);
2166: }
2167: }
2168: my $clientos='unknown';
2169: if (($httpbrowser=~/linux/i) ||
2170: ($httpbrowser=~/unix/i) ||
2171: ($httpbrowser=~/ux/i) ||
2172: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2173: if (($httpbrowser=~/vax/i) ||
2174: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2175: if ($httpbrowser=~/next/i) { $clientos='next'; }
2176: if (($httpbrowser=~/mac/i) ||
2177: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
2178: if ($httpbrowser=~/win/i) { $clientos='win'; }
2179: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
2180: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
2181: $clientunicode,$clientos,);
2182: }
2183:
1.32 matthew 2184: ###############################################################
2185: ## Authentication changing form generation subroutines ##
2186: ###############################################################
2187: ##
2188: ## All of the authform_xxxxxxx subroutines take their inputs in a
2189: ## hash, and have reasonable default values.
2190: ##
2191: ## formname = the name given in the <form> tag.
1.35 matthew 2192: #-------------------------------------------
2193:
1.45 matthew 2194: =pod
2195:
1.112 bowersj2 2196: =head1 Authentication Routines
2197:
2198: =over 4
2199:
1.648 raeburn 2200: =item * &authform_xxxxxx()
1.35 matthew 2201:
2202: The authform_xxxxxx subroutines provide javascript and html forms which
2203: handle some of the conveniences required for authentication forms.
2204: This is not an optimal method, but it works.
2205:
2206: =over 4
2207:
1.112 bowersj2 2208: =item * authform_header
1.35 matthew 2209:
1.112 bowersj2 2210: =item * authform_authorwarning
1.35 matthew 2211:
1.112 bowersj2 2212: =item * authform_nochange
1.35 matthew 2213:
1.112 bowersj2 2214: =item * authform_kerberos
1.35 matthew 2215:
1.112 bowersj2 2216: =item * authform_internal
1.35 matthew 2217:
1.112 bowersj2 2218: =item * authform_filesystem
1.35 matthew 2219:
2220: =back
2221:
1.648 raeburn 2222: See loncreateuser.pm for invocation and use examples.
1.157 matthew 2223:
1.35 matthew 2224: =cut
2225:
2226: #-------------------------------------------
1.32 matthew 2227: sub authform_header{
2228: my %in = (
2229: formname => 'cu',
1.80 albertel 2230: kerb_def_dom => '',
1.32 matthew 2231: @_,
2232: );
2233: $in{'formname'} = 'document.' . $in{'formname'};
2234: my $result='';
1.80 albertel 2235:
2236: #---------------------------------------------- Code for upper case translation
2237: my $Javascript_toUpperCase;
2238: unless ($in{kerb_def_dom}) {
2239: $Javascript_toUpperCase =<<"END";
2240: switch (choice) {
2241: case 'krb': currentform.elements[choicearg].value =
2242: currentform.elements[choicearg].value.toUpperCase();
2243: break;
2244: default:
2245: }
2246: END
2247: } else {
2248: $Javascript_toUpperCase = "";
2249: }
2250:
1.165 raeburn 2251: my $radioval = "'nochange'";
1.591 raeburn 2252: if (defined($in{'curr_authtype'})) {
2253: if ($in{'curr_authtype'} ne '') {
2254: $radioval = "'".$in{'curr_authtype'}."arg'";
2255: }
1.174 matthew 2256: }
1.165 raeburn 2257: my $argfield = 'null';
1.591 raeburn 2258: if (defined($in{'mode'})) {
1.165 raeburn 2259: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2260: if (defined($in{'curr_autharg'})) {
2261: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2262: $argfield = "'$in{'curr_autharg'}'";
2263: }
2264: }
2265: }
2266: }
2267:
1.32 matthew 2268: $result.=<<"END";
2269: var current = new Object();
1.165 raeburn 2270: current.radiovalue = $radioval;
2271: current.argfield = $argfield;
1.32 matthew 2272:
2273: function changed_radio(choice,currentform) {
2274: var choicearg = choice + 'arg';
2275: // If a radio button in changed, we need to change the argfield
2276: if (current.radiovalue != choice) {
2277: current.radiovalue = choice;
2278: if (current.argfield != null) {
2279: currentform.elements[current.argfield].value = '';
2280: }
2281: if (choice == 'nochange') {
2282: current.argfield = null;
2283: } else {
2284: current.argfield = choicearg;
2285: switch(choice) {
2286: case 'krb':
2287: currentform.elements[current.argfield].value =
2288: "$in{'kerb_def_dom'}";
2289: break;
2290: default:
2291: break;
2292: }
2293: }
2294: }
2295: return;
2296: }
1.22 www 2297:
1.32 matthew 2298: function changed_text(choice,currentform) {
2299: var choicearg = choice + 'arg';
2300: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2301: $Javascript_toUpperCase
1.32 matthew 2302: // clear old field
2303: if ((current.argfield != choicearg) && (current.argfield != null)) {
2304: currentform.elements[current.argfield].value = '';
2305: }
2306: current.argfield = choicearg;
2307: }
2308: set_auth_radio_buttons(choice,currentform);
2309: return;
1.20 www 2310: }
1.32 matthew 2311:
2312: function set_auth_radio_buttons(newvalue,currentform) {
1.986 raeburn 2313: var numauthchoices = currentform.login.length;
2314: if (typeof numauthchoices == "undefined") {
2315: return;
2316: }
1.32 matthew 2317: var i=0;
1.986 raeburn 2318: while (i < numauthchoices) {
1.32 matthew 2319: if (currentform.login[i].value == newvalue) { break; }
2320: i++;
2321: }
1.986 raeburn 2322: if (i == numauthchoices) {
1.32 matthew 2323: return;
2324: }
2325: current.radiovalue = newvalue;
2326: currentform.login[i].checked = true;
2327: return;
2328: }
2329: END
2330: return $result;
2331: }
2332:
2333: sub authform_authorwarning{
2334: my $result='';
1.144 matthew 2335: $result='<i>'.
2336: &mt('As a general rule, only authors or co-authors should be '.
2337: 'filesystem authenticated '.
2338: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2339: return $result;
2340: }
2341:
2342: sub authform_nochange{
2343: my %in = (
2344: formname => 'document.cu',
2345: kerb_def_dom => 'MSU.EDU',
2346: @_,
2347: );
1.586 raeburn 2348: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2349: my $result;
2350: if (keys(%can_assign) == 0) {
2351: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2352: } else {
2353: $result = '<label>'.&mt('[_1] Do not change login data',
2354: '<input type="radio" name="login" value="nochange" '.
2355: 'checked="checked" onclick="'.
1.281 albertel 2356: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2357: '</label>';
1.586 raeburn 2358: }
1.32 matthew 2359: return $result;
2360: }
2361:
1.591 raeburn 2362: sub authform_kerberos {
1.32 matthew 2363: my %in = (
2364: formname => 'document.cu',
2365: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2366: kerb_def_auth => 'krb4',
1.32 matthew 2367: @_,
2368: );
1.586 raeburn 2369: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2370: $autharg,$jscall);
2371: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2372: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2373: $check5 = ' checked="checked"';
1.80 albertel 2374: } else {
1.772 bisitz 2375: $check4 = ' checked="checked"';
1.80 albertel 2376: }
1.165 raeburn 2377: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2378: if (defined($in{'curr_authtype'})) {
2379: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2380: $krbcheck = ' checked="checked"';
1.623 raeburn 2381: if (defined($in{'mode'})) {
2382: if ($in{'mode'} eq 'modifyuser') {
2383: $krbcheck = '';
2384: }
2385: }
1.591 raeburn 2386: if (defined($in{'curr_kerb_ver'})) {
2387: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2388: $check5 = ' checked="checked"';
1.591 raeburn 2389: $check4 = '';
2390: } else {
1.772 bisitz 2391: $check4 = ' checked="checked"';
1.591 raeburn 2392: $check5 = '';
2393: }
1.586 raeburn 2394: }
1.591 raeburn 2395: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2396: $krbarg = $in{'curr_autharg'};
2397: }
1.586 raeburn 2398: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2399: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2400: $result =
2401: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2402: $in{'curr_autharg'},$krbver);
2403: } else {
2404: $result =
2405: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2406: }
2407: return $result;
2408: }
2409: }
2410: } else {
2411: if ($authnum == 1) {
1.784 bisitz 2412: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2413: }
2414: }
1.586 raeburn 2415: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2416: return;
1.587 raeburn 2417: } elsif ($authtype eq '') {
1.591 raeburn 2418: if (defined($in{'mode'})) {
1.587 raeburn 2419: if ($in{'mode'} eq 'modifycourse') {
2420: if ($authnum == 1) {
1.784 bisitz 2421: $authtype = '<input type="hidden" name="login" value="krb" />';
1.587 raeburn 2422: }
2423: }
2424: }
1.586 raeburn 2425: }
2426: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2427: if ($authtype eq '') {
2428: $authtype = '<input type="radio" name="login" value="krb" '.
2429: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2430: $krbcheck.' />';
2431: }
2432: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2433: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2434: $in{'curr_authtype'} eq 'krb5') ||
2435: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2436: $in{'curr_authtype'} eq 'krb4')) {
2437: $result .= &mt
1.144 matthew 2438: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2439: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2440: '<label>'.$authtype,
1.281 albertel 2441: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2442: 'value="'.$krbarg.'" '.
1.144 matthew 2443: 'onchange="'.$jscall.'" />',
1.281 albertel 2444: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2445: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2446: '</label>');
1.586 raeburn 2447: } elsif ($can_assign{'krb4'}) {
2448: $result .= &mt
2449: ('[_1] Kerberos authenticated with domain [_2] '.
2450: '[_3] Version 4 [_4]',
2451: '<label>'.$authtype,
2452: '</label><input type="text" size="10" name="krbarg" '.
2453: 'value="'.$krbarg.'" '.
2454: 'onchange="'.$jscall.'" />',
2455: '<label><input type="hidden" name="krbver" value="4" />',
2456: '</label>');
2457: } elsif ($can_assign{'krb5'}) {
2458: $result .= &mt
2459: ('[_1] Kerberos authenticated with domain [_2] '.
2460: '[_3] Version 5 [_4]',
2461: '<label>'.$authtype,
2462: '</label><input type="text" size="10" name="krbarg" '.
2463: 'value="'.$krbarg.'" '.
2464: 'onchange="'.$jscall.'" />',
2465: '<label><input type="hidden" name="krbver" value="5" />',
2466: '</label>');
2467: }
1.32 matthew 2468: return $result;
2469: }
2470:
2471: sub authform_internal{
1.586 raeburn 2472: my %in = (
1.32 matthew 2473: formname => 'document.cu',
2474: kerb_def_dom => 'MSU.EDU',
2475: @_,
2476: );
1.586 raeburn 2477: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2478: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2479: if (defined($in{'curr_authtype'})) {
2480: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2481: if ($can_assign{'int'}) {
1.772 bisitz 2482: $intcheck = 'checked="checked" ';
1.623 raeburn 2483: if (defined($in{'mode'})) {
2484: if ($in{'mode'} eq 'modifyuser') {
2485: $intcheck = '';
2486: }
2487: }
1.591 raeburn 2488: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2489: $intarg = $in{'curr_autharg'};
2490: }
2491: } else {
2492: $result = &mt('Currently internally authenticated.');
2493: return $result;
1.165 raeburn 2494: }
2495: }
1.586 raeburn 2496: } else {
2497: if ($authnum == 1) {
1.784 bisitz 2498: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 2499: }
2500: }
2501: if (!$can_assign{'int'}) {
2502: return;
1.587 raeburn 2503: } elsif ($authtype eq '') {
1.591 raeburn 2504: if (defined($in{'mode'})) {
1.587 raeburn 2505: if ($in{'mode'} eq 'modifycourse') {
2506: if ($authnum == 1) {
1.784 bisitz 2507: $authtype = '<input type="hidden" name="login" value="int" />';
1.587 raeburn 2508: }
2509: }
2510: }
1.165 raeburn 2511: }
1.586 raeburn 2512: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2513: if ($authtype eq '') {
2514: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2515: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2516: }
1.605 bisitz 2517: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2518: $intarg.'" onchange="'.$jscall.'" />';
2519: $result = &mt
1.144 matthew 2520: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2521: '<label>'.$authtype,'</label>'.$autharg);
1.824 bisitz 2522: $result.="<label><input type=\"checkbox\" name=\"visible\" onclick='if (this.checked) { this.form.intarg.type=\"text\" } else { this.form.intarg.type=\"password\" }' />".&mt('Visible input').'</label>';
1.32 matthew 2523: return $result;
2524: }
2525:
2526: sub authform_local{
2527: my %in = (
2528: formname => 'document.cu',
2529: kerb_def_dom => 'MSU.EDU',
2530: @_,
2531: );
1.586 raeburn 2532: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2533: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2534: if (defined($in{'curr_authtype'})) {
2535: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2536: if ($can_assign{'loc'}) {
1.772 bisitz 2537: $loccheck = 'checked="checked" ';
1.623 raeburn 2538: if (defined($in{'mode'})) {
2539: if ($in{'mode'} eq 'modifyuser') {
2540: $loccheck = '';
2541: }
2542: }
1.591 raeburn 2543: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2544: $locarg = $in{'curr_autharg'};
2545: }
2546: } else {
2547: $result = &mt('Currently using local (institutional) authentication.');
2548: return $result;
1.165 raeburn 2549: }
2550: }
1.586 raeburn 2551: } else {
2552: if ($authnum == 1) {
1.784 bisitz 2553: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 2554: }
2555: }
2556: if (!$can_assign{'loc'}) {
2557: return;
1.587 raeburn 2558: } elsif ($authtype eq '') {
1.591 raeburn 2559: if (defined($in{'mode'})) {
1.587 raeburn 2560: if ($in{'mode'} eq 'modifycourse') {
2561: if ($authnum == 1) {
1.784 bisitz 2562: $authtype = '<input type="hidden" name="login" value="loc" />';
1.587 raeburn 2563: }
2564: }
2565: }
1.165 raeburn 2566: }
1.586 raeburn 2567: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2568: if ($authtype eq '') {
2569: $authtype = '<input type="radio" name="login" value="loc" '.
2570: $loccheck.' onchange="'.$jscall.'" onclick="'.
2571: $jscall.'" />';
2572: }
2573: $autharg = '<input type="text" size="10" name="locarg" value="'.
2574: $locarg.'" onchange="'.$jscall.'" />';
2575: $result = &mt('[_1] Local Authentication with argument [_2]',
2576: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2577: return $result;
2578: }
2579:
2580: sub authform_filesystem{
2581: my %in = (
2582: formname => 'document.cu',
2583: kerb_def_dom => 'MSU.EDU',
2584: @_,
2585: );
1.586 raeburn 2586: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2587: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2588: if (defined($in{'curr_authtype'})) {
2589: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2590: if ($can_assign{'fsys'}) {
1.772 bisitz 2591: $fsyscheck = 'checked="checked" ';
1.623 raeburn 2592: if (defined($in{'mode'})) {
2593: if ($in{'mode'} eq 'modifyuser') {
2594: $fsyscheck = '';
2595: }
2596: }
1.586 raeburn 2597: } else {
2598: $result = &mt('Currently Filesystem Authenticated.');
2599: return $result;
2600: }
2601: }
2602: } else {
2603: if ($authnum == 1) {
1.784 bisitz 2604: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 2605: }
2606: }
2607: if (!$can_assign{'fsys'}) {
2608: return;
1.587 raeburn 2609: } elsif ($authtype eq '') {
1.591 raeburn 2610: if (defined($in{'mode'})) {
1.587 raeburn 2611: if ($in{'mode'} eq 'modifycourse') {
2612: if ($authnum == 1) {
1.784 bisitz 2613: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587 raeburn 2614: }
2615: }
2616: }
1.586 raeburn 2617: }
2618: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2619: if ($authtype eq '') {
2620: $authtype = '<input type="radio" name="login" value="fsys" '.
2621: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2622: $jscall.'" />';
2623: }
2624: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2625: ' onchange="'.$jscall.'" />';
2626: $result = &mt
1.144 matthew 2627: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2628: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2629: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2630: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2631: 'onchange="'.$jscall.'" />');
1.32 matthew 2632: return $result;
2633: }
2634:
1.586 raeburn 2635: sub get_assignable_auth {
2636: my ($dom) = @_;
2637: if ($dom eq '') {
2638: $dom = $env{'request.role.domain'};
2639: }
2640: my %can_assign = (
2641: krb4 => 1,
2642: krb5 => 1,
2643: int => 1,
2644: loc => 1,
2645: );
2646: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2647: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2648: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2649: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2650: my $context;
2651: if ($env{'request.role'} =~ /^au/) {
2652: $context = 'author';
2653: } elsif ($env{'request.role'} =~ /^dc/) {
2654: $context = 'domain';
2655: } elsif ($env{'request.course.id'}) {
2656: $context = 'course';
2657: }
2658: if ($context) {
2659: if (ref($authhash->{$context}) eq 'HASH') {
2660: %can_assign = %{$authhash->{$context}};
2661: }
2662: }
2663: }
2664: }
2665: my $authnum = 0;
2666: foreach my $key (keys(%can_assign)) {
2667: if ($can_assign{$key}) {
2668: $authnum ++;
2669: }
2670: }
2671: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2672: $authnum --;
2673: }
2674: return ($authnum,%can_assign);
2675: }
2676:
1.80 albertel 2677: ###############################################################
2678: ## Get Kerberos Defaults for Domain ##
2679: ###############################################################
2680: ##
2681: ## Returns default kerberos version and an associated argument
2682: ## as listed in file domain.tab. If not listed, provides
2683: ## appropriate default domain and kerberos version.
2684: ##
2685: #-------------------------------------------
2686:
2687: =pod
2688:
1.648 raeburn 2689: =item * &get_kerberos_defaults()
1.80 albertel 2690:
2691: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2692: version and domain. If not found, it defaults to version 4 and the
2693: domain of the server.
1.80 albertel 2694:
1.648 raeburn 2695: =over 4
2696:
1.80 albertel 2697: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2698:
1.648 raeburn 2699: =back
2700:
2701: =back
2702:
1.80 albertel 2703: =cut
2704:
2705: #-------------------------------------------
2706: sub get_kerberos_defaults {
2707: my $domain=shift;
1.641 raeburn 2708: my ($krbdef,$krbdefdom);
2709: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2710: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2711: $krbdef = $domdefaults{'auth_def'};
2712: $krbdefdom = $domdefaults{'auth_arg_def'};
2713: } else {
1.80 albertel 2714: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2715: my $krbdefdom=$1;
2716: $krbdefdom=~tr/a-z/A-Z/;
2717: $krbdef = "krb4";
2718: }
2719: return ($krbdef,$krbdefdom);
2720: }
1.112 bowersj2 2721:
1.32 matthew 2722:
1.46 matthew 2723: ###############################################################
2724: ## Thesaurus Functions ##
2725: ###############################################################
1.20 www 2726:
1.46 matthew 2727: =pod
1.20 www 2728:
1.112 bowersj2 2729: =head1 Thesaurus Functions
2730:
2731: =over 4
2732:
1.648 raeburn 2733: =item * &initialize_keywords()
1.46 matthew 2734:
2735: Initializes the package variable %Keywords if it is empty. Uses the
2736: package variable $thesaurus_db_file.
2737:
2738: =cut
2739:
2740: ###################################################
2741:
2742: sub initialize_keywords {
2743: return 1 if (scalar keys(%Keywords));
2744: # If we are here, %Keywords is empty, so fill it up
2745: # Make sure the file we need exists...
2746: if (! -e $thesaurus_db_file) {
2747: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2748: " failed because it does not exist");
2749: return 0;
2750: }
2751: # Set up the hash as a database
2752: my %thesaurus_db;
2753: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2754: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2755: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2756: $thesaurus_db_file);
2757: return 0;
2758: }
2759: # Get the average number of appearances of a word.
2760: my $avecount = $thesaurus_db{'average.count'};
2761: # Put keywords (those that appear > average) into %Keywords
2762: while (my ($word,$data)=each (%thesaurus_db)) {
2763: my ($count,undef) = split /:/,$data;
2764: $Keywords{$word}++ if ($count > $avecount);
2765: }
2766: untie %thesaurus_db;
2767: # Remove special values from %Keywords.
1.356 albertel 2768: foreach my $value ('total.count','average.count') {
2769: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2770: }
1.46 matthew 2771: return 1;
2772: }
2773:
2774: ###################################################
2775:
2776: =pod
2777:
1.648 raeburn 2778: =item * &keyword($word)
1.46 matthew 2779:
2780: Returns true if $word is a keyword. A keyword is a word that appears more
2781: than the average number of times in the thesaurus database. Calls
2782: &initialize_keywords
2783:
2784: =cut
2785:
2786: ###################################################
1.20 www 2787:
2788: sub keyword {
1.46 matthew 2789: return if (!&initialize_keywords());
2790: my $word=lc(shift());
2791: $word=~s/\W//g;
2792: return exists($Keywords{$word});
1.20 www 2793: }
1.46 matthew 2794:
2795: ###############################################################
2796:
2797: =pod
1.20 www 2798:
1.648 raeburn 2799: =item * &get_related_words()
1.46 matthew 2800:
1.160 matthew 2801: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2802: an array of words. If the keyword is not in the thesaurus, an empty array
2803: will be returned. The order of the words returned is determined by the
2804: database which holds them.
2805:
2806: Uses global $thesaurus_db_file.
2807:
2808: =cut
2809:
2810: ###############################################################
2811: sub get_related_words {
2812: my $keyword = shift;
2813: my %thesaurus_db;
2814: if (! -e $thesaurus_db_file) {
2815: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2816: "failed because the file does not exist");
2817: return ();
2818: }
2819: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2820: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2821: return ();
2822: }
2823: my @Words=();
1.429 www 2824: my $count=0;
1.46 matthew 2825: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2826: # The first element is the number of times
2827: # the word appears. We do not need it now.
1.429 www 2828: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2829: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2830: my $threshold=$mostfrequentcount/10;
2831: foreach my $possibleword (@RelatedWords) {
2832: my ($word,$wordcount)=split(/\,/,$possibleword);
2833: if ($wordcount>$threshold) {
2834: push(@Words,$word);
2835: $count++;
2836: if ($count>10) { last; }
2837: }
1.20 www 2838: }
2839: }
1.46 matthew 2840: untie %thesaurus_db;
2841: return @Words;
1.14 harris41 2842: }
1.46 matthew 2843:
1.112 bowersj2 2844: =pod
2845:
2846: =back
2847:
2848: =cut
1.61 www 2849:
2850: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2851: =pod
2852:
1.112 bowersj2 2853: =head1 User Name Functions
2854:
2855: =over 4
2856:
1.648 raeburn 2857: =item * &plainname($uname,$udom,$first)
1.81 albertel 2858:
1.112 bowersj2 2859: Takes a users logon name and returns it as a string in
1.226 albertel 2860: "first middle last generation" form
2861: if $first is set to 'lastname' then it returns it as
2862: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2863:
2864: =cut
1.61 www 2865:
1.295 www 2866:
1.81 albertel 2867: ###############################################################
1.61 www 2868: sub plainname {
1.226 albertel 2869: my ($uname,$udom,$first)=@_;
1.537 albertel 2870: return if (!defined($uname) || !defined($udom));
1.295 www 2871: my %names=&getnames($uname,$udom);
1.226 albertel 2872: my $name=&Apache::lonnet::format_name($names{'firstname'},
2873: $names{'middlename'},
2874: $names{'lastname'},
2875: $names{'generation'},$first);
2876: $name=~s/^\s+//;
1.62 www 2877: $name=~s/\s+$//;
2878: $name=~s/\s+/ /g;
1.353 albertel 2879: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2880: return $name;
1.61 www 2881: }
1.66 www 2882:
2883: # -------------------------------------------------------------------- Nickname
1.81 albertel 2884: =pod
2885:
1.648 raeburn 2886: =item * &nickname($uname,$udom)
1.81 albertel 2887:
2888: Gets a users name and returns it as a string as
2889:
2890: ""nickname""
1.66 www 2891:
1.81 albertel 2892: if the user has a nickname or
2893:
2894: "first middle last generation"
2895:
2896: if the user does not
2897:
2898: =cut
1.66 www 2899:
2900: sub nickname {
2901: my ($uname,$udom)=@_;
1.537 albertel 2902: return if (!defined($uname) || !defined($udom));
1.295 www 2903: my %names=&getnames($uname,$udom);
1.68 albertel 2904: my $name=$names{'nickname'};
1.66 www 2905: if ($name) {
2906: $name='"'.$name.'"';
2907: } else {
2908: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2909: $names{'lastname'}.' '.$names{'generation'};
2910: $name=~s/\s+$//;
2911: $name=~s/\s+/ /g;
2912: }
2913: return $name;
2914: }
2915:
1.295 www 2916: sub getnames {
2917: my ($uname,$udom)=@_;
1.537 albertel 2918: return if (!defined($uname) || !defined($udom));
1.433 albertel 2919: if ($udom eq 'public' && $uname eq 'public') {
2920: return ('lastname' => &mt('Public'));
2921: }
1.295 www 2922: my $id=$uname.':'.$udom;
2923: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2924: if ($cached) {
2925: return %{$names};
2926: } else {
2927: my %loadnames=&Apache::lonnet::get('environment',
2928: ['firstname','middlename','lastname','generation','nickname'],
2929: $udom,$uname);
2930: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2931: return %loadnames;
2932: }
2933: }
1.61 www 2934:
1.542 raeburn 2935: # -------------------------------------------------------------------- getemails
1.648 raeburn 2936:
1.542 raeburn 2937: =pod
2938:
1.648 raeburn 2939: =item * &getemails($uname,$udom)
1.542 raeburn 2940:
2941: Gets a user's email information and returns it as a hash with keys:
2942: notification, critnotification, permanentemail
2943:
2944: For notification and critnotification, values are comma-separated lists
1.648 raeburn 2945: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 2946:
1.648 raeburn 2947:
1.542 raeburn 2948: =cut
2949:
1.648 raeburn 2950:
1.466 albertel 2951: sub getemails {
2952: my ($uname,$udom)=@_;
2953: if ($udom eq 'public' && $uname eq 'public') {
2954: return;
2955: }
1.467 www 2956: if (!$udom) { $udom=$env{'user.domain'}; }
2957: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 2958: my $id=$uname.':'.$udom;
2959: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2960: if ($cached) {
2961: return %{$names};
2962: } else {
2963: my %loadnames=&Apache::lonnet::get('environment',
2964: ['notification','critnotification',
2965: 'permanentemail'],
2966: $udom,$uname);
2967: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2968: return %loadnames;
2969: }
2970: }
2971:
1.551 albertel 2972: sub flush_email_cache {
2973: my ($uname,$udom)=@_;
2974: if (!$udom) { $udom =$env{'user.domain'}; }
2975: if (!$uname) { $uname=$env{'user.name'}; }
2976: return if ($udom eq 'public' && $uname eq 'public');
2977: my $id=$uname.':'.$udom;
2978: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2979: }
2980:
1.728 raeburn 2981: # -------------------------------------------------------------------- getlangs
2982:
2983: =pod
2984:
2985: =item * &getlangs($uname,$udom)
2986:
2987: Gets a user's language preference and returns it as a hash with key:
2988: language.
2989:
2990: =cut
2991:
2992:
2993: sub getlangs {
2994: my ($uname,$udom) = @_;
2995: if (!$udom) { $udom =$env{'user.domain'}; }
2996: if (!$uname) { $uname=$env{'user.name'}; }
2997: my $id=$uname.':'.$udom;
2998: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
2999: if ($cached) {
3000: return %{$langs};
3001: } else {
3002: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
3003: $udom,$uname);
3004: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
3005: return %loadlangs;
3006: }
3007: }
3008:
3009: sub flush_langs_cache {
3010: my ($uname,$udom)=@_;
3011: if (!$udom) { $udom =$env{'user.domain'}; }
3012: if (!$uname) { $uname=$env{'user.name'}; }
3013: return if ($udom eq 'public' && $uname eq 'public');
3014: my $id=$uname.':'.$udom;
3015: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
3016: }
3017:
1.61 www 3018: # ------------------------------------------------------------------ Screenname
1.81 albertel 3019:
3020: =pod
3021:
1.648 raeburn 3022: =item * &screenname($uname,$udom)
1.81 albertel 3023:
3024: Gets a users screenname and returns it as a string
3025:
3026: =cut
1.61 www 3027:
3028: sub screenname {
3029: my ($uname,$udom)=@_;
1.258 albertel 3030: if ($uname eq $env{'user.name'} &&
3031: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 3032: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 3033: return $names{'screenname'};
1.62 www 3034: }
3035:
1.212 albertel 3036:
1.802 bisitz 3037: # ------------------------------------------------------------- Confirm Wrapper
3038: =pod
3039:
3040: =item confirmwrapper
3041:
3042: Wrap messages about completion of operation in box
3043:
3044: =cut
3045:
3046: sub confirmwrapper {
3047: my ($message)=@_;
3048: if ($message) {
3049: return "\n".'<div class="LC_confirm_box">'."\n"
3050: .$message."\n"
3051: .'</div>'."\n";
3052: } else {
3053: return $message;
3054: }
3055: }
3056:
1.62 www 3057: # ------------------------------------------------------------- Message Wrapper
3058:
3059: sub messagewrapper {
1.369 www 3060: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 3061: return
1.441 albertel 3062: '<a href="/adm/email?compose=individual&'.
3063: 'recname='.$username.'&recdom='.$domain.
3064: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 3065: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 3066: }
1.802 bisitz 3067:
1.74 www 3068: # --------------------------------------------------------------- Notes Wrapper
3069:
3070: sub noteswrapper {
3071: my ($link,$un,$do)=@_;
3072: return
1.896 amueller 3073: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 3074: }
1.802 bisitz 3075:
1.62 www 3076: # ------------------------------------------------------------- Aboutme Wrapper
3077:
3078: sub aboutmewrapper {
1.166 www 3079: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 3080: if (!defined($username) && !defined($domain)) {
3081: return;
3082: }
1.892 amueller 3083: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.756 weissno 3084: ($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 3085: }
3086:
3087: # ------------------------------------------------------------ Syllabus Wrapper
3088:
3089: sub syllabuswrapper {
1.707 bisitz 3090: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 3091: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 3092: }
1.14 harris41 3093:
1.802 bisitz 3094: # -----------------------------------------------------------------------------
3095:
1.208 matthew 3096: sub track_student_link {
1.887 raeburn 3097: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 3098: my $link ="/adm/trackstudent?";
1.208 matthew 3099: my $title = 'View recent activity';
3100: if (defined($sname) && $sname !~ /^\s*$/ &&
3101: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 3102: $link .= "selected_student=$sname:$sdom";
1.208 matthew 3103: $title .= ' of this student';
1.268 albertel 3104: }
1.208 matthew 3105: if (defined($target) && $target !~ /^\s*$/) {
3106: $target = qq{target="$target"};
3107: } else {
3108: $target = '';
3109: }
1.268 albertel 3110: if ($start) { $link.='&start='.$start; }
1.887 raeburn 3111: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 3112: $title = &mt($title);
3113: $linktext = &mt($linktext);
1.448 albertel 3114: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
3115: &help_open_topic('View_recent_activity');
1.208 matthew 3116: }
3117:
1.781 raeburn 3118: sub slot_reservations_link {
3119: my ($linktext,$sname,$sdom,$target) = @_;
3120: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
3121: my $title = 'View slot reservation history';
3122: if (defined($sname) && $sname !~ /^\s*$/ &&
3123: defined($sdom) && $sdom !~ /^\s*$/) {
3124: $link .= "&uname=$sname&udom=$sdom";
3125: $title .= ' of this student';
3126: }
3127: if (defined($target) && $target !~ /^\s*$/) {
3128: $target = qq{target="$target"};
3129: } else {
3130: $target = '';
3131: }
3132: $title = &mt($title);
3133: $linktext = &mt($linktext);
3134: return qq{<a href="$link" title="$title" $target>$linktext</a>};
3135: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
3136:
3137: }
3138:
1.508 www 3139: # ===================================================== Display a student photo
3140:
3141:
1.509 albertel 3142: sub student_image_tag {
1.508 www 3143: my ($domain,$user)=@_;
3144: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
3145: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
3146: return '<img src="'.$imgsrc.'" align="right" />';
3147: } else {
3148: return '';
3149: }
3150: }
3151:
1.112 bowersj2 3152: =pod
3153:
3154: =back
3155:
3156: =head1 Access .tab File Data
3157:
3158: =over 4
3159:
1.648 raeburn 3160: =item * &languageids()
1.112 bowersj2 3161:
3162: returns list of all language ids
3163:
3164: =cut
3165:
1.14 harris41 3166: sub languageids {
1.16 harris41 3167: return sort(keys(%language));
1.14 harris41 3168: }
3169:
1.112 bowersj2 3170: =pod
3171:
1.648 raeburn 3172: =item * &languagedescription()
1.112 bowersj2 3173:
3174: returns description of a specified language id
3175:
3176: =cut
3177:
1.14 harris41 3178: sub languagedescription {
1.125 www 3179: my $code=shift;
3180: return ($supported_language{$code}?'* ':'').
3181: $language{$code}.
1.126 www 3182: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 3183: }
3184:
3185: sub plainlanguagedescription {
3186: my $code=shift;
3187: return $language{$code};
3188: }
3189:
3190: sub supportedlanguagecode {
3191: my $code=shift;
3192: return $supported_language{$code};
1.97 www 3193: }
3194:
1.112 bowersj2 3195: =pod
3196:
1.648 raeburn 3197: =item * ©rightids()
1.112 bowersj2 3198:
3199: returns list of all copyrights
3200:
3201: =cut
3202:
3203: sub copyrightids {
3204: return sort(keys(%cprtag));
3205: }
3206:
3207: =pod
3208:
1.648 raeburn 3209: =item * ©rightdescription()
1.112 bowersj2 3210:
3211: returns description of a specified copyright id
3212:
3213: =cut
3214:
3215: sub copyrightdescription {
1.166 www 3216: return &mt($cprtag{shift(@_)});
1.112 bowersj2 3217: }
1.197 matthew 3218:
3219: =pod
3220:
1.648 raeburn 3221: =item * &source_copyrightids()
1.192 taceyjo1 3222:
3223: returns list of all source copyrights
3224:
3225: =cut
3226:
3227: sub source_copyrightids {
3228: return sort(keys(%scprtag));
3229: }
3230:
3231: =pod
3232:
1.648 raeburn 3233: =item * &source_copyrightdescription()
1.192 taceyjo1 3234:
3235: returns description of a specified source copyright id
3236:
3237: =cut
3238:
3239: sub source_copyrightdescription {
3240: return &mt($scprtag{shift(@_)});
3241: }
1.112 bowersj2 3242:
3243: =pod
3244:
1.648 raeburn 3245: =item * &filecategories()
1.112 bowersj2 3246:
3247: returns list of all file categories
3248:
3249: =cut
3250:
3251: sub filecategories {
3252: return sort(keys(%category_extensions));
3253: }
3254:
3255: =pod
3256:
1.648 raeburn 3257: =item * &filecategorytypes()
1.112 bowersj2 3258:
3259: returns list of file types belonging to a given file
3260: category
3261:
3262: =cut
3263:
3264: sub filecategorytypes {
1.356 albertel 3265: my ($cat) = @_;
3266: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 3267: }
3268:
3269: =pod
3270:
1.648 raeburn 3271: =item * &fileembstyle()
1.112 bowersj2 3272:
3273: returns embedding style for a specified file type
3274:
3275: =cut
3276:
3277: sub fileembstyle {
3278: return $fe{lc(shift(@_))};
1.169 www 3279: }
3280:
1.351 www 3281: sub filemimetype {
3282: return $fm{lc(shift(@_))};
3283: }
3284:
1.169 www 3285:
3286: sub filecategoryselect {
3287: my ($name,$value)=@_;
1.189 matthew 3288: return &select_form($value,$name,
1.970 raeburn 3289: {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112 bowersj2 3290: }
3291:
3292: =pod
3293:
1.648 raeburn 3294: =item * &filedescription()
1.112 bowersj2 3295:
3296: returns description for a specified file type
3297:
3298: =cut
3299:
3300: sub filedescription {
1.188 matthew 3301: my $file_description = $fd{lc(shift())};
3302: $file_description =~ s:([\[\]]):~$1:g;
3303: return &mt($file_description);
1.112 bowersj2 3304: }
3305:
3306: =pod
3307:
1.648 raeburn 3308: =item * &filedescriptionex()
1.112 bowersj2 3309:
3310: returns description for a specified file type with
3311: extra formatting
3312:
3313: =cut
3314:
3315: sub filedescriptionex {
3316: my $ex=shift;
1.188 matthew 3317: my $file_description = $fd{lc($ex)};
3318: $file_description =~ s:([\[\]]):~$1:g;
3319: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3320: }
3321:
3322: # End of .tab access
3323: =pod
3324:
3325: =back
3326:
3327: =cut
3328:
3329: # ------------------------------------------------------------------ File Types
3330: sub fileextensions {
3331: return sort(keys(%fe));
3332: }
3333:
1.97 www 3334: # ----------------------------------------------------------- Display Languages
3335: # returns a hash with all desired display languages
3336: #
3337:
3338: sub display_languages {
3339: my %languages=();
1.695 raeburn 3340: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3341: $languages{$lang}=1;
1.97 www 3342: }
3343: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3344: if ($env{'form.displaylanguage'}) {
1.356 albertel 3345: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3346: $languages{$lang}=1;
1.97 www 3347: }
3348: }
3349: return %languages;
1.14 harris41 3350: }
3351:
1.582 albertel 3352: sub languages {
3353: my ($possible_langs) = @_;
1.695 raeburn 3354: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3355: if (!ref($possible_langs)) {
3356: if( wantarray ) {
3357: return @preferred_langs;
3358: } else {
3359: return $preferred_langs[0];
3360: }
3361: }
3362: my %possibilities = map { $_ => 1 } (@$possible_langs);
3363: my @preferred_possibilities;
3364: foreach my $preferred_lang (@preferred_langs) {
3365: if (exists($possibilities{$preferred_lang})) {
3366: push(@preferred_possibilities, $preferred_lang);
3367: }
3368: }
3369: if( wantarray ) {
3370: return @preferred_possibilities;
3371: }
3372: return $preferred_possibilities[0];
3373: }
3374:
1.742 raeburn 3375: sub user_lang {
3376: my ($touname,$toudom,$fromcid) = @_;
3377: my @userlangs;
3378: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3379: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3380: $env{'course.'.$fromcid.'.languages'}));
3381: } else {
3382: my %langhash = &getlangs($touname,$toudom);
3383: if ($langhash{'languages'} ne '') {
3384: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3385: } else {
3386: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3387: if ($domdefs{'lang_def'} ne '') {
3388: @userlangs = ($domdefs{'lang_def'});
3389: }
3390: }
3391: }
3392: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3393: my $user_lh = Apache::localize->get_handle(@languages);
3394: return $user_lh;
3395: }
3396:
3397:
1.112 bowersj2 3398: ###############################################################
3399: ## Student Answer Attempts ##
3400: ###############################################################
3401:
3402: =pod
3403:
3404: =head1 Alternate Problem Views
3405:
3406: =over 4
3407:
1.648 raeburn 3408: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3409: $getattempt, $regexp, $gradesub)
3410:
3411: Return string with previous attempt on problem. Arguments:
3412:
3413: =over 4
3414:
3415: =item * $symb: Problem, including path
3416:
3417: =item * $username: username of the desired student
3418:
3419: =item * $domain: domain of the desired student
1.14 harris41 3420:
1.112 bowersj2 3421: =item * $course: Course ID
1.14 harris41 3422:
1.112 bowersj2 3423: =item * $getattempt: Leave blank for all attempts, otherwise put
3424: something
1.14 harris41 3425:
1.112 bowersj2 3426: =item * $regexp: if string matches this regexp, the string will be
3427: sent to $gradesub
1.14 harris41 3428:
1.112 bowersj2 3429: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3430:
1.112 bowersj2 3431: =back
1.14 harris41 3432:
1.112 bowersj2 3433: The output string is a table containing all desired attempts, if any.
1.16 harris41 3434:
1.112 bowersj2 3435: =cut
1.1 albertel 3436:
3437: sub get_previous_attempt {
1.43 ng 3438: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3439: my $prevattempts='';
1.43 ng 3440: no strict 'refs';
1.1 albertel 3441: if ($symb) {
1.3 albertel 3442: my (%returnhash)=
3443: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3444: if ($returnhash{'version'}) {
3445: my %lasthash=();
3446: my $version;
3447: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3448: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3449: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3450: }
1.1 albertel 3451: }
1.596 albertel 3452: $prevattempts=&start_data_table().&start_data_table_header_row();
3453: $prevattempts.='<th>'.&mt('History').'</th>';
1.978 raeburn 3454: my (%typeparts,%lasthidden);
1.945 raeburn 3455: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 3456: foreach my $key (sort(keys(%lasthash))) {
3457: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3458: if ($#parts > 0) {
1.31 albertel 3459: my $data=$parts[-1];
1.989 raeburn 3460: next if ($data eq 'foilorder');
1.31 albertel 3461: pop(@parts);
1.945 raeburn 3462: if ($data eq 'type') {
3463: unless ($showsurv) {
3464: my $id = join(',',@parts);
3465: $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978 raeburn 3466: if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
3467: $lasthidden{$ign.'.'.$id} = 1;
3468: }
1.945 raeburn 3469: }
3470: delete($lasthash{$key});
3471: } else {
3472: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
3473: }
1.31 albertel 3474: } else {
1.41 ng 3475: if ($#parts == 0) {
3476: $prevattempts.='<th>'.$parts[0].'</th>';
3477: } else {
3478: $prevattempts.='<th>'.$ign.'</th>';
3479: }
1.31 albertel 3480: }
1.16 harris41 3481: }
1.596 albertel 3482: $prevattempts.=&end_data_table_header_row();
1.40 ng 3483: if ($getattempt eq '') {
3484: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.945 raeburn 3485: my @hidden;
3486: if (%typeparts) {
3487: foreach my $id (keys(%typeparts)) {
3488: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
3489: push(@hidden,$id);
3490: }
3491: }
3492: }
3493: $prevattempts.=&start_data_table_row().
3494: '<td>'.&mt('Transaction [_1]',$version).'</td>';
3495: if (@hidden) {
3496: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3497: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3498: my $hide;
3499: foreach my $id (@hidden) {
3500: if ($key =~ /^\Q$id\E/) {
3501: $hide = 1;
3502: last;
3503: }
3504: }
3505: if ($hide) {
3506: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3507: if (($data eq 'award') || ($data eq 'awarddetail')) {
3508: my $value = &format_previous_attempt_value($key,
3509: $returnhash{$version.':'.$key});
3510: $prevattempts.='<td>'.$value.' </td>';
3511: } else {
3512: $prevattempts.='<td> </td>';
3513: }
3514: } else {
3515: if ($key =~ /\./) {
3516: my $value = &format_previous_attempt_value($key,
3517: $returnhash{$version.':'.$key});
3518: $prevattempts.='<td>'.$value.' </td>';
3519: } else {
3520: $prevattempts.='<td> </td>';
3521: }
3522: }
3523: }
3524: } else {
3525: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3526: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3527: my $value = &format_previous_attempt_value($key,
3528: $returnhash{$version.':'.$key});
3529: $prevattempts.='<td>'.$value.' </td>';
3530: }
3531: }
3532: $prevattempts.=&end_data_table_row();
1.40 ng 3533: }
1.1 albertel 3534: }
1.945 raeburn 3535: my @currhidden = keys(%lasthidden);
1.596 albertel 3536: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3537: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3538: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3539: if (%typeparts) {
3540: my $hidden;
3541: foreach my $id (@currhidden) {
3542: if ($key =~ /^\Q$id\E/) {
3543: $hidden = 1;
3544: last;
3545: }
3546: }
3547: if ($hidden) {
3548: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3549: if (($data eq 'award') || ($data eq 'awarddetail')) {
3550: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3551: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3552: $value = &$gradesub($value);
3553: }
3554: $prevattempts.='<td>'.$value.' </td>';
3555: } else {
3556: $prevattempts.='<td> </td>';
3557: }
3558: } else {
3559: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3560: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3561: $value = &$gradesub($value);
3562: }
3563: $prevattempts.='<td>'.$value.' </td>';
3564: }
3565: } else {
3566: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3567: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3568: $value = &$gradesub($value);
3569: }
3570: $prevattempts.='<td>'.$value.' </td>';
3571: }
1.16 harris41 3572: }
1.596 albertel 3573: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3574: } else {
1.596 albertel 3575: $prevattempts=
3576: &start_data_table().&start_data_table_row().
3577: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3578: &end_data_table_row().&end_data_table();
1.1 albertel 3579: }
3580: } else {
1.596 albertel 3581: $prevattempts=
3582: &start_data_table().&start_data_table_row().
3583: '<td>'.&mt('No data.').'</td>'.
3584: &end_data_table_row().&end_data_table();
1.1 albertel 3585: }
1.10 albertel 3586: }
3587:
1.581 albertel 3588: sub format_previous_attempt_value {
3589: my ($key,$value) = @_;
3590: if ($key =~ /timestamp/) {
3591: $value = &Apache::lonlocal::locallocaltime($value);
3592: } elsif (ref($value) eq 'ARRAY') {
3593: $value = '('.join(', ', @{ $value }).')';
1.988 raeburn 3594: } elsif ($key =~ /answerstring$/) {
3595: my %answers = &Apache::lonnet::str2hash($value);
3596: my @anskeys = sort(keys(%answers));
3597: if (@anskeys == 1) {
3598: my $answer = $answers{$anskeys[0]};
1.1001 raeburn 3599: if ($answer =~ m{\0}) {
3600: $answer =~ s{\0}{,}g;
1.988 raeburn 3601: }
3602: my $tag_internal_answer_name = 'INTERNAL';
3603: if ($anskeys[0] eq $tag_internal_answer_name) {
3604: $value = $answer;
3605: } else {
3606: $value = $anskeys[0].'='.$answer;
3607: }
3608: } else {
3609: foreach my $ans (@anskeys) {
3610: my $answer = $answers{$ans};
1.1001 raeburn 3611: if ($answer =~ m{\0}) {
3612: $answer =~ s{\0}{,}g;
1.988 raeburn 3613: }
3614: $value .= $ans.'='.$answer.'<br />';;
3615: }
3616: }
1.581 albertel 3617: } else {
3618: $value = &unescape($value);
3619: }
3620: return $value;
3621: }
3622:
3623:
1.107 albertel 3624: sub relative_to_absolute {
3625: my ($url,$output)=@_;
3626: my $parser=HTML::TokeParser->new(\$output);
3627: my $token;
3628: my $thisdir=$url;
3629: my @rlinks=();
3630: while ($token=$parser->get_token) {
3631: if ($token->[0] eq 'S') {
3632: if ($token->[1] eq 'a') {
3633: if ($token->[2]->{'href'}) {
3634: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3635: }
3636: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3637: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3638: } elsif ($token->[1] eq 'base') {
3639: $thisdir=$token->[2]->{'href'};
3640: }
3641: }
3642: }
3643: $thisdir=~s-/[^/]*$--;
1.356 albertel 3644: foreach my $link (@rlinks) {
1.726 raeburn 3645: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3646: ($link=~/^\//) ||
3647: ($link=~/^javascript:/i) ||
3648: ($link=~/^mailto:/i) ||
3649: ($link=~/^\#/)) {
3650: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3651: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3652: }
3653: }
3654: # -------------------------------------------------- Deal with Applet codebases
3655: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3656: return $output;
3657: }
3658:
1.112 bowersj2 3659: =pod
3660:
1.648 raeburn 3661: =item * &get_student_view()
1.112 bowersj2 3662:
3663: show a snapshot of what student was looking at
3664:
3665: =cut
3666:
1.10 albertel 3667: sub get_student_view {
1.186 albertel 3668: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3669: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3670: my (%form);
1.10 albertel 3671: my @elements=('symb','courseid','domain','username');
3672: foreach my $element (@elements) {
1.186 albertel 3673: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3674: }
1.186 albertel 3675: if (defined($moreenv)) {
3676: %form=(%form,%{$moreenv});
3677: }
1.236 albertel 3678: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3679: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3680: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3681: $userview=~s/\<body[^\>]*\>//gi;
3682: $userview=~s/\<\/body\>//gi;
3683: $userview=~s/\<html\>//gi;
3684: $userview=~s/\<\/html\>//gi;
3685: $userview=~s/\<head\>//gi;
3686: $userview=~s/\<\/head\>//gi;
3687: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3688: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3689: if (wantarray) {
3690: return ($userview,$response);
3691: } else {
3692: return $userview;
3693: }
3694: }
3695:
3696: sub get_student_view_with_retries {
3697: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3698:
3699: my $ok = 0; # True if we got a good response.
3700: my $content;
3701: my $response;
3702:
3703: # Try to get the student_view done. within the retries count:
3704:
3705: do {
3706: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3707: $ok = $response->is_success;
3708: if (!$ok) {
3709: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3710: }
3711: $retries--;
3712: } while (!$ok && ($retries > 0));
3713:
3714: if (!$ok) {
3715: $content = ''; # On error return an empty content.
3716: }
1.651 www 3717: if (wantarray) {
3718: return ($content, $response);
3719: } else {
3720: return $content;
3721: }
1.11 albertel 3722: }
3723:
1.112 bowersj2 3724: =pod
3725:
1.648 raeburn 3726: =item * &get_student_answers()
1.112 bowersj2 3727:
3728: show a snapshot of how student was answering problem
3729:
3730: =cut
3731:
1.11 albertel 3732: sub get_student_answers {
1.100 sakharuk 3733: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3734: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3735: my (%moreenv);
1.11 albertel 3736: my @elements=('symb','courseid','domain','username');
3737: foreach my $element (@elements) {
1.186 albertel 3738: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3739: }
1.186 albertel 3740: $moreenv{'grade_target'}='answer';
3741: %moreenv=(%form,%moreenv);
1.497 raeburn 3742: $feedurl = &Apache::lonnet::clutter($feedurl);
3743: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3744: return $userview;
1.1 albertel 3745: }
1.116 albertel 3746:
3747: =pod
3748:
3749: =item * &submlink()
3750:
1.242 albertel 3751: Inputs: $text $uname $udom $symb $target
1.116 albertel 3752:
3753: Returns: A link to grades.pm such as to see the SUBM view of a student
3754:
3755: =cut
3756:
3757: ###############################################
3758: sub submlink {
1.242 albertel 3759: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3760: if (!($uname && $udom)) {
3761: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3762: &Apache::lonnet::whichuser($symb);
1.116 albertel 3763: if (!$symb) { $symb=$cursymb; }
3764: }
1.254 matthew 3765: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3766: $symb=&escape($symb);
1.960 bisitz 3767: if ($target) { $target=" target=\"$target\""; }
3768: return
3769: '<a href="/adm/grades?command=submission'.
3770: '&symb='.$symb.
3771: '&student='.$uname.
3772: '&userdom='.$udom.'"'.
3773: $target.'>'.$text.'</a>';
1.242 albertel 3774: }
3775: ##############################################
3776:
3777: =pod
3778:
3779: =item * &pgrdlink()
3780:
3781: Inputs: $text $uname $udom $symb $target
3782:
3783: Returns: A link to grades.pm such as to see the PGRD view of a student
3784:
3785: =cut
3786:
3787: ###############################################
3788: sub pgrdlink {
3789: my $link=&submlink(@_);
3790: $link=~s/(&command=submission)/$1&showgrading=yes/;
3791: return $link;
3792: }
3793: ##############################################
3794:
3795: =pod
3796:
3797: =item * &pprmlink()
3798:
3799: Inputs: $text $uname $udom $symb $target
3800:
3801: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3802: student and a specific resource
1.242 albertel 3803:
3804: =cut
3805:
3806: ###############################################
3807: sub pprmlink {
3808: my ($text,$uname,$udom,$symb,$target)=@_;
3809: if (!($uname && $udom)) {
3810: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3811: &Apache::lonnet::whichuser($symb);
1.242 albertel 3812: if (!$symb) { $symb=$cursymb; }
3813: }
1.254 matthew 3814: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3815: $symb=&escape($symb);
1.242 albertel 3816: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3817: return '<a href="/adm/parmset?command=set&'.
3818: 'symb='.$symb.'&uname='.$uname.
3819: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3820: }
3821: ##############################################
1.37 matthew 3822:
1.112 bowersj2 3823: =pod
3824:
3825: =back
3826:
3827: =cut
3828:
1.37 matthew 3829: ###############################################
1.51 www 3830:
3831:
3832: sub timehash {
1.687 raeburn 3833: my ($thistime) = @_;
3834: my $timezone = &Apache::lonlocal::gettimezone();
3835: my $dt = DateTime->from_epoch(epoch => $thistime)
3836: ->set_time_zone($timezone);
3837: my $wday = $dt->day_of_week();
3838: if ($wday == 7) { $wday = 0; }
3839: return ( 'second' => $dt->second(),
3840: 'minute' => $dt->minute(),
3841: 'hour' => $dt->hour(),
3842: 'day' => $dt->day_of_month(),
3843: 'month' => $dt->month(),
3844: 'year' => $dt->year(),
3845: 'weekday' => $wday,
3846: 'dayyear' => $dt->day_of_year(),
3847: 'dlsav' => $dt->is_dst() );
1.51 www 3848: }
3849:
1.370 www 3850: sub utc_string {
3851: my ($date)=@_;
1.371 www 3852: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3853: }
3854:
1.51 www 3855: sub maketime {
3856: my %th=@_;
1.687 raeburn 3857: my ($epoch_time,$timezone,$dt);
3858: $timezone = &Apache::lonlocal::gettimezone();
3859: eval {
3860: $dt = DateTime->new( year => $th{'year'},
3861: month => $th{'month'},
3862: day => $th{'day'},
3863: hour => $th{'hour'},
3864: minute => $th{'minute'},
3865: second => $th{'second'},
3866: time_zone => $timezone,
3867: );
3868: };
3869: if (!$@) {
3870: $epoch_time = $dt->epoch;
3871: if ($epoch_time) {
3872: return $epoch_time;
3873: }
3874: }
1.51 www 3875: return POSIX::mktime(
3876: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3877: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3878: }
3879:
3880: #########################################
1.51 www 3881:
3882: sub findallcourses {
1.482 raeburn 3883: my ($roles,$uname,$udom) = @_;
1.355 albertel 3884: my %roles;
3885: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3886: my %courses;
1.51 www 3887: my $now=time;
1.482 raeburn 3888: if (!defined($uname)) {
3889: $uname = $env{'user.name'};
3890: }
3891: if (!defined($udom)) {
3892: $udom = $env{'user.domain'};
3893: }
3894: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.982 raeburn 3895: my $extra = &Apache::lonnet::freeze_escape({'skipcheck' => 1});
3896: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname,'.',undef,
3897: $extra);
1.482 raeburn 3898: if (!%roles) {
3899: %roles = (
3900: cc => 1,
1.907 raeburn 3901: co => 1,
1.482 raeburn 3902: in => 1,
3903: ep => 1,
3904: ta => 1,
3905: cr => 1,
3906: st => 1,
3907: );
3908: }
3909: foreach my $entry (keys(%roleshash)) {
3910: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3911: if ($trole =~ /^cr/) {
3912: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3913: } else {
3914: next if (!exists($roles{$trole}));
3915: }
3916: if ($tend) {
3917: next if ($tend < $now);
3918: }
3919: if ($tstart) {
3920: next if ($tstart > $now);
3921: }
3922: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3923: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3924: if ($secpart eq '') {
3925: ($cnum,$role) = split(/_/,$cnumpart);
3926: $sec = 'none';
3927: $realsec = '';
3928: } else {
3929: $cnum = $cnumpart;
3930: ($sec,$role) = split(/_/,$secpart);
3931: $realsec = $sec;
1.490 raeburn 3932: }
1.482 raeburn 3933: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3934: }
3935: } else {
3936: foreach my $key (keys(%env)) {
1.483 albertel 3937: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3938: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3939: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3940: next if ($role eq 'ca' || $role eq 'aa');
3941: next if (%roles && !exists($roles{$role}));
3942: my ($starttime,$endtime)=split(/\./,$env{$key});
3943: my $active=1;
3944: if ($starttime) {
3945: if ($now<$starttime) { $active=0; }
3946: }
3947: if ($endtime) {
3948: if ($now>$endtime) { $active=0; }
3949: }
3950: if ($active) {
3951: if ($sec eq '') {
3952: $sec = 'none';
3953: }
3954: $courses{$cdom.'_'.$cnum}{$sec} =
3955: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 3956: }
3957: }
1.51 www 3958: }
3959: }
1.474 raeburn 3960: return %courses;
1.51 www 3961: }
1.37 matthew 3962:
1.54 www 3963: ###############################################
1.474 raeburn 3964:
3965: sub blockcheck {
1.482 raeburn 3966: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 3967:
3968: if (!defined($udom)) {
3969: $udom = $env{'user.domain'};
3970: }
3971: if (!defined($uname)) {
3972: $uname = $env{'user.name'};
3973: }
3974:
3975: # If uname and udom are for a course, check for blocks in the course.
3976:
3977: if (&Apache::lonnet::is_course($udom,$uname)) {
3978: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 3979: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 3980: return ($startblock,$endblock);
3981: }
1.474 raeburn 3982:
1.502 raeburn 3983: my $startblock = 0;
3984: my $endblock = 0;
1.482 raeburn 3985: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 3986:
1.490 raeburn 3987: # If uname is for a user, and activity is course-specific, i.e.,
3988: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3989:
1.490 raeburn 3990: if (($activity eq 'boards' || $activity eq 'chat' ||
3991: $activity eq 'groups') && ($env{'request.course.id'})) {
3992: foreach my $key (keys(%live_courses)) {
3993: if ($key ne $env{'request.course.id'}) {
3994: delete($live_courses{$key});
3995: }
3996: }
3997: }
3998:
3999: my $otheruser = 0;
4000: my %own_courses;
4001: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
4002: # Resource belongs to user other than current user.
4003: $otheruser = 1;
4004: # Gather courses for current user
4005: %own_courses =
4006: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
4007: }
4008:
4009: # Gather active course roles - course coordinator, instructor,
4010: # exam proctor, ta, student, or custom role.
1.474 raeburn 4011:
4012: foreach my $course (keys(%live_courses)) {
1.482 raeburn 4013: my ($cdom,$cnum);
4014: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
4015: $cdom = $env{'course.'.$course.'.domain'};
4016: $cnum = $env{'course.'.$course.'.num'};
4017: } else {
1.490 raeburn 4018: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 4019: }
4020: my $no_ownblock = 0;
4021: my $no_userblock = 0;
1.533 raeburn 4022: if ($otheruser && $activity ne 'com') {
1.490 raeburn 4023: # Check if current user has 'evb' priv for this
4024: if (defined($own_courses{$course})) {
4025: foreach my $sec (keys(%{$own_courses{$course}})) {
4026: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
4027: if ($sec ne 'none') {
4028: $checkrole .= '/'.$sec;
4029: }
4030: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4031: $no_ownblock = 1;
4032: last;
4033: }
4034: }
4035: }
4036: # if they have 'evb' priv and are currently not playing student
4037: next if (($no_ownblock) &&
4038: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
4039: }
1.474 raeburn 4040: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 4041: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 4042: if ($sec ne 'none') {
1.482 raeburn 4043: $checkrole .= '/'.$sec;
1.474 raeburn 4044: }
1.490 raeburn 4045: if ($otheruser) {
4046: # Resource belongs to user other than current user.
4047: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 4048: my ($trole,$tdom,$tnum,$tsec);
4049: my $entry = $live_courses{$course}{$sec};
4050: if ($entry =~ /^cr/) {
4051: ($trole,$tdom,$tnum,$tsec) =
4052: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
4053: } else {
4054: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
4055: }
4056: my ($spec,$area,$trest,%allroles,%userroles);
4057: $area = '/'.$tdom.'/'.$tnum;
4058: $trest = $tnum;
4059: if ($tsec ne '') {
4060: $area .= '/'.$tsec;
4061: $trest .= '/'.$tsec;
4062: }
4063: $spec = $trole.'.'.$area;
4064: if ($trole =~ /^cr/) {
4065: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
4066: $tdom,$spec,$trest,$area);
4067: } else {
4068: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
4069: $tdom,$spec,$trest,$area);
4070: }
4071: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 4072: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
4073: if ($1) {
4074: $no_userblock = 1;
4075: last;
4076: }
4077: }
1.490 raeburn 4078: } else {
4079: # Resource belongs to current user
4080: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 4081: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4082: $no_ownblock = 1;
4083: last;
4084: }
1.474 raeburn 4085: }
4086: }
4087: # if they have the evb priv and are currently not playing student
1.482 raeburn 4088: next if (($no_ownblock) &&
1.491 albertel 4089: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 4090: next if ($no_userblock);
1.474 raeburn 4091:
1.866 kalberla 4092: # Retrieve blocking times and identity of locker for course
1.490 raeburn 4093: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 4094:
4095: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
4096: if (($start != 0) &&
4097: (($startblock == 0) || ($startblock > $start))) {
4098: $startblock = $start;
4099: }
4100: if (($end != 0) &&
4101: (($endblock == 0) || ($endblock < $end))) {
4102: $endblock = $end;
4103: }
1.490 raeburn 4104: }
4105: return ($startblock,$endblock);
4106: }
4107:
4108: sub get_blocks {
4109: my ($setters,$activity,$cdom,$cnum) = @_;
4110: my $startblock = 0;
4111: my $endblock = 0;
4112: my $course = $cdom.'_'.$cnum;
4113: $setters->{$course} = {};
4114: $setters->{$course}{'staff'} = [];
4115: $setters->{$course}{'times'} = [];
4116: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
4117: foreach my $record (keys(%records)) {
4118: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
4119: if ($start <= time && $end >= time) {
4120: my ($staff_name,$staff_dom,$title,$blocks) =
4121: &parse_block_record($records{$record});
4122: if ($blocks->{$activity} eq 'on') {
4123: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
4124: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 4125: if ( ($startblock == 0) || ($startblock > $start) ) {
4126: $startblock = $start;
1.490 raeburn 4127: }
1.491 albertel 4128: if ( ($endblock == 0) || ($endblock < $end) ) {
4129: $endblock = $end;
1.474 raeburn 4130: }
4131: }
4132: }
4133: }
4134: return ($startblock,$endblock);
4135: }
4136:
4137: sub parse_block_record {
4138: my ($record) = @_;
4139: my ($setuname,$setudom,$title,$blocks);
4140: if (ref($record) eq 'HASH') {
4141: ($setuname,$setudom) = split(/:/,$record->{'setter'});
4142: $title = &unescape($record->{'event'});
4143: $blocks = $record->{'blocks'};
4144: } else {
4145: my @data = split(/:/,$record,3);
4146: if (scalar(@data) eq 2) {
4147: $title = $data[1];
4148: ($setuname,$setudom) = split(/@/,$data[0]);
4149: } else {
4150: ($setuname,$setudom,$title) = @data;
4151: }
4152: $blocks = { 'com' => 'on' };
4153: }
4154: return ($setuname,$setudom,$title,$blocks);
4155: }
4156:
1.854 kalberla 4157: sub blocking_status {
4158: my ($activity,$uname,$udom) = @_;
1.867 kalberla 4159: my %setters;
1.890 droeschl 4160:
4161: # check for active blocking
1.867 kalberla 4162: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
1.854 kalberla 4163:
1.890 droeschl 4164: my $blocked = $startblock && $endblock ? 1 : 0;
4165:
4166: # caller just wants to know whether a block is active
4167: if (!wantarray) { return $blocked; }
4168:
4169: # build a link to a popup window containing the details
4170: my $querystring = "?activity=$activity";
4171: # $uname and $udom decide whose portfolio the user is trying to look at
4172: $querystring .= "&udom=$udom" if $udom;
4173: $querystring .= "&uname=$uname" if $uname;
4174:
4175: my $output .= <<'END_MYBLOCK';
1.854 kalberla 4176: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
4177: var options = "width=" + w + ",height=" + h + ",";
4178: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
4179: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
4180: var newWin = window.open(url, wdwName, options);
4181: newWin.focus();
4182: }
1.890 droeschl 4183: END_MYBLOCK
1.854 kalberla 4184:
1.890 droeschl 4185: $output = Apache::lonhtmlcommon::scripttag($output);
4186:
1.854 kalberla 4187: my $popupUrl = "/adm/blockingstatus/$querystring";
1.890 droeschl 4188: my $text = mt('Communication Blocked');
4189:
1.867 kalberla 4190: $output .= <<"END_BLOCK";
4191: <div class='LC_comblock'>
1.869 kalberla 4192: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4193: title='$text'>
4194: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 4195: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4196: title='$text'>$text</a>
1.867 kalberla 4197: </div>
4198:
4199: END_BLOCK
1.474 raeburn 4200:
1.854 kalberla 4201: return ($blocked, $output);
4202: }
1.490 raeburn 4203:
1.60 matthew 4204: ###############################################
4205:
1.682 raeburn 4206: sub check_ip_acc {
4207: my ($acc)=@_;
4208: &Apache::lonxml::debug("acc is $acc");
4209: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
4210: return 1;
4211: }
4212: my $allowed=0;
4213: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
4214:
4215: my $name;
4216: foreach my $pattern (split(',',$acc)) {
4217: $pattern =~ s/^\s*//;
4218: $pattern =~ s/\s*$//;
4219: if ($pattern =~ /\*$/) {
4220: #35.8.*
4221: $pattern=~s/\*//;
4222: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4223: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
4224: #35.8.3.[34-56]
4225: my $low=$2;
4226: my $high=$3;
4227: $pattern=$1;
4228: if ($ip =~ /^\Q$pattern\E/) {
4229: my $last=(split(/\./,$ip))[3];
4230: if ($last <=$high && $last >=$low) { $allowed=1; }
4231: }
4232: } elsif ($pattern =~ /^\*/) {
4233: #*.msu.edu
4234: $pattern=~s/\*//;
4235: if (!defined($name)) {
4236: use Socket;
4237: my $netaddr=inet_aton($ip);
4238: ($name)=gethostbyaddr($netaddr,AF_INET);
4239: }
4240: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4241: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
4242: #127.0.0.1
4243: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4244: } else {
4245: #some.name.com
4246: if (!defined($name)) {
4247: use Socket;
4248: my $netaddr=inet_aton($ip);
4249: ($name)=gethostbyaddr($netaddr,AF_INET);
4250: }
4251: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4252: }
4253: if ($allowed) { last; }
4254: }
4255: return $allowed;
4256: }
4257:
4258: ###############################################
4259:
1.60 matthew 4260: =pod
4261:
1.112 bowersj2 4262: =head1 Domain Template Functions
4263:
4264: =over 4
4265:
4266: =item * &determinedomain()
1.60 matthew 4267:
4268: Inputs: $domain (usually will be undef)
4269:
1.63 www 4270: Returns: Determines which domain should be used for designs
1.60 matthew 4271:
4272: =cut
1.54 www 4273:
1.60 matthew 4274: ###############################################
1.63 www 4275: sub determinedomain {
4276: my $domain=shift;
1.531 albertel 4277: if (! $domain) {
1.60 matthew 4278: # Determine domain if we have not been given one
1.893 raeburn 4279: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 4280: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
4281: if ($env{'request.role.domain'}) {
4282: $domain=$env{'request.role.domain'};
1.60 matthew 4283: }
4284: }
1.63 www 4285: return $domain;
4286: }
4287: ###############################################
1.517 raeburn 4288:
1.518 albertel 4289: sub devalidate_domconfig_cache {
4290: my ($udom)=@_;
4291: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
4292: }
4293:
4294: # ---------------------- Get domain configuration for a domain
4295: sub get_domainconf {
4296: my ($udom) = @_;
4297: my $cachetime=1800;
4298: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
4299: if (defined($cached)) { return %{$result}; }
4300:
4301: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 4302: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 4303: my (%designhash,%legacy);
1.518 albertel 4304: if (keys(%domconfig) > 0) {
4305: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 4306: if (keys(%{$domconfig{'login'}})) {
4307: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 4308: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.946 raeburn 4309: if ($key eq 'loginvia') {
4310: if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') {
4311: my @ids = &Apache::lonnet::current_machine_ids();
4312: foreach my $hostname (@ids) {
1.948 raeburn 4313: if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') {
4314: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
4315: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
4316: $designhash{$udom.'.login.loginvia'} = $server;
4317: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
4318:
4319: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
4320: } else {
4321: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
4322: }
4323: if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) {
4324: $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'};
4325: }
1.946 raeburn 4326: }
4327: }
4328: }
4329: }
4330: } else {
4331: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
4332: $designhash{$udom.'.login.'.$key.'_'.$img} =
4333: $domconfig{'login'}{$key}{$img};
4334: }
1.699 raeburn 4335: }
4336: } else {
4337: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
4338: }
1.632 raeburn 4339: }
4340: } else {
4341: $legacy{'login'} = 1;
1.518 albertel 4342: }
1.632 raeburn 4343: } else {
4344: $legacy{'login'} = 1;
1.518 albertel 4345: }
4346: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 4347: if (keys(%{$domconfig{'rolecolors'}})) {
4348: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
4349: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
4350: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
4351: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
4352: }
1.518 albertel 4353: }
4354: }
1.632 raeburn 4355: } else {
4356: $legacy{'rolecolors'} = 1;
1.518 albertel 4357: }
1.632 raeburn 4358: } else {
4359: $legacy{'rolecolors'} = 1;
1.518 albertel 4360: }
1.948 raeburn 4361: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
4362: if ($domconfig{'autoenroll'}{'co-owners'}) {
4363: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
4364: }
4365: }
1.632 raeburn 4366: if (keys(%legacy) > 0) {
4367: my %legacyhash = &get_legacy_domconf($udom);
4368: foreach my $item (keys(%legacyhash)) {
4369: if ($item =~ /^\Q$udom\E\.login/) {
4370: if ($legacy{'login'}) {
4371: $designhash{$item} = $legacyhash{$item};
4372: }
4373: } else {
4374: if ($legacy{'rolecolors'}) {
4375: $designhash{$item} = $legacyhash{$item};
4376: }
1.518 albertel 4377: }
4378: }
4379: }
1.632 raeburn 4380: } else {
4381: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4382: }
4383: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4384: $cachetime);
4385: return %designhash;
4386: }
4387:
1.632 raeburn 4388: sub get_legacy_domconf {
4389: my ($udom) = @_;
4390: my %legacyhash;
4391: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4392: my $designfile = $designdir.'/'.$udom.'.tab';
4393: if (-e $designfile) {
4394: if ( open (my $fh,"<$designfile") ) {
4395: while (my $line = <$fh>) {
4396: next if ($line =~ /^\#/);
4397: chomp($line);
4398: my ($key,$val)=(split(/\=/,$line));
4399: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4400: }
4401: close($fh);
4402: }
4403: }
4404: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
4405: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4406: }
4407: return %legacyhash;
4408: }
4409:
1.63 www 4410: =pod
4411:
1.112 bowersj2 4412: =item * &domainlogo()
1.63 www 4413:
4414: Inputs: $domain (usually will be undef)
4415:
4416: Returns: A link to a domain logo, if the domain logo exists.
4417: If the domain logo does not exist, a description of the domain.
4418:
4419: =cut
1.112 bowersj2 4420:
1.63 www 4421: ###############################################
4422: sub domainlogo {
1.517 raeburn 4423: my $domain = &determinedomain(shift);
1.518 albertel 4424: my %designhash = &get_domainconf($domain);
1.517 raeburn 4425: # See if there is a logo
4426: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4427: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4428: if ($imgsrc =~ m{^/(adm|res)/}) {
4429: if ($imgsrc =~ m{^/res/}) {
4430: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4431: &Apache::lonnet::repcopy($local_name);
4432: }
4433: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4434: }
4435: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4436: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4437: return &Apache::lonnet::domain($domain,'description');
1.59 www 4438: } else {
1.60 matthew 4439: return '';
1.59 www 4440: }
4441: }
1.63 www 4442: ##############################################
4443:
4444: =pod
4445:
1.112 bowersj2 4446: =item * &designparm()
1.63 www 4447:
4448: Inputs: $which parameter; $domain (usually will be undef)
4449:
4450: Returns: value of designparamter $which
4451:
4452: =cut
1.112 bowersj2 4453:
1.397 albertel 4454:
1.400 albertel 4455: ##############################################
1.397 albertel 4456: sub designparm {
4457: my ($which,$domain)=@_;
4458: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 4459: return $env{'environment.color.'.$which};
1.96 www 4460: }
1.63 www 4461: $domain=&determinedomain($domain);
1.518 albertel 4462: my %domdesign = &get_domainconf($domain);
1.520 raeburn 4463: my $output;
1.517 raeburn 4464: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 4465: $output = $domdesign{$domain.'.'.$which};
1.63 www 4466: } else {
1.520 raeburn 4467: $output = $defaultdesign{$which};
4468: }
4469: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4470: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4471: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 4472: if ($output =~ m{^/res/}) {
4473: my $local_name = &Apache::lonnet::filelocation('',$output);
4474: &Apache::lonnet::repcopy($local_name);
4475: }
1.520 raeburn 4476: $output = &lonhttpdurl($output);
4477: }
1.63 www 4478: }
1.520 raeburn 4479: return $output;
1.63 www 4480: }
1.59 www 4481:
1.822 bisitz 4482: ##############################################
4483: =pod
4484:
1.832 bisitz 4485: =item * &authorspace()
4486:
4487: Inputs: ./.
4488:
4489: Returns: Path to the Construction Space of the current user's
4490: accessed author space
4491: The author space will be that of the current user
4492: when accessing the own author space
4493: and that of the co-author/assistent co-author
4494: when accessing the co-author's/assistent co-author's
4495: space
4496:
4497: =cut
4498:
4499: sub authorspace {
4500: my $caname = '';
4501: if ($env{'request.role'} =~ /^ca|^aa/) {
4502: (undef,$caname) =
4503: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
4504: } else {
4505: $caname = $env{'user.name'};
4506: }
4507: return '/priv/'.$caname.'/';
4508: }
4509:
4510: ##############################################
4511: =pod
4512:
1.822 bisitz 4513: =item * &head_subbox()
4514:
4515: Inputs: $content (contains HTML code with page functions, etc.)
4516:
4517: Returns: HTML div with $content
4518: To be included in page header
4519:
4520: =cut
4521:
4522: sub head_subbox {
4523: my ($content)=@_;
4524: my $output =
1.993 raeburn 4525: '<div class="LC_head_subbox">'
1.822 bisitz 4526: .$content
4527: .'</div>'
4528: }
4529:
4530: ##############################################
4531: =pod
4532:
4533: =item * &CSTR_pageheader()
4534:
4535: Inputs: ./.
4536:
4537: Returns: HTML div with CSTR path and recent box
4538: To be included on Construction Space pages
4539:
4540: =cut
4541:
4542: sub CSTR_pageheader {
4543: # this is for resources; directories have customtitle, and crumbs
4544: # and select recent are created in lonpubdir.pm
4545: my ($uname,$thisdisfn)=
4546: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
4547: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4548: $formaction=~s/\/+/\//g;
4549:
4550: my $parentpath = '';
4551: my $lastitem = '';
4552: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4553: $parentpath = $1;
4554: $lastitem = $2;
4555: } else {
4556: $lastitem = $thisdisfn;
4557: }
1.921 bisitz 4558:
4559: my $output =
1.822 bisitz 4560: '<div>'
4561: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
4562: .'<b>'.&mt('Construction Space:').'</b> '
4563: .'<form name="dirs" method="post" action="'.$formaction
1.921 bisitz 4564: .'" target="_top">' #FIXME lonpubdir: target="_parent"
4565: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv',undef,undef);
4566:
4567: if ($lastitem) {
4568: $output .=
4569: '<span class="LC_filename">'
4570: .$lastitem
4571: .'</span>';
4572: }
4573: $output .=
4574: '<br />'
1.822 bisitz 4575: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
4576: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4577: .'</form>'
4578: .&Apache::lonmenu::constspaceform()
4579: .'</div>';
1.921 bisitz 4580:
4581: return $output;
1.822 bisitz 4582: }
4583:
1.60 matthew 4584: ###############################################
4585: ###############################################
4586:
4587: =pod
4588:
1.112 bowersj2 4589: =back
4590:
1.549 albertel 4591: =head1 HTML Helpers
1.112 bowersj2 4592:
4593: =over 4
4594:
4595: =item * &bodytag()
1.60 matthew 4596:
4597: Returns a uniform header for LON-CAPA web pages.
4598:
4599: Inputs:
4600:
1.112 bowersj2 4601: =over 4
4602:
4603: =item * $title, A title to be displayed on the page.
4604:
4605: =item * $function, the current role (can be undef).
4606:
4607: =item * $addentries, extra parameters for the <body> tag.
4608:
4609: =item * $bodyonly, if defined, only return the <body> tag.
4610:
4611: =item * $domain, if defined, force a given domain.
4612:
4613: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4614: text interface only)
1.60 matthew 4615:
1.814 bisitz 4616: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
4617: navigational links
1.317 albertel 4618:
1.338 albertel 4619: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4620:
1.460 albertel 4621: =item * $args, optional argument valid values are
4622: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4623: inherit_jsmath -> when creating popup window in a page,
4624: should it have jsmath forced on by the
4625: current page
1.460 albertel 4626:
1.112 bowersj2 4627: =back
4628:
1.60 matthew 4629: Returns: A uniform header for LON-CAPA web pages.
4630: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4631: If $bodyonly is undef or zero, an html string containing a <body> tag and
4632: other decorations will be returned.
4633:
4634: =cut
4635:
1.54 www 4636: sub bodytag {
1.831 bisitz 4637: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.962 droeschl 4638: $no_nav_bar,$bgcolor,$args)=@_;
1.339 albertel 4639:
1.954 raeburn 4640: my $public;
4641: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
4642: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
4643: $public = 1;
4644: }
1.460 albertel 4645: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4646:
1.183 matthew 4647: $function = &get_users_function() if (!$function);
1.339 albertel 4648: my $img = &designparm($function.'.img',$domain);
4649: my $font = &designparm($function.'.font',$domain);
4650: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4651:
1.803 bisitz 4652: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 4653: 'bgcolor' => $pgbg,
1.339 albertel 4654: 'text' => $font,
4655: 'alink' => &designparm($function.'.alink',$domain),
4656: 'vlink' => &designparm($function.'.vlink',$domain),
4657: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4658: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4659:
1.63 www 4660: # role and realm
1.378 raeburn 4661: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4662: if ($role eq 'ca') {
1.479 albertel 4663: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4664: $realm = &plainname($rname,$rdom);
1.378 raeburn 4665: }
1.55 www 4666: # realm
1.258 albertel 4667: if ($env{'request.course.id'}) {
1.378 raeburn 4668: if ($env{'request.role'} !~ /^cr/) {
4669: $role = &Apache::lonnet::plaintext($role,&course_type());
4670: }
1.898 raeburn 4671: if ($env{'request.course.sec'}) {
4672: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
4673: }
1.359 albertel 4674: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4675: } else {
4676: $role = &Apache::lonnet::plaintext($role);
1.54 www 4677: }
1.433 albertel 4678:
1.359 albertel 4679: if (!$realm) { $realm=' '; }
1.330 albertel 4680:
1.438 albertel 4681: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4682:
1.101 www 4683: # construct main body tag
1.359 albertel 4684: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4685: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4686:
1.530 albertel 4687: if ($bodyonly) {
1.60 matthew 4688: return $bodytag;
1.798 tempelho 4689: }
1.359 albertel 4690:
1.410 albertel 4691: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.954 raeburn 4692: if ($public) {
1.433 albertel 4693: undef($role);
1.434 albertel 4694: } else {
4695: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4696: }
1.359 albertel 4697:
1.762 bisitz 4698: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 4699: #
4700: # Extra info if you are the DC
4701: my $dc_info = '';
4702: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4703: $env{'course.'.$env{'request.course.id'}.
4704: '.domain'}.'/'})) {
4705: my $cid = $env{'request.course.id'};
1.917 raeburn 4706: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4707: $dc_info =~ s/\s+$//;
1.359 albertel 4708: }
4709:
1.898 raeburn 4710: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853 droeschl 4711: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
4712:
1.916 droeschl 4713: if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') {
4714: return $bodytag;
4715: }
1.903 droeschl 4716:
4717: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
4718:
4719: # if ($env{'request.state'} eq 'construct') {
4720: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
4721: # }
4722:
1.359 albertel 4723:
4724:
1.916 droeschl 4725: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917 raeburn 4726: if ($dc_info) {
4727: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
4728: }
1.916 droeschl 4729: $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
4730: <em>$realm</em> $dc_info</div>|;
1.903 droeschl 4731: return $bodytag;
4732: }
1.894 droeschl 4733:
1.927 raeburn 4734: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
4735: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
4736: }
1.916 droeschl 4737:
1.903 droeschl 4738: $bodytag .= Apache::lonhtmlcommon::scripttag(
4739: Apache::lonmenu::utilityfunctions(), 'start');
1.816 bisitz 4740:
1.903 droeschl 4741: $bodytag .= Apache::lonmenu::primary_menu();
1.852 droeschl 4742:
1.917 raeburn 4743: if ($dc_info) {
4744: $dc_info = &dc_courseid_toggle($dc_info);
4745: }
4746: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 4747:
1.903 droeschl 4748: #don't show menus for public users
1.954 raeburn 4749: if (!$public){
1.903 droeschl 4750: $bodytag .= Apache::lonmenu::secondary_menu();
4751: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 4752: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
4753: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 4754: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.920 raeburn 4755: $args->{'bread_crumbs'});
4756: } elsif ($forcereg) {
4757: $bodytag .= &Apache::lonmenu::innerregister($forcereg);
4758: }
1.903 droeschl 4759: }else{
4760: # this is to seperate menu from content when there's no secondary
4761: # menu. Especially needed for public accessible ressources.
4762: $bodytag .= '<hr style="clear:both" />';
4763: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 4764: }
1.903 droeschl 4765:
1.235 raeburn 4766: return $bodytag;
1.182 matthew 4767: }
4768:
1.917 raeburn 4769: sub dc_courseid_toggle {
4770: my ($dc_info) = @_;
1.980 raeburn 4771: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.917 raeburn 4772: '<a href="javascript:showCourseID();">'.
4773: &mt('(More ...)').'</a></span>'.
4774: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
4775: }
4776:
1.330 albertel 4777: sub make_attr_string {
4778: my ($register,$attr_ref) = @_;
4779:
4780: if ($attr_ref && !ref($attr_ref)) {
4781: die("addentries Must be a hash ref ".
4782: join(':',caller(1))." ".
4783: join(':',caller(0))." ");
4784: }
4785:
4786: if ($register) {
1.339 albertel 4787: my ($on_load,$on_unload);
4788: foreach my $key (keys(%{$attr_ref})) {
4789: if (lc($key) eq 'onload') {
4790: $on_load.=$attr_ref->{$key}.';';
4791: delete($attr_ref->{$key});
4792:
4793: } elsif (lc($key) eq 'onunload') {
4794: $on_unload.=$attr_ref->{$key}.';';
4795: delete($attr_ref->{$key});
4796: }
4797: }
1.953 droeschl 4798: $attr_ref->{'onload'} = $on_load;
4799: $attr_ref->{'onunload'}= $on_unload;
1.330 albertel 4800: }
1.339 albertel 4801:
1.330 albertel 4802: my $attr_string;
4803: foreach my $attr (keys(%$attr_ref)) {
4804: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4805: }
4806: return $attr_string;
4807: }
4808:
4809:
1.182 matthew 4810: ###############################################
1.251 albertel 4811: ###############################################
4812:
4813: =pod
4814:
4815: =item * &endbodytag()
4816:
4817: Returns a uniform footer for LON-CAPA web pages.
4818:
1.635 raeburn 4819: Inputs: 1 - optional reference to an args hash
4820: If in the hash, key for noredirectlink has a value which evaluates to true,
4821: a 'Continue' link is not displayed if the page contains an
4822: internal redirect in the <head></head> section,
4823: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4824:
4825: =cut
4826:
4827: sub endbodytag {
1.635 raeburn 4828: my ($args) = @_;
1.251 albertel 4829: my $endbodytag='</body>';
1.269 albertel 4830: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4831: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4832: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4833: $endbodytag=
4834: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4835: &mt('Continue').'</a>'.
4836: $endbodytag;
4837: }
1.315 albertel 4838: }
1.251 albertel 4839: return $endbodytag;
4840: }
4841:
1.352 albertel 4842: =pod
4843:
4844: =item * &standard_css()
4845:
4846: Returns a style sheet
4847:
4848: Inputs: (all optional)
4849: domain -> force to color decorate a page for a specific
4850: domain
4851: function -> force usage of a specific rolish color scheme
4852: bgcolor -> override the default page bgcolor
4853:
4854: =cut
4855:
1.343 albertel 4856: sub standard_css {
1.345 albertel 4857: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4858: $function = &get_users_function() if (!$function);
4859: my $img = &designparm($function.'.img', $domain);
4860: my $tabbg = &designparm($function.'.tabbg', $domain);
4861: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 4862: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 4863: #second colour for later usage
1.345 albertel 4864: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4865: my $pgbg_or_bgcolor =
4866: $bgcolor ||
1.352 albertel 4867: &designparm($function.'.pgbg', $domain);
1.382 albertel 4868: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4869: my $alink = &designparm($function.'.alink', $domain);
4870: my $vlink = &designparm($function.'.vlink', $domain);
4871: my $link = &designparm($function.'.link', $domain);
4872:
1.602 albertel 4873: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4874: my $mono = 'monospace';
1.850 bisitz 4875: my $data_table_head = $sidebg;
4876: my $data_table_light = '#FAFAFA';
4877: my $data_table_dark = '#F0F0F0';
1.470 banghart 4878: my $data_table_darker = '#CCCCCC';
1.349 albertel 4879: my $data_table_highlight = '#FFFF00';
1.352 albertel 4880: my $mail_new = '#FFBB77';
4881: my $mail_new_hover = '#DD9955';
4882: my $mail_read = '#BBBB77';
4883: my $mail_read_hover = '#999944';
4884: my $mail_replied = '#AAAA88';
4885: my $mail_replied_hover = '#888855';
4886: my $mail_other = '#99BBBB';
4887: my $mail_other_hover = '#669999';
1.391 albertel 4888: my $table_header = '#DDDDDD';
1.489 raeburn 4889: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 4890: my $lg_border_color = '#C8C8C8';
1.952 onken 4891: my $button_hover = '#BF2317';
1.392 albertel 4892:
1.608 albertel 4893: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 4894: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
4895: : '0 3px 0 4px';
1.448 albertel 4896:
1.523 albertel 4897:
1.343 albertel 4898: return <<END;
1.947 droeschl 4899:
4900: /* needed for iframe to allow 100% height in FF */
4901: body, html {
4902: margin: 0;
4903: padding: 0 0.5%;
4904: height: 99%; /* to avoid scrollbars */
4905: }
4906:
1.795 www 4907: body {
1.911 bisitz 4908: font-family: $sans;
4909: line-height:130%;
4910: font-size:0.83em;
4911: color:$font;
1.795 www 4912: }
4913:
1.959 onken 4914: a:focus,
4915: a:focus img {
1.795 www 4916: color: red;
1.911 bisitz 4917: background: yellow;
1.795 www 4918: }
1.698 harmsja 4919:
1.911 bisitz 4920: form, .inline {
4921: display: inline;
1.795 www 4922: }
1.721 harmsja 4923:
1.795 www 4924: .LC_right {
1.911 bisitz 4925: text-align:right;
1.795 www 4926: }
4927:
4928: .LC_middle {
1.911 bisitz 4929: vertical-align:middle;
1.795 www 4930: }
1.721 harmsja 4931:
1.911 bisitz 4932: .LC_400Box {
4933: width:400px;
4934: }
1.721 harmsja 4935:
1.947 droeschl 4936: .LC_iframecontainer {
4937: width: 98%;
4938: margin: 0;
4939: position: fixed;
4940: top: 8.5em;
4941: bottom: 0;
4942: }
4943:
4944: .LC_iframecontainer iframe{
4945: border: none;
4946: width: 100%;
4947: height: 100%;
4948: }
4949:
1.778 bisitz 4950: .LC_filename {
4951: font-family: $mono;
4952: white-space:pre;
1.921 bisitz 4953: font-size: 120%;
1.778 bisitz 4954: }
4955:
4956: .LC_fileicon {
4957: border: none;
4958: height: 1.3em;
4959: vertical-align: text-bottom;
4960: margin-right: 0.3em;
4961: text-decoration:none;
4962: }
4963:
1.350 albertel 4964: .LC_error {
4965: color: red;
4966: font-size: larger;
4967: }
1.795 www 4968:
1.457 albertel 4969: .LC_warning,
4970: .LC_diff_removed {
1.733 bisitz 4971: color: red;
1.394 albertel 4972: }
1.532 albertel 4973:
4974: .LC_info,
1.457 albertel 4975: .LC_success,
4976: .LC_diff_added {
1.350 albertel 4977: color: green;
4978: }
1.795 www 4979:
1.802 bisitz 4980: div.LC_confirm_box {
4981: background-color: #FAFAFA;
4982: border: 1px solid $lg_border_color;
4983: margin-right: 0;
4984: padding: 5px;
4985: }
4986:
4987: div.LC_confirm_box .LC_error img,
4988: div.LC_confirm_box .LC_success img {
4989: vertical-align: middle;
4990: }
4991:
1.440 albertel 4992: .LC_icon {
1.771 droeschl 4993: border: none;
1.790 droeschl 4994: vertical-align: middle;
1.771 droeschl 4995: }
4996:
1.543 albertel 4997: .LC_docs_spacer {
4998: width: 25px;
4999: height: 1px;
1.771 droeschl 5000: border: none;
1.543 albertel 5001: }
1.346 albertel 5002:
1.532 albertel 5003: .LC_internal_info {
1.735 bisitz 5004: color: #999999;
1.532 albertel 5005: }
5006:
1.794 www 5007: .LC_discussion {
1.911 bisitz 5008: background: $tabbg;
5009: border: 1px solid black;
5010: margin: 2px;
1.794 www 5011: }
5012:
5013: .LC_disc_action_links_bar {
1.911 bisitz 5014: background: $tabbg;
5015: border: none;
5016: margin: 4px;
1.794 www 5017: }
5018:
5019: .LC_disc_action_left {
1.911 bisitz 5020: text-align: left;
1.794 www 5021: }
5022:
5023: .LC_disc_action_right {
1.911 bisitz 5024: text-align: right;
1.794 www 5025: }
5026:
5027: .LC_disc_new_item {
1.911 bisitz 5028: background: white;
5029: border: 2px solid red;
5030: margin: 2px;
1.794 www 5031: }
5032:
5033: .LC_disc_old_item {
1.911 bisitz 5034: background: white;
5035: border: 1px solid black;
5036: margin: 2px;
1.794 www 5037: }
5038:
1.458 albertel 5039: table.LC_pastsubmission {
5040: border: 1px solid black;
5041: margin: 2px;
5042: }
5043:
1.924 bisitz 5044: table#LC_menubuttons {
1.345 albertel 5045: width: 100%;
5046: background: $pgbg;
1.392 albertel 5047: border: 2px;
1.402 albertel 5048: border-collapse: separate;
1.803 bisitz 5049: padding: 0;
1.345 albertel 5050: }
1.392 albertel 5051:
1.801 tempelho 5052: table#LC_title_bar a {
5053: color: $fontmenu;
5054: }
1.836 bisitz 5055:
1.807 droeschl 5056: table#LC_title_bar {
1.819 tempelho 5057: clear: both;
1.836 bisitz 5058: display: none;
1.807 droeschl 5059: }
5060:
1.795 www 5061: table#LC_title_bar,
1.933 droeschl 5062: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 5063: table#LC_title_bar.LC_with_remote {
1.359 albertel 5064: width: 100%;
1.392 albertel 5065: border-color: $pgbg;
5066: border-style: solid;
5067: border-width: $border;
1.379 albertel 5068: background: $pgbg;
1.801 tempelho 5069: color: $fontmenu;
1.392 albertel 5070: border-collapse: collapse;
1.803 bisitz 5071: padding: 0;
1.819 tempelho 5072: margin: 0;
1.359 albertel 5073: }
1.795 www 5074:
1.933 droeschl 5075: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 5076: margin: 0;
5077: padding: 0;
1.933 droeschl 5078: position: relative;
5079: list-style: none;
1.913 droeschl 5080: }
1.933 droeschl 5081: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 5082: display: inline;
5083: }
1.933 droeschl 5084:
5085: .LC_breadcrumb_tools_navigation {
1.913 droeschl 5086: padding: 0;
1.933 droeschl 5087: margin: 0;
5088: float: left;
1.913 droeschl 5089: }
1.933 droeschl 5090: .LC_breadcrumb_tools_tools {
5091: padding: 0;
5092: margin: 0;
1.913 droeschl 5093: float: right;
5094: }
5095:
1.359 albertel 5096: table#LC_title_bar td {
5097: background: $tabbg;
5098: }
1.795 www 5099:
1.911 bisitz 5100: table#LC_menubuttons img {
1.803 bisitz 5101: border: none;
1.346 albertel 5102: }
1.795 www 5103:
1.842 droeschl 5104: .LC_breadcrumbs_component {
1.911 bisitz 5105: float: right;
5106: margin: 0 1em;
1.357 albertel 5107: }
1.842 droeschl 5108: .LC_breadcrumbs_component img {
1.911 bisitz 5109: vertical-align: middle;
1.777 tempelho 5110: }
1.795 www 5111:
1.383 albertel 5112: td.LC_table_cell_checkbox {
5113: text-align: center;
5114: }
1.795 www 5115:
5116: .LC_fontsize_small {
1.911 bisitz 5117: font-size: 70%;
1.705 tempelho 5118: }
5119:
1.844 bisitz 5120: #LC_breadcrumbs {
1.911 bisitz 5121: clear:both;
5122: background: $sidebg;
5123: border-bottom: 1px solid $lg_border_color;
5124: line-height: 2.5em;
1.933 droeschl 5125: overflow: hidden;
1.911 bisitz 5126: margin: 0;
5127: padding: 0;
1.995 raeburn 5128: text-align: left;
1.819 tempelho 5129: }
1.862 bisitz 5130:
1.993 raeburn 5131: .LC_head_subbox {
1.911 bisitz 5132: clear:both;
5133: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 5134: border: 1px solid $sidebg;
5135: margin: 0 0 10px 0;
1.966 bisitz 5136: padding: 3px;
1.995 raeburn 5137: text-align: left;
1.822 bisitz 5138: }
5139:
1.795 www 5140: .LC_fontsize_medium {
1.911 bisitz 5141: font-size: 85%;
1.705 tempelho 5142: }
5143:
1.795 www 5144: .LC_fontsize_large {
1.911 bisitz 5145: font-size: 120%;
1.705 tempelho 5146: }
5147:
1.346 albertel 5148: .LC_menubuttons_inline_text {
5149: color: $font;
1.698 harmsja 5150: font-size: 90%;
1.701 harmsja 5151: padding-left:3px;
1.346 albertel 5152: }
5153:
1.934 droeschl 5154: .LC_menubuttons_inline_text img{
5155: vertical-align: middle;
5156: }
5157:
1.951 onken 5158: li.LC_menubuttons_inline_text img,a {
5159: cursor:pointer;
1.1002 droeschl 5160: text-decoration: none;
1.951 onken 5161: }
5162:
1.526 www 5163: .LC_menubuttons_link {
5164: text-decoration: none;
5165: }
1.795 www 5166:
1.522 albertel 5167: .LC_menubuttons_category {
1.521 www 5168: color: $font;
1.526 www 5169: background: $pgbg;
1.521 www 5170: font-size: larger;
5171: font-weight: bold;
5172: }
5173:
1.346 albertel 5174: td.LC_menubuttons_text {
1.911 bisitz 5175: color: $font;
1.346 albertel 5176: }
1.706 harmsja 5177:
1.346 albertel 5178: .LC_current_location {
5179: background: $tabbg;
5180: }
1.795 www 5181:
1.938 bisitz 5182: table.LC_data_table {
1.347 albertel 5183: border: 1px solid #000000;
1.402 albertel 5184: border-collapse: separate;
1.426 albertel 5185: border-spacing: 1px;
1.610 albertel 5186: background: $pgbg;
1.347 albertel 5187: }
1.795 www 5188:
1.422 albertel 5189: .LC_data_table_dense {
5190: font-size: small;
5191: }
1.795 www 5192:
1.507 raeburn 5193: table.LC_nested_outer {
5194: border: 1px solid #000000;
1.589 raeburn 5195: border-collapse: collapse;
1.803 bisitz 5196: border-spacing: 0;
1.507 raeburn 5197: width: 100%;
5198: }
1.795 www 5199:
1.879 raeburn 5200: table.LC_innerpickbox,
1.507 raeburn 5201: table.LC_nested {
1.803 bisitz 5202: border: none;
1.589 raeburn 5203: border-collapse: collapse;
1.803 bisitz 5204: border-spacing: 0;
1.507 raeburn 5205: width: 100%;
5206: }
1.795 www 5207:
1.930 faziophi 5208: .ui-accordion,
5209: .ui-accordion table.LC_data_table,
5210: .ui-accordion table.LC_nested_outer{
5211: border: 0px;
5212: border-spacing: 0px;
5213: margin: 3px;
5214: }
5215:
1.911 bisitz 5216: table.LC_data_table tr th,
5217: table.LC_calendar tr th,
1.879 raeburn 5218: table.LC_prior_tries tr th,
5219: table.LC_innerpickbox tr th {
1.349 albertel 5220: font-weight: bold;
5221: background-color: $data_table_head;
1.801 tempelho 5222: color:$fontmenu;
1.701 harmsja 5223: font-size:90%;
1.347 albertel 5224: }
1.795 www 5225:
1.879 raeburn 5226: table.LC_innerpickbox tr th,
5227: table.LC_innerpickbox tr td {
5228: vertical-align: top;
5229: }
5230:
1.711 raeburn 5231: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 5232: background-color: #CCCCCC;
1.711 raeburn 5233: font-weight: bold;
5234: text-align: left;
5235: }
1.795 www 5236:
1.912 bisitz 5237: table.LC_data_table tr.LC_odd_row > td {
5238: background-color: $data_table_light;
5239: padding: 2px;
5240: vertical-align: top;
5241: }
5242:
1.809 bisitz 5243: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 5244: background-color: $data_table_light;
1.912 bisitz 5245: vertical-align: top;
5246: }
5247:
5248: table.LC_data_table tr.LC_even_row > td {
5249: background-color: $data_table_dark;
1.425 albertel 5250: padding: 2px;
1.900 bisitz 5251: vertical-align: top;
1.347 albertel 5252: }
1.795 www 5253:
1.809 bisitz 5254: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 5255: background-color: $data_table_dark;
1.900 bisitz 5256: vertical-align: top;
1.347 albertel 5257: }
1.795 www 5258:
1.425 albertel 5259: table.LC_data_table tr.LC_data_table_highlight td {
5260: background-color: $data_table_darker;
5261: }
1.795 www 5262:
1.639 raeburn 5263: table.LC_data_table tr td.LC_leftcol_header {
5264: background-color: $data_table_head;
5265: font-weight: bold;
5266: }
1.795 www 5267:
1.451 albertel 5268: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5269: table.LC_nested tr.LC_empty_row td {
1.421 albertel 5270: font-weight: bold;
5271: font-style: italic;
5272: text-align: center;
5273: padding: 8px;
1.347 albertel 5274: }
1.795 www 5275:
1.940 bisitz 5276: table.LC_data_table tr.LC_empty_row td {
5277: background-color: $sidebg;
5278: }
5279:
5280: table.LC_nested tr.LC_empty_row td {
5281: background-color: #FFFFFF;
5282: }
5283:
1.890 droeschl 5284: table.LC_caption {
5285: }
5286:
1.507 raeburn 5287: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5288: padding: 4ex
5289: }
1.795 www 5290:
1.507 raeburn 5291: table.LC_nested_outer tr th {
5292: font-weight: bold;
1.801 tempelho 5293: color:$fontmenu;
1.507 raeburn 5294: background-color: $data_table_head;
1.701 harmsja 5295: font-size: small;
1.507 raeburn 5296: border-bottom: 1px solid #000000;
5297: }
1.795 www 5298:
1.507 raeburn 5299: table.LC_nested_outer tr td.LC_subheader {
5300: background-color: $data_table_head;
5301: font-weight: bold;
5302: font-size: small;
5303: border-bottom: 1px solid #000000;
5304: text-align: right;
1.451 albertel 5305: }
1.795 www 5306:
1.507 raeburn 5307: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5308: background-color: #CCCCCC;
1.451 albertel 5309: font-weight: bold;
5310: font-size: small;
1.507 raeburn 5311: text-align: center;
5312: }
1.795 www 5313:
1.589 raeburn 5314: table.LC_nested tr.LC_info_row td.LC_left_item,
5315: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5316: text-align: left;
1.451 albertel 5317: }
1.795 www 5318:
1.507 raeburn 5319: table.LC_nested td {
1.735 bisitz 5320: background-color: #FFFFFF;
1.451 albertel 5321: font-size: small;
1.507 raeburn 5322: }
1.795 www 5323:
1.507 raeburn 5324: table.LC_nested_outer tr th.LC_right_item,
5325: table.LC_nested tr.LC_info_row td.LC_right_item,
5326: table.LC_nested tr.LC_odd_row td.LC_right_item,
5327: table.LC_nested tr td.LC_right_item {
1.451 albertel 5328: text-align: right;
5329: }
5330:
1.930 faziophi 5331: .ui-accordion table.LC_nested tr.LC_odd_row td.LC_left_item,
5332: .ui-accordion table.LC_nested tr.LC_even_row td.LC_left_item {
5333: text-align: right;
5334: width: 40%;
5335: padding-right:10px;
5336: vertical-align: top;
5337: padding: 5px;
5338: }
5339:
5340: .ui-accordion table.LC_nested tr.LC_odd_row td.LC_right_item,
5341: .ui-accordion table.LC_nested tr.LC_even_row td.LC_right_item {
5342: text-align: left;
5343: width: 60%;
5344: padding: 2px 4px;
5345: }
5346:
1.507 raeburn 5347: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5348: background-color: #EEEEEE;
1.451 albertel 5349: }
5350:
1.473 raeburn 5351: table.LC_createuser {
5352: }
5353:
5354: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5355: font-size: small;
1.473 raeburn 5356: }
5357:
5358: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5359: background-color: #CCCCCC;
1.473 raeburn 5360: font-weight: bold;
5361: text-align: center;
5362: }
5363:
1.349 albertel 5364: table.LC_calendar {
5365: border: 1px solid #000000;
5366: border-collapse: collapse;
1.917 raeburn 5367: width: 98%;
1.349 albertel 5368: }
1.795 www 5369:
1.349 albertel 5370: table.LC_calendar_pickdate {
5371: font-size: xx-small;
5372: }
1.795 www 5373:
1.349 albertel 5374: table.LC_calendar tr td {
5375: border: 1px solid #000000;
5376: vertical-align: top;
1.917 raeburn 5377: width: 14%;
1.349 albertel 5378: }
1.795 www 5379:
1.349 albertel 5380: table.LC_calendar tr td.LC_calendar_day_empty {
5381: background-color: $data_table_dark;
5382: }
1.795 www 5383:
1.779 bisitz 5384: table.LC_calendar tr td.LC_calendar_day_current {
5385: background-color: $data_table_highlight;
1.777 tempelho 5386: }
1.795 www 5387:
1.938 bisitz 5388: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 5389: background-color: $mail_new;
5390: }
1.795 www 5391:
1.938 bisitz 5392: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 5393: background-color: $mail_new_hover;
5394: }
1.795 www 5395:
1.938 bisitz 5396: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 5397: background-color: $mail_read;
5398: }
1.795 www 5399:
1.938 bisitz 5400: /*
5401: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 5402: background-color: $mail_read_hover;
5403: }
1.938 bisitz 5404: */
1.795 www 5405:
1.938 bisitz 5406: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 5407: background-color: $mail_replied;
5408: }
1.795 www 5409:
1.938 bisitz 5410: /*
5411: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 5412: background-color: $mail_replied_hover;
5413: }
1.938 bisitz 5414: */
1.795 www 5415:
1.938 bisitz 5416: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 5417: background-color: $mail_other;
5418: }
1.795 www 5419:
1.938 bisitz 5420: /*
5421: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 5422: background-color: $mail_other_hover;
5423: }
1.938 bisitz 5424: */
1.494 raeburn 5425:
1.777 tempelho 5426: table.LC_data_table tr > td.LC_browser_file,
5427: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 5428: background: #AAEE77;
1.389 albertel 5429: }
1.795 www 5430:
1.777 tempelho 5431: table.LC_data_table tr > td.LC_browser_file_locked,
5432: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5433: background: #FFAA99;
1.387 albertel 5434: }
1.795 www 5435:
1.777 tempelho 5436: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 5437: background: #888888;
1.779 bisitz 5438: }
1.795 www 5439:
1.777 tempelho 5440: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5441: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 5442: background: #F8F866;
1.777 tempelho 5443: }
1.795 www 5444:
1.696 bisitz 5445: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 5446: background: #E0E8FF;
1.387 albertel 5447: }
1.696 bisitz 5448:
1.707 bisitz 5449: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 5450: /* background: #77FF77; */
1.707 bisitz 5451: }
1.795 www 5452:
1.707 bisitz 5453: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 5454: border-right: 8px solid #FFFF77;
1.707 bisitz 5455: }
1.795 www 5456:
1.707 bisitz 5457: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 5458: border-right: 8px solid #FFAA77;
1.707 bisitz 5459: }
1.795 www 5460:
1.707 bisitz 5461: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 5462: border-right: 8px solid #FF7777;
1.707 bisitz 5463: }
1.795 www 5464:
1.707 bisitz 5465: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 5466: border-right: 8px solid #AAFF77;
1.707 bisitz 5467: }
1.795 www 5468:
1.707 bisitz 5469: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 5470: border-right: 8px solid #11CC55;
1.707 bisitz 5471: }
5472:
1.388 albertel 5473: span.LC_current_location {
1.701 harmsja 5474: font-size:larger;
1.388 albertel 5475: background: $pgbg;
5476: }
1.387 albertel 5477:
1.395 albertel 5478: span.LC_parm_menu_item {
5479: font-size: larger;
5480: }
1.795 www 5481:
1.395 albertel 5482: span.LC_parm_scope_all {
5483: color: red;
5484: }
1.795 www 5485:
1.395 albertel 5486: span.LC_parm_scope_folder {
5487: color: green;
5488: }
1.795 www 5489:
1.395 albertel 5490: span.LC_parm_scope_resource {
5491: color: orange;
5492: }
1.795 www 5493:
1.395 albertel 5494: span.LC_parm_part {
5495: color: blue;
5496: }
1.795 www 5497:
1.911 bisitz 5498: span.LC_parm_folder,
5499: span.LC_parm_symb {
1.395 albertel 5500: font-size: x-small;
5501: font-family: $mono;
5502: color: #AAAAAA;
5503: }
5504:
1.977 bisitz 5505: ul.LC_parm_parmlist li {
5506: display: inline-block;
5507: padding: 0.3em 0.8em;
5508: vertical-align: top;
5509: width: 150px;
5510: border-top:1px solid $lg_border_color;
5511: }
5512:
1.795 www 5513: td.LC_parm_overview_level_menu,
5514: td.LC_parm_overview_map_menu,
5515: td.LC_parm_overview_parm_selectors,
5516: td.LC_parm_overview_restrictions {
1.396 albertel 5517: border: 1px solid black;
5518: border-collapse: collapse;
5519: }
1.795 www 5520:
1.396 albertel 5521: table.LC_parm_overview_restrictions td {
5522: border-width: 1px 4px 1px 4px;
5523: border-style: solid;
5524: border-color: $pgbg;
5525: text-align: center;
5526: }
1.795 www 5527:
1.396 albertel 5528: table.LC_parm_overview_restrictions th {
5529: background: $tabbg;
5530: border-width: 1px 4px 1px 4px;
5531: border-style: solid;
5532: border-color: $pgbg;
5533: }
1.795 www 5534:
1.398 albertel 5535: table#LC_helpmenu {
1.803 bisitz 5536: border: none;
1.398 albertel 5537: height: 55px;
1.803 bisitz 5538: border-spacing: 0;
1.398 albertel 5539: }
5540:
5541: table#LC_helpmenu fieldset legend {
5542: font-size: larger;
5543: }
1.795 www 5544:
1.397 albertel 5545: table#LC_helpmenu_links {
5546: width: 100%;
5547: border: 1px solid black;
5548: background: $pgbg;
1.803 bisitz 5549: padding: 0;
1.397 albertel 5550: border-spacing: 1px;
5551: }
1.795 www 5552:
1.397 albertel 5553: table#LC_helpmenu_links tr td {
5554: padding: 1px;
5555: background: $tabbg;
1.399 albertel 5556: text-align: center;
5557: font-weight: bold;
1.397 albertel 5558: }
1.396 albertel 5559:
1.795 www 5560: table#LC_helpmenu_links a:link,
5561: table#LC_helpmenu_links a:visited,
1.397 albertel 5562: table#LC_helpmenu_links a:active {
5563: text-decoration: none;
5564: color: $font;
5565: }
1.795 www 5566:
1.397 albertel 5567: table#LC_helpmenu_links a:hover {
5568: text-decoration: underline;
5569: color: $vlink;
5570: }
1.396 albertel 5571:
1.417 albertel 5572: .LC_chrt_popup_exists {
5573: border: 1px solid #339933;
5574: margin: -1px;
5575: }
1.795 www 5576:
1.417 albertel 5577: .LC_chrt_popup_up {
5578: border: 1px solid yellow;
5579: margin: -1px;
5580: }
1.795 www 5581:
1.417 albertel 5582: .LC_chrt_popup {
5583: border: 1px solid #8888FF;
5584: background: #CCCCFF;
5585: }
1.795 www 5586:
1.421 albertel 5587: table.LC_pick_box {
5588: border-collapse: separate;
5589: background: white;
5590: border: 1px solid black;
5591: border-spacing: 1px;
5592: }
1.795 www 5593:
1.421 albertel 5594: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 5595: background: $sidebg;
1.421 albertel 5596: font-weight: bold;
1.900 bisitz 5597: text-align: left;
1.740 bisitz 5598: vertical-align: top;
1.421 albertel 5599: width: 184px;
5600: padding: 8px;
5601: }
1.795 www 5602:
1.579 raeburn 5603: table.LC_pick_box td.LC_pick_box_value {
5604: text-align: left;
5605: padding: 8px;
5606: }
1.795 www 5607:
1.579 raeburn 5608: table.LC_pick_box td.LC_pick_box_select {
5609: text-align: left;
5610: padding: 8px;
5611: }
1.795 www 5612:
1.424 albertel 5613: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 5614: padding: 0;
1.421 albertel 5615: height: 1px;
5616: background: black;
5617: }
1.795 www 5618:
1.421 albertel 5619: table.LC_pick_box td.LC_pick_box_submit {
5620: text-align: right;
5621: }
1.795 www 5622:
1.579 raeburn 5623: table.LC_pick_box td.LC_evenrow_value {
5624: text-align: left;
5625: padding: 8px;
5626: background-color: $data_table_light;
5627: }
1.795 www 5628:
1.579 raeburn 5629: table.LC_pick_box td.LC_oddrow_value {
5630: text-align: left;
5631: padding: 8px;
5632: background-color: $data_table_light;
5633: }
1.795 www 5634:
1.579 raeburn 5635: span.LC_helpform_receipt_cat {
5636: font-weight: bold;
5637: }
1.795 www 5638:
1.424 albertel 5639: table.LC_group_priv_box {
5640: background: white;
5641: border: 1px solid black;
5642: border-spacing: 1px;
5643: }
1.795 www 5644:
1.424 albertel 5645: table.LC_group_priv_box td.LC_pick_box_title {
5646: background: $tabbg;
5647: font-weight: bold;
5648: text-align: right;
5649: width: 184px;
5650: }
1.795 www 5651:
1.424 albertel 5652: table.LC_group_priv_box td.LC_groups_fixed {
5653: background: $data_table_light;
5654: text-align: center;
5655: }
1.795 www 5656:
1.424 albertel 5657: table.LC_group_priv_box td.LC_groups_optional {
5658: background: $data_table_dark;
5659: text-align: center;
5660: }
1.795 www 5661:
1.424 albertel 5662: table.LC_group_priv_box td.LC_groups_functionality {
5663: background: $data_table_darker;
5664: text-align: center;
5665: font-weight: bold;
5666: }
1.795 www 5667:
1.424 albertel 5668: table.LC_group_priv td {
5669: text-align: left;
1.803 bisitz 5670: padding: 0;
1.424 albertel 5671: }
5672:
5673: .LC_navbuttons {
5674: margin: 2ex 0ex 2ex 0ex;
5675: }
1.795 www 5676:
1.423 albertel 5677: .LC_topic_bar {
5678: font-weight: bold;
5679: background: $tabbg;
1.918 wenzelju 5680: margin: 1em 0em 1em 2em;
1.805 bisitz 5681: padding: 3px;
1.918 wenzelju 5682: font-size: 1.2em;
1.423 albertel 5683: }
1.795 www 5684:
1.423 albertel 5685: .LC_topic_bar span {
1.918 wenzelju 5686: left: 0.5em;
5687: position: absolute;
1.423 albertel 5688: vertical-align: middle;
1.918 wenzelju 5689: font-size: 1.2em;
1.423 albertel 5690: }
1.795 www 5691:
1.423 albertel 5692: table.LC_course_group_status {
5693: margin: 20px;
5694: }
1.795 www 5695:
1.423 albertel 5696: table.LC_status_selector td {
5697: vertical-align: top;
5698: text-align: center;
1.424 albertel 5699: padding: 4px;
5700: }
1.795 www 5701:
1.599 albertel 5702: div.LC_feedback_link {
1.616 albertel 5703: clear: both;
1.829 kalberla 5704: background: $sidebg;
1.779 bisitz 5705: width: 100%;
1.829 kalberla 5706: padding-bottom: 10px;
5707: border: 1px $tabbg solid;
1.833 kalberla 5708: height: 22px;
5709: line-height: 22px;
5710: padding-top: 5px;
5711: }
5712:
5713: div.LC_feedback_link img {
5714: height: 22px;
1.867 kalberla 5715: vertical-align:middle;
1.829 kalberla 5716: }
5717:
1.911 bisitz 5718: div.LC_feedback_link a {
1.829 kalberla 5719: text-decoration: none;
1.489 raeburn 5720: }
1.795 www 5721:
1.867 kalberla 5722: div.LC_comblock {
1.911 bisitz 5723: display:inline;
1.867 kalberla 5724: color:$font;
5725: font-size:90%;
5726: }
5727:
5728: div.LC_feedback_link div.LC_comblock {
5729: padding-left:5px;
5730: }
5731:
5732: div.LC_feedback_link div.LC_comblock a {
5733: color:$font;
5734: }
5735:
1.489 raeburn 5736: span.LC_feedback_link {
1.858 bisitz 5737: /* background: $feedback_link_bg; */
1.599 albertel 5738: font-size: larger;
5739: }
1.795 www 5740:
1.599 albertel 5741: span.LC_message_link {
1.858 bisitz 5742: /* background: $feedback_link_bg; */
1.599 albertel 5743: font-size: larger;
5744: position: absolute;
5745: right: 1em;
1.489 raeburn 5746: }
1.421 albertel 5747:
1.515 albertel 5748: table.LC_prior_tries {
1.524 albertel 5749: border: 1px solid #000000;
5750: border-collapse: separate;
5751: border-spacing: 1px;
1.515 albertel 5752: }
1.523 albertel 5753:
1.515 albertel 5754: table.LC_prior_tries td {
1.524 albertel 5755: padding: 2px;
1.515 albertel 5756: }
1.523 albertel 5757:
5758: .LC_answer_correct {
1.795 www 5759: background: lightgreen;
5760: color: darkgreen;
5761: padding: 6px;
1.523 albertel 5762: }
1.795 www 5763:
1.523 albertel 5764: .LC_answer_charged_try {
1.797 www 5765: background: #FFAAAA;
1.795 www 5766: color: darkred;
5767: padding: 6px;
1.523 albertel 5768: }
1.795 www 5769:
1.779 bisitz 5770: .LC_answer_not_charged_try,
1.523 albertel 5771: .LC_answer_no_grade,
5772: .LC_answer_late {
1.795 www 5773: background: lightyellow;
1.523 albertel 5774: color: black;
1.795 www 5775: padding: 6px;
1.523 albertel 5776: }
1.795 www 5777:
1.523 albertel 5778: .LC_answer_previous {
1.795 www 5779: background: lightblue;
5780: color: darkblue;
5781: padding: 6px;
1.523 albertel 5782: }
1.795 www 5783:
1.779 bisitz 5784: .LC_answer_no_message {
1.777 tempelho 5785: background: #FFFFFF;
5786: color: black;
1.795 www 5787: padding: 6px;
1.779 bisitz 5788: }
1.795 www 5789:
1.779 bisitz 5790: .LC_answer_unknown {
5791: background: orange;
5792: color: black;
1.795 www 5793: padding: 6px;
1.777 tempelho 5794: }
1.795 www 5795:
1.529 albertel 5796: span.LC_prior_numerical,
5797: span.LC_prior_string,
5798: span.LC_prior_custom,
5799: span.LC_prior_reaction,
5800: span.LC_prior_math {
1.925 bisitz 5801: font-family: $mono;
1.523 albertel 5802: white-space: pre;
5803: }
5804:
1.525 albertel 5805: span.LC_prior_string {
1.925 bisitz 5806: font-family: $mono;
1.525 albertel 5807: white-space: pre;
5808: }
5809:
1.523 albertel 5810: table.LC_prior_option {
5811: width: 100%;
5812: border-collapse: collapse;
5813: }
1.795 www 5814:
1.911 bisitz 5815: table.LC_prior_rank,
1.795 www 5816: table.LC_prior_match {
1.528 albertel 5817: border-collapse: collapse;
5818: }
1.795 www 5819:
1.528 albertel 5820: table.LC_prior_option tr td,
5821: table.LC_prior_rank tr td,
5822: table.LC_prior_match tr td {
1.524 albertel 5823: border: 1px solid #000000;
1.515 albertel 5824: }
5825:
1.855 bisitz 5826: .LC_nobreak {
1.544 albertel 5827: white-space: nowrap;
1.519 raeburn 5828: }
5829:
1.576 raeburn 5830: span.LC_cusr_emph {
5831: font-style: italic;
5832: }
5833:
1.633 raeburn 5834: span.LC_cusr_subheading {
5835: font-weight: normal;
5836: font-size: 85%;
5837: }
5838:
1.861 bisitz 5839: div.LC_docs_entry_move {
1.859 bisitz 5840: border: 1px solid #BBBBBB;
1.545 albertel 5841: background: #DDDDDD;
1.861 bisitz 5842: width: 22px;
1.859 bisitz 5843: padding: 1px;
5844: margin: 0;
1.545 albertel 5845: }
5846:
1.861 bisitz 5847: table.LC_data_table tr > td.LC_docs_entry_commands,
5848: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 5849: background: #DDDDDD;
5850: font-size: x-small;
5851: }
1.795 www 5852:
1.861 bisitz 5853: .LC_docs_entry_parameter {
5854: white-space: nowrap;
5855: }
5856:
1.544 albertel 5857: .LC_docs_copy {
1.545 albertel 5858: color: #000099;
1.544 albertel 5859: }
1.795 www 5860:
1.544 albertel 5861: .LC_docs_cut {
1.545 albertel 5862: color: #550044;
1.544 albertel 5863: }
1.795 www 5864:
1.544 albertel 5865: .LC_docs_rename {
1.545 albertel 5866: color: #009900;
1.544 albertel 5867: }
1.795 www 5868:
1.544 albertel 5869: .LC_docs_remove {
1.545 albertel 5870: color: #990000;
5871: }
5872:
1.547 albertel 5873: .LC_docs_reinit_warn,
5874: .LC_docs_ext_edit {
5875: font-size: x-small;
5876: }
5877:
1.545 albertel 5878: table.LC_docs_adddocs td,
5879: table.LC_docs_adddocs th {
5880: border: 1px solid #BBBBBB;
5881: padding: 4px;
5882: background: #DDDDDD;
1.543 albertel 5883: }
5884:
1.584 albertel 5885: table.LC_sty_begin {
5886: background: #BBFFBB;
5887: }
1.795 www 5888:
1.584 albertel 5889: table.LC_sty_end {
5890: background: #FFBBBB;
5891: }
5892:
1.589 raeburn 5893: table.LC_double_column {
1.803 bisitz 5894: border-width: 0;
1.589 raeburn 5895: border-collapse: collapse;
5896: width: 100%;
5897: padding: 2px;
5898: }
5899:
5900: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5901: top: 2px;
1.589 raeburn 5902: left: 2px;
5903: width: 47%;
5904: vertical-align: top;
5905: }
5906:
5907: table.LC_double_column tr td.LC_right_col {
5908: top: 2px;
1.779 bisitz 5909: right: 2px;
1.589 raeburn 5910: width: 47%;
5911: vertical-align: top;
5912: }
5913:
1.591 raeburn 5914: div.LC_left_float {
5915: float: left;
5916: padding-right: 5%;
1.597 albertel 5917: padding-bottom: 4px;
1.591 raeburn 5918: }
5919:
5920: div.LC_clear_float_header {
1.597 albertel 5921: padding-bottom: 2px;
1.591 raeburn 5922: }
5923:
5924: div.LC_clear_float_footer {
1.597 albertel 5925: padding-top: 10px;
1.591 raeburn 5926: clear: both;
5927: }
5928:
1.597 albertel 5929: div.LC_grade_show_user {
1.941 bisitz 5930: /* border-left: 5px solid $sidebg; */
5931: border-top: 5px solid #000000;
5932: margin: 50px 0 0 0;
1.936 bisitz 5933: padding: 15px 0 5px 10px;
1.597 albertel 5934: }
1.795 www 5935:
1.936 bisitz 5936: div.LC_grade_show_user_odd_row {
1.941 bisitz 5937: /* border-left: 5px solid #000000; */
5938: }
5939:
5940: div.LC_grade_show_user div.LC_Box {
5941: margin-right: 50px;
1.597 albertel 5942: }
5943:
5944: div.LC_grade_submissions,
5945: div.LC_grade_message_center,
1.936 bisitz 5946: div.LC_grade_info_links {
1.597 albertel 5947: margin: 5px;
5948: width: 99%;
5949: background: #FFFFFF;
5950: }
1.795 www 5951:
1.597 albertel 5952: div.LC_grade_submissions_header,
1.936 bisitz 5953: div.LC_grade_message_center_header {
1.705 tempelho 5954: font-weight: bold;
5955: font-size: large;
1.597 albertel 5956: }
1.795 www 5957:
1.597 albertel 5958: div.LC_grade_submissions_body,
1.936 bisitz 5959: div.LC_grade_message_center_body {
1.597 albertel 5960: border: 1px solid black;
5961: width: 99%;
5962: background: #FFFFFF;
5963: }
1.795 www 5964:
1.613 albertel 5965: table.LC_scantron_action {
5966: width: 100%;
5967: }
1.795 www 5968:
1.613 albertel 5969: table.LC_scantron_action tr th {
1.698 harmsja 5970: font-weight:bold;
5971: font-style:normal;
1.613 albertel 5972: }
1.795 www 5973:
1.779 bisitz 5974: .LC_edit_problem_header,
1.614 albertel 5975: div.LC_edit_problem_footer {
1.705 tempelho 5976: font-weight: normal;
5977: font-size: medium;
1.602 albertel 5978: margin: 2px;
1.600 albertel 5979: }
1.795 www 5980:
1.600 albertel 5981: div.LC_edit_problem_header,
1.602 albertel 5982: div.LC_edit_problem_header div,
1.614 albertel 5983: div.LC_edit_problem_footer,
5984: div.LC_edit_problem_footer div,
1.602 albertel 5985: div.LC_edit_problem_editxml_header,
5986: div.LC_edit_problem_editxml_header div {
1.600 albertel 5987: margin-top: 5px;
5988: }
1.795 www 5989:
1.600 albertel 5990: div.LC_edit_problem_header_title {
1.705 tempelho 5991: font-weight: bold;
5992: font-size: larger;
1.602 albertel 5993: background: $tabbg;
5994: padding: 3px;
5995: }
1.795 www 5996:
1.602 albertel 5997: table.LC_edit_problem_header_title {
5998: width: 100%;
1.600 albertel 5999: background: $tabbg;
1.602 albertel 6000: }
6001:
6002: div.LC_edit_problem_discards {
6003: float: left;
6004: padding-bottom: 5px;
6005: }
1.795 www 6006:
1.602 albertel 6007: div.LC_edit_problem_saves {
6008: float: right;
6009: padding-bottom: 5px;
1.600 albertel 6010: }
1.795 www 6011:
1.911 bisitz 6012: img.stift {
1.803 bisitz 6013: border-width: 0;
6014: vertical-align: middle;
1.677 riegler 6015: }
1.680 riegler 6016:
1.923 bisitz 6017: table td.LC_mainmenu_col_fieldset {
1.680 riegler 6018: vertical-align: top;
1.777 tempelho 6019: }
1.795 www 6020:
1.716 raeburn 6021: div.LC_createcourse {
1.911 bisitz 6022: margin: 10px 10px 10px 10px;
1.716 raeburn 6023: }
6024:
1.917 raeburn 6025: .LC_dccid {
6026: margin: 0.2em 0 0 0;
6027: padding: 0;
6028: font-size: 90%;
6029: display:none;
6030: }
6031:
1.698 harmsja 6032: a:hover,
1.897 wenzelju 6033: ol.LC_primary_menu a:hover,
1.721 harmsja 6034: ol#LC_MenuBreadcrumbs a:hover,
6035: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 6036: ul#LC_secondary_menu a:hover,
1.721 harmsja 6037: .LC_FormSectionClearButton input:hover
1.795 www 6038: ul.LC_TabContent li:hover a {
1.952 onken 6039: color:$button_hover;
1.911 bisitz 6040: text-decoration:none;
1.693 droeschl 6041: }
6042:
1.779 bisitz 6043: h1 {
1.911 bisitz 6044: padding: 0;
6045: line-height:130%;
1.693 droeschl 6046: }
1.698 harmsja 6047:
1.911 bisitz 6048: h2,
6049: h3,
6050: h4,
6051: h5,
6052: h6 {
6053: margin: 5px 0 5px 0;
6054: padding: 0;
6055: line-height:130%;
1.693 droeschl 6056: }
1.795 www 6057:
6058: .LC_hcell {
1.911 bisitz 6059: padding:3px 15px 3px 15px;
6060: margin: 0;
6061: background-color:$tabbg;
6062: color:$fontmenu;
6063: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 6064: }
1.795 www 6065:
1.840 bisitz 6066: .LC_Box > .LC_hcell {
1.911 bisitz 6067: margin: 0 -10px 10px -10px;
1.835 bisitz 6068: }
6069:
1.721 harmsja 6070: .LC_noBorder {
1.911 bisitz 6071: border: 0;
1.698 harmsja 6072: }
1.693 droeschl 6073:
1.721 harmsja 6074: .LC_FormSectionClearButton input {
1.911 bisitz 6075: background-color:transparent;
6076: border: none;
6077: cursor:pointer;
6078: text-decoration:underline;
1.693 droeschl 6079: }
1.763 bisitz 6080:
6081: .LC_help_open_topic {
1.911 bisitz 6082: color: #FFFFFF;
6083: background-color: #EEEEFF;
6084: margin: 1px;
6085: padding: 4px;
6086: border: 1px solid #000033;
6087: white-space: nowrap;
6088: /* vertical-align: middle; */
1.759 neumanie 6089: }
1.693 droeschl 6090:
1.911 bisitz 6091: dl,
6092: ul,
6093: div,
6094: fieldset {
6095: margin: 10px 10px 10px 0;
6096: /* overflow: hidden; */
1.693 droeschl 6097: }
1.795 www 6098:
1.838 bisitz 6099: fieldset > legend {
1.911 bisitz 6100: font-weight: bold;
6101: padding: 0 5px 0 5px;
1.838 bisitz 6102: }
6103:
1.813 bisitz 6104: #LC_nav_bar {
1.911 bisitz 6105: float: left;
1.995 raeburn 6106: background-color: $pgbg_or_bgcolor;
1.966 bisitz 6107: margin: 0 0 2px 0;
1.807 droeschl 6108: }
6109:
1.916 droeschl 6110: #LC_realm {
6111: margin: 0.2em 0 0 0;
6112: padding: 0;
6113: font-weight: bold;
6114: text-align: center;
1.995 raeburn 6115: background-color: $pgbg_or_bgcolor;
1.916 droeschl 6116: }
6117:
1.911 bisitz 6118: #LC_nav_bar em {
6119: font-weight: bold;
6120: font-style: normal;
1.807 droeschl 6121: }
6122:
1.897 wenzelju 6123: ol.LC_primary_menu {
1.911 bisitz 6124: float: right;
1.934 droeschl 6125: margin: 0;
1.995 raeburn 6126: background-color: $pgbg_or_bgcolor;
1.807 droeschl 6127: }
6128:
1.852 droeschl 6129: ol#LC_PathBreadcrumbs {
1.911 bisitz 6130: margin: 0;
1.693 droeschl 6131: }
6132:
1.897 wenzelju 6133: ol.LC_primary_menu li {
1.911 bisitz 6134: display: inline;
6135: padding: 5px 5px 0 10px;
6136: vertical-align: top;
1.693 droeschl 6137: }
6138:
1.897 wenzelju 6139: ol.LC_primary_menu li img {
1.911 bisitz 6140: vertical-align: bottom;
1.934 droeschl 6141: height: 1.1em;
1.693 droeschl 6142: }
6143:
1.897 wenzelju 6144: ol.LC_primary_menu a {
1.911 bisitz 6145: color: RGB(80, 80, 80);
6146: text-decoration: none;
1.693 droeschl 6147: }
1.795 www 6148:
1.949 droeschl 6149: ol.LC_primary_menu a.LC_new_message {
6150: font-weight:bold;
6151: color: darkred;
6152: }
6153:
1.975 raeburn 6154: ol.LC_docs_parameters {
6155: margin-left: 0;
6156: padding: 0;
6157: list-style: none;
6158: }
6159:
6160: ol.LC_docs_parameters li {
6161: margin: 0;
6162: padding-right: 20px;
6163: display: inline;
6164: }
6165:
1.976 raeburn 6166: ol.LC_docs_parameters li:before {
6167: content: "\\002022 \\0020";
6168: }
6169:
6170: li.LC_docs_parameters_title {
6171: font-weight: bold;
6172: }
6173:
6174: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
6175: content: "";
6176: }
6177:
1.897 wenzelju 6178: ul#LC_secondary_menu {
1.911 bisitz 6179: clear: both;
6180: color: $fontmenu;
6181: background: $tabbg;
6182: list-style: none;
6183: padding: 0;
6184: margin: 0;
6185: width: 100%;
1.995 raeburn 6186: text-align: left;
1.808 droeschl 6187: }
6188:
1.897 wenzelju 6189: ul#LC_secondary_menu li {
1.911 bisitz 6190: font-weight: bold;
6191: line-height: 1.8em;
6192: padding: 0 0.8em;
6193: border-right: 1px solid black;
6194: display: inline;
6195: vertical-align: middle;
1.807 droeschl 6196: }
6197:
1.847 tempelho 6198: ul.LC_TabContent {
1.911 bisitz 6199: display:block;
6200: background: $sidebg;
6201: border-bottom: solid 1px $lg_border_color;
6202: list-style:none;
6203: margin: 0 -10px;
6204: padding: 0;
1.693 droeschl 6205: }
6206:
1.795 www 6207: ul.LC_TabContent li,
6208: ul.LC_TabContentBigger li {
1.911 bisitz 6209: float:left;
1.741 harmsja 6210: }
1.795 www 6211:
1.897 wenzelju 6212: ul#LC_secondary_menu li a {
1.911 bisitz 6213: color: $fontmenu;
6214: text-decoration: none;
1.693 droeschl 6215: }
1.795 www 6216:
1.721 harmsja 6217: ul.LC_TabContent {
1.952 onken 6218: min-height:20px;
1.721 harmsja 6219: }
1.795 www 6220:
6221: ul.LC_TabContent li {
1.911 bisitz 6222: vertical-align:middle;
1.959 onken 6223: padding: 0 16px 0 10px;
1.911 bisitz 6224: background-color:$tabbg;
6225: border-bottom:solid 1px $lg_border_color;
1.952 onken 6226: border-right: solid 1px $font;
1.721 harmsja 6227: }
1.795 www 6228:
1.847 tempelho 6229: ul.LC_TabContent .right {
1.911 bisitz 6230: float:right;
1.847 tempelho 6231: }
6232:
1.911 bisitz 6233: ul.LC_TabContent li a,
6234: ul.LC_TabContent li {
6235: color:rgb(47,47,47);
6236: text-decoration:none;
6237: font-size:95%;
6238: font-weight:bold;
1.952 onken 6239: min-height:20px;
6240: }
6241:
1.959 onken 6242: ul.LC_TabContent li a:hover,
6243: ul.LC_TabContent li a:focus {
1.952 onken 6244: color: $button_hover;
1.959 onken 6245: background:none;
6246: outline:none;
1.952 onken 6247: }
6248:
6249: ul.LC_TabContent li:hover {
6250: color: $button_hover;
6251: cursor:pointer;
1.721 harmsja 6252: }
1.795 www 6253:
1.911 bisitz 6254: ul.LC_TabContent li.active {
1.952 onken 6255: color: $font;
1.911 bisitz 6256: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 6257: border-bottom:solid 1px #FFFFFF;
6258: cursor: default;
1.744 ehlerst 6259: }
1.795 www 6260:
1.959 onken 6261: ul.LC_TabContent li.active a {
6262: color:$font;
6263: background:#FFFFFF;
6264: outline: none;
6265: }
1.870 tempelho 6266: #maincoursedoc {
1.911 bisitz 6267: clear:both;
1.870 tempelho 6268: }
6269:
6270: ul.LC_TabContentBigger {
1.911 bisitz 6271: display:block;
6272: list-style:none;
6273: padding: 0;
1.870 tempelho 6274: }
6275:
1.795 www 6276: ul.LC_TabContentBigger li {
1.911 bisitz 6277: vertical-align:bottom;
6278: height: 30px;
6279: font-size:110%;
6280: font-weight:bold;
6281: color: #737373;
1.841 tempelho 6282: }
6283:
1.957 onken 6284: ul.LC_TabContentBigger li.active {
6285: position: relative;
6286: top: 1px;
6287: }
6288:
1.870 tempelho 6289: ul.LC_TabContentBigger li a {
1.911 bisitz 6290: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6291: height: 30px;
6292: line-height: 30px;
6293: text-align: center;
6294: display: block;
6295: text-decoration: none;
1.958 onken 6296: outline: none;
1.741 harmsja 6297: }
1.795 www 6298:
1.870 tempelho 6299: ul.LC_TabContentBigger li.active a {
1.911 bisitz 6300: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6301: color:$font;
1.744 ehlerst 6302: }
1.795 www 6303:
1.870 tempelho 6304: ul.LC_TabContentBigger li b {
1.911 bisitz 6305: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
6306: display: block;
6307: float: left;
6308: padding: 0 30px;
1.957 onken 6309: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 6310: }
6311:
1.956 onken 6312: ul.LC_TabContentBigger li:hover b {
6313: color:$button_hover;
6314: }
6315:
1.870 tempelho 6316: ul.LC_TabContentBigger li.active b {
1.911 bisitz 6317: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
6318: color:$font;
1.957 onken 6319: border: 0;
1.741 harmsja 6320: }
1.693 droeschl 6321:
1.870 tempelho 6322:
1.862 bisitz 6323: ul.LC_CourseBreadcrumbs {
6324: background: $sidebg;
6325: line-height: 32px;
6326: padding-left: 10px;
6327: margin: 0 0 10px 0;
6328: list-style-position: inside;
6329:
6330: }
6331:
1.911 bisitz 6332: ol#LC_MenuBreadcrumbs,
1.862 bisitz 6333: ol#LC_PathBreadcrumbs {
1.911 bisitz 6334: padding-left: 10px;
6335: margin: 0;
1.933 droeschl 6336: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 6337: }
6338:
1.911 bisitz 6339: ol#LC_MenuBreadcrumbs li,
6340: ol#LC_PathBreadcrumbs li,
1.862 bisitz 6341: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 6342: display: inline;
1.933 droeschl 6343: white-space: normal;
1.693 droeschl 6344: }
6345:
1.823 bisitz 6346: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 6347: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 6348: text-decoration: none;
6349: font-size:90%;
1.693 droeschl 6350: }
1.795 www 6351:
1.969 droeschl 6352: ol#LC_MenuBreadcrumbs h1 {
6353: display: inline;
6354: font-size: 90%;
6355: line-height: 2.5em;
6356: margin: 0;
6357: padding: 0;
6358: }
6359:
1.795 www 6360: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 6361: text-decoration:none;
6362: font-size:100%;
6363: font-weight:bold;
1.693 droeschl 6364: }
1.795 www 6365:
1.840 bisitz 6366: .LC_Box {
1.911 bisitz 6367: border: solid 1px $lg_border_color;
6368: padding: 0 10px 10px 10px;
1.746 neumanie 6369: }
1.795 www 6370:
6371: .LC_AboutMe_Image {
1.911 bisitz 6372: float:left;
6373: margin-right:10px;
1.747 neumanie 6374: }
1.795 www 6375:
6376: .LC_Clear_AboutMe_Image {
1.911 bisitz 6377: clear:left;
1.747 neumanie 6378: }
1.795 www 6379:
1.721 harmsja 6380: dl.LC_ListStyleClean dt {
1.911 bisitz 6381: padding-right: 5px;
6382: display: table-header-group;
1.693 droeschl 6383: }
6384:
1.721 harmsja 6385: dl.LC_ListStyleClean dd {
1.911 bisitz 6386: display: table-row;
1.693 droeschl 6387: }
6388:
1.721 harmsja 6389: .LC_ListStyleClean,
6390: .LC_ListStyleSimple,
6391: .LC_ListStyleNormal,
1.795 www 6392: .LC_ListStyleSpecial {
1.911 bisitz 6393: /* display:block; */
6394: list-style-position: inside;
6395: list-style-type: none;
6396: overflow: hidden;
6397: padding: 0;
1.693 droeschl 6398: }
6399:
1.721 harmsja 6400: .LC_ListStyleSimple li,
6401: .LC_ListStyleSimple dd,
6402: .LC_ListStyleNormal li,
6403: .LC_ListStyleNormal dd,
6404: .LC_ListStyleSpecial li,
1.795 www 6405: .LC_ListStyleSpecial dd {
1.911 bisitz 6406: margin: 0;
6407: padding: 5px 5px 5px 10px;
6408: clear: both;
1.693 droeschl 6409: }
6410:
1.721 harmsja 6411: .LC_ListStyleClean li,
6412: .LC_ListStyleClean dd {
1.911 bisitz 6413: padding-top: 0;
6414: padding-bottom: 0;
1.693 droeschl 6415: }
6416:
1.721 harmsja 6417: .LC_ListStyleSimple dd,
1.795 www 6418: .LC_ListStyleSimple li {
1.911 bisitz 6419: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6420: }
6421:
1.721 harmsja 6422: .LC_ListStyleSpecial li,
6423: .LC_ListStyleSpecial dd {
1.911 bisitz 6424: list-style-type: none;
6425: background-color: RGB(220, 220, 220);
6426: margin-bottom: 4px;
1.693 droeschl 6427: }
6428:
1.721 harmsja 6429: table.LC_SimpleTable {
1.911 bisitz 6430: margin:5px;
6431: border:solid 1px $lg_border_color;
1.795 www 6432: }
1.693 droeschl 6433:
1.721 harmsja 6434: table.LC_SimpleTable tr {
1.911 bisitz 6435: padding: 0;
6436: border:solid 1px $lg_border_color;
1.693 droeschl 6437: }
1.795 www 6438:
6439: table.LC_SimpleTable thead {
1.911 bisitz 6440: background:rgb(220,220,220);
1.693 droeschl 6441: }
6442:
1.721 harmsja 6443: div.LC_columnSection {
1.911 bisitz 6444: display: block;
6445: clear: both;
6446: overflow: hidden;
6447: margin: 0;
1.693 droeschl 6448: }
6449:
1.721 harmsja 6450: div.LC_columnSection>* {
1.911 bisitz 6451: float: left;
6452: margin: 10px 20px 10px 0;
6453: overflow:hidden;
1.693 droeschl 6454: }
1.721 harmsja 6455:
1.795 www 6456: table em {
1.911 bisitz 6457: font-weight: bold;
6458: font-style: normal;
1.748 schulted 6459: }
1.795 www 6460:
1.779 bisitz 6461: table.LC_tableBrowseRes,
1.795 www 6462: table.LC_tableOfContent {
1.911 bisitz 6463: border:none;
6464: border-spacing: 1px;
6465: padding: 3px;
6466: background-color: #FFFFFF;
6467: font-size: 90%;
1.753 droeschl 6468: }
1.789 droeschl 6469:
1.911 bisitz 6470: table.LC_tableOfContent {
6471: border-collapse: collapse;
1.789 droeschl 6472: }
6473:
1.771 droeschl 6474: table.LC_tableBrowseRes a,
1.768 schulted 6475: table.LC_tableOfContent a {
1.911 bisitz 6476: background-color: transparent;
6477: text-decoration: none;
1.753 droeschl 6478: }
6479:
1.795 www 6480: table.LC_tableOfContent img {
1.911 bisitz 6481: border: none;
6482: height: 1.3em;
6483: vertical-align: text-bottom;
6484: margin-right: 0.3em;
1.753 droeschl 6485: }
1.757 schulted 6486:
1.795 www 6487: a#LC_content_toolbar_firsthomework {
1.911 bisitz 6488: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 6489: }
6490:
1.795 www 6491: a#LC_content_toolbar_everything {
1.911 bisitz 6492: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 6493: }
6494:
1.795 www 6495: a#LC_content_toolbar_uncompleted {
1.911 bisitz 6496: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 6497: }
6498:
1.795 www 6499: #LC_content_toolbar_clearbubbles {
1.911 bisitz 6500: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 6501: }
6502:
1.795 www 6503: a#LC_content_toolbar_changefolder {
1.911 bisitz 6504: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 6505: }
6506:
1.795 www 6507: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 6508: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 6509: }
6510:
1.795 www 6511: ul#LC_toolbar li a:hover {
1.911 bisitz 6512: background-position: bottom center;
1.757 schulted 6513: }
6514:
1.795 www 6515: ul#LC_toolbar {
1.911 bisitz 6516: padding: 0;
6517: margin: 2px;
6518: list-style:none;
6519: position:relative;
6520: background-color:white;
1.757 schulted 6521: }
6522:
1.795 www 6523: ul#LC_toolbar li {
1.911 bisitz 6524: border:1px solid white;
6525: padding: 0;
6526: margin: 0;
6527: float: left;
6528: display:inline;
6529: vertical-align:middle;
6530: }
1.757 schulted 6531:
1.783 amueller 6532:
1.795 www 6533: a.LC_toolbarItem {
1.911 bisitz 6534: display:block;
6535: padding: 0;
6536: margin: 0;
6537: height: 32px;
6538: width: 32px;
6539: color:white;
6540: border: none;
6541: background-repeat:no-repeat;
6542: background-color:transparent;
1.757 schulted 6543: }
6544:
1.915 droeschl 6545: ul.LC_funclist {
6546: margin: 0;
6547: padding: 0.5em 1em 0.5em 0;
6548: }
6549:
1.933 droeschl 6550: ul.LC_funclist > li:first-child {
6551: font-weight:bold;
6552: margin-left:0.8em;
6553: }
6554:
1.915 droeschl 6555: ul.LC_funclist + ul.LC_funclist {
6556: /*
6557: left border as a seperator if we have more than
6558: one list
6559: */
6560: border-left: 1px solid $sidebg;
6561: /*
6562: this hides the left border behind the border of the
6563: outer box if element is wrapped to the next 'line'
6564: */
6565: margin-left: -1px;
6566: }
6567:
1.843 bisitz 6568: ul.LC_funclist li {
1.915 droeschl 6569: display: inline;
1.782 bisitz 6570: white-space: nowrap;
1.915 droeschl 6571: margin: 0 0 0 25px;
6572: line-height: 150%;
1.782 bisitz 6573: }
6574:
1.930 faziophi 6575: .ui-accordion .LC_advanced_toggle {
6576: float: right;
6577: font-size: 90%;
6578: padding: 0px 4px
6579: }
1.757 schulted 6580:
1.974 wenzelju 6581: .LC_hidden {
6582: display: none;
6583: }
6584:
1.343 albertel 6585: END
6586: }
6587:
1.306 albertel 6588: =pod
6589:
6590: =item * &headtag()
6591:
6592: Returns a uniform footer for LON-CAPA web pages.
6593:
1.307 albertel 6594: Inputs: $title - optional title for the head
6595: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 6596: $args - optional arguments
1.319 albertel 6597: force_register - if is true call registerurl so the remote is
6598: informed
1.415 albertel 6599: redirect -> array ref of
6600: 1- seconds before redirect occurs
6601: 2- url to redirect to
6602: 3- whether the side effect should occur
1.315 albertel 6603: (side effect of setting
6604: $env{'internal.head.redirect'} to the url
6605: redirected too)
1.352 albertel 6606: domain -> force to color decorate a page for a specific
6607: domain
6608: function -> force usage of a specific rolish color scheme
6609: bgcolor -> override the default page bgcolor
1.460 albertel 6610: no_auto_mt_title
6611: -> prevent &mt()ing the title arg
1.464 albertel 6612:
1.306 albertel 6613: =cut
6614:
6615: sub headtag {
1.313 albertel 6616: my ($title,$head_extra,$args) = @_;
1.306 albertel 6617:
1.363 albertel 6618: my $function = $args->{'function'} || &get_users_function();
6619: my $domain = $args->{'domain'} || &determinedomain();
6620: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 6621: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 6622: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 6623: #time(),
1.418 albertel 6624: $env{'environment.color.timestamp'},
1.363 albertel 6625: $function,$domain,$bgcolor);
6626:
1.369 www 6627: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 6628:
1.308 albertel 6629: my $result =
6630: '<head>'.
1.461 albertel 6631: &font_settings();
1.319 albertel 6632:
1.461 albertel 6633: if (!$args->{'frameset'}) {
6634: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
6635: }
1.962 droeschl 6636: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
6637: $result .= Apache::lonxml::display_title();
1.319 albertel 6638: }
1.436 albertel 6639: if (!$args->{'no_nav_bar'}
6640: && !$args->{'only_body'}
6641: && !$args->{'frameset'}) {
6642: $result .= &help_menu_js();
6643: }
1.319 albertel 6644:
1.314 albertel 6645: if (ref($args->{'redirect'})) {
1.414 albertel 6646: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 6647: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 6648: if (!$inhibit_continue) {
6649: $env{'internal.head.redirect'} = $url;
6650: }
1.313 albertel 6651: $result.=<<ADDMETA
6652: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 6653: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 6654: ADDMETA
6655: }
1.306 albertel 6656: if (!defined($title)) {
6657: $title = 'The LearningOnline Network with CAPA';
6658: }
1.460 albertel 6659: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
6660: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 6661: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
6662: .$head_extra;
1.962 droeschl 6663: return $result.'</head>';
1.306 albertel 6664: }
6665:
6666: =pod
6667:
1.340 albertel 6668: =item * &font_settings()
6669:
6670: Returns neccessary <meta> to set the proper encoding
6671:
6672: Inputs: none
6673:
6674: =cut
6675:
6676: sub font_settings {
6677: my $headerstring='';
1.647 www 6678: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 6679: $headerstring.=
6680: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
6681: }
6682: return $headerstring;
6683: }
6684:
1.341 albertel 6685: =pod
6686:
6687: =item * &xml_begin()
6688:
6689: Returns the needed doctype and <html>
6690:
6691: Inputs: none
6692:
6693: =cut
6694:
6695: sub xml_begin {
6696: my $output='';
6697:
6698: if ($env{'browser.mathml'}) {
6699: $output='<?xml version="1.0"?>'
6700: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
6701: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
6702:
6703: # .'<!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">] >'
6704: .'<!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">'
6705: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
6706: .'xmlns="http://www.w3.org/1999/xhtml">';
6707: } else {
1.849 bisitz 6708: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
6709: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341 albertel 6710: }
6711: return $output;
6712: }
1.340 albertel 6713:
6714: =pod
6715:
1.306 albertel 6716: =item * &start_page()
6717:
6718: Returns a complete <html> .. <body> section for LON-CAPA web pages.
6719:
1.648 raeburn 6720: Inputs:
6721:
6722: =over 4
6723:
6724: $title - optional title for the page
6725:
6726: $head_extra - optional extra HTML to incude inside the <head>
6727:
6728: $args - additional optional args supported are:
6729:
6730: =over 8
6731:
6732: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 6733: arg on
1.814 bisitz 6734: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 6735: add_entries -> additional attributes to add to the <body>
6736: domain -> force to color decorate a page for a
1.317 albertel 6737: specific domain
1.648 raeburn 6738: function -> force usage of a specific rolish color
1.317 albertel 6739: scheme
1.648 raeburn 6740: redirect -> see &headtag()
6741: bgcolor -> override the default page bg color
6742: js_ready -> return a string ready for being used in
1.317 albertel 6743: a javascript writeln
1.648 raeburn 6744: html_encode -> return a string ready for being used in
1.320 albertel 6745: a html attribute
1.648 raeburn 6746: force_register -> if is true will turn on the &bodytag()
1.317 albertel 6747: $forcereg arg
1.648 raeburn 6748: frameset -> if true will start with a <frameset>
1.330 albertel 6749: rather than <body>
1.648 raeburn 6750: skip_phases -> hash ref of
1.338 albertel 6751: head -> skip the <html><head> generation
6752: body -> skip all <body> generation
1.648 raeburn 6753: no_auto_mt_title -> prevent &mt()ing the title arg
6754: inherit_jsmath -> when creating popup window in a page,
6755: should it have jsmath forced on by the
6756: current page
1.867 kalberla 6757: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 6758: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.361 albertel 6759:
1.648 raeburn 6760: =back
1.460 albertel 6761:
1.648 raeburn 6762: =back
1.562 albertel 6763:
1.306 albertel 6764: =cut
6765:
6766: sub start_page {
1.309 albertel 6767: my ($title,$head_extra,$args) = @_;
1.318 albertel 6768: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.964 droeschl 6769: #SD
6770: #I don't see why we copy certain elements of %$args to %head_args
6771: #head args is passed to headtag() and this routine only reads those
6772: #keys that are needed. There doesn't happen any writes or any processing
6773: #of other keys.
6774: #proposal: just pass $args to headtag instead of \%head_args and delete
6775: #marked lines
6776: #<- MARK
1.313 albertel 6777: my %head_args;
1.352 albertel 6778: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6779: 'bgcolor','frameset','no_nav_bar','only_body',
6780: 'no_auto_mt_title') {
1.319 albertel 6781: if (defined($args->{$arg})) {
1.324 raeburn 6782: $head_args{$arg} = $args->{$arg};
1.319 albertel 6783: }
1.313 albertel 6784: }
1.964 droeschl 6785: #MARK ->
1.319 albertel 6786:
1.315 albertel 6787: $env{'internal.start_page'}++;
1.338 albertel 6788: my $result;
1.964 droeschl 6789:
1.338 albertel 6790: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.964 droeschl 6791: $result .=
6792: &xml_begin() . &headtag($title,$head_extra,\%head_args);
6793: #replace prev line by
6794: # &xml_begin() . &headtag($title, $head_extra, $args);
1.338 albertel 6795: }
6796:
6797: if (! exists($args->{'skip_phases'}{'body'}) ) {
6798: if ($args->{'frameset'}) {
6799: my $attr_string = &make_attr_string($args->{'force_register'},
6800: $args->{'add_entries'});
6801: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 6802: } else {
6803: $result .=
6804: &bodytag($title,
6805: $args->{'function'}, $args->{'add_entries'},
6806: $args->{'only_body'}, $args->{'domain'},
6807: $args->{'force_register'}, $args->{'no_nav_bar'},
1.962 droeschl 6808: $args->{'bgcolor'}, $args);
1.831 bisitz 6809: }
1.330 albertel 6810: }
1.338 albertel 6811:
1.315 albertel 6812: if ($args->{'js_ready'}) {
1.713 kaisler 6813: $result = &js_ready($result);
1.315 albertel 6814: }
1.320 albertel 6815: if ($args->{'html_encode'}) {
1.713 kaisler 6816: $result = &html_encode($result);
6817: }
6818:
1.813 bisitz 6819: # Preparation for new and consistent functionlist at top of screen
6820: # if ($args->{'functionlist'}) {
6821: # $result .= &build_functionlist();
6822: #}
6823:
1.964 droeschl 6824: # Don't add anything more if only_body wanted or in const space
6825: return $result if $args->{'only_body'}
6826: || $env{'request.state'} eq 'construct';
1.813 bisitz 6827:
6828: #Breadcrumbs
1.758 kaisler 6829: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
6830: &Apache::lonhtmlcommon::clear_breadcrumbs();
6831: #if any br links exists, add them to the breadcrumbs
6832: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6833: foreach my $crumb (@{$args->{'bread_crumbs'}}){
6834: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
6835: }
6836: }
6837:
6838: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
6839: if(exists($args->{'bread_crumbs_component'})){
6840: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
6841: }else{
6842: $result .= &Apache::lonhtmlcommon::breadcrumbs();
6843: }
1.320 albertel 6844: }
1.315 albertel 6845: return $result;
1.306 albertel 6846: }
6847:
6848: sub end_page {
1.315 albertel 6849: my ($args) = @_;
6850: $env{'internal.end_page'}++;
1.330 albertel 6851: my $result;
1.335 albertel 6852: if ($args->{'discussion'}) {
6853: my ($target,$parser);
6854: if (ref($args->{'discussion'})) {
6855: ($target,$parser) =($args->{'discussion'}{'target'},
6856: $args->{'discussion'}{'parser'});
6857: }
6858: $result .= &Apache::lonxml::xmlend($target,$parser);
6859: }
6860:
1.330 albertel 6861: if ($args->{'frameset'}) {
6862: $result .= '</frameset>';
6863: } else {
1.635 raeburn 6864: $result .= &endbodytag($args);
1.330 albertel 6865: }
6866: $result .= "\n</html>";
6867:
1.315 albertel 6868: if ($args->{'js_ready'}) {
1.317 albertel 6869: $result = &js_ready($result);
1.315 albertel 6870: }
1.335 albertel 6871:
1.320 albertel 6872: if ($args->{'html_encode'}) {
6873: $result = &html_encode($result);
6874: }
1.335 albertel 6875:
1.315 albertel 6876: return $result;
6877: }
6878:
1.320 albertel 6879: sub html_encode {
6880: my ($result) = @_;
6881:
1.322 albertel 6882: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6883:
6884: return $result;
6885: }
1.317 albertel 6886: sub js_ready {
6887: my ($result) = @_;
6888:
1.323 albertel 6889: $result =~ s/[\n\r]/ /xmsg;
6890: $result =~ s/\\/\\\\/xmsg;
6891: $result =~ s/'/\\'/xmsg;
1.372 albertel 6892: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6893:
6894: return $result;
6895: }
6896:
1.315 albertel 6897: sub validate_page {
6898: if ( exists($env{'internal.start_page'})
1.316 albertel 6899: && $env{'internal.start_page'} > 1) {
6900: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6901: $env{'internal.start_page'}.' '.
1.316 albertel 6902: $ENV{'request.filename'});
1.315 albertel 6903: }
6904: if ( exists($env{'internal.end_page'})
1.316 albertel 6905: && $env{'internal.end_page'} > 1) {
6906: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6907: $env{'internal.end_page'}.' '.
1.316 albertel 6908: $env{'request.filename'});
1.315 albertel 6909: }
6910: if ( exists($env{'internal.start_page'})
6911: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6912: &Apache::lonnet::logthis('start_page called without end_page '.
6913: $env{'request.filename'});
1.315 albertel 6914: }
6915: if ( ! exists($env{'internal.start_page'})
6916: && exists($env{'internal.end_page'})) {
1.316 albertel 6917: &Apache::lonnet::logthis('end_page called without start_page'.
6918: $env{'request.filename'});
1.315 albertel 6919: }
1.306 albertel 6920: }
1.315 albertel 6921:
1.996 www 6922:
6923: sub start_scrollbox {
1.998 raeburn 6924: my ($outerwidth,$width,$height)=@_;
6925: unless ($outerwidth) { $outerwidth='520px'; }
6926: unless ($width) { $width='500px'; }
6927: unless ($height) { $height='200px'; }
6928: return "<table style='width: $outerwidth; border: 1px solid black;'><tr><td style='width: $width;' bgcolor='#FFFFFF'><div style='overflow:auto; width:$width; height: $height;'>";
1.996 www 6929: }
6930:
6931: sub end_scrollbox {
1.998 raeburn 6932: return '</td></tr></table>';
1.996 www 6933: }
6934:
1.318 albertel 6935: sub simple_error_page {
6936: my ($r,$title,$msg) = @_;
6937: my $page =
6938: &Apache::loncommon::start_page($title).
6939: &mt($msg).
6940: &Apache::loncommon::end_page();
6941: if (ref($r)) {
6942: $r->print($page);
1.327 albertel 6943: return;
1.318 albertel 6944: }
6945: return $page;
6946: }
1.347 albertel 6947:
6948: {
1.610 albertel 6949: my @row_count;
1.961 onken 6950:
6951: sub start_data_table_count {
6952: unshift(@row_count, 0);
6953: return;
6954: }
6955:
6956: sub end_data_table_count {
6957: shift(@row_count);
6958: return;
6959: }
6960:
1.347 albertel 6961: sub start_data_table {
1.422 albertel 6962: my ($add_class) = @_;
6963: my $css_class = (join(' ','LC_data_table',$add_class));
1.961 onken 6964: &start_data_table_count();
1.422 albertel 6965: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 6966: }
6967:
6968: sub end_data_table {
1.961 onken 6969: &end_data_table_count();
1.389 albertel 6970: return '</table>'."\n";;
1.347 albertel 6971: }
6972:
6973: sub start_data_table_row {
1.974 wenzelju 6974: my ($add_class, $id) = @_;
1.610 albertel 6975: $row_count[0]++;
6976: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 6977: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 6978: $id = (' id="'.$id.'"') unless ($id eq '');
6979: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 6980: }
1.471 banghart 6981:
6982: sub continue_data_table_row {
1.974 wenzelju 6983: my ($add_class, $id) = @_;
1.610 albertel 6984: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 6985: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
6986: $id = (' id="'.$id.'"') unless ($id eq '');
6987: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 6988: }
1.347 albertel 6989:
6990: sub end_data_table_row {
1.389 albertel 6991: return '</tr>'."\n";;
1.347 albertel 6992: }
1.367 www 6993:
1.421 albertel 6994: sub start_data_table_empty_row {
1.707 bisitz 6995: # $row_count[0]++;
1.421 albertel 6996: return '<tr class="LC_empty_row" >'."\n";;
6997: }
6998:
6999: sub end_data_table_empty_row {
7000: return '</tr>'."\n";;
7001: }
7002:
1.367 www 7003: sub start_data_table_header_row {
1.389 albertel 7004: return '<tr class="LC_header_row">'."\n";;
1.367 www 7005: }
7006:
7007: sub end_data_table_header_row {
1.389 albertel 7008: return '</tr>'."\n";;
1.367 www 7009: }
1.890 droeschl 7010:
7011: sub data_table_caption {
7012: my $caption = shift;
7013: return "<caption class=\"LC_caption\">$caption</caption>";
7014: }
1.347 albertel 7015: }
7016:
1.548 albertel 7017: =pod
7018:
7019: =item * &inhibit_menu_check($arg)
7020:
7021: Checks for a inhibitmenu state and generates output to preserve it
7022:
7023: Inputs: $arg - can be any of
7024: - undef - in which case the return value is a string
7025: to add into arguments list of a uri
7026: - 'input' - in which case the return value is a HTML
7027: <form> <input> field of type hidden to
7028: preserve the value
7029: - a url - in which case the return value is the url with
7030: the neccesary cgi args added to preserve the
7031: inhibitmenu state
7032: - a ref to a url - no return value, but the string is
7033: updated to include the neccessary cgi
7034: args to preserve the inhibitmenu state
7035:
7036: =cut
7037:
7038: sub inhibit_menu_check {
7039: my ($arg) = @_;
7040: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
7041: if ($arg eq 'input') {
7042: if ($env{'form.inhibitmenu'}) {
7043: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
7044: } else {
7045: return
7046: }
7047: }
7048: if ($env{'form.inhibitmenu'}) {
7049: if (ref($arg)) {
7050: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7051: } elsif ($arg eq '') {
7052: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
7053: } else {
7054: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7055: }
7056: }
7057: if (!ref($arg)) {
7058: return $arg;
7059: }
7060: }
7061:
1.251 albertel 7062: ###############################################
1.182 matthew 7063:
7064: =pod
7065:
1.549 albertel 7066: =back
7067:
7068: =head1 User Information Routines
7069:
7070: =over 4
7071:
1.405 albertel 7072: =item * &get_users_function()
1.182 matthew 7073:
7074: Used by &bodytag to determine the current users primary role.
7075: Returns either 'student','coordinator','admin', or 'author'.
7076:
7077: =cut
7078:
7079: ###############################################
7080: sub get_users_function {
1.815 tempelho 7081: my $function = 'norole';
1.818 tempelho 7082: if ($env{'request.role'}=~/^(st)/) {
7083: $function='student';
7084: }
1.907 raeburn 7085: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 7086: $function='coordinator';
7087: }
1.258 albertel 7088: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 7089: $function='admin';
7090: }
1.826 bisitz 7091: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182 matthew 7092: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
7093: $function='author';
7094: }
7095: return $function;
1.54 www 7096: }
1.99 www 7097:
7098: ###############################################
7099:
1.233 raeburn 7100: =pod
7101:
1.821 raeburn 7102: =item * &show_course()
7103:
7104: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
7105: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
7106:
7107: Inputs:
7108: None
7109:
7110: Outputs:
7111: Scalar: 1 if 'Course' to be used, 0 otherwise.
7112:
7113: =cut
7114:
7115: ###############################################
7116: sub show_course {
7117: my $course = !$env{'user.adv'};
7118: if (!$env{'user.adv'}) {
7119: foreach my $env (keys(%env)) {
7120: next if ($env !~ m/^user\.priv\./);
7121: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
7122: $course = 0;
7123: last;
7124: }
7125: }
7126: }
7127: return $course;
7128: }
7129:
7130: ###############################################
7131:
7132: =pod
7133:
1.542 raeburn 7134: =item * &check_user_status()
1.274 raeburn 7135:
7136: Determines current status of supplied role for a
7137: specific user. Roles can be active, previous or future.
7138:
7139: Inputs:
7140: user's domain, user's username, course's domain,
1.375 raeburn 7141: course's number, optional section ID.
1.274 raeburn 7142:
7143: Outputs:
7144: role status: active, previous or future.
7145:
7146: =cut
7147:
7148: sub check_user_status {
1.412 raeburn 7149: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.982 raeburn 7150: my $extra = &Apache::lonnet::freeze_escape({'skipcheck' => 1});
7151: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname,'.',undef,$extra);
1.274 raeburn 7152: my @uroles = keys %userinfo;
7153: my $srchstr;
7154: my $active_chk = 'none';
1.412 raeburn 7155: my $now = time;
1.274 raeburn 7156: if (@uroles > 0) {
1.908 raeburn 7157: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 7158: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
7159: } else {
1.412 raeburn 7160: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
7161: }
7162: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 7163: my $role_end = 0;
7164: my $role_start = 0;
7165: $active_chk = 'active';
1.412 raeburn 7166: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
7167: $role_end = $1;
7168: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
7169: $role_start = $1;
1.274 raeburn 7170: }
7171: }
7172: if ($role_start > 0) {
1.412 raeburn 7173: if ($now < $role_start) {
1.274 raeburn 7174: $active_chk = 'future';
7175: }
7176: }
7177: if ($role_end > 0) {
1.412 raeburn 7178: if ($now > $role_end) {
1.274 raeburn 7179: $active_chk = 'previous';
7180: }
7181: }
7182: }
7183: }
7184: return $active_chk;
7185: }
7186:
7187: ###############################################
7188:
7189: =pod
7190:
1.405 albertel 7191: =item * &get_sections()
1.233 raeburn 7192:
7193: Determines all the sections for a course including
7194: sections with students and sections containing other roles.
1.419 raeburn 7195: Incoming parameters:
7196:
7197: 1. domain
7198: 2. course number
7199: 3. reference to array containing roles for which sections should
7200: be gathered (optional).
7201: 4. reference to array containing status types for which sections
7202: should be gathered (optional).
7203:
7204: If the third argument is undefined, sections are gathered for any role.
7205: If the fourth argument is undefined, sections are gathered for any status.
7206: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 7207:
1.374 raeburn 7208: Returns section hash (keys are section IDs, values are
7209: number of users in each section), subject to the
1.419 raeburn 7210: optional roles filter, optional status filter
1.233 raeburn 7211:
7212: =cut
7213:
7214: ###############################################
7215: sub get_sections {
1.419 raeburn 7216: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 7217: if (!defined($cdom) || !defined($cnum)) {
7218: my $cid = $env{'request.course.id'};
7219:
7220: return if (!defined($cid));
7221:
7222: $cdom = $env{'course.'.$cid.'.domain'};
7223: $cnum = $env{'course.'.$cid.'.num'};
7224: }
7225:
7226: my %sectioncount;
1.419 raeburn 7227: my $now = time;
1.240 albertel 7228:
1.366 albertel 7229: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 7230: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 7231: my $sec_index = &Apache::loncoursedata::CL_SECTION();
7232: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 7233: my $start_index = &Apache::loncoursedata::CL_START();
7234: my $end_index = &Apache::loncoursedata::CL_END();
7235: my $status;
1.366 albertel 7236: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 7237: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
7238: $data->[$status_index],
7239: $data->[$start_index],
7240: $data->[$end_index]);
7241: if ($stu_status eq 'Active') {
7242: $status = 'active';
7243: } elsif ($end < $now) {
7244: $status = 'previous';
7245: } elsif ($start > $now) {
7246: $status = 'future';
7247: }
7248: if ($section ne '-1' && $section !~ /^\s*$/) {
7249: if ((!defined($possible_status)) || (($status ne '') &&
7250: (grep/^\Q$status\E$/,@{$possible_status}))) {
7251: $sectioncount{$section}++;
7252: }
1.240 albertel 7253: }
7254: }
7255: }
7256: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7257: foreach my $user (sort(keys(%courseroles))) {
7258: if ($user !~ /^(\w{2})/) { next; }
7259: my ($role) = ($user =~ /^(\w{2})/);
7260: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 7261: my ($section,$status);
1.240 albertel 7262: if ($role eq 'cr' &&
7263: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
7264: $section=$1;
7265: }
7266: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
7267: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 7268: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
7269: if ($end == -1 && $start == -1) {
7270: next; #deleted role
7271: }
7272: if (!defined($possible_status)) {
7273: $sectioncount{$section}++;
7274: } else {
7275: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
7276: $status = 'active';
7277: } elsif ($end < $now) {
7278: $status = 'future';
7279: } elsif ($start > $now) {
7280: $status = 'previous';
7281: }
7282: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
7283: $sectioncount{$section}++;
7284: }
7285: }
1.233 raeburn 7286: }
1.366 albertel 7287: return %sectioncount;
1.233 raeburn 7288: }
7289:
1.274 raeburn 7290: ###############################################
1.294 raeburn 7291:
7292: =pod
1.405 albertel 7293:
7294: =item * &get_course_users()
7295:
1.275 raeburn 7296: Retrieves usernames:domains for users in the specified course
7297: with specific role(s), and access status.
7298:
7299: Incoming parameters:
1.277 albertel 7300: 1. course domain
7301: 2. course number
7302: 3. access status: users must have - either active,
1.275 raeburn 7303: previous, future, or all.
1.277 albertel 7304: 4. reference to array of permissible roles
1.288 raeburn 7305: 5. reference to array of section restrictions (optional)
7306: 6. reference to results object (hash of hashes).
7307: 7. reference to optional userdata hash
1.609 raeburn 7308: 8. reference to optional statushash
1.630 raeburn 7309: 9. flag if privileged users (except those set to unhide in
7310: course settings) should be excluded
1.609 raeburn 7311: Keys of top level results hash are roles.
1.275 raeburn 7312: Keys of inner hashes are username:domain, with
7313: values set to access type.
1.288 raeburn 7314: Optional userdata hash returns an array with arguments in the
7315: same order as loncoursedata::get_classlist() for student data.
7316:
1.609 raeburn 7317: Optional statushash returns
7318:
1.288 raeburn 7319: Entries for end, start, section and status are blank because
7320: of the possibility of multiple values for non-student roles.
7321:
1.275 raeburn 7322: =cut
1.405 albertel 7323:
1.275 raeburn 7324: ###############################################
1.405 albertel 7325:
1.275 raeburn 7326: sub get_course_users {
1.630 raeburn 7327: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 7328: my %idx = ();
1.419 raeburn 7329: my %seclists;
1.288 raeburn 7330:
7331: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
7332: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
7333: $idx{end} = &Apache::loncoursedata::CL_END();
7334: $idx{start} = &Apache::loncoursedata::CL_START();
7335: $idx{id} = &Apache::loncoursedata::CL_ID();
7336: $idx{section} = &Apache::loncoursedata::CL_SECTION();
7337: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
7338: $idx{status} = &Apache::loncoursedata::CL_STATUS();
7339:
1.290 albertel 7340: if (grep(/^st$/,@{$roles})) {
1.276 albertel 7341: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 7342: my $now = time;
1.277 albertel 7343: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 7344: my $match = 0;
1.412 raeburn 7345: my $secmatch = 0;
1.419 raeburn 7346: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 7347: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 7348: if ($section eq '') {
7349: $section = 'none';
7350: }
1.291 albertel 7351: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7352: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7353: $secmatch = 1;
7354: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 7355: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7356: $secmatch = 1;
7357: }
7358: } else {
1.419 raeburn 7359: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 7360: $secmatch = 1;
7361: }
1.290 albertel 7362: }
1.412 raeburn 7363: if (!$secmatch) {
7364: next;
7365: }
1.419 raeburn 7366: }
1.275 raeburn 7367: if (defined($$types{'active'})) {
1.288 raeburn 7368: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 7369: push(@{$$users{st}{$student}},'active');
1.288 raeburn 7370: $match = 1;
1.275 raeburn 7371: }
7372: }
7373: if (defined($$types{'previous'})) {
1.609 raeburn 7374: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 7375: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 7376: $match = 1;
1.275 raeburn 7377: }
7378: }
7379: if (defined($$types{'future'})) {
1.609 raeburn 7380: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 7381: push(@{$$users{st}{$student}},'future');
1.288 raeburn 7382: $match = 1;
1.275 raeburn 7383: }
7384: }
1.609 raeburn 7385: if ($match) {
7386: push(@{$seclists{$student}},$section);
7387: if (ref($userdata) eq 'HASH') {
7388: $$userdata{$student} = $$classlist{$student};
7389: }
7390: if (ref($statushash) eq 'HASH') {
7391: $statushash->{$student}{'st'}{$section} = $status;
7392: }
1.288 raeburn 7393: }
1.275 raeburn 7394: }
7395: }
1.412 raeburn 7396: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 7397: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7398: my $now = time;
1.609 raeburn 7399: my %displaystatus = ( previous => 'Expired',
7400: active => 'Active',
7401: future => 'Future',
7402: );
1.630 raeburn 7403: my %nothide;
7404: if ($hidepriv) {
7405: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
7406: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
7407: if ($user !~ /:/) {
7408: $nothide{join(':',split(/[\@]/,$user))}=1;
7409: } else {
7410: $nothide{$user} = 1;
7411: }
7412: }
7413: }
1.439 raeburn 7414: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 7415: my $match = 0;
1.412 raeburn 7416: my $secmatch = 0;
1.439 raeburn 7417: my $status;
1.412 raeburn 7418: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 7419: $user =~ s/:$//;
1.439 raeburn 7420: my ($end,$start) = split(/:/,$coursepersonnel{$person});
7421: if ($end == -1 || $start == -1) {
7422: next;
7423: }
7424: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
7425: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 7426: my ($uname,$udom) = split(/:/,$user);
7427: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7428: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7429: $secmatch = 1;
7430: } elsif ($usec eq '') {
1.420 albertel 7431: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7432: $secmatch = 1;
7433: }
7434: } else {
7435: if (grep(/^\Q$usec\E$/,@{$sections})) {
7436: $secmatch = 1;
7437: }
7438: }
7439: if (!$secmatch) {
7440: next;
7441: }
1.288 raeburn 7442: }
1.419 raeburn 7443: if ($usec eq '') {
7444: $usec = 'none';
7445: }
1.275 raeburn 7446: if ($uname ne '' && $udom ne '') {
1.630 raeburn 7447: if ($hidepriv) {
7448: if ((&Apache::lonnet::privileged($uname,$udom)) &&
7449: (!$nothide{$uname.':'.$udom})) {
7450: next;
7451: }
7452: }
1.503 raeburn 7453: if ($end > 0 && $end < $now) {
1.439 raeburn 7454: $status = 'previous';
7455: } elsif ($start > $now) {
7456: $status = 'future';
7457: } else {
7458: $status = 'active';
7459: }
1.277 albertel 7460: foreach my $type (keys(%{$types})) {
1.275 raeburn 7461: if ($status eq $type) {
1.420 albertel 7462: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 7463: push(@{$$users{$role}{$user}},$type);
7464: }
1.288 raeburn 7465: $match = 1;
7466: }
7467: }
1.419 raeburn 7468: if (($match) && (ref($userdata) eq 'HASH')) {
7469: if (!exists($$userdata{$uname.':'.$udom})) {
7470: &get_user_info($udom,$uname,\%idx,$userdata);
7471: }
1.420 albertel 7472: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 7473: push(@{$seclists{$uname.':'.$udom}},$usec);
7474: }
1.609 raeburn 7475: if (ref($statushash) eq 'HASH') {
7476: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
7477: }
1.275 raeburn 7478: }
7479: }
7480: }
7481: }
1.290 albertel 7482: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 7483: if ((defined($cdom)) && (defined($cnum))) {
7484: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
7485: if ( defined($csettings{'internal.courseowner'}) ) {
7486: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 7487: next if ($owner eq '');
7488: my ($ownername,$ownerdom);
7489: if ($owner =~ /^([^:]+):([^:]+)$/) {
7490: $ownername = $1;
7491: $ownerdom = $2;
7492: } else {
7493: $ownername = $owner;
7494: $ownerdom = $cdom;
7495: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 7496: }
7497: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 7498: if (defined($userdata) &&
1.609 raeburn 7499: !exists($$userdata{$owner})) {
7500: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
7501: if (!grep(/^none$/,@{$seclists{$owner}})) {
7502: push(@{$seclists{$owner}},'none');
7503: }
7504: if (ref($statushash) eq 'HASH') {
7505: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 7506: }
1.290 albertel 7507: }
1.279 raeburn 7508: }
7509: }
7510: }
1.419 raeburn 7511: foreach my $user (keys(%seclists)) {
7512: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
7513: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
7514: }
1.275 raeburn 7515: }
7516: return;
7517: }
7518:
1.288 raeburn 7519: sub get_user_info {
7520: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 7521: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
7522: &plainname($uname,$udom,'lastname');
1.291 albertel 7523: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 7524: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 7525: my %idhash = &Apache::lonnet::idrget($udom,($uname));
7526: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 7527: return;
7528: }
1.275 raeburn 7529:
1.472 raeburn 7530: ###############################################
7531:
7532: =pod
7533:
7534: =item * &get_user_quota()
7535:
7536: Retrieves quota assigned for storage of portfolio files for a user
7537:
7538: Incoming parameters:
7539: 1. user's username
7540: 2. user's domain
7541:
7542: Returns:
1.536 raeburn 7543: 1. Disk quota (in Mb) assigned to student.
7544: 2. (Optional) Type of setting: custom or default
7545: (individually assigned or default for user's
7546: institutional status).
7547: 3. (Optional) - User's institutional status (e.g., faculty, staff
7548: or student - types as defined in localenroll::inst_usertypes
7549: for user's domain, which determines default quota for user.
7550: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 7551:
7552: If a value has been stored in the user's environment,
1.536 raeburn 7553: it will return that, otherwise it returns the maximal default
7554: defined for the user's instituional status(es) in the domain.
1.472 raeburn 7555:
7556: =cut
7557:
7558: ###############################################
7559:
7560:
7561: sub get_user_quota {
7562: my ($uname,$udom) = @_;
1.536 raeburn 7563: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 7564: if (!defined($udom)) {
7565: $udom = $env{'user.domain'};
7566: }
7567: if (!defined($uname)) {
7568: $uname = $env{'user.name'};
7569: }
7570: if (($udom eq '' || $uname eq '') ||
7571: ($udom eq 'public') && ($uname eq 'public')) {
7572: $quota = 0;
1.536 raeburn 7573: $quotatype = 'default';
7574: $defquota = 0;
1.472 raeburn 7575: } else {
1.536 raeburn 7576: my $inststatus;
1.472 raeburn 7577: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
7578: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 7579: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 7580: } else {
1.536 raeburn 7581: my %userenv =
7582: &Apache::lonnet::get('environment',['portfolioquota',
7583: 'inststatus'],$udom,$uname);
1.472 raeburn 7584: my ($tmp) = keys(%userenv);
7585: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7586: $quota = $userenv{'portfolioquota'};
1.536 raeburn 7587: $inststatus = $userenv{'inststatus'};
1.472 raeburn 7588: } else {
7589: undef(%userenv);
7590: }
7591: }
1.536 raeburn 7592: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 7593: if ($quota eq '') {
1.536 raeburn 7594: $quota = $defquota;
7595: $quotatype = 'default';
7596: } else {
7597: $quotatype = 'custom';
1.472 raeburn 7598: }
7599: }
1.536 raeburn 7600: if (wantarray) {
7601: return ($quota,$quotatype,$settingstatus,$defquota);
7602: } else {
7603: return $quota;
7604: }
1.472 raeburn 7605: }
7606:
7607: ###############################################
7608:
7609: =pod
7610:
7611: =item * &default_quota()
7612:
1.536 raeburn 7613: Retrieves default quota assigned for storage of user portfolio files,
7614: given an (optional) user's institutional status.
1.472 raeburn 7615:
7616: Incoming parameters:
7617: 1. domain
1.536 raeburn 7618: 2. (Optional) institutional status(es). This is a : separated list of
7619: status types (e.g., faculty, staff, student etc.)
7620: which apply to the user for whom the default is being retrieved.
7621: If the institutional status string in undefined, the domain
7622: default quota will be returned.
1.472 raeburn 7623:
7624: Returns:
7625: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 7626: 2. (Optional) institutional type which determined the value of the
7627: default quota.
1.472 raeburn 7628:
7629: If a value has been stored in the domain's configuration db,
7630: it will return that, otherwise it returns 20 (for backwards
7631: compatibility with domains which have not set up a configuration
7632: db file; the original statically defined portfolio quota was 20 Mb).
7633:
1.536 raeburn 7634: If the user's status includes multiple types (e.g., staff and student),
7635: the largest default quota which applies to the user determines the
7636: default quota returned.
7637:
1.780 raeburn 7638: =back
7639:
1.472 raeburn 7640: =cut
7641:
7642: ###############################################
7643:
7644:
7645: sub default_quota {
1.536 raeburn 7646: my ($udom,$inststatus) = @_;
7647: my ($defquota,$settingstatus);
7648: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 7649: ['quotas'],$udom);
7650: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 7651: if ($inststatus ne '') {
1.765 raeburn 7652: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 7653: foreach my $item (@statuses) {
1.711 raeburn 7654: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7655: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
7656: if ($defquota eq '') {
7657: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7658: $settingstatus = $item;
7659: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
7660: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7661: $settingstatus = $item;
7662: }
7663: }
7664: } else {
7665: if ($quotahash{'quotas'}{$item} ne '') {
7666: if ($defquota eq '') {
7667: $defquota = $quotahash{'quotas'}{$item};
7668: $settingstatus = $item;
7669: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
7670: $defquota = $quotahash{'quotas'}{$item};
7671: $settingstatus = $item;
7672: }
1.536 raeburn 7673: }
7674: }
7675: }
7676: }
7677: if ($defquota eq '') {
1.711 raeburn 7678: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7679: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
7680: } else {
7681: $defquota = $quotahash{'quotas'}{'default'};
7682: }
1.536 raeburn 7683: $settingstatus = 'default';
7684: }
7685: } else {
7686: $settingstatus = 'default';
7687: $defquota = 20;
7688: }
7689: if (wantarray) {
7690: return ($defquota,$settingstatus);
1.472 raeburn 7691: } else {
1.536 raeburn 7692: return $defquota;
1.472 raeburn 7693: }
7694: }
7695:
1.384 raeburn 7696: sub get_secgrprole_info {
7697: my ($cdom,$cnum,$needroles,$type) = @_;
7698: my %sections_count = &get_sections($cdom,$cnum);
7699: my @sections = (sort {$a <=> $b} keys(%sections_count));
7700: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
7701: my @groups = sort(keys(%curr_groups));
7702: my $allroles = [];
7703: my $rolehash;
7704: my $accesshash = {
7705: active => 'Currently has access',
7706: future => 'Will have future access',
7707: previous => 'Previously had access',
7708: };
7709: if ($needroles) {
7710: $rolehash = {'all' => 'all'};
1.385 albertel 7711: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7712: if (&Apache::lonnet::error(%user_roles)) {
7713: undef(%user_roles);
7714: }
7715: foreach my $item (keys(%user_roles)) {
1.384 raeburn 7716: my ($role)=split(/\:/,$item,2);
7717: if ($role eq 'cr') { next; }
7718: if ($role =~ /^cr/) {
7719: $$rolehash{$role} = (split('/',$role))[3];
7720: } else {
7721: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
7722: }
7723: }
7724: foreach my $key (sort(keys(%{$rolehash}))) {
7725: push(@{$allroles},$key);
7726: }
7727: push (@{$allroles},'st');
7728: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
7729: }
7730: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
7731: }
7732:
1.555 raeburn 7733: sub user_picker {
1.994 raeburn 7734: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context) = @_;
1.555 raeburn 7735: my $currdom = $dom;
7736: my %curr_selected = (
7737: srchin => 'dom',
1.580 raeburn 7738: srchby => 'lastname',
1.555 raeburn 7739: );
7740: my $srchterm;
1.625 raeburn 7741: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 7742: if ($srch->{'srchby'} ne '') {
7743: $curr_selected{'srchby'} = $srch->{'srchby'};
7744: }
7745: if ($srch->{'srchin'} ne '') {
7746: $curr_selected{'srchin'} = $srch->{'srchin'};
7747: }
7748: if ($srch->{'srchtype'} ne '') {
7749: $curr_selected{'srchtype'} = $srch->{'srchtype'};
7750: }
7751: if ($srch->{'srchdomain'} ne '') {
7752: $currdom = $srch->{'srchdomain'};
7753: }
7754: $srchterm = $srch->{'srchterm'};
7755: }
7756: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 7757: 'usr' => 'Search criteria',
1.563 raeburn 7758: 'doma' => 'Domain/institution to search',
1.558 albertel 7759: 'uname' => 'username',
7760: 'lastname' => 'last name',
1.555 raeburn 7761: 'lastfirst' => 'last name, first name',
1.558 albertel 7762: 'crs' => 'in this course',
1.576 raeburn 7763: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 7764: 'alc' => 'all LON-CAPA',
1.573 raeburn 7765: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 7766: 'exact' => 'is',
7767: 'contains' => 'contains',
1.569 raeburn 7768: 'begins' => 'begins with',
1.571 raeburn 7769: 'youm' => "You must include some text to search for.",
7770: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
7771: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
7772: 'yomc' => "You must choose a domain when using an institutional directory search.",
7773: 'ymcd' => "You must choose a domain when using a domain search.",
7774: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
7775: 'whse' => "When searching by last,first you must include at least one character in the first name.",
7776: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 7777: );
1.563 raeburn 7778: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
7779: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 7780:
7781: my @srchins = ('crs','dom','alc','instd');
7782:
7783: foreach my $option (@srchins) {
7784: # FIXME 'alc' option unavailable until
7785: # loncreateuser::print_user_query_page()
7786: # has been completed.
7787: next if ($option eq 'alc');
1.880 raeburn 7788: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 7789: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 7790: if ($curr_selected{'srchin'} eq $option) {
7791: $srchinsel .= '
7792: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7793: } else {
7794: $srchinsel .= '
7795: <option value="'.$option.'">'.$lt{$option}.'</option>';
7796: }
1.555 raeburn 7797: }
1.563 raeburn 7798: $srchinsel .= "\n </select>\n";
1.555 raeburn 7799:
7800: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 7801: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 7802: if ($curr_selected{'srchby'} eq $option) {
7803: $srchbysel .= '
7804: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7805: } else {
7806: $srchbysel .= '
7807: <option value="'.$option.'">'.$lt{$option}.'</option>';
7808: }
7809: }
7810: $srchbysel .= "\n </select>\n";
7811:
7812: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 7813: foreach my $option ('begins','contains','exact') {
1.555 raeburn 7814: if ($curr_selected{'srchtype'} eq $option) {
7815: $srchtypesel .= '
7816: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7817: } else {
7818: $srchtypesel .= '
7819: <option value="'.$option.'">'.$lt{$option}.'</option>';
7820: }
7821: }
7822: $srchtypesel .= "\n </select>\n";
7823:
1.558 albertel 7824: my ($newuserscript,$new_user_create);
1.994 raeburn 7825: my $context_dom = $env{'request.role.domain'};
7826: if ($context eq 'requestcrs') {
7827: if ($env{'form.coursedom'} ne '') {
7828: $context_dom = $env{'form.coursedom'};
7829: }
7830: }
1.556 raeburn 7831: if ($forcenewuser) {
1.576 raeburn 7832: if (ref($srch) eq 'HASH') {
1.994 raeburn 7833: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 7834: if ($cancreate) {
7835: $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>';
7836: } else {
1.799 bisitz 7837: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 7838: my %usertypetext = (
7839: official => 'institutional',
7840: unofficial => 'non-institutional',
7841: );
1.799 bisitz 7842: $new_user_create = '<p class="LC_warning">'
7843: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
7844: .' '
7845: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
7846: ,'<a href="'.$helplink.'">','</a>')
7847: .'</p><br />';
1.627 raeburn 7848: }
1.576 raeburn 7849: }
7850: }
7851:
1.556 raeburn 7852: $newuserscript = <<"ENDSCRIPT";
7853:
1.570 raeburn 7854: function setSearch(createnew,callingForm) {
1.556 raeburn 7855: if (createnew == 1) {
1.570 raeburn 7856: for (var i=0; i<callingForm.srchby.length; i++) {
7857: if (callingForm.srchby.options[i].value == 'uname') {
7858: callingForm.srchby.selectedIndex = i;
1.556 raeburn 7859: }
7860: }
1.570 raeburn 7861: for (var i=0; i<callingForm.srchin.length; i++) {
7862: if ( callingForm.srchin.options[i].value == 'dom') {
7863: callingForm.srchin.selectedIndex = i;
1.556 raeburn 7864: }
7865: }
1.570 raeburn 7866: for (var i=0; i<callingForm.srchtype.length; i++) {
7867: if (callingForm.srchtype.options[i].value == 'exact') {
7868: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 7869: }
7870: }
1.570 raeburn 7871: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 7872: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 7873: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 7874: }
7875: }
7876: }
7877: }
7878: ENDSCRIPT
1.558 albertel 7879:
1.556 raeburn 7880: }
7881:
1.555 raeburn 7882: my $output = <<"END_BLOCK";
1.556 raeburn 7883: <script type="text/javascript">
1.824 bisitz 7884: // <![CDATA[
1.570 raeburn 7885: function validateEntry(callingForm) {
1.558 albertel 7886:
1.556 raeburn 7887: var checkok = 1;
1.558 albertel 7888: var srchin;
1.570 raeburn 7889: for (var i=0; i<callingForm.srchin.length; i++) {
7890: if ( callingForm.srchin[i].checked ) {
7891: srchin = callingForm.srchin[i].value;
1.558 albertel 7892: }
7893: }
7894:
1.570 raeburn 7895: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7896: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7897: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7898: var srchterm = callingForm.srchterm.value;
7899: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7900: var msg = "";
7901:
7902: if (srchterm == "") {
7903: checkok = 0;
1.571 raeburn 7904: msg += "$lt{'youm'}\\n";
1.556 raeburn 7905: }
7906:
1.569 raeburn 7907: if (srchtype== 'begins') {
7908: if (srchterm.length < 2) {
7909: checkok = 0;
1.571 raeburn 7910: msg += "$lt{'thte'}\\n";
1.569 raeburn 7911: }
7912: }
7913:
1.556 raeburn 7914: if (srchtype== 'contains') {
7915: if (srchterm.length < 3) {
7916: checkok = 0;
1.571 raeburn 7917: msg += "$lt{'thet'}\\n";
1.556 raeburn 7918: }
7919: }
7920: if (srchin == 'instd') {
7921: if (srchdomain == '') {
7922: checkok = 0;
1.571 raeburn 7923: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7924: }
7925: }
7926: if (srchin == 'dom') {
7927: if (srchdomain == '') {
7928: checkok = 0;
1.571 raeburn 7929: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7930: }
7931: }
7932: if (srchby == 'lastfirst') {
7933: if (srchterm.indexOf(",") == -1) {
7934: checkok = 0;
1.571 raeburn 7935: msg += "$lt{'whus'}\\n";
1.556 raeburn 7936: }
7937: if (srchterm.indexOf(",") == srchterm.length -1) {
7938: checkok = 0;
1.571 raeburn 7939: msg += "$lt{'whse'}\\n";
1.556 raeburn 7940: }
7941: }
7942: if (checkok == 0) {
1.571 raeburn 7943: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7944: return;
7945: }
7946: if (checkok == 1) {
1.570 raeburn 7947: callingForm.submit();
1.556 raeburn 7948: }
7949: }
7950:
7951: $newuserscript
7952:
1.824 bisitz 7953: // ]]>
1.556 raeburn 7954: </script>
1.558 albertel 7955:
7956: $new_user_create
7957:
1.555 raeburn 7958: END_BLOCK
1.558 albertel 7959:
1.876 raeburn 7960: $output .= &Apache::lonhtmlcommon::start_pick_box().
7961: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
7962: $domform.
7963: &Apache::lonhtmlcommon::row_closure().
7964: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
7965: $srchbysel.
7966: $srchtypesel.
7967: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
7968: $srchinsel.
7969: &Apache::lonhtmlcommon::row_closure(1).
7970: &Apache::lonhtmlcommon::end_pick_box().
7971: '<br />';
1.555 raeburn 7972: return $output;
7973: }
7974:
1.612 raeburn 7975: sub user_rule_check {
1.615 raeburn 7976: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 7977: my $response;
7978: if (ref($usershash) eq 'HASH') {
7979: foreach my $user (keys(%{$usershash})) {
7980: my ($uname,$udom) = split(/:/,$user);
7981: next if ($udom eq '' || $uname eq '');
1.615 raeburn 7982: my ($id,$newuser);
1.612 raeburn 7983: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 7984: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 7985: $id = $usershash->{$user}->{'id'};
7986: }
7987: my $inst_response;
7988: if (ref($checks) eq 'HASH') {
7989: if (defined($checks->{'username'})) {
1.615 raeburn 7990: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7991: &Apache::lonnet::get_instuser($udom,$uname);
7992: } elsif (defined($checks->{'id'})) {
1.615 raeburn 7993: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7994: &Apache::lonnet::get_instuser($udom,undef,$id);
7995: }
1.615 raeburn 7996: } else {
7997: ($inst_response,%{$inst_results->{$user}}) =
7998: &Apache::lonnet::get_instuser($udom,$uname);
7999: return;
1.612 raeburn 8000: }
1.615 raeburn 8001: if (!$got_rules->{$udom}) {
1.612 raeburn 8002: my %domconfig = &Apache::lonnet::get_dom('configuration',
8003: ['usercreation'],$udom);
8004: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 8005: foreach my $item ('username','id') {
1.612 raeburn 8006: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
8007: $$curr_rules{$udom}{$item} =
8008: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 8009: }
8010: }
8011: }
1.615 raeburn 8012: $got_rules->{$udom} = 1;
1.585 raeburn 8013: }
1.612 raeburn 8014: foreach my $item (keys(%{$checks})) {
8015: if (ref($$curr_rules{$udom}) eq 'HASH') {
8016: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
8017: if (@{$$curr_rules{$udom}{$item}} > 0) {
8018: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
8019: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
8020: if ($rule_check{$rule}) {
8021: $$rulematch{$user}{$item} = $rule;
8022: if ($inst_response eq 'ok') {
1.615 raeburn 8023: if (ref($inst_results) eq 'HASH') {
8024: if (ref($inst_results->{$user}) eq 'HASH') {
8025: if (keys(%{$inst_results->{$user}}) == 0) {
8026: $$alerts{$item}{$udom}{$uname} = 1;
8027: }
1.612 raeburn 8028: }
8029: }
1.615 raeburn 8030: }
8031: last;
1.585 raeburn 8032: }
8033: }
8034: }
8035: }
8036: }
8037: }
8038: }
8039: }
1.612 raeburn 8040: return;
8041: }
8042:
8043: sub user_rule_formats {
8044: my ($domain,$domdesc,$curr_rules,$check) = @_;
8045: my %text = (
8046: 'username' => 'Usernames',
8047: 'id' => 'IDs',
8048: );
8049: my $output;
8050: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
8051: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
8052: if (@{$ruleorder} > 0) {
8053: $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>';
8054: foreach my $rule (@{$ruleorder}) {
8055: if (ref($curr_rules) eq 'ARRAY') {
8056: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
8057: if (ref($rules->{$rule}) eq 'HASH') {
8058: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
8059: $rules->{$rule}{'desc'}.'</li>';
8060: }
8061: }
8062: }
8063: }
8064: $output .= '</ul>';
8065: }
8066: }
8067: return $output;
8068: }
8069:
8070: sub instrule_disallow_msg {
1.615 raeburn 8071: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 8072: my $response;
8073: my %text = (
8074: item => 'username',
8075: items => 'usernames',
8076: match => 'matches',
8077: do => 'does',
8078: action => 'a username',
8079: one => 'one',
8080: );
8081: if ($count > 1) {
8082: $text{'item'} = 'usernames';
8083: $text{'match'} ='match';
8084: $text{'do'} = 'do';
8085: $text{'action'} = 'usernames',
8086: $text{'one'} = 'ones';
8087: }
8088: if ($checkitem eq 'id') {
8089: $text{'items'} = 'IDs';
8090: $text{'item'} = 'ID';
8091: $text{'action'} = 'an ID';
1.615 raeburn 8092: if ($count > 1) {
8093: $text{'item'} = 'IDs';
8094: $text{'action'} = 'IDs';
8095: }
1.612 raeburn 8096: }
1.674 bisitz 8097: $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 8098: if ($mode eq 'upload') {
8099: if ($checkitem eq 'username') {
8100: $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'}.");
8101: } elsif ($checkitem eq 'id') {
1.674 bisitz 8102: $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 8103: }
1.669 raeburn 8104: } elsif ($mode eq 'selfcreate') {
8105: if ($checkitem eq 'id') {
8106: $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.");
8107: }
1.615 raeburn 8108: } else {
8109: if ($checkitem eq 'username') {
8110: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
8111: } elsif ($checkitem eq 'id') {
8112: $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.");
8113: }
1.612 raeburn 8114: }
8115: return $response;
1.585 raeburn 8116: }
8117:
1.624 raeburn 8118: sub personal_data_fieldtitles {
8119: my %fieldtitles = &Apache::lonlocal::texthash (
8120: id => 'Student/Employee ID',
8121: permanentemail => 'E-mail address',
8122: lastname => 'Last Name',
8123: firstname => 'First Name',
8124: middlename => 'Middle Name',
8125: generation => 'Generation',
8126: gen => 'Generation',
1.765 raeburn 8127: inststatus => 'Affiliation',
1.624 raeburn 8128: );
8129: return %fieldtitles;
8130: }
8131:
1.642 raeburn 8132: sub sorted_inst_types {
8133: my ($dom) = @_;
8134: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
8135: my $othertitle = &mt('All users');
8136: if ($env{'request.course.id'}) {
1.668 raeburn 8137: $othertitle = &mt('Any users');
1.642 raeburn 8138: }
8139: my @types;
8140: if (ref($order) eq 'ARRAY') {
8141: @types = @{$order};
8142: }
8143: if (@types == 0) {
8144: if (ref($usertypes) eq 'HASH') {
8145: @types = sort(keys(%{$usertypes}));
8146: }
8147: }
8148: if (keys(%{$usertypes}) > 0) {
8149: $othertitle = &mt('Other users');
8150: }
8151: return ($othertitle,$usertypes,\@types);
8152: }
8153:
1.645 raeburn 8154: sub get_institutional_codes {
8155: my ($settings,$allcourses,$LC_code) = @_;
8156: # Get complete list of course sections to update
8157: my @currsections = ();
8158: my @currxlists = ();
8159: my $coursecode = $$settings{'internal.coursecode'};
8160:
8161: if ($$settings{'internal.sectionnums'} ne '') {
8162: @currsections = split(/,/,$$settings{'internal.sectionnums'});
8163: }
8164:
8165: if ($$settings{'internal.crosslistings'} ne '') {
8166: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
8167: }
8168:
8169: if (@currxlists > 0) {
8170: foreach (@currxlists) {
8171: if (m/^([^:]+):(\w*)$/) {
8172: unless (grep/^$1$/,@{$allcourses}) {
8173: push @{$allcourses},$1;
8174: $$LC_code{$1} = $2;
8175: }
8176: }
8177: }
8178: }
8179:
8180: if (@currsections > 0) {
8181: foreach (@currsections) {
8182: if (m/^(\w+):(\w*)$/) {
8183: my $sec = $coursecode.$1;
8184: my $lc_sec = $2;
8185: unless (grep/^$sec$/,@{$allcourses}) {
8186: push @{$allcourses},$sec;
8187: $$LC_code{$sec} = $lc_sec;
8188: }
8189: }
8190: }
8191: }
8192: return;
8193: }
8194:
1.971 raeburn 8195: sub get_standard_codeitems {
8196: return ('Year','Semester','Department','Number','Section');
8197: }
8198:
1.112 bowersj2 8199: =pod
8200:
1.780 raeburn 8201: =head1 Slot Helpers
8202:
8203: =over 4
8204:
8205: =item * sorted_slots()
8206:
8207: Sorts an array of slot names in order of slot start time (earliest first).
8208:
8209: Inputs:
8210:
8211: =over 4
8212:
8213: slotsarr - Reference to array of unsorted slot names.
8214:
8215: slots - Reference to hash of hash, where outer hash keys are slot names.
8216:
1.549 albertel 8217: =back
8218:
1.780 raeburn 8219: Returns:
8220:
8221: =over 4
8222:
8223: sorted - An array of slot names sorted by the start time of the slot.
8224:
8225: =back
8226:
8227: =back
8228:
8229: =cut
8230:
8231:
8232: sub sorted_slots {
8233: my ($slotsarr,$slots) = @_;
8234: my @sorted;
8235: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
8236: @sorted =
8237: sort {
8238: if (ref($slots->{$a}) && ref($slots->{$b})) {
8239: return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
8240: }
8241: if (ref($slots->{$a})) { return -1;}
8242: if (ref($slots->{$b})) { return 1;}
8243: return 0;
8244: } @{$slotsarr};
8245: }
8246: return @sorted;
8247: }
8248:
8249:
8250: =pod
8251:
1.549 albertel 8252: =head1 HTTP Helpers
8253:
8254: =over 4
8255:
1.648 raeburn 8256: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 8257:
1.258 albertel 8258: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 8259: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 8260: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 8261:
8262: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
8263: $possible_names is an ref to an array of form element names. As an example:
8264: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 8265: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 8266:
8267: =cut
1.1 albertel 8268:
1.6 albertel 8269: sub get_unprocessed_cgi {
1.25 albertel 8270: my ($query,$possible_names)= @_;
1.26 matthew 8271: # $Apache::lonxml::debug=1;
1.356 albertel 8272: foreach my $pair (split(/&/,$query)) {
8273: my ($name, $value) = split(/=/,$pair);
1.369 www 8274: $name = &unescape($name);
1.25 albertel 8275: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
8276: $value =~ tr/+/ /;
8277: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 8278: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 8279: }
1.16 harris41 8280: }
1.6 albertel 8281: }
8282:
1.112 bowersj2 8283: =pod
8284:
1.648 raeburn 8285: =item * &cacheheader()
1.112 bowersj2 8286:
8287: returns cache-controlling header code
8288:
8289: =cut
8290:
1.7 albertel 8291: sub cacheheader {
1.258 albertel 8292: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 8293: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
8294: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 8295: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
8296: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 8297: return $output;
1.7 albertel 8298: }
8299:
1.112 bowersj2 8300: =pod
8301:
1.648 raeburn 8302: =item * &no_cache($r)
1.112 bowersj2 8303:
8304: specifies header code to not have cache
8305:
8306: =cut
8307:
1.9 albertel 8308: sub no_cache {
1.216 albertel 8309: my ($r) = @_;
8310: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 8311: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 8312: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
8313: $r->no_cache(1);
8314: $r->header_out("Expires" => $date);
8315: $r->header_out("Pragma" => "no-cache");
1.123 www 8316: }
8317:
8318: sub content_type {
1.181 albertel 8319: my ($r,$type,$charset) = @_;
1.299 foxr 8320: if ($r) {
8321: # Note that printout.pl calls this with undef for $r.
8322: &no_cache($r);
8323: }
1.258 albertel 8324: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 8325: unless ($charset) {
8326: $charset=&Apache::lonlocal::current_encoding;
8327: }
8328: if ($charset) { $type.='; charset='.$charset; }
8329: if ($r) {
8330: $r->content_type($type);
8331: } else {
8332: print("Content-type: $type\n\n");
8333: }
1.9 albertel 8334: }
1.25 albertel 8335:
1.112 bowersj2 8336: =pod
8337:
1.648 raeburn 8338: =item * &add_to_env($name,$value)
1.112 bowersj2 8339:
1.258 albertel 8340: adds $name to the %env hash with value
1.112 bowersj2 8341: $value, if $name already exists, the entry is converted to an array
8342: reference and $value is added to the array.
8343:
8344: =cut
8345:
1.25 albertel 8346: sub add_to_env {
8347: my ($name,$value)=@_;
1.258 albertel 8348: if (defined($env{$name})) {
8349: if (ref($env{$name})) {
1.25 albertel 8350: #already have multiple values
1.258 albertel 8351: push(@{ $env{$name} },$value);
1.25 albertel 8352: } else {
8353: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 8354: my $first=$env{$name};
8355: undef($env{$name});
8356: push(@{ $env{$name} },$first,$value);
1.25 albertel 8357: }
8358: } else {
1.258 albertel 8359: $env{$name}=$value;
1.25 albertel 8360: }
1.31 albertel 8361: }
1.149 albertel 8362:
8363: =pod
8364:
1.648 raeburn 8365: =item * &get_env_multiple($name)
1.149 albertel 8366:
1.258 albertel 8367: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 8368: values may be defined and end up as an array ref.
8369:
8370: returns an array of values
8371:
8372: =cut
8373:
8374: sub get_env_multiple {
8375: my ($name) = @_;
8376: my @values;
1.258 albertel 8377: if (defined($env{$name})) {
1.149 albertel 8378: # exists is it an array
1.258 albertel 8379: if (ref($env{$name})) {
8380: @values=@{ $env{$name} };
1.149 albertel 8381: } else {
1.258 albertel 8382: $values[0]=$env{$name};
1.149 albertel 8383: }
8384: }
8385: return(@values);
8386: }
8387:
1.660 raeburn 8388: sub ask_for_embedded_content {
8389: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.987 raeburn 8390: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges);
1.660 raeburn 8391: my $num = 0;
1.987 raeburn 8392: my $numremref = 0;
8393: my $numinvalid = 0;
8394: my $numpathchg = 0;
8395: my $numexisting = 0;
8396: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath);
1.984 raeburn 8397: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
8398: my $current_path='/';
8399: if ($env{'form.currentpath'}) {
8400: $current_path = $env{'form.currentpath'};
8401: }
8402: if ($actionurl eq '/adm/coursegrp_portfolio') {
8403: $udom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8404: $uname = $env{'course.'.$env{'request.course.id'}.'.num'};
8405: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
8406: } else {
8407: $udom = $env{'user.domain'};
8408: $uname = $env{'user.name'};
8409: $url = '/userfiles/portfolio';
8410: }
1.987 raeburn 8411: $toplevel = $url.'/';
1.984 raeburn 8412: $url .= $current_path;
8413: $getpropath = 1;
1.987 raeburn 8414: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
8415: ($actionurl eq '/adm/imsimport')) {
1.984 raeburn 8416: ($uname,my $rest) = ($args->{'current_path'} =~ m{/priv/($match_username)/?(.*)$});
1.987 raeburn 8417: $url = '/home/'.$uname.'/public_html/';
8418: $toplevel = $url;
1.984 raeburn 8419: if ($rest ne '') {
1.987 raeburn 8420: $url .= $rest;
8421: }
8422: } elsif ($actionurl eq '/adm/coursedocs') {
8423: if (ref($args) eq 'HASH') {
8424: $url = $args->{'docs_url'};
8425: $toplevel = $url;
8426: }
8427: }
8428: my $now = time();
8429: foreach my $embed_file (keys(%{$allfiles})) {
8430: my $absolutepath;
8431: if ($embed_file =~ m{^\w+://}) {
8432: $newfiles{$embed_file} = 1;
8433: $mapping{$embed_file} = $embed_file;
8434: } else {
8435: if ($embed_file =~ m{^/}) {
8436: $absolutepath = $embed_file;
8437: $embed_file =~ s{^(/+)}{};
8438: }
8439: if ($embed_file =~ m{/}) {
8440: my ($path,$fname) = ($embed_file =~ m{^(.+)/([^/]*)$});
8441: $path = &check_for_traversal($path,$url,$toplevel);
8442: my $item = $fname;
8443: if ($path ne '') {
8444: $item = $path.'/'.$fname;
8445: $subdependencies{$path}{$fname} = 1;
8446: } else {
8447: $dependencies{$item} = 1;
8448: }
8449: if ($absolutepath) {
8450: $mapping{$item} = $absolutepath;
8451: } else {
8452: $mapping{$item} = $embed_file;
8453: }
8454: } else {
8455: $dependencies{$embed_file} = 1;
8456: if ($absolutepath) {
8457: $mapping{$embed_file} = $absolutepath;
8458: } else {
8459: $mapping{$embed_file} = $embed_file;
8460: }
8461: }
1.984 raeburn 8462: }
8463: }
8464: foreach my $path (keys(%subdependencies)) {
8465: my %currsubfile;
8466: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
8467: my @subdir_list = &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
8468: foreach my $line (@subdir_list) {
8469: my ($file_name,$rest) = split(/\&/,$line,2);
8470: $currsubfile{$file_name} = 1;
8471: }
1.987 raeburn 8472: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 8473: if (opendir(my $dir,$url.'/'.$path)) {
8474: my @subdir_list = grep(!/^\./,readdir($dir));
8475: map {$currsubfile{$_} = 1;} @subdir_list;
8476: }
8477: }
8478: foreach my $file (keys(%{$subdependencies{$path}})) {
1.987 raeburn 8479: if ($currsubfile{$file}) {
8480: my $item = $path.'/'.$file;
8481: unless ($mapping{$item} eq $item) {
8482: $pathchanges{$item} = 1;
8483: }
8484: $existing{$item} = 1;
8485: $numexisting ++;
8486: } else {
8487: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 8488: }
8489: }
8490: }
1.987 raeburn 8491: my %currfile;
1.984 raeburn 8492: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
8493: my @dir_list = &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
8494: foreach my $line (@dir_list) {
8495: my ($file_name,$rest) = split(/\&/,$line,2);
8496: $currfile{$file_name} = 1;
8497: }
1.987 raeburn 8498: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 8499: if (opendir(my $dir,$url)) {
1.987 raeburn 8500: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 8501: map {$currfile{$_} = 1;} @dir_list;
8502: }
8503: }
8504: foreach my $file (keys(%dependencies)) {
1.987 raeburn 8505: if ($currfile{$file}) {
8506: unless ($mapping{$file} eq $file) {
8507: $pathchanges{$file} = 1;
8508: }
8509: $existing{$file} = 1;
8510: $numexisting ++;
8511: } else {
1.984 raeburn 8512: $newfiles{$file} = 1;
8513: }
8514: }
8515: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.660 raeburn 8516: $upload_output .= &start_data_table_row().
1.987 raeburn 8517: '<td><span class="LC_filename">'.$embed_file.'</span>';
8518: unless ($mapping{$embed_file} eq $embed_file) {
8519: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.&mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
8520: }
8521: $upload_output .= '</td><td>';
1.660 raeburn 8522: if ($args->{'ignore_remote_references'}
8523: && $embed_file =~ m{^\w+://}) {
8524: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
1.987 raeburn 8525: $numremref++;
1.660 raeburn 8526: } elsif ($args->{'error_on_invalid_names'}
8527: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
8528:
1.987 raeburn 8529: $upload_output.='<span class="LC_warning">'.&mt('Invalid characters').'</span>';
8530: $numinvalid++;
1.660 raeburn 8531: } else {
1.987 raeburn 8532: $upload_output .= &embedded_file_element('upload_embedded',$num,
8533: $embed_file,\%mapping,
8534: $allfiles,$codebase);
8535: $num++;
8536: }
8537: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
8538: }
8539: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
8540: $upload_output .= &start_data_table_row().
8541: '<td><span class="LC_filename">'.$embed_file.'</span></td>'.
8542: '<td><span class="LC_warning">'.&mt('Already exists').'</span></td>'.
8543: &Apache::loncommon::end_data_table_row()."\n";
8544: }
8545: if ($upload_output) {
8546: $upload_output = &start_data_table().
8547: $upload_output.
8548: &end_data_table()."\n";
8549: }
8550: my $applies = 0;
8551: if ($numremref) {
8552: $applies ++;
8553: }
8554: if ($numinvalid) {
8555: $applies ++;
8556: }
8557: if ($numexisting) {
8558: $applies ++;
8559: }
8560: if ($num) {
8561: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
8562: ' method="post" enctype="multipart/form-data">'."\n".
8563: $state.
8564: '<h3>'.&mt('Upload embedded files').
8565: ':</h3>'.$upload_output.'<br />'."\n".
8566: '<input type ="hidden" name="number_embedded_items" value="'.
8567: $num.'" />'."\n";
8568: if ($actionurl eq '') {
8569: $output .= '<input type="hidden" name="phase" value="three" />';
8570: }
8571: } elsif ($applies) {
8572: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
8573: if ($applies > 1) {
8574: $output .=
8575: &mt('No files need to be uploaded, as one of the following applies to each reference:').'<ul>';
8576: if ($numremref) {
8577: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
8578: }
8579: if ($numinvalid) {
8580: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
8581: }
8582: if ($numexisting) {
8583: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
8584: }
8585: $output .= '</ul><br />';
8586: } elsif ($numremref) {
8587: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
8588: } elsif ($numinvalid) {
8589: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
8590: } elsif ($numexisting) {
8591: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
8592: }
8593: $output .= $upload_output.'<br />';
8594: }
8595: my ($pathchange_output,$chgcount);
8596: $chgcount = $num;
8597: if (keys(%pathchanges) > 0) {
8598: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
8599: if ($num) {
8600: $output .= &embedded_file_element('pathchange',$chgcount,
8601: $embed_file,\%mapping,
8602: $allfiles,$codebase);
8603: } else {
8604: $pathchange_output .=
8605: &start_data_table_row().
8606: '<td><input type ="checkbox" name="namechange" value="'.
8607: $chgcount.'" checked="checked" /></td>'.
8608: '<td>'.$mapping{$embed_file}.'</td>'.
8609: '<td>'.$embed_file.
8610: &embedded_file_element('pathchange',$numpathchg,$embed_file,
8611: \%mapping,$allfiles,$codebase).
8612: '</td>'.&end_data_table_row();
1.660 raeburn 8613: }
1.987 raeburn 8614: $numpathchg ++;
8615: $chgcount ++;
1.660 raeburn 8616: }
8617: }
1.984 raeburn 8618: if ($num) {
1.987 raeburn 8619: if ($numpathchg) {
8620: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
8621: $numpathchg.'" />'."\n";
8622: }
8623: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
8624: ($actionurl eq '/adm/imsimport')) {
8625: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
8626: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
8627: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
8628: }
8629: $output .= '<input type ="submit" value="'.&mt('Upload Listed Files').'" />'."\n".
8630: &mt('(only files for which a location has been provided will be uploaded)').'</form>'."\n";
8631: } elsif ($numpathchg) {
8632: my %pathchange = ();
8633: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
8634: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
8635: $output .= '<p>'.&mt('or').'</p>';
8636: }
8637: }
8638: return ($output,$num,$numpathchg);
8639: }
8640:
8641: sub embedded_file_element {
8642: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase) = @_;
8643: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
8644: (ref($codebase) eq 'HASH'));
8645: my $output;
8646: if ($context eq 'upload_embedded') {
8647: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
8648: }
8649: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
8650: &escape($embed_file).'" />';
8651: unless (($context eq 'upload_embedded') &&
8652: ($mapping->{$embed_file} eq $embed_file)) {
8653: $output .='
8654: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
8655: }
8656: my $attrib;
8657: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
8658: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
8659: }
8660: $output .=
8661: "\n\t\t".
8662: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
8663: $attrib.'" />';
8664: if (exists($codebase->{$mapping->{$embed_file}})) {
8665: $output .=
8666: "\n\t\t".
8667: '<input name="codebase_'.$num.'" type="hidden" value="'.
8668: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 8669: }
1.987 raeburn 8670: return $output;
1.660 raeburn 8671: }
8672:
1.661 raeburn 8673: sub upload_embedded {
8674: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 8675: $current_disk_usage,$hiddenstate,$actionurl) = @_;
8676: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 8677: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
8678: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
8679: my $orig_uploaded_filename =
8680: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 8681: foreach my $type ('orig','ref','attrib','codebase') {
8682: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
8683: $env{'form.embedded_'.$type.'_'.$i} =
8684: &unescape($env{'form.embedded_'.$type.'_'.$i});
8685: }
8686: }
1.661 raeburn 8687: my ($path,$fname) =
8688: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
8689: # no path, whole string is fname
8690: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
8691: $fname = &Apache::lonnet::clean_filename($fname);
8692: # See if there is anything left
8693: next if ($fname eq '');
8694:
8695: # Check if file already exists as a file or directory.
8696: my ($state,$msg);
8697: if ($context eq 'portfolio') {
8698: my $port_path = $dirpath;
8699: if ($group ne '') {
8700: $port_path = "groups/$group/$port_path";
8701: }
1.987 raeburn 8702: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
8703: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 8704: $dir_root,$port_path,$disk_quota,
8705: $current_disk_usage,$uname,$udom);
8706: if ($state eq 'will_exceed_quota'
1.984 raeburn 8707: || $state eq 'file_locked') {
1.661 raeburn 8708: $output .= $msg;
8709: next;
8710: }
8711: } elsif (($context eq 'author') || ($context eq 'testbank')) {
8712: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
8713: if ($state eq 'exists') {
8714: $output .= $msg;
8715: next;
8716: }
8717: }
8718: # Check if extension is valid
8719: if (($fname =~ /\.(\w+)$/) &&
8720: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.987 raeburn 8721: $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 8722: next;
8723: } elsif (($fname =~ /\.(\w+)$/) &&
8724: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 8725: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 8726: next;
8727: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.987 raeburn 8728: $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 8729: next;
8730: }
8731:
8732: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
8733: if ($context eq 'portfolio') {
1.984 raeburn 8734: my $result;
8735: if ($state eq 'existingfile') {
8736: $result=
8737: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.987 raeburn 8738: $dirpath.$env{'form.currentpath'}.$path);
1.661 raeburn 8739: } else {
1.984 raeburn 8740: $result=
8741: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 8742: $dirpath.
8743: $env{'form.currentpath'}.$path);
1.984 raeburn 8744: if ($result !~ m|^/uploaded/|) {
8745: $output .= '<span class="LC_error">'
8746: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
8747: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
8748: .'</span><br />';
8749: next;
8750: } else {
1.987 raeburn 8751: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
8752: $path.$fname.'</span>').'<br />';
1.984 raeburn 8753: }
1.661 raeburn 8754: }
1.987 raeburn 8755: } elsif ($context eq 'coursedoc') {
8756: my $result =
8757: &Apache::lonnet::userfileupload('embedded_item_'.$i,'coursedoc',
8758: $dirpath.'/'.$path);
8759: if ($result !~ m|^/uploaded/|) {
8760: $output .= '<span class="LC_error">'
8761: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
8762: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
8763: .'</span><br />';
8764: next;
8765: } else {
8766: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
8767: $path.$fname.'</span>').'<br />';
8768: }
1.661 raeburn 8769: } else {
8770: # Save the file
8771: my $target = $env{'form.embedded_item_'.$i};
8772: my $fullpath = $dir_root.$dirpath.'/'.$path;
8773: my $dest = $fullpath.$fname;
8774: my $url = $url_root.$dirpath.'/'.$path.$fname;
8775: my @parts=split(/\//,$fullpath);
8776: my $count;
8777: my $filepath = $dir_root;
8778: for ($count=4;$count<=$#parts;$count++) {
8779: $filepath .= "/$parts[$count]";
8780: if ((-e $filepath)!=1) {
8781: mkdir($filepath,0770);
8782: }
8783: }
8784: my $fh;
8785: if (!open($fh,'>'.$dest)) {
8786: &Apache::lonnet::logthis('Failed to create '.$dest);
8787: $output .= '<span class="LC_error">'.
8788: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8789: '</span><br />';
8790: } else {
8791: if (!print $fh $env{'form.embedded_item_'.$i}) {
8792: &Apache::lonnet::logthis('Failed to write to '.$dest);
8793: $output .= '<span class="LC_error">'.
8794: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8795: '</span><br />';
8796: } else {
1.987 raeburn 8797: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
8798: $url.'</span>').'<br />';
8799: unless ($context eq 'testbank') {
8800: $footer .= &mt('View embedded file: [_1]',
8801: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
8802: }
8803: }
8804: close($fh);
8805: }
8806: }
8807: if ($env{'form.embedded_ref_'.$i}) {
8808: $pathchange{$i} = 1;
8809: }
8810: }
8811: if ($output) {
8812: $output = '<p>'.$output.'</p>';
8813: }
8814: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
8815: $returnflag = 'ok';
8816: if (keys(%pathchange) > 0) {
8817: if ($context eq 'portfolio') {
8818: $output .= '<p>'.&mt('or').'</p>';
8819: } elsif ($context eq 'testbank') {
1.988 raeburn 8820: $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 8821: $returnflag = 'modify_orightml';
8822: }
8823: }
8824: return ($output.$footer,$returnflag);
8825: }
8826:
8827: sub modify_html_form {
8828: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
8829: my $end = 0;
8830: my $modifyform;
8831: if ($context eq 'upload_embedded') {
8832: return unless (ref($pathchange) eq 'HASH');
8833: if ($env{'form.number_embedded_items'}) {
8834: $end += $env{'form.number_embedded_items'};
8835: }
8836: if ($env{'form.number_pathchange_items'}) {
8837: $end += $env{'form.number_pathchange_items'};
8838: }
8839: if ($end) {
8840: for (my $i=0; $i<$end; $i++) {
8841: if ($i < $env{'form.number_embedded_items'}) {
8842: next unless($pathchange->{$i});
8843: }
8844: $modifyform .=
8845: &start_data_table_row().
8846: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
8847: 'checked="checked" /></td>'.
8848: '<td>'.$env{'form.embedded_ref_'.$i}.
8849: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
8850: &escape($env{'form.embedded_ref_'.$i}).'" />'.
8851: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
8852: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
8853: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
8854: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
8855: '<td>'.$env{'form.embedded_orig_'.$i}.
8856: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
8857: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
8858: &end_data_table_row();
8859: }
8860: }
8861: } else {
8862: $modifyform = $pathchgtable;
8863: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
8864: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
8865: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
8866: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
8867: }
8868: }
8869: if ($modifyform) {
8870: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
8871: '<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".
8872: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
8873: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
8874: '</ol></p>'."\n".'<p>'.
8875: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
8876: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
8877: &start_data_table()."\n".
8878: &start_data_table_header_row().
8879: '<th>'.&mt('Change?').'</th>'.
8880: '<th>'.&mt('Current reference').'</th>'.
8881: '<th>'.&mt('Required reference').'</th>'.
8882: &end_data_table_header_row()."\n".
8883: $modifyform.
8884: &end_data_table().'<br />'."\n".$hiddenstate.
8885: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
8886: '</form>'."\n";
8887: }
8888: return;
8889: }
8890:
8891: sub modify_html_refs {
8892: my ($context,$dirpath,$uname,$udom,$dir_root) = @_;
8893: my $container;
8894: if ($context eq 'portfolio') {
8895: $container = $env{'form.container'};
8896: } elsif ($context eq 'coursedoc') {
8897: $container = $env{'form.primaryurl'};
8898: } else {
8899: $container = $env{'form.filename'};
8900: $container =~ s{^/priv/(\Q$uname\E)/(.*)}{/home/$1/public_html/$2};
8901: }
8902: my (%allfiles,%codebase,$output,$content);
8903: my @changes = &get_env_multiple('form.namechange');
8904: return unless (@changes > 0);
8905: if (($context eq 'portfolio') || ($context eq 'coursedoc')) {
8906: return unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/});
8907: $content = &Apache::lonnet::getfile($container);
8908: return if ($content eq '-1');
8909: } else {
8910: return unless ($container =~ /^\Q$dir_root\E/);
8911: if (open(my $fh,"<$container")) {
8912: $content = join('', <$fh>);
8913: close($fh);
8914: } else {
8915: return;
8916: }
8917: }
8918: my ($count,$codebasecount) = (0,0);
8919: my $mm = new File::MMagic;
8920: my $mime_type = $mm->checktype_contents($content);
8921: if ($mime_type eq 'text/html') {
8922: my $parse_result =
8923: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
8924: \%codebase,\$content);
8925: if ($parse_result eq 'ok') {
8926: foreach my $i (@changes) {
8927: my $orig = &unescape($env{'form.embedded_orig_'.$i});
8928: my $ref = &unescape($env{'form.embedded_ref_'.$i});
8929: if ($allfiles{$ref}) {
8930: my $newname = $orig;
8931: my ($attrib_regexp,$codebase);
8932: my $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
8933: if ($attrib_regexp =~ /:/) {
8934: $attrib_regexp =~ s/\:/|/g;
8935: }
8936: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
8937: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
8938: $count += $numchg;
8939: }
8940: if ($env{'form.embedded_codebase_'.$i} ne '') {
8941: my $codebase = &unescape($env{'form.embedded_codebase_'.$i});
8942: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
8943: $codebasecount ++;
8944: }
8945: }
8946: }
8947: if ($count || $codebasecount) {
8948: my $saveresult;
8949: if ($context eq 'portfolio' || $context eq 'coursedoc') {
8950: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
8951: if ($url eq $container) {
8952: my ($fname) = ($container =~ m{/([^/]+)$});
8953: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
8954: $count,'<span class="LC_filename">'.
8955: $fname.'</span>').'</p>';
8956: } else {
8957: $output = '<p class="LC_error">'.
8958: &mt('Error: update failed for: [_1].',
8959: '<span class="LC_filename">'.
8960: $container.'</span>').'</p>';
8961: }
8962: } else {
8963: if (open(my $fh,">$container")) {
8964: print $fh $content;
8965: close($fh);
8966: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
8967: $count,'<span class="LC_filename">'.
8968: $container.'</span>').'</p>';
1.661 raeburn 8969: } else {
1.987 raeburn 8970: $output = '<p class="LC_error">'.
8971: &mt('Error: could not update [_1].',
8972: '<span class="LC_filename">'.
8973: $container.'</span>').'</p>';
1.661 raeburn 8974: }
8975: }
8976: }
1.987 raeburn 8977: } else {
8978: &logthis('Failed to parse '.$container.
8979: ' to modify references: '.$parse_result);
1.661 raeburn 8980: }
8981: }
8982: return $output;
8983: }
8984:
8985: sub check_for_existing {
8986: my ($path,$fname,$element) = @_;
8987: my ($state,$msg);
8988: if (-d $path.'/'.$fname) {
8989: $state = 'exists';
8990: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8991: } elsif (-e $path.'/'.$fname) {
8992: $state = 'exists';
8993: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8994: }
8995: if ($state eq 'exists') {
8996: $msg = '<span class="LC_error">'.$msg.'</span><br />';
8997: }
8998: return ($state,$msg);
8999: }
9000:
9001: sub check_for_upload {
9002: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
9003: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 9004: my $filesize = length($env{'form.'.$element});
9005: if (!$filesize) {
9006: my $msg = '<span class="LC_error">'.
9007: &mt('Unable to upload [_1]. (size = [_2] bytes)',
9008: '<span class="LC_filename">'.$fname.'</span>',
9009: $filesize).'<br />'.
1.992 raeburn 9010: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />';
1.985 raeburn 9011: '</span>';
9012: return ('zero_bytes',$msg);
9013: }
9014: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 9015: my $getpropath = 1;
9016: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
9017: $getpropath);
9018: my $found_file = 0;
9019: my $locked_file = 0;
1.991 raeburn 9020: my @lockers;
9021: my $navmap;
9022: if ($env{'request.course.id'}) {
9023: $navmap = Apache::lonnavmaps::navmap->new();
9024: }
1.661 raeburn 9025: foreach my $line (@dir_list) {
1.984 raeburn 9026: my ($file_name,$rest)=split(/\&/,$line,2);
1.661 raeburn 9027: if ($file_name eq $fname){
9028: $file_name = $path.$file_name;
9029: if ($group ne '') {
9030: $file_name = $group.$file_name;
9031: }
9032: $found_file = 1;
1.991 raeburn 9033: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
9034: foreach my $lock (@lockers) {
9035: if (ref($lock) eq 'ARRAY') {
9036: my ($symb,$crsid) = @{$lock};
9037: if ($crsid eq $env{'request.course.id'}) {
9038: if (ref($navmap)) {
9039: my $res = $navmap->getBySymb($symb);
9040: foreach my $part (@{$res->parts()}) {
9041: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
9042: unless (($slot_status == $res->RESERVED) ||
9043: ($slot_status == $res->RESERVED_LOCATION)) {
9044: $locked_file = 1;
9045: }
9046: }
9047: } else {
9048: $locked_file = 1;
9049: }
9050: } else {
9051: $locked_file = 1;
9052: }
9053: }
9054: }
1.984 raeburn 9055: } else {
9056: my @info = split(/\&/,$rest);
9057: my $currsize = $info[6]/1000;
9058: if ($currsize < $filesize) {
9059: my $extra = $filesize - $currsize;
9060: if (($current_disk_usage + $extra) > $disk_quota) {
9061: my $msg = '<span class="LC_error">'.
9062: &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.',
9063: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</span>'.
9064: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
9065: $disk_quota,$current_disk_usage);
9066: return ('will_exceed_quota',$msg);
9067: }
9068: }
1.661 raeburn 9069: }
9070: }
9071: }
9072: if (($current_disk_usage + $filesize) > $disk_quota){
9073: my $msg = '<span class="LC_error">'.
9074: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
9075: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
9076: return ('will_exceed_quota',$msg);
9077: } elsif ($found_file) {
9078: if ($locked_file) {
9079: my $msg = '<span class="LC_error">';
9080: $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>');
9081: $msg .= '</span><br />';
9082: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
9083: return ('file_locked',$msg);
9084: } else {
9085: my $msg = '<span class="LC_error">';
1.984 raeburn 9086: $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 9087: $msg .= '</span>';
1.984 raeburn 9088: return ('existingfile',$msg);
1.661 raeburn 9089: }
9090: }
9091: }
9092:
1.987 raeburn 9093: sub check_for_traversal {
9094: my ($path,$url,$toplevel) = @_;
9095: my @parts=split(/\//,$path);
9096: my $cleanpath;
9097: my $fullpath = $url;
9098: for (my $i=0;$i<@parts;$i++) {
9099: next if ($parts[$i] eq '.');
9100: if ($parts[$i] eq '..') {
9101: $fullpath =~ s{([^/]+/)$}{};
9102: } else {
9103: $fullpath .= $parts[$i].'/';
9104: }
9105: }
9106: if ($fullpath =~ /^\Q$url\E(.*)$/) {
9107: $cleanpath = $1;
9108: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
9109: my $curr_toprel = $1;
9110: my @parts = split(/\//,$curr_toprel);
9111: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
9112: my @urlparts = split(/\//,$url_toprel);
9113: my $doubledots;
9114: my $startdiff = -1;
9115: for (my $i=0; $i<@urlparts; $i++) {
9116: if ($startdiff == -1) {
9117: unless ($urlparts[$i] eq $parts[$i]) {
9118: $startdiff = $i;
9119: $doubledots .= '../';
9120: }
9121: } else {
9122: $doubledots .= '../';
9123: }
9124: }
9125: if ($startdiff > -1) {
9126: $cleanpath = $doubledots;
9127: for (my $i=$startdiff; $i<@parts; $i++) {
9128: $cleanpath .= $parts[$i].'/';
9129: }
9130: }
9131: }
9132: $cleanpath =~ s{(/)$}{};
9133: return $cleanpath;
9134: }
1.31 albertel 9135:
1.41 ng 9136: =pod
1.45 matthew 9137:
1.464 albertel 9138: =back
1.41 ng 9139:
1.112 bowersj2 9140: =head1 CSV Upload/Handling functions
1.38 albertel 9141:
1.41 ng 9142: =over 4
9143:
1.648 raeburn 9144: =item * &upfile_store($r)
1.41 ng 9145:
9146: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 9147: needs $env{'form.upfile'}
1.41 ng 9148: returns $datatoken to be put into hidden field
9149:
9150: =cut
1.31 albertel 9151:
9152: sub upfile_store {
9153: my $r=shift;
1.258 albertel 9154: $env{'form.upfile'}=~s/\r/\n/gs;
9155: $env{'form.upfile'}=~s/\f/\n/gs;
9156: $env{'form.upfile'}=~s/\n+/\n/gs;
9157: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 9158:
1.258 albertel 9159: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
9160: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 9161: {
1.158 raeburn 9162: my $datafile = $r->dir_config('lonDaemons').
9163: '/tmp/'.$datatoken.'.tmp';
9164: if ( open(my $fh,">$datafile") ) {
1.258 albertel 9165: print $fh $env{'form.upfile'};
1.158 raeburn 9166: close($fh);
9167: }
1.31 albertel 9168: }
9169: return $datatoken;
9170: }
9171:
1.56 matthew 9172: =pod
9173:
1.648 raeburn 9174: =item * &load_tmp_file($r)
1.41 ng 9175:
9176: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 9177: needs $env{'form.datatoken'},
9178: sets $env{'form.upfile'} to the contents of the file
1.41 ng 9179:
9180: =cut
1.31 albertel 9181:
9182: sub load_tmp_file {
9183: my $r=shift;
9184: my @studentdata=();
9185: {
1.158 raeburn 9186: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 9187: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 9188: if ( open(my $fh,"<$studentfile") ) {
9189: @studentdata=<$fh>;
9190: close($fh);
9191: }
1.31 albertel 9192: }
1.258 albertel 9193: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 9194: }
9195:
1.56 matthew 9196: =pod
9197:
1.648 raeburn 9198: =item * &upfile_record_sep()
1.41 ng 9199:
9200: Separate uploaded file into records
9201: returns array of records,
1.258 albertel 9202: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 9203:
9204: =cut
1.31 albertel 9205:
9206: sub upfile_record_sep {
1.258 albertel 9207: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 9208: } else {
1.248 albertel 9209: my @records;
1.258 albertel 9210: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 9211: if ($line=~/^\s*$/) { next; }
9212: push(@records,$line);
9213: }
9214: return @records;
1.31 albertel 9215: }
9216: }
9217:
1.56 matthew 9218: =pod
9219:
1.648 raeburn 9220: =item * &record_sep($record)
1.41 ng 9221:
1.258 albertel 9222: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 9223:
9224: =cut
9225:
1.263 www 9226: sub takeleft {
9227: my $index=shift;
9228: return substr('0000'.$index,-4,4);
9229: }
9230:
1.31 albertel 9231: sub record_sep {
9232: my $record=shift;
9233: my %components=();
1.258 albertel 9234: if ($env{'form.upfiletype'} eq 'xml') {
9235: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 9236: my $i=0;
1.356 albertel 9237: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 9238: $field=~s/^(\"|\')//;
9239: $field=~s/(\"|\')$//;
1.263 www 9240: $components{&takeleft($i)}=$field;
1.31 albertel 9241: $i++;
9242: }
1.258 albertel 9243: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 9244: my $i=0;
1.356 albertel 9245: foreach my $field (split(/\t/,$record)) {
1.31 albertel 9246: $field=~s/^(\"|\')//;
9247: $field=~s/(\"|\')$//;
1.263 www 9248: $components{&takeleft($i)}=$field;
1.31 albertel 9249: $i++;
9250: }
9251: } else {
1.561 www 9252: my $separator=',';
1.480 banghart 9253: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 9254: $separator=';';
1.480 banghart 9255: }
1.31 albertel 9256: my $i=0;
1.561 www 9257: # the character we are looking for to indicate the end of a quote or a record
9258: my $looking_for=$separator;
9259: # do not add the characters to the fields
9260: my $ignore=0;
9261: # we just encountered a separator (or the beginning of the record)
9262: my $just_found_separator=1;
9263: # store the field we are working on here
9264: my $field='';
9265: # work our way through all characters in record
9266: foreach my $character ($record=~/(.)/g) {
9267: if ($character eq $looking_for) {
9268: if ($character ne $separator) {
9269: # Found the end of a quote, again looking for separator
9270: $looking_for=$separator;
9271: $ignore=1;
9272: } else {
9273: # Found a separator, store away what we got
9274: $components{&takeleft($i)}=$field;
9275: $i++;
9276: $just_found_separator=1;
9277: $ignore=0;
9278: $field='';
9279: }
9280: next;
9281: }
9282: # single or double quotation marks after a separator indicate beginning of a quote
9283: # we are now looking for the end of the quote and need to ignore separators
9284: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
9285: $looking_for=$character;
9286: next;
9287: }
9288: # ignore would be true after we reached the end of a quote
9289: if ($ignore) { next; }
9290: if (($just_found_separator) && ($character=~/\s/)) { next; }
9291: $field.=$character;
9292: $just_found_separator=0;
1.31 albertel 9293: }
1.561 www 9294: # catch the very last entry, since we never encountered the separator
9295: $components{&takeleft($i)}=$field;
1.31 albertel 9296: }
9297: return %components;
9298: }
9299:
1.144 matthew 9300: ######################################################
9301: ######################################################
9302:
1.56 matthew 9303: =pod
9304:
1.648 raeburn 9305: =item * &upfile_select_html()
1.41 ng 9306:
1.144 matthew 9307: Return HTML code to select a file from the users machine and specify
9308: the file type.
1.41 ng 9309:
9310: =cut
9311:
1.144 matthew 9312: ######################################################
9313: ######################################################
1.31 albertel 9314: sub upfile_select_html {
1.144 matthew 9315: my %Types = (
9316: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 9317: semisv => &mt('Semicolon separated values'),
1.144 matthew 9318: space => &mt('Space separated'),
9319: tab => &mt('Tabulator separated'),
9320: # xml => &mt('HTML/XML'),
9321: );
9322: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 9323: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 9324: foreach my $type (sort(keys(%Types))) {
9325: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
9326: }
9327: $Str .= "</select>\n";
9328: return $Str;
1.31 albertel 9329: }
9330:
1.301 albertel 9331: sub get_samples {
9332: my ($records,$toget) = @_;
9333: my @samples=({});
9334: my $got=0;
9335: foreach my $rec (@$records) {
9336: my %temp = &record_sep($rec);
9337: if (! grep(/\S/, values(%temp))) { next; }
9338: if (%temp) {
9339: $samples[$got]=\%temp;
9340: $got++;
9341: if ($got == $toget) { last; }
9342: }
9343: }
9344: return \@samples;
9345: }
9346:
1.144 matthew 9347: ######################################################
9348: ######################################################
9349:
1.56 matthew 9350: =pod
9351:
1.648 raeburn 9352: =item * &csv_print_samples($r,$records)
1.41 ng 9353:
9354: Prints a table of sample values from each column uploaded $r is an
9355: Apache Request ref, $records is an arrayref from
9356: &Apache::loncommon::upfile_record_sep
9357:
9358: =cut
9359:
1.144 matthew 9360: ######################################################
9361: ######################################################
1.31 albertel 9362: sub csv_print_samples {
9363: my ($r,$records) = @_;
1.662 bisitz 9364: my $samples = &get_samples($records,5);
1.301 albertel 9365:
1.594 raeburn 9366: $r->print(&mt('Samples').'<br />'.&start_data_table().
9367: &start_data_table_header_row());
1.356 albertel 9368: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 9369: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 9370: $r->print(&end_data_table_header_row());
1.301 albertel 9371: foreach my $hash (@$samples) {
1.594 raeburn 9372: $r->print(&start_data_table_row());
1.356 albertel 9373: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 9374: $r->print('<td>');
1.356 albertel 9375: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 9376: $r->print('</td>');
9377: }
1.594 raeburn 9378: $r->print(&end_data_table_row());
1.31 albertel 9379: }
1.594 raeburn 9380: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 9381: }
9382:
1.144 matthew 9383: ######################################################
9384: ######################################################
9385:
1.56 matthew 9386: =pod
9387:
1.648 raeburn 9388: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 9389:
9390: Prints a table to create associations between values and table columns.
1.144 matthew 9391:
1.41 ng 9392: $r is an Apache Request ref,
9393: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 9394: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 9395:
9396: =cut
9397:
1.144 matthew 9398: ######################################################
9399: ######################################################
1.31 albertel 9400: sub csv_print_select_table {
9401: my ($r,$records,$d) = @_;
1.301 albertel 9402: my $i=0;
9403: my $samples = &get_samples($records,1);
1.144 matthew 9404: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 9405: &start_data_table().&start_data_table_header_row().
1.144 matthew 9406: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 9407: '<th>'.&mt('Column').'</th>'.
9408: &end_data_table_header_row()."\n");
1.356 albertel 9409: foreach my $array_ref (@$d) {
9410: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 9411: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 9412:
1.875 bisitz 9413: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 9414: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 9415: $r->print('<option value="none"></option>');
1.356 albertel 9416: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
9417: $r->print('<option value="'.$sample.'"'.
9418: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 9419: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 9420: }
1.594 raeburn 9421: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 9422: $i++;
9423: }
1.594 raeburn 9424: $r->print(&end_data_table());
1.31 albertel 9425: $i--;
9426: return $i;
9427: }
1.56 matthew 9428:
1.144 matthew 9429: ######################################################
9430: ######################################################
9431:
1.56 matthew 9432: =pod
1.31 albertel 9433:
1.648 raeburn 9434: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 9435:
9436: Prints a table of sample values from the upload and can make associate samples to internal names.
9437:
9438: $r is an Apache Request ref,
9439: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
9440: $d is an array of 2 element arrays (internal name, displayed name)
9441:
9442: =cut
9443:
1.144 matthew 9444: ######################################################
9445: ######################################################
1.31 albertel 9446: sub csv_samples_select_table {
9447: my ($r,$records,$d) = @_;
9448: my $i=0;
1.144 matthew 9449: #
1.662 bisitz 9450: my $max_samples = 5;
9451: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 9452: $r->print(&start_data_table().
9453: &start_data_table_header_row().'<th>'.
9454: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
9455: &end_data_table_header_row());
1.301 albertel 9456:
9457: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 9458: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 9459: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 9460: foreach my $option (@$d) {
9461: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 9462: $r->print('<option value="'.$value.'"'.
1.253 albertel 9463: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 9464: $display.'</option>');
1.31 albertel 9465: }
9466: $r->print('</select></td><td>');
1.662 bisitz 9467: foreach my $line (0..($max_samples-1)) {
1.301 albertel 9468: if (defined($samples->[$line]{$key})) {
9469: $r->print($samples->[$line]{$key}."<br />\n");
9470: }
9471: }
1.594 raeburn 9472: $r->print('</td>'.&end_data_table_row());
1.31 albertel 9473: $i++;
9474: }
1.594 raeburn 9475: $r->print(&end_data_table());
1.31 albertel 9476: $i--;
9477: return($i);
1.115 matthew 9478: }
9479:
1.144 matthew 9480: ######################################################
9481: ######################################################
9482:
1.115 matthew 9483: =pod
9484:
1.648 raeburn 9485: =item * &clean_excel_name($name)
1.115 matthew 9486:
9487: Returns a replacement for $name which does not contain any illegal characters.
9488:
9489: =cut
9490:
1.144 matthew 9491: ######################################################
9492: ######################################################
1.115 matthew 9493: sub clean_excel_name {
9494: my ($name) = @_;
9495: $name =~ s/[:\*\?\/\\]//g;
9496: if (length($name) > 31) {
9497: $name = substr($name,0,31);
9498: }
9499: return $name;
1.25 albertel 9500: }
1.84 albertel 9501:
1.85 albertel 9502: =pod
9503:
1.648 raeburn 9504: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 9505:
9506: Returns either 1 or undef
9507:
9508: 1 if the part is to be hidden, undef if it is to be shown
9509:
9510: Arguments are:
9511:
9512: $id the id of the part to be checked
9513: $symb, optional the symb of the resource to check
9514: $udom, optional the domain of the user to check for
9515: $uname, optional the username of the user to check for
9516:
9517: =cut
1.84 albertel 9518:
9519: sub check_if_partid_hidden {
9520: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 9521: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 9522: $symb,$udom,$uname);
1.141 albertel 9523: my $truth=1;
9524: #if the string starts with !, then the list is the list to show not hide
9525: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 9526: my @hiddenlist=split(/,/,$hiddenparts);
9527: foreach my $checkid (@hiddenlist) {
1.141 albertel 9528: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 9529: }
1.141 albertel 9530: return !$truth;
1.84 albertel 9531: }
1.127 matthew 9532:
1.138 matthew 9533:
9534: ############################################################
9535: ############################################################
9536:
9537: =pod
9538:
1.157 matthew 9539: =back
9540:
1.138 matthew 9541: =head1 cgi-bin script and graphing routines
9542:
1.157 matthew 9543: =over 4
9544:
1.648 raeburn 9545: =item * &get_cgi_id()
1.138 matthew 9546:
9547: Inputs: none
9548:
9549: Returns an id which can be used to pass environment variables
9550: to various cgi-bin scripts. These environment variables will
9551: be removed from the users environment after a given time by
9552: the routine &Apache::lonnet::transfer_profile_to_env.
9553:
9554: =cut
9555:
9556: ############################################################
9557: ############################################################
1.152 albertel 9558: my $uniq=0;
1.136 matthew 9559: sub get_cgi_id {
1.154 albertel 9560: $uniq=($uniq+1)%100000;
1.280 albertel 9561: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 9562: }
9563:
1.127 matthew 9564: ############################################################
9565: ############################################################
9566:
9567: =pod
9568:
1.648 raeburn 9569: =item * &DrawBarGraph()
1.127 matthew 9570:
1.138 matthew 9571: Facilitates the plotting of data in a (stacked) bar graph.
9572: Puts plot definition data into the users environment in order for
9573: graph.png to plot it. Returns an <img> tag for the plot.
9574: The bars on the plot are labeled '1','2',...,'n'.
9575:
9576: Inputs:
9577:
9578: =over 4
9579:
9580: =item $Title: string, the title of the plot
9581:
9582: =item $xlabel: string, text describing the X-axis of the plot
9583:
9584: =item $ylabel: string, text describing the Y-axis of the plot
9585:
9586: =item $Max: scalar, the maximum Y value to use in the plot
9587: If $Max is < any data point, the graph will not be rendered.
9588:
1.140 matthew 9589: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 9590: they are plotted. If undefined, default values will be used.
9591:
1.178 matthew 9592: =item $labels: array ref holding the labels to use on the x-axis for the bars.
9593:
1.138 matthew 9594: =item @Values: An array of array references. Each array reference holds data
9595: to be plotted in a stacked bar chart.
9596:
1.239 matthew 9597: =item If the final element of @Values is a hash reference the key/value
9598: pairs will be added to the graph definition.
9599:
1.138 matthew 9600: =back
9601:
9602: Returns:
9603:
9604: An <img> tag which references graph.png and the appropriate identifying
9605: information for the plot.
9606:
1.127 matthew 9607: =cut
9608:
9609: ############################################################
9610: ############################################################
1.134 matthew 9611: sub DrawBarGraph {
1.178 matthew 9612: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 9613: #
9614: if (! defined($colors)) {
9615: $colors = ['#33ff00',
9616: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
9617: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
9618: ];
9619: }
1.228 matthew 9620: my $extra_settings = {};
9621: if (ref($Values[-1]) eq 'HASH') {
9622: $extra_settings = pop(@Values);
9623: }
1.127 matthew 9624: #
1.136 matthew 9625: my $identifier = &get_cgi_id();
9626: my $id = 'cgi.'.$identifier;
1.129 matthew 9627: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 9628: return '';
9629: }
1.225 matthew 9630: #
9631: my @Labels;
9632: if (defined($labels)) {
9633: @Labels = @$labels;
9634: } else {
9635: for (my $i=0;$i<@{$Values[0]};$i++) {
9636: push (@Labels,$i+1);
9637: }
9638: }
9639: #
1.129 matthew 9640: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 9641: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 9642: my %ValuesHash;
9643: my $NumSets=1;
9644: foreach my $array (@Values) {
9645: next if (! ref($array));
1.136 matthew 9646: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 9647: join(',',@$array);
1.129 matthew 9648: }
1.127 matthew 9649: #
1.136 matthew 9650: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 9651: if ($NumBars < 3) {
9652: $width = 120+$NumBars*32;
1.220 matthew 9653: $xskip = 1;
1.225 matthew 9654: $bar_width = 30;
9655: } elsif ($NumBars < 5) {
9656: $width = 120+$NumBars*20;
9657: $xskip = 1;
9658: $bar_width = 20;
1.220 matthew 9659: } elsif ($NumBars < 10) {
1.136 matthew 9660: $width = 120+$NumBars*15;
9661: $xskip = 1;
9662: $bar_width = 15;
9663: } elsif ($NumBars <= 25) {
9664: $width = 120+$NumBars*11;
9665: $xskip = 5;
9666: $bar_width = 8;
9667: } elsif ($NumBars <= 50) {
9668: $width = 120+$NumBars*8;
9669: $xskip = 5;
9670: $bar_width = 4;
9671: } else {
9672: $width = 120+$NumBars*8;
9673: $xskip = 5;
9674: $bar_width = 4;
9675: }
9676: #
1.137 matthew 9677: $Max = 1 if ($Max < 1);
9678: if ( int($Max) < $Max ) {
9679: $Max++;
9680: $Max = int($Max);
9681: }
1.127 matthew 9682: $Title = '' if (! defined($Title));
9683: $xlabel = '' if (! defined($xlabel));
9684: $ylabel = '' if (! defined($ylabel));
1.369 www 9685: $ValuesHash{$id.'.title'} = &escape($Title);
9686: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
9687: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 9688: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 9689: $ValuesHash{$id.'.NumBars'} = $NumBars;
9690: $ValuesHash{$id.'.NumSets'} = $NumSets;
9691: $ValuesHash{$id.'.PlotType'} = 'bar';
9692: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9693: $ValuesHash{$id.'.height'} = $height;
9694: $ValuesHash{$id.'.width'} = $width;
9695: $ValuesHash{$id.'.xskip'} = $xskip;
9696: $ValuesHash{$id.'.bar_width'} = $bar_width;
9697: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 9698: #
1.228 matthew 9699: # Deal with other parameters
9700: while (my ($key,$value) = each(%$extra_settings)) {
9701: $ValuesHash{$id.'.'.$key} = $value;
9702: }
9703: #
1.646 raeburn 9704: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 9705: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9706: }
9707:
9708: ############################################################
9709: ############################################################
9710:
9711: =pod
9712:
1.648 raeburn 9713: =item * &DrawXYGraph()
1.137 matthew 9714:
1.138 matthew 9715: Facilitates the plotting of data in an XY graph.
9716: Puts plot definition data into the users environment in order for
9717: graph.png to plot it. Returns an <img> tag for the plot.
9718:
9719: Inputs:
9720:
9721: =over 4
9722:
9723: =item $Title: string, the title of the plot
9724:
9725: =item $xlabel: string, text describing the X-axis of the plot
9726:
9727: =item $ylabel: string, text describing the Y-axis of the plot
9728:
9729: =item $Max: scalar, the maximum Y value to use in the plot
9730: If $Max is < any data point, the graph will not be rendered.
9731:
9732: =item $colors: Array ref containing the hex color codes for the data to be
9733: plotted in. If undefined, default values will be used.
9734:
9735: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9736:
9737: =item $Ydata: Array ref containing Array refs.
1.185 www 9738: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 9739:
9740: =item %Values: hash indicating or overriding any default values which are
9741: passed to graph.png.
9742: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9743:
9744: =back
9745:
9746: Returns:
9747:
9748: An <img> tag which references graph.png and the appropriate identifying
9749: information for the plot.
9750:
1.137 matthew 9751: =cut
9752:
9753: ############################################################
9754: ############################################################
9755: sub DrawXYGraph {
9756: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
9757: #
9758: # Create the identifier for the graph
9759: my $identifier = &get_cgi_id();
9760: my $id = 'cgi.'.$identifier;
9761: #
9762: $Title = '' if (! defined($Title));
9763: $xlabel = '' if (! defined($xlabel));
9764: $ylabel = '' if (! defined($ylabel));
9765: my %ValuesHash =
9766: (
1.369 www 9767: $id.'.title' => &escape($Title),
9768: $id.'.xlabel' => &escape($xlabel),
9769: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 9770: $id.'.y_max_value'=> $Max,
9771: $id.'.labels' => join(',',@$Xlabels),
9772: $id.'.PlotType' => 'XY',
9773: );
9774: #
9775: if (defined($colors) && ref($colors) eq 'ARRAY') {
9776: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9777: }
9778: #
9779: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
9780: return '';
9781: }
9782: my $NumSets=1;
1.138 matthew 9783: foreach my $array (@{$Ydata}){
1.137 matthew 9784: next if (! ref($array));
9785: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
9786: }
1.138 matthew 9787: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 9788: #
9789: # Deal with other parameters
9790: while (my ($key,$value) = each(%Values)) {
9791: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 9792: }
9793: #
1.646 raeburn 9794: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 9795: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9796: }
9797:
9798: ############################################################
9799: ############################################################
9800:
9801: =pod
9802:
1.648 raeburn 9803: =item * &DrawXYYGraph()
1.138 matthew 9804:
9805: Facilitates the plotting of data in an XY graph with two Y axes.
9806: Puts plot definition data into the users environment in order for
9807: graph.png to plot it. Returns an <img> tag for the plot.
9808:
9809: Inputs:
9810:
9811: =over 4
9812:
9813: =item $Title: string, the title of the plot
9814:
9815: =item $xlabel: string, text describing the X-axis of the plot
9816:
9817: =item $ylabel: string, text describing the Y-axis of the plot
9818:
9819: =item $colors: Array ref containing the hex color codes for the data to be
9820: plotted in. If undefined, default values will be used.
9821:
9822: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9823:
9824: =item $Ydata1: The first data set
9825:
9826: =item $Min1: The minimum value of the left Y-axis
9827:
9828: =item $Max1: The maximum value of the left Y-axis
9829:
9830: =item $Ydata2: The second data set
9831:
9832: =item $Min2: The minimum value of the right Y-axis
9833:
9834: =item $Max2: The maximum value of the left Y-axis
9835:
9836: =item %Values: hash indicating or overriding any default values which are
9837: passed to graph.png.
9838: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9839:
9840: =back
9841:
9842: Returns:
9843:
9844: An <img> tag which references graph.png and the appropriate identifying
9845: information for the plot.
1.136 matthew 9846:
9847: =cut
9848:
9849: ############################################################
9850: ############################################################
1.137 matthew 9851: sub DrawXYYGraph {
9852: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
9853: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 9854: #
9855: # Create the identifier for the graph
9856: my $identifier = &get_cgi_id();
9857: my $id = 'cgi.'.$identifier;
9858: #
9859: $Title = '' if (! defined($Title));
9860: $xlabel = '' if (! defined($xlabel));
9861: $ylabel = '' if (! defined($ylabel));
9862: my %ValuesHash =
9863: (
1.369 www 9864: $id.'.title' => &escape($Title),
9865: $id.'.xlabel' => &escape($xlabel),
9866: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 9867: $id.'.labels' => join(',',@$Xlabels),
9868: $id.'.PlotType' => 'XY',
9869: $id.'.NumSets' => 2,
1.137 matthew 9870: $id.'.two_axes' => 1,
9871: $id.'.y1_max_value' => $Max1,
9872: $id.'.y1_min_value' => $Min1,
9873: $id.'.y2_max_value' => $Max2,
9874: $id.'.y2_min_value' => $Min2,
1.136 matthew 9875: );
9876: #
1.137 matthew 9877: if (defined($colors) && ref($colors) eq 'ARRAY') {
9878: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9879: }
9880: #
9881: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
9882: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 9883: return '';
9884: }
9885: my $NumSets=1;
1.137 matthew 9886: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 9887: next if (! ref($array));
9888: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 9889: }
9890: #
9891: # Deal with other parameters
9892: while (my ($key,$value) = each(%Values)) {
9893: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 9894: }
9895: #
1.646 raeburn 9896: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 9897: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 9898: }
9899:
9900: ############################################################
9901: ############################################################
9902:
9903: =pod
9904:
1.157 matthew 9905: =back
9906:
1.139 matthew 9907: =head1 Statistics helper routines?
9908:
9909: Bad place for them but what the hell.
9910:
1.157 matthew 9911: =over 4
9912:
1.648 raeburn 9913: =item * &chartlink()
1.139 matthew 9914:
9915: Returns a link to the chart for a specific student.
9916:
9917: Inputs:
9918:
9919: =over 4
9920:
9921: =item $linktext: The text of the link
9922:
9923: =item $sname: The students username
9924:
9925: =item $sdomain: The students domain
9926:
9927: =back
9928:
1.157 matthew 9929: =back
9930:
1.139 matthew 9931: =cut
9932:
9933: ############################################################
9934: ############################################################
9935: sub chartlink {
9936: my ($linktext, $sname, $sdomain) = @_;
9937: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 9938: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 9939: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 9940: '">'.$linktext.'</a>';
1.153 matthew 9941: }
9942:
9943: #######################################################
9944: #######################################################
9945:
9946: =pod
9947:
9948: =head1 Course Environment Routines
1.157 matthew 9949:
9950: =over 4
1.153 matthew 9951:
1.648 raeburn 9952: =item * &restore_course_settings()
1.153 matthew 9953:
1.648 raeburn 9954: =item * &store_course_settings()
1.153 matthew 9955:
9956: Restores/Store indicated form parameters from the course environment.
9957: Will not overwrite existing values of the form parameters.
9958:
9959: Inputs:
9960: a scalar describing the data (e.g. 'chart', 'problem_analysis')
9961:
9962: a hash ref describing the data to be stored. For example:
9963:
9964: %Save_Parameters = ('Status' => 'scalar',
9965: 'chartoutputmode' => 'scalar',
9966: 'chartoutputdata' => 'scalar',
9967: 'Section' => 'array',
1.373 raeburn 9968: 'Group' => 'array',
1.153 matthew 9969: 'StudentData' => 'array',
9970: 'Maps' => 'array');
9971:
9972: Returns: both routines return nothing
9973:
1.631 raeburn 9974: =back
9975:
1.153 matthew 9976: =cut
9977:
9978: #######################################################
9979: #######################################################
9980: sub store_course_settings {
1.496 albertel 9981: return &store_settings($env{'request.course.id'},@_);
9982: }
9983:
9984: sub store_settings {
1.153 matthew 9985: # save to the environment
9986: # appenv the same items, just to be safe
1.300 albertel 9987: my $udom = $env{'user.domain'};
9988: my $uname = $env{'user.name'};
1.496 albertel 9989: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9990: my %SaveHash;
9991: my %AppHash;
9992: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 9993: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 9994: my $envname = 'environment.'.$basename;
1.258 albertel 9995: if (exists($env{'form.'.$setting})) {
1.153 matthew 9996: # Save this value away
9997: if ($type eq 'scalar' &&
1.258 albertel 9998: (! exists($env{$envname}) ||
9999: $env{$envname} ne $env{'form.'.$setting})) {
10000: $SaveHash{$basename} = $env{'form.'.$setting};
10001: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 10002: } elsif ($type eq 'array') {
10003: my $stored_form;
1.258 albertel 10004: if (ref($env{'form.'.$setting})) {
1.153 matthew 10005: $stored_form = join(',',
10006: map {
1.369 www 10007: &escape($_);
1.258 albertel 10008: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 10009: } else {
10010: $stored_form =
1.369 www 10011: &escape($env{'form.'.$setting});
1.153 matthew 10012: }
10013: # Determine if the array contents are the same.
1.258 albertel 10014: if ($stored_form ne $env{$envname}) {
1.153 matthew 10015: $SaveHash{$basename} = $stored_form;
10016: $AppHash{$envname} = $stored_form;
10017: }
10018: }
10019: }
10020: }
10021: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 10022: $udom,$uname);
1.153 matthew 10023: if ($put_result !~ /^(ok|delayed)/) {
10024: &Apache::lonnet::logthis('unable to save form parameters, '.
10025: 'got error:'.$put_result);
10026: }
10027: # Make sure these settings stick around in this session, too
1.646 raeburn 10028: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 10029: return;
10030: }
10031:
10032: sub restore_course_settings {
1.499 albertel 10033: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 10034: }
10035:
10036: sub restore_settings {
10037: my ($context,$prefix,$Settings) = @_;
1.153 matthew 10038: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 10039: next if (exists($env{'form.'.$setting}));
1.496 albertel 10040: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 10041: '.'.$setting;
1.258 albertel 10042: if (exists($env{$envname})) {
1.153 matthew 10043: if ($type eq 'scalar') {
1.258 albertel 10044: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 10045: } elsif ($type eq 'array') {
1.258 albertel 10046: $env{'form.'.$setting} = [
1.153 matthew 10047: map {
1.369 www 10048: &unescape($_);
1.258 albertel 10049: } split(',',$env{$envname})
1.153 matthew 10050: ];
10051: }
10052: }
10053: }
1.127 matthew 10054: }
10055:
1.618 raeburn 10056: #######################################################
10057: #######################################################
10058:
10059: =pod
10060:
10061: =head1 Domain E-mail Routines
10062:
10063: =over 4
10064:
1.648 raeburn 10065: =item * &build_recipient_list()
1.618 raeburn 10066:
1.884 raeburn 10067: Build recipient lists for five types of e-mail:
1.766 raeburn 10068: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884 raeburn 10069: (d) Help requests, (e) Course requests needing approval, generated by
10070: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
10071: loncoursequeueadmin.pm respectively.
1.618 raeburn 10072:
10073: Inputs:
1.619 raeburn 10074: defmail (scalar - email address of default recipient),
1.618 raeburn 10075: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 10076: defdom (domain for which to retrieve configuration settings),
10077: origmail (scalar - email address of recipient from loncapa.conf,
10078: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 10079:
1.655 raeburn 10080: Returns: comma separated list of addresses to which to send e-mail.
10081:
10082: =back
1.618 raeburn 10083:
10084: =cut
10085:
10086: ############################################################
10087: ############################################################
10088: sub build_recipient_list {
1.619 raeburn 10089: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 10090: my @recipients;
10091: my $otheremails;
10092: my %domconfig =
10093: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
10094: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 10095: if (exists($domconfig{'contacts'}{$mailing})) {
10096: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
10097: my @contacts = ('adminemail','supportemail');
10098: foreach my $item (@contacts) {
10099: if ($domconfig{'contacts'}{$mailing}{$item}) {
10100: my $addr = $domconfig{'contacts'}{$item};
10101: if (!grep(/^\Q$addr\E$/,@recipients)) {
10102: push(@recipients,$addr);
10103: }
1.619 raeburn 10104: }
1.766 raeburn 10105: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 10106: }
10107: }
1.766 raeburn 10108: } elsif ($origmail ne '') {
10109: push(@recipients,$origmail);
1.618 raeburn 10110: }
1.619 raeburn 10111: } elsif ($origmail ne '') {
10112: push(@recipients,$origmail);
1.618 raeburn 10113: }
1.688 raeburn 10114: if (defined($defmail)) {
10115: if ($defmail ne '') {
10116: push(@recipients,$defmail);
10117: }
1.618 raeburn 10118: }
10119: if ($otheremails) {
1.619 raeburn 10120: my @others;
10121: if ($otheremails =~ /,/) {
10122: @others = split(/,/,$otheremails);
1.618 raeburn 10123: } else {
1.619 raeburn 10124: push(@others,$otheremails);
10125: }
10126: foreach my $addr (@others) {
10127: if (!grep(/^\Q$addr\E$/,@recipients)) {
10128: push(@recipients,$addr);
10129: }
1.618 raeburn 10130: }
10131: }
1.619 raeburn 10132: my $recipientlist = join(',',@recipients);
1.618 raeburn 10133: return $recipientlist;
10134: }
10135:
1.127 matthew 10136: ############################################################
10137: ############################################################
1.154 albertel 10138:
1.655 raeburn 10139: =pod
10140:
10141: =head1 Course Catalog Routines
10142:
10143: =over 4
10144:
10145: =item * &gather_categories()
10146:
10147: Converts category definitions - keys of categories hash stored in
10148: coursecategories in configuration.db on the primary library server in a
10149: domain - to an array. Also generates javascript and idx hash used to
10150: generate Domain Coordinator interface for editing Course Categories.
10151:
10152: Inputs:
1.663 raeburn 10153:
1.655 raeburn 10154: categories (reference to hash of category definitions).
1.663 raeburn 10155:
1.655 raeburn 10156: cats (reference to array of arrays/hashes which encapsulates hierarchy of
10157: categories and subcategories).
1.663 raeburn 10158:
1.655 raeburn 10159: idx (reference to hash of counters used in Domain Coordinator interface for
10160: editing Course Categories).
1.663 raeburn 10161:
1.655 raeburn 10162: jsarray (reference to array of categories used to create Javascript arrays for
10163: Domain Coordinator interface for editing Course Categories).
10164:
10165: Returns: nothing
10166:
10167: Side effects: populates cats, idx and jsarray.
10168:
10169: =cut
10170:
10171: sub gather_categories {
10172: my ($categories,$cats,$idx,$jsarray) = @_;
10173: my %counters;
10174: my $num = 0;
10175: foreach my $item (keys(%{$categories})) {
10176: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
10177: if ($container eq '' && $depth == 0) {
10178: $cats->[$depth][$categories->{$item}] = $cat;
10179: } else {
10180: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
10181: }
10182: my ($escitem,$tail) = split(/:/,$item,2);
10183: if ($counters{$tail} eq '') {
10184: $counters{$tail} = $num;
10185: $num ++;
10186: }
10187: if (ref($idx) eq 'HASH') {
10188: $idx->{$item} = $counters{$tail};
10189: }
10190: if (ref($jsarray) eq 'ARRAY') {
10191: push(@{$jsarray->[$counters{$tail}]},$item);
10192: }
10193: }
10194: return;
10195: }
10196:
10197: =pod
10198:
10199: =item * &extract_categories()
10200:
10201: Used to generate breadcrumb trails for course categories.
10202:
10203: Inputs:
1.663 raeburn 10204:
1.655 raeburn 10205: categories (reference to hash of category definitions).
1.663 raeburn 10206:
1.655 raeburn 10207: cats (reference to array of arrays/hashes which encapsulates hierarchy of
10208: categories and subcategories).
1.663 raeburn 10209:
1.655 raeburn 10210: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 10211:
1.655 raeburn 10212: allitems (reference to hash - key is category key
10213: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 10214:
1.655 raeburn 10215: idx (reference to hash of counters used in Domain Coordinator interface for
10216: editing Course Categories).
1.663 raeburn 10217:
1.655 raeburn 10218: jsarray (reference to array of categories used to create Javascript arrays for
10219: Domain Coordinator interface for editing Course Categories).
10220:
1.665 raeburn 10221: subcats (reference to hash of arrays containing all subcategories within each
10222: category, -recursive)
10223:
1.655 raeburn 10224: Returns: nothing
10225:
10226: Side effects: populates trails and allitems hash references.
10227:
10228: =cut
10229:
10230: sub extract_categories {
1.665 raeburn 10231: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 10232: if (ref($categories) eq 'HASH') {
10233: &gather_categories($categories,$cats,$idx,$jsarray);
10234: if (ref($cats->[0]) eq 'ARRAY') {
10235: for (my $i=0; $i<@{$cats->[0]}; $i++) {
10236: my $name = $cats->[0][$i];
10237: my $item = &escape($name).'::0';
10238: my $trailstr;
10239: if ($name eq 'instcode') {
10240: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 10241: } elsif ($name eq 'communities') {
10242: $trailstr = &mt('Communities');
1.655 raeburn 10243: } else {
10244: $trailstr = $name;
10245: }
10246: if ($allitems->{$item} eq '') {
10247: push(@{$trails},$trailstr);
10248: $allitems->{$item} = scalar(@{$trails})-1;
10249: }
10250: my @parents = ($name);
10251: if (ref($cats->[1]{$name}) eq 'ARRAY') {
10252: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
10253: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 10254: if (ref($subcats) eq 'HASH') {
10255: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
10256: }
10257: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
10258: }
10259: } else {
10260: if (ref($subcats) eq 'HASH') {
10261: $subcats->{$item} = [];
1.655 raeburn 10262: }
10263: }
10264: }
10265: }
10266: }
10267: return;
10268: }
10269:
10270: =pod
10271:
10272: =item *&recurse_categories()
10273:
10274: Recursively used to generate breadcrumb trails for course categories.
10275:
10276: Inputs:
1.663 raeburn 10277:
1.655 raeburn 10278: cats (reference to array of arrays/hashes which encapsulates hierarchy of
10279: categories and subcategories).
1.663 raeburn 10280:
1.655 raeburn 10281: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 10282:
10283: category (current course category, for which breadcrumb trail is being generated).
10284:
10285: trails (reference to array of breadcrumb trails for each category).
10286:
1.655 raeburn 10287: allitems (reference to hash - key is category key
10288: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 10289:
1.655 raeburn 10290: parents (array containing containers directories for current category,
10291: back to top level).
10292:
10293: Returns: nothing
10294:
10295: Side effects: populates trails and allitems hash references
10296:
10297: =cut
10298:
10299: sub recurse_categories {
1.665 raeburn 10300: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 10301: my $shallower = $depth - 1;
10302: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
10303: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
10304: my $name = $cats->[$depth]{$category}[$k];
10305: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
10306: my $trailstr = join(' -> ',(@{$parents},$category));
10307: if ($allitems->{$item} eq '') {
10308: push(@{$trails},$trailstr);
10309: $allitems->{$item} = scalar(@{$trails})-1;
10310: }
10311: my $deeper = $depth+1;
10312: push(@{$parents},$category);
1.665 raeburn 10313: if (ref($subcats) eq 'HASH') {
10314: my $subcat = &escape($name).':'.$category.':'.$depth;
10315: for (my $j=@{$parents}; $j>=0; $j--) {
10316: my $higher;
10317: if ($j > 0) {
10318: $higher = &escape($parents->[$j]).':'.
10319: &escape($parents->[$j-1]).':'.$j;
10320: } else {
10321: $higher = &escape($parents->[$j]).'::'.$j;
10322: }
10323: push(@{$subcats->{$higher}},$subcat);
10324: }
10325: }
10326: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
10327: $subcats);
1.655 raeburn 10328: pop(@{$parents});
10329: }
10330: } else {
10331: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
10332: my $trailstr = join(' -> ',(@{$parents},$category));
10333: if ($allitems->{$item} eq '') {
10334: push(@{$trails},$trailstr);
10335: $allitems->{$item} = scalar(@{$trails})-1;
10336: }
10337: }
10338: return;
10339: }
10340:
1.663 raeburn 10341: =pod
10342:
10343: =item *&assign_categories_table()
10344:
10345: Create a datatable for display of hierarchical categories in a domain,
10346: with checkboxes to allow a course to be categorized.
10347:
10348: Inputs:
10349:
10350: cathash - reference to hash of categories defined for the domain (from
10351: configuration.db)
10352:
10353: currcat - scalar with an & separated list of categories assigned to a course.
10354:
1.919 raeburn 10355: type - scalar contains course type (Course or Community).
10356:
1.663 raeburn 10357: Returns: $output (markup to be displayed)
10358:
10359: =cut
10360:
10361: sub assign_categories_table {
1.919 raeburn 10362: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 10363: my $output;
10364: if (ref($cathash) eq 'HASH') {
10365: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
10366: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
10367: $maxdepth = scalar(@cats);
10368: if (@cats > 0) {
10369: my $itemcount = 0;
10370: if (ref($cats[0]) eq 'ARRAY') {
10371: my @currcategories;
10372: if ($currcat ne '') {
10373: @currcategories = split('&',$currcat);
10374: }
1.919 raeburn 10375: my $table;
1.663 raeburn 10376: for (my $i=0; $i<@{$cats[0]}; $i++) {
10377: my $parent = $cats[0][$i];
1.919 raeburn 10378: next if ($parent eq 'instcode');
10379: if ($type eq 'Community') {
10380: next unless ($parent eq 'communities');
10381: } else {
10382: next if ($parent eq 'communities');
10383: }
1.663 raeburn 10384: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
10385: my $item = &escape($parent).'::0';
10386: my $checked = '';
10387: if (@currcategories > 0) {
10388: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 10389: $checked = ' checked="checked"';
1.663 raeburn 10390: }
10391: }
1.919 raeburn 10392: my $parent_title = $parent;
10393: if ($parent eq 'communities') {
10394: $parent_title = &mt('Communities');
10395: }
10396: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
10397: '<input type="checkbox" name="usecategory" value="'.
10398: $item.'"'.$checked.' />'.$parent_title.'</span>'.
10399: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 10400: my $depth = 1;
10401: push(@path,$parent);
1.919 raeburn 10402: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 10403: pop(@path);
1.919 raeburn 10404: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 10405: $itemcount ++;
10406: }
1.919 raeburn 10407: if ($itemcount) {
10408: $output = &Apache::loncommon::start_data_table().
10409: $table.
10410: &Apache::loncommon::end_data_table();
10411: }
1.663 raeburn 10412: }
10413: }
10414: }
10415: return $output;
10416: }
10417:
10418: =pod
10419:
10420: =item *&assign_category_rows()
10421:
10422: Create a datatable row for display of nested categories in a domain,
10423: with checkboxes to allow a course to be categorized,called recursively.
10424:
10425: Inputs:
10426:
10427: itemcount - track row number for alternating colors
10428:
10429: cats - reference to array of arrays/hashes which encapsulates hierarchy of
10430: categories and subcategories.
10431:
10432: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
10433:
10434: parent - parent of current category item
10435:
10436: path - Array containing all categories back up through the hierarchy from the
10437: current category to the top level.
10438:
10439: currcategories - reference to array of current categories assigned to the course
10440:
10441: Returns: $output (markup to be displayed).
10442:
10443: =cut
10444:
10445: sub assign_category_rows {
10446: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
10447: my ($text,$name,$item,$chgstr);
10448: if (ref($cats) eq 'ARRAY') {
10449: my $maxdepth = scalar(@{$cats});
10450: if (ref($cats->[$depth]) eq 'HASH') {
10451: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
10452: my $numchildren = @{$cats->[$depth]{$parent}};
10453: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
10454: $text .= '<td><table class="LC_datatable">';
10455: for (my $j=0; $j<$numchildren; $j++) {
10456: $name = $cats->[$depth]{$parent}[$j];
10457: $item = &escape($name).':'.&escape($parent).':'.$depth;
10458: my $deeper = $depth+1;
10459: my $checked = '';
10460: if (ref($currcategories) eq 'ARRAY') {
10461: if (@{$currcategories} > 0) {
10462: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 10463: $checked = ' checked="checked"';
1.663 raeburn 10464: }
10465: }
10466: }
1.664 raeburn 10467: $text .= '<tr><td><span class="LC_nobreak"><label>'.
10468: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 10469: $item.'"'.$checked.' />'.$name.'</label></span>'.
10470: '<input type="hidden" name="catname" value="'.$name.'" />'.
10471: '</td><td>';
1.663 raeburn 10472: if (ref($path) eq 'ARRAY') {
10473: push(@{$path},$name);
10474: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
10475: pop(@{$path});
10476: }
10477: $text .= '</td></tr>';
10478: }
10479: $text .= '</table></td>';
10480: }
10481: }
10482: }
10483: return $text;
10484: }
10485:
1.655 raeburn 10486: ############################################################
10487: ############################################################
10488:
10489:
1.443 albertel 10490: sub commit_customrole {
1.664 raeburn 10491: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 10492: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 10493: ($start?', '.&mt('starting').' '.localtime($start):'').
10494: ($end?', ending '.localtime($end):'').': <b>'.
10495: &Apache::lonnet::assigncustomrole(
1.664 raeburn 10496: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 10497: '</b><br />';
10498: return $output;
10499: }
10500:
10501: sub commit_standardrole {
1.541 raeburn 10502: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
10503: my ($output,$logmsg,$linefeed);
10504: if ($context eq 'auto') {
10505: $linefeed = "\n";
10506: } else {
10507: $linefeed = "<br />\n";
10508: }
1.443 albertel 10509: if ($three eq 'st') {
1.541 raeburn 10510: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
10511: $one,$two,$sec,$context);
10512: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 10513: ($result eq 'unknown_course') || ($result eq 'refused')) {
10514: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 10515: } else {
1.541 raeburn 10516: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 10517: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 10518: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
10519: if ($context eq 'auto') {
10520: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
10521: } else {
10522: $output .= '<b>'.$result.'</b>'.$linefeed.
10523: &mt('Add to classlist').': <b>ok</b>';
10524: }
10525: $output .= $linefeed;
1.443 albertel 10526: }
10527: } else {
10528: $output = &mt('Assigning').' '.$three.' in '.$url.
10529: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 10530: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 10531: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 10532: if ($context eq 'auto') {
10533: $output .= $result.$linefeed;
10534: } else {
10535: $output .= '<b>'.$result.'</b>'.$linefeed;
10536: }
1.443 albertel 10537: }
10538: return $output;
10539: }
10540:
10541: sub commit_studentrole {
1.541 raeburn 10542: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 10543: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 10544: if ($context eq 'auto') {
10545: $linefeed = "\n";
10546: } else {
10547: $linefeed = '<br />'."\n";
10548: }
1.443 albertel 10549: if (defined($one) && defined($two)) {
10550: my $cid=$one.'_'.$two;
10551: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
10552: my $secchange = 0;
10553: my $expire_role_result;
10554: my $modify_section_result;
1.628 raeburn 10555: if ($oldsec ne '-1') {
10556: if ($oldsec ne $sec) {
1.443 albertel 10557: $secchange = 1;
1.628 raeburn 10558: my $now = time;
1.443 albertel 10559: my $uurl='/'.$cid;
10560: $uurl=~s/\_/\//g;
10561: if ($oldsec) {
10562: $uurl.='/'.$oldsec;
10563: }
1.626 raeburn 10564: $oldsecurl = $uurl;
1.628 raeburn 10565: $expire_role_result =
1.652 raeburn 10566: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 10567: if ($env{'request.course.sec'} ne '') {
10568: if ($expire_role_result eq 'refused') {
10569: my @roles = ('st');
10570: my @statuses = ('previous');
10571: my @roledoms = ($one);
10572: my $withsec = 1;
10573: my %roleshash =
10574: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
10575: \@statuses,\@roles,\@roledoms,$withsec);
10576: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
10577: my ($oldstart,$oldend) =
10578: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
10579: if ($oldend > 0 && $oldend <= $now) {
10580: $expire_role_result = 'ok';
10581: }
10582: }
10583: }
10584: }
1.443 albertel 10585: $result = $expire_role_result;
10586: }
10587: }
10588: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 10589: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 10590: if ($modify_section_result =~ /^ok/) {
10591: if ($secchange == 1) {
1.628 raeburn 10592: if ($sec eq '') {
10593: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
10594: } else {
10595: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
10596: }
1.443 albertel 10597: } elsif ($oldsec eq '-1') {
1.628 raeburn 10598: if ($sec eq '') {
10599: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
10600: } else {
10601: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
10602: }
1.443 albertel 10603: } else {
1.628 raeburn 10604: if ($sec eq '') {
10605: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
10606: } else {
10607: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
10608: }
1.443 albertel 10609: }
10610: } else {
1.628 raeburn 10611: if ($secchange) {
10612: $$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;
10613: } else {
10614: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
10615: }
1.443 albertel 10616: }
10617: $result = $modify_section_result;
10618: } elsif ($secchange == 1) {
1.628 raeburn 10619: if ($oldsec eq '') {
10620: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
10621: } else {
10622: $$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;
10623: }
1.626 raeburn 10624: if ($expire_role_result eq 'refused') {
10625: my $newsecurl = '/'.$cid;
10626: $newsecurl =~ s/\_/\//g;
10627: if ($sec ne '') {
10628: $newsecurl.='/'.$sec;
10629: }
10630: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
10631: if ($sec eq '') {
10632: $$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;
10633: } else {
10634: $$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;
10635: }
10636: }
10637: }
1.443 albertel 10638: }
10639: } else {
1.626 raeburn 10640: $$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 10641: $result = "error: incomplete course id\n";
10642: }
10643: return $result;
10644: }
10645:
10646: ############################################################
10647: ############################################################
10648:
1.566 albertel 10649: sub check_clone {
1.578 raeburn 10650: my ($args,$linefeed) = @_;
1.566 albertel 10651: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
10652: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
10653: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
10654: my $clonemsg;
10655: my $can_clone = 0;
1.944 raeburn 10656: my $lctype = lc($args->{'crstype'});
1.908 raeburn 10657: if ($lctype ne 'community') {
10658: $lctype = 'course';
10659: }
1.566 albertel 10660: if ($clonehome eq 'no_host') {
1.944 raeburn 10661: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10662: $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'});
10663: } else {
10664: $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'});
10665: }
1.566 albertel 10666: } else {
10667: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944 raeburn 10668: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10669: if ($clonedesc{'type'} ne 'Community') {
10670: $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'});
10671: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10672: }
10673: }
1.882 raeburn 10674: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
10675: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 10676: $can_clone = 1;
10677: } else {
10678: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
10679: $args->{'clonedomain'},$args->{'clonecourse'});
10680: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 10681: if (grep(/^\*$/,@cloners)) {
10682: $can_clone = 1;
10683: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
10684: $can_clone = 1;
10685: } else {
1.908 raeburn 10686: my $ccrole = 'cc';
1.944 raeburn 10687: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10688: $ccrole = 'co';
10689: }
1.578 raeburn 10690: my %roleshash =
10691: &Apache::lonnet::get_my_roles($args->{'ccuname'},
10692: $args->{'ccdomain'},
1.908 raeburn 10693: 'userroles',['active'],[$ccrole],
1.578 raeburn 10694: [$args->{'clonedomain'}]);
1.908 raeburn 10695: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942 raeburn 10696: $can_clone = 1;
10697: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
10698: $can_clone = 1;
10699: } else {
1.944 raeburn 10700: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10701: $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'});
10702: } else {
10703: $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'});
10704: }
1.578 raeburn 10705: }
1.566 albertel 10706: }
1.578 raeburn 10707: }
1.566 albertel 10708: }
10709: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10710: }
10711:
1.444 albertel 10712: sub construct_course {
1.885 raeburn 10713: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444 albertel 10714: my $outcome;
1.541 raeburn 10715: my $linefeed = '<br />'."\n";
10716: if ($context eq 'auto') {
10717: $linefeed = "\n";
10718: }
1.566 albertel 10719:
10720: #
10721: # Are we cloning?
10722: #
10723: my ($can_clone, $clonemsg, $cloneid, $clonehome);
10724: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 10725: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 10726: if ($context ne 'auto') {
1.578 raeburn 10727: if ($clonemsg ne '') {
10728: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
10729: }
1.566 albertel 10730: }
10731: $outcome .= $clonemsg.$linefeed;
10732:
10733: if (!$can_clone) {
10734: return (0,$outcome);
10735: }
10736: }
10737:
1.444 albertel 10738: #
10739: # Open course
10740: #
10741: my $crstype = lc($args->{'crstype'});
10742: my %cenv=();
10743: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
10744: $args->{'cdescr'},
10745: $args->{'curl'},
10746: $args->{'course_home'},
10747: $args->{'nonstandard'},
10748: $args->{'crscode'},
10749: $args->{'ccuname'}.':'.
10750: $args->{'ccdomain'},
1.882 raeburn 10751: $args->{'crstype'},
1.885 raeburn 10752: $cnum,$context,$category);
1.444 albertel 10753:
10754: # Note: The testing routines depend on this being output; see
10755: # Utils::Course. This needs to at least be output as a comment
10756: # if anyone ever decides to not show this, and Utils::Course::new
10757: # will need to be suitably modified.
1.541 raeburn 10758: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943 raeburn 10759: if ($$courseid =~ /^error:/) {
10760: return (0,$outcome);
10761: }
10762:
1.444 albertel 10763: #
10764: # Check if created correctly
10765: #
1.479 albertel 10766: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 10767: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 10768: if ($crsuhome eq 'no_host') {
10769: $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
10770: return (0,$outcome);
10771: }
1.541 raeburn 10772: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 10773:
1.444 albertel 10774: #
1.566 albertel 10775: # Do the cloning
10776: #
10777: if ($can_clone && $cloneid) {
10778: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
10779: if ($context ne 'auto') {
10780: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
10781: }
10782: $outcome .= $clonemsg.$linefeed;
10783: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 10784: # Copy all files
1.637 www 10785: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 10786: # Restore URL
1.566 albertel 10787: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 10788: # Restore title
1.566 albertel 10789: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 10790: # Restore creation date, creator and creation context.
10791: $cenv{'internal.created'}=$oldcenv{'internal.created'};
10792: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
10793: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 10794: # Mark as cloned
1.566 albertel 10795: $cenv{'clonedfrom'}=$cloneid;
1.638 www 10796: # Need to clone grading mode
10797: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
10798: $cenv{'grading'}=$newenv{'grading'};
10799: # Do not clone these environment entries
10800: &Apache::lonnet::del('environment',
10801: ['default_enrollment_start_date',
10802: 'default_enrollment_end_date',
10803: 'question.email',
10804: 'policy.email',
10805: 'comment.email',
10806: 'pch.users.denied',
1.725 raeburn 10807: 'plc.users.denied',
10808: 'hidefromcat',
10809: 'categories'],
1.638 www 10810: $$crsudom,$$crsunum);
1.444 albertel 10811: }
1.566 albertel 10812:
1.444 albertel 10813: #
10814: # Set environment (will override cloned, if existing)
10815: #
10816: my @sections = ();
10817: my @xlists = ();
10818: if ($args->{'crstype'}) {
10819: $cenv{'type'}=$args->{'crstype'};
10820: }
10821: if ($args->{'crsid'}) {
10822: $cenv{'courseid'}=$args->{'crsid'};
10823: }
10824: if ($args->{'crscode'}) {
10825: $cenv{'internal.coursecode'}=$args->{'crscode'};
10826: }
10827: if ($args->{'crsquota'} ne '') {
10828: $cenv{'internal.coursequota'}=$args->{'crsquota'};
10829: } else {
10830: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
10831: }
10832: if ($args->{'ccuname'}) {
10833: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
10834: ':'.$args->{'ccdomain'};
10835: } else {
10836: $cenv{'internal.courseowner'} = $args->{'curruser'};
10837: }
10838: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
10839: if ($args->{'crssections'}) {
10840: $cenv{'internal.sectionnums'} = '';
10841: if ($args->{'crssections'} =~ m/,/) {
10842: @sections = split/,/,$args->{'crssections'};
10843: } else {
10844: $sections[0] = $args->{'crssections'};
10845: }
10846: if (@sections > 0) {
10847: foreach my $item (@sections) {
10848: my ($sec,$gp) = split/:/,$item;
10849: my $class = $args->{'crscode'}.$sec;
10850: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
10851: $cenv{'internal.sectionnums'} .= $item.',';
10852: unless ($addcheck eq 'ok') {
10853: push @badclasses, $class;
10854: }
10855: }
10856: $cenv{'internal.sectionnums'} =~ s/,$//;
10857: }
10858: }
10859: # do not hide course coordinator from staff listing,
10860: # even if privileged
10861: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10862: # add crosslistings
10863: if ($args->{'crsxlist'}) {
10864: $cenv{'internal.crosslistings'}='';
10865: if ($args->{'crsxlist'} =~ m/,/) {
10866: @xlists = split/,/,$args->{'crsxlist'};
10867: } else {
10868: $xlists[0] = $args->{'crsxlist'};
10869: }
10870: if (@xlists > 0) {
10871: foreach my $item (@xlists) {
10872: my ($xl,$gp) = split/:/,$item;
10873: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
10874: $cenv{'internal.crosslistings'} .= $item.',';
10875: unless ($addcheck eq 'ok') {
10876: push @badclasses, $xl;
10877: }
10878: }
10879: $cenv{'internal.crosslistings'} =~ s/,$//;
10880: }
10881: }
10882: if ($args->{'autoadds'}) {
10883: $cenv{'internal.autoadds'}=$args->{'autoadds'};
10884: }
10885: if ($args->{'autodrops'}) {
10886: $cenv{'internal.autodrops'}=$args->{'autodrops'};
10887: }
10888: # check for notification of enrollment changes
10889: my @notified = ();
10890: if ($args->{'notify_owner'}) {
10891: if ($args->{'ccuname'} ne '') {
10892: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
10893: }
10894: }
10895: if ($args->{'notify_dc'}) {
10896: if ($uname ne '') {
1.630 raeburn 10897: push(@notified,$uname.':'.$udom);
1.444 albertel 10898: }
10899: }
10900: if (@notified > 0) {
10901: my $notifylist;
10902: if (@notified > 1) {
10903: $notifylist = join(',',@notified);
10904: } else {
10905: $notifylist = $notified[0];
10906: }
10907: $cenv{'internal.notifylist'} = $notifylist;
10908: }
10909: if (@badclasses > 0) {
10910: my %lt=&Apache::lonlocal::texthash(
10911: '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',
10912: 'dnhr' => 'does not have rights to access enrollment in these classes',
10913: 'adby' => 'as determined by the policies of your institution on access to official classlists'
10914: );
1.541 raeburn 10915: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
10916: ' ('.$lt{'adby'}.')';
10917: if ($context eq 'auto') {
10918: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 10919: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 10920: foreach my $item (@badclasses) {
10921: if ($context eq 'auto') {
10922: $outcome .= " - $item\n";
10923: } else {
10924: $outcome .= "<li>$item</li>\n";
10925: }
10926: }
10927: if ($context eq 'auto') {
10928: $outcome .= $linefeed;
10929: } else {
1.566 albertel 10930: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 10931: }
10932: }
1.444 albertel 10933: }
10934: if ($args->{'no_end_date'}) {
10935: $args->{'endaccess'} = 0;
10936: }
10937: $cenv{'internal.autostart'}=$args->{'enrollstart'};
10938: $cenv{'internal.autoend'}=$args->{'enrollend'};
10939: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
10940: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
10941: if ($args->{'showphotos'}) {
10942: $cenv{'internal.showphotos'}=$args->{'showphotos'};
10943: }
10944: $cenv{'internal.authtype'} = $args->{'authtype'};
10945: $cenv{'internal.autharg'} = $args->{'autharg'};
10946: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
10947: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 10948: 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');
10949: if ($context eq 'auto') {
10950: $outcome .= $krb_msg;
10951: } else {
1.566 albertel 10952: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 10953: }
10954: $outcome .= $linefeed;
1.444 albertel 10955: }
10956: }
10957: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
10958: if ($args->{'setpolicy'}) {
10959: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10960: }
10961: if ($args->{'setcontent'}) {
10962: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10963: }
10964: }
10965: if ($args->{'reshome'}) {
10966: $cenv{'reshome'}=$args->{'reshome'}.'/';
10967: $cenv{'reshome'}=~s/\/+$/\//;
10968: }
10969: #
10970: # course has keyed access
10971: #
10972: if ($args->{'setkeys'}) {
10973: $cenv{'keyaccess'}='yes';
10974: }
10975: # if specified, key authority is not course, but user
10976: # only active if keyaccess is yes
10977: if ($args->{'keyauth'}) {
1.487 albertel 10978: my ($user,$domain) = split(':',$args->{'keyauth'});
10979: $user = &LONCAPA::clean_username($user);
10980: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 10981: if ($user ne '' && $domain ne '') {
1.487 albertel 10982: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 10983: }
10984: }
10985:
10986: if ($args->{'disresdis'}) {
10987: $cenv{'pch.roles.denied'}='st';
10988: }
10989: if ($args->{'disablechat'}) {
10990: $cenv{'plc.roles.denied'}='st';
10991: }
10992:
10993: # Record we've not yet viewed the Course Initialization Helper for this
10994: # course
10995: $cenv{'course.helper.not.run'} = 1;
10996: #
10997: # Use new Randomseed
10998: #
10999: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
11000: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
11001: #
11002: # The encryption code and receipt prefix for this course
11003: #
11004: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
11005: $cenv{'internal.encpref'}=100+int(9*rand(99));
11006: #
11007: # By default, use standard grading
11008: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
11009:
1.541 raeburn 11010: $outcome .= $linefeed.&mt('Setting environment').': '.
11011: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 11012: #
11013: # Open all assignments
11014: #
11015: if ($args->{'openall'}) {
11016: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
11017: my %storecontent = ($storeunder => time,
11018: $storeunder.'.type' => 'date_start');
11019:
11020: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 11021: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 11022: }
11023: #
11024: # Set first page
11025: #
11026: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
11027: || ($cloneid)) {
1.445 albertel 11028: use LONCAPA::map;
1.444 albertel 11029: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 11030:
11031: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
11032: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
11033:
1.444 albertel 11034: $outcome .= ($fatal?$errtext:'read ok').' - ';
11035: my $title; my $url;
11036: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 11037: $title=&mt('Syllabus');
1.444 albertel 11038: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
11039: } else {
1.963 raeburn 11040: $title=&mt('Table of Contents');
1.444 albertel 11041: $url='/adm/navmaps';
11042: }
1.445 albertel 11043:
11044: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
11045: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
11046:
11047: if ($errtext) { $fatal=2; }
1.541 raeburn 11048: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 11049: }
1.566 albertel 11050:
11051: return (1,$outcome);
1.444 albertel 11052: }
11053:
11054: ############################################################
11055: ############################################################
11056:
1.953 droeschl 11057: #SD
11058: # only Community and Course, or anything else?
1.378 raeburn 11059: sub course_type {
11060: my ($cid) = @_;
11061: if (!defined($cid)) {
11062: $cid = $env{'request.course.id'};
11063: }
1.404 albertel 11064: if (defined($env{'course.'.$cid.'.type'})) {
11065: return $env{'course.'.$cid.'.type'};
1.378 raeburn 11066: } else {
11067: return 'Course';
1.377 raeburn 11068: }
11069: }
1.156 albertel 11070:
1.406 raeburn 11071: sub group_term {
11072: my $crstype = &course_type();
11073: my %names = (
11074: 'Course' => 'group',
1.865 raeburn 11075: 'Community' => 'group',
1.406 raeburn 11076: );
11077: return $names{$crstype};
11078: }
11079:
1.902 raeburn 11080: sub course_types {
11081: my @types = ('official','unofficial','community');
11082: my %typename = (
11083: official => 'Official course',
11084: unofficial => 'Unofficial course',
11085: community => 'Community',
11086: );
11087: return (\@types,\%typename);
11088: }
11089:
1.156 albertel 11090: sub icon {
11091: my ($file)=@_;
1.505 albertel 11092: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 11093: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 11094: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 11095: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
11096: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
11097: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
11098: $curfext.".gif") {
11099: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
11100: $curfext.".gif";
11101: }
11102: }
1.249 albertel 11103: return &lonhttpdurl($iconname);
1.154 albertel 11104: }
1.84 albertel 11105:
1.575 albertel 11106: sub lonhttpdurl {
1.692 www 11107: #
11108: # Had been used for "small fry" static images on separate port 8080.
11109: # Modify here if lightweight http functionality desired again.
11110: # Currently eliminated due to increasing firewall issues.
11111: #
1.575 albertel 11112: my ($url)=@_;
1.692 www 11113: return $url;
1.215 albertel 11114: }
11115:
1.213 albertel 11116: sub connection_aborted {
11117: my ($r)=@_;
11118: $r->print(" ");$r->rflush();
11119: my $c = $r->connection;
11120: return $c->aborted();
11121: }
11122:
1.221 foxr 11123: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 11124: # strings as 'strings'.
11125: sub escape_single {
1.221 foxr 11126: my ($input) = @_;
1.223 albertel 11127: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 11128: $input =~ s/\'/\\\'/g; # Esacpe the 's....
11129: return $input;
11130: }
1.223 albertel 11131:
1.222 foxr 11132: # Same as escape_single, but escape's "'s This
11133: # can be used for "strings"
11134: sub escape_double {
11135: my ($input) = @_;
11136: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
11137: $input =~ s/\"/\\\"/g; # Esacpe the "s....
11138: return $input;
11139: }
1.223 albertel 11140:
1.222 foxr 11141: # Escapes the last element of a full URL.
11142: sub escape_url {
11143: my ($url) = @_;
1.238 raeburn 11144: my @urlslices = split(/\//, $url,-1);
1.369 www 11145: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 11146: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 11147: }
1.462 albertel 11148:
1.820 raeburn 11149: sub compare_arrays {
11150: my ($arrayref1,$arrayref2) = @_;
11151: my (@difference,%count);
11152: @difference = ();
11153: %count = ();
11154: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
11155: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
11156: foreach my $element (keys(%count)) {
11157: if ($count{$element} == 1) {
11158: push(@difference,$element);
11159: }
11160: }
11161: }
11162: return @difference;
11163: }
11164:
1.817 bisitz 11165: # -------------------------------------------------------- Initialize user login
1.462 albertel 11166: sub init_user_environment {
1.463 albertel 11167: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 11168: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
11169:
11170: my $public=($username eq 'public' && $domain eq 'public');
11171:
11172: # See if old ID present, if so, remove
11173:
11174: my ($filename,$cookie,$userroles);
11175: my $now=time;
11176:
11177: if ($public) {
11178: my $max_public=100;
11179: my $oldest;
11180: my $oldest_time=0;
11181: for(my $next=1;$next<=$max_public;$next++) {
11182: if (-e $lonids."/publicuser_$next.id") {
11183: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
11184: if ($mtime<$oldest_time || !$oldest_time) {
11185: $oldest_time=$mtime;
11186: $oldest=$next;
11187: }
11188: } else {
11189: $cookie="publicuser_$next";
11190: last;
11191: }
11192: }
11193: if (!$cookie) { $cookie="publicuser_$oldest"; }
11194: } else {
1.463 albertel 11195: # if this isn't a robot, kill any existing non-robot sessions
11196: if (!$args->{'robot'}) {
11197: opendir(DIR,$lonids);
11198: while ($filename=readdir(DIR)) {
11199: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
11200: unlink($lonids.'/'.$filename);
11201: }
1.462 albertel 11202: }
1.463 albertel 11203: closedir(DIR);
1.462 albertel 11204: }
11205: # Give them a new cookie
1.463 albertel 11206: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 11207: : $now.$$.int(rand(10000)));
1.463 albertel 11208: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 11209:
11210: # Initialize roles
11211:
11212: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
11213: }
11214: # ------------------------------------ Check browser type and MathML capability
11215:
11216: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
11217: $clientunicode,$clientos) = &decode_user_agent($r);
11218:
11219: # ------------------------------------------------------------- Get environment
11220:
11221: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
11222: my ($tmp) = keys(%userenv);
11223: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
11224: } else {
11225: undef(%userenv);
11226: }
11227: if (($userenv{'interface'}) && (!$form->{'interface'})) {
11228: $form->{'interface'}=$userenv{'interface'};
11229: }
11230: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
11231:
11232: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 11233: foreach my $option ('interface','localpath','localres') {
11234: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 11235: }
11236: # --------------------------------------------------------- Write first profile
11237:
11238: {
11239: my %initial_env =
11240: ("user.name" => $username,
11241: "user.domain" => $domain,
11242: "user.home" => $authhost,
11243: "browser.type" => $clientbrowser,
11244: "browser.version" => $clientversion,
11245: "browser.mathml" => $clientmathml,
11246: "browser.unicode" => $clientunicode,
11247: "browser.os" => $clientos,
11248: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
11249: "request.course.fn" => '',
11250: "request.course.uri" => '',
11251: "request.course.sec" => '',
11252: "request.role" => 'cm',
11253: "request.role.adv" => $env{'user.adv'},
11254: "request.host" => $ENV{'REMOTE_ADDR'},);
11255:
11256: if ($form->{'localpath'}) {
11257: $initial_env{"browser.localpath"} = $form->{'localpath'};
11258: $initial_env{"browser.localres"} = $form->{'localres'};
11259: }
11260:
11261: if ($form->{'interface'}) {
11262: $form->{'interface'}=~s/\W//gs;
11263: $initial_env{"browser.interface"} = $form->{'interface'};
11264: $env{'browser.interface'}=$form->{'interface'};
11265: }
11266:
1.981 raeburn 11267: my %is_adv = ( is_adv => $env{'user.adv'} );
1.980 raeburn 11268: my %domdef = &Apache::lonnet::get_domain_defaults($domain);
11269:
1.724 raeburn 11270: foreach my $tool ('aboutme','blog','portfolio') {
11271: $userenv{'availabletools.'.$tool} =
1.980 raeburn 11272: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
11273: undef,\%userenv,\%domdef,\%is_adv);
1.724 raeburn 11274: }
11275:
1.864 raeburn 11276: foreach my $crstype ('official','unofficial','community') {
1.765 raeburn 11277: $userenv{'canrequest.'.$crstype} =
11278: &Apache::lonnet::usertools_access($username,$domain,$crstype,
1.980 raeburn 11279: 'reload','requestcourses',
11280: \%userenv,\%domdef,\%is_adv);
1.765 raeburn 11281: }
11282:
1.462 albertel 11283: $env{'user.environment'} = "$lonids/$cookie.id";
11284:
11285: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
11286: &GDBM_WRCREAT(),0640)) {
11287: &_add_to_env(\%disk_env,\%initial_env);
11288: &_add_to_env(\%disk_env,\%userenv,'environment.');
11289: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 11290: if (ref($args->{'extra_env'})) {
11291: &_add_to_env(\%disk_env,$args->{'extra_env'});
11292: }
1.462 albertel 11293: untie(%disk_env);
11294: } else {
1.705 tempelho 11295: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
11296: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 11297: return 'error: '.$!;
11298: }
11299: }
11300: $env{'request.role'}='cm';
11301: $env{'request.role.adv'}=$env{'user.adv'};
11302: $env{'browser.type'}=$clientbrowser;
11303:
11304: return $cookie;
11305:
11306: }
11307:
11308: sub _add_to_env {
11309: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 11310: if (ref($env_data) eq 'HASH') {
11311: while (my ($key,$value) = each(%$env_data)) {
11312: $idf->{$prefix.$key} = $value;
11313: $env{$prefix.$key} = $value;
11314: }
1.462 albertel 11315: }
11316: }
11317:
1.685 tempelho 11318: # --- Get the symbolic name of a problem and the url
11319: sub get_symb {
11320: my ($request,$silent) = @_;
1.726 raeburn 11321: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 11322: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
11323: if ($symb eq '') {
11324: if (!$silent) {
11325: $request->print("Unable to handle ambiguous references:$url:.");
11326: return ();
11327: }
11328: }
11329: &Apache::lonenc::check_decrypt(\$symb);
11330: return ($symb);
11331: }
11332:
11333: # --------------------------------------------------------------Get annotation
11334:
11335: sub get_annotation {
11336: my ($symb,$enc) = @_;
11337:
11338: my $key = $symb;
11339: if (!$enc) {
11340: $key =
11341: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
11342: }
11343: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
11344: return $annotation{$key};
11345: }
11346:
11347: sub clean_symb {
1.731 raeburn 11348: my ($symb,$delete_enc) = @_;
1.685 tempelho 11349:
11350: &Apache::lonenc::check_decrypt(\$symb);
11351: my $enc = $env{'request.enc'};
1.731 raeburn 11352: if ($delete_enc) {
1.730 raeburn 11353: delete($env{'request.enc'});
11354: }
1.685 tempelho 11355:
11356: return ($symb,$enc);
11357: }
1.462 albertel 11358:
1.990 raeburn 11359: sub build_release_hashes {
11360: my ($checkparms,$checkresponsetypes,$checkcrstypes,$anonsurvey,$randomizetry) = @_;
11361: return unless((ref($checkparms) eq 'HASH') && (ref($checkresponsetypes) eq 'HASH') &&
11362: (ref($checkcrstypes) eq 'HASH') && (ref($anonsurvey) eq 'HASH') &&
11363: (ref($randomizetry) eq 'HASH'));
11364: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
11365: my ($item,$name,$value) = split(/:/,$key);
11366: if ($item eq 'parameter') {
11367: if (ref($checkparms->{$name}) eq 'ARRAY') {
11368: unless(grep(/^\Q$name\E$/,@{$checkparms->{$name}})) {
11369: push(@{$checkparms->{$name}},$value);
11370: }
11371: } else {
11372: push(@{$checkparms->{$name}},$value);
11373: }
11374: } elsif ($item eq 'resourcetag') {
11375: if ($name eq 'responsetype') {
11376: $checkresponsetypes->{$value} = $Apache::lonnet::needsrelease{$key}
11377: }
11378: } elsif ($item eq 'course') {
11379: if ($name eq 'crstype') {
11380: $checkcrstypes->{$value} = $Apache::lonnet::needsrelease{$key};
11381: }
11382: }
11383: }
11384: ($anonsurvey->{major},$anonsurvey->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:anonsurvey'});
11385: ($randomizetry->{major},$randomizetry->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:randomizetry'});
11386: return;
11387: }
11388:
1.41 ng 11389: =pod
11390:
11391: =back
11392:
1.112 bowersj2 11393: =cut
1.41 ng 11394:
1.112 bowersj2 11395: 1;
11396: __END__;
1.41 ng 11397:
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