Annotation of loncom/interface/loncommon.pm, revision 1.1076
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1076 ! raeburn 4: # $Id: loncommon.pm,v 1.1075 2012/05/09 20:17:47 raeburn Exp $
1.10 albertel 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.1 albertel 28:
29: # Makes a table out of the previous attempts
1.2 albertel 30: # Inputs result_from_symbread, user, domain, course_id
1.16 harris41 31: # Reads in non-network-related .tab files
1.1 albertel 32:
1.35 matthew 33: # POD header:
34:
1.45 matthew 35: =pod
36:
1.35 matthew 37: =head1 NAME
38:
39: Apache::loncommon - pile of common routines
40:
41: =head1 SYNOPSIS
42:
1.112 bowersj2 43: Common routines for manipulating connections, student answers,
44: domains, common Javascript fragments, etc.
1.35 matthew 45:
1.112 bowersj2 46: =head1 OVERVIEW
1.35 matthew 47:
1.112 bowersj2 48: A collection of commonly used subroutines that don't have a natural
49: home anywhere else. This collection helps remove
1.35 matthew 50: redundancy from other modules and increase efficiency of memory usage.
51:
52: =cut
53:
54: # End of POD header
1.1 albertel 55: package Apache::loncommon;
56:
57: use strict;
1.258 albertel 58: use Apache::lonnet;
1.46 matthew 59: use GDBM_File;
1.51 www 60: use POSIX qw(strftime mktime);
1.82 www 61: use Apache::lonmenu();
1.498 albertel 62: use Apache::lonenc();
1.117 www 63: use Apache::lonlocal;
1.685 tempelho 64: use Apache::lonnet();
1.139 matthew 65: use HTML::Entities;
1.334 albertel 66: use Apache::lonhtmlcommon();
67: use Apache::loncoursedata();
1.344 albertel 68: use Apache::lontexconvert();
1.444 albertel 69: use Apache::lonclonecourse();
1.479 albertel 70: use LONCAPA qw(:DEFAULT :match);
1.657 raeburn 71: use DateTime::TimeZone;
1.687 raeburn 72: use DateTime::Locale::Catalog;
1.117 www 73:
1.517 raeburn 74: # ---------------------------------------------- Designs
75: use vars qw(%defaultdesign);
76:
1.22 www 77: my $readit;
78:
1.517 raeburn 79:
1.157 matthew 80: ##
81: ## Global Variables
82: ##
1.46 matthew 83:
1.643 foxr 84:
85: # ----------------------------------------------- SSI with retries:
86: #
87:
88: =pod
89:
1.648 raeburn 90: =head1 Server Side include with retries:
1.643 foxr 91:
92: =over 4
93:
1.648 raeburn 94: =item * &ssi_with_retries(resource,retries form)
1.643 foxr 95:
96: Performs an ssi with some number of retries. Retries continue either
97: until the result is ok or until the retry count supplied by the
98: caller is exhausted.
99:
100: Inputs:
1.648 raeburn 101:
102: =over 4
103:
1.643 foxr 104: resource - Identifies the resource to insert.
1.648 raeburn 105:
1.643 foxr 106: retries - Count of the number of retries allowed.
1.648 raeburn 107:
1.643 foxr 108: form - Hash that identifies the rendering options.
109:
1.648 raeburn 110: =back
111:
112: Returns:
113:
114: =over 4
115:
1.643 foxr 116: content - The content of the response. If retries were exhausted this is empty.
1.648 raeburn 117:
1.643 foxr 118: response - The response from the last attempt (which may or may not have been successful.
119:
1.648 raeburn 120: =back
121:
122: =back
123:
1.643 foxr 124: =cut
125:
126: sub ssi_with_retries {
127: my ($resource, $retries, %form) = @_;
128:
129:
130: my $ok = 0; # True if we got a good response.
131: my $content;
132: my $response;
133:
134: # Try to get the ssi done. within the retries count:
135:
136: do {
137: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
138: $ok = $response->is_success;
1.650 www 139: if (!$ok) {
140: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
141: }
1.643 foxr 142: $retries--;
143: } while (!$ok && ($retries > 0));
144:
145: if (!$ok) {
146: $content = ''; # On error return an empty content.
147: }
148: return ($content, $response);
149:
150: }
151:
152:
153:
1.20 www 154: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 155: my %language;
1.124 www 156: my %supported_language;
1.1048 foxr 157: my %latex_language; # For choosing hyphenation in <transl..>
158: my %latex_language_bykey; # for choosing hyphenation from metadata
1.12 harris41 159: my %cprtag;
1.192 taceyjo1 160: my %scprtag;
1.351 www 161: my %fe; my %fd; my %fm;
1.41 ng 162: my %category_extensions;
1.12 harris41 163:
1.46 matthew 164: # ---------------------------------------------- Thesaurus variables
1.144 matthew 165: #
166: # %Keywords:
167: # A hash used by &keyword to determine if a word is considered a keyword.
168: # $thesaurus_db_file
169: # Scalar containing the full path to the thesaurus database.
1.46 matthew 170:
171: my %Keywords;
172: my $thesaurus_db_file;
173:
1.144 matthew 174: #
175: # Initialize values from language.tab, copyright.tab, filetypes.tab,
176: # thesaurus.tab, and filecategories.tab.
177: #
1.18 www 178: BEGIN {
1.46 matthew 179: # Variable initialization
180: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
181: #
1.22 www 182: unless ($readit) {
1.12 harris41 183: # ------------------------------------------------------------------- languages
184: {
1.158 raeburn 185: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
186: '/language.tab';
187: if ( open(my $fh,"<$langtabfile") ) {
1.356 albertel 188: while (my $line = <$fh>) {
189: next if ($line=~/^\#/);
190: chomp($line);
1.1048 foxr 191: my ($key,$two,$country,$three,$enc,$val,$sup,$latex)=(split(/\t/,$line));
1.158 raeburn 192: $language{$key}=$val.' - '.$enc;
193: if ($sup) {
194: $supported_language{$key}=$sup;
195: }
1.1048 foxr 196: if ($latex) {
197: $latex_language_bykey{$key} = $latex;
198: $latex_language{$two} = $latex;
199: }
1.158 raeburn 200: }
201: close($fh);
202: }
1.12 harris41 203: }
204: # ------------------------------------------------------------------ copyrights
205: {
1.158 raeburn 206: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
207: '/copyright.tab';
208: if ( open (my $fh,"<$copyrightfile") ) {
1.356 albertel 209: while (my $line = <$fh>) {
210: next if ($line=~/^\#/);
211: chomp($line);
212: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 213: $cprtag{$key}=$val;
214: }
215: close($fh);
216: }
1.12 harris41 217: }
1.351 www 218: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 219: {
220: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
221: '/source_copyright.tab';
222: if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356 albertel 223: while (my $line = <$fh>) {
224: next if ($line =~ /^\#/);
225: chomp($line);
226: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 227: $scprtag{$key}=$val;
228: }
229: close($fh);
230: }
231: }
1.63 www 232:
1.517 raeburn 233: # -------------------------------------------------------------- default domain designs
1.63 www 234: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 235: my $designfile = $designdir.'/default.tab';
236: if ( open (my $fh,"<$designfile") ) {
237: while (my $line = <$fh>) {
238: next if ($line =~ /^\#/);
239: chomp($line);
240: my ($key,$val)=(split(/\=/,$line));
241: if ($val) { $defaultdesign{$key}=$val; }
242: }
243: close($fh);
1.63 www 244: }
245:
1.15 harris41 246: # ------------------------------------------------------------- file categories
247: {
1.158 raeburn 248: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
249: '/filecategories.tab';
250: if ( open (my $fh,"<$categoryfile") ) {
1.356 albertel 251: while (my $line = <$fh>) {
252: next if ($line =~ /^\#/);
253: chomp($line);
254: my ($extension,$category)=(split(/\s+/,$line,2));
1.158 raeburn 255: push @{$category_extensions{lc($category)}},$extension;
256: }
257: close($fh);
258: }
259:
1.15 harris41 260: }
1.12 harris41 261: # ------------------------------------------------------------------ file types
262: {
1.158 raeburn 263: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
264: '/filetypes.tab';
265: if ( open (my $fh,"<$typesfile") ) {
1.356 albertel 266: while (my $line = <$fh>) {
267: next if ($line =~ /^\#/);
268: chomp($line);
269: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 270: if ($descr ne '') {
271: $fe{$ending}=lc($emb);
272: $fd{$ending}=$descr;
1.351 www 273: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 274: }
275: }
276: close($fh);
277: }
1.12 harris41 278: }
1.22 www 279: &Apache::lonnet::logthis(
1.705 tempelho 280: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 281: $readit=1;
1.46 matthew 282: } # end of unless($readit)
1.32 matthew 283:
284: }
1.112 bowersj2 285:
1.42 matthew 286: ###############################################################
287: ## HTML and Javascript Helper Functions ##
288: ###############################################################
289:
290: =pod
291:
1.112 bowersj2 292: =head1 HTML and Javascript Functions
1.42 matthew 293:
1.112 bowersj2 294: =over 4
295:
1.648 raeburn 296: =item * &browser_and_searcher_javascript()
1.112 bowersj2 297:
298: X<browsing, javascript>X<searching, javascript>Returns a string
299: containing javascript with two functions, C<openbrowser> and
300: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
301: tags.
1.42 matthew 302:
1.648 raeburn 303: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 304:
305: inputs: formname, elementname, only, omit
306:
307: formname and elementname indicate the name of the html form and name of
308: the element that the results of the browsing selection are to be placed in.
309:
310: Specifying 'only' will restrict the browser to displaying only files
1.185 www 311: with the given extension. Can be a comma separated list.
1.42 matthew 312:
313: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 314: with the given extension. Can be a comma separated list.
1.42 matthew 315:
1.648 raeburn 316: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 317:
318: Inputs: formname, elementname
319:
320: formname and elementname specify the name of the html form and the name
321: of the element the selection from the search results will be placed in.
1.542 raeburn 322:
1.42 matthew 323: =cut
324:
325: sub browser_and_searcher_javascript {
1.199 albertel 326: my ($mode)=@_;
327: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 328: my $resurl=&escape_single(&lastresurl());
1.42 matthew 329: return <<END;
1.219 albertel 330: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 331: var editbrowser = null;
1.135 albertel 332: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 333: var url = '$resurl/?';
1.42 matthew 334: if (editbrowser == null) {
335: url += 'launch=1&';
336: }
337: url += 'catalogmode=interactive&';
1.199 albertel 338: url += 'mode=$mode&';
1.611 albertel 339: url += 'inhibitmenu=yes&';
1.42 matthew 340: url += 'form=' + formname + '&';
341: if (only != null) {
342: url += 'only=' + only + '&';
1.217 albertel 343: } else {
344: url += 'only=&';
345: }
1.42 matthew 346: if (omit != null) {
347: url += 'omit=' + omit + '&';
1.217 albertel 348: } else {
349: url += 'omit=&';
350: }
1.135 albertel 351: if (titleelement != null) {
352: url += 'titleelement=' + titleelement + '&';
1.217 albertel 353: } else {
354: url += 'titleelement=&';
355: }
1.42 matthew 356: url += 'element=' + elementname + '';
357: var title = 'Browser';
1.435 albertel 358: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 359: options += ',width=700,height=600';
360: editbrowser = open(url,title,options,'1');
361: editbrowser.focus();
362: }
363: var editsearcher;
1.135 albertel 364: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 365: var url = '/adm/searchcat?';
366: if (editsearcher == null) {
367: url += 'launch=1&';
368: }
369: url += 'catalogmode=interactive&';
1.199 albertel 370: url += 'mode=$mode&';
1.42 matthew 371: url += 'form=' + formname + '&';
1.135 albertel 372: if (titleelement != null) {
373: url += 'titleelement=' + titleelement + '&';
1.217 albertel 374: } else {
375: url += 'titleelement=&';
376: }
1.42 matthew 377: url += 'element=' + elementname + '';
378: var title = 'Search';
1.435 albertel 379: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 380: options += ',width=700,height=600';
381: editsearcher = open(url,title,options,'1');
382: editsearcher.focus();
383: }
1.219 albertel 384: // END LON-CAPA Internal -->
1.42 matthew 385: END
1.170 www 386: }
387:
388: sub lastresurl {
1.258 albertel 389: if ($env{'environment.lastresurl'}) {
390: return $env{'environment.lastresurl'}
1.170 www 391: } else {
392: return '/res';
393: }
394: }
395:
396: sub storeresurl {
397: my $resurl=&Apache::lonnet::clutter(shift);
398: unless ($resurl=~/^\/res/) { return 0; }
399: $resurl=~s/\/$//;
400: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 401: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 402: return 1;
1.42 matthew 403: }
404:
1.74 www 405: sub studentbrowser_javascript {
1.111 www 406: unless (
1.258 albertel 407: (($env{'request.course.id'}) &&
1.302 albertel 408: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
409: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
410: '/'.$env{'request.course.sec'})
411: ))
1.258 albertel 412: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 413: ) { return ''; }
1.74 www 414: return (<<'ENDSTDBRW');
1.776 bisitz 415: <script type="text/javascript" language="Javascript">
1.824 bisitz 416: // <![CDATA[
1.74 www 417: var stdeditbrowser;
1.999 www 418: function openstdbrowser(formname,uname,udom,clicker,roleflag,ignorefilter,courseadvonly) {
1.74 www 419: var url = '/adm/pickstudent?';
420: var filter;
1.558 albertel 421: if (!ignorefilter) {
422: eval('filter=document.'+formname+'.'+uname+'.value;');
423: }
1.74 www 424: if (filter != null) {
425: if (filter != '') {
426: url += 'filter='+filter+'&';
427: }
428: }
429: url += 'form=' + formname + '&unameelement='+uname+
1.999 www 430: '&udomelement='+udom+
431: '&clicker='+clicker;
1.111 www 432: if (roleflag) { url+="&roles=1"; }
1.793 raeburn 433: if (courseadvonly) { url+="&courseadvonly=1"; }
1.102 www 434: var title = 'Student_Browser';
1.74 www 435: var options = 'scrollbars=1,resizable=1,menubar=0';
436: options += ',width=700,height=600';
437: stdeditbrowser = open(url,title,options,'1');
438: stdeditbrowser.focus();
439: }
1.824 bisitz 440: // ]]>
1.74 www 441: </script>
442: ENDSTDBRW
443: }
1.42 matthew 444:
1.1003 www 445: sub resourcebrowser_javascript {
446: unless ($env{'request.course.id'}) { return ''; }
1.1004 www 447: return (<<'ENDRESBRW');
1.1003 www 448: <script type="text/javascript" language="Javascript">
449: // <![CDATA[
450: var reseditbrowser;
1.1004 www 451: function openresbrowser(formname,reslink) {
1.1005 www 452: var url = '/adm/pickresource?form='+formname+'&reslink='+reslink;
1.1003 www 453: var title = 'Resource_Browser';
454: var options = 'scrollbars=1,resizable=1,menubar=0';
1.1005 www 455: options += ',width=700,height=500';
1.1004 www 456: reseditbrowser = open(url,title,options,'1');
457: reseditbrowser.focus();
1.1003 www 458: }
459: // ]]>
460: </script>
1.1004 www 461: ENDRESBRW
1.1003 www 462: }
463:
1.74 www 464: sub selectstudent_link {
1.999 www 465: my ($form,$unameele,$udomele,$courseadvonly,$clickerid)=@_;
466: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
467: &Apache::lonhtmlcommon::entity_encode($unameele)."','".
468: &Apache::lonhtmlcommon::entity_encode($udomele)."'";
1.258 albertel 469: if ($env{'request.course.id'}) {
1.302 albertel 470: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
471: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
472: '/'.$env{'request.course.sec'})) {
1.111 www 473: return '';
474: }
1.999 www 475: $callargs.=",'".&Apache::lonhtmlcommon::entity_encode($clickerid)."'";
1.793 raeburn 476: if ($courseadvonly) {
477: $callargs .= ",'',1,1";
478: }
479: return '<span class="LC_nobreak">'.
480: '<a href="javascript:openstdbrowser('.$callargs.');">'.
481: &mt('Select User').'</a></span>';
1.74 www 482: }
1.258 albertel 483: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.1012 www 484: $callargs .= ",'',1";
1.793 raeburn 485: return '<span class="LC_nobreak">'.
486: '<a href="javascript:openstdbrowser('.$callargs.');">'.
487: &mt('Select User').'</a></span>';
1.111 www 488: }
489: return '';
1.91 www 490: }
491:
1.1004 www 492: sub selectresource_link {
493: my ($form,$reslink,$arg)=@_;
494:
495: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
496: &Apache::lonhtmlcommon::entity_encode($reslink)."'";
497: unless ($env{'request.course.id'}) { return $arg; }
498: return '<span class="LC_nobreak">'.
499: '<a href="javascript:openresbrowser('.$callargs.');">'.
500: $arg.'</a></span>';
501: }
502:
503:
504:
1.653 raeburn 505: sub authorbrowser_javascript {
506: return <<"ENDAUTHORBRW";
1.776 bisitz 507: <script type="text/javascript" language="JavaScript">
1.824 bisitz 508: // <![CDATA[
1.653 raeburn 509: var stdeditbrowser;
510:
511: function openauthorbrowser(formname,udom) {
512: var url = '/adm/pickauthor?';
513: url += 'form='+formname+'&roledom='+udom;
514: var title = 'Author_Browser';
515: var options = 'scrollbars=1,resizable=1,menubar=0';
516: options += ',width=700,height=600';
517: stdeditbrowser = open(url,title,options,'1');
518: stdeditbrowser.focus();
519: }
520:
1.824 bisitz 521: // ]]>
1.653 raeburn 522: </script>
523: ENDAUTHORBRW
524: }
525:
1.91 www 526: sub coursebrowser_javascript {
1.909 raeburn 527: my ($domainfilter,$sec_element,$formname,$role_element,$crstype) = @_;
1.932 raeburn 528: my $wintitle = 'Course_Browser';
1.931 raeburn 529: if ($crstype eq 'Community') {
1.932 raeburn 530: $wintitle = 'Community_Browser';
1.909 raeburn 531: }
1.876 raeburn 532: my $id_functions = &javascript_index_functions();
533: my $output = '
1.776 bisitz 534: <script type="text/javascript" language="JavaScript">
1.824 bisitz 535: // <![CDATA[
1.468 raeburn 536: var stdeditbrowser;'."\n";
1.876 raeburn 537:
538: $output .= <<"ENDSTDBRW";
1.909 raeburn 539: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91 www 540: var url = '/adm/pickcourse?';
1.895 raeburn 541: var formid = getFormIdByName(formname);
1.876 raeburn 542: var domainfilter = getDomainFromSelectbox(formname,udom);
1.128 albertel 543: if (domainfilter != null) {
544: if (domainfilter != '') {
545: url += 'domainfilter='+domainfilter+'&';
546: }
547: }
1.91 www 548: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 549: '&cdomelement='+udom+
550: '&cnameelement='+desc;
1.468 raeburn 551: if (extra_element !=null && extra_element != '') {
1.594 raeburn 552: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 553: url += '&roleelement='+extra_element;
554: if (domainfilter == null || domainfilter == '') {
555: url += '&domainfilter='+extra_element;
556: }
1.234 raeburn 557: }
1.468 raeburn 558: else {
559: if (formname == 'portform') {
560: url += '&setroles='+extra_element;
1.800 raeburn 561: } else {
562: if (formname == 'rules') {
563: url += '&fixeddom='+extra_element;
564: }
1.468 raeburn 565: }
566: }
1.230 raeburn 567: }
1.909 raeburn 568: if (type != null && type != '') {
569: url += '&type='+type;
570: }
571: if (type_elem != null && type_elem != '') {
572: url += '&typeelement='+type_elem;
573: }
1.872 raeburn 574: if (formname == 'ccrs') {
575: var ownername = document.forms[formid].ccuname.value;
576: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
577: url += '&cloner='+ownername+':'+ownerdom;
578: }
1.293 raeburn 579: if (multflag !=null && multflag != '') {
580: url += '&multiple='+multflag;
581: }
1.909 raeburn 582: var title = '$wintitle';
1.91 www 583: var options = 'scrollbars=1,resizable=1,menubar=0';
584: options += ',width=700,height=600';
585: stdeditbrowser = open(url,title,options,'1');
586: stdeditbrowser.focus();
587: }
1.876 raeburn 588: $id_functions
589: ENDSTDBRW
1.905 raeburn 590: if (($sec_element ne '') || ($role_element ne '')) {
591: $output .= &setsec_javascript($sec_element,$formname,$role_element);
1.876 raeburn 592: }
593: $output .= '
594: // ]]>
595: </script>';
596: return $output;
597: }
598:
599: sub javascript_index_functions {
600: return <<"ENDJS";
601:
602: function getFormIdByName(formname) {
603: for (var i=0;i<document.forms.length;i++) {
604: if (document.forms[i].name == formname) {
605: return i;
606: }
607: }
608: return -1;
609: }
610:
611: function getIndexByName(formid,item) {
612: for (var i=0;i<document.forms[formid].elements.length;i++) {
613: if (document.forms[formid].elements[i].name == item) {
614: return i;
615: }
616: }
617: return -1;
618: }
1.468 raeburn 619:
1.876 raeburn 620: function getDomainFromSelectbox(formname,udom) {
621: var userdom;
622: var formid = getFormIdByName(formname);
623: if (formid > -1) {
624: var domid = getIndexByName(formid,udom);
625: if (domid > -1) {
626: if (document.forms[formid].elements[domid].type == 'select-one') {
627: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
628: }
629: if (document.forms[formid].elements[domid].type == 'hidden') {
630: userdom=document.forms[formid].elements[domid].value;
1.468 raeburn 631: }
632: }
633: }
1.876 raeburn 634: return userdom;
635: }
636:
637: ENDJS
1.468 raeburn 638:
1.876 raeburn 639: }
640:
1.1017 raeburn 641: sub javascript_array_indexof {
1.1018 raeburn 642: return <<ENDJS;
1.1017 raeburn 643: <script type="text/javascript" language="JavaScript">
644: // <![CDATA[
645:
646: if (!Array.prototype.indexOf) {
647: Array.prototype.indexOf = function (searchElement /*, fromIndex */ ) {
648: "use strict";
649: if (this === void 0 || this === null) {
650: throw new TypeError();
651: }
652: var t = Object(this);
653: var len = t.length >>> 0;
654: if (len === 0) {
655: return -1;
656: }
657: var n = 0;
658: if (arguments.length > 0) {
659: n = Number(arguments[1]);
660: if (n !== n) { // shortcut for verifying if it's NaN
661: n = 0;
662: } else if (n !== 0 && n !== (1 / 0) && n !== -(1 / 0)) {
663: n = (n > 0 || -1) * Math.floor(Math.abs(n));
664: }
665: }
666: if (n >= len) {
667: return -1;
668: }
669: var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
670: for (; k < len; k++) {
671: if (k in t && t[k] === searchElement) {
672: return k;
673: }
674: }
675: return -1;
676: }
677: }
678:
679: // ]]>
680: </script>
681:
682: ENDJS
683:
684: }
685:
1.876 raeburn 686: sub userbrowser_javascript {
687: my $id_functions = &javascript_index_functions();
688: return <<"ENDUSERBRW";
689:
1.888 raeburn 690: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876 raeburn 691: var url = '/adm/pickuser?';
692: var userdom = getDomainFromSelectbox(formname,udom);
693: if (userdom != null) {
694: if (userdom != '') {
695: url += 'srchdom='+userdom+'&';
696: }
697: }
698: url += 'form=' + formname + '&unameelement='+uname+
699: '&udomelement='+udom+
700: '&ulastelement='+ulast+
701: '&ufirstelement='+ufirst+
702: '&uemailelement='+uemail+
1.881 raeburn 703: '&hideudomelement='+hideudom+
704: '&coursedom='+crsdom;
1.888 raeburn 705: if ((caller != null) && (caller != undefined)) {
706: url += '&caller='+caller;
707: }
1.876 raeburn 708: var title = 'User_Browser';
709: var options = 'scrollbars=1,resizable=1,menubar=0';
710: options += ',width=700,height=600';
711: var stdeditbrowser = open(url,title,options,'1');
712: stdeditbrowser.focus();
713: }
714:
1.888 raeburn 715: function fix_domain (formname,udom,origdom,uname) {
1.876 raeburn 716: var formid = getFormIdByName(formname);
717: if (formid > -1) {
1.888 raeburn 718: var unameid = getIndexByName(formid,uname);
1.876 raeburn 719: var domid = getIndexByName(formid,udom);
720: var hidedomid = getIndexByName(formid,origdom);
721: if (hidedomid > -1) {
722: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888 raeburn 723: var unameval = document.forms[formid].elements[unameid].value;
724: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
725: if (domid > -1) {
726: var slct = document.forms[formid].elements[domid];
727: if (slct.type == 'select-one') {
728: var i;
729: for (i=0;i<slct.length;i++) {
730: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
731: }
732: }
733: if (slct.type == 'hidden') {
734: slct.value = fixeddom;
1.876 raeburn 735: }
736: }
1.468 raeburn 737: }
738: }
739: }
1.876 raeburn 740: return;
741: }
742:
743: $id_functions
744: ENDUSERBRW
1.468 raeburn 745: }
746:
747: sub setsec_javascript {
1.905 raeburn 748: my ($sec_element,$formname,$role_element) = @_;
749: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
750: $communityrolestr);
751: if ($role_element ne '') {
752: my @allroles = ('st','ta','ep','in','ad');
753: foreach my $crstype ('Course','Community') {
754: if ($crstype eq 'Community') {
755: foreach my $role (@allroles) {
756: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
757: }
758: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
759: } else {
760: foreach my $role (@allroles) {
761: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
762: }
763: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
764: }
765: }
766: $rolestr = '"'.join('","',@allroles).'"';
767: $courserolestr = '"'.join('","',@courserolenames).'"';
768: $communityrolestr = '"'.join('","',@communityrolenames).'"';
769: }
1.468 raeburn 770: my $setsections = qq|
771: function setSect(sectionlist) {
1.629 raeburn 772: var sectionsArray = new Array();
773: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
774: sectionsArray = sectionlist.split(",");
775: }
1.468 raeburn 776: var numSections = sectionsArray.length;
777: document.$formname.$sec_element.length = 0;
778: if (numSections == 0) {
779: document.$formname.$sec_element.multiple=false;
780: document.$formname.$sec_element.size=1;
781: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
782: } else {
783: if (numSections == 1) {
784: document.$formname.$sec_element.multiple=false;
785: document.$formname.$sec_element.size=1;
786: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
787: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
788: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
789: } else {
790: for (var i=0; i<numSections; i++) {
791: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
792: }
793: document.$formname.$sec_element.multiple=true
794: if (numSections < 3) {
795: document.$formname.$sec_element.size=numSections;
796: } else {
797: document.$formname.$sec_element.size=3;
798: }
799: document.$formname.$sec_element.options[0].selected = false
800: }
801: }
1.91 www 802: }
1.905 raeburn 803:
804: function setRole(crstype) {
1.468 raeburn 805: |;
1.905 raeburn 806: if ($role_element eq '') {
807: $setsections .= ' return;
808: }
809: ';
810: } else {
811: $setsections .= qq|
812: var elementLength = document.$formname.$role_element.length;
813: var allroles = Array($rolestr);
814: var courserolenames = Array($courserolestr);
815: var communityrolenames = Array($communityrolestr);
816: if (elementLength != undefined) {
817: if (document.$formname.$role_element.options[5].value == 'cc') {
818: if (crstype == 'Course') {
819: return;
820: } else {
821: allroles[5] = 'co';
822: for (var i=0; i<6; i++) {
823: document.$formname.$role_element.options[i].value = allroles[i];
824: document.$formname.$role_element.options[i].text = communityrolenames[i];
825: }
826: }
827: } else {
828: if (crstype == 'Community') {
829: return;
830: } else {
831: allroles[5] = 'cc';
832: for (var i=0; i<6; i++) {
833: document.$formname.$role_element.options[i].value = allroles[i];
834: document.$formname.$role_element.options[i].text = courserolenames[i];
835: }
836: }
837: }
838: }
839: return;
840: }
841: |;
842: }
1.468 raeburn 843: return $setsections;
844: }
845:
1.91 www 846: sub selectcourse_link {
1.909 raeburn 847: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
848: $typeelement) = @_;
849: my $type = $selecttype;
1.871 raeburn 850: my $linktext = &mt('Select Course');
851: if ($selecttype eq 'Community') {
1.909 raeburn 852: $linktext = &mt('Select Community');
1.906 raeburn 853: } elsif ($selecttype eq 'Course/Community') {
854: $linktext = &mt('Select Course/Community');
1.909 raeburn 855: $type = '';
1.1019 raeburn 856: } elsif ($selecttype eq 'Select') {
857: $linktext = &mt('Select');
858: $type = '';
1.871 raeburn 859: }
1.787 bisitz 860: return '<span class="LC_nobreak">'
861: ."<a href='"
862: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
863: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 864: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 865: ."'>".$linktext.'</a>'
1.787 bisitz 866: .'</span>';
1.74 www 867: }
1.42 matthew 868:
1.653 raeburn 869: sub selectauthor_link {
870: my ($form,$udom)=@_;
871: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
872: &mt('Select Author').'</a>';
873: }
874:
1.876 raeburn 875: sub selectuser_link {
1.881 raeburn 876: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 877: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 878: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 879: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 880: ');">'.$linktext.'</a>';
1.876 raeburn 881: }
882:
1.273 raeburn 883: sub check_uncheck_jscript {
884: my $jscript = <<"ENDSCRT";
885: function checkAll(field) {
886: if (field.length > 0) {
887: for (i = 0; i < field.length; i++) {
888: field[i].checked = true ;
889: }
890: } else {
891: field.checked = true
892: }
893: }
894:
895: function uncheckAll(field) {
896: if (field.length > 0) {
897: for (i = 0; i < field.length; i++) {
898: field[i].checked = false ;
1.543 albertel 899: }
900: } else {
1.273 raeburn 901: field.checked = false ;
902: }
903: }
904: ENDSCRT
905: return $jscript;
906: }
907:
1.656 www 908: sub select_timezone {
1.659 raeburn 909: my ($name,$selected,$onchange,$includeempty)=@_;
910: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
911: if ($includeempty) {
912: $output .= '<option value=""';
913: if (($selected eq '') || ($selected eq 'local')) {
914: $output .= ' selected="selected" ';
915: }
916: $output .= '> </option>';
917: }
1.657 raeburn 918: my @timezones = DateTime::TimeZone->all_names;
919: foreach my $tzone (@timezones) {
920: $output.= '<option value="'.$tzone.'"';
921: if ($tzone eq $selected) {
922: $output.=' selected="selected"';
923: }
924: $output.=">$tzone</option>\n";
1.656 www 925: }
926: $output.="</select>";
927: return $output;
928: }
1.273 raeburn 929:
1.687 raeburn 930: sub select_datelocale {
931: my ($name,$selected,$onchange,$includeempty)=@_;
932: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
933: if ($includeempty) {
934: $output .= '<option value=""';
935: if ($selected eq '') {
936: $output .= ' selected="selected" ';
937: }
938: $output .= '> </option>';
939: }
940: my (@possibles,%locale_names);
941: my @locales = DateTime::Locale::Catalog::Locales;
942: foreach my $locale (@locales) {
943: if (ref($locale) eq 'HASH') {
944: my $id = $locale->{'id'};
945: if ($id ne '') {
946: my $en_terr = $locale->{'en_territory'};
947: my $native_terr = $locale->{'native_territory'};
1.695 raeburn 948: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 949: if (grep(/^en$/,@languages) || !@languages) {
950: if ($en_terr ne '') {
951: $locale_names{$id} = '('.$en_terr.')';
952: } elsif ($native_terr ne '') {
953: $locale_names{$id} = $native_terr;
954: }
955: } else {
956: if ($native_terr ne '') {
957: $locale_names{$id} = $native_terr.' ';
958: } elsif ($en_terr ne '') {
959: $locale_names{$id} = '('.$en_terr.')';
960: }
961: }
962: push (@possibles,$id);
963: }
964: }
965: }
966: foreach my $item (sort(@possibles)) {
967: $output.= '<option value="'.$item.'"';
968: if ($item eq $selected) {
969: $output.=' selected="selected"';
970: }
971: $output.=">$item";
972: if ($locale_names{$item} ne '') {
973: $output.=" $locale_names{$item}</option>\n";
974: }
975: $output.="</option>\n";
976: }
977: $output.="</select>";
978: return $output;
979: }
980:
1.792 raeburn 981: sub select_language {
982: my ($name,$selected,$includeempty) = @_;
983: my %langchoices;
984: if ($includeempty) {
985: %langchoices = ('' => 'No language preference');
986: }
987: foreach my $id (&languageids()) {
988: my $code = &supportedlanguagecode($id);
989: if ($code) {
990: $langchoices{$code} = &plainlanguagedescription($id);
991: }
992: }
1.970 raeburn 993: return &select_form($selected,$name,\%langchoices);
1.792 raeburn 994: }
995:
1.42 matthew 996: =pod
1.36 matthew 997:
1.648 raeburn 998: =item * &linked_select_forms(...)
1.36 matthew 999:
1000: linked_select_forms returns a string containing a <script></script> block
1001: and html for two <select> menus. The select menus will be linked in that
1002: changing the value of the first menu will result in new values being placed
1003: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 1004: order unless a defined order is provided.
1.36 matthew 1005:
1006: linked_select_forms takes the following ordered inputs:
1007:
1008: =over 4
1009:
1.112 bowersj2 1010: =item * $formname, the name of the <form> tag
1.36 matthew 1011:
1.112 bowersj2 1012: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 1013:
1.112 bowersj2 1014: =item * $firstdefault, the default value for the first menu
1.36 matthew 1015:
1.112 bowersj2 1016: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 1017:
1.112 bowersj2 1018: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 1019:
1.112 bowersj2 1020: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 1021:
1.609 raeburn 1022: =item * $menuorder, the order of values in the first menu
1023:
1.41 ng 1024: =back
1025:
1.36 matthew 1026: Below is an example of such a hash. Only the 'text', 'default', and
1027: 'select2' keys must appear as stated. keys(%menu) are the possible
1028: values for the first select menu. The text that coincides with the
1.41 ng 1029: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 1030: and text for the second menu are given in the hash pointed to by
1031: $menu{$choice1}->{'select2'}.
1032:
1.112 bowersj2 1033: my %menu = ( A1 => { text =>"Choice A1" ,
1034: default => "B3",
1035: select2 => {
1036: B1 => "Choice B1",
1037: B2 => "Choice B2",
1038: B3 => "Choice B3",
1039: B4 => "Choice B4"
1.609 raeburn 1040: },
1041: order => ['B4','B3','B1','B2'],
1.112 bowersj2 1042: },
1043: A2 => { text =>"Choice A2" ,
1044: default => "C2",
1045: select2 => {
1046: C1 => "Choice C1",
1047: C2 => "Choice C2",
1048: C3 => "Choice C3"
1.609 raeburn 1049: },
1050: order => ['C2','C1','C3'],
1.112 bowersj2 1051: },
1052: A3 => { text =>"Choice A3" ,
1053: default => "D6",
1054: select2 => {
1055: D1 => "Choice D1",
1056: D2 => "Choice D2",
1057: D3 => "Choice D3",
1058: D4 => "Choice D4",
1059: D5 => "Choice D5",
1060: D6 => "Choice D6",
1061: D7 => "Choice D7"
1.609 raeburn 1062: },
1063: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 1064: }
1065: );
1.36 matthew 1066:
1067: =cut
1068:
1069: sub linked_select_forms {
1070: my ($formname,
1071: $middletext,
1072: $firstdefault,
1073: $firstselectname,
1074: $secondselectname,
1.609 raeburn 1075: $hashref,
1076: $menuorder,
1.36 matthew 1077: ) = @_;
1078: my $second = "document.$formname.$secondselectname";
1079: my $first = "document.$formname.$firstselectname";
1080: # output the javascript to do the changing
1081: my $result = '';
1.776 bisitz 1082: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 1083: $result.="// <![CDATA[\n";
1.36 matthew 1084: $result.="var select2data = new Object();\n";
1085: $" = '","';
1086: my $debug = '';
1087: foreach my $s1 (sort(keys(%$hashref))) {
1088: $result.="select2data.d_$s1 = new Object();\n";
1089: $result.="select2data.d_$s1.def = new String('".
1090: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 1091: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 1092: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1093: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1094: @s2values = @{$hashref->{$s1}->{'order'}};
1095: }
1.36 matthew 1096: $result.="\"@s2values\");\n";
1097: $result.="select2data.d_$s1.texts = new Array(";
1098: my @s2texts;
1099: foreach my $value (@s2values) {
1100: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
1101: }
1102: $result.="\"@s2texts\");\n";
1103: }
1104: $"=' ';
1105: $result.= <<"END";
1106:
1107: function select1_changed() {
1108: // Determine new choice
1109: var newvalue = "d_" + $first.value;
1110: // update select2
1111: var values = select2data[newvalue].values;
1112: var texts = select2data[newvalue].texts;
1113: var select2def = select2data[newvalue].def;
1114: var i;
1115: // out with the old
1116: for (i = 0; i < $second.options.length; i++) {
1117: $second.options[i] = null;
1118: }
1119: // in with the nuclear
1120: for (i=0;i<values.length; i++) {
1121: $second.options[i] = new Option(values[i]);
1.143 matthew 1122: $second.options[i].value = values[i];
1.36 matthew 1123: $second.options[i].text = texts[i];
1124: if (values[i] == select2def) {
1125: $second.options[i].selected = true;
1126: }
1127: }
1128: }
1.824 bisitz 1129: // ]]>
1.36 matthew 1130: </script>
1131: END
1132: # output the initial values for the selection lists
1133: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609 raeburn 1134: my @order = sort(keys(%{$hashref}));
1135: if (ref($menuorder) eq 'ARRAY') {
1136: @order = @{$menuorder};
1137: }
1138: foreach my $value (@order) {
1.36 matthew 1139: $result.=" <option value=\"$value\" ";
1.253 albertel 1140: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1141: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1142: }
1143: $result .= "</select>\n";
1144: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1145: $result .= $middletext;
1146: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
1147: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1148:
1149: my @secondorder = sort(keys(%select2));
1150: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1151: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1152: }
1153: foreach my $value (@secondorder) {
1.36 matthew 1154: $result.=" <option value=\"$value\" ";
1.253 albertel 1155: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1156: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1157: }
1158: $result .= "</select>\n";
1159: # return $debug;
1160: return $result;
1161: } # end of sub linked_select_forms {
1162:
1.45 matthew 1163: =pod
1.44 bowersj2 1164:
1.973 raeburn 1165: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid)
1.44 bowersj2 1166:
1.112 bowersj2 1167: Returns a string corresponding to an HTML link to the given help
1168: $topic, where $topic corresponds to the name of a .tex file in
1169: /home/httpd/html/adm/help/tex, with underscores replaced by
1170: spaces.
1171:
1172: $text will optionally be linked to the same topic, allowing you to
1173: link text in addition to the graphic. If you do not want to link
1174: text, but wish to specify one of the later parameters, pass an
1175: empty string.
1176:
1177: $stayOnPage is a value that will be interpreted as a boolean. If true,
1178: the link will not open a new window. If false, the link will open
1179: a new window using Javascript. (Default is false.)
1180:
1181: $width and $height are optional numerical parameters that will
1182: override the width and height of the popped up window, which may
1.973 raeburn 1183: be useful for certain help topics with big pictures included.
1184:
1185: $imgid is the id of the img tag used for the help icon. This may be
1186: used in a javascript call to switch the image src. See
1187: lonhtmlcommon::htmlareaselectactive() for an example.
1.44 bowersj2 1188:
1189: =cut
1190:
1191: sub help_open_topic {
1.973 raeburn 1192: my ($topic, $text, $stayOnPage, $width, $height, $imgid) = @_;
1.48 bowersj2 1193: $text = "" if (not defined $text);
1.44 bowersj2 1194: $stayOnPage = 0 if (not defined $stayOnPage);
1.1033 www 1195: $width = 500 if (not defined $width);
1.44 bowersj2 1196: $height = 400 if (not defined $height);
1197: my $filename = $topic;
1198: $filename =~ s/ /_/g;
1199:
1.48 bowersj2 1200: my $template = "";
1201: my $link;
1.572 banghart 1202:
1.159 www 1203: $topic=~s/\W/\_/g;
1.44 bowersj2 1204:
1.572 banghart 1205: if (!$stayOnPage) {
1.1033 www 1206: $link = "javascript:openMyModal('/adm/help/${filename}.hlp',$width,$height,'yes');";
1.1037 www 1207: } elsif ($stayOnPage eq 'popup') {
1208: $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 1209: } else {
1.48 bowersj2 1210: $link = "/adm/help/${filename}.hlp";
1211: }
1212:
1213: # Add the text
1.755 neumanie 1214: if ($text ne "") {
1.763 bisitz 1215: $template.='<span class="LC_help_open_topic">'
1216: .'<a target="_top" href="'.$link.'">'
1217: .$text.'</a>';
1.48 bowersj2 1218: }
1219:
1.763 bisitz 1220: # (Always) Add the graphic
1.179 matthew 1221: my $title = &mt('Online Help');
1.667 raeburn 1222: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973 raeburn 1223: if ($imgid ne '') {
1224: $imgid = ' id="'.$imgid.'"';
1225: }
1.763 bisitz 1226: $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
1227: .'<img src="'.$helpicon.'" border="0"'
1228: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973 raeburn 1229: .' title="'.$title.'" style="vertical-align:middle;"'.$imgid
1.763 bisitz 1230: .' /></a>';
1231: if ($text ne "") {
1232: $template.='</span>';
1233: }
1.44 bowersj2 1234: return $template;
1235:
1.106 bowersj2 1236: }
1237:
1238: # This is a quicky function for Latex cheatsheet editing, since it
1239: # appears in at least four places
1240: sub helpLatexCheatsheet {
1.1037 www 1241: my ($topic,$text,$not_author,$stayOnPage) = @_;
1.732 raeburn 1242: my $out;
1.106 bowersj2 1243: my $addOther = '';
1.732 raeburn 1244: if ($topic) {
1.1037 www 1245: $addOther = '<span>'.&help_open_topic($topic,&mt($text),$stayOnPage, undef, 600).'</span> ';
1.763 bisitz 1246: }
1247: $out = '<span>' # Start cheatsheet
1248: .$addOther
1249: .'<span>'
1.1037 www 1250: .&help_open_topic('Greek_Symbols',&mt('Greek Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1251: .'</span> <span>'
1.1037 www 1252: .&help_open_topic('Other_Symbols',&mt('Other Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1253: .'</span>';
1.732 raeburn 1254: unless ($not_author) {
1.763 bisitz 1255: $out .= ' <span>'
1.1037 www 1256: .&help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),$stayOnPage,undef,600)
1.763 bisitz 1257: .'</span>';
1.732 raeburn 1258: }
1.763 bisitz 1259: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1260: return $out;
1.172 www 1261: }
1262:
1.430 albertel 1263: sub general_help {
1264: my $helptopic='Student_Intro';
1265: if ($env{'request.role'}=~/^(ca|au)/) {
1266: $helptopic='Authoring_Intro';
1.907 raeburn 1267: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1268: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1269: } elsif ($env{'request.role'}=~/^dc/) {
1270: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1271: }
1272: return $helptopic;
1273: }
1274:
1275: sub update_help_link {
1276: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1277: my $origurl = $ENV{'REQUEST_URI'};
1278: $origurl=~s|^/~|/priv/|;
1279: my $timestamp = time;
1280: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1281: $$datum = &escape($$datum);
1282: }
1283:
1284: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1285: my $output .= <<"ENDOUTPUT";
1286: <script type="text/javascript">
1.824 bisitz 1287: // <![CDATA[
1.430 albertel 1288: banner_link = '$banner_link';
1.824 bisitz 1289: // ]]>
1.430 albertel 1290: </script>
1291: ENDOUTPUT
1292: return $output;
1293: }
1294:
1295: # now just updates the help link and generates a blue icon
1.193 raeburn 1296: sub help_open_menu {
1.430 albertel 1297: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1298: = @_;
1.949 droeschl 1299: $stayOnPage = 1;
1.430 albertel 1300: my $output;
1301: if ($component_help) {
1302: if (!$text) {
1303: $output=&help_open_topic($component_help,undef,$stayOnPage,
1304: $width,$height);
1305: } else {
1306: my $help_text;
1307: $help_text=&unescape($topic);
1308: $output='<table><tr><td>'.
1309: &help_open_topic($component_help,$help_text,$stayOnPage,
1310: $width,$height).'</td></tr></table>';
1311: }
1312: }
1313: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1314: return $output.$banner_link;
1315: }
1316:
1317: sub top_nav_help {
1318: my ($text) = @_;
1.436 albertel 1319: $text = &mt($text);
1.949 droeschl 1320: my $stay_on_page = 1;
1321:
1.572 banghart 1322: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1323: : "javascript:helpMenu('open')";
1.572 banghart 1324: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1325:
1.201 raeburn 1326: my $title = &mt('Get help');
1.436 albertel 1327:
1328: return <<"END";
1329: $banner_link
1330: <a href="$link" title="$title">$text</a>
1331: END
1332: }
1333:
1334: sub help_menu_js {
1335: my ($text) = @_;
1.949 droeschl 1336: my $stayOnPage = 1;
1.436 albertel 1337: my $width = 620;
1338: my $height = 600;
1.430 albertel 1339: my $helptopic=&general_help();
1340: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1341: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1342: my $start_page =
1343: &Apache::loncommon::start_page('Help Menu', undef,
1344: {'frameset' => 1,
1345: 'js_ready' => 1,
1346: 'add_entries' => {
1347: 'border' => '0',
1.579 raeburn 1348: 'rows' => "110,*",},});
1.331 albertel 1349: my $end_page =
1350: &Apache::loncommon::end_page({'frameset' => 1,
1351: 'js_ready' => 1,});
1352:
1.436 albertel 1353: my $template .= <<"ENDTEMPLATE";
1354: <script type="text/javascript">
1.877 bisitz 1355: // <![CDATA[
1.253 albertel 1356: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1357: var banner_link = '';
1.243 raeburn 1358: function helpMenu(target) {
1359: var caller = this;
1360: if (target == 'open') {
1361: var newWindow = null;
1362: try {
1.262 albertel 1363: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1364: }
1365: catch(error) {
1366: writeHelp(caller);
1367: return;
1368: }
1369: if (newWindow) {
1370: caller = newWindow;
1371: }
1.193 raeburn 1372: }
1.243 raeburn 1373: writeHelp(caller);
1374: return;
1375: }
1376: function writeHelp(caller) {
1.1072 raeburn 1377: caller.document.writeln('$start_page\\n<frame name="bannerframe" src="'+banner_link+'" />\\n<frame name="bodyframe" src="$details_link" />\\n$end_page')
1.243 raeburn 1378: caller.document.close()
1379: caller.focus()
1.193 raeburn 1380: }
1.877 bisitz 1381: // END LON-CAPA Internal -->
1.253 albertel 1382: // ]]>
1.436 albertel 1383: </script>
1.193 raeburn 1384: ENDTEMPLATE
1385: return $template;
1386: }
1387:
1.172 www 1388: sub help_open_bug {
1389: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1390: unless ($env{'user.adv'}) { return ''; }
1.172 www 1391: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1392: $text = "" if (not defined $text);
1393: $stayOnPage=1;
1.184 albertel 1394: $width = 600 if (not defined $width);
1395: $height = 600 if (not defined $height);
1.172 www 1396:
1397: $topic=~s/\W+/\+/g;
1398: my $link='';
1399: my $template='';
1.379 albertel 1400: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1401: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1402: if (!$stayOnPage)
1403: {
1404: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1405: }
1406: else
1407: {
1408: $link = $url;
1409: }
1410: # Add the text
1411: if ($text ne "")
1412: {
1413: $template .=
1414: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1415: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1416: }
1417:
1418: # Add the graphic
1.179 matthew 1419: my $title = &mt('Report a Bug');
1.215 albertel 1420: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1421: $template .= <<"ENDTEMPLATE";
1.436 albertel 1422: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1423: ENDTEMPLATE
1424: if ($text ne '') { $template.='</td></tr></table>' };
1425: return $template;
1426:
1427: }
1428:
1429: sub help_open_faq {
1430: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1431: unless ($env{'user.adv'}) { return ''; }
1.172 www 1432: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1433: $text = "" if (not defined $text);
1434: $stayOnPage=1;
1435: $width = 350 if (not defined $width);
1436: $height = 400 if (not defined $height);
1437:
1438: $topic=~s/\W+/\+/g;
1439: my $link='';
1440: my $template='';
1441: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1442: if (!$stayOnPage)
1443: {
1444: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1445: }
1446: else
1447: {
1448: $link = $url;
1449: }
1450:
1451: # Add the text
1452: if ($text ne "")
1453: {
1454: $template .=
1.173 www 1455: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1456: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1457: }
1458:
1459: # Add the graphic
1.179 matthew 1460: my $title = &mt('View the FAQ');
1.215 albertel 1461: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1462: $template .= <<"ENDTEMPLATE";
1.436 albertel 1463: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1464: ENDTEMPLATE
1465: if ($text ne '') { $template.='</td></tr></table>' };
1466: return $template;
1467:
1.44 bowersj2 1468: }
1.37 matthew 1469:
1.180 matthew 1470: ###############################################################
1471: ###############################################################
1472:
1.45 matthew 1473: =pod
1474:
1.648 raeburn 1475: =item * &change_content_javascript():
1.256 matthew 1476:
1477: This and the next function allow you to create small sections of an
1478: otherwise static HTML page that you can update on the fly with
1479: Javascript, even in Netscape 4.
1480:
1481: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1482: must be written to the HTML page once. It will prove the Javascript
1483: function "change(name, content)". Calling the change function with the
1484: name of the section
1485: you want to update, matching the name passed to C<changable_area>, and
1486: the new content you want to put in there, will put the content into
1487: that area.
1488:
1489: B<Note>: Netscape 4 only reserves enough space for the changable area
1490: to contain room for the original contents. You need to "make space"
1491: for whatever changes you wish to make, and be B<sure> to check your
1492: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1493: it's adequate for updating a one-line status display, but little more.
1494: This script will set the space to 100% width, so you only need to
1495: worry about height in Netscape 4.
1496:
1497: Modern browsers are much less limiting, and if you can commit to the
1498: user not using Netscape 4, this feature may be used freely with
1499: pretty much any HTML.
1500:
1501: =cut
1502:
1503: sub change_content_javascript {
1504: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1505: if ($env{'browser.type'} eq 'netscape' &&
1506: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1507: return (<<NETSCAPE4);
1508: function change(name, content) {
1509: doc = document.layers[name+"___escape"].layers[0].document;
1510: doc.open();
1511: doc.write(content);
1512: doc.close();
1513: }
1514: NETSCAPE4
1515: } else {
1516: # Otherwise, we need to use semi-standards-compliant code
1517: # (technically, "innerHTML" isn't standard but the equivalent
1518: # is really scary, and every useful browser supports it
1519: return (<<DOMBASED);
1520: function change(name, content) {
1521: element = document.getElementById(name);
1522: element.innerHTML = content;
1523: }
1524: DOMBASED
1525: }
1526: }
1527:
1528: =pod
1529:
1.648 raeburn 1530: =item * &changable_area($name,$origContent):
1.256 matthew 1531:
1532: This provides a "changable area" that can be modified on the fly via
1533: the Javascript code provided in C<change_content_javascript>. $name is
1534: the name you will use to reference the area later; do not repeat the
1535: same name on a given HTML page more then once. $origContent is what
1536: the area will originally contain, which can be left blank.
1537:
1538: =cut
1539:
1540: sub changable_area {
1541: my ($name, $origContent) = @_;
1542:
1.258 albertel 1543: if ($env{'browser.type'} eq 'netscape' &&
1544: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1545: # If this is netscape 4, we need to use the Layer tag
1546: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1547: } else {
1548: return "<span id='$name'>$origContent</span>";
1549: }
1550: }
1551:
1552: =pod
1553:
1.648 raeburn 1554: =item * &viewport_geometry_js
1.590 raeburn 1555:
1556: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1557:
1558: =cut
1559:
1560:
1561: sub viewport_geometry_js {
1562: return <<"GEOMETRY";
1563: var Geometry = {};
1564: function init_geometry() {
1565: if (Geometry.init) { return };
1566: Geometry.init=1;
1567: if (window.innerHeight) {
1568: Geometry.getViewportHeight = function() { return window.innerHeight; };
1569: Geometry.getViewportWidth = function() { return window.innerWidth; };
1570: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1571: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1572: }
1573: else if (document.documentElement && document.documentElement.clientHeight) {
1574: Geometry.getViewportHeight =
1575: function() { return document.documentElement.clientHeight; };
1576: Geometry.getViewportWidth =
1577: function() { return document.documentElement.clientWidth; };
1578:
1579: Geometry.getHorizontalScroll =
1580: function() { return document.documentElement.scrollLeft; };
1581: Geometry.getVerticalScroll =
1582: function() { return document.documentElement.scrollTop; };
1583: }
1584: else if (document.body.clientHeight) {
1585: Geometry.getViewportHeight =
1586: function() { return document.body.clientHeight; };
1587: Geometry.getViewportWidth =
1588: function() { return document.body.clientWidth; };
1589: Geometry.getHorizontalScroll =
1590: function() { return document.body.scrollLeft; };
1591: Geometry.getVerticalScroll =
1592: function() { return document.body.scrollTop; };
1593: }
1594: }
1595:
1596: GEOMETRY
1597: }
1598:
1599: =pod
1600:
1.648 raeburn 1601: =item * &viewport_size_js()
1.590 raeburn 1602:
1603: 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.
1604:
1605: =cut
1606:
1607: sub viewport_size_js {
1608: my $geometry = &viewport_geometry_js();
1609: return <<"DIMS";
1610:
1611: $geometry
1612:
1613: function getViewportDims(width,height) {
1614: init_geometry();
1615: width.value = Geometry.getViewportWidth();
1616: height.value = Geometry.getViewportHeight();
1617: return;
1618: }
1619:
1620: DIMS
1621: }
1622:
1623: =pod
1624:
1.648 raeburn 1625: =item * &resize_textarea_js()
1.565 albertel 1626:
1627: emits the needed javascript to resize a textarea to be as big as possible
1628:
1629: creates a function resize_textrea that takes two IDs first should be
1630: the id of the element to resize, second should be the id of a div that
1631: surrounds everything that comes after the textarea, this routine needs
1632: to be attached to the <body> for the onload and onresize events.
1633:
1.648 raeburn 1634: =back
1.565 albertel 1635:
1636: =cut
1637:
1638: sub resize_textarea_js {
1.590 raeburn 1639: my $geometry = &viewport_geometry_js();
1.565 albertel 1640: return <<"RESIZE";
1641: <script type="text/javascript">
1.824 bisitz 1642: // <![CDATA[
1.590 raeburn 1643: $geometry
1.565 albertel 1644:
1.588 albertel 1645: function getX(element) {
1646: var x = 0;
1647: while (element) {
1648: x += element.offsetLeft;
1649: element = element.offsetParent;
1650: }
1651: return x;
1652: }
1653: function getY(element) {
1654: var y = 0;
1655: while (element) {
1656: y += element.offsetTop;
1657: element = element.offsetParent;
1658: }
1659: return y;
1660: }
1661:
1662:
1.565 albertel 1663: function resize_textarea(textarea_id,bottom_id) {
1664: init_geometry();
1665: var textarea = document.getElementById(textarea_id);
1666: //alert(textarea);
1667:
1.588 albertel 1668: var textarea_top = getY(textarea);
1.565 albertel 1669: var textarea_height = textarea.offsetHeight;
1670: var bottom = document.getElementById(bottom_id);
1.588 albertel 1671: var bottom_top = getY(bottom);
1.565 albertel 1672: var bottom_height = bottom.offsetHeight;
1673: var window_height = Geometry.getViewportHeight();
1.588 albertel 1674: var fudge = 23;
1.565 albertel 1675: var new_height = window_height-fudge-textarea_top-bottom_height;
1676: if (new_height < 300) {
1677: new_height = 300;
1678: }
1679: textarea.style.height=new_height+'px';
1680: }
1.824 bisitz 1681: // ]]>
1.565 albertel 1682: </script>
1683: RESIZE
1684:
1685: }
1686:
1687: =pod
1688:
1.256 matthew 1689: =head1 Excel and CSV file utility routines
1690:
1691: =over 4
1692:
1693: =cut
1694:
1695: ###############################################################
1696: ###############################################################
1697:
1698: =pod
1699:
1.648 raeburn 1700: =item * &csv_translate($text)
1.37 matthew 1701:
1.185 www 1702: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1703: format.
1704:
1705: =cut
1706:
1.180 matthew 1707: ###############################################################
1708: ###############################################################
1.37 matthew 1709: sub csv_translate {
1710: my $text = shift;
1711: $text =~ s/\"/\"\"/g;
1.209 albertel 1712: $text =~ s/\n/ /g;
1.37 matthew 1713: return $text;
1714: }
1.180 matthew 1715:
1716: ###############################################################
1717: ###############################################################
1718:
1719: =pod
1720:
1.648 raeburn 1721: =item * &define_excel_formats()
1.180 matthew 1722:
1723: Define some commonly used Excel cell formats.
1724:
1725: Currently supported formats:
1726:
1727: =over 4
1728:
1729: =item header
1730:
1731: =item bold
1732:
1733: =item h1
1734:
1735: =item h2
1736:
1737: =item h3
1738:
1.256 matthew 1739: =item h4
1740:
1741: =item i
1742:
1.180 matthew 1743: =item date
1744:
1745: =back
1746:
1747: Inputs: $workbook
1748:
1749: Returns: $format, a hash reference.
1750:
1.1057 foxr 1751:
1.180 matthew 1752: =cut
1753:
1754: ###############################################################
1755: ###############################################################
1756: sub define_excel_formats {
1757: my ($workbook) = @_;
1758: my $format;
1759: $format->{'header'} = $workbook->add_format(bold => 1,
1760: bottom => 1,
1761: align => 'center');
1762: $format->{'bold'} = $workbook->add_format(bold=>1);
1763: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1764: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1765: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1766: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1767: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1768: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1769: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1770: return $format;
1771: }
1772:
1773: ###############################################################
1774: ###############################################################
1.113 bowersj2 1775:
1776: =pod
1777:
1.648 raeburn 1778: =item * &create_workbook()
1.255 matthew 1779:
1780: Create an Excel worksheet. If it fails, output message on the
1781: request object and return undefs.
1782:
1783: Inputs: Apache request object
1784:
1785: Returns (undef) on failure,
1786: Excel worksheet object, scalar with filename, and formats
1787: from &Apache::loncommon::define_excel_formats on success
1788:
1789: =cut
1790:
1791: ###############################################################
1792: ###############################################################
1793: sub create_workbook {
1794: my ($r) = @_;
1795: #
1796: # Create the excel spreadsheet
1797: my $filename = '/prtspool/'.
1.258 albertel 1798: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1799: time.'_'.rand(1000000000).'.xls';
1800: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1801: if (! defined($workbook)) {
1802: $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928 bisitz 1803: $r->print(
1804: '<p class="LC_error">'
1805: .&mt('Problems occurred in creating the new Excel file.')
1806: .' '.&mt('This error has been logged.')
1807: .' '.&mt('Please alert your LON-CAPA administrator.')
1808: .'</p>'
1809: );
1.255 matthew 1810: return (undef);
1811: }
1812: #
1.1014 foxr 1813: $workbook->set_tempdir(LONCAPA::tempdir());
1.255 matthew 1814: #
1815: my $format = &Apache::loncommon::define_excel_formats($workbook);
1816: return ($workbook,$filename,$format);
1817: }
1818:
1819: ###############################################################
1820: ###############################################################
1821:
1822: =pod
1823:
1.648 raeburn 1824: =item * &create_text_file()
1.113 bowersj2 1825:
1.542 raeburn 1826: Create a file to write to and eventually make available to the user.
1.256 matthew 1827: If file creation fails, outputs an error message on the request object and
1828: return undefs.
1.113 bowersj2 1829:
1.256 matthew 1830: Inputs: Apache request object, and file suffix
1.113 bowersj2 1831:
1.256 matthew 1832: Returns (undef) on failure,
1833: Filehandle and filename on success.
1.113 bowersj2 1834:
1835: =cut
1836:
1.256 matthew 1837: ###############################################################
1838: ###############################################################
1839: sub create_text_file {
1840: my ($r,$suffix) = @_;
1841: if (! defined($suffix)) { $suffix = 'txt'; };
1842: my $fh;
1843: my $filename = '/prtspool/'.
1.258 albertel 1844: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1845: time.'_'.rand(1000000000).'.'.$suffix;
1846: $fh = Apache::File->new('>/home/httpd'.$filename);
1847: if (! defined($fh)) {
1848: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 1849: $r->print(
1850: '<p class="LC_error">'
1851: .&mt('Problems occurred in creating the output file.')
1852: .' '.&mt('This error has been logged.')
1853: .' '.&mt('Please alert your LON-CAPA administrator.')
1854: .'</p>'
1855: );
1.113 bowersj2 1856: }
1.256 matthew 1857: return ($fh,$filename)
1.113 bowersj2 1858: }
1859:
1860:
1.256 matthew 1861: =pod
1.113 bowersj2 1862:
1863: =back
1864:
1865: =cut
1.37 matthew 1866:
1867: ###############################################################
1.33 matthew 1868: ## Home server <option> list generating code ##
1869: ###############################################################
1.35 matthew 1870:
1.169 www 1871: # ------------------------------------------
1872:
1873: sub domain_select {
1874: my ($name,$value,$multiple)=@_;
1875: my %domains=map {
1.514 albertel 1876: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1877: } &Apache::lonnet::all_domains();
1.169 www 1878: if ($multiple) {
1879: $domains{''}=&mt('Any domain');
1.550 albertel 1880: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1881: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1882: } else {
1.550 albertel 1883: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970 raeburn 1884: return &select_form($name,$value,\%domains);
1.169 www 1885: }
1886: }
1887:
1.282 albertel 1888: #-------------------------------------------
1889:
1890: =pod
1891:
1.519 raeburn 1892: =head1 Routines for form select boxes
1893:
1894: =over 4
1895:
1.648 raeburn 1896: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1897:
1898: Returns a string containing a <select> element int multiple mode
1899:
1900:
1901: Args:
1902: $name - name of the <select> element
1.506 raeburn 1903: $value - scalar or array ref of values that should already be selected
1.282 albertel 1904: $size - number of rows long the select element is
1.283 albertel 1905: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1906: (shown text should already have been &mt())
1.506 raeburn 1907: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1908:
1.282 albertel 1909: =cut
1910:
1911: #-------------------------------------------
1.169 www 1912: sub multiple_select_form {
1.284 albertel 1913: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1914: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1915: my $output='';
1.191 matthew 1916: if (! defined($size)) {
1917: $size = 4;
1.283 albertel 1918: if (scalar(keys(%$hash))<4) {
1919: $size = scalar(keys(%$hash));
1.191 matthew 1920: }
1921: }
1.734 bisitz 1922: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1923: my @order;
1.506 raeburn 1924: if (ref($order) eq 'ARRAY') {
1925: @order = @{$order};
1926: } else {
1927: @order = sort(keys(%$hash));
1.501 banghart 1928: }
1929: if (exists($$hash{'select_form_order'})) {
1930: @order = @{$$hash{'select_form_order'}};
1931: }
1932:
1.284 albertel 1933: foreach my $key (@order) {
1.356 albertel 1934: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1935: $output.='selected="selected" ' if ($selected{$key});
1936: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1937: }
1938: $output.="</select>\n";
1939: return $output;
1940: }
1941:
1.88 www 1942: #-------------------------------------------
1943:
1944: =pod
1945:
1.970 raeburn 1946: =item * &select_form($defdom,$name,$hashref,$onchange)
1.88 www 1947:
1948: Returns a string containing a <select name='$name' size='1'> form to
1.970 raeburn 1949: allow a user to select options from a ref to a hash containing:
1950: option_name => displayed text. An optional $onchange can include
1951: a javascript onchange item, e.g., onchange="this.form.submit();"
1952:
1.88 www 1953: See lonrights.pm for an example invocation and use.
1954:
1955: =cut
1956:
1957: #-------------------------------------------
1958: sub select_form {
1.970 raeburn 1959: my ($def,$name,$hashref,$onchange) = @_;
1960: return unless (ref($hashref) eq 'HASH');
1961: if ($onchange) {
1962: $onchange = ' onchange="'.$onchange.'"';
1963: }
1964: my $selectform = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.128 albertel 1965: my @keys;
1.970 raeburn 1966: if (exists($hashref->{'select_form_order'})) {
1967: @keys=@{$hashref->{'select_form_order'}};
1.128 albertel 1968: } else {
1.970 raeburn 1969: @keys=sort(keys(%{$hashref}));
1.128 albertel 1970: }
1.356 albertel 1971: foreach my $key (@keys) {
1972: $selectform.=
1973: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1974: ($key eq $def ? 'selected="selected" ' : '').
1.970 raeburn 1975: ">".$hashref->{$key}."</option>\n";
1.88 www 1976: }
1977: $selectform.="</select>";
1978: return $selectform;
1979: }
1980:
1.475 www 1981: # For display filters
1982:
1983: sub display_filter {
1.1074 raeburn 1984: my ($context) = @_;
1.475 www 1985: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1986: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.1074 raeburn 1987: my $phraseinput = 'hidden';
1988: my $includeinput = 'hidden';
1989: my ($checked,$includetypestext);
1990: if ($env{'form.displayfilter'} eq 'containing') {
1991: $phraseinput = 'text';
1992: if ($context eq 'parmslog') {
1993: $includeinput = 'checkbox';
1994: if ($env{'form.includetypes'}) {
1995: $checked = ' checked="checked"';
1996: }
1997: $includetypestext = &mt('Include parameter types');
1998: }
1999: } else {
2000: $includetypestext = ' ';
2001: }
2002: my ($additional,$secondid,$thirdid);
2003: if ($context eq 'parmslog') {
2004: $additional =
2005: '<label><input type="'.$includeinput.'" name="includetypes"'.
2006: $checked.' name="includetypes" value="1" id="includetypes" />'.
2007: ' <span id="includetypestext">'.$includetypestext.'</span>'.
2008: '</label>';
2009: $secondid = 'includetypes';
2010: $thirdid = 'includetypestext';
2011: }
2012: my $onchange = "javascript:toggleHistoryOptions(this,'containingphrase','$context',
2013: '$secondid','$thirdid')";
2014: return '<span class="LC_nobreak"><label>'.&mt('Records: [_1]',
1.475 www 2015: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
2016: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 2017: '</label></span> <span class="LC_nobreak">'.
1.1074 raeburn 2018: &mt('Filter: [_1]',
1.477 www 2019: &select_form($env{'form.displayfilter'},
2020: 'displayfilter',
1.970 raeburn 2021: {'currentfolder' => 'Current folder/page',
1.477 www 2022: 'containing' => 'Containing phrase',
1.1074 raeburn 2023: 'none' => 'None'},$onchange)).' '.
2024: '<input type="'.$phraseinput.'" name="containingphrase" id="containingphrase" size="30" value="'.
2025: &HTML::Entities::encode($env{'form.containingphrase'}).
2026: '" />'.$additional;
2027: }
2028:
2029: sub display_filter_js {
2030: my $includetext = &mt('Include parameter types');
2031: return <<"ENDJS";
2032:
2033: function toggleHistoryOptions(setter,firstid,context,secondid,thirdid) {
2034: var firstType = 'hidden';
2035: if (setter.options[setter.selectedIndex].value == 'containing') {
2036: firstType = 'text';
2037: }
2038: firstObject = document.getElementById(firstid);
2039: if (typeof(firstObject) == 'object') {
2040: if (firstObject.type != firstType) {
2041: changeInputType(firstObject,firstType);
2042: }
2043: }
2044: if (context == 'parmslog') {
2045: var secondType = 'hidden';
2046: if (firstType == 'text') {
2047: secondType = 'checkbox';
2048: }
2049: secondObject = document.getElementById(secondid);
2050: if (typeof(secondObject) == 'object') {
2051: if (secondObject.type != secondType) {
2052: changeInputType(secondObject,secondType);
2053: }
2054: }
2055: var textItem = document.getElementById(thirdid);
2056: var currtext = textItem.innerHTML;
2057: var newtext;
2058: if (firstType == 'text') {
2059: newtext = '$includetext';
2060: } else {
2061: newtext = ' ';
2062: }
2063: if (currtext != newtext) {
2064: textItem.innerHTML = newtext;
2065: }
2066: }
2067: return;
2068: }
2069:
2070: function changeInputType(oldObject,newType) {
2071: var newObject = document.createElement('input');
2072: newObject.type = newType;
2073: if (oldObject.size) {
2074: newObject.size = oldObject.size;
2075: }
2076: if (oldObject.value) {
2077: newObject.value = oldObject.value;
2078: }
2079: if (oldObject.name) {
2080: newObject.name = oldObject.name;
2081: }
2082: if (oldObject.id) {
2083: newObject.id = oldObject.id;
2084: }
2085: oldObject.parentNode.replaceChild(newObject,oldObject);
2086: return;
2087: }
2088:
2089: ENDJS
1.475 www 2090: }
2091:
1.167 www 2092: sub gradeleveldescription {
2093: my $gradelevel=shift;
2094: my %gradelevels=(0 => 'Not specified',
2095: 1 => 'Grade 1',
2096: 2 => 'Grade 2',
2097: 3 => 'Grade 3',
2098: 4 => 'Grade 4',
2099: 5 => 'Grade 5',
2100: 6 => 'Grade 6',
2101: 7 => 'Grade 7',
2102: 8 => 'Grade 8',
2103: 9 => 'Grade 9',
2104: 10 => 'Grade 10',
2105: 11 => 'Grade 11',
2106: 12 => 'Grade 12',
2107: 13 => 'Grade 13',
2108: 14 => '100 Level',
2109: 15 => '200 Level',
2110: 16 => '300 Level',
2111: 17 => '400 Level',
2112: 18 => 'Graduate Level');
2113: return &mt($gradelevels{$gradelevel});
2114: }
2115:
1.163 www 2116: sub select_level_form {
2117: my ($deflevel,$name)=@_;
2118: unless ($deflevel) { $deflevel=0; }
1.167 www 2119: my $selectform = "<select name=\"$name\" size=\"1\">\n";
2120: for (my $i=0; $i<=18; $i++) {
2121: $selectform.="<option value=\"$i\" ".
1.253 albertel 2122: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 2123: ">".&gradeleveldescription($i)."</option>\n";
2124: }
2125: $selectform.="</select>";
2126: return $selectform;
1.163 www 2127: }
1.167 www 2128:
1.35 matthew 2129: #-------------------------------------------
2130:
1.45 matthew 2131: =pod
2132:
1.910 raeburn 2133: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35 matthew 2134:
2135: Returns a string containing a <select name='$name' size='1'> form to
2136: allow a user to select the domain to preform an operation in.
2137: See loncreateuser.pm for an example invocation and use.
2138:
1.90 www 2139: If the $includeempty flag is set, it also includes an empty choice ("no domain
2140: selected");
2141:
1.743 raeburn 2142: If the $showdomdesc flag is set, the domain name is followed by the domain description.
2143:
1.910 raeburn 2144: 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.
2145:
2146: The optional $incdoms is a reference to an array of domains which will be the only available options.
1.563 raeburn 2147:
1.35 matthew 2148: =cut
2149:
2150: #-------------------------------------------
1.34 matthew 2151: sub select_dom_form {
1.910 raeburn 2152: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.872 raeburn 2153: if ($onchange) {
1.874 raeburn 2154: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 2155: }
1.910 raeburn 2156: my @domains;
2157: if (ref($incdoms) eq 'ARRAY') {
2158: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
2159: } else {
2160: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
2161: }
1.90 www 2162: if ($includeempty) { @domains=('',@domains); }
1.743 raeburn 2163: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 2164: foreach my $dom (@domains) {
2165: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 2166: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
2167: if ($showdomdesc) {
2168: if ($dom ne '') {
2169: my $domdesc = &Apache::lonnet::domain($dom,'description');
2170: if ($domdesc ne '') {
2171: $selectdomain .= ' ('.$domdesc.')';
2172: }
2173: }
2174: }
2175: $selectdomain .= "</option>\n";
1.34 matthew 2176: }
2177: $selectdomain.="</select>";
2178: return $selectdomain;
2179: }
2180:
1.35 matthew 2181: #-------------------------------------------
2182:
1.45 matthew 2183: =pod
2184:
1.648 raeburn 2185: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 2186:
1.586 raeburn 2187: input: 4 arguments (two required, two optional) -
2188: $domain - domain of new user
2189: $name - name of form element
2190: $default - Value of 'default' causes a default item to be first
2191: option, and selected by default.
2192: $hide - Value of 'hide' causes hiding of the name of the server,
2193: if 1 server found, or default, if 0 found.
1.594 raeburn 2194: output: returns 2 items:
1.586 raeburn 2195: (a) form element which contains either:
2196: (i) <select name="$name">
2197: <option value="$hostid1">$hostid $servers{$hostid}</option>
2198: <option value="$hostid2">$hostid $servers{$hostid}</option>
2199: </select>
2200: form item if there are multiple library servers in $domain, or
2201: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2202: if there is only one library server in $domain.
2203:
2204: (b) number of library servers found.
2205:
2206: See loncreateuser.pm for example of use.
1.35 matthew 2207:
2208: =cut
2209:
2210: #-------------------------------------------
1.586 raeburn 2211: sub home_server_form_item {
2212: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2213: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2214: my $result;
2215: my $numlib = keys(%servers);
2216: if ($numlib > 1) {
2217: $result .= '<select name="'.$name.'" />'."\n";
2218: if ($default) {
1.804 bisitz 2219: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 2220: '</option>'."\n";
2221: }
2222: foreach my $hostid (sort(keys(%servers))) {
2223: $result.= '<option value="'.$hostid.'">'.
2224: $hostid.' '.$servers{$hostid}."</option>\n";
2225: }
2226: $result .= '</select>'."\n";
2227: } elsif ($numlib == 1) {
2228: my $hostid;
2229: foreach my $item (keys(%servers)) {
2230: $hostid = $item;
2231: }
2232: $result .= '<input type="hidden" name="'.$name.'" value="'.
2233: $hostid.'" />';
2234: if (!$hide) {
2235: $result .= $hostid.' '.$servers{$hostid};
2236: }
2237: $result .= "\n";
2238: } elsif ($default) {
2239: $result .= '<input type="hidden" name="'.$name.
2240: '" value="default" />';
2241: if (!$hide) {
2242: $result .= &mt('default');
2243: }
2244: $result .= "\n";
1.33 matthew 2245: }
1.586 raeburn 2246: return ($result,$numlib);
1.33 matthew 2247: }
1.112 bowersj2 2248:
2249: =pod
2250:
1.534 albertel 2251: =back
2252:
1.112 bowersj2 2253: =cut
1.87 matthew 2254:
2255: ###############################################################
1.112 bowersj2 2256: ## Decoding User Agent ##
1.87 matthew 2257: ###############################################################
2258:
2259: =pod
2260:
1.112 bowersj2 2261: =head1 Decoding the User Agent
2262:
2263: =over 4
2264:
2265: =item * &decode_user_agent()
1.87 matthew 2266:
2267: Inputs: $r
2268:
2269: Outputs:
2270:
2271: =over 4
2272:
1.112 bowersj2 2273: =item * $httpbrowser
1.87 matthew 2274:
1.112 bowersj2 2275: =item * $clientbrowser
1.87 matthew 2276:
1.112 bowersj2 2277: =item * $clientversion
1.87 matthew 2278:
1.112 bowersj2 2279: =item * $clientmathml
1.87 matthew 2280:
1.112 bowersj2 2281: =item * $clientunicode
1.87 matthew 2282:
1.112 bowersj2 2283: =item * $clientos
1.87 matthew 2284:
2285: =back
2286:
1.157 matthew 2287: =back
2288:
1.87 matthew 2289: =cut
2290:
2291: ###############################################################
2292: ###############################################################
2293: sub decode_user_agent {
1.247 albertel 2294: my ($r)=@_;
1.87 matthew 2295: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2296: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2297: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2298: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2299: my $clientbrowser='unknown';
2300: my $clientversion='0';
2301: my $clientmathml='';
2302: my $clientunicode='0';
2303: for (my $i=0;$i<=$#browsertype;$i++) {
2304: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
2305: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2306: $clientbrowser=$bname;
2307: $httpbrowser=~/$vreg/i;
2308: $clientversion=$1;
2309: $clientmathml=($clientversion>=$minv);
2310: $clientunicode=($clientversion>=$univ);
2311: }
2312: }
2313: my $clientos='unknown';
2314: if (($httpbrowser=~/linux/i) ||
2315: ($httpbrowser=~/unix/i) ||
2316: ($httpbrowser=~/ux/i) ||
2317: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2318: if (($httpbrowser=~/vax/i) ||
2319: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2320: if ($httpbrowser=~/next/i) { $clientos='next'; }
2321: if (($httpbrowser=~/mac/i) ||
2322: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
2323: if ($httpbrowser=~/win/i) { $clientos='win'; }
2324: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
2325: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
2326: $clientunicode,$clientos,);
2327: }
2328:
1.32 matthew 2329: ###############################################################
2330: ## Authentication changing form generation subroutines ##
2331: ###############################################################
2332: ##
2333: ## All of the authform_xxxxxxx subroutines take their inputs in a
2334: ## hash, and have reasonable default values.
2335: ##
2336: ## formname = the name given in the <form> tag.
1.35 matthew 2337: #-------------------------------------------
2338:
1.45 matthew 2339: =pod
2340:
1.112 bowersj2 2341: =head1 Authentication Routines
2342:
2343: =over 4
2344:
1.648 raeburn 2345: =item * &authform_xxxxxx()
1.35 matthew 2346:
2347: The authform_xxxxxx subroutines provide javascript and html forms which
2348: handle some of the conveniences required for authentication forms.
2349: This is not an optimal method, but it works.
2350:
2351: =over 4
2352:
1.112 bowersj2 2353: =item * authform_header
1.35 matthew 2354:
1.112 bowersj2 2355: =item * authform_authorwarning
1.35 matthew 2356:
1.112 bowersj2 2357: =item * authform_nochange
1.35 matthew 2358:
1.112 bowersj2 2359: =item * authform_kerberos
1.35 matthew 2360:
1.112 bowersj2 2361: =item * authform_internal
1.35 matthew 2362:
1.112 bowersj2 2363: =item * authform_filesystem
1.35 matthew 2364:
2365: =back
2366:
1.648 raeburn 2367: See loncreateuser.pm for invocation and use examples.
1.157 matthew 2368:
1.35 matthew 2369: =cut
2370:
2371: #-------------------------------------------
1.32 matthew 2372: sub authform_header{
2373: my %in = (
2374: formname => 'cu',
1.80 albertel 2375: kerb_def_dom => '',
1.32 matthew 2376: @_,
2377: );
2378: $in{'formname'} = 'document.' . $in{'formname'};
2379: my $result='';
1.80 albertel 2380:
2381: #---------------------------------------------- Code for upper case translation
2382: my $Javascript_toUpperCase;
2383: unless ($in{kerb_def_dom}) {
2384: $Javascript_toUpperCase =<<"END";
2385: switch (choice) {
2386: case 'krb': currentform.elements[choicearg].value =
2387: currentform.elements[choicearg].value.toUpperCase();
2388: break;
2389: default:
2390: }
2391: END
2392: } else {
2393: $Javascript_toUpperCase = "";
2394: }
2395:
1.165 raeburn 2396: my $radioval = "'nochange'";
1.591 raeburn 2397: if (defined($in{'curr_authtype'})) {
2398: if ($in{'curr_authtype'} ne '') {
2399: $radioval = "'".$in{'curr_authtype'}."arg'";
2400: }
1.174 matthew 2401: }
1.165 raeburn 2402: my $argfield = 'null';
1.591 raeburn 2403: if (defined($in{'mode'})) {
1.165 raeburn 2404: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2405: if (defined($in{'curr_autharg'})) {
2406: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2407: $argfield = "'$in{'curr_autharg'}'";
2408: }
2409: }
2410: }
2411: }
2412:
1.32 matthew 2413: $result.=<<"END";
2414: var current = new Object();
1.165 raeburn 2415: current.radiovalue = $radioval;
2416: current.argfield = $argfield;
1.32 matthew 2417:
2418: function changed_radio(choice,currentform) {
2419: var choicearg = choice + 'arg';
2420: // If a radio button in changed, we need to change the argfield
2421: if (current.radiovalue != choice) {
2422: current.radiovalue = choice;
2423: if (current.argfield != null) {
2424: currentform.elements[current.argfield].value = '';
2425: }
2426: if (choice == 'nochange') {
2427: current.argfield = null;
2428: } else {
2429: current.argfield = choicearg;
2430: switch(choice) {
2431: case 'krb':
2432: currentform.elements[current.argfield].value =
2433: "$in{'kerb_def_dom'}";
2434: break;
2435: default:
2436: break;
2437: }
2438: }
2439: }
2440: return;
2441: }
1.22 www 2442:
1.32 matthew 2443: function changed_text(choice,currentform) {
2444: var choicearg = choice + 'arg';
2445: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2446: $Javascript_toUpperCase
1.32 matthew 2447: // clear old field
2448: if ((current.argfield != choicearg) && (current.argfield != null)) {
2449: currentform.elements[current.argfield].value = '';
2450: }
2451: current.argfield = choicearg;
2452: }
2453: set_auth_radio_buttons(choice,currentform);
2454: return;
1.20 www 2455: }
1.32 matthew 2456:
2457: function set_auth_radio_buttons(newvalue,currentform) {
1.986 raeburn 2458: var numauthchoices = currentform.login.length;
2459: if (typeof numauthchoices == "undefined") {
2460: return;
2461: }
1.32 matthew 2462: var i=0;
1.986 raeburn 2463: while (i < numauthchoices) {
1.32 matthew 2464: if (currentform.login[i].value == newvalue) { break; }
2465: i++;
2466: }
1.986 raeburn 2467: if (i == numauthchoices) {
1.32 matthew 2468: return;
2469: }
2470: current.radiovalue = newvalue;
2471: currentform.login[i].checked = true;
2472: return;
2473: }
2474: END
2475: return $result;
2476: }
2477:
2478: sub authform_authorwarning{
2479: my $result='';
1.144 matthew 2480: $result='<i>'.
2481: &mt('As a general rule, only authors or co-authors should be '.
2482: 'filesystem authenticated '.
2483: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2484: return $result;
2485: }
2486:
2487: sub authform_nochange{
2488: my %in = (
2489: formname => 'document.cu',
2490: kerb_def_dom => 'MSU.EDU',
2491: @_,
2492: );
1.586 raeburn 2493: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2494: my $result;
2495: if (keys(%can_assign) == 0) {
2496: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2497: } else {
2498: $result = '<label>'.&mt('[_1] Do not change login data',
2499: '<input type="radio" name="login" value="nochange" '.
2500: 'checked="checked" onclick="'.
1.281 albertel 2501: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2502: '</label>';
1.586 raeburn 2503: }
1.32 matthew 2504: return $result;
2505: }
2506:
1.591 raeburn 2507: sub authform_kerberos {
1.32 matthew 2508: my %in = (
2509: formname => 'document.cu',
2510: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2511: kerb_def_auth => 'krb4',
1.32 matthew 2512: @_,
2513: );
1.586 raeburn 2514: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2515: $autharg,$jscall);
2516: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2517: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2518: $check5 = ' checked="checked"';
1.80 albertel 2519: } else {
1.772 bisitz 2520: $check4 = ' checked="checked"';
1.80 albertel 2521: }
1.165 raeburn 2522: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2523: if (defined($in{'curr_authtype'})) {
2524: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2525: $krbcheck = ' checked="checked"';
1.623 raeburn 2526: if (defined($in{'mode'})) {
2527: if ($in{'mode'} eq 'modifyuser') {
2528: $krbcheck = '';
2529: }
2530: }
1.591 raeburn 2531: if (defined($in{'curr_kerb_ver'})) {
2532: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2533: $check5 = ' checked="checked"';
1.591 raeburn 2534: $check4 = '';
2535: } else {
1.772 bisitz 2536: $check4 = ' checked="checked"';
1.591 raeburn 2537: $check5 = '';
2538: }
1.586 raeburn 2539: }
1.591 raeburn 2540: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2541: $krbarg = $in{'curr_autharg'};
2542: }
1.586 raeburn 2543: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2544: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2545: $result =
2546: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2547: $in{'curr_autharg'},$krbver);
2548: } else {
2549: $result =
2550: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2551: }
2552: return $result;
2553: }
2554: }
2555: } else {
2556: if ($authnum == 1) {
1.784 bisitz 2557: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2558: }
2559: }
1.586 raeburn 2560: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2561: return;
1.587 raeburn 2562: } elsif ($authtype eq '') {
1.591 raeburn 2563: if (defined($in{'mode'})) {
1.587 raeburn 2564: if ($in{'mode'} eq 'modifycourse') {
2565: if ($authnum == 1) {
1.784 bisitz 2566: $authtype = '<input type="hidden" name="login" value="krb" />';
1.587 raeburn 2567: }
2568: }
2569: }
1.586 raeburn 2570: }
2571: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2572: if ($authtype eq '') {
2573: $authtype = '<input type="radio" name="login" value="krb" '.
2574: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2575: $krbcheck.' />';
2576: }
2577: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2578: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2579: $in{'curr_authtype'} eq 'krb5') ||
2580: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2581: $in{'curr_authtype'} eq 'krb4')) {
2582: $result .= &mt
1.144 matthew 2583: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2584: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2585: '<label>'.$authtype,
1.281 albertel 2586: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2587: 'value="'.$krbarg.'" '.
1.144 matthew 2588: 'onchange="'.$jscall.'" />',
1.281 albertel 2589: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2590: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2591: '</label>');
1.586 raeburn 2592: } elsif ($can_assign{'krb4'}) {
2593: $result .= &mt
2594: ('[_1] Kerberos authenticated with domain [_2] '.
2595: '[_3] Version 4 [_4]',
2596: '<label>'.$authtype,
2597: '</label><input type="text" size="10" name="krbarg" '.
2598: 'value="'.$krbarg.'" '.
2599: 'onchange="'.$jscall.'" />',
2600: '<label><input type="hidden" name="krbver" value="4" />',
2601: '</label>');
2602: } elsif ($can_assign{'krb5'}) {
2603: $result .= &mt
2604: ('[_1] Kerberos authenticated with domain [_2] '.
2605: '[_3] Version 5 [_4]',
2606: '<label>'.$authtype,
2607: '</label><input type="text" size="10" name="krbarg" '.
2608: 'value="'.$krbarg.'" '.
2609: 'onchange="'.$jscall.'" />',
2610: '<label><input type="hidden" name="krbver" value="5" />',
2611: '</label>');
2612: }
1.32 matthew 2613: return $result;
2614: }
2615:
2616: sub authform_internal{
1.586 raeburn 2617: my %in = (
1.32 matthew 2618: formname => 'document.cu',
2619: kerb_def_dom => 'MSU.EDU',
2620: @_,
2621: );
1.586 raeburn 2622: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2623: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2624: if (defined($in{'curr_authtype'})) {
2625: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2626: if ($can_assign{'int'}) {
1.772 bisitz 2627: $intcheck = 'checked="checked" ';
1.623 raeburn 2628: if (defined($in{'mode'})) {
2629: if ($in{'mode'} eq 'modifyuser') {
2630: $intcheck = '';
2631: }
2632: }
1.591 raeburn 2633: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2634: $intarg = $in{'curr_autharg'};
2635: }
2636: } else {
2637: $result = &mt('Currently internally authenticated.');
2638: return $result;
1.165 raeburn 2639: }
2640: }
1.586 raeburn 2641: } else {
2642: if ($authnum == 1) {
1.784 bisitz 2643: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 2644: }
2645: }
2646: if (!$can_assign{'int'}) {
2647: return;
1.587 raeburn 2648: } elsif ($authtype eq '') {
1.591 raeburn 2649: if (defined($in{'mode'})) {
1.587 raeburn 2650: if ($in{'mode'} eq 'modifycourse') {
2651: if ($authnum == 1) {
1.784 bisitz 2652: $authtype = '<input type="hidden" name="login" value="int" />';
1.587 raeburn 2653: }
2654: }
2655: }
1.165 raeburn 2656: }
1.586 raeburn 2657: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2658: if ($authtype eq '') {
2659: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2660: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2661: }
1.605 bisitz 2662: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2663: $intarg.'" onchange="'.$jscall.'" />';
2664: $result = &mt
1.144 matthew 2665: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2666: '<label>'.$authtype,'</label>'.$autharg);
1.824 bisitz 2667: $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 2668: return $result;
2669: }
2670:
2671: sub authform_local{
2672: my %in = (
2673: formname => 'document.cu',
2674: kerb_def_dom => 'MSU.EDU',
2675: @_,
2676: );
1.586 raeburn 2677: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2678: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2679: if (defined($in{'curr_authtype'})) {
2680: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2681: if ($can_assign{'loc'}) {
1.772 bisitz 2682: $loccheck = 'checked="checked" ';
1.623 raeburn 2683: if (defined($in{'mode'})) {
2684: if ($in{'mode'} eq 'modifyuser') {
2685: $loccheck = '';
2686: }
2687: }
1.591 raeburn 2688: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2689: $locarg = $in{'curr_autharg'};
2690: }
2691: } else {
2692: $result = &mt('Currently using local (institutional) authentication.');
2693: return $result;
1.165 raeburn 2694: }
2695: }
1.586 raeburn 2696: } else {
2697: if ($authnum == 1) {
1.784 bisitz 2698: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 2699: }
2700: }
2701: if (!$can_assign{'loc'}) {
2702: return;
1.587 raeburn 2703: } elsif ($authtype eq '') {
1.591 raeburn 2704: if (defined($in{'mode'})) {
1.587 raeburn 2705: if ($in{'mode'} eq 'modifycourse') {
2706: if ($authnum == 1) {
1.784 bisitz 2707: $authtype = '<input type="hidden" name="login" value="loc" />';
1.587 raeburn 2708: }
2709: }
2710: }
1.165 raeburn 2711: }
1.586 raeburn 2712: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2713: if ($authtype eq '') {
2714: $authtype = '<input type="radio" name="login" value="loc" '.
2715: $loccheck.' onchange="'.$jscall.'" onclick="'.
2716: $jscall.'" />';
2717: }
2718: $autharg = '<input type="text" size="10" name="locarg" value="'.
2719: $locarg.'" onchange="'.$jscall.'" />';
2720: $result = &mt('[_1] Local Authentication with argument [_2]',
2721: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2722: return $result;
2723: }
2724:
2725: sub authform_filesystem{
2726: my %in = (
2727: formname => 'document.cu',
2728: kerb_def_dom => 'MSU.EDU',
2729: @_,
2730: );
1.586 raeburn 2731: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2732: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2733: if (defined($in{'curr_authtype'})) {
2734: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2735: if ($can_assign{'fsys'}) {
1.772 bisitz 2736: $fsyscheck = 'checked="checked" ';
1.623 raeburn 2737: if (defined($in{'mode'})) {
2738: if ($in{'mode'} eq 'modifyuser') {
2739: $fsyscheck = '';
2740: }
2741: }
1.586 raeburn 2742: } else {
2743: $result = &mt('Currently Filesystem Authenticated.');
2744: return $result;
2745: }
2746: }
2747: } else {
2748: if ($authnum == 1) {
1.784 bisitz 2749: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 2750: }
2751: }
2752: if (!$can_assign{'fsys'}) {
2753: return;
1.587 raeburn 2754: } elsif ($authtype eq '') {
1.591 raeburn 2755: if (defined($in{'mode'})) {
1.587 raeburn 2756: if ($in{'mode'} eq 'modifycourse') {
2757: if ($authnum == 1) {
1.784 bisitz 2758: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587 raeburn 2759: }
2760: }
2761: }
1.586 raeburn 2762: }
2763: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2764: if ($authtype eq '') {
2765: $authtype = '<input type="radio" name="login" value="fsys" '.
2766: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2767: $jscall.'" />';
2768: }
2769: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2770: ' onchange="'.$jscall.'" />';
2771: $result = &mt
1.144 matthew 2772: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2773: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2774: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2775: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2776: 'onchange="'.$jscall.'" />');
1.32 matthew 2777: return $result;
2778: }
2779:
1.586 raeburn 2780: sub get_assignable_auth {
2781: my ($dom) = @_;
2782: if ($dom eq '') {
2783: $dom = $env{'request.role.domain'};
2784: }
2785: my %can_assign = (
2786: krb4 => 1,
2787: krb5 => 1,
2788: int => 1,
2789: loc => 1,
2790: );
2791: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2792: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2793: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2794: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2795: my $context;
2796: if ($env{'request.role'} =~ /^au/) {
2797: $context = 'author';
2798: } elsif ($env{'request.role'} =~ /^dc/) {
2799: $context = 'domain';
2800: } elsif ($env{'request.course.id'}) {
2801: $context = 'course';
2802: }
2803: if ($context) {
2804: if (ref($authhash->{$context}) eq 'HASH') {
2805: %can_assign = %{$authhash->{$context}};
2806: }
2807: }
2808: }
2809: }
2810: my $authnum = 0;
2811: foreach my $key (keys(%can_assign)) {
2812: if ($can_assign{$key}) {
2813: $authnum ++;
2814: }
2815: }
2816: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2817: $authnum --;
2818: }
2819: return ($authnum,%can_assign);
2820: }
2821:
1.80 albertel 2822: ###############################################################
2823: ## Get Kerberos Defaults for Domain ##
2824: ###############################################################
2825: ##
2826: ## Returns default kerberos version and an associated argument
2827: ## as listed in file domain.tab. If not listed, provides
2828: ## appropriate default domain and kerberos version.
2829: ##
2830: #-------------------------------------------
2831:
2832: =pod
2833:
1.648 raeburn 2834: =item * &get_kerberos_defaults()
1.80 albertel 2835:
2836: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2837: version and domain. If not found, it defaults to version 4 and the
2838: domain of the server.
1.80 albertel 2839:
1.648 raeburn 2840: =over 4
2841:
1.80 albertel 2842: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2843:
1.648 raeburn 2844: =back
2845:
2846: =back
2847:
1.80 albertel 2848: =cut
2849:
2850: #-------------------------------------------
2851: sub get_kerberos_defaults {
2852: my $domain=shift;
1.641 raeburn 2853: my ($krbdef,$krbdefdom);
2854: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2855: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2856: $krbdef = $domdefaults{'auth_def'};
2857: $krbdefdom = $domdefaults{'auth_arg_def'};
2858: } else {
1.80 albertel 2859: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2860: my $krbdefdom=$1;
2861: $krbdefdom=~tr/a-z/A-Z/;
2862: $krbdef = "krb4";
2863: }
2864: return ($krbdef,$krbdefdom);
2865: }
1.112 bowersj2 2866:
1.32 matthew 2867:
1.46 matthew 2868: ###############################################################
2869: ## Thesaurus Functions ##
2870: ###############################################################
1.20 www 2871:
1.46 matthew 2872: =pod
1.20 www 2873:
1.112 bowersj2 2874: =head1 Thesaurus Functions
2875:
2876: =over 4
2877:
1.648 raeburn 2878: =item * &initialize_keywords()
1.46 matthew 2879:
2880: Initializes the package variable %Keywords if it is empty. Uses the
2881: package variable $thesaurus_db_file.
2882:
2883: =cut
2884:
2885: ###################################################
2886:
2887: sub initialize_keywords {
2888: return 1 if (scalar keys(%Keywords));
2889: # If we are here, %Keywords is empty, so fill it up
2890: # Make sure the file we need exists...
2891: if (! -e $thesaurus_db_file) {
2892: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2893: " failed because it does not exist");
2894: return 0;
2895: }
2896: # Set up the hash as a database
2897: my %thesaurus_db;
2898: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2899: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2900: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2901: $thesaurus_db_file);
2902: return 0;
2903: }
2904: # Get the average number of appearances of a word.
2905: my $avecount = $thesaurus_db{'average.count'};
2906: # Put keywords (those that appear > average) into %Keywords
2907: while (my ($word,$data)=each (%thesaurus_db)) {
2908: my ($count,undef) = split /:/,$data;
2909: $Keywords{$word}++ if ($count > $avecount);
2910: }
2911: untie %thesaurus_db;
2912: # Remove special values from %Keywords.
1.356 albertel 2913: foreach my $value ('total.count','average.count') {
2914: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2915: }
1.46 matthew 2916: return 1;
2917: }
2918:
2919: ###################################################
2920:
2921: =pod
2922:
1.648 raeburn 2923: =item * &keyword($word)
1.46 matthew 2924:
2925: Returns true if $word is a keyword. A keyword is a word that appears more
2926: than the average number of times in the thesaurus database. Calls
2927: &initialize_keywords
2928:
2929: =cut
2930:
2931: ###################################################
1.20 www 2932:
2933: sub keyword {
1.46 matthew 2934: return if (!&initialize_keywords());
2935: my $word=lc(shift());
2936: $word=~s/\W//g;
2937: return exists($Keywords{$word});
1.20 www 2938: }
1.46 matthew 2939:
2940: ###############################################################
2941:
2942: =pod
1.20 www 2943:
1.648 raeburn 2944: =item * &get_related_words()
1.46 matthew 2945:
1.160 matthew 2946: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2947: an array of words. If the keyword is not in the thesaurus, an empty array
2948: will be returned. The order of the words returned is determined by the
2949: database which holds them.
2950:
2951: Uses global $thesaurus_db_file.
2952:
1.1057 foxr 2953:
1.46 matthew 2954: =cut
2955:
2956: ###############################################################
2957: sub get_related_words {
2958: my $keyword = shift;
2959: my %thesaurus_db;
2960: if (! -e $thesaurus_db_file) {
2961: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2962: "failed because the file does not exist");
2963: return ();
2964: }
2965: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2966: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2967: return ();
2968: }
2969: my @Words=();
1.429 www 2970: my $count=0;
1.46 matthew 2971: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2972: # The first element is the number of times
2973: # the word appears. We do not need it now.
1.429 www 2974: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2975: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2976: my $threshold=$mostfrequentcount/10;
2977: foreach my $possibleword (@RelatedWords) {
2978: my ($word,$wordcount)=split(/\,/,$possibleword);
2979: if ($wordcount>$threshold) {
2980: push(@Words,$word);
2981: $count++;
2982: if ($count>10) { last; }
2983: }
1.20 www 2984: }
2985: }
1.46 matthew 2986: untie %thesaurus_db;
2987: return @Words;
1.14 harris41 2988: }
1.46 matthew 2989:
1.112 bowersj2 2990: =pod
2991:
2992: =back
2993:
2994: =cut
1.61 www 2995:
2996: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2997: =pod
2998:
1.112 bowersj2 2999: =head1 User Name Functions
3000:
3001: =over 4
3002:
1.648 raeburn 3003: =item * &plainname($uname,$udom,$first)
1.81 albertel 3004:
1.112 bowersj2 3005: Takes a users logon name and returns it as a string in
1.226 albertel 3006: "first middle last generation" form
3007: if $first is set to 'lastname' then it returns it as
3008: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 3009:
3010: =cut
1.61 www 3011:
1.295 www 3012:
1.81 albertel 3013: ###############################################################
1.61 www 3014: sub plainname {
1.226 albertel 3015: my ($uname,$udom,$first)=@_;
1.537 albertel 3016: return if (!defined($uname) || !defined($udom));
1.295 www 3017: my %names=&getnames($uname,$udom);
1.226 albertel 3018: my $name=&Apache::lonnet::format_name($names{'firstname'},
3019: $names{'middlename'},
3020: $names{'lastname'},
3021: $names{'generation'},$first);
3022: $name=~s/^\s+//;
1.62 www 3023: $name=~s/\s+$//;
3024: $name=~s/\s+/ /g;
1.353 albertel 3025: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 3026: return $name;
1.61 www 3027: }
1.66 www 3028:
3029: # -------------------------------------------------------------------- Nickname
1.81 albertel 3030: =pod
3031:
1.648 raeburn 3032: =item * &nickname($uname,$udom)
1.81 albertel 3033:
3034: Gets a users name and returns it as a string as
3035:
3036: ""nickname""
1.66 www 3037:
1.81 albertel 3038: if the user has a nickname or
3039:
3040: "first middle last generation"
3041:
3042: if the user does not
3043:
3044: =cut
1.66 www 3045:
3046: sub nickname {
3047: my ($uname,$udom)=@_;
1.537 albertel 3048: return if (!defined($uname) || !defined($udom));
1.295 www 3049: my %names=&getnames($uname,$udom);
1.68 albertel 3050: my $name=$names{'nickname'};
1.66 www 3051: if ($name) {
3052: $name='"'.$name.'"';
3053: } else {
3054: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
3055: $names{'lastname'}.' '.$names{'generation'};
3056: $name=~s/\s+$//;
3057: $name=~s/\s+/ /g;
3058: }
3059: return $name;
3060: }
3061:
1.295 www 3062: sub getnames {
3063: my ($uname,$udom)=@_;
1.537 albertel 3064: return if (!defined($uname) || !defined($udom));
1.433 albertel 3065: if ($udom eq 'public' && $uname eq 'public') {
3066: return ('lastname' => &mt('Public'));
3067: }
1.295 www 3068: my $id=$uname.':'.$udom;
3069: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
3070: if ($cached) {
3071: return %{$names};
3072: } else {
3073: my %loadnames=&Apache::lonnet::get('environment',
3074: ['firstname','middlename','lastname','generation','nickname'],
3075: $udom,$uname);
3076: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
3077: return %loadnames;
3078: }
3079: }
1.61 www 3080:
1.542 raeburn 3081: # -------------------------------------------------------------------- getemails
1.648 raeburn 3082:
1.542 raeburn 3083: =pod
3084:
1.648 raeburn 3085: =item * &getemails($uname,$udom)
1.542 raeburn 3086:
3087: Gets a user's email information and returns it as a hash with keys:
3088: notification, critnotification, permanentemail
3089:
3090: For notification and critnotification, values are comma-separated lists
1.648 raeburn 3091: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 3092:
1.648 raeburn 3093:
1.542 raeburn 3094: =cut
3095:
1.648 raeburn 3096:
1.466 albertel 3097: sub getemails {
3098: my ($uname,$udom)=@_;
3099: if ($udom eq 'public' && $uname eq 'public') {
3100: return;
3101: }
1.467 www 3102: if (!$udom) { $udom=$env{'user.domain'}; }
3103: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 3104: my $id=$uname.':'.$udom;
3105: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
3106: if ($cached) {
3107: return %{$names};
3108: } else {
3109: my %loadnames=&Apache::lonnet::get('environment',
3110: ['notification','critnotification',
3111: 'permanentemail'],
3112: $udom,$uname);
3113: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
3114: return %loadnames;
3115: }
3116: }
3117:
1.551 albertel 3118: sub flush_email_cache {
3119: my ($uname,$udom)=@_;
3120: if (!$udom) { $udom =$env{'user.domain'}; }
3121: if (!$uname) { $uname=$env{'user.name'}; }
3122: return if ($udom eq 'public' && $uname eq 'public');
3123: my $id=$uname.':'.$udom;
3124: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
3125: }
3126:
1.728 raeburn 3127: # -------------------------------------------------------------------- getlangs
3128:
3129: =pod
3130:
3131: =item * &getlangs($uname,$udom)
3132:
3133: Gets a user's language preference and returns it as a hash with key:
3134: language.
3135:
3136: =cut
3137:
3138:
3139: sub getlangs {
3140: my ($uname,$udom) = @_;
3141: if (!$udom) { $udom =$env{'user.domain'}; }
3142: if (!$uname) { $uname=$env{'user.name'}; }
3143: my $id=$uname.':'.$udom;
3144: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
3145: if ($cached) {
3146: return %{$langs};
3147: } else {
3148: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
3149: $udom,$uname);
3150: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
3151: return %loadlangs;
3152: }
3153: }
3154:
3155: sub flush_langs_cache {
3156: my ($uname,$udom)=@_;
3157: if (!$udom) { $udom =$env{'user.domain'}; }
3158: if (!$uname) { $uname=$env{'user.name'}; }
3159: return if ($udom eq 'public' && $uname eq 'public');
3160: my $id=$uname.':'.$udom;
3161: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
3162: }
3163:
1.61 www 3164: # ------------------------------------------------------------------ Screenname
1.81 albertel 3165:
3166: =pod
3167:
1.648 raeburn 3168: =item * &screenname($uname,$udom)
1.81 albertel 3169:
3170: Gets a users screenname and returns it as a string
3171:
3172: =cut
1.61 www 3173:
3174: sub screenname {
3175: my ($uname,$udom)=@_;
1.258 albertel 3176: if ($uname eq $env{'user.name'} &&
3177: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 3178: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 3179: return $names{'screenname'};
1.62 www 3180: }
3181:
1.212 albertel 3182:
1.802 bisitz 3183: # ------------------------------------------------------------- Confirm Wrapper
3184: =pod
3185:
3186: =item confirmwrapper
3187:
3188: Wrap messages about completion of operation in box
3189:
3190: =cut
3191:
3192: sub confirmwrapper {
3193: my ($message)=@_;
3194: if ($message) {
3195: return "\n".'<div class="LC_confirm_box">'."\n"
3196: .$message."\n"
3197: .'</div>'."\n";
3198: } else {
3199: return $message;
3200: }
3201: }
3202:
1.62 www 3203: # ------------------------------------------------------------- Message Wrapper
3204:
3205: sub messagewrapper {
1.369 www 3206: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 3207: return
1.441 albertel 3208: '<a href="/adm/email?compose=individual&'.
3209: 'recname='.$username.'&recdom='.$domain.
3210: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 3211: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 3212: }
1.802 bisitz 3213:
1.74 www 3214: # --------------------------------------------------------------- Notes Wrapper
3215:
3216: sub noteswrapper {
3217: my ($link,$un,$do)=@_;
3218: return
1.896 amueller 3219: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 3220: }
1.802 bisitz 3221:
1.62 www 3222: # ------------------------------------------------------------- Aboutme Wrapper
3223:
3224: sub aboutmewrapper {
1.1070 raeburn 3225: my ($link,$username,$domain,$target,$class)=@_;
1.447 raeburn 3226: if (!defined($username) && !defined($domain)) {
3227: return;
3228: }
1.892 amueller 3229: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.1070 raeburn 3230: ($target?' target="'.$target.'"':'').($class?' class="'.$class.'"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 3231: }
3232:
3233: # ------------------------------------------------------------ Syllabus Wrapper
3234:
3235: sub syllabuswrapper {
1.707 bisitz 3236: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 3237: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 3238: }
1.14 harris41 3239:
1.802 bisitz 3240: # -----------------------------------------------------------------------------
3241:
1.208 matthew 3242: sub track_student_link {
1.887 raeburn 3243: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 3244: my $link ="/adm/trackstudent?";
1.208 matthew 3245: my $title = 'View recent activity';
3246: if (defined($sname) && $sname !~ /^\s*$/ &&
3247: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 3248: $link .= "selected_student=$sname:$sdom";
1.208 matthew 3249: $title .= ' of this student';
1.268 albertel 3250: }
1.208 matthew 3251: if (defined($target) && $target !~ /^\s*$/) {
3252: $target = qq{target="$target"};
3253: } else {
3254: $target = '';
3255: }
1.268 albertel 3256: if ($start) { $link.='&start='.$start; }
1.887 raeburn 3257: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 3258: $title = &mt($title);
3259: $linktext = &mt($linktext);
1.448 albertel 3260: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
3261: &help_open_topic('View_recent_activity');
1.208 matthew 3262: }
3263:
1.781 raeburn 3264: sub slot_reservations_link {
3265: my ($linktext,$sname,$sdom,$target) = @_;
3266: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
3267: my $title = 'View slot reservation history';
3268: if (defined($sname) && $sname !~ /^\s*$/ &&
3269: defined($sdom) && $sdom !~ /^\s*$/) {
3270: $link .= "&uname=$sname&udom=$sdom";
3271: $title .= ' of this student';
3272: }
3273: if (defined($target) && $target !~ /^\s*$/) {
3274: $target = qq{target="$target"};
3275: } else {
3276: $target = '';
3277: }
3278: $title = &mt($title);
3279: $linktext = &mt($linktext);
3280: return qq{<a href="$link" title="$title" $target>$linktext</a>};
3281: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
3282:
3283: }
3284:
1.508 www 3285: # ===================================================== Display a student photo
3286:
3287:
1.509 albertel 3288: sub student_image_tag {
1.508 www 3289: my ($domain,$user)=@_;
3290: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
3291: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
3292: return '<img src="'.$imgsrc.'" align="right" />';
3293: } else {
3294: return '';
3295: }
3296: }
3297:
1.112 bowersj2 3298: =pod
3299:
3300: =back
3301:
3302: =head1 Access .tab File Data
3303:
3304: =over 4
3305:
1.648 raeburn 3306: =item * &languageids()
1.112 bowersj2 3307:
3308: returns list of all language ids
3309:
3310: =cut
3311:
1.14 harris41 3312: sub languageids {
1.16 harris41 3313: return sort(keys(%language));
1.14 harris41 3314: }
3315:
1.112 bowersj2 3316: =pod
3317:
1.648 raeburn 3318: =item * &languagedescription()
1.112 bowersj2 3319:
3320: returns description of a specified language id
3321:
3322: =cut
3323:
1.14 harris41 3324: sub languagedescription {
1.125 www 3325: my $code=shift;
3326: return ($supported_language{$code}?'* ':'').
3327: $language{$code}.
1.126 www 3328: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 3329: }
3330:
1.1048 foxr 3331: =pod
3332:
3333: =item * &plainlanguagedescription
3334:
3335: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
3336: and the language character encoding (e.g. ISO) separated by a ' - ' string.
3337:
3338: =cut
3339:
1.145 www 3340: sub plainlanguagedescription {
3341: my $code=shift;
3342: return $language{$code};
3343: }
3344:
1.1048 foxr 3345: =pod
3346:
3347: =item * &supportedlanguagecode
3348:
3349: Returns the supported language code (e.g. sptutf maps to pt) given a language
3350: code.
3351:
3352: =cut
3353:
1.145 www 3354: sub supportedlanguagecode {
3355: my $code=shift;
3356: return $supported_language{$code};
1.97 www 3357: }
3358:
1.112 bowersj2 3359: =pod
3360:
1.1048 foxr 3361: =item * &latexlanguage()
3362:
3363: Given a language key code returns the correspondnig language to use
3364: to select the correct hyphenation on LaTeX printouts. This is undef if there
3365: is no supported hyphenation for the language code.
3366:
3367: =cut
3368:
3369: sub latexlanguage {
3370: my $code = shift;
3371: return $latex_language{$code};
3372: }
3373:
3374: =pod
3375:
3376: =item * &latexhyphenation()
3377:
3378: Same as above but what's supplied is the language as it might be stored
3379: in the metadata.
3380:
3381: =cut
3382:
3383: sub latexhyphenation {
3384: my $key = shift;
3385: return $latex_language_bykey{$key};
3386: }
3387:
3388: =pod
3389:
1.648 raeburn 3390: =item * ©rightids()
1.112 bowersj2 3391:
3392: returns list of all copyrights
3393:
3394: =cut
3395:
3396: sub copyrightids {
3397: return sort(keys(%cprtag));
3398: }
3399:
3400: =pod
3401:
1.648 raeburn 3402: =item * ©rightdescription()
1.112 bowersj2 3403:
3404: returns description of a specified copyright id
3405:
3406: =cut
3407:
3408: sub copyrightdescription {
1.166 www 3409: return &mt($cprtag{shift(@_)});
1.112 bowersj2 3410: }
1.197 matthew 3411:
3412: =pod
3413:
1.648 raeburn 3414: =item * &source_copyrightids()
1.192 taceyjo1 3415:
3416: returns list of all source copyrights
3417:
3418: =cut
3419:
3420: sub source_copyrightids {
3421: return sort(keys(%scprtag));
3422: }
3423:
3424: =pod
3425:
1.648 raeburn 3426: =item * &source_copyrightdescription()
1.192 taceyjo1 3427:
3428: returns description of a specified source copyright id
3429:
3430: =cut
3431:
3432: sub source_copyrightdescription {
3433: return &mt($scprtag{shift(@_)});
3434: }
1.112 bowersj2 3435:
3436: =pod
3437:
1.648 raeburn 3438: =item * &filecategories()
1.112 bowersj2 3439:
3440: returns list of all file categories
3441:
3442: =cut
3443:
3444: sub filecategories {
3445: return sort(keys(%category_extensions));
3446: }
3447:
3448: =pod
3449:
1.648 raeburn 3450: =item * &filecategorytypes()
1.112 bowersj2 3451:
3452: returns list of file types belonging to a given file
3453: category
3454:
3455: =cut
3456:
3457: sub filecategorytypes {
1.356 albertel 3458: my ($cat) = @_;
3459: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 3460: }
3461:
3462: =pod
3463:
1.648 raeburn 3464: =item * &fileembstyle()
1.112 bowersj2 3465:
3466: returns embedding style for a specified file type
3467:
3468: =cut
3469:
3470: sub fileembstyle {
3471: return $fe{lc(shift(@_))};
1.169 www 3472: }
3473:
1.351 www 3474: sub filemimetype {
3475: return $fm{lc(shift(@_))};
3476: }
3477:
1.169 www 3478:
3479: sub filecategoryselect {
3480: my ($name,$value)=@_;
1.189 matthew 3481: return &select_form($value,$name,
1.970 raeburn 3482: {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112 bowersj2 3483: }
3484:
3485: =pod
3486:
1.648 raeburn 3487: =item * &filedescription()
1.112 bowersj2 3488:
3489: returns description for a specified file type
3490:
3491: =cut
3492:
3493: sub filedescription {
1.188 matthew 3494: my $file_description = $fd{lc(shift())};
3495: $file_description =~ s:([\[\]]):~$1:g;
3496: return &mt($file_description);
1.112 bowersj2 3497: }
3498:
3499: =pod
3500:
1.648 raeburn 3501: =item * &filedescriptionex()
1.112 bowersj2 3502:
3503: returns description for a specified file type with
3504: extra formatting
3505:
3506: =cut
3507:
3508: sub filedescriptionex {
3509: my $ex=shift;
1.188 matthew 3510: my $file_description = $fd{lc($ex)};
3511: $file_description =~ s:([\[\]]):~$1:g;
3512: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3513: }
3514:
3515: # End of .tab access
3516: =pod
3517:
3518: =back
3519:
3520: =cut
3521:
3522: # ------------------------------------------------------------------ File Types
3523: sub fileextensions {
3524: return sort(keys(%fe));
3525: }
3526:
1.97 www 3527: # ----------------------------------------------------------- Display Languages
3528: # returns a hash with all desired display languages
3529: #
3530:
3531: sub display_languages {
3532: my %languages=();
1.695 raeburn 3533: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3534: $languages{$lang}=1;
1.97 www 3535: }
3536: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3537: if ($env{'form.displaylanguage'}) {
1.356 albertel 3538: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3539: $languages{$lang}=1;
1.97 www 3540: }
3541: }
3542: return %languages;
1.14 harris41 3543: }
3544:
1.582 albertel 3545: sub languages {
3546: my ($possible_langs) = @_;
1.695 raeburn 3547: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3548: if (!ref($possible_langs)) {
3549: if( wantarray ) {
3550: return @preferred_langs;
3551: } else {
3552: return $preferred_langs[0];
3553: }
3554: }
3555: my %possibilities = map { $_ => 1 } (@$possible_langs);
3556: my @preferred_possibilities;
3557: foreach my $preferred_lang (@preferred_langs) {
3558: if (exists($possibilities{$preferred_lang})) {
3559: push(@preferred_possibilities, $preferred_lang);
3560: }
3561: }
3562: if( wantarray ) {
3563: return @preferred_possibilities;
3564: }
3565: return $preferred_possibilities[0];
3566: }
3567:
1.742 raeburn 3568: sub user_lang {
3569: my ($touname,$toudom,$fromcid) = @_;
3570: my @userlangs;
3571: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3572: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3573: $env{'course.'.$fromcid.'.languages'}));
3574: } else {
3575: my %langhash = &getlangs($touname,$toudom);
3576: if ($langhash{'languages'} ne '') {
3577: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3578: } else {
3579: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3580: if ($domdefs{'lang_def'} ne '') {
3581: @userlangs = ($domdefs{'lang_def'});
3582: }
3583: }
3584: }
3585: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3586: my $user_lh = Apache::localize->get_handle(@languages);
3587: return $user_lh;
3588: }
3589:
3590:
1.112 bowersj2 3591: ###############################################################
3592: ## Student Answer Attempts ##
3593: ###############################################################
3594:
3595: =pod
3596:
3597: =head1 Alternate Problem Views
3598:
3599: =over 4
3600:
1.648 raeburn 3601: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3602: $getattempt, $regexp, $gradesub)
3603:
3604: Return string with previous attempt on problem. Arguments:
3605:
3606: =over 4
3607:
3608: =item * $symb: Problem, including path
3609:
3610: =item * $username: username of the desired student
3611:
3612: =item * $domain: domain of the desired student
1.14 harris41 3613:
1.112 bowersj2 3614: =item * $course: Course ID
1.14 harris41 3615:
1.112 bowersj2 3616: =item * $getattempt: Leave blank for all attempts, otherwise put
3617: something
1.14 harris41 3618:
1.112 bowersj2 3619: =item * $regexp: if string matches this regexp, the string will be
3620: sent to $gradesub
1.14 harris41 3621:
1.112 bowersj2 3622: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3623:
1.112 bowersj2 3624: =back
1.14 harris41 3625:
1.112 bowersj2 3626: The output string is a table containing all desired attempts, if any.
1.16 harris41 3627:
1.112 bowersj2 3628: =cut
1.1 albertel 3629:
3630: sub get_previous_attempt {
1.43 ng 3631: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3632: my $prevattempts='';
1.43 ng 3633: no strict 'refs';
1.1 albertel 3634: if ($symb) {
1.3 albertel 3635: my (%returnhash)=
3636: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3637: if ($returnhash{'version'}) {
3638: my %lasthash=();
3639: my $version;
3640: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3641: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3642: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3643: }
1.1 albertel 3644: }
1.596 albertel 3645: $prevattempts=&start_data_table().&start_data_table_header_row();
3646: $prevattempts.='<th>'.&mt('History').'</th>';
1.978 raeburn 3647: my (%typeparts,%lasthidden);
1.945 raeburn 3648: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 3649: foreach my $key (sort(keys(%lasthash))) {
3650: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3651: if ($#parts > 0) {
1.31 albertel 3652: my $data=$parts[-1];
1.989 raeburn 3653: next if ($data eq 'foilorder');
1.31 albertel 3654: pop(@parts);
1.1010 www 3655: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.945 raeburn 3656: if ($data eq 'type') {
3657: unless ($showsurv) {
3658: my $id = join(',',@parts);
3659: $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978 raeburn 3660: if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
3661: $lasthidden{$ign.'.'.$id} = 1;
3662: }
1.945 raeburn 3663: }
1.1010 www 3664: }
1.31 albertel 3665: } else {
1.41 ng 3666: if ($#parts == 0) {
3667: $prevattempts.='<th>'.$parts[0].'</th>';
3668: } else {
3669: $prevattempts.='<th>'.$ign.'</th>';
3670: }
1.31 albertel 3671: }
1.16 harris41 3672: }
1.596 albertel 3673: $prevattempts.=&end_data_table_header_row();
1.40 ng 3674: if ($getattempt eq '') {
3675: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.945 raeburn 3676: my @hidden;
3677: if (%typeparts) {
3678: foreach my $id (keys(%typeparts)) {
3679: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
3680: push(@hidden,$id);
3681: }
3682: }
3683: }
3684: $prevattempts.=&start_data_table_row().
3685: '<td>'.&mt('Transaction [_1]',$version).'</td>';
3686: if (@hidden) {
3687: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3688: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3689: my $hide;
3690: foreach my $id (@hidden) {
3691: if ($key =~ /^\Q$id\E/) {
3692: $hide = 1;
3693: last;
3694: }
3695: }
3696: if ($hide) {
3697: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3698: if (($data eq 'award') || ($data eq 'awarddetail')) {
3699: my $value = &format_previous_attempt_value($key,
3700: $returnhash{$version.':'.$key});
3701: $prevattempts.='<td>'.$value.' </td>';
3702: } else {
3703: $prevattempts.='<td> </td>';
3704: }
3705: } else {
3706: if ($key =~ /\./) {
3707: my $value = &format_previous_attempt_value($key,
3708: $returnhash{$version.':'.$key});
3709: $prevattempts.='<td>'.$value.' </td>';
3710: } else {
3711: $prevattempts.='<td> </td>';
3712: }
3713: }
3714: }
3715: } else {
3716: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3717: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3718: my $value = &format_previous_attempt_value($key,
3719: $returnhash{$version.':'.$key});
3720: $prevattempts.='<td>'.$value.' </td>';
3721: }
3722: }
3723: $prevattempts.=&end_data_table_row();
1.40 ng 3724: }
1.1 albertel 3725: }
1.945 raeburn 3726: my @currhidden = keys(%lasthidden);
1.596 albertel 3727: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3728: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3729: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3730: if (%typeparts) {
3731: my $hidden;
3732: foreach my $id (@currhidden) {
3733: if ($key =~ /^\Q$id\E/) {
3734: $hidden = 1;
3735: last;
3736: }
3737: }
3738: if ($hidden) {
3739: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3740: if (($data eq 'award') || ($data eq 'awarddetail')) {
3741: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3742: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3743: $value = &$gradesub($value);
3744: }
3745: $prevattempts.='<td>'.$value.' </td>';
3746: } else {
3747: $prevattempts.='<td> </td>';
3748: }
3749: } else {
3750: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3751: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3752: $value = &$gradesub($value);
3753: }
3754: $prevattempts.='<td>'.$value.' </td>';
3755: }
3756: } else {
3757: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3758: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3759: $value = &$gradesub($value);
3760: }
3761: $prevattempts.='<td>'.$value.' </td>';
3762: }
1.16 harris41 3763: }
1.596 albertel 3764: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3765: } else {
1.596 albertel 3766: $prevattempts=
3767: &start_data_table().&start_data_table_row().
3768: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3769: &end_data_table_row().&end_data_table();
1.1 albertel 3770: }
3771: } else {
1.596 albertel 3772: $prevattempts=
3773: &start_data_table().&start_data_table_row().
3774: '<td>'.&mt('No data.').'</td>'.
3775: &end_data_table_row().&end_data_table();
1.1 albertel 3776: }
1.10 albertel 3777: }
3778:
1.581 albertel 3779: sub format_previous_attempt_value {
3780: my ($key,$value) = @_;
1.1011 www 3781: if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.581 albertel 3782: $value = &Apache::lonlocal::locallocaltime($value);
3783: } elsif (ref($value) eq 'ARRAY') {
3784: $value = '('.join(', ', @{ $value }).')';
1.988 raeburn 3785: } elsif ($key =~ /answerstring$/) {
3786: my %answers = &Apache::lonnet::str2hash($value);
3787: my @anskeys = sort(keys(%answers));
3788: if (@anskeys == 1) {
3789: my $answer = $answers{$anskeys[0]};
1.1001 raeburn 3790: if ($answer =~ m{\0}) {
3791: $answer =~ s{\0}{,}g;
1.988 raeburn 3792: }
3793: my $tag_internal_answer_name = 'INTERNAL';
3794: if ($anskeys[0] eq $tag_internal_answer_name) {
3795: $value = $answer;
3796: } else {
3797: $value = $anskeys[0].'='.$answer;
3798: }
3799: } else {
3800: foreach my $ans (@anskeys) {
3801: my $answer = $answers{$ans};
1.1001 raeburn 3802: if ($answer =~ m{\0}) {
3803: $answer =~ s{\0}{,}g;
1.988 raeburn 3804: }
3805: $value .= $ans.'='.$answer.'<br />';;
3806: }
3807: }
1.581 albertel 3808: } else {
3809: $value = &unescape($value);
3810: }
3811: return $value;
3812: }
3813:
3814:
1.107 albertel 3815: sub relative_to_absolute {
3816: my ($url,$output)=@_;
3817: my $parser=HTML::TokeParser->new(\$output);
3818: my $token;
3819: my $thisdir=$url;
3820: my @rlinks=();
3821: while ($token=$parser->get_token) {
3822: if ($token->[0] eq 'S') {
3823: if ($token->[1] eq 'a') {
3824: if ($token->[2]->{'href'}) {
3825: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3826: }
3827: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3828: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3829: } elsif ($token->[1] eq 'base') {
3830: $thisdir=$token->[2]->{'href'};
3831: }
3832: }
3833: }
3834: $thisdir=~s-/[^/]*$--;
1.356 albertel 3835: foreach my $link (@rlinks) {
1.726 raeburn 3836: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3837: ($link=~/^\//) ||
3838: ($link=~/^javascript:/i) ||
3839: ($link=~/^mailto:/i) ||
3840: ($link=~/^\#/)) {
3841: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3842: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3843: }
3844: }
3845: # -------------------------------------------------- Deal with Applet codebases
3846: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3847: return $output;
3848: }
3849:
1.112 bowersj2 3850: =pod
3851:
1.648 raeburn 3852: =item * &get_student_view()
1.112 bowersj2 3853:
3854: show a snapshot of what student was looking at
3855:
3856: =cut
3857:
1.10 albertel 3858: sub get_student_view {
1.186 albertel 3859: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3860: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3861: my (%form);
1.10 albertel 3862: my @elements=('symb','courseid','domain','username');
3863: foreach my $element (@elements) {
1.186 albertel 3864: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3865: }
1.186 albertel 3866: if (defined($moreenv)) {
3867: %form=(%form,%{$moreenv});
3868: }
1.236 albertel 3869: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3870: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3871: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3872: $userview=~s/\<body[^\>]*\>//gi;
3873: $userview=~s/\<\/body\>//gi;
3874: $userview=~s/\<html\>//gi;
3875: $userview=~s/\<\/html\>//gi;
3876: $userview=~s/\<head\>//gi;
3877: $userview=~s/\<\/head\>//gi;
3878: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3879: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3880: if (wantarray) {
3881: return ($userview,$response);
3882: } else {
3883: return $userview;
3884: }
3885: }
3886:
3887: sub get_student_view_with_retries {
3888: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3889:
3890: my $ok = 0; # True if we got a good response.
3891: my $content;
3892: my $response;
3893:
3894: # Try to get the student_view done. within the retries count:
3895:
3896: do {
3897: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3898: $ok = $response->is_success;
3899: if (!$ok) {
3900: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3901: }
3902: $retries--;
3903: } while (!$ok && ($retries > 0));
3904:
3905: if (!$ok) {
3906: $content = ''; # On error return an empty content.
3907: }
1.651 www 3908: if (wantarray) {
3909: return ($content, $response);
3910: } else {
3911: return $content;
3912: }
1.11 albertel 3913: }
3914:
1.112 bowersj2 3915: =pod
3916:
1.648 raeburn 3917: =item * &get_student_answers()
1.112 bowersj2 3918:
3919: show a snapshot of how student was answering problem
3920:
3921: =cut
3922:
1.11 albertel 3923: sub get_student_answers {
1.100 sakharuk 3924: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3925: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3926: my (%moreenv);
1.11 albertel 3927: my @elements=('symb','courseid','domain','username');
3928: foreach my $element (@elements) {
1.186 albertel 3929: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3930: }
1.186 albertel 3931: $moreenv{'grade_target'}='answer';
3932: %moreenv=(%form,%moreenv);
1.497 raeburn 3933: $feedurl = &Apache::lonnet::clutter($feedurl);
3934: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3935: return $userview;
1.1 albertel 3936: }
1.116 albertel 3937:
3938: =pod
3939:
3940: =item * &submlink()
3941:
1.242 albertel 3942: Inputs: $text $uname $udom $symb $target
1.116 albertel 3943:
3944: Returns: A link to grades.pm such as to see the SUBM view of a student
3945:
3946: =cut
3947:
3948: ###############################################
3949: sub submlink {
1.242 albertel 3950: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3951: if (!($uname && $udom)) {
3952: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3953: &Apache::lonnet::whichuser($symb);
1.116 albertel 3954: if (!$symb) { $symb=$cursymb; }
3955: }
1.254 matthew 3956: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3957: $symb=&escape($symb);
1.960 bisitz 3958: if ($target) { $target=" target=\"$target\""; }
3959: return
3960: '<a href="/adm/grades?command=submission'.
3961: '&symb='.$symb.
3962: '&student='.$uname.
3963: '&userdom='.$udom.'"'.
3964: $target.'>'.$text.'</a>';
1.242 albertel 3965: }
3966: ##############################################
3967:
3968: =pod
3969:
3970: =item * &pgrdlink()
3971:
3972: Inputs: $text $uname $udom $symb $target
3973:
3974: Returns: A link to grades.pm such as to see the PGRD view of a student
3975:
3976: =cut
3977:
3978: ###############################################
3979: sub pgrdlink {
3980: my $link=&submlink(@_);
3981: $link=~s/(&command=submission)/$1&showgrading=yes/;
3982: return $link;
3983: }
3984: ##############################################
3985:
3986: =pod
3987:
3988: =item * &pprmlink()
3989:
3990: Inputs: $text $uname $udom $symb $target
3991:
3992: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3993: student and a specific resource
1.242 albertel 3994:
3995: =cut
3996:
3997: ###############################################
3998: sub pprmlink {
3999: my ($text,$uname,$udom,$symb,$target)=@_;
4000: if (!($uname && $udom)) {
4001: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 4002: &Apache::lonnet::whichuser($symb);
1.242 albertel 4003: if (!$symb) { $symb=$cursymb; }
4004: }
1.254 matthew 4005: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 4006: $symb=&escape($symb);
1.242 albertel 4007: if ($target) { $target="target=\"$target\""; }
1.595 albertel 4008: return '<a href="/adm/parmset?command=set&'.
4009: 'symb='.$symb.'&uname='.$uname.
4010: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 4011: }
4012: ##############################################
1.37 matthew 4013:
1.112 bowersj2 4014: =pod
4015:
4016: =back
4017:
4018: =cut
4019:
1.37 matthew 4020: ###############################################
1.51 www 4021:
4022:
4023: sub timehash {
1.687 raeburn 4024: my ($thistime) = @_;
4025: my $timezone = &Apache::lonlocal::gettimezone();
4026: my $dt = DateTime->from_epoch(epoch => $thistime)
4027: ->set_time_zone($timezone);
4028: my $wday = $dt->day_of_week();
4029: if ($wday == 7) { $wday = 0; }
4030: return ( 'second' => $dt->second(),
4031: 'minute' => $dt->minute(),
4032: 'hour' => $dt->hour(),
4033: 'day' => $dt->day_of_month(),
4034: 'month' => $dt->month(),
4035: 'year' => $dt->year(),
4036: 'weekday' => $wday,
4037: 'dayyear' => $dt->day_of_year(),
4038: 'dlsav' => $dt->is_dst() );
1.51 www 4039: }
4040:
1.370 www 4041: sub utc_string {
4042: my ($date)=@_;
1.371 www 4043: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 4044: }
4045:
1.51 www 4046: sub maketime {
4047: my %th=@_;
1.687 raeburn 4048: my ($epoch_time,$timezone,$dt);
4049: $timezone = &Apache::lonlocal::gettimezone();
4050: eval {
4051: $dt = DateTime->new( year => $th{'year'},
4052: month => $th{'month'},
4053: day => $th{'day'},
4054: hour => $th{'hour'},
4055: minute => $th{'minute'},
4056: second => $th{'second'},
4057: time_zone => $timezone,
4058: );
4059: };
4060: if (!$@) {
4061: $epoch_time = $dt->epoch;
4062: if ($epoch_time) {
4063: return $epoch_time;
4064: }
4065: }
1.51 www 4066: return POSIX::mktime(
4067: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 4068: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 4069: }
4070:
4071: #########################################
1.51 www 4072:
4073: sub findallcourses {
1.482 raeburn 4074: my ($roles,$uname,$udom) = @_;
1.355 albertel 4075: my %roles;
4076: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 4077: my %courses;
1.51 www 4078: my $now=time;
1.482 raeburn 4079: if (!defined($uname)) {
4080: $uname = $env{'user.name'};
4081: }
4082: if (!defined($udom)) {
4083: $udom = $env{'user.domain'};
4084: }
4085: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.1073 raeburn 4086: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
1.482 raeburn 4087: if (!%roles) {
4088: %roles = (
4089: cc => 1,
1.907 raeburn 4090: co => 1,
1.482 raeburn 4091: in => 1,
4092: ep => 1,
4093: ta => 1,
4094: cr => 1,
4095: st => 1,
4096: );
4097: }
4098: foreach my $entry (keys(%roleshash)) {
4099: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
4100: if ($trole =~ /^cr/) {
4101: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
4102: } else {
4103: next if (!exists($roles{$trole}));
4104: }
4105: if ($tend) {
4106: next if ($tend < $now);
4107: }
4108: if ($tstart) {
4109: next if ($tstart > $now);
4110: }
1.1058 raeburn 4111: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482 raeburn 4112: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058 raeburn 4113: my $value = $trole.'/'.$cdom.'/';
1.482 raeburn 4114: if ($secpart eq '') {
4115: ($cnum,$role) = split(/_/,$cnumpart);
4116: $sec = 'none';
1.1058 raeburn 4117: $value .= $cnum.'/';
1.482 raeburn 4118: } else {
4119: $cnum = $cnumpart;
4120: ($sec,$role) = split(/_/,$secpart);
1.1058 raeburn 4121: $value .= $cnum.'/'.$sec;
4122: }
4123: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
4124: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
4125: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
4126: }
4127: } else {
4128: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490 raeburn 4129: }
1.482 raeburn 4130: }
4131: } else {
4132: foreach my $key (keys(%env)) {
1.483 albertel 4133: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
4134: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 4135: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
4136: next if ($role eq 'ca' || $role eq 'aa');
4137: next if (%roles && !exists($roles{$role}));
4138: my ($starttime,$endtime)=split(/\./,$env{$key});
4139: my $active=1;
4140: if ($starttime) {
4141: if ($now<$starttime) { $active=0; }
4142: }
4143: if ($endtime) {
4144: if ($now>$endtime) { $active=0; }
4145: }
4146: if ($active) {
1.1058 raeburn 4147: my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482 raeburn 4148: if ($sec eq '') {
4149: $sec = 'none';
1.1058 raeburn 4150: } else {
4151: $value .= $sec;
4152: }
4153: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
4154: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
4155: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
4156: }
4157: } else {
4158: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482 raeburn 4159: }
1.474 raeburn 4160: }
4161: }
1.51 www 4162: }
4163: }
1.474 raeburn 4164: return %courses;
1.51 www 4165: }
1.37 matthew 4166:
1.54 www 4167: ###############################################
1.474 raeburn 4168:
4169: sub blockcheck {
1.1062 raeburn 4170: my ($setters,$activity,$uname,$udom,$url) = @_;
1.490 raeburn 4171:
4172: if (!defined($udom)) {
4173: $udom = $env{'user.domain'};
4174: }
4175: if (!defined($uname)) {
4176: $uname = $env{'user.name'};
4177: }
4178:
4179: # If uname and udom are for a course, check for blocks in the course.
4180:
4181: if (&Apache::lonnet::is_course($udom,$uname)) {
1.1062 raeburn 4182: my ($startblock,$endblock,$triggerblock) =
4183: &get_blocks($setters,$activity,$udom,$uname,$url);
4184: return ($startblock,$endblock,$triggerblock);
1.490 raeburn 4185: }
1.474 raeburn 4186:
1.502 raeburn 4187: my $startblock = 0;
4188: my $endblock = 0;
1.1062 raeburn 4189: my $triggerblock = '';
1.482 raeburn 4190: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 4191:
1.490 raeburn 4192: # If uname is for a user, and activity is course-specific, i.e.,
4193: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 4194:
1.490 raeburn 4195: if (($activity eq 'boards' || $activity eq 'chat' ||
4196: $activity eq 'groups') && ($env{'request.course.id'})) {
4197: foreach my $key (keys(%live_courses)) {
4198: if ($key ne $env{'request.course.id'}) {
4199: delete($live_courses{$key});
4200: }
4201: }
4202: }
4203:
4204: my $otheruser = 0;
4205: my %own_courses;
4206: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
4207: # Resource belongs to user other than current user.
4208: $otheruser = 1;
4209: # Gather courses for current user
4210: %own_courses =
4211: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
4212: }
4213:
4214: # Gather active course roles - course coordinator, instructor,
4215: # exam proctor, ta, student, or custom role.
1.474 raeburn 4216:
4217: foreach my $course (keys(%live_courses)) {
1.482 raeburn 4218: my ($cdom,$cnum);
4219: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
4220: $cdom = $env{'course.'.$course.'.domain'};
4221: $cnum = $env{'course.'.$course.'.num'};
4222: } else {
1.490 raeburn 4223: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 4224: }
4225: my $no_ownblock = 0;
4226: my $no_userblock = 0;
1.533 raeburn 4227: if ($otheruser && $activity ne 'com') {
1.490 raeburn 4228: # Check if current user has 'evb' priv for this
4229: if (defined($own_courses{$course})) {
4230: foreach my $sec (keys(%{$own_courses{$course}})) {
4231: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
4232: if ($sec ne 'none') {
4233: $checkrole .= '/'.$sec;
4234: }
4235: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4236: $no_ownblock = 1;
4237: last;
4238: }
4239: }
4240: }
4241: # if they have 'evb' priv and are currently not playing student
4242: next if (($no_ownblock) &&
4243: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
4244: }
1.474 raeburn 4245: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 4246: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 4247: if ($sec ne 'none') {
1.482 raeburn 4248: $checkrole .= '/'.$sec;
1.474 raeburn 4249: }
1.490 raeburn 4250: if ($otheruser) {
4251: # Resource belongs to user other than current user.
4252: # Assemble privs for that user, and check for 'evb' priv.
1.1058 raeburn 4253: my (%allroles,%userroles);
4254: if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
4255: foreach my $entry (@{$live_courses{$course}{$sec}}) {
4256: my ($trole,$tdom,$tnum,$tsec);
4257: if ($entry =~ /^cr/) {
4258: ($trole,$tdom,$tnum,$tsec) =
4259: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
4260: } else {
4261: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
4262: }
4263: my ($spec,$area,$trest);
4264: $area = '/'.$tdom.'/'.$tnum;
4265: $trest = $tnum;
4266: if ($tsec ne '') {
4267: $area .= '/'.$tsec;
4268: $trest .= '/'.$tsec;
4269: }
4270: $spec = $trole.'.'.$area;
4271: if ($trole =~ /^cr/) {
4272: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
4273: $tdom,$spec,$trest,$area);
4274: } else {
4275: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
4276: $tdom,$spec,$trest,$area);
4277: }
4278: }
4279: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
4280: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
4281: if ($1) {
4282: $no_userblock = 1;
4283: last;
4284: }
1.486 raeburn 4285: }
4286: }
1.490 raeburn 4287: } else {
4288: # Resource belongs to current user
4289: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 4290: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4291: $no_ownblock = 1;
4292: last;
4293: }
1.474 raeburn 4294: }
4295: }
4296: # if they have the evb priv and are currently not playing student
1.482 raeburn 4297: next if (($no_ownblock) &&
1.491 albertel 4298: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 4299: next if ($no_userblock);
1.474 raeburn 4300:
1.866 kalberla 4301: # Retrieve blocking times and identity of locker for course
1.490 raeburn 4302: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 4303:
1.1062 raeburn 4304: my ($start,$end,$trigger) =
4305: &get_blocks($setters,$activity,$cdom,$cnum,$url);
1.502 raeburn 4306: if (($start != 0) &&
4307: (($startblock == 0) || ($startblock > $start))) {
4308: $startblock = $start;
1.1062 raeburn 4309: if ($trigger ne '') {
4310: $triggerblock = $trigger;
4311: }
1.502 raeburn 4312: }
4313: if (($end != 0) &&
4314: (($endblock == 0) || ($endblock < $end))) {
4315: $endblock = $end;
1.1062 raeburn 4316: if ($trigger ne '') {
4317: $triggerblock = $trigger;
4318: }
1.502 raeburn 4319: }
1.490 raeburn 4320: }
1.1062 raeburn 4321: return ($startblock,$endblock,$triggerblock);
1.490 raeburn 4322: }
4323:
4324: sub get_blocks {
1.1062 raeburn 4325: my ($setters,$activity,$cdom,$cnum,$url) = @_;
1.490 raeburn 4326: my $startblock = 0;
4327: my $endblock = 0;
1.1062 raeburn 4328: my $triggerblock = '';
1.490 raeburn 4329: my $course = $cdom.'_'.$cnum;
4330: $setters->{$course} = {};
4331: $setters->{$course}{'staff'} = [];
4332: $setters->{$course}{'times'} = [];
1.1062 raeburn 4333: $setters->{$course}{'triggers'} = [];
4334: my (@blockers,%triggered);
4335: my $now = time;
4336: my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
4337: if ($activity eq 'docs') {
4338: @blockers = &Apache::lonnet::has_comm_blocking('bre',undef,$url,\%commblocks);
4339: foreach my $block (@blockers) {
4340: if ($block =~ /^firstaccess____(.+)$/) {
4341: my $item = $1;
4342: my $type = 'map';
4343: my $timersymb = $item;
4344: if ($item eq 'course') {
4345: $type = 'course';
4346: } elsif ($item =~ /___\d+___/) {
4347: $type = 'resource';
4348: } else {
4349: $timersymb = &Apache::lonnet::symbread($item);
4350: }
4351: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
4352: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
4353: $triggered{$block} = {
4354: start => $start,
4355: end => $end,
4356: type => $type,
4357: };
4358: }
4359: }
4360: } else {
4361: foreach my $block (keys(%commblocks)) {
4362: if ($block =~ m/^(\d+)____(\d+)$/) {
4363: my ($start,$end) = ($1,$2);
4364: if ($start <= time && $end >= time) {
4365: if (ref($commblocks{$block}) eq 'HASH') {
4366: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
4367: if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
4368: unless(grep(/^\Q$block\E$/,@blockers)) {
4369: push(@blockers,$block);
4370: }
4371: }
4372: }
4373: }
4374: }
4375: } elsif ($block =~ /^firstaccess____(.+)$/) {
4376: my $item = $1;
4377: my $timersymb = $item;
4378: my $type = 'map';
4379: if ($item eq 'course') {
4380: $type = 'course';
4381: } elsif ($item =~ /___\d+___/) {
4382: $type = 'resource';
4383: } else {
4384: $timersymb = &Apache::lonnet::symbread($item);
4385: }
4386: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
4387: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
4388: if ($start && $end) {
4389: if (($start <= time) && ($end >= time)) {
4390: unless (grep(/^\Q$block\E$/,@blockers)) {
4391: push(@blockers,$block);
4392: $triggered{$block} = {
4393: start => $start,
4394: end => $end,
4395: type => $type,
4396: };
4397: }
4398: }
1.490 raeburn 4399: }
1.1062 raeburn 4400: }
4401: }
4402: }
4403: foreach my $blocker (@blockers) {
4404: my ($staff_name,$staff_dom,$title,$blocks) =
4405: &parse_block_record($commblocks{$blocker});
4406: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
4407: my ($start,$end,$triggertype);
4408: if ($blocker =~ m/^(\d+)____(\d+)$/) {
4409: ($start,$end) = ($1,$2);
4410: } elsif (ref($triggered{$blocker}) eq 'HASH') {
4411: $start = $triggered{$blocker}{'start'};
4412: $end = $triggered{$blocker}{'end'};
4413: $triggertype = $triggered{$blocker}{'type'};
4414: }
4415: if ($start) {
4416: push(@{$$setters{$course}{'times'}}, [$start,$end]);
4417: if ($triggertype) {
4418: push(@{$$setters{$course}{'triggers'}},$triggertype);
4419: } else {
4420: push(@{$$setters{$course}{'triggers'}},0);
4421: }
4422: if ( ($startblock == 0) || ($startblock > $start) ) {
4423: $startblock = $start;
4424: if ($triggertype) {
4425: $triggerblock = $blocker;
1.474 raeburn 4426: }
4427: }
1.1062 raeburn 4428: if ( ($endblock == 0) || ($endblock < $end) ) {
4429: $endblock = $end;
4430: if ($triggertype) {
4431: $triggerblock = $blocker;
4432: }
4433: }
1.474 raeburn 4434: }
4435: }
1.1062 raeburn 4436: return ($startblock,$endblock,$triggerblock);
1.474 raeburn 4437: }
4438:
4439: sub parse_block_record {
4440: my ($record) = @_;
4441: my ($setuname,$setudom,$title,$blocks);
4442: if (ref($record) eq 'HASH') {
4443: ($setuname,$setudom) = split(/:/,$record->{'setter'});
4444: $title = &unescape($record->{'event'});
4445: $blocks = $record->{'blocks'};
4446: } else {
4447: my @data = split(/:/,$record,3);
4448: if (scalar(@data) eq 2) {
4449: $title = $data[1];
4450: ($setuname,$setudom) = split(/@/,$data[0]);
4451: } else {
4452: ($setuname,$setudom,$title) = @data;
4453: }
4454: $blocks = { 'com' => 'on' };
4455: }
4456: return ($setuname,$setudom,$title,$blocks);
4457: }
4458:
1.854 kalberla 4459: sub blocking_status {
1.1062 raeburn 4460: my ($activity,$uname,$udom,$url) = @_;
1.1061 raeburn 4461: my %setters;
1.890 droeschl 4462:
1.1061 raeburn 4463: # check for active blocking
1.1062 raeburn 4464: my ($startblock,$endblock,$triggerblock) =
4465: &blockcheck(\%setters,$activity,$uname,$udom,$url);
4466: my $blocked = 0;
4467: if ($startblock && $endblock) {
4468: $blocked = 1;
4469: }
1.890 droeschl 4470:
1.1061 raeburn 4471: # caller just wants to know whether a block is active
4472: if (!wantarray) { return $blocked; }
4473:
4474: # build a link to a popup window containing the details
4475: my $querystring = "?activity=$activity";
4476: # $uname and $udom decide whose portfolio the user is trying to look at
1.1062 raeburn 4477: if ($activity eq 'port') {
4478: $querystring .= "&udom=$udom" if $udom;
4479: $querystring .= "&uname=$uname" if $uname;
4480: } elsif ($activity eq 'docs') {
4481: $querystring .= '&url='.&HTML::Entities::encode($url,'&"');
4482: }
1.1061 raeburn 4483:
4484: my $output .= <<'END_MYBLOCK';
4485: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
4486: var options = "width=" + w + ",height=" + h + ",";
4487: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
4488: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
4489: var newWin = window.open(url, wdwName, options);
4490: newWin.focus();
4491: }
1.890 droeschl 4492: END_MYBLOCK
1.854 kalberla 4493:
1.1061 raeburn 4494: $output = Apache::lonhtmlcommon::scripttag($output);
1.890 droeschl 4495:
1.1061 raeburn 4496: my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062 raeburn 4497: my $text = &mt('Communication Blocked');
4498: if ($activity eq 'docs') {
4499: $text = &mt('Content Access Blocked');
1.1063 raeburn 4500: } elsif ($activity eq 'printout') {
4501: $text = &mt('Printing Blocked');
1.1062 raeburn 4502: }
1.1061 raeburn 4503: $output .= <<"END_BLOCK";
1.867 kalberla 4504: <div class='LC_comblock'>
1.869 kalberla 4505: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4506: title='$text'>
4507: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 4508: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4509: title='$text'>$text</a>
1.867 kalberla 4510: </div>
4511:
4512: END_BLOCK
1.474 raeburn 4513:
1.1061 raeburn 4514: return ($blocked, $output);
1.854 kalberla 4515: }
1.490 raeburn 4516:
1.60 matthew 4517: ###############################################
4518:
1.682 raeburn 4519: sub check_ip_acc {
4520: my ($acc)=@_;
4521: &Apache::lonxml::debug("acc is $acc");
4522: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
4523: return 1;
4524: }
4525: my $allowed=0;
4526: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
4527:
4528: my $name;
4529: foreach my $pattern (split(',',$acc)) {
4530: $pattern =~ s/^\s*//;
4531: $pattern =~ s/\s*$//;
4532: if ($pattern =~ /\*$/) {
4533: #35.8.*
4534: $pattern=~s/\*//;
4535: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4536: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
4537: #35.8.3.[34-56]
4538: my $low=$2;
4539: my $high=$3;
4540: $pattern=$1;
4541: if ($ip =~ /^\Q$pattern\E/) {
4542: my $last=(split(/\./,$ip))[3];
4543: if ($last <=$high && $last >=$low) { $allowed=1; }
4544: }
4545: } elsif ($pattern =~ /^\*/) {
4546: #*.msu.edu
4547: $pattern=~s/\*//;
4548: if (!defined($name)) {
4549: use Socket;
4550: my $netaddr=inet_aton($ip);
4551: ($name)=gethostbyaddr($netaddr,AF_INET);
4552: }
4553: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4554: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
4555: #127.0.0.1
4556: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4557: } else {
4558: #some.name.com
4559: if (!defined($name)) {
4560: use Socket;
4561: my $netaddr=inet_aton($ip);
4562: ($name)=gethostbyaddr($netaddr,AF_INET);
4563: }
4564: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4565: }
4566: if ($allowed) { last; }
4567: }
4568: return $allowed;
4569: }
4570:
4571: ###############################################
4572:
1.60 matthew 4573: =pod
4574:
1.112 bowersj2 4575: =head1 Domain Template Functions
4576:
4577: =over 4
4578:
4579: =item * &determinedomain()
1.60 matthew 4580:
4581: Inputs: $domain (usually will be undef)
4582:
1.63 www 4583: Returns: Determines which domain should be used for designs
1.60 matthew 4584:
4585: =cut
1.54 www 4586:
1.60 matthew 4587: ###############################################
1.63 www 4588: sub determinedomain {
4589: my $domain=shift;
1.531 albertel 4590: if (! $domain) {
1.60 matthew 4591: # Determine domain if we have not been given one
1.893 raeburn 4592: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 4593: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
4594: if ($env{'request.role.domain'}) {
4595: $domain=$env{'request.role.domain'};
1.60 matthew 4596: }
4597: }
1.63 www 4598: return $domain;
4599: }
4600: ###############################################
1.517 raeburn 4601:
1.518 albertel 4602: sub devalidate_domconfig_cache {
4603: my ($udom)=@_;
4604: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
4605: }
4606:
4607: # ---------------------- Get domain configuration for a domain
4608: sub get_domainconf {
4609: my ($udom) = @_;
4610: my $cachetime=1800;
4611: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
4612: if (defined($cached)) { return %{$result}; }
4613:
4614: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 4615: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 4616: my (%designhash,%legacy);
1.518 albertel 4617: if (keys(%domconfig) > 0) {
4618: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 4619: if (keys(%{$domconfig{'login'}})) {
4620: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 4621: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.946 raeburn 4622: if ($key eq 'loginvia') {
4623: if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') {
1.1013 raeburn 4624: foreach my $hostname (keys(%{$domconfig{'login'}{'loginvia'}})) {
1.948 raeburn 4625: if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') {
4626: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
4627: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
4628: $designhash{$udom.'.login.loginvia'} = $server;
4629: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
4630:
4631: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
4632: } else {
1.1013 raeburn 4633: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
1.948 raeburn 4634: }
4635: if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) {
4636: $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'};
4637: }
1.946 raeburn 4638: }
4639: }
4640: }
4641: }
4642: } else {
4643: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
4644: $designhash{$udom.'.login.'.$key.'_'.$img} =
4645: $domconfig{'login'}{$key}{$img};
4646: }
1.699 raeburn 4647: }
4648: } else {
4649: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
4650: }
1.632 raeburn 4651: }
4652: } else {
4653: $legacy{'login'} = 1;
1.518 albertel 4654: }
1.632 raeburn 4655: } else {
4656: $legacy{'login'} = 1;
1.518 albertel 4657: }
4658: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 4659: if (keys(%{$domconfig{'rolecolors'}})) {
4660: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
4661: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
4662: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
4663: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
4664: }
1.518 albertel 4665: }
4666: }
1.632 raeburn 4667: } else {
4668: $legacy{'rolecolors'} = 1;
1.518 albertel 4669: }
1.632 raeburn 4670: } else {
4671: $legacy{'rolecolors'} = 1;
1.518 albertel 4672: }
1.948 raeburn 4673: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
4674: if ($domconfig{'autoenroll'}{'co-owners'}) {
4675: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
4676: }
4677: }
1.632 raeburn 4678: if (keys(%legacy) > 0) {
4679: my %legacyhash = &get_legacy_domconf($udom);
4680: foreach my $item (keys(%legacyhash)) {
4681: if ($item =~ /^\Q$udom\E\.login/) {
4682: if ($legacy{'login'}) {
4683: $designhash{$item} = $legacyhash{$item};
4684: }
4685: } else {
4686: if ($legacy{'rolecolors'}) {
4687: $designhash{$item} = $legacyhash{$item};
4688: }
1.518 albertel 4689: }
4690: }
4691: }
1.632 raeburn 4692: } else {
4693: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4694: }
4695: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4696: $cachetime);
4697: return %designhash;
4698: }
4699:
1.632 raeburn 4700: sub get_legacy_domconf {
4701: my ($udom) = @_;
4702: my %legacyhash;
4703: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4704: my $designfile = $designdir.'/'.$udom.'.tab';
4705: if (-e $designfile) {
4706: if ( open (my $fh,"<$designfile") ) {
4707: while (my $line = <$fh>) {
4708: next if ($line =~ /^\#/);
4709: chomp($line);
4710: my ($key,$val)=(split(/\=/,$line));
4711: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4712: }
4713: close($fh);
4714: }
4715: }
1.1026 raeburn 4716: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632 raeburn 4717: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4718: }
4719: return %legacyhash;
4720: }
4721:
1.63 www 4722: =pod
4723:
1.112 bowersj2 4724: =item * &domainlogo()
1.63 www 4725:
4726: Inputs: $domain (usually will be undef)
4727:
4728: Returns: A link to a domain logo, if the domain logo exists.
4729: If the domain logo does not exist, a description of the domain.
4730:
4731: =cut
1.112 bowersj2 4732:
1.63 www 4733: ###############################################
4734: sub domainlogo {
1.517 raeburn 4735: my $domain = &determinedomain(shift);
1.518 albertel 4736: my %designhash = &get_domainconf($domain);
1.517 raeburn 4737: # See if there is a logo
4738: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4739: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4740: if ($imgsrc =~ m{^/(adm|res)/}) {
4741: if ($imgsrc =~ m{^/res/}) {
4742: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4743: &Apache::lonnet::repcopy($local_name);
4744: }
4745: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4746: }
4747: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4748: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4749: return &Apache::lonnet::domain($domain,'description');
1.59 www 4750: } else {
1.60 matthew 4751: return '';
1.59 www 4752: }
4753: }
1.63 www 4754: ##############################################
4755:
4756: =pod
4757:
1.112 bowersj2 4758: =item * &designparm()
1.63 www 4759:
4760: Inputs: $which parameter; $domain (usually will be undef)
4761:
4762: Returns: value of designparamter $which
4763:
4764: =cut
1.112 bowersj2 4765:
1.397 albertel 4766:
1.400 albertel 4767: ##############################################
1.397 albertel 4768: sub designparm {
4769: my ($which,$domain)=@_;
4770: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 4771: return $env{'environment.color.'.$which};
1.96 www 4772: }
1.63 www 4773: $domain=&determinedomain($domain);
1.1016 raeburn 4774: my %domdesign;
4775: unless ($domain eq 'public') {
4776: %domdesign = &get_domainconf($domain);
4777: }
1.520 raeburn 4778: my $output;
1.517 raeburn 4779: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 4780: $output = $domdesign{$domain.'.'.$which};
1.63 www 4781: } else {
1.520 raeburn 4782: $output = $defaultdesign{$which};
4783: }
4784: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4785: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4786: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 4787: if ($output =~ m{^/res/}) {
4788: my $local_name = &Apache::lonnet::filelocation('',$output);
4789: &Apache::lonnet::repcopy($local_name);
4790: }
1.520 raeburn 4791: $output = &lonhttpdurl($output);
4792: }
1.63 www 4793: }
1.520 raeburn 4794: return $output;
1.63 www 4795: }
1.59 www 4796:
1.822 bisitz 4797: ##############################################
4798: =pod
4799:
1.832 bisitz 4800: =item * &authorspace()
4801:
1.1028 raeburn 4802: Inputs: $url (usually will be undef).
1.832 bisitz 4803:
1.1028 raeburn 4804: Returns: Path to Construction Space containing the resource or
4805: directory being viewed (or for which action is being taken).
4806: If $url is provided, and begins /priv/<domain>/<uname>
4807: the path will be that portion of the $context argument.
4808: Otherwise the path will be for the author space of the current
4809: user when the current role is author, or for that of the
4810: co-author/assistant co-author space when the current role
4811: is co-author or assistant co-author.
1.832 bisitz 4812:
4813: =cut
4814:
4815: sub authorspace {
1.1028 raeburn 4816: my ($url) = @_;
4817: if ($url ne '') {
4818: if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
4819: return $1;
4820: }
4821: }
1.832 bisitz 4822: my $caname = '';
1.1024 www 4823: my $cadom = '';
1.1028 raeburn 4824: if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024 www 4825: ($cadom,$caname) =
1.832 bisitz 4826: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028 raeburn 4827: } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832 bisitz 4828: $caname = $env{'user.name'};
1.1024 www 4829: $cadom = $env{'user.domain'};
1.832 bisitz 4830: }
1.1028 raeburn 4831: if (($caname ne '') && ($cadom ne '')) {
4832: return "/priv/$cadom/$caname/";
4833: }
4834: return;
1.832 bisitz 4835: }
4836:
4837: ##############################################
4838: =pod
4839:
1.822 bisitz 4840: =item * &head_subbox()
4841:
4842: Inputs: $content (contains HTML code with page functions, etc.)
4843:
4844: Returns: HTML div with $content
4845: To be included in page header
4846:
4847: =cut
4848:
4849: sub head_subbox {
4850: my ($content)=@_;
4851: my $output =
1.993 raeburn 4852: '<div class="LC_head_subbox">'
1.822 bisitz 4853: .$content
4854: .'</div>'
4855: }
4856:
4857: ##############################################
4858: =pod
4859:
4860: =item * &CSTR_pageheader()
4861:
1.1026 raeburn 4862: Input: (optional) filename from which breadcrumb trail is built.
4863: In most cases no input as needed, as $env{'request.filename'}
4864: is appropriate for use in building the breadcrumb trail.
1.822 bisitz 4865:
4866: Returns: HTML div with CSTR path and recent box
4867: To be included on Construction Space pages
4868:
4869: =cut
4870:
4871: sub CSTR_pageheader {
1.1026 raeburn 4872: my ($trailfile) = @_;
4873: if ($trailfile eq '') {
4874: $trailfile = $env{'request.filename'};
4875: }
4876:
4877: # this is for resources; directories have customtitle, and crumbs
4878: # and select recent are created in lonpubdir.pm
4879:
4880: my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022 www 4881: my ($udom,$uname,$thisdisfn)=
1.1026 raeburn 4882: ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)/(.*)$});
4883: my $formaction = "/priv/$udom/$uname/$thisdisfn";
4884: $formaction =~ s{/+}{/}g;
1.822 bisitz 4885:
4886: my $parentpath = '';
4887: my $lastitem = '';
4888: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4889: $parentpath = $1;
4890: $lastitem = $2;
4891: } else {
4892: $lastitem = $thisdisfn;
4893: }
1.921 bisitz 4894:
4895: my $output =
1.822 bisitz 4896: '<div>'
4897: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
4898: .'<b>'.&mt('Construction Space:').'</b> '
4899: .'<form name="dirs" method="post" action="'.$formaction
1.921 bisitz 4900: .'" target="_top">' #FIXME lonpubdir: target="_parent"
1.1024 www 4901: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv/'.$udom,undef,undef);
1.921 bisitz 4902:
4903: if ($lastitem) {
4904: $output .=
4905: '<span class="LC_filename">'
4906: .$lastitem
4907: .'</span>';
4908: }
4909: $output .=
4910: '<br />'
1.822 bisitz 4911: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
4912: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4913: .'</form>'
4914: .&Apache::lonmenu::constspaceform()
4915: .'</div>';
1.921 bisitz 4916:
4917: return $output;
1.822 bisitz 4918: }
4919:
1.60 matthew 4920: ###############################################
4921: ###############################################
4922:
4923: =pod
4924:
1.112 bowersj2 4925: =back
4926:
1.549 albertel 4927: =head1 HTML Helpers
1.112 bowersj2 4928:
4929: =over 4
4930:
4931: =item * &bodytag()
1.60 matthew 4932:
4933: Returns a uniform header for LON-CAPA web pages.
4934:
4935: Inputs:
4936:
1.112 bowersj2 4937: =over 4
4938:
4939: =item * $title, A title to be displayed on the page.
4940:
4941: =item * $function, the current role (can be undef).
4942:
4943: =item * $addentries, extra parameters for the <body> tag.
4944:
4945: =item * $bodyonly, if defined, only return the <body> tag.
4946:
4947: =item * $domain, if defined, force a given domain.
4948:
4949: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4950: text interface only)
1.60 matthew 4951:
1.814 bisitz 4952: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
4953: navigational links
1.317 albertel 4954:
1.338 albertel 4955: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4956:
1.460 albertel 4957: =item * $args, optional argument valid values are
4958: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4959: inherit_jsmath -> when creating popup window in a page,
4960: should it have jsmath forced on by the
4961: current page
1.460 albertel 4962:
1.112 bowersj2 4963: =back
4964:
1.60 matthew 4965: Returns: A uniform header for LON-CAPA web pages.
4966: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4967: If $bodyonly is undef or zero, an html string containing a <body> tag and
4968: other decorations will be returned.
4969:
4970: =cut
4971:
1.54 www 4972: sub bodytag {
1.831 bisitz 4973: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.962 droeschl 4974: $no_nav_bar,$bgcolor,$args)=@_;
1.339 albertel 4975:
1.954 raeburn 4976: my $public;
4977: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
4978: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
4979: $public = 1;
4980: }
1.460 albertel 4981: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4982:
1.183 matthew 4983: $function = &get_users_function() if (!$function);
1.339 albertel 4984: my $img = &designparm($function.'.img',$domain);
4985: my $font = &designparm($function.'.font',$domain);
4986: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4987:
1.803 bisitz 4988: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 4989: 'bgcolor' => $pgbg,
1.339 albertel 4990: 'text' => $font,
4991: 'alink' => &designparm($function.'.alink',$domain),
4992: 'vlink' => &designparm($function.'.vlink',$domain),
4993: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4994: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4995:
1.63 www 4996: # role and realm
1.378 raeburn 4997: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4998: if ($role eq 'ca') {
1.479 albertel 4999: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 5000: $realm = &plainname($rname,$rdom);
1.378 raeburn 5001: }
1.55 www 5002: # realm
1.258 albertel 5003: if ($env{'request.course.id'}) {
1.378 raeburn 5004: if ($env{'request.role'} !~ /^cr/) {
5005: $role = &Apache::lonnet::plaintext($role,&course_type());
5006: }
1.898 raeburn 5007: if ($env{'request.course.sec'}) {
5008: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
5009: }
1.359 albertel 5010: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 5011: } else {
5012: $role = &Apache::lonnet::plaintext($role);
1.54 www 5013: }
1.433 albertel 5014:
1.359 albertel 5015: if (!$realm) { $realm=' '; }
1.330 albertel 5016:
1.438 albertel 5017: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 5018:
1.101 www 5019: # construct main body tag
1.359 albertel 5020: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 5021: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 5022:
1.530 albertel 5023: if ($bodyonly) {
1.60 matthew 5024: return $bodytag;
1.798 tempelho 5025: }
1.359 albertel 5026:
1.410 albertel 5027: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.954 raeburn 5028: if ($public) {
1.433 albertel 5029: undef($role);
1.434 albertel 5030: } else {
1.1070 raeburn 5031: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'},
5032: undef,'LC_menubuttons_link');
1.433 albertel 5033: }
1.359 albertel 5034:
1.762 bisitz 5035: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 5036: #
5037: # Extra info if you are the DC
5038: my $dc_info = '';
5039: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
5040: $env{'course.'.$env{'request.course.id'}.
5041: '.domain'}.'/'})) {
5042: my $cid = $env{'request.course.id'};
1.917 raeburn 5043: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 5044: $dc_info =~ s/\s+$//;
1.359 albertel 5045: }
5046:
1.898 raeburn 5047: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853 droeschl 5048: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
5049:
1.916 droeschl 5050: if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') {
5051: return $bodytag;
5052: }
1.903 droeschl 5053:
5054: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
5055:
5056: # if ($env{'request.state'} eq 'construct') {
5057: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
5058: # }
5059:
1.359 albertel 5060:
5061:
1.916 droeschl 5062: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917 raeburn 5063: if ($dc_info) {
5064: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
5065: }
1.916 droeschl 5066: $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
5067: <em>$realm</em> $dc_info</div>|;
1.903 droeschl 5068: return $bodytag;
5069: }
1.894 droeschl 5070:
1.927 raeburn 5071: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
5072: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
5073: }
1.916 droeschl 5074:
1.903 droeschl 5075: $bodytag .= Apache::lonhtmlcommon::scripttag(
5076: Apache::lonmenu::utilityfunctions(), 'start');
1.816 bisitz 5077:
1.903 droeschl 5078: $bodytag .= Apache::lonmenu::primary_menu();
1.852 droeschl 5079:
1.917 raeburn 5080: if ($dc_info) {
5081: $dc_info = &dc_courseid_toggle($dc_info);
5082: }
5083: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 5084:
1.903 droeschl 5085: #don't show menus for public users
1.954 raeburn 5086: if (!$public){
1.903 droeschl 5087: $bodytag .= Apache::lonmenu::secondary_menu();
5088: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 5089: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
5090: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 5091: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.920 raeburn 5092: $args->{'bread_crumbs'});
5093: } elsif ($forcereg) {
5094: $bodytag .= &Apache::lonmenu::innerregister($forcereg);
5095: }
1.903 droeschl 5096: }else{
5097: # this is to seperate menu from content when there's no secondary
5098: # menu. Especially needed for public accessible ressources.
5099: $bodytag .= '<hr style="clear:both" />';
5100: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 5101: }
1.903 droeschl 5102:
1.235 raeburn 5103: return $bodytag;
1.182 matthew 5104: }
5105:
1.917 raeburn 5106: sub dc_courseid_toggle {
5107: my ($dc_info) = @_;
1.980 raeburn 5108: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069 raeburn 5109: '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917 raeburn 5110: &mt('(More ...)').'</a></span>'.
5111: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
5112: }
5113:
1.330 albertel 5114: sub make_attr_string {
5115: my ($register,$attr_ref) = @_;
5116:
5117: if ($attr_ref && !ref($attr_ref)) {
5118: die("addentries Must be a hash ref ".
5119: join(':',caller(1))." ".
5120: join(':',caller(0))." ");
5121: }
5122:
5123: if ($register) {
1.339 albertel 5124: my ($on_load,$on_unload);
5125: foreach my $key (keys(%{$attr_ref})) {
5126: if (lc($key) eq 'onload') {
5127: $on_load.=$attr_ref->{$key}.';';
5128: delete($attr_ref->{$key});
5129:
5130: } elsif (lc($key) eq 'onunload') {
5131: $on_unload.=$attr_ref->{$key}.';';
5132: delete($attr_ref->{$key});
5133: }
5134: }
1.953 droeschl 5135: $attr_ref->{'onload'} = $on_load;
5136: $attr_ref->{'onunload'}= $on_unload;
1.330 albertel 5137: }
1.339 albertel 5138:
1.330 albertel 5139: my $attr_string;
5140: foreach my $attr (keys(%$attr_ref)) {
5141: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
5142: }
5143: return $attr_string;
5144: }
5145:
5146:
1.182 matthew 5147: ###############################################
1.251 albertel 5148: ###############################################
5149:
5150: =pod
5151:
5152: =item * &endbodytag()
5153:
5154: Returns a uniform footer for LON-CAPA web pages.
5155:
1.635 raeburn 5156: Inputs: 1 - optional reference to an args hash
5157: If in the hash, key for noredirectlink has a value which evaluates to true,
5158: a 'Continue' link is not displayed if the page contains an
5159: internal redirect in the <head></head> section,
5160: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 5161:
5162: =cut
5163:
5164: sub endbodytag {
1.635 raeburn 5165: my ($args) = @_;
1.251 albertel 5166: my $endbodytag='</body>';
1.269 albertel 5167: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 5168: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 5169: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
5170: $endbodytag=
5171: "<br /><a href=\"$env{'internal.head.redirect'}\">".
5172: &mt('Continue').'</a>'.
5173: $endbodytag;
5174: }
1.315 albertel 5175: }
1.251 albertel 5176: return $endbodytag;
5177: }
5178:
1.352 albertel 5179: =pod
5180:
5181: =item * &standard_css()
5182:
5183: Returns a style sheet
5184:
5185: Inputs: (all optional)
5186: domain -> force to color decorate a page for a specific
5187: domain
5188: function -> force usage of a specific rolish color scheme
5189: bgcolor -> override the default page bgcolor
5190:
5191: =cut
5192:
1.343 albertel 5193: sub standard_css {
1.345 albertel 5194: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 5195: $function = &get_users_function() if (!$function);
5196: my $img = &designparm($function.'.img', $domain);
5197: my $tabbg = &designparm($function.'.tabbg', $domain);
5198: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 5199: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 5200: #second colour for later usage
1.345 albertel 5201: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 5202: my $pgbg_or_bgcolor =
5203: $bgcolor ||
1.352 albertel 5204: &designparm($function.'.pgbg', $domain);
1.382 albertel 5205: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 5206: my $alink = &designparm($function.'.alink', $domain);
5207: my $vlink = &designparm($function.'.vlink', $domain);
5208: my $link = &designparm($function.'.link', $domain);
5209:
1.602 albertel 5210: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 5211: my $mono = 'monospace';
1.850 bisitz 5212: my $data_table_head = $sidebg;
5213: my $data_table_light = '#FAFAFA';
1.1060 bisitz 5214: my $data_table_dark = '#E0E0E0';
1.470 banghart 5215: my $data_table_darker = '#CCCCCC';
1.349 albertel 5216: my $data_table_highlight = '#FFFF00';
1.352 albertel 5217: my $mail_new = '#FFBB77';
5218: my $mail_new_hover = '#DD9955';
5219: my $mail_read = '#BBBB77';
5220: my $mail_read_hover = '#999944';
5221: my $mail_replied = '#AAAA88';
5222: my $mail_replied_hover = '#888855';
5223: my $mail_other = '#99BBBB';
5224: my $mail_other_hover = '#669999';
1.391 albertel 5225: my $table_header = '#DDDDDD';
1.489 raeburn 5226: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 5227: my $lg_border_color = '#C8C8C8';
1.952 onken 5228: my $button_hover = '#BF2317';
1.392 albertel 5229:
1.608 albertel 5230: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 5231: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
5232: : '0 3px 0 4px';
1.448 albertel 5233:
1.523 albertel 5234:
1.343 albertel 5235: return <<END;
1.947 droeschl 5236:
5237: /* needed for iframe to allow 100% height in FF */
5238: body, html {
5239: margin: 0;
5240: padding: 0 0.5%;
5241: height: 99%; /* to avoid scrollbars */
5242: }
5243:
1.795 www 5244: body {
1.911 bisitz 5245: font-family: $sans;
5246: line-height:130%;
5247: font-size:0.83em;
5248: color:$font;
1.795 www 5249: }
5250:
1.959 onken 5251: a:focus,
5252: a:focus img {
1.795 www 5253: color: red;
5254: }
1.698 harmsja 5255:
1.911 bisitz 5256: form, .inline {
5257: display: inline;
1.795 www 5258: }
1.721 harmsja 5259:
1.795 www 5260: .LC_right {
1.911 bisitz 5261: text-align:right;
1.795 www 5262: }
5263:
5264: .LC_middle {
1.911 bisitz 5265: vertical-align:middle;
1.795 www 5266: }
1.721 harmsja 5267:
1.911 bisitz 5268: .LC_400Box {
5269: width:400px;
5270: }
1.721 harmsja 5271:
1.947 droeschl 5272: .LC_iframecontainer {
5273: width: 98%;
5274: margin: 0;
5275: position: fixed;
5276: top: 8.5em;
5277: bottom: 0;
5278: }
5279:
5280: .LC_iframecontainer iframe{
5281: border: none;
5282: width: 100%;
5283: height: 100%;
5284: }
5285:
1.778 bisitz 5286: .LC_filename {
5287: font-family: $mono;
5288: white-space:pre;
1.921 bisitz 5289: font-size: 120%;
1.778 bisitz 5290: }
5291:
5292: .LC_fileicon {
5293: border: none;
5294: height: 1.3em;
5295: vertical-align: text-bottom;
5296: margin-right: 0.3em;
5297: text-decoration:none;
5298: }
5299:
1.1008 www 5300: .LC_setting {
5301: text-decoration:underline;
5302: }
5303:
1.350 albertel 5304: .LC_error {
5305: color: red;
5306: font-size: larger;
5307: }
1.795 www 5308:
1.457 albertel 5309: .LC_warning,
5310: .LC_diff_removed {
1.733 bisitz 5311: color: red;
1.394 albertel 5312: }
1.532 albertel 5313:
5314: .LC_info,
1.457 albertel 5315: .LC_success,
5316: .LC_diff_added {
1.350 albertel 5317: color: green;
5318: }
1.795 www 5319:
1.802 bisitz 5320: div.LC_confirm_box {
5321: background-color: #FAFAFA;
5322: border: 1px solid $lg_border_color;
5323: margin-right: 0;
5324: padding: 5px;
5325: }
5326:
5327: div.LC_confirm_box .LC_error img,
5328: div.LC_confirm_box .LC_success img {
5329: vertical-align: middle;
5330: }
5331:
1.440 albertel 5332: .LC_icon {
1.771 droeschl 5333: border: none;
1.790 droeschl 5334: vertical-align: middle;
1.771 droeschl 5335: }
5336:
1.543 albertel 5337: .LC_docs_spacer {
5338: width: 25px;
5339: height: 1px;
1.771 droeschl 5340: border: none;
1.543 albertel 5341: }
1.346 albertel 5342:
1.532 albertel 5343: .LC_internal_info {
1.735 bisitz 5344: color: #999999;
1.532 albertel 5345: }
5346:
1.794 www 5347: .LC_discussion {
1.1050 www 5348: background: $data_table_dark;
1.911 bisitz 5349: border: 1px solid black;
5350: margin: 2px;
1.794 www 5351: }
5352:
5353: .LC_disc_action_left {
1.1050 www 5354: background: $sidebg;
1.911 bisitz 5355: text-align: left;
1.1050 www 5356: padding: 4px;
5357: margin: 2px;
1.794 www 5358: }
5359:
5360: .LC_disc_action_right {
1.1050 www 5361: background: $sidebg;
1.911 bisitz 5362: text-align: right;
1.1050 www 5363: padding: 4px;
5364: margin: 2px;
1.794 www 5365: }
5366:
5367: .LC_disc_new_item {
1.911 bisitz 5368: background: white;
5369: border: 2px solid red;
1.1050 www 5370: margin: 4px;
5371: padding: 4px;
1.794 www 5372: }
5373:
5374: .LC_disc_old_item {
1.911 bisitz 5375: background: white;
1.1050 www 5376: margin: 4px;
5377: padding: 4px;
1.794 www 5378: }
5379:
1.458 albertel 5380: table.LC_pastsubmission {
5381: border: 1px solid black;
5382: margin: 2px;
5383: }
5384:
1.924 bisitz 5385: table#LC_menubuttons {
1.345 albertel 5386: width: 100%;
5387: background: $pgbg;
1.392 albertel 5388: border: 2px;
1.402 albertel 5389: border-collapse: separate;
1.803 bisitz 5390: padding: 0;
1.345 albertel 5391: }
1.392 albertel 5392:
1.801 tempelho 5393: table#LC_title_bar a {
5394: color: $fontmenu;
5395: }
1.836 bisitz 5396:
1.807 droeschl 5397: table#LC_title_bar {
1.819 tempelho 5398: clear: both;
1.836 bisitz 5399: display: none;
1.807 droeschl 5400: }
5401:
1.795 www 5402: table#LC_title_bar,
1.933 droeschl 5403: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 5404: table#LC_title_bar.LC_with_remote {
1.359 albertel 5405: width: 100%;
1.392 albertel 5406: border-color: $pgbg;
5407: border-style: solid;
5408: border-width: $border;
1.379 albertel 5409: background: $pgbg;
1.801 tempelho 5410: color: $fontmenu;
1.392 albertel 5411: border-collapse: collapse;
1.803 bisitz 5412: padding: 0;
1.819 tempelho 5413: margin: 0;
1.359 albertel 5414: }
1.795 www 5415:
1.933 droeschl 5416: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 5417: margin: 0;
5418: padding: 0;
1.933 droeschl 5419: position: relative;
5420: list-style: none;
1.913 droeschl 5421: }
1.933 droeschl 5422: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 5423: display: inline;
5424: }
1.933 droeschl 5425:
5426: .LC_breadcrumb_tools_navigation {
1.913 droeschl 5427: padding: 0;
1.933 droeschl 5428: margin: 0;
5429: float: left;
1.913 droeschl 5430: }
1.933 droeschl 5431: .LC_breadcrumb_tools_tools {
5432: padding: 0;
5433: margin: 0;
1.913 droeschl 5434: float: right;
5435: }
5436:
1.359 albertel 5437: table#LC_title_bar td {
5438: background: $tabbg;
5439: }
1.795 www 5440:
1.911 bisitz 5441: table#LC_menubuttons img {
1.803 bisitz 5442: border: none;
1.346 albertel 5443: }
1.795 www 5444:
1.842 droeschl 5445: .LC_breadcrumbs_component {
1.911 bisitz 5446: float: right;
5447: margin: 0 1em;
1.357 albertel 5448: }
1.842 droeschl 5449: .LC_breadcrumbs_component img {
1.911 bisitz 5450: vertical-align: middle;
1.777 tempelho 5451: }
1.795 www 5452:
1.383 albertel 5453: td.LC_table_cell_checkbox {
5454: text-align: center;
5455: }
1.795 www 5456:
5457: .LC_fontsize_small {
1.911 bisitz 5458: font-size: 70%;
1.705 tempelho 5459: }
5460:
1.844 bisitz 5461: #LC_breadcrumbs {
1.911 bisitz 5462: clear:both;
5463: background: $sidebg;
5464: border-bottom: 1px solid $lg_border_color;
5465: line-height: 2.5em;
1.933 droeschl 5466: overflow: hidden;
1.911 bisitz 5467: margin: 0;
5468: padding: 0;
1.995 raeburn 5469: text-align: left;
1.819 tempelho 5470: }
1.862 bisitz 5471:
1.993 raeburn 5472: .LC_head_subbox {
1.911 bisitz 5473: clear:both;
5474: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 5475: border: 1px solid $sidebg;
5476: margin: 0 0 10px 0;
1.966 bisitz 5477: padding: 3px;
1.995 raeburn 5478: text-align: left;
1.822 bisitz 5479: }
5480:
1.795 www 5481: .LC_fontsize_medium {
1.911 bisitz 5482: font-size: 85%;
1.705 tempelho 5483: }
5484:
1.795 www 5485: .LC_fontsize_large {
1.911 bisitz 5486: font-size: 120%;
1.705 tempelho 5487: }
5488:
1.346 albertel 5489: .LC_menubuttons_inline_text {
5490: color: $font;
1.698 harmsja 5491: font-size: 90%;
1.701 harmsja 5492: padding-left:3px;
1.346 albertel 5493: }
5494:
1.934 droeschl 5495: .LC_menubuttons_inline_text img{
5496: vertical-align: middle;
5497: }
5498:
1.1051 www 5499: li.LC_menubuttons_inline_text img {
1.951 onken 5500: cursor:pointer;
1.1002 droeschl 5501: text-decoration: none;
1.951 onken 5502: }
5503:
1.526 www 5504: .LC_menubuttons_link {
5505: text-decoration: none;
5506: }
1.795 www 5507:
1.522 albertel 5508: .LC_menubuttons_category {
1.521 www 5509: color: $font;
1.526 www 5510: background: $pgbg;
1.521 www 5511: font-size: larger;
5512: font-weight: bold;
5513: }
5514:
1.346 albertel 5515: td.LC_menubuttons_text {
1.911 bisitz 5516: color: $font;
1.346 albertel 5517: }
1.706 harmsja 5518:
1.346 albertel 5519: .LC_current_location {
5520: background: $tabbg;
5521: }
1.795 www 5522:
1.938 bisitz 5523: table.LC_data_table {
1.347 albertel 5524: border: 1px solid #000000;
1.402 albertel 5525: border-collapse: separate;
1.426 albertel 5526: border-spacing: 1px;
1.610 albertel 5527: background: $pgbg;
1.347 albertel 5528: }
1.795 www 5529:
1.422 albertel 5530: .LC_data_table_dense {
5531: font-size: small;
5532: }
1.795 www 5533:
1.507 raeburn 5534: table.LC_nested_outer {
5535: border: 1px solid #000000;
1.589 raeburn 5536: border-collapse: collapse;
1.803 bisitz 5537: border-spacing: 0;
1.507 raeburn 5538: width: 100%;
5539: }
1.795 www 5540:
1.879 raeburn 5541: table.LC_innerpickbox,
1.507 raeburn 5542: table.LC_nested {
1.803 bisitz 5543: border: none;
1.589 raeburn 5544: border-collapse: collapse;
1.803 bisitz 5545: border-spacing: 0;
1.507 raeburn 5546: width: 100%;
5547: }
1.795 www 5548:
1.911 bisitz 5549: table.LC_data_table tr th,
5550: table.LC_calendar tr th,
1.879 raeburn 5551: table.LC_prior_tries tr th,
5552: table.LC_innerpickbox tr th {
1.349 albertel 5553: font-weight: bold;
5554: background-color: $data_table_head;
1.801 tempelho 5555: color:$fontmenu;
1.701 harmsja 5556: font-size:90%;
1.347 albertel 5557: }
1.795 www 5558:
1.879 raeburn 5559: table.LC_innerpickbox tr th,
5560: table.LC_innerpickbox tr td {
5561: vertical-align: top;
5562: }
5563:
1.711 raeburn 5564: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 5565: background-color: #CCCCCC;
1.711 raeburn 5566: font-weight: bold;
5567: text-align: left;
5568: }
1.795 www 5569:
1.912 bisitz 5570: table.LC_data_table tr.LC_odd_row > td {
5571: background-color: $data_table_light;
5572: padding: 2px;
5573: vertical-align: top;
5574: }
5575:
1.809 bisitz 5576: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 5577: background-color: $data_table_light;
1.912 bisitz 5578: vertical-align: top;
5579: }
5580:
5581: table.LC_data_table tr.LC_even_row > td {
5582: background-color: $data_table_dark;
1.425 albertel 5583: padding: 2px;
1.900 bisitz 5584: vertical-align: top;
1.347 albertel 5585: }
1.795 www 5586:
1.809 bisitz 5587: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 5588: background-color: $data_table_dark;
1.900 bisitz 5589: vertical-align: top;
1.347 albertel 5590: }
1.795 www 5591:
1.425 albertel 5592: table.LC_data_table tr.LC_data_table_highlight td {
5593: background-color: $data_table_darker;
5594: }
1.795 www 5595:
1.639 raeburn 5596: table.LC_data_table tr td.LC_leftcol_header {
5597: background-color: $data_table_head;
5598: font-weight: bold;
5599: }
1.795 www 5600:
1.451 albertel 5601: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5602: table.LC_nested tr.LC_empty_row td {
1.421 albertel 5603: font-weight: bold;
5604: font-style: italic;
5605: text-align: center;
5606: padding: 8px;
1.347 albertel 5607: }
1.795 www 5608:
1.940 bisitz 5609: table.LC_data_table tr.LC_empty_row td {
5610: background-color: $sidebg;
5611: }
5612:
5613: table.LC_nested tr.LC_empty_row td {
5614: background-color: #FFFFFF;
5615: }
5616:
1.890 droeschl 5617: table.LC_caption {
5618: }
5619:
1.507 raeburn 5620: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5621: padding: 4ex
5622: }
1.795 www 5623:
1.507 raeburn 5624: table.LC_nested_outer tr th {
5625: font-weight: bold;
1.801 tempelho 5626: color:$fontmenu;
1.507 raeburn 5627: background-color: $data_table_head;
1.701 harmsja 5628: font-size: small;
1.507 raeburn 5629: border-bottom: 1px solid #000000;
5630: }
1.795 www 5631:
1.507 raeburn 5632: table.LC_nested_outer tr td.LC_subheader {
5633: background-color: $data_table_head;
5634: font-weight: bold;
5635: font-size: small;
5636: border-bottom: 1px solid #000000;
5637: text-align: right;
1.451 albertel 5638: }
1.795 www 5639:
1.507 raeburn 5640: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5641: background-color: #CCCCCC;
1.451 albertel 5642: font-weight: bold;
5643: font-size: small;
1.507 raeburn 5644: text-align: center;
5645: }
1.795 www 5646:
1.589 raeburn 5647: table.LC_nested tr.LC_info_row td.LC_left_item,
5648: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5649: text-align: left;
1.451 albertel 5650: }
1.795 www 5651:
1.507 raeburn 5652: table.LC_nested td {
1.735 bisitz 5653: background-color: #FFFFFF;
1.451 albertel 5654: font-size: small;
1.507 raeburn 5655: }
1.795 www 5656:
1.507 raeburn 5657: table.LC_nested_outer tr th.LC_right_item,
5658: table.LC_nested tr.LC_info_row td.LC_right_item,
5659: table.LC_nested tr.LC_odd_row td.LC_right_item,
5660: table.LC_nested tr td.LC_right_item {
1.451 albertel 5661: text-align: right;
5662: }
5663:
1.507 raeburn 5664: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5665: background-color: #EEEEEE;
1.451 albertel 5666: }
5667:
1.473 raeburn 5668: table.LC_createuser {
5669: }
5670:
5671: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5672: font-size: small;
1.473 raeburn 5673: }
5674:
5675: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5676: background-color: #CCCCCC;
1.473 raeburn 5677: font-weight: bold;
5678: text-align: center;
5679: }
5680:
1.349 albertel 5681: table.LC_calendar {
5682: border: 1px solid #000000;
5683: border-collapse: collapse;
1.917 raeburn 5684: width: 98%;
1.349 albertel 5685: }
1.795 www 5686:
1.349 albertel 5687: table.LC_calendar_pickdate {
5688: font-size: xx-small;
5689: }
1.795 www 5690:
1.349 albertel 5691: table.LC_calendar tr td {
5692: border: 1px solid #000000;
5693: vertical-align: top;
1.917 raeburn 5694: width: 14%;
1.349 albertel 5695: }
1.795 www 5696:
1.349 albertel 5697: table.LC_calendar tr td.LC_calendar_day_empty {
5698: background-color: $data_table_dark;
5699: }
1.795 www 5700:
1.779 bisitz 5701: table.LC_calendar tr td.LC_calendar_day_current {
5702: background-color: $data_table_highlight;
1.777 tempelho 5703: }
1.795 www 5704:
1.938 bisitz 5705: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 5706: background-color: $mail_new;
5707: }
1.795 www 5708:
1.938 bisitz 5709: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 5710: background-color: $mail_new_hover;
5711: }
1.795 www 5712:
1.938 bisitz 5713: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 5714: background-color: $mail_read;
5715: }
1.795 www 5716:
1.938 bisitz 5717: /*
5718: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 5719: background-color: $mail_read_hover;
5720: }
1.938 bisitz 5721: */
1.795 www 5722:
1.938 bisitz 5723: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 5724: background-color: $mail_replied;
5725: }
1.795 www 5726:
1.938 bisitz 5727: /*
5728: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 5729: background-color: $mail_replied_hover;
5730: }
1.938 bisitz 5731: */
1.795 www 5732:
1.938 bisitz 5733: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 5734: background-color: $mail_other;
5735: }
1.795 www 5736:
1.938 bisitz 5737: /*
5738: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 5739: background-color: $mail_other_hover;
5740: }
1.938 bisitz 5741: */
1.494 raeburn 5742:
1.777 tempelho 5743: table.LC_data_table tr > td.LC_browser_file,
5744: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 5745: background: #AAEE77;
1.389 albertel 5746: }
1.795 www 5747:
1.777 tempelho 5748: table.LC_data_table tr > td.LC_browser_file_locked,
5749: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5750: background: #FFAA99;
1.387 albertel 5751: }
1.795 www 5752:
1.777 tempelho 5753: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 5754: background: #888888;
1.779 bisitz 5755: }
1.795 www 5756:
1.777 tempelho 5757: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5758: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 5759: background: #F8F866;
1.777 tempelho 5760: }
1.795 www 5761:
1.696 bisitz 5762: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 5763: background: #E0E8FF;
1.387 albertel 5764: }
1.696 bisitz 5765:
1.707 bisitz 5766: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 5767: /* background: #77FF77; */
1.707 bisitz 5768: }
1.795 www 5769:
1.707 bisitz 5770: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 5771: border-right: 8px solid #FFFF77;
1.707 bisitz 5772: }
1.795 www 5773:
1.707 bisitz 5774: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 5775: border-right: 8px solid #FFAA77;
1.707 bisitz 5776: }
1.795 www 5777:
1.707 bisitz 5778: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 5779: border-right: 8px solid #FF7777;
1.707 bisitz 5780: }
1.795 www 5781:
1.707 bisitz 5782: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 5783: border-right: 8px solid #AAFF77;
1.707 bisitz 5784: }
1.795 www 5785:
1.707 bisitz 5786: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 5787: border-right: 8px solid #11CC55;
1.707 bisitz 5788: }
5789:
1.388 albertel 5790: span.LC_current_location {
1.701 harmsja 5791: font-size:larger;
1.388 albertel 5792: background: $pgbg;
5793: }
1.387 albertel 5794:
1.1029 www 5795: span.LC_current_nav_location {
5796: font-weight:bold;
5797: background: $sidebg;
5798: }
5799:
1.395 albertel 5800: span.LC_parm_menu_item {
5801: font-size: larger;
5802: }
1.795 www 5803:
1.395 albertel 5804: span.LC_parm_scope_all {
5805: color: red;
5806: }
1.795 www 5807:
1.395 albertel 5808: span.LC_parm_scope_folder {
5809: color: green;
5810: }
1.795 www 5811:
1.395 albertel 5812: span.LC_parm_scope_resource {
5813: color: orange;
5814: }
1.795 www 5815:
1.395 albertel 5816: span.LC_parm_part {
5817: color: blue;
5818: }
1.795 www 5819:
1.911 bisitz 5820: span.LC_parm_folder,
5821: span.LC_parm_symb {
1.395 albertel 5822: font-size: x-small;
5823: font-family: $mono;
5824: color: #AAAAAA;
5825: }
5826:
1.977 bisitz 5827: ul.LC_parm_parmlist li {
5828: display: inline-block;
5829: padding: 0.3em 0.8em;
5830: vertical-align: top;
5831: width: 150px;
5832: border-top:1px solid $lg_border_color;
5833: }
5834:
1.795 www 5835: td.LC_parm_overview_level_menu,
5836: td.LC_parm_overview_map_menu,
5837: td.LC_parm_overview_parm_selectors,
5838: td.LC_parm_overview_restrictions {
1.396 albertel 5839: border: 1px solid black;
5840: border-collapse: collapse;
5841: }
1.795 www 5842:
1.396 albertel 5843: table.LC_parm_overview_restrictions td {
5844: border-width: 1px 4px 1px 4px;
5845: border-style: solid;
5846: border-color: $pgbg;
5847: text-align: center;
5848: }
1.795 www 5849:
1.396 albertel 5850: table.LC_parm_overview_restrictions th {
5851: background: $tabbg;
5852: border-width: 1px 4px 1px 4px;
5853: border-style: solid;
5854: border-color: $pgbg;
5855: }
1.795 www 5856:
1.398 albertel 5857: table#LC_helpmenu {
1.803 bisitz 5858: border: none;
1.398 albertel 5859: height: 55px;
1.803 bisitz 5860: border-spacing: 0;
1.398 albertel 5861: }
5862:
5863: table#LC_helpmenu fieldset legend {
5864: font-size: larger;
5865: }
1.795 www 5866:
1.397 albertel 5867: table#LC_helpmenu_links {
5868: width: 100%;
5869: border: 1px solid black;
5870: background: $pgbg;
1.803 bisitz 5871: padding: 0;
1.397 albertel 5872: border-spacing: 1px;
5873: }
1.795 www 5874:
1.397 albertel 5875: table#LC_helpmenu_links tr td {
5876: padding: 1px;
5877: background: $tabbg;
1.399 albertel 5878: text-align: center;
5879: font-weight: bold;
1.397 albertel 5880: }
1.396 albertel 5881:
1.795 www 5882: table#LC_helpmenu_links a:link,
5883: table#LC_helpmenu_links a:visited,
1.397 albertel 5884: table#LC_helpmenu_links a:active {
5885: text-decoration: none;
5886: color: $font;
5887: }
1.795 www 5888:
1.397 albertel 5889: table#LC_helpmenu_links a:hover {
5890: text-decoration: underline;
5891: color: $vlink;
5892: }
1.396 albertel 5893:
1.417 albertel 5894: .LC_chrt_popup_exists {
5895: border: 1px solid #339933;
5896: margin: -1px;
5897: }
1.795 www 5898:
1.417 albertel 5899: .LC_chrt_popup_up {
5900: border: 1px solid yellow;
5901: margin: -1px;
5902: }
1.795 www 5903:
1.417 albertel 5904: .LC_chrt_popup {
5905: border: 1px solid #8888FF;
5906: background: #CCCCFF;
5907: }
1.795 www 5908:
1.421 albertel 5909: table.LC_pick_box {
5910: border-collapse: separate;
5911: background: white;
5912: border: 1px solid black;
5913: border-spacing: 1px;
5914: }
1.795 www 5915:
1.421 albertel 5916: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 5917: background: $sidebg;
1.421 albertel 5918: font-weight: bold;
1.900 bisitz 5919: text-align: left;
1.740 bisitz 5920: vertical-align: top;
1.421 albertel 5921: width: 184px;
5922: padding: 8px;
5923: }
1.795 www 5924:
1.579 raeburn 5925: table.LC_pick_box td.LC_pick_box_value {
5926: text-align: left;
5927: padding: 8px;
5928: }
1.795 www 5929:
1.579 raeburn 5930: table.LC_pick_box td.LC_pick_box_select {
5931: text-align: left;
5932: padding: 8px;
5933: }
1.795 www 5934:
1.424 albertel 5935: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 5936: padding: 0;
1.421 albertel 5937: height: 1px;
5938: background: black;
5939: }
1.795 www 5940:
1.421 albertel 5941: table.LC_pick_box td.LC_pick_box_submit {
5942: text-align: right;
5943: }
1.795 www 5944:
1.579 raeburn 5945: table.LC_pick_box td.LC_evenrow_value {
5946: text-align: left;
5947: padding: 8px;
5948: background-color: $data_table_light;
5949: }
1.795 www 5950:
1.579 raeburn 5951: table.LC_pick_box td.LC_oddrow_value {
5952: text-align: left;
5953: padding: 8px;
5954: background-color: $data_table_light;
5955: }
1.795 www 5956:
1.579 raeburn 5957: span.LC_helpform_receipt_cat {
5958: font-weight: bold;
5959: }
1.795 www 5960:
1.424 albertel 5961: table.LC_group_priv_box {
5962: background: white;
5963: border: 1px solid black;
5964: border-spacing: 1px;
5965: }
1.795 www 5966:
1.424 albertel 5967: table.LC_group_priv_box td.LC_pick_box_title {
5968: background: $tabbg;
5969: font-weight: bold;
5970: text-align: right;
5971: width: 184px;
5972: }
1.795 www 5973:
1.424 albertel 5974: table.LC_group_priv_box td.LC_groups_fixed {
5975: background: $data_table_light;
5976: text-align: center;
5977: }
1.795 www 5978:
1.424 albertel 5979: table.LC_group_priv_box td.LC_groups_optional {
5980: background: $data_table_dark;
5981: text-align: center;
5982: }
1.795 www 5983:
1.424 albertel 5984: table.LC_group_priv_box td.LC_groups_functionality {
5985: background: $data_table_darker;
5986: text-align: center;
5987: font-weight: bold;
5988: }
1.795 www 5989:
1.424 albertel 5990: table.LC_group_priv td {
5991: text-align: left;
1.803 bisitz 5992: padding: 0;
1.424 albertel 5993: }
5994:
5995: .LC_navbuttons {
5996: margin: 2ex 0ex 2ex 0ex;
5997: }
1.795 www 5998:
1.423 albertel 5999: .LC_topic_bar {
6000: font-weight: bold;
6001: background: $tabbg;
1.918 wenzelju 6002: margin: 1em 0em 1em 2em;
1.805 bisitz 6003: padding: 3px;
1.918 wenzelju 6004: font-size: 1.2em;
1.423 albertel 6005: }
1.795 www 6006:
1.423 albertel 6007: .LC_topic_bar span {
1.918 wenzelju 6008: left: 0.5em;
6009: position: absolute;
1.423 albertel 6010: vertical-align: middle;
1.918 wenzelju 6011: font-size: 1.2em;
1.423 albertel 6012: }
1.795 www 6013:
1.423 albertel 6014: table.LC_course_group_status {
6015: margin: 20px;
6016: }
1.795 www 6017:
1.423 albertel 6018: table.LC_status_selector td {
6019: vertical-align: top;
6020: text-align: center;
1.424 albertel 6021: padding: 4px;
6022: }
1.795 www 6023:
1.599 albertel 6024: div.LC_feedback_link {
1.616 albertel 6025: clear: both;
1.829 kalberla 6026: background: $sidebg;
1.779 bisitz 6027: width: 100%;
1.829 kalberla 6028: padding-bottom: 10px;
6029: border: 1px $tabbg solid;
1.833 kalberla 6030: height: 22px;
6031: line-height: 22px;
6032: padding-top: 5px;
6033: }
6034:
6035: div.LC_feedback_link img {
6036: height: 22px;
1.867 kalberla 6037: vertical-align:middle;
1.829 kalberla 6038: }
6039:
1.911 bisitz 6040: div.LC_feedback_link a {
1.829 kalberla 6041: text-decoration: none;
1.489 raeburn 6042: }
1.795 www 6043:
1.867 kalberla 6044: div.LC_comblock {
1.911 bisitz 6045: display:inline;
1.867 kalberla 6046: color:$font;
6047: font-size:90%;
6048: }
6049:
6050: div.LC_feedback_link div.LC_comblock {
6051: padding-left:5px;
6052: }
6053:
6054: div.LC_feedback_link div.LC_comblock a {
6055: color:$font;
6056: }
6057:
1.489 raeburn 6058: span.LC_feedback_link {
1.858 bisitz 6059: /* background: $feedback_link_bg; */
1.599 albertel 6060: font-size: larger;
6061: }
1.795 www 6062:
1.599 albertel 6063: span.LC_message_link {
1.858 bisitz 6064: /* background: $feedback_link_bg; */
1.599 albertel 6065: font-size: larger;
6066: position: absolute;
6067: right: 1em;
1.489 raeburn 6068: }
1.421 albertel 6069:
1.515 albertel 6070: table.LC_prior_tries {
1.524 albertel 6071: border: 1px solid #000000;
6072: border-collapse: separate;
6073: border-spacing: 1px;
1.515 albertel 6074: }
1.523 albertel 6075:
1.515 albertel 6076: table.LC_prior_tries td {
1.524 albertel 6077: padding: 2px;
1.515 albertel 6078: }
1.523 albertel 6079:
6080: .LC_answer_correct {
1.795 www 6081: background: lightgreen;
6082: color: darkgreen;
6083: padding: 6px;
1.523 albertel 6084: }
1.795 www 6085:
1.523 albertel 6086: .LC_answer_charged_try {
1.797 www 6087: background: #FFAAAA;
1.795 www 6088: color: darkred;
6089: padding: 6px;
1.523 albertel 6090: }
1.795 www 6091:
1.779 bisitz 6092: .LC_answer_not_charged_try,
1.523 albertel 6093: .LC_answer_no_grade,
6094: .LC_answer_late {
1.795 www 6095: background: lightyellow;
1.523 albertel 6096: color: black;
1.795 www 6097: padding: 6px;
1.523 albertel 6098: }
1.795 www 6099:
1.523 albertel 6100: .LC_answer_previous {
1.795 www 6101: background: lightblue;
6102: color: darkblue;
6103: padding: 6px;
1.523 albertel 6104: }
1.795 www 6105:
1.779 bisitz 6106: .LC_answer_no_message {
1.777 tempelho 6107: background: #FFFFFF;
6108: color: black;
1.795 www 6109: padding: 6px;
1.779 bisitz 6110: }
1.795 www 6111:
1.779 bisitz 6112: .LC_answer_unknown {
6113: background: orange;
6114: color: black;
1.795 www 6115: padding: 6px;
1.777 tempelho 6116: }
1.795 www 6117:
1.529 albertel 6118: span.LC_prior_numerical,
6119: span.LC_prior_string,
6120: span.LC_prior_custom,
6121: span.LC_prior_reaction,
6122: span.LC_prior_math {
1.925 bisitz 6123: font-family: $mono;
1.523 albertel 6124: white-space: pre;
6125: }
6126:
1.525 albertel 6127: span.LC_prior_string {
1.925 bisitz 6128: font-family: $mono;
1.525 albertel 6129: white-space: pre;
6130: }
6131:
1.523 albertel 6132: table.LC_prior_option {
6133: width: 100%;
6134: border-collapse: collapse;
6135: }
1.795 www 6136:
1.911 bisitz 6137: table.LC_prior_rank,
1.795 www 6138: table.LC_prior_match {
1.528 albertel 6139: border-collapse: collapse;
6140: }
1.795 www 6141:
1.528 albertel 6142: table.LC_prior_option tr td,
6143: table.LC_prior_rank tr td,
6144: table.LC_prior_match tr td {
1.524 albertel 6145: border: 1px solid #000000;
1.515 albertel 6146: }
6147:
1.855 bisitz 6148: .LC_nobreak {
1.544 albertel 6149: white-space: nowrap;
1.519 raeburn 6150: }
6151:
1.576 raeburn 6152: span.LC_cusr_emph {
6153: font-style: italic;
6154: }
6155:
1.633 raeburn 6156: span.LC_cusr_subheading {
6157: font-weight: normal;
6158: font-size: 85%;
6159: }
6160:
1.861 bisitz 6161: div.LC_docs_entry_move {
1.859 bisitz 6162: border: 1px solid #BBBBBB;
1.545 albertel 6163: background: #DDDDDD;
1.861 bisitz 6164: width: 22px;
1.859 bisitz 6165: padding: 1px;
6166: margin: 0;
1.545 albertel 6167: }
6168:
1.861 bisitz 6169: table.LC_data_table tr > td.LC_docs_entry_commands,
6170: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 6171: background: #DDDDDD;
6172: font-size: x-small;
6173: }
1.795 www 6174:
1.861 bisitz 6175: .LC_docs_entry_parameter {
6176: white-space: nowrap;
6177: }
6178:
1.544 albertel 6179: .LC_docs_copy {
1.545 albertel 6180: color: #000099;
1.544 albertel 6181: }
1.795 www 6182:
1.544 albertel 6183: .LC_docs_cut {
1.545 albertel 6184: color: #550044;
1.544 albertel 6185: }
1.795 www 6186:
1.544 albertel 6187: .LC_docs_rename {
1.545 albertel 6188: color: #009900;
1.544 albertel 6189: }
1.795 www 6190:
1.544 albertel 6191: .LC_docs_remove {
1.545 albertel 6192: color: #990000;
6193: }
6194:
1.547 albertel 6195: .LC_docs_reinit_warn,
6196: .LC_docs_ext_edit {
6197: font-size: x-small;
6198: }
6199:
1.545 albertel 6200: table.LC_docs_adddocs td,
6201: table.LC_docs_adddocs th {
6202: border: 1px solid #BBBBBB;
6203: padding: 4px;
6204: background: #DDDDDD;
1.543 albertel 6205: }
6206:
1.584 albertel 6207: table.LC_sty_begin {
6208: background: #BBFFBB;
6209: }
1.795 www 6210:
1.584 albertel 6211: table.LC_sty_end {
6212: background: #FFBBBB;
6213: }
6214:
1.589 raeburn 6215: table.LC_double_column {
1.803 bisitz 6216: border-width: 0;
1.589 raeburn 6217: border-collapse: collapse;
6218: width: 100%;
6219: padding: 2px;
6220: }
6221:
6222: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 6223: top: 2px;
1.589 raeburn 6224: left: 2px;
6225: width: 47%;
6226: vertical-align: top;
6227: }
6228:
6229: table.LC_double_column tr td.LC_right_col {
6230: top: 2px;
1.779 bisitz 6231: right: 2px;
1.589 raeburn 6232: width: 47%;
6233: vertical-align: top;
6234: }
6235:
1.591 raeburn 6236: div.LC_left_float {
6237: float: left;
6238: padding-right: 5%;
1.597 albertel 6239: padding-bottom: 4px;
1.591 raeburn 6240: }
6241:
6242: div.LC_clear_float_header {
1.597 albertel 6243: padding-bottom: 2px;
1.591 raeburn 6244: }
6245:
6246: div.LC_clear_float_footer {
1.597 albertel 6247: padding-top: 10px;
1.591 raeburn 6248: clear: both;
6249: }
6250:
1.597 albertel 6251: div.LC_grade_show_user {
1.941 bisitz 6252: /* border-left: 5px solid $sidebg; */
6253: border-top: 5px solid #000000;
6254: margin: 50px 0 0 0;
1.936 bisitz 6255: padding: 15px 0 5px 10px;
1.597 albertel 6256: }
1.795 www 6257:
1.936 bisitz 6258: div.LC_grade_show_user_odd_row {
1.941 bisitz 6259: /* border-left: 5px solid #000000; */
6260: }
6261:
6262: div.LC_grade_show_user div.LC_Box {
6263: margin-right: 50px;
1.597 albertel 6264: }
6265:
6266: div.LC_grade_submissions,
6267: div.LC_grade_message_center,
1.936 bisitz 6268: div.LC_grade_info_links {
1.597 albertel 6269: margin: 5px;
6270: width: 99%;
6271: background: #FFFFFF;
6272: }
1.795 www 6273:
1.597 albertel 6274: div.LC_grade_submissions_header,
1.936 bisitz 6275: div.LC_grade_message_center_header {
1.705 tempelho 6276: font-weight: bold;
6277: font-size: large;
1.597 albertel 6278: }
1.795 www 6279:
1.597 albertel 6280: div.LC_grade_submissions_body,
1.936 bisitz 6281: div.LC_grade_message_center_body {
1.597 albertel 6282: border: 1px solid black;
6283: width: 99%;
6284: background: #FFFFFF;
6285: }
1.795 www 6286:
1.613 albertel 6287: table.LC_scantron_action {
6288: width: 100%;
6289: }
1.795 www 6290:
1.613 albertel 6291: table.LC_scantron_action tr th {
1.698 harmsja 6292: font-weight:bold;
6293: font-style:normal;
1.613 albertel 6294: }
1.795 www 6295:
1.779 bisitz 6296: .LC_edit_problem_header,
1.614 albertel 6297: div.LC_edit_problem_footer {
1.705 tempelho 6298: font-weight: normal;
6299: font-size: medium;
1.602 albertel 6300: margin: 2px;
1.1060 bisitz 6301: background-color: $sidebg;
1.600 albertel 6302: }
1.795 www 6303:
1.600 albertel 6304: div.LC_edit_problem_header,
1.602 albertel 6305: div.LC_edit_problem_header div,
1.614 albertel 6306: div.LC_edit_problem_footer,
6307: div.LC_edit_problem_footer div,
1.602 albertel 6308: div.LC_edit_problem_editxml_header,
6309: div.LC_edit_problem_editxml_header div {
1.600 albertel 6310: margin-top: 5px;
6311: }
1.795 www 6312:
1.600 albertel 6313: div.LC_edit_problem_header_title {
1.705 tempelho 6314: font-weight: bold;
6315: font-size: larger;
1.602 albertel 6316: background: $tabbg;
6317: padding: 3px;
1.1060 bisitz 6318: margin: 0 0 5px 0;
1.602 albertel 6319: }
1.795 www 6320:
1.602 albertel 6321: table.LC_edit_problem_header_title {
6322: width: 100%;
1.600 albertel 6323: background: $tabbg;
1.602 albertel 6324: }
6325:
6326: div.LC_edit_problem_discards {
6327: float: left;
6328: padding-bottom: 5px;
6329: }
1.795 www 6330:
1.602 albertel 6331: div.LC_edit_problem_saves {
6332: float: right;
6333: padding-bottom: 5px;
1.600 albertel 6334: }
1.795 www 6335:
1.911 bisitz 6336: img.stift {
1.803 bisitz 6337: border-width: 0;
6338: vertical-align: middle;
1.677 riegler 6339: }
1.680 riegler 6340:
1.923 bisitz 6341: table td.LC_mainmenu_col_fieldset {
1.680 riegler 6342: vertical-align: top;
1.777 tempelho 6343: }
1.795 www 6344:
1.716 raeburn 6345: div.LC_createcourse {
1.911 bisitz 6346: margin: 10px 10px 10px 10px;
1.716 raeburn 6347: }
6348:
1.917 raeburn 6349: .LC_dccid {
6350: margin: 0.2em 0 0 0;
6351: padding: 0;
6352: font-size: 90%;
6353: display:none;
6354: }
6355:
1.897 wenzelju 6356: ol.LC_primary_menu a:hover,
1.721 harmsja 6357: ol#LC_MenuBreadcrumbs a:hover,
6358: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 6359: ul#LC_secondary_menu a:hover,
1.721 harmsja 6360: .LC_FormSectionClearButton input:hover
1.795 www 6361: ul.LC_TabContent li:hover a {
1.952 onken 6362: color:$button_hover;
1.911 bisitz 6363: text-decoration:none;
1.693 droeschl 6364: }
6365:
1.779 bisitz 6366: h1 {
1.911 bisitz 6367: padding: 0;
6368: line-height:130%;
1.693 droeschl 6369: }
1.698 harmsja 6370:
1.911 bisitz 6371: h2,
6372: h3,
6373: h4,
6374: h5,
6375: h6 {
6376: margin: 5px 0 5px 0;
6377: padding: 0;
6378: line-height:130%;
1.693 droeschl 6379: }
1.795 www 6380:
6381: .LC_hcell {
1.911 bisitz 6382: padding:3px 15px 3px 15px;
6383: margin: 0;
6384: background-color:$tabbg;
6385: color:$fontmenu;
6386: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 6387: }
1.795 www 6388:
1.840 bisitz 6389: .LC_Box > .LC_hcell {
1.911 bisitz 6390: margin: 0 -10px 10px -10px;
1.835 bisitz 6391: }
6392:
1.721 harmsja 6393: .LC_noBorder {
1.911 bisitz 6394: border: 0;
1.698 harmsja 6395: }
1.693 droeschl 6396:
1.721 harmsja 6397: .LC_FormSectionClearButton input {
1.911 bisitz 6398: background-color:transparent;
6399: border: none;
6400: cursor:pointer;
6401: text-decoration:underline;
1.693 droeschl 6402: }
1.763 bisitz 6403:
6404: .LC_help_open_topic {
1.911 bisitz 6405: color: #FFFFFF;
6406: background-color: #EEEEFF;
6407: margin: 1px;
6408: padding: 4px;
6409: border: 1px solid #000033;
6410: white-space: nowrap;
6411: /* vertical-align: middle; */
1.759 neumanie 6412: }
1.693 droeschl 6413:
1.911 bisitz 6414: dl,
6415: ul,
6416: div,
6417: fieldset {
6418: margin: 10px 10px 10px 0;
6419: /* overflow: hidden; */
1.693 droeschl 6420: }
1.795 www 6421:
1.838 bisitz 6422: fieldset > legend {
1.911 bisitz 6423: font-weight: bold;
6424: padding: 0 5px 0 5px;
1.838 bisitz 6425: }
6426:
1.813 bisitz 6427: #LC_nav_bar {
1.911 bisitz 6428: float: left;
1.995 raeburn 6429: background-color: $pgbg_or_bgcolor;
1.966 bisitz 6430: margin: 0 0 2px 0;
1.807 droeschl 6431: }
6432:
1.916 droeschl 6433: #LC_realm {
6434: margin: 0.2em 0 0 0;
6435: padding: 0;
6436: font-weight: bold;
6437: text-align: center;
1.995 raeburn 6438: background-color: $pgbg_or_bgcolor;
1.916 droeschl 6439: }
6440:
1.911 bisitz 6441: #LC_nav_bar em {
6442: font-weight: bold;
6443: font-style: normal;
1.807 droeschl 6444: }
6445:
1.897 wenzelju 6446: ol.LC_primary_menu {
1.911 bisitz 6447: float: right;
1.934 droeschl 6448: margin: 0;
1.1076 ! raeburn 6449: padding: 0;
1.995 raeburn 6450: background-color: $pgbg_or_bgcolor;
1.807 droeschl 6451: }
6452:
1.852 droeschl 6453: ol#LC_PathBreadcrumbs {
1.911 bisitz 6454: margin: 0;
1.693 droeschl 6455: }
6456:
1.897 wenzelju 6457: ol.LC_primary_menu li {
1.1076 ! raeburn 6458: color: RGB(80, 80, 80);
! 6459: vertical-align: middle;
! 6460: text-align: left;
! 6461: list-style: none;
! 6462: float: left;
! 6463: }
! 6464:
! 6465: ol.LC_primary_menu li a {
! 6466: display: block;
! 6467: margin: 0;
! 6468: padding: 0 5px 0 10px;
! 6469: text-decoration: none;
! 6470: }
! 6471:
! 6472: ol.LC_primary_menu li ul {
! 6473: display: none;
! 6474: width: 10em;
! 6475: background-color: $data_table_light;
! 6476: }
! 6477:
! 6478: ol.LC_primary_menu li:hover ul, ol.LC_primary_menu li.hover ul {
! 6479: display: block;
! 6480: position: absolute;
! 6481: margin: 0;
! 6482: padding: 0;
! 6483: }
! 6484:
! 6485: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
! 6486: font-size: 90%;
1.911 bisitz 6487: vertical-align: top;
1.1076 ! raeburn 6488: float: none;
! 6489: }
! 6490:
! 6491: ol.LC_primary_menu li:hover li a, ol.LC_primary_menu li.hover li a {
! 6492: background-color:$data_table_light
! 6493: }
! 6494:
! 6495: ol.LC_primary_menu li li a:hover {
! 6496: color:$button_hover;
! 6497: background-color:$data_table_dark;
1.693 droeschl 6498: }
6499:
1.897 wenzelju 6500: ol.LC_primary_menu li img {
1.911 bisitz 6501: vertical-align: bottom;
1.934 droeschl 6502: height: 1.1em;
1.693 droeschl 6503: }
6504:
1.897 wenzelju 6505: ol.LC_primary_menu a {
1.911 bisitz 6506: color: RGB(80, 80, 80);
6507: text-decoration: none;
1.693 droeschl 6508: }
1.795 www 6509:
1.949 droeschl 6510: ol.LC_primary_menu a.LC_new_message {
6511: font-weight:bold;
6512: color: darkred;
6513: }
6514:
1.975 raeburn 6515: ol.LC_docs_parameters {
6516: margin-left: 0;
6517: padding: 0;
6518: list-style: none;
6519: }
6520:
6521: ol.LC_docs_parameters li {
6522: margin: 0;
6523: padding-right: 20px;
6524: display: inline;
6525: }
6526:
1.976 raeburn 6527: ol.LC_docs_parameters li:before {
6528: content: "\\002022 \\0020";
6529: }
6530:
6531: li.LC_docs_parameters_title {
6532: font-weight: bold;
6533: }
6534:
6535: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
6536: content: "";
6537: }
6538:
1.897 wenzelju 6539: ul#LC_secondary_menu {
1.911 bisitz 6540: clear: both;
6541: color: $fontmenu;
6542: background: $tabbg;
6543: list-style: none;
6544: padding: 0;
6545: margin: 0;
6546: width: 100%;
1.995 raeburn 6547: text-align: left;
1.808 droeschl 6548: }
6549:
1.897 wenzelju 6550: ul#LC_secondary_menu li {
1.911 bisitz 6551: font-weight: bold;
6552: line-height: 1.8em;
6553: padding: 0 0.8em;
6554: border-right: 1px solid black;
6555: display: inline;
6556: vertical-align: middle;
1.807 droeschl 6557: }
6558:
1.847 tempelho 6559: ul.LC_TabContent {
1.911 bisitz 6560: display:block;
6561: background: $sidebg;
6562: border-bottom: solid 1px $lg_border_color;
6563: list-style:none;
1.1020 raeburn 6564: margin: -1px -10px 0 -10px;
1.911 bisitz 6565: padding: 0;
1.693 droeschl 6566: }
6567:
1.795 www 6568: ul.LC_TabContent li,
6569: ul.LC_TabContentBigger li {
1.911 bisitz 6570: float:left;
1.741 harmsja 6571: }
1.795 www 6572:
1.897 wenzelju 6573: ul#LC_secondary_menu li a {
1.911 bisitz 6574: color: $fontmenu;
6575: text-decoration: none;
1.693 droeschl 6576: }
1.795 www 6577:
1.721 harmsja 6578: ul.LC_TabContent {
1.952 onken 6579: min-height:20px;
1.721 harmsja 6580: }
1.795 www 6581:
6582: ul.LC_TabContent li {
1.911 bisitz 6583: vertical-align:middle;
1.959 onken 6584: padding: 0 16px 0 10px;
1.911 bisitz 6585: background-color:$tabbg;
6586: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 6587: border-left: solid 1px $font;
1.721 harmsja 6588: }
1.795 www 6589:
1.847 tempelho 6590: ul.LC_TabContent .right {
1.911 bisitz 6591: float:right;
1.847 tempelho 6592: }
6593:
1.911 bisitz 6594: ul.LC_TabContent li a,
6595: ul.LC_TabContent li {
6596: color:rgb(47,47,47);
6597: text-decoration:none;
6598: font-size:95%;
6599: font-weight:bold;
1.952 onken 6600: min-height:20px;
6601: }
6602:
1.959 onken 6603: ul.LC_TabContent li a:hover,
6604: ul.LC_TabContent li a:focus {
1.952 onken 6605: color: $button_hover;
1.959 onken 6606: background:none;
6607: outline:none;
1.952 onken 6608: }
6609:
6610: ul.LC_TabContent li:hover {
6611: color: $button_hover;
6612: cursor:pointer;
1.721 harmsja 6613: }
1.795 www 6614:
1.911 bisitz 6615: ul.LC_TabContent li.active {
1.952 onken 6616: color: $font;
1.911 bisitz 6617: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 6618: border-bottom:solid 1px #FFFFFF;
6619: cursor: default;
1.744 ehlerst 6620: }
1.795 www 6621:
1.959 onken 6622: ul.LC_TabContent li.active a {
6623: color:$font;
6624: background:#FFFFFF;
6625: outline: none;
6626: }
1.1047 raeburn 6627:
6628: ul.LC_TabContent li.goback {
6629: float: left;
6630: border-left: none;
6631: }
6632:
1.870 tempelho 6633: #maincoursedoc {
1.911 bisitz 6634: clear:both;
1.870 tempelho 6635: }
6636:
6637: ul.LC_TabContentBigger {
1.911 bisitz 6638: display:block;
6639: list-style:none;
6640: padding: 0;
1.870 tempelho 6641: }
6642:
1.795 www 6643: ul.LC_TabContentBigger li {
1.911 bisitz 6644: vertical-align:bottom;
6645: height: 30px;
6646: font-size:110%;
6647: font-weight:bold;
6648: color: #737373;
1.841 tempelho 6649: }
6650:
1.957 onken 6651: ul.LC_TabContentBigger li.active {
6652: position: relative;
6653: top: 1px;
6654: }
6655:
1.870 tempelho 6656: ul.LC_TabContentBigger li a {
1.911 bisitz 6657: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6658: height: 30px;
6659: line-height: 30px;
6660: text-align: center;
6661: display: block;
6662: text-decoration: none;
1.958 onken 6663: outline: none;
1.741 harmsja 6664: }
1.795 www 6665:
1.870 tempelho 6666: ul.LC_TabContentBigger li.active a {
1.911 bisitz 6667: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6668: color:$font;
1.744 ehlerst 6669: }
1.795 www 6670:
1.870 tempelho 6671: ul.LC_TabContentBigger li b {
1.911 bisitz 6672: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
6673: display: block;
6674: float: left;
6675: padding: 0 30px;
1.957 onken 6676: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 6677: }
6678:
1.956 onken 6679: ul.LC_TabContentBigger li:hover b {
6680: color:$button_hover;
6681: }
6682:
1.870 tempelho 6683: ul.LC_TabContentBigger li.active b {
1.911 bisitz 6684: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
6685: color:$font;
1.957 onken 6686: border: 0;
1.741 harmsja 6687: }
1.693 droeschl 6688:
1.870 tempelho 6689:
1.862 bisitz 6690: ul.LC_CourseBreadcrumbs {
6691: background: $sidebg;
1.1020 raeburn 6692: height: 2em;
1.862 bisitz 6693: padding-left: 10px;
1.1020 raeburn 6694: margin: 0;
1.862 bisitz 6695: list-style-position: inside;
6696: }
6697:
1.911 bisitz 6698: ol#LC_MenuBreadcrumbs,
1.862 bisitz 6699: ol#LC_PathBreadcrumbs {
1.911 bisitz 6700: padding-left: 10px;
6701: margin: 0;
1.933 droeschl 6702: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 6703: }
6704:
1.911 bisitz 6705: ol#LC_MenuBreadcrumbs li,
6706: ol#LC_PathBreadcrumbs li,
1.862 bisitz 6707: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 6708: display: inline;
1.933 droeschl 6709: white-space: normal;
1.693 droeschl 6710: }
6711:
1.823 bisitz 6712: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 6713: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 6714: text-decoration: none;
6715: font-size:90%;
1.693 droeschl 6716: }
1.795 www 6717:
1.969 droeschl 6718: ol#LC_MenuBreadcrumbs h1 {
6719: display: inline;
6720: font-size: 90%;
6721: line-height: 2.5em;
6722: margin: 0;
6723: padding: 0;
6724: }
6725:
1.795 www 6726: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 6727: text-decoration:none;
6728: font-size:100%;
6729: font-weight:bold;
1.693 droeschl 6730: }
1.795 www 6731:
1.840 bisitz 6732: .LC_Box {
1.911 bisitz 6733: border: solid 1px $lg_border_color;
6734: padding: 0 10px 10px 10px;
1.746 neumanie 6735: }
1.795 www 6736:
1.1020 raeburn 6737: .LC_DocsBox {
6738: border: solid 1px $lg_border_color;
6739: padding: 0 0 10px 10px;
6740: }
6741:
1.795 www 6742: .LC_AboutMe_Image {
1.911 bisitz 6743: float:left;
6744: margin-right:10px;
1.747 neumanie 6745: }
1.795 www 6746:
6747: .LC_Clear_AboutMe_Image {
1.911 bisitz 6748: clear:left;
1.747 neumanie 6749: }
1.795 www 6750:
1.721 harmsja 6751: dl.LC_ListStyleClean dt {
1.911 bisitz 6752: padding-right: 5px;
6753: display: table-header-group;
1.693 droeschl 6754: }
6755:
1.721 harmsja 6756: dl.LC_ListStyleClean dd {
1.911 bisitz 6757: display: table-row;
1.693 droeschl 6758: }
6759:
1.721 harmsja 6760: .LC_ListStyleClean,
6761: .LC_ListStyleSimple,
6762: .LC_ListStyleNormal,
1.795 www 6763: .LC_ListStyleSpecial {
1.911 bisitz 6764: /* display:block; */
6765: list-style-position: inside;
6766: list-style-type: none;
6767: overflow: hidden;
6768: padding: 0;
1.693 droeschl 6769: }
6770:
1.721 harmsja 6771: .LC_ListStyleSimple li,
6772: .LC_ListStyleSimple dd,
6773: .LC_ListStyleNormal li,
6774: .LC_ListStyleNormal dd,
6775: .LC_ListStyleSpecial li,
1.795 www 6776: .LC_ListStyleSpecial dd {
1.911 bisitz 6777: margin: 0;
6778: padding: 5px 5px 5px 10px;
6779: clear: both;
1.693 droeschl 6780: }
6781:
1.721 harmsja 6782: .LC_ListStyleClean li,
6783: .LC_ListStyleClean dd {
1.911 bisitz 6784: padding-top: 0;
6785: padding-bottom: 0;
1.693 droeschl 6786: }
6787:
1.721 harmsja 6788: .LC_ListStyleSimple dd,
1.795 www 6789: .LC_ListStyleSimple li {
1.911 bisitz 6790: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6791: }
6792:
1.721 harmsja 6793: .LC_ListStyleSpecial li,
6794: .LC_ListStyleSpecial dd {
1.911 bisitz 6795: list-style-type: none;
6796: background-color: RGB(220, 220, 220);
6797: margin-bottom: 4px;
1.693 droeschl 6798: }
6799:
1.721 harmsja 6800: table.LC_SimpleTable {
1.911 bisitz 6801: margin:5px;
6802: border:solid 1px $lg_border_color;
1.795 www 6803: }
1.693 droeschl 6804:
1.721 harmsja 6805: table.LC_SimpleTable tr {
1.911 bisitz 6806: padding: 0;
6807: border:solid 1px $lg_border_color;
1.693 droeschl 6808: }
1.795 www 6809:
6810: table.LC_SimpleTable thead {
1.911 bisitz 6811: background:rgb(220,220,220);
1.693 droeschl 6812: }
6813:
1.721 harmsja 6814: div.LC_columnSection {
1.911 bisitz 6815: display: block;
6816: clear: both;
6817: overflow: hidden;
6818: margin: 0;
1.693 droeschl 6819: }
6820:
1.721 harmsja 6821: div.LC_columnSection>* {
1.911 bisitz 6822: float: left;
6823: margin: 10px 20px 10px 0;
6824: overflow:hidden;
1.693 droeschl 6825: }
1.721 harmsja 6826:
1.795 www 6827: table em {
1.911 bisitz 6828: font-weight: bold;
6829: font-style: normal;
1.748 schulted 6830: }
1.795 www 6831:
1.779 bisitz 6832: table.LC_tableBrowseRes,
1.795 www 6833: table.LC_tableOfContent {
1.911 bisitz 6834: border:none;
6835: border-spacing: 1px;
6836: padding: 3px;
6837: background-color: #FFFFFF;
6838: font-size: 90%;
1.753 droeschl 6839: }
1.789 droeschl 6840:
1.911 bisitz 6841: table.LC_tableOfContent {
6842: border-collapse: collapse;
1.789 droeschl 6843: }
6844:
1.771 droeschl 6845: table.LC_tableBrowseRes a,
1.768 schulted 6846: table.LC_tableOfContent a {
1.911 bisitz 6847: background-color: transparent;
6848: text-decoration: none;
1.753 droeschl 6849: }
6850:
1.795 www 6851: table.LC_tableOfContent img {
1.911 bisitz 6852: border: none;
6853: height: 1.3em;
6854: vertical-align: text-bottom;
6855: margin-right: 0.3em;
1.753 droeschl 6856: }
1.757 schulted 6857:
1.795 www 6858: a#LC_content_toolbar_firsthomework {
1.911 bisitz 6859: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 6860: }
6861:
1.795 www 6862: a#LC_content_toolbar_everything {
1.911 bisitz 6863: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 6864: }
6865:
1.795 www 6866: a#LC_content_toolbar_uncompleted {
1.911 bisitz 6867: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 6868: }
6869:
1.795 www 6870: #LC_content_toolbar_clearbubbles {
1.911 bisitz 6871: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 6872: }
6873:
1.795 www 6874: a#LC_content_toolbar_changefolder {
1.911 bisitz 6875: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 6876: }
6877:
1.795 www 6878: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 6879: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 6880: }
6881:
1.1043 raeburn 6882: a#LC_content_toolbar_edittoplevel {
6883: background-image:url(/res/adm/pages/edittoplevel.gif);
6884: }
6885:
1.795 www 6886: ul#LC_toolbar li a:hover {
1.911 bisitz 6887: background-position: bottom center;
1.757 schulted 6888: }
6889:
1.795 www 6890: ul#LC_toolbar {
1.911 bisitz 6891: padding: 0;
6892: margin: 2px;
6893: list-style:none;
6894: position:relative;
6895: background-color:white;
1.757 schulted 6896: }
6897:
1.795 www 6898: ul#LC_toolbar li {
1.911 bisitz 6899: border:1px solid white;
6900: padding: 0;
6901: margin: 0;
6902: float: left;
6903: display:inline;
6904: vertical-align:middle;
6905: }
1.757 schulted 6906:
1.783 amueller 6907:
1.795 www 6908: a.LC_toolbarItem {
1.911 bisitz 6909: display:block;
6910: padding: 0;
6911: margin: 0;
6912: height: 32px;
6913: width: 32px;
6914: color:white;
6915: border: none;
6916: background-repeat:no-repeat;
6917: background-color:transparent;
1.757 schulted 6918: }
6919:
1.915 droeschl 6920: ul.LC_funclist {
6921: margin: 0;
6922: padding: 0.5em 1em 0.5em 0;
6923: }
6924:
1.933 droeschl 6925: ul.LC_funclist > li:first-child {
6926: font-weight:bold;
6927: margin-left:0.8em;
6928: }
6929:
1.915 droeschl 6930: ul.LC_funclist + ul.LC_funclist {
6931: /*
6932: left border as a seperator if we have more than
6933: one list
6934: */
6935: border-left: 1px solid $sidebg;
6936: /*
6937: this hides the left border behind the border of the
6938: outer box if element is wrapped to the next 'line'
6939: */
6940: margin-left: -1px;
6941: }
6942:
1.843 bisitz 6943: ul.LC_funclist li {
1.915 droeschl 6944: display: inline;
1.782 bisitz 6945: white-space: nowrap;
1.915 droeschl 6946: margin: 0 0 0 25px;
6947: line-height: 150%;
1.782 bisitz 6948: }
6949:
1.974 wenzelju 6950: .LC_hidden {
6951: display: none;
6952: }
6953:
1.1030 www 6954: .LCmodal-overlay {
6955: position:fixed;
6956: top:0;
6957: right:0;
6958: bottom:0;
6959: left:0;
6960: height:100%;
6961: width:100%;
6962: margin:0;
6963: padding:0;
6964: background:#999;
6965: opacity:.75;
6966: filter: alpha(opacity=75);
6967: -moz-opacity: 0.75;
6968: z-index:101;
6969: }
6970:
6971: * html .LCmodal-overlay {
6972: position: absolute;
6973: height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
6974: }
6975:
6976: .LCmodal-window {
6977: position:fixed;
6978: top:50%;
6979: left:50%;
6980: margin:0;
6981: padding:0;
6982: z-index:102;
6983: }
6984:
6985: * html .LCmodal-window {
6986: position:absolute;
6987: }
6988:
6989: .LCclose-window {
6990: position:absolute;
6991: width:32px;
6992: height:32px;
6993: right:8px;
6994: top:8px;
6995: background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
6996: text-indent:-99999px;
6997: overflow:hidden;
6998: cursor:pointer;
6999: }
7000:
1.343 albertel 7001: END
7002: }
7003:
1.306 albertel 7004: =pod
7005:
7006: =item * &headtag()
7007:
7008: Returns a uniform footer for LON-CAPA web pages.
7009:
1.307 albertel 7010: Inputs: $title - optional title for the head
7011: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 7012: $args - optional arguments
1.319 albertel 7013: force_register - if is true call registerurl so the remote is
7014: informed
1.415 albertel 7015: redirect -> array ref of
7016: 1- seconds before redirect occurs
7017: 2- url to redirect to
7018: 3- whether the side effect should occur
1.315 albertel 7019: (side effect of setting
7020: $env{'internal.head.redirect'} to the url
7021: redirected too)
1.352 albertel 7022: domain -> force to color decorate a page for a specific
7023: domain
7024: function -> force usage of a specific rolish color scheme
7025: bgcolor -> override the default page bgcolor
1.460 albertel 7026: no_auto_mt_title
7027: -> prevent &mt()ing the title arg
1.464 albertel 7028:
1.306 albertel 7029: =cut
7030:
7031: sub headtag {
1.313 albertel 7032: my ($title,$head_extra,$args) = @_;
1.306 albertel 7033:
1.363 albertel 7034: my $function = $args->{'function'} || &get_users_function();
7035: my $domain = $args->{'domain'} || &determinedomain();
7036: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 7037: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 7038: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 7039: #time(),
1.418 albertel 7040: $env{'environment.color.timestamp'},
1.363 albertel 7041: $function,$domain,$bgcolor);
7042:
1.369 www 7043: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 7044:
1.308 albertel 7045: my $result =
7046: '<head>'.
1.461 albertel 7047: &font_settings();
1.319 albertel 7048:
1.1064 raeburn 7049: my $inhibitprint = &print_suppression();
7050:
1.461 albertel 7051: if (!$args->{'frameset'}) {
7052: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
7053: }
1.962 droeschl 7054: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
7055: $result .= Apache::lonxml::display_title();
1.319 albertel 7056: }
1.436 albertel 7057: if (!$args->{'no_nav_bar'}
7058: && !$args->{'only_body'}
7059: && !$args->{'frameset'}) {
7060: $result .= &help_menu_js();
1.1032 www 7061: $result.=&modal_window();
1.1038 www 7062: $result.=&togglebox_script();
1.1034 www 7063: $result.=&wishlist_window();
1.1041 www 7064: $result.=&LCprogressbarUpdate_script();
1.1034 www 7065: } else {
7066: if ($args->{'add_modal'}) {
7067: $result.=&modal_window();
7068: }
7069: if ($args->{'add_wishlist'}) {
7070: $result.=&wishlist_window();
7071: }
1.1038 www 7072: if ($args->{'add_togglebox'}) {
7073: $result.=&togglebox_script();
7074: }
1.1041 www 7075: if ($args->{'add_progressbar'}) {
7076: $result.=&LCprogressbarUpdate_script();
7077: }
1.436 albertel 7078: }
1.314 albertel 7079: if (ref($args->{'redirect'})) {
1.414 albertel 7080: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 7081: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 7082: if (!$inhibit_continue) {
7083: $env{'internal.head.redirect'} = $url;
7084: }
1.313 albertel 7085: $result.=<<ADDMETA
7086: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 7087: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 7088: ADDMETA
7089: }
1.306 albertel 7090: if (!defined($title)) {
7091: $title = 'The LearningOnline Network with CAPA';
7092: }
1.460 albertel 7093: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
7094: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 7095: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
1.1064 raeburn 7096: .$inhibitprint
1.414 albertel 7097: .$head_extra;
1.962 droeschl 7098: return $result.'</head>';
1.306 albertel 7099: }
7100:
7101: =pod
7102:
1.340 albertel 7103: =item * &font_settings()
7104:
7105: Returns neccessary <meta> to set the proper encoding
7106:
7107: Inputs: none
7108:
7109: =cut
7110:
7111: sub font_settings {
7112: my $headerstring='';
1.647 www 7113: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 7114: $headerstring.=
7115: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
7116: }
7117: return $headerstring;
7118: }
7119:
1.341 albertel 7120: =pod
7121:
1.1064 raeburn 7122: =item * &print_suppression()
7123:
7124: In course context returns css which causes the body to be blank when media="print",
7125: if printout generation is unavailable for the current resource.
7126:
7127: This could be because:
7128:
7129: (a) printstartdate is in the future
7130:
7131: (b) printenddate is in the past
7132:
7133: (c) there is an active exam block with "printout"
7134: functionality blocked
7135:
7136: Users with pav, pfo or evb privileges are exempt.
7137:
7138: Inputs: none
7139:
7140: =cut
7141:
7142:
7143: sub print_suppression {
7144: my $noprint;
7145: if ($env{'request.course.id'}) {
7146: my $scope = $env{'request.course.id'};
7147: if ((&Apache::lonnet::allowed('pav',$scope)) ||
7148: (&Apache::lonnet::allowed('pfo',$scope))) {
7149: return;
7150: }
7151: if ($env{'request.course.sec'} ne '') {
7152: $scope .= "/$env{'request.course.sec'}";
7153: if ((&Apache::lonnet::allowed('pav',$scope)) ||
7154: (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065 raeburn 7155: return;
1.1064 raeburn 7156: }
7157: }
7158: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7159: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1065 raeburn 7160: my $blocked = &blocking_status('printout',$cnum,$cdom);
1.1064 raeburn 7161: if ($blocked) {
7162: my $checkrole = "cm./$cdom/$cnum";
7163: if ($env{'request.course.sec'} ne '') {
7164: $checkrole .= "/$env{'request.course.sec'}";
7165: }
7166: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
7167: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
7168: $noprint = 1;
7169: }
7170: }
7171: unless ($noprint) {
7172: my $symb = &Apache::lonnet::symbread();
7173: if ($symb ne '') {
7174: my $navmap = Apache::lonnavmaps::navmap->new();
7175: if (ref($navmap)) {
7176: my $res = $navmap->getBySymb($symb);
7177: if (ref($res)) {
7178: if (!$res->resprintable()) {
7179: $noprint = 1;
7180: }
7181: }
7182: }
7183: }
7184: }
7185: if ($noprint) {
7186: return <<"ENDSTYLE";
7187: <style type="text/css" media="print">
7188: body { display:none }
7189: </style>
7190: ENDSTYLE
7191: }
7192: }
7193: return;
7194: }
7195:
7196: =pod
7197:
1.341 albertel 7198: =item * &xml_begin()
7199:
7200: Returns the needed doctype and <html>
7201:
7202: Inputs: none
7203:
7204: =cut
7205:
7206: sub xml_begin {
7207: my $output='';
7208:
7209: if ($env{'browser.mathml'}) {
7210: $output='<?xml version="1.0"?>'
7211: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
7212: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
7213:
7214: # .'<!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">] >'
7215: .'<!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">'
7216: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
7217: .'xmlns="http://www.w3.org/1999/xhtml">';
7218: } else {
1.849 bisitz 7219: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
7220: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341 albertel 7221: }
7222: return $output;
7223: }
1.340 albertel 7224:
7225: =pod
7226:
1.306 albertel 7227: =item * &start_page()
7228:
7229: Returns a complete <html> .. <body> section for LON-CAPA web pages.
7230:
1.648 raeburn 7231: Inputs:
7232:
7233: =over 4
7234:
7235: $title - optional title for the page
7236:
7237: $head_extra - optional extra HTML to incude inside the <head>
7238:
7239: $args - additional optional args supported are:
7240:
7241: =over 8
7242:
7243: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 7244: arg on
1.814 bisitz 7245: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 7246: add_entries -> additional attributes to add to the <body>
7247: domain -> force to color decorate a page for a
1.317 albertel 7248: specific domain
1.648 raeburn 7249: function -> force usage of a specific rolish color
1.317 albertel 7250: scheme
1.648 raeburn 7251: redirect -> see &headtag()
7252: bgcolor -> override the default page bg color
7253: js_ready -> return a string ready for being used in
1.317 albertel 7254: a javascript writeln
1.648 raeburn 7255: html_encode -> return a string ready for being used in
1.320 albertel 7256: a html attribute
1.648 raeburn 7257: force_register -> if is true will turn on the &bodytag()
1.317 albertel 7258: $forcereg arg
1.648 raeburn 7259: frameset -> if true will start with a <frameset>
1.330 albertel 7260: rather than <body>
1.648 raeburn 7261: skip_phases -> hash ref of
1.338 albertel 7262: head -> skip the <html><head> generation
7263: body -> skip all <body> generation
1.648 raeburn 7264: no_auto_mt_title -> prevent &mt()ing the title arg
7265: inherit_jsmath -> when creating popup window in a page,
7266: should it have jsmath forced on by the
7267: current page
1.867 kalberla 7268: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 7269: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.361 albertel 7270:
1.648 raeburn 7271: =back
1.460 albertel 7272:
1.648 raeburn 7273: =back
1.562 albertel 7274:
1.306 albertel 7275: =cut
7276:
7277: sub start_page {
1.309 albertel 7278: my ($title,$head_extra,$args) = @_;
1.318 albertel 7279: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319 albertel 7280:
1.315 albertel 7281: $env{'internal.start_page'}++;
1.338 albertel 7282: my $result;
1.964 droeschl 7283:
1.338 albertel 7284: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1030 www 7285: $result .= &xml_begin() . &headtag($title, $head_extra, $args);
1.338 albertel 7286: }
7287:
7288: if (! exists($args->{'skip_phases'}{'body'}) ) {
7289: if ($args->{'frameset'}) {
7290: my $attr_string = &make_attr_string($args->{'force_register'},
7291: $args->{'add_entries'});
7292: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 7293: } else {
7294: $result .=
7295: &bodytag($title,
7296: $args->{'function'}, $args->{'add_entries'},
7297: $args->{'only_body'}, $args->{'domain'},
7298: $args->{'force_register'}, $args->{'no_nav_bar'},
1.962 droeschl 7299: $args->{'bgcolor'}, $args);
1.831 bisitz 7300: }
1.330 albertel 7301: }
1.338 albertel 7302:
1.315 albertel 7303: if ($args->{'js_ready'}) {
1.713 kaisler 7304: $result = &js_ready($result);
1.315 albertel 7305: }
1.320 albertel 7306: if ($args->{'html_encode'}) {
1.713 kaisler 7307: $result = &html_encode($result);
7308: }
7309:
1.813 bisitz 7310: # Preparation for new and consistent functionlist at top of screen
7311: # if ($args->{'functionlist'}) {
7312: # $result .= &build_functionlist();
7313: #}
7314:
1.964 droeschl 7315: # Don't add anything more if only_body wanted or in const space
7316: return $result if $args->{'only_body'}
7317: || $env{'request.state'} eq 'construct';
1.813 bisitz 7318:
7319: #Breadcrumbs
1.758 kaisler 7320: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
7321: &Apache::lonhtmlcommon::clear_breadcrumbs();
7322: #if any br links exists, add them to the breadcrumbs
7323: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
7324: foreach my $crumb (@{$args->{'bread_crumbs'}}){
7325: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
7326: }
7327: }
7328:
7329: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
7330: if(exists($args->{'bread_crumbs_component'})){
7331: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
7332: }else{
7333: $result .= &Apache::lonhtmlcommon::breadcrumbs();
7334: }
1.320 albertel 7335: }
1.315 albertel 7336: return $result;
1.306 albertel 7337: }
7338:
7339: sub end_page {
1.315 albertel 7340: my ($args) = @_;
7341: $env{'internal.end_page'}++;
1.330 albertel 7342: my $result;
1.335 albertel 7343: if ($args->{'discussion'}) {
7344: my ($target,$parser);
7345: if (ref($args->{'discussion'})) {
7346: ($target,$parser) =($args->{'discussion'}{'target'},
7347: $args->{'discussion'}{'parser'});
7348: }
7349: $result .= &Apache::lonxml::xmlend($target,$parser);
7350: }
1.330 albertel 7351: if ($args->{'frameset'}) {
7352: $result .= '</frameset>';
7353: } else {
1.635 raeburn 7354: $result .= &endbodytag($args);
1.330 albertel 7355: }
7356: $result .= "\n</html>";
7357:
1.315 albertel 7358: if ($args->{'js_ready'}) {
1.317 albertel 7359: $result = &js_ready($result);
1.315 albertel 7360: }
1.335 albertel 7361:
1.320 albertel 7362: if ($args->{'html_encode'}) {
7363: $result = &html_encode($result);
7364: }
1.335 albertel 7365:
1.315 albertel 7366: return $result;
7367: }
7368:
1.1034 www 7369: sub wishlist_window {
7370: return(<<'ENDWISHLIST');
1.1046 raeburn 7371: <script type="text/javascript">
1.1034 www 7372: // <![CDATA[
7373: // <!-- BEGIN LON-CAPA Internal
7374: function set_wishlistlink(title, path) {
7375: if (!title) {
7376: title = document.title;
7377: title = title.replace(/^LON-CAPA /,'');
7378: }
7379: if (!path) {
7380: path = location.pathname;
7381: }
7382: Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
7383: 'wishlistNewLink','width=560,height=350,scrollbars=0');
7384: }
7385: // END LON-CAPA Internal -->
7386: // ]]>
7387: </script>
7388: ENDWISHLIST
7389: }
7390:
1.1030 www 7391: sub modal_window {
7392: return(<<'ENDMODAL');
1.1046 raeburn 7393: <script type="text/javascript">
1.1030 www 7394: // <![CDATA[
7395: // <!-- BEGIN LON-CAPA Internal
7396: var modalWindow = {
7397: parent:"body",
7398: windowId:null,
7399: content:null,
7400: width:null,
7401: height:null,
7402: close:function()
7403: {
7404: $(".LCmodal-window").remove();
7405: $(".LCmodal-overlay").remove();
7406: },
7407: open:function()
7408: {
7409: var modal = "";
7410: modal += "<div class=\"LCmodal-overlay\"></div>";
7411: modal += "<div id=\"" + this.windowId + "\" class=\"LCmodal-window\" style=\"width:" + this.width + "px; height:" + this.height + "px; margin-top:-" + (this.height / 2) + "px; margin-left:-" + (this.width / 2) + "px;\">";
7412: modal += this.content;
7413: modal += "</div>";
7414:
7415: $(this.parent).append(modal);
7416:
7417: $(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
7418: $(".LCclose-window").click(function(){modalWindow.close();});
7419: $(".LCmodal-overlay").click(function(){modalWindow.close();});
7420: }
7421: };
1.1031 www 7422: var openMyModal = function(source,width,height,scrolling)
1.1030 www 7423: {
7424: modalWindow.windowId = "myModal";
7425: modalWindow.width = width;
7426: modalWindow.height = height;
1.1031 www 7427: modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='true' src='" + source + "'></iframe>";
1.1030 www 7428: modalWindow.open();
7429: };
7430: // END LON-CAPA Internal -->
7431: // ]]>
7432: </script>
7433: ENDMODAL
7434: }
7435:
7436: sub modal_link {
1.1052 www 7437: my ($link,$linktext,$width,$height,$target,$scrolling,$title)=@_;
1.1030 www 7438: unless ($width) { $width=480; }
7439: unless ($height) { $height=400; }
1.1031 www 7440: unless ($scrolling) { $scrolling='yes'; }
1.1074 raeburn 7441: my $target_attr;
7442: if (defined($target)) {
7443: $target_attr = 'target="'.$target.'"';
7444: }
7445: return <<"ENDLINK";
7446: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling'); return false;">
7447: $linktext</a>
7448: ENDLINK
1.1030 www 7449: }
7450:
1.1032 www 7451: sub modal_adhoc_script {
7452: my ($funcname,$width,$height,$content)=@_;
7453: return (<<ENDADHOC);
1.1046 raeburn 7454: <script type="text/javascript">
1.1032 www 7455: // <![CDATA[
7456: var $funcname = function()
7457: {
7458: modalWindow.windowId = "myModal";
7459: modalWindow.width = $width;
7460: modalWindow.height = $height;
7461: modalWindow.content = '$content';
7462: modalWindow.open();
7463: };
7464: // ]]>
7465: </script>
7466: ENDADHOC
7467: }
7468:
1.1041 www 7469: sub modal_adhoc_inner {
7470: my ($funcname,$width,$height,$content)=@_;
7471: my $innerwidth=$width-20;
7472: $content=&js_ready(
1.1042 www 7473: &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
1.1041 www 7474: &start_scrollbox($width.'px',$innerwidth.'px',$height.'px').
7475: $content.
7476: &end_scrollbox().
7477: &end_page()
7478: );
7479: return &modal_adhoc_script($funcname,$width,$height,$content);
7480: }
7481:
7482: sub modal_adhoc_window {
7483: my ($funcname,$width,$height,$content,$linktext)=@_;
7484: return &modal_adhoc_inner($funcname,$width,$height,$content).
7485: "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
7486: }
7487:
7488: sub modal_adhoc_launch {
7489: my ($funcname,$width,$height,$content)=@_;
7490: return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
7491: <script type="text/javascript">
7492: // <![CDATA[
7493: $funcname();
7494: // ]]>
7495: </script>
7496: ENDLAUNCH
7497: }
7498:
7499: sub modal_adhoc_close {
7500: return (<<ENDCLOSE);
7501: <script type="text/javascript">
7502: // <![CDATA[
7503: modalWindow.close();
7504: // ]]>
7505: </script>
7506: ENDCLOSE
7507: }
7508:
1.1038 www 7509: sub togglebox_script {
7510: return(<<ENDTOGGLE);
7511: <script type="text/javascript">
7512: // <![CDATA[
7513: function LCtoggleDisplay(id,hidetext,showtext) {
7514: link = document.getElementById(id + "link").childNodes[0];
7515: with (document.getElementById(id).style) {
7516: if (display == "none" ) {
7517: display = "inline";
7518: link.nodeValue = hidetext;
7519: } else {
7520: display = "none";
7521: link.nodeValue = showtext;
7522: }
7523: }
7524: }
7525: // ]]>
7526: </script>
7527: ENDTOGGLE
7528: }
7529:
1.1039 www 7530: sub start_togglebox {
7531: my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
7532: unless ($heading) { $heading=''; } else { $heading.=' '; }
7533: unless ($showtext) { $showtext=&mt('show'); }
7534: unless ($hidetext) { $hidetext=&mt('hide'); }
7535: unless ($headerbg) { $headerbg='#FFFFFF'; }
7536: return &start_data_table().
7537: &start_data_table_header_row().
7538: '<td bgcolor="'.$headerbg.'">'.$heading.
7539: '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
7540: $showtext.'\')">'.$showtext.'</a>]</td>'.
7541: &end_data_table_header_row().
7542: '<tr id="'.$id.'" style="display:none""><td>';
7543: }
7544:
7545: sub end_togglebox {
7546: return '</td></tr>'.&end_data_table();
7547: }
7548:
1.1041 www 7549: sub LCprogressbar_script {
1.1045 www 7550: my ($id)=@_;
1.1041 www 7551: return(<<ENDPROGRESS);
7552: <script type="text/javascript">
7553: // <![CDATA[
1.1045 www 7554: \$('#progressbar$id').progressbar({
1.1041 www 7555: value: 0,
7556: change: function(event, ui) {
7557: var newVal = \$(this).progressbar('option', 'value');
7558: \$('.pblabel', this).text(LCprogressTxt);
7559: }
7560: });
7561: // ]]>
7562: </script>
7563: ENDPROGRESS
7564: }
7565:
7566: sub LCprogressbarUpdate_script {
7567: return(<<ENDPROGRESSUPDATE);
7568: <style type="text/css">
7569: .ui-progressbar { position:relative; }
7570: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
7571: </style>
7572: <script type="text/javascript">
7573: // <![CDATA[
1.1045 www 7574: var LCprogressTxt='---';
7575:
7576: function LCupdateProgress(percent,progresstext,id) {
1.1041 www 7577: LCprogressTxt=progresstext;
1.1045 www 7578: \$('#progressbar'+id).progressbar('value',percent);
1.1041 www 7579: }
7580: // ]]>
7581: </script>
7582: ENDPROGRESSUPDATE
7583: }
7584:
1.1042 www 7585: my $LClastpercent;
1.1045 www 7586: my $LCidcnt;
7587: my $LCcurrentid;
1.1042 www 7588:
1.1041 www 7589: sub LCprogressbar {
1.1042 www 7590: my ($r)=(@_);
7591: $LClastpercent=0;
1.1045 www 7592: $LCidcnt++;
7593: $LCcurrentid=$$.'_'.$LCidcnt;
1.1041 www 7594: my $starting=&mt('Starting');
7595: my $content=(<<ENDPROGBAR);
7596: <p>
1.1045 www 7597: <div id="progressbar$LCcurrentid">
1.1041 www 7598: <span class="pblabel">$starting</span>
7599: </div>
7600: </p>
7601: ENDPROGBAR
1.1045 www 7602: &r_print($r,$content.&LCprogressbar_script($LCcurrentid));
1.1041 www 7603: }
7604:
7605: sub LCprogressbarUpdate {
1.1042 www 7606: my ($r,$val,$text)=@_;
7607: unless ($val) {
7608: if ($LClastpercent) {
7609: $val=$LClastpercent;
7610: } else {
7611: $val=0;
7612: }
7613: }
1.1041 www 7614: if ($val<0) { $val=0; }
7615: if ($val>100) { $val=0; }
1.1042 www 7616: $LClastpercent=$val;
1.1041 www 7617: unless ($text) { $text=$val.'%'; }
7618: $text=&js_ready($text);
1.1044 www 7619: &r_print($r,<<ENDUPDATE);
1.1041 www 7620: <script type="text/javascript">
7621: // <![CDATA[
1.1045 www 7622: LCupdateProgress($val,'$text','$LCcurrentid');
1.1041 www 7623: // ]]>
7624: </script>
7625: ENDUPDATE
1.1035 www 7626: }
7627:
1.1042 www 7628: sub LCprogressbarClose {
7629: my ($r)=@_;
7630: $LClastpercent=0;
1.1044 www 7631: &r_print($r,<<ENDCLOSE);
1.1042 www 7632: <script type="text/javascript">
7633: // <![CDATA[
1.1045 www 7634: \$("#progressbar$LCcurrentid").hide('slow');
1.1042 www 7635: // ]]>
7636: </script>
7637: ENDCLOSE
1.1044 www 7638: }
7639:
7640: sub r_print {
7641: my ($r,$to_print)=@_;
7642: if ($r) {
7643: $r->print($to_print);
7644: $r->rflush();
7645: } else {
7646: print($to_print);
7647: }
1.1042 www 7648: }
7649:
1.320 albertel 7650: sub html_encode {
7651: my ($result) = @_;
7652:
1.322 albertel 7653: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 7654:
7655: return $result;
7656: }
1.1044 www 7657:
1.317 albertel 7658: sub js_ready {
7659: my ($result) = @_;
7660:
1.323 albertel 7661: $result =~ s/[\n\r]/ /xmsg;
7662: $result =~ s/\\/\\\\/xmsg;
7663: $result =~ s/'/\\'/xmsg;
1.372 albertel 7664: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 7665:
7666: return $result;
7667: }
7668:
1.315 albertel 7669: sub validate_page {
7670: if ( exists($env{'internal.start_page'})
1.316 albertel 7671: && $env{'internal.start_page'} > 1) {
7672: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 7673: $env{'internal.start_page'}.' '.
1.316 albertel 7674: $ENV{'request.filename'});
1.315 albertel 7675: }
7676: if ( exists($env{'internal.end_page'})
1.316 albertel 7677: && $env{'internal.end_page'} > 1) {
7678: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 7679: $env{'internal.end_page'}.' '.
1.316 albertel 7680: $env{'request.filename'});
1.315 albertel 7681: }
7682: if ( exists($env{'internal.start_page'})
7683: && ! exists($env{'internal.end_page'})) {
1.316 albertel 7684: &Apache::lonnet::logthis('start_page called without end_page '.
7685: $env{'request.filename'});
1.315 albertel 7686: }
7687: if ( ! exists($env{'internal.start_page'})
7688: && exists($env{'internal.end_page'})) {
1.316 albertel 7689: &Apache::lonnet::logthis('end_page called without start_page'.
7690: $env{'request.filename'});
1.315 albertel 7691: }
1.306 albertel 7692: }
1.315 albertel 7693:
1.996 www 7694:
7695: sub start_scrollbox {
1.1075 raeburn 7696: my ($outerwidth,$width,$height,$id,$bgcolor)=@_;
1.998 raeburn 7697: unless ($outerwidth) { $outerwidth='520px'; }
7698: unless ($width) { $width='500px'; }
7699: unless ($height) { $height='200px'; }
1.1075 raeburn 7700: my ($table_id,$div_id,$tdcol);
1.1018 raeburn 7701: if ($id ne '') {
1.1020 raeburn 7702: $table_id = " id='table_$id'";
7703: $div_id = " id='div_$id'";
1.1018 raeburn 7704: }
1.1075 raeburn 7705: if ($bgcolor ne '') {
7706: $tdcol = "background-color: $bgcolor;";
7707: }
7708: return <<"END";
7709: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol"><div style="overflow:auto; width:$width; height: $height;"$div_id>
7710: END
1.996 www 7711: }
7712:
7713: sub end_scrollbox {
1.1036 www 7714: return '</div></td></tr></table>';
1.996 www 7715: }
7716:
1.318 albertel 7717: sub simple_error_page {
7718: my ($r,$title,$msg) = @_;
7719: my $page =
7720: &Apache::loncommon::start_page($title).
7721: &mt($msg).
7722: &Apache::loncommon::end_page();
7723: if (ref($r)) {
7724: $r->print($page);
1.327 albertel 7725: return;
1.318 albertel 7726: }
7727: return $page;
7728: }
1.347 albertel 7729:
7730: {
1.610 albertel 7731: my @row_count;
1.961 onken 7732:
7733: sub start_data_table_count {
7734: unshift(@row_count, 0);
7735: return;
7736: }
7737:
7738: sub end_data_table_count {
7739: shift(@row_count);
7740: return;
7741: }
7742:
1.347 albertel 7743: sub start_data_table {
1.1018 raeburn 7744: my ($add_class,$id) = @_;
1.422 albertel 7745: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 7746: my $table_id;
7747: if (defined($id)) {
7748: $table_id = ' id="'.$id.'"';
7749: }
1.961 onken 7750: &start_data_table_count();
1.1018 raeburn 7751: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 7752: }
7753:
7754: sub end_data_table {
1.961 onken 7755: &end_data_table_count();
1.389 albertel 7756: return '</table>'."\n";;
1.347 albertel 7757: }
7758:
7759: sub start_data_table_row {
1.974 wenzelju 7760: my ($add_class, $id) = @_;
1.610 albertel 7761: $row_count[0]++;
7762: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 7763: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 7764: $id = (' id="'.$id.'"') unless ($id eq '');
7765: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 7766: }
1.471 banghart 7767:
7768: sub continue_data_table_row {
1.974 wenzelju 7769: my ($add_class, $id) = @_;
1.610 albertel 7770: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 7771: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
7772: $id = (' id="'.$id.'"') unless ($id eq '');
7773: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 7774: }
1.347 albertel 7775:
7776: sub end_data_table_row {
1.389 albertel 7777: return '</tr>'."\n";;
1.347 albertel 7778: }
1.367 www 7779:
1.421 albertel 7780: sub start_data_table_empty_row {
1.707 bisitz 7781: # $row_count[0]++;
1.421 albertel 7782: return '<tr class="LC_empty_row" >'."\n";;
7783: }
7784:
7785: sub end_data_table_empty_row {
7786: return '</tr>'."\n";;
7787: }
7788:
1.367 www 7789: sub start_data_table_header_row {
1.389 albertel 7790: return '<tr class="LC_header_row">'."\n";;
1.367 www 7791: }
7792:
7793: sub end_data_table_header_row {
1.389 albertel 7794: return '</tr>'."\n";;
1.367 www 7795: }
1.890 droeschl 7796:
7797: sub data_table_caption {
7798: my $caption = shift;
7799: return "<caption class=\"LC_caption\">$caption</caption>";
7800: }
1.347 albertel 7801: }
7802:
1.548 albertel 7803: =pod
7804:
7805: =item * &inhibit_menu_check($arg)
7806:
7807: Checks for a inhibitmenu state and generates output to preserve it
7808:
7809: Inputs: $arg - can be any of
7810: - undef - in which case the return value is a string
7811: to add into arguments list of a uri
7812: - 'input' - in which case the return value is a HTML
7813: <form> <input> field of type hidden to
7814: preserve the value
7815: - a url - in which case the return value is the url with
7816: the neccesary cgi args added to preserve the
7817: inhibitmenu state
7818: - a ref to a url - no return value, but the string is
7819: updated to include the neccessary cgi
7820: args to preserve the inhibitmenu state
7821:
7822: =cut
7823:
7824: sub inhibit_menu_check {
7825: my ($arg) = @_;
7826: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
7827: if ($arg eq 'input') {
7828: if ($env{'form.inhibitmenu'}) {
7829: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
7830: } else {
7831: return
7832: }
7833: }
7834: if ($env{'form.inhibitmenu'}) {
7835: if (ref($arg)) {
7836: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7837: } elsif ($arg eq '') {
7838: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
7839: } else {
7840: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7841: }
7842: }
7843: if (!ref($arg)) {
7844: return $arg;
7845: }
7846: }
7847:
1.251 albertel 7848: ###############################################
1.182 matthew 7849:
7850: =pod
7851:
1.549 albertel 7852: =back
7853:
7854: =head1 User Information Routines
7855:
7856: =over 4
7857:
1.405 albertel 7858: =item * &get_users_function()
1.182 matthew 7859:
7860: Used by &bodytag to determine the current users primary role.
7861: Returns either 'student','coordinator','admin', or 'author'.
7862:
7863: =cut
7864:
7865: ###############################################
7866: sub get_users_function {
1.815 tempelho 7867: my $function = 'norole';
1.818 tempelho 7868: if ($env{'request.role'}=~/^(st)/) {
7869: $function='student';
7870: }
1.907 raeburn 7871: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 7872: $function='coordinator';
7873: }
1.258 albertel 7874: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 7875: $function='admin';
7876: }
1.826 bisitz 7877: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025 raeburn 7878: ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182 matthew 7879: $function='author';
7880: }
7881: return $function;
1.54 www 7882: }
1.99 www 7883:
7884: ###############################################
7885:
1.233 raeburn 7886: =pod
7887:
1.821 raeburn 7888: =item * &show_course()
7889:
7890: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
7891: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
7892:
7893: Inputs:
7894: None
7895:
7896: Outputs:
7897: Scalar: 1 if 'Course' to be used, 0 otherwise.
7898:
7899: =cut
7900:
7901: ###############################################
7902: sub show_course {
7903: my $course = !$env{'user.adv'};
7904: if (!$env{'user.adv'}) {
7905: foreach my $env (keys(%env)) {
7906: next if ($env !~ m/^user\.priv\./);
7907: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
7908: $course = 0;
7909: last;
7910: }
7911: }
7912: }
7913: return $course;
7914: }
7915:
7916: ###############################################
7917:
7918: =pod
7919:
1.542 raeburn 7920: =item * &check_user_status()
1.274 raeburn 7921:
7922: Determines current status of supplied role for a
7923: specific user. Roles can be active, previous or future.
7924:
7925: Inputs:
7926: user's domain, user's username, course's domain,
1.375 raeburn 7927: course's number, optional section ID.
1.274 raeburn 7928:
7929: Outputs:
7930: role status: active, previous or future.
7931:
7932: =cut
7933:
7934: sub check_user_status {
1.412 raeburn 7935: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073 raeburn 7936: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.274 raeburn 7937: my @uroles = keys %userinfo;
7938: my $srchstr;
7939: my $active_chk = 'none';
1.412 raeburn 7940: my $now = time;
1.274 raeburn 7941: if (@uroles > 0) {
1.908 raeburn 7942: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 7943: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
7944: } else {
1.412 raeburn 7945: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
7946: }
7947: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 7948: my $role_end = 0;
7949: my $role_start = 0;
7950: $active_chk = 'active';
1.412 raeburn 7951: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
7952: $role_end = $1;
7953: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
7954: $role_start = $1;
1.274 raeburn 7955: }
7956: }
7957: if ($role_start > 0) {
1.412 raeburn 7958: if ($now < $role_start) {
1.274 raeburn 7959: $active_chk = 'future';
7960: }
7961: }
7962: if ($role_end > 0) {
1.412 raeburn 7963: if ($now > $role_end) {
1.274 raeburn 7964: $active_chk = 'previous';
7965: }
7966: }
7967: }
7968: }
7969: return $active_chk;
7970: }
7971:
7972: ###############################################
7973:
7974: =pod
7975:
1.405 albertel 7976: =item * &get_sections()
1.233 raeburn 7977:
7978: Determines all the sections for a course including
7979: sections with students and sections containing other roles.
1.419 raeburn 7980: Incoming parameters:
7981:
7982: 1. domain
7983: 2. course number
7984: 3. reference to array containing roles for which sections should
7985: be gathered (optional).
7986: 4. reference to array containing status types for which sections
7987: should be gathered (optional).
7988:
7989: If the third argument is undefined, sections are gathered for any role.
7990: If the fourth argument is undefined, sections are gathered for any status.
7991: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 7992:
1.374 raeburn 7993: Returns section hash (keys are section IDs, values are
7994: number of users in each section), subject to the
1.419 raeburn 7995: optional roles filter, optional status filter
1.233 raeburn 7996:
7997: =cut
7998:
7999: ###############################################
8000: sub get_sections {
1.419 raeburn 8001: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 8002: if (!defined($cdom) || !defined($cnum)) {
8003: my $cid = $env{'request.course.id'};
8004:
8005: return if (!defined($cid));
8006:
8007: $cdom = $env{'course.'.$cid.'.domain'};
8008: $cnum = $env{'course.'.$cid.'.num'};
8009: }
8010:
8011: my %sectioncount;
1.419 raeburn 8012: my $now = time;
1.240 albertel 8013:
1.366 albertel 8014: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 8015: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 8016: my $sec_index = &Apache::loncoursedata::CL_SECTION();
8017: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 8018: my $start_index = &Apache::loncoursedata::CL_START();
8019: my $end_index = &Apache::loncoursedata::CL_END();
8020: my $status;
1.366 albertel 8021: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 8022: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
8023: $data->[$status_index],
8024: $data->[$start_index],
8025: $data->[$end_index]);
8026: if ($stu_status eq 'Active') {
8027: $status = 'active';
8028: } elsif ($end < $now) {
8029: $status = 'previous';
8030: } elsif ($start > $now) {
8031: $status = 'future';
8032: }
8033: if ($section ne '-1' && $section !~ /^\s*$/) {
8034: if ((!defined($possible_status)) || (($status ne '') &&
8035: (grep/^\Q$status\E$/,@{$possible_status}))) {
8036: $sectioncount{$section}++;
8037: }
1.240 albertel 8038: }
8039: }
8040: }
8041: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8042: foreach my $user (sort(keys(%courseroles))) {
8043: if ($user !~ /^(\w{2})/) { next; }
8044: my ($role) = ($user =~ /^(\w{2})/);
8045: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 8046: my ($section,$status);
1.240 albertel 8047: if ($role eq 'cr' &&
8048: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
8049: $section=$1;
8050: }
8051: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
8052: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 8053: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
8054: if ($end == -1 && $start == -1) {
8055: next; #deleted role
8056: }
8057: if (!defined($possible_status)) {
8058: $sectioncount{$section}++;
8059: } else {
8060: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
8061: $status = 'active';
8062: } elsif ($end < $now) {
8063: $status = 'future';
8064: } elsif ($start > $now) {
8065: $status = 'previous';
8066: }
8067: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
8068: $sectioncount{$section}++;
8069: }
8070: }
1.233 raeburn 8071: }
1.366 albertel 8072: return %sectioncount;
1.233 raeburn 8073: }
8074:
1.274 raeburn 8075: ###############################################
1.294 raeburn 8076:
8077: =pod
1.405 albertel 8078:
8079: =item * &get_course_users()
8080:
1.275 raeburn 8081: Retrieves usernames:domains for users in the specified course
8082: with specific role(s), and access status.
8083:
8084: Incoming parameters:
1.277 albertel 8085: 1. course domain
8086: 2. course number
8087: 3. access status: users must have - either active,
1.275 raeburn 8088: previous, future, or all.
1.277 albertel 8089: 4. reference to array of permissible roles
1.288 raeburn 8090: 5. reference to array of section restrictions (optional)
8091: 6. reference to results object (hash of hashes).
8092: 7. reference to optional userdata hash
1.609 raeburn 8093: 8. reference to optional statushash
1.630 raeburn 8094: 9. flag if privileged users (except those set to unhide in
8095: course settings) should be excluded
1.609 raeburn 8096: Keys of top level results hash are roles.
1.275 raeburn 8097: Keys of inner hashes are username:domain, with
8098: values set to access type.
1.288 raeburn 8099: Optional userdata hash returns an array with arguments in the
8100: same order as loncoursedata::get_classlist() for student data.
8101:
1.609 raeburn 8102: Optional statushash returns
8103:
1.288 raeburn 8104: Entries for end, start, section and status are blank because
8105: of the possibility of multiple values for non-student roles.
8106:
1.275 raeburn 8107: =cut
1.405 albertel 8108:
1.275 raeburn 8109: ###############################################
1.405 albertel 8110:
1.275 raeburn 8111: sub get_course_users {
1.630 raeburn 8112: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 8113: my %idx = ();
1.419 raeburn 8114: my %seclists;
1.288 raeburn 8115:
8116: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
8117: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
8118: $idx{end} = &Apache::loncoursedata::CL_END();
8119: $idx{start} = &Apache::loncoursedata::CL_START();
8120: $idx{id} = &Apache::loncoursedata::CL_ID();
8121: $idx{section} = &Apache::loncoursedata::CL_SECTION();
8122: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
8123: $idx{status} = &Apache::loncoursedata::CL_STATUS();
8124:
1.290 albertel 8125: if (grep(/^st$/,@{$roles})) {
1.276 albertel 8126: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 8127: my $now = time;
1.277 albertel 8128: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 8129: my $match = 0;
1.412 raeburn 8130: my $secmatch = 0;
1.419 raeburn 8131: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 8132: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 8133: if ($section eq '') {
8134: $section = 'none';
8135: }
1.291 albertel 8136: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 8137: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 8138: $secmatch = 1;
8139: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 8140: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 8141: $secmatch = 1;
8142: }
8143: } else {
1.419 raeburn 8144: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 8145: $secmatch = 1;
8146: }
1.290 albertel 8147: }
1.412 raeburn 8148: if (!$secmatch) {
8149: next;
8150: }
1.419 raeburn 8151: }
1.275 raeburn 8152: if (defined($$types{'active'})) {
1.288 raeburn 8153: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 8154: push(@{$$users{st}{$student}},'active');
1.288 raeburn 8155: $match = 1;
1.275 raeburn 8156: }
8157: }
8158: if (defined($$types{'previous'})) {
1.609 raeburn 8159: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 8160: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 8161: $match = 1;
1.275 raeburn 8162: }
8163: }
8164: if (defined($$types{'future'})) {
1.609 raeburn 8165: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 8166: push(@{$$users{st}{$student}},'future');
1.288 raeburn 8167: $match = 1;
1.275 raeburn 8168: }
8169: }
1.609 raeburn 8170: if ($match) {
8171: push(@{$seclists{$student}},$section);
8172: if (ref($userdata) eq 'HASH') {
8173: $$userdata{$student} = $$classlist{$student};
8174: }
8175: if (ref($statushash) eq 'HASH') {
8176: $statushash->{$student}{'st'}{$section} = $status;
8177: }
1.288 raeburn 8178: }
1.275 raeburn 8179: }
8180: }
1.412 raeburn 8181: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 8182: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8183: my $now = time;
1.609 raeburn 8184: my %displaystatus = ( previous => 'Expired',
8185: active => 'Active',
8186: future => 'Future',
8187: );
1.630 raeburn 8188: my %nothide;
8189: if ($hidepriv) {
8190: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
8191: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
8192: if ($user !~ /:/) {
8193: $nothide{join(':',split(/[\@]/,$user))}=1;
8194: } else {
8195: $nothide{$user} = 1;
8196: }
8197: }
8198: }
1.439 raeburn 8199: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 8200: my $match = 0;
1.412 raeburn 8201: my $secmatch = 0;
1.439 raeburn 8202: my $status;
1.412 raeburn 8203: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 8204: $user =~ s/:$//;
1.439 raeburn 8205: my ($end,$start) = split(/:/,$coursepersonnel{$person});
8206: if ($end == -1 || $start == -1) {
8207: next;
8208: }
8209: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
8210: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 8211: my ($uname,$udom) = split(/:/,$user);
8212: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 8213: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 8214: $secmatch = 1;
8215: } elsif ($usec eq '') {
1.420 albertel 8216: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 8217: $secmatch = 1;
8218: }
8219: } else {
8220: if (grep(/^\Q$usec\E$/,@{$sections})) {
8221: $secmatch = 1;
8222: }
8223: }
8224: if (!$secmatch) {
8225: next;
8226: }
1.288 raeburn 8227: }
1.419 raeburn 8228: if ($usec eq '') {
8229: $usec = 'none';
8230: }
1.275 raeburn 8231: if ($uname ne '' && $udom ne '') {
1.630 raeburn 8232: if ($hidepriv) {
8233: if ((&Apache::lonnet::privileged($uname,$udom)) &&
8234: (!$nothide{$uname.':'.$udom})) {
8235: next;
8236: }
8237: }
1.503 raeburn 8238: if ($end > 0 && $end < $now) {
1.439 raeburn 8239: $status = 'previous';
8240: } elsif ($start > $now) {
8241: $status = 'future';
8242: } else {
8243: $status = 'active';
8244: }
1.277 albertel 8245: foreach my $type (keys(%{$types})) {
1.275 raeburn 8246: if ($status eq $type) {
1.420 albertel 8247: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 8248: push(@{$$users{$role}{$user}},$type);
8249: }
1.288 raeburn 8250: $match = 1;
8251: }
8252: }
1.419 raeburn 8253: if (($match) && (ref($userdata) eq 'HASH')) {
8254: if (!exists($$userdata{$uname.':'.$udom})) {
8255: &get_user_info($udom,$uname,\%idx,$userdata);
8256: }
1.420 albertel 8257: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 8258: push(@{$seclists{$uname.':'.$udom}},$usec);
8259: }
1.609 raeburn 8260: if (ref($statushash) eq 'HASH') {
8261: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
8262: }
1.275 raeburn 8263: }
8264: }
8265: }
8266: }
1.290 albertel 8267: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 8268: if ((defined($cdom)) && (defined($cnum))) {
8269: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
8270: if ( defined($csettings{'internal.courseowner'}) ) {
8271: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 8272: next if ($owner eq '');
8273: my ($ownername,$ownerdom);
8274: if ($owner =~ /^([^:]+):([^:]+)$/) {
8275: $ownername = $1;
8276: $ownerdom = $2;
8277: } else {
8278: $ownername = $owner;
8279: $ownerdom = $cdom;
8280: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 8281: }
8282: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 8283: if (defined($userdata) &&
1.609 raeburn 8284: !exists($$userdata{$owner})) {
8285: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
8286: if (!grep(/^none$/,@{$seclists{$owner}})) {
8287: push(@{$seclists{$owner}},'none');
8288: }
8289: if (ref($statushash) eq 'HASH') {
8290: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 8291: }
1.290 albertel 8292: }
1.279 raeburn 8293: }
8294: }
8295: }
1.419 raeburn 8296: foreach my $user (keys(%seclists)) {
8297: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
8298: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
8299: }
1.275 raeburn 8300: }
8301: return;
8302: }
8303:
1.288 raeburn 8304: sub get_user_info {
8305: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 8306: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
8307: &plainname($uname,$udom,'lastname');
1.291 albertel 8308: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 8309: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 8310: my %idhash = &Apache::lonnet::idrget($udom,($uname));
8311: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 8312: return;
8313: }
1.275 raeburn 8314:
1.472 raeburn 8315: ###############################################
8316:
8317: =pod
8318:
8319: =item * &get_user_quota()
8320:
8321: Retrieves quota assigned for storage of portfolio files for a user
8322:
8323: Incoming parameters:
8324: 1. user's username
8325: 2. user's domain
8326:
8327: Returns:
1.536 raeburn 8328: 1. Disk quota (in Mb) assigned to student.
8329: 2. (Optional) Type of setting: custom or default
8330: (individually assigned or default for user's
8331: institutional status).
8332: 3. (Optional) - User's institutional status (e.g., faculty, staff
8333: or student - types as defined in localenroll::inst_usertypes
8334: for user's domain, which determines default quota for user.
8335: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 8336:
8337: If a value has been stored in the user's environment,
1.536 raeburn 8338: it will return that, otherwise it returns the maximal default
8339: defined for the user's instituional status(es) in the domain.
1.472 raeburn 8340:
8341: =cut
8342:
8343: ###############################################
8344:
8345:
8346: sub get_user_quota {
8347: my ($uname,$udom) = @_;
1.536 raeburn 8348: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 8349: if (!defined($udom)) {
8350: $udom = $env{'user.domain'};
8351: }
8352: if (!defined($uname)) {
8353: $uname = $env{'user.name'};
8354: }
8355: if (($udom eq '' || $uname eq '') ||
8356: ($udom eq 'public') && ($uname eq 'public')) {
8357: $quota = 0;
1.536 raeburn 8358: $quotatype = 'default';
8359: $defquota = 0;
1.472 raeburn 8360: } else {
1.536 raeburn 8361: my $inststatus;
1.472 raeburn 8362: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
8363: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 8364: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 8365: } else {
1.536 raeburn 8366: my %userenv =
8367: &Apache::lonnet::get('environment',['portfolioquota',
8368: 'inststatus'],$udom,$uname);
1.472 raeburn 8369: my ($tmp) = keys(%userenv);
8370: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
8371: $quota = $userenv{'portfolioquota'};
1.536 raeburn 8372: $inststatus = $userenv{'inststatus'};
1.472 raeburn 8373: } else {
8374: undef(%userenv);
8375: }
8376: }
1.536 raeburn 8377: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 8378: if ($quota eq '') {
1.536 raeburn 8379: $quota = $defquota;
8380: $quotatype = 'default';
8381: } else {
8382: $quotatype = 'custom';
1.472 raeburn 8383: }
8384: }
1.536 raeburn 8385: if (wantarray) {
8386: return ($quota,$quotatype,$settingstatus,$defquota);
8387: } else {
8388: return $quota;
8389: }
1.472 raeburn 8390: }
8391:
8392: ###############################################
8393:
8394: =pod
8395:
8396: =item * &default_quota()
8397:
1.536 raeburn 8398: Retrieves default quota assigned for storage of user portfolio files,
8399: given an (optional) user's institutional status.
1.472 raeburn 8400:
8401: Incoming parameters:
8402: 1. domain
1.536 raeburn 8403: 2. (Optional) institutional status(es). This is a : separated list of
8404: status types (e.g., faculty, staff, student etc.)
8405: which apply to the user for whom the default is being retrieved.
8406: If the institutional status string in undefined, the domain
8407: default quota will be returned.
1.472 raeburn 8408:
8409: Returns:
8410: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 8411: 2. (Optional) institutional type which determined the value of the
8412: default quota.
1.472 raeburn 8413:
8414: If a value has been stored in the domain's configuration db,
8415: it will return that, otherwise it returns 20 (for backwards
8416: compatibility with domains which have not set up a configuration
8417: db file; the original statically defined portfolio quota was 20 Mb).
8418:
1.536 raeburn 8419: If the user's status includes multiple types (e.g., staff and student),
8420: the largest default quota which applies to the user determines the
8421: default quota returned.
8422:
1.780 raeburn 8423: =back
8424:
1.472 raeburn 8425: =cut
8426:
8427: ###############################################
8428:
8429:
8430: sub default_quota {
1.536 raeburn 8431: my ($udom,$inststatus) = @_;
8432: my ($defquota,$settingstatus);
8433: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 8434: ['quotas'],$udom);
8435: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 8436: if ($inststatus ne '') {
1.765 raeburn 8437: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 8438: foreach my $item (@statuses) {
1.711 raeburn 8439: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
8440: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
8441: if ($defquota eq '') {
8442: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
8443: $settingstatus = $item;
8444: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
8445: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
8446: $settingstatus = $item;
8447: }
8448: }
8449: } else {
8450: if ($quotahash{'quotas'}{$item} ne '') {
8451: if ($defquota eq '') {
8452: $defquota = $quotahash{'quotas'}{$item};
8453: $settingstatus = $item;
8454: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
8455: $defquota = $quotahash{'quotas'}{$item};
8456: $settingstatus = $item;
8457: }
1.536 raeburn 8458: }
8459: }
8460: }
8461: }
8462: if ($defquota eq '') {
1.711 raeburn 8463: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
8464: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
8465: } else {
8466: $defquota = $quotahash{'quotas'}{'default'};
8467: }
1.536 raeburn 8468: $settingstatus = 'default';
8469: }
8470: } else {
8471: $settingstatus = 'default';
8472: $defquota = 20;
8473: }
8474: if (wantarray) {
8475: return ($defquota,$settingstatus);
1.472 raeburn 8476: } else {
1.536 raeburn 8477: return $defquota;
1.472 raeburn 8478: }
8479: }
8480:
1.384 raeburn 8481: sub get_secgrprole_info {
8482: my ($cdom,$cnum,$needroles,$type) = @_;
8483: my %sections_count = &get_sections($cdom,$cnum);
8484: my @sections = (sort {$a <=> $b} keys(%sections_count));
8485: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
8486: my @groups = sort(keys(%curr_groups));
8487: my $allroles = [];
8488: my $rolehash;
8489: my $accesshash = {
8490: active => 'Currently has access',
8491: future => 'Will have future access',
8492: previous => 'Previously had access',
8493: };
8494: if ($needroles) {
8495: $rolehash = {'all' => 'all'};
1.385 albertel 8496: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8497: if (&Apache::lonnet::error(%user_roles)) {
8498: undef(%user_roles);
8499: }
8500: foreach my $item (keys(%user_roles)) {
1.384 raeburn 8501: my ($role)=split(/\:/,$item,2);
8502: if ($role eq 'cr') { next; }
8503: if ($role =~ /^cr/) {
8504: $$rolehash{$role} = (split('/',$role))[3];
8505: } else {
8506: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
8507: }
8508: }
8509: foreach my $key (sort(keys(%{$rolehash}))) {
8510: push(@{$allroles},$key);
8511: }
8512: push (@{$allroles},'st');
8513: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
8514: }
8515: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
8516: }
8517:
1.555 raeburn 8518: sub user_picker {
1.994 raeburn 8519: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context) = @_;
1.555 raeburn 8520: my $currdom = $dom;
8521: my %curr_selected = (
8522: srchin => 'dom',
1.580 raeburn 8523: srchby => 'lastname',
1.555 raeburn 8524: );
8525: my $srchterm;
1.625 raeburn 8526: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 8527: if ($srch->{'srchby'} ne '') {
8528: $curr_selected{'srchby'} = $srch->{'srchby'};
8529: }
8530: if ($srch->{'srchin'} ne '') {
8531: $curr_selected{'srchin'} = $srch->{'srchin'};
8532: }
8533: if ($srch->{'srchtype'} ne '') {
8534: $curr_selected{'srchtype'} = $srch->{'srchtype'};
8535: }
8536: if ($srch->{'srchdomain'} ne '') {
8537: $currdom = $srch->{'srchdomain'};
8538: }
8539: $srchterm = $srch->{'srchterm'};
8540: }
8541: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 8542: 'usr' => 'Search criteria',
1.563 raeburn 8543: 'doma' => 'Domain/institution to search',
1.558 albertel 8544: 'uname' => 'username',
8545: 'lastname' => 'last name',
1.555 raeburn 8546: 'lastfirst' => 'last name, first name',
1.558 albertel 8547: 'crs' => 'in this course',
1.576 raeburn 8548: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 8549: 'alc' => 'all LON-CAPA',
1.573 raeburn 8550: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 8551: 'exact' => 'is',
8552: 'contains' => 'contains',
1.569 raeburn 8553: 'begins' => 'begins with',
1.571 raeburn 8554: 'youm' => "You must include some text to search for.",
8555: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
8556: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
8557: 'yomc' => "You must choose a domain when using an institutional directory search.",
8558: 'ymcd' => "You must choose a domain when using a domain search.",
8559: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
8560: 'whse' => "When searching by last,first you must include at least one character in the first name.",
8561: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 8562: );
1.563 raeburn 8563: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
8564: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 8565:
8566: my @srchins = ('crs','dom','alc','instd');
8567:
8568: foreach my $option (@srchins) {
8569: # FIXME 'alc' option unavailable until
8570: # loncreateuser::print_user_query_page()
8571: # has been completed.
8572: next if ($option eq 'alc');
1.880 raeburn 8573: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 8574: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 8575: if ($curr_selected{'srchin'} eq $option) {
8576: $srchinsel .= '
8577: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
8578: } else {
8579: $srchinsel .= '
8580: <option value="'.$option.'">'.$lt{$option}.'</option>';
8581: }
1.555 raeburn 8582: }
1.563 raeburn 8583: $srchinsel .= "\n </select>\n";
1.555 raeburn 8584:
8585: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 8586: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 8587: if ($curr_selected{'srchby'} eq $option) {
8588: $srchbysel .= '
8589: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
8590: } else {
8591: $srchbysel .= '
8592: <option value="'.$option.'">'.$lt{$option}.'</option>';
8593: }
8594: }
8595: $srchbysel .= "\n </select>\n";
8596:
8597: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 8598: foreach my $option ('begins','contains','exact') {
1.555 raeburn 8599: if ($curr_selected{'srchtype'} eq $option) {
8600: $srchtypesel .= '
8601: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
8602: } else {
8603: $srchtypesel .= '
8604: <option value="'.$option.'">'.$lt{$option}.'</option>';
8605: }
8606: }
8607: $srchtypesel .= "\n </select>\n";
8608:
1.558 albertel 8609: my ($newuserscript,$new_user_create);
1.994 raeburn 8610: my $context_dom = $env{'request.role.domain'};
8611: if ($context eq 'requestcrs') {
8612: if ($env{'form.coursedom'} ne '') {
8613: $context_dom = $env{'form.coursedom'};
8614: }
8615: }
1.556 raeburn 8616: if ($forcenewuser) {
1.576 raeburn 8617: if (ref($srch) eq 'HASH') {
1.994 raeburn 8618: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 8619: if ($cancreate) {
8620: $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>';
8621: } else {
1.799 bisitz 8622: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 8623: my %usertypetext = (
8624: official => 'institutional',
8625: unofficial => 'non-institutional',
8626: );
1.799 bisitz 8627: $new_user_create = '<p class="LC_warning">'
8628: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
8629: .' '
8630: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
8631: ,'<a href="'.$helplink.'">','</a>')
8632: .'</p><br />';
1.627 raeburn 8633: }
1.576 raeburn 8634: }
8635: }
8636:
1.556 raeburn 8637: $newuserscript = <<"ENDSCRIPT";
8638:
1.570 raeburn 8639: function setSearch(createnew,callingForm) {
1.556 raeburn 8640: if (createnew == 1) {
1.570 raeburn 8641: for (var i=0; i<callingForm.srchby.length; i++) {
8642: if (callingForm.srchby.options[i].value == 'uname') {
8643: callingForm.srchby.selectedIndex = i;
1.556 raeburn 8644: }
8645: }
1.570 raeburn 8646: for (var i=0; i<callingForm.srchin.length; i++) {
8647: if ( callingForm.srchin.options[i].value == 'dom') {
8648: callingForm.srchin.selectedIndex = i;
1.556 raeburn 8649: }
8650: }
1.570 raeburn 8651: for (var i=0; i<callingForm.srchtype.length; i++) {
8652: if (callingForm.srchtype.options[i].value == 'exact') {
8653: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 8654: }
8655: }
1.570 raeburn 8656: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 8657: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 8658: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 8659: }
8660: }
8661: }
8662: }
8663: ENDSCRIPT
1.558 albertel 8664:
1.556 raeburn 8665: }
8666:
1.555 raeburn 8667: my $output = <<"END_BLOCK";
1.556 raeburn 8668: <script type="text/javascript">
1.824 bisitz 8669: // <![CDATA[
1.570 raeburn 8670: function validateEntry(callingForm) {
1.558 albertel 8671:
1.556 raeburn 8672: var checkok = 1;
1.558 albertel 8673: var srchin;
1.570 raeburn 8674: for (var i=0; i<callingForm.srchin.length; i++) {
8675: if ( callingForm.srchin[i].checked ) {
8676: srchin = callingForm.srchin[i].value;
1.558 albertel 8677: }
8678: }
8679:
1.570 raeburn 8680: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
8681: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
8682: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
8683: var srchterm = callingForm.srchterm.value;
8684: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 8685: var msg = "";
8686:
8687: if (srchterm == "") {
8688: checkok = 0;
1.571 raeburn 8689: msg += "$lt{'youm'}\\n";
1.556 raeburn 8690: }
8691:
1.569 raeburn 8692: if (srchtype== 'begins') {
8693: if (srchterm.length < 2) {
8694: checkok = 0;
1.571 raeburn 8695: msg += "$lt{'thte'}\\n";
1.569 raeburn 8696: }
8697: }
8698:
1.556 raeburn 8699: if (srchtype== 'contains') {
8700: if (srchterm.length < 3) {
8701: checkok = 0;
1.571 raeburn 8702: msg += "$lt{'thet'}\\n";
1.556 raeburn 8703: }
8704: }
8705: if (srchin == 'instd') {
8706: if (srchdomain == '') {
8707: checkok = 0;
1.571 raeburn 8708: msg += "$lt{'yomc'}\\n";
1.556 raeburn 8709: }
8710: }
8711: if (srchin == 'dom') {
8712: if (srchdomain == '') {
8713: checkok = 0;
1.571 raeburn 8714: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 8715: }
8716: }
8717: if (srchby == 'lastfirst') {
8718: if (srchterm.indexOf(",") == -1) {
8719: checkok = 0;
1.571 raeburn 8720: msg += "$lt{'whus'}\\n";
1.556 raeburn 8721: }
8722: if (srchterm.indexOf(",") == srchterm.length -1) {
8723: checkok = 0;
1.571 raeburn 8724: msg += "$lt{'whse'}\\n";
1.556 raeburn 8725: }
8726: }
8727: if (checkok == 0) {
1.571 raeburn 8728: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 8729: return;
8730: }
8731: if (checkok == 1) {
1.570 raeburn 8732: callingForm.submit();
1.556 raeburn 8733: }
8734: }
8735:
8736: $newuserscript
8737:
1.824 bisitz 8738: // ]]>
1.556 raeburn 8739: </script>
1.558 albertel 8740:
8741: $new_user_create
8742:
1.555 raeburn 8743: END_BLOCK
1.558 albertel 8744:
1.876 raeburn 8745: $output .= &Apache::lonhtmlcommon::start_pick_box().
8746: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
8747: $domform.
8748: &Apache::lonhtmlcommon::row_closure().
8749: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
8750: $srchbysel.
8751: $srchtypesel.
8752: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
8753: $srchinsel.
8754: &Apache::lonhtmlcommon::row_closure(1).
8755: &Apache::lonhtmlcommon::end_pick_box().
8756: '<br />';
1.555 raeburn 8757: return $output;
8758: }
8759:
1.612 raeburn 8760: sub user_rule_check {
1.615 raeburn 8761: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 8762: my $response;
8763: if (ref($usershash) eq 'HASH') {
8764: foreach my $user (keys(%{$usershash})) {
8765: my ($uname,$udom) = split(/:/,$user);
8766: next if ($udom eq '' || $uname eq '');
1.615 raeburn 8767: my ($id,$newuser);
1.612 raeburn 8768: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 8769: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 8770: $id = $usershash->{$user}->{'id'};
8771: }
8772: my $inst_response;
8773: if (ref($checks) eq 'HASH') {
8774: if (defined($checks->{'username'})) {
1.615 raeburn 8775: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 8776: &Apache::lonnet::get_instuser($udom,$uname);
8777: } elsif (defined($checks->{'id'})) {
1.615 raeburn 8778: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 8779: &Apache::lonnet::get_instuser($udom,undef,$id);
8780: }
1.615 raeburn 8781: } else {
8782: ($inst_response,%{$inst_results->{$user}}) =
8783: &Apache::lonnet::get_instuser($udom,$uname);
8784: return;
1.612 raeburn 8785: }
1.615 raeburn 8786: if (!$got_rules->{$udom}) {
1.612 raeburn 8787: my %domconfig = &Apache::lonnet::get_dom('configuration',
8788: ['usercreation'],$udom);
8789: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 8790: foreach my $item ('username','id') {
1.612 raeburn 8791: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
8792: $$curr_rules{$udom}{$item} =
8793: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 8794: }
8795: }
8796: }
1.615 raeburn 8797: $got_rules->{$udom} = 1;
1.585 raeburn 8798: }
1.612 raeburn 8799: foreach my $item (keys(%{$checks})) {
8800: if (ref($$curr_rules{$udom}) eq 'HASH') {
8801: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
8802: if (@{$$curr_rules{$udom}{$item}} > 0) {
8803: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
8804: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
8805: if ($rule_check{$rule}) {
8806: $$rulematch{$user}{$item} = $rule;
8807: if ($inst_response eq 'ok') {
1.615 raeburn 8808: if (ref($inst_results) eq 'HASH') {
8809: if (ref($inst_results->{$user}) eq 'HASH') {
8810: if (keys(%{$inst_results->{$user}}) == 0) {
8811: $$alerts{$item}{$udom}{$uname} = 1;
8812: }
1.612 raeburn 8813: }
8814: }
1.615 raeburn 8815: }
8816: last;
1.585 raeburn 8817: }
8818: }
8819: }
8820: }
8821: }
8822: }
8823: }
8824: }
1.612 raeburn 8825: return;
8826: }
8827:
8828: sub user_rule_formats {
8829: my ($domain,$domdesc,$curr_rules,$check) = @_;
8830: my %text = (
8831: 'username' => 'Usernames',
8832: 'id' => 'IDs',
8833: );
8834: my $output;
8835: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
8836: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
8837: if (@{$ruleorder} > 0) {
8838: $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>';
8839: foreach my $rule (@{$ruleorder}) {
8840: if (ref($curr_rules) eq 'ARRAY') {
8841: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
8842: if (ref($rules->{$rule}) eq 'HASH') {
8843: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
8844: $rules->{$rule}{'desc'}.'</li>';
8845: }
8846: }
8847: }
8848: }
8849: $output .= '</ul>';
8850: }
8851: }
8852: return $output;
8853: }
8854:
8855: sub instrule_disallow_msg {
1.615 raeburn 8856: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 8857: my $response;
8858: my %text = (
8859: item => 'username',
8860: items => 'usernames',
8861: match => 'matches',
8862: do => 'does',
8863: action => 'a username',
8864: one => 'one',
8865: );
8866: if ($count > 1) {
8867: $text{'item'} = 'usernames';
8868: $text{'match'} ='match';
8869: $text{'do'} = 'do';
8870: $text{'action'} = 'usernames',
8871: $text{'one'} = 'ones';
8872: }
8873: if ($checkitem eq 'id') {
8874: $text{'items'} = 'IDs';
8875: $text{'item'} = 'ID';
8876: $text{'action'} = 'an ID';
1.615 raeburn 8877: if ($count > 1) {
8878: $text{'item'} = 'IDs';
8879: $text{'action'} = 'IDs';
8880: }
1.612 raeburn 8881: }
1.674 bisitz 8882: $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 8883: if ($mode eq 'upload') {
8884: if ($checkitem eq 'username') {
8885: $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'}.");
8886: } elsif ($checkitem eq 'id') {
1.674 bisitz 8887: $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 8888: }
1.669 raeburn 8889: } elsif ($mode eq 'selfcreate') {
8890: if ($checkitem eq 'id') {
8891: $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.");
8892: }
1.615 raeburn 8893: } else {
8894: if ($checkitem eq 'username') {
8895: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
8896: } elsif ($checkitem eq 'id') {
8897: $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.");
8898: }
1.612 raeburn 8899: }
8900: return $response;
1.585 raeburn 8901: }
8902:
1.624 raeburn 8903: sub personal_data_fieldtitles {
8904: my %fieldtitles = &Apache::lonlocal::texthash (
8905: id => 'Student/Employee ID',
8906: permanentemail => 'E-mail address',
8907: lastname => 'Last Name',
8908: firstname => 'First Name',
8909: middlename => 'Middle Name',
8910: generation => 'Generation',
8911: gen => 'Generation',
1.765 raeburn 8912: inststatus => 'Affiliation',
1.624 raeburn 8913: );
8914: return %fieldtitles;
8915: }
8916:
1.642 raeburn 8917: sub sorted_inst_types {
8918: my ($dom) = @_;
8919: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
8920: my $othertitle = &mt('All users');
8921: if ($env{'request.course.id'}) {
1.668 raeburn 8922: $othertitle = &mt('Any users');
1.642 raeburn 8923: }
8924: my @types;
8925: if (ref($order) eq 'ARRAY') {
8926: @types = @{$order};
8927: }
8928: if (@types == 0) {
8929: if (ref($usertypes) eq 'HASH') {
8930: @types = sort(keys(%{$usertypes}));
8931: }
8932: }
8933: if (keys(%{$usertypes}) > 0) {
8934: $othertitle = &mt('Other users');
8935: }
8936: return ($othertitle,$usertypes,\@types);
8937: }
8938:
1.645 raeburn 8939: sub get_institutional_codes {
8940: my ($settings,$allcourses,$LC_code) = @_;
8941: # Get complete list of course sections to update
8942: my @currsections = ();
8943: my @currxlists = ();
8944: my $coursecode = $$settings{'internal.coursecode'};
8945:
8946: if ($$settings{'internal.sectionnums'} ne '') {
8947: @currsections = split(/,/,$$settings{'internal.sectionnums'});
8948: }
8949:
8950: if ($$settings{'internal.crosslistings'} ne '') {
8951: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
8952: }
8953:
8954: if (@currxlists > 0) {
8955: foreach (@currxlists) {
8956: if (m/^([^:]+):(\w*)$/) {
8957: unless (grep/^$1$/,@{$allcourses}) {
8958: push @{$allcourses},$1;
8959: $$LC_code{$1} = $2;
8960: }
8961: }
8962: }
8963: }
8964:
8965: if (@currsections > 0) {
8966: foreach (@currsections) {
8967: if (m/^(\w+):(\w*)$/) {
8968: my $sec = $coursecode.$1;
8969: my $lc_sec = $2;
8970: unless (grep/^$sec$/,@{$allcourses}) {
8971: push @{$allcourses},$sec;
8972: $$LC_code{$sec} = $lc_sec;
8973: }
8974: }
8975: }
8976: }
8977: return;
8978: }
8979:
1.971 raeburn 8980: sub get_standard_codeitems {
8981: return ('Year','Semester','Department','Number','Section');
8982: }
8983:
1.112 bowersj2 8984: =pod
8985:
1.780 raeburn 8986: =head1 Slot Helpers
8987:
8988: =over 4
8989:
8990: =item * sorted_slots()
8991:
1.1040 raeburn 8992: Sorts an array of slot names in order of an optional sort key,
8993: default sort is by slot start time (earliest first).
1.780 raeburn 8994:
8995: Inputs:
8996:
8997: =over 4
8998:
8999: slotsarr - Reference to array of unsorted slot names.
9000:
9001: slots - Reference to hash of hash, where outer hash keys are slot names.
9002:
1.1040 raeburn 9003: sortkey - Name of key in inner hash to be sorted on (e.g., starttime).
9004:
1.549 albertel 9005: =back
9006:
1.780 raeburn 9007: Returns:
9008:
9009: =over 4
9010:
1.1040 raeburn 9011: sorted - An array of slot names sorted by a specified sort key
9012: (default sort key is start time of the slot).
1.780 raeburn 9013:
9014: =back
9015:
9016: =cut
9017:
9018:
9019: sub sorted_slots {
1.1040 raeburn 9020: my ($slotsarr,$slots,$sortkey) = @_;
9021: if ($sortkey eq '') {
9022: $sortkey = 'starttime';
9023: }
1.780 raeburn 9024: my @sorted;
9025: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
9026: @sorted =
9027: sort {
9028: if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040 raeburn 9029: return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780 raeburn 9030: }
9031: if (ref($slots->{$a})) { return -1;}
9032: if (ref($slots->{$b})) { return 1;}
9033: return 0;
9034: } @{$slotsarr};
9035: }
9036: return @sorted;
9037: }
9038:
1.1040 raeburn 9039: =pod
9040:
9041: =item * get_future_slots()
9042:
9043: Inputs:
9044:
9045: =over 4
9046:
9047: cnum - course number
9048:
9049: cdom - course domain
9050:
9051: now - current UNIX time
9052:
9053: symb - optional symb
9054:
9055: =back
9056:
9057: Returns:
9058:
9059: =over 4
9060:
9061: sorted_reservable - ref to array of student_schedulable slots currently
9062: reservable, ordered by end date of reservation period.
9063:
9064: reservable_now - ref to hash of student_schedulable slots currently
9065: reservable.
9066:
9067: Keys in inner hash are:
9068: (a) symb: either blank or symb to which slot use is restricted.
9069: (b) endreserve: end date of reservation period.
9070:
9071: sorted_future - ref to array of student_schedulable slots reservable in
9072: the future, ordered by start date of reservation period.
9073:
9074: future_reservable - ref to hash of student_schedulable slots reservable
9075: in the future.
9076:
9077: Keys in inner hash are:
9078: (a) symb: either blank or symb to which slot use is restricted.
9079: (b) startreserve: start date of reservation period.
9080:
9081: =back
9082:
9083: =cut
9084:
9085: sub get_future_slots {
9086: my ($cnum,$cdom,$now,$symb) = @_;
9087: my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
9088: my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
9089: foreach my $slot (keys(%slots)) {
9090: next unless($slots{$slot}->{'type'} eq 'schedulable_student');
9091: if ($symb) {
9092: next if (($slots{$slot}->{'symb'} ne '') &&
9093: ($slots{$slot}->{'symb'} ne $symb));
9094: }
9095: if (($slots{$slot}->{'starttime'} > $now) &&
9096: ($slots{$slot}->{'endtime'} > $now)) {
9097: if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
9098: my $userallowed = 0;
9099: if ($slots{$slot}->{'allowedsections'}) {
9100: my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
9101: if (!defined($env{'request.role.sec'})
9102: && grep(/^No section assigned$/,@allowed_sec)) {
9103: $userallowed=1;
9104: } else {
9105: if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
9106: $userallowed=1;
9107: }
9108: }
9109: unless ($userallowed) {
9110: if (defined($env{'request.course.groups'})) {
9111: my @groups = split(/:/,$env{'request.course.groups'});
9112: foreach my $group (@groups) {
9113: if (grep(/^\Q$group\E$/,@allowed_sec)) {
9114: $userallowed=1;
9115: last;
9116: }
9117: }
9118: }
9119: }
9120: }
9121: if ($slots{$slot}->{'allowedusers'}) {
9122: my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
9123: my $user = $env{'user.name'}.':'.$env{'user.domain'};
9124: if (grep(/^\Q$user\E$/,@allowed_users)) {
9125: $userallowed = 1;
9126: }
9127: }
9128: next unless($userallowed);
9129: }
9130: my $startreserve = $slots{$slot}->{'startreserve'};
9131: my $endreserve = $slots{$slot}->{'endreserve'};
9132: my $symb = $slots{$slot}->{'symb'};
9133: if (($startreserve < $now) &&
9134: (!$endreserve || $endreserve > $now)) {
9135: my $lastres = $endreserve;
9136: if (!$lastres) {
9137: $lastres = $slots{$slot}->{'starttime'};
9138: }
9139: $reservable_now{$slot} = {
9140: symb => $symb,
9141: endreserve => $lastres
9142: };
9143: } elsif (($startreserve > $now) &&
9144: (!$endreserve || $endreserve > $startreserve)) {
9145: $future_reservable{$slot} = {
9146: symb => $symb,
9147: startreserve => $startreserve
9148: };
9149: }
9150: }
9151: }
9152: my @unsorted_reservable = keys(%reservable_now);
9153: if (@unsorted_reservable > 0) {
9154: @sorted_reservable =
9155: &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
9156: }
9157: my @unsorted_future = keys(%future_reservable);
9158: if (@unsorted_future > 0) {
9159: @sorted_future =
9160: &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
9161: }
9162: return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
9163: }
1.780 raeburn 9164:
9165: =pod
9166:
1.1057 foxr 9167: =back
9168:
1.549 albertel 9169: =head1 HTTP Helpers
9170:
9171: =over 4
9172:
1.648 raeburn 9173: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 9174:
1.258 albertel 9175: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 9176: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 9177: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 9178:
9179: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
9180: $possible_names is an ref to an array of form element names. As an example:
9181: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 9182: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 9183:
9184: =cut
1.1 albertel 9185:
1.6 albertel 9186: sub get_unprocessed_cgi {
1.25 albertel 9187: my ($query,$possible_names)= @_;
1.26 matthew 9188: # $Apache::lonxml::debug=1;
1.356 albertel 9189: foreach my $pair (split(/&/,$query)) {
9190: my ($name, $value) = split(/=/,$pair);
1.369 www 9191: $name = &unescape($name);
1.25 albertel 9192: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
9193: $value =~ tr/+/ /;
9194: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 9195: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 9196: }
1.16 harris41 9197: }
1.6 albertel 9198: }
9199:
1.112 bowersj2 9200: =pod
9201:
1.648 raeburn 9202: =item * &cacheheader()
1.112 bowersj2 9203:
9204: returns cache-controlling header code
9205:
9206: =cut
9207:
1.7 albertel 9208: sub cacheheader {
1.258 albertel 9209: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 9210: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
9211: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 9212: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
9213: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 9214: return $output;
1.7 albertel 9215: }
9216:
1.112 bowersj2 9217: =pod
9218:
1.648 raeburn 9219: =item * &no_cache($r)
1.112 bowersj2 9220:
9221: specifies header code to not have cache
9222:
9223: =cut
9224:
1.9 albertel 9225: sub no_cache {
1.216 albertel 9226: my ($r) = @_;
9227: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 9228: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 9229: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
9230: $r->no_cache(1);
9231: $r->header_out("Expires" => $date);
9232: $r->header_out("Pragma" => "no-cache");
1.123 www 9233: }
9234:
9235: sub content_type {
1.181 albertel 9236: my ($r,$type,$charset) = @_;
1.299 foxr 9237: if ($r) {
9238: # Note that printout.pl calls this with undef for $r.
9239: &no_cache($r);
9240: }
1.258 albertel 9241: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 9242: unless ($charset) {
9243: $charset=&Apache::lonlocal::current_encoding;
9244: }
9245: if ($charset) { $type.='; charset='.$charset; }
9246: if ($r) {
9247: $r->content_type($type);
9248: } else {
9249: print("Content-type: $type\n\n");
9250: }
1.9 albertel 9251: }
1.25 albertel 9252:
1.112 bowersj2 9253: =pod
9254:
1.648 raeburn 9255: =item * &add_to_env($name,$value)
1.112 bowersj2 9256:
1.258 albertel 9257: adds $name to the %env hash with value
1.112 bowersj2 9258: $value, if $name already exists, the entry is converted to an array
9259: reference and $value is added to the array.
9260:
9261: =cut
9262:
1.25 albertel 9263: sub add_to_env {
9264: my ($name,$value)=@_;
1.258 albertel 9265: if (defined($env{$name})) {
9266: if (ref($env{$name})) {
1.25 albertel 9267: #already have multiple values
1.258 albertel 9268: push(@{ $env{$name} },$value);
1.25 albertel 9269: } else {
9270: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 9271: my $first=$env{$name};
9272: undef($env{$name});
9273: push(@{ $env{$name} },$first,$value);
1.25 albertel 9274: }
9275: } else {
1.258 albertel 9276: $env{$name}=$value;
1.25 albertel 9277: }
1.31 albertel 9278: }
1.149 albertel 9279:
9280: =pod
9281:
1.648 raeburn 9282: =item * &get_env_multiple($name)
1.149 albertel 9283:
1.258 albertel 9284: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 9285: values may be defined and end up as an array ref.
9286:
9287: returns an array of values
9288:
9289: =cut
9290:
9291: sub get_env_multiple {
9292: my ($name) = @_;
9293: my @values;
1.258 albertel 9294: if (defined($env{$name})) {
1.149 albertel 9295: # exists is it an array
1.258 albertel 9296: if (ref($env{$name})) {
9297: @values=@{ $env{$name} };
1.149 albertel 9298: } else {
1.258 albertel 9299: $values[0]=$env{$name};
1.149 albertel 9300: }
9301: }
9302: return(@values);
9303: }
9304:
1.660 raeburn 9305: sub ask_for_embedded_content {
9306: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071 raeburn 9307: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
9308: %currsubfile,%unused);
9309: my $counter = 0;
9310: my $numnew = 0;
1.987 raeburn 9311: my $numremref = 0;
9312: my $numinvalid = 0;
9313: my $numpathchg = 0;
9314: my $numexisting = 0;
1.1071 raeburn 9315: my $numunused = 0;
9316: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
9317: $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path);
9318: my $heading = &mt('Upload embedded files');
9319: my $buttontext = &mt('Upload');
9320:
1.984 raeburn 9321: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
9322: my $current_path='/';
9323: if ($env{'form.currentpath'}) {
9324: $current_path = $env{'form.currentpath'};
9325: }
9326: if ($actionurl eq '/adm/coursegrp_portfolio') {
9327: $udom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9328: $uname = $env{'course.'.$env{'request.course.id'}.'.num'};
9329: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
9330: } else {
9331: $udom = $env{'user.domain'};
9332: $uname = $env{'user.name'};
9333: $url = '/userfiles/portfolio';
9334: }
1.987 raeburn 9335: $toplevel = $url.'/';
1.984 raeburn 9336: $url .= $current_path;
9337: $getpropath = 1;
1.987 raeburn 9338: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
9339: ($actionurl eq '/adm/imsimport')) {
1.1022 www 9340: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026 raeburn 9341: $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987 raeburn 9342: $toplevel = $url;
1.984 raeburn 9343: if ($rest ne '') {
1.987 raeburn 9344: $url .= $rest;
9345: }
9346: } elsif ($actionurl eq '/adm/coursedocs') {
9347: if (ref($args) eq 'HASH') {
1.1071 raeburn 9348: $url = $args->{'docs_url'};
9349: $toplevel = $url;
9350: }
9351: } elsif ($actionurl eq '/adm/dependencies') {
9352: if ($env{'request.course.id'} ne '') {
9353: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9354: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
9355: if (ref($args) eq 'HASH') {
9356: $url = $args->{'docs_url'};
9357: $title = $args->{'docs_title'};
9358: $toplevel = "/$url";
9359: ($path) =
9360: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
9361: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
9362: $fileloc =~ s{^/}{};
9363: ($filename) = ($fileloc =~ m{.+/([^/]+)$});
9364: $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
9365: }
1.987 raeburn 9366: }
9367: }
9368: my $now = time();
9369: foreach my $embed_file (keys(%{$allfiles})) {
9370: my $absolutepath;
9371: if ($embed_file =~ m{^\w+://}) {
9372: $newfiles{$embed_file} = 1;
9373: $mapping{$embed_file} = $embed_file;
9374: } else {
9375: if ($embed_file =~ m{^/}) {
9376: $absolutepath = $embed_file;
9377: $embed_file =~ s{^(/+)}{};
9378: }
9379: if ($embed_file =~ m{/}) {
9380: my ($path,$fname) = ($embed_file =~ m{^(.+)/([^/]*)$});
9381: $path = &check_for_traversal($path,$url,$toplevel);
9382: my $item = $fname;
9383: if ($path ne '') {
9384: $item = $path.'/'.$fname;
9385: $subdependencies{$path}{$fname} = 1;
9386: } else {
9387: $dependencies{$item} = 1;
9388: }
9389: if ($absolutepath) {
9390: $mapping{$item} = $absolutepath;
9391: } else {
9392: $mapping{$item} = $embed_file;
9393: }
9394: } else {
9395: $dependencies{$embed_file} = 1;
9396: if ($absolutepath) {
9397: $mapping{$embed_file} = $absolutepath;
9398: } else {
9399: $mapping{$embed_file} = $embed_file;
9400: }
9401: }
1.984 raeburn 9402: }
9403: }
1.1071 raeburn 9404: my $dirptr = 16384;
1.984 raeburn 9405: foreach my $path (keys(%subdependencies)) {
1.1071 raeburn 9406: $currsubfile{$path} = {};
1.984 raeburn 9407: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 9408: my ($sublistref,$listerror) =
9409: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
9410: if (ref($sublistref) eq 'ARRAY') {
9411: foreach my $line (@{$sublistref}) {
9412: my ($file_name,$rest) = split(/\&/,$line,2);
1.1071 raeburn 9413: $currsubfile{$path}{$file_name} = 1;
1.1021 raeburn 9414: }
1.984 raeburn 9415: }
1.987 raeburn 9416: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 9417: if (opendir(my $dir,$url.'/'.$path)) {
9418: my @subdir_list = grep(!/^\./,readdir($dir));
1.1071 raeburn 9419: map {$currsubfile{$path}{$_} = 1;} @subdir_list;
9420: }
9421: } elsif ($actionurl eq '/adm/dependencies') {
9422: if ($env{'request.course.id'} ne '') {
9423: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
9424: if ($dir ne '') {
9425: my ($sublistref,$listerror) =
9426: &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
9427: if (ref($sublistref) eq 'ARRAY') {
9428: foreach my $line (@{$sublistref}) {
9429: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
9430: undef,$mtime)=split(/\&/,$line,12);
9431: unless (($testdir&$dirptr) ||
9432: ($file_name =~ /^\.\.?$/)) {
9433: $currsubfile{$path}{$file_name} = [$size,$mtime];
9434: }
9435: }
9436: }
9437: }
1.984 raeburn 9438: }
9439: }
9440: foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071 raeburn 9441: if (exists($currsubfile{$path}{$file})) {
1.987 raeburn 9442: my $item = $path.'/'.$file;
9443: unless ($mapping{$item} eq $item) {
9444: $pathchanges{$item} = 1;
9445: }
9446: $existing{$item} = 1;
9447: $numexisting ++;
9448: } else {
9449: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 9450: }
9451: }
1.1071 raeburn 9452: if ($actionurl eq '/adm/dependencies') {
9453: foreach my $path (keys(%currsubfile)) {
9454: if (ref($currsubfile{$path}) eq 'HASH') {
9455: foreach my $file (keys(%{$currsubfile{$path}})) {
9456: unless ($subdependencies{$path}{$file}) {
9457: $unused{$path.'/'.$file} = 1;
9458: }
9459: }
9460: }
9461: }
9462: }
1.984 raeburn 9463: }
1.987 raeburn 9464: my %currfile;
1.984 raeburn 9465: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 9466: my ($dirlistref,$listerror) =
9467: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
9468: if (ref($dirlistref) eq 'ARRAY') {
9469: foreach my $line (@{$dirlistref}) {
9470: my ($file_name,$rest) = split(/\&/,$line,2);
9471: $currfile{$file_name} = 1;
9472: }
1.984 raeburn 9473: }
1.987 raeburn 9474: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 9475: if (opendir(my $dir,$url)) {
1.987 raeburn 9476: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 9477: map {$currfile{$_} = 1;} @dir_list;
9478: }
1.1071 raeburn 9479: } elsif ($actionurl eq '/adm/dependencies') {
9480: if ($env{'request.course.id'} ne '') {
9481: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
9482: if ($dir ne '') {
9483: my ($dirlistref,$listerror) =
9484: &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
9485: if (ref($dirlistref) eq 'ARRAY') {
9486: foreach my $line (@{$dirlistref}) {
9487: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
9488: $size,undef,$mtime)=split(/\&/,$line,12);
9489: unless (($testdir&$dirptr) ||
9490: ($file_name =~ /^\.\.?$/)) {
9491: $currfile{$file_name} = [$size,$mtime];
9492: }
9493: }
9494: }
9495: }
9496: }
1.984 raeburn 9497: }
9498: foreach my $file (keys(%dependencies)) {
1.1071 raeburn 9499: if (exists($currfile{$file})) {
1.987 raeburn 9500: unless ($mapping{$file} eq $file) {
9501: $pathchanges{$file} = 1;
9502: }
9503: $existing{$file} = 1;
9504: $numexisting ++;
9505: } else {
1.984 raeburn 9506: $newfiles{$file} = 1;
9507: }
9508: }
1.1071 raeburn 9509: foreach my $file (keys(%currfile)) {
9510: unless (($file eq $filename) ||
9511: ($file eq $filename.'.bak') ||
9512: ($dependencies{$file})) {
9513: $unused{$file} = 1;
9514: }
9515: }
1.984 raeburn 9516: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071 raeburn 9517: if ($actionurl eq '/adm/dependencies') {
9518: next if ($embed_file =~ m{^\w+://});
9519: }
1.660 raeburn 9520: $upload_output .= &start_data_table_row().
1.1071 raeburn 9521: '<td><img src="'.&icon($embed_file).'" /> '.
9522: '<span class="LC_filename">'.$embed_file.'</span>';
1.987 raeburn 9523: unless ($mapping{$embed_file} eq $embed_file) {
9524: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.&mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
9525: }
9526: $upload_output .= '</td><td>';
1.1071 raeburn 9527: if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) {
1.660 raeburn 9528: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
1.987 raeburn 9529: $numremref++;
1.660 raeburn 9530: } elsif ($args->{'error_on_invalid_names'}
9531: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
9532:
1.987 raeburn 9533: $upload_output.='<span class="LC_warning">'.&mt('Invalid characters').'</span>';
9534: $numinvalid++;
1.660 raeburn 9535: } else {
1.1071 raeburn 9536: $upload_output .= &embedded_file_element('upload_embedded',$counter,
1.987 raeburn 9537: $embed_file,\%mapping,
1.1071 raeburn 9538: $allfiles,$codebase,'upload');
9539: $counter ++;
9540: $numnew ++;
1.987 raeburn 9541: }
9542: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
9543: }
9544: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071 raeburn 9545: if ($actionurl eq '/adm/dependencies') {
9546: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
9547: $modify_output .= &start_data_table_row().
9548: '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
9549: '<img src="'.&icon($embed_file).'" border="0" />'.
9550: ' <span class="LC_filename">'.$embed_file.'</span></a></td>'.
9551: '<td>'.$size.'</td>'.
9552: '<td>'.$mtime.'</td>'.
9553: '<td><label><input type="checkbox" name="mod_upload_dep" '.
9554: 'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
9555: $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
9556: '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
9557: &embedded_file_element('upload_embedded',$counter,
9558: $embed_file,\%mapping,
9559: $allfiles,$codebase,'modify').
9560: '</div></td>'.
9561: &end_data_table_row()."\n";
9562: $counter ++;
9563: } else {
9564: $upload_output .= &start_data_table_row().
9565: '<td><span class="LC_filename">'.$embed_file.'</span></td>';
9566: '<td><span class="LC_warning">'.&mt('Already exists').'</span></td>'.
9567: &Apache::loncommon::end_data_table_row()."\n";
9568: }
9569: }
9570: my $delidx = $counter;
9571: foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
9572: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
9573: $delete_output .= &start_data_table_row().
9574: '<td><img src="'.&icon($oldfile).'" />'.
9575: ' <span class="LC_filename">'.$oldfile.'</span></td>'.
9576: '<td>'.$size.'</td>'.
9577: '<td>'.$mtime.'</td>'.
9578: '<td><label><input type="checkbox" name="del_upload_dep" '.
9579: ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
9580: &embedded_file_element('upload_embedded',$delidx,
9581: $oldfile,\%mapping,$allfiles,
9582: $codebase,'delete').'</td>'.
9583: &end_data_table_row()."\n";
9584: $numunused ++;
9585: $delidx ++;
1.987 raeburn 9586: }
9587: if ($upload_output) {
9588: $upload_output = &start_data_table().
9589: $upload_output.
9590: &end_data_table()."\n";
9591: }
1.1071 raeburn 9592: if ($modify_output) {
9593: $modify_output = &start_data_table().
9594: &start_data_table_header_row().
9595: '<th>'.&mt('File').'</th>'.
9596: '<th>'.&mt('Size (KB)').'</th>'.
9597: '<th>'.&mt('Modified').'</th>'.
9598: '<th>'.&mt('Upload replacement?').'</th>'.
9599: &end_data_table_header_row().
9600: $modify_output.
9601: &end_data_table()."\n";
9602: }
9603: if ($delete_output) {
9604: $delete_output = &start_data_table().
9605: &start_data_table_header_row().
9606: '<th>'.&mt('File').'</th>'.
9607: '<th>'.&mt('Size (KB)').'</th>'.
9608: '<th>'.&mt('Modified').'</th>'.
9609: '<th>'.&mt('Delete?').'</th>'.
9610: &end_data_table_header_row().
9611: $delete_output.
9612: &end_data_table()."\n";
9613: }
1.987 raeburn 9614: my $applies = 0;
9615: if ($numremref) {
9616: $applies ++;
9617: }
9618: if ($numinvalid) {
9619: $applies ++;
9620: }
9621: if ($numexisting) {
9622: $applies ++;
9623: }
1.1071 raeburn 9624: if ($counter || $numunused) {
1.987 raeburn 9625: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
9626: ' method="post" enctype="multipart/form-data">'."\n".
1.1071 raeburn 9627: $state.'<h3>'.$heading.'</h3>';
9628: if ($actionurl eq '/adm/dependencies') {
9629: if ($numnew) {
9630: $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
9631: '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
9632: $upload_output.'<br />'."\n";
9633: }
9634: if ($numexisting) {
9635: $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
9636: '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
9637: $modify_output.'<br />'."\n";
9638: $buttontext = &mt('Save changes');
9639: }
9640: if ($numunused) {
9641: $output .= '<h4>'.&mt('Unused files').'</h4>'.
9642: '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
9643: $delete_output.'<br />'."\n";
9644: $buttontext = &mt('Save changes');
9645: }
9646: } else {
9647: $output .= $upload_output.'<br />'."\n";
9648: }
9649: $output .= '<input type ="hidden" name="number_embedded_items" value="'.
9650: $counter.'" />'."\n";
9651: if ($actionurl eq '/adm/dependencies') {
9652: $output .= '<input type ="hidden" name="number_newemb_items" value="'.
9653: $numnew.'" />'."\n";
9654: } elsif ($actionurl eq '') {
1.987 raeburn 9655: $output .= '<input type="hidden" name="phase" value="three" />';
9656: }
9657: } elsif ($applies) {
9658: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
9659: if ($applies > 1) {
9660: $output .=
9661: &mt('No files need to be uploaded, as one of the following applies to each reference:').'<ul>';
9662: if ($numremref) {
9663: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
9664: }
9665: if ($numinvalid) {
9666: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
9667: }
9668: if ($numexisting) {
9669: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
9670: }
9671: $output .= '</ul><br />';
9672: } elsif ($numremref) {
9673: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
9674: } elsif ($numinvalid) {
9675: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
9676: } elsif ($numexisting) {
9677: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
9678: }
9679: $output .= $upload_output.'<br />';
9680: }
9681: my ($pathchange_output,$chgcount);
1.1071 raeburn 9682: $chgcount = $counter;
1.987 raeburn 9683: if (keys(%pathchanges) > 0) {
9684: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071 raeburn 9685: if ($counter) {
1.987 raeburn 9686: $output .= &embedded_file_element('pathchange',$chgcount,
9687: $embed_file,\%mapping,
1.1071 raeburn 9688: $allfiles,$codebase,'change');
1.987 raeburn 9689: } else {
9690: $pathchange_output .=
9691: &start_data_table_row().
9692: '<td><input type ="checkbox" name="namechange" value="'.
9693: $chgcount.'" checked="checked" /></td>'.
9694: '<td>'.$mapping{$embed_file}.'</td>'.
9695: '<td>'.$embed_file.
9696: &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071 raeburn 9697: \%mapping,$allfiles,$codebase,'change').
1.987 raeburn 9698: '</td>'.&end_data_table_row();
1.660 raeburn 9699: }
1.987 raeburn 9700: $numpathchg ++;
9701: $chgcount ++;
1.660 raeburn 9702: }
9703: }
1.1071 raeburn 9704: if ($counter) {
1.987 raeburn 9705: if ($numpathchg) {
9706: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
9707: $numpathchg.'" />'."\n";
9708: }
9709: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
9710: ($actionurl eq '/adm/imsimport')) {
9711: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
9712: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
9713: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071 raeburn 9714: } elsif ($actionurl eq '/adm/dependencies') {
9715: $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987 raeburn 9716: }
1.1071 raeburn 9717: $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987 raeburn 9718: } elsif ($numpathchg) {
9719: my %pathchange = ();
9720: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
9721: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
9722: $output .= '<p>'.&mt('or').'</p>';
9723: }
9724: }
1.1071 raeburn 9725: return ($output,$counter,$numpathchg);
1.987 raeburn 9726: }
9727:
9728: sub embedded_file_element {
1.1071 raeburn 9729: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987 raeburn 9730: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
9731: (ref($codebase) eq 'HASH'));
9732: my $output;
1.1071 raeburn 9733: if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987 raeburn 9734: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
9735: }
9736: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
9737: &escape($embed_file).'" />';
9738: unless (($context eq 'upload_embedded') &&
9739: ($mapping->{$embed_file} eq $embed_file)) {
9740: $output .='
9741: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
9742: }
9743: my $attrib;
9744: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
9745: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
9746: }
9747: $output .=
9748: "\n\t\t".
9749: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
9750: $attrib.'" />';
9751: if (exists($codebase->{$mapping->{$embed_file}})) {
9752: $output .=
9753: "\n\t\t".
9754: '<input name="codebase_'.$num.'" type="hidden" value="'.
9755: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 9756: }
1.987 raeburn 9757: return $output;
1.660 raeburn 9758: }
9759:
1.1071 raeburn 9760: sub get_dependency_details {
9761: my ($currfile,$currsubfile,$embed_file) = @_;
9762: my ($size,$mtime,$showsize,$showmtime);
9763: if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
9764: if ($embed_file =~ m{/}) {
9765: my ($path,$fname) = split(/\//,$embed_file);
9766: if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
9767: ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
9768: }
9769: } else {
9770: if (ref($currfile->{$embed_file}) eq 'ARRAY') {
9771: ($size,$mtime) = @{$currfile->{$embed_file}};
9772: }
9773: }
9774: $showsize = $size/1024.0;
9775: $showsize = sprintf("%.1f",$showsize);
9776: if ($mtime > 0) {
9777: $showmtime = &Apache::lonlocal::locallocaltime($mtime);
9778: }
9779: }
9780: return ($showsize,$showmtime);
9781: }
9782:
9783: sub ask_embedded_js {
9784: return <<"END";
9785: <script type="text/javascript"">
9786: // <![CDATA[
9787: function toggleBrowse(counter) {
9788: var chkboxid = document.getElementById('mod_upload_dep_'+counter);
9789: var fileid = document.getElementById('embedded_item_'+counter);
9790: var uploaddivid = document.getElementById('moduploaddep_'+counter);
9791: if (chkboxid.checked == true) {
9792: uploaddivid.style.display='block';
9793: } else {
9794: uploaddivid.style.display='none';
9795: fileid.value = '';
9796: }
9797: }
9798: // ]]>
9799: </script>
9800:
9801: END
9802: }
9803:
1.661 raeburn 9804: sub upload_embedded {
9805: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 9806: $current_disk_usage,$hiddenstate,$actionurl) = @_;
9807: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 9808: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
9809: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
9810: my $orig_uploaded_filename =
9811: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 9812: foreach my $type ('orig','ref','attrib','codebase') {
9813: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
9814: $env{'form.embedded_'.$type.'_'.$i} =
9815: &unescape($env{'form.embedded_'.$type.'_'.$i});
9816: }
9817: }
1.661 raeburn 9818: my ($path,$fname) =
9819: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
9820: # no path, whole string is fname
9821: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
9822: $fname = &Apache::lonnet::clean_filename($fname);
9823: # See if there is anything left
9824: next if ($fname eq '');
9825:
9826: # Check if file already exists as a file or directory.
9827: my ($state,$msg);
9828: if ($context eq 'portfolio') {
9829: my $port_path = $dirpath;
9830: if ($group ne '') {
9831: $port_path = "groups/$group/$port_path";
9832: }
1.987 raeburn 9833: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
9834: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 9835: $dir_root,$port_path,$disk_quota,
9836: $current_disk_usage,$uname,$udom);
9837: if ($state eq 'will_exceed_quota'
1.984 raeburn 9838: || $state eq 'file_locked') {
1.661 raeburn 9839: $output .= $msg;
9840: next;
9841: }
9842: } elsif (($context eq 'author') || ($context eq 'testbank')) {
9843: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
9844: if ($state eq 'exists') {
9845: $output .= $msg;
9846: next;
9847: }
9848: }
9849: # Check if extension is valid
9850: if (($fname =~ /\.(\w+)$/) &&
9851: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.987 raeburn 9852: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1).'<br />';
1.661 raeburn 9853: next;
9854: } elsif (($fname =~ /\.(\w+)$/) &&
9855: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 9856: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 9857: next;
9858: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.987 raeburn 9859: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2).'<br />';
1.661 raeburn 9860: next;
9861: }
9862: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
9863: if ($context eq 'portfolio') {
1.984 raeburn 9864: my $result;
9865: if ($state eq 'existingfile') {
9866: $result=
9867: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.987 raeburn 9868: $dirpath.$env{'form.currentpath'}.$path);
1.661 raeburn 9869: } else {
1.984 raeburn 9870: $result=
9871: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 9872: $dirpath.
9873: $env{'form.currentpath'}.$path);
1.984 raeburn 9874: if ($result !~ m|^/uploaded/|) {
9875: $output .= '<span class="LC_error">'
9876: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
9877: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
9878: .'</span><br />';
9879: next;
9880: } else {
1.987 raeburn 9881: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
9882: $path.$fname.'</span>').'<br />';
1.984 raeburn 9883: }
1.661 raeburn 9884: }
1.987 raeburn 9885: } elsif ($context eq 'coursedoc') {
9886: my $result =
9887: &Apache::lonnet::userfileupload('embedded_item_'.$i,'coursedoc',
9888: $dirpath.'/'.$path);
9889: if ($result !~ m|^/uploaded/|) {
9890: $output .= '<span class="LC_error">'
9891: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
9892: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
9893: .'</span><br />';
9894: next;
9895: } else {
9896: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
9897: $path.$fname.'</span>').'<br />';
9898: }
1.661 raeburn 9899: } else {
9900: # Save the file
9901: my $target = $env{'form.embedded_item_'.$i};
9902: my $fullpath = $dir_root.$dirpath.'/'.$path;
9903: my $dest = $fullpath.$fname;
9904: my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027 raeburn 9905: my @parts=split(/\//,"$dirpath/$path");
1.661 raeburn 9906: my $count;
9907: my $filepath = $dir_root;
1.1027 raeburn 9908: foreach my $subdir (@parts) {
9909: $filepath .= "/$subdir";
9910: if (!-e $filepath) {
1.661 raeburn 9911: mkdir($filepath,0770);
9912: }
9913: }
9914: my $fh;
9915: if (!open($fh,'>'.$dest)) {
9916: &Apache::lonnet::logthis('Failed to create '.$dest);
9917: $output .= '<span class="LC_error">'.
1.1071 raeburn 9918: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
9919: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 9920: '</span><br />';
9921: } else {
9922: if (!print $fh $env{'form.embedded_item_'.$i}) {
9923: &Apache::lonnet::logthis('Failed to write to '.$dest);
9924: $output .= '<span class="LC_error">'.
1.1071 raeburn 9925: &mt('An error occurred while writing the file [_1] for embedded element [_2].',
9926: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 9927: '</span><br />';
9928: } else {
1.987 raeburn 9929: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
9930: $url.'</span>').'<br />';
9931: unless ($context eq 'testbank') {
9932: $footer .= &mt('View embedded file: [_1]',
9933: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
9934: }
9935: }
9936: close($fh);
9937: }
9938: }
9939: if ($env{'form.embedded_ref_'.$i}) {
9940: $pathchange{$i} = 1;
9941: }
9942: }
9943: if ($output) {
9944: $output = '<p>'.$output.'</p>';
9945: }
9946: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
9947: $returnflag = 'ok';
1.1071 raeburn 9948: my $numpathchgs = scalar(keys(%pathchange));
9949: if ($numpathchgs > 0) {
1.987 raeburn 9950: if ($context eq 'portfolio') {
9951: $output .= '<p>'.&mt('or').'</p>';
9952: } elsif ($context eq 'testbank') {
1.1071 raeburn 9953: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
9954: '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987 raeburn 9955: $returnflag = 'modify_orightml';
9956: }
9957: }
1.1071 raeburn 9958: return ($output.$footer,$returnflag,$numpathchgs);
1.987 raeburn 9959: }
9960:
9961: sub modify_html_form {
9962: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
9963: my $end = 0;
9964: my $modifyform;
9965: if ($context eq 'upload_embedded') {
9966: return unless (ref($pathchange) eq 'HASH');
9967: if ($env{'form.number_embedded_items'}) {
9968: $end += $env{'form.number_embedded_items'};
9969: }
9970: if ($env{'form.number_pathchange_items'}) {
9971: $end += $env{'form.number_pathchange_items'};
9972: }
9973: if ($end) {
9974: for (my $i=0; $i<$end; $i++) {
9975: if ($i < $env{'form.number_embedded_items'}) {
9976: next unless($pathchange->{$i});
9977: }
9978: $modifyform .=
9979: &start_data_table_row().
9980: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
9981: 'checked="checked" /></td>'.
9982: '<td>'.$env{'form.embedded_ref_'.$i}.
9983: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
9984: &escape($env{'form.embedded_ref_'.$i}).'" />'.
9985: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
9986: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
9987: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
9988: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
9989: '<td>'.$env{'form.embedded_orig_'.$i}.
9990: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
9991: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
9992: &end_data_table_row();
1.1071 raeburn 9993: }
1.987 raeburn 9994: }
9995: } else {
9996: $modifyform = $pathchgtable;
9997: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
9998: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
9999: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
10000: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
10001: }
10002: }
10003: if ($modifyform) {
1.1071 raeburn 10004: if ($actionurl eq '/adm/dependencies') {
10005: $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
10006: }
1.987 raeburn 10007: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
10008: '<p>'.&mt('Changes need to be made to the reference(s) used for one or more of the dependencies, if your HTML file is to work correctly:').'<ol>'."\n".
10009: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
10010: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
10011: '</ol></p>'."\n".'<p>'.
10012: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
10013: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
10014: &start_data_table()."\n".
10015: &start_data_table_header_row().
10016: '<th>'.&mt('Change?').'</th>'.
10017: '<th>'.&mt('Current reference').'</th>'.
10018: '<th>'.&mt('Required reference').'</th>'.
10019: &end_data_table_header_row()."\n".
10020: $modifyform.
10021: &end_data_table().'<br />'."\n".$hiddenstate.
10022: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
10023: '</form>'."\n";
10024: }
10025: return;
10026: }
10027:
10028: sub modify_html_refs {
10029: my ($context,$dirpath,$uname,$udom,$dir_root) = @_;
10030: my $container;
10031: if ($context eq 'portfolio') {
10032: $container = $env{'form.container'};
10033: } elsif ($context eq 'coursedoc') {
10034: $container = $env{'form.primaryurl'};
1.1071 raeburn 10035: } elsif ($context eq 'manage_dependencies') {
10036: (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
10037: $container = "/$container";
1.987 raeburn 10038: } else {
1.1027 raeburn 10039: $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987 raeburn 10040: }
10041: my (%allfiles,%codebase,$output,$content);
10042: my @changes = &get_env_multiple('form.namechange');
1.1071 raeburn 10043: unless (@changes > 0) {
10044: if (wantarray) {
10045: return ('',0,0);
10046: } else {
10047: return;
10048: }
10049: }
10050: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
10051: ($context eq 'manage_dependencies')) {
10052: unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
10053: if (wantarray) {
10054: return ('',0,0);
10055: } else {
10056: return;
10057: }
10058: }
1.987 raeburn 10059: $content = &Apache::lonnet::getfile($container);
1.1071 raeburn 10060: if ($content eq '-1') {
10061: if (wantarray) {
10062: return ('',0,0);
10063: } else {
10064: return;
10065: }
10066: }
1.987 raeburn 10067: } else {
1.1071 raeburn 10068: unless ($container =~ /^\Q$dir_root\E/) {
10069: if (wantarray) {
10070: return ('',0,0);
10071: } else {
10072: return;
10073: }
10074: }
1.987 raeburn 10075: if (open(my $fh,"<$container")) {
10076: $content = join('', <$fh>);
10077: close($fh);
10078: } else {
1.1071 raeburn 10079: if (wantarray) {
10080: return ('',0,0);
10081: } else {
10082: return;
10083: }
1.987 raeburn 10084: }
10085: }
10086: my ($count,$codebasecount) = (0,0);
10087: my $mm = new File::MMagic;
10088: my $mime_type = $mm->checktype_contents($content);
10089: if ($mime_type eq 'text/html') {
10090: my $parse_result =
10091: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
10092: \%codebase,\$content);
10093: if ($parse_result eq 'ok') {
10094: foreach my $i (@changes) {
10095: my $orig = &unescape($env{'form.embedded_orig_'.$i});
10096: my $ref = &unescape($env{'form.embedded_ref_'.$i});
10097: if ($allfiles{$ref}) {
10098: my $newname = $orig;
10099: my ($attrib_regexp,$codebase);
1.1006 raeburn 10100: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 10101: if ($attrib_regexp =~ /:/) {
10102: $attrib_regexp =~ s/\:/|/g;
10103: }
10104: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
10105: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
10106: $count += $numchg;
10107: }
10108: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 10109: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 10110: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
10111: $codebasecount ++;
10112: }
10113: }
10114: }
10115: if ($count || $codebasecount) {
10116: my $saveresult;
1.1071 raeburn 10117: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
10118: ($context eq 'manage_dependencies')) {
1.987 raeburn 10119: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
10120: if ($url eq $container) {
10121: my ($fname) = ($container =~ m{/([^/]+)$});
10122: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
10123: $count,'<span class="LC_filename">'.
1.1071 raeburn 10124: $fname.'</span>').'</p>';
1.987 raeburn 10125: } else {
10126: $output = '<p class="LC_error">'.
10127: &mt('Error: update failed for: [_1].',
10128: '<span class="LC_filename">'.
10129: $container.'</span>').'</p>';
10130: }
10131: } else {
10132: if (open(my $fh,">$container")) {
10133: print $fh $content;
10134: close($fh);
10135: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
10136: $count,'<span class="LC_filename">'.
10137: $container.'</span>').'</p>';
1.661 raeburn 10138: } else {
1.987 raeburn 10139: $output = '<p class="LC_error">'.
10140: &mt('Error: could not update [_1].',
10141: '<span class="LC_filename">'.
10142: $container.'</span>').'</p>';
1.661 raeburn 10143: }
10144: }
10145: }
1.987 raeburn 10146: } else {
10147: &logthis('Failed to parse '.$container.
10148: ' to modify references: '.$parse_result);
1.661 raeburn 10149: }
10150: }
1.1071 raeburn 10151: if (wantarray) {
10152: return ($output,$count,$codebasecount);
10153: } else {
10154: return $output;
10155: }
1.661 raeburn 10156: }
10157:
10158: sub check_for_existing {
10159: my ($path,$fname,$element) = @_;
10160: my ($state,$msg);
10161: if (-d $path.'/'.$fname) {
10162: $state = 'exists';
10163: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
10164: } elsif (-e $path.'/'.$fname) {
10165: $state = 'exists';
10166: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
10167: }
10168: if ($state eq 'exists') {
10169: $msg = '<span class="LC_error">'.$msg.'</span><br />';
10170: }
10171: return ($state,$msg);
10172: }
10173:
10174: sub check_for_upload {
10175: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
10176: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 10177: my $filesize = length($env{'form.'.$element});
10178: if (!$filesize) {
10179: my $msg = '<span class="LC_error">'.
10180: &mt('Unable to upload [_1]. (size = [_2] bytes)',
10181: '<span class="LC_filename">'.$fname.'</span>',
10182: $filesize).'<br />'.
1.1007 raeburn 10183: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 10184: '</span>';
10185: return ('zero_bytes',$msg);
10186: }
10187: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 10188: my $getpropath = 1;
1.1021 raeburn 10189: my ($dirlistref,$listerror) =
10190: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 10191: my $found_file = 0;
10192: my $locked_file = 0;
1.991 raeburn 10193: my @lockers;
10194: my $navmap;
10195: if ($env{'request.course.id'}) {
10196: $navmap = Apache::lonnavmaps::navmap->new();
10197: }
1.1021 raeburn 10198: if (ref($dirlistref) eq 'ARRAY') {
10199: foreach my $line (@{$dirlistref}) {
10200: my ($file_name,$rest)=split(/\&/,$line,2);
10201: if ($file_name eq $fname){
10202: $file_name = $path.$file_name;
10203: if ($group ne '') {
10204: $file_name = $group.$file_name;
10205: }
10206: $found_file = 1;
10207: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
10208: foreach my $lock (@lockers) {
10209: if (ref($lock) eq 'ARRAY') {
10210: my ($symb,$crsid) = @{$lock};
10211: if ($crsid eq $env{'request.course.id'}) {
10212: if (ref($navmap)) {
10213: my $res = $navmap->getBySymb($symb);
10214: foreach my $part (@{$res->parts()}) {
10215: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
10216: unless (($slot_status == $res->RESERVED) ||
10217: ($slot_status == $res->RESERVED_LOCATION)) {
10218: $locked_file = 1;
10219: }
1.991 raeburn 10220: }
1.1021 raeburn 10221: } else {
10222: $locked_file = 1;
1.991 raeburn 10223: }
10224: } else {
10225: $locked_file = 1;
10226: }
10227: }
1.1021 raeburn 10228: }
10229: } else {
10230: my @info = split(/\&/,$rest);
10231: my $currsize = $info[6]/1000;
10232: if ($currsize < $filesize) {
10233: my $extra = $filesize - $currsize;
10234: if (($current_disk_usage + $extra) > $disk_quota) {
10235: my $msg = '<span class="LC_error">'.
10236: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded if existing (smaller) file with same name (size = [_3] kilobytes) is replaced.',
10237: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</span>'.
10238: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
10239: $disk_quota,$current_disk_usage);
10240: return ('will_exceed_quota',$msg);
10241: }
1.984 raeburn 10242: }
10243: }
1.661 raeburn 10244: }
10245: }
10246: }
10247: if (($current_disk_usage + $filesize) > $disk_quota){
10248: my $msg = '<span class="LC_error">'.
10249: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
10250: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
10251: return ('will_exceed_quota',$msg);
10252: } elsif ($found_file) {
10253: if ($locked_file) {
10254: my $msg = '<span class="LC_error">';
10255: $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>');
10256: $msg .= '</span><br />';
10257: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
10258: return ('file_locked',$msg);
10259: } else {
10260: my $msg = '<span class="LC_error">';
1.984 raeburn 10261: $msg .= &mt(' A file by that name: [_1] was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$port_path.$env{'form.currentpath'});
1.661 raeburn 10262: $msg .= '</span>';
1.984 raeburn 10263: return ('existingfile',$msg);
1.661 raeburn 10264: }
10265: }
10266: }
10267:
1.987 raeburn 10268: sub check_for_traversal {
10269: my ($path,$url,$toplevel) = @_;
10270: my @parts=split(/\//,$path);
10271: my $cleanpath;
10272: my $fullpath = $url;
10273: for (my $i=0;$i<@parts;$i++) {
10274: next if ($parts[$i] eq '.');
10275: if ($parts[$i] eq '..') {
10276: $fullpath =~ s{([^/]+/)$}{};
10277: } else {
10278: $fullpath .= $parts[$i].'/';
10279: }
10280: }
10281: if ($fullpath =~ /^\Q$url\E(.*)$/) {
10282: $cleanpath = $1;
10283: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
10284: my $curr_toprel = $1;
10285: my @parts = split(/\//,$curr_toprel);
10286: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
10287: my @urlparts = split(/\//,$url_toprel);
10288: my $doubledots;
10289: my $startdiff = -1;
10290: for (my $i=0; $i<@urlparts; $i++) {
10291: if ($startdiff == -1) {
10292: unless ($urlparts[$i] eq $parts[$i]) {
10293: $startdiff = $i;
10294: $doubledots .= '../';
10295: }
10296: } else {
10297: $doubledots .= '../';
10298: }
10299: }
10300: if ($startdiff > -1) {
10301: $cleanpath = $doubledots;
10302: for (my $i=$startdiff; $i<@parts; $i++) {
10303: $cleanpath .= $parts[$i].'/';
10304: }
10305: }
10306: }
10307: $cleanpath =~ s{(/)$}{};
10308: return $cleanpath;
10309: }
1.31 albertel 10310:
1.1053 raeburn 10311: sub is_archive_file {
10312: my ($mimetype) = @_;
10313: if (($mimetype eq 'application/octet-stream') ||
10314: ($mimetype eq 'application/x-stuffit') ||
10315: ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
10316: return 1;
10317: }
10318: return;
10319: }
10320:
10321: sub decompress_form {
1.1065 raeburn 10322: my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053 raeburn 10323: my %lt = &Apache::lonlocal::texthash (
10324: this => 'This file is an archive file.',
1.1067 raeburn 10325: camt => 'This file is a Camtasia archive file.',
1.1065 raeburn 10326: itsc => 'Its contents are as follows:',
1.1053 raeburn 10327: youm => 'You may wish to extract its contents.',
10328: extr => 'Extract contents',
1.1067 raeburn 10329: auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
10330: proa => 'Process automatically?',
1.1053 raeburn 10331: yes => 'Yes',
10332: no => 'No',
1.1067 raeburn 10333: fold => 'Title for folder containing movie',
10334: movi => 'Title for page containing embedded movie',
1.1053 raeburn 10335: );
1.1065 raeburn 10336: my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067 raeburn 10337: my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065 raeburn 10338: my $info = &list_archive_contents($fileloc,\@paths);
10339: if (@paths) {
10340: foreach my $path (@paths) {
10341: $path =~ s{^/}{};
1.1067 raeburn 10342: if ($path =~ m{^([^/]+)/$}) {
10343: $topdir = $1;
10344: }
1.1065 raeburn 10345: if ($path =~ m{^([^/]+)/}) {
10346: $toplevel{$1} = $path;
10347: } else {
10348: $toplevel{$path} = $path;
10349: }
10350: }
10351: }
1.1067 raeburn 10352: if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
10353: my @camtasia = ("$topdir/","$topdir/index.html",
10354: "$topdir/media/",
10355: "$topdir/media/$topdir.mp4",
10356: "$topdir/media/FirstFrame.png",
10357: "$topdir/media/player.swf",
10358: "$topdir/media/swfobject.js",
10359: "$topdir/media/expressInstall.swf");
10360: my @diffs = &compare_arrays(\@paths,\@camtasia);
10361: if (@diffs == 0) {
10362: $is_camtasia = 1;
10363: }
10364: }
10365: my $output;
10366: if ($is_camtasia) {
10367: $output = <<"ENDCAM";
10368: <script type="text/javascript" language="Javascript">
10369: // <![CDATA[
10370:
10371: function camtasiaToggle() {
10372: for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
10373: if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
10374: if (document.uploaded_decompress.autoextract_camtasia[i].value == 1) {
10375:
10376: document.getElementById('camtasia_titles').style.display='block';
10377: } else {
10378: document.getElementById('camtasia_titles').style.display='none';
10379: }
10380: }
10381: }
10382: return;
10383: }
10384:
10385: // ]]>
10386: </script>
10387: <p>$lt{'camt'}</p>
10388: ENDCAM
1.1065 raeburn 10389: } else {
1.1067 raeburn 10390: $output = '<p>'.$lt{'this'};
10391: if ($info eq '') {
10392: $output .= ' '.$lt{'youm'}.'</p>'."\n";
10393: } else {
10394: $output .= ' '.$lt{'itsc'}.'</p>'."\n".
10395: '<div><pre>'.$info.'</pre></div>';
10396: }
1.1065 raeburn 10397: }
1.1067 raeburn 10398: $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065 raeburn 10399: my $duplicates;
10400: my $num = 0;
10401: if (ref($dirlist) eq 'ARRAY') {
10402: foreach my $item (@{$dirlist}) {
10403: if (ref($item) eq 'ARRAY') {
10404: if (exists($toplevel{$item->[0]})) {
10405: $duplicates .=
10406: &start_data_table_row().
10407: '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
10408: 'value="0" checked="checked" />'.&mt('No').'</label>'.
10409: ' <label><input type="radio" name="archive_overwrite_'.$num.'" '.
10410: 'value="1" />'.&mt('Yes').'</label>'.
10411: '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
10412: '<td>'.$item->[0].'</td>';
10413: if ($item->[2]) {
10414: $duplicates .= '<td>'.&mt('Directory').'</td>';
10415: } else {
10416: $duplicates .= '<td>'.&mt('File').'</td>';
10417: }
10418: $duplicates .= '<td>'.$item->[3].'</td>'.
10419: '<td>'.
10420: &Apache::lonlocal::locallocaltime($item->[4]).
10421: '</td>'.
10422: &end_data_table_row();
10423: $num ++;
10424: }
10425: }
10426: }
10427: }
10428: my $itemcount;
10429: if (@paths > 0) {
10430: $itemcount = scalar(@paths);
10431: } else {
10432: $itemcount = 1;
10433: }
1.1067 raeburn 10434: if ($is_camtasia) {
10435: $output .= $lt{'auto'}.'<br />'.
10436: '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
10437: '<input type="radio" name="autoextract_camtasia" value="1" onclick="javascript:camtasiaToggle();" checked="checked" />'.
10438: $lt{'yes'}.'</label> <label>'.
10439: '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
10440: $lt{'no'}.'</label></span><br />'.
10441: '<div id="camtasia_titles" style="display:block">'.
10442: &Apache::lonhtmlcommon::start_pick_box().
10443: &Apache::lonhtmlcommon::row_title($lt{'fold'}).
10444: '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
10445: &Apache::lonhtmlcommon::row_closure().
10446: &Apache::lonhtmlcommon::row_title($lt{'movi'}).
10447: '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
10448: &Apache::lonhtmlcommon::row_closure(1).
10449: &Apache::lonhtmlcommon::end_pick_box().
10450: '</div>';
10451: }
1.1065 raeburn 10452: $output .=
10453: '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067 raeburn 10454: '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
10455: "\n";
1.1065 raeburn 10456: if ($duplicates ne '') {
10457: $output .= '<p><span class="LC_warning">'.
10458: &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.
10459: &start_data_table().
10460: &start_data_table_header_row().
10461: '<th>'.&mt('Overwrite?').'</th>'.
10462: '<th>'.&mt('Name').'</th>'.
10463: '<th>'.&mt('Type').'</th>'.
10464: '<th>'.&mt('Size').'</th>'.
10465: '<th>'.&mt('Last modified').'</th>'.
10466: &end_data_table_header_row().
10467: $duplicates.
10468: &end_data_table().
10469: '</p>';
10470: }
1.1067 raeburn 10471: $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053 raeburn 10472: if (ref($hiddenelements) eq 'HASH') {
10473: foreach my $hidden (sort(keys(%{$hiddenelements}))) {
10474: $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
10475: }
10476: }
10477: $output .= <<"END";
1.1067 raeburn 10478: <br />
1.1053 raeburn 10479: <input type="submit" name="decompress" value="$lt{'extr'}" />
10480: </form>
10481: $noextract
10482: END
10483: return $output;
10484: }
10485:
1.1065 raeburn 10486: sub decompression_utility {
10487: my ($program) = @_;
10488: my @utilities = ('tar','gunzip','bunzip2','unzip');
10489: my $location;
10490: if (grep(/^\Q$program\E$/,@utilities)) {
10491: foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
10492: '/usr/sbin/') {
10493: if (-x $dir.$program) {
10494: $location = $dir.$program;
10495: last;
10496: }
10497: }
10498: }
10499: return $location;
10500: }
10501:
10502: sub list_archive_contents {
10503: my ($file,$pathsref) = @_;
10504: my (@cmd,$output);
10505: my $needsregexp;
10506: if ($file =~ /\.zip$/) {
10507: @cmd = (&decompression_utility('unzip'),"-l");
10508: $needsregexp = 1;
10509: } elsif (($file =~ m/\.tar\.gz$/) ||
10510: ($file =~ /\.tgz$/)) {
10511: @cmd = (&decompression_utility('tar'),"-ztf");
10512: } elsif ($file =~ /\.tar\.bz2$/) {
10513: @cmd = (&decompression_utility('tar'),"-jtf");
10514: } elsif ($file =~ m|\.tar$|) {
10515: @cmd = (&decompression_utility('tar'),"-tf");
10516: }
10517: if (@cmd) {
10518: undef($!);
10519: undef($@);
10520: if (open(my $fh,"-|", @cmd, $file)) {
10521: while (my $line = <$fh>) {
10522: $output .= $line;
10523: chomp($line);
10524: my $item;
10525: if ($needsregexp) {
10526: ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/);
10527: } else {
10528: $item = $line;
10529: }
10530: if ($item ne '') {
10531: unless (grep(/^\Q$item\E$/,@{$pathsref})) {
10532: push(@{$pathsref},$item);
10533: }
10534: }
10535: }
10536: close($fh);
10537: }
10538: }
10539: return $output;
10540: }
10541:
1.1053 raeburn 10542: sub decompress_uploaded_file {
10543: my ($file,$dir) = @_;
10544: &Apache::lonnet::appenv({'cgi.file' => $file});
10545: &Apache::lonnet::appenv({'cgi.dir' => $dir});
10546: my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
10547: my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
10548: my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
10549: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
10550: my $decompressed = $env{'cgi.decompressed'};
10551: &Apache::lonnet::delenv('cgi.file');
10552: &Apache::lonnet::delenv('cgi.dir');
10553: &Apache::lonnet::delenv('cgi.decompressed');
10554: return ($decompressed,$result);
10555: }
10556:
1.1055 raeburn 10557: sub process_decompression {
10558: my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
10559: my ($dir,$error,$warning,$output);
10560: if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/) {
10561: $error = &mt('File name not a supported archive file type.').
10562: '<br />'.&mt('File name should end with one of: [_1].',
10563: '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
10564: } else {
10565: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
10566: if ($docuhome eq 'no_host') {
10567: $error = &mt('Could not determine home server for course.');
10568: } else {
10569: my @ids=&Apache::lonnet::current_machine_ids();
10570: my $currdir = "$dir_root/$destination";
10571: if (grep(/^\Q$docuhome\E$/,@ids)) {
10572: $dir = &LONCAPA::propath($docudom,$docuname).
10573: "$dir_root/$destination";
10574: } else {
10575: $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
10576: "$dir_root/$docudom/$docuname/$destination";
10577: unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
10578: $error = &mt('Archive file not found.');
10579: }
10580: }
1.1065 raeburn 10581: my (@to_overwrite,@to_skip);
10582: if ($env{'form.archive_overwrite_total'} > 0) {
10583: my $total = $env{'form.archive_overwrite_total'};
10584: for (my $i=0; $i<$total; $i++) {
10585: if ($env{'form.archive_overwrite_'.$i} == 1) {
10586: push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
10587: } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
10588: push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
10589: }
10590: }
10591: }
10592: my $numskip = scalar(@to_skip);
10593: if (($numskip > 0) &&
10594: ($numskip == $env{'form.archive_itemcount'})) {
10595: $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');
10596: } elsif ($dir eq '') {
1.1055 raeburn 10597: $error = &mt('Directory containing archive file unavailable.');
10598: } elsif (!$error) {
1.1065 raeburn 10599: my ($decompressed,$display);
10600: if ($numskip > 0) {
10601: my $tempdir = time.'_'.$$.int(rand(10000));
10602: mkdir("$dir/$tempdir",0755);
10603: system("mv $dir/$file $dir/$tempdir/$file");
10604: ($decompressed,$display) =
10605: &decompress_uploaded_file($file,"$dir/$tempdir");
10606: foreach my $item (@to_skip) {
10607: if (($item ne '') && ($item !~ /\.\./)) {
10608: if (-f "$dir/$tempdir/$item") {
10609: unlink("$dir/$tempdir/$item");
10610: } elsif (-d "$dir/$tempdir/$item") {
10611: system("rm -rf $dir/$tempdir/$item");
10612: }
10613: }
10614: }
10615: system("mv $dir/$tempdir/* $dir");
10616: rmdir("$dir/$tempdir");
10617: } else {
10618: ($decompressed,$display) =
10619: &decompress_uploaded_file($file,$dir);
10620: }
1.1055 raeburn 10621: if ($decompressed eq 'ok') {
1.1065 raeburn 10622: $output = '<p class="LC_info">'.
10623: &mt('Files extracted successfully from archive.').
10624: '</p>'."\n";
1.1055 raeburn 10625: my ($warning,$result,@contents);
10626: my ($newdirlistref,$newlisterror) =
10627: &Apache::lonnet::dirlist($currdir,$docudom,
10628: $docuname,1);
10629: my (%is_dir,%changes,@newitems);
10630: my $dirptr = 16384;
1.1065 raeburn 10631: if (ref($newdirlistref) eq 'ARRAY') {
1.1055 raeburn 10632: foreach my $dir_line (@{$newdirlistref}) {
10633: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1065 raeburn 10634: unless (($item =~ /^\.+$/) || ($item eq $file) ||
10635: ((@to_skip > 0) && (grep(/^\Q$item\E$/,@to_skip)))) {
1.1055 raeburn 10636: push(@newitems,$item);
10637: if ($dirptr&$testdir) {
10638: $is_dir{$item} = 1;
10639: }
10640: $changes{$item} = 1;
10641: }
10642: }
10643: }
10644: if (keys(%changes) > 0) {
10645: foreach my $item (sort(@newitems)) {
10646: if ($changes{$item}) {
10647: push(@contents,$item);
10648: }
10649: }
10650: }
10651: if (@contents > 0) {
1.1067 raeburn 10652: my $wantform;
10653: unless ($env{'form.autoextract_camtasia'}) {
10654: $wantform = 1;
10655: }
1.1056 raeburn 10656: my (%children,%parent,%dirorder,%titles);
1.1055 raeburn 10657: my ($count,$datatable) = &get_extracted($docudom,$docuname,
10658: $currdir,\%is_dir,
10659: \%children,\%parent,
1.1056 raeburn 10660: \@contents,\%dirorder,
10661: \%titles,$wantform);
1.1055 raeburn 10662: if ($datatable ne '') {
10663: $output .= &archive_options_form('decompressed',$datatable,
10664: $count,$hiddenelem);
1.1065 raeburn 10665: my $startcount = 6;
1.1055 raeburn 10666: $output .= &archive_javascript($startcount,$count,
1.1056 raeburn 10667: \%titles,\%children);
1.1055 raeburn 10668: }
1.1067 raeburn 10669: if ($env{'form.autoextract_camtasia'}) {
10670: my %displayed;
10671: my $total = 1;
10672: $env{'form.archive_directory'} = [];
10673: foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
10674: my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
10675: $path =~ s{/$}{};
10676: my $item;
10677: if ($path ne '') {
10678: $item = "$path/$titles{$i}";
10679: } else {
10680: $item = $titles{$i};
10681: }
10682: $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
10683: if ($item eq $contents[0]) {
10684: push(@{$env{'form.archive_directory'}},$i);
10685: $env{'form.archive_'.$i} = 'display';
10686: $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
10687: $displayed{'folder'} = $i;
10688: } elsif ($item eq "$contents[0]/index.html") {
10689: $env{'form.archive_'.$i} = 'display';
10690: $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
10691: $displayed{'web'} = $i;
10692: } else {
10693: if ($item eq "$contents[0]/media") {
10694: push(@{$env{'form.archive_directory'}},$i);
10695: }
10696: $env{'form.archive_'.$i} = 'dependency';
10697: }
10698: $total ++;
10699: }
10700: for (my $i=1; $i<$total; $i++) {
10701: next if ($i == $displayed{'web'});
10702: next if ($i == $displayed{'folder'});
10703: $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
10704: }
10705: $env{'form.phase'} = 'decompress_cleanup';
10706: $env{'form.archivedelete'} = 1;
10707: $env{'form.archive_count'} = $total-1;
10708: $output .=
10709: &process_extracted_files('coursedocs',$docudom,
10710: $docuname,$destination,
10711: $dir_root,$hiddenelem);
10712: }
1.1055 raeburn 10713: } else {
10714: $warning = &mt('No new items extracted from archive file.');
10715: }
10716: } else {
10717: $output = $display;
10718: $error = &mt('An error occurred during extraction from the archive file.');
10719: }
10720: }
10721: }
10722: }
10723: if ($error) {
10724: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
10725: $error.'</p>'."\n";
10726: }
10727: if ($warning) {
10728: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
10729: }
10730: return $output;
10731: }
10732:
10733: sub get_extracted {
1.1056 raeburn 10734: my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
10735: $titles,$wantform) = @_;
1.1055 raeburn 10736: my $count = 0;
10737: my $depth = 0;
10738: my $datatable;
1.1056 raeburn 10739: my @hierarchy;
1.1055 raeburn 10740: return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056 raeburn 10741: (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
10742: (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055 raeburn 10743: foreach my $item (@{$contents}) {
10744: $count ++;
1.1056 raeburn 10745: @{$dirorder->{$count}} = @hierarchy;
10746: $titles->{$count} = $item;
1.1055 raeburn 10747: &archive_hierarchy($depth,$count,$parent,$children);
10748: if ($wantform) {
10749: $datatable .= &archive_row($is_dir->{$item},$item,
10750: $currdir,$depth,$count);
10751: }
10752: if ($is_dir->{$item}) {
10753: $depth ++;
1.1056 raeburn 10754: push(@hierarchy,$count);
10755: $parent->{$depth} = $count;
1.1055 raeburn 10756: $datatable .=
10757: &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056 raeburn 10758: \$depth,\$count,\@hierarchy,$dirorder,
10759: $children,$parent,$titles,$wantform);
1.1055 raeburn 10760: $depth --;
1.1056 raeburn 10761: pop(@hierarchy);
1.1055 raeburn 10762: }
10763: }
10764: return ($count,$datatable);
10765: }
10766:
10767: sub recurse_extracted_archive {
1.1056 raeburn 10768: my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
10769: $children,$parent,$titles,$wantform) = @_;
1.1055 raeburn 10770: my $result='';
1.1056 raeburn 10771: unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
10772: (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
10773: (ref($dirorder) eq 'HASH')) {
1.1055 raeburn 10774: return $result;
10775: }
10776: my $dirptr = 16384;
10777: my ($newdirlistref,$newlisterror) =
10778: &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
10779: if (ref($newdirlistref) eq 'ARRAY') {
10780: foreach my $dir_line (@{$newdirlistref}) {
10781: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
10782: unless ($item =~ /^\.+$/) {
10783: $$count ++;
1.1056 raeburn 10784: @{$dirorder->{$$count}} = @{$hierarchy};
10785: $titles->{$$count} = $item;
1.1055 raeburn 10786: &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056 raeburn 10787:
1.1055 raeburn 10788: my $is_dir;
10789: if ($dirptr&$testdir) {
10790: $is_dir = 1;
10791: }
10792: if ($wantform) {
10793: $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
10794: }
10795: if ($is_dir) {
10796: $$depth ++;
1.1056 raeburn 10797: push(@{$hierarchy},$$count);
10798: $parent->{$$depth} = $$count;
1.1055 raeburn 10799: $result .=
10800: &recurse_extracted_archive("$currdir/$item",$docudom,
10801: $docuname,$depth,$count,
1.1056 raeburn 10802: $hierarchy,$dirorder,$children,
10803: $parent,$titles,$wantform);
1.1055 raeburn 10804: $$depth --;
1.1056 raeburn 10805: pop(@{$hierarchy});
1.1055 raeburn 10806: }
10807: }
10808: }
10809: }
10810: return $result;
10811: }
10812:
10813: sub archive_hierarchy {
10814: my ($depth,$count,$parent,$children) =@_;
10815: if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
10816: if (exists($parent->{$depth})) {
10817: $children->{$parent->{$depth}} .= $count.':';
10818: }
10819: }
10820: return;
10821: }
10822:
10823: sub archive_row {
10824: my ($is_dir,$item,$currdir,$depth,$count) = @_;
10825: my ($name) = ($item =~ m{([^/]+)$});
10826: my %choices = &Apache::lonlocal::texthash (
1.1059 raeburn 10827: 'display' => 'Add as file',
1.1055 raeburn 10828: 'dependency' => 'Include as dependency',
10829: 'discard' => 'Discard',
10830: );
10831: if ($is_dir) {
1.1059 raeburn 10832: $choices{'display'} = &mt('Add as folder');
1.1055 raeburn 10833: }
1.1056 raeburn 10834: my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
10835: my $offset = 0;
1.1055 raeburn 10836: foreach my $action ('display','dependency','discard') {
1.1056 raeburn 10837: $offset ++;
1.1065 raeburn 10838: if ($action ne 'display') {
10839: $offset ++;
10840: }
1.1055 raeburn 10841: $output .= '<td><span class="LC_nobreak">'.
10842: '<label><input type="radio" name="archive_'.$count.
10843: '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
10844: my $text = $choices{$action};
10845: if ($is_dir) {
10846: $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
10847: if ($action eq 'display') {
1.1059 raeburn 10848: $text = &mt('Add as folder');
1.1055 raeburn 10849: }
1.1056 raeburn 10850: } else {
10851: $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
10852:
10853: }
10854: $output .= ' /> '.$choices{$action}.'</label></span>';
10855: if ($action eq 'dependency') {
10856: $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
10857: &mt('Used by:').' <select name="archive_dependent_on_'.$count.'" '.
10858: 'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
10859: '<option value=""></option>'."\n".
10860: '</select>'."\n".
10861: '</div>';
1.1059 raeburn 10862: } elsif ($action eq 'display') {
10863: $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
10864: &mt('Title:').' <input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
10865: '</div>';
1.1055 raeburn 10866: }
1.1056 raeburn 10867: $output .= '</td>';
1.1055 raeburn 10868: }
10869: $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
10870: &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.(' ' x 2);
10871: for (my $i=0; $i<$depth; $i++) {
10872: $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
10873: }
10874: if ($is_dir) {
10875: $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" /> '."\n".
10876: '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
10877: } else {
10878: $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
10879: }
10880: $output .= ' '.$name.'</td>'."\n".
10881: &end_data_table_row();
10882: return $output;
10883: }
10884:
10885: sub archive_options_form {
1.1065 raeburn 10886: my ($form,$display,$count,$hiddenelem) = @_;
10887: my %lt = &Apache::lonlocal::texthash(
10888: perm => 'Permanently remove archive file?',
10889: hows => 'How should each extracted item be incorporated in the course?',
10890: cont => 'Content actions for all',
10891: addf => 'Add as folder/file',
10892: incd => 'Include as dependency for a displayed file',
10893: disc => 'Discard',
10894: no => 'No',
10895: yes => 'Yes',
10896: save => 'Save',
10897: );
10898: my $output = <<"END";
10899: <form name="$form" method="post" action="">
10900: <p><span class="LC_nobreak">$lt{'perm'}
10901: <label>
10902: <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
10903: </label>
10904:
10905: <label>
10906: <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
10907: </span>
10908: </p>
10909: <input type="hidden" name="phase" value="decompress_cleanup" />
10910: <br />$lt{'hows'}
10911: <div class="LC_columnSection">
10912: <fieldset>
10913: <legend>$lt{'cont'}</legend>
10914: <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" />
10915: <input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
10916: <input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
10917: </fieldset>
10918: </div>
10919: END
10920: return $output.
1.1055 raeburn 10921: &start_data_table()."\n".
1.1065 raeburn 10922: $display."\n".
1.1055 raeburn 10923: &end_data_table()."\n".
10924: '<input type="hidden" name="archive_count" value="'.$count.'" />'.
10925: $hiddenelem.
1.1065 raeburn 10926: '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055 raeburn 10927: '</form>';
10928: }
10929:
10930: sub archive_javascript {
1.1056 raeburn 10931: my ($startcount,$numitems,$titles,$children) = @_;
10932: return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059 raeburn 10933: my $maintitle = $env{'form.comment'};
1.1055 raeburn 10934: my $scripttag = <<START;
10935: <script type="text/javascript">
10936: // <![CDATA[
10937:
10938: function checkAll(form,prefix) {
10939: var idstr = new RegExp("^archive_"+prefix+"_\\\\d+\$");
10940: for (var i=0; i < form.elements.length; i++) {
10941: var id = form.elements[i].id;
10942: if ((id != '') && (id != undefined)) {
10943: if (idstr.test(id)) {
10944: if (form.elements[i].type == 'radio') {
10945: form.elements[i].checked = true;
1.1056 raeburn 10946: var nostart = i-$startcount;
1.1059 raeburn 10947: var offset = nostart%7;
10948: var count = (nostart-offset)/7;
1.1056 raeburn 10949: dependencyCheck(form,count,offset);
1.1055 raeburn 10950: }
10951: }
10952: }
10953: }
10954: }
10955:
10956: function propagateCheck(form,count) {
10957: if (count > 0) {
1.1059 raeburn 10958: var startelement = $startcount + ((count-1) * 7);
10959: for (var j=1; j<6; j++) {
10960: if ((j != 2) && (j != 4)) {
1.1056 raeburn 10961: var item = startelement + j;
10962: if (form.elements[item].type == 'radio') {
10963: if (form.elements[item].checked) {
10964: containerCheck(form,count,j);
10965: break;
10966: }
1.1055 raeburn 10967: }
10968: }
10969: }
10970: }
10971: }
10972:
10973: numitems = $numitems
1.1056 raeburn 10974: var titles = new Array(numitems);
10975: var parents = new Array(numitems);
1.1055 raeburn 10976: for (var i=0; i<numitems; i++) {
1.1056 raeburn 10977: parents[i] = new Array;
1.1055 raeburn 10978: }
1.1059 raeburn 10979: var maintitle = '$maintitle';
1.1055 raeburn 10980:
10981: START
10982:
1.1056 raeburn 10983: foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
10984: my @contents = split(/:/,$children->{$container});
1.1055 raeburn 10985: for (my $i=0; $i<@contents; $i ++) {
10986: $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
10987: }
10988: }
10989:
1.1056 raeburn 10990: foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
10991: $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
10992: }
10993:
1.1055 raeburn 10994: $scripttag .= <<END;
10995:
10996: function containerCheck(form,count,offset) {
10997: if (count > 0) {
1.1056 raeburn 10998: dependencyCheck(form,count,offset);
1.1059 raeburn 10999: var item = (offset+$startcount)+7*(count-1);
1.1055 raeburn 11000: form.elements[item].checked = true;
11001: if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
11002: if (parents[count].length > 0) {
11003: for (var j=0; j<parents[count].length; j++) {
1.1056 raeburn 11004: containerCheck(form,parents[count][j],offset);
11005: }
11006: }
11007: }
11008: }
11009: }
11010:
11011: function dependencyCheck(form,count,offset) {
11012: if (count > 0) {
1.1059 raeburn 11013: var chosen = (offset+$startcount)+7*(count-1);
11014: var depitem = $startcount + ((count-1) * 7) + 4;
1.1056 raeburn 11015: var currtype = form.elements[depitem].type;
11016: if (form.elements[chosen].value == 'dependency') {
11017: document.getElementById('arc_depon_'+count).style.display='block';
11018: form.elements[depitem].options.length = 0;
11019: form.elements[depitem].options[0] = new Option('Select','',true,true);
11020: for (var i=1; i<count; i++) {
1.1059 raeburn 11021: var startelement = $startcount + (i-1) * 7;
11022: for (var j=1; j<6; j++) {
11023: if ((j != 2) && (j!= 4)) {
1.1056 raeburn 11024: var item = startelement + j;
11025: if (form.elements[item].type == 'radio') {
11026: if (form.elements[item].checked) {
11027: if (form.elements[item].value == 'display') {
11028: var n = form.elements[depitem].options.length;
11029: form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
11030: }
11031: }
11032: }
11033: }
11034: }
11035: }
11036: } else {
11037: document.getElementById('arc_depon_'+count).style.display='none';
11038: form.elements[depitem].options.length = 0;
11039: form.elements[depitem].options[0] = new Option('Select','',true,true);
11040: }
1.1059 raeburn 11041: titleCheck(form,count,offset);
1.1056 raeburn 11042: }
11043: }
11044:
11045: function propagateSelect(form,count,offset) {
11046: if (count > 0) {
1.1065 raeburn 11047: var item = (1+offset+$startcount)+7*(count-1);
1.1056 raeburn 11048: var picked = form.elements[item].options[form.elements[item].selectedIndex].value;
11049: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
11050: if (parents[count].length > 0) {
11051: for (var j=0; j<parents[count].length; j++) {
11052: containerSelect(form,parents[count][j],offset,picked);
1.1055 raeburn 11053: }
11054: }
11055: }
11056: }
11057: }
1.1056 raeburn 11058:
11059: function containerSelect(form,count,offset,picked) {
11060: if (count > 0) {
1.1065 raeburn 11061: var item = (offset+$startcount)+7*(count-1);
1.1056 raeburn 11062: if (form.elements[item].type == 'radio') {
11063: if (form.elements[item].value == 'dependency') {
11064: if (form.elements[item+1].type == 'select-one') {
11065: for (var i=0; i<form.elements[item+1].options.length; i++) {
11066: if (form.elements[item+1].options[i].value == picked) {
11067: form.elements[item+1].selectedIndex = i;
11068: break;
11069: }
11070: }
11071: }
11072: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
11073: if (parents[count].length > 0) {
11074: for (var j=0; j<parents[count].length; j++) {
11075: containerSelect(form,parents[count][j],offset,picked);
11076: }
11077: }
11078: }
11079: }
11080: }
11081: }
11082: }
11083:
1.1059 raeburn 11084: function titleCheck(form,count,offset) {
11085: if (count > 0) {
11086: var chosen = (offset+$startcount)+7*(count-1);
11087: var depitem = $startcount + ((count-1) * 7) + 2;
11088: var currtype = form.elements[depitem].type;
11089: if (form.elements[chosen].value == 'display') {
11090: document.getElementById('arc_title_'+count).style.display='block';
11091: if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
11092: document.getElementById('archive_title_'+count).value=maintitle;
11093: }
11094: } else {
11095: document.getElementById('arc_title_'+count).style.display='none';
11096: if (currtype == 'text') {
11097: document.getElementById('archive_title_'+count).value='';
11098: }
11099: }
11100: }
11101: return;
11102: }
11103:
1.1055 raeburn 11104: // ]]>
11105: </script>
11106: END
11107: return $scripttag;
11108: }
11109:
11110: sub process_extracted_files {
1.1067 raeburn 11111: my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055 raeburn 11112: my $numitems = $env{'form.archive_count'};
11113: return unless ($numitems);
11114: my @ids=&Apache::lonnet::current_machine_ids();
11115: my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067 raeburn 11116: %folders,%containers,%mapinner,%prompttofetch);
1.1055 raeburn 11117: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
11118: if (grep(/^\Q$docuhome\E$/,@ids)) {
11119: $prefix = &LONCAPA::propath($docudom,$docuname);
11120: $pathtocheck = "$dir_root/$destination";
11121: $dir = $dir_root;
11122: $ishome = 1;
11123: } else {
11124: $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
11125: $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
11126: $dir = "$dir_root/$docudom/$docuname";
11127: }
11128: my $currdir = "$dir_root/$destination";
11129: (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
11130: if ($env{'form.folderpath'}) {
11131: my @items = split('&',$env{'form.folderpath'});
11132: $folders{'0'} = $items[-2];
11133: $containers{'0'}='sequence';
11134: } elsif ($env{'form.pagepath'}) {
11135: my @items = split('&',$env{'form.pagepath'});
11136: $folders{'0'} = $items[-2];
11137: $containers{'0'}='page';
11138: }
11139: my @archdirs = &get_env_multiple('form.archive_directory');
11140: if ($numitems) {
11141: for (my $i=1; $i<=$numitems; $i++) {
11142: my $path = $env{'form.archive_content_'.$i};
11143: if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
11144: my $item = $1;
11145: $toplevelitems{$item} = $i;
11146: if (grep(/^\Q$i\E$/,@archdirs)) {
11147: $is_dir{$item} = 1;
11148: }
11149: }
11150: }
11151: }
1.1067 raeburn 11152: my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055 raeburn 11153: if (keys(%toplevelitems) > 0) {
11154: my @contents = sort(keys(%toplevelitems));
1.1056 raeburn 11155: (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
11156: \%parent,\@contents,\%dirorder,\%titles);
1.1055 raeburn 11157: }
1.1066 raeburn 11158: my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055 raeburn 11159: if ($numitems) {
11160: for (my $i=1; $i<=$numitems; $i++) {
11161: my $path = $env{'form.archive_content_'.$i};
11162: if ($path =~ /^\Q$pathtocheck\E/) {
11163: if ($env{'form.archive_'.$i} eq 'discard') {
11164: if ($prefix ne '' && $path ne '') {
11165: if (-e $prefix.$path) {
1.1066 raeburn 11166: if ((@archdirs > 0) &&
11167: (grep(/^\Q$i\E$/,@archdirs))) {
11168: $todeletedir{$prefix.$path} = 1;
11169: } else {
11170: $todelete{$prefix.$path} = 1;
11171: }
1.1055 raeburn 11172: }
11173: }
11174: } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059 raeburn 11175: my ($docstitle,$title,$url,$outer);
1.1055 raeburn 11176: ($title) = ($path =~ m{/([^/]+)$});
1.1059 raeburn 11177: $docstitle = $env{'form.archive_title_'.$i};
11178: if ($docstitle eq '') {
11179: $docstitle = $title;
11180: }
1.1055 raeburn 11181: $outer = 0;
1.1056 raeburn 11182: if (ref($dirorder{$i}) eq 'ARRAY') {
11183: if (@{$dirorder{$i}} > 0) {
11184: foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055 raeburn 11185: if ($env{'form.archive_'.$item} eq 'display') {
11186: $outer = $item;
11187: last;
11188: }
11189: }
11190: }
11191: }
11192: my ($errtext,$fatal) =
11193: &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
11194: '/'.$folders{$outer}.'.'.
11195: $containers{$outer});
11196: next if ($fatal);
11197: if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
11198: if ($context eq 'coursedocs') {
1.1056 raeburn 11199: $mapinner{$i} = time;
1.1055 raeburn 11200: $folders{$i} = 'default_'.$mapinner{$i};
11201: $containers{$i} = 'sequence';
11202: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
11203: $folders{$i}.'.'.$containers{$i};
11204: my $newidx = &LONCAPA::map::getresidx();
11205: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 11206: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 11207: push(@LONCAPA::map::order,$newidx);
11208: my ($outtext,$errtext) =
11209: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
11210: $docuname.'/'.$folders{$outer}.
11211: '.'.$containers{$outer},1);
1.1056 raeburn 11212: $newseqid{$i} = $newidx;
1.1067 raeburn 11213: unless ($errtext) {
11214: $result .= '<li>'.&mt('Folder: [_1] added to course',$docstitle).'</li>'."\n";
11215: }
1.1055 raeburn 11216: }
11217: } else {
11218: if ($context eq 'coursedocs') {
11219: my $newidx=&LONCAPA::map::getresidx();
11220: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
11221: $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
11222: $title;
11223: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
11224: mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
11225: }
11226: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
11227: mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
11228: }
11229: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
11230: system("mv $prefix$path $prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title");
1.1056 raeburn 11231: $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
1.1067 raeburn 11232: unless ($ishome) {
11233: my $fetch = "$newdest{$i}/$title";
11234: $fetch =~ s/^\Q$prefix$dir\E//;
11235: $prompttofetch{$fetch} = 1;
11236: }
1.1055 raeburn 11237: }
11238: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 11239: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 11240: push(@LONCAPA::map::order, $newidx);
11241: my ($outtext,$errtext)=
11242: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
11243: $docuname.'/'.$folders{$outer}.
11244: '.'.$containers{$outer},1);
1.1067 raeburn 11245: unless ($errtext) {
11246: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
11247: $result .= '<li>'.&mt('File: [_1] added to course',$docstitle).'</li>'."\n";
11248: }
11249: }
1.1055 raeburn 11250: }
11251: }
11252: } elsif ($env{'form.archive_'.$i} eq 'dependency') {
1.1056 raeburn 11253: my ($title) = ($path =~ m{/([^/]+)$});
11254: $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
11255: if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
11256: if (ref($dirorder{$i}) eq 'ARRAY') {
1.1067 raeburn 11257: my ($itemidx,$fullpath,$relpath);
1.1056 raeburn 11258: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
11259: if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
11260: my $container = $dirorder{$referrer{$i}}->[-1];
11261: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
11262: if ($dirorder{$i}->[$j] eq $container) {
11263: $itemidx = $j;
11264: }
11265: }
11266: }
11267: }
11268: if ($itemidx ne '') {
11269: if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
11270: if ($mapinner{$referrer{$i}}) {
11271: $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
11272: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
11273: if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
11274: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
11275: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
1.1067 raeburn 11276: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
1.1056 raeburn 11277: if (!-e $fullpath) {
11278: mkdir($fullpath,0755);
11279: }
11280: }
11281: } else {
11282: last;
11283: }
11284: }
11285: }
11286: } elsif ($newdest{$referrer{$i}}) {
11287: $fullpath = $newdest{$referrer{$i}};
11288: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
11289: if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
11290: $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
11291: last;
11292: } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
11293: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
11294: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
1.1067 raeburn 11295: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
1.1056 raeburn 11296: if (!-e $fullpath) {
11297: mkdir($fullpath,0755);
11298: }
11299: }
11300: } else {
11301: last;
11302: }
11303: }
11304: }
11305: if ($fullpath ne '') {
1.1067 raeburn 11306: if (-e "$prefix$path") {
11307: system("mv $prefix$path $fullpath/$title");
11308: }
11309: if (-e "$fullpath/$title") {
11310: my $showpath;
11311: if ($relpath ne '') {
11312: $showpath = "$relpath/$title";
11313: } else {
11314: $showpath = "/$title";
11315: }
11316: $result .= '<li>'.&mt('[_1] included as a dependency',$showpath).'</li>'."\n";
11317: }
11318: unless ($ishome) {
11319: my $fetch = "$fullpath/$title";
11320: $fetch =~ s/^\Q$prefix$dir\E//;
11321: $prompttofetch{$fetch} = 1;
11322: }
1.1056 raeburn 11323: }
1.1055 raeburn 11324: }
11325: }
1.1056 raeburn 11326: } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
11327: $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
11328: $path,$env{'form.archive_content_'.$referrer{$i}}).'<br />';
1.1055 raeburn 11329: }
11330: }
11331: } else {
11332: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',$path).'<br />';
11333: }
11334: }
11335: if (keys(%todelete)) {
11336: foreach my $key (keys(%todelete)) {
11337: unlink($key);
1.1066 raeburn 11338: }
11339: }
11340: if (keys(%todeletedir)) {
11341: foreach my $key (keys(%todeletedir)) {
11342: rmdir($key);
11343: }
11344: }
11345: foreach my $dir (sort(keys(%is_dir))) {
11346: if (($pathtocheck ne '') && ($dir ne '')) {
11347: &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055 raeburn 11348: }
11349: }
1.1067 raeburn 11350: if ($result ne '') {
11351: $output .= '<ul>'."\n".
11352: $result."\n".
11353: '</ul>';
11354: }
11355: unless ($ishome) {
11356: my $replicationfail;
11357: foreach my $item (keys(%prompttofetch)) {
11358: my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
11359: unless ($fetchresult eq 'ok') {
11360: $replicationfail .= '<li>'.$item.'</li>'."\n";
11361: }
11362: }
11363: if ($replicationfail) {
11364: $output .= '<p class="LC_error">'.
11365: &mt('Course home server failed to retrieve:').'<ul>'.
11366: $replicationfail.
11367: '</ul></p>';
11368: }
11369: }
1.1055 raeburn 11370: } else {
11371: $warning = &mt('No items found in archive.');
11372: }
11373: if ($error) {
11374: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
11375: $error.'</p>'."\n";
11376: }
11377: if ($warning) {
11378: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
11379: }
11380: return $output;
11381: }
11382:
1.1066 raeburn 11383: sub cleanup_empty_dirs {
11384: my ($path) = @_;
11385: if (($path ne '') && (-d $path)) {
11386: if (opendir(my $dirh,$path)) {
11387: my @dircontents = grep(!/^\./,readdir($dirh));
11388: my $numitems = 0;
11389: foreach my $item (@dircontents) {
11390: if (-d "$path/$item") {
11391: &recurse_dirs("$path/$item");
11392: if (-e "$path/$item") {
11393: $numitems ++;
11394: }
11395: } else {
11396: $numitems ++;
11397: }
11398: }
11399: if ($numitems == 0) {
11400: rmdir($path);
11401: }
11402: closedir($dirh);
11403: }
11404: }
11405: return;
11406: }
11407:
1.41 ng 11408: =pod
1.45 matthew 11409:
1.1068 raeburn 11410: =item &get_folder_hierarchy()
11411:
11412: Provides hierarchy of names of folders/sub-folders containing the current
11413: item,
11414:
11415: Inputs: 3
11416: - $navmap - navmaps object
11417:
11418: - $map - url for map (either the trigger itself, or map containing
11419: the resource, which is the trigger).
11420:
11421: - $showitem - 1 => show title for map itself; 0 => do not show.
11422:
11423: Outputs: 1 @pathitems - array of folder/subfolder names.
11424:
11425: =cut
11426:
11427: sub get_folder_hierarchy {
11428: my ($navmap,$map,$showitem) = @_;
11429: my @pathitems;
11430: if (ref($navmap)) {
11431: my $mapres = $navmap->getResourceByUrl($map);
11432: if (ref($mapres)) {
11433: my $pcslist = $mapres->map_hierarchy();
11434: if ($pcslist ne '') {
11435: my @pcs = split(/,/,$pcslist);
11436: foreach my $pc (@pcs) {
11437: if ($pc == 1) {
11438: push(@pathitems,&mt('Main Course Documents'));
11439: } else {
11440: my $res = $navmap->getByMapPc($pc);
11441: if (ref($res)) {
11442: my $title = $res->compTitle();
11443: $title =~ s/\W+/_/g;
11444: if ($title ne '') {
11445: push(@pathitems,$title);
11446: }
11447: }
11448: }
11449: }
11450: }
1.1071 raeburn 11451: if ($showitem) {
11452: if ($mapres->{ID} eq '0.0') {
11453: push(@pathitems,&mt('Main Course Documents'));
11454: } else {
11455: my $maptitle = $mapres->compTitle();
11456: $maptitle =~ s/\W+/_/g;
11457: if ($maptitle ne '') {
11458: push(@pathitems,$maptitle);
11459: }
1.1068 raeburn 11460: }
11461: }
11462: }
11463: }
11464: return @pathitems;
11465: }
11466:
11467: =pod
11468:
1.1015 raeburn 11469: =item * &get_turnedin_filepath()
11470:
11471: Determines path in a user's portfolio file for storage of files uploaded
11472: to a specific essayresponse or dropbox item.
11473:
11474: Inputs: 3 required + 1 optional.
11475: $symb is symb for resource, $uname and $udom are for current user (required).
11476: $caller is optional (can be "submission", if routine is called when storing
11477: an upoaded file when "Submit Answer" button was pressed).
11478:
11479: Returns array containing $path and $multiresp.
11480: $path is path in portfolio. $multiresp is 1 if this resource contains more
11481: than one file upload item. Callers of routine should append partid as a
11482: subdirectory to $path in cases where $multiresp is 1.
11483:
11484: Called by: homework/essayresponse.pm and homework/structuretags.pm
11485:
11486: =cut
11487:
11488: sub get_turnedin_filepath {
11489: my ($symb,$uname,$udom,$caller) = @_;
11490: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
11491: my $turnindir;
11492: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
11493: $turnindir = $userhash{'turnindir'};
11494: my ($path,$multiresp);
11495: if ($turnindir eq '') {
11496: if ($caller eq 'submission') {
11497: $turnindir = &mt('turned in');
11498: $turnindir =~ s/\W+/_/g;
11499: my %newhash = (
11500: 'turnindir' => $turnindir,
11501: );
11502: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
11503: }
11504: }
11505: if ($turnindir ne '') {
11506: $path = '/'.$turnindir.'/';
11507: my ($multipart,$turnin,@pathitems);
11508: my $navmap = Apache::lonnavmaps::navmap->new();
11509: if (defined($navmap)) {
11510: my $mapres = $navmap->getResourceByUrl($map);
11511: if (ref($mapres)) {
11512: my $pcslist = $mapres->map_hierarchy();
11513: if ($pcslist ne '') {
11514: foreach my $pc (split(/,/,$pcslist)) {
11515: my $res = $navmap->getByMapPc($pc);
11516: if (ref($res)) {
11517: my $title = $res->compTitle();
11518: $title =~ s/\W+/_/g;
11519: if ($title ne '') {
11520: push(@pathitems,$title);
11521: }
11522: }
11523: }
11524: }
11525: my $maptitle = $mapres->compTitle();
11526: $maptitle =~ s/\W+/_/g;
11527: if ($maptitle ne '') {
11528: push(@pathitems,$maptitle);
11529: }
11530: unless ($env{'request.state'} eq 'construct') {
11531: my $res = $navmap->getBySymb($symb);
11532: if (ref($res)) {
11533: my $partlist = $res->parts();
11534: my $totaluploads = 0;
11535: if (ref($partlist) eq 'ARRAY') {
11536: foreach my $part (@{$partlist}) {
11537: my @types = $res->responseType($part);
11538: my @ids = $res->responseIds($part);
11539: for (my $i=0; $i < scalar(@ids); $i++) {
11540: if ($types[$i] eq 'essay') {
11541: my $partid = $part.'_'.$ids[$i];
11542: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
11543: $totaluploads ++;
11544: }
11545: }
11546: }
11547: }
11548: if ($totaluploads > 1) {
11549: $multiresp = 1;
11550: }
11551: }
11552: }
11553: }
11554: } else {
11555: return;
11556: }
11557: } else {
11558: return;
11559: }
11560: my $restitle=&Apache::lonnet::gettitle($symb);
11561: $restitle =~ s/\W+/_/g;
11562: if ($restitle eq '') {
11563: $restitle = ($resurl =~ m{/[^/]+$});
11564: if ($restitle eq '') {
11565: $restitle = time;
11566: }
11567: }
11568: push(@pathitems,$restitle);
11569: $path .= join('/',@pathitems);
11570: }
11571: return ($path,$multiresp);
11572: }
11573:
11574: =pod
11575:
1.464 albertel 11576: =back
1.41 ng 11577:
1.112 bowersj2 11578: =head1 CSV Upload/Handling functions
1.38 albertel 11579:
1.41 ng 11580: =over 4
11581:
1.648 raeburn 11582: =item * &upfile_store($r)
1.41 ng 11583:
11584: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 11585: needs $env{'form.upfile'}
1.41 ng 11586: returns $datatoken to be put into hidden field
11587:
11588: =cut
1.31 albertel 11589:
11590: sub upfile_store {
11591: my $r=shift;
1.258 albertel 11592: $env{'form.upfile'}=~s/\r/\n/gs;
11593: $env{'form.upfile'}=~s/\f/\n/gs;
11594: $env{'form.upfile'}=~s/\n+/\n/gs;
11595: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 11596:
1.258 albertel 11597: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
11598: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 11599: {
1.158 raeburn 11600: my $datafile = $r->dir_config('lonDaemons').
11601: '/tmp/'.$datatoken.'.tmp';
11602: if ( open(my $fh,">$datafile") ) {
1.258 albertel 11603: print $fh $env{'form.upfile'};
1.158 raeburn 11604: close($fh);
11605: }
1.31 albertel 11606: }
11607: return $datatoken;
11608: }
11609:
1.56 matthew 11610: =pod
11611:
1.648 raeburn 11612: =item * &load_tmp_file($r)
1.41 ng 11613:
11614: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 11615: needs $env{'form.datatoken'},
11616: sets $env{'form.upfile'} to the contents of the file
1.41 ng 11617:
11618: =cut
1.31 albertel 11619:
11620: sub load_tmp_file {
11621: my $r=shift;
11622: my @studentdata=();
11623: {
1.158 raeburn 11624: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 11625: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 11626: if ( open(my $fh,"<$studentfile") ) {
11627: @studentdata=<$fh>;
11628: close($fh);
11629: }
1.31 albertel 11630: }
1.258 albertel 11631: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 11632: }
11633:
1.56 matthew 11634: =pod
11635:
1.648 raeburn 11636: =item * &upfile_record_sep()
1.41 ng 11637:
11638: Separate uploaded file into records
11639: returns array of records,
1.258 albertel 11640: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 11641:
11642: =cut
1.31 albertel 11643:
11644: sub upfile_record_sep {
1.258 albertel 11645: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 11646: } else {
1.248 albertel 11647: my @records;
1.258 albertel 11648: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 11649: if ($line=~/^\s*$/) { next; }
11650: push(@records,$line);
11651: }
11652: return @records;
1.31 albertel 11653: }
11654: }
11655:
1.56 matthew 11656: =pod
11657:
1.648 raeburn 11658: =item * &record_sep($record)
1.41 ng 11659:
1.258 albertel 11660: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 11661:
11662: =cut
11663:
1.263 www 11664: sub takeleft {
11665: my $index=shift;
11666: return substr('0000'.$index,-4,4);
11667: }
11668:
1.31 albertel 11669: sub record_sep {
11670: my $record=shift;
11671: my %components=();
1.258 albertel 11672: if ($env{'form.upfiletype'} eq 'xml') {
11673: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 11674: my $i=0;
1.356 albertel 11675: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 11676: $field=~s/^(\"|\')//;
11677: $field=~s/(\"|\')$//;
1.263 www 11678: $components{&takeleft($i)}=$field;
1.31 albertel 11679: $i++;
11680: }
1.258 albertel 11681: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 11682: my $i=0;
1.356 albertel 11683: foreach my $field (split(/\t/,$record)) {
1.31 albertel 11684: $field=~s/^(\"|\')//;
11685: $field=~s/(\"|\')$//;
1.263 www 11686: $components{&takeleft($i)}=$field;
1.31 albertel 11687: $i++;
11688: }
11689: } else {
1.561 www 11690: my $separator=',';
1.480 banghart 11691: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 11692: $separator=';';
1.480 banghart 11693: }
1.31 albertel 11694: my $i=0;
1.561 www 11695: # the character we are looking for to indicate the end of a quote or a record
11696: my $looking_for=$separator;
11697: # do not add the characters to the fields
11698: my $ignore=0;
11699: # we just encountered a separator (or the beginning of the record)
11700: my $just_found_separator=1;
11701: # store the field we are working on here
11702: my $field='';
11703: # work our way through all characters in record
11704: foreach my $character ($record=~/(.)/g) {
11705: if ($character eq $looking_for) {
11706: if ($character ne $separator) {
11707: # Found the end of a quote, again looking for separator
11708: $looking_for=$separator;
11709: $ignore=1;
11710: } else {
11711: # Found a separator, store away what we got
11712: $components{&takeleft($i)}=$field;
11713: $i++;
11714: $just_found_separator=1;
11715: $ignore=0;
11716: $field='';
11717: }
11718: next;
11719: }
11720: # single or double quotation marks after a separator indicate beginning of a quote
11721: # we are now looking for the end of the quote and need to ignore separators
11722: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
11723: $looking_for=$character;
11724: next;
11725: }
11726: # ignore would be true after we reached the end of a quote
11727: if ($ignore) { next; }
11728: if (($just_found_separator) && ($character=~/\s/)) { next; }
11729: $field.=$character;
11730: $just_found_separator=0;
1.31 albertel 11731: }
1.561 www 11732: # catch the very last entry, since we never encountered the separator
11733: $components{&takeleft($i)}=$field;
1.31 albertel 11734: }
11735: return %components;
11736: }
11737:
1.144 matthew 11738: ######################################################
11739: ######################################################
11740:
1.56 matthew 11741: =pod
11742:
1.648 raeburn 11743: =item * &upfile_select_html()
1.41 ng 11744:
1.144 matthew 11745: Return HTML code to select a file from the users machine and specify
11746: the file type.
1.41 ng 11747:
11748: =cut
11749:
1.144 matthew 11750: ######################################################
11751: ######################################################
1.31 albertel 11752: sub upfile_select_html {
1.144 matthew 11753: my %Types = (
11754: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 11755: semisv => &mt('Semicolon separated values'),
1.144 matthew 11756: space => &mt('Space separated'),
11757: tab => &mt('Tabulator separated'),
11758: # xml => &mt('HTML/XML'),
11759: );
11760: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 11761: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 11762: foreach my $type (sort(keys(%Types))) {
11763: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
11764: }
11765: $Str .= "</select>\n";
11766: return $Str;
1.31 albertel 11767: }
11768:
1.301 albertel 11769: sub get_samples {
11770: my ($records,$toget) = @_;
11771: my @samples=({});
11772: my $got=0;
11773: foreach my $rec (@$records) {
11774: my %temp = &record_sep($rec);
11775: if (! grep(/\S/, values(%temp))) { next; }
11776: if (%temp) {
11777: $samples[$got]=\%temp;
11778: $got++;
11779: if ($got == $toget) { last; }
11780: }
11781: }
11782: return \@samples;
11783: }
11784:
1.144 matthew 11785: ######################################################
11786: ######################################################
11787:
1.56 matthew 11788: =pod
11789:
1.648 raeburn 11790: =item * &csv_print_samples($r,$records)
1.41 ng 11791:
11792: Prints a table of sample values from each column uploaded $r is an
11793: Apache Request ref, $records is an arrayref from
11794: &Apache::loncommon::upfile_record_sep
11795:
11796: =cut
11797:
1.144 matthew 11798: ######################################################
11799: ######################################################
1.31 albertel 11800: sub csv_print_samples {
11801: my ($r,$records) = @_;
1.662 bisitz 11802: my $samples = &get_samples($records,5);
1.301 albertel 11803:
1.594 raeburn 11804: $r->print(&mt('Samples').'<br />'.&start_data_table().
11805: &start_data_table_header_row());
1.356 albertel 11806: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 11807: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 11808: $r->print(&end_data_table_header_row());
1.301 albertel 11809: foreach my $hash (@$samples) {
1.594 raeburn 11810: $r->print(&start_data_table_row());
1.356 albertel 11811: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 11812: $r->print('<td>');
1.356 albertel 11813: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 11814: $r->print('</td>');
11815: }
1.594 raeburn 11816: $r->print(&end_data_table_row());
1.31 albertel 11817: }
1.594 raeburn 11818: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 11819: }
11820:
1.144 matthew 11821: ######################################################
11822: ######################################################
11823:
1.56 matthew 11824: =pod
11825:
1.648 raeburn 11826: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 11827:
11828: Prints a table to create associations between values and table columns.
1.144 matthew 11829:
1.41 ng 11830: $r is an Apache Request ref,
11831: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 11832: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 11833:
11834: =cut
11835:
1.144 matthew 11836: ######################################################
11837: ######################################################
1.31 albertel 11838: sub csv_print_select_table {
11839: my ($r,$records,$d) = @_;
1.301 albertel 11840: my $i=0;
11841: my $samples = &get_samples($records,1);
1.144 matthew 11842: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 11843: &start_data_table().&start_data_table_header_row().
1.144 matthew 11844: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 11845: '<th>'.&mt('Column').'</th>'.
11846: &end_data_table_header_row()."\n");
1.356 albertel 11847: foreach my $array_ref (@$d) {
11848: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 11849: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 11850:
1.875 bisitz 11851: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 11852: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 11853: $r->print('<option value="none"></option>');
1.356 albertel 11854: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
11855: $r->print('<option value="'.$sample.'"'.
11856: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 11857: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 11858: }
1.594 raeburn 11859: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 11860: $i++;
11861: }
1.594 raeburn 11862: $r->print(&end_data_table());
1.31 albertel 11863: $i--;
11864: return $i;
11865: }
1.56 matthew 11866:
1.144 matthew 11867: ######################################################
11868: ######################################################
11869:
1.56 matthew 11870: =pod
1.31 albertel 11871:
1.648 raeburn 11872: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 11873:
11874: Prints a table of sample values from the upload and can make associate samples to internal names.
11875:
11876: $r is an Apache Request ref,
11877: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
11878: $d is an array of 2 element arrays (internal name, displayed name)
11879:
11880: =cut
11881:
1.144 matthew 11882: ######################################################
11883: ######################################################
1.31 albertel 11884: sub csv_samples_select_table {
11885: my ($r,$records,$d) = @_;
11886: my $i=0;
1.144 matthew 11887: #
1.662 bisitz 11888: my $max_samples = 5;
11889: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 11890: $r->print(&start_data_table().
11891: &start_data_table_header_row().'<th>'.
11892: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
11893: &end_data_table_header_row());
1.301 albertel 11894:
11895: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 11896: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 11897: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 11898: foreach my $option (@$d) {
11899: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 11900: $r->print('<option value="'.$value.'"'.
1.253 albertel 11901: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 11902: $display.'</option>');
1.31 albertel 11903: }
11904: $r->print('</select></td><td>');
1.662 bisitz 11905: foreach my $line (0..($max_samples-1)) {
1.301 albertel 11906: if (defined($samples->[$line]{$key})) {
11907: $r->print($samples->[$line]{$key}."<br />\n");
11908: }
11909: }
1.594 raeburn 11910: $r->print('</td>'.&end_data_table_row());
1.31 albertel 11911: $i++;
11912: }
1.594 raeburn 11913: $r->print(&end_data_table());
1.31 albertel 11914: $i--;
11915: return($i);
1.115 matthew 11916: }
11917:
1.144 matthew 11918: ######################################################
11919: ######################################################
11920:
1.115 matthew 11921: =pod
11922:
1.648 raeburn 11923: =item * &clean_excel_name($name)
1.115 matthew 11924:
11925: Returns a replacement for $name which does not contain any illegal characters.
11926:
11927: =cut
11928:
1.144 matthew 11929: ######################################################
11930: ######################################################
1.115 matthew 11931: sub clean_excel_name {
11932: my ($name) = @_;
11933: $name =~ s/[:\*\?\/\\]//g;
11934: if (length($name) > 31) {
11935: $name = substr($name,0,31);
11936: }
11937: return $name;
1.25 albertel 11938: }
1.84 albertel 11939:
1.85 albertel 11940: =pod
11941:
1.648 raeburn 11942: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 11943:
11944: Returns either 1 or undef
11945:
11946: 1 if the part is to be hidden, undef if it is to be shown
11947:
11948: Arguments are:
11949:
11950: $id the id of the part to be checked
11951: $symb, optional the symb of the resource to check
11952: $udom, optional the domain of the user to check for
11953: $uname, optional the username of the user to check for
11954:
11955: =cut
1.84 albertel 11956:
11957: sub check_if_partid_hidden {
11958: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 11959: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 11960: $symb,$udom,$uname);
1.141 albertel 11961: my $truth=1;
11962: #if the string starts with !, then the list is the list to show not hide
11963: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 11964: my @hiddenlist=split(/,/,$hiddenparts);
11965: foreach my $checkid (@hiddenlist) {
1.141 albertel 11966: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 11967: }
1.141 albertel 11968: return !$truth;
1.84 albertel 11969: }
1.127 matthew 11970:
1.138 matthew 11971:
11972: ############################################################
11973: ############################################################
11974:
11975: =pod
11976:
1.157 matthew 11977: =back
11978:
1.138 matthew 11979: =head1 cgi-bin script and graphing routines
11980:
1.157 matthew 11981: =over 4
11982:
1.648 raeburn 11983: =item * &get_cgi_id()
1.138 matthew 11984:
11985: Inputs: none
11986:
11987: Returns an id which can be used to pass environment variables
11988: to various cgi-bin scripts. These environment variables will
11989: be removed from the users environment after a given time by
11990: the routine &Apache::lonnet::transfer_profile_to_env.
11991:
11992: =cut
11993:
11994: ############################################################
11995: ############################################################
1.152 albertel 11996: my $uniq=0;
1.136 matthew 11997: sub get_cgi_id {
1.154 albertel 11998: $uniq=($uniq+1)%100000;
1.280 albertel 11999: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 12000: }
12001:
1.127 matthew 12002: ############################################################
12003: ############################################################
12004:
12005: =pod
12006:
1.648 raeburn 12007: =item * &DrawBarGraph()
1.127 matthew 12008:
1.138 matthew 12009: Facilitates the plotting of data in a (stacked) bar graph.
12010: Puts plot definition data into the users environment in order for
12011: graph.png to plot it. Returns an <img> tag for the plot.
12012: The bars on the plot are labeled '1','2',...,'n'.
12013:
12014: Inputs:
12015:
12016: =over 4
12017:
12018: =item $Title: string, the title of the plot
12019:
12020: =item $xlabel: string, text describing the X-axis of the plot
12021:
12022: =item $ylabel: string, text describing the Y-axis of the plot
12023:
12024: =item $Max: scalar, the maximum Y value to use in the plot
12025: If $Max is < any data point, the graph will not be rendered.
12026:
1.140 matthew 12027: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 12028: they are plotted. If undefined, default values will be used.
12029:
1.178 matthew 12030: =item $labels: array ref holding the labels to use on the x-axis for the bars.
12031:
1.138 matthew 12032: =item @Values: An array of array references. Each array reference holds data
12033: to be plotted in a stacked bar chart.
12034:
1.239 matthew 12035: =item If the final element of @Values is a hash reference the key/value
12036: pairs will be added to the graph definition.
12037:
1.138 matthew 12038: =back
12039:
12040: Returns:
12041:
12042: An <img> tag which references graph.png and the appropriate identifying
12043: information for the plot.
12044:
1.127 matthew 12045: =cut
12046:
12047: ############################################################
12048: ############################################################
1.134 matthew 12049: sub DrawBarGraph {
1.178 matthew 12050: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 12051: #
12052: if (! defined($colors)) {
12053: $colors = ['#33ff00',
12054: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
12055: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
12056: ];
12057: }
1.228 matthew 12058: my $extra_settings = {};
12059: if (ref($Values[-1]) eq 'HASH') {
12060: $extra_settings = pop(@Values);
12061: }
1.127 matthew 12062: #
1.136 matthew 12063: my $identifier = &get_cgi_id();
12064: my $id = 'cgi.'.$identifier;
1.129 matthew 12065: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 12066: return '';
12067: }
1.225 matthew 12068: #
12069: my @Labels;
12070: if (defined($labels)) {
12071: @Labels = @$labels;
12072: } else {
12073: for (my $i=0;$i<@{$Values[0]};$i++) {
12074: push (@Labels,$i+1);
12075: }
12076: }
12077: #
1.129 matthew 12078: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 12079: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 12080: my %ValuesHash;
12081: my $NumSets=1;
12082: foreach my $array (@Values) {
12083: next if (! ref($array));
1.136 matthew 12084: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 12085: join(',',@$array);
1.129 matthew 12086: }
1.127 matthew 12087: #
1.136 matthew 12088: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 12089: if ($NumBars < 3) {
12090: $width = 120+$NumBars*32;
1.220 matthew 12091: $xskip = 1;
1.225 matthew 12092: $bar_width = 30;
12093: } elsif ($NumBars < 5) {
12094: $width = 120+$NumBars*20;
12095: $xskip = 1;
12096: $bar_width = 20;
1.220 matthew 12097: } elsif ($NumBars < 10) {
1.136 matthew 12098: $width = 120+$NumBars*15;
12099: $xskip = 1;
12100: $bar_width = 15;
12101: } elsif ($NumBars <= 25) {
12102: $width = 120+$NumBars*11;
12103: $xskip = 5;
12104: $bar_width = 8;
12105: } elsif ($NumBars <= 50) {
12106: $width = 120+$NumBars*8;
12107: $xskip = 5;
12108: $bar_width = 4;
12109: } else {
12110: $width = 120+$NumBars*8;
12111: $xskip = 5;
12112: $bar_width = 4;
12113: }
12114: #
1.137 matthew 12115: $Max = 1 if ($Max < 1);
12116: if ( int($Max) < $Max ) {
12117: $Max++;
12118: $Max = int($Max);
12119: }
1.127 matthew 12120: $Title = '' if (! defined($Title));
12121: $xlabel = '' if (! defined($xlabel));
12122: $ylabel = '' if (! defined($ylabel));
1.369 www 12123: $ValuesHash{$id.'.title'} = &escape($Title);
12124: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
12125: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 12126: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 12127: $ValuesHash{$id.'.NumBars'} = $NumBars;
12128: $ValuesHash{$id.'.NumSets'} = $NumSets;
12129: $ValuesHash{$id.'.PlotType'} = 'bar';
12130: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
12131: $ValuesHash{$id.'.height'} = $height;
12132: $ValuesHash{$id.'.width'} = $width;
12133: $ValuesHash{$id.'.xskip'} = $xskip;
12134: $ValuesHash{$id.'.bar_width'} = $bar_width;
12135: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 12136: #
1.228 matthew 12137: # Deal with other parameters
12138: while (my ($key,$value) = each(%$extra_settings)) {
12139: $ValuesHash{$id.'.'.$key} = $value;
12140: }
12141: #
1.646 raeburn 12142: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 12143: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
12144: }
12145:
12146: ############################################################
12147: ############################################################
12148:
12149: =pod
12150:
1.648 raeburn 12151: =item * &DrawXYGraph()
1.137 matthew 12152:
1.138 matthew 12153: Facilitates the plotting of data in an XY graph.
12154: Puts plot definition data into the users environment in order for
12155: graph.png to plot it. Returns an <img> tag for the plot.
12156:
12157: Inputs:
12158:
12159: =over 4
12160:
12161: =item $Title: string, the title of the plot
12162:
12163: =item $xlabel: string, text describing the X-axis of the plot
12164:
12165: =item $ylabel: string, text describing the Y-axis of the plot
12166:
12167: =item $Max: scalar, the maximum Y value to use in the plot
12168: If $Max is < any data point, the graph will not be rendered.
12169:
12170: =item $colors: Array ref containing the hex color codes for the data to be
12171: plotted in. If undefined, default values will be used.
12172:
12173: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
12174:
12175: =item $Ydata: Array ref containing Array refs.
1.185 www 12176: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 12177:
12178: =item %Values: hash indicating or overriding any default values which are
12179: passed to graph.png.
12180: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
12181:
12182: =back
12183:
12184: Returns:
12185:
12186: An <img> tag which references graph.png and the appropriate identifying
12187: information for the plot.
12188:
1.137 matthew 12189: =cut
12190:
12191: ############################################################
12192: ############################################################
12193: sub DrawXYGraph {
12194: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
12195: #
12196: # Create the identifier for the graph
12197: my $identifier = &get_cgi_id();
12198: my $id = 'cgi.'.$identifier;
12199: #
12200: $Title = '' if (! defined($Title));
12201: $xlabel = '' if (! defined($xlabel));
12202: $ylabel = '' if (! defined($ylabel));
12203: my %ValuesHash =
12204: (
1.369 www 12205: $id.'.title' => &escape($Title),
12206: $id.'.xlabel' => &escape($xlabel),
12207: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 12208: $id.'.y_max_value'=> $Max,
12209: $id.'.labels' => join(',',@$Xlabels),
12210: $id.'.PlotType' => 'XY',
12211: );
12212: #
12213: if (defined($colors) && ref($colors) eq 'ARRAY') {
12214: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
12215: }
12216: #
12217: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
12218: return '';
12219: }
12220: my $NumSets=1;
1.138 matthew 12221: foreach my $array (@{$Ydata}){
1.137 matthew 12222: next if (! ref($array));
12223: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
12224: }
1.138 matthew 12225: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 12226: #
12227: # Deal with other parameters
12228: while (my ($key,$value) = each(%Values)) {
12229: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 12230: }
12231: #
1.646 raeburn 12232: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 12233: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
12234: }
12235:
12236: ############################################################
12237: ############################################################
12238:
12239: =pod
12240:
1.648 raeburn 12241: =item * &DrawXYYGraph()
1.138 matthew 12242:
12243: Facilitates the plotting of data in an XY graph with two Y axes.
12244: Puts plot definition data into the users environment in order for
12245: graph.png to plot it. Returns an <img> tag for the plot.
12246:
12247: Inputs:
12248:
12249: =over 4
12250:
12251: =item $Title: string, the title of the plot
12252:
12253: =item $xlabel: string, text describing the X-axis of the plot
12254:
12255: =item $ylabel: string, text describing the Y-axis of the plot
12256:
12257: =item $colors: Array ref containing the hex color codes for the data to be
12258: plotted in. If undefined, default values will be used.
12259:
12260: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
12261:
12262: =item $Ydata1: The first data set
12263:
12264: =item $Min1: The minimum value of the left Y-axis
12265:
12266: =item $Max1: The maximum value of the left Y-axis
12267:
12268: =item $Ydata2: The second data set
12269:
12270: =item $Min2: The minimum value of the right Y-axis
12271:
12272: =item $Max2: The maximum value of the left Y-axis
12273:
12274: =item %Values: hash indicating or overriding any default values which are
12275: passed to graph.png.
12276: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
12277:
12278: =back
12279:
12280: Returns:
12281:
12282: An <img> tag which references graph.png and the appropriate identifying
12283: information for the plot.
1.136 matthew 12284:
12285: =cut
12286:
12287: ############################################################
12288: ############################################################
1.137 matthew 12289: sub DrawXYYGraph {
12290: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
12291: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 12292: #
12293: # Create the identifier for the graph
12294: my $identifier = &get_cgi_id();
12295: my $id = 'cgi.'.$identifier;
12296: #
12297: $Title = '' if (! defined($Title));
12298: $xlabel = '' if (! defined($xlabel));
12299: $ylabel = '' if (! defined($ylabel));
12300: my %ValuesHash =
12301: (
1.369 www 12302: $id.'.title' => &escape($Title),
12303: $id.'.xlabel' => &escape($xlabel),
12304: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 12305: $id.'.labels' => join(',',@$Xlabels),
12306: $id.'.PlotType' => 'XY',
12307: $id.'.NumSets' => 2,
1.137 matthew 12308: $id.'.two_axes' => 1,
12309: $id.'.y1_max_value' => $Max1,
12310: $id.'.y1_min_value' => $Min1,
12311: $id.'.y2_max_value' => $Max2,
12312: $id.'.y2_min_value' => $Min2,
1.136 matthew 12313: );
12314: #
1.137 matthew 12315: if (defined($colors) && ref($colors) eq 'ARRAY') {
12316: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
12317: }
12318: #
12319: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
12320: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 12321: return '';
12322: }
12323: my $NumSets=1;
1.137 matthew 12324: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 12325: next if (! ref($array));
12326: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 12327: }
12328: #
12329: # Deal with other parameters
12330: while (my ($key,$value) = each(%Values)) {
12331: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 12332: }
12333: #
1.646 raeburn 12334: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 12335: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 12336: }
12337:
12338: ############################################################
12339: ############################################################
12340:
12341: =pod
12342:
1.157 matthew 12343: =back
12344:
1.139 matthew 12345: =head1 Statistics helper routines?
12346:
12347: Bad place for them but what the hell.
12348:
1.157 matthew 12349: =over 4
12350:
1.648 raeburn 12351: =item * &chartlink()
1.139 matthew 12352:
12353: Returns a link to the chart for a specific student.
12354:
12355: Inputs:
12356:
12357: =over 4
12358:
12359: =item $linktext: The text of the link
12360:
12361: =item $sname: The students username
12362:
12363: =item $sdomain: The students domain
12364:
12365: =back
12366:
1.157 matthew 12367: =back
12368:
1.139 matthew 12369: =cut
12370:
12371: ############################################################
12372: ############################################################
12373: sub chartlink {
12374: my ($linktext, $sname, $sdomain) = @_;
12375: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 12376: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 12377: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 12378: '">'.$linktext.'</a>';
1.153 matthew 12379: }
12380:
12381: #######################################################
12382: #######################################################
12383:
12384: =pod
12385:
12386: =head1 Course Environment Routines
1.157 matthew 12387:
12388: =over 4
1.153 matthew 12389:
1.648 raeburn 12390: =item * &restore_course_settings()
1.153 matthew 12391:
1.648 raeburn 12392: =item * &store_course_settings()
1.153 matthew 12393:
12394: Restores/Store indicated form parameters from the course environment.
12395: Will not overwrite existing values of the form parameters.
12396:
12397: Inputs:
12398: a scalar describing the data (e.g. 'chart', 'problem_analysis')
12399:
12400: a hash ref describing the data to be stored. For example:
12401:
12402: %Save_Parameters = ('Status' => 'scalar',
12403: 'chartoutputmode' => 'scalar',
12404: 'chartoutputdata' => 'scalar',
12405: 'Section' => 'array',
1.373 raeburn 12406: 'Group' => 'array',
1.153 matthew 12407: 'StudentData' => 'array',
12408: 'Maps' => 'array');
12409:
12410: Returns: both routines return nothing
12411:
1.631 raeburn 12412: =back
12413:
1.153 matthew 12414: =cut
12415:
12416: #######################################################
12417: #######################################################
12418: sub store_course_settings {
1.496 albertel 12419: return &store_settings($env{'request.course.id'},@_);
12420: }
12421:
12422: sub store_settings {
1.153 matthew 12423: # save to the environment
12424: # appenv the same items, just to be safe
1.300 albertel 12425: my $udom = $env{'user.domain'};
12426: my $uname = $env{'user.name'};
1.496 albertel 12427: my ($context,$prefix,$Settings) = @_;
1.153 matthew 12428: my %SaveHash;
12429: my %AppHash;
12430: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 12431: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 12432: my $envname = 'environment.'.$basename;
1.258 albertel 12433: if (exists($env{'form.'.$setting})) {
1.153 matthew 12434: # Save this value away
12435: if ($type eq 'scalar' &&
1.258 albertel 12436: (! exists($env{$envname}) ||
12437: $env{$envname} ne $env{'form.'.$setting})) {
12438: $SaveHash{$basename} = $env{'form.'.$setting};
12439: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 12440: } elsif ($type eq 'array') {
12441: my $stored_form;
1.258 albertel 12442: if (ref($env{'form.'.$setting})) {
1.153 matthew 12443: $stored_form = join(',',
12444: map {
1.369 www 12445: &escape($_);
1.258 albertel 12446: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 12447: } else {
12448: $stored_form =
1.369 www 12449: &escape($env{'form.'.$setting});
1.153 matthew 12450: }
12451: # Determine if the array contents are the same.
1.258 albertel 12452: if ($stored_form ne $env{$envname}) {
1.153 matthew 12453: $SaveHash{$basename} = $stored_form;
12454: $AppHash{$envname} = $stored_form;
12455: }
12456: }
12457: }
12458: }
12459: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 12460: $udom,$uname);
1.153 matthew 12461: if ($put_result !~ /^(ok|delayed)/) {
12462: &Apache::lonnet::logthis('unable to save form parameters, '.
12463: 'got error:'.$put_result);
12464: }
12465: # Make sure these settings stick around in this session, too
1.646 raeburn 12466: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 12467: return;
12468: }
12469:
12470: sub restore_course_settings {
1.499 albertel 12471: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 12472: }
12473:
12474: sub restore_settings {
12475: my ($context,$prefix,$Settings) = @_;
1.153 matthew 12476: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 12477: next if (exists($env{'form.'.$setting}));
1.496 albertel 12478: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 12479: '.'.$setting;
1.258 albertel 12480: if (exists($env{$envname})) {
1.153 matthew 12481: if ($type eq 'scalar') {
1.258 albertel 12482: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 12483: } elsif ($type eq 'array') {
1.258 albertel 12484: $env{'form.'.$setting} = [
1.153 matthew 12485: map {
1.369 www 12486: &unescape($_);
1.258 albertel 12487: } split(',',$env{$envname})
1.153 matthew 12488: ];
12489: }
12490: }
12491: }
1.127 matthew 12492: }
12493:
1.618 raeburn 12494: #######################################################
12495: #######################################################
12496:
12497: =pod
12498:
12499: =head1 Domain E-mail Routines
12500:
12501: =over 4
12502:
1.648 raeburn 12503: =item * &build_recipient_list()
1.618 raeburn 12504:
1.884 raeburn 12505: Build recipient lists for five types of e-mail:
1.766 raeburn 12506: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884 raeburn 12507: (d) Help requests, (e) Course requests needing approval, generated by
12508: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
12509: loncoursequeueadmin.pm respectively.
1.618 raeburn 12510:
12511: Inputs:
1.619 raeburn 12512: defmail (scalar - email address of default recipient),
1.618 raeburn 12513: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 12514: defdom (domain for which to retrieve configuration settings),
12515: origmail (scalar - email address of recipient from loncapa.conf,
12516: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 12517:
1.655 raeburn 12518: Returns: comma separated list of addresses to which to send e-mail.
12519:
12520: =back
1.618 raeburn 12521:
12522: =cut
12523:
12524: ############################################################
12525: ############################################################
12526: sub build_recipient_list {
1.619 raeburn 12527: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 12528: my @recipients;
12529: my $otheremails;
12530: my %domconfig =
12531: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
12532: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 12533: if (exists($domconfig{'contacts'}{$mailing})) {
12534: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
12535: my @contacts = ('adminemail','supportemail');
12536: foreach my $item (@contacts) {
12537: if ($domconfig{'contacts'}{$mailing}{$item}) {
12538: my $addr = $domconfig{'contacts'}{$item};
12539: if (!grep(/^\Q$addr\E$/,@recipients)) {
12540: push(@recipients,$addr);
12541: }
1.619 raeburn 12542: }
1.766 raeburn 12543: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 12544: }
12545: }
1.766 raeburn 12546: } elsif ($origmail ne '') {
12547: push(@recipients,$origmail);
1.618 raeburn 12548: }
1.619 raeburn 12549: } elsif ($origmail ne '') {
12550: push(@recipients,$origmail);
1.618 raeburn 12551: }
1.688 raeburn 12552: if (defined($defmail)) {
12553: if ($defmail ne '') {
12554: push(@recipients,$defmail);
12555: }
1.618 raeburn 12556: }
12557: if ($otheremails) {
1.619 raeburn 12558: my @others;
12559: if ($otheremails =~ /,/) {
12560: @others = split(/,/,$otheremails);
1.618 raeburn 12561: } else {
1.619 raeburn 12562: push(@others,$otheremails);
12563: }
12564: foreach my $addr (@others) {
12565: if (!grep(/^\Q$addr\E$/,@recipients)) {
12566: push(@recipients,$addr);
12567: }
1.618 raeburn 12568: }
12569: }
1.619 raeburn 12570: my $recipientlist = join(',',@recipients);
1.618 raeburn 12571: return $recipientlist;
12572: }
12573:
1.127 matthew 12574: ############################################################
12575: ############################################################
1.154 albertel 12576:
1.655 raeburn 12577: =pod
12578:
12579: =head1 Course Catalog Routines
12580:
12581: =over 4
12582:
12583: =item * &gather_categories()
12584:
12585: Converts category definitions - keys of categories hash stored in
12586: coursecategories in configuration.db on the primary library server in a
12587: domain - to an array. Also generates javascript and idx hash used to
12588: generate Domain Coordinator interface for editing Course Categories.
12589:
12590: Inputs:
1.663 raeburn 12591:
1.655 raeburn 12592: categories (reference to hash of category definitions).
1.663 raeburn 12593:
1.655 raeburn 12594: cats (reference to array of arrays/hashes which encapsulates hierarchy of
12595: categories and subcategories).
1.663 raeburn 12596:
1.655 raeburn 12597: idx (reference to hash of counters used in Domain Coordinator interface for
12598: editing Course Categories).
1.663 raeburn 12599:
1.655 raeburn 12600: jsarray (reference to array of categories used to create Javascript arrays for
12601: Domain Coordinator interface for editing Course Categories).
12602:
12603: Returns: nothing
12604:
12605: Side effects: populates cats, idx and jsarray.
12606:
12607: =cut
12608:
12609: sub gather_categories {
12610: my ($categories,$cats,$idx,$jsarray) = @_;
12611: my %counters;
12612: my $num = 0;
12613: foreach my $item (keys(%{$categories})) {
12614: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
12615: if ($container eq '' && $depth == 0) {
12616: $cats->[$depth][$categories->{$item}] = $cat;
12617: } else {
12618: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
12619: }
12620: my ($escitem,$tail) = split(/:/,$item,2);
12621: if ($counters{$tail} eq '') {
12622: $counters{$tail} = $num;
12623: $num ++;
12624: }
12625: if (ref($idx) eq 'HASH') {
12626: $idx->{$item} = $counters{$tail};
12627: }
12628: if (ref($jsarray) eq 'ARRAY') {
12629: push(@{$jsarray->[$counters{$tail}]},$item);
12630: }
12631: }
12632: return;
12633: }
12634:
12635: =pod
12636:
12637: =item * &extract_categories()
12638:
12639: Used to generate breadcrumb trails for course categories.
12640:
12641: Inputs:
1.663 raeburn 12642:
1.655 raeburn 12643: categories (reference to hash of category definitions).
1.663 raeburn 12644:
1.655 raeburn 12645: cats (reference to array of arrays/hashes which encapsulates hierarchy of
12646: categories and subcategories).
1.663 raeburn 12647:
1.655 raeburn 12648: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 12649:
1.655 raeburn 12650: allitems (reference to hash - key is category key
12651: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 12652:
1.655 raeburn 12653: idx (reference to hash of counters used in Domain Coordinator interface for
12654: editing Course Categories).
1.663 raeburn 12655:
1.655 raeburn 12656: jsarray (reference to array of categories used to create Javascript arrays for
12657: Domain Coordinator interface for editing Course Categories).
12658:
1.665 raeburn 12659: subcats (reference to hash of arrays containing all subcategories within each
12660: category, -recursive)
12661:
1.655 raeburn 12662: Returns: nothing
12663:
12664: Side effects: populates trails and allitems hash references.
12665:
12666: =cut
12667:
12668: sub extract_categories {
1.665 raeburn 12669: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 12670: if (ref($categories) eq 'HASH') {
12671: &gather_categories($categories,$cats,$idx,$jsarray);
12672: if (ref($cats->[0]) eq 'ARRAY') {
12673: for (my $i=0; $i<@{$cats->[0]}; $i++) {
12674: my $name = $cats->[0][$i];
12675: my $item = &escape($name).'::0';
12676: my $trailstr;
12677: if ($name eq 'instcode') {
12678: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 12679: } elsif ($name eq 'communities') {
12680: $trailstr = &mt('Communities');
1.655 raeburn 12681: } else {
12682: $trailstr = $name;
12683: }
12684: if ($allitems->{$item} eq '') {
12685: push(@{$trails},$trailstr);
12686: $allitems->{$item} = scalar(@{$trails})-1;
12687: }
12688: my @parents = ($name);
12689: if (ref($cats->[1]{$name}) eq 'ARRAY') {
12690: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
12691: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 12692: if (ref($subcats) eq 'HASH') {
12693: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
12694: }
12695: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
12696: }
12697: } else {
12698: if (ref($subcats) eq 'HASH') {
12699: $subcats->{$item} = [];
1.655 raeburn 12700: }
12701: }
12702: }
12703: }
12704: }
12705: return;
12706: }
12707:
12708: =pod
12709:
12710: =item *&recurse_categories()
12711:
12712: Recursively used to generate breadcrumb trails for course categories.
12713:
12714: Inputs:
1.663 raeburn 12715:
1.655 raeburn 12716: cats (reference to array of arrays/hashes which encapsulates hierarchy of
12717: categories and subcategories).
1.663 raeburn 12718:
1.655 raeburn 12719: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 12720:
12721: category (current course category, for which breadcrumb trail is being generated).
12722:
12723: trails (reference to array of breadcrumb trails for each category).
12724:
1.655 raeburn 12725: allitems (reference to hash - key is category key
12726: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 12727:
1.655 raeburn 12728: parents (array containing containers directories for current category,
12729: back to top level).
12730:
12731: Returns: nothing
12732:
12733: Side effects: populates trails and allitems hash references
12734:
12735: =cut
12736:
12737: sub recurse_categories {
1.665 raeburn 12738: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 12739: my $shallower = $depth - 1;
12740: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
12741: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
12742: my $name = $cats->[$depth]{$category}[$k];
12743: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
12744: my $trailstr = join(' -> ',(@{$parents},$category));
12745: if ($allitems->{$item} eq '') {
12746: push(@{$trails},$trailstr);
12747: $allitems->{$item} = scalar(@{$trails})-1;
12748: }
12749: my $deeper = $depth+1;
12750: push(@{$parents},$category);
1.665 raeburn 12751: if (ref($subcats) eq 'HASH') {
12752: my $subcat = &escape($name).':'.$category.':'.$depth;
12753: for (my $j=@{$parents}; $j>=0; $j--) {
12754: my $higher;
12755: if ($j > 0) {
12756: $higher = &escape($parents->[$j]).':'.
12757: &escape($parents->[$j-1]).':'.$j;
12758: } else {
12759: $higher = &escape($parents->[$j]).'::'.$j;
12760: }
12761: push(@{$subcats->{$higher}},$subcat);
12762: }
12763: }
12764: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
12765: $subcats);
1.655 raeburn 12766: pop(@{$parents});
12767: }
12768: } else {
12769: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
12770: my $trailstr = join(' -> ',(@{$parents},$category));
12771: if ($allitems->{$item} eq '') {
12772: push(@{$trails},$trailstr);
12773: $allitems->{$item} = scalar(@{$trails})-1;
12774: }
12775: }
12776: return;
12777: }
12778:
1.663 raeburn 12779: =pod
12780:
12781: =item *&assign_categories_table()
12782:
12783: Create a datatable for display of hierarchical categories in a domain,
12784: with checkboxes to allow a course to be categorized.
12785:
12786: Inputs:
12787:
12788: cathash - reference to hash of categories defined for the domain (from
12789: configuration.db)
12790:
12791: currcat - scalar with an & separated list of categories assigned to a course.
12792:
1.919 raeburn 12793: type - scalar contains course type (Course or Community).
12794:
1.663 raeburn 12795: Returns: $output (markup to be displayed)
12796:
12797: =cut
12798:
12799: sub assign_categories_table {
1.919 raeburn 12800: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 12801: my $output;
12802: if (ref($cathash) eq 'HASH') {
12803: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
12804: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
12805: $maxdepth = scalar(@cats);
12806: if (@cats > 0) {
12807: my $itemcount = 0;
12808: if (ref($cats[0]) eq 'ARRAY') {
12809: my @currcategories;
12810: if ($currcat ne '') {
12811: @currcategories = split('&',$currcat);
12812: }
1.919 raeburn 12813: my $table;
1.663 raeburn 12814: for (my $i=0; $i<@{$cats[0]}; $i++) {
12815: my $parent = $cats[0][$i];
1.919 raeburn 12816: next if ($parent eq 'instcode');
12817: if ($type eq 'Community') {
12818: next unless ($parent eq 'communities');
12819: } else {
12820: next if ($parent eq 'communities');
12821: }
1.663 raeburn 12822: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
12823: my $item = &escape($parent).'::0';
12824: my $checked = '';
12825: if (@currcategories > 0) {
12826: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 12827: $checked = ' checked="checked"';
1.663 raeburn 12828: }
12829: }
1.919 raeburn 12830: my $parent_title = $parent;
12831: if ($parent eq 'communities') {
12832: $parent_title = &mt('Communities');
12833: }
12834: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
12835: '<input type="checkbox" name="usecategory" value="'.
12836: $item.'"'.$checked.' />'.$parent_title.'</span>'.
12837: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 12838: my $depth = 1;
12839: push(@path,$parent);
1.919 raeburn 12840: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 12841: pop(@path);
1.919 raeburn 12842: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 12843: $itemcount ++;
12844: }
1.919 raeburn 12845: if ($itemcount) {
12846: $output = &Apache::loncommon::start_data_table().
12847: $table.
12848: &Apache::loncommon::end_data_table();
12849: }
1.663 raeburn 12850: }
12851: }
12852: }
12853: return $output;
12854: }
12855:
12856: =pod
12857:
12858: =item *&assign_category_rows()
12859:
12860: Create a datatable row for display of nested categories in a domain,
12861: with checkboxes to allow a course to be categorized,called recursively.
12862:
12863: Inputs:
12864:
12865: itemcount - track row number for alternating colors
12866:
12867: cats - reference to array of arrays/hashes which encapsulates hierarchy of
12868: categories and subcategories.
12869:
12870: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
12871:
12872: parent - parent of current category item
12873:
12874: path - Array containing all categories back up through the hierarchy from the
12875: current category to the top level.
12876:
12877: currcategories - reference to array of current categories assigned to the course
12878:
12879: Returns: $output (markup to be displayed).
12880:
12881: =cut
12882:
12883: sub assign_category_rows {
12884: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
12885: my ($text,$name,$item,$chgstr);
12886: if (ref($cats) eq 'ARRAY') {
12887: my $maxdepth = scalar(@{$cats});
12888: if (ref($cats->[$depth]) eq 'HASH') {
12889: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
12890: my $numchildren = @{$cats->[$depth]{$parent}};
12891: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
12892: $text .= '<td><table class="LC_datatable">';
12893: for (my $j=0; $j<$numchildren; $j++) {
12894: $name = $cats->[$depth]{$parent}[$j];
12895: $item = &escape($name).':'.&escape($parent).':'.$depth;
12896: my $deeper = $depth+1;
12897: my $checked = '';
12898: if (ref($currcategories) eq 'ARRAY') {
12899: if (@{$currcategories} > 0) {
12900: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 12901: $checked = ' checked="checked"';
1.663 raeburn 12902: }
12903: }
12904: }
1.664 raeburn 12905: $text .= '<tr><td><span class="LC_nobreak"><label>'.
12906: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 12907: $item.'"'.$checked.' />'.$name.'</label></span>'.
12908: '<input type="hidden" name="catname" value="'.$name.'" />'.
12909: '</td><td>';
1.663 raeburn 12910: if (ref($path) eq 'ARRAY') {
12911: push(@{$path},$name);
12912: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
12913: pop(@{$path});
12914: }
12915: $text .= '</td></tr>';
12916: }
12917: $text .= '</table></td>';
12918: }
12919: }
12920: }
12921: return $text;
12922: }
12923:
1.655 raeburn 12924: ############################################################
12925: ############################################################
12926:
12927:
1.443 albertel 12928: sub commit_customrole {
1.664 raeburn 12929: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 12930: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 12931: ($start?', '.&mt('starting').' '.localtime($start):'').
12932: ($end?', ending '.localtime($end):'').': <b>'.
12933: &Apache::lonnet::assigncustomrole(
1.664 raeburn 12934: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 12935: '</b><br />';
12936: return $output;
12937: }
12938:
12939: sub commit_standardrole {
1.541 raeburn 12940: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
12941: my ($output,$logmsg,$linefeed);
12942: if ($context eq 'auto') {
12943: $linefeed = "\n";
12944: } else {
12945: $linefeed = "<br />\n";
12946: }
1.443 albertel 12947: if ($three eq 'st') {
1.541 raeburn 12948: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
12949: $one,$two,$sec,$context);
12950: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 12951: ($result eq 'unknown_course') || ($result eq 'refused')) {
12952: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 12953: } else {
1.541 raeburn 12954: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 12955: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 12956: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
12957: if ($context eq 'auto') {
12958: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
12959: } else {
12960: $output .= '<b>'.$result.'</b>'.$linefeed.
12961: &mt('Add to classlist').': <b>ok</b>';
12962: }
12963: $output .= $linefeed;
1.443 albertel 12964: }
12965: } else {
12966: $output = &mt('Assigning').' '.$three.' in '.$url.
12967: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 12968: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 12969: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 12970: if ($context eq 'auto') {
12971: $output .= $result.$linefeed;
12972: } else {
12973: $output .= '<b>'.$result.'</b>'.$linefeed;
12974: }
1.443 albertel 12975: }
12976: return $output;
12977: }
12978:
12979: sub commit_studentrole {
1.541 raeburn 12980: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 12981: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 12982: if ($context eq 'auto') {
12983: $linefeed = "\n";
12984: } else {
12985: $linefeed = '<br />'."\n";
12986: }
1.443 albertel 12987: if (defined($one) && defined($two)) {
12988: my $cid=$one.'_'.$two;
12989: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
12990: my $secchange = 0;
12991: my $expire_role_result;
12992: my $modify_section_result;
1.628 raeburn 12993: if ($oldsec ne '-1') {
12994: if ($oldsec ne $sec) {
1.443 albertel 12995: $secchange = 1;
1.628 raeburn 12996: my $now = time;
1.443 albertel 12997: my $uurl='/'.$cid;
12998: $uurl=~s/\_/\//g;
12999: if ($oldsec) {
13000: $uurl.='/'.$oldsec;
13001: }
1.626 raeburn 13002: $oldsecurl = $uurl;
1.628 raeburn 13003: $expire_role_result =
1.652 raeburn 13004: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 13005: if ($env{'request.course.sec'} ne '') {
13006: if ($expire_role_result eq 'refused') {
13007: my @roles = ('st');
13008: my @statuses = ('previous');
13009: my @roledoms = ($one);
13010: my $withsec = 1;
13011: my %roleshash =
13012: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
13013: \@statuses,\@roles,\@roledoms,$withsec);
13014: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
13015: my ($oldstart,$oldend) =
13016: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
13017: if ($oldend > 0 && $oldend <= $now) {
13018: $expire_role_result = 'ok';
13019: }
13020: }
13021: }
13022: }
1.443 albertel 13023: $result = $expire_role_result;
13024: }
13025: }
13026: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 13027: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 13028: if ($modify_section_result =~ /^ok/) {
13029: if ($secchange == 1) {
1.628 raeburn 13030: if ($sec eq '') {
13031: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
13032: } else {
13033: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
13034: }
1.443 albertel 13035: } elsif ($oldsec eq '-1') {
1.628 raeburn 13036: if ($sec eq '') {
13037: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
13038: } else {
13039: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
13040: }
1.443 albertel 13041: } else {
1.628 raeburn 13042: if ($sec eq '') {
13043: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
13044: } else {
13045: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
13046: }
1.443 albertel 13047: }
13048: } else {
1.628 raeburn 13049: if ($secchange) {
13050: $$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;
13051: } else {
13052: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
13053: }
1.443 albertel 13054: }
13055: $result = $modify_section_result;
13056: } elsif ($secchange == 1) {
1.628 raeburn 13057: if ($oldsec eq '') {
13058: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
13059: } else {
13060: $$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;
13061: }
1.626 raeburn 13062: if ($expire_role_result eq 'refused') {
13063: my $newsecurl = '/'.$cid;
13064: $newsecurl =~ s/\_/\//g;
13065: if ($sec ne '') {
13066: $newsecurl.='/'.$sec;
13067: }
13068: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
13069: if ($sec eq '') {
13070: $$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;
13071: } else {
13072: $$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;
13073: }
13074: }
13075: }
1.443 albertel 13076: }
13077: } else {
1.626 raeburn 13078: $$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 13079: $result = "error: incomplete course id\n";
13080: }
13081: return $result;
13082: }
13083:
13084: ############################################################
13085: ############################################################
13086:
1.566 albertel 13087: sub check_clone {
1.578 raeburn 13088: my ($args,$linefeed) = @_;
1.566 albertel 13089: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
13090: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
13091: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
13092: my $clonemsg;
13093: my $can_clone = 0;
1.944 raeburn 13094: my $lctype = lc($args->{'crstype'});
1.908 raeburn 13095: if ($lctype ne 'community') {
13096: $lctype = 'course';
13097: }
1.566 albertel 13098: if ($clonehome eq 'no_host') {
1.944 raeburn 13099: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13100: $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'});
13101: } else {
13102: $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'});
13103: }
1.566 albertel 13104: } else {
13105: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944 raeburn 13106: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13107: if ($clonedesc{'type'} ne 'Community') {
13108: $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'});
13109: return ($can_clone, $clonemsg, $cloneid, $clonehome);
13110: }
13111: }
1.882 raeburn 13112: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
13113: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 13114: $can_clone = 1;
13115: } else {
13116: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
13117: $args->{'clonedomain'},$args->{'clonecourse'});
13118: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 13119: if (grep(/^\*$/,@cloners)) {
13120: $can_clone = 1;
13121: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
13122: $can_clone = 1;
13123: } else {
1.908 raeburn 13124: my $ccrole = 'cc';
1.944 raeburn 13125: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13126: $ccrole = 'co';
13127: }
1.578 raeburn 13128: my %roleshash =
13129: &Apache::lonnet::get_my_roles($args->{'ccuname'},
13130: $args->{'ccdomain'},
1.908 raeburn 13131: 'userroles',['active'],[$ccrole],
1.578 raeburn 13132: [$args->{'clonedomain'}]);
1.908 raeburn 13133: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942 raeburn 13134: $can_clone = 1;
13135: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
13136: $can_clone = 1;
13137: } else {
1.944 raeburn 13138: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13139: $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'});
13140: } else {
13141: $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'});
13142: }
1.578 raeburn 13143: }
1.566 albertel 13144: }
1.578 raeburn 13145: }
1.566 albertel 13146: }
13147: return ($can_clone, $clonemsg, $cloneid, $clonehome);
13148: }
13149:
1.444 albertel 13150: sub construct_course {
1.885 raeburn 13151: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444 albertel 13152: my $outcome;
1.541 raeburn 13153: my $linefeed = '<br />'."\n";
13154: if ($context eq 'auto') {
13155: $linefeed = "\n";
13156: }
1.566 albertel 13157:
13158: #
13159: # Are we cloning?
13160: #
13161: my ($can_clone, $clonemsg, $cloneid, $clonehome);
13162: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 13163: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 13164: if ($context ne 'auto') {
1.578 raeburn 13165: if ($clonemsg ne '') {
13166: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
13167: }
1.566 albertel 13168: }
13169: $outcome .= $clonemsg.$linefeed;
13170:
13171: if (!$can_clone) {
13172: return (0,$outcome);
13173: }
13174: }
13175:
1.444 albertel 13176: #
13177: # Open course
13178: #
13179: my $crstype = lc($args->{'crstype'});
13180: my %cenv=();
13181: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
13182: $args->{'cdescr'},
13183: $args->{'curl'},
13184: $args->{'course_home'},
13185: $args->{'nonstandard'},
13186: $args->{'crscode'},
13187: $args->{'ccuname'}.':'.
13188: $args->{'ccdomain'},
1.882 raeburn 13189: $args->{'crstype'},
1.885 raeburn 13190: $cnum,$context,$category);
1.444 albertel 13191:
13192: # Note: The testing routines depend on this being output; see
13193: # Utils::Course. This needs to at least be output as a comment
13194: # if anyone ever decides to not show this, and Utils::Course::new
13195: # will need to be suitably modified.
1.541 raeburn 13196: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943 raeburn 13197: if ($$courseid =~ /^error:/) {
13198: return (0,$outcome);
13199: }
13200:
1.444 albertel 13201: #
13202: # Check if created correctly
13203: #
1.479 albertel 13204: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 13205: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 13206: if ($crsuhome eq 'no_host') {
13207: $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
13208: return (0,$outcome);
13209: }
1.541 raeburn 13210: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 13211:
1.444 albertel 13212: #
1.566 albertel 13213: # Do the cloning
13214: #
13215: if ($can_clone && $cloneid) {
13216: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
13217: if ($context ne 'auto') {
13218: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
13219: }
13220: $outcome .= $clonemsg.$linefeed;
13221: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 13222: # Copy all files
1.637 www 13223: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 13224: # Restore URL
1.566 albertel 13225: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 13226: # Restore title
1.566 albertel 13227: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 13228: # Restore creation date, creator and creation context.
13229: $cenv{'internal.created'}=$oldcenv{'internal.created'};
13230: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
13231: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 13232: # Mark as cloned
1.566 albertel 13233: $cenv{'clonedfrom'}=$cloneid;
1.638 www 13234: # Need to clone grading mode
13235: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
13236: $cenv{'grading'}=$newenv{'grading'};
13237: # Do not clone these environment entries
13238: &Apache::lonnet::del('environment',
13239: ['default_enrollment_start_date',
13240: 'default_enrollment_end_date',
13241: 'question.email',
13242: 'policy.email',
13243: 'comment.email',
13244: 'pch.users.denied',
1.725 raeburn 13245: 'plc.users.denied',
13246: 'hidefromcat',
13247: 'categories'],
1.638 www 13248: $$crsudom,$$crsunum);
1.444 albertel 13249: }
1.566 albertel 13250:
1.444 albertel 13251: #
13252: # Set environment (will override cloned, if existing)
13253: #
13254: my @sections = ();
13255: my @xlists = ();
13256: if ($args->{'crstype'}) {
13257: $cenv{'type'}=$args->{'crstype'};
13258: }
13259: if ($args->{'crsid'}) {
13260: $cenv{'courseid'}=$args->{'crsid'};
13261: }
13262: if ($args->{'crscode'}) {
13263: $cenv{'internal.coursecode'}=$args->{'crscode'};
13264: }
13265: if ($args->{'crsquota'} ne '') {
13266: $cenv{'internal.coursequota'}=$args->{'crsquota'};
13267: } else {
13268: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
13269: }
13270: if ($args->{'ccuname'}) {
13271: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
13272: ':'.$args->{'ccdomain'};
13273: } else {
13274: $cenv{'internal.courseowner'} = $args->{'curruser'};
13275: }
13276: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
13277: if ($args->{'crssections'}) {
13278: $cenv{'internal.sectionnums'} = '';
13279: if ($args->{'crssections'} =~ m/,/) {
13280: @sections = split/,/,$args->{'crssections'};
13281: } else {
13282: $sections[0] = $args->{'crssections'};
13283: }
13284: if (@sections > 0) {
13285: foreach my $item (@sections) {
13286: my ($sec,$gp) = split/:/,$item;
13287: my $class = $args->{'crscode'}.$sec;
13288: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
13289: $cenv{'internal.sectionnums'} .= $item.',';
13290: unless ($addcheck eq 'ok') {
13291: push @badclasses, $class;
13292: }
13293: }
13294: $cenv{'internal.sectionnums'} =~ s/,$//;
13295: }
13296: }
13297: # do not hide course coordinator from staff listing,
13298: # even if privileged
13299: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
13300: # add crosslistings
13301: if ($args->{'crsxlist'}) {
13302: $cenv{'internal.crosslistings'}='';
13303: if ($args->{'crsxlist'} =~ m/,/) {
13304: @xlists = split/,/,$args->{'crsxlist'};
13305: } else {
13306: $xlists[0] = $args->{'crsxlist'};
13307: }
13308: if (@xlists > 0) {
13309: foreach my $item (@xlists) {
13310: my ($xl,$gp) = split/:/,$item;
13311: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
13312: $cenv{'internal.crosslistings'} .= $item.',';
13313: unless ($addcheck eq 'ok') {
13314: push @badclasses, $xl;
13315: }
13316: }
13317: $cenv{'internal.crosslistings'} =~ s/,$//;
13318: }
13319: }
13320: if ($args->{'autoadds'}) {
13321: $cenv{'internal.autoadds'}=$args->{'autoadds'};
13322: }
13323: if ($args->{'autodrops'}) {
13324: $cenv{'internal.autodrops'}=$args->{'autodrops'};
13325: }
13326: # check for notification of enrollment changes
13327: my @notified = ();
13328: if ($args->{'notify_owner'}) {
13329: if ($args->{'ccuname'} ne '') {
13330: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
13331: }
13332: }
13333: if ($args->{'notify_dc'}) {
13334: if ($uname ne '') {
1.630 raeburn 13335: push(@notified,$uname.':'.$udom);
1.444 albertel 13336: }
13337: }
13338: if (@notified > 0) {
13339: my $notifylist;
13340: if (@notified > 1) {
13341: $notifylist = join(',',@notified);
13342: } else {
13343: $notifylist = $notified[0];
13344: }
13345: $cenv{'internal.notifylist'} = $notifylist;
13346: }
13347: if (@badclasses > 0) {
13348: my %lt=&Apache::lonlocal::texthash(
13349: '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',
13350: 'dnhr' => 'does not have rights to access enrollment in these classes',
13351: 'adby' => 'as determined by the policies of your institution on access to official classlists'
13352: );
1.541 raeburn 13353: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
13354: ' ('.$lt{'adby'}.')';
13355: if ($context eq 'auto') {
13356: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 13357: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 13358: foreach my $item (@badclasses) {
13359: if ($context eq 'auto') {
13360: $outcome .= " - $item\n";
13361: } else {
13362: $outcome .= "<li>$item</li>\n";
13363: }
13364: }
13365: if ($context eq 'auto') {
13366: $outcome .= $linefeed;
13367: } else {
1.566 albertel 13368: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 13369: }
13370: }
1.444 albertel 13371: }
13372: if ($args->{'no_end_date'}) {
13373: $args->{'endaccess'} = 0;
13374: }
13375: $cenv{'internal.autostart'}=$args->{'enrollstart'};
13376: $cenv{'internal.autoend'}=$args->{'enrollend'};
13377: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
13378: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
13379: if ($args->{'showphotos'}) {
13380: $cenv{'internal.showphotos'}=$args->{'showphotos'};
13381: }
13382: $cenv{'internal.authtype'} = $args->{'authtype'};
13383: $cenv{'internal.autharg'} = $args->{'autharg'};
13384: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
13385: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 13386: 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');
13387: if ($context eq 'auto') {
13388: $outcome .= $krb_msg;
13389: } else {
1.566 albertel 13390: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 13391: }
13392: $outcome .= $linefeed;
1.444 albertel 13393: }
13394: }
13395: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
13396: if ($args->{'setpolicy'}) {
13397: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
13398: }
13399: if ($args->{'setcontent'}) {
13400: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
13401: }
13402: }
13403: if ($args->{'reshome'}) {
13404: $cenv{'reshome'}=$args->{'reshome'}.'/';
13405: $cenv{'reshome'}=~s/\/+$/\//;
13406: }
13407: #
13408: # course has keyed access
13409: #
13410: if ($args->{'setkeys'}) {
13411: $cenv{'keyaccess'}='yes';
13412: }
13413: # if specified, key authority is not course, but user
13414: # only active if keyaccess is yes
13415: if ($args->{'keyauth'}) {
1.487 albertel 13416: my ($user,$domain) = split(':',$args->{'keyauth'});
13417: $user = &LONCAPA::clean_username($user);
13418: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 13419: if ($user ne '' && $domain ne '') {
1.487 albertel 13420: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 13421: }
13422: }
13423:
13424: if ($args->{'disresdis'}) {
13425: $cenv{'pch.roles.denied'}='st';
13426: }
13427: if ($args->{'disablechat'}) {
13428: $cenv{'plc.roles.denied'}='st';
13429: }
13430:
13431: # Record we've not yet viewed the Course Initialization Helper for this
13432: # course
13433: $cenv{'course.helper.not.run'} = 1;
13434: #
13435: # Use new Randomseed
13436: #
13437: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
13438: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
13439: #
13440: # The encryption code and receipt prefix for this course
13441: #
13442: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
13443: $cenv{'internal.encpref'}=100+int(9*rand(99));
13444: #
13445: # By default, use standard grading
13446: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
13447:
1.541 raeburn 13448: $outcome .= $linefeed.&mt('Setting environment').': '.
13449: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 13450: #
13451: # Open all assignments
13452: #
13453: if ($args->{'openall'}) {
13454: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
13455: my %storecontent = ($storeunder => time,
13456: $storeunder.'.type' => 'date_start');
13457:
13458: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 13459: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 13460: }
13461: #
13462: # Set first page
13463: #
13464: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
13465: || ($cloneid)) {
1.445 albertel 13466: use LONCAPA::map;
1.444 albertel 13467: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 13468:
13469: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
13470: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
13471:
1.444 albertel 13472: $outcome .= ($fatal?$errtext:'read ok').' - ';
13473: my $title; my $url;
13474: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 13475: $title=&mt('Syllabus');
1.444 albertel 13476: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
13477: } else {
1.963 raeburn 13478: $title=&mt('Table of Contents');
1.444 albertel 13479: $url='/adm/navmaps';
13480: }
1.445 albertel 13481:
13482: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
13483: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
13484:
13485: if ($errtext) { $fatal=2; }
1.541 raeburn 13486: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 13487: }
1.566 albertel 13488:
13489: return (1,$outcome);
1.444 albertel 13490: }
13491:
13492: ############################################################
13493: ############################################################
13494:
1.953 droeschl 13495: #SD
13496: # only Community and Course, or anything else?
1.378 raeburn 13497: sub course_type {
13498: my ($cid) = @_;
13499: if (!defined($cid)) {
13500: $cid = $env{'request.course.id'};
13501: }
1.404 albertel 13502: if (defined($env{'course.'.$cid.'.type'})) {
13503: return $env{'course.'.$cid.'.type'};
1.378 raeburn 13504: } else {
13505: return 'Course';
1.377 raeburn 13506: }
13507: }
1.156 albertel 13508:
1.406 raeburn 13509: sub group_term {
13510: my $crstype = &course_type();
13511: my %names = (
13512: 'Course' => 'group',
1.865 raeburn 13513: 'Community' => 'group',
1.406 raeburn 13514: );
13515: return $names{$crstype};
13516: }
13517:
1.902 raeburn 13518: sub course_types {
13519: my @types = ('official','unofficial','community');
13520: my %typename = (
13521: official => 'Official course',
13522: unofficial => 'Unofficial course',
13523: community => 'Community',
13524: );
13525: return (\@types,\%typename);
13526: }
13527:
1.156 albertel 13528: sub icon {
13529: my ($file)=@_;
1.505 albertel 13530: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 13531: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 13532: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 13533: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
13534: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
13535: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
13536: $curfext.".gif") {
13537: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
13538: $curfext.".gif";
13539: }
13540: }
1.249 albertel 13541: return &lonhttpdurl($iconname);
1.154 albertel 13542: }
1.84 albertel 13543:
1.575 albertel 13544: sub lonhttpdurl {
1.692 www 13545: #
13546: # Had been used for "small fry" static images on separate port 8080.
13547: # Modify here if lightweight http functionality desired again.
13548: # Currently eliminated due to increasing firewall issues.
13549: #
1.575 albertel 13550: my ($url)=@_;
1.692 www 13551: return $url;
1.215 albertel 13552: }
13553:
1.213 albertel 13554: sub connection_aborted {
13555: my ($r)=@_;
13556: $r->print(" ");$r->rflush();
13557: my $c = $r->connection;
13558: return $c->aborted();
13559: }
13560:
1.221 foxr 13561: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 13562: # strings as 'strings'.
13563: sub escape_single {
1.221 foxr 13564: my ($input) = @_;
1.223 albertel 13565: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 13566: $input =~ s/\'/\\\'/g; # Esacpe the 's....
13567: return $input;
13568: }
1.223 albertel 13569:
1.222 foxr 13570: # Same as escape_single, but escape's "'s This
13571: # can be used for "strings"
13572: sub escape_double {
13573: my ($input) = @_;
13574: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
13575: $input =~ s/\"/\\\"/g; # Esacpe the "s....
13576: return $input;
13577: }
1.223 albertel 13578:
1.222 foxr 13579: # Escapes the last element of a full URL.
13580: sub escape_url {
13581: my ($url) = @_;
1.238 raeburn 13582: my @urlslices = split(/\//, $url,-1);
1.369 www 13583: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 13584: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 13585: }
1.462 albertel 13586:
1.820 raeburn 13587: sub compare_arrays {
13588: my ($arrayref1,$arrayref2) = @_;
13589: my (@difference,%count);
13590: @difference = ();
13591: %count = ();
13592: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
13593: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
13594: foreach my $element (keys(%count)) {
13595: if ($count{$element} == 1) {
13596: push(@difference,$element);
13597: }
13598: }
13599: }
13600: return @difference;
13601: }
13602:
1.817 bisitz 13603: # -------------------------------------------------------- Initialize user login
1.462 albertel 13604: sub init_user_environment {
1.463 albertel 13605: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 13606: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
13607:
13608: my $public=($username eq 'public' && $domain eq 'public');
13609:
13610: # See if old ID present, if so, remove
13611:
1.1062 raeburn 13612: my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462 albertel 13613: my $now=time;
13614:
13615: if ($public) {
13616: my $max_public=100;
13617: my $oldest;
13618: my $oldest_time=0;
13619: for(my $next=1;$next<=$max_public;$next++) {
13620: if (-e $lonids."/publicuser_$next.id") {
13621: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
13622: if ($mtime<$oldest_time || !$oldest_time) {
13623: $oldest_time=$mtime;
13624: $oldest=$next;
13625: }
13626: } else {
13627: $cookie="publicuser_$next";
13628: last;
13629: }
13630: }
13631: if (!$cookie) { $cookie="publicuser_$oldest"; }
13632: } else {
1.463 albertel 13633: # if this isn't a robot, kill any existing non-robot sessions
13634: if (!$args->{'robot'}) {
13635: opendir(DIR,$lonids);
13636: while ($filename=readdir(DIR)) {
13637: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
13638: unlink($lonids.'/'.$filename);
13639: }
1.462 albertel 13640: }
1.463 albertel 13641: closedir(DIR);
1.462 albertel 13642: }
13643: # Give them a new cookie
1.463 albertel 13644: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 13645: : $now.$$.int(rand(10000)));
1.463 albertel 13646: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 13647:
13648: # Initialize roles
13649:
1.1062 raeburn 13650: ($userroles,$firstaccenv,$timerintenv) =
13651: &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462 albertel 13652: }
13653: # ------------------------------------ Check browser type and MathML capability
13654:
13655: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
13656: $clientunicode,$clientos) = &decode_user_agent($r);
13657:
13658: # ------------------------------------------------------------- Get environment
13659:
13660: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
13661: my ($tmp) = keys(%userenv);
13662: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
13663: } else {
13664: undef(%userenv);
13665: }
13666: if (($userenv{'interface'}) && (!$form->{'interface'})) {
13667: $form->{'interface'}=$userenv{'interface'};
13668: }
13669: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
13670:
13671: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 13672: foreach my $option ('interface','localpath','localres') {
13673: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 13674: }
13675: # --------------------------------------------------------- Write first profile
13676:
13677: {
13678: my %initial_env =
13679: ("user.name" => $username,
13680: "user.domain" => $domain,
13681: "user.home" => $authhost,
13682: "browser.type" => $clientbrowser,
13683: "browser.version" => $clientversion,
13684: "browser.mathml" => $clientmathml,
13685: "browser.unicode" => $clientunicode,
13686: "browser.os" => $clientos,
13687: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
13688: "request.course.fn" => '',
13689: "request.course.uri" => '',
13690: "request.course.sec" => '',
13691: "request.role" => 'cm',
13692: "request.role.adv" => $env{'user.adv'},
13693: "request.host" => $ENV{'REMOTE_ADDR'},);
13694:
13695: if ($form->{'localpath'}) {
13696: $initial_env{"browser.localpath"} = $form->{'localpath'};
13697: $initial_env{"browser.localres"} = $form->{'localres'};
13698: }
13699:
13700: if ($form->{'interface'}) {
13701: $form->{'interface'}=~s/\W//gs;
13702: $initial_env{"browser.interface"} = $form->{'interface'};
13703: $env{'browser.interface'}=$form->{'interface'};
13704: }
13705:
1.981 raeburn 13706: my %is_adv = ( is_adv => $env{'user.adv'} );
1.1016 raeburn 13707: my %domdef;
13708: unless ($domain eq 'public') {
13709: %domdef = &Apache::lonnet::get_domain_defaults($domain);
13710: }
1.980 raeburn 13711:
1.724 raeburn 13712: foreach my $tool ('aboutme','blog','portfolio') {
13713: $userenv{'availabletools.'.$tool} =
1.980 raeburn 13714: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
13715: undef,\%userenv,\%domdef,\%is_adv);
1.724 raeburn 13716: }
13717:
1.864 raeburn 13718: foreach my $crstype ('official','unofficial','community') {
1.765 raeburn 13719: $userenv{'canrequest.'.$crstype} =
13720: &Apache::lonnet::usertools_access($username,$domain,$crstype,
1.980 raeburn 13721: 'reload','requestcourses',
13722: \%userenv,\%domdef,\%is_adv);
1.765 raeburn 13723: }
13724:
1.462 albertel 13725: $env{'user.environment'} = "$lonids/$cookie.id";
1.1062 raeburn 13726:
1.462 albertel 13727: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
13728: &GDBM_WRCREAT(),0640)) {
13729: &_add_to_env(\%disk_env,\%initial_env);
13730: &_add_to_env(\%disk_env,\%userenv,'environment.');
13731: &_add_to_env(\%disk_env,$userroles);
1.1062 raeburn 13732: if (ref($firstaccenv) eq 'HASH') {
13733: &_add_to_env(\%disk_env,$firstaccenv);
13734: }
13735: if (ref($timerintenv) eq 'HASH') {
13736: &_add_to_env(\%disk_env,$timerintenv);
13737: }
1.463 albertel 13738: if (ref($args->{'extra_env'})) {
13739: &_add_to_env(\%disk_env,$args->{'extra_env'});
13740: }
1.462 albertel 13741: untie(%disk_env);
13742: } else {
1.705 tempelho 13743: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
13744: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 13745: return 'error: '.$!;
13746: }
13747: }
13748: $env{'request.role'}='cm';
13749: $env{'request.role.adv'}=$env{'user.adv'};
13750: $env{'browser.type'}=$clientbrowser;
13751:
13752: return $cookie;
13753:
13754: }
13755:
13756: sub _add_to_env {
13757: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 13758: if (ref($env_data) eq 'HASH') {
13759: while (my ($key,$value) = each(%$env_data)) {
13760: $idf->{$prefix.$key} = $value;
13761: $env{$prefix.$key} = $value;
13762: }
1.462 albertel 13763: }
13764: }
13765:
1.685 tempelho 13766: # --- Get the symbolic name of a problem and the url
13767: sub get_symb {
13768: my ($request,$silent) = @_;
1.726 raeburn 13769: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 13770: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
13771: if ($symb eq '') {
13772: if (!$silent) {
1.1071 raeburn 13773: if (ref($request)) {
13774: $request->print("Unable to handle ambiguous references:$url:.");
13775: }
1.685 tempelho 13776: return ();
13777: }
13778: }
13779: &Apache::lonenc::check_decrypt(\$symb);
13780: return ($symb);
13781: }
13782:
13783: # --------------------------------------------------------------Get annotation
13784:
13785: sub get_annotation {
13786: my ($symb,$enc) = @_;
13787:
13788: my $key = $symb;
13789: if (!$enc) {
13790: $key =
13791: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
13792: }
13793: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
13794: return $annotation{$key};
13795: }
13796:
13797: sub clean_symb {
1.731 raeburn 13798: my ($symb,$delete_enc) = @_;
1.685 tempelho 13799:
13800: &Apache::lonenc::check_decrypt(\$symb);
13801: my $enc = $env{'request.enc'};
1.731 raeburn 13802: if ($delete_enc) {
1.730 raeburn 13803: delete($env{'request.enc'});
13804: }
1.685 tempelho 13805:
13806: return ($symb,$enc);
13807: }
1.462 albertel 13808:
1.990 raeburn 13809: sub build_release_hashes {
13810: my ($checkparms,$checkresponsetypes,$checkcrstypes,$anonsurvey,$randomizetry) = @_;
13811: return unless((ref($checkparms) eq 'HASH') && (ref($checkresponsetypes) eq 'HASH') &&
13812: (ref($checkcrstypes) eq 'HASH') && (ref($anonsurvey) eq 'HASH') &&
13813: (ref($randomizetry) eq 'HASH'));
13814: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
13815: my ($item,$name,$value) = split(/:/,$key);
13816: if ($item eq 'parameter') {
13817: if (ref($checkparms->{$name}) eq 'ARRAY') {
13818: unless(grep(/^\Q$name\E$/,@{$checkparms->{$name}})) {
13819: push(@{$checkparms->{$name}},$value);
13820: }
13821: } else {
13822: push(@{$checkparms->{$name}},$value);
13823: }
13824: } elsif ($item eq 'resourcetag') {
13825: if ($name eq 'responsetype') {
13826: $checkresponsetypes->{$value} = $Apache::lonnet::needsrelease{$key}
13827: }
13828: } elsif ($item eq 'course') {
13829: if ($name eq 'crstype') {
13830: $checkcrstypes->{$value} = $Apache::lonnet::needsrelease{$key};
13831: }
13832: }
13833: }
13834: ($anonsurvey->{major},$anonsurvey->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:anonsurvey'});
13835: ($randomizetry->{major},$randomizetry->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:randomizetry'});
13836: return;
13837: }
13838:
1.41 ng 13839: =pod
13840:
13841: =back
13842:
1.112 bowersj2 13843: =cut
1.41 ng 13844:
1.112 bowersj2 13845: 1;
13846: __END__;
1.41 ng 13847:
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