Annotation of loncom/interface/loncommon.pm, revision 1.1081
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1081 ! raeburn 4: # $Id: loncommon.pm,v 1.1080 2012/05/28 20:31:17 raeburn Exp $
1.10 albertel 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.1 albertel 28:
29: # Makes a table out of the previous attempts
1.2 albertel 30: # Inputs result_from_symbread, user, domain, course_id
1.16 harris41 31: # Reads in non-network-related .tab files
1.1 albertel 32:
1.35 matthew 33: # POD header:
34:
1.45 matthew 35: =pod
36:
1.35 matthew 37: =head1 NAME
38:
39: Apache::loncommon - pile of common routines
40:
41: =head1 SYNOPSIS
42:
1.112 bowersj2 43: Common routines for manipulating connections, student answers,
44: domains, common Javascript fragments, etc.
1.35 matthew 45:
1.112 bowersj2 46: =head1 OVERVIEW
1.35 matthew 47:
1.112 bowersj2 48: A collection of commonly used subroutines that don't have a natural
49: home anywhere else. This collection helps remove
1.35 matthew 50: redundancy from other modules and increase efficiency of memory usage.
51:
52: =cut
53:
54: # End of POD header
1.1 albertel 55: package Apache::loncommon;
56:
57: use strict;
1.258 albertel 58: use Apache::lonnet;
1.46 matthew 59: use GDBM_File;
1.51 www 60: use POSIX qw(strftime mktime);
1.82 www 61: use Apache::lonmenu();
1.498 albertel 62: use Apache::lonenc();
1.117 www 63: use Apache::lonlocal;
1.685 tempelho 64: use Apache::lonnet();
1.139 matthew 65: use HTML::Entities;
1.334 albertel 66: use Apache::lonhtmlcommon();
67: use Apache::loncoursedata();
1.344 albertel 68: use Apache::lontexconvert();
1.444 albertel 69: use Apache::lonclonecourse();
1.479 albertel 70: use LONCAPA qw(:DEFAULT :match);
1.657 raeburn 71: use DateTime::TimeZone;
1.687 raeburn 72: use DateTime::Locale::Catalog;
1.117 www 73:
1.517 raeburn 74: # ---------------------------------------------- Designs
75: use vars qw(%defaultdesign);
76:
1.22 www 77: my $readit;
78:
1.517 raeburn 79:
1.157 matthew 80: ##
81: ## Global Variables
82: ##
1.46 matthew 83:
1.643 foxr 84:
85: # ----------------------------------------------- SSI with retries:
86: #
87:
88: =pod
89:
1.648 raeburn 90: =head1 Server Side include with retries:
1.643 foxr 91:
92: =over 4
93:
1.648 raeburn 94: =item * &ssi_with_retries(resource,retries form)
1.643 foxr 95:
96: Performs an ssi with some number of retries. Retries continue either
97: until the result is ok or until the retry count supplied by the
98: caller is exhausted.
99:
100: Inputs:
1.648 raeburn 101:
102: =over 4
103:
1.643 foxr 104: resource - Identifies the resource to insert.
1.648 raeburn 105:
1.643 foxr 106: retries - Count of the number of retries allowed.
1.648 raeburn 107:
1.643 foxr 108: form - Hash that identifies the rendering options.
109:
1.648 raeburn 110: =back
111:
112: Returns:
113:
114: =over 4
115:
1.643 foxr 116: content - The content of the response. If retries were exhausted this is empty.
1.648 raeburn 117:
1.643 foxr 118: response - The response from the last attempt (which may or may not have been successful.
119:
1.648 raeburn 120: =back
121:
122: =back
123:
1.643 foxr 124: =cut
125:
126: sub ssi_with_retries {
127: my ($resource, $retries, %form) = @_;
128:
129:
130: my $ok = 0; # True if we got a good response.
131: my $content;
132: my $response;
133:
134: # Try to get the ssi done. within the retries count:
135:
136: do {
137: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
138: $ok = $response->is_success;
1.650 www 139: if (!$ok) {
140: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
141: }
1.643 foxr 142: $retries--;
143: } while (!$ok && ($retries > 0));
144:
145: if (!$ok) {
146: $content = ''; # On error return an empty content.
147: }
148: return ($content, $response);
149:
150: }
151:
152:
153:
1.20 www 154: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 155: my %language;
1.124 www 156: my %supported_language;
1.1048 foxr 157: my %latex_language; # For choosing hyphenation in <transl..>
158: my %latex_language_bykey; # for choosing hyphenation from metadata
1.12 harris41 159: my %cprtag;
1.192 taceyjo1 160: my %scprtag;
1.351 www 161: my %fe; my %fd; my %fm;
1.41 ng 162: my %category_extensions;
1.12 harris41 163:
1.46 matthew 164: # ---------------------------------------------- Thesaurus variables
1.144 matthew 165: #
166: # %Keywords:
167: # A hash used by &keyword to determine if a word is considered a keyword.
168: # $thesaurus_db_file
169: # Scalar containing the full path to the thesaurus database.
1.46 matthew 170:
171: my %Keywords;
172: my $thesaurus_db_file;
173:
1.144 matthew 174: #
175: # Initialize values from language.tab, copyright.tab, filetypes.tab,
176: # thesaurus.tab, and filecategories.tab.
177: #
1.18 www 178: BEGIN {
1.46 matthew 179: # Variable initialization
180: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
181: #
1.22 www 182: unless ($readit) {
1.12 harris41 183: # ------------------------------------------------------------------- languages
184: {
1.158 raeburn 185: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
186: '/language.tab';
187: if ( open(my $fh,"<$langtabfile") ) {
1.356 albertel 188: while (my $line = <$fh>) {
189: next if ($line=~/^\#/);
190: chomp($line);
1.1048 foxr 191: my ($key,$two,$country,$three,$enc,$val,$sup,$latex)=(split(/\t/,$line));
1.158 raeburn 192: $language{$key}=$val.' - '.$enc;
193: if ($sup) {
194: $supported_language{$key}=$sup;
195: }
1.1048 foxr 196: if ($latex) {
197: $latex_language_bykey{$key} = $latex;
198: $latex_language{$two} = $latex;
199: }
1.158 raeburn 200: }
201: close($fh);
202: }
1.12 harris41 203: }
204: # ------------------------------------------------------------------ copyrights
205: {
1.158 raeburn 206: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
207: '/copyright.tab';
208: if ( open (my $fh,"<$copyrightfile") ) {
1.356 albertel 209: while (my $line = <$fh>) {
210: next if ($line=~/^\#/);
211: chomp($line);
212: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 213: $cprtag{$key}=$val;
214: }
215: close($fh);
216: }
1.12 harris41 217: }
1.351 www 218: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 219: {
220: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
221: '/source_copyright.tab';
222: if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356 albertel 223: while (my $line = <$fh>) {
224: next if ($line =~ /^\#/);
225: chomp($line);
226: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 227: $scprtag{$key}=$val;
228: }
229: close($fh);
230: }
231: }
1.63 www 232:
1.517 raeburn 233: # -------------------------------------------------------------- default domain designs
1.63 www 234: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 235: my $designfile = $designdir.'/default.tab';
236: if ( open (my $fh,"<$designfile") ) {
237: while (my $line = <$fh>) {
238: next if ($line =~ /^\#/);
239: chomp($line);
240: my ($key,$val)=(split(/\=/,$line));
241: if ($val) { $defaultdesign{$key}=$val; }
242: }
243: close($fh);
1.63 www 244: }
245:
1.15 harris41 246: # ------------------------------------------------------------- file categories
247: {
1.158 raeburn 248: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
249: '/filecategories.tab';
250: if ( open (my $fh,"<$categoryfile") ) {
1.356 albertel 251: while (my $line = <$fh>) {
252: next if ($line =~ /^\#/);
253: chomp($line);
254: my ($extension,$category)=(split(/\s+/,$line,2));
1.158 raeburn 255: push @{$category_extensions{lc($category)}},$extension;
256: }
257: close($fh);
258: }
259:
1.15 harris41 260: }
1.12 harris41 261: # ------------------------------------------------------------------ file types
262: {
1.158 raeburn 263: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
264: '/filetypes.tab';
265: if ( open (my $fh,"<$typesfile") ) {
1.356 albertel 266: while (my $line = <$fh>) {
267: next if ($line =~ /^\#/);
268: chomp($line);
269: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 270: if ($descr ne '') {
271: $fe{$ending}=lc($emb);
272: $fd{$ending}=$descr;
1.351 www 273: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 274: }
275: }
276: close($fh);
277: }
1.12 harris41 278: }
1.22 www 279: &Apache::lonnet::logthis(
1.705 tempelho 280: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 281: $readit=1;
1.46 matthew 282: } # end of unless($readit)
1.32 matthew 283:
284: }
1.112 bowersj2 285:
1.42 matthew 286: ###############################################################
287: ## HTML and Javascript Helper Functions ##
288: ###############################################################
289:
290: =pod
291:
1.112 bowersj2 292: =head1 HTML and Javascript Functions
1.42 matthew 293:
1.112 bowersj2 294: =over 4
295:
1.648 raeburn 296: =item * &browser_and_searcher_javascript()
1.112 bowersj2 297:
298: X<browsing, javascript>X<searching, javascript>Returns a string
299: containing javascript with two functions, C<openbrowser> and
300: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
301: tags.
1.42 matthew 302:
1.648 raeburn 303: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 304:
305: inputs: formname, elementname, only, omit
306:
307: formname and elementname indicate the name of the html form and name of
308: the element that the results of the browsing selection are to be placed in.
309:
310: Specifying 'only' will restrict the browser to displaying only files
1.185 www 311: with the given extension. Can be a comma separated list.
1.42 matthew 312:
313: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 314: with the given extension. Can be a comma separated list.
1.42 matthew 315:
1.648 raeburn 316: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 317:
318: Inputs: formname, elementname
319:
320: formname and elementname specify the name of the html form and the name
321: of the element the selection from the search results will be placed in.
1.542 raeburn 322:
1.42 matthew 323: =cut
324:
325: sub browser_and_searcher_javascript {
1.199 albertel 326: my ($mode)=@_;
327: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 328: my $resurl=&escape_single(&lastresurl());
1.42 matthew 329: return <<END;
1.219 albertel 330: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 331: var editbrowser = null;
1.135 albertel 332: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 333: var url = '$resurl/?';
1.42 matthew 334: if (editbrowser == null) {
335: url += 'launch=1&';
336: }
337: url += 'catalogmode=interactive&';
1.199 albertel 338: url += 'mode=$mode&';
1.611 albertel 339: url += 'inhibitmenu=yes&';
1.42 matthew 340: url += 'form=' + formname + '&';
341: if (only != null) {
342: url += 'only=' + only + '&';
1.217 albertel 343: } else {
344: url += 'only=&';
345: }
1.42 matthew 346: if (omit != null) {
347: url += 'omit=' + omit + '&';
1.217 albertel 348: } else {
349: url += 'omit=&';
350: }
1.135 albertel 351: if (titleelement != null) {
352: url += 'titleelement=' + titleelement + '&';
1.217 albertel 353: } else {
354: url += 'titleelement=&';
355: }
1.42 matthew 356: url += 'element=' + elementname + '';
357: var title = 'Browser';
1.435 albertel 358: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 359: options += ',width=700,height=600';
360: editbrowser = open(url,title,options,'1');
361: editbrowser.focus();
362: }
363: var editsearcher;
1.135 albertel 364: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 365: var url = '/adm/searchcat?';
366: if (editsearcher == null) {
367: url += 'launch=1&';
368: }
369: url += 'catalogmode=interactive&';
1.199 albertel 370: url += 'mode=$mode&';
1.42 matthew 371: url += 'form=' + formname + '&';
1.135 albertel 372: if (titleelement != null) {
373: url += 'titleelement=' + titleelement + '&';
1.217 albertel 374: } else {
375: url += 'titleelement=&';
376: }
1.42 matthew 377: url += 'element=' + elementname + '';
378: var title = 'Search';
1.435 albertel 379: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 380: options += ',width=700,height=600';
381: editsearcher = open(url,title,options,'1');
382: editsearcher.focus();
383: }
1.219 albertel 384: // END LON-CAPA Internal -->
1.42 matthew 385: END
1.170 www 386: }
387:
388: sub lastresurl {
1.258 albertel 389: if ($env{'environment.lastresurl'}) {
390: return $env{'environment.lastresurl'}
1.170 www 391: } else {
392: return '/res';
393: }
394: }
395:
396: sub storeresurl {
397: my $resurl=&Apache::lonnet::clutter(shift);
398: unless ($resurl=~/^\/res/) { return 0; }
399: $resurl=~s/\/$//;
400: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 401: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 402: return 1;
1.42 matthew 403: }
404:
1.74 www 405: sub studentbrowser_javascript {
1.111 www 406: unless (
1.258 albertel 407: (($env{'request.course.id'}) &&
1.302 albertel 408: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
409: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
410: '/'.$env{'request.course.sec'})
411: ))
1.258 albertel 412: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 413: ) { return ''; }
1.74 www 414: return (<<'ENDSTDBRW');
1.776 bisitz 415: <script type="text/javascript" language="Javascript">
1.824 bisitz 416: // <![CDATA[
1.74 www 417: var stdeditbrowser;
1.999 www 418: function openstdbrowser(formname,uname,udom,clicker,roleflag,ignorefilter,courseadvonly) {
1.74 www 419: var url = '/adm/pickstudent?';
420: var filter;
1.558 albertel 421: if (!ignorefilter) {
422: eval('filter=document.'+formname+'.'+uname+'.value;');
423: }
1.74 www 424: if (filter != null) {
425: if (filter != '') {
426: url += 'filter='+filter+'&';
427: }
428: }
429: url += 'form=' + formname + '&unameelement='+uname+
1.999 www 430: '&udomelement='+udom+
431: '&clicker='+clicker;
1.111 www 432: if (roleflag) { url+="&roles=1"; }
1.793 raeburn 433: if (courseadvonly) { url+="&courseadvonly=1"; }
1.102 www 434: var title = 'Student_Browser';
1.74 www 435: var options = 'scrollbars=1,resizable=1,menubar=0';
436: options += ',width=700,height=600';
437: stdeditbrowser = open(url,title,options,'1');
438: stdeditbrowser.focus();
439: }
1.824 bisitz 440: // ]]>
1.74 www 441: </script>
442: ENDSTDBRW
443: }
1.42 matthew 444:
1.1003 www 445: sub resourcebrowser_javascript {
446: unless ($env{'request.course.id'}) { return ''; }
1.1004 www 447: return (<<'ENDRESBRW');
1.1003 www 448: <script type="text/javascript" language="Javascript">
449: // <![CDATA[
450: var reseditbrowser;
1.1004 www 451: function openresbrowser(formname,reslink) {
1.1005 www 452: var url = '/adm/pickresource?form='+formname+'&reslink='+reslink;
1.1003 www 453: var title = 'Resource_Browser';
454: var options = 'scrollbars=1,resizable=1,menubar=0';
1.1005 www 455: options += ',width=700,height=500';
1.1004 www 456: reseditbrowser = open(url,title,options,'1');
457: reseditbrowser.focus();
1.1003 www 458: }
459: // ]]>
460: </script>
1.1004 www 461: ENDRESBRW
1.1003 www 462: }
463:
1.74 www 464: sub selectstudent_link {
1.999 www 465: my ($form,$unameele,$udomele,$courseadvonly,$clickerid)=@_;
466: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
467: &Apache::lonhtmlcommon::entity_encode($unameele)."','".
468: &Apache::lonhtmlcommon::entity_encode($udomele)."'";
1.258 albertel 469: if ($env{'request.course.id'}) {
1.302 albertel 470: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
471: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
472: '/'.$env{'request.course.sec'})) {
1.111 www 473: return '';
474: }
1.999 www 475: $callargs.=",'".&Apache::lonhtmlcommon::entity_encode($clickerid)."'";
1.793 raeburn 476: if ($courseadvonly) {
477: $callargs .= ",'',1,1";
478: }
479: return '<span class="LC_nobreak">'.
480: '<a href="javascript:openstdbrowser('.$callargs.');">'.
481: &mt('Select User').'</a></span>';
1.74 www 482: }
1.258 albertel 483: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.1012 www 484: $callargs .= ",'',1";
1.793 raeburn 485: return '<span class="LC_nobreak">'.
486: '<a href="javascript:openstdbrowser('.$callargs.');">'.
487: &mt('Select User').'</a></span>';
1.111 www 488: }
489: return '';
1.91 www 490: }
491:
1.1004 www 492: sub selectresource_link {
493: my ($form,$reslink,$arg)=@_;
494:
495: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
496: &Apache::lonhtmlcommon::entity_encode($reslink)."'";
497: unless ($env{'request.course.id'}) { return $arg; }
498: return '<span class="LC_nobreak">'.
499: '<a href="javascript:openresbrowser('.$callargs.');">'.
500: $arg.'</a></span>';
501: }
502:
503:
504:
1.653 raeburn 505: sub authorbrowser_javascript {
506: return <<"ENDAUTHORBRW";
1.776 bisitz 507: <script type="text/javascript" language="JavaScript">
1.824 bisitz 508: // <![CDATA[
1.653 raeburn 509: var stdeditbrowser;
510:
511: function openauthorbrowser(formname,udom) {
512: var url = '/adm/pickauthor?';
513: url += 'form='+formname+'&roledom='+udom;
514: var title = 'Author_Browser';
515: var options = 'scrollbars=1,resizable=1,menubar=0';
516: options += ',width=700,height=600';
517: stdeditbrowser = open(url,title,options,'1');
518: stdeditbrowser.focus();
519: }
520:
1.824 bisitz 521: // ]]>
1.653 raeburn 522: </script>
523: ENDAUTHORBRW
524: }
525:
1.91 www 526: sub coursebrowser_javascript {
1.909 raeburn 527: my ($domainfilter,$sec_element,$formname,$role_element,$crstype) = @_;
1.932 raeburn 528: my $wintitle = 'Course_Browser';
1.931 raeburn 529: if ($crstype eq 'Community') {
1.932 raeburn 530: $wintitle = 'Community_Browser';
1.909 raeburn 531: }
1.876 raeburn 532: my $id_functions = &javascript_index_functions();
533: my $output = '
1.776 bisitz 534: <script type="text/javascript" language="JavaScript">
1.824 bisitz 535: // <![CDATA[
1.468 raeburn 536: var stdeditbrowser;'."\n";
1.876 raeburn 537:
538: $output .= <<"ENDSTDBRW";
1.909 raeburn 539: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91 www 540: var url = '/adm/pickcourse?';
1.895 raeburn 541: var formid = getFormIdByName(formname);
1.876 raeburn 542: var domainfilter = getDomainFromSelectbox(formname,udom);
1.128 albertel 543: if (domainfilter != null) {
544: if (domainfilter != '') {
545: url += 'domainfilter='+domainfilter+'&';
546: }
547: }
1.91 www 548: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 549: '&cdomelement='+udom+
550: '&cnameelement='+desc;
1.468 raeburn 551: if (extra_element !=null && extra_element != '') {
1.594 raeburn 552: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 553: url += '&roleelement='+extra_element;
554: if (domainfilter == null || domainfilter == '') {
555: url += '&domainfilter='+extra_element;
556: }
1.234 raeburn 557: }
1.468 raeburn 558: else {
559: if (formname == 'portform') {
560: url += '&setroles='+extra_element;
1.800 raeburn 561: } else {
562: if (formname == 'rules') {
563: url += '&fixeddom='+extra_element;
564: }
1.468 raeburn 565: }
566: }
1.230 raeburn 567: }
1.909 raeburn 568: if (type != null && type != '') {
569: url += '&type='+type;
570: }
571: if (type_elem != null && type_elem != '') {
572: url += '&typeelement='+type_elem;
573: }
1.872 raeburn 574: if (formname == 'ccrs') {
575: var ownername = document.forms[formid].ccuname.value;
576: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
577: url += '&cloner='+ownername+':'+ownerdom;
578: }
1.293 raeburn 579: if (multflag !=null && multflag != '') {
580: url += '&multiple='+multflag;
581: }
1.909 raeburn 582: var title = '$wintitle';
1.91 www 583: var options = 'scrollbars=1,resizable=1,menubar=0';
584: options += ',width=700,height=600';
585: stdeditbrowser = open(url,title,options,'1');
586: stdeditbrowser.focus();
587: }
1.876 raeburn 588: $id_functions
589: ENDSTDBRW
1.905 raeburn 590: if (($sec_element ne '') || ($role_element ne '')) {
591: $output .= &setsec_javascript($sec_element,$formname,$role_element);
1.876 raeburn 592: }
593: $output .= '
594: // ]]>
595: </script>';
596: return $output;
597: }
598:
599: sub javascript_index_functions {
600: return <<"ENDJS";
601:
602: function getFormIdByName(formname) {
603: for (var i=0;i<document.forms.length;i++) {
604: if (document.forms[i].name == formname) {
605: return i;
606: }
607: }
608: return -1;
609: }
610:
611: function getIndexByName(formid,item) {
612: for (var i=0;i<document.forms[formid].elements.length;i++) {
613: if (document.forms[formid].elements[i].name == item) {
614: return i;
615: }
616: }
617: return -1;
618: }
1.468 raeburn 619:
1.876 raeburn 620: function getDomainFromSelectbox(formname,udom) {
621: var userdom;
622: var formid = getFormIdByName(formname);
623: if (formid > -1) {
624: var domid = getIndexByName(formid,udom);
625: if (domid > -1) {
626: if (document.forms[formid].elements[domid].type == 'select-one') {
627: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
628: }
629: if (document.forms[formid].elements[domid].type == 'hidden') {
630: userdom=document.forms[formid].elements[domid].value;
1.468 raeburn 631: }
632: }
633: }
1.876 raeburn 634: return userdom;
635: }
636:
637: ENDJS
1.468 raeburn 638:
1.876 raeburn 639: }
640:
1.1017 raeburn 641: sub javascript_array_indexof {
1.1018 raeburn 642: return <<ENDJS;
1.1017 raeburn 643: <script type="text/javascript" language="JavaScript">
644: // <![CDATA[
645:
646: if (!Array.prototype.indexOf) {
647: Array.prototype.indexOf = function (searchElement /*, fromIndex */ ) {
648: "use strict";
649: if (this === void 0 || this === null) {
650: throw new TypeError();
651: }
652: var t = Object(this);
653: var len = t.length >>> 0;
654: if (len === 0) {
655: return -1;
656: }
657: var n = 0;
658: if (arguments.length > 0) {
659: n = Number(arguments[1]);
660: if (n !== n) { // shortcut for verifying if it's NaN
661: n = 0;
662: } else if (n !== 0 && n !== (1 / 0) && n !== -(1 / 0)) {
663: n = (n > 0 || -1) * Math.floor(Math.abs(n));
664: }
665: }
666: if (n >= len) {
667: return -1;
668: }
669: var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
670: for (; k < len; k++) {
671: if (k in t && t[k] === searchElement) {
672: return k;
673: }
674: }
675: return -1;
676: }
677: }
678:
679: // ]]>
680: </script>
681:
682: ENDJS
683:
684: }
685:
1.876 raeburn 686: sub userbrowser_javascript {
687: my $id_functions = &javascript_index_functions();
688: return <<"ENDUSERBRW";
689:
1.888 raeburn 690: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876 raeburn 691: var url = '/adm/pickuser?';
692: var userdom = getDomainFromSelectbox(formname,udom);
693: if (userdom != null) {
694: if (userdom != '') {
695: url += 'srchdom='+userdom+'&';
696: }
697: }
698: url += 'form=' + formname + '&unameelement='+uname+
699: '&udomelement='+udom+
700: '&ulastelement='+ulast+
701: '&ufirstelement='+ufirst+
702: '&uemailelement='+uemail+
1.881 raeburn 703: '&hideudomelement='+hideudom+
704: '&coursedom='+crsdom;
1.888 raeburn 705: if ((caller != null) && (caller != undefined)) {
706: url += '&caller='+caller;
707: }
1.876 raeburn 708: var title = 'User_Browser';
709: var options = 'scrollbars=1,resizable=1,menubar=0';
710: options += ',width=700,height=600';
711: var stdeditbrowser = open(url,title,options,'1');
712: stdeditbrowser.focus();
713: }
714:
1.888 raeburn 715: function fix_domain (formname,udom,origdom,uname) {
1.876 raeburn 716: var formid = getFormIdByName(formname);
717: if (formid > -1) {
1.888 raeburn 718: var unameid = getIndexByName(formid,uname);
1.876 raeburn 719: var domid = getIndexByName(formid,udom);
720: var hidedomid = getIndexByName(formid,origdom);
721: if (hidedomid > -1) {
722: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888 raeburn 723: var unameval = document.forms[formid].elements[unameid].value;
724: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
725: if (domid > -1) {
726: var slct = document.forms[formid].elements[domid];
727: if (slct.type == 'select-one') {
728: var i;
729: for (i=0;i<slct.length;i++) {
730: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
731: }
732: }
733: if (slct.type == 'hidden') {
734: slct.value = fixeddom;
1.876 raeburn 735: }
736: }
1.468 raeburn 737: }
738: }
739: }
1.876 raeburn 740: return;
741: }
742:
743: $id_functions
744: ENDUSERBRW
1.468 raeburn 745: }
746:
747: sub setsec_javascript {
1.905 raeburn 748: my ($sec_element,$formname,$role_element) = @_;
749: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
750: $communityrolestr);
751: if ($role_element ne '') {
752: my @allroles = ('st','ta','ep','in','ad');
753: foreach my $crstype ('Course','Community') {
754: if ($crstype eq 'Community') {
755: foreach my $role (@allroles) {
756: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
757: }
758: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
759: } else {
760: foreach my $role (@allroles) {
761: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
762: }
763: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
764: }
765: }
766: $rolestr = '"'.join('","',@allroles).'"';
767: $courserolestr = '"'.join('","',@courserolenames).'"';
768: $communityrolestr = '"'.join('","',@communityrolenames).'"';
769: }
1.468 raeburn 770: my $setsections = qq|
771: function setSect(sectionlist) {
1.629 raeburn 772: var sectionsArray = new Array();
773: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
774: sectionsArray = sectionlist.split(",");
775: }
1.468 raeburn 776: var numSections = sectionsArray.length;
777: document.$formname.$sec_element.length = 0;
778: if (numSections == 0) {
779: document.$formname.$sec_element.multiple=false;
780: document.$formname.$sec_element.size=1;
781: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
782: } else {
783: if (numSections == 1) {
784: document.$formname.$sec_element.multiple=false;
785: document.$formname.$sec_element.size=1;
786: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
787: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
788: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
789: } else {
790: for (var i=0; i<numSections; i++) {
791: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
792: }
793: document.$formname.$sec_element.multiple=true
794: if (numSections < 3) {
795: document.$formname.$sec_element.size=numSections;
796: } else {
797: document.$formname.$sec_element.size=3;
798: }
799: document.$formname.$sec_element.options[0].selected = false
800: }
801: }
1.91 www 802: }
1.905 raeburn 803:
804: function setRole(crstype) {
1.468 raeburn 805: |;
1.905 raeburn 806: if ($role_element eq '') {
807: $setsections .= ' return;
808: }
809: ';
810: } else {
811: $setsections .= qq|
812: var elementLength = document.$formname.$role_element.length;
813: var allroles = Array($rolestr);
814: var courserolenames = Array($courserolestr);
815: var communityrolenames = Array($communityrolestr);
816: if (elementLength != undefined) {
817: if (document.$formname.$role_element.options[5].value == 'cc') {
818: if (crstype == 'Course') {
819: return;
820: } else {
821: allroles[5] = 'co';
822: for (var i=0; i<6; i++) {
823: document.$formname.$role_element.options[i].value = allroles[i];
824: document.$formname.$role_element.options[i].text = communityrolenames[i];
825: }
826: }
827: } else {
828: if (crstype == 'Community') {
829: return;
830: } else {
831: allroles[5] = 'cc';
832: for (var i=0; i<6; i++) {
833: document.$formname.$role_element.options[i].value = allroles[i];
834: document.$formname.$role_element.options[i].text = courserolenames[i];
835: }
836: }
837: }
838: }
839: return;
840: }
841: |;
842: }
1.468 raeburn 843: return $setsections;
844: }
845:
1.91 www 846: sub selectcourse_link {
1.909 raeburn 847: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
848: $typeelement) = @_;
849: my $type = $selecttype;
1.871 raeburn 850: my $linktext = &mt('Select Course');
851: if ($selecttype eq 'Community') {
1.909 raeburn 852: $linktext = &mt('Select Community');
1.906 raeburn 853: } elsif ($selecttype eq 'Course/Community') {
854: $linktext = &mt('Select Course/Community');
1.909 raeburn 855: $type = '';
1.1019 raeburn 856: } elsif ($selecttype eq 'Select') {
857: $linktext = &mt('Select');
858: $type = '';
1.871 raeburn 859: }
1.787 bisitz 860: return '<span class="LC_nobreak">'
861: ."<a href='"
862: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
863: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 864: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 865: ."'>".$linktext.'</a>'
1.787 bisitz 866: .'</span>';
1.74 www 867: }
1.42 matthew 868:
1.653 raeburn 869: sub selectauthor_link {
870: my ($form,$udom)=@_;
871: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
872: &mt('Select Author').'</a>';
873: }
874:
1.876 raeburn 875: sub selectuser_link {
1.881 raeburn 876: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 877: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 878: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 879: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 880: ');">'.$linktext.'</a>';
1.876 raeburn 881: }
882:
1.273 raeburn 883: sub check_uncheck_jscript {
884: my $jscript = <<"ENDSCRT";
885: function checkAll(field) {
886: if (field.length > 0) {
887: for (i = 0; i < field.length; i++) {
888: field[i].checked = true ;
889: }
890: } else {
891: field.checked = true
892: }
893: }
894:
895: function uncheckAll(field) {
896: if (field.length > 0) {
897: for (i = 0; i < field.length; i++) {
898: field[i].checked = false ;
1.543 albertel 899: }
900: } else {
1.273 raeburn 901: field.checked = false ;
902: }
903: }
904: ENDSCRT
905: return $jscript;
906: }
907:
1.656 www 908: sub select_timezone {
1.659 raeburn 909: my ($name,$selected,$onchange,$includeempty)=@_;
910: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
911: if ($includeempty) {
912: $output .= '<option value=""';
913: if (($selected eq '') || ($selected eq 'local')) {
914: $output .= ' selected="selected" ';
915: }
916: $output .= '> </option>';
917: }
1.657 raeburn 918: my @timezones = DateTime::TimeZone->all_names;
919: foreach my $tzone (@timezones) {
920: $output.= '<option value="'.$tzone.'"';
921: if ($tzone eq $selected) {
922: $output.=' selected="selected"';
923: }
924: $output.=">$tzone</option>\n";
1.656 www 925: }
926: $output.="</select>";
927: return $output;
928: }
1.273 raeburn 929:
1.687 raeburn 930: sub select_datelocale {
931: my ($name,$selected,$onchange,$includeempty)=@_;
932: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
933: if ($includeempty) {
934: $output .= '<option value=""';
935: if ($selected eq '') {
936: $output .= ' selected="selected" ';
937: }
938: $output .= '> </option>';
939: }
940: my (@possibles,%locale_names);
941: my @locales = DateTime::Locale::Catalog::Locales;
942: foreach my $locale (@locales) {
943: if (ref($locale) eq 'HASH') {
944: my $id = $locale->{'id'};
945: if ($id ne '') {
946: my $en_terr = $locale->{'en_territory'};
947: my $native_terr = $locale->{'native_territory'};
1.695 raeburn 948: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 949: if (grep(/^en$/,@languages) || !@languages) {
950: if ($en_terr ne '') {
951: $locale_names{$id} = '('.$en_terr.')';
952: } elsif ($native_terr ne '') {
953: $locale_names{$id} = $native_terr;
954: }
955: } else {
956: if ($native_terr ne '') {
957: $locale_names{$id} = $native_terr.' ';
958: } elsif ($en_terr ne '') {
959: $locale_names{$id} = '('.$en_terr.')';
960: }
961: }
962: push (@possibles,$id);
963: }
964: }
965: }
966: foreach my $item (sort(@possibles)) {
967: $output.= '<option value="'.$item.'"';
968: if ($item eq $selected) {
969: $output.=' selected="selected"';
970: }
971: $output.=">$item";
972: if ($locale_names{$item} ne '') {
973: $output.=" $locale_names{$item}</option>\n";
974: }
975: $output.="</option>\n";
976: }
977: $output.="</select>";
978: return $output;
979: }
980:
1.792 raeburn 981: sub select_language {
982: my ($name,$selected,$includeempty) = @_;
983: my %langchoices;
984: if ($includeempty) {
985: %langchoices = ('' => 'No language preference');
986: }
987: foreach my $id (&languageids()) {
988: my $code = &supportedlanguagecode($id);
989: if ($code) {
990: $langchoices{$code} = &plainlanguagedescription($id);
991: }
992: }
1.970 raeburn 993: return &select_form($selected,$name,\%langchoices);
1.792 raeburn 994: }
995:
1.42 matthew 996: =pod
1.36 matthew 997:
1.648 raeburn 998: =item * &linked_select_forms(...)
1.36 matthew 999:
1000: linked_select_forms returns a string containing a <script></script> block
1001: and html for two <select> menus. The select menus will be linked in that
1002: changing the value of the first menu will result in new values being placed
1003: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 1004: order unless a defined order is provided.
1.36 matthew 1005:
1006: linked_select_forms takes the following ordered inputs:
1007:
1008: =over 4
1009:
1.112 bowersj2 1010: =item * $formname, the name of the <form> tag
1.36 matthew 1011:
1.112 bowersj2 1012: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 1013:
1.112 bowersj2 1014: =item * $firstdefault, the default value for the first menu
1.36 matthew 1015:
1.112 bowersj2 1016: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 1017:
1.112 bowersj2 1018: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 1019:
1.112 bowersj2 1020: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 1021:
1.609 raeburn 1022: =item * $menuorder, the order of values in the first menu
1023:
1.41 ng 1024: =back
1025:
1.36 matthew 1026: Below is an example of such a hash. Only the 'text', 'default', and
1027: 'select2' keys must appear as stated. keys(%menu) are the possible
1028: values for the first select menu. The text that coincides with the
1.41 ng 1029: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 1030: and text for the second menu are given in the hash pointed to by
1031: $menu{$choice1}->{'select2'}.
1032:
1.112 bowersj2 1033: my %menu = ( A1 => { text =>"Choice A1" ,
1034: default => "B3",
1035: select2 => {
1036: B1 => "Choice B1",
1037: B2 => "Choice B2",
1038: B3 => "Choice B3",
1039: B4 => "Choice B4"
1.609 raeburn 1040: },
1041: order => ['B4','B3','B1','B2'],
1.112 bowersj2 1042: },
1043: A2 => { text =>"Choice A2" ,
1044: default => "C2",
1045: select2 => {
1046: C1 => "Choice C1",
1047: C2 => "Choice C2",
1048: C3 => "Choice C3"
1.609 raeburn 1049: },
1050: order => ['C2','C1','C3'],
1.112 bowersj2 1051: },
1052: A3 => { text =>"Choice A3" ,
1053: default => "D6",
1054: select2 => {
1055: D1 => "Choice D1",
1056: D2 => "Choice D2",
1057: D3 => "Choice D3",
1058: D4 => "Choice D4",
1059: D5 => "Choice D5",
1060: D6 => "Choice D6",
1061: D7 => "Choice D7"
1.609 raeburn 1062: },
1063: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 1064: }
1065: );
1.36 matthew 1066:
1067: =cut
1068:
1069: sub linked_select_forms {
1070: my ($formname,
1071: $middletext,
1072: $firstdefault,
1073: $firstselectname,
1074: $secondselectname,
1.609 raeburn 1075: $hashref,
1076: $menuorder,
1.36 matthew 1077: ) = @_;
1078: my $second = "document.$formname.$secondselectname";
1079: my $first = "document.$formname.$firstselectname";
1080: # output the javascript to do the changing
1081: my $result = '';
1.776 bisitz 1082: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 1083: $result.="// <![CDATA[\n";
1.36 matthew 1084: $result.="var select2data = new Object();\n";
1085: $" = '","';
1086: my $debug = '';
1087: foreach my $s1 (sort(keys(%$hashref))) {
1088: $result.="select2data.d_$s1 = new Object();\n";
1089: $result.="select2data.d_$s1.def = new String('".
1090: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 1091: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 1092: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1093: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1094: @s2values = @{$hashref->{$s1}->{'order'}};
1095: }
1.36 matthew 1096: $result.="\"@s2values\");\n";
1097: $result.="select2data.d_$s1.texts = new Array(";
1098: my @s2texts;
1099: foreach my $value (@s2values) {
1100: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
1101: }
1102: $result.="\"@s2texts\");\n";
1103: }
1104: $"=' ';
1105: $result.= <<"END";
1106:
1107: function select1_changed() {
1108: // Determine new choice
1109: var newvalue = "d_" + $first.value;
1110: // update select2
1111: var values = select2data[newvalue].values;
1112: var texts = select2data[newvalue].texts;
1113: var select2def = select2data[newvalue].def;
1114: var i;
1115: // out with the old
1116: for (i = 0; i < $second.options.length; i++) {
1117: $second.options[i] = null;
1118: }
1119: // in with the nuclear
1120: for (i=0;i<values.length; i++) {
1121: $second.options[i] = new Option(values[i]);
1.143 matthew 1122: $second.options[i].value = values[i];
1.36 matthew 1123: $second.options[i].text = texts[i];
1124: if (values[i] == select2def) {
1125: $second.options[i].selected = true;
1126: }
1127: }
1128: }
1.824 bisitz 1129: // ]]>
1.36 matthew 1130: </script>
1131: END
1132: # output the initial values for the selection lists
1133: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609 raeburn 1134: my @order = sort(keys(%{$hashref}));
1135: if (ref($menuorder) eq 'ARRAY') {
1136: @order = @{$menuorder};
1137: }
1138: foreach my $value (@order) {
1.36 matthew 1139: $result.=" <option value=\"$value\" ";
1.253 albertel 1140: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1141: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1142: }
1143: $result .= "</select>\n";
1144: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1145: $result .= $middletext;
1146: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
1147: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1148:
1149: my @secondorder = sort(keys(%select2));
1150: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1151: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1152: }
1153: foreach my $value (@secondorder) {
1.36 matthew 1154: $result.=" <option value=\"$value\" ";
1.253 albertel 1155: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1156: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1157: }
1158: $result .= "</select>\n";
1159: # return $debug;
1160: return $result;
1161: } # end of sub linked_select_forms {
1162:
1.45 matthew 1163: =pod
1.44 bowersj2 1164:
1.973 raeburn 1165: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid)
1.44 bowersj2 1166:
1.112 bowersj2 1167: Returns a string corresponding to an HTML link to the given help
1168: $topic, where $topic corresponds to the name of a .tex file in
1169: /home/httpd/html/adm/help/tex, with underscores replaced by
1170: spaces.
1171:
1172: $text will optionally be linked to the same topic, allowing you to
1173: link text in addition to the graphic. If you do not want to link
1174: text, but wish to specify one of the later parameters, pass an
1175: empty string.
1176:
1177: $stayOnPage is a value that will be interpreted as a boolean. If true,
1178: the link will not open a new window. If false, the link will open
1179: a new window using Javascript. (Default is false.)
1180:
1181: $width and $height are optional numerical parameters that will
1182: override the width and height of the popped up window, which may
1.973 raeburn 1183: be useful for certain help topics with big pictures included.
1184:
1185: $imgid is the id of the img tag used for the help icon. This may be
1186: used in a javascript call to switch the image src. See
1187: lonhtmlcommon::htmlareaselectactive() for an example.
1.44 bowersj2 1188:
1189: =cut
1190:
1191: sub help_open_topic {
1.973 raeburn 1192: my ($topic, $text, $stayOnPage, $width, $height, $imgid) = @_;
1.48 bowersj2 1193: $text = "" if (not defined $text);
1.44 bowersj2 1194: $stayOnPage = 0 if (not defined $stayOnPage);
1.1033 www 1195: $width = 500 if (not defined $width);
1.44 bowersj2 1196: $height = 400 if (not defined $height);
1197: my $filename = $topic;
1198: $filename =~ s/ /_/g;
1199:
1.48 bowersj2 1200: my $template = "";
1201: my $link;
1.572 banghart 1202:
1.159 www 1203: $topic=~s/\W/\_/g;
1.44 bowersj2 1204:
1.572 banghart 1205: if (!$stayOnPage) {
1.1033 www 1206: $link = "javascript:openMyModal('/adm/help/${filename}.hlp',$width,$height,'yes');";
1.1037 www 1207: } elsif ($stayOnPage eq 'popup') {
1208: $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1.572 banghart 1209: } else {
1.48 bowersj2 1210: $link = "/adm/help/${filename}.hlp";
1211: }
1212:
1213: # Add the text
1.755 neumanie 1214: if ($text ne "") {
1.763 bisitz 1215: $template.='<span class="LC_help_open_topic">'
1216: .'<a target="_top" href="'.$link.'">'
1217: .$text.'</a>';
1.48 bowersj2 1218: }
1219:
1.763 bisitz 1220: # (Always) Add the graphic
1.179 matthew 1221: my $title = &mt('Online Help');
1.667 raeburn 1222: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973 raeburn 1223: if ($imgid ne '') {
1224: $imgid = ' id="'.$imgid.'"';
1225: }
1.763 bisitz 1226: $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
1227: .'<img src="'.$helpicon.'" border="0"'
1228: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973 raeburn 1229: .' title="'.$title.'" style="vertical-align:middle;"'.$imgid
1.763 bisitz 1230: .' /></a>';
1231: if ($text ne "") {
1232: $template.='</span>';
1233: }
1.44 bowersj2 1234: return $template;
1235:
1.106 bowersj2 1236: }
1237:
1238: # This is a quicky function for Latex cheatsheet editing, since it
1239: # appears in at least four places
1240: sub helpLatexCheatsheet {
1.1037 www 1241: my ($topic,$text,$not_author,$stayOnPage) = @_;
1.732 raeburn 1242: my $out;
1.106 bowersj2 1243: my $addOther = '';
1.732 raeburn 1244: if ($topic) {
1.1037 www 1245: $addOther = '<span>'.&help_open_topic($topic,&mt($text),$stayOnPage, undef, 600).'</span> ';
1.763 bisitz 1246: }
1247: $out = '<span>' # Start cheatsheet
1248: .$addOther
1249: .'<span>'
1.1037 www 1250: .&help_open_topic('Greek_Symbols',&mt('Greek Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1251: .'</span> <span>'
1.1037 www 1252: .&help_open_topic('Other_Symbols',&mt('Other Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1253: .'</span>';
1.732 raeburn 1254: unless ($not_author) {
1.763 bisitz 1255: $out .= ' <span>'
1.1037 www 1256: .&help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),$stayOnPage,undef,600)
1.763 bisitz 1257: .'</span>';
1.732 raeburn 1258: }
1.763 bisitz 1259: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1260: return $out;
1.172 www 1261: }
1262:
1.430 albertel 1263: sub general_help {
1264: my $helptopic='Student_Intro';
1265: if ($env{'request.role'}=~/^(ca|au)/) {
1266: $helptopic='Authoring_Intro';
1.907 raeburn 1267: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1268: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1269: } elsif ($env{'request.role'}=~/^dc/) {
1270: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1271: }
1272: return $helptopic;
1273: }
1274:
1275: sub update_help_link {
1276: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1277: my $origurl = $ENV{'REQUEST_URI'};
1278: $origurl=~s|^/~|/priv/|;
1279: my $timestamp = time;
1280: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1281: $$datum = &escape($$datum);
1282: }
1283:
1284: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1285: my $output .= <<"ENDOUTPUT";
1286: <script type="text/javascript">
1.824 bisitz 1287: // <![CDATA[
1.430 albertel 1288: banner_link = '$banner_link';
1.824 bisitz 1289: // ]]>
1.430 albertel 1290: </script>
1291: ENDOUTPUT
1292: return $output;
1293: }
1294:
1295: # now just updates the help link and generates a blue icon
1.193 raeburn 1296: sub help_open_menu {
1.430 albertel 1297: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1298: = @_;
1.949 droeschl 1299: $stayOnPage = 1;
1.430 albertel 1300: my $output;
1301: if ($component_help) {
1302: if (!$text) {
1303: $output=&help_open_topic($component_help,undef,$stayOnPage,
1304: $width,$height);
1305: } else {
1306: my $help_text;
1307: $help_text=&unescape($topic);
1308: $output='<table><tr><td>'.
1309: &help_open_topic($component_help,$help_text,$stayOnPage,
1310: $width,$height).'</td></tr></table>';
1311: }
1312: }
1313: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1314: return $output.$banner_link;
1315: }
1316:
1317: sub top_nav_help {
1318: my ($text) = @_;
1.436 albertel 1319: $text = &mt($text);
1.949 droeschl 1320: my $stay_on_page = 1;
1321:
1.572 banghart 1322: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1323: : "javascript:helpMenu('open')";
1.572 banghart 1324: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1325:
1.201 raeburn 1326: my $title = &mt('Get help');
1.436 albertel 1327:
1328: return <<"END";
1329: $banner_link
1330: <a href="$link" title="$title">$text</a>
1331: END
1332: }
1333:
1334: sub help_menu_js {
1335: my ($text) = @_;
1.949 droeschl 1336: my $stayOnPage = 1;
1.436 albertel 1337: my $width = 620;
1338: my $height = 600;
1.430 albertel 1339: my $helptopic=&general_help();
1340: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1341: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1342: my $start_page =
1343: &Apache::loncommon::start_page('Help Menu', undef,
1344: {'frameset' => 1,
1345: 'js_ready' => 1,
1346: 'add_entries' => {
1347: 'border' => '0',
1.579 raeburn 1348: 'rows' => "110,*",},});
1.331 albertel 1349: my $end_page =
1350: &Apache::loncommon::end_page({'frameset' => 1,
1351: 'js_ready' => 1,});
1352:
1.436 albertel 1353: my $template .= <<"ENDTEMPLATE";
1354: <script type="text/javascript">
1.877 bisitz 1355: // <![CDATA[
1.253 albertel 1356: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1357: var banner_link = '';
1.243 raeburn 1358: function helpMenu(target) {
1359: var caller = this;
1360: if (target == 'open') {
1361: var newWindow = null;
1362: try {
1.262 albertel 1363: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1364: }
1365: catch(error) {
1366: writeHelp(caller);
1367: return;
1368: }
1369: if (newWindow) {
1370: caller = newWindow;
1371: }
1.193 raeburn 1372: }
1.243 raeburn 1373: writeHelp(caller);
1374: return;
1375: }
1376: function writeHelp(caller) {
1.1072 raeburn 1377: caller.document.writeln('$start_page\\n<frame name="bannerframe" src="'+banner_link+'" />\\n<frame name="bodyframe" src="$details_link" />\\n$end_page')
1.243 raeburn 1378: caller.document.close()
1379: caller.focus()
1.193 raeburn 1380: }
1.877 bisitz 1381: // END LON-CAPA Internal -->
1.253 albertel 1382: // ]]>
1.436 albertel 1383: </script>
1.193 raeburn 1384: ENDTEMPLATE
1385: return $template;
1386: }
1387:
1.172 www 1388: sub help_open_bug {
1389: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1390: unless ($env{'user.adv'}) { return ''; }
1.172 www 1391: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1392: $text = "" if (not defined $text);
1393: $stayOnPage=1;
1.184 albertel 1394: $width = 600 if (not defined $width);
1395: $height = 600 if (not defined $height);
1.172 www 1396:
1397: $topic=~s/\W+/\+/g;
1398: my $link='';
1399: my $template='';
1.379 albertel 1400: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1401: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1402: if (!$stayOnPage)
1403: {
1404: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1405: }
1406: else
1407: {
1408: $link = $url;
1409: }
1410: # Add the text
1411: if ($text ne "")
1412: {
1413: $template .=
1414: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1415: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1416: }
1417:
1418: # Add the graphic
1.179 matthew 1419: my $title = &mt('Report a Bug');
1.215 albertel 1420: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1421: $template .= <<"ENDTEMPLATE";
1.436 albertel 1422: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1423: ENDTEMPLATE
1424: if ($text ne '') { $template.='</td></tr></table>' };
1425: return $template;
1426:
1427: }
1428:
1429: sub help_open_faq {
1430: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1431: unless ($env{'user.adv'}) { return ''; }
1.172 www 1432: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1433: $text = "" if (not defined $text);
1434: $stayOnPage=1;
1435: $width = 350 if (not defined $width);
1436: $height = 400 if (not defined $height);
1437:
1438: $topic=~s/\W+/\+/g;
1439: my $link='';
1440: my $template='';
1441: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1442: if (!$stayOnPage)
1443: {
1444: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1445: }
1446: else
1447: {
1448: $link = $url;
1449: }
1450:
1451: # Add the text
1452: if ($text ne "")
1453: {
1454: $template .=
1.173 www 1455: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1456: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1457: }
1458:
1459: # Add the graphic
1.179 matthew 1460: my $title = &mt('View the FAQ');
1.215 albertel 1461: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1462: $template .= <<"ENDTEMPLATE";
1.436 albertel 1463: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1464: ENDTEMPLATE
1465: if ($text ne '') { $template.='</td></tr></table>' };
1466: return $template;
1467:
1.44 bowersj2 1468: }
1.37 matthew 1469:
1.180 matthew 1470: ###############################################################
1471: ###############################################################
1472:
1.45 matthew 1473: =pod
1474:
1.648 raeburn 1475: =item * &change_content_javascript():
1.256 matthew 1476:
1477: This and the next function allow you to create small sections of an
1478: otherwise static HTML page that you can update on the fly with
1479: Javascript, even in Netscape 4.
1480:
1481: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1482: must be written to the HTML page once. It will prove the Javascript
1483: function "change(name, content)". Calling the change function with the
1484: name of the section
1485: you want to update, matching the name passed to C<changable_area>, and
1486: the new content you want to put in there, will put the content into
1487: that area.
1488:
1489: B<Note>: Netscape 4 only reserves enough space for the changable area
1490: to contain room for the original contents. You need to "make space"
1491: for whatever changes you wish to make, and be B<sure> to check your
1492: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1493: it's adequate for updating a one-line status display, but little more.
1494: This script will set the space to 100% width, so you only need to
1495: worry about height in Netscape 4.
1496:
1497: Modern browsers are much less limiting, and if you can commit to the
1498: user not using Netscape 4, this feature may be used freely with
1499: pretty much any HTML.
1500:
1501: =cut
1502:
1503: sub change_content_javascript {
1504: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1505: if ($env{'browser.type'} eq 'netscape' &&
1506: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1507: return (<<NETSCAPE4);
1508: function change(name, content) {
1509: doc = document.layers[name+"___escape"].layers[0].document;
1510: doc.open();
1511: doc.write(content);
1512: doc.close();
1513: }
1514: NETSCAPE4
1515: } else {
1516: # Otherwise, we need to use semi-standards-compliant code
1517: # (technically, "innerHTML" isn't standard but the equivalent
1518: # is really scary, and every useful browser supports it
1519: return (<<DOMBASED);
1520: function change(name, content) {
1521: element = document.getElementById(name);
1522: element.innerHTML = content;
1523: }
1524: DOMBASED
1525: }
1526: }
1527:
1528: =pod
1529:
1.648 raeburn 1530: =item * &changable_area($name,$origContent):
1.256 matthew 1531:
1532: This provides a "changable area" that can be modified on the fly via
1533: the Javascript code provided in C<change_content_javascript>. $name is
1534: the name you will use to reference the area later; do not repeat the
1535: same name on a given HTML page more then once. $origContent is what
1536: the area will originally contain, which can be left blank.
1537:
1538: =cut
1539:
1540: sub changable_area {
1541: my ($name, $origContent) = @_;
1542:
1.258 albertel 1543: if ($env{'browser.type'} eq 'netscape' &&
1544: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1545: # If this is netscape 4, we need to use the Layer tag
1546: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1547: } else {
1548: return "<span id='$name'>$origContent</span>";
1549: }
1550: }
1551:
1552: =pod
1553:
1.648 raeburn 1554: =item * &viewport_geometry_js
1.590 raeburn 1555:
1556: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1557:
1558: =cut
1559:
1560:
1561: sub viewport_geometry_js {
1562: return <<"GEOMETRY";
1563: var Geometry = {};
1564: function init_geometry() {
1565: if (Geometry.init) { return };
1566: Geometry.init=1;
1567: if (window.innerHeight) {
1568: Geometry.getViewportHeight = function() { return window.innerHeight; };
1569: Geometry.getViewportWidth = function() { return window.innerWidth; };
1570: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1571: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1572: }
1573: else if (document.documentElement && document.documentElement.clientHeight) {
1574: Geometry.getViewportHeight =
1575: function() { return document.documentElement.clientHeight; };
1576: Geometry.getViewportWidth =
1577: function() { return document.documentElement.clientWidth; };
1578:
1579: Geometry.getHorizontalScroll =
1580: function() { return document.documentElement.scrollLeft; };
1581: Geometry.getVerticalScroll =
1582: function() { return document.documentElement.scrollTop; };
1583: }
1584: else if (document.body.clientHeight) {
1585: Geometry.getViewportHeight =
1586: function() { return document.body.clientHeight; };
1587: Geometry.getViewportWidth =
1588: function() { return document.body.clientWidth; };
1589: Geometry.getHorizontalScroll =
1590: function() { return document.body.scrollLeft; };
1591: Geometry.getVerticalScroll =
1592: function() { return document.body.scrollTop; };
1593: }
1594: }
1595:
1596: GEOMETRY
1597: }
1598:
1599: =pod
1600:
1.648 raeburn 1601: =item * &viewport_size_js()
1.590 raeburn 1602:
1603: Provides a javascript function to set values of two form elements - width and height (elements are passed in as arguments to the javascript function) to the dimensions of the user's browser window.
1604:
1605: =cut
1606:
1607: sub viewport_size_js {
1608: my $geometry = &viewport_geometry_js();
1609: return <<"DIMS";
1610:
1611: $geometry
1612:
1613: function getViewportDims(width,height) {
1614: init_geometry();
1615: width.value = Geometry.getViewportWidth();
1616: height.value = Geometry.getViewportHeight();
1617: return;
1618: }
1619:
1620: DIMS
1621: }
1622:
1623: =pod
1624:
1.648 raeburn 1625: =item * &resize_textarea_js()
1.565 albertel 1626:
1627: emits the needed javascript to resize a textarea to be as big as possible
1628:
1629: creates a function resize_textrea that takes two IDs first should be
1630: the id of the element to resize, second should be the id of a div that
1631: surrounds everything that comes after the textarea, this routine needs
1632: to be attached to the <body> for the onload and onresize events.
1633:
1.648 raeburn 1634: =back
1.565 albertel 1635:
1636: =cut
1637:
1638: sub resize_textarea_js {
1.590 raeburn 1639: my $geometry = &viewport_geometry_js();
1.565 albertel 1640: return <<"RESIZE";
1641: <script type="text/javascript">
1.824 bisitz 1642: // <![CDATA[
1.590 raeburn 1643: $geometry
1.565 albertel 1644:
1.588 albertel 1645: function getX(element) {
1646: var x = 0;
1647: while (element) {
1648: x += element.offsetLeft;
1649: element = element.offsetParent;
1650: }
1651: return x;
1652: }
1653: function getY(element) {
1654: var y = 0;
1655: while (element) {
1656: y += element.offsetTop;
1657: element = element.offsetParent;
1658: }
1659: return y;
1660: }
1661:
1662:
1.565 albertel 1663: function resize_textarea(textarea_id,bottom_id) {
1664: init_geometry();
1665: var textarea = document.getElementById(textarea_id);
1666: //alert(textarea);
1667:
1.588 albertel 1668: var textarea_top = getY(textarea);
1.565 albertel 1669: var textarea_height = textarea.offsetHeight;
1670: var bottom = document.getElementById(bottom_id);
1.588 albertel 1671: var bottom_top = getY(bottom);
1.565 albertel 1672: var bottom_height = bottom.offsetHeight;
1673: var window_height = Geometry.getViewportHeight();
1.588 albertel 1674: var fudge = 23;
1.565 albertel 1675: var new_height = window_height-fudge-textarea_top-bottom_height;
1676: if (new_height < 300) {
1677: new_height = 300;
1678: }
1679: textarea.style.height=new_height+'px';
1680: }
1.824 bisitz 1681: // ]]>
1.565 albertel 1682: </script>
1683: RESIZE
1684:
1685: }
1686:
1687: =pod
1688:
1.256 matthew 1689: =head1 Excel and CSV file utility routines
1690:
1691: =over 4
1692:
1693: =cut
1694:
1695: ###############################################################
1696: ###############################################################
1697:
1698: =pod
1699:
1.648 raeburn 1700: =item * &csv_translate($text)
1.37 matthew 1701:
1.185 www 1702: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1703: format.
1704:
1705: =cut
1706:
1.180 matthew 1707: ###############################################################
1708: ###############################################################
1.37 matthew 1709: sub csv_translate {
1710: my $text = shift;
1711: $text =~ s/\"/\"\"/g;
1.209 albertel 1712: $text =~ s/\n/ /g;
1.37 matthew 1713: return $text;
1714: }
1.180 matthew 1715:
1716: ###############################################################
1717: ###############################################################
1718:
1719: =pod
1720:
1.648 raeburn 1721: =item * &define_excel_formats()
1.180 matthew 1722:
1723: Define some commonly used Excel cell formats.
1724:
1725: Currently supported formats:
1726:
1727: =over 4
1728:
1729: =item header
1730:
1731: =item bold
1732:
1733: =item h1
1734:
1735: =item h2
1736:
1737: =item h3
1738:
1.256 matthew 1739: =item h4
1740:
1741: =item i
1742:
1.180 matthew 1743: =item date
1744:
1745: =back
1746:
1747: Inputs: $workbook
1748:
1749: Returns: $format, a hash reference.
1750:
1.1057 foxr 1751:
1.180 matthew 1752: =cut
1753:
1754: ###############################################################
1755: ###############################################################
1756: sub define_excel_formats {
1757: my ($workbook) = @_;
1758: my $format;
1759: $format->{'header'} = $workbook->add_format(bold => 1,
1760: bottom => 1,
1761: align => 'center');
1762: $format->{'bold'} = $workbook->add_format(bold=>1);
1763: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1764: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1765: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1766: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1767: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1768: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1769: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1770: return $format;
1771: }
1772:
1773: ###############################################################
1774: ###############################################################
1.113 bowersj2 1775:
1776: =pod
1777:
1.648 raeburn 1778: =item * &create_workbook()
1.255 matthew 1779:
1780: Create an Excel worksheet. If it fails, output message on the
1781: request object and return undefs.
1782:
1783: Inputs: Apache request object
1784:
1785: Returns (undef) on failure,
1786: Excel worksheet object, scalar with filename, and formats
1787: from &Apache::loncommon::define_excel_formats on success
1788:
1789: =cut
1790:
1791: ###############################################################
1792: ###############################################################
1793: sub create_workbook {
1794: my ($r) = @_;
1795: #
1796: # Create the excel spreadsheet
1797: my $filename = '/prtspool/'.
1.258 albertel 1798: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1799: time.'_'.rand(1000000000).'.xls';
1800: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1801: if (! defined($workbook)) {
1802: $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928 bisitz 1803: $r->print(
1804: '<p class="LC_error">'
1805: .&mt('Problems occurred in creating the new Excel file.')
1806: .' '.&mt('This error has been logged.')
1807: .' '.&mt('Please alert your LON-CAPA administrator.')
1808: .'</p>'
1809: );
1.255 matthew 1810: return (undef);
1811: }
1812: #
1.1014 foxr 1813: $workbook->set_tempdir(LONCAPA::tempdir());
1.255 matthew 1814: #
1815: my $format = &Apache::loncommon::define_excel_formats($workbook);
1816: return ($workbook,$filename,$format);
1817: }
1818:
1819: ###############################################################
1820: ###############################################################
1821:
1822: =pod
1823:
1.648 raeburn 1824: =item * &create_text_file()
1.113 bowersj2 1825:
1.542 raeburn 1826: Create a file to write to and eventually make available to the user.
1.256 matthew 1827: If file creation fails, outputs an error message on the request object and
1828: return undefs.
1.113 bowersj2 1829:
1.256 matthew 1830: Inputs: Apache request object, and file suffix
1.113 bowersj2 1831:
1.256 matthew 1832: Returns (undef) on failure,
1833: Filehandle and filename on success.
1.113 bowersj2 1834:
1835: =cut
1836:
1.256 matthew 1837: ###############################################################
1838: ###############################################################
1839: sub create_text_file {
1840: my ($r,$suffix) = @_;
1841: if (! defined($suffix)) { $suffix = 'txt'; };
1842: my $fh;
1843: my $filename = '/prtspool/'.
1.258 albertel 1844: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1845: time.'_'.rand(1000000000).'.'.$suffix;
1846: $fh = Apache::File->new('>/home/httpd'.$filename);
1847: if (! defined($fh)) {
1848: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 1849: $r->print(
1850: '<p class="LC_error">'
1851: .&mt('Problems occurred in creating the output file.')
1852: .' '.&mt('This error has been logged.')
1853: .' '.&mt('Please alert your LON-CAPA administrator.')
1854: .'</p>'
1855: );
1.113 bowersj2 1856: }
1.256 matthew 1857: return ($fh,$filename)
1.113 bowersj2 1858: }
1859:
1860:
1.256 matthew 1861: =pod
1.113 bowersj2 1862:
1863: =back
1864:
1865: =cut
1.37 matthew 1866:
1867: ###############################################################
1.33 matthew 1868: ## Home server <option> list generating code ##
1869: ###############################################################
1.35 matthew 1870:
1.169 www 1871: # ------------------------------------------
1872:
1873: sub domain_select {
1874: my ($name,$value,$multiple)=@_;
1875: my %domains=map {
1.514 albertel 1876: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1877: } &Apache::lonnet::all_domains();
1.169 www 1878: if ($multiple) {
1879: $domains{''}=&mt('Any domain');
1.550 albertel 1880: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1881: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1882: } else {
1.550 albertel 1883: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970 raeburn 1884: return &select_form($name,$value,\%domains);
1.169 www 1885: }
1886: }
1887:
1.282 albertel 1888: #-------------------------------------------
1889:
1890: =pod
1891:
1.519 raeburn 1892: =head1 Routines for form select boxes
1893:
1894: =over 4
1895:
1.648 raeburn 1896: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1897:
1898: Returns a string containing a <select> element int multiple mode
1899:
1900:
1901: Args:
1902: $name - name of the <select> element
1.506 raeburn 1903: $value - scalar or array ref of values that should already be selected
1.282 albertel 1904: $size - number of rows long the select element is
1.283 albertel 1905: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1906: (shown text should already have been &mt())
1.506 raeburn 1907: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1908:
1.282 albertel 1909: =cut
1910:
1911: #-------------------------------------------
1.169 www 1912: sub multiple_select_form {
1.284 albertel 1913: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1914: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1915: my $output='';
1.191 matthew 1916: if (! defined($size)) {
1917: $size = 4;
1.283 albertel 1918: if (scalar(keys(%$hash))<4) {
1919: $size = scalar(keys(%$hash));
1.191 matthew 1920: }
1921: }
1.734 bisitz 1922: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1923: my @order;
1.506 raeburn 1924: if (ref($order) eq 'ARRAY') {
1925: @order = @{$order};
1926: } else {
1927: @order = sort(keys(%$hash));
1.501 banghart 1928: }
1929: if (exists($$hash{'select_form_order'})) {
1930: @order = @{$$hash{'select_form_order'}};
1931: }
1932:
1.284 albertel 1933: foreach my $key (@order) {
1.356 albertel 1934: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1935: $output.='selected="selected" ' if ($selected{$key});
1936: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1937: }
1938: $output.="</select>\n";
1939: return $output;
1940: }
1941:
1.88 www 1942: #-------------------------------------------
1943:
1944: =pod
1945:
1.970 raeburn 1946: =item * &select_form($defdom,$name,$hashref,$onchange)
1.88 www 1947:
1948: Returns a string containing a <select name='$name' size='1'> form to
1.970 raeburn 1949: allow a user to select options from a ref to a hash containing:
1950: option_name => displayed text. An optional $onchange can include
1951: a javascript onchange item, e.g., onchange="this.form.submit();"
1952:
1.88 www 1953: See lonrights.pm for an example invocation and use.
1954:
1955: =cut
1956:
1957: #-------------------------------------------
1958: sub select_form {
1.970 raeburn 1959: my ($def,$name,$hashref,$onchange) = @_;
1960: return unless (ref($hashref) eq 'HASH');
1961: if ($onchange) {
1962: $onchange = ' onchange="'.$onchange.'"';
1963: }
1964: my $selectform = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.128 albertel 1965: my @keys;
1.970 raeburn 1966: if (exists($hashref->{'select_form_order'})) {
1967: @keys=@{$hashref->{'select_form_order'}};
1.128 albertel 1968: } else {
1.970 raeburn 1969: @keys=sort(keys(%{$hashref}));
1.128 albertel 1970: }
1.356 albertel 1971: foreach my $key (@keys) {
1972: $selectform.=
1973: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1974: ($key eq $def ? 'selected="selected" ' : '').
1.970 raeburn 1975: ">".$hashref->{$key}."</option>\n";
1.88 www 1976: }
1977: $selectform.="</select>";
1978: return $selectform;
1979: }
1980:
1.475 www 1981: # For display filters
1982:
1983: sub display_filter {
1.1074 raeburn 1984: my ($context) = @_;
1.475 www 1985: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1986: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.1074 raeburn 1987: my $phraseinput = 'hidden';
1988: my $includeinput = 'hidden';
1989: my ($checked,$includetypestext);
1990: if ($env{'form.displayfilter'} eq 'containing') {
1991: $phraseinput = 'text';
1992: if ($context eq 'parmslog') {
1993: $includeinput = 'checkbox';
1994: if ($env{'form.includetypes'}) {
1995: $checked = ' checked="checked"';
1996: }
1997: $includetypestext = &mt('Include parameter types');
1998: }
1999: } else {
2000: $includetypestext = ' ';
2001: }
2002: my ($additional,$secondid,$thirdid);
2003: if ($context eq 'parmslog') {
2004: $additional =
2005: '<label><input type="'.$includeinput.'" name="includetypes"'.
2006: $checked.' name="includetypes" value="1" id="includetypes" />'.
2007: ' <span id="includetypestext">'.$includetypestext.'</span>'.
2008: '</label>';
2009: $secondid = 'includetypes';
2010: $thirdid = 'includetypestext';
2011: }
2012: my $onchange = "javascript:toggleHistoryOptions(this,'containingphrase','$context',
2013: '$secondid','$thirdid')";
2014: return '<span class="LC_nobreak"><label>'.&mt('Records: [_1]',
1.475 www 2015: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
2016: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 2017: '</label></span> <span class="LC_nobreak">'.
1.1074 raeburn 2018: &mt('Filter: [_1]',
1.477 www 2019: &select_form($env{'form.displayfilter'},
2020: 'displayfilter',
1.970 raeburn 2021: {'currentfolder' => 'Current folder/page',
1.477 www 2022: 'containing' => 'Containing phrase',
1.1074 raeburn 2023: 'none' => 'None'},$onchange)).' '.
2024: '<input type="'.$phraseinput.'" name="containingphrase" id="containingphrase" size="30" value="'.
2025: &HTML::Entities::encode($env{'form.containingphrase'}).
2026: '" />'.$additional;
2027: }
2028:
2029: sub display_filter_js {
2030: my $includetext = &mt('Include parameter types');
2031: return <<"ENDJS";
2032:
2033: function toggleHistoryOptions(setter,firstid,context,secondid,thirdid) {
2034: var firstType = 'hidden';
2035: if (setter.options[setter.selectedIndex].value == 'containing') {
2036: firstType = 'text';
2037: }
2038: firstObject = document.getElementById(firstid);
2039: if (typeof(firstObject) == 'object') {
2040: if (firstObject.type != firstType) {
2041: changeInputType(firstObject,firstType);
2042: }
2043: }
2044: if (context == 'parmslog') {
2045: var secondType = 'hidden';
2046: if (firstType == 'text') {
2047: secondType = 'checkbox';
2048: }
2049: secondObject = document.getElementById(secondid);
2050: if (typeof(secondObject) == 'object') {
2051: if (secondObject.type != secondType) {
2052: changeInputType(secondObject,secondType);
2053: }
2054: }
2055: var textItem = document.getElementById(thirdid);
2056: var currtext = textItem.innerHTML;
2057: var newtext;
2058: if (firstType == 'text') {
2059: newtext = '$includetext';
2060: } else {
2061: newtext = ' ';
2062: }
2063: if (currtext != newtext) {
2064: textItem.innerHTML = newtext;
2065: }
2066: }
2067: return;
2068: }
2069:
2070: function changeInputType(oldObject,newType) {
2071: var newObject = document.createElement('input');
2072: newObject.type = newType;
2073: if (oldObject.size) {
2074: newObject.size = oldObject.size;
2075: }
2076: if (oldObject.value) {
2077: newObject.value = oldObject.value;
2078: }
2079: if (oldObject.name) {
2080: newObject.name = oldObject.name;
2081: }
2082: if (oldObject.id) {
2083: newObject.id = oldObject.id;
2084: }
2085: oldObject.parentNode.replaceChild(newObject,oldObject);
2086: return;
2087: }
2088:
2089: ENDJS
1.475 www 2090: }
2091:
1.167 www 2092: sub gradeleveldescription {
2093: my $gradelevel=shift;
2094: my %gradelevels=(0 => 'Not specified',
2095: 1 => 'Grade 1',
2096: 2 => 'Grade 2',
2097: 3 => 'Grade 3',
2098: 4 => 'Grade 4',
2099: 5 => 'Grade 5',
2100: 6 => 'Grade 6',
2101: 7 => 'Grade 7',
2102: 8 => 'Grade 8',
2103: 9 => 'Grade 9',
2104: 10 => 'Grade 10',
2105: 11 => 'Grade 11',
2106: 12 => 'Grade 12',
2107: 13 => 'Grade 13',
2108: 14 => '100 Level',
2109: 15 => '200 Level',
2110: 16 => '300 Level',
2111: 17 => '400 Level',
2112: 18 => 'Graduate Level');
2113: return &mt($gradelevels{$gradelevel});
2114: }
2115:
1.163 www 2116: sub select_level_form {
2117: my ($deflevel,$name)=@_;
2118: unless ($deflevel) { $deflevel=0; }
1.167 www 2119: my $selectform = "<select name=\"$name\" size=\"1\">\n";
2120: for (my $i=0; $i<=18; $i++) {
2121: $selectform.="<option value=\"$i\" ".
1.253 albertel 2122: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 2123: ">".&gradeleveldescription($i)."</option>\n";
2124: }
2125: $selectform.="</select>";
2126: return $selectform;
1.163 www 2127: }
1.167 www 2128:
1.35 matthew 2129: #-------------------------------------------
2130:
1.45 matthew 2131: =pod
2132:
1.910 raeburn 2133: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35 matthew 2134:
2135: Returns a string containing a <select name='$name' size='1'> form to
2136: allow a user to select the domain to preform an operation in.
2137: See loncreateuser.pm for an example invocation and use.
2138:
1.90 www 2139: If the $includeempty flag is set, it also includes an empty choice ("no domain
2140: selected");
2141:
1.743 raeburn 2142: If the $showdomdesc flag is set, the domain name is followed by the domain description.
2143:
1.910 raeburn 2144: The optional $onchange argument specifies what should occur if the domain selector is changed, e.g., 'this.form.submit()' if the form is to be automatically submitted.
2145:
2146: The optional $incdoms is a reference to an array of domains which will be the only available options.
1.563 raeburn 2147:
1.35 matthew 2148: =cut
2149:
2150: #-------------------------------------------
1.34 matthew 2151: sub select_dom_form {
1.910 raeburn 2152: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.872 raeburn 2153: if ($onchange) {
1.874 raeburn 2154: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 2155: }
1.910 raeburn 2156: my @domains;
2157: if (ref($incdoms) eq 'ARRAY') {
2158: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
2159: } else {
2160: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
2161: }
1.90 www 2162: if ($includeempty) { @domains=('',@domains); }
1.743 raeburn 2163: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 2164: foreach my $dom (@domains) {
2165: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 2166: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
2167: if ($showdomdesc) {
2168: if ($dom ne '') {
2169: my $domdesc = &Apache::lonnet::domain($dom,'description');
2170: if ($domdesc ne '') {
2171: $selectdomain .= ' ('.$domdesc.')';
2172: }
2173: }
2174: }
2175: $selectdomain .= "</option>\n";
1.34 matthew 2176: }
2177: $selectdomain.="</select>";
2178: return $selectdomain;
2179: }
2180:
1.35 matthew 2181: #-------------------------------------------
2182:
1.45 matthew 2183: =pod
2184:
1.648 raeburn 2185: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 2186:
1.586 raeburn 2187: input: 4 arguments (two required, two optional) -
2188: $domain - domain of new user
2189: $name - name of form element
2190: $default - Value of 'default' causes a default item to be first
2191: option, and selected by default.
2192: $hide - Value of 'hide' causes hiding of the name of the server,
2193: if 1 server found, or default, if 0 found.
1.594 raeburn 2194: output: returns 2 items:
1.586 raeburn 2195: (a) form element which contains either:
2196: (i) <select name="$name">
2197: <option value="$hostid1">$hostid $servers{$hostid}</option>
2198: <option value="$hostid2">$hostid $servers{$hostid}</option>
2199: </select>
2200: form item if there are multiple library servers in $domain, or
2201: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2202: if there is only one library server in $domain.
2203:
2204: (b) number of library servers found.
2205:
2206: See loncreateuser.pm for example of use.
1.35 matthew 2207:
2208: =cut
2209:
2210: #-------------------------------------------
1.586 raeburn 2211: sub home_server_form_item {
2212: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2213: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2214: my $result;
2215: my $numlib = keys(%servers);
2216: if ($numlib > 1) {
2217: $result .= '<select name="'.$name.'" />'."\n";
2218: if ($default) {
1.804 bisitz 2219: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 2220: '</option>'."\n";
2221: }
2222: foreach my $hostid (sort(keys(%servers))) {
2223: $result.= '<option value="'.$hostid.'">'.
2224: $hostid.' '.$servers{$hostid}."</option>\n";
2225: }
2226: $result .= '</select>'."\n";
2227: } elsif ($numlib == 1) {
2228: my $hostid;
2229: foreach my $item (keys(%servers)) {
2230: $hostid = $item;
2231: }
2232: $result .= '<input type="hidden" name="'.$name.'" value="'.
2233: $hostid.'" />';
2234: if (!$hide) {
2235: $result .= $hostid.' '.$servers{$hostid};
2236: }
2237: $result .= "\n";
2238: } elsif ($default) {
2239: $result .= '<input type="hidden" name="'.$name.
2240: '" value="default" />';
2241: if (!$hide) {
2242: $result .= &mt('default');
2243: }
2244: $result .= "\n";
1.33 matthew 2245: }
1.586 raeburn 2246: return ($result,$numlib);
1.33 matthew 2247: }
1.112 bowersj2 2248:
2249: =pod
2250:
1.534 albertel 2251: =back
2252:
1.112 bowersj2 2253: =cut
1.87 matthew 2254:
2255: ###############################################################
1.112 bowersj2 2256: ## Decoding User Agent ##
1.87 matthew 2257: ###############################################################
2258:
2259: =pod
2260:
1.112 bowersj2 2261: =head1 Decoding the User Agent
2262:
2263: =over 4
2264:
2265: =item * &decode_user_agent()
1.87 matthew 2266:
2267: Inputs: $r
2268:
2269: Outputs:
2270:
2271: =over 4
2272:
1.112 bowersj2 2273: =item * $httpbrowser
1.87 matthew 2274:
1.112 bowersj2 2275: =item * $clientbrowser
1.87 matthew 2276:
1.112 bowersj2 2277: =item * $clientversion
1.87 matthew 2278:
1.112 bowersj2 2279: =item * $clientmathml
1.87 matthew 2280:
1.112 bowersj2 2281: =item * $clientunicode
1.87 matthew 2282:
1.112 bowersj2 2283: =item * $clientos
1.87 matthew 2284:
2285: =back
2286:
1.157 matthew 2287: =back
2288:
1.87 matthew 2289: =cut
2290:
2291: ###############################################################
2292: ###############################################################
2293: sub decode_user_agent {
1.247 albertel 2294: my ($r)=@_;
1.87 matthew 2295: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2296: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2297: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2298: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2299: my $clientbrowser='unknown';
2300: my $clientversion='0';
2301: my $clientmathml='';
2302: my $clientunicode='0';
2303: for (my $i=0;$i<=$#browsertype;$i++) {
2304: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
2305: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2306: $clientbrowser=$bname;
2307: $httpbrowser=~/$vreg/i;
2308: $clientversion=$1;
2309: $clientmathml=($clientversion>=$minv);
2310: $clientunicode=($clientversion>=$univ);
2311: }
2312: }
2313: my $clientos='unknown';
2314: if (($httpbrowser=~/linux/i) ||
2315: ($httpbrowser=~/unix/i) ||
2316: ($httpbrowser=~/ux/i) ||
2317: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2318: if (($httpbrowser=~/vax/i) ||
2319: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2320: if ($httpbrowser=~/next/i) { $clientos='next'; }
2321: if (($httpbrowser=~/mac/i) ||
2322: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
2323: if ($httpbrowser=~/win/i) { $clientos='win'; }
2324: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
2325: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
2326: $clientunicode,$clientos,);
2327: }
2328:
1.32 matthew 2329: ###############################################################
2330: ## Authentication changing form generation subroutines ##
2331: ###############################################################
2332: ##
2333: ## All of the authform_xxxxxxx subroutines take their inputs in a
2334: ## hash, and have reasonable default values.
2335: ##
2336: ## formname = the name given in the <form> tag.
1.35 matthew 2337: #-------------------------------------------
2338:
1.45 matthew 2339: =pod
2340:
1.112 bowersj2 2341: =head1 Authentication Routines
2342:
2343: =over 4
2344:
1.648 raeburn 2345: =item * &authform_xxxxxx()
1.35 matthew 2346:
2347: The authform_xxxxxx subroutines provide javascript and html forms which
2348: handle some of the conveniences required for authentication forms.
2349: This is not an optimal method, but it works.
2350:
2351: =over 4
2352:
1.112 bowersj2 2353: =item * authform_header
1.35 matthew 2354:
1.112 bowersj2 2355: =item * authform_authorwarning
1.35 matthew 2356:
1.112 bowersj2 2357: =item * authform_nochange
1.35 matthew 2358:
1.112 bowersj2 2359: =item * authform_kerberos
1.35 matthew 2360:
1.112 bowersj2 2361: =item * authform_internal
1.35 matthew 2362:
1.112 bowersj2 2363: =item * authform_filesystem
1.35 matthew 2364:
2365: =back
2366:
1.648 raeburn 2367: See loncreateuser.pm for invocation and use examples.
1.157 matthew 2368:
1.35 matthew 2369: =cut
2370:
2371: #-------------------------------------------
1.32 matthew 2372: sub authform_header{
2373: my %in = (
2374: formname => 'cu',
1.80 albertel 2375: kerb_def_dom => '',
1.32 matthew 2376: @_,
2377: );
2378: $in{'formname'} = 'document.' . $in{'formname'};
2379: my $result='';
1.80 albertel 2380:
2381: #---------------------------------------------- Code for upper case translation
2382: my $Javascript_toUpperCase;
2383: unless ($in{kerb_def_dom}) {
2384: $Javascript_toUpperCase =<<"END";
2385: switch (choice) {
2386: case 'krb': currentform.elements[choicearg].value =
2387: currentform.elements[choicearg].value.toUpperCase();
2388: break;
2389: default:
2390: }
2391: END
2392: } else {
2393: $Javascript_toUpperCase = "";
2394: }
2395:
1.165 raeburn 2396: my $radioval = "'nochange'";
1.591 raeburn 2397: if (defined($in{'curr_authtype'})) {
2398: if ($in{'curr_authtype'} ne '') {
2399: $radioval = "'".$in{'curr_authtype'}."arg'";
2400: }
1.174 matthew 2401: }
1.165 raeburn 2402: my $argfield = 'null';
1.591 raeburn 2403: if (defined($in{'mode'})) {
1.165 raeburn 2404: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2405: if (defined($in{'curr_autharg'})) {
2406: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2407: $argfield = "'$in{'curr_autharg'}'";
2408: }
2409: }
2410: }
2411: }
2412:
1.32 matthew 2413: $result.=<<"END";
2414: var current = new Object();
1.165 raeburn 2415: current.radiovalue = $radioval;
2416: current.argfield = $argfield;
1.32 matthew 2417:
2418: function changed_radio(choice,currentform) {
2419: var choicearg = choice + 'arg';
2420: // If a radio button in changed, we need to change the argfield
2421: if (current.radiovalue != choice) {
2422: current.radiovalue = choice;
2423: if (current.argfield != null) {
2424: currentform.elements[current.argfield].value = '';
2425: }
2426: if (choice == 'nochange') {
2427: current.argfield = null;
2428: } else {
2429: current.argfield = choicearg;
2430: switch(choice) {
2431: case 'krb':
2432: currentform.elements[current.argfield].value =
2433: "$in{'kerb_def_dom'}";
2434: break;
2435: default:
2436: break;
2437: }
2438: }
2439: }
2440: return;
2441: }
1.22 www 2442:
1.32 matthew 2443: function changed_text(choice,currentform) {
2444: var choicearg = choice + 'arg';
2445: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2446: $Javascript_toUpperCase
1.32 matthew 2447: // clear old field
2448: if ((current.argfield != choicearg) && (current.argfield != null)) {
2449: currentform.elements[current.argfield].value = '';
2450: }
2451: current.argfield = choicearg;
2452: }
2453: set_auth_radio_buttons(choice,currentform);
2454: return;
1.20 www 2455: }
1.32 matthew 2456:
2457: function set_auth_radio_buttons(newvalue,currentform) {
1.986 raeburn 2458: var numauthchoices = currentform.login.length;
2459: if (typeof numauthchoices == "undefined") {
2460: return;
2461: }
1.32 matthew 2462: var i=0;
1.986 raeburn 2463: while (i < numauthchoices) {
1.32 matthew 2464: if (currentform.login[i].value == newvalue) { break; }
2465: i++;
2466: }
1.986 raeburn 2467: if (i == numauthchoices) {
1.32 matthew 2468: return;
2469: }
2470: current.radiovalue = newvalue;
2471: currentform.login[i].checked = true;
2472: return;
2473: }
2474: END
2475: return $result;
2476: }
2477:
2478: sub authform_authorwarning{
2479: my $result='';
1.144 matthew 2480: $result='<i>'.
2481: &mt('As a general rule, only authors or co-authors should be '.
2482: 'filesystem authenticated '.
2483: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2484: return $result;
2485: }
2486:
2487: sub authform_nochange{
2488: my %in = (
2489: formname => 'document.cu',
2490: kerb_def_dom => 'MSU.EDU',
2491: @_,
2492: );
1.586 raeburn 2493: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2494: my $result;
2495: if (keys(%can_assign) == 0) {
2496: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2497: } else {
2498: $result = '<label>'.&mt('[_1] Do not change login data',
2499: '<input type="radio" name="login" value="nochange" '.
2500: 'checked="checked" onclick="'.
1.281 albertel 2501: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2502: '</label>';
1.586 raeburn 2503: }
1.32 matthew 2504: return $result;
2505: }
2506:
1.591 raeburn 2507: sub authform_kerberos {
1.32 matthew 2508: my %in = (
2509: formname => 'document.cu',
2510: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2511: kerb_def_auth => 'krb4',
1.32 matthew 2512: @_,
2513: );
1.586 raeburn 2514: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2515: $autharg,$jscall);
2516: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2517: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2518: $check5 = ' checked="checked"';
1.80 albertel 2519: } else {
1.772 bisitz 2520: $check4 = ' checked="checked"';
1.80 albertel 2521: }
1.165 raeburn 2522: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2523: if (defined($in{'curr_authtype'})) {
2524: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2525: $krbcheck = ' checked="checked"';
1.623 raeburn 2526: if (defined($in{'mode'})) {
2527: if ($in{'mode'} eq 'modifyuser') {
2528: $krbcheck = '';
2529: }
2530: }
1.591 raeburn 2531: if (defined($in{'curr_kerb_ver'})) {
2532: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2533: $check5 = ' checked="checked"';
1.591 raeburn 2534: $check4 = '';
2535: } else {
1.772 bisitz 2536: $check4 = ' checked="checked"';
1.591 raeburn 2537: $check5 = '';
2538: }
1.586 raeburn 2539: }
1.591 raeburn 2540: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2541: $krbarg = $in{'curr_autharg'};
2542: }
1.586 raeburn 2543: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2544: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2545: $result =
2546: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2547: $in{'curr_autharg'},$krbver);
2548: } else {
2549: $result =
2550: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2551: }
2552: return $result;
2553: }
2554: }
2555: } else {
2556: if ($authnum == 1) {
1.784 bisitz 2557: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2558: }
2559: }
1.586 raeburn 2560: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2561: return;
1.587 raeburn 2562: } elsif ($authtype eq '') {
1.591 raeburn 2563: if (defined($in{'mode'})) {
1.587 raeburn 2564: if ($in{'mode'} eq 'modifycourse') {
2565: if ($authnum == 1) {
1.784 bisitz 2566: $authtype = '<input type="hidden" name="login" value="krb" />';
1.587 raeburn 2567: }
2568: }
2569: }
1.586 raeburn 2570: }
2571: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2572: if ($authtype eq '') {
2573: $authtype = '<input type="radio" name="login" value="krb" '.
2574: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2575: $krbcheck.' />';
2576: }
2577: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2578: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2579: $in{'curr_authtype'} eq 'krb5') ||
2580: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2581: $in{'curr_authtype'} eq 'krb4')) {
2582: $result .= &mt
1.144 matthew 2583: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2584: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2585: '<label>'.$authtype,
1.281 albertel 2586: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2587: 'value="'.$krbarg.'" '.
1.144 matthew 2588: 'onchange="'.$jscall.'" />',
1.281 albertel 2589: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2590: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2591: '</label>');
1.586 raeburn 2592: } elsif ($can_assign{'krb4'}) {
2593: $result .= &mt
2594: ('[_1] Kerberos authenticated with domain [_2] '.
2595: '[_3] Version 4 [_4]',
2596: '<label>'.$authtype,
2597: '</label><input type="text" size="10" name="krbarg" '.
2598: 'value="'.$krbarg.'" '.
2599: 'onchange="'.$jscall.'" />',
2600: '<label><input type="hidden" name="krbver" value="4" />',
2601: '</label>');
2602: } elsif ($can_assign{'krb5'}) {
2603: $result .= &mt
2604: ('[_1] Kerberos authenticated with domain [_2] '.
2605: '[_3] Version 5 [_4]',
2606: '<label>'.$authtype,
2607: '</label><input type="text" size="10" name="krbarg" '.
2608: 'value="'.$krbarg.'" '.
2609: 'onchange="'.$jscall.'" />',
2610: '<label><input type="hidden" name="krbver" value="5" />',
2611: '</label>');
2612: }
1.32 matthew 2613: return $result;
2614: }
2615:
2616: sub authform_internal{
1.586 raeburn 2617: my %in = (
1.32 matthew 2618: formname => 'document.cu',
2619: kerb_def_dom => 'MSU.EDU',
2620: @_,
2621: );
1.586 raeburn 2622: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2623: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2624: if (defined($in{'curr_authtype'})) {
2625: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2626: if ($can_assign{'int'}) {
1.772 bisitz 2627: $intcheck = 'checked="checked" ';
1.623 raeburn 2628: if (defined($in{'mode'})) {
2629: if ($in{'mode'} eq 'modifyuser') {
2630: $intcheck = '';
2631: }
2632: }
1.591 raeburn 2633: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2634: $intarg = $in{'curr_autharg'};
2635: }
2636: } else {
2637: $result = &mt('Currently internally authenticated.');
2638: return $result;
1.165 raeburn 2639: }
2640: }
1.586 raeburn 2641: } else {
2642: if ($authnum == 1) {
1.784 bisitz 2643: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 2644: }
2645: }
2646: if (!$can_assign{'int'}) {
2647: return;
1.587 raeburn 2648: } elsif ($authtype eq '') {
1.591 raeburn 2649: if (defined($in{'mode'})) {
1.587 raeburn 2650: if ($in{'mode'} eq 'modifycourse') {
2651: if ($authnum == 1) {
1.784 bisitz 2652: $authtype = '<input type="hidden" name="login" value="int" />';
1.587 raeburn 2653: }
2654: }
2655: }
1.165 raeburn 2656: }
1.586 raeburn 2657: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2658: if ($authtype eq '') {
2659: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2660: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2661: }
1.605 bisitz 2662: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2663: $intarg.'" onchange="'.$jscall.'" />';
2664: $result = &mt
1.144 matthew 2665: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2666: '<label>'.$authtype,'</label>'.$autharg);
1.824 bisitz 2667: $result.="<label><input type=\"checkbox\" name=\"visible\" onclick='if (this.checked) { this.form.intarg.type=\"text\" } else { this.form.intarg.type=\"password\" }' />".&mt('Visible input').'</label>';
1.32 matthew 2668: return $result;
2669: }
2670:
2671: sub authform_local{
2672: my %in = (
2673: formname => 'document.cu',
2674: kerb_def_dom => 'MSU.EDU',
2675: @_,
2676: );
1.586 raeburn 2677: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2678: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2679: if (defined($in{'curr_authtype'})) {
2680: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2681: if ($can_assign{'loc'}) {
1.772 bisitz 2682: $loccheck = 'checked="checked" ';
1.623 raeburn 2683: if (defined($in{'mode'})) {
2684: if ($in{'mode'} eq 'modifyuser') {
2685: $loccheck = '';
2686: }
2687: }
1.591 raeburn 2688: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2689: $locarg = $in{'curr_autharg'};
2690: }
2691: } else {
2692: $result = &mt('Currently using local (institutional) authentication.');
2693: return $result;
1.165 raeburn 2694: }
2695: }
1.586 raeburn 2696: } else {
2697: if ($authnum == 1) {
1.784 bisitz 2698: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 2699: }
2700: }
2701: if (!$can_assign{'loc'}) {
2702: return;
1.587 raeburn 2703: } elsif ($authtype eq '') {
1.591 raeburn 2704: if (defined($in{'mode'})) {
1.587 raeburn 2705: if ($in{'mode'} eq 'modifycourse') {
2706: if ($authnum == 1) {
1.784 bisitz 2707: $authtype = '<input type="hidden" name="login" value="loc" />';
1.587 raeburn 2708: }
2709: }
2710: }
1.165 raeburn 2711: }
1.586 raeburn 2712: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2713: if ($authtype eq '') {
2714: $authtype = '<input type="radio" name="login" value="loc" '.
2715: $loccheck.' onchange="'.$jscall.'" onclick="'.
2716: $jscall.'" />';
2717: }
2718: $autharg = '<input type="text" size="10" name="locarg" value="'.
2719: $locarg.'" onchange="'.$jscall.'" />';
2720: $result = &mt('[_1] Local Authentication with argument [_2]',
2721: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2722: return $result;
2723: }
2724:
2725: sub authform_filesystem{
2726: my %in = (
2727: formname => 'document.cu',
2728: kerb_def_dom => 'MSU.EDU',
2729: @_,
2730: );
1.586 raeburn 2731: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2732: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2733: if (defined($in{'curr_authtype'})) {
2734: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2735: if ($can_assign{'fsys'}) {
1.772 bisitz 2736: $fsyscheck = 'checked="checked" ';
1.623 raeburn 2737: if (defined($in{'mode'})) {
2738: if ($in{'mode'} eq 'modifyuser') {
2739: $fsyscheck = '';
2740: }
2741: }
1.586 raeburn 2742: } else {
2743: $result = &mt('Currently Filesystem Authenticated.');
2744: return $result;
2745: }
2746: }
2747: } else {
2748: if ($authnum == 1) {
1.784 bisitz 2749: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 2750: }
2751: }
2752: if (!$can_assign{'fsys'}) {
2753: return;
1.587 raeburn 2754: } elsif ($authtype eq '') {
1.591 raeburn 2755: if (defined($in{'mode'})) {
1.587 raeburn 2756: if ($in{'mode'} eq 'modifycourse') {
2757: if ($authnum == 1) {
1.784 bisitz 2758: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587 raeburn 2759: }
2760: }
2761: }
1.586 raeburn 2762: }
2763: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2764: if ($authtype eq '') {
2765: $authtype = '<input type="radio" name="login" value="fsys" '.
2766: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2767: $jscall.'" />';
2768: }
2769: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2770: ' onchange="'.$jscall.'" />';
2771: $result = &mt
1.144 matthew 2772: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2773: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2774: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2775: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2776: 'onchange="'.$jscall.'" />');
1.32 matthew 2777: return $result;
2778: }
2779:
1.586 raeburn 2780: sub get_assignable_auth {
2781: my ($dom) = @_;
2782: if ($dom eq '') {
2783: $dom = $env{'request.role.domain'};
2784: }
2785: my %can_assign = (
2786: krb4 => 1,
2787: krb5 => 1,
2788: int => 1,
2789: loc => 1,
2790: );
2791: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2792: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2793: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2794: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2795: my $context;
2796: if ($env{'request.role'} =~ /^au/) {
2797: $context = 'author';
2798: } elsif ($env{'request.role'} =~ /^dc/) {
2799: $context = 'domain';
2800: } elsif ($env{'request.course.id'}) {
2801: $context = 'course';
2802: }
2803: if ($context) {
2804: if (ref($authhash->{$context}) eq 'HASH') {
2805: %can_assign = %{$authhash->{$context}};
2806: }
2807: }
2808: }
2809: }
2810: my $authnum = 0;
2811: foreach my $key (keys(%can_assign)) {
2812: if ($can_assign{$key}) {
2813: $authnum ++;
2814: }
2815: }
2816: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2817: $authnum --;
2818: }
2819: return ($authnum,%can_assign);
2820: }
2821:
1.80 albertel 2822: ###############################################################
2823: ## Get Kerberos Defaults for Domain ##
2824: ###############################################################
2825: ##
2826: ## Returns default kerberos version and an associated argument
2827: ## as listed in file domain.tab. If not listed, provides
2828: ## appropriate default domain and kerberos version.
2829: ##
2830: #-------------------------------------------
2831:
2832: =pod
2833:
1.648 raeburn 2834: =item * &get_kerberos_defaults()
1.80 albertel 2835:
2836: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2837: version and domain. If not found, it defaults to version 4 and the
2838: domain of the server.
1.80 albertel 2839:
1.648 raeburn 2840: =over 4
2841:
1.80 albertel 2842: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2843:
1.648 raeburn 2844: =back
2845:
2846: =back
2847:
1.80 albertel 2848: =cut
2849:
2850: #-------------------------------------------
2851: sub get_kerberos_defaults {
2852: my $domain=shift;
1.641 raeburn 2853: my ($krbdef,$krbdefdom);
2854: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2855: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2856: $krbdef = $domdefaults{'auth_def'};
2857: $krbdefdom = $domdefaults{'auth_arg_def'};
2858: } else {
1.80 albertel 2859: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2860: my $krbdefdom=$1;
2861: $krbdefdom=~tr/a-z/A-Z/;
2862: $krbdef = "krb4";
2863: }
2864: return ($krbdef,$krbdefdom);
2865: }
1.112 bowersj2 2866:
1.32 matthew 2867:
1.46 matthew 2868: ###############################################################
2869: ## Thesaurus Functions ##
2870: ###############################################################
1.20 www 2871:
1.46 matthew 2872: =pod
1.20 www 2873:
1.112 bowersj2 2874: =head1 Thesaurus Functions
2875:
2876: =over 4
2877:
1.648 raeburn 2878: =item * &initialize_keywords()
1.46 matthew 2879:
2880: Initializes the package variable %Keywords if it is empty. Uses the
2881: package variable $thesaurus_db_file.
2882:
2883: =cut
2884:
2885: ###################################################
2886:
2887: sub initialize_keywords {
2888: return 1 if (scalar keys(%Keywords));
2889: # If we are here, %Keywords is empty, so fill it up
2890: # Make sure the file we need exists...
2891: if (! -e $thesaurus_db_file) {
2892: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2893: " failed because it does not exist");
2894: return 0;
2895: }
2896: # Set up the hash as a database
2897: my %thesaurus_db;
2898: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2899: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2900: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2901: $thesaurus_db_file);
2902: return 0;
2903: }
2904: # Get the average number of appearances of a word.
2905: my $avecount = $thesaurus_db{'average.count'};
2906: # Put keywords (those that appear > average) into %Keywords
2907: while (my ($word,$data)=each (%thesaurus_db)) {
2908: my ($count,undef) = split /:/,$data;
2909: $Keywords{$word}++ if ($count > $avecount);
2910: }
2911: untie %thesaurus_db;
2912: # Remove special values from %Keywords.
1.356 albertel 2913: foreach my $value ('total.count','average.count') {
2914: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2915: }
1.46 matthew 2916: return 1;
2917: }
2918:
2919: ###################################################
2920:
2921: =pod
2922:
1.648 raeburn 2923: =item * &keyword($word)
1.46 matthew 2924:
2925: Returns true if $word is a keyword. A keyword is a word that appears more
2926: than the average number of times in the thesaurus database. Calls
2927: &initialize_keywords
2928:
2929: =cut
2930:
2931: ###################################################
1.20 www 2932:
2933: sub keyword {
1.46 matthew 2934: return if (!&initialize_keywords());
2935: my $word=lc(shift());
2936: $word=~s/\W//g;
2937: return exists($Keywords{$word});
1.20 www 2938: }
1.46 matthew 2939:
2940: ###############################################################
2941:
2942: =pod
1.20 www 2943:
1.648 raeburn 2944: =item * &get_related_words()
1.46 matthew 2945:
1.160 matthew 2946: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2947: an array of words. If the keyword is not in the thesaurus, an empty array
2948: will be returned. The order of the words returned is determined by the
2949: database which holds them.
2950:
2951: Uses global $thesaurus_db_file.
2952:
1.1057 foxr 2953:
1.46 matthew 2954: =cut
2955:
2956: ###############################################################
2957: sub get_related_words {
2958: my $keyword = shift;
2959: my %thesaurus_db;
2960: if (! -e $thesaurus_db_file) {
2961: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2962: "failed because the file does not exist");
2963: return ();
2964: }
2965: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2966: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2967: return ();
2968: }
2969: my @Words=();
1.429 www 2970: my $count=0;
1.46 matthew 2971: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2972: # The first element is the number of times
2973: # the word appears. We do not need it now.
1.429 www 2974: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2975: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2976: my $threshold=$mostfrequentcount/10;
2977: foreach my $possibleword (@RelatedWords) {
2978: my ($word,$wordcount)=split(/\,/,$possibleword);
2979: if ($wordcount>$threshold) {
2980: push(@Words,$word);
2981: $count++;
2982: if ($count>10) { last; }
2983: }
1.20 www 2984: }
2985: }
1.46 matthew 2986: untie %thesaurus_db;
2987: return @Words;
1.14 harris41 2988: }
1.46 matthew 2989:
1.112 bowersj2 2990: =pod
2991:
2992: =back
2993:
2994: =cut
1.61 www 2995:
2996: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2997: =pod
2998:
1.112 bowersj2 2999: =head1 User Name Functions
3000:
3001: =over 4
3002:
1.648 raeburn 3003: =item * &plainname($uname,$udom,$first)
1.81 albertel 3004:
1.112 bowersj2 3005: Takes a users logon name and returns it as a string in
1.226 albertel 3006: "first middle last generation" form
3007: if $first is set to 'lastname' then it returns it as
3008: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 3009:
3010: =cut
1.61 www 3011:
1.295 www 3012:
1.81 albertel 3013: ###############################################################
1.61 www 3014: sub plainname {
1.226 albertel 3015: my ($uname,$udom,$first)=@_;
1.537 albertel 3016: return if (!defined($uname) || !defined($udom));
1.295 www 3017: my %names=&getnames($uname,$udom);
1.226 albertel 3018: my $name=&Apache::lonnet::format_name($names{'firstname'},
3019: $names{'middlename'},
3020: $names{'lastname'},
3021: $names{'generation'},$first);
3022: $name=~s/^\s+//;
1.62 www 3023: $name=~s/\s+$//;
3024: $name=~s/\s+/ /g;
1.353 albertel 3025: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 3026: return $name;
1.61 www 3027: }
1.66 www 3028:
3029: # -------------------------------------------------------------------- Nickname
1.81 albertel 3030: =pod
3031:
1.648 raeburn 3032: =item * &nickname($uname,$udom)
1.81 albertel 3033:
3034: Gets a users name and returns it as a string as
3035:
3036: ""nickname""
1.66 www 3037:
1.81 albertel 3038: if the user has a nickname or
3039:
3040: "first middle last generation"
3041:
3042: if the user does not
3043:
3044: =cut
1.66 www 3045:
3046: sub nickname {
3047: my ($uname,$udom)=@_;
1.537 albertel 3048: return if (!defined($uname) || !defined($udom));
1.295 www 3049: my %names=&getnames($uname,$udom);
1.68 albertel 3050: my $name=$names{'nickname'};
1.66 www 3051: if ($name) {
3052: $name='"'.$name.'"';
3053: } else {
3054: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
3055: $names{'lastname'}.' '.$names{'generation'};
3056: $name=~s/\s+$//;
3057: $name=~s/\s+/ /g;
3058: }
3059: return $name;
3060: }
3061:
1.295 www 3062: sub getnames {
3063: my ($uname,$udom)=@_;
1.537 albertel 3064: return if (!defined($uname) || !defined($udom));
1.433 albertel 3065: if ($udom eq 'public' && $uname eq 'public') {
3066: return ('lastname' => &mt('Public'));
3067: }
1.295 www 3068: my $id=$uname.':'.$udom;
3069: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
3070: if ($cached) {
3071: return %{$names};
3072: } else {
3073: my %loadnames=&Apache::lonnet::get('environment',
3074: ['firstname','middlename','lastname','generation','nickname'],
3075: $udom,$uname);
3076: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
3077: return %loadnames;
3078: }
3079: }
1.61 www 3080:
1.542 raeburn 3081: # -------------------------------------------------------------------- getemails
1.648 raeburn 3082:
1.542 raeburn 3083: =pod
3084:
1.648 raeburn 3085: =item * &getemails($uname,$udom)
1.542 raeburn 3086:
3087: Gets a user's email information and returns it as a hash with keys:
3088: notification, critnotification, permanentemail
3089:
3090: For notification and critnotification, values are comma-separated lists
1.648 raeburn 3091: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 3092:
1.648 raeburn 3093:
1.542 raeburn 3094: =cut
3095:
1.648 raeburn 3096:
1.466 albertel 3097: sub getemails {
3098: my ($uname,$udom)=@_;
3099: if ($udom eq 'public' && $uname eq 'public') {
3100: return;
3101: }
1.467 www 3102: if (!$udom) { $udom=$env{'user.domain'}; }
3103: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 3104: my $id=$uname.':'.$udom;
3105: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
3106: if ($cached) {
3107: return %{$names};
3108: } else {
3109: my %loadnames=&Apache::lonnet::get('environment',
3110: ['notification','critnotification',
3111: 'permanentemail'],
3112: $udom,$uname);
3113: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
3114: return %loadnames;
3115: }
3116: }
3117:
1.551 albertel 3118: sub flush_email_cache {
3119: my ($uname,$udom)=@_;
3120: if (!$udom) { $udom =$env{'user.domain'}; }
3121: if (!$uname) { $uname=$env{'user.name'}; }
3122: return if ($udom eq 'public' && $uname eq 'public');
3123: my $id=$uname.':'.$udom;
3124: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
3125: }
3126:
1.728 raeburn 3127: # -------------------------------------------------------------------- getlangs
3128:
3129: =pod
3130:
3131: =item * &getlangs($uname,$udom)
3132:
3133: Gets a user's language preference and returns it as a hash with key:
3134: language.
3135:
3136: =cut
3137:
3138:
3139: sub getlangs {
3140: my ($uname,$udom) = @_;
3141: if (!$udom) { $udom =$env{'user.domain'}; }
3142: if (!$uname) { $uname=$env{'user.name'}; }
3143: my $id=$uname.':'.$udom;
3144: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
3145: if ($cached) {
3146: return %{$langs};
3147: } else {
3148: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
3149: $udom,$uname);
3150: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
3151: return %loadlangs;
3152: }
3153: }
3154:
3155: sub flush_langs_cache {
3156: my ($uname,$udom)=@_;
3157: if (!$udom) { $udom =$env{'user.domain'}; }
3158: if (!$uname) { $uname=$env{'user.name'}; }
3159: return if ($udom eq 'public' && $uname eq 'public');
3160: my $id=$uname.':'.$udom;
3161: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
3162: }
3163:
1.61 www 3164: # ------------------------------------------------------------------ Screenname
1.81 albertel 3165:
3166: =pod
3167:
1.648 raeburn 3168: =item * &screenname($uname,$udom)
1.81 albertel 3169:
3170: Gets a users screenname and returns it as a string
3171:
3172: =cut
1.61 www 3173:
3174: sub screenname {
3175: my ($uname,$udom)=@_;
1.258 albertel 3176: if ($uname eq $env{'user.name'} &&
3177: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 3178: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 3179: return $names{'screenname'};
1.62 www 3180: }
3181:
1.212 albertel 3182:
1.802 bisitz 3183: # ------------------------------------------------------------- Confirm Wrapper
3184: =pod
3185:
3186: =item confirmwrapper
3187:
3188: Wrap messages about completion of operation in box
3189:
3190: =cut
3191:
3192: sub confirmwrapper {
3193: my ($message)=@_;
3194: if ($message) {
3195: return "\n".'<div class="LC_confirm_box">'."\n"
3196: .$message."\n"
3197: .'</div>'."\n";
3198: } else {
3199: return $message;
3200: }
3201: }
3202:
1.62 www 3203: # ------------------------------------------------------------- Message Wrapper
3204:
3205: sub messagewrapper {
1.369 www 3206: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 3207: return
1.441 albertel 3208: '<a href="/adm/email?compose=individual&'.
3209: 'recname='.$username.'&recdom='.$domain.
3210: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 3211: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 3212: }
1.802 bisitz 3213:
1.74 www 3214: # --------------------------------------------------------------- Notes Wrapper
3215:
3216: sub noteswrapper {
3217: my ($link,$un,$do)=@_;
3218: return
1.896 amueller 3219: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 3220: }
1.802 bisitz 3221:
1.62 www 3222: # ------------------------------------------------------------- Aboutme Wrapper
3223:
3224: sub aboutmewrapper {
1.1070 raeburn 3225: my ($link,$username,$domain,$target,$class)=@_;
1.447 raeburn 3226: if (!defined($username) && !defined($domain)) {
3227: return;
3228: }
1.892 amueller 3229: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.1070 raeburn 3230: ($target?' target="'.$target.'"':'').($class?' class="'.$class.'"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 3231: }
3232:
3233: # ------------------------------------------------------------ Syllabus Wrapper
3234:
3235: sub syllabuswrapper {
1.707 bisitz 3236: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 3237: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 3238: }
1.14 harris41 3239:
1.802 bisitz 3240: # -----------------------------------------------------------------------------
3241:
1.208 matthew 3242: sub track_student_link {
1.887 raeburn 3243: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 3244: my $link ="/adm/trackstudent?";
1.208 matthew 3245: my $title = 'View recent activity';
3246: if (defined($sname) && $sname !~ /^\s*$/ &&
3247: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 3248: $link .= "selected_student=$sname:$sdom";
1.208 matthew 3249: $title .= ' of this student';
1.268 albertel 3250: }
1.208 matthew 3251: if (defined($target) && $target !~ /^\s*$/) {
3252: $target = qq{target="$target"};
3253: } else {
3254: $target = '';
3255: }
1.268 albertel 3256: if ($start) { $link.='&start='.$start; }
1.887 raeburn 3257: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 3258: $title = &mt($title);
3259: $linktext = &mt($linktext);
1.448 albertel 3260: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
3261: &help_open_topic('View_recent_activity');
1.208 matthew 3262: }
3263:
1.781 raeburn 3264: sub slot_reservations_link {
3265: my ($linktext,$sname,$sdom,$target) = @_;
3266: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
3267: my $title = 'View slot reservation history';
3268: if (defined($sname) && $sname !~ /^\s*$/ &&
3269: defined($sdom) && $sdom !~ /^\s*$/) {
3270: $link .= "&uname=$sname&udom=$sdom";
3271: $title .= ' of this student';
3272: }
3273: if (defined($target) && $target !~ /^\s*$/) {
3274: $target = qq{target="$target"};
3275: } else {
3276: $target = '';
3277: }
3278: $title = &mt($title);
3279: $linktext = &mt($linktext);
3280: return qq{<a href="$link" title="$title" $target>$linktext</a>};
3281: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
3282:
3283: }
3284:
1.508 www 3285: # ===================================================== Display a student photo
3286:
3287:
1.509 albertel 3288: sub student_image_tag {
1.508 www 3289: my ($domain,$user)=@_;
3290: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
3291: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
3292: return '<img src="'.$imgsrc.'" align="right" />';
3293: } else {
3294: return '';
3295: }
3296: }
3297:
1.112 bowersj2 3298: =pod
3299:
3300: =back
3301:
3302: =head1 Access .tab File Data
3303:
3304: =over 4
3305:
1.648 raeburn 3306: =item * &languageids()
1.112 bowersj2 3307:
3308: returns list of all language ids
3309:
3310: =cut
3311:
1.14 harris41 3312: sub languageids {
1.16 harris41 3313: return sort(keys(%language));
1.14 harris41 3314: }
3315:
1.112 bowersj2 3316: =pod
3317:
1.648 raeburn 3318: =item * &languagedescription()
1.112 bowersj2 3319:
3320: returns description of a specified language id
3321:
3322: =cut
3323:
1.14 harris41 3324: sub languagedescription {
1.125 www 3325: my $code=shift;
3326: return ($supported_language{$code}?'* ':'').
3327: $language{$code}.
1.126 www 3328: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 3329: }
3330:
1.1048 foxr 3331: =pod
3332:
3333: =item * &plainlanguagedescription
3334:
3335: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
3336: and the language character encoding (e.g. ISO) separated by a ' - ' string.
3337:
3338: =cut
3339:
1.145 www 3340: sub plainlanguagedescription {
3341: my $code=shift;
3342: return $language{$code};
3343: }
3344:
1.1048 foxr 3345: =pod
3346:
3347: =item * &supportedlanguagecode
3348:
3349: Returns the supported language code (e.g. sptutf maps to pt) given a language
3350: code.
3351:
3352: =cut
3353:
1.145 www 3354: sub supportedlanguagecode {
3355: my $code=shift;
3356: return $supported_language{$code};
1.97 www 3357: }
3358:
1.112 bowersj2 3359: =pod
3360:
1.1048 foxr 3361: =item * &latexlanguage()
3362:
3363: Given a language key code returns the correspondnig language to use
3364: to select the correct hyphenation on LaTeX printouts. This is undef if there
3365: is no supported hyphenation for the language code.
3366:
3367: =cut
3368:
3369: sub latexlanguage {
3370: my $code = shift;
3371: return $latex_language{$code};
3372: }
3373:
3374: =pod
3375:
3376: =item * &latexhyphenation()
3377:
3378: Same as above but what's supplied is the language as it might be stored
3379: in the metadata.
3380:
3381: =cut
3382:
3383: sub latexhyphenation {
3384: my $key = shift;
3385: return $latex_language_bykey{$key};
3386: }
3387:
3388: =pod
3389:
1.648 raeburn 3390: =item * ©rightids()
1.112 bowersj2 3391:
3392: returns list of all copyrights
3393:
3394: =cut
3395:
3396: sub copyrightids {
3397: return sort(keys(%cprtag));
3398: }
3399:
3400: =pod
3401:
1.648 raeburn 3402: =item * ©rightdescription()
1.112 bowersj2 3403:
3404: returns description of a specified copyright id
3405:
3406: =cut
3407:
3408: sub copyrightdescription {
1.166 www 3409: return &mt($cprtag{shift(@_)});
1.112 bowersj2 3410: }
1.197 matthew 3411:
3412: =pod
3413:
1.648 raeburn 3414: =item * &source_copyrightids()
1.192 taceyjo1 3415:
3416: returns list of all source copyrights
3417:
3418: =cut
3419:
3420: sub source_copyrightids {
3421: return sort(keys(%scprtag));
3422: }
3423:
3424: =pod
3425:
1.648 raeburn 3426: =item * &source_copyrightdescription()
1.192 taceyjo1 3427:
3428: returns description of a specified source copyright id
3429:
3430: =cut
3431:
3432: sub source_copyrightdescription {
3433: return &mt($scprtag{shift(@_)});
3434: }
1.112 bowersj2 3435:
3436: =pod
3437:
1.648 raeburn 3438: =item * &filecategories()
1.112 bowersj2 3439:
3440: returns list of all file categories
3441:
3442: =cut
3443:
3444: sub filecategories {
3445: return sort(keys(%category_extensions));
3446: }
3447:
3448: =pod
3449:
1.648 raeburn 3450: =item * &filecategorytypes()
1.112 bowersj2 3451:
3452: returns list of file types belonging to a given file
3453: category
3454:
3455: =cut
3456:
3457: sub filecategorytypes {
1.356 albertel 3458: my ($cat) = @_;
3459: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 3460: }
3461:
3462: =pod
3463:
1.648 raeburn 3464: =item * &fileembstyle()
1.112 bowersj2 3465:
3466: returns embedding style for a specified file type
3467:
3468: =cut
3469:
3470: sub fileembstyle {
3471: return $fe{lc(shift(@_))};
1.169 www 3472: }
3473:
1.351 www 3474: sub filemimetype {
3475: return $fm{lc(shift(@_))};
3476: }
3477:
1.169 www 3478:
3479: sub filecategoryselect {
3480: my ($name,$value)=@_;
1.189 matthew 3481: return &select_form($value,$name,
1.970 raeburn 3482: {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112 bowersj2 3483: }
3484:
3485: =pod
3486:
1.648 raeburn 3487: =item * &filedescription()
1.112 bowersj2 3488:
3489: returns description for a specified file type
3490:
3491: =cut
3492:
3493: sub filedescription {
1.188 matthew 3494: my $file_description = $fd{lc(shift())};
3495: $file_description =~ s:([\[\]]):~$1:g;
3496: return &mt($file_description);
1.112 bowersj2 3497: }
3498:
3499: =pod
3500:
1.648 raeburn 3501: =item * &filedescriptionex()
1.112 bowersj2 3502:
3503: returns description for a specified file type with
3504: extra formatting
3505:
3506: =cut
3507:
3508: sub filedescriptionex {
3509: my $ex=shift;
1.188 matthew 3510: my $file_description = $fd{lc($ex)};
3511: $file_description =~ s:([\[\]]):~$1:g;
3512: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3513: }
3514:
3515: # End of .tab access
3516: =pod
3517:
3518: =back
3519:
3520: =cut
3521:
3522: # ------------------------------------------------------------------ File Types
3523: sub fileextensions {
3524: return sort(keys(%fe));
3525: }
3526:
1.97 www 3527: # ----------------------------------------------------------- Display Languages
3528: # returns a hash with all desired display languages
3529: #
3530:
3531: sub display_languages {
3532: my %languages=();
1.695 raeburn 3533: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3534: $languages{$lang}=1;
1.97 www 3535: }
3536: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3537: if ($env{'form.displaylanguage'}) {
1.356 albertel 3538: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3539: $languages{$lang}=1;
1.97 www 3540: }
3541: }
3542: return %languages;
1.14 harris41 3543: }
3544:
1.582 albertel 3545: sub languages {
3546: my ($possible_langs) = @_;
1.695 raeburn 3547: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3548: if (!ref($possible_langs)) {
3549: if( wantarray ) {
3550: return @preferred_langs;
3551: } else {
3552: return $preferred_langs[0];
3553: }
3554: }
3555: my %possibilities = map { $_ => 1 } (@$possible_langs);
3556: my @preferred_possibilities;
3557: foreach my $preferred_lang (@preferred_langs) {
3558: if (exists($possibilities{$preferred_lang})) {
3559: push(@preferred_possibilities, $preferred_lang);
3560: }
3561: }
3562: if( wantarray ) {
3563: return @preferred_possibilities;
3564: }
3565: return $preferred_possibilities[0];
3566: }
3567:
1.742 raeburn 3568: sub user_lang {
3569: my ($touname,$toudom,$fromcid) = @_;
3570: my @userlangs;
3571: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3572: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3573: $env{'course.'.$fromcid.'.languages'}));
3574: } else {
3575: my %langhash = &getlangs($touname,$toudom);
3576: if ($langhash{'languages'} ne '') {
3577: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3578: } else {
3579: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3580: if ($domdefs{'lang_def'} ne '') {
3581: @userlangs = ($domdefs{'lang_def'});
3582: }
3583: }
3584: }
3585: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3586: my $user_lh = Apache::localize->get_handle(@languages);
3587: return $user_lh;
3588: }
3589:
3590:
1.112 bowersj2 3591: ###############################################################
3592: ## Student Answer Attempts ##
3593: ###############################################################
3594:
3595: =pod
3596:
3597: =head1 Alternate Problem Views
3598:
3599: =over 4
3600:
1.648 raeburn 3601: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3602: $getattempt, $regexp, $gradesub)
3603:
3604: Return string with previous attempt on problem. Arguments:
3605:
3606: =over 4
3607:
3608: =item * $symb: Problem, including path
3609:
3610: =item * $username: username of the desired student
3611:
3612: =item * $domain: domain of the desired student
1.14 harris41 3613:
1.112 bowersj2 3614: =item * $course: Course ID
1.14 harris41 3615:
1.112 bowersj2 3616: =item * $getattempt: Leave blank for all attempts, otherwise put
3617: something
1.14 harris41 3618:
1.112 bowersj2 3619: =item * $regexp: if string matches this regexp, the string will be
3620: sent to $gradesub
1.14 harris41 3621:
1.112 bowersj2 3622: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3623:
1.112 bowersj2 3624: =back
1.14 harris41 3625:
1.112 bowersj2 3626: The output string is a table containing all desired attempts, if any.
1.16 harris41 3627:
1.112 bowersj2 3628: =cut
1.1 albertel 3629:
3630: sub get_previous_attempt {
1.43 ng 3631: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3632: my $prevattempts='';
1.43 ng 3633: no strict 'refs';
1.1 albertel 3634: if ($symb) {
1.3 albertel 3635: my (%returnhash)=
3636: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3637: if ($returnhash{'version'}) {
3638: my %lasthash=();
3639: my $version;
3640: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3641: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3642: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3643: }
1.1 albertel 3644: }
1.596 albertel 3645: $prevattempts=&start_data_table().&start_data_table_header_row();
3646: $prevattempts.='<th>'.&mt('History').'</th>';
1.978 raeburn 3647: my (%typeparts,%lasthidden);
1.945 raeburn 3648: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 3649: foreach my $key (sort(keys(%lasthash))) {
3650: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3651: if ($#parts > 0) {
1.31 albertel 3652: my $data=$parts[-1];
1.989 raeburn 3653: next if ($data eq 'foilorder');
1.31 albertel 3654: pop(@parts);
1.1010 www 3655: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.945 raeburn 3656: if ($data eq 'type') {
3657: unless ($showsurv) {
3658: my $id = join(',',@parts);
3659: $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978 raeburn 3660: if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
3661: $lasthidden{$ign.'.'.$id} = 1;
3662: }
1.945 raeburn 3663: }
1.1010 www 3664: }
1.31 albertel 3665: } else {
1.41 ng 3666: if ($#parts == 0) {
3667: $prevattempts.='<th>'.$parts[0].'</th>';
3668: } else {
3669: $prevattempts.='<th>'.$ign.'</th>';
3670: }
1.31 albertel 3671: }
1.16 harris41 3672: }
1.596 albertel 3673: $prevattempts.=&end_data_table_header_row();
1.40 ng 3674: if ($getattempt eq '') {
3675: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.945 raeburn 3676: my @hidden;
3677: if (%typeparts) {
3678: foreach my $id (keys(%typeparts)) {
3679: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
3680: push(@hidden,$id);
3681: }
3682: }
3683: }
3684: $prevattempts.=&start_data_table_row().
3685: '<td>'.&mt('Transaction [_1]',$version).'</td>';
3686: if (@hidden) {
3687: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3688: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3689: my $hide;
3690: foreach my $id (@hidden) {
3691: if ($key =~ /^\Q$id\E/) {
3692: $hide = 1;
3693: last;
3694: }
3695: }
3696: if ($hide) {
3697: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3698: if (($data eq 'award') || ($data eq 'awarddetail')) {
3699: my $value = &format_previous_attempt_value($key,
3700: $returnhash{$version.':'.$key});
3701: $prevattempts.='<td>'.$value.' </td>';
3702: } else {
3703: $prevattempts.='<td> </td>';
3704: }
3705: } else {
3706: if ($key =~ /\./) {
3707: my $value = &format_previous_attempt_value($key,
3708: $returnhash{$version.':'.$key});
3709: $prevattempts.='<td>'.$value.' </td>';
3710: } else {
3711: $prevattempts.='<td> </td>';
3712: }
3713: }
3714: }
3715: } else {
3716: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3717: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3718: my $value = &format_previous_attempt_value($key,
3719: $returnhash{$version.':'.$key});
3720: $prevattempts.='<td>'.$value.' </td>';
3721: }
3722: }
3723: $prevattempts.=&end_data_table_row();
1.40 ng 3724: }
1.1 albertel 3725: }
1.945 raeburn 3726: my @currhidden = keys(%lasthidden);
1.596 albertel 3727: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3728: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3729: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3730: if (%typeparts) {
3731: my $hidden;
3732: foreach my $id (@currhidden) {
3733: if ($key =~ /^\Q$id\E/) {
3734: $hidden = 1;
3735: last;
3736: }
3737: }
3738: if ($hidden) {
3739: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3740: if (($data eq 'award') || ($data eq 'awarddetail')) {
3741: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3742: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3743: $value = &$gradesub($value);
3744: }
3745: $prevattempts.='<td>'.$value.' </td>';
3746: } else {
3747: $prevattempts.='<td> </td>';
3748: }
3749: } else {
3750: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3751: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3752: $value = &$gradesub($value);
3753: }
3754: $prevattempts.='<td>'.$value.' </td>';
3755: }
3756: } else {
3757: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3758: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3759: $value = &$gradesub($value);
3760: }
3761: $prevattempts.='<td>'.$value.' </td>';
3762: }
1.16 harris41 3763: }
1.596 albertel 3764: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3765: } else {
1.596 albertel 3766: $prevattempts=
3767: &start_data_table().&start_data_table_row().
3768: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3769: &end_data_table_row().&end_data_table();
1.1 albertel 3770: }
3771: } else {
1.596 albertel 3772: $prevattempts=
3773: &start_data_table().&start_data_table_row().
3774: '<td>'.&mt('No data.').'</td>'.
3775: &end_data_table_row().&end_data_table();
1.1 albertel 3776: }
1.10 albertel 3777: }
3778:
1.581 albertel 3779: sub format_previous_attempt_value {
3780: my ($key,$value) = @_;
1.1011 www 3781: if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.581 albertel 3782: $value = &Apache::lonlocal::locallocaltime($value);
3783: } elsif (ref($value) eq 'ARRAY') {
3784: $value = '('.join(', ', @{ $value }).')';
1.988 raeburn 3785: } elsif ($key =~ /answerstring$/) {
3786: my %answers = &Apache::lonnet::str2hash($value);
3787: my @anskeys = sort(keys(%answers));
3788: if (@anskeys == 1) {
3789: my $answer = $answers{$anskeys[0]};
1.1001 raeburn 3790: if ($answer =~ m{\0}) {
3791: $answer =~ s{\0}{,}g;
1.988 raeburn 3792: }
3793: my $tag_internal_answer_name = 'INTERNAL';
3794: if ($anskeys[0] eq $tag_internal_answer_name) {
3795: $value = $answer;
3796: } else {
3797: $value = $anskeys[0].'='.$answer;
3798: }
3799: } else {
3800: foreach my $ans (@anskeys) {
3801: my $answer = $answers{$ans};
1.1001 raeburn 3802: if ($answer =~ m{\0}) {
3803: $answer =~ s{\0}{,}g;
1.988 raeburn 3804: }
3805: $value .= $ans.'='.$answer.'<br />';;
3806: }
3807: }
1.581 albertel 3808: } else {
3809: $value = &unescape($value);
3810: }
3811: return $value;
3812: }
3813:
3814:
1.107 albertel 3815: sub relative_to_absolute {
3816: my ($url,$output)=@_;
3817: my $parser=HTML::TokeParser->new(\$output);
3818: my $token;
3819: my $thisdir=$url;
3820: my @rlinks=();
3821: while ($token=$parser->get_token) {
3822: if ($token->[0] eq 'S') {
3823: if ($token->[1] eq 'a') {
3824: if ($token->[2]->{'href'}) {
3825: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3826: }
3827: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3828: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3829: } elsif ($token->[1] eq 'base') {
3830: $thisdir=$token->[2]->{'href'};
3831: }
3832: }
3833: }
3834: $thisdir=~s-/[^/]*$--;
1.356 albertel 3835: foreach my $link (@rlinks) {
1.726 raeburn 3836: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3837: ($link=~/^\//) ||
3838: ($link=~/^javascript:/i) ||
3839: ($link=~/^mailto:/i) ||
3840: ($link=~/^\#/)) {
3841: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3842: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3843: }
3844: }
3845: # -------------------------------------------------- Deal with Applet codebases
3846: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3847: return $output;
3848: }
3849:
1.112 bowersj2 3850: =pod
3851:
1.648 raeburn 3852: =item * &get_student_view()
1.112 bowersj2 3853:
3854: show a snapshot of what student was looking at
3855:
3856: =cut
3857:
1.10 albertel 3858: sub get_student_view {
1.186 albertel 3859: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3860: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3861: my (%form);
1.10 albertel 3862: my @elements=('symb','courseid','domain','username');
3863: foreach my $element (@elements) {
1.186 albertel 3864: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3865: }
1.186 albertel 3866: if (defined($moreenv)) {
3867: %form=(%form,%{$moreenv});
3868: }
1.236 albertel 3869: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3870: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3871: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3872: $userview=~s/\<body[^\>]*\>//gi;
3873: $userview=~s/\<\/body\>//gi;
3874: $userview=~s/\<html\>//gi;
3875: $userview=~s/\<\/html\>//gi;
3876: $userview=~s/\<head\>//gi;
3877: $userview=~s/\<\/head\>//gi;
3878: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3879: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3880: if (wantarray) {
3881: return ($userview,$response);
3882: } else {
3883: return $userview;
3884: }
3885: }
3886:
3887: sub get_student_view_with_retries {
3888: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3889:
3890: my $ok = 0; # True if we got a good response.
3891: my $content;
3892: my $response;
3893:
3894: # Try to get the student_view done. within the retries count:
3895:
3896: do {
3897: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3898: $ok = $response->is_success;
3899: if (!$ok) {
3900: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3901: }
3902: $retries--;
3903: } while (!$ok && ($retries > 0));
3904:
3905: if (!$ok) {
3906: $content = ''; # On error return an empty content.
3907: }
1.651 www 3908: if (wantarray) {
3909: return ($content, $response);
3910: } else {
3911: return $content;
3912: }
1.11 albertel 3913: }
3914:
1.112 bowersj2 3915: =pod
3916:
1.648 raeburn 3917: =item * &get_student_answers()
1.112 bowersj2 3918:
3919: show a snapshot of how student was answering problem
3920:
3921: =cut
3922:
1.11 albertel 3923: sub get_student_answers {
1.100 sakharuk 3924: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3925: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3926: my (%moreenv);
1.11 albertel 3927: my @elements=('symb','courseid','domain','username');
3928: foreach my $element (@elements) {
1.186 albertel 3929: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3930: }
1.186 albertel 3931: $moreenv{'grade_target'}='answer';
3932: %moreenv=(%form,%moreenv);
1.497 raeburn 3933: $feedurl = &Apache::lonnet::clutter($feedurl);
3934: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3935: return $userview;
1.1 albertel 3936: }
1.116 albertel 3937:
3938: =pod
3939:
3940: =item * &submlink()
3941:
1.242 albertel 3942: Inputs: $text $uname $udom $symb $target
1.116 albertel 3943:
3944: Returns: A link to grades.pm such as to see the SUBM view of a student
3945:
3946: =cut
3947:
3948: ###############################################
3949: sub submlink {
1.242 albertel 3950: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3951: if (!($uname && $udom)) {
3952: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3953: &Apache::lonnet::whichuser($symb);
1.116 albertel 3954: if (!$symb) { $symb=$cursymb; }
3955: }
1.254 matthew 3956: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3957: $symb=&escape($symb);
1.960 bisitz 3958: if ($target) { $target=" target=\"$target\""; }
3959: return
3960: '<a href="/adm/grades?command=submission'.
3961: '&symb='.$symb.
3962: '&student='.$uname.
3963: '&userdom='.$udom.'"'.
3964: $target.'>'.$text.'</a>';
1.242 albertel 3965: }
3966: ##############################################
3967:
3968: =pod
3969:
3970: =item * &pgrdlink()
3971:
3972: Inputs: $text $uname $udom $symb $target
3973:
3974: Returns: A link to grades.pm such as to see the PGRD view of a student
3975:
3976: =cut
3977:
3978: ###############################################
3979: sub pgrdlink {
3980: my $link=&submlink(@_);
3981: $link=~s/(&command=submission)/$1&showgrading=yes/;
3982: return $link;
3983: }
3984: ##############################################
3985:
3986: =pod
3987:
3988: =item * &pprmlink()
3989:
3990: Inputs: $text $uname $udom $symb $target
3991:
3992: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3993: student and a specific resource
1.242 albertel 3994:
3995: =cut
3996:
3997: ###############################################
3998: sub pprmlink {
3999: my ($text,$uname,$udom,$symb,$target)=@_;
4000: if (!($uname && $udom)) {
4001: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 4002: &Apache::lonnet::whichuser($symb);
1.242 albertel 4003: if (!$symb) { $symb=$cursymb; }
4004: }
1.254 matthew 4005: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 4006: $symb=&escape($symb);
1.242 albertel 4007: if ($target) { $target="target=\"$target\""; }
1.595 albertel 4008: return '<a href="/adm/parmset?command=set&'.
4009: 'symb='.$symb.'&uname='.$uname.
4010: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 4011: }
4012: ##############################################
1.37 matthew 4013:
1.112 bowersj2 4014: =pod
4015:
4016: =back
4017:
4018: =cut
4019:
1.37 matthew 4020: ###############################################
1.51 www 4021:
4022:
4023: sub timehash {
1.687 raeburn 4024: my ($thistime) = @_;
4025: my $timezone = &Apache::lonlocal::gettimezone();
4026: my $dt = DateTime->from_epoch(epoch => $thistime)
4027: ->set_time_zone($timezone);
4028: my $wday = $dt->day_of_week();
4029: if ($wday == 7) { $wday = 0; }
4030: return ( 'second' => $dt->second(),
4031: 'minute' => $dt->minute(),
4032: 'hour' => $dt->hour(),
4033: 'day' => $dt->day_of_month(),
4034: 'month' => $dt->month(),
4035: 'year' => $dt->year(),
4036: 'weekday' => $wday,
4037: 'dayyear' => $dt->day_of_year(),
4038: 'dlsav' => $dt->is_dst() );
1.51 www 4039: }
4040:
1.370 www 4041: sub utc_string {
4042: my ($date)=@_;
1.371 www 4043: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 4044: }
4045:
1.51 www 4046: sub maketime {
4047: my %th=@_;
1.687 raeburn 4048: my ($epoch_time,$timezone,$dt);
4049: $timezone = &Apache::lonlocal::gettimezone();
4050: eval {
4051: $dt = DateTime->new( year => $th{'year'},
4052: month => $th{'month'},
4053: day => $th{'day'},
4054: hour => $th{'hour'},
4055: minute => $th{'minute'},
4056: second => $th{'second'},
4057: time_zone => $timezone,
4058: );
4059: };
4060: if (!$@) {
4061: $epoch_time = $dt->epoch;
4062: if ($epoch_time) {
4063: return $epoch_time;
4064: }
4065: }
1.51 www 4066: return POSIX::mktime(
4067: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 4068: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 4069: }
4070:
4071: #########################################
1.51 www 4072:
4073: sub findallcourses {
1.482 raeburn 4074: my ($roles,$uname,$udom) = @_;
1.355 albertel 4075: my %roles;
4076: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 4077: my %courses;
1.51 www 4078: my $now=time;
1.482 raeburn 4079: if (!defined($uname)) {
4080: $uname = $env{'user.name'};
4081: }
4082: if (!defined($udom)) {
4083: $udom = $env{'user.domain'};
4084: }
4085: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.1073 raeburn 4086: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
1.482 raeburn 4087: if (!%roles) {
4088: %roles = (
4089: cc => 1,
1.907 raeburn 4090: co => 1,
1.482 raeburn 4091: in => 1,
4092: ep => 1,
4093: ta => 1,
4094: cr => 1,
4095: st => 1,
4096: );
4097: }
4098: foreach my $entry (keys(%roleshash)) {
4099: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
4100: if ($trole =~ /^cr/) {
4101: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
4102: } else {
4103: next if (!exists($roles{$trole}));
4104: }
4105: if ($tend) {
4106: next if ($tend < $now);
4107: }
4108: if ($tstart) {
4109: next if ($tstart > $now);
4110: }
1.1058 raeburn 4111: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482 raeburn 4112: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058 raeburn 4113: my $value = $trole.'/'.$cdom.'/';
1.482 raeburn 4114: if ($secpart eq '') {
4115: ($cnum,$role) = split(/_/,$cnumpart);
4116: $sec = 'none';
1.1058 raeburn 4117: $value .= $cnum.'/';
1.482 raeburn 4118: } else {
4119: $cnum = $cnumpart;
4120: ($sec,$role) = split(/_/,$secpart);
1.1058 raeburn 4121: $value .= $cnum.'/'.$sec;
4122: }
4123: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
4124: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
4125: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
4126: }
4127: } else {
4128: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490 raeburn 4129: }
1.482 raeburn 4130: }
4131: } else {
4132: foreach my $key (keys(%env)) {
1.483 albertel 4133: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
4134: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 4135: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
4136: next if ($role eq 'ca' || $role eq 'aa');
4137: next if (%roles && !exists($roles{$role}));
4138: my ($starttime,$endtime)=split(/\./,$env{$key});
4139: my $active=1;
4140: if ($starttime) {
4141: if ($now<$starttime) { $active=0; }
4142: }
4143: if ($endtime) {
4144: if ($now>$endtime) { $active=0; }
4145: }
4146: if ($active) {
1.1058 raeburn 4147: my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482 raeburn 4148: if ($sec eq '') {
4149: $sec = 'none';
1.1058 raeburn 4150: } else {
4151: $value .= $sec;
4152: }
4153: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
4154: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
4155: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
4156: }
4157: } else {
4158: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482 raeburn 4159: }
1.474 raeburn 4160: }
4161: }
1.51 www 4162: }
4163: }
1.474 raeburn 4164: return %courses;
1.51 www 4165: }
1.37 matthew 4166:
1.54 www 4167: ###############################################
1.474 raeburn 4168:
4169: sub blockcheck {
1.1062 raeburn 4170: my ($setters,$activity,$uname,$udom,$url) = @_;
1.490 raeburn 4171:
4172: if (!defined($udom)) {
4173: $udom = $env{'user.domain'};
4174: }
4175: if (!defined($uname)) {
4176: $uname = $env{'user.name'};
4177: }
4178:
4179: # If uname and udom are for a course, check for blocks in the course.
4180:
4181: if (&Apache::lonnet::is_course($udom,$uname)) {
1.1062 raeburn 4182: my ($startblock,$endblock,$triggerblock) =
4183: &get_blocks($setters,$activity,$udom,$uname,$url);
4184: return ($startblock,$endblock,$triggerblock);
1.490 raeburn 4185: }
1.474 raeburn 4186:
1.502 raeburn 4187: my $startblock = 0;
4188: my $endblock = 0;
1.1062 raeburn 4189: my $triggerblock = '';
1.482 raeburn 4190: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 4191:
1.490 raeburn 4192: # If uname is for a user, and activity is course-specific, i.e.,
4193: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 4194:
1.490 raeburn 4195: if (($activity eq 'boards' || $activity eq 'chat' ||
4196: $activity eq 'groups') && ($env{'request.course.id'})) {
4197: foreach my $key (keys(%live_courses)) {
4198: if ($key ne $env{'request.course.id'}) {
4199: delete($live_courses{$key});
4200: }
4201: }
4202: }
4203:
4204: my $otheruser = 0;
4205: my %own_courses;
4206: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
4207: # Resource belongs to user other than current user.
4208: $otheruser = 1;
4209: # Gather courses for current user
4210: %own_courses =
4211: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
4212: }
4213:
4214: # Gather active course roles - course coordinator, instructor,
4215: # exam proctor, ta, student, or custom role.
1.474 raeburn 4216:
4217: foreach my $course (keys(%live_courses)) {
1.482 raeburn 4218: my ($cdom,$cnum);
4219: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
4220: $cdom = $env{'course.'.$course.'.domain'};
4221: $cnum = $env{'course.'.$course.'.num'};
4222: } else {
1.490 raeburn 4223: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 4224: }
4225: my $no_ownblock = 0;
4226: my $no_userblock = 0;
1.533 raeburn 4227: if ($otheruser && $activity ne 'com') {
1.490 raeburn 4228: # Check if current user has 'evb' priv for this
4229: if (defined($own_courses{$course})) {
4230: foreach my $sec (keys(%{$own_courses{$course}})) {
4231: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
4232: if ($sec ne 'none') {
4233: $checkrole .= '/'.$sec;
4234: }
4235: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4236: $no_ownblock = 1;
4237: last;
4238: }
4239: }
4240: }
4241: # if they have 'evb' priv and are currently not playing student
4242: next if (($no_ownblock) &&
4243: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
4244: }
1.474 raeburn 4245: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 4246: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 4247: if ($sec ne 'none') {
1.482 raeburn 4248: $checkrole .= '/'.$sec;
1.474 raeburn 4249: }
1.490 raeburn 4250: if ($otheruser) {
4251: # Resource belongs to user other than current user.
4252: # Assemble privs for that user, and check for 'evb' priv.
1.1058 raeburn 4253: my (%allroles,%userroles);
4254: if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
4255: foreach my $entry (@{$live_courses{$course}{$sec}}) {
4256: my ($trole,$tdom,$tnum,$tsec);
4257: if ($entry =~ /^cr/) {
4258: ($trole,$tdom,$tnum,$tsec) =
4259: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
4260: } else {
4261: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
4262: }
4263: my ($spec,$area,$trest);
4264: $area = '/'.$tdom.'/'.$tnum;
4265: $trest = $tnum;
4266: if ($tsec ne '') {
4267: $area .= '/'.$tsec;
4268: $trest .= '/'.$tsec;
4269: }
4270: $spec = $trole.'.'.$area;
4271: if ($trole =~ /^cr/) {
4272: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
4273: $tdom,$spec,$trest,$area);
4274: } else {
4275: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
4276: $tdom,$spec,$trest,$area);
4277: }
4278: }
4279: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
4280: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
4281: if ($1) {
4282: $no_userblock = 1;
4283: last;
4284: }
1.486 raeburn 4285: }
4286: }
1.490 raeburn 4287: } else {
4288: # Resource belongs to current user
4289: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 4290: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4291: $no_ownblock = 1;
4292: last;
4293: }
1.474 raeburn 4294: }
4295: }
4296: # if they have the evb priv and are currently not playing student
1.482 raeburn 4297: next if (($no_ownblock) &&
1.491 albertel 4298: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 4299: next if ($no_userblock);
1.474 raeburn 4300:
1.866 kalberla 4301: # Retrieve blocking times and identity of locker for course
1.490 raeburn 4302: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 4303:
1.1062 raeburn 4304: my ($start,$end,$trigger) =
4305: &get_blocks($setters,$activity,$cdom,$cnum,$url);
1.502 raeburn 4306: if (($start != 0) &&
4307: (($startblock == 0) || ($startblock > $start))) {
4308: $startblock = $start;
1.1062 raeburn 4309: if ($trigger ne '') {
4310: $triggerblock = $trigger;
4311: }
1.502 raeburn 4312: }
4313: if (($end != 0) &&
4314: (($endblock == 0) || ($endblock < $end))) {
4315: $endblock = $end;
1.1062 raeburn 4316: if ($trigger ne '') {
4317: $triggerblock = $trigger;
4318: }
1.502 raeburn 4319: }
1.490 raeburn 4320: }
1.1062 raeburn 4321: return ($startblock,$endblock,$triggerblock);
1.490 raeburn 4322: }
4323:
4324: sub get_blocks {
1.1062 raeburn 4325: my ($setters,$activity,$cdom,$cnum,$url) = @_;
1.490 raeburn 4326: my $startblock = 0;
4327: my $endblock = 0;
1.1062 raeburn 4328: my $triggerblock = '';
1.490 raeburn 4329: my $course = $cdom.'_'.$cnum;
4330: $setters->{$course} = {};
4331: $setters->{$course}{'staff'} = [];
4332: $setters->{$course}{'times'} = [];
1.1062 raeburn 4333: $setters->{$course}{'triggers'} = [];
4334: my (@blockers,%triggered);
4335: my $now = time;
4336: my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
4337: if ($activity eq 'docs') {
4338: @blockers = &Apache::lonnet::has_comm_blocking('bre',undef,$url,\%commblocks);
4339: foreach my $block (@blockers) {
4340: if ($block =~ /^firstaccess____(.+)$/) {
4341: my $item = $1;
4342: my $type = 'map';
4343: my $timersymb = $item;
4344: if ($item eq 'course') {
4345: $type = 'course';
4346: } elsif ($item =~ /___\d+___/) {
4347: $type = 'resource';
4348: } else {
4349: $timersymb = &Apache::lonnet::symbread($item);
4350: }
4351: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
4352: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
4353: $triggered{$block} = {
4354: start => $start,
4355: end => $end,
4356: type => $type,
4357: };
4358: }
4359: }
4360: } else {
4361: foreach my $block (keys(%commblocks)) {
4362: if ($block =~ m/^(\d+)____(\d+)$/) {
4363: my ($start,$end) = ($1,$2);
4364: if ($start <= time && $end >= time) {
4365: if (ref($commblocks{$block}) eq 'HASH') {
4366: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
4367: if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
4368: unless(grep(/^\Q$block\E$/,@blockers)) {
4369: push(@blockers,$block);
4370: }
4371: }
4372: }
4373: }
4374: }
4375: } elsif ($block =~ /^firstaccess____(.+)$/) {
4376: my $item = $1;
4377: my $timersymb = $item;
4378: my $type = 'map';
4379: if ($item eq 'course') {
4380: $type = 'course';
4381: } elsif ($item =~ /___\d+___/) {
4382: $type = 'resource';
4383: } else {
4384: $timersymb = &Apache::lonnet::symbread($item);
4385: }
4386: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
4387: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
4388: if ($start && $end) {
4389: if (($start <= time) && ($end >= time)) {
4390: unless (grep(/^\Q$block\E$/,@blockers)) {
4391: push(@blockers,$block);
4392: $triggered{$block} = {
4393: start => $start,
4394: end => $end,
4395: type => $type,
4396: };
4397: }
4398: }
1.490 raeburn 4399: }
1.1062 raeburn 4400: }
4401: }
4402: }
4403: foreach my $blocker (@blockers) {
4404: my ($staff_name,$staff_dom,$title,$blocks) =
4405: &parse_block_record($commblocks{$blocker});
4406: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
4407: my ($start,$end,$triggertype);
4408: if ($blocker =~ m/^(\d+)____(\d+)$/) {
4409: ($start,$end) = ($1,$2);
4410: } elsif (ref($triggered{$blocker}) eq 'HASH') {
4411: $start = $triggered{$blocker}{'start'};
4412: $end = $triggered{$blocker}{'end'};
4413: $triggertype = $triggered{$blocker}{'type'};
4414: }
4415: if ($start) {
4416: push(@{$$setters{$course}{'times'}}, [$start,$end]);
4417: if ($triggertype) {
4418: push(@{$$setters{$course}{'triggers'}},$triggertype);
4419: } else {
4420: push(@{$$setters{$course}{'triggers'}},0);
4421: }
4422: if ( ($startblock == 0) || ($startblock > $start) ) {
4423: $startblock = $start;
4424: if ($triggertype) {
4425: $triggerblock = $blocker;
1.474 raeburn 4426: }
4427: }
1.1062 raeburn 4428: if ( ($endblock == 0) || ($endblock < $end) ) {
4429: $endblock = $end;
4430: if ($triggertype) {
4431: $triggerblock = $blocker;
4432: }
4433: }
1.474 raeburn 4434: }
4435: }
1.1062 raeburn 4436: return ($startblock,$endblock,$triggerblock);
1.474 raeburn 4437: }
4438:
4439: sub parse_block_record {
4440: my ($record) = @_;
4441: my ($setuname,$setudom,$title,$blocks);
4442: if (ref($record) eq 'HASH') {
4443: ($setuname,$setudom) = split(/:/,$record->{'setter'});
4444: $title = &unescape($record->{'event'});
4445: $blocks = $record->{'blocks'};
4446: } else {
4447: my @data = split(/:/,$record,3);
4448: if (scalar(@data) eq 2) {
4449: $title = $data[1];
4450: ($setuname,$setudom) = split(/@/,$data[0]);
4451: } else {
4452: ($setuname,$setudom,$title) = @data;
4453: }
4454: $blocks = { 'com' => 'on' };
4455: }
4456: return ($setuname,$setudom,$title,$blocks);
4457: }
4458:
1.854 kalberla 4459: sub blocking_status {
1.1062 raeburn 4460: my ($activity,$uname,$udom,$url) = @_;
1.1061 raeburn 4461: my %setters;
1.890 droeschl 4462:
1.1061 raeburn 4463: # check for active blocking
1.1062 raeburn 4464: my ($startblock,$endblock,$triggerblock) =
4465: &blockcheck(\%setters,$activity,$uname,$udom,$url);
4466: my $blocked = 0;
4467: if ($startblock && $endblock) {
4468: $blocked = 1;
4469: }
1.890 droeschl 4470:
1.1061 raeburn 4471: # caller just wants to know whether a block is active
4472: if (!wantarray) { return $blocked; }
4473:
4474: # build a link to a popup window containing the details
4475: my $querystring = "?activity=$activity";
4476: # $uname and $udom decide whose portfolio the user is trying to look at
1.1062 raeburn 4477: if ($activity eq 'port') {
4478: $querystring .= "&udom=$udom" if $udom;
4479: $querystring .= "&uname=$uname" if $uname;
4480: } elsif ($activity eq 'docs') {
4481: $querystring .= '&url='.&HTML::Entities::encode($url,'&"');
4482: }
1.1061 raeburn 4483:
4484: my $output .= <<'END_MYBLOCK';
4485: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
4486: var options = "width=" + w + ",height=" + h + ",";
4487: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
4488: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
4489: var newWin = window.open(url, wdwName, options);
4490: newWin.focus();
4491: }
1.890 droeschl 4492: END_MYBLOCK
1.854 kalberla 4493:
1.1061 raeburn 4494: $output = Apache::lonhtmlcommon::scripttag($output);
1.890 droeschl 4495:
1.1061 raeburn 4496: my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062 raeburn 4497: my $text = &mt('Communication Blocked');
4498: if ($activity eq 'docs') {
4499: $text = &mt('Content Access Blocked');
1.1063 raeburn 4500: } elsif ($activity eq 'printout') {
4501: $text = &mt('Printing Blocked');
1.1062 raeburn 4502: }
1.1061 raeburn 4503: $output .= <<"END_BLOCK";
1.867 kalberla 4504: <div class='LC_comblock'>
1.869 kalberla 4505: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4506: title='$text'>
4507: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 4508: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4509: title='$text'>$text</a>
1.867 kalberla 4510: </div>
4511:
4512: END_BLOCK
1.474 raeburn 4513:
1.1061 raeburn 4514: return ($blocked, $output);
1.854 kalberla 4515: }
1.490 raeburn 4516:
1.60 matthew 4517: ###############################################
4518:
1.682 raeburn 4519: sub check_ip_acc {
4520: my ($acc)=@_;
4521: &Apache::lonxml::debug("acc is $acc");
4522: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
4523: return 1;
4524: }
4525: my $allowed=0;
4526: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
4527:
4528: my $name;
4529: foreach my $pattern (split(',',$acc)) {
4530: $pattern =~ s/^\s*//;
4531: $pattern =~ s/\s*$//;
4532: if ($pattern =~ /\*$/) {
4533: #35.8.*
4534: $pattern=~s/\*//;
4535: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4536: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
4537: #35.8.3.[34-56]
4538: my $low=$2;
4539: my $high=$3;
4540: $pattern=$1;
4541: if ($ip =~ /^\Q$pattern\E/) {
4542: my $last=(split(/\./,$ip))[3];
4543: if ($last <=$high && $last >=$low) { $allowed=1; }
4544: }
4545: } elsif ($pattern =~ /^\*/) {
4546: #*.msu.edu
4547: $pattern=~s/\*//;
4548: if (!defined($name)) {
4549: use Socket;
4550: my $netaddr=inet_aton($ip);
4551: ($name)=gethostbyaddr($netaddr,AF_INET);
4552: }
4553: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4554: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
4555: #127.0.0.1
4556: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4557: } else {
4558: #some.name.com
4559: if (!defined($name)) {
4560: use Socket;
4561: my $netaddr=inet_aton($ip);
4562: ($name)=gethostbyaddr($netaddr,AF_INET);
4563: }
4564: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4565: }
4566: if ($allowed) { last; }
4567: }
4568: return $allowed;
4569: }
4570:
4571: ###############################################
4572:
1.60 matthew 4573: =pod
4574:
1.112 bowersj2 4575: =head1 Domain Template Functions
4576:
4577: =over 4
4578:
4579: =item * &determinedomain()
1.60 matthew 4580:
4581: Inputs: $domain (usually will be undef)
4582:
1.63 www 4583: Returns: Determines which domain should be used for designs
1.60 matthew 4584:
4585: =cut
1.54 www 4586:
1.60 matthew 4587: ###############################################
1.63 www 4588: sub determinedomain {
4589: my $domain=shift;
1.531 albertel 4590: if (! $domain) {
1.60 matthew 4591: # Determine domain if we have not been given one
1.893 raeburn 4592: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 4593: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
4594: if ($env{'request.role.domain'}) {
4595: $domain=$env{'request.role.domain'};
1.60 matthew 4596: }
4597: }
1.63 www 4598: return $domain;
4599: }
4600: ###############################################
1.517 raeburn 4601:
1.518 albertel 4602: sub devalidate_domconfig_cache {
4603: my ($udom)=@_;
4604: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
4605: }
4606:
4607: # ---------------------- Get domain configuration for a domain
4608: sub get_domainconf {
4609: my ($udom) = @_;
4610: my $cachetime=1800;
4611: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
4612: if (defined($cached)) { return %{$result}; }
4613:
4614: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 4615: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 4616: my (%designhash,%legacy);
1.518 albertel 4617: if (keys(%domconfig) > 0) {
4618: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 4619: if (keys(%{$domconfig{'login'}})) {
4620: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 4621: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.946 raeburn 4622: if ($key eq 'loginvia') {
4623: if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') {
1.1013 raeburn 4624: foreach my $hostname (keys(%{$domconfig{'login'}{'loginvia'}})) {
1.948 raeburn 4625: if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') {
4626: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
4627: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
4628: $designhash{$udom.'.login.loginvia'} = $server;
4629: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
4630:
4631: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
4632: } else {
1.1013 raeburn 4633: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
1.948 raeburn 4634: }
4635: if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) {
4636: $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'};
4637: }
1.946 raeburn 4638: }
4639: }
4640: }
4641: }
4642: } else {
4643: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
4644: $designhash{$udom.'.login.'.$key.'_'.$img} =
4645: $domconfig{'login'}{$key}{$img};
4646: }
1.699 raeburn 4647: }
4648: } else {
4649: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
4650: }
1.632 raeburn 4651: }
4652: } else {
4653: $legacy{'login'} = 1;
1.518 albertel 4654: }
1.632 raeburn 4655: } else {
4656: $legacy{'login'} = 1;
1.518 albertel 4657: }
4658: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 4659: if (keys(%{$domconfig{'rolecolors'}})) {
4660: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
4661: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
4662: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
4663: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
4664: }
1.518 albertel 4665: }
4666: }
1.632 raeburn 4667: } else {
4668: $legacy{'rolecolors'} = 1;
1.518 albertel 4669: }
1.632 raeburn 4670: } else {
4671: $legacy{'rolecolors'} = 1;
1.518 albertel 4672: }
1.948 raeburn 4673: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
4674: if ($domconfig{'autoenroll'}{'co-owners'}) {
4675: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
4676: }
4677: }
1.632 raeburn 4678: if (keys(%legacy) > 0) {
4679: my %legacyhash = &get_legacy_domconf($udom);
4680: foreach my $item (keys(%legacyhash)) {
4681: if ($item =~ /^\Q$udom\E\.login/) {
4682: if ($legacy{'login'}) {
4683: $designhash{$item} = $legacyhash{$item};
4684: }
4685: } else {
4686: if ($legacy{'rolecolors'}) {
4687: $designhash{$item} = $legacyhash{$item};
4688: }
1.518 albertel 4689: }
4690: }
4691: }
1.632 raeburn 4692: } else {
4693: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4694: }
4695: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4696: $cachetime);
4697: return %designhash;
4698: }
4699:
1.632 raeburn 4700: sub get_legacy_domconf {
4701: my ($udom) = @_;
4702: my %legacyhash;
4703: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4704: my $designfile = $designdir.'/'.$udom.'.tab';
4705: if (-e $designfile) {
4706: if ( open (my $fh,"<$designfile") ) {
4707: while (my $line = <$fh>) {
4708: next if ($line =~ /^\#/);
4709: chomp($line);
4710: my ($key,$val)=(split(/\=/,$line));
4711: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4712: }
4713: close($fh);
4714: }
4715: }
1.1026 raeburn 4716: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632 raeburn 4717: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4718: }
4719: return %legacyhash;
4720: }
4721:
1.63 www 4722: =pod
4723:
1.112 bowersj2 4724: =item * &domainlogo()
1.63 www 4725:
4726: Inputs: $domain (usually will be undef)
4727:
4728: Returns: A link to a domain logo, if the domain logo exists.
4729: If the domain logo does not exist, a description of the domain.
4730:
4731: =cut
1.112 bowersj2 4732:
1.63 www 4733: ###############################################
4734: sub domainlogo {
1.517 raeburn 4735: my $domain = &determinedomain(shift);
1.518 albertel 4736: my %designhash = &get_domainconf($domain);
1.517 raeburn 4737: # See if there is a logo
4738: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4739: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4740: if ($imgsrc =~ m{^/(adm|res)/}) {
4741: if ($imgsrc =~ m{^/res/}) {
4742: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4743: &Apache::lonnet::repcopy($local_name);
4744: }
4745: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4746: }
4747: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4748: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4749: return &Apache::lonnet::domain($domain,'description');
1.59 www 4750: } else {
1.60 matthew 4751: return '';
1.59 www 4752: }
4753: }
1.63 www 4754: ##############################################
4755:
4756: =pod
4757:
1.112 bowersj2 4758: =item * &designparm()
1.63 www 4759:
4760: Inputs: $which parameter; $domain (usually will be undef)
4761:
4762: Returns: value of designparamter $which
4763:
4764: =cut
1.112 bowersj2 4765:
1.397 albertel 4766:
1.400 albertel 4767: ##############################################
1.397 albertel 4768: sub designparm {
4769: my ($which,$domain)=@_;
4770: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 4771: return $env{'environment.color.'.$which};
1.96 www 4772: }
1.63 www 4773: $domain=&determinedomain($domain);
1.1016 raeburn 4774: my %domdesign;
4775: unless ($domain eq 'public') {
4776: %domdesign = &get_domainconf($domain);
4777: }
1.520 raeburn 4778: my $output;
1.517 raeburn 4779: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 4780: $output = $domdesign{$domain.'.'.$which};
1.63 www 4781: } else {
1.520 raeburn 4782: $output = $defaultdesign{$which};
4783: }
4784: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4785: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4786: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 4787: if ($output =~ m{^/res/}) {
4788: my $local_name = &Apache::lonnet::filelocation('',$output);
4789: &Apache::lonnet::repcopy($local_name);
4790: }
1.520 raeburn 4791: $output = &lonhttpdurl($output);
4792: }
1.63 www 4793: }
1.520 raeburn 4794: return $output;
1.63 www 4795: }
1.59 www 4796:
1.822 bisitz 4797: ##############################################
4798: =pod
4799:
1.832 bisitz 4800: =item * &authorspace()
4801:
1.1028 raeburn 4802: Inputs: $url (usually will be undef).
1.832 bisitz 4803:
1.1028 raeburn 4804: Returns: Path to Construction Space containing the resource or
4805: directory being viewed (or for which action is being taken).
4806: If $url is provided, and begins /priv/<domain>/<uname>
4807: the path will be that portion of the $context argument.
4808: Otherwise the path will be for the author space of the current
4809: user when the current role is author, or for that of the
4810: co-author/assistant co-author space when the current role
4811: is co-author or assistant co-author.
1.832 bisitz 4812:
4813: =cut
4814:
4815: sub authorspace {
1.1028 raeburn 4816: my ($url) = @_;
4817: if ($url ne '') {
4818: if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
4819: return $1;
4820: }
4821: }
1.832 bisitz 4822: my $caname = '';
1.1024 www 4823: my $cadom = '';
1.1028 raeburn 4824: if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024 www 4825: ($cadom,$caname) =
1.832 bisitz 4826: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028 raeburn 4827: } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832 bisitz 4828: $caname = $env{'user.name'};
1.1024 www 4829: $cadom = $env{'user.domain'};
1.832 bisitz 4830: }
1.1028 raeburn 4831: if (($caname ne '') && ($cadom ne '')) {
4832: return "/priv/$cadom/$caname/";
4833: }
4834: return;
1.832 bisitz 4835: }
4836:
4837: ##############################################
4838: =pod
4839:
1.822 bisitz 4840: =item * &head_subbox()
4841:
4842: Inputs: $content (contains HTML code with page functions, etc.)
4843:
4844: Returns: HTML div with $content
4845: To be included in page header
4846:
4847: =cut
4848:
4849: sub head_subbox {
4850: my ($content)=@_;
4851: my $output =
1.993 raeburn 4852: '<div class="LC_head_subbox">'
1.822 bisitz 4853: .$content
4854: .'</div>'
4855: }
4856:
4857: ##############################################
4858: =pod
4859:
4860: =item * &CSTR_pageheader()
4861:
1.1026 raeburn 4862: Input: (optional) filename from which breadcrumb trail is built.
4863: In most cases no input as needed, as $env{'request.filename'}
4864: is appropriate for use in building the breadcrumb trail.
1.822 bisitz 4865:
4866: Returns: HTML div with CSTR path and recent box
4867: To be included on Construction Space pages
4868:
4869: =cut
4870:
4871: sub CSTR_pageheader {
1.1026 raeburn 4872: my ($trailfile) = @_;
4873: if ($trailfile eq '') {
4874: $trailfile = $env{'request.filename'};
4875: }
4876:
4877: # this is for resources; directories have customtitle, and crumbs
4878: # and select recent are created in lonpubdir.pm
4879:
4880: my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022 www 4881: my ($udom,$uname,$thisdisfn)=
1.1026 raeburn 4882: ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)/(.*)$});
4883: my $formaction = "/priv/$udom/$uname/$thisdisfn";
4884: $formaction =~ s{/+}{/}g;
1.822 bisitz 4885:
4886: my $parentpath = '';
4887: my $lastitem = '';
4888: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4889: $parentpath = $1;
4890: $lastitem = $2;
4891: } else {
4892: $lastitem = $thisdisfn;
4893: }
1.921 bisitz 4894:
4895: my $output =
1.822 bisitz 4896: '<div>'
4897: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
4898: .'<b>'.&mt('Construction Space:').'</b> '
4899: .'<form name="dirs" method="post" action="'.$formaction
1.921 bisitz 4900: .'" target="_top">' #FIXME lonpubdir: target="_parent"
1.1024 www 4901: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv/'.$udom,undef,undef);
1.921 bisitz 4902:
4903: if ($lastitem) {
4904: $output .=
4905: '<span class="LC_filename">'
4906: .$lastitem
4907: .'</span>';
4908: }
4909: $output .=
4910: '<br />'
1.822 bisitz 4911: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
4912: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4913: .'</form>'
4914: .&Apache::lonmenu::constspaceform()
4915: .'</div>';
1.921 bisitz 4916:
4917: return $output;
1.822 bisitz 4918: }
4919:
1.60 matthew 4920: ###############################################
4921: ###############################################
4922:
4923: =pod
4924:
1.112 bowersj2 4925: =back
4926:
1.549 albertel 4927: =head1 HTML Helpers
1.112 bowersj2 4928:
4929: =over 4
4930:
4931: =item * &bodytag()
1.60 matthew 4932:
4933: Returns a uniform header for LON-CAPA web pages.
4934:
4935: Inputs:
4936:
1.112 bowersj2 4937: =over 4
4938:
4939: =item * $title, A title to be displayed on the page.
4940:
4941: =item * $function, the current role (can be undef).
4942:
4943: =item * $addentries, extra parameters for the <body> tag.
4944:
4945: =item * $bodyonly, if defined, only return the <body> tag.
4946:
4947: =item * $domain, if defined, force a given domain.
4948:
4949: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4950: text interface only)
1.60 matthew 4951:
1.814 bisitz 4952: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
4953: navigational links
1.317 albertel 4954:
1.338 albertel 4955: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4956:
1.460 albertel 4957: =item * $args, optional argument valid values are
4958: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4959: inherit_jsmath -> when creating popup window in a page,
4960: should it have jsmath forced on by the
4961: current page
1.460 albertel 4962:
1.112 bowersj2 4963: =back
4964:
1.60 matthew 4965: Returns: A uniform header for LON-CAPA web pages.
4966: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4967: If $bodyonly is undef or zero, an html string containing a <body> tag and
4968: other decorations will be returned.
4969:
4970: =cut
4971:
1.54 www 4972: sub bodytag {
1.831 bisitz 4973: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.962 droeschl 4974: $no_nav_bar,$bgcolor,$args)=@_;
1.339 albertel 4975:
1.954 raeburn 4976: my $public;
4977: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
4978: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
4979: $public = 1;
4980: }
1.460 albertel 4981: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4982:
1.183 matthew 4983: $function = &get_users_function() if (!$function);
1.339 albertel 4984: my $img = &designparm($function.'.img',$domain);
4985: my $font = &designparm($function.'.font',$domain);
4986: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4987:
1.803 bisitz 4988: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 4989: 'bgcolor' => $pgbg,
1.339 albertel 4990: 'text' => $font,
4991: 'alink' => &designparm($function.'.alink',$domain),
4992: 'vlink' => &designparm($function.'.vlink',$domain),
4993: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4994: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4995:
1.63 www 4996: # role and realm
1.378 raeburn 4997: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4998: if ($role eq 'ca') {
1.479 albertel 4999: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 5000: $realm = &plainname($rname,$rdom);
1.378 raeburn 5001: }
1.55 www 5002: # realm
1.258 albertel 5003: if ($env{'request.course.id'}) {
1.378 raeburn 5004: if ($env{'request.role'} !~ /^cr/) {
5005: $role = &Apache::lonnet::plaintext($role,&course_type());
5006: }
1.898 raeburn 5007: if ($env{'request.course.sec'}) {
5008: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
5009: }
1.359 albertel 5010: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 5011: } else {
5012: $role = &Apache::lonnet::plaintext($role);
1.54 www 5013: }
1.433 albertel 5014:
1.359 albertel 5015: if (!$realm) { $realm=' '; }
1.330 albertel 5016:
1.438 albertel 5017: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 5018:
1.101 www 5019: # construct main body tag
1.359 albertel 5020: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 5021: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 5022:
1.530 albertel 5023: if ($bodyonly) {
1.60 matthew 5024: return $bodytag;
1.798 tempelho 5025: }
1.359 albertel 5026:
1.410 albertel 5027: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.954 raeburn 5028: if ($public) {
1.433 albertel 5029: undef($role);
1.434 albertel 5030: } else {
1.1070 raeburn 5031: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'},
5032: undef,'LC_menubuttons_link');
1.433 albertel 5033: }
1.359 albertel 5034:
1.762 bisitz 5035: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 5036: #
5037: # Extra info if you are the DC
5038: my $dc_info = '';
5039: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
5040: $env{'course.'.$env{'request.course.id'}.
5041: '.domain'}.'/'})) {
5042: my $cid = $env{'request.course.id'};
1.917 raeburn 5043: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 5044: $dc_info =~ s/\s+$//;
1.359 albertel 5045: }
5046:
1.898 raeburn 5047: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853 droeschl 5048: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
5049:
1.916 droeschl 5050: if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') {
5051: return $bodytag;
5052: }
1.903 droeschl 5053:
5054: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
5055:
5056: # if ($env{'request.state'} eq 'construct') {
5057: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
5058: # }
5059:
1.359 albertel 5060:
5061:
1.916 droeschl 5062: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917 raeburn 5063: if ($dc_info) {
5064: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
5065: }
1.916 droeschl 5066: $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
5067: <em>$realm</em> $dc_info</div>|;
1.903 droeschl 5068: return $bodytag;
5069: }
1.894 droeschl 5070:
1.927 raeburn 5071: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
5072: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
5073: }
1.916 droeschl 5074:
1.903 droeschl 5075: $bodytag .= Apache::lonhtmlcommon::scripttag(
5076: Apache::lonmenu::utilityfunctions(), 'start');
1.816 bisitz 5077:
1.903 droeschl 5078: $bodytag .= Apache::lonmenu::primary_menu();
1.852 droeschl 5079:
1.917 raeburn 5080: if ($dc_info) {
5081: $dc_info = &dc_courseid_toggle($dc_info);
5082: }
5083: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 5084:
1.903 droeschl 5085: #don't show menus for public users
1.954 raeburn 5086: if (!$public){
1.903 droeschl 5087: $bodytag .= Apache::lonmenu::secondary_menu();
5088: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 5089: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
5090: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 5091: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.920 raeburn 5092: $args->{'bread_crumbs'});
5093: } elsif ($forcereg) {
5094: $bodytag .= &Apache::lonmenu::innerregister($forcereg);
5095: }
1.903 droeschl 5096: }else{
5097: # this is to seperate menu from content when there's no secondary
5098: # menu. Especially needed for public accessible ressources.
5099: $bodytag .= '<hr style="clear:both" />';
5100: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 5101: }
1.903 droeschl 5102:
1.235 raeburn 5103: return $bodytag;
1.182 matthew 5104: }
5105:
1.917 raeburn 5106: sub dc_courseid_toggle {
5107: my ($dc_info) = @_;
1.980 raeburn 5108: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069 raeburn 5109: '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917 raeburn 5110: &mt('(More ...)').'</a></span>'.
5111: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
5112: }
5113:
1.330 albertel 5114: sub make_attr_string {
5115: my ($register,$attr_ref) = @_;
5116:
5117: if ($attr_ref && !ref($attr_ref)) {
5118: die("addentries Must be a hash ref ".
5119: join(':',caller(1))." ".
5120: join(':',caller(0))." ");
5121: }
5122:
5123: if ($register) {
1.339 albertel 5124: my ($on_load,$on_unload);
5125: foreach my $key (keys(%{$attr_ref})) {
5126: if (lc($key) eq 'onload') {
5127: $on_load.=$attr_ref->{$key}.';';
5128: delete($attr_ref->{$key});
5129:
5130: } elsif (lc($key) eq 'onunload') {
5131: $on_unload.=$attr_ref->{$key}.';';
5132: delete($attr_ref->{$key});
5133: }
5134: }
1.953 droeschl 5135: $attr_ref->{'onload'} = $on_load;
5136: $attr_ref->{'onunload'}= $on_unload;
1.330 albertel 5137: }
1.339 albertel 5138:
1.330 albertel 5139: my $attr_string;
5140: foreach my $attr (keys(%$attr_ref)) {
5141: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
5142: }
5143: return $attr_string;
5144: }
5145:
5146:
1.182 matthew 5147: ###############################################
1.251 albertel 5148: ###############################################
5149:
5150: =pod
5151:
5152: =item * &endbodytag()
5153:
5154: Returns a uniform footer for LON-CAPA web pages.
5155:
1.635 raeburn 5156: Inputs: 1 - optional reference to an args hash
5157: If in the hash, key for noredirectlink has a value which evaluates to true,
5158: a 'Continue' link is not displayed if the page contains an
5159: internal redirect in the <head></head> section,
5160: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 5161:
5162: =cut
5163:
5164: sub endbodytag {
1.635 raeburn 5165: my ($args) = @_;
1.1080 raeburn 5166: my $endbodytag;
5167: unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
5168: $endbodytag='</body>';
5169: }
1.269 albertel 5170: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 5171: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 5172: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
5173: $endbodytag=
5174: "<br /><a href=\"$env{'internal.head.redirect'}\">".
5175: &mt('Continue').'</a>'.
5176: $endbodytag;
5177: }
1.315 albertel 5178: }
1.251 albertel 5179: return $endbodytag;
5180: }
5181:
1.352 albertel 5182: =pod
5183:
5184: =item * &standard_css()
5185:
5186: Returns a style sheet
5187:
5188: Inputs: (all optional)
5189: domain -> force to color decorate a page for a specific
5190: domain
5191: function -> force usage of a specific rolish color scheme
5192: bgcolor -> override the default page bgcolor
5193:
5194: =cut
5195:
1.343 albertel 5196: sub standard_css {
1.345 albertel 5197: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 5198: $function = &get_users_function() if (!$function);
5199: my $img = &designparm($function.'.img', $domain);
5200: my $tabbg = &designparm($function.'.tabbg', $domain);
5201: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 5202: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 5203: #second colour for later usage
1.345 albertel 5204: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 5205: my $pgbg_or_bgcolor =
5206: $bgcolor ||
1.352 albertel 5207: &designparm($function.'.pgbg', $domain);
1.382 albertel 5208: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 5209: my $alink = &designparm($function.'.alink', $domain);
5210: my $vlink = &designparm($function.'.vlink', $domain);
5211: my $link = &designparm($function.'.link', $domain);
5212:
1.602 albertel 5213: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 5214: my $mono = 'monospace';
1.850 bisitz 5215: my $data_table_head = $sidebg;
5216: my $data_table_light = '#FAFAFA';
1.1060 bisitz 5217: my $data_table_dark = '#E0E0E0';
1.470 banghart 5218: my $data_table_darker = '#CCCCCC';
1.349 albertel 5219: my $data_table_highlight = '#FFFF00';
1.352 albertel 5220: my $mail_new = '#FFBB77';
5221: my $mail_new_hover = '#DD9955';
5222: my $mail_read = '#BBBB77';
5223: my $mail_read_hover = '#999944';
5224: my $mail_replied = '#AAAA88';
5225: my $mail_replied_hover = '#888855';
5226: my $mail_other = '#99BBBB';
5227: my $mail_other_hover = '#669999';
1.391 albertel 5228: my $table_header = '#DDDDDD';
1.489 raeburn 5229: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 5230: my $lg_border_color = '#C8C8C8';
1.952 onken 5231: my $button_hover = '#BF2317';
1.392 albertel 5232:
1.608 albertel 5233: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 5234: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
5235: : '0 3px 0 4px';
1.448 albertel 5236:
1.523 albertel 5237:
1.343 albertel 5238: return <<END;
1.947 droeschl 5239:
5240: /* needed for iframe to allow 100% height in FF */
5241: body, html {
5242: margin: 0;
5243: padding: 0 0.5%;
5244: height: 99%; /* to avoid scrollbars */
5245: }
5246:
1.795 www 5247: body {
1.911 bisitz 5248: font-family: $sans;
5249: line-height:130%;
5250: font-size:0.83em;
5251: color:$font;
1.795 www 5252: }
5253:
1.959 onken 5254: a:focus,
5255: a:focus img {
1.795 www 5256: color: red;
5257: }
1.698 harmsja 5258:
1.911 bisitz 5259: form, .inline {
5260: display: inline;
1.795 www 5261: }
1.721 harmsja 5262:
1.795 www 5263: .LC_right {
1.911 bisitz 5264: text-align:right;
1.795 www 5265: }
5266:
5267: .LC_middle {
1.911 bisitz 5268: vertical-align:middle;
1.795 www 5269: }
1.721 harmsja 5270:
1.911 bisitz 5271: .LC_400Box {
5272: width:400px;
5273: }
1.721 harmsja 5274:
1.947 droeschl 5275: .LC_iframecontainer {
5276: width: 98%;
5277: margin: 0;
5278: position: fixed;
5279: top: 8.5em;
5280: bottom: 0;
5281: }
5282:
5283: .LC_iframecontainer iframe{
5284: border: none;
5285: width: 100%;
5286: height: 100%;
5287: }
5288:
1.778 bisitz 5289: .LC_filename {
5290: font-family: $mono;
5291: white-space:pre;
1.921 bisitz 5292: font-size: 120%;
1.778 bisitz 5293: }
5294:
5295: .LC_fileicon {
5296: border: none;
5297: height: 1.3em;
5298: vertical-align: text-bottom;
5299: margin-right: 0.3em;
5300: text-decoration:none;
5301: }
5302:
1.1008 www 5303: .LC_setting {
5304: text-decoration:underline;
5305: }
5306:
1.350 albertel 5307: .LC_error {
5308: color: red;
5309: font-size: larger;
5310: }
1.795 www 5311:
1.457 albertel 5312: .LC_warning,
5313: .LC_diff_removed {
1.733 bisitz 5314: color: red;
1.394 albertel 5315: }
1.532 albertel 5316:
5317: .LC_info,
1.457 albertel 5318: .LC_success,
5319: .LC_diff_added {
1.350 albertel 5320: color: green;
5321: }
1.795 www 5322:
1.802 bisitz 5323: div.LC_confirm_box {
5324: background-color: #FAFAFA;
5325: border: 1px solid $lg_border_color;
5326: margin-right: 0;
5327: padding: 5px;
5328: }
5329:
5330: div.LC_confirm_box .LC_error img,
5331: div.LC_confirm_box .LC_success img {
5332: vertical-align: middle;
5333: }
5334:
1.440 albertel 5335: .LC_icon {
1.771 droeschl 5336: border: none;
1.790 droeschl 5337: vertical-align: middle;
1.771 droeschl 5338: }
5339:
1.543 albertel 5340: .LC_docs_spacer {
5341: width: 25px;
5342: height: 1px;
1.771 droeschl 5343: border: none;
1.543 albertel 5344: }
1.346 albertel 5345:
1.532 albertel 5346: .LC_internal_info {
1.735 bisitz 5347: color: #999999;
1.532 albertel 5348: }
5349:
1.794 www 5350: .LC_discussion {
1.1050 www 5351: background: $data_table_dark;
1.911 bisitz 5352: border: 1px solid black;
5353: margin: 2px;
1.794 www 5354: }
5355:
5356: .LC_disc_action_left {
1.1050 www 5357: background: $sidebg;
1.911 bisitz 5358: text-align: left;
1.1050 www 5359: padding: 4px;
5360: margin: 2px;
1.794 www 5361: }
5362:
5363: .LC_disc_action_right {
1.1050 www 5364: background: $sidebg;
1.911 bisitz 5365: text-align: right;
1.1050 www 5366: padding: 4px;
5367: margin: 2px;
1.794 www 5368: }
5369:
5370: .LC_disc_new_item {
1.911 bisitz 5371: background: white;
5372: border: 2px solid red;
1.1050 www 5373: margin: 4px;
5374: padding: 4px;
1.794 www 5375: }
5376:
5377: .LC_disc_old_item {
1.911 bisitz 5378: background: white;
1.1050 www 5379: margin: 4px;
5380: padding: 4px;
1.794 www 5381: }
5382:
1.458 albertel 5383: table.LC_pastsubmission {
5384: border: 1px solid black;
5385: margin: 2px;
5386: }
5387:
1.924 bisitz 5388: table#LC_menubuttons {
1.345 albertel 5389: width: 100%;
5390: background: $pgbg;
1.392 albertel 5391: border: 2px;
1.402 albertel 5392: border-collapse: separate;
1.803 bisitz 5393: padding: 0;
1.345 albertel 5394: }
1.392 albertel 5395:
1.801 tempelho 5396: table#LC_title_bar a {
5397: color: $fontmenu;
5398: }
1.836 bisitz 5399:
1.807 droeschl 5400: table#LC_title_bar {
1.819 tempelho 5401: clear: both;
1.836 bisitz 5402: display: none;
1.807 droeschl 5403: }
5404:
1.795 www 5405: table#LC_title_bar,
1.933 droeschl 5406: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 5407: table#LC_title_bar.LC_with_remote {
1.359 albertel 5408: width: 100%;
1.392 albertel 5409: border-color: $pgbg;
5410: border-style: solid;
5411: border-width: $border;
1.379 albertel 5412: background: $pgbg;
1.801 tempelho 5413: color: $fontmenu;
1.392 albertel 5414: border-collapse: collapse;
1.803 bisitz 5415: padding: 0;
1.819 tempelho 5416: margin: 0;
1.359 albertel 5417: }
1.795 www 5418:
1.933 droeschl 5419: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 5420: margin: 0;
5421: padding: 0;
1.933 droeschl 5422: position: relative;
5423: list-style: none;
1.913 droeschl 5424: }
1.933 droeschl 5425: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 5426: display: inline;
5427: }
1.933 droeschl 5428:
5429: .LC_breadcrumb_tools_navigation {
1.913 droeschl 5430: padding: 0;
1.933 droeschl 5431: margin: 0;
5432: float: left;
1.913 droeschl 5433: }
1.933 droeschl 5434: .LC_breadcrumb_tools_tools {
5435: padding: 0;
5436: margin: 0;
1.913 droeschl 5437: float: right;
5438: }
5439:
1.359 albertel 5440: table#LC_title_bar td {
5441: background: $tabbg;
5442: }
1.795 www 5443:
1.911 bisitz 5444: table#LC_menubuttons img {
1.803 bisitz 5445: border: none;
1.346 albertel 5446: }
1.795 www 5447:
1.842 droeschl 5448: .LC_breadcrumbs_component {
1.911 bisitz 5449: float: right;
5450: margin: 0 1em;
1.357 albertel 5451: }
1.842 droeschl 5452: .LC_breadcrumbs_component img {
1.911 bisitz 5453: vertical-align: middle;
1.777 tempelho 5454: }
1.795 www 5455:
1.383 albertel 5456: td.LC_table_cell_checkbox {
5457: text-align: center;
5458: }
1.795 www 5459:
5460: .LC_fontsize_small {
1.911 bisitz 5461: font-size: 70%;
1.705 tempelho 5462: }
5463:
1.844 bisitz 5464: #LC_breadcrumbs {
1.911 bisitz 5465: clear:both;
5466: background: $sidebg;
5467: border-bottom: 1px solid $lg_border_color;
5468: line-height: 2.5em;
1.933 droeschl 5469: overflow: hidden;
1.911 bisitz 5470: margin: 0;
5471: padding: 0;
1.995 raeburn 5472: text-align: left;
1.819 tempelho 5473: }
1.862 bisitz 5474:
1.993 raeburn 5475: .LC_head_subbox {
1.911 bisitz 5476: clear:both;
5477: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 5478: border: 1px solid $sidebg;
5479: margin: 0 0 10px 0;
1.966 bisitz 5480: padding: 3px;
1.995 raeburn 5481: text-align: left;
1.822 bisitz 5482: }
5483:
1.795 www 5484: .LC_fontsize_medium {
1.911 bisitz 5485: font-size: 85%;
1.705 tempelho 5486: }
5487:
1.795 www 5488: .LC_fontsize_large {
1.911 bisitz 5489: font-size: 120%;
1.705 tempelho 5490: }
5491:
1.346 albertel 5492: .LC_menubuttons_inline_text {
5493: color: $font;
1.698 harmsja 5494: font-size: 90%;
1.701 harmsja 5495: padding-left:3px;
1.346 albertel 5496: }
5497:
1.934 droeschl 5498: .LC_menubuttons_inline_text img{
5499: vertical-align: middle;
5500: }
5501:
1.1051 www 5502: li.LC_menubuttons_inline_text img {
1.951 onken 5503: cursor:pointer;
1.1002 droeschl 5504: text-decoration: none;
1.951 onken 5505: }
5506:
1.526 www 5507: .LC_menubuttons_link {
5508: text-decoration: none;
5509: }
1.795 www 5510:
1.522 albertel 5511: .LC_menubuttons_category {
1.521 www 5512: color: $font;
1.526 www 5513: background: $pgbg;
1.521 www 5514: font-size: larger;
5515: font-weight: bold;
5516: }
5517:
1.346 albertel 5518: td.LC_menubuttons_text {
1.911 bisitz 5519: color: $font;
1.346 albertel 5520: }
1.706 harmsja 5521:
1.346 albertel 5522: .LC_current_location {
5523: background: $tabbg;
5524: }
1.795 www 5525:
1.938 bisitz 5526: table.LC_data_table {
1.347 albertel 5527: border: 1px solid #000000;
1.402 albertel 5528: border-collapse: separate;
1.426 albertel 5529: border-spacing: 1px;
1.610 albertel 5530: background: $pgbg;
1.347 albertel 5531: }
1.795 www 5532:
1.422 albertel 5533: .LC_data_table_dense {
5534: font-size: small;
5535: }
1.795 www 5536:
1.507 raeburn 5537: table.LC_nested_outer {
5538: border: 1px solid #000000;
1.589 raeburn 5539: border-collapse: collapse;
1.803 bisitz 5540: border-spacing: 0;
1.507 raeburn 5541: width: 100%;
5542: }
1.795 www 5543:
1.879 raeburn 5544: table.LC_innerpickbox,
1.507 raeburn 5545: table.LC_nested {
1.803 bisitz 5546: border: none;
1.589 raeburn 5547: border-collapse: collapse;
1.803 bisitz 5548: border-spacing: 0;
1.507 raeburn 5549: width: 100%;
5550: }
1.795 www 5551:
1.911 bisitz 5552: table.LC_data_table tr th,
5553: table.LC_calendar tr th,
1.879 raeburn 5554: table.LC_prior_tries tr th,
5555: table.LC_innerpickbox tr th {
1.349 albertel 5556: font-weight: bold;
5557: background-color: $data_table_head;
1.801 tempelho 5558: color:$fontmenu;
1.701 harmsja 5559: font-size:90%;
1.347 albertel 5560: }
1.795 www 5561:
1.879 raeburn 5562: table.LC_innerpickbox tr th,
5563: table.LC_innerpickbox tr td {
5564: vertical-align: top;
5565: }
5566:
1.711 raeburn 5567: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 5568: background-color: #CCCCCC;
1.711 raeburn 5569: font-weight: bold;
5570: text-align: left;
5571: }
1.795 www 5572:
1.912 bisitz 5573: table.LC_data_table tr.LC_odd_row > td {
5574: background-color: $data_table_light;
5575: padding: 2px;
5576: vertical-align: top;
5577: }
5578:
1.809 bisitz 5579: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 5580: background-color: $data_table_light;
1.912 bisitz 5581: vertical-align: top;
5582: }
5583:
5584: table.LC_data_table tr.LC_even_row > td {
5585: background-color: $data_table_dark;
1.425 albertel 5586: padding: 2px;
1.900 bisitz 5587: vertical-align: top;
1.347 albertel 5588: }
1.795 www 5589:
1.809 bisitz 5590: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 5591: background-color: $data_table_dark;
1.900 bisitz 5592: vertical-align: top;
1.347 albertel 5593: }
1.795 www 5594:
1.425 albertel 5595: table.LC_data_table tr.LC_data_table_highlight td {
5596: background-color: $data_table_darker;
5597: }
1.795 www 5598:
1.639 raeburn 5599: table.LC_data_table tr td.LC_leftcol_header {
5600: background-color: $data_table_head;
5601: font-weight: bold;
5602: }
1.795 www 5603:
1.451 albertel 5604: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5605: table.LC_nested tr.LC_empty_row td {
1.421 albertel 5606: font-weight: bold;
5607: font-style: italic;
5608: text-align: center;
5609: padding: 8px;
1.347 albertel 5610: }
1.795 www 5611:
1.940 bisitz 5612: table.LC_data_table tr.LC_empty_row td {
5613: background-color: $sidebg;
5614: }
5615:
5616: table.LC_nested tr.LC_empty_row td {
5617: background-color: #FFFFFF;
5618: }
5619:
1.890 droeschl 5620: table.LC_caption {
5621: }
5622:
1.507 raeburn 5623: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5624: padding: 4ex
5625: }
1.795 www 5626:
1.507 raeburn 5627: table.LC_nested_outer tr th {
5628: font-weight: bold;
1.801 tempelho 5629: color:$fontmenu;
1.507 raeburn 5630: background-color: $data_table_head;
1.701 harmsja 5631: font-size: small;
1.507 raeburn 5632: border-bottom: 1px solid #000000;
5633: }
1.795 www 5634:
1.507 raeburn 5635: table.LC_nested_outer tr td.LC_subheader {
5636: background-color: $data_table_head;
5637: font-weight: bold;
5638: font-size: small;
5639: border-bottom: 1px solid #000000;
5640: text-align: right;
1.451 albertel 5641: }
1.795 www 5642:
1.507 raeburn 5643: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5644: background-color: #CCCCCC;
1.451 albertel 5645: font-weight: bold;
5646: font-size: small;
1.507 raeburn 5647: text-align: center;
5648: }
1.795 www 5649:
1.589 raeburn 5650: table.LC_nested tr.LC_info_row td.LC_left_item,
5651: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5652: text-align: left;
1.451 albertel 5653: }
1.795 www 5654:
1.507 raeburn 5655: table.LC_nested td {
1.735 bisitz 5656: background-color: #FFFFFF;
1.451 albertel 5657: font-size: small;
1.507 raeburn 5658: }
1.795 www 5659:
1.507 raeburn 5660: table.LC_nested_outer tr th.LC_right_item,
5661: table.LC_nested tr.LC_info_row td.LC_right_item,
5662: table.LC_nested tr.LC_odd_row td.LC_right_item,
5663: table.LC_nested tr td.LC_right_item {
1.451 albertel 5664: text-align: right;
5665: }
5666:
1.507 raeburn 5667: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5668: background-color: #EEEEEE;
1.451 albertel 5669: }
5670:
1.473 raeburn 5671: table.LC_createuser {
5672: }
5673:
5674: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5675: font-size: small;
1.473 raeburn 5676: }
5677:
5678: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5679: background-color: #CCCCCC;
1.473 raeburn 5680: font-weight: bold;
5681: text-align: center;
5682: }
5683:
1.349 albertel 5684: table.LC_calendar {
5685: border: 1px solid #000000;
5686: border-collapse: collapse;
1.917 raeburn 5687: width: 98%;
1.349 albertel 5688: }
1.795 www 5689:
1.349 albertel 5690: table.LC_calendar_pickdate {
5691: font-size: xx-small;
5692: }
1.795 www 5693:
1.349 albertel 5694: table.LC_calendar tr td {
5695: border: 1px solid #000000;
5696: vertical-align: top;
1.917 raeburn 5697: width: 14%;
1.349 albertel 5698: }
1.795 www 5699:
1.349 albertel 5700: table.LC_calendar tr td.LC_calendar_day_empty {
5701: background-color: $data_table_dark;
5702: }
1.795 www 5703:
1.779 bisitz 5704: table.LC_calendar tr td.LC_calendar_day_current {
5705: background-color: $data_table_highlight;
1.777 tempelho 5706: }
1.795 www 5707:
1.938 bisitz 5708: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 5709: background-color: $mail_new;
5710: }
1.795 www 5711:
1.938 bisitz 5712: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 5713: background-color: $mail_new_hover;
5714: }
1.795 www 5715:
1.938 bisitz 5716: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 5717: background-color: $mail_read;
5718: }
1.795 www 5719:
1.938 bisitz 5720: /*
5721: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 5722: background-color: $mail_read_hover;
5723: }
1.938 bisitz 5724: */
1.795 www 5725:
1.938 bisitz 5726: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 5727: background-color: $mail_replied;
5728: }
1.795 www 5729:
1.938 bisitz 5730: /*
5731: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 5732: background-color: $mail_replied_hover;
5733: }
1.938 bisitz 5734: */
1.795 www 5735:
1.938 bisitz 5736: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 5737: background-color: $mail_other;
5738: }
1.795 www 5739:
1.938 bisitz 5740: /*
5741: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 5742: background-color: $mail_other_hover;
5743: }
1.938 bisitz 5744: */
1.494 raeburn 5745:
1.777 tempelho 5746: table.LC_data_table tr > td.LC_browser_file,
5747: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 5748: background: #AAEE77;
1.389 albertel 5749: }
1.795 www 5750:
1.777 tempelho 5751: table.LC_data_table tr > td.LC_browser_file_locked,
5752: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5753: background: #FFAA99;
1.387 albertel 5754: }
1.795 www 5755:
1.777 tempelho 5756: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 5757: background: #888888;
1.779 bisitz 5758: }
1.795 www 5759:
1.777 tempelho 5760: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5761: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 5762: background: #F8F866;
1.777 tempelho 5763: }
1.795 www 5764:
1.696 bisitz 5765: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 5766: background: #E0E8FF;
1.387 albertel 5767: }
1.696 bisitz 5768:
1.707 bisitz 5769: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 5770: /* background: #77FF77; */
1.707 bisitz 5771: }
1.795 www 5772:
1.707 bisitz 5773: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 5774: border-right: 8px solid #FFFF77;
1.707 bisitz 5775: }
1.795 www 5776:
1.707 bisitz 5777: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 5778: border-right: 8px solid #FFAA77;
1.707 bisitz 5779: }
1.795 www 5780:
1.707 bisitz 5781: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 5782: border-right: 8px solid #FF7777;
1.707 bisitz 5783: }
1.795 www 5784:
1.707 bisitz 5785: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 5786: border-right: 8px solid #AAFF77;
1.707 bisitz 5787: }
1.795 www 5788:
1.707 bisitz 5789: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 5790: border-right: 8px solid #11CC55;
1.707 bisitz 5791: }
5792:
1.388 albertel 5793: span.LC_current_location {
1.701 harmsja 5794: font-size:larger;
1.388 albertel 5795: background: $pgbg;
5796: }
1.387 albertel 5797:
1.1029 www 5798: span.LC_current_nav_location {
5799: font-weight:bold;
5800: background: $sidebg;
5801: }
5802:
1.395 albertel 5803: span.LC_parm_menu_item {
5804: font-size: larger;
5805: }
1.795 www 5806:
1.395 albertel 5807: span.LC_parm_scope_all {
5808: color: red;
5809: }
1.795 www 5810:
1.395 albertel 5811: span.LC_parm_scope_folder {
5812: color: green;
5813: }
1.795 www 5814:
1.395 albertel 5815: span.LC_parm_scope_resource {
5816: color: orange;
5817: }
1.795 www 5818:
1.395 albertel 5819: span.LC_parm_part {
5820: color: blue;
5821: }
1.795 www 5822:
1.911 bisitz 5823: span.LC_parm_folder,
5824: span.LC_parm_symb {
1.395 albertel 5825: font-size: x-small;
5826: font-family: $mono;
5827: color: #AAAAAA;
5828: }
5829:
1.977 bisitz 5830: ul.LC_parm_parmlist li {
5831: display: inline-block;
5832: padding: 0.3em 0.8em;
5833: vertical-align: top;
5834: width: 150px;
5835: border-top:1px solid $lg_border_color;
5836: }
5837:
1.795 www 5838: td.LC_parm_overview_level_menu,
5839: td.LC_parm_overview_map_menu,
5840: td.LC_parm_overview_parm_selectors,
5841: td.LC_parm_overview_restrictions {
1.396 albertel 5842: border: 1px solid black;
5843: border-collapse: collapse;
5844: }
1.795 www 5845:
1.396 albertel 5846: table.LC_parm_overview_restrictions td {
5847: border-width: 1px 4px 1px 4px;
5848: border-style: solid;
5849: border-color: $pgbg;
5850: text-align: center;
5851: }
1.795 www 5852:
1.396 albertel 5853: table.LC_parm_overview_restrictions th {
5854: background: $tabbg;
5855: border-width: 1px 4px 1px 4px;
5856: border-style: solid;
5857: border-color: $pgbg;
5858: }
1.795 www 5859:
1.398 albertel 5860: table#LC_helpmenu {
1.803 bisitz 5861: border: none;
1.398 albertel 5862: height: 55px;
1.803 bisitz 5863: border-spacing: 0;
1.398 albertel 5864: }
5865:
5866: table#LC_helpmenu fieldset legend {
5867: font-size: larger;
5868: }
1.795 www 5869:
1.397 albertel 5870: table#LC_helpmenu_links {
5871: width: 100%;
5872: border: 1px solid black;
5873: background: $pgbg;
1.803 bisitz 5874: padding: 0;
1.397 albertel 5875: border-spacing: 1px;
5876: }
1.795 www 5877:
1.397 albertel 5878: table#LC_helpmenu_links tr td {
5879: padding: 1px;
5880: background: $tabbg;
1.399 albertel 5881: text-align: center;
5882: font-weight: bold;
1.397 albertel 5883: }
1.396 albertel 5884:
1.795 www 5885: table#LC_helpmenu_links a:link,
5886: table#LC_helpmenu_links a:visited,
1.397 albertel 5887: table#LC_helpmenu_links a:active {
5888: text-decoration: none;
5889: color: $font;
5890: }
1.795 www 5891:
1.397 albertel 5892: table#LC_helpmenu_links a:hover {
5893: text-decoration: underline;
5894: color: $vlink;
5895: }
1.396 albertel 5896:
1.417 albertel 5897: .LC_chrt_popup_exists {
5898: border: 1px solid #339933;
5899: margin: -1px;
5900: }
1.795 www 5901:
1.417 albertel 5902: .LC_chrt_popup_up {
5903: border: 1px solid yellow;
5904: margin: -1px;
5905: }
1.795 www 5906:
1.417 albertel 5907: .LC_chrt_popup {
5908: border: 1px solid #8888FF;
5909: background: #CCCCFF;
5910: }
1.795 www 5911:
1.421 albertel 5912: table.LC_pick_box {
5913: border-collapse: separate;
5914: background: white;
5915: border: 1px solid black;
5916: border-spacing: 1px;
5917: }
1.795 www 5918:
1.421 albertel 5919: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 5920: background: $sidebg;
1.421 albertel 5921: font-weight: bold;
1.900 bisitz 5922: text-align: left;
1.740 bisitz 5923: vertical-align: top;
1.421 albertel 5924: width: 184px;
5925: padding: 8px;
5926: }
1.795 www 5927:
1.579 raeburn 5928: table.LC_pick_box td.LC_pick_box_value {
5929: text-align: left;
5930: padding: 8px;
5931: }
1.795 www 5932:
1.579 raeburn 5933: table.LC_pick_box td.LC_pick_box_select {
5934: text-align: left;
5935: padding: 8px;
5936: }
1.795 www 5937:
1.424 albertel 5938: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 5939: padding: 0;
1.421 albertel 5940: height: 1px;
5941: background: black;
5942: }
1.795 www 5943:
1.421 albertel 5944: table.LC_pick_box td.LC_pick_box_submit {
5945: text-align: right;
5946: }
1.795 www 5947:
1.579 raeburn 5948: table.LC_pick_box td.LC_evenrow_value {
5949: text-align: left;
5950: padding: 8px;
5951: background-color: $data_table_light;
5952: }
1.795 www 5953:
1.579 raeburn 5954: table.LC_pick_box td.LC_oddrow_value {
5955: text-align: left;
5956: padding: 8px;
5957: background-color: $data_table_light;
5958: }
1.795 www 5959:
1.579 raeburn 5960: span.LC_helpform_receipt_cat {
5961: font-weight: bold;
5962: }
1.795 www 5963:
1.424 albertel 5964: table.LC_group_priv_box {
5965: background: white;
5966: border: 1px solid black;
5967: border-spacing: 1px;
5968: }
1.795 www 5969:
1.424 albertel 5970: table.LC_group_priv_box td.LC_pick_box_title {
5971: background: $tabbg;
5972: font-weight: bold;
5973: text-align: right;
5974: width: 184px;
5975: }
1.795 www 5976:
1.424 albertel 5977: table.LC_group_priv_box td.LC_groups_fixed {
5978: background: $data_table_light;
5979: text-align: center;
5980: }
1.795 www 5981:
1.424 albertel 5982: table.LC_group_priv_box td.LC_groups_optional {
5983: background: $data_table_dark;
5984: text-align: center;
5985: }
1.795 www 5986:
1.424 albertel 5987: table.LC_group_priv_box td.LC_groups_functionality {
5988: background: $data_table_darker;
5989: text-align: center;
5990: font-weight: bold;
5991: }
1.795 www 5992:
1.424 albertel 5993: table.LC_group_priv td {
5994: text-align: left;
1.803 bisitz 5995: padding: 0;
1.424 albertel 5996: }
5997:
5998: .LC_navbuttons {
5999: margin: 2ex 0ex 2ex 0ex;
6000: }
1.795 www 6001:
1.423 albertel 6002: .LC_topic_bar {
6003: font-weight: bold;
6004: background: $tabbg;
1.918 wenzelju 6005: margin: 1em 0em 1em 2em;
1.805 bisitz 6006: padding: 3px;
1.918 wenzelju 6007: font-size: 1.2em;
1.423 albertel 6008: }
1.795 www 6009:
1.423 albertel 6010: .LC_topic_bar span {
1.918 wenzelju 6011: left: 0.5em;
6012: position: absolute;
1.423 albertel 6013: vertical-align: middle;
1.918 wenzelju 6014: font-size: 1.2em;
1.423 albertel 6015: }
1.795 www 6016:
1.423 albertel 6017: table.LC_course_group_status {
6018: margin: 20px;
6019: }
1.795 www 6020:
1.423 albertel 6021: table.LC_status_selector td {
6022: vertical-align: top;
6023: text-align: center;
1.424 albertel 6024: padding: 4px;
6025: }
1.795 www 6026:
1.599 albertel 6027: div.LC_feedback_link {
1.616 albertel 6028: clear: both;
1.829 kalberla 6029: background: $sidebg;
1.779 bisitz 6030: width: 100%;
1.829 kalberla 6031: padding-bottom: 10px;
6032: border: 1px $tabbg solid;
1.833 kalberla 6033: height: 22px;
6034: line-height: 22px;
6035: padding-top: 5px;
6036: }
6037:
6038: div.LC_feedback_link img {
6039: height: 22px;
1.867 kalberla 6040: vertical-align:middle;
1.829 kalberla 6041: }
6042:
1.911 bisitz 6043: div.LC_feedback_link a {
1.829 kalberla 6044: text-decoration: none;
1.489 raeburn 6045: }
1.795 www 6046:
1.867 kalberla 6047: div.LC_comblock {
1.911 bisitz 6048: display:inline;
1.867 kalberla 6049: color:$font;
6050: font-size:90%;
6051: }
6052:
6053: div.LC_feedback_link div.LC_comblock {
6054: padding-left:5px;
6055: }
6056:
6057: div.LC_feedback_link div.LC_comblock a {
6058: color:$font;
6059: }
6060:
1.489 raeburn 6061: span.LC_feedback_link {
1.858 bisitz 6062: /* background: $feedback_link_bg; */
1.599 albertel 6063: font-size: larger;
6064: }
1.795 www 6065:
1.599 albertel 6066: span.LC_message_link {
1.858 bisitz 6067: /* background: $feedback_link_bg; */
1.599 albertel 6068: font-size: larger;
6069: position: absolute;
6070: right: 1em;
1.489 raeburn 6071: }
1.421 albertel 6072:
1.515 albertel 6073: table.LC_prior_tries {
1.524 albertel 6074: border: 1px solid #000000;
6075: border-collapse: separate;
6076: border-spacing: 1px;
1.515 albertel 6077: }
1.523 albertel 6078:
1.515 albertel 6079: table.LC_prior_tries td {
1.524 albertel 6080: padding: 2px;
1.515 albertel 6081: }
1.523 albertel 6082:
6083: .LC_answer_correct {
1.795 www 6084: background: lightgreen;
6085: color: darkgreen;
6086: padding: 6px;
1.523 albertel 6087: }
1.795 www 6088:
1.523 albertel 6089: .LC_answer_charged_try {
1.797 www 6090: background: #FFAAAA;
1.795 www 6091: color: darkred;
6092: padding: 6px;
1.523 albertel 6093: }
1.795 www 6094:
1.779 bisitz 6095: .LC_answer_not_charged_try,
1.523 albertel 6096: .LC_answer_no_grade,
6097: .LC_answer_late {
1.795 www 6098: background: lightyellow;
1.523 albertel 6099: color: black;
1.795 www 6100: padding: 6px;
1.523 albertel 6101: }
1.795 www 6102:
1.523 albertel 6103: .LC_answer_previous {
1.795 www 6104: background: lightblue;
6105: color: darkblue;
6106: padding: 6px;
1.523 albertel 6107: }
1.795 www 6108:
1.779 bisitz 6109: .LC_answer_no_message {
1.777 tempelho 6110: background: #FFFFFF;
6111: color: black;
1.795 www 6112: padding: 6px;
1.779 bisitz 6113: }
1.795 www 6114:
1.779 bisitz 6115: .LC_answer_unknown {
6116: background: orange;
6117: color: black;
1.795 www 6118: padding: 6px;
1.777 tempelho 6119: }
1.795 www 6120:
1.529 albertel 6121: span.LC_prior_numerical,
6122: span.LC_prior_string,
6123: span.LC_prior_custom,
6124: span.LC_prior_reaction,
6125: span.LC_prior_math {
1.925 bisitz 6126: font-family: $mono;
1.523 albertel 6127: white-space: pre;
6128: }
6129:
1.525 albertel 6130: span.LC_prior_string {
1.925 bisitz 6131: font-family: $mono;
1.525 albertel 6132: white-space: pre;
6133: }
6134:
1.523 albertel 6135: table.LC_prior_option {
6136: width: 100%;
6137: border-collapse: collapse;
6138: }
1.795 www 6139:
1.911 bisitz 6140: table.LC_prior_rank,
1.795 www 6141: table.LC_prior_match {
1.528 albertel 6142: border-collapse: collapse;
6143: }
1.795 www 6144:
1.528 albertel 6145: table.LC_prior_option tr td,
6146: table.LC_prior_rank tr td,
6147: table.LC_prior_match tr td {
1.524 albertel 6148: border: 1px solid #000000;
1.515 albertel 6149: }
6150:
1.855 bisitz 6151: .LC_nobreak {
1.544 albertel 6152: white-space: nowrap;
1.519 raeburn 6153: }
6154:
1.576 raeburn 6155: span.LC_cusr_emph {
6156: font-style: italic;
6157: }
6158:
1.633 raeburn 6159: span.LC_cusr_subheading {
6160: font-weight: normal;
6161: font-size: 85%;
6162: }
6163:
1.861 bisitz 6164: div.LC_docs_entry_move {
1.859 bisitz 6165: border: 1px solid #BBBBBB;
1.545 albertel 6166: background: #DDDDDD;
1.861 bisitz 6167: width: 22px;
1.859 bisitz 6168: padding: 1px;
6169: margin: 0;
1.545 albertel 6170: }
6171:
1.861 bisitz 6172: table.LC_data_table tr > td.LC_docs_entry_commands,
6173: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 6174: background: #DDDDDD;
6175: font-size: x-small;
6176: }
1.795 www 6177:
1.861 bisitz 6178: .LC_docs_entry_parameter {
6179: white-space: nowrap;
6180: }
6181:
1.544 albertel 6182: .LC_docs_copy {
1.545 albertel 6183: color: #000099;
1.544 albertel 6184: }
1.795 www 6185:
1.544 albertel 6186: .LC_docs_cut {
1.545 albertel 6187: color: #550044;
1.544 albertel 6188: }
1.795 www 6189:
1.544 albertel 6190: .LC_docs_rename {
1.545 albertel 6191: color: #009900;
1.544 albertel 6192: }
1.795 www 6193:
1.544 albertel 6194: .LC_docs_remove {
1.545 albertel 6195: color: #990000;
6196: }
6197:
1.547 albertel 6198: .LC_docs_reinit_warn,
6199: .LC_docs_ext_edit {
6200: font-size: x-small;
6201: }
6202:
1.545 albertel 6203: table.LC_docs_adddocs td,
6204: table.LC_docs_adddocs th {
6205: border: 1px solid #BBBBBB;
6206: padding: 4px;
6207: background: #DDDDDD;
1.543 albertel 6208: }
6209:
1.584 albertel 6210: table.LC_sty_begin {
6211: background: #BBFFBB;
6212: }
1.795 www 6213:
1.584 albertel 6214: table.LC_sty_end {
6215: background: #FFBBBB;
6216: }
6217:
1.589 raeburn 6218: table.LC_double_column {
1.803 bisitz 6219: border-width: 0;
1.589 raeburn 6220: border-collapse: collapse;
6221: width: 100%;
6222: padding: 2px;
6223: }
6224:
6225: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 6226: top: 2px;
1.589 raeburn 6227: left: 2px;
6228: width: 47%;
6229: vertical-align: top;
6230: }
6231:
6232: table.LC_double_column tr td.LC_right_col {
6233: top: 2px;
1.779 bisitz 6234: right: 2px;
1.589 raeburn 6235: width: 47%;
6236: vertical-align: top;
6237: }
6238:
1.591 raeburn 6239: div.LC_left_float {
6240: float: left;
6241: padding-right: 5%;
1.597 albertel 6242: padding-bottom: 4px;
1.591 raeburn 6243: }
6244:
6245: div.LC_clear_float_header {
1.597 albertel 6246: padding-bottom: 2px;
1.591 raeburn 6247: }
6248:
6249: div.LC_clear_float_footer {
1.597 albertel 6250: padding-top: 10px;
1.591 raeburn 6251: clear: both;
6252: }
6253:
1.597 albertel 6254: div.LC_grade_show_user {
1.941 bisitz 6255: /* border-left: 5px solid $sidebg; */
6256: border-top: 5px solid #000000;
6257: margin: 50px 0 0 0;
1.936 bisitz 6258: padding: 15px 0 5px 10px;
1.597 albertel 6259: }
1.795 www 6260:
1.936 bisitz 6261: div.LC_grade_show_user_odd_row {
1.941 bisitz 6262: /* border-left: 5px solid #000000; */
6263: }
6264:
6265: div.LC_grade_show_user div.LC_Box {
6266: margin-right: 50px;
1.597 albertel 6267: }
6268:
6269: div.LC_grade_submissions,
6270: div.LC_grade_message_center,
1.936 bisitz 6271: div.LC_grade_info_links {
1.597 albertel 6272: margin: 5px;
6273: width: 99%;
6274: background: #FFFFFF;
6275: }
1.795 www 6276:
1.597 albertel 6277: div.LC_grade_submissions_header,
1.936 bisitz 6278: div.LC_grade_message_center_header {
1.705 tempelho 6279: font-weight: bold;
6280: font-size: large;
1.597 albertel 6281: }
1.795 www 6282:
1.597 albertel 6283: div.LC_grade_submissions_body,
1.936 bisitz 6284: div.LC_grade_message_center_body {
1.597 albertel 6285: border: 1px solid black;
6286: width: 99%;
6287: background: #FFFFFF;
6288: }
1.795 www 6289:
1.613 albertel 6290: table.LC_scantron_action {
6291: width: 100%;
6292: }
1.795 www 6293:
1.613 albertel 6294: table.LC_scantron_action tr th {
1.698 harmsja 6295: font-weight:bold;
6296: font-style:normal;
1.613 albertel 6297: }
1.795 www 6298:
1.779 bisitz 6299: .LC_edit_problem_header,
1.614 albertel 6300: div.LC_edit_problem_footer {
1.705 tempelho 6301: font-weight: normal;
6302: font-size: medium;
1.602 albertel 6303: margin: 2px;
1.1060 bisitz 6304: background-color: $sidebg;
1.600 albertel 6305: }
1.795 www 6306:
1.600 albertel 6307: div.LC_edit_problem_header,
1.602 albertel 6308: div.LC_edit_problem_header div,
1.614 albertel 6309: div.LC_edit_problem_footer,
6310: div.LC_edit_problem_footer div,
1.602 albertel 6311: div.LC_edit_problem_editxml_header,
6312: div.LC_edit_problem_editxml_header div {
1.600 albertel 6313: margin-top: 5px;
6314: }
1.795 www 6315:
1.600 albertel 6316: div.LC_edit_problem_header_title {
1.705 tempelho 6317: font-weight: bold;
6318: font-size: larger;
1.602 albertel 6319: background: $tabbg;
6320: padding: 3px;
1.1060 bisitz 6321: margin: 0 0 5px 0;
1.602 albertel 6322: }
1.795 www 6323:
1.602 albertel 6324: table.LC_edit_problem_header_title {
6325: width: 100%;
1.600 albertel 6326: background: $tabbg;
1.602 albertel 6327: }
6328:
6329: div.LC_edit_problem_discards {
6330: float: left;
6331: padding-bottom: 5px;
6332: }
1.795 www 6333:
1.602 albertel 6334: div.LC_edit_problem_saves {
6335: float: right;
6336: padding-bottom: 5px;
1.600 albertel 6337: }
1.795 www 6338:
1.911 bisitz 6339: img.stift {
1.803 bisitz 6340: border-width: 0;
6341: vertical-align: middle;
1.677 riegler 6342: }
1.680 riegler 6343:
1.923 bisitz 6344: table td.LC_mainmenu_col_fieldset {
1.680 riegler 6345: vertical-align: top;
1.777 tempelho 6346: }
1.795 www 6347:
1.716 raeburn 6348: div.LC_createcourse {
1.911 bisitz 6349: margin: 10px 10px 10px 10px;
1.716 raeburn 6350: }
6351:
1.917 raeburn 6352: .LC_dccid {
6353: margin: 0.2em 0 0 0;
6354: padding: 0;
6355: font-size: 90%;
6356: display:none;
6357: }
6358:
1.897 wenzelju 6359: ol.LC_primary_menu a:hover,
1.721 harmsja 6360: ol#LC_MenuBreadcrumbs a:hover,
6361: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 6362: ul#LC_secondary_menu a:hover,
1.721 harmsja 6363: .LC_FormSectionClearButton input:hover
1.795 www 6364: ul.LC_TabContent li:hover a {
1.952 onken 6365: color:$button_hover;
1.911 bisitz 6366: text-decoration:none;
1.693 droeschl 6367: }
6368:
1.779 bisitz 6369: h1 {
1.911 bisitz 6370: padding: 0;
6371: line-height:130%;
1.693 droeschl 6372: }
1.698 harmsja 6373:
1.911 bisitz 6374: h2,
6375: h3,
6376: h4,
6377: h5,
6378: h6 {
6379: margin: 5px 0 5px 0;
6380: padding: 0;
6381: line-height:130%;
1.693 droeschl 6382: }
1.795 www 6383:
6384: .LC_hcell {
1.911 bisitz 6385: padding:3px 15px 3px 15px;
6386: margin: 0;
6387: background-color:$tabbg;
6388: color:$fontmenu;
6389: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 6390: }
1.795 www 6391:
1.840 bisitz 6392: .LC_Box > .LC_hcell {
1.911 bisitz 6393: margin: 0 -10px 10px -10px;
1.835 bisitz 6394: }
6395:
1.721 harmsja 6396: .LC_noBorder {
1.911 bisitz 6397: border: 0;
1.698 harmsja 6398: }
1.693 droeschl 6399:
1.721 harmsja 6400: .LC_FormSectionClearButton input {
1.911 bisitz 6401: background-color:transparent;
6402: border: none;
6403: cursor:pointer;
6404: text-decoration:underline;
1.693 droeschl 6405: }
1.763 bisitz 6406:
6407: .LC_help_open_topic {
1.911 bisitz 6408: color: #FFFFFF;
6409: background-color: #EEEEFF;
6410: margin: 1px;
6411: padding: 4px;
6412: border: 1px solid #000033;
6413: white-space: nowrap;
6414: /* vertical-align: middle; */
1.759 neumanie 6415: }
1.693 droeschl 6416:
1.911 bisitz 6417: dl,
6418: ul,
6419: div,
6420: fieldset {
6421: margin: 10px 10px 10px 0;
6422: /* overflow: hidden; */
1.693 droeschl 6423: }
1.795 www 6424:
1.838 bisitz 6425: fieldset > legend {
1.911 bisitz 6426: font-weight: bold;
6427: padding: 0 5px 0 5px;
1.838 bisitz 6428: }
6429:
1.813 bisitz 6430: #LC_nav_bar {
1.911 bisitz 6431: float: left;
1.995 raeburn 6432: background-color: $pgbg_or_bgcolor;
1.966 bisitz 6433: margin: 0 0 2px 0;
1.807 droeschl 6434: }
6435:
1.916 droeschl 6436: #LC_realm {
6437: margin: 0.2em 0 0 0;
6438: padding: 0;
6439: font-weight: bold;
6440: text-align: center;
1.995 raeburn 6441: background-color: $pgbg_or_bgcolor;
1.916 droeschl 6442: }
6443:
1.911 bisitz 6444: #LC_nav_bar em {
6445: font-weight: bold;
6446: font-style: normal;
1.807 droeschl 6447: }
6448:
1.897 wenzelju 6449: ol.LC_primary_menu {
1.911 bisitz 6450: float: right;
1.934 droeschl 6451: margin: 0;
1.1076 raeburn 6452: padding: 0;
1.995 raeburn 6453: background-color: $pgbg_or_bgcolor;
1.807 droeschl 6454: }
6455:
1.852 droeschl 6456: ol#LC_PathBreadcrumbs {
1.911 bisitz 6457: margin: 0;
1.693 droeschl 6458: }
6459:
1.897 wenzelju 6460: ol.LC_primary_menu li {
1.1076 raeburn 6461: color: RGB(80, 80, 80);
6462: vertical-align: middle;
6463: text-align: left;
6464: list-style: none;
6465: float: left;
6466: }
6467:
6468: ol.LC_primary_menu li a {
6469: display: block;
6470: margin: 0;
6471: padding: 0 5px 0 10px;
6472: text-decoration: none;
6473: }
6474:
6475: ol.LC_primary_menu li ul {
6476: display: none;
6477: width: 10em;
6478: background-color: $data_table_light;
6479: }
6480:
6481: ol.LC_primary_menu li:hover ul, ol.LC_primary_menu li.hover ul {
6482: display: block;
6483: position: absolute;
6484: margin: 0;
6485: padding: 0;
1.1078 raeburn 6486: z-index: 2;
1.1076 raeburn 6487: }
6488:
6489: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
6490: font-size: 90%;
1.911 bisitz 6491: vertical-align: top;
1.1076 raeburn 6492: float: none;
1.1079 raeburn 6493: border-left: 1px solid black;
6494: border-right: 1px solid black;
1.1076 raeburn 6495: }
6496:
6497: ol.LC_primary_menu li:hover li a, ol.LC_primary_menu li.hover li a {
1.1078 raeburn 6498: background-color:$data_table_light;
1.1076 raeburn 6499: }
6500:
6501: ol.LC_primary_menu li li a:hover {
6502: color:$button_hover;
6503: background-color:$data_table_dark;
1.693 droeschl 6504: }
6505:
1.897 wenzelju 6506: ol.LC_primary_menu li img {
1.911 bisitz 6507: vertical-align: bottom;
1.934 droeschl 6508: height: 1.1em;
1.1077 raeburn 6509: margin: 0.2em 0 0 0;
1.693 droeschl 6510: }
6511:
1.897 wenzelju 6512: ol.LC_primary_menu a {
1.911 bisitz 6513: color: RGB(80, 80, 80);
6514: text-decoration: none;
1.693 droeschl 6515: }
1.795 www 6516:
1.949 droeschl 6517: ol.LC_primary_menu a.LC_new_message {
6518: font-weight:bold;
6519: color: darkred;
6520: }
6521:
1.975 raeburn 6522: ol.LC_docs_parameters {
6523: margin-left: 0;
6524: padding: 0;
6525: list-style: none;
6526: }
6527:
6528: ol.LC_docs_parameters li {
6529: margin: 0;
6530: padding-right: 20px;
6531: display: inline;
6532: }
6533:
1.976 raeburn 6534: ol.LC_docs_parameters li:before {
6535: content: "\\002022 \\0020";
6536: }
6537:
6538: li.LC_docs_parameters_title {
6539: font-weight: bold;
6540: }
6541:
6542: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
6543: content: "";
6544: }
6545:
1.897 wenzelju 6546: ul#LC_secondary_menu {
1.911 bisitz 6547: clear: both;
6548: color: $fontmenu;
6549: background: $tabbg;
6550: list-style: none;
6551: padding: 0;
6552: margin: 0;
6553: width: 100%;
1.995 raeburn 6554: text-align: left;
1.808 droeschl 6555: }
6556:
1.897 wenzelju 6557: ul#LC_secondary_menu li {
1.911 bisitz 6558: font-weight: bold;
6559: line-height: 1.8em;
6560: padding: 0 0.8em;
6561: border-right: 1px solid black;
6562: display: inline;
6563: vertical-align: middle;
1.807 droeschl 6564: }
6565:
1.847 tempelho 6566: ul.LC_TabContent {
1.911 bisitz 6567: display:block;
6568: background: $sidebg;
6569: border-bottom: solid 1px $lg_border_color;
6570: list-style:none;
1.1020 raeburn 6571: margin: -1px -10px 0 -10px;
1.911 bisitz 6572: padding: 0;
1.693 droeschl 6573: }
6574:
1.795 www 6575: ul.LC_TabContent li,
6576: ul.LC_TabContentBigger li {
1.911 bisitz 6577: float:left;
1.741 harmsja 6578: }
1.795 www 6579:
1.897 wenzelju 6580: ul#LC_secondary_menu li a {
1.911 bisitz 6581: color: $fontmenu;
6582: text-decoration: none;
1.693 droeschl 6583: }
1.795 www 6584:
1.721 harmsja 6585: ul.LC_TabContent {
1.952 onken 6586: min-height:20px;
1.721 harmsja 6587: }
1.795 www 6588:
6589: ul.LC_TabContent li {
1.911 bisitz 6590: vertical-align:middle;
1.959 onken 6591: padding: 0 16px 0 10px;
1.911 bisitz 6592: background-color:$tabbg;
6593: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 6594: border-left: solid 1px $font;
1.721 harmsja 6595: }
1.795 www 6596:
1.847 tempelho 6597: ul.LC_TabContent .right {
1.911 bisitz 6598: float:right;
1.847 tempelho 6599: }
6600:
1.911 bisitz 6601: ul.LC_TabContent li a,
6602: ul.LC_TabContent li {
6603: color:rgb(47,47,47);
6604: text-decoration:none;
6605: font-size:95%;
6606: font-weight:bold;
1.952 onken 6607: min-height:20px;
6608: }
6609:
1.959 onken 6610: ul.LC_TabContent li a:hover,
6611: ul.LC_TabContent li a:focus {
1.952 onken 6612: color: $button_hover;
1.959 onken 6613: background:none;
6614: outline:none;
1.952 onken 6615: }
6616:
6617: ul.LC_TabContent li:hover {
6618: color: $button_hover;
6619: cursor:pointer;
1.721 harmsja 6620: }
1.795 www 6621:
1.911 bisitz 6622: ul.LC_TabContent li.active {
1.952 onken 6623: color: $font;
1.911 bisitz 6624: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 6625: border-bottom:solid 1px #FFFFFF;
6626: cursor: default;
1.744 ehlerst 6627: }
1.795 www 6628:
1.959 onken 6629: ul.LC_TabContent li.active a {
6630: color:$font;
6631: background:#FFFFFF;
6632: outline: none;
6633: }
1.1047 raeburn 6634:
6635: ul.LC_TabContent li.goback {
6636: float: left;
6637: border-left: none;
6638: }
6639:
1.870 tempelho 6640: #maincoursedoc {
1.911 bisitz 6641: clear:both;
1.870 tempelho 6642: }
6643:
6644: ul.LC_TabContentBigger {
1.911 bisitz 6645: display:block;
6646: list-style:none;
6647: padding: 0;
1.870 tempelho 6648: }
6649:
1.795 www 6650: ul.LC_TabContentBigger li {
1.911 bisitz 6651: vertical-align:bottom;
6652: height: 30px;
6653: font-size:110%;
6654: font-weight:bold;
6655: color: #737373;
1.841 tempelho 6656: }
6657:
1.957 onken 6658: ul.LC_TabContentBigger li.active {
6659: position: relative;
6660: top: 1px;
6661: }
6662:
1.870 tempelho 6663: ul.LC_TabContentBigger li a {
1.911 bisitz 6664: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6665: height: 30px;
6666: line-height: 30px;
6667: text-align: center;
6668: display: block;
6669: text-decoration: none;
1.958 onken 6670: outline: none;
1.741 harmsja 6671: }
1.795 www 6672:
1.870 tempelho 6673: ul.LC_TabContentBigger li.active a {
1.911 bisitz 6674: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6675: color:$font;
1.744 ehlerst 6676: }
1.795 www 6677:
1.870 tempelho 6678: ul.LC_TabContentBigger li b {
1.911 bisitz 6679: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
6680: display: block;
6681: float: left;
6682: padding: 0 30px;
1.957 onken 6683: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 6684: }
6685:
1.956 onken 6686: ul.LC_TabContentBigger li:hover b {
6687: color:$button_hover;
6688: }
6689:
1.870 tempelho 6690: ul.LC_TabContentBigger li.active b {
1.911 bisitz 6691: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
6692: color:$font;
1.957 onken 6693: border: 0;
1.741 harmsja 6694: }
1.693 droeschl 6695:
1.870 tempelho 6696:
1.862 bisitz 6697: ul.LC_CourseBreadcrumbs {
6698: background: $sidebg;
1.1020 raeburn 6699: height: 2em;
1.862 bisitz 6700: padding-left: 10px;
1.1020 raeburn 6701: margin: 0;
1.862 bisitz 6702: list-style-position: inside;
6703: }
6704:
1.911 bisitz 6705: ol#LC_MenuBreadcrumbs,
1.862 bisitz 6706: ol#LC_PathBreadcrumbs {
1.911 bisitz 6707: padding-left: 10px;
6708: margin: 0;
1.933 droeschl 6709: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 6710: }
6711:
1.911 bisitz 6712: ol#LC_MenuBreadcrumbs li,
6713: ol#LC_PathBreadcrumbs li,
1.862 bisitz 6714: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 6715: display: inline;
1.933 droeschl 6716: white-space: normal;
1.693 droeschl 6717: }
6718:
1.823 bisitz 6719: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 6720: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 6721: text-decoration: none;
6722: font-size:90%;
1.693 droeschl 6723: }
1.795 www 6724:
1.969 droeschl 6725: ol#LC_MenuBreadcrumbs h1 {
6726: display: inline;
6727: font-size: 90%;
6728: line-height: 2.5em;
6729: margin: 0;
6730: padding: 0;
6731: }
6732:
1.795 www 6733: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 6734: text-decoration:none;
6735: font-size:100%;
6736: font-weight:bold;
1.693 droeschl 6737: }
1.795 www 6738:
1.840 bisitz 6739: .LC_Box {
1.911 bisitz 6740: border: solid 1px $lg_border_color;
6741: padding: 0 10px 10px 10px;
1.746 neumanie 6742: }
1.795 www 6743:
1.1020 raeburn 6744: .LC_DocsBox {
6745: border: solid 1px $lg_border_color;
6746: padding: 0 0 10px 10px;
6747: }
6748:
1.795 www 6749: .LC_AboutMe_Image {
1.911 bisitz 6750: float:left;
6751: margin-right:10px;
1.747 neumanie 6752: }
1.795 www 6753:
6754: .LC_Clear_AboutMe_Image {
1.911 bisitz 6755: clear:left;
1.747 neumanie 6756: }
1.795 www 6757:
1.721 harmsja 6758: dl.LC_ListStyleClean dt {
1.911 bisitz 6759: padding-right: 5px;
6760: display: table-header-group;
1.693 droeschl 6761: }
6762:
1.721 harmsja 6763: dl.LC_ListStyleClean dd {
1.911 bisitz 6764: display: table-row;
1.693 droeschl 6765: }
6766:
1.721 harmsja 6767: .LC_ListStyleClean,
6768: .LC_ListStyleSimple,
6769: .LC_ListStyleNormal,
1.795 www 6770: .LC_ListStyleSpecial {
1.911 bisitz 6771: /* display:block; */
6772: list-style-position: inside;
6773: list-style-type: none;
6774: overflow: hidden;
6775: padding: 0;
1.693 droeschl 6776: }
6777:
1.721 harmsja 6778: .LC_ListStyleSimple li,
6779: .LC_ListStyleSimple dd,
6780: .LC_ListStyleNormal li,
6781: .LC_ListStyleNormal dd,
6782: .LC_ListStyleSpecial li,
1.795 www 6783: .LC_ListStyleSpecial dd {
1.911 bisitz 6784: margin: 0;
6785: padding: 5px 5px 5px 10px;
6786: clear: both;
1.693 droeschl 6787: }
6788:
1.721 harmsja 6789: .LC_ListStyleClean li,
6790: .LC_ListStyleClean dd {
1.911 bisitz 6791: padding-top: 0;
6792: padding-bottom: 0;
1.693 droeschl 6793: }
6794:
1.721 harmsja 6795: .LC_ListStyleSimple dd,
1.795 www 6796: .LC_ListStyleSimple li {
1.911 bisitz 6797: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6798: }
6799:
1.721 harmsja 6800: .LC_ListStyleSpecial li,
6801: .LC_ListStyleSpecial dd {
1.911 bisitz 6802: list-style-type: none;
6803: background-color: RGB(220, 220, 220);
6804: margin-bottom: 4px;
1.693 droeschl 6805: }
6806:
1.721 harmsja 6807: table.LC_SimpleTable {
1.911 bisitz 6808: margin:5px;
6809: border:solid 1px $lg_border_color;
1.795 www 6810: }
1.693 droeschl 6811:
1.721 harmsja 6812: table.LC_SimpleTable tr {
1.911 bisitz 6813: padding: 0;
6814: border:solid 1px $lg_border_color;
1.693 droeschl 6815: }
1.795 www 6816:
6817: table.LC_SimpleTable thead {
1.911 bisitz 6818: background:rgb(220,220,220);
1.693 droeschl 6819: }
6820:
1.721 harmsja 6821: div.LC_columnSection {
1.911 bisitz 6822: display: block;
6823: clear: both;
6824: overflow: hidden;
6825: margin: 0;
1.693 droeschl 6826: }
6827:
1.721 harmsja 6828: div.LC_columnSection>* {
1.911 bisitz 6829: float: left;
6830: margin: 10px 20px 10px 0;
6831: overflow:hidden;
1.693 droeschl 6832: }
1.721 harmsja 6833:
1.795 www 6834: table em {
1.911 bisitz 6835: font-weight: bold;
6836: font-style: normal;
1.748 schulted 6837: }
1.795 www 6838:
1.779 bisitz 6839: table.LC_tableBrowseRes,
1.795 www 6840: table.LC_tableOfContent {
1.911 bisitz 6841: border:none;
6842: border-spacing: 1px;
6843: padding: 3px;
6844: background-color: #FFFFFF;
6845: font-size: 90%;
1.753 droeschl 6846: }
1.789 droeschl 6847:
1.911 bisitz 6848: table.LC_tableOfContent {
6849: border-collapse: collapse;
1.789 droeschl 6850: }
6851:
1.771 droeschl 6852: table.LC_tableBrowseRes a,
1.768 schulted 6853: table.LC_tableOfContent a {
1.911 bisitz 6854: background-color: transparent;
6855: text-decoration: none;
1.753 droeschl 6856: }
6857:
1.795 www 6858: table.LC_tableOfContent img {
1.911 bisitz 6859: border: none;
6860: height: 1.3em;
6861: vertical-align: text-bottom;
6862: margin-right: 0.3em;
1.753 droeschl 6863: }
1.757 schulted 6864:
1.795 www 6865: a#LC_content_toolbar_firsthomework {
1.911 bisitz 6866: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 6867: }
6868:
1.795 www 6869: a#LC_content_toolbar_everything {
1.911 bisitz 6870: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 6871: }
6872:
1.795 www 6873: a#LC_content_toolbar_uncompleted {
1.911 bisitz 6874: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 6875: }
6876:
1.795 www 6877: #LC_content_toolbar_clearbubbles {
1.911 bisitz 6878: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 6879: }
6880:
1.795 www 6881: a#LC_content_toolbar_changefolder {
1.911 bisitz 6882: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 6883: }
6884:
1.795 www 6885: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 6886: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 6887: }
6888:
1.1043 raeburn 6889: a#LC_content_toolbar_edittoplevel {
6890: background-image:url(/res/adm/pages/edittoplevel.gif);
6891: }
6892:
1.795 www 6893: ul#LC_toolbar li a:hover {
1.911 bisitz 6894: background-position: bottom center;
1.757 schulted 6895: }
6896:
1.795 www 6897: ul#LC_toolbar {
1.911 bisitz 6898: padding: 0;
6899: margin: 2px;
6900: list-style:none;
6901: position:relative;
6902: background-color:white;
1.757 schulted 6903: }
6904:
1.795 www 6905: ul#LC_toolbar li {
1.911 bisitz 6906: border:1px solid white;
6907: padding: 0;
6908: margin: 0;
6909: float: left;
6910: display:inline;
6911: vertical-align:middle;
6912: }
1.757 schulted 6913:
1.783 amueller 6914:
1.795 www 6915: a.LC_toolbarItem {
1.911 bisitz 6916: display:block;
6917: padding: 0;
6918: margin: 0;
6919: height: 32px;
6920: width: 32px;
6921: color:white;
6922: border: none;
6923: background-repeat:no-repeat;
6924: background-color:transparent;
1.757 schulted 6925: }
6926:
1.915 droeschl 6927: ul.LC_funclist {
6928: margin: 0;
6929: padding: 0.5em 1em 0.5em 0;
6930: }
6931:
1.933 droeschl 6932: ul.LC_funclist > li:first-child {
6933: font-weight:bold;
6934: margin-left:0.8em;
6935: }
6936:
1.915 droeschl 6937: ul.LC_funclist + ul.LC_funclist {
6938: /*
6939: left border as a seperator if we have more than
6940: one list
6941: */
6942: border-left: 1px solid $sidebg;
6943: /*
6944: this hides the left border behind the border of the
6945: outer box if element is wrapped to the next 'line'
6946: */
6947: margin-left: -1px;
6948: }
6949:
1.843 bisitz 6950: ul.LC_funclist li {
1.915 droeschl 6951: display: inline;
1.782 bisitz 6952: white-space: nowrap;
1.915 droeschl 6953: margin: 0 0 0 25px;
6954: line-height: 150%;
1.782 bisitz 6955: }
6956:
1.974 wenzelju 6957: .LC_hidden {
6958: display: none;
6959: }
6960:
1.1030 www 6961: .LCmodal-overlay {
6962: position:fixed;
6963: top:0;
6964: right:0;
6965: bottom:0;
6966: left:0;
6967: height:100%;
6968: width:100%;
6969: margin:0;
6970: padding:0;
6971: background:#999;
6972: opacity:.75;
6973: filter: alpha(opacity=75);
6974: -moz-opacity: 0.75;
6975: z-index:101;
6976: }
6977:
6978: * html .LCmodal-overlay {
6979: position: absolute;
6980: height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
6981: }
6982:
6983: .LCmodal-window {
6984: position:fixed;
6985: top:50%;
6986: left:50%;
6987: margin:0;
6988: padding:0;
6989: z-index:102;
6990: }
6991:
6992: * html .LCmodal-window {
6993: position:absolute;
6994: }
6995:
6996: .LCclose-window {
6997: position:absolute;
6998: width:32px;
6999: height:32px;
7000: right:8px;
7001: top:8px;
7002: background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
7003: text-indent:-99999px;
7004: overflow:hidden;
7005: cursor:pointer;
7006: }
7007:
1.343 albertel 7008: END
7009: }
7010:
1.306 albertel 7011: =pod
7012:
7013: =item * &headtag()
7014:
7015: Returns a uniform footer for LON-CAPA web pages.
7016:
1.307 albertel 7017: Inputs: $title - optional title for the head
7018: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 7019: $args - optional arguments
1.319 albertel 7020: force_register - if is true call registerurl so the remote is
7021: informed
1.415 albertel 7022: redirect -> array ref of
7023: 1- seconds before redirect occurs
7024: 2- url to redirect to
7025: 3- whether the side effect should occur
1.315 albertel 7026: (side effect of setting
7027: $env{'internal.head.redirect'} to the url
7028: redirected too)
1.352 albertel 7029: domain -> force to color decorate a page for a specific
7030: domain
7031: function -> force usage of a specific rolish color scheme
7032: bgcolor -> override the default page bgcolor
1.460 albertel 7033: no_auto_mt_title
7034: -> prevent &mt()ing the title arg
1.464 albertel 7035:
1.306 albertel 7036: =cut
7037:
7038: sub headtag {
1.313 albertel 7039: my ($title,$head_extra,$args) = @_;
1.306 albertel 7040:
1.363 albertel 7041: my $function = $args->{'function'} || &get_users_function();
7042: my $domain = $args->{'domain'} || &determinedomain();
7043: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 7044: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 7045: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 7046: #time(),
1.418 albertel 7047: $env{'environment.color.timestamp'},
1.363 albertel 7048: $function,$domain,$bgcolor);
7049:
1.369 www 7050: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 7051:
1.308 albertel 7052: my $result =
7053: '<head>'.
1.461 albertel 7054: &font_settings();
1.319 albertel 7055:
1.1064 raeburn 7056: my $inhibitprint = &print_suppression();
7057:
1.461 albertel 7058: if (!$args->{'frameset'}) {
7059: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
7060: }
1.962 droeschl 7061: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
7062: $result .= Apache::lonxml::display_title();
1.319 albertel 7063: }
1.436 albertel 7064: if (!$args->{'no_nav_bar'}
7065: && !$args->{'only_body'}
7066: && !$args->{'frameset'}) {
7067: $result .= &help_menu_js();
1.1032 www 7068: $result.=&modal_window();
1.1038 www 7069: $result.=&togglebox_script();
1.1034 www 7070: $result.=&wishlist_window();
1.1041 www 7071: $result.=&LCprogressbarUpdate_script();
1.1034 www 7072: } else {
7073: if ($args->{'add_modal'}) {
7074: $result.=&modal_window();
7075: }
7076: if ($args->{'add_wishlist'}) {
7077: $result.=&wishlist_window();
7078: }
1.1038 www 7079: if ($args->{'add_togglebox'}) {
7080: $result.=&togglebox_script();
7081: }
1.1041 www 7082: if ($args->{'add_progressbar'}) {
7083: $result.=&LCprogressbarUpdate_script();
7084: }
1.436 albertel 7085: }
1.314 albertel 7086: if (ref($args->{'redirect'})) {
1.414 albertel 7087: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 7088: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 7089: if (!$inhibit_continue) {
7090: $env{'internal.head.redirect'} = $url;
7091: }
1.313 albertel 7092: $result.=<<ADDMETA
7093: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 7094: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 7095: ADDMETA
7096: }
1.306 albertel 7097: if (!defined($title)) {
7098: $title = 'The LearningOnline Network with CAPA';
7099: }
1.460 albertel 7100: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
7101: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 7102: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
1.1064 raeburn 7103: .$inhibitprint
1.414 albertel 7104: .$head_extra;
1.962 droeschl 7105: return $result.'</head>';
1.306 albertel 7106: }
7107:
7108: =pod
7109:
1.340 albertel 7110: =item * &font_settings()
7111:
7112: Returns neccessary <meta> to set the proper encoding
7113:
7114: Inputs: none
7115:
7116: =cut
7117:
7118: sub font_settings {
7119: my $headerstring='';
1.647 www 7120: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 7121: $headerstring.=
7122: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
7123: }
7124: return $headerstring;
7125: }
7126:
1.341 albertel 7127: =pod
7128:
1.1064 raeburn 7129: =item * &print_suppression()
7130:
7131: In course context returns css which causes the body to be blank when media="print",
7132: if printout generation is unavailable for the current resource.
7133:
7134: This could be because:
7135:
7136: (a) printstartdate is in the future
7137:
7138: (b) printenddate is in the past
7139:
7140: (c) there is an active exam block with "printout"
7141: functionality blocked
7142:
7143: Users with pav, pfo or evb privileges are exempt.
7144:
7145: Inputs: none
7146:
7147: =cut
7148:
7149:
7150: sub print_suppression {
7151: my $noprint;
7152: if ($env{'request.course.id'}) {
7153: my $scope = $env{'request.course.id'};
7154: if ((&Apache::lonnet::allowed('pav',$scope)) ||
7155: (&Apache::lonnet::allowed('pfo',$scope))) {
7156: return;
7157: }
7158: if ($env{'request.course.sec'} ne '') {
7159: $scope .= "/$env{'request.course.sec'}";
7160: if ((&Apache::lonnet::allowed('pav',$scope)) ||
7161: (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065 raeburn 7162: return;
1.1064 raeburn 7163: }
7164: }
7165: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7166: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1065 raeburn 7167: my $blocked = &blocking_status('printout',$cnum,$cdom);
1.1064 raeburn 7168: if ($blocked) {
7169: my $checkrole = "cm./$cdom/$cnum";
7170: if ($env{'request.course.sec'} ne '') {
7171: $checkrole .= "/$env{'request.course.sec'}";
7172: }
7173: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
7174: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
7175: $noprint = 1;
7176: }
7177: }
7178: unless ($noprint) {
7179: my $symb = &Apache::lonnet::symbread();
7180: if ($symb ne '') {
7181: my $navmap = Apache::lonnavmaps::navmap->new();
7182: if (ref($navmap)) {
7183: my $res = $navmap->getBySymb($symb);
7184: if (ref($res)) {
7185: if (!$res->resprintable()) {
7186: $noprint = 1;
7187: }
7188: }
7189: }
7190: }
7191: }
7192: if ($noprint) {
7193: return <<"ENDSTYLE";
7194: <style type="text/css" media="print">
7195: body { display:none }
7196: </style>
7197: ENDSTYLE
7198: }
7199: }
7200: return;
7201: }
7202:
7203: =pod
7204:
1.341 albertel 7205: =item * &xml_begin()
7206:
7207: Returns the needed doctype and <html>
7208:
7209: Inputs: none
7210:
7211: =cut
7212:
7213: sub xml_begin {
7214: my $output='';
7215:
7216: if ($env{'browser.mathml'}) {
7217: $output='<?xml version="1.0"?>'
7218: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
7219: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
7220:
7221: # .'<!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">] >'
7222: .'<!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">'
7223: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
7224: .'xmlns="http://www.w3.org/1999/xhtml">';
7225: } else {
1.849 bisitz 7226: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
7227: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341 albertel 7228: }
7229: return $output;
7230: }
1.340 albertel 7231:
7232: =pod
7233:
1.306 albertel 7234: =item * &start_page()
7235:
7236: Returns a complete <html> .. <body> section for LON-CAPA web pages.
7237:
1.648 raeburn 7238: Inputs:
7239:
7240: =over 4
7241:
7242: $title - optional title for the page
7243:
7244: $head_extra - optional extra HTML to incude inside the <head>
7245:
7246: $args - additional optional args supported are:
7247:
7248: =over 8
7249:
7250: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 7251: arg on
1.814 bisitz 7252: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 7253: add_entries -> additional attributes to add to the <body>
7254: domain -> force to color decorate a page for a
1.317 albertel 7255: specific domain
1.648 raeburn 7256: function -> force usage of a specific rolish color
1.317 albertel 7257: scheme
1.648 raeburn 7258: redirect -> see &headtag()
7259: bgcolor -> override the default page bg color
7260: js_ready -> return a string ready for being used in
1.317 albertel 7261: a javascript writeln
1.648 raeburn 7262: html_encode -> return a string ready for being used in
1.320 albertel 7263: a html attribute
1.648 raeburn 7264: force_register -> if is true will turn on the &bodytag()
1.317 albertel 7265: $forcereg arg
1.648 raeburn 7266: frameset -> if true will start with a <frameset>
1.330 albertel 7267: rather than <body>
1.648 raeburn 7268: skip_phases -> hash ref of
1.338 albertel 7269: head -> skip the <html><head> generation
7270: body -> skip all <body> generation
1.648 raeburn 7271: no_auto_mt_title -> prevent &mt()ing the title arg
7272: inherit_jsmath -> when creating popup window in a page,
7273: should it have jsmath forced on by the
7274: current page
1.867 kalberla 7275: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 7276: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.361 albertel 7277:
1.648 raeburn 7278: =back
1.460 albertel 7279:
1.648 raeburn 7280: =back
1.562 albertel 7281:
1.306 albertel 7282: =cut
7283:
7284: sub start_page {
1.309 albertel 7285: my ($title,$head_extra,$args) = @_;
1.318 albertel 7286: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319 albertel 7287:
1.315 albertel 7288: $env{'internal.start_page'}++;
1.338 albertel 7289: my $result;
1.964 droeschl 7290:
1.338 albertel 7291: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1030 www 7292: $result .= &xml_begin() . &headtag($title, $head_extra, $args);
1.338 albertel 7293: }
7294:
7295: if (! exists($args->{'skip_phases'}{'body'}) ) {
7296: if ($args->{'frameset'}) {
7297: my $attr_string = &make_attr_string($args->{'force_register'},
7298: $args->{'add_entries'});
7299: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 7300: } else {
7301: $result .=
7302: &bodytag($title,
7303: $args->{'function'}, $args->{'add_entries'},
7304: $args->{'only_body'}, $args->{'domain'},
7305: $args->{'force_register'}, $args->{'no_nav_bar'},
1.962 droeschl 7306: $args->{'bgcolor'}, $args);
1.831 bisitz 7307: }
1.330 albertel 7308: }
1.338 albertel 7309:
1.315 albertel 7310: if ($args->{'js_ready'}) {
1.713 kaisler 7311: $result = &js_ready($result);
1.315 albertel 7312: }
1.320 albertel 7313: if ($args->{'html_encode'}) {
1.713 kaisler 7314: $result = &html_encode($result);
7315: }
7316:
1.813 bisitz 7317: # Preparation for new and consistent functionlist at top of screen
7318: # if ($args->{'functionlist'}) {
7319: # $result .= &build_functionlist();
7320: #}
7321:
1.964 droeschl 7322: # Don't add anything more if only_body wanted or in const space
7323: return $result if $args->{'only_body'}
7324: || $env{'request.state'} eq 'construct';
1.813 bisitz 7325:
7326: #Breadcrumbs
1.758 kaisler 7327: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
7328: &Apache::lonhtmlcommon::clear_breadcrumbs();
7329: #if any br links exists, add them to the breadcrumbs
7330: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
7331: foreach my $crumb (@{$args->{'bread_crumbs'}}){
7332: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
7333: }
7334: }
7335:
7336: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
7337: if(exists($args->{'bread_crumbs_component'})){
7338: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
7339: }else{
7340: $result .= &Apache::lonhtmlcommon::breadcrumbs();
7341: }
1.320 albertel 7342: }
1.315 albertel 7343: return $result;
1.306 albertel 7344: }
7345:
7346: sub end_page {
1.315 albertel 7347: my ($args) = @_;
7348: $env{'internal.end_page'}++;
1.330 albertel 7349: my $result;
1.335 albertel 7350: if ($args->{'discussion'}) {
7351: my ($target,$parser);
7352: if (ref($args->{'discussion'})) {
7353: ($target,$parser) =($args->{'discussion'}{'target'},
7354: $args->{'discussion'}{'parser'});
7355: }
7356: $result .= &Apache::lonxml::xmlend($target,$parser);
7357: }
1.330 albertel 7358: if ($args->{'frameset'}) {
7359: $result .= '</frameset>';
7360: } else {
1.635 raeburn 7361: $result .= &endbodytag($args);
1.330 albertel 7362: }
1.1080 raeburn 7363: unless ($args->{'notbody'}) {
7364: $result .= "\n</html>";
7365: }
1.330 albertel 7366:
1.315 albertel 7367: if ($args->{'js_ready'}) {
1.317 albertel 7368: $result = &js_ready($result);
1.315 albertel 7369: }
1.335 albertel 7370:
1.320 albertel 7371: if ($args->{'html_encode'}) {
7372: $result = &html_encode($result);
7373: }
1.335 albertel 7374:
1.315 albertel 7375: return $result;
7376: }
7377:
1.1034 www 7378: sub wishlist_window {
7379: return(<<'ENDWISHLIST');
1.1046 raeburn 7380: <script type="text/javascript">
1.1034 www 7381: // <![CDATA[
7382: // <!-- BEGIN LON-CAPA Internal
7383: function set_wishlistlink(title, path) {
7384: if (!title) {
7385: title = document.title;
7386: title = title.replace(/^LON-CAPA /,'');
7387: }
7388: if (!path) {
7389: path = location.pathname;
7390: }
7391: Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
7392: 'wishlistNewLink','width=560,height=350,scrollbars=0');
7393: }
7394: // END LON-CAPA Internal -->
7395: // ]]>
7396: </script>
7397: ENDWISHLIST
7398: }
7399:
1.1030 www 7400: sub modal_window {
7401: return(<<'ENDMODAL');
1.1046 raeburn 7402: <script type="text/javascript">
1.1030 www 7403: // <![CDATA[
7404: // <!-- BEGIN LON-CAPA Internal
7405: var modalWindow = {
7406: parent:"body",
7407: windowId:null,
7408: content:null,
7409: width:null,
7410: height:null,
7411: close:function()
7412: {
7413: $(".LCmodal-window").remove();
7414: $(".LCmodal-overlay").remove();
7415: },
7416: open:function()
7417: {
7418: var modal = "";
7419: modal += "<div class=\"LCmodal-overlay\"></div>";
7420: 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;\">";
7421: modal += this.content;
7422: modal += "</div>";
7423:
7424: $(this.parent).append(modal);
7425:
7426: $(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
7427: $(".LCclose-window").click(function(){modalWindow.close();});
7428: $(".LCmodal-overlay").click(function(){modalWindow.close();});
7429: }
7430: };
1.1031 www 7431: var openMyModal = function(source,width,height,scrolling)
1.1030 www 7432: {
7433: modalWindow.windowId = "myModal";
7434: modalWindow.width = width;
7435: modalWindow.height = height;
1.1031 www 7436: modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='true' src='" + source + "'></iframe>";
1.1030 www 7437: modalWindow.open();
7438: };
7439: // END LON-CAPA Internal -->
7440: // ]]>
7441: </script>
7442: ENDMODAL
7443: }
7444:
7445: sub modal_link {
1.1052 www 7446: my ($link,$linktext,$width,$height,$target,$scrolling,$title)=@_;
1.1030 www 7447: unless ($width) { $width=480; }
7448: unless ($height) { $height=400; }
1.1031 www 7449: unless ($scrolling) { $scrolling='yes'; }
1.1074 raeburn 7450: my $target_attr;
7451: if (defined($target)) {
7452: $target_attr = 'target="'.$target.'"';
7453: }
7454: return <<"ENDLINK";
7455: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling'); return false;">
7456: $linktext</a>
7457: ENDLINK
1.1030 www 7458: }
7459:
1.1032 www 7460: sub modal_adhoc_script {
7461: my ($funcname,$width,$height,$content)=@_;
7462: return (<<ENDADHOC);
1.1046 raeburn 7463: <script type="text/javascript">
1.1032 www 7464: // <![CDATA[
7465: var $funcname = function()
7466: {
7467: modalWindow.windowId = "myModal";
7468: modalWindow.width = $width;
7469: modalWindow.height = $height;
7470: modalWindow.content = '$content';
7471: modalWindow.open();
7472: };
7473: // ]]>
7474: </script>
7475: ENDADHOC
7476: }
7477:
1.1041 www 7478: sub modal_adhoc_inner {
7479: my ($funcname,$width,$height,$content)=@_;
7480: my $innerwidth=$width-20;
7481: $content=&js_ready(
1.1042 www 7482: &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
1.1041 www 7483: &start_scrollbox($width.'px',$innerwidth.'px',$height.'px').
7484: $content.
7485: &end_scrollbox().
7486: &end_page()
7487: );
7488: return &modal_adhoc_script($funcname,$width,$height,$content);
7489: }
7490:
7491: sub modal_adhoc_window {
7492: my ($funcname,$width,$height,$content,$linktext)=@_;
7493: return &modal_adhoc_inner($funcname,$width,$height,$content).
7494: "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
7495: }
7496:
7497: sub modal_adhoc_launch {
7498: my ($funcname,$width,$height,$content)=@_;
7499: return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
7500: <script type="text/javascript">
7501: // <![CDATA[
7502: $funcname();
7503: // ]]>
7504: </script>
7505: ENDLAUNCH
7506: }
7507:
7508: sub modal_adhoc_close {
7509: return (<<ENDCLOSE);
7510: <script type="text/javascript">
7511: // <![CDATA[
7512: modalWindow.close();
7513: // ]]>
7514: </script>
7515: ENDCLOSE
7516: }
7517:
1.1038 www 7518: sub togglebox_script {
7519: return(<<ENDTOGGLE);
7520: <script type="text/javascript">
7521: // <![CDATA[
7522: function LCtoggleDisplay(id,hidetext,showtext) {
7523: link = document.getElementById(id + "link").childNodes[0];
7524: with (document.getElementById(id).style) {
7525: if (display == "none" ) {
7526: display = "inline";
7527: link.nodeValue = hidetext;
7528: } else {
7529: display = "none";
7530: link.nodeValue = showtext;
7531: }
7532: }
7533: }
7534: // ]]>
7535: </script>
7536: ENDTOGGLE
7537: }
7538:
1.1039 www 7539: sub start_togglebox {
7540: my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
7541: unless ($heading) { $heading=''; } else { $heading.=' '; }
7542: unless ($showtext) { $showtext=&mt('show'); }
7543: unless ($hidetext) { $hidetext=&mt('hide'); }
7544: unless ($headerbg) { $headerbg='#FFFFFF'; }
7545: return &start_data_table().
7546: &start_data_table_header_row().
7547: '<td bgcolor="'.$headerbg.'">'.$heading.
7548: '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
7549: $showtext.'\')">'.$showtext.'</a>]</td>'.
7550: &end_data_table_header_row().
7551: '<tr id="'.$id.'" style="display:none""><td>';
7552: }
7553:
7554: sub end_togglebox {
7555: return '</td></tr>'.&end_data_table();
7556: }
7557:
1.1041 www 7558: sub LCprogressbar_script {
1.1045 www 7559: my ($id)=@_;
1.1041 www 7560: return(<<ENDPROGRESS);
7561: <script type="text/javascript">
7562: // <![CDATA[
1.1045 www 7563: \$('#progressbar$id').progressbar({
1.1041 www 7564: value: 0,
7565: change: function(event, ui) {
7566: var newVal = \$(this).progressbar('option', 'value');
7567: \$('.pblabel', this).text(LCprogressTxt);
7568: }
7569: });
7570: // ]]>
7571: </script>
7572: ENDPROGRESS
7573: }
7574:
7575: sub LCprogressbarUpdate_script {
7576: return(<<ENDPROGRESSUPDATE);
7577: <style type="text/css">
7578: .ui-progressbar { position:relative; }
7579: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
7580: </style>
7581: <script type="text/javascript">
7582: // <![CDATA[
1.1045 www 7583: var LCprogressTxt='---';
7584:
7585: function LCupdateProgress(percent,progresstext,id) {
1.1041 www 7586: LCprogressTxt=progresstext;
1.1045 www 7587: \$('#progressbar'+id).progressbar('value',percent);
1.1041 www 7588: }
7589: // ]]>
7590: </script>
7591: ENDPROGRESSUPDATE
7592: }
7593:
1.1042 www 7594: my $LClastpercent;
1.1045 www 7595: my $LCidcnt;
7596: my $LCcurrentid;
1.1042 www 7597:
1.1041 www 7598: sub LCprogressbar {
1.1042 www 7599: my ($r)=(@_);
7600: $LClastpercent=0;
1.1045 www 7601: $LCidcnt++;
7602: $LCcurrentid=$$.'_'.$LCidcnt;
1.1041 www 7603: my $starting=&mt('Starting');
7604: my $content=(<<ENDPROGBAR);
7605: <p>
1.1045 www 7606: <div id="progressbar$LCcurrentid">
1.1041 www 7607: <span class="pblabel">$starting</span>
7608: </div>
7609: </p>
7610: ENDPROGBAR
1.1045 www 7611: &r_print($r,$content.&LCprogressbar_script($LCcurrentid));
1.1041 www 7612: }
7613:
7614: sub LCprogressbarUpdate {
1.1042 www 7615: my ($r,$val,$text)=@_;
7616: unless ($val) {
7617: if ($LClastpercent) {
7618: $val=$LClastpercent;
7619: } else {
7620: $val=0;
7621: }
7622: }
1.1041 www 7623: if ($val<0) { $val=0; }
7624: if ($val>100) { $val=0; }
1.1042 www 7625: $LClastpercent=$val;
1.1041 www 7626: unless ($text) { $text=$val.'%'; }
7627: $text=&js_ready($text);
1.1044 www 7628: &r_print($r,<<ENDUPDATE);
1.1041 www 7629: <script type="text/javascript">
7630: // <![CDATA[
1.1045 www 7631: LCupdateProgress($val,'$text','$LCcurrentid');
1.1041 www 7632: // ]]>
7633: </script>
7634: ENDUPDATE
1.1035 www 7635: }
7636:
1.1042 www 7637: sub LCprogressbarClose {
7638: my ($r)=@_;
7639: $LClastpercent=0;
1.1044 www 7640: &r_print($r,<<ENDCLOSE);
1.1042 www 7641: <script type="text/javascript">
7642: // <![CDATA[
1.1045 www 7643: \$("#progressbar$LCcurrentid").hide('slow');
1.1042 www 7644: // ]]>
7645: </script>
7646: ENDCLOSE
1.1044 www 7647: }
7648:
7649: sub r_print {
7650: my ($r,$to_print)=@_;
7651: if ($r) {
7652: $r->print($to_print);
7653: $r->rflush();
7654: } else {
7655: print($to_print);
7656: }
1.1042 www 7657: }
7658:
1.320 albertel 7659: sub html_encode {
7660: my ($result) = @_;
7661:
1.322 albertel 7662: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 7663:
7664: return $result;
7665: }
1.1044 www 7666:
1.317 albertel 7667: sub js_ready {
7668: my ($result) = @_;
7669:
1.323 albertel 7670: $result =~ s/[\n\r]/ /xmsg;
7671: $result =~ s/\\/\\\\/xmsg;
7672: $result =~ s/'/\\'/xmsg;
1.372 albertel 7673: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 7674:
7675: return $result;
7676: }
7677:
1.315 albertel 7678: sub validate_page {
7679: if ( exists($env{'internal.start_page'})
1.316 albertel 7680: && $env{'internal.start_page'} > 1) {
7681: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 7682: $env{'internal.start_page'}.' '.
1.316 albertel 7683: $ENV{'request.filename'});
1.315 albertel 7684: }
7685: if ( exists($env{'internal.end_page'})
1.316 albertel 7686: && $env{'internal.end_page'} > 1) {
7687: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 7688: $env{'internal.end_page'}.' '.
1.316 albertel 7689: $env{'request.filename'});
1.315 albertel 7690: }
7691: if ( exists($env{'internal.start_page'})
7692: && ! exists($env{'internal.end_page'})) {
1.316 albertel 7693: &Apache::lonnet::logthis('start_page called without end_page '.
7694: $env{'request.filename'});
1.315 albertel 7695: }
7696: if ( ! exists($env{'internal.start_page'})
7697: && exists($env{'internal.end_page'})) {
1.316 albertel 7698: &Apache::lonnet::logthis('end_page called without start_page'.
7699: $env{'request.filename'});
1.315 albertel 7700: }
1.306 albertel 7701: }
1.315 albertel 7702:
1.996 www 7703:
7704: sub start_scrollbox {
1.1075 raeburn 7705: my ($outerwidth,$width,$height,$id,$bgcolor)=@_;
1.998 raeburn 7706: unless ($outerwidth) { $outerwidth='520px'; }
7707: unless ($width) { $width='500px'; }
7708: unless ($height) { $height='200px'; }
1.1075 raeburn 7709: my ($table_id,$div_id,$tdcol);
1.1018 raeburn 7710: if ($id ne '') {
1.1020 raeburn 7711: $table_id = " id='table_$id'";
7712: $div_id = " id='div_$id'";
1.1018 raeburn 7713: }
1.1075 raeburn 7714: if ($bgcolor ne '') {
7715: $tdcol = "background-color: $bgcolor;";
7716: }
7717: return <<"END";
7718: <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>
7719: END
1.996 www 7720: }
7721:
7722: sub end_scrollbox {
1.1036 www 7723: return '</div></td></tr></table>';
1.996 www 7724: }
7725:
1.318 albertel 7726: sub simple_error_page {
7727: my ($r,$title,$msg) = @_;
7728: my $page =
7729: &Apache::loncommon::start_page($title).
7730: &mt($msg).
7731: &Apache::loncommon::end_page();
7732: if (ref($r)) {
7733: $r->print($page);
1.327 albertel 7734: return;
1.318 albertel 7735: }
7736: return $page;
7737: }
1.347 albertel 7738:
7739: {
1.610 albertel 7740: my @row_count;
1.961 onken 7741:
7742: sub start_data_table_count {
7743: unshift(@row_count, 0);
7744: return;
7745: }
7746:
7747: sub end_data_table_count {
7748: shift(@row_count);
7749: return;
7750: }
7751:
1.347 albertel 7752: sub start_data_table {
1.1018 raeburn 7753: my ($add_class,$id) = @_;
1.422 albertel 7754: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 7755: my $table_id;
7756: if (defined($id)) {
7757: $table_id = ' id="'.$id.'"';
7758: }
1.961 onken 7759: &start_data_table_count();
1.1018 raeburn 7760: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 7761: }
7762:
7763: sub end_data_table {
1.961 onken 7764: &end_data_table_count();
1.389 albertel 7765: return '</table>'."\n";;
1.347 albertel 7766: }
7767:
7768: sub start_data_table_row {
1.974 wenzelju 7769: my ($add_class, $id) = @_;
1.610 albertel 7770: $row_count[0]++;
7771: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 7772: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 7773: $id = (' id="'.$id.'"') unless ($id eq '');
7774: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 7775: }
1.471 banghart 7776:
7777: sub continue_data_table_row {
1.974 wenzelju 7778: my ($add_class, $id) = @_;
1.610 albertel 7779: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 7780: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
7781: $id = (' id="'.$id.'"') unless ($id eq '');
7782: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 7783: }
1.347 albertel 7784:
7785: sub end_data_table_row {
1.389 albertel 7786: return '</tr>'."\n";;
1.347 albertel 7787: }
1.367 www 7788:
1.421 albertel 7789: sub start_data_table_empty_row {
1.707 bisitz 7790: # $row_count[0]++;
1.421 albertel 7791: return '<tr class="LC_empty_row" >'."\n";;
7792: }
7793:
7794: sub end_data_table_empty_row {
7795: return '</tr>'."\n";;
7796: }
7797:
1.367 www 7798: sub start_data_table_header_row {
1.389 albertel 7799: return '<tr class="LC_header_row">'."\n";;
1.367 www 7800: }
7801:
7802: sub end_data_table_header_row {
1.389 albertel 7803: return '</tr>'."\n";;
1.367 www 7804: }
1.890 droeschl 7805:
7806: sub data_table_caption {
7807: my $caption = shift;
7808: return "<caption class=\"LC_caption\">$caption</caption>";
7809: }
1.347 albertel 7810: }
7811:
1.548 albertel 7812: =pod
7813:
7814: =item * &inhibit_menu_check($arg)
7815:
7816: Checks for a inhibitmenu state and generates output to preserve it
7817:
7818: Inputs: $arg - can be any of
7819: - undef - in which case the return value is a string
7820: to add into arguments list of a uri
7821: - 'input' - in which case the return value is a HTML
7822: <form> <input> field of type hidden to
7823: preserve the value
7824: - a url - in which case the return value is the url with
7825: the neccesary cgi args added to preserve the
7826: inhibitmenu state
7827: - a ref to a url - no return value, but the string is
7828: updated to include the neccessary cgi
7829: args to preserve the inhibitmenu state
7830:
7831: =cut
7832:
7833: sub inhibit_menu_check {
7834: my ($arg) = @_;
7835: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
7836: if ($arg eq 'input') {
7837: if ($env{'form.inhibitmenu'}) {
7838: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
7839: } else {
7840: return
7841: }
7842: }
7843: if ($env{'form.inhibitmenu'}) {
7844: if (ref($arg)) {
7845: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7846: } elsif ($arg eq '') {
7847: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
7848: } else {
7849: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7850: }
7851: }
7852: if (!ref($arg)) {
7853: return $arg;
7854: }
7855: }
7856:
1.251 albertel 7857: ###############################################
1.182 matthew 7858:
7859: =pod
7860:
1.549 albertel 7861: =back
7862:
7863: =head1 User Information Routines
7864:
7865: =over 4
7866:
1.405 albertel 7867: =item * &get_users_function()
1.182 matthew 7868:
7869: Used by &bodytag to determine the current users primary role.
7870: Returns either 'student','coordinator','admin', or 'author'.
7871:
7872: =cut
7873:
7874: ###############################################
7875: sub get_users_function {
1.815 tempelho 7876: my $function = 'norole';
1.818 tempelho 7877: if ($env{'request.role'}=~/^(st)/) {
7878: $function='student';
7879: }
1.907 raeburn 7880: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 7881: $function='coordinator';
7882: }
1.258 albertel 7883: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 7884: $function='admin';
7885: }
1.826 bisitz 7886: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025 raeburn 7887: ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182 matthew 7888: $function='author';
7889: }
7890: return $function;
1.54 www 7891: }
1.99 www 7892:
7893: ###############################################
7894:
1.233 raeburn 7895: =pod
7896:
1.821 raeburn 7897: =item * &show_course()
7898:
7899: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
7900: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
7901:
7902: Inputs:
7903: None
7904:
7905: Outputs:
7906: Scalar: 1 if 'Course' to be used, 0 otherwise.
7907:
7908: =cut
7909:
7910: ###############################################
7911: sub show_course {
7912: my $course = !$env{'user.adv'};
7913: if (!$env{'user.adv'}) {
7914: foreach my $env (keys(%env)) {
7915: next if ($env !~ m/^user\.priv\./);
7916: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
7917: $course = 0;
7918: last;
7919: }
7920: }
7921: }
7922: return $course;
7923: }
7924:
7925: ###############################################
7926:
7927: =pod
7928:
1.542 raeburn 7929: =item * &check_user_status()
1.274 raeburn 7930:
7931: Determines current status of supplied role for a
7932: specific user. Roles can be active, previous or future.
7933:
7934: Inputs:
7935: user's domain, user's username, course's domain,
1.375 raeburn 7936: course's number, optional section ID.
1.274 raeburn 7937:
7938: Outputs:
7939: role status: active, previous or future.
7940:
7941: =cut
7942:
7943: sub check_user_status {
1.412 raeburn 7944: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073 raeburn 7945: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.274 raeburn 7946: my @uroles = keys %userinfo;
7947: my $srchstr;
7948: my $active_chk = 'none';
1.412 raeburn 7949: my $now = time;
1.274 raeburn 7950: if (@uroles > 0) {
1.908 raeburn 7951: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 7952: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
7953: } else {
1.412 raeburn 7954: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
7955: }
7956: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 7957: my $role_end = 0;
7958: my $role_start = 0;
7959: $active_chk = 'active';
1.412 raeburn 7960: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
7961: $role_end = $1;
7962: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
7963: $role_start = $1;
1.274 raeburn 7964: }
7965: }
7966: if ($role_start > 0) {
1.412 raeburn 7967: if ($now < $role_start) {
1.274 raeburn 7968: $active_chk = 'future';
7969: }
7970: }
7971: if ($role_end > 0) {
1.412 raeburn 7972: if ($now > $role_end) {
1.274 raeburn 7973: $active_chk = 'previous';
7974: }
7975: }
7976: }
7977: }
7978: return $active_chk;
7979: }
7980:
7981: ###############################################
7982:
7983: =pod
7984:
1.405 albertel 7985: =item * &get_sections()
1.233 raeburn 7986:
7987: Determines all the sections for a course including
7988: sections with students and sections containing other roles.
1.419 raeburn 7989: Incoming parameters:
7990:
7991: 1. domain
7992: 2. course number
7993: 3. reference to array containing roles for which sections should
7994: be gathered (optional).
7995: 4. reference to array containing status types for which sections
7996: should be gathered (optional).
7997:
7998: If the third argument is undefined, sections are gathered for any role.
7999: If the fourth argument is undefined, sections are gathered for any status.
8000: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 8001:
1.374 raeburn 8002: Returns section hash (keys are section IDs, values are
8003: number of users in each section), subject to the
1.419 raeburn 8004: optional roles filter, optional status filter
1.233 raeburn 8005:
8006: =cut
8007:
8008: ###############################################
8009: sub get_sections {
1.419 raeburn 8010: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 8011: if (!defined($cdom) || !defined($cnum)) {
8012: my $cid = $env{'request.course.id'};
8013:
8014: return if (!defined($cid));
8015:
8016: $cdom = $env{'course.'.$cid.'.domain'};
8017: $cnum = $env{'course.'.$cid.'.num'};
8018: }
8019:
8020: my %sectioncount;
1.419 raeburn 8021: my $now = time;
1.240 albertel 8022:
1.366 albertel 8023: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 8024: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 8025: my $sec_index = &Apache::loncoursedata::CL_SECTION();
8026: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 8027: my $start_index = &Apache::loncoursedata::CL_START();
8028: my $end_index = &Apache::loncoursedata::CL_END();
8029: my $status;
1.366 albertel 8030: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 8031: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
8032: $data->[$status_index],
8033: $data->[$start_index],
8034: $data->[$end_index]);
8035: if ($stu_status eq 'Active') {
8036: $status = 'active';
8037: } elsif ($end < $now) {
8038: $status = 'previous';
8039: } elsif ($start > $now) {
8040: $status = 'future';
8041: }
8042: if ($section ne '-1' && $section !~ /^\s*$/) {
8043: if ((!defined($possible_status)) || (($status ne '') &&
8044: (grep/^\Q$status\E$/,@{$possible_status}))) {
8045: $sectioncount{$section}++;
8046: }
1.240 albertel 8047: }
8048: }
8049: }
8050: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8051: foreach my $user (sort(keys(%courseroles))) {
8052: if ($user !~ /^(\w{2})/) { next; }
8053: my ($role) = ($user =~ /^(\w{2})/);
8054: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 8055: my ($section,$status);
1.240 albertel 8056: if ($role eq 'cr' &&
8057: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
8058: $section=$1;
8059: }
8060: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
8061: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 8062: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
8063: if ($end == -1 && $start == -1) {
8064: next; #deleted role
8065: }
8066: if (!defined($possible_status)) {
8067: $sectioncount{$section}++;
8068: } else {
8069: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
8070: $status = 'active';
8071: } elsif ($end < $now) {
8072: $status = 'future';
8073: } elsif ($start > $now) {
8074: $status = 'previous';
8075: }
8076: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
8077: $sectioncount{$section}++;
8078: }
8079: }
1.233 raeburn 8080: }
1.366 albertel 8081: return %sectioncount;
1.233 raeburn 8082: }
8083:
1.274 raeburn 8084: ###############################################
1.294 raeburn 8085:
8086: =pod
1.405 albertel 8087:
8088: =item * &get_course_users()
8089:
1.275 raeburn 8090: Retrieves usernames:domains for users in the specified course
8091: with specific role(s), and access status.
8092:
8093: Incoming parameters:
1.277 albertel 8094: 1. course domain
8095: 2. course number
8096: 3. access status: users must have - either active,
1.275 raeburn 8097: previous, future, or all.
1.277 albertel 8098: 4. reference to array of permissible roles
1.288 raeburn 8099: 5. reference to array of section restrictions (optional)
8100: 6. reference to results object (hash of hashes).
8101: 7. reference to optional userdata hash
1.609 raeburn 8102: 8. reference to optional statushash
1.630 raeburn 8103: 9. flag if privileged users (except those set to unhide in
8104: course settings) should be excluded
1.609 raeburn 8105: Keys of top level results hash are roles.
1.275 raeburn 8106: Keys of inner hashes are username:domain, with
8107: values set to access type.
1.288 raeburn 8108: Optional userdata hash returns an array with arguments in the
8109: same order as loncoursedata::get_classlist() for student data.
8110:
1.609 raeburn 8111: Optional statushash returns
8112:
1.288 raeburn 8113: Entries for end, start, section and status are blank because
8114: of the possibility of multiple values for non-student roles.
8115:
1.275 raeburn 8116: =cut
1.405 albertel 8117:
1.275 raeburn 8118: ###############################################
1.405 albertel 8119:
1.275 raeburn 8120: sub get_course_users {
1.630 raeburn 8121: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 8122: my %idx = ();
1.419 raeburn 8123: my %seclists;
1.288 raeburn 8124:
8125: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
8126: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
8127: $idx{end} = &Apache::loncoursedata::CL_END();
8128: $idx{start} = &Apache::loncoursedata::CL_START();
8129: $idx{id} = &Apache::loncoursedata::CL_ID();
8130: $idx{section} = &Apache::loncoursedata::CL_SECTION();
8131: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
8132: $idx{status} = &Apache::loncoursedata::CL_STATUS();
8133:
1.290 albertel 8134: if (grep(/^st$/,@{$roles})) {
1.276 albertel 8135: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 8136: my $now = time;
1.277 albertel 8137: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 8138: my $match = 0;
1.412 raeburn 8139: my $secmatch = 0;
1.419 raeburn 8140: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 8141: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 8142: if ($section eq '') {
8143: $section = 'none';
8144: }
1.291 albertel 8145: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 8146: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 8147: $secmatch = 1;
8148: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 8149: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 8150: $secmatch = 1;
8151: }
8152: } else {
1.419 raeburn 8153: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 8154: $secmatch = 1;
8155: }
1.290 albertel 8156: }
1.412 raeburn 8157: if (!$secmatch) {
8158: next;
8159: }
1.419 raeburn 8160: }
1.275 raeburn 8161: if (defined($$types{'active'})) {
1.288 raeburn 8162: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 8163: push(@{$$users{st}{$student}},'active');
1.288 raeburn 8164: $match = 1;
1.275 raeburn 8165: }
8166: }
8167: if (defined($$types{'previous'})) {
1.609 raeburn 8168: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 8169: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 8170: $match = 1;
1.275 raeburn 8171: }
8172: }
8173: if (defined($$types{'future'})) {
1.609 raeburn 8174: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 8175: push(@{$$users{st}{$student}},'future');
1.288 raeburn 8176: $match = 1;
1.275 raeburn 8177: }
8178: }
1.609 raeburn 8179: if ($match) {
8180: push(@{$seclists{$student}},$section);
8181: if (ref($userdata) eq 'HASH') {
8182: $$userdata{$student} = $$classlist{$student};
8183: }
8184: if (ref($statushash) eq 'HASH') {
8185: $statushash->{$student}{'st'}{$section} = $status;
8186: }
1.288 raeburn 8187: }
1.275 raeburn 8188: }
8189: }
1.412 raeburn 8190: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 8191: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8192: my $now = time;
1.609 raeburn 8193: my %displaystatus = ( previous => 'Expired',
8194: active => 'Active',
8195: future => 'Future',
8196: );
1.630 raeburn 8197: my %nothide;
8198: if ($hidepriv) {
8199: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
8200: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
8201: if ($user !~ /:/) {
8202: $nothide{join(':',split(/[\@]/,$user))}=1;
8203: } else {
8204: $nothide{$user} = 1;
8205: }
8206: }
8207: }
1.439 raeburn 8208: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 8209: my $match = 0;
1.412 raeburn 8210: my $secmatch = 0;
1.439 raeburn 8211: my $status;
1.412 raeburn 8212: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 8213: $user =~ s/:$//;
1.439 raeburn 8214: my ($end,$start) = split(/:/,$coursepersonnel{$person});
8215: if ($end == -1 || $start == -1) {
8216: next;
8217: }
8218: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
8219: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 8220: my ($uname,$udom) = split(/:/,$user);
8221: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 8222: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 8223: $secmatch = 1;
8224: } elsif ($usec eq '') {
1.420 albertel 8225: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 8226: $secmatch = 1;
8227: }
8228: } else {
8229: if (grep(/^\Q$usec\E$/,@{$sections})) {
8230: $secmatch = 1;
8231: }
8232: }
8233: if (!$secmatch) {
8234: next;
8235: }
1.288 raeburn 8236: }
1.419 raeburn 8237: if ($usec eq '') {
8238: $usec = 'none';
8239: }
1.275 raeburn 8240: if ($uname ne '' && $udom ne '') {
1.630 raeburn 8241: if ($hidepriv) {
8242: if ((&Apache::lonnet::privileged($uname,$udom)) &&
8243: (!$nothide{$uname.':'.$udom})) {
8244: next;
8245: }
8246: }
1.503 raeburn 8247: if ($end > 0 && $end < $now) {
1.439 raeburn 8248: $status = 'previous';
8249: } elsif ($start > $now) {
8250: $status = 'future';
8251: } else {
8252: $status = 'active';
8253: }
1.277 albertel 8254: foreach my $type (keys(%{$types})) {
1.275 raeburn 8255: if ($status eq $type) {
1.420 albertel 8256: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 8257: push(@{$$users{$role}{$user}},$type);
8258: }
1.288 raeburn 8259: $match = 1;
8260: }
8261: }
1.419 raeburn 8262: if (($match) && (ref($userdata) eq 'HASH')) {
8263: if (!exists($$userdata{$uname.':'.$udom})) {
8264: &get_user_info($udom,$uname,\%idx,$userdata);
8265: }
1.420 albertel 8266: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 8267: push(@{$seclists{$uname.':'.$udom}},$usec);
8268: }
1.609 raeburn 8269: if (ref($statushash) eq 'HASH') {
8270: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
8271: }
1.275 raeburn 8272: }
8273: }
8274: }
8275: }
1.290 albertel 8276: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 8277: if ((defined($cdom)) && (defined($cnum))) {
8278: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
8279: if ( defined($csettings{'internal.courseowner'}) ) {
8280: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 8281: next if ($owner eq '');
8282: my ($ownername,$ownerdom);
8283: if ($owner =~ /^([^:]+):([^:]+)$/) {
8284: $ownername = $1;
8285: $ownerdom = $2;
8286: } else {
8287: $ownername = $owner;
8288: $ownerdom = $cdom;
8289: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 8290: }
8291: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 8292: if (defined($userdata) &&
1.609 raeburn 8293: !exists($$userdata{$owner})) {
8294: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
8295: if (!grep(/^none$/,@{$seclists{$owner}})) {
8296: push(@{$seclists{$owner}},'none');
8297: }
8298: if (ref($statushash) eq 'HASH') {
8299: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 8300: }
1.290 albertel 8301: }
1.279 raeburn 8302: }
8303: }
8304: }
1.419 raeburn 8305: foreach my $user (keys(%seclists)) {
8306: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
8307: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
8308: }
1.275 raeburn 8309: }
8310: return;
8311: }
8312:
1.288 raeburn 8313: sub get_user_info {
8314: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 8315: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
8316: &plainname($uname,$udom,'lastname');
1.291 albertel 8317: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 8318: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 8319: my %idhash = &Apache::lonnet::idrget($udom,($uname));
8320: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 8321: return;
8322: }
1.275 raeburn 8323:
1.472 raeburn 8324: ###############################################
8325:
8326: =pod
8327:
8328: =item * &get_user_quota()
8329:
8330: Retrieves quota assigned for storage of portfolio files for a user
8331:
8332: Incoming parameters:
8333: 1. user's username
8334: 2. user's domain
8335:
8336: Returns:
1.536 raeburn 8337: 1. Disk quota (in Mb) assigned to student.
8338: 2. (Optional) Type of setting: custom or default
8339: (individually assigned or default for user's
8340: institutional status).
8341: 3. (Optional) - User's institutional status (e.g., faculty, staff
8342: or student - types as defined in localenroll::inst_usertypes
8343: for user's domain, which determines default quota for user.
8344: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 8345:
8346: If a value has been stored in the user's environment,
1.536 raeburn 8347: it will return that, otherwise it returns the maximal default
8348: defined for the user's instituional status(es) in the domain.
1.472 raeburn 8349:
8350: =cut
8351:
8352: ###############################################
8353:
8354:
8355: sub get_user_quota {
8356: my ($uname,$udom) = @_;
1.536 raeburn 8357: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 8358: if (!defined($udom)) {
8359: $udom = $env{'user.domain'};
8360: }
8361: if (!defined($uname)) {
8362: $uname = $env{'user.name'};
8363: }
8364: if (($udom eq '' || $uname eq '') ||
8365: ($udom eq 'public') && ($uname eq 'public')) {
8366: $quota = 0;
1.536 raeburn 8367: $quotatype = 'default';
8368: $defquota = 0;
1.472 raeburn 8369: } else {
1.536 raeburn 8370: my $inststatus;
1.472 raeburn 8371: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
8372: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 8373: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 8374: } else {
1.536 raeburn 8375: my %userenv =
8376: &Apache::lonnet::get('environment',['portfolioquota',
8377: 'inststatus'],$udom,$uname);
1.472 raeburn 8378: my ($tmp) = keys(%userenv);
8379: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
8380: $quota = $userenv{'portfolioquota'};
1.536 raeburn 8381: $inststatus = $userenv{'inststatus'};
1.472 raeburn 8382: } else {
8383: undef(%userenv);
8384: }
8385: }
1.536 raeburn 8386: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 8387: if ($quota eq '') {
1.536 raeburn 8388: $quota = $defquota;
8389: $quotatype = 'default';
8390: } else {
8391: $quotatype = 'custom';
1.472 raeburn 8392: }
8393: }
1.536 raeburn 8394: if (wantarray) {
8395: return ($quota,$quotatype,$settingstatus,$defquota);
8396: } else {
8397: return $quota;
8398: }
1.472 raeburn 8399: }
8400:
8401: ###############################################
8402:
8403: =pod
8404:
8405: =item * &default_quota()
8406:
1.536 raeburn 8407: Retrieves default quota assigned for storage of user portfolio files,
8408: given an (optional) user's institutional status.
1.472 raeburn 8409:
8410: Incoming parameters:
8411: 1. domain
1.536 raeburn 8412: 2. (Optional) institutional status(es). This is a : separated list of
8413: status types (e.g., faculty, staff, student etc.)
8414: which apply to the user for whom the default is being retrieved.
8415: If the institutional status string in undefined, the domain
8416: default quota will be returned.
1.472 raeburn 8417:
8418: Returns:
8419: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 8420: 2. (Optional) institutional type which determined the value of the
8421: default quota.
1.472 raeburn 8422:
8423: If a value has been stored in the domain's configuration db,
8424: it will return that, otherwise it returns 20 (for backwards
8425: compatibility with domains which have not set up a configuration
8426: db file; the original statically defined portfolio quota was 20 Mb).
8427:
1.536 raeburn 8428: If the user's status includes multiple types (e.g., staff and student),
8429: the largest default quota which applies to the user determines the
8430: default quota returned.
8431:
1.780 raeburn 8432: =back
8433:
1.472 raeburn 8434: =cut
8435:
8436: ###############################################
8437:
8438:
8439: sub default_quota {
1.536 raeburn 8440: my ($udom,$inststatus) = @_;
8441: my ($defquota,$settingstatus);
8442: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 8443: ['quotas'],$udom);
8444: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 8445: if ($inststatus ne '') {
1.765 raeburn 8446: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 8447: foreach my $item (@statuses) {
1.711 raeburn 8448: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
8449: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
8450: if ($defquota eq '') {
8451: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
8452: $settingstatus = $item;
8453: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
8454: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
8455: $settingstatus = $item;
8456: }
8457: }
8458: } else {
8459: if ($quotahash{'quotas'}{$item} ne '') {
8460: if ($defquota eq '') {
8461: $defquota = $quotahash{'quotas'}{$item};
8462: $settingstatus = $item;
8463: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
8464: $defquota = $quotahash{'quotas'}{$item};
8465: $settingstatus = $item;
8466: }
1.536 raeburn 8467: }
8468: }
8469: }
8470: }
8471: if ($defquota eq '') {
1.711 raeburn 8472: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
8473: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
8474: } else {
8475: $defquota = $quotahash{'quotas'}{'default'};
8476: }
1.536 raeburn 8477: $settingstatus = 'default';
8478: }
8479: } else {
8480: $settingstatus = 'default';
8481: $defquota = 20;
8482: }
8483: if (wantarray) {
8484: return ($defquota,$settingstatus);
1.472 raeburn 8485: } else {
1.536 raeburn 8486: return $defquota;
1.472 raeburn 8487: }
8488: }
8489:
1.384 raeburn 8490: sub get_secgrprole_info {
8491: my ($cdom,$cnum,$needroles,$type) = @_;
8492: my %sections_count = &get_sections($cdom,$cnum);
8493: my @sections = (sort {$a <=> $b} keys(%sections_count));
8494: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
8495: my @groups = sort(keys(%curr_groups));
8496: my $allroles = [];
8497: my $rolehash;
8498: my $accesshash = {
8499: active => 'Currently has access',
8500: future => 'Will have future access',
8501: previous => 'Previously had access',
8502: };
8503: if ($needroles) {
8504: $rolehash = {'all' => 'all'};
1.385 albertel 8505: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8506: if (&Apache::lonnet::error(%user_roles)) {
8507: undef(%user_roles);
8508: }
8509: foreach my $item (keys(%user_roles)) {
1.384 raeburn 8510: my ($role)=split(/\:/,$item,2);
8511: if ($role eq 'cr') { next; }
8512: if ($role =~ /^cr/) {
8513: $$rolehash{$role} = (split('/',$role))[3];
8514: } else {
8515: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
8516: }
8517: }
8518: foreach my $key (sort(keys(%{$rolehash}))) {
8519: push(@{$allroles},$key);
8520: }
8521: push (@{$allroles},'st');
8522: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
8523: }
8524: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
8525: }
8526:
1.555 raeburn 8527: sub user_picker {
1.994 raeburn 8528: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context) = @_;
1.555 raeburn 8529: my $currdom = $dom;
8530: my %curr_selected = (
8531: srchin => 'dom',
1.580 raeburn 8532: srchby => 'lastname',
1.555 raeburn 8533: );
8534: my $srchterm;
1.625 raeburn 8535: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 8536: if ($srch->{'srchby'} ne '') {
8537: $curr_selected{'srchby'} = $srch->{'srchby'};
8538: }
8539: if ($srch->{'srchin'} ne '') {
8540: $curr_selected{'srchin'} = $srch->{'srchin'};
8541: }
8542: if ($srch->{'srchtype'} ne '') {
8543: $curr_selected{'srchtype'} = $srch->{'srchtype'};
8544: }
8545: if ($srch->{'srchdomain'} ne '') {
8546: $currdom = $srch->{'srchdomain'};
8547: }
8548: $srchterm = $srch->{'srchterm'};
8549: }
8550: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 8551: 'usr' => 'Search criteria',
1.563 raeburn 8552: 'doma' => 'Domain/institution to search',
1.558 albertel 8553: 'uname' => 'username',
8554: 'lastname' => 'last name',
1.555 raeburn 8555: 'lastfirst' => 'last name, first name',
1.558 albertel 8556: 'crs' => 'in this course',
1.576 raeburn 8557: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 8558: 'alc' => 'all LON-CAPA',
1.573 raeburn 8559: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 8560: 'exact' => 'is',
8561: 'contains' => 'contains',
1.569 raeburn 8562: 'begins' => 'begins with',
1.571 raeburn 8563: 'youm' => "You must include some text to search for.",
8564: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
8565: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
8566: 'yomc' => "You must choose a domain when using an institutional directory search.",
8567: 'ymcd' => "You must choose a domain when using a domain search.",
8568: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
8569: 'whse' => "When searching by last,first you must include at least one character in the first name.",
8570: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 8571: );
1.563 raeburn 8572: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
8573: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 8574:
8575: my @srchins = ('crs','dom','alc','instd');
8576:
8577: foreach my $option (@srchins) {
8578: # FIXME 'alc' option unavailable until
8579: # loncreateuser::print_user_query_page()
8580: # has been completed.
8581: next if ($option eq 'alc');
1.880 raeburn 8582: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 8583: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 8584: if ($curr_selected{'srchin'} eq $option) {
8585: $srchinsel .= '
8586: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
8587: } else {
8588: $srchinsel .= '
8589: <option value="'.$option.'">'.$lt{$option}.'</option>';
8590: }
1.555 raeburn 8591: }
1.563 raeburn 8592: $srchinsel .= "\n </select>\n";
1.555 raeburn 8593:
8594: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 8595: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 8596: if ($curr_selected{'srchby'} eq $option) {
8597: $srchbysel .= '
8598: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
8599: } else {
8600: $srchbysel .= '
8601: <option value="'.$option.'">'.$lt{$option}.'</option>';
8602: }
8603: }
8604: $srchbysel .= "\n </select>\n";
8605:
8606: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 8607: foreach my $option ('begins','contains','exact') {
1.555 raeburn 8608: if ($curr_selected{'srchtype'} eq $option) {
8609: $srchtypesel .= '
8610: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
8611: } else {
8612: $srchtypesel .= '
8613: <option value="'.$option.'">'.$lt{$option}.'</option>';
8614: }
8615: }
8616: $srchtypesel .= "\n </select>\n";
8617:
1.558 albertel 8618: my ($newuserscript,$new_user_create);
1.994 raeburn 8619: my $context_dom = $env{'request.role.domain'};
8620: if ($context eq 'requestcrs') {
8621: if ($env{'form.coursedom'} ne '') {
8622: $context_dom = $env{'form.coursedom'};
8623: }
8624: }
1.556 raeburn 8625: if ($forcenewuser) {
1.576 raeburn 8626: if (ref($srch) eq 'HASH') {
1.994 raeburn 8627: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 8628: if ($cancreate) {
8629: $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>';
8630: } else {
1.799 bisitz 8631: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 8632: my %usertypetext = (
8633: official => 'institutional',
8634: unofficial => 'non-institutional',
8635: );
1.799 bisitz 8636: $new_user_create = '<p class="LC_warning">'
8637: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
8638: .' '
8639: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
8640: ,'<a href="'.$helplink.'">','</a>')
8641: .'</p><br />';
1.627 raeburn 8642: }
1.576 raeburn 8643: }
8644: }
8645:
1.556 raeburn 8646: $newuserscript = <<"ENDSCRIPT";
8647:
1.570 raeburn 8648: function setSearch(createnew,callingForm) {
1.556 raeburn 8649: if (createnew == 1) {
1.570 raeburn 8650: for (var i=0; i<callingForm.srchby.length; i++) {
8651: if (callingForm.srchby.options[i].value == 'uname') {
8652: callingForm.srchby.selectedIndex = i;
1.556 raeburn 8653: }
8654: }
1.570 raeburn 8655: for (var i=0; i<callingForm.srchin.length; i++) {
8656: if ( callingForm.srchin.options[i].value == 'dom') {
8657: callingForm.srchin.selectedIndex = i;
1.556 raeburn 8658: }
8659: }
1.570 raeburn 8660: for (var i=0; i<callingForm.srchtype.length; i++) {
8661: if (callingForm.srchtype.options[i].value == 'exact') {
8662: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 8663: }
8664: }
1.570 raeburn 8665: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 8666: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 8667: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 8668: }
8669: }
8670: }
8671: }
8672: ENDSCRIPT
1.558 albertel 8673:
1.556 raeburn 8674: }
8675:
1.555 raeburn 8676: my $output = <<"END_BLOCK";
1.556 raeburn 8677: <script type="text/javascript">
1.824 bisitz 8678: // <![CDATA[
1.570 raeburn 8679: function validateEntry(callingForm) {
1.558 albertel 8680:
1.556 raeburn 8681: var checkok = 1;
1.558 albertel 8682: var srchin;
1.570 raeburn 8683: for (var i=0; i<callingForm.srchin.length; i++) {
8684: if ( callingForm.srchin[i].checked ) {
8685: srchin = callingForm.srchin[i].value;
1.558 albertel 8686: }
8687: }
8688:
1.570 raeburn 8689: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
8690: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
8691: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
8692: var srchterm = callingForm.srchterm.value;
8693: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 8694: var msg = "";
8695:
8696: if (srchterm == "") {
8697: checkok = 0;
1.571 raeburn 8698: msg += "$lt{'youm'}\\n";
1.556 raeburn 8699: }
8700:
1.569 raeburn 8701: if (srchtype== 'begins') {
8702: if (srchterm.length < 2) {
8703: checkok = 0;
1.571 raeburn 8704: msg += "$lt{'thte'}\\n";
1.569 raeburn 8705: }
8706: }
8707:
1.556 raeburn 8708: if (srchtype== 'contains') {
8709: if (srchterm.length < 3) {
8710: checkok = 0;
1.571 raeburn 8711: msg += "$lt{'thet'}\\n";
1.556 raeburn 8712: }
8713: }
8714: if (srchin == 'instd') {
8715: if (srchdomain == '') {
8716: checkok = 0;
1.571 raeburn 8717: msg += "$lt{'yomc'}\\n";
1.556 raeburn 8718: }
8719: }
8720: if (srchin == 'dom') {
8721: if (srchdomain == '') {
8722: checkok = 0;
1.571 raeburn 8723: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 8724: }
8725: }
8726: if (srchby == 'lastfirst') {
8727: if (srchterm.indexOf(",") == -1) {
8728: checkok = 0;
1.571 raeburn 8729: msg += "$lt{'whus'}\\n";
1.556 raeburn 8730: }
8731: if (srchterm.indexOf(",") == srchterm.length -1) {
8732: checkok = 0;
1.571 raeburn 8733: msg += "$lt{'whse'}\\n";
1.556 raeburn 8734: }
8735: }
8736: if (checkok == 0) {
1.571 raeburn 8737: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 8738: return;
8739: }
8740: if (checkok == 1) {
1.570 raeburn 8741: callingForm.submit();
1.556 raeburn 8742: }
8743: }
8744:
8745: $newuserscript
8746:
1.824 bisitz 8747: // ]]>
1.556 raeburn 8748: </script>
1.558 albertel 8749:
8750: $new_user_create
8751:
1.555 raeburn 8752: END_BLOCK
1.558 albertel 8753:
1.876 raeburn 8754: $output .= &Apache::lonhtmlcommon::start_pick_box().
8755: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
8756: $domform.
8757: &Apache::lonhtmlcommon::row_closure().
8758: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
8759: $srchbysel.
8760: $srchtypesel.
8761: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
8762: $srchinsel.
8763: &Apache::lonhtmlcommon::row_closure(1).
8764: &Apache::lonhtmlcommon::end_pick_box().
8765: '<br />';
1.555 raeburn 8766: return $output;
8767: }
8768:
1.612 raeburn 8769: sub user_rule_check {
1.615 raeburn 8770: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 8771: my $response;
8772: if (ref($usershash) eq 'HASH') {
8773: foreach my $user (keys(%{$usershash})) {
8774: my ($uname,$udom) = split(/:/,$user);
8775: next if ($udom eq '' || $uname eq '');
1.615 raeburn 8776: my ($id,$newuser);
1.612 raeburn 8777: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 8778: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 8779: $id = $usershash->{$user}->{'id'};
8780: }
8781: my $inst_response;
8782: if (ref($checks) eq 'HASH') {
8783: if (defined($checks->{'username'})) {
1.615 raeburn 8784: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 8785: &Apache::lonnet::get_instuser($udom,$uname);
8786: } elsif (defined($checks->{'id'})) {
1.615 raeburn 8787: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 8788: &Apache::lonnet::get_instuser($udom,undef,$id);
8789: }
1.615 raeburn 8790: } else {
8791: ($inst_response,%{$inst_results->{$user}}) =
8792: &Apache::lonnet::get_instuser($udom,$uname);
8793: return;
1.612 raeburn 8794: }
1.615 raeburn 8795: if (!$got_rules->{$udom}) {
1.612 raeburn 8796: my %domconfig = &Apache::lonnet::get_dom('configuration',
8797: ['usercreation'],$udom);
8798: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 8799: foreach my $item ('username','id') {
1.612 raeburn 8800: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
8801: $$curr_rules{$udom}{$item} =
8802: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 8803: }
8804: }
8805: }
1.615 raeburn 8806: $got_rules->{$udom} = 1;
1.585 raeburn 8807: }
1.612 raeburn 8808: foreach my $item (keys(%{$checks})) {
8809: if (ref($$curr_rules{$udom}) eq 'HASH') {
8810: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
8811: if (@{$$curr_rules{$udom}{$item}} > 0) {
8812: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
8813: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
8814: if ($rule_check{$rule}) {
8815: $$rulematch{$user}{$item} = $rule;
8816: if ($inst_response eq 'ok') {
1.615 raeburn 8817: if (ref($inst_results) eq 'HASH') {
8818: if (ref($inst_results->{$user}) eq 'HASH') {
8819: if (keys(%{$inst_results->{$user}}) == 0) {
8820: $$alerts{$item}{$udom}{$uname} = 1;
8821: }
1.612 raeburn 8822: }
8823: }
1.615 raeburn 8824: }
8825: last;
1.585 raeburn 8826: }
8827: }
8828: }
8829: }
8830: }
8831: }
8832: }
8833: }
1.612 raeburn 8834: return;
8835: }
8836:
8837: sub user_rule_formats {
8838: my ($domain,$domdesc,$curr_rules,$check) = @_;
8839: my %text = (
8840: 'username' => 'Usernames',
8841: 'id' => 'IDs',
8842: );
8843: my $output;
8844: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
8845: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
8846: if (@{$ruleorder} > 0) {
8847: $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>';
8848: foreach my $rule (@{$ruleorder}) {
8849: if (ref($curr_rules) eq 'ARRAY') {
8850: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
8851: if (ref($rules->{$rule}) eq 'HASH') {
8852: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
8853: $rules->{$rule}{'desc'}.'</li>';
8854: }
8855: }
8856: }
8857: }
8858: $output .= '</ul>';
8859: }
8860: }
8861: return $output;
8862: }
8863:
8864: sub instrule_disallow_msg {
1.615 raeburn 8865: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 8866: my $response;
8867: my %text = (
8868: item => 'username',
8869: items => 'usernames',
8870: match => 'matches',
8871: do => 'does',
8872: action => 'a username',
8873: one => 'one',
8874: );
8875: if ($count > 1) {
8876: $text{'item'} = 'usernames';
8877: $text{'match'} ='match';
8878: $text{'do'} = 'do';
8879: $text{'action'} = 'usernames',
8880: $text{'one'} = 'ones';
8881: }
8882: if ($checkitem eq 'id') {
8883: $text{'items'} = 'IDs';
8884: $text{'item'} = 'ID';
8885: $text{'action'} = 'an ID';
1.615 raeburn 8886: if ($count > 1) {
8887: $text{'item'} = 'IDs';
8888: $text{'action'} = 'IDs';
8889: }
1.612 raeburn 8890: }
1.674 bisitz 8891: $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 8892: if ($mode eq 'upload') {
8893: if ($checkitem eq 'username') {
8894: $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'}.");
8895: } elsif ($checkitem eq 'id') {
1.674 bisitz 8896: $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 8897: }
1.669 raeburn 8898: } elsif ($mode eq 'selfcreate') {
8899: if ($checkitem eq 'id') {
8900: $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.");
8901: }
1.615 raeburn 8902: } else {
8903: if ($checkitem eq 'username') {
8904: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
8905: } elsif ($checkitem eq 'id') {
8906: $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.");
8907: }
1.612 raeburn 8908: }
8909: return $response;
1.585 raeburn 8910: }
8911:
1.624 raeburn 8912: sub personal_data_fieldtitles {
8913: my %fieldtitles = &Apache::lonlocal::texthash (
8914: id => 'Student/Employee ID',
8915: permanentemail => 'E-mail address',
8916: lastname => 'Last Name',
8917: firstname => 'First Name',
8918: middlename => 'Middle Name',
8919: generation => 'Generation',
8920: gen => 'Generation',
1.765 raeburn 8921: inststatus => 'Affiliation',
1.624 raeburn 8922: );
8923: return %fieldtitles;
8924: }
8925:
1.642 raeburn 8926: sub sorted_inst_types {
8927: my ($dom) = @_;
8928: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
8929: my $othertitle = &mt('All users');
8930: if ($env{'request.course.id'}) {
1.668 raeburn 8931: $othertitle = &mt('Any users');
1.642 raeburn 8932: }
8933: my @types;
8934: if (ref($order) eq 'ARRAY') {
8935: @types = @{$order};
8936: }
8937: if (@types == 0) {
8938: if (ref($usertypes) eq 'HASH') {
8939: @types = sort(keys(%{$usertypes}));
8940: }
8941: }
8942: if (keys(%{$usertypes}) > 0) {
8943: $othertitle = &mt('Other users');
8944: }
8945: return ($othertitle,$usertypes,\@types);
8946: }
8947:
1.645 raeburn 8948: sub get_institutional_codes {
8949: my ($settings,$allcourses,$LC_code) = @_;
8950: # Get complete list of course sections to update
8951: my @currsections = ();
8952: my @currxlists = ();
8953: my $coursecode = $$settings{'internal.coursecode'};
8954:
8955: if ($$settings{'internal.sectionnums'} ne '') {
8956: @currsections = split(/,/,$$settings{'internal.sectionnums'});
8957: }
8958:
8959: if ($$settings{'internal.crosslistings'} ne '') {
8960: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
8961: }
8962:
8963: if (@currxlists > 0) {
8964: foreach (@currxlists) {
8965: if (m/^([^:]+):(\w*)$/) {
8966: unless (grep/^$1$/,@{$allcourses}) {
8967: push @{$allcourses},$1;
8968: $$LC_code{$1} = $2;
8969: }
8970: }
8971: }
8972: }
8973:
8974: if (@currsections > 0) {
8975: foreach (@currsections) {
8976: if (m/^(\w+):(\w*)$/) {
8977: my $sec = $coursecode.$1;
8978: my $lc_sec = $2;
8979: unless (grep/^$sec$/,@{$allcourses}) {
8980: push @{$allcourses},$sec;
8981: $$LC_code{$sec} = $lc_sec;
8982: }
8983: }
8984: }
8985: }
8986: return;
8987: }
8988:
1.971 raeburn 8989: sub get_standard_codeitems {
8990: return ('Year','Semester','Department','Number','Section');
8991: }
8992:
1.112 bowersj2 8993: =pod
8994:
1.780 raeburn 8995: =head1 Slot Helpers
8996:
8997: =over 4
8998:
8999: =item * sorted_slots()
9000:
1.1040 raeburn 9001: Sorts an array of slot names in order of an optional sort key,
9002: default sort is by slot start time (earliest first).
1.780 raeburn 9003:
9004: Inputs:
9005:
9006: =over 4
9007:
9008: slotsarr - Reference to array of unsorted slot names.
9009:
9010: slots - Reference to hash of hash, where outer hash keys are slot names.
9011:
1.1040 raeburn 9012: sortkey - Name of key in inner hash to be sorted on (e.g., starttime).
9013:
1.549 albertel 9014: =back
9015:
1.780 raeburn 9016: Returns:
9017:
9018: =over 4
9019:
1.1040 raeburn 9020: sorted - An array of slot names sorted by a specified sort key
9021: (default sort key is start time of the slot).
1.780 raeburn 9022:
9023: =back
9024:
9025: =cut
9026:
9027:
9028: sub sorted_slots {
1.1040 raeburn 9029: my ($slotsarr,$slots,$sortkey) = @_;
9030: if ($sortkey eq '') {
9031: $sortkey = 'starttime';
9032: }
1.780 raeburn 9033: my @sorted;
9034: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
9035: @sorted =
9036: sort {
9037: if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040 raeburn 9038: return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780 raeburn 9039: }
9040: if (ref($slots->{$a})) { return -1;}
9041: if (ref($slots->{$b})) { return 1;}
9042: return 0;
9043: } @{$slotsarr};
9044: }
9045: return @sorted;
9046: }
9047:
1.1040 raeburn 9048: =pod
9049:
9050: =item * get_future_slots()
9051:
9052: Inputs:
9053:
9054: =over 4
9055:
9056: cnum - course number
9057:
9058: cdom - course domain
9059:
9060: now - current UNIX time
9061:
9062: symb - optional symb
9063:
9064: =back
9065:
9066: Returns:
9067:
9068: =over 4
9069:
9070: sorted_reservable - ref to array of student_schedulable slots currently
9071: reservable, ordered by end date of reservation period.
9072:
9073: reservable_now - ref to hash of student_schedulable slots currently
9074: reservable.
9075:
9076: Keys in inner hash are:
9077: (a) symb: either blank or symb to which slot use is restricted.
9078: (b) endreserve: end date of reservation period.
9079:
9080: sorted_future - ref to array of student_schedulable slots reservable in
9081: the future, ordered by start date of reservation period.
9082:
9083: future_reservable - ref to hash of student_schedulable slots reservable
9084: in the future.
9085:
9086: Keys in inner hash are:
9087: (a) symb: either blank or symb to which slot use is restricted.
9088: (b) startreserve: start date of reservation period.
9089:
9090: =back
9091:
9092: =cut
9093:
9094: sub get_future_slots {
9095: my ($cnum,$cdom,$now,$symb) = @_;
9096: my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
9097: my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
9098: foreach my $slot (keys(%slots)) {
9099: next unless($slots{$slot}->{'type'} eq 'schedulable_student');
9100: if ($symb) {
9101: next if (($slots{$slot}->{'symb'} ne '') &&
9102: ($slots{$slot}->{'symb'} ne $symb));
9103: }
9104: if (($slots{$slot}->{'starttime'} > $now) &&
9105: ($slots{$slot}->{'endtime'} > $now)) {
9106: if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
9107: my $userallowed = 0;
9108: if ($slots{$slot}->{'allowedsections'}) {
9109: my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
9110: if (!defined($env{'request.role.sec'})
9111: && grep(/^No section assigned$/,@allowed_sec)) {
9112: $userallowed=1;
9113: } else {
9114: if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
9115: $userallowed=1;
9116: }
9117: }
9118: unless ($userallowed) {
9119: if (defined($env{'request.course.groups'})) {
9120: my @groups = split(/:/,$env{'request.course.groups'});
9121: foreach my $group (@groups) {
9122: if (grep(/^\Q$group\E$/,@allowed_sec)) {
9123: $userallowed=1;
9124: last;
9125: }
9126: }
9127: }
9128: }
9129: }
9130: if ($slots{$slot}->{'allowedusers'}) {
9131: my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
9132: my $user = $env{'user.name'}.':'.$env{'user.domain'};
9133: if (grep(/^\Q$user\E$/,@allowed_users)) {
9134: $userallowed = 1;
9135: }
9136: }
9137: next unless($userallowed);
9138: }
9139: my $startreserve = $slots{$slot}->{'startreserve'};
9140: my $endreserve = $slots{$slot}->{'endreserve'};
9141: my $symb = $slots{$slot}->{'symb'};
9142: if (($startreserve < $now) &&
9143: (!$endreserve || $endreserve > $now)) {
9144: my $lastres = $endreserve;
9145: if (!$lastres) {
9146: $lastres = $slots{$slot}->{'starttime'};
9147: }
9148: $reservable_now{$slot} = {
9149: symb => $symb,
9150: endreserve => $lastres
9151: };
9152: } elsif (($startreserve > $now) &&
9153: (!$endreserve || $endreserve > $startreserve)) {
9154: $future_reservable{$slot} = {
9155: symb => $symb,
9156: startreserve => $startreserve
9157: };
9158: }
9159: }
9160: }
9161: my @unsorted_reservable = keys(%reservable_now);
9162: if (@unsorted_reservable > 0) {
9163: @sorted_reservable =
9164: &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
9165: }
9166: my @unsorted_future = keys(%future_reservable);
9167: if (@unsorted_future > 0) {
9168: @sorted_future =
9169: &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
9170: }
9171: return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
9172: }
1.780 raeburn 9173:
9174: =pod
9175:
1.1057 foxr 9176: =back
9177:
1.549 albertel 9178: =head1 HTTP Helpers
9179:
9180: =over 4
9181:
1.648 raeburn 9182: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 9183:
1.258 albertel 9184: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 9185: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 9186: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 9187:
9188: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
9189: $possible_names is an ref to an array of form element names. As an example:
9190: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 9191: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 9192:
9193: =cut
1.1 albertel 9194:
1.6 albertel 9195: sub get_unprocessed_cgi {
1.25 albertel 9196: my ($query,$possible_names)= @_;
1.26 matthew 9197: # $Apache::lonxml::debug=1;
1.356 albertel 9198: foreach my $pair (split(/&/,$query)) {
9199: my ($name, $value) = split(/=/,$pair);
1.369 www 9200: $name = &unescape($name);
1.25 albertel 9201: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
9202: $value =~ tr/+/ /;
9203: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 9204: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 9205: }
1.16 harris41 9206: }
1.6 albertel 9207: }
9208:
1.112 bowersj2 9209: =pod
9210:
1.648 raeburn 9211: =item * &cacheheader()
1.112 bowersj2 9212:
9213: returns cache-controlling header code
9214:
9215: =cut
9216:
1.7 albertel 9217: sub cacheheader {
1.258 albertel 9218: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 9219: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
9220: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 9221: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
9222: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 9223: return $output;
1.7 albertel 9224: }
9225:
1.112 bowersj2 9226: =pod
9227:
1.648 raeburn 9228: =item * &no_cache($r)
1.112 bowersj2 9229:
9230: specifies header code to not have cache
9231:
9232: =cut
9233:
1.9 albertel 9234: sub no_cache {
1.216 albertel 9235: my ($r) = @_;
9236: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 9237: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 9238: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
9239: $r->no_cache(1);
9240: $r->header_out("Expires" => $date);
9241: $r->header_out("Pragma" => "no-cache");
1.123 www 9242: }
9243:
9244: sub content_type {
1.181 albertel 9245: my ($r,$type,$charset) = @_;
1.299 foxr 9246: if ($r) {
9247: # Note that printout.pl calls this with undef for $r.
9248: &no_cache($r);
9249: }
1.258 albertel 9250: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 9251: unless ($charset) {
9252: $charset=&Apache::lonlocal::current_encoding;
9253: }
9254: if ($charset) { $type.='; charset='.$charset; }
9255: if ($r) {
9256: $r->content_type($type);
9257: } else {
9258: print("Content-type: $type\n\n");
9259: }
1.9 albertel 9260: }
1.25 albertel 9261:
1.112 bowersj2 9262: =pod
9263:
1.648 raeburn 9264: =item * &add_to_env($name,$value)
1.112 bowersj2 9265:
1.258 albertel 9266: adds $name to the %env hash with value
1.112 bowersj2 9267: $value, if $name already exists, the entry is converted to an array
9268: reference and $value is added to the array.
9269:
9270: =cut
9271:
1.25 albertel 9272: sub add_to_env {
9273: my ($name,$value)=@_;
1.258 albertel 9274: if (defined($env{$name})) {
9275: if (ref($env{$name})) {
1.25 albertel 9276: #already have multiple values
1.258 albertel 9277: push(@{ $env{$name} },$value);
1.25 albertel 9278: } else {
9279: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 9280: my $first=$env{$name};
9281: undef($env{$name});
9282: push(@{ $env{$name} },$first,$value);
1.25 albertel 9283: }
9284: } else {
1.258 albertel 9285: $env{$name}=$value;
1.25 albertel 9286: }
1.31 albertel 9287: }
1.149 albertel 9288:
9289: =pod
9290:
1.648 raeburn 9291: =item * &get_env_multiple($name)
1.149 albertel 9292:
1.258 albertel 9293: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 9294: values may be defined and end up as an array ref.
9295:
9296: returns an array of values
9297:
9298: =cut
9299:
9300: sub get_env_multiple {
9301: my ($name) = @_;
9302: my @values;
1.258 albertel 9303: if (defined($env{$name})) {
1.149 albertel 9304: # exists is it an array
1.258 albertel 9305: if (ref($env{$name})) {
9306: @values=@{ $env{$name} };
1.149 albertel 9307: } else {
1.258 albertel 9308: $values[0]=$env{$name};
1.149 albertel 9309: }
9310: }
9311: return(@values);
9312: }
9313:
1.660 raeburn 9314: sub ask_for_embedded_content {
9315: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071 raeburn 9316: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
9317: %currsubfile,%unused);
9318: my $counter = 0;
9319: my $numnew = 0;
1.987 raeburn 9320: my $numremref = 0;
9321: my $numinvalid = 0;
9322: my $numpathchg = 0;
9323: my $numexisting = 0;
1.1071 raeburn 9324: my $numunused = 0;
9325: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
9326: $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path);
9327: my $heading = &mt('Upload embedded files');
9328: my $buttontext = &mt('Upload');
9329:
1.984 raeburn 9330: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
9331: my $current_path='/';
9332: if ($env{'form.currentpath'}) {
9333: $current_path = $env{'form.currentpath'};
9334: }
9335: if ($actionurl eq '/adm/coursegrp_portfolio') {
9336: $udom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9337: $uname = $env{'course.'.$env{'request.course.id'}.'.num'};
9338: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
9339: } else {
9340: $udom = $env{'user.domain'};
9341: $uname = $env{'user.name'};
9342: $url = '/userfiles/portfolio';
9343: }
1.987 raeburn 9344: $toplevel = $url.'/';
1.984 raeburn 9345: $url .= $current_path;
9346: $getpropath = 1;
1.987 raeburn 9347: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
9348: ($actionurl eq '/adm/imsimport')) {
1.1022 www 9349: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026 raeburn 9350: $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987 raeburn 9351: $toplevel = $url;
1.984 raeburn 9352: if ($rest ne '') {
1.987 raeburn 9353: $url .= $rest;
9354: }
9355: } elsif ($actionurl eq '/adm/coursedocs') {
9356: if (ref($args) eq 'HASH') {
1.1071 raeburn 9357: $url = $args->{'docs_url'};
9358: $toplevel = $url;
9359: }
9360: } elsif ($actionurl eq '/adm/dependencies') {
9361: if ($env{'request.course.id'} ne '') {
9362: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9363: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
9364: if (ref($args) eq 'HASH') {
9365: $url = $args->{'docs_url'};
9366: $title = $args->{'docs_title'};
9367: $toplevel = "/$url";
9368: ($path) =
9369: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
9370: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
9371: $fileloc =~ s{^/}{};
9372: ($filename) = ($fileloc =~ m{.+/([^/]+)$});
9373: $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
9374: }
1.987 raeburn 9375: }
9376: }
9377: my $now = time();
9378: foreach my $embed_file (keys(%{$allfiles})) {
9379: my $absolutepath;
9380: if ($embed_file =~ m{^\w+://}) {
9381: $newfiles{$embed_file} = 1;
9382: $mapping{$embed_file} = $embed_file;
9383: } else {
9384: if ($embed_file =~ m{^/}) {
9385: $absolutepath = $embed_file;
9386: $embed_file =~ s{^(/+)}{};
9387: }
9388: if ($embed_file =~ m{/}) {
9389: my ($path,$fname) = ($embed_file =~ m{^(.+)/([^/]*)$});
9390: $path = &check_for_traversal($path,$url,$toplevel);
9391: my $item = $fname;
9392: if ($path ne '') {
9393: $item = $path.'/'.$fname;
9394: $subdependencies{$path}{$fname} = 1;
9395: } else {
9396: $dependencies{$item} = 1;
9397: }
9398: if ($absolutepath) {
9399: $mapping{$item} = $absolutepath;
9400: } else {
9401: $mapping{$item} = $embed_file;
9402: }
9403: } else {
9404: $dependencies{$embed_file} = 1;
9405: if ($absolutepath) {
9406: $mapping{$embed_file} = $absolutepath;
9407: } else {
9408: $mapping{$embed_file} = $embed_file;
9409: }
9410: }
1.984 raeburn 9411: }
9412: }
1.1071 raeburn 9413: my $dirptr = 16384;
1.984 raeburn 9414: foreach my $path (keys(%subdependencies)) {
1.1071 raeburn 9415: $currsubfile{$path} = {};
1.984 raeburn 9416: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 9417: my ($sublistref,$listerror) =
9418: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
9419: if (ref($sublistref) eq 'ARRAY') {
9420: foreach my $line (@{$sublistref}) {
9421: my ($file_name,$rest) = split(/\&/,$line,2);
1.1071 raeburn 9422: $currsubfile{$path}{$file_name} = 1;
1.1021 raeburn 9423: }
1.984 raeburn 9424: }
1.987 raeburn 9425: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 9426: if (opendir(my $dir,$url.'/'.$path)) {
9427: my @subdir_list = grep(!/^\./,readdir($dir));
1.1071 raeburn 9428: map {$currsubfile{$path}{$_} = 1;} @subdir_list;
9429: }
9430: } elsif ($actionurl eq '/adm/dependencies') {
9431: if ($env{'request.course.id'} ne '') {
9432: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
9433: if ($dir ne '') {
9434: my ($sublistref,$listerror) =
9435: &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
9436: if (ref($sublistref) eq 'ARRAY') {
9437: foreach my $line (@{$sublistref}) {
9438: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
9439: undef,$mtime)=split(/\&/,$line,12);
9440: unless (($testdir&$dirptr) ||
9441: ($file_name =~ /^\.\.?$/)) {
9442: $currsubfile{$path}{$file_name} = [$size,$mtime];
9443: }
9444: }
9445: }
9446: }
1.984 raeburn 9447: }
9448: }
9449: foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071 raeburn 9450: if (exists($currsubfile{$path}{$file})) {
1.987 raeburn 9451: my $item = $path.'/'.$file;
9452: unless ($mapping{$item} eq $item) {
9453: $pathchanges{$item} = 1;
9454: }
9455: $existing{$item} = 1;
9456: $numexisting ++;
9457: } else {
9458: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 9459: }
9460: }
1.1071 raeburn 9461: if ($actionurl eq '/adm/dependencies') {
9462: foreach my $path (keys(%currsubfile)) {
9463: if (ref($currsubfile{$path}) eq 'HASH') {
9464: foreach my $file (keys(%{$currsubfile{$path}})) {
9465: unless ($subdependencies{$path}{$file}) {
9466: $unused{$path.'/'.$file} = 1;
9467: }
9468: }
9469: }
9470: }
9471: }
1.984 raeburn 9472: }
1.987 raeburn 9473: my %currfile;
1.984 raeburn 9474: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 9475: my ($dirlistref,$listerror) =
9476: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
9477: if (ref($dirlistref) eq 'ARRAY') {
9478: foreach my $line (@{$dirlistref}) {
9479: my ($file_name,$rest) = split(/\&/,$line,2);
9480: $currfile{$file_name} = 1;
9481: }
1.984 raeburn 9482: }
1.987 raeburn 9483: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 9484: if (opendir(my $dir,$url)) {
1.987 raeburn 9485: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 9486: map {$currfile{$_} = 1;} @dir_list;
9487: }
1.1071 raeburn 9488: } elsif ($actionurl eq '/adm/dependencies') {
9489: if ($env{'request.course.id'} ne '') {
9490: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
9491: if ($dir ne '') {
9492: my ($dirlistref,$listerror) =
9493: &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
9494: if (ref($dirlistref) eq 'ARRAY') {
9495: foreach my $line (@{$dirlistref}) {
9496: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
9497: $size,undef,$mtime)=split(/\&/,$line,12);
9498: unless (($testdir&$dirptr) ||
9499: ($file_name =~ /^\.\.?$/)) {
9500: $currfile{$file_name} = [$size,$mtime];
9501: }
9502: }
9503: }
9504: }
9505: }
1.984 raeburn 9506: }
9507: foreach my $file (keys(%dependencies)) {
1.1071 raeburn 9508: if (exists($currfile{$file})) {
1.987 raeburn 9509: unless ($mapping{$file} eq $file) {
9510: $pathchanges{$file} = 1;
9511: }
9512: $existing{$file} = 1;
9513: $numexisting ++;
9514: } else {
1.984 raeburn 9515: $newfiles{$file} = 1;
9516: }
9517: }
1.1071 raeburn 9518: foreach my $file (keys(%currfile)) {
9519: unless (($file eq $filename) ||
9520: ($file eq $filename.'.bak') ||
9521: ($dependencies{$file})) {
9522: $unused{$file} = 1;
9523: }
9524: }
1.984 raeburn 9525: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071 raeburn 9526: if ($actionurl eq '/adm/dependencies') {
9527: next if ($embed_file =~ m{^\w+://});
9528: }
1.660 raeburn 9529: $upload_output .= &start_data_table_row().
1.1071 raeburn 9530: '<td><img src="'.&icon($embed_file).'" /> '.
9531: '<span class="LC_filename">'.$embed_file.'</span>';
1.987 raeburn 9532: unless ($mapping{$embed_file} eq $embed_file) {
9533: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.&mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
9534: }
9535: $upload_output .= '</td><td>';
1.1071 raeburn 9536: if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) {
1.660 raeburn 9537: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
1.987 raeburn 9538: $numremref++;
1.660 raeburn 9539: } elsif ($args->{'error_on_invalid_names'}
9540: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
9541:
1.987 raeburn 9542: $upload_output.='<span class="LC_warning">'.&mt('Invalid characters').'</span>';
9543: $numinvalid++;
1.660 raeburn 9544: } else {
1.1071 raeburn 9545: $upload_output .= &embedded_file_element('upload_embedded',$counter,
1.987 raeburn 9546: $embed_file,\%mapping,
1.1071 raeburn 9547: $allfiles,$codebase,'upload');
9548: $counter ++;
9549: $numnew ++;
1.987 raeburn 9550: }
9551: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
9552: }
9553: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071 raeburn 9554: if ($actionurl eq '/adm/dependencies') {
9555: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
9556: $modify_output .= &start_data_table_row().
9557: '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
9558: '<img src="'.&icon($embed_file).'" border="0" />'.
9559: ' <span class="LC_filename">'.$embed_file.'</span></a></td>'.
9560: '<td>'.$size.'</td>'.
9561: '<td>'.$mtime.'</td>'.
9562: '<td><label><input type="checkbox" name="mod_upload_dep" '.
9563: 'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
9564: $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
9565: '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
9566: &embedded_file_element('upload_embedded',$counter,
9567: $embed_file,\%mapping,
9568: $allfiles,$codebase,'modify').
9569: '</div></td>'.
9570: &end_data_table_row()."\n";
9571: $counter ++;
9572: } else {
9573: $upload_output .= &start_data_table_row().
9574: '<td><span class="LC_filename">'.$embed_file.'</span></td>';
9575: '<td><span class="LC_warning">'.&mt('Already exists').'</span></td>'.
9576: &Apache::loncommon::end_data_table_row()."\n";
9577: }
9578: }
9579: my $delidx = $counter;
9580: foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
9581: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
9582: $delete_output .= &start_data_table_row().
9583: '<td><img src="'.&icon($oldfile).'" />'.
9584: ' <span class="LC_filename">'.$oldfile.'</span></td>'.
9585: '<td>'.$size.'</td>'.
9586: '<td>'.$mtime.'</td>'.
9587: '<td><label><input type="checkbox" name="del_upload_dep" '.
9588: ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
9589: &embedded_file_element('upload_embedded',$delidx,
9590: $oldfile,\%mapping,$allfiles,
9591: $codebase,'delete').'</td>'.
9592: &end_data_table_row()."\n";
9593: $numunused ++;
9594: $delidx ++;
1.987 raeburn 9595: }
9596: if ($upload_output) {
9597: $upload_output = &start_data_table().
9598: $upload_output.
9599: &end_data_table()."\n";
9600: }
1.1071 raeburn 9601: if ($modify_output) {
9602: $modify_output = &start_data_table().
9603: &start_data_table_header_row().
9604: '<th>'.&mt('File').'</th>'.
9605: '<th>'.&mt('Size (KB)').'</th>'.
9606: '<th>'.&mt('Modified').'</th>'.
9607: '<th>'.&mt('Upload replacement?').'</th>'.
9608: &end_data_table_header_row().
9609: $modify_output.
9610: &end_data_table()."\n";
9611: }
9612: if ($delete_output) {
9613: $delete_output = &start_data_table().
9614: &start_data_table_header_row().
9615: '<th>'.&mt('File').'</th>'.
9616: '<th>'.&mt('Size (KB)').'</th>'.
9617: '<th>'.&mt('Modified').'</th>'.
9618: '<th>'.&mt('Delete?').'</th>'.
9619: &end_data_table_header_row().
9620: $delete_output.
9621: &end_data_table()."\n";
9622: }
1.987 raeburn 9623: my $applies = 0;
9624: if ($numremref) {
9625: $applies ++;
9626: }
9627: if ($numinvalid) {
9628: $applies ++;
9629: }
9630: if ($numexisting) {
9631: $applies ++;
9632: }
1.1071 raeburn 9633: if ($counter || $numunused) {
1.987 raeburn 9634: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
9635: ' method="post" enctype="multipart/form-data">'."\n".
1.1071 raeburn 9636: $state.'<h3>'.$heading.'</h3>';
9637: if ($actionurl eq '/adm/dependencies') {
9638: if ($numnew) {
9639: $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
9640: '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
9641: $upload_output.'<br />'."\n";
9642: }
9643: if ($numexisting) {
9644: $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
9645: '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
9646: $modify_output.'<br />'."\n";
9647: $buttontext = &mt('Save changes');
9648: }
9649: if ($numunused) {
9650: $output .= '<h4>'.&mt('Unused files').'</h4>'.
9651: '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
9652: $delete_output.'<br />'."\n";
9653: $buttontext = &mt('Save changes');
9654: }
9655: } else {
9656: $output .= $upload_output.'<br />'."\n";
9657: }
9658: $output .= '<input type ="hidden" name="number_embedded_items" value="'.
9659: $counter.'" />'."\n";
9660: if ($actionurl eq '/adm/dependencies') {
9661: $output .= '<input type ="hidden" name="number_newemb_items" value="'.
9662: $numnew.'" />'."\n";
9663: } elsif ($actionurl eq '') {
1.987 raeburn 9664: $output .= '<input type="hidden" name="phase" value="three" />';
9665: }
9666: } elsif ($applies) {
9667: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
9668: if ($applies > 1) {
9669: $output .=
9670: &mt('No files need to be uploaded, as one of the following applies to each reference:').'<ul>';
9671: if ($numremref) {
9672: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
9673: }
9674: if ($numinvalid) {
9675: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
9676: }
9677: if ($numexisting) {
9678: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
9679: }
9680: $output .= '</ul><br />';
9681: } elsif ($numremref) {
9682: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
9683: } elsif ($numinvalid) {
9684: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
9685: } elsif ($numexisting) {
9686: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
9687: }
9688: $output .= $upload_output.'<br />';
9689: }
9690: my ($pathchange_output,$chgcount);
1.1071 raeburn 9691: $chgcount = $counter;
1.987 raeburn 9692: if (keys(%pathchanges) > 0) {
9693: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071 raeburn 9694: if ($counter) {
1.987 raeburn 9695: $output .= &embedded_file_element('pathchange',$chgcount,
9696: $embed_file,\%mapping,
1.1071 raeburn 9697: $allfiles,$codebase,'change');
1.987 raeburn 9698: } else {
9699: $pathchange_output .=
9700: &start_data_table_row().
9701: '<td><input type ="checkbox" name="namechange" value="'.
9702: $chgcount.'" checked="checked" /></td>'.
9703: '<td>'.$mapping{$embed_file}.'</td>'.
9704: '<td>'.$embed_file.
9705: &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071 raeburn 9706: \%mapping,$allfiles,$codebase,'change').
1.987 raeburn 9707: '</td>'.&end_data_table_row();
1.660 raeburn 9708: }
1.987 raeburn 9709: $numpathchg ++;
9710: $chgcount ++;
1.660 raeburn 9711: }
9712: }
1.1071 raeburn 9713: if ($counter) {
1.987 raeburn 9714: if ($numpathchg) {
9715: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
9716: $numpathchg.'" />'."\n";
9717: }
9718: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
9719: ($actionurl eq '/adm/imsimport')) {
9720: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
9721: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
9722: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071 raeburn 9723: } elsif ($actionurl eq '/adm/dependencies') {
9724: $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987 raeburn 9725: }
1.1071 raeburn 9726: $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987 raeburn 9727: } elsif ($numpathchg) {
9728: my %pathchange = ();
9729: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
9730: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
9731: $output .= '<p>'.&mt('or').'</p>';
9732: }
9733: }
1.1071 raeburn 9734: return ($output,$counter,$numpathchg);
1.987 raeburn 9735: }
9736:
9737: sub embedded_file_element {
1.1071 raeburn 9738: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987 raeburn 9739: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
9740: (ref($codebase) eq 'HASH'));
9741: my $output;
1.1071 raeburn 9742: if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987 raeburn 9743: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
9744: }
9745: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
9746: &escape($embed_file).'" />';
9747: unless (($context eq 'upload_embedded') &&
9748: ($mapping->{$embed_file} eq $embed_file)) {
9749: $output .='
9750: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
9751: }
9752: my $attrib;
9753: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
9754: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
9755: }
9756: $output .=
9757: "\n\t\t".
9758: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
9759: $attrib.'" />';
9760: if (exists($codebase->{$mapping->{$embed_file}})) {
9761: $output .=
9762: "\n\t\t".
9763: '<input name="codebase_'.$num.'" type="hidden" value="'.
9764: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 9765: }
1.987 raeburn 9766: return $output;
1.660 raeburn 9767: }
9768:
1.1071 raeburn 9769: sub get_dependency_details {
9770: my ($currfile,$currsubfile,$embed_file) = @_;
9771: my ($size,$mtime,$showsize,$showmtime);
9772: if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
9773: if ($embed_file =~ m{/}) {
9774: my ($path,$fname) = split(/\//,$embed_file);
9775: if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
9776: ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
9777: }
9778: } else {
9779: if (ref($currfile->{$embed_file}) eq 'ARRAY') {
9780: ($size,$mtime) = @{$currfile->{$embed_file}};
9781: }
9782: }
9783: $showsize = $size/1024.0;
9784: $showsize = sprintf("%.1f",$showsize);
9785: if ($mtime > 0) {
9786: $showmtime = &Apache::lonlocal::locallocaltime($mtime);
9787: }
9788: }
9789: return ($showsize,$showmtime);
9790: }
9791:
9792: sub ask_embedded_js {
9793: return <<"END";
9794: <script type="text/javascript"">
9795: // <![CDATA[
9796: function toggleBrowse(counter) {
9797: var chkboxid = document.getElementById('mod_upload_dep_'+counter);
9798: var fileid = document.getElementById('embedded_item_'+counter);
9799: var uploaddivid = document.getElementById('moduploaddep_'+counter);
9800: if (chkboxid.checked == true) {
9801: uploaddivid.style.display='block';
9802: } else {
9803: uploaddivid.style.display='none';
9804: fileid.value = '';
9805: }
9806: }
9807: // ]]>
9808: </script>
9809:
9810: END
9811: }
9812:
1.661 raeburn 9813: sub upload_embedded {
9814: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 9815: $current_disk_usage,$hiddenstate,$actionurl) = @_;
9816: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 9817: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
9818: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
9819: my $orig_uploaded_filename =
9820: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 9821: foreach my $type ('orig','ref','attrib','codebase') {
9822: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
9823: $env{'form.embedded_'.$type.'_'.$i} =
9824: &unescape($env{'form.embedded_'.$type.'_'.$i});
9825: }
9826: }
1.661 raeburn 9827: my ($path,$fname) =
9828: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
9829: # no path, whole string is fname
9830: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
9831: $fname = &Apache::lonnet::clean_filename($fname);
9832: # See if there is anything left
9833: next if ($fname eq '');
9834:
9835: # Check if file already exists as a file or directory.
9836: my ($state,$msg);
9837: if ($context eq 'portfolio') {
9838: my $port_path = $dirpath;
9839: if ($group ne '') {
9840: $port_path = "groups/$group/$port_path";
9841: }
1.987 raeburn 9842: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
9843: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 9844: $dir_root,$port_path,$disk_quota,
9845: $current_disk_usage,$uname,$udom);
9846: if ($state eq 'will_exceed_quota'
1.984 raeburn 9847: || $state eq 'file_locked') {
1.661 raeburn 9848: $output .= $msg;
9849: next;
9850: }
9851: } elsif (($context eq 'author') || ($context eq 'testbank')) {
9852: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
9853: if ($state eq 'exists') {
9854: $output .= $msg;
9855: next;
9856: }
9857: }
9858: # Check if extension is valid
9859: if (($fname =~ /\.(\w+)$/) &&
9860: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.987 raeburn 9861: $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 9862: next;
9863: } elsif (($fname =~ /\.(\w+)$/) &&
9864: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 9865: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 9866: next;
9867: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.987 raeburn 9868: $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 9869: next;
9870: }
9871: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
9872: if ($context eq 'portfolio') {
1.984 raeburn 9873: my $result;
9874: if ($state eq 'existingfile') {
9875: $result=
9876: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.987 raeburn 9877: $dirpath.$env{'form.currentpath'}.$path);
1.661 raeburn 9878: } else {
1.984 raeburn 9879: $result=
9880: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 9881: $dirpath.
9882: $env{'form.currentpath'}.$path);
1.984 raeburn 9883: if ($result !~ m|^/uploaded/|) {
9884: $output .= '<span class="LC_error">'
9885: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
9886: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
9887: .'</span><br />';
9888: next;
9889: } else {
1.987 raeburn 9890: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
9891: $path.$fname.'</span>').'<br />';
1.984 raeburn 9892: }
1.661 raeburn 9893: }
1.987 raeburn 9894: } elsif ($context eq 'coursedoc') {
9895: my $result =
9896: &Apache::lonnet::userfileupload('embedded_item_'.$i,'coursedoc',
9897: $dirpath.'/'.$path);
9898: if ($result !~ m|^/uploaded/|) {
9899: $output .= '<span class="LC_error">'
9900: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
9901: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
9902: .'</span><br />';
9903: next;
9904: } else {
9905: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
9906: $path.$fname.'</span>').'<br />';
9907: }
1.661 raeburn 9908: } else {
9909: # Save the file
9910: my $target = $env{'form.embedded_item_'.$i};
9911: my $fullpath = $dir_root.$dirpath.'/'.$path;
9912: my $dest = $fullpath.$fname;
9913: my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027 raeburn 9914: my @parts=split(/\//,"$dirpath/$path");
1.661 raeburn 9915: my $count;
9916: my $filepath = $dir_root;
1.1027 raeburn 9917: foreach my $subdir (@parts) {
9918: $filepath .= "/$subdir";
9919: if (!-e $filepath) {
1.661 raeburn 9920: mkdir($filepath,0770);
9921: }
9922: }
9923: my $fh;
9924: if (!open($fh,'>'.$dest)) {
9925: &Apache::lonnet::logthis('Failed to create '.$dest);
9926: $output .= '<span class="LC_error">'.
1.1071 raeburn 9927: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
9928: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 9929: '</span><br />';
9930: } else {
9931: if (!print $fh $env{'form.embedded_item_'.$i}) {
9932: &Apache::lonnet::logthis('Failed to write to '.$dest);
9933: $output .= '<span class="LC_error">'.
1.1071 raeburn 9934: &mt('An error occurred while writing the file [_1] for embedded element [_2].',
9935: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 9936: '</span><br />';
9937: } else {
1.987 raeburn 9938: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
9939: $url.'</span>').'<br />';
9940: unless ($context eq 'testbank') {
9941: $footer .= &mt('View embedded file: [_1]',
9942: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
9943: }
9944: }
9945: close($fh);
9946: }
9947: }
9948: if ($env{'form.embedded_ref_'.$i}) {
9949: $pathchange{$i} = 1;
9950: }
9951: }
9952: if ($output) {
9953: $output = '<p>'.$output.'</p>';
9954: }
9955: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
9956: $returnflag = 'ok';
1.1071 raeburn 9957: my $numpathchgs = scalar(keys(%pathchange));
9958: if ($numpathchgs > 0) {
1.987 raeburn 9959: if ($context eq 'portfolio') {
9960: $output .= '<p>'.&mt('or').'</p>';
9961: } elsif ($context eq 'testbank') {
1.1071 raeburn 9962: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
9963: '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987 raeburn 9964: $returnflag = 'modify_orightml';
9965: }
9966: }
1.1071 raeburn 9967: return ($output.$footer,$returnflag,$numpathchgs);
1.987 raeburn 9968: }
9969:
9970: sub modify_html_form {
9971: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
9972: my $end = 0;
9973: my $modifyform;
9974: if ($context eq 'upload_embedded') {
9975: return unless (ref($pathchange) eq 'HASH');
9976: if ($env{'form.number_embedded_items'}) {
9977: $end += $env{'form.number_embedded_items'};
9978: }
9979: if ($env{'form.number_pathchange_items'}) {
9980: $end += $env{'form.number_pathchange_items'};
9981: }
9982: if ($end) {
9983: for (my $i=0; $i<$end; $i++) {
9984: if ($i < $env{'form.number_embedded_items'}) {
9985: next unless($pathchange->{$i});
9986: }
9987: $modifyform .=
9988: &start_data_table_row().
9989: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
9990: 'checked="checked" /></td>'.
9991: '<td>'.$env{'form.embedded_ref_'.$i}.
9992: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
9993: &escape($env{'form.embedded_ref_'.$i}).'" />'.
9994: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
9995: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
9996: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
9997: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
9998: '<td>'.$env{'form.embedded_orig_'.$i}.
9999: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
10000: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
10001: &end_data_table_row();
1.1071 raeburn 10002: }
1.987 raeburn 10003: }
10004: } else {
10005: $modifyform = $pathchgtable;
10006: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
10007: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
10008: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
10009: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
10010: }
10011: }
10012: if ($modifyform) {
1.1071 raeburn 10013: if ($actionurl eq '/adm/dependencies') {
10014: $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
10015: }
1.987 raeburn 10016: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
10017: '<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".
10018: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
10019: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
10020: '</ol></p>'."\n".'<p>'.
10021: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
10022: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
10023: &start_data_table()."\n".
10024: &start_data_table_header_row().
10025: '<th>'.&mt('Change?').'</th>'.
10026: '<th>'.&mt('Current reference').'</th>'.
10027: '<th>'.&mt('Required reference').'</th>'.
10028: &end_data_table_header_row()."\n".
10029: $modifyform.
10030: &end_data_table().'<br />'."\n".$hiddenstate.
10031: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
10032: '</form>'."\n";
10033: }
10034: return;
10035: }
10036:
10037: sub modify_html_refs {
10038: my ($context,$dirpath,$uname,$udom,$dir_root) = @_;
10039: my $container;
10040: if ($context eq 'portfolio') {
10041: $container = $env{'form.container'};
10042: } elsif ($context eq 'coursedoc') {
10043: $container = $env{'form.primaryurl'};
1.1071 raeburn 10044: } elsif ($context eq 'manage_dependencies') {
10045: (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
10046: $container = "/$container";
1.987 raeburn 10047: } else {
1.1027 raeburn 10048: $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987 raeburn 10049: }
10050: my (%allfiles,%codebase,$output,$content);
10051: my @changes = &get_env_multiple('form.namechange');
1.1071 raeburn 10052: unless (@changes > 0) {
10053: if (wantarray) {
10054: return ('',0,0);
10055: } else {
10056: return;
10057: }
10058: }
10059: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
10060: ($context eq 'manage_dependencies')) {
10061: unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
10062: if (wantarray) {
10063: return ('',0,0);
10064: } else {
10065: return;
10066: }
10067: }
1.987 raeburn 10068: $content = &Apache::lonnet::getfile($container);
1.1071 raeburn 10069: if ($content eq '-1') {
10070: if (wantarray) {
10071: return ('',0,0);
10072: } else {
10073: return;
10074: }
10075: }
1.987 raeburn 10076: } else {
1.1071 raeburn 10077: unless ($container =~ /^\Q$dir_root\E/) {
10078: if (wantarray) {
10079: return ('',0,0);
10080: } else {
10081: return;
10082: }
10083: }
1.987 raeburn 10084: if (open(my $fh,"<$container")) {
10085: $content = join('', <$fh>);
10086: close($fh);
10087: } else {
1.1071 raeburn 10088: if (wantarray) {
10089: return ('',0,0);
10090: } else {
10091: return;
10092: }
1.987 raeburn 10093: }
10094: }
10095: my ($count,$codebasecount) = (0,0);
10096: my $mm = new File::MMagic;
10097: my $mime_type = $mm->checktype_contents($content);
10098: if ($mime_type eq 'text/html') {
10099: my $parse_result =
10100: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
10101: \%codebase,\$content);
10102: if ($parse_result eq 'ok') {
10103: foreach my $i (@changes) {
10104: my $orig = &unescape($env{'form.embedded_orig_'.$i});
10105: my $ref = &unescape($env{'form.embedded_ref_'.$i});
10106: if ($allfiles{$ref}) {
10107: my $newname = $orig;
10108: my ($attrib_regexp,$codebase);
1.1006 raeburn 10109: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 10110: if ($attrib_regexp =~ /:/) {
10111: $attrib_regexp =~ s/\:/|/g;
10112: }
10113: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
10114: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
10115: $count += $numchg;
10116: }
10117: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 10118: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 10119: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
10120: $codebasecount ++;
10121: }
10122: }
10123: }
10124: if ($count || $codebasecount) {
10125: my $saveresult;
1.1071 raeburn 10126: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
10127: ($context eq 'manage_dependencies')) {
1.987 raeburn 10128: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
10129: if ($url eq $container) {
10130: my ($fname) = ($container =~ m{/([^/]+)$});
10131: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
10132: $count,'<span class="LC_filename">'.
1.1071 raeburn 10133: $fname.'</span>').'</p>';
1.987 raeburn 10134: } else {
10135: $output = '<p class="LC_error">'.
10136: &mt('Error: update failed for: [_1].',
10137: '<span class="LC_filename">'.
10138: $container.'</span>').'</p>';
10139: }
10140: } else {
10141: if (open(my $fh,">$container")) {
10142: print $fh $content;
10143: close($fh);
10144: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
10145: $count,'<span class="LC_filename">'.
10146: $container.'</span>').'</p>';
1.661 raeburn 10147: } else {
1.987 raeburn 10148: $output = '<p class="LC_error">'.
10149: &mt('Error: could not update [_1].',
10150: '<span class="LC_filename">'.
10151: $container.'</span>').'</p>';
1.661 raeburn 10152: }
10153: }
10154: }
1.987 raeburn 10155: } else {
10156: &logthis('Failed to parse '.$container.
10157: ' to modify references: '.$parse_result);
1.661 raeburn 10158: }
10159: }
1.1071 raeburn 10160: if (wantarray) {
10161: return ($output,$count,$codebasecount);
10162: } else {
10163: return $output;
10164: }
1.661 raeburn 10165: }
10166:
10167: sub check_for_existing {
10168: my ($path,$fname,$element) = @_;
10169: my ($state,$msg);
10170: if (-d $path.'/'.$fname) {
10171: $state = 'exists';
10172: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
10173: } elsif (-e $path.'/'.$fname) {
10174: $state = 'exists';
10175: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
10176: }
10177: if ($state eq 'exists') {
10178: $msg = '<span class="LC_error">'.$msg.'</span><br />';
10179: }
10180: return ($state,$msg);
10181: }
10182:
10183: sub check_for_upload {
10184: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
10185: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 10186: my $filesize = length($env{'form.'.$element});
10187: if (!$filesize) {
10188: my $msg = '<span class="LC_error">'.
10189: &mt('Unable to upload [_1]. (size = [_2] bytes)',
10190: '<span class="LC_filename">'.$fname.'</span>',
10191: $filesize).'<br />'.
1.1007 raeburn 10192: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 10193: '</span>';
10194: return ('zero_bytes',$msg);
10195: }
10196: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 10197: my $getpropath = 1;
1.1021 raeburn 10198: my ($dirlistref,$listerror) =
10199: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 10200: my $found_file = 0;
10201: my $locked_file = 0;
1.991 raeburn 10202: my @lockers;
10203: my $navmap;
10204: if ($env{'request.course.id'}) {
10205: $navmap = Apache::lonnavmaps::navmap->new();
10206: }
1.1021 raeburn 10207: if (ref($dirlistref) eq 'ARRAY') {
10208: foreach my $line (@{$dirlistref}) {
10209: my ($file_name,$rest)=split(/\&/,$line,2);
10210: if ($file_name eq $fname){
10211: $file_name = $path.$file_name;
10212: if ($group ne '') {
10213: $file_name = $group.$file_name;
10214: }
10215: $found_file = 1;
10216: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
10217: foreach my $lock (@lockers) {
10218: if (ref($lock) eq 'ARRAY') {
10219: my ($symb,$crsid) = @{$lock};
10220: if ($crsid eq $env{'request.course.id'}) {
10221: if (ref($navmap)) {
10222: my $res = $navmap->getBySymb($symb);
10223: foreach my $part (@{$res->parts()}) {
10224: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
10225: unless (($slot_status == $res->RESERVED) ||
10226: ($slot_status == $res->RESERVED_LOCATION)) {
10227: $locked_file = 1;
10228: }
1.991 raeburn 10229: }
1.1021 raeburn 10230: } else {
10231: $locked_file = 1;
1.991 raeburn 10232: }
10233: } else {
10234: $locked_file = 1;
10235: }
10236: }
1.1021 raeburn 10237: }
10238: } else {
10239: my @info = split(/\&/,$rest);
10240: my $currsize = $info[6]/1000;
10241: if ($currsize < $filesize) {
10242: my $extra = $filesize - $currsize;
10243: if (($current_disk_usage + $extra) > $disk_quota) {
10244: my $msg = '<span class="LC_error">'.
10245: &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.',
10246: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</span>'.
10247: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
10248: $disk_quota,$current_disk_usage);
10249: return ('will_exceed_quota',$msg);
10250: }
1.984 raeburn 10251: }
10252: }
1.661 raeburn 10253: }
10254: }
10255: }
10256: if (($current_disk_usage + $filesize) > $disk_quota){
10257: my $msg = '<span class="LC_error">'.
10258: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
10259: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
10260: return ('will_exceed_quota',$msg);
10261: } elsif ($found_file) {
10262: if ($locked_file) {
10263: my $msg = '<span class="LC_error">';
10264: $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>');
10265: $msg .= '</span><br />';
10266: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
10267: return ('file_locked',$msg);
10268: } else {
10269: my $msg = '<span class="LC_error">';
1.984 raeburn 10270: $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 10271: $msg .= '</span>';
1.984 raeburn 10272: return ('existingfile',$msg);
1.661 raeburn 10273: }
10274: }
10275: }
10276:
1.987 raeburn 10277: sub check_for_traversal {
10278: my ($path,$url,$toplevel) = @_;
10279: my @parts=split(/\//,$path);
10280: my $cleanpath;
10281: my $fullpath = $url;
10282: for (my $i=0;$i<@parts;$i++) {
10283: next if ($parts[$i] eq '.');
10284: if ($parts[$i] eq '..') {
10285: $fullpath =~ s{([^/]+/)$}{};
10286: } else {
10287: $fullpath .= $parts[$i].'/';
10288: }
10289: }
10290: if ($fullpath =~ /^\Q$url\E(.*)$/) {
10291: $cleanpath = $1;
10292: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
10293: my $curr_toprel = $1;
10294: my @parts = split(/\//,$curr_toprel);
10295: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
10296: my @urlparts = split(/\//,$url_toprel);
10297: my $doubledots;
10298: my $startdiff = -1;
10299: for (my $i=0; $i<@urlparts; $i++) {
10300: if ($startdiff == -1) {
10301: unless ($urlparts[$i] eq $parts[$i]) {
10302: $startdiff = $i;
10303: $doubledots .= '../';
10304: }
10305: } else {
10306: $doubledots .= '../';
10307: }
10308: }
10309: if ($startdiff > -1) {
10310: $cleanpath = $doubledots;
10311: for (my $i=$startdiff; $i<@parts; $i++) {
10312: $cleanpath .= $parts[$i].'/';
10313: }
10314: }
10315: }
10316: $cleanpath =~ s{(/)$}{};
10317: return $cleanpath;
10318: }
1.31 albertel 10319:
1.1053 raeburn 10320: sub is_archive_file {
10321: my ($mimetype) = @_;
10322: if (($mimetype eq 'application/octet-stream') ||
10323: ($mimetype eq 'application/x-stuffit') ||
10324: ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
10325: return 1;
10326: }
10327: return;
10328: }
10329:
10330: sub decompress_form {
1.1065 raeburn 10331: my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053 raeburn 10332: my %lt = &Apache::lonlocal::texthash (
10333: this => 'This file is an archive file.',
1.1067 raeburn 10334: camt => 'This file is a Camtasia archive file.',
1.1065 raeburn 10335: itsc => 'Its contents are as follows:',
1.1053 raeburn 10336: youm => 'You may wish to extract its contents.',
10337: extr => 'Extract contents',
1.1067 raeburn 10338: auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
10339: proa => 'Process automatically?',
1.1053 raeburn 10340: yes => 'Yes',
10341: no => 'No',
1.1067 raeburn 10342: fold => 'Title for folder containing movie',
10343: movi => 'Title for page containing embedded movie',
1.1053 raeburn 10344: );
1.1065 raeburn 10345: my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067 raeburn 10346: my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065 raeburn 10347: my $info = &list_archive_contents($fileloc,\@paths);
10348: if (@paths) {
10349: foreach my $path (@paths) {
10350: $path =~ s{^/}{};
1.1067 raeburn 10351: if ($path =~ m{^([^/]+)/$}) {
10352: $topdir = $1;
10353: }
1.1065 raeburn 10354: if ($path =~ m{^([^/]+)/}) {
10355: $toplevel{$1} = $path;
10356: } else {
10357: $toplevel{$path} = $path;
10358: }
10359: }
10360: }
1.1067 raeburn 10361: if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
10362: my @camtasia = ("$topdir/","$topdir/index.html",
10363: "$topdir/media/",
10364: "$topdir/media/$topdir.mp4",
10365: "$topdir/media/FirstFrame.png",
10366: "$topdir/media/player.swf",
10367: "$topdir/media/swfobject.js",
10368: "$topdir/media/expressInstall.swf");
10369: my @diffs = &compare_arrays(\@paths,\@camtasia);
10370: if (@diffs == 0) {
10371: $is_camtasia = 1;
10372: }
10373: }
10374: my $output;
10375: if ($is_camtasia) {
10376: $output = <<"ENDCAM";
10377: <script type="text/javascript" language="Javascript">
10378: // <![CDATA[
10379:
10380: function camtasiaToggle() {
10381: for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
10382: if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
10383: if (document.uploaded_decompress.autoextract_camtasia[i].value == 1) {
10384:
10385: document.getElementById('camtasia_titles').style.display='block';
10386: } else {
10387: document.getElementById('camtasia_titles').style.display='none';
10388: }
10389: }
10390: }
10391: return;
10392: }
10393:
10394: // ]]>
10395: </script>
10396: <p>$lt{'camt'}</p>
10397: ENDCAM
1.1065 raeburn 10398: } else {
1.1067 raeburn 10399: $output = '<p>'.$lt{'this'};
10400: if ($info eq '') {
10401: $output .= ' '.$lt{'youm'}.'</p>'."\n";
10402: } else {
10403: $output .= ' '.$lt{'itsc'}.'</p>'."\n".
10404: '<div><pre>'.$info.'</pre></div>';
10405: }
1.1065 raeburn 10406: }
1.1067 raeburn 10407: $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065 raeburn 10408: my $duplicates;
10409: my $num = 0;
10410: if (ref($dirlist) eq 'ARRAY') {
10411: foreach my $item (@{$dirlist}) {
10412: if (ref($item) eq 'ARRAY') {
10413: if (exists($toplevel{$item->[0]})) {
10414: $duplicates .=
10415: &start_data_table_row().
10416: '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
10417: 'value="0" checked="checked" />'.&mt('No').'</label>'.
10418: ' <label><input type="radio" name="archive_overwrite_'.$num.'" '.
10419: 'value="1" />'.&mt('Yes').'</label>'.
10420: '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
10421: '<td>'.$item->[0].'</td>';
10422: if ($item->[2]) {
10423: $duplicates .= '<td>'.&mt('Directory').'</td>';
10424: } else {
10425: $duplicates .= '<td>'.&mt('File').'</td>';
10426: }
10427: $duplicates .= '<td>'.$item->[3].'</td>'.
10428: '<td>'.
10429: &Apache::lonlocal::locallocaltime($item->[4]).
10430: '</td>'.
10431: &end_data_table_row();
10432: $num ++;
10433: }
10434: }
10435: }
10436: }
10437: my $itemcount;
10438: if (@paths > 0) {
10439: $itemcount = scalar(@paths);
10440: } else {
10441: $itemcount = 1;
10442: }
1.1067 raeburn 10443: if ($is_camtasia) {
10444: $output .= $lt{'auto'}.'<br />'.
10445: '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
10446: '<input type="radio" name="autoextract_camtasia" value="1" onclick="javascript:camtasiaToggle();" checked="checked" />'.
10447: $lt{'yes'}.'</label> <label>'.
10448: '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
10449: $lt{'no'}.'</label></span><br />'.
10450: '<div id="camtasia_titles" style="display:block">'.
10451: &Apache::lonhtmlcommon::start_pick_box().
10452: &Apache::lonhtmlcommon::row_title($lt{'fold'}).
10453: '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
10454: &Apache::lonhtmlcommon::row_closure().
10455: &Apache::lonhtmlcommon::row_title($lt{'movi'}).
10456: '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
10457: &Apache::lonhtmlcommon::row_closure(1).
10458: &Apache::lonhtmlcommon::end_pick_box().
10459: '</div>';
10460: }
1.1065 raeburn 10461: $output .=
10462: '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067 raeburn 10463: '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
10464: "\n";
1.1065 raeburn 10465: if ($duplicates ne '') {
10466: $output .= '<p><span class="LC_warning">'.
10467: &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.
10468: &start_data_table().
10469: &start_data_table_header_row().
10470: '<th>'.&mt('Overwrite?').'</th>'.
10471: '<th>'.&mt('Name').'</th>'.
10472: '<th>'.&mt('Type').'</th>'.
10473: '<th>'.&mt('Size').'</th>'.
10474: '<th>'.&mt('Last modified').'</th>'.
10475: &end_data_table_header_row().
10476: $duplicates.
10477: &end_data_table().
10478: '</p>';
10479: }
1.1067 raeburn 10480: $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053 raeburn 10481: if (ref($hiddenelements) eq 'HASH') {
10482: foreach my $hidden (sort(keys(%{$hiddenelements}))) {
10483: $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
10484: }
10485: }
10486: $output .= <<"END";
1.1067 raeburn 10487: <br />
1.1053 raeburn 10488: <input type="submit" name="decompress" value="$lt{'extr'}" />
10489: </form>
10490: $noextract
10491: END
10492: return $output;
10493: }
10494:
1.1065 raeburn 10495: sub decompression_utility {
10496: my ($program) = @_;
10497: my @utilities = ('tar','gunzip','bunzip2','unzip');
10498: my $location;
10499: if (grep(/^\Q$program\E$/,@utilities)) {
10500: foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
10501: '/usr/sbin/') {
10502: if (-x $dir.$program) {
10503: $location = $dir.$program;
10504: last;
10505: }
10506: }
10507: }
10508: return $location;
10509: }
10510:
10511: sub list_archive_contents {
10512: my ($file,$pathsref) = @_;
10513: my (@cmd,$output);
10514: my $needsregexp;
10515: if ($file =~ /\.zip$/) {
10516: @cmd = (&decompression_utility('unzip'),"-l");
10517: $needsregexp = 1;
10518: } elsif (($file =~ m/\.tar\.gz$/) ||
10519: ($file =~ /\.tgz$/)) {
10520: @cmd = (&decompression_utility('tar'),"-ztf");
10521: } elsif ($file =~ /\.tar\.bz2$/) {
10522: @cmd = (&decompression_utility('tar'),"-jtf");
10523: } elsif ($file =~ m|\.tar$|) {
10524: @cmd = (&decompression_utility('tar'),"-tf");
10525: }
10526: if (@cmd) {
10527: undef($!);
10528: undef($@);
10529: if (open(my $fh,"-|", @cmd, $file)) {
10530: while (my $line = <$fh>) {
10531: $output .= $line;
10532: chomp($line);
10533: my $item;
10534: if ($needsregexp) {
10535: ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/);
10536: } else {
10537: $item = $line;
10538: }
10539: if ($item ne '') {
10540: unless (grep(/^\Q$item\E$/,@{$pathsref})) {
10541: push(@{$pathsref},$item);
10542: }
10543: }
10544: }
10545: close($fh);
10546: }
10547: }
10548: return $output;
10549: }
10550:
1.1053 raeburn 10551: sub decompress_uploaded_file {
10552: my ($file,$dir) = @_;
10553: &Apache::lonnet::appenv({'cgi.file' => $file});
10554: &Apache::lonnet::appenv({'cgi.dir' => $dir});
10555: my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
10556: my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
10557: my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
10558: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
10559: my $decompressed = $env{'cgi.decompressed'};
10560: &Apache::lonnet::delenv('cgi.file');
10561: &Apache::lonnet::delenv('cgi.dir');
10562: &Apache::lonnet::delenv('cgi.decompressed');
10563: return ($decompressed,$result);
10564: }
10565:
1.1055 raeburn 10566: sub process_decompression {
10567: my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
10568: my ($dir,$error,$warning,$output);
10569: if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/) {
10570: $error = &mt('File name not a supported archive file type.').
10571: '<br />'.&mt('File name should end with one of: [_1].',
10572: '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
10573: } else {
10574: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
10575: if ($docuhome eq 'no_host') {
10576: $error = &mt('Could not determine home server for course.');
10577: } else {
10578: my @ids=&Apache::lonnet::current_machine_ids();
10579: my $currdir = "$dir_root/$destination";
10580: if (grep(/^\Q$docuhome\E$/,@ids)) {
10581: $dir = &LONCAPA::propath($docudom,$docuname).
10582: "$dir_root/$destination";
10583: } else {
10584: $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
10585: "$dir_root/$docudom/$docuname/$destination";
10586: unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
10587: $error = &mt('Archive file not found.');
10588: }
10589: }
1.1065 raeburn 10590: my (@to_overwrite,@to_skip);
10591: if ($env{'form.archive_overwrite_total'} > 0) {
10592: my $total = $env{'form.archive_overwrite_total'};
10593: for (my $i=0; $i<$total; $i++) {
10594: if ($env{'form.archive_overwrite_'.$i} == 1) {
10595: push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
10596: } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
10597: push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
10598: }
10599: }
10600: }
10601: my $numskip = scalar(@to_skip);
10602: if (($numskip > 0) &&
10603: ($numskip == $env{'form.archive_itemcount'})) {
10604: $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');
10605: } elsif ($dir eq '') {
1.1055 raeburn 10606: $error = &mt('Directory containing archive file unavailable.');
10607: } elsif (!$error) {
1.1065 raeburn 10608: my ($decompressed,$display);
10609: if ($numskip > 0) {
10610: my $tempdir = time.'_'.$$.int(rand(10000));
10611: mkdir("$dir/$tempdir",0755);
10612: system("mv $dir/$file $dir/$tempdir/$file");
10613: ($decompressed,$display) =
10614: &decompress_uploaded_file($file,"$dir/$tempdir");
10615: foreach my $item (@to_skip) {
10616: if (($item ne '') && ($item !~ /\.\./)) {
10617: if (-f "$dir/$tempdir/$item") {
10618: unlink("$dir/$tempdir/$item");
10619: } elsif (-d "$dir/$tempdir/$item") {
10620: system("rm -rf $dir/$tempdir/$item");
10621: }
10622: }
10623: }
10624: system("mv $dir/$tempdir/* $dir");
10625: rmdir("$dir/$tempdir");
10626: } else {
10627: ($decompressed,$display) =
10628: &decompress_uploaded_file($file,$dir);
10629: }
1.1055 raeburn 10630: if ($decompressed eq 'ok') {
1.1065 raeburn 10631: $output = '<p class="LC_info">'.
10632: &mt('Files extracted successfully from archive.').
10633: '</p>'."\n";
1.1055 raeburn 10634: my ($warning,$result,@contents);
10635: my ($newdirlistref,$newlisterror) =
10636: &Apache::lonnet::dirlist($currdir,$docudom,
10637: $docuname,1);
10638: my (%is_dir,%changes,@newitems);
10639: my $dirptr = 16384;
1.1065 raeburn 10640: if (ref($newdirlistref) eq 'ARRAY') {
1.1055 raeburn 10641: foreach my $dir_line (@{$newdirlistref}) {
10642: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1065 raeburn 10643: unless (($item =~ /^\.+$/) || ($item eq $file) ||
10644: ((@to_skip > 0) && (grep(/^\Q$item\E$/,@to_skip)))) {
1.1055 raeburn 10645: push(@newitems,$item);
10646: if ($dirptr&$testdir) {
10647: $is_dir{$item} = 1;
10648: }
10649: $changes{$item} = 1;
10650: }
10651: }
10652: }
10653: if (keys(%changes) > 0) {
10654: foreach my $item (sort(@newitems)) {
10655: if ($changes{$item}) {
10656: push(@contents,$item);
10657: }
10658: }
10659: }
10660: if (@contents > 0) {
1.1067 raeburn 10661: my $wantform;
10662: unless ($env{'form.autoextract_camtasia'}) {
10663: $wantform = 1;
10664: }
1.1056 raeburn 10665: my (%children,%parent,%dirorder,%titles);
1.1055 raeburn 10666: my ($count,$datatable) = &get_extracted($docudom,$docuname,
10667: $currdir,\%is_dir,
10668: \%children,\%parent,
1.1056 raeburn 10669: \@contents,\%dirorder,
10670: \%titles,$wantform);
1.1055 raeburn 10671: if ($datatable ne '') {
10672: $output .= &archive_options_form('decompressed',$datatable,
10673: $count,$hiddenelem);
1.1065 raeburn 10674: my $startcount = 6;
1.1055 raeburn 10675: $output .= &archive_javascript($startcount,$count,
1.1056 raeburn 10676: \%titles,\%children);
1.1055 raeburn 10677: }
1.1067 raeburn 10678: if ($env{'form.autoextract_camtasia'}) {
10679: my %displayed;
10680: my $total = 1;
10681: $env{'form.archive_directory'} = [];
10682: foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
10683: my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
10684: $path =~ s{/$}{};
10685: my $item;
10686: if ($path ne '') {
10687: $item = "$path/$titles{$i}";
10688: } else {
10689: $item = $titles{$i};
10690: }
10691: $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
10692: if ($item eq $contents[0]) {
10693: push(@{$env{'form.archive_directory'}},$i);
10694: $env{'form.archive_'.$i} = 'display';
10695: $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
10696: $displayed{'folder'} = $i;
10697: } elsif ($item eq "$contents[0]/index.html") {
10698: $env{'form.archive_'.$i} = 'display';
10699: $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
10700: $displayed{'web'} = $i;
10701: } else {
10702: if ($item eq "$contents[0]/media") {
10703: push(@{$env{'form.archive_directory'}},$i);
10704: }
10705: $env{'form.archive_'.$i} = 'dependency';
10706: }
10707: $total ++;
10708: }
10709: for (my $i=1; $i<$total; $i++) {
10710: next if ($i == $displayed{'web'});
10711: next if ($i == $displayed{'folder'});
10712: $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
10713: }
10714: $env{'form.phase'} = 'decompress_cleanup';
10715: $env{'form.archivedelete'} = 1;
10716: $env{'form.archive_count'} = $total-1;
10717: $output .=
10718: &process_extracted_files('coursedocs',$docudom,
10719: $docuname,$destination,
10720: $dir_root,$hiddenelem);
10721: }
1.1055 raeburn 10722: } else {
10723: $warning = &mt('No new items extracted from archive file.');
10724: }
10725: } else {
10726: $output = $display;
10727: $error = &mt('An error occurred during extraction from the archive file.');
10728: }
10729: }
10730: }
10731: }
10732: if ($error) {
10733: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
10734: $error.'</p>'."\n";
10735: }
10736: if ($warning) {
10737: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
10738: }
10739: return $output;
10740: }
10741:
10742: sub get_extracted {
1.1056 raeburn 10743: my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
10744: $titles,$wantform) = @_;
1.1055 raeburn 10745: my $count = 0;
10746: my $depth = 0;
10747: my $datatable;
1.1056 raeburn 10748: my @hierarchy;
1.1055 raeburn 10749: return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056 raeburn 10750: (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
10751: (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055 raeburn 10752: foreach my $item (@{$contents}) {
10753: $count ++;
1.1056 raeburn 10754: @{$dirorder->{$count}} = @hierarchy;
10755: $titles->{$count} = $item;
1.1055 raeburn 10756: &archive_hierarchy($depth,$count,$parent,$children);
10757: if ($wantform) {
10758: $datatable .= &archive_row($is_dir->{$item},$item,
10759: $currdir,$depth,$count);
10760: }
10761: if ($is_dir->{$item}) {
10762: $depth ++;
1.1056 raeburn 10763: push(@hierarchy,$count);
10764: $parent->{$depth} = $count;
1.1055 raeburn 10765: $datatable .=
10766: &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056 raeburn 10767: \$depth,\$count,\@hierarchy,$dirorder,
10768: $children,$parent,$titles,$wantform);
1.1055 raeburn 10769: $depth --;
1.1056 raeburn 10770: pop(@hierarchy);
1.1055 raeburn 10771: }
10772: }
10773: return ($count,$datatable);
10774: }
10775:
10776: sub recurse_extracted_archive {
1.1056 raeburn 10777: my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
10778: $children,$parent,$titles,$wantform) = @_;
1.1055 raeburn 10779: my $result='';
1.1056 raeburn 10780: unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
10781: (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
10782: (ref($dirorder) eq 'HASH')) {
1.1055 raeburn 10783: return $result;
10784: }
10785: my $dirptr = 16384;
10786: my ($newdirlistref,$newlisterror) =
10787: &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
10788: if (ref($newdirlistref) eq 'ARRAY') {
10789: foreach my $dir_line (@{$newdirlistref}) {
10790: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
10791: unless ($item =~ /^\.+$/) {
10792: $$count ++;
1.1056 raeburn 10793: @{$dirorder->{$$count}} = @{$hierarchy};
10794: $titles->{$$count} = $item;
1.1055 raeburn 10795: &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056 raeburn 10796:
1.1055 raeburn 10797: my $is_dir;
10798: if ($dirptr&$testdir) {
10799: $is_dir = 1;
10800: }
10801: if ($wantform) {
10802: $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
10803: }
10804: if ($is_dir) {
10805: $$depth ++;
1.1056 raeburn 10806: push(@{$hierarchy},$$count);
10807: $parent->{$$depth} = $$count;
1.1055 raeburn 10808: $result .=
10809: &recurse_extracted_archive("$currdir/$item",$docudom,
10810: $docuname,$depth,$count,
1.1056 raeburn 10811: $hierarchy,$dirorder,$children,
10812: $parent,$titles,$wantform);
1.1055 raeburn 10813: $$depth --;
1.1056 raeburn 10814: pop(@{$hierarchy});
1.1055 raeburn 10815: }
10816: }
10817: }
10818: }
10819: return $result;
10820: }
10821:
10822: sub archive_hierarchy {
10823: my ($depth,$count,$parent,$children) =@_;
10824: if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
10825: if (exists($parent->{$depth})) {
10826: $children->{$parent->{$depth}} .= $count.':';
10827: }
10828: }
10829: return;
10830: }
10831:
10832: sub archive_row {
10833: my ($is_dir,$item,$currdir,$depth,$count) = @_;
10834: my ($name) = ($item =~ m{([^/]+)$});
10835: my %choices = &Apache::lonlocal::texthash (
1.1059 raeburn 10836: 'display' => 'Add as file',
1.1055 raeburn 10837: 'dependency' => 'Include as dependency',
10838: 'discard' => 'Discard',
10839: );
10840: if ($is_dir) {
1.1059 raeburn 10841: $choices{'display'} = &mt('Add as folder');
1.1055 raeburn 10842: }
1.1056 raeburn 10843: my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
10844: my $offset = 0;
1.1055 raeburn 10845: foreach my $action ('display','dependency','discard') {
1.1056 raeburn 10846: $offset ++;
1.1065 raeburn 10847: if ($action ne 'display') {
10848: $offset ++;
10849: }
1.1055 raeburn 10850: $output .= '<td><span class="LC_nobreak">'.
10851: '<label><input type="radio" name="archive_'.$count.
10852: '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
10853: my $text = $choices{$action};
10854: if ($is_dir) {
10855: $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
10856: if ($action eq 'display') {
1.1059 raeburn 10857: $text = &mt('Add as folder');
1.1055 raeburn 10858: }
1.1056 raeburn 10859: } else {
10860: $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
10861:
10862: }
10863: $output .= ' /> '.$choices{$action}.'</label></span>';
10864: if ($action eq 'dependency') {
10865: $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
10866: &mt('Used by:').' <select name="archive_dependent_on_'.$count.'" '.
10867: 'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
10868: '<option value=""></option>'."\n".
10869: '</select>'."\n".
10870: '</div>';
1.1059 raeburn 10871: } elsif ($action eq 'display') {
10872: $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
10873: &mt('Title:').' <input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
10874: '</div>';
1.1055 raeburn 10875: }
1.1056 raeburn 10876: $output .= '</td>';
1.1055 raeburn 10877: }
10878: $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
10879: &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.(' ' x 2);
10880: for (my $i=0; $i<$depth; $i++) {
10881: $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
10882: }
10883: if ($is_dir) {
10884: $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" /> '."\n".
10885: '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
10886: } else {
10887: $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
10888: }
10889: $output .= ' '.$name.'</td>'."\n".
10890: &end_data_table_row();
10891: return $output;
10892: }
10893:
10894: sub archive_options_form {
1.1065 raeburn 10895: my ($form,$display,$count,$hiddenelem) = @_;
10896: my %lt = &Apache::lonlocal::texthash(
10897: perm => 'Permanently remove archive file?',
10898: hows => 'How should each extracted item be incorporated in the course?',
10899: cont => 'Content actions for all',
10900: addf => 'Add as folder/file',
10901: incd => 'Include as dependency for a displayed file',
10902: disc => 'Discard',
10903: no => 'No',
10904: yes => 'Yes',
10905: save => 'Save',
10906: );
10907: my $output = <<"END";
10908: <form name="$form" method="post" action="">
10909: <p><span class="LC_nobreak">$lt{'perm'}
10910: <label>
10911: <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
10912: </label>
10913:
10914: <label>
10915: <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
10916: </span>
10917: </p>
10918: <input type="hidden" name="phase" value="decompress_cleanup" />
10919: <br />$lt{'hows'}
10920: <div class="LC_columnSection">
10921: <fieldset>
10922: <legend>$lt{'cont'}</legend>
10923: <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" />
10924: <input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
10925: <input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
10926: </fieldset>
10927: </div>
10928: END
10929: return $output.
1.1055 raeburn 10930: &start_data_table()."\n".
1.1065 raeburn 10931: $display."\n".
1.1055 raeburn 10932: &end_data_table()."\n".
10933: '<input type="hidden" name="archive_count" value="'.$count.'" />'.
10934: $hiddenelem.
1.1065 raeburn 10935: '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055 raeburn 10936: '</form>';
10937: }
10938:
10939: sub archive_javascript {
1.1056 raeburn 10940: my ($startcount,$numitems,$titles,$children) = @_;
10941: return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059 raeburn 10942: my $maintitle = $env{'form.comment'};
1.1055 raeburn 10943: my $scripttag = <<START;
10944: <script type="text/javascript">
10945: // <![CDATA[
10946:
10947: function checkAll(form,prefix) {
10948: var idstr = new RegExp("^archive_"+prefix+"_\\\\d+\$");
10949: for (var i=0; i < form.elements.length; i++) {
10950: var id = form.elements[i].id;
10951: if ((id != '') && (id != undefined)) {
10952: if (idstr.test(id)) {
10953: if (form.elements[i].type == 'radio') {
10954: form.elements[i].checked = true;
1.1056 raeburn 10955: var nostart = i-$startcount;
1.1059 raeburn 10956: var offset = nostart%7;
10957: var count = (nostart-offset)/7;
1.1056 raeburn 10958: dependencyCheck(form,count,offset);
1.1055 raeburn 10959: }
10960: }
10961: }
10962: }
10963: }
10964:
10965: function propagateCheck(form,count) {
10966: if (count > 0) {
1.1059 raeburn 10967: var startelement = $startcount + ((count-1) * 7);
10968: for (var j=1; j<6; j++) {
10969: if ((j != 2) && (j != 4)) {
1.1056 raeburn 10970: var item = startelement + j;
10971: if (form.elements[item].type == 'radio') {
10972: if (form.elements[item].checked) {
10973: containerCheck(form,count,j);
10974: break;
10975: }
1.1055 raeburn 10976: }
10977: }
10978: }
10979: }
10980: }
10981:
10982: numitems = $numitems
1.1056 raeburn 10983: var titles = new Array(numitems);
10984: var parents = new Array(numitems);
1.1055 raeburn 10985: for (var i=0; i<numitems; i++) {
1.1056 raeburn 10986: parents[i] = new Array;
1.1055 raeburn 10987: }
1.1059 raeburn 10988: var maintitle = '$maintitle';
1.1055 raeburn 10989:
10990: START
10991:
1.1056 raeburn 10992: foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
10993: my @contents = split(/:/,$children->{$container});
1.1055 raeburn 10994: for (my $i=0; $i<@contents; $i ++) {
10995: $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
10996: }
10997: }
10998:
1.1056 raeburn 10999: foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
11000: $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
11001: }
11002:
1.1055 raeburn 11003: $scripttag .= <<END;
11004:
11005: function containerCheck(form,count,offset) {
11006: if (count > 0) {
1.1056 raeburn 11007: dependencyCheck(form,count,offset);
1.1059 raeburn 11008: var item = (offset+$startcount)+7*(count-1);
1.1055 raeburn 11009: form.elements[item].checked = true;
11010: if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
11011: if (parents[count].length > 0) {
11012: for (var j=0; j<parents[count].length; j++) {
1.1056 raeburn 11013: containerCheck(form,parents[count][j],offset);
11014: }
11015: }
11016: }
11017: }
11018: }
11019:
11020: function dependencyCheck(form,count,offset) {
11021: if (count > 0) {
1.1059 raeburn 11022: var chosen = (offset+$startcount)+7*(count-1);
11023: var depitem = $startcount + ((count-1) * 7) + 4;
1.1056 raeburn 11024: var currtype = form.elements[depitem].type;
11025: if (form.elements[chosen].value == 'dependency') {
11026: document.getElementById('arc_depon_'+count).style.display='block';
11027: form.elements[depitem].options.length = 0;
11028: form.elements[depitem].options[0] = new Option('Select','',true,true);
11029: for (var i=1; i<count; i++) {
1.1059 raeburn 11030: var startelement = $startcount + (i-1) * 7;
11031: for (var j=1; j<6; j++) {
11032: if ((j != 2) && (j!= 4)) {
1.1056 raeburn 11033: var item = startelement + j;
11034: if (form.elements[item].type == 'radio') {
11035: if (form.elements[item].checked) {
11036: if (form.elements[item].value == 'display') {
11037: var n = form.elements[depitem].options.length;
11038: form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
11039: }
11040: }
11041: }
11042: }
11043: }
11044: }
11045: } else {
11046: document.getElementById('arc_depon_'+count).style.display='none';
11047: form.elements[depitem].options.length = 0;
11048: form.elements[depitem].options[0] = new Option('Select','',true,true);
11049: }
1.1059 raeburn 11050: titleCheck(form,count,offset);
1.1056 raeburn 11051: }
11052: }
11053:
11054: function propagateSelect(form,count,offset) {
11055: if (count > 0) {
1.1065 raeburn 11056: var item = (1+offset+$startcount)+7*(count-1);
1.1056 raeburn 11057: var picked = form.elements[item].options[form.elements[item].selectedIndex].value;
11058: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
11059: if (parents[count].length > 0) {
11060: for (var j=0; j<parents[count].length; j++) {
11061: containerSelect(form,parents[count][j],offset,picked);
1.1055 raeburn 11062: }
11063: }
11064: }
11065: }
11066: }
1.1056 raeburn 11067:
11068: function containerSelect(form,count,offset,picked) {
11069: if (count > 0) {
1.1065 raeburn 11070: var item = (offset+$startcount)+7*(count-1);
1.1056 raeburn 11071: if (form.elements[item].type == 'radio') {
11072: if (form.elements[item].value == 'dependency') {
11073: if (form.elements[item+1].type == 'select-one') {
11074: for (var i=0; i<form.elements[item+1].options.length; i++) {
11075: if (form.elements[item+1].options[i].value == picked) {
11076: form.elements[item+1].selectedIndex = i;
11077: break;
11078: }
11079: }
11080: }
11081: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
11082: if (parents[count].length > 0) {
11083: for (var j=0; j<parents[count].length; j++) {
11084: containerSelect(form,parents[count][j],offset,picked);
11085: }
11086: }
11087: }
11088: }
11089: }
11090: }
11091: }
11092:
1.1059 raeburn 11093: function titleCheck(form,count,offset) {
11094: if (count > 0) {
11095: var chosen = (offset+$startcount)+7*(count-1);
11096: var depitem = $startcount + ((count-1) * 7) + 2;
11097: var currtype = form.elements[depitem].type;
11098: if (form.elements[chosen].value == 'display') {
11099: document.getElementById('arc_title_'+count).style.display='block';
11100: if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
11101: document.getElementById('archive_title_'+count).value=maintitle;
11102: }
11103: } else {
11104: document.getElementById('arc_title_'+count).style.display='none';
11105: if (currtype == 'text') {
11106: document.getElementById('archive_title_'+count).value='';
11107: }
11108: }
11109: }
11110: return;
11111: }
11112:
1.1055 raeburn 11113: // ]]>
11114: </script>
11115: END
11116: return $scripttag;
11117: }
11118:
11119: sub process_extracted_files {
1.1067 raeburn 11120: my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055 raeburn 11121: my $numitems = $env{'form.archive_count'};
11122: return unless ($numitems);
11123: my @ids=&Apache::lonnet::current_machine_ids();
11124: my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067 raeburn 11125: %folders,%containers,%mapinner,%prompttofetch);
1.1055 raeburn 11126: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
11127: if (grep(/^\Q$docuhome\E$/,@ids)) {
11128: $prefix = &LONCAPA::propath($docudom,$docuname);
11129: $pathtocheck = "$dir_root/$destination";
11130: $dir = $dir_root;
11131: $ishome = 1;
11132: } else {
11133: $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
11134: $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
11135: $dir = "$dir_root/$docudom/$docuname";
11136: }
11137: my $currdir = "$dir_root/$destination";
11138: (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
11139: if ($env{'form.folderpath'}) {
11140: my @items = split('&',$env{'form.folderpath'});
11141: $folders{'0'} = $items[-2];
11142: $containers{'0'}='sequence';
11143: } elsif ($env{'form.pagepath'}) {
11144: my @items = split('&',$env{'form.pagepath'});
11145: $folders{'0'} = $items[-2];
11146: $containers{'0'}='page';
11147: }
11148: my @archdirs = &get_env_multiple('form.archive_directory');
11149: if ($numitems) {
11150: for (my $i=1; $i<=$numitems; $i++) {
11151: my $path = $env{'form.archive_content_'.$i};
11152: if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
11153: my $item = $1;
11154: $toplevelitems{$item} = $i;
11155: if (grep(/^\Q$i\E$/,@archdirs)) {
11156: $is_dir{$item} = 1;
11157: }
11158: }
11159: }
11160: }
1.1067 raeburn 11161: my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055 raeburn 11162: if (keys(%toplevelitems) > 0) {
11163: my @contents = sort(keys(%toplevelitems));
1.1056 raeburn 11164: (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
11165: \%parent,\@contents,\%dirorder,\%titles);
1.1055 raeburn 11166: }
1.1066 raeburn 11167: my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055 raeburn 11168: if ($numitems) {
11169: for (my $i=1; $i<=$numitems; $i++) {
11170: my $path = $env{'form.archive_content_'.$i};
11171: if ($path =~ /^\Q$pathtocheck\E/) {
11172: if ($env{'form.archive_'.$i} eq 'discard') {
11173: if ($prefix ne '' && $path ne '') {
11174: if (-e $prefix.$path) {
1.1066 raeburn 11175: if ((@archdirs > 0) &&
11176: (grep(/^\Q$i\E$/,@archdirs))) {
11177: $todeletedir{$prefix.$path} = 1;
11178: } else {
11179: $todelete{$prefix.$path} = 1;
11180: }
1.1055 raeburn 11181: }
11182: }
11183: } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059 raeburn 11184: my ($docstitle,$title,$url,$outer);
1.1055 raeburn 11185: ($title) = ($path =~ m{/([^/]+)$});
1.1059 raeburn 11186: $docstitle = $env{'form.archive_title_'.$i};
11187: if ($docstitle eq '') {
11188: $docstitle = $title;
11189: }
1.1055 raeburn 11190: $outer = 0;
1.1056 raeburn 11191: if (ref($dirorder{$i}) eq 'ARRAY') {
11192: if (@{$dirorder{$i}} > 0) {
11193: foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055 raeburn 11194: if ($env{'form.archive_'.$item} eq 'display') {
11195: $outer = $item;
11196: last;
11197: }
11198: }
11199: }
11200: }
11201: my ($errtext,$fatal) =
11202: &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
11203: '/'.$folders{$outer}.'.'.
11204: $containers{$outer});
11205: next if ($fatal);
11206: if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
11207: if ($context eq 'coursedocs') {
1.1056 raeburn 11208: $mapinner{$i} = time;
1.1055 raeburn 11209: $folders{$i} = 'default_'.$mapinner{$i};
11210: $containers{$i} = 'sequence';
11211: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
11212: $folders{$i}.'.'.$containers{$i};
11213: my $newidx = &LONCAPA::map::getresidx();
11214: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 11215: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 11216: push(@LONCAPA::map::order,$newidx);
11217: my ($outtext,$errtext) =
11218: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
11219: $docuname.'/'.$folders{$outer}.
11220: '.'.$containers{$outer},1);
1.1056 raeburn 11221: $newseqid{$i} = $newidx;
1.1067 raeburn 11222: unless ($errtext) {
11223: $result .= '<li>'.&mt('Folder: [_1] added to course',$docstitle).'</li>'."\n";
11224: }
1.1055 raeburn 11225: }
11226: } else {
11227: if ($context eq 'coursedocs') {
11228: my $newidx=&LONCAPA::map::getresidx();
11229: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
11230: $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
11231: $title;
11232: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
11233: mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
11234: }
11235: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
11236: mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
11237: }
11238: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
11239: system("mv $prefix$path $prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title");
1.1056 raeburn 11240: $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
1.1067 raeburn 11241: unless ($ishome) {
11242: my $fetch = "$newdest{$i}/$title";
11243: $fetch =~ s/^\Q$prefix$dir\E//;
11244: $prompttofetch{$fetch} = 1;
11245: }
1.1055 raeburn 11246: }
11247: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 11248: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 11249: push(@LONCAPA::map::order, $newidx);
11250: my ($outtext,$errtext)=
11251: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
11252: $docuname.'/'.$folders{$outer}.
11253: '.'.$containers{$outer},1);
1.1067 raeburn 11254: unless ($errtext) {
11255: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
11256: $result .= '<li>'.&mt('File: [_1] added to course',$docstitle).'</li>'."\n";
11257: }
11258: }
1.1055 raeburn 11259: }
11260: }
11261: } elsif ($env{'form.archive_'.$i} eq 'dependency') {
1.1056 raeburn 11262: my ($title) = ($path =~ m{/([^/]+)$});
11263: $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
11264: if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
11265: if (ref($dirorder{$i}) eq 'ARRAY') {
1.1067 raeburn 11266: my ($itemidx,$fullpath,$relpath);
1.1056 raeburn 11267: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
11268: if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
11269: my $container = $dirorder{$referrer{$i}}->[-1];
11270: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
11271: if ($dirorder{$i}->[$j] eq $container) {
11272: $itemidx = $j;
11273: }
11274: }
11275: }
11276: }
11277: if ($itemidx ne '') {
11278: if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
11279: if ($mapinner{$referrer{$i}}) {
11280: $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
11281: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
11282: if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
11283: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
11284: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
1.1067 raeburn 11285: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
1.1056 raeburn 11286: if (!-e $fullpath) {
11287: mkdir($fullpath,0755);
11288: }
11289: }
11290: } else {
11291: last;
11292: }
11293: }
11294: }
11295: } elsif ($newdest{$referrer{$i}}) {
11296: $fullpath = $newdest{$referrer{$i}};
11297: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
11298: if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
11299: $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
11300: last;
11301: } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
11302: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
11303: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
1.1067 raeburn 11304: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
1.1056 raeburn 11305: if (!-e $fullpath) {
11306: mkdir($fullpath,0755);
11307: }
11308: }
11309: } else {
11310: last;
11311: }
11312: }
11313: }
11314: if ($fullpath ne '') {
1.1067 raeburn 11315: if (-e "$prefix$path") {
11316: system("mv $prefix$path $fullpath/$title");
11317: }
11318: if (-e "$fullpath/$title") {
11319: my $showpath;
11320: if ($relpath ne '') {
11321: $showpath = "$relpath/$title";
11322: } else {
11323: $showpath = "/$title";
11324: }
11325: $result .= '<li>'.&mt('[_1] included as a dependency',$showpath).'</li>'."\n";
11326: }
11327: unless ($ishome) {
11328: my $fetch = "$fullpath/$title";
11329: $fetch =~ s/^\Q$prefix$dir\E//;
11330: $prompttofetch{$fetch} = 1;
11331: }
1.1056 raeburn 11332: }
1.1055 raeburn 11333: }
11334: }
1.1056 raeburn 11335: } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
11336: $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
11337: $path,$env{'form.archive_content_'.$referrer{$i}}).'<br />';
1.1055 raeburn 11338: }
11339: }
11340: } else {
11341: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',$path).'<br />';
11342: }
11343: }
11344: if (keys(%todelete)) {
11345: foreach my $key (keys(%todelete)) {
11346: unlink($key);
1.1066 raeburn 11347: }
11348: }
11349: if (keys(%todeletedir)) {
11350: foreach my $key (keys(%todeletedir)) {
11351: rmdir($key);
11352: }
11353: }
11354: foreach my $dir (sort(keys(%is_dir))) {
11355: if (($pathtocheck ne '') && ($dir ne '')) {
11356: &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055 raeburn 11357: }
11358: }
1.1067 raeburn 11359: if ($result ne '') {
11360: $output .= '<ul>'."\n".
11361: $result."\n".
11362: '</ul>';
11363: }
11364: unless ($ishome) {
11365: my $replicationfail;
11366: foreach my $item (keys(%prompttofetch)) {
11367: my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
11368: unless ($fetchresult eq 'ok') {
11369: $replicationfail .= '<li>'.$item.'</li>'."\n";
11370: }
11371: }
11372: if ($replicationfail) {
11373: $output .= '<p class="LC_error">'.
11374: &mt('Course home server failed to retrieve:').'<ul>'.
11375: $replicationfail.
11376: '</ul></p>';
11377: }
11378: }
1.1055 raeburn 11379: } else {
11380: $warning = &mt('No items found in archive.');
11381: }
11382: if ($error) {
11383: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
11384: $error.'</p>'."\n";
11385: }
11386: if ($warning) {
11387: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
11388: }
11389: return $output;
11390: }
11391:
1.1066 raeburn 11392: sub cleanup_empty_dirs {
11393: my ($path) = @_;
11394: if (($path ne '') && (-d $path)) {
11395: if (opendir(my $dirh,$path)) {
11396: my @dircontents = grep(!/^\./,readdir($dirh));
11397: my $numitems = 0;
11398: foreach my $item (@dircontents) {
11399: if (-d "$path/$item") {
11400: &recurse_dirs("$path/$item");
11401: if (-e "$path/$item") {
11402: $numitems ++;
11403: }
11404: } else {
11405: $numitems ++;
11406: }
11407: }
11408: if ($numitems == 0) {
11409: rmdir($path);
11410: }
11411: closedir($dirh);
11412: }
11413: }
11414: return;
11415: }
11416:
1.41 ng 11417: =pod
1.45 matthew 11418:
1.1068 raeburn 11419: =item &get_folder_hierarchy()
11420:
11421: Provides hierarchy of names of folders/sub-folders containing the current
11422: item,
11423:
11424: Inputs: 3
11425: - $navmap - navmaps object
11426:
11427: - $map - url for map (either the trigger itself, or map containing
11428: the resource, which is the trigger).
11429:
11430: - $showitem - 1 => show title for map itself; 0 => do not show.
11431:
11432: Outputs: 1 @pathitems - array of folder/subfolder names.
11433:
11434: =cut
11435:
11436: sub get_folder_hierarchy {
11437: my ($navmap,$map,$showitem) = @_;
11438: my @pathitems;
11439: if (ref($navmap)) {
11440: my $mapres = $navmap->getResourceByUrl($map);
11441: if (ref($mapres)) {
11442: my $pcslist = $mapres->map_hierarchy();
11443: if ($pcslist ne '') {
11444: my @pcs = split(/,/,$pcslist);
11445: foreach my $pc (@pcs) {
11446: if ($pc == 1) {
11447: push(@pathitems,&mt('Main Course Documents'));
11448: } else {
11449: my $res = $navmap->getByMapPc($pc);
11450: if (ref($res)) {
11451: my $title = $res->compTitle();
11452: $title =~ s/\W+/_/g;
11453: if ($title ne '') {
11454: push(@pathitems,$title);
11455: }
11456: }
11457: }
11458: }
11459: }
1.1071 raeburn 11460: if ($showitem) {
11461: if ($mapres->{ID} eq '0.0') {
11462: push(@pathitems,&mt('Main Course Documents'));
11463: } else {
11464: my $maptitle = $mapres->compTitle();
11465: $maptitle =~ s/\W+/_/g;
11466: if ($maptitle ne '') {
11467: push(@pathitems,$maptitle);
11468: }
1.1068 raeburn 11469: }
11470: }
11471: }
11472: }
11473: return @pathitems;
11474: }
11475:
11476: =pod
11477:
1.1015 raeburn 11478: =item * &get_turnedin_filepath()
11479:
11480: Determines path in a user's portfolio file for storage of files uploaded
11481: to a specific essayresponse or dropbox item.
11482:
11483: Inputs: 3 required + 1 optional.
11484: $symb is symb for resource, $uname and $udom are for current user (required).
11485: $caller is optional (can be "submission", if routine is called when storing
11486: an upoaded file when "Submit Answer" button was pressed).
11487:
11488: Returns array containing $path and $multiresp.
11489: $path is path in portfolio. $multiresp is 1 if this resource contains more
11490: than one file upload item. Callers of routine should append partid as a
11491: subdirectory to $path in cases where $multiresp is 1.
11492:
11493: Called by: homework/essayresponse.pm and homework/structuretags.pm
11494:
11495: =cut
11496:
11497: sub get_turnedin_filepath {
11498: my ($symb,$uname,$udom,$caller) = @_;
11499: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
11500: my $turnindir;
11501: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
11502: $turnindir = $userhash{'turnindir'};
11503: my ($path,$multiresp);
11504: if ($turnindir eq '') {
11505: if ($caller eq 'submission') {
11506: $turnindir = &mt('turned in');
11507: $turnindir =~ s/\W+/_/g;
11508: my %newhash = (
11509: 'turnindir' => $turnindir,
11510: );
11511: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
11512: }
11513: }
11514: if ($turnindir ne '') {
11515: $path = '/'.$turnindir.'/';
11516: my ($multipart,$turnin,@pathitems);
11517: my $navmap = Apache::lonnavmaps::navmap->new();
11518: if (defined($navmap)) {
11519: my $mapres = $navmap->getResourceByUrl($map);
11520: if (ref($mapres)) {
11521: my $pcslist = $mapres->map_hierarchy();
11522: if ($pcslist ne '') {
11523: foreach my $pc (split(/,/,$pcslist)) {
11524: my $res = $navmap->getByMapPc($pc);
11525: if (ref($res)) {
11526: my $title = $res->compTitle();
11527: $title =~ s/\W+/_/g;
11528: if ($title ne '') {
11529: push(@pathitems,$title);
11530: }
11531: }
11532: }
11533: }
11534: my $maptitle = $mapres->compTitle();
11535: $maptitle =~ s/\W+/_/g;
11536: if ($maptitle ne '') {
11537: push(@pathitems,$maptitle);
11538: }
11539: unless ($env{'request.state'} eq 'construct') {
11540: my $res = $navmap->getBySymb($symb);
11541: if (ref($res)) {
11542: my $partlist = $res->parts();
11543: my $totaluploads = 0;
11544: if (ref($partlist) eq 'ARRAY') {
11545: foreach my $part (@{$partlist}) {
11546: my @types = $res->responseType($part);
11547: my @ids = $res->responseIds($part);
11548: for (my $i=0; $i < scalar(@ids); $i++) {
11549: if ($types[$i] eq 'essay') {
11550: my $partid = $part.'_'.$ids[$i];
11551: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
11552: $totaluploads ++;
11553: }
11554: }
11555: }
11556: }
11557: if ($totaluploads > 1) {
11558: $multiresp = 1;
11559: }
11560: }
11561: }
11562: }
11563: } else {
11564: return;
11565: }
11566: } else {
11567: return;
11568: }
11569: my $restitle=&Apache::lonnet::gettitle($symb);
11570: $restitle =~ s/\W+/_/g;
11571: if ($restitle eq '') {
11572: $restitle = ($resurl =~ m{/[^/]+$});
11573: if ($restitle eq '') {
11574: $restitle = time;
11575: }
11576: }
11577: push(@pathitems,$restitle);
11578: $path .= join('/',@pathitems);
11579: }
11580: return ($path,$multiresp);
11581: }
11582:
11583: =pod
11584:
1.464 albertel 11585: =back
1.41 ng 11586:
1.112 bowersj2 11587: =head1 CSV Upload/Handling functions
1.38 albertel 11588:
1.41 ng 11589: =over 4
11590:
1.648 raeburn 11591: =item * &upfile_store($r)
1.41 ng 11592:
11593: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 11594: needs $env{'form.upfile'}
1.41 ng 11595: returns $datatoken to be put into hidden field
11596:
11597: =cut
1.31 albertel 11598:
11599: sub upfile_store {
11600: my $r=shift;
1.258 albertel 11601: $env{'form.upfile'}=~s/\r/\n/gs;
11602: $env{'form.upfile'}=~s/\f/\n/gs;
11603: $env{'form.upfile'}=~s/\n+/\n/gs;
11604: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 11605:
1.258 albertel 11606: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
11607: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 11608: {
1.158 raeburn 11609: my $datafile = $r->dir_config('lonDaemons').
11610: '/tmp/'.$datatoken.'.tmp';
11611: if ( open(my $fh,">$datafile") ) {
1.258 albertel 11612: print $fh $env{'form.upfile'};
1.158 raeburn 11613: close($fh);
11614: }
1.31 albertel 11615: }
11616: return $datatoken;
11617: }
11618:
1.56 matthew 11619: =pod
11620:
1.648 raeburn 11621: =item * &load_tmp_file($r)
1.41 ng 11622:
11623: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 11624: needs $env{'form.datatoken'},
11625: sets $env{'form.upfile'} to the contents of the file
1.41 ng 11626:
11627: =cut
1.31 albertel 11628:
11629: sub load_tmp_file {
11630: my $r=shift;
11631: my @studentdata=();
11632: {
1.158 raeburn 11633: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 11634: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 11635: if ( open(my $fh,"<$studentfile") ) {
11636: @studentdata=<$fh>;
11637: close($fh);
11638: }
1.31 albertel 11639: }
1.258 albertel 11640: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 11641: }
11642:
1.56 matthew 11643: =pod
11644:
1.648 raeburn 11645: =item * &upfile_record_sep()
1.41 ng 11646:
11647: Separate uploaded file into records
11648: returns array of records,
1.258 albertel 11649: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 11650:
11651: =cut
1.31 albertel 11652:
11653: sub upfile_record_sep {
1.258 albertel 11654: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 11655: } else {
1.248 albertel 11656: my @records;
1.258 albertel 11657: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 11658: if ($line=~/^\s*$/) { next; }
11659: push(@records,$line);
11660: }
11661: return @records;
1.31 albertel 11662: }
11663: }
11664:
1.56 matthew 11665: =pod
11666:
1.648 raeburn 11667: =item * &record_sep($record)
1.41 ng 11668:
1.258 albertel 11669: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 11670:
11671: =cut
11672:
1.263 www 11673: sub takeleft {
11674: my $index=shift;
11675: return substr('0000'.$index,-4,4);
11676: }
11677:
1.31 albertel 11678: sub record_sep {
11679: my $record=shift;
11680: my %components=();
1.258 albertel 11681: if ($env{'form.upfiletype'} eq 'xml') {
11682: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 11683: my $i=0;
1.356 albertel 11684: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 11685: $field=~s/^(\"|\')//;
11686: $field=~s/(\"|\')$//;
1.263 www 11687: $components{&takeleft($i)}=$field;
1.31 albertel 11688: $i++;
11689: }
1.258 albertel 11690: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 11691: my $i=0;
1.356 albertel 11692: foreach my $field (split(/\t/,$record)) {
1.31 albertel 11693: $field=~s/^(\"|\')//;
11694: $field=~s/(\"|\')$//;
1.263 www 11695: $components{&takeleft($i)}=$field;
1.31 albertel 11696: $i++;
11697: }
11698: } else {
1.561 www 11699: my $separator=',';
1.480 banghart 11700: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 11701: $separator=';';
1.480 banghart 11702: }
1.31 albertel 11703: my $i=0;
1.561 www 11704: # the character we are looking for to indicate the end of a quote or a record
11705: my $looking_for=$separator;
11706: # do not add the characters to the fields
11707: my $ignore=0;
11708: # we just encountered a separator (or the beginning of the record)
11709: my $just_found_separator=1;
11710: # store the field we are working on here
11711: my $field='';
11712: # work our way through all characters in record
11713: foreach my $character ($record=~/(.)/g) {
11714: if ($character eq $looking_for) {
11715: if ($character ne $separator) {
11716: # Found the end of a quote, again looking for separator
11717: $looking_for=$separator;
11718: $ignore=1;
11719: } else {
11720: # Found a separator, store away what we got
11721: $components{&takeleft($i)}=$field;
11722: $i++;
11723: $just_found_separator=1;
11724: $ignore=0;
11725: $field='';
11726: }
11727: next;
11728: }
11729: # single or double quotation marks after a separator indicate beginning of a quote
11730: # we are now looking for the end of the quote and need to ignore separators
11731: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
11732: $looking_for=$character;
11733: next;
11734: }
11735: # ignore would be true after we reached the end of a quote
11736: if ($ignore) { next; }
11737: if (($just_found_separator) && ($character=~/\s/)) { next; }
11738: $field.=$character;
11739: $just_found_separator=0;
1.31 albertel 11740: }
1.561 www 11741: # catch the very last entry, since we never encountered the separator
11742: $components{&takeleft($i)}=$field;
1.31 albertel 11743: }
11744: return %components;
11745: }
11746:
1.144 matthew 11747: ######################################################
11748: ######################################################
11749:
1.56 matthew 11750: =pod
11751:
1.648 raeburn 11752: =item * &upfile_select_html()
1.41 ng 11753:
1.144 matthew 11754: Return HTML code to select a file from the users machine and specify
11755: the file type.
1.41 ng 11756:
11757: =cut
11758:
1.144 matthew 11759: ######################################################
11760: ######################################################
1.31 albertel 11761: sub upfile_select_html {
1.144 matthew 11762: my %Types = (
11763: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 11764: semisv => &mt('Semicolon separated values'),
1.144 matthew 11765: space => &mt('Space separated'),
11766: tab => &mt('Tabulator separated'),
11767: # xml => &mt('HTML/XML'),
11768: );
11769: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 11770: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 11771: foreach my $type (sort(keys(%Types))) {
11772: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
11773: }
11774: $Str .= "</select>\n";
11775: return $Str;
1.31 albertel 11776: }
11777:
1.301 albertel 11778: sub get_samples {
11779: my ($records,$toget) = @_;
11780: my @samples=({});
11781: my $got=0;
11782: foreach my $rec (@$records) {
11783: my %temp = &record_sep($rec);
11784: if (! grep(/\S/, values(%temp))) { next; }
11785: if (%temp) {
11786: $samples[$got]=\%temp;
11787: $got++;
11788: if ($got == $toget) { last; }
11789: }
11790: }
11791: return \@samples;
11792: }
11793:
1.144 matthew 11794: ######################################################
11795: ######################################################
11796:
1.56 matthew 11797: =pod
11798:
1.648 raeburn 11799: =item * &csv_print_samples($r,$records)
1.41 ng 11800:
11801: Prints a table of sample values from each column uploaded $r is an
11802: Apache Request ref, $records is an arrayref from
11803: &Apache::loncommon::upfile_record_sep
11804:
11805: =cut
11806:
1.144 matthew 11807: ######################################################
11808: ######################################################
1.31 albertel 11809: sub csv_print_samples {
11810: my ($r,$records) = @_;
1.662 bisitz 11811: my $samples = &get_samples($records,5);
1.301 albertel 11812:
1.594 raeburn 11813: $r->print(&mt('Samples').'<br />'.&start_data_table().
11814: &start_data_table_header_row());
1.356 albertel 11815: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 11816: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 11817: $r->print(&end_data_table_header_row());
1.301 albertel 11818: foreach my $hash (@$samples) {
1.594 raeburn 11819: $r->print(&start_data_table_row());
1.356 albertel 11820: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 11821: $r->print('<td>');
1.356 albertel 11822: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 11823: $r->print('</td>');
11824: }
1.594 raeburn 11825: $r->print(&end_data_table_row());
1.31 albertel 11826: }
1.594 raeburn 11827: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 11828: }
11829:
1.144 matthew 11830: ######################################################
11831: ######################################################
11832:
1.56 matthew 11833: =pod
11834:
1.648 raeburn 11835: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 11836:
11837: Prints a table to create associations between values and table columns.
1.144 matthew 11838:
1.41 ng 11839: $r is an Apache Request ref,
11840: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 11841: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 11842:
11843: =cut
11844:
1.144 matthew 11845: ######################################################
11846: ######################################################
1.31 albertel 11847: sub csv_print_select_table {
11848: my ($r,$records,$d) = @_;
1.301 albertel 11849: my $i=0;
11850: my $samples = &get_samples($records,1);
1.144 matthew 11851: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 11852: &start_data_table().&start_data_table_header_row().
1.144 matthew 11853: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 11854: '<th>'.&mt('Column').'</th>'.
11855: &end_data_table_header_row()."\n");
1.356 albertel 11856: foreach my $array_ref (@$d) {
11857: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 11858: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 11859:
1.875 bisitz 11860: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 11861: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 11862: $r->print('<option value="none"></option>');
1.356 albertel 11863: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
11864: $r->print('<option value="'.$sample.'"'.
11865: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 11866: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 11867: }
1.594 raeburn 11868: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 11869: $i++;
11870: }
1.594 raeburn 11871: $r->print(&end_data_table());
1.31 albertel 11872: $i--;
11873: return $i;
11874: }
1.56 matthew 11875:
1.144 matthew 11876: ######################################################
11877: ######################################################
11878:
1.56 matthew 11879: =pod
1.31 albertel 11880:
1.648 raeburn 11881: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 11882:
11883: Prints a table of sample values from the upload and can make associate samples to internal names.
11884:
11885: $r is an Apache Request ref,
11886: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
11887: $d is an array of 2 element arrays (internal name, displayed name)
11888:
11889: =cut
11890:
1.144 matthew 11891: ######################################################
11892: ######################################################
1.31 albertel 11893: sub csv_samples_select_table {
11894: my ($r,$records,$d) = @_;
11895: my $i=0;
1.144 matthew 11896: #
1.662 bisitz 11897: my $max_samples = 5;
11898: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 11899: $r->print(&start_data_table().
11900: &start_data_table_header_row().'<th>'.
11901: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
11902: &end_data_table_header_row());
1.301 albertel 11903:
11904: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 11905: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 11906: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 11907: foreach my $option (@$d) {
11908: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 11909: $r->print('<option value="'.$value.'"'.
1.253 albertel 11910: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 11911: $display.'</option>');
1.31 albertel 11912: }
11913: $r->print('</select></td><td>');
1.662 bisitz 11914: foreach my $line (0..($max_samples-1)) {
1.301 albertel 11915: if (defined($samples->[$line]{$key})) {
11916: $r->print($samples->[$line]{$key}."<br />\n");
11917: }
11918: }
1.594 raeburn 11919: $r->print('</td>'.&end_data_table_row());
1.31 albertel 11920: $i++;
11921: }
1.594 raeburn 11922: $r->print(&end_data_table());
1.31 albertel 11923: $i--;
11924: return($i);
1.115 matthew 11925: }
11926:
1.144 matthew 11927: ######################################################
11928: ######################################################
11929:
1.115 matthew 11930: =pod
11931:
1.648 raeburn 11932: =item * &clean_excel_name($name)
1.115 matthew 11933:
11934: Returns a replacement for $name which does not contain any illegal characters.
11935:
11936: =cut
11937:
1.144 matthew 11938: ######################################################
11939: ######################################################
1.115 matthew 11940: sub clean_excel_name {
11941: my ($name) = @_;
11942: $name =~ s/[:\*\?\/\\]//g;
11943: if (length($name) > 31) {
11944: $name = substr($name,0,31);
11945: }
11946: return $name;
1.25 albertel 11947: }
1.84 albertel 11948:
1.85 albertel 11949: =pod
11950:
1.648 raeburn 11951: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 11952:
11953: Returns either 1 or undef
11954:
11955: 1 if the part is to be hidden, undef if it is to be shown
11956:
11957: Arguments are:
11958:
11959: $id the id of the part to be checked
11960: $symb, optional the symb of the resource to check
11961: $udom, optional the domain of the user to check for
11962: $uname, optional the username of the user to check for
11963:
11964: =cut
1.84 albertel 11965:
11966: sub check_if_partid_hidden {
11967: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 11968: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 11969: $symb,$udom,$uname);
1.141 albertel 11970: my $truth=1;
11971: #if the string starts with !, then the list is the list to show not hide
11972: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 11973: my @hiddenlist=split(/,/,$hiddenparts);
11974: foreach my $checkid (@hiddenlist) {
1.141 albertel 11975: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 11976: }
1.141 albertel 11977: return !$truth;
1.84 albertel 11978: }
1.127 matthew 11979:
1.138 matthew 11980:
11981: ############################################################
11982: ############################################################
11983:
11984: =pod
11985:
1.157 matthew 11986: =back
11987:
1.138 matthew 11988: =head1 cgi-bin script and graphing routines
11989:
1.157 matthew 11990: =over 4
11991:
1.648 raeburn 11992: =item * &get_cgi_id()
1.138 matthew 11993:
11994: Inputs: none
11995:
11996: Returns an id which can be used to pass environment variables
11997: to various cgi-bin scripts. These environment variables will
11998: be removed from the users environment after a given time by
11999: the routine &Apache::lonnet::transfer_profile_to_env.
12000:
12001: =cut
12002:
12003: ############################################################
12004: ############################################################
1.152 albertel 12005: my $uniq=0;
1.136 matthew 12006: sub get_cgi_id {
1.154 albertel 12007: $uniq=($uniq+1)%100000;
1.280 albertel 12008: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 12009: }
12010:
1.127 matthew 12011: ############################################################
12012: ############################################################
12013:
12014: =pod
12015:
1.648 raeburn 12016: =item * &DrawBarGraph()
1.127 matthew 12017:
1.138 matthew 12018: Facilitates the plotting of data in a (stacked) bar graph.
12019: Puts plot definition data into the users environment in order for
12020: graph.png to plot it. Returns an <img> tag for the plot.
12021: The bars on the plot are labeled '1','2',...,'n'.
12022:
12023: Inputs:
12024:
12025: =over 4
12026:
12027: =item $Title: string, the title of the plot
12028:
12029: =item $xlabel: string, text describing the X-axis of the plot
12030:
12031: =item $ylabel: string, text describing the Y-axis of the plot
12032:
12033: =item $Max: scalar, the maximum Y value to use in the plot
12034: If $Max is < any data point, the graph will not be rendered.
12035:
1.140 matthew 12036: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 12037: they are plotted. If undefined, default values will be used.
12038:
1.178 matthew 12039: =item $labels: array ref holding the labels to use on the x-axis for the bars.
12040:
1.138 matthew 12041: =item @Values: An array of array references. Each array reference holds data
12042: to be plotted in a stacked bar chart.
12043:
1.239 matthew 12044: =item If the final element of @Values is a hash reference the key/value
12045: pairs will be added to the graph definition.
12046:
1.138 matthew 12047: =back
12048:
12049: Returns:
12050:
12051: An <img> tag which references graph.png and the appropriate identifying
12052: information for the plot.
12053:
1.127 matthew 12054: =cut
12055:
12056: ############################################################
12057: ############################################################
1.134 matthew 12058: sub DrawBarGraph {
1.178 matthew 12059: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 12060: #
12061: if (! defined($colors)) {
12062: $colors = ['#33ff00',
12063: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
12064: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
12065: ];
12066: }
1.228 matthew 12067: my $extra_settings = {};
12068: if (ref($Values[-1]) eq 'HASH') {
12069: $extra_settings = pop(@Values);
12070: }
1.127 matthew 12071: #
1.136 matthew 12072: my $identifier = &get_cgi_id();
12073: my $id = 'cgi.'.$identifier;
1.129 matthew 12074: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 12075: return '';
12076: }
1.225 matthew 12077: #
12078: my @Labels;
12079: if (defined($labels)) {
12080: @Labels = @$labels;
12081: } else {
12082: for (my $i=0;$i<@{$Values[0]};$i++) {
12083: push (@Labels,$i+1);
12084: }
12085: }
12086: #
1.129 matthew 12087: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 12088: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 12089: my %ValuesHash;
12090: my $NumSets=1;
12091: foreach my $array (@Values) {
12092: next if (! ref($array));
1.136 matthew 12093: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 12094: join(',',@$array);
1.129 matthew 12095: }
1.127 matthew 12096: #
1.136 matthew 12097: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 12098: if ($NumBars < 3) {
12099: $width = 120+$NumBars*32;
1.220 matthew 12100: $xskip = 1;
1.225 matthew 12101: $bar_width = 30;
12102: } elsif ($NumBars < 5) {
12103: $width = 120+$NumBars*20;
12104: $xskip = 1;
12105: $bar_width = 20;
1.220 matthew 12106: } elsif ($NumBars < 10) {
1.136 matthew 12107: $width = 120+$NumBars*15;
12108: $xskip = 1;
12109: $bar_width = 15;
12110: } elsif ($NumBars <= 25) {
12111: $width = 120+$NumBars*11;
12112: $xskip = 5;
12113: $bar_width = 8;
12114: } elsif ($NumBars <= 50) {
12115: $width = 120+$NumBars*8;
12116: $xskip = 5;
12117: $bar_width = 4;
12118: } else {
12119: $width = 120+$NumBars*8;
12120: $xskip = 5;
12121: $bar_width = 4;
12122: }
12123: #
1.137 matthew 12124: $Max = 1 if ($Max < 1);
12125: if ( int($Max) < $Max ) {
12126: $Max++;
12127: $Max = int($Max);
12128: }
1.127 matthew 12129: $Title = '' if (! defined($Title));
12130: $xlabel = '' if (! defined($xlabel));
12131: $ylabel = '' if (! defined($ylabel));
1.369 www 12132: $ValuesHash{$id.'.title'} = &escape($Title);
12133: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
12134: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 12135: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 12136: $ValuesHash{$id.'.NumBars'} = $NumBars;
12137: $ValuesHash{$id.'.NumSets'} = $NumSets;
12138: $ValuesHash{$id.'.PlotType'} = 'bar';
12139: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
12140: $ValuesHash{$id.'.height'} = $height;
12141: $ValuesHash{$id.'.width'} = $width;
12142: $ValuesHash{$id.'.xskip'} = $xskip;
12143: $ValuesHash{$id.'.bar_width'} = $bar_width;
12144: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 12145: #
1.228 matthew 12146: # Deal with other parameters
12147: while (my ($key,$value) = each(%$extra_settings)) {
12148: $ValuesHash{$id.'.'.$key} = $value;
12149: }
12150: #
1.646 raeburn 12151: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 12152: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
12153: }
12154:
12155: ############################################################
12156: ############################################################
12157:
12158: =pod
12159:
1.648 raeburn 12160: =item * &DrawXYGraph()
1.137 matthew 12161:
1.138 matthew 12162: Facilitates the plotting of data in an XY graph.
12163: Puts plot definition data into the users environment in order for
12164: graph.png to plot it. Returns an <img> tag for the plot.
12165:
12166: Inputs:
12167:
12168: =over 4
12169:
12170: =item $Title: string, the title of the plot
12171:
12172: =item $xlabel: string, text describing the X-axis of the plot
12173:
12174: =item $ylabel: string, text describing the Y-axis of the plot
12175:
12176: =item $Max: scalar, the maximum Y value to use in the plot
12177: If $Max is < any data point, the graph will not be rendered.
12178:
12179: =item $colors: Array ref containing the hex color codes for the data to be
12180: plotted in. If undefined, default values will be used.
12181:
12182: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
12183:
12184: =item $Ydata: Array ref containing Array refs.
1.185 www 12185: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 12186:
12187: =item %Values: hash indicating or overriding any default values which are
12188: passed to graph.png.
12189: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
12190:
12191: =back
12192:
12193: Returns:
12194:
12195: An <img> tag which references graph.png and the appropriate identifying
12196: information for the plot.
12197:
1.137 matthew 12198: =cut
12199:
12200: ############################################################
12201: ############################################################
12202: sub DrawXYGraph {
12203: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
12204: #
12205: # Create the identifier for the graph
12206: my $identifier = &get_cgi_id();
12207: my $id = 'cgi.'.$identifier;
12208: #
12209: $Title = '' if (! defined($Title));
12210: $xlabel = '' if (! defined($xlabel));
12211: $ylabel = '' if (! defined($ylabel));
12212: my %ValuesHash =
12213: (
1.369 www 12214: $id.'.title' => &escape($Title),
12215: $id.'.xlabel' => &escape($xlabel),
12216: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 12217: $id.'.y_max_value'=> $Max,
12218: $id.'.labels' => join(',',@$Xlabels),
12219: $id.'.PlotType' => 'XY',
12220: );
12221: #
12222: if (defined($colors) && ref($colors) eq 'ARRAY') {
12223: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
12224: }
12225: #
12226: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
12227: return '';
12228: }
12229: my $NumSets=1;
1.138 matthew 12230: foreach my $array (@{$Ydata}){
1.137 matthew 12231: next if (! ref($array));
12232: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
12233: }
1.138 matthew 12234: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 12235: #
12236: # Deal with other parameters
12237: while (my ($key,$value) = each(%Values)) {
12238: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 12239: }
12240: #
1.646 raeburn 12241: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 12242: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
12243: }
12244:
12245: ############################################################
12246: ############################################################
12247:
12248: =pod
12249:
1.648 raeburn 12250: =item * &DrawXYYGraph()
1.138 matthew 12251:
12252: Facilitates the plotting of data in an XY graph with two Y axes.
12253: Puts plot definition data into the users environment in order for
12254: graph.png to plot it. Returns an <img> tag for the plot.
12255:
12256: Inputs:
12257:
12258: =over 4
12259:
12260: =item $Title: string, the title of the plot
12261:
12262: =item $xlabel: string, text describing the X-axis of the plot
12263:
12264: =item $ylabel: string, text describing the Y-axis of the plot
12265:
12266: =item $colors: Array ref containing the hex color codes for the data to be
12267: plotted in. If undefined, default values will be used.
12268:
12269: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
12270:
12271: =item $Ydata1: The first data set
12272:
12273: =item $Min1: The minimum value of the left Y-axis
12274:
12275: =item $Max1: The maximum value of the left Y-axis
12276:
12277: =item $Ydata2: The second data set
12278:
12279: =item $Min2: The minimum value of the right Y-axis
12280:
12281: =item $Max2: The maximum value of the left Y-axis
12282:
12283: =item %Values: hash indicating or overriding any default values which are
12284: passed to graph.png.
12285: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
12286:
12287: =back
12288:
12289: Returns:
12290:
12291: An <img> tag which references graph.png and the appropriate identifying
12292: information for the plot.
1.136 matthew 12293:
12294: =cut
12295:
12296: ############################################################
12297: ############################################################
1.137 matthew 12298: sub DrawXYYGraph {
12299: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
12300: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 12301: #
12302: # Create the identifier for the graph
12303: my $identifier = &get_cgi_id();
12304: my $id = 'cgi.'.$identifier;
12305: #
12306: $Title = '' if (! defined($Title));
12307: $xlabel = '' if (! defined($xlabel));
12308: $ylabel = '' if (! defined($ylabel));
12309: my %ValuesHash =
12310: (
1.369 www 12311: $id.'.title' => &escape($Title),
12312: $id.'.xlabel' => &escape($xlabel),
12313: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 12314: $id.'.labels' => join(',',@$Xlabels),
12315: $id.'.PlotType' => 'XY',
12316: $id.'.NumSets' => 2,
1.137 matthew 12317: $id.'.two_axes' => 1,
12318: $id.'.y1_max_value' => $Max1,
12319: $id.'.y1_min_value' => $Min1,
12320: $id.'.y2_max_value' => $Max2,
12321: $id.'.y2_min_value' => $Min2,
1.136 matthew 12322: );
12323: #
1.137 matthew 12324: if (defined($colors) && ref($colors) eq 'ARRAY') {
12325: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
12326: }
12327: #
12328: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
12329: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 12330: return '';
12331: }
12332: my $NumSets=1;
1.137 matthew 12333: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 12334: next if (! ref($array));
12335: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 12336: }
12337: #
12338: # Deal with other parameters
12339: while (my ($key,$value) = each(%Values)) {
12340: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 12341: }
12342: #
1.646 raeburn 12343: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 12344: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 12345: }
12346:
12347: ############################################################
12348: ############################################################
12349:
12350: =pod
12351:
1.157 matthew 12352: =back
12353:
1.139 matthew 12354: =head1 Statistics helper routines?
12355:
12356: Bad place for them but what the hell.
12357:
1.157 matthew 12358: =over 4
12359:
1.648 raeburn 12360: =item * &chartlink()
1.139 matthew 12361:
12362: Returns a link to the chart for a specific student.
12363:
12364: Inputs:
12365:
12366: =over 4
12367:
12368: =item $linktext: The text of the link
12369:
12370: =item $sname: The students username
12371:
12372: =item $sdomain: The students domain
12373:
12374: =back
12375:
1.157 matthew 12376: =back
12377:
1.139 matthew 12378: =cut
12379:
12380: ############################################################
12381: ############################################################
12382: sub chartlink {
12383: my ($linktext, $sname, $sdomain) = @_;
12384: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 12385: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 12386: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 12387: '">'.$linktext.'</a>';
1.153 matthew 12388: }
12389:
12390: #######################################################
12391: #######################################################
12392:
12393: =pod
12394:
12395: =head1 Course Environment Routines
1.157 matthew 12396:
12397: =over 4
1.153 matthew 12398:
1.648 raeburn 12399: =item * &restore_course_settings()
1.153 matthew 12400:
1.648 raeburn 12401: =item * &store_course_settings()
1.153 matthew 12402:
12403: Restores/Store indicated form parameters from the course environment.
12404: Will not overwrite existing values of the form parameters.
12405:
12406: Inputs:
12407: a scalar describing the data (e.g. 'chart', 'problem_analysis')
12408:
12409: a hash ref describing the data to be stored. For example:
12410:
12411: %Save_Parameters = ('Status' => 'scalar',
12412: 'chartoutputmode' => 'scalar',
12413: 'chartoutputdata' => 'scalar',
12414: 'Section' => 'array',
1.373 raeburn 12415: 'Group' => 'array',
1.153 matthew 12416: 'StudentData' => 'array',
12417: 'Maps' => 'array');
12418:
12419: Returns: both routines return nothing
12420:
1.631 raeburn 12421: =back
12422:
1.153 matthew 12423: =cut
12424:
12425: #######################################################
12426: #######################################################
12427: sub store_course_settings {
1.496 albertel 12428: return &store_settings($env{'request.course.id'},@_);
12429: }
12430:
12431: sub store_settings {
1.153 matthew 12432: # save to the environment
12433: # appenv the same items, just to be safe
1.300 albertel 12434: my $udom = $env{'user.domain'};
12435: my $uname = $env{'user.name'};
1.496 albertel 12436: my ($context,$prefix,$Settings) = @_;
1.153 matthew 12437: my %SaveHash;
12438: my %AppHash;
12439: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 12440: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 12441: my $envname = 'environment.'.$basename;
1.258 albertel 12442: if (exists($env{'form.'.$setting})) {
1.153 matthew 12443: # Save this value away
12444: if ($type eq 'scalar' &&
1.258 albertel 12445: (! exists($env{$envname}) ||
12446: $env{$envname} ne $env{'form.'.$setting})) {
12447: $SaveHash{$basename} = $env{'form.'.$setting};
12448: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 12449: } elsif ($type eq 'array') {
12450: my $stored_form;
1.258 albertel 12451: if (ref($env{'form.'.$setting})) {
1.153 matthew 12452: $stored_form = join(',',
12453: map {
1.369 www 12454: &escape($_);
1.258 albertel 12455: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 12456: } else {
12457: $stored_form =
1.369 www 12458: &escape($env{'form.'.$setting});
1.153 matthew 12459: }
12460: # Determine if the array contents are the same.
1.258 albertel 12461: if ($stored_form ne $env{$envname}) {
1.153 matthew 12462: $SaveHash{$basename} = $stored_form;
12463: $AppHash{$envname} = $stored_form;
12464: }
12465: }
12466: }
12467: }
12468: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 12469: $udom,$uname);
1.153 matthew 12470: if ($put_result !~ /^(ok|delayed)/) {
12471: &Apache::lonnet::logthis('unable to save form parameters, '.
12472: 'got error:'.$put_result);
12473: }
12474: # Make sure these settings stick around in this session, too
1.646 raeburn 12475: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 12476: return;
12477: }
12478:
12479: sub restore_course_settings {
1.499 albertel 12480: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 12481: }
12482:
12483: sub restore_settings {
12484: my ($context,$prefix,$Settings) = @_;
1.153 matthew 12485: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 12486: next if (exists($env{'form.'.$setting}));
1.496 albertel 12487: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 12488: '.'.$setting;
1.258 albertel 12489: if (exists($env{$envname})) {
1.153 matthew 12490: if ($type eq 'scalar') {
1.258 albertel 12491: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 12492: } elsif ($type eq 'array') {
1.258 albertel 12493: $env{'form.'.$setting} = [
1.153 matthew 12494: map {
1.369 www 12495: &unescape($_);
1.258 albertel 12496: } split(',',$env{$envname})
1.153 matthew 12497: ];
12498: }
12499: }
12500: }
1.127 matthew 12501: }
12502:
1.618 raeburn 12503: #######################################################
12504: #######################################################
12505:
12506: =pod
12507:
12508: =head1 Domain E-mail Routines
12509:
12510: =over 4
12511:
1.648 raeburn 12512: =item * &build_recipient_list()
1.618 raeburn 12513:
1.884 raeburn 12514: Build recipient lists for five types of e-mail:
1.766 raeburn 12515: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884 raeburn 12516: (d) Help requests, (e) Course requests needing approval, generated by
12517: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
12518: loncoursequeueadmin.pm respectively.
1.618 raeburn 12519:
12520: Inputs:
1.619 raeburn 12521: defmail (scalar - email address of default recipient),
1.618 raeburn 12522: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 12523: defdom (domain for which to retrieve configuration settings),
12524: origmail (scalar - email address of recipient from loncapa.conf,
12525: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 12526:
1.655 raeburn 12527: Returns: comma separated list of addresses to which to send e-mail.
12528:
12529: =back
1.618 raeburn 12530:
12531: =cut
12532:
12533: ############################################################
12534: ############################################################
12535: sub build_recipient_list {
1.619 raeburn 12536: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 12537: my @recipients;
12538: my $otheremails;
12539: my %domconfig =
12540: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
12541: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 12542: if (exists($domconfig{'contacts'}{$mailing})) {
12543: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
12544: my @contacts = ('adminemail','supportemail');
12545: foreach my $item (@contacts) {
12546: if ($domconfig{'contacts'}{$mailing}{$item}) {
12547: my $addr = $domconfig{'contacts'}{$item};
12548: if (!grep(/^\Q$addr\E$/,@recipients)) {
12549: push(@recipients,$addr);
12550: }
1.619 raeburn 12551: }
1.766 raeburn 12552: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 12553: }
12554: }
1.766 raeburn 12555: } elsif ($origmail ne '') {
12556: push(@recipients,$origmail);
1.618 raeburn 12557: }
1.619 raeburn 12558: } elsif ($origmail ne '') {
12559: push(@recipients,$origmail);
1.618 raeburn 12560: }
1.688 raeburn 12561: if (defined($defmail)) {
12562: if ($defmail ne '') {
12563: push(@recipients,$defmail);
12564: }
1.618 raeburn 12565: }
12566: if ($otheremails) {
1.619 raeburn 12567: my @others;
12568: if ($otheremails =~ /,/) {
12569: @others = split(/,/,$otheremails);
1.618 raeburn 12570: } else {
1.619 raeburn 12571: push(@others,$otheremails);
12572: }
12573: foreach my $addr (@others) {
12574: if (!grep(/^\Q$addr\E$/,@recipients)) {
12575: push(@recipients,$addr);
12576: }
1.618 raeburn 12577: }
12578: }
1.619 raeburn 12579: my $recipientlist = join(',',@recipients);
1.618 raeburn 12580: return $recipientlist;
12581: }
12582:
1.127 matthew 12583: ############################################################
12584: ############################################################
1.154 albertel 12585:
1.655 raeburn 12586: =pod
12587:
12588: =head1 Course Catalog Routines
12589:
12590: =over 4
12591:
12592: =item * &gather_categories()
12593:
12594: Converts category definitions - keys of categories hash stored in
12595: coursecategories in configuration.db on the primary library server in a
12596: domain - to an array. Also generates javascript and idx hash used to
12597: generate Domain Coordinator interface for editing Course Categories.
12598:
12599: Inputs:
1.663 raeburn 12600:
1.655 raeburn 12601: categories (reference to hash of category definitions).
1.663 raeburn 12602:
1.655 raeburn 12603: cats (reference to array of arrays/hashes which encapsulates hierarchy of
12604: categories and subcategories).
1.663 raeburn 12605:
1.655 raeburn 12606: idx (reference to hash of counters used in Domain Coordinator interface for
12607: editing Course Categories).
1.663 raeburn 12608:
1.655 raeburn 12609: jsarray (reference to array of categories used to create Javascript arrays for
12610: Domain Coordinator interface for editing Course Categories).
12611:
12612: Returns: nothing
12613:
12614: Side effects: populates cats, idx and jsarray.
12615:
12616: =cut
12617:
12618: sub gather_categories {
12619: my ($categories,$cats,$idx,$jsarray) = @_;
12620: my %counters;
12621: my $num = 0;
12622: foreach my $item (keys(%{$categories})) {
12623: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
12624: if ($container eq '' && $depth == 0) {
12625: $cats->[$depth][$categories->{$item}] = $cat;
12626: } else {
12627: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
12628: }
12629: my ($escitem,$tail) = split(/:/,$item,2);
12630: if ($counters{$tail} eq '') {
12631: $counters{$tail} = $num;
12632: $num ++;
12633: }
12634: if (ref($idx) eq 'HASH') {
12635: $idx->{$item} = $counters{$tail};
12636: }
12637: if (ref($jsarray) eq 'ARRAY') {
12638: push(@{$jsarray->[$counters{$tail}]},$item);
12639: }
12640: }
12641: return;
12642: }
12643:
12644: =pod
12645:
12646: =item * &extract_categories()
12647:
12648: Used to generate breadcrumb trails for course categories.
12649:
12650: Inputs:
1.663 raeburn 12651:
1.655 raeburn 12652: categories (reference to hash of category definitions).
1.663 raeburn 12653:
1.655 raeburn 12654: cats (reference to array of arrays/hashes which encapsulates hierarchy of
12655: categories and subcategories).
1.663 raeburn 12656:
1.655 raeburn 12657: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 12658:
1.655 raeburn 12659: allitems (reference to hash - key is category key
12660: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 12661:
1.655 raeburn 12662: idx (reference to hash of counters used in Domain Coordinator interface for
12663: editing Course Categories).
1.663 raeburn 12664:
1.655 raeburn 12665: jsarray (reference to array of categories used to create Javascript arrays for
12666: Domain Coordinator interface for editing Course Categories).
12667:
1.665 raeburn 12668: subcats (reference to hash of arrays containing all subcategories within each
12669: category, -recursive)
12670:
1.655 raeburn 12671: Returns: nothing
12672:
12673: Side effects: populates trails and allitems hash references.
12674:
12675: =cut
12676:
12677: sub extract_categories {
1.665 raeburn 12678: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 12679: if (ref($categories) eq 'HASH') {
12680: &gather_categories($categories,$cats,$idx,$jsarray);
12681: if (ref($cats->[0]) eq 'ARRAY') {
12682: for (my $i=0; $i<@{$cats->[0]}; $i++) {
12683: my $name = $cats->[0][$i];
12684: my $item = &escape($name).'::0';
12685: my $trailstr;
12686: if ($name eq 'instcode') {
12687: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 12688: } elsif ($name eq 'communities') {
12689: $trailstr = &mt('Communities');
1.655 raeburn 12690: } else {
12691: $trailstr = $name;
12692: }
12693: if ($allitems->{$item} eq '') {
12694: push(@{$trails},$trailstr);
12695: $allitems->{$item} = scalar(@{$trails})-1;
12696: }
12697: my @parents = ($name);
12698: if (ref($cats->[1]{$name}) eq 'ARRAY') {
12699: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
12700: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 12701: if (ref($subcats) eq 'HASH') {
12702: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
12703: }
12704: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
12705: }
12706: } else {
12707: if (ref($subcats) eq 'HASH') {
12708: $subcats->{$item} = [];
1.655 raeburn 12709: }
12710: }
12711: }
12712: }
12713: }
12714: return;
12715: }
12716:
12717: =pod
12718:
12719: =item *&recurse_categories()
12720:
12721: Recursively used to generate breadcrumb trails for course categories.
12722:
12723: Inputs:
1.663 raeburn 12724:
1.655 raeburn 12725: cats (reference to array of arrays/hashes which encapsulates hierarchy of
12726: categories and subcategories).
1.663 raeburn 12727:
1.655 raeburn 12728: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 12729:
12730: category (current course category, for which breadcrumb trail is being generated).
12731:
12732: trails (reference to array of breadcrumb trails for each category).
12733:
1.655 raeburn 12734: allitems (reference to hash - key is category key
12735: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 12736:
1.655 raeburn 12737: parents (array containing containers directories for current category,
12738: back to top level).
12739:
12740: Returns: nothing
12741:
12742: Side effects: populates trails and allitems hash references
12743:
12744: =cut
12745:
12746: sub recurse_categories {
1.665 raeburn 12747: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 12748: my $shallower = $depth - 1;
12749: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
12750: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
12751: my $name = $cats->[$depth]{$category}[$k];
12752: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
12753: my $trailstr = join(' -> ',(@{$parents},$category));
12754: if ($allitems->{$item} eq '') {
12755: push(@{$trails},$trailstr);
12756: $allitems->{$item} = scalar(@{$trails})-1;
12757: }
12758: my $deeper = $depth+1;
12759: push(@{$parents},$category);
1.665 raeburn 12760: if (ref($subcats) eq 'HASH') {
12761: my $subcat = &escape($name).':'.$category.':'.$depth;
12762: for (my $j=@{$parents}; $j>=0; $j--) {
12763: my $higher;
12764: if ($j > 0) {
12765: $higher = &escape($parents->[$j]).':'.
12766: &escape($parents->[$j-1]).':'.$j;
12767: } else {
12768: $higher = &escape($parents->[$j]).'::'.$j;
12769: }
12770: push(@{$subcats->{$higher}},$subcat);
12771: }
12772: }
12773: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
12774: $subcats);
1.655 raeburn 12775: pop(@{$parents});
12776: }
12777: } else {
12778: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
12779: my $trailstr = join(' -> ',(@{$parents},$category));
12780: if ($allitems->{$item} eq '') {
12781: push(@{$trails},$trailstr);
12782: $allitems->{$item} = scalar(@{$trails})-1;
12783: }
12784: }
12785: return;
12786: }
12787:
1.663 raeburn 12788: =pod
12789:
12790: =item *&assign_categories_table()
12791:
12792: Create a datatable for display of hierarchical categories in a domain,
12793: with checkboxes to allow a course to be categorized.
12794:
12795: Inputs:
12796:
12797: cathash - reference to hash of categories defined for the domain (from
12798: configuration.db)
12799:
12800: currcat - scalar with an & separated list of categories assigned to a course.
12801:
1.919 raeburn 12802: type - scalar contains course type (Course or Community).
12803:
1.663 raeburn 12804: Returns: $output (markup to be displayed)
12805:
12806: =cut
12807:
12808: sub assign_categories_table {
1.919 raeburn 12809: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 12810: my $output;
12811: if (ref($cathash) eq 'HASH') {
12812: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
12813: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
12814: $maxdepth = scalar(@cats);
12815: if (@cats > 0) {
12816: my $itemcount = 0;
12817: if (ref($cats[0]) eq 'ARRAY') {
12818: my @currcategories;
12819: if ($currcat ne '') {
12820: @currcategories = split('&',$currcat);
12821: }
1.919 raeburn 12822: my $table;
1.663 raeburn 12823: for (my $i=0; $i<@{$cats[0]}; $i++) {
12824: my $parent = $cats[0][$i];
1.919 raeburn 12825: next if ($parent eq 'instcode');
12826: if ($type eq 'Community') {
12827: next unless ($parent eq 'communities');
12828: } else {
12829: next if ($parent eq 'communities');
12830: }
1.663 raeburn 12831: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
12832: my $item = &escape($parent).'::0';
12833: my $checked = '';
12834: if (@currcategories > 0) {
12835: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 12836: $checked = ' checked="checked"';
1.663 raeburn 12837: }
12838: }
1.919 raeburn 12839: my $parent_title = $parent;
12840: if ($parent eq 'communities') {
12841: $parent_title = &mt('Communities');
12842: }
12843: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
12844: '<input type="checkbox" name="usecategory" value="'.
12845: $item.'"'.$checked.' />'.$parent_title.'</span>'.
12846: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 12847: my $depth = 1;
12848: push(@path,$parent);
1.919 raeburn 12849: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 12850: pop(@path);
1.919 raeburn 12851: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 12852: $itemcount ++;
12853: }
1.919 raeburn 12854: if ($itemcount) {
12855: $output = &Apache::loncommon::start_data_table().
12856: $table.
12857: &Apache::loncommon::end_data_table();
12858: }
1.663 raeburn 12859: }
12860: }
12861: }
12862: return $output;
12863: }
12864:
12865: =pod
12866:
12867: =item *&assign_category_rows()
12868:
12869: Create a datatable row for display of nested categories in a domain,
12870: with checkboxes to allow a course to be categorized,called recursively.
12871:
12872: Inputs:
12873:
12874: itemcount - track row number for alternating colors
12875:
12876: cats - reference to array of arrays/hashes which encapsulates hierarchy of
12877: categories and subcategories.
12878:
12879: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
12880:
12881: parent - parent of current category item
12882:
12883: path - Array containing all categories back up through the hierarchy from the
12884: current category to the top level.
12885:
12886: currcategories - reference to array of current categories assigned to the course
12887:
12888: Returns: $output (markup to be displayed).
12889:
12890: =cut
12891:
12892: sub assign_category_rows {
12893: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
12894: my ($text,$name,$item,$chgstr);
12895: if (ref($cats) eq 'ARRAY') {
12896: my $maxdepth = scalar(@{$cats});
12897: if (ref($cats->[$depth]) eq 'HASH') {
12898: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
12899: my $numchildren = @{$cats->[$depth]{$parent}};
12900: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
12901: $text .= '<td><table class="LC_datatable">';
12902: for (my $j=0; $j<$numchildren; $j++) {
12903: $name = $cats->[$depth]{$parent}[$j];
12904: $item = &escape($name).':'.&escape($parent).':'.$depth;
12905: my $deeper = $depth+1;
12906: my $checked = '';
12907: if (ref($currcategories) eq 'ARRAY') {
12908: if (@{$currcategories} > 0) {
12909: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 12910: $checked = ' checked="checked"';
1.663 raeburn 12911: }
12912: }
12913: }
1.664 raeburn 12914: $text .= '<tr><td><span class="LC_nobreak"><label>'.
12915: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 12916: $item.'"'.$checked.' />'.$name.'</label></span>'.
12917: '<input type="hidden" name="catname" value="'.$name.'" />'.
12918: '</td><td>';
1.663 raeburn 12919: if (ref($path) eq 'ARRAY') {
12920: push(@{$path},$name);
12921: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
12922: pop(@{$path});
12923: }
12924: $text .= '</td></tr>';
12925: }
12926: $text .= '</table></td>';
12927: }
12928: }
12929: }
12930: return $text;
12931: }
12932:
1.655 raeburn 12933: ############################################################
12934: ############################################################
12935:
12936:
1.443 albertel 12937: sub commit_customrole {
1.664 raeburn 12938: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 12939: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 12940: ($start?', '.&mt('starting').' '.localtime($start):'').
12941: ($end?', ending '.localtime($end):'').': <b>'.
12942: &Apache::lonnet::assigncustomrole(
1.664 raeburn 12943: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 12944: '</b><br />';
12945: return $output;
12946: }
12947:
12948: sub commit_standardrole {
1.541 raeburn 12949: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
12950: my ($output,$logmsg,$linefeed);
12951: if ($context eq 'auto') {
12952: $linefeed = "\n";
12953: } else {
12954: $linefeed = "<br />\n";
12955: }
1.443 albertel 12956: if ($three eq 'st') {
1.541 raeburn 12957: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
12958: $one,$two,$sec,$context);
12959: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 12960: ($result eq 'unknown_course') || ($result eq 'refused')) {
12961: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 12962: } else {
1.541 raeburn 12963: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 12964: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 12965: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
12966: if ($context eq 'auto') {
12967: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
12968: } else {
12969: $output .= '<b>'.$result.'</b>'.$linefeed.
12970: &mt('Add to classlist').': <b>ok</b>';
12971: }
12972: $output .= $linefeed;
1.443 albertel 12973: }
12974: } else {
12975: $output = &mt('Assigning').' '.$three.' in '.$url.
12976: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 12977: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 12978: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 12979: if ($context eq 'auto') {
12980: $output .= $result.$linefeed;
12981: } else {
12982: $output .= '<b>'.$result.'</b>'.$linefeed;
12983: }
1.443 albertel 12984: }
12985: return $output;
12986: }
12987:
12988: sub commit_studentrole {
1.541 raeburn 12989: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 12990: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 12991: if ($context eq 'auto') {
12992: $linefeed = "\n";
12993: } else {
12994: $linefeed = '<br />'."\n";
12995: }
1.443 albertel 12996: if (defined($one) && defined($two)) {
12997: my $cid=$one.'_'.$two;
12998: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
12999: my $secchange = 0;
13000: my $expire_role_result;
13001: my $modify_section_result;
1.628 raeburn 13002: if ($oldsec ne '-1') {
13003: if ($oldsec ne $sec) {
1.443 albertel 13004: $secchange = 1;
1.628 raeburn 13005: my $now = time;
1.443 albertel 13006: my $uurl='/'.$cid;
13007: $uurl=~s/\_/\//g;
13008: if ($oldsec) {
13009: $uurl.='/'.$oldsec;
13010: }
1.626 raeburn 13011: $oldsecurl = $uurl;
1.628 raeburn 13012: $expire_role_result =
1.652 raeburn 13013: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 13014: if ($env{'request.course.sec'} ne '') {
13015: if ($expire_role_result eq 'refused') {
13016: my @roles = ('st');
13017: my @statuses = ('previous');
13018: my @roledoms = ($one);
13019: my $withsec = 1;
13020: my %roleshash =
13021: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
13022: \@statuses,\@roles,\@roledoms,$withsec);
13023: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
13024: my ($oldstart,$oldend) =
13025: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
13026: if ($oldend > 0 && $oldend <= $now) {
13027: $expire_role_result = 'ok';
13028: }
13029: }
13030: }
13031: }
1.443 albertel 13032: $result = $expire_role_result;
13033: }
13034: }
13035: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 13036: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 13037: if ($modify_section_result =~ /^ok/) {
13038: if ($secchange == 1) {
1.628 raeburn 13039: if ($sec eq '') {
13040: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
13041: } else {
13042: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
13043: }
1.443 albertel 13044: } elsif ($oldsec eq '-1') {
1.628 raeburn 13045: if ($sec eq '') {
13046: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
13047: } else {
13048: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
13049: }
1.443 albertel 13050: } else {
1.628 raeburn 13051: if ($sec eq '') {
13052: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
13053: } else {
13054: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
13055: }
1.443 albertel 13056: }
13057: } else {
1.628 raeburn 13058: if ($secchange) {
13059: $$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;
13060: } else {
13061: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
13062: }
1.443 albertel 13063: }
13064: $result = $modify_section_result;
13065: } elsif ($secchange == 1) {
1.628 raeburn 13066: if ($oldsec eq '') {
13067: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
13068: } else {
13069: $$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;
13070: }
1.626 raeburn 13071: if ($expire_role_result eq 'refused') {
13072: my $newsecurl = '/'.$cid;
13073: $newsecurl =~ s/\_/\//g;
13074: if ($sec ne '') {
13075: $newsecurl.='/'.$sec;
13076: }
13077: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
13078: if ($sec eq '') {
13079: $$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;
13080: } else {
13081: $$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;
13082: }
13083: }
13084: }
1.443 albertel 13085: }
13086: } else {
1.626 raeburn 13087: $$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 13088: $result = "error: incomplete course id\n";
13089: }
13090: return $result;
13091: }
13092:
13093: ############################################################
13094: ############################################################
13095:
1.566 albertel 13096: sub check_clone {
1.578 raeburn 13097: my ($args,$linefeed) = @_;
1.566 albertel 13098: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
13099: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
13100: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
13101: my $clonemsg;
13102: my $can_clone = 0;
1.944 raeburn 13103: my $lctype = lc($args->{'crstype'});
1.908 raeburn 13104: if ($lctype ne 'community') {
13105: $lctype = 'course';
13106: }
1.566 albertel 13107: if ($clonehome eq 'no_host') {
1.944 raeburn 13108: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13109: $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'});
13110: } else {
13111: $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'});
13112: }
1.566 albertel 13113: } else {
13114: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944 raeburn 13115: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13116: if ($clonedesc{'type'} ne 'Community') {
13117: $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'});
13118: return ($can_clone, $clonemsg, $cloneid, $clonehome);
13119: }
13120: }
1.882 raeburn 13121: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
13122: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 13123: $can_clone = 1;
13124: } else {
13125: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
13126: $args->{'clonedomain'},$args->{'clonecourse'});
13127: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 13128: if (grep(/^\*$/,@cloners)) {
13129: $can_clone = 1;
13130: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
13131: $can_clone = 1;
13132: } else {
1.908 raeburn 13133: my $ccrole = 'cc';
1.944 raeburn 13134: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13135: $ccrole = 'co';
13136: }
1.578 raeburn 13137: my %roleshash =
13138: &Apache::lonnet::get_my_roles($args->{'ccuname'},
13139: $args->{'ccdomain'},
1.908 raeburn 13140: 'userroles',['active'],[$ccrole],
1.578 raeburn 13141: [$args->{'clonedomain'}]);
1.908 raeburn 13142: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942 raeburn 13143: $can_clone = 1;
13144: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
13145: $can_clone = 1;
13146: } else {
1.944 raeburn 13147: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13148: $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'});
13149: } else {
13150: $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'});
13151: }
1.578 raeburn 13152: }
1.566 albertel 13153: }
1.578 raeburn 13154: }
1.566 albertel 13155: }
13156: return ($can_clone, $clonemsg, $cloneid, $clonehome);
13157: }
13158:
1.444 albertel 13159: sub construct_course {
1.885 raeburn 13160: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444 albertel 13161: my $outcome;
1.541 raeburn 13162: my $linefeed = '<br />'."\n";
13163: if ($context eq 'auto') {
13164: $linefeed = "\n";
13165: }
1.566 albertel 13166:
13167: #
13168: # Are we cloning?
13169: #
13170: my ($can_clone, $clonemsg, $cloneid, $clonehome);
13171: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 13172: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 13173: if ($context ne 'auto') {
1.578 raeburn 13174: if ($clonemsg ne '') {
13175: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
13176: }
1.566 albertel 13177: }
13178: $outcome .= $clonemsg.$linefeed;
13179:
13180: if (!$can_clone) {
13181: return (0,$outcome);
13182: }
13183: }
13184:
1.444 albertel 13185: #
13186: # Open course
13187: #
13188: my $crstype = lc($args->{'crstype'});
13189: my %cenv=();
13190: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
13191: $args->{'cdescr'},
13192: $args->{'curl'},
13193: $args->{'course_home'},
13194: $args->{'nonstandard'},
13195: $args->{'crscode'},
13196: $args->{'ccuname'}.':'.
13197: $args->{'ccdomain'},
1.882 raeburn 13198: $args->{'crstype'},
1.885 raeburn 13199: $cnum,$context,$category);
1.444 albertel 13200:
13201: # Note: The testing routines depend on this being output; see
13202: # Utils::Course. This needs to at least be output as a comment
13203: # if anyone ever decides to not show this, and Utils::Course::new
13204: # will need to be suitably modified.
1.541 raeburn 13205: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943 raeburn 13206: if ($$courseid =~ /^error:/) {
13207: return (0,$outcome);
13208: }
13209:
1.444 albertel 13210: #
13211: # Check if created correctly
13212: #
1.479 albertel 13213: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 13214: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 13215: if ($crsuhome eq 'no_host') {
13216: $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
13217: return (0,$outcome);
13218: }
1.541 raeburn 13219: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 13220:
1.444 albertel 13221: #
1.566 albertel 13222: # Do the cloning
13223: #
13224: if ($can_clone && $cloneid) {
13225: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
13226: if ($context ne 'auto') {
13227: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
13228: }
13229: $outcome .= $clonemsg.$linefeed;
13230: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 13231: # Copy all files
1.637 www 13232: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 13233: # Restore URL
1.566 albertel 13234: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 13235: # Restore title
1.566 albertel 13236: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 13237: # Restore creation date, creator and creation context.
13238: $cenv{'internal.created'}=$oldcenv{'internal.created'};
13239: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
13240: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 13241: # Mark as cloned
1.566 albertel 13242: $cenv{'clonedfrom'}=$cloneid;
1.638 www 13243: # Need to clone grading mode
13244: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
13245: $cenv{'grading'}=$newenv{'grading'};
13246: # Do not clone these environment entries
13247: &Apache::lonnet::del('environment',
13248: ['default_enrollment_start_date',
13249: 'default_enrollment_end_date',
13250: 'question.email',
13251: 'policy.email',
13252: 'comment.email',
13253: 'pch.users.denied',
1.725 raeburn 13254: 'plc.users.denied',
13255: 'hidefromcat',
13256: 'categories'],
1.638 www 13257: $$crsudom,$$crsunum);
1.444 albertel 13258: }
1.566 albertel 13259:
1.444 albertel 13260: #
13261: # Set environment (will override cloned, if existing)
13262: #
13263: my @sections = ();
13264: my @xlists = ();
13265: if ($args->{'crstype'}) {
13266: $cenv{'type'}=$args->{'crstype'};
13267: }
13268: if ($args->{'crsid'}) {
13269: $cenv{'courseid'}=$args->{'crsid'};
13270: }
13271: if ($args->{'crscode'}) {
13272: $cenv{'internal.coursecode'}=$args->{'crscode'};
13273: }
13274: if ($args->{'crsquota'} ne '') {
13275: $cenv{'internal.coursequota'}=$args->{'crsquota'};
13276: } else {
13277: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
13278: }
13279: if ($args->{'ccuname'}) {
13280: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
13281: ':'.$args->{'ccdomain'};
13282: } else {
13283: $cenv{'internal.courseowner'} = $args->{'curruser'};
13284: }
13285: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
13286: if ($args->{'crssections'}) {
13287: $cenv{'internal.sectionnums'} = '';
13288: if ($args->{'crssections'} =~ m/,/) {
13289: @sections = split/,/,$args->{'crssections'};
13290: } else {
13291: $sections[0] = $args->{'crssections'};
13292: }
13293: if (@sections > 0) {
13294: foreach my $item (@sections) {
13295: my ($sec,$gp) = split/:/,$item;
13296: my $class = $args->{'crscode'}.$sec;
13297: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
13298: $cenv{'internal.sectionnums'} .= $item.',';
13299: unless ($addcheck eq 'ok') {
13300: push @badclasses, $class;
13301: }
13302: }
13303: $cenv{'internal.sectionnums'} =~ s/,$//;
13304: }
13305: }
13306: # do not hide course coordinator from staff listing,
13307: # even if privileged
13308: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
13309: # add crosslistings
13310: if ($args->{'crsxlist'}) {
13311: $cenv{'internal.crosslistings'}='';
13312: if ($args->{'crsxlist'} =~ m/,/) {
13313: @xlists = split/,/,$args->{'crsxlist'};
13314: } else {
13315: $xlists[0] = $args->{'crsxlist'};
13316: }
13317: if (@xlists > 0) {
13318: foreach my $item (@xlists) {
13319: my ($xl,$gp) = split/:/,$item;
13320: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
13321: $cenv{'internal.crosslistings'} .= $item.',';
13322: unless ($addcheck eq 'ok') {
13323: push @badclasses, $xl;
13324: }
13325: }
13326: $cenv{'internal.crosslistings'} =~ s/,$//;
13327: }
13328: }
13329: if ($args->{'autoadds'}) {
13330: $cenv{'internal.autoadds'}=$args->{'autoadds'};
13331: }
13332: if ($args->{'autodrops'}) {
13333: $cenv{'internal.autodrops'}=$args->{'autodrops'};
13334: }
13335: # check for notification of enrollment changes
13336: my @notified = ();
13337: if ($args->{'notify_owner'}) {
13338: if ($args->{'ccuname'} ne '') {
13339: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
13340: }
13341: }
13342: if ($args->{'notify_dc'}) {
13343: if ($uname ne '') {
1.630 raeburn 13344: push(@notified,$uname.':'.$udom);
1.444 albertel 13345: }
13346: }
13347: if (@notified > 0) {
13348: my $notifylist;
13349: if (@notified > 1) {
13350: $notifylist = join(',',@notified);
13351: } else {
13352: $notifylist = $notified[0];
13353: }
13354: $cenv{'internal.notifylist'} = $notifylist;
13355: }
13356: if (@badclasses > 0) {
13357: my %lt=&Apache::lonlocal::texthash(
13358: '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',
13359: 'dnhr' => 'does not have rights to access enrollment in these classes',
13360: 'adby' => 'as determined by the policies of your institution on access to official classlists'
13361: );
1.541 raeburn 13362: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
13363: ' ('.$lt{'adby'}.')';
13364: if ($context eq 'auto') {
13365: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 13366: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 13367: foreach my $item (@badclasses) {
13368: if ($context eq 'auto') {
13369: $outcome .= " - $item\n";
13370: } else {
13371: $outcome .= "<li>$item</li>\n";
13372: }
13373: }
13374: if ($context eq 'auto') {
13375: $outcome .= $linefeed;
13376: } else {
1.566 albertel 13377: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 13378: }
13379: }
1.444 albertel 13380: }
13381: if ($args->{'no_end_date'}) {
13382: $args->{'endaccess'} = 0;
13383: }
13384: $cenv{'internal.autostart'}=$args->{'enrollstart'};
13385: $cenv{'internal.autoend'}=$args->{'enrollend'};
13386: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
13387: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
13388: if ($args->{'showphotos'}) {
13389: $cenv{'internal.showphotos'}=$args->{'showphotos'};
13390: }
13391: $cenv{'internal.authtype'} = $args->{'authtype'};
13392: $cenv{'internal.autharg'} = $args->{'autharg'};
13393: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
13394: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 13395: 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');
13396: if ($context eq 'auto') {
13397: $outcome .= $krb_msg;
13398: } else {
1.566 albertel 13399: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 13400: }
13401: $outcome .= $linefeed;
1.444 albertel 13402: }
13403: }
13404: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
13405: if ($args->{'setpolicy'}) {
13406: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
13407: }
13408: if ($args->{'setcontent'}) {
13409: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
13410: }
13411: }
13412: if ($args->{'reshome'}) {
13413: $cenv{'reshome'}=$args->{'reshome'}.'/';
13414: $cenv{'reshome'}=~s/\/+$/\//;
13415: }
13416: #
13417: # course has keyed access
13418: #
13419: if ($args->{'setkeys'}) {
13420: $cenv{'keyaccess'}='yes';
13421: }
13422: # if specified, key authority is not course, but user
13423: # only active if keyaccess is yes
13424: if ($args->{'keyauth'}) {
1.487 albertel 13425: my ($user,$domain) = split(':',$args->{'keyauth'});
13426: $user = &LONCAPA::clean_username($user);
13427: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 13428: if ($user ne '' && $domain ne '') {
1.487 albertel 13429: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 13430: }
13431: }
13432:
13433: if ($args->{'disresdis'}) {
13434: $cenv{'pch.roles.denied'}='st';
13435: }
13436: if ($args->{'disablechat'}) {
13437: $cenv{'plc.roles.denied'}='st';
13438: }
13439:
13440: # Record we've not yet viewed the Course Initialization Helper for this
13441: # course
13442: $cenv{'course.helper.not.run'} = 1;
13443: #
13444: # Use new Randomseed
13445: #
13446: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
13447: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
13448: #
13449: # The encryption code and receipt prefix for this course
13450: #
13451: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
13452: $cenv{'internal.encpref'}=100+int(9*rand(99));
13453: #
13454: # By default, use standard grading
13455: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
13456:
1.541 raeburn 13457: $outcome .= $linefeed.&mt('Setting environment').': '.
13458: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 13459: #
13460: # Open all assignments
13461: #
13462: if ($args->{'openall'}) {
13463: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
13464: my %storecontent = ($storeunder => time,
13465: $storeunder.'.type' => 'date_start');
13466:
13467: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 13468: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 13469: }
13470: #
13471: # Set first page
13472: #
13473: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
13474: || ($cloneid)) {
1.445 albertel 13475: use LONCAPA::map;
1.444 albertel 13476: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 13477:
13478: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
13479: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
13480:
1.444 albertel 13481: $outcome .= ($fatal?$errtext:'read ok').' - ';
13482: my $title; my $url;
13483: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 13484: $title=&mt('Syllabus');
1.444 albertel 13485: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
13486: } else {
1.963 raeburn 13487: $title=&mt('Table of Contents');
1.444 albertel 13488: $url='/adm/navmaps';
13489: }
1.445 albertel 13490:
13491: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
13492: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
13493:
13494: if ($errtext) { $fatal=2; }
1.541 raeburn 13495: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 13496: }
1.566 albertel 13497:
13498: return (1,$outcome);
1.444 albertel 13499: }
13500:
13501: ############################################################
13502: ############################################################
13503:
1.953 droeschl 13504: #SD
13505: # only Community and Course, or anything else?
1.378 raeburn 13506: sub course_type {
13507: my ($cid) = @_;
13508: if (!defined($cid)) {
13509: $cid = $env{'request.course.id'};
13510: }
1.404 albertel 13511: if (defined($env{'course.'.$cid.'.type'})) {
13512: return $env{'course.'.$cid.'.type'};
1.378 raeburn 13513: } else {
13514: return 'Course';
1.377 raeburn 13515: }
13516: }
1.156 albertel 13517:
1.406 raeburn 13518: sub group_term {
13519: my $crstype = &course_type();
13520: my %names = (
13521: 'Course' => 'group',
1.865 raeburn 13522: 'Community' => 'group',
1.406 raeburn 13523: );
13524: return $names{$crstype};
13525: }
13526:
1.902 raeburn 13527: sub course_types {
13528: my @types = ('official','unofficial','community');
13529: my %typename = (
13530: official => 'Official course',
13531: unofficial => 'Unofficial course',
13532: community => 'Community',
13533: );
13534: return (\@types,\%typename);
13535: }
13536:
1.156 albertel 13537: sub icon {
13538: my ($file)=@_;
1.505 albertel 13539: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 13540: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 13541: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 13542: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
13543: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
13544: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
13545: $curfext.".gif") {
13546: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
13547: $curfext.".gif";
13548: }
13549: }
1.249 albertel 13550: return &lonhttpdurl($iconname);
1.154 albertel 13551: }
1.84 albertel 13552:
1.575 albertel 13553: sub lonhttpdurl {
1.692 www 13554: #
13555: # Had been used for "small fry" static images on separate port 8080.
13556: # Modify here if lightweight http functionality desired again.
13557: # Currently eliminated due to increasing firewall issues.
13558: #
1.575 albertel 13559: my ($url)=@_;
1.692 www 13560: return $url;
1.215 albertel 13561: }
13562:
1.213 albertel 13563: sub connection_aborted {
13564: my ($r)=@_;
13565: $r->print(" ");$r->rflush();
13566: my $c = $r->connection;
13567: return $c->aborted();
13568: }
13569:
1.221 foxr 13570: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 13571: # strings as 'strings'.
13572: sub escape_single {
1.221 foxr 13573: my ($input) = @_;
1.223 albertel 13574: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 13575: $input =~ s/\'/\\\'/g; # Esacpe the 's....
13576: return $input;
13577: }
1.223 albertel 13578:
1.222 foxr 13579: # Same as escape_single, but escape's "'s This
13580: # can be used for "strings"
13581: sub escape_double {
13582: my ($input) = @_;
13583: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
13584: $input =~ s/\"/\\\"/g; # Esacpe the "s....
13585: return $input;
13586: }
1.223 albertel 13587:
1.222 foxr 13588: # Escapes the last element of a full URL.
13589: sub escape_url {
13590: my ($url) = @_;
1.238 raeburn 13591: my @urlslices = split(/\//, $url,-1);
1.369 www 13592: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 13593: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 13594: }
1.462 albertel 13595:
1.820 raeburn 13596: sub compare_arrays {
13597: my ($arrayref1,$arrayref2) = @_;
13598: my (@difference,%count);
13599: @difference = ();
13600: %count = ();
13601: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
13602: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
13603: foreach my $element (keys(%count)) {
13604: if ($count{$element} == 1) {
13605: push(@difference,$element);
13606: }
13607: }
13608: }
13609: return @difference;
13610: }
13611:
1.817 bisitz 13612: # -------------------------------------------------------- Initialize user login
1.462 albertel 13613: sub init_user_environment {
1.463 albertel 13614: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 13615: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
13616:
13617: my $public=($username eq 'public' && $domain eq 'public');
13618:
13619: # See if old ID present, if so, remove
13620:
1.1062 raeburn 13621: my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462 albertel 13622: my $now=time;
13623:
13624: if ($public) {
13625: my $max_public=100;
13626: my $oldest;
13627: my $oldest_time=0;
13628: for(my $next=1;$next<=$max_public;$next++) {
13629: if (-e $lonids."/publicuser_$next.id") {
13630: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
13631: if ($mtime<$oldest_time || !$oldest_time) {
13632: $oldest_time=$mtime;
13633: $oldest=$next;
13634: }
13635: } else {
13636: $cookie="publicuser_$next";
13637: last;
13638: }
13639: }
13640: if (!$cookie) { $cookie="publicuser_$oldest"; }
13641: } else {
1.463 albertel 13642: # if this isn't a robot, kill any existing non-robot sessions
13643: if (!$args->{'robot'}) {
13644: opendir(DIR,$lonids);
13645: while ($filename=readdir(DIR)) {
13646: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
13647: unlink($lonids.'/'.$filename);
13648: }
1.462 albertel 13649: }
1.463 albertel 13650: closedir(DIR);
1.462 albertel 13651: }
13652: # Give them a new cookie
1.463 albertel 13653: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 13654: : $now.$$.int(rand(10000)));
1.463 albertel 13655: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 13656:
13657: # Initialize roles
13658:
1.1062 raeburn 13659: ($userroles,$firstaccenv,$timerintenv) =
13660: &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462 albertel 13661: }
13662: # ------------------------------------ Check browser type and MathML capability
13663:
13664: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
13665: $clientunicode,$clientos) = &decode_user_agent($r);
13666:
13667: # ------------------------------------------------------------- Get environment
13668:
13669: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
13670: my ($tmp) = keys(%userenv);
13671: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
13672: } else {
13673: undef(%userenv);
13674: }
13675: if (($userenv{'interface'}) && (!$form->{'interface'})) {
13676: $form->{'interface'}=$userenv{'interface'};
13677: }
13678: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
13679:
13680: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 13681: foreach my $option ('interface','localpath','localres') {
13682: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 13683: }
13684: # --------------------------------------------------------- Write first profile
13685:
13686: {
13687: my %initial_env =
13688: ("user.name" => $username,
13689: "user.domain" => $domain,
13690: "user.home" => $authhost,
13691: "browser.type" => $clientbrowser,
13692: "browser.version" => $clientversion,
13693: "browser.mathml" => $clientmathml,
13694: "browser.unicode" => $clientunicode,
13695: "browser.os" => $clientos,
13696: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
13697: "request.course.fn" => '',
13698: "request.course.uri" => '',
13699: "request.course.sec" => '',
13700: "request.role" => 'cm',
13701: "request.role.adv" => $env{'user.adv'},
13702: "request.host" => $ENV{'REMOTE_ADDR'},);
13703:
13704: if ($form->{'localpath'}) {
13705: $initial_env{"browser.localpath"} = $form->{'localpath'};
13706: $initial_env{"browser.localres"} = $form->{'localres'};
13707: }
13708:
13709: if ($form->{'interface'}) {
13710: $form->{'interface'}=~s/\W//gs;
13711: $initial_env{"browser.interface"} = $form->{'interface'};
13712: $env{'browser.interface'}=$form->{'interface'};
13713: }
13714:
1.981 raeburn 13715: my %is_adv = ( is_adv => $env{'user.adv'} );
1.1016 raeburn 13716: my %domdef;
13717: unless ($domain eq 'public') {
13718: %domdef = &Apache::lonnet::get_domain_defaults($domain);
13719: }
1.980 raeburn 13720:
1.1081 ! raeburn 13721: foreach my $tool ('aboutme','blog','webdav','portfolio') {
1.724 raeburn 13722: $userenv{'availabletools.'.$tool} =
1.980 raeburn 13723: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
13724: undef,\%userenv,\%domdef,\%is_adv);
1.724 raeburn 13725: }
13726:
1.864 raeburn 13727: foreach my $crstype ('official','unofficial','community') {
1.765 raeburn 13728: $userenv{'canrequest.'.$crstype} =
13729: &Apache::lonnet::usertools_access($username,$domain,$crstype,
1.980 raeburn 13730: 'reload','requestcourses',
13731: \%userenv,\%domdef,\%is_adv);
1.765 raeburn 13732: }
13733:
1.462 albertel 13734: $env{'user.environment'} = "$lonids/$cookie.id";
1.1062 raeburn 13735:
1.462 albertel 13736: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
13737: &GDBM_WRCREAT(),0640)) {
13738: &_add_to_env(\%disk_env,\%initial_env);
13739: &_add_to_env(\%disk_env,\%userenv,'environment.');
13740: &_add_to_env(\%disk_env,$userroles);
1.1062 raeburn 13741: if (ref($firstaccenv) eq 'HASH') {
13742: &_add_to_env(\%disk_env,$firstaccenv);
13743: }
13744: if (ref($timerintenv) eq 'HASH') {
13745: &_add_to_env(\%disk_env,$timerintenv);
13746: }
1.463 albertel 13747: if (ref($args->{'extra_env'})) {
13748: &_add_to_env(\%disk_env,$args->{'extra_env'});
13749: }
1.462 albertel 13750: untie(%disk_env);
13751: } else {
1.705 tempelho 13752: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
13753: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 13754: return 'error: '.$!;
13755: }
13756: }
13757: $env{'request.role'}='cm';
13758: $env{'request.role.adv'}=$env{'user.adv'};
13759: $env{'browser.type'}=$clientbrowser;
13760:
13761: return $cookie;
13762:
13763: }
13764:
13765: sub _add_to_env {
13766: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 13767: if (ref($env_data) eq 'HASH') {
13768: while (my ($key,$value) = each(%$env_data)) {
13769: $idf->{$prefix.$key} = $value;
13770: $env{$prefix.$key} = $value;
13771: }
1.462 albertel 13772: }
13773: }
13774:
1.685 tempelho 13775: # --- Get the symbolic name of a problem and the url
13776: sub get_symb {
13777: my ($request,$silent) = @_;
1.726 raeburn 13778: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 13779: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
13780: if ($symb eq '') {
13781: if (!$silent) {
1.1071 raeburn 13782: if (ref($request)) {
13783: $request->print("Unable to handle ambiguous references:$url:.");
13784: }
1.685 tempelho 13785: return ();
13786: }
13787: }
13788: &Apache::lonenc::check_decrypt(\$symb);
13789: return ($symb);
13790: }
13791:
13792: # --------------------------------------------------------------Get annotation
13793:
13794: sub get_annotation {
13795: my ($symb,$enc) = @_;
13796:
13797: my $key = $symb;
13798: if (!$enc) {
13799: $key =
13800: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
13801: }
13802: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
13803: return $annotation{$key};
13804: }
13805:
13806: sub clean_symb {
1.731 raeburn 13807: my ($symb,$delete_enc) = @_;
1.685 tempelho 13808:
13809: &Apache::lonenc::check_decrypt(\$symb);
13810: my $enc = $env{'request.enc'};
1.731 raeburn 13811: if ($delete_enc) {
1.730 raeburn 13812: delete($env{'request.enc'});
13813: }
1.685 tempelho 13814:
13815: return ($symb,$enc);
13816: }
1.462 albertel 13817:
1.990 raeburn 13818: sub build_release_hashes {
13819: my ($checkparms,$checkresponsetypes,$checkcrstypes,$anonsurvey,$randomizetry) = @_;
13820: return unless((ref($checkparms) eq 'HASH') && (ref($checkresponsetypes) eq 'HASH') &&
13821: (ref($checkcrstypes) eq 'HASH') && (ref($anonsurvey) eq 'HASH') &&
13822: (ref($randomizetry) eq 'HASH'));
13823: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
13824: my ($item,$name,$value) = split(/:/,$key);
13825: if ($item eq 'parameter') {
13826: if (ref($checkparms->{$name}) eq 'ARRAY') {
13827: unless(grep(/^\Q$name\E$/,@{$checkparms->{$name}})) {
13828: push(@{$checkparms->{$name}},$value);
13829: }
13830: } else {
13831: push(@{$checkparms->{$name}},$value);
13832: }
13833: } elsif ($item eq 'resourcetag') {
13834: if ($name eq 'responsetype') {
13835: $checkresponsetypes->{$value} = $Apache::lonnet::needsrelease{$key}
13836: }
13837: } elsif ($item eq 'course') {
13838: if ($name eq 'crstype') {
13839: $checkcrstypes->{$value} = $Apache::lonnet::needsrelease{$key};
13840: }
13841: }
13842: }
13843: ($anonsurvey->{major},$anonsurvey->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:anonsurvey'});
13844: ($randomizetry->{major},$randomizetry->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:randomizetry'});
13845: return;
13846: }
13847:
1.41 ng 13848: =pod
13849:
13850: =back
13851:
1.112 bowersj2 13852: =cut
1.41 ng 13853:
1.112 bowersj2 13854: 1;
13855: __END__;
1.41 ng 13856:
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