Annotation of loncom/interface/loncommon.pm, revision 1.953
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.953 ! droeschl 4: # $Id: loncommon.pm,v 1.952 2010/03/16 16:00:42 onken 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.793 raeburn 412: function openstdbrowser(formname,uname,udom,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+
424: '&udomelement='+udom;
1.111 www 425: if (roleflag) { url+="&roles=1"; }
1.793 raeburn 426: if (courseadvonly) { url+="&courseadvonly=1"; }
1.102 www 427: var title = 'Student_Browser';
1.74 www 428: var options = 'scrollbars=1,resizable=1,menubar=0';
429: options += ',width=700,height=600';
430: stdeditbrowser = open(url,title,options,'1');
431: stdeditbrowser.focus();
432: }
1.824 bisitz 433: // ]]>
1.74 www 434: </script>
435: ENDSTDBRW
436: }
1.42 matthew 437:
1.74 www 438: sub selectstudent_link {
1.793 raeburn 439: my ($form,$unameele,$udomele,$courseadvonly)=@_;
440: my $callargs = "'".$form."','".$unameele."','".$udomele."'";
1.258 albertel 441: if ($env{'request.course.id'}) {
1.302 albertel 442: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
443: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
444: '/'.$env{'request.course.sec'})) {
1.111 www 445: return '';
446: }
1.793 raeburn 447: if ($courseadvonly) {
448: $callargs .= ",'',1,1";
449: }
450: return '<span class="LC_nobreak">'.
451: '<a href="javascript:openstdbrowser('.$callargs.');">'.
452: &mt('Select User').'</a></span>';
1.74 www 453: }
1.258 albertel 454: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.793 raeburn 455: $callargs .= ",1";
456: return '<span class="LC_nobreak">'.
457: '<a href="javascript:openstdbrowser('.$callargs.');">'.
458: &mt('Select User').'</a></span>';
1.111 www 459: }
460: return '';
1.91 www 461: }
462:
1.653 raeburn 463: sub authorbrowser_javascript {
464: return <<"ENDAUTHORBRW";
1.776 bisitz 465: <script type="text/javascript" language="JavaScript">
1.824 bisitz 466: // <![CDATA[
1.653 raeburn 467: var stdeditbrowser;
468:
469: function openauthorbrowser(formname,udom) {
470: var url = '/adm/pickauthor?';
471: url += 'form='+formname+'&roledom='+udom;
472: var title = 'Author_Browser';
473: var options = 'scrollbars=1,resizable=1,menubar=0';
474: options += ',width=700,height=600';
475: stdeditbrowser = open(url,title,options,'1');
476: stdeditbrowser.focus();
477: }
478:
1.824 bisitz 479: // ]]>
1.653 raeburn 480: </script>
481: ENDAUTHORBRW
482: }
483:
1.91 www 484: sub coursebrowser_javascript {
1.909 raeburn 485: my ($domainfilter,$sec_element,$formname,$role_element,$crstype) = @_;
1.932 raeburn 486: my $wintitle = 'Course_Browser';
1.931 raeburn 487: if ($crstype eq 'Community') {
1.932 raeburn 488: $wintitle = 'Community_Browser';
1.909 raeburn 489: }
1.876 raeburn 490: my $id_functions = &javascript_index_functions();
491: my $output = '
1.776 bisitz 492: <script type="text/javascript" language="JavaScript">
1.824 bisitz 493: // <![CDATA[
1.468 raeburn 494: var stdeditbrowser;'."\n";
1.876 raeburn 495:
496: $output .= <<"ENDSTDBRW";
1.909 raeburn 497: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91 www 498: var url = '/adm/pickcourse?';
1.895 raeburn 499: var formid = getFormIdByName(formname);
1.876 raeburn 500: var domainfilter = getDomainFromSelectbox(formname,udom);
1.128 albertel 501: if (domainfilter != null) {
502: if (domainfilter != '') {
503: url += 'domainfilter='+domainfilter+'&';
504: }
505: }
1.91 www 506: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 507: '&cdomelement='+udom+
508: '&cnameelement='+desc;
1.468 raeburn 509: if (extra_element !=null && extra_element != '') {
1.594 raeburn 510: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 511: url += '&roleelement='+extra_element;
512: if (domainfilter == null || domainfilter == '') {
513: url += '&domainfilter='+extra_element;
514: }
1.234 raeburn 515: }
1.468 raeburn 516: else {
517: if (formname == 'portform') {
518: url += '&setroles='+extra_element;
1.800 raeburn 519: } else {
520: if (formname == 'rules') {
521: url += '&fixeddom='+extra_element;
522: }
1.468 raeburn 523: }
524: }
1.230 raeburn 525: }
1.909 raeburn 526: if (type != null && type != '') {
527: url += '&type='+type;
528: }
529: if (type_elem != null && type_elem != '') {
530: url += '&typeelement='+type_elem;
531: }
1.872 raeburn 532: if (formname == 'ccrs') {
533: var ownername = document.forms[formid].ccuname.value;
534: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
535: url += '&cloner='+ownername+':'+ownerdom;
536: }
1.293 raeburn 537: if (multflag !=null && multflag != '') {
538: url += '&multiple='+multflag;
539: }
1.909 raeburn 540: var title = '$wintitle';
1.91 www 541: var options = 'scrollbars=1,resizable=1,menubar=0';
542: options += ',width=700,height=600';
543: stdeditbrowser = open(url,title,options,'1');
544: stdeditbrowser.focus();
545: }
1.876 raeburn 546: $id_functions
547: ENDSTDBRW
1.905 raeburn 548: if (($sec_element ne '') || ($role_element ne '')) {
549: $output .= &setsec_javascript($sec_element,$formname,$role_element);
1.876 raeburn 550: }
551: $output .= '
552: // ]]>
553: </script>';
554: return $output;
555: }
556:
557: sub javascript_index_functions {
558: return <<"ENDJS";
559:
560: function getFormIdByName(formname) {
561: for (var i=0;i<document.forms.length;i++) {
562: if (document.forms[i].name == formname) {
563: return i;
564: }
565: }
566: return -1;
567: }
568:
569: function getIndexByName(formid,item) {
570: for (var i=0;i<document.forms[formid].elements.length;i++) {
571: if (document.forms[formid].elements[i].name == item) {
572: return i;
573: }
574: }
575: return -1;
576: }
1.468 raeburn 577:
1.876 raeburn 578: function getDomainFromSelectbox(formname,udom) {
579: var userdom;
580: var formid = getFormIdByName(formname);
581: if (formid > -1) {
582: var domid = getIndexByName(formid,udom);
583: if (domid > -1) {
584: if (document.forms[formid].elements[domid].type == 'select-one') {
585: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
586: }
587: if (document.forms[formid].elements[domid].type == 'hidden') {
588: userdom=document.forms[formid].elements[domid].value;
1.468 raeburn 589: }
590: }
591: }
1.876 raeburn 592: return userdom;
593: }
594:
595: ENDJS
1.468 raeburn 596:
1.876 raeburn 597: }
598:
599: sub userbrowser_javascript {
600: my $id_functions = &javascript_index_functions();
601: return <<"ENDUSERBRW";
602:
1.888 raeburn 603: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876 raeburn 604: var url = '/adm/pickuser?';
605: var userdom = getDomainFromSelectbox(formname,udom);
606: if (userdom != null) {
607: if (userdom != '') {
608: url += 'srchdom='+userdom+'&';
609: }
610: }
611: url += 'form=' + formname + '&unameelement='+uname+
612: '&udomelement='+udom+
613: '&ulastelement='+ulast+
614: '&ufirstelement='+ufirst+
615: '&uemailelement='+uemail+
1.881 raeburn 616: '&hideudomelement='+hideudom+
617: '&coursedom='+crsdom;
1.888 raeburn 618: if ((caller != null) && (caller != undefined)) {
619: url += '&caller='+caller;
620: }
1.876 raeburn 621: var title = 'User_Browser';
622: var options = 'scrollbars=1,resizable=1,menubar=0';
623: options += ',width=700,height=600';
624: var stdeditbrowser = open(url,title,options,'1');
625: stdeditbrowser.focus();
626: }
627:
1.888 raeburn 628: function fix_domain (formname,udom,origdom,uname) {
1.876 raeburn 629: var formid = getFormIdByName(formname);
630: if (formid > -1) {
1.888 raeburn 631: var unameid = getIndexByName(formid,uname);
1.876 raeburn 632: var domid = getIndexByName(formid,udom);
633: var hidedomid = getIndexByName(formid,origdom);
634: if (hidedomid > -1) {
635: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888 raeburn 636: var unameval = document.forms[formid].elements[unameid].value;
637: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
638: if (domid > -1) {
639: var slct = document.forms[formid].elements[domid];
640: if (slct.type == 'select-one') {
641: var i;
642: for (i=0;i<slct.length;i++) {
643: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
644: }
645: }
646: if (slct.type == 'hidden') {
647: slct.value = fixeddom;
1.876 raeburn 648: }
649: }
1.468 raeburn 650: }
651: }
652: }
1.876 raeburn 653: return;
654: }
655:
656: $id_functions
657: ENDUSERBRW
1.468 raeburn 658: }
659:
660: sub setsec_javascript {
1.905 raeburn 661: my ($sec_element,$formname,$role_element) = @_;
662: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
663: $communityrolestr);
664: if ($role_element ne '') {
665: my @allroles = ('st','ta','ep','in','ad');
666: foreach my $crstype ('Course','Community') {
667: if ($crstype eq 'Community') {
668: foreach my $role (@allroles) {
669: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
670: }
671: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
672: } else {
673: foreach my $role (@allroles) {
674: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
675: }
676: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
677: }
678: }
679: $rolestr = '"'.join('","',@allroles).'"';
680: $courserolestr = '"'.join('","',@courserolenames).'"';
681: $communityrolestr = '"'.join('","',@communityrolenames).'"';
682: }
1.468 raeburn 683: my $setsections = qq|
684: function setSect(sectionlist) {
1.629 raeburn 685: var sectionsArray = new Array();
686: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
687: sectionsArray = sectionlist.split(",");
688: }
1.468 raeburn 689: var numSections = sectionsArray.length;
690: document.$formname.$sec_element.length = 0;
691: if (numSections == 0) {
692: document.$formname.$sec_element.multiple=false;
693: document.$formname.$sec_element.size=1;
694: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
695: } else {
696: if (numSections == 1) {
697: document.$formname.$sec_element.multiple=false;
698: document.$formname.$sec_element.size=1;
699: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
700: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
701: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
702: } else {
703: for (var i=0; i<numSections; i++) {
704: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
705: }
706: document.$formname.$sec_element.multiple=true
707: if (numSections < 3) {
708: document.$formname.$sec_element.size=numSections;
709: } else {
710: document.$formname.$sec_element.size=3;
711: }
712: document.$formname.$sec_element.options[0].selected = false
713: }
714: }
1.91 www 715: }
1.905 raeburn 716:
717: function setRole(crstype) {
1.468 raeburn 718: |;
1.905 raeburn 719: if ($role_element eq '') {
720: $setsections .= ' return;
721: }
722: ';
723: } else {
724: $setsections .= qq|
725: var elementLength = document.$formname.$role_element.length;
726: var allroles = Array($rolestr);
727: var courserolenames = Array($courserolestr);
728: var communityrolenames = Array($communityrolestr);
729: if (elementLength != undefined) {
730: if (document.$formname.$role_element.options[5].value == 'cc') {
731: if (crstype == 'Course') {
732: return;
733: } else {
734: allroles[5] = 'co';
735: for (var i=0; i<6; i++) {
736: document.$formname.$role_element.options[i].value = allroles[i];
737: document.$formname.$role_element.options[i].text = communityrolenames[i];
738: }
739: }
740: } else {
741: if (crstype == 'Community') {
742: return;
743: } else {
744: allroles[5] = 'cc';
745: for (var i=0; i<6; i++) {
746: document.$formname.$role_element.options[i].value = allroles[i];
747: document.$formname.$role_element.options[i].text = courserolenames[i];
748: }
749: }
750: }
751: }
752: return;
753: }
754: |;
755: }
1.468 raeburn 756: return $setsections;
757: }
758:
1.91 www 759: sub selectcourse_link {
1.909 raeburn 760: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
761: $typeelement) = @_;
762: my $type = $selecttype;
1.871 raeburn 763: my $linktext = &mt('Select Course');
764: if ($selecttype eq 'Community') {
1.909 raeburn 765: $linktext = &mt('Select Community');
1.906 raeburn 766: } elsif ($selecttype eq 'Course/Community') {
767: $linktext = &mt('Select Course/Community');
1.909 raeburn 768: $type = '';
1.871 raeburn 769: }
1.787 bisitz 770: return '<span class="LC_nobreak">'
771: ."<a href='"
772: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
773: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 774: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 775: ."'>".$linktext.'</a>'
1.787 bisitz 776: .'</span>';
1.74 www 777: }
1.42 matthew 778:
1.653 raeburn 779: sub selectauthor_link {
780: my ($form,$udom)=@_;
781: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
782: &mt('Select Author').'</a>';
783: }
784:
1.876 raeburn 785: sub selectuser_link {
1.881 raeburn 786: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 787: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 788: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 789: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 790: ');">'.$linktext.'</a>';
1.876 raeburn 791: }
792:
1.273 raeburn 793: sub check_uncheck_jscript {
794: my $jscript = <<"ENDSCRT";
795: function checkAll(field) {
796: if (field.length > 0) {
797: for (i = 0; i < field.length; i++) {
798: field[i].checked = true ;
799: }
800: } else {
801: field.checked = true
802: }
803: }
804:
805: function uncheckAll(field) {
806: if (field.length > 0) {
807: for (i = 0; i < field.length; i++) {
808: field[i].checked = false ;
1.543 albertel 809: }
810: } else {
1.273 raeburn 811: field.checked = false ;
812: }
813: }
814: ENDSCRT
815: return $jscript;
816: }
817:
1.656 www 818: sub select_timezone {
1.659 raeburn 819: my ($name,$selected,$onchange,$includeempty)=@_;
820: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
821: if ($includeempty) {
822: $output .= '<option value=""';
823: if (($selected eq '') || ($selected eq 'local')) {
824: $output .= ' selected="selected" ';
825: }
826: $output .= '> </option>';
827: }
1.657 raeburn 828: my @timezones = DateTime::TimeZone->all_names;
829: foreach my $tzone (@timezones) {
830: $output.= '<option value="'.$tzone.'"';
831: if ($tzone eq $selected) {
832: $output.=' selected="selected"';
833: }
834: $output.=">$tzone</option>\n";
1.656 www 835: }
836: $output.="</select>";
837: return $output;
838: }
1.273 raeburn 839:
1.687 raeburn 840: sub select_datelocale {
841: my ($name,$selected,$onchange,$includeempty)=@_;
842: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
843: if ($includeempty) {
844: $output .= '<option value=""';
845: if ($selected eq '') {
846: $output .= ' selected="selected" ';
847: }
848: $output .= '> </option>';
849: }
850: my (@possibles,%locale_names);
851: my @locales = DateTime::Locale::Catalog::Locales;
852: foreach my $locale (@locales) {
853: if (ref($locale) eq 'HASH') {
854: my $id = $locale->{'id'};
855: if ($id ne '') {
856: my $en_terr = $locale->{'en_territory'};
857: my $native_terr = $locale->{'native_territory'};
1.695 raeburn 858: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 859: if (grep(/^en$/,@languages) || !@languages) {
860: if ($en_terr ne '') {
861: $locale_names{$id} = '('.$en_terr.')';
862: } elsif ($native_terr ne '') {
863: $locale_names{$id} = $native_terr;
864: }
865: } else {
866: if ($native_terr ne '') {
867: $locale_names{$id} = $native_terr.' ';
868: } elsif ($en_terr ne '') {
869: $locale_names{$id} = '('.$en_terr.')';
870: }
871: }
872: push (@possibles,$id);
873: }
874: }
875: }
876: foreach my $item (sort(@possibles)) {
877: $output.= '<option value="'.$item.'"';
878: if ($item eq $selected) {
879: $output.=' selected="selected"';
880: }
881: $output.=">$item";
882: if ($locale_names{$item} ne '') {
883: $output.=" $locale_names{$item}</option>\n";
884: }
885: $output.="</option>\n";
886: }
887: $output.="</select>";
888: return $output;
889: }
890:
1.792 raeburn 891: sub select_language {
892: my ($name,$selected,$includeempty) = @_;
893: my %langchoices;
894: if ($includeempty) {
895: %langchoices = ('' => 'No language preference');
896: }
897: foreach my $id (&languageids()) {
898: my $code = &supportedlanguagecode($id);
899: if ($code) {
900: $langchoices{$code} = &plainlanguagedescription($id);
901: }
902: }
903: return &select_form($selected,$name,%langchoices);
904: }
905:
1.42 matthew 906: =pod
1.36 matthew 907:
1.648 raeburn 908: =item * &linked_select_forms(...)
1.36 matthew 909:
910: linked_select_forms returns a string containing a <script></script> block
911: and html for two <select> menus. The select menus will be linked in that
912: changing the value of the first menu will result in new values being placed
913: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 914: order unless a defined order is provided.
1.36 matthew 915:
916: linked_select_forms takes the following ordered inputs:
917:
918: =over 4
919:
1.112 bowersj2 920: =item * $formname, the name of the <form> tag
1.36 matthew 921:
1.112 bowersj2 922: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 923:
1.112 bowersj2 924: =item * $firstdefault, the default value for the first menu
1.36 matthew 925:
1.112 bowersj2 926: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 927:
1.112 bowersj2 928: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 929:
1.112 bowersj2 930: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 931:
1.609 raeburn 932: =item * $menuorder, the order of values in the first menu
933:
1.41 ng 934: =back
935:
1.36 matthew 936: Below is an example of such a hash. Only the 'text', 'default', and
937: 'select2' keys must appear as stated. keys(%menu) are the possible
938: values for the first select menu. The text that coincides with the
1.41 ng 939: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 940: and text for the second menu are given in the hash pointed to by
941: $menu{$choice1}->{'select2'}.
942:
1.112 bowersj2 943: my %menu = ( A1 => { text =>"Choice A1" ,
944: default => "B3",
945: select2 => {
946: B1 => "Choice B1",
947: B2 => "Choice B2",
948: B3 => "Choice B3",
949: B4 => "Choice B4"
1.609 raeburn 950: },
951: order => ['B4','B3','B1','B2'],
1.112 bowersj2 952: },
953: A2 => { text =>"Choice A2" ,
954: default => "C2",
955: select2 => {
956: C1 => "Choice C1",
957: C2 => "Choice C2",
958: C3 => "Choice C3"
1.609 raeburn 959: },
960: order => ['C2','C1','C3'],
1.112 bowersj2 961: },
962: A3 => { text =>"Choice A3" ,
963: default => "D6",
964: select2 => {
965: D1 => "Choice D1",
966: D2 => "Choice D2",
967: D3 => "Choice D3",
968: D4 => "Choice D4",
969: D5 => "Choice D5",
970: D6 => "Choice D6",
971: D7 => "Choice D7"
1.609 raeburn 972: },
973: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 974: }
975: );
1.36 matthew 976:
977: =cut
978:
979: sub linked_select_forms {
980: my ($formname,
981: $middletext,
982: $firstdefault,
983: $firstselectname,
984: $secondselectname,
1.609 raeburn 985: $hashref,
986: $menuorder,
1.36 matthew 987: ) = @_;
988: my $second = "document.$formname.$secondselectname";
989: my $first = "document.$formname.$firstselectname";
990: # output the javascript to do the changing
991: my $result = '';
1.776 bisitz 992: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 993: $result.="// <![CDATA[\n";
1.36 matthew 994: $result.="var select2data = new Object();\n";
995: $" = '","';
996: my $debug = '';
997: foreach my $s1 (sort(keys(%$hashref))) {
998: $result.="select2data.d_$s1 = new Object();\n";
999: $result.="select2data.d_$s1.def = new String('".
1000: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 1001: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 1002: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1003: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1004: @s2values = @{$hashref->{$s1}->{'order'}};
1005: }
1.36 matthew 1006: $result.="\"@s2values\");\n";
1007: $result.="select2data.d_$s1.texts = new Array(";
1008: my @s2texts;
1009: foreach my $value (@s2values) {
1010: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
1011: }
1012: $result.="\"@s2texts\");\n";
1013: }
1014: $"=' ';
1015: $result.= <<"END";
1016:
1017: function select1_changed() {
1018: // Determine new choice
1019: var newvalue = "d_" + $first.value;
1020: // update select2
1021: var values = select2data[newvalue].values;
1022: var texts = select2data[newvalue].texts;
1023: var select2def = select2data[newvalue].def;
1024: var i;
1025: // out with the old
1026: for (i = 0; i < $second.options.length; i++) {
1027: $second.options[i] = null;
1028: }
1029: // in with the nuclear
1030: for (i=0;i<values.length; i++) {
1031: $second.options[i] = new Option(values[i]);
1.143 matthew 1032: $second.options[i].value = values[i];
1.36 matthew 1033: $second.options[i].text = texts[i];
1034: if (values[i] == select2def) {
1035: $second.options[i].selected = true;
1036: }
1037: }
1038: }
1.824 bisitz 1039: // ]]>
1.36 matthew 1040: </script>
1041: END
1042: # output the initial values for the selection lists
1043: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609 raeburn 1044: my @order = sort(keys(%{$hashref}));
1045: if (ref($menuorder) eq 'ARRAY') {
1046: @order = @{$menuorder};
1047: }
1048: foreach my $value (@order) {
1.36 matthew 1049: $result.=" <option value=\"$value\" ";
1.253 albertel 1050: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1051: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1052: }
1053: $result .= "</select>\n";
1054: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1055: $result .= $middletext;
1056: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
1057: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1058:
1059: my @secondorder = sort(keys(%select2));
1060: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1061: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1062: }
1063: foreach my $value (@secondorder) {
1.36 matthew 1064: $result.=" <option value=\"$value\" ";
1.253 albertel 1065: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1066: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1067: }
1068: $result .= "</select>\n";
1069: # return $debug;
1070: return $result;
1071: } # end of sub linked_select_forms {
1072:
1.45 matthew 1073: =pod
1.44 bowersj2 1074:
1.648 raeburn 1075: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
1.44 bowersj2 1076:
1.112 bowersj2 1077: Returns a string corresponding to an HTML link to the given help
1078: $topic, where $topic corresponds to the name of a .tex file in
1079: /home/httpd/html/adm/help/tex, with underscores replaced by
1080: spaces.
1081:
1082: $text will optionally be linked to the same topic, allowing you to
1083: link text in addition to the graphic. If you do not want to link
1084: text, but wish to specify one of the later parameters, pass an
1085: empty string.
1086:
1087: $stayOnPage is a value that will be interpreted as a boolean. If true,
1088: the link will not open a new window. If false, the link will open
1089: a new window using Javascript. (Default is false.)
1090:
1091: $width and $height are optional numerical parameters that will
1092: override the width and height of the popped up window, which may
1093: be useful for certain help topics with big pictures included.
1.44 bowersj2 1094:
1095: =cut
1096:
1097: sub help_open_topic {
1.48 bowersj2 1098: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1099: $text = "" if (not defined $text);
1.44 bowersj2 1100: $stayOnPage = 0 if (not defined $stayOnPage);
1101: $width = 350 if (not defined $width);
1102: $height = 400 if (not defined $height);
1103: my $filename = $topic;
1104: $filename =~ s/ /_/g;
1105:
1.48 bowersj2 1106: my $template = "";
1107: my $link;
1.572 banghart 1108:
1.159 www 1109: $topic=~s/\W/\_/g;
1.44 bowersj2 1110:
1.572 banghart 1111: if (!$stayOnPage) {
1.72 bowersj2 1112: $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 1113: } else {
1.48 bowersj2 1114: $link = "/adm/help/${filename}.hlp";
1115: }
1116:
1117: # Add the text
1.755 neumanie 1118: if ($text ne "") {
1.763 bisitz 1119: $template.='<span class="LC_help_open_topic">'
1120: .'<a target="_top" href="'.$link.'">'
1121: .$text.'</a>';
1.48 bowersj2 1122: }
1123:
1.763 bisitz 1124: # (Always) Add the graphic
1.179 matthew 1125: my $title = &mt('Online Help');
1.667 raeburn 1126: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.763 bisitz 1127: $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
1128: .'<img src="'.$helpicon.'" border="0"'
1129: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.934 droeschl 1130: .' title="'.$title.'" style="vertical-align:middle;"'
1.763 bisitz 1131: .' /></a>';
1132: if ($text ne "") {
1133: $template.='</span>';
1134: }
1.44 bowersj2 1135: return $template;
1136:
1.106 bowersj2 1137: }
1138:
1139: # This is a quicky function for Latex cheatsheet editing, since it
1140: # appears in at least four places
1141: sub helpLatexCheatsheet {
1.732 raeburn 1142: my ($topic,$text,$not_author) = @_;
1143: my $out;
1.106 bowersj2 1144: my $addOther = '';
1.732 raeburn 1145: if ($topic) {
1.763 bisitz 1146: $addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
1147: undef, undef, 600).
1148: '</span> ';
1149: }
1150: $out = '<span>' # Start cheatsheet
1151: .$addOther
1152: .'<span>'
1153: .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
1154: undef,undef,600)
1155: .'</span> <span>'
1156: .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
1157: undef,undef,600)
1158: .'</span>';
1.732 raeburn 1159: unless ($not_author) {
1.763 bisitz 1160: $out .= ' <span>'
1161: .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
1162: undef,undef,600)
1163: .'</span>';
1.732 raeburn 1164: }
1.763 bisitz 1165: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1166: return $out;
1.172 www 1167: }
1168:
1.430 albertel 1169: sub general_help {
1170: my $helptopic='Student_Intro';
1171: if ($env{'request.role'}=~/^(ca|au)/) {
1172: $helptopic='Authoring_Intro';
1.907 raeburn 1173: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1174: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1175: } elsif ($env{'request.role'}=~/^dc/) {
1176: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1177: }
1178: return $helptopic;
1179: }
1180:
1181: sub update_help_link {
1182: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1183: my $origurl = $ENV{'REQUEST_URI'};
1184: $origurl=~s|^/~|/priv/|;
1185: my $timestamp = time;
1186: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1187: $$datum = &escape($$datum);
1188: }
1189:
1190: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1191: my $output .= <<"ENDOUTPUT";
1192: <script type="text/javascript">
1.824 bisitz 1193: // <![CDATA[
1.430 albertel 1194: banner_link = '$banner_link';
1.824 bisitz 1195: // ]]>
1.430 albertel 1196: </script>
1197: ENDOUTPUT
1198: return $output;
1199: }
1200:
1201: # now just updates the help link and generates a blue icon
1.193 raeburn 1202: sub help_open_menu {
1.430 albertel 1203: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1204: = @_;
1.949 droeschl 1205: $stayOnPage = 1;
1.430 albertel 1206: my $output;
1207: if ($component_help) {
1208: if (!$text) {
1209: $output=&help_open_topic($component_help,undef,$stayOnPage,
1210: $width,$height);
1211: } else {
1212: my $help_text;
1213: $help_text=&unescape($topic);
1214: $output='<table><tr><td>'.
1215: &help_open_topic($component_help,$help_text,$stayOnPage,
1216: $width,$height).'</td></tr></table>';
1217: }
1218: }
1219: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1220: return $output.$banner_link;
1221: }
1222:
1223: sub top_nav_help {
1224: my ($text) = @_;
1.436 albertel 1225: $text = &mt($text);
1.949 droeschl 1226: my $stay_on_page = 1;
1227:
1.572 banghart 1228: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1229: : "javascript:helpMenu('open')";
1.572 banghart 1230: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1231:
1.201 raeburn 1232: my $title = &mt('Get help');
1.436 albertel 1233:
1234: return <<"END";
1235: $banner_link
1236: <a href="$link" title="$title">$text</a>
1237: END
1238: }
1239:
1240: sub help_menu_js {
1241: my ($text) = @_;
1.949 droeschl 1242: my $stayOnPage = 1;
1.436 albertel 1243: my $width = 620;
1244: my $height = 600;
1.430 albertel 1245: my $helptopic=&general_help();
1246: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1247: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1248: my $start_page =
1249: &Apache::loncommon::start_page('Help Menu', undef,
1250: {'frameset' => 1,
1251: 'js_ready' => 1,
1252: 'add_entries' => {
1253: 'border' => '0',
1.579 raeburn 1254: 'rows' => "110,*",},});
1.331 albertel 1255: my $end_page =
1256: &Apache::loncommon::end_page({'frameset' => 1,
1257: 'js_ready' => 1,});
1258:
1.436 albertel 1259: my $template .= <<"ENDTEMPLATE";
1260: <script type="text/javascript">
1.877 bisitz 1261: // <![CDATA[
1.253 albertel 1262: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1263: var banner_link = '';
1.243 raeburn 1264: function helpMenu(target) {
1265: var caller = this;
1266: if (target == 'open') {
1267: var newWindow = null;
1268: try {
1.262 albertel 1269: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1270: }
1271: catch(error) {
1272: writeHelp(caller);
1273: return;
1274: }
1275: if (newWindow) {
1276: caller = newWindow;
1277: }
1.193 raeburn 1278: }
1.243 raeburn 1279: writeHelp(caller);
1280: return;
1281: }
1282: function writeHelp(caller) {
1.430 albertel 1283: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243 raeburn 1284: caller.document.close()
1285: caller.focus()
1.193 raeburn 1286: }
1.877 bisitz 1287: // END LON-CAPA Internal -->
1.253 albertel 1288: // ]]>
1.436 albertel 1289: </script>
1.193 raeburn 1290: ENDTEMPLATE
1291: return $template;
1292: }
1293:
1.172 www 1294: sub help_open_bug {
1295: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1296: unless ($env{'user.adv'}) { return ''; }
1.172 www 1297: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1298: $text = "" if (not defined $text);
1299: $stayOnPage=1;
1.184 albertel 1300: $width = 600 if (not defined $width);
1301: $height = 600 if (not defined $height);
1.172 www 1302:
1303: $topic=~s/\W+/\+/g;
1304: my $link='';
1305: my $template='';
1.379 albertel 1306: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1307: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1308: if (!$stayOnPage)
1309: {
1310: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1311: }
1312: else
1313: {
1314: $link = $url;
1315: }
1316: # Add the text
1317: if ($text ne "")
1318: {
1319: $template .=
1320: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1321: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1322: }
1323:
1324: # Add the graphic
1.179 matthew 1325: my $title = &mt('Report a Bug');
1.215 albertel 1326: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1327: $template .= <<"ENDTEMPLATE";
1.436 albertel 1328: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1329: ENDTEMPLATE
1330: if ($text ne '') { $template.='</td></tr></table>' };
1331: return $template;
1332:
1333: }
1334:
1335: sub help_open_faq {
1336: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1337: unless ($env{'user.adv'}) { return ''; }
1.172 www 1338: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1339: $text = "" if (not defined $text);
1340: $stayOnPage=1;
1341: $width = 350 if (not defined $width);
1342: $height = 400 if (not defined $height);
1343:
1344: $topic=~s/\W+/\+/g;
1345: my $link='';
1346: my $template='';
1347: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1348: if (!$stayOnPage)
1349: {
1350: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1351: }
1352: else
1353: {
1354: $link = $url;
1355: }
1356:
1357: # Add the text
1358: if ($text ne "")
1359: {
1360: $template .=
1.173 www 1361: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1362: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1363: }
1364:
1365: # Add the graphic
1.179 matthew 1366: my $title = &mt('View the FAQ');
1.215 albertel 1367: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1368: $template .= <<"ENDTEMPLATE";
1.436 albertel 1369: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1370: ENDTEMPLATE
1371: if ($text ne '') { $template.='</td></tr></table>' };
1372: return $template;
1373:
1.44 bowersj2 1374: }
1.37 matthew 1375:
1.180 matthew 1376: ###############################################################
1377: ###############################################################
1378:
1.45 matthew 1379: =pod
1380:
1.648 raeburn 1381: =item * &change_content_javascript():
1.256 matthew 1382:
1383: This and the next function allow you to create small sections of an
1384: otherwise static HTML page that you can update on the fly with
1385: Javascript, even in Netscape 4.
1386:
1387: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1388: must be written to the HTML page once. It will prove the Javascript
1389: function "change(name, content)". Calling the change function with the
1390: name of the section
1391: you want to update, matching the name passed to C<changable_area>, and
1392: the new content you want to put in there, will put the content into
1393: that area.
1394:
1395: B<Note>: Netscape 4 only reserves enough space for the changable area
1396: to contain room for the original contents. You need to "make space"
1397: for whatever changes you wish to make, and be B<sure> to check your
1398: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1399: it's adequate for updating a one-line status display, but little more.
1400: This script will set the space to 100% width, so you only need to
1401: worry about height in Netscape 4.
1402:
1403: Modern browsers are much less limiting, and if you can commit to the
1404: user not using Netscape 4, this feature may be used freely with
1405: pretty much any HTML.
1406:
1407: =cut
1408:
1409: sub change_content_javascript {
1410: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1411: if ($env{'browser.type'} eq 'netscape' &&
1412: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1413: return (<<NETSCAPE4);
1414: function change(name, content) {
1415: doc = document.layers[name+"___escape"].layers[0].document;
1416: doc.open();
1417: doc.write(content);
1418: doc.close();
1419: }
1420: NETSCAPE4
1421: } else {
1422: # Otherwise, we need to use semi-standards-compliant code
1423: # (technically, "innerHTML" isn't standard but the equivalent
1424: # is really scary, and every useful browser supports it
1425: return (<<DOMBASED);
1426: function change(name, content) {
1427: element = document.getElementById(name);
1428: element.innerHTML = content;
1429: }
1430: DOMBASED
1431: }
1432: }
1433:
1434: =pod
1435:
1.648 raeburn 1436: =item * &changable_area($name,$origContent):
1.256 matthew 1437:
1438: This provides a "changable area" that can be modified on the fly via
1439: the Javascript code provided in C<change_content_javascript>. $name is
1440: the name you will use to reference the area later; do not repeat the
1441: same name on a given HTML page more then once. $origContent is what
1442: the area will originally contain, which can be left blank.
1443:
1444: =cut
1445:
1446: sub changable_area {
1447: my ($name, $origContent) = @_;
1448:
1.258 albertel 1449: if ($env{'browser.type'} eq 'netscape' &&
1450: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1451: # If this is netscape 4, we need to use the Layer tag
1452: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1453: } else {
1454: return "<span id='$name'>$origContent</span>";
1455: }
1456: }
1457:
1458: =pod
1459:
1.648 raeburn 1460: =item * &viewport_geometry_js
1.590 raeburn 1461:
1462: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1463:
1464: =cut
1465:
1466:
1467: sub viewport_geometry_js {
1468: return <<"GEOMETRY";
1469: var Geometry = {};
1470: function init_geometry() {
1471: if (Geometry.init) { return };
1472: Geometry.init=1;
1473: if (window.innerHeight) {
1474: Geometry.getViewportHeight = function() { return window.innerHeight; };
1475: Geometry.getViewportWidth = function() { return window.innerWidth; };
1476: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1477: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1478: }
1479: else if (document.documentElement && document.documentElement.clientHeight) {
1480: Geometry.getViewportHeight =
1481: function() { return document.documentElement.clientHeight; };
1482: Geometry.getViewportWidth =
1483: function() { return document.documentElement.clientWidth; };
1484:
1485: Geometry.getHorizontalScroll =
1486: function() { return document.documentElement.scrollLeft; };
1487: Geometry.getVerticalScroll =
1488: function() { return document.documentElement.scrollTop; };
1489: }
1490: else if (document.body.clientHeight) {
1491: Geometry.getViewportHeight =
1492: function() { return document.body.clientHeight; };
1493: Geometry.getViewportWidth =
1494: function() { return document.body.clientWidth; };
1495: Geometry.getHorizontalScroll =
1496: function() { return document.body.scrollLeft; };
1497: Geometry.getVerticalScroll =
1498: function() { return document.body.scrollTop; };
1499: }
1500: }
1501:
1502: GEOMETRY
1503: }
1504:
1505: =pod
1506:
1.648 raeburn 1507: =item * &viewport_size_js()
1.590 raeburn 1508:
1509: 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.
1510:
1511: =cut
1512:
1513: sub viewport_size_js {
1514: my $geometry = &viewport_geometry_js();
1515: return <<"DIMS";
1516:
1517: $geometry
1518:
1519: function getViewportDims(width,height) {
1520: init_geometry();
1521: width.value = Geometry.getViewportWidth();
1522: height.value = Geometry.getViewportHeight();
1523: return;
1524: }
1525:
1526: DIMS
1527: }
1528:
1529: =pod
1530:
1.648 raeburn 1531: =item * &resize_textarea_js()
1.565 albertel 1532:
1533: emits the needed javascript to resize a textarea to be as big as possible
1534:
1535: creates a function resize_textrea that takes two IDs first should be
1536: the id of the element to resize, second should be the id of a div that
1537: surrounds everything that comes after the textarea, this routine needs
1538: to be attached to the <body> for the onload and onresize events.
1539:
1.648 raeburn 1540: =back
1.565 albertel 1541:
1542: =cut
1543:
1544: sub resize_textarea_js {
1.590 raeburn 1545: my $geometry = &viewport_geometry_js();
1.565 albertel 1546: return <<"RESIZE";
1547: <script type="text/javascript">
1.824 bisitz 1548: // <![CDATA[
1.590 raeburn 1549: $geometry
1.565 albertel 1550:
1.588 albertel 1551: function getX(element) {
1552: var x = 0;
1553: while (element) {
1554: x += element.offsetLeft;
1555: element = element.offsetParent;
1556: }
1557: return x;
1558: }
1559: function getY(element) {
1560: var y = 0;
1561: while (element) {
1562: y += element.offsetTop;
1563: element = element.offsetParent;
1564: }
1565: return y;
1566: }
1567:
1568:
1.565 albertel 1569: function resize_textarea(textarea_id,bottom_id) {
1570: init_geometry();
1571: var textarea = document.getElementById(textarea_id);
1572: //alert(textarea);
1573:
1.588 albertel 1574: var textarea_top = getY(textarea);
1.565 albertel 1575: var textarea_height = textarea.offsetHeight;
1576: var bottom = document.getElementById(bottom_id);
1.588 albertel 1577: var bottom_top = getY(bottom);
1.565 albertel 1578: var bottom_height = bottom.offsetHeight;
1579: var window_height = Geometry.getViewportHeight();
1.588 albertel 1580: var fudge = 23;
1.565 albertel 1581: var new_height = window_height-fudge-textarea_top-bottom_height;
1582: if (new_height < 300) {
1583: new_height = 300;
1584: }
1585: textarea.style.height=new_height+'px';
1586: }
1.824 bisitz 1587: // ]]>
1.565 albertel 1588: </script>
1589: RESIZE
1590:
1591: }
1592:
1593: =pod
1594:
1.256 matthew 1595: =head1 Excel and CSV file utility routines
1596:
1597: =over 4
1598:
1599: =cut
1600:
1601: ###############################################################
1602: ###############################################################
1603:
1604: =pod
1605:
1.648 raeburn 1606: =item * &csv_translate($text)
1.37 matthew 1607:
1.185 www 1608: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1609: format.
1610:
1611: =cut
1612:
1.180 matthew 1613: ###############################################################
1614: ###############################################################
1.37 matthew 1615: sub csv_translate {
1616: my $text = shift;
1617: $text =~ s/\"/\"\"/g;
1.209 albertel 1618: $text =~ s/\n/ /g;
1.37 matthew 1619: return $text;
1620: }
1.180 matthew 1621:
1622: ###############################################################
1623: ###############################################################
1624:
1625: =pod
1626:
1.648 raeburn 1627: =item * &define_excel_formats()
1.180 matthew 1628:
1629: Define some commonly used Excel cell formats.
1630:
1631: Currently supported formats:
1632:
1633: =over 4
1634:
1635: =item header
1636:
1637: =item bold
1638:
1639: =item h1
1640:
1641: =item h2
1642:
1643: =item h3
1644:
1.256 matthew 1645: =item h4
1646:
1647: =item i
1648:
1.180 matthew 1649: =item date
1650:
1651: =back
1652:
1653: Inputs: $workbook
1654:
1655: Returns: $format, a hash reference.
1656:
1657: =cut
1658:
1659: ###############################################################
1660: ###############################################################
1661: sub define_excel_formats {
1662: my ($workbook) = @_;
1663: my $format;
1664: $format->{'header'} = $workbook->add_format(bold => 1,
1665: bottom => 1,
1666: align => 'center');
1667: $format->{'bold'} = $workbook->add_format(bold=>1);
1668: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1669: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1670: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1671: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1672: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1673: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1674: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1675: return $format;
1676: }
1677:
1678: ###############################################################
1679: ###############################################################
1.113 bowersj2 1680:
1681: =pod
1682:
1.648 raeburn 1683: =item * &create_workbook()
1.255 matthew 1684:
1685: Create an Excel worksheet. If it fails, output message on the
1686: request object and return undefs.
1687:
1688: Inputs: Apache request object
1689:
1690: Returns (undef) on failure,
1691: Excel worksheet object, scalar with filename, and formats
1692: from &Apache::loncommon::define_excel_formats on success
1693:
1694: =cut
1695:
1696: ###############################################################
1697: ###############################################################
1698: sub create_workbook {
1699: my ($r) = @_;
1700: #
1701: # Create the excel spreadsheet
1702: my $filename = '/prtspool/'.
1.258 albertel 1703: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1704: time.'_'.rand(1000000000).'.xls';
1705: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1706: if (! defined($workbook)) {
1707: $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928 bisitz 1708: $r->print(
1709: '<p class="LC_error">'
1710: .&mt('Problems occurred in creating the new Excel file.')
1711: .' '.&mt('This error has been logged.')
1712: .' '.&mt('Please alert your LON-CAPA administrator.')
1713: .'</p>'
1714: );
1.255 matthew 1715: return (undef);
1716: }
1717: #
1718: $workbook->set_tempdir('/home/httpd/perl/tmp');
1719: #
1720: my $format = &Apache::loncommon::define_excel_formats($workbook);
1721: return ($workbook,$filename,$format);
1722: }
1723:
1724: ###############################################################
1725: ###############################################################
1726:
1727: =pod
1728:
1.648 raeburn 1729: =item * &create_text_file()
1.113 bowersj2 1730:
1.542 raeburn 1731: Create a file to write to and eventually make available to the user.
1.256 matthew 1732: If file creation fails, outputs an error message on the request object and
1733: return undefs.
1.113 bowersj2 1734:
1.256 matthew 1735: Inputs: Apache request object, and file suffix
1.113 bowersj2 1736:
1.256 matthew 1737: Returns (undef) on failure,
1738: Filehandle and filename on success.
1.113 bowersj2 1739:
1740: =cut
1741:
1.256 matthew 1742: ###############################################################
1743: ###############################################################
1744: sub create_text_file {
1745: my ($r,$suffix) = @_;
1746: if (! defined($suffix)) { $suffix = 'txt'; };
1747: my $fh;
1748: my $filename = '/prtspool/'.
1.258 albertel 1749: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1750: time.'_'.rand(1000000000).'.'.$suffix;
1751: $fh = Apache::File->new('>/home/httpd'.$filename);
1752: if (! defined($fh)) {
1753: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 1754: $r->print(
1755: '<p class="LC_error">'
1756: .&mt('Problems occurred in creating the output file.')
1757: .' '.&mt('This error has been logged.')
1758: .' '.&mt('Please alert your LON-CAPA administrator.')
1759: .'</p>'
1760: );
1.113 bowersj2 1761: }
1.256 matthew 1762: return ($fh,$filename)
1.113 bowersj2 1763: }
1764:
1765:
1.256 matthew 1766: =pod
1.113 bowersj2 1767:
1768: =back
1769:
1770: =cut
1.37 matthew 1771:
1772: ###############################################################
1.33 matthew 1773: ## Home server <option> list generating code ##
1774: ###############################################################
1.35 matthew 1775:
1.169 www 1776: # ------------------------------------------
1777:
1778: sub domain_select {
1779: my ($name,$value,$multiple)=@_;
1780: my %domains=map {
1.514 albertel 1781: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1782: } &Apache::lonnet::all_domains();
1.169 www 1783: if ($multiple) {
1784: $domains{''}=&mt('Any domain');
1.550 albertel 1785: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1786: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1787: } else {
1.550 albertel 1788: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169 www 1789: return &select_form($name,$value,%domains);
1790: }
1791: }
1792:
1.282 albertel 1793: #-------------------------------------------
1794:
1795: =pod
1796:
1.519 raeburn 1797: =head1 Routines for form select boxes
1798:
1799: =over 4
1800:
1.648 raeburn 1801: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1802:
1803: Returns a string containing a <select> element int multiple mode
1804:
1805:
1806: Args:
1807: $name - name of the <select> element
1.506 raeburn 1808: $value - scalar or array ref of values that should already be selected
1.282 albertel 1809: $size - number of rows long the select element is
1.283 albertel 1810: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1811: (shown text should already have been &mt())
1.506 raeburn 1812: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1813:
1.282 albertel 1814: =cut
1815:
1816: #-------------------------------------------
1.169 www 1817: sub multiple_select_form {
1.284 albertel 1818: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1819: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1820: my $output='';
1.191 matthew 1821: if (! defined($size)) {
1822: $size = 4;
1.283 albertel 1823: if (scalar(keys(%$hash))<4) {
1824: $size = scalar(keys(%$hash));
1.191 matthew 1825: }
1826: }
1.734 bisitz 1827: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1828: my @order;
1.506 raeburn 1829: if (ref($order) eq 'ARRAY') {
1830: @order = @{$order};
1831: } else {
1832: @order = sort(keys(%$hash));
1.501 banghart 1833: }
1834: if (exists($$hash{'select_form_order'})) {
1835: @order = @{$$hash{'select_form_order'}};
1836: }
1837:
1.284 albertel 1838: foreach my $key (@order) {
1.356 albertel 1839: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1840: $output.='selected="selected" ' if ($selected{$key});
1841: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1842: }
1843: $output.="</select>\n";
1844: return $output;
1845: }
1846:
1.88 www 1847: #-------------------------------------------
1848:
1849: =pod
1850:
1.648 raeburn 1851: =item * &select_form($defdom,$name,%hash)
1.88 www 1852:
1853: Returns a string containing a <select name='$name' size='1'> form to
1854: allow a user to select options from a hash option_name => displayed text.
1855: See lonrights.pm for an example invocation and use.
1856:
1857: =cut
1858:
1859: #-------------------------------------------
1860: sub select_form {
1861: my ($def,$name,%hash) = @_;
1862: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128 albertel 1863: my @keys;
1864: if (exists($hash{'select_form_order'})) {
1865: @keys=@{$hash{'select_form_order'}};
1866: } else {
1867: @keys=sort(keys(%hash));
1868: }
1.356 albertel 1869: foreach my $key (@keys) {
1870: $selectform.=
1871: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1872: ($key eq $def ? 'selected="selected" ' : '').
1.922 bisitz 1873: ">".$hash{$key}."</option>\n";
1.88 www 1874: }
1875: $selectform.="</select>";
1876: return $selectform;
1877: }
1878:
1.475 www 1879: # For display filters
1880:
1881: sub display_filter {
1882: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1883: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714 bisitz 1884: return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475 www 1885: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1886: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 1887: '</label></span> <span class="LC_nobreak">'.
1.475 www 1888: &mt('Filter [_1]',
1.477 www 1889: &select_form($env{'form.displayfilter'},
1890: 'displayfilter',
1891: ('currentfolder' => 'Current folder/page',
1892: 'containing' => 'Containing phrase',
1893: 'none' => 'None'))).
1.714 bisitz 1894: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475 www 1895: }
1896:
1.167 www 1897: sub gradeleveldescription {
1898: my $gradelevel=shift;
1899: my %gradelevels=(0 => 'Not specified',
1900: 1 => 'Grade 1',
1901: 2 => 'Grade 2',
1902: 3 => 'Grade 3',
1903: 4 => 'Grade 4',
1904: 5 => 'Grade 5',
1905: 6 => 'Grade 6',
1906: 7 => 'Grade 7',
1907: 8 => 'Grade 8',
1908: 9 => 'Grade 9',
1909: 10 => 'Grade 10',
1910: 11 => 'Grade 11',
1911: 12 => 'Grade 12',
1912: 13 => 'Grade 13',
1913: 14 => '100 Level',
1914: 15 => '200 Level',
1915: 16 => '300 Level',
1916: 17 => '400 Level',
1917: 18 => 'Graduate Level');
1918: return &mt($gradelevels{$gradelevel});
1919: }
1920:
1.163 www 1921: sub select_level_form {
1922: my ($deflevel,$name)=@_;
1923: unless ($deflevel) { $deflevel=0; }
1.167 www 1924: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1925: for (my $i=0; $i<=18; $i++) {
1926: $selectform.="<option value=\"$i\" ".
1.253 albertel 1927: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1928: ">".&gradeleveldescription($i)."</option>\n";
1929: }
1930: $selectform.="</select>";
1931: return $selectform;
1.163 www 1932: }
1.167 www 1933:
1.35 matthew 1934: #-------------------------------------------
1935:
1.45 matthew 1936: =pod
1937:
1.910 raeburn 1938: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35 matthew 1939:
1940: Returns a string containing a <select name='$name' size='1'> form to
1941: allow a user to select the domain to preform an operation in.
1942: See loncreateuser.pm for an example invocation and use.
1943:
1.90 www 1944: If the $includeempty flag is set, it also includes an empty choice ("no domain
1945: selected");
1946:
1.743 raeburn 1947: If the $showdomdesc flag is set, the domain name is followed by the domain description.
1948:
1.910 raeburn 1949: 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.
1950:
1951: The optional $incdoms is a reference to an array of domains which will be the only available options.
1.563 raeburn 1952:
1.35 matthew 1953: =cut
1954:
1955: #-------------------------------------------
1.34 matthew 1956: sub select_dom_form {
1.910 raeburn 1957: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.872 raeburn 1958: if ($onchange) {
1.874 raeburn 1959: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 1960: }
1.910 raeburn 1961: my @domains;
1962: if (ref($incdoms) eq 'ARRAY') {
1963: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
1964: } else {
1965: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1966: }
1.90 www 1967: if ($includeempty) { @domains=('',@domains); }
1.743 raeburn 1968: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 1969: foreach my $dom (@domains) {
1970: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 1971: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
1972: if ($showdomdesc) {
1973: if ($dom ne '') {
1974: my $domdesc = &Apache::lonnet::domain($dom,'description');
1975: if ($domdesc ne '') {
1976: $selectdomain .= ' ('.$domdesc.')';
1977: }
1978: }
1979: }
1980: $selectdomain .= "</option>\n";
1.34 matthew 1981: }
1982: $selectdomain.="</select>";
1983: return $selectdomain;
1984: }
1985:
1.35 matthew 1986: #-------------------------------------------
1987:
1.45 matthew 1988: =pod
1989:
1.648 raeburn 1990: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 1991:
1.586 raeburn 1992: input: 4 arguments (two required, two optional) -
1993: $domain - domain of new user
1994: $name - name of form element
1995: $default - Value of 'default' causes a default item to be first
1996: option, and selected by default.
1997: $hide - Value of 'hide' causes hiding of the name of the server,
1998: if 1 server found, or default, if 0 found.
1.594 raeburn 1999: output: returns 2 items:
1.586 raeburn 2000: (a) form element which contains either:
2001: (i) <select name="$name">
2002: <option value="$hostid1">$hostid $servers{$hostid}</option>
2003: <option value="$hostid2">$hostid $servers{$hostid}</option>
2004: </select>
2005: form item if there are multiple library servers in $domain, or
2006: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2007: if there is only one library server in $domain.
2008:
2009: (b) number of library servers found.
2010:
2011: See loncreateuser.pm for example of use.
1.35 matthew 2012:
2013: =cut
2014:
2015: #-------------------------------------------
1.586 raeburn 2016: sub home_server_form_item {
2017: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2018: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2019: my $result;
2020: my $numlib = keys(%servers);
2021: if ($numlib > 1) {
2022: $result .= '<select name="'.$name.'" />'."\n";
2023: if ($default) {
1.804 bisitz 2024: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 2025: '</option>'."\n";
2026: }
2027: foreach my $hostid (sort(keys(%servers))) {
2028: $result.= '<option value="'.$hostid.'">'.
2029: $hostid.' '.$servers{$hostid}."</option>\n";
2030: }
2031: $result .= '</select>'."\n";
2032: } elsif ($numlib == 1) {
2033: my $hostid;
2034: foreach my $item (keys(%servers)) {
2035: $hostid = $item;
2036: }
2037: $result .= '<input type="hidden" name="'.$name.'" value="'.
2038: $hostid.'" />';
2039: if (!$hide) {
2040: $result .= $hostid.' '.$servers{$hostid};
2041: }
2042: $result .= "\n";
2043: } elsif ($default) {
2044: $result .= '<input type="hidden" name="'.$name.
2045: '" value="default" />';
2046: if (!$hide) {
2047: $result .= &mt('default');
2048: }
2049: $result .= "\n";
1.33 matthew 2050: }
1.586 raeburn 2051: return ($result,$numlib);
1.33 matthew 2052: }
1.112 bowersj2 2053:
2054: =pod
2055:
1.534 albertel 2056: =back
2057:
1.112 bowersj2 2058: =cut
1.87 matthew 2059:
2060: ###############################################################
1.112 bowersj2 2061: ## Decoding User Agent ##
1.87 matthew 2062: ###############################################################
2063:
2064: =pod
2065:
1.112 bowersj2 2066: =head1 Decoding the User Agent
2067:
2068: =over 4
2069:
2070: =item * &decode_user_agent()
1.87 matthew 2071:
2072: Inputs: $r
2073:
2074: Outputs:
2075:
2076: =over 4
2077:
1.112 bowersj2 2078: =item * $httpbrowser
1.87 matthew 2079:
1.112 bowersj2 2080: =item * $clientbrowser
1.87 matthew 2081:
1.112 bowersj2 2082: =item * $clientversion
1.87 matthew 2083:
1.112 bowersj2 2084: =item * $clientmathml
1.87 matthew 2085:
1.112 bowersj2 2086: =item * $clientunicode
1.87 matthew 2087:
1.112 bowersj2 2088: =item * $clientos
1.87 matthew 2089:
2090: =back
2091:
1.157 matthew 2092: =back
2093:
1.87 matthew 2094: =cut
2095:
2096: ###############################################################
2097: ###############################################################
2098: sub decode_user_agent {
1.247 albertel 2099: my ($r)=@_;
1.87 matthew 2100: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2101: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2102: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2103: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2104: my $clientbrowser='unknown';
2105: my $clientversion='0';
2106: my $clientmathml='';
2107: my $clientunicode='0';
2108: for (my $i=0;$i<=$#browsertype;$i++) {
2109: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
2110: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2111: $clientbrowser=$bname;
2112: $httpbrowser=~/$vreg/i;
2113: $clientversion=$1;
2114: $clientmathml=($clientversion>=$minv);
2115: $clientunicode=($clientversion>=$univ);
2116: }
2117: }
2118: my $clientos='unknown';
2119: if (($httpbrowser=~/linux/i) ||
2120: ($httpbrowser=~/unix/i) ||
2121: ($httpbrowser=~/ux/i) ||
2122: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2123: if (($httpbrowser=~/vax/i) ||
2124: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2125: if ($httpbrowser=~/next/i) { $clientos='next'; }
2126: if (($httpbrowser=~/mac/i) ||
2127: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
2128: if ($httpbrowser=~/win/i) { $clientos='win'; }
2129: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
2130: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
2131: $clientunicode,$clientos,);
2132: }
2133:
1.32 matthew 2134: ###############################################################
2135: ## Authentication changing form generation subroutines ##
2136: ###############################################################
2137: ##
2138: ## All of the authform_xxxxxxx subroutines take their inputs in a
2139: ## hash, and have reasonable default values.
2140: ##
2141: ## formname = the name given in the <form> tag.
1.35 matthew 2142: #-------------------------------------------
2143:
1.45 matthew 2144: =pod
2145:
1.112 bowersj2 2146: =head1 Authentication Routines
2147:
2148: =over 4
2149:
1.648 raeburn 2150: =item * &authform_xxxxxx()
1.35 matthew 2151:
2152: The authform_xxxxxx subroutines provide javascript and html forms which
2153: handle some of the conveniences required for authentication forms.
2154: This is not an optimal method, but it works.
2155:
2156: =over 4
2157:
1.112 bowersj2 2158: =item * authform_header
1.35 matthew 2159:
1.112 bowersj2 2160: =item * authform_authorwarning
1.35 matthew 2161:
1.112 bowersj2 2162: =item * authform_nochange
1.35 matthew 2163:
1.112 bowersj2 2164: =item * authform_kerberos
1.35 matthew 2165:
1.112 bowersj2 2166: =item * authform_internal
1.35 matthew 2167:
1.112 bowersj2 2168: =item * authform_filesystem
1.35 matthew 2169:
2170: =back
2171:
1.648 raeburn 2172: See loncreateuser.pm for invocation and use examples.
1.157 matthew 2173:
1.35 matthew 2174: =cut
2175:
2176: #-------------------------------------------
1.32 matthew 2177: sub authform_header{
2178: my %in = (
2179: formname => 'cu',
1.80 albertel 2180: kerb_def_dom => '',
1.32 matthew 2181: @_,
2182: );
2183: $in{'formname'} = 'document.' . $in{'formname'};
2184: my $result='';
1.80 albertel 2185:
2186: #---------------------------------------------- Code for upper case translation
2187: my $Javascript_toUpperCase;
2188: unless ($in{kerb_def_dom}) {
2189: $Javascript_toUpperCase =<<"END";
2190: switch (choice) {
2191: case 'krb': currentform.elements[choicearg].value =
2192: currentform.elements[choicearg].value.toUpperCase();
2193: break;
2194: default:
2195: }
2196: END
2197: } else {
2198: $Javascript_toUpperCase = "";
2199: }
2200:
1.165 raeburn 2201: my $radioval = "'nochange'";
1.591 raeburn 2202: if (defined($in{'curr_authtype'})) {
2203: if ($in{'curr_authtype'} ne '') {
2204: $radioval = "'".$in{'curr_authtype'}."arg'";
2205: }
1.174 matthew 2206: }
1.165 raeburn 2207: my $argfield = 'null';
1.591 raeburn 2208: if (defined($in{'mode'})) {
1.165 raeburn 2209: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2210: if (defined($in{'curr_autharg'})) {
2211: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2212: $argfield = "'$in{'curr_autharg'}'";
2213: }
2214: }
2215: }
2216: }
2217:
1.32 matthew 2218: $result.=<<"END";
2219: var current = new Object();
1.165 raeburn 2220: current.radiovalue = $radioval;
2221: current.argfield = $argfield;
1.32 matthew 2222:
2223: function changed_radio(choice,currentform) {
2224: var choicearg = choice + 'arg';
2225: // If a radio button in changed, we need to change the argfield
2226: if (current.radiovalue != choice) {
2227: current.radiovalue = choice;
2228: if (current.argfield != null) {
2229: currentform.elements[current.argfield].value = '';
2230: }
2231: if (choice == 'nochange') {
2232: current.argfield = null;
2233: } else {
2234: current.argfield = choicearg;
2235: switch(choice) {
2236: case 'krb':
2237: currentform.elements[current.argfield].value =
2238: "$in{'kerb_def_dom'}";
2239: break;
2240: default:
2241: break;
2242: }
2243: }
2244: }
2245: return;
2246: }
1.22 www 2247:
1.32 matthew 2248: function changed_text(choice,currentform) {
2249: var choicearg = choice + 'arg';
2250: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2251: $Javascript_toUpperCase
1.32 matthew 2252: // clear old field
2253: if ((current.argfield != choicearg) && (current.argfield != null)) {
2254: currentform.elements[current.argfield].value = '';
2255: }
2256: current.argfield = choicearg;
2257: }
2258: set_auth_radio_buttons(choice,currentform);
2259: return;
1.20 www 2260: }
1.32 matthew 2261:
2262: function set_auth_radio_buttons(newvalue,currentform) {
2263: var i=0;
2264: while (i < currentform.login.length) {
2265: if (currentform.login[i].value == newvalue) { break; }
2266: i++;
2267: }
2268: if (i == currentform.login.length) {
2269: return;
2270: }
2271: current.radiovalue = newvalue;
2272: currentform.login[i].checked = true;
2273: return;
2274: }
2275: END
2276: return $result;
2277: }
2278:
2279: sub authform_authorwarning{
2280: my $result='';
1.144 matthew 2281: $result='<i>'.
2282: &mt('As a general rule, only authors or co-authors should be '.
2283: 'filesystem authenticated '.
2284: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2285: return $result;
2286: }
2287:
2288: sub authform_nochange{
2289: my %in = (
2290: formname => 'document.cu',
2291: kerb_def_dom => 'MSU.EDU',
2292: @_,
2293: );
1.586 raeburn 2294: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2295: my $result;
2296: if (keys(%can_assign) == 0) {
2297: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2298: } else {
2299: $result = '<label>'.&mt('[_1] Do not change login data',
2300: '<input type="radio" name="login" value="nochange" '.
2301: 'checked="checked" onclick="'.
1.281 albertel 2302: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2303: '</label>';
1.586 raeburn 2304: }
1.32 matthew 2305: return $result;
2306: }
2307:
1.591 raeburn 2308: sub authform_kerberos {
1.32 matthew 2309: my %in = (
2310: formname => 'document.cu',
2311: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2312: kerb_def_auth => 'krb4',
1.32 matthew 2313: @_,
2314: );
1.586 raeburn 2315: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2316: $autharg,$jscall);
2317: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2318: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2319: $check5 = ' checked="checked"';
1.80 albertel 2320: } else {
1.772 bisitz 2321: $check4 = ' checked="checked"';
1.80 albertel 2322: }
1.165 raeburn 2323: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2324: if (defined($in{'curr_authtype'})) {
2325: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2326: $krbcheck = ' checked="checked"';
1.623 raeburn 2327: if (defined($in{'mode'})) {
2328: if ($in{'mode'} eq 'modifyuser') {
2329: $krbcheck = '';
2330: }
2331: }
1.591 raeburn 2332: if (defined($in{'curr_kerb_ver'})) {
2333: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2334: $check5 = ' checked="checked"';
1.591 raeburn 2335: $check4 = '';
2336: } else {
1.772 bisitz 2337: $check4 = ' checked="checked"';
1.591 raeburn 2338: $check5 = '';
2339: }
1.586 raeburn 2340: }
1.591 raeburn 2341: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2342: $krbarg = $in{'curr_autharg'};
2343: }
1.586 raeburn 2344: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2345: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2346: $result =
2347: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2348: $in{'curr_autharg'},$krbver);
2349: } else {
2350: $result =
2351: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2352: }
2353: return $result;
2354: }
2355: }
2356: } else {
2357: if ($authnum == 1) {
1.784 bisitz 2358: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2359: }
2360: }
1.586 raeburn 2361: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2362: return;
1.587 raeburn 2363: } elsif ($authtype eq '') {
1.591 raeburn 2364: if (defined($in{'mode'})) {
1.587 raeburn 2365: if ($in{'mode'} eq 'modifycourse') {
2366: if ($authnum == 1) {
1.784 bisitz 2367: $authtype = '<input type="hidden" name="login" value="krb" />';
1.587 raeburn 2368: }
2369: }
2370: }
1.586 raeburn 2371: }
2372: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2373: if ($authtype eq '') {
2374: $authtype = '<input type="radio" name="login" value="krb" '.
2375: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2376: $krbcheck.' />';
2377: }
2378: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2379: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2380: $in{'curr_authtype'} eq 'krb5') ||
2381: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2382: $in{'curr_authtype'} eq 'krb4')) {
2383: $result .= &mt
1.144 matthew 2384: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2385: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2386: '<label>'.$authtype,
1.281 albertel 2387: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2388: 'value="'.$krbarg.'" '.
1.144 matthew 2389: 'onchange="'.$jscall.'" />',
1.281 albertel 2390: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2391: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2392: '</label>');
1.586 raeburn 2393: } elsif ($can_assign{'krb4'}) {
2394: $result .= &mt
2395: ('[_1] Kerberos authenticated with domain [_2] '.
2396: '[_3] Version 4 [_4]',
2397: '<label>'.$authtype,
2398: '</label><input type="text" size="10" name="krbarg" '.
2399: 'value="'.$krbarg.'" '.
2400: 'onchange="'.$jscall.'" />',
2401: '<label><input type="hidden" name="krbver" value="4" />',
2402: '</label>');
2403: } elsif ($can_assign{'krb5'}) {
2404: $result .= &mt
2405: ('[_1] Kerberos authenticated with domain [_2] '.
2406: '[_3] Version 5 [_4]',
2407: '<label>'.$authtype,
2408: '</label><input type="text" size="10" name="krbarg" '.
2409: 'value="'.$krbarg.'" '.
2410: 'onchange="'.$jscall.'" />',
2411: '<label><input type="hidden" name="krbver" value="5" />',
2412: '</label>');
2413: }
1.32 matthew 2414: return $result;
2415: }
2416:
2417: sub authform_internal{
1.586 raeburn 2418: my %in = (
1.32 matthew 2419: formname => 'document.cu',
2420: kerb_def_dom => 'MSU.EDU',
2421: @_,
2422: );
1.586 raeburn 2423: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2424: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2425: if (defined($in{'curr_authtype'})) {
2426: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2427: if ($can_assign{'int'}) {
1.772 bisitz 2428: $intcheck = 'checked="checked" ';
1.623 raeburn 2429: if (defined($in{'mode'})) {
2430: if ($in{'mode'} eq 'modifyuser') {
2431: $intcheck = '';
2432: }
2433: }
1.591 raeburn 2434: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2435: $intarg = $in{'curr_autharg'};
2436: }
2437: } else {
2438: $result = &mt('Currently internally authenticated.');
2439: return $result;
1.165 raeburn 2440: }
2441: }
1.586 raeburn 2442: } else {
2443: if ($authnum == 1) {
1.784 bisitz 2444: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 2445: }
2446: }
2447: if (!$can_assign{'int'}) {
2448: return;
1.587 raeburn 2449: } elsif ($authtype eq '') {
1.591 raeburn 2450: if (defined($in{'mode'})) {
1.587 raeburn 2451: if ($in{'mode'} eq 'modifycourse') {
2452: if ($authnum == 1) {
1.784 bisitz 2453: $authtype = '<input type="hidden" name="login" value="int" />';
1.587 raeburn 2454: }
2455: }
2456: }
1.165 raeburn 2457: }
1.586 raeburn 2458: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2459: if ($authtype eq '') {
2460: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2461: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2462: }
1.605 bisitz 2463: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2464: $intarg.'" onchange="'.$jscall.'" />';
2465: $result = &mt
1.144 matthew 2466: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2467: '<label>'.$authtype,'</label>'.$autharg);
1.824 bisitz 2468: $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 2469: return $result;
2470: }
2471:
2472: sub authform_local{
2473: my %in = (
2474: formname => 'document.cu',
2475: kerb_def_dom => 'MSU.EDU',
2476: @_,
2477: );
1.586 raeburn 2478: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2479: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2480: if (defined($in{'curr_authtype'})) {
2481: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2482: if ($can_assign{'loc'}) {
1.772 bisitz 2483: $loccheck = 'checked="checked" ';
1.623 raeburn 2484: if (defined($in{'mode'})) {
2485: if ($in{'mode'} eq 'modifyuser') {
2486: $loccheck = '';
2487: }
2488: }
1.591 raeburn 2489: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2490: $locarg = $in{'curr_autharg'};
2491: }
2492: } else {
2493: $result = &mt('Currently using local (institutional) authentication.');
2494: return $result;
1.165 raeburn 2495: }
2496: }
1.586 raeburn 2497: } else {
2498: if ($authnum == 1) {
1.784 bisitz 2499: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 2500: }
2501: }
2502: if (!$can_assign{'loc'}) {
2503: return;
1.587 raeburn 2504: } elsif ($authtype eq '') {
1.591 raeburn 2505: if (defined($in{'mode'})) {
1.587 raeburn 2506: if ($in{'mode'} eq 'modifycourse') {
2507: if ($authnum == 1) {
1.784 bisitz 2508: $authtype = '<input type="hidden" name="login" value="loc" />';
1.587 raeburn 2509: }
2510: }
2511: }
1.165 raeburn 2512: }
1.586 raeburn 2513: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2514: if ($authtype eq '') {
2515: $authtype = '<input type="radio" name="login" value="loc" '.
2516: $loccheck.' onchange="'.$jscall.'" onclick="'.
2517: $jscall.'" />';
2518: }
2519: $autharg = '<input type="text" size="10" name="locarg" value="'.
2520: $locarg.'" onchange="'.$jscall.'" />';
2521: $result = &mt('[_1] Local Authentication with argument [_2]',
2522: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2523: return $result;
2524: }
2525:
2526: sub authform_filesystem{
2527: my %in = (
2528: formname => 'document.cu',
2529: kerb_def_dom => 'MSU.EDU',
2530: @_,
2531: );
1.586 raeburn 2532: my ($fsyscheck,$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 'fsys') {
1.586 raeburn 2536: if ($can_assign{'fsys'}) {
1.772 bisitz 2537: $fsyscheck = 'checked="checked" ';
1.623 raeburn 2538: if (defined($in{'mode'})) {
2539: if ($in{'mode'} eq 'modifyuser') {
2540: $fsyscheck = '';
2541: }
2542: }
1.586 raeburn 2543: } else {
2544: $result = &mt('Currently Filesystem Authenticated.');
2545: return $result;
2546: }
2547: }
2548: } else {
2549: if ($authnum == 1) {
1.784 bisitz 2550: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 2551: }
2552: }
2553: if (!$can_assign{'fsys'}) {
2554: return;
1.587 raeburn 2555: } elsif ($authtype eq '') {
1.591 raeburn 2556: if (defined($in{'mode'})) {
1.587 raeburn 2557: if ($in{'mode'} eq 'modifycourse') {
2558: if ($authnum == 1) {
1.784 bisitz 2559: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587 raeburn 2560: }
2561: }
2562: }
1.586 raeburn 2563: }
2564: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2565: if ($authtype eq '') {
2566: $authtype = '<input type="radio" name="login" value="fsys" '.
2567: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2568: $jscall.'" />';
2569: }
2570: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2571: ' onchange="'.$jscall.'" />';
2572: $result = &mt
1.144 matthew 2573: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2574: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2575: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2576: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2577: 'onchange="'.$jscall.'" />');
1.32 matthew 2578: return $result;
2579: }
2580:
1.586 raeburn 2581: sub get_assignable_auth {
2582: my ($dom) = @_;
2583: if ($dom eq '') {
2584: $dom = $env{'request.role.domain'};
2585: }
2586: my %can_assign = (
2587: krb4 => 1,
2588: krb5 => 1,
2589: int => 1,
2590: loc => 1,
2591: );
2592: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2593: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2594: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2595: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2596: my $context;
2597: if ($env{'request.role'} =~ /^au/) {
2598: $context = 'author';
2599: } elsif ($env{'request.role'} =~ /^dc/) {
2600: $context = 'domain';
2601: } elsif ($env{'request.course.id'}) {
2602: $context = 'course';
2603: }
2604: if ($context) {
2605: if (ref($authhash->{$context}) eq 'HASH') {
2606: %can_assign = %{$authhash->{$context}};
2607: }
2608: }
2609: }
2610: }
2611: my $authnum = 0;
2612: foreach my $key (keys(%can_assign)) {
2613: if ($can_assign{$key}) {
2614: $authnum ++;
2615: }
2616: }
2617: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2618: $authnum --;
2619: }
2620: return ($authnum,%can_assign);
2621: }
2622:
1.80 albertel 2623: ###############################################################
2624: ## Get Kerberos Defaults for Domain ##
2625: ###############################################################
2626: ##
2627: ## Returns default kerberos version and an associated argument
2628: ## as listed in file domain.tab. If not listed, provides
2629: ## appropriate default domain and kerberos version.
2630: ##
2631: #-------------------------------------------
2632:
2633: =pod
2634:
1.648 raeburn 2635: =item * &get_kerberos_defaults()
1.80 albertel 2636:
2637: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2638: version and domain. If not found, it defaults to version 4 and the
2639: domain of the server.
1.80 albertel 2640:
1.648 raeburn 2641: =over 4
2642:
1.80 albertel 2643: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2644:
1.648 raeburn 2645: =back
2646:
2647: =back
2648:
1.80 albertel 2649: =cut
2650:
2651: #-------------------------------------------
2652: sub get_kerberos_defaults {
2653: my $domain=shift;
1.641 raeburn 2654: my ($krbdef,$krbdefdom);
2655: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2656: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2657: $krbdef = $domdefaults{'auth_def'};
2658: $krbdefdom = $domdefaults{'auth_arg_def'};
2659: } else {
1.80 albertel 2660: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2661: my $krbdefdom=$1;
2662: $krbdefdom=~tr/a-z/A-Z/;
2663: $krbdef = "krb4";
2664: }
2665: return ($krbdef,$krbdefdom);
2666: }
1.112 bowersj2 2667:
1.32 matthew 2668:
1.46 matthew 2669: ###############################################################
2670: ## Thesaurus Functions ##
2671: ###############################################################
1.20 www 2672:
1.46 matthew 2673: =pod
1.20 www 2674:
1.112 bowersj2 2675: =head1 Thesaurus Functions
2676:
2677: =over 4
2678:
1.648 raeburn 2679: =item * &initialize_keywords()
1.46 matthew 2680:
2681: Initializes the package variable %Keywords if it is empty. Uses the
2682: package variable $thesaurus_db_file.
2683:
2684: =cut
2685:
2686: ###################################################
2687:
2688: sub initialize_keywords {
2689: return 1 if (scalar keys(%Keywords));
2690: # If we are here, %Keywords is empty, so fill it up
2691: # Make sure the file we need exists...
2692: if (! -e $thesaurus_db_file) {
2693: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2694: " failed because it does not exist");
2695: return 0;
2696: }
2697: # Set up the hash as a database
2698: my %thesaurus_db;
2699: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2700: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2701: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2702: $thesaurus_db_file);
2703: return 0;
2704: }
2705: # Get the average number of appearances of a word.
2706: my $avecount = $thesaurus_db{'average.count'};
2707: # Put keywords (those that appear > average) into %Keywords
2708: while (my ($word,$data)=each (%thesaurus_db)) {
2709: my ($count,undef) = split /:/,$data;
2710: $Keywords{$word}++ if ($count > $avecount);
2711: }
2712: untie %thesaurus_db;
2713: # Remove special values from %Keywords.
1.356 albertel 2714: foreach my $value ('total.count','average.count') {
2715: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2716: }
1.46 matthew 2717: return 1;
2718: }
2719:
2720: ###################################################
2721:
2722: =pod
2723:
1.648 raeburn 2724: =item * &keyword($word)
1.46 matthew 2725:
2726: Returns true if $word is a keyword. A keyword is a word that appears more
2727: than the average number of times in the thesaurus database. Calls
2728: &initialize_keywords
2729:
2730: =cut
2731:
2732: ###################################################
1.20 www 2733:
2734: sub keyword {
1.46 matthew 2735: return if (!&initialize_keywords());
2736: my $word=lc(shift());
2737: $word=~s/\W//g;
2738: return exists($Keywords{$word});
1.20 www 2739: }
1.46 matthew 2740:
2741: ###############################################################
2742:
2743: =pod
1.20 www 2744:
1.648 raeburn 2745: =item * &get_related_words()
1.46 matthew 2746:
1.160 matthew 2747: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2748: an array of words. If the keyword is not in the thesaurus, an empty array
2749: will be returned. The order of the words returned is determined by the
2750: database which holds them.
2751:
2752: Uses global $thesaurus_db_file.
2753:
2754: =cut
2755:
2756: ###############################################################
2757: sub get_related_words {
2758: my $keyword = shift;
2759: my %thesaurus_db;
2760: if (! -e $thesaurus_db_file) {
2761: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2762: "failed because the file does not exist");
2763: return ();
2764: }
2765: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2766: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2767: return ();
2768: }
2769: my @Words=();
1.429 www 2770: my $count=0;
1.46 matthew 2771: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2772: # The first element is the number of times
2773: # the word appears. We do not need it now.
1.429 www 2774: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2775: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2776: my $threshold=$mostfrequentcount/10;
2777: foreach my $possibleword (@RelatedWords) {
2778: my ($word,$wordcount)=split(/\,/,$possibleword);
2779: if ($wordcount>$threshold) {
2780: push(@Words,$word);
2781: $count++;
2782: if ($count>10) { last; }
2783: }
1.20 www 2784: }
2785: }
1.46 matthew 2786: untie %thesaurus_db;
2787: return @Words;
1.14 harris41 2788: }
1.46 matthew 2789:
1.112 bowersj2 2790: =pod
2791:
2792: =back
2793:
2794: =cut
1.61 www 2795:
2796: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2797: =pod
2798:
1.112 bowersj2 2799: =head1 User Name Functions
2800:
2801: =over 4
2802:
1.648 raeburn 2803: =item * &plainname($uname,$udom,$first)
1.81 albertel 2804:
1.112 bowersj2 2805: Takes a users logon name and returns it as a string in
1.226 albertel 2806: "first middle last generation" form
2807: if $first is set to 'lastname' then it returns it as
2808: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2809:
2810: =cut
1.61 www 2811:
1.295 www 2812:
1.81 albertel 2813: ###############################################################
1.61 www 2814: sub plainname {
1.226 albertel 2815: my ($uname,$udom,$first)=@_;
1.537 albertel 2816: return if (!defined($uname) || !defined($udom));
1.295 www 2817: my %names=&getnames($uname,$udom);
1.226 albertel 2818: my $name=&Apache::lonnet::format_name($names{'firstname'},
2819: $names{'middlename'},
2820: $names{'lastname'},
2821: $names{'generation'},$first);
2822: $name=~s/^\s+//;
1.62 www 2823: $name=~s/\s+$//;
2824: $name=~s/\s+/ /g;
1.353 albertel 2825: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2826: return $name;
1.61 www 2827: }
1.66 www 2828:
2829: # -------------------------------------------------------------------- Nickname
1.81 albertel 2830: =pod
2831:
1.648 raeburn 2832: =item * &nickname($uname,$udom)
1.81 albertel 2833:
2834: Gets a users name and returns it as a string as
2835:
2836: ""nickname""
1.66 www 2837:
1.81 albertel 2838: if the user has a nickname or
2839:
2840: "first middle last generation"
2841:
2842: if the user does not
2843:
2844: =cut
1.66 www 2845:
2846: sub nickname {
2847: my ($uname,$udom)=@_;
1.537 albertel 2848: return if (!defined($uname) || !defined($udom));
1.295 www 2849: my %names=&getnames($uname,$udom);
1.68 albertel 2850: my $name=$names{'nickname'};
1.66 www 2851: if ($name) {
2852: $name='"'.$name.'"';
2853: } else {
2854: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2855: $names{'lastname'}.' '.$names{'generation'};
2856: $name=~s/\s+$//;
2857: $name=~s/\s+/ /g;
2858: }
2859: return $name;
2860: }
2861:
1.295 www 2862: sub getnames {
2863: my ($uname,$udom)=@_;
1.537 albertel 2864: return if (!defined($uname) || !defined($udom));
1.433 albertel 2865: if ($udom eq 'public' && $uname eq 'public') {
2866: return ('lastname' => &mt('Public'));
2867: }
1.295 www 2868: my $id=$uname.':'.$udom;
2869: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2870: if ($cached) {
2871: return %{$names};
2872: } else {
2873: my %loadnames=&Apache::lonnet::get('environment',
2874: ['firstname','middlename','lastname','generation','nickname'],
2875: $udom,$uname);
2876: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2877: return %loadnames;
2878: }
2879: }
1.61 www 2880:
1.542 raeburn 2881: # -------------------------------------------------------------------- getemails
1.648 raeburn 2882:
1.542 raeburn 2883: =pod
2884:
1.648 raeburn 2885: =item * &getemails($uname,$udom)
1.542 raeburn 2886:
2887: Gets a user's email information and returns it as a hash with keys:
2888: notification, critnotification, permanentemail
2889:
2890: For notification and critnotification, values are comma-separated lists
1.648 raeburn 2891: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 2892:
1.648 raeburn 2893:
1.542 raeburn 2894: =cut
2895:
1.648 raeburn 2896:
1.466 albertel 2897: sub getemails {
2898: my ($uname,$udom)=@_;
2899: if ($udom eq 'public' && $uname eq 'public') {
2900: return;
2901: }
1.467 www 2902: if (!$udom) { $udom=$env{'user.domain'}; }
2903: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 2904: my $id=$uname.':'.$udom;
2905: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2906: if ($cached) {
2907: return %{$names};
2908: } else {
2909: my %loadnames=&Apache::lonnet::get('environment',
2910: ['notification','critnotification',
2911: 'permanentemail'],
2912: $udom,$uname);
2913: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2914: return %loadnames;
2915: }
2916: }
2917:
1.551 albertel 2918: sub flush_email_cache {
2919: my ($uname,$udom)=@_;
2920: if (!$udom) { $udom =$env{'user.domain'}; }
2921: if (!$uname) { $uname=$env{'user.name'}; }
2922: return if ($udom eq 'public' && $uname eq 'public');
2923: my $id=$uname.':'.$udom;
2924: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2925: }
2926:
1.728 raeburn 2927: # -------------------------------------------------------------------- getlangs
2928:
2929: =pod
2930:
2931: =item * &getlangs($uname,$udom)
2932:
2933: Gets a user's language preference and returns it as a hash with key:
2934: language.
2935:
2936: =cut
2937:
2938:
2939: sub getlangs {
2940: my ($uname,$udom) = @_;
2941: if (!$udom) { $udom =$env{'user.domain'}; }
2942: if (!$uname) { $uname=$env{'user.name'}; }
2943: my $id=$uname.':'.$udom;
2944: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
2945: if ($cached) {
2946: return %{$langs};
2947: } else {
2948: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
2949: $udom,$uname);
2950: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
2951: return %loadlangs;
2952: }
2953: }
2954:
2955: sub flush_langs_cache {
2956: my ($uname,$udom)=@_;
2957: if (!$udom) { $udom =$env{'user.domain'}; }
2958: if (!$uname) { $uname=$env{'user.name'}; }
2959: return if ($udom eq 'public' && $uname eq 'public');
2960: my $id=$uname.':'.$udom;
2961: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
2962: }
2963:
1.61 www 2964: # ------------------------------------------------------------------ Screenname
1.81 albertel 2965:
2966: =pod
2967:
1.648 raeburn 2968: =item * &screenname($uname,$udom)
1.81 albertel 2969:
2970: Gets a users screenname and returns it as a string
2971:
2972: =cut
1.61 www 2973:
2974: sub screenname {
2975: my ($uname,$udom)=@_;
1.258 albertel 2976: if ($uname eq $env{'user.name'} &&
2977: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 2978: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 2979: return $names{'screenname'};
1.62 www 2980: }
2981:
1.212 albertel 2982:
1.802 bisitz 2983: # ------------------------------------------------------------- Confirm Wrapper
2984: =pod
2985:
2986: =item confirmwrapper
2987:
2988: Wrap messages about completion of operation in box
2989:
2990: =cut
2991:
2992: sub confirmwrapper {
2993: my ($message)=@_;
2994: if ($message) {
2995: return "\n".'<div class="LC_confirm_box">'."\n"
2996: .$message."\n"
2997: .'</div>'."\n";
2998: } else {
2999: return $message;
3000: }
3001: }
3002:
1.62 www 3003: # ------------------------------------------------------------- Message Wrapper
3004:
3005: sub messagewrapper {
1.369 www 3006: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 3007: return
1.441 albertel 3008: '<a href="/adm/email?compose=individual&'.
3009: 'recname='.$username.'&recdom='.$domain.
3010: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 3011: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 3012: }
1.802 bisitz 3013:
1.74 www 3014: # --------------------------------------------------------------- Notes Wrapper
3015:
3016: sub noteswrapper {
3017: my ($link,$un,$do)=@_;
3018: return
1.896 amueller 3019: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 3020: }
1.802 bisitz 3021:
1.62 www 3022: # ------------------------------------------------------------- Aboutme Wrapper
3023:
3024: sub aboutmewrapper {
1.166 www 3025: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 3026: if (!defined($username) && !defined($domain)) {
3027: return;
3028: }
1.892 amueller 3029: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.756 weissno 3030: ($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 3031: }
3032:
3033: # ------------------------------------------------------------ Syllabus Wrapper
3034:
3035: sub syllabuswrapper {
1.707 bisitz 3036: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 3037: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 3038: }
1.14 harris41 3039:
1.802 bisitz 3040: # -----------------------------------------------------------------------------
3041:
1.208 matthew 3042: sub track_student_link {
1.887 raeburn 3043: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 3044: my $link ="/adm/trackstudent?";
1.208 matthew 3045: my $title = 'View recent activity';
3046: if (defined($sname) && $sname !~ /^\s*$/ &&
3047: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 3048: $link .= "selected_student=$sname:$sdom";
1.208 matthew 3049: $title .= ' of this student';
1.268 albertel 3050: }
1.208 matthew 3051: if (defined($target) && $target !~ /^\s*$/) {
3052: $target = qq{target="$target"};
3053: } else {
3054: $target = '';
3055: }
1.268 albertel 3056: if ($start) { $link.='&start='.$start; }
1.887 raeburn 3057: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 3058: $title = &mt($title);
3059: $linktext = &mt($linktext);
1.448 albertel 3060: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
3061: &help_open_topic('View_recent_activity');
1.208 matthew 3062: }
3063:
1.781 raeburn 3064: sub slot_reservations_link {
3065: my ($linktext,$sname,$sdom,$target) = @_;
3066: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
3067: my $title = 'View slot reservation history';
3068: if (defined($sname) && $sname !~ /^\s*$/ &&
3069: defined($sdom) && $sdom !~ /^\s*$/) {
3070: $link .= "&uname=$sname&udom=$sdom";
3071: $title .= ' of this student';
3072: }
3073: if (defined($target) && $target !~ /^\s*$/) {
3074: $target = qq{target="$target"};
3075: } else {
3076: $target = '';
3077: }
3078: $title = &mt($title);
3079: $linktext = &mt($linktext);
3080: return qq{<a href="$link" title="$title" $target>$linktext</a>};
3081: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
3082:
3083: }
3084:
1.508 www 3085: # ===================================================== Display a student photo
3086:
3087:
1.509 albertel 3088: sub student_image_tag {
1.508 www 3089: my ($domain,$user)=@_;
3090: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
3091: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
3092: return '<img src="'.$imgsrc.'" align="right" />';
3093: } else {
3094: return '';
3095: }
3096: }
3097:
1.112 bowersj2 3098: =pod
3099:
3100: =back
3101:
3102: =head1 Access .tab File Data
3103:
3104: =over 4
3105:
1.648 raeburn 3106: =item * &languageids()
1.112 bowersj2 3107:
3108: returns list of all language ids
3109:
3110: =cut
3111:
1.14 harris41 3112: sub languageids {
1.16 harris41 3113: return sort(keys(%language));
1.14 harris41 3114: }
3115:
1.112 bowersj2 3116: =pod
3117:
1.648 raeburn 3118: =item * &languagedescription()
1.112 bowersj2 3119:
3120: returns description of a specified language id
3121:
3122: =cut
3123:
1.14 harris41 3124: sub languagedescription {
1.125 www 3125: my $code=shift;
3126: return ($supported_language{$code}?'* ':'').
3127: $language{$code}.
1.126 www 3128: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 3129: }
3130:
3131: sub plainlanguagedescription {
3132: my $code=shift;
3133: return $language{$code};
3134: }
3135:
3136: sub supportedlanguagecode {
3137: my $code=shift;
3138: return $supported_language{$code};
1.97 www 3139: }
3140:
1.112 bowersj2 3141: =pod
3142:
1.648 raeburn 3143: =item * ©rightids()
1.112 bowersj2 3144:
3145: returns list of all copyrights
3146:
3147: =cut
3148:
3149: sub copyrightids {
3150: return sort(keys(%cprtag));
3151: }
3152:
3153: =pod
3154:
1.648 raeburn 3155: =item * ©rightdescription()
1.112 bowersj2 3156:
3157: returns description of a specified copyright id
3158:
3159: =cut
3160:
3161: sub copyrightdescription {
1.166 www 3162: return &mt($cprtag{shift(@_)});
1.112 bowersj2 3163: }
1.197 matthew 3164:
3165: =pod
3166:
1.648 raeburn 3167: =item * &source_copyrightids()
1.192 taceyjo1 3168:
3169: returns list of all source copyrights
3170:
3171: =cut
3172:
3173: sub source_copyrightids {
3174: return sort(keys(%scprtag));
3175: }
3176:
3177: =pod
3178:
1.648 raeburn 3179: =item * &source_copyrightdescription()
1.192 taceyjo1 3180:
3181: returns description of a specified source copyright id
3182:
3183: =cut
3184:
3185: sub source_copyrightdescription {
3186: return &mt($scprtag{shift(@_)});
3187: }
1.112 bowersj2 3188:
3189: =pod
3190:
1.648 raeburn 3191: =item * &filecategories()
1.112 bowersj2 3192:
3193: returns list of all file categories
3194:
3195: =cut
3196:
3197: sub filecategories {
3198: return sort(keys(%category_extensions));
3199: }
3200:
3201: =pod
3202:
1.648 raeburn 3203: =item * &filecategorytypes()
1.112 bowersj2 3204:
3205: returns list of file types belonging to a given file
3206: category
3207:
3208: =cut
3209:
3210: sub filecategorytypes {
1.356 albertel 3211: my ($cat) = @_;
3212: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 3213: }
3214:
3215: =pod
3216:
1.648 raeburn 3217: =item * &fileembstyle()
1.112 bowersj2 3218:
3219: returns embedding style for a specified file type
3220:
3221: =cut
3222:
3223: sub fileembstyle {
3224: return $fe{lc(shift(@_))};
1.169 www 3225: }
3226:
1.351 www 3227: sub filemimetype {
3228: return $fm{lc(shift(@_))};
3229: }
3230:
1.169 www 3231:
3232: sub filecategoryselect {
3233: my ($name,$value)=@_;
1.189 matthew 3234: return &select_form($value,$name,
1.169 www 3235: '' => &mt('Any category'),
3236: map { $_,$_ } sort(keys(%category_extensions)));
1.112 bowersj2 3237: }
3238:
3239: =pod
3240:
1.648 raeburn 3241: =item * &filedescription()
1.112 bowersj2 3242:
3243: returns description for a specified file type
3244:
3245: =cut
3246:
3247: sub filedescription {
1.188 matthew 3248: my $file_description = $fd{lc(shift())};
3249: $file_description =~ s:([\[\]]):~$1:g;
3250: return &mt($file_description);
1.112 bowersj2 3251: }
3252:
3253: =pod
3254:
1.648 raeburn 3255: =item * &filedescriptionex()
1.112 bowersj2 3256:
3257: returns description for a specified file type with
3258: extra formatting
3259:
3260: =cut
3261:
3262: sub filedescriptionex {
3263: my $ex=shift;
1.188 matthew 3264: my $file_description = $fd{lc($ex)};
3265: $file_description =~ s:([\[\]]):~$1:g;
3266: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3267: }
3268:
3269: # End of .tab access
3270: =pod
3271:
3272: =back
3273:
3274: =cut
3275:
3276: # ------------------------------------------------------------------ File Types
3277: sub fileextensions {
3278: return sort(keys(%fe));
3279: }
3280:
1.97 www 3281: # ----------------------------------------------------------- Display Languages
3282: # returns a hash with all desired display languages
3283: #
3284:
3285: sub display_languages {
3286: my %languages=();
1.695 raeburn 3287: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3288: $languages{$lang}=1;
1.97 www 3289: }
3290: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3291: if ($env{'form.displaylanguage'}) {
1.356 albertel 3292: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3293: $languages{$lang}=1;
1.97 www 3294: }
3295: }
3296: return %languages;
1.14 harris41 3297: }
3298:
1.582 albertel 3299: sub languages {
3300: my ($possible_langs) = @_;
1.695 raeburn 3301: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3302: if (!ref($possible_langs)) {
3303: if( wantarray ) {
3304: return @preferred_langs;
3305: } else {
3306: return $preferred_langs[0];
3307: }
3308: }
3309: my %possibilities = map { $_ => 1 } (@$possible_langs);
3310: my @preferred_possibilities;
3311: foreach my $preferred_lang (@preferred_langs) {
3312: if (exists($possibilities{$preferred_lang})) {
3313: push(@preferred_possibilities, $preferred_lang);
3314: }
3315: }
3316: if( wantarray ) {
3317: return @preferred_possibilities;
3318: }
3319: return $preferred_possibilities[0];
3320: }
3321:
1.742 raeburn 3322: sub user_lang {
3323: my ($touname,$toudom,$fromcid) = @_;
3324: my @userlangs;
3325: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3326: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3327: $env{'course.'.$fromcid.'.languages'}));
3328: } else {
3329: my %langhash = &getlangs($touname,$toudom);
3330: if ($langhash{'languages'} ne '') {
3331: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3332: } else {
3333: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3334: if ($domdefs{'lang_def'} ne '') {
3335: @userlangs = ($domdefs{'lang_def'});
3336: }
3337: }
3338: }
3339: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3340: my $user_lh = Apache::localize->get_handle(@languages);
3341: return $user_lh;
3342: }
3343:
3344:
1.112 bowersj2 3345: ###############################################################
3346: ## Student Answer Attempts ##
3347: ###############################################################
3348:
3349: =pod
3350:
3351: =head1 Alternate Problem Views
3352:
3353: =over 4
3354:
1.648 raeburn 3355: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3356: $getattempt, $regexp, $gradesub)
3357:
3358: Return string with previous attempt on problem. Arguments:
3359:
3360: =over 4
3361:
3362: =item * $symb: Problem, including path
3363:
3364: =item * $username: username of the desired student
3365:
3366: =item * $domain: domain of the desired student
1.14 harris41 3367:
1.112 bowersj2 3368: =item * $course: Course ID
1.14 harris41 3369:
1.112 bowersj2 3370: =item * $getattempt: Leave blank for all attempts, otherwise put
3371: something
1.14 harris41 3372:
1.112 bowersj2 3373: =item * $regexp: if string matches this regexp, the string will be
3374: sent to $gradesub
1.14 harris41 3375:
1.112 bowersj2 3376: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3377:
1.112 bowersj2 3378: =back
1.14 harris41 3379:
1.112 bowersj2 3380: The output string is a table containing all desired attempts, if any.
1.16 harris41 3381:
1.112 bowersj2 3382: =cut
1.1 albertel 3383:
3384: sub get_previous_attempt {
1.43 ng 3385: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3386: my $prevattempts='';
1.43 ng 3387: no strict 'refs';
1.1 albertel 3388: if ($symb) {
1.3 albertel 3389: my (%returnhash)=
3390: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3391: if ($returnhash{'version'}) {
3392: my %lasthash=();
3393: my $version;
3394: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3395: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3396: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3397: }
1.1 albertel 3398: }
1.596 albertel 3399: $prevattempts=&start_data_table().&start_data_table_header_row();
3400: $prevattempts.='<th>'.&mt('History').'</th>';
1.945 raeburn 3401: my %typeparts;
3402: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 3403: foreach my $key (sort(keys(%lasthash))) {
3404: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3405: if ($#parts > 0) {
1.31 albertel 3406: my $data=$parts[-1];
3407: pop(@parts);
1.945 raeburn 3408: if ($data eq 'type') {
3409: unless ($showsurv) {
3410: my $id = join(',',@parts);
3411: $typeparts{$ign.'.'.$id} = $lasthash{$key};
3412: }
3413: delete($lasthash{$key});
3414: } else {
3415: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
3416: }
1.31 albertel 3417: } else {
1.41 ng 3418: if ($#parts == 0) {
3419: $prevattempts.='<th>'.$parts[0].'</th>';
3420: } else {
3421: $prevattempts.='<th>'.$ign.'</th>';
3422: }
1.31 albertel 3423: }
1.16 harris41 3424: }
1.596 albertel 3425: $prevattempts.=&end_data_table_header_row();
1.945 raeburn 3426: my %lasthidden;
1.40 ng 3427: if ($getattempt eq '') {
3428: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.945 raeburn 3429: my @hidden;
3430: if (%typeparts) {
3431: foreach my $id (keys(%typeparts)) {
3432: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
3433: push(@hidden,$id);
3434: $lasthidden{$id} = 1;
3435: } elsif ($lasthidden{$id}) {
3436: if (exists($returnhash{$version.':'.$id.'.award'})) {
3437: delete($lasthidden{$id});
3438: }
3439: }
3440: }
3441: }
3442: $prevattempts.=&start_data_table_row().
3443: '<td>'.&mt('Transaction [_1]',$version).'</td>';
3444: if (@hidden) {
3445: foreach my $key (sort(keys(%lasthash))) {
3446: my $hide;
3447: foreach my $id (@hidden) {
3448: if ($key =~ /^\Q$id\E/) {
3449: $hide = 1;
3450: last;
3451: }
3452: }
3453: if ($hide) {
3454: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3455: if (($data eq 'award') || ($data eq 'awarddetail')) {
3456: my $value = &format_previous_attempt_value($key,
3457: $returnhash{$version.':'.$key});
3458: $prevattempts.='<td>'.$value.' </td>';
3459: } else {
3460: $prevattempts.='<td> </td>';
3461: }
3462: } else {
3463: if ($key =~ /\./) {
3464: my $value = &format_previous_attempt_value($key,
3465: $returnhash{$version.':'.$key});
3466: $prevattempts.='<td>'.$value.' </td>';
3467: } else {
3468: $prevattempts.='<td> </td>';
3469: }
3470: }
3471: }
3472: } else {
3473: foreach my $key (sort(keys(%lasthash))) {
3474: my $value = &format_previous_attempt_value($key,
3475: $returnhash{$version.':'.$key});
3476: $prevattempts.='<td>'.$value.' </td>';
3477: }
3478: }
3479: $prevattempts.=&end_data_table_row();
1.40 ng 3480: }
1.1 albertel 3481: }
1.945 raeburn 3482: my @currhidden = keys(%lasthidden);
1.596 albertel 3483: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3484: foreach my $key (sort(keys(%lasthash))) {
1.945 raeburn 3485: if (%typeparts) {
3486: my $hidden;
3487: foreach my $id (@currhidden) {
3488: if ($key =~ /^\Q$id\E/) {
3489: $hidden = 1;
3490: last;
3491: }
3492: }
3493: if ($hidden) {
3494: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3495: if (($data eq 'award') || ($data eq 'awarddetail')) {
3496: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3497: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3498: $value = &$gradesub($value);
3499: }
3500: $prevattempts.='<td>'.$value.' </td>';
3501: } else {
3502: $prevattempts.='<td> </td>';
3503: }
3504: } else {
3505: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3506: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3507: $value = &$gradesub($value);
3508: }
3509: $prevattempts.='<td>'.$value.' </td>';
3510: }
3511: } else {
3512: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3513: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3514: $value = &$gradesub($value);
3515: }
3516: $prevattempts.='<td>'.$value.' </td>';
3517: }
1.16 harris41 3518: }
1.596 albertel 3519: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3520: } else {
1.596 albertel 3521: $prevattempts=
3522: &start_data_table().&start_data_table_row().
3523: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3524: &end_data_table_row().&end_data_table();
1.1 albertel 3525: }
3526: } else {
1.596 albertel 3527: $prevattempts=
3528: &start_data_table().&start_data_table_row().
3529: '<td>'.&mt('No data.').'</td>'.
3530: &end_data_table_row().&end_data_table();
1.1 albertel 3531: }
1.10 albertel 3532: }
3533:
1.581 albertel 3534: sub format_previous_attempt_value {
3535: my ($key,$value) = @_;
3536: if ($key =~ /timestamp/) {
3537: $value = &Apache::lonlocal::locallocaltime($value);
3538: } elsif (ref($value) eq 'ARRAY') {
3539: $value = '('.join(', ', @{ $value }).')';
3540: } else {
3541: $value = &unescape($value);
3542: }
3543: return $value;
3544: }
3545:
3546:
1.107 albertel 3547: sub relative_to_absolute {
3548: my ($url,$output)=@_;
3549: my $parser=HTML::TokeParser->new(\$output);
3550: my $token;
3551: my $thisdir=$url;
3552: my @rlinks=();
3553: while ($token=$parser->get_token) {
3554: if ($token->[0] eq 'S') {
3555: if ($token->[1] eq 'a') {
3556: if ($token->[2]->{'href'}) {
3557: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3558: }
3559: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3560: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3561: } elsif ($token->[1] eq 'base') {
3562: $thisdir=$token->[2]->{'href'};
3563: }
3564: }
3565: }
3566: $thisdir=~s-/[^/]*$--;
1.356 albertel 3567: foreach my $link (@rlinks) {
1.726 raeburn 3568: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3569: ($link=~/^\//) ||
3570: ($link=~/^javascript:/i) ||
3571: ($link=~/^mailto:/i) ||
3572: ($link=~/^\#/)) {
3573: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3574: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3575: }
3576: }
3577: # -------------------------------------------------- Deal with Applet codebases
3578: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3579: return $output;
3580: }
3581:
1.112 bowersj2 3582: =pod
3583:
1.648 raeburn 3584: =item * &get_student_view()
1.112 bowersj2 3585:
3586: show a snapshot of what student was looking at
3587:
3588: =cut
3589:
1.10 albertel 3590: sub get_student_view {
1.186 albertel 3591: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3592: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3593: my (%form);
1.10 albertel 3594: my @elements=('symb','courseid','domain','username');
3595: foreach my $element (@elements) {
1.186 albertel 3596: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3597: }
1.186 albertel 3598: if (defined($moreenv)) {
3599: %form=(%form,%{$moreenv});
3600: }
1.236 albertel 3601: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3602: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3603: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3604: $userview=~s/\<body[^\>]*\>//gi;
3605: $userview=~s/\<\/body\>//gi;
3606: $userview=~s/\<html\>//gi;
3607: $userview=~s/\<\/html\>//gi;
3608: $userview=~s/\<head\>//gi;
3609: $userview=~s/\<\/head\>//gi;
3610: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3611: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3612: if (wantarray) {
3613: return ($userview,$response);
3614: } else {
3615: return $userview;
3616: }
3617: }
3618:
3619: sub get_student_view_with_retries {
3620: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3621:
3622: my $ok = 0; # True if we got a good response.
3623: my $content;
3624: my $response;
3625:
3626: # Try to get the student_view done. within the retries count:
3627:
3628: do {
3629: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3630: $ok = $response->is_success;
3631: if (!$ok) {
3632: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3633: }
3634: $retries--;
3635: } while (!$ok && ($retries > 0));
3636:
3637: if (!$ok) {
3638: $content = ''; # On error return an empty content.
3639: }
1.651 www 3640: if (wantarray) {
3641: return ($content, $response);
3642: } else {
3643: return $content;
3644: }
1.11 albertel 3645: }
3646:
1.112 bowersj2 3647: =pod
3648:
1.648 raeburn 3649: =item * &get_student_answers()
1.112 bowersj2 3650:
3651: show a snapshot of how student was answering problem
3652:
3653: =cut
3654:
1.11 albertel 3655: sub get_student_answers {
1.100 sakharuk 3656: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3657: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3658: my (%moreenv);
1.11 albertel 3659: my @elements=('symb','courseid','domain','username');
3660: foreach my $element (@elements) {
1.186 albertel 3661: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3662: }
1.186 albertel 3663: $moreenv{'grade_target'}='answer';
3664: %moreenv=(%form,%moreenv);
1.497 raeburn 3665: $feedurl = &Apache::lonnet::clutter($feedurl);
3666: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3667: return $userview;
1.1 albertel 3668: }
1.116 albertel 3669:
3670: =pod
3671:
3672: =item * &submlink()
3673:
1.242 albertel 3674: Inputs: $text $uname $udom $symb $target
1.116 albertel 3675:
3676: Returns: A link to grades.pm such as to see the SUBM view of a student
3677:
3678: =cut
3679:
3680: ###############################################
3681: sub submlink {
1.242 albertel 3682: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3683: if (!($uname && $udom)) {
3684: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3685: &Apache::lonnet::whichuser($symb);
1.116 albertel 3686: if (!$symb) { $symb=$cursymb; }
3687: }
1.254 matthew 3688: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3689: $symb=&escape($symb);
1.242 albertel 3690: if ($target) { $target="target=\"$target\""; }
3691: return '<a href="/adm/grades?&command=submission&'.
3692: 'symb='.$symb.'&student='.$uname.
3693: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
3694: }
3695: ##############################################
3696:
3697: =pod
3698:
3699: =item * &pgrdlink()
3700:
3701: Inputs: $text $uname $udom $symb $target
3702:
3703: Returns: A link to grades.pm such as to see the PGRD view of a student
3704:
3705: =cut
3706:
3707: ###############################################
3708: sub pgrdlink {
3709: my $link=&submlink(@_);
3710: $link=~s/(&command=submission)/$1&showgrading=yes/;
3711: return $link;
3712: }
3713: ##############################################
3714:
3715: =pod
3716:
3717: =item * &pprmlink()
3718:
3719: Inputs: $text $uname $udom $symb $target
3720:
3721: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3722: student and a specific resource
1.242 albertel 3723:
3724: =cut
3725:
3726: ###############################################
3727: sub pprmlink {
3728: my ($text,$uname,$udom,$symb,$target)=@_;
3729: if (!($uname && $udom)) {
3730: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3731: &Apache::lonnet::whichuser($symb);
1.242 albertel 3732: if (!$symb) { $symb=$cursymb; }
3733: }
1.254 matthew 3734: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3735: $symb=&escape($symb);
1.242 albertel 3736: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3737: return '<a href="/adm/parmset?command=set&'.
3738: 'symb='.$symb.'&uname='.$uname.
3739: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3740: }
3741: ##############################################
1.37 matthew 3742:
1.112 bowersj2 3743: =pod
3744:
3745: =back
3746:
3747: =cut
3748:
1.37 matthew 3749: ###############################################
1.51 www 3750:
3751:
3752: sub timehash {
1.687 raeburn 3753: my ($thistime) = @_;
3754: my $timezone = &Apache::lonlocal::gettimezone();
3755: my $dt = DateTime->from_epoch(epoch => $thistime)
3756: ->set_time_zone($timezone);
3757: my $wday = $dt->day_of_week();
3758: if ($wday == 7) { $wday = 0; }
3759: return ( 'second' => $dt->second(),
3760: 'minute' => $dt->minute(),
3761: 'hour' => $dt->hour(),
3762: 'day' => $dt->day_of_month(),
3763: 'month' => $dt->month(),
3764: 'year' => $dt->year(),
3765: 'weekday' => $wday,
3766: 'dayyear' => $dt->day_of_year(),
3767: 'dlsav' => $dt->is_dst() );
1.51 www 3768: }
3769:
1.370 www 3770: sub utc_string {
3771: my ($date)=@_;
1.371 www 3772: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3773: }
3774:
1.51 www 3775: sub maketime {
3776: my %th=@_;
1.687 raeburn 3777: my ($epoch_time,$timezone,$dt);
3778: $timezone = &Apache::lonlocal::gettimezone();
3779: eval {
3780: $dt = DateTime->new( year => $th{'year'},
3781: month => $th{'month'},
3782: day => $th{'day'},
3783: hour => $th{'hour'},
3784: minute => $th{'minute'},
3785: second => $th{'second'},
3786: time_zone => $timezone,
3787: );
3788: };
3789: if (!$@) {
3790: $epoch_time = $dt->epoch;
3791: if ($epoch_time) {
3792: return $epoch_time;
3793: }
3794: }
1.51 www 3795: return POSIX::mktime(
3796: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3797: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3798: }
3799:
3800: #########################################
1.51 www 3801:
3802: sub findallcourses {
1.482 raeburn 3803: my ($roles,$uname,$udom) = @_;
1.355 albertel 3804: my %roles;
3805: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3806: my %courses;
1.51 www 3807: my $now=time;
1.482 raeburn 3808: if (!defined($uname)) {
3809: $uname = $env{'user.name'};
3810: }
3811: if (!defined($udom)) {
3812: $udom = $env{'user.domain'};
3813: }
3814: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
3815: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
3816: if (!%roles) {
3817: %roles = (
3818: cc => 1,
1.907 raeburn 3819: co => 1,
1.482 raeburn 3820: in => 1,
3821: ep => 1,
3822: ta => 1,
3823: cr => 1,
3824: st => 1,
3825: );
3826: }
3827: foreach my $entry (keys(%roleshash)) {
3828: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3829: if ($trole =~ /^cr/) {
3830: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3831: } else {
3832: next if (!exists($roles{$trole}));
3833: }
3834: if ($tend) {
3835: next if ($tend < $now);
3836: }
3837: if ($tstart) {
3838: next if ($tstart > $now);
3839: }
3840: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3841: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3842: if ($secpart eq '') {
3843: ($cnum,$role) = split(/_/,$cnumpart);
3844: $sec = 'none';
3845: $realsec = '';
3846: } else {
3847: $cnum = $cnumpart;
3848: ($sec,$role) = split(/_/,$secpart);
3849: $realsec = $sec;
1.490 raeburn 3850: }
1.482 raeburn 3851: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3852: }
3853: } else {
3854: foreach my $key (keys(%env)) {
1.483 albertel 3855: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3856: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3857: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3858: next if ($role eq 'ca' || $role eq 'aa');
3859: next if (%roles && !exists($roles{$role}));
3860: my ($starttime,$endtime)=split(/\./,$env{$key});
3861: my $active=1;
3862: if ($starttime) {
3863: if ($now<$starttime) { $active=0; }
3864: }
3865: if ($endtime) {
3866: if ($now>$endtime) { $active=0; }
3867: }
3868: if ($active) {
3869: if ($sec eq '') {
3870: $sec = 'none';
3871: }
3872: $courses{$cdom.'_'.$cnum}{$sec} =
3873: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 3874: }
3875: }
1.51 www 3876: }
3877: }
1.474 raeburn 3878: return %courses;
1.51 www 3879: }
1.37 matthew 3880:
1.54 www 3881: ###############################################
1.474 raeburn 3882:
3883: sub blockcheck {
1.482 raeburn 3884: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 3885:
3886: if (!defined($udom)) {
3887: $udom = $env{'user.domain'};
3888: }
3889: if (!defined($uname)) {
3890: $uname = $env{'user.name'};
3891: }
3892:
3893: # If uname and udom are for a course, check for blocks in the course.
3894:
3895: if (&Apache::lonnet::is_course($udom,$uname)) {
3896: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 3897: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 3898: return ($startblock,$endblock);
3899: }
1.474 raeburn 3900:
1.502 raeburn 3901: my $startblock = 0;
3902: my $endblock = 0;
1.482 raeburn 3903: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 3904:
1.490 raeburn 3905: # If uname is for a user, and activity is course-specific, i.e.,
3906: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3907:
1.490 raeburn 3908: if (($activity eq 'boards' || $activity eq 'chat' ||
3909: $activity eq 'groups') && ($env{'request.course.id'})) {
3910: foreach my $key (keys(%live_courses)) {
3911: if ($key ne $env{'request.course.id'}) {
3912: delete($live_courses{$key});
3913: }
3914: }
3915: }
3916:
3917: my $otheruser = 0;
3918: my %own_courses;
3919: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3920: # Resource belongs to user other than current user.
3921: $otheruser = 1;
3922: # Gather courses for current user
3923: %own_courses =
3924: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3925: }
3926:
3927: # Gather active course roles - course coordinator, instructor,
3928: # exam proctor, ta, student, or custom role.
1.474 raeburn 3929:
3930: foreach my $course (keys(%live_courses)) {
1.482 raeburn 3931: my ($cdom,$cnum);
3932: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3933: $cdom = $env{'course.'.$course.'.domain'};
3934: $cnum = $env{'course.'.$course.'.num'};
3935: } else {
1.490 raeburn 3936: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 3937: }
3938: my $no_ownblock = 0;
3939: my $no_userblock = 0;
1.533 raeburn 3940: if ($otheruser && $activity ne 'com') {
1.490 raeburn 3941: # Check if current user has 'evb' priv for this
3942: if (defined($own_courses{$course})) {
3943: foreach my $sec (keys(%{$own_courses{$course}})) {
3944: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3945: if ($sec ne 'none') {
3946: $checkrole .= '/'.$sec;
3947: }
3948: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3949: $no_ownblock = 1;
3950: last;
3951: }
3952: }
3953: }
3954: # if they have 'evb' priv and are currently not playing student
3955: next if (($no_ownblock) &&
3956: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
3957: }
1.474 raeburn 3958: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 3959: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 3960: if ($sec ne 'none') {
1.482 raeburn 3961: $checkrole .= '/'.$sec;
1.474 raeburn 3962: }
1.490 raeburn 3963: if ($otheruser) {
3964: # Resource belongs to user other than current user.
3965: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 3966: my ($trole,$tdom,$tnum,$tsec);
3967: my $entry = $live_courses{$course}{$sec};
3968: if ($entry =~ /^cr/) {
3969: ($trole,$tdom,$tnum,$tsec) =
3970: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
3971: } else {
3972: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
3973: }
3974: my ($spec,$area,$trest,%allroles,%userroles);
3975: $area = '/'.$tdom.'/'.$tnum;
3976: $trest = $tnum;
3977: if ($tsec ne '') {
3978: $area .= '/'.$tsec;
3979: $trest .= '/'.$tsec;
3980: }
3981: $spec = $trole.'.'.$area;
3982: if ($trole =~ /^cr/) {
3983: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
3984: $tdom,$spec,$trest,$area);
3985: } else {
3986: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
3987: $tdom,$spec,$trest,$area);
3988: }
3989: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 3990: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
3991: if ($1) {
3992: $no_userblock = 1;
3993: last;
3994: }
3995: }
1.490 raeburn 3996: } else {
3997: # Resource belongs to current user
3998: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 3999: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4000: $no_ownblock = 1;
4001: last;
4002: }
1.474 raeburn 4003: }
4004: }
4005: # if they have the evb priv and are currently not playing student
1.482 raeburn 4006: next if (($no_ownblock) &&
1.491 albertel 4007: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 4008: next if ($no_userblock);
1.474 raeburn 4009:
1.866 kalberla 4010: # Retrieve blocking times and identity of locker for course
1.490 raeburn 4011: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 4012:
4013: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
4014: if (($start != 0) &&
4015: (($startblock == 0) || ($startblock > $start))) {
4016: $startblock = $start;
4017: }
4018: if (($end != 0) &&
4019: (($endblock == 0) || ($endblock < $end))) {
4020: $endblock = $end;
4021: }
1.490 raeburn 4022: }
4023: return ($startblock,$endblock);
4024: }
4025:
4026: sub get_blocks {
4027: my ($setters,$activity,$cdom,$cnum) = @_;
4028: my $startblock = 0;
4029: my $endblock = 0;
4030: my $course = $cdom.'_'.$cnum;
4031: $setters->{$course} = {};
4032: $setters->{$course}{'staff'} = [];
4033: $setters->{$course}{'times'} = [];
4034: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
4035: foreach my $record (keys(%records)) {
4036: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
4037: if ($start <= time && $end >= time) {
4038: my ($staff_name,$staff_dom,$title,$blocks) =
4039: &parse_block_record($records{$record});
4040: if ($blocks->{$activity} eq 'on') {
4041: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
4042: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 4043: if ( ($startblock == 0) || ($startblock > $start) ) {
4044: $startblock = $start;
1.490 raeburn 4045: }
1.491 albertel 4046: if ( ($endblock == 0) || ($endblock < $end) ) {
4047: $endblock = $end;
1.474 raeburn 4048: }
4049: }
4050: }
4051: }
4052: return ($startblock,$endblock);
4053: }
4054:
4055: sub parse_block_record {
4056: my ($record) = @_;
4057: my ($setuname,$setudom,$title,$blocks);
4058: if (ref($record) eq 'HASH') {
4059: ($setuname,$setudom) = split(/:/,$record->{'setter'});
4060: $title = &unescape($record->{'event'});
4061: $blocks = $record->{'blocks'};
4062: } else {
4063: my @data = split(/:/,$record,3);
4064: if (scalar(@data) eq 2) {
4065: $title = $data[1];
4066: ($setuname,$setudom) = split(/@/,$data[0]);
4067: } else {
4068: ($setuname,$setudom,$title) = @data;
4069: }
4070: $blocks = { 'com' => 'on' };
4071: }
4072: return ($setuname,$setudom,$title,$blocks);
4073: }
4074:
1.854 kalberla 4075: sub blocking_status {
4076: my ($activity,$uname,$udom) = @_;
1.867 kalberla 4077: my %setters;
1.890 droeschl 4078:
4079: # check for active blocking
1.867 kalberla 4080: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
1.854 kalberla 4081:
1.890 droeschl 4082: my $blocked = $startblock && $endblock ? 1 : 0;
4083:
4084: # caller just wants to know whether a block is active
4085: if (!wantarray) { return $blocked; }
4086:
4087: # build a link to a popup window containing the details
4088: my $querystring = "?activity=$activity";
4089: # $uname and $udom decide whose portfolio the user is trying to look at
4090: $querystring .= "&udom=$udom" if $udom;
4091: $querystring .= "&uname=$uname" if $uname;
4092:
4093: my $output .= <<'END_MYBLOCK';
1.854 kalberla 4094: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
4095: var options = "width=" + w + ",height=" + h + ",";
4096: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
4097: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
4098: var newWin = window.open(url, wdwName, options);
4099: newWin.focus();
4100: }
1.890 droeschl 4101: END_MYBLOCK
1.854 kalberla 4102:
1.890 droeschl 4103: $output = Apache::lonhtmlcommon::scripttag($output);
4104:
1.854 kalberla 4105: my $popupUrl = "/adm/blockingstatus/$querystring";
1.890 droeschl 4106: my $text = mt('Communication Blocked');
4107:
1.867 kalberla 4108: $output .= <<"END_BLOCK";
4109: <div class='LC_comblock'>
1.869 kalberla 4110: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4111: title='$text'>
4112: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 4113: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4114: title='$text'>$text</a>
1.867 kalberla 4115: </div>
4116:
4117: END_BLOCK
1.474 raeburn 4118:
1.854 kalberla 4119: return ($blocked, $output);
4120: }
1.490 raeburn 4121:
1.60 matthew 4122: ###############################################
4123:
1.682 raeburn 4124: sub check_ip_acc {
4125: my ($acc)=@_;
4126: &Apache::lonxml::debug("acc is $acc");
4127: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
4128: return 1;
4129: }
4130: my $allowed=0;
4131: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
4132:
4133: my $name;
4134: foreach my $pattern (split(',',$acc)) {
4135: $pattern =~ s/^\s*//;
4136: $pattern =~ s/\s*$//;
4137: if ($pattern =~ /\*$/) {
4138: #35.8.*
4139: $pattern=~s/\*//;
4140: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4141: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
4142: #35.8.3.[34-56]
4143: my $low=$2;
4144: my $high=$3;
4145: $pattern=$1;
4146: if ($ip =~ /^\Q$pattern\E/) {
4147: my $last=(split(/\./,$ip))[3];
4148: if ($last <=$high && $last >=$low) { $allowed=1; }
4149: }
4150: } elsif ($pattern =~ /^\*/) {
4151: #*.msu.edu
4152: $pattern=~s/\*//;
4153: if (!defined($name)) {
4154: use Socket;
4155: my $netaddr=inet_aton($ip);
4156: ($name)=gethostbyaddr($netaddr,AF_INET);
4157: }
4158: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4159: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
4160: #127.0.0.1
4161: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4162: } else {
4163: #some.name.com
4164: if (!defined($name)) {
4165: use Socket;
4166: my $netaddr=inet_aton($ip);
4167: ($name)=gethostbyaddr($netaddr,AF_INET);
4168: }
4169: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4170: }
4171: if ($allowed) { last; }
4172: }
4173: return $allowed;
4174: }
4175:
4176: ###############################################
4177:
1.60 matthew 4178: =pod
4179:
1.112 bowersj2 4180: =head1 Domain Template Functions
4181:
4182: =over 4
4183:
4184: =item * &determinedomain()
1.60 matthew 4185:
4186: Inputs: $domain (usually will be undef)
4187:
1.63 www 4188: Returns: Determines which domain should be used for designs
1.60 matthew 4189:
4190: =cut
1.54 www 4191:
1.60 matthew 4192: ###############################################
1.63 www 4193: sub determinedomain {
4194: my $domain=shift;
1.531 albertel 4195: if (! $domain) {
1.60 matthew 4196: # Determine domain if we have not been given one
1.893 raeburn 4197: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 4198: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
4199: if ($env{'request.role.domain'}) {
4200: $domain=$env{'request.role.domain'};
1.60 matthew 4201: }
4202: }
1.63 www 4203: return $domain;
4204: }
4205: ###############################################
1.517 raeburn 4206:
1.518 albertel 4207: sub devalidate_domconfig_cache {
4208: my ($udom)=@_;
4209: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
4210: }
4211:
4212: # ---------------------- Get domain configuration for a domain
4213: sub get_domainconf {
4214: my ($udom) = @_;
4215: my $cachetime=1800;
4216: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
4217: if (defined($cached)) { return %{$result}; }
4218:
4219: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 4220: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 4221: my (%designhash,%legacy);
1.518 albertel 4222: if (keys(%domconfig) > 0) {
4223: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 4224: if (keys(%{$domconfig{'login'}})) {
4225: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 4226: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.946 raeburn 4227: if ($key eq 'loginvia') {
4228: if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') {
4229: my @ids = &Apache::lonnet::current_machine_ids();
4230: foreach my $hostname (@ids) {
1.948 raeburn 4231: if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') {
4232: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
4233: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
4234: $designhash{$udom.'.login.loginvia'} = $server;
4235: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
4236:
4237: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
4238: } else {
4239: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
4240: }
4241: if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) {
4242: $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'};
4243: }
1.946 raeburn 4244: }
4245: }
4246: }
4247: }
4248: } else {
4249: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
4250: $designhash{$udom.'.login.'.$key.'_'.$img} =
4251: $domconfig{'login'}{$key}{$img};
4252: }
1.699 raeburn 4253: }
4254: } else {
4255: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
4256: }
1.632 raeburn 4257: }
4258: } else {
4259: $legacy{'login'} = 1;
1.518 albertel 4260: }
1.632 raeburn 4261: } else {
4262: $legacy{'login'} = 1;
1.518 albertel 4263: }
4264: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 4265: if (keys(%{$domconfig{'rolecolors'}})) {
4266: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
4267: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
4268: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
4269: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
4270: }
1.518 albertel 4271: }
4272: }
1.632 raeburn 4273: } else {
4274: $legacy{'rolecolors'} = 1;
1.518 albertel 4275: }
1.632 raeburn 4276: } else {
4277: $legacy{'rolecolors'} = 1;
1.518 albertel 4278: }
1.948 raeburn 4279: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
4280: if ($domconfig{'autoenroll'}{'co-owners'}) {
4281: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
4282: }
4283: }
1.632 raeburn 4284: if (keys(%legacy) > 0) {
4285: my %legacyhash = &get_legacy_domconf($udom);
4286: foreach my $item (keys(%legacyhash)) {
4287: if ($item =~ /^\Q$udom\E\.login/) {
4288: if ($legacy{'login'}) {
4289: $designhash{$item} = $legacyhash{$item};
4290: }
4291: } else {
4292: if ($legacy{'rolecolors'}) {
4293: $designhash{$item} = $legacyhash{$item};
4294: }
1.518 albertel 4295: }
4296: }
4297: }
1.632 raeburn 4298: } else {
4299: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4300: }
4301: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4302: $cachetime);
4303: return %designhash;
4304: }
4305:
1.632 raeburn 4306: sub get_legacy_domconf {
4307: my ($udom) = @_;
4308: my %legacyhash;
4309: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4310: my $designfile = $designdir.'/'.$udom.'.tab';
4311: if (-e $designfile) {
4312: if ( open (my $fh,"<$designfile") ) {
4313: while (my $line = <$fh>) {
4314: next if ($line =~ /^\#/);
4315: chomp($line);
4316: my ($key,$val)=(split(/\=/,$line));
4317: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4318: }
4319: close($fh);
4320: }
4321: }
4322: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
4323: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4324: }
4325: return %legacyhash;
4326: }
4327:
1.63 www 4328: =pod
4329:
1.112 bowersj2 4330: =item * &domainlogo()
1.63 www 4331:
4332: Inputs: $domain (usually will be undef)
4333:
4334: Returns: A link to a domain logo, if the domain logo exists.
4335: If the domain logo does not exist, a description of the domain.
4336:
4337: =cut
1.112 bowersj2 4338:
1.63 www 4339: ###############################################
4340: sub domainlogo {
1.517 raeburn 4341: my $domain = &determinedomain(shift);
1.518 albertel 4342: my %designhash = &get_domainconf($domain);
1.517 raeburn 4343: # See if there is a logo
4344: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4345: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4346: if ($imgsrc =~ m{^/(adm|res)/}) {
4347: if ($imgsrc =~ m{^/res/}) {
4348: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4349: &Apache::lonnet::repcopy($local_name);
4350: }
4351: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4352: }
4353: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4354: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4355: return &Apache::lonnet::domain($domain,'description');
1.59 www 4356: } else {
1.60 matthew 4357: return '';
1.59 www 4358: }
4359: }
1.63 www 4360: ##############################################
4361:
4362: =pod
4363:
1.112 bowersj2 4364: =item * &designparm()
1.63 www 4365:
4366: Inputs: $which parameter; $domain (usually will be undef)
4367:
4368: Returns: value of designparamter $which
4369:
4370: =cut
1.112 bowersj2 4371:
1.397 albertel 4372:
1.400 albertel 4373: ##############################################
1.397 albertel 4374: sub designparm {
4375: my ($which,$domain)=@_;
4376: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 4377: return $env{'environment.color.'.$which};
1.96 www 4378: }
1.63 www 4379: $domain=&determinedomain($domain);
1.518 albertel 4380: my %domdesign = &get_domainconf($domain);
1.520 raeburn 4381: my $output;
1.517 raeburn 4382: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 4383: $output = $domdesign{$domain.'.'.$which};
1.63 www 4384: } else {
1.520 raeburn 4385: $output = $defaultdesign{$which};
4386: }
4387: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4388: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4389: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 4390: if ($output =~ m{^/res/}) {
4391: my $local_name = &Apache::lonnet::filelocation('',$output);
4392: &Apache::lonnet::repcopy($local_name);
4393: }
1.520 raeburn 4394: $output = &lonhttpdurl($output);
4395: }
1.63 www 4396: }
1.520 raeburn 4397: return $output;
1.63 www 4398: }
1.59 www 4399:
1.822 bisitz 4400: ##############################################
4401: =pod
4402:
1.832 bisitz 4403: =item * &authorspace()
4404:
4405: Inputs: ./.
4406:
4407: Returns: Path to the Construction Space of the current user's
4408: accessed author space
4409: The author space will be that of the current user
4410: when accessing the own author space
4411: and that of the co-author/assistent co-author
4412: when accessing the co-author's/assistent co-author's
4413: space
4414:
4415: =cut
4416:
4417: sub authorspace {
4418: my $caname = '';
4419: if ($env{'request.role'} =~ /^ca|^aa/) {
4420: (undef,$caname) =
4421: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
4422: } else {
4423: $caname = $env{'user.name'};
4424: }
4425: return '/priv/'.$caname.'/';
4426: }
4427:
4428: ##############################################
4429: =pod
4430:
1.822 bisitz 4431: =item * &head_subbox()
4432:
4433: Inputs: $content (contains HTML code with page functions, etc.)
4434:
4435: Returns: HTML div with $content
4436: To be included in page header
4437:
4438: =cut
4439:
4440: sub head_subbox {
4441: my ($content)=@_;
4442: my $output =
1.844 bisitz 4443: '<div id="LC_head_subbox">'
1.822 bisitz 4444: .$content
4445: .'</div>'
4446: }
4447:
4448: ##############################################
4449: =pod
4450:
4451: =item * &CSTR_pageheader()
4452:
4453: Inputs: ./.
4454:
4455: Returns: HTML div with CSTR path and recent box
4456: To be included on Construction Space pages
4457:
4458: =cut
4459:
4460: sub CSTR_pageheader {
4461: # this is for resources; directories have customtitle, and crumbs
4462: # and select recent are created in lonpubdir.pm
4463: my ($uname,$thisdisfn)=
4464: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
4465: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4466: $formaction=~s/\/+/\//g;
4467:
4468: my $parentpath = '';
4469: my $lastitem = '';
4470: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4471: $parentpath = $1;
4472: $lastitem = $2;
4473: } else {
4474: $lastitem = $thisdisfn;
4475: }
1.921 bisitz 4476:
4477: my $output =
1.822 bisitz 4478: '<div>'
4479: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
4480: .'<b>'.&mt('Construction Space:').'</b> '
4481: .'<form name="dirs" method="post" action="'.$formaction
1.921 bisitz 4482: .'" target="_top">' #FIXME lonpubdir: target="_parent"
4483: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv',undef,undef);
4484:
4485: if ($lastitem) {
4486: $output .=
4487: '<span class="LC_filename">'
4488: .$lastitem
4489: .'</span>';
4490: }
4491: $output .=
4492: '<br />'
1.822 bisitz 4493: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
4494: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4495: .'</form>'
4496: .&Apache::lonmenu::constspaceform()
4497: .'</div>';
1.921 bisitz 4498:
4499: return $output;
1.822 bisitz 4500: }
4501:
1.60 matthew 4502: ###############################################
4503: ###############################################
4504:
4505: =pod
4506:
1.112 bowersj2 4507: =back
4508:
1.549 albertel 4509: =head1 HTML Helpers
1.112 bowersj2 4510:
4511: =over 4
4512:
4513: =item * &bodytag()
1.60 matthew 4514:
4515: Returns a uniform header for LON-CAPA web pages.
4516:
4517: Inputs:
4518:
1.112 bowersj2 4519: =over 4
4520:
4521: =item * $title, A title to be displayed on the page.
4522:
4523: =item * $function, the current role (can be undef).
4524:
4525: =item * $addentries, extra parameters for the <body> tag.
4526:
4527: =item * $bodyonly, if defined, only return the <body> tag.
4528:
4529: =item * $domain, if defined, force a given domain.
4530:
4531: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4532: text interface only)
1.60 matthew 4533:
1.814 bisitz 4534: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
4535: navigational links
1.317 albertel 4536:
1.338 albertel 4537: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4538:
1.953 ! droeschl 4539: #SD
1.949 droeschl 4540: #RC =item * $no_inline_link, if true and in remote mode, don't show the
4541: #RC 'Switch To Inline Menu' link
4542: #RC
1.460 albertel 4543: =item * $args, optional argument valid values are
4544: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4545: inherit_jsmath -> when creating popup window in a page,
4546: should it have jsmath forced on by the
4547: current page
1.460 albertel 4548:
1.112 bowersj2 4549: =back
4550:
1.60 matthew 4551: Returns: A uniform header for LON-CAPA web pages.
4552: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4553: If $bodyonly is undef or zero, an html string containing a <body> tag and
4554: other decorations will be returned.
4555:
4556: =cut
4557:
1.54 www 4558: sub bodytag {
1.831 bisitz 4559: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.816 bisitz 4560: $no_nav_bar,$bgcolor,$no_inline_link,$args)=@_;
1.339 albertel 4561:
1.460 albertel 4562: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4563:
1.183 matthew 4564: $function = &get_users_function() if (!$function);
1.339 albertel 4565: my $img = &designparm($function.'.img',$domain);
4566: my $font = &designparm($function.'.font',$domain);
4567: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4568:
1.803 bisitz 4569: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 4570: 'bgcolor' => $pgbg,
1.339 albertel 4571: 'text' => $font,
4572: 'alink' => &designparm($function.'.alink',$domain),
4573: 'vlink' => &designparm($function.'.vlink',$domain),
4574: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4575: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4576:
1.63 www 4577: # role and realm
1.378 raeburn 4578: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4579: if ($role eq 'ca') {
1.479 albertel 4580: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4581: $realm = &plainname($rname,$rdom);
1.378 raeburn 4582: }
1.55 www 4583: # realm
1.258 albertel 4584: if ($env{'request.course.id'}) {
1.378 raeburn 4585: if ($env{'request.role'} !~ /^cr/) {
4586: $role = &Apache::lonnet::plaintext($role,&course_type());
4587: }
1.898 raeburn 4588: if ($env{'request.course.sec'}) {
4589: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
4590: }
1.359 albertel 4591: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4592: } else {
4593: $role = &Apache::lonnet::plaintext($role);
1.54 www 4594: }
1.433 albertel 4595:
1.359 albertel 4596: if (!$realm) { $realm=' '; }
1.55 www 4597: # Set messages
1.60 matthew 4598: my $messages=&domainlogo($domain);
1.330 albertel 4599:
1.438 albertel 4600: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4601:
1.101 www 4602: # construct main body tag
1.359 albertel 4603: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4604: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4605:
1.530 albertel 4606: if ($bodyonly) {
1.60 matthew 4607: return $bodytag;
1.798 tempelho 4608: }
1.359 albertel 4609:
1.410 albertel 4610: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433 albertel 4611: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4612: undef($role);
1.434 albertel 4613: } else {
4614: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4615: }
1.359 albertel 4616:
1.762 bisitz 4617: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 4618: #
4619: # Extra info if you are the DC
4620: my $dc_info = '';
4621: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4622: $env{'course.'.$env{'request.course.id'}.
4623: '.domain'}.'/'})) {
4624: my $cid = $env{'request.course.id'};
1.917 raeburn 4625: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4626: $dc_info =~ s/\s+$//;
1.359 albertel 4627: }
4628:
1.898 raeburn 4629: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853 droeschl 4630: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
4631:
1.359 albertel 4632: # No Remote
1.916 droeschl 4633: if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') {
4634: return $bodytag;
4635: }
1.903 droeschl 4636:
4637: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
4638:
4639: # if ($env{'request.state'} eq 'construct') {
4640: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
4641: # }
4642:
1.359 albertel 4643:
4644:
1.916 droeschl 4645: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917 raeburn 4646: if ($dc_info) {
4647: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
4648: }
1.916 droeschl 4649: $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
4650: <em>$realm</em> $dc_info</div>|;
1.903 droeschl 4651: return $bodytag;
4652: }
1.894 droeschl 4653:
1.927 raeburn 4654: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
4655: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
4656: }
1.916 droeschl 4657:
1.903 droeschl 4658: $bodytag .= Apache::lonhtmlcommon::scripttag(
4659: Apache::lonmenu::utilityfunctions(), 'start');
1.816 bisitz 4660:
1.903 droeschl 4661: $bodytag .= Apache::lonmenu::primary_menu();
1.852 droeschl 4662:
1.917 raeburn 4663: if ($dc_info) {
4664: $dc_info = &dc_courseid_toggle($dc_info);
4665: }
4666: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 4667:
1.903 droeschl 4668: #don't show menus for public users
4669: if($env{'user.name'} ne 'public' && $env{'user.domain'} ne 'public'){
4670: $bodytag .= Apache::lonmenu::secondary_menu();
4671: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 4672: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
4673: if ($env{'request.state'} eq 'construct') {
4674: $bodytag .= &Apache::lonmenu::innerregister($forcereg,'',
4675: $args->{'bread_crumbs'});
4676: } elsif ($forcereg) {
4677: $bodytag .= &Apache::lonmenu::innerregister($forcereg);
4678: }
1.903 droeschl 4679: }else{
4680: # this is to seperate menu from content when there's no secondary
4681: # menu. Especially needed for public accessible ressources.
4682: $bodytag .= '<hr style="clear:both" />';
4683: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 4684: }
1.903 droeschl 4685:
1.235 raeburn 4686: return $bodytag;
1.182 matthew 4687: }
4688:
1.917 raeburn 4689: sub dc_courseid_toggle {
4690: my ($dc_info) = @_;
4691: return ' <span id="dccidtext" class="LC_cusr_subheading">'.
4692: '<a href="javascript:showCourseID();">'.
4693: &mt('(More ...)').'</a></span>'.
4694: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
4695: }
4696:
1.330 albertel 4697: sub make_attr_string {
4698: my ($register,$attr_ref) = @_;
4699:
4700: if ($attr_ref && !ref($attr_ref)) {
4701: die("addentries Must be a hash ref ".
4702: join(':',caller(1))." ".
4703: join(':',caller(0))." ");
4704: }
4705:
4706: if ($register) {
1.339 albertel 4707: my ($on_load,$on_unload);
4708: foreach my $key (keys(%{$attr_ref})) {
4709: if (lc($key) eq 'onload') {
4710: $on_load.=$attr_ref->{$key}.';';
4711: delete($attr_ref->{$key});
4712:
4713: } elsif (lc($key) eq 'onunload') {
4714: $on_unload.=$attr_ref->{$key}.';';
4715: delete($attr_ref->{$key});
4716: }
4717: }
1.953 ! droeschl 4718: $attr_ref->{'onload'} = $on_load;
! 4719: $attr_ref->{'onunload'}= $on_unload;
1.330 albertel 4720: }
1.339 albertel 4721:
1.330 albertel 4722: my $attr_string;
4723: foreach my $attr (keys(%$attr_ref)) {
4724: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4725: }
4726: return $attr_string;
4727: }
4728:
4729:
1.182 matthew 4730: ###############################################
1.251 albertel 4731: ###############################################
4732:
4733: =pod
4734:
4735: =item * &endbodytag()
4736:
4737: Returns a uniform footer for LON-CAPA web pages.
4738:
1.635 raeburn 4739: Inputs: 1 - optional reference to an args hash
4740: If in the hash, key for noredirectlink has a value which evaluates to true,
4741: a 'Continue' link is not displayed if the page contains an
4742: internal redirect in the <head></head> section,
4743: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4744:
4745: =cut
4746:
4747: sub endbodytag {
1.635 raeburn 4748: my ($args) = @_;
1.251 albertel 4749: my $endbodytag='</body>';
1.269 albertel 4750: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4751: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4752: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4753: $endbodytag=
4754: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4755: &mt('Continue').'</a>'.
4756: $endbodytag;
4757: }
1.315 albertel 4758: }
1.251 albertel 4759: return $endbodytag;
4760: }
4761:
1.352 albertel 4762: =pod
4763:
4764: =item * &standard_css()
4765:
4766: Returns a style sheet
4767:
4768: Inputs: (all optional)
4769: domain -> force to color decorate a page for a specific
4770: domain
4771: function -> force usage of a specific rolish color scheme
4772: bgcolor -> override the default page bgcolor
4773:
4774: =cut
4775:
1.343 albertel 4776: sub standard_css {
1.345 albertel 4777: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4778: $function = &get_users_function() if (!$function);
4779: my $img = &designparm($function.'.img', $domain);
4780: my $tabbg = &designparm($function.'.tabbg', $domain);
4781: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 4782: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 4783: #second colour for later usage
1.345 albertel 4784: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4785: my $pgbg_or_bgcolor =
4786: $bgcolor ||
1.352 albertel 4787: &designparm($function.'.pgbg', $domain);
1.382 albertel 4788: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4789: my $alink = &designparm($function.'.alink', $domain);
4790: my $vlink = &designparm($function.'.vlink', $domain);
4791: my $link = &designparm($function.'.link', $domain);
4792:
1.704 muellerd 4793: my $loginbg = &designparm('login.sidebg',$domain);
1.712 muellerd 4794: my $bgcol = &designparm('login.bgcol',$domain);
4795: my $textcol = &designparm('login.textcol',$domain);
1.704 muellerd 4796:
1.602 albertel 4797: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4798: my $mono = 'monospace';
1.850 bisitz 4799: my $data_table_head = $sidebg;
4800: my $data_table_light = '#FAFAFA';
4801: my $data_table_dark = '#F0F0F0';
1.470 banghart 4802: my $data_table_darker = '#CCCCCC';
1.349 albertel 4803: my $data_table_highlight = '#FFFF00';
1.352 albertel 4804: my $mail_new = '#FFBB77';
4805: my $mail_new_hover = '#DD9955';
4806: my $mail_read = '#BBBB77';
4807: my $mail_read_hover = '#999944';
4808: my $mail_replied = '#AAAA88';
4809: my $mail_replied_hover = '#888855';
4810: my $mail_other = '#99BBBB';
4811: my $mail_other_hover = '#669999';
1.391 albertel 4812: my $table_header = '#DDDDDD';
1.489 raeburn 4813: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 4814: my $lg_border_color = '#C8C8C8';
1.952 onken 4815: my $button_hover = '#BF2317';
1.392 albertel 4816:
1.608 albertel 4817: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 4818: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
4819: : '0 3px 0 4px';
1.448 albertel 4820:
1.523 albertel 4821:
1.343 albertel 4822: return <<END;
1.947 droeschl 4823:
4824: /* needed for iframe to allow 100% height in FF */
4825: body, html {
4826: margin: 0;
4827: padding: 0 0.5%;
4828: height: 99%; /* to avoid scrollbars */
4829: }
4830:
1.795 www 4831: body {
1.911 bisitz 4832: font-family: $sans;
4833: line-height:130%;
4834: font-size:0.83em;
4835: color:$font;
1.795 www 4836: }
4837:
1.911 bisitz 4838: a:focus {
1.795 www 4839: color: red;
1.911 bisitz 4840: background: yellow;
1.795 www 4841: }
1.698 harmsja 4842:
1.911 bisitz 4843: form, .inline {
4844: display: inline;
1.795 www 4845: }
1.721 harmsja 4846:
1.795 www 4847: .LC_right {
1.911 bisitz 4848: text-align:right;
1.795 www 4849: }
4850:
4851: .LC_middle {
1.911 bisitz 4852: vertical-align:middle;
1.795 www 4853: }
1.721 harmsja 4854:
1.911 bisitz 4855: .LC_400Box {
4856: width:400px;
4857: }
1.721 harmsja 4858:
1.947 droeschl 4859: .LC_iframecontainer {
4860: width: 98%;
4861: margin: 0;
4862: position: fixed;
4863: top: 8.5em;
4864: bottom: 0;
4865: }
4866:
4867: .LC_iframecontainer iframe{
4868: border: none;
4869: width: 100%;
4870: height: 100%;
4871: }
4872:
1.778 bisitz 4873: .LC_filename {
4874: font-family: $mono;
4875: white-space:pre;
1.921 bisitz 4876: font-size: 120%;
1.778 bisitz 4877: }
4878:
4879: .LC_fileicon {
4880: border: none;
4881: height: 1.3em;
4882: vertical-align: text-bottom;
4883: margin-right: 0.3em;
4884: text-decoration:none;
4885: }
4886:
1.350 albertel 4887: .LC_error {
4888: color: red;
4889: font-size: larger;
4890: }
1.795 www 4891:
1.457 albertel 4892: .LC_warning,
4893: .LC_diff_removed {
1.733 bisitz 4894: color: red;
1.394 albertel 4895: }
1.532 albertel 4896:
4897: .LC_info,
1.457 albertel 4898: .LC_success,
4899: .LC_diff_added {
1.350 albertel 4900: color: green;
4901: }
1.795 www 4902:
1.802 bisitz 4903: div.LC_confirm_box {
4904: background-color: #FAFAFA;
4905: border: 1px solid $lg_border_color;
4906: margin-right: 0;
4907: padding: 5px;
4908: }
4909:
4910: div.LC_confirm_box .LC_error img,
4911: div.LC_confirm_box .LC_success img {
4912: vertical-align: middle;
4913: }
4914:
1.440 albertel 4915: .LC_icon {
1.771 droeschl 4916: border: none;
1.790 droeschl 4917: vertical-align: middle;
1.771 droeschl 4918: }
4919:
1.543 albertel 4920: .LC_docs_spacer {
4921: width: 25px;
4922: height: 1px;
1.771 droeschl 4923: border: none;
1.543 albertel 4924: }
1.346 albertel 4925:
1.532 albertel 4926: .LC_internal_info {
1.735 bisitz 4927: color: #999999;
1.532 albertel 4928: }
4929:
1.794 www 4930: .LC_discussion {
1.911 bisitz 4931: background: $tabbg;
4932: border: 1px solid black;
4933: margin: 2px;
1.794 www 4934: }
4935:
4936: .LC_disc_action_links_bar {
1.911 bisitz 4937: background: $tabbg;
4938: border: none;
4939: margin: 4px;
1.794 www 4940: }
4941:
4942: .LC_disc_action_left {
1.911 bisitz 4943: text-align: left;
1.794 www 4944: }
4945:
4946: .LC_disc_action_right {
1.911 bisitz 4947: text-align: right;
1.794 www 4948: }
4949:
4950: .LC_disc_new_item {
1.911 bisitz 4951: background: white;
4952: border: 2px solid red;
4953: margin: 2px;
1.794 www 4954: }
4955:
4956: .LC_disc_old_item {
1.911 bisitz 4957: background: white;
4958: border: 1px solid black;
4959: margin: 2px;
1.794 www 4960: }
4961:
1.458 albertel 4962: table.LC_pastsubmission {
4963: border: 1px solid black;
4964: margin: 2px;
4965: }
4966:
1.924 bisitz 4967: table#LC_menubuttons {
1.345 albertel 4968: width: 100%;
4969: background: $pgbg;
1.392 albertel 4970: border: 2px;
1.402 albertel 4971: border-collapse: separate;
1.803 bisitz 4972: padding: 0;
1.345 albertel 4973: }
1.392 albertel 4974:
1.801 tempelho 4975: table#LC_title_bar a {
4976: color: $fontmenu;
4977: }
1.836 bisitz 4978:
1.807 droeschl 4979: table#LC_title_bar {
1.819 tempelho 4980: clear: both;
1.836 bisitz 4981: display: none;
1.807 droeschl 4982: }
4983:
1.795 www 4984: table#LC_title_bar,
1.933 droeschl 4985: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 4986: table#LC_title_bar.LC_with_remote {
1.359 albertel 4987: width: 100%;
1.392 albertel 4988: border-color: $pgbg;
4989: border-style: solid;
4990: border-width: $border;
1.379 albertel 4991: background: $pgbg;
1.801 tempelho 4992: color: $fontmenu;
1.392 albertel 4993: border-collapse: collapse;
1.803 bisitz 4994: padding: 0;
1.819 tempelho 4995: margin: 0;
1.359 albertel 4996: }
1.795 www 4997:
1.933 droeschl 4998: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 4999: margin: 0;
5000: padding: 0;
1.933 droeschl 5001: position: relative;
5002: list-style: none;
1.913 droeschl 5003: }
1.933 droeschl 5004: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 5005: display: inline;
5006: }
1.933 droeschl 5007:
5008: .LC_breadcrumb_tools_navigation {
1.913 droeschl 5009: padding: 0;
1.933 droeschl 5010: margin: 0;
5011: float: left;
1.913 droeschl 5012: }
1.933 droeschl 5013: .LC_breadcrumb_tools_tools {
5014: padding: 0;
5015: margin: 0;
1.913 droeschl 5016: float: right;
5017: }
5018:
1.359 albertel 5019: table#LC_title_bar td {
5020: background: $tabbg;
5021: }
1.795 www 5022:
1.911 bisitz 5023: table#LC_menubuttons img {
1.803 bisitz 5024: border: none;
1.346 albertel 5025: }
1.795 www 5026:
1.842 droeschl 5027: .LC_breadcrumbs_component {
1.911 bisitz 5028: float: right;
5029: margin: 0 1em;
1.357 albertel 5030: }
1.842 droeschl 5031: .LC_breadcrumbs_component img {
1.911 bisitz 5032: vertical-align: middle;
1.777 tempelho 5033: }
1.795 www 5034:
1.383 albertel 5035: td.LC_table_cell_checkbox {
5036: text-align: center;
5037: }
1.795 www 5038:
5039: .LC_fontsize_small {
1.911 bisitz 5040: font-size: 70%;
1.705 tempelho 5041: }
5042:
1.844 bisitz 5043: #LC_breadcrumbs {
1.911 bisitz 5044: clear:both;
5045: background: $sidebg;
5046: border-bottom: 1px solid $lg_border_color;
5047: line-height: 2.5em;
1.933 droeschl 5048: overflow: hidden;
1.911 bisitz 5049: margin: 0;
5050: padding: 0;
1.819 tempelho 5051: }
1.862 bisitz 5052:
1.844 bisitz 5053: #LC_head_subbox {
1.911 bisitz 5054: clear:both;
5055: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 5056: border: 1px solid $sidebg;
5057: margin: 0 0 10px 0;
1.822 bisitz 5058: }
5059:
1.795 www 5060: .LC_fontsize_medium {
1.911 bisitz 5061: font-size: 85%;
1.705 tempelho 5062: }
5063:
1.795 www 5064: .LC_fontsize_large {
1.911 bisitz 5065: font-size: 120%;
1.705 tempelho 5066: }
5067:
1.346 albertel 5068: .LC_menubuttons_inline_text {
5069: color: $font;
1.698 harmsja 5070: font-size: 90%;
1.701 harmsja 5071: padding-left:3px;
1.346 albertel 5072: }
5073:
1.934 droeschl 5074: .LC_menubuttons_inline_text img{
5075: vertical-align: middle;
5076: }
5077:
1.951 onken 5078: li.LC_menubuttons_inline_text img,a {
5079: cursor:pointer;
5080: }
5081:
1.526 www 5082: .LC_menubuttons_link {
5083: text-decoration: none;
5084: }
1.795 www 5085:
1.522 albertel 5086: .LC_menubuttons_category {
1.521 www 5087: color: $font;
1.526 www 5088: background: $pgbg;
1.521 www 5089: font-size: larger;
5090: font-weight: bold;
5091: }
5092:
1.346 albertel 5093: td.LC_menubuttons_text {
1.911 bisitz 5094: color: $font;
1.346 albertel 5095: }
1.706 harmsja 5096:
1.346 albertel 5097: .LC_current_location {
5098: background: $tabbg;
5099: }
1.795 www 5100:
1.938 bisitz 5101: table.LC_data_table {
1.347 albertel 5102: border: 1px solid #000000;
1.402 albertel 5103: border-collapse: separate;
1.426 albertel 5104: border-spacing: 1px;
1.610 albertel 5105: background: $pgbg;
1.347 albertel 5106: }
1.795 www 5107:
1.422 albertel 5108: .LC_data_table_dense {
5109: font-size: small;
5110: }
1.795 www 5111:
1.507 raeburn 5112: table.LC_nested_outer {
5113: border: 1px solid #000000;
1.589 raeburn 5114: border-collapse: collapse;
1.803 bisitz 5115: border-spacing: 0;
1.507 raeburn 5116: width: 100%;
5117: }
1.795 www 5118:
1.879 raeburn 5119: table.LC_innerpickbox,
1.507 raeburn 5120: table.LC_nested {
1.803 bisitz 5121: border: none;
1.589 raeburn 5122: border-collapse: collapse;
1.803 bisitz 5123: border-spacing: 0;
1.507 raeburn 5124: width: 100%;
5125: }
1.795 www 5126:
1.930 faziophi 5127: .ui-accordion,
5128: .ui-accordion table.LC_data_table,
5129: .ui-accordion table.LC_nested_outer{
5130: border: 0px;
5131: border-spacing: 0px;
5132: margin: 3px;
5133: }
5134:
1.911 bisitz 5135: table.LC_data_table tr th,
5136: table.LC_calendar tr th,
1.879 raeburn 5137: table.LC_prior_tries tr th,
5138: table.LC_innerpickbox tr th {
1.349 albertel 5139: font-weight: bold;
5140: background-color: $data_table_head;
1.801 tempelho 5141: color:$fontmenu;
1.701 harmsja 5142: font-size:90%;
1.347 albertel 5143: }
1.795 www 5144:
1.879 raeburn 5145: table.LC_innerpickbox tr th,
5146: table.LC_innerpickbox tr td {
5147: vertical-align: top;
5148: }
5149:
1.711 raeburn 5150: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 5151: background-color: #CCCCCC;
1.711 raeburn 5152: font-weight: bold;
5153: text-align: left;
5154: }
1.795 www 5155:
1.912 bisitz 5156: table.LC_data_table tr.LC_odd_row > td {
5157: background-color: $data_table_light;
5158: padding: 2px;
5159: vertical-align: top;
5160: }
5161:
1.809 bisitz 5162: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 5163: background-color: $data_table_light;
1.912 bisitz 5164: vertical-align: top;
5165: }
5166:
5167: table.LC_data_table tr.LC_even_row > td {
5168: background-color: $data_table_dark;
1.425 albertel 5169: padding: 2px;
1.900 bisitz 5170: vertical-align: top;
1.347 albertel 5171: }
1.795 www 5172:
1.809 bisitz 5173: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 5174: background-color: $data_table_dark;
1.900 bisitz 5175: vertical-align: top;
1.347 albertel 5176: }
1.795 www 5177:
1.425 albertel 5178: table.LC_data_table tr.LC_data_table_highlight td {
5179: background-color: $data_table_darker;
5180: }
1.795 www 5181:
1.639 raeburn 5182: table.LC_data_table tr td.LC_leftcol_header {
5183: background-color: $data_table_head;
5184: font-weight: bold;
5185: }
1.795 www 5186:
1.451 albertel 5187: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5188: table.LC_nested tr.LC_empty_row td {
1.421 albertel 5189: font-weight: bold;
5190: font-style: italic;
5191: text-align: center;
5192: padding: 8px;
1.347 albertel 5193: }
1.795 www 5194:
1.940 bisitz 5195: table.LC_data_table tr.LC_empty_row td {
5196: background-color: $sidebg;
5197: }
5198:
5199: table.LC_nested tr.LC_empty_row td {
5200: background-color: #FFFFFF;
5201: }
5202:
1.890 droeschl 5203: table.LC_caption {
5204: }
5205:
1.507 raeburn 5206: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5207: padding: 4ex
5208: }
1.795 www 5209:
1.507 raeburn 5210: table.LC_nested_outer tr th {
5211: font-weight: bold;
1.801 tempelho 5212: color:$fontmenu;
1.507 raeburn 5213: background-color: $data_table_head;
1.701 harmsja 5214: font-size: small;
1.507 raeburn 5215: border-bottom: 1px solid #000000;
5216: }
1.795 www 5217:
1.507 raeburn 5218: table.LC_nested_outer tr td.LC_subheader {
5219: background-color: $data_table_head;
5220: font-weight: bold;
5221: font-size: small;
5222: border-bottom: 1px solid #000000;
5223: text-align: right;
1.451 albertel 5224: }
1.795 www 5225:
1.507 raeburn 5226: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5227: background-color: #CCCCCC;
1.451 albertel 5228: font-weight: bold;
5229: font-size: small;
1.507 raeburn 5230: text-align: center;
5231: }
1.795 www 5232:
1.589 raeburn 5233: table.LC_nested tr.LC_info_row td.LC_left_item,
5234: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5235: text-align: left;
1.451 albertel 5236: }
1.795 www 5237:
1.507 raeburn 5238: table.LC_nested td {
1.735 bisitz 5239: background-color: #FFFFFF;
1.451 albertel 5240: font-size: small;
1.507 raeburn 5241: }
1.795 www 5242:
1.507 raeburn 5243: table.LC_nested_outer tr th.LC_right_item,
5244: table.LC_nested tr.LC_info_row td.LC_right_item,
5245: table.LC_nested tr.LC_odd_row td.LC_right_item,
5246: table.LC_nested tr td.LC_right_item {
1.451 albertel 5247: text-align: right;
5248: }
5249:
1.930 faziophi 5250: .ui-accordion table.LC_nested tr.LC_odd_row td.LC_left_item,
5251: .ui-accordion table.LC_nested tr.LC_even_row td.LC_left_item {
5252: text-align: right;
5253: width: 40%;
5254: padding-right:10px;
5255: vertical-align: top;
5256: padding: 5px;
5257: }
5258:
5259: .ui-accordion table.LC_nested tr.LC_odd_row td.LC_right_item,
5260: .ui-accordion table.LC_nested tr.LC_even_row td.LC_right_item {
5261: text-align: left;
5262: width: 60%;
5263: padding: 2px 4px;
5264: }
5265:
1.507 raeburn 5266: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5267: background-color: #EEEEEE;
1.451 albertel 5268: }
5269:
1.473 raeburn 5270: table.LC_createuser {
5271: }
5272:
5273: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5274: font-size: small;
1.473 raeburn 5275: }
5276:
5277: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5278: background-color: #CCCCCC;
1.473 raeburn 5279: font-weight: bold;
5280: text-align: center;
5281: }
5282:
1.349 albertel 5283: table.LC_calendar {
5284: border: 1px solid #000000;
5285: border-collapse: collapse;
1.917 raeburn 5286: width: 98%;
1.349 albertel 5287: }
1.795 www 5288:
1.349 albertel 5289: table.LC_calendar_pickdate {
5290: font-size: xx-small;
5291: }
1.795 www 5292:
1.349 albertel 5293: table.LC_calendar tr td {
5294: border: 1px solid #000000;
5295: vertical-align: top;
1.917 raeburn 5296: width: 14%;
1.349 albertel 5297: }
1.795 www 5298:
1.349 albertel 5299: table.LC_calendar tr td.LC_calendar_day_empty {
5300: background-color: $data_table_dark;
5301: }
1.795 www 5302:
1.779 bisitz 5303: table.LC_calendar tr td.LC_calendar_day_current {
5304: background-color: $data_table_highlight;
1.777 tempelho 5305: }
1.795 www 5306:
1.938 bisitz 5307: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 5308: background-color: $mail_new;
5309: }
1.795 www 5310:
1.938 bisitz 5311: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 5312: background-color: $mail_new_hover;
5313: }
1.795 www 5314:
1.938 bisitz 5315: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 5316: background-color: $mail_read;
5317: }
1.795 www 5318:
1.938 bisitz 5319: /*
5320: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 5321: background-color: $mail_read_hover;
5322: }
1.938 bisitz 5323: */
1.795 www 5324:
1.938 bisitz 5325: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 5326: background-color: $mail_replied;
5327: }
1.795 www 5328:
1.938 bisitz 5329: /*
5330: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 5331: background-color: $mail_replied_hover;
5332: }
1.938 bisitz 5333: */
1.795 www 5334:
1.938 bisitz 5335: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 5336: background-color: $mail_other;
5337: }
1.795 www 5338:
1.938 bisitz 5339: /*
5340: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 5341: background-color: $mail_other_hover;
5342: }
1.938 bisitz 5343: */
1.494 raeburn 5344:
1.777 tempelho 5345: table.LC_data_table tr > td.LC_browser_file,
5346: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 5347: background: #AAEE77;
1.389 albertel 5348: }
1.795 www 5349:
1.777 tempelho 5350: table.LC_data_table tr > td.LC_browser_file_locked,
5351: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5352: background: #FFAA99;
1.387 albertel 5353: }
1.795 www 5354:
1.777 tempelho 5355: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 5356: background: #888888;
1.779 bisitz 5357: }
1.795 www 5358:
1.777 tempelho 5359: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5360: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 5361: background: #F8F866;
1.777 tempelho 5362: }
1.795 www 5363:
1.696 bisitz 5364: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 5365: background: #E0E8FF;
1.387 albertel 5366: }
1.696 bisitz 5367:
1.707 bisitz 5368: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 5369: /* background: #77FF77; */
1.707 bisitz 5370: }
1.795 www 5371:
1.707 bisitz 5372: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 5373: border-right: 8px solid #FFFF77;
1.707 bisitz 5374: }
1.795 www 5375:
1.707 bisitz 5376: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 5377: border-right: 8px solid #FFAA77;
1.707 bisitz 5378: }
1.795 www 5379:
1.707 bisitz 5380: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 5381: border-right: 8px solid #FF7777;
1.707 bisitz 5382: }
1.795 www 5383:
1.707 bisitz 5384: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 5385: border-right: 8px solid #AAFF77;
1.707 bisitz 5386: }
1.795 www 5387:
1.707 bisitz 5388: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 5389: border-right: 8px solid #11CC55;
1.707 bisitz 5390: }
5391:
1.388 albertel 5392: span.LC_current_location {
1.701 harmsja 5393: font-size:larger;
1.388 albertel 5394: background: $pgbg;
5395: }
1.387 albertel 5396:
1.395 albertel 5397: span.LC_parm_menu_item {
5398: font-size: larger;
5399: }
1.795 www 5400:
1.395 albertel 5401: span.LC_parm_scope_all {
5402: color: red;
5403: }
1.795 www 5404:
1.395 albertel 5405: span.LC_parm_scope_folder {
5406: color: green;
5407: }
1.795 www 5408:
1.395 albertel 5409: span.LC_parm_scope_resource {
5410: color: orange;
5411: }
1.795 www 5412:
1.395 albertel 5413: span.LC_parm_part {
5414: color: blue;
5415: }
1.795 www 5416:
1.911 bisitz 5417: span.LC_parm_folder,
5418: span.LC_parm_symb {
1.395 albertel 5419: font-size: x-small;
5420: font-family: $mono;
5421: color: #AAAAAA;
5422: }
5423:
1.795 www 5424: td.LC_parm_overview_level_menu,
5425: td.LC_parm_overview_map_menu,
5426: td.LC_parm_overview_parm_selectors,
5427: td.LC_parm_overview_restrictions {
1.396 albertel 5428: border: 1px solid black;
5429: border-collapse: collapse;
5430: }
1.795 www 5431:
1.396 albertel 5432: table.LC_parm_overview_restrictions td {
5433: border-width: 1px 4px 1px 4px;
5434: border-style: solid;
5435: border-color: $pgbg;
5436: text-align: center;
5437: }
1.795 www 5438:
1.396 albertel 5439: table.LC_parm_overview_restrictions th {
5440: background: $tabbg;
5441: border-width: 1px 4px 1px 4px;
5442: border-style: solid;
5443: border-color: $pgbg;
5444: }
1.795 www 5445:
1.398 albertel 5446: table#LC_helpmenu {
1.803 bisitz 5447: border: none;
1.398 albertel 5448: height: 55px;
1.803 bisitz 5449: border-spacing: 0;
1.398 albertel 5450: }
5451:
5452: table#LC_helpmenu fieldset legend {
5453: font-size: larger;
5454: }
1.795 www 5455:
1.397 albertel 5456: table#LC_helpmenu_links {
5457: width: 100%;
5458: border: 1px solid black;
5459: background: $pgbg;
1.803 bisitz 5460: padding: 0;
1.397 albertel 5461: border-spacing: 1px;
5462: }
1.795 www 5463:
1.397 albertel 5464: table#LC_helpmenu_links tr td {
5465: padding: 1px;
5466: background: $tabbg;
1.399 albertel 5467: text-align: center;
5468: font-weight: bold;
1.397 albertel 5469: }
1.396 albertel 5470:
1.795 www 5471: table#LC_helpmenu_links a:link,
5472: table#LC_helpmenu_links a:visited,
1.397 albertel 5473: table#LC_helpmenu_links a:active {
5474: text-decoration: none;
5475: color: $font;
5476: }
1.795 www 5477:
1.397 albertel 5478: table#LC_helpmenu_links a:hover {
5479: text-decoration: underline;
5480: color: $vlink;
5481: }
1.396 albertel 5482:
1.417 albertel 5483: .LC_chrt_popup_exists {
5484: border: 1px solid #339933;
5485: margin: -1px;
5486: }
1.795 www 5487:
1.417 albertel 5488: .LC_chrt_popup_up {
5489: border: 1px solid yellow;
5490: margin: -1px;
5491: }
1.795 www 5492:
1.417 albertel 5493: .LC_chrt_popup {
5494: border: 1px solid #8888FF;
5495: background: #CCCCFF;
5496: }
1.795 www 5497:
1.421 albertel 5498: table.LC_pick_box {
5499: border-collapse: separate;
5500: background: white;
5501: border: 1px solid black;
5502: border-spacing: 1px;
5503: }
1.795 www 5504:
1.421 albertel 5505: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 5506: background: $sidebg;
1.421 albertel 5507: font-weight: bold;
1.900 bisitz 5508: text-align: left;
1.740 bisitz 5509: vertical-align: top;
1.421 albertel 5510: width: 184px;
5511: padding: 8px;
5512: }
1.795 www 5513:
1.579 raeburn 5514: table.LC_pick_box td.LC_pick_box_value {
5515: text-align: left;
5516: padding: 8px;
5517: }
1.795 www 5518:
1.579 raeburn 5519: table.LC_pick_box td.LC_pick_box_select {
5520: text-align: left;
5521: padding: 8px;
5522: }
1.795 www 5523:
1.424 albertel 5524: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 5525: padding: 0;
1.421 albertel 5526: height: 1px;
5527: background: black;
5528: }
1.795 www 5529:
1.421 albertel 5530: table.LC_pick_box td.LC_pick_box_submit {
5531: text-align: right;
5532: }
1.795 www 5533:
1.579 raeburn 5534: table.LC_pick_box td.LC_evenrow_value {
5535: text-align: left;
5536: padding: 8px;
5537: background-color: $data_table_light;
5538: }
1.795 www 5539:
1.579 raeburn 5540: table.LC_pick_box td.LC_oddrow_value {
5541: text-align: left;
5542: padding: 8px;
5543: background-color: $data_table_light;
5544: }
1.795 www 5545:
1.579 raeburn 5546: span.LC_helpform_receipt_cat {
5547: font-weight: bold;
5548: }
1.795 www 5549:
1.424 albertel 5550: table.LC_group_priv_box {
5551: background: white;
5552: border: 1px solid black;
5553: border-spacing: 1px;
5554: }
1.795 www 5555:
1.424 albertel 5556: table.LC_group_priv_box td.LC_pick_box_title {
5557: background: $tabbg;
5558: font-weight: bold;
5559: text-align: right;
5560: width: 184px;
5561: }
1.795 www 5562:
1.424 albertel 5563: table.LC_group_priv_box td.LC_groups_fixed {
5564: background: $data_table_light;
5565: text-align: center;
5566: }
1.795 www 5567:
1.424 albertel 5568: table.LC_group_priv_box td.LC_groups_optional {
5569: background: $data_table_dark;
5570: text-align: center;
5571: }
1.795 www 5572:
1.424 albertel 5573: table.LC_group_priv_box td.LC_groups_functionality {
5574: background: $data_table_darker;
5575: text-align: center;
5576: font-weight: bold;
5577: }
1.795 www 5578:
1.424 albertel 5579: table.LC_group_priv td {
5580: text-align: left;
1.803 bisitz 5581: padding: 0;
1.424 albertel 5582: }
5583:
1.421 albertel 5584: table.LC_notify_front_page {
5585: background: white;
5586: border: 1px solid black;
5587: padding: 8px;
5588: }
1.795 www 5589:
1.421 albertel 5590: table.LC_notify_front_page td {
5591: padding: 8px;
5592: }
1.795 www 5593:
1.424 albertel 5594: .LC_navbuttons {
5595: margin: 2ex 0ex 2ex 0ex;
5596: }
1.795 www 5597:
1.423 albertel 5598: .LC_topic_bar {
5599: font-weight: bold;
5600: background: $tabbg;
1.918 wenzelju 5601: margin: 1em 0em 1em 2em;
1.805 bisitz 5602: padding: 3px;
1.918 wenzelju 5603: font-size: 1.2em;
1.423 albertel 5604: }
1.795 www 5605:
1.423 albertel 5606: .LC_topic_bar span {
1.918 wenzelju 5607: left: 0.5em;
5608: position: absolute;
1.423 albertel 5609: vertical-align: middle;
1.918 wenzelju 5610: font-size: 1.2em;
1.423 albertel 5611: }
1.795 www 5612:
1.423 albertel 5613: table.LC_course_group_status {
5614: margin: 20px;
5615: }
1.795 www 5616:
1.423 albertel 5617: table.LC_status_selector td {
5618: vertical-align: top;
5619: text-align: center;
1.424 albertel 5620: padding: 4px;
5621: }
1.795 www 5622:
1.599 albertel 5623: div.LC_feedback_link {
1.616 albertel 5624: clear: both;
1.829 kalberla 5625: background: $sidebg;
1.779 bisitz 5626: width: 100%;
1.829 kalberla 5627: padding-bottom: 10px;
5628: border: 1px $tabbg solid;
1.833 kalberla 5629: height: 22px;
5630: line-height: 22px;
5631: padding-top: 5px;
5632: }
5633:
5634: div.LC_feedback_link img {
5635: height: 22px;
1.867 kalberla 5636: vertical-align:middle;
1.829 kalberla 5637: }
5638:
1.911 bisitz 5639: div.LC_feedback_link a {
1.829 kalberla 5640: text-decoration: none;
1.489 raeburn 5641: }
1.795 www 5642:
1.867 kalberla 5643: div.LC_comblock {
1.911 bisitz 5644: display:inline;
1.867 kalberla 5645: color:$font;
5646: font-size:90%;
5647: }
5648:
5649: div.LC_feedback_link div.LC_comblock {
5650: padding-left:5px;
5651: }
5652:
5653: div.LC_feedback_link div.LC_comblock a {
5654: color:$font;
5655: }
5656:
1.489 raeburn 5657: span.LC_feedback_link {
1.858 bisitz 5658: /* background: $feedback_link_bg; */
1.599 albertel 5659: font-size: larger;
5660: }
1.795 www 5661:
1.599 albertel 5662: span.LC_message_link {
1.858 bisitz 5663: /* background: $feedback_link_bg; */
1.599 albertel 5664: font-size: larger;
5665: position: absolute;
5666: right: 1em;
1.489 raeburn 5667: }
1.421 albertel 5668:
1.515 albertel 5669: table.LC_prior_tries {
1.524 albertel 5670: border: 1px solid #000000;
5671: border-collapse: separate;
5672: border-spacing: 1px;
1.515 albertel 5673: }
1.523 albertel 5674:
1.515 albertel 5675: table.LC_prior_tries td {
1.524 albertel 5676: padding: 2px;
1.515 albertel 5677: }
1.523 albertel 5678:
5679: .LC_answer_correct {
1.795 www 5680: background: lightgreen;
5681: color: darkgreen;
5682: padding: 6px;
1.523 albertel 5683: }
1.795 www 5684:
1.523 albertel 5685: .LC_answer_charged_try {
1.797 www 5686: background: #FFAAAA;
1.795 www 5687: color: darkred;
5688: padding: 6px;
1.523 albertel 5689: }
1.795 www 5690:
1.779 bisitz 5691: .LC_answer_not_charged_try,
1.523 albertel 5692: .LC_answer_no_grade,
5693: .LC_answer_late {
1.795 www 5694: background: lightyellow;
1.523 albertel 5695: color: black;
1.795 www 5696: padding: 6px;
1.523 albertel 5697: }
1.795 www 5698:
1.523 albertel 5699: .LC_answer_previous {
1.795 www 5700: background: lightblue;
5701: color: darkblue;
5702: padding: 6px;
1.523 albertel 5703: }
1.795 www 5704:
1.779 bisitz 5705: .LC_answer_no_message {
1.777 tempelho 5706: background: #FFFFFF;
5707: color: black;
1.795 www 5708: padding: 6px;
1.779 bisitz 5709: }
1.795 www 5710:
1.779 bisitz 5711: .LC_answer_unknown {
5712: background: orange;
5713: color: black;
1.795 www 5714: padding: 6px;
1.777 tempelho 5715: }
1.795 www 5716:
1.529 albertel 5717: span.LC_prior_numerical,
5718: span.LC_prior_string,
5719: span.LC_prior_custom,
5720: span.LC_prior_reaction,
5721: span.LC_prior_math {
1.925 bisitz 5722: font-family: $mono;
1.523 albertel 5723: white-space: pre;
5724: }
5725:
1.525 albertel 5726: span.LC_prior_string {
1.925 bisitz 5727: font-family: $mono;
1.525 albertel 5728: white-space: pre;
5729: }
5730:
1.523 albertel 5731: table.LC_prior_option {
5732: width: 100%;
5733: border-collapse: collapse;
5734: }
1.795 www 5735:
1.911 bisitz 5736: table.LC_prior_rank,
1.795 www 5737: table.LC_prior_match {
1.528 albertel 5738: border-collapse: collapse;
5739: }
1.795 www 5740:
1.528 albertel 5741: table.LC_prior_option tr td,
5742: table.LC_prior_rank tr td,
5743: table.LC_prior_match tr td {
1.524 albertel 5744: border: 1px solid #000000;
1.515 albertel 5745: }
5746:
1.855 bisitz 5747: .LC_nobreak {
1.544 albertel 5748: white-space: nowrap;
1.519 raeburn 5749: }
5750:
1.576 raeburn 5751: span.LC_cusr_emph {
5752: font-style: italic;
5753: }
5754:
1.633 raeburn 5755: span.LC_cusr_subheading {
5756: font-weight: normal;
5757: font-size: 85%;
5758: }
5759:
1.861 bisitz 5760: div.LC_docs_entry_move {
1.859 bisitz 5761: border: 1px solid #BBBBBB;
1.545 albertel 5762: background: #DDDDDD;
1.861 bisitz 5763: width: 22px;
1.859 bisitz 5764: padding: 1px;
5765: margin: 0;
1.545 albertel 5766: }
5767:
1.861 bisitz 5768: table.LC_data_table tr > td.LC_docs_entry_commands,
5769: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 5770: background: #DDDDDD;
5771: font-size: x-small;
5772: }
1.795 www 5773:
1.861 bisitz 5774: .LC_docs_entry_parameter {
5775: white-space: nowrap;
5776: }
5777:
1.544 albertel 5778: .LC_docs_copy {
1.545 albertel 5779: color: #000099;
1.544 albertel 5780: }
1.795 www 5781:
1.544 albertel 5782: .LC_docs_cut {
1.545 albertel 5783: color: #550044;
1.544 albertel 5784: }
1.795 www 5785:
1.544 albertel 5786: .LC_docs_rename {
1.545 albertel 5787: color: #009900;
1.544 albertel 5788: }
1.795 www 5789:
1.544 albertel 5790: .LC_docs_remove {
1.545 albertel 5791: color: #990000;
5792: }
5793:
1.547 albertel 5794: .LC_docs_reinit_warn,
5795: .LC_docs_ext_edit {
5796: font-size: x-small;
5797: }
5798:
1.545 albertel 5799: table.LC_docs_adddocs td,
5800: table.LC_docs_adddocs th {
5801: border: 1px solid #BBBBBB;
5802: padding: 4px;
5803: background: #DDDDDD;
1.543 albertel 5804: }
5805:
1.584 albertel 5806: table.LC_sty_begin {
5807: background: #BBFFBB;
5808: }
1.795 www 5809:
1.584 albertel 5810: table.LC_sty_end {
5811: background: #FFBBBB;
5812: }
5813:
1.589 raeburn 5814: table.LC_double_column {
1.803 bisitz 5815: border-width: 0;
1.589 raeburn 5816: border-collapse: collapse;
5817: width: 100%;
5818: padding: 2px;
5819: }
5820:
5821: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5822: top: 2px;
1.589 raeburn 5823: left: 2px;
5824: width: 47%;
5825: vertical-align: top;
5826: }
5827:
5828: table.LC_double_column tr td.LC_right_col {
5829: top: 2px;
1.779 bisitz 5830: right: 2px;
1.589 raeburn 5831: width: 47%;
5832: vertical-align: top;
5833: }
5834:
1.591 raeburn 5835: div.LC_left_float {
5836: float: left;
5837: padding-right: 5%;
1.597 albertel 5838: padding-bottom: 4px;
1.591 raeburn 5839: }
5840:
5841: div.LC_clear_float_header {
1.597 albertel 5842: padding-bottom: 2px;
1.591 raeburn 5843: }
5844:
5845: div.LC_clear_float_footer {
1.597 albertel 5846: padding-top: 10px;
1.591 raeburn 5847: clear: both;
5848: }
5849:
1.597 albertel 5850: div.LC_grade_show_user {
1.941 bisitz 5851: /* border-left: 5px solid $sidebg; */
5852: border-top: 5px solid #000000;
5853: margin: 50px 0 0 0;
1.936 bisitz 5854: padding: 15px 0 5px 10px;
1.597 albertel 5855: }
1.795 www 5856:
1.936 bisitz 5857: div.LC_grade_show_user_odd_row {
1.941 bisitz 5858: /* border-left: 5px solid #000000; */
5859: }
5860:
5861: div.LC_grade_show_user div.LC_Box {
5862: margin-right: 50px;
1.597 albertel 5863: }
5864:
5865: div.LC_grade_submissions,
5866: div.LC_grade_message_center,
1.936 bisitz 5867: div.LC_grade_info_links {
1.597 albertel 5868: margin: 5px;
5869: width: 99%;
5870: background: #FFFFFF;
5871: }
1.795 www 5872:
1.597 albertel 5873: div.LC_grade_submissions_header,
1.936 bisitz 5874: div.LC_grade_message_center_header {
1.705 tempelho 5875: font-weight: bold;
5876: font-size: large;
1.597 albertel 5877: }
1.795 www 5878:
1.597 albertel 5879: div.LC_grade_submissions_body,
1.936 bisitz 5880: div.LC_grade_message_center_body {
1.597 albertel 5881: border: 1px solid black;
5882: width: 99%;
5883: background: #FFFFFF;
5884: }
1.795 www 5885:
1.613 albertel 5886: table.LC_scantron_action {
5887: width: 100%;
5888: }
1.795 www 5889:
1.613 albertel 5890: table.LC_scantron_action tr th {
1.698 harmsja 5891: font-weight:bold;
5892: font-style:normal;
1.613 albertel 5893: }
1.795 www 5894:
1.779 bisitz 5895: .LC_edit_problem_header,
1.614 albertel 5896: div.LC_edit_problem_footer {
1.705 tempelho 5897: font-weight: normal;
5898: font-size: medium;
1.602 albertel 5899: margin: 2px;
1.600 albertel 5900: }
1.795 www 5901:
1.600 albertel 5902: div.LC_edit_problem_header,
1.602 albertel 5903: div.LC_edit_problem_header div,
1.614 albertel 5904: div.LC_edit_problem_footer,
5905: div.LC_edit_problem_footer div,
1.602 albertel 5906: div.LC_edit_problem_editxml_header,
5907: div.LC_edit_problem_editxml_header div {
1.600 albertel 5908: margin-top: 5px;
5909: }
1.795 www 5910:
1.600 albertel 5911: div.LC_edit_problem_header_title {
1.705 tempelho 5912: font-weight: bold;
5913: font-size: larger;
1.602 albertel 5914: background: $tabbg;
5915: padding: 3px;
5916: }
1.795 www 5917:
1.602 albertel 5918: table.LC_edit_problem_header_title {
5919: width: 100%;
1.600 albertel 5920: background: $tabbg;
1.602 albertel 5921: }
5922:
5923: div.LC_edit_problem_discards {
5924: float: left;
5925: padding-bottom: 5px;
5926: }
1.795 www 5927:
1.602 albertel 5928: div.LC_edit_problem_saves {
5929: float: right;
5930: padding-bottom: 5px;
1.600 albertel 5931: }
1.795 www 5932:
1.911 bisitz 5933: img.stift {
1.803 bisitz 5934: border-width: 0;
5935: vertical-align: middle;
1.677 riegler 5936: }
1.680 riegler 5937:
1.923 bisitz 5938: table td.LC_mainmenu_col_fieldset {
1.680 riegler 5939: vertical-align: top;
1.777 tempelho 5940: }
1.795 www 5941:
1.716 raeburn 5942: div.LC_createcourse {
1.911 bisitz 5943: margin: 10px 10px 10px 10px;
1.716 raeburn 5944: }
5945:
1.917 raeburn 5946: .LC_dccid {
5947: margin: 0.2em 0 0 0;
5948: padding: 0;
5949: font-size: 90%;
5950: display:none;
5951: }
5952:
1.698 harmsja 5953: a:hover,
1.897 wenzelju 5954: ol.LC_primary_menu a:hover,
1.721 harmsja 5955: ol#LC_MenuBreadcrumbs a:hover,
5956: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 5957: ul#LC_secondary_menu a:hover,
1.721 harmsja 5958: .LC_FormSectionClearButton input:hover
1.795 www 5959: ul.LC_TabContent li:hover a {
1.952 onken 5960: color:$button_hover;
1.911 bisitz 5961: text-decoration:none;
1.693 droeschl 5962: }
5963:
1.779 bisitz 5964: h1 {
1.911 bisitz 5965: padding: 0;
5966: line-height:130%;
1.693 droeschl 5967: }
1.698 harmsja 5968:
1.911 bisitz 5969: h2,
5970: h3,
5971: h4,
5972: h5,
5973: h6 {
5974: margin: 5px 0 5px 0;
5975: padding: 0;
5976: line-height:130%;
1.693 droeschl 5977: }
1.795 www 5978:
5979: .LC_hcell {
1.911 bisitz 5980: padding:3px 15px 3px 15px;
5981: margin: 0;
5982: background-color:$tabbg;
5983: color:$fontmenu;
5984: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 5985: }
1.795 www 5986:
1.840 bisitz 5987: .LC_Box > .LC_hcell {
1.911 bisitz 5988: margin: 0 -10px 10px -10px;
1.835 bisitz 5989: }
5990:
1.721 harmsja 5991: .LC_noBorder {
1.911 bisitz 5992: border: 0;
1.698 harmsja 5993: }
1.693 droeschl 5994:
1.721 harmsja 5995: .LC_FormSectionClearButton input {
1.911 bisitz 5996: background-color:transparent;
5997: border: none;
5998: cursor:pointer;
5999: text-decoration:underline;
1.693 droeschl 6000: }
1.763 bisitz 6001:
6002: .LC_help_open_topic {
1.911 bisitz 6003: color: #FFFFFF;
6004: background-color: #EEEEFF;
6005: margin: 1px;
6006: padding: 4px;
6007: border: 1px solid #000033;
6008: white-space: nowrap;
6009: /* vertical-align: middle; */
1.759 neumanie 6010: }
1.693 droeschl 6011:
1.911 bisitz 6012: dl,
6013: ul,
6014: div,
6015: fieldset {
6016: margin: 10px 10px 10px 0;
6017: /* overflow: hidden; */
1.693 droeschl 6018: }
1.795 www 6019:
1.838 bisitz 6020: fieldset > legend {
1.911 bisitz 6021: font-weight: bold;
6022: padding: 0 5px 0 5px;
1.838 bisitz 6023: }
6024:
1.813 bisitz 6025: #LC_nav_bar {
1.911 bisitz 6026: float: left;
1.934 droeschl 6027: margin: 0;
1.807 droeschl 6028: }
6029:
1.916 droeschl 6030: #LC_realm {
6031: margin: 0.2em 0 0 0;
6032: padding: 0;
6033: font-weight: bold;
6034: text-align: center;
6035: }
6036:
1.911 bisitz 6037: #LC_nav_bar em {
6038: font-weight: bold;
6039: font-style: normal;
1.807 droeschl 6040: }
6041:
1.897 wenzelju 6042: ol.LC_primary_menu {
1.911 bisitz 6043: float: right;
1.934 droeschl 6044: margin: 0;
1.807 droeschl 6045: }
6046:
1.852 droeschl 6047: ol#LC_PathBreadcrumbs {
1.911 bisitz 6048: margin: 0;
1.693 droeschl 6049: }
6050:
1.897 wenzelju 6051: ol.LC_primary_menu li {
1.911 bisitz 6052: display: inline;
6053: padding: 5px 5px 0 10px;
6054: vertical-align: top;
1.693 droeschl 6055: }
6056:
1.897 wenzelju 6057: ol.LC_primary_menu li img {
1.911 bisitz 6058: vertical-align: bottom;
1.934 droeschl 6059: height: 1.1em;
1.693 droeschl 6060: }
6061:
1.897 wenzelju 6062: ol.LC_primary_menu a {
1.911 bisitz 6063: color: RGB(80, 80, 80);
6064: text-decoration: none;
1.693 droeschl 6065: }
1.795 www 6066:
1.949 droeschl 6067: ol.LC_primary_menu a.LC_new_message {
6068: font-weight:bold;
6069: color: darkred;
6070: }
6071:
1.897 wenzelju 6072: ul#LC_secondary_menu {
1.911 bisitz 6073: clear: both;
6074: color: $fontmenu;
6075: background: $tabbg;
6076: list-style: none;
6077: padding: 0;
6078: margin: 0;
6079: width: 100%;
1.808 droeschl 6080: }
6081:
1.897 wenzelju 6082: ul#LC_secondary_menu li {
1.911 bisitz 6083: font-weight: bold;
6084: line-height: 1.8em;
6085: padding: 0 0.8em;
6086: border-right: 1px solid black;
6087: display: inline;
6088: vertical-align: middle;
1.807 droeschl 6089: }
6090:
1.847 tempelho 6091: ul.LC_TabContent {
1.911 bisitz 6092: display:block;
6093: background: $sidebg;
6094: border-bottom: solid 1px $lg_border_color;
6095: list-style:none;
6096: margin: 0 -10px;
6097: padding: 0;
1.693 droeschl 6098: }
6099:
1.795 www 6100: ul.LC_TabContent li,
6101: ul.LC_TabContentBigger li {
1.911 bisitz 6102: float:left;
1.741 harmsja 6103: }
1.795 www 6104:
1.897 wenzelju 6105: ul#LC_secondary_menu li a {
1.911 bisitz 6106: color: $fontmenu;
6107: text-decoration: none;
1.693 droeschl 6108: }
1.795 www 6109:
1.721 harmsja 6110: ul.LC_TabContent {
1.952 onken 6111: min-height:20px;
1.721 harmsja 6112: }
1.795 www 6113:
6114: ul.LC_TabContent li {
1.911 bisitz 6115: vertical-align:middle;
6116: padding: 0 10px 0 10px;
6117: background-color:$tabbg;
6118: border-bottom:solid 1px $lg_border_color;
1.952 onken 6119: border-right: solid 1px $font;
1.721 harmsja 6120: }
1.795 www 6121:
1.847 tempelho 6122: ul.LC_TabContent .right {
1.911 bisitz 6123: float:right;
1.847 tempelho 6124: }
6125:
1.911 bisitz 6126: ul.LC_TabContent li a,
6127: ul.LC_TabContent li {
6128: color:rgb(47,47,47);
6129: text-decoration:none;
6130: font-size:95%;
6131: font-weight:bold;
6132: padding-right: 16px;
1.952 onken 6133: min-height:20px;
6134: }
6135:
6136: ul.LC_TabContent li a:hover {
6137: color: $button_hover;
6138: }
6139:
6140: ul.LC_TabContent li:hover {
6141: color: $button_hover;
6142: cursor:pointer;
1.721 harmsja 6143: }
1.795 www 6144:
1.911 bisitz 6145: ul.LC_TabContent li.active {
1.952 onken 6146: color: $font;
1.911 bisitz 6147: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 6148: border-bottom:solid 1px #FFFFFF;
6149: cursor: default;
1.744 ehlerst 6150: }
1.795 www 6151:
1.870 tempelho 6152: #maincoursedoc {
1.911 bisitz 6153: clear:both;
1.870 tempelho 6154: }
6155:
6156: ul.LC_TabContentBigger {
1.911 bisitz 6157: display:block;
6158: list-style:none;
6159: padding: 0;
1.870 tempelho 6160: }
6161:
1.795 www 6162: ul.LC_TabContentBigger li {
1.911 bisitz 6163: vertical-align:bottom;
6164: height: 30px;
6165: font-size:110%;
6166: font-weight:bold;
6167: color: #737373;
1.841 tempelho 6168: }
6169:
1.870 tempelho 6170:
6171: ul.LC_TabContentBigger li a {
1.911 bisitz 6172: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6173: height: 30px;
6174: line-height: 30px;
6175: text-align: center;
6176: display: block;
6177: text-decoration: none;
1.741 harmsja 6178: }
1.795 www 6179:
1.911 bisitz 6180: ul.LC_TabContentBigger li:hover a,
1.870 tempelho 6181: ul.LC_TabContentBigger li.active a {
1.911 bisitz 6182: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6183: color:$font;
6184: text-decoration: underline;
1.744 ehlerst 6185: }
1.795 www 6186:
1.870 tempelho 6187:
6188: ul.LC_TabContentBigger li b {
1.911 bisitz 6189: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
6190: display: block;
6191: float: left;
6192: padding: 0 30px;
1.870 tempelho 6193: }
6194:
6195: ul.LC_TabContentBigger li:hover b,
6196: ul.LC_TabContentBigger li.active b {
1.911 bisitz 6197: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
6198: color:$font;
6199: border-bottom: 1px solid #FFFFFF;
1.741 harmsja 6200: }
1.693 droeschl 6201:
1.870 tempelho 6202:
1.862 bisitz 6203: ul.LC_CourseBreadcrumbs {
6204: background: $sidebg;
6205: line-height: 32px;
6206: padding-left: 10px;
6207: margin: 0 0 10px 0;
6208: list-style-position: inside;
6209:
6210: }
6211:
1.911 bisitz 6212: ol#LC_MenuBreadcrumbs,
1.862 bisitz 6213: ol#LC_PathBreadcrumbs {
1.911 bisitz 6214: padding-left: 10px;
6215: margin: 0;
1.933 droeschl 6216: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 6217: }
6218:
1.911 bisitz 6219: ol#LC_MenuBreadcrumbs li,
6220: ol#LC_PathBreadcrumbs li,
1.862 bisitz 6221: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 6222: display: inline;
1.933 droeschl 6223: white-space: normal;
1.693 droeschl 6224: }
6225:
1.823 bisitz 6226: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 6227: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 6228: text-decoration: none;
6229: font-size:90%;
1.693 droeschl 6230: }
1.795 www 6231:
6232: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 6233: text-decoration:none;
6234: font-size:100%;
6235: font-weight:bold;
1.693 droeschl 6236: }
1.795 www 6237:
1.840 bisitz 6238: .LC_Box {
1.911 bisitz 6239: border: solid 1px $lg_border_color;
6240: padding: 0 10px 10px 10px;
1.746 neumanie 6241: }
1.795 www 6242:
6243: .LC_AboutMe_Image {
1.911 bisitz 6244: float:left;
6245: margin-right:10px;
1.747 neumanie 6246: }
1.795 www 6247:
6248: .LC_Clear_AboutMe_Image {
1.911 bisitz 6249: clear:left;
1.747 neumanie 6250: }
1.795 www 6251:
1.721 harmsja 6252: dl.LC_ListStyleClean dt {
1.911 bisitz 6253: padding-right: 5px;
6254: display: table-header-group;
1.693 droeschl 6255: }
6256:
1.721 harmsja 6257: dl.LC_ListStyleClean dd {
1.911 bisitz 6258: display: table-row;
1.693 droeschl 6259: }
6260:
1.721 harmsja 6261: .LC_ListStyleClean,
6262: .LC_ListStyleSimple,
6263: .LC_ListStyleNormal,
1.795 www 6264: .LC_ListStyleSpecial {
1.911 bisitz 6265: /* display:block; */
6266: list-style-position: inside;
6267: list-style-type: none;
6268: overflow: hidden;
6269: padding: 0;
1.693 droeschl 6270: }
6271:
1.721 harmsja 6272: .LC_ListStyleSimple li,
6273: .LC_ListStyleSimple dd,
6274: .LC_ListStyleNormal li,
6275: .LC_ListStyleNormal dd,
6276: .LC_ListStyleSpecial li,
1.795 www 6277: .LC_ListStyleSpecial dd {
1.911 bisitz 6278: margin: 0;
6279: padding: 5px 5px 5px 10px;
6280: clear: both;
1.693 droeschl 6281: }
6282:
1.721 harmsja 6283: .LC_ListStyleClean li,
6284: .LC_ListStyleClean dd {
1.911 bisitz 6285: padding-top: 0;
6286: padding-bottom: 0;
1.693 droeschl 6287: }
6288:
1.721 harmsja 6289: .LC_ListStyleSimple dd,
1.795 www 6290: .LC_ListStyleSimple li {
1.911 bisitz 6291: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6292: }
6293:
1.721 harmsja 6294: .LC_ListStyleSpecial li,
6295: .LC_ListStyleSpecial dd {
1.911 bisitz 6296: list-style-type: none;
6297: background-color: RGB(220, 220, 220);
6298: margin-bottom: 4px;
1.693 droeschl 6299: }
6300:
1.721 harmsja 6301: table.LC_SimpleTable {
1.911 bisitz 6302: margin:5px;
6303: border:solid 1px $lg_border_color;
1.795 www 6304: }
1.693 droeschl 6305:
1.721 harmsja 6306: table.LC_SimpleTable tr {
1.911 bisitz 6307: padding: 0;
6308: border:solid 1px $lg_border_color;
1.693 droeschl 6309: }
1.795 www 6310:
6311: table.LC_SimpleTable thead {
1.911 bisitz 6312: background:rgb(220,220,220);
1.693 droeschl 6313: }
6314:
1.721 harmsja 6315: div.LC_columnSection {
1.911 bisitz 6316: display: block;
6317: clear: both;
6318: overflow: hidden;
6319: margin: 0;
1.693 droeschl 6320: }
6321:
1.721 harmsja 6322: div.LC_columnSection>* {
1.911 bisitz 6323: float: left;
6324: margin: 10px 20px 10px 0;
6325: overflow:hidden;
1.693 droeschl 6326: }
1.721 harmsja 6327:
1.694 tempelho 6328: .LC_loginpage_container {
1.911 bisitz 6329: text-align:left;
6330: margin : 0 auto;
6331: width:90%;
6332: padding: 10px;
6333: height: auto;
6334: background-color:#FFFFFF;
6335: border:1px solid #CCCCCC;
1.694 tempelho 6336: }
6337:
6338:
6339: .LC_loginpage_loginContainer {
1.911 bisitz 6340: float:left;
6341: width: 182px;
6342: padding: 2px;
6343: border:1px solid #CCCCCC;
6344: background-color:$loginbg;
1.694 tempelho 6345: }
6346:
1.795 www 6347: .LC_loginpage_loginContainer h2 {
1.911 bisitz 6348: margin-top: 0;
6349: display:block;
6350: background:$bgcol;
6351: color:$textcol;
6352: padding-left:5px;
1.712 muellerd 6353: }
1.785 tempelho 6354:
1.694 tempelho 6355: .LC_loginpage_loginInfo {
1.911 bisitz 6356: float:left;
6357: width:182px;
6358: border:1px solid #CCCCCC;
6359: padding:2px;
1.712 muellerd 6360: }
6361:
1.694 tempelho 6362: .LC_loginpage_space {
1.911 bisitz 6363: clear: both;
6364: margin-bottom: 20px;
6365: border-bottom: 1px solid #CCCCCC;
1.694 tempelho 6366: }
6367:
1.785 tempelho 6368: .LC_loginpage_floatLeft {
1.911 bisitz 6369: float: left;
6370: width: 200px;
6371: margin: 0;
1.785 tempelho 6372: }
6373:
1.795 www 6374: table em {
1.911 bisitz 6375: font-weight: bold;
6376: font-style: normal;
1.748 schulted 6377: }
1.795 www 6378:
1.779 bisitz 6379: table.LC_tableBrowseRes,
1.795 www 6380: table.LC_tableOfContent {
1.911 bisitz 6381: border:none;
6382: border-spacing: 1px;
6383: padding: 3px;
6384: background-color: #FFFFFF;
6385: font-size: 90%;
1.753 droeschl 6386: }
1.789 droeschl 6387:
1.911 bisitz 6388: table.LC_tableOfContent {
6389: border-collapse: collapse;
1.789 droeschl 6390: }
6391:
1.771 droeschl 6392: table.LC_tableBrowseRes a,
1.768 schulted 6393: table.LC_tableOfContent a {
1.911 bisitz 6394: background-color: transparent;
6395: text-decoration: none;
1.753 droeschl 6396: }
6397:
1.795 www 6398: table.LC_tableOfContent img {
1.911 bisitz 6399: border: none;
6400: height: 1.3em;
6401: vertical-align: text-bottom;
6402: margin-right: 0.3em;
1.753 droeschl 6403: }
1.757 schulted 6404:
1.795 www 6405: a#LC_content_toolbar_firsthomework {
1.911 bisitz 6406: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 6407: }
6408:
1.795 www 6409: a#LC_content_toolbar_everything {
1.911 bisitz 6410: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 6411: }
6412:
1.795 www 6413: a#LC_content_toolbar_uncompleted {
1.911 bisitz 6414: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 6415: }
6416:
1.795 www 6417: #LC_content_toolbar_clearbubbles {
1.911 bisitz 6418: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 6419: }
6420:
1.795 www 6421: a#LC_content_toolbar_changefolder {
1.911 bisitz 6422: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 6423: }
6424:
1.795 www 6425: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 6426: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 6427: }
6428:
1.795 www 6429: ul#LC_toolbar li a:hover {
1.911 bisitz 6430: background-position: bottom center;
1.757 schulted 6431: }
6432:
1.795 www 6433: ul#LC_toolbar {
1.911 bisitz 6434: padding: 0;
6435: margin: 2px;
6436: list-style:none;
6437: position:relative;
6438: background-color:white;
1.757 schulted 6439: }
6440:
1.795 www 6441: ul#LC_toolbar li {
1.911 bisitz 6442: border:1px solid white;
6443: padding: 0;
6444: margin: 0;
6445: float: left;
6446: display:inline;
6447: vertical-align:middle;
6448: }
1.757 schulted 6449:
1.783 amueller 6450:
1.795 www 6451: a.LC_toolbarItem {
1.911 bisitz 6452: display:block;
6453: padding: 0;
6454: margin: 0;
6455: height: 32px;
6456: width: 32px;
6457: color:white;
6458: border: none;
6459: background-repeat:no-repeat;
6460: background-color:transparent;
1.757 schulted 6461: }
6462:
1.915 droeschl 6463: ul.LC_funclist {
6464: margin: 0;
6465: padding: 0.5em 1em 0.5em 0;
6466: }
6467:
1.933 droeschl 6468: ul.LC_funclist > li:first-child {
6469: font-weight:bold;
6470: margin-left:0.8em;
6471: }
6472:
1.915 droeschl 6473: ul.LC_funclist + ul.LC_funclist {
6474: /*
6475: left border as a seperator if we have more than
6476: one list
6477: */
6478: border-left: 1px solid $sidebg;
6479: /*
6480: this hides the left border behind the border of the
6481: outer box if element is wrapped to the next 'line'
6482: */
6483: margin-left: -1px;
6484: }
6485:
1.843 bisitz 6486: ul.LC_funclist li {
1.915 droeschl 6487: display: inline;
1.782 bisitz 6488: white-space: nowrap;
1.915 droeschl 6489: margin: 0 0 0 25px;
6490: line-height: 150%;
1.782 bisitz 6491: }
6492:
1.930 faziophi 6493: .ui-accordion .LC_advanced_toggle {
6494: float: right;
6495: font-size: 90%;
6496: padding: 0px 4px
6497: }
1.757 schulted 6498:
1.343 albertel 6499: END
6500: }
6501:
1.306 albertel 6502: =pod
6503:
6504: =item * &headtag()
6505:
6506: Returns a uniform footer for LON-CAPA web pages.
6507:
1.307 albertel 6508: Inputs: $title - optional title for the head
6509: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 6510: $args - optional arguments
1.319 albertel 6511: force_register - if is true call registerurl so the remote is
6512: informed
1.415 albertel 6513: redirect -> array ref of
6514: 1- seconds before redirect occurs
6515: 2- url to redirect to
6516: 3- whether the side effect should occur
1.315 albertel 6517: (side effect of setting
6518: $env{'internal.head.redirect'} to the url
6519: redirected too)
1.352 albertel 6520: domain -> force to color decorate a page for a specific
6521: domain
6522: function -> force usage of a specific rolish color scheme
6523: bgcolor -> override the default page bgcolor
1.460 albertel 6524: no_auto_mt_title
6525: -> prevent &mt()ing the title arg
1.464 albertel 6526:
1.306 albertel 6527: =cut
6528:
6529: sub headtag {
1.313 albertel 6530: my ($title,$head_extra,$args) = @_;
1.306 albertel 6531:
1.363 albertel 6532: my $function = $args->{'function'} || &get_users_function();
6533: my $domain = $args->{'domain'} || &determinedomain();
6534: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 6535: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 6536: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 6537: #time(),
1.418 albertel 6538: $env{'environment.color.timestamp'},
1.363 albertel 6539: $function,$domain,$bgcolor);
6540:
1.369 www 6541: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 6542:
1.308 albertel 6543: my $result =
6544: '<head>'.
1.461 albertel 6545: &font_settings();
1.319 albertel 6546:
1.461 albertel 6547: if (!$args->{'frameset'}) {
6548: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
6549: }
1.319 albertel 6550: if ($args->{'force_register'}) {
1.953 ! droeschl 6551: $result .= &Apache::lonmenu::registerurl();
1.319 albertel 6552: }
1.436 albertel 6553: if (!$args->{'no_nav_bar'}
6554: && !$args->{'only_body'}
6555: && !$args->{'frameset'}) {
6556: $result .= &help_menu_js();
6557: }
1.319 albertel 6558:
1.314 albertel 6559: if (ref($args->{'redirect'})) {
1.414 albertel 6560: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 6561: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 6562: if (!$inhibit_continue) {
6563: $env{'internal.head.redirect'} = $url;
6564: }
1.313 albertel 6565: $result.=<<ADDMETA
6566: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 6567: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 6568: ADDMETA
6569: }
1.306 albertel 6570: if (!defined($title)) {
6571: $title = 'The LearningOnline Network with CAPA';
6572: }
1.460 albertel 6573: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
6574: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 6575: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
6576: .$head_extra;
1.306 albertel 6577: return $result;
6578: }
6579:
6580: =pod
6581:
1.340 albertel 6582: =item * &font_settings()
6583:
6584: Returns neccessary <meta> to set the proper encoding
6585:
6586: Inputs: none
6587:
6588: =cut
6589:
6590: sub font_settings {
6591: my $headerstring='';
1.647 www 6592: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 6593: $headerstring.=
6594: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
6595: }
6596: return $headerstring;
6597: }
6598:
1.341 albertel 6599: =pod
6600:
6601: =item * &xml_begin()
6602:
6603: Returns the needed doctype and <html>
6604:
6605: Inputs: none
6606:
6607: =cut
6608:
6609: sub xml_begin {
6610: my $output='';
6611:
1.592 albertel 6612: if ($env{'internal.start_page'}==1) {
6613: &Apache::lonhtmlcommon::init_htmlareafields();
6614: }
1.342 albertel 6615:
1.341 albertel 6616: if ($env{'browser.mathml'}) {
6617: $output='<?xml version="1.0"?>'
6618: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
6619: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
6620:
6621: # .'<!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">] >'
6622: .'<!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">'
6623: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
6624: .'xmlns="http://www.w3.org/1999/xhtml">';
6625: } else {
1.849 bisitz 6626: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
6627: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341 albertel 6628: }
6629: return $output;
6630: }
1.340 albertel 6631:
6632: =pod
6633:
1.306 albertel 6634: =item * &endheadtag()
6635:
6636: Returns a uniform </head> for LON-CAPA web pages.
6637:
6638: Inputs: none
6639:
6640: =cut
6641:
6642: sub endheadtag {
6643: return '</head>';
6644: }
6645:
6646: =pod
6647:
6648: =item * &head()
6649:
6650: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
6651:
1.648 raeburn 6652: Inputs:
6653:
6654: =over 4
6655:
6656: $title - optional title for the page
6657:
6658: $head_extra - optional extra HTML to put inside the <head>
6659:
6660: =back
1.405 albertel 6661:
1.306 albertel 6662: =cut
6663:
6664: sub head {
1.325 albertel 6665: my ($title,$head_extra,$args) = @_;
6666: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 6667: }
6668:
6669: =pod
6670:
6671: =item * &start_page()
6672:
6673: Returns a complete <html> .. <body> section for LON-CAPA web pages.
6674:
1.648 raeburn 6675: Inputs:
6676:
6677: =over 4
6678:
6679: $title - optional title for the page
6680:
6681: $head_extra - optional extra HTML to incude inside the <head>
6682:
6683: $args - additional optional args supported are:
6684:
6685: =over 8
6686:
6687: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 6688: arg on
1.814 bisitz 6689: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 6690: add_entries -> additional attributes to add to the <body>
6691: domain -> force to color decorate a page for a
1.317 albertel 6692: specific domain
1.648 raeburn 6693: function -> force usage of a specific rolish color
1.317 albertel 6694: scheme
1.648 raeburn 6695: redirect -> see &headtag()
6696: bgcolor -> override the default page bg color
6697: js_ready -> return a string ready for being used in
1.317 albertel 6698: a javascript writeln
1.648 raeburn 6699: html_encode -> return a string ready for being used in
1.320 albertel 6700: a html attribute
1.648 raeburn 6701: force_register -> if is true will turn on the &bodytag()
1.317 albertel 6702: $forcereg arg
1.648 raeburn 6703: frameset -> if true will start with a <frameset>
1.330 albertel 6704: rather than <body>
1.648 raeburn 6705: skip_phases -> hash ref of
1.338 albertel 6706: head -> skip the <html><head> generation
6707: body -> skip all <body> generation
1.949 droeschl 6708: #RC no_inline_link -> if true and in remote mode, don't show the
6709: #RC 'Switch To Inline Menu' link
1.648 raeburn 6710: no_auto_mt_title -> prevent &mt()ing the title arg
6711: inherit_jsmath -> when creating popup window in a page,
6712: should it have jsmath forced on by the
6713: current page
1.867 kalberla 6714: bread_crumbs -> Array containing breadcrumbs
6715: bread_crumbs_components -> if exists show it as headline else show only the breadcrumbs
1.361 albertel 6716:
1.648 raeburn 6717: =back
1.460 albertel 6718:
1.648 raeburn 6719: =back
1.562 albertel 6720:
1.306 albertel 6721: =cut
6722:
6723: sub start_page {
1.309 albertel 6724: my ($title,$head_extra,$args) = @_;
1.318 albertel 6725: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 6726: my %head_args;
1.352 albertel 6727: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6728: 'bgcolor','frameset','no_nav_bar','only_body',
6729: 'no_auto_mt_title') {
1.319 albertel 6730: if (defined($args->{$arg})) {
1.324 raeburn 6731: $head_args{$arg} = $args->{$arg};
1.319 albertel 6732: }
1.313 albertel 6733: }
1.319 albertel 6734:
1.315 albertel 6735: $env{'internal.start_page'}++;
1.338 albertel 6736: my $result;
6737: if (! exists($args->{'skip_phases'}{'head'}) ) {
6738: $result.=
1.341 albertel 6739: &xml_begin().
1.338 albertel 6740: &headtag($title,$head_extra,\%head_args).&endheadtag();
6741: }
6742:
6743: if (! exists($args->{'skip_phases'}{'body'}) ) {
6744: if ($args->{'frameset'}) {
6745: my $attr_string = &make_attr_string($args->{'force_register'},
6746: $args->{'add_entries'});
6747: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 6748: } else {
6749: $result .=
6750: &bodytag($title,
6751: $args->{'function'}, $args->{'add_entries'},
6752: $args->{'only_body'}, $args->{'domain'},
6753: $args->{'force_register'}, $args->{'no_nav_bar'},
6754: $args->{'bgcolor'}, $args->{'no_inline_link'},
6755: $args);
6756: }
1.330 albertel 6757: }
1.338 albertel 6758:
1.315 albertel 6759: if ($args->{'js_ready'}) {
1.713 kaisler 6760: $result = &js_ready($result);
1.315 albertel 6761: }
1.320 albertel 6762: if ($args->{'html_encode'}) {
1.713 kaisler 6763: $result = &html_encode($result);
6764: }
6765:
1.813 bisitz 6766: # Preparation for new and consistent functionlist at top of screen
6767: # if ($args->{'functionlist'}) {
6768: # $result .= &build_functionlist();
6769: #}
6770:
6771: # Don't add anything more if only_body wanted
6772: return $result if $args->{'only_body'};
6773:
1.920 raeburn 6774: #Breadcrumbs for Construction Space provided by &bodytag.
1.949 droeschl 6775: if (
6776: $env{'request.state'} eq 'construct') {
1.920 raeburn 6777: return $result;
6778: }
6779:
1.813 bisitz 6780: #Breadcrumbs
1.758 kaisler 6781: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
6782: &Apache::lonhtmlcommon::clear_breadcrumbs();
6783: #if any br links exists, add them to the breadcrumbs
6784: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6785: foreach my $crumb (@{$args->{'bread_crumbs'}}){
6786: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
6787: }
6788: }
6789:
6790: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
6791: if(exists($args->{'bread_crumbs_component'})){
6792: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
6793: }else{
6794: $result .= &Apache::lonhtmlcommon::breadcrumbs();
6795: }
1.320 albertel 6796: }
1.315 albertel 6797: return $result;
1.306 albertel 6798: }
6799:
1.330 albertel 6800:
1.306 albertel 6801: =pod
6802:
6803: =item * &head()
6804:
6805: Returns a complete </body></html> section for LON-CAPA web pages.
6806:
1.315 albertel 6807: Inputs: $args - additional optional args supported are:
6808: js_ready -> return a string ready for being used in
6809: a javascript writeln
1.320 albertel 6810: html_encode -> return a string ready for being used in
6811: a html attribute
1.330 albertel 6812: frameset -> if true will start with a <frameset>
6813: rather than <body>
1.493 albertel 6814: dicsussion -> if true will get discussion from
6815: lonxml::xmlend
6816: (you can pass the target and parser arguments
6817: through optional 'target' and 'parser' args
6818: to this routine)
1.306 albertel 6819:
6820: =cut
6821:
6822: sub end_page {
1.315 albertel 6823: my ($args) = @_;
6824: $env{'internal.end_page'}++;
1.330 albertel 6825: my $result;
1.335 albertel 6826: if ($args->{'discussion'}) {
6827: my ($target,$parser);
6828: if (ref($args->{'discussion'})) {
6829: ($target,$parser) =($args->{'discussion'}{'target'},
6830: $args->{'discussion'}{'parser'});
6831: }
6832: $result .= &Apache::lonxml::xmlend($target,$parser);
6833: }
6834:
1.330 albertel 6835: if ($args->{'frameset'}) {
6836: $result .= '</frameset>';
6837: } else {
1.635 raeburn 6838: $result .= &endbodytag($args);
1.330 albertel 6839: }
6840: $result .= "\n</html>";
6841:
1.315 albertel 6842: if ($args->{'js_ready'}) {
1.317 albertel 6843: $result = &js_ready($result);
1.315 albertel 6844: }
1.335 albertel 6845:
1.320 albertel 6846: if ($args->{'html_encode'}) {
6847: $result = &html_encode($result);
6848: }
1.335 albertel 6849:
1.315 albertel 6850: return $result;
6851: }
6852:
1.320 albertel 6853: sub html_encode {
6854: my ($result) = @_;
6855:
1.322 albertel 6856: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6857:
6858: return $result;
6859: }
1.317 albertel 6860: sub js_ready {
6861: my ($result) = @_;
6862:
1.323 albertel 6863: $result =~ s/[\n\r]/ /xmsg;
6864: $result =~ s/\\/\\\\/xmsg;
6865: $result =~ s/'/\\'/xmsg;
1.372 albertel 6866: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6867:
6868: return $result;
6869: }
6870:
1.315 albertel 6871: sub validate_page {
6872: if ( exists($env{'internal.start_page'})
1.316 albertel 6873: && $env{'internal.start_page'} > 1) {
6874: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6875: $env{'internal.start_page'}.' '.
1.316 albertel 6876: $ENV{'request.filename'});
1.315 albertel 6877: }
6878: if ( exists($env{'internal.end_page'})
1.316 albertel 6879: && $env{'internal.end_page'} > 1) {
6880: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6881: $env{'internal.end_page'}.' '.
1.316 albertel 6882: $env{'request.filename'});
1.315 albertel 6883: }
6884: if ( exists($env{'internal.start_page'})
6885: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6886: &Apache::lonnet::logthis('start_page called without end_page '.
6887: $env{'request.filename'});
1.315 albertel 6888: }
6889: if ( ! exists($env{'internal.start_page'})
6890: && exists($env{'internal.end_page'})) {
1.316 albertel 6891: &Apache::lonnet::logthis('end_page called without start_page'.
6892: $env{'request.filename'});
1.315 albertel 6893: }
1.306 albertel 6894: }
1.315 albertel 6895:
1.318 albertel 6896: sub simple_error_page {
6897: my ($r,$title,$msg) = @_;
6898: my $page =
6899: &Apache::loncommon::start_page($title).
6900: &mt($msg).
6901: &Apache::loncommon::end_page();
6902: if (ref($r)) {
6903: $r->print($page);
1.327 albertel 6904: return;
1.318 albertel 6905: }
6906: return $page;
6907: }
1.347 albertel 6908:
6909: {
1.610 albertel 6910: my @row_count;
1.347 albertel 6911: sub start_data_table {
1.422 albertel 6912: my ($add_class) = @_;
6913: my $css_class = (join(' ','LC_data_table',$add_class));
1.610 albertel 6914: unshift(@row_count,0);
1.422 albertel 6915: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 6916: }
6917:
6918: sub end_data_table {
1.610 albertel 6919: shift(@row_count);
1.389 albertel 6920: return '</table>'."\n";;
1.347 albertel 6921: }
6922:
6923: sub start_data_table_row {
1.422 albertel 6924: my ($add_class) = @_;
1.610 albertel 6925: $row_count[0]++;
6926: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 6927: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.422 albertel 6928: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 6929: }
1.471 banghart 6930:
6931: sub continue_data_table_row {
6932: my ($add_class) = @_;
1.610 albertel 6933: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 6934: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');;
1.471 banghart 6935: return '<tr class="'.$css_class.'">'."\n";;
6936: }
1.347 albertel 6937:
6938: sub end_data_table_row {
1.389 albertel 6939: return '</tr>'."\n";;
1.347 albertel 6940: }
1.367 www 6941:
1.421 albertel 6942: sub start_data_table_empty_row {
1.707 bisitz 6943: # $row_count[0]++;
1.421 albertel 6944: return '<tr class="LC_empty_row" >'."\n";;
6945: }
6946:
6947: sub end_data_table_empty_row {
6948: return '</tr>'."\n";;
6949: }
6950:
1.367 www 6951: sub start_data_table_header_row {
1.389 albertel 6952: return '<tr class="LC_header_row">'."\n";;
1.367 www 6953: }
6954:
6955: sub end_data_table_header_row {
1.389 albertel 6956: return '</tr>'."\n";;
1.367 www 6957: }
1.890 droeschl 6958:
6959: sub data_table_caption {
6960: my $caption = shift;
6961: return "<caption class=\"LC_caption\">$caption</caption>";
6962: }
1.347 albertel 6963: }
6964:
1.548 albertel 6965: =pod
6966:
6967: =item * &inhibit_menu_check($arg)
6968:
6969: Checks for a inhibitmenu state and generates output to preserve it
6970:
6971: Inputs: $arg - can be any of
6972: - undef - in which case the return value is a string
6973: to add into arguments list of a uri
6974: - 'input' - in which case the return value is a HTML
6975: <form> <input> field of type hidden to
6976: preserve the value
6977: - a url - in which case the return value is the url with
6978: the neccesary cgi args added to preserve the
6979: inhibitmenu state
6980: - a ref to a url - no return value, but the string is
6981: updated to include the neccessary cgi
6982: args to preserve the inhibitmenu state
6983:
6984: =cut
6985:
6986: sub inhibit_menu_check {
6987: my ($arg) = @_;
6988: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6989: if ($arg eq 'input') {
6990: if ($env{'form.inhibitmenu'}) {
6991: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
6992: } else {
6993: return
6994: }
6995: }
6996: if ($env{'form.inhibitmenu'}) {
6997: if (ref($arg)) {
6998: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6999: } elsif ($arg eq '') {
7000: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
7001: } else {
7002: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7003: }
7004: }
7005: if (!ref($arg)) {
7006: return $arg;
7007: }
7008: }
7009:
1.251 albertel 7010: ###############################################
1.182 matthew 7011:
7012: =pod
7013:
1.549 albertel 7014: =back
7015:
7016: =head1 User Information Routines
7017:
7018: =over 4
7019:
1.405 albertel 7020: =item * &get_users_function()
1.182 matthew 7021:
7022: Used by &bodytag to determine the current users primary role.
7023: Returns either 'student','coordinator','admin', or 'author'.
7024:
7025: =cut
7026:
7027: ###############################################
7028: sub get_users_function {
1.815 tempelho 7029: my $function = 'norole';
1.818 tempelho 7030: if ($env{'request.role'}=~/^(st)/) {
7031: $function='student';
7032: }
1.907 raeburn 7033: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 7034: $function='coordinator';
7035: }
1.258 albertel 7036: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 7037: $function='admin';
7038: }
1.826 bisitz 7039: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182 matthew 7040: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
7041: $function='author';
7042: }
7043: return $function;
1.54 www 7044: }
1.99 www 7045:
7046: ###############################################
7047:
1.233 raeburn 7048: =pod
7049:
1.821 raeburn 7050: =item * &show_course()
7051:
7052: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
7053: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
7054:
7055: Inputs:
7056: None
7057:
7058: Outputs:
7059: Scalar: 1 if 'Course' to be used, 0 otherwise.
7060:
7061: =cut
7062:
7063: ###############################################
7064: sub show_course {
7065: my $course = !$env{'user.adv'};
7066: if (!$env{'user.adv'}) {
7067: foreach my $env (keys(%env)) {
7068: next if ($env !~ m/^user\.priv\./);
7069: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
7070: $course = 0;
7071: last;
7072: }
7073: }
7074: }
7075: return $course;
7076: }
7077:
7078: ###############################################
7079:
7080: =pod
7081:
1.542 raeburn 7082: =item * &check_user_status()
1.274 raeburn 7083:
7084: Determines current status of supplied role for a
7085: specific user. Roles can be active, previous or future.
7086:
7087: Inputs:
7088: user's domain, user's username, course's domain,
1.375 raeburn 7089: course's number, optional section ID.
1.274 raeburn 7090:
7091: Outputs:
7092: role status: active, previous or future.
7093:
7094: =cut
7095:
7096: sub check_user_status {
1.412 raeburn 7097: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 7098: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
7099: my @uroles = keys %userinfo;
7100: my $srchstr;
7101: my $active_chk = 'none';
1.412 raeburn 7102: my $now = time;
1.274 raeburn 7103: if (@uroles > 0) {
1.908 raeburn 7104: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 7105: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
7106: } else {
1.412 raeburn 7107: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
7108: }
7109: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 7110: my $role_end = 0;
7111: my $role_start = 0;
7112: $active_chk = 'active';
1.412 raeburn 7113: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
7114: $role_end = $1;
7115: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
7116: $role_start = $1;
1.274 raeburn 7117: }
7118: }
7119: if ($role_start > 0) {
1.412 raeburn 7120: if ($now < $role_start) {
1.274 raeburn 7121: $active_chk = 'future';
7122: }
7123: }
7124: if ($role_end > 0) {
1.412 raeburn 7125: if ($now > $role_end) {
1.274 raeburn 7126: $active_chk = 'previous';
7127: }
7128: }
7129: }
7130: }
7131: return $active_chk;
7132: }
7133:
7134: ###############################################
7135:
7136: =pod
7137:
1.405 albertel 7138: =item * &get_sections()
1.233 raeburn 7139:
7140: Determines all the sections for a course including
7141: sections with students and sections containing other roles.
1.419 raeburn 7142: Incoming parameters:
7143:
7144: 1. domain
7145: 2. course number
7146: 3. reference to array containing roles for which sections should
7147: be gathered (optional).
7148: 4. reference to array containing status types for which sections
7149: should be gathered (optional).
7150:
7151: If the third argument is undefined, sections are gathered for any role.
7152: If the fourth argument is undefined, sections are gathered for any status.
7153: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 7154:
1.374 raeburn 7155: Returns section hash (keys are section IDs, values are
7156: number of users in each section), subject to the
1.419 raeburn 7157: optional roles filter, optional status filter
1.233 raeburn 7158:
7159: =cut
7160:
7161: ###############################################
7162: sub get_sections {
1.419 raeburn 7163: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 7164: if (!defined($cdom) || !defined($cnum)) {
7165: my $cid = $env{'request.course.id'};
7166:
7167: return if (!defined($cid));
7168:
7169: $cdom = $env{'course.'.$cid.'.domain'};
7170: $cnum = $env{'course.'.$cid.'.num'};
7171: }
7172:
7173: my %sectioncount;
1.419 raeburn 7174: my $now = time;
1.240 albertel 7175:
1.366 albertel 7176: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 7177: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 7178: my $sec_index = &Apache::loncoursedata::CL_SECTION();
7179: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 7180: my $start_index = &Apache::loncoursedata::CL_START();
7181: my $end_index = &Apache::loncoursedata::CL_END();
7182: my $status;
1.366 albertel 7183: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 7184: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
7185: $data->[$status_index],
7186: $data->[$start_index],
7187: $data->[$end_index]);
7188: if ($stu_status eq 'Active') {
7189: $status = 'active';
7190: } elsif ($end < $now) {
7191: $status = 'previous';
7192: } elsif ($start > $now) {
7193: $status = 'future';
7194: }
7195: if ($section ne '-1' && $section !~ /^\s*$/) {
7196: if ((!defined($possible_status)) || (($status ne '') &&
7197: (grep/^\Q$status\E$/,@{$possible_status}))) {
7198: $sectioncount{$section}++;
7199: }
1.240 albertel 7200: }
7201: }
7202: }
7203: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7204: foreach my $user (sort(keys(%courseroles))) {
7205: if ($user !~ /^(\w{2})/) { next; }
7206: my ($role) = ($user =~ /^(\w{2})/);
7207: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 7208: my ($section,$status);
1.240 albertel 7209: if ($role eq 'cr' &&
7210: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
7211: $section=$1;
7212: }
7213: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
7214: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 7215: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
7216: if ($end == -1 && $start == -1) {
7217: next; #deleted role
7218: }
7219: if (!defined($possible_status)) {
7220: $sectioncount{$section}++;
7221: } else {
7222: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
7223: $status = 'active';
7224: } elsif ($end < $now) {
7225: $status = 'future';
7226: } elsif ($start > $now) {
7227: $status = 'previous';
7228: }
7229: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
7230: $sectioncount{$section}++;
7231: }
7232: }
1.233 raeburn 7233: }
1.366 albertel 7234: return %sectioncount;
1.233 raeburn 7235: }
7236:
1.274 raeburn 7237: ###############################################
1.294 raeburn 7238:
7239: =pod
1.405 albertel 7240:
7241: =item * &get_course_users()
7242:
1.275 raeburn 7243: Retrieves usernames:domains for users in the specified course
7244: with specific role(s), and access status.
7245:
7246: Incoming parameters:
1.277 albertel 7247: 1. course domain
7248: 2. course number
7249: 3. access status: users must have - either active,
1.275 raeburn 7250: previous, future, or all.
1.277 albertel 7251: 4. reference to array of permissible roles
1.288 raeburn 7252: 5. reference to array of section restrictions (optional)
7253: 6. reference to results object (hash of hashes).
7254: 7. reference to optional userdata hash
1.609 raeburn 7255: 8. reference to optional statushash
1.630 raeburn 7256: 9. flag if privileged users (except those set to unhide in
7257: course settings) should be excluded
1.609 raeburn 7258: Keys of top level results hash are roles.
1.275 raeburn 7259: Keys of inner hashes are username:domain, with
7260: values set to access type.
1.288 raeburn 7261: Optional userdata hash returns an array with arguments in the
7262: same order as loncoursedata::get_classlist() for student data.
7263:
1.609 raeburn 7264: Optional statushash returns
7265:
1.288 raeburn 7266: Entries for end, start, section and status are blank because
7267: of the possibility of multiple values for non-student roles.
7268:
1.275 raeburn 7269: =cut
1.405 albertel 7270:
1.275 raeburn 7271: ###############################################
1.405 albertel 7272:
1.275 raeburn 7273: sub get_course_users {
1.630 raeburn 7274: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 7275: my %idx = ();
1.419 raeburn 7276: my %seclists;
1.288 raeburn 7277:
7278: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
7279: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
7280: $idx{end} = &Apache::loncoursedata::CL_END();
7281: $idx{start} = &Apache::loncoursedata::CL_START();
7282: $idx{id} = &Apache::loncoursedata::CL_ID();
7283: $idx{section} = &Apache::loncoursedata::CL_SECTION();
7284: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
7285: $idx{status} = &Apache::loncoursedata::CL_STATUS();
7286:
1.290 albertel 7287: if (grep(/^st$/,@{$roles})) {
1.276 albertel 7288: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 7289: my $now = time;
1.277 albertel 7290: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 7291: my $match = 0;
1.412 raeburn 7292: my $secmatch = 0;
1.419 raeburn 7293: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 7294: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 7295: if ($section eq '') {
7296: $section = 'none';
7297: }
1.291 albertel 7298: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7299: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7300: $secmatch = 1;
7301: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 7302: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7303: $secmatch = 1;
7304: }
7305: } else {
1.419 raeburn 7306: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 7307: $secmatch = 1;
7308: }
1.290 albertel 7309: }
1.412 raeburn 7310: if (!$secmatch) {
7311: next;
7312: }
1.419 raeburn 7313: }
1.275 raeburn 7314: if (defined($$types{'active'})) {
1.288 raeburn 7315: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 7316: push(@{$$users{st}{$student}},'active');
1.288 raeburn 7317: $match = 1;
1.275 raeburn 7318: }
7319: }
7320: if (defined($$types{'previous'})) {
1.609 raeburn 7321: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 7322: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 7323: $match = 1;
1.275 raeburn 7324: }
7325: }
7326: if (defined($$types{'future'})) {
1.609 raeburn 7327: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 7328: push(@{$$users{st}{$student}},'future');
1.288 raeburn 7329: $match = 1;
1.275 raeburn 7330: }
7331: }
1.609 raeburn 7332: if ($match) {
7333: push(@{$seclists{$student}},$section);
7334: if (ref($userdata) eq 'HASH') {
7335: $$userdata{$student} = $$classlist{$student};
7336: }
7337: if (ref($statushash) eq 'HASH') {
7338: $statushash->{$student}{'st'}{$section} = $status;
7339: }
1.288 raeburn 7340: }
1.275 raeburn 7341: }
7342: }
1.412 raeburn 7343: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 7344: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7345: my $now = time;
1.609 raeburn 7346: my %displaystatus = ( previous => 'Expired',
7347: active => 'Active',
7348: future => 'Future',
7349: );
1.630 raeburn 7350: my %nothide;
7351: if ($hidepriv) {
7352: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
7353: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
7354: if ($user !~ /:/) {
7355: $nothide{join(':',split(/[\@]/,$user))}=1;
7356: } else {
7357: $nothide{$user} = 1;
7358: }
7359: }
7360: }
1.439 raeburn 7361: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 7362: my $match = 0;
1.412 raeburn 7363: my $secmatch = 0;
1.439 raeburn 7364: my $status;
1.412 raeburn 7365: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 7366: $user =~ s/:$//;
1.439 raeburn 7367: my ($end,$start) = split(/:/,$coursepersonnel{$person});
7368: if ($end == -1 || $start == -1) {
7369: next;
7370: }
7371: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
7372: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 7373: my ($uname,$udom) = split(/:/,$user);
7374: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7375: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7376: $secmatch = 1;
7377: } elsif ($usec eq '') {
1.420 albertel 7378: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7379: $secmatch = 1;
7380: }
7381: } else {
7382: if (grep(/^\Q$usec\E$/,@{$sections})) {
7383: $secmatch = 1;
7384: }
7385: }
7386: if (!$secmatch) {
7387: next;
7388: }
1.288 raeburn 7389: }
1.419 raeburn 7390: if ($usec eq '') {
7391: $usec = 'none';
7392: }
1.275 raeburn 7393: if ($uname ne '' && $udom ne '') {
1.630 raeburn 7394: if ($hidepriv) {
7395: if ((&Apache::lonnet::privileged($uname,$udom)) &&
7396: (!$nothide{$uname.':'.$udom})) {
7397: next;
7398: }
7399: }
1.503 raeburn 7400: if ($end > 0 && $end < $now) {
1.439 raeburn 7401: $status = 'previous';
7402: } elsif ($start > $now) {
7403: $status = 'future';
7404: } else {
7405: $status = 'active';
7406: }
1.277 albertel 7407: foreach my $type (keys(%{$types})) {
1.275 raeburn 7408: if ($status eq $type) {
1.420 albertel 7409: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 7410: push(@{$$users{$role}{$user}},$type);
7411: }
1.288 raeburn 7412: $match = 1;
7413: }
7414: }
1.419 raeburn 7415: if (($match) && (ref($userdata) eq 'HASH')) {
7416: if (!exists($$userdata{$uname.':'.$udom})) {
7417: &get_user_info($udom,$uname,\%idx,$userdata);
7418: }
1.420 albertel 7419: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 7420: push(@{$seclists{$uname.':'.$udom}},$usec);
7421: }
1.609 raeburn 7422: if (ref($statushash) eq 'HASH') {
7423: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
7424: }
1.275 raeburn 7425: }
7426: }
7427: }
7428: }
1.290 albertel 7429: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 7430: if ((defined($cdom)) && (defined($cnum))) {
7431: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
7432: if ( defined($csettings{'internal.courseowner'}) ) {
7433: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 7434: next if ($owner eq '');
7435: my ($ownername,$ownerdom);
7436: if ($owner =~ /^([^:]+):([^:]+)$/) {
7437: $ownername = $1;
7438: $ownerdom = $2;
7439: } else {
7440: $ownername = $owner;
7441: $ownerdom = $cdom;
7442: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 7443: }
7444: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 7445: if (defined($userdata) &&
1.609 raeburn 7446: !exists($$userdata{$owner})) {
7447: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
7448: if (!grep(/^none$/,@{$seclists{$owner}})) {
7449: push(@{$seclists{$owner}},'none');
7450: }
7451: if (ref($statushash) eq 'HASH') {
7452: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 7453: }
1.290 albertel 7454: }
1.279 raeburn 7455: }
7456: }
7457: }
1.419 raeburn 7458: foreach my $user (keys(%seclists)) {
7459: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
7460: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
7461: }
1.275 raeburn 7462: }
7463: return;
7464: }
7465:
1.288 raeburn 7466: sub get_user_info {
7467: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 7468: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
7469: &plainname($uname,$udom,'lastname');
1.291 albertel 7470: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 7471: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 7472: my %idhash = &Apache::lonnet::idrget($udom,($uname));
7473: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 7474: return;
7475: }
1.275 raeburn 7476:
1.472 raeburn 7477: ###############################################
7478:
7479: =pod
7480:
7481: =item * &get_user_quota()
7482:
7483: Retrieves quota assigned for storage of portfolio files for a user
7484:
7485: Incoming parameters:
7486: 1. user's username
7487: 2. user's domain
7488:
7489: Returns:
1.536 raeburn 7490: 1. Disk quota (in Mb) assigned to student.
7491: 2. (Optional) Type of setting: custom or default
7492: (individually assigned or default for user's
7493: institutional status).
7494: 3. (Optional) - User's institutional status (e.g., faculty, staff
7495: or student - types as defined in localenroll::inst_usertypes
7496: for user's domain, which determines default quota for user.
7497: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 7498:
7499: If a value has been stored in the user's environment,
1.536 raeburn 7500: it will return that, otherwise it returns the maximal default
7501: defined for the user's instituional status(es) in the domain.
1.472 raeburn 7502:
7503: =cut
7504:
7505: ###############################################
7506:
7507:
7508: sub get_user_quota {
7509: my ($uname,$udom) = @_;
1.536 raeburn 7510: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 7511: if (!defined($udom)) {
7512: $udom = $env{'user.domain'};
7513: }
7514: if (!defined($uname)) {
7515: $uname = $env{'user.name'};
7516: }
7517: if (($udom eq '' || $uname eq '') ||
7518: ($udom eq 'public') && ($uname eq 'public')) {
7519: $quota = 0;
1.536 raeburn 7520: $quotatype = 'default';
7521: $defquota = 0;
1.472 raeburn 7522: } else {
1.536 raeburn 7523: my $inststatus;
1.472 raeburn 7524: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
7525: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 7526: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 7527: } else {
1.536 raeburn 7528: my %userenv =
7529: &Apache::lonnet::get('environment',['portfolioquota',
7530: 'inststatus'],$udom,$uname);
1.472 raeburn 7531: my ($tmp) = keys(%userenv);
7532: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7533: $quota = $userenv{'portfolioquota'};
1.536 raeburn 7534: $inststatus = $userenv{'inststatus'};
1.472 raeburn 7535: } else {
7536: undef(%userenv);
7537: }
7538: }
1.536 raeburn 7539: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 7540: if ($quota eq '') {
1.536 raeburn 7541: $quota = $defquota;
7542: $quotatype = 'default';
7543: } else {
7544: $quotatype = 'custom';
1.472 raeburn 7545: }
7546: }
1.536 raeburn 7547: if (wantarray) {
7548: return ($quota,$quotatype,$settingstatus,$defquota);
7549: } else {
7550: return $quota;
7551: }
1.472 raeburn 7552: }
7553:
7554: ###############################################
7555:
7556: =pod
7557:
7558: =item * &default_quota()
7559:
1.536 raeburn 7560: Retrieves default quota assigned for storage of user portfolio files,
7561: given an (optional) user's institutional status.
1.472 raeburn 7562:
7563: Incoming parameters:
7564: 1. domain
1.536 raeburn 7565: 2. (Optional) institutional status(es). This is a : separated list of
7566: status types (e.g., faculty, staff, student etc.)
7567: which apply to the user for whom the default is being retrieved.
7568: If the institutional status string in undefined, the domain
7569: default quota will be returned.
1.472 raeburn 7570:
7571: Returns:
7572: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 7573: 2. (Optional) institutional type which determined the value of the
7574: default quota.
1.472 raeburn 7575:
7576: If a value has been stored in the domain's configuration db,
7577: it will return that, otherwise it returns 20 (for backwards
7578: compatibility with domains which have not set up a configuration
7579: db file; the original statically defined portfolio quota was 20 Mb).
7580:
1.536 raeburn 7581: If the user's status includes multiple types (e.g., staff and student),
7582: the largest default quota which applies to the user determines the
7583: default quota returned.
7584:
1.780 raeburn 7585: =back
7586:
1.472 raeburn 7587: =cut
7588:
7589: ###############################################
7590:
7591:
7592: sub default_quota {
1.536 raeburn 7593: my ($udom,$inststatus) = @_;
7594: my ($defquota,$settingstatus);
7595: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 7596: ['quotas'],$udom);
7597: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 7598: if ($inststatus ne '') {
1.765 raeburn 7599: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 7600: foreach my $item (@statuses) {
1.711 raeburn 7601: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7602: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
7603: if ($defquota eq '') {
7604: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7605: $settingstatus = $item;
7606: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
7607: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7608: $settingstatus = $item;
7609: }
7610: }
7611: } else {
7612: if ($quotahash{'quotas'}{$item} ne '') {
7613: if ($defquota eq '') {
7614: $defquota = $quotahash{'quotas'}{$item};
7615: $settingstatus = $item;
7616: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
7617: $defquota = $quotahash{'quotas'}{$item};
7618: $settingstatus = $item;
7619: }
1.536 raeburn 7620: }
7621: }
7622: }
7623: }
7624: if ($defquota eq '') {
1.711 raeburn 7625: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7626: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
7627: } else {
7628: $defquota = $quotahash{'quotas'}{'default'};
7629: }
1.536 raeburn 7630: $settingstatus = 'default';
7631: }
7632: } else {
7633: $settingstatus = 'default';
7634: $defquota = 20;
7635: }
7636: if (wantarray) {
7637: return ($defquota,$settingstatus);
1.472 raeburn 7638: } else {
1.536 raeburn 7639: return $defquota;
1.472 raeburn 7640: }
7641: }
7642:
1.384 raeburn 7643: sub get_secgrprole_info {
7644: my ($cdom,$cnum,$needroles,$type) = @_;
7645: my %sections_count = &get_sections($cdom,$cnum);
7646: my @sections = (sort {$a <=> $b} keys(%sections_count));
7647: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
7648: my @groups = sort(keys(%curr_groups));
7649: my $allroles = [];
7650: my $rolehash;
7651: my $accesshash = {
7652: active => 'Currently has access',
7653: future => 'Will have future access',
7654: previous => 'Previously had access',
7655: };
7656: if ($needroles) {
7657: $rolehash = {'all' => 'all'};
1.385 albertel 7658: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7659: if (&Apache::lonnet::error(%user_roles)) {
7660: undef(%user_roles);
7661: }
7662: foreach my $item (keys(%user_roles)) {
1.384 raeburn 7663: my ($role)=split(/\:/,$item,2);
7664: if ($role eq 'cr') { next; }
7665: if ($role =~ /^cr/) {
7666: $$rolehash{$role} = (split('/',$role))[3];
7667: } else {
7668: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
7669: }
7670: }
7671: foreach my $key (sort(keys(%{$rolehash}))) {
7672: push(@{$allroles},$key);
7673: }
7674: push (@{$allroles},'st');
7675: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
7676: }
7677: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
7678: }
7679:
1.555 raeburn 7680: sub user_picker {
1.627 raeburn 7681: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555 raeburn 7682: my $currdom = $dom;
7683: my %curr_selected = (
7684: srchin => 'dom',
1.580 raeburn 7685: srchby => 'lastname',
1.555 raeburn 7686: );
7687: my $srchterm;
1.625 raeburn 7688: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 7689: if ($srch->{'srchby'} ne '') {
7690: $curr_selected{'srchby'} = $srch->{'srchby'};
7691: }
7692: if ($srch->{'srchin'} ne '') {
7693: $curr_selected{'srchin'} = $srch->{'srchin'};
7694: }
7695: if ($srch->{'srchtype'} ne '') {
7696: $curr_selected{'srchtype'} = $srch->{'srchtype'};
7697: }
7698: if ($srch->{'srchdomain'} ne '') {
7699: $currdom = $srch->{'srchdomain'};
7700: }
7701: $srchterm = $srch->{'srchterm'};
7702: }
7703: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 7704: 'usr' => 'Search criteria',
1.563 raeburn 7705: 'doma' => 'Domain/institution to search',
1.558 albertel 7706: 'uname' => 'username',
7707: 'lastname' => 'last name',
1.555 raeburn 7708: 'lastfirst' => 'last name, first name',
1.558 albertel 7709: 'crs' => 'in this course',
1.576 raeburn 7710: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 7711: 'alc' => 'all LON-CAPA',
1.573 raeburn 7712: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 7713: 'exact' => 'is',
7714: 'contains' => 'contains',
1.569 raeburn 7715: 'begins' => 'begins with',
1.571 raeburn 7716: 'youm' => "You must include some text to search for.",
7717: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
7718: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
7719: 'yomc' => "You must choose a domain when using an institutional directory search.",
7720: 'ymcd' => "You must choose a domain when using a domain search.",
7721: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
7722: 'whse' => "When searching by last,first you must include at least one character in the first name.",
7723: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 7724: );
1.563 raeburn 7725: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
7726: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 7727:
7728: my @srchins = ('crs','dom','alc','instd');
7729:
7730: foreach my $option (@srchins) {
7731: # FIXME 'alc' option unavailable until
7732: # loncreateuser::print_user_query_page()
7733: # has been completed.
7734: next if ($option eq 'alc');
1.880 raeburn 7735: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 7736: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 7737: if ($curr_selected{'srchin'} eq $option) {
7738: $srchinsel .= '
7739: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7740: } else {
7741: $srchinsel .= '
7742: <option value="'.$option.'">'.$lt{$option}.'</option>';
7743: }
1.555 raeburn 7744: }
1.563 raeburn 7745: $srchinsel .= "\n </select>\n";
1.555 raeburn 7746:
7747: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 7748: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 7749: if ($curr_selected{'srchby'} eq $option) {
7750: $srchbysel .= '
7751: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7752: } else {
7753: $srchbysel .= '
7754: <option value="'.$option.'">'.$lt{$option}.'</option>';
7755: }
7756: }
7757: $srchbysel .= "\n </select>\n";
7758:
7759: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 7760: foreach my $option ('begins','contains','exact') {
1.555 raeburn 7761: if ($curr_selected{'srchtype'} eq $option) {
7762: $srchtypesel .= '
7763: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7764: } else {
7765: $srchtypesel .= '
7766: <option value="'.$option.'">'.$lt{$option}.'</option>';
7767: }
7768: }
7769: $srchtypesel .= "\n </select>\n";
7770:
1.558 albertel 7771: my ($newuserscript,$new_user_create);
1.556 raeburn 7772:
7773: if ($forcenewuser) {
1.576 raeburn 7774: if (ref($srch) eq 'HASH') {
7775: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627 raeburn 7776: if ($cancreate) {
7777: $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>';
7778: } else {
1.799 bisitz 7779: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 7780: my %usertypetext = (
7781: official => 'institutional',
7782: unofficial => 'non-institutional',
7783: );
1.799 bisitz 7784: $new_user_create = '<p class="LC_warning">'
7785: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
7786: .' '
7787: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
7788: ,'<a href="'.$helplink.'">','</a>')
7789: .'</p><br />';
1.627 raeburn 7790: }
1.576 raeburn 7791: }
7792: }
7793:
1.556 raeburn 7794: $newuserscript = <<"ENDSCRIPT";
7795:
1.570 raeburn 7796: function setSearch(createnew,callingForm) {
1.556 raeburn 7797: if (createnew == 1) {
1.570 raeburn 7798: for (var i=0; i<callingForm.srchby.length; i++) {
7799: if (callingForm.srchby.options[i].value == 'uname') {
7800: callingForm.srchby.selectedIndex = i;
1.556 raeburn 7801: }
7802: }
1.570 raeburn 7803: for (var i=0; i<callingForm.srchin.length; i++) {
7804: if ( callingForm.srchin.options[i].value == 'dom') {
7805: callingForm.srchin.selectedIndex = i;
1.556 raeburn 7806: }
7807: }
1.570 raeburn 7808: for (var i=0; i<callingForm.srchtype.length; i++) {
7809: if (callingForm.srchtype.options[i].value == 'exact') {
7810: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 7811: }
7812: }
1.570 raeburn 7813: for (var i=0; i<callingForm.srchdomain.length; i++) {
7814: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
7815: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 7816: }
7817: }
7818: }
7819: }
7820: ENDSCRIPT
1.558 albertel 7821:
1.556 raeburn 7822: }
7823:
1.555 raeburn 7824: my $output = <<"END_BLOCK";
1.556 raeburn 7825: <script type="text/javascript">
1.824 bisitz 7826: // <![CDATA[
1.570 raeburn 7827: function validateEntry(callingForm) {
1.558 albertel 7828:
1.556 raeburn 7829: var checkok = 1;
1.558 albertel 7830: var srchin;
1.570 raeburn 7831: for (var i=0; i<callingForm.srchin.length; i++) {
7832: if ( callingForm.srchin[i].checked ) {
7833: srchin = callingForm.srchin[i].value;
1.558 albertel 7834: }
7835: }
7836:
1.570 raeburn 7837: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7838: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7839: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7840: var srchterm = callingForm.srchterm.value;
7841: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7842: var msg = "";
7843:
7844: if (srchterm == "") {
7845: checkok = 0;
1.571 raeburn 7846: msg += "$lt{'youm'}\\n";
1.556 raeburn 7847: }
7848:
1.569 raeburn 7849: if (srchtype== 'begins') {
7850: if (srchterm.length < 2) {
7851: checkok = 0;
1.571 raeburn 7852: msg += "$lt{'thte'}\\n";
1.569 raeburn 7853: }
7854: }
7855:
1.556 raeburn 7856: if (srchtype== 'contains') {
7857: if (srchterm.length < 3) {
7858: checkok = 0;
1.571 raeburn 7859: msg += "$lt{'thet'}\\n";
1.556 raeburn 7860: }
7861: }
7862: if (srchin == 'instd') {
7863: if (srchdomain == '') {
7864: checkok = 0;
1.571 raeburn 7865: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7866: }
7867: }
7868: if (srchin == 'dom') {
7869: if (srchdomain == '') {
7870: checkok = 0;
1.571 raeburn 7871: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7872: }
7873: }
7874: if (srchby == 'lastfirst') {
7875: if (srchterm.indexOf(",") == -1) {
7876: checkok = 0;
1.571 raeburn 7877: msg += "$lt{'whus'}\\n";
1.556 raeburn 7878: }
7879: if (srchterm.indexOf(",") == srchterm.length -1) {
7880: checkok = 0;
1.571 raeburn 7881: msg += "$lt{'whse'}\\n";
1.556 raeburn 7882: }
7883: }
7884: if (checkok == 0) {
1.571 raeburn 7885: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7886: return;
7887: }
7888: if (checkok == 1) {
1.570 raeburn 7889: callingForm.submit();
1.556 raeburn 7890: }
7891: }
7892:
7893: $newuserscript
7894:
1.824 bisitz 7895: // ]]>
1.556 raeburn 7896: </script>
1.558 albertel 7897:
7898: $new_user_create
7899:
1.555 raeburn 7900: END_BLOCK
1.558 albertel 7901:
1.876 raeburn 7902: $output .= &Apache::lonhtmlcommon::start_pick_box().
7903: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
7904: $domform.
7905: &Apache::lonhtmlcommon::row_closure().
7906: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
7907: $srchbysel.
7908: $srchtypesel.
7909: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
7910: $srchinsel.
7911: &Apache::lonhtmlcommon::row_closure(1).
7912: &Apache::lonhtmlcommon::end_pick_box().
7913: '<br />';
1.555 raeburn 7914: return $output;
7915: }
7916:
1.612 raeburn 7917: sub user_rule_check {
1.615 raeburn 7918: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 7919: my $response;
7920: if (ref($usershash) eq 'HASH') {
7921: foreach my $user (keys(%{$usershash})) {
7922: my ($uname,$udom) = split(/:/,$user);
7923: next if ($udom eq '' || $uname eq '');
1.615 raeburn 7924: my ($id,$newuser);
1.612 raeburn 7925: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 7926: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 7927: $id = $usershash->{$user}->{'id'};
7928: }
7929: my $inst_response;
7930: if (ref($checks) eq 'HASH') {
7931: if (defined($checks->{'username'})) {
1.615 raeburn 7932: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7933: &Apache::lonnet::get_instuser($udom,$uname);
7934: } elsif (defined($checks->{'id'})) {
1.615 raeburn 7935: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7936: &Apache::lonnet::get_instuser($udom,undef,$id);
7937: }
1.615 raeburn 7938: } else {
7939: ($inst_response,%{$inst_results->{$user}}) =
7940: &Apache::lonnet::get_instuser($udom,$uname);
7941: return;
1.612 raeburn 7942: }
1.615 raeburn 7943: if (!$got_rules->{$udom}) {
1.612 raeburn 7944: my %domconfig = &Apache::lonnet::get_dom('configuration',
7945: ['usercreation'],$udom);
7946: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 7947: foreach my $item ('username','id') {
1.612 raeburn 7948: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
7949: $$curr_rules{$udom}{$item} =
7950: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 7951: }
7952: }
7953: }
1.615 raeburn 7954: $got_rules->{$udom} = 1;
1.585 raeburn 7955: }
1.612 raeburn 7956: foreach my $item (keys(%{$checks})) {
7957: if (ref($$curr_rules{$udom}) eq 'HASH') {
7958: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
7959: if (@{$$curr_rules{$udom}{$item}} > 0) {
7960: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
7961: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
7962: if ($rule_check{$rule}) {
7963: $$rulematch{$user}{$item} = $rule;
7964: if ($inst_response eq 'ok') {
1.615 raeburn 7965: if (ref($inst_results) eq 'HASH') {
7966: if (ref($inst_results->{$user}) eq 'HASH') {
7967: if (keys(%{$inst_results->{$user}}) == 0) {
7968: $$alerts{$item}{$udom}{$uname} = 1;
7969: }
1.612 raeburn 7970: }
7971: }
1.615 raeburn 7972: }
7973: last;
1.585 raeburn 7974: }
7975: }
7976: }
7977: }
7978: }
7979: }
7980: }
7981: }
1.612 raeburn 7982: return;
7983: }
7984:
7985: sub user_rule_formats {
7986: my ($domain,$domdesc,$curr_rules,$check) = @_;
7987: my %text = (
7988: 'username' => 'Usernames',
7989: 'id' => 'IDs',
7990: );
7991: my $output;
7992: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
7993: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
7994: if (@{$ruleorder} > 0) {
7995: $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>';
7996: foreach my $rule (@{$ruleorder}) {
7997: if (ref($curr_rules) eq 'ARRAY') {
7998: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
7999: if (ref($rules->{$rule}) eq 'HASH') {
8000: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
8001: $rules->{$rule}{'desc'}.'</li>';
8002: }
8003: }
8004: }
8005: }
8006: $output .= '</ul>';
8007: }
8008: }
8009: return $output;
8010: }
8011:
8012: sub instrule_disallow_msg {
1.615 raeburn 8013: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 8014: my $response;
8015: my %text = (
8016: item => 'username',
8017: items => 'usernames',
8018: match => 'matches',
8019: do => 'does',
8020: action => 'a username',
8021: one => 'one',
8022: );
8023: if ($count > 1) {
8024: $text{'item'} = 'usernames';
8025: $text{'match'} ='match';
8026: $text{'do'} = 'do';
8027: $text{'action'} = 'usernames',
8028: $text{'one'} = 'ones';
8029: }
8030: if ($checkitem eq 'id') {
8031: $text{'items'} = 'IDs';
8032: $text{'item'} = 'ID';
8033: $text{'action'} = 'an ID';
1.615 raeburn 8034: if ($count > 1) {
8035: $text{'item'} = 'IDs';
8036: $text{'action'} = 'IDs';
8037: }
1.612 raeburn 8038: }
1.674 bisitz 8039: $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 8040: if ($mode eq 'upload') {
8041: if ($checkitem eq 'username') {
8042: $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'}.");
8043: } elsif ($checkitem eq 'id') {
1.674 bisitz 8044: $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 8045: }
1.669 raeburn 8046: } elsif ($mode eq 'selfcreate') {
8047: if ($checkitem eq 'id') {
8048: $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.");
8049: }
1.615 raeburn 8050: } else {
8051: if ($checkitem eq 'username') {
8052: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
8053: } elsif ($checkitem eq 'id') {
8054: $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.");
8055: }
1.612 raeburn 8056: }
8057: return $response;
1.585 raeburn 8058: }
8059:
1.624 raeburn 8060: sub personal_data_fieldtitles {
8061: my %fieldtitles = &Apache::lonlocal::texthash (
8062: id => 'Student/Employee ID',
8063: permanentemail => 'E-mail address',
8064: lastname => 'Last Name',
8065: firstname => 'First Name',
8066: middlename => 'Middle Name',
8067: generation => 'Generation',
8068: gen => 'Generation',
1.765 raeburn 8069: inststatus => 'Affiliation',
1.624 raeburn 8070: );
8071: return %fieldtitles;
8072: }
8073:
1.642 raeburn 8074: sub sorted_inst_types {
8075: my ($dom) = @_;
8076: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
8077: my $othertitle = &mt('All users');
8078: if ($env{'request.course.id'}) {
1.668 raeburn 8079: $othertitle = &mt('Any users');
1.642 raeburn 8080: }
8081: my @types;
8082: if (ref($order) eq 'ARRAY') {
8083: @types = @{$order};
8084: }
8085: if (@types == 0) {
8086: if (ref($usertypes) eq 'HASH') {
8087: @types = sort(keys(%{$usertypes}));
8088: }
8089: }
8090: if (keys(%{$usertypes}) > 0) {
8091: $othertitle = &mt('Other users');
8092: }
8093: return ($othertitle,$usertypes,\@types);
8094: }
8095:
1.645 raeburn 8096: sub get_institutional_codes {
8097: my ($settings,$allcourses,$LC_code) = @_;
8098: # Get complete list of course sections to update
8099: my @currsections = ();
8100: my @currxlists = ();
8101: my $coursecode = $$settings{'internal.coursecode'};
8102:
8103: if ($$settings{'internal.sectionnums'} ne '') {
8104: @currsections = split(/,/,$$settings{'internal.sectionnums'});
8105: }
8106:
8107: if ($$settings{'internal.crosslistings'} ne '') {
8108: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
8109: }
8110:
8111: if (@currxlists > 0) {
8112: foreach (@currxlists) {
8113: if (m/^([^:]+):(\w*)$/) {
8114: unless (grep/^$1$/,@{$allcourses}) {
8115: push @{$allcourses},$1;
8116: $$LC_code{$1} = $2;
8117: }
8118: }
8119: }
8120: }
8121:
8122: if (@currsections > 0) {
8123: foreach (@currsections) {
8124: if (m/^(\w+):(\w*)$/) {
8125: my $sec = $coursecode.$1;
8126: my $lc_sec = $2;
8127: unless (grep/^$sec$/,@{$allcourses}) {
8128: push @{$allcourses},$sec;
8129: $$LC_code{$sec} = $lc_sec;
8130: }
8131: }
8132: }
8133: }
8134: return;
8135: }
8136:
1.112 bowersj2 8137: =pod
8138:
1.780 raeburn 8139: =head1 Slot Helpers
8140:
8141: =over 4
8142:
8143: =item * sorted_slots()
8144:
8145: Sorts an array of slot names in order of slot start time (earliest first).
8146:
8147: Inputs:
8148:
8149: =over 4
8150:
8151: slotsarr - Reference to array of unsorted slot names.
8152:
8153: slots - Reference to hash of hash, where outer hash keys are slot names.
8154:
1.549 albertel 8155: =back
8156:
1.780 raeburn 8157: Returns:
8158:
8159: =over 4
8160:
8161: sorted - An array of slot names sorted by the start time of the slot.
8162:
8163: =back
8164:
8165: =back
8166:
8167: =cut
8168:
8169:
8170: sub sorted_slots {
8171: my ($slotsarr,$slots) = @_;
8172: my @sorted;
8173: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
8174: @sorted =
8175: sort {
8176: if (ref($slots->{$a}) && ref($slots->{$b})) {
8177: return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
8178: }
8179: if (ref($slots->{$a})) { return -1;}
8180: if (ref($slots->{$b})) { return 1;}
8181: return 0;
8182: } @{$slotsarr};
8183: }
8184: return @sorted;
8185: }
8186:
8187:
8188: =pod
8189:
1.549 albertel 8190: =head1 HTTP Helpers
8191:
8192: =over 4
8193:
1.648 raeburn 8194: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 8195:
1.258 albertel 8196: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 8197: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 8198: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 8199:
8200: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
8201: $possible_names is an ref to an array of form element names. As an example:
8202: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 8203: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 8204:
8205: =cut
1.1 albertel 8206:
1.6 albertel 8207: sub get_unprocessed_cgi {
1.25 albertel 8208: my ($query,$possible_names)= @_;
1.26 matthew 8209: # $Apache::lonxml::debug=1;
1.356 albertel 8210: foreach my $pair (split(/&/,$query)) {
8211: my ($name, $value) = split(/=/,$pair);
1.369 www 8212: $name = &unescape($name);
1.25 albertel 8213: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
8214: $value =~ tr/+/ /;
8215: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 8216: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 8217: }
1.16 harris41 8218: }
1.6 albertel 8219: }
8220:
1.112 bowersj2 8221: =pod
8222:
1.648 raeburn 8223: =item * &cacheheader()
1.112 bowersj2 8224:
8225: returns cache-controlling header code
8226:
8227: =cut
8228:
1.7 albertel 8229: sub cacheheader {
1.258 albertel 8230: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 8231: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
8232: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 8233: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
8234: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 8235: return $output;
1.7 albertel 8236: }
8237:
1.112 bowersj2 8238: =pod
8239:
1.648 raeburn 8240: =item * &no_cache($r)
1.112 bowersj2 8241:
8242: specifies header code to not have cache
8243:
8244: =cut
8245:
1.9 albertel 8246: sub no_cache {
1.216 albertel 8247: my ($r) = @_;
8248: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 8249: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 8250: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
8251: $r->no_cache(1);
8252: $r->header_out("Expires" => $date);
8253: $r->header_out("Pragma" => "no-cache");
1.123 www 8254: }
8255:
8256: sub content_type {
1.181 albertel 8257: my ($r,$type,$charset) = @_;
1.299 foxr 8258: if ($r) {
8259: # Note that printout.pl calls this with undef for $r.
8260: &no_cache($r);
8261: }
1.258 albertel 8262: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 8263: unless ($charset) {
8264: $charset=&Apache::lonlocal::current_encoding;
8265: }
8266: if ($charset) { $type.='; charset='.$charset; }
8267: if ($r) {
8268: $r->content_type($type);
8269: } else {
8270: print("Content-type: $type\n\n");
8271: }
1.9 albertel 8272: }
1.25 albertel 8273:
1.112 bowersj2 8274: =pod
8275:
1.648 raeburn 8276: =item * &add_to_env($name,$value)
1.112 bowersj2 8277:
1.258 albertel 8278: adds $name to the %env hash with value
1.112 bowersj2 8279: $value, if $name already exists, the entry is converted to an array
8280: reference and $value is added to the array.
8281:
8282: =cut
8283:
1.25 albertel 8284: sub add_to_env {
8285: my ($name,$value)=@_;
1.258 albertel 8286: if (defined($env{$name})) {
8287: if (ref($env{$name})) {
1.25 albertel 8288: #already have multiple values
1.258 albertel 8289: push(@{ $env{$name} },$value);
1.25 albertel 8290: } else {
8291: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 8292: my $first=$env{$name};
8293: undef($env{$name});
8294: push(@{ $env{$name} },$first,$value);
1.25 albertel 8295: }
8296: } else {
1.258 albertel 8297: $env{$name}=$value;
1.25 albertel 8298: }
1.31 albertel 8299: }
1.149 albertel 8300:
8301: =pod
8302:
1.648 raeburn 8303: =item * &get_env_multiple($name)
1.149 albertel 8304:
1.258 albertel 8305: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 8306: values may be defined and end up as an array ref.
8307:
8308: returns an array of values
8309:
8310: =cut
8311:
8312: sub get_env_multiple {
8313: my ($name) = @_;
8314: my @values;
1.258 albertel 8315: if (defined($env{$name})) {
1.149 albertel 8316: # exists is it an array
1.258 albertel 8317: if (ref($env{$name})) {
8318: @values=@{ $env{$name} };
1.149 albertel 8319: } else {
1.258 albertel 8320: $values[0]=$env{$name};
1.149 albertel 8321: }
8322: }
8323: return(@values);
8324: }
8325:
1.660 raeburn 8326: sub ask_for_embedded_content {
8327: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
8328: my $upload_output = '
8329: <form name="upload_embedded" action="'.$actionurl.'"
8330: method="post" enctype="multipart/form-data">';
8331: $upload_output .= $state;
1.661 raeburn 8332: $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660 raeburn 8333:
8334: my $num = 0;
8335: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
8336: $upload_output .= &start_data_table_row().
8337: '<td>'.$embed_file.'</td><td>';
8338: if ($args->{'ignore_remote_references'}
8339: && $embed_file =~ m{^\w+://}) {
8340: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
8341: } elsif ($args->{'error_on_invalid_names'}
8342: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
8343:
8344: $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
8345:
8346: } else {
8347: $upload_output .='
1.661 raeburn 8348: <input name="embedded_item_'.$num.'" type="file" value="" />
1.660 raeburn 8349: <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
8350: my $attrib = join(':',@{$$allfiles{$embed_file}});
8351: $upload_output .=
8352: "\n\t\t".
8353: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
8354: $attrib.'" />';
8355: if (exists($$codebase{$embed_file})) {
8356: $upload_output .=
8357: "\n\t\t".
8358: '<input name="codebase_'.$num.'" type="hidden" value="'.
8359: &escape($$codebase{$embed_file}).'" />';
8360: }
8361: }
8362: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
8363: $num++;
8364: }
8365: $upload_output .= &Apache::loncommon::end_data_table().'<br />
8366: <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
8367: <input type ="submit" value="'.&mt('Upload Listed Files').'" />
8368: '.&mt('(only files for which a location has been provided will be uploaded)').'
8369: </form>';
8370: return $upload_output;
8371: }
8372:
1.661 raeburn 8373: sub upload_embedded {
8374: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
8375: $current_disk_usage) = @_;
8376: my $output;
8377: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
8378: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
8379: my $orig_uploaded_filename =
8380: $env{'form.embedded_item_'.$i.'.filename'};
8381:
8382: $env{'form.embedded_orig_'.$i} =
8383: &unescape($env{'form.embedded_orig_'.$i});
8384: my ($path,$fname) =
8385: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
8386: # no path, whole string is fname
8387: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
8388:
8389: $path = $env{'form.currentpath'}.$path;
8390: $fname = &Apache::lonnet::clean_filename($fname);
8391: # See if there is anything left
8392: next if ($fname eq '');
8393:
8394: # Check if file already exists as a file or directory.
8395: my ($state,$msg);
8396: if ($context eq 'portfolio') {
8397: my $port_path = $dirpath;
8398: if ($group ne '') {
8399: $port_path = "groups/$group/$port_path";
8400: }
8401: ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
8402: $dir_root,$port_path,$disk_quota,
8403: $current_disk_usage,$uname,$udom);
8404: if ($state eq 'will_exceed_quota'
8405: || $state eq 'file_locked'
8406: || $state eq 'file_exists' ) {
8407: $output .= $msg;
8408: next;
8409: }
8410: } elsif (($context eq 'author') || ($context eq 'testbank')) {
8411: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
8412: if ($state eq 'exists') {
8413: $output .= $msg;
8414: next;
8415: }
8416: }
8417: # Check if extension is valid
8418: if (($fname =~ /\.(\w+)$/) &&
8419: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
8420: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
8421: next;
8422: } elsif (($fname =~ /\.(\w+)$/) &&
8423: (!defined(&Apache::loncommon::fileembstyle($1)))) {
8424: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
8425: next;
8426: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
8427: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
8428: next;
8429: }
8430:
8431: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
8432: if ($context eq 'portfolio') {
8433: my $result=
8434: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
8435: $dirpath.$path);
8436: if ($result !~ m|^/uploaded/|) {
8437: $output .= '<span class="LC_error">'
8438: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
8439: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
8440: .'</span><br />';
8441: next;
8442: } else {
8443: $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
8444: $path.$fname.'</span>').'</p>';
8445: }
8446: } else {
8447: # Save the file
8448: my $target = $env{'form.embedded_item_'.$i};
8449: my $fullpath = $dir_root.$dirpath.'/'.$path;
8450: my $dest = $fullpath.$fname;
8451: my $url = $url_root.$dirpath.'/'.$path.$fname;
8452: my @parts=split(/\//,$fullpath);
8453: my $count;
8454: my $filepath = $dir_root;
8455: for ($count=4;$count<=$#parts;$count++) {
8456: $filepath .= "/$parts[$count]";
8457: if ((-e $filepath)!=1) {
8458: mkdir($filepath,0770);
8459: }
8460: }
8461: my $fh;
8462: if (!open($fh,'>'.$dest)) {
8463: &Apache::lonnet::logthis('Failed to create '.$dest);
8464: $output .= '<span class="LC_error">'.
8465: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8466: '</span><br />';
8467: } else {
8468: if (!print $fh $env{'form.embedded_item_'.$i}) {
8469: &Apache::lonnet::logthis('Failed to write to '.$dest);
8470: $output .= '<span class="LC_error">'.
8471: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8472: '</span><br />';
8473: } else {
8474: if ($context eq 'testbank') {
8475: $output .= &mt('Embedded file uploaded successfully:').
8476: ' <a href="'.$url.'">'.
8477: $orig_uploaded_filename.'</a><br />';
8478: } else {
1.705 tempelho 8479: $output .= '<span class=\"LC_fontsize_large\">'.
1.661 raeburn 8480: &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705 tempelho 8481: $orig_uploaded_filename.'</a>').'</span><br />';
1.661 raeburn 8482: }
8483: }
8484: close($fh);
8485: }
8486: }
8487: }
8488: return $output;
8489: }
8490:
8491: sub check_for_existing {
8492: my ($path,$fname,$element) = @_;
8493: my ($state,$msg);
8494: if (-d $path.'/'.$fname) {
8495: $state = 'exists';
8496: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8497: } elsif (-e $path.'/'.$fname) {
8498: $state = 'exists';
8499: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8500: }
8501: if ($state eq 'exists') {
8502: $msg = '<span class="LC_error">'.$msg.'</span><br />';
8503: }
8504: return ($state,$msg);
8505: }
8506:
8507: sub check_for_upload {
8508: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
8509: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
8510: my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
8511: my $getpropath = 1;
8512: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
8513: $getpropath);
8514: my $found_file = 0;
8515: my $locked_file = 0;
8516: foreach my $line (@dir_list) {
8517: my ($file_name)=split(/\&/,$line,2);
8518: if ($file_name eq $fname){
8519: $file_name = $path.$file_name;
8520: if ($group ne '') {
8521: $file_name = $group.$file_name;
8522: }
8523: $found_file = 1;
8524: if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
8525: $locked_file = 1;
8526: }
8527: }
8528: }
8529: if (($current_disk_usage + $filesize) > $disk_quota){
8530: my $msg = '<span class="LC_error">'.
8531: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
8532: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
8533: return ('will_exceed_quota',$msg);
8534: } elsif ($found_file) {
8535: if ($locked_file) {
8536: my $msg = '<span class="LC_error">';
8537: $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>');
8538: $msg .= '</span><br />';
8539: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
8540: return ('file_locked',$msg);
8541: } else {
8542: my $msg = '<span class="LC_error">';
8543: $msg .= &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$port_path.$env{'form.currentpath'});
8544: $msg .= '</span>';
8545: $msg .= '<br />';
8546: $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
8547: return ('file_exists',$msg);
8548: }
8549: }
8550: }
8551:
1.31 albertel 8552:
1.41 ng 8553: =pod
1.45 matthew 8554:
1.464 albertel 8555: =back
1.41 ng 8556:
1.112 bowersj2 8557: =head1 CSV Upload/Handling functions
1.38 albertel 8558:
1.41 ng 8559: =over 4
8560:
1.648 raeburn 8561: =item * &upfile_store($r)
1.41 ng 8562:
8563: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 8564: needs $env{'form.upfile'}
1.41 ng 8565: returns $datatoken to be put into hidden field
8566:
8567: =cut
1.31 albertel 8568:
8569: sub upfile_store {
8570: my $r=shift;
1.258 albertel 8571: $env{'form.upfile'}=~s/\r/\n/gs;
8572: $env{'form.upfile'}=~s/\f/\n/gs;
8573: $env{'form.upfile'}=~s/\n+/\n/gs;
8574: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 8575:
1.258 albertel 8576: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
8577: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 8578: {
1.158 raeburn 8579: my $datafile = $r->dir_config('lonDaemons').
8580: '/tmp/'.$datatoken.'.tmp';
8581: if ( open(my $fh,">$datafile") ) {
1.258 albertel 8582: print $fh $env{'form.upfile'};
1.158 raeburn 8583: close($fh);
8584: }
1.31 albertel 8585: }
8586: return $datatoken;
8587: }
8588:
1.56 matthew 8589: =pod
8590:
1.648 raeburn 8591: =item * &load_tmp_file($r)
1.41 ng 8592:
8593: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 8594: needs $env{'form.datatoken'},
8595: sets $env{'form.upfile'} to the contents of the file
1.41 ng 8596:
8597: =cut
1.31 albertel 8598:
8599: sub load_tmp_file {
8600: my $r=shift;
8601: my @studentdata=();
8602: {
1.158 raeburn 8603: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 8604: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 8605: if ( open(my $fh,"<$studentfile") ) {
8606: @studentdata=<$fh>;
8607: close($fh);
8608: }
1.31 albertel 8609: }
1.258 albertel 8610: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 8611: }
8612:
1.56 matthew 8613: =pod
8614:
1.648 raeburn 8615: =item * &upfile_record_sep()
1.41 ng 8616:
8617: Separate uploaded file into records
8618: returns array of records,
1.258 albertel 8619: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 8620:
8621: =cut
1.31 albertel 8622:
8623: sub upfile_record_sep {
1.258 albertel 8624: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 8625: } else {
1.248 albertel 8626: my @records;
1.258 albertel 8627: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 8628: if ($line=~/^\s*$/) { next; }
8629: push(@records,$line);
8630: }
8631: return @records;
1.31 albertel 8632: }
8633: }
8634:
1.56 matthew 8635: =pod
8636:
1.648 raeburn 8637: =item * &record_sep($record)
1.41 ng 8638:
1.258 albertel 8639: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 8640:
8641: =cut
8642:
1.263 www 8643: sub takeleft {
8644: my $index=shift;
8645: return substr('0000'.$index,-4,4);
8646: }
8647:
1.31 albertel 8648: sub record_sep {
8649: my $record=shift;
8650: my %components=();
1.258 albertel 8651: if ($env{'form.upfiletype'} eq 'xml') {
8652: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 8653: my $i=0;
1.356 albertel 8654: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 8655: $field=~s/^(\"|\')//;
8656: $field=~s/(\"|\')$//;
1.263 www 8657: $components{&takeleft($i)}=$field;
1.31 albertel 8658: $i++;
8659: }
1.258 albertel 8660: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 8661: my $i=0;
1.356 albertel 8662: foreach my $field (split(/\t/,$record)) {
1.31 albertel 8663: $field=~s/^(\"|\')//;
8664: $field=~s/(\"|\')$//;
1.263 www 8665: $components{&takeleft($i)}=$field;
1.31 albertel 8666: $i++;
8667: }
8668: } else {
1.561 www 8669: my $separator=',';
1.480 banghart 8670: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 8671: $separator=';';
1.480 banghart 8672: }
1.31 albertel 8673: my $i=0;
1.561 www 8674: # the character we are looking for to indicate the end of a quote or a record
8675: my $looking_for=$separator;
8676: # do not add the characters to the fields
8677: my $ignore=0;
8678: # we just encountered a separator (or the beginning of the record)
8679: my $just_found_separator=1;
8680: # store the field we are working on here
8681: my $field='';
8682: # work our way through all characters in record
8683: foreach my $character ($record=~/(.)/g) {
8684: if ($character eq $looking_for) {
8685: if ($character ne $separator) {
8686: # Found the end of a quote, again looking for separator
8687: $looking_for=$separator;
8688: $ignore=1;
8689: } else {
8690: # Found a separator, store away what we got
8691: $components{&takeleft($i)}=$field;
8692: $i++;
8693: $just_found_separator=1;
8694: $ignore=0;
8695: $field='';
8696: }
8697: next;
8698: }
8699: # single or double quotation marks after a separator indicate beginning of a quote
8700: # we are now looking for the end of the quote and need to ignore separators
8701: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
8702: $looking_for=$character;
8703: next;
8704: }
8705: # ignore would be true after we reached the end of a quote
8706: if ($ignore) { next; }
8707: if (($just_found_separator) && ($character=~/\s/)) { next; }
8708: $field.=$character;
8709: $just_found_separator=0;
1.31 albertel 8710: }
1.561 www 8711: # catch the very last entry, since we never encountered the separator
8712: $components{&takeleft($i)}=$field;
1.31 albertel 8713: }
8714: return %components;
8715: }
8716:
1.144 matthew 8717: ######################################################
8718: ######################################################
8719:
1.56 matthew 8720: =pod
8721:
1.648 raeburn 8722: =item * &upfile_select_html()
1.41 ng 8723:
1.144 matthew 8724: Return HTML code to select a file from the users machine and specify
8725: the file type.
1.41 ng 8726:
8727: =cut
8728:
1.144 matthew 8729: ######################################################
8730: ######################################################
1.31 albertel 8731: sub upfile_select_html {
1.144 matthew 8732: my %Types = (
8733: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 8734: semisv => &mt('Semicolon separated values'),
1.144 matthew 8735: space => &mt('Space separated'),
8736: tab => &mt('Tabulator separated'),
8737: # xml => &mt('HTML/XML'),
8738: );
8739: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 8740: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 8741: foreach my $type (sort(keys(%Types))) {
8742: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
8743: }
8744: $Str .= "</select>\n";
8745: return $Str;
1.31 albertel 8746: }
8747:
1.301 albertel 8748: sub get_samples {
8749: my ($records,$toget) = @_;
8750: my @samples=({});
8751: my $got=0;
8752: foreach my $rec (@$records) {
8753: my %temp = &record_sep($rec);
8754: if (! grep(/\S/, values(%temp))) { next; }
8755: if (%temp) {
8756: $samples[$got]=\%temp;
8757: $got++;
8758: if ($got == $toget) { last; }
8759: }
8760: }
8761: return \@samples;
8762: }
8763:
1.144 matthew 8764: ######################################################
8765: ######################################################
8766:
1.56 matthew 8767: =pod
8768:
1.648 raeburn 8769: =item * &csv_print_samples($r,$records)
1.41 ng 8770:
8771: Prints a table of sample values from each column uploaded $r is an
8772: Apache Request ref, $records is an arrayref from
8773: &Apache::loncommon::upfile_record_sep
8774:
8775: =cut
8776:
1.144 matthew 8777: ######################################################
8778: ######################################################
1.31 albertel 8779: sub csv_print_samples {
8780: my ($r,$records) = @_;
1.662 bisitz 8781: my $samples = &get_samples($records,5);
1.301 albertel 8782:
1.594 raeburn 8783: $r->print(&mt('Samples').'<br />'.&start_data_table().
8784: &start_data_table_header_row());
1.356 albertel 8785: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 8786: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 8787: $r->print(&end_data_table_header_row());
1.301 albertel 8788: foreach my $hash (@$samples) {
1.594 raeburn 8789: $r->print(&start_data_table_row());
1.356 albertel 8790: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 8791: $r->print('<td>');
1.356 albertel 8792: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 8793: $r->print('</td>');
8794: }
1.594 raeburn 8795: $r->print(&end_data_table_row());
1.31 albertel 8796: }
1.594 raeburn 8797: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 8798: }
8799:
1.144 matthew 8800: ######################################################
8801: ######################################################
8802:
1.56 matthew 8803: =pod
8804:
1.648 raeburn 8805: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 8806:
8807: Prints a table to create associations between values and table columns.
1.144 matthew 8808:
1.41 ng 8809: $r is an Apache Request ref,
8810: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 8811: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 8812:
8813: =cut
8814:
1.144 matthew 8815: ######################################################
8816: ######################################################
1.31 albertel 8817: sub csv_print_select_table {
8818: my ($r,$records,$d) = @_;
1.301 albertel 8819: my $i=0;
8820: my $samples = &get_samples($records,1);
1.144 matthew 8821: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 8822: &start_data_table().&start_data_table_header_row().
1.144 matthew 8823: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 8824: '<th>'.&mt('Column').'</th>'.
8825: &end_data_table_header_row()."\n");
1.356 albertel 8826: foreach my $array_ref (@$d) {
8827: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 8828: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 8829:
1.875 bisitz 8830: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 8831: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 8832: $r->print('<option value="none"></option>');
1.356 albertel 8833: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8834: $r->print('<option value="'.$sample.'"'.
8835: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 8836: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 8837: }
1.594 raeburn 8838: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 8839: $i++;
8840: }
1.594 raeburn 8841: $r->print(&end_data_table());
1.31 albertel 8842: $i--;
8843: return $i;
8844: }
1.56 matthew 8845:
1.144 matthew 8846: ######################################################
8847: ######################################################
8848:
1.56 matthew 8849: =pod
1.31 albertel 8850:
1.648 raeburn 8851: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 8852:
8853: Prints a table of sample values from the upload and can make associate samples to internal names.
8854:
8855: $r is an Apache Request ref,
8856: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
8857: $d is an array of 2 element arrays (internal name, displayed name)
8858:
8859: =cut
8860:
1.144 matthew 8861: ######################################################
8862: ######################################################
1.31 albertel 8863: sub csv_samples_select_table {
8864: my ($r,$records,$d) = @_;
8865: my $i=0;
1.144 matthew 8866: #
1.662 bisitz 8867: my $max_samples = 5;
8868: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 8869: $r->print(&start_data_table().
8870: &start_data_table_header_row().'<th>'.
8871: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
8872: &end_data_table_header_row());
1.301 albertel 8873:
8874: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 8875: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 8876: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 8877: foreach my $option (@$d) {
8878: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 8879: $r->print('<option value="'.$value.'"'.
1.253 albertel 8880: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 8881: $display.'</option>');
1.31 albertel 8882: }
8883: $r->print('</select></td><td>');
1.662 bisitz 8884: foreach my $line (0..($max_samples-1)) {
1.301 albertel 8885: if (defined($samples->[$line]{$key})) {
8886: $r->print($samples->[$line]{$key}."<br />\n");
8887: }
8888: }
1.594 raeburn 8889: $r->print('</td>'.&end_data_table_row());
1.31 albertel 8890: $i++;
8891: }
1.594 raeburn 8892: $r->print(&end_data_table());
1.31 albertel 8893: $i--;
8894: return($i);
1.115 matthew 8895: }
8896:
1.144 matthew 8897: ######################################################
8898: ######################################################
8899:
1.115 matthew 8900: =pod
8901:
1.648 raeburn 8902: =item * &clean_excel_name($name)
1.115 matthew 8903:
8904: Returns a replacement for $name which does not contain any illegal characters.
8905:
8906: =cut
8907:
1.144 matthew 8908: ######################################################
8909: ######################################################
1.115 matthew 8910: sub clean_excel_name {
8911: my ($name) = @_;
8912: $name =~ s/[:\*\?\/\\]//g;
8913: if (length($name) > 31) {
8914: $name = substr($name,0,31);
8915: }
8916: return $name;
1.25 albertel 8917: }
1.84 albertel 8918:
1.85 albertel 8919: =pod
8920:
1.648 raeburn 8921: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 8922:
8923: Returns either 1 or undef
8924:
8925: 1 if the part is to be hidden, undef if it is to be shown
8926:
8927: Arguments are:
8928:
8929: $id the id of the part to be checked
8930: $symb, optional the symb of the resource to check
8931: $udom, optional the domain of the user to check for
8932: $uname, optional the username of the user to check for
8933:
8934: =cut
1.84 albertel 8935:
8936: sub check_if_partid_hidden {
8937: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 8938: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 8939: $symb,$udom,$uname);
1.141 albertel 8940: my $truth=1;
8941: #if the string starts with !, then the list is the list to show not hide
8942: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 8943: my @hiddenlist=split(/,/,$hiddenparts);
8944: foreach my $checkid (@hiddenlist) {
1.141 albertel 8945: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 8946: }
1.141 albertel 8947: return !$truth;
1.84 albertel 8948: }
1.127 matthew 8949:
1.138 matthew 8950:
8951: ############################################################
8952: ############################################################
8953:
8954: =pod
8955:
1.157 matthew 8956: =back
8957:
1.138 matthew 8958: =head1 cgi-bin script and graphing routines
8959:
1.157 matthew 8960: =over 4
8961:
1.648 raeburn 8962: =item * &get_cgi_id()
1.138 matthew 8963:
8964: Inputs: none
8965:
8966: Returns an id which can be used to pass environment variables
8967: to various cgi-bin scripts. These environment variables will
8968: be removed from the users environment after a given time by
8969: the routine &Apache::lonnet::transfer_profile_to_env.
8970:
8971: =cut
8972:
8973: ############################################################
8974: ############################################################
1.152 albertel 8975: my $uniq=0;
1.136 matthew 8976: sub get_cgi_id {
1.154 albertel 8977: $uniq=($uniq+1)%100000;
1.280 albertel 8978: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 8979: }
8980:
1.127 matthew 8981: ############################################################
8982: ############################################################
8983:
8984: =pod
8985:
1.648 raeburn 8986: =item * &DrawBarGraph()
1.127 matthew 8987:
1.138 matthew 8988: Facilitates the plotting of data in a (stacked) bar graph.
8989: Puts plot definition data into the users environment in order for
8990: graph.png to plot it. Returns an <img> tag for the plot.
8991: The bars on the plot are labeled '1','2',...,'n'.
8992:
8993: Inputs:
8994:
8995: =over 4
8996:
8997: =item $Title: string, the title of the plot
8998:
8999: =item $xlabel: string, text describing the X-axis of the plot
9000:
9001: =item $ylabel: string, text describing the Y-axis of the plot
9002:
9003: =item $Max: scalar, the maximum Y value to use in the plot
9004: If $Max is < any data point, the graph will not be rendered.
9005:
1.140 matthew 9006: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 9007: they are plotted. If undefined, default values will be used.
9008:
1.178 matthew 9009: =item $labels: array ref holding the labels to use on the x-axis for the bars.
9010:
1.138 matthew 9011: =item @Values: An array of array references. Each array reference holds data
9012: to be plotted in a stacked bar chart.
9013:
1.239 matthew 9014: =item If the final element of @Values is a hash reference the key/value
9015: pairs will be added to the graph definition.
9016:
1.138 matthew 9017: =back
9018:
9019: Returns:
9020:
9021: An <img> tag which references graph.png and the appropriate identifying
9022: information for the plot.
9023:
1.127 matthew 9024: =cut
9025:
9026: ############################################################
9027: ############################################################
1.134 matthew 9028: sub DrawBarGraph {
1.178 matthew 9029: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 9030: #
9031: if (! defined($colors)) {
9032: $colors = ['#33ff00',
9033: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
9034: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
9035: ];
9036: }
1.228 matthew 9037: my $extra_settings = {};
9038: if (ref($Values[-1]) eq 'HASH') {
9039: $extra_settings = pop(@Values);
9040: }
1.127 matthew 9041: #
1.136 matthew 9042: my $identifier = &get_cgi_id();
9043: my $id = 'cgi.'.$identifier;
1.129 matthew 9044: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 9045: return '';
9046: }
1.225 matthew 9047: #
9048: my @Labels;
9049: if (defined($labels)) {
9050: @Labels = @$labels;
9051: } else {
9052: for (my $i=0;$i<@{$Values[0]};$i++) {
9053: push (@Labels,$i+1);
9054: }
9055: }
9056: #
1.129 matthew 9057: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 9058: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 9059: my %ValuesHash;
9060: my $NumSets=1;
9061: foreach my $array (@Values) {
9062: next if (! ref($array));
1.136 matthew 9063: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 9064: join(',',@$array);
1.129 matthew 9065: }
1.127 matthew 9066: #
1.136 matthew 9067: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 9068: if ($NumBars < 3) {
9069: $width = 120+$NumBars*32;
1.220 matthew 9070: $xskip = 1;
1.225 matthew 9071: $bar_width = 30;
9072: } elsif ($NumBars < 5) {
9073: $width = 120+$NumBars*20;
9074: $xskip = 1;
9075: $bar_width = 20;
1.220 matthew 9076: } elsif ($NumBars < 10) {
1.136 matthew 9077: $width = 120+$NumBars*15;
9078: $xskip = 1;
9079: $bar_width = 15;
9080: } elsif ($NumBars <= 25) {
9081: $width = 120+$NumBars*11;
9082: $xskip = 5;
9083: $bar_width = 8;
9084: } elsif ($NumBars <= 50) {
9085: $width = 120+$NumBars*8;
9086: $xskip = 5;
9087: $bar_width = 4;
9088: } else {
9089: $width = 120+$NumBars*8;
9090: $xskip = 5;
9091: $bar_width = 4;
9092: }
9093: #
1.137 matthew 9094: $Max = 1 if ($Max < 1);
9095: if ( int($Max) < $Max ) {
9096: $Max++;
9097: $Max = int($Max);
9098: }
1.127 matthew 9099: $Title = '' if (! defined($Title));
9100: $xlabel = '' if (! defined($xlabel));
9101: $ylabel = '' if (! defined($ylabel));
1.369 www 9102: $ValuesHash{$id.'.title'} = &escape($Title);
9103: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
9104: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 9105: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 9106: $ValuesHash{$id.'.NumBars'} = $NumBars;
9107: $ValuesHash{$id.'.NumSets'} = $NumSets;
9108: $ValuesHash{$id.'.PlotType'} = 'bar';
9109: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9110: $ValuesHash{$id.'.height'} = $height;
9111: $ValuesHash{$id.'.width'} = $width;
9112: $ValuesHash{$id.'.xskip'} = $xskip;
9113: $ValuesHash{$id.'.bar_width'} = $bar_width;
9114: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 9115: #
1.228 matthew 9116: # Deal with other parameters
9117: while (my ($key,$value) = each(%$extra_settings)) {
9118: $ValuesHash{$id.'.'.$key} = $value;
9119: }
9120: #
1.646 raeburn 9121: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 9122: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9123: }
9124:
9125: ############################################################
9126: ############################################################
9127:
9128: =pod
9129:
1.648 raeburn 9130: =item * &DrawXYGraph()
1.137 matthew 9131:
1.138 matthew 9132: Facilitates the plotting of data in an XY graph.
9133: Puts plot definition data into the users environment in order for
9134: graph.png to plot it. Returns an <img> tag for the plot.
9135:
9136: Inputs:
9137:
9138: =over 4
9139:
9140: =item $Title: string, the title of the plot
9141:
9142: =item $xlabel: string, text describing the X-axis of the plot
9143:
9144: =item $ylabel: string, text describing the Y-axis of the plot
9145:
9146: =item $Max: scalar, the maximum Y value to use in the plot
9147: If $Max is < any data point, the graph will not be rendered.
9148:
9149: =item $colors: Array ref containing the hex color codes for the data to be
9150: plotted in. If undefined, default values will be used.
9151:
9152: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9153:
9154: =item $Ydata: Array ref containing Array refs.
1.185 www 9155: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 9156:
9157: =item %Values: hash indicating or overriding any default values which are
9158: passed to graph.png.
9159: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9160:
9161: =back
9162:
9163: Returns:
9164:
9165: An <img> tag which references graph.png and the appropriate identifying
9166: information for the plot.
9167:
1.137 matthew 9168: =cut
9169:
9170: ############################################################
9171: ############################################################
9172: sub DrawXYGraph {
9173: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
9174: #
9175: # Create the identifier for the graph
9176: my $identifier = &get_cgi_id();
9177: my $id = 'cgi.'.$identifier;
9178: #
9179: $Title = '' if (! defined($Title));
9180: $xlabel = '' if (! defined($xlabel));
9181: $ylabel = '' if (! defined($ylabel));
9182: my %ValuesHash =
9183: (
1.369 www 9184: $id.'.title' => &escape($Title),
9185: $id.'.xlabel' => &escape($xlabel),
9186: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 9187: $id.'.y_max_value'=> $Max,
9188: $id.'.labels' => join(',',@$Xlabels),
9189: $id.'.PlotType' => 'XY',
9190: );
9191: #
9192: if (defined($colors) && ref($colors) eq 'ARRAY') {
9193: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9194: }
9195: #
9196: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
9197: return '';
9198: }
9199: my $NumSets=1;
1.138 matthew 9200: foreach my $array (@{$Ydata}){
1.137 matthew 9201: next if (! ref($array));
9202: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
9203: }
1.138 matthew 9204: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 9205: #
9206: # Deal with other parameters
9207: while (my ($key,$value) = each(%Values)) {
9208: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 9209: }
9210: #
1.646 raeburn 9211: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 9212: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9213: }
9214:
9215: ############################################################
9216: ############################################################
9217:
9218: =pod
9219:
1.648 raeburn 9220: =item * &DrawXYYGraph()
1.138 matthew 9221:
9222: Facilitates the plotting of data in an XY graph with two Y axes.
9223: Puts plot definition data into the users environment in order for
9224: graph.png to plot it. Returns an <img> tag for the plot.
9225:
9226: Inputs:
9227:
9228: =over 4
9229:
9230: =item $Title: string, the title of the plot
9231:
9232: =item $xlabel: string, text describing the X-axis of the plot
9233:
9234: =item $ylabel: string, text describing the Y-axis of the plot
9235:
9236: =item $colors: Array ref containing the hex color codes for the data to be
9237: plotted in. If undefined, default values will be used.
9238:
9239: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9240:
9241: =item $Ydata1: The first data set
9242:
9243: =item $Min1: The minimum value of the left Y-axis
9244:
9245: =item $Max1: The maximum value of the left Y-axis
9246:
9247: =item $Ydata2: The second data set
9248:
9249: =item $Min2: The minimum value of the right Y-axis
9250:
9251: =item $Max2: The maximum value of the left Y-axis
9252:
9253: =item %Values: hash indicating or overriding any default values which are
9254: passed to graph.png.
9255: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9256:
9257: =back
9258:
9259: Returns:
9260:
9261: An <img> tag which references graph.png and the appropriate identifying
9262: information for the plot.
1.136 matthew 9263:
9264: =cut
9265:
9266: ############################################################
9267: ############################################################
1.137 matthew 9268: sub DrawXYYGraph {
9269: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
9270: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 9271: #
9272: # Create the identifier for the graph
9273: my $identifier = &get_cgi_id();
9274: my $id = 'cgi.'.$identifier;
9275: #
9276: $Title = '' if (! defined($Title));
9277: $xlabel = '' if (! defined($xlabel));
9278: $ylabel = '' if (! defined($ylabel));
9279: my %ValuesHash =
9280: (
1.369 www 9281: $id.'.title' => &escape($Title),
9282: $id.'.xlabel' => &escape($xlabel),
9283: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 9284: $id.'.labels' => join(',',@$Xlabels),
9285: $id.'.PlotType' => 'XY',
9286: $id.'.NumSets' => 2,
1.137 matthew 9287: $id.'.two_axes' => 1,
9288: $id.'.y1_max_value' => $Max1,
9289: $id.'.y1_min_value' => $Min1,
9290: $id.'.y2_max_value' => $Max2,
9291: $id.'.y2_min_value' => $Min2,
1.136 matthew 9292: );
9293: #
1.137 matthew 9294: if (defined($colors) && ref($colors) eq 'ARRAY') {
9295: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9296: }
9297: #
9298: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
9299: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 9300: return '';
9301: }
9302: my $NumSets=1;
1.137 matthew 9303: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 9304: next if (! ref($array));
9305: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 9306: }
9307: #
9308: # Deal with other parameters
9309: while (my ($key,$value) = each(%Values)) {
9310: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 9311: }
9312: #
1.646 raeburn 9313: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 9314: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 9315: }
9316:
9317: ############################################################
9318: ############################################################
9319:
9320: =pod
9321:
1.157 matthew 9322: =back
9323:
1.139 matthew 9324: =head1 Statistics helper routines?
9325:
9326: Bad place for them but what the hell.
9327:
1.157 matthew 9328: =over 4
9329:
1.648 raeburn 9330: =item * &chartlink()
1.139 matthew 9331:
9332: Returns a link to the chart for a specific student.
9333:
9334: Inputs:
9335:
9336: =over 4
9337:
9338: =item $linktext: The text of the link
9339:
9340: =item $sname: The students username
9341:
9342: =item $sdomain: The students domain
9343:
9344: =back
9345:
1.157 matthew 9346: =back
9347:
1.139 matthew 9348: =cut
9349:
9350: ############################################################
9351: ############################################################
9352: sub chartlink {
9353: my ($linktext, $sname, $sdomain) = @_;
9354: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 9355: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 9356: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 9357: '">'.$linktext.'</a>';
1.153 matthew 9358: }
9359:
9360: #######################################################
9361: #######################################################
9362:
9363: =pod
9364:
9365: =head1 Course Environment Routines
1.157 matthew 9366:
9367: =over 4
1.153 matthew 9368:
1.648 raeburn 9369: =item * &restore_course_settings()
1.153 matthew 9370:
1.648 raeburn 9371: =item * &store_course_settings()
1.153 matthew 9372:
9373: Restores/Store indicated form parameters from the course environment.
9374: Will not overwrite existing values of the form parameters.
9375:
9376: Inputs:
9377: a scalar describing the data (e.g. 'chart', 'problem_analysis')
9378:
9379: a hash ref describing the data to be stored. For example:
9380:
9381: %Save_Parameters = ('Status' => 'scalar',
9382: 'chartoutputmode' => 'scalar',
9383: 'chartoutputdata' => 'scalar',
9384: 'Section' => 'array',
1.373 raeburn 9385: 'Group' => 'array',
1.153 matthew 9386: 'StudentData' => 'array',
9387: 'Maps' => 'array');
9388:
9389: Returns: both routines return nothing
9390:
1.631 raeburn 9391: =back
9392:
1.153 matthew 9393: =cut
9394:
9395: #######################################################
9396: #######################################################
9397: sub store_course_settings {
1.496 albertel 9398: return &store_settings($env{'request.course.id'},@_);
9399: }
9400:
9401: sub store_settings {
1.153 matthew 9402: # save to the environment
9403: # appenv the same items, just to be safe
1.300 albertel 9404: my $udom = $env{'user.domain'};
9405: my $uname = $env{'user.name'};
1.496 albertel 9406: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9407: my %SaveHash;
9408: my %AppHash;
9409: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 9410: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 9411: my $envname = 'environment.'.$basename;
1.258 albertel 9412: if (exists($env{'form.'.$setting})) {
1.153 matthew 9413: # Save this value away
9414: if ($type eq 'scalar' &&
1.258 albertel 9415: (! exists($env{$envname}) ||
9416: $env{$envname} ne $env{'form.'.$setting})) {
9417: $SaveHash{$basename} = $env{'form.'.$setting};
9418: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 9419: } elsif ($type eq 'array') {
9420: my $stored_form;
1.258 albertel 9421: if (ref($env{'form.'.$setting})) {
1.153 matthew 9422: $stored_form = join(',',
9423: map {
1.369 www 9424: &escape($_);
1.258 albertel 9425: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 9426: } else {
9427: $stored_form =
1.369 www 9428: &escape($env{'form.'.$setting});
1.153 matthew 9429: }
9430: # Determine if the array contents are the same.
1.258 albertel 9431: if ($stored_form ne $env{$envname}) {
1.153 matthew 9432: $SaveHash{$basename} = $stored_form;
9433: $AppHash{$envname} = $stored_form;
9434: }
9435: }
9436: }
9437: }
9438: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 9439: $udom,$uname);
1.153 matthew 9440: if ($put_result !~ /^(ok|delayed)/) {
9441: &Apache::lonnet::logthis('unable to save form parameters, '.
9442: 'got error:'.$put_result);
9443: }
9444: # Make sure these settings stick around in this session, too
1.646 raeburn 9445: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 9446: return;
9447: }
9448:
9449: sub restore_course_settings {
1.499 albertel 9450: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 9451: }
9452:
9453: sub restore_settings {
9454: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9455: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 9456: next if (exists($env{'form.'.$setting}));
1.496 albertel 9457: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 9458: '.'.$setting;
1.258 albertel 9459: if (exists($env{$envname})) {
1.153 matthew 9460: if ($type eq 'scalar') {
1.258 albertel 9461: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 9462: } elsif ($type eq 'array') {
1.258 albertel 9463: $env{'form.'.$setting} = [
1.153 matthew 9464: map {
1.369 www 9465: &unescape($_);
1.258 albertel 9466: } split(',',$env{$envname})
1.153 matthew 9467: ];
9468: }
9469: }
9470: }
1.127 matthew 9471: }
9472:
1.618 raeburn 9473: #######################################################
9474: #######################################################
9475:
9476: =pod
9477:
9478: =head1 Domain E-mail Routines
9479:
9480: =over 4
9481:
1.648 raeburn 9482: =item * &build_recipient_list()
1.618 raeburn 9483:
1.884 raeburn 9484: Build recipient lists for five types of e-mail:
1.766 raeburn 9485: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884 raeburn 9486: (d) Help requests, (e) Course requests needing approval, generated by
9487: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
9488: loncoursequeueadmin.pm respectively.
1.618 raeburn 9489:
9490: Inputs:
1.619 raeburn 9491: defmail (scalar - email address of default recipient),
1.618 raeburn 9492: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 9493: defdom (domain for which to retrieve configuration settings),
9494: origmail (scalar - email address of recipient from loncapa.conf,
9495: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 9496:
1.655 raeburn 9497: Returns: comma separated list of addresses to which to send e-mail.
9498:
9499: =back
1.618 raeburn 9500:
9501: =cut
9502:
9503: ############################################################
9504: ############################################################
9505: sub build_recipient_list {
1.619 raeburn 9506: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 9507: my @recipients;
9508: my $otheremails;
9509: my %domconfig =
9510: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
9511: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 9512: if (exists($domconfig{'contacts'}{$mailing})) {
9513: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
9514: my @contacts = ('adminemail','supportemail');
9515: foreach my $item (@contacts) {
9516: if ($domconfig{'contacts'}{$mailing}{$item}) {
9517: my $addr = $domconfig{'contacts'}{$item};
9518: if (!grep(/^\Q$addr\E$/,@recipients)) {
9519: push(@recipients,$addr);
9520: }
1.619 raeburn 9521: }
1.766 raeburn 9522: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 9523: }
9524: }
1.766 raeburn 9525: } elsif ($origmail ne '') {
9526: push(@recipients,$origmail);
1.618 raeburn 9527: }
1.619 raeburn 9528: } elsif ($origmail ne '') {
9529: push(@recipients,$origmail);
1.618 raeburn 9530: }
1.688 raeburn 9531: if (defined($defmail)) {
9532: if ($defmail ne '') {
9533: push(@recipients,$defmail);
9534: }
1.618 raeburn 9535: }
9536: if ($otheremails) {
1.619 raeburn 9537: my @others;
9538: if ($otheremails =~ /,/) {
9539: @others = split(/,/,$otheremails);
1.618 raeburn 9540: } else {
1.619 raeburn 9541: push(@others,$otheremails);
9542: }
9543: foreach my $addr (@others) {
9544: if (!grep(/^\Q$addr\E$/,@recipients)) {
9545: push(@recipients,$addr);
9546: }
1.618 raeburn 9547: }
9548: }
1.619 raeburn 9549: my $recipientlist = join(',',@recipients);
1.618 raeburn 9550: return $recipientlist;
9551: }
9552:
1.127 matthew 9553: ############################################################
9554: ############################################################
1.154 albertel 9555:
1.655 raeburn 9556: =pod
9557:
9558: =head1 Course Catalog Routines
9559:
9560: =over 4
9561:
9562: =item * &gather_categories()
9563:
9564: Converts category definitions - keys of categories hash stored in
9565: coursecategories in configuration.db on the primary library server in a
9566: domain - to an array. Also generates javascript and idx hash used to
9567: generate Domain Coordinator interface for editing Course Categories.
9568:
9569: Inputs:
1.663 raeburn 9570:
1.655 raeburn 9571: categories (reference to hash of category definitions).
1.663 raeburn 9572:
1.655 raeburn 9573: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9574: categories and subcategories).
1.663 raeburn 9575:
1.655 raeburn 9576: idx (reference to hash of counters used in Domain Coordinator interface for
9577: editing Course Categories).
1.663 raeburn 9578:
1.655 raeburn 9579: jsarray (reference to array of categories used to create Javascript arrays for
9580: Domain Coordinator interface for editing Course Categories).
9581:
9582: Returns: nothing
9583:
9584: Side effects: populates cats, idx and jsarray.
9585:
9586: =cut
9587:
9588: sub gather_categories {
9589: my ($categories,$cats,$idx,$jsarray) = @_;
9590: my %counters;
9591: my $num = 0;
9592: foreach my $item (keys(%{$categories})) {
9593: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
9594: if ($container eq '' && $depth == 0) {
9595: $cats->[$depth][$categories->{$item}] = $cat;
9596: } else {
9597: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
9598: }
9599: my ($escitem,$tail) = split(/:/,$item,2);
9600: if ($counters{$tail} eq '') {
9601: $counters{$tail} = $num;
9602: $num ++;
9603: }
9604: if (ref($idx) eq 'HASH') {
9605: $idx->{$item} = $counters{$tail};
9606: }
9607: if (ref($jsarray) eq 'ARRAY') {
9608: push(@{$jsarray->[$counters{$tail}]},$item);
9609: }
9610: }
9611: return;
9612: }
9613:
9614: =pod
9615:
9616: =item * &extract_categories()
9617:
9618: Used to generate breadcrumb trails for course categories.
9619:
9620: Inputs:
1.663 raeburn 9621:
1.655 raeburn 9622: categories (reference to hash of category definitions).
1.663 raeburn 9623:
1.655 raeburn 9624: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9625: categories and subcategories).
1.663 raeburn 9626:
1.655 raeburn 9627: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 9628:
1.655 raeburn 9629: allitems (reference to hash - key is category key
9630: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9631:
1.655 raeburn 9632: idx (reference to hash of counters used in Domain Coordinator interface for
9633: editing Course Categories).
1.663 raeburn 9634:
1.655 raeburn 9635: jsarray (reference to array of categories used to create Javascript arrays for
9636: Domain Coordinator interface for editing Course Categories).
9637:
1.665 raeburn 9638: subcats (reference to hash of arrays containing all subcategories within each
9639: category, -recursive)
9640:
1.655 raeburn 9641: Returns: nothing
9642:
9643: Side effects: populates trails and allitems hash references.
9644:
9645: =cut
9646:
9647: sub extract_categories {
1.665 raeburn 9648: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 9649: if (ref($categories) eq 'HASH') {
9650: &gather_categories($categories,$cats,$idx,$jsarray);
9651: if (ref($cats->[0]) eq 'ARRAY') {
9652: for (my $i=0; $i<@{$cats->[0]}; $i++) {
9653: my $name = $cats->[0][$i];
9654: my $item = &escape($name).'::0';
9655: my $trailstr;
9656: if ($name eq 'instcode') {
9657: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 9658: } elsif ($name eq 'communities') {
9659: $trailstr = &mt('Communities');
1.655 raeburn 9660: } else {
9661: $trailstr = $name;
9662: }
9663: if ($allitems->{$item} eq '') {
9664: push(@{$trails},$trailstr);
9665: $allitems->{$item} = scalar(@{$trails})-1;
9666: }
9667: my @parents = ($name);
9668: if (ref($cats->[1]{$name}) eq 'ARRAY') {
9669: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
9670: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 9671: if (ref($subcats) eq 'HASH') {
9672: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
9673: }
9674: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
9675: }
9676: } else {
9677: if (ref($subcats) eq 'HASH') {
9678: $subcats->{$item} = [];
1.655 raeburn 9679: }
9680: }
9681: }
9682: }
9683: }
9684: return;
9685: }
9686:
9687: =pod
9688:
9689: =item *&recurse_categories()
9690:
9691: Recursively used to generate breadcrumb trails for course categories.
9692:
9693: Inputs:
1.663 raeburn 9694:
1.655 raeburn 9695: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9696: categories and subcategories).
1.663 raeburn 9697:
1.655 raeburn 9698: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 9699:
9700: category (current course category, for which breadcrumb trail is being generated).
9701:
9702: trails (reference to array of breadcrumb trails for each category).
9703:
1.655 raeburn 9704: allitems (reference to hash - key is category key
9705: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9706:
1.655 raeburn 9707: parents (array containing containers directories for current category,
9708: back to top level).
9709:
9710: Returns: nothing
9711:
9712: Side effects: populates trails and allitems hash references
9713:
9714: =cut
9715:
9716: sub recurse_categories {
1.665 raeburn 9717: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 9718: my $shallower = $depth - 1;
9719: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
9720: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
9721: my $name = $cats->[$depth]{$category}[$k];
9722: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9723: my $trailstr = join(' -> ',(@{$parents},$category));
9724: if ($allitems->{$item} eq '') {
9725: push(@{$trails},$trailstr);
9726: $allitems->{$item} = scalar(@{$trails})-1;
9727: }
9728: my $deeper = $depth+1;
9729: push(@{$parents},$category);
1.665 raeburn 9730: if (ref($subcats) eq 'HASH') {
9731: my $subcat = &escape($name).':'.$category.':'.$depth;
9732: for (my $j=@{$parents}; $j>=0; $j--) {
9733: my $higher;
9734: if ($j > 0) {
9735: $higher = &escape($parents->[$j]).':'.
9736: &escape($parents->[$j-1]).':'.$j;
9737: } else {
9738: $higher = &escape($parents->[$j]).'::'.$j;
9739: }
9740: push(@{$subcats->{$higher}},$subcat);
9741: }
9742: }
9743: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
9744: $subcats);
1.655 raeburn 9745: pop(@{$parents});
9746: }
9747: } else {
9748: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9749: my $trailstr = join(' -> ',(@{$parents},$category));
9750: if ($allitems->{$item} eq '') {
9751: push(@{$trails},$trailstr);
9752: $allitems->{$item} = scalar(@{$trails})-1;
9753: }
9754: }
9755: return;
9756: }
9757:
1.663 raeburn 9758: =pod
9759:
9760: =item *&assign_categories_table()
9761:
9762: Create a datatable for display of hierarchical categories in a domain,
9763: with checkboxes to allow a course to be categorized.
9764:
9765: Inputs:
9766:
9767: cathash - reference to hash of categories defined for the domain (from
9768: configuration.db)
9769:
9770: currcat - scalar with an & separated list of categories assigned to a course.
9771:
1.919 raeburn 9772: type - scalar contains course type (Course or Community).
9773:
1.663 raeburn 9774: Returns: $output (markup to be displayed)
9775:
9776: =cut
9777:
9778: sub assign_categories_table {
1.919 raeburn 9779: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 9780: my $output;
9781: if (ref($cathash) eq 'HASH') {
9782: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
9783: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
9784: $maxdepth = scalar(@cats);
9785: if (@cats > 0) {
9786: my $itemcount = 0;
9787: if (ref($cats[0]) eq 'ARRAY') {
9788: my @currcategories;
9789: if ($currcat ne '') {
9790: @currcategories = split('&',$currcat);
9791: }
1.919 raeburn 9792: my $table;
1.663 raeburn 9793: for (my $i=0; $i<@{$cats[0]}; $i++) {
9794: my $parent = $cats[0][$i];
1.919 raeburn 9795: next if ($parent eq 'instcode');
9796: if ($type eq 'Community') {
9797: next unless ($parent eq 'communities');
9798: } else {
9799: next if ($parent eq 'communities');
9800: }
1.663 raeburn 9801: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9802: my $item = &escape($parent).'::0';
9803: my $checked = '';
9804: if (@currcategories > 0) {
9805: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 9806: $checked = ' checked="checked"';
1.663 raeburn 9807: }
9808: }
1.919 raeburn 9809: my $parent_title = $parent;
9810: if ($parent eq 'communities') {
9811: $parent_title = &mt('Communities');
9812: }
9813: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
9814: '<input type="checkbox" name="usecategory" value="'.
9815: $item.'"'.$checked.' />'.$parent_title.'</span>'.
9816: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 9817: my $depth = 1;
9818: push(@path,$parent);
1.919 raeburn 9819: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 9820: pop(@path);
1.919 raeburn 9821: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 9822: $itemcount ++;
9823: }
1.919 raeburn 9824: if ($itemcount) {
9825: $output = &Apache::loncommon::start_data_table().
9826: $table.
9827: &Apache::loncommon::end_data_table();
9828: }
1.663 raeburn 9829: }
9830: }
9831: }
9832: return $output;
9833: }
9834:
9835: =pod
9836:
9837: =item *&assign_category_rows()
9838:
9839: Create a datatable row for display of nested categories in a domain,
9840: with checkboxes to allow a course to be categorized,called recursively.
9841:
9842: Inputs:
9843:
9844: itemcount - track row number for alternating colors
9845:
9846: cats - reference to array of arrays/hashes which encapsulates hierarchy of
9847: categories and subcategories.
9848:
9849: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
9850:
9851: parent - parent of current category item
9852:
9853: path - Array containing all categories back up through the hierarchy from the
9854: current category to the top level.
9855:
9856: currcategories - reference to array of current categories assigned to the course
9857:
9858: Returns: $output (markup to be displayed).
9859:
9860: =cut
9861:
9862: sub assign_category_rows {
9863: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
9864: my ($text,$name,$item,$chgstr);
9865: if (ref($cats) eq 'ARRAY') {
9866: my $maxdepth = scalar(@{$cats});
9867: if (ref($cats->[$depth]) eq 'HASH') {
9868: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
9869: my $numchildren = @{$cats->[$depth]{$parent}};
9870: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9871: $text .= '<td><table class="LC_datatable">';
9872: for (my $j=0; $j<$numchildren; $j++) {
9873: $name = $cats->[$depth]{$parent}[$j];
9874: $item = &escape($name).':'.&escape($parent).':'.$depth;
9875: my $deeper = $depth+1;
9876: my $checked = '';
9877: if (ref($currcategories) eq 'ARRAY') {
9878: if (@{$currcategories} > 0) {
9879: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 9880: $checked = ' checked="checked"';
1.663 raeburn 9881: }
9882: }
9883: }
1.664 raeburn 9884: $text .= '<tr><td><span class="LC_nobreak"><label>'.
9885: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 9886: $item.'"'.$checked.' />'.$name.'</label></span>'.
9887: '<input type="hidden" name="catname" value="'.$name.'" />'.
9888: '</td><td>';
1.663 raeburn 9889: if (ref($path) eq 'ARRAY') {
9890: push(@{$path},$name);
9891: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
9892: pop(@{$path});
9893: }
9894: $text .= '</td></tr>';
9895: }
9896: $text .= '</table></td>';
9897: }
9898: }
9899: }
9900: return $text;
9901: }
9902:
1.655 raeburn 9903: ############################################################
9904: ############################################################
9905:
9906:
1.443 albertel 9907: sub commit_customrole {
1.664 raeburn 9908: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 9909: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 9910: ($start?', '.&mt('starting').' '.localtime($start):'').
9911: ($end?', ending '.localtime($end):'').': <b>'.
9912: &Apache::lonnet::assigncustomrole(
1.664 raeburn 9913: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 9914: '</b><br />';
9915: return $output;
9916: }
9917:
9918: sub commit_standardrole {
1.541 raeburn 9919: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
9920: my ($output,$logmsg,$linefeed);
9921: if ($context eq 'auto') {
9922: $linefeed = "\n";
9923: } else {
9924: $linefeed = "<br />\n";
9925: }
1.443 albertel 9926: if ($three eq 'st') {
1.541 raeburn 9927: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
9928: $one,$two,$sec,$context);
9929: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 9930: ($result eq 'unknown_course') || ($result eq 'refused')) {
9931: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 9932: } else {
1.541 raeburn 9933: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 9934: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9935: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
9936: if ($context eq 'auto') {
9937: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
9938: } else {
9939: $output .= '<b>'.$result.'</b>'.$linefeed.
9940: &mt('Add to classlist').': <b>ok</b>';
9941: }
9942: $output .= $linefeed;
1.443 albertel 9943: }
9944: } else {
9945: $output = &mt('Assigning').' '.$three.' in '.$url.
9946: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9947: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 9948: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 9949: if ($context eq 'auto') {
9950: $output .= $result.$linefeed;
9951: } else {
9952: $output .= '<b>'.$result.'</b>'.$linefeed;
9953: }
1.443 albertel 9954: }
9955: return $output;
9956: }
9957:
9958: sub commit_studentrole {
1.541 raeburn 9959: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 9960: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 9961: if ($context eq 'auto') {
9962: $linefeed = "\n";
9963: } else {
9964: $linefeed = '<br />'."\n";
9965: }
1.443 albertel 9966: if (defined($one) && defined($two)) {
9967: my $cid=$one.'_'.$two;
9968: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
9969: my $secchange = 0;
9970: my $expire_role_result;
9971: my $modify_section_result;
1.628 raeburn 9972: if ($oldsec ne '-1') {
9973: if ($oldsec ne $sec) {
1.443 albertel 9974: $secchange = 1;
1.628 raeburn 9975: my $now = time;
1.443 albertel 9976: my $uurl='/'.$cid;
9977: $uurl=~s/\_/\//g;
9978: if ($oldsec) {
9979: $uurl.='/'.$oldsec;
9980: }
1.626 raeburn 9981: $oldsecurl = $uurl;
1.628 raeburn 9982: $expire_role_result =
1.652 raeburn 9983: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 9984: if ($env{'request.course.sec'} ne '') {
9985: if ($expire_role_result eq 'refused') {
9986: my @roles = ('st');
9987: my @statuses = ('previous');
9988: my @roledoms = ($one);
9989: my $withsec = 1;
9990: my %roleshash =
9991: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
9992: \@statuses,\@roles,\@roledoms,$withsec);
9993: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
9994: my ($oldstart,$oldend) =
9995: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
9996: if ($oldend > 0 && $oldend <= $now) {
9997: $expire_role_result = 'ok';
9998: }
9999: }
10000: }
10001: }
1.443 albertel 10002: $result = $expire_role_result;
10003: }
10004: }
10005: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 10006: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 10007: if ($modify_section_result =~ /^ok/) {
10008: if ($secchange == 1) {
1.628 raeburn 10009: if ($sec eq '') {
10010: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
10011: } else {
10012: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
10013: }
1.443 albertel 10014: } elsif ($oldsec eq '-1') {
1.628 raeburn 10015: if ($sec eq '') {
10016: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
10017: } else {
10018: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
10019: }
1.443 albertel 10020: } else {
1.628 raeburn 10021: if ($sec eq '') {
10022: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
10023: } else {
10024: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
10025: }
1.443 albertel 10026: }
10027: } else {
1.628 raeburn 10028: if ($secchange) {
10029: $$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;
10030: } else {
10031: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
10032: }
1.443 albertel 10033: }
10034: $result = $modify_section_result;
10035: } elsif ($secchange == 1) {
1.628 raeburn 10036: if ($oldsec eq '') {
10037: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
10038: } else {
10039: $$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;
10040: }
1.626 raeburn 10041: if ($expire_role_result eq 'refused') {
10042: my $newsecurl = '/'.$cid;
10043: $newsecurl =~ s/\_/\//g;
10044: if ($sec ne '') {
10045: $newsecurl.='/'.$sec;
10046: }
10047: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
10048: if ($sec eq '') {
10049: $$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;
10050: } else {
10051: $$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;
10052: }
10053: }
10054: }
1.443 albertel 10055: }
10056: } else {
1.626 raeburn 10057: $$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 10058: $result = "error: incomplete course id\n";
10059: }
10060: return $result;
10061: }
10062:
10063: ############################################################
10064: ############################################################
10065:
1.566 albertel 10066: sub check_clone {
1.578 raeburn 10067: my ($args,$linefeed) = @_;
1.566 albertel 10068: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
10069: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
10070: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
10071: my $clonemsg;
10072: my $can_clone = 0;
1.944 raeburn 10073: my $lctype = lc($args->{'crstype'});
1.908 raeburn 10074: if ($lctype ne 'community') {
10075: $lctype = 'course';
10076: }
1.566 albertel 10077: if ($clonehome eq 'no_host') {
1.944 raeburn 10078: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10079: $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'});
10080: } else {
10081: $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'});
10082: }
1.566 albertel 10083: } else {
10084: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944 raeburn 10085: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10086: if ($clonedesc{'type'} ne 'Community') {
10087: $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'});
10088: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10089: }
10090: }
1.882 raeburn 10091: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
10092: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 10093: $can_clone = 1;
10094: } else {
10095: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
10096: $args->{'clonedomain'},$args->{'clonecourse'});
10097: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 10098: if (grep(/^\*$/,@cloners)) {
10099: $can_clone = 1;
10100: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
10101: $can_clone = 1;
10102: } else {
1.908 raeburn 10103: my $ccrole = 'cc';
1.944 raeburn 10104: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10105: $ccrole = 'co';
10106: }
1.578 raeburn 10107: my %roleshash =
10108: &Apache::lonnet::get_my_roles($args->{'ccuname'},
10109: $args->{'ccdomain'},
1.908 raeburn 10110: 'userroles',['active'],[$ccrole],
1.578 raeburn 10111: [$args->{'clonedomain'}]);
1.908 raeburn 10112: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942 raeburn 10113: $can_clone = 1;
10114: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
10115: $can_clone = 1;
10116: } else {
1.944 raeburn 10117: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10118: $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'});
10119: } else {
10120: $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'});
10121: }
1.578 raeburn 10122: }
1.566 albertel 10123: }
1.578 raeburn 10124: }
1.566 albertel 10125: }
10126: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10127: }
10128:
1.444 albertel 10129: sub construct_course {
1.885 raeburn 10130: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444 albertel 10131: my $outcome;
1.541 raeburn 10132: my $linefeed = '<br />'."\n";
10133: if ($context eq 'auto') {
10134: $linefeed = "\n";
10135: }
1.566 albertel 10136:
10137: #
10138: # Are we cloning?
10139: #
10140: my ($can_clone, $clonemsg, $cloneid, $clonehome);
10141: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 10142: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 10143: if ($context ne 'auto') {
1.578 raeburn 10144: if ($clonemsg ne '') {
10145: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
10146: }
1.566 albertel 10147: }
10148: $outcome .= $clonemsg.$linefeed;
10149:
10150: if (!$can_clone) {
10151: return (0,$outcome);
10152: }
10153: }
10154:
1.444 albertel 10155: #
10156: # Open course
10157: #
10158: my $crstype = lc($args->{'crstype'});
10159: my %cenv=();
10160: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
10161: $args->{'cdescr'},
10162: $args->{'curl'},
10163: $args->{'course_home'},
10164: $args->{'nonstandard'},
10165: $args->{'crscode'},
10166: $args->{'ccuname'}.':'.
10167: $args->{'ccdomain'},
1.882 raeburn 10168: $args->{'crstype'},
1.885 raeburn 10169: $cnum,$context,$category);
1.444 albertel 10170:
10171: # Note: The testing routines depend on this being output; see
10172: # Utils::Course. This needs to at least be output as a comment
10173: # if anyone ever decides to not show this, and Utils::Course::new
10174: # will need to be suitably modified.
1.541 raeburn 10175: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943 raeburn 10176: if ($$courseid =~ /^error:/) {
10177: return (0,$outcome);
10178: }
10179:
1.444 albertel 10180: #
10181: # Check if created correctly
10182: #
1.479 albertel 10183: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 10184: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 10185: if ($crsuhome eq 'no_host') {
10186: $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
10187: return (0,$outcome);
10188: }
1.541 raeburn 10189: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 10190:
1.444 albertel 10191: #
1.566 albertel 10192: # Do the cloning
10193: #
10194: if ($can_clone && $cloneid) {
10195: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
10196: if ($context ne 'auto') {
10197: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
10198: }
10199: $outcome .= $clonemsg.$linefeed;
10200: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 10201: # Copy all files
1.637 www 10202: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 10203: # Restore URL
1.566 albertel 10204: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 10205: # Restore title
1.566 albertel 10206: $cenv{'description'}=$oldcenv{'description'};
1.444 albertel 10207: # Mark as cloned
1.566 albertel 10208: $cenv{'clonedfrom'}=$cloneid;
1.638 www 10209: # Need to clone grading mode
10210: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
10211: $cenv{'grading'}=$newenv{'grading'};
10212: # Do not clone these environment entries
10213: &Apache::lonnet::del('environment',
10214: ['default_enrollment_start_date',
10215: 'default_enrollment_end_date',
10216: 'question.email',
10217: 'policy.email',
10218: 'comment.email',
10219: 'pch.users.denied',
1.725 raeburn 10220: 'plc.users.denied',
10221: 'hidefromcat',
10222: 'categories'],
1.638 www 10223: $$crsudom,$$crsunum);
1.444 albertel 10224: }
1.566 albertel 10225:
1.444 albertel 10226: #
10227: # Set environment (will override cloned, if existing)
10228: #
10229: my @sections = ();
10230: my @xlists = ();
10231: if ($args->{'crstype'}) {
10232: $cenv{'type'}=$args->{'crstype'};
10233: }
10234: if ($args->{'crsid'}) {
10235: $cenv{'courseid'}=$args->{'crsid'};
10236: }
10237: if ($args->{'crscode'}) {
10238: $cenv{'internal.coursecode'}=$args->{'crscode'};
10239: }
10240: if ($args->{'crsquota'} ne '') {
10241: $cenv{'internal.coursequota'}=$args->{'crsquota'};
10242: } else {
10243: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
10244: }
10245: if ($args->{'ccuname'}) {
10246: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
10247: ':'.$args->{'ccdomain'};
10248: } else {
10249: $cenv{'internal.courseowner'} = $args->{'curruser'};
10250: }
10251: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
10252: if ($args->{'crssections'}) {
10253: $cenv{'internal.sectionnums'} = '';
10254: if ($args->{'crssections'} =~ m/,/) {
10255: @sections = split/,/,$args->{'crssections'};
10256: } else {
10257: $sections[0] = $args->{'crssections'};
10258: }
10259: if (@sections > 0) {
10260: foreach my $item (@sections) {
10261: my ($sec,$gp) = split/:/,$item;
10262: my $class = $args->{'crscode'}.$sec;
10263: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
10264: $cenv{'internal.sectionnums'} .= $item.',';
10265: unless ($addcheck eq 'ok') {
10266: push @badclasses, $class;
10267: }
10268: }
10269: $cenv{'internal.sectionnums'} =~ s/,$//;
10270: }
10271: }
10272: # do not hide course coordinator from staff listing,
10273: # even if privileged
10274: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10275: # add crosslistings
10276: if ($args->{'crsxlist'}) {
10277: $cenv{'internal.crosslistings'}='';
10278: if ($args->{'crsxlist'} =~ m/,/) {
10279: @xlists = split/,/,$args->{'crsxlist'};
10280: } else {
10281: $xlists[0] = $args->{'crsxlist'};
10282: }
10283: if (@xlists > 0) {
10284: foreach my $item (@xlists) {
10285: my ($xl,$gp) = split/:/,$item;
10286: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
10287: $cenv{'internal.crosslistings'} .= $item.',';
10288: unless ($addcheck eq 'ok') {
10289: push @badclasses, $xl;
10290: }
10291: }
10292: $cenv{'internal.crosslistings'} =~ s/,$//;
10293: }
10294: }
10295: if ($args->{'autoadds'}) {
10296: $cenv{'internal.autoadds'}=$args->{'autoadds'};
10297: }
10298: if ($args->{'autodrops'}) {
10299: $cenv{'internal.autodrops'}=$args->{'autodrops'};
10300: }
10301: # check for notification of enrollment changes
10302: my @notified = ();
10303: if ($args->{'notify_owner'}) {
10304: if ($args->{'ccuname'} ne '') {
10305: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
10306: }
10307: }
10308: if ($args->{'notify_dc'}) {
10309: if ($uname ne '') {
1.630 raeburn 10310: push(@notified,$uname.':'.$udom);
1.444 albertel 10311: }
10312: }
10313: if (@notified > 0) {
10314: my $notifylist;
10315: if (@notified > 1) {
10316: $notifylist = join(',',@notified);
10317: } else {
10318: $notifylist = $notified[0];
10319: }
10320: $cenv{'internal.notifylist'} = $notifylist;
10321: }
10322: if (@badclasses > 0) {
10323: my %lt=&Apache::lonlocal::texthash(
10324: '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',
10325: 'dnhr' => 'does not have rights to access enrollment in these classes',
10326: 'adby' => 'as determined by the policies of your institution on access to official classlists'
10327: );
1.541 raeburn 10328: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
10329: ' ('.$lt{'adby'}.')';
10330: if ($context eq 'auto') {
10331: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 10332: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 10333: foreach my $item (@badclasses) {
10334: if ($context eq 'auto') {
10335: $outcome .= " - $item\n";
10336: } else {
10337: $outcome .= "<li>$item</li>\n";
10338: }
10339: }
10340: if ($context eq 'auto') {
10341: $outcome .= $linefeed;
10342: } else {
1.566 albertel 10343: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 10344: }
10345: }
1.444 albertel 10346: }
10347: if ($args->{'no_end_date'}) {
10348: $args->{'endaccess'} = 0;
10349: }
10350: $cenv{'internal.autostart'}=$args->{'enrollstart'};
10351: $cenv{'internal.autoend'}=$args->{'enrollend'};
10352: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
10353: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
10354: if ($args->{'showphotos'}) {
10355: $cenv{'internal.showphotos'}=$args->{'showphotos'};
10356: }
10357: $cenv{'internal.authtype'} = $args->{'authtype'};
10358: $cenv{'internal.autharg'} = $args->{'autharg'};
10359: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
10360: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 10361: 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');
10362: if ($context eq 'auto') {
10363: $outcome .= $krb_msg;
10364: } else {
1.566 albertel 10365: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 10366: }
10367: $outcome .= $linefeed;
1.444 albertel 10368: }
10369: }
10370: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
10371: if ($args->{'setpolicy'}) {
10372: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10373: }
10374: if ($args->{'setcontent'}) {
10375: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10376: }
10377: }
10378: if ($args->{'reshome'}) {
10379: $cenv{'reshome'}=$args->{'reshome'}.'/';
10380: $cenv{'reshome'}=~s/\/+$/\//;
10381: }
10382: #
10383: # course has keyed access
10384: #
10385: if ($args->{'setkeys'}) {
10386: $cenv{'keyaccess'}='yes';
10387: }
10388: # if specified, key authority is not course, but user
10389: # only active if keyaccess is yes
10390: if ($args->{'keyauth'}) {
1.487 albertel 10391: my ($user,$domain) = split(':',$args->{'keyauth'});
10392: $user = &LONCAPA::clean_username($user);
10393: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 10394: if ($user ne '' && $domain ne '') {
1.487 albertel 10395: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 10396: }
10397: }
10398:
10399: if ($args->{'disresdis'}) {
10400: $cenv{'pch.roles.denied'}='st';
10401: }
10402: if ($args->{'disablechat'}) {
10403: $cenv{'plc.roles.denied'}='st';
10404: }
10405:
10406: # Record we've not yet viewed the Course Initialization Helper for this
10407: # course
10408: $cenv{'course.helper.not.run'} = 1;
10409: #
10410: # Use new Randomseed
10411: #
10412: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
10413: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
10414: #
10415: # The encryption code and receipt prefix for this course
10416: #
10417: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
10418: $cenv{'internal.encpref'}=100+int(9*rand(99));
10419: #
10420: # By default, use standard grading
10421: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
10422:
1.541 raeburn 10423: $outcome .= $linefeed.&mt('Setting environment').': '.
10424: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10425: #
10426: # Open all assignments
10427: #
10428: if ($args->{'openall'}) {
10429: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
10430: my %storecontent = ($storeunder => time,
10431: $storeunder.'.type' => 'date_start');
10432:
10433: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 10434: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10435: }
10436: #
10437: # Set first page
10438: #
10439: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
10440: || ($cloneid)) {
1.445 albertel 10441: use LONCAPA::map;
1.444 albertel 10442: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 10443:
10444: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
10445: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
10446:
1.444 albertel 10447: $outcome .= ($fatal?$errtext:'read ok').' - ';
10448: my $title; my $url;
10449: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 10450: $title=&mt('Syllabus');
1.444 albertel 10451: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
10452: } else {
1.690 bisitz 10453: $title=&mt('Navigate Contents');
1.444 albertel 10454: $url='/adm/navmaps';
10455: }
1.445 albertel 10456:
10457: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
10458: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
10459:
10460: if ($errtext) { $fatal=2; }
1.541 raeburn 10461: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 10462: }
1.566 albertel 10463:
10464: return (1,$outcome);
1.444 albertel 10465: }
10466:
10467: ############################################################
10468: ############################################################
10469:
1.953 ! droeschl 10470: #SD
! 10471: # only Community and Course, or anything else?
1.378 raeburn 10472: sub course_type {
10473: my ($cid) = @_;
10474: if (!defined($cid)) {
10475: $cid = $env{'request.course.id'};
10476: }
1.404 albertel 10477: if (defined($env{'course.'.$cid.'.type'})) {
10478: return $env{'course.'.$cid.'.type'};
1.378 raeburn 10479: } else {
10480: return 'Course';
1.377 raeburn 10481: }
10482: }
1.156 albertel 10483:
1.406 raeburn 10484: sub group_term {
10485: my $crstype = &course_type();
10486: my %names = (
10487: 'Course' => 'group',
1.865 raeburn 10488: 'Community' => 'group',
1.406 raeburn 10489: );
10490: return $names{$crstype};
10491: }
10492:
1.902 raeburn 10493: sub course_types {
10494: my @types = ('official','unofficial','community');
10495: my %typename = (
10496: official => 'Official course',
10497: unofficial => 'Unofficial course',
10498: community => 'Community',
10499: );
10500: return (\@types,\%typename);
10501: }
10502:
1.156 albertel 10503: sub icon {
10504: my ($file)=@_;
1.505 albertel 10505: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 10506: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 10507: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 10508: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
10509: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
10510: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10511: $curfext.".gif") {
10512: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10513: $curfext.".gif";
10514: }
10515: }
1.249 albertel 10516: return &lonhttpdurl($iconname);
1.154 albertel 10517: }
1.84 albertel 10518:
1.575 albertel 10519: sub lonhttpdurl {
1.692 www 10520: #
10521: # Had been used for "small fry" static images on separate port 8080.
10522: # Modify here if lightweight http functionality desired again.
10523: # Currently eliminated due to increasing firewall issues.
10524: #
1.575 albertel 10525: my ($url)=@_;
1.692 www 10526: return $url;
1.215 albertel 10527: }
10528:
1.213 albertel 10529: sub connection_aborted {
10530: my ($r)=@_;
10531: $r->print(" ");$r->rflush();
10532: my $c = $r->connection;
10533: return $c->aborted();
10534: }
10535:
1.221 foxr 10536: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 10537: # strings as 'strings'.
10538: sub escape_single {
1.221 foxr 10539: my ($input) = @_;
1.223 albertel 10540: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 10541: $input =~ s/\'/\\\'/g; # Esacpe the 's....
10542: return $input;
10543: }
1.223 albertel 10544:
1.222 foxr 10545: # Same as escape_single, but escape's "'s This
10546: # can be used for "strings"
10547: sub escape_double {
10548: my ($input) = @_;
10549: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
10550: $input =~ s/\"/\\\"/g; # Esacpe the "s....
10551: return $input;
10552: }
1.223 albertel 10553:
1.222 foxr 10554: # Escapes the last element of a full URL.
10555: sub escape_url {
10556: my ($url) = @_;
1.238 raeburn 10557: my @urlslices = split(/\//, $url,-1);
1.369 www 10558: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 10559: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 10560: }
1.462 albertel 10561:
1.820 raeburn 10562: sub compare_arrays {
10563: my ($arrayref1,$arrayref2) = @_;
10564: my (@difference,%count);
10565: @difference = ();
10566: %count = ();
10567: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
10568: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
10569: foreach my $element (keys(%count)) {
10570: if ($count{$element} == 1) {
10571: push(@difference,$element);
10572: }
10573: }
10574: }
10575: return @difference;
10576: }
10577:
1.817 bisitz 10578: # -------------------------------------------------------- Initialize user login
1.462 albertel 10579: sub init_user_environment {
1.463 albertel 10580: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 10581: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
10582:
10583: my $public=($username eq 'public' && $domain eq 'public');
10584:
10585: # See if old ID present, if so, remove
10586:
10587: my ($filename,$cookie,$userroles);
10588: my $now=time;
10589:
10590: if ($public) {
10591: my $max_public=100;
10592: my $oldest;
10593: my $oldest_time=0;
10594: for(my $next=1;$next<=$max_public;$next++) {
10595: if (-e $lonids."/publicuser_$next.id") {
10596: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
10597: if ($mtime<$oldest_time || !$oldest_time) {
10598: $oldest_time=$mtime;
10599: $oldest=$next;
10600: }
10601: } else {
10602: $cookie="publicuser_$next";
10603: last;
10604: }
10605: }
10606: if (!$cookie) { $cookie="publicuser_$oldest"; }
10607: } else {
1.463 albertel 10608: # if this isn't a robot, kill any existing non-robot sessions
10609: if (!$args->{'robot'}) {
10610: opendir(DIR,$lonids);
10611: while ($filename=readdir(DIR)) {
10612: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
10613: unlink($lonids.'/'.$filename);
10614: }
1.462 albertel 10615: }
1.463 albertel 10616: closedir(DIR);
1.462 albertel 10617: }
10618: # Give them a new cookie
1.463 albertel 10619: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 10620: : $now.$$.int(rand(10000)));
1.463 albertel 10621: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 10622:
10623: # Initialize roles
10624:
10625: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
10626: }
10627: # ------------------------------------ Check browser type and MathML capability
10628:
10629: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
10630: $clientunicode,$clientos) = &decode_user_agent($r);
10631:
10632: # ------------------------------------------------------------- Get environment
10633:
10634: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
10635: my ($tmp) = keys(%userenv);
10636: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
10637: } else {
10638: undef(%userenv);
10639: }
10640: if (($userenv{'interface'}) && (!$form->{'interface'})) {
10641: $form->{'interface'}=$userenv{'interface'};
10642: }
10643: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
10644:
10645: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 10646: foreach my $option ('interface','localpath','localres') {
10647: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 10648: }
10649: # --------------------------------------------------------- Write first profile
10650:
10651: {
10652: my %initial_env =
10653: ("user.name" => $username,
10654: "user.domain" => $domain,
10655: "user.home" => $authhost,
10656: "browser.type" => $clientbrowser,
10657: "browser.version" => $clientversion,
10658: "browser.mathml" => $clientmathml,
10659: "browser.unicode" => $clientunicode,
10660: "browser.os" => $clientos,
10661: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
10662: "request.course.fn" => '',
10663: "request.course.uri" => '',
10664: "request.course.sec" => '',
10665: "request.role" => 'cm',
10666: "request.role.adv" => $env{'user.adv'},
10667: "request.host" => $ENV{'REMOTE_ADDR'},);
10668:
10669: if ($form->{'localpath'}) {
10670: $initial_env{"browser.localpath"} = $form->{'localpath'};
10671: $initial_env{"browser.localres"} = $form->{'localres'};
10672: }
10673:
10674: if ($form->{'interface'}) {
10675: $form->{'interface'}=~s/\W//gs;
10676: $initial_env{"browser.interface"} = $form->{'interface'};
10677: $env{'browser.interface'}=$form->{'interface'};
10678: }
10679:
1.724 raeburn 10680: foreach my $tool ('aboutme','blog','portfolio') {
10681: $userenv{'availabletools.'.$tool} =
10682: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
10683: }
10684:
1.864 raeburn 10685: foreach my $crstype ('official','unofficial','community') {
1.765 raeburn 10686: $userenv{'canrequest.'.$crstype} =
10687: &Apache::lonnet::usertools_access($username,$domain,$crstype,
10688: 'reload','requestcourses');
10689: }
10690:
1.462 albertel 10691: $env{'user.environment'} = "$lonids/$cookie.id";
10692:
10693: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
10694: &GDBM_WRCREAT(),0640)) {
10695: &_add_to_env(\%disk_env,\%initial_env);
10696: &_add_to_env(\%disk_env,\%userenv,'environment.');
10697: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 10698: if (ref($args->{'extra_env'})) {
10699: &_add_to_env(\%disk_env,$args->{'extra_env'});
10700: }
1.462 albertel 10701: untie(%disk_env);
10702: } else {
1.705 tempelho 10703: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
10704: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 10705: return 'error: '.$!;
10706: }
10707: }
10708: $env{'request.role'}='cm';
10709: $env{'request.role.adv'}=$env{'user.adv'};
10710: $env{'browser.type'}=$clientbrowser;
10711:
10712: return $cookie;
10713:
10714: }
10715:
10716: sub _add_to_env {
10717: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 10718: if (ref($env_data) eq 'HASH') {
10719: while (my ($key,$value) = each(%$env_data)) {
10720: $idf->{$prefix.$key} = $value;
10721: $env{$prefix.$key} = $value;
10722: }
1.462 albertel 10723: }
10724: }
10725:
1.685 tempelho 10726: # --- Get the symbolic name of a problem and the url
10727: sub get_symb {
10728: my ($request,$silent) = @_;
1.726 raeburn 10729: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 10730: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
10731: if ($symb eq '') {
10732: if (!$silent) {
10733: $request->print("Unable to handle ambiguous references:$url:.");
10734: return ();
10735: }
10736: }
10737: &Apache::lonenc::check_decrypt(\$symb);
10738: return ($symb);
10739: }
10740:
10741: # --------------------------------------------------------------Get annotation
10742:
10743: sub get_annotation {
10744: my ($symb,$enc) = @_;
10745:
10746: my $key = $symb;
10747: if (!$enc) {
10748: $key =
10749: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
10750: }
10751: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
10752: return $annotation{$key};
10753: }
10754:
10755: sub clean_symb {
1.731 raeburn 10756: my ($symb,$delete_enc) = @_;
1.685 tempelho 10757:
10758: &Apache::lonenc::check_decrypt(\$symb);
10759: my $enc = $env{'request.enc'};
1.731 raeburn 10760: if ($delete_enc) {
1.730 raeburn 10761: delete($env{'request.enc'});
10762: }
1.685 tempelho 10763:
10764: return ($symb,$enc);
10765: }
1.462 albertel 10766:
1.41 ng 10767: =pod
10768:
10769: =back
10770:
1.112 bowersj2 10771: =cut
1.41 ng 10772:
1.112 bowersj2 10773: 1;
10774: __END__;
1.41 ng 10775:
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