Annotation of loncom/interface/loncommon.pm, revision 1.1075.2.2
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1075.2.2! raeburn 4: # $Id: loncommon.pm,v 1.1075.2.1 2012/05/15 23:01:24 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:
1.1075.2.2! raeburn 5061:
1.916 droeschl 5062: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.1075.2.1 raeburn 5063: unless ($env{'request.noversionuri'} =~ m{/res/adm/pages/bookmarkmenu/}) {
5064: if ($dc_info) {
5065: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
5066: }
5067: $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
5068: <em>$realm</em> $dc_info</div>|;
5069: }
1.903 droeschl 5070: return $bodytag;
5071: }
1.894 droeschl 5072:
1.927 raeburn 5073: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
5074: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
5075: }
1.916 droeschl 5076:
1.903 droeschl 5077: $bodytag .= Apache::lonhtmlcommon::scripttag(
5078: Apache::lonmenu::utilityfunctions(), 'start');
1.816 bisitz 5079:
1.903 droeschl 5080: $bodytag .= Apache::lonmenu::primary_menu();
1.852 droeschl 5081:
1.917 raeburn 5082: if ($dc_info) {
5083: $dc_info = &dc_courseid_toggle($dc_info);
5084: }
5085: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 5086:
1.903 droeschl 5087: #don't show menus for public users
1.954 raeburn 5088: if (!$public){
1.903 droeschl 5089: $bodytag .= Apache::lonmenu::secondary_menu();
5090: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 5091: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
5092: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 5093: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.920 raeburn 5094: $args->{'bread_crumbs'});
5095: } elsif ($forcereg) {
5096: $bodytag .= &Apache::lonmenu::innerregister($forcereg);
5097: }
1.903 droeschl 5098: }else{
5099: # this is to seperate menu from content when there's no secondary
5100: # menu. Especially needed for public accessible ressources.
5101: $bodytag .= '<hr style="clear:both" />';
5102: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 5103: }
1.903 droeschl 5104:
1.235 raeburn 5105: return $bodytag;
1.182 matthew 5106: }
5107:
1.917 raeburn 5108: sub dc_courseid_toggle {
5109: my ($dc_info) = @_;
1.980 raeburn 5110: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069 raeburn 5111: '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917 raeburn 5112: &mt('(More ...)').'</a></span>'.
5113: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
5114: }
5115:
1.330 albertel 5116: sub make_attr_string {
5117: my ($register,$attr_ref) = @_;
5118:
5119: if ($attr_ref && !ref($attr_ref)) {
5120: die("addentries Must be a hash ref ".
5121: join(':',caller(1))." ".
5122: join(':',caller(0))." ");
5123: }
5124:
5125: if ($register) {
1.339 albertel 5126: my ($on_load,$on_unload);
5127: foreach my $key (keys(%{$attr_ref})) {
5128: if (lc($key) eq 'onload') {
5129: $on_load.=$attr_ref->{$key}.';';
5130: delete($attr_ref->{$key});
5131:
5132: } elsif (lc($key) eq 'onunload') {
5133: $on_unload.=$attr_ref->{$key}.';';
5134: delete($attr_ref->{$key});
5135: }
5136: }
1.953 droeschl 5137: $attr_ref->{'onload'} = $on_load;
5138: $attr_ref->{'onunload'}= $on_unload;
1.330 albertel 5139: }
1.339 albertel 5140:
1.330 albertel 5141: my $attr_string;
5142: foreach my $attr (keys(%$attr_ref)) {
5143: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
5144: }
5145: return $attr_string;
5146: }
5147:
5148:
1.182 matthew 5149: ###############################################
1.251 albertel 5150: ###############################################
5151:
5152: =pod
5153:
5154: =item * &endbodytag()
5155:
5156: Returns a uniform footer for LON-CAPA web pages.
5157:
1.635 raeburn 5158: Inputs: 1 - optional reference to an args hash
5159: If in the hash, key for noredirectlink has a value which evaluates to true,
5160: a 'Continue' link is not displayed if the page contains an
5161: internal redirect in the <head></head> section,
5162: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 5163:
5164: =cut
5165:
5166: sub endbodytag {
1.635 raeburn 5167: my ($args) = @_;
1.251 albertel 5168: my $endbodytag='</body>';
1.269 albertel 5169: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 5170: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 5171: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
5172: $endbodytag=
5173: "<br /><a href=\"$env{'internal.head.redirect'}\">".
5174: &mt('Continue').'</a>'.
5175: $endbodytag;
5176: }
1.315 albertel 5177: }
1.251 albertel 5178: return $endbodytag;
5179: }
5180:
1.352 albertel 5181: =pod
5182:
5183: =item * &standard_css()
5184:
5185: Returns a style sheet
5186:
5187: Inputs: (all optional)
5188: domain -> force to color decorate a page for a specific
5189: domain
5190: function -> force usage of a specific rolish color scheme
5191: bgcolor -> override the default page bgcolor
5192:
5193: =cut
5194:
1.343 albertel 5195: sub standard_css {
1.345 albertel 5196: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 5197: $function = &get_users_function() if (!$function);
5198: my $img = &designparm($function.'.img', $domain);
5199: my $tabbg = &designparm($function.'.tabbg', $domain);
5200: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 5201: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 5202: #second colour for later usage
1.345 albertel 5203: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 5204: my $pgbg_or_bgcolor =
5205: $bgcolor ||
1.352 albertel 5206: &designparm($function.'.pgbg', $domain);
1.382 albertel 5207: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 5208: my $alink = &designparm($function.'.alink', $domain);
5209: my $vlink = &designparm($function.'.vlink', $domain);
5210: my $link = &designparm($function.'.link', $domain);
5211:
1.602 albertel 5212: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 5213: my $mono = 'monospace';
1.850 bisitz 5214: my $data_table_head = $sidebg;
5215: my $data_table_light = '#FAFAFA';
1.1060 bisitz 5216: my $data_table_dark = '#E0E0E0';
1.470 banghart 5217: my $data_table_darker = '#CCCCCC';
1.349 albertel 5218: my $data_table_highlight = '#FFFF00';
1.352 albertel 5219: my $mail_new = '#FFBB77';
5220: my $mail_new_hover = '#DD9955';
5221: my $mail_read = '#BBBB77';
5222: my $mail_read_hover = '#999944';
5223: my $mail_replied = '#AAAA88';
5224: my $mail_replied_hover = '#888855';
5225: my $mail_other = '#99BBBB';
5226: my $mail_other_hover = '#669999';
1.391 albertel 5227: my $table_header = '#DDDDDD';
1.489 raeburn 5228: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 5229: my $lg_border_color = '#C8C8C8';
1.952 onken 5230: my $button_hover = '#BF2317';
1.392 albertel 5231:
1.608 albertel 5232: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 5233: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
5234: : '0 3px 0 4px';
1.448 albertel 5235:
1.523 albertel 5236:
1.343 albertel 5237: return <<END;
1.947 droeschl 5238:
5239: /* needed for iframe to allow 100% height in FF */
5240: body, html {
5241: margin: 0;
5242: padding: 0 0.5%;
5243: height: 99%; /* to avoid scrollbars */
5244: }
5245:
1.795 www 5246: body {
1.911 bisitz 5247: font-family: $sans;
5248: line-height:130%;
5249: font-size:0.83em;
5250: color:$font;
1.795 www 5251: }
5252:
1.959 onken 5253: a:focus,
5254: a:focus img {
1.795 www 5255: color: red;
5256: }
1.698 harmsja 5257:
1.911 bisitz 5258: form, .inline {
5259: display: inline;
1.795 www 5260: }
1.721 harmsja 5261:
1.795 www 5262: .LC_right {
1.911 bisitz 5263: text-align:right;
1.795 www 5264: }
5265:
5266: .LC_middle {
1.911 bisitz 5267: vertical-align:middle;
1.795 www 5268: }
1.721 harmsja 5269:
1.911 bisitz 5270: .LC_400Box {
5271: width:400px;
5272: }
1.721 harmsja 5273:
1.947 droeschl 5274: .LC_iframecontainer {
5275: width: 98%;
5276: margin: 0;
5277: position: fixed;
5278: top: 8.5em;
5279: bottom: 0;
5280: }
5281:
5282: .LC_iframecontainer iframe{
5283: border: none;
5284: width: 100%;
5285: height: 100%;
5286: }
5287:
1.778 bisitz 5288: .LC_filename {
5289: font-family: $mono;
5290: white-space:pre;
1.921 bisitz 5291: font-size: 120%;
1.778 bisitz 5292: }
5293:
5294: .LC_fileicon {
5295: border: none;
5296: height: 1.3em;
5297: vertical-align: text-bottom;
5298: margin-right: 0.3em;
5299: text-decoration:none;
5300: }
5301:
1.1008 www 5302: .LC_setting {
5303: text-decoration:underline;
5304: }
5305:
1.350 albertel 5306: .LC_error {
5307: color: red;
5308: font-size: larger;
5309: }
1.795 www 5310:
1.457 albertel 5311: .LC_warning,
5312: .LC_diff_removed {
1.733 bisitz 5313: color: red;
1.394 albertel 5314: }
1.532 albertel 5315:
5316: .LC_info,
1.457 albertel 5317: .LC_success,
5318: .LC_diff_added {
1.350 albertel 5319: color: green;
5320: }
1.795 www 5321:
1.802 bisitz 5322: div.LC_confirm_box {
5323: background-color: #FAFAFA;
5324: border: 1px solid $lg_border_color;
5325: margin-right: 0;
5326: padding: 5px;
5327: }
5328:
5329: div.LC_confirm_box .LC_error img,
5330: div.LC_confirm_box .LC_success img {
5331: vertical-align: middle;
5332: }
5333:
1.440 albertel 5334: .LC_icon {
1.771 droeschl 5335: border: none;
1.790 droeschl 5336: vertical-align: middle;
1.771 droeschl 5337: }
5338:
1.543 albertel 5339: .LC_docs_spacer {
5340: width: 25px;
5341: height: 1px;
1.771 droeschl 5342: border: none;
1.543 albertel 5343: }
1.346 albertel 5344:
1.532 albertel 5345: .LC_internal_info {
1.735 bisitz 5346: color: #999999;
1.532 albertel 5347: }
5348:
1.794 www 5349: .LC_discussion {
1.1050 www 5350: background: $data_table_dark;
1.911 bisitz 5351: border: 1px solid black;
5352: margin: 2px;
1.794 www 5353: }
5354:
5355: .LC_disc_action_left {
1.1050 www 5356: background: $sidebg;
1.911 bisitz 5357: text-align: left;
1.1050 www 5358: padding: 4px;
5359: margin: 2px;
1.794 www 5360: }
5361:
5362: .LC_disc_action_right {
1.1050 www 5363: background: $sidebg;
1.911 bisitz 5364: text-align: right;
1.1050 www 5365: padding: 4px;
5366: margin: 2px;
1.794 www 5367: }
5368:
5369: .LC_disc_new_item {
1.911 bisitz 5370: background: white;
5371: border: 2px solid red;
1.1050 www 5372: margin: 4px;
5373: padding: 4px;
1.794 www 5374: }
5375:
5376: .LC_disc_old_item {
1.911 bisitz 5377: background: white;
1.1050 www 5378: margin: 4px;
5379: padding: 4px;
1.794 www 5380: }
5381:
1.458 albertel 5382: table.LC_pastsubmission {
5383: border: 1px solid black;
5384: margin: 2px;
5385: }
5386:
1.924 bisitz 5387: table#LC_menubuttons {
1.345 albertel 5388: width: 100%;
5389: background: $pgbg;
1.392 albertel 5390: border: 2px;
1.402 albertel 5391: border-collapse: separate;
1.803 bisitz 5392: padding: 0;
1.345 albertel 5393: }
1.392 albertel 5394:
1.801 tempelho 5395: table#LC_title_bar a {
5396: color: $fontmenu;
5397: }
1.836 bisitz 5398:
1.807 droeschl 5399: table#LC_title_bar {
1.819 tempelho 5400: clear: both;
1.836 bisitz 5401: display: none;
1.807 droeschl 5402: }
5403:
1.795 www 5404: table#LC_title_bar,
1.933 droeschl 5405: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 5406: table#LC_title_bar.LC_with_remote {
1.359 albertel 5407: width: 100%;
1.392 albertel 5408: border-color: $pgbg;
5409: border-style: solid;
5410: border-width: $border;
1.379 albertel 5411: background: $pgbg;
1.801 tempelho 5412: color: $fontmenu;
1.392 albertel 5413: border-collapse: collapse;
1.803 bisitz 5414: padding: 0;
1.819 tempelho 5415: margin: 0;
1.359 albertel 5416: }
1.795 www 5417:
1.933 droeschl 5418: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 5419: margin: 0;
5420: padding: 0;
1.933 droeschl 5421: position: relative;
5422: list-style: none;
1.913 droeschl 5423: }
1.933 droeschl 5424: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 5425: display: inline;
5426: }
1.933 droeschl 5427:
5428: .LC_breadcrumb_tools_navigation {
1.913 droeschl 5429: padding: 0;
1.933 droeschl 5430: margin: 0;
5431: float: left;
1.913 droeschl 5432: }
1.933 droeschl 5433: .LC_breadcrumb_tools_tools {
5434: padding: 0;
5435: margin: 0;
1.913 droeschl 5436: float: right;
5437: }
5438:
1.359 albertel 5439: table#LC_title_bar td {
5440: background: $tabbg;
5441: }
1.795 www 5442:
1.911 bisitz 5443: table#LC_menubuttons img {
1.803 bisitz 5444: border: none;
1.346 albertel 5445: }
1.795 www 5446:
1.842 droeschl 5447: .LC_breadcrumbs_component {
1.911 bisitz 5448: float: right;
5449: margin: 0 1em;
1.357 albertel 5450: }
1.842 droeschl 5451: .LC_breadcrumbs_component img {
1.911 bisitz 5452: vertical-align: middle;
1.777 tempelho 5453: }
1.795 www 5454:
1.383 albertel 5455: td.LC_table_cell_checkbox {
5456: text-align: center;
5457: }
1.795 www 5458:
5459: .LC_fontsize_small {
1.911 bisitz 5460: font-size: 70%;
1.705 tempelho 5461: }
5462:
1.844 bisitz 5463: #LC_breadcrumbs {
1.911 bisitz 5464: clear:both;
5465: background: $sidebg;
5466: border-bottom: 1px solid $lg_border_color;
5467: line-height: 2.5em;
1.933 droeschl 5468: overflow: hidden;
1.911 bisitz 5469: margin: 0;
5470: padding: 0;
1.995 raeburn 5471: text-align: left;
1.819 tempelho 5472: }
1.862 bisitz 5473:
1.993 raeburn 5474: .LC_head_subbox {
1.911 bisitz 5475: clear:both;
5476: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 5477: border: 1px solid $sidebg;
5478: margin: 0 0 10px 0;
1.966 bisitz 5479: padding: 3px;
1.995 raeburn 5480: text-align: left;
1.822 bisitz 5481: }
5482:
1.795 www 5483: .LC_fontsize_medium {
1.911 bisitz 5484: font-size: 85%;
1.705 tempelho 5485: }
5486:
1.795 www 5487: .LC_fontsize_large {
1.911 bisitz 5488: font-size: 120%;
1.705 tempelho 5489: }
5490:
1.346 albertel 5491: .LC_menubuttons_inline_text {
5492: color: $font;
1.698 harmsja 5493: font-size: 90%;
1.701 harmsja 5494: padding-left:3px;
1.346 albertel 5495: }
5496:
1.934 droeschl 5497: .LC_menubuttons_inline_text img{
5498: vertical-align: middle;
5499: }
5500:
1.1051 www 5501: li.LC_menubuttons_inline_text img {
1.951 onken 5502: cursor:pointer;
1.1002 droeschl 5503: text-decoration: none;
1.951 onken 5504: }
5505:
1.526 www 5506: .LC_menubuttons_link {
5507: text-decoration: none;
5508: }
1.795 www 5509:
1.522 albertel 5510: .LC_menubuttons_category {
1.521 www 5511: color: $font;
1.526 www 5512: background: $pgbg;
1.521 www 5513: font-size: larger;
5514: font-weight: bold;
5515: }
5516:
1.346 albertel 5517: td.LC_menubuttons_text {
1.911 bisitz 5518: color: $font;
1.346 albertel 5519: }
1.706 harmsja 5520:
1.346 albertel 5521: .LC_current_location {
5522: background: $tabbg;
5523: }
1.795 www 5524:
1.938 bisitz 5525: table.LC_data_table {
1.347 albertel 5526: border: 1px solid #000000;
1.402 albertel 5527: border-collapse: separate;
1.426 albertel 5528: border-spacing: 1px;
1.610 albertel 5529: background: $pgbg;
1.347 albertel 5530: }
1.795 www 5531:
1.422 albertel 5532: .LC_data_table_dense {
5533: font-size: small;
5534: }
1.795 www 5535:
1.507 raeburn 5536: table.LC_nested_outer {
5537: border: 1px solid #000000;
1.589 raeburn 5538: border-collapse: collapse;
1.803 bisitz 5539: border-spacing: 0;
1.507 raeburn 5540: width: 100%;
5541: }
1.795 www 5542:
1.879 raeburn 5543: table.LC_innerpickbox,
1.507 raeburn 5544: table.LC_nested {
1.803 bisitz 5545: border: none;
1.589 raeburn 5546: border-collapse: collapse;
1.803 bisitz 5547: border-spacing: 0;
1.507 raeburn 5548: width: 100%;
5549: }
1.795 www 5550:
1.911 bisitz 5551: table.LC_data_table tr th,
5552: table.LC_calendar tr th,
1.879 raeburn 5553: table.LC_prior_tries tr th,
5554: table.LC_innerpickbox tr th {
1.349 albertel 5555: font-weight: bold;
5556: background-color: $data_table_head;
1.801 tempelho 5557: color:$fontmenu;
1.701 harmsja 5558: font-size:90%;
1.347 albertel 5559: }
1.795 www 5560:
1.879 raeburn 5561: table.LC_innerpickbox tr th,
5562: table.LC_innerpickbox tr td {
5563: vertical-align: top;
5564: }
5565:
1.711 raeburn 5566: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 5567: background-color: #CCCCCC;
1.711 raeburn 5568: font-weight: bold;
5569: text-align: left;
5570: }
1.795 www 5571:
1.912 bisitz 5572: table.LC_data_table tr.LC_odd_row > td {
5573: background-color: $data_table_light;
5574: padding: 2px;
5575: vertical-align: top;
5576: }
5577:
1.809 bisitz 5578: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 5579: background-color: $data_table_light;
1.912 bisitz 5580: vertical-align: top;
5581: }
5582:
5583: table.LC_data_table tr.LC_even_row > td {
5584: background-color: $data_table_dark;
1.425 albertel 5585: padding: 2px;
1.900 bisitz 5586: vertical-align: top;
1.347 albertel 5587: }
1.795 www 5588:
1.809 bisitz 5589: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 5590: background-color: $data_table_dark;
1.900 bisitz 5591: vertical-align: top;
1.347 albertel 5592: }
1.795 www 5593:
1.425 albertel 5594: table.LC_data_table tr.LC_data_table_highlight td {
5595: background-color: $data_table_darker;
5596: }
1.795 www 5597:
1.639 raeburn 5598: table.LC_data_table tr td.LC_leftcol_header {
5599: background-color: $data_table_head;
5600: font-weight: bold;
5601: }
1.795 www 5602:
1.451 albertel 5603: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5604: table.LC_nested tr.LC_empty_row td {
1.421 albertel 5605: font-weight: bold;
5606: font-style: italic;
5607: text-align: center;
5608: padding: 8px;
1.347 albertel 5609: }
1.795 www 5610:
1.940 bisitz 5611: table.LC_data_table tr.LC_empty_row td {
5612: background-color: $sidebg;
5613: }
5614:
5615: table.LC_nested tr.LC_empty_row td {
5616: background-color: #FFFFFF;
5617: }
5618:
1.890 droeschl 5619: table.LC_caption {
5620: }
5621:
1.507 raeburn 5622: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5623: padding: 4ex
5624: }
1.795 www 5625:
1.507 raeburn 5626: table.LC_nested_outer tr th {
5627: font-weight: bold;
1.801 tempelho 5628: color:$fontmenu;
1.507 raeburn 5629: background-color: $data_table_head;
1.701 harmsja 5630: font-size: small;
1.507 raeburn 5631: border-bottom: 1px solid #000000;
5632: }
1.795 www 5633:
1.507 raeburn 5634: table.LC_nested_outer tr td.LC_subheader {
5635: background-color: $data_table_head;
5636: font-weight: bold;
5637: font-size: small;
5638: border-bottom: 1px solid #000000;
5639: text-align: right;
1.451 albertel 5640: }
1.795 www 5641:
1.507 raeburn 5642: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5643: background-color: #CCCCCC;
1.451 albertel 5644: font-weight: bold;
5645: font-size: small;
1.507 raeburn 5646: text-align: center;
5647: }
1.795 www 5648:
1.589 raeburn 5649: table.LC_nested tr.LC_info_row td.LC_left_item,
5650: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5651: text-align: left;
1.451 albertel 5652: }
1.795 www 5653:
1.507 raeburn 5654: table.LC_nested td {
1.735 bisitz 5655: background-color: #FFFFFF;
1.451 albertel 5656: font-size: small;
1.507 raeburn 5657: }
1.795 www 5658:
1.507 raeburn 5659: table.LC_nested_outer tr th.LC_right_item,
5660: table.LC_nested tr.LC_info_row td.LC_right_item,
5661: table.LC_nested tr.LC_odd_row td.LC_right_item,
5662: table.LC_nested tr td.LC_right_item {
1.451 albertel 5663: text-align: right;
5664: }
5665:
1.507 raeburn 5666: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5667: background-color: #EEEEEE;
1.451 albertel 5668: }
5669:
1.473 raeburn 5670: table.LC_createuser {
5671: }
5672:
5673: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5674: font-size: small;
1.473 raeburn 5675: }
5676:
5677: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5678: background-color: #CCCCCC;
1.473 raeburn 5679: font-weight: bold;
5680: text-align: center;
5681: }
5682:
1.349 albertel 5683: table.LC_calendar {
5684: border: 1px solid #000000;
5685: border-collapse: collapse;
1.917 raeburn 5686: width: 98%;
1.349 albertel 5687: }
1.795 www 5688:
1.349 albertel 5689: table.LC_calendar_pickdate {
5690: font-size: xx-small;
5691: }
1.795 www 5692:
1.349 albertel 5693: table.LC_calendar tr td {
5694: border: 1px solid #000000;
5695: vertical-align: top;
1.917 raeburn 5696: width: 14%;
1.349 albertel 5697: }
1.795 www 5698:
1.349 albertel 5699: table.LC_calendar tr td.LC_calendar_day_empty {
5700: background-color: $data_table_dark;
5701: }
1.795 www 5702:
1.779 bisitz 5703: table.LC_calendar tr td.LC_calendar_day_current {
5704: background-color: $data_table_highlight;
1.777 tempelho 5705: }
1.795 www 5706:
1.938 bisitz 5707: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 5708: background-color: $mail_new;
5709: }
1.795 www 5710:
1.938 bisitz 5711: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 5712: background-color: $mail_new_hover;
5713: }
1.795 www 5714:
1.938 bisitz 5715: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 5716: background-color: $mail_read;
5717: }
1.795 www 5718:
1.938 bisitz 5719: /*
5720: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 5721: background-color: $mail_read_hover;
5722: }
1.938 bisitz 5723: */
1.795 www 5724:
1.938 bisitz 5725: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 5726: background-color: $mail_replied;
5727: }
1.795 www 5728:
1.938 bisitz 5729: /*
5730: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 5731: background-color: $mail_replied_hover;
5732: }
1.938 bisitz 5733: */
1.795 www 5734:
1.938 bisitz 5735: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 5736: background-color: $mail_other;
5737: }
1.795 www 5738:
1.938 bisitz 5739: /*
5740: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 5741: background-color: $mail_other_hover;
5742: }
1.938 bisitz 5743: */
1.494 raeburn 5744:
1.777 tempelho 5745: table.LC_data_table tr > td.LC_browser_file,
5746: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 5747: background: #AAEE77;
1.389 albertel 5748: }
1.795 www 5749:
1.777 tempelho 5750: table.LC_data_table tr > td.LC_browser_file_locked,
5751: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5752: background: #FFAA99;
1.387 albertel 5753: }
1.795 www 5754:
1.777 tempelho 5755: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 5756: background: #888888;
1.779 bisitz 5757: }
1.795 www 5758:
1.777 tempelho 5759: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5760: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 5761: background: #F8F866;
1.777 tempelho 5762: }
1.795 www 5763:
1.696 bisitz 5764: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 5765: background: #E0E8FF;
1.387 albertel 5766: }
1.696 bisitz 5767:
1.707 bisitz 5768: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 5769: /* background: #77FF77; */
1.707 bisitz 5770: }
1.795 www 5771:
1.707 bisitz 5772: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 5773: border-right: 8px solid #FFFF77;
1.707 bisitz 5774: }
1.795 www 5775:
1.707 bisitz 5776: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 5777: border-right: 8px solid #FFAA77;
1.707 bisitz 5778: }
1.795 www 5779:
1.707 bisitz 5780: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 5781: border-right: 8px solid #FF7777;
1.707 bisitz 5782: }
1.795 www 5783:
1.707 bisitz 5784: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 5785: border-right: 8px solid #AAFF77;
1.707 bisitz 5786: }
1.795 www 5787:
1.707 bisitz 5788: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 5789: border-right: 8px solid #11CC55;
1.707 bisitz 5790: }
5791:
1.388 albertel 5792: span.LC_current_location {
1.701 harmsja 5793: font-size:larger;
1.388 albertel 5794: background: $pgbg;
5795: }
1.387 albertel 5796:
1.1029 www 5797: span.LC_current_nav_location {
5798: font-weight:bold;
5799: background: $sidebg;
5800: }
5801:
1.395 albertel 5802: span.LC_parm_menu_item {
5803: font-size: larger;
5804: }
1.795 www 5805:
1.395 albertel 5806: span.LC_parm_scope_all {
5807: color: red;
5808: }
1.795 www 5809:
1.395 albertel 5810: span.LC_parm_scope_folder {
5811: color: green;
5812: }
1.795 www 5813:
1.395 albertel 5814: span.LC_parm_scope_resource {
5815: color: orange;
5816: }
1.795 www 5817:
1.395 albertel 5818: span.LC_parm_part {
5819: color: blue;
5820: }
1.795 www 5821:
1.911 bisitz 5822: span.LC_parm_folder,
5823: span.LC_parm_symb {
1.395 albertel 5824: font-size: x-small;
5825: font-family: $mono;
5826: color: #AAAAAA;
5827: }
5828:
1.977 bisitz 5829: ul.LC_parm_parmlist li {
5830: display: inline-block;
5831: padding: 0.3em 0.8em;
5832: vertical-align: top;
5833: width: 150px;
5834: border-top:1px solid $lg_border_color;
5835: }
5836:
1.795 www 5837: td.LC_parm_overview_level_menu,
5838: td.LC_parm_overview_map_menu,
5839: td.LC_parm_overview_parm_selectors,
5840: td.LC_parm_overview_restrictions {
1.396 albertel 5841: border: 1px solid black;
5842: border-collapse: collapse;
5843: }
1.795 www 5844:
1.396 albertel 5845: table.LC_parm_overview_restrictions td {
5846: border-width: 1px 4px 1px 4px;
5847: border-style: solid;
5848: border-color: $pgbg;
5849: text-align: center;
5850: }
1.795 www 5851:
1.396 albertel 5852: table.LC_parm_overview_restrictions th {
5853: background: $tabbg;
5854: border-width: 1px 4px 1px 4px;
5855: border-style: solid;
5856: border-color: $pgbg;
5857: }
1.795 www 5858:
1.398 albertel 5859: table#LC_helpmenu {
1.803 bisitz 5860: border: none;
1.398 albertel 5861: height: 55px;
1.803 bisitz 5862: border-spacing: 0;
1.398 albertel 5863: }
5864:
5865: table#LC_helpmenu fieldset legend {
5866: font-size: larger;
5867: }
1.795 www 5868:
1.397 albertel 5869: table#LC_helpmenu_links {
5870: width: 100%;
5871: border: 1px solid black;
5872: background: $pgbg;
1.803 bisitz 5873: padding: 0;
1.397 albertel 5874: border-spacing: 1px;
5875: }
1.795 www 5876:
1.397 albertel 5877: table#LC_helpmenu_links tr td {
5878: padding: 1px;
5879: background: $tabbg;
1.399 albertel 5880: text-align: center;
5881: font-weight: bold;
1.397 albertel 5882: }
1.396 albertel 5883:
1.795 www 5884: table#LC_helpmenu_links a:link,
5885: table#LC_helpmenu_links a:visited,
1.397 albertel 5886: table#LC_helpmenu_links a:active {
5887: text-decoration: none;
5888: color: $font;
5889: }
1.795 www 5890:
1.397 albertel 5891: table#LC_helpmenu_links a:hover {
5892: text-decoration: underline;
5893: color: $vlink;
5894: }
1.396 albertel 5895:
1.417 albertel 5896: .LC_chrt_popup_exists {
5897: border: 1px solid #339933;
5898: margin: -1px;
5899: }
1.795 www 5900:
1.417 albertel 5901: .LC_chrt_popup_up {
5902: border: 1px solid yellow;
5903: margin: -1px;
5904: }
1.795 www 5905:
1.417 albertel 5906: .LC_chrt_popup {
5907: border: 1px solid #8888FF;
5908: background: #CCCCFF;
5909: }
1.795 www 5910:
1.421 albertel 5911: table.LC_pick_box {
5912: border-collapse: separate;
5913: background: white;
5914: border: 1px solid black;
5915: border-spacing: 1px;
5916: }
1.795 www 5917:
1.421 albertel 5918: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 5919: background: $sidebg;
1.421 albertel 5920: font-weight: bold;
1.900 bisitz 5921: text-align: left;
1.740 bisitz 5922: vertical-align: top;
1.421 albertel 5923: width: 184px;
5924: padding: 8px;
5925: }
1.795 www 5926:
1.579 raeburn 5927: table.LC_pick_box td.LC_pick_box_value {
5928: text-align: left;
5929: padding: 8px;
5930: }
1.795 www 5931:
1.579 raeburn 5932: table.LC_pick_box td.LC_pick_box_select {
5933: text-align: left;
5934: padding: 8px;
5935: }
1.795 www 5936:
1.424 albertel 5937: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 5938: padding: 0;
1.421 albertel 5939: height: 1px;
5940: background: black;
5941: }
1.795 www 5942:
1.421 albertel 5943: table.LC_pick_box td.LC_pick_box_submit {
5944: text-align: right;
5945: }
1.795 www 5946:
1.579 raeburn 5947: table.LC_pick_box td.LC_evenrow_value {
5948: text-align: left;
5949: padding: 8px;
5950: background-color: $data_table_light;
5951: }
1.795 www 5952:
1.579 raeburn 5953: table.LC_pick_box td.LC_oddrow_value {
5954: text-align: left;
5955: padding: 8px;
5956: background-color: $data_table_light;
5957: }
1.795 www 5958:
1.579 raeburn 5959: span.LC_helpform_receipt_cat {
5960: font-weight: bold;
5961: }
1.795 www 5962:
1.424 albertel 5963: table.LC_group_priv_box {
5964: background: white;
5965: border: 1px solid black;
5966: border-spacing: 1px;
5967: }
1.795 www 5968:
1.424 albertel 5969: table.LC_group_priv_box td.LC_pick_box_title {
5970: background: $tabbg;
5971: font-weight: bold;
5972: text-align: right;
5973: width: 184px;
5974: }
1.795 www 5975:
1.424 albertel 5976: table.LC_group_priv_box td.LC_groups_fixed {
5977: background: $data_table_light;
5978: text-align: center;
5979: }
1.795 www 5980:
1.424 albertel 5981: table.LC_group_priv_box td.LC_groups_optional {
5982: background: $data_table_dark;
5983: text-align: center;
5984: }
1.795 www 5985:
1.424 albertel 5986: table.LC_group_priv_box td.LC_groups_functionality {
5987: background: $data_table_darker;
5988: text-align: center;
5989: font-weight: bold;
5990: }
1.795 www 5991:
1.424 albertel 5992: table.LC_group_priv td {
5993: text-align: left;
1.803 bisitz 5994: padding: 0;
1.424 albertel 5995: }
5996:
5997: .LC_navbuttons {
5998: margin: 2ex 0ex 2ex 0ex;
5999: }
1.795 www 6000:
1.423 albertel 6001: .LC_topic_bar {
6002: font-weight: bold;
6003: background: $tabbg;
1.918 wenzelju 6004: margin: 1em 0em 1em 2em;
1.805 bisitz 6005: padding: 3px;
1.918 wenzelju 6006: font-size: 1.2em;
1.423 albertel 6007: }
1.795 www 6008:
1.423 albertel 6009: .LC_topic_bar span {
1.918 wenzelju 6010: left: 0.5em;
6011: position: absolute;
1.423 albertel 6012: vertical-align: middle;
1.918 wenzelju 6013: font-size: 1.2em;
1.423 albertel 6014: }
1.795 www 6015:
1.423 albertel 6016: table.LC_course_group_status {
6017: margin: 20px;
6018: }
1.795 www 6019:
1.423 albertel 6020: table.LC_status_selector td {
6021: vertical-align: top;
6022: text-align: center;
1.424 albertel 6023: padding: 4px;
6024: }
1.795 www 6025:
1.599 albertel 6026: div.LC_feedback_link {
1.616 albertel 6027: clear: both;
1.829 kalberla 6028: background: $sidebg;
1.779 bisitz 6029: width: 100%;
1.829 kalberla 6030: padding-bottom: 10px;
6031: border: 1px $tabbg solid;
1.833 kalberla 6032: height: 22px;
6033: line-height: 22px;
6034: padding-top: 5px;
6035: }
6036:
6037: div.LC_feedback_link img {
6038: height: 22px;
1.867 kalberla 6039: vertical-align:middle;
1.829 kalberla 6040: }
6041:
1.911 bisitz 6042: div.LC_feedback_link a {
1.829 kalberla 6043: text-decoration: none;
1.489 raeburn 6044: }
1.795 www 6045:
1.867 kalberla 6046: div.LC_comblock {
1.911 bisitz 6047: display:inline;
1.867 kalberla 6048: color:$font;
6049: font-size:90%;
6050: }
6051:
6052: div.LC_feedback_link div.LC_comblock {
6053: padding-left:5px;
6054: }
6055:
6056: div.LC_feedback_link div.LC_comblock a {
6057: color:$font;
6058: }
6059:
1.489 raeburn 6060: span.LC_feedback_link {
1.858 bisitz 6061: /* background: $feedback_link_bg; */
1.599 albertel 6062: font-size: larger;
6063: }
1.795 www 6064:
1.599 albertel 6065: span.LC_message_link {
1.858 bisitz 6066: /* background: $feedback_link_bg; */
1.599 albertel 6067: font-size: larger;
6068: position: absolute;
6069: right: 1em;
1.489 raeburn 6070: }
1.421 albertel 6071:
1.515 albertel 6072: table.LC_prior_tries {
1.524 albertel 6073: border: 1px solid #000000;
6074: border-collapse: separate;
6075: border-spacing: 1px;
1.515 albertel 6076: }
1.523 albertel 6077:
1.515 albertel 6078: table.LC_prior_tries td {
1.524 albertel 6079: padding: 2px;
1.515 albertel 6080: }
1.523 albertel 6081:
6082: .LC_answer_correct {
1.795 www 6083: background: lightgreen;
6084: color: darkgreen;
6085: padding: 6px;
1.523 albertel 6086: }
1.795 www 6087:
1.523 albertel 6088: .LC_answer_charged_try {
1.797 www 6089: background: #FFAAAA;
1.795 www 6090: color: darkred;
6091: padding: 6px;
1.523 albertel 6092: }
1.795 www 6093:
1.779 bisitz 6094: .LC_answer_not_charged_try,
1.523 albertel 6095: .LC_answer_no_grade,
6096: .LC_answer_late {
1.795 www 6097: background: lightyellow;
1.523 albertel 6098: color: black;
1.795 www 6099: padding: 6px;
1.523 albertel 6100: }
1.795 www 6101:
1.523 albertel 6102: .LC_answer_previous {
1.795 www 6103: background: lightblue;
6104: color: darkblue;
6105: padding: 6px;
1.523 albertel 6106: }
1.795 www 6107:
1.779 bisitz 6108: .LC_answer_no_message {
1.777 tempelho 6109: background: #FFFFFF;
6110: color: black;
1.795 www 6111: padding: 6px;
1.779 bisitz 6112: }
1.795 www 6113:
1.779 bisitz 6114: .LC_answer_unknown {
6115: background: orange;
6116: color: black;
1.795 www 6117: padding: 6px;
1.777 tempelho 6118: }
1.795 www 6119:
1.529 albertel 6120: span.LC_prior_numerical,
6121: span.LC_prior_string,
6122: span.LC_prior_custom,
6123: span.LC_prior_reaction,
6124: span.LC_prior_math {
1.925 bisitz 6125: font-family: $mono;
1.523 albertel 6126: white-space: pre;
6127: }
6128:
1.525 albertel 6129: span.LC_prior_string {
1.925 bisitz 6130: font-family: $mono;
1.525 albertel 6131: white-space: pre;
6132: }
6133:
1.523 albertel 6134: table.LC_prior_option {
6135: width: 100%;
6136: border-collapse: collapse;
6137: }
1.795 www 6138:
1.911 bisitz 6139: table.LC_prior_rank,
1.795 www 6140: table.LC_prior_match {
1.528 albertel 6141: border-collapse: collapse;
6142: }
1.795 www 6143:
1.528 albertel 6144: table.LC_prior_option tr td,
6145: table.LC_prior_rank tr td,
6146: table.LC_prior_match tr td {
1.524 albertel 6147: border: 1px solid #000000;
1.515 albertel 6148: }
6149:
1.855 bisitz 6150: .LC_nobreak {
1.544 albertel 6151: white-space: nowrap;
1.519 raeburn 6152: }
6153:
1.576 raeburn 6154: span.LC_cusr_emph {
6155: font-style: italic;
6156: }
6157:
1.633 raeburn 6158: span.LC_cusr_subheading {
6159: font-weight: normal;
6160: font-size: 85%;
6161: }
6162:
1.861 bisitz 6163: div.LC_docs_entry_move {
1.859 bisitz 6164: border: 1px solid #BBBBBB;
1.545 albertel 6165: background: #DDDDDD;
1.861 bisitz 6166: width: 22px;
1.859 bisitz 6167: padding: 1px;
6168: margin: 0;
1.545 albertel 6169: }
6170:
1.861 bisitz 6171: table.LC_data_table tr > td.LC_docs_entry_commands,
6172: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 6173: background: #DDDDDD;
6174: font-size: x-small;
6175: }
1.795 www 6176:
1.861 bisitz 6177: .LC_docs_entry_parameter {
6178: white-space: nowrap;
6179: }
6180:
1.544 albertel 6181: .LC_docs_copy {
1.545 albertel 6182: color: #000099;
1.544 albertel 6183: }
1.795 www 6184:
1.544 albertel 6185: .LC_docs_cut {
1.545 albertel 6186: color: #550044;
1.544 albertel 6187: }
1.795 www 6188:
1.544 albertel 6189: .LC_docs_rename {
1.545 albertel 6190: color: #009900;
1.544 albertel 6191: }
1.795 www 6192:
1.544 albertel 6193: .LC_docs_remove {
1.545 albertel 6194: color: #990000;
6195: }
6196:
1.547 albertel 6197: .LC_docs_reinit_warn,
6198: .LC_docs_ext_edit {
6199: font-size: x-small;
6200: }
6201:
1.545 albertel 6202: table.LC_docs_adddocs td,
6203: table.LC_docs_adddocs th {
6204: border: 1px solid #BBBBBB;
6205: padding: 4px;
6206: background: #DDDDDD;
1.543 albertel 6207: }
6208:
1.584 albertel 6209: table.LC_sty_begin {
6210: background: #BBFFBB;
6211: }
1.795 www 6212:
1.584 albertel 6213: table.LC_sty_end {
6214: background: #FFBBBB;
6215: }
6216:
1.589 raeburn 6217: table.LC_double_column {
1.803 bisitz 6218: border-width: 0;
1.589 raeburn 6219: border-collapse: collapse;
6220: width: 100%;
6221: padding: 2px;
6222: }
6223:
6224: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 6225: top: 2px;
1.589 raeburn 6226: left: 2px;
6227: width: 47%;
6228: vertical-align: top;
6229: }
6230:
6231: table.LC_double_column tr td.LC_right_col {
6232: top: 2px;
1.779 bisitz 6233: right: 2px;
1.589 raeburn 6234: width: 47%;
6235: vertical-align: top;
6236: }
6237:
1.591 raeburn 6238: div.LC_left_float {
6239: float: left;
6240: padding-right: 5%;
1.597 albertel 6241: padding-bottom: 4px;
1.591 raeburn 6242: }
6243:
6244: div.LC_clear_float_header {
1.597 albertel 6245: padding-bottom: 2px;
1.591 raeburn 6246: }
6247:
6248: div.LC_clear_float_footer {
1.597 albertel 6249: padding-top: 10px;
1.591 raeburn 6250: clear: both;
6251: }
6252:
1.597 albertel 6253: div.LC_grade_show_user {
1.941 bisitz 6254: /* border-left: 5px solid $sidebg; */
6255: border-top: 5px solid #000000;
6256: margin: 50px 0 0 0;
1.936 bisitz 6257: padding: 15px 0 5px 10px;
1.597 albertel 6258: }
1.795 www 6259:
1.936 bisitz 6260: div.LC_grade_show_user_odd_row {
1.941 bisitz 6261: /* border-left: 5px solid #000000; */
6262: }
6263:
6264: div.LC_grade_show_user div.LC_Box {
6265: margin-right: 50px;
1.597 albertel 6266: }
6267:
6268: div.LC_grade_submissions,
6269: div.LC_grade_message_center,
1.936 bisitz 6270: div.LC_grade_info_links {
1.597 albertel 6271: margin: 5px;
6272: width: 99%;
6273: background: #FFFFFF;
6274: }
1.795 www 6275:
1.597 albertel 6276: div.LC_grade_submissions_header,
1.936 bisitz 6277: div.LC_grade_message_center_header {
1.705 tempelho 6278: font-weight: bold;
6279: font-size: large;
1.597 albertel 6280: }
1.795 www 6281:
1.597 albertel 6282: div.LC_grade_submissions_body,
1.936 bisitz 6283: div.LC_grade_message_center_body {
1.597 albertel 6284: border: 1px solid black;
6285: width: 99%;
6286: background: #FFFFFF;
6287: }
1.795 www 6288:
1.613 albertel 6289: table.LC_scantron_action {
6290: width: 100%;
6291: }
1.795 www 6292:
1.613 albertel 6293: table.LC_scantron_action tr th {
1.698 harmsja 6294: font-weight:bold;
6295: font-style:normal;
1.613 albertel 6296: }
1.795 www 6297:
1.779 bisitz 6298: .LC_edit_problem_header,
1.614 albertel 6299: div.LC_edit_problem_footer {
1.705 tempelho 6300: font-weight: normal;
6301: font-size: medium;
1.602 albertel 6302: margin: 2px;
1.1060 bisitz 6303: background-color: $sidebg;
1.600 albertel 6304: }
1.795 www 6305:
1.600 albertel 6306: div.LC_edit_problem_header,
1.602 albertel 6307: div.LC_edit_problem_header div,
1.614 albertel 6308: div.LC_edit_problem_footer,
6309: div.LC_edit_problem_footer div,
1.602 albertel 6310: div.LC_edit_problem_editxml_header,
6311: div.LC_edit_problem_editxml_header div {
1.600 albertel 6312: margin-top: 5px;
6313: }
1.795 www 6314:
1.600 albertel 6315: div.LC_edit_problem_header_title {
1.705 tempelho 6316: font-weight: bold;
6317: font-size: larger;
1.602 albertel 6318: background: $tabbg;
6319: padding: 3px;
1.1060 bisitz 6320: margin: 0 0 5px 0;
1.602 albertel 6321: }
1.795 www 6322:
1.602 albertel 6323: table.LC_edit_problem_header_title {
6324: width: 100%;
1.600 albertel 6325: background: $tabbg;
1.602 albertel 6326: }
6327:
6328: div.LC_edit_problem_discards {
6329: float: left;
6330: padding-bottom: 5px;
6331: }
1.795 www 6332:
1.602 albertel 6333: div.LC_edit_problem_saves {
6334: float: right;
6335: padding-bottom: 5px;
1.600 albertel 6336: }
1.795 www 6337:
1.911 bisitz 6338: img.stift {
1.803 bisitz 6339: border-width: 0;
6340: vertical-align: middle;
1.677 riegler 6341: }
1.680 riegler 6342:
1.923 bisitz 6343: table td.LC_mainmenu_col_fieldset {
1.680 riegler 6344: vertical-align: top;
1.777 tempelho 6345: }
1.795 www 6346:
1.716 raeburn 6347: div.LC_createcourse {
1.911 bisitz 6348: margin: 10px 10px 10px 10px;
1.716 raeburn 6349: }
6350:
1.917 raeburn 6351: .LC_dccid {
6352: margin: 0.2em 0 0 0;
6353: padding: 0;
6354: font-size: 90%;
6355: display:none;
6356: }
6357:
1.897 wenzelju 6358: ol.LC_primary_menu a:hover,
1.721 harmsja 6359: ol#LC_MenuBreadcrumbs a:hover,
6360: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 6361: ul#LC_secondary_menu a:hover,
1.721 harmsja 6362: .LC_FormSectionClearButton input:hover
1.795 www 6363: ul.LC_TabContent li:hover a {
1.952 onken 6364: color:$button_hover;
1.911 bisitz 6365: text-decoration:none;
1.693 droeschl 6366: }
6367:
1.779 bisitz 6368: h1 {
1.911 bisitz 6369: padding: 0;
6370: line-height:130%;
1.693 droeschl 6371: }
1.698 harmsja 6372:
1.911 bisitz 6373: h2,
6374: h3,
6375: h4,
6376: h5,
6377: h6 {
6378: margin: 5px 0 5px 0;
6379: padding: 0;
6380: line-height:130%;
1.693 droeschl 6381: }
1.795 www 6382:
6383: .LC_hcell {
1.911 bisitz 6384: padding:3px 15px 3px 15px;
6385: margin: 0;
6386: background-color:$tabbg;
6387: color:$fontmenu;
6388: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 6389: }
1.795 www 6390:
1.840 bisitz 6391: .LC_Box > .LC_hcell {
1.911 bisitz 6392: margin: 0 -10px 10px -10px;
1.835 bisitz 6393: }
6394:
1.721 harmsja 6395: .LC_noBorder {
1.911 bisitz 6396: border: 0;
1.698 harmsja 6397: }
1.693 droeschl 6398:
1.721 harmsja 6399: .LC_FormSectionClearButton input {
1.911 bisitz 6400: background-color:transparent;
6401: border: none;
6402: cursor:pointer;
6403: text-decoration:underline;
1.693 droeschl 6404: }
1.763 bisitz 6405:
6406: .LC_help_open_topic {
1.911 bisitz 6407: color: #FFFFFF;
6408: background-color: #EEEEFF;
6409: margin: 1px;
6410: padding: 4px;
6411: border: 1px solid #000033;
6412: white-space: nowrap;
6413: /* vertical-align: middle; */
1.759 neumanie 6414: }
1.693 droeschl 6415:
1.911 bisitz 6416: dl,
6417: ul,
6418: div,
6419: fieldset {
6420: margin: 10px 10px 10px 0;
6421: /* overflow: hidden; */
1.693 droeschl 6422: }
1.795 www 6423:
1.838 bisitz 6424: fieldset > legend {
1.911 bisitz 6425: font-weight: bold;
6426: padding: 0 5px 0 5px;
1.838 bisitz 6427: }
6428:
1.813 bisitz 6429: #LC_nav_bar {
1.911 bisitz 6430: float: left;
1.995 raeburn 6431: background-color: $pgbg_or_bgcolor;
1.966 bisitz 6432: margin: 0 0 2px 0;
1.807 droeschl 6433: }
6434:
1.916 droeschl 6435: #LC_realm {
6436: margin: 0.2em 0 0 0;
6437: padding: 0;
6438: font-weight: bold;
6439: text-align: center;
1.995 raeburn 6440: background-color: $pgbg_or_bgcolor;
1.916 droeschl 6441: }
6442:
1.911 bisitz 6443: #LC_nav_bar em {
6444: font-weight: bold;
6445: font-style: normal;
1.807 droeschl 6446: }
6447:
1.897 wenzelju 6448: ol.LC_primary_menu {
1.911 bisitz 6449: float: right;
1.934 droeschl 6450: margin: 0;
1.1075.2.2! raeburn 6451: padding: 0;
1.995 raeburn 6452: background-color: $pgbg_or_bgcolor;
1.807 droeschl 6453: }
6454:
1.852 droeschl 6455: ol#LC_PathBreadcrumbs {
1.911 bisitz 6456: margin: 0;
1.693 droeschl 6457: }
6458:
1.897 wenzelju 6459: ol.LC_primary_menu li {
1.1075.2.2! raeburn 6460: color: RGB(80, 80, 80);
! 6461: vertical-align: middle;
! 6462: text-align: left;
! 6463: list-style: none;
! 6464: float: left;
! 6465: }
! 6466:
! 6467: ol.LC_primary_menu li a {
! 6468: display: block;
! 6469: margin: 0;
! 6470: padding: 0 5px 0 10px;
! 6471: text-decoration: none;
! 6472: }
! 6473:
! 6474: ol.LC_primary_menu li ul {
! 6475: display: none;
! 6476: width: 10em;
! 6477: background-color: $data_table_light;
! 6478: }
! 6479:
! 6480: ol.LC_primary_menu li:hover ul, ol.LC_primary_menu li.hover ul {
! 6481: display: block;
! 6482: position: absolute;
! 6483: margin: 0;
! 6484: padding: 0;
! 6485: }
! 6486:
! 6487: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
! 6488: font-size: 90%;
1.911 bisitz 6489: vertical-align: top;
1.1075.2.2! raeburn 6490: float: none;
! 6491: }
! 6492:
! 6493: ol.LC_primary_menu li:hover li a, ol.LC_primary_menu li.hover li a {
! 6494: background-color:$data_table_light
! 6495: }
! 6496:
! 6497: ol.LC_primary_menu li li a:hover {
! 6498: color:$button_hover;
! 6499: background-color:$data_table_dark;
1.693 droeschl 6500: }
6501:
1.897 wenzelju 6502: ol.LC_primary_menu li img {
1.911 bisitz 6503: vertical-align: bottom;
1.934 droeschl 6504: height: 1.1em;
1.693 droeschl 6505: }
6506:
1.897 wenzelju 6507: ol.LC_primary_menu a {
1.911 bisitz 6508: color: RGB(80, 80, 80);
6509: text-decoration: none;
1.693 droeschl 6510: }
1.795 www 6511:
1.949 droeschl 6512: ol.LC_primary_menu a.LC_new_message {
6513: font-weight:bold;
6514: color: darkred;
6515: }
6516:
1.975 raeburn 6517: ol.LC_docs_parameters {
6518: margin-left: 0;
6519: padding: 0;
6520: list-style: none;
6521: }
6522:
6523: ol.LC_docs_parameters li {
6524: margin: 0;
6525: padding-right: 20px;
6526: display: inline;
6527: }
6528:
1.976 raeburn 6529: ol.LC_docs_parameters li:before {
6530: content: "\\002022 \\0020";
6531: }
6532:
6533: li.LC_docs_parameters_title {
6534: font-weight: bold;
6535: }
6536:
6537: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
6538: content: "";
6539: }
6540:
1.897 wenzelju 6541: ul#LC_secondary_menu {
1.911 bisitz 6542: clear: both;
6543: color: $fontmenu;
6544: background: $tabbg;
6545: list-style: none;
6546: padding: 0;
6547: margin: 0;
6548: width: 100%;
1.995 raeburn 6549: text-align: left;
1.808 droeschl 6550: }
6551:
1.897 wenzelju 6552: ul#LC_secondary_menu li {
1.911 bisitz 6553: font-weight: bold;
6554: line-height: 1.8em;
6555: padding: 0 0.8em;
6556: border-right: 1px solid black;
6557: display: inline;
6558: vertical-align: middle;
1.807 droeschl 6559: }
6560:
1.847 tempelho 6561: ul.LC_TabContent {
1.911 bisitz 6562: display:block;
6563: background: $sidebg;
6564: border-bottom: solid 1px $lg_border_color;
6565: list-style:none;
1.1020 raeburn 6566: margin: -1px -10px 0 -10px;
1.911 bisitz 6567: padding: 0;
1.693 droeschl 6568: }
6569:
1.795 www 6570: ul.LC_TabContent li,
6571: ul.LC_TabContentBigger li {
1.911 bisitz 6572: float:left;
1.741 harmsja 6573: }
1.795 www 6574:
1.897 wenzelju 6575: ul#LC_secondary_menu li a {
1.911 bisitz 6576: color: $fontmenu;
6577: text-decoration: none;
1.693 droeschl 6578: }
1.795 www 6579:
1.721 harmsja 6580: ul.LC_TabContent {
1.952 onken 6581: min-height:20px;
1.721 harmsja 6582: }
1.795 www 6583:
6584: ul.LC_TabContent li {
1.911 bisitz 6585: vertical-align:middle;
1.959 onken 6586: padding: 0 16px 0 10px;
1.911 bisitz 6587: background-color:$tabbg;
6588: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 6589: border-left: solid 1px $font;
1.721 harmsja 6590: }
1.795 www 6591:
1.847 tempelho 6592: ul.LC_TabContent .right {
1.911 bisitz 6593: float:right;
1.847 tempelho 6594: }
6595:
1.911 bisitz 6596: ul.LC_TabContent li a,
6597: ul.LC_TabContent li {
6598: color:rgb(47,47,47);
6599: text-decoration:none;
6600: font-size:95%;
6601: font-weight:bold;
1.952 onken 6602: min-height:20px;
6603: }
6604:
1.959 onken 6605: ul.LC_TabContent li a:hover,
6606: ul.LC_TabContent li a:focus {
1.952 onken 6607: color: $button_hover;
1.959 onken 6608: background:none;
6609: outline:none;
1.952 onken 6610: }
6611:
6612: ul.LC_TabContent li:hover {
6613: color: $button_hover;
6614: cursor:pointer;
1.721 harmsja 6615: }
1.795 www 6616:
1.911 bisitz 6617: ul.LC_TabContent li.active {
1.952 onken 6618: color: $font;
1.911 bisitz 6619: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 6620: border-bottom:solid 1px #FFFFFF;
6621: cursor: default;
1.744 ehlerst 6622: }
1.795 www 6623:
1.959 onken 6624: ul.LC_TabContent li.active a {
6625: color:$font;
6626: background:#FFFFFF;
6627: outline: none;
6628: }
1.1047 raeburn 6629:
6630: ul.LC_TabContent li.goback {
6631: float: left;
6632: border-left: none;
6633: }
6634:
1.870 tempelho 6635: #maincoursedoc {
1.911 bisitz 6636: clear:both;
1.870 tempelho 6637: }
6638:
6639: ul.LC_TabContentBigger {
1.911 bisitz 6640: display:block;
6641: list-style:none;
6642: padding: 0;
1.870 tempelho 6643: }
6644:
1.795 www 6645: ul.LC_TabContentBigger li {
1.911 bisitz 6646: vertical-align:bottom;
6647: height: 30px;
6648: font-size:110%;
6649: font-weight:bold;
6650: color: #737373;
1.841 tempelho 6651: }
6652:
1.957 onken 6653: ul.LC_TabContentBigger li.active {
6654: position: relative;
6655: top: 1px;
6656: }
6657:
1.870 tempelho 6658: ul.LC_TabContentBigger li a {
1.911 bisitz 6659: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6660: height: 30px;
6661: line-height: 30px;
6662: text-align: center;
6663: display: block;
6664: text-decoration: none;
1.958 onken 6665: outline: none;
1.741 harmsja 6666: }
1.795 www 6667:
1.870 tempelho 6668: ul.LC_TabContentBigger li.active a {
1.911 bisitz 6669: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6670: color:$font;
1.744 ehlerst 6671: }
1.795 www 6672:
1.870 tempelho 6673: ul.LC_TabContentBigger li b {
1.911 bisitz 6674: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
6675: display: block;
6676: float: left;
6677: padding: 0 30px;
1.957 onken 6678: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 6679: }
6680:
1.956 onken 6681: ul.LC_TabContentBigger li:hover b {
6682: color:$button_hover;
6683: }
6684:
1.870 tempelho 6685: ul.LC_TabContentBigger li.active b {
1.911 bisitz 6686: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
6687: color:$font;
1.957 onken 6688: border: 0;
1.741 harmsja 6689: }
1.693 droeschl 6690:
1.870 tempelho 6691:
1.862 bisitz 6692: ul.LC_CourseBreadcrumbs {
6693: background: $sidebg;
1.1020 raeburn 6694: height: 2em;
1.862 bisitz 6695: padding-left: 10px;
1.1020 raeburn 6696: margin: 0;
1.862 bisitz 6697: list-style-position: inside;
6698: }
6699:
1.911 bisitz 6700: ol#LC_MenuBreadcrumbs,
1.862 bisitz 6701: ol#LC_PathBreadcrumbs {
1.911 bisitz 6702: padding-left: 10px;
6703: margin: 0;
1.933 droeschl 6704: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 6705: }
6706:
1.911 bisitz 6707: ol#LC_MenuBreadcrumbs li,
6708: ol#LC_PathBreadcrumbs li,
1.862 bisitz 6709: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 6710: display: inline;
1.933 droeschl 6711: white-space: normal;
1.693 droeschl 6712: }
6713:
1.823 bisitz 6714: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 6715: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 6716: text-decoration: none;
6717: font-size:90%;
1.693 droeschl 6718: }
1.795 www 6719:
1.969 droeschl 6720: ol#LC_MenuBreadcrumbs h1 {
6721: display: inline;
6722: font-size: 90%;
6723: line-height: 2.5em;
6724: margin: 0;
6725: padding: 0;
6726: }
6727:
1.795 www 6728: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 6729: text-decoration:none;
6730: font-size:100%;
6731: font-weight:bold;
1.693 droeschl 6732: }
1.795 www 6733:
1.840 bisitz 6734: .LC_Box {
1.911 bisitz 6735: border: solid 1px $lg_border_color;
6736: padding: 0 10px 10px 10px;
1.746 neumanie 6737: }
1.795 www 6738:
1.1020 raeburn 6739: .LC_DocsBox {
6740: border: solid 1px $lg_border_color;
6741: padding: 0 0 10px 10px;
6742: }
6743:
1.795 www 6744: .LC_AboutMe_Image {
1.911 bisitz 6745: float:left;
6746: margin-right:10px;
1.747 neumanie 6747: }
1.795 www 6748:
6749: .LC_Clear_AboutMe_Image {
1.911 bisitz 6750: clear:left;
1.747 neumanie 6751: }
1.795 www 6752:
1.721 harmsja 6753: dl.LC_ListStyleClean dt {
1.911 bisitz 6754: padding-right: 5px;
6755: display: table-header-group;
1.693 droeschl 6756: }
6757:
1.721 harmsja 6758: dl.LC_ListStyleClean dd {
1.911 bisitz 6759: display: table-row;
1.693 droeschl 6760: }
6761:
1.721 harmsja 6762: .LC_ListStyleClean,
6763: .LC_ListStyleSimple,
6764: .LC_ListStyleNormal,
1.795 www 6765: .LC_ListStyleSpecial {
1.911 bisitz 6766: /* display:block; */
6767: list-style-position: inside;
6768: list-style-type: none;
6769: overflow: hidden;
6770: padding: 0;
1.693 droeschl 6771: }
6772:
1.721 harmsja 6773: .LC_ListStyleSimple li,
6774: .LC_ListStyleSimple dd,
6775: .LC_ListStyleNormal li,
6776: .LC_ListStyleNormal dd,
6777: .LC_ListStyleSpecial li,
1.795 www 6778: .LC_ListStyleSpecial dd {
1.911 bisitz 6779: margin: 0;
6780: padding: 5px 5px 5px 10px;
6781: clear: both;
1.693 droeschl 6782: }
6783:
1.721 harmsja 6784: .LC_ListStyleClean li,
6785: .LC_ListStyleClean dd {
1.911 bisitz 6786: padding-top: 0;
6787: padding-bottom: 0;
1.693 droeschl 6788: }
6789:
1.721 harmsja 6790: .LC_ListStyleSimple dd,
1.795 www 6791: .LC_ListStyleSimple li {
1.911 bisitz 6792: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6793: }
6794:
1.721 harmsja 6795: .LC_ListStyleSpecial li,
6796: .LC_ListStyleSpecial dd {
1.911 bisitz 6797: list-style-type: none;
6798: background-color: RGB(220, 220, 220);
6799: margin-bottom: 4px;
1.693 droeschl 6800: }
6801:
1.721 harmsja 6802: table.LC_SimpleTable {
1.911 bisitz 6803: margin:5px;
6804: border:solid 1px $lg_border_color;
1.795 www 6805: }
1.693 droeschl 6806:
1.721 harmsja 6807: table.LC_SimpleTable tr {
1.911 bisitz 6808: padding: 0;
6809: border:solid 1px $lg_border_color;
1.693 droeschl 6810: }
1.795 www 6811:
6812: table.LC_SimpleTable thead {
1.911 bisitz 6813: background:rgb(220,220,220);
1.693 droeschl 6814: }
6815:
1.721 harmsja 6816: div.LC_columnSection {
1.911 bisitz 6817: display: block;
6818: clear: both;
6819: overflow: hidden;
6820: margin: 0;
1.693 droeschl 6821: }
6822:
1.721 harmsja 6823: div.LC_columnSection>* {
1.911 bisitz 6824: float: left;
6825: margin: 10px 20px 10px 0;
6826: overflow:hidden;
1.693 droeschl 6827: }
1.721 harmsja 6828:
1.795 www 6829: table em {
1.911 bisitz 6830: font-weight: bold;
6831: font-style: normal;
1.748 schulted 6832: }
1.795 www 6833:
1.779 bisitz 6834: table.LC_tableBrowseRes,
1.795 www 6835: table.LC_tableOfContent {
1.911 bisitz 6836: border:none;
6837: border-spacing: 1px;
6838: padding: 3px;
6839: background-color: #FFFFFF;
6840: font-size: 90%;
1.753 droeschl 6841: }
1.789 droeschl 6842:
1.911 bisitz 6843: table.LC_tableOfContent {
6844: border-collapse: collapse;
1.789 droeschl 6845: }
6846:
1.771 droeschl 6847: table.LC_tableBrowseRes a,
1.768 schulted 6848: table.LC_tableOfContent a {
1.911 bisitz 6849: background-color: transparent;
6850: text-decoration: none;
1.753 droeschl 6851: }
6852:
1.795 www 6853: table.LC_tableOfContent img {
1.911 bisitz 6854: border: none;
6855: height: 1.3em;
6856: vertical-align: text-bottom;
6857: margin-right: 0.3em;
1.753 droeschl 6858: }
1.757 schulted 6859:
1.795 www 6860: a#LC_content_toolbar_firsthomework {
1.911 bisitz 6861: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 6862: }
6863:
1.795 www 6864: a#LC_content_toolbar_everything {
1.911 bisitz 6865: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 6866: }
6867:
1.795 www 6868: a#LC_content_toolbar_uncompleted {
1.911 bisitz 6869: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 6870: }
6871:
1.795 www 6872: #LC_content_toolbar_clearbubbles {
1.911 bisitz 6873: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 6874: }
6875:
1.795 www 6876: a#LC_content_toolbar_changefolder {
1.911 bisitz 6877: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 6878: }
6879:
1.795 www 6880: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 6881: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 6882: }
6883:
1.1043 raeburn 6884: a#LC_content_toolbar_edittoplevel {
6885: background-image:url(/res/adm/pages/edittoplevel.gif);
6886: }
6887:
1.795 www 6888: ul#LC_toolbar li a:hover {
1.911 bisitz 6889: background-position: bottom center;
1.757 schulted 6890: }
6891:
1.795 www 6892: ul#LC_toolbar {
1.911 bisitz 6893: padding: 0;
6894: margin: 2px;
6895: list-style:none;
6896: position:relative;
6897: background-color:white;
1.757 schulted 6898: }
6899:
1.795 www 6900: ul#LC_toolbar li {
1.911 bisitz 6901: border:1px solid white;
6902: padding: 0;
6903: margin: 0;
6904: float: left;
6905: display:inline;
6906: vertical-align:middle;
6907: }
1.757 schulted 6908:
1.783 amueller 6909:
1.795 www 6910: a.LC_toolbarItem {
1.911 bisitz 6911: display:block;
6912: padding: 0;
6913: margin: 0;
6914: height: 32px;
6915: width: 32px;
6916: color:white;
6917: border: none;
6918: background-repeat:no-repeat;
6919: background-color:transparent;
1.757 schulted 6920: }
6921:
1.915 droeschl 6922: ul.LC_funclist {
6923: margin: 0;
6924: padding: 0.5em 1em 0.5em 0;
6925: }
6926:
1.933 droeschl 6927: ul.LC_funclist > li:first-child {
6928: font-weight:bold;
6929: margin-left:0.8em;
6930: }
6931:
1.915 droeschl 6932: ul.LC_funclist + ul.LC_funclist {
6933: /*
6934: left border as a seperator if we have more than
6935: one list
6936: */
6937: border-left: 1px solid $sidebg;
6938: /*
6939: this hides the left border behind the border of the
6940: outer box if element is wrapped to the next 'line'
6941: */
6942: margin-left: -1px;
6943: }
6944:
1.843 bisitz 6945: ul.LC_funclist li {
1.915 droeschl 6946: display: inline;
1.782 bisitz 6947: white-space: nowrap;
1.915 droeschl 6948: margin: 0 0 0 25px;
6949: line-height: 150%;
1.782 bisitz 6950: }
6951:
1.974 wenzelju 6952: .LC_hidden {
6953: display: none;
6954: }
6955:
1.1030 www 6956: .LCmodal-overlay {
6957: position:fixed;
6958: top:0;
6959: right:0;
6960: bottom:0;
6961: left:0;
6962: height:100%;
6963: width:100%;
6964: margin:0;
6965: padding:0;
6966: background:#999;
6967: opacity:.75;
6968: filter: alpha(opacity=75);
6969: -moz-opacity: 0.75;
6970: z-index:101;
6971: }
6972:
6973: * html .LCmodal-overlay {
6974: position: absolute;
6975: height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
6976: }
6977:
6978: .LCmodal-window {
6979: position:fixed;
6980: top:50%;
6981: left:50%;
6982: margin:0;
6983: padding:0;
6984: z-index:102;
6985: }
6986:
6987: * html .LCmodal-window {
6988: position:absolute;
6989: }
6990:
6991: .LCclose-window {
6992: position:absolute;
6993: width:32px;
6994: height:32px;
6995: right:8px;
6996: top:8px;
6997: background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
6998: text-indent:-99999px;
6999: overflow:hidden;
7000: cursor:pointer;
7001: }
7002:
1.343 albertel 7003: END
7004: }
7005:
1.306 albertel 7006: =pod
7007:
7008: =item * &headtag()
7009:
7010: Returns a uniform footer for LON-CAPA web pages.
7011:
1.307 albertel 7012: Inputs: $title - optional title for the head
7013: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 7014: $args - optional arguments
1.319 albertel 7015: force_register - if is true call registerurl so the remote is
7016: informed
1.415 albertel 7017: redirect -> array ref of
7018: 1- seconds before redirect occurs
7019: 2- url to redirect to
7020: 3- whether the side effect should occur
1.315 albertel 7021: (side effect of setting
7022: $env{'internal.head.redirect'} to the url
7023: redirected too)
1.352 albertel 7024: domain -> force to color decorate a page for a specific
7025: domain
7026: function -> force usage of a specific rolish color scheme
7027: bgcolor -> override the default page bgcolor
1.460 albertel 7028: no_auto_mt_title
7029: -> prevent &mt()ing the title arg
1.464 albertel 7030:
1.306 albertel 7031: =cut
7032:
7033: sub headtag {
1.313 albertel 7034: my ($title,$head_extra,$args) = @_;
1.306 albertel 7035:
1.363 albertel 7036: my $function = $args->{'function'} || &get_users_function();
7037: my $domain = $args->{'domain'} || &determinedomain();
7038: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 7039: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 7040: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 7041: #time(),
1.418 albertel 7042: $env{'environment.color.timestamp'},
1.363 albertel 7043: $function,$domain,$bgcolor);
7044:
1.369 www 7045: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 7046:
1.308 albertel 7047: my $result =
7048: '<head>'.
1.461 albertel 7049: &font_settings();
1.319 albertel 7050:
1.1064 raeburn 7051: my $inhibitprint = &print_suppression();
7052:
1.461 albertel 7053: if (!$args->{'frameset'}) {
7054: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
7055: }
1.962 droeschl 7056: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
7057: $result .= Apache::lonxml::display_title();
1.319 albertel 7058: }
1.436 albertel 7059: if (!$args->{'no_nav_bar'}
7060: && !$args->{'only_body'}
7061: && !$args->{'frameset'}) {
7062: $result .= &help_menu_js();
1.1032 www 7063: $result.=&modal_window();
1.1038 www 7064: $result.=&togglebox_script();
1.1034 www 7065: $result.=&wishlist_window();
1.1041 www 7066: $result.=&LCprogressbarUpdate_script();
1.1034 www 7067: } else {
7068: if ($args->{'add_modal'}) {
7069: $result.=&modal_window();
7070: }
7071: if ($args->{'add_wishlist'}) {
7072: $result.=&wishlist_window();
7073: }
1.1038 www 7074: if ($args->{'add_togglebox'}) {
7075: $result.=&togglebox_script();
7076: }
1.1041 www 7077: if ($args->{'add_progressbar'}) {
7078: $result.=&LCprogressbarUpdate_script();
7079: }
1.436 albertel 7080: }
1.314 albertel 7081: if (ref($args->{'redirect'})) {
1.414 albertel 7082: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 7083: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 7084: if (!$inhibit_continue) {
7085: $env{'internal.head.redirect'} = $url;
7086: }
1.313 albertel 7087: $result.=<<ADDMETA
7088: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 7089: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 7090: ADDMETA
7091: }
1.306 albertel 7092: if (!defined($title)) {
7093: $title = 'The LearningOnline Network with CAPA';
7094: }
1.460 albertel 7095: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
7096: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 7097: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
1.1064 raeburn 7098: .$inhibitprint
1.414 albertel 7099: .$head_extra;
1.962 droeschl 7100: return $result.'</head>';
1.306 albertel 7101: }
7102:
7103: =pod
7104:
1.340 albertel 7105: =item * &font_settings()
7106:
7107: Returns neccessary <meta> to set the proper encoding
7108:
7109: Inputs: none
7110:
7111: =cut
7112:
7113: sub font_settings {
7114: my $headerstring='';
1.647 www 7115: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 7116: $headerstring.=
7117: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
7118: }
7119: return $headerstring;
7120: }
7121:
1.341 albertel 7122: =pod
7123:
1.1064 raeburn 7124: =item * &print_suppression()
7125:
7126: In course context returns css which causes the body to be blank when media="print",
7127: if printout generation is unavailable for the current resource.
7128:
7129: This could be because:
7130:
7131: (a) printstartdate is in the future
7132:
7133: (b) printenddate is in the past
7134:
7135: (c) there is an active exam block with "printout"
7136: functionality blocked
7137:
7138: Users with pav, pfo or evb privileges are exempt.
7139:
7140: Inputs: none
7141:
7142: =cut
7143:
7144:
7145: sub print_suppression {
7146: my $noprint;
7147: if ($env{'request.course.id'}) {
7148: my $scope = $env{'request.course.id'};
7149: if ((&Apache::lonnet::allowed('pav',$scope)) ||
7150: (&Apache::lonnet::allowed('pfo',$scope))) {
7151: return;
7152: }
7153: if ($env{'request.course.sec'} ne '') {
7154: $scope .= "/$env{'request.course.sec'}";
7155: if ((&Apache::lonnet::allowed('pav',$scope)) ||
7156: (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065 raeburn 7157: return;
1.1064 raeburn 7158: }
7159: }
7160: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7161: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1065 raeburn 7162: my $blocked = &blocking_status('printout',$cnum,$cdom);
1.1064 raeburn 7163: if ($blocked) {
7164: my $checkrole = "cm./$cdom/$cnum";
7165: if ($env{'request.course.sec'} ne '') {
7166: $checkrole .= "/$env{'request.course.sec'}";
7167: }
7168: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
7169: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
7170: $noprint = 1;
7171: }
7172: }
7173: unless ($noprint) {
7174: my $symb = &Apache::lonnet::symbread();
7175: if ($symb ne '') {
7176: my $navmap = Apache::lonnavmaps::navmap->new();
7177: if (ref($navmap)) {
7178: my $res = $navmap->getBySymb($symb);
7179: if (ref($res)) {
7180: if (!$res->resprintable()) {
7181: $noprint = 1;
7182: }
7183: }
7184: }
7185: }
7186: }
7187: if ($noprint) {
7188: return <<"ENDSTYLE";
7189: <style type="text/css" media="print">
7190: body { display:none }
7191: </style>
7192: ENDSTYLE
7193: }
7194: }
7195: return;
7196: }
7197:
7198: =pod
7199:
1.341 albertel 7200: =item * &xml_begin()
7201:
7202: Returns the needed doctype and <html>
7203:
7204: Inputs: none
7205:
7206: =cut
7207:
7208: sub xml_begin {
7209: my $output='';
7210:
7211: if ($env{'browser.mathml'}) {
7212: $output='<?xml version="1.0"?>'
7213: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
7214: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
7215:
7216: # .'<!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">] >'
7217: .'<!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">'
7218: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
7219: .'xmlns="http://www.w3.org/1999/xhtml">';
7220: } else {
1.849 bisitz 7221: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
7222: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341 albertel 7223: }
7224: return $output;
7225: }
1.340 albertel 7226:
7227: =pod
7228:
1.306 albertel 7229: =item * &start_page()
7230:
7231: Returns a complete <html> .. <body> section for LON-CAPA web pages.
7232:
1.648 raeburn 7233: Inputs:
7234:
7235: =over 4
7236:
7237: $title - optional title for the page
7238:
7239: $head_extra - optional extra HTML to incude inside the <head>
7240:
7241: $args - additional optional args supported are:
7242:
7243: =over 8
7244:
7245: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 7246: arg on
1.814 bisitz 7247: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 7248: add_entries -> additional attributes to add to the <body>
7249: domain -> force to color decorate a page for a
1.317 albertel 7250: specific domain
1.648 raeburn 7251: function -> force usage of a specific rolish color
1.317 albertel 7252: scheme
1.648 raeburn 7253: redirect -> see &headtag()
7254: bgcolor -> override the default page bg color
7255: js_ready -> return a string ready for being used in
1.317 albertel 7256: a javascript writeln
1.648 raeburn 7257: html_encode -> return a string ready for being used in
1.320 albertel 7258: a html attribute
1.648 raeburn 7259: force_register -> if is true will turn on the &bodytag()
1.317 albertel 7260: $forcereg arg
1.648 raeburn 7261: frameset -> if true will start with a <frameset>
1.330 albertel 7262: rather than <body>
1.648 raeburn 7263: skip_phases -> hash ref of
1.338 albertel 7264: head -> skip the <html><head> generation
7265: body -> skip all <body> generation
1.648 raeburn 7266: no_auto_mt_title -> prevent &mt()ing the title arg
7267: inherit_jsmath -> when creating popup window in a page,
7268: should it have jsmath forced on by the
7269: current page
1.867 kalberla 7270: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 7271: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.361 albertel 7272:
1.648 raeburn 7273: =back
1.460 albertel 7274:
1.648 raeburn 7275: =back
1.562 albertel 7276:
1.306 albertel 7277: =cut
7278:
7279: sub start_page {
1.309 albertel 7280: my ($title,$head_extra,$args) = @_;
1.318 albertel 7281: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319 albertel 7282:
1.315 albertel 7283: $env{'internal.start_page'}++;
1.338 albertel 7284: my $result;
1.964 droeschl 7285:
1.338 albertel 7286: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1030 www 7287: $result .= &xml_begin() . &headtag($title, $head_extra, $args);
1.338 albertel 7288: }
7289:
7290: if (! exists($args->{'skip_phases'}{'body'}) ) {
7291: if ($args->{'frameset'}) {
7292: my $attr_string = &make_attr_string($args->{'force_register'},
7293: $args->{'add_entries'});
7294: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 7295: } else {
7296: $result .=
7297: &bodytag($title,
7298: $args->{'function'}, $args->{'add_entries'},
7299: $args->{'only_body'}, $args->{'domain'},
7300: $args->{'force_register'}, $args->{'no_nav_bar'},
1.962 droeschl 7301: $args->{'bgcolor'}, $args);
1.831 bisitz 7302: }
1.330 albertel 7303: }
1.338 albertel 7304:
1.315 albertel 7305: if ($args->{'js_ready'}) {
1.713 kaisler 7306: $result = &js_ready($result);
1.315 albertel 7307: }
1.320 albertel 7308: if ($args->{'html_encode'}) {
1.713 kaisler 7309: $result = &html_encode($result);
7310: }
7311:
1.813 bisitz 7312: # Preparation for new and consistent functionlist at top of screen
7313: # if ($args->{'functionlist'}) {
7314: # $result .= &build_functionlist();
7315: #}
7316:
1.964 droeschl 7317: # Don't add anything more if only_body wanted or in const space
7318: return $result if $args->{'only_body'}
7319: || $env{'request.state'} eq 'construct';
1.813 bisitz 7320:
7321: #Breadcrumbs
1.758 kaisler 7322: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
7323: &Apache::lonhtmlcommon::clear_breadcrumbs();
7324: #if any br links exists, add them to the breadcrumbs
7325: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
7326: foreach my $crumb (@{$args->{'bread_crumbs'}}){
7327: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
7328: }
7329: }
7330:
7331: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
7332: if(exists($args->{'bread_crumbs_component'})){
7333: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
7334: }else{
7335: $result .= &Apache::lonhtmlcommon::breadcrumbs();
7336: }
1.320 albertel 7337: }
1.315 albertel 7338: return $result;
1.306 albertel 7339: }
7340:
7341: sub end_page {
1.315 albertel 7342: my ($args) = @_;
7343: $env{'internal.end_page'}++;
1.330 albertel 7344: my $result;
1.335 albertel 7345: if ($args->{'discussion'}) {
7346: my ($target,$parser);
7347: if (ref($args->{'discussion'})) {
7348: ($target,$parser) =($args->{'discussion'}{'target'},
7349: $args->{'discussion'}{'parser'});
7350: }
7351: $result .= &Apache::lonxml::xmlend($target,$parser);
7352: }
1.330 albertel 7353: if ($args->{'frameset'}) {
7354: $result .= '</frameset>';
7355: } else {
1.635 raeburn 7356: $result .= &endbodytag($args);
1.330 albertel 7357: }
7358: $result .= "\n</html>";
7359:
1.315 albertel 7360: if ($args->{'js_ready'}) {
1.317 albertel 7361: $result = &js_ready($result);
1.315 albertel 7362: }
1.335 albertel 7363:
1.320 albertel 7364: if ($args->{'html_encode'}) {
7365: $result = &html_encode($result);
7366: }
1.335 albertel 7367:
1.315 albertel 7368: return $result;
7369: }
7370:
1.1034 www 7371: sub wishlist_window {
7372: return(<<'ENDWISHLIST');
1.1046 raeburn 7373: <script type="text/javascript">
1.1034 www 7374: // <![CDATA[
7375: // <!-- BEGIN LON-CAPA Internal
7376: function set_wishlistlink(title, path) {
7377: if (!title) {
7378: title = document.title;
7379: title = title.replace(/^LON-CAPA /,'');
7380: }
7381: if (!path) {
7382: path = location.pathname;
7383: }
7384: Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
7385: 'wishlistNewLink','width=560,height=350,scrollbars=0');
7386: }
7387: // END LON-CAPA Internal -->
7388: // ]]>
7389: </script>
7390: ENDWISHLIST
7391: }
7392:
1.1030 www 7393: sub modal_window {
7394: return(<<'ENDMODAL');
1.1046 raeburn 7395: <script type="text/javascript">
1.1030 www 7396: // <![CDATA[
7397: // <!-- BEGIN LON-CAPA Internal
7398: var modalWindow = {
7399: parent:"body",
7400: windowId:null,
7401: content:null,
7402: width:null,
7403: height:null,
7404: close:function()
7405: {
7406: $(".LCmodal-window").remove();
7407: $(".LCmodal-overlay").remove();
7408: },
7409: open:function()
7410: {
7411: var modal = "";
7412: modal += "<div class=\"LCmodal-overlay\"></div>";
7413: 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;\">";
7414: modal += this.content;
7415: modal += "</div>";
7416:
7417: $(this.parent).append(modal);
7418:
7419: $(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
7420: $(".LCclose-window").click(function(){modalWindow.close();});
7421: $(".LCmodal-overlay").click(function(){modalWindow.close();});
7422: }
7423: };
1.1031 www 7424: var openMyModal = function(source,width,height,scrolling)
1.1030 www 7425: {
7426: modalWindow.windowId = "myModal";
7427: modalWindow.width = width;
7428: modalWindow.height = height;
1.1031 www 7429: modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='true' src='" + source + "'></iframe>";
1.1030 www 7430: modalWindow.open();
7431: };
7432: // END LON-CAPA Internal -->
7433: // ]]>
7434: </script>
7435: ENDMODAL
7436: }
7437:
7438: sub modal_link {
1.1052 www 7439: my ($link,$linktext,$width,$height,$target,$scrolling,$title)=@_;
1.1030 www 7440: unless ($width) { $width=480; }
7441: unless ($height) { $height=400; }
1.1031 www 7442: unless ($scrolling) { $scrolling='yes'; }
1.1074 raeburn 7443: my $target_attr;
7444: if (defined($target)) {
7445: $target_attr = 'target="'.$target.'"';
7446: }
7447: return <<"ENDLINK";
7448: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling'); return false;">
7449: $linktext</a>
7450: ENDLINK
1.1030 www 7451: }
7452:
1.1032 www 7453: sub modal_adhoc_script {
7454: my ($funcname,$width,$height,$content)=@_;
7455: return (<<ENDADHOC);
1.1046 raeburn 7456: <script type="text/javascript">
1.1032 www 7457: // <![CDATA[
7458: var $funcname = function()
7459: {
7460: modalWindow.windowId = "myModal";
7461: modalWindow.width = $width;
7462: modalWindow.height = $height;
7463: modalWindow.content = '$content';
7464: modalWindow.open();
7465: };
7466: // ]]>
7467: </script>
7468: ENDADHOC
7469: }
7470:
1.1041 www 7471: sub modal_adhoc_inner {
7472: my ($funcname,$width,$height,$content)=@_;
7473: my $innerwidth=$width-20;
7474: $content=&js_ready(
1.1042 www 7475: &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
1.1041 www 7476: &start_scrollbox($width.'px',$innerwidth.'px',$height.'px').
7477: $content.
7478: &end_scrollbox().
7479: &end_page()
7480: );
7481: return &modal_adhoc_script($funcname,$width,$height,$content);
7482: }
7483:
7484: sub modal_adhoc_window {
7485: my ($funcname,$width,$height,$content,$linktext)=@_;
7486: return &modal_adhoc_inner($funcname,$width,$height,$content).
7487: "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
7488: }
7489:
7490: sub modal_adhoc_launch {
7491: my ($funcname,$width,$height,$content)=@_;
7492: return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
7493: <script type="text/javascript">
7494: // <![CDATA[
7495: $funcname();
7496: // ]]>
7497: </script>
7498: ENDLAUNCH
7499: }
7500:
7501: sub modal_adhoc_close {
7502: return (<<ENDCLOSE);
7503: <script type="text/javascript">
7504: // <![CDATA[
7505: modalWindow.close();
7506: // ]]>
7507: </script>
7508: ENDCLOSE
7509: }
7510:
1.1038 www 7511: sub togglebox_script {
7512: return(<<ENDTOGGLE);
7513: <script type="text/javascript">
7514: // <![CDATA[
7515: function LCtoggleDisplay(id,hidetext,showtext) {
7516: link = document.getElementById(id + "link").childNodes[0];
7517: with (document.getElementById(id).style) {
7518: if (display == "none" ) {
7519: display = "inline";
7520: link.nodeValue = hidetext;
7521: } else {
7522: display = "none";
7523: link.nodeValue = showtext;
7524: }
7525: }
7526: }
7527: // ]]>
7528: </script>
7529: ENDTOGGLE
7530: }
7531:
1.1039 www 7532: sub start_togglebox {
7533: my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
7534: unless ($heading) { $heading=''; } else { $heading.=' '; }
7535: unless ($showtext) { $showtext=&mt('show'); }
7536: unless ($hidetext) { $hidetext=&mt('hide'); }
7537: unless ($headerbg) { $headerbg='#FFFFFF'; }
7538: return &start_data_table().
7539: &start_data_table_header_row().
7540: '<td bgcolor="'.$headerbg.'">'.$heading.
7541: '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
7542: $showtext.'\')">'.$showtext.'</a>]</td>'.
7543: &end_data_table_header_row().
7544: '<tr id="'.$id.'" style="display:none""><td>';
7545: }
7546:
7547: sub end_togglebox {
7548: return '</td></tr>'.&end_data_table();
7549: }
7550:
1.1041 www 7551: sub LCprogressbar_script {
1.1045 www 7552: my ($id)=@_;
1.1041 www 7553: return(<<ENDPROGRESS);
7554: <script type="text/javascript">
7555: // <![CDATA[
1.1045 www 7556: \$('#progressbar$id').progressbar({
1.1041 www 7557: value: 0,
7558: change: function(event, ui) {
7559: var newVal = \$(this).progressbar('option', 'value');
7560: \$('.pblabel', this).text(LCprogressTxt);
7561: }
7562: });
7563: // ]]>
7564: </script>
7565: ENDPROGRESS
7566: }
7567:
7568: sub LCprogressbarUpdate_script {
7569: return(<<ENDPROGRESSUPDATE);
7570: <style type="text/css">
7571: .ui-progressbar { position:relative; }
7572: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
7573: </style>
7574: <script type="text/javascript">
7575: // <![CDATA[
1.1045 www 7576: var LCprogressTxt='---';
7577:
7578: function LCupdateProgress(percent,progresstext,id) {
1.1041 www 7579: LCprogressTxt=progresstext;
1.1045 www 7580: \$('#progressbar'+id).progressbar('value',percent);
1.1041 www 7581: }
7582: // ]]>
7583: </script>
7584: ENDPROGRESSUPDATE
7585: }
7586:
1.1042 www 7587: my $LClastpercent;
1.1045 www 7588: my $LCidcnt;
7589: my $LCcurrentid;
1.1042 www 7590:
1.1041 www 7591: sub LCprogressbar {
1.1042 www 7592: my ($r)=(@_);
7593: $LClastpercent=0;
1.1045 www 7594: $LCidcnt++;
7595: $LCcurrentid=$$.'_'.$LCidcnt;
1.1041 www 7596: my $starting=&mt('Starting');
7597: my $content=(<<ENDPROGBAR);
7598: <p>
1.1045 www 7599: <div id="progressbar$LCcurrentid">
1.1041 www 7600: <span class="pblabel">$starting</span>
7601: </div>
7602: </p>
7603: ENDPROGBAR
1.1045 www 7604: &r_print($r,$content.&LCprogressbar_script($LCcurrentid));
1.1041 www 7605: }
7606:
7607: sub LCprogressbarUpdate {
1.1042 www 7608: my ($r,$val,$text)=@_;
7609: unless ($val) {
7610: if ($LClastpercent) {
7611: $val=$LClastpercent;
7612: } else {
7613: $val=0;
7614: }
7615: }
1.1041 www 7616: if ($val<0) { $val=0; }
7617: if ($val>100) { $val=0; }
1.1042 www 7618: $LClastpercent=$val;
1.1041 www 7619: unless ($text) { $text=$val.'%'; }
7620: $text=&js_ready($text);
1.1044 www 7621: &r_print($r,<<ENDUPDATE);
1.1041 www 7622: <script type="text/javascript">
7623: // <![CDATA[
1.1045 www 7624: LCupdateProgress($val,'$text','$LCcurrentid');
1.1041 www 7625: // ]]>
7626: </script>
7627: ENDUPDATE
1.1035 www 7628: }
7629:
1.1042 www 7630: sub LCprogressbarClose {
7631: my ($r)=@_;
7632: $LClastpercent=0;
1.1044 www 7633: &r_print($r,<<ENDCLOSE);
1.1042 www 7634: <script type="text/javascript">
7635: // <![CDATA[
1.1045 www 7636: \$("#progressbar$LCcurrentid").hide('slow');
1.1042 www 7637: // ]]>
7638: </script>
7639: ENDCLOSE
1.1044 www 7640: }
7641:
7642: sub r_print {
7643: my ($r,$to_print)=@_;
7644: if ($r) {
7645: $r->print($to_print);
7646: $r->rflush();
7647: } else {
7648: print($to_print);
7649: }
1.1042 www 7650: }
7651:
1.320 albertel 7652: sub html_encode {
7653: my ($result) = @_;
7654:
1.322 albertel 7655: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 7656:
7657: return $result;
7658: }
1.1044 www 7659:
1.317 albertel 7660: sub js_ready {
7661: my ($result) = @_;
7662:
1.323 albertel 7663: $result =~ s/[\n\r]/ /xmsg;
7664: $result =~ s/\\/\\\\/xmsg;
7665: $result =~ s/'/\\'/xmsg;
1.372 albertel 7666: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 7667:
7668: return $result;
7669: }
7670:
1.315 albertel 7671: sub validate_page {
7672: if ( exists($env{'internal.start_page'})
1.316 albertel 7673: && $env{'internal.start_page'} > 1) {
7674: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 7675: $env{'internal.start_page'}.' '.
1.316 albertel 7676: $ENV{'request.filename'});
1.315 albertel 7677: }
7678: if ( exists($env{'internal.end_page'})
1.316 albertel 7679: && $env{'internal.end_page'} > 1) {
7680: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 7681: $env{'internal.end_page'}.' '.
1.316 albertel 7682: $env{'request.filename'});
1.315 albertel 7683: }
7684: if ( exists($env{'internal.start_page'})
7685: && ! exists($env{'internal.end_page'})) {
1.316 albertel 7686: &Apache::lonnet::logthis('start_page called without end_page '.
7687: $env{'request.filename'});
1.315 albertel 7688: }
7689: if ( ! exists($env{'internal.start_page'})
7690: && exists($env{'internal.end_page'})) {
1.316 albertel 7691: &Apache::lonnet::logthis('end_page called without start_page'.
7692: $env{'request.filename'});
1.315 albertel 7693: }
1.306 albertel 7694: }
1.315 albertel 7695:
1.996 www 7696:
7697: sub start_scrollbox {
1.1075 raeburn 7698: my ($outerwidth,$width,$height,$id,$bgcolor)=@_;
1.998 raeburn 7699: unless ($outerwidth) { $outerwidth='520px'; }
7700: unless ($width) { $width='500px'; }
7701: unless ($height) { $height='200px'; }
1.1075 raeburn 7702: my ($table_id,$div_id,$tdcol);
1.1018 raeburn 7703: if ($id ne '') {
1.1020 raeburn 7704: $table_id = " id='table_$id'";
7705: $div_id = " id='div_$id'";
1.1018 raeburn 7706: }
1.1075 raeburn 7707: if ($bgcolor ne '') {
7708: $tdcol = "background-color: $bgcolor;";
7709: }
7710: return <<"END";
7711: <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>
7712: END
1.996 www 7713: }
7714:
7715: sub end_scrollbox {
1.1036 www 7716: return '</div></td></tr></table>';
1.996 www 7717: }
7718:
1.318 albertel 7719: sub simple_error_page {
7720: my ($r,$title,$msg) = @_;
7721: my $page =
7722: &Apache::loncommon::start_page($title).
7723: &mt($msg).
7724: &Apache::loncommon::end_page();
7725: if (ref($r)) {
7726: $r->print($page);
1.327 albertel 7727: return;
1.318 albertel 7728: }
7729: return $page;
7730: }
1.347 albertel 7731:
7732: {
1.610 albertel 7733: my @row_count;
1.961 onken 7734:
7735: sub start_data_table_count {
7736: unshift(@row_count, 0);
7737: return;
7738: }
7739:
7740: sub end_data_table_count {
7741: shift(@row_count);
7742: return;
7743: }
7744:
1.347 albertel 7745: sub start_data_table {
1.1018 raeburn 7746: my ($add_class,$id) = @_;
1.422 albertel 7747: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 7748: my $table_id;
7749: if (defined($id)) {
7750: $table_id = ' id="'.$id.'"';
7751: }
1.961 onken 7752: &start_data_table_count();
1.1018 raeburn 7753: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 7754: }
7755:
7756: sub end_data_table {
1.961 onken 7757: &end_data_table_count();
1.389 albertel 7758: return '</table>'."\n";;
1.347 albertel 7759: }
7760:
7761: sub start_data_table_row {
1.974 wenzelju 7762: my ($add_class, $id) = @_;
1.610 albertel 7763: $row_count[0]++;
7764: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 7765: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 7766: $id = (' id="'.$id.'"') unless ($id eq '');
7767: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 7768: }
1.471 banghart 7769:
7770: sub continue_data_table_row {
1.974 wenzelju 7771: my ($add_class, $id) = @_;
1.610 albertel 7772: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 7773: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
7774: $id = (' id="'.$id.'"') unless ($id eq '');
7775: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 7776: }
1.347 albertel 7777:
7778: sub end_data_table_row {
1.389 albertel 7779: return '</tr>'."\n";;
1.347 albertel 7780: }
1.367 www 7781:
1.421 albertel 7782: sub start_data_table_empty_row {
1.707 bisitz 7783: # $row_count[0]++;
1.421 albertel 7784: return '<tr class="LC_empty_row" >'."\n";;
7785: }
7786:
7787: sub end_data_table_empty_row {
7788: return '</tr>'."\n";;
7789: }
7790:
1.367 www 7791: sub start_data_table_header_row {
1.389 albertel 7792: return '<tr class="LC_header_row">'."\n";;
1.367 www 7793: }
7794:
7795: sub end_data_table_header_row {
1.389 albertel 7796: return '</tr>'."\n";;
1.367 www 7797: }
1.890 droeschl 7798:
7799: sub data_table_caption {
7800: my $caption = shift;
7801: return "<caption class=\"LC_caption\">$caption</caption>";
7802: }
1.347 albertel 7803: }
7804:
1.548 albertel 7805: =pod
7806:
7807: =item * &inhibit_menu_check($arg)
7808:
7809: Checks for a inhibitmenu state and generates output to preserve it
7810:
7811: Inputs: $arg - can be any of
7812: - undef - in which case the return value is a string
7813: to add into arguments list of a uri
7814: - 'input' - in which case the return value is a HTML
7815: <form> <input> field of type hidden to
7816: preserve the value
7817: - a url - in which case the return value is the url with
7818: the neccesary cgi args added to preserve the
7819: inhibitmenu state
7820: - a ref to a url - no return value, but the string is
7821: updated to include the neccessary cgi
7822: args to preserve the inhibitmenu state
7823:
7824: =cut
7825:
7826: sub inhibit_menu_check {
7827: my ($arg) = @_;
7828: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
7829: if ($arg eq 'input') {
7830: if ($env{'form.inhibitmenu'}) {
7831: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
7832: } else {
7833: return
7834: }
7835: }
7836: if ($env{'form.inhibitmenu'}) {
7837: if (ref($arg)) {
7838: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7839: } elsif ($arg eq '') {
7840: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
7841: } else {
7842: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7843: }
7844: }
7845: if (!ref($arg)) {
7846: return $arg;
7847: }
7848: }
7849:
1.251 albertel 7850: ###############################################
1.182 matthew 7851:
7852: =pod
7853:
1.549 albertel 7854: =back
7855:
7856: =head1 User Information Routines
7857:
7858: =over 4
7859:
1.405 albertel 7860: =item * &get_users_function()
1.182 matthew 7861:
7862: Used by &bodytag to determine the current users primary role.
7863: Returns either 'student','coordinator','admin', or 'author'.
7864:
7865: =cut
7866:
7867: ###############################################
7868: sub get_users_function {
1.815 tempelho 7869: my $function = 'norole';
1.818 tempelho 7870: if ($env{'request.role'}=~/^(st)/) {
7871: $function='student';
7872: }
1.907 raeburn 7873: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 7874: $function='coordinator';
7875: }
1.258 albertel 7876: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 7877: $function='admin';
7878: }
1.826 bisitz 7879: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025 raeburn 7880: ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182 matthew 7881: $function='author';
7882: }
7883: return $function;
1.54 www 7884: }
1.99 www 7885:
7886: ###############################################
7887:
1.233 raeburn 7888: =pod
7889:
1.821 raeburn 7890: =item * &show_course()
7891:
7892: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
7893: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
7894:
7895: Inputs:
7896: None
7897:
7898: Outputs:
7899: Scalar: 1 if 'Course' to be used, 0 otherwise.
7900:
7901: =cut
7902:
7903: ###############################################
7904: sub show_course {
7905: my $course = !$env{'user.adv'};
7906: if (!$env{'user.adv'}) {
7907: foreach my $env (keys(%env)) {
7908: next if ($env !~ m/^user\.priv\./);
7909: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
7910: $course = 0;
7911: last;
7912: }
7913: }
7914: }
7915: return $course;
7916: }
7917:
7918: ###############################################
7919:
7920: =pod
7921:
1.542 raeburn 7922: =item * &check_user_status()
1.274 raeburn 7923:
7924: Determines current status of supplied role for a
7925: specific user. Roles can be active, previous or future.
7926:
7927: Inputs:
7928: user's domain, user's username, course's domain,
1.375 raeburn 7929: course's number, optional section ID.
1.274 raeburn 7930:
7931: Outputs:
7932: role status: active, previous or future.
7933:
7934: =cut
7935:
7936: sub check_user_status {
1.412 raeburn 7937: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073 raeburn 7938: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.274 raeburn 7939: my @uroles = keys %userinfo;
7940: my $srchstr;
7941: my $active_chk = 'none';
1.412 raeburn 7942: my $now = time;
1.274 raeburn 7943: if (@uroles > 0) {
1.908 raeburn 7944: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 7945: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
7946: } else {
1.412 raeburn 7947: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
7948: }
7949: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 7950: my $role_end = 0;
7951: my $role_start = 0;
7952: $active_chk = 'active';
1.412 raeburn 7953: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
7954: $role_end = $1;
7955: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
7956: $role_start = $1;
1.274 raeburn 7957: }
7958: }
7959: if ($role_start > 0) {
1.412 raeburn 7960: if ($now < $role_start) {
1.274 raeburn 7961: $active_chk = 'future';
7962: }
7963: }
7964: if ($role_end > 0) {
1.412 raeburn 7965: if ($now > $role_end) {
1.274 raeburn 7966: $active_chk = 'previous';
7967: }
7968: }
7969: }
7970: }
7971: return $active_chk;
7972: }
7973:
7974: ###############################################
7975:
7976: =pod
7977:
1.405 albertel 7978: =item * &get_sections()
1.233 raeburn 7979:
7980: Determines all the sections for a course including
7981: sections with students and sections containing other roles.
1.419 raeburn 7982: Incoming parameters:
7983:
7984: 1. domain
7985: 2. course number
7986: 3. reference to array containing roles for which sections should
7987: be gathered (optional).
7988: 4. reference to array containing status types for which sections
7989: should be gathered (optional).
7990:
7991: If the third argument is undefined, sections are gathered for any role.
7992: If the fourth argument is undefined, sections are gathered for any status.
7993: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 7994:
1.374 raeburn 7995: Returns section hash (keys are section IDs, values are
7996: number of users in each section), subject to the
1.419 raeburn 7997: optional roles filter, optional status filter
1.233 raeburn 7998:
7999: =cut
8000:
8001: ###############################################
8002: sub get_sections {
1.419 raeburn 8003: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 8004: if (!defined($cdom) || !defined($cnum)) {
8005: my $cid = $env{'request.course.id'};
8006:
8007: return if (!defined($cid));
8008:
8009: $cdom = $env{'course.'.$cid.'.domain'};
8010: $cnum = $env{'course.'.$cid.'.num'};
8011: }
8012:
8013: my %sectioncount;
1.419 raeburn 8014: my $now = time;
1.240 albertel 8015:
1.366 albertel 8016: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 8017: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 8018: my $sec_index = &Apache::loncoursedata::CL_SECTION();
8019: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 8020: my $start_index = &Apache::loncoursedata::CL_START();
8021: my $end_index = &Apache::loncoursedata::CL_END();
8022: my $status;
1.366 albertel 8023: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 8024: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
8025: $data->[$status_index],
8026: $data->[$start_index],
8027: $data->[$end_index]);
8028: if ($stu_status eq 'Active') {
8029: $status = 'active';
8030: } elsif ($end < $now) {
8031: $status = 'previous';
8032: } elsif ($start > $now) {
8033: $status = 'future';
8034: }
8035: if ($section ne '-1' && $section !~ /^\s*$/) {
8036: if ((!defined($possible_status)) || (($status ne '') &&
8037: (grep/^\Q$status\E$/,@{$possible_status}))) {
8038: $sectioncount{$section}++;
8039: }
1.240 albertel 8040: }
8041: }
8042: }
8043: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8044: foreach my $user (sort(keys(%courseroles))) {
8045: if ($user !~ /^(\w{2})/) { next; }
8046: my ($role) = ($user =~ /^(\w{2})/);
8047: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 8048: my ($section,$status);
1.240 albertel 8049: if ($role eq 'cr' &&
8050: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
8051: $section=$1;
8052: }
8053: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
8054: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 8055: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
8056: if ($end == -1 && $start == -1) {
8057: next; #deleted role
8058: }
8059: if (!defined($possible_status)) {
8060: $sectioncount{$section}++;
8061: } else {
8062: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
8063: $status = 'active';
8064: } elsif ($end < $now) {
8065: $status = 'future';
8066: } elsif ($start > $now) {
8067: $status = 'previous';
8068: }
8069: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
8070: $sectioncount{$section}++;
8071: }
8072: }
1.233 raeburn 8073: }
1.366 albertel 8074: return %sectioncount;
1.233 raeburn 8075: }
8076:
1.274 raeburn 8077: ###############################################
1.294 raeburn 8078:
8079: =pod
1.405 albertel 8080:
8081: =item * &get_course_users()
8082:
1.275 raeburn 8083: Retrieves usernames:domains for users in the specified course
8084: with specific role(s), and access status.
8085:
8086: Incoming parameters:
1.277 albertel 8087: 1. course domain
8088: 2. course number
8089: 3. access status: users must have - either active,
1.275 raeburn 8090: previous, future, or all.
1.277 albertel 8091: 4. reference to array of permissible roles
1.288 raeburn 8092: 5. reference to array of section restrictions (optional)
8093: 6. reference to results object (hash of hashes).
8094: 7. reference to optional userdata hash
1.609 raeburn 8095: 8. reference to optional statushash
1.630 raeburn 8096: 9. flag if privileged users (except those set to unhide in
8097: course settings) should be excluded
1.609 raeburn 8098: Keys of top level results hash are roles.
1.275 raeburn 8099: Keys of inner hashes are username:domain, with
8100: values set to access type.
1.288 raeburn 8101: Optional userdata hash returns an array with arguments in the
8102: same order as loncoursedata::get_classlist() for student data.
8103:
1.609 raeburn 8104: Optional statushash returns
8105:
1.288 raeburn 8106: Entries for end, start, section and status are blank because
8107: of the possibility of multiple values for non-student roles.
8108:
1.275 raeburn 8109: =cut
1.405 albertel 8110:
1.275 raeburn 8111: ###############################################
1.405 albertel 8112:
1.275 raeburn 8113: sub get_course_users {
1.630 raeburn 8114: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 8115: my %idx = ();
1.419 raeburn 8116: my %seclists;
1.288 raeburn 8117:
8118: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
8119: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
8120: $idx{end} = &Apache::loncoursedata::CL_END();
8121: $idx{start} = &Apache::loncoursedata::CL_START();
8122: $idx{id} = &Apache::loncoursedata::CL_ID();
8123: $idx{section} = &Apache::loncoursedata::CL_SECTION();
8124: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
8125: $idx{status} = &Apache::loncoursedata::CL_STATUS();
8126:
1.290 albertel 8127: if (grep(/^st$/,@{$roles})) {
1.276 albertel 8128: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 8129: my $now = time;
1.277 albertel 8130: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 8131: my $match = 0;
1.412 raeburn 8132: my $secmatch = 0;
1.419 raeburn 8133: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 8134: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 8135: if ($section eq '') {
8136: $section = 'none';
8137: }
1.291 albertel 8138: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 8139: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 8140: $secmatch = 1;
8141: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 8142: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 8143: $secmatch = 1;
8144: }
8145: } else {
1.419 raeburn 8146: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 8147: $secmatch = 1;
8148: }
1.290 albertel 8149: }
1.412 raeburn 8150: if (!$secmatch) {
8151: next;
8152: }
1.419 raeburn 8153: }
1.275 raeburn 8154: if (defined($$types{'active'})) {
1.288 raeburn 8155: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 8156: push(@{$$users{st}{$student}},'active');
1.288 raeburn 8157: $match = 1;
1.275 raeburn 8158: }
8159: }
8160: if (defined($$types{'previous'})) {
1.609 raeburn 8161: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 8162: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 8163: $match = 1;
1.275 raeburn 8164: }
8165: }
8166: if (defined($$types{'future'})) {
1.609 raeburn 8167: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 8168: push(@{$$users{st}{$student}},'future');
1.288 raeburn 8169: $match = 1;
1.275 raeburn 8170: }
8171: }
1.609 raeburn 8172: if ($match) {
8173: push(@{$seclists{$student}},$section);
8174: if (ref($userdata) eq 'HASH') {
8175: $$userdata{$student} = $$classlist{$student};
8176: }
8177: if (ref($statushash) eq 'HASH') {
8178: $statushash->{$student}{'st'}{$section} = $status;
8179: }
1.288 raeburn 8180: }
1.275 raeburn 8181: }
8182: }
1.412 raeburn 8183: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 8184: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8185: my $now = time;
1.609 raeburn 8186: my %displaystatus = ( previous => 'Expired',
8187: active => 'Active',
8188: future => 'Future',
8189: );
1.630 raeburn 8190: my %nothide;
8191: if ($hidepriv) {
8192: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
8193: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
8194: if ($user !~ /:/) {
8195: $nothide{join(':',split(/[\@]/,$user))}=1;
8196: } else {
8197: $nothide{$user} = 1;
8198: }
8199: }
8200: }
1.439 raeburn 8201: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 8202: my $match = 0;
1.412 raeburn 8203: my $secmatch = 0;
1.439 raeburn 8204: my $status;
1.412 raeburn 8205: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 8206: $user =~ s/:$//;
1.439 raeburn 8207: my ($end,$start) = split(/:/,$coursepersonnel{$person});
8208: if ($end == -1 || $start == -1) {
8209: next;
8210: }
8211: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
8212: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 8213: my ($uname,$udom) = split(/:/,$user);
8214: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 8215: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 8216: $secmatch = 1;
8217: } elsif ($usec eq '') {
1.420 albertel 8218: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 8219: $secmatch = 1;
8220: }
8221: } else {
8222: if (grep(/^\Q$usec\E$/,@{$sections})) {
8223: $secmatch = 1;
8224: }
8225: }
8226: if (!$secmatch) {
8227: next;
8228: }
1.288 raeburn 8229: }
1.419 raeburn 8230: if ($usec eq '') {
8231: $usec = 'none';
8232: }
1.275 raeburn 8233: if ($uname ne '' && $udom ne '') {
1.630 raeburn 8234: if ($hidepriv) {
8235: if ((&Apache::lonnet::privileged($uname,$udom)) &&
8236: (!$nothide{$uname.':'.$udom})) {
8237: next;
8238: }
8239: }
1.503 raeburn 8240: if ($end > 0 && $end < $now) {
1.439 raeburn 8241: $status = 'previous';
8242: } elsif ($start > $now) {
8243: $status = 'future';
8244: } else {
8245: $status = 'active';
8246: }
1.277 albertel 8247: foreach my $type (keys(%{$types})) {
1.275 raeburn 8248: if ($status eq $type) {
1.420 albertel 8249: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 8250: push(@{$$users{$role}{$user}},$type);
8251: }
1.288 raeburn 8252: $match = 1;
8253: }
8254: }
1.419 raeburn 8255: if (($match) && (ref($userdata) eq 'HASH')) {
8256: if (!exists($$userdata{$uname.':'.$udom})) {
8257: &get_user_info($udom,$uname,\%idx,$userdata);
8258: }
1.420 albertel 8259: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 8260: push(@{$seclists{$uname.':'.$udom}},$usec);
8261: }
1.609 raeburn 8262: if (ref($statushash) eq 'HASH') {
8263: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
8264: }
1.275 raeburn 8265: }
8266: }
8267: }
8268: }
1.290 albertel 8269: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 8270: if ((defined($cdom)) && (defined($cnum))) {
8271: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
8272: if ( defined($csettings{'internal.courseowner'}) ) {
8273: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 8274: next if ($owner eq '');
8275: my ($ownername,$ownerdom);
8276: if ($owner =~ /^([^:]+):([^:]+)$/) {
8277: $ownername = $1;
8278: $ownerdom = $2;
8279: } else {
8280: $ownername = $owner;
8281: $ownerdom = $cdom;
8282: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 8283: }
8284: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 8285: if (defined($userdata) &&
1.609 raeburn 8286: !exists($$userdata{$owner})) {
8287: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
8288: if (!grep(/^none$/,@{$seclists{$owner}})) {
8289: push(@{$seclists{$owner}},'none');
8290: }
8291: if (ref($statushash) eq 'HASH') {
8292: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 8293: }
1.290 albertel 8294: }
1.279 raeburn 8295: }
8296: }
8297: }
1.419 raeburn 8298: foreach my $user (keys(%seclists)) {
8299: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
8300: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
8301: }
1.275 raeburn 8302: }
8303: return;
8304: }
8305:
1.288 raeburn 8306: sub get_user_info {
8307: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 8308: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
8309: &plainname($uname,$udom,'lastname');
1.291 albertel 8310: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 8311: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 8312: my %idhash = &Apache::lonnet::idrget($udom,($uname));
8313: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 8314: return;
8315: }
1.275 raeburn 8316:
1.472 raeburn 8317: ###############################################
8318:
8319: =pod
8320:
8321: =item * &get_user_quota()
8322:
8323: Retrieves quota assigned for storage of portfolio files for a user
8324:
8325: Incoming parameters:
8326: 1. user's username
8327: 2. user's domain
8328:
8329: Returns:
1.536 raeburn 8330: 1. Disk quota (in Mb) assigned to student.
8331: 2. (Optional) Type of setting: custom or default
8332: (individually assigned or default for user's
8333: institutional status).
8334: 3. (Optional) - User's institutional status (e.g., faculty, staff
8335: or student - types as defined in localenroll::inst_usertypes
8336: for user's domain, which determines default quota for user.
8337: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 8338:
8339: If a value has been stored in the user's environment,
1.536 raeburn 8340: it will return that, otherwise it returns the maximal default
8341: defined for the user's instituional status(es) in the domain.
1.472 raeburn 8342:
8343: =cut
8344:
8345: ###############################################
8346:
8347:
8348: sub get_user_quota {
8349: my ($uname,$udom) = @_;
1.536 raeburn 8350: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 8351: if (!defined($udom)) {
8352: $udom = $env{'user.domain'};
8353: }
8354: if (!defined($uname)) {
8355: $uname = $env{'user.name'};
8356: }
8357: if (($udom eq '' || $uname eq '') ||
8358: ($udom eq 'public') && ($uname eq 'public')) {
8359: $quota = 0;
1.536 raeburn 8360: $quotatype = 'default';
8361: $defquota = 0;
1.472 raeburn 8362: } else {
1.536 raeburn 8363: my $inststatus;
1.472 raeburn 8364: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
8365: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 8366: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 8367: } else {
1.536 raeburn 8368: my %userenv =
8369: &Apache::lonnet::get('environment',['portfolioquota',
8370: 'inststatus'],$udom,$uname);
1.472 raeburn 8371: my ($tmp) = keys(%userenv);
8372: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
8373: $quota = $userenv{'portfolioquota'};
1.536 raeburn 8374: $inststatus = $userenv{'inststatus'};
1.472 raeburn 8375: } else {
8376: undef(%userenv);
8377: }
8378: }
1.536 raeburn 8379: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 8380: if ($quota eq '') {
1.536 raeburn 8381: $quota = $defquota;
8382: $quotatype = 'default';
8383: } else {
8384: $quotatype = 'custom';
1.472 raeburn 8385: }
8386: }
1.536 raeburn 8387: if (wantarray) {
8388: return ($quota,$quotatype,$settingstatus,$defquota);
8389: } else {
8390: return $quota;
8391: }
1.472 raeburn 8392: }
8393:
8394: ###############################################
8395:
8396: =pod
8397:
8398: =item * &default_quota()
8399:
1.536 raeburn 8400: Retrieves default quota assigned for storage of user portfolio files,
8401: given an (optional) user's institutional status.
1.472 raeburn 8402:
8403: Incoming parameters:
8404: 1. domain
1.536 raeburn 8405: 2. (Optional) institutional status(es). This is a : separated list of
8406: status types (e.g., faculty, staff, student etc.)
8407: which apply to the user for whom the default is being retrieved.
8408: If the institutional status string in undefined, the domain
8409: default quota will be returned.
1.472 raeburn 8410:
8411: Returns:
8412: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 8413: 2. (Optional) institutional type which determined the value of the
8414: default quota.
1.472 raeburn 8415:
8416: If a value has been stored in the domain's configuration db,
8417: it will return that, otherwise it returns 20 (for backwards
8418: compatibility with domains which have not set up a configuration
8419: db file; the original statically defined portfolio quota was 20 Mb).
8420:
1.536 raeburn 8421: If the user's status includes multiple types (e.g., staff and student),
8422: the largest default quota which applies to the user determines the
8423: default quota returned.
8424:
1.780 raeburn 8425: =back
8426:
1.472 raeburn 8427: =cut
8428:
8429: ###############################################
8430:
8431:
8432: sub default_quota {
1.536 raeburn 8433: my ($udom,$inststatus) = @_;
8434: my ($defquota,$settingstatus);
8435: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 8436: ['quotas'],$udom);
8437: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 8438: if ($inststatus ne '') {
1.765 raeburn 8439: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 8440: foreach my $item (@statuses) {
1.711 raeburn 8441: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
8442: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
8443: if ($defquota eq '') {
8444: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
8445: $settingstatus = $item;
8446: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
8447: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
8448: $settingstatus = $item;
8449: }
8450: }
8451: } else {
8452: if ($quotahash{'quotas'}{$item} ne '') {
8453: if ($defquota eq '') {
8454: $defquota = $quotahash{'quotas'}{$item};
8455: $settingstatus = $item;
8456: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
8457: $defquota = $quotahash{'quotas'}{$item};
8458: $settingstatus = $item;
8459: }
1.536 raeburn 8460: }
8461: }
8462: }
8463: }
8464: if ($defquota eq '') {
1.711 raeburn 8465: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
8466: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
8467: } else {
8468: $defquota = $quotahash{'quotas'}{'default'};
8469: }
1.536 raeburn 8470: $settingstatus = 'default';
8471: }
8472: } else {
8473: $settingstatus = 'default';
8474: $defquota = 20;
8475: }
8476: if (wantarray) {
8477: return ($defquota,$settingstatus);
1.472 raeburn 8478: } else {
1.536 raeburn 8479: return $defquota;
1.472 raeburn 8480: }
8481: }
8482:
1.384 raeburn 8483: sub get_secgrprole_info {
8484: my ($cdom,$cnum,$needroles,$type) = @_;
8485: my %sections_count = &get_sections($cdom,$cnum);
8486: my @sections = (sort {$a <=> $b} keys(%sections_count));
8487: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
8488: my @groups = sort(keys(%curr_groups));
8489: my $allroles = [];
8490: my $rolehash;
8491: my $accesshash = {
8492: active => 'Currently has access',
8493: future => 'Will have future access',
8494: previous => 'Previously had access',
8495: };
8496: if ($needroles) {
8497: $rolehash = {'all' => 'all'};
1.385 albertel 8498: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8499: if (&Apache::lonnet::error(%user_roles)) {
8500: undef(%user_roles);
8501: }
8502: foreach my $item (keys(%user_roles)) {
1.384 raeburn 8503: my ($role)=split(/\:/,$item,2);
8504: if ($role eq 'cr') { next; }
8505: if ($role =~ /^cr/) {
8506: $$rolehash{$role} = (split('/',$role))[3];
8507: } else {
8508: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
8509: }
8510: }
8511: foreach my $key (sort(keys(%{$rolehash}))) {
8512: push(@{$allroles},$key);
8513: }
8514: push (@{$allroles},'st');
8515: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
8516: }
8517: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
8518: }
8519:
1.555 raeburn 8520: sub user_picker {
1.994 raeburn 8521: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context) = @_;
1.555 raeburn 8522: my $currdom = $dom;
8523: my %curr_selected = (
8524: srchin => 'dom',
1.580 raeburn 8525: srchby => 'lastname',
1.555 raeburn 8526: );
8527: my $srchterm;
1.625 raeburn 8528: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 8529: if ($srch->{'srchby'} ne '') {
8530: $curr_selected{'srchby'} = $srch->{'srchby'};
8531: }
8532: if ($srch->{'srchin'} ne '') {
8533: $curr_selected{'srchin'} = $srch->{'srchin'};
8534: }
8535: if ($srch->{'srchtype'} ne '') {
8536: $curr_selected{'srchtype'} = $srch->{'srchtype'};
8537: }
8538: if ($srch->{'srchdomain'} ne '') {
8539: $currdom = $srch->{'srchdomain'};
8540: }
8541: $srchterm = $srch->{'srchterm'};
8542: }
8543: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 8544: 'usr' => 'Search criteria',
1.563 raeburn 8545: 'doma' => 'Domain/institution to search',
1.558 albertel 8546: 'uname' => 'username',
8547: 'lastname' => 'last name',
1.555 raeburn 8548: 'lastfirst' => 'last name, first name',
1.558 albertel 8549: 'crs' => 'in this course',
1.576 raeburn 8550: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 8551: 'alc' => 'all LON-CAPA',
1.573 raeburn 8552: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 8553: 'exact' => 'is',
8554: 'contains' => 'contains',
1.569 raeburn 8555: 'begins' => 'begins with',
1.571 raeburn 8556: 'youm' => "You must include some text to search for.",
8557: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
8558: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
8559: 'yomc' => "You must choose a domain when using an institutional directory search.",
8560: 'ymcd' => "You must choose a domain when using a domain search.",
8561: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
8562: 'whse' => "When searching by last,first you must include at least one character in the first name.",
8563: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 8564: );
1.563 raeburn 8565: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
8566: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 8567:
8568: my @srchins = ('crs','dom','alc','instd');
8569:
8570: foreach my $option (@srchins) {
8571: # FIXME 'alc' option unavailable until
8572: # loncreateuser::print_user_query_page()
8573: # has been completed.
8574: next if ($option eq 'alc');
1.880 raeburn 8575: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 8576: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 8577: if ($curr_selected{'srchin'} eq $option) {
8578: $srchinsel .= '
8579: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
8580: } else {
8581: $srchinsel .= '
8582: <option value="'.$option.'">'.$lt{$option}.'</option>';
8583: }
1.555 raeburn 8584: }
1.563 raeburn 8585: $srchinsel .= "\n </select>\n";
1.555 raeburn 8586:
8587: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 8588: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 8589: if ($curr_selected{'srchby'} eq $option) {
8590: $srchbysel .= '
8591: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
8592: } else {
8593: $srchbysel .= '
8594: <option value="'.$option.'">'.$lt{$option}.'</option>';
8595: }
8596: }
8597: $srchbysel .= "\n </select>\n";
8598:
8599: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 8600: foreach my $option ('begins','contains','exact') {
1.555 raeburn 8601: if ($curr_selected{'srchtype'} eq $option) {
8602: $srchtypesel .= '
8603: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
8604: } else {
8605: $srchtypesel .= '
8606: <option value="'.$option.'">'.$lt{$option}.'</option>';
8607: }
8608: }
8609: $srchtypesel .= "\n </select>\n";
8610:
1.558 albertel 8611: my ($newuserscript,$new_user_create);
1.994 raeburn 8612: my $context_dom = $env{'request.role.domain'};
8613: if ($context eq 'requestcrs') {
8614: if ($env{'form.coursedom'} ne '') {
8615: $context_dom = $env{'form.coursedom'};
8616: }
8617: }
1.556 raeburn 8618: if ($forcenewuser) {
1.576 raeburn 8619: if (ref($srch) eq 'HASH') {
1.994 raeburn 8620: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 8621: if ($cancreate) {
8622: $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>';
8623: } else {
1.799 bisitz 8624: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 8625: my %usertypetext = (
8626: official => 'institutional',
8627: unofficial => 'non-institutional',
8628: );
1.799 bisitz 8629: $new_user_create = '<p class="LC_warning">'
8630: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
8631: .' '
8632: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
8633: ,'<a href="'.$helplink.'">','</a>')
8634: .'</p><br />';
1.627 raeburn 8635: }
1.576 raeburn 8636: }
8637: }
8638:
1.556 raeburn 8639: $newuserscript = <<"ENDSCRIPT";
8640:
1.570 raeburn 8641: function setSearch(createnew,callingForm) {
1.556 raeburn 8642: if (createnew == 1) {
1.570 raeburn 8643: for (var i=0; i<callingForm.srchby.length; i++) {
8644: if (callingForm.srchby.options[i].value == 'uname') {
8645: callingForm.srchby.selectedIndex = i;
1.556 raeburn 8646: }
8647: }
1.570 raeburn 8648: for (var i=0; i<callingForm.srchin.length; i++) {
8649: if ( callingForm.srchin.options[i].value == 'dom') {
8650: callingForm.srchin.selectedIndex = i;
1.556 raeburn 8651: }
8652: }
1.570 raeburn 8653: for (var i=0; i<callingForm.srchtype.length; i++) {
8654: if (callingForm.srchtype.options[i].value == 'exact') {
8655: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 8656: }
8657: }
1.570 raeburn 8658: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 8659: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 8660: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 8661: }
8662: }
8663: }
8664: }
8665: ENDSCRIPT
1.558 albertel 8666:
1.556 raeburn 8667: }
8668:
1.555 raeburn 8669: my $output = <<"END_BLOCK";
1.556 raeburn 8670: <script type="text/javascript">
1.824 bisitz 8671: // <![CDATA[
1.570 raeburn 8672: function validateEntry(callingForm) {
1.558 albertel 8673:
1.556 raeburn 8674: var checkok = 1;
1.558 albertel 8675: var srchin;
1.570 raeburn 8676: for (var i=0; i<callingForm.srchin.length; i++) {
8677: if ( callingForm.srchin[i].checked ) {
8678: srchin = callingForm.srchin[i].value;
1.558 albertel 8679: }
8680: }
8681:
1.570 raeburn 8682: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
8683: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
8684: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
8685: var srchterm = callingForm.srchterm.value;
8686: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 8687: var msg = "";
8688:
8689: if (srchterm == "") {
8690: checkok = 0;
1.571 raeburn 8691: msg += "$lt{'youm'}\\n";
1.556 raeburn 8692: }
8693:
1.569 raeburn 8694: if (srchtype== 'begins') {
8695: if (srchterm.length < 2) {
8696: checkok = 0;
1.571 raeburn 8697: msg += "$lt{'thte'}\\n";
1.569 raeburn 8698: }
8699: }
8700:
1.556 raeburn 8701: if (srchtype== 'contains') {
8702: if (srchterm.length < 3) {
8703: checkok = 0;
1.571 raeburn 8704: msg += "$lt{'thet'}\\n";
1.556 raeburn 8705: }
8706: }
8707: if (srchin == 'instd') {
8708: if (srchdomain == '') {
8709: checkok = 0;
1.571 raeburn 8710: msg += "$lt{'yomc'}\\n";
1.556 raeburn 8711: }
8712: }
8713: if (srchin == 'dom') {
8714: if (srchdomain == '') {
8715: checkok = 0;
1.571 raeburn 8716: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 8717: }
8718: }
8719: if (srchby == 'lastfirst') {
8720: if (srchterm.indexOf(",") == -1) {
8721: checkok = 0;
1.571 raeburn 8722: msg += "$lt{'whus'}\\n";
1.556 raeburn 8723: }
8724: if (srchterm.indexOf(",") == srchterm.length -1) {
8725: checkok = 0;
1.571 raeburn 8726: msg += "$lt{'whse'}\\n";
1.556 raeburn 8727: }
8728: }
8729: if (checkok == 0) {
1.571 raeburn 8730: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 8731: return;
8732: }
8733: if (checkok == 1) {
1.570 raeburn 8734: callingForm.submit();
1.556 raeburn 8735: }
8736: }
8737:
8738: $newuserscript
8739:
1.824 bisitz 8740: // ]]>
1.556 raeburn 8741: </script>
1.558 albertel 8742:
8743: $new_user_create
8744:
1.555 raeburn 8745: END_BLOCK
1.558 albertel 8746:
1.876 raeburn 8747: $output .= &Apache::lonhtmlcommon::start_pick_box().
8748: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
8749: $domform.
8750: &Apache::lonhtmlcommon::row_closure().
8751: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
8752: $srchbysel.
8753: $srchtypesel.
8754: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
8755: $srchinsel.
8756: &Apache::lonhtmlcommon::row_closure(1).
8757: &Apache::lonhtmlcommon::end_pick_box().
8758: '<br />';
1.555 raeburn 8759: return $output;
8760: }
8761:
1.612 raeburn 8762: sub user_rule_check {
1.615 raeburn 8763: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 8764: my $response;
8765: if (ref($usershash) eq 'HASH') {
8766: foreach my $user (keys(%{$usershash})) {
8767: my ($uname,$udom) = split(/:/,$user);
8768: next if ($udom eq '' || $uname eq '');
1.615 raeburn 8769: my ($id,$newuser);
1.612 raeburn 8770: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 8771: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 8772: $id = $usershash->{$user}->{'id'};
8773: }
8774: my $inst_response;
8775: if (ref($checks) eq 'HASH') {
8776: if (defined($checks->{'username'})) {
1.615 raeburn 8777: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 8778: &Apache::lonnet::get_instuser($udom,$uname);
8779: } elsif (defined($checks->{'id'})) {
1.615 raeburn 8780: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 8781: &Apache::lonnet::get_instuser($udom,undef,$id);
8782: }
1.615 raeburn 8783: } else {
8784: ($inst_response,%{$inst_results->{$user}}) =
8785: &Apache::lonnet::get_instuser($udom,$uname);
8786: return;
1.612 raeburn 8787: }
1.615 raeburn 8788: if (!$got_rules->{$udom}) {
1.612 raeburn 8789: my %domconfig = &Apache::lonnet::get_dom('configuration',
8790: ['usercreation'],$udom);
8791: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 8792: foreach my $item ('username','id') {
1.612 raeburn 8793: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
8794: $$curr_rules{$udom}{$item} =
8795: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 8796: }
8797: }
8798: }
1.615 raeburn 8799: $got_rules->{$udom} = 1;
1.585 raeburn 8800: }
1.612 raeburn 8801: foreach my $item (keys(%{$checks})) {
8802: if (ref($$curr_rules{$udom}) eq 'HASH') {
8803: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
8804: if (@{$$curr_rules{$udom}{$item}} > 0) {
8805: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
8806: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
8807: if ($rule_check{$rule}) {
8808: $$rulematch{$user}{$item} = $rule;
8809: if ($inst_response eq 'ok') {
1.615 raeburn 8810: if (ref($inst_results) eq 'HASH') {
8811: if (ref($inst_results->{$user}) eq 'HASH') {
8812: if (keys(%{$inst_results->{$user}}) == 0) {
8813: $$alerts{$item}{$udom}{$uname} = 1;
8814: }
1.612 raeburn 8815: }
8816: }
1.615 raeburn 8817: }
8818: last;
1.585 raeburn 8819: }
8820: }
8821: }
8822: }
8823: }
8824: }
8825: }
8826: }
1.612 raeburn 8827: return;
8828: }
8829:
8830: sub user_rule_formats {
8831: my ($domain,$domdesc,$curr_rules,$check) = @_;
8832: my %text = (
8833: 'username' => 'Usernames',
8834: 'id' => 'IDs',
8835: );
8836: my $output;
8837: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
8838: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
8839: if (@{$ruleorder} > 0) {
8840: $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>';
8841: foreach my $rule (@{$ruleorder}) {
8842: if (ref($curr_rules) eq 'ARRAY') {
8843: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
8844: if (ref($rules->{$rule}) eq 'HASH') {
8845: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
8846: $rules->{$rule}{'desc'}.'</li>';
8847: }
8848: }
8849: }
8850: }
8851: $output .= '</ul>';
8852: }
8853: }
8854: return $output;
8855: }
8856:
8857: sub instrule_disallow_msg {
1.615 raeburn 8858: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 8859: my $response;
8860: my %text = (
8861: item => 'username',
8862: items => 'usernames',
8863: match => 'matches',
8864: do => 'does',
8865: action => 'a username',
8866: one => 'one',
8867: );
8868: if ($count > 1) {
8869: $text{'item'} = 'usernames';
8870: $text{'match'} ='match';
8871: $text{'do'} = 'do';
8872: $text{'action'} = 'usernames',
8873: $text{'one'} = 'ones';
8874: }
8875: if ($checkitem eq 'id') {
8876: $text{'items'} = 'IDs';
8877: $text{'item'} = 'ID';
8878: $text{'action'} = 'an ID';
1.615 raeburn 8879: if ($count > 1) {
8880: $text{'item'} = 'IDs';
8881: $text{'action'} = 'IDs';
8882: }
1.612 raeburn 8883: }
1.674 bisitz 8884: $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 8885: if ($mode eq 'upload') {
8886: if ($checkitem eq 'username') {
8887: $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'}.");
8888: } elsif ($checkitem eq 'id') {
1.674 bisitz 8889: $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 8890: }
1.669 raeburn 8891: } elsif ($mode eq 'selfcreate') {
8892: if ($checkitem eq 'id') {
8893: $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.");
8894: }
1.615 raeburn 8895: } else {
8896: if ($checkitem eq 'username') {
8897: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
8898: } elsif ($checkitem eq 'id') {
8899: $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.");
8900: }
1.612 raeburn 8901: }
8902: return $response;
1.585 raeburn 8903: }
8904:
1.624 raeburn 8905: sub personal_data_fieldtitles {
8906: my %fieldtitles = &Apache::lonlocal::texthash (
8907: id => 'Student/Employee ID',
8908: permanentemail => 'E-mail address',
8909: lastname => 'Last Name',
8910: firstname => 'First Name',
8911: middlename => 'Middle Name',
8912: generation => 'Generation',
8913: gen => 'Generation',
1.765 raeburn 8914: inststatus => 'Affiliation',
1.624 raeburn 8915: );
8916: return %fieldtitles;
8917: }
8918:
1.642 raeburn 8919: sub sorted_inst_types {
8920: my ($dom) = @_;
8921: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
8922: my $othertitle = &mt('All users');
8923: if ($env{'request.course.id'}) {
1.668 raeburn 8924: $othertitle = &mt('Any users');
1.642 raeburn 8925: }
8926: my @types;
8927: if (ref($order) eq 'ARRAY') {
8928: @types = @{$order};
8929: }
8930: if (@types == 0) {
8931: if (ref($usertypes) eq 'HASH') {
8932: @types = sort(keys(%{$usertypes}));
8933: }
8934: }
8935: if (keys(%{$usertypes}) > 0) {
8936: $othertitle = &mt('Other users');
8937: }
8938: return ($othertitle,$usertypes,\@types);
8939: }
8940:
1.645 raeburn 8941: sub get_institutional_codes {
8942: my ($settings,$allcourses,$LC_code) = @_;
8943: # Get complete list of course sections to update
8944: my @currsections = ();
8945: my @currxlists = ();
8946: my $coursecode = $$settings{'internal.coursecode'};
8947:
8948: if ($$settings{'internal.sectionnums'} ne '') {
8949: @currsections = split(/,/,$$settings{'internal.sectionnums'});
8950: }
8951:
8952: if ($$settings{'internal.crosslistings'} ne '') {
8953: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
8954: }
8955:
8956: if (@currxlists > 0) {
8957: foreach (@currxlists) {
8958: if (m/^([^:]+):(\w*)$/) {
8959: unless (grep/^$1$/,@{$allcourses}) {
8960: push @{$allcourses},$1;
8961: $$LC_code{$1} = $2;
8962: }
8963: }
8964: }
8965: }
8966:
8967: if (@currsections > 0) {
8968: foreach (@currsections) {
8969: if (m/^(\w+):(\w*)$/) {
8970: my $sec = $coursecode.$1;
8971: my $lc_sec = $2;
8972: unless (grep/^$sec$/,@{$allcourses}) {
8973: push @{$allcourses},$sec;
8974: $$LC_code{$sec} = $lc_sec;
8975: }
8976: }
8977: }
8978: }
8979: return;
8980: }
8981:
1.971 raeburn 8982: sub get_standard_codeitems {
8983: return ('Year','Semester','Department','Number','Section');
8984: }
8985:
1.112 bowersj2 8986: =pod
8987:
1.780 raeburn 8988: =head1 Slot Helpers
8989:
8990: =over 4
8991:
8992: =item * sorted_slots()
8993:
1.1040 raeburn 8994: Sorts an array of slot names in order of an optional sort key,
8995: default sort is by slot start time (earliest first).
1.780 raeburn 8996:
8997: Inputs:
8998:
8999: =over 4
9000:
9001: slotsarr - Reference to array of unsorted slot names.
9002:
9003: slots - Reference to hash of hash, where outer hash keys are slot names.
9004:
1.1040 raeburn 9005: sortkey - Name of key in inner hash to be sorted on (e.g., starttime).
9006:
1.549 albertel 9007: =back
9008:
1.780 raeburn 9009: Returns:
9010:
9011: =over 4
9012:
1.1040 raeburn 9013: sorted - An array of slot names sorted by a specified sort key
9014: (default sort key is start time of the slot).
1.780 raeburn 9015:
9016: =back
9017:
9018: =cut
9019:
9020:
9021: sub sorted_slots {
1.1040 raeburn 9022: my ($slotsarr,$slots,$sortkey) = @_;
9023: if ($sortkey eq '') {
9024: $sortkey = 'starttime';
9025: }
1.780 raeburn 9026: my @sorted;
9027: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
9028: @sorted =
9029: sort {
9030: if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040 raeburn 9031: return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780 raeburn 9032: }
9033: if (ref($slots->{$a})) { return -1;}
9034: if (ref($slots->{$b})) { return 1;}
9035: return 0;
9036: } @{$slotsarr};
9037: }
9038: return @sorted;
9039: }
9040:
1.1040 raeburn 9041: =pod
9042:
9043: =item * get_future_slots()
9044:
9045: Inputs:
9046:
9047: =over 4
9048:
9049: cnum - course number
9050:
9051: cdom - course domain
9052:
9053: now - current UNIX time
9054:
9055: symb - optional symb
9056:
9057: =back
9058:
9059: Returns:
9060:
9061: =over 4
9062:
9063: sorted_reservable - ref to array of student_schedulable slots currently
9064: reservable, ordered by end date of reservation period.
9065:
9066: reservable_now - ref to hash of student_schedulable slots currently
9067: reservable.
9068:
9069: Keys in inner hash are:
9070: (a) symb: either blank or symb to which slot use is restricted.
9071: (b) endreserve: end date of reservation period.
9072:
9073: sorted_future - ref to array of student_schedulable slots reservable in
9074: the future, ordered by start date of reservation period.
9075:
9076: future_reservable - ref to hash of student_schedulable slots reservable
9077: in the future.
9078:
9079: Keys in inner hash are:
9080: (a) symb: either blank or symb to which slot use is restricted.
9081: (b) startreserve: start date of reservation period.
9082:
9083: =back
9084:
9085: =cut
9086:
9087: sub get_future_slots {
9088: my ($cnum,$cdom,$now,$symb) = @_;
9089: my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
9090: my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
9091: foreach my $slot (keys(%slots)) {
9092: next unless($slots{$slot}->{'type'} eq 'schedulable_student');
9093: if ($symb) {
9094: next if (($slots{$slot}->{'symb'} ne '') &&
9095: ($slots{$slot}->{'symb'} ne $symb));
9096: }
9097: if (($slots{$slot}->{'starttime'} > $now) &&
9098: ($slots{$slot}->{'endtime'} > $now)) {
9099: if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
9100: my $userallowed = 0;
9101: if ($slots{$slot}->{'allowedsections'}) {
9102: my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
9103: if (!defined($env{'request.role.sec'})
9104: && grep(/^No section assigned$/,@allowed_sec)) {
9105: $userallowed=1;
9106: } else {
9107: if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
9108: $userallowed=1;
9109: }
9110: }
9111: unless ($userallowed) {
9112: if (defined($env{'request.course.groups'})) {
9113: my @groups = split(/:/,$env{'request.course.groups'});
9114: foreach my $group (@groups) {
9115: if (grep(/^\Q$group\E$/,@allowed_sec)) {
9116: $userallowed=1;
9117: last;
9118: }
9119: }
9120: }
9121: }
9122: }
9123: if ($slots{$slot}->{'allowedusers'}) {
9124: my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
9125: my $user = $env{'user.name'}.':'.$env{'user.domain'};
9126: if (grep(/^\Q$user\E$/,@allowed_users)) {
9127: $userallowed = 1;
9128: }
9129: }
9130: next unless($userallowed);
9131: }
9132: my $startreserve = $slots{$slot}->{'startreserve'};
9133: my $endreserve = $slots{$slot}->{'endreserve'};
9134: my $symb = $slots{$slot}->{'symb'};
9135: if (($startreserve < $now) &&
9136: (!$endreserve || $endreserve > $now)) {
9137: my $lastres = $endreserve;
9138: if (!$lastres) {
9139: $lastres = $slots{$slot}->{'starttime'};
9140: }
9141: $reservable_now{$slot} = {
9142: symb => $symb,
9143: endreserve => $lastres
9144: };
9145: } elsif (($startreserve > $now) &&
9146: (!$endreserve || $endreserve > $startreserve)) {
9147: $future_reservable{$slot} = {
9148: symb => $symb,
9149: startreserve => $startreserve
9150: };
9151: }
9152: }
9153: }
9154: my @unsorted_reservable = keys(%reservable_now);
9155: if (@unsorted_reservable > 0) {
9156: @sorted_reservable =
9157: &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
9158: }
9159: my @unsorted_future = keys(%future_reservable);
9160: if (@unsorted_future > 0) {
9161: @sorted_future =
9162: &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
9163: }
9164: return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
9165: }
1.780 raeburn 9166:
9167: =pod
9168:
1.1057 foxr 9169: =back
9170:
1.549 albertel 9171: =head1 HTTP Helpers
9172:
9173: =over 4
9174:
1.648 raeburn 9175: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 9176:
1.258 albertel 9177: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 9178: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 9179: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 9180:
9181: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
9182: $possible_names is an ref to an array of form element names. As an example:
9183: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 9184: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 9185:
9186: =cut
1.1 albertel 9187:
1.6 albertel 9188: sub get_unprocessed_cgi {
1.25 albertel 9189: my ($query,$possible_names)= @_;
1.26 matthew 9190: # $Apache::lonxml::debug=1;
1.356 albertel 9191: foreach my $pair (split(/&/,$query)) {
9192: my ($name, $value) = split(/=/,$pair);
1.369 www 9193: $name = &unescape($name);
1.25 albertel 9194: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
9195: $value =~ tr/+/ /;
9196: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 9197: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 9198: }
1.16 harris41 9199: }
1.6 albertel 9200: }
9201:
1.112 bowersj2 9202: =pod
9203:
1.648 raeburn 9204: =item * &cacheheader()
1.112 bowersj2 9205:
9206: returns cache-controlling header code
9207:
9208: =cut
9209:
1.7 albertel 9210: sub cacheheader {
1.258 albertel 9211: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 9212: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
9213: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 9214: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
9215: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 9216: return $output;
1.7 albertel 9217: }
9218:
1.112 bowersj2 9219: =pod
9220:
1.648 raeburn 9221: =item * &no_cache($r)
1.112 bowersj2 9222:
9223: specifies header code to not have cache
9224:
9225: =cut
9226:
1.9 albertel 9227: sub no_cache {
1.216 albertel 9228: my ($r) = @_;
9229: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 9230: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 9231: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
9232: $r->no_cache(1);
9233: $r->header_out("Expires" => $date);
9234: $r->header_out("Pragma" => "no-cache");
1.123 www 9235: }
9236:
9237: sub content_type {
1.181 albertel 9238: my ($r,$type,$charset) = @_;
1.299 foxr 9239: if ($r) {
9240: # Note that printout.pl calls this with undef for $r.
9241: &no_cache($r);
9242: }
1.258 albertel 9243: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 9244: unless ($charset) {
9245: $charset=&Apache::lonlocal::current_encoding;
9246: }
9247: if ($charset) { $type.='; charset='.$charset; }
9248: if ($r) {
9249: $r->content_type($type);
9250: } else {
9251: print("Content-type: $type\n\n");
9252: }
1.9 albertel 9253: }
1.25 albertel 9254:
1.112 bowersj2 9255: =pod
9256:
1.648 raeburn 9257: =item * &add_to_env($name,$value)
1.112 bowersj2 9258:
1.258 albertel 9259: adds $name to the %env hash with value
1.112 bowersj2 9260: $value, if $name already exists, the entry is converted to an array
9261: reference and $value is added to the array.
9262:
9263: =cut
9264:
1.25 albertel 9265: sub add_to_env {
9266: my ($name,$value)=@_;
1.258 albertel 9267: if (defined($env{$name})) {
9268: if (ref($env{$name})) {
1.25 albertel 9269: #already have multiple values
1.258 albertel 9270: push(@{ $env{$name} },$value);
1.25 albertel 9271: } else {
9272: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 9273: my $first=$env{$name};
9274: undef($env{$name});
9275: push(@{ $env{$name} },$first,$value);
1.25 albertel 9276: }
9277: } else {
1.258 albertel 9278: $env{$name}=$value;
1.25 albertel 9279: }
1.31 albertel 9280: }
1.149 albertel 9281:
9282: =pod
9283:
1.648 raeburn 9284: =item * &get_env_multiple($name)
1.149 albertel 9285:
1.258 albertel 9286: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 9287: values may be defined and end up as an array ref.
9288:
9289: returns an array of values
9290:
9291: =cut
9292:
9293: sub get_env_multiple {
9294: my ($name) = @_;
9295: my @values;
1.258 albertel 9296: if (defined($env{$name})) {
1.149 albertel 9297: # exists is it an array
1.258 albertel 9298: if (ref($env{$name})) {
9299: @values=@{ $env{$name} };
1.149 albertel 9300: } else {
1.258 albertel 9301: $values[0]=$env{$name};
1.149 albertel 9302: }
9303: }
9304: return(@values);
9305: }
9306:
1.660 raeburn 9307: sub ask_for_embedded_content {
9308: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071 raeburn 9309: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
9310: %currsubfile,%unused);
9311: my $counter = 0;
9312: my $numnew = 0;
1.987 raeburn 9313: my $numremref = 0;
9314: my $numinvalid = 0;
9315: my $numpathchg = 0;
9316: my $numexisting = 0;
1.1071 raeburn 9317: my $numunused = 0;
9318: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
9319: $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path);
9320: my $heading = &mt('Upload embedded files');
9321: my $buttontext = &mt('Upload');
9322:
1.984 raeburn 9323: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
9324: my $current_path='/';
9325: if ($env{'form.currentpath'}) {
9326: $current_path = $env{'form.currentpath'};
9327: }
9328: if ($actionurl eq '/adm/coursegrp_portfolio') {
9329: $udom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9330: $uname = $env{'course.'.$env{'request.course.id'}.'.num'};
9331: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
9332: } else {
9333: $udom = $env{'user.domain'};
9334: $uname = $env{'user.name'};
9335: $url = '/userfiles/portfolio';
9336: }
1.987 raeburn 9337: $toplevel = $url.'/';
1.984 raeburn 9338: $url .= $current_path;
9339: $getpropath = 1;
1.987 raeburn 9340: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
9341: ($actionurl eq '/adm/imsimport')) {
1.1022 www 9342: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026 raeburn 9343: $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987 raeburn 9344: $toplevel = $url;
1.984 raeburn 9345: if ($rest ne '') {
1.987 raeburn 9346: $url .= $rest;
9347: }
9348: } elsif ($actionurl eq '/adm/coursedocs') {
9349: if (ref($args) eq 'HASH') {
1.1071 raeburn 9350: $url = $args->{'docs_url'};
9351: $toplevel = $url;
9352: }
9353: } elsif ($actionurl eq '/adm/dependencies') {
9354: if ($env{'request.course.id'} ne '') {
9355: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9356: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
9357: if (ref($args) eq 'HASH') {
9358: $url = $args->{'docs_url'};
9359: $title = $args->{'docs_title'};
9360: $toplevel = "/$url";
9361: ($path) =
9362: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
9363: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
9364: $fileloc =~ s{^/}{};
9365: ($filename) = ($fileloc =~ m{.+/([^/]+)$});
9366: $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
9367: }
1.987 raeburn 9368: }
9369: }
9370: my $now = time();
9371: foreach my $embed_file (keys(%{$allfiles})) {
9372: my $absolutepath;
9373: if ($embed_file =~ m{^\w+://}) {
9374: $newfiles{$embed_file} = 1;
9375: $mapping{$embed_file} = $embed_file;
9376: } else {
9377: if ($embed_file =~ m{^/}) {
9378: $absolutepath = $embed_file;
9379: $embed_file =~ s{^(/+)}{};
9380: }
9381: if ($embed_file =~ m{/}) {
9382: my ($path,$fname) = ($embed_file =~ m{^(.+)/([^/]*)$});
9383: $path = &check_for_traversal($path,$url,$toplevel);
9384: my $item = $fname;
9385: if ($path ne '') {
9386: $item = $path.'/'.$fname;
9387: $subdependencies{$path}{$fname} = 1;
9388: } else {
9389: $dependencies{$item} = 1;
9390: }
9391: if ($absolutepath) {
9392: $mapping{$item} = $absolutepath;
9393: } else {
9394: $mapping{$item} = $embed_file;
9395: }
9396: } else {
9397: $dependencies{$embed_file} = 1;
9398: if ($absolutepath) {
9399: $mapping{$embed_file} = $absolutepath;
9400: } else {
9401: $mapping{$embed_file} = $embed_file;
9402: }
9403: }
1.984 raeburn 9404: }
9405: }
1.1071 raeburn 9406: my $dirptr = 16384;
1.984 raeburn 9407: foreach my $path (keys(%subdependencies)) {
1.1071 raeburn 9408: $currsubfile{$path} = {};
1.984 raeburn 9409: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 9410: my ($sublistref,$listerror) =
9411: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
9412: if (ref($sublistref) eq 'ARRAY') {
9413: foreach my $line (@{$sublistref}) {
9414: my ($file_name,$rest) = split(/\&/,$line,2);
1.1071 raeburn 9415: $currsubfile{$path}{$file_name} = 1;
1.1021 raeburn 9416: }
1.984 raeburn 9417: }
1.987 raeburn 9418: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 9419: if (opendir(my $dir,$url.'/'.$path)) {
9420: my @subdir_list = grep(!/^\./,readdir($dir));
1.1071 raeburn 9421: map {$currsubfile{$path}{$_} = 1;} @subdir_list;
9422: }
9423: } elsif ($actionurl eq '/adm/dependencies') {
9424: if ($env{'request.course.id'} ne '') {
9425: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
9426: if ($dir ne '') {
9427: my ($sublistref,$listerror) =
9428: &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
9429: if (ref($sublistref) eq 'ARRAY') {
9430: foreach my $line (@{$sublistref}) {
9431: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
9432: undef,$mtime)=split(/\&/,$line,12);
9433: unless (($testdir&$dirptr) ||
9434: ($file_name =~ /^\.\.?$/)) {
9435: $currsubfile{$path}{$file_name} = [$size,$mtime];
9436: }
9437: }
9438: }
9439: }
1.984 raeburn 9440: }
9441: }
9442: foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071 raeburn 9443: if (exists($currsubfile{$path}{$file})) {
1.987 raeburn 9444: my $item = $path.'/'.$file;
9445: unless ($mapping{$item} eq $item) {
9446: $pathchanges{$item} = 1;
9447: }
9448: $existing{$item} = 1;
9449: $numexisting ++;
9450: } else {
9451: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 9452: }
9453: }
1.1071 raeburn 9454: if ($actionurl eq '/adm/dependencies') {
9455: foreach my $path (keys(%currsubfile)) {
9456: if (ref($currsubfile{$path}) eq 'HASH') {
9457: foreach my $file (keys(%{$currsubfile{$path}})) {
9458: unless ($subdependencies{$path}{$file}) {
9459: $unused{$path.'/'.$file} = 1;
9460: }
9461: }
9462: }
9463: }
9464: }
1.984 raeburn 9465: }
1.987 raeburn 9466: my %currfile;
1.984 raeburn 9467: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 9468: my ($dirlistref,$listerror) =
9469: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
9470: if (ref($dirlistref) eq 'ARRAY') {
9471: foreach my $line (@{$dirlistref}) {
9472: my ($file_name,$rest) = split(/\&/,$line,2);
9473: $currfile{$file_name} = 1;
9474: }
1.984 raeburn 9475: }
1.987 raeburn 9476: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 9477: if (opendir(my $dir,$url)) {
1.987 raeburn 9478: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 9479: map {$currfile{$_} = 1;} @dir_list;
9480: }
1.1071 raeburn 9481: } elsif ($actionurl eq '/adm/dependencies') {
9482: if ($env{'request.course.id'} ne '') {
9483: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
9484: if ($dir ne '') {
9485: my ($dirlistref,$listerror) =
9486: &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
9487: if (ref($dirlistref) eq 'ARRAY') {
9488: foreach my $line (@{$dirlistref}) {
9489: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
9490: $size,undef,$mtime)=split(/\&/,$line,12);
9491: unless (($testdir&$dirptr) ||
9492: ($file_name =~ /^\.\.?$/)) {
9493: $currfile{$file_name} = [$size,$mtime];
9494: }
9495: }
9496: }
9497: }
9498: }
1.984 raeburn 9499: }
9500: foreach my $file (keys(%dependencies)) {
1.1071 raeburn 9501: if (exists($currfile{$file})) {
1.987 raeburn 9502: unless ($mapping{$file} eq $file) {
9503: $pathchanges{$file} = 1;
9504: }
9505: $existing{$file} = 1;
9506: $numexisting ++;
9507: } else {
1.984 raeburn 9508: $newfiles{$file} = 1;
9509: }
9510: }
1.1071 raeburn 9511: foreach my $file (keys(%currfile)) {
9512: unless (($file eq $filename) ||
9513: ($file eq $filename.'.bak') ||
9514: ($dependencies{$file})) {
9515: $unused{$file} = 1;
9516: }
9517: }
1.984 raeburn 9518: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071 raeburn 9519: if ($actionurl eq '/adm/dependencies') {
9520: next if ($embed_file =~ m{^\w+://});
9521: }
1.660 raeburn 9522: $upload_output .= &start_data_table_row().
1.1071 raeburn 9523: '<td><img src="'.&icon($embed_file).'" /> '.
9524: '<span class="LC_filename">'.$embed_file.'</span>';
1.987 raeburn 9525: unless ($mapping{$embed_file} eq $embed_file) {
9526: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.&mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
9527: }
9528: $upload_output .= '</td><td>';
1.1071 raeburn 9529: if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) {
1.660 raeburn 9530: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
1.987 raeburn 9531: $numremref++;
1.660 raeburn 9532: } elsif ($args->{'error_on_invalid_names'}
9533: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
9534:
1.987 raeburn 9535: $upload_output.='<span class="LC_warning">'.&mt('Invalid characters').'</span>';
9536: $numinvalid++;
1.660 raeburn 9537: } else {
1.1071 raeburn 9538: $upload_output .= &embedded_file_element('upload_embedded',$counter,
1.987 raeburn 9539: $embed_file,\%mapping,
1.1071 raeburn 9540: $allfiles,$codebase,'upload');
9541: $counter ++;
9542: $numnew ++;
1.987 raeburn 9543: }
9544: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
9545: }
9546: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071 raeburn 9547: if ($actionurl eq '/adm/dependencies') {
9548: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
9549: $modify_output .= &start_data_table_row().
9550: '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
9551: '<img src="'.&icon($embed_file).'" border="0" />'.
9552: ' <span class="LC_filename">'.$embed_file.'</span></a></td>'.
9553: '<td>'.$size.'</td>'.
9554: '<td>'.$mtime.'</td>'.
9555: '<td><label><input type="checkbox" name="mod_upload_dep" '.
9556: 'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
9557: $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
9558: '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
9559: &embedded_file_element('upload_embedded',$counter,
9560: $embed_file,\%mapping,
9561: $allfiles,$codebase,'modify').
9562: '</div></td>'.
9563: &end_data_table_row()."\n";
9564: $counter ++;
9565: } else {
9566: $upload_output .= &start_data_table_row().
9567: '<td><span class="LC_filename">'.$embed_file.'</span></td>';
9568: '<td><span class="LC_warning">'.&mt('Already exists').'</span></td>'.
9569: &Apache::loncommon::end_data_table_row()."\n";
9570: }
9571: }
9572: my $delidx = $counter;
9573: foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
9574: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
9575: $delete_output .= &start_data_table_row().
9576: '<td><img src="'.&icon($oldfile).'" />'.
9577: ' <span class="LC_filename">'.$oldfile.'</span></td>'.
9578: '<td>'.$size.'</td>'.
9579: '<td>'.$mtime.'</td>'.
9580: '<td><label><input type="checkbox" name="del_upload_dep" '.
9581: ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
9582: &embedded_file_element('upload_embedded',$delidx,
9583: $oldfile,\%mapping,$allfiles,
9584: $codebase,'delete').'</td>'.
9585: &end_data_table_row()."\n";
9586: $numunused ++;
9587: $delidx ++;
1.987 raeburn 9588: }
9589: if ($upload_output) {
9590: $upload_output = &start_data_table().
9591: $upload_output.
9592: &end_data_table()."\n";
9593: }
1.1071 raeburn 9594: if ($modify_output) {
9595: $modify_output = &start_data_table().
9596: &start_data_table_header_row().
9597: '<th>'.&mt('File').'</th>'.
9598: '<th>'.&mt('Size (KB)').'</th>'.
9599: '<th>'.&mt('Modified').'</th>'.
9600: '<th>'.&mt('Upload replacement?').'</th>'.
9601: &end_data_table_header_row().
9602: $modify_output.
9603: &end_data_table()."\n";
9604: }
9605: if ($delete_output) {
9606: $delete_output = &start_data_table().
9607: &start_data_table_header_row().
9608: '<th>'.&mt('File').'</th>'.
9609: '<th>'.&mt('Size (KB)').'</th>'.
9610: '<th>'.&mt('Modified').'</th>'.
9611: '<th>'.&mt('Delete?').'</th>'.
9612: &end_data_table_header_row().
9613: $delete_output.
9614: &end_data_table()."\n";
9615: }
1.987 raeburn 9616: my $applies = 0;
9617: if ($numremref) {
9618: $applies ++;
9619: }
9620: if ($numinvalid) {
9621: $applies ++;
9622: }
9623: if ($numexisting) {
9624: $applies ++;
9625: }
1.1071 raeburn 9626: if ($counter || $numunused) {
1.987 raeburn 9627: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
9628: ' method="post" enctype="multipart/form-data">'."\n".
1.1071 raeburn 9629: $state.'<h3>'.$heading.'</h3>';
9630: if ($actionurl eq '/adm/dependencies') {
9631: if ($numnew) {
9632: $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
9633: '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
9634: $upload_output.'<br />'."\n";
9635: }
9636: if ($numexisting) {
9637: $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
9638: '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
9639: $modify_output.'<br />'."\n";
9640: $buttontext = &mt('Save changes');
9641: }
9642: if ($numunused) {
9643: $output .= '<h4>'.&mt('Unused files').'</h4>'.
9644: '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
9645: $delete_output.'<br />'."\n";
9646: $buttontext = &mt('Save changes');
9647: }
9648: } else {
9649: $output .= $upload_output.'<br />'."\n";
9650: }
9651: $output .= '<input type ="hidden" name="number_embedded_items" value="'.
9652: $counter.'" />'."\n";
9653: if ($actionurl eq '/adm/dependencies') {
9654: $output .= '<input type ="hidden" name="number_newemb_items" value="'.
9655: $numnew.'" />'."\n";
9656: } elsif ($actionurl eq '') {
1.987 raeburn 9657: $output .= '<input type="hidden" name="phase" value="three" />';
9658: }
9659: } elsif ($applies) {
9660: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
9661: if ($applies > 1) {
9662: $output .=
9663: &mt('No files need to be uploaded, as one of the following applies to each reference:').'<ul>';
9664: if ($numremref) {
9665: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
9666: }
9667: if ($numinvalid) {
9668: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
9669: }
9670: if ($numexisting) {
9671: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
9672: }
9673: $output .= '</ul><br />';
9674: } elsif ($numremref) {
9675: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
9676: } elsif ($numinvalid) {
9677: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
9678: } elsif ($numexisting) {
9679: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
9680: }
9681: $output .= $upload_output.'<br />';
9682: }
9683: my ($pathchange_output,$chgcount);
1.1071 raeburn 9684: $chgcount = $counter;
1.987 raeburn 9685: if (keys(%pathchanges) > 0) {
9686: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071 raeburn 9687: if ($counter) {
1.987 raeburn 9688: $output .= &embedded_file_element('pathchange',$chgcount,
9689: $embed_file,\%mapping,
1.1071 raeburn 9690: $allfiles,$codebase,'change');
1.987 raeburn 9691: } else {
9692: $pathchange_output .=
9693: &start_data_table_row().
9694: '<td><input type ="checkbox" name="namechange" value="'.
9695: $chgcount.'" checked="checked" /></td>'.
9696: '<td>'.$mapping{$embed_file}.'</td>'.
9697: '<td>'.$embed_file.
9698: &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071 raeburn 9699: \%mapping,$allfiles,$codebase,'change').
1.987 raeburn 9700: '</td>'.&end_data_table_row();
1.660 raeburn 9701: }
1.987 raeburn 9702: $numpathchg ++;
9703: $chgcount ++;
1.660 raeburn 9704: }
9705: }
1.1071 raeburn 9706: if ($counter) {
1.987 raeburn 9707: if ($numpathchg) {
9708: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
9709: $numpathchg.'" />'."\n";
9710: }
9711: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
9712: ($actionurl eq '/adm/imsimport')) {
9713: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
9714: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
9715: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071 raeburn 9716: } elsif ($actionurl eq '/adm/dependencies') {
9717: $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987 raeburn 9718: }
1.1071 raeburn 9719: $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987 raeburn 9720: } elsif ($numpathchg) {
9721: my %pathchange = ();
9722: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
9723: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
9724: $output .= '<p>'.&mt('or').'</p>';
9725: }
9726: }
1.1071 raeburn 9727: return ($output,$counter,$numpathchg);
1.987 raeburn 9728: }
9729:
9730: sub embedded_file_element {
1.1071 raeburn 9731: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987 raeburn 9732: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
9733: (ref($codebase) eq 'HASH'));
9734: my $output;
1.1071 raeburn 9735: if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987 raeburn 9736: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
9737: }
9738: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
9739: &escape($embed_file).'" />';
9740: unless (($context eq 'upload_embedded') &&
9741: ($mapping->{$embed_file} eq $embed_file)) {
9742: $output .='
9743: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
9744: }
9745: my $attrib;
9746: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
9747: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
9748: }
9749: $output .=
9750: "\n\t\t".
9751: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
9752: $attrib.'" />';
9753: if (exists($codebase->{$mapping->{$embed_file}})) {
9754: $output .=
9755: "\n\t\t".
9756: '<input name="codebase_'.$num.'" type="hidden" value="'.
9757: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 9758: }
1.987 raeburn 9759: return $output;
1.660 raeburn 9760: }
9761:
1.1071 raeburn 9762: sub get_dependency_details {
9763: my ($currfile,$currsubfile,$embed_file) = @_;
9764: my ($size,$mtime,$showsize,$showmtime);
9765: if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
9766: if ($embed_file =~ m{/}) {
9767: my ($path,$fname) = split(/\//,$embed_file);
9768: if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
9769: ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
9770: }
9771: } else {
9772: if (ref($currfile->{$embed_file}) eq 'ARRAY') {
9773: ($size,$mtime) = @{$currfile->{$embed_file}};
9774: }
9775: }
9776: $showsize = $size/1024.0;
9777: $showsize = sprintf("%.1f",$showsize);
9778: if ($mtime > 0) {
9779: $showmtime = &Apache::lonlocal::locallocaltime($mtime);
9780: }
9781: }
9782: return ($showsize,$showmtime);
9783: }
9784:
9785: sub ask_embedded_js {
9786: return <<"END";
9787: <script type="text/javascript"">
9788: // <![CDATA[
9789: function toggleBrowse(counter) {
9790: var chkboxid = document.getElementById('mod_upload_dep_'+counter);
9791: var fileid = document.getElementById('embedded_item_'+counter);
9792: var uploaddivid = document.getElementById('moduploaddep_'+counter);
9793: if (chkboxid.checked == true) {
9794: uploaddivid.style.display='block';
9795: } else {
9796: uploaddivid.style.display='none';
9797: fileid.value = '';
9798: }
9799: }
9800: // ]]>
9801: </script>
9802:
9803: END
9804: }
9805:
1.661 raeburn 9806: sub upload_embedded {
9807: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 9808: $current_disk_usage,$hiddenstate,$actionurl) = @_;
9809: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 9810: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
9811: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
9812: my $orig_uploaded_filename =
9813: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 9814: foreach my $type ('orig','ref','attrib','codebase') {
9815: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
9816: $env{'form.embedded_'.$type.'_'.$i} =
9817: &unescape($env{'form.embedded_'.$type.'_'.$i});
9818: }
9819: }
1.661 raeburn 9820: my ($path,$fname) =
9821: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
9822: # no path, whole string is fname
9823: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
9824: $fname = &Apache::lonnet::clean_filename($fname);
9825: # See if there is anything left
9826: next if ($fname eq '');
9827:
9828: # Check if file already exists as a file or directory.
9829: my ($state,$msg);
9830: if ($context eq 'portfolio') {
9831: my $port_path = $dirpath;
9832: if ($group ne '') {
9833: $port_path = "groups/$group/$port_path";
9834: }
1.987 raeburn 9835: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
9836: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 9837: $dir_root,$port_path,$disk_quota,
9838: $current_disk_usage,$uname,$udom);
9839: if ($state eq 'will_exceed_quota'
1.984 raeburn 9840: || $state eq 'file_locked') {
1.661 raeburn 9841: $output .= $msg;
9842: next;
9843: }
9844: } elsif (($context eq 'author') || ($context eq 'testbank')) {
9845: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
9846: if ($state eq 'exists') {
9847: $output .= $msg;
9848: next;
9849: }
9850: }
9851: # Check if extension is valid
9852: if (($fname =~ /\.(\w+)$/) &&
9853: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.987 raeburn 9854: $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 9855: next;
9856: } elsif (($fname =~ /\.(\w+)$/) &&
9857: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 9858: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 9859: next;
9860: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.987 raeburn 9861: $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 9862: next;
9863: }
9864: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
9865: if ($context eq 'portfolio') {
1.984 raeburn 9866: my $result;
9867: if ($state eq 'existingfile') {
9868: $result=
9869: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.987 raeburn 9870: $dirpath.$env{'form.currentpath'}.$path);
1.661 raeburn 9871: } else {
1.984 raeburn 9872: $result=
9873: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 9874: $dirpath.
9875: $env{'form.currentpath'}.$path);
1.984 raeburn 9876: if ($result !~ m|^/uploaded/|) {
9877: $output .= '<span class="LC_error">'
9878: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
9879: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
9880: .'</span><br />';
9881: next;
9882: } else {
1.987 raeburn 9883: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
9884: $path.$fname.'</span>').'<br />';
1.984 raeburn 9885: }
1.661 raeburn 9886: }
1.987 raeburn 9887: } elsif ($context eq 'coursedoc') {
9888: my $result =
9889: &Apache::lonnet::userfileupload('embedded_item_'.$i,'coursedoc',
9890: $dirpath.'/'.$path);
9891: if ($result !~ m|^/uploaded/|) {
9892: $output .= '<span class="LC_error">'
9893: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
9894: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
9895: .'</span><br />';
9896: next;
9897: } else {
9898: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
9899: $path.$fname.'</span>').'<br />';
9900: }
1.661 raeburn 9901: } else {
9902: # Save the file
9903: my $target = $env{'form.embedded_item_'.$i};
9904: my $fullpath = $dir_root.$dirpath.'/'.$path;
9905: my $dest = $fullpath.$fname;
9906: my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027 raeburn 9907: my @parts=split(/\//,"$dirpath/$path");
1.661 raeburn 9908: my $count;
9909: my $filepath = $dir_root;
1.1027 raeburn 9910: foreach my $subdir (@parts) {
9911: $filepath .= "/$subdir";
9912: if (!-e $filepath) {
1.661 raeburn 9913: mkdir($filepath,0770);
9914: }
9915: }
9916: my $fh;
9917: if (!open($fh,'>'.$dest)) {
9918: &Apache::lonnet::logthis('Failed to create '.$dest);
9919: $output .= '<span class="LC_error">'.
1.1071 raeburn 9920: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
9921: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 9922: '</span><br />';
9923: } else {
9924: if (!print $fh $env{'form.embedded_item_'.$i}) {
9925: &Apache::lonnet::logthis('Failed to write to '.$dest);
9926: $output .= '<span class="LC_error">'.
1.1071 raeburn 9927: &mt('An error occurred while writing the file [_1] for embedded element [_2].',
9928: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 9929: '</span><br />';
9930: } else {
1.987 raeburn 9931: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
9932: $url.'</span>').'<br />';
9933: unless ($context eq 'testbank') {
9934: $footer .= &mt('View embedded file: [_1]',
9935: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
9936: }
9937: }
9938: close($fh);
9939: }
9940: }
9941: if ($env{'form.embedded_ref_'.$i}) {
9942: $pathchange{$i} = 1;
9943: }
9944: }
9945: if ($output) {
9946: $output = '<p>'.$output.'</p>';
9947: }
9948: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
9949: $returnflag = 'ok';
1.1071 raeburn 9950: my $numpathchgs = scalar(keys(%pathchange));
9951: if ($numpathchgs > 0) {
1.987 raeburn 9952: if ($context eq 'portfolio') {
9953: $output .= '<p>'.&mt('or').'</p>';
9954: } elsif ($context eq 'testbank') {
1.1071 raeburn 9955: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
9956: '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987 raeburn 9957: $returnflag = 'modify_orightml';
9958: }
9959: }
1.1071 raeburn 9960: return ($output.$footer,$returnflag,$numpathchgs);
1.987 raeburn 9961: }
9962:
9963: sub modify_html_form {
9964: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
9965: my $end = 0;
9966: my $modifyform;
9967: if ($context eq 'upload_embedded') {
9968: return unless (ref($pathchange) eq 'HASH');
9969: if ($env{'form.number_embedded_items'}) {
9970: $end += $env{'form.number_embedded_items'};
9971: }
9972: if ($env{'form.number_pathchange_items'}) {
9973: $end += $env{'form.number_pathchange_items'};
9974: }
9975: if ($end) {
9976: for (my $i=0; $i<$end; $i++) {
9977: if ($i < $env{'form.number_embedded_items'}) {
9978: next unless($pathchange->{$i});
9979: }
9980: $modifyform .=
9981: &start_data_table_row().
9982: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
9983: 'checked="checked" /></td>'.
9984: '<td>'.$env{'form.embedded_ref_'.$i}.
9985: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
9986: &escape($env{'form.embedded_ref_'.$i}).'" />'.
9987: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
9988: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
9989: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
9990: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
9991: '<td>'.$env{'form.embedded_orig_'.$i}.
9992: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
9993: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
9994: &end_data_table_row();
1.1071 raeburn 9995: }
1.987 raeburn 9996: }
9997: } else {
9998: $modifyform = $pathchgtable;
9999: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
10000: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
10001: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
10002: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
10003: }
10004: }
10005: if ($modifyform) {
1.1071 raeburn 10006: if ($actionurl eq '/adm/dependencies') {
10007: $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
10008: }
1.987 raeburn 10009: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
10010: '<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".
10011: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
10012: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
10013: '</ol></p>'."\n".'<p>'.
10014: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
10015: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
10016: &start_data_table()."\n".
10017: &start_data_table_header_row().
10018: '<th>'.&mt('Change?').'</th>'.
10019: '<th>'.&mt('Current reference').'</th>'.
10020: '<th>'.&mt('Required reference').'</th>'.
10021: &end_data_table_header_row()."\n".
10022: $modifyform.
10023: &end_data_table().'<br />'."\n".$hiddenstate.
10024: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
10025: '</form>'."\n";
10026: }
10027: return;
10028: }
10029:
10030: sub modify_html_refs {
10031: my ($context,$dirpath,$uname,$udom,$dir_root) = @_;
10032: my $container;
10033: if ($context eq 'portfolio') {
10034: $container = $env{'form.container'};
10035: } elsif ($context eq 'coursedoc') {
10036: $container = $env{'form.primaryurl'};
1.1071 raeburn 10037: } elsif ($context eq 'manage_dependencies') {
10038: (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
10039: $container = "/$container";
1.987 raeburn 10040: } else {
1.1027 raeburn 10041: $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987 raeburn 10042: }
10043: my (%allfiles,%codebase,$output,$content);
10044: my @changes = &get_env_multiple('form.namechange');
1.1071 raeburn 10045: unless (@changes > 0) {
10046: if (wantarray) {
10047: return ('',0,0);
10048: } else {
10049: return;
10050: }
10051: }
10052: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
10053: ($context eq 'manage_dependencies')) {
10054: unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
10055: if (wantarray) {
10056: return ('',0,0);
10057: } else {
10058: return;
10059: }
10060: }
1.987 raeburn 10061: $content = &Apache::lonnet::getfile($container);
1.1071 raeburn 10062: if ($content eq '-1') {
10063: if (wantarray) {
10064: return ('',0,0);
10065: } else {
10066: return;
10067: }
10068: }
1.987 raeburn 10069: } else {
1.1071 raeburn 10070: unless ($container =~ /^\Q$dir_root\E/) {
10071: if (wantarray) {
10072: return ('',0,0);
10073: } else {
10074: return;
10075: }
10076: }
1.987 raeburn 10077: if (open(my $fh,"<$container")) {
10078: $content = join('', <$fh>);
10079: close($fh);
10080: } else {
1.1071 raeburn 10081: if (wantarray) {
10082: return ('',0,0);
10083: } else {
10084: return;
10085: }
1.987 raeburn 10086: }
10087: }
10088: my ($count,$codebasecount) = (0,0);
10089: my $mm = new File::MMagic;
10090: my $mime_type = $mm->checktype_contents($content);
10091: if ($mime_type eq 'text/html') {
10092: my $parse_result =
10093: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
10094: \%codebase,\$content);
10095: if ($parse_result eq 'ok') {
10096: foreach my $i (@changes) {
10097: my $orig = &unescape($env{'form.embedded_orig_'.$i});
10098: my $ref = &unescape($env{'form.embedded_ref_'.$i});
10099: if ($allfiles{$ref}) {
10100: my $newname = $orig;
10101: my ($attrib_regexp,$codebase);
1.1006 raeburn 10102: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 10103: if ($attrib_regexp =~ /:/) {
10104: $attrib_regexp =~ s/\:/|/g;
10105: }
10106: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
10107: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
10108: $count += $numchg;
10109: }
10110: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 10111: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 10112: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
10113: $codebasecount ++;
10114: }
10115: }
10116: }
10117: if ($count || $codebasecount) {
10118: my $saveresult;
1.1071 raeburn 10119: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
10120: ($context eq 'manage_dependencies')) {
1.987 raeburn 10121: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
10122: if ($url eq $container) {
10123: my ($fname) = ($container =~ m{/([^/]+)$});
10124: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
10125: $count,'<span class="LC_filename">'.
1.1071 raeburn 10126: $fname.'</span>').'</p>';
1.987 raeburn 10127: } else {
10128: $output = '<p class="LC_error">'.
10129: &mt('Error: update failed for: [_1].',
10130: '<span class="LC_filename">'.
10131: $container.'</span>').'</p>';
10132: }
10133: } else {
10134: if (open(my $fh,">$container")) {
10135: print $fh $content;
10136: close($fh);
10137: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
10138: $count,'<span class="LC_filename">'.
10139: $container.'</span>').'</p>';
1.661 raeburn 10140: } else {
1.987 raeburn 10141: $output = '<p class="LC_error">'.
10142: &mt('Error: could not update [_1].',
10143: '<span class="LC_filename">'.
10144: $container.'</span>').'</p>';
1.661 raeburn 10145: }
10146: }
10147: }
1.987 raeburn 10148: } else {
10149: &logthis('Failed to parse '.$container.
10150: ' to modify references: '.$parse_result);
1.661 raeburn 10151: }
10152: }
1.1071 raeburn 10153: if (wantarray) {
10154: return ($output,$count,$codebasecount);
10155: } else {
10156: return $output;
10157: }
1.661 raeburn 10158: }
10159:
10160: sub check_for_existing {
10161: my ($path,$fname,$element) = @_;
10162: my ($state,$msg);
10163: if (-d $path.'/'.$fname) {
10164: $state = 'exists';
10165: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
10166: } elsif (-e $path.'/'.$fname) {
10167: $state = 'exists';
10168: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
10169: }
10170: if ($state eq 'exists') {
10171: $msg = '<span class="LC_error">'.$msg.'</span><br />';
10172: }
10173: return ($state,$msg);
10174: }
10175:
10176: sub check_for_upload {
10177: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
10178: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 10179: my $filesize = length($env{'form.'.$element});
10180: if (!$filesize) {
10181: my $msg = '<span class="LC_error">'.
10182: &mt('Unable to upload [_1]. (size = [_2] bytes)',
10183: '<span class="LC_filename">'.$fname.'</span>',
10184: $filesize).'<br />'.
1.1007 raeburn 10185: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 10186: '</span>';
10187: return ('zero_bytes',$msg);
10188: }
10189: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 10190: my $getpropath = 1;
1.1021 raeburn 10191: my ($dirlistref,$listerror) =
10192: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 10193: my $found_file = 0;
10194: my $locked_file = 0;
1.991 raeburn 10195: my @lockers;
10196: my $navmap;
10197: if ($env{'request.course.id'}) {
10198: $navmap = Apache::lonnavmaps::navmap->new();
10199: }
1.1021 raeburn 10200: if (ref($dirlistref) eq 'ARRAY') {
10201: foreach my $line (@{$dirlistref}) {
10202: my ($file_name,$rest)=split(/\&/,$line,2);
10203: if ($file_name eq $fname){
10204: $file_name = $path.$file_name;
10205: if ($group ne '') {
10206: $file_name = $group.$file_name;
10207: }
10208: $found_file = 1;
10209: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
10210: foreach my $lock (@lockers) {
10211: if (ref($lock) eq 'ARRAY') {
10212: my ($symb,$crsid) = @{$lock};
10213: if ($crsid eq $env{'request.course.id'}) {
10214: if (ref($navmap)) {
10215: my $res = $navmap->getBySymb($symb);
10216: foreach my $part (@{$res->parts()}) {
10217: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
10218: unless (($slot_status == $res->RESERVED) ||
10219: ($slot_status == $res->RESERVED_LOCATION)) {
10220: $locked_file = 1;
10221: }
1.991 raeburn 10222: }
1.1021 raeburn 10223: } else {
10224: $locked_file = 1;
1.991 raeburn 10225: }
10226: } else {
10227: $locked_file = 1;
10228: }
10229: }
1.1021 raeburn 10230: }
10231: } else {
10232: my @info = split(/\&/,$rest);
10233: my $currsize = $info[6]/1000;
10234: if ($currsize < $filesize) {
10235: my $extra = $filesize - $currsize;
10236: if (($current_disk_usage + $extra) > $disk_quota) {
10237: my $msg = '<span class="LC_error">'.
10238: &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.',
10239: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</span>'.
10240: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
10241: $disk_quota,$current_disk_usage);
10242: return ('will_exceed_quota',$msg);
10243: }
1.984 raeburn 10244: }
10245: }
1.661 raeburn 10246: }
10247: }
10248: }
10249: if (($current_disk_usage + $filesize) > $disk_quota){
10250: my $msg = '<span class="LC_error">'.
10251: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
10252: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
10253: return ('will_exceed_quota',$msg);
10254: } elsif ($found_file) {
10255: if ($locked_file) {
10256: my $msg = '<span class="LC_error">';
10257: $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>');
10258: $msg .= '</span><br />';
10259: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
10260: return ('file_locked',$msg);
10261: } else {
10262: my $msg = '<span class="LC_error">';
1.984 raeburn 10263: $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 10264: $msg .= '</span>';
1.984 raeburn 10265: return ('existingfile',$msg);
1.661 raeburn 10266: }
10267: }
10268: }
10269:
1.987 raeburn 10270: sub check_for_traversal {
10271: my ($path,$url,$toplevel) = @_;
10272: my @parts=split(/\//,$path);
10273: my $cleanpath;
10274: my $fullpath = $url;
10275: for (my $i=0;$i<@parts;$i++) {
10276: next if ($parts[$i] eq '.');
10277: if ($parts[$i] eq '..') {
10278: $fullpath =~ s{([^/]+/)$}{};
10279: } else {
10280: $fullpath .= $parts[$i].'/';
10281: }
10282: }
10283: if ($fullpath =~ /^\Q$url\E(.*)$/) {
10284: $cleanpath = $1;
10285: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
10286: my $curr_toprel = $1;
10287: my @parts = split(/\//,$curr_toprel);
10288: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
10289: my @urlparts = split(/\//,$url_toprel);
10290: my $doubledots;
10291: my $startdiff = -1;
10292: for (my $i=0; $i<@urlparts; $i++) {
10293: if ($startdiff == -1) {
10294: unless ($urlparts[$i] eq $parts[$i]) {
10295: $startdiff = $i;
10296: $doubledots .= '../';
10297: }
10298: } else {
10299: $doubledots .= '../';
10300: }
10301: }
10302: if ($startdiff > -1) {
10303: $cleanpath = $doubledots;
10304: for (my $i=$startdiff; $i<@parts; $i++) {
10305: $cleanpath .= $parts[$i].'/';
10306: }
10307: }
10308: }
10309: $cleanpath =~ s{(/)$}{};
10310: return $cleanpath;
10311: }
1.31 albertel 10312:
1.1053 raeburn 10313: sub is_archive_file {
10314: my ($mimetype) = @_;
10315: if (($mimetype eq 'application/octet-stream') ||
10316: ($mimetype eq 'application/x-stuffit') ||
10317: ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
10318: return 1;
10319: }
10320: return;
10321: }
10322:
10323: sub decompress_form {
1.1065 raeburn 10324: my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053 raeburn 10325: my %lt = &Apache::lonlocal::texthash (
10326: this => 'This file is an archive file.',
1.1067 raeburn 10327: camt => 'This file is a Camtasia archive file.',
1.1065 raeburn 10328: itsc => 'Its contents are as follows:',
1.1053 raeburn 10329: youm => 'You may wish to extract its contents.',
10330: extr => 'Extract contents',
1.1067 raeburn 10331: auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
10332: proa => 'Process automatically?',
1.1053 raeburn 10333: yes => 'Yes',
10334: no => 'No',
1.1067 raeburn 10335: fold => 'Title for folder containing movie',
10336: movi => 'Title for page containing embedded movie',
1.1053 raeburn 10337: );
1.1065 raeburn 10338: my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067 raeburn 10339: my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065 raeburn 10340: my $info = &list_archive_contents($fileloc,\@paths);
10341: if (@paths) {
10342: foreach my $path (@paths) {
10343: $path =~ s{^/}{};
1.1067 raeburn 10344: if ($path =~ m{^([^/]+)/$}) {
10345: $topdir = $1;
10346: }
1.1065 raeburn 10347: if ($path =~ m{^([^/]+)/}) {
10348: $toplevel{$1} = $path;
10349: } else {
10350: $toplevel{$path} = $path;
10351: }
10352: }
10353: }
1.1067 raeburn 10354: if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
10355: my @camtasia = ("$topdir/","$topdir/index.html",
10356: "$topdir/media/",
10357: "$topdir/media/$topdir.mp4",
10358: "$topdir/media/FirstFrame.png",
10359: "$topdir/media/player.swf",
10360: "$topdir/media/swfobject.js",
10361: "$topdir/media/expressInstall.swf");
10362: my @diffs = &compare_arrays(\@paths,\@camtasia);
10363: if (@diffs == 0) {
10364: $is_camtasia = 1;
10365: }
10366: }
10367: my $output;
10368: if ($is_camtasia) {
10369: $output = <<"ENDCAM";
10370: <script type="text/javascript" language="Javascript">
10371: // <![CDATA[
10372:
10373: function camtasiaToggle() {
10374: for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
10375: if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
10376: if (document.uploaded_decompress.autoextract_camtasia[i].value == 1) {
10377:
10378: document.getElementById('camtasia_titles').style.display='block';
10379: } else {
10380: document.getElementById('camtasia_titles').style.display='none';
10381: }
10382: }
10383: }
10384: return;
10385: }
10386:
10387: // ]]>
10388: </script>
10389: <p>$lt{'camt'}</p>
10390: ENDCAM
1.1065 raeburn 10391: } else {
1.1067 raeburn 10392: $output = '<p>'.$lt{'this'};
10393: if ($info eq '') {
10394: $output .= ' '.$lt{'youm'}.'</p>'."\n";
10395: } else {
10396: $output .= ' '.$lt{'itsc'}.'</p>'."\n".
10397: '<div><pre>'.$info.'</pre></div>';
10398: }
1.1065 raeburn 10399: }
1.1067 raeburn 10400: $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065 raeburn 10401: my $duplicates;
10402: my $num = 0;
10403: if (ref($dirlist) eq 'ARRAY') {
10404: foreach my $item (@{$dirlist}) {
10405: if (ref($item) eq 'ARRAY') {
10406: if (exists($toplevel{$item->[0]})) {
10407: $duplicates .=
10408: &start_data_table_row().
10409: '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
10410: 'value="0" checked="checked" />'.&mt('No').'</label>'.
10411: ' <label><input type="radio" name="archive_overwrite_'.$num.'" '.
10412: 'value="1" />'.&mt('Yes').'</label>'.
10413: '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
10414: '<td>'.$item->[0].'</td>';
10415: if ($item->[2]) {
10416: $duplicates .= '<td>'.&mt('Directory').'</td>';
10417: } else {
10418: $duplicates .= '<td>'.&mt('File').'</td>';
10419: }
10420: $duplicates .= '<td>'.$item->[3].'</td>'.
10421: '<td>'.
10422: &Apache::lonlocal::locallocaltime($item->[4]).
10423: '</td>'.
10424: &end_data_table_row();
10425: $num ++;
10426: }
10427: }
10428: }
10429: }
10430: my $itemcount;
10431: if (@paths > 0) {
10432: $itemcount = scalar(@paths);
10433: } else {
10434: $itemcount = 1;
10435: }
1.1067 raeburn 10436: if ($is_camtasia) {
10437: $output .= $lt{'auto'}.'<br />'.
10438: '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
10439: '<input type="radio" name="autoextract_camtasia" value="1" onclick="javascript:camtasiaToggle();" checked="checked" />'.
10440: $lt{'yes'}.'</label> <label>'.
10441: '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
10442: $lt{'no'}.'</label></span><br />'.
10443: '<div id="camtasia_titles" style="display:block">'.
10444: &Apache::lonhtmlcommon::start_pick_box().
10445: &Apache::lonhtmlcommon::row_title($lt{'fold'}).
10446: '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
10447: &Apache::lonhtmlcommon::row_closure().
10448: &Apache::lonhtmlcommon::row_title($lt{'movi'}).
10449: '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
10450: &Apache::lonhtmlcommon::row_closure(1).
10451: &Apache::lonhtmlcommon::end_pick_box().
10452: '</div>';
10453: }
1.1065 raeburn 10454: $output .=
10455: '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067 raeburn 10456: '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
10457: "\n";
1.1065 raeburn 10458: if ($duplicates ne '') {
10459: $output .= '<p><span class="LC_warning">'.
10460: &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.
10461: &start_data_table().
10462: &start_data_table_header_row().
10463: '<th>'.&mt('Overwrite?').'</th>'.
10464: '<th>'.&mt('Name').'</th>'.
10465: '<th>'.&mt('Type').'</th>'.
10466: '<th>'.&mt('Size').'</th>'.
10467: '<th>'.&mt('Last modified').'</th>'.
10468: &end_data_table_header_row().
10469: $duplicates.
10470: &end_data_table().
10471: '</p>';
10472: }
1.1067 raeburn 10473: $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053 raeburn 10474: if (ref($hiddenelements) eq 'HASH') {
10475: foreach my $hidden (sort(keys(%{$hiddenelements}))) {
10476: $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
10477: }
10478: }
10479: $output .= <<"END";
1.1067 raeburn 10480: <br />
1.1053 raeburn 10481: <input type="submit" name="decompress" value="$lt{'extr'}" />
10482: </form>
10483: $noextract
10484: END
10485: return $output;
10486: }
10487:
1.1065 raeburn 10488: sub decompression_utility {
10489: my ($program) = @_;
10490: my @utilities = ('tar','gunzip','bunzip2','unzip');
10491: my $location;
10492: if (grep(/^\Q$program\E$/,@utilities)) {
10493: foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
10494: '/usr/sbin/') {
10495: if (-x $dir.$program) {
10496: $location = $dir.$program;
10497: last;
10498: }
10499: }
10500: }
10501: return $location;
10502: }
10503:
10504: sub list_archive_contents {
10505: my ($file,$pathsref) = @_;
10506: my (@cmd,$output);
10507: my $needsregexp;
10508: if ($file =~ /\.zip$/) {
10509: @cmd = (&decompression_utility('unzip'),"-l");
10510: $needsregexp = 1;
10511: } elsif (($file =~ m/\.tar\.gz$/) ||
10512: ($file =~ /\.tgz$/)) {
10513: @cmd = (&decompression_utility('tar'),"-ztf");
10514: } elsif ($file =~ /\.tar\.bz2$/) {
10515: @cmd = (&decompression_utility('tar'),"-jtf");
10516: } elsif ($file =~ m|\.tar$|) {
10517: @cmd = (&decompression_utility('tar'),"-tf");
10518: }
10519: if (@cmd) {
10520: undef($!);
10521: undef($@);
10522: if (open(my $fh,"-|", @cmd, $file)) {
10523: while (my $line = <$fh>) {
10524: $output .= $line;
10525: chomp($line);
10526: my $item;
10527: if ($needsregexp) {
10528: ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/);
10529: } else {
10530: $item = $line;
10531: }
10532: if ($item ne '') {
10533: unless (grep(/^\Q$item\E$/,@{$pathsref})) {
10534: push(@{$pathsref},$item);
10535: }
10536: }
10537: }
10538: close($fh);
10539: }
10540: }
10541: return $output;
10542: }
10543:
1.1053 raeburn 10544: sub decompress_uploaded_file {
10545: my ($file,$dir) = @_;
10546: &Apache::lonnet::appenv({'cgi.file' => $file});
10547: &Apache::lonnet::appenv({'cgi.dir' => $dir});
10548: my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
10549: my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
10550: my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
10551: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
10552: my $decompressed = $env{'cgi.decompressed'};
10553: &Apache::lonnet::delenv('cgi.file');
10554: &Apache::lonnet::delenv('cgi.dir');
10555: &Apache::lonnet::delenv('cgi.decompressed');
10556: return ($decompressed,$result);
10557: }
10558:
1.1055 raeburn 10559: sub process_decompression {
10560: my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
10561: my ($dir,$error,$warning,$output);
10562: if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/) {
10563: $error = &mt('File name not a supported archive file type.').
10564: '<br />'.&mt('File name should end with one of: [_1].',
10565: '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
10566: } else {
10567: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
10568: if ($docuhome eq 'no_host') {
10569: $error = &mt('Could not determine home server for course.');
10570: } else {
10571: my @ids=&Apache::lonnet::current_machine_ids();
10572: my $currdir = "$dir_root/$destination";
10573: if (grep(/^\Q$docuhome\E$/,@ids)) {
10574: $dir = &LONCAPA::propath($docudom,$docuname).
10575: "$dir_root/$destination";
10576: } else {
10577: $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
10578: "$dir_root/$docudom/$docuname/$destination";
10579: unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
10580: $error = &mt('Archive file not found.');
10581: }
10582: }
1.1065 raeburn 10583: my (@to_overwrite,@to_skip);
10584: if ($env{'form.archive_overwrite_total'} > 0) {
10585: my $total = $env{'form.archive_overwrite_total'};
10586: for (my $i=0; $i<$total; $i++) {
10587: if ($env{'form.archive_overwrite_'.$i} == 1) {
10588: push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
10589: } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
10590: push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
10591: }
10592: }
10593: }
10594: my $numskip = scalar(@to_skip);
10595: if (($numskip > 0) &&
10596: ($numskip == $env{'form.archive_itemcount'})) {
10597: $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');
10598: } elsif ($dir eq '') {
1.1055 raeburn 10599: $error = &mt('Directory containing archive file unavailable.');
10600: } elsif (!$error) {
1.1065 raeburn 10601: my ($decompressed,$display);
10602: if ($numskip > 0) {
10603: my $tempdir = time.'_'.$$.int(rand(10000));
10604: mkdir("$dir/$tempdir",0755);
10605: system("mv $dir/$file $dir/$tempdir/$file");
10606: ($decompressed,$display) =
10607: &decompress_uploaded_file($file,"$dir/$tempdir");
10608: foreach my $item (@to_skip) {
10609: if (($item ne '') && ($item !~ /\.\./)) {
10610: if (-f "$dir/$tempdir/$item") {
10611: unlink("$dir/$tempdir/$item");
10612: } elsif (-d "$dir/$tempdir/$item") {
10613: system("rm -rf $dir/$tempdir/$item");
10614: }
10615: }
10616: }
10617: system("mv $dir/$tempdir/* $dir");
10618: rmdir("$dir/$tempdir");
10619: } else {
10620: ($decompressed,$display) =
10621: &decompress_uploaded_file($file,$dir);
10622: }
1.1055 raeburn 10623: if ($decompressed eq 'ok') {
1.1065 raeburn 10624: $output = '<p class="LC_info">'.
10625: &mt('Files extracted successfully from archive.').
10626: '</p>'."\n";
1.1055 raeburn 10627: my ($warning,$result,@contents);
10628: my ($newdirlistref,$newlisterror) =
10629: &Apache::lonnet::dirlist($currdir,$docudom,
10630: $docuname,1);
10631: my (%is_dir,%changes,@newitems);
10632: my $dirptr = 16384;
1.1065 raeburn 10633: if (ref($newdirlistref) eq 'ARRAY') {
1.1055 raeburn 10634: foreach my $dir_line (@{$newdirlistref}) {
10635: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1065 raeburn 10636: unless (($item =~ /^\.+$/) || ($item eq $file) ||
10637: ((@to_skip > 0) && (grep(/^\Q$item\E$/,@to_skip)))) {
1.1055 raeburn 10638: push(@newitems,$item);
10639: if ($dirptr&$testdir) {
10640: $is_dir{$item} = 1;
10641: }
10642: $changes{$item} = 1;
10643: }
10644: }
10645: }
10646: if (keys(%changes) > 0) {
10647: foreach my $item (sort(@newitems)) {
10648: if ($changes{$item}) {
10649: push(@contents,$item);
10650: }
10651: }
10652: }
10653: if (@contents > 0) {
1.1067 raeburn 10654: my $wantform;
10655: unless ($env{'form.autoextract_camtasia'}) {
10656: $wantform = 1;
10657: }
1.1056 raeburn 10658: my (%children,%parent,%dirorder,%titles);
1.1055 raeburn 10659: my ($count,$datatable) = &get_extracted($docudom,$docuname,
10660: $currdir,\%is_dir,
10661: \%children,\%parent,
1.1056 raeburn 10662: \@contents,\%dirorder,
10663: \%titles,$wantform);
1.1055 raeburn 10664: if ($datatable ne '') {
10665: $output .= &archive_options_form('decompressed',$datatable,
10666: $count,$hiddenelem);
1.1065 raeburn 10667: my $startcount = 6;
1.1055 raeburn 10668: $output .= &archive_javascript($startcount,$count,
1.1056 raeburn 10669: \%titles,\%children);
1.1055 raeburn 10670: }
1.1067 raeburn 10671: if ($env{'form.autoextract_camtasia'}) {
10672: my %displayed;
10673: my $total = 1;
10674: $env{'form.archive_directory'} = [];
10675: foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
10676: my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
10677: $path =~ s{/$}{};
10678: my $item;
10679: if ($path ne '') {
10680: $item = "$path/$titles{$i}";
10681: } else {
10682: $item = $titles{$i};
10683: }
10684: $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
10685: if ($item eq $contents[0]) {
10686: push(@{$env{'form.archive_directory'}},$i);
10687: $env{'form.archive_'.$i} = 'display';
10688: $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
10689: $displayed{'folder'} = $i;
10690: } elsif ($item eq "$contents[0]/index.html") {
10691: $env{'form.archive_'.$i} = 'display';
10692: $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
10693: $displayed{'web'} = $i;
10694: } else {
10695: if ($item eq "$contents[0]/media") {
10696: push(@{$env{'form.archive_directory'}},$i);
10697: }
10698: $env{'form.archive_'.$i} = 'dependency';
10699: }
10700: $total ++;
10701: }
10702: for (my $i=1; $i<$total; $i++) {
10703: next if ($i == $displayed{'web'});
10704: next if ($i == $displayed{'folder'});
10705: $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
10706: }
10707: $env{'form.phase'} = 'decompress_cleanup';
10708: $env{'form.archivedelete'} = 1;
10709: $env{'form.archive_count'} = $total-1;
10710: $output .=
10711: &process_extracted_files('coursedocs',$docudom,
10712: $docuname,$destination,
10713: $dir_root,$hiddenelem);
10714: }
1.1055 raeburn 10715: } else {
10716: $warning = &mt('No new items extracted from archive file.');
10717: }
10718: } else {
10719: $output = $display;
10720: $error = &mt('An error occurred during extraction from the archive file.');
10721: }
10722: }
10723: }
10724: }
10725: if ($error) {
10726: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
10727: $error.'</p>'."\n";
10728: }
10729: if ($warning) {
10730: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
10731: }
10732: return $output;
10733: }
10734:
10735: sub get_extracted {
1.1056 raeburn 10736: my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
10737: $titles,$wantform) = @_;
1.1055 raeburn 10738: my $count = 0;
10739: my $depth = 0;
10740: my $datatable;
1.1056 raeburn 10741: my @hierarchy;
1.1055 raeburn 10742: return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056 raeburn 10743: (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
10744: (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055 raeburn 10745: foreach my $item (@{$contents}) {
10746: $count ++;
1.1056 raeburn 10747: @{$dirorder->{$count}} = @hierarchy;
10748: $titles->{$count} = $item;
1.1055 raeburn 10749: &archive_hierarchy($depth,$count,$parent,$children);
10750: if ($wantform) {
10751: $datatable .= &archive_row($is_dir->{$item},$item,
10752: $currdir,$depth,$count);
10753: }
10754: if ($is_dir->{$item}) {
10755: $depth ++;
1.1056 raeburn 10756: push(@hierarchy,$count);
10757: $parent->{$depth} = $count;
1.1055 raeburn 10758: $datatable .=
10759: &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056 raeburn 10760: \$depth,\$count,\@hierarchy,$dirorder,
10761: $children,$parent,$titles,$wantform);
1.1055 raeburn 10762: $depth --;
1.1056 raeburn 10763: pop(@hierarchy);
1.1055 raeburn 10764: }
10765: }
10766: return ($count,$datatable);
10767: }
10768:
10769: sub recurse_extracted_archive {
1.1056 raeburn 10770: my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
10771: $children,$parent,$titles,$wantform) = @_;
1.1055 raeburn 10772: my $result='';
1.1056 raeburn 10773: unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
10774: (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
10775: (ref($dirorder) eq 'HASH')) {
1.1055 raeburn 10776: return $result;
10777: }
10778: my $dirptr = 16384;
10779: my ($newdirlistref,$newlisterror) =
10780: &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
10781: if (ref($newdirlistref) eq 'ARRAY') {
10782: foreach my $dir_line (@{$newdirlistref}) {
10783: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
10784: unless ($item =~ /^\.+$/) {
10785: $$count ++;
1.1056 raeburn 10786: @{$dirorder->{$$count}} = @{$hierarchy};
10787: $titles->{$$count} = $item;
1.1055 raeburn 10788: &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056 raeburn 10789:
1.1055 raeburn 10790: my $is_dir;
10791: if ($dirptr&$testdir) {
10792: $is_dir = 1;
10793: }
10794: if ($wantform) {
10795: $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
10796: }
10797: if ($is_dir) {
10798: $$depth ++;
1.1056 raeburn 10799: push(@{$hierarchy},$$count);
10800: $parent->{$$depth} = $$count;
1.1055 raeburn 10801: $result .=
10802: &recurse_extracted_archive("$currdir/$item",$docudom,
10803: $docuname,$depth,$count,
1.1056 raeburn 10804: $hierarchy,$dirorder,$children,
10805: $parent,$titles,$wantform);
1.1055 raeburn 10806: $$depth --;
1.1056 raeburn 10807: pop(@{$hierarchy});
1.1055 raeburn 10808: }
10809: }
10810: }
10811: }
10812: return $result;
10813: }
10814:
10815: sub archive_hierarchy {
10816: my ($depth,$count,$parent,$children) =@_;
10817: if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
10818: if (exists($parent->{$depth})) {
10819: $children->{$parent->{$depth}} .= $count.':';
10820: }
10821: }
10822: return;
10823: }
10824:
10825: sub archive_row {
10826: my ($is_dir,$item,$currdir,$depth,$count) = @_;
10827: my ($name) = ($item =~ m{([^/]+)$});
10828: my %choices = &Apache::lonlocal::texthash (
1.1059 raeburn 10829: 'display' => 'Add as file',
1.1055 raeburn 10830: 'dependency' => 'Include as dependency',
10831: 'discard' => 'Discard',
10832: );
10833: if ($is_dir) {
1.1059 raeburn 10834: $choices{'display'} = &mt('Add as folder');
1.1055 raeburn 10835: }
1.1056 raeburn 10836: my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
10837: my $offset = 0;
1.1055 raeburn 10838: foreach my $action ('display','dependency','discard') {
1.1056 raeburn 10839: $offset ++;
1.1065 raeburn 10840: if ($action ne 'display') {
10841: $offset ++;
10842: }
1.1055 raeburn 10843: $output .= '<td><span class="LC_nobreak">'.
10844: '<label><input type="radio" name="archive_'.$count.
10845: '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
10846: my $text = $choices{$action};
10847: if ($is_dir) {
10848: $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
10849: if ($action eq 'display') {
1.1059 raeburn 10850: $text = &mt('Add as folder');
1.1055 raeburn 10851: }
1.1056 raeburn 10852: } else {
10853: $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
10854:
10855: }
10856: $output .= ' /> '.$choices{$action}.'</label></span>';
10857: if ($action eq 'dependency') {
10858: $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
10859: &mt('Used by:').' <select name="archive_dependent_on_'.$count.'" '.
10860: 'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
10861: '<option value=""></option>'."\n".
10862: '</select>'."\n".
10863: '</div>';
1.1059 raeburn 10864: } elsif ($action eq 'display') {
10865: $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
10866: &mt('Title:').' <input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
10867: '</div>';
1.1055 raeburn 10868: }
1.1056 raeburn 10869: $output .= '</td>';
1.1055 raeburn 10870: }
10871: $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
10872: &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.(' ' x 2);
10873: for (my $i=0; $i<$depth; $i++) {
10874: $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
10875: }
10876: if ($is_dir) {
10877: $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" /> '."\n".
10878: '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
10879: } else {
10880: $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
10881: }
10882: $output .= ' '.$name.'</td>'."\n".
10883: &end_data_table_row();
10884: return $output;
10885: }
10886:
10887: sub archive_options_form {
1.1065 raeburn 10888: my ($form,$display,$count,$hiddenelem) = @_;
10889: my %lt = &Apache::lonlocal::texthash(
10890: perm => 'Permanently remove archive file?',
10891: hows => 'How should each extracted item be incorporated in the course?',
10892: cont => 'Content actions for all',
10893: addf => 'Add as folder/file',
10894: incd => 'Include as dependency for a displayed file',
10895: disc => 'Discard',
10896: no => 'No',
10897: yes => 'Yes',
10898: save => 'Save',
10899: );
10900: my $output = <<"END";
10901: <form name="$form" method="post" action="">
10902: <p><span class="LC_nobreak">$lt{'perm'}
10903: <label>
10904: <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
10905: </label>
10906:
10907: <label>
10908: <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
10909: </span>
10910: </p>
10911: <input type="hidden" name="phase" value="decompress_cleanup" />
10912: <br />$lt{'hows'}
10913: <div class="LC_columnSection">
10914: <fieldset>
10915: <legend>$lt{'cont'}</legend>
10916: <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" />
10917: <input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
10918: <input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
10919: </fieldset>
10920: </div>
10921: END
10922: return $output.
1.1055 raeburn 10923: &start_data_table()."\n".
1.1065 raeburn 10924: $display."\n".
1.1055 raeburn 10925: &end_data_table()."\n".
10926: '<input type="hidden" name="archive_count" value="'.$count.'" />'.
10927: $hiddenelem.
1.1065 raeburn 10928: '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055 raeburn 10929: '</form>';
10930: }
10931:
10932: sub archive_javascript {
1.1056 raeburn 10933: my ($startcount,$numitems,$titles,$children) = @_;
10934: return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059 raeburn 10935: my $maintitle = $env{'form.comment'};
1.1055 raeburn 10936: my $scripttag = <<START;
10937: <script type="text/javascript">
10938: // <![CDATA[
10939:
10940: function checkAll(form,prefix) {
10941: var idstr = new RegExp("^archive_"+prefix+"_\\\\d+\$");
10942: for (var i=0; i < form.elements.length; i++) {
10943: var id = form.elements[i].id;
10944: if ((id != '') && (id != undefined)) {
10945: if (idstr.test(id)) {
10946: if (form.elements[i].type == 'radio') {
10947: form.elements[i].checked = true;
1.1056 raeburn 10948: var nostart = i-$startcount;
1.1059 raeburn 10949: var offset = nostart%7;
10950: var count = (nostart-offset)/7;
1.1056 raeburn 10951: dependencyCheck(form,count,offset);
1.1055 raeburn 10952: }
10953: }
10954: }
10955: }
10956: }
10957:
10958: function propagateCheck(form,count) {
10959: if (count > 0) {
1.1059 raeburn 10960: var startelement = $startcount + ((count-1) * 7);
10961: for (var j=1; j<6; j++) {
10962: if ((j != 2) && (j != 4)) {
1.1056 raeburn 10963: var item = startelement + j;
10964: if (form.elements[item].type == 'radio') {
10965: if (form.elements[item].checked) {
10966: containerCheck(form,count,j);
10967: break;
10968: }
1.1055 raeburn 10969: }
10970: }
10971: }
10972: }
10973: }
10974:
10975: numitems = $numitems
1.1056 raeburn 10976: var titles = new Array(numitems);
10977: var parents = new Array(numitems);
1.1055 raeburn 10978: for (var i=0; i<numitems; i++) {
1.1056 raeburn 10979: parents[i] = new Array;
1.1055 raeburn 10980: }
1.1059 raeburn 10981: var maintitle = '$maintitle';
1.1055 raeburn 10982:
10983: START
10984:
1.1056 raeburn 10985: foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
10986: my @contents = split(/:/,$children->{$container});
1.1055 raeburn 10987: for (my $i=0; $i<@contents; $i ++) {
10988: $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
10989: }
10990: }
10991:
1.1056 raeburn 10992: foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
10993: $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
10994: }
10995:
1.1055 raeburn 10996: $scripttag .= <<END;
10997:
10998: function containerCheck(form,count,offset) {
10999: if (count > 0) {
1.1056 raeburn 11000: dependencyCheck(form,count,offset);
1.1059 raeburn 11001: var item = (offset+$startcount)+7*(count-1);
1.1055 raeburn 11002: form.elements[item].checked = true;
11003: if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
11004: if (parents[count].length > 0) {
11005: for (var j=0; j<parents[count].length; j++) {
1.1056 raeburn 11006: containerCheck(form,parents[count][j],offset);
11007: }
11008: }
11009: }
11010: }
11011: }
11012:
11013: function dependencyCheck(form,count,offset) {
11014: if (count > 0) {
1.1059 raeburn 11015: var chosen = (offset+$startcount)+7*(count-1);
11016: var depitem = $startcount + ((count-1) * 7) + 4;
1.1056 raeburn 11017: var currtype = form.elements[depitem].type;
11018: if (form.elements[chosen].value == 'dependency') {
11019: document.getElementById('arc_depon_'+count).style.display='block';
11020: form.elements[depitem].options.length = 0;
11021: form.elements[depitem].options[0] = new Option('Select','',true,true);
11022: for (var i=1; i<count; i++) {
1.1059 raeburn 11023: var startelement = $startcount + (i-1) * 7;
11024: for (var j=1; j<6; j++) {
11025: if ((j != 2) && (j!= 4)) {
1.1056 raeburn 11026: var item = startelement + j;
11027: if (form.elements[item].type == 'radio') {
11028: if (form.elements[item].checked) {
11029: if (form.elements[item].value == 'display') {
11030: var n = form.elements[depitem].options.length;
11031: form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
11032: }
11033: }
11034: }
11035: }
11036: }
11037: }
11038: } else {
11039: document.getElementById('arc_depon_'+count).style.display='none';
11040: form.elements[depitem].options.length = 0;
11041: form.elements[depitem].options[0] = new Option('Select','',true,true);
11042: }
1.1059 raeburn 11043: titleCheck(form,count,offset);
1.1056 raeburn 11044: }
11045: }
11046:
11047: function propagateSelect(form,count,offset) {
11048: if (count > 0) {
1.1065 raeburn 11049: var item = (1+offset+$startcount)+7*(count-1);
1.1056 raeburn 11050: var picked = form.elements[item].options[form.elements[item].selectedIndex].value;
11051: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
11052: if (parents[count].length > 0) {
11053: for (var j=0; j<parents[count].length; j++) {
11054: containerSelect(form,parents[count][j],offset,picked);
1.1055 raeburn 11055: }
11056: }
11057: }
11058: }
11059: }
1.1056 raeburn 11060:
11061: function containerSelect(form,count,offset,picked) {
11062: if (count > 0) {
1.1065 raeburn 11063: var item = (offset+$startcount)+7*(count-1);
1.1056 raeburn 11064: if (form.elements[item].type == 'radio') {
11065: if (form.elements[item].value == 'dependency') {
11066: if (form.elements[item+1].type == 'select-one') {
11067: for (var i=0; i<form.elements[item+1].options.length; i++) {
11068: if (form.elements[item+1].options[i].value == picked) {
11069: form.elements[item+1].selectedIndex = i;
11070: break;
11071: }
11072: }
11073: }
11074: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
11075: if (parents[count].length > 0) {
11076: for (var j=0; j<parents[count].length; j++) {
11077: containerSelect(form,parents[count][j],offset,picked);
11078: }
11079: }
11080: }
11081: }
11082: }
11083: }
11084: }
11085:
1.1059 raeburn 11086: function titleCheck(form,count,offset) {
11087: if (count > 0) {
11088: var chosen = (offset+$startcount)+7*(count-1);
11089: var depitem = $startcount + ((count-1) * 7) + 2;
11090: var currtype = form.elements[depitem].type;
11091: if (form.elements[chosen].value == 'display') {
11092: document.getElementById('arc_title_'+count).style.display='block';
11093: if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
11094: document.getElementById('archive_title_'+count).value=maintitle;
11095: }
11096: } else {
11097: document.getElementById('arc_title_'+count).style.display='none';
11098: if (currtype == 'text') {
11099: document.getElementById('archive_title_'+count).value='';
11100: }
11101: }
11102: }
11103: return;
11104: }
11105:
1.1055 raeburn 11106: // ]]>
11107: </script>
11108: END
11109: return $scripttag;
11110: }
11111:
11112: sub process_extracted_files {
1.1067 raeburn 11113: my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055 raeburn 11114: my $numitems = $env{'form.archive_count'};
11115: return unless ($numitems);
11116: my @ids=&Apache::lonnet::current_machine_ids();
11117: my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067 raeburn 11118: %folders,%containers,%mapinner,%prompttofetch);
1.1055 raeburn 11119: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
11120: if (grep(/^\Q$docuhome\E$/,@ids)) {
11121: $prefix = &LONCAPA::propath($docudom,$docuname);
11122: $pathtocheck = "$dir_root/$destination";
11123: $dir = $dir_root;
11124: $ishome = 1;
11125: } else {
11126: $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
11127: $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
11128: $dir = "$dir_root/$docudom/$docuname";
11129: }
11130: my $currdir = "$dir_root/$destination";
11131: (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
11132: if ($env{'form.folderpath'}) {
11133: my @items = split('&',$env{'form.folderpath'});
11134: $folders{'0'} = $items[-2];
11135: $containers{'0'}='sequence';
11136: } elsif ($env{'form.pagepath'}) {
11137: my @items = split('&',$env{'form.pagepath'});
11138: $folders{'0'} = $items[-2];
11139: $containers{'0'}='page';
11140: }
11141: my @archdirs = &get_env_multiple('form.archive_directory');
11142: if ($numitems) {
11143: for (my $i=1; $i<=$numitems; $i++) {
11144: my $path = $env{'form.archive_content_'.$i};
11145: if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
11146: my $item = $1;
11147: $toplevelitems{$item} = $i;
11148: if (grep(/^\Q$i\E$/,@archdirs)) {
11149: $is_dir{$item} = 1;
11150: }
11151: }
11152: }
11153: }
1.1067 raeburn 11154: my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055 raeburn 11155: if (keys(%toplevelitems) > 0) {
11156: my @contents = sort(keys(%toplevelitems));
1.1056 raeburn 11157: (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
11158: \%parent,\@contents,\%dirorder,\%titles);
1.1055 raeburn 11159: }
1.1066 raeburn 11160: my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055 raeburn 11161: if ($numitems) {
11162: for (my $i=1; $i<=$numitems; $i++) {
11163: my $path = $env{'form.archive_content_'.$i};
11164: if ($path =~ /^\Q$pathtocheck\E/) {
11165: if ($env{'form.archive_'.$i} eq 'discard') {
11166: if ($prefix ne '' && $path ne '') {
11167: if (-e $prefix.$path) {
1.1066 raeburn 11168: if ((@archdirs > 0) &&
11169: (grep(/^\Q$i\E$/,@archdirs))) {
11170: $todeletedir{$prefix.$path} = 1;
11171: } else {
11172: $todelete{$prefix.$path} = 1;
11173: }
1.1055 raeburn 11174: }
11175: }
11176: } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059 raeburn 11177: my ($docstitle,$title,$url,$outer);
1.1055 raeburn 11178: ($title) = ($path =~ m{/([^/]+)$});
1.1059 raeburn 11179: $docstitle = $env{'form.archive_title_'.$i};
11180: if ($docstitle eq '') {
11181: $docstitle = $title;
11182: }
1.1055 raeburn 11183: $outer = 0;
1.1056 raeburn 11184: if (ref($dirorder{$i}) eq 'ARRAY') {
11185: if (@{$dirorder{$i}} > 0) {
11186: foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055 raeburn 11187: if ($env{'form.archive_'.$item} eq 'display') {
11188: $outer = $item;
11189: last;
11190: }
11191: }
11192: }
11193: }
11194: my ($errtext,$fatal) =
11195: &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
11196: '/'.$folders{$outer}.'.'.
11197: $containers{$outer});
11198: next if ($fatal);
11199: if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
11200: if ($context eq 'coursedocs') {
1.1056 raeburn 11201: $mapinner{$i} = time;
1.1055 raeburn 11202: $folders{$i} = 'default_'.$mapinner{$i};
11203: $containers{$i} = 'sequence';
11204: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
11205: $folders{$i}.'.'.$containers{$i};
11206: my $newidx = &LONCAPA::map::getresidx();
11207: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 11208: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 11209: push(@LONCAPA::map::order,$newidx);
11210: my ($outtext,$errtext) =
11211: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
11212: $docuname.'/'.$folders{$outer}.
11213: '.'.$containers{$outer},1);
1.1056 raeburn 11214: $newseqid{$i} = $newidx;
1.1067 raeburn 11215: unless ($errtext) {
11216: $result .= '<li>'.&mt('Folder: [_1] added to course',$docstitle).'</li>'."\n";
11217: }
1.1055 raeburn 11218: }
11219: } else {
11220: if ($context eq 'coursedocs') {
11221: my $newidx=&LONCAPA::map::getresidx();
11222: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
11223: $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
11224: $title;
11225: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
11226: mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
11227: }
11228: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
11229: mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
11230: }
11231: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
11232: system("mv $prefix$path $prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title");
1.1056 raeburn 11233: $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
1.1067 raeburn 11234: unless ($ishome) {
11235: my $fetch = "$newdest{$i}/$title";
11236: $fetch =~ s/^\Q$prefix$dir\E//;
11237: $prompttofetch{$fetch} = 1;
11238: }
1.1055 raeburn 11239: }
11240: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 11241: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 11242: push(@LONCAPA::map::order, $newidx);
11243: my ($outtext,$errtext)=
11244: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
11245: $docuname.'/'.$folders{$outer}.
11246: '.'.$containers{$outer},1);
1.1067 raeburn 11247: unless ($errtext) {
11248: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
11249: $result .= '<li>'.&mt('File: [_1] added to course',$docstitle).'</li>'."\n";
11250: }
11251: }
1.1055 raeburn 11252: }
11253: }
11254: } elsif ($env{'form.archive_'.$i} eq 'dependency') {
1.1056 raeburn 11255: my ($title) = ($path =~ m{/([^/]+)$});
11256: $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
11257: if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
11258: if (ref($dirorder{$i}) eq 'ARRAY') {
1.1067 raeburn 11259: my ($itemidx,$fullpath,$relpath);
1.1056 raeburn 11260: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
11261: if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
11262: my $container = $dirorder{$referrer{$i}}->[-1];
11263: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
11264: if ($dirorder{$i}->[$j] eq $container) {
11265: $itemidx = $j;
11266: }
11267: }
11268: }
11269: }
11270: if ($itemidx ne '') {
11271: if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
11272: if ($mapinner{$referrer{$i}}) {
11273: $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
11274: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
11275: if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
11276: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
11277: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
1.1067 raeburn 11278: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
1.1056 raeburn 11279: if (!-e $fullpath) {
11280: mkdir($fullpath,0755);
11281: }
11282: }
11283: } else {
11284: last;
11285: }
11286: }
11287: }
11288: } elsif ($newdest{$referrer{$i}}) {
11289: $fullpath = $newdest{$referrer{$i}};
11290: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
11291: if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
11292: $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
11293: last;
11294: } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
11295: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
11296: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
1.1067 raeburn 11297: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
1.1056 raeburn 11298: if (!-e $fullpath) {
11299: mkdir($fullpath,0755);
11300: }
11301: }
11302: } else {
11303: last;
11304: }
11305: }
11306: }
11307: if ($fullpath ne '') {
1.1067 raeburn 11308: if (-e "$prefix$path") {
11309: system("mv $prefix$path $fullpath/$title");
11310: }
11311: if (-e "$fullpath/$title") {
11312: my $showpath;
11313: if ($relpath ne '') {
11314: $showpath = "$relpath/$title";
11315: } else {
11316: $showpath = "/$title";
11317: }
11318: $result .= '<li>'.&mt('[_1] included as a dependency',$showpath).'</li>'."\n";
11319: }
11320: unless ($ishome) {
11321: my $fetch = "$fullpath/$title";
11322: $fetch =~ s/^\Q$prefix$dir\E//;
11323: $prompttofetch{$fetch} = 1;
11324: }
1.1056 raeburn 11325: }
1.1055 raeburn 11326: }
11327: }
1.1056 raeburn 11328: } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
11329: $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
11330: $path,$env{'form.archive_content_'.$referrer{$i}}).'<br />';
1.1055 raeburn 11331: }
11332: }
11333: } else {
11334: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',$path).'<br />';
11335: }
11336: }
11337: if (keys(%todelete)) {
11338: foreach my $key (keys(%todelete)) {
11339: unlink($key);
1.1066 raeburn 11340: }
11341: }
11342: if (keys(%todeletedir)) {
11343: foreach my $key (keys(%todeletedir)) {
11344: rmdir($key);
11345: }
11346: }
11347: foreach my $dir (sort(keys(%is_dir))) {
11348: if (($pathtocheck ne '') && ($dir ne '')) {
11349: &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055 raeburn 11350: }
11351: }
1.1067 raeburn 11352: if ($result ne '') {
11353: $output .= '<ul>'."\n".
11354: $result."\n".
11355: '</ul>';
11356: }
11357: unless ($ishome) {
11358: my $replicationfail;
11359: foreach my $item (keys(%prompttofetch)) {
11360: my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
11361: unless ($fetchresult eq 'ok') {
11362: $replicationfail .= '<li>'.$item.'</li>'."\n";
11363: }
11364: }
11365: if ($replicationfail) {
11366: $output .= '<p class="LC_error">'.
11367: &mt('Course home server failed to retrieve:').'<ul>'.
11368: $replicationfail.
11369: '</ul></p>';
11370: }
11371: }
1.1055 raeburn 11372: } else {
11373: $warning = &mt('No items found in archive.');
11374: }
11375: if ($error) {
11376: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
11377: $error.'</p>'."\n";
11378: }
11379: if ($warning) {
11380: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
11381: }
11382: return $output;
11383: }
11384:
1.1066 raeburn 11385: sub cleanup_empty_dirs {
11386: my ($path) = @_;
11387: if (($path ne '') && (-d $path)) {
11388: if (opendir(my $dirh,$path)) {
11389: my @dircontents = grep(!/^\./,readdir($dirh));
11390: my $numitems = 0;
11391: foreach my $item (@dircontents) {
11392: if (-d "$path/$item") {
11393: &recurse_dirs("$path/$item");
11394: if (-e "$path/$item") {
11395: $numitems ++;
11396: }
11397: } else {
11398: $numitems ++;
11399: }
11400: }
11401: if ($numitems == 0) {
11402: rmdir($path);
11403: }
11404: closedir($dirh);
11405: }
11406: }
11407: return;
11408: }
11409:
1.41 ng 11410: =pod
1.45 matthew 11411:
1.1068 raeburn 11412: =item &get_folder_hierarchy()
11413:
11414: Provides hierarchy of names of folders/sub-folders containing the current
11415: item,
11416:
11417: Inputs: 3
11418: - $navmap - navmaps object
11419:
11420: - $map - url for map (either the trigger itself, or map containing
11421: the resource, which is the trigger).
11422:
11423: - $showitem - 1 => show title for map itself; 0 => do not show.
11424:
11425: Outputs: 1 @pathitems - array of folder/subfolder names.
11426:
11427: =cut
11428:
11429: sub get_folder_hierarchy {
11430: my ($navmap,$map,$showitem) = @_;
11431: my @pathitems;
11432: if (ref($navmap)) {
11433: my $mapres = $navmap->getResourceByUrl($map);
11434: if (ref($mapres)) {
11435: my $pcslist = $mapres->map_hierarchy();
11436: if ($pcslist ne '') {
11437: my @pcs = split(/,/,$pcslist);
11438: foreach my $pc (@pcs) {
11439: if ($pc == 1) {
11440: push(@pathitems,&mt('Main Course Documents'));
11441: } else {
11442: my $res = $navmap->getByMapPc($pc);
11443: if (ref($res)) {
11444: my $title = $res->compTitle();
11445: $title =~ s/\W+/_/g;
11446: if ($title ne '') {
11447: push(@pathitems,$title);
11448: }
11449: }
11450: }
11451: }
11452: }
1.1071 raeburn 11453: if ($showitem) {
11454: if ($mapres->{ID} eq '0.0') {
11455: push(@pathitems,&mt('Main Course Documents'));
11456: } else {
11457: my $maptitle = $mapres->compTitle();
11458: $maptitle =~ s/\W+/_/g;
11459: if ($maptitle ne '') {
11460: push(@pathitems,$maptitle);
11461: }
1.1068 raeburn 11462: }
11463: }
11464: }
11465: }
11466: return @pathitems;
11467: }
11468:
11469: =pod
11470:
1.1015 raeburn 11471: =item * &get_turnedin_filepath()
11472:
11473: Determines path in a user's portfolio file for storage of files uploaded
11474: to a specific essayresponse or dropbox item.
11475:
11476: Inputs: 3 required + 1 optional.
11477: $symb is symb for resource, $uname and $udom are for current user (required).
11478: $caller is optional (can be "submission", if routine is called when storing
11479: an upoaded file when "Submit Answer" button was pressed).
11480:
11481: Returns array containing $path and $multiresp.
11482: $path is path in portfolio. $multiresp is 1 if this resource contains more
11483: than one file upload item. Callers of routine should append partid as a
11484: subdirectory to $path in cases where $multiresp is 1.
11485:
11486: Called by: homework/essayresponse.pm and homework/structuretags.pm
11487:
11488: =cut
11489:
11490: sub get_turnedin_filepath {
11491: my ($symb,$uname,$udom,$caller) = @_;
11492: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
11493: my $turnindir;
11494: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
11495: $turnindir = $userhash{'turnindir'};
11496: my ($path,$multiresp);
11497: if ($turnindir eq '') {
11498: if ($caller eq 'submission') {
11499: $turnindir = &mt('turned in');
11500: $turnindir =~ s/\W+/_/g;
11501: my %newhash = (
11502: 'turnindir' => $turnindir,
11503: );
11504: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
11505: }
11506: }
11507: if ($turnindir ne '') {
11508: $path = '/'.$turnindir.'/';
11509: my ($multipart,$turnin,@pathitems);
11510: my $navmap = Apache::lonnavmaps::navmap->new();
11511: if (defined($navmap)) {
11512: my $mapres = $navmap->getResourceByUrl($map);
11513: if (ref($mapres)) {
11514: my $pcslist = $mapres->map_hierarchy();
11515: if ($pcslist ne '') {
11516: foreach my $pc (split(/,/,$pcslist)) {
11517: my $res = $navmap->getByMapPc($pc);
11518: if (ref($res)) {
11519: my $title = $res->compTitle();
11520: $title =~ s/\W+/_/g;
11521: if ($title ne '') {
11522: push(@pathitems,$title);
11523: }
11524: }
11525: }
11526: }
11527: my $maptitle = $mapres->compTitle();
11528: $maptitle =~ s/\W+/_/g;
11529: if ($maptitle ne '') {
11530: push(@pathitems,$maptitle);
11531: }
11532: unless ($env{'request.state'} eq 'construct') {
11533: my $res = $navmap->getBySymb($symb);
11534: if (ref($res)) {
11535: my $partlist = $res->parts();
11536: my $totaluploads = 0;
11537: if (ref($partlist) eq 'ARRAY') {
11538: foreach my $part (@{$partlist}) {
11539: my @types = $res->responseType($part);
11540: my @ids = $res->responseIds($part);
11541: for (my $i=0; $i < scalar(@ids); $i++) {
11542: if ($types[$i] eq 'essay') {
11543: my $partid = $part.'_'.$ids[$i];
11544: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
11545: $totaluploads ++;
11546: }
11547: }
11548: }
11549: }
11550: if ($totaluploads > 1) {
11551: $multiresp = 1;
11552: }
11553: }
11554: }
11555: }
11556: } else {
11557: return;
11558: }
11559: } else {
11560: return;
11561: }
11562: my $restitle=&Apache::lonnet::gettitle($symb);
11563: $restitle =~ s/\W+/_/g;
11564: if ($restitle eq '') {
11565: $restitle = ($resurl =~ m{/[^/]+$});
11566: if ($restitle eq '') {
11567: $restitle = time;
11568: }
11569: }
11570: push(@pathitems,$restitle);
11571: $path .= join('/',@pathitems);
11572: }
11573: return ($path,$multiresp);
11574: }
11575:
11576: =pod
11577:
1.464 albertel 11578: =back
1.41 ng 11579:
1.112 bowersj2 11580: =head1 CSV Upload/Handling functions
1.38 albertel 11581:
1.41 ng 11582: =over 4
11583:
1.648 raeburn 11584: =item * &upfile_store($r)
1.41 ng 11585:
11586: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 11587: needs $env{'form.upfile'}
1.41 ng 11588: returns $datatoken to be put into hidden field
11589:
11590: =cut
1.31 albertel 11591:
11592: sub upfile_store {
11593: my $r=shift;
1.258 albertel 11594: $env{'form.upfile'}=~s/\r/\n/gs;
11595: $env{'form.upfile'}=~s/\f/\n/gs;
11596: $env{'form.upfile'}=~s/\n+/\n/gs;
11597: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 11598:
1.258 albertel 11599: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
11600: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 11601: {
1.158 raeburn 11602: my $datafile = $r->dir_config('lonDaemons').
11603: '/tmp/'.$datatoken.'.tmp';
11604: if ( open(my $fh,">$datafile") ) {
1.258 albertel 11605: print $fh $env{'form.upfile'};
1.158 raeburn 11606: close($fh);
11607: }
1.31 albertel 11608: }
11609: return $datatoken;
11610: }
11611:
1.56 matthew 11612: =pod
11613:
1.648 raeburn 11614: =item * &load_tmp_file($r)
1.41 ng 11615:
11616: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 11617: needs $env{'form.datatoken'},
11618: sets $env{'form.upfile'} to the contents of the file
1.41 ng 11619:
11620: =cut
1.31 albertel 11621:
11622: sub load_tmp_file {
11623: my $r=shift;
11624: my @studentdata=();
11625: {
1.158 raeburn 11626: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 11627: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 11628: if ( open(my $fh,"<$studentfile") ) {
11629: @studentdata=<$fh>;
11630: close($fh);
11631: }
1.31 albertel 11632: }
1.258 albertel 11633: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 11634: }
11635:
1.56 matthew 11636: =pod
11637:
1.648 raeburn 11638: =item * &upfile_record_sep()
1.41 ng 11639:
11640: Separate uploaded file into records
11641: returns array of records,
1.258 albertel 11642: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 11643:
11644: =cut
1.31 albertel 11645:
11646: sub upfile_record_sep {
1.258 albertel 11647: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 11648: } else {
1.248 albertel 11649: my @records;
1.258 albertel 11650: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 11651: if ($line=~/^\s*$/) { next; }
11652: push(@records,$line);
11653: }
11654: return @records;
1.31 albertel 11655: }
11656: }
11657:
1.56 matthew 11658: =pod
11659:
1.648 raeburn 11660: =item * &record_sep($record)
1.41 ng 11661:
1.258 albertel 11662: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 11663:
11664: =cut
11665:
1.263 www 11666: sub takeleft {
11667: my $index=shift;
11668: return substr('0000'.$index,-4,4);
11669: }
11670:
1.31 albertel 11671: sub record_sep {
11672: my $record=shift;
11673: my %components=();
1.258 albertel 11674: if ($env{'form.upfiletype'} eq 'xml') {
11675: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 11676: my $i=0;
1.356 albertel 11677: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 11678: $field=~s/^(\"|\')//;
11679: $field=~s/(\"|\')$//;
1.263 www 11680: $components{&takeleft($i)}=$field;
1.31 albertel 11681: $i++;
11682: }
1.258 albertel 11683: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 11684: my $i=0;
1.356 albertel 11685: foreach my $field (split(/\t/,$record)) {
1.31 albertel 11686: $field=~s/^(\"|\')//;
11687: $field=~s/(\"|\')$//;
1.263 www 11688: $components{&takeleft($i)}=$field;
1.31 albertel 11689: $i++;
11690: }
11691: } else {
1.561 www 11692: my $separator=',';
1.480 banghart 11693: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 11694: $separator=';';
1.480 banghart 11695: }
1.31 albertel 11696: my $i=0;
1.561 www 11697: # the character we are looking for to indicate the end of a quote or a record
11698: my $looking_for=$separator;
11699: # do not add the characters to the fields
11700: my $ignore=0;
11701: # we just encountered a separator (or the beginning of the record)
11702: my $just_found_separator=1;
11703: # store the field we are working on here
11704: my $field='';
11705: # work our way through all characters in record
11706: foreach my $character ($record=~/(.)/g) {
11707: if ($character eq $looking_for) {
11708: if ($character ne $separator) {
11709: # Found the end of a quote, again looking for separator
11710: $looking_for=$separator;
11711: $ignore=1;
11712: } else {
11713: # Found a separator, store away what we got
11714: $components{&takeleft($i)}=$field;
11715: $i++;
11716: $just_found_separator=1;
11717: $ignore=0;
11718: $field='';
11719: }
11720: next;
11721: }
11722: # single or double quotation marks after a separator indicate beginning of a quote
11723: # we are now looking for the end of the quote and need to ignore separators
11724: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
11725: $looking_for=$character;
11726: next;
11727: }
11728: # ignore would be true after we reached the end of a quote
11729: if ($ignore) { next; }
11730: if (($just_found_separator) && ($character=~/\s/)) { next; }
11731: $field.=$character;
11732: $just_found_separator=0;
1.31 albertel 11733: }
1.561 www 11734: # catch the very last entry, since we never encountered the separator
11735: $components{&takeleft($i)}=$field;
1.31 albertel 11736: }
11737: return %components;
11738: }
11739:
1.144 matthew 11740: ######################################################
11741: ######################################################
11742:
1.56 matthew 11743: =pod
11744:
1.648 raeburn 11745: =item * &upfile_select_html()
1.41 ng 11746:
1.144 matthew 11747: Return HTML code to select a file from the users machine and specify
11748: the file type.
1.41 ng 11749:
11750: =cut
11751:
1.144 matthew 11752: ######################################################
11753: ######################################################
1.31 albertel 11754: sub upfile_select_html {
1.144 matthew 11755: my %Types = (
11756: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 11757: semisv => &mt('Semicolon separated values'),
1.144 matthew 11758: space => &mt('Space separated'),
11759: tab => &mt('Tabulator separated'),
11760: # xml => &mt('HTML/XML'),
11761: );
11762: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 11763: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 11764: foreach my $type (sort(keys(%Types))) {
11765: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
11766: }
11767: $Str .= "</select>\n";
11768: return $Str;
1.31 albertel 11769: }
11770:
1.301 albertel 11771: sub get_samples {
11772: my ($records,$toget) = @_;
11773: my @samples=({});
11774: my $got=0;
11775: foreach my $rec (@$records) {
11776: my %temp = &record_sep($rec);
11777: if (! grep(/\S/, values(%temp))) { next; }
11778: if (%temp) {
11779: $samples[$got]=\%temp;
11780: $got++;
11781: if ($got == $toget) { last; }
11782: }
11783: }
11784: return \@samples;
11785: }
11786:
1.144 matthew 11787: ######################################################
11788: ######################################################
11789:
1.56 matthew 11790: =pod
11791:
1.648 raeburn 11792: =item * &csv_print_samples($r,$records)
1.41 ng 11793:
11794: Prints a table of sample values from each column uploaded $r is an
11795: Apache Request ref, $records is an arrayref from
11796: &Apache::loncommon::upfile_record_sep
11797:
11798: =cut
11799:
1.144 matthew 11800: ######################################################
11801: ######################################################
1.31 albertel 11802: sub csv_print_samples {
11803: my ($r,$records) = @_;
1.662 bisitz 11804: my $samples = &get_samples($records,5);
1.301 albertel 11805:
1.594 raeburn 11806: $r->print(&mt('Samples').'<br />'.&start_data_table().
11807: &start_data_table_header_row());
1.356 albertel 11808: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 11809: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 11810: $r->print(&end_data_table_header_row());
1.301 albertel 11811: foreach my $hash (@$samples) {
1.594 raeburn 11812: $r->print(&start_data_table_row());
1.356 albertel 11813: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 11814: $r->print('<td>');
1.356 albertel 11815: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 11816: $r->print('</td>');
11817: }
1.594 raeburn 11818: $r->print(&end_data_table_row());
1.31 albertel 11819: }
1.594 raeburn 11820: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 11821: }
11822:
1.144 matthew 11823: ######################################################
11824: ######################################################
11825:
1.56 matthew 11826: =pod
11827:
1.648 raeburn 11828: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 11829:
11830: Prints a table to create associations between values and table columns.
1.144 matthew 11831:
1.41 ng 11832: $r is an Apache Request ref,
11833: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 11834: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 11835:
11836: =cut
11837:
1.144 matthew 11838: ######################################################
11839: ######################################################
1.31 albertel 11840: sub csv_print_select_table {
11841: my ($r,$records,$d) = @_;
1.301 albertel 11842: my $i=0;
11843: my $samples = &get_samples($records,1);
1.144 matthew 11844: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 11845: &start_data_table().&start_data_table_header_row().
1.144 matthew 11846: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 11847: '<th>'.&mt('Column').'</th>'.
11848: &end_data_table_header_row()."\n");
1.356 albertel 11849: foreach my $array_ref (@$d) {
11850: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 11851: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 11852:
1.875 bisitz 11853: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 11854: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 11855: $r->print('<option value="none"></option>');
1.356 albertel 11856: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
11857: $r->print('<option value="'.$sample.'"'.
11858: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 11859: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 11860: }
1.594 raeburn 11861: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 11862: $i++;
11863: }
1.594 raeburn 11864: $r->print(&end_data_table());
1.31 albertel 11865: $i--;
11866: return $i;
11867: }
1.56 matthew 11868:
1.144 matthew 11869: ######################################################
11870: ######################################################
11871:
1.56 matthew 11872: =pod
1.31 albertel 11873:
1.648 raeburn 11874: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 11875:
11876: Prints a table of sample values from the upload and can make associate samples to internal names.
11877:
11878: $r is an Apache Request ref,
11879: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
11880: $d is an array of 2 element arrays (internal name, displayed name)
11881:
11882: =cut
11883:
1.144 matthew 11884: ######################################################
11885: ######################################################
1.31 albertel 11886: sub csv_samples_select_table {
11887: my ($r,$records,$d) = @_;
11888: my $i=0;
1.144 matthew 11889: #
1.662 bisitz 11890: my $max_samples = 5;
11891: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 11892: $r->print(&start_data_table().
11893: &start_data_table_header_row().'<th>'.
11894: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
11895: &end_data_table_header_row());
1.301 albertel 11896:
11897: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 11898: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 11899: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 11900: foreach my $option (@$d) {
11901: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 11902: $r->print('<option value="'.$value.'"'.
1.253 albertel 11903: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 11904: $display.'</option>');
1.31 albertel 11905: }
11906: $r->print('</select></td><td>');
1.662 bisitz 11907: foreach my $line (0..($max_samples-1)) {
1.301 albertel 11908: if (defined($samples->[$line]{$key})) {
11909: $r->print($samples->[$line]{$key}."<br />\n");
11910: }
11911: }
1.594 raeburn 11912: $r->print('</td>'.&end_data_table_row());
1.31 albertel 11913: $i++;
11914: }
1.594 raeburn 11915: $r->print(&end_data_table());
1.31 albertel 11916: $i--;
11917: return($i);
1.115 matthew 11918: }
11919:
1.144 matthew 11920: ######################################################
11921: ######################################################
11922:
1.115 matthew 11923: =pod
11924:
1.648 raeburn 11925: =item * &clean_excel_name($name)
1.115 matthew 11926:
11927: Returns a replacement for $name which does not contain any illegal characters.
11928:
11929: =cut
11930:
1.144 matthew 11931: ######################################################
11932: ######################################################
1.115 matthew 11933: sub clean_excel_name {
11934: my ($name) = @_;
11935: $name =~ s/[:\*\?\/\\]//g;
11936: if (length($name) > 31) {
11937: $name = substr($name,0,31);
11938: }
11939: return $name;
1.25 albertel 11940: }
1.84 albertel 11941:
1.85 albertel 11942: =pod
11943:
1.648 raeburn 11944: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 11945:
11946: Returns either 1 or undef
11947:
11948: 1 if the part is to be hidden, undef if it is to be shown
11949:
11950: Arguments are:
11951:
11952: $id the id of the part to be checked
11953: $symb, optional the symb of the resource to check
11954: $udom, optional the domain of the user to check for
11955: $uname, optional the username of the user to check for
11956:
11957: =cut
1.84 albertel 11958:
11959: sub check_if_partid_hidden {
11960: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 11961: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 11962: $symb,$udom,$uname);
1.141 albertel 11963: my $truth=1;
11964: #if the string starts with !, then the list is the list to show not hide
11965: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 11966: my @hiddenlist=split(/,/,$hiddenparts);
11967: foreach my $checkid (@hiddenlist) {
1.141 albertel 11968: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 11969: }
1.141 albertel 11970: return !$truth;
1.84 albertel 11971: }
1.127 matthew 11972:
1.138 matthew 11973:
11974: ############################################################
11975: ############################################################
11976:
11977: =pod
11978:
1.157 matthew 11979: =back
11980:
1.138 matthew 11981: =head1 cgi-bin script and graphing routines
11982:
1.157 matthew 11983: =over 4
11984:
1.648 raeburn 11985: =item * &get_cgi_id()
1.138 matthew 11986:
11987: Inputs: none
11988:
11989: Returns an id which can be used to pass environment variables
11990: to various cgi-bin scripts. These environment variables will
11991: be removed from the users environment after a given time by
11992: the routine &Apache::lonnet::transfer_profile_to_env.
11993:
11994: =cut
11995:
11996: ############################################################
11997: ############################################################
1.152 albertel 11998: my $uniq=0;
1.136 matthew 11999: sub get_cgi_id {
1.154 albertel 12000: $uniq=($uniq+1)%100000;
1.280 albertel 12001: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 12002: }
12003:
1.127 matthew 12004: ############################################################
12005: ############################################################
12006:
12007: =pod
12008:
1.648 raeburn 12009: =item * &DrawBarGraph()
1.127 matthew 12010:
1.138 matthew 12011: Facilitates the plotting of data in a (stacked) bar graph.
12012: Puts plot definition data into the users environment in order for
12013: graph.png to plot it. Returns an <img> tag for the plot.
12014: The bars on the plot are labeled '1','2',...,'n'.
12015:
12016: Inputs:
12017:
12018: =over 4
12019:
12020: =item $Title: string, the title of the plot
12021:
12022: =item $xlabel: string, text describing the X-axis of the plot
12023:
12024: =item $ylabel: string, text describing the Y-axis of the plot
12025:
12026: =item $Max: scalar, the maximum Y value to use in the plot
12027: If $Max is < any data point, the graph will not be rendered.
12028:
1.140 matthew 12029: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 12030: they are plotted. If undefined, default values will be used.
12031:
1.178 matthew 12032: =item $labels: array ref holding the labels to use on the x-axis for the bars.
12033:
1.138 matthew 12034: =item @Values: An array of array references. Each array reference holds data
12035: to be plotted in a stacked bar chart.
12036:
1.239 matthew 12037: =item If the final element of @Values is a hash reference the key/value
12038: pairs will be added to the graph definition.
12039:
1.138 matthew 12040: =back
12041:
12042: Returns:
12043:
12044: An <img> tag which references graph.png and the appropriate identifying
12045: information for the plot.
12046:
1.127 matthew 12047: =cut
12048:
12049: ############################################################
12050: ############################################################
1.134 matthew 12051: sub DrawBarGraph {
1.178 matthew 12052: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 12053: #
12054: if (! defined($colors)) {
12055: $colors = ['#33ff00',
12056: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
12057: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
12058: ];
12059: }
1.228 matthew 12060: my $extra_settings = {};
12061: if (ref($Values[-1]) eq 'HASH') {
12062: $extra_settings = pop(@Values);
12063: }
1.127 matthew 12064: #
1.136 matthew 12065: my $identifier = &get_cgi_id();
12066: my $id = 'cgi.'.$identifier;
1.129 matthew 12067: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 12068: return '';
12069: }
1.225 matthew 12070: #
12071: my @Labels;
12072: if (defined($labels)) {
12073: @Labels = @$labels;
12074: } else {
12075: for (my $i=0;$i<@{$Values[0]};$i++) {
12076: push (@Labels,$i+1);
12077: }
12078: }
12079: #
1.129 matthew 12080: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 12081: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 12082: my %ValuesHash;
12083: my $NumSets=1;
12084: foreach my $array (@Values) {
12085: next if (! ref($array));
1.136 matthew 12086: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 12087: join(',',@$array);
1.129 matthew 12088: }
1.127 matthew 12089: #
1.136 matthew 12090: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 12091: if ($NumBars < 3) {
12092: $width = 120+$NumBars*32;
1.220 matthew 12093: $xskip = 1;
1.225 matthew 12094: $bar_width = 30;
12095: } elsif ($NumBars < 5) {
12096: $width = 120+$NumBars*20;
12097: $xskip = 1;
12098: $bar_width = 20;
1.220 matthew 12099: } elsif ($NumBars < 10) {
1.136 matthew 12100: $width = 120+$NumBars*15;
12101: $xskip = 1;
12102: $bar_width = 15;
12103: } elsif ($NumBars <= 25) {
12104: $width = 120+$NumBars*11;
12105: $xskip = 5;
12106: $bar_width = 8;
12107: } elsif ($NumBars <= 50) {
12108: $width = 120+$NumBars*8;
12109: $xskip = 5;
12110: $bar_width = 4;
12111: } else {
12112: $width = 120+$NumBars*8;
12113: $xskip = 5;
12114: $bar_width = 4;
12115: }
12116: #
1.137 matthew 12117: $Max = 1 if ($Max < 1);
12118: if ( int($Max) < $Max ) {
12119: $Max++;
12120: $Max = int($Max);
12121: }
1.127 matthew 12122: $Title = '' if (! defined($Title));
12123: $xlabel = '' if (! defined($xlabel));
12124: $ylabel = '' if (! defined($ylabel));
1.369 www 12125: $ValuesHash{$id.'.title'} = &escape($Title);
12126: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
12127: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 12128: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 12129: $ValuesHash{$id.'.NumBars'} = $NumBars;
12130: $ValuesHash{$id.'.NumSets'} = $NumSets;
12131: $ValuesHash{$id.'.PlotType'} = 'bar';
12132: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
12133: $ValuesHash{$id.'.height'} = $height;
12134: $ValuesHash{$id.'.width'} = $width;
12135: $ValuesHash{$id.'.xskip'} = $xskip;
12136: $ValuesHash{$id.'.bar_width'} = $bar_width;
12137: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 12138: #
1.228 matthew 12139: # Deal with other parameters
12140: while (my ($key,$value) = each(%$extra_settings)) {
12141: $ValuesHash{$id.'.'.$key} = $value;
12142: }
12143: #
1.646 raeburn 12144: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 12145: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
12146: }
12147:
12148: ############################################################
12149: ############################################################
12150:
12151: =pod
12152:
1.648 raeburn 12153: =item * &DrawXYGraph()
1.137 matthew 12154:
1.138 matthew 12155: Facilitates the plotting of data in an XY graph.
12156: Puts plot definition data into the users environment in order for
12157: graph.png to plot it. Returns an <img> tag for the plot.
12158:
12159: Inputs:
12160:
12161: =over 4
12162:
12163: =item $Title: string, the title of the plot
12164:
12165: =item $xlabel: string, text describing the X-axis of the plot
12166:
12167: =item $ylabel: string, text describing the Y-axis of the plot
12168:
12169: =item $Max: scalar, the maximum Y value to use in the plot
12170: If $Max is < any data point, the graph will not be rendered.
12171:
12172: =item $colors: Array ref containing the hex color codes for the data to be
12173: plotted in. If undefined, default values will be used.
12174:
12175: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
12176:
12177: =item $Ydata: Array ref containing Array refs.
1.185 www 12178: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 12179:
12180: =item %Values: hash indicating or overriding any default values which are
12181: passed to graph.png.
12182: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
12183:
12184: =back
12185:
12186: Returns:
12187:
12188: An <img> tag which references graph.png and the appropriate identifying
12189: information for the plot.
12190:
1.137 matthew 12191: =cut
12192:
12193: ############################################################
12194: ############################################################
12195: sub DrawXYGraph {
12196: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
12197: #
12198: # Create the identifier for the graph
12199: my $identifier = &get_cgi_id();
12200: my $id = 'cgi.'.$identifier;
12201: #
12202: $Title = '' if (! defined($Title));
12203: $xlabel = '' if (! defined($xlabel));
12204: $ylabel = '' if (! defined($ylabel));
12205: my %ValuesHash =
12206: (
1.369 www 12207: $id.'.title' => &escape($Title),
12208: $id.'.xlabel' => &escape($xlabel),
12209: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 12210: $id.'.y_max_value'=> $Max,
12211: $id.'.labels' => join(',',@$Xlabels),
12212: $id.'.PlotType' => 'XY',
12213: );
12214: #
12215: if (defined($colors) && ref($colors) eq 'ARRAY') {
12216: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
12217: }
12218: #
12219: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
12220: return '';
12221: }
12222: my $NumSets=1;
1.138 matthew 12223: foreach my $array (@{$Ydata}){
1.137 matthew 12224: next if (! ref($array));
12225: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
12226: }
1.138 matthew 12227: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 12228: #
12229: # Deal with other parameters
12230: while (my ($key,$value) = each(%Values)) {
12231: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 12232: }
12233: #
1.646 raeburn 12234: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 12235: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
12236: }
12237:
12238: ############################################################
12239: ############################################################
12240:
12241: =pod
12242:
1.648 raeburn 12243: =item * &DrawXYYGraph()
1.138 matthew 12244:
12245: Facilitates the plotting of data in an XY graph with two Y axes.
12246: Puts plot definition data into the users environment in order for
12247: graph.png to plot it. Returns an <img> tag for the plot.
12248:
12249: Inputs:
12250:
12251: =over 4
12252:
12253: =item $Title: string, the title of the plot
12254:
12255: =item $xlabel: string, text describing the X-axis of the plot
12256:
12257: =item $ylabel: string, text describing the Y-axis of the plot
12258:
12259: =item $colors: Array ref containing the hex color codes for the data to be
12260: plotted in. If undefined, default values will be used.
12261:
12262: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
12263:
12264: =item $Ydata1: The first data set
12265:
12266: =item $Min1: The minimum value of the left Y-axis
12267:
12268: =item $Max1: The maximum value of the left Y-axis
12269:
12270: =item $Ydata2: The second data set
12271:
12272: =item $Min2: The minimum value of the right Y-axis
12273:
12274: =item $Max2: The maximum value of the left Y-axis
12275:
12276: =item %Values: hash indicating or overriding any default values which are
12277: passed to graph.png.
12278: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
12279:
12280: =back
12281:
12282: Returns:
12283:
12284: An <img> tag which references graph.png and the appropriate identifying
12285: information for the plot.
1.136 matthew 12286:
12287: =cut
12288:
12289: ############################################################
12290: ############################################################
1.137 matthew 12291: sub DrawXYYGraph {
12292: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
12293: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 12294: #
12295: # Create the identifier for the graph
12296: my $identifier = &get_cgi_id();
12297: my $id = 'cgi.'.$identifier;
12298: #
12299: $Title = '' if (! defined($Title));
12300: $xlabel = '' if (! defined($xlabel));
12301: $ylabel = '' if (! defined($ylabel));
12302: my %ValuesHash =
12303: (
1.369 www 12304: $id.'.title' => &escape($Title),
12305: $id.'.xlabel' => &escape($xlabel),
12306: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 12307: $id.'.labels' => join(',',@$Xlabels),
12308: $id.'.PlotType' => 'XY',
12309: $id.'.NumSets' => 2,
1.137 matthew 12310: $id.'.two_axes' => 1,
12311: $id.'.y1_max_value' => $Max1,
12312: $id.'.y1_min_value' => $Min1,
12313: $id.'.y2_max_value' => $Max2,
12314: $id.'.y2_min_value' => $Min2,
1.136 matthew 12315: );
12316: #
1.137 matthew 12317: if (defined($colors) && ref($colors) eq 'ARRAY') {
12318: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
12319: }
12320: #
12321: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
12322: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 12323: return '';
12324: }
12325: my $NumSets=1;
1.137 matthew 12326: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 12327: next if (! ref($array));
12328: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 12329: }
12330: #
12331: # Deal with other parameters
12332: while (my ($key,$value) = each(%Values)) {
12333: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 12334: }
12335: #
1.646 raeburn 12336: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 12337: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 12338: }
12339:
12340: ############################################################
12341: ############################################################
12342:
12343: =pod
12344:
1.157 matthew 12345: =back
12346:
1.139 matthew 12347: =head1 Statistics helper routines?
12348:
12349: Bad place for them but what the hell.
12350:
1.157 matthew 12351: =over 4
12352:
1.648 raeburn 12353: =item * &chartlink()
1.139 matthew 12354:
12355: Returns a link to the chart for a specific student.
12356:
12357: Inputs:
12358:
12359: =over 4
12360:
12361: =item $linktext: The text of the link
12362:
12363: =item $sname: The students username
12364:
12365: =item $sdomain: The students domain
12366:
12367: =back
12368:
1.157 matthew 12369: =back
12370:
1.139 matthew 12371: =cut
12372:
12373: ############################################################
12374: ############################################################
12375: sub chartlink {
12376: my ($linktext, $sname, $sdomain) = @_;
12377: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 12378: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 12379: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 12380: '">'.$linktext.'</a>';
1.153 matthew 12381: }
12382:
12383: #######################################################
12384: #######################################################
12385:
12386: =pod
12387:
12388: =head1 Course Environment Routines
1.157 matthew 12389:
12390: =over 4
1.153 matthew 12391:
1.648 raeburn 12392: =item * &restore_course_settings()
1.153 matthew 12393:
1.648 raeburn 12394: =item * &store_course_settings()
1.153 matthew 12395:
12396: Restores/Store indicated form parameters from the course environment.
12397: Will not overwrite existing values of the form parameters.
12398:
12399: Inputs:
12400: a scalar describing the data (e.g. 'chart', 'problem_analysis')
12401:
12402: a hash ref describing the data to be stored. For example:
12403:
12404: %Save_Parameters = ('Status' => 'scalar',
12405: 'chartoutputmode' => 'scalar',
12406: 'chartoutputdata' => 'scalar',
12407: 'Section' => 'array',
1.373 raeburn 12408: 'Group' => 'array',
1.153 matthew 12409: 'StudentData' => 'array',
12410: 'Maps' => 'array');
12411:
12412: Returns: both routines return nothing
12413:
1.631 raeburn 12414: =back
12415:
1.153 matthew 12416: =cut
12417:
12418: #######################################################
12419: #######################################################
12420: sub store_course_settings {
1.496 albertel 12421: return &store_settings($env{'request.course.id'},@_);
12422: }
12423:
12424: sub store_settings {
1.153 matthew 12425: # save to the environment
12426: # appenv the same items, just to be safe
1.300 albertel 12427: my $udom = $env{'user.domain'};
12428: my $uname = $env{'user.name'};
1.496 albertel 12429: my ($context,$prefix,$Settings) = @_;
1.153 matthew 12430: my %SaveHash;
12431: my %AppHash;
12432: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 12433: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 12434: my $envname = 'environment.'.$basename;
1.258 albertel 12435: if (exists($env{'form.'.$setting})) {
1.153 matthew 12436: # Save this value away
12437: if ($type eq 'scalar' &&
1.258 albertel 12438: (! exists($env{$envname}) ||
12439: $env{$envname} ne $env{'form.'.$setting})) {
12440: $SaveHash{$basename} = $env{'form.'.$setting};
12441: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 12442: } elsif ($type eq 'array') {
12443: my $stored_form;
1.258 albertel 12444: if (ref($env{'form.'.$setting})) {
1.153 matthew 12445: $stored_form = join(',',
12446: map {
1.369 www 12447: &escape($_);
1.258 albertel 12448: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 12449: } else {
12450: $stored_form =
1.369 www 12451: &escape($env{'form.'.$setting});
1.153 matthew 12452: }
12453: # Determine if the array contents are the same.
1.258 albertel 12454: if ($stored_form ne $env{$envname}) {
1.153 matthew 12455: $SaveHash{$basename} = $stored_form;
12456: $AppHash{$envname} = $stored_form;
12457: }
12458: }
12459: }
12460: }
12461: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 12462: $udom,$uname);
1.153 matthew 12463: if ($put_result !~ /^(ok|delayed)/) {
12464: &Apache::lonnet::logthis('unable to save form parameters, '.
12465: 'got error:'.$put_result);
12466: }
12467: # Make sure these settings stick around in this session, too
1.646 raeburn 12468: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 12469: return;
12470: }
12471:
12472: sub restore_course_settings {
1.499 albertel 12473: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 12474: }
12475:
12476: sub restore_settings {
12477: my ($context,$prefix,$Settings) = @_;
1.153 matthew 12478: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 12479: next if (exists($env{'form.'.$setting}));
1.496 albertel 12480: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 12481: '.'.$setting;
1.258 albertel 12482: if (exists($env{$envname})) {
1.153 matthew 12483: if ($type eq 'scalar') {
1.258 albertel 12484: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 12485: } elsif ($type eq 'array') {
1.258 albertel 12486: $env{'form.'.$setting} = [
1.153 matthew 12487: map {
1.369 www 12488: &unescape($_);
1.258 albertel 12489: } split(',',$env{$envname})
1.153 matthew 12490: ];
12491: }
12492: }
12493: }
1.127 matthew 12494: }
12495:
1.618 raeburn 12496: #######################################################
12497: #######################################################
12498:
12499: =pod
12500:
12501: =head1 Domain E-mail Routines
12502:
12503: =over 4
12504:
1.648 raeburn 12505: =item * &build_recipient_list()
1.618 raeburn 12506:
1.884 raeburn 12507: Build recipient lists for five types of e-mail:
1.766 raeburn 12508: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884 raeburn 12509: (d) Help requests, (e) Course requests needing approval, generated by
12510: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
12511: loncoursequeueadmin.pm respectively.
1.618 raeburn 12512:
12513: Inputs:
1.619 raeburn 12514: defmail (scalar - email address of default recipient),
1.618 raeburn 12515: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 12516: defdom (domain for which to retrieve configuration settings),
12517: origmail (scalar - email address of recipient from loncapa.conf,
12518: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 12519:
1.655 raeburn 12520: Returns: comma separated list of addresses to which to send e-mail.
12521:
12522: =back
1.618 raeburn 12523:
12524: =cut
12525:
12526: ############################################################
12527: ############################################################
12528: sub build_recipient_list {
1.619 raeburn 12529: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 12530: my @recipients;
12531: my $otheremails;
12532: my %domconfig =
12533: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
12534: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 12535: if (exists($domconfig{'contacts'}{$mailing})) {
12536: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
12537: my @contacts = ('adminemail','supportemail');
12538: foreach my $item (@contacts) {
12539: if ($domconfig{'contacts'}{$mailing}{$item}) {
12540: my $addr = $domconfig{'contacts'}{$item};
12541: if (!grep(/^\Q$addr\E$/,@recipients)) {
12542: push(@recipients,$addr);
12543: }
1.619 raeburn 12544: }
1.766 raeburn 12545: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 12546: }
12547: }
1.766 raeburn 12548: } elsif ($origmail ne '') {
12549: push(@recipients,$origmail);
1.618 raeburn 12550: }
1.619 raeburn 12551: } elsif ($origmail ne '') {
12552: push(@recipients,$origmail);
1.618 raeburn 12553: }
1.688 raeburn 12554: if (defined($defmail)) {
12555: if ($defmail ne '') {
12556: push(@recipients,$defmail);
12557: }
1.618 raeburn 12558: }
12559: if ($otheremails) {
1.619 raeburn 12560: my @others;
12561: if ($otheremails =~ /,/) {
12562: @others = split(/,/,$otheremails);
1.618 raeburn 12563: } else {
1.619 raeburn 12564: push(@others,$otheremails);
12565: }
12566: foreach my $addr (@others) {
12567: if (!grep(/^\Q$addr\E$/,@recipients)) {
12568: push(@recipients,$addr);
12569: }
1.618 raeburn 12570: }
12571: }
1.619 raeburn 12572: my $recipientlist = join(',',@recipients);
1.618 raeburn 12573: return $recipientlist;
12574: }
12575:
1.127 matthew 12576: ############################################################
12577: ############################################################
1.154 albertel 12578:
1.655 raeburn 12579: =pod
12580:
12581: =head1 Course Catalog Routines
12582:
12583: =over 4
12584:
12585: =item * &gather_categories()
12586:
12587: Converts category definitions - keys of categories hash stored in
12588: coursecategories in configuration.db on the primary library server in a
12589: domain - to an array. Also generates javascript and idx hash used to
12590: generate Domain Coordinator interface for editing Course Categories.
12591:
12592: Inputs:
1.663 raeburn 12593:
1.655 raeburn 12594: categories (reference to hash of category definitions).
1.663 raeburn 12595:
1.655 raeburn 12596: cats (reference to array of arrays/hashes which encapsulates hierarchy of
12597: categories and subcategories).
1.663 raeburn 12598:
1.655 raeburn 12599: idx (reference to hash of counters used in Domain Coordinator interface for
12600: editing Course Categories).
1.663 raeburn 12601:
1.655 raeburn 12602: jsarray (reference to array of categories used to create Javascript arrays for
12603: Domain Coordinator interface for editing Course Categories).
12604:
12605: Returns: nothing
12606:
12607: Side effects: populates cats, idx and jsarray.
12608:
12609: =cut
12610:
12611: sub gather_categories {
12612: my ($categories,$cats,$idx,$jsarray) = @_;
12613: my %counters;
12614: my $num = 0;
12615: foreach my $item (keys(%{$categories})) {
12616: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
12617: if ($container eq '' && $depth == 0) {
12618: $cats->[$depth][$categories->{$item}] = $cat;
12619: } else {
12620: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
12621: }
12622: my ($escitem,$tail) = split(/:/,$item,2);
12623: if ($counters{$tail} eq '') {
12624: $counters{$tail} = $num;
12625: $num ++;
12626: }
12627: if (ref($idx) eq 'HASH') {
12628: $idx->{$item} = $counters{$tail};
12629: }
12630: if (ref($jsarray) eq 'ARRAY') {
12631: push(@{$jsarray->[$counters{$tail}]},$item);
12632: }
12633: }
12634: return;
12635: }
12636:
12637: =pod
12638:
12639: =item * &extract_categories()
12640:
12641: Used to generate breadcrumb trails for course categories.
12642:
12643: Inputs:
1.663 raeburn 12644:
1.655 raeburn 12645: categories (reference to hash of category definitions).
1.663 raeburn 12646:
1.655 raeburn 12647: cats (reference to array of arrays/hashes which encapsulates hierarchy of
12648: categories and subcategories).
1.663 raeburn 12649:
1.655 raeburn 12650: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 12651:
1.655 raeburn 12652: allitems (reference to hash - key is category key
12653: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 12654:
1.655 raeburn 12655: idx (reference to hash of counters used in Domain Coordinator interface for
12656: editing Course Categories).
1.663 raeburn 12657:
1.655 raeburn 12658: jsarray (reference to array of categories used to create Javascript arrays for
12659: Domain Coordinator interface for editing Course Categories).
12660:
1.665 raeburn 12661: subcats (reference to hash of arrays containing all subcategories within each
12662: category, -recursive)
12663:
1.655 raeburn 12664: Returns: nothing
12665:
12666: Side effects: populates trails and allitems hash references.
12667:
12668: =cut
12669:
12670: sub extract_categories {
1.665 raeburn 12671: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 12672: if (ref($categories) eq 'HASH') {
12673: &gather_categories($categories,$cats,$idx,$jsarray);
12674: if (ref($cats->[0]) eq 'ARRAY') {
12675: for (my $i=0; $i<@{$cats->[0]}; $i++) {
12676: my $name = $cats->[0][$i];
12677: my $item = &escape($name).'::0';
12678: my $trailstr;
12679: if ($name eq 'instcode') {
12680: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 12681: } elsif ($name eq 'communities') {
12682: $trailstr = &mt('Communities');
1.655 raeburn 12683: } else {
12684: $trailstr = $name;
12685: }
12686: if ($allitems->{$item} eq '') {
12687: push(@{$trails},$trailstr);
12688: $allitems->{$item} = scalar(@{$trails})-1;
12689: }
12690: my @parents = ($name);
12691: if (ref($cats->[1]{$name}) eq 'ARRAY') {
12692: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
12693: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 12694: if (ref($subcats) eq 'HASH') {
12695: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
12696: }
12697: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
12698: }
12699: } else {
12700: if (ref($subcats) eq 'HASH') {
12701: $subcats->{$item} = [];
1.655 raeburn 12702: }
12703: }
12704: }
12705: }
12706: }
12707: return;
12708: }
12709:
12710: =pod
12711:
12712: =item *&recurse_categories()
12713:
12714: Recursively used to generate breadcrumb trails for course categories.
12715:
12716: Inputs:
1.663 raeburn 12717:
1.655 raeburn 12718: cats (reference to array of arrays/hashes which encapsulates hierarchy of
12719: categories and subcategories).
1.663 raeburn 12720:
1.655 raeburn 12721: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 12722:
12723: category (current course category, for which breadcrumb trail is being generated).
12724:
12725: trails (reference to array of breadcrumb trails for each category).
12726:
1.655 raeburn 12727: allitems (reference to hash - key is category key
12728: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 12729:
1.655 raeburn 12730: parents (array containing containers directories for current category,
12731: back to top level).
12732:
12733: Returns: nothing
12734:
12735: Side effects: populates trails and allitems hash references
12736:
12737: =cut
12738:
12739: sub recurse_categories {
1.665 raeburn 12740: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 12741: my $shallower = $depth - 1;
12742: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
12743: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
12744: my $name = $cats->[$depth]{$category}[$k];
12745: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
12746: my $trailstr = join(' -> ',(@{$parents},$category));
12747: if ($allitems->{$item} eq '') {
12748: push(@{$trails},$trailstr);
12749: $allitems->{$item} = scalar(@{$trails})-1;
12750: }
12751: my $deeper = $depth+1;
12752: push(@{$parents},$category);
1.665 raeburn 12753: if (ref($subcats) eq 'HASH') {
12754: my $subcat = &escape($name).':'.$category.':'.$depth;
12755: for (my $j=@{$parents}; $j>=0; $j--) {
12756: my $higher;
12757: if ($j > 0) {
12758: $higher = &escape($parents->[$j]).':'.
12759: &escape($parents->[$j-1]).':'.$j;
12760: } else {
12761: $higher = &escape($parents->[$j]).'::'.$j;
12762: }
12763: push(@{$subcats->{$higher}},$subcat);
12764: }
12765: }
12766: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
12767: $subcats);
1.655 raeburn 12768: pop(@{$parents});
12769: }
12770: } else {
12771: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
12772: my $trailstr = join(' -> ',(@{$parents},$category));
12773: if ($allitems->{$item} eq '') {
12774: push(@{$trails},$trailstr);
12775: $allitems->{$item} = scalar(@{$trails})-1;
12776: }
12777: }
12778: return;
12779: }
12780:
1.663 raeburn 12781: =pod
12782:
12783: =item *&assign_categories_table()
12784:
12785: Create a datatable for display of hierarchical categories in a domain,
12786: with checkboxes to allow a course to be categorized.
12787:
12788: Inputs:
12789:
12790: cathash - reference to hash of categories defined for the domain (from
12791: configuration.db)
12792:
12793: currcat - scalar with an & separated list of categories assigned to a course.
12794:
1.919 raeburn 12795: type - scalar contains course type (Course or Community).
12796:
1.663 raeburn 12797: Returns: $output (markup to be displayed)
12798:
12799: =cut
12800:
12801: sub assign_categories_table {
1.919 raeburn 12802: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 12803: my $output;
12804: if (ref($cathash) eq 'HASH') {
12805: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
12806: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
12807: $maxdepth = scalar(@cats);
12808: if (@cats > 0) {
12809: my $itemcount = 0;
12810: if (ref($cats[0]) eq 'ARRAY') {
12811: my @currcategories;
12812: if ($currcat ne '') {
12813: @currcategories = split('&',$currcat);
12814: }
1.919 raeburn 12815: my $table;
1.663 raeburn 12816: for (my $i=0; $i<@{$cats[0]}; $i++) {
12817: my $parent = $cats[0][$i];
1.919 raeburn 12818: next if ($parent eq 'instcode');
12819: if ($type eq 'Community') {
12820: next unless ($parent eq 'communities');
12821: } else {
12822: next if ($parent eq 'communities');
12823: }
1.663 raeburn 12824: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
12825: my $item = &escape($parent).'::0';
12826: my $checked = '';
12827: if (@currcategories > 0) {
12828: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 12829: $checked = ' checked="checked"';
1.663 raeburn 12830: }
12831: }
1.919 raeburn 12832: my $parent_title = $parent;
12833: if ($parent eq 'communities') {
12834: $parent_title = &mt('Communities');
12835: }
12836: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
12837: '<input type="checkbox" name="usecategory" value="'.
12838: $item.'"'.$checked.' />'.$parent_title.'</span>'.
12839: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 12840: my $depth = 1;
12841: push(@path,$parent);
1.919 raeburn 12842: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 12843: pop(@path);
1.919 raeburn 12844: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 12845: $itemcount ++;
12846: }
1.919 raeburn 12847: if ($itemcount) {
12848: $output = &Apache::loncommon::start_data_table().
12849: $table.
12850: &Apache::loncommon::end_data_table();
12851: }
1.663 raeburn 12852: }
12853: }
12854: }
12855: return $output;
12856: }
12857:
12858: =pod
12859:
12860: =item *&assign_category_rows()
12861:
12862: Create a datatable row for display of nested categories in a domain,
12863: with checkboxes to allow a course to be categorized,called recursively.
12864:
12865: Inputs:
12866:
12867: itemcount - track row number for alternating colors
12868:
12869: cats - reference to array of arrays/hashes which encapsulates hierarchy of
12870: categories and subcategories.
12871:
12872: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
12873:
12874: parent - parent of current category item
12875:
12876: path - Array containing all categories back up through the hierarchy from the
12877: current category to the top level.
12878:
12879: currcategories - reference to array of current categories assigned to the course
12880:
12881: Returns: $output (markup to be displayed).
12882:
12883: =cut
12884:
12885: sub assign_category_rows {
12886: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
12887: my ($text,$name,$item,$chgstr);
12888: if (ref($cats) eq 'ARRAY') {
12889: my $maxdepth = scalar(@{$cats});
12890: if (ref($cats->[$depth]) eq 'HASH') {
12891: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
12892: my $numchildren = @{$cats->[$depth]{$parent}};
12893: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
12894: $text .= '<td><table class="LC_datatable">';
12895: for (my $j=0; $j<$numchildren; $j++) {
12896: $name = $cats->[$depth]{$parent}[$j];
12897: $item = &escape($name).':'.&escape($parent).':'.$depth;
12898: my $deeper = $depth+1;
12899: my $checked = '';
12900: if (ref($currcategories) eq 'ARRAY') {
12901: if (@{$currcategories} > 0) {
12902: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 12903: $checked = ' checked="checked"';
1.663 raeburn 12904: }
12905: }
12906: }
1.664 raeburn 12907: $text .= '<tr><td><span class="LC_nobreak"><label>'.
12908: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 12909: $item.'"'.$checked.' />'.$name.'</label></span>'.
12910: '<input type="hidden" name="catname" value="'.$name.'" />'.
12911: '</td><td>';
1.663 raeburn 12912: if (ref($path) eq 'ARRAY') {
12913: push(@{$path},$name);
12914: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
12915: pop(@{$path});
12916: }
12917: $text .= '</td></tr>';
12918: }
12919: $text .= '</table></td>';
12920: }
12921: }
12922: }
12923: return $text;
12924: }
12925:
1.655 raeburn 12926: ############################################################
12927: ############################################################
12928:
12929:
1.443 albertel 12930: sub commit_customrole {
1.664 raeburn 12931: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 12932: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 12933: ($start?', '.&mt('starting').' '.localtime($start):'').
12934: ($end?', ending '.localtime($end):'').': <b>'.
12935: &Apache::lonnet::assigncustomrole(
1.664 raeburn 12936: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 12937: '</b><br />';
12938: return $output;
12939: }
12940:
12941: sub commit_standardrole {
1.541 raeburn 12942: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
12943: my ($output,$logmsg,$linefeed);
12944: if ($context eq 'auto') {
12945: $linefeed = "\n";
12946: } else {
12947: $linefeed = "<br />\n";
12948: }
1.443 albertel 12949: if ($three eq 'st') {
1.541 raeburn 12950: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
12951: $one,$two,$sec,$context);
12952: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 12953: ($result eq 'unknown_course') || ($result eq 'refused')) {
12954: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 12955: } else {
1.541 raeburn 12956: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 12957: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 12958: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
12959: if ($context eq 'auto') {
12960: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
12961: } else {
12962: $output .= '<b>'.$result.'</b>'.$linefeed.
12963: &mt('Add to classlist').': <b>ok</b>';
12964: }
12965: $output .= $linefeed;
1.443 albertel 12966: }
12967: } else {
12968: $output = &mt('Assigning').' '.$three.' in '.$url.
12969: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 12970: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 12971: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 12972: if ($context eq 'auto') {
12973: $output .= $result.$linefeed;
12974: } else {
12975: $output .= '<b>'.$result.'</b>'.$linefeed;
12976: }
1.443 albertel 12977: }
12978: return $output;
12979: }
12980:
12981: sub commit_studentrole {
1.541 raeburn 12982: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 12983: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 12984: if ($context eq 'auto') {
12985: $linefeed = "\n";
12986: } else {
12987: $linefeed = '<br />'."\n";
12988: }
1.443 albertel 12989: if (defined($one) && defined($two)) {
12990: my $cid=$one.'_'.$two;
12991: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
12992: my $secchange = 0;
12993: my $expire_role_result;
12994: my $modify_section_result;
1.628 raeburn 12995: if ($oldsec ne '-1') {
12996: if ($oldsec ne $sec) {
1.443 albertel 12997: $secchange = 1;
1.628 raeburn 12998: my $now = time;
1.443 albertel 12999: my $uurl='/'.$cid;
13000: $uurl=~s/\_/\//g;
13001: if ($oldsec) {
13002: $uurl.='/'.$oldsec;
13003: }
1.626 raeburn 13004: $oldsecurl = $uurl;
1.628 raeburn 13005: $expire_role_result =
1.652 raeburn 13006: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 13007: if ($env{'request.course.sec'} ne '') {
13008: if ($expire_role_result eq 'refused') {
13009: my @roles = ('st');
13010: my @statuses = ('previous');
13011: my @roledoms = ($one);
13012: my $withsec = 1;
13013: my %roleshash =
13014: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
13015: \@statuses,\@roles,\@roledoms,$withsec);
13016: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
13017: my ($oldstart,$oldend) =
13018: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
13019: if ($oldend > 0 && $oldend <= $now) {
13020: $expire_role_result = 'ok';
13021: }
13022: }
13023: }
13024: }
1.443 albertel 13025: $result = $expire_role_result;
13026: }
13027: }
13028: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 13029: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 13030: if ($modify_section_result =~ /^ok/) {
13031: if ($secchange == 1) {
1.628 raeburn 13032: if ($sec eq '') {
13033: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
13034: } else {
13035: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
13036: }
1.443 albertel 13037: } elsif ($oldsec eq '-1') {
1.628 raeburn 13038: if ($sec eq '') {
13039: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
13040: } else {
13041: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
13042: }
1.443 albertel 13043: } else {
1.628 raeburn 13044: if ($sec eq '') {
13045: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
13046: } else {
13047: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
13048: }
1.443 albertel 13049: }
13050: } else {
1.628 raeburn 13051: if ($secchange) {
13052: $$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;
13053: } else {
13054: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
13055: }
1.443 albertel 13056: }
13057: $result = $modify_section_result;
13058: } elsif ($secchange == 1) {
1.628 raeburn 13059: if ($oldsec eq '') {
13060: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
13061: } else {
13062: $$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;
13063: }
1.626 raeburn 13064: if ($expire_role_result eq 'refused') {
13065: my $newsecurl = '/'.$cid;
13066: $newsecurl =~ s/\_/\//g;
13067: if ($sec ne '') {
13068: $newsecurl.='/'.$sec;
13069: }
13070: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
13071: if ($sec eq '') {
13072: $$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;
13073: } else {
13074: $$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;
13075: }
13076: }
13077: }
1.443 albertel 13078: }
13079: } else {
1.626 raeburn 13080: $$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 13081: $result = "error: incomplete course id\n";
13082: }
13083: return $result;
13084: }
13085:
13086: ############################################################
13087: ############################################################
13088:
1.566 albertel 13089: sub check_clone {
1.578 raeburn 13090: my ($args,$linefeed) = @_;
1.566 albertel 13091: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
13092: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
13093: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
13094: my $clonemsg;
13095: my $can_clone = 0;
1.944 raeburn 13096: my $lctype = lc($args->{'crstype'});
1.908 raeburn 13097: if ($lctype ne 'community') {
13098: $lctype = 'course';
13099: }
1.566 albertel 13100: if ($clonehome eq 'no_host') {
1.944 raeburn 13101: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13102: $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'});
13103: } else {
13104: $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'});
13105: }
1.566 albertel 13106: } else {
13107: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944 raeburn 13108: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13109: if ($clonedesc{'type'} ne 'Community') {
13110: $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'});
13111: return ($can_clone, $clonemsg, $cloneid, $clonehome);
13112: }
13113: }
1.882 raeburn 13114: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
13115: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 13116: $can_clone = 1;
13117: } else {
13118: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
13119: $args->{'clonedomain'},$args->{'clonecourse'});
13120: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 13121: if (grep(/^\*$/,@cloners)) {
13122: $can_clone = 1;
13123: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
13124: $can_clone = 1;
13125: } else {
1.908 raeburn 13126: my $ccrole = 'cc';
1.944 raeburn 13127: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13128: $ccrole = 'co';
13129: }
1.578 raeburn 13130: my %roleshash =
13131: &Apache::lonnet::get_my_roles($args->{'ccuname'},
13132: $args->{'ccdomain'},
1.908 raeburn 13133: 'userroles',['active'],[$ccrole],
1.578 raeburn 13134: [$args->{'clonedomain'}]);
1.908 raeburn 13135: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942 raeburn 13136: $can_clone = 1;
13137: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
13138: $can_clone = 1;
13139: } else {
1.944 raeburn 13140: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13141: $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'});
13142: } else {
13143: $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'});
13144: }
1.578 raeburn 13145: }
1.566 albertel 13146: }
1.578 raeburn 13147: }
1.566 albertel 13148: }
13149: return ($can_clone, $clonemsg, $cloneid, $clonehome);
13150: }
13151:
1.444 albertel 13152: sub construct_course {
1.885 raeburn 13153: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444 albertel 13154: my $outcome;
1.541 raeburn 13155: my $linefeed = '<br />'."\n";
13156: if ($context eq 'auto') {
13157: $linefeed = "\n";
13158: }
1.566 albertel 13159:
13160: #
13161: # Are we cloning?
13162: #
13163: my ($can_clone, $clonemsg, $cloneid, $clonehome);
13164: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 13165: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 13166: if ($context ne 'auto') {
1.578 raeburn 13167: if ($clonemsg ne '') {
13168: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
13169: }
1.566 albertel 13170: }
13171: $outcome .= $clonemsg.$linefeed;
13172:
13173: if (!$can_clone) {
13174: return (0,$outcome);
13175: }
13176: }
13177:
1.444 albertel 13178: #
13179: # Open course
13180: #
13181: my $crstype = lc($args->{'crstype'});
13182: my %cenv=();
13183: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
13184: $args->{'cdescr'},
13185: $args->{'curl'},
13186: $args->{'course_home'},
13187: $args->{'nonstandard'},
13188: $args->{'crscode'},
13189: $args->{'ccuname'}.':'.
13190: $args->{'ccdomain'},
1.882 raeburn 13191: $args->{'crstype'},
1.885 raeburn 13192: $cnum,$context,$category);
1.444 albertel 13193:
13194: # Note: The testing routines depend on this being output; see
13195: # Utils::Course. This needs to at least be output as a comment
13196: # if anyone ever decides to not show this, and Utils::Course::new
13197: # will need to be suitably modified.
1.541 raeburn 13198: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943 raeburn 13199: if ($$courseid =~ /^error:/) {
13200: return (0,$outcome);
13201: }
13202:
1.444 albertel 13203: #
13204: # Check if created correctly
13205: #
1.479 albertel 13206: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 13207: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 13208: if ($crsuhome eq 'no_host') {
13209: $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
13210: return (0,$outcome);
13211: }
1.541 raeburn 13212: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 13213:
1.444 albertel 13214: #
1.566 albertel 13215: # Do the cloning
13216: #
13217: if ($can_clone && $cloneid) {
13218: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
13219: if ($context ne 'auto') {
13220: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
13221: }
13222: $outcome .= $clonemsg.$linefeed;
13223: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 13224: # Copy all files
1.637 www 13225: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 13226: # Restore URL
1.566 albertel 13227: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 13228: # Restore title
1.566 albertel 13229: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 13230: # Restore creation date, creator and creation context.
13231: $cenv{'internal.created'}=$oldcenv{'internal.created'};
13232: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
13233: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 13234: # Mark as cloned
1.566 albertel 13235: $cenv{'clonedfrom'}=$cloneid;
1.638 www 13236: # Need to clone grading mode
13237: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
13238: $cenv{'grading'}=$newenv{'grading'};
13239: # Do not clone these environment entries
13240: &Apache::lonnet::del('environment',
13241: ['default_enrollment_start_date',
13242: 'default_enrollment_end_date',
13243: 'question.email',
13244: 'policy.email',
13245: 'comment.email',
13246: 'pch.users.denied',
1.725 raeburn 13247: 'plc.users.denied',
13248: 'hidefromcat',
13249: 'categories'],
1.638 www 13250: $$crsudom,$$crsunum);
1.444 albertel 13251: }
1.566 albertel 13252:
1.444 albertel 13253: #
13254: # Set environment (will override cloned, if existing)
13255: #
13256: my @sections = ();
13257: my @xlists = ();
13258: if ($args->{'crstype'}) {
13259: $cenv{'type'}=$args->{'crstype'};
13260: }
13261: if ($args->{'crsid'}) {
13262: $cenv{'courseid'}=$args->{'crsid'};
13263: }
13264: if ($args->{'crscode'}) {
13265: $cenv{'internal.coursecode'}=$args->{'crscode'};
13266: }
13267: if ($args->{'crsquota'} ne '') {
13268: $cenv{'internal.coursequota'}=$args->{'crsquota'};
13269: } else {
13270: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
13271: }
13272: if ($args->{'ccuname'}) {
13273: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
13274: ':'.$args->{'ccdomain'};
13275: } else {
13276: $cenv{'internal.courseowner'} = $args->{'curruser'};
13277: }
13278: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
13279: if ($args->{'crssections'}) {
13280: $cenv{'internal.sectionnums'} = '';
13281: if ($args->{'crssections'} =~ m/,/) {
13282: @sections = split/,/,$args->{'crssections'};
13283: } else {
13284: $sections[0] = $args->{'crssections'};
13285: }
13286: if (@sections > 0) {
13287: foreach my $item (@sections) {
13288: my ($sec,$gp) = split/:/,$item;
13289: my $class = $args->{'crscode'}.$sec;
13290: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
13291: $cenv{'internal.sectionnums'} .= $item.',';
13292: unless ($addcheck eq 'ok') {
13293: push @badclasses, $class;
13294: }
13295: }
13296: $cenv{'internal.sectionnums'} =~ s/,$//;
13297: }
13298: }
13299: # do not hide course coordinator from staff listing,
13300: # even if privileged
13301: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
13302: # add crosslistings
13303: if ($args->{'crsxlist'}) {
13304: $cenv{'internal.crosslistings'}='';
13305: if ($args->{'crsxlist'} =~ m/,/) {
13306: @xlists = split/,/,$args->{'crsxlist'};
13307: } else {
13308: $xlists[0] = $args->{'crsxlist'};
13309: }
13310: if (@xlists > 0) {
13311: foreach my $item (@xlists) {
13312: my ($xl,$gp) = split/:/,$item;
13313: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
13314: $cenv{'internal.crosslistings'} .= $item.',';
13315: unless ($addcheck eq 'ok') {
13316: push @badclasses, $xl;
13317: }
13318: }
13319: $cenv{'internal.crosslistings'} =~ s/,$//;
13320: }
13321: }
13322: if ($args->{'autoadds'}) {
13323: $cenv{'internal.autoadds'}=$args->{'autoadds'};
13324: }
13325: if ($args->{'autodrops'}) {
13326: $cenv{'internal.autodrops'}=$args->{'autodrops'};
13327: }
13328: # check for notification of enrollment changes
13329: my @notified = ();
13330: if ($args->{'notify_owner'}) {
13331: if ($args->{'ccuname'} ne '') {
13332: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
13333: }
13334: }
13335: if ($args->{'notify_dc'}) {
13336: if ($uname ne '') {
1.630 raeburn 13337: push(@notified,$uname.':'.$udom);
1.444 albertel 13338: }
13339: }
13340: if (@notified > 0) {
13341: my $notifylist;
13342: if (@notified > 1) {
13343: $notifylist = join(',',@notified);
13344: } else {
13345: $notifylist = $notified[0];
13346: }
13347: $cenv{'internal.notifylist'} = $notifylist;
13348: }
13349: if (@badclasses > 0) {
13350: my %lt=&Apache::lonlocal::texthash(
13351: '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',
13352: 'dnhr' => 'does not have rights to access enrollment in these classes',
13353: 'adby' => 'as determined by the policies of your institution on access to official classlists'
13354: );
1.541 raeburn 13355: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
13356: ' ('.$lt{'adby'}.')';
13357: if ($context eq 'auto') {
13358: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 13359: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 13360: foreach my $item (@badclasses) {
13361: if ($context eq 'auto') {
13362: $outcome .= " - $item\n";
13363: } else {
13364: $outcome .= "<li>$item</li>\n";
13365: }
13366: }
13367: if ($context eq 'auto') {
13368: $outcome .= $linefeed;
13369: } else {
1.566 albertel 13370: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 13371: }
13372: }
1.444 albertel 13373: }
13374: if ($args->{'no_end_date'}) {
13375: $args->{'endaccess'} = 0;
13376: }
13377: $cenv{'internal.autostart'}=$args->{'enrollstart'};
13378: $cenv{'internal.autoend'}=$args->{'enrollend'};
13379: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
13380: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
13381: if ($args->{'showphotos'}) {
13382: $cenv{'internal.showphotos'}=$args->{'showphotos'};
13383: }
13384: $cenv{'internal.authtype'} = $args->{'authtype'};
13385: $cenv{'internal.autharg'} = $args->{'autharg'};
13386: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
13387: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 13388: 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');
13389: if ($context eq 'auto') {
13390: $outcome .= $krb_msg;
13391: } else {
1.566 albertel 13392: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 13393: }
13394: $outcome .= $linefeed;
1.444 albertel 13395: }
13396: }
13397: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
13398: if ($args->{'setpolicy'}) {
13399: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
13400: }
13401: if ($args->{'setcontent'}) {
13402: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
13403: }
13404: }
13405: if ($args->{'reshome'}) {
13406: $cenv{'reshome'}=$args->{'reshome'}.'/';
13407: $cenv{'reshome'}=~s/\/+$/\//;
13408: }
13409: #
13410: # course has keyed access
13411: #
13412: if ($args->{'setkeys'}) {
13413: $cenv{'keyaccess'}='yes';
13414: }
13415: # if specified, key authority is not course, but user
13416: # only active if keyaccess is yes
13417: if ($args->{'keyauth'}) {
1.487 albertel 13418: my ($user,$domain) = split(':',$args->{'keyauth'});
13419: $user = &LONCAPA::clean_username($user);
13420: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 13421: if ($user ne '' && $domain ne '') {
1.487 albertel 13422: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 13423: }
13424: }
13425:
13426: if ($args->{'disresdis'}) {
13427: $cenv{'pch.roles.denied'}='st';
13428: }
13429: if ($args->{'disablechat'}) {
13430: $cenv{'plc.roles.denied'}='st';
13431: }
13432:
13433: # Record we've not yet viewed the Course Initialization Helper for this
13434: # course
13435: $cenv{'course.helper.not.run'} = 1;
13436: #
13437: # Use new Randomseed
13438: #
13439: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
13440: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
13441: #
13442: # The encryption code and receipt prefix for this course
13443: #
13444: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
13445: $cenv{'internal.encpref'}=100+int(9*rand(99));
13446: #
13447: # By default, use standard grading
13448: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
13449:
1.541 raeburn 13450: $outcome .= $linefeed.&mt('Setting environment').': '.
13451: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 13452: #
13453: # Open all assignments
13454: #
13455: if ($args->{'openall'}) {
13456: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
13457: my %storecontent = ($storeunder => time,
13458: $storeunder.'.type' => 'date_start');
13459:
13460: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 13461: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 13462: }
13463: #
13464: # Set first page
13465: #
13466: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
13467: || ($cloneid)) {
1.445 albertel 13468: use LONCAPA::map;
1.444 albertel 13469: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 13470:
13471: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
13472: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
13473:
1.444 albertel 13474: $outcome .= ($fatal?$errtext:'read ok').' - ';
13475: my $title; my $url;
13476: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 13477: $title=&mt('Syllabus');
1.444 albertel 13478: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
13479: } else {
1.963 raeburn 13480: $title=&mt('Table of Contents');
1.444 albertel 13481: $url='/adm/navmaps';
13482: }
1.445 albertel 13483:
13484: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
13485: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
13486:
13487: if ($errtext) { $fatal=2; }
1.541 raeburn 13488: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 13489: }
1.566 albertel 13490:
13491: return (1,$outcome);
1.444 albertel 13492: }
13493:
13494: ############################################################
13495: ############################################################
13496:
1.953 droeschl 13497: #SD
13498: # only Community and Course, or anything else?
1.378 raeburn 13499: sub course_type {
13500: my ($cid) = @_;
13501: if (!defined($cid)) {
13502: $cid = $env{'request.course.id'};
13503: }
1.404 albertel 13504: if (defined($env{'course.'.$cid.'.type'})) {
13505: return $env{'course.'.$cid.'.type'};
1.378 raeburn 13506: } else {
13507: return 'Course';
1.377 raeburn 13508: }
13509: }
1.156 albertel 13510:
1.406 raeburn 13511: sub group_term {
13512: my $crstype = &course_type();
13513: my %names = (
13514: 'Course' => 'group',
1.865 raeburn 13515: 'Community' => 'group',
1.406 raeburn 13516: );
13517: return $names{$crstype};
13518: }
13519:
1.902 raeburn 13520: sub course_types {
13521: my @types = ('official','unofficial','community');
13522: my %typename = (
13523: official => 'Official course',
13524: unofficial => 'Unofficial course',
13525: community => 'Community',
13526: );
13527: return (\@types,\%typename);
13528: }
13529:
1.156 albertel 13530: sub icon {
13531: my ($file)=@_;
1.505 albertel 13532: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 13533: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 13534: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 13535: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
13536: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
13537: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
13538: $curfext.".gif") {
13539: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
13540: $curfext.".gif";
13541: }
13542: }
1.249 albertel 13543: return &lonhttpdurl($iconname);
1.154 albertel 13544: }
1.84 albertel 13545:
1.575 albertel 13546: sub lonhttpdurl {
1.692 www 13547: #
13548: # Had been used for "small fry" static images on separate port 8080.
13549: # Modify here if lightweight http functionality desired again.
13550: # Currently eliminated due to increasing firewall issues.
13551: #
1.575 albertel 13552: my ($url)=@_;
1.692 www 13553: return $url;
1.215 albertel 13554: }
13555:
1.213 albertel 13556: sub connection_aborted {
13557: my ($r)=@_;
13558: $r->print(" ");$r->rflush();
13559: my $c = $r->connection;
13560: return $c->aborted();
13561: }
13562:
1.221 foxr 13563: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 13564: # strings as 'strings'.
13565: sub escape_single {
1.221 foxr 13566: my ($input) = @_;
1.223 albertel 13567: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 13568: $input =~ s/\'/\\\'/g; # Esacpe the 's....
13569: return $input;
13570: }
1.223 albertel 13571:
1.222 foxr 13572: # Same as escape_single, but escape's "'s This
13573: # can be used for "strings"
13574: sub escape_double {
13575: my ($input) = @_;
13576: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
13577: $input =~ s/\"/\\\"/g; # Esacpe the "s....
13578: return $input;
13579: }
1.223 albertel 13580:
1.222 foxr 13581: # Escapes the last element of a full URL.
13582: sub escape_url {
13583: my ($url) = @_;
1.238 raeburn 13584: my @urlslices = split(/\//, $url,-1);
1.369 www 13585: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 13586: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 13587: }
1.462 albertel 13588:
1.820 raeburn 13589: sub compare_arrays {
13590: my ($arrayref1,$arrayref2) = @_;
13591: my (@difference,%count);
13592: @difference = ();
13593: %count = ();
13594: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
13595: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
13596: foreach my $element (keys(%count)) {
13597: if ($count{$element} == 1) {
13598: push(@difference,$element);
13599: }
13600: }
13601: }
13602: return @difference;
13603: }
13604:
1.817 bisitz 13605: # -------------------------------------------------------- Initialize user login
1.462 albertel 13606: sub init_user_environment {
1.463 albertel 13607: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 13608: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
13609:
13610: my $public=($username eq 'public' && $domain eq 'public');
13611:
13612: # See if old ID present, if so, remove
13613:
1.1062 raeburn 13614: my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462 albertel 13615: my $now=time;
13616:
13617: if ($public) {
13618: my $max_public=100;
13619: my $oldest;
13620: my $oldest_time=0;
13621: for(my $next=1;$next<=$max_public;$next++) {
13622: if (-e $lonids."/publicuser_$next.id") {
13623: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
13624: if ($mtime<$oldest_time || !$oldest_time) {
13625: $oldest_time=$mtime;
13626: $oldest=$next;
13627: }
13628: } else {
13629: $cookie="publicuser_$next";
13630: last;
13631: }
13632: }
13633: if (!$cookie) { $cookie="publicuser_$oldest"; }
13634: } else {
1.463 albertel 13635: # if this isn't a robot, kill any existing non-robot sessions
13636: if (!$args->{'robot'}) {
13637: opendir(DIR,$lonids);
13638: while ($filename=readdir(DIR)) {
13639: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
13640: unlink($lonids.'/'.$filename);
13641: }
1.462 albertel 13642: }
1.463 albertel 13643: closedir(DIR);
1.462 albertel 13644: }
13645: # Give them a new cookie
1.463 albertel 13646: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 13647: : $now.$$.int(rand(10000)));
1.463 albertel 13648: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 13649:
13650: # Initialize roles
13651:
1.1062 raeburn 13652: ($userroles,$firstaccenv,$timerintenv) =
13653: &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462 albertel 13654: }
13655: # ------------------------------------ Check browser type and MathML capability
13656:
13657: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
13658: $clientunicode,$clientos) = &decode_user_agent($r);
13659:
13660: # ------------------------------------------------------------- Get environment
13661:
13662: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
13663: my ($tmp) = keys(%userenv);
13664: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
13665: } else {
13666: undef(%userenv);
13667: }
13668: if (($userenv{'interface'}) && (!$form->{'interface'})) {
13669: $form->{'interface'}=$userenv{'interface'};
13670: }
13671: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
13672:
13673: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 13674: foreach my $option ('interface','localpath','localres') {
13675: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 13676: }
13677: # --------------------------------------------------------- Write first profile
13678:
13679: {
13680: my %initial_env =
13681: ("user.name" => $username,
13682: "user.domain" => $domain,
13683: "user.home" => $authhost,
13684: "browser.type" => $clientbrowser,
13685: "browser.version" => $clientversion,
13686: "browser.mathml" => $clientmathml,
13687: "browser.unicode" => $clientunicode,
13688: "browser.os" => $clientos,
13689: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
13690: "request.course.fn" => '',
13691: "request.course.uri" => '',
13692: "request.course.sec" => '',
13693: "request.role" => 'cm',
13694: "request.role.adv" => $env{'user.adv'},
13695: "request.host" => $ENV{'REMOTE_ADDR'},);
13696:
13697: if ($form->{'localpath'}) {
13698: $initial_env{"browser.localpath"} = $form->{'localpath'};
13699: $initial_env{"browser.localres"} = $form->{'localres'};
13700: }
13701:
13702: if ($form->{'interface'}) {
13703: $form->{'interface'}=~s/\W//gs;
13704: $initial_env{"browser.interface"} = $form->{'interface'};
13705: $env{'browser.interface'}=$form->{'interface'};
13706: }
13707:
1.981 raeburn 13708: my %is_adv = ( is_adv => $env{'user.adv'} );
1.1016 raeburn 13709: my %domdef;
13710: unless ($domain eq 'public') {
13711: %domdef = &Apache::lonnet::get_domain_defaults($domain);
13712: }
1.980 raeburn 13713:
1.724 raeburn 13714: foreach my $tool ('aboutme','blog','portfolio') {
13715: $userenv{'availabletools.'.$tool} =
1.980 raeburn 13716: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
13717: undef,\%userenv,\%domdef,\%is_adv);
1.724 raeburn 13718: }
13719:
1.864 raeburn 13720: foreach my $crstype ('official','unofficial','community') {
1.765 raeburn 13721: $userenv{'canrequest.'.$crstype} =
13722: &Apache::lonnet::usertools_access($username,$domain,$crstype,
1.980 raeburn 13723: 'reload','requestcourses',
13724: \%userenv,\%domdef,\%is_adv);
1.765 raeburn 13725: }
13726:
1.462 albertel 13727: $env{'user.environment'} = "$lonids/$cookie.id";
1.1062 raeburn 13728:
1.462 albertel 13729: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
13730: &GDBM_WRCREAT(),0640)) {
13731: &_add_to_env(\%disk_env,\%initial_env);
13732: &_add_to_env(\%disk_env,\%userenv,'environment.');
13733: &_add_to_env(\%disk_env,$userroles);
1.1062 raeburn 13734: if (ref($firstaccenv) eq 'HASH') {
13735: &_add_to_env(\%disk_env,$firstaccenv);
13736: }
13737: if (ref($timerintenv) eq 'HASH') {
13738: &_add_to_env(\%disk_env,$timerintenv);
13739: }
1.463 albertel 13740: if (ref($args->{'extra_env'})) {
13741: &_add_to_env(\%disk_env,$args->{'extra_env'});
13742: }
1.462 albertel 13743: untie(%disk_env);
13744: } else {
1.705 tempelho 13745: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
13746: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 13747: return 'error: '.$!;
13748: }
13749: }
13750: $env{'request.role'}='cm';
13751: $env{'request.role.adv'}=$env{'user.adv'};
13752: $env{'browser.type'}=$clientbrowser;
13753:
13754: return $cookie;
13755:
13756: }
13757:
13758: sub _add_to_env {
13759: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 13760: if (ref($env_data) eq 'HASH') {
13761: while (my ($key,$value) = each(%$env_data)) {
13762: $idf->{$prefix.$key} = $value;
13763: $env{$prefix.$key} = $value;
13764: }
1.462 albertel 13765: }
13766: }
13767:
1.685 tempelho 13768: # --- Get the symbolic name of a problem and the url
13769: sub get_symb {
13770: my ($request,$silent) = @_;
1.726 raeburn 13771: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 13772: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
13773: if ($symb eq '') {
13774: if (!$silent) {
1.1071 raeburn 13775: if (ref($request)) {
13776: $request->print("Unable to handle ambiguous references:$url:.");
13777: }
1.685 tempelho 13778: return ();
13779: }
13780: }
13781: &Apache::lonenc::check_decrypt(\$symb);
13782: return ($symb);
13783: }
13784:
13785: # --------------------------------------------------------------Get annotation
13786:
13787: sub get_annotation {
13788: my ($symb,$enc) = @_;
13789:
13790: my $key = $symb;
13791: if (!$enc) {
13792: $key =
13793: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
13794: }
13795: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
13796: return $annotation{$key};
13797: }
13798:
13799: sub clean_symb {
1.731 raeburn 13800: my ($symb,$delete_enc) = @_;
1.685 tempelho 13801:
13802: &Apache::lonenc::check_decrypt(\$symb);
13803: my $enc = $env{'request.enc'};
1.731 raeburn 13804: if ($delete_enc) {
1.730 raeburn 13805: delete($env{'request.enc'});
13806: }
1.685 tempelho 13807:
13808: return ($symb,$enc);
13809: }
1.462 albertel 13810:
1.990 raeburn 13811: sub build_release_hashes {
13812: my ($checkparms,$checkresponsetypes,$checkcrstypes,$anonsurvey,$randomizetry) = @_;
13813: return unless((ref($checkparms) eq 'HASH') && (ref($checkresponsetypes) eq 'HASH') &&
13814: (ref($checkcrstypes) eq 'HASH') && (ref($anonsurvey) eq 'HASH') &&
13815: (ref($randomizetry) eq 'HASH'));
13816: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
13817: my ($item,$name,$value) = split(/:/,$key);
13818: if ($item eq 'parameter') {
13819: if (ref($checkparms->{$name}) eq 'ARRAY') {
13820: unless(grep(/^\Q$name\E$/,@{$checkparms->{$name}})) {
13821: push(@{$checkparms->{$name}},$value);
13822: }
13823: } else {
13824: push(@{$checkparms->{$name}},$value);
13825: }
13826: } elsif ($item eq 'resourcetag') {
13827: if ($name eq 'responsetype') {
13828: $checkresponsetypes->{$value} = $Apache::lonnet::needsrelease{$key}
13829: }
13830: } elsif ($item eq 'course') {
13831: if ($name eq 'crstype') {
13832: $checkcrstypes->{$value} = $Apache::lonnet::needsrelease{$key};
13833: }
13834: }
13835: }
13836: ($anonsurvey->{major},$anonsurvey->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:anonsurvey'});
13837: ($randomizetry->{major},$randomizetry->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:randomizetry'});
13838: return;
13839: }
13840:
1.41 ng 13841: =pod
13842:
13843: =back
13844:
1.112 bowersj2 13845: =cut
1.41 ng 13846:
1.112 bowersj2 13847: 1;
13848: __END__;
1.41 ng 13849:
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