Annotation of loncom/interface/loncommon.pm, revision 1.1075.2.37
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1075.2.37! raeburn 4: # $Id: loncommon.pm,v 1.1075.2.36 2013/05/12 03:36:46 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.1075.2.25 raeburn 70: use Apache::lonuserutils();
1.1075.2.27 raeburn 71: use Apache::lonuserstate();
1.479 albertel 72: use LONCAPA qw(:DEFAULT :match);
1.657 raeburn 73: use DateTime::TimeZone;
1.687 raeburn 74: use DateTime::Locale::Catalog;
1.1075.2.14 raeburn 75: use Authen::Captcha;
76: use Captcha::reCAPTCHA;
1.117 www 77:
1.517 raeburn 78: # ---------------------------------------------- Designs
79: use vars qw(%defaultdesign);
80:
1.22 www 81: my $readit;
82:
1.517 raeburn 83:
1.157 matthew 84: ##
85: ## Global Variables
86: ##
1.46 matthew 87:
1.643 foxr 88:
89: # ----------------------------------------------- SSI with retries:
90: #
91:
92: =pod
93:
1.648 raeburn 94: =head1 Server Side include with retries:
1.643 foxr 95:
96: =over 4
97:
1.648 raeburn 98: =item * &ssi_with_retries(resource,retries form)
1.643 foxr 99:
100: Performs an ssi with some number of retries. Retries continue either
101: until the result is ok or until the retry count supplied by the
102: caller is exhausted.
103:
104: Inputs:
1.648 raeburn 105:
106: =over 4
107:
1.643 foxr 108: resource - Identifies the resource to insert.
1.648 raeburn 109:
1.643 foxr 110: retries - Count of the number of retries allowed.
1.648 raeburn 111:
1.643 foxr 112: form - Hash that identifies the rendering options.
113:
1.648 raeburn 114: =back
115:
116: Returns:
117:
118: =over 4
119:
1.643 foxr 120: content - The content of the response. If retries were exhausted this is empty.
1.648 raeburn 121:
1.643 foxr 122: response - The response from the last attempt (which may or may not have been successful.
123:
1.648 raeburn 124: =back
125:
126: =back
127:
1.643 foxr 128: =cut
129:
130: sub ssi_with_retries {
131: my ($resource, $retries, %form) = @_;
132:
133:
134: my $ok = 0; # True if we got a good response.
135: my $content;
136: my $response;
137:
138: # Try to get the ssi done. within the retries count:
139:
140: do {
141: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
142: $ok = $response->is_success;
1.650 www 143: if (!$ok) {
144: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
145: }
1.643 foxr 146: $retries--;
147: } while (!$ok && ($retries > 0));
148:
149: if (!$ok) {
150: $content = ''; # On error return an empty content.
151: }
152: return ($content, $response);
153:
154: }
155:
156:
157:
1.20 www 158: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 159: my %language;
1.124 www 160: my %supported_language;
1.1048 foxr 161: my %latex_language; # For choosing hyphenation in <transl..>
162: my %latex_language_bykey; # for choosing hyphenation from metadata
1.12 harris41 163: my %cprtag;
1.192 taceyjo1 164: my %scprtag;
1.351 www 165: my %fe; my %fd; my %fm;
1.41 ng 166: my %category_extensions;
1.12 harris41 167:
1.46 matthew 168: # ---------------------------------------------- Thesaurus variables
1.144 matthew 169: #
170: # %Keywords:
171: # A hash used by &keyword to determine if a word is considered a keyword.
172: # $thesaurus_db_file
173: # Scalar containing the full path to the thesaurus database.
1.46 matthew 174:
175: my %Keywords;
176: my $thesaurus_db_file;
177:
1.144 matthew 178: #
179: # Initialize values from language.tab, copyright.tab, filetypes.tab,
180: # thesaurus.tab, and filecategories.tab.
181: #
1.18 www 182: BEGIN {
1.46 matthew 183: # Variable initialization
184: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
185: #
1.22 www 186: unless ($readit) {
1.12 harris41 187: # ------------------------------------------------------------------- languages
188: {
1.158 raeburn 189: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
190: '/language.tab';
191: if ( open(my $fh,"<$langtabfile") ) {
1.356 albertel 192: while (my $line = <$fh>) {
193: next if ($line=~/^\#/);
194: chomp($line);
1.1048 foxr 195: my ($key,$two,$country,$three,$enc,$val,$sup,$latex)=(split(/\t/,$line));
1.158 raeburn 196: $language{$key}=$val.' - '.$enc;
197: if ($sup) {
198: $supported_language{$key}=$sup;
199: }
1.1048 foxr 200: if ($latex) {
201: $latex_language_bykey{$key} = $latex;
202: $latex_language{$two} = $latex;
203: }
1.158 raeburn 204: }
205: close($fh);
206: }
1.12 harris41 207: }
208: # ------------------------------------------------------------------ copyrights
209: {
1.158 raeburn 210: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
211: '/copyright.tab';
212: if ( open (my $fh,"<$copyrightfile") ) {
1.356 albertel 213: while (my $line = <$fh>) {
214: next if ($line=~/^\#/);
215: chomp($line);
216: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 217: $cprtag{$key}=$val;
218: }
219: close($fh);
220: }
1.12 harris41 221: }
1.351 www 222: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 223: {
224: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
225: '/source_copyright.tab';
226: if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356 albertel 227: while (my $line = <$fh>) {
228: next if ($line =~ /^\#/);
229: chomp($line);
230: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 231: $scprtag{$key}=$val;
232: }
233: close($fh);
234: }
235: }
1.63 www 236:
1.517 raeburn 237: # -------------------------------------------------------------- default domain designs
1.63 www 238: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 239: my $designfile = $designdir.'/default.tab';
240: if ( open (my $fh,"<$designfile") ) {
241: while (my $line = <$fh>) {
242: next if ($line =~ /^\#/);
243: chomp($line);
244: my ($key,$val)=(split(/\=/,$line));
245: if ($val) { $defaultdesign{$key}=$val; }
246: }
247: close($fh);
1.63 www 248: }
249:
1.15 harris41 250: # ------------------------------------------------------------- file categories
251: {
1.158 raeburn 252: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
253: '/filecategories.tab';
254: if ( open (my $fh,"<$categoryfile") ) {
1.356 albertel 255: while (my $line = <$fh>) {
256: next if ($line =~ /^\#/);
257: chomp($line);
258: my ($extension,$category)=(split(/\s+/,$line,2));
1.158 raeburn 259: push @{$category_extensions{lc($category)}},$extension;
260: }
261: close($fh);
262: }
263:
1.15 harris41 264: }
1.12 harris41 265: # ------------------------------------------------------------------ file types
266: {
1.158 raeburn 267: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
268: '/filetypes.tab';
269: if ( open (my $fh,"<$typesfile") ) {
1.356 albertel 270: while (my $line = <$fh>) {
271: next if ($line =~ /^\#/);
272: chomp($line);
273: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 274: if ($descr ne '') {
275: $fe{$ending}=lc($emb);
276: $fd{$ending}=$descr;
1.351 www 277: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 278: }
279: }
280: close($fh);
281: }
1.12 harris41 282: }
1.22 www 283: &Apache::lonnet::logthis(
1.705 tempelho 284: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 285: $readit=1;
1.46 matthew 286: } # end of unless($readit)
1.32 matthew 287:
288: }
1.112 bowersj2 289:
1.42 matthew 290: ###############################################################
291: ## HTML and Javascript Helper Functions ##
292: ###############################################################
293:
294: =pod
295:
1.112 bowersj2 296: =head1 HTML and Javascript Functions
1.42 matthew 297:
1.112 bowersj2 298: =over 4
299:
1.648 raeburn 300: =item * &browser_and_searcher_javascript()
1.112 bowersj2 301:
302: X<browsing, javascript>X<searching, javascript>Returns a string
303: containing javascript with two functions, C<openbrowser> and
304: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
305: tags.
1.42 matthew 306:
1.648 raeburn 307: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 308:
309: inputs: formname, elementname, only, omit
310:
311: formname and elementname indicate the name of the html form and name of
312: the element that the results of the browsing selection are to be placed in.
313:
314: Specifying 'only' will restrict the browser to displaying only files
1.185 www 315: with the given extension. Can be a comma separated list.
1.42 matthew 316:
317: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 318: with the given extension. Can be a comma separated list.
1.42 matthew 319:
1.648 raeburn 320: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 321:
322: Inputs: formname, elementname
323:
324: formname and elementname specify the name of the html form and the name
325: of the element the selection from the search results will be placed in.
1.542 raeburn 326:
1.42 matthew 327: =cut
328:
329: sub browser_and_searcher_javascript {
1.199 albertel 330: my ($mode)=@_;
331: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 332: my $resurl=&escape_single(&lastresurl());
1.42 matthew 333: return <<END;
1.219 albertel 334: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 335: var editbrowser = null;
1.135 albertel 336: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 337: var url = '$resurl/?';
1.42 matthew 338: if (editbrowser == null) {
339: url += 'launch=1&';
340: }
341: url += 'catalogmode=interactive&';
1.199 albertel 342: url += 'mode=$mode&';
1.611 albertel 343: url += 'inhibitmenu=yes&';
1.42 matthew 344: url += 'form=' + formname + '&';
345: if (only != null) {
346: url += 'only=' + only + '&';
1.217 albertel 347: } else {
348: url += 'only=&';
349: }
1.42 matthew 350: if (omit != null) {
351: url += 'omit=' + omit + '&';
1.217 albertel 352: } else {
353: url += 'omit=&';
354: }
1.135 albertel 355: if (titleelement != null) {
356: url += 'titleelement=' + titleelement + '&';
1.217 albertel 357: } else {
358: url += 'titleelement=&';
359: }
1.42 matthew 360: url += 'element=' + elementname + '';
361: var title = 'Browser';
1.435 albertel 362: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 363: options += ',width=700,height=600';
364: editbrowser = open(url,title,options,'1');
365: editbrowser.focus();
366: }
367: var editsearcher;
1.135 albertel 368: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 369: var url = '/adm/searchcat?';
370: if (editsearcher == null) {
371: url += 'launch=1&';
372: }
373: url += 'catalogmode=interactive&';
1.199 albertel 374: url += 'mode=$mode&';
1.42 matthew 375: url += 'form=' + formname + '&';
1.135 albertel 376: if (titleelement != null) {
377: url += 'titleelement=' + titleelement + '&';
1.217 albertel 378: } else {
379: url += 'titleelement=&';
380: }
1.42 matthew 381: url += 'element=' + elementname + '';
382: var title = 'Search';
1.435 albertel 383: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 384: options += ',width=700,height=600';
385: editsearcher = open(url,title,options,'1');
386: editsearcher.focus();
387: }
1.219 albertel 388: // END LON-CAPA Internal -->
1.42 matthew 389: END
1.170 www 390: }
391:
392: sub lastresurl {
1.258 albertel 393: if ($env{'environment.lastresurl'}) {
394: return $env{'environment.lastresurl'}
1.170 www 395: } else {
396: return '/res';
397: }
398: }
399:
400: sub storeresurl {
401: my $resurl=&Apache::lonnet::clutter(shift);
402: unless ($resurl=~/^\/res/) { return 0; }
403: $resurl=~s/\/$//;
404: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 405: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 406: return 1;
1.42 matthew 407: }
408:
1.74 www 409: sub studentbrowser_javascript {
1.111 www 410: unless (
1.258 albertel 411: (($env{'request.course.id'}) &&
1.302 albertel 412: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
413: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
414: '/'.$env{'request.course.sec'})
415: ))
1.258 albertel 416: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 417: ) { return ''; }
1.74 www 418: return (<<'ENDSTDBRW');
1.776 bisitz 419: <script type="text/javascript" language="Javascript">
1.824 bisitz 420: // <![CDATA[
1.74 www 421: var stdeditbrowser;
1.999 www 422: function openstdbrowser(formname,uname,udom,clicker,roleflag,ignorefilter,courseadvonly) {
1.74 www 423: var url = '/adm/pickstudent?';
424: var filter;
1.558 albertel 425: if (!ignorefilter) {
426: eval('filter=document.'+formname+'.'+uname+'.value;');
427: }
1.74 www 428: if (filter != null) {
429: if (filter != '') {
430: url += 'filter='+filter+'&';
431: }
432: }
433: url += 'form=' + formname + '&unameelement='+uname+
1.999 www 434: '&udomelement='+udom+
435: '&clicker='+clicker;
1.111 www 436: if (roleflag) { url+="&roles=1"; }
1.793 raeburn 437: if (courseadvonly) { url+="&courseadvonly=1"; }
1.102 www 438: var title = 'Student_Browser';
1.74 www 439: var options = 'scrollbars=1,resizable=1,menubar=0';
440: options += ',width=700,height=600';
441: stdeditbrowser = open(url,title,options,'1');
442: stdeditbrowser.focus();
443: }
1.824 bisitz 444: // ]]>
1.74 www 445: </script>
446: ENDSTDBRW
447: }
1.42 matthew 448:
1.1003 www 449: sub resourcebrowser_javascript {
450: unless ($env{'request.course.id'}) { return ''; }
1.1004 www 451: return (<<'ENDRESBRW');
1.1003 www 452: <script type="text/javascript" language="Javascript">
453: // <![CDATA[
454: var reseditbrowser;
1.1004 www 455: function openresbrowser(formname,reslink) {
1.1005 www 456: var url = '/adm/pickresource?form='+formname+'&reslink='+reslink;
1.1003 www 457: var title = 'Resource_Browser';
458: var options = 'scrollbars=1,resizable=1,menubar=0';
1.1005 www 459: options += ',width=700,height=500';
1.1004 www 460: reseditbrowser = open(url,title,options,'1');
461: reseditbrowser.focus();
1.1003 www 462: }
463: // ]]>
464: </script>
1.1004 www 465: ENDRESBRW
1.1003 www 466: }
467:
1.74 www 468: sub selectstudent_link {
1.999 www 469: my ($form,$unameele,$udomele,$courseadvonly,$clickerid)=@_;
470: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
471: &Apache::lonhtmlcommon::entity_encode($unameele)."','".
472: &Apache::lonhtmlcommon::entity_encode($udomele)."'";
1.258 albertel 473: if ($env{'request.course.id'}) {
1.302 albertel 474: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
475: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
476: '/'.$env{'request.course.sec'})) {
1.111 www 477: return '';
478: }
1.999 www 479: $callargs.=",'".&Apache::lonhtmlcommon::entity_encode($clickerid)."'";
1.793 raeburn 480: if ($courseadvonly) {
481: $callargs .= ",'',1,1";
482: }
483: return '<span class="LC_nobreak">'.
484: '<a href="javascript:openstdbrowser('.$callargs.');">'.
485: &mt('Select User').'</a></span>';
1.74 www 486: }
1.258 albertel 487: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.1012 www 488: $callargs .= ",'',1";
1.793 raeburn 489: return '<span class="LC_nobreak">'.
490: '<a href="javascript:openstdbrowser('.$callargs.');">'.
491: &mt('Select User').'</a></span>';
1.111 www 492: }
493: return '';
1.91 www 494: }
495:
1.1004 www 496: sub selectresource_link {
497: my ($form,$reslink,$arg)=@_;
498:
499: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
500: &Apache::lonhtmlcommon::entity_encode($reslink)."'";
501: unless ($env{'request.course.id'}) { return $arg; }
502: return '<span class="LC_nobreak">'.
503: '<a href="javascript:openresbrowser('.$callargs.');">'.
504: $arg.'</a></span>';
505: }
506:
507:
508:
1.653 raeburn 509: sub authorbrowser_javascript {
510: return <<"ENDAUTHORBRW";
1.776 bisitz 511: <script type="text/javascript" language="JavaScript">
1.824 bisitz 512: // <![CDATA[
1.653 raeburn 513: var stdeditbrowser;
514:
515: function openauthorbrowser(formname,udom) {
516: var url = '/adm/pickauthor?';
517: url += 'form='+formname+'&roledom='+udom;
518: var title = 'Author_Browser';
519: var options = 'scrollbars=1,resizable=1,menubar=0';
520: options += ',width=700,height=600';
521: stdeditbrowser = open(url,title,options,'1');
522: stdeditbrowser.focus();
523: }
524:
1.824 bisitz 525: // ]]>
1.653 raeburn 526: </script>
527: ENDAUTHORBRW
528: }
529:
1.91 www 530: sub coursebrowser_javascript {
1.1075.2.31 raeburn 531: my ($domainfilter,$sec_element,$formname,$role_element,$crstype,
532: $credits_element) = @_;
1.932 raeburn 533: my $wintitle = 'Course_Browser';
1.931 raeburn 534: if ($crstype eq 'Community') {
1.932 raeburn 535: $wintitle = 'Community_Browser';
1.909 raeburn 536: }
1.876 raeburn 537: my $id_functions = &javascript_index_functions();
538: my $output = '
1.776 bisitz 539: <script type="text/javascript" language="JavaScript">
1.824 bisitz 540: // <![CDATA[
1.468 raeburn 541: var stdeditbrowser;'."\n";
1.876 raeburn 542:
543: $output .= <<"ENDSTDBRW";
1.909 raeburn 544: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91 www 545: var url = '/adm/pickcourse?';
1.895 raeburn 546: var formid = getFormIdByName(formname);
1.876 raeburn 547: var domainfilter = getDomainFromSelectbox(formname,udom);
1.128 albertel 548: if (domainfilter != null) {
549: if (domainfilter != '') {
550: url += 'domainfilter='+domainfilter+'&';
551: }
552: }
1.91 www 553: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 554: '&cdomelement='+udom+
555: '&cnameelement='+desc;
1.468 raeburn 556: if (extra_element !=null && extra_element != '') {
1.594 raeburn 557: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 558: url += '&roleelement='+extra_element;
559: if (domainfilter == null || domainfilter == '') {
560: url += '&domainfilter='+extra_element;
561: }
1.234 raeburn 562: }
1.468 raeburn 563: else {
564: if (formname == 'portform') {
565: url += '&setroles='+extra_element;
1.800 raeburn 566: } else {
567: if (formname == 'rules') {
568: url += '&fixeddom='+extra_element;
569: }
1.468 raeburn 570: }
571: }
1.230 raeburn 572: }
1.909 raeburn 573: if (type != null && type != '') {
574: url += '&type='+type;
575: }
576: if (type_elem != null && type_elem != '') {
577: url += '&typeelement='+type_elem;
578: }
1.872 raeburn 579: if (formname == 'ccrs') {
580: var ownername = document.forms[formid].ccuname.value;
581: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
582: url += '&cloner='+ownername+':'+ownerdom;
583: }
1.293 raeburn 584: if (multflag !=null && multflag != '') {
585: url += '&multiple='+multflag;
586: }
1.909 raeburn 587: var title = '$wintitle';
1.91 www 588: var options = 'scrollbars=1,resizable=1,menubar=0';
589: options += ',width=700,height=600';
590: stdeditbrowser = open(url,title,options,'1');
591: stdeditbrowser.focus();
592: }
1.876 raeburn 593: $id_functions
594: ENDSTDBRW
1.1075.2.31 raeburn 595: if (($sec_element ne '') || ($role_element ne '') || ($credits_element ne '')) {
596: $output .= &setsec_javascript($sec_element,$formname,$role_element,
597: $credits_element);
1.876 raeburn 598: }
599: $output .= '
600: // ]]>
601: </script>';
602: return $output;
603: }
604:
605: sub javascript_index_functions {
606: return <<"ENDJS";
607:
608: function getFormIdByName(formname) {
609: for (var i=0;i<document.forms.length;i++) {
610: if (document.forms[i].name == formname) {
611: return i;
612: }
613: }
614: return -1;
615: }
616:
617: function getIndexByName(formid,item) {
618: for (var i=0;i<document.forms[formid].elements.length;i++) {
619: if (document.forms[formid].elements[i].name == item) {
620: return i;
621: }
622: }
623: return -1;
624: }
1.468 raeburn 625:
1.876 raeburn 626: function getDomainFromSelectbox(formname,udom) {
627: var userdom;
628: var formid = getFormIdByName(formname);
629: if (formid > -1) {
630: var domid = getIndexByName(formid,udom);
631: if (domid > -1) {
632: if (document.forms[formid].elements[domid].type == 'select-one') {
633: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
634: }
635: if (document.forms[formid].elements[domid].type == 'hidden') {
636: userdom=document.forms[formid].elements[domid].value;
1.468 raeburn 637: }
638: }
639: }
1.876 raeburn 640: return userdom;
641: }
642:
643: ENDJS
1.468 raeburn 644:
1.876 raeburn 645: }
646:
1.1017 raeburn 647: sub javascript_array_indexof {
1.1018 raeburn 648: return <<ENDJS;
1.1017 raeburn 649: <script type="text/javascript" language="JavaScript">
650: // <![CDATA[
651:
652: if (!Array.prototype.indexOf) {
653: Array.prototype.indexOf = function (searchElement /*, fromIndex */ ) {
654: "use strict";
655: if (this === void 0 || this === null) {
656: throw new TypeError();
657: }
658: var t = Object(this);
659: var len = t.length >>> 0;
660: if (len === 0) {
661: return -1;
662: }
663: var n = 0;
664: if (arguments.length > 0) {
665: n = Number(arguments[1]);
666: if (n !== n) { // shortcut for verifying if it's NaN
667: n = 0;
668: } else if (n !== 0 && n !== (1 / 0) && n !== -(1 / 0)) {
669: n = (n > 0 || -1) * Math.floor(Math.abs(n));
670: }
671: }
672: if (n >= len) {
673: return -1;
674: }
675: var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
676: for (; k < len; k++) {
677: if (k in t && t[k] === searchElement) {
678: return k;
679: }
680: }
681: return -1;
682: }
683: }
684:
685: // ]]>
686: </script>
687:
688: ENDJS
689:
690: }
691:
1.876 raeburn 692: sub userbrowser_javascript {
693: my $id_functions = &javascript_index_functions();
694: return <<"ENDUSERBRW";
695:
1.888 raeburn 696: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876 raeburn 697: var url = '/adm/pickuser?';
698: var userdom = getDomainFromSelectbox(formname,udom);
699: if (userdom != null) {
700: if (userdom != '') {
701: url += 'srchdom='+userdom+'&';
702: }
703: }
704: url += 'form=' + formname + '&unameelement='+uname+
705: '&udomelement='+udom+
706: '&ulastelement='+ulast+
707: '&ufirstelement='+ufirst+
708: '&uemailelement='+uemail+
1.881 raeburn 709: '&hideudomelement='+hideudom+
710: '&coursedom='+crsdom;
1.888 raeburn 711: if ((caller != null) && (caller != undefined)) {
712: url += '&caller='+caller;
713: }
1.876 raeburn 714: var title = 'User_Browser';
715: var options = 'scrollbars=1,resizable=1,menubar=0';
716: options += ',width=700,height=600';
717: var stdeditbrowser = open(url,title,options,'1');
718: stdeditbrowser.focus();
719: }
720:
1.888 raeburn 721: function fix_domain (formname,udom,origdom,uname) {
1.876 raeburn 722: var formid = getFormIdByName(formname);
723: if (formid > -1) {
1.888 raeburn 724: var unameid = getIndexByName(formid,uname);
1.876 raeburn 725: var domid = getIndexByName(formid,udom);
726: var hidedomid = getIndexByName(formid,origdom);
727: if (hidedomid > -1) {
728: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888 raeburn 729: var unameval = document.forms[formid].elements[unameid].value;
730: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
731: if (domid > -1) {
732: var slct = document.forms[formid].elements[domid];
733: if (slct.type == 'select-one') {
734: var i;
735: for (i=0;i<slct.length;i++) {
736: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
737: }
738: }
739: if (slct.type == 'hidden') {
740: slct.value = fixeddom;
1.876 raeburn 741: }
742: }
1.468 raeburn 743: }
744: }
745: }
1.876 raeburn 746: return;
747: }
748:
749: $id_functions
750: ENDUSERBRW
1.468 raeburn 751: }
752:
753: sub setsec_javascript {
1.1075.2.31 raeburn 754: my ($sec_element,$formname,$role_element,$credits_element) = @_;
1.905 raeburn 755: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
756: $communityrolestr);
757: if ($role_element ne '') {
758: my @allroles = ('st','ta','ep','in','ad');
759: foreach my $crstype ('Course','Community') {
760: if ($crstype eq 'Community') {
761: foreach my $role (@allroles) {
762: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
763: }
764: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
765: } else {
766: foreach my $role (@allroles) {
767: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
768: }
769: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
770: }
771: }
772: $rolestr = '"'.join('","',@allroles).'"';
773: $courserolestr = '"'.join('","',@courserolenames).'"';
774: $communityrolestr = '"'.join('","',@communityrolenames).'"';
775: }
1.468 raeburn 776: my $setsections = qq|
777: function setSect(sectionlist) {
1.629 raeburn 778: var sectionsArray = new Array();
779: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
780: sectionsArray = sectionlist.split(",");
781: }
1.468 raeburn 782: var numSections = sectionsArray.length;
783: document.$formname.$sec_element.length = 0;
784: if (numSections == 0) {
785: document.$formname.$sec_element.multiple=false;
786: document.$formname.$sec_element.size=1;
787: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
788: } else {
789: if (numSections == 1) {
790: document.$formname.$sec_element.multiple=false;
791: document.$formname.$sec_element.size=1;
792: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
793: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
794: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
795: } else {
796: for (var i=0; i<numSections; i++) {
797: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
798: }
799: document.$formname.$sec_element.multiple=true
800: if (numSections < 3) {
801: document.$formname.$sec_element.size=numSections;
802: } else {
803: document.$formname.$sec_element.size=3;
804: }
805: document.$formname.$sec_element.options[0].selected = false
806: }
807: }
1.91 www 808: }
1.905 raeburn 809:
810: function setRole(crstype) {
1.468 raeburn 811: |;
1.905 raeburn 812: if ($role_element eq '') {
813: $setsections .= ' return;
814: }
815: ';
816: } else {
817: $setsections .= qq|
818: var elementLength = document.$formname.$role_element.length;
819: var allroles = Array($rolestr);
820: var courserolenames = Array($courserolestr);
821: var communityrolenames = Array($communityrolestr);
822: if (elementLength != undefined) {
823: if (document.$formname.$role_element.options[5].value == 'cc') {
824: if (crstype == 'Course') {
825: return;
826: } else {
827: allroles[5] = 'co';
828: for (var i=0; i<6; i++) {
829: document.$formname.$role_element.options[i].value = allroles[i];
830: document.$formname.$role_element.options[i].text = communityrolenames[i];
831: }
832: }
833: } else {
834: if (crstype == 'Community') {
835: return;
836: } else {
837: allroles[5] = 'cc';
838: for (var i=0; i<6; i++) {
839: document.$formname.$role_element.options[i].value = allroles[i];
840: document.$formname.$role_element.options[i].text = courserolenames[i];
841: }
842: }
843: }
844: }
845: return;
846: }
847: |;
848: }
1.1075.2.31 raeburn 849: if ($credits_element) {
850: $setsections .= qq|
851: function setCredits(defaultcredits) {
852: document.$formname.$credits_element.value = defaultcredits;
853: return;
854: }
855: |;
856: }
1.468 raeburn 857: return $setsections;
858: }
859:
1.91 www 860: sub selectcourse_link {
1.909 raeburn 861: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
862: $typeelement) = @_;
863: my $type = $selecttype;
1.871 raeburn 864: my $linktext = &mt('Select Course');
865: if ($selecttype eq 'Community') {
1.909 raeburn 866: $linktext = &mt('Select Community');
1.906 raeburn 867: } elsif ($selecttype eq 'Course/Community') {
868: $linktext = &mt('Select Course/Community');
1.909 raeburn 869: $type = '';
1.1019 raeburn 870: } elsif ($selecttype eq 'Select') {
871: $linktext = &mt('Select');
872: $type = '';
1.871 raeburn 873: }
1.787 bisitz 874: return '<span class="LC_nobreak">'
875: ."<a href='"
876: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
877: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 878: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 879: ."'>".$linktext.'</a>'
1.787 bisitz 880: .'</span>';
1.74 www 881: }
1.42 matthew 882:
1.653 raeburn 883: sub selectauthor_link {
884: my ($form,$udom)=@_;
885: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
886: &mt('Select Author').'</a>';
887: }
888:
1.876 raeburn 889: sub selectuser_link {
1.881 raeburn 890: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 891: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 892: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 893: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 894: ');">'.$linktext.'</a>';
1.876 raeburn 895: }
896:
1.273 raeburn 897: sub check_uncheck_jscript {
898: my $jscript = <<"ENDSCRT";
899: function checkAll(field) {
900: if (field.length > 0) {
901: for (i = 0; i < field.length; i++) {
1.1075.2.14 raeburn 902: if (!field[i].disabled) {
903: field[i].checked = true;
904: }
1.273 raeburn 905: }
906: } else {
1.1075.2.14 raeburn 907: if (!field.disabled) {
908: field.checked = true;
909: }
1.273 raeburn 910: }
911: }
912:
913: function uncheckAll(field) {
914: if (field.length > 0) {
915: for (i = 0; i < field.length; i++) {
916: field[i].checked = false ;
1.543 albertel 917: }
918: } else {
1.273 raeburn 919: field.checked = false ;
920: }
921: }
922: ENDSCRT
923: return $jscript;
924: }
925:
1.656 www 926: sub select_timezone {
1.659 raeburn 927: my ($name,$selected,$onchange,$includeempty)=@_;
928: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
929: if ($includeempty) {
930: $output .= '<option value=""';
931: if (($selected eq '') || ($selected eq 'local')) {
932: $output .= ' selected="selected" ';
933: }
934: $output .= '> </option>';
935: }
1.657 raeburn 936: my @timezones = DateTime::TimeZone->all_names;
937: foreach my $tzone (@timezones) {
938: $output.= '<option value="'.$tzone.'"';
939: if ($tzone eq $selected) {
940: $output.=' selected="selected"';
941: }
942: $output.=">$tzone</option>\n";
1.656 www 943: }
944: $output.="</select>";
945: return $output;
946: }
1.273 raeburn 947:
1.687 raeburn 948: sub select_datelocale {
949: my ($name,$selected,$onchange,$includeempty)=@_;
950: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
951: if ($includeempty) {
952: $output .= '<option value=""';
953: if ($selected eq '') {
954: $output .= ' selected="selected" ';
955: }
956: $output .= '> </option>';
957: }
958: my (@possibles,%locale_names);
959: my @locales = DateTime::Locale::Catalog::Locales;
960: foreach my $locale (@locales) {
961: if (ref($locale) eq 'HASH') {
962: my $id = $locale->{'id'};
963: if ($id ne '') {
964: my $en_terr = $locale->{'en_territory'};
965: my $native_terr = $locale->{'native_territory'};
1.695 raeburn 966: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 967: if (grep(/^en$/,@languages) || !@languages) {
968: if ($en_terr ne '') {
969: $locale_names{$id} = '('.$en_terr.')';
970: } elsif ($native_terr ne '') {
971: $locale_names{$id} = $native_terr;
972: }
973: } else {
974: if ($native_terr ne '') {
975: $locale_names{$id} = $native_terr.' ';
976: } elsif ($en_terr ne '') {
977: $locale_names{$id} = '('.$en_terr.')';
978: }
979: }
980: push (@possibles,$id);
981: }
982: }
983: }
984: foreach my $item (sort(@possibles)) {
985: $output.= '<option value="'.$item.'"';
986: if ($item eq $selected) {
987: $output.=' selected="selected"';
988: }
989: $output.=">$item";
990: if ($locale_names{$item} ne '') {
991: $output.=" $locale_names{$item}</option>\n";
992: }
993: $output.="</option>\n";
994: }
995: $output.="</select>";
996: return $output;
997: }
998:
1.792 raeburn 999: sub select_language {
1000: my ($name,$selected,$includeempty) = @_;
1001: my %langchoices;
1002: if ($includeempty) {
1.1075.2.32 raeburn 1003: %langchoices = ('' => 'No language preference');
1.792 raeburn 1004: }
1005: foreach my $id (&languageids()) {
1006: my $code = &supportedlanguagecode($id);
1007: if ($code) {
1008: $langchoices{$code} = &plainlanguagedescription($id);
1009: }
1010: }
1.1075.2.32 raeburn 1011: %langchoices = &Apache::lonlocal::texthash(%langchoices);
1.970 raeburn 1012: return &select_form($selected,$name,\%langchoices);
1.792 raeburn 1013: }
1014:
1.42 matthew 1015: =pod
1.36 matthew 1016:
1.648 raeburn 1017: =item * &linked_select_forms(...)
1.36 matthew 1018:
1019: linked_select_forms returns a string containing a <script></script> block
1020: and html for two <select> menus. The select menus will be linked in that
1021: changing the value of the first menu will result in new values being placed
1022: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 1023: order unless a defined order is provided.
1.36 matthew 1024:
1025: linked_select_forms takes the following ordered inputs:
1026:
1027: =over 4
1028:
1.112 bowersj2 1029: =item * $formname, the name of the <form> tag
1.36 matthew 1030:
1.112 bowersj2 1031: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 1032:
1.112 bowersj2 1033: =item * $firstdefault, the default value for the first menu
1.36 matthew 1034:
1.112 bowersj2 1035: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 1036:
1.112 bowersj2 1037: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 1038:
1.112 bowersj2 1039: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 1040:
1.609 raeburn 1041: =item * $menuorder, the order of values in the first menu
1042:
1.1075.2.31 raeburn 1043: =item * $onchangefirst, additional javascript call to execute for an onchange
1044: event for the first <select> tag
1045:
1046: =item * $onchangesecond, additional javascript call to execute for an onchange
1047: event for the second <select> tag
1048:
1.41 ng 1049: =back
1050:
1.36 matthew 1051: Below is an example of such a hash. Only the 'text', 'default', and
1052: 'select2' keys must appear as stated. keys(%menu) are the possible
1053: values for the first select menu. The text that coincides with the
1.41 ng 1054: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 1055: and text for the second menu are given in the hash pointed to by
1056: $menu{$choice1}->{'select2'}.
1057:
1.112 bowersj2 1058: my %menu = ( A1 => { text =>"Choice A1" ,
1059: default => "B3",
1060: select2 => {
1061: B1 => "Choice B1",
1062: B2 => "Choice B2",
1063: B3 => "Choice B3",
1064: B4 => "Choice B4"
1.609 raeburn 1065: },
1066: order => ['B4','B3','B1','B2'],
1.112 bowersj2 1067: },
1068: A2 => { text =>"Choice A2" ,
1069: default => "C2",
1070: select2 => {
1071: C1 => "Choice C1",
1072: C2 => "Choice C2",
1073: C3 => "Choice C3"
1.609 raeburn 1074: },
1075: order => ['C2','C1','C3'],
1.112 bowersj2 1076: },
1077: A3 => { text =>"Choice A3" ,
1078: default => "D6",
1079: select2 => {
1080: D1 => "Choice D1",
1081: D2 => "Choice D2",
1082: D3 => "Choice D3",
1083: D4 => "Choice D4",
1084: D5 => "Choice D5",
1085: D6 => "Choice D6",
1086: D7 => "Choice D7"
1.609 raeburn 1087: },
1088: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 1089: }
1090: );
1.36 matthew 1091:
1092: =cut
1093:
1094: sub linked_select_forms {
1095: my ($formname,
1096: $middletext,
1097: $firstdefault,
1098: $firstselectname,
1099: $secondselectname,
1.609 raeburn 1100: $hashref,
1101: $menuorder,
1.1075.2.31 raeburn 1102: $onchangefirst,
1103: $onchangesecond
1.36 matthew 1104: ) = @_;
1105: my $second = "document.$formname.$secondselectname";
1106: my $first = "document.$formname.$firstselectname";
1107: # output the javascript to do the changing
1108: my $result = '';
1.776 bisitz 1109: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 1110: $result.="// <![CDATA[\n";
1.36 matthew 1111: $result.="var select2data = new Object();\n";
1112: $" = '","';
1113: my $debug = '';
1114: foreach my $s1 (sort(keys(%$hashref))) {
1115: $result.="select2data.d_$s1 = new Object();\n";
1116: $result.="select2data.d_$s1.def = new String('".
1117: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 1118: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 1119: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1120: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1121: @s2values = @{$hashref->{$s1}->{'order'}};
1122: }
1.36 matthew 1123: $result.="\"@s2values\");\n";
1124: $result.="select2data.d_$s1.texts = new Array(";
1125: my @s2texts;
1126: foreach my $value (@s2values) {
1127: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
1128: }
1129: $result.="\"@s2texts\");\n";
1130: }
1131: $"=' ';
1132: $result.= <<"END";
1133:
1134: function select1_changed() {
1135: // Determine new choice
1136: var newvalue = "d_" + $first.value;
1137: // update select2
1138: var values = select2data[newvalue].values;
1139: var texts = select2data[newvalue].texts;
1140: var select2def = select2data[newvalue].def;
1141: var i;
1142: // out with the old
1143: for (i = 0; i < $second.options.length; i++) {
1144: $second.options[i] = null;
1145: }
1146: // in with the nuclear
1147: for (i=0;i<values.length; i++) {
1148: $second.options[i] = new Option(values[i]);
1.143 matthew 1149: $second.options[i].value = values[i];
1.36 matthew 1150: $second.options[i].text = texts[i];
1151: if (values[i] == select2def) {
1152: $second.options[i].selected = true;
1153: }
1154: }
1155: }
1.824 bisitz 1156: // ]]>
1.36 matthew 1157: </script>
1158: END
1159: # output the initial values for the selection lists
1.1075.2.31 raeburn 1160: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed();$onchangefirst\">\n";
1.609 raeburn 1161: my @order = sort(keys(%{$hashref}));
1162: if (ref($menuorder) eq 'ARRAY') {
1163: @order = @{$menuorder};
1164: }
1165: foreach my $value (@order) {
1.36 matthew 1166: $result.=" <option value=\"$value\" ";
1.253 albertel 1167: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1168: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1169: }
1170: $result .= "</select>\n";
1171: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1172: $result .= $middletext;
1.1075.2.31 raeburn 1173: $result .= "<select size=\"1\" name=\"$secondselectname\"";
1174: if ($onchangesecond) {
1175: $result .= ' onchange="'.$onchangesecond.'"';
1176: }
1177: $result .= ">\n";
1.36 matthew 1178: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1179:
1180: my @secondorder = sort(keys(%select2));
1181: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1182: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1183: }
1184: foreach my $value (@secondorder) {
1.36 matthew 1185: $result.=" <option value=\"$value\" ";
1.253 albertel 1186: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1187: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1188: }
1189: $result .= "</select>\n";
1190: # return $debug;
1191: return $result;
1192: } # end of sub linked_select_forms {
1193:
1.45 matthew 1194: =pod
1.44 bowersj2 1195:
1.973 raeburn 1196: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid)
1.44 bowersj2 1197:
1.112 bowersj2 1198: Returns a string corresponding to an HTML link to the given help
1199: $topic, where $topic corresponds to the name of a .tex file in
1200: /home/httpd/html/adm/help/tex, with underscores replaced by
1201: spaces.
1202:
1203: $text will optionally be linked to the same topic, allowing you to
1204: link text in addition to the graphic. If you do not want to link
1205: text, but wish to specify one of the later parameters, pass an
1206: empty string.
1207:
1208: $stayOnPage is a value that will be interpreted as a boolean. If true,
1209: the link will not open a new window. If false, the link will open
1210: a new window using Javascript. (Default is false.)
1211:
1212: $width and $height are optional numerical parameters that will
1213: override the width and height of the popped up window, which may
1.973 raeburn 1214: be useful for certain help topics with big pictures included.
1215:
1216: $imgid is the id of the img tag used for the help icon. This may be
1217: used in a javascript call to switch the image src. See
1218: lonhtmlcommon::htmlareaselectactive() for an example.
1.44 bowersj2 1219:
1220: =cut
1221:
1222: sub help_open_topic {
1.973 raeburn 1223: my ($topic, $text, $stayOnPage, $width, $height, $imgid) = @_;
1.48 bowersj2 1224: $text = "" if (not defined $text);
1.44 bowersj2 1225: $stayOnPage = 0 if (not defined $stayOnPage);
1.1033 www 1226: $width = 500 if (not defined $width);
1.44 bowersj2 1227: $height = 400 if (not defined $height);
1228: my $filename = $topic;
1229: $filename =~ s/ /_/g;
1230:
1.48 bowersj2 1231: my $template = "";
1232: my $link;
1.572 banghart 1233:
1.159 www 1234: $topic=~s/\W/\_/g;
1.44 bowersj2 1235:
1.572 banghart 1236: if (!$stayOnPage) {
1.1033 www 1237: $link = "javascript:openMyModal('/adm/help/${filename}.hlp',$width,$height,'yes');";
1.1037 www 1238: } elsif ($stayOnPage eq 'popup') {
1239: $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 1240: } else {
1.48 bowersj2 1241: $link = "/adm/help/${filename}.hlp";
1242: }
1243:
1244: # Add the text
1.755 neumanie 1245: if ($text ne "") {
1.763 bisitz 1246: $template.='<span class="LC_help_open_topic">'
1247: .'<a target="_top" href="'.$link.'">'
1248: .$text.'</a>';
1.48 bowersj2 1249: }
1250:
1.763 bisitz 1251: # (Always) Add the graphic
1.179 matthew 1252: my $title = &mt('Online Help');
1.667 raeburn 1253: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973 raeburn 1254: if ($imgid ne '') {
1255: $imgid = ' id="'.$imgid.'"';
1256: }
1.763 bisitz 1257: $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
1258: .'<img src="'.$helpicon.'" border="0"'
1259: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973 raeburn 1260: .' title="'.$title.'" style="vertical-align:middle;"'.$imgid
1.763 bisitz 1261: .' /></a>';
1262: if ($text ne "") {
1263: $template.='</span>';
1264: }
1.44 bowersj2 1265: return $template;
1266:
1.106 bowersj2 1267: }
1268:
1269: # This is a quicky function for Latex cheatsheet editing, since it
1270: # appears in at least four places
1271: sub helpLatexCheatsheet {
1.1037 www 1272: my ($topic,$text,$not_author,$stayOnPage) = @_;
1.732 raeburn 1273: my $out;
1.106 bowersj2 1274: my $addOther = '';
1.732 raeburn 1275: if ($topic) {
1.1037 www 1276: $addOther = '<span>'.&help_open_topic($topic,&mt($text),$stayOnPage, undef, 600).'</span> ';
1.763 bisitz 1277: }
1278: $out = '<span>' # Start cheatsheet
1279: .$addOther
1280: .'<span>'
1.1037 www 1281: .&help_open_topic('Greek_Symbols',&mt('Greek Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1282: .'</span> <span>'
1.1037 www 1283: .&help_open_topic('Other_Symbols',&mt('Other Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1284: .'</span>';
1.732 raeburn 1285: unless ($not_author) {
1.763 bisitz 1286: $out .= ' <span>'
1.1037 www 1287: .&help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),$stayOnPage,undef,600)
1.763 bisitz 1288: .'</span>';
1.732 raeburn 1289: }
1.763 bisitz 1290: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1291: return $out;
1.172 www 1292: }
1293:
1.430 albertel 1294: sub general_help {
1295: my $helptopic='Student_Intro';
1296: if ($env{'request.role'}=~/^(ca|au)/) {
1297: $helptopic='Authoring_Intro';
1.907 raeburn 1298: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1299: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1300: } elsif ($env{'request.role'}=~/^dc/) {
1301: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1302: }
1303: return $helptopic;
1304: }
1305:
1306: sub update_help_link {
1307: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1308: my $origurl = $ENV{'REQUEST_URI'};
1309: $origurl=~s|^/~|/priv/|;
1310: my $timestamp = time;
1311: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1312: $$datum = &escape($$datum);
1313: }
1314:
1315: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1316: my $output .= <<"ENDOUTPUT";
1317: <script type="text/javascript">
1.824 bisitz 1318: // <![CDATA[
1.430 albertel 1319: banner_link = '$banner_link';
1.824 bisitz 1320: // ]]>
1.430 albertel 1321: </script>
1322: ENDOUTPUT
1323: return $output;
1324: }
1325:
1326: # now just updates the help link and generates a blue icon
1.193 raeburn 1327: sub help_open_menu {
1.430 albertel 1328: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1329: = @_;
1.949 droeschl 1330: $stayOnPage = 1;
1.430 albertel 1331: my $output;
1332: if ($component_help) {
1333: if (!$text) {
1334: $output=&help_open_topic($component_help,undef,$stayOnPage,
1335: $width,$height);
1336: } else {
1337: my $help_text;
1338: $help_text=&unescape($topic);
1339: $output='<table><tr><td>'.
1340: &help_open_topic($component_help,$help_text,$stayOnPage,
1341: $width,$height).'</td></tr></table>';
1342: }
1343: }
1344: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1345: return $output.$banner_link;
1346: }
1347:
1348: sub top_nav_help {
1349: my ($text) = @_;
1.436 albertel 1350: $text = &mt($text);
1.949 droeschl 1351: my $stay_on_page = 1;
1352:
1.572 banghart 1353: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1354: : "javascript:helpMenu('open')";
1.572 banghart 1355: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1356:
1.201 raeburn 1357: my $title = &mt('Get help');
1.436 albertel 1358:
1359: return <<"END";
1360: $banner_link
1361: <a href="$link" title="$title">$text</a>
1362: END
1363: }
1364:
1365: sub help_menu_js {
1366: my ($text) = @_;
1.949 droeschl 1367: my $stayOnPage = 1;
1.436 albertel 1368: my $width = 620;
1369: my $height = 600;
1.430 albertel 1370: my $helptopic=&general_help();
1371: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1372: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1373: my $start_page =
1374: &Apache::loncommon::start_page('Help Menu', undef,
1375: {'frameset' => 1,
1376: 'js_ready' => 1,
1377: 'add_entries' => {
1378: 'border' => '0',
1.579 raeburn 1379: 'rows' => "110,*",},});
1.331 albertel 1380: my $end_page =
1381: &Apache::loncommon::end_page({'frameset' => 1,
1382: 'js_ready' => 1,});
1383:
1.436 albertel 1384: my $template .= <<"ENDTEMPLATE";
1385: <script type="text/javascript">
1.877 bisitz 1386: // <![CDATA[
1.253 albertel 1387: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1388: var banner_link = '';
1.243 raeburn 1389: function helpMenu(target) {
1390: var caller = this;
1391: if (target == 'open') {
1392: var newWindow = null;
1393: try {
1.262 albertel 1394: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1395: }
1396: catch(error) {
1397: writeHelp(caller);
1398: return;
1399: }
1400: if (newWindow) {
1401: caller = newWindow;
1402: }
1.193 raeburn 1403: }
1.243 raeburn 1404: writeHelp(caller);
1405: return;
1406: }
1407: function writeHelp(caller) {
1.1072 raeburn 1408: 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 1409: caller.document.close()
1410: caller.focus()
1.193 raeburn 1411: }
1.877 bisitz 1412: // END LON-CAPA Internal -->
1.253 albertel 1413: // ]]>
1.436 albertel 1414: </script>
1.193 raeburn 1415: ENDTEMPLATE
1416: return $template;
1417: }
1418:
1.172 www 1419: sub help_open_bug {
1420: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1421: unless ($env{'user.adv'}) { return ''; }
1.172 www 1422: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1423: $text = "" if (not defined $text);
1424: $stayOnPage=1;
1.184 albertel 1425: $width = 600 if (not defined $width);
1426: $height = 600 if (not defined $height);
1.172 www 1427:
1428: $topic=~s/\W+/\+/g;
1429: my $link='';
1430: my $template='';
1.379 albertel 1431: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1432: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1433: if (!$stayOnPage)
1434: {
1435: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1436: }
1437: else
1438: {
1439: $link = $url;
1440: }
1441: # Add the text
1442: if ($text ne "")
1443: {
1444: $template .=
1445: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1446: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1447: }
1448:
1449: # Add the graphic
1.179 matthew 1450: my $title = &mt('Report a Bug');
1.215 albertel 1451: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1452: $template .= <<"ENDTEMPLATE";
1.436 albertel 1453: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1454: ENDTEMPLATE
1455: if ($text ne '') { $template.='</td></tr></table>' };
1456: return $template;
1457:
1458: }
1459:
1460: sub help_open_faq {
1461: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1462: unless ($env{'user.adv'}) { return ''; }
1.172 www 1463: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1464: $text = "" if (not defined $text);
1465: $stayOnPage=1;
1466: $width = 350 if (not defined $width);
1467: $height = 400 if (not defined $height);
1468:
1469: $topic=~s/\W+/\+/g;
1470: my $link='';
1471: my $template='';
1472: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1473: if (!$stayOnPage)
1474: {
1475: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1476: }
1477: else
1478: {
1479: $link = $url;
1480: }
1481:
1482: # Add the text
1483: if ($text ne "")
1484: {
1485: $template .=
1.173 www 1486: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1487: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1488: }
1489:
1490: # Add the graphic
1.179 matthew 1491: my $title = &mt('View the FAQ');
1.215 albertel 1492: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1493: $template .= <<"ENDTEMPLATE";
1.436 albertel 1494: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1495: ENDTEMPLATE
1496: if ($text ne '') { $template.='</td></tr></table>' };
1497: return $template;
1498:
1.44 bowersj2 1499: }
1.37 matthew 1500:
1.180 matthew 1501: ###############################################################
1502: ###############################################################
1503:
1.45 matthew 1504: =pod
1505:
1.648 raeburn 1506: =item * &change_content_javascript():
1.256 matthew 1507:
1508: This and the next function allow you to create small sections of an
1509: otherwise static HTML page that you can update on the fly with
1510: Javascript, even in Netscape 4.
1511:
1512: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1513: must be written to the HTML page once. It will prove the Javascript
1514: function "change(name, content)". Calling the change function with the
1515: name of the section
1516: you want to update, matching the name passed to C<changable_area>, and
1517: the new content you want to put in there, will put the content into
1518: that area.
1519:
1520: B<Note>: Netscape 4 only reserves enough space for the changable area
1521: to contain room for the original contents. You need to "make space"
1522: for whatever changes you wish to make, and be B<sure> to check your
1523: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1524: it's adequate for updating a one-line status display, but little more.
1525: This script will set the space to 100% width, so you only need to
1526: worry about height in Netscape 4.
1527:
1528: Modern browsers are much less limiting, and if you can commit to the
1529: user not using Netscape 4, this feature may be used freely with
1530: pretty much any HTML.
1531:
1532: =cut
1533:
1534: sub change_content_javascript {
1535: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1536: if ($env{'browser.type'} eq 'netscape' &&
1537: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1538: return (<<NETSCAPE4);
1539: function change(name, content) {
1540: doc = document.layers[name+"___escape"].layers[0].document;
1541: doc.open();
1542: doc.write(content);
1543: doc.close();
1544: }
1545: NETSCAPE4
1546: } else {
1547: # Otherwise, we need to use semi-standards-compliant code
1548: # (technically, "innerHTML" isn't standard but the equivalent
1549: # is really scary, and every useful browser supports it
1550: return (<<DOMBASED);
1551: function change(name, content) {
1552: element = document.getElementById(name);
1553: element.innerHTML = content;
1554: }
1555: DOMBASED
1556: }
1557: }
1558:
1559: =pod
1560:
1.648 raeburn 1561: =item * &changable_area($name,$origContent):
1.256 matthew 1562:
1563: This provides a "changable area" that can be modified on the fly via
1564: the Javascript code provided in C<change_content_javascript>. $name is
1565: the name you will use to reference the area later; do not repeat the
1566: same name on a given HTML page more then once. $origContent is what
1567: the area will originally contain, which can be left blank.
1568:
1569: =cut
1570:
1571: sub changable_area {
1572: my ($name, $origContent) = @_;
1573:
1.258 albertel 1574: if ($env{'browser.type'} eq 'netscape' &&
1575: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1576: # If this is netscape 4, we need to use the Layer tag
1577: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1578: } else {
1579: return "<span id='$name'>$origContent</span>";
1580: }
1581: }
1582:
1583: =pod
1584:
1.648 raeburn 1585: =item * &viewport_geometry_js
1.590 raeburn 1586:
1587: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1588:
1589: =cut
1590:
1591:
1592: sub viewport_geometry_js {
1593: return <<"GEOMETRY";
1594: var Geometry = {};
1595: function init_geometry() {
1596: if (Geometry.init) { return };
1597: Geometry.init=1;
1598: if (window.innerHeight) {
1599: Geometry.getViewportHeight = function() { return window.innerHeight; };
1600: Geometry.getViewportWidth = function() { return window.innerWidth; };
1601: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1602: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1603: }
1604: else if (document.documentElement && document.documentElement.clientHeight) {
1605: Geometry.getViewportHeight =
1606: function() { return document.documentElement.clientHeight; };
1607: Geometry.getViewportWidth =
1608: function() { return document.documentElement.clientWidth; };
1609:
1610: Geometry.getHorizontalScroll =
1611: function() { return document.documentElement.scrollLeft; };
1612: Geometry.getVerticalScroll =
1613: function() { return document.documentElement.scrollTop; };
1614: }
1615: else if (document.body.clientHeight) {
1616: Geometry.getViewportHeight =
1617: function() { return document.body.clientHeight; };
1618: Geometry.getViewportWidth =
1619: function() { return document.body.clientWidth; };
1620: Geometry.getHorizontalScroll =
1621: function() { return document.body.scrollLeft; };
1622: Geometry.getVerticalScroll =
1623: function() { return document.body.scrollTop; };
1624: }
1625: }
1626:
1627: GEOMETRY
1628: }
1629:
1630: =pod
1631:
1.648 raeburn 1632: =item * &viewport_size_js()
1.590 raeburn 1633:
1634: 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.
1635:
1636: =cut
1637:
1638: sub viewport_size_js {
1639: my $geometry = &viewport_geometry_js();
1640: return <<"DIMS";
1641:
1642: $geometry
1643:
1644: function getViewportDims(width,height) {
1645: init_geometry();
1646: width.value = Geometry.getViewportWidth();
1647: height.value = Geometry.getViewportHeight();
1648: return;
1649: }
1650:
1651: DIMS
1652: }
1653:
1654: =pod
1655:
1.648 raeburn 1656: =item * &resize_textarea_js()
1.565 albertel 1657:
1658: emits the needed javascript to resize a textarea to be as big as possible
1659:
1660: creates a function resize_textrea that takes two IDs first should be
1661: the id of the element to resize, second should be the id of a div that
1662: surrounds everything that comes after the textarea, this routine needs
1663: to be attached to the <body> for the onload and onresize events.
1664:
1.648 raeburn 1665: =back
1.565 albertel 1666:
1667: =cut
1668:
1669: sub resize_textarea_js {
1.590 raeburn 1670: my $geometry = &viewport_geometry_js();
1.565 albertel 1671: return <<"RESIZE";
1672: <script type="text/javascript">
1.824 bisitz 1673: // <![CDATA[
1.590 raeburn 1674: $geometry
1.565 albertel 1675:
1.588 albertel 1676: function getX(element) {
1677: var x = 0;
1678: while (element) {
1679: x += element.offsetLeft;
1680: element = element.offsetParent;
1681: }
1682: return x;
1683: }
1684: function getY(element) {
1685: var y = 0;
1686: while (element) {
1687: y += element.offsetTop;
1688: element = element.offsetParent;
1689: }
1690: return y;
1691: }
1692:
1693:
1.565 albertel 1694: function resize_textarea(textarea_id,bottom_id) {
1695: init_geometry();
1696: var textarea = document.getElementById(textarea_id);
1697: //alert(textarea);
1698:
1.588 albertel 1699: var textarea_top = getY(textarea);
1.565 albertel 1700: var textarea_height = textarea.offsetHeight;
1701: var bottom = document.getElementById(bottom_id);
1.588 albertel 1702: var bottom_top = getY(bottom);
1.565 albertel 1703: var bottom_height = bottom.offsetHeight;
1704: var window_height = Geometry.getViewportHeight();
1.588 albertel 1705: var fudge = 23;
1.565 albertel 1706: var new_height = window_height-fudge-textarea_top-bottom_height;
1707: if (new_height < 300) {
1708: new_height = 300;
1709: }
1710: textarea.style.height=new_height+'px';
1711: }
1.824 bisitz 1712: // ]]>
1.565 albertel 1713: </script>
1714: RESIZE
1715:
1716: }
1717:
1718: =pod
1719:
1.256 matthew 1720: =head1 Excel and CSV file utility routines
1721:
1722: =over 4
1723:
1724: =cut
1725:
1726: ###############################################################
1727: ###############################################################
1728:
1729: =pod
1730:
1.648 raeburn 1731: =item * &csv_translate($text)
1.37 matthew 1732:
1.185 www 1733: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1734: format.
1735:
1736: =cut
1737:
1.180 matthew 1738: ###############################################################
1739: ###############################################################
1.37 matthew 1740: sub csv_translate {
1741: my $text = shift;
1742: $text =~ s/\"/\"\"/g;
1.209 albertel 1743: $text =~ s/\n/ /g;
1.37 matthew 1744: return $text;
1745: }
1.180 matthew 1746:
1747: ###############################################################
1748: ###############################################################
1749:
1750: =pod
1751:
1.648 raeburn 1752: =item * &define_excel_formats()
1.180 matthew 1753:
1754: Define some commonly used Excel cell formats.
1755:
1756: Currently supported formats:
1757:
1758: =over 4
1759:
1760: =item header
1761:
1762: =item bold
1763:
1764: =item h1
1765:
1766: =item h2
1767:
1768: =item h3
1769:
1.256 matthew 1770: =item h4
1771:
1772: =item i
1773:
1.180 matthew 1774: =item date
1775:
1776: =back
1777:
1778: Inputs: $workbook
1779:
1780: Returns: $format, a hash reference.
1781:
1.1057 foxr 1782:
1.180 matthew 1783: =cut
1784:
1785: ###############################################################
1786: ###############################################################
1787: sub define_excel_formats {
1788: my ($workbook) = @_;
1789: my $format;
1790: $format->{'header'} = $workbook->add_format(bold => 1,
1791: bottom => 1,
1792: align => 'center');
1793: $format->{'bold'} = $workbook->add_format(bold=>1);
1794: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1795: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1796: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1797: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1798: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1799: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1800: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1801: return $format;
1802: }
1803:
1804: ###############################################################
1805: ###############################################################
1.113 bowersj2 1806:
1807: =pod
1808:
1.648 raeburn 1809: =item * &create_workbook()
1.255 matthew 1810:
1811: Create an Excel worksheet. If it fails, output message on the
1812: request object and return undefs.
1813:
1814: Inputs: Apache request object
1815:
1816: Returns (undef) on failure,
1817: Excel worksheet object, scalar with filename, and formats
1818: from &Apache::loncommon::define_excel_formats on success
1819:
1820: =cut
1821:
1822: ###############################################################
1823: ###############################################################
1824: sub create_workbook {
1825: my ($r) = @_;
1826: #
1827: # Create the excel spreadsheet
1828: my $filename = '/prtspool/'.
1.258 albertel 1829: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1830: time.'_'.rand(1000000000).'.xls';
1831: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1832: if (! defined($workbook)) {
1833: $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928 bisitz 1834: $r->print(
1835: '<p class="LC_error">'
1836: .&mt('Problems occurred in creating the new Excel file.')
1837: .' '.&mt('This error has been logged.')
1838: .' '.&mt('Please alert your LON-CAPA administrator.')
1839: .'</p>'
1840: );
1.255 matthew 1841: return (undef);
1842: }
1843: #
1.1014 foxr 1844: $workbook->set_tempdir(LONCAPA::tempdir());
1.255 matthew 1845: #
1846: my $format = &Apache::loncommon::define_excel_formats($workbook);
1847: return ($workbook,$filename,$format);
1848: }
1849:
1850: ###############################################################
1851: ###############################################################
1852:
1853: =pod
1854:
1.648 raeburn 1855: =item * &create_text_file()
1.113 bowersj2 1856:
1.542 raeburn 1857: Create a file to write to and eventually make available to the user.
1.256 matthew 1858: If file creation fails, outputs an error message on the request object and
1859: return undefs.
1.113 bowersj2 1860:
1.256 matthew 1861: Inputs: Apache request object, and file suffix
1.113 bowersj2 1862:
1.256 matthew 1863: Returns (undef) on failure,
1864: Filehandle and filename on success.
1.113 bowersj2 1865:
1866: =cut
1867:
1.256 matthew 1868: ###############################################################
1869: ###############################################################
1870: sub create_text_file {
1871: my ($r,$suffix) = @_;
1872: if (! defined($suffix)) { $suffix = 'txt'; };
1873: my $fh;
1874: my $filename = '/prtspool/'.
1.258 albertel 1875: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1876: time.'_'.rand(1000000000).'.'.$suffix;
1877: $fh = Apache::File->new('>/home/httpd'.$filename);
1878: if (! defined($fh)) {
1879: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 1880: $r->print(
1881: '<p class="LC_error">'
1882: .&mt('Problems occurred in creating the output file.')
1883: .' '.&mt('This error has been logged.')
1884: .' '.&mt('Please alert your LON-CAPA administrator.')
1885: .'</p>'
1886: );
1.113 bowersj2 1887: }
1.256 matthew 1888: return ($fh,$filename)
1.113 bowersj2 1889: }
1890:
1891:
1.256 matthew 1892: =pod
1.113 bowersj2 1893:
1894: =back
1895:
1896: =cut
1.37 matthew 1897:
1898: ###############################################################
1.33 matthew 1899: ## Home server <option> list generating code ##
1900: ###############################################################
1.35 matthew 1901:
1.169 www 1902: # ------------------------------------------
1903:
1904: sub domain_select {
1905: my ($name,$value,$multiple)=@_;
1906: my %domains=map {
1.514 albertel 1907: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1908: } &Apache::lonnet::all_domains();
1.169 www 1909: if ($multiple) {
1910: $domains{''}=&mt('Any domain');
1.550 albertel 1911: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1912: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1913: } else {
1.550 albertel 1914: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970 raeburn 1915: return &select_form($name,$value,\%domains);
1.169 www 1916: }
1917: }
1918:
1.282 albertel 1919: #-------------------------------------------
1920:
1921: =pod
1922:
1.519 raeburn 1923: =head1 Routines for form select boxes
1924:
1925: =over 4
1926:
1.648 raeburn 1927: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1928:
1929: Returns a string containing a <select> element int multiple mode
1930:
1931:
1932: Args:
1933: $name - name of the <select> element
1.506 raeburn 1934: $value - scalar or array ref of values that should already be selected
1.282 albertel 1935: $size - number of rows long the select element is
1.283 albertel 1936: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1937: (shown text should already have been &mt())
1.506 raeburn 1938: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1939:
1.282 albertel 1940: =cut
1941:
1942: #-------------------------------------------
1.169 www 1943: sub multiple_select_form {
1.284 albertel 1944: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1945: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1946: my $output='';
1.191 matthew 1947: if (! defined($size)) {
1948: $size = 4;
1.283 albertel 1949: if (scalar(keys(%$hash))<4) {
1950: $size = scalar(keys(%$hash));
1.191 matthew 1951: }
1952: }
1.734 bisitz 1953: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1954: my @order;
1.506 raeburn 1955: if (ref($order) eq 'ARRAY') {
1956: @order = @{$order};
1957: } else {
1958: @order = sort(keys(%$hash));
1.501 banghart 1959: }
1960: if (exists($$hash{'select_form_order'})) {
1961: @order = @{$$hash{'select_form_order'}};
1962: }
1963:
1.284 albertel 1964: foreach my $key (@order) {
1.356 albertel 1965: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1966: $output.='selected="selected" ' if ($selected{$key});
1967: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1968: }
1969: $output.="</select>\n";
1970: return $output;
1971: }
1972:
1.88 www 1973: #-------------------------------------------
1974:
1975: =pod
1976:
1.970 raeburn 1977: =item * &select_form($defdom,$name,$hashref,$onchange)
1.88 www 1978:
1979: Returns a string containing a <select name='$name' size='1'> form to
1.970 raeburn 1980: allow a user to select options from a ref to a hash containing:
1981: option_name => displayed text. An optional $onchange can include
1982: a javascript onchange item, e.g., onchange="this.form.submit();"
1983:
1.88 www 1984: See lonrights.pm for an example invocation and use.
1985:
1986: =cut
1987:
1988: #-------------------------------------------
1989: sub select_form {
1.970 raeburn 1990: my ($def,$name,$hashref,$onchange) = @_;
1991: return unless (ref($hashref) eq 'HASH');
1992: if ($onchange) {
1993: $onchange = ' onchange="'.$onchange.'"';
1994: }
1995: my $selectform = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.128 albertel 1996: my @keys;
1.970 raeburn 1997: if (exists($hashref->{'select_form_order'})) {
1998: @keys=@{$hashref->{'select_form_order'}};
1.128 albertel 1999: } else {
1.970 raeburn 2000: @keys=sort(keys(%{$hashref}));
1.128 albertel 2001: }
1.356 albertel 2002: foreach my $key (@keys) {
2003: $selectform.=
2004: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
2005: ($key eq $def ? 'selected="selected" ' : '').
1.970 raeburn 2006: ">".$hashref->{$key}."</option>\n";
1.88 www 2007: }
2008: $selectform.="</select>";
2009: return $selectform;
2010: }
2011:
1.475 www 2012: # For display filters
2013:
2014: sub display_filter {
1.1074 raeburn 2015: my ($context) = @_;
1.475 www 2016: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 2017: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.1074 raeburn 2018: my $phraseinput = 'hidden';
2019: my $includeinput = 'hidden';
2020: my ($checked,$includetypestext);
2021: if ($env{'form.displayfilter'} eq 'containing') {
2022: $phraseinput = 'text';
2023: if ($context eq 'parmslog') {
2024: $includeinput = 'checkbox';
2025: if ($env{'form.includetypes'}) {
2026: $checked = ' checked="checked"';
2027: }
2028: $includetypestext = &mt('Include parameter types');
2029: }
2030: } else {
2031: $includetypestext = ' ';
2032: }
2033: my ($additional,$secondid,$thirdid);
2034: if ($context eq 'parmslog') {
2035: $additional =
2036: '<label><input type="'.$includeinput.'" name="includetypes"'.
2037: $checked.' name="includetypes" value="1" id="includetypes" />'.
2038: ' <span id="includetypestext">'.$includetypestext.'</span>'.
2039: '</label>';
2040: $secondid = 'includetypes';
2041: $thirdid = 'includetypestext';
2042: }
2043: my $onchange = "javascript:toggleHistoryOptions(this,'containingphrase','$context',
2044: '$secondid','$thirdid')";
2045: return '<span class="LC_nobreak"><label>'.&mt('Records: [_1]',
1.475 www 2046: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
2047: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 2048: '</label></span> <span class="LC_nobreak">'.
1.1074 raeburn 2049: &mt('Filter: [_1]',
1.477 www 2050: &select_form($env{'form.displayfilter'},
2051: 'displayfilter',
1.970 raeburn 2052: {'currentfolder' => 'Current folder/page',
1.477 www 2053: 'containing' => 'Containing phrase',
1.1074 raeburn 2054: 'none' => 'None'},$onchange)).' '.
2055: '<input type="'.$phraseinput.'" name="containingphrase" id="containingphrase" size="30" value="'.
2056: &HTML::Entities::encode($env{'form.containingphrase'}).
2057: '" />'.$additional;
2058: }
2059:
2060: sub display_filter_js {
2061: my $includetext = &mt('Include parameter types');
2062: return <<"ENDJS";
2063:
2064: function toggleHistoryOptions(setter,firstid,context,secondid,thirdid) {
2065: var firstType = 'hidden';
2066: if (setter.options[setter.selectedIndex].value == 'containing') {
2067: firstType = 'text';
2068: }
2069: firstObject = document.getElementById(firstid);
2070: if (typeof(firstObject) == 'object') {
2071: if (firstObject.type != firstType) {
2072: changeInputType(firstObject,firstType);
2073: }
2074: }
2075: if (context == 'parmslog') {
2076: var secondType = 'hidden';
2077: if (firstType == 'text') {
2078: secondType = 'checkbox';
2079: }
2080: secondObject = document.getElementById(secondid);
2081: if (typeof(secondObject) == 'object') {
2082: if (secondObject.type != secondType) {
2083: changeInputType(secondObject,secondType);
2084: }
2085: }
2086: var textItem = document.getElementById(thirdid);
2087: var currtext = textItem.innerHTML;
2088: var newtext;
2089: if (firstType == 'text') {
2090: newtext = '$includetext';
2091: } else {
2092: newtext = ' ';
2093: }
2094: if (currtext != newtext) {
2095: textItem.innerHTML = newtext;
2096: }
2097: }
2098: return;
2099: }
2100:
2101: function changeInputType(oldObject,newType) {
2102: var newObject = document.createElement('input');
2103: newObject.type = newType;
2104: if (oldObject.size) {
2105: newObject.size = oldObject.size;
2106: }
2107: if (oldObject.value) {
2108: newObject.value = oldObject.value;
2109: }
2110: if (oldObject.name) {
2111: newObject.name = oldObject.name;
2112: }
2113: if (oldObject.id) {
2114: newObject.id = oldObject.id;
2115: }
2116: oldObject.parentNode.replaceChild(newObject,oldObject);
2117: return;
2118: }
2119:
2120: ENDJS
1.475 www 2121: }
2122:
1.167 www 2123: sub gradeleveldescription {
2124: my $gradelevel=shift;
2125: my %gradelevels=(0 => 'Not specified',
2126: 1 => 'Grade 1',
2127: 2 => 'Grade 2',
2128: 3 => 'Grade 3',
2129: 4 => 'Grade 4',
2130: 5 => 'Grade 5',
2131: 6 => 'Grade 6',
2132: 7 => 'Grade 7',
2133: 8 => 'Grade 8',
2134: 9 => 'Grade 9',
2135: 10 => 'Grade 10',
2136: 11 => 'Grade 11',
2137: 12 => 'Grade 12',
2138: 13 => 'Grade 13',
2139: 14 => '100 Level',
2140: 15 => '200 Level',
2141: 16 => '300 Level',
2142: 17 => '400 Level',
2143: 18 => 'Graduate Level');
2144: return &mt($gradelevels{$gradelevel});
2145: }
2146:
1.163 www 2147: sub select_level_form {
2148: my ($deflevel,$name)=@_;
2149: unless ($deflevel) { $deflevel=0; }
1.167 www 2150: my $selectform = "<select name=\"$name\" size=\"1\">\n";
2151: for (my $i=0; $i<=18; $i++) {
2152: $selectform.="<option value=\"$i\" ".
1.253 albertel 2153: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 2154: ">".&gradeleveldescription($i)."</option>\n";
2155: }
2156: $selectform.="</select>";
2157: return $selectform;
1.163 www 2158: }
1.167 www 2159:
1.35 matthew 2160: #-------------------------------------------
2161:
1.45 matthew 2162: =pod
2163:
1.1075.2.36 raeburn 2164: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoma,$excdoms)
1.35 matthew 2165:
2166: Returns a string containing a <select name='$name' size='1'> form to
2167: allow a user to select the domain to preform an operation in.
2168: See loncreateuser.pm for an example invocation and use.
2169:
1.90 www 2170: If the $includeempty flag is set, it also includes an empty choice ("no domain
2171: selected");
2172:
1.743 raeburn 2173: If the $showdomdesc flag is set, the domain name is followed by the domain description.
2174:
1.910 raeburn 2175: 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.
2176:
1.1075.2.36 raeburn 2177: The optional $incdoms is a reference to an array of domains which will be the only available options.
2178:
2179: The optional $excdoms is a reference to an array of domains which will be excluded from the available options.
1.563 raeburn 2180:
1.35 matthew 2181: =cut
2182:
2183: #-------------------------------------------
1.34 matthew 2184: sub select_dom_form {
1.1075.2.36 raeburn 2185: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms) = @_;
1.872 raeburn 2186: if ($onchange) {
1.874 raeburn 2187: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 2188: }
1.1075.2.36 raeburn 2189: my (@domains,%exclude);
1.910 raeburn 2190: if (ref($incdoms) eq 'ARRAY') {
2191: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
2192: } else {
2193: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
2194: }
1.90 www 2195: if ($includeempty) { @domains=('',@domains); }
1.1075.2.36 raeburn 2196: if (ref($excdoms) eq 'ARRAY') {
2197: map { $exclude{$_} = 1; } @{$excdoms};
2198: }
1.743 raeburn 2199: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 2200: foreach my $dom (@domains) {
1.1075.2.36 raeburn 2201: next if ($exclude{$dom});
1.356 albertel 2202: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 2203: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
2204: if ($showdomdesc) {
2205: if ($dom ne '') {
2206: my $domdesc = &Apache::lonnet::domain($dom,'description');
2207: if ($domdesc ne '') {
2208: $selectdomain .= ' ('.$domdesc.')';
2209: }
2210: }
2211: }
2212: $selectdomain .= "</option>\n";
1.34 matthew 2213: }
2214: $selectdomain.="</select>";
2215: return $selectdomain;
2216: }
2217:
1.35 matthew 2218: #-------------------------------------------
2219:
1.45 matthew 2220: =pod
2221:
1.648 raeburn 2222: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 2223:
1.586 raeburn 2224: input: 4 arguments (two required, two optional) -
2225: $domain - domain of new user
2226: $name - name of form element
2227: $default - Value of 'default' causes a default item to be first
2228: option, and selected by default.
2229: $hide - Value of 'hide' causes hiding of the name of the server,
2230: if 1 server found, or default, if 0 found.
1.594 raeburn 2231: output: returns 2 items:
1.586 raeburn 2232: (a) form element which contains either:
2233: (i) <select name="$name">
2234: <option value="$hostid1">$hostid $servers{$hostid}</option>
2235: <option value="$hostid2">$hostid $servers{$hostid}</option>
2236: </select>
2237: form item if there are multiple library servers in $domain, or
2238: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2239: if there is only one library server in $domain.
2240:
2241: (b) number of library servers found.
2242:
2243: See loncreateuser.pm for example of use.
1.35 matthew 2244:
2245: =cut
2246:
2247: #-------------------------------------------
1.586 raeburn 2248: sub home_server_form_item {
2249: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2250: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2251: my $result;
2252: my $numlib = keys(%servers);
2253: if ($numlib > 1) {
2254: $result .= '<select name="'.$name.'" />'."\n";
2255: if ($default) {
1.804 bisitz 2256: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 2257: '</option>'."\n";
2258: }
2259: foreach my $hostid (sort(keys(%servers))) {
2260: $result.= '<option value="'.$hostid.'">'.
2261: $hostid.' '.$servers{$hostid}."</option>\n";
2262: }
2263: $result .= '</select>'."\n";
2264: } elsif ($numlib == 1) {
2265: my $hostid;
2266: foreach my $item (keys(%servers)) {
2267: $hostid = $item;
2268: }
2269: $result .= '<input type="hidden" name="'.$name.'" value="'.
2270: $hostid.'" />';
2271: if (!$hide) {
2272: $result .= $hostid.' '.$servers{$hostid};
2273: }
2274: $result .= "\n";
2275: } elsif ($default) {
2276: $result .= '<input type="hidden" name="'.$name.
2277: '" value="default" />';
2278: if (!$hide) {
2279: $result .= &mt('default');
2280: }
2281: $result .= "\n";
1.33 matthew 2282: }
1.586 raeburn 2283: return ($result,$numlib);
1.33 matthew 2284: }
1.112 bowersj2 2285:
2286: =pod
2287:
1.534 albertel 2288: =back
2289:
1.112 bowersj2 2290: =cut
1.87 matthew 2291:
2292: ###############################################################
1.112 bowersj2 2293: ## Decoding User Agent ##
1.87 matthew 2294: ###############################################################
2295:
2296: =pod
2297:
1.112 bowersj2 2298: =head1 Decoding the User Agent
2299:
2300: =over 4
2301:
2302: =item * &decode_user_agent()
1.87 matthew 2303:
2304: Inputs: $r
2305:
2306: Outputs:
2307:
2308: =over 4
2309:
1.112 bowersj2 2310: =item * $httpbrowser
1.87 matthew 2311:
1.112 bowersj2 2312: =item * $clientbrowser
1.87 matthew 2313:
1.112 bowersj2 2314: =item * $clientversion
1.87 matthew 2315:
1.112 bowersj2 2316: =item * $clientmathml
1.87 matthew 2317:
1.112 bowersj2 2318: =item * $clientunicode
1.87 matthew 2319:
1.112 bowersj2 2320: =item * $clientos
1.87 matthew 2321:
2322: =back
2323:
1.157 matthew 2324: =back
2325:
1.87 matthew 2326: =cut
2327:
2328: ###############################################################
2329: ###############################################################
2330: sub decode_user_agent {
1.247 albertel 2331: my ($r)=@_;
1.87 matthew 2332: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2333: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2334: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2335: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2336: my $clientbrowser='unknown';
2337: my $clientversion='0';
2338: my $clientmathml='';
2339: my $clientunicode='0';
2340: for (my $i=0;$i<=$#browsertype;$i++) {
2341: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
2342: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2343: $clientbrowser=$bname;
2344: $httpbrowser=~/$vreg/i;
2345: $clientversion=$1;
2346: $clientmathml=($clientversion>=$minv);
2347: $clientunicode=($clientversion>=$univ);
2348: }
2349: }
2350: my $clientos='unknown';
2351: if (($httpbrowser=~/linux/i) ||
2352: ($httpbrowser=~/unix/i) ||
2353: ($httpbrowser=~/ux/i) ||
2354: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2355: if (($httpbrowser=~/vax/i) ||
2356: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2357: if ($httpbrowser=~/next/i) { $clientos='next'; }
2358: if (($httpbrowser=~/mac/i) ||
2359: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
2360: if ($httpbrowser=~/win/i) { $clientos='win'; }
2361: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
2362: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
2363: $clientunicode,$clientos,);
2364: }
2365:
1.32 matthew 2366: ###############################################################
2367: ## Authentication changing form generation subroutines ##
2368: ###############################################################
2369: ##
2370: ## All of the authform_xxxxxxx subroutines take their inputs in a
2371: ## hash, and have reasonable default values.
2372: ##
2373: ## formname = the name given in the <form> tag.
1.35 matthew 2374: #-------------------------------------------
2375:
1.45 matthew 2376: =pod
2377:
1.112 bowersj2 2378: =head1 Authentication Routines
2379:
2380: =over 4
2381:
1.648 raeburn 2382: =item * &authform_xxxxxx()
1.35 matthew 2383:
2384: The authform_xxxxxx subroutines provide javascript and html forms which
2385: handle some of the conveniences required for authentication forms.
2386: This is not an optimal method, but it works.
2387:
2388: =over 4
2389:
1.112 bowersj2 2390: =item * authform_header
1.35 matthew 2391:
1.112 bowersj2 2392: =item * authform_authorwarning
1.35 matthew 2393:
1.112 bowersj2 2394: =item * authform_nochange
1.35 matthew 2395:
1.112 bowersj2 2396: =item * authform_kerberos
1.35 matthew 2397:
1.112 bowersj2 2398: =item * authform_internal
1.35 matthew 2399:
1.112 bowersj2 2400: =item * authform_filesystem
1.35 matthew 2401:
2402: =back
2403:
1.648 raeburn 2404: See loncreateuser.pm for invocation and use examples.
1.157 matthew 2405:
1.35 matthew 2406: =cut
2407:
2408: #-------------------------------------------
1.32 matthew 2409: sub authform_header{
2410: my %in = (
2411: formname => 'cu',
1.80 albertel 2412: kerb_def_dom => '',
1.32 matthew 2413: @_,
2414: );
2415: $in{'formname'} = 'document.' . $in{'formname'};
2416: my $result='';
1.80 albertel 2417:
2418: #---------------------------------------------- Code for upper case translation
2419: my $Javascript_toUpperCase;
2420: unless ($in{kerb_def_dom}) {
2421: $Javascript_toUpperCase =<<"END";
2422: switch (choice) {
2423: case 'krb': currentform.elements[choicearg].value =
2424: currentform.elements[choicearg].value.toUpperCase();
2425: break;
2426: default:
2427: }
2428: END
2429: } else {
2430: $Javascript_toUpperCase = "";
2431: }
2432:
1.165 raeburn 2433: my $radioval = "'nochange'";
1.591 raeburn 2434: if (defined($in{'curr_authtype'})) {
2435: if ($in{'curr_authtype'} ne '') {
2436: $radioval = "'".$in{'curr_authtype'}."arg'";
2437: }
1.174 matthew 2438: }
1.165 raeburn 2439: my $argfield = 'null';
1.591 raeburn 2440: if (defined($in{'mode'})) {
1.165 raeburn 2441: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2442: if (defined($in{'curr_autharg'})) {
2443: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2444: $argfield = "'$in{'curr_autharg'}'";
2445: }
2446: }
2447: }
2448: }
2449:
1.32 matthew 2450: $result.=<<"END";
2451: var current = new Object();
1.165 raeburn 2452: current.radiovalue = $radioval;
2453: current.argfield = $argfield;
1.32 matthew 2454:
2455: function changed_radio(choice,currentform) {
2456: var choicearg = choice + 'arg';
2457: // If a radio button in changed, we need to change the argfield
2458: if (current.radiovalue != choice) {
2459: current.radiovalue = choice;
2460: if (current.argfield != null) {
2461: currentform.elements[current.argfield].value = '';
2462: }
2463: if (choice == 'nochange') {
2464: current.argfield = null;
2465: } else {
2466: current.argfield = choicearg;
2467: switch(choice) {
2468: case 'krb':
2469: currentform.elements[current.argfield].value =
2470: "$in{'kerb_def_dom'}";
2471: break;
2472: default:
2473: break;
2474: }
2475: }
2476: }
2477: return;
2478: }
1.22 www 2479:
1.32 matthew 2480: function changed_text(choice,currentform) {
2481: var choicearg = choice + 'arg';
2482: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2483: $Javascript_toUpperCase
1.32 matthew 2484: // clear old field
2485: if ((current.argfield != choicearg) && (current.argfield != null)) {
2486: currentform.elements[current.argfield].value = '';
2487: }
2488: current.argfield = choicearg;
2489: }
2490: set_auth_radio_buttons(choice,currentform);
2491: return;
1.20 www 2492: }
1.32 matthew 2493:
2494: function set_auth_radio_buttons(newvalue,currentform) {
1.986 raeburn 2495: var numauthchoices = currentform.login.length;
2496: if (typeof numauthchoices == "undefined") {
2497: return;
2498: }
1.32 matthew 2499: var i=0;
1.986 raeburn 2500: while (i < numauthchoices) {
1.32 matthew 2501: if (currentform.login[i].value == newvalue) { break; }
2502: i++;
2503: }
1.986 raeburn 2504: if (i == numauthchoices) {
1.32 matthew 2505: return;
2506: }
2507: current.radiovalue = newvalue;
2508: currentform.login[i].checked = true;
2509: return;
2510: }
2511: END
2512: return $result;
2513: }
2514:
1.1075.2.20 raeburn 2515: sub authform_authorwarning {
1.32 matthew 2516: my $result='';
1.144 matthew 2517: $result='<i>'.
2518: &mt('As a general rule, only authors or co-authors should be '.
2519: 'filesystem authenticated '.
2520: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2521: return $result;
2522: }
2523:
1.1075.2.20 raeburn 2524: sub authform_nochange {
1.32 matthew 2525: my %in = (
2526: formname => 'document.cu',
2527: kerb_def_dom => 'MSU.EDU',
2528: @_,
2529: );
1.1075.2.20 raeburn 2530: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.586 raeburn 2531: my $result;
1.1075.2.20 raeburn 2532: if (!$authnum) {
2533: $result = &mt('Under your current role you are not permitted to change login settings for this user');
1.586 raeburn 2534: } else {
2535: $result = '<label>'.&mt('[_1] Do not change login data',
2536: '<input type="radio" name="login" value="nochange" '.
2537: 'checked="checked" onclick="'.
1.281 albertel 2538: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2539: '</label>';
1.586 raeburn 2540: }
1.32 matthew 2541: return $result;
2542: }
2543:
1.591 raeburn 2544: sub authform_kerberos {
1.32 matthew 2545: my %in = (
2546: formname => 'document.cu',
2547: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2548: kerb_def_auth => 'krb4',
1.32 matthew 2549: @_,
2550: );
1.586 raeburn 2551: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2552: $autharg,$jscall);
1.1075.2.20 raeburn 2553: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2554: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2555: $check5 = ' checked="checked"';
1.80 albertel 2556: } else {
1.772 bisitz 2557: $check4 = ' checked="checked"';
1.80 albertel 2558: }
1.165 raeburn 2559: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2560: if (defined($in{'curr_authtype'})) {
2561: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2562: $krbcheck = ' checked="checked"';
1.623 raeburn 2563: if (defined($in{'mode'})) {
2564: if ($in{'mode'} eq 'modifyuser') {
2565: $krbcheck = '';
2566: }
2567: }
1.591 raeburn 2568: if (defined($in{'curr_kerb_ver'})) {
2569: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2570: $check5 = ' checked="checked"';
1.591 raeburn 2571: $check4 = '';
2572: } else {
1.772 bisitz 2573: $check4 = ' checked="checked"';
1.591 raeburn 2574: $check5 = '';
2575: }
1.586 raeburn 2576: }
1.591 raeburn 2577: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2578: $krbarg = $in{'curr_autharg'};
2579: }
1.586 raeburn 2580: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2581: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2582: $result =
2583: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2584: $in{'curr_autharg'},$krbver);
2585: } else {
2586: $result =
2587: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2588: }
2589: return $result;
2590: }
2591: }
2592: } else {
2593: if ($authnum == 1) {
1.784 bisitz 2594: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2595: }
2596: }
1.586 raeburn 2597: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2598: return;
1.587 raeburn 2599: } elsif ($authtype eq '') {
1.591 raeburn 2600: if (defined($in{'mode'})) {
1.587 raeburn 2601: if ($in{'mode'} eq 'modifycourse') {
2602: if ($authnum == 1) {
1.1075.2.20 raeburn 2603: $authtype = '<input type="radio" name="login" value="krb" />';
1.587 raeburn 2604: }
2605: }
2606: }
1.586 raeburn 2607: }
2608: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2609: if ($authtype eq '') {
2610: $authtype = '<input type="radio" name="login" value="krb" '.
2611: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2612: $krbcheck.' />';
2613: }
2614: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
1.1075.2.20 raeburn 2615: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
1.586 raeburn 2616: $in{'curr_authtype'} eq 'krb5') ||
1.1075.2.20 raeburn 2617: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
1.586 raeburn 2618: $in{'curr_authtype'} eq 'krb4')) {
2619: $result .= &mt
1.144 matthew 2620: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2621: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2622: '<label>'.$authtype,
1.281 albertel 2623: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2624: 'value="'.$krbarg.'" '.
1.144 matthew 2625: 'onchange="'.$jscall.'" />',
1.281 albertel 2626: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2627: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2628: '</label>');
1.586 raeburn 2629: } elsif ($can_assign{'krb4'}) {
2630: $result .= &mt
2631: ('[_1] Kerberos authenticated with domain [_2] '.
2632: '[_3] Version 4 [_4]',
2633: '<label>'.$authtype,
2634: '</label><input type="text" size="10" name="krbarg" '.
2635: 'value="'.$krbarg.'" '.
2636: 'onchange="'.$jscall.'" />',
2637: '<label><input type="hidden" name="krbver" value="4" />',
2638: '</label>');
2639: } elsif ($can_assign{'krb5'}) {
2640: $result .= &mt
2641: ('[_1] Kerberos authenticated with domain [_2] '.
2642: '[_3] Version 5 [_4]',
2643: '<label>'.$authtype,
2644: '</label><input type="text" size="10" name="krbarg" '.
2645: 'value="'.$krbarg.'" '.
2646: 'onchange="'.$jscall.'" />',
2647: '<label><input type="hidden" name="krbver" value="5" />',
2648: '</label>');
2649: }
1.32 matthew 2650: return $result;
2651: }
2652:
1.1075.2.20 raeburn 2653: sub authform_internal {
1.586 raeburn 2654: my %in = (
1.32 matthew 2655: formname => 'document.cu',
2656: kerb_def_dom => 'MSU.EDU',
2657: @_,
2658: );
1.586 raeburn 2659: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
1.1075.2.20 raeburn 2660: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2661: if (defined($in{'curr_authtype'})) {
2662: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2663: if ($can_assign{'int'}) {
1.772 bisitz 2664: $intcheck = 'checked="checked" ';
1.623 raeburn 2665: if (defined($in{'mode'})) {
2666: if ($in{'mode'} eq 'modifyuser') {
2667: $intcheck = '';
2668: }
2669: }
1.591 raeburn 2670: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2671: $intarg = $in{'curr_autharg'};
2672: }
2673: } else {
2674: $result = &mt('Currently internally authenticated.');
2675: return $result;
1.165 raeburn 2676: }
2677: }
1.586 raeburn 2678: } else {
2679: if ($authnum == 1) {
1.784 bisitz 2680: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 2681: }
2682: }
2683: if (!$can_assign{'int'}) {
2684: return;
1.587 raeburn 2685: } elsif ($authtype eq '') {
1.591 raeburn 2686: if (defined($in{'mode'})) {
1.587 raeburn 2687: if ($in{'mode'} eq 'modifycourse') {
2688: if ($authnum == 1) {
1.1075.2.20 raeburn 2689: $authtype = '<input type="radio" name="login" value="int" />';
1.587 raeburn 2690: }
2691: }
2692: }
1.165 raeburn 2693: }
1.586 raeburn 2694: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2695: if ($authtype eq '') {
2696: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2697: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2698: }
1.605 bisitz 2699: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2700: $intarg.'" onchange="'.$jscall.'" />';
2701: $result = &mt
1.144 matthew 2702: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2703: '<label>'.$authtype,'</label>'.$autharg);
1.824 bisitz 2704: $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 2705: return $result;
2706: }
2707:
1.1075.2.20 raeburn 2708: sub authform_local {
1.32 matthew 2709: my %in = (
2710: formname => 'document.cu',
2711: kerb_def_dom => 'MSU.EDU',
2712: @_,
2713: );
1.586 raeburn 2714: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
1.1075.2.20 raeburn 2715: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2716: if (defined($in{'curr_authtype'})) {
2717: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2718: if ($can_assign{'loc'}) {
1.772 bisitz 2719: $loccheck = 'checked="checked" ';
1.623 raeburn 2720: if (defined($in{'mode'})) {
2721: if ($in{'mode'} eq 'modifyuser') {
2722: $loccheck = '';
2723: }
2724: }
1.591 raeburn 2725: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2726: $locarg = $in{'curr_autharg'};
2727: }
2728: } else {
2729: $result = &mt('Currently using local (institutional) authentication.');
2730: return $result;
1.165 raeburn 2731: }
2732: }
1.586 raeburn 2733: } else {
2734: if ($authnum == 1) {
1.784 bisitz 2735: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 2736: }
2737: }
2738: if (!$can_assign{'loc'}) {
2739: return;
1.587 raeburn 2740: } elsif ($authtype eq '') {
1.591 raeburn 2741: if (defined($in{'mode'})) {
1.587 raeburn 2742: if ($in{'mode'} eq 'modifycourse') {
2743: if ($authnum == 1) {
1.1075.2.20 raeburn 2744: $authtype = '<input type="radio" name="login" value="loc" />';
1.587 raeburn 2745: }
2746: }
2747: }
1.165 raeburn 2748: }
1.586 raeburn 2749: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2750: if ($authtype eq '') {
2751: $authtype = '<input type="radio" name="login" value="loc" '.
2752: $loccheck.' onchange="'.$jscall.'" onclick="'.
2753: $jscall.'" />';
2754: }
2755: $autharg = '<input type="text" size="10" name="locarg" value="'.
2756: $locarg.'" onchange="'.$jscall.'" />';
2757: $result = &mt('[_1] Local Authentication with argument [_2]',
2758: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2759: return $result;
2760: }
2761:
1.1075.2.20 raeburn 2762: sub authform_filesystem {
1.32 matthew 2763: my %in = (
2764: formname => 'document.cu',
2765: kerb_def_dom => 'MSU.EDU',
2766: @_,
2767: );
1.586 raeburn 2768: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
1.1075.2.20 raeburn 2769: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2770: if (defined($in{'curr_authtype'})) {
2771: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2772: if ($can_assign{'fsys'}) {
1.772 bisitz 2773: $fsyscheck = 'checked="checked" ';
1.623 raeburn 2774: if (defined($in{'mode'})) {
2775: if ($in{'mode'} eq 'modifyuser') {
2776: $fsyscheck = '';
2777: }
2778: }
1.586 raeburn 2779: } else {
2780: $result = &mt('Currently Filesystem Authenticated.');
2781: return $result;
2782: }
2783: }
2784: } else {
2785: if ($authnum == 1) {
1.784 bisitz 2786: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 2787: }
2788: }
2789: if (!$can_assign{'fsys'}) {
2790: return;
1.587 raeburn 2791: } elsif ($authtype eq '') {
1.591 raeburn 2792: if (defined($in{'mode'})) {
1.587 raeburn 2793: if ($in{'mode'} eq 'modifycourse') {
2794: if ($authnum == 1) {
1.1075.2.20 raeburn 2795: $authtype = '<input type="radio" name="login" value="fsys" />';
1.587 raeburn 2796: }
2797: }
2798: }
1.586 raeburn 2799: }
2800: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2801: if ($authtype eq '') {
2802: $authtype = '<input type="radio" name="login" value="fsys" '.
2803: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2804: $jscall.'" />';
2805: }
2806: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2807: ' onchange="'.$jscall.'" />';
2808: $result = &mt
1.144 matthew 2809: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2810: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2811: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2812: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2813: 'onchange="'.$jscall.'" />');
1.32 matthew 2814: return $result;
2815: }
2816:
1.586 raeburn 2817: sub get_assignable_auth {
2818: my ($dom) = @_;
2819: if ($dom eq '') {
2820: $dom = $env{'request.role.domain'};
2821: }
2822: my %can_assign = (
2823: krb4 => 1,
2824: krb5 => 1,
2825: int => 1,
2826: loc => 1,
2827: );
2828: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2829: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2830: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2831: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2832: my $context;
2833: if ($env{'request.role'} =~ /^au/) {
2834: $context = 'author';
2835: } elsif ($env{'request.role'} =~ /^dc/) {
2836: $context = 'domain';
2837: } elsif ($env{'request.course.id'}) {
2838: $context = 'course';
2839: }
2840: if ($context) {
2841: if (ref($authhash->{$context}) eq 'HASH') {
2842: %can_assign = %{$authhash->{$context}};
2843: }
2844: }
2845: }
2846: }
2847: my $authnum = 0;
2848: foreach my $key (keys(%can_assign)) {
2849: if ($can_assign{$key}) {
2850: $authnum ++;
2851: }
2852: }
2853: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2854: $authnum --;
2855: }
2856: return ($authnum,%can_assign);
2857: }
2858:
1.80 albertel 2859: ###############################################################
2860: ## Get Kerberos Defaults for Domain ##
2861: ###############################################################
2862: ##
2863: ## Returns default kerberos version and an associated argument
2864: ## as listed in file domain.tab. If not listed, provides
2865: ## appropriate default domain and kerberos version.
2866: ##
2867: #-------------------------------------------
2868:
2869: =pod
2870:
1.648 raeburn 2871: =item * &get_kerberos_defaults()
1.80 albertel 2872:
2873: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2874: version and domain. If not found, it defaults to version 4 and the
2875: domain of the server.
1.80 albertel 2876:
1.648 raeburn 2877: =over 4
2878:
1.80 albertel 2879: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2880:
1.648 raeburn 2881: =back
2882:
2883: =back
2884:
1.80 albertel 2885: =cut
2886:
2887: #-------------------------------------------
2888: sub get_kerberos_defaults {
2889: my $domain=shift;
1.641 raeburn 2890: my ($krbdef,$krbdefdom);
2891: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2892: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2893: $krbdef = $domdefaults{'auth_def'};
2894: $krbdefdom = $domdefaults{'auth_arg_def'};
2895: } else {
1.80 albertel 2896: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2897: my $krbdefdom=$1;
2898: $krbdefdom=~tr/a-z/A-Z/;
2899: $krbdef = "krb4";
2900: }
2901: return ($krbdef,$krbdefdom);
2902: }
1.112 bowersj2 2903:
1.32 matthew 2904:
1.46 matthew 2905: ###############################################################
2906: ## Thesaurus Functions ##
2907: ###############################################################
1.20 www 2908:
1.46 matthew 2909: =pod
1.20 www 2910:
1.112 bowersj2 2911: =head1 Thesaurus Functions
2912:
2913: =over 4
2914:
1.648 raeburn 2915: =item * &initialize_keywords()
1.46 matthew 2916:
2917: Initializes the package variable %Keywords if it is empty. Uses the
2918: package variable $thesaurus_db_file.
2919:
2920: =cut
2921:
2922: ###################################################
2923:
2924: sub initialize_keywords {
2925: return 1 if (scalar keys(%Keywords));
2926: # If we are here, %Keywords is empty, so fill it up
2927: # Make sure the file we need exists...
2928: if (! -e $thesaurus_db_file) {
2929: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2930: " failed because it does not exist");
2931: return 0;
2932: }
2933: # Set up the hash as a database
2934: my %thesaurus_db;
2935: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2936: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2937: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2938: $thesaurus_db_file);
2939: return 0;
2940: }
2941: # Get the average number of appearances of a word.
2942: my $avecount = $thesaurus_db{'average.count'};
2943: # Put keywords (those that appear > average) into %Keywords
2944: while (my ($word,$data)=each (%thesaurus_db)) {
2945: my ($count,undef) = split /:/,$data;
2946: $Keywords{$word}++ if ($count > $avecount);
2947: }
2948: untie %thesaurus_db;
2949: # Remove special values from %Keywords.
1.356 albertel 2950: foreach my $value ('total.count','average.count') {
2951: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2952: }
1.46 matthew 2953: return 1;
2954: }
2955:
2956: ###################################################
2957:
2958: =pod
2959:
1.648 raeburn 2960: =item * &keyword($word)
1.46 matthew 2961:
2962: Returns true if $word is a keyword. A keyword is a word that appears more
2963: than the average number of times in the thesaurus database. Calls
2964: &initialize_keywords
2965:
2966: =cut
2967:
2968: ###################################################
1.20 www 2969:
2970: sub keyword {
1.46 matthew 2971: return if (!&initialize_keywords());
2972: my $word=lc(shift());
2973: $word=~s/\W//g;
2974: return exists($Keywords{$word});
1.20 www 2975: }
1.46 matthew 2976:
2977: ###############################################################
2978:
2979: =pod
1.20 www 2980:
1.648 raeburn 2981: =item * &get_related_words()
1.46 matthew 2982:
1.160 matthew 2983: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2984: an array of words. If the keyword is not in the thesaurus, an empty array
2985: will be returned. The order of the words returned is determined by the
2986: database which holds them.
2987:
2988: Uses global $thesaurus_db_file.
2989:
1.1057 foxr 2990:
1.46 matthew 2991: =cut
2992:
2993: ###############################################################
2994: sub get_related_words {
2995: my $keyword = shift;
2996: my %thesaurus_db;
2997: if (! -e $thesaurus_db_file) {
2998: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2999: "failed because the file does not exist");
3000: return ();
3001: }
3002: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 3003: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 3004: return ();
3005: }
3006: my @Words=();
1.429 www 3007: my $count=0;
1.46 matthew 3008: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 3009: # The first element is the number of times
3010: # the word appears. We do not need it now.
1.429 www 3011: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
3012: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
3013: my $threshold=$mostfrequentcount/10;
3014: foreach my $possibleword (@RelatedWords) {
3015: my ($word,$wordcount)=split(/\,/,$possibleword);
3016: if ($wordcount>$threshold) {
3017: push(@Words,$word);
3018: $count++;
3019: if ($count>10) { last; }
3020: }
1.20 www 3021: }
3022: }
1.46 matthew 3023: untie %thesaurus_db;
3024: return @Words;
1.14 harris41 3025: }
1.46 matthew 3026:
1.112 bowersj2 3027: =pod
3028:
3029: =back
3030:
3031: =cut
1.61 www 3032:
3033: # -------------------------------------------------------------- Plaintext name
1.81 albertel 3034: =pod
3035:
1.112 bowersj2 3036: =head1 User Name Functions
3037:
3038: =over 4
3039:
1.648 raeburn 3040: =item * &plainname($uname,$udom,$first)
1.81 albertel 3041:
1.112 bowersj2 3042: Takes a users logon name and returns it as a string in
1.226 albertel 3043: "first middle last generation" form
3044: if $first is set to 'lastname' then it returns it as
3045: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 3046:
3047: =cut
1.61 www 3048:
1.295 www 3049:
1.81 albertel 3050: ###############################################################
1.61 www 3051: sub plainname {
1.226 albertel 3052: my ($uname,$udom,$first)=@_;
1.537 albertel 3053: return if (!defined($uname) || !defined($udom));
1.295 www 3054: my %names=&getnames($uname,$udom);
1.226 albertel 3055: my $name=&Apache::lonnet::format_name($names{'firstname'},
3056: $names{'middlename'},
3057: $names{'lastname'},
3058: $names{'generation'},$first);
3059: $name=~s/^\s+//;
1.62 www 3060: $name=~s/\s+$//;
3061: $name=~s/\s+/ /g;
1.353 albertel 3062: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 3063: return $name;
1.61 www 3064: }
1.66 www 3065:
3066: # -------------------------------------------------------------------- Nickname
1.81 albertel 3067: =pod
3068:
1.648 raeburn 3069: =item * &nickname($uname,$udom)
1.81 albertel 3070:
3071: Gets a users name and returns it as a string as
3072:
3073: ""nickname""
1.66 www 3074:
1.81 albertel 3075: if the user has a nickname or
3076:
3077: "first middle last generation"
3078:
3079: if the user does not
3080:
3081: =cut
1.66 www 3082:
3083: sub nickname {
3084: my ($uname,$udom)=@_;
1.537 albertel 3085: return if (!defined($uname) || !defined($udom));
1.295 www 3086: my %names=&getnames($uname,$udom);
1.68 albertel 3087: my $name=$names{'nickname'};
1.66 www 3088: if ($name) {
3089: $name='"'.$name.'"';
3090: } else {
3091: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
3092: $names{'lastname'}.' '.$names{'generation'};
3093: $name=~s/\s+$//;
3094: $name=~s/\s+/ /g;
3095: }
3096: return $name;
3097: }
3098:
1.295 www 3099: sub getnames {
3100: my ($uname,$udom)=@_;
1.537 albertel 3101: return if (!defined($uname) || !defined($udom));
1.433 albertel 3102: if ($udom eq 'public' && $uname eq 'public') {
3103: return ('lastname' => &mt('Public'));
3104: }
1.295 www 3105: my $id=$uname.':'.$udom;
3106: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
3107: if ($cached) {
3108: return %{$names};
3109: } else {
3110: my %loadnames=&Apache::lonnet::get('environment',
3111: ['firstname','middlename','lastname','generation','nickname'],
3112: $udom,$uname);
3113: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
3114: return %loadnames;
3115: }
3116: }
1.61 www 3117:
1.542 raeburn 3118: # -------------------------------------------------------------------- getemails
1.648 raeburn 3119:
1.542 raeburn 3120: =pod
3121:
1.648 raeburn 3122: =item * &getemails($uname,$udom)
1.542 raeburn 3123:
3124: Gets a user's email information and returns it as a hash with keys:
3125: notification, critnotification, permanentemail
3126:
3127: For notification and critnotification, values are comma-separated lists
1.648 raeburn 3128: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 3129:
1.648 raeburn 3130:
1.542 raeburn 3131: =cut
3132:
1.648 raeburn 3133:
1.466 albertel 3134: sub getemails {
3135: my ($uname,$udom)=@_;
3136: if ($udom eq 'public' && $uname eq 'public') {
3137: return;
3138: }
1.467 www 3139: if (!$udom) { $udom=$env{'user.domain'}; }
3140: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 3141: my $id=$uname.':'.$udom;
3142: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
3143: if ($cached) {
3144: return %{$names};
3145: } else {
3146: my %loadnames=&Apache::lonnet::get('environment',
3147: ['notification','critnotification',
3148: 'permanentemail'],
3149: $udom,$uname);
3150: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
3151: return %loadnames;
3152: }
3153: }
3154:
1.551 albertel 3155: sub flush_email_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('emailscache',$id);
3162: }
3163:
1.728 raeburn 3164: # -------------------------------------------------------------------- getlangs
3165:
3166: =pod
3167:
3168: =item * &getlangs($uname,$udom)
3169:
3170: Gets a user's language preference and returns it as a hash with key:
3171: language.
3172:
3173: =cut
3174:
3175:
3176: sub getlangs {
3177: my ($uname,$udom) = @_;
3178: if (!$udom) { $udom =$env{'user.domain'}; }
3179: if (!$uname) { $uname=$env{'user.name'}; }
3180: my $id=$uname.':'.$udom;
3181: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
3182: if ($cached) {
3183: return %{$langs};
3184: } else {
3185: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
3186: $udom,$uname);
3187: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
3188: return %loadlangs;
3189: }
3190: }
3191:
3192: sub flush_langs_cache {
3193: my ($uname,$udom)=@_;
3194: if (!$udom) { $udom =$env{'user.domain'}; }
3195: if (!$uname) { $uname=$env{'user.name'}; }
3196: return if ($udom eq 'public' && $uname eq 'public');
3197: my $id=$uname.':'.$udom;
3198: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
3199: }
3200:
1.61 www 3201: # ------------------------------------------------------------------ Screenname
1.81 albertel 3202:
3203: =pod
3204:
1.648 raeburn 3205: =item * &screenname($uname,$udom)
1.81 albertel 3206:
3207: Gets a users screenname and returns it as a string
3208:
3209: =cut
1.61 www 3210:
3211: sub screenname {
3212: my ($uname,$udom)=@_;
1.258 albertel 3213: if ($uname eq $env{'user.name'} &&
3214: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 3215: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 3216: return $names{'screenname'};
1.62 www 3217: }
3218:
1.212 albertel 3219:
1.802 bisitz 3220: # ------------------------------------------------------------- Confirm Wrapper
3221: =pod
3222:
3223: =item confirmwrapper
3224:
3225: Wrap messages about completion of operation in box
3226:
3227: =cut
3228:
3229: sub confirmwrapper {
3230: my ($message)=@_;
3231: if ($message) {
3232: return "\n".'<div class="LC_confirm_box">'."\n"
3233: .$message."\n"
3234: .'</div>'."\n";
3235: } else {
3236: return $message;
3237: }
3238: }
3239:
1.62 www 3240: # ------------------------------------------------------------- Message Wrapper
3241:
3242: sub messagewrapper {
1.369 www 3243: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 3244: return
1.441 albertel 3245: '<a href="/adm/email?compose=individual&'.
3246: 'recname='.$username.'&recdom='.$domain.
3247: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 3248: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 3249: }
1.802 bisitz 3250:
1.74 www 3251: # --------------------------------------------------------------- Notes Wrapper
3252:
3253: sub noteswrapper {
3254: my ($link,$un,$do)=@_;
3255: return
1.896 amueller 3256: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 3257: }
1.802 bisitz 3258:
1.62 www 3259: # ------------------------------------------------------------- Aboutme Wrapper
3260:
3261: sub aboutmewrapper {
1.1070 raeburn 3262: my ($link,$username,$domain,$target,$class)=@_;
1.447 raeburn 3263: if (!defined($username) && !defined($domain)) {
3264: return;
3265: }
1.1075.2.15 raeburn 3266: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.1070 raeburn 3267: ($target?' target="'.$target.'"':'').($class?' class="'.$class.'"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 3268: }
3269:
3270: # ------------------------------------------------------------ Syllabus Wrapper
3271:
3272: sub syllabuswrapper {
1.707 bisitz 3273: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 3274: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 3275: }
1.14 harris41 3276:
1.802 bisitz 3277: # -----------------------------------------------------------------------------
3278:
1.208 matthew 3279: sub track_student_link {
1.887 raeburn 3280: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 3281: my $link ="/adm/trackstudent?";
1.208 matthew 3282: my $title = 'View recent activity';
3283: if (defined($sname) && $sname !~ /^\s*$/ &&
3284: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 3285: $link .= "selected_student=$sname:$sdom";
1.208 matthew 3286: $title .= ' of this student';
1.268 albertel 3287: }
1.208 matthew 3288: if (defined($target) && $target !~ /^\s*$/) {
3289: $target = qq{target="$target"};
3290: } else {
3291: $target = '';
3292: }
1.268 albertel 3293: if ($start) { $link.='&start='.$start; }
1.887 raeburn 3294: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 3295: $title = &mt($title);
3296: $linktext = &mt($linktext);
1.448 albertel 3297: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
3298: &help_open_topic('View_recent_activity');
1.208 matthew 3299: }
3300:
1.781 raeburn 3301: sub slot_reservations_link {
3302: my ($linktext,$sname,$sdom,$target) = @_;
3303: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
3304: my $title = 'View slot reservation history';
3305: if (defined($sname) && $sname !~ /^\s*$/ &&
3306: defined($sdom) && $sdom !~ /^\s*$/) {
3307: $link .= "&uname=$sname&udom=$sdom";
3308: $title .= ' of this student';
3309: }
3310: if (defined($target) && $target !~ /^\s*$/) {
3311: $target = qq{target="$target"};
3312: } else {
3313: $target = '';
3314: }
3315: $title = &mt($title);
3316: $linktext = &mt($linktext);
3317: return qq{<a href="$link" title="$title" $target>$linktext</a>};
3318: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
3319:
3320: }
3321:
1.508 www 3322: # ===================================================== Display a student photo
3323:
3324:
1.509 albertel 3325: sub student_image_tag {
1.508 www 3326: my ($domain,$user)=@_;
3327: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
3328: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
3329: return '<img src="'.$imgsrc.'" align="right" />';
3330: } else {
3331: return '';
3332: }
3333: }
3334:
1.112 bowersj2 3335: =pod
3336:
3337: =back
3338:
3339: =head1 Access .tab File Data
3340:
3341: =over 4
3342:
1.648 raeburn 3343: =item * &languageids()
1.112 bowersj2 3344:
3345: returns list of all language ids
3346:
3347: =cut
3348:
1.14 harris41 3349: sub languageids {
1.16 harris41 3350: return sort(keys(%language));
1.14 harris41 3351: }
3352:
1.112 bowersj2 3353: =pod
3354:
1.648 raeburn 3355: =item * &languagedescription()
1.112 bowersj2 3356:
3357: returns description of a specified language id
3358:
3359: =cut
3360:
1.14 harris41 3361: sub languagedescription {
1.125 www 3362: my $code=shift;
3363: return ($supported_language{$code}?'* ':'').
3364: $language{$code}.
1.126 www 3365: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 3366: }
3367:
1.1048 foxr 3368: =pod
3369:
3370: =item * &plainlanguagedescription
3371:
3372: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
3373: and the language character encoding (e.g. ISO) separated by a ' - ' string.
3374:
3375: =cut
3376:
1.145 www 3377: sub plainlanguagedescription {
3378: my $code=shift;
3379: return $language{$code};
3380: }
3381:
1.1048 foxr 3382: =pod
3383:
3384: =item * &supportedlanguagecode
3385:
3386: Returns the supported language code (e.g. sptutf maps to pt) given a language
3387: code.
3388:
3389: =cut
3390:
1.145 www 3391: sub supportedlanguagecode {
3392: my $code=shift;
3393: return $supported_language{$code};
1.97 www 3394: }
3395:
1.112 bowersj2 3396: =pod
3397:
1.1048 foxr 3398: =item * &latexlanguage()
3399:
3400: Given a language key code returns the correspondnig language to use
3401: to select the correct hyphenation on LaTeX printouts. This is undef if there
3402: is no supported hyphenation for the language code.
3403:
3404: =cut
3405:
3406: sub latexlanguage {
3407: my $code = shift;
3408: return $latex_language{$code};
3409: }
3410:
3411: =pod
3412:
3413: =item * &latexhyphenation()
3414:
3415: Same as above but what's supplied is the language as it might be stored
3416: in the metadata.
3417:
3418: =cut
3419:
3420: sub latexhyphenation {
3421: my $key = shift;
3422: return $latex_language_bykey{$key};
3423: }
3424:
3425: =pod
3426:
1.648 raeburn 3427: =item * ©rightids()
1.112 bowersj2 3428:
3429: returns list of all copyrights
3430:
3431: =cut
3432:
3433: sub copyrightids {
3434: return sort(keys(%cprtag));
3435: }
3436:
3437: =pod
3438:
1.648 raeburn 3439: =item * ©rightdescription()
1.112 bowersj2 3440:
3441: returns description of a specified copyright id
3442:
3443: =cut
3444:
3445: sub copyrightdescription {
1.166 www 3446: return &mt($cprtag{shift(@_)});
1.112 bowersj2 3447: }
1.197 matthew 3448:
3449: =pod
3450:
1.648 raeburn 3451: =item * &source_copyrightids()
1.192 taceyjo1 3452:
3453: returns list of all source copyrights
3454:
3455: =cut
3456:
3457: sub source_copyrightids {
3458: return sort(keys(%scprtag));
3459: }
3460:
3461: =pod
3462:
1.648 raeburn 3463: =item * &source_copyrightdescription()
1.192 taceyjo1 3464:
3465: returns description of a specified source copyright id
3466:
3467: =cut
3468:
3469: sub source_copyrightdescription {
3470: return &mt($scprtag{shift(@_)});
3471: }
1.112 bowersj2 3472:
3473: =pod
3474:
1.648 raeburn 3475: =item * &filecategories()
1.112 bowersj2 3476:
3477: returns list of all file categories
3478:
3479: =cut
3480:
3481: sub filecategories {
3482: return sort(keys(%category_extensions));
3483: }
3484:
3485: =pod
3486:
1.648 raeburn 3487: =item * &filecategorytypes()
1.112 bowersj2 3488:
3489: returns list of file types belonging to a given file
3490: category
3491:
3492: =cut
3493:
3494: sub filecategorytypes {
1.356 albertel 3495: my ($cat) = @_;
3496: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 3497: }
3498:
3499: =pod
3500:
1.648 raeburn 3501: =item * &fileembstyle()
1.112 bowersj2 3502:
3503: returns embedding style for a specified file type
3504:
3505: =cut
3506:
3507: sub fileembstyle {
3508: return $fe{lc(shift(@_))};
1.169 www 3509: }
3510:
1.351 www 3511: sub filemimetype {
3512: return $fm{lc(shift(@_))};
3513: }
3514:
1.169 www 3515:
3516: sub filecategoryselect {
3517: my ($name,$value)=@_;
1.189 matthew 3518: return &select_form($value,$name,
1.970 raeburn 3519: {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112 bowersj2 3520: }
3521:
3522: =pod
3523:
1.648 raeburn 3524: =item * &filedescription()
1.112 bowersj2 3525:
3526: returns description for a specified file type
3527:
3528: =cut
3529:
3530: sub filedescription {
1.188 matthew 3531: my $file_description = $fd{lc(shift())};
3532: $file_description =~ s:([\[\]]):~$1:g;
3533: return &mt($file_description);
1.112 bowersj2 3534: }
3535:
3536: =pod
3537:
1.648 raeburn 3538: =item * &filedescriptionex()
1.112 bowersj2 3539:
3540: returns description for a specified file type with
3541: extra formatting
3542:
3543: =cut
3544:
3545: sub filedescriptionex {
3546: my $ex=shift;
1.188 matthew 3547: my $file_description = $fd{lc($ex)};
3548: $file_description =~ s:([\[\]]):~$1:g;
3549: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3550: }
3551:
3552: # End of .tab access
3553: =pod
3554:
3555: =back
3556:
3557: =cut
3558:
3559: # ------------------------------------------------------------------ File Types
3560: sub fileextensions {
3561: return sort(keys(%fe));
3562: }
3563:
1.97 www 3564: # ----------------------------------------------------------- Display Languages
3565: # returns a hash with all desired display languages
3566: #
3567:
3568: sub display_languages {
3569: my %languages=();
1.695 raeburn 3570: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3571: $languages{$lang}=1;
1.97 www 3572: }
3573: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3574: if ($env{'form.displaylanguage'}) {
1.356 albertel 3575: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3576: $languages{$lang}=1;
1.97 www 3577: }
3578: }
3579: return %languages;
1.14 harris41 3580: }
3581:
1.582 albertel 3582: sub languages {
3583: my ($possible_langs) = @_;
1.695 raeburn 3584: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3585: if (!ref($possible_langs)) {
3586: if( wantarray ) {
3587: return @preferred_langs;
3588: } else {
3589: return $preferred_langs[0];
3590: }
3591: }
3592: my %possibilities = map { $_ => 1 } (@$possible_langs);
3593: my @preferred_possibilities;
3594: foreach my $preferred_lang (@preferred_langs) {
3595: if (exists($possibilities{$preferred_lang})) {
3596: push(@preferred_possibilities, $preferred_lang);
3597: }
3598: }
3599: if( wantarray ) {
3600: return @preferred_possibilities;
3601: }
3602: return $preferred_possibilities[0];
3603: }
3604:
1.742 raeburn 3605: sub user_lang {
3606: my ($touname,$toudom,$fromcid) = @_;
3607: my @userlangs;
3608: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3609: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3610: $env{'course.'.$fromcid.'.languages'}));
3611: } else {
3612: my %langhash = &getlangs($touname,$toudom);
3613: if ($langhash{'languages'} ne '') {
3614: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3615: } else {
3616: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3617: if ($domdefs{'lang_def'} ne '') {
3618: @userlangs = ($domdefs{'lang_def'});
3619: }
3620: }
3621: }
3622: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3623: my $user_lh = Apache::localize->get_handle(@languages);
3624: return $user_lh;
3625: }
3626:
3627:
1.112 bowersj2 3628: ###############################################################
3629: ## Student Answer Attempts ##
3630: ###############################################################
3631:
3632: =pod
3633:
3634: =head1 Alternate Problem Views
3635:
3636: =over 4
3637:
1.648 raeburn 3638: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3639: $getattempt, $regexp, $gradesub)
3640:
3641: Return string with previous attempt on problem. Arguments:
3642:
3643: =over 4
3644:
3645: =item * $symb: Problem, including path
3646:
3647: =item * $username: username of the desired student
3648:
3649: =item * $domain: domain of the desired student
1.14 harris41 3650:
1.112 bowersj2 3651: =item * $course: Course ID
1.14 harris41 3652:
1.112 bowersj2 3653: =item * $getattempt: Leave blank for all attempts, otherwise put
3654: something
1.14 harris41 3655:
1.112 bowersj2 3656: =item * $regexp: if string matches this regexp, the string will be
3657: sent to $gradesub
1.14 harris41 3658:
1.112 bowersj2 3659: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3660:
1.112 bowersj2 3661: =back
1.14 harris41 3662:
1.112 bowersj2 3663: The output string is a table containing all desired attempts, if any.
1.16 harris41 3664:
1.112 bowersj2 3665: =cut
1.1 albertel 3666:
3667: sub get_previous_attempt {
1.43 ng 3668: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3669: my $prevattempts='';
1.43 ng 3670: no strict 'refs';
1.1 albertel 3671: if ($symb) {
1.3 albertel 3672: my (%returnhash)=
3673: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3674: if ($returnhash{'version'}) {
3675: my %lasthash=();
3676: my $version;
3677: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3678: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3679: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3680: }
1.1 albertel 3681: }
1.596 albertel 3682: $prevattempts=&start_data_table().&start_data_table_header_row();
3683: $prevattempts.='<th>'.&mt('History').'</th>';
1.978 raeburn 3684: my (%typeparts,%lasthidden);
1.945 raeburn 3685: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 3686: foreach my $key (sort(keys(%lasthash))) {
3687: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3688: if ($#parts > 0) {
1.31 albertel 3689: my $data=$parts[-1];
1.989 raeburn 3690: next if ($data eq 'foilorder');
1.31 albertel 3691: pop(@parts);
1.1010 www 3692: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.945 raeburn 3693: if ($data eq 'type') {
3694: unless ($showsurv) {
3695: my $id = join(',',@parts);
3696: $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978 raeburn 3697: if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
3698: $lasthidden{$ign.'.'.$id} = 1;
3699: }
1.945 raeburn 3700: }
1.1010 www 3701: }
1.31 albertel 3702: } else {
1.41 ng 3703: if ($#parts == 0) {
3704: $prevattempts.='<th>'.$parts[0].'</th>';
3705: } else {
3706: $prevattempts.='<th>'.$ign.'</th>';
3707: }
1.31 albertel 3708: }
1.16 harris41 3709: }
1.596 albertel 3710: $prevattempts.=&end_data_table_header_row();
1.40 ng 3711: if ($getattempt eq '') {
3712: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.945 raeburn 3713: my @hidden;
3714: if (%typeparts) {
3715: foreach my $id (keys(%typeparts)) {
3716: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
3717: push(@hidden,$id);
3718: }
3719: }
3720: }
3721: $prevattempts.=&start_data_table_row().
3722: '<td>'.&mt('Transaction [_1]',$version).'</td>';
3723: if (@hidden) {
3724: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3725: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3726: my $hide;
3727: foreach my $id (@hidden) {
3728: if ($key =~ /^\Q$id\E/) {
3729: $hide = 1;
3730: last;
3731: }
3732: }
3733: if ($hide) {
3734: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3735: if (($data eq 'award') || ($data eq 'awarddetail')) {
3736: my $value = &format_previous_attempt_value($key,
3737: $returnhash{$version.':'.$key});
3738: $prevattempts.='<td>'.$value.' </td>';
3739: } else {
3740: $prevattempts.='<td> </td>';
3741: }
3742: } else {
3743: if ($key =~ /\./) {
3744: my $value = &format_previous_attempt_value($key,
3745: $returnhash{$version.':'.$key});
3746: $prevattempts.='<td>'.$value.' </td>';
3747: } else {
3748: $prevattempts.='<td> </td>';
3749: }
3750: }
3751: }
3752: } else {
3753: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3754: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3755: my $value = &format_previous_attempt_value($key,
3756: $returnhash{$version.':'.$key});
3757: $prevattempts.='<td>'.$value.' </td>';
3758: }
3759: }
3760: $prevattempts.=&end_data_table_row();
1.40 ng 3761: }
1.1 albertel 3762: }
1.945 raeburn 3763: my @currhidden = keys(%lasthidden);
1.596 albertel 3764: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3765: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3766: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3767: if (%typeparts) {
3768: my $hidden;
3769: foreach my $id (@currhidden) {
3770: if ($key =~ /^\Q$id\E/) {
3771: $hidden = 1;
3772: last;
3773: }
3774: }
3775: if ($hidden) {
3776: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3777: if (($data eq 'award') || ($data eq 'awarddetail')) {
3778: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3779: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3780: $value = &$gradesub($value);
3781: }
3782: $prevattempts.='<td>'.$value.' </td>';
3783: } else {
3784: $prevattempts.='<td> </td>';
3785: }
3786: } else {
3787: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3788: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3789: $value = &$gradesub($value);
3790: }
3791: $prevattempts.='<td>'.$value.' </td>';
3792: }
3793: } else {
3794: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3795: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3796: $value = &$gradesub($value);
3797: }
3798: $prevattempts.='<td>'.$value.' </td>';
3799: }
1.16 harris41 3800: }
1.596 albertel 3801: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3802: } else {
1.596 albertel 3803: $prevattempts=
3804: &start_data_table().&start_data_table_row().
3805: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3806: &end_data_table_row().&end_data_table();
1.1 albertel 3807: }
3808: } else {
1.596 albertel 3809: $prevattempts=
3810: &start_data_table().&start_data_table_row().
3811: '<td>'.&mt('No data.').'</td>'.
3812: &end_data_table_row().&end_data_table();
1.1 albertel 3813: }
1.10 albertel 3814: }
3815:
1.581 albertel 3816: sub format_previous_attempt_value {
3817: my ($key,$value) = @_;
1.1011 www 3818: if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.581 albertel 3819: $value = &Apache::lonlocal::locallocaltime($value);
3820: } elsif (ref($value) eq 'ARRAY') {
3821: $value = '('.join(', ', @{ $value }).')';
1.988 raeburn 3822: } elsif ($key =~ /answerstring$/) {
3823: my %answers = &Apache::lonnet::str2hash($value);
3824: my @anskeys = sort(keys(%answers));
3825: if (@anskeys == 1) {
3826: my $answer = $answers{$anskeys[0]};
1.1001 raeburn 3827: if ($answer =~ m{\0}) {
3828: $answer =~ s{\0}{,}g;
1.988 raeburn 3829: }
3830: my $tag_internal_answer_name = 'INTERNAL';
3831: if ($anskeys[0] eq $tag_internal_answer_name) {
3832: $value = $answer;
3833: } else {
3834: $value = $anskeys[0].'='.$answer;
3835: }
3836: } else {
3837: foreach my $ans (@anskeys) {
3838: my $answer = $answers{$ans};
1.1001 raeburn 3839: if ($answer =~ m{\0}) {
3840: $answer =~ s{\0}{,}g;
1.988 raeburn 3841: }
3842: $value .= $ans.'='.$answer.'<br />';;
3843: }
3844: }
1.581 albertel 3845: } else {
3846: $value = &unescape($value);
3847: }
3848: return $value;
3849: }
3850:
3851:
1.107 albertel 3852: sub relative_to_absolute {
3853: my ($url,$output)=@_;
3854: my $parser=HTML::TokeParser->new(\$output);
3855: my $token;
3856: my $thisdir=$url;
3857: my @rlinks=();
3858: while ($token=$parser->get_token) {
3859: if ($token->[0] eq 'S') {
3860: if ($token->[1] eq 'a') {
3861: if ($token->[2]->{'href'}) {
3862: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3863: }
3864: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3865: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3866: } elsif ($token->[1] eq 'base') {
3867: $thisdir=$token->[2]->{'href'};
3868: }
3869: }
3870: }
3871: $thisdir=~s-/[^/]*$--;
1.356 albertel 3872: foreach my $link (@rlinks) {
1.726 raeburn 3873: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3874: ($link=~/^\//) ||
3875: ($link=~/^javascript:/i) ||
3876: ($link=~/^mailto:/i) ||
3877: ($link=~/^\#/)) {
3878: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3879: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3880: }
3881: }
3882: # -------------------------------------------------- Deal with Applet codebases
3883: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3884: return $output;
3885: }
3886:
1.112 bowersj2 3887: =pod
3888:
1.648 raeburn 3889: =item * &get_student_view()
1.112 bowersj2 3890:
3891: show a snapshot of what student was looking at
3892:
3893: =cut
3894:
1.10 albertel 3895: sub get_student_view {
1.186 albertel 3896: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3897: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3898: my (%form);
1.10 albertel 3899: my @elements=('symb','courseid','domain','username');
3900: foreach my $element (@elements) {
1.186 albertel 3901: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3902: }
1.186 albertel 3903: if (defined($moreenv)) {
3904: %form=(%form,%{$moreenv});
3905: }
1.236 albertel 3906: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3907: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3908: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3909: $userview=~s/\<body[^\>]*\>//gi;
3910: $userview=~s/\<\/body\>//gi;
3911: $userview=~s/\<html\>//gi;
3912: $userview=~s/\<\/html\>//gi;
3913: $userview=~s/\<head\>//gi;
3914: $userview=~s/\<\/head\>//gi;
3915: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3916: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3917: if (wantarray) {
3918: return ($userview,$response);
3919: } else {
3920: return $userview;
3921: }
3922: }
3923:
3924: sub get_student_view_with_retries {
3925: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3926:
3927: my $ok = 0; # True if we got a good response.
3928: my $content;
3929: my $response;
3930:
3931: # Try to get the student_view done. within the retries count:
3932:
3933: do {
3934: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3935: $ok = $response->is_success;
3936: if (!$ok) {
3937: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3938: }
3939: $retries--;
3940: } while (!$ok && ($retries > 0));
3941:
3942: if (!$ok) {
3943: $content = ''; # On error return an empty content.
3944: }
1.651 www 3945: if (wantarray) {
3946: return ($content, $response);
3947: } else {
3948: return $content;
3949: }
1.11 albertel 3950: }
3951:
1.112 bowersj2 3952: =pod
3953:
1.648 raeburn 3954: =item * &get_student_answers()
1.112 bowersj2 3955:
3956: show a snapshot of how student was answering problem
3957:
3958: =cut
3959:
1.11 albertel 3960: sub get_student_answers {
1.100 sakharuk 3961: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3962: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3963: my (%moreenv);
1.11 albertel 3964: my @elements=('symb','courseid','domain','username');
3965: foreach my $element (@elements) {
1.186 albertel 3966: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3967: }
1.186 albertel 3968: $moreenv{'grade_target'}='answer';
3969: %moreenv=(%form,%moreenv);
1.497 raeburn 3970: $feedurl = &Apache::lonnet::clutter($feedurl);
3971: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3972: return $userview;
1.1 albertel 3973: }
1.116 albertel 3974:
3975: =pod
3976:
3977: =item * &submlink()
3978:
1.242 albertel 3979: Inputs: $text $uname $udom $symb $target
1.116 albertel 3980:
3981: Returns: A link to grades.pm such as to see the SUBM view of a student
3982:
3983: =cut
3984:
3985: ###############################################
3986: sub submlink {
1.242 albertel 3987: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3988: if (!($uname && $udom)) {
3989: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3990: &Apache::lonnet::whichuser($symb);
1.116 albertel 3991: if (!$symb) { $symb=$cursymb; }
3992: }
1.254 matthew 3993: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3994: $symb=&escape($symb);
1.960 bisitz 3995: if ($target) { $target=" target=\"$target\""; }
3996: return
3997: '<a href="/adm/grades?command=submission'.
3998: '&symb='.$symb.
3999: '&student='.$uname.
4000: '&userdom='.$udom.'"'.
4001: $target.'>'.$text.'</a>';
1.242 albertel 4002: }
4003: ##############################################
4004:
4005: =pod
4006:
4007: =item * &pgrdlink()
4008:
4009: Inputs: $text $uname $udom $symb $target
4010:
4011: Returns: A link to grades.pm such as to see the PGRD view of a student
4012:
4013: =cut
4014:
4015: ###############################################
4016: sub pgrdlink {
4017: my $link=&submlink(@_);
4018: $link=~s/(&command=submission)/$1&showgrading=yes/;
4019: return $link;
4020: }
4021: ##############################################
4022:
4023: =pod
4024:
4025: =item * &pprmlink()
4026:
4027: Inputs: $text $uname $udom $symb $target
4028:
4029: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 4030: student and a specific resource
1.242 albertel 4031:
4032: =cut
4033:
4034: ###############################################
4035: sub pprmlink {
4036: my ($text,$uname,$udom,$symb,$target)=@_;
4037: if (!($uname && $udom)) {
4038: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 4039: &Apache::lonnet::whichuser($symb);
1.242 albertel 4040: if (!$symb) { $symb=$cursymb; }
4041: }
1.254 matthew 4042: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 4043: $symb=&escape($symb);
1.242 albertel 4044: if ($target) { $target="target=\"$target\""; }
1.595 albertel 4045: return '<a href="/adm/parmset?command=set&'.
4046: 'symb='.$symb.'&uname='.$uname.
4047: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 4048: }
4049: ##############################################
1.37 matthew 4050:
1.112 bowersj2 4051: =pod
4052:
4053: =back
4054:
4055: =cut
4056:
1.37 matthew 4057: ###############################################
1.51 www 4058:
4059:
4060: sub timehash {
1.687 raeburn 4061: my ($thistime) = @_;
4062: my $timezone = &Apache::lonlocal::gettimezone();
4063: my $dt = DateTime->from_epoch(epoch => $thistime)
4064: ->set_time_zone($timezone);
4065: my $wday = $dt->day_of_week();
4066: if ($wday == 7) { $wday = 0; }
4067: return ( 'second' => $dt->second(),
4068: 'minute' => $dt->minute(),
4069: 'hour' => $dt->hour(),
4070: 'day' => $dt->day_of_month(),
4071: 'month' => $dt->month(),
4072: 'year' => $dt->year(),
4073: 'weekday' => $wday,
4074: 'dayyear' => $dt->day_of_year(),
4075: 'dlsav' => $dt->is_dst() );
1.51 www 4076: }
4077:
1.370 www 4078: sub utc_string {
4079: my ($date)=@_;
1.371 www 4080: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 4081: }
4082:
1.51 www 4083: sub maketime {
4084: my %th=@_;
1.687 raeburn 4085: my ($epoch_time,$timezone,$dt);
4086: $timezone = &Apache::lonlocal::gettimezone();
4087: eval {
4088: $dt = DateTime->new( year => $th{'year'},
4089: month => $th{'month'},
4090: day => $th{'day'},
4091: hour => $th{'hour'},
4092: minute => $th{'minute'},
4093: second => $th{'second'},
4094: time_zone => $timezone,
4095: );
4096: };
4097: if (!$@) {
4098: $epoch_time = $dt->epoch;
4099: if ($epoch_time) {
4100: return $epoch_time;
4101: }
4102: }
1.51 www 4103: return POSIX::mktime(
4104: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 4105: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 4106: }
4107:
4108: #########################################
1.51 www 4109:
4110: sub findallcourses {
1.482 raeburn 4111: my ($roles,$uname,$udom) = @_;
1.355 albertel 4112: my %roles;
4113: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 4114: my %courses;
1.51 www 4115: my $now=time;
1.482 raeburn 4116: if (!defined($uname)) {
4117: $uname = $env{'user.name'};
4118: }
4119: if (!defined($udom)) {
4120: $udom = $env{'user.domain'};
4121: }
4122: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.1073 raeburn 4123: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
1.482 raeburn 4124: if (!%roles) {
4125: %roles = (
4126: cc => 1,
1.907 raeburn 4127: co => 1,
1.482 raeburn 4128: in => 1,
4129: ep => 1,
4130: ta => 1,
4131: cr => 1,
4132: st => 1,
4133: );
4134: }
4135: foreach my $entry (keys(%roleshash)) {
4136: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
4137: if ($trole =~ /^cr/) {
4138: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
4139: } else {
4140: next if (!exists($roles{$trole}));
4141: }
4142: if ($tend) {
4143: next if ($tend < $now);
4144: }
4145: if ($tstart) {
4146: next if ($tstart > $now);
4147: }
1.1058 raeburn 4148: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482 raeburn 4149: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058 raeburn 4150: my $value = $trole.'/'.$cdom.'/';
1.482 raeburn 4151: if ($secpart eq '') {
4152: ($cnum,$role) = split(/_/,$cnumpart);
4153: $sec = 'none';
1.1058 raeburn 4154: $value .= $cnum.'/';
1.482 raeburn 4155: } else {
4156: $cnum = $cnumpart;
4157: ($sec,$role) = split(/_/,$secpart);
1.1058 raeburn 4158: $value .= $cnum.'/'.$sec;
4159: }
4160: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
4161: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
4162: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
4163: }
4164: } else {
4165: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490 raeburn 4166: }
1.482 raeburn 4167: }
4168: } else {
4169: foreach my $key (keys(%env)) {
1.483 albertel 4170: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
4171: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 4172: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
4173: next if ($role eq 'ca' || $role eq 'aa');
4174: next if (%roles && !exists($roles{$role}));
4175: my ($starttime,$endtime)=split(/\./,$env{$key});
4176: my $active=1;
4177: if ($starttime) {
4178: if ($now<$starttime) { $active=0; }
4179: }
4180: if ($endtime) {
4181: if ($now>$endtime) { $active=0; }
4182: }
4183: if ($active) {
1.1058 raeburn 4184: my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482 raeburn 4185: if ($sec eq '') {
4186: $sec = 'none';
1.1058 raeburn 4187: } else {
4188: $value .= $sec;
4189: }
4190: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
4191: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
4192: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
4193: }
4194: } else {
4195: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482 raeburn 4196: }
1.474 raeburn 4197: }
4198: }
1.51 www 4199: }
4200: }
1.474 raeburn 4201: return %courses;
1.51 www 4202: }
1.37 matthew 4203:
1.54 www 4204: ###############################################
1.474 raeburn 4205:
4206: sub blockcheck {
1.1062 raeburn 4207: my ($setters,$activity,$uname,$udom,$url) = @_;
1.490 raeburn 4208:
4209: if (!defined($udom)) {
4210: $udom = $env{'user.domain'};
4211: }
4212: if (!defined($uname)) {
4213: $uname = $env{'user.name'};
4214: }
4215:
4216: # If uname and udom are for a course, check for blocks in the course.
4217:
4218: if (&Apache::lonnet::is_course($udom,$uname)) {
1.1062 raeburn 4219: my ($startblock,$endblock,$triggerblock) =
4220: &get_blocks($setters,$activity,$udom,$uname,$url);
4221: return ($startblock,$endblock,$triggerblock);
1.490 raeburn 4222: }
1.474 raeburn 4223:
1.502 raeburn 4224: my $startblock = 0;
4225: my $endblock = 0;
1.1062 raeburn 4226: my $triggerblock = '';
1.482 raeburn 4227: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 4228:
1.490 raeburn 4229: # If uname is for a user, and activity is course-specific, i.e.,
4230: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 4231:
1.490 raeburn 4232: if (($activity eq 'boards' || $activity eq 'chat' ||
4233: $activity eq 'groups') && ($env{'request.course.id'})) {
4234: foreach my $key (keys(%live_courses)) {
4235: if ($key ne $env{'request.course.id'}) {
4236: delete($live_courses{$key});
4237: }
4238: }
4239: }
4240:
4241: my $otheruser = 0;
4242: my %own_courses;
4243: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
4244: # Resource belongs to user other than current user.
4245: $otheruser = 1;
4246: # Gather courses for current user
4247: %own_courses =
4248: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
4249: }
4250:
4251: # Gather active course roles - course coordinator, instructor,
4252: # exam proctor, ta, student, or custom role.
1.474 raeburn 4253:
4254: foreach my $course (keys(%live_courses)) {
1.482 raeburn 4255: my ($cdom,$cnum);
4256: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
4257: $cdom = $env{'course.'.$course.'.domain'};
4258: $cnum = $env{'course.'.$course.'.num'};
4259: } else {
1.490 raeburn 4260: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 4261: }
4262: my $no_ownblock = 0;
4263: my $no_userblock = 0;
1.533 raeburn 4264: if ($otheruser && $activity ne 'com') {
1.490 raeburn 4265: # Check if current user has 'evb' priv for this
4266: if (defined($own_courses{$course})) {
4267: foreach my $sec (keys(%{$own_courses{$course}})) {
4268: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
4269: if ($sec ne 'none') {
4270: $checkrole .= '/'.$sec;
4271: }
4272: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4273: $no_ownblock = 1;
4274: last;
4275: }
4276: }
4277: }
4278: # if they have 'evb' priv and are currently not playing student
4279: next if (($no_ownblock) &&
4280: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
4281: }
1.474 raeburn 4282: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 4283: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 4284: if ($sec ne 'none') {
1.482 raeburn 4285: $checkrole .= '/'.$sec;
1.474 raeburn 4286: }
1.490 raeburn 4287: if ($otheruser) {
4288: # Resource belongs to user other than current user.
4289: # Assemble privs for that user, and check for 'evb' priv.
1.1058 raeburn 4290: my (%allroles,%userroles);
4291: if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
4292: foreach my $entry (@{$live_courses{$course}{$sec}}) {
4293: my ($trole,$tdom,$tnum,$tsec);
4294: if ($entry =~ /^cr/) {
4295: ($trole,$tdom,$tnum,$tsec) =
4296: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
4297: } else {
4298: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
4299: }
4300: my ($spec,$area,$trest);
4301: $area = '/'.$tdom.'/'.$tnum;
4302: $trest = $tnum;
4303: if ($tsec ne '') {
4304: $area .= '/'.$tsec;
4305: $trest .= '/'.$tsec;
4306: }
4307: $spec = $trole.'.'.$area;
4308: if ($trole =~ /^cr/) {
4309: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
4310: $tdom,$spec,$trest,$area);
4311: } else {
4312: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
4313: $tdom,$spec,$trest,$area);
4314: }
4315: }
4316: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
4317: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
4318: if ($1) {
4319: $no_userblock = 1;
4320: last;
4321: }
1.486 raeburn 4322: }
4323: }
1.490 raeburn 4324: } else {
4325: # Resource belongs to current user
4326: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 4327: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4328: $no_ownblock = 1;
4329: last;
4330: }
1.474 raeburn 4331: }
4332: }
4333: # if they have the evb priv and are currently not playing student
1.482 raeburn 4334: next if (($no_ownblock) &&
1.491 albertel 4335: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 4336: next if ($no_userblock);
1.474 raeburn 4337:
1.866 kalberla 4338: # Retrieve blocking times and identity of locker for course
1.490 raeburn 4339: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 4340:
1.1062 raeburn 4341: my ($start,$end,$trigger) =
4342: &get_blocks($setters,$activity,$cdom,$cnum,$url);
1.502 raeburn 4343: if (($start != 0) &&
4344: (($startblock == 0) || ($startblock > $start))) {
4345: $startblock = $start;
1.1062 raeburn 4346: if ($trigger ne '') {
4347: $triggerblock = $trigger;
4348: }
1.502 raeburn 4349: }
4350: if (($end != 0) &&
4351: (($endblock == 0) || ($endblock < $end))) {
4352: $endblock = $end;
1.1062 raeburn 4353: if ($trigger ne '') {
4354: $triggerblock = $trigger;
4355: }
1.502 raeburn 4356: }
1.490 raeburn 4357: }
1.1062 raeburn 4358: return ($startblock,$endblock,$triggerblock);
1.490 raeburn 4359: }
4360:
4361: sub get_blocks {
1.1062 raeburn 4362: my ($setters,$activity,$cdom,$cnum,$url) = @_;
1.490 raeburn 4363: my $startblock = 0;
4364: my $endblock = 0;
1.1062 raeburn 4365: my $triggerblock = '';
1.490 raeburn 4366: my $course = $cdom.'_'.$cnum;
4367: $setters->{$course} = {};
4368: $setters->{$course}{'staff'} = [];
4369: $setters->{$course}{'times'} = [];
1.1062 raeburn 4370: $setters->{$course}{'triggers'} = [];
4371: my (@blockers,%triggered);
4372: my $now = time;
4373: my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
4374: if ($activity eq 'docs') {
4375: @blockers = &Apache::lonnet::has_comm_blocking('bre',undef,$url,\%commblocks);
4376: foreach my $block (@blockers) {
4377: if ($block =~ /^firstaccess____(.+)$/) {
4378: my $item = $1;
4379: my $type = 'map';
4380: my $timersymb = $item;
4381: if ($item eq 'course') {
4382: $type = 'course';
4383: } elsif ($item =~ /___\d+___/) {
4384: $type = 'resource';
4385: } else {
4386: $timersymb = &Apache::lonnet::symbread($item);
4387: }
4388: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
4389: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
4390: $triggered{$block} = {
4391: start => $start,
4392: end => $end,
4393: type => $type,
4394: };
4395: }
4396: }
4397: } else {
4398: foreach my $block (keys(%commblocks)) {
4399: if ($block =~ m/^(\d+)____(\d+)$/) {
4400: my ($start,$end) = ($1,$2);
4401: if ($start <= time && $end >= time) {
4402: if (ref($commblocks{$block}) eq 'HASH') {
4403: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
4404: if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
4405: unless(grep(/^\Q$block\E$/,@blockers)) {
4406: push(@blockers,$block);
4407: }
4408: }
4409: }
4410: }
4411: }
4412: } elsif ($block =~ /^firstaccess____(.+)$/) {
4413: my $item = $1;
4414: my $timersymb = $item;
4415: my $type = 'map';
4416: if ($item eq 'course') {
4417: $type = 'course';
4418: } elsif ($item =~ /___\d+___/) {
4419: $type = 'resource';
4420: } else {
4421: $timersymb = &Apache::lonnet::symbread($item);
4422: }
4423: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
4424: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
4425: if ($start && $end) {
4426: if (($start <= time) && ($end >= time)) {
4427: unless (grep(/^\Q$block\E$/,@blockers)) {
4428: push(@blockers,$block);
4429: $triggered{$block} = {
4430: start => $start,
4431: end => $end,
4432: type => $type,
4433: };
4434: }
4435: }
1.490 raeburn 4436: }
1.1062 raeburn 4437: }
4438: }
4439: }
4440: foreach my $blocker (@blockers) {
4441: my ($staff_name,$staff_dom,$title,$blocks) =
4442: &parse_block_record($commblocks{$blocker});
4443: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
4444: my ($start,$end,$triggertype);
4445: if ($blocker =~ m/^(\d+)____(\d+)$/) {
4446: ($start,$end) = ($1,$2);
4447: } elsif (ref($triggered{$blocker}) eq 'HASH') {
4448: $start = $triggered{$blocker}{'start'};
4449: $end = $triggered{$blocker}{'end'};
4450: $triggertype = $triggered{$blocker}{'type'};
4451: }
4452: if ($start) {
4453: push(@{$$setters{$course}{'times'}}, [$start,$end]);
4454: if ($triggertype) {
4455: push(@{$$setters{$course}{'triggers'}},$triggertype);
4456: } else {
4457: push(@{$$setters{$course}{'triggers'}},0);
4458: }
4459: if ( ($startblock == 0) || ($startblock > $start) ) {
4460: $startblock = $start;
4461: if ($triggertype) {
4462: $triggerblock = $blocker;
1.474 raeburn 4463: }
4464: }
1.1062 raeburn 4465: if ( ($endblock == 0) || ($endblock < $end) ) {
4466: $endblock = $end;
4467: if ($triggertype) {
4468: $triggerblock = $blocker;
4469: }
4470: }
1.474 raeburn 4471: }
4472: }
1.1062 raeburn 4473: return ($startblock,$endblock,$triggerblock);
1.474 raeburn 4474: }
4475:
4476: sub parse_block_record {
4477: my ($record) = @_;
4478: my ($setuname,$setudom,$title,$blocks);
4479: if (ref($record) eq 'HASH') {
4480: ($setuname,$setudom) = split(/:/,$record->{'setter'});
4481: $title = &unescape($record->{'event'});
4482: $blocks = $record->{'blocks'};
4483: } else {
4484: my @data = split(/:/,$record,3);
4485: if (scalar(@data) eq 2) {
4486: $title = $data[1];
4487: ($setuname,$setudom) = split(/@/,$data[0]);
4488: } else {
4489: ($setuname,$setudom,$title) = @data;
4490: }
4491: $blocks = { 'com' => 'on' };
4492: }
4493: return ($setuname,$setudom,$title,$blocks);
4494: }
4495:
1.854 kalberla 4496: sub blocking_status {
1.1062 raeburn 4497: my ($activity,$uname,$udom,$url) = @_;
1.1061 raeburn 4498: my %setters;
1.890 droeschl 4499:
1.1061 raeburn 4500: # check for active blocking
1.1062 raeburn 4501: my ($startblock,$endblock,$triggerblock) =
4502: &blockcheck(\%setters,$activity,$uname,$udom,$url);
4503: my $blocked = 0;
4504: if ($startblock && $endblock) {
4505: $blocked = 1;
4506: }
1.890 droeschl 4507:
1.1061 raeburn 4508: # caller just wants to know whether a block is active
4509: if (!wantarray) { return $blocked; }
4510:
4511: # build a link to a popup window containing the details
4512: my $querystring = "?activity=$activity";
4513: # $uname and $udom decide whose portfolio the user is trying to look at
1.1062 raeburn 4514: if ($activity eq 'port') {
4515: $querystring .= "&udom=$udom" if $udom;
4516: $querystring .= "&uname=$uname" if $uname;
4517: } elsif ($activity eq 'docs') {
4518: $querystring .= '&url='.&HTML::Entities::encode($url,'&"');
4519: }
1.1061 raeburn 4520:
4521: my $output .= <<'END_MYBLOCK';
4522: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
4523: var options = "width=" + w + ",height=" + h + ",";
4524: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
4525: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
4526: var newWin = window.open(url, wdwName, options);
4527: newWin.focus();
4528: }
1.890 droeschl 4529: END_MYBLOCK
1.854 kalberla 4530:
1.1061 raeburn 4531: $output = Apache::lonhtmlcommon::scripttag($output);
1.890 droeschl 4532:
1.1061 raeburn 4533: my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062 raeburn 4534: my $text = &mt('Communication Blocked');
4535: if ($activity eq 'docs') {
4536: $text = &mt('Content Access Blocked');
1.1063 raeburn 4537: } elsif ($activity eq 'printout') {
4538: $text = &mt('Printing Blocked');
1.1062 raeburn 4539: }
1.1061 raeburn 4540: $output .= <<"END_BLOCK";
1.867 kalberla 4541: <div class='LC_comblock'>
1.869 kalberla 4542: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4543: title='$text'>
4544: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 4545: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4546: title='$text'>$text</a>
1.867 kalberla 4547: </div>
4548:
4549: END_BLOCK
1.474 raeburn 4550:
1.1061 raeburn 4551: return ($blocked, $output);
1.854 kalberla 4552: }
1.490 raeburn 4553:
1.60 matthew 4554: ###############################################
4555:
1.682 raeburn 4556: sub check_ip_acc {
4557: my ($acc)=@_;
4558: &Apache::lonxml::debug("acc is $acc");
4559: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
4560: return 1;
4561: }
4562: my $allowed=0;
4563: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
4564:
4565: my $name;
4566: foreach my $pattern (split(',',$acc)) {
4567: $pattern =~ s/^\s*//;
4568: $pattern =~ s/\s*$//;
4569: if ($pattern =~ /\*$/) {
4570: #35.8.*
4571: $pattern=~s/\*//;
4572: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4573: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
4574: #35.8.3.[34-56]
4575: my $low=$2;
4576: my $high=$3;
4577: $pattern=$1;
4578: if ($ip =~ /^\Q$pattern\E/) {
4579: my $last=(split(/\./,$ip))[3];
4580: if ($last <=$high && $last >=$low) { $allowed=1; }
4581: }
4582: } elsif ($pattern =~ /^\*/) {
4583: #*.msu.edu
4584: $pattern=~s/\*//;
4585: if (!defined($name)) {
4586: use Socket;
4587: my $netaddr=inet_aton($ip);
4588: ($name)=gethostbyaddr($netaddr,AF_INET);
4589: }
4590: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4591: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
4592: #127.0.0.1
4593: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4594: } else {
4595: #some.name.com
4596: if (!defined($name)) {
4597: use Socket;
4598: my $netaddr=inet_aton($ip);
4599: ($name)=gethostbyaddr($netaddr,AF_INET);
4600: }
4601: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4602: }
4603: if ($allowed) { last; }
4604: }
4605: return $allowed;
4606: }
4607:
4608: ###############################################
4609:
1.60 matthew 4610: =pod
4611:
1.112 bowersj2 4612: =head1 Domain Template Functions
4613:
4614: =over 4
4615:
4616: =item * &determinedomain()
1.60 matthew 4617:
4618: Inputs: $domain (usually will be undef)
4619:
1.63 www 4620: Returns: Determines which domain should be used for designs
1.60 matthew 4621:
4622: =cut
1.54 www 4623:
1.60 matthew 4624: ###############################################
1.63 www 4625: sub determinedomain {
4626: my $domain=shift;
1.531 albertel 4627: if (! $domain) {
1.60 matthew 4628: # Determine domain if we have not been given one
1.893 raeburn 4629: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 4630: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
4631: if ($env{'request.role.domain'}) {
4632: $domain=$env{'request.role.domain'};
1.60 matthew 4633: }
4634: }
1.63 www 4635: return $domain;
4636: }
4637: ###############################################
1.517 raeburn 4638:
1.518 albertel 4639: sub devalidate_domconfig_cache {
4640: my ($udom)=@_;
4641: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
4642: }
4643:
4644: # ---------------------- Get domain configuration for a domain
4645: sub get_domainconf {
4646: my ($udom) = @_;
4647: my $cachetime=1800;
4648: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
4649: if (defined($cached)) { return %{$result}; }
4650:
4651: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 4652: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 4653: my (%designhash,%legacy);
1.518 albertel 4654: if (keys(%domconfig) > 0) {
4655: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 4656: if (keys(%{$domconfig{'login'}})) {
4657: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 4658: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.946 raeburn 4659: if ($key eq 'loginvia') {
4660: if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') {
1.1013 raeburn 4661: foreach my $hostname (keys(%{$domconfig{'login'}{'loginvia'}})) {
1.948 raeburn 4662: if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') {
4663: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
4664: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
4665: $designhash{$udom.'.login.loginvia'} = $server;
4666: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
4667:
4668: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
4669: } else {
1.1013 raeburn 4670: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
1.948 raeburn 4671: }
4672: if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) {
4673: $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'};
4674: }
1.946 raeburn 4675: }
4676: }
4677: }
4678: }
4679: } else {
4680: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
4681: $designhash{$udom.'.login.'.$key.'_'.$img} =
4682: $domconfig{'login'}{$key}{$img};
4683: }
1.699 raeburn 4684: }
4685: } else {
4686: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
4687: }
1.632 raeburn 4688: }
4689: } else {
4690: $legacy{'login'} = 1;
1.518 albertel 4691: }
1.632 raeburn 4692: } else {
4693: $legacy{'login'} = 1;
1.518 albertel 4694: }
4695: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 4696: if (keys(%{$domconfig{'rolecolors'}})) {
4697: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
4698: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
4699: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
4700: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
4701: }
1.518 albertel 4702: }
4703: }
1.632 raeburn 4704: } else {
4705: $legacy{'rolecolors'} = 1;
1.518 albertel 4706: }
1.632 raeburn 4707: } else {
4708: $legacy{'rolecolors'} = 1;
1.518 albertel 4709: }
1.948 raeburn 4710: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
4711: if ($domconfig{'autoenroll'}{'co-owners'}) {
4712: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
4713: }
4714: }
1.632 raeburn 4715: if (keys(%legacy) > 0) {
4716: my %legacyhash = &get_legacy_domconf($udom);
4717: foreach my $item (keys(%legacyhash)) {
4718: if ($item =~ /^\Q$udom\E\.login/) {
4719: if ($legacy{'login'}) {
4720: $designhash{$item} = $legacyhash{$item};
4721: }
4722: } else {
4723: if ($legacy{'rolecolors'}) {
4724: $designhash{$item} = $legacyhash{$item};
4725: }
1.518 albertel 4726: }
4727: }
4728: }
1.632 raeburn 4729: } else {
4730: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4731: }
4732: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4733: $cachetime);
4734: return %designhash;
4735: }
4736:
1.632 raeburn 4737: sub get_legacy_domconf {
4738: my ($udom) = @_;
4739: my %legacyhash;
4740: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4741: my $designfile = $designdir.'/'.$udom.'.tab';
4742: if (-e $designfile) {
4743: if ( open (my $fh,"<$designfile") ) {
4744: while (my $line = <$fh>) {
4745: next if ($line =~ /^\#/);
4746: chomp($line);
4747: my ($key,$val)=(split(/\=/,$line));
4748: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4749: }
4750: close($fh);
4751: }
4752: }
1.1026 raeburn 4753: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632 raeburn 4754: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4755: }
4756: return %legacyhash;
4757: }
4758:
1.63 www 4759: =pod
4760:
1.112 bowersj2 4761: =item * &domainlogo()
1.63 www 4762:
4763: Inputs: $domain (usually will be undef)
4764:
4765: Returns: A link to a domain logo, if the domain logo exists.
4766: If the domain logo does not exist, a description of the domain.
4767:
4768: =cut
1.112 bowersj2 4769:
1.63 www 4770: ###############################################
4771: sub domainlogo {
1.517 raeburn 4772: my $domain = &determinedomain(shift);
1.518 albertel 4773: my %designhash = &get_domainconf($domain);
1.517 raeburn 4774: # See if there is a logo
4775: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4776: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4777: if ($imgsrc =~ m{^/(adm|res)/}) {
4778: if ($imgsrc =~ m{^/res/}) {
4779: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4780: &Apache::lonnet::repcopy($local_name);
4781: }
4782: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4783: }
4784: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4785: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4786: return &Apache::lonnet::domain($domain,'description');
1.59 www 4787: } else {
1.60 matthew 4788: return '';
1.59 www 4789: }
4790: }
1.63 www 4791: ##############################################
4792:
4793: =pod
4794:
1.112 bowersj2 4795: =item * &designparm()
1.63 www 4796:
4797: Inputs: $which parameter; $domain (usually will be undef)
4798:
4799: Returns: value of designparamter $which
4800:
4801: =cut
1.112 bowersj2 4802:
1.397 albertel 4803:
1.400 albertel 4804: ##############################################
1.397 albertel 4805: sub designparm {
4806: my ($which,$domain)=@_;
4807: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 4808: return $env{'environment.color.'.$which};
1.96 www 4809: }
1.63 www 4810: $domain=&determinedomain($domain);
1.1016 raeburn 4811: my %domdesign;
4812: unless ($domain eq 'public') {
4813: %domdesign = &get_domainconf($domain);
4814: }
1.520 raeburn 4815: my $output;
1.517 raeburn 4816: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 4817: $output = $domdesign{$domain.'.'.$which};
1.63 www 4818: } else {
1.520 raeburn 4819: $output = $defaultdesign{$which};
4820: }
4821: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4822: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4823: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 4824: if ($output =~ m{^/res/}) {
4825: my $local_name = &Apache::lonnet::filelocation('',$output);
4826: &Apache::lonnet::repcopy($local_name);
4827: }
1.520 raeburn 4828: $output = &lonhttpdurl($output);
4829: }
1.63 www 4830: }
1.520 raeburn 4831: return $output;
1.63 www 4832: }
1.59 www 4833:
1.822 bisitz 4834: ##############################################
4835: =pod
4836:
1.832 bisitz 4837: =item * &authorspace()
4838:
1.1028 raeburn 4839: Inputs: $url (usually will be undef).
1.832 bisitz 4840:
1.1028 raeburn 4841: Returns: Path to Construction Space containing the resource or
4842: directory being viewed (or for which action is being taken).
4843: If $url is provided, and begins /priv/<domain>/<uname>
4844: the path will be that portion of the $context argument.
4845: Otherwise the path will be for the author space of the current
4846: user when the current role is author, or for that of the
4847: co-author/assistant co-author space when the current role
4848: is co-author or assistant co-author.
1.832 bisitz 4849:
4850: =cut
4851:
4852: sub authorspace {
1.1028 raeburn 4853: my ($url) = @_;
4854: if ($url ne '') {
4855: if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
4856: return $1;
4857: }
4858: }
1.832 bisitz 4859: my $caname = '';
1.1024 www 4860: my $cadom = '';
1.1028 raeburn 4861: if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024 www 4862: ($cadom,$caname) =
1.832 bisitz 4863: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028 raeburn 4864: } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832 bisitz 4865: $caname = $env{'user.name'};
1.1024 www 4866: $cadom = $env{'user.domain'};
1.832 bisitz 4867: }
1.1028 raeburn 4868: if (($caname ne '') && ($cadom ne '')) {
4869: return "/priv/$cadom/$caname/";
4870: }
4871: return;
1.832 bisitz 4872: }
4873:
4874: ##############################################
4875: =pod
4876:
1.822 bisitz 4877: =item * &head_subbox()
4878:
4879: Inputs: $content (contains HTML code with page functions, etc.)
4880:
4881: Returns: HTML div with $content
4882: To be included in page header
4883:
4884: =cut
4885:
4886: sub head_subbox {
4887: my ($content)=@_;
4888: my $output =
1.993 raeburn 4889: '<div class="LC_head_subbox">'
1.822 bisitz 4890: .$content
4891: .'</div>'
4892: }
4893:
4894: ##############################################
4895: =pod
4896:
4897: =item * &CSTR_pageheader()
4898:
1.1026 raeburn 4899: Input: (optional) filename from which breadcrumb trail is built.
4900: In most cases no input as needed, as $env{'request.filename'}
4901: is appropriate for use in building the breadcrumb trail.
1.822 bisitz 4902:
4903: Returns: HTML div with CSTR path and recent box
4904: To be included on Construction Space pages
4905:
4906: =cut
4907:
4908: sub CSTR_pageheader {
1.1026 raeburn 4909: my ($trailfile) = @_;
4910: if ($trailfile eq '') {
4911: $trailfile = $env{'request.filename'};
4912: }
4913:
4914: # this is for resources; directories have customtitle, and crumbs
4915: # and select recent are created in lonpubdir.pm
4916:
4917: my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022 www 4918: my ($udom,$uname,$thisdisfn)=
1.1075.2.29 raeburn 4919: ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)(?:|/(.*))$});
1.1026 raeburn 4920: my $formaction = "/priv/$udom/$uname/$thisdisfn";
4921: $formaction =~ s{/+}{/}g;
1.822 bisitz 4922:
4923: my $parentpath = '';
4924: my $lastitem = '';
4925: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4926: $parentpath = $1;
4927: $lastitem = $2;
4928: } else {
4929: $lastitem = $thisdisfn;
4930: }
1.921 bisitz 4931:
4932: my $output =
1.822 bisitz 4933: '<div>'
4934: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
4935: .'<b>'.&mt('Construction Space:').'</b> '
4936: .'<form name="dirs" method="post" action="'.$formaction
1.921 bisitz 4937: .'" target="_top">' #FIXME lonpubdir: target="_parent"
1.1024 www 4938: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv/'.$udom,undef,undef);
1.921 bisitz 4939:
4940: if ($lastitem) {
4941: $output .=
4942: '<span class="LC_filename">'
4943: .$lastitem
4944: .'</span>';
4945: }
4946: $output .=
4947: '<br />'
1.822 bisitz 4948: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
4949: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4950: .'</form>'
4951: .&Apache::lonmenu::constspaceform()
4952: .'</div>';
1.921 bisitz 4953:
4954: return $output;
1.822 bisitz 4955: }
4956:
1.60 matthew 4957: ###############################################
4958: ###############################################
4959:
4960: =pod
4961:
1.112 bowersj2 4962: =back
4963:
1.549 albertel 4964: =head1 HTML Helpers
1.112 bowersj2 4965:
4966: =over 4
4967:
4968: =item * &bodytag()
1.60 matthew 4969:
4970: Returns a uniform header for LON-CAPA web pages.
4971:
4972: Inputs:
4973:
1.112 bowersj2 4974: =over 4
4975:
4976: =item * $title, A title to be displayed on the page.
4977:
4978: =item * $function, the current role (can be undef).
4979:
4980: =item * $addentries, extra parameters for the <body> tag.
4981:
4982: =item * $bodyonly, if defined, only return the <body> tag.
4983:
4984: =item * $domain, if defined, force a given domain.
4985:
4986: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4987: text interface only)
1.60 matthew 4988:
1.814 bisitz 4989: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
4990: navigational links
1.317 albertel 4991:
1.338 albertel 4992: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4993:
1.1075.2.12 raeburn 4994: =item * $no_inline_link, if true and in remote mode, don't show the
4995: 'Switch To Inline Menu' link
4996:
1.460 albertel 4997: =item * $args, optional argument valid values are
4998: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4999: inherit_jsmath -> when creating popup window in a page,
5000: should it have jsmath forced on by the
5001: current page
1.460 albertel 5002:
1.1075.2.15 raeburn 5003: =item * $advtoolsref, optional argument, ref to an array containing
5004: inlineremote items to be added in "Functions" menu below
5005: breadcrumbs.
5006:
1.112 bowersj2 5007: =back
5008:
1.60 matthew 5009: Returns: A uniform header for LON-CAPA web pages.
5010: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
5011: If $bodyonly is undef or zero, an html string containing a <body> tag and
5012: other decorations will be returned.
5013:
5014: =cut
5015:
1.54 www 5016: sub bodytag {
1.831 bisitz 5017: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1075.2.15 raeburn 5018: $no_nav_bar,$bgcolor,$no_inline_link,$args,$advtoolsref)=@_;
1.339 albertel 5019:
1.954 raeburn 5020: my $public;
5021: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
5022: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
5023: $public = 1;
5024: }
1.460 albertel 5025: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 5026:
1.183 matthew 5027: $function = &get_users_function() if (!$function);
1.339 albertel 5028: my $img = &designparm($function.'.img',$domain);
5029: my $font = &designparm($function.'.font',$domain);
5030: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
5031:
1.803 bisitz 5032: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 5033: 'bgcolor' => $pgbg,
1.339 albertel 5034: 'text' => $font,
5035: 'alink' => &designparm($function.'.alink',$domain),
5036: 'vlink' => &designparm($function.'.vlink',$domain),
5037: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 5038: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 5039:
1.63 www 5040: # role and realm
1.378 raeburn 5041: my ($role,$realm) = split(/\./,$env{'request.role'},2);
5042: if ($role eq 'ca') {
1.479 albertel 5043: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 5044: $realm = &plainname($rname,$rdom);
1.378 raeburn 5045: }
1.55 www 5046: # realm
1.258 albertel 5047: if ($env{'request.course.id'}) {
1.378 raeburn 5048: if ($env{'request.role'} !~ /^cr/) {
5049: $role = &Apache::lonnet::plaintext($role,&course_type());
5050: }
1.898 raeburn 5051: if ($env{'request.course.sec'}) {
5052: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
5053: }
1.359 albertel 5054: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 5055: } else {
5056: $role = &Apache::lonnet::plaintext($role);
1.54 www 5057: }
1.433 albertel 5058:
1.359 albertel 5059: if (!$realm) { $realm=' '; }
1.330 albertel 5060:
1.438 albertel 5061: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 5062:
1.101 www 5063: # construct main body tag
1.359 albertel 5064: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 5065: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 5066:
1.530 albertel 5067: if ($bodyonly) {
1.60 matthew 5068: return $bodytag;
1.798 tempelho 5069: }
1.359 albertel 5070:
1.410 albertel 5071: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.954 raeburn 5072: if ($public) {
1.433 albertel 5073: undef($role);
1.434 albertel 5074: } else {
1.1070 raeburn 5075: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'},
5076: undef,'LC_menubuttons_link');
1.433 albertel 5077: }
1.359 albertel 5078:
1.762 bisitz 5079: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 5080: #
5081: # Extra info if you are the DC
5082: my $dc_info = '';
5083: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
5084: $env{'course.'.$env{'request.course.id'}.
5085: '.domain'}.'/'})) {
5086: my $cid = $env{'request.course.id'};
1.917 raeburn 5087: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 5088: $dc_info =~ s/\s+$//;
1.359 albertel 5089: }
5090:
1.898 raeburn 5091: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853 droeschl 5092: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
5093:
1.1075.2.13 raeburn 5094: if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') {
5095: return $bodytag;
5096: }
1.903 droeschl 5097:
1.1075.2.13 raeburn 5098: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
5099:
1.1075.2.21 raeburn 5100: my $funclist;
5101: if (($env{'environment.remote'} eq 'on') && ($env{'request.state'} ne 'construct')) {
5102: $bodytag .= Apache::lonhtmlcommon::scripttag(Apache::lonmenu::utilityfunctions(), 'start')."\n".
5103: Apache::lonmenu::serverform();
5104: my $forbodytag;
5105: &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
5106: $forcereg,$args->{'group'},
5107: $args->{'bread_crumbs'},
5108: $advtoolsref,'',\$forbodytag);
5109: unless (ref($args->{'bread_crumbs'}) eq 'ARRAY') {
5110: $funclist = $forbodytag;
5111: }
5112: } else {
1.903 droeschl 5113:
5114: # if ($env{'request.state'} eq 'construct') {
5115: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
5116: # }
5117:
1.359 albertel 5118:
1.1075.2.2 raeburn 5119:
1.916 droeschl 5120: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.1075.2.22 raeburn 5121: if ($dc_info) {
5122: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
1.1075.2.1 raeburn 5123: }
1.1075.2.22 raeburn 5124: $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
5125: <em>$realm</em> $dc_info</div>|;
1.903 droeschl 5126: return $bodytag;
5127: }
1.894 droeschl 5128:
1.927 raeburn 5129: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
5130: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
5131: }
1.916 droeschl 5132:
1.903 droeschl 5133: $bodytag .= Apache::lonhtmlcommon::scripttag(
5134: Apache::lonmenu::utilityfunctions(), 'start');
1.816 bisitz 5135:
1.903 droeschl 5136: $bodytag .= Apache::lonmenu::primary_menu();
1.852 droeschl 5137:
1.917 raeburn 5138: if ($dc_info) {
5139: $dc_info = &dc_courseid_toggle($dc_info);
5140: }
5141: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 5142:
1.903 droeschl 5143: #don't show menus for public users
1.954 raeburn 5144: if (!$public){
1.903 droeschl 5145: $bodytag .= Apache::lonmenu::secondary_menu();
5146: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 5147: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
5148: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 5149: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.920 raeburn 5150: $args->{'bread_crumbs'});
5151: } elsif ($forcereg) {
1.1075.2.22 raeburn 5152: $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
5153: $args->{'group'});
1.1075.2.15 raeburn 5154: } else {
1.1075.2.21 raeburn 5155: my $forbodytag;
5156: &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
5157: $forcereg,$args->{'group'},
5158: $args->{'bread_crumbs'},
5159: $advtoolsref,'',\$forbodytag);
5160: unless (ref($args->{'bread_crumbs'}) eq 'ARRAY') {
5161: $bodytag .= $forbodytag;
5162: }
1.920 raeburn 5163: }
1.903 droeschl 5164: }else{
5165: # this is to seperate menu from content when there's no secondary
5166: # menu. Especially needed for public accessible ressources.
5167: $bodytag .= '<hr style="clear:both" />';
5168: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 5169: }
1.903 droeschl 5170:
1.235 raeburn 5171: return $bodytag;
1.1075.2.12 raeburn 5172: }
5173:
5174: #
5175: # Top frame rendering, Remote is up
5176: #
5177:
5178: my $imgsrc = $img;
5179: if ($img =~ /^\/adm/) {
5180: $imgsrc = &lonhttpdurl($img);
5181: }
5182: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
5183:
5184: # Explicit link to get inline menu
5185: my $menu= ($no_inline_link?''
5186: :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
5187:
5188: if ($dc_info) {
5189: $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
5190: }
5191:
5192: unless ($env{'form.inhibitmenu'}) {
5193: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>
5194: <ol class="LC_primary_menu LC_right">
5195: <li>$menu</li>
5196: </ol><div id="LC_realm"> $realm $dc_info</div>|;
5197: }
1.1075.2.13 raeburn 5198: if ($env{'request.state'} eq 'construct') {
5199: if (!$public){
5200: if ($env{'request.state'} eq 'construct') {
5201: $funclist = &Apache::lonhtmlcommon::scripttag(
5202: &Apache::lonmenu::utilityfunctions(), 'start').
5203: &Apache::lonhtmlcommon::scripttag('','end').
5204: &Apache::lonmenu::innerregister($forcereg,
5205: $args->{'bread_crumbs'});
5206: }
5207: }
5208: }
1.1075.2.21 raeburn 5209: return $bodytag."\n".$funclist;
1.182 matthew 5210: }
5211:
1.917 raeburn 5212: sub dc_courseid_toggle {
5213: my ($dc_info) = @_;
1.980 raeburn 5214: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069 raeburn 5215: '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917 raeburn 5216: &mt('(More ...)').'</a></span>'.
5217: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
5218: }
5219:
1.330 albertel 5220: sub make_attr_string {
5221: my ($register,$attr_ref) = @_;
5222:
5223: if ($attr_ref && !ref($attr_ref)) {
5224: die("addentries Must be a hash ref ".
5225: join(':',caller(1))." ".
5226: join(':',caller(0))." ");
5227: }
5228:
5229: if ($register) {
1.339 albertel 5230: my ($on_load,$on_unload);
5231: foreach my $key (keys(%{$attr_ref})) {
5232: if (lc($key) eq 'onload') {
5233: $on_load.=$attr_ref->{$key}.';';
5234: delete($attr_ref->{$key});
5235:
5236: } elsif (lc($key) eq 'onunload') {
5237: $on_unload.=$attr_ref->{$key}.';';
5238: delete($attr_ref->{$key});
5239: }
5240: }
1.1075.2.12 raeburn 5241: if ($env{'environment.remote'} eq 'on') {
5242: $attr_ref->{'onload'} =
5243: &Apache::lonmenu::loadevents(). $on_load;
5244: $attr_ref->{'onunload'}=
5245: &Apache::lonmenu::unloadevents().$on_unload;
5246: } else {
5247: $attr_ref->{'onload'} = $on_load;
5248: $attr_ref->{'onunload'}= $on_unload;
5249: }
1.330 albertel 5250: }
1.339 albertel 5251:
1.330 albertel 5252: my $attr_string;
5253: foreach my $attr (keys(%$attr_ref)) {
5254: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
5255: }
5256: return $attr_string;
5257: }
5258:
5259:
1.182 matthew 5260: ###############################################
1.251 albertel 5261: ###############################################
5262:
5263: =pod
5264:
5265: =item * &endbodytag()
5266:
5267: Returns a uniform footer for LON-CAPA web pages.
5268:
1.635 raeburn 5269: Inputs: 1 - optional reference to an args hash
5270: If in the hash, key for noredirectlink has a value which evaluates to true,
5271: a 'Continue' link is not displayed if the page contains an
5272: internal redirect in the <head></head> section,
5273: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 5274:
5275: =cut
5276:
5277: sub endbodytag {
1.635 raeburn 5278: my ($args) = @_;
1.1075.2.6 raeburn 5279: my $endbodytag;
5280: unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
5281: $endbodytag='</body>';
5282: }
1.269 albertel 5283: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 5284: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 5285: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
5286: $endbodytag=
5287: "<br /><a href=\"$env{'internal.head.redirect'}\">".
5288: &mt('Continue').'</a>'.
5289: $endbodytag;
5290: }
1.315 albertel 5291: }
1.251 albertel 5292: return $endbodytag;
5293: }
5294:
1.352 albertel 5295: =pod
5296:
5297: =item * &standard_css()
5298:
5299: Returns a style sheet
5300:
5301: Inputs: (all optional)
5302: domain -> force to color decorate a page for a specific
5303: domain
5304: function -> force usage of a specific rolish color scheme
5305: bgcolor -> override the default page bgcolor
5306:
5307: =cut
5308:
1.343 albertel 5309: sub standard_css {
1.345 albertel 5310: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 5311: $function = &get_users_function() if (!$function);
5312: my $img = &designparm($function.'.img', $domain);
5313: my $tabbg = &designparm($function.'.tabbg', $domain);
5314: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 5315: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 5316: #second colour for later usage
1.345 albertel 5317: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 5318: my $pgbg_or_bgcolor =
5319: $bgcolor ||
1.352 albertel 5320: &designparm($function.'.pgbg', $domain);
1.382 albertel 5321: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 5322: my $alink = &designparm($function.'.alink', $domain);
5323: my $vlink = &designparm($function.'.vlink', $domain);
5324: my $link = &designparm($function.'.link', $domain);
5325:
1.602 albertel 5326: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 5327: my $mono = 'monospace';
1.850 bisitz 5328: my $data_table_head = $sidebg;
5329: my $data_table_light = '#FAFAFA';
1.1060 bisitz 5330: my $data_table_dark = '#E0E0E0';
1.470 banghart 5331: my $data_table_darker = '#CCCCCC';
1.349 albertel 5332: my $data_table_highlight = '#FFFF00';
1.352 albertel 5333: my $mail_new = '#FFBB77';
5334: my $mail_new_hover = '#DD9955';
5335: my $mail_read = '#BBBB77';
5336: my $mail_read_hover = '#999944';
5337: my $mail_replied = '#AAAA88';
5338: my $mail_replied_hover = '#888855';
5339: my $mail_other = '#99BBBB';
5340: my $mail_other_hover = '#669999';
1.391 albertel 5341: my $table_header = '#DDDDDD';
1.489 raeburn 5342: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 5343: my $lg_border_color = '#C8C8C8';
1.952 onken 5344: my $button_hover = '#BF2317';
1.392 albertel 5345:
1.608 albertel 5346: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 5347: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
5348: : '0 3px 0 4px';
1.448 albertel 5349:
1.523 albertel 5350:
1.343 albertel 5351: return <<END;
1.947 droeschl 5352:
5353: /* needed for iframe to allow 100% height in FF */
5354: body, html {
5355: margin: 0;
5356: padding: 0 0.5%;
5357: height: 99%; /* to avoid scrollbars */
5358: }
5359:
1.795 www 5360: body {
1.911 bisitz 5361: font-family: $sans;
5362: line-height:130%;
5363: font-size:0.83em;
5364: color:$font;
1.795 www 5365: }
5366:
1.959 onken 5367: a:focus,
5368: a:focus img {
1.795 www 5369: color: red;
5370: }
1.698 harmsja 5371:
1.911 bisitz 5372: form, .inline {
5373: display: inline;
1.795 www 5374: }
1.721 harmsja 5375:
1.795 www 5376: .LC_right {
1.911 bisitz 5377: text-align:right;
1.795 www 5378: }
5379:
5380: .LC_middle {
1.911 bisitz 5381: vertical-align:middle;
1.795 www 5382: }
1.721 harmsja 5383:
1.911 bisitz 5384: .LC_400Box {
5385: width:400px;
5386: }
1.721 harmsja 5387:
1.947 droeschl 5388: .LC_iframecontainer {
5389: width: 98%;
5390: margin: 0;
5391: position: fixed;
5392: top: 8.5em;
5393: bottom: 0;
5394: }
5395:
5396: .LC_iframecontainer iframe{
5397: border: none;
5398: width: 100%;
5399: height: 100%;
5400: }
5401:
1.778 bisitz 5402: .LC_filename {
5403: font-family: $mono;
5404: white-space:pre;
1.921 bisitz 5405: font-size: 120%;
1.778 bisitz 5406: }
5407:
5408: .LC_fileicon {
5409: border: none;
5410: height: 1.3em;
5411: vertical-align: text-bottom;
5412: margin-right: 0.3em;
5413: text-decoration:none;
5414: }
5415:
1.1008 www 5416: .LC_setting {
5417: text-decoration:underline;
5418: }
5419:
1.350 albertel 5420: .LC_error {
5421: color: red;
5422: }
1.795 www 5423:
1.1075.2.15 raeburn 5424: .LC_warning {
5425: color: darkorange;
5426: }
5427:
1.457 albertel 5428: .LC_diff_removed {
1.733 bisitz 5429: color: red;
1.394 albertel 5430: }
1.532 albertel 5431:
5432: .LC_info,
1.457 albertel 5433: .LC_success,
5434: .LC_diff_added {
1.350 albertel 5435: color: green;
5436: }
1.795 www 5437:
1.802 bisitz 5438: div.LC_confirm_box {
5439: background-color: #FAFAFA;
5440: border: 1px solid $lg_border_color;
5441: margin-right: 0;
5442: padding: 5px;
5443: }
5444:
5445: div.LC_confirm_box .LC_error img,
5446: div.LC_confirm_box .LC_success img {
5447: vertical-align: middle;
5448: }
5449:
1.440 albertel 5450: .LC_icon {
1.771 droeschl 5451: border: none;
1.790 droeschl 5452: vertical-align: middle;
1.771 droeschl 5453: }
5454:
1.543 albertel 5455: .LC_docs_spacer {
5456: width: 25px;
5457: height: 1px;
1.771 droeschl 5458: border: none;
1.543 albertel 5459: }
1.346 albertel 5460:
1.532 albertel 5461: .LC_internal_info {
1.735 bisitz 5462: color: #999999;
1.532 albertel 5463: }
5464:
1.794 www 5465: .LC_discussion {
1.1050 www 5466: background: $data_table_dark;
1.911 bisitz 5467: border: 1px solid black;
5468: margin: 2px;
1.794 www 5469: }
5470:
5471: .LC_disc_action_left {
1.1050 www 5472: background: $sidebg;
1.911 bisitz 5473: text-align: left;
1.1050 www 5474: padding: 4px;
5475: margin: 2px;
1.794 www 5476: }
5477:
5478: .LC_disc_action_right {
1.1050 www 5479: background: $sidebg;
1.911 bisitz 5480: text-align: right;
1.1050 www 5481: padding: 4px;
5482: margin: 2px;
1.794 www 5483: }
5484:
5485: .LC_disc_new_item {
1.911 bisitz 5486: background: white;
5487: border: 2px solid red;
1.1050 www 5488: margin: 4px;
5489: padding: 4px;
1.794 www 5490: }
5491:
5492: .LC_disc_old_item {
1.911 bisitz 5493: background: white;
1.1050 www 5494: margin: 4px;
5495: padding: 4px;
1.794 www 5496: }
5497:
1.458 albertel 5498: table.LC_pastsubmission {
5499: border: 1px solid black;
5500: margin: 2px;
5501: }
5502:
1.924 bisitz 5503: table#LC_menubuttons {
1.345 albertel 5504: width: 100%;
5505: background: $pgbg;
1.392 albertel 5506: border: 2px;
1.402 albertel 5507: border-collapse: separate;
1.803 bisitz 5508: padding: 0;
1.345 albertel 5509: }
1.392 albertel 5510:
1.801 tempelho 5511: table#LC_title_bar a {
5512: color: $fontmenu;
5513: }
1.836 bisitz 5514:
1.807 droeschl 5515: table#LC_title_bar {
1.819 tempelho 5516: clear: both;
1.836 bisitz 5517: display: none;
1.807 droeschl 5518: }
5519:
1.795 www 5520: table#LC_title_bar,
1.933 droeschl 5521: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 5522: table#LC_title_bar.LC_with_remote {
1.359 albertel 5523: width: 100%;
1.392 albertel 5524: border-color: $pgbg;
5525: border-style: solid;
5526: border-width: $border;
1.379 albertel 5527: background: $pgbg;
1.801 tempelho 5528: color: $fontmenu;
1.392 albertel 5529: border-collapse: collapse;
1.803 bisitz 5530: padding: 0;
1.819 tempelho 5531: margin: 0;
1.359 albertel 5532: }
1.795 www 5533:
1.933 droeschl 5534: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 5535: margin: 0;
5536: padding: 0;
1.933 droeschl 5537: position: relative;
5538: list-style: none;
1.913 droeschl 5539: }
1.933 droeschl 5540: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 5541: display: inline;
5542: }
1.933 droeschl 5543:
5544: .LC_breadcrumb_tools_navigation {
1.913 droeschl 5545: padding: 0;
1.933 droeschl 5546: margin: 0;
5547: float: left;
1.913 droeschl 5548: }
1.933 droeschl 5549: .LC_breadcrumb_tools_tools {
5550: padding: 0;
5551: margin: 0;
1.913 droeschl 5552: float: right;
5553: }
5554:
1.359 albertel 5555: table#LC_title_bar td {
5556: background: $tabbg;
5557: }
1.795 www 5558:
1.911 bisitz 5559: table#LC_menubuttons img {
1.803 bisitz 5560: border: none;
1.346 albertel 5561: }
1.795 www 5562:
1.842 droeschl 5563: .LC_breadcrumbs_component {
1.911 bisitz 5564: float: right;
5565: margin: 0 1em;
1.357 albertel 5566: }
1.842 droeschl 5567: .LC_breadcrumbs_component img {
1.911 bisitz 5568: vertical-align: middle;
1.777 tempelho 5569: }
1.795 www 5570:
1.383 albertel 5571: td.LC_table_cell_checkbox {
5572: text-align: center;
5573: }
1.795 www 5574:
5575: .LC_fontsize_small {
1.911 bisitz 5576: font-size: 70%;
1.705 tempelho 5577: }
5578:
1.844 bisitz 5579: #LC_breadcrumbs {
1.911 bisitz 5580: clear:both;
5581: background: $sidebg;
5582: border-bottom: 1px solid $lg_border_color;
5583: line-height: 2.5em;
1.933 droeschl 5584: overflow: hidden;
1.911 bisitz 5585: margin: 0;
5586: padding: 0;
1.995 raeburn 5587: text-align: left;
1.819 tempelho 5588: }
1.862 bisitz 5589:
1.1075.2.16 raeburn 5590: .LC_head_subbox, .LC_actionbox {
1.911 bisitz 5591: clear:both;
5592: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 5593: border: 1px solid $sidebg;
1.1075.2.16 raeburn 5594: margin: 0 0 10px 0;
1.966 bisitz 5595: padding: 3px;
1.995 raeburn 5596: text-align: left;
1.822 bisitz 5597: }
5598:
1.795 www 5599: .LC_fontsize_medium {
1.911 bisitz 5600: font-size: 85%;
1.705 tempelho 5601: }
5602:
1.795 www 5603: .LC_fontsize_large {
1.911 bisitz 5604: font-size: 120%;
1.705 tempelho 5605: }
5606:
1.346 albertel 5607: .LC_menubuttons_inline_text {
5608: color: $font;
1.698 harmsja 5609: font-size: 90%;
1.701 harmsja 5610: padding-left:3px;
1.346 albertel 5611: }
5612:
1.934 droeschl 5613: .LC_menubuttons_inline_text img{
5614: vertical-align: middle;
5615: }
5616:
1.1051 www 5617: li.LC_menubuttons_inline_text img {
1.951 onken 5618: cursor:pointer;
1.1002 droeschl 5619: text-decoration: none;
1.951 onken 5620: }
5621:
1.526 www 5622: .LC_menubuttons_link {
5623: text-decoration: none;
5624: }
1.795 www 5625:
1.522 albertel 5626: .LC_menubuttons_category {
1.521 www 5627: color: $font;
1.526 www 5628: background: $pgbg;
1.521 www 5629: font-size: larger;
5630: font-weight: bold;
5631: }
5632:
1.346 albertel 5633: td.LC_menubuttons_text {
1.911 bisitz 5634: color: $font;
1.346 albertel 5635: }
1.706 harmsja 5636:
1.346 albertel 5637: .LC_current_location {
5638: background: $tabbg;
5639: }
1.795 www 5640:
1.938 bisitz 5641: table.LC_data_table {
1.347 albertel 5642: border: 1px solid #000000;
1.402 albertel 5643: border-collapse: separate;
1.426 albertel 5644: border-spacing: 1px;
1.610 albertel 5645: background: $pgbg;
1.347 albertel 5646: }
1.795 www 5647:
1.422 albertel 5648: .LC_data_table_dense {
5649: font-size: small;
5650: }
1.795 www 5651:
1.507 raeburn 5652: table.LC_nested_outer {
5653: border: 1px solid #000000;
1.589 raeburn 5654: border-collapse: collapse;
1.803 bisitz 5655: border-spacing: 0;
1.507 raeburn 5656: width: 100%;
5657: }
1.795 www 5658:
1.879 raeburn 5659: table.LC_innerpickbox,
1.507 raeburn 5660: table.LC_nested {
1.803 bisitz 5661: border: none;
1.589 raeburn 5662: border-collapse: collapse;
1.803 bisitz 5663: border-spacing: 0;
1.507 raeburn 5664: width: 100%;
5665: }
1.795 www 5666:
1.911 bisitz 5667: table.LC_data_table tr th,
5668: table.LC_calendar tr th,
1.879 raeburn 5669: table.LC_prior_tries tr th,
5670: table.LC_innerpickbox tr th {
1.349 albertel 5671: font-weight: bold;
5672: background-color: $data_table_head;
1.801 tempelho 5673: color:$fontmenu;
1.701 harmsja 5674: font-size:90%;
1.347 albertel 5675: }
1.795 www 5676:
1.879 raeburn 5677: table.LC_innerpickbox tr th,
5678: table.LC_innerpickbox tr td {
5679: vertical-align: top;
5680: }
5681:
1.711 raeburn 5682: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 5683: background-color: #CCCCCC;
1.711 raeburn 5684: font-weight: bold;
5685: text-align: left;
5686: }
1.795 www 5687:
1.912 bisitz 5688: table.LC_data_table tr.LC_odd_row > td {
5689: background-color: $data_table_light;
5690: padding: 2px;
5691: vertical-align: top;
5692: }
5693:
1.809 bisitz 5694: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 5695: background-color: $data_table_light;
1.912 bisitz 5696: vertical-align: top;
5697: }
5698:
5699: table.LC_data_table tr.LC_even_row > td {
5700: background-color: $data_table_dark;
1.425 albertel 5701: padding: 2px;
1.900 bisitz 5702: vertical-align: top;
1.347 albertel 5703: }
1.795 www 5704:
1.809 bisitz 5705: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 5706: background-color: $data_table_dark;
1.900 bisitz 5707: vertical-align: top;
1.347 albertel 5708: }
1.795 www 5709:
1.425 albertel 5710: table.LC_data_table tr.LC_data_table_highlight td {
5711: background-color: $data_table_darker;
5712: }
1.795 www 5713:
1.639 raeburn 5714: table.LC_data_table tr td.LC_leftcol_header {
5715: background-color: $data_table_head;
5716: font-weight: bold;
5717: }
1.795 www 5718:
1.451 albertel 5719: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5720: table.LC_nested tr.LC_empty_row td {
1.421 albertel 5721: font-weight: bold;
5722: font-style: italic;
5723: text-align: center;
5724: padding: 8px;
1.347 albertel 5725: }
1.795 www 5726:
1.1075.2.30 raeburn 5727: table.LC_data_table tr.LC_empty_row td,
5728: table.LC_data_table tr.LC_footer_row td {
1.940 bisitz 5729: background-color: $sidebg;
5730: }
5731:
5732: table.LC_nested tr.LC_empty_row td {
5733: background-color: #FFFFFF;
5734: }
5735:
1.890 droeschl 5736: table.LC_caption {
5737: }
5738:
1.507 raeburn 5739: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5740: padding: 4ex
5741: }
1.795 www 5742:
1.507 raeburn 5743: table.LC_nested_outer tr th {
5744: font-weight: bold;
1.801 tempelho 5745: color:$fontmenu;
1.507 raeburn 5746: background-color: $data_table_head;
1.701 harmsja 5747: font-size: small;
1.507 raeburn 5748: border-bottom: 1px solid #000000;
5749: }
1.795 www 5750:
1.507 raeburn 5751: table.LC_nested_outer tr td.LC_subheader {
5752: background-color: $data_table_head;
5753: font-weight: bold;
5754: font-size: small;
5755: border-bottom: 1px solid #000000;
5756: text-align: right;
1.451 albertel 5757: }
1.795 www 5758:
1.507 raeburn 5759: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5760: background-color: #CCCCCC;
1.451 albertel 5761: font-weight: bold;
5762: font-size: small;
1.507 raeburn 5763: text-align: center;
5764: }
1.795 www 5765:
1.589 raeburn 5766: table.LC_nested tr.LC_info_row td.LC_left_item,
5767: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5768: text-align: left;
1.451 albertel 5769: }
1.795 www 5770:
1.507 raeburn 5771: table.LC_nested td {
1.735 bisitz 5772: background-color: #FFFFFF;
1.451 albertel 5773: font-size: small;
1.507 raeburn 5774: }
1.795 www 5775:
1.507 raeburn 5776: table.LC_nested_outer tr th.LC_right_item,
5777: table.LC_nested tr.LC_info_row td.LC_right_item,
5778: table.LC_nested tr.LC_odd_row td.LC_right_item,
5779: table.LC_nested tr td.LC_right_item {
1.451 albertel 5780: text-align: right;
5781: }
5782:
1.507 raeburn 5783: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5784: background-color: #EEEEEE;
1.451 albertel 5785: }
5786:
1.473 raeburn 5787: table.LC_createuser {
5788: }
5789:
5790: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5791: font-size: small;
1.473 raeburn 5792: }
5793:
5794: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5795: background-color: #CCCCCC;
1.473 raeburn 5796: font-weight: bold;
5797: text-align: center;
5798: }
5799:
1.349 albertel 5800: table.LC_calendar {
5801: border: 1px solid #000000;
5802: border-collapse: collapse;
1.917 raeburn 5803: width: 98%;
1.349 albertel 5804: }
1.795 www 5805:
1.349 albertel 5806: table.LC_calendar_pickdate {
5807: font-size: xx-small;
5808: }
1.795 www 5809:
1.349 albertel 5810: table.LC_calendar tr td {
5811: border: 1px solid #000000;
5812: vertical-align: top;
1.917 raeburn 5813: width: 14%;
1.349 albertel 5814: }
1.795 www 5815:
1.349 albertel 5816: table.LC_calendar tr td.LC_calendar_day_empty {
5817: background-color: $data_table_dark;
5818: }
1.795 www 5819:
1.779 bisitz 5820: table.LC_calendar tr td.LC_calendar_day_current {
5821: background-color: $data_table_highlight;
1.777 tempelho 5822: }
1.795 www 5823:
1.938 bisitz 5824: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 5825: background-color: $mail_new;
5826: }
1.795 www 5827:
1.938 bisitz 5828: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 5829: background-color: $mail_new_hover;
5830: }
1.795 www 5831:
1.938 bisitz 5832: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 5833: background-color: $mail_read;
5834: }
1.795 www 5835:
1.938 bisitz 5836: /*
5837: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 5838: background-color: $mail_read_hover;
5839: }
1.938 bisitz 5840: */
1.795 www 5841:
1.938 bisitz 5842: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 5843: background-color: $mail_replied;
5844: }
1.795 www 5845:
1.938 bisitz 5846: /*
5847: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 5848: background-color: $mail_replied_hover;
5849: }
1.938 bisitz 5850: */
1.795 www 5851:
1.938 bisitz 5852: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 5853: background-color: $mail_other;
5854: }
1.795 www 5855:
1.938 bisitz 5856: /*
5857: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 5858: background-color: $mail_other_hover;
5859: }
1.938 bisitz 5860: */
1.494 raeburn 5861:
1.777 tempelho 5862: table.LC_data_table tr > td.LC_browser_file,
5863: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 5864: background: #AAEE77;
1.389 albertel 5865: }
1.795 www 5866:
1.777 tempelho 5867: table.LC_data_table tr > td.LC_browser_file_locked,
5868: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5869: background: #FFAA99;
1.387 albertel 5870: }
1.795 www 5871:
1.777 tempelho 5872: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 5873: background: #888888;
1.779 bisitz 5874: }
1.795 www 5875:
1.777 tempelho 5876: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5877: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 5878: background: #F8F866;
1.777 tempelho 5879: }
1.795 www 5880:
1.696 bisitz 5881: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 5882: background: #E0E8FF;
1.387 albertel 5883: }
1.696 bisitz 5884:
1.707 bisitz 5885: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 5886: /* background: #77FF77; */
1.707 bisitz 5887: }
1.795 www 5888:
1.707 bisitz 5889: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 5890: border-right: 8px solid #FFFF77;
1.707 bisitz 5891: }
1.795 www 5892:
1.707 bisitz 5893: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 5894: border-right: 8px solid #FFAA77;
1.707 bisitz 5895: }
1.795 www 5896:
1.707 bisitz 5897: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 5898: border-right: 8px solid #FF7777;
1.707 bisitz 5899: }
1.795 www 5900:
1.707 bisitz 5901: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 5902: border-right: 8px solid #AAFF77;
1.707 bisitz 5903: }
1.795 www 5904:
1.707 bisitz 5905: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 5906: border-right: 8px solid #11CC55;
1.707 bisitz 5907: }
5908:
1.388 albertel 5909: span.LC_current_location {
1.701 harmsja 5910: font-size:larger;
1.388 albertel 5911: background: $pgbg;
5912: }
1.387 albertel 5913:
1.1029 www 5914: span.LC_current_nav_location {
5915: font-weight:bold;
5916: background: $sidebg;
5917: }
5918:
1.395 albertel 5919: span.LC_parm_menu_item {
5920: font-size: larger;
5921: }
1.795 www 5922:
1.395 albertel 5923: span.LC_parm_scope_all {
5924: color: red;
5925: }
1.795 www 5926:
1.395 albertel 5927: span.LC_parm_scope_folder {
5928: color: green;
5929: }
1.795 www 5930:
1.395 albertel 5931: span.LC_parm_scope_resource {
5932: color: orange;
5933: }
1.795 www 5934:
1.395 albertel 5935: span.LC_parm_part {
5936: color: blue;
5937: }
1.795 www 5938:
1.911 bisitz 5939: span.LC_parm_folder,
5940: span.LC_parm_symb {
1.395 albertel 5941: font-size: x-small;
5942: font-family: $mono;
5943: color: #AAAAAA;
5944: }
5945:
1.977 bisitz 5946: ul.LC_parm_parmlist li {
5947: display: inline-block;
5948: padding: 0.3em 0.8em;
5949: vertical-align: top;
5950: width: 150px;
5951: border-top:1px solid $lg_border_color;
5952: }
5953:
1.795 www 5954: td.LC_parm_overview_level_menu,
5955: td.LC_parm_overview_map_menu,
5956: td.LC_parm_overview_parm_selectors,
5957: td.LC_parm_overview_restrictions {
1.396 albertel 5958: border: 1px solid black;
5959: border-collapse: collapse;
5960: }
1.795 www 5961:
1.396 albertel 5962: table.LC_parm_overview_restrictions td {
5963: border-width: 1px 4px 1px 4px;
5964: border-style: solid;
5965: border-color: $pgbg;
5966: text-align: center;
5967: }
1.795 www 5968:
1.396 albertel 5969: table.LC_parm_overview_restrictions th {
5970: background: $tabbg;
5971: border-width: 1px 4px 1px 4px;
5972: border-style: solid;
5973: border-color: $pgbg;
5974: }
1.795 www 5975:
1.398 albertel 5976: table#LC_helpmenu {
1.803 bisitz 5977: border: none;
1.398 albertel 5978: height: 55px;
1.803 bisitz 5979: border-spacing: 0;
1.398 albertel 5980: }
5981:
5982: table#LC_helpmenu fieldset legend {
5983: font-size: larger;
5984: }
1.795 www 5985:
1.397 albertel 5986: table#LC_helpmenu_links {
5987: width: 100%;
5988: border: 1px solid black;
5989: background: $pgbg;
1.803 bisitz 5990: padding: 0;
1.397 albertel 5991: border-spacing: 1px;
5992: }
1.795 www 5993:
1.397 albertel 5994: table#LC_helpmenu_links tr td {
5995: padding: 1px;
5996: background: $tabbg;
1.399 albertel 5997: text-align: center;
5998: font-weight: bold;
1.397 albertel 5999: }
1.396 albertel 6000:
1.795 www 6001: table#LC_helpmenu_links a:link,
6002: table#LC_helpmenu_links a:visited,
1.397 albertel 6003: table#LC_helpmenu_links a:active {
6004: text-decoration: none;
6005: color: $font;
6006: }
1.795 www 6007:
1.397 albertel 6008: table#LC_helpmenu_links a:hover {
6009: text-decoration: underline;
6010: color: $vlink;
6011: }
1.396 albertel 6012:
1.417 albertel 6013: .LC_chrt_popup_exists {
6014: border: 1px solid #339933;
6015: margin: -1px;
6016: }
1.795 www 6017:
1.417 albertel 6018: .LC_chrt_popup_up {
6019: border: 1px solid yellow;
6020: margin: -1px;
6021: }
1.795 www 6022:
1.417 albertel 6023: .LC_chrt_popup {
6024: border: 1px solid #8888FF;
6025: background: #CCCCFF;
6026: }
1.795 www 6027:
1.421 albertel 6028: table.LC_pick_box {
6029: border-collapse: separate;
6030: background: white;
6031: border: 1px solid black;
6032: border-spacing: 1px;
6033: }
1.795 www 6034:
1.421 albertel 6035: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 6036: background: $sidebg;
1.421 albertel 6037: font-weight: bold;
1.900 bisitz 6038: text-align: left;
1.740 bisitz 6039: vertical-align: top;
1.421 albertel 6040: width: 184px;
6041: padding: 8px;
6042: }
1.795 www 6043:
1.579 raeburn 6044: table.LC_pick_box td.LC_pick_box_value {
6045: text-align: left;
6046: padding: 8px;
6047: }
1.795 www 6048:
1.579 raeburn 6049: table.LC_pick_box td.LC_pick_box_select {
6050: text-align: left;
6051: padding: 8px;
6052: }
1.795 www 6053:
1.424 albertel 6054: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 6055: padding: 0;
1.421 albertel 6056: height: 1px;
6057: background: black;
6058: }
1.795 www 6059:
1.421 albertel 6060: table.LC_pick_box td.LC_pick_box_submit {
6061: text-align: right;
6062: }
1.795 www 6063:
1.579 raeburn 6064: table.LC_pick_box td.LC_evenrow_value {
6065: text-align: left;
6066: padding: 8px;
6067: background-color: $data_table_light;
6068: }
1.795 www 6069:
1.579 raeburn 6070: table.LC_pick_box td.LC_oddrow_value {
6071: text-align: left;
6072: padding: 8px;
6073: background-color: $data_table_light;
6074: }
1.795 www 6075:
1.579 raeburn 6076: span.LC_helpform_receipt_cat {
6077: font-weight: bold;
6078: }
1.795 www 6079:
1.424 albertel 6080: table.LC_group_priv_box {
6081: background: white;
6082: border: 1px solid black;
6083: border-spacing: 1px;
6084: }
1.795 www 6085:
1.424 albertel 6086: table.LC_group_priv_box td.LC_pick_box_title {
6087: background: $tabbg;
6088: font-weight: bold;
6089: text-align: right;
6090: width: 184px;
6091: }
1.795 www 6092:
1.424 albertel 6093: table.LC_group_priv_box td.LC_groups_fixed {
6094: background: $data_table_light;
6095: text-align: center;
6096: }
1.795 www 6097:
1.424 albertel 6098: table.LC_group_priv_box td.LC_groups_optional {
6099: background: $data_table_dark;
6100: text-align: center;
6101: }
1.795 www 6102:
1.424 albertel 6103: table.LC_group_priv_box td.LC_groups_functionality {
6104: background: $data_table_darker;
6105: text-align: center;
6106: font-weight: bold;
6107: }
1.795 www 6108:
1.424 albertel 6109: table.LC_group_priv td {
6110: text-align: left;
1.803 bisitz 6111: padding: 0;
1.424 albertel 6112: }
6113:
6114: .LC_navbuttons {
6115: margin: 2ex 0ex 2ex 0ex;
6116: }
1.795 www 6117:
1.423 albertel 6118: .LC_topic_bar {
6119: font-weight: bold;
6120: background: $tabbg;
1.918 wenzelju 6121: margin: 1em 0em 1em 2em;
1.805 bisitz 6122: padding: 3px;
1.918 wenzelju 6123: font-size: 1.2em;
1.423 albertel 6124: }
1.795 www 6125:
1.423 albertel 6126: .LC_topic_bar span {
1.918 wenzelju 6127: left: 0.5em;
6128: position: absolute;
1.423 albertel 6129: vertical-align: middle;
1.918 wenzelju 6130: font-size: 1.2em;
1.423 albertel 6131: }
1.795 www 6132:
1.423 albertel 6133: table.LC_course_group_status {
6134: margin: 20px;
6135: }
1.795 www 6136:
1.423 albertel 6137: table.LC_status_selector td {
6138: vertical-align: top;
6139: text-align: center;
1.424 albertel 6140: padding: 4px;
6141: }
1.795 www 6142:
1.599 albertel 6143: div.LC_feedback_link {
1.616 albertel 6144: clear: both;
1.829 kalberla 6145: background: $sidebg;
1.779 bisitz 6146: width: 100%;
1.829 kalberla 6147: padding-bottom: 10px;
6148: border: 1px $tabbg solid;
1.833 kalberla 6149: height: 22px;
6150: line-height: 22px;
6151: padding-top: 5px;
6152: }
6153:
6154: div.LC_feedback_link img {
6155: height: 22px;
1.867 kalberla 6156: vertical-align:middle;
1.829 kalberla 6157: }
6158:
1.911 bisitz 6159: div.LC_feedback_link a {
1.829 kalberla 6160: text-decoration: none;
1.489 raeburn 6161: }
1.795 www 6162:
1.867 kalberla 6163: div.LC_comblock {
1.911 bisitz 6164: display:inline;
1.867 kalberla 6165: color:$font;
6166: font-size:90%;
6167: }
6168:
6169: div.LC_feedback_link div.LC_comblock {
6170: padding-left:5px;
6171: }
6172:
6173: div.LC_feedback_link div.LC_comblock a {
6174: color:$font;
6175: }
6176:
1.489 raeburn 6177: span.LC_feedback_link {
1.858 bisitz 6178: /* background: $feedback_link_bg; */
1.599 albertel 6179: font-size: larger;
6180: }
1.795 www 6181:
1.599 albertel 6182: span.LC_message_link {
1.858 bisitz 6183: /* background: $feedback_link_bg; */
1.599 albertel 6184: font-size: larger;
6185: position: absolute;
6186: right: 1em;
1.489 raeburn 6187: }
1.421 albertel 6188:
1.515 albertel 6189: table.LC_prior_tries {
1.524 albertel 6190: border: 1px solid #000000;
6191: border-collapse: separate;
6192: border-spacing: 1px;
1.515 albertel 6193: }
1.523 albertel 6194:
1.515 albertel 6195: table.LC_prior_tries td {
1.524 albertel 6196: padding: 2px;
1.515 albertel 6197: }
1.523 albertel 6198:
6199: .LC_answer_correct {
1.795 www 6200: background: lightgreen;
6201: color: darkgreen;
6202: padding: 6px;
1.523 albertel 6203: }
1.795 www 6204:
1.523 albertel 6205: .LC_answer_charged_try {
1.797 www 6206: background: #FFAAAA;
1.795 www 6207: color: darkred;
6208: padding: 6px;
1.523 albertel 6209: }
1.795 www 6210:
1.779 bisitz 6211: .LC_answer_not_charged_try,
1.523 albertel 6212: .LC_answer_no_grade,
6213: .LC_answer_late {
1.795 www 6214: background: lightyellow;
1.523 albertel 6215: color: black;
1.795 www 6216: padding: 6px;
1.523 albertel 6217: }
1.795 www 6218:
1.523 albertel 6219: .LC_answer_previous {
1.795 www 6220: background: lightblue;
6221: color: darkblue;
6222: padding: 6px;
1.523 albertel 6223: }
1.795 www 6224:
1.779 bisitz 6225: .LC_answer_no_message {
1.777 tempelho 6226: background: #FFFFFF;
6227: color: black;
1.795 www 6228: padding: 6px;
1.779 bisitz 6229: }
1.795 www 6230:
1.779 bisitz 6231: .LC_answer_unknown {
6232: background: orange;
6233: color: black;
1.795 www 6234: padding: 6px;
1.777 tempelho 6235: }
1.795 www 6236:
1.529 albertel 6237: span.LC_prior_numerical,
6238: span.LC_prior_string,
6239: span.LC_prior_custom,
6240: span.LC_prior_reaction,
6241: span.LC_prior_math {
1.925 bisitz 6242: font-family: $mono;
1.523 albertel 6243: white-space: pre;
6244: }
6245:
1.525 albertel 6246: span.LC_prior_string {
1.925 bisitz 6247: font-family: $mono;
1.525 albertel 6248: white-space: pre;
6249: }
6250:
1.523 albertel 6251: table.LC_prior_option {
6252: width: 100%;
6253: border-collapse: collapse;
6254: }
1.795 www 6255:
1.911 bisitz 6256: table.LC_prior_rank,
1.795 www 6257: table.LC_prior_match {
1.528 albertel 6258: border-collapse: collapse;
6259: }
1.795 www 6260:
1.528 albertel 6261: table.LC_prior_option tr td,
6262: table.LC_prior_rank tr td,
6263: table.LC_prior_match tr td {
1.524 albertel 6264: border: 1px solid #000000;
1.515 albertel 6265: }
6266:
1.855 bisitz 6267: .LC_nobreak {
1.544 albertel 6268: white-space: nowrap;
1.519 raeburn 6269: }
6270:
1.576 raeburn 6271: span.LC_cusr_emph {
6272: font-style: italic;
6273: }
6274:
1.633 raeburn 6275: span.LC_cusr_subheading {
6276: font-weight: normal;
6277: font-size: 85%;
6278: }
6279:
1.861 bisitz 6280: div.LC_docs_entry_move {
1.859 bisitz 6281: border: 1px solid #BBBBBB;
1.545 albertel 6282: background: #DDDDDD;
1.861 bisitz 6283: width: 22px;
1.859 bisitz 6284: padding: 1px;
6285: margin: 0;
1.545 albertel 6286: }
6287:
1.861 bisitz 6288: table.LC_data_table tr > td.LC_docs_entry_commands,
6289: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 6290: font-size: x-small;
6291: }
1.795 www 6292:
1.861 bisitz 6293: .LC_docs_entry_parameter {
6294: white-space: nowrap;
6295: }
6296:
1.544 albertel 6297: .LC_docs_copy {
1.545 albertel 6298: color: #000099;
1.544 albertel 6299: }
1.795 www 6300:
1.544 albertel 6301: .LC_docs_cut {
1.545 albertel 6302: color: #550044;
1.544 albertel 6303: }
1.795 www 6304:
1.544 albertel 6305: .LC_docs_rename {
1.545 albertel 6306: color: #009900;
1.544 albertel 6307: }
1.795 www 6308:
1.544 albertel 6309: .LC_docs_remove {
1.545 albertel 6310: color: #990000;
6311: }
6312:
1.547 albertel 6313: .LC_docs_reinit_warn,
6314: .LC_docs_ext_edit {
6315: font-size: x-small;
6316: }
6317:
1.545 albertel 6318: table.LC_docs_adddocs td,
6319: table.LC_docs_adddocs th {
6320: border: 1px solid #BBBBBB;
6321: padding: 4px;
6322: background: #DDDDDD;
1.543 albertel 6323: }
6324:
1.584 albertel 6325: table.LC_sty_begin {
6326: background: #BBFFBB;
6327: }
1.795 www 6328:
1.584 albertel 6329: table.LC_sty_end {
6330: background: #FFBBBB;
6331: }
6332:
1.589 raeburn 6333: table.LC_double_column {
1.803 bisitz 6334: border-width: 0;
1.589 raeburn 6335: border-collapse: collapse;
6336: width: 100%;
6337: padding: 2px;
6338: }
6339:
6340: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 6341: top: 2px;
1.589 raeburn 6342: left: 2px;
6343: width: 47%;
6344: vertical-align: top;
6345: }
6346:
6347: table.LC_double_column tr td.LC_right_col {
6348: top: 2px;
1.779 bisitz 6349: right: 2px;
1.589 raeburn 6350: width: 47%;
6351: vertical-align: top;
6352: }
6353:
1.591 raeburn 6354: div.LC_left_float {
6355: float: left;
6356: padding-right: 5%;
1.597 albertel 6357: padding-bottom: 4px;
1.591 raeburn 6358: }
6359:
6360: div.LC_clear_float_header {
1.597 albertel 6361: padding-bottom: 2px;
1.591 raeburn 6362: }
6363:
6364: div.LC_clear_float_footer {
1.597 albertel 6365: padding-top: 10px;
1.591 raeburn 6366: clear: both;
6367: }
6368:
1.597 albertel 6369: div.LC_grade_show_user {
1.941 bisitz 6370: /* border-left: 5px solid $sidebg; */
6371: border-top: 5px solid #000000;
6372: margin: 50px 0 0 0;
1.936 bisitz 6373: padding: 15px 0 5px 10px;
1.597 albertel 6374: }
1.795 www 6375:
1.936 bisitz 6376: div.LC_grade_show_user_odd_row {
1.941 bisitz 6377: /* border-left: 5px solid #000000; */
6378: }
6379:
6380: div.LC_grade_show_user div.LC_Box {
6381: margin-right: 50px;
1.597 albertel 6382: }
6383:
6384: div.LC_grade_submissions,
6385: div.LC_grade_message_center,
1.936 bisitz 6386: div.LC_grade_info_links {
1.597 albertel 6387: margin: 5px;
6388: width: 99%;
6389: background: #FFFFFF;
6390: }
1.795 www 6391:
1.597 albertel 6392: div.LC_grade_submissions_header,
1.936 bisitz 6393: div.LC_grade_message_center_header {
1.705 tempelho 6394: font-weight: bold;
6395: font-size: large;
1.597 albertel 6396: }
1.795 www 6397:
1.597 albertel 6398: div.LC_grade_submissions_body,
1.936 bisitz 6399: div.LC_grade_message_center_body {
1.597 albertel 6400: border: 1px solid black;
6401: width: 99%;
6402: background: #FFFFFF;
6403: }
1.795 www 6404:
1.613 albertel 6405: table.LC_scantron_action {
6406: width: 100%;
6407: }
1.795 www 6408:
1.613 albertel 6409: table.LC_scantron_action tr th {
1.698 harmsja 6410: font-weight:bold;
6411: font-style:normal;
1.613 albertel 6412: }
1.795 www 6413:
1.779 bisitz 6414: .LC_edit_problem_header,
1.614 albertel 6415: div.LC_edit_problem_footer {
1.705 tempelho 6416: font-weight: normal;
6417: font-size: medium;
1.602 albertel 6418: margin: 2px;
1.1060 bisitz 6419: background-color: $sidebg;
1.600 albertel 6420: }
1.795 www 6421:
1.600 albertel 6422: div.LC_edit_problem_header,
1.602 albertel 6423: div.LC_edit_problem_header div,
1.614 albertel 6424: div.LC_edit_problem_footer,
6425: div.LC_edit_problem_footer div,
1.602 albertel 6426: div.LC_edit_problem_editxml_header,
6427: div.LC_edit_problem_editxml_header div {
1.600 albertel 6428: margin-top: 5px;
6429: }
1.795 www 6430:
1.600 albertel 6431: div.LC_edit_problem_header_title {
1.705 tempelho 6432: font-weight: bold;
6433: font-size: larger;
1.602 albertel 6434: background: $tabbg;
6435: padding: 3px;
1.1060 bisitz 6436: margin: 0 0 5px 0;
1.602 albertel 6437: }
1.795 www 6438:
1.602 albertel 6439: table.LC_edit_problem_header_title {
6440: width: 100%;
1.600 albertel 6441: background: $tabbg;
1.602 albertel 6442: }
6443:
6444: div.LC_edit_problem_discards {
6445: float: left;
6446: padding-bottom: 5px;
6447: }
1.795 www 6448:
1.602 albertel 6449: div.LC_edit_problem_saves {
6450: float: right;
6451: padding-bottom: 5px;
1.600 albertel 6452: }
1.795 www 6453:
1.1075.2.34 raeburn 6454: .LC_edit_opt {
6455: padding-left: 1em;
6456: white-space: nowrap;
6457: }
6458:
1.911 bisitz 6459: img.stift {
1.803 bisitz 6460: border-width: 0;
6461: vertical-align: middle;
1.677 riegler 6462: }
1.680 riegler 6463:
1.923 bisitz 6464: table td.LC_mainmenu_col_fieldset {
1.680 riegler 6465: vertical-align: top;
1.777 tempelho 6466: }
1.795 www 6467:
1.716 raeburn 6468: div.LC_createcourse {
1.911 bisitz 6469: margin: 10px 10px 10px 10px;
1.716 raeburn 6470: }
6471:
1.917 raeburn 6472: .LC_dccid {
6473: margin: 0.2em 0 0 0;
6474: padding: 0;
6475: font-size: 90%;
6476: display:none;
6477: }
6478:
1.897 wenzelju 6479: ol.LC_primary_menu a:hover,
1.721 harmsja 6480: ol#LC_MenuBreadcrumbs a:hover,
6481: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 6482: ul#LC_secondary_menu a:hover,
1.721 harmsja 6483: .LC_FormSectionClearButton input:hover
1.795 www 6484: ul.LC_TabContent li:hover a {
1.952 onken 6485: color:$button_hover;
1.911 bisitz 6486: text-decoration:none;
1.693 droeschl 6487: }
6488:
1.779 bisitz 6489: h1 {
1.911 bisitz 6490: padding: 0;
6491: line-height:130%;
1.693 droeschl 6492: }
1.698 harmsja 6493:
1.911 bisitz 6494: h2,
6495: h3,
6496: h4,
6497: h5,
6498: h6 {
6499: margin: 5px 0 5px 0;
6500: padding: 0;
6501: line-height:130%;
1.693 droeschl 6502: }
1.795 www 6503:
6504: .LC_hcell {
1.911 bisitz 6505: padding:3px 15px 3px 15px;
6506: margin: 0;
6507: background-color:$tabbg;
6508: color:$fontmenu;
6509: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 6510: }
1.795 www 6511:
1.840 bisitz 6512: .LC_Box > .LC_hcell {
1.911 bisitz 6513: margin: 0 -10px 10px -10px;
1.835 bisitz 6514: }
6515:
1.721 harmsja 6516: .LC_noBorder {
1.911 bisitz 6517: border: 0;
1.698 harmsja 6518: }
1.693 droeschl 6519:
1.721 harmsja 6520: .LC_FormSectionClearButton input {
1.911 bisitz 6521: background-color:transparent;
6522: border: none;
6523: cursor:pointer;
6524: text-decoration:underline;
1.693 droeschl 6525: }
1.763 bisitz 6526:
6527: .LC_help_open_topic {
1.911 bisitz 6528: color: #FFFFFF;
6529: background-color: #EEEEFF;
6530: margin: 1px;
6531: padding: 4px;
6532: border: 1px solid #000033;
6533: white-space: nowrap;
6534: /* vertical-align: middle; */
1.759 neumanie 6535: }
1.693 droeschl 6536:
1.911 bisitz 6537: dl,
6538: ul,
6539: div,
6540: fieldset {
6541: margin: 10px 10px 10px 0;
6542: /* overflow: hidden; */
1.693 droeschl 6543: }
1.795 www 6544:
1.838 bisitz 6545: fieldset > legend {
1.911 bisitz 6546: font-weight: bold;
6547: padding: 0 5px 0 5px;
1.838 bisitz 6548: }
6549:
1.813 bisitz 6550: #LC_nav_bar {
1.911 bisitz 6551: float: left;
1.995 raeburn 6552: background-color: $pgbg_or_bgcolor;
1.966 bisitz 6553: margin: 0 0 2px 0;
1.807 droeschl 6554: }
6555:
1.916 droeschl 6556: #LC_realm {
6557: margin: 0.2em 0 0 0;
6558: padding: 0;
6559: font-weight: bold;
6560: text-align: center;
1.995 raeburn 6561: background-color: $pgbg_or_bgcolor;
1.916 droeschl 6562: }
6563:
1.911 bisitz 6564: #LC_nav_bar em {
6565: font-weight: bold;
6566: font-style: normal;
1.807 droeschl 6567: }
6568:
1.897 wenzelju 6569: ol.LC_primary_menu {
1.911 bisitz 6570: float: right;
1.934 droeschl 6571: margin: 0;
1.1075.2.2 raeburn 6572: padding: 0;
1.995 raeburn 6573: background-color: $pgbg_or_bgcolor;
1.807 droeschl 6574: }
6575:
1.852 droeschl 6576: ol#LC_PathBreadcrumbs {
1.911 bisitz 6577: margin: 0;
1.693 droeschl 6578: }
6579:
1.897 wenzelju 6580: ol.LC_primary_menu li {
1.1075.2.2 raeburn 6581: color: RGB(80, 80, 80);
6582: vertical-align: middle;
6583: text-align: left;
6584: list-style: none;
6585: float: left;
6586: }
6587:
6588: ol.LC_primary_menu li a {
6589: display: block;
6590: margin: 0;
6591: padding: 0 5px 0 10px;
6592: text-decoration: none;
6593: }
6594:
6595: ol.LC_primary_menu li ul {
6596: display: none;
6597: width: 10em;
6598: background-color: $data_table_light;
6599: }
6600:
6601: ol.LC_primary_menu li:hover ul, ol.LC_primary_menu li.hover ul {
6602: display: block;
6603: position: absolute;
6604: margin: 0;
6605: padding: 0;
1.1075.2.5 raeburn 6606: z-index: 2;
1.1075.2.2 raeburn 6607: }
6608:
6609: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
6610: font-size: 90%;
1.911 bisitz 6611: vertical-align: top;
1.1075.2.2 raeburn 6612: float: none;
1.1075.2.5 raeburn 6613: border-left: 1px solid black;
6614: border-right: 1px solid black;
1.1075.2.2 raeburn 6615: }
6616:
6617: ol.LC_primary_menu li:hover li a, ol.LC_primary_menu li.hover li a {
1.1075.2.5 raeburn 6618: background-color:$data_table_light;
1.1075.2.2 raeburn 6619: }
6620:
6621: ol.LC_primary_menu li li a:hover {
6622: color:$button_hover;
6623: background-color:$data_table_dark;
1.693 droeschl 6624: }
6625:
1.897 wenzelju 6626: ol.LC_primary_menu li img {
1.911 bisitz 6627: vertical-align: bottom;
1.934 droeschl 6628: height: 1.1em;
1.1075.2.3 raeburn 6629: margin: 0.2em 0 0 0;
1.693 droeschl 6630: }
6631:
1.897 wenzelju 6632: ol.LC_primary_menu a {
1.911 bisitz 6633: color: RGB(80, 80, 80);
6634: text-decoration: none;
1.693 droeschl 6635: }
1.795 www 6636:
1.949 droeschl 6637: ol.LC_primary_menu a.LC_new_message {
6638: font-weight:bold;
6639: color: darkred;
6640: }
6641:
1.975 raeburn 6642: ol.LC_docs_parameters {
6643: margin-left: 0;
6644: padding: 0;
6645: list-style: none;
6646: }
6647:
6648: ol.LC_docs_parameters li {
6649: margin: 0;
6650: padding-right: 20px;
6651: display: inline;
6652: }
6653:
1.976 raeburn 6654: ol.LC_docs_parameters li:before {
6655: content: "\\002022 \\0020";
6656: }
6657:
6658: li.LC_docs_parameters_title {
6659: font-weight: bold;
6660: }
6661:
6662: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
6663: content: "";
6664: }
6665:
1.897 wenzelju 6666: ul#LC_secondary_menu {
1.1075.2.23 raeburn 6667: clear: right;
1.911 bisitz 6668: color: $fontmenu;
6669: background: $tabbg;
6670: list-style: none;
6671: padding: 0;
6672: margin: 0;
6673: width: 100%;
1.995 raeburn 6674: text-align: left;
1.1075.2.4 raeburn 6675: float: left;
1.808 droeschl 6676: }
6677:
1.897 wenzelju 6678: ul#LC_secondary_menu li {
1.911 bisitz 6679: font-weight: bold;
6680: line-height: 1.8em;
6681: border-right: 1px solid black;
6682: vertical-align: middle;
1.1075.2.4 raeburn 6683: float: left;
6684: }
6685:
6686: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
6687: background-color: $data_table_light;
6688: }
6689:
6690: ul#LC_secondary_menu li a {
6691: padding: 0 0.8em;
6692: }
6693:
6694: ul#LC_secondary_menu li ul {
6695: display: none;
6696: }
6697:
6698: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
6699: display: block;
6700: position: absolute;
6701: margin: 0;
6702: padding: 0;
6703: list-style:none;
6704: float: none;
6705: background-color: $data_table_light;
1.1075.2.5 raeburn 6706: z-index: 2;
1.1075.2.10 raeburn 6707: margin-left: -1px;
1.1075.2.4 raeburn 6708: }
6709:
6710: ul#LC_secondary_menu li ul li {
6711: font-size: 90%;
6712: vertical-align: top;
6713: border-left: 1px solid black;
6714: border-right: 1px solid black;
1.1075.2.33 raeburn 6715: background-color: $data_table_light;
1.1075.2.4 raeburn 6716: list-style:none;
6717: float: none;
6718: }
6719:
6720: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
6721: background-color: $data_table_dark;
1.807 droeschl 6722: }
6723:
1.847 tempelho 6724: ul.LC_TabContent {
1.911 bisitz 6725: display:block;
6726: background: $sidebg;
6727: border-bottom: solid 1px $lg_border_color;
6728: list-style:none;
1.1020 raeburn 6729: margin: -1px -10px 0 -10px;
1.911 bisitz 6730: padding: 0;
1.693 droeschl 6731: }
6732:
1.795 www 6733: ul.LC_TabContent li,
6734: ul.LC_TabContentBigger li {
1.911 bisitz 6735: float:left;
1.741 harmsja 6736: }
1.795 www 6737:
1.897 wenzelju 6738: ul#LC_secondary_menu li a {
1.911 bisitz 6739: color: $fontmenu;
6740: text-decoration: none;
1.693 droeschl 6741: }
1.795 www 6742:
1.721 harmsja 6743: ul.LC_TabContent {
1.952 onken 6744: min-height:20px;
1.721 harmsja 6745: }
1.795 www 6746:
6747: ul.LC_TabContent li {
1.911 bisitz 6748: vertical-align:middle;
1.959 onken 6749: padding: 0 16px 0 10px;
1.911 bisitz 6750: background-color:$tabbg;
6751: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 6752: border-left: solid 1px $font;
1.721 harmsja 6753: }
1.795 www 6754:
1.847 tempelho 6755: ul.LC_TabContent .right {
1.911 bisitz 6756: float:right;
1.847 tempelho 6757: }
6758:
1.911 bisitz 6759: ul.LC_TabContent li a,
6760: ul.LC_TabContent li {
6761: color:rgb(47,47,47);
6762: text-decoration:none;
6763: font-size:95%;
6764: font-weight:bold;
1.952 onken 6765: min-height:20px;
6766: }
6767:
1.959 onken 6768: ul.LC_TabContent li a:hover,
6769: ul.LC_TabContent li a:focus {
1.952 onken 6770: color: $button_hover;
1.959 onken 6771: background:none;
6772: outline:none;
1.952 onken 6773: }
6774:
6775: ul.LC_TabContent li:hover {
6776: color: $button_hover;
6777: cursor:pointer;
1.721 harmsja 6778: }
1.795 www 6779:
1.911 bisitz 6780: ul.LC_TabContent li.active {
1.952 onken 6781: color: $font;
1.911 bisitz 6782: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 6783: border-bottom:solid 1px #FFFFFF;
6784: cursor: default;
1.744 ehlerst 6785: }
1.795 www 6786:
1.959 onken 6787: ul.LC_TabContent li.active a {
6788: color:$font;
6789: background:#FFFFFF;
6790: outline: none;
6791: }
1.1047 raeburn 6792:
6793: ul.LC_TabContent li.goback {
6794: float: left;
6795: border-left: none;
6796: }
6797:
1.870 tempelho 6798: #maincoursedoc {
1.911 bisitz 6799: clear:both;
1.870 tempelho 6800: }
6801:
6802: ul.LC_TabContentBigger {
1.911 bisitz 6803: display:block;
6804: list-style:none;
6805: padding: 0;
1.870 tempelho 6806: }
6807:
1.795 www 6808: ul.LC_TabContentBigger li {
1.911 bisitz 6809: vertical-align:bottom;
6810: height: 30px;
6811: font-size:110%;
6812: font-weight:bold;
6813: color: #737373;
1.841 tempelho 6814: }
6815:
1.957 onken 6816: ul.LC_TabContentBigger li.active {
6817: position: relative;
6818: top: 1px;
6819: }
6820:
1.870 tempelho 6821: ul.LC_TabContentBigger li a {
1.911 bisitz 6822: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6823: height: 30px;
6824: line-height: 30px;
6825: text-align: center;
6826: display: block;
6827: text-decoration: none;
1.958 onken 6828: outline: none;
1.741 harmsja 6829: }
1.795 www 6830:
1.870 tempelho 6831: ul.LC_TabContentBigger li.active a {
1.911 bisitz 6832: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6833: color:$font;
1.744 ehlerst 6834: }
1.795 www 6835:
1.870 tempelho 6836: ul.LC_TabContentBigger li b {
1.911 bisitz 6837: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
6838: display: block;
6839: float: left;
6840: padding: 0 30px;
1.957 onken 6841: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 6842: }
6843:
1.956 onken 6844: ul.LC_TabContentBigger li:hover b {
6845: color:$button_hover;
6846: }
6847:
1.870 tempelho 6848: ul.LC_TabContentBigger li.active b {
1.911 bisitz 6849: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
6850: color:$font;
1.957 onken 6851: border: 0;
1.741 harmsja 6852: }
1.693 droeschl 6853:
1.870 tempelho 6854:
1.862 bisitz 6855: ul.LC_CourseBreadcrumbs {
6856: background: $sidebg;
1.1020 raeburn 6857: height: 2em;
1.862 bisitz 6858: padding-left: 10px;
1.1020 raeburn 6859: margin: 0;
1.862 bisitz 6860: list-style-position: inside;
6861: }
6862:
1.911 bisitz 6863: ol#LC_MenuBreadcrumbs,
1.862 bisitz 6864: ol#LC_PathBreadcrumbs {
1.911 bisitz 6865: padding-left: 10px;
6866: margin: 0;
1.933 droeschl 6867: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 6868: }
6869:
1.911 bisitz 6870: ol#LC_MenuBreadcrumbs li,
6871: ol#LC_PathBreadcrumbs li,
1.862 bisitz 6872: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 6873: display: inline;
1.933 droeschl 6874: white-space: normal;
1.693 droeschl 6875: }
6876:
1.823 bisitz 6877: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 6878: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 6879: text-decoration: none;
6880: font-size:90%;
1.693 droeschl 6881: }
1.795 www 6882:
1.969 droeschl 6883: ol#LC_MenuBreadcrumbs h1 {
6884: display: inline;
6885: font-size: 90%;
6886: line-height: 2.5em;
6887: margin: 0;
6888: padding: 0;
6889: }
6890:
1.795 www 6891: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 6892: text-decoration:none;
6893: font-size:100%;
6894: font-weight:bold;
1.693 droeschl 6895: }
1.795 www 6896:
1.840 bisitz 6897: .LC_Box {
1.911 bisitz 6898: border: solid 1px $lg_border_color;
6899: padding: 0 10px 10px 10px;
1.746 neumanie 6900: }
1.795 www 6901:
1.1020 raeburn 6902: .LC_DocsBox {
6903: border: solid 1px $lg_border_color;
6904: padding: 0 0 10px 10px;
6905: }
6906:
1.795 www 6907: .LC_AboutMe_Image {
1.911 bisitz 6908: float:left;
6909: margin-right:10px;
1.747 neumanie 6910: }
1.795 www 6911:
6912: .LC_Clear_AboutMe_Image {
1.911 bisitz 6913: clear:left;
1.747 neumanie 6914: }
1.795 www 6915:
1.721 harmsja 6916: dl.LC_ListStyleClean dt {
1.911 bisitz 6917: padding-right: 5px;
6918: display: table-header-group;
1.693 droeschl 6919: }
6920:
1.721 harmsja 6921: dl.LC_ListStyleClean dd {
1.911 bisitz 6922: display: table-row;
1.693 droeschl 6923: }
6924:
1.721 harmsja 6925: .LC_ListStyleClean,
6926: .LC_ListStyleSimple,
6927: .LC_ListStyleNormal,
1.795 www 6928: .LC_ListStyleSpecial {
1.911 bisitz 6929: /* display:block; */
6930: list-style-position: inside;
6931: list-style-type: none;
6932: overflow: hidden;
6933: padding: 0;
1.693 droeschl 6934: }
6935:
1.721 harmsja 6936: .LC_ListStyleSimple li,
6937: .LC_ListStyleSimple dd,
6938: .LC_ListStyleNormal li,
6939: .LC_ListStyleNormal dd,
6940: .LC_ListStyleSpecial li,
1.795 www 6941: .LC_ListStyleSpecial dd {
1.911 bisitz 6942: margin: 0;
6943: padding: 5px 5px 5px 10px;
6944: clear: both;
1.693 droeschl 6945: }
6946:
1.721 harmsja 6947: .LC_ListStyleClean li,
6948: .LC_ListStyleClean dd {
1.911 bisitz 6949: padding-top: 0;
6950: padding-bottom: 0;
1.693 droeschl 6951: }
6952:
1.721 harmsja 6953: .LC_ListStyleSimple dd,
1.795 www 6954: .LC_ListStyleSimple li {
1.911 bisitz 6955: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6956: }
6957:
1.721 harmsja 6958: .LC_ListStyleSpecial li,
6959: .LC_ListStyleSpecial dd {
1.911 bisitz 6960: list-style-type: none;
6961: background-color: RGB(220, 220, 220);
6962: margin-bottom: 4px;
1.693 droeschl 6963: }
6964:
1.721 harmsja 6965: table.LC_SimpleTable {
1.911 bisitz 6966: margin:5px;
6967: border:solid 1px $lg_border_color;
1.795 www 6968: }
1.693 droeschl 6969:
1.721 harmsja 6970: table.LC_SimpleTable tr {
1.911 bisitz 6971: padding: 0;
6972: border:solid 1px $lg_border_color;
1.693 droeschl 6973: }
1.795 www 6974:
6975: table.LC_SimpleTable thead {
1.911 bisitz 6976: background:rgb(220,220,220);
1.693 droeschl 6977: }
6978:
1.721 harmsja 6979: div.LC_columnSection {
1.911 bisitz 6980: display: block;
6981: clear: both;
6982: overflow: hidden;
6983: margin: 0;
1.693 droeschl 6984: }
6985:
1.721 harmsja 6986: div.LC_columnSection>* {
1.911 bisitz 6987: float: left;
6988: margin: 10px 20px 10px 0;
6989: overflow:hidden;
1.693 droeschl 6990: }
1.721 harmsja 6991:
1.795 www 6992: table em {
1.911 bisitz 6993: font-weight: bold;
6994: font-style: normal;
1.748 schulted 6995: }
1.795 www 6996:
1.779 bisitz 6997: table.LC_tableBrowseRes,
1.795 www 6998: table.LC_tableOfContent {
1.911 bisitz 6999: border:none;
7000: border-spacing: 1px;
7001: padding: 3px;
7002: background-color: #FFFFFF;
7003: font-size: 90%;
1.753 droeschl 7004: }
1.789 droeschl 7005:
1.911 bisitz 7006: table.LC_tableOfContent {
7007: border-collapse: collapse;
1.789 droeschl 7008: }
7009:
1.771 droeschl 7010: table.LC_tableBrowseRes a,
1.768 schulted 7011: table.LC_tableOfContent a {
1.911 bisitz 7012: background-color: transparent;
7013: text-decoration: none;
1.753 droeschl 7014: }
7015:
1.795 www 7016: table.LC_tableOfContent img {
1.911 bisitz 7017: border: none;
7018: height: 1.3em;
7019: vertical-align: text-bottom;
7020: margin-right: 0.3em;
1.753 droeschl 7021: }
1.757 schulted 7022:
1.795 www 7023: a#LC_content_toolbar_firsthomework {
1.911 bisitz 7024: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 7025: }
7026:
1.795 www 7027: a#LC_content_toolbar_everything {
1.911 bisitz 7028: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 7029: }
7030:
1.795 www 7031: a#LC_content_toolbar_uncompleted {
1.911 bisitz 7032: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 7033: }
7034:
1.795 www 7035: #LC_content_toolbar_clearbubbles {
1.911 bisitz 7036: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 7037: }
7038:
1.795 www 7039: a#LC_content_toolbar_changefolder {
1.911 bisitz 7040: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 7041: }
7042:
1.795 www 7043: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 7044: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 7045: }
7046:
1.1043 raeburn 7047: a#LC_content_toolbar_edittoplevel {
7048: background-image:url(/res/adm/pages/edittoplevel.gif);
7049: }
7050:
1.795 www 7051: ul#LC_toolbar li a:hover {
1.911 bisitz 7052: background-position: bottom center;
1.757 schulted 7053: }
7054:
1.795 www 7055: ul#LC_toolbar {
1.911 bisitz 7056: padding: 0;
7057: margin: 2px;
7058: list-style:none;
7059: position:relative;
7060: background-color:white;
1.1075.2.9 raeburn 7061: overflow: auto;
1.757 schulted 7062: }
7063:
1.795 www 7064: ul#LC_toolbar li {
1.911 bisitz 7065: border:1px solid white;
7066: padding: 0;
7067: margin: 0;
7068: float: left;
7069: display:inline;
7070: vertical-align:middle;
1.1075.2.9 raeburn 7071: white-space: nowrap;
1.911 bisitz 7072: }
1.757 schulted 7073:
1.783 amueller 7074:
1.795 www 7075: a.LC_toolbarItem {
1.911 bisitz 7076: display:block;
7077: padding: 0;
7078: margin: 0;
7079: height: 32px;
7080: width: 32px;
7081: color:white;
7082: border: none;
7083: background-repeat:no-repeat;
7084: background-color:transparent;
1.757 schulted 7085: }
7086:
1.915 droeschl 7087: ul.LC_funclist {
7088: margin: 0;
7089: padding: 0.5em 1em 0.5em 0;
7090: }
7091:
1.933 droeschl 7092: ul.LC_funclist > li:first-child {
7093: font-weight:bold;
7094: margin-left:0.8em;
7095: }
7096:
1.915 droeschl 7097: ul.LC_funclist + ul.LC_funclist {
7098: /*
7099: left border as a seperator if we have more than
7100: one list
7101: */
7102: border-left: 1px solid $sidebg;
7103: /*
7104: this hides the left border behind the border of the
7105: outer box if element is wrapped to the next 'line'
7106: */
7107: margin-left: -1px;
7108: }
7109:
1.843 bisitz 7110: ul.LC_funclist li {
1.915 droeschl 7111: display: inline;
1.782 bisitz 7112: white-space: nowrap;
1.915 droeschl 7113: margin: 0 0 0 25px;
7114: line-height: 150%;
1.782 bisitz 7115: }
7116:
1.974 wenzelju 7117: .LC_hidden {
7118: display: none;
7119: }
7120:
1.1030 www 7121: .LCmodal-overlay {
7122: position:fixed;
7123: top:0;
7124: right:0;
7125: bottom:0;
7126: left:0;
7127: height:100%;
7128: width:100%;
7129: margin:0;
7130: padding:0;
7131: background:#999;
7132: opacity:.75;
7133: filter: alpha(opacity=75);
7134: -moz-opacity: 0.75;
7135: z-index:101;
7136: }
7137:
7138: * html .LCmodal-overlay {
7139: position: absolute;
7140: height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
7141: }
7142:
7143: .LCmodal-window {
7144: position:fixed;
7145: top:50%;
7146: left:50%;
7147: margin:0;
7148: padding:0;
7149: z-index:102;
7150: }
7151:
7152: * html .LCmodal-window {
7153: position:absolute;
7154: }
7155:
7156: .LCclose-window {
7157: position:absolute;
7158: width:32px;
7159: height:32px;
7160: right:8px;
7161: top:8px;
7162: background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
7163: text-indent:-99999px;
7164: overflow:hidden;
7165: cursor:pointer;
7166: }
7167:
1.1075.2.17 raeburn 7168: /*
7169: styles used by TTH when "Default set of options to pass to tth/m
7170: when converting TeX" in course settings has been set
7171:
7172: option passed: -t
7173:
7174: */
7175:
7176: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
7177: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
7178: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
7179: td div.norm {line-height:normal;}
7180:
7181: /*
7182: option passed -y3
7183: */
7184:
7185: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
7186: span.overacc2 {position: relative; left: .8em; top: -1.2ex;}
7187: span.overacc1 {position: relative; left: .6em; top: -1.2ex;}
7188:
1.343 albertel 7189: END
7190: }
7191:
1.306 albertel 7192: =pod
7193:
7194: =item * &headtag()
7195:
7196: Returns a uniform footer for LON-CAPA web pages.
7197:
1.307 albertel 7198: Inputs: $title - optional title for the head
7199: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 7200: $args - optional arguments
1.319 albertel 7201: force_register - if is true call registerurl so the remote is
7202: informed
1.415 albertel 7203: redirect -> array ref of
7204: 1- seconds before redirect occurs
7205: 2- url to redirect to
7206: 3- whether the side effect should occur
1.315 albertel 7207: (side effect of setting
7208: $env{'internal.head.redirect'} to the url
7209: redirected too)
1.352 albertel 7210: domain -> force to color decorate a page for a specific
7211: domain
7212: function -> force usage of a specific rolish color scheme
7213: bgcolor -> override the default page bgcolor
1.460 albertel 7214: no_auto_mt_title
7215: -> prevent &mt()ing the title arg
1.464 albertel 7216:
1.306 albertel 7217: =cut
7218:
7219: sub headtag {
1.313 albertel 7220: my ($title,$head_extra,$args) = @_;
1.306 albertel 7221:
1.363 albertel 7222: my $function = $args->{'function'} || &get_users_function();
7223: my $domain = $args->{'domain'} || &determinedomain();
7224: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 7225: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 7226: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 7227: #time(),
1.418 albertel 7228: $env{'environment.color.timestamp'},
1.363 albertel 7229: $function,$domain,$bgcolor);
7230:
1.369 www 7231: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 7232:
1.308 albertel 7233: my $result =
7234: '<head>'.
1.461 albertel 7235: &font_settings();
1.319 albertel 7236:
1.1064 raeburn 7237: my $inhibitprint = &print_suppression();
7238:
1.461 albertel 7239: if (!$args->{'frameset'}) {
7240: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
7241: }
1.1075.2.12 raeburn 7242: if ($args->{'force_register'}) {
7243: $result .= &Apache::lonmenu::registerurl(1);
1.319 albertel 7244: }
1.436 albertel 7245: if (!$args->{'no_nav_bar'}
7246: && !$args->{'only_body'}
7247: && !$args->{'frameset'}) {
7248: $result .= &help_menu_js();
1.1032 www 7249: $result.=&modal_window();
1.1038 www 7250: $result.=&togglebox_script();
1.1034 www 7251: $result.=&wishlist_window();
1.1041 www 7252: $result.=&LCprogressbarUpdate_script();
1.1034 www 7253: } else {
7254: if ($args->{'add_modal'}) {
7255: $result.=&modal_window();
7256: }
7257: if ($args->{'add_wishlist'}) {
7258: $result.=&wishlist_window();
7259: }
1.1038 www 7260: if ($args->{'add_togglebox'}) {
7261: $result.=&togglebox_script();
7262: }
1.1041 www 7263: if ($args->{'add_progressbar'}) {
7264: $result.=&LCprogressbarUpdate_script();
7265: }
1.436 albertel 7266: }
1.314 albertel 7267: if (ref($args->{'redirect'})) {
1.414 albertel 7268: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 7269: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 7270: if (!$inhibit_continue) {
7271: $env{'internal.head.redirect'} = $url;
7272: }
1.313 albertel 7273: $result.=<<ADDMETA
7274: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 7275: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 7276: ADDMETA
7277: }
1.306 albertel 7278: if (!defined($title)) {
7279: $title = 'The LearningOnline Network with CAPA';
7280: }
1.460 albertel 7281: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
7282: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 7283: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
1.1064 raeburn 7284: .$inhibitprint
1.414 albertel 7285: .$head_extra;
1.962 droeschl 7286: return $result.'</head>';
1.306 albertel 7287: }
7288:
7289: =pod
7290:
1.340 albertel 7291: =item * &font_settings()
7292:
7293: Returns neccessary <meta> to set the proper encoding
7294:
7295: Inputs: none
7296:
7297: =cut
7298:
7299: sub font_settings {
7300: my $headerstring='';
1.647 www 7301: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 7302: $headerstring.=
7303: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
7304: }
7305: return $headerstring;
7306: }
7307:
1.341 albertel 7308: =pod
7309:
1.1064 raeburn 7310: =item * &print_suppression()
7311:
7312: In course context returns css which causes the body to be blank when media="print",
7313: if printout generation is unavailable for the current resource.
7314:
7315: This could be because:
7316:
7317: (a) printstartdate is in the future
7318:
7319: (b) printenddate is in the past
7320:
7321: (c) there is an active exam block with "printout"
7322: functionality blocked
7323:
7324: Users with pav, pfo or evb privileges are exempt.
7325:
7326: Inputs: none
7327:
7328: =cut
7329:
7330:
7331: sub print_suppression {
7332: my $noprint;
7333: if ($env{'request.course.id'}) {
7334: my $scope = $env{'request.course.id'};
7335: if ((&Apache::lonnet::allowed('pav',$scope)) ||
7336: (&Apache::lonnet::allowed('pfo',$scope))) {
7337: return;
7338: }
7339: if ($env{'request.course.sec'} ne '') {
7340: $scope .= "/$env{'request.course.sec'}";
7341: if ((&Apache::lonnet::allowed('pav',$scope)) ||
7342: (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065 raeburn 7343: return;
1.1064 raeburn 7344: }
7345: }
7346: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7347: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1065 raeburn 7348: my $blocked = &blocking_status('printout',$cnum,$cdom);
1.1064 raeburn 7349: if ($blocked) {
7350: my $checkrole = "cm./$cdom/$cnum";
7351: if ($env{'request.course.sec'} ne '') {
7352: $checkrole .= "/$env{'request.course.sec'}";
7353: }
7354: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
7355: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
7356: $noprint = 1;
7357: }
7358: }
7359: unless ($noprint) {
7360: my $symb = &Apache::lonnet::symbread();
7361: if ($symb ne '') {
7362: my $navmap = Apache::lonnavmaps::navmap->new();
7363: if (ref($navmap)) {
7364: my $res = $navmap->getBySymb($symb);
7365: if (ref($res)) {
7366: if (!$res->resprintable()) {
7367: $noprint = 1;
7368: }
7369: }
7370: }
7371: }
7372: }
7373: if ($noprint) {
7374: return <<"ENDSTYLE";
7375: <style type="text/css" media="print">
7376: body { display:none }
7377: </style>
7378: ENDSTYLE
7379: }
7380: }
7381: return;
7382: }
7383:
7384: =pod
7385:
1.341 albertel 7386: =item * &xml_begin()
7387:
7388: Returns the needed doctype and <html>
7389:
7390: Inputs: none
7391:
7392: =cut
7393:
7394: sub xml_begin {
7395: my $output='';
7396:
7397: if ($env{'browser.mathml'}) {
7398: $output='<?xml version="1.0"?>'
7399: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
7400: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
7401:
7402: # .'<!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">] >'
7403: .'<!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">'
7404: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
7405: .'xmlns="http://www.w3.org/1999/xhtml">';
7406: } else {
1.849 bisitz 7407: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
7408: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341 albertel 7409: }
7410: return $output;
7411: }
1.340 albertel 7412:
7413: =pod
7414:
1.306 albertel 7415: =item * &start_page()
7416:
7417: Returns a complete <html> .. <body> section for LON-CAPA web pages.
7418:
1.648 raeburn 7419: Inputs:
7420:
7421: =over 4
7422:
7423: $title - optional title for the page
7424:
7425: $head_extra - optional extra HTML to incude inside the <head>
7426:
7427: $args - additional optional args supported are:
7428:
7429: =over 8
7430:
7431: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 7432: arg on
1.814 bisitz 7433: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 7434: add_entries -> additional attributes to add to the <body>
7435: domain -> force to color decorate a page for a
1.317 albertel 7436: specific domain
1.648 raeburn 7437: function -> force usage of a specific rolish color
1.317 albertel 7438: scheme
1.648 raeburn 7439: redirect -> see &headtag()
7440: bgcolor -> override the default page bg color
7441: js_ready -> return a string ready for being used in
1.317 albertel 7442: a javascript writeln
1.648 raeburn 7443: html_encode -> return a string ready for being used in
1.320 albertel 7444: a html attribute
1.648 raeburn 7445: force_register -> if is true will turn on the &bodytag()
1.317 albertel 7446: $forcereg arg
1.648 raeburn 7447: frameset -> if true will start with a <frameset>
1.330 albertel 7448: rather than <body>
1.648 raeburn 7449: skip_phases -> hash ref of
1.338 albertel 7450: head -> skip the <html><head> generation
7451: body -> skip all <body> generation
1.1075.2.12 raeburn 7452: no_inline_link -> if true and in remote mode, don't show the
7453: 'Switch To Inline Menu' link
1.648 raeburn 7454: no_auto_mt_title -> prevent &mt()ing the title arg
7455: inherit_jsmath -> when creating popup window in a page,
7456: should it have jsmath forced on by the
7457: current page
1.867 kalberla 7458: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 7459: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.1075.2.15 raeburn 7460: group -> includes the current group, if page is for a
7461: specific group
1.361 albertel 7462:
1.648 raeburn 7463: =back
1.460 albertel 7464:
1.648 raeburn 7465: =back
1.562 albertel 7466:
1.306 albertel 7467: =cut
7468:
7469: sub start_page {
1.309 albertel 7470: my ($title,$head_extra,$args) = @_;
1.318 albertel 7471: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319 albertel 7472:
1.315 albertel 7473: $env{'internal.start_page'}++;
1.1075.2.15 raeburn 7474: my ($result,@advtools);
1.964 droeschl 7475:
1.338 albertel 7476: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1030 www 7477: $result .= &xml_begin() . &headtag($title, $head_extra, $args);
1.338 albertel 7478: }
7479:
7480: if (! exists($args->{'skip_phases'}{'body'}) ) {
7481: if ($args->{'frameset'}) {
7482: my $attr_string = &make_attr_string($args->{'force_register'},
7483: $args->{'add_entries'});
7484: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 7485: } else {
7486: $result .=
7487: &bodytag($title,
7488: $args->{'function'}, $args->{'add_entries'},
7489: $args->{'only_body'}, $args->{'domain'},
7490: $args->{'force_register'}, $args->{'no_nav_bar'},
1.1075.2.12 raeburn 7491: $args->{'bgcolor'}, $args->{'no_inline_link'},
1.1075.2.15 raeburn 7492: $args, \@advtools);
1.831 bisitz 7493: }
1.330 albertel 7494: }
1.338 albertel 7495:
1.315 albertel 7496: if ($args->{'js_ready'}) {
1.713 kaisler 7497: $result = &js_ready($result);
1.315 albertel 7498: }
1.320 albertel 7499: if ($args->{'html_encode'}) {
1.713 kaisler 7500: $result = &html_encode($result);
7501: }
7502:
1.813 bisitz 7503: # Preparation for new and consistent functionlist at top of screen
7504: # if ($args->{'functionlist'}) {
7505: # $result .= &build_functionlist();
7506: #}
7507:
1.964 droeschl 7508: # Don't add anything more if only_body wanted or in const space
7509: return $result if $args->{'only_body'}
7510: || $env{'request.state'} eq 'construct';
1.813 bisitz 7511:
7512: #Breadcrumbs
1.758 kaisler 7513: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
7514: &Apache::lonhtmlcommon::clear_breadcrumbs();
7515: #if any br links exists, add them to the breadcrumbs
7516: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
7517: foreach my $crumb (@{$args->{'bread_crumbs'}}){
7518: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
7519: }
7520: }
1.1075.2.19 raeburn 7521: # if @advtools array contains items add then to the breadcrumbs
7522: if (@advtools > 0) {
7523: &Apache::lonmenu::advtools_crumbs(@advtools);
7524: }
1.758 kaisler 7525:
7526: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
7527: if(exists($args->{'bread_crumbs_component'})){
7528: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
7529: }else{
7530: $result .= &Apache::lonhtmlcommon::breadcrumbs();
7531: }
1.1075.2.24 raeburn 7532: } elsif (($env{'environment.remote'} eq 'on') &&
7533: ($env{'form.inhibitmenu'} ne 'yes') &&
7534: ($env{'request.noversionuri'} =~ m{^/res/}) &&
7535: ($env{'request.noversionuri'} !~ m{^/res/adm/pages/})) {
1.1075.2.21 raeburn 7536: $result .= '<div style="padding:0;margin:0;clear:both"><hr /></div>';
1.320 albertel 7537: }
1.315 albertel 7538: return $result;
1.306 albertel 7539: }
7540:
7541: sub end_page {
1.315 albertel 7542: my ($args) = @_;
7543: $env{'internal.end_page'}++;
1.330 albertel 7544: my $result;
1.335 albertel 7545: if ($args->{'discussion'}) {
7546: my ($target,$parser);
7547: if (ref($args->{'discussion'})) {
7548: ($target,$parser) =($args->{'discussion'}{'target'},
7549: $args->{'discussion'}{'parser'});
7550: }
7551: $result .= &Apache::lonxml::xmlend($target,$parser);
7552: }
1.330 albertel 7553: if ($args->{'frameset'}) {
7554: $result .= '</frameset>';
7555: } else {
1.635 raeburn 7556: $result .= &endbodytag($args);
1.330 albertel 7557: }
1.1075.2.6 raeburn 7558: unless ($args->{'notbody'}) {
7559: $result .= "\n</html>";
7560: }
1.330 albertel 7561:
1.315 albertel 7562: if ($args->{'js_ready'}) {
1.317 albertel 7563: $result = &js_ready($result);
1.315 albertel 7564: }
1.335 albertel 7565:
1.320 albertel 7566: if ($args->{'html_encode'}) {
7567: $result = &html_encode($result);
7568: }
1.335 albertel 7569:
1.315 albertel 7570: return $result;
7571: }
7572:
1.1034 www 7573: sub wishlist_window {
7574: return(<<'ENDWISHLIST');
1.1046 raeburn 7575: <script type="text/javascript">
1.1034 www 7576: // <![CDATA[
7577: // <!-- BEGIN LON-CAPA Internal
7578: function set_wishlistlink(title, path) {
7579: if (!title) {
7580: title = document.title;
7581: title = title.replace(/^LON-CAPA /,'');
7582: }
7583: if (!path) {
7584: path = location.pathname;
7585: }
7586: Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
7587: 'wishlistNewLink','width=560,height=350,scrollbars=0');
7588: }
7589: // END LON-CAPA Internal -->
7590: // ]]>
7591: </script>
7592: ENDWISHLIST
7593: }
7594:
1.1030 www 7595: sub modal_window {
7596: return(<<'ENDMODAL');
1.1046 raeburn 7597: <script type="text/javascript">
1.1030 www 7598: // <![CDATA[
7599: // <!-- BEGIN LON-CAPA Internal
7600: var modalWindow = {
7601: parent:"body",
7602: windowId:null,
7603: content:null,
7604: width:null,
7605: height:null,
7606: close:function()
7607: {
7608: $(".LCmodal-window").remove();
7609: $(".LCmodal-overlay").remove();
7610: },
7611: open:function()
7612: {
7613: var modal = "";
7614: modal += "<div class=\"LCmodal-overlay\"></div>";
7615: 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;\">";
7616: modal += this.content;
7617: modal += "</div>";
7618:
7619: $(this.parent).append(modal);
7620:
7621: $(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
7622: $(".LCclose-window").click(function(){modalWindow.close();});
7623: $(".LCmodal-overlay").click(function(){modalWindow.close();});
7624: }
7625: };
1.1031 www 7626: var openMyModal = function(source,width,height,scrolling)
1.1030 www 7627: {
7628: modalWindow.windowId = "myModal";
7629: modalWindow.width = width;
7630: modalWindow.height = height;
1.1031 www 7631: modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='true' src='" + source + "'></iframe>";
1.1030 www 7632: modalWindow.open();
7633: };
7634: // END LON-CAPA Internal -->
7635: // ]]>
7636: </script>
7637: ENDMODAL
7638: }
7639:
7640: sub modal_link {
1.1052 www 7641: my ($link,$linktext,$width,$height,$target,$scrolling,$title)=@_;
1.1030 www 7642: unless ($width) { $width=480; }
7643: unless ($height) { $height=400; }
1.1031 www 7644: unless ($scrolling) { $scrolling='yes'; }
1.1074 raeburn 7645: my $target_attr;
7646: if (defined($target)) {
7647: $target_attr = 'target="'.$target.'"';
7648: }
7649: return <<"ENDLINK";
7650: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling'); return false;">
7651: $linktext</a>
7652: ENDLINK
1.1030 www 7653: }
7654:
1.1032 www 7655: sub modal_adhoc_script {
7656: my ($funcname,$width,$height,$content)=@_;
7657: return (<<ENDADHOC);
1.1046 raeburn 7658: <script type="text/javascript">
1.1032 www 7659: // <![CDATA[
7660: var $funcname = function()
7661: {
7662: modalWindow.windowId = "myModal";
7663: modalWindow.width = $width;
7664: modalWindow.height = $height;
7665: modalWindow.content = '$content';
7666: modalWindow.open();
7667: };
7668: // ]]>
7669: </script>
7670: ENDADHOC
7671: }
7672:
1.1041 www 7673: sub modal_adhoc_inner {
7674: my ($funcname,$width,$height,$content)=@_;
7675: my $innerwidth=$width-20;
7676: $content=&js_ready(
1.1042 www 7677: &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
1.1041 www 7678: &start_scrollbox($width.'px',$innerwidth.'px',$height.'px').
7679: $content.
7680: &end_scrollbox().
7681: &end_page()
7682: );
7683: return &modal_adhoc_script($funcname,$width,$height,$content);
7684: }
7685:
7686: sub modal_adhoc_window {
7687: my ($funcname,$width,$height,$content,$linktext)=@_;
7688: return &modal_adhoc_inner($funcname,$width,$height,$content).
7689: "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
7690: }
7691:
7692: sub modal_adhoc_launch {
7693: my ($funcname,$width,$height,$content)=@_;
7694: return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
7695: <script type="text/javascript">
7696: // <![CDATA[
7697: $funcname();
7698: // ]]>
7699: </script>
7700: ENDLAUNCH
7701: }
7702:
7703: sub modal_adhoc_close {
7704: return (<<ENDCLOSE);
7705: <script type="text/javascript">
7706: // <![CDATA[
7707: modalWindow.close();
7708: // ]]>
7709: </script>
7710: ENDCLOSE
7711: }
7712:
1.1038 www 7713: sub togglebox_script {
7714: return(<<ENDTOGGLE);
7715: <script type="text/javascript">
7716: // <![CDATA[
7717: function LCtoggleDisplay(id,hidetext,showtext) {
7718: link = document.getElementById(id + "link").childNodes[0];
7719: with (document.getElementById(id).style) {
7720: if (display == "none" ) {
7721: display = "inline";
7722: link.nodeValue = hidetext;
7723: } else {
7724: display = "none";
7725: link.nodeValue = showtext;
7726: }
7727: }
7728: }
7729: // ]]>
7730: </script>
7731: ENDTOGGLE
7732: }
7733:
1.1039 www 7734: sub start_togglebox {
7735: my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
7736: unless ($heading) { $heading=''; } else { $heading.=' '; }
7737: unless ($showtext) { $showtext=&mt('show'); }
7738: unless ($hidetext) { $hidetext=&mt('hide'); }
7739: unless ($headerbg) { $headerbg='#FFFFFF'; }
7740: return &start_data_table().
7741: &start_data_table_header_row().
7742: '<td bgcolor="'.$headerbg.'">'.$heading.
7743: '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
7744: $showtext.'\')">'.$showtext.'</a>]</td>'.
7745: &end_data_table_header_row().
7746: '<tr id="'.$id.'" style="display:none""><td>';
7747: }
7748:
7749: sub end_togglebox {
7750: return '</td></tr>'.&end_data_table();
7751: }
7752:
1.1041 www 7753: sub LCprogressbar_script {
1.1045 www 7754: my ($id)=@_;
1.1041 www 7755: return(<<ENDPROGRESS);
7756: <script type="text/javascript">
7757: // <![CDATA[
1.1045 www 7758: \$('#progressbar$id').progressbar({
1.1041 www 7759: value: 0,
7760: change: function(event, ui) {
7761: var newVal = \$(this).progressbar('option', 'value');
7762: \$('.pblabel', this).text(LCprogressTxt);
7763: }
7764: });
7765: // ]]>
7766: </script>
7767: ENDPROGRESS
7768: }
7769:
7770: sub LCprogressbarUpdate_script {
7771: return(<<ENDPROGRESSUPDATE);
7772: <style type="text/css">
7773: .ui-progressbar { position:relative; }
7774: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
7775: </style>
7776: <script type="text/javascript">
7777: // <![CDATA[
1.1045 www 7778: var LCprogressTxt='---';
7779:
7780: function LCupdateProgress(percent,progresstext,id) {
1.1041 www 7781: LCprogressTxt=progresstext;
1.1045 www 7782: \$('#progressbar'+id).progressbar('value',percent);
1.1041 www 7783: }
7784: // ]]>
7785: </script>
7786: ENDPROGRESSUPDATE
7787: }
7788:
1.1042 www 7789: my $LClastpercent;
1.1045 www 7790: my $LCidcnt;
7791: my $LCcurrentid;
1.1042 www 7792:
1.1041 www 7793: sub LCprogressbar {
1.1042 www 7794: my ($r)=(@_);
7795: $LClastpercent=0;
1.1045 www 7796: $LCidcnt++;
7797: $LCcurrentid=$$.'_'.$LCidcnt;
1.1041 www 7798: my $starting=&mt('Starting');
7799: my $content=(<<ENDPROGBAR);
1.1045 www 7800: <div id="progressbar$LCcurrentid">
1.1041 www 7801: <span class="pblabel">$starting</span>
7802: </div>
7803: ENDPROGBAR
1.1045 www 7804: &r_print($r,$content.&LCprogressbar_script($LCcurrentid));
1.1041 www 7805: }
7806:
7807: sub LCprogressbarUpdate {
1.1042 www 7808: my ($r,$val,$text)=@_;
7809: unless ($val) {
7810: if ($LClastpercent) {
7811: $val=$LClastpercent;
7812: } else {
7813: $val=0;
7814: }
7815: }
1.1041 www 7816: if ($val<0) { $val=0; }
7817: if ($val>100) { $val=0; }
1.1042 www 7818: $LClastpercent=$val;
1.1041 www 7819: unless ($text) { $text=$val.'%'; }
7820: $text=&js_ready($text);
1.1044 www 7821: &r_print($r,<<ENDUPDATE);
1.1041 www 7822: <script type="text/javascript">
7823: // <![CDATA[
1.1045 www 7824: LCupdateProgress($val,'$text','$LCcurrentid');
1.1041 www 7825: // ]]>
7826: </script>
7827: ENDUPDATE
1.1035 www 7828: }
7829:
1.1042 www 7830: sub LCprogressbarClose {
7831: my ($r)=@_;
7832: $LClastpercent=0;
1.1044 www 7833: &r_print($r,<<ENDCLOSE);
1.1042 www 7834: <script type="text/javascript">
7835: // <![CDATA[
1.1045 www 7836: \$("#progressbar$LCcurrentid").hide('slow');
1.1042 www 7837: // ]]>
7838: </script>
7839: ENDCLOSE
1.1044 www 7840: }
7841:
7842: sub r_print {
7843: my ($r,$to_print)=@_;
7844: if ($r) {
7845: $r->print($to_print);
7846: $r->rflush();
7847: } else {
7848: print($to_print);
7849: }
1.1042 www 7850: }
7851:
1.320 albertel 7852: sub html_encode {
7853: my ($result) = @_;
7854:
1.322 albertel 7855: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 7856:
7857: return $result;
7858: }
1.1044 www 7859:
1.317 albertel 7860: sub js_ready {
7861: my ($result) = @_;
7862:
1.323 albertel 7863: $result =~ s/[\n\r]/ /xmsg;
7864: $result =~ s/\\/\\\\/xmsg;
7865: $result =~ s/'/\\'/xmsg;
1.372 albertel 7866: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 7867:
7868: return $result;
7869: }
7870:
1.315 albertel 7871: sub validate_page {
7872: if ( exists($env{'internal.start_page'})
1.316 albertel 7873: && $env{'internal.start_page'} > 1) {
7874: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 7875: $env{'internal.start_page'}.' '.
1.316 albertel 7876: $ENV{'request.filename'});
1.315 albertel 7877: }
7878: if ( exists($env{'internal.end_page'})
1.316 albertel 7879: && $env{'internal.end_page'} > 1) {
7880: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 7881: $env{'internal.end_page'}.' '.
1.316 albertel 7882: $env{'request.filename'});
1.315 albertel 7883: }
7884: if ( exists($env{'internal.start_page'})
7885: && ! exists($env{'internal.end_page'})) {
1.316 albertel 7886: &Apache::lonnet::logthis('start_page called without end_page '.
7887: $env{'request.filename'});
1.315 albertel 7888: }
7889: if ( ! exists($env{'internal.start_page'})
7890: && exists($env{'internal.end_page'})) {
1.316 albertel 7891: &Apache::lonnet::logthis('end_page called without start_page'.
7892: $env{'request.filename'});
1.315 albertel 7893: }
1.306 albertel 7894: }
1.315 albertel 7895:
1.996 www 7896:
7897: sub start_scrollbox {
1.1075 raeburn 7898: my ($outerwidth,$width,$height,$id,$bgcolor)=@_;
1.998 raeburn 7899: unless ($outerwidth) { $outerwidth='520px'; }
7900: unless ($width) { $width='500px'; }
7901: unless ($height) { $height='200px'; }
1.1075 raeburn 7902: my ($table_id,$div_id,$tdcol);
1.1018 raeburn 7903: if ($id ne '') {
1.1020 raeburn 7904: $table_id = " id='table_$id'";
7905: $div_id = " id='div_$id'";
1.1018 raeburn 7906: }
1.1075 raeburn 7907: if ($bgcolor ne '') {
7908: $tdcol = "background-color: $bgcolor;";
7909: }
7910: return <<"END";
7911: <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>
7912: END
1.996 www 7913: }
7914:
7915: sub end_scrollbox {
1.1036 www 7916: return '</div></td></tr></table>';
1.996 www 7917: }
7918:
1.318 albertel 7919: sub simple_error_page {
7920: my ($r,$title,$msg) = @_;
7921: my $page =
7922: &Apache::loncommon::start_page($title).
1.1075.2.15 raeburn 7923: '<p class="LC_error">'.&mt($msg).'</p>'.
1.318 albertel 7924: &Apache::loncommon::end_page();
7925: if (ref($r)) {
7926: $r->print($page);
1.327 albertel 7927: return;
1.318 albertel 7928: }
7929: return $page;
7930: }
1.347 albertel 7931:
7932: {
1.610 albertel 7933: my @row_count;
1.961 onken 7934:
7935: sub start_data_table_count {
7936: unshift(@row_count, 0);
7937: return;
7938: }
7939:
7940: sub end_data_table_count {
7941: shift(@row_count);
7942: return;
7943: }
7944:
1.347 albertel 7945: sub start_data_table {
1.1018 raeburn 7946: my ($add_class,$id) = @_;
1.422 albertel 7947: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 7948: my $table_id;
7949: if (defined($id)) {
7950: $table_id = ' id="'.$id.'"';
7951: }
1.961 onken 7952: &start_data_table_count();
1.1018 raeburn 7953: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 7954: }
7955:
7956: sub end_data_table {
1.961 onken 7957: &end_data_table_count();
1.389 albertel 7958: return '</table>'."\n";;
1.347 albertel 7959: }
7960:
7961: sub start_data_table_row {
1.974 wenzelju 7962: my ($add_class, $id) = @_;
1.610 albertel 7963: $row_count[0]++;
7964: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 7965: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 7966: $id = (' id="'.$id.'"') unless ($id eq '');
7967: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 7968: }
1.471 banghart 7969:
7970: sub continue_data_table_row {
1.974 wenzelju 7971: my ($add_class, $id) = @_;
1.610 albertel 7972: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 7973: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
7974: $id = (' id="'.$id.'"') unless ($id eq '');
7975: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 7976: }
1.347 albertel 7977:
7978: sub end_data_table_row {
1.389 albertel 7979: return '</tr>'."\n";;
1.347 albertel 7980: }
1.367 www 7981:
1.421 albertel 7982: sub start_data_table_empty_row {
1.707 bisitz 7983: # $row_count[0]++;
1.421 albertel 7984: return '<tr class="LC_empty_row" >'."\n";;
7985: }
7986:
7987: sub end_data_table_empty_row {
7988: return '</tr>'."\n";;
7989: }
7990:
1.367 www 7991: sub start_data_table_header_row {
1.389 albertel 7992: return '<tr class="LC_header_row">'."\n";;
1.367 www 7993: }
7994:
7995: sub end_data_table_header_row {
1.389 albertel 7996: return '</tr>'."\n";;
1.367 www 7997: }
1.890 droeschl 7998:
7999: sub data_table_caption {
8000: my $caption = shift;
8001: return "<caption class=\"LC_caption\">$caption</caption>";
8002: }
1.347 albertel 8003: }
8004:
1.548 albertel 8005: =pod
8006:
8007: =item * &inhibit_menu_check($arg)
8008:
8009: Checks for a inhibitmenu state and generates output to preserve it
8010:
8011: Inputs: $arg - can be any of
8012: - undef - in which case the return value is a string
8013: to add into arguments list of a uri
8014: - 'input' - in which case the return value is a HTML
8015: <form> <input> field of type hidden to
8016: preserve the value
8017: - a url - in which case the return value is the url with
8018: the neccesary cgi args added to preserve the
8019: inhibitmenu state
8020: - a ref to a url - no return value, but the string is
8021: updated to include the neccessary cgi
8022: args to preserve the inhibitmenu state
8023:
8024: =cut
8025:
8026: sub inhibit_menu_check {
8027: my ($arg) = @_;
8028: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
8029: if ($arg eq 'input') {
8030: if ($env{'form.inhibitmenu'}) {
8031: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
8032: } else {
8033: return
8034: }
8035: }
8036: if ($env{'form.inhibitmenu'}) {
8037: if (ref($arg)) {
8038: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
8039: } elsif ($arg eq '') {
8040: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
8041: } else {
8042: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
8043: }
8044: }
8045: if (!ref($arg)) {
8046: return $arg;
8047: }
8048: }
8049:
1.251 albertel 8050: ###############################################
1.182 matthew 8051:
8052: =pod
8053:
1.549 albertel 8054: =back
8055:
8056: =head1 User Information Routines
8057:
8058: =over 4
8059:
1.405 albertel 8060: =item * &get_users_function()
1.182 matthew 8061:
8062: Used by &bodytag to determine the current users primary role.
8063: Returns either 'student','coordinator','admin', or 'author'.
8064:
8065: =cut
8066:
8067: ###############################################
8068: sub get_users_function {
1.815 tempelho 8069: my $function = 'norole';
1.818 tempelho 8070: if ($env{'request.role'}=~/^(st)/) {
8071: $function='student';
8072: }
1.907 raeburn 8073: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 8074: $function='coordinator';
8075: }
1.258 albertel 8076: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 8077: $function='admin';
8078: }
1.826 bisitz 8079: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025 raeburn 8080: ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182 matthew 8081: $function='author';
8082: }
8083: return $function;
1.54 www 8084: }
1.99 www 8085:
8086: ###############################################
8087:
1.233 raeburn 8088: =pod
8089:
1.821 raeburn 8090: =item * &show_course()
8091:
8092: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
8093: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
8094:
8095: Inputs:
8096: None
8097:
8098: Outputs:
8099: Scalar: 1 if 'Course' to be used, 0 otherwise.
8100:
8101: =cut
8102:
8103: ###############################################
8104: sub show_course {
8105: my $course = !$env{'user.adv'};
8106: if (!$env{'user.adv'}) {
8107: foreach my $env (keys(%env)) {
8108: next if ($env !~ m/^user\.priv\./);
8109: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
8110: $course = 0;
8111: last;
8112: }
8113: }
8114: }
8115: return $course;
8116: }
8117:
8118: ###############################################
8119:
8120: =pod
8121:
1.542 raeburn 8122: =item * &check_user_status()
1.274 raeburn 8123:
8124: Determines current status of supplied role for a
8125: specific user. Roles can be active, previous or future.
8126:
8127: Inputs:
8128: user's domain, user's username, course's domain,
1.375 raeburn 8129: course's number, optional section ID.
1.274 raeburn 8130:
8131: Outputs:
8132: role status: active, previous or future.
8133:
8134: =cut
8135:
8136: sub check_user_status {
1.412 raeburn 8137: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073 raeburn 8138: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.274 raeburn 8139: my @uroles = keys %userinfo;
8140: my $srchstr;
8141: my $active_chk = 'none';
1.412 raeburn 8142: my $now = time;
1.274 raeburn 8143: if (@uroles > 0) {
1.908 raeburn 8144: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 8145: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
8146: } else {
1.412 raeburn 8147: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
8148: }
8149: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 8150: my $role_end = 0;
8151: my $role_start = 0;
8152: $active_chk = 'active';
1.412 raeburn 8153: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
8154: $role_end = $1;
8155: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
8156: $role_start = $1;
1.274 raeburn 8157: }
8158: }
8159: if ($role_start > 0) {
1.412 raeburn 8160: if ($now < $role_start) {
1.274 raeburn 8161: $active_chk = 'future';
8162: }
8163: }
8164: if ($role_end > 0) {
1.412 raeburn 8165: if ($now > $role_end) {
1.274 raeburn 8166: $active_chk = 'previous';
8167: }
8168: }
8169: }
8170: }
8171: return $active_chk;
8172: }
8173:
8174: ###############################################
8175:
8176: =pod
8177:
1.405 albertel 8178: =item * &get_sections()
1.233 raeburn 8179:
8180: Determines all the sections for a course including
8181: sections with students and sections containing other roles.
1.419 raeburn 8182: Incoming parameters:
8183:
8184: 1. domain
8185: 2. course number
8186: 3. reference to array containing roles for which sections should
8187: be gathered (optional).
8188: 4. reference to array containing status types for which sections
8189: should be gathered (optional).
8190:
8191: If the third argument is undefined, sections are gathered for any role.
8192: If the fourth argument is undefined, sections are gathered for any status.
8193: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 8194:
1.374 raeburn 8195: Returns section hash (keys are section IDs, values are
8196: number of users in each section), subject to the
1.419 raeburn 8197: optional roles filter, optional status filter
1.233 raeburn 8198:
8199: =cut
8200:
8201: ###############################################
8202: sub get_sections {
1.419 raeburn 8203: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 8204: if (!defined($cdom) || !defined($cnum)) {
8205: my $cid = $env{'request.course.id'};
8206:
8207: return if (!defined($cid));
8208:
8209: $cdom = $env{'course.'.$cid.'.domain'};
8210: $cnum = $env{'course.'.$cid.'.num'};
8211: }
8212:
8213: my %sectioncount;
1.419 raeburn 8214: my $now = time;
1.240 albertel 8215:
1.1075.2.33 raeburn 8216: my $check_students = 1;
8217: my $only_students = 0;
8218: if (ref($possible_roles) eq 'ARRAY') {
8219: if (grep(/^st$/,@{$possible_roles})) {
8220: if (@{$possible_roles} == 1) {
8221: $only_students = 1;
8222: }
8223: } else {
8224: $check_students = 0;
8225: }
8226: }
8227:
8228: if ($check_students) {
1.276 albertel 8229: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 8230: my $sec_index = &Apache::loncoursedata::CL_SECTION();
8231: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 8232: my $start_index = &Apache::loncoursedata::CL_START();
8233: my $end_index = &Apache::loncoursedata::CL_END();
8234: my $status;
1.366 albertel 8235: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 8236: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
8237: $data->[$status_index],
8238: $data->[$start_index],
8239: $data->[$end_index]);
8240: if ($stu_status eq 'Active') {
8241: $status = 'active';
8242: } elsif ($end < $now) {
8243: $status = 'previous';
8244: } elsif ($start > $now) {
8245: $status = 'future';
8246: }
8247: if ($section ne '-1' && $section !~ /^\s*$/) {
8248: if ((!defined($possible_status)) || (($status ne '') &&
8249: (grep/^\Q$status\E$/,@{$possible_status}))) {
8250: $sectioncount{$section}++;
8251: }
1.240 albertel 8252: }
8253: }
8254: }
1.1075.2.33 raeburn 8255: if ($only_students) {
8256: return %sectioncount;
8257: }
1.240 albertel 8258: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8259: foreach my $user (sort(keys(%courseroles))) {
8260: if ($user !~ /^(\w{2})/) { next; }
8261: my ($role) = ($user =~ /^(\w{2})/);
8262: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 8263: my ($section,$status);
1.240 albertel 8264: if ($role eq 'cr' &&
8265: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
8266: $section=$1;
8267: }
8268: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
8269: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 8270: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
8271: if ($end == -1 && $start == -1) {
8272: next; #deleted role
8273: }
8274: if (!defined($possible_status)) {
8275: $sectioncount{$section}++;
8276: } else {
8277: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
8278: $status = 'active';
8279: } elsif ($end < $now) {
8280: $status = 'future';
8281: } elsif ($start > $now) {
8282: $status = 'previous';
8283: }
8284: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
8285: $sectioncount{$section}++;
8286: }
8287: }
1.233 raeburn 8288: }
1.366 albertel 8289: return %sectioncount;
1.233 raeburn 8290: }
8291:
1.274 raeburn 8292: ###############################################
1.294 raeburn 8293:
8294: =pod
1.405 albertel 8295:
8296: =item * &get_course_users()
8297:
1.275 raeburn 8298: Retrieves usernames:domains for users in the specified course
8299: with specific role(s), and access status.
8300:
8301: Incoming parameters:
1.277 albertel 8302: 1. course domain
8303: 2. course number
8304: 3. access status: users must have - either active,
1.275 raeburn 8305: previous, future, or all.
1.277 albertel 8306: 4. reference to array of permissible roles
1.288 raeburn 8307: 5. reference to array of section restrictions (optional)
8308: 6. reference to results object (hash of hashes).
8309: 7. reference to optional userdata hash
1.609 raeburn 8310: 8. reference to optional statushash
1.630 raeburn 8311: 9. flag if privileged users (except those set to unhide in
8312: course settings) should be excluded
1.609 raeburn 8313: Keys of top level results hash are roles.
1.275 raeburn 8314: Keys of inner hashes are username:domain, with
8315: values set to access type.
1.288 raeburn 8316: Optional userdata hash returns an array with arguments in the
8317: same order as loncoursedata::get_classlist() for student data.
8318:
1.609 raeburn 8319: Optional statushash returns
8320:
1.288 raeburn 8321: Entries for end, start, section and status are blank because
8322: of the possibility of multiple values for non-student roles.
8323:
1.275 raeburn 8324: =cut
1.405 albertel 8325:
1.275 raeburn 8326: ###############################################
1.405 albertel 8327:
1.275 raeburn 8328: sub get_course_users {
1.630 raeburn 8329: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 8330: my %idx = ();
1.419 raeburn 8331: my %seclists;
1.288 raeburn 8332:
8333: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
8334: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
8335: $idx{end} = &Apache::loncoursedata::CL_END();
8336: $idx{start} = &Apache::loncoursedata::CL_START();
8337: $idx{id} = &Apache::loncoursedata::CL_ID();
8338: $idx{section} = &Apache::loncoursedata::CL_SECTION();
8339: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
8340: $idx{status} = &Apache::loncoursedata::CL_STATUS();
8341:
1.290 albertel 8342: if (grep(/^st$/,@{$roles})) {
1.276 albertel 8343: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 8344: my $now = time;
1.277 albertel 8345: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 8346: my $match = 0;
1.412 raeburn 8347: my $secmatch = 0;
1.419 raeburn 8348: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 8349: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 8350: if ($section eq '') {
8351: $section = 'none';
8352: }
1.291 albertel 8353: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 8354: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 8355: $secmatch = 1;
8356: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 8357: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 8358: $secmatch = 1;
8359: }
8360: } else {
1.419 raeburn 8361: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 8362: $secmatch = 1;
8363: }
1.290 albertel 8364: }
1.412 raeburn 8365: if (!$secmatch) {
8366: next;
8367: }
1.419 raeburn 8368: }
1.275 raeburn 8369: if (defined($$types{'active'})) {
1.288 raeburn 8370: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 8371: push(@{$$users{st}{$student}},'active');
1.288 raeburn 8372: $match = 1;
1.275 raeburn 8373: }
8374: }
8375: if (defined($$types{'previous'})) {
1.609 raeburn 8376: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 8377: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 8378: $match = 1;
1.275 raeburn 8379: }
8380: }
8381: if (defined($$types{'future'})) {
1.609 raeburn 8382: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 8383: push(@{$$users{st}{$student}},'future');
1.288 raeburn 8384: $match = 1;
1.275 raeburn 8385: }
8386: }
1.609 raeburn 8387: if ($match) {
8388: push(@{$seclists{$student}},$section);
8389: if (ref($userdata) eq 'HASH') {
8390: $$userdata{$student} = $$classlist{$student};
8391: }
8392: if (ref($statushash) eq 'HASH') {
8393: $statushash->{$student}{'st'}{$section} = $status;
8394: }
1.288 raeburn 8395: }
1.275 raeburn 8396: }
8397: }
1.412 raeburn 8398: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 8399: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8400: my $now = time;
1.609 raeburn 8401: my %displaystatus = ( previous => 'Expired',
8402: active => 'Active',
8403: future => 'Future',
8404: );
1.1075.2.36 raeburn 8405: my (%nothide,@possdoms);
1.630 raeburn 8406: if ($hidepriv) {
8407: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
8408: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
8409: if ($user !~ /:/) {
8410: $nothide{join(':',split(/[\@]/,$user))}=1;
8411: } else {
8412: $nothide{$user} = 1;
8413: }
8414: }
1.1075.2.36 raeburn 8415: my @possdoms = ($cdom);
8416: if ($coursehash{'checkforpriv'}) {
8417: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
8418: }
1.630 raeburn 8419: }
1.439 raeburn 8420: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 8421: my $match = 0;
1.412 raeburn 8422: my $secmatch = 0;
1.439 raeburn 8423: my $status;
1.412 raeburn 8424: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 8425: $user =~ s/:$//;
1.439 raeburn 8426: my ($end,$start) = split(/:/,$coursepersonnel{$person});
8427: if ($end == -1 || $start == -1) {
8428: next;
8429: }
8430: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
8431: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 8432: my ($uname,$udom) = split(/:/,$user);
8433: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 8434: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 8435: $secmatch = 1;
8436: } elsif ($usec eq '') {
1.420 albertel 8437: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 8438: $secmatch = 1;
8439: }
8440: } else {
8441: if (grep(/^\Q$usec\E$/,@{$sections})) {
8442: $secmatch = 1;
8443: }
8444: }
8445: if (!$secmatch) {
8446: next;
8447: }
1.288 raeburn 8448: }
1.419 raeburn 8449: if ($usec eq '') {
8450: $usec = 'none';
8451: }
1.275 raeburn 8452: if ($uname ne '' && $udom ne '') {
1.630 raeburn 8453: if ($hidepriv) {
1.1075.2.36 raeburn 8454: if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630 raeburn 8455: (!$nothide{$uname.':'.$udom})) {
8456: next;
8457: }
8458: }
1.503 raeburn 8459: if ($end > 0 && $end < $now) {
1.439 raeburn 8460: $status = 'previous';
8461: } elsif ($start > $now) {
8462: $status = 'future';
8463: } else {
8464: $status = 'active';
8465: }
1.277 albertel 8466: foreach my $type (keys(%{$types})) {
1.275 raeburn 8467: if ($status eq $type) {
1.420 albertel 8468: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 8469: push(@{$$users{$role}{$user}},$type);
8470: }
1.288 raeburn 8471: $match = 1;
8472: }
8473: }
1.419 raeburn 8474: if (($match) && (ref($userdata) eq 'HASH')) {
8475: if (!exists($$userdata{$uname.':'.$udom})) {
8476: &get_user_info($udom,$uname,\%idx,$userdata);
8477: }
1.420 albertel 8478: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 8479: push(@{$seclists{$uname.':'.$udom}},$usec);
8480: }
1.609 raeburn 8481: if (ref($statushash) eq 'HASH') {
8482: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
8483: }
1.275 raeburn 8484: }
8485: }
8486: }
8487: }
1.290 albertel 8488: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 8489: if ((defined($cdom)) && (defined($cnum))) {
8490: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
8491: if ( defined($csettings{'internal.courseowner'}) ) {
8492: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 8493: next if ($owner eq '');
8494: my ($ownername,$ownerdom);
8495: if ($owner =~ /^([^:]+):([^:]+)$/) {
8496: $ownername = $1;
8497: $ownerdom = $2;
8498: } else {
8499: $ownername = $owner;
8500: $ownerdom = $cdom;
8501: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 8502: }
8503: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 8504: if (defined($userdata) &&
1.609 raeburn 8505: !exists($$userdata{$owner})) {
8506: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
8507: if (!grep(/^none$/,@{$seclists{$owner}})) {
8508: push(@{$seclists{$owner}},'none');
8509: }
8510: if (ref($statushash) eq 'HASH') {
8511: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 8512: }
1.290 albertel 8513: }
1.279 raeburn 8514: }
8515: }
8516: }
1.419 raeburn 8517: foreach my $user (keys(%seclists)) {
8518: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
8519: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
8520: }
1.275 raeburn 8521: }
8522: return;
8523: }
8524:
1.288 raeburn 8525: sub get_user_info {
8526: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 8527: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
8528: &plainname($uname,$udom,'lastname');
1.291 albertel 8529: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 8530: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 8531: my %idhash = &Apache::lonnet::idrget($udom,($uname));
8532: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 8533: return;
8534: }
1.275 raeburn 8535:
1.472 raeburn 8536: ###############################################
8537:
8538: =pod
8539:
8540: =item * &get_user_quota()
8541:
8542: Retrieves quota assigned for storage of portfolio files for a user
8543:
8544: Incoming parameters:
8545: 1. user's username
8546: 2. user's domain
8547:
8548: Returns:
1.536 raeburn 8549: 1. Disk quota (in Mb) assigned to student.
8550: 2. (Optional) Type of setting: custom or default
8551: (individually assigned or default for user's
8552: institutional status).
8553: 3. (Optional) - User's institutional status (e.g., faculty, staff
8554: or student - types as defined in localenroll::inst_usertypes
8555: for user's domain, which determines default quota for user.
8556: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 8557:
8558: If a value has been stored in the user's environment,
1.536 raeburn 8559: it will return that, otherwise it returns the maximal default
8560: defined for the user's instituional status(es) in the domain.
1.472 raeburn 8561:
8562: =cut
8563:
8564: ###############################################
8565:
8566:
8567: sub get_user_quota {
8568: my ($uname,$udom) = @_;
1.536 raeburn 8569: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 8570: if (!defined($udom)) {
8571: $udom = $env{'user.domain'};
8572: }
8573: if (!defined($uname)) {
8574: $uname = $env{'user.name'};
8575: }
8576: if (($udom eq '' || $uname eq '') ||
8577: ($udom eq 'public') && ($uname eq 'public')) {
8578: $quota = 0;
1.536 raeburn 8579: $quotatype = 'default';
8580: $defquota = 0;
1.472 raeburn 8581: } else {
1.536 raeburn 8582: my $inststatus;
1.472 raeburn 8583: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
8584: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 8585: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 8586: } else {
1.536 raeburn 8587: my %userenv =
8588: &Apache::lonnet::get('environment',['portfolioquota',
8589: 'inststatus'],$udom,$uname);
1.472 raeburn 8590: my ($tmp) = keys(%userenv);
8591: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
8592: $quota = $userenv{'portfolioquota'};
1.536 raeburn 8593: $inststatus = $userenv{'inststatus'};
1.472 raeburn 8594: } else {
8595: undef(%userenv);
8596: }
8597: }
1.536 raeburn 8598: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 8599: if ($quota eq '') {
1.536 raeburn 8600: $quota = $defquota;
8601: $quotatype = 'default';
8602: } else {
8603: $quotatype = 'custom';
1.472 raeburn 8604: }
8605: }
1.536 raeburn 8606: if (wantarray) {
8607: return ($quota,$quotatype,$settingstatus,$defquota);
8608: } else {
8609: return $quota;
8610: }
1.472 raeburn 8611: }
8612:
8613: ###############################################
8614:
8615: =pod
8616:
8617: =item * &default_quota()
8618:
1.536 raeburn 8619: Retrieves default quota assigned for storage of user portfolio files,
8620: given an (optional) user's institutional status.
1.472 raeburn 8621:
8622: Incoming parameters:
8623: 1. domain
1.536 raeburn 8624: 2. (Optional) institutional status(es). This is a : separated list of
8625: status types (e.g., faculty, staff, student etc.)
8626: which apply to the user for whom the default is being retrieved.
8627: If the institutional status string in undefined, the domain
8628: default quota will be returned.
1.472 raeburn 8629:
8630: Returns:
8631: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 8632: 2. (Optional) institutional type which determined the value of the
8633: default quota.
1.472 raeburn 8634:
8635: If a value has been stored in the domain's configuration db,
8636: it will return that, otherwise it returns 20 (for backwards
8637: compatibility with domains which have not set up a configuration
8638: db file; the original statically defined portfolio quota was 20 Mb).
8639:
1.536 raeburn 8640: If the user's status includes multiple types (e.g., staff and student),
8641: the largest default quota which applies to the user determines the
8642: default quota returned.
8643:
1.780 raeburn 8644: =back
8645:
1.472 raeburn 8646: =cut
8647:
8648: ###############################################
8649:
8650:
8651: sub default_quota {
1.536 raeburn 8652: my ($udom,$inststatus) = @_;
8653: my ($defquota,$settingstatus);
8654: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 8655: ['quotas'],$udom);
8656: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 8657: if ($inststatus ne '') {
1.765 raeburn 8658: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 8659: foreach my $item (@statuses) {
1.711 raeburn 8660: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
8661: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
8662: if ($defquota eq '') {
8663: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
8664: $settingstatus = $item;
8665: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
8666: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
8667: $settingstatus = $item;
8668: }
8669: }
8670: } else {
8671: if ($quotahash{'quotas'}{$item} ne '') {
8672: if ($defquota eq '') {
8673: $defquota = $quotahash{'quotas'}{$item};
8674: $settingstatus = $item;
8675: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
8676: $defquota = $quotahash{'quotas'}{$item};
8677: $settingstatus = $item;
8678: }
1.536 raeburn 8679: }
8680: }
8681: }
8682: }
8683: if ($defquota eq '') {
1.711 raeburn 8684: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
8685: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
8686: } else {
8687: $defquota = $quotahash{'quotas'}{'default'};
8688: }
1.536 raeburn 8689: $settingstatus = 'default';
8690: }
8691: } else {
8692: $settingstatus = 'default';
8693: $defquota = 20;
8694: }
8695: if (wantarray) {
8696: return ($defquota,$settingstatus);
1.472 raeburn 8697: } else {
1.536 raeburn 8698: return $defquota;
1.472 raeburn 8699: }
8700: }
8701:
1.384 raeburn 8702: sub get_secgrprole_info {
8703: my ($cdom,$cnum,$needroles,$type) = @_;
8704: my %sections_count = &get_sections($cdom,$cnum);
8705: my @sections = (sort {$a <=> $b} keys(%sections_count));
8706: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
8707: my @groups = sort(keys(%curr_groups));
8708: my $allroles = [];
8709: my $rolehash;
8710: my $accesshash = {
8711: active => 'Currently has access',
8712: future => 'Will have future access',
8713: previous => 'Previously had access',
8714: };
8715: if ($needroles) {
8716: $rolehash = {'all' => 'all'};
1.385 albertel 8717: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8718: if (&Apache::lonnet::error(%user_roles)) {
8719: undef(%user_roles);
8720: }
8721: foreach my $item (keys(%user_roles)) {
1.384 raeburn 8722: my ($role)=split(/\:/,$item,2);
8723: if ($role eq 'cr') { next; }
8724: if ($role =~ /^cr/) {
8725: $$rolehash{$role} = (split('/',$role))[3];
8726: } else {
8727: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
8728: }
8729: }
8730: foreach my $key (sort(keys(%{$rolehash}))) {
8731: push(@{$allroles},$key);
8732: }
8733: push (@{$allroles},'st');
8734: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
8735: }
8736: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
8737: }
8738:
1.555 raeburn 8739: sub user_picker {
1.994 raeburn 8740: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context) = @_;
1.555 raeburn 8741: my $currdom = $dom;
8742: my %curr_selected = (
8743: srchin => 'dom',
1.580 raeburn 8744: srchby => 'lastname',
1.555 raeburn 8745: );
8746: my $srchterm;
1.625 raeburn 8747: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 8748: if ($srch->{'srchby'} ne '') {
8749: $curr_selected{'srchby'} = $srch->{'srchby'};
8750: }
8751: if ($srch->{'srchin'} ne '') {
8752: $curr_selected{'srchin'} = $srch->{'srchin'};
8753: }
8754: if ($srch->{'srchtype'} ne '') {
8755: $curr_selected{'srchtype'} = $srch->{'srchtype'};
8756: }
8757: if ($srch->{'srchdomain'} ne '') {
8758: $currdom = $srch->{'srchdomain'};
8759: }
8760: $srchterm = $srch->{'srchterm'};
8761: }
8762: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 8763: 'usr' => 'Search criteria',
1.563 raeburn 8764: 'doma' => 'Domain/institution to search',
1.558 albertel 8765: 'uname' => 'username',
8766: 'lastname' => 'last name',
1.555 raeburn 8767: 'lastfirst' => 'last name, first name',
1.558 albertel 8768: 'crs' => 'in this course',
1.576 raeburn 8769: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 8770: 'alc' => 'all LON-CAPA',
1.573 raeburn 8771: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 8772: 'exact' => 'is',
8773: 'contains' => 'contains',
1.569 raeburn 8774: 'begins' => 'begins with',
1.571 raeburn 8775: 'youm' => "You must include some text to search for.",
8776: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
8777: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
8778: 'yomc' => "You must choose a domain when using an institutional directory search.",
8779: 'ymcd' => "You must choose a domain when using a domain search.",
8780: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
8781: 'whse' => "When searching by last,first you must include at least one character in the first name.",
8782: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 8783: );
1.563 raeburn 8784: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
8785: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 8786:
8787: my @srchins = ('crs','dom','alc','instd');
8788:
8789: foreach my $option (@srchins) {
8790: # FIXME 'alc' option unavailable until
8791: # loncreateuser::print_user_query_page()
8792: # has been completed.
8793: next if ($option eq 'alc');
1.880 raeburn 8794: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 8795: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 8796: if ($curr_selected{'srchin'} eq $option) {
8797: $srchinsel .= '
8798: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
8799: } else {
8800: $srchinsel .= '
8801: <option value="'.$option.'">'.$lt{$option}.'</option>';
8802: }
1.555 raeburn 8803: }
1.563 raeburn 8804: $srchinsel .= "\n </select>\n";
1.555 raeburn 8805:
8806: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 8807: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 8808: if ($curr_selected{'srchby'} eq $option) {
8809: $srchbysel .= '
8810: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
8811: } else {
8812: $srchbysel .= '
8813: <option value="'.$option.'">'.$lt{$option}.'</option>';
8814: }
8815: }
8816: $srchbysel .= "\n </select>\n";
8817:
8818: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 8819: foreach my $option ('begins','contains','exact') {
1.555 raeburn 8820: if ($curr_selected{'srchtype'} eq $option) {
8821: $srchtypesel .= '
8822: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
8823: } else {
8824: $srchtypesel .= '
8825: <option value="'.$option.'">'.$lt{$option}.'</option>';
8826: }
8827: }
8828: $srchtypesel .= "\n </select>\n";
8829:
1.558 albertel 8830: my ($newuserscript,$new_user_create);
1.994 raeburn 8831: my $context_dom = $env{'request.role.domain'};
8832: if ($context eq 'requestcrs') {
8833: if ($env{'form.coursedom'} ne '') {
8834: $context_dom = $env{'form.coursedom'};
8835: }
8836: }
1.556 raeburn 8837: if ($forcenewuser) {
1.576 raeburn 8838: if (ref($srch) eq 'HASH') {
1.994 raeburn 8839: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 8840: if ($cancreate) {
8841: $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>';
8842: } else {
1.799 bisitz 8843: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 8844: my %usertypetext = (
8845: official => 'institutional',
8846: unofficial => 'non-institutional',
8847: );
1.799 bisitz 8848: $new_user_create = '<p class="LC_warning">'
8849: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
8850: .' '
8851: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
8852: ,'<a href="'.$helplink.'">','</a>')
8853: .'</p><br />';
1.627 raeburn 8854: }
1.576 raeburn 8855: }
8856: }
8857:
1.556 raeburn 8858: $newuserscript = <<"ENDSCRIPT";
8859:
1.570 raeburn 8860: function setSearch(createnew,callingForm) {
1.556 raeburn 8861: if (createnew == 1) {
1.570 raeburn 8862: for (var i=0; i<callingForm.srchby.length; i++) {
8863: if (callingForm.srchby.options[i].value == 'uname') {
8864: callingForm.srchby.selectedIndex = i;
1.556 raeburn 8865: }
8866: }
1.570 raeburn 8867: for (var i=0; i<callingForm.srchin.length; i++) {
8868: if ( callingForm.srchin.options[i].value == 'dom') {
8869: callingForm.srchin.selectedIndex = i;
1.556 raeburn 8870: }
8871: }
1.570 raeburn 8872: for (var i=0; i<callingForm.srchtype.length; i++) {
8873: if (callingForm.srchtype.options[i].value == 'exact') {
8874: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 8875: }
8876: }
1.570 raeburn 8877: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 8878: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 8879: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 8880: }
8881: }
8882: }
8883: }
8884: ENDSCRIPT
1.558 albertel 8885:
1.556 raeburn 8886: }
8887:
1.555 raeburn 8888: my $output = <<"END_BLOCK";
1.556 raeburn 8889: <script type="text/javascript">
1.824 bisitz 8890: // <![CDATA[
1.570 raeburn 8891: function validateEntry(callingForm) {
1.558 albertel 8892:
1.556 raeburn 8893: var checkok = 1;
1.558 albertel 8894: var srchin;
1.570 raeburn 8895: for (var i=0; i<callingForm.srchin.length; i++) {
8896: if ( callingForm.srchin[i].checked ) {
8897: srchin = callingForm.srchin[i].value;
1.558 albertel 8898: }
8899: }
8900:
1.570 raeburn 8901: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
8902: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
8903: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
8904: var srchterm = callingForm.srchterm.value;
8905: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 8906: var msg = "";
8907:
8908: if (srchterm == "") {
8909: checkok = 0;
1.571 raeburn 8910: msg += "$lt{'youm'}\\n";
1.556 raeburn 8911: }
8912:
1.569 raeburn 8913: if (srchtype== 'begins') {
8914: if (srchterm.length < 2) {
8915: checkok = 0;
1.571 raeburn 8916: msg += "$lt{'thte'}\\n";
1.569 raeburn 8917: }
8918: }
8919:
1.556 raeburn 8920: if (srchtype== 'contains') {
8921: if (srchterm.length < 3) {
8922: checkok = 0;
1.571 raeburn 8923: msg += "$lt{'thet'}\\n";
1.556 raeburn 8924: }
8925: }
8926: if (srchin == 'instd') {
8927: if (srchdomain == '') {
8928: checkok = 0;
1.571 raeburn 8929: msg += "$lt{'yomc'}\\n";
1.556 raeburn 8930: }
8931: }
8932: if (srchin == 'dom') {
8933: if (srchdomain == '') {
8934: checkok = 0;
1.571 raeburn 8935: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 8936: }
8937: }
8938: if (srchby == 'lastfirst') {
8939: if (srchterm.indexOf(",") == -1) {
8940: checkok = 0;
1.571 raeburn 8941: msg += "$lt{'whus'}\\n";
1.556 raeburn 8942: }
8943: if (srchterm.indexOf(",") == srchterm.length -1) {
8944: checkok = 0;
1.571 raeburn 8945: msg += "$lt{'whse'}\\n";
1.556 raeburn 8946: }
8947: }
8948: if (checkok == 0) {
1.571 raeburn 8949: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 8950: return;
8951: }
8952: if (checkok == 1) {
1.570 raeburn 8953: callingForm.submit();
1.556 raeburn 8954: }
8955: }
8956:
8957: $newuserscript
8958:
1.824 bisitz 8959: // ]]>
1.556 raeburn 8960: </script>
1.558 albertel 8961:
8962: $new_user_create
8963:
1.555 raeburn 8964: END_BLOCK
1.558 albertel 8965:
1.876 raeburn 8966: $output .= &Apache::lonhtmlcommon::start_pick_box().
8967: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
8968: $domform.
8969: &Apache::lonhtmlcommon::row_closure().
8970: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
8971: $srchbysel.
8972: $srchtypesel.
8973: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
8974: $srchinsel.
8975: &Apache::lonhtmlcommon::row_closure(1).
8976: &Apache::lonhtmlcommon::end_pick_box().
8977: '<br />';
1.555 raeburn 8978: return $output;
8979: }
8980:
1.612 raeburn 8981: sub user_rule_check {
1.615 raeburn 8982: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 8983: my $response;
8984: if (ref($usershash) eq 'HASH') {
8985: foreach my $user (keys(%{$usershash})) {
8986: my ($uname,$udom) = split(/:/,$user);
8987: next if ($udom eq '' || $uname eq '');
1.615 raeburn 8988: my ($id,$newuser);
1.612 raeburn 8989: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 8990: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 8991: $id = $usershash->{$user}->{'id'};
8992: }
8993: my $inst_response;
8994: if (ref($checks) eq 'HASH') {
8995: if (defined($checks->{'username'})) {
1.615 raeburn 8996: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 8997: &Apache::lonnet::get_instuser($udom,$uname);
8998: } elsif (defined($checks->{'id'})) {
1.615 raeburn 8999: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 9000: &Apache::lonnet::get_instuser($udom,undef,$id);
9001: }
1.615 raeburn 9002: } else {
9003: ($inst_response,%{$inst_results->{$user}}) =
9004: &Apache::lonnet::get_instuser($udom,$uname);
9005: return;
1.612 raeburn 9006: }
1.615 raeburn 9007: if (!$got_rules->{$udom}) {
1.612 raeburn 9008: my %domconfig = &Apache::lonnet::get_dom('configuration',
9009: ['usercreation'],$udom);
9010: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 9011: foreach my $item ('username','id') {
1.612 raeburn 9012: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
9013: $$curr_rules{$udom}{$item} =
9014: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 9015: }
9016: }
9017: }
1.615 raeburn 9018: $got_rules->{$udom} = 1;
1.585 raeburn 9019: }
1.612 raeburn 9020: foreach my $item (keys(%{$checks})) {
9021: if (ref($$curr_rules{$udom}) eq 'HASH') {
9022: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
9023: if (@{$$curr_rules{$udom}{$item}} > 0) {
9024: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
9025: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
9026: if ($rule_check{$rule}) {
9027: $$rulematch{$user}{$item} = $rule;
9028: if ($inst_response eq 'ok') {
1.615 raeburn 9029: if (ref($inst_results) eq 'HASH') {
9030: if (ref($inst_results->{$user}) eq 'HASH') {
9031: if (keys(%{$inst_results->{$user}}) == 0) {
9032: $$alerts{$item}{$udom}{$uname} = 1;
9033: }
1.612 raeburn 9034: }
9035: }
1.615 raeburn 9036: }
9037: last;
1.585 raeburn 9038: }
9039: }
9040: }
9041: }
9042: }
9043: }
9044: }
9045: }
1.612 raeburn 9046: return;
9047: }
9048:
9049: sub user_rule_formats {
9050: my ($domain,$domdesc,$curr_rules,$check) = @_;
9051: my %text = (
9052: 'username' => 'Usernames',
9053: 'id' => 'IDs',
9054: );
9055: my $output;
9056: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
9057: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
9058: if (@{$ruleorder} > 0) {
1.1075.2.20 raeburn 9059: $output = '<br />'.
9060: &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
9061: '<span class="LC_cusr_emph">','</span>',$domdesc).
9062: ' <ul>';
1.612 raeburn 9063: foreach my $rule (@{$ruleorder}) {
9064: if (ref($curr_rules) eq 'ARRAY') {
9065: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
9066: if (ref($rules->{$rule}) eq 'HASH') {
9067: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
9068: $rules->{$rule}{'desc'}.'</li>';
9069: }
9070: }
9071: }
9072: }
9073: $output .= '</ul>';
9074: }
9075: }
9076: return $output;
9077: }
9078:
9079: sub instrule_disallow_msg {
1.615 raeburn 9080: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 9081: my $response;
9082: my %text = (
9083: item => 'username',
9084: items => 'usernames',
9085: match => 'matches',
9086: do => 'does',
9087: action => 'a username',
9088: one => 'one',
9089: );
9090: if ($count > 1) {
9091: $text{'item'} = 'usernames';
9092: $text{'match'} ='match';
9093: $text{'do'} = 'do';
9094: $text{'action'} = 'usernames',
9095: $text{'one'} = 'ones';
9096: }
9097: if ($checkitem eq 'id') {
9098: $text{'items'} = 'IDs';
9099: $text{'item'} = 'ID';
9100: $text{'action'} = 'an ID';
1.615 raeburn 9101: if ($count > 1) {
9102: $text{'item'} = 'IDs';
9103: $text{'action'} = 'IDs';
9104: }
1.612 raeburn 9105: }
1.674 bisitz 9106: $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 9107: if ($mode eq 'upload') {
9108: if ($checkitem eq 'username') {
9109: $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'}.");
9110: } elsif ($checkitem eq 'id') {
1.674 bisitz 9111: $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 9112: }
1.669 raeburn 9113: } elsif ($mode eq 'selfcreate') {
9114: if ($checkitem eq 'id') {
9115: $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.");
9116: }
1.615 raeburn 9117: } else {
9118: if ($checkitem eq 'username') {
9119: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
9120: } elsif ($checkitem eq 'id') {
9121: $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.");
9122: }
1.612 raeburn 9123: }
9124: return $response;
1.585 raeburn 9125: }
9126:
1.624 raeburn 9127: sub personal_data_fieldtitles {
9128: my %fieldtitles = &Apache::lonlocal::texthash (
9129: id => 'Student/Employee ID',
9130: permanentemail => 'E-mail address',
9131: lastname => 'Last Name',
9132: firstname => 'First Name',
9133: middlename => 'Middle Name',
9134: generation => 'Generation',
9135: gen => 'Generation',
1.765 raeburn 9136: inststatus => 'Affiliation',
1.624 raeburn 9137: );
9138: return %fieldtitles;
9139: }
9140:
1.642 raeburn 9141: sub sorted_inst_types {
9142: my ($dom) = @_;
9143: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
9144: my $othertitle = &mt('All users');
9145: if ($env{'request.course.id'}) {
1.668 raeburn 9146: $othertitle = &mt('Any users');
1.642 raeburn 9147: }
9148: my @types;
9149: if (ref($order) eq 'ARRAY') {
9150: @types = @{$order};
9151: }
9152: if (@types == 0) {
9153: if (ref($usertypes) eq 'HASH') {
9154: @types = sort(keys(%{$usertypes}));
9155: }
9156: }
9157: if (keys(%{$usertypes}) > 0) {
9158: $othertitle = &mt('Other users');
9159: }
9160: return ($othertitle,$usertypes,\@types);
9161: }
9162:
1.645 raeburn 9163: sub get_institutional_codes {
9164: my ($settings,$allcourses,$LC_code) = @_;
9165: # Get complete list of course sections to update
9166: my @currsections = ();
9167: my @currxlists = ();
9168: my $coursecode = $$settings{'internal.coursecode'};
9169:
9170: if ($$settings{'internal.sectionnums'} ne '') {
9171: @currsections = split(/,/,$$settings{'internal.sectionnums'});
9172: }
9173:
9174: if ($$settings{'internal.crosslistings'} ne '') {
9175: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
9176: }
9177:
9178: if (@currxlists > 0) {
9179: foreach (@currxlists) {
9180: if (m/^([^:]+):(\w*)$/) {
9181: unless (grep/^$1$/,@{$allcourses}) {
9182: push @{$allcourses},$1;
9183: $$LC_code{$1} = $2;
9184: }
9185: }
9186: }
9187: }
9188:
9189: if (@currsections > 0) {
9190: foreach (@currsections) {
9191: if (m/^(\w+):(\w*)$/) {
9192: my $sec = $coursecode.$1;
9193: my $lc_sec = $2;
9194: unless (grep/^$sec$/,@{$allcourses}) {
9195: push @{$allcourses},$sec;
9196: $$LC_code{$sec} = $lc_sec;
9197: }
9198: }
9199: }
9200: }
9201: return;
9202: }
9203:
1.971 raeburn 9204: sub get_standard_codeitems {
9205: return ('Year','Semester','Department','Number','Section');
9206: }
9207:
1.112 bowersj2 9208: =pod
9209:
1.780 raeburn 9210: =head1 Slot Helpers
9211:
9212: =over 4
9213:
9214: =item * sorted_slots()
9215:
1.1040 raeburn 9216: Sorts an array of slot names in order of an optional sort key,
9217: default sort is by slot start time (earliest first).
1.780 raeburn 9218:
9219: Inputs:
9220:
9221: =over 4
9222:
9223: slotsarr - Reference to array of unsorted slot names.
9224:
9225: slots - Reference to hash of hash, where outer hash keys are slot names.
9226:
1.1040 raeburn 9227: sortkey - Name of key in inner hash to be sorted on (e.g., starttime).
9228:
1.549 albertel 9229: =back
9230:
1.780 raeburn 9231: Returns:
9232:
9233: =over 4
9234:
1.1040 raeburn 9235: sorted - An array of slot names sorted by a specified sort key
9236: (default sort key is start time of the slot).
1.780 raeburn 9237:
9238: =back
9239:
9240: =cut
9241:
9242:
9243: sub sorted_slots {
1.1040 raeburn 9244: my ($slotsarr,$slots,$sortkey) = @_;
9245: if ($sortkey eq '') {
9246: $sortkey = 'starttime';
9247: }
1.780 raeburn 9248: my @sorted;
9249: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
9250: @sorted =
9251: sort {
9252: if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040 raeburn 9253: return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780 raeburn 9254: }
9255: if (ref($slots->{$a})) { return -1;}
9256: if (ref($slots->{$b})) { return 1;}
9257: return 0;
9258: } @{$slotsarr};
9259: }
9260: return @sorted;
9261: }
9262:
1.1040 raeburn 9263: =pod
9264:
9265: =item * get_future_slots()
9266:
9267: Inputs:
9268:
9269: =over 4
9270:
9271: cnum - course number
9272:
9273: cdom - course domain
9274:
9275: now - current UNIX time
9276:
9277: symb - optional symb
9278:
9279: =back
9280:
9281: Returns:
9282:
9283: =over 4
9284:
9285: sorted_reservable - ref to array of student_schedulable slots currently
9286: reservable, ordered by end date of reservation period.
9287:
9288: reservable_now - ref to hash of student_schedulable slots currently
9289: reservable.
9290:
9291: Keys in inner hash are:
9292: (a) symb: either blank or symb to which slot use is restricted.
9293: (b) endreserve: end date of reservation period.
9294:
9295: sorted_future - ref to array of student_schedulable slots reservable in
9296: the future, ordered by start date of reservation period.
9297:
9298: future_reservable - ref to hash of student_schedulable slots reservable
9299: in the future.
9300:
9301: Keys in inner hash are:
9302: (a) symb: either blank or symb to which slot use is restricted.
9303: (b) startreserve: start date of reservation period.
9304:
9305: =back
9306:
9307: =cut
9308:
9309: sub get_future_slots {
9310: my ($cnum,$cdom,$now,$symb) = @_;
9311: my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
9312: my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
9313: foreach my $slot (keys(%slots)) {
9314: next unless($slots{$slot}->{'type'} eq 'schedulable_student');
9315: if ($symb) {
9316: next if (($slots{$slot}->{'symb'} ne '') &&
9317: ($slots{$slot}->{'symb'} ne $symb));
9318: }
9319: if (($slots{$slot}->{'starttime'} > $now) &&
9320: ($slots{$slot}->{'endtime'} > $now)) {
9321: if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
9322: my $userallowed = 0;
9323: if ($slots{$slot}->{'allowedsections'}) {
9324: my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
9325: if (!defined($env{'request.role.sec'})
9326: && grep(/^No section assigned$/,@allowed_sec)) {
9327: $userallowed=1;
9328: } else {
9329: if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
9330: $userallowed=1;
9331: }
9332: }
9333: unless ($userallowed) {
9334: if (defined($env{'request.course.groups'})) {
9335: my @groups = split(/:/,$env{'request.course.groups'});
9336: foreach my $group (@groups) {
9337: if (grep(/^\Q$group\E$/,@allowed_sec)) {
9338: $userallowed=1;
9339: last;
9340: }
9341: }
9342: }
9343: }
9344: }
9345: if ($slots{$slot}->{'allowedusers'}) {
9346: my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
9347: my $user = $env{'user.name'}.':'.$env{'user.domain'};
9348: if (grep(/^\Q$user\E$/,@allowed_users)) {
9349: $userallowed = 1;
9350: }
9351: }
9352: next unless($userallowed);
9353: }
9354: my $startreserve = $slots{$slot}->{'startreserve'};
9355: my $endreserve = $slots{$slot}->{'endreserve'};
9356: my $symb = $slots{$slot}->{'symb'};
9357: if (($startreserve < $now) &&
9358: (!$endreserve || $endreserve > $now)) {
9359: my $lastres = $endreserve;
9360: if (!$lastres) {
9361: $lastres = $slots{$slot}->{'starttime'};
9362: }
9363: $reservable_now{$slot} = {
9364: symb => $symb,
9365: endreserve => $lastres
9366: };
9367: } elsif (($startreserve > $now) &&
9368: (!$endreserve || $endreserve > $startreserve)) {
9369: $future_reservable{$slot} = {
9370: symb => $symb,
9371: startreserve => $startreserve
9372: };
9373: }
9374: }
9375: }
9376: my @unsorted_reservable = keys(%reservable_now);
9377: if (@unsorted_reservable > 0) {
9378: @sorted_reservable =
9379: &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
9380: }
9381: my @unsorted_future = keys(%future_reservable);
9382: if (@unsorted_future > 0) {
9383: @sorted_future =
9384: &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
9385: }
9386: return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
9387: }
1.780 raeburn 9388:
9389: =pod
9390:
1.1057 foxr 9391: =back
9392:
1.549 albertel 9393: =head1 HTTP Helpers
9394:
9395: =over 4
9396:
1.648 raeburn 9397: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 9398:
1.258 albertel 9399: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 9400: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 9401: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 9402:
9403: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
9404: $possible_names is an ref to an array of form element names. As an example:
9405: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 9406: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 9407:
9408: =cut
1.1 albertel 9409:
1.6 albertel 9410: sub get_unprocessed_cgi {
1.25 albertel 9411: my ($query,$possible_names)= @_;
1.26 matthew 9412: # $Apache::lonxml::debug=1;
1.356 albertel 9413: foreach my $pair (split(/&/,$query)) {
9414: my ($name, $value) = split(/=/,$pair);
1.369 www 9415: $name = &unescape($name);
1.25 albertel 9416: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
9417: $value =~ tr/+/ /;
9418: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 9419: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 9420: }
1.16 harris41 9421: }
1.6 albertel 9422: }
9423:
1.112 bowersj2 9424: =pod
9425:
1.648 raeburn 9426: =item * &cacheheader()
1.112 bowersj2 9427:
9428: returns cache-controlling header code
9429:
9430: =cut
9431:
1.7 albertel 9432: sub cacheheader {
1.258 albertel 9433: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 9434: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
9435: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 9436: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
9437: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 9438: return $output;
1.7 albertel 9439: }
9440:
1.112 bowersj2 9441: =pod
9442:
1.648 raeburn 9443: =item * &no_cache($r)
1.112 bowersj2 9444:
9445: specifies header code to not have cache
9446:
9447: =cut
9448:
1.9 albertel 9449: sub no_cache {
1.216 albertel 9450: my ($r) = @_;
9451: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 9452: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 9453: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
9454: $r->no_cache(1);
9455: $r->header_out("Expires" => $date);
9456: $r->header_out("Pragma" => "no-cache");
1.123 www 9457: }
9458:
9459: sub content_type {
1.181 albertel 9460: my ($r,$type,$charset) = @_;
1.299 foxr 9461: if ($r) {
9462: # Note that printout.pl calls this with undef for $r.
9463: &no_cache($r);
9464: }
1.258 albertel 9465: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 9466: unless ($charset) {
9467: $charset=&Apache::lonlocal::current_encoding;
9468: }
9469: if ($charset) { $type.='; charset='.$charset; }
9470: if ($r) {
9471: $r->content_type($type);
9472: } else {
9473: print("Content-type: $type\n\n");
9474: }
1.9 albertel 9475: }
1.25 albertel 9476:
1.112 bowersj2 9477: =pod
9478:
1.648 raeburn 9479: =item * &add_to_env($name,$value)
1.112 bowersj2 9480:
1.258 albertel 9481: adds $name to the %env hash with value
1.112 bowersj2 9482: $value, if $name already exists, the entry is converted to an array
9483: reference and $value is added to the array.
9484:
9485: =cut
9486:
1.25 albertel 9487: sub add_to_env {
9488: my ($name,$value)=@_;
1.258 albertel 9489: if (defined($env{$name})) {
9490: if (ref($env{$name})) {
1.25 albertel 9491: #already have multiple values
1.258 albertel 9492: push(@{ $env{$name} },$value);
1.25 albertel 9493: } else {
9494: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 9495: my $first=$env{$name};
9496: undef($env{$name});
9497: push(@{ $env{$name} },$first,$value);
1.25 albertel 9498: }
9499: } else {
1.258 albertel 9500: $env{$name}=$value;
1.25 albertel 9501: }
1.31 albertel 9502: }
1.149 albertel 9503:
9504: =pod
9505:
1.648 raeburn 9506: =item * &get_env_multiple($name)
1.149 albertel 9507:
1.258 albertel 9508: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 9509: values may be defined and end up as an array ref.
9510:
9511: returns an array of values
9512:
9513: =cut
9514:
9515: sub get_env_multiple {
9516: my ($name) = @_;
9517: my @values;
1.258 albertel 9518: if (defined($env{$name})) {
1.149 albertel 9519: # exists is it an array
1.258 albertel 9520: if (ref($env{$name})) {
9521: @values=@{ $env{$name} };
1.149 albertel 9522: } else {
1.258 albertel 9523: $values[0]=$env{$name};
1.149 albertel 9524: }
9525: }
9526: return(@values);
9527: }
9528:
1.660 raeburn 9529: sub ask_for_embedded_content {
9530: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071 raeburn 9531: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1075.2.11 raeburn 9532: %currsubfile,%unused,$rem);
1.1071 raeburn 9533: my $counter = 0;
9534: my $numnew = 0;
1.987 raeburn 9535: my $numremref = 0;
9536: my $numinvalid = 0;
9537: my $numpathchg = 0;
9538: my $numexisting = 0;
1.1071 raeburn 9539: my $numunused = 0;
9540: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
9541: $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path);
9542: my $heading = &mt('Upload embedded files');
9543: my $buttontext = &mt('Upload');
9544:
1.1075.2.35 raeburn 9545: my ($navmap,$cdom,$cnum);
1.1075.2.11 raeburn 9546: if ($env{'request.course.id'}) {
1.1075.2.35 raeburn 9547: if ($actionurl eq '/adm/dependencies') {
9548: $navmap = Apache::lonnavmaps::navmap->new();
9549: }
9550: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9551: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1075.2.11 raeburn 9552: }
1.1075.2.35 raeburn 9553: if (($actionurl eq '/adm/portfolio') ||
9554: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984 raeburn 9555: my $current_path='/';
9556: if ($env{'form.currentpath'}) {
9557: $current_path = $env{'form.currentpath'};
9558: }
9559: if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1075.2.35 raeburn 9560: $udom = $cdom;
9561: $uname = $cnum;
1.984 raeburn 9562: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
9563: } else {
9564: $udom = $env{'user.domain'};
9565: $uname = $env{'user.name'};
9566: $url = '/userfiles/portfolio';
9567: }
1.987 raeburn 9568: $toplevel = $url.'/';
1.984 raeburn 9569: $url .= $current_path;
9570: $getpropath = 1;
1.987 raeburn 9571: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
9572: ($actionurl eq '/adm/imsimport')) {
1.1022 www 9573: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026 raeburn 9574: $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987 raeburn 9575: $toplevel = $url;
1.984 raeburn 9576: if ($rest ne '') {
1.987 raeburn 9577: $url .= $rest;
9578: }
9579: } elsif ($actionurl eq '/adm/coursedocs') {
9580: if (ref($args) eq 'HASH') {
1.1071 raeburn 9581: $url = $args->{'docs_url'};
9582: $toplevel = $url;
1.1075.2.11 raeburn 9583: if ($args->{'context'} eq 'paste') {
9584: ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
9585: ($path) =
9586: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
9587: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
9588: $fileloc =~ s{^/}{};
9589: }
1.1071 raeburn 9590: }
9591: } elsif ($actionurl eq '/adm/dependencies') {
9592: if ($env{'request.course.id'} ne '') {
9593: if (ref($args) eq 'HASH') {
9594: $url = $args->{'docs_url'};
9595: $title = $args->{'docs_title'};
1.1075.2.35 raeburn 9596: $toplevel = $url;
9597: unless ($toplevel =~ m{^/}) {
9598: $toplevel = "/$url";
9599: }
1.1075.2.11 raeburn 9600: ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1075.2.35 raeburn 9601: if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
9602: $path = $1;
9603: } else {
9604: ($path) =
9605: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
9606: }
1.1071 raeburn 9607: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
9608: $fileloc =~ s{^/}{};
9609: ($filename) = ($fileloc =~ m{.+/([^/]+)$});
9610: $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
9611: }
1.987 raeburn 9612: }
1.1075.2.35 raeburn 9613: } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
9614: $udom = $cdom;
9615: $uname = $cnum;
9616: $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
9617: $toplevel = $url;
9618: $path = $url;
9619: $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
9620: $fileloc =~ s{^/}{};
9621: }
9622: foreach my $file (keys(%{$allfiles})) {
9623: my $embed_file;
9624: if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
9625: $embed_file = $1;
9626: } else {
9627: $embed_file = $file;
9628: }
1.987 raeburn 9629: my $absolutepath;
9630: if ($embed_file =~ m{^\w+://}) {
9631: $newfiles{$embed_file} = 1;
9632: $mapping{$embed_file} = $embed_file;
9633: } else {
9634: if ($embed_file =~ m{^/}) {
9635: $absolutepath = $embed_file;
9636: $embed_file =~ s{^(/+)}{};
9637: }
9638: if ($embed_file =~ m{/}) {
9639: my ($path,$fname) = ($embed_file =~ m{^(.+)/([^/]*)$});
9640: $path = &check_for_traversal($path,$url,$toplevel);
9641: my $item = $fname;
9642: if ($path ne '') {
9643: $item = $path.'/'.$fname;
9644: $subdependencies{$path}{$fname} = 1;
9645: } else {
9646: $dependencies{$item} = 1;
9647: }
9648: if ($absolutepath) {
9649: $mapping{$item} = $absolutepath;
9650: } else {
9651: $mapping{$item} = $embed_file;
9652: }
9653: } else {
9654: $dependencies{$embed_file} = 1;
9655: if ($absolutepath) {
9656: $mapping{$embed_file} = $absolutepath;
9657: } else {
9658: $mapping{$embed_file} = $embed_file;
9659: }
9660: }
1.984 raeburn 9661: }
9662: }
1.1071 raeburn 9663: my $dirptr = 16384;
1.984 raeburn 9664: foreach my $path (keys(%subdependencies)) {
1.1071 raeburn 9665: $currsubfile{$path} = {};
1.1075.2.35 raeburn 9666: if (($actionurl eq '/adm/portfolio') ||
9667: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 9668: my ($sublistref,$listerror) =
9669: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
9670: if (ref($sublistref) eq 'ARRAY') {
9671: foreach my $line (@{$sublistref}) {
9672: my ($file_name,$rest) = split(/\&/,$line,2);
1.1071 raeburn 9673: $currsubfile{$path}{$file_name} = 1;
1.1021 raeburn 9674: }
1.984 raeburn 9675: }
1.987 raeburn 9676: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 9677: if (opendir(my $dir,$url.'/'.$path)) {
9678: my @subdir_list = grep(!/^\./,readdir($dir));
1.1071 raeburn 9679: map {$currsubfile{$path}{$_} = 1;} @subdir_list;
9680: }
1.1075.2.11 raeburn 9681: } elsif (($actionurl eq '/adm/dependencies') ||
9682: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1075.2.35 raeburn 9683: ($args->{'context'} eq 'paste')) ||
9684: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 9685: if ($env{'request.course.id'} ne '') {
1.1075.2.35 raeburn 9686: my $dir;
9687: if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
9688: $dir = $fileloc;
9689: } else {
9690: ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
9691: }
1.1071 raeburn 9692: if ($dir ne '') {
9693: my ($sublistref,$listerror) =
9694: &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
9695: if (ref($sublistref) eq 'ARRAY') {
9696: foreach my $line (@{$sublistref}) {
9697: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
9698: undef,$mtime)=split(/\&/,$line,12);
9699: unless (($testdir&$dirptr) ||
9700: ($file_name =~ /^\.\.?$/)) {
9701: $currsubfile{$path}{$file_name} = [$size,$mtime];
9702: }
9703: }
9704: }
9705: }
1.984 raeburn 9706: }
9707: }
9708: foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071 raeburn 9709: if (exists($currsubfile{$path}{$file})) {
1.987 raeburn 9710: my $item = $path.'/'.$file;
9711: unless ($mapping{$item} eq $item) {
9712: $pathchanges{$item} = 1;
9713: }
9714: $existing{$item} = 1;
9715: $numexisting ++;
9716: } else {
9717: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 9718: }
9719: }
1.1071 raeburn 9720: if ($actionurl eq '/adm/dependencies') {
9721: foreach my $path (keys(%currsubfile)) {
9722: if (ref($currsubfile{$path}) eq 'HASH') {
9723: foreach my $file (keys(%{$currsubfile{$path}})) {
9724: unless ($subdependencies{$path}{$file}) {
1.1075.2.11 raeburn 9725: next if (($rem ne '') &&
9726: (($env{"httpref.$rem"."$path/$file"} ne '') ||
9727: (ref($navmap) &&
9728: (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
9729: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
9730: ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071 raeburn 9731: $unused{$path.'/'.$file} = 1;
9732: }
9733: }
9734: }
9735: }
9736: }
1.984 raeburn 9737: }
1.987 raeburn 9738: my %currfile;
1.1075.2.35 raeburn 9739: if (($actionurl eq '/adm/portfolio') ||
9740: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 9741: my ($dirlistref,$listerror) =
9742: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
9743: if (ref($dirlistref) eq 'ARRAY') {
9744: foreach my $line (@{$dirlistref}) {
9745: my ($file_name,$rest) = split(/\&/,$line,2);
9746: $currfile{$file_name} = 1;
9747: }
1.984 raeburn 9748: }
1.987 raeburn 9749: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 9750: if (opendir(my $dir,$url)) {
1.987 raeburn 9751: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 9752: map {$currfile{$_} = 1;} @dir_list;
9753: }
1.1075.2.11 raeburn 9754: } elsif (($actionurl eq '/adm/dependencies') ||
9755: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1075.2.35 raeburn 9756: ($args->{'context'} eq 'paste')) ||
9757: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 9758: if ($env{'request.course.id'} ne '') {
9759: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
9760: if ($dir ne '') {
9761: my ($dirlistref,$listerror) =
9762: &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
9763: if (ref($dirlistref) eq 'ARRAY') {
9764: foreach my $line (@{$dirlistref}) {
9765: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
9766: $size,undef,$mtime)=split(/\&/,$line,12);
9767: unless (($testdir&$dirptr) ||
9768: ($file_name =~ /^\.\.?$/)) {
9769: $currfile{$file_name} = [$size,$mtime];
9770: }
9771: }
9772: }
9773: }
9774: }
1.984 raeburn 9775: }
9776: foreach my $file (keys(%dependencies)) {
1.1071 raeburn 9777: if (exists($currfile{$file})) {
1.987 raeburn 9778: unless ($mapping{$file} eq $file) {
9779: $pathchanges{$file} = 1;
9780: }
9781: $existing{$file} = 1;
9782: $numexisting ++;
9783: } else {
1.984 raeburn 9784: $newfiles{$file} = 1;
9785: }
9786: }
1.1071 raeburn 9787: foreach my $file (keys(%currfile)) {
9788: unless (($file eq $filename) ||
9789: ($file eq $filename.'.bak') ||
9790: ($dependencies{$file})) {
1.1075.2.11 raeburn 9791: if ($actionurl eq '/adm/dependencies') {
1.1075.2.35 raeburn 9792: unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
9793: next if (($rem ne '') &&
9794: (($env{"httpref.$rem".$file} ne '') ||
9795: (ref($navmap) &&
9796: (($navmap->getResourceByUrl($rem.$file) ne '') ||
9797: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
9798: ($navmap->getResourceByUrl($rem.$1)))))));
9799: }
1.1075.2.11 raeburn 9800: }
1.1071 raeburn 9801: $unused{$file} = 1;
9802: }
9803: }
1.1075.2.11 raeburn 9804: if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
9805: ($args->{'context'} eq 'paste')) {
9806: $counter = scalar(keys(%existing));
9807: $numpathchg = scalar(keys(%pathchanges));
9808: return ($output,$counter,$numpathchg,\%existing);
1.1075.2.35 raeburn 9809: } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
9810: (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
9811: $counter = scalar(keys(%existing));
9812: $numpathchg = scalar(keys(%pathchanges));
9813: return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1075.2.11 raeburn 9814: }
1.984 raeburn 9815: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071 raeburn 9816: if ($actionurl eq '/adm/dependencies') {
9817: next if ($embed_file =~ m{^\w+://});
9818: }
1.660 raeburn 9819: $upload_output .= &start_data_table_row().
1.1075.2.35 raeburn 9820: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
1.1071 raeburn 9821: '<span class="LC_filename">'.$embed_file.'</span>';
1.987 raeburn 9822: unless ($mapping{$embed_file} eq $embed_file) {
1.1075.2.35 raeburn 9823: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
9824: &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987 raeburn 9825: }
1.1075.2.35 raeburn 9826: $upload_output .= '</td>';
1.1071 raeburn 9827: if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) {
1.1075.2.35 raeburn 9828: $upload_output.='<td align="right">'.
9829: '<span class="LC_info LC_fontsize_medium">'.
9830: &mt("URL points to web address").'</span>';
1.987 raeburn 9831: $numremref++;
1.660 raeburn 9832: } elsif ($args->{'error_on_invalid_names'}
9833: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1075.2.35 raeburn 9834: $upload_output.='<td align="right"><span class="LC_warning">'.
9835: &mt('Invalid characters').'</span>';
1.987 raeburn 9836: $numinvalid++;
1.660 raeburn 9837: } else {
1.1075.2.35 raeburn 9838: $upload_output .= '<td>'.
9839: &embedded_file_element('upload_embedded',$counter,
1.987 raeburn 9840: $embed_file,\%mapping,
1.1071 raeburn 9841: $allfiles,$codebase,'upload');
9842: $counter ++;
9843: $numnew ++;
1.987 raeburn 9844: }
9845: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
9846: }
9847: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071 raeburn 9848: if ($actionurl eq '/adm/dependencies') {
9849: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
9850: $modify_output .= &start_data_table_row().
9851: '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
9852: '<img src="'.&icon($embed_file).'" border="0" />'.
9853: ' <span class="LC_filename">'.$embed_file.'</span></a></td>'.
9854: '<td>'.$size.'</td>'.
9855: '<td>'.$mtime.'</td>'.
9856: '<td><label><input type="checkbox" name="mod_upload_dep" '.
9857: 'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
9858: $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
9859: '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
9860: &embedded_file_element('upload_embedded',$counter,
9861: $embed_file,\%mapping,
9862: $allfiles,$codebase,'modify').
9863: '</div></td>'.
9864: &end_data_table_row()."\n";
9865: $counter ++;
9866: } else {
9867: $upload_output .= &start_data_table_row().
1.1075.2.35 raeburn 9868: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
9869: '<span class="LC_filename">'.$embed_file.'</span></td>'.
9870: '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071 raeburn 9871: &Apache::loncommon::end_data_table_row()."\n";
9872: }
9873: }
9874: my $delidx = $counter;
9875: foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
9876: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
9877: $delete_output .= &start_data_table_row().
9878: '<td><img src="'.&icon($oldfile).'" />'.
9879: ' <span class="LC_filename">'.$oldfile.'</span></td>'.
9880: '<td>'.$size.'</td>'.
9881: '<td>'.$mtime.'</td>'.
9882: '<td><label><input type="checkbox" name="del_upload_dep" '.
9883: ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
9884: &embedded_file_element('upload_embedded',$delidx,
9885: $oldfile,\%mapping,$allfiles,
9886: $codebase,'delete').'</td>'.
9887: &end_data_table_row()."\n";
9888: $numunused ++;
9889: $delidx ++;
1.987 raeburn 9890: }
9891: if ($upload_output) {
9892: $upload_output = &start_data_table().
9893: $upload_output.
9894: &end_data_table()."\n";
9895: }
1.1071 raeburn 9896: if ($modify_output) {
9897: $modify_output = &start_data_table().
9898: &start_data_table_header_row().
9899: '<th>'.&mt('File').'</th>'.
9900: '<th>'.&mt('Size (KB)').'</th>'.
9901: '<th>'.&mt('Modified').'</th>'.
9902: '<th>'.&mt('Upload replacement?').'</th>'.
9903: &end_data_table_header_row().
9904: $modify_output.
9905: &end_data_table()."\n";
9906: }
9907: if ($delete_output) {
9908: $delete_output = &start_data_table().
9909: &start_data_table_header_row().
9910: '<th>'.&mt('File').'</th>'.
9911: '<th>'.&mt('Size (KB)').'</th>'.
9912: '<th>'.&mt('Modified').'</th>'.
9913: '<th>'.&mt('Delete?').'</th>'.
9914: &end_data_table_header_row().
9915: $delete_output.
9916: &end_data_table()."\n";
9917: }
1.987 raeburn 9918: my $applies = 0;
9919: if ($numremref) {
9920: $applies ++;
9921: }
9922: if ($numinvalid) {
9923: $applies ++;
9924: }
9925: if ($numexisting) {
9926: $applies ++;
9927: }
1.1071 raeburn 9928: if ($counter || $numunused) {
1.987 raeburn 9929: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
9930: ' method="post" enctype="multipart/form-data">'."\n".
1.1071 raeburn 9931: $state.'<h3>'.$heading.'</h3>';
9932: if ($actionurl eq '/adm/dependencies') {
9933: if ($numnew) {
9934: $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
9935: '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
9936: $upload_output.'<br />'."\n";
9937: }
9938: if ($numexisting) {
9939: $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
9940: '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
9941: $modify_output.'<br />'."\n";
9942: $buttontext = &mt('Save changes');
9943: }
9944: if ($numunused) {
9945: $output .= '<h4>'.&mt('Unused files').'</h4>'.
9946: '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
9947: $delete_output.'<br />'."\n";
9948: $buttontext = &mt('Save changes');
9949: }
9950: } else {
9951: $output .= $upload_output.'<br />'."\n";
9952: }
9953: $output .= '<input type ="hidden" name="number_embedded_items" value="'.
9954: $counter.'" />'."\n";
9955: if ($actionurl eq '/adm/dependencies') {
9956: $output .= '<input type ="hidden" name="number_newemb_items" value="'.
9957: $numnew.'" />'."\n";
9958: } elsif ($actionurl eq '') {
1.987 raeburn 9959: $output .= '<input type="hidden" name="phase" value="three" />';
9960: }
9961: } elsif ($applies) {
9962: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
9963: if ($applies > 1) {
9964: $output .=
1.1075.2.35 raeburn 9965: &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987 raeburn 9966: if ($numremref) {
9967: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
9968: }
9969: if ($numinvalid) {
9970: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
9971: }
9972: if ($numexisting) {
9973: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
9974: }
9975: $output .= '</ul><br />';
9976: } elsif ($numremref) {
9977: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
9978: } elsif ($numinvalid) {
9979: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
9980: } elsif ($numexisting) {
9981: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
9982: }
9983: $output .= $upload_output.'<br />';
9984: }
9985: my ($pathchange_output,$chgcount);
1.1071 raeburn 9986: $chgcount = $counter;
1.987 raeburn 9987: if (keys(%pathchanges) > 0) {
9988: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071 raeburn 9989: if ($counter) {
1.987 raeburn 9990: $output .= &embedded_file_element('pathchange',$chgcount,
9991: $embed_file,\%mapping,
1.1071 raeburn 9992: $allfiles,$codebase,'change');
1.987 raeburn 9993: } else {
9994: $pathchange_output .=
9995: &start_data_table_row().
9996: '<td><input type ="checkbox" name="namechange" value="'.
9997: $chgcount.'" checked="checked" /></td>'.
9998: '<td>'.$mapping{$embed_file}.'</td>'.
9999: '<td>'.$embed_file.
10000: &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071 raeburn 10001: \%mapping,$allfiles,$codebase,'change').
1.987 raeburn 10002: '</td>'.&end_data_table_row();
1.660 raeburn 10003: }
1.987 raeburn 10004: $numpathchg ++;
10005: $chgcount ++;
1.660 raeburn 10006: }
10007: }
1.1075.2.35 raeburn 10008: if (($counter) || ($numunused)) {
1.987 raeburn 10009: if ($numpathchg) {
10010: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
10011: $numpathchg.'" />'."\n";
10012: }
10013: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
10014: ($actionurl eq '/adm/imsimport')) {
10015: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
10016: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
10017: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071 raeburn 10018: } elsif ($actionurl eq '/adm/dependencies') {
10019: $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987 raeburn 10020: }
1.1075.2.35 raeburn 10021: $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987 raeburn 10022: } elsif ($numpathchg) {
10023: my %pathchange = ();
10024: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
10025: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
10026: $output .= '<p>'.&mt('or').'</p>';
1.1075.2.35 raeburn 10027: }
1.987 raeburn 10028: }
1.1071 raeburn 10029: return ($output,$counter,$numpathchg);
1.987 raeburn 10030: }
10031:
10032: sub embedded_file_element {
1.1071 raeburn 10033: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987 raeburn 10034: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
10035: (ref($codebase) eq 'HASH'));
10036: my $output;
1.1071 raeburn 10037: if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987 raeburn 10038: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
10039: }
10040: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
10041: &escape($embed_file).'" />';
10042: unless (($context eq 'upload_embedded') &&
10043: ($mapping->{$embed_file} eq $embed_file)) {
10044: $output .='
10045: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
10046: }
10047: my $attrib;
10048: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
10049: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
10050: }
10051: $output .=
10052: "\n\t\t".
10053: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
10054: $attrib.'" />';
10055: if (exists($codebase->{$mapping->{$embed_file}})) {
10056: $output .=
10057: "\n\t\t".
10058: '<input name="codebase_'.$num.'" type="hidden" value="'.
10059: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 10060: }
1.987 raeburn 10061: return $output;
1.660 raeburn 10062: }
10063:
1.1071 raeburn 10064: sub get_dependency_details {
10065: my ($currfile,$currsubfile,$embed_file) = @_;
10066: my ($size,$mtime,$showsize,$showmtime);
10067: if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
10068: if ($embed_file =~ m{/}) {
10069: my ($path,$fname) = split(/\//,$embed_file);
10070: if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
10071: ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
10072: }
10073: } else {
10074: if (ref($currfile->{$embed_file}) eq 'ARRAY') {
10075: ($size,$mtime) = @{$currfile->{$embed_file}};
10076: }
10077: }
10078: $showsize = $size/1024.0;
10079: $showsize = sprintf("%.1f",$showsize);
10080: if ($mtime > 0) {
10081: $showmtime = &Apache::lonlocal::locallocaltime($mtime);
10082: }
10083: }
10084: return ($showsize,$showmtime);
10085: }
10086:
10087: sub ask_embedded_js {
10088: return <<"END";
10089: <script type="text/javascript"">
10090: // <![CDATA[
10091: function toggleBrowse(counter) {
10092: var chkboxid = document.getElementById('mod_upload_dep_'+counter);
10093: var fileid = document.getElementById('embedded_item_'+counter);
10094: var uploaddivid = document.getElementById('moduploaddep_'+counter);
10095: if (chkboxid.checked == true) {
10096: uploaddivid.style.display='block';
10097: } else {
10098: uploaddivid.style.display='none';
10099: fileid.value = '';
10100: }
10101: }
10102: // ]]>
10103: </script>
10104:
10105: END
10106: }
10107:
1.661 raeburn 10108: sub upload_embedded {
10109: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 10110: $current_disk_usage,$hiddenstate,$actionurl) = @_;
10111: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 10112: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
10113: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
10114: my $orig_uploaded_filename =
10115: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 10116: foreach my $type ('orig','ref','attrib','codebase') {
10117: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
10118: $env{'form.embedded_'.$type.'_'.$i} =
10119: &unescape($env{'form.embedded_'.$type.'_'.$i});
10120: }
10121: }
1.661 raeburn 10122: my ($path,$fname) =
10123: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
10124: # no path, whole string is fname
10125: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
10126: $fname = &Apache::lonnet::clean_filename($fname);
10127: # See if there is anything left
10128: next if ($fname eq '');
10129:
10130: # Check if file already exists as a file or directory.
10131: my ($state,$msg);
10132: if ($context eq 'portfolio') {
10133: my $port_path = $dirpath;
10134: if ($group ne '') {
10135: $port_path = "groups/$group/$port_path";
10136: }
1.987 raeburn 10137: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
10138: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 10139: $dir_root,$port_path,$disk_quota,
10140: $current_disk_usage,$uname,$udom);
10141: if ($state eq 'will_exceed_quota'
1.984 raeburn 10142: || $state eq 'file_locked') {
1.661 raeburn 10143: $output .= $msg;
10144: next;
10145: }
10146: } elsif (($context eq 'author') || ($context eq 'testbank')) {
10147: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
10148: if ($state eq 'exists') {
10149: $output .= $msg;
10150: next;
10151: }
10152: }
10153: # Check if extension is valid
10154: if (($fname =~ /\.(\w+)$/) &&
10155: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.987 raeburn 10156: $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 10157: next;
10158: } elsif (($fname =~ /\.(\w+)$/) &&
10159: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 10160: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 10161: next;
10162: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1075.2.34 raeburn 10163: $output .= &mt('Filename not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2).'<br />';
1.661 raeburn 10164: next;
10165: }
10166: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1075.2.35 raeburn 10167: my $subdir = $path;
10168: $subdir =~ s{/+$}{};
1.661 raeburn 10169: if ($context eq 'portfolio') {
1.984 raeburn 10170: my $result;
10171: if ($state eq 'existingfile') {
10172: $result=
10173: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1075.2.35 raeburn 10174: $dirpath.$env{'form.currentpath'}.$subdir);
1.661 raeburn 10175: } else {
1.984 raeburn 10176: $result=
10177: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 10178: $dirpath.
1.1075.2.35 raeburn 10179: $env{'form.currentpath'}.$subdir);
1.984 raeburn 10180: if ($result !~ m|^/uploaded/|) {
10181: $output .= '<span class="LC_error">'
10182: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
10183: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
10184: .'</span><br />';
10185: next;
10186: } else {
1.987 raeburn 10187: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
10188: $path.$fname.'</span>').'<br />';
1.984 raeburn 10189: }
1.661 raeburn 10190: }
1.1075.2.35 raeburn 10191: } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
10192: my $extendedsubdir = $dirpath.'/'.$subdir;
10193: $extendedsubdir =~ s{/+$}{};
1.987 raeburn 10194: my $result =
1.1075.2.35 raeburn 10195: &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987 raeburn 10196: if ($result !~ m|^/uploaded/|) {
10197: $output .= '<span class="LC_error">'
10198: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
10199: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
10200: .'</span><br />';
10201: next;
10202: } else {
10203: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
10204: $path.$fname.'</span>').'<br />';
1.1075.2.35 raeburn 10205: if ($context eq 'syllabus') {
10206: &Apache::lonnet::make_public_indefinitely($result);
10207: }
1.987 raeburn 10208: }
1.661 raeburn 10209: } else {
10210: # Save the file
10211: my $target = $env{'form.embedded_item_'.$i};
10212: my $fullpath = $dir_root.$dirpath.'/'.$path;
10213: my $dest = $fullpath.$fname;
10214: my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027 raeburn 10215: my @parts=split(/\//,"$dirpath/$path");
1.661 raeburn 10216: my $count;
10217: my $filepath = $dir_root;
1.1027 raeburn 10218: foreach my $subdir (@parts) {
10219: $filepath .= "/$subdir";
10220: if (!-e $filepath) {
1.661 raeburn 10221: mkdir($filepath,0770);
10222: }
10223: }
10224: my $fh;
10225: if (!open($fh,'>'.$dest)) {
10226: &Apache::lonnet::logthis('Failed to create '.$dest);
10227: $output .= '<span class="LC_error">'.
1.1071 raeburn 10228: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
10229: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 10230: '</span><br />';
10231: } else {
10232: if (!print $fh $env{'form.embedded_item_'.$i}) {
10233: &Apache::lonnet::logthis('Failed to write to '.$dest);
10234: $output .= '<span class="LC_error">'.
1.1071 raeburn 10235: &mt('An error occurred while writing the file [_1] for embedded element [_2].',
10236: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 10237: '</span><br />';
10238: } else {
1.987 raeburn 10239: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
10240: $url.'</span>').'<br />';
10241: unless ($context eq 'testbank') {
10242: $footer .= &mt('View embedded file: [_1]',
10243: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
10244: }
10245: }
10246: close($fh);
10247: }
10248: }
10249: if ($env{'form.embedded_ref_'.$i}) {
10250: $pathchange{$i} = 1;
10251: }
10252: }
10253: if ($output) {
10254: $output = '<p>'.$output.'</p>';
10255: }
10256: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
10257: $returnflag = 'ok';
1.1071 raeburn 10258: my $numpathchgs = scalar(keys(%pathchange));
10259: if ($numpathchgs > 0) {
1.987 raeburn 10260: if ($context eq 'portfolio') {
10261: $output .= '<p>'.&mt('or').'</p>';
10262: } elsif ($context eq 'testbank') {
1.1071 raeburn 10263: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
10264: '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987 raeburn 10265: $returnflag = 'modify_orightml';
10266: }
10267: }
1.1071 raeburn 10268: return ($output.$footer,$returnflag,$numpathchgs);
1.987 raeburn 10269: }
10270:
10271: sub modify_html_form {
10272: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
10273: my $end = 0;
10274: my $modifyform;
10275: if ($context eq 'upload_embedded') {
10276: return unless (ref($pathchange) eq 'HASH');
10277: if ($env{'form.number_embedded_items'}) {
10278: $end += $env{'form.number_embedded_items'};
10279: }
10280: if ($env{'form.number_pathchange_items'}) {
10281: $end += $env{'form.number_pathchange_items'};
10282: }
10283: if ($end) {
10284: for (my $i=0; $i<$end; $i++) {
10285: if ($i < $env{'form.number_embedded_items'}) {
10286: next unless($pathchange->{$i});
10287: }
10288: $modifyform .=
10289: &start_data_table_row().
10290: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
10291: 'checked="checked" /></td>'.
10292: '<td>'.$env{'form.embedded_ref_'.$i}.
10293: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
10294: &escape($env{'form.embedded_ref_'.$i}).'" />'.
10295: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
10296: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
10297: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
10298: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
10299: '<td>'.$env{'form.embedded_orig_'.$i}.
10300: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
10301: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
10302: &end_data_table_row();
1.1071 raeburn 10303: }
1.987 raeburn 10304: }
10305: } else {
10306: $modifyform = $pathchgtable;
10307: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
10308: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
10309: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
10310: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
10311: }
10312: }
10313: if ($modifyform) {
1.1071 raeburn 10314: if ($actionurl eq '/adm/dependencies') {
10315: $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
10316: }
1.987 raeburn 10317: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
10318: '<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".
10319: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
10320: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
10321: '</ol></p>'."\n".'<p>'.
10322: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
10323: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
10324: &start_data_table()."\n".
10325: &start_data_table_header_row().
10326: '<th>'.&mt('Change?').'</th>'.
10327: '<th>'.&mt('Current reference').'</th>'.
10328: '<th>'.&mt('Required reference').'</th>'.
10329: &end_data_table_header_row()."\n".
10330: $modifyform.
10331: &end_data_table().'<br />'."\n".$hiddenstate.
10332: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
10333: '</form>'."\n";
10334: }
10335: return;
10336: }
10337:
10338: sub modify_html_refs {
1.1075.2.35 raeburn 10339: my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987 raeburn 10340: my $container;
10341: if ($context eq 'portfolio') {
10342: $container = $env{'form.container'};
10343: } elsif ($context eq 'coursedoc') {
10344: $container = $env{'form.primaryurl'};
1.1071 raeburn 10345: } elsif ($context eq 'manage_dependencies') {
10346: (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
10347: $container = "/$container";
1.1075.2.35 raeburn 10348: } elsif ($context eq 'syllabus') {
10349: $container = $url;
1.987 raeburn 10350: } else {
1.1027 raeburn 10351: $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987 raeburn 10352: }
10353: my (%allfiles,%codebase,$output,$content);
10354: my @changes = &get_env_multiple('form.namechange');
1.1075.2.35 raeburn 10355: unless ((@changes > 0) || ($context eq 'syllabus')) {
1.1071 raeburn 10356: if (wantarray) {
10357: return ('',0,0);
10358: } else {
10359: return;
10360: }
10361: }
10362: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1075.2.35 raeburn 10363: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071 raeburn 10364: unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
10365: if (wantarray) {
10366: return ('',0,0);
10367: } else {
10368: return;
10369: }
10370: }
1.987 raeburn 10371: $content = &Apache::lonnet::getfile($container);
1.1071 raeburn 10372: if ($content eq '-1') {
10373: if (wantarray) {
10374: return ('',0,0);
10375: } else {
10376: return;
10377: }
10378: }
1.987 raeburn 10379: } else {
1.1071 raeburn 10380: unless ($container =~ /^\Q$dir_root\E/) {
10381: if (wantarray) {
10382: return ('',0,0);
10383: } else {
10384: return;
10385: }
10386: }
1.987 raeburn 10387: if (open(my $fh,"<$container")) {
10388: $content = join('', <$fh>);
10389: close($fh);
10390: } else {
1.1071 raeburn 10391: if (wantarray) {
10392: return ('',0,0);
10393: } else {
10394: return;
10395: }
1.987 raeburn 10396: }
10397: }
10398: my ($count,$codebasecount) = (0,0);
10399: my $mm = new File::MMagic;
10400: my $mime_type = $mm->checktype_contents($content);
10401: if ($mime_type eq 'text/html') {
10402: my $parse_result =
10403: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
10404: \%codebase,\$content);
10405: if ($parse_result eq 'ok') {
10406: foreach my $i (@changes) {
10407: my $orig = &unescape($env{'form.embedded_orig_'.$i});
10408: my $ref = &unescape($env{'form.embedded_ref_'.$i});
10409: if ($allfiles{$ref}) {
10410: my $newname = $orig;
10411: my ($attrib_regexp,$codebase);
1.1006 raeburn 10412: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 10413: if ($attrib_regexp =~ /:/) {
10414: $attrib_regexp =~ s/\:/|/g;
10415: }
10416: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
10417: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
10418: $count += $numchg;
1.1075.2.35 raeburn 10419: $allfiles{$newname} = $allfiles{$ref};
1.987 raeburn 10420: }
10421: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 10422: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 10423: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
10424: $codebasecount ++;
10425: }
10426: }
10427: }
1.1075.2.35 raeburn 10428: my $skiprewrites;
1.987 raeburn 10429: if ($count || $codebasecount) {
10430: my $saveresult;
1.1071 raeburn 10431: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1075.2.35 raeburn 10432: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987 raeburn 10433: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
10434: if ($url eq $container) {
10435: my ($fname) = ($container =~ m{/([^/]+)$});
10436: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
10437: $count,'<span class="LC_filename">'.
1.1071 raeburn 10438: $fname.'</span>').'</p>';
1.987 raeburn 10439: } else {
10440: $output = '<p class="LC_error">'.
10441: &mt('Error: update failed for: [_1].',
10442: '<span class="LC_filename">'.
10443: $container.'</span>').'</p>';
10444: }
1.1075.2.35 raeburn 10445: if ($context eq 'syllabus') {
10446: unless ($saveresult eq 'ok') {
10447: $skiprewrites = 1;
10448: }
10449: }
1.987 raeburn 10450: } else {
10451: if (open(my $fh,">$container")) {
10452: print $fh $content;
10453: close($fh);
10454: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
10455: $count,'<span class="LC_filename">'.
10456: $container.'</span>').'</p>';
1.661 raeburn 10457: } else {
1.987 raeburn 10458: $output = '<p class="LC_error">'.
10459: &mt('Error: could not update [_1].',
10460: '<span class="LC_filename">'.
10461: $container.'</span>').'</p>';
1.661 raeburn 10462: }
10463: }
10464: }
1.1075.2.35 raeburn 10465: if (($context eq 'syllabus') && (!$skiprewrites)) {
10466: my ($actionurl,$state);
10467: $actionurl = "/public/$udom/$uname/syllabus";
10468: my ($ignore,$num,$numpathchanges,$existing,$mapping) =
10469: &ask_for_embedded_content($actionurl,$state,\%allfiles,
10470: \%codebase,
10471: {'context' => 'rewrites',
10472: 'ignore_remote_references' => 1,});
10473: if (ref($mapping) eq 'HASH') {
10474: my $rewrites = 0;
10475: foreach my $key (keys(%{$mapping})) {
10476: next if ($key =~ m{^https?://});
10477: my $ref = $mapping->{$key};
10478: my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
10479: my $attrib;
10480: if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
10481: $attrib = join('|',@{$allfiles{$mapping->{$key}}});
10482: }
10483: if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
10484: my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
10485: $rewrites += $numchg;
10486: }
10487: }
10488: if ($rewrites) {
10489: my $saveresult;
10490: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
10491: if ($url eq $container) {
10492: my ($fname) = ($container =~ m{/([^/]+)$});
10493: $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
10494: $count,'<span class="LC_filename">'.
10495: $fname.'</span>').'</p>';
10496: } else {
10497: $output .= '<p class="LC_error">'.
10498: &mt('Error: could not update links in [_1].',
10499: '<span class="LC_filename">'.
10500: $container.'</span>').'</p>';
10501:
10502: }
10503: }
10504: }
10505: }
1.987 raeburn 10506: } else {
10507: &logthis('Failed to parse '.$container.
10508: ' to modify references: '.$parse_result);
1.661 raeburn 10509: }
10510: }
1.1071 raeburn 10511: if (wantarray) {
10512: return ($output,$count,$codebasecount);
10513: } else {
10514: return $output;
10515: }
1.661 raeburn 10516: }
10517:
10518: sub check_for_existing {
10519: my ($path,$fname,$element) = @_;
10520: my ($state,$msg);
10521: if (-d $path.'/'.$fname) {
10522: $state = 'exists';
10523: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
10524: } elsif (-e $path.'/'.$fname) {
10525: $state = 'exists';
10526: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
10527: }
10528: if ($state eq 'exists') {
10529: $msg = '<span class="LC_error">'.$msg.'</span><br />';
10530: }
10531: return ($state,$msg);
10532: }
10533:
10534: sub check_for_upload {
10535: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
10536: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 10537: my $filesize = length($env{'form.'.$element});
10538: if (!$filesize) {
10539: my $msg = '<span class="LC_error">'.
10540: &mt('Unable to upload [_1]. (size = [_2] bytes)',
10541: '<span class="LC_filename">'.$fname.'</span>',
10542: $filesize).'<br />'.
1.1007 raeburn 10543: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 10544: '</span>';
10545: return ('zero_bytes',$msg);
10546: }
10547: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 10548: my $getpropath = 1;
1.1021 raeburn 10549: my ($dirlistref,$listerror) =
10550: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 10551: my $found_file = 0;
10552: my $locked_file = 0;
1.991 raeburn 10553: my @lockers;
10554: my $navmap;
10555: if ($env{'request.course.id'}) {
10556: $navmap = Apache::lonnavmaps::navmap->new();
10557: }
1.1021 raeburn 10558: if (ref($dirlistref) eq 'ARRAY') {
10559: foreach my $line (@{$dirlistref}) {
10560: my ($file_name,$rest)=split(/\&/,$line,2);
10561: if ($file_name eq $fname){
10562: $file_name = $path.$file_name;
10563: if ($group ne '') {
10564: $file_name = $group.$file_name;
10565: }
10566: $found_file = 1;
10567: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
10568: foreach my $lock (@lockers) {
10569: if (ref($lock) eq 'ARRAY') {
10570: my ($symb,$crsid) = @{$lock};
10571: if ($crsid eq $env{'request.course.id'}) {
10572: if (ref($navmap)) {
10573: my $res = $navmap->getBySymb($symb);
10574: foreach my $part (@{$res->parts()}) {
10575: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
10576: unless (($slot_status == $res->RESERVED) ||
10577: ($slot_status == $res->RESERVED_LOCATION)) {
10578: $locked_file = 1;
10579: }
1.991 raeburn 10580: }
1.1021 raeburn 10581: } else {
10582: $locked_file = 1;
1.991 raeburn 10583: }
10584: } else {
10585: $locked_file = 1;
10586: }
10587: }
1.1021 raeburn 10588: }
10589: } else {
10590: my @info = split(/\&/,$rest);
10591: my $currsize = $info[6]/1000;
10592: if ($currsize < $filesize) {
10593: my $extra = $filesize - $currsize;
10594: if (($current_disk_usage + $extra) > $disk_quota) {
10595: my $msg = '<span class="LC_error">'.
10596: &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.',
10597: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</span>'.
10598: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
10599: $disk_quota,$current_disk_usage);
10600: return ('will_exceed_quota',$msg);
10601: }
1.984 raeburn 10602: }
10603: }
1.661 raeburn 10604: }
10605: }
10606: }
10607: if (($current_disk_usage + $filesize) > $disk_quota){
10608: my $msg = '<span class="LC_error">'.
10609: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
10610: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
10611: return ('will_exceed_quota',$msg);
10612: } elsif ($found_file) {
10613: if ($locked_file) {
10614: my $msg = '<span class="LC_error">';
10615: $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>');
10616: $msg .= '</span><br />';
10617: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
10618: return ('file_locked',$msg);
10619: } else {
10620: my $msg = '<span class="LC_error">';
1.984 raeburn 10621: $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 10622: $msg .= '</span>';
1.984 raeburn 10623: return ('existingfile',$msg);
1.661 raeburn 10624: }
10625: }
10626: }
10627:
1.987 raeburn 10628: sub check_for_traversal {
10629: my ($path,$url,$toplevel) = @_;
10630: my @parts=split(/\//,$path);
10631: my $cleanpath;
10632: my $fullpath = $url;
10633: for (my $i=0;$i<@parts;$i++) {
10634: next if ($parts[$i] eq '.');
10635: if ($parts[$i] eq '..') {
10636: $fullpath =~ s{([^/]+/)$}{};
10637: } else {
10638: $fullpath .= $parts[$i].'/';
10639: }
10640: }
10641: if ($fullpath =~ /^\Q$url\E(.*)$/) {
10642: $cleanpath = $1;
10643: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
10644: my $curr_toprel = $1;
10645: my @parts = split(/\//,$curr_toprel);
10646: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
10647: my @urlparts = split(/\//,$url_toprel);
10648: my $doubledots;
10649: my $startdiff = -1;
10650: for (my $i=0; $i<@urlparts; $i++) {
10651: if ($startdiff == -1) {
10652: unless ($urlparts[$i] eq $parts[$i]) {
10653: $startdiff = $i;
10654: $doubledots .= '../';
10655: }
10656: } else {
10657: $doubledots .= '../';
10658: }
10659: }
10660: if ($startdiff > -1) {
10661: $cleanpath = $doubledots;
10662: for (my $i=$startdiff; $i<@parts; $i++) {
10663: $cleanpath .= $parts[$i].'/';
10664: }
10665: }
10666: }
10667: $cleanpath =~ s{(/)$}{};
10668: return $cleanpath;
10669: }
1.31 albertel 10670:
1.1053 raeburn 10671: sub is_archive_file {
10672: my ($mimetype) = @_;
10673: if (($mimetype eq 'application/octet-stream') ||
10674: ($mimetype eq 'application/x-stuffit') ||
10675: ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
10676: return 1;
10677: }
10678: return;
10679: }
10680:
10681: sub decompress_form {
1.1065 raeburn 10682: my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053 raeburn 10683: my %lt = &Apache::lonlocal::texthash (
10684: this => 'This file is an archive file.',
1.1067 raeburn 10685: camt => 'This file is a Camtasia archive file.',
1.1065 raeburn 10686: itsc => 'Its contents are as follows:',
1.1053 raeburn 10687: youm => 'You may wish to extract its contents.',
10688: extr => 'Extract contents',
1.1067 raeburn 10689: auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
10690: proa => 'Process automatically?',
1.1053 raeburn 10691: yes => 'Yes',
10692: no => 'No',
1.1067 raeburn 10693: fold => 'Title for folder containing movie',
10694: movi => 'Title for page containing embedded movie',
1.1053 raeburn 10695: );
1.1065 raeburn 10696: my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067 raeburn 10697: my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065 raeburn 10698: my $info = &list_archive_contents($fileloc,\@paths);
10699: if (@paths) {
10700: foreach my $path (@paths) {
10701: $path =~ s{^/}{};
1.1067 raeburn 10702: if ($path =~ m{^([^/]+)/$}) {
10703: $topdir = $1;
10704: }
1.1065 raeburn 10705: if ($path =~ m{^([^/]+)/}) {
10706: $toplevel{$1} = $path;
10707: } else {
10708: $toplevel{$path} = $path;
10709: }
10710: }
10711: }
1.1067 raeburn 10712: if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
10713: my @camtasia = ("$topdir/","$topdir/index.html",
10714: "$topdir/media/",
10715: "$topdir/media/$topdir.mp4",
10716: "$topdir/media/FirstFrame.png",
10717: "$topdir/media/player.swf",
10718: "$topdir/media/swfobject.js",
10719: "$topdir/media/expressInstall.swf");
10720: my @diffs = &compare_arrays(\@paths,\@camtasia);
10721: if (@diffs == 0) {
10722: $is_camtasia = 1;
10723: }
10724: }
10725: my $output;
10726: if ($is_camtasia) {
10727: $output = <<"ENDCAM";
10728: <script type="text/javascript" language="Javascript">
10729: // <![CDATA[
10730:
10731: function camtasiaToggle() {
10732: for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
10733: if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
10734: if (document.uploaded_decompress.autoextract_camtasia[i].value == 1) {
10735:
10736: document.getElementById('camtasia_titles').style.display='block';
10737: } else {
10738: document.getElementById('camtasia_titles').style.display='none';
10739: }
10740: }
10741: }
10742: return;
10743: }
10744:
10745: // ]]>
10746: </script>
10747: <p>$lt{'camt'}</p>
10748: ENDCAM
1.1065 raeburn 10749: } else {
1.1067 raeburn 10750: $output = '<p>'.$lt{'this'};
10751: if ($info eq '') {
10752: $output .= ' '.$lt{'youm'}.'</p>'."\n";
10753: } else {
10754: $output .= ' '.$lt{'itsc'}.'</p>'."\n".
10755: '<div><pre>'.$info.'</pre></div>';
10756: }
1.1065 raeburn 10757: }
1.1067 raeburn 10758: $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065 raeburn 10759: my $duplicates;
10760: my $num = 0;
10761: if (ref($dirlist) eq 'ARRAY') {
10762: foreach my $item (@{$dirlist}) {
10763: if (ref($item) eq 'ARRAY') {
10764: if (exists($toplevel{$item->[0]})) {
10765: $duplicates .=
10766: &start_data_table_row().
10767: '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
10768: 'value="0" checked="checked" />'.&mt('No').'</label>'.
10769: ' <label><input type="radio" name="archive_overwrite_'.$num.'" '.
10770: 'value="1" />'.&mt('Yes').'</label>'.
10771: '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
10772: '<td>'.$item->[0].'</td>';
10773: if ($item->[2]) {
10774: $duplicates .= '<td>'.&mt('Directory').'</td>';
10775: } else {
10776: $duplicates .= '<td>'.&mt('File').'</td>';
10777: }
10778: $duplicates .= '<td>'.$item->[3].'</td>'.
10779: '<td>'.
10780: &Apache::lonlocal::locallocaltime($item->[4]).
10781: '</td>'.
10782: &end_data_table_row();
10783: $num ++;
10784: }
10785: }
10786: }
10787: }
10788: my $itemcount;
10789: if (@paths > 0) {
10790: $itemcount = scalar(@paths);
10791: } else {
10792: $itemcount = 1;
10793: }
1.1067 raeburn 10794: if ($is_camtasia) {
10795: $output .= $lt{'auto'}.'<br />'.
10796: '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
10797: '<input type="radio" name="autoextract_camtasia" value="1" onclick="javascript:camtasiaToggle();" checked="checked" />'.
10798: $lt{'yes'}.'</label> <label>'.
10799: '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
10800: $lt{'no'}.'</label></span><br />'.
10801: '<div id="camtasia_titles" style="display:block">'.
10802: &Apache::lonhtmlcommon::start_pick_box().
10803: &Apache::lonhtmlcommon::row_title($lt{'fold'}).
10804: '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
10805: &Apache::lonhtmlcommon::row_closure().
10806: &Apache::lonhtmlcommon::row_title($lt{'movi'}).
10807: '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
10808: &Apache::lonhtmlcommon::row_closure(1).
10809: &Apache::lonhtmlcommon::end_pick_box().
10810: '</div>';
10811: }
1.1065 raeburn 10812: $output .=
10813: '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067 raeburn 10814: '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
10815: "\n";
1.1065 raeburn 10816: if ($duplicates ne '') {
10817: $output .= '<p><span class="LC_warning">'.
10818: &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.
10819: &start_data_table().
10820: &start_data_table_header_row().
10821: '<th>'.&mt('Overwrite?').'</th>'.
10822: '<th>'.&mt('Name').'</th>'.
10823: '<th>'.&mt('Type').'</th>'.
10824: '<th>'.&mt('Size').'</th>'.
10825: '<th>'.&mt('Last modified').'</th>'.
10826: &end_data_table_header_row().
10827: $duplicates.
10828: &end_data_table().
10829: '</p>';
10830: }
1.1067 raeburn 10831: $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053 raeburn 10832: if (ref($hiddenelements) eq 'HASH') {
10833: foreach my $hidden (sort(keys(%{$hiddenelements}))) {
10834: $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
10835: }
10836: }
10837: $output .= <<"END";
1.1067 raeburn 10838: <br />
1.1053 raeburn 10839: <input type="submit" name="decompress" value="$lt{'extr'}" />
10840: </form>
10841: $noextract
10842: END
10843: return $output;
10844: }
10845:
1.1065 raeburn 10846: sub decompression_utility {
10847: my ($program) = @_;
10848: my @utilities = ('tar','gunzip','bunzip2','unzip');
10849: my $location;
10850: if (grep(/^\Q$program\E$/,@utilities)) {
10851: foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
10852: '/usr/sbin/') {
10853: if (-x $dir.$program) {
10854: $location = $dir.$program;
10855: last;
10856: }
10857: }
10858: }
10859: return $location;
10860: }
10861:
10862: sub list_archive_contents {
10863: my ($file,$pathsref) = @_;
10864: my (@cmd,$output);
10865: my $needsregexp;
10866: if ($file =~ /\.zip$/) {
10867: @cmd = (&decompression_utility('unzip'),"-l");
10868: $needsregexp = 1;
10869: } elsif (($file =~ m/\.tar\.gz$/) ||
10870: ($file =~ /\.tgz$/)) {
10871: @cmd = (&decompression_utility('tar'),"-ztf");
10872: } elsif ($file =~ /\.tar\.bz2$/) {
10873: @cmd = (&decompression_utility('tar'),"-jtf");
10874: } elsif ($file =~ m|\.tar$|) {
10875: @cmd = (&decompression_utility('tar'),"-tf");
10876: }
10877: if (@cmd) {
10878: undef($!);
10879: undef($@);
10880: if (open(my $fh,"-|", @cmd, $file)) {
10881: while (my $line = <$fh>) {
10882: $output .= $line;
10883: chomp($line);
10884: my $item;
10885: if ($needsregexp) {
10886: ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/);
10887: } else {
10888: $item = $line;
10889: }
10890: if ($item ne '') {
10891: unless (grep(/^\Q$item\E$/,@{$pathsref})) {
10892: push(@{$pathsref},$item);
10893: }
10894: }
10895: }
10896: close($fh);
10897: }
10898: }
10899: return $output;
10900: }
10901:
1.1053 raeburn 10902: sub decompress_uploaded_file {
10903: my ($file,$dir) = @_;
10904: &Apache::lonnet::appenv({'cgi.file' => $file});
10905: &Apache::lonnet::appenv({'cgi.dir' => $dir});
10906: my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
10907: my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
10908: my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
10909: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
10910: my $decompressed = $env{'cgi.decompressed'};
10911: &Apache::lonnet::delenv('cgi.file');
10912: &Apache::lonnet::delenv('cgi.dir');
10913: &Apache::lonnet::delenv('cgi.decompressed');
10914: return ($decompressed,$result);
10915: }
10916:
1.1055 raeburn 10917: sub process_decompression {
10918: my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
10919: my ($dir,$error,$warning,$output);
10920: if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/) {
1.1075.2.34 raeburn 10921: $error = &mt('Filename not a supported archive file type.').
10922: '<br />'.&mt('Filename should end with one of: [_1].',
1.1055 raeburn 10923: '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
10924: } else {
10925: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
10926: if ($docuhome eq 'no_host') {
10927: $error = &mt('Could not determine home server for course.');
10928: } else {
10929: my @ids=&Apache::lonnet::current_machine_ids();
10930: my $currdir = "$dir_root/$destination";
10931: if (grep(/^\Q$docuhome\E$/,@ids)) {
10932: $dir = &LONCAPA::propath($docudom,$docuname).
10933: "$dir_root/$destination";
10934: } else {
10935: $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
10936: "$dir_root/$docudom/$docuname/$destination";
10937: unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
10938: $error = &mt('Archive file not found.');
10939: }
10940: }
1.1065 raeburn 10941: my (@to_overwrite,@to_skip);
10942: if ($env{'form.archive_overwrite_total'} > 0) {
10943: my $total = $env{'form.archive_overwrite_total'};
10944: for (my $i=0; $i<$total; $i++) {
10945: if ($env{'form.archive_overwrite_'.$i} == 1) {
10946: push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
10947: } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
10948: push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
10949: }
10950: }
10951: }
10952: my $numskip = scalar(@to_skip);
10953: if (($numskip > 0) &&
10954: ($numskip == $env{'form.archive_itemcount'})) {
10955: $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');
10956: } elsif ($dir eq '') {
1.1055 raeburn 10957: $error = &mt('Directory containing archive file unavailable.');
10958: } elsif (!$error) {
1.1065 raeburn 10959: my ($decompressed,$display);
10960: if ($numskip > 0) {
10961: my $tempdir = time.'_'.$$.int(rand(10000));
10962: mkdir("$dir/$tempdir",0755);
10963: system("mv $dir/$file $dir/$tempdir/$file");
10964: ($decompressed,$display) =
10965: &decompress_uploaded_file($file,"$dir/$tempdir");
10966: foreach my $item (@to_skip) {
10967: if (($item ne '') && ($item !~ /\.\./)) {
10968: if (-f "$dir/$tempdir/$item") {
10969: unlink("$dir/$tempdir/$item");
10970: } elsif (-d "$dir/$tempdir/$item") {
10971: system("rm -rf $dir/$tempdir/$item");
10972: }
10973: }
10974: }
10975: system("mv $dir/$tempdir/* $dir");
10976: rmdir("$dir/$tempdir");
10977: } else {
10978: ($decompressed,$display) =
10979: &decompress_uploaded_file($file,$dir);
10980: }
1.1055 raeburn 10981: if ($decompressed eq 'ok') {
1.1065 raeburn 10982: $output = '<p class="LC_info">'.
10983: &mt('Files extracted successfully from archive.').
10984: '</p>'."\n";
1.1055 raeburn 10985: my ($warning,$result,@contents);
10986: my ($newdirlistref,$newlisterror) =
10987: &Apache::lonnet::dirlist($currdir,$docudom,
10988: $docuname,1);
10989: my (%is_dir,%changes,@newitems);
10990: my $dirptr = 16384;
1.1065 raeburn 10991: if (ref($newdirlistref) eq 'ARRAY') {
1.1055 raeburn 10992: foreach my $dir_line (@{$newdirlistref}) {
10993: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1065 raeburn 10994: unless (($item =~ /^\.+$/) || ($item eq $file) ||
10995: ((@to_skip > 0) && (grep(/^\Q$item\E$/,@to_skip)))) {
1.1055 raeburn 10996: push(@newitems,$item);
10997: if ($dirptr&$testdir) {
10998: $is_dir{$item} = 1;
10999: }
11000: $changes{$item} = 1;
11001: }
11002: }
11003: }
11004: if (keys(%changes) > 0) {
11005: foreach my $item (sort(@newitems)) {
11006: if ($changes{$item}) {
11007: push(@contents,$item);
11008: }
11009: }
11010: }
11011: if (@contents > 0) {
1.1067 raeburn 11012: my $wantform;
11013: unless ($env{'form.autoextract_camtasia'}) {
11014: $wantform = 1;
11015: }
1.1056 raeburn 11016: my (%children,%parent,%dirorder,%titles);
1.1055 raeburn 11017: my ($count,$datatable) = &get_extracted($docudom,$docuname,
11018: $currdir,\%is_dir,
11019: \%children,\%parent,
1.1056 raeburn 11020: \@contents,\%dirorder,
11021: \%titles,$wantform);
1.1055 raeburn 11022: if ($datatable ne '') {
11023: $output .= &archive_options_form('decompressed',$datatable,
11024: $count,$hiddenelem);
1.1065 raeburn 11025: my $startcount = 6;
1.1055 raeburn 11026: $output .= &archive_javascript($startcount,$count,
1.1056 raeburn 11027: \%titles,\%children);
1.1055 raeburn 11028: }
1.1067 raeburn 11029: if ($env{'form.autoextract_camtasia'}) {
11030: my %displayed;
11031: my $total = 1;
11032: $env{'form.archive_directory'} = [];
11033: foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
11034: my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
11035: $path =~ s{/$}{};
11036: my $item;
11037: if ($path ne '') {
11038: $item = "$path/$titles{$i}";
11039: } else {
11040: $item = $titles{$i};
11041: }
11042: $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
11043: if ($item eq $contents[0]) {
11044: push(@{$env{'form.archive_directory'}},$i);
11045: $env{'form.archive_'.$i} = 'display';
11046: $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
11047: $displayed{'folder'} = $i;
11048: } elsif ($item eq "$contents[0]/index.html") {
11049: $env{'form.archive_'.$i} = 'display';
11050: $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
11051: $displayed{'web'} = $i;
11052: } else {
11053: if ($item eq "$contents[0]/media") {
11054: push(@{$env{'form.archive_directory'}},$i);
11055: }
11056: $env{'form.archive_'.$i} = 'dependency';
11057: }
11058: $total ++;
11059: }
11060: for (my $i=1; $i<$total; $i++) {
11061: next if ($i == $displayed{'web'});
11062: next if ($i == $displayed{'folder'});
11063: $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
11064: }
11065: $env{'form.phase'} = 'decompress_cleanup';
11066: $env{'form.archivedelete'} = 1;
11067: $env{'form.archive_count'} = $total-1;
11068: $output .=
11069: &process_extracted_files('coursedocs',$docudom,
11070: $docuname,$destination,
11071: $dir_root,$hiddenelem);
11072: }
1.1055 raeburn 11073: } else {
11074: $warning = &mt('No new items extracted from archive file.');
11075: }
11076: } else {
11077: $output = $display;
11078: $error = &mt('An error occurred during extraction from the archive file.');
11079: }
11080: }
11081: }
11082: }
11083: if ($error) {
11084: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
11085: $error.'</p>'."\n";
11086: }
11087: if ($warning) {
11088: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
11089: }
11090: return $output;
11091: }
11092:
11093: sub get_extracted {
1.1056 raeburn 11094: my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
11095: $titles,$wantform) = @_;
1.1055 raeburn 11096: my $count = 0;
11097: my $depth = 0;
11098: my $datatable;
1.1056 raeburn 11099: my @hierarchy;
1.1055 raeburn 11100: return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056 raeburn 11101: (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
11102: (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055 raeburn 11103: foreach my $item (@{$contents}) {
11104: $count ++;
1.1056 raeburn 11105: @{$dirorder->{$count}} = @hierarchy;
11106: $titles->{$count} = $item;
1.1055 raeburn 11107: &archive_hierarchy($depth,$count,$parent,$children);
11108: if ($wantform) {
11109: $datatable .= &archive_row($is_dir->{$item},$item,
11110: $currdir,$depth,$count);
11111: }
11112: if ($is_dir->{$item}) {
11113: $depth ++;
1.1056 raeburn 11114: push(@hierarchy,$count);
11115: $parent->{$depth} = $count;
1.1055 raeburn 11116: $datatable .=
11117: &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056 raeburn 11118: \$depth,\$count,\@hierarchy,$dirorder,
11119: $children,$parent,$titles,$wantform);
1.1055 raeburn 11120: $depth --;
1.1056 raeburn 11121: pop(@hierarchy);
1.1055 raeburn 11122: }
11123: }
11124: return ($count,$datatable);
11125: }
11126:
11127: sub recurse_extracted_archive {
1.1056 raeburn 11128: my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
11129: $children,$parent,$titles,$wantform) = @_;
1.1055 raeburn 11130: my $result='';
1.1056 raeburn 11131: unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
11132: (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
11133: (ref($dirorder) eq 'HASH')) {
1.1055 raeburn 11134: return $result;
11135: }
11136: my $dirptr = 16384;
11137: my ($newdirlistref,$newlisterror) =
11138: &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
11139: if (ref($newdirlistref) eq 'ARRAY') {
11140: foreach my $dir_line (@{$newdirlistref}) {
11141: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
11142: unless ($item =~ /^\.+$/) {
11143: $$count ++;
1.1056 raeburn 11144: @{$dirorder->{$$count}} = @{$hierarchy};
11145: $titles->{$$count} = $item;
1.1055 raeburn 11146: &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056 raeburn 11147:
1.1055 raeburn 11148: my $is_dir;
11149: if ($dirptr&$testdir) {
11150: $is_dir = 1;
11151: }
11152: if ($wantform) {
11153: $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
11154: }
11155: if ($is_dir) {
11156: $$depth ++;
1.1056 raeburn 11157: push(@{$hierarchy},$$count);
11158: $parent->{$$depth} = $$count;
1.1055 raeburn 11159: $result .=
11160: &recurse_extracted_archive("$currdir/$item",$docudom,
11161: $docuname,$depth,$count,
1.1056 raeburn 11162: $hierarchy,$dirorder,$children,
11163: $parent,$titles,$wantform);
1.1055 raeburn 11164: $$depth --;
1.1056 raeburn 11165: pop(@{$hierarchy});
1.1055 raeburn 11166: }
11167: }
11168: }
11169: }
11170: return $result;
11171: }
11172:
11173: sub archive_hierarchy {
11174: my ($depth,$count,$parent,$children) =@_;
11175: if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
11176: if (exists($parent->{$depth})) {
11177: $children->{$parent->{$depth}} .= $count.':';
11178: }
11179: }
11180: return;
11181: }
11182:
11183: sub archive_row {
11184: my ($is_dir,$item,$currdir,$depth,$count) = @_;
11185: my ($name) = ($item =~ m{([^/]+)$});
11186: my %choices = &Apache::lonlocal::texthash (
1.1059 raeburn 11187: 'display' => 'Add as file',
1.1055 raeburn 11188: 'dependency' => 'Include as dependency',
11189: 'discard' => 'Discard',
11190: );
11191: if ($is_dir) {
1.1059 raeburn 11192: $choices{'display'} = &mt('Add as folder');
1.1055 raeburn 11193: }
1.1056 raeburn 11194: my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
11195: my $offset = 0;
1.1055 raeburn 11196: foreach my $action ('display','dependency','discard') {
1.1056 raeburn 11197: $offset ++;
1.1065 raeburn 11198: if ($action ne 'display') {
11199: $offset ++;
11200: }
1.1055 raeburn 11201: $output .= '<td><span class="LC_nobreak">'.
11202: '<label><input type="radio" name="archive_'.$count.
11203: '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
11204: my $text = $choices{$action};
11205: if ($is_dir) {
11206: $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
11207: if ($action eq 'display') {
1.1059 raeburn 11208: $text = &mt('Add as folder');
1.1055 raeburn 11209: }
1.1056 raeburn 11210: } else {
11211: $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
11212:
11213: }
11214: $output .= ' /> '.$choices{$action}.'</label></span>';
11215: if ($action eq 'dependency') {
11216: $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
11217: &mt('Used by:').' <select name="archive_dependent_on_'.$count.'" '.
11218: 'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
11219: '<option value=""></option>'."\n".
11220: '</select>'."\n".
11221: '</div>';
1.1059 raeburn 11222: } elsif ($action eq 'display') {
11223: $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
11224: &mt('Title:').' <input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
11225: '</div>';
1.1055 raeburn 11226: }
1.1056 raeburn 11227: $output .= '</td>';
1.1055 raeburn 11228: }
11229: $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
11230: &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.(' ' x 2);
11231: for (my $i=0; $i<$depth; $i++) {
11232: $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
11233: }
11234: if ($is_dir) {
11235: $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" /> '."\n".
11236: '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
11237: } else {
11238: $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
11239: }
11240: $output .= ' '.$name.'</td>'."\n".
11241: &end_data_table_row();
11242: return $output;
11243: }
11244:
11245: sub archive_options_form {
1.1065 raeburn 11246: my ($form,$display,$count,$hiddenelem) = @_;
11247: my %lt = &Apache::lonlocal::texthash(
11248: perm => 'Permanently remove archive file?',
11249: hows => 'How should each extracted item be incorporated in the course?',
11250: cont => 'Content actions for all',
11251: addf => 'Add as folder/file',
11252: incd => 'Include as dependency for a displayed file',
11253: disc => 'Discard',
11254: no => 'No',
11255: yes => 'Yes',
11256: save => 'Save',
11257: );
11258: my $output = <<"END";
11259: <form name="$form" method="post" action="">
11260: <p><span class="LC_nobreak">$lt{'perm'}
11261: <label>
11262: <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
11263: </label>
11264:
11265: <label>
11266: <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
11267: </span>
11268: </p>
11269: <input type="hidden" name="phase" value="decompress_cleanup" />
11270: <br />$lt{'hows'}
11271: <div class="LC_columnSection">
11272: <fieldset>
11273: <legend>$lt{'cont'}</legend>
11274: <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" />
11275: <input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
11276: <input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
11277: </fieldset>
11278: </div>
11279: END
11280: return $output.
1.1055 raeburn 11281: &start_data_table()."\n".
1.1065 raeburn 11282: $display."\n".
1.1055 raeburn 11283: &end_data_table()."\n".
11284: '<input type="hidden" name="archive_count" value="'.$count.'" />'.
11285: $hiddenelem.
1.1065 raeburn 11286: '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055 raeburn 11287: '</form>';
11288: }
11289:
11290: sub archive_javascript {
1.1056 raeburn 11291: my ($startcount,$numitems,$titles,$children) = @_;
11292: return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059 raeburn 11293: my $maintitle = $env{'form.comment'};
1.1055 raeburn 11294: my $scripttag = <<START;
11295: <script type="text/javascript">
11296: // <![CDATA[
11297:
11298: function checkAll(form,prefix) {
11299: var idstr = new RegExp("^archive_"+prefix+"_\\\\d+\$");
11300: for (var i=0; i < form.elements.length; i++) {
11301: var id = form.elements[i].id;
11302: if ((id != '') && (id != undefined)) {
11303: if (idstr.test(id)) {
11304: if (form.elements[i].type == 'radio') {
11305: form.elements[i].checked = true;
1.1056 raeburn 11306: var nostart = i-$startcount;
1.1059 raeburn 11307: var offset = nostart%7;
11308: var count = (nostart-offset)/7;
1.1056 raeburn 11309: dependencyCheck(form,count,offset);
1.1055 raeburn 11310: }
11311: }
11312: }
11313: }
11314: }
11315:
11316: function propagateCheck(form,count) {
11317: if (count > 0) {
1.1059 raeburn 11318: var startelement = $startcount + ((count-1) * 7);
11319: for (var j=1; j<6; j++) {
11320: if ((j != 2) && (j != 4)) {
1.1056 raeburn 11321: var item = startelement + j;
11322: if (form.elements[item].type == 'radio') {
11323: if (form.elements[item].checked) {
11324: containerCheck(form,count,j);
11325: break;
11326: }
1.1055 raeburn 11327: }
11328: }
11329: }
11330: }
11331: }
11332:
11333: numitems = $numitems
1.1056 raeburn 11334: var titles = new Array(numitems);
11335: var parents = new Array(numitems);
1.1055 raeburn 11336: for (var i=0; i<numitems; i++) {
1.1056 raeburn 11337: parents[i] = new Array;
1.1055 raeburn 11338: }
1.1059 raeburn 11339: var maintitle = '$maintitle';
1.1055 raeburn 11340:
11341: START
11342:
1.1056 raeburn 11343: foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
11344: my @contents = split(/:/,$children->{$container});
1.1055 raeburn 11345: for (my $i=0; $i<@contents; $i ++) {
11346: $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
11347: }
11348: }
11349:
1.1056 raeburn 11350: foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
11351: $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
11352: }
11353:
1.1055 raeburn 11354: $scripttag .= <<END;
11355:
11356: function containerCheck(form,count,offset) {
11357: if (count > 0) {
1.1056 raeburn 11358: dependencyCheck(form,count,offset);
1.1059 raeburn 11359: var item = (offset+$startcount)+7*(count-1);
1.1055 raeburn 11360: form.elements[item].checked = true;
11361: if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
11362: if (parents[count].length > 0) {
11363: for (var j=0; j<parents[count].length; j++) {
1.1056 raeburn 11364: containerCheck(form,parents[count][j],offset);
11365: }
11366: }
11367: }
11368: }
11369: }
11370:
11371: function dependencyCheck(form,count,offset) {
11372: if (count > 0) {
1.1059 raeburn 11373: var chosen = (offset+$startcount)+7*(count-1);
11374: var depitem = $startcount + ((count-1) * 7) + 4;
1.1056 raeburn 11375: var currtype = form.elements[depitem].type;
11376: if (form.elements[chosen].value == 'dependency') {
11377: document.getElementById('arc_depon_'+count).style.display='block';
11378: form.elements[depitem].options.length = 0;
11379: form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1075.2.11 raeburn 11380: for (var i=1; i<=numitems; i++) {
11381: if (i == count) {
11382: continue;
11383: }
1.1059 raeburn 11384: var startelement = $startcount + (i-1) * 7;
11385: for (var j=1; j<6; j++) {
11386: if ((j != 2) && (j!= 4)) {
1.1056 raeburn 11387: var item = startelement + j;
11388: if (form.elements[item].type == 'radio') {
11389: if (form.elements[item].checked) {
11390: if (form.elements[item].value == 'display') {
11391: var n = form.elements[depitem].options.length;
11392: form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
11393: }
11394: }
11395: }
11396: }
11397: }
11398: }
11399: } else {
11400: document.getElementById('arc_depon_'+count).style.display='none';
11401: form.elements[depitem].options.length = 0;
11402: form.elements[depitem].options[0] = new Option('Select','',true,true);
11403: }
1.1059 raeburn 11404: titleCheck(form,count,offset);
1.1056 raeburn 11405: }
11406: }
11407:
11408: function propagateSelect(form,count,offset) {
11409: if (count > 0) {
1.1065 raeburn 11410: var item = (1+offset+$startcount)+7*(count-1);
1.1056 raeburn 11411: var picked = form.elements[item].options[form.elements[item].selectedIndex].value;
11412: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
11413: if (parents[count].length > 0) {
11414: for (var j=0; j<parents[count].length; j++) {
11415: containerSelect(form,parents[count][j],offset,picked);
1.1055 raeburn 11416: }
11417: }
11418: }
11419: }
11420: }
1.1056 raeburn 11421:
11422: function containerSelect(form,count,offset,picked) {
11423: if (count > 0) {
1.1065 raeburn 11424: var item = (offset+$startcount)+7*(count-1);
1.1056 raeburn 11425: if (form.elements[item].type == 'radio') {
11426: if (form.elements[item].value == 'dependency') {
11427: if (form.elements[item+1].type == 'select-one') {
11428: for (var i=0; i<form.elements[item+1].options.length; i++) {
11429: if (form.elements[item+1].options[i].value == picked) {
11430: form.elements[item+1].selectedIndex = i;
11431: break;
11432: }
11433: }
11434: }
11435: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
11436: if (parents[count].length > 0) {
11437: for (var j=0; j<parents[count].length; j++) {
11438: containerSelect(form,parents[count][j],offset,picked);
11439: }
11440: }
11441: }
11442: }
11443: }
11444: }
11445: }
11446:
1.1059 raeburn 11447: function titleCheck(form,count,offset) {
11448: if (count > 0) {
11449: var chosen = (offset+$startcount)+7*(count-1);
11450: var depitem = $startcount + ((count-1) * 7) + 2;
11451: var currtype = form.elements[depitem].type;
11452: if (form.elements[chosen].value == 'display') {
11453: document.getElementById('arc_title_'+count).style.display='block';
11454: if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
11455: document.getElementById('archive_title_'+count).value=maintitle;
11456: }
11457: } else {
11458: document.getElementById('arc_title_'+count).style.display='none';
11459: if (currtype == 'text') {
11460: document.getElementById('archive_title_'+count).value='';
11461: }
11462: }
11463: }
11464: return;
11465: }
11466:
1.1055 raeburn 11467: // ]]>
11468: </script>
11469: END
11470: return $scripttag;
11471: }
11472:
11473: sub process_extracted_files {
1.1067 raeburn 11474: my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055 raeburn 11475: my $numitems = $env{'form.archive_count'};
11476: return unless ($numitems);
11477: my @ids=&Apache::lonnet::current_machine_ids();
11478: my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067 raeburn 11479: %folders,%containers,%mapinner,%prompttofetch);
1.1055 raeburn 11480: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
11481: if (grep(/^\Q$docuhome\E$/,@ids)) {
11482: $prefix = &LONCAPA::propath($docudom,$docuname);
11483: $pathtocheck = "$dir_root/$destination";
11484: $dir = $dir_root;
11485: $ishome = 1;
11486: } else {
11487: $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
11488: $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
11489: $dir = "$dir_root/$docudom/$docuname";
11490: }
11491: my $currdir = "$dir_root/$destination";
11492: (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
11493: if ($env{'form.folderpath'}) {
11494: my @items = split('&',$env{'form.folderpath'});
11495: $folders{'0'} = $items[-2];
1.1075.2.17 raeburn 11496: if ($env{'form.folderpath'} =~ /\:1$/) {
11497: $containers{'0'}='page';
11498: } else {
11499: $containers{'0'}='sequence';
11500: }
1.1055 raeburn 11501: }
11502: my @archdirs = &get_env_multiple('form.archive_directory');
11503: if ($numitems) {
11504: for (my $i=1; $i<=$numitems; $i++) {
11505: my $path = $env{'form.archive_content_'.$i};
11506: if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
11507: my $item = $1;
11508: $toplevelitems{$item} = $i;
11509: if (grep(/^\Q$i\E$/,@archdirs)) {
11510: $is_dir{$item} = 1;
11511: }
11512: }
11513: }
11514: }
1.1067 raeburn 11515: my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055 raeburn 11516: if (keys(%toplevelitems) > 0) {
11517: my @contents = sort(keys(%toplevelitems));
1.1056 raeburn 11518: (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
11519: \%parent,\@contents,\%dirorder,\%titles);
1.1055 raeburn 11520: }
1.1066 raeburn 11521: my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055 raeburn 11522: if ($numitems) {
11523: for (my $i=1; $i<=$numitems; $i++) {
1.1075.2.11 raeburn 11524: next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055 raeburn 11525: my $path = $env{'form.archive_content_'.$i};
11526: if ($path =~ /^\Q$pathtocheck\E/) {
11527: if ($env{'form.archive_'.$i} eq 'discard') {
11528: if ($prefix ne '' && $path ne '') {
11529: if (-e $prefix.$path) {
1.1066 raeburn 11530: if ((@archdirs > 0) &&
11531: (grep(/^\Q$i\E$/,@archdirs))) {
11532: $todeletedir{$prefix.$path} = 1;
11533: } else {
11534: $todelete{$prefix.$path} = 1;
11535: }
1.1055 raeburn 11536: }
11537: }
11538: } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059 raeburn 11539: my ($docstitle,$title,$url,$outer);
1.1055 raeburn 11540: ($title) = ($path =~ m{/([^/]+)$});
1.1059 raeburn 11541: $docstitle = $env{'form.archive_title_'.$i};
11542: if ($docstitle eq '') {
11543: $docstitle = $title;
11544: }
1.1055 raeburn 11545: $outer = 0;
1.1056 raeburn 11546: if (ref($dirorder{$i}) eq 'ARRAY') {
11547: if (@{$dirorder{$i}} > 0) {
11548: foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055 raeburn 11549: if ($env{'form.archive_'.$item} eq 'display') {
11550: $outer = $item;
11551: last;
11552: }
11553: }
11554: }
11555: }
11556: my ($errtext,$fatal) =
11557: &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
11558: '/'.$folders{$outer}.'.'.
11559: $containers{$outer});
11560: next if ($fatal);
11561: if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
11562: if ($context eq 'coursedocs') {
1.1056 raeburn 11563: $mapinner{$i} = time;
1.1055 raeburn 11564: $folders{$i} = 'default_'.$mapinner{$i};
11565: $containers{$i} = 'sequence';
11566: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
11567: $folders{$i}.'.'.$containers{$i};
11568: my $newidx = &LONCAPA::map::getresidx();
11569: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 11570: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 11571: push(@LONCAPA::map::order,$newidx);
11572: my ($outtext,$errtext) =
11573: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
11574: $docuname.'/'.$folders{$outer}.
1.1075.2.11 raeburn 11575: '.'.$containers{$outer},1,1);
1.1056 raeburn 11576: $newseqid{$i} = $newidx;
1.1067 raeburn 11577: unless ($errtext) {
11578: $result .= '<li>'.&mt('Folder: [_1] added to course',$docstitle).'</li>'."\n";
11579: }
1.1055 raeburn 11580: }
11581: } else {
11582: if ($context eq 'coursedocs') {
11583: my $newidx=&LONCAPA::map::getresidx();
11584: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
11585: $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
11586: $title;
11587: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
11588: mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
11589: }
11590: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
11591: mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
11592: }
11593: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
11594: system("mv $prefix$path $prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title");
1.1056 raeburn 11595: $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
1.1067 raeburn 11596: unless ($ishome) {
11597: my $fetch = "$newdest{$i}/$title";
11598: $fetch =~ s/^\Q$prefix$dir\E//;
11599: $prompttofetch{$fetch} = 1;
11600: }
1.1055 raeburn 11601: }
11602: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 11603: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 11604: push(@LONCAPA::map::order, $newidx);
11605: my ($outtext,$errtext)=
11606: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
11607: $docuname.'/'.$folders{$outer}.
1.1075.2.11 raeburn 11608: '.'.$containers{$outer},1,1);
1.1067 raeburn 11609: unless ($errtext) {
11610: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
11611: $result .= '<li>'.&mt('File: [_1] added to course',$docstitle).'</li>'."\n";
11612: }
11613: }
1.1055 raeburn 11614: }
11615: }
1.1075.2.11 raeburn 11616: }
11617: } else {
11618: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',$path).'<br />';
11619: }
11620: }
11621: for (my $i=1; $i<=$numitems; $i++) {
11622: next unless ($env{'form.archive_'.$i} eq 'dependency');
11623: my $path = $env{'form.archive_content_'.$i};
11624: if ($path =~ /^\Q$pathtocheck\E/) {
11625: my ($title) = ($path =~ m{/([^/]+)$});
11626: $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
11627: if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
11628: if (ref($dirorder{$i}) eq 'ARRAY') {
11629: my ($itemidx,$fullpath,$relpath);
11630: if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
11631: my $container = $dirorder{$referrer{$i}}->[-1];
1.1056 raeburn 11632: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1075.2.11 raeburn 11633: if ($dirorder{$i}->[$j] eq $container) {
11634: $itemidx = $j;
1.1056 raeburn 11635: }
11636: }
1.1075.2.11 raeburn 11637: }
11638: if ($itemidx eq '') {
11639: $itemidx = 0;
11640: }
11641: if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
11642: if ($mapinner{$referrer{$i}}) {
11643: $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
11644: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
11645: if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
11646: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
11647: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
11648: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
11649: if (!-e $fullpath) {
11650: mkdir($fullpath,0755);
1.1056 raeburn 11651: }
11652: }
1.1075.2.11 raeburn 11653: } else {
11654: last;
1.1056 raeburn 11655: }
1.1075.2.11 raeburn 11656: }
11657: }
11658: } elsif ($newdest{$referrer{$i}}) {
11659: $fullpath = $newdest{$referrer{$i}};
11660: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
11661: if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
11662: $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
11663: last;
11664: } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
11665: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
11666: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
11667: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
11668: if (!-e $fullpath) {
11669: mkdir($fullpath,0755);
1.1056 raeburn 11670: }
11671: }
1.1075.2.11 raeburn 11672: } else {
11673: last;
1.1056 raeburn 11674: }
1.1075.2.11 raeburn 11675: }
11676: }
11677: if ($fullpath ne '') {
11678: if (-e "$prefix$path") {
11679: system("mv $prefix$path $fullpath/$title");
11680: }
11681: if (-e "$fullpath/$title") {
11682: my $showpath;
11683: if ($relpath ne '') {
11684: $showpath = "$relpath/$title";
11685: } else {
11686: $showpath = "/$title";
1.1056 raeburn 11687: }
1.1075.2.11 raeburn 11688: $result .= '<li>'.&mt('[_1] included as a dependency',$showpath).'</li>'."\n";
11689: }
11690: unless ($ishome) {
11691: my $fetch = "$fullpath/$title";
11692: $fetch =~ s/^\Q$prefix$dir\E//;
11693: $prompttofetch{$fetch} = 1;
1.1055 raeburn 11694: }
11695: }
11696: }
1.1075.2.11 raeburn 11697: } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
11698: $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
11699: $path,$env{'form.archive_content_'.$referrer{$i}}).'<br />';
1.1055 raeburn 11700: }
11701: } else {
1.1075.2.11 raeburn 11702: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',$path).'<br />';
1.1055 raeburn 11703: }
11704: }
11705: if (keys(%todelete)) {
11706: foreach my $key (keys(%todelete)) {
11707: unlink($key);
1.1066 raeburn 11708: }
11709: }
11710: if (keys(%todeletedir)) {
11711: foreach my $key (keys(%todeletedir)) {
11712: rmdir($key);
11713: }
11714: }
11715: foreach my $dir (sort(keys(%is_dir))) {
11716: if (($pathtocheck ne '') && ($dir ne '')) {
11717: &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055 raeburn 11718: }
11719: }
1.1067 raeburn 11720: if ($result ne '') {
11721: $output .= '<ul>'."\n".
11722: $result."\n".
11723: '</ul>';
11724: }
11725: unless ($ishome) {
11726: my $replicationfail;
11727: foreach my $item (keys(%prompttofetch)) {
11728: my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
11729: unless ($fetchresult eq 'ok') {
11730: $replicationfail .= '<li>'.$item.'</li>'."\n";
11731: }
11732: }
11733: if ($replicationfail) {
11734: $output .= '<p class="LC_error">'.
11735: &mt('Course home server failed to retrieve:').'<ul>'.
11736: $replicationfail.
11737: '</ul></p>';
11738: }
11739: }
1.1055 raeburn 11740: } else {
11741: $warning = &mt('No items found in archive.');
11742: }
11743: if ($error) {
11744: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
11745: $error.'</p>'."\n";
11746: }
11747: if ($warning) {
11748: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
11749: }
11750: return $output;
11751: }
11752:
1.1066 raeburn 11753: sub cleanup_empty_dirs {
11754: my ($path) = @_;
11755: if (($path ne '') && (-d $path)) {
11756: if (opendir(my $dirh,$path)) {
11757: my @dircontents = grep(!/^\./,readdir($dirh));
11758: my $numitems = 0;
11759: foreach my $item (@dircontents) {
11760: if (-d "$path/$item") {
1.1075.2.28 raeburn 11761: &cleanup_empty_dirs("$path/$item");
1.1066 raeburn 11762: if (-e "$path/$item") {
11763: $numitems ++;
11764: }
11765: } else {
11766: $numitems ++;
11767: }
11768: }
11769: if ($numitems == 0) {
11770: rmdir($path);
11771: }
11772: closedir($dirh);
11773: }
11774: }
11775: return;
11776: }
11777:
1.41 ng 11778: =pod
1.45 matthew 11779:
1.1068 raeburn 11780: =item &get_folder_hierarchy()
11781:
11782: Provides hierarchy of names of folders/sub-folders containing the current
11783: item,
11784:
11785: Inputs: 3
11786: - $navmap - navmaps object
11787:
11788: - $map - url for map (either the trigger itself, or map containing
11789: the resource, which is the trigger).
11790:
11791: - $showitem - 1 => show title for map itself; 0 => do not show.
11792:
11793: Outputs: 1 @pathitems - array of folder/subfolder names.
11794:
11795: =cut
11796:
11797: sub get_folder_hierarchy {
11798: my ($navmap,$map,$showitem) = @_;
11799: my @pathitems;
11800: if (ref($navmap)) {
11801: my $mapres = $navmap->getResourceByUrl($map);
11802: if (ref($mapres)) {
11803: my $pcslist = $mapres->map_hierarchy();
11804: if ($pcslist ne '') {
11805: my @pcs = split(/,/,$pcslist);
11806: foreach my $pc (@pcs) {
11807: if ($pc == 1) {
11808: push(@pathitems,&mt('Main Course Documents'));
11809: } else {
11810: my $res = $navmap->getByMapPc($pc);
11811: if (ref($res)) {
11812: my $title = $res->compTitle();
11813: $title =~ s/\W+/_/g;
11814: if ($title ne '') {
11815: push(@pathitems,$title);
11816: }
11817: }
11818: }
11819: }
11820: }
1.1071 raeburn 11821: if ($showitem) {
11822: if ($mapres->{ID} eq '0.0') {
11823: push(@pathitems,&mt('Main Course Documents'));
11824: } else {
11825: my $maptitle = $mapres->compTitle();
11826: $maptitle =~ s/\W+/_/g;
11827: if ($maptitle ne '') {
11828: push(@pathitems,$maptitle);
11829: }
1.1068 raeburn 11830: }
11831: }
11832: }
11833: }
11834: return @pathitems;
11835: }
11836:
11837: =pod
11838:
1.1015 raeburn 11839: =item * &get_turnedin_filepath()
11840:
11841: Determines path in a user's portfolio file for storage of files uploaded
11842: to a specific essayresponse or dropbox item.
11843:
11844: Inputs: 3 required + 1 optional.
11845: $symb is symb for resource, $uname and $udom are for current user (required).
11846: $caller is optional (can be "submission", if routine is called when storing
11847: an upoaded file when "Submit Answer" button was pressed).
11848:
11849: Returns array containing $path and $multiresp.
11850: $path is path in portfolio. $multiresp is 1 if this resource contains more
11851: than one file upload item. Callers of routine should append partid as a
11852: subdirectory to $path in cases where $multiresp is 1.
11853:
11854: Called by: homework/essayresponse.pm and homework/structuretags.pm
11855:
11856: =cut
11857:
11858: sub get_turnedin_filepath {
11859: my ($symb,$uname,$udom,$caller) = @_;
11860: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
11861: my $turnindir;
11862: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
11863: $turnindir = $userhash{'turnindir'};
11864: my ($path,$multiresp);
11865: if ($turnindir eq '') {
11866: if ($caller eq 'submission') {
11867: $turnindir = &mt('turned in');
11868: $turnindir =~ s/\W+/_/g;
11869: my %newhash = (
11870: 'turnindir' => $turnindir,
11871: );
11872: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
11873: }
11874: }
11875: if ($turnindir ne '') {
11876: $path = '/'.$turnindir.'/';
11877: my ($multipart,$turnin,@pathitems);
11878: my $navmap = Apache::lonnavmaps::navmap->new();
11879: if (defined($navmap)) {
11880: my $mapres = $navmap->getResourceByUrl($map);
11881: if (ref($mapres)) {
11882: my $pcslist = $mapres->map_hierarchy();
11883: if ($pcslist ne '') {
11884: foreach my $pc (split(/,/,$pcslist)) {
11885: my $res = $navmap->getByMapPc($pc);
11886: if (ref($res)) {
11887: my $title = $res->compTitle();
11888: $title =~ s/\W+/_/g;
11889: if ($title ne '') {
11890: push(@pathitems,$title);
11891: }
11892: }
11893: }
11894: }
11895: my $maptitle = $mapres->compTitle();
11896: $maptitle =~ s/\W+/_/g;
11897: if ($maptitle ne '') {
11898: push(@pathitems,$maptitle);
11899: }
11900: unless ($env{'request.state'} eq 'construct') {
11901: my $res = $navmap->getBySymb($symb);
11902: if (ref($res)) {
11903: my $partlist = $res->parts();
11904: my $totaluploads = 0;
11905: if (ref($partlist) eq 'ARRAY') {
11906: foreach my $part (@{$partlist}) {
11907: my @types = $res->responseType($part);
11908: my @ids = $res->responseIds($part);
11909: for (my $i=0; $i < scalar(@ids); $i++) {
11910: if ($types[$i] eq 'essay') {
11911: my $partid = $part.'_'.$ids[$i];
11912: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
11913: $totaluploads ++;
11914: }
11915: }
11916: }
11917: }
11918: if ($totaluploads > 1) {
11919: $multiresp = 1;
11920: }
11921: }
11922: }
11923: }
11924: } else {
11925: return;
11926: }
11927: } else {
11928: return;
11929: }
11930: my $restitle=&Apache::lonnet::gettitle($symb);
11931: $restitle =~ s/\W+/_/g;
11932: if ($restitle eq '') {
11933: $restitle = ($resurl =~ m{/[^/]+$});
11934: if ($restitle eq '') {
11935: $restitle = time;
11936: }
11937: }
11938: push(@pathitems,$restitle);
11939: $path .= join('/',@pathitems);
11940: }
11941: return ($path,$multiresp);
11942: }
11943:
11944: =pod
11945:
1.464 albertel 11946: =back
1.41 ng 11947:
1.112 bowersj2 11948: =head1 CSV Upload/Handling functions
1.38 albertel 11949:
1.41 ng 11950: =over 4
11951:
1.648 raeburn 11952: =item * &upfile_store($r)
1.41 ng 11953:
11954: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 11955: needs $env{'form.upfile'}
1.41 ng 11956: returns $datatoken to be put into hidden field
11957:
11958: =cut
1.31 albertel 11959:
11960: sub upfile_store {
11961: my $r=shift;
1.258 albertel 11962: $env{'form.upfile'}=~s/\r/\n/gs;
11963: $env{'form.upfile'}=~s/\f/\n/gs;
11964: $env{'form.upfile'}=~s/\n+/\n/gs;
11965: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 11966:
1.258 albertel 11967: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
11968: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 11969: {
1.158 raeburn 11970: my $datafile = $r->dir_config('lonDaemons').
11971: '/tmp/'.$datatoken.'.tmp';
11972: if ( open(my $fh,">$datafile") ) {
1.258 albertel 11973: print $fh $env{'form.upfile'};
1.158 raeburn 11974: close($fh);
11975: }
1.31 albertel 11976: }
11977: return $datatoken;
11978: }
11979:
1.56 matthew 11980: =pod
11981:
1.648 raeburn 11982: =item * &load_tmp_file($r)
1.41 ng 11983:
11984: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 11985: needs $env{'form.datatoken'},
11986: sets $env{'form.upfile'} to the contents of the file
1.41 ng 11987:
11988: =cut
1.31 albertel 11989:
11990: sub load_tmp_file {
11991: my $r=shift;
11992: my @studentdata=();
11993: {
1.158 raeburn 11994: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 11995: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 11996: if ( open(my $fh,"<$studentfile") ) {
11997: @studentdata=<$fh>;
11998: close($fh);
11999: }
1.31 albertel 12000: }
1.258 albertel 12001: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 12002: }
12003:
1.56 matthew 12004: =pod
12005:
1.648 raeburn 12006: =item * &upfile_record_sep()
1.41 ng 12007:
12008: Separate uploaded file into records
12009: returns array of records,
1.258 albertel 12010: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 12011:
12012: =cut
1.31 albertel 12013:
12014: sub upfile_record_sep {
1.258 albertel 12015: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 12016: } else {
1.248 albertel 12017: my @records;
1.258 albertel 12018: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 12019: if ($line=~/^\s*$/) { next; }
12020: push(@records,$line);
12021: }
12022: return @records;
1.31 albertel 12023: }
12024: }
12025:
1.56 matthew 12026: =pod
12027:
1.648 raeburn 12028: =item * &record_sep($record)
1.41 ng 12029:
1.258 albertel 12030: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 12031:
12032: =cut
12033:
1.263 www 12034: sub takeleft {
12035: my $index=shift;
12036: return substr('0000'.$index,-4,4);
12037: }
12038:
1.31 albertel 12039: sub record_sep {
12040: my $record=shift;
12041: my %components=();
1.258 albertel 12042: if ($env{'form.upfiletype'} eq 'xml') {
12043: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 12044: my $i=0;
1.356 albertel 12045: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 12046: $field=~s/^(\"|\')//;
12047: $field=~s/(\"|\')$//;
1.263 www 12048: $components{&takeleft($i)}=$field;
1.31 albertel 12049: $i++;
12050: }
1.258 albertel 12051: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 12052: my $i=0;
1.356 albertel 12053: foreach my $field (split(/\t/,$record)) {
1.31 albertel 12054: $field=~s/^(\"|\')//;
12055: $field=~s/(\"|\')$//;
1.263 www 12056: $components{&takeleft($i)}=$field;
1.31 albertel 12057: $i++;
12058: }
12059: } else {
1.561 www 12060: my $separator=',';
1.480 banghart 12061: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 12062: $separator=';';
1.480 banghart 12063: }
1.31 albertel 12064: my $i=0;
1.561 www 12065: # the character we are looking for to indicate the end of a quote or a record
12066: my $looking_for=$separator;
12067: # do not add the characters to the fields
12068: my $ignore=0;
12069: # we just encountered a separator (or the beginning of the record)
12070: my $just_found_separator=1;
12071: # store the field we are working on here
12072: my $field='';
12073: # work our way through all characters in record
12074: foreach my $character ($record=~/(.)/g) {
12075: if ($character eq $looking_for) {
12076: if ($character ne $separator) {
12077: # Found the end of a quote, again looking for separator
12078: $looking_for=$separator;
12079: $ignore=1;
12080: } else {
12081: # Found a separator, store away what we got
12082: $components{&takeleft($i)}=$field;
12083: $i++;
12084: $just_found_separator=1;
12085: $ignore=0;
12086: $field='';
12087: }
12088: next;
12089: }
12090: # single or double quotation marks after a separator indicate beginning of a quote
12091: # we are now looking for the end of the quote and need to ignore separators
12092: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
12093: $looking_for=$character;
12094: next;
12095: }
12096: # ignore would be true after we reached the end of a quote
12097: if ($ignore) { next; }
12098: if (($just_found_separator) && ($character=~/\s/)) { next; }
12099: $field.=$character;
12100: $just_found_separator=0;
1.31 albertel 12101: }
1.561 www 12102: # catch the very last entry, since we never encountered the separator
12103: $components{&takeleft($i)}=$field;
1.31 albertel 12104: }
12105: return %components;
12106: }
12107:
1.144 matthew 12108: ######################################################
12109: ######################################################
12110:
1.56 matthew 12111: =pod
12112:
1.648 raeburn 12113: =item * &upfile_select_html()
1.41 ng 12114:
1.144 matthew 12115: Return HTML code to select a file from the users machine and specify
12116: the file type.
1.41 ng 12117:
12118: =cut
12119:
1.144 matthew 12120: ######################################################
12121: ######################################################
1.31 albertel 12122: sub upfile_select_html {
1.144 matthew 12123: my %Types = (
12124: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 12125: semisv => &mt('Semicolon separated values'),
1.144 matthew 12126: space => &mt('Space separated'),
12127: tab => &mt('Tabulator separated'),
12128: # xml => &mt('HTML/XML'),
12129: );
12130: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 12131: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 12132: foreach my $type (sort(keys(%Types))) {
12133: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
12134: }
12135: $Str .= "</select>\n";
12136: return $Str;
1.31 albertel 12137: }
12138:
1.301 albertel 12139: sub get_samples {
12140: my ($records,$toget) = @_;
12141: my @samples=({});
12142: my $got=0;
12143: foreach my $rec (@$records) {
12144: my %temp = &record_sep($rec);
12145: if (! grep(/\S/, values(%temp))) { next; }
12146: if (%temp) {
12147: $samples[$got]=\%temp;
12148: $got++;
12149: if ($got == $toget) { last; }
12150: }
12151: }
12152: return \@samples;
12153: }
12154:
1.144 matthew 12155: ######################################################
12156: ######################################################
12157:
1.56 matthew 12158: =pod
12159:
1.648 raeburn 12160: =item * &csv_print_samples($r,$records)
1.41 ng 12161:
12162: Prints a table of sample values from each column uploaded $r is an
12163: Apache Request ref, $records is an arrayref from
12164: &Apache::loncommon::upfile_record_sep
12165:
12166: =cut
12167:
1.144 matthew 12168: ######################################################
12169: ######################################################
1.31 albertel 12170: sub csv_print_samples {
12171: my ($r,$records) = @_;
1.662 bisitz 12172: my $samples = &get_samples($records,5);
1.301 albertel 12173:
1.594 raeburn 12174: $r->print(&mt('Samples').'<br />'.&start_data_table().
12175: &start_data_table_header_row());
1.356 albertel 12176: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 12177: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 12178: $r->print(&end_data_table_header_row());
1.301 albertel 12179: foreach my $hash (@$samples) {
1.594 raeburn 12180: $r->print(&start_data_table_row());
1.356 albertel 12181: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 12182: $r->print('<td>');
1.356 albertel 12183: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 12184: $r->print('</td>');
12185: }
1.594 raeburn 12186: $r->print(&end_data_table_row());
1.31 albertel 12187: }
1.594 raeburn 12188: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 12189: }
12190:
1.144 matthew 12191: ######################################################
12192: ######################################################
12193:
1.56 matthew 12194: =pod
12195:
1.648 raeburn 12196: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 12197:
12198: Prints a table to create associations between values and table columns.
1.144 matthew 12199:
1.41 ng 12200: $r is an Apache Request ref,
12201: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 12202: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 12203:
12204: =cut
12205:
1.144 matthew 12206: ######################################################
12207: ######################################################
1.31 albertel 12208: sub csv_print_select_table {
12209: my ($r,$records,$d) = @_;
1.301 albertel 12210: my $i=0;
12211: my $samples = &get_samples($records,1);
1.144 matthew 12212: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 12213: &start_data_table().&start_data_table_header_row().
1.144 matthew 12214: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 12215: '<th>'.&mt('Column').'</th>'.
12216: &end_data_table_header_row()."\n");
1.356 albertel 12217: foreach my $array_ref (@$d) {
12218: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 12219: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 12220:
1.875 bisitz 12221: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 12222: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 12223: $r->print('<option value="none"></option>');
1.356 albertel 12224: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
12225: $r->print('<option value="'.$sample.'"'.
12226: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 12227: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 12228: }
1.594 raeburn 12229: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 12230: $i++;
12231: }
1.594 raeburn 12232: $r->print(&end_data_table());
1.31 albertel 12233: $i--;
12234: return $i;
12235: }
1.56 matthew 12236:
1.144 matthew 12237: ######################################################
12238: ######################################################
12239:
1.56 matthew 12240: =pod
1.31 albertel 12241:
1.648 raeburn 12242: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 12243:
12244: Prints a table of sample values from the upload and can make associate samples to internal names.
12245:
12246: $r is an Apache Request ref,
12247: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
12248: $d is an array of 2 element arrays (internal name, displayed name)
12249:
12250: =cut
12251:
1.144 matthew 12252: ######################################################
12253: ######################################################
1.31 albertel 12254: sub csv_samples_select_table {
12255: my ($r,$records,$d) = @_;
12256: my $i=0;
1.144 matthew 12257: #
1.662 bisitz 12258: my $max_samples = 5;
12259: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 12260: $r->print(&start_data_table().
12261: &start_data_table_header_row().'<th>'.
12262: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
12263: &end_data_table_header_row());
1.301 albertel 12264:
12265: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 12266: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 12267: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 12268: foreach my $option (@$d) {
12269: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 12270: $r->print('<option value="'.$value.'"'.
1.253 albertel 12271: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 12272: $display.'</option>');
1.31 albertel 12273: }
12274: $r->print('</select></td><td>');
1.662 bisitz 12275: foreach my $line (0..($max_samples-1)) {
1.301 albertel 12276: if (defined($samples->[$line]{$key})) {
12277: $r->print($samples->[$line]{$key}."<br />\n");
12278: }
12279: }
1.594 raeburn 12280: $r->print('</td>'.&end_data_table_row());
1.31 albertel 12281: $i++;
12282: }
1.594 raeburn 12283: $r->print(&end_data_table());
1.31 albertel 12284: $i--;
12285: return($i);
1.115 matthew 12286: }
12287:
1.144 matthew 12288: ######################################################
12289: ######################################################
12290:
1.115 matthew 12291: =pod
12292:
1.648 raeburn 12293: =item * &clean_excel_name($name)
1.115 matthew 12294:
12295: Returns a replacement for $name which does not contain any illegal characters.
12296:
12297: =cut
12298:
1.144 matthew 12299: ######################################################
12300: ######################################################
1.115 matthew 12301: sub clean_excel_name {
12302: my ($name) = @_;
12303: $name =~ s/[:\*\?\/\\]//g;
12304: if (length($name) > 31) {
12305: $name = substr($name,0,31);
12306: }
12307: return $name;
1.25 albertel 12308: }
1.84 albertel 12309:
1.85 albertel 12310: =pod
12311:
1.648 raeburn 12312: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 12313:
12314: Returns either 1 or undef
12315:
12316: 1 if the part is to be hidden, undef if it is to be shown
12317:
12318: Arguments are:
12319:
12320: $id the id of the part to be checked
12321: $symb, optional the symb of the resource to check
12322: $udom, optional the domain of the user to check for
12323: $uname, optional the username of the user to check for
12324:
12325: =cut
1.84 albertel 12326:
12327: sub check_if_partid_hidden {
12328: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 12329: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 12330: $symb,$udom,$uname);
1.141 albertel 12331: my $truth=1;
12332: #if the string starts with !, then the list is the list to show not hide
12333: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 12334: my @hiddenlist=split(/,/,$hiddenparts);
12335: foreach my $checkid (@hiddenlist) {
1.141 albertel 12336: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 12337: }
1.141 albertel 12338: return !$truth;
1.84 albertel 12339: }
1.127 matthew 12340:
1.138 matthew 12341:
12342: ############################################################
12343: ############################################################
12344:
12345: =pod
12346:
1.157 matthew 12347: =back
12348:
1.138 matthew 12349: =head1 cgi-bin script and graphing routines
12350:
1.157 matthew 12351: =over 4
12352:
1.648 raeburn 12353: =item * &get_cgi_id()
1.138 matthew 12354:
12355: Inputs: none
12356:
12357: Returns an id which can be used to pass environment variables
12358: to various cgi-bin scripts. These environment variables will
12359: be removed from the users environment after a given time by
12360: the routine &Apache::lonnet::transfer_profile_to_env.
12361:
12362: =cut
12363:
12364: ############################################################
12365: ############################################################
1.152 albertel 12366: my $uniq=0;
1.136 matthew 12367: sub get_cgi_id {
1.154 albertel 12368: $uniq=($uniq+1)%100000;
1.280 albertel 12369: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 12370: }
12371:
1.127 matthew 12372: ############################################################
12373: ############################################################
12374:
12375: =pod
12376:
1.648 raeburn 12377: =item * &DrawBarGraph()
1.127 matthew 12378:
1.138 matthew 12379: Facilitates the plotting of data in a (stacked) bar graph.
12380: Puts plot definition data into the users environment in order for
12381: graph.png to plot it. Returns an <img> tag for the plot.
12382: The bars on the plot are labeled '1','2',...,'n'.
12383:
12384: Inputs:
12385:
12386: =over 4
12387:
12388: =item $Title: string, the title of the plot
12389:
12390: =item $xlabel: string, text describing the X-axis of the plot
12391:
12392: =item $ylabel: string, text describing the Y-axis of the plot
12393:
12394: =item $Max: scalar, the maximum Y value to use in the plot
12395: If $Max is < any data point, the graph will not be rendered.
12396:
1.140 matthew 12397: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 12398: they are plotted. If undefined, default values will be used.
12399:
1.178 matthew 12400: =item $labels: array ref holding the labels to use on the x-axis for the bars.
12401:
1.138 matthew 12402: =item @Values: An array of array references. Each array reference holds data
12403: to be plotted in a stacked bar chart.
12404:
1.239 matthew 12405: =item If the final element of @Values is a hash reference the key/value
12406: pairs will be added to the graph definition.
12407:
1.138 matthew 12408: =back
12409:
12410: Returns:
12411:
12412: An <img> tag which references graph.png and the appropriate identifying
12413: information for the plot.
12414:
1.127 matthew 12415: =cut
12416:
12417: ############################################################
12418: ############################################################
1.134 matthew 12419: sub DrawBarGraph {
1.178 matthew 12420: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 12421: #
12422: if (! defined($colors)) {
12423: $colors = ['#33ff00',
12424: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
12425: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
12426: ];
12427: }
1.228 matthew 12428: my $extra_settings = {};
12429: if (ref($Values[-1]) eq 'HASH') {
12430: $extra_settings = pop(@Values);
12431: }
1.127 matthew 12432: #
1.136 matthew 12433: my $identifier = &get_cgi_id();
12434: my $id = 'cgi.'.$identifier;
1.129 matthew 12435: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 12436: return '';
12437: }
1.225 matthew 12438: #
12439: my @Labels;
12440: if (defined($labels)) {
12441: @Labels = @$labels;
12442: } else {
12443: for (my $i=0;$i<@{$Values[0]};$i++) {
12444: push (@Labels,$i+1);
12445: }
12446: }
12447: #
1.129 matthew 12448: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 12449: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 12450: my %ValuesHash;
12451: my $NumSets=1;
12452: foreach my $array (@Values) {
12453: next if (! ref($array));
1.136 matthew 12454: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 12455: join(',',@$array);
1.129 matthew 12456: }
1.127 matthew 12457: #
1.136 matthew 12458: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 12459: if ($NumBars < 3) {
12460: $width = 120+$NumBars*32;
1.220 matthew 12461: $xskip = 1;
1.225 matthew 12462: $bar_width = 30;
12463: } elsif ($NumBars < 5) {
12464: $width = 120+$NumBars*20;
12465: $xskip = 1;
12466: $bar_width = 20;
1.220 matthew 12467: } elsif ($NumBars < 10) {
1.136 matthew 12468: $width = 120+$NumBars*15;
12469: $xskip = 1;
12470: $bar_width = 15;
12471: } elsif ($NumBars <= 25) {
12472: $width = 120+$NumBars*11;
12473: $xskip = 5;
12474: $bar_width = 8;
12475: } elsif ($NumBars <= 50) {
12476: $width = 120+$NumBars*8;
12477: $xskip = 5;
12478: $bar_width = 4;
12479: } else {
12480: $width = 120+$NumBars*8;
12481: $xskip = 5;
12482: $bar_width = 4;
12483: }
12484: #
1.137 matthew 12485: $Max = 1 if ($Max < 1);
12486: if ( int($Max) < $Max ) {
12487: $Max++;
12488: $Max = int($Max);
12489: }
1.127 matthew 12490: $Title = '' if (! defined($Title));
12491: $xlabel = '' if (! defined($xlabel));
12492: $ylabel = '' if (! defined($ylabel));
1.369 www 12493: $ValuesHash{$id.'.title'} = &escape($Title);
12494: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
12495: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 12496: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 12497: $ValuesHash{$id.'.NumBars'} = $NumBars;
12498: $ValuesHash{$id.'.NumSets'} = $NumSets;
12499: $ValuesHash{$id.'.PlotType'} = 'bar';
12500: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
12501: $ValuesHash{$id.'.height'} = $height;
12502: $ValuesHash{$id.'.width'} = $width;
12503: $ValuesHash{$id.'.xskip'} = $xskip;
12504: $ValuesHash{$id.'.bar_width'} = $bar_width;
12505: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 12506: #
1.228 matthew 12507: # Deal with other parameters
12508: while (my ($key,$value) = each(%$extra_settings)) {
12509: $ValuesHash{$id.'.'.$key} = $value;
12510: }
12511: #
1.646 raeburn 12512: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 12513: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
12514: }
12515:
12516: ############################################################
12517: ############################################################
12518:
12519: =pod
12520:
1.648 raeburn 12521: =item * &DrawXYGraph()
1.137 matthew 12522:
1.138 matthew 12523: Facilitates the plotting of data in an XY graph.
12524: Puts plot definition data into the users environment in order for
12525: graph.png to plot it. Returns an <img> tag for the plot.
12526:
12527: Inputs:
12528:
12529: =over 4
12530:
12531: =item $Title: string, the title of the plot
12532:
12533: =item $xlabel: string, text describing the X-axis of the plot
12534:
12535: =item $ylabel: string, text describing the Y-axis of the plot
12536:
12537: =item $Max: scalar, the maximum Y value to use in the plot
12538: If $Max is < any data point, the graph will not be rendered.
12539:
12540: =item $colors: Array ref containing the hex color codes for the data to be
12541: plotted in. If undefined, default values will be used.
12542:
12543: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
12544:
12545: =item $Ydata: Array ref containing Array refs.
1.185 www 12546: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 12547:
12548: =item %Values: hash indicating or overriding any default values which are
12549: passed to graph.png.
12550: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
12551:
12552: =back
12553:
12554: Returns:
12555:
12556: An <img> tag which references graph.png and the appropriate identifying
12557: information for the plot.
12558:
1.137 matthew 12559: =cut
12560:
12561: ############################################################
12562: ############################################################
12563: sub DrawXYGraph {
12564: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
12565: #
12566: # Create the identifier for the graph
12567: my $identifier = &get_cgi_id();
12568: my $id = 'cgi.'.$identifier;
12569: #
12570: $Title = '' if (! defined($Title));
12571: $xlabel = '' if (! defined($xlabel));
12572: $ylabel = '' if (! defined($ylabel));
12573: my %ValuesHash =
12574: (
1.369 www 12575: $id.'.title' => &escape($Title),
12576: $id.'.xlabel' => &escape($xlabel),
12577: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 12578: $id.'.y_max_value'=> $Max,
12579: $id.'.labels' => join(',',@$Xlabels),
12580: $id.'.PlotType' => 'XY',
12581: );
12582: #
12583: if (defined($colors) && ref($colors) eq 'ARRAY') {
12584: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
12585: }
12586: #
12587: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
12588: return '';
12589: }
12590: my $NumSets=1;
1.138 matthew 12591: foreach my $array (@{$Ydata}){
1.137 matthew 12592: next if (! ref($array));
12593: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
12594: }
1.138 matthew 12595: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 12596: #
12597: # Deal with other parameters
12598: while (my ($key,$value) = each(%Values)) {
12599: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 12600: }
12601: #
1.646 raeburn 12602: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 12603: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
12604: }
12605:
12606: ############################################################
12607: ############################################################
12608:
12609: =pod
12610:
1.648 raeburn 12611: =item * &DrawXYYGraph()
1.138 matthew 12612:
12613: Facilitates the plotting of data in an XY graph with two Y axes.
12614: Puts plot definition data into the users environment in order for
12615: graph.png to plot it. Returns an <img> tag for the plot.
12616:
12617: Inputs:
12618:
12619: =over 4
12620:
12621: =item $Title: string, the title of the plot
12622:
12623: =item $xlabel: string, text describing the X-axis of the plot
12624:
12625: =item $ylabel: string, text describing the Y-axis of the plot
12626:
12627: =item $colors: Array ref containing the hex color codes for the data to be
12628: plotted in. If undefined, default values will be used.
12629:
12630: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
12631:
12632: =item $Ydata1: The first data set
12633:
12634: =item $Min1: The minimum value of the left Y-axis
12635:
12636: =item $Max1: The maximum value of the left Y-axis
12637:
12638: =item $Ydata2: The second data set
12639:
12640: =item $Min2: The minimum value of the right Y-axis
12641:
12642: =item $Max2: The maximum value of the left Y-axis
12643:
12644: =item %Values: hash indicating or overriding any default values which are
12645: passed to graph.png.
12646: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
12647:
12648: =back
12649:
12650: Returns:
12651:
12652: An <img> tag which references graph.png and the appropriate identifying
12653: information for the plot.
1.136 matthew 12654:
12655: =cut
12656:
12657: ############################################################
12658: ############################################################
1.137 matthew 12659: sub DrawXYYGraph {
12660: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
12661: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 12662: #
12663: # Create the identifier for the graph
12664: my $identifier = &get_cgi_id();
12665: my $id = 'cgi.'.$identifier;
12666: #
12667: $Title = '' if (! defined($Title));
12668: $xlabel = '' if (! defined($xlabel));
12669: $ylabel = '' if (! defined($ylabel));
12670: my %ValuesHash =
12671: (
1.369 www 12672: $id.'.title' => &escape($Title),
12673: $id.'.xlabel' => &escape($xlabel),
12674: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 12675: $id.'.labels' => join(',',@$Xlabels),
12676: $id.'.PlotType' => 'XY',
12677: $id.'.NumSets' => 2,
1.137 matthew 12678: $id.'.two_axes' => 1,
12679: $id.'.y1_max_value' => $Max1,
12680: $id.'.y1_min_value' => $Min1,
12681: $id.'.y2_max_value' => $Max2,
12682: $id.'.y2_min_value' => $Min2,
1.136 matthew 12683: );
12684: #
1.137 matthew 12685: if (defined($colors) && ref($colors) eq 'ARRAY') {
12686: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
12687: }
12688: #
12689: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
12690: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 12691: return '';
12692: }
12693: my $NumSets=1;
1.137 matthew 12694: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 12695: next if (! ref($array));
12696: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 12697: }
12698: #
12699: # Deal with other parameters
12700: while (my ($key,$value) = each(%Values)) {
12701: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 12702: }
12703: #
1.646 raeburn 12704: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 12705: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 12706: }
12707:
12708: ############################################################
12709: ############################################################
12710:
12711: =pod
12712:
1.157 matthew 12713: =back
12714:
1.139 matthew 12715: =head1 Statistics helper routines?
12716:
12717: Bad place for them but what the hell.
12718:
1.157 matthew 12719: =over 4
12720:
1.648 raeburn 12721: =item * &chartlink()
1.139 matthew 12722:
12723: Returns a link to the chart for a specific student.
12724:
12725: Inputs:
12726:
12727: =over 4
12728:
12729: =item $linktext: The text of the link
12730:
12731: =item $sname: The students username
12732:
12733: =item $sdomain: The students domain
12734:
12735: =back
12736:
1.157 matthew 12737: =back
12738:
1.139 matthew 12739: =cut
12740:
12741: ############################################################
12742: ############################################################
12743: sub chartlink {
12744: my ($linktext, $sname, $sdomain) = @_;
12745: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 12746: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 12747: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 12748: '">'.$linktext.'</a>';
1.153 matthew 12749: }
12750:
12751: #######################################################
12752: #######################################################
12753:
12754: =pod
12755:
12756: =head1 Course Environment Routines
1.157 matthew 12757:
12758: =over 4
1.153 matthew 12759:
1.648 raeburn 12760: =item * &restore_course_settings()
1.153 matthew 12761:
1.648 raeburn 12762: =item * &store_course_settings()
1.153 matthew 12763:
12764: Restores/Store indicated form parameters from the course environment.
12765: Will not overwrite existing values of the form parameters.
12766:
12767: Inputs:
12768: a scalar describing the data (e.g. 'chart', 'problem_analysis')
12769:
12770: a hash ref describing the data to be stored. For example:
12771:
12772: %Save_Parameters = ('Status' => 'scalar',
12773: 'chartoutputmode' => 'scalar',
12774: 'chartoutputdata' => 'scalar',
12775: 'Section' => 'array',
1.373 raeburn 12776: 'Group' => 'array',
1.153 matthew 12777: 'StudentData' => 'array',
12778: 'Maps' => 'array');
12779:
12780: Returns: both routines return nothing
12781:
1.631 raeburn 12782: =back
12783:
1.153 matthew 12784: =cut
12785:
12786: #######################################################
12787: #######################################################
12788: sub store_course_settings {
1.496 albertel 12789: return &store_settings($env{'request.course.id'},@_);
12790: }
12791:
12792: sub store_settings {
1.153 matthew 12793: # save to the environment
12794: # appenv the same items, just to be safe
1.300 albertel 12795: my $udom = $env{'user.domain'};
12796: my $uname = $env{'user.name'};
1.496 albertel 12797: my ($context,$prefix,$Settings) = @_;
1.153 matthew 12798: my %SaveHash;
12799: my %AppHash;
12800: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 12801: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 12802: my $envname = 'environment.'.$basename;
1.258 albertel 12803: if (exists($env{'form.'.$setting})) {
1.153 matthew 12804: # Save this value away
12805: if ($type eq 'scalar' &&
1.258 albertel 12806: (! exists($env{$envname}) ||
12807: $env{$envname} ne $env{'form.'.$setting})) {
12808: $SaveHash{$basename} = $env{'form.'.$setting};
12809: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 12810: } elsif ($type eq 'array') {
12811: my $stored_form;
1.258 albertel 12812: if (ref($env{'form.'.$setting})) {
1.153 matthew 12813: $stored_form = join(',',
12814: map {
1.369 www 12815: &escape($_);
1.258 albertel 12816: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 12817: } else {
12818: $stored_form =
1.369 www 12819: &escape($env{'form.'.$setting});
1.153 matthew 12820: }
12821: # Determine if the array contents are the same.
1.258 albertel 12822: if ($stored_form ne $env{$envname}) {
1.153 matthew 12823: $SaveHash{$basename} = $stored_form;
12824: $AppHash{$envname} = $stored_form;
12825: }
12826: }
12827: }
12828: }
12829: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 12830: $udom,$uname);
1.153 matthew 12831: if ($put_result !~ /^(ok|delayed)/) {
12832: &Apache::lonnet::logthis('unable to save form parameters, '.
12833: 'got error:'.$put_result);
12834: }
12835: # Make sure these settings stick around in this session, too
1.646 raeburn 12836: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 12837: return;
12838: }
12839:
12840: sub restore_course_settings {
1.499 albertel 12841: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 12842: }
12843:
12844: sub restore_settings {
12845: my ($context,$prefix,$Settings) = @_;
1.153 matthew 12846: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 12847: next if (exists($env{'form.'.$setting}));
1.496 albertel 12848: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 12849: '.'.$setting;
1.258 albertel 12850: if (exists($env{$envname})) {
1.153 matthew 12851: if ($type eq 'scalar') {
1.258 albertel 12852: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 12853: } elsif ($type eq 'array') {
1.258 albertel 12854: $env{'form.'.$setting} = [
1.153 matthew 12855: map {
1.369 www 12856: &unescape($_);
1.258 albertel 12857: } split(',',$env{$envname})
1.153 matthew 12858: ];
12859: }
12860: }
12861: }
1.127 matthew 12862: }
12863:
1.618 raeburn 12864: #######################################################
12865: #######################################################
12866:
12867: =pod
12868:
12869: =head1 Domain E-mail Routines
12870:
12871: =over 4
12872:
1.648 raeburn 12873: =item * &build_recipient_list()
1.618 raeburn 12874:
1.884 raeburn 12875: Build recipient lists for five types of e-mail:
1.766 raeburn 12876: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884 raeburn 12877: (d) Help requests, (e) Course requests needing approval, generated by
12878: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
12879: loncoursequeueadmin.pm respectively.
1.618 raeburn 12880:
12881: Inputs:
1.619 raeburn 12882: defmail (scalar - email address of default recipient),
1.618 raeburn 12883: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 12884: defdom (domain for which to retrieve configuration settings),
12885: origmail (scalar - email address of recipient from loncapa.conf,
12886: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 12887:
1.655 raeburn 12888: Returns: comma separated list of addresses to which to send e-mail.
12889:
12890: =back
1.618 raeburn 12891:
12892: =cut
12893:
12894: ############################################################
12895: ############################################################
12896: sub build_recipient_list {
1.619 raeburn 12897: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 12898: my @recipients;
12899: my $otheremails;
12900: my %domconfig =
12901: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
12902: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 12903: if (exists($domconfig{'contacts'}{$mailing})) {
12904: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
12905: my @contacts = ('adminemail','supportemail');
12906: foreach my $item (@contacts) {
12907: if ($domconfig{'contacts'}{$mailing}{$item}) {
12908: my $addr = $domconfig{'contacts'}{$item};
12909: if (!grep(/^\Q$addr\E$/,@recipients)) {
12910: push(@recipients,$addr);
12911: }
1.619 raeburn 12912: }
1.766 raeburn 12913: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 12914: }
12915: }
1.766 raeburn 12916: } elsif ($origmail ne '') {
12917: push(@recipients,$origmail);
1.618 raeburn 12918: }
1.619 raeburn 12919: } elsif ($origmail ne '') {
12920: push(@recipients,$origmail);
1.618 raeburn 12921: }
1.688 raeburn 12922: if (defined($defmail)) {
12923: if ($defmail ne '') {
12924: push(@recipients,$defmail);
12925: }
1.618 raeburn 12926: }
12927: if ($otheremails) {
1.619 raeburn 12928: my @others;
12929: if ($otheremails =~ /,/) {
12930: @others = split(/,/,$otheremails);
1.618 raeburn 12931: } else {
1.619 raeburn 12932: push(@others,$otheremails);
12933: }
12934: foreach my $addr (@others) {
12935: if (!grep(/^\Q$addr\E$/,@recipients)) {
12936: push(@recipients,$addr);
12937: }
1.618 raeburn 12938: }
12939: }
1.619 raeburn 12940: my $recipientlist = join(',',@recipients);
1.618 raeburn 12941: return $recipientlist;
12942: }
12943:
1.127 matthew 12944: ############################################################
12945: ############################################################
1.154 albertel 12946:
1.655 raeburn 12947: =pod
12948:
12949: =head1 Course Catalog Routines
12950:
12951: =over 4
12952:
12953: =item * &gather_categories()
12954:
12955: Converts category definitions - keys of categories hash stored in
12956: coursecategories in configuration.db on the primary library server in a
12957: domain - to an array. Also generates javascript and idx hash used to
12958: generate Domain Coordinator interface for editing Course Categories.
12959:
12960: Inputs:
1.663 raeburn 12961:
1.655 raeburn 12962: categories (reference to hash of category definitions).
1.663 raeburn 12963:
1.655 raeburn 12964: cats (reference to array of arrays/hashes which encapsulates hierarchy of
12965: categories and subcategories).
1.663 raeburn 12966:
1.655 raeburn 12967: idx (reference to hash of counters used in Domain Coordinator interface for
12968: editing Course Categories).
1.663 raeburn 12969:
1.655 raeburn 12970: jsarray (reference to array of categories used to create Javascript arrays for
12971: Domain Coordinator interface for editing Course Categories).
12972:
12973: Returns: nothing
12974:
12975: Side effects: populates cats, idx and jsarray.
12976:
12977: =cut
12978:
12979: sub gather_categories {
12980: my ($categories,$cats,$idx,$jsarray) = @_;
12981: my %counters;
12982: my $num = 0;
12983: foreach my $item (keys(%{$categories})) {
12984: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
12985: if ($container eq '' && $depth == 0) {
12986: $cats->[$depth][$categories->{$item}] = $cat;
12987: } else {
12988: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
12989: }
12990: my ($escitem,$tail) = split(/:/,$item,2);
12991: if ($counters{$tail} eq '') {
12992: $counters{$tail} = $num;
12993: $num ++;
12994: }
12995: if (ref($idx) eq 'HASH') {
12996: $idx->{$item} = $counters{$tail};
12997: }
12998: if (ref($jsarray) eq 'ARRAY') {
12999: push(@{$jsarray->[$counters{$tail}]},$item);
13000: }
13001: }
13002: return;
13003: }
13004:
13005: =pod
13006:
13007: =item * &extract_categories()
13008:
13009: Used to generate breadcrumb trails for course categories.
13010:
13011: Inputs:
1.663 raeburn 13012:
1.655 raeburn 13013: categories (reference to hash of category definitions).
1.663 raeburn 13014:
1.655 raeburn 13015: cats (reference to array of arrays/hashes which encapsulates hierarchy of
13016: categories and subcategories).
1.663 raeburn 13017:
1.655 raeburn 13018: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 13019:
1.655 raeburn 13020: allitems (reference to hash - key is category key
13021: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 13022:
1.655 raeburn 13023: idx (reference to hash of counters used in Domain Coordinator interface for
13024: editing Course Categories).
1.663 raeburn 13025:
1.655 raeburn 13026: jsarray (reference to array of categories used to create Javascript arrays for
13027: Domain Coordinator interface for editing Course Categories).
13028:
1.665 raeburn 13029: subcats (reference to hash of arrays containing all subcategories within each
13030: category, -recursive)
13031:
1.655 raeburn 13032: Returns: nothing
13033:
13034: Side effects: populates trails and allitems hash references.
13035:
13036: =cut
13037:
13038: sub extract_categories {
1.665 raeburn 13039: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 13040: if (ref($categories) eq 'HASH') {
13041: &gather_categories($categories,$cats,$idx,$jsarray);
13042: if (ref($cats->[0]) eq 'ARRAY') {
13043: for (my $i=0; $i<@{$cats->[0]}; $i++) {
13044: my $name = $cats->[0][$i];
13045: my $item = &escape($name).'::0';
13046: my $trailstr;
13047: if ($name eq 'instcode') {
13048: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 13049: } elsif ($name eq 'communities') {
13050: $trailstr = &mt('Communities');
1.655 raeburn 13051: } else {
13052: $trailstr = $name;
13053: }
13054: if ($allitems->{$item} eq '') {
13055: push(@{$trails},$trailstr);
13056: $allitems->{$item} = scalar(@{$trails})-1;
13057: }
13058: my @parents = ($name);
13059: if (ref($cats->[1]{$name}) eq 'ARRAY') {
13060: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
13061: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 13062: if (ref($subcats) eq 'HASH') {
13063: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
13064: }
13065: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
13066: }
13067: } else {
13068: if (ref($subcats) eq 'HASH') {
13069: $subcats->{$item} = [];
1.655 raeburn 13070: }
13071: }
13072: }
13073: }
13074: }
13075: return;
13076: }
13077:
13078: =pod
13079:
13080: =item *&recurse_categories()
13081:
13082: Recursively used to generate breadcrumb trails for course categories.
13083:
13084: Inputs:
1.663 raeburn 13085:
1.655 raeburn 13086: cats (reference to array of arrays/hashes which encapsulates hierarchy of
13087: categories and subcategories).
1.663 raeburn 13088:
1.655 raeburn 13089: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 13090:
13091: category (current course category, for which breadcrumb trail is being generated).
13092:
13093: trails (reference to array of breadcrumb trails for each category).
13094:
1.655 raeburn 13095: allitems (reference to hash - key is category key
13096: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 13097:
1.655 raeburn 13098: parents (array containing containers directories for current category,
13099: back to top level).
13100:
13101: Returns: nothing
13102:
13103: Side effects: populates trails and allitems hash references
13104:
13105: =cut
13106:
13107: sub recurse_categories {
1.665 raeburn 13108: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 13109: my $shallower = $depth - 1;
13110: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
13111: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
13112: my $name = $cats->[$depth]{$category}[$k];
13113: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
13114: my $trailstr = join(' -> ',(@{$parents},$category));
13115: if ($allitems->{$item} eq '') {
13116: push(@{$trails},$trailstr);
13117: $allitems->{$item} = scalar(@{$trails})-1;
13118: }
13119: my $deeper = $depth+1;
13120: push(@{$parents},$category);
1.665 raeburn 13121: if (ref($subcats) eq 'HASH') {
13122: my $subcat = &escape($name).':'.$category.':'.$depth;
13123: for (my $j=@{$parents}; $j>=0; $j--) {
13124: my $higher;
13125: if ($j > 0) {
13126: $higher = &escape($parents->[$j]).':'.
13127: &escape($parents->[$j-1]).':'.$j;
13128: } else {
13129: $higher = &escape($parents->[$j]).'::'.$j;
13130: }
13131: push(@{$subcats->{$higher}},$subcat);
13132: }
13133: }
13134: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
13135: $subcats);
1.655 raeburn 13136: pop(@{$parents});
13137: }
13138: } else {
13139: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
13140: my $trailstr = join(' -> ',(@{$parents},$category));
13141: if ($allitems->{$item} eq '') {
13142: push(@{$trails},$trailstr);
13143: $allitems->{$item} = scalar(@{$trails})-1;
13144: }
13145: }
13146: return;
13147: }
13148:
1.663 raeburn 13149: =pod
13150:
13151: =item *&assign_categories_table()
13152:
13153: Create a datatable for display of hierarchical categories in a domain,
13154: with checkboxes to allow a course to be categorized.
13155:
13156: Inputs:
13157:
13158: cathash - reference to hash of categories defined for the domain (from
13159: configuration.db)
13160:
13161: currcat - scalar with an & separated list of categories assigned to a course.
13162:
1.919 raeburn 13163: type - scalar contains course type (Course or Community).
13164:
1.663 raeburn 13165: Returns: $output (markup to be displayed)
13166:
13167: =cut
13168:
13169: sub assign_categories_table {
1.919 raeburn 13170: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 13171: my $output;
13172: if (ref($cathash) eq 'HASH') {
13173: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
13174: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
13175: $maxdepth = scalar(@cats);
13176: if (@cats > 0) {
13177: my $itemcount = 0;
13178: if (ref($cats[0]) eq 'ARRAY') {
13179: my @currcategories;
13180: if ($currcat ne '') {
13181: @currcategories = split('&',$currcat);
13182: }
1.919 raeburn 13183: my $table;
1.663 raeburn 13184: for (my $i=0; $i<@{$cats[0]}; $i++) {
13185: my $parent = $cats[0][$i];
1.919 raeburn 13186: next if ($parent eq 'instcode');
13187: if ($type eq 'Community') {
13188: next unless ($parent eq 'communities');
13189: } else {
13190: next if ($parent eq 'communities');
13191: }
1.663 raeburn 13192: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
13193: my $item = &escape($parent).'::0';
13194: my $checked = '';
13195: if (@currcategories > 0) {
13196: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 13197: $checked = ' checked="checked"';
1.663 raeburn 13198: }
13199: }
1.919 raeburn 13200: my $parent_title = $parent;
13201: if ($parent eq 'communities') {
13202: $parent_title = &mt('Communities');
13203: }
13204: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
13205: '<input type="checkbox" name="usecategory" value="'.
13206: $item.'"'.$checked.' />'.$parent_title.'</span>'.
13207: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 13208: my $depth = 1;
13209: push(@path,$parent);
1.919 raeburn 13210: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 13211: pop(@path);
1.919 raeburn 13212: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 13213: $itemcount ++;
13214: }
1.919 raeburn 13215: if ($itemcount) {
13216: $output = &Apache::loncommon::start_data_table().
13217: $table.
13218: &Apache::loncommon::end_data_table();
13219: }
1.663 raeburn 13220: }
13221: }
13222: }
13223: return $output;
13224: }
13225:
13226: =pod
13227:
13228: =item *&assign_category_rows()
13229:
13230: Create a datatable row for display of nested categories in a domain,
13231: with checkboxes to allow a course to be categorized,called recursively.
13232:
13233: Inputs:
13234:
13235: itemcount - track row number for alternating colors
13236:
13237: cats - reference to array of arrays/hashes which encapsulates hierarchy of
13238: categories and subcategories.
13239:
13240: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
13241:
13242: parent - parent of current category item
13243:
13244: path - Array containing all categories back up through the hierarchy from the
13245: current category to the top level.
13246:
13247: currcategories - reference to array of current categories assigned to the course
13248:
13249: Returns: $output (markup to be displayed).
13250:
13251: =cut
13252:
13253: sub assign_category_rows {
13254: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
13255: my ($text,$name,$item,$chgstr);
13256: if (ref($cats) eq 'ARRAY') {
13257: my $maxdepth = scalar(@{$cats});
13258: if (ref($cats->[$depth]) eq 'HASH') {
13259: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
13260: my $numchildren = @{$cats->[$depth]{$parent}};
13261: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
13262: $text .= '<td><table class="LC_datatable">';
13263: for (my $j=0; $j<$numchildren; $j++) {
13264: $name = $cats->[$depth]{$parent}[$j];
13265: $item = &escape($name).':'.&escape($parent).':'.$depth;
13266: my $deeper = $depth+1;
13267: my $checked = '';
13268: if (ref($currcategories) eq 'ARRAY') {
13269: if (@{$currcategories} > 0) {
13270: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 13271: $checked = ' checked="checked"';
1.663 raeburn 13272: }
13273: }
13274: }
1.664 raeburn 13275: $text .= '<tr><td><span class="LC_nobreak"><label>'.
13276: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 13277: $item.'"'.$checked.' />'.$name.'</label></span>'.
13278: '<input type="hidden" name="catname" value="'.$name.'" />'.
13279: '</td><td>';
1.663 raeburn 13280: if (ref($path) eq 'ARRAY') {
13281: push(@{$path},$name);
13282: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
13283: pop(@{$path});
13284: }
13285: $text .= '</td></tr>';
13286: }
13287: $text .= '</table></td>';
13288: }
13289: }
13290: }
13291: return $text;
13292: }
13293:
1.655 raeburn 13294: ############################################################
13295: ############################################################
13296:
13297:
1.443 albertel 13298: sub commit_customrole {
1.664 raeburn 13299: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 13300: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 13301: ($start?', '.&mt('starting').' '.localtime($start):'').
13302: ($end?', ending '.localtime($end):'').': <b>'.
13303: &Apache::lonnet::assigncustomrole(
1.664 raeburn 13304: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 13305: '</b><br />';
13306: return $output;
13307: }
13308:
13309: sub commit_standardrole {
1.1075.2.31 raeburn 13310: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits) = @_;
1.541 raeburn 13311: my ($output,$logmsg,$linefeed);
13312: if ($context eq 'auto') {
13313: $linefeed = "\n";
13314: } else {
13315: $linefeed = "<br />\n";
13316: }
1.443 albertel 13317: if ($three eq 'st') {
1.541 raeburn 13318: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1075.2.31 raeburn 13319: $one,$two,$sec,$context,$credits);
1.541 raeburn 13320: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 13321: ($result eq 'unknown_course') || ($result eq 'refused')) {
13322: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 13323: } else {
1.541 raeburn 13324: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 13325: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 13326: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
13327: if ($context eq 'auto') {
13328: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
13329: } else {
13330: $output .= '<b>'.$result.'</b>'.$linefeed.
13331: &mt('Add to classlist').': <b>ok</b>';
13332: }
13333: $output .= $linefeed;
1.443 albertel 13334: }
13335: } else {
13336: $output = &mt('Assigning').' '.$three.' in '.$url.
13337: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 13338: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 13339: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 13340: if ($context eq 'auto') {
13341: $output .= $result.$linefeed;
13342: } else {
13343: $output .= '<b>'.$result.'</b>'.$linefeed;
13344: }
1.443 albertel 13345: }
13346: return $output;
13347: }
13348:
13349: sub commit_studentrole {
1.1075.2.31 raeburn 13350: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
13351: $credits) = @_;
1.626 raeburn 13352: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 13353: if ($context eq 'auto') {
13354: $linefeed = "\n";
13355: } else {
13356: $linefeed = '<br />'."\n";
13357: }
1.443 albertel 13358: if (defined($one) && defined($two)) {
13359: my $cid=$one.'_'.$two;
13360: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
13361: my $secchange = 0;
13362: my $expire_role_result;
13363: my $modify_section_result;
1.628 raeburn 13364: if ($oldsec ne '-1') {
13365: if ($oldsec ne $sec) {
1.443 albertel 13366: $secchange = 1;
1.628 raeburn 13367: my $now = time;
1.443 albertel 13368: my $uurl='/'.$cid;
13369: $uurl=~s/\_/\//g;
13370: if ($oldsec) {
13371: $uurl.='/'.$oldsec;
13372: }
1.626 raeburn 13373: $oldsecurl = $uurl;
1.628 raeburn 13374: $expire_role_result =
1.652 raeburn 13375: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 13376: if ($env{'request.course.sec'} ne '') {
13377: if ($expire_role_result eq 'refused') {
13378: my @roles = ('st');
13379: my @statuses = ('previous');
13380: my @roledoms = ($one);
13381: my $withsec = 1;
13382: my %roleshash =
13383: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
13384: \@statuses,\@roles,\@roledoms,$withsec);
13385: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
13386: my ($oldstart,$oldend) =
13387: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
13388: if ($oldend > 0 && $oldend <= $now) {
13389: $expire_role_result = 'ok';
13390: }
13391: }
13392: }
13393: }
1.443 albertel 13394: $result = $expire_role_result;
13395: }
13396: }
13397: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1075.2.31 raeburn 13398: $modify_section_result =
13399: &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
13400: undef,undef,undef,$sec,
13401: $end,$start,'','',$cid,
13402: '',$context,$credits);
1.443 albertel 13403: if ($modify_section_result =~ /^ok/) {
13404: if ($secchange == 1) {
1.628 raeburn 13405: if ($sec eq '') {
13406: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
13407: } else {
13408: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
13409: }
1.443 albertel 13410: } elsif ($oldsec eq '-1') {
1.628 raeburn 13411: if ($sec eq '') {
13412: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
13413: } else {
13414: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
13415: }
1.443 albertel 13416: } else {
1.628 raeburn 13417: if ($sec eq '') {
13418: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
13419: } else {
13420: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
13421: }
1.443 albertel 13422: }
13423: } else {
1.628 raeburn 13424: if ($secchange) {
13425: $$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;
13426: } else {
13427: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
13428: }
1.443 albertel 13429: }
13430: $result = $modify_section_result;
13431: } elsif ($secchange == 1) {
1.628 raeburn 13432: if ($oldsec eq '') {
1.1075.2.20 raeburn 13433: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_2] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
1.628 raeburn 13434: } else {
13435: $$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;
13436: }
1.626 raeburn 13437: if ($expire_role_result eq 'refused') {
13438: my $newsecurl = '/'.$cid;
13439: $newsecurl =~ s/\_/\//g;
13440: if ($sec ne '') {
13441: $newsecurl.='/'.$sec;
13442: }
13443: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
13444: if ($sec eq '') {
13445: $$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;
13446: } else {
13447: $$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;
13448: }
13449: }
13450: }
1.443 albertel 13451: }
13452: } else {
1.626 raeburn 13453: $$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 13454: $result = "error: incomplete course id\n";
13455: }
13456: return $result;
13457: }
13458:
1.1075.2.25 raeburn 13459: sub show_role_extent {
13460: my ($scope,$context,$role) = @_;
13461: $scope =~ s{^/}{};
13462: my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
13463: push(@courseroles,'co');
13464: my @authorroles = &Apache::lonuserutils::roles_by_context('author');
13465: if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
13466: $scope =~ s{/}{_};
13467: return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
13468: } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
13469: my ($audom,$auname) = split(/\//,$scope);
13470: return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
13471: &Apache::loncommon::plainname($auname,$audom).'</span>');
13472: } else {
13473: $scope =~ s{/$}{};
13474: return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
13475: &Apache::lonnet::domain($scope,'description').'</span>');
13476: }
13477: }
13478:
1.443 albertel 13479: ############################################################
13480: ############################################################
13481:
1.566 albertel 13482: sub check_clone {
1.578 raeburn 13483: my ($args,$linefeed) = @_;
1.566 albertel 13484: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
13485: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
13486: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
13487: my $clonemsg;
13488: my $can_clone = 0;
1.944 raeburn 13489: my $lctype = lc($args->{'crstype'});
1.908 raeburn 13490: if ($lctype ne 'community') {
13491: $lctype = 'course';
13492: }
1.566 albertel 13493: if ($clonehome eq 'no_host') {
1.944 raeburn 13494: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13495: $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'});
13496: } else {
13497: $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'});
13498: }
1.566 albertel 13499: } else {
13500: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944 raeburn 13501: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13502: if ($clonedesc{'type'} ne 'Community') {
13503: $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'});
13504: return ($can_clone, $clonemsg, $cloneid, $clonehome);
13505: }
13506: }
1.882 raeburn 13507: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
13508: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 13509: $can_clone = 1;
13510: } else {
13511: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
13512: $args->{'clonedomain'},$args->{'clonecourse'});
13513: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 13514: if (grep(/^\*$/,@cloners)) {
13515: $can_clone = 1;
13516: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
13517: $can_clone = 1;
13518: } else {
1.908 raeburn 13519: my $ccrole = 'cc';
1.944 raeburn 13520: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13521: $ccrole = 'co';
13522: }
1.578 raeburn 13523: my %roleshash =
13524: &Apache::lonnet::get_my_roles($args->{'ccuname'},
13525: $args->{'ccdomain'},
1.908 raeburn 13526: 'userroles',['active'],[$ccrole],
1.578 raeburn 13527: [$args->{'clonedomain'}]);
1.908 raeburn 13528: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942 raeburn 13529: $can_clone = 1;
13530: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
13531: $can_clone = 1;
13532: } else {
1.944 raeburn 13533: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13534: $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'});
13535: } else {
13536: $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'});
13537: }
1.578 raeburn 13538: }
1.566 albertel 13539: }
1.578 raeburn 13540: }
1.566 albertel 13541: }
13542: return ($can_clone, $clonemsg, $cloneid, $clonehome);
13543: }
13544:
1.444 albertel 13545: sub construct_course {
1.885 raeburn 13546: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444 albertel 13547: my $outcome;
1.541 raeburn 13548: my $linefeed = '<br />'."\n";
13549: if ($context eq 'auto') {
13550: $linefeed = "\n";
13551: }
1.566 albertel 13552:
13553: #
13554: # Are we cloning?
13555: #
13556: my ($can_clone, $clonemsg, $cloneid, $clonehome);
13557: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 13558: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 13559: if ($context ne 'auto') {
1.578 raeburn 13560: if ($clonemsg ne '') {
13561: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
13562: }
1.566 albertel 13563: }
13564: $outcome .= $clonemsg.$linefeed;
13565:
13566: if (!$can_clone) {
13567: return (0,$outcome);
13568: }
13569: }
13570:
1.444 albertel 13571: #
13572: # Open course
13573: #
13574: my $crstype = lc($args->{'crstype'});
13575: my %cenv=();
13576: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
13577: $args->{'cdescr'},
13578: $args->{'curl'},
13579: $args->{'course_home'},
13580: $args->{'nonstandard'},
13581: $args->{'crscode'},
13582: $args->{'ccuname'}.':'.
13583: $args->{'ccdomain'},
1.882 raeburn 13584: $args->{'crstype'},
1.885 raeburn 13585: $cnum,$context,$category);
1.444 albertel 13586:
13587: # Note: The testing routines depend on this being output; see
13588: # Utils::Course. This needs to at least be output as a comment
13589: # if anyone ever decides to not show this, and Utils::Course::new
13590: # will need to be suitably modified.
1.541 raeburn 13591: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943 raeburn 13592: if ($$courseid =~ /^error:/) {
13593: return (0,$outcome);
13594: }
13595:
1.444 albertel 13596: #
13597: # Check if created correctly
13598: #
1.479 albertel 13599: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 13600: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 13601: if ($crsuhome eq 'no_host') {
13602: $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
13603: return (0,$outcome);
13604: }
1.541 raeburn 13605: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 13606:
1.444 albertel 13607: #
1.566 albertel 13608: # Do the cloning
13609: #
13610: if ($can_clone && $cloneid) {
13611: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
13612: if ($context ne 'auto') {
13613: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
13614: }
13615: $outcome .= $clonemsg.$linefeed;
13616: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 13617: # Copy all files
1.637 www 13618: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 13619: # Restore URL
1.566 albertel 13620: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 13621: # Restore title
1.566 albertel 13622: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 13623: # Restore creation date, creator and creation context.
13624: $cenv{'internal.created'}=$oldcenv{'internal.created'};
13625: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
13626: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 13627: # Mark as cloned
1.566 albertel 13628: $cenv{'clonedfrom'}=$cloneid;
1.638 www 13629: # Need to clone grading mode
13630: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
13631: $cenv{'grading'}=$newenv{'grading'};
13632: # Do not clone these environment entries
13633: &Apache::lonnet::del('environment',
13634: ['default_enrollment_start_date',
13635: 'default_enrollment_end_date',
13636: 'question.email',
13637: 'policy.email',
13638: 'comment.email',
13639: 'pch.users.denied',
1.725 raeburn 13640: 'plc.users.denied',
13641: 'hidefromcat',
1.1075.2.36 raeburn 13642: 'checkforpriv',
1.725 raeburn 13643: 'categories'],
1.638 www 13644: $$crsudom,$$crsunum);
1.444 albertel 13645: }
1.566 albertel 13646:
1.444 albertel 13647: #
13648: # Set environment (will override cloned, if existing)
13649: #
13650: my @sections = ();
13651: my @xlists = ();
13652: if ($args->{'crstype'}) {
13653: $cenv{'type'}=$args->{'crstype'};
13654: }
13655: if ($args->{'crsid'}) {
13656: $cenv{'courseid'}=$args->{'crsid'};
13657: }
13658: if ($args->{'crscode'}) {
13659: $cenv{'internal.coursecode'}=$args->{'crscode'};
13660: }
13661: if ($args->{'crsquota'} ne '') {
13662: $cenv{'internal.coursequota'}=$args->{'crsquota'};
13663: } else {
13664: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
13665: }
13666: if ($args->{'ccuname'}) {
13667: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
13668: ':'.$args->{'ccdomain'};
13669: } else {
13670: $cenv{'internal.courseowner'} = $args->{'curruser'};
13671: }
1.1075.2.31 raeburn 13672: if ($args->{'defaultcredits'}) {
13673: $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
13674: }
1.444 albertel 13675: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
13676: if ($args->{'crssections'}) {
13677: $cenv{'internal.sectionnums'} = '';
13678: if ($args->{'crssections'} =~ m/,/) {
13679: @sections = split/,/,$args->{'crssections'};
13680: } else {
13681: $sections[0] = $args->{'crssections'};
13682: }
13683: if (@sections > 0) {
13684: foreach my $item (@sections) {
13685: my ($sec,$gp) = split/:/,$item;
13686: my $class = $args->{'crscode'}.$sec;
13687: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
13688: $cenv{'internal.sectionnums'} .= $item.',';
13689: unless ($addcheck eq 'ok') {
13690: push @badclasses, $class;
13691: }
13692: }
13693: $cenv{'internal.sectionnums'} =~ s/,$//;
13694: }
13695: }
13696: # do not hide course coordinator from staff listing,
13697: # even if privileged
13698: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1075.2.36 raeburn 13699: # add course coordinator's domain to domains to check for privileged users
13700: # if different to course domain
13701: if ($$crsudom ne $args->{'ccdomain'}) {
13702: $cenv{'checkforpriv'} = $args->{'ccdomain'};
13703: }
1.444 albertel 13704: # add crosslistings
13705: if ($args->{'crsxlist'}) {
13706: $cenv{'internal.crosslistings'}='';
13707: if ($args->{'crsxlist'} =~ m/,/) {
13708: @xlists = split/,/,$args->{'crsxlist'};
13709: } else {
13710: $xlists[0] = $args->{'crsxlist'};
13711: }
13712: if (@xlists > 0) {
13713: foreach my $item (@xlists) {
13714: my ($xl,$gp) = split/:/,$item;
13715: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
13716: $cenv{'internal.crosslistings'} .= $item.',';
13717: unless ($addcheck eq 'ok') {
13718: push @badclasses, $xl;
13719: }
13720: }
13721: $cenv{'internal.crosslistings'} =~ s/,$//;
13722: }
13723: }
13724: if ($args->{'autoadds'}) {
13725: $cenv{'internal.autoadds'}=$args->{'autoadds'};
13726: }
13727: if ($args->{'autodrops'}) {
13728: $cenv{'internal.autodrops'}=$args->{'autodrops'};
13729: }
13730: # check for notification of enrollment changes
13731: my @notified = ();
13732: if ($args->{'notify_owner'}) {
13733: if ($args->{'ccuname'} ne '') {
13734: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
13735: }
13736: }
13737: if ($args->{'notify_dc'}) {
13738: if ($uname ne '') {
1.630 raeburn 13739: push(@notified,$uname.':'.$udom);
1.444 albertel 13740: }
13741: }
13742: if (@notified > 0) {
13743: my $notifylist;
13744: if (@notified > 1) {
13745: $notifylist = join(',',@notified);
13746: } else {
13747: $notifylist = $notified[0];
13748: }
13749: $cenv{'internal.notifylist'} = $notifylist;
13750: }
13751: if (@badclasses > 0) {
13752: my %lt=&Apache::lonlocal::texthash(
13753: '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',
13754: 'dnhr' => 'does not have rights to access enrollment in these classes',
13755: 'adby' => 'as determined by the policies of your institution on access to official classlists'
13756: );
1.541 raeburn 13757: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
13758: ' ('.$lt{'adby'}.')';
13759: if ($context eq 'auto') {
13760: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 13761: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 13762: foreach my $item (@badclasses) {
13763: if ($context eq 'auto') {
13764: $outcome .= " - $item\n";
13765: } else {
13766: $outcome .= "<li>$item</li>\n";
13767: }
13768: }
13769: if ($context eq 'auto') {
13770: $outcome .= $linefeed;
13771: } else {
1.566 albertel 13772: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 13773: }
13774: }
1.444 albertel 13775: }
13776: if ($args->{'no_end_date'}) {
13777: $args->{'endaccess'} = 0;
13778: }
13779: $cenv{'internal.autostart'}=$args->{'enrollstart'};
13780: $cenv{'internal.autoend'}=$args->{'enrollend'};
13781: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
13782: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
13783: if ($args->{'showphotos'}) {
13784: $cenv{'internal.showphotos'}=$args->{'showphotos'};
13785: }
13786: $cenv{'internal.authtype'} = $args->{'authtype'};
13787: $cenv{'internal.autharg'} = $args->{'autharg'};
13788: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
13789: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 13790: 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');
13791: if ($context eq 'auto') {
13792: $outcome .= $krb_msg;
13793: } else {
1.566 albertel 13794: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 13795: }
13796: $outcome .= $linefeed;
1.444 albertel 13797: }
13798: }
13799: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
13800: if ($args->{'setpolicy'}) {
13801: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
13802: }
13803: if ($args->{'setcontent'}) {
13804: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
13805: }
13806: }
13807: if ($args->{'reshome'}) {
13808: $cenv{'reshome'}=$args->{'reshome'}.'/';
13809: $cenv{'reshome'}=~s/\/+$/\//;
13810: }
13811: #
13812: # course has keyed access
13813: #
13814: if ($args->{'setkeys'}) {
13815: $cenv{'keyaccess'}='yes';
13816: }
13817: # if specified, key authority is not course, but user
13818: # only active if keyaccess is yes
13819: if ($args->{'keyauth'}) {
1.487 albertel 13820: my ($user,$domain) = split(':',$args->{'keyauth'});
13821: $user = &LONCAPA::clean_username($user);
13822: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 13823: if ($user ne '' && $domain ne '') {
1.487 albertel 13824: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 13825: }
13826: }
13827:
13828: if ($args->{'disresdis'}) {
13829: $cenv{'pch.roles.denied'}='st';
13830: }
13831: if ($args->{'disablechat'}) {
13832: $cenv{'plc.roles.denied'}='st';
13833: }
13834:
13835: # Record we've not yet viewed the Course Initialization Helper for this
13836: # course
13837: $cenv{'course.helper.not.run'} = 1;
13838: #
13839: # Use new Randomseed
13840: #
13841: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
13842: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
13843: #
13844: # The encryption code and receipt prefix for this course
13845: #
13846: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
13847: $cenv{'internal.encpref'}=100+int(9*rand(99));
13848: #
13849: # By default, use standard grading
13850: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
13851:
1.541 raeburn 13852: $outcome .= $linefeed.&mt('Setting environment').': '.
13853: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 13854: #
13855: # Open all assignments
13856: #
13857: if ($args->{'openall'}) {
13858: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
13859: my %storecontent = ($storeunder => time,
13860: $storeunder.'.type' => 'date_start');
13861:
13862: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 13863: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 13864: }
13865: #
13866: # Set first page
13867: #
13868: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
13869: || ($cloneid)) {
1.445 albertel 13870: use LONCAPA::map;
1.444 albertel 13871: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 13872:
13873: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
13874: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
13875:
1.444 albertel 13876: $outcome .= ($fatal?$errtext:'read ok').' - ';
13877: my $title; my $url;
13878: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 13879: $title=&mt('Syllabus');
1.444 albertel 13880: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
13881: } else {
1.963 raeburn 13882: $title=&mt('Table of Contents');
1.444 albertel 13883: $url='/adm/navmaps';
13884: }
1.445 albertel 13885:
13886: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
13887: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
13888:
13889: if ($errtext) { $fatal=2; }
1.541 raeburn 13890: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 13891: }
1.566 albertel 13892:
13893: return (1,$outcome);
1.444 albertel 13894: }
13895:
13896: ############################################################
13897: ############################################################
13898:
1.953 droeschl 13899: #SD
13900: # only Community and Course, or anything else?
1.378 raeburn 13901: sub course_type {
13902: my ($cid) = @_;
13903: if (!defined($cid)) {
13904: $cid = $env{'request.course.id'};
13905: }
1.404 albertel 13906: if (defined($env{'course.'.$cid.'.type'})) {
13907: return $env{'course.'.$cid.'.type'};
1.378 raeburn 13908: } else {
13909: return 'Course';
1.377 raeburn 13910: }
13911: }
1.156 albertel 13912:
1.406 raeburn 13913: sub group_term {
13914: my $crstype = &course_type();
13915: my %names = (
13916: 'Course' => 'group',
1.865 raeburn 13917: 'Community' => 'group',
1.406 raeburn 13918: );
13919: return $names{$crstype};
13920: }
13921:
1.902 raeburn 13922: sub course_types {
13923: my @types = ('official','unofficial','community');
13924: my %typename = (
13925: official => 'Official course',
13926: unofficial => 'Unofficial course',
13927: community => 'Community',
13928: );
13929: return (\@types,\%typename);
13930: }
13931:
1.156 albertel 13932: sub icon {
13933: my ($file)=@_;
1.505 albertel 13934: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 13935: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 13936: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 13937: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
13938: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
13939: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
13940: $curfext.".gif") {
13941: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
13942: $curfext.".gif";
13943: }
13944: }
1.249 albertel 13945: return &lonhttpdurl($iconname);
1.154 albertel 13946: }
1.84 albertel 13947:
1.575 albertel 13948: sub lonhttpdurl {
1.692 www 13949: #
13950: # Had been used for "small fry" static images on separate port 8080.
13951: # Modify here if lightweight http functionality desired again.
13952: # Currently eliminated due to increasing firewall issues.
13953: #
1.575 albertel 13954: my ($url)=@_;
1.692 www 13955: return $url;
1.215 albertel 13956: }
13957:
1.213 albertel 13958: sub connection_aborted {
13959: my ($r)=@_;
13960: $r->print(" ");$r->rflush();
13961: my $c = $r->connection;
13962: return $c->aborted();
13963: }
13964:
1.221 foxr 13965: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 13966: # strings as 'strings'.
13967: sub escape_single {
1.221 foxr 13968: my ($input) = @_;
1.223 albertel 13969: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 13970: $input =~ s/\'/\\\'/g; # Esacpe the 's....
13971: return $input;
13972: }
1.223 albertel 13973:
1.222 foxr 13974: # Same as escape_single, but escape's "'s This
13975: # can be used for "strings"
13976: sub escape_double {
13977: my ($input) = @_;
13978: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
13979: $input =~ s/\"/\\\"/g; # Esacpe the "s....
13980: return $input;
13981: }
1.223 albertel 13982:
1.222 foxr 13983: # Escapes the last element of a full URL.
13984: sub escape_url {
13985: my ($url) = @_;
1.238 raeburn 13986: my @urlslices = split(/\//, $url,-1);
1.369 www 13987: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 13988: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 13989: }
1.462 albertel 13990:
1.820 raeburn 13991: sub compare_arrays {
13992: my ($arrayref1,$arrayref2) = @_;
13993: my (@difference,%count);
13994: @difference = ();
13995: %count = ();
13996: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
13997: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
13998: foreach my $element (keys(%count)) {
13999: if ($count{$element} == 1) {
14000: push(@difference,$element);
14001: }
14002: }
14003: }
14004: return @difference;
14005: }
14006:
1.817 bisitz 14007: # -------------------------------------------------------- Initialize user login
1.462 albertel 14008: sub init_user_environment {
1.463 albertel 14009: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 14010: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
14011:
14012: my $public=($username eq 'public' && $domain eq 'public');
14013:
14014: # See if old ID present, if so, remove
14015:
1.1062 raeburn 14016: my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462 albertel 14017: my $now=time;
14018:
14019: if ($public) {
14020: my $max_public=100;
14021: my $oldest;
14022: my $oldest_time=0;
14023: for(my $next=1;$next<=$max_public;$next++) {
14024: if (-e $lonids."/publicuser_$next.id") {
14025: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
14026: if ($mtime<$oldest_time || !$oldest_time) {
14027: $oldest_time=$mtime;
14028: $oldest=$next;
14029: }
14030: } else {
14031: $cookie="publicuser_$next";
14032: last;
14033: }
14034: }
14035: if (!$cookie) { $cookie="publicuser_$oldest"; }
14036: } else {
1.463 albertel 14037: # if this isn't a robot, kill any existing non-robot sessions
14038: if (!$args->{'robot'}) {
14039: opendir(DIR,$lonids);
14040: while ($filename=readdir(DIR)) {
14041: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
14042: unlink($lonids.'/'.$filename);
14043: }
1.462 albertel 14044: }
1.463 albertel 14045: closedir(DIR);
1.462 albertel 14046: }
14047: # Give them a new cookie
1.463 albertel 14048: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 14049: : $now.$$.int(rand(10000)));
1.463 albertel 14050: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 14051:
14052: # Initialize roles
14053:
1.1062 raeburn 14054: ($userroles,$firstaccenv,$timerintenv) =
14055: &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462 albertel 14056: }
14057: # ------------------------------------ Check browser type and MathML capability
14058:
14059: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
14060: $clientunicode,$clientos) = &decode_user_agent($r);
14061:
14062: # ------------------------------------------------------------- Get environment
14063:
14064: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
14065: my ($tmp) = keys(%userenv);
14066: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
14067: } else {
14068: undef(%userenv);
14069: }
14070: if (($userenv{'interface'}) && (!$form->{'interface'})) {
14071: $form->{'interface'}=$userenv{'interface'};
14072: }
14073: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
14074:
14075: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 14076: foreach my $option ('interface','localpath','localres') {
14077: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 14078: }
14079: # --------------------------------------------------------- Write first profile
14080:
14081: {
14082: my %initial_env =
14083: ("user.name" => $username,
14084: "user.domain" => $domain,
14085: "user.home" => $authhost,
14086: "browser.type" => $clientbrowser,
14087: "browser.version" => $clientversion,
14088: "browser.mathml" => $clientmathml,
14089: "browser.unicode" => $clientunicode,
14090: "browser.os" => $clientos,
14091: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
14092: "request.course.fn" => '',
14093: "request.course.uri" => '',
14094: "request.course.sec" => '',
14095: "request.role" => 'cm',
14096: "request.role.adv" => $env{'user.adv'},
14097: "request.host" => $ENV{'REMOTE_ADDR'},);
14098:
14099: if ($form->{'localpath'}) {
14100: $initial_env{"browser.localpath"} = $form->{'localpath'};
14101: $initial_env{"browser.localres"} = $form->{'localres'};
14102: }
14103:
14104: if ($form->{'interface'}) {
14105: $form->{'interface'}=~s/\W//gs;
14106: $initial_env{"browser.interface"} = $form->{'interface'};
14107: $env{'browser.interface'}=$form->{'interface'};
14108: }
14109:
1.981 raeburn 14110: my %is_adv = ( is_adv => $env{'user.adv'} );
1.1016 raeburn 14111: my %domdef;
14112: unless ($domain eq 'public') {
14113: %domdef = &Apache::lonnet::get_domain_defaults($domain);
14114: }
1.980 raeburn 14115:
1.1075.2.7 raeburn 14116: foreach my $tool ('aboutme','blog','webdav','portfolio') {
1.724 raeburn 14117: $userenv{'availabletools.'.$tool} =
1.980 raeburn 14118: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
14119: undef,\%userenv,\%domdef,\%is_adv);
1.724 raeburn 14120: }
14121:
1.864 raeburn 14122: foreach my $crstype ('official','unofficial','community') {
1.765 raeburn 14123: $userenv{'canrequest.'.$crstype} =
14124: &Apache::lonnet::usertools_access($username,$domain,$crstype,
1.980 raeburn 14125: 'reload','requestcourses',
14126: \%userenv,\%domdef,\%is_adv);
1.765 raeburn 14127: }
14128:
1.1075.2.14 raeburn 14129: $userenv{'canrequest.author'} =
14130: &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
14131: 'reload','requestauthor',
14132: \%userenv,\%domdef,\%is_adv);
14133: my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
14134: $domain,$username);
14135: my $reqstatus = $reqauthor{'author_status'};
14136: if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
14137: if (ref($reqauthor{'author'}) eq 'HASH') {
14138: $userenv{'requestauthorqueued'} = $reqstatus.':'.
14139: $reqauthor{'author'}{'timestamp'};
14140: }
14141: }
14142:
1.462 albertel 14143: $env{'user.environment'} = "$lonids/$cookie.id";
1.1062 raeburn 14144:
1.462 albertel 14145: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
14146: &GDBM_WRCREAT(),0640)) {
14147: &_add_to_env(\%disk_env,\%initial_env);
14148: &_add_to_env(\%disk_env,\%userenv,'environment.');
14149: &_add_to_env(\%disk_env,$userroles);
1.1062 raeburn 14150: if (ref($firstaccenv) eq 'HASH') {
14151: &_add_to_env(\%disk_env,$firstaccenv);
14152: }
14153: if (ref($timerintenv) eq 'HASH') {
14154: &_add_to_env(\%disk_env,$timerintenv);
14155: }
1.463 albertel 14156: if (ref($args->{'extra_env'})) {
14157: &_add_to_env(\%disk_env,$args->{'extra_env'});
14158: }
1.462 albertel 14159: untie(%disk_env);
14160: } else {
1.705 tempelho 14161: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
14162: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 14163: return 'error: '.$!;
14164: }
14165: }
14166: $env{'request.role'}='cm';
14167: $env{'request.role.adv'}=$env{'user.adv'};
14168: $env{'browser.type'}=$clientbrowser;
14169:
14170: return $cookie;
14171:
14172: }
14173:
14174: sub _add_to_env {
14175: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 14176: if (ref($env_data) eq 'HASH') {
14177: while (my ($key,$value) = each(%$env_data)) {
14178: $idf->{$prefix.$key} = $value;
14179: $env{$prefix.$key} = $value;
14180: }
1.462 albertel 14181: }
14182: }
14183:
1.685 tempelho 14184: # --- Get the symbolic name of a problem and the url
14185: sub get_symb {
14186: my ($request,$silent) = @_;
1.726 raeburn 14187: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 14188: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
14189: if ($symb eq '') {
14190: if (!$silent) {
1.1071 raeburn 14191: if (ref($request)) {
14192: $request->print("Unable to handle ambiguous references:$url:.");
14193: }
1.685 tempelho 14194: return ();
14195: }
14196: }
14197: &Apache::lonenc::check_decrypt(\$symb);
14198: return ($symb);
14199: }
14200:
14201: # --------------------------------------------------------------Get annotation
14202:
14203: sub get_annotation {
14204: my ($symb,$enc) = @_;
14205:
14206: my $key = $symb;
14207: if (!$enc) {
14208: $key =
14209: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
14210: }
14211: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
14212: return $annotation{$key};
14213: }
14214:
14215: sub clean_symb {
1.731 raeburn 14216: my ($symb,$delete_enc) = @_;
1.685 tempelho 14217:
14218: &Apache::lonenc::check_decrypt(\$symb);
14219: my $enc = $env{'request.enc'};
1.731 raeburn 14220: if ($delete_enc) {
1.730 raeburn 14221: delete($env{'request.enc'});
14222: }
1.685 tempelho 14223:
14224: return ($symb,$enc);
14225: }
1.462 albertel 14226:
1.990 raeburn 14227: sub build_release_hashes {
14228: my ($checkparms,$checkresponsetypes,$checkcrstypes,$anonsurvey,$randomizetry) = @_;
14229: return unless((ref($checkparms) eq 'HASH') && (ref($checkresponsetypes) eq 'HASH') &&
14230: (ref($checkcrstypes) eq 'HASH') && (ref($anonsurvey) eq 'HASH') &&
14231: (ref($randomizetry) eq 'HASH'));
14232: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
14233: my ($item,$name,$value) = split(/:/,$key);
14234: if ($item eq 'parameter') {
14235: if (ref($checkparms->{$name}) eq 'ARRAY') {
14236: unless(grep(/^\Q$name\E$/,@{$checkparms->{$name}})) {
14237: push(@{$checkparms->{$name}},$value);
14238: }
14239: } else {
14240: push(@{$checkparms->{$name}},$value);
14241: }
14242: } elsif ($item eq 'resourcetag') {
14243: if ($name eq 'responsetype') {
14244: $checkresponsetypes->{$value} = $Apache::lonnet::needsrelease{$key}
14245: }
14246: } elsif ($item eq 'course') {
14247: if ($name eq 'crstype') {
14248: $checkcrstypes->{$value} = $Apache::lonnet::needsrelease{$key};
14249: }
14250: }
14251: }
14252: ($anonsurvey->{major},$anonsurvey->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:anonsurvey'});
14253: ($randomizetry->{major},$randomizetry->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:randomizetry'});
14254: return;
14255: }
14256:
1.1075.2.11 raeburn 14257: sub update_content_constraints {
14258: my ($cdom,$cnum,$chome,$cid) = @_;
14259: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
14260: my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
14261: my %checkresponsetypes;
14262: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
14263: my ($item,$name,$value) = split(/:/,$key);
14264: if ($item eq 'resourcetag') {
14265: if ($name eq 'responsetype') {
14266: $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
14267: }
14268: }
14269: }
14270: my $navmap = Apache::lonnavmaps::navmap->new();
14271: if (defined($navmap)) {
14272: my %allresponses;
14273: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() },1,0)) {
14274: my %responses = $res->responseTypes();
14275: foreach my $key (keys(%responses)) {
14276: next unless(exists($checkresponsetypes{$key}));
14277: $allresponses{$key} += $responses{$key};
14278: }
14279: }
14280: foreach my $key (keys(%allresponses)) {
14281: my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
14282: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
14283: ($reqdmajor,$reqdminor) = ($major,$minor);
14284: }
14285: }
14286: undef($navmap);
14287: }
14288: unless (($reqdmajor eq '') && ($reqdminor eq '')) {
14289: &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
14290: }
14291: return;
14292: }
14293:
1.1075.2.27 raeburn 14294: sub allmaps_incourse {
14295: my ($cdom,$cnum,$chome,$cid) = @_;
14296: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
14297: $cid = $env{'request.course.id'};
14298: $cdom = $env{'course.'.$cid.'.domain'};
14299: $cnum = $env{'course.'.$cid.'.num'};
14300: $chome = $env{'course.'.$cid.'.home'};
14301: }
14302: my %allmaps = ();
14303: my $lastchange =
14304: &Apache::lonnet::get_coursechange($cdom,$cnum);
14305: if ($lastchange > $env{'request.course.tied'}) {
14306: my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
14307: unless ($ferr) {
14308: &update_content_constraints($cdom,$cnum,$chome,$cid);
14309: }
14310: }
14311: my $navmap = Apache::lonnavmaps::navmap->new();
14312: if (defined($navmap)) {
14313: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
14314: $allmaps{$res->src()} = 1;
14315: }
14316: }
14317: return \%allmaps;
14318: }
14319:
1.1075.2.11 raeburn 14320: sub parse_supplemental_title {
14321: my ($title) = @_;
14322:
14323: my ($foldertitle,$renametitle);
14324: if ($title =~ /&&&/) {
14325: $title = &HTML::Entites::decode($title);
14326: }
14327: if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
14328: $renametitle=$4;
14329: my ($time,$uname,$udom) = ($1,$2,$3);
14330: $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
14331: my $name = &plainname($uname,$udom);
14332: $name = &HTML::Entities::encode($name,'"<>&\'');
14333: $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
14334: $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.
14335: $name.': <br />'.$foldertitle;
14336: }
14337: if (wantarray) {
14338: return ($title,$foldertitle,$renametitle);
14339: }
14340: return $title;
14341: }
14342:
1.1075.2.18 raeburn 14343: sub symb_to_docspath {
14344: my ($symb) = @_;
14345: return unless ($symb);
14346: my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
14347: if ($resurl=~/\.(sequence|page)$/) {
14348: $mapurl=$resurl;
14349: } elsif ($resurl eq 'adm/navmaps') {
14350: $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
14351: }
14352: my $mapresobj;
14353: my $navmap = Apache::lonnavmaps::navmap->new();
14354: if (ref($navmap)) {
14355: $mapresobj = $navmap->getResourceByUrl($mapurl);
14356: }
14357: $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
14358: my $type=$2;
14359: my $path;
14360: if (ref($mapresobj)) {
14361: my $pcslist = $mapresobj->map_hierarchy();
14362: if ($pcslist ne '') {
14363: foreach my $pc (split(/,/,$pcslist)) {
14364: next if ($pc <= 1);
14365: my $res = $navmap->getByMapPc($pc);
14366: if (ref($res)) {
14367: my $thisurl = $res->src();
14368: $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
14369: my $thistitle = $res->title();
14370: $path .= '&'.
14371: &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
14372: &Apache::lonhtmlcommon::entity_encode($thistitle).
14373: ':'.$res->randompick().
14374: ':'.$res->randomout().
14375: ':'.$res->encrypted().
14376: ':'.$res->randomorder().
14377: ':'.$res->is_page();
14378: }
14379: }
14380: }
14381: $path =~ s/^\&//;
14382: my $maptitle = $mapresobj->title();
14383: if ($mapurl eq 'default') {
14384: $maptitle = 'Main Course Documents';
14385: }
14386: $path .= (($path ne '')? '&' : '').
14387: &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
14388: &Apache::lonhtmlcommon::entity_encode($maptitle).
14389: ':'.$mapresobj->randompick().
14390: ':'.$mapresobj->randomout().
14391: ':'.$mapresobj->encrypted().
14392: ':'.$mapresobj->randomorder().
14393: ':'.$mapresobj->is_page();
14394: } else {
14395: my $maptitle = &Apache::lonnet::gettitle($mapurl);
14396: my $ispage = (($type eq 'page')? 1 : '');
14397: if ($mapurl eq 'default') {
14398: $maptitle = 'Main Course Documents';
14399: }
14400: $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
14401: &Apache::lonhtmlcommon::entity_encode($maptitle).':::::'.$ispage;
14402: }
14403: unless ($mapurl eq 'default') {
14404: $path = 'default&'.
14405: &Apache::lonhtmlcommon::entity_encode('Main Course Documents').
14406: ':::::&'.$path;
14407: }
14408: return $path;
14409: }
14410:
1.1075.2.14 raeburn 14411: sub captcha_display {
14412: my ($context,$lonhost) = @_;
14413: my ($output,$error);
14414: my ($captcha,$pubkey,$privkey) = &get_captcha_config($context,$lonhost);
14415: if ($captcha eq 'original') {
14416: $output = &create_captcha();
14417: unless ($output) {
14418: $error = 'captcha';
14419: }
14420: } elsif ($captcha eq 'recaptcha') {
14421: $output = &create_recaptcha($pubkey);
14422: unless ($output) {
14423: $error = 'recaptcha';
14424: }
14425: }
14426: return ($output,$error);
14427: }
14428:
14429: sub captcha_response {
14430: my ($context,$lonhost) = @_;
14431: my ($captcha_chk,$captcha_error);
14432: my ($captcha,$pubkey,$privkey) = &get_captcha_config($context,$lonhost);
14433: if ($captcha eq 'original') {
14434: ($captcha_chk,$captcha_error) = &check_captcha();
14435: } elsif ($captcha eq 'recaptcha') {
14436: $captcha_chk = &check_recaptcha($privkey);
14437: } else {
14438: $captcha_chk = 1;
14439: }
14440: return ($captcha_chk,$captcha_error);
14441: }
14442:
14443: sub get_captcha_config {
14444: my ($context,$lonhost) = @_;
14445: my ($captcha,$pubkey,$privkey,$hashtocheck);
14446: my $hostname = &Apache::lonnet::hostname($lonhost);
14447: my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
14448: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
14449: if ($context eq 'usercreation') {
14450: my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
14451: if (ref($domconfig{$context}) eq 'HASH') {
14452: $hashtocheck = $domconfig{$context}{'cancreate'};
14453: if (ref($hashtocheck) eq 'HASH') {
14454: if ($hashtocheck->{'captcha'} eq 'recaptcha') {
14455: if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
14456: $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
14457: $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
14458: }
14459: if ($privkey && $pubkey) {
14460: $captcha = 'recaptcha';
14461: } else {
14462: $captcha = 'original';
14463: }
14464: } elsif ($hashtocheck->{'captcha'} ne 'notused') {
14465: $captcha = 'original';
14466: }
14467: }
14468: } else {
14469: $captcha = 'captcha';
14470: }
14471: } elsif ($context eq 'login') {
14472: my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
14473: if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
14474: $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
14475: $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
14476: if ($privkey && $pubkey) {
14477: $captcha = 'recaptcha';
14478: } else {
14479: $captcha = 'original';
14480: }
14481: } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
14482: $captcha = 'original';
14483: }
14484: }
14485: return ($captcha,$pubkey,$privkey);
14486: }
14487:
14488: sub create_captcha {
14489: my %captcha_params = &captcha_settings();
14490: my ($output,$maxtries,$tries) = ('',10,0);
14491: while ($tries < $maxtries) {
14492: $tries ++;
14493: my $captcha = Authen::Captcha->new (
14494: output_folder => $captcha_params{'output_dir'},
14495: data_folder => $captcha_params{'db_dir'},
14496: );
14497: my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
14498:
14499: if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
14500: $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
14501: &mt('Type in the letters/numbers shown below').' '.
14502: '<input type="text" size="5" name="code" value="" /><br />'.
14503: '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" />';
14504: last;
14505: }
14506: }
14507: return $output;
14508: }
14509:
14510: sub captcha_settings {
14511: my %captcha_params = (
14512: output_dir => $Apache::lonnet::perlvar{'lonCaptchaDir'},
14513: www_output_dir => "/captchaspool",
14514: db_dir => $Apache::lonnet::perlvar{'lonCaptchaDb'},
14515: numchars => '5',
14516: );
14517: return %captcha_params;
14518: }
14519:
14520: sub check_captcha {
14521: my ($captcha_chk,$captcha_error);
14522: my $code = $env{'form.code'};
14523: my $md5sum = $env{'form.crypt'};
14524: my %captcha_params = &captcha_settings();
14525: my $captcha = Authen::Captcha->new(
14526: output_folder => $captcha_params{'output_dir'},
14527: data_folder => $captcha_params{'db_dir'},
14528: );
1.1075.2.26 raeburn 14529: $captcha_chk = $captcha->check_code($code,$md5sum);
1.1075.2.14 raeburn 14530: my %captcha_hash = (
14531: 0 => 'Code not checked (file error)',
14532: -1 => 'Failed: code expired',
14533: -2 => 'Failed: invalid code (not in database)',
14534: -3 => 'Failed: invalid code (code does not match crypt)',
14535: );
14536: if ($captcha_chk != 1) {
14537: $captcha_error = $captcha_hash{$captcha_chk}
14538: }
14539: return ($captcha_chk,$captcha_error);
14540: }
14541:
14542: sub create_recaptcha {
14543: my ($pubkey) = @_;
14544: my $captcha = Captcha::reCAPTCHA->new;
14545: return $captcha->get_options_setter({theme => 'white'})."\n".
14546: $captcha->get_html($pubkey).
14547: &mt('If either word is hard to read, [_1] will replace them.',
14548: '<image src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
14549: '<br /><br />';
14550: }
14551:
14552: sub check_recaptcha {
14553: my ($privkey) = @_;
14554: my $captcha_chk;
14555: my $captcha = Captcha::reCAPTCHA->new;
14556: my $captcha_result =
14557: $captcha->check_answer(
14558: $privkey,
14559: $ENV{'REMOTE_ADDR'},
14560: $env{'form.recaptcha_challenge_field'},
14561: $env{'form.recaptcha_response_field'},
14562: );
14563: if ($captcha_result->{is_valid}) {
14564: $captcha_chk = 1;
14565: }
14566: return $captcha_chk;
14567: }
14568:
1.41 ng 14569: =pod
14570:
14571: =back
14572:
1.112 bowersj2 14573: =cut
1.41 ng 14574:
1.112 bowersj2 14575: 1;
14576: __END__;
1.41 ng 14577:
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