Annotation of loncom/interface/loncommon.pm, revision 1.1075.2.97
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.97! raeburn 4: # $Id: loncommon.pm,v 1.1075.2.96 2015/07/14 03:03:51 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.1075.2.69 raeburn 72: use Apache::courseclassifier();
1.479 albertel 73: use LONCAPA qw(:DEFAULT :match);
1.657 raeburn 74: use DateTime::TimeZone;
1.687 raeburn 75: use DateTime::Locale::Catalog;
1.1075.2.94 raeburn 76: use Encode();
1.1075.2.14 raeburn 77: use Authen::Captcha;
78: use Captcha::reCAPTCHA;
1.1075.2.64 raeburn 79: use Crypt::DES;
80: use DynaLoader; # for Crypt::DES version
1.117 www 81:
1.517 raeburn 82: # ---------------------------------------------- Designs
83: use vars qw(%defaultdesign);
84:
1.22 www 85: my $readit;
86:
1.517 raeburn 87:
1.157 matthew 88: ##
89: ## Global Variables
90: ##
1.46 matthew 91:
1.643 foxr 92:
93: # ----------------------------------------------- SSI with retries:
94: #
95:
96: =pod
97:
1.648 raeburn 98: =head1 Server Side include with retries:
1.643 foxr 99:
100: =over 4
101:
1.648 raeburn 102: =item * &ssi_with_retries(resource,retries form)
1.643 foxr 103:
104: Performs an ssi with some number of retries. Retries continue either
105: until the result is ok or until the retry count supplied by the
106: caller is exhausted.
107:
108: Inputs:
1.648 raeburn 109:
110: =over 4
111:
1.643 foxr 112: resource - Identifies the resource to insert.
1.648 raeburn 113:
1.643 foxr 114: retries - Count of the number of retries allowed.
1.648 raeburn 115:
1.643 foxr 116: form - Hash that identifies the rendering options.
117:
1.648 raeburn 118: =back
119:
120: Returns:
121:
122: =over 4
123:
1.643 foxr 124: content - The content of the response. If retries were exhausted this is empty.
1.648 raeburn 125:
1.643 foxr 126: response - The response from the last attempt (which may or may not have been successful.
127:
1.648 raeburn 128: =back
129:
130: =back
131:
1.643 foxr 132: =cut
133:
134: sub ssi_with_retries {
135: my ($resource, $retries, %form) = @_;
136:
137:
138: my $ok = 0; # True if we got a good response.
139: my $content;
140: my $response;
141:
142: # Try to get the ssi done. within the retries count:
143:
144: do {
145: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
146: $ok = $response->is_success;
1.650 www 147: if (!$ok) {
148: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
149: }
1.643 foxr 150: $retries--;
151: } while (!$ok && ($retries > 0));
152:
153: if (!$ok) {
154: $content = ''; # On error return an empty content.
155: }
156: return ($content, $response);
157:
158: }
159:
160:
161:
1.20 www 162: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 163: my %language;
1.124 www 164: my %supported_language;
1.1048 foxr 165: my %latex_language; # For choosing hyphenation in <transl..>
166: my %latex_language_bykey; # for choosing hyphenation from metadata
1.12 harris41 167: my %cprtag;
1.192 taceyjo1 168: my %scprtag;
1.351 www 169: my %fe; my %fd; my %fm;
1.41 ng 170: my %category_extensions;
1.12 harris41 171:
1.46 matthew 172: # ---------------------------------------------- Thesaurus variables
1.144 matthew 173: #
174: # %Keywords:
175: # A hash used by &keyword to determine if a word is considered a keyword.
176: # $thesaurus_db_file
177: # Scalar containing the full path to the thesaurus database.
1.46 matthew 178:
179: my %Keywords;
180: my $thesaurus_db_file;
181:
1.144 matthew 182: #
183: # Initialize values from language.tab, copyright.tab, filetypes.tab,
184: # thesaurus.tab, and filecategories.tab.
185: #
1.18 www 186: BEGIN {
1.46 matthew 187: # Variable initialization
188: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
189: #
1.22 www 190: unless ($readit) {
1.12 harris41 191: # ------------------------------------------------------------------- languages
192: {
1.158 raeburn 193: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
194: '/language.tab';
195: if ( open(my $fh,"<$langtabfile") ) {
1.356 albertel 196: while (my $line = <$fh>) {
197: next if ($line=~/^\#/);
198: chomp($line);
1.1048 foxr 199: my ($key,$two,$country,$three,$enc,$val,$sup,$latex)=(split(/\t/,$line));
1.158 raeburn 200: $language{$key}=$val.' - '.$enc;
201: if ($sup) {
202: $supported_language{$key}=$sup;
203: }
1.1048 foxr 204: if ($latex) {
205: $latex_language_bykey{$key} = $latex;
206: $latex_language{$two} = $latex;
207: }
1.158 raeburn 208: }
209: close($fh);
210: }
1.12 harris41 211: }
212: # ------------------------------------------------------------------ copyrights
213: {
1.158 raeburn 214: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
215: '/copyright.tab';
216: if ( open (my $fh,"<$copyrightfile") ) {
1.356 albertel 217: while (my $line = <$fh>) {
218: next if ($line=~/^\#/);
219: chomp($line);
220: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 221: $cprtag{$key}=$val;
222: }
223: close($fh);
224: }
1.12 harris41 225: }
1.351 www 226: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 227: {
228: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
229: '/source_copyright.tab';
230: if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356 albertel 231: while (my $line = <$fh>) {
232: next if ($line =~ /^\#/);
233: chomp($line);
234: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 235: $scprtag{$key}=$val;
236: }
237: close($fh);
238: }
239: }
1.63 www 240:
1.517 raeburn 241: # -------------------------------------------------------------- default domain designs
1.63 www 242: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 243: my $designfile = $designdir.'/default.tab';
244: if ( open (my $fh,"<$designfile") ) {
245: while (my $line = <$fh>) {
246: next if ($line =~ /^\#/);
247: chomp($line);
248: my ($key,$val)=(split(/\=/,$line));
249: if ($val) { $defaultdesign{$key}=$val; }
250: }
251: close($fh);
1.63 www 252: }
253:
1.15 harris41 254: # ------------------------------------------------------------- file categories
255: {
1.158 raeburn 256: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
257: '/filecategories.tab';
258: if ( open (my $fh,"<$categoryfile") ) {
1.356 albertel 259: while (my $line = <$fh>) {
260: next if ($line =~ /^\#/);
261: chomp($line);
262: my ($extension,$category)=(split(/\s+/,$line,2));
1.158 raeburn 263: push @{$category_extensions{lc($category)}},$extension;
264: }
265: close($fh);
266: }
267:
1.15 harris41 268: }
1.12 harris41 269: # ------------------------------------------------------------------ file types
270: {
1.158 raeburn 271: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
272: '/filetypes.tab';
273: if ( open (my $fh,"<$typesfile") ) {
1.356 albertel 274: while (my $line = <$fh>) {
275: next if ($line =~ /^\#/);
276: chomp($line);
277: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 278: if ($descr ne '') {
279: $fe{$ending}=lc($emb);
280: $fd{$ending}=$descr;
1.351 www 281: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 282: }
283: }
284: close($fh);
285: }
1.12 harris41 286: }
1.22 www 287: &Apache::lonnet::logthis(
1.705 tempelho 288: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 289: $readit=1;
1.46 matthew 290: } # end of unless($readit)
1.32 matthew 291:
292: }
1.112 bowersj2 293:
1.42 matthew 294: ###############################################################
295: ## HTML and Javascript Helper Functions ##
296: ###############################################################
297:
298: =pod
299:
1.112 bowersj2 300: =head1 HTML and Javascript Functions
1.42 matthew 301:
1.112 bowersj2 302: =over 4
303:
1.648 raeburn 304: =item * &browser_and_searcher_javascript()
1.112 bowersj2 305:
306: X<browsing, javascript>X<searching, javascript>Returns a string
307: containing javascript with two functions, C<openbrowser> and
308: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
309: tags.
1.42 matthew 310:
1.648 raeburn 311: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 312:
313: inputs: formname, elementname, only, omit
314:
315: formname and elementname indicate the name of the html form and name of
316: the element that the results of the browsing selection are to be placed in.
317:
318: Specifying 'only' will restrict the browser to displaying only files
1.185 www 319: with the given extension. Can be a comma separated list.
1.42 matthew 320:
321: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 322: with the given extension. Can be a comma separated list.
1.42 matthew 323:
1.648 raeburn 324: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 325:
326: Inputs: formname, elementname
327:
328: formname and elementname specify the name of the html form and the name
329: of the element the selection from the search results will be placed in.
1.542 raeburn 330:
1.42 matthew 331: =cut
332:
333: sub browser_and_searcher_javascript {
1.199 albertel 334: my ($mode)=@_;
335: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 336: my $resurl=&escape_single(&lastresurl());
1.42 matthew 337: return <<END;
1.219 albertel 338: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 339: var editbrowser = null;
1.135 albertel 340: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 341: var url = '$resurl/?';
1.42 matthew 342: if (editbrowser == null) {
343: url += 'launch=1&';
344: }
345: url += 'catalogmode=interactive&';
1.199 albertel 346: url += 'mode=$mode&';
1.611 albertel 347: url += 'inhibitmenu=yes&';
1.42 matthew 348: url += 'form=' + formname + '&';
349: if (only != null) {
350: url += 'only=' + only + '&';
1.217 albertel 351: } else {
352: url += 'only=&';
353: }
1.42 matthew 354: if (omit != null) {
355: url += 'omit=' + omit + '&';
1.217 albertel 356: } else {
357: url += 'omit=&';
358: }
1.135 albertel 359: if (titleelement != null) {
360: url += 'titleelement=' + titleelement + '&';
1.217 albertel 361: } else {
362: url += 'titleelement=&';
363: }
1.42 matthew 364: url += 'element=' + elementname + '';
365: var title = 'Browser';
1.435 albertel 366: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 367: options += ',width=700,height=600';
368: editbrowser = open(url,title,options,'1');
369: editbrowser.focus();
370: }
371: var editsearcher;
1.135 albertel 372: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 373: var url = '/adm/searchcat?';
374: if (editsearcher == null) {
375: url += 'launch=1&';
376: }
377: url += 'catalogmode=interactive&';
1.199 albertel 378: url += 'mode=$mode&';
1.42 matthew 379: url += 'form=' + formname + '&';
1.135 albertel 380: if (titleelement != null) {
381: url += 'titleelement=' + titleelement + '&';
1.217 albertel 382: } else {
383: url += 'titleelement=&';
384: }
1.42 matthew 385: url += 'element=' + elementname + '';
386: var title = 'Search';
1.435 albertel 387: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 388: options += ',width=700,height=600';
389: editsearcher = open(url,title,options,'1');
390: editsearcher.focus();
391: }
1.219 albertel 392: // END LON-CAPA Internal -->
1.42 matthew 393: END
1.170 www 394: }
395:
396: sub lastresurl {
1.258 albertel 397: if ($env{'environment.lastresurl'}) {
398: return $env{'environment.lastresurl'}
1.170 www 399: } else {
400: return '/res';
401: }
402: }
403:
404: sub storeresurl {
405: my $resurl=&Apache::lonnet::clutter(shift);
406: unless ($resurl=~/^\/res/) { return 0; }
407: $resurl=~s/\/$//;
408: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 409: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 410: return 1;
1.42 matthew 411: }
412:
1.74 www 413: sub studentbrowser_javascript {
1.111 www 414: unless (
1.258 albertel 415: (($env{'request.course.id'}) &&
1.302 albertel 416: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
417: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
418: '/'.$env{'request.course.sec'})
419: ))
1.258 albertel 420: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 421: ) { return ''; }
1.74 www 422: return (<<'ENDSTDBRW');
1.776 bisitz 423: <script type="text/javascript" language="Javascript">
1.824 bisitz 424: // <![CDATA[
1.74 www 425: var stdeditbrowser;
1.999 www 426: function openstdbrowser(formname,uname,udom,clicker,roleflag,ignorefilter,courseadvonly) {
1.74 www 427: var url = '/adm/pickstudent?';
428: var filter;
1.558 albertel 429: if (!ignorefilter) {
430: eval('filter=document.'+formname+'.'+uname+'.value;');
431: }
1.74 www 432: if (filter != null) {
433: if (filter != '') {
434: url += 'filter='+filter+'&';
435: }
436: }
437: url += 'form=' + formname + '&unameelement='+uname+
1.999 www 438: '&udomelement='+udom+
439: '&clicker='+clicker;
1.111 www 440: if (roleflag) { url+="&roles=1"; }
1.793 raeburn 441: if (courseadvonly) { url+="&courseadvonly=1"; }
1.102 www 442: var title = 'Student_Browser';
1.74 www 443: var options = 'scrollbars=1,resizable=1,menubar=0';
444: options += ',width=700,height=600';
445: stdeditbrowser = open(url,title,options,'1');
446: stdeditbrowser.focus();
447: }
1.824 bisitz 448: // ]]>
1.74 www 449: </script>
450: ENDSTDBRW
451: }
1.42 matthew 452:
1.1003 www 453: sub resourcebrowser_javascript {
454: unless ($env{'request.course.id'}) { return ''; }
1.1004 www 455: return (<<'ENDRESBRW');
1.1003 www 456: <script type="text/javascript" language="Javascript">
457: // <![CDATA[
458: var reseditbrowser;
1.1004 www 459: function openresbrowser(formname,reslink) {
1.1005 www 460: var url = '/adm/pickresource?form='+formname+'&reslink='+reslink;
1.1003 www 461: var title = 'Resource_Browser';
462: var options = 'scrollbars=1,resizable=1,menubar=0';
1.1005 www 463: options += ',width=700,height=500';
1.1004 www 464: reseditbrowser = open(url,title,options,'1');
465: reseditbrowser.focus();
1.1003 www 466: }
467: // ]]>
468: </script>
1.1004 www 469: ENDRESBRW
1.1003 www 470: }
471:
1.74 www 472: sub selectstudent_link {
1.999 www 473: my ($form,$unameele,$udomele,$courseadvonly,$clickerid)=@_;
474: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
475: &Apache::lonhtmlcommon::entity_encode($unameele)."','".
476: &Apache::lonhtmlcommon::entity_encode($udomele)."'";
1.258 albertel 477: if ($env{'request.course.id'}) {
1.302 albertel 478: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
479: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
480: '/'.$env{'request.course.sec'})) {
1.111 www 481: return '';
482: }
1.999 www 483: $callargs.=",'".&Apache::lonhtmlcommon::entity_encode($clickerid)."'";
1.793 raeburn 484: if ($courseadvonly) {
485: $callargs .= ",'',1,1";
486: }
487: return '<span class="LC_nobreak">'.
488: '<a href="javascript:openstdbrowser('.$callargs.');">'.
489: &mt('Select User').'</a></span>';
1.74 www 490: }
1.258 albertel 491: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.1012 www 492: $callargs .= ",'',1";
1.793 raeburn 493: return '<span class="LC_nobreak">'.
494: '<a href="javascript:openstdbrowser('.$callargs.');">'.
495: &mt('Select User').'</a></span>';
1.111 www 496: }
497: return '';
1.91 www 498: }
499:
1.1004 www 500: sub selectresource_link {
501: my ($form,$reslink,$arg)=@_;
502:
503: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
504: &Apache::lonhtmlcommon::entity_encode($reslink)."'";
505: unless ($env{'request.course.id'}) { return $arg; }
506: return '<span class="LC_nobreak">'.
507: '<a href="javascript:openresbrowser('.$callargs.');">'.
508: $arg.'</a></span>';
509: }
510:
511:
512:
1.653 raeburn 513: sub authorbrowser_javascript {
514: return <<"ENDAUTHORBRW";
1.776 bisitz 515: <script type="text/javascript" language="JavaScript">
1.824 bisitz 516: // <![CDATA[
1.653 raeburn 517: var stdeditbrowser;
518:
519: function openauthorbrowser(formname,udom) {
520: var url = '/adm/pickauthor?';
521: url += 'form='+formname+'&roledom='+udom;
522: var title = 'Author_Browser';
523: var options = 'scrollbars=1,resizable=1,menubar=0';
524: options += ',width=700,height=600';
525: stdeditbrowser = open(url,title,options,'1');
526: stdeditbrowser.focus();
527: }
528:
1.824 bisitz 529: // ]]>
1.653 raeburn 530: </script>
531: ENDAUTHORBRW
532: }
533:
1.91 www 534: sub coursebrowser_javascript {
1.1075.2.31 raeburn 535: my ($domainfilter,$sec_element,$formname,$role_element,$crstype,
1.1075.2.95 raeburn 536: $credits_element,$instcode) = @_;
1.932 raeburn 537: my $wintitle = 'Course_Browser';
1.931 raeburn 538: if ($crstype eq 'Community') {
1.932 raeburn 539: $wintitle = 'Community_Browser';
1.909 raeburn 540: }
1.876 raeburn 541: my $id_functions = &javascript_index_functions();
542: my $output = '
1.776 bisitz 543: <script type="text/javascript" language="JavaScript">
1.824 bisitz 544: // <![CDATA[
1.468 raeburn 545: var stdeditbrowser;'."\n";
1.876 raeburn 546:
547: $output .= <<"ENDSTDBRW";
1.909 raeburn 548: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91 www 549: var url = '/adm/pickcourse?';
1.895 raeburn 550: var formid = getFormIdByName(formname);
1.876 raeburn 551: var domainfilter = getDomainFromSelectbox(formname,udom);
1.128 albertel 552: if (domainfilter != null) {
553: if (domainfilter != '') {
554: url += 'domainfilter='+domainfilter+'&';
555: }
556: }
1.91 www 557: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 558: '&cdomelement='+udom+
559: '&cnameelement='+desc;
1.468 raeburn 560: if (extra_element !=null && extra_element != '') {
1.594 raeburn 561: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 562: url += '&roleelement='+extra_element;
563: if (domainfilter == null || domainfilter == '') {
564: url += '&domainfilter='+extra_element;
565: }
1.234 raeburn 566: }
1.468 raeburn 567: else {
568: if (formname == 'portform') {
569: url += '&setroles='+extra_element;
1.800 raeburn 570: } else {
571: if (formname == 'rules') {
572: url += '&fixeddom='+extra_element;
573: }
1.468 raeburn 574: }
575: }
1.230 raeburn 576: }
1.909 raeburn 577: if (type != null && type != '') {
578: url += '&type='+type;
579: }
580: if (type_elem != null && type_elem != '') {
581: url += '&typeelement='+type_elem;
582: }
1.872 raeburn 583: if (formname == 'ccrs') {
584: var ownername = document.forms[formid].ccuname.value;
585: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
1.1075.2.95 raeburn 586: url += '&cloner='+ownername+':'+ownerdom+'&crscode='+document.forms[formid].crscode.value;
587: }
588: if (formname == 'requestcrs') {
589: url += '&crsdom=$domainfilter&crscode=$instcode';
1.872 raeburn 590: }
1.293 raeburn 591: if (multflag !=null && multflag != '') {
592: url += '&multiple='+multflag;
593: }
1.909 raeburn 594: var title = '$wintitle';
1.91 www 595: var options = 'scrollbars=1,resizable=1,menubar=0';
596: options += ',width=700,height=600';
597: stdeditbrowser = open(url,title,options,'1');
598: stdeditbrowser.focus();
599: }
1.876 raeburn 600: $id_functions
601: ENDSTDBRW
1.1075.2.31 raeburn 602: if (($sec_element ne '') || ($role_element ne '') || ($credits_element ne '')) {
603: $output .= &setsec_javascript($sec_element,$formname,$role_element,
604: $credits_element);
1.876 raeburn 605: }
606: $output .= '
607: // ]]>
608: </script>';
609: return $output;
610: }
611:
612: sub javascript_index_functions {
613: return <<"ENDJS";
614:
615: function getFormIdByName(formname) {
616: for (var i=0;i<document.forms.length;i++) {
617: if (document.forms[i].name == formname) {
618: return i;
619: }
620: }
621: return -1;
622: }
623:
624: function getIndexByName(formid,item) {
625: for (var i=0;i<document.forms[formid].elements.length;i++) {
626: if (document.forms[formid].elements[i].name == item) {
627: return i;
628: }
629: }
630: return -1;
631: }
1.468 raeburn 632:
1.876 raeburn 633: function getDomainFromSelectbox(formname,udom) {
634: var userdom;
635: var formid = getFormIdByName(formname);
636: if (formid > -1) {
637: var domid = getIndexByName(formid,udom);
638: if (domid > -1) {
639: if (document.forms[formid].elements[domid].type == 'select-one') {
640: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
641: }
642: if (document.forms[formid].elements[domid].type == 'hidden') {
643: userdom=document.forms[formid].elements[domid].value;
1.468 raeburn 644: }
645: }
646: }
1.876 raeburn 647: return userdom;
648: }
649:
650: ENDJS
1.468 raeburn 651:
1.876 raeburn 652: }
653:
1.1017 raeburn 654: sub javascript_array_indexof {
1.1018 raeburn 655: return <<ENDJS;
1.1017 raeburn 656: <script type="text/javascript" language="JavaScript">
657: // <![CDATA[
658:
659: if (!Array.prototype.indexOf) {
660: Array.prototype.indexOf = function (searchElement /*, fromIndex */ ) {
661: "use strict";
662: if (this === void 0 || this === null) {
663: throw new TypeError();
664: }
665: var t = Object(this);
666: var len = t.length >>> 0;
667: if (len === 0) {
668: return -1;
669: }
670: var n = 0;
671: if (arguments.length > 0) {
672: n = Number(arguments[1]);
673: if (n !== n) { // shortcut for verifying if it's NaN
674: n = 0;
675: } else if (n !== 0 && n !== (1 / 0) && n !== -(1 / 0)) {
676: n = (n > 0 || -1) * Math.floor(Math.abs(n));
677: }
678: }
679: if (n >= len) {
680: return -1;
681: }
682: var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
683: for (; k < len; k++) {
684: if (k in t && t[k] === searchElement) {
685: return k;
686: }
687: }
688: return -1;
689: }
690: }
691:
692: // ]]>
693: </script>
694:
695: ENDJS
696:
697: }
698:
1.876 raeburn 699: sub userbrowser_javascript {
700: my $id_functions = &javascript_index_functions();
701: return <<"ENDUSERBRW";
702:
1.888 raeburn 703: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876 raeburn 704: var url = '/adm/pickuser?';
705: var userdom = getDomainFromSelectbox(formname,udom);
706: if (userdom != null) {
707: if (userdom != '') {
708: url += 'srchdom='+userdom+'&';
709: }
710: }
711: url += 'form=' + formname + '&unameelement='+uname+
712: '&udomelement='+udom+
713: '&ulastelement='+ulast+
714: '&ufirstelement='+ufirst+
715: '&uemailelement='+uemail+
1.881 raeburn 716: '&hideudomelement='+hideudom+
717: '&coursedom='+crsdom;
1.888 raeburn 718: if ((caller != null) && (caller != undefined)) {
719: url += '&caller='+caller;
720: }
1.876 raeburn 721: var title = 'User_Browser';
722: var options = 'scrollbars=1,resizable=1,menubar=0';
723: options += ',width=700,height=600';
724: var stdeditbrowser = open(url,title,options,'1');
725: stdeditbrowser.focus();
726: }
727:
1.888 raeburn 728: function fix_domain (formname,udom,origdom,uname) {
1.876 raeburn 729: var formid = getFormIdByName(formname);
730: if (formid > -1) {
1.888 raeburn 731: var unameid = getIndexByName(formid,uname);
1.876 raeburn 732: var domid = getIndexByName(formid,udom);
733: var hidedomid = getIndexByName(formid,origdom);
734: if (hidedomid > -1) {
735: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888 raeburn 736: var unameval = document.forms[formid].elements[unameid].value;
737: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
738: if (domid > -1) {
739: var slct = document.forms[formid].elements[domid];
740: if (slct.type == 'select-one') {
741: var i;
742: for (i=0;i<slct.length;i++) {
743: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
744: }
745: }
746: if (slct.type == 'hidden') {
747: slct.value = fixeddom;
1.876 raeburn 748: }
749: }
1.468 raeburn 750: }
751: }
752: }
1.876 raeburn 753: return;
754: }
755:
756: $id_functions
757: ENDUSERBRW
1.468 raeburn 758: }
759:
760: sub setsec_javascript {
1.1075.2.31 raeburn 761: my ($sec_element,$formname,$role_element,$credits_element) = @_;
1.905 raeburn 762: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
763: $communityrolestr);
764: if ($role_element ne '') {
765: my @allroles = ('st','ta','ep','in','ad');
766: foreach my $crstype ('Course','Community') {
767: if ($crstype eq 'Community') {
768: foreach my $role (@allroles) {
769: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
770: }
771: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
772: } else {
773: foreach my $role (@allroles) {
774: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
775: }
776: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
777: }
778: }
779: $rolestr = '"'.join('","',@allroles).'"';
780: $courserolestr = '"'.join('","',@courserolenames).'"';
781: $communityrolestr = '"'.join('","',@communityrolenames).'"';
782: }
1.468 raeburn 783: my $setsections = qq|
784: function setSect(sectionlist) {
1.629 raeburn 785: var sectionsArray = new Array();
786: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
787: sectionsArray = sectionlist.split(",");
788: }
1.468 raeburn 789: var numSections = sectionsArray.length;
790: document.$formname.$sec_element.length = 0;
791: if (numSections == 0) {
792: document.$formname.$sec_element.multiple=false;
793: document.$formname.$sec_element.size=1;
794: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
795: } else {
796: if (numSections == 1) {
797: document.$formname.$sec_element.multiple=false;
798: document.$formname.$sec_element.size=1;
799: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
800: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
801: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
802: } else {
803: for (var i=0; i<numSections; i++) {
804: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
805: }
806: document.$formname.$sec_element.multiple=true
807: if (numSections < 3) {
808: document.$formname.$sec_element.size=numSections;
809: } else {
810: document.$formname.$sec_element.size=3;
811: }
812: document.$formname.$sec_element.options[0].selected = false
813: }
814: }
1.91 www 815: }
1.905 raeburn 816:
817: function setRole(crstype) {
1.468 raeburn 818: |;
1.905 raeburn 819: if ($role_element eq '') {
820: $setsections .= ' return;
821: }
822: ';
823: } else {
824: $setsections .= qq|
825: var elementLength = document.$formname.$role_element.length;
826: var allroles = Array($rolestr);
827: var courserolenames = Array($courserolestr);
828: var communityrolenames = Array($communityrolestr);
829: if (elementLength != undefined) {
830: if (document.$formname.$role_element.options[5].value == 'cc') {
831: if (crstype == 'Course') {
832: return;
833: } else {
834: allroles[5] = 'co';
835: for (var i=0; i<6; i++) {
836: document.$formname.$role_element.options[i].value = allroles[i];
837: document.$formname.$role_element.options[i].text = communityrolenames[i];
838: }
839: }
840: } else {
841: if (crstype == 'Community') {
842: return;
843: } else {
844: allroles[5] = 'cc';
845: for (var i=0; i<6; i++) {
846: document.$formname.$role_element.options[i].value = allroles[i];
847: document.$formname.$role_element.options[i].text = courserolenames[i];
848: }
849: }
850: }
851: }
852: return;
853: }
854: |;
855: }
1.1075.2.31 raeburn 856: if ($credits_element) {
857: $setsections .= qq|
858: function setCredits(defaultcredits) {
859: document.$formname.$credits_element.value = defaultcredits;
860: return;
861: }
862: |;
863: }
1.468 raeburn 864: return $setsections;
865: }
866:
1.91 www 867: sub selectcourse_link {
1.909 raeburn 868: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
869: $typeelement) = @_;
870: my $type = $selecttype;
1.871 raeburn 871: my $linktext = &mt('Select Course');
872: if ($selecttype eq 'Community') {
1.909 raeburn 873: $linktext = &mt('Select Community');
1.906 raeburn 874: } elsif ($selecttype eq 'Course/Community') {
875: $linktext = &mt('Select Course/Community');
1.909 raeburn 876: $type = '';
1.1019 raeburn 877: } elsif ($selecttype eq 'Select') {
878: $linktext = &mt('Select');
879: $type = '';
1.871 raeburn 880: }
1.787 bisitz 881: return '<span class="LC_nobreak">'
882: ."<a href='"
883: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
884: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 885: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 886: ."'>".$linktext.'</a>'
1.787 bisitz 887: .'</span>';
1.74 www 888: }
1.42 matthew 889:
1.653 raeburn 890: sub selectauthor_link {
891: my ($form,$udom)=@_;
892: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
893: &mt('Select Author').'</a>';
894: }
895:
1.876 raeburn 896: sub selectuser_link {
1.881 raeburn 897: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 898: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 899: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 900: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 901: ');">'.$linktext.'</a>';
1.876 raeburn 902: }
903:
1.273 raeburn 904: sub check_uncheck_jscript {
905: my $jscript = <<"ENDSCRT";
906: function checkAll(field) {
907: if (field.length > 0) {
908: for (i = 0; i < field.length; i++) {
1.1075.2.14 raeburn 909: if (!field[i].disabled) {
910: field[i].checked = true;
911: }
1.273 raeburn 912: }
913: } else {
1.1075.2.14 raeburn 914: if (!field.disabled) {
915: field.checked = true;
916: }
1.273 raeburn 917: }
918: }
919:
920: function uncheckAll(field) {
921: if (field.length > 0) {
922: for (i = 0; i < field.length; i++) {
923: field[i].checked = false ;
1.543 albertel 924: }
925: } else {
1.273 raeburn 926: field.checked = false ;
927: }
928: }
929: ENDSCRT
930: return $jscript;
931: }
932:
1.656 www 933: sub select_timezone {
1.659 raeburn 934: my ($name,$selected,$onchange,$includeempty)=@_;
935: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
936: if ($includeempty) {
937: $output .= '<option value=""';
938: if (($selected eq '') || ($selected eq 'local')) {
939: $output .= ' selected="selected" ';
940: }
941: $output .= '> </option>';
942: }
1.657 raeburn 943: my @timezones = DateTime::TimeZone->all_names;
944: foreach my $tzone (@timezones) {
945: $output.= '<option value="'.$tzone.'"';
946: if ($tzone eq $selected) {
947: $output.=' selected="selected"';
948: }
949: $output.=">$tzone</option>\n";
1.656 www 950: }
951: $output.="</select>";
952: return $output;
953: }
1.273 raeburn 954:
1.687 raeburn 955: sub select_datelocale {
956: my ($name,$selected,$onchange,$includeempty)=@_;
957: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
958: if ($includeempty) {
959: $output .= '<option value=""';
960: if ($selected eq '') {
961: $output .= ' selected="selected" ';
962: }
963: $output .= '> </option>';
964: }
965: my (@possibles,%locale_names);
966: my @locales = DateTime::Locale::Catalog::Locales;
967: foreach my $locale (@locales) {
968: if (ref($locale) eq 'HASH') {
969: my $id = $locale->{'id'};
970: if ($id ne '') {
971: my $en_terr = $locale->{'en_territory'};
972: my $native_terr = $locale->{'native_territory'};
1.695 raeburn 973: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 974: if (grep(/^en$/,@languages) || !@languages) {
975: if ($en_terr ne '') {
976: $locale_names{$id} = '('.$en_terr.')';
977: } elsif ($native_terr ne '') {
978: $locale_names{$id} = $native_terr;
979: }
980: } else {
981: if ($native_terr ne '') {
982: $locale_names{$id} = $native_terr.' ';
983: } elsif ($en_terr ne '') {
984: $locale_names{$id} = '('.$en_terr.')';
985: }
986: }
1.1075.2.94 raeburn 987: $locale_names{$id} = Encode::encode('UTF-8',$locale_names{$id});
1.687 raeburn 988: push (@possibles,$id);
989: }
990: }
991: }
992: foreach my $item (sort(@possibles)) {
993: $output.= '<option value="'.$item.'"';
994: if ($item eq $selected) {
995: $output.=' selected="selected"';
996: }
997: $output.=">$item";
998: if ($locale_names{$item} ne '') {
1.1075.2.94 raeburn 999: $output.=' '.$locale_names{$item};
1.687 raeburn 1000: }
1001: $output.="</option>\n";
1002: }
1003: $output.="</select>";
1004: return $output;
1005: }
1006:
1.792 raeburn 1007: sub select_language {
1008: my ($name,$selected,$includeempty) = @_;
1009: my %langchoices;
1010: if ($includeempty) {
1.1075.2.32 raeburn 1011: %langchoices = ('' => 'No language preference');
1.792 raeburn 1012: }
1013: foreach my $id (&languageids()) {
1014: my $code = &supportedlanguagecode($id);
1015: if ($code) {
1016: $langchoices{$code} = &plainlanguagedescription($id);
1017: }
1018: }
1.1075.2.32 raeburn 1019: %langchoices = &Apache::lonlocal::texthash(%langchoices);
1.970 raeburn 1020: return &select_form($selected,$name,\%langchoices);
1.792 raeburn 1021: }
1022:
1.42 matthew 1023: =pod
1.36 matthew 1024:
1.648 raeburn 1025: =item * &linked_select_forms(...)
1.36 matthew 1026:
1027: linked_select_forms returns a string containing a <script></script> block
1028: and html for two <select> menus. The select menus will be linked in that
1029: changing the value of the first menu will result in new values being placed
1030: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 1031: order unless a defined order is provided.
1.36 matthew 1032:
1033: linked_select_forms takes the following ordered inputs:
1034:
1035: =over 4
1036:
1.112 bowersj2 1037: =item * $formname, the name of the <form> tag
1.36 matthew 1038:
1.112 bowersj2 1039: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 1040:
1.112 bowersj2 1041: =item * $firstdefault, the default value for the first menu
1.36 matthew 1042:
1.112 bowersj2 1043: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 1044:
1.112 bowersj2 1045: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 1046:
1.112 bowersj2 1047: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 1048:
1.609 raeburn 1049: =item * $menuorder, the order of values in the first menu
1050:
1.1075.2.31 raeburn 1051: =item * $onchangefirst, additional javascript call to execute for an onchange
1052: event for the first <select> tag
1053:
1054: =item * $onchangesecond, additional javascript call to execute for an onchange
1055: event for the second <select> tag
1056:
1.41 ng 1057: =back
1058:
1.36 matthew 1059: Below is an example of such a hash. Only the 'text', 'default', and
1060: 'select2' keys must appear as stated. keys(%menu) are the possible
1061: values for the first select menu. The text that coincides with the
1.41 ng 1062: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 1063: and text for the second menu are given in the hash pointed to by
1064: $menu{$choice1}->{'select2'}.
1065:
1.112 bowersj2 1066: my %menu = ( A1 => { text =>"Choice A1" ,
1067: default => "B3",
1068: select2 => {
1069: B1 => "Choice B1",
1070: B2 => "Choice B2",
1071: B3 => "Choice B3",
1072: B4 => "Choice B4"
1.609 raeburn 1073: },
1074: order => ['B4','B3','B1','B2'],
1.112 bowersj2 1075: },
1076: A2 => { text =>"Choice A2" ,
1077: default => "C2",
1078: select2 => {
1079: C1 => "Choice C1",
1080: C2 => "Choice C2",
1081: C3 => "Choice C3"
1.609 raeburn 1082: },
1083: order => ['C2','C1','C3'],
1.112 bowersj2 1084: },
1085: A3 => { text =>"Choice A3" ,
1086: default => "D6",
1087: select2 => {
1088: D1 => "Choice D1",
1089: D2 => "Choice D2",
1090: D3 => "Choice D3",
1091: D4 => "Choice D4",
1092: D5 => "Choice D5",
1093: D6 => "Choice D6",
1094: D7 => "Choice D7"
1.609 raeburn 1095: },
1096: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 1097: }
1098: );
1.36 matthew 1099:
1100: =cut
1101:
1102: sub linked_select_forms {
1103: my ($formname,
1104: $middletext,
1105: $firstdefault,
1106: $firstselectname,
1107: $secondselectname,
1.609 raeburn 1108: $hashref,
1109: $menuorder,
1.1075.2.31 raeburn 1110: $onchangefirst,
1111: $onchangesecond
1.36 matthew 1112: ) = @_;
1113: my $second = "document.$formname.$secondselectname";
1114: my $first = "document.$formname.$firstselectname";
1115: # output the javascript to do the changing
1116: my $result = '';
1.776 bisitz 1117: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 1118: $result.="// <![CDATA[\n";
1.36 matthew 1119: $result.="var select2data = new Object();\n";
1120: $" = '","';
1121: my $debug = '';
1122: foreach my $s1 (sort(keys(%$hashref))) {
1123: $result.="select2data.d_$s1 = new Object();\n";
1124: $result.="select2data.d_$s1.def = new String('".
1125: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 1126: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 1127: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1128: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1129: @s2values = @{$hashref->{$s1}->{'order'}};
1130: }
1.36 matthew 1131: $result.="\"@s2values\");\n";
1132: $result.="select2data.d_$s1.texts = new Array(";
1133: my @s2texts;
1134: foreach my $value (@s2values) {
1135: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
1136: }
1137: $result.="\"@s2texts\");\n";
1138: }
1139: $"=' ';
1140: $result.= <<"END";
1141:
1142: function select1_changed() {
1143: // Determine new choice
1144: var newvalue = "d_" + $first.value;
1145: // update select2
1146: var values = select2data[newvalue].values;
1147: var texts = select2data[newvalue].texts;
1148: var select2def = select2data[newvalue].def;
1149: var i;
1150: // out with the old
1151: for (i = 0; i < $second.options.length; i++) {
1152: $second.options[i] = null;
1153: }
1154: // in with the nuclear
1155: for (i=0;i<values.length; i++) {
1156: $second.options[i] = new Option(values[i]);
1.143 matthew 1157: $second.options[i].value = values[i];
1.36 matthew 1158: $second.options[i].text = texts[i];
1159: if (values[i] == select2def) {
1160: $second.options[i].selected = true;
1161: }
1162: }
1163: }
1.824 bisitz 1164: // ]]>
1.36 matthew 1165: </script>
1166: END
1167: # output the initial values for the selection lists
1.1075.2.31 raeburn 1168: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed();$onchangefirst\">\n";
1.609 raeburn 1169: my @order = sort(keys(%{$hashref}));
1170: if (ref($menuorder) eq 'ARRAY') {
1171: @order = @{$menuorder};
1172: }
1173: foreach my $value (@order) {
1.36 matthew 1174: $result.=" <option value=\"$value\" ";
1.253 albertel 1175: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1176: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1177: }
1178: $result .= "</select>\n";
1179: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1180: $result .= $middletext;
1.1075.2.31 raeburn 1181: $result .= "<select size=\"1\" name=\"$secondselectname\"";
1182: if ($onchangesecond) {
1183: $result .= ' onchange="'.$onchangesecond.'"';
1184: }
1185: $result .= ">\n";
1.36 matthew 1186: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1187:
1188: my @secondorder = sort(keys(%select2));
1189: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1190: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1191: }
1192: foreach my $value (@secondorder) {
1.36 matthew 1193: $result.=" <option value=\"$value\" ";
1.253 albertel 1194: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1195: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1196: }
1197: $result .= "</select>\n";
1198: # return $debug;
1199: return $result;
1200: } # end of sub linked_select_forms {
1201:
1.45 matthew 1202: =pod
1.44 bowersj2 1203:
1.973 raeburn 1204: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid)
1.44 bowersj2 1205:
1.112 bowersj2 1206: Returns a string corresponding to an HTML link to the given help
1207: $topic, where $topic corresponds to the name of a .tex file in
1208: /home/httpd/html/adm/help/tex, with underscores replaced by
1209: spaces.
1210:
1211: $text will optionally be linked to the same topic, allowing you to
1212: link text in addition to the graphic. If you do not want to link
1213: text, but wish to specify one of the later parameters, pass an
1214: empty string.
1215:
1216: $stayOnPage is a value that will be interpreted as a boolean. If true,
1217: the link will not open a new window. If false, the link will open
1218: a new window using Javascript. (Default is false.)
1219:
1220: $width and $height are optional numerical parameters that will
1221: override the width and height of the popped up window, which may
1.973 raeburn 1222: be useful for certain help topics with big pictures included.
1223:
1224: $imgid is the id of the img tag used for the help icon. This may be
1225: used in a javascript call to switch the image src. See
1226: lonhtmlcommon::htmlareaselectactive() for an example.
1.44 bowersj2 1227:
1228: =cut
1229:
1230: sub help_open_topic {
1.973 raeburn 1231: my ($topic, $text, $stayOnPage, $width, $height, $imgid) = @_;
1.48 bowersj2 1232: $text = "" if (not defined $text);
1.44 bowersj2 1233: $stayOnPage = 0 if (not defined $stayOnPage);
1.1033 www 1234: $width = 500 if (not defined $width);
1.44 bowersj2 1235: $height = 400 if (not defined $height);
1236: my $filename = $topic;
1237: $filename =~ s/ /_/g;
1238:
1.48 bowersj2 1239: my $template = "";
1240: my $link;
1.572 banghart 1241:
1.159 www 1242: $topic=~s/\W/\_/g;
1.44 bowersj2 1243:
1.572 banghart 1244: if (!$stayOnPage) {
1.1075.2.50 raeburn 1245: if ($env{'browser.mobile'}) {
1246: $link = "javascript:openMyModal('/adm/help/${filename}.hlp',$width,$height,'yes');";
1247: } else {
1248: $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1249: }
1.1037 www 1250: } elsif ($stayOnPage eq 'popup') {
1251: $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 1252: } else {
1.48 bowersj2 1253: $link = "/adm/help/${filename}.hlp";
1254: }
1255:
1256: # Add the text
1.755 neumanie 1257: if ($text ne "") {
1.763 bisitz 1258: $template.='<span class="LC_help_open_topic">'
1259: .'<a target="_top" href="'.$link.'">'
1260: .$text.'</a>';
1.48 bowersj2 1261: }
1262:
1.763 bisitz 1263: # (Always) Add the graphic
1.179 matthew 1264: my $title = &mt('Online Help');
1.667 raeburn 1265: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973 raeburn 1266: if ($imgid ne '') {
1267: $imgid = ' id="'.$imgid.'"';
1268: }
1.763 bisitz 1269: $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
1270: .'<img src="'.$helpicon.'" border="0"'
1271: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973 raeburn 1272: .' title="'.$title.'" style="vertical-align:middle;"'.$imgid
1.763 bisitz 1273: .' /></a>';
1274: if ($text ne "") {
1275: $template.='</span>';
1276: }
1.44 bowersj2 1277: return $template;
1278:
1.106 bowersj2 1279: }
1280:
1281: # This is a quicky function for Latex cheatsheet editing, since it
1282: # appears in at least four places
1283: sub helpLatexCheatsheet {
1.1037 www 1284: my ($topic,$text,$not_author,$stayOnPage) = @_;
1.732 raeburn 1285: my $out;
1.106 bowersj2 1286: my $addOther = '';
1.732 raeburn 1287: if ($topic) {
1.1037 www 1288: $addOther = '<span>'.&help_open_topic($topic,&mt($text),$stayOnPage, undef, 600).'</span> ';
1.763 bisitz 1289: }
1290: $out = '<span>' # Start cheatsheet
1291: .$addOther
1292: .'<span>'
1.1037 www 1293: .&help_open_topic('Greek_Symbols',&mt('Greek Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1294: .'</span> <span>'
1.1037 www 1295: .&help_open_topic('Other_Symbols',&mt('Other Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1296: .'</span>';
1.732 raeburn 1297: unless ($not_author) {
1.763 bisitz 1298: $out .= ' <span>'
1.1037 www 1299: .&help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),$stayOnPage,undef,600)
1.1075.2.71 raeburn 1300: .'</span> <span>'
1.1075.2.78 raeburn 1301: .&help_open_topic('Authoring_Multilingual_Problems',&mt('Languages'),$stayOnPage,undef,600)
1.1075.2.71 raeburn 1302: .'</span>';
1.732 raeburn 1303: }
1.763 bisitz 1304: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1305: return $out;
1.172 www 1306: }
1307:
1.430 albertel 1308: sub general_help {
1309: my $helptopic='Student_Intro';
1310: if ($env{'request.role'}=~/^(ca|au)/) {
1311: $helptopic='Authoring_Intro';
1.907 raeburn 1312: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1313: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1314: } elsif ($env{'request.role'}=~/^dc/) {
1315: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1316: }
1317: return $helptopic;
1318: }
1319:
1320: sub update_help_link {
1321: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1322: my $origurl = $ENV{'REQUEST_URI'};
1323: $origurl=~s|^/~|/priv/|;
1324: my $timestamp = time;
1325: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1326: $$datum = &escape($$datum);
1327: }
1328:
1329: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1330: my $output .= <<"ENDOUTPUT";
1331: <script type="text/javascript">
1.824 bisitz 1332: // <![CDATA[
1.430 albertel 1333: banner_link = '$banner_link';
1.824 bisitz 1334: // ]]>
1.430 albertel 1335: </script>
1336: ENDOUTPUT
1337: return $output;
1338: }
1339:
1340: # now just updates the help link and generates a blue icon
1.193 raeburn 1341: sub help_open_menu {
1.430 albertel 1342: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1343: = @_;
1.949 droeschl 1344: $stayOnPage = 1;
1.430 albertel 1345: my $output;
1346: if ($component_help) {
1347: if (!$text) {
1348: $output=&help_open_topic($component_help,undef,$stayOnPage,
1349: $width,$height);
1350: } else {
1351: my $help_text;
1352: $help_text=&unescape($topic);
1353: $output='<table><tr><td>'.
1354: &help_open_topic($component_help,$help_text,$stayOnPage,
1355: $width,$height).'</td></tr></table>';
1356: }
1357: }
1358: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1359: return $output.$banner_link;
1360: }
1361:
1362: sub top_nav_help {
1363: my ($text) = @_;
1.436 albertel 1364: $text = &mt($text);
1.1075.2.60 raeburn 1365: my $stay_on_page;
1366: unless ($env{'environment.remote'} eq 'on') {
1367: $stay_on_page = 1;
1368: }
1.1075.2.61 raeburn 1369: my ($link,$banner_link);
1370: unless ($env{'request.noversionuri'} =~ m{^/adm/helpmenu}) {
1371: $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1372: : "javascript:helpMenu('open')";
1373: $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1374: }
1.201 raeburn 1375: my $title = &mt('Get help');
1.1075.2.61 raeburn 1376: if ($link) {
1377: return <<"END";
1.436 albertel 1378: $banner_link
1.1075.2.56 raeburn 1379: <a href="$link" title="$title">$text</a>
1.436 albertel 1380: END
1.1075.2.61 raeburn 1381: } else {
1382: return ' '.$text.' ';
1383: }
1.436 albertel 1384: }
1385:
1386: sub help_menu_js {
1.1075.2.52 raeburn 1387: my ($httphost) = @_;
1.949 droeschl 1388: my $stayOnPage = 1;
1.436 albertel 1389: my $width = 620;
1390: my $height = 600;
1.430 albertel 1391: my $helptopic=&general_help();
1.1075.2.52 raeburn 1392: my $details_link = $httphost.'/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1393: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1394: my $start_page =
1395: &Apache::loncommon::start_page('Help Menu', undef,
1396: {'frameset' => 1,
1397: 'js_ready' => 1,
1.1075.2.52 raeburn 1398: 'use_absolute' => $httphost,
1.331 albertel 1399: 'add_entries' => {
1400: 'border' => '0',
1.579 raeburn 1401: 'rows' => "110,*",},});
1.331 albertel 1402: my $end_page =
1403: &Apache::loncommon::end_page({'frameset' => 1,
1404: 'js_ready' => 1,});
1405:
1.436 albertel 1406: my $template .= <<"ENDTEMPLATE";
1407: <script type="text/javascript">
1.877 bisitz 1408: // <![CDATA[
1.253 albertel 1409: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1410: var banner_link = '';
1.243 raeburn 1411: function helpMenu(target) {
1412: var caller = this;
1413: if (target == 'open') {
1414: var newWindow = null;
1415: try {
1.262 albertel 1416: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1417: }
1418: catch(error) {
1419: writeHelp(caller);
1420: return;
1421: }
1422: if (newWindow) {
1423: caller = newWindow;
1424: }
1.193 raeburn 1425: }
1.243 raeburn 1426: writeHelp(caller);
1427: return;
1428: }
1429: function writeHelp(caller) {
1.1075.2.61 raeburn 1430: caller.document.writeln('$start_page\\n<frame name="bannerframe" src="'+banner_link+'" marginwidth="0" marginheight="0" frameborder="0">\\n');
1431: caller.document.writeln('<frame name="bodyframe" src="$details_link" marginwidth="0" marginheight="0" frameborder="0">\\n$end_page');
1432: caller.document.close();
1433: caller.focus();
1.193 raeburn 1434: }
1.877 bisitz 1435: // END LON-CAPA Internal -->
1.253 albertel 1436: // ]]>
1.436 albertel 1437: </script>
1.193 raeburn 1438: ENDTEMPLATE
1439: return $template;
1440: }
1441:
1.172 www 1442: sub help_open_bug {
1443: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1444: unless ($env{'user.adv'}) { return ''; }
1.172 www 1445: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1446: $text = "" if (not defined $text);
1447: $stayOnPage=1;
1.184 albertel 1448: $width = 600 if (not defined $width);
1449: $height = 600 if (not defined $height);
1.172 www 1450:
1451: $topic=~s/\W+/\+/g;
1452: my $link='';
1453: my $template='';
1.379 albertel 1454: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1455: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1456: if (!$stayOnPage)
1457: {
1458: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1459: }
1460: else
1461: {
1462: $link = $url;
1463: }
1464: # Add the text
1465: if ($text ne "")
1466: {
1467: $template .=
1468: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1469: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1470: }
1471:
1472: # Add the graphic
1.179 matthew 1473: my $title = &mt('Report a Bug');
1.215 albertel 1474: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1475: $template .= <<"ENDTEMPLATE";
1.436 albertel 1476: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1477: ENDTEMPLATE
1478: if ($text ne '') { $template.='</td></tr></table>' };
1479: return $template;
1480:
1481: }
1482:
1483: sub help_open_faq {
1484: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1485: unless ($env{'user.adv'}) { return ''; }
1.172 www 1486: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1487: $text = "" if (not defined $text);
1488: $stayOnPage=1;
1489: $width = 350 if (not defined $width);
1490: $height = 400 if (not defined $height);
1491:
1492: $topic=~s/\W+/\+/g;
1493: my $link='';
1494: my $template='';
1495: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1496: if (!$stayOnPage)
1497: {
1498: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1499: }
1500: else
1501: {
1502: $link = $url;
1503: }
1504:
1505: # Add the text
1506: if ($text ne "")
1507: {
1508: $template .=
1.173 www 1509: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1510: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1511: }
1512:
1513: # Add the graphic
1.179 matthew 1514: my $title = &mt('View the FAQ');
1.215 albertel 1515: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1516: $template .= <<"ENDTEMPLATE";
1.436 albertel 1517: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1518: ENDTEMPLATE
1519: if ($text ne '') { $template.='</td></tr></table>' };
1520: return $template;
1521:
1.44 bowersj2 1522: }
1.37 matthew 1523:
1.180 matthew 1524: ###############################################################
1525: ###############################################################
1526:
1.45 matthew 1527: =pod
1528:
1.648 raeburn 1529: =item * &change_content_javascript():
1.256 matthew 1530:
1531: This and the next function allow you to create small sections of an
1532: otherwise static HTML page that you can update on the fly with
1533: Javascript, even in Netscape 4.
1534:
1535: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1536: must be written to the HTML page once. It will prove the Javascript
1537: function "change(name, content)". Calling the change function with the
1538: name of the section
1539: you want to update, matching the name passed to C<changable_area>, and
1540: the new content you want to put in there, will put the content into
1541: that area.
1542:
1543: B<Note>: Netscape 4 only reserves enough space for the changable area
1544: to contain room for the original contents. You need to "make space"
1545: for whatever changes you wish to make, and be B<sure> to check your
1546: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1547: it's adequate for updating a one-line status display, but little more.
1548: This script will set the space to 100% width, so you only need to
1549: worry about height in Netscape 4.
1550:
1551: Modern browsers are much less limiting, and if you can commit to the
1552: user not using Netscape 4, this feature may be used freely with
1553: pretty much any HTML.
1554:
1555: =cut
1556:
1557: sub change_content_javascript {
1558: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1559: if ($env{'browser.type'} eq 'netscape' &&
1560: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1561: return (<<NETSCAPE4);
1562: function change(name, content) {
1563: doc = document.layers[name+"___escape"].layers[0].document;
1564: doc.open();
1565: doc.write(content);
1566: doc.close();
1567: }
1568: NETSCAPE4
1569: } else {
1570: # Otherwise, we need to use semi-standards-compliant code
1571: # (technically, "innerHTML" isn't standard but the equivalent
1572: # is really scary, and every useful browser supports it
1573: return (<<DOMBASED);
1574: function change(name, content) {
1575: element = document.getElementById(name);
1576: element.innerHTML = content;
1577: }
1578: DOMBASED
1579: }
1580: }
1581:
1582: =pod
1583:
1.648 raeburn 1584: =item * &changable_area($name,$origContent):
1.256 matthew 1585:
1586: This provides a "changable area" that can be modified on the fly via
1587: the Javascript code provided in C<change_content_javascript>. $name is
1588: the name you will use to reference the area later; do not repeat the
1589: same name on a given HTML page more then once. $origContent is what
1590: the area will originally contain, which can be left blank.
1591:
1592: =cut
1593:
1594: sub changable_area {
1595: my ($name, $origContent) = @_;
1596:
1.258 albertel 1597: if ($env{'browser.type'} eq 'netscape' &&
1598: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1599: # If this is netscape 4, we need to use the Layer tag
1600: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1601: } else {
1602: return "<span id='$name'>$origContent</span>";
1603: }
1604: }
1605:
1606: =pod
1607:
1.648 raeburn 1608: =item * &viewport_geometry_js
1.590 raeburn 1609:
1610: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1611:
1612: =cut
1613:
1614:
1615: sub viewport_geometry_js {
1616: return <<"GEOMETRY";
1617: var Geometry = {};
1618: function init_geometry() {
1619: if (Geometry.init) { return };
1620: Geometry.init=1;
1621: if (window.innerHeight) {
1622: Geometry.getViewportHeight = function() { return window.innerHeight; };
1623: Geometry.getViewportWidth = function() { return window.innerWidth; };
1624: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1625: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1626: }
1627: else if (document.documentElement && document.documentElement.clientHeight) {
1628: Geometry.getViewportHeight =
1629: function() { return document.documentElement.clientHeight; };
1630: Geometry.getViewportWidth =
1631: function() { return document.documentElement.clientWidth; };
1632:
1633: Geometry.getHorizontalScroll =
1634: function() { return document.documentElement.scrollLeft; };
1635: Geometry.getVerticalScroll =
1636: function() { return document.documentElement.scrollTop; };
1637: }
1638: else if (document.body.clientHeight) {
1639: Geometry.getViewportHeight =
1640: function() { return document.body.clientHeight; };
1641: Geometry.getViewportWidth =
1642: function() { return document.body.clientWidth; };
1643: Geometry.getHorizontalScroll =
1644: function() { return document.body.scrollLeft; };
1645: Geometry.getVerticalScroll =
1646: function() { return document.body.scrollTop; };
1647: }
1648: }
1649:
1650: GEOMETRY
1651: }
1652:
1653: =pod
1654:
1.648 raeburn 1655: =item * &viewport_size_js()
1.590 raeburn 1656:
1657: 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.
1658:
1659: =cut
1660:
1661: sub viewport_size_js {
1662: my $geometry = &viewport_geometry_js();
1663: return <<"DIMS";
1664:
1665: $geometry
1666:
1667: function getViewportDims(width,height) {
1668: init_geometry();
1669: width.value = Geometry.getViewportWidth();
1670: height.value = Geometry.getViewportHeight();
1671: return;
1672: }
1673:
1674: DIMS
1675: }
1676:
1677: =pod
1678:
1.648 raeburn 1679: =item * &resize_textarea_js()
1.565 albertel 1680:
1681: emits the needed javascript to resize a textarea to be as big as possible
1682:
1683: creates a function resize_textrea that takes two IDs first should be
1684: the id of the element to resize, second should be the id of a div that
1685: surrounds everything that comes after the textarea, this routine needs
1686: to be attached to the <body> for the onload and onresize events.
1687:
1.648 raeburn 1688: =back
1.565 albertel 1689:
1690: =cut
1691:
1692: sub resize_textarea_js {
1.590 raeburn 1693: my $geometry = &viewport_geometry_js();
1.565 albertel 1694: return <<"RESIZE";
1695: <script type="text/javascript">
1.824 bisitz 1696: // <![CDATA[
1.590 raeburn 1697: $geometry
1.565 albertel 1698:
1.588 albertel 1699: function getX(element) {
1700: var x = 0;
1701: while (element) {
1702: x += element.offsetLeft;
1703: element = element.offsetParent;
1704: }
1705: return x;
1706: }
1707: function getY(element) {
1708: var y = 0;
1709: while (element) {
1710: y += element.offsetTop;
1711: element = element.offsetParent;
1712: }
1713: return y;
1714: }
1715:
1716:
1.565 albertel 1717: function resize_textarea(textarea_id,bottom_id) {
1718: init_geometry();
1719: var textarea = document.getElementById(textarea_id);
1720: //alert(textarea);
1721:
1.588 albertel 1722: var textarea_top = getY(textarea);
1.565 albertel 1723: var textarea_height = textarea.offsetHeight;
1724: var bottom = document.getElementById(bottom_id);
1.588 albertel 1725: var bottom_top = getY(bottom);
1.565 albertel 1726: var bottom_height = bottom.offsetHeight;
1727: var window_height = Geometry.getViewportHeight();
1.588 albertel 1728: var fudge = 23;
1.565 albertel 1729: var new_height = window_height-fudge-textarea_top-bottom_height;
1730: if (new_height < 300) {
1731: new_height = 300;
1732: }
1733: textarea.style.height=new_height+'px';
1734: }
1.824 bisitz 1735: // ]]>
1.565 albertel 1736: </script>
1737: RESIZE
1738:
1739: }
1740:
1741: =pod
1742:
1.256 matthew 1743: =head1 Excel and CSV file utility routines
1744:
1745: =cut
1746:
1747: ###############################################################
1748: ###############################################################
1749:
1750: =pod
1751:
1.1075.2.56 raeburn 1752: =over 4
1753:
1.648 raeburn 1754: =item * &csv_translate($text)
1.37 matthew 1755:
1.185 www 1756: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1757: format.
1758:
1759: =cut
1760:
1.180 matthew 1761: ###############################################################
1762: ###############################################################
1.37 matthew 1763: sub csv_translate {
1764: my $text = shift;
1765: $text =~ s/\"/\"\"/g;
1.209 albertel 1766: $text =~ s/\n/ /g;
1.37 matthew 1767: return $text;
1768: }
1.180 matthew 1769:
1770: ###############################################################
1771: ###############################################################
1772:
1773: =pod
1774:
1.648 raeburn 1775: =item * &define_excel_formats()
1.180 matthew 1776:
1777: Define some commonly used Excel cell formats.
1778:
1779: Currently supported formats:
1780:
1781: =over 4
1782:
1783: =item header
1784:
1785: =item bold
1786:
1787: =item h1
1788:
1789: =item h2
1790:
1791: =item h3
1792:
1.256 matthew 1793: =item h4
1794:
1795: =item i
1796:
1.180 matthew 1797: =item date
1798:
1799: =back
1800:
1801: Inputs: $workbook
1802:
1803: Returns: $format, a hash reference.
1804:
1.1057 foxr 1805:
1.180 matthew 1806: =cut
1807:
1808: ###############################################################
1809: ###############################################################
1810: sub define_excel_formats {
1811: my ($workbook) = @_;
1812: my $format;
1813: $format->{'header'} = $workbook->add_format(bold => 1,
1814: bottom => 1,
1815: align => 'center');
1816: $format->{'bold'} = $workbook->add_format(bold=>1);
1817: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1818: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1819: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1820: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1821: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1822: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1823: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1824: return $format;
1825: }
1826:
1827: ###############################################################
1828: ###############################################################
1.113 bowersj2 1829:
1830: =pod
1831:
1.648 raeburn 1832: =item * &create_workbook()
1.255 matthew 1833:
1834: Create an Excel worksheet. If it fails, output message on the
1835: request object and return undefs.
1836:
1837: Inputs: Apache request object
1838:
1839: Returns (undef) on failure,
1840: Excel worksheet object, scalar with filename, and formats
1841: from &Apache::loncommon::define_excel_formats on success
1842:
1843: =cut
1844:
1845: ###############################################################
1846: ###############################################################
1847: sub create_workbook {
1848: my ($r) = @_;
1849: #
1850: # Create the excel spreadsheet
1851: my $filename = '/prtspool/'.
1.258 albertel 1852: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1853: time.'_'.rand(1000000000).'.xls';
1854: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1855: if (! defined($workbook)) {
1856: $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928 bisitz 1857: $r->print(
1858: '<p class="LC_error">'
1859: .&mt('Problems occurred in creating the new Excel file.')
1860: .' '.&mt('This error has been logged.')
1861: .' '.&mt('Please alert your LON-CAPA administrator.')
1862: .'</p>'
1863: );
1.255 matthew 1864: return (undef);
1865: }
1866: #
1.1014 foxr 1867: $workbook->set_tempdir(LONCAPA::tempdir());
1.255 matthew 1868: #
1869: my $format = &Apache::loncommon::define_excel_formats($workbook);
1870: return ($workbook,$filename,$format);
1871: }
1872:
1873: ###############################################################
1874: ###############################################################
1875:
1876: =pod
1877:
1.648 raeburn 1878: =item * &create_text_file()
1.113 bowersj2 1879:
1.542 raeburn 1880: Create a file to write to and eventually make available to the user.
1.256 matthew 1881: If file creation fails, outputs an error message on the request object and
1882: return undefs.
1.113 bowersj2 1883:
1.256 matthew 1884: Inputs: Apache request object, and file suffix
1.113 bowersj2 1885:
1.256 matthew 1886: Returns (undef) on failure,
1887: Filehandle and filename on success.
1.113 bowersj2 1888:
1889: =cut
1890:
1.256 matthew 1891: ###############################################################
1892: ###############################################################
1893: sub create_text_file {
1894: my ($r,$suffix) = @_;
1895: if (! defined($suffix)) { $suffix = 'txt'; };
1896: my $fh;
1897: my $filename = '/prtspool/'.
1.258 albertel 1898: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1899: time.'_'.rand(1000000000).'.'.$suffix;
1900: $fh = Apache::File->new('>/home/httpd'.$filename);
1901: if (! defined($fh)) {
1902: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 1903: $r->print(
1904: '<p class="LC_error">'
1905: .&mt('Problems occurred in creating the output file.')
1906: .' '.&mt('This error has been logged.')
1907: .' '.&mt('Please alert your LON-CAPA administrator.')
1908: .'</p>'
1909: );
1.113 bowersj2 1910: }
1.256 matthew 1911: return ($fh,$filename)
1.113 bowersj2 1912: }
1913:
1914:
1.256 matthew 1915: =pod
1.113 bowersj2 1916:
1917: =back
1918:
1919: =cut
1.37 matthew 1920:
1921: ###############################################################
1.33 matthew 1922: ## Home server <option> list generating code ##
1923: ###############################################################
1.35 matthew 1924:
1.169 www 1925: # ------------------------------------------
1926:
1927: sub domain_select {
1928: my ($name,$value,$multiple)=@_;
1929: my %domains=map {
1.514 albertel 1930: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1931: } &Apache::lonnet::all_domains();
1.169 www 1932: if ($multiple) {
1933: $domains{''}=&mt('Any domain');
1.550 albertel 1934: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1935: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1936: } else {
1.550 albertel 1937: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970 raeburn 1938: return &select_form($name,$value,\%domains);
1.169 www 1939: }
1940: }
1941:
1.282 albertel 1942: #-------------------------------------------
1943:
1944: =pod
1945:
1.519 raeburn 1946: =head1 Routines for form select boxes
1947:
1948: =over 4
1949:
1.648 raeburn 1950: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1951:
1952: Returns a string containing a <select> element int multiple mode
1953:
1954:
1955: Args:
1956: $name - name of the <select> element
1.506 raeburn 1957: $value - scalar or array ref of values that should already be selected
1.282 albertel 1958: $size - number of rows long the select element is
1.283 albertel 1959: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1960: (shown text should already have been &mt())
1.506 raeburn 1961: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1962:
1.282 albertel 1963: =cut
1964:
1965: #-------------------------------------------
1.169 www 1966: sub multiple_select_form {
1.284 albertel 1967: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1968: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1969: my $output='';
1.191 matthew 1970: if (! defined($size)) {
1971: $size = 4;
1.283 albertel 1972: if (scalar(keys(%$hash))<4) {
1973: $size = scalar(keys(%$hash));
1.191 matthew 1974: }
1975: }
1.734 bisitz 1976: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1977: my @order;
1.506 raeburn 1978: if (ref($order) eq 'ARRAY') {
1979: @order = @{$order};
1980: } else {
1981: @order = sort(keys(%$hash));
1.501 banghart 1982: }
1983: if (exists($$hash{'select_form_order'})) {
1984: @order = @{$$hash{'select_form_order'}};
1985: }
1986:
1.284 albertel 1987: foreach my $key (@order) {
1.356 albertel 1988: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1989: $output.='selected="selected" ' if ($selected{$key});
1990: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1991: }
1992: $output.="</select>\n";
1993: return $output;
1994: }
1995:
1.88 www 1996: #-------------------------------------------
1997:
1998: =pod
1999:
1.970 raeburn 2000: =item * &select_form($defdom,$name,$hashref,$onchange)
1.88 www 2001:
2002: Returns a string containing a <select name='$name' size='1'> form to
1.970 raeburn 2003: allow a user to select options from a ref to a hash containing:
2004: option_name => displayed text. An optional $onchange can include
2005: a javascript onchange item, e.g., onchange="this.form.submit();"
2006:
1.88 www 2007: See lonrights.pm for an example invocation and use.
2008:
2009: =cut
2010:
2011: #-------------------------------------------
2012: sub select_form {
1.970 raeburn 2013: my ($def,$name,$hashref,$onchange) = @_;
2014: return unless (ref($hashref) eq 'HASH');
2015: if ($onchange) {
2016: $onchange = ' onchange="'.$onchange.'"';
2017: }
2018: my $selectform = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.128 albertel 2019: my @keys;
1.970 raeburn 2020: if (exists($hashref->{'select_form_order'})) {
2021: @keys=@{$hashref->{'select_form_order'}};
1.128 albertel 2022: } else {
1.970 raeburn 2023: @keys=sort(keys(%{$hashref}));
1.128 albertel 2024: }
1.356 albertel 2025: foreach my $key (@keys) {
2026: $selectform.=
2027: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
2028: ($key eq $def ? 'selected="selected" ' : '').
1.970 raeburn 2029: ">".$hashref->{$key}."</option>\n";
1.88 www 2030: }
2031: $selectform.="</select>";
2032: return $selectform;
2033: }
2034:
1.475 www 2035: # For display filters
2036:
2037: sub display_filter {
1.1074 raeburn 2038: my ($context) = @_;
1.475 www 2039: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 2040: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.1074 raeburn 2041: my $phraseinput = 'hidden';
2042: my $includeinput = 'hidden';
2043: my ($checked,$includetypestext);
2044: if ($env{'form.displayfilter'} eq 'containing') {
2045: $phraseinput = 'text';
2046: if ($context eq 'parmslog') {
2047: $includeinput = 'checkbox';
2048: if ($env{'form.includetypes'}) {
2049: $checked = ' checked="checked"';
2050: }
2051: $includetypestext = &mt('Include parameter types');
2052: }
2053: } else {
2054: $includetypestext = ' ';
2055: }
2056: my ($additional,$secondid,$thirdid);
2057: if ($context eq 'parmslog') {
2058: $additional =
2059: '<label><input type="'.$includeinput.'" name="includetypes"'.
2060: $checked.' name="includetypes" value="1" id="includetypes" />'.
2061: ' <span id="includetypestext">'.$includetypestext.'</span>'.
2062: '</label>';
2063: $secondid = 'includetypes';
2064: $thirdid = 'includetypestext';
2065: }
2066: my $onchange = "javascript:toggleHistoryOptions(this,'containingphrase','$context',
2067: '$secondid','$thirdid')";
2068: return '<span class="LC_nobreak"><label>'.&mt('Records: [_1]',
1.475 www 2069: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
2070: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 2071: '</label></span> <span class="LC_nobreak">'.
1.1074 raeburn 2072: &mt('Filter: [_1]',
1.477 www 2073: &select_form($env{'form.displayfilter'},
2074: 'displayfilter',
1.970 raeburn 2075: {'currentfolder' => 'Current folder/page',
1.477 www 2076: 'containing' => 'Containing phrase',
1.1074 raeburn 2077: 'none' => 'None'},$onchange)).' '.
2078: '<input type="'.$phraseinput.'" name="containingphrase" id="containingphrase" size="30" value="'.
2079: &HTML::Entities::encode($env{'form.containingphrase'}).
2080: '" />'.$additional;
2081: }
2082:
2083: sub display_filter_js {
2084: my $includetext = &mt('Include parameter types');
2085: return <<"ENDJS";
2086:
2087: function toggleHistoryOptions(setter,firstid,context,secondid,thirdid) {
2088: var firstType = 'hidden';
2089: if (setter.options[setter.selectedIndex].value == 'containing') {
2090: firstType = 'text';
2091: }
2092: firstObject = document.getElementById(firstid);
2093: if (typeof(firstObject) == 'object') {
2094: if (firstObject.type != firstType) {
2095: changeInputType(firstObject,firstType);
2096: }
2097: }
2098: if (context == 'parmslog') {
2099: var secondType = 'hidden';
2100: if (firstType == 'text') {
2101: secondType = 'checkbox';
2102: }
2103: secondObject = document.getElementById(secondid);
2104: if (typeof(secondObject) == 'object') {
2105: if (secondObject.type != secondType) {
2106: changeInputType(secondObject,secondType);
2107: }
2108: }
2109: var textItem = document.getElementById(thirdid);
2110: var currtext = textItem.innerHTML;
2111: var newtext;
2112: if (firstType == 'text') {
2113: newtext = '$includetext';
2114: } else {
2115: newtext = ' ';
2116: }
2117: if (currtext != newtext) {
2118: textItem.innerHTML = newtext;
2119: }
2120: }
2121: return;
2122: }
2123:
2124: function changeInputType(oldObject,newType) {
2125: var newObject = document.createElement('input');
2126: newObject.type = newType;
2127: if (oldObject.size) {
2128: newObject.size = oldObject.size;
2129: }
2130: if (oldObject.value) {
2131: newObject.value = oldObject.value;
2132: }
2133: if (oldObject.name) {
2134: newObject.name = oldObject.name;
2135: }
2136: if (oldObject.id) {
2137: newObject.id = oldObject.id;
2138: }
2139: oldObject.parentNode.replaceChild(newObject,oldObject);
2140: return;
2141: }
2142:
2143: ENDJS
1.475 www 2144: }
2145:
1.167 www 2146: sub gradeleveldescription {
2147: my $gradelevel=shift;
2148: my %gradelevels=(0 => 'Not specified',
2149: 1 => 'Grade 1',
2150: 2 => 'Grade 2',
2151: 3 => 'Grade 3',
2152: 4 => 'Grade 4',
2153: 5 => 'Grade 5',
2154: 6 => 'Grade 6',
2155: 7 => 'Grade 7',
2156: 8 => 'Grade 8',
2157: 9 => 'Grade 9',
2158: 10 => 'Grade 10',
2159: 11 => 'Grade 11',
2160: 12 => 'Grade 12',
2161: 13 => 'Grade 13',
2162: 14 => '100 Level',
2163: 15 => '200 Level',
2164: 16 => '300 Level',
2165: 17 => '400 Level',
2166: 18 => 'Graduate Level');
2167: return &mt($gradelevels{$gradelevel});
2168: }
2169:
1.163 www 2170: sub select_level_form {
2171: my ($deflevel,$name)=@_;
2172: unless ($deflevel) { $deflevel=0; }
1.167 www 2173: my $selectform = "<select name=\"$name\" size=\"1\">\n";
2174: for (my $i=0; $i<=18; $i++) {
2175: $selectform.="<option value=\"$i\" ".
1.253 albertel 2176: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 2177: ">".&gradeleveldescription($i)."</option>\n";
2178: }
2179: $selectform.="</select>";
2180: return $selectform;
1.163 www 2181: }
1.167 www 2182:
1.35 matthew 2183: #-------------------------------------------
2184:
1.45 matthew 2185: =pod
2186:
1.1075.2.42 raeburn 2187: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms)
1.35 matthew 2188:
2189: Returns a string containing a <select name='$name' size='1'> form to
2190: allow a user to select the domain to preform an operation in.
2191: See loncreateuser.pm for an example invocation and use.
2192:
1.90 www 2193: If the $includeempty flag is set, it also includes an empty choice ("no domain
2194: selected");
2195:
1.743 raeburn 2196: If the $showdomdesc flag is set, the domain name is followed by the domain description.
2197:
1.910 raeburn 2198: 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.
2199:
1.1075.2.36 raeburn 2200: The optional $incdoms is a reference to an array of domains which will be the only available options.
2201:
2202: The optional $excdoms is a reference to an array of domains which will be excluded from the available options.
1.563 raeburn 2203:
1.35 matthew 2204: =cut
2205:
2206: #-------------------------------------------
1.34 matthew 2207: sub select_dom_form {
1.1075.2.36 raeburn 2208: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms) = @_;
1.872 raeburn 2209: if ($onchange) {
1.874 raeburn 2210: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 2211: }
1.1075.2.36 raeburn 2212: my (@domains,%exclude);
1.910 raeburn 2213: if (ref($incdoms) eq 'ARRAY') {
2214: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
2215: } else {
2216: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
2217: }
1.90 www 2218: if ($includeempty) { @domains=('',@domains); }
1.1075.2.36 raeburn 2219: if (ref($excdoms) eq 'ARRAY') {
2220: map { $exclude{$_} = 1; } @{$excdoms};
2221: }
1.743 raeburn 2222: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 2223: foreach my $dom (@domains) {
1.1075.2.36 raeburn 2224: next if ($exclude{$dom});
1.356 albertel 2225: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 2226: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
2227: if ($showdomdesc) {
2228: if ($dom ne '') {
2229: my $domdesc = &Apache::lonnet::domain($dom,'description');
2230: if ($domdesc ne '') {
2231: $selectdomain .= ' ('.$domdesc.')';
2232: }
2233: }
2234: }
2235: $selectdomain .= "</option>\n";
1.34 matthew 2236: }
2237: $selectdomain.="</select>";
2238: return $selectdomain;
2239: }
2240:
1.35 matthew 2241: #-------------------------------------------
2242:
1.45 matthew 2243: =pod
2244:
1.648 raeburn 2245: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 2246:
1.586 raeburn 2247: input: 4 arguments (two required, two optional) -
2248: $domain - domain of new user
2249: $name - name of form element
2250: $default - Value of 'default' causes a default item to be first
2251: option, and selected by default.
2252: $hide - Value of 'hide' causes hiding of the name of the server,
2253: if 1 server found, or default, if 0 found.
1.594 raeburn 2254: output: returns 2 items:
1.586 raeburn 2255: (a) form element which contains either:
2256: (i) <select name="$name">
2257: <option value="$hostid1">$hostid $servers{$hostid}</option>
2258: <option value="$hostid2">$hostid $servers{$hostid}</option>
2259: </select>
2260: form item if there are multiple library servers in $domain, or
2261: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2262: if there is only one library server in $domain.
2263:
2264: (b) number of library servers found.
2265:
2266: See loncreateuser.pm for example of use.
1.35 matthew 2267:
2268: =cut
2269:
2270: #-------------------------------------------
1.586 raeburn 2271: sub home_server_form_item {
2272: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2273: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2274: my $result;
2275: my $numlib = keys(%servers);
2276: if ($numlib > 1) {
2277: $result .= '<select name="'.$name.'" />'."\n";
2278: if ($default) {
1.804 bisitz 2279: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 2280: '</option>'."\n";
2281: }
2282: foreach my $hostid (sort(keys(%servers))) {
2283: $result.= '<option value="'.$hostid.'">'.
2284: $hostid.' '.$servers{$hostid}."</option>\n";
2285: }
2286: $result .= '</select>'."\n";
2287: } elsif ($numlib == 1) {
2288: my $hostid;
2289: foreach my $item (keys(%servers)) {
2290: $hostid = $item;
2291: }
2292: $result .= '<input type="hidden" name="'.$name.'" value="'.
2293: $hostid.'" />';
2294: if (!$hide) {
2295: $result .= $hostid.' '.$servers{$hostid};
2296: }
2297: $result .= "\n";
2298: } elsif ($default) {
2299: $result .= '<input type="hidden" name="'.$name.
2300: '" value="default" />';
2301: if (!$hide) {
2302: $result .= &mt('default');
2303: }
2304: $result .= "\n";
1.33 matthew 2305: }
1.586 raeburn 2306: return ($result,$numlib);
1.33 matthew 2307: }
1.112 bowersj2 2308:
2309: =pod
2310:
1.534 albertel 2311: =back
2312:
1.112 bowersj2 2313: =cut
1.87 matthew 2314:
2315: ###############################################################
1.112 bowersj2 2316: ## Decoding User Agent ##
1.87 matthew 2317: ###############################################################
2318:
2319: =pod
2320:
1.112 bowersj2 2321: =head1 Decoding the User Agent
2322:
2323: =over 4
2324:
2325: =item * &decode_user_agent()
1.87 matthew 2326:
2327: Inputs: $r
2328:
2329: Outputs:
2330:
2331: =over 4
2332:
1.112 bowersj2 2333: =item * $httpbrowser
1.87 matthew 2334:
1.112 bowersj2 2335: =item * $clientbrowser
1.87 matthew 2336:
1.112 bowersj2 2337: =item * $clientversion
1.87 matthew 2338:
1.112 bowersj2 2339: =item * $clientmathml
1.87 matthew 2340:
1.112 bowersj2 2341: =item * $clientunicode
1.87 matthew 2342:
1.112 bowersj2 2343: =item * $clientos
1.87 matthew 2344:
1.1075.2.42 raeburn 2345: =item * $clientmobile
2346:
2347: =item * $clientinfo
2348:
1.1075.2.77 raeburn 2349: =item * $clientosversion
2350:
1.87 matthew 2351: =back
2352:
1.157 matthew 2353: =back
2354:
1.87 matthew 2355: =cut
2356:
2357: ###############################################################
2358: ###############################################################
2359: sub decode_user_agent {
1.247 albertel 2360: my ($r)=@_;
1.87 matthew 2361: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2362: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2363: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2364: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2365: my $clientbrowser='unknown';
2366: my $clientversion='0';
2367: my $clientmathml='';
2368: my $clientunicode='0';
1.1075.2.42 raeburn 2369: my $clientmobile=0;
1.1075.2.77 raeburn 2370: my $clientosversion='';
1.87 matthew 2371: for (my $i=0;$i<=$#browsertype;$i++) {
1.1075.2.76 raeburn 2372: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\%/,$browsertype[$i]);
1.87 matthew 2373: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2374: $clientbrowser=$bname;
2375: $httpbrowser=~/$vreg/i;
2376: $clientversion=$1;
2377: $clientmathml=($clientversion>=$minv);
2378: $clientunicode=($clientversion>=$univ);
2379: }
2380: }
2381: my $clientos='unknown';
1.1075.2.42 raeburn 2382: my $clientinfo;
1.87 matthew 2383: if (($httpbrowser=~/linux/i) ||
2384: ($httpbrowser=~/unix/i) ||
2385: ($httpbrowser=~/ux/i) ||
2386: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2387: if (($httpbrowser=~/vax/i) ||
2388: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2389: if ($httpbrowser=~/next/i) { $clientos='next'; }
2390: if (($httpbrowser=~/mac/i) ||
2391: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1.1075.2.77 raeburn 2392: if ($httpbrowser=~/win/i) {
2393: $clientos='win';
2394: if ($httpbrowser =~/Windows\s+NT\s+(\d+\.\d+)/i) {
2395: $clientosversion = $1;
2396: }
2397: }
1.87 matthew 2398: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1.1075.2.42 raeburn 2399: if ($httpbrowser=~/(Android|iPod|iPad|iPhone|webOS|Blackberry|Windows Phone|Opera m(?:ob|in)|Fennec)/i) {
2400: $clientmobile=lc($1);
2401: }
2402: if ($httpbrowser=~ m{Firefox/(\d+\.\d+)}) {
2403: $clientinfo = 'firefox-'.$1;
2404: } elsif ($httpbrowser=~ m{chromeframe/(\d+\.\d+)\.}) {
2405: $clientinfo = 'chromeframe-'.$1;
2406: }
1.87 matthew 2407: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1.1075.2.77 raeburn 2408: $clientunicode,$clientos,$clientmobile,$clientinfo,
2409: $clientosversion);
1.87 matthew 2410: }
2411:
1.32 matthew 2412: ###############################################################
2413: ## Authentication changing form generation subroutines ##
2414: ###############################################################
2415: ##
2416: ## All of the authform_xxxxxxx subroutines take their inputs in a
2417: ## hash, and have reasonable default values.
2418: ##
2419: ## formname = the name given in the <form> tag.
1.35 matthew 2420: #-------------------------------------------
2421:
1.45 matthew 2422: =pod
2423:
1.112 bowersj2 2424: =head1 Authentication Routines
2425:
2426: =over 4
2427:
1.648 raeburn 2428: =item * &authform_xxxxxx()
1.35 matthew 2429:
2430: The authform_xxxxxx subroutines provide javascript and html forms which
2431: handle some of the conveniences required for authentication forms.
2432: This is not an optimal method, but it works.
2433:
2434: =over 4
2435:
1.112 bowersj2 2436: =item * authform_header
1.35 matthew 2437:
1.112 bowersj2 2438: =item * authform_authorwarning
1.35 matthew 2439:
1.112 bowersj2 2440: =item * authform_nochange
1.35 matthew 2441:
1.112 bowersj2 2442: =item * authform_kerberos
1.35 matthew 2443:
1.112 bowersj2 2444: =item * authform_internal
1.35 matthew 2445:
1.112 bowersj2 2446: =item * authform_filesystem
1.35 matthew 2447:
2448: =back
2449:
1.648 raeburn 2450: See loncreateuser.pm for invocation and use examples.
1.157 matthew 2451:
1.35 matthew 2452: =cut
2453:
2454: #-------------------------------------------
1.32 matthew 2455: sub authform_header{
2456: my %in = (
2457: formname => 'cu',
1.80 albertel 2458: kerb_def_dom => '',
1.32 matthew 2459: @_,
2460: );
2461: $in{'formname'} = 'document.' . $in{'formname'};
2462: my $result='';
1.80 albertel 2463:
2464: #---------------------------------------------- Code for upper case translation
2465: my $Javascript_toUpperCase;
2466: unless ($in{kerb_def_dom}) {
2467: $Javascript_toUpperCase =<<"END";
2468: switch (choice) {
2469: case 'krb': currentform.elements[choicearg].value =
2470: currentform.elements[choicearg].value.toUpperCase();
2471: break;
2472: default:
2473: }
2474: END
2475: } else {
2476: $Javascript_toUpperCase = "";
2477: }
2478:
1.165 raeburn 2479: my $radioval = "'nochange'";
1.591 raeburn 2480: if (defined($in{'curr_authtype'})) {
2481: if ($in{'curr_authtype'} ne '') {
2482: $radioval = "'".$in{'curr_authtype'}."arg'";
2483: }
1.174 matthew 2484: }
1.165 raeburn 2485: my $argfield = 'null';
1.591 raeburn 2486: if (defined($in{'mode'})) {
1.165 raeburn 2487: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2488: if (defined($in{'curr_autharg'})) {
2489: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2490: $argfield = "'$in{'curr_autharg'}'";
2491: }
2492: }
2493: }
2494: }
2495:
1.32 matthew 2496: $result.=<<"END";
2497: var current = new Object();
1.165 raeburn 2498: current.radiovalue = $radioval;
2499: current.argfield = $argfield;
1.32 matthew 2500:
2501: function changed_radio(choice,currentform) {
2502: var choicearg = choice + 'arg';
2503: // If a radio button in changed, we need to change the argfield
2504: if (current.radiovalue != choice) {
2505: current.radiovalue = choice;
2506: if (current.argfield != null) {
2507: currentform.elements[current.argfield].value = '';
2508: }
2509: if (choice == 'nochange') {
2510: current.argfield = null;
2511: } else {
2512: current.argfield = choicearg;
2513: switch(choice) {
2514: case 'krb':
2515: currentform.elements[current.argfield].value =
2516: "$in{'kerb_def_dom'}";
2517: break;
2518: default:
2519: break;
2520: }
2521: }
2522: }
2523: return;
2524: }
1.22 www 2525:
1.32 matthew 2526: function changed_text(choice,currentform) {
2527: var choicearg = choice + 'arg';
2528: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2529: $Javascript_toUpperCase
1.32 matthew 2530: // clear old field
2531: if ((current.argfield != choicearg) && (current.argfield != null)) {
2532: currentform.elements[current.argfield].value = '';
2533: }
2534: current.argfield = choicearg;
2535: }
2536: set_auth_radio_buttons(choice,currentform);
2537: return;
1.20 www 2538: }
1.32 matthew 2539:
2540: function set_auth_radio_buttons(newvalue,currentform) {
1.986 raeburn 2541: var numauthchoices = currentform.login.length;
2542: if (typeof numauthchoices == "undefined") {
2543: return;
2544: }
1.32 matthew 2545: var i=0;
1.986 raeburn 2546: while (i < numauthchoices) {
1.32 matthew 2547: if (currentform.login[i].value == newvalue) { break; }
2548: i++;
2549: }
1.986 raeburn 2550: if (i == numauthchoices) {
1.32 matthew 2551: return;
2552: }
2553: current.radiovalue = newvalue;
2554: currentform.login[i].checked = true;
2555: return;
2556: }
2557: END
2558: return $result;
2559: }
2560:
1.1075.2.20 raeburn 2561: sub authform_authorwarning {
1.32 matthew 2562: my $result='';
1.144 matthew 2563: $result='<i>'.
2564: &mt('As a general rule, only authors or co-authors should be '.
2565: 'filesystem authenticated '.
2566: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2567: return $result;
2568: }
2569:
1.1075.2.20 raeburn 2570: sub authform_nochange {
1.32 matthew 2571: my %in = (
2572: formname => 'document.cu',
2573: kerb_def_dom => 'MSU.EDU',
2574: @_,
2575: );
1.1075.2.20 raeburn 2576: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.586 raeburn 2577: my $result;
1.1075.2.20 raeburn 2578: if (!$authnum) {
2579: $result = &mt('Under your current role you are not permitted to change login settings for this user');
1.586 raeburn 2580: } else {
2581: $result = '<label>'.&mt('[_1] Do not change login data',
2582: '<input type="radio" name="login" value="nochange" '.
2583: 'checked="checked" onclick="'.
1.281 albertel 2584: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2585: '</label>';
1.586 raeburn 2586: }
1.32 matthew 2587: return $result;
2588: }
2589:
1.591 raeburn 2590: sub authform_kerberos {
1.32 matthew 2591: my %in = (
2592: formname => 'document.cu',
2593: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2594: kerb_def_auth => 'krb4',
1.32 matthew 2595: @_,
2596: );
1.586 raeburn 2597: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2598: $autharg,$jscall);
1.1075.2.20 raeburn 2599: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2600: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2601: $check5 = ' checked="checked"';
1.80 albertel 2602: } else {
1.772 bisitz 2603: $check4 = ' checked="checked"';
1.80 albertel 2604: }
1.165 raeburn 2605: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2606: if (defined($in{'curr_authtype'})) {
2607: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2608: $krbcheck = ' checked="checked"';
1.623 raeburn 2609: if (defined($in{'mode'})) {
2610: if ($in{'mode'} eq 'modifyuser') {
2611: $krbcheck = '';
2612: }
2613: }
1.591 raeburn 2614: if (defined($in{'curr_kerb_ver'})) {
2615: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2616: $check5 = ' checked="checked"';
1.591 raeburn 2617: $check4 = '';
2618: } else {
1.772 bisitz 2619: $check4 = ' checked="checked"';
1.591 raeburn 2620: $check5 = '';
2621: }
1.586 raeburn 2622: }
1.591 raeburn 2623: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2624: $krbarg = $in{'curr_autharg'};
2625: }
1.586 raeburn 2626: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2627: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2628: $result =
2629: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2630: $in{'curr_autharg'},$krbver);
2631: } else {
2632: $result =
2633: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2634: }
2635: return $result;
2636: }
2637: }
2638: } else {
2639: if ($authnum == 1) {
1.784 bisitz 2640: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2641: }
2642: }
1.586 raeburn 2643: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2644: return;
1.587 raeburn 2645: } elsif ($authtype eq '') {
1.591 raeburn 2646: if (defined($in{'mode'})) {
1.587 raeburn 2647: if ($in{'mode'} eq 'modifycourse') {
2648: if ($authnum == 1) {
1.1075.2.20 raeburn 2649: $authtype = '<input type="radio" name="login" value="krb" />';
1.587 raeburn 2650: }
2651: }
2652: }
1.586 raeburn 2653: }
2654: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2655: if ($authtype eq '') {
2656: $authtype = '<input type="radio" name="login" value="krb" '.
2657: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2658: $krbcheck.' />';
2659: }
2660: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
1.1075.2.20 raeburn 2661: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
1.586 raeburn 2662: $in{'curr_authtype'} eq 'krb5') ||
1.1075.2.20 raeburn 2663: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
1.586 raeburn 2664: $in{'curr_authtype'} eq 'krb4')) {
2665: $result .= &mt
1.144 matthew 2666: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2667: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2668: '<label>'.$authtype,
1.281 albertel 2669: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2670: 'value="'.$krbarg.'" '.
1.144 matthew 2671: 'onchange="'.$jscall.'" />',
1.281 albertel 2672: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2673: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2674: '</label>');
1.586 raeburn 2675: } elsif ($can_assign{'krb4'}) {
2676: $result .= &mt
2677: ('[_1] Kerberos authenticated with domain [_2] '.
2678: '[_3] Version 4 [_4]',
2679: '<label>'.$authtype,
2680: '</label><input type="text" size="10" name="krbarg" '.
2681: 'value="'.$krbarg.'" '.
2682: 'onchange="'.$jscall.'" />',
2683: '<label><input type="hidden" name="krbver" value="4" />',
2684: '</label>');
2685: } elsif ($can_assign{'krb5'}) {
2686: $result .= &mt
2687: ('[_1] Kerberos authenticated with domain [_2] '.
2688: '[_3] Version 5 [_4]',
2689: '<label>'.$authtype,
2690: '</label><input type="text" size="10" name="krbarg" '.
2691: 'value="'.$krbarg.'" '.
2692: 'onchange="'.$jscall.'" />',
2693: '<label><input type="hidden" name="krbver" value="5" />',
2694: '</label>');
2695: }
1.32 matthew 2696: return $result;
2697: }
2698:
1.1075.2.20 raeburn 2699: sub authform_internal {
1.586 raeburn 2700: my %in = (
1.32 matthew 2701: formname => 'document.cu',
2702: kerb_def_dom => 'MSU.EDU',
2703: @_,
2704: );
1.586 raeburn 2705: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
1.1075.2.20 raeburn 2706: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2707: if (defined($in{'curr_authtype'})) {
2708: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2709: if ($can_assign{'int'}) {
1.772 bisitz 2710: $intcheck = 'checked="checked" ';
1.623 raeburn 2711: if (defined($in{'mode'})) {
2712: if ($in{'mode'} eq 'modifyuser') {
2713: $intcheck = '';
2714: }
2715: }
1.591 raeburn 2716: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2717: $intarg = $in{'curr_autharg'};
2718: }
2719: } else {
2720: $result = &mt('Currently internally authenticated.');
2721: return $result;
1.165 raeburn 2722: }
2723: }
1.586 raeburn 2724: } else {
2725: if ($authnum == 1) {
1.784 bisitz 2726: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 2727: }
2728: }
2729: if (!$can_assign{'int'}) {
2730: return;
1.587 raeburn 2731: } elsif ($authtype eq '') {
1.591 raeburn 2732: if (defined($in{'mode'})) {
1.587 raeburn 2733: if ($in{'mode'} eq 'modifycourse') {
2734: if ($authnum == 1) {
1.1075.2.20 raeburn 2735: $authtype = '<input type="radio" name="login" value="int" />';
1.587 raeburn 2736: }
2737: }
2738: }
1.165 raeburn 2739: }
1.586 raeburn 2740: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2741: if ($authtype eq '') {
2742: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2743: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2744: }
1.605 bisitz 2745: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2746: $intarg.'" onchange="'.$jscall.'" />';
2747: $result = &mt
1.144 matthew 2748: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2749: '<label>'.$authtype,'</label>'.$autharg);
1.824 bisitz 2750: $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 2751: return $result;
2752: }
2753:
1.1075.2.20 raeburn 2754: sub authform_local {
1.32 matthew 2755: my %in = (
2756: formname => 'document.cu',
2757: kerb_def_dom => 'MSU.EDU',
2758: @_,
2759: );
1.586 raeburn 2760: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
1.1075.2.20 raeburn 2761: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2762: if (defined($in{'curr_authtype'})) {
2763: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2764: if ($can_assign{'loc'}) {
1.772 bisitz 2765: $loccheck = 'checked="checked" ';
1.623 raeburn 2766: if (defined($in{'mode'})) {
2767: if ($in{'mode'} eq 'modifyuser') {
2768: $loccheck = '';
2769: }
2770: }
1.591 raeburn 2771: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2772: $locarg = $in{'curr_autharg'};
2773: }
2774: } else {
2775: $result = &mt('Currently using local (institutional) authentication.');
2776: return $result;
1.165 raeburn 2777: }
2778: }
1.586 raeburn 2779: } else {
2780: if ($authnum == 1) {
1.784 bisitz 2781: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 2782: }
2783: }
2784: if (!$can_assign{'loc'}) {
2785: return;
1.587 raeburn 2786: } elsif ($authtype eq '') {
1.591 raeburn 2787: if (defined($in{'mode'})) {
1.587 raeburn 2788: if ($in{'mode'} eq 'modifycourse') {
2789: if ($authnum == 1) {
1.1075.2.20 raeburn 2790: $authtype = '<input type="radio" name="login" value="loc" />';
1.587 raeburn 2791: }
2792: }
2793: }
1.165 raeburn 2794: }
1.586 raeburn 2795: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2796: if ($authtype eq '') {
2797: $authtype = '<input type="radio" name="login" value="loc" '.
2798: $loccheck.' onchange="'.$jscall.'" onclick="'.
2799: $jscall.'" />';
2800: }
2801: $autharg = '<input type="text" size="10" name="locarg" value="'.
2802: $locarg.'" onchange="'.$jscall.'" />';
2803: $result = &mt('[_1] Local Authentication with argument [_2]',
2804: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2805: return $result;
2806: }
2807:
1.1075.2.20 raeburn 2808: sub authform_filesystem {
1.32 matthew 2809: my %in = (
2810: formname => 'document.cu',
2811: kerb_def_dom => 'MSU.EDU',
2812: @_,
2813: );
1.586 raeburn 2814: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
1.1075.2.20 raeburn 2815: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2816: if (defined($in{'curr_authtype'})) {
2817: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2818: if ($can_assign{'fsys'}) {
1.772 bisitz 2819: $fsyscheck = 'checked="checked" ';
1.623 raeburn 2820: if (defined($in{'mode'})) {
2821: if ($in{'mode'} eq 'modifyuser') {
2822: $fsyscheck = '';
2823: }
2824: }
1.586 raeburn 2825: } else {
2826: $result = &mt('Currently Filesystem Authenticated.');
2827: return $result;
2828: }
2829: }
2830: } else {
2831: if ($authnum == 1) {
1.784 bisitz 2832: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 2833: }
2834: }
2835: if (!$can_assign{'fsys'}) {
2836: return;
1.587 raeburn 2837: } elsif ($authtype eq '') {
1.591 raeburn 2838: if (defined($in{'mode'})) {
1.587 raeburn 2839: if ($in{'mode'} eq 'modifycourse') {
2840: if ($authnum == 1) {
1.1075.2.20 raeburn 2841: $authtype = '<input type="radio" name="login" value="fsys" />';
1.587 raeburn 2842: }
2843: }
2844: }
1.586 raeburn 2845: }
2846: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2847: if ($authtype eq '') {
2848: $authtype = '<input type="radio" name="login" value="fsys" '.
2849: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2850: $jscall.'" />';
2851: }
2852: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2853: ' onchange="'.$jscall.'" />';
2854: $result = &mt
1.144 matthew 2855: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2856: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2857: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2858: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2859: 'onchange="'.$jscall.'" />');
1.32 matthew 2860: return $result;
2861: }
2862:
1.586 raeburn 2863: sub get_assignable_auth {
2864: my ($dom) = @_;
2865: if ($dom eq '') {
2866: $dom = $env{'request.role.domain'};
2867: }
2868: my %can_assign = (
2869: krb4 => 1,
2870: krb5 => 1,
2871: int => 1,
2872: loc => 1,
2873: );
2874: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2875: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2876: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2877: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2878: my $context;
2879: if ($env{'request.role'} =~ /^au/) {
2880: $context = 'author';
2881: } elsif ($env{'request.role'} =~ /^dc/) {
2882: $context = 'domain';
2883: } elsif ($env{'request.course.id'}) {
2884: $context = 'course';
2885: }
2886: if ($context) {
2887: if (ref($authhash->{$context}) eq 'HASH') {
2888: %can_assign = %{$authhash->{$context}};
2889: }
2890: }
2891: }
2892: }
2893: my $authnum = 0;
2894: foreach my $key (keys(%can_assign)) {
2895: if ($can_assign{$key}) {
2896: $authnum ++;
2897: }
2898: }
2899: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2900: $authnum --;
2901: }
2902: return ($authnum,%can_assign);
2903: }
2904:
1.80 albertel 2905: ###############################################################
2906: ## Get Kerberos Defaults for Domain ##
2907: ###############################################################
2908: ##
2909: ## Returns default kerberos version and an associated argument
2910: ## as listed in file domain.tab. If not listed, provides
2911: ## appropriate default domain and kerberos version.
2912: ##
2913: #-------------------------------------------
2914:
2915: =pod
2916:
1.648 raeburn 2917: =item * &get_kerberos_defaults()
1.80 albertel 2918:
2919: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2920: version and domain. If not found, it defaults to version 4 and the
2921: domain of the server.
1.80 albertel 2922:
1.648 raeburn 2923: =over 4
2924:
1.80 albertel 2925: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2926:
1.648 raeburn 2927: =back
2928:
2929: =back
2930:
1.80 albertel 2931: =cut
2932:
2933: #-------------------------------------------
2934: sub get_kerberos_defaults {
2935: my $domain=shift;
1.641 raeburn 2936: my ($krbdef,$krbdefdom);
2937: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2938: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2939: $krbdef = $domdefaults{'auth_def'};
2940: $krbdefdom = $domdefaults{'auth_arg_def'};
2941: } else {
1.80 albertel 2942: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2943: my $krbdefdom=$1;
2944: $krbdefdom=~tr/a-z/A-Z/;
2945: $krbdef = "krb4";
2946: }
2947: return ($krbdef,$krbdefdom);
2948: }
1.112 bowersj2 2949:
1.32 matthew 2950:
1.46 matthew 2951: ###############################################################
2952: ## Thesaurus Functions ##
2953: ###############################################################
1.20 www 2954:
1.46 matthew 2955: =pod
1.20 www 2956:
1.112 bowersj2 2957: =head1 Thesaurus Functions
2958:
2959: =over 4
2960:
1.648 raeburn 2961: =item * &initialize_keywords()
1.46 matthew 2962:
2963: Initializes the package variable %Keywords if it is empty. Uses the
2964: package variable $thesaurus_db_file.
2965:
2966: =cut
2967:
2968: ###################################################
2969:
2970: sub initialize_keywords {
2971: return 1 if (scalar keys(%Keywords));
2972: # If we are here, %Keywords is empty, so fill it up
2973: # Make sure the file we need exists...
2974: if (! -e $thesaurus_db_file) {
2975: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2976: " failed because it does not exist");
2977: return 0;
2978: }
2979: # Set up the hash as a database
2980: my %thesaurus_db;
2981: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2982: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2983: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2984: $thesaurus_db_file);
2985: return 0;
2986: }
2987: # Get the average number of appearances of a word.
2988: my $avecount = $thesaurus_db{'average.count'};
2989: # Put keywords (those that appear > average) into %Keywords
2990: while (my ($word,$data)=each (%thesaurus_db)) {
2991: my ($count,undef) = split /:/,$data;
2992: $Keywords{$word}++ if ($count > $avecount);
2993: }
2994: untie %thesaurus_db;
2995: # Remove special values from %Keywords.
1.356 albertel 2996: foreach my $value ('total.count','average.count') {
2997: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2998: }
1.46 matthew 2999: return 1;
3000: }
3001:
3002: ###################################################
3003:
3004: =pod
3005:
1.648 raeburn 3006: =item * &keyword($word)
1.46 matthew 3007:
3008: Returns true if $word is a keyword. A keyword is a word that appears more
3009: than the average number of times in the thesaurus database. Calls
3010: &initialize_keywords
3011:
3012: =cut
3013:
3014: ###################################################
1.20 www 3015:
3016: sub keyword {
1.46 matthew 3017: return if (!&initialize_keywords());
3018: my $word=lc(shift());
3019: $word=~s/\W//g;
3020: return exists($Keywords{$word});
1.20 www 3021: }
1.46 matthew 3022:
3023: ###############################################################
3024:
3025: =pod
1.20 www 3026:
1.648 raeburn 3027: =item * &get_related_words()
1.46 matthew 3028:
1.160 matthew 3029: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 3030: an array of words. If the keyword is not in the thesaurus, an empty array
3031: will be returned. The order of the words returned is determined by the
3032: database which holds them.
3033:
3034: Uses global $thesaurus_db_file.
3035:
1.1057 foxr 3036:
1.46 matthew 3037: =cut
3038:
3039: ###############################################################
3040: sub get_related_words {
3041: my $keyword = shift;
3042: my %thesaurus_db;
3043: if (! -e $thesaurus_db_file) {
3044: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
3045: "failed because the file does not exist");
3046: return ();
3047: }
3048: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 3049: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 3050: return ();
3051: }
3052: my @Words=();
1.429 www 3053: my $count=0;
1.46 matthew 3054: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 3055: # The first element is the number of times
3056: # the word appears. We do not need it now.
1.429 www 3057: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
3058: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
3059: my $threshold=$mostfrequentcount/10;
3060: foreach my $possibleword (@RelatedWords) {
3061: my ($word,$wordcount)=split(/\,/,$possibleword);
3062: if ($wordcount>$threshold) {
3063: push(@Words,$word);
3064: $count++;
3065: if ($count>10) { last; }
3066: }
1.20 www 3067: }
3068: }
1.46 matthew 3069: untie %thesaurus_db;
3070: return @Words;
1.14 harris41 3071: }
1.46 matthew 3072:
1.112 bowersj2 3073: =pod
3074:
3075: =back
3076:
3077: =cut
1.61 www 3078:
3079: # -------------------------------------------------------------- Plaintext name
1.81 albertel 3080: =pod
3081:
1.112 bowersj2 3082: =head1 User Name Functions
3083:
3084: =over 4
3085:
1.648 raeburn 3086: =item * &plainname($uname,$udom,$first)
1.81 albertel 3087:
1.112 bowersj2 3088: Takes a users logon name and returns it as a string in
1.226 albertel 3089: "first middle last generation" form
3090: if $first is set to 'lastname' then it returns it as
3091: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 3092:
3093: =cut
1.61 www 3094:
1.295 www 3095:
1.81 albertel 3096: ###############################################################
1.61 www 3097: sub plainname {
1.226 albertel 3098: my ($uname,$udom,$first)=@_;
1.537 albertel 3099: return if (!defined($uname) || !defined($udom));
1.295 www 3100: my %names=&getnames($uname,$udom);
1.226 albertel 3101: my $name=&Apache::lonnet::format_name($names{'firstname'},
3102: $names{'middlename'},
3103: $names{'lastname'},
3104: $names{'generation'},$first);
3105: $name=~s/^\s+//;
1.62 www 3106: $name=~s/\s+$//;
3107: $name=~s/\s+/ /g;
1.353 albertel 3108: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 3109: return $name;
1.61 www 3110: }
1.66 www 3111:
3112: # -------------------------------------------------------------------- Nickname
1.81 albertel 3113: =pod
3114:
1.648 raeburn 3115: =item * &nickname($uname,$udom)
1.81 albertel 3116:
3117: Gets a users name and returns it as a string as
3118:
3119: ""nickname""
1.66 www 3120:
1.81 albertel 3121: if the user has a nickname or
3122:
3123: "first middle last generation"
3124:
3125: if the user does not
3126:
3127: =cut
1.66 www 3128:
3129: sub nickname {
3130: my ($uname,$udom)=@_;
1.537 albertel 3131: return if (!defined($uname) || !defined($udom));
1.295 www 3132: my %names=&getnames($uname,$udom);
1.68 albertel 3133: my $name=$names{'nickname'};
1.66 www 3134: if ($name) {
3135: $name='"'.$name.'"';
3136: } else {
3137: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
3138: $names{'lastname'}.' '.$names{'generation'};
3139: $name=~s/\s+$//;
3140: $name=~s/\s+/ /g;
3141: }
3142: return $name;
3143: }
3144:
1.295 www 3145: sub getnames {
3146: my ($uname,$udom)=@_;
1.537 albertel 3147: return if (!defined($uname) || !defined($udom));
1.433 albertel 3148: if ($udom eq 'public' && $uname eq 'public') {
3149: return ('lastname' => &mt('Public'));
3150: }
1.295 www 3151: my $id=$uname.':'.$udom;
3152: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
3153: if ($cached) {
3154: return %{$names};
3155: } else {
3156: my %loadnames=&Apache::lonnet::get('environment',
3157: ['firstname','middlename','lastname','generation','nickname'],
3158: $udom,$uname);
3159: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
3160: return %loadnames;
3161: }
3162: }
1.61 www 3163:
1.542 raeburn 3164: # -------------------------------------------------------------------- getemails
1.648 raeburn 3165:
1.542 raeburn 3166: =pod
3167:
1.648 raeburn 3168: =item * &getemails($uname,$udom)
1.542 raeburn 3169:
3170: Gets a user's email information and returns it as a hash with keys:
3171: notification, critnotification, permanentemail
3172:
3173: For notification and critnotification, values are comma-separated lists
1.648 raeburn 3174: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 3175:
1.648 raeburn 3176:
1.542 raeburn 3177: =cut
3178:
1.648 raeburn 3179:
1.466 albertel 3180: sub getemails {
3181: my ($uname,$udom)=@_;
3182: if ($udom eq 'public' && $uname eq 'public') {
3183: return;
3184: }
1.467 www 3185: if (!$udom) { $udom=$env{'user.domain'}; }
3186: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 3187: my $id=$uname.':'.$udom;
3188: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
3189: if ($cached) {
3190: return %{$names};
3191: } else {
3192: my %loadnames=&Apache::lonnet::get('environment',
3193: ['notification','critnotification',
3194: 'permanentemail'],
3195: $udom,$uname);
3196: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
3197: return %loadnames;
3198: }
3199: }
3200:
1.551 albertel 3201: sub flush_email_cache {
3202: my ($uname,$udom)=@_;
3203: if (!$udom) { $udom =$env{'user.domain'}; }
3204: if (!$uname) { $uname=$env{'user.name'}; }
3205: return if ($udom eq 'public' && $uname eq 'public');
3206: my $id=$uname.':'.$udom;
3207: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
3208: }
3209:
1.728 raeburn 3210: # -------------------------------------------------------------------- getlangs
3211:
3212: =pod
3213:
3214: =item * &getlangs($uname,$udom)
3215:
3216: Gets a user's language preference and returns it as a hash with key:
3217: language.
3218:
3219: =cut
3220:
3221:
3222: sub getlangs {
3223: my ($uname,$udom) = @_;
3224: if (!$udom) { $udom =$env{'user.domain'}; }
3225: if (!$uname) { $uname=$env{'user.name'}; }
3226: my $id=$uname.':'.$udom;
3227: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
3228: if ($cached) {
3229: return %{$langs};
3230: } else {
3231: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
3232: $udom,$uname);
3233: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
3234: return %loadlangs;
3235: }
3236: }
3237:
3238: sub flush_langs_cache {
3239: my ($uname,$udom)=@_;
3240: if (!$udom) { $udom =$env{'user.domain'}; }
3241: if (!$uname) { $uname=$env{'user.name'}; }
3242: return if ($udom eq 'public' && $uname eq 'public');
3243: my $id=$uname.':'.$udom;
3244: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
3245: }
3246:
1.61 www 3247: # ------------------------------------------------------------------ Screenname
1.81 albertel 3248:
3249: =pod
3250:
1.648 raeburn 3251: =item * &screenname($uname,$udom)
1.81 albertel 3252:
3253: Gets a users screenname and returns it as a string
3254:
3255: =cut
1.61 www 3256:
3257: sub screenname {
3258: my ($uname,$udom)=@_;
1.258 albertel 3259: if ($uname eq $env{'user.name'} &&
3260: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 3261: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 3262: return $names{'screenname'};
1.62 www 3263: }
3264:
1.212 albertel 3265:
1.802 bisitz 3266: # ------------------------------------------------------------- Confirm Wrapper
3267: =pod
3268:
1.1075.2.42 raeburn 3269: =item * &confirmwrapper($message)
1.802 bisitz 3270:
3271: Wrap messages about completion of operation in box
3272:
3273: =cut
3274:
3275: sub confirmwrapper {
3276: my ($message)=@_;
3277: if ($message) {
3278: return "\n".'<div class="LC_confirm_box">'."\n"
3279: .$message."\n"
3280: .'</div>'."\n";
3281: } else {
3282: return $message;
3283: }
3284: }
3285:
1.62 www 3286: # ------------------------------------------------------------- Message Wrapper
3287:
3288: sub messagewrapper {
1.369 www 3289: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 3290: return
1.441 albertel 3291: '<a href="/adm/email?compose=individual&'.
3292: 'recname='.$username.'&recdom='.$domain.
3293: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 3294: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 3295: }
1.802 bisitz 3296:
1.74 www 3297: # --------------------------------------------------------------- Notes Wrapper
3298:
3299: sub noteswrapper {
3300: my ($link,$un,$do)=@_;
3301: return
1.896 amueller 3302: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 3303: }
1.802 bisitz 3304:
1.62 www 3305: # ------------------------------------------------------------- Aboutme Wrapper
3306:
3307: sub aboutmewrapper {
1.1070 raeburn 3308: my ($link,$username,$domain,$target,$class)=@_;
1.447 raeburn 3309: if (!defined($username) && !defined($domain)) {
3310: return;
3311: }
1.1075.2.15 raeburn 3312: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.1070 raeburn 3313: ($target?' target="'.$target.'"':'').($class?' class="'.$class.'"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 3314: }
3315:
3316: # ------------------------------------------------------------ Syllabus Wrapper
3317:
3318: sub syllabuswrapper {
1.707 bisitz 3319: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 3320: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 3321: }
1.14 harris41 3322:
1.802 bisitz 3323: # -----------------------------------------------------------------------------
3324:
1.208 matthew 3325: sub track_student_link {
1.887 raeburn 3326: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 3327: my $link ="/adm/trackstudent?";
1.208 matthew 3328: my $title = 'View recent activity';
3329: if (defined($sname) && $sname !~ /^\s*$/ &&
3330: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 3331: $link .= "selected_student=$sname:$sdom";
1.208 matthew 3332: $title .= ' of this student';
1.268 albertel 3333: }
1.208 matthew 3334: if (defined($target) && $target !~ /^\s*$/) {
3335: $target = qq{target="$target"};
3336: } else {
3337: $target = '';
3338: }
1.268 albertel 3339: if ($start) { $link.='&start='.$start; }
1.887 raeburn 3340: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 3341: $title = &mt($title);
3342: $linktext = &mt($linktext);
1.448 albertel 3343: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
3344: &help_open_topic('View_recent_activity');
1.208 matthew 3345: }
3346:
1.781 raeburn 3347: sub slot_reservations_link {
3348: my ($linktext,$sname,$sdom,$target) = @_;
3349: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
3350: my $title = 'View slot reservation history';
3351: if (defined($sname) && $sname !~ /^\s*$/ &&
3352: defined($sdom) && $sdom !~ /^\s*$/) {
3353: $link .= "&uname=$sname&udom=$sdom";
3354: $title .= ' of this student';
3355: }
3356: if (defined($target) && $target !~ /^\s*$/) {
3357: $target = qq{target="$target"};
3358: } else {
3359: $target = '';
3360: }
3361: $title = &mt($title);
3362: $linktext = &mt($linktext);
3363: return qq{<a href="$link" title="$title" $target>$linktext</a>};
3364: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
3365:
3366: }
3367:
1.508 www 3368: # ===================================================== Display a student photo
3369:
3370:
1.509 albertel 3371: sub student_image_tag {
1.508 www 3372: my ($domain,$user)=@_;
3373: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
3374: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
3375: return '<img src="'.$imgsrc.'" align="right" />';
3376: } else {
3377: return '';
3378: }
3379: }
3380:
1.112 bowersj2 3381: =pod
3382:
3383: =back
3384:
3385: =head1 Access .tab File Data
3386:
3387: =over 4
3388:
1.648 raeburn 3389: =item * &languageids()
1.112 bowersj2 3390:
3391: returns list of all language ids
3392:
3393: =cut
3394:
1.14 harris41 3395: sub languageids {
1.16 harris41 3396: return sort(keys(%language));
1.14 harris41 3397: }
3398:
1.112 bowersj2 3399: =pod
3400:
1.648 raeburn 3401: =item * &languagedescription()
1.112 bowersj2 3402:
3403: returns description of a specified language id
3404:
3405: =cut
3406:
1.14 harris41 3407: sub languagedescription {
1.125 www 3408: my $code=shift;
3409: return ($supported_language{$code}?'* ':'').
3410: $language{$code}.
1.126 www 3411: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 3412: }
3413:
1.1048 foxr 3414: =pod
3415:
3416: =item * &plainlanguagedescription
3417:
3418: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
3419: and the language character encoding (e.g. ISO) separated by a ' - ' string.
3420:
3421: =cut
3422:
1.145 www 3423: sub plainlanguagedescription {
3424: my $code=shift;
3425: return $language{$code};
3426: }
3427:
1.1048 foxr 3428: =pod
3429:
3430: =item * &supportedlanguagecode
3431:
3432: Returns the supported language code (e.g. sptutf maps to pt) given a language
3433: code.
3434:
3435: =cut
3436:
1.145 www 3437: sub supportedlanguagecode {
3438: my $code=shift;
3439: return $supported_language{$code};
1.97 www 3440: }
3441:
1.112 bowersj2 3442: =pod
3443:
1.1048 foxr 3444: =item * &latexlanguage()
3445:
3446: Given a language key code returns the correspondnig language to use
3447: to select the correct hyphenation on LaTeX printouts. This is undef if there
3448: is no supported hyphenation for the language code.
3449:
3450: =cut
3451:
3452: sub latexlanguage {
3453: my $code = shift;
3454: return $latex_language{$code};
3455: }
3456:
3457: =pod
3458:
3459: =item * &latexhyphenation()
3460:
3461: Same as above but what's supplied is the language as it might be stored
3462: in the metadata.
3463:
3464: =cut
3465:
3466: sub latexhyphenation {
3467: my $key = shift;
3468: return $latex_language_bykey{$key};
3469: }
3470:
3471: =pod
3472:
1.648 raeburn 3473: =item * ©rightids()
1.112 bowersj2 3474:
3475: returns list of all copyrights
3476:
3477: =cut
3478:
3479: sub copyrightids {
3480: return sort(keys(%cprtag));
3481: }
3482:
3483: =pod
3484:
1.648 raeburn 3485: =item * ©rightdescription()
1.112 bowersj2 3486:
3487: returns description of a specified copyright id
3488:
3489: =cut
3490:
3491: sub copyrightdescription {
1.166 www 3492: return &mt($cprtag{shift(@_)});
1.112 bowersj2 3493: }
1.197 matthew 3494:
3495: =pod
3496:
1.648 raeburn 3497: =item * &source_copyrightids()
1.192 taceyjo1 3498:
3499: returns list of all source copyrights
3500:
3501: =cut
3502:
3503: sub source_copyrightids {
3504: return sort(keys(%scprtag));
3505: }
3506:
3507: =pod
3508:
1.648 raeburn 3509: =item * &source_copyrightdescription()
1.192 taceyjo1 3510:
3511: returns description of a specified source copyright id
3512:
3513: =cut
3514:
3515: sub source_copyrightdescription {
3516: return &mt($scprtag{shift(@_)});
3517: }
1.112 bowersj2 3518:
3519: =pod
3520:
1.648 raeburn 3521: =item * &filecategories()
1.112 bowersj2 3522:
3523: returns list of all file categories
3524:
3525: =cut
3526:
3527: sub filecategories {
3528: return sort(keys(%category_extensions));
3529: }
3530:
3531: =pod
3532:
1.648 raeburn 3533: =item * &filecategorytypes()
1.112 bowersj2 3534:
3535: returns list of file types belonging to a given file
3536: category
3537:
3538: =cut
3539:
3540: sub filecategorytypes {
1.356 albertel 3541: my ($cat) = @_;
3542: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 3543: }
3544:
3545: =pod
3546:
1.648 raeburn 3547: =item * &fileembstyle()
1.112 bowersj2 3548:
3549: returns embedding style for a specified file type
3550:
3551: =cut
3552:
3553: sub fileembstyle {
3554: return $fe{lc(shift(@_))};
1.169 www 3555: }
3556:
1.351 www 3557: sub filemimetype {
3558: return $fm{lc(shift(@_))};
3559: }
3560:
1.169 www 3561:
3562: sub filecategoryselect {
3563: my ($name,$value)=@_;
1.189 matthew 3564: return &select_form($value,$name,
1.970 raeburn 3565: {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112 bowersj2 3566: }
3567:
3568: =pod
3569:
1.648 raeburn 3570: =item * &filedescription()
1.112 bowersj2 3571:
3572: returns description for a specified file type
3573:
3574: =cut
3575:
3576: sub filedescription {
1.188 matthew 3577: my $file_description = $fd{lc(shift())};
3578: $file_description =~ s:([\[\]]):~$1:g;
3579: return &mt($file_description);
1.112 bowersj2 3580: }
3581:
3582: =pod
3583:
1.648 raeburn 3584: =item * &filedescriptionex()
1.112 bowersj2 3585:
3586: returns description for a specified file type with
3587: extra formatting
3588:
3589: =cut
3590:
3591: sub filedescriptionex {
3592: my $ex=shift;
1.188 matthew 3593: my $file_description = $fd{lc($ex)};
3594: $file_description =~ s:([\[\]]):~$1:g;
3595: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3596: }
3597:
3598: # End of .tab access
3599: =pod
3600:
3601: =back
3602:
3603: =cut
3604:
3605: # ------------------------------------------------------------------ File Types
3606: sub fileextensions {
3607: return sort(keys(%fe));
3608: }
3609:
1.97 www 3610: # ----------------------------------------------------------- Display Languages
3611: # returns a hash with all desired display languages
3612: #
3613:
3614: sub display_languages {
3615: my %languages=();
1.695 raeburn 3616: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3617: $languages{$lang}=1;
1.97 www 3618: }
3619: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3620: if ($env{'form.displaylanguage'}) {
1.356 albertel 3621: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3622: $languages{$lang}=1;
1.97 www 3623: }
3624: }
3625: return %languages;
1.14 harris41 3626: }
3627:
1.582 albertel 3628: sub languages {
3629: my ($possible_langs) = @_;
1.695 raeburn 3630: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3631: if (!ref($possible_langs)) {
3632: if( wantarray ) {
3633: return @preferred_langs;
3634: } else {
3635: return $preferred_langs[0];
3636: }
3637: }
3638: my %possibilities = map { $_ => 1 } (@$possible_langs);
3639: my @preferred_possibilities;
3640: foreach my $preferred_lang (@preferred_langs) {
3641: if (exists($possibilities{$preferred_lang})) {
3642: push(@preferred_possibilities, $preferred_lang);
3643: }
3644: }
3645: if( wantarray ) {
3646: return @preferred_possibilities;
3647: }
3648: return $preferred_possibilities[0];
3649: }
3650:
1.742 raeburn 3651: sub user_lang {
3652: my ($touname,$toudom,$fromcid) = @_;
3653: my @userlangs;
3654: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3655: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3656: $env{'course.'.$fromcid.'.languages'}));
3657: } else {
3658: my %langhash = &getlangs($touname,$toudom);
3659: if ($langhash{'languages'} ne '') {
3660: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3661: } else {
3662: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3663: if ($domdefs{'lang_def'} ne '') {
3664: @userlangs = ($domdefs{'lang_def'});
3665: }
3666: }
3667: }
3668: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3669: my $user_lh = Apache::localize->get_handle(@languages);
3670: return $user_lh;
3671: }
3672:
3673:
1.112 bowersj2 3674: ###############################################################
3675: ## Student Answer Attempts ##
3676: ###############################################################
3677:
3678: =pod
3679:
3680: =head1 Alternate Problem Views
3681:
3682: =over 4
3683:
1.648 raeburn 3684: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.1075.2.86 raeburn 3685: $getattempt, $regexp, $gradesub, $usec, $identifier)
1.112 bowersj2 3686:
3687: Return string with previous attempt on problem. Arguments:
3688:
3689: =over 4
3690:
3691: =item * $symb: Problem, including path
3692:
3693: =item * $username: username of the desired student
3694:
3695: =item * $domain: domain of the desired student
1.14 harris41 3696:
1.112 bowersj2 3697: =item * $course: Course ID
1.14 harris41 3698:
1.112 bowersj2 3699: =item * $getattempt: Leave blank for all attempts, otherwise put
3700: something
1.14 harris41 3701:
1.112 bowersj2 3702: =item * $regexp: if string matches this regexp, the string will be
3703: sent to $gradesub
1.14 harris41 3704:
1.112 bowersj2 3705: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3706:
1.1075.2.86 raeburn 3707: =item * $usec: section of the desired student
3708:
3709: =item * $identifier: counter for student (multiple students one problem) or
3710: problem (one student; whole sequence).
3711:
1.112 bowersj2 3712: =back
1.14 harris41 3713:
1.112 bowersj2 3714: The output string is a table containing all desired attempts, if any.
1.16 harris41 3715:
1.112 bowersj2 3716: =cut
1.1 albertel 3717:
3718: sub get_previous_attempt {
1.1075.2.86 raeburn 3719: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub,$usec,$identifier)=@_;
1.1 albertel 3720: my $prevattempts='';
1.43 ng 3721: no strict 'refs';
1.1 albertel 3722: if ($symb) {
1.3 albertel 3723: my (%returnhash)=
3724: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3725: if ($returnhash{'version'}) {
3726: my %lasthash=();
3727: my $version;
3728: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1075.2.91 raeburn 3729: foreach my $key (reverse(sort(split(/\:/,$returnhash{$version.':keys'})))) {
3730: if ($key =~ /\.rawrndseed$/) {
3731: my ($id) = ($key =~ /^(.+)\.rawrndseed$/);
3732: $lasthash{$id.'.rndseed'} = $returnhash{$version.':'.$key};
3733: } else {
3734: $lasthash{$key}=$returnhash{$version.':'.$key};
3735: }
1.19 harris41 3736: }
1.1 albertel 3737: }
1.596 albertel 3738: $prevattempts=&start_data_table().&start_data_table_header_row();
3739: $prevattempts.='<th>'.&mt('History').'</th>';
1.1075.2.86 raeburn 3740: my (%typeparts,%lasthidden,%regraded,%hidestatus);
1.945 raeburn 3741: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 3742: foreach my $key (sort(keys(%lasthash))) {
3743: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3744: if ($#parts > 0) {
1.31 albertel 3745: my $data=$parts[-1];
1.989 raeburn 3746: next if ($data eq 'foilorder');
1.31 albertel 3747: pop(@parts);
1.1010 www 3748: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.945 raeburn 3749: if ($data eq 'type') {
3750: unless ($showsurv) {
3751: my $id = join(',',@parts);
3752: $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978 raeburn 3753: if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
3754: $lasthidden{$ign.'.'.$id} = 1;
3755: }
1.945 raeburn 3756: }
1.1075.2.86 raeburn 3757: if ($identifier ne '') {
3758: my $id = join(',',@parts);
3759: if (&Apache::lonnet::EXT("resource.$id.problemstatus",$symb,
3760: $domain,$username,$usec,undef,$course) =~ /^no/) {
3761: $hidestatus{$ign.'.'.$id} = 1;
3762: }
3763: }
3764: } elsif ($data eq 'regrader') {
3765: if (($identifier ne '') && (@parts)) {
3766: my $id = join(',',@parts);
3767: $regraded{$ign.'.'.$id} = 1;
3768: }
1.1010 www 3769: }
1.31 albertel 3770: } else {
1.41 ng 3771: if ($#parts == 0) {
3772: $prevattempts.='<th>'.$parts[0].'</th>';
3773: } else {
3774: $prevattempts.='<th>'.$ign.'</th>';
3775: }
1.31 albertel 3776: }
1.16 harris41 3777: }
1.596 albertel 3778: $prevattempts.=&end_data_table_header_row();
1.40 ng 3779: if ($getattempt eq '') {
1.1075.2.86 raeburn 3780: my (%solved,%resets,%probstatus);
3781: if (($identifier ne '') && (keys(%regraded) > 0)) {
3782: for ($version=1;$version<=$returnhash{'version'};$version++) {
3783: foreach my $id (keys(%regraded)) {
3784: if (($returnhash{$version.':'.$id.'.regrader'}) &&
3785: ($returnhash{$version.':'.$id.'.tries'} eq '') &&
3786: ($returnhash{$version.':'.$id.'.award'} eq '')) {
3787: push(@{$resets{$id}},$version);
3788: }
3789: }
3790: }
3791: }
1.40 ng 3792: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1075.2.86 raeburn 3793: my (@hidden,@unsolved);
1.945 raeburn 3794: if (%typeparts) {
3795: foreach my $id (keys(%typeparts)) {
1.1075.2.86 raeburn 3796: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') ||
3797: ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
1.945 raeburn 3798: push(@hidden,$id);
1.1075.2.86 raeburn 3799: } elsif ($identifier ne '') {
3800: unless (($returnhash{$version.':'.$id.'.type'} eq 'survey') ||
3801: ($returnhash{$version.':'.$id.'.type'} eq 'surveycred') ||
3802: ($hidestatus{$id})) {
3803: next if ((ref($resets{$id}) eq 'ARRAY') && grep(/^\Q$version\E$/,@{$resets{$id}}));
3804: if ($returnhash{$version.':'.$id.'.solved'} eq 'correct_by_student') {
3805: push(@{$solved{$id}},$version);
3806: } elsif (($returnhash{$version.':'.$id.'.solved'} ne '') &&
3807: (ref($solved{$id}) eq 'ARRAY')) {
3808: my $skip;
3809: if (ref($resets{$id}) eq 'ARRAY') {
3810: foreach my $reset (@{$resets{$id}}) {
3811: if ($reset > $solved{$id}[-1]) {
3812: $skip=1;
3813: last;
3814: }
3815: }
3816: }
3817: unless ($skip) {
3818: my ($ign,$partslist) = split(/\./,$id,2);
3819: push(@unsolved,$partslist);
3820: }
3821: }
3822: }
1.945 raeburn 3823: }
3824: }
3825: }
3826: $prevattempts.=&start_data_table_row().
1.1075.2.86 raeburn 3827: '<td>'.&mt('Transaction [_1]',$version);
3828: if (@unsolved) {
3829: $prevattempts .= '<span class="LC_nobreak"><label>'.
3830: '<input type="checkbox" name="HIDE'.$identifier.'" value="'.$version.':'.join('_',@unsolved).'" />'.
3831: &mt('Hide').'</label></span>';
3832: }
3833: $prevattempts .= '</td>';
1.945 raeburn 3834: if (@hidden) {
3835: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3836: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3837: my $hide;
3838: foreach my $id (@hidden) {
3839: if ($key =~ /^\Q$id\E/) {
3840: $hide = 1;
3841: last;
3842: }
3843: }
3844: if ($hide) {
3845: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3846: if (($data eq 'award') || ($data eq 'awarddetail')) {
3847: my $value = &format_previous_attempt_value($key,
3848: $returnhash{$version.':'.$key});
3849: $prevattempts.='<td>'.$value.' </td>';
3850: } else {
3851: $prevattempts.='<td> </td>';
3852: }
3853: } else {
3854: if ($key =~ /\./) {
1.1075.2.91 raeburn 3855: my $value = $returnhash{$version.':'.$key};
3856: if ($key =~ /\.rndseed$/) {
3857: my ($id) = ($key =~ /^(.+)\.rndseed$/);
3858: if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
3859: $value = $returnhash{$version.':'.$id.'.rawrndseed'};
3860: }
3861: }
3862: $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
3863: ' </td>';
1.945 raeburn 3864: } else {
3865: $prevattempts.='<td> </td>';
3866: }
3867: }
3868: }
3869: } else {
3870: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3871: next if ($key =~ /\.foilorder$/);
1.1075.2.91 raeburn 3872: my $value = $returnhash{$version.':'.$key};
3873: if ($key =~ /\.rndseed$/) {
3874: my ($id) = ($key =~ /^(.+)\.rndseed$/);
3875: if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
3876: $value = $returnhash{$version.':'.$id.'.rawrndseed'};
3877: }
3878: }
3879: $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
3880: ' </td>';
1.945 raeburn 3881: }
3882: }
3883: $prevattempts.=&end_data_table_row();
1.40 ng 3884: }
1.1 albertel 3885: }
1.945 raeburn 3886: my @currhidden = keys(%lasthidden);
1.596 albertel 3887: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3888: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3889: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3890: if (%typeparts) {
3891: my $hidden;
3892: foreach my $id (@currhidden) {
3893: if ($key =~ /^\Q$id\E/) {
3894: $hidden = 1;
3895: last;
3896: }
3897: }
3898: if ($hidden) {
3899: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3900: if (($data eq 'award') || ($data eq 'awarddetail')) {
3901: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3902: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3903: $value = &$gradesub($value);
3904: }
3905: $prevattempts.='<td>'.$value.' </td>';
3906: } else {
3907: $prevattempts.='<td> </td>';
3908: }
3909: } else {
3910: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3911: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3912: $value = &$gradesub($value);
3913: }
3914: $prevattempts.='<td>'.$value.' </td>';
3915: }
3916: } else {
3917: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3918: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3919: $value = &$gradesub($value);
3920: }
3921: $prevattempts.='<td>'.$value.' </td>';
3922: }
1.16 harris41 3923: }
1.596 albertel 3924: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3925: } else {
1.596 albertel 3926: $prevattempts=
3927: &start_data_table().&start_data_table_row().
3928: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3929: &end_data_table_row().&end_data_table();
1.1 albertel 3930: }
3931: } else {
1.596 albertel 3932: $prevattempts=
3933: &start_data_table().&start_data_table_row().
3934: '<td>'.&mt('No data.').'</td>'.
3935: &end_data_table_row().&end_data_table();
1.1 albertel 3936: }
1.10 albertel 3937: }
3938:
1.581 albertel 3939: sub format_previous_attempt_value {
3940: my ($key,$value) = @_;
1.1011 www 3941: if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.581 albertel 3942: $value = &Apache::lonlocal::locallocaltime($value);
3943: } elsif (ref($value) eq 'ARRAY') {
3944: $value = '('.join(', ', @{ $value }).')';
1.988 raeburn 3945: } elsif ($key =~ /answerstring$/) {
3946: my %answers = &Apache::lonnet::str2hash($value);
3947: my @anskeys = sort(keys(%answers));
3948: if (@anskeys == 1) {
3949: my $answer = $answers{$anskeys[0]};
1.1001 raeburn 3950: if ($answer =~ m{\0}) {
3951: $answer =~ s{\0}{,}g;
1.988 raeburn 3952: }
3953: my $tag_internal_answer_name = 'INTERNAL';
3954: if ($anskeys[0] eq $tag_internal_answer_name) {
3955: $value = $answer;
3956: } else {
3957: $value = $anskeys[0].'='.$answer;
3958: }
3959: } else {
3960: foreach my $ans (@anskeys) {
3961: my $answer = $answers{$ans};
1.1001 raeburn 3962: if ($answer =~ m{\0}) {
3963: $answer =~ s{\0}{,}g;
1.988 raeburn 3964: }
3965: $value .= $ans.'='.$answer.'<br />';;
3966: }
3967: }
1.581 albertel 3968: } else {
3969: $value = &unescape($value);
3970: }
3971: return $value;
3972: }
3973:
3974:
1.107 albertel 3975: sub relative_to_absolute {
3976: my ($url,$output)=@_;
3977: my $parser=HTML::TokeParser->new(\$output);
3978: my $token;
3979: my $thisdir=$url;
3980: my @rlinks=();
3981: while ($token=$parser->get_token) {
3982: if ($token->[0] eq 'S') {
3983: if ($token->[1] eq 'a') {
3984: if ($token->[2]->{'href'}) {
3985: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3986: }
3987: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3988: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3989: } elsif ($token->[1] eq 'base') {
3990: $thisdir=$token->[2]->{'href'};
3991: }
3992: }
3993: }
3994: $thisdir=~s-/[^/]*$--;
1.356 albertel 3995: foreach my $link (@rlinks) {
1.726 raeburn 3996: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3997: ($link=~/^\//) ||
3998: ($link=~/^javascript:/i) ||
3999: ($link=~/^mailto:/i) ||
4000: ($link=~/^\#/)) {
4001: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
4002: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 4003: }
4004: }
4005: # -------------------------------------------------- Deal with Applet codebases
4006: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
4007: return $output;
4008: }
4009:
1.112 bowersj2 4010: =pod
4011:
1.648 raeburn 4012: =item * &get_student_view()
1.112 bowersj2 4013:
4014: show a snapshot of what student was looking at
4015:
4016: =cut
4017:
1.10 albertel 4018: sub get_student_view {
1.186 albertel 4019: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 4020: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 4021: my (%form);
1.10 albertel 4022: my @elements=('symb','courseid','domain','username');
4023: foreach my $element (@elements) {
1.186 albertel 4024: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 4025: }
1.186 albertel 4026: if (defined($moreenv)) {
4027: %form=(%form,%{$moreenv});
4028: }
1.236 albertel 4029: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 4030: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 4031: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 4032: $userview=~s/\<body[^\>]*\>//gi;
4033: $userview=~s/\<\/body\>//gi;
4034: $userview=~s/\<html\>//gi;
4035: $userview=~s/\<\/html\>//gi;
4036: $userview=~s/\<head\>//gi;
4037: $userview=~s/\<\/head\>//gi;
4038: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 4039: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 4040: if (wantarray) {
4041: return ($userview,$response);
4042: } else {
4043: return $userview;
4044: }
4045: }
4046:
4047: sub get_student_view_with_retries {
4048: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
4049:
4050: my $ok = 0; # True if we got a good response.
4051: my $content;
4052: my $response;
4053:
4054: # Try to get the student_view done. within the retries count:
4055:
4056: do {
4057: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
4058: $ok = $response->is_success;
4059: if (!$ok) {
4060: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
4061: }
4062: $retries--;
4063: } while (!$ok && ($retries > 0));
4064:
4065: if (!$ok) {
4066: $content = ''; # On error return an empty content.
4067: }
1.651 www 4068: if (wantarray) {
4069: return ($content, $response);
4070: } else {
4071: return $content;
4072: }
1.11 albertel 4073: }
4074:
1.112 bowersj2 4075: =pod
4076:
1.648 raeburn 4077: =item * &get_student_answers()
1.112 bowersj2 4078:
4079: show a snapshot of how student was answering problem
4080:
4081: =cut
4082:
1.11 albertel 4083: sub get_student_answers {
1.100 sakharuk 4084: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 4085: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 4086: my (%moreenv);
1.11 albertel 4087: my @elements=('symb','courseid','domain','username');
4088: foreach my $element (@elements) {
1.186 albertel 4089: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 4090: }
1.186 albertel 4091: $moreenv{'grade_target'}='answer';
4092: %moreenv=(%form,%moreenv);
1.497 raeburn 4093: $feedurl = &Apache::lonnet::clutter($feedurl);
4094: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 4095: return $userview;
1.1 albertel 4096: }
1.116 albertel 4097:
4098: =pod
4099:
4100: =item * &submlink()
4101:
1.242 albertel 4102: Inputs: $text $uname $udom $symb $target
1.116 albertel 4103:
4104: Returns: A link to grades.pm such as to see the SUBM view of a student
4105:
4106: =cut
4107:
4108: ###############################################
4109: sub submlink {
1.242 albertel 4110: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 4111: if (!($uname && $udom)) {
4112: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 4113: &Apache::lonnet::whichuser($symb);
1.116 albertel 4114: if (!$symb) { $symb=$cursymb; }
4115: }
1.254 matthew 4116: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 4117: $symb=&escape($symb);
1.960 bisitz 4118: if ($target) { $target=" target=\"$target\""; }
4119: return
4120: '<a href="/adm/grades?command=submission'.
4121: '&symb='.$symb.
4122: '&student='.$uname.
4123: '&userdom='.$udom.'"'.
4124: $target.'>'.$text.'</a>';
1.242 albertel 4125: }
4126: ##############################################
4127:
4128: =pod
4129:
4130: =item * &pgrdlink()
4131:
4132: Inputs: $text $uname $udom $symb $target
4133:
4134: Returns: A link to grades.pm such as to see the PGRD view of a student
4135:
4136: =cut
4137:
4138: ###############################################
4139: sub pgrdlink {
4140: my $link=&submlink(@_);
4141: $link=~s/(&command=submission)/$1&showgrading=yes/;
4142: return $link;
4143: }
4144: ##############################################
4145:
4146: =pod
4147:
4148: =item * &pprmlink()
4149:
4150: Inputs: $text $uname $udom $symb $target
4151:
4152: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 4153: student and a specific resource
1.242 albertel 4154:
4155: =cut
4156:
4157: ###############################################
4158: sub pprmlink {
4159: my ($text,$uname,$udom,$symb,$target)=@_;
4160: if (!($uname && $udom)) {
4161: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 4162: &Apache::lonnet::whichuser($symb);
1.242 albertel 4163: if (!$symb) { $symb=$cursymb; }
4164: }
1.254 matthew 4165: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 4166: $symb=&escape($symb);
1.242 albertel 4167: if ($target) { $target="target=\"$target\""; }
1.595 albertel 4168: return '<a href="/adm/parmset?command=set&'.
4169: 'symb='.$symb.'&uname='.$uname.
4170: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 4171: }
4172: ##############################################
1.37 matthew 4173:
1.112 bowersj2 4174: =pod
4175:
4176: =back
4177:
4178: =cut
4179:
1.37 matthew 4180: ###############################################
1.51 www 4181:
4182:
4183: sub timehash {
1.687 raeburn 4184: my ($thistime) = @_;
4185: my $timezone = &Apache::lonlocal::gettimezone();
4186: my $dt = DateTime->from_epoch(epoch => $thistime)
4187: ->set_time_zone($timezone);
4188: my $wday = $dt->day_of_week();
4189: if ($wday == 7) { $wday = 0; }
4190: return ( 'second' => $dt->second(),
4191: 'minute' => $dt->minute(),
4192: 'hour' => $dt->hour(),
4193: 'day' => $dt->day_of_month(),
4194: 'month' => $dt->month(),
4195: 'year' => $dt->year(),
4196: 'weekday' => $wday,
4197: 'dayyear' => $dt->day_of_year(),
4198: 'dlsav' => $dt->is_dst() );
1.51 www 4199: }
4200:
1.370 www 4201: sub utc_string {
4202: my ($date)=@_;
1.371 www 4203: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 4204: }
4205:
1.51 www 4206: sub maketime {
4207: my %th=@_;
1.687 raeburn 4208: my ($epoch_time,$timezone,$dt);
4209: $timezone = &Apache::lonlocal::gettimezone();
4210: eval {
4211: $dt = DateTime->new( year => $th{'year'},
4212: month => $th{'month'},
4213: day => $th{'day'},
4214: hour => $th{'hour'},
4215: minute => $th{'minute'},
4216: second => $th{'second'},
4217: time_zone => $timezone,
4218: );
4219: };
4220: if (!$@) {
4221: $epoch_time = $dt->epoch;
4222: if ($epoch_time) {
4223: return $epoch_time;
4224: }
4225: }
1.51 www 4226: return POSIX::mktime(
4227: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 4228: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 4229: }
4230:
4231: #########################################
1.51 www 4232:
4233: sub findallcourses {
1.482 raeburn 4234: my ($roles,$uname,$udom) = @_;
1.355 albertel 4235: my %roles;
4236: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 4237: my %courses;
1.51 www 4238: my $now=time;
1.482 raeburn 4239: if (!defined($uname)) {
4240: $uname = $env{'user.name'};
4241: }
4242: if (!defined($udom)) {
4243: $udom = $env{'user.domain'};
4244: }
4245: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.1073 raeburn 4246: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
1.482 raeburn 4247: if (!%roles) {
4248: %roles = (
4249: cc => 1,
1.907 raeburn 4250: co => 1,
1.482 raeburn 4251: in => 1,
4252: ep => 1,
4253: ta => 1,
4254: cr => 1,
4255: st => 1,
4256: );
4257: }
4258: foreach my $entry (keys(%roleshash)) {
4259: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
4260: if ($trole =~ /^cr/) {
4261: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
4262: } else {
4263: next if (!exists($roles{$trole}));
4264: }
4265: if ($tend) {
4266: next if ($tend < $now);
4267: }
4268: if ($tstart) {
4269: next if ($tstart > $now);
4270: }
1.1058 raeburn 4271: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482 raeburn 4272: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058 raeburn 4273: my $value = $trole.'/'.$cdom.'/';
1.482 raeburn 4274: if ($secpart eq '') {
4275: ($cnum,$role) = split(/_/,$cnumpart);
4276: $sec = 'none';
1.1058 raeburn 4277: $value .= $cnum.'/';
1.482 raeburn 4278: } else {
4279: $cnum = $cnumpart;
4280: ($sec,$role) = split(/_/,$secpart);
1.1058 raeburn 4281: $value .= $cnum.'/'.$sec;
4282: }
4283: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
4284: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
4285: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
4286: }
4287: } else {
4288: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490 raeburn 4289: }
1.482 raeburn 4290: }
4291: } else {
4292: foreach my $key (keys(%env)) {
1.483 albertel 4293: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
4294: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 4295: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
4296: next if ($role eq 'ca' || $role eq 'aa');
4297: next if (%roles && !exists($roles{$role}));
4298: my ($starttime,$endtime)=split(/\./,$env{$key});
4299: my $active=1;
4300: if ($starttime) {
4301: if ($now<$starttime) { $active=0; }
4302: }
4303: if ($endtime) {
4304: if ($now>$endtime) { $active=0; }
4305: }
4306: if ($active) {
1.1058 raeburn 4307: my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482 raeburn 4308: if ($sec eq '') {
4309: $sec = 'none';
1.1058 raeburn 4310: } else {
4311: $value .= $sec;
4312: }
4313: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
4314: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
4315: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
4316: }
4317: } else {
4318: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482 raeburn 4319: }
1.474 raeburn 4320: }
4321: }
1.51 www 4322: }
4323: }
1.474 raeburn 4324: return %courses;
1.51 www 4325: }
1.37 matthew 4326:
1.54 www 4327: ###############################################
1.474 raeburn 4328:
4329: sub blockcheck {
1.1075.2.73 raeburn 4330: my ($setters,$activity,$uname,$udom,$url,$is_course) = @_;
1.490 raeburn 4331:
1.1075.2.73 raeburn 4332: if (defined($udom) && defined($uname)) {
4333: # If uname and udom are for a course, check for blocks in the course.
4334: if (($is_course) || (&Apache::lonnet::is_course($udom,$uname))) {
4335: my ($startblock,$endblock,$triggerblock) =
4336: &get_blocks($setters,$activity,$udom,$uname,$url);
4337: return ($startblock,$endblock,$triggerblock);
4338: }
4339: } else {
1.490 raeburn 4340: $udom = $env{'user.domain'};
4341: $uname = $env{'user.name'};
4342: }
4343:
1.502 raeburn 4344: my $startblock = 0;
4345: my $endblock = 0;
1.1062 raeburn 4346: my $triggerblock = '';
1.482 raeburn 4347: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 4348:
1.490 raeburn 4349: # If uname is for a user, and activity is course-specific, i.e.,
4350: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 4351:
1.490 raeburn 4352: if (($activity eq 'boards' || $activity eq 'chat' ||
1.1075.2.73 raeburn 4353: $activity eq 'groups' || $activity eq 'printout') &&
4354: ($env{'request.course.id'})) {
1.490 raeburn 4355: foreach my $key (keys(%live_courses)) {
4356: if ($key ne $env{'request.course.id'}) {
4357: delete($live_courses{$key});
4358: }
4359: }
4360: }
4361:
4362: my $otheruser = 0;
4363: my %own_courses;
4364: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
4365: # Resource belongs to user other than current user.
4366: $otheruser = 1;
4367: # Gather courses for current user
4368: %own_courses =
4369: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
4370: }
4371:
4372: # Gather active course roles - course coordinator, instructor,
4373: # exam proctor, ta, student, or custom role.
1.474 raeburn 4374:
4375: foreach my $course (keys(%live_courses)) {
1.482 raeburn 4376: my ($cdom,$cnum);
4377: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
4378: $cdom = $env{'course.'.$course.'.domain'};
4379: $cnum = $env{'course.'.$course.'.num'};
4380: } else {
1.490 raeburn 4381: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 4382: }
4383: my $no_ownblock = 0;
4384: my $no_userblock = 0;
1.533 raeburn 4385: if ($otheruser && $activity ne 'com') {
1.490 raeburn 4386: # Check if current user has 'evb' priv for this
4387: if (defined($own_courses{$course})) {
4388: foreach my $sec (keys(%{$own_courses{$course}})) {
4389: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
4390: if ($sec ne 'none') {
4391: $checkrole .= '/'.$sec;
4392: }
4393: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4394: $no_ownblock = 1;
4395: last;
4396: }
4397: }
4398: }
4399: # if they have 'evb' priv and are currently not playing student
4400: next if (($no_ownblock) &&
4401: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
4402: }
1.474 raeburn 4403: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 4404: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 4405: if ($sec ne 'none') {
1.482 raeburn 4406: $checkrole .= '/'.$sec;
1.474 raeburn 4407: }
1.490 raeburn 4408: if ($otheruser) {
4409: # Resource belongs to user other than current user.
4410: # Assemble privs for that user, and check for 'evb' priv.
1.1058 raeburn 4411: my (%allroles,%userroles);
4412: if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
4413: foreach my $entry (@{$live_courses{$course}{$sec}}) {
4414: my ($trole,$tdom,$tnum,$tsec);
4415: if ($entry =~ /^cr/) {
4416: ($trole,$tdom,$tnum,$tsec) =
4417: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
4418: } else {
4419: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
4420: }
4421: my ($spec,$area,$trest);
4422: $area = '/'.$tdom.'/'.$tnum;
4423: $trest = $tnum;
4424: if ($tsec ne '') {
4425: $area .= '/'.$tsec;
4426: $trest .= '/'.$tsec;
4427: }
4428: $spec = $trole.'.'.$area;
4429: if ($trole =~ /^cr/) {
4430: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
4431: $tdom,$spec,$trest,$area);
4432: } else {
4433: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
4434: $tdom,$spec,$trest,$area);
4435: }
4436: }
4437: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
4438: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
4439: if ($1) {
4440: $no_userblock = 1;
4441: last;
4442: }
1.486 raeburn 4443: }
4444: }
1.490 raeburn 4445: } else {
4446: # Resource belongs to current user
4447: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 4448: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4449: $no_ownblock = 1;
4450: last;
4451: }
1.474 raeburn 4452: }
4453: }
4454: # if they have the evb priv and are currently not playing student
1.482 raeburn 4455: next if (($no_ownblock) &&
1.491 albertel 4456: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 4457: next if ($no_userblock);
1.474 raeburn 4458:
1.866 kalberla 4459: # Retrieve blocking times and identity of locker for course
1.490 raeburn 4460: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 4461:
1.1062 raeburn 4462: my ($start,$end,$trigger) =
4463: &get_blocks($setters,$activity,$cdom,$cnum,$url);
1.502 raeburn 4464: if (($start != 0) &&
4465: (($startblock == 0) || ($startblock > $start))) {
4466: $startblock = $start;
1.1062 raeburn 4467: if ($trigger ne '') {
4468: $triggerblock = $trigger;
4469: }
1.502 raeburn 4470: }
4471: if (($end != 0) &&
4472: (($endblock == 0) || ($endblock < $end))) {
4473: $endblock = $end;
1.1062 raeburn 4474: if ($trigger ne '') {
4475: $triggerblock = $trigger;
4476: }
1.502 raeburn 4477: }
1.490 raeburn 4478: }
1.1062 raeburn 4479: return ($startblock,$endblock,$triggerblock);
1.490 raeburn 4480: }
4481:
4482: sub get_blocks {
1.1062 raeburn 4483: my ($setters,$activity,$cdom,$cnum,$url) = @_;
1.490 raeburn 4484: my $startblock = 0;
4485: my $endblock = 0;
1.1062 raeburn 4486: my $triggerblock = '';
1.490 raeburn 4487: my $course = $cdom.'_'.$cnum;
4488: $setters->{$course} = {};
4489: $setters->{$course}{'staff'} = [];
4490: $setters->{$course}{'times'} = [];
1.1062 raeburn 4491: $setters->{$course}{'triggers'} = [];
4492: my (@blockers,%triggered);
4493: my $now = time;
4494: my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
4495: if ($activity eq 'docs') {
4496: @blockers = &Apache::lonnet::has_comm_blocking('bre',undef,$url,\%commblocks);
4497: foreach my $block (@blockers) {
4498: if ($block =~ /^firstaccess____(.+)$/) {
4499: my $item = $1;
4500: my $type = 'map';
4501: my $timersymb = $item;
4502: if ($item eq 'course') {
4503: $type = 'course';
4504: } elsif ($item =~ /___\d+___/) {
4505: $type = 'resource';
4506: } else {
4507: $timersymb = &Apache::lonnet::symbread($item);
4508: }
4509: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
4510: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
4511: $triggered{$block} = {
4512: start => $start,
4513: end => $end,
4514: type => $type,
4515: };
4516: }
4517: }
4518: } else {
4519: foreach my $block (keys(%commblocks)) {
4520: if ($block =~ m/^(\d+)____(\d+)$/) {
4521: my ($start,$end) = ($1,$2);
4522: if ($start <= time && $end >= time) {
4523: if (ref($commblocks{$block}) eq 'HASH') {
4524: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
4525: if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
4526: unless(grep(/^\Q$block\E$/,@blockers)) {
4527: push(@blockers,$block);
4528: }
4529: }
4530: }
4531: }
4532: }
4533: } elsif ($block =~ /^firstaccess____(.+)$/) {
4534: my $item = $1;
4535: my $timersymb = $item;
4536: my $type = 'map';
4537: if ($item eq 'course') {
4538: $type = 'course';
4539: } elsif ($item =~ /___\d+___/) {
4540: $type = 'resource';
4541: } else {
4542: $timersymb = &Apache::lonnet::symbread($item);
4543: }
4544: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
4545: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
4546: if ($start && $end) {
4547: if (($start <= time) && ($end >= time)) {
4548: unless (grep(/^\Q$block\E$/,@blockers)) {
4549: push(@blockers,$block);
4550: $triggered{$block} = {
4551: start => $start,
4552: end => $end,
4553: type => $type,
4554: };
4555: }
4556: }
1.490 raeburn 4557: }
1.1062 raeburn 4558: }
4559: }
4560: }
4561: foreach my $blocker (@blockers) {
4562: my ($staff_name,$staff_dom,$title,$blocks) =
4563: &parse_block_record($commblocks{$blocker});
4564: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
4565: my ($start,$end,$triggertype);
4566: if ($blocker =~ m/^(\d+)____(\d+)$/) {
4567: ($start,$end) = ($1,$2);
4568: } elsif (ref($triggered{$blocker}) eq 'HASH') {
4569: $start = $triggered{$blocker}{'start'};
4570: $end = $triggered{$blocker}{'end'};
4571: $triggertype = $triggered{$blocker}{'type'};
4572: }
4573: if ($start) {
4574: push(@{$$setters{$course}{'times'}}, [$start,$end]);
4575: if ($triggertype) {
4576: push(@{$$setters{$course}{'triggers'}},$triggertype);
4577: } else {
4578: push(@{$$setters{$course}{'triggers'}},0);
4579: }
4580: if ( ($startblock == 0) || ($startblock > $start) ) {
4581: $startblock = $start;
4582: if ($triggertype) {
4583: $triggerblock = $blocker;
1.474 raeburn 4584: }
4585: }
1.1062 raeburn 4586: if ( ($endblock == 0) || ($endblock < $end) ) {
4587: $endblock = $end;
4588: if ($triggertype) {
4589: $triggerblock = $blocker;
4590: }
4591: }
1.474 raeburn 4592: }
4593: }
1.1062 raeburn 4594: return ($startblock,$endblock,$triggerblock);
1.474 raeburn 4595: }
4596:
4597: sub parse_block_record {
4598: my ($record) = @_;
4599: my ($setuname,$setudom,$title,$blocks);
4600: if (ref($record) eq 'HASH') {
4601: ($setuname,$setudom) = split(/:/,$record->{'setter'});
4602: $title = &unescape($record->{'event'});
4603: $blocks = $record->{'blocks'};
4604: } else {
4605: my @data = split(/:/,$record,3);
4606: if (scalar(@data) eq 2) {
4607: $title = $data[1];
4608: ($setuname,$setudom) = split(/@/,$data[0]);
4609: } else {
4610: ($setuname,$setudom,$title) = @data;
4611: }
4612: $blocks = { 'com' => 'on' };
4613: }
4614: return ($setuname,$setudom,$title,$blocks);
4615: }
4616:
1.854 kalberla 4617: sub blocking_status {
1.1075.2.73 raeburn 4618: my ($activity,$uname,$udom,$url,$is_course) = @_;
1.1061 raeburn 4619: my %setters;
1.890 droeschl 4620:
1.1061 raeburn 4621: # check for active blocking
1.1062 raeburn 4622: my ($startblock,$endblock,$triggerblock) =
1.1075.2.73 raeburn 4623: &blockcheck(\%setters,$activity,$uname,$udom,$url,$is_course);
1.1062 raeburn 4624: my $blocked = 0;
4625: if ($startblock && $endblock) {
4626: $blocked = 1;
4627: }
1.890 droeschl 4628:
1.1061 raeburn 4629: # caller just wants to know whether a block is active
4630: if (!wantarray) { return $blocked; }
4631:
4632: # build a link to a popup window containing the details
4633: my $querystring = "?activity=$activity";
4634: # $uname and $udom decide whose portfolio the user is trying to look at
1.1075.2.97! raeburn 4635: if (($activity eq 'port') || ($activity eq 'passwd')) {
! 4636: $querystring .= "&udom=$udom" if ($udom =~ /^$match_domain$/);
! 4637: $querystring .= "&uname=$uname" if ($uname =~ /^$match_username$/);
1.1062 raeburn 4638: } elsif ($activity eq 'docs') {
4639: $querystring .= '&url='.&HTML::Entities::encode($url,'&"');
4640: }
1.1061 raeburn 4641:
4642: my $output .= <<'END_MYBLOCK';
4643: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
4644: var options = "width=" + w + ",height=" + h + ",";
4645: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
4646: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
4647: var newWin = window.open(url, wdwName, options);
4648: newWin.focus();
4649: }
1.890 droeschl 4650: END_MYBLOCK
1.854 kalberla 4651:
1.1061 raeburn 4652: $output = Apache::lonhtmlcommon::scripttag($output);
1.890 droeschl 4653:
1.1061 raeburn 4654: my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062 raeburn 4655: my $text = &mt('Communication Blocked');
1.1075.2.93 raeburn 4656: my $class = 'LC_comblock';
1.1062 raeburn 4657: if ($activity eq 'docs') {
4658: $text = &mt('Content Access Blocked');
1.1075.2.93 raeburn 4659: $class = '';
1.1063 raeburn 4660: } elsif ($activity eq 'printout') {
4661: $text = &mt('Printing Blocked');
1.1075.2.97! raeburn 4662: } elsif ($activity eq 'passwd') {
! 4663: $text = &mt('Password Changing Blocked');
1.1062 raeburn 4664: }
1.1061 raeburn 4665: $output .= <<"END_BLOCK";
1.1075.2.93 raeburn 4666: <div class='$class'>
1.869 kalberla 4667: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4668: title='$text'>
4669: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 4670: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4671: title='$text'>$text</a>
1.867 kalberla 4672: </div>
4673:
4674: END_BLOCK
1.474 raeburn 4675:
1.1061 raeburn 4676: return ($blocked, $output);
1.854 kalberla 4677: }
1.490 raeburn 4678:
1.60 matthew 4679: ###############################################
4680:
1.682 raeburn 4681: sub check_ip_acc {
4682: my ($acc)=@_;
4683: &Apache::lonxml::debug("acc is $acc");
4684: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
4685: return 1;
4686: }
4687: my $allowed=0;
4688: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
4689:
4690: my $name;
4691: foreach my $pattern (split(',',$acc)) {
4692: $pattern =~ s/^\s*//;
4693: $pattern =~ s/\s*$//;
4694: if ($pattern =~ /\*$/) {
4695: #35.8.*
4696: $pattern=~s/\*//;
4697: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4698: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
4699: #35.8.3.[34-56]
4700: my $low=$2;
4701: my $high=$3;
4702: $pattern=$1;
4703: if ($ip =~ /^\Q$pattern\E/) {
4704: my $last=(split(/\./,$ip))[3];
4705: if ($last <=$high && $last >=$low) { $allowed=1; }
4706: }
4707: } elsif ($pattern =~ /^\*/) {
4708: #*.msu.edu
4709: $pattern=~s/\*//;
4710: if (!defined($name)) {
4711: use Socket;
4712: my $netaddr=inet_aton($ip);
4713: ($name)=gethostbyaddr($netaddr,AF_INET);
4714: }
4715: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4716: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
4717: #127.0.0.1
4718: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4719: } else {
4720: #some.name.com
4721: if (!defined($name)) {
4722: use Socket;
4723: my $netaddr=inet_aton($ip);
4724: ($name)=gethostbyaddr($netaddr,AF_INET);
4725: }
4726: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4727: }
4728: if ($allowed) { last; }
4729: }
4730: return $allowed;
4731: }
4732:
4733: ###############################################
4734:
1.60 matthew 4735: =pod
4736:
1.112 bowersj2 4737: =head1 Domain Template Functions
4738:
4739: =over 4
4740:
4741: =item * &determinedomain()
1.60 matthew 4742:
4743: Inputs: $domain (usually will be undef)
4744:
1.63 www 4745: Returns: Determines which domain should be used for designs
1.60 matthew 4746:
4747: =cut
1.54 www 4748:
1.60 matthew 4749: ###############################################
1.63 www 4750: sub determinedomain {
4751: my $domain=shift;
1.531 albertel 4752: if (! $domain) {
1.60 matthew 4753: # Determine domain if we have not been given one
1.893 raeburn 4754: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 4755: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
4756: if ($env{'request.role.domain'}) {
4757: $domain=$env{'request.role.domain'};
1.60 matthew 4758: }
4759: }
1.63 www 4760: return $domain;
4761: }
4762: ###############################################
1.517 raeburn 4763:
1.518 albertel 4764: sub devalidate_domconfig_cache {
4765: my ($udom)=@_;
4766: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
4767: }
4768:
4769: # ---------------------- Get domain configuration for a domain
4770: sub get_domainconf {
4771: my ($udom) = @_;
4772: my $cachetime=1800;
4773: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
4774: if (defined($cached)) { return %{$result}; }
4775:
4776: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 4777: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 4778: my (%designhash,%legacy);
1.518 albertel 4779: if (keys(%domconfig) > 0) {
4780: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 4781: if (keys(%{$domconfig{'login'}})) {
4782: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 4783: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.1075.2.87 raeburn 4784: if (($key eq 'loginvia') || ($key eq 'headtag')) {
4785: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
4786: foreach my $hostname (keys(%{$domconfig{'login'}{$key}})) {
4787: if (ref($domconfig{'login'}{$key}{$hostname}) eq 'HASH') {
4788: if ($key eq 'loginvia') {
4789: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
4790: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
4791: $designhash{$udom.'.login.loginvia'} = $server;
4792: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
4793: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
4794: } else {
4795: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
4796: }
1.948 raeburn 4797: }
1.1075.2.87 raeburn 4798: } elsif ($key eq 'headtag') {
4799: if ($domconfig{'login'}{'headtag'}{$hostname}{'url'}) {
4800: $designhash{$udom.'.login.headtag_'.$hostname} = $domconfig{'login'}{'headtag'}{$hostname}{'url'};
1.948 raeburn 4801: }
1.946 raeburn 4802: }
1.1075.2.87 raeburn 4803: if ($domconfig{'login'}{$key}{$hostname}{'exempt'}) {
4804: $designhash{$udom.'.login.'.$key.'_exempt_'.$hostname} = $domconfig{'login'}{$key}{$hostname}{'exempt'};
4805: }
1.946 raeburn 4806: }
4807: }
4808: }
4809: } else {
4810: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
4811: $designhash{$udom.'.login.'.$key.'_'.$img} =
4812: $domconfig{'login'}{$key}{$img};
4813: }
1.699 raeburn 4814: }
4815: } else {
4816: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
4817: }
1.632 raeburn 4818: }
4819: } else {
4820: $legacy{'login'} = 1;
1.518 albertel 4821: }
1.632 raeburn 4822: } else {
4823: $legacy{'login'} = 1;
1.518 albertel 4824: }
4825: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 4826: if (keys(%{$domconfig{'rolecolors'}})) {
4827: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
4828: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
4829: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
4830: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
4831: }
1.518 albertel 4832: }
4833: }
1.632 raeburn 4834: } else {
4835: $legacy{'rolecolors'} = 1;
1.518 albertel 4836: }
1.632 raeburn 4837: } else {
4838: $legacy{'rolecolors'} = 1;
1.518 albertel 4839: }
1.948 raeburn 4840: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
4841: if ($domconfig{'autoenroll'}{'co-owners'}) {
4842: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
4843: }
4844: }
1.632 raeburn 4845: if (keys(%legacy) > 0) {
4846: my %legacyhash = &get_legacy_domconf($udom);
4847: foreach my $item (keys(%legacyhash)) {
4848: if ($item =~ /^\Q$udom\E\.login/) {
4849: if ($legacy{'login'}) {
4850: $designhash{$item} = $legacyhash{$item};
4851: }
4852: } else {
4853: if ($legacy{'rolecolors'}) {
4854: $designhash{$item} = $legacyhash{$item};
4855: }
1.518 albertel 4856: }
4857: }
4858: }
1.632 raeburn 4859: } else {
4860: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4861: }
4862: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4863: $cachetime);
4864: return %designhash;
4865: }
4866:
1.632 raeburn 4867: sub get_legacy_domconf {
4868: my ($udom) = @_;
4869: my %legacyhash;
4870: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4871: my $designfile = $designdir.'/'.$udom.'.tab';
4872: if (-e $designfile) {
4873: if ( open (my $fh,"<$designfile") ) {
4874: while (my $line = <$fh>) {
4875: next if ($line =~ /^\#/);
4876: chomp($line);
4877: my ($key,$val)=(split(/\=/,$line));
4878: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4879: }
4880: close($fh);
4881: }
4882: }
1.1026 raeburn 4883: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632 raeburn 4884: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4885: }
4886: return %legacyhash;
4887: }
4888:
1.63 www 4889: =pod
4890:
1.112 bowersj2 4891: =item * &domainlogo()
1.63 www 4892:
4893: Inputs: $domain (usually will be undef)
4894:
4895: Returns: A link to a domain logo, if the domain logo exists.
4896: If the domain logo does not exist, a description of the domain.
4897:
4898: =cut
1.112 bowersj2 4899:
1.63 www 4900: ###############################################
4901: sub domainlogo {
1.517 raeburn 4902: my $domain = &determinedomain(shift);
1.518 albertel 4903: my %designhash = &get_domainconf($domain);
1.517 raeburn 4904: # See if there is a logo
4905: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4906: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4907: if ($imgsrc =~ m{^/(adm|res)/}) {
4908: if ($imgsrc =~ m{^/res/}) {
4909: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4910: &Apache::lonnet::repcopy($local_name);
4911: }
4912: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4913: }
4914: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4915: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4916: return &Apache::lonnet::domain($domain,'description');
1.59 www 4917: } else {
1.60 matthew 4918: return '';
1.59 www 4919: }
4920: }
1.63 www 4921: ##############################################
4922:
4923: =pod
4924:
1.112 bowersj2 4925: =item * &designparm()
1.63 www 4926:
4927: Inputs: $which parameter; $domain (usually will be undef)
4928:
4929: Returns: value of designparamter $which
4930:
4931: =cut
1.112 bowersj2 4932:
1.397 albertel 4933:
1.400 albertel 4934: ##############################################
1.397 albertel 4935: sub designparm {
4936: my ($which,$domain)=@_;
4937: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 4938: return $env{'environment.color.'.$which};
1.96 www 4939: }
1.63 www 4940: $domain=&determinedomain($domain);
1.1016 raeburn 4941: my %domdesign;
4942: unless ($domain eq 'public') {
4943: %domdesign = &get_domainconf($domain);
4944: }
1.520 raeburn 4945: my $output;
1.517 raeburn 4946: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 4947: $output = $domdesign{$domain.'.'.$which};
1.63 www 4948: } else {
1.520 raeburn 4949: $output = $defaultdesign{$which};
4950: }
4951: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4952: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4953: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 4954: if ($output =~ m{^/res/}) {
4955: my $local_name = &Apache::lonnet::filelocation('',$output);
4956: &Apache::lonnet::repcopy($local_name);
4957: }
1.520 raeburn 4958: $output = &lonhttpdurl($output);
4959: }
1.63 www 4960: }
1.520 raeburn 4961: return $output;
1.63 www 4962: }
1.59 www 4963:
1.822 bisitz 4964: ##############################################
4965: =pod
4966:
1.832 bisitz 4967: =item * &authorspace()
4968:
1.1028 raeburn 4969: Inputs: $url (usually will be undef).
1.832 bisitz 4970:
1.1075.2.40 raeburn 4971: Returns: Path to Authoring Space containing the resource or
1.1028 raeburn 4972: directory being viewed (or for which action is being taken).
4973: If $url is provided, and begins /priv/<domain>/<uname>
4974: the path will be that portion of the $context argument.
4975: Otherwise the path will be for the author space of the current
4976: user when the current role is author, or for that of the
4977: co-author/assistant co-author space when the current role
4978: is co-author or assistant co-author.
1.832 bisitz 4979:
4980: =cut
4981:
4982: sub authorspace {
1.1028 raeburn 4983: my ($url) = @_;
4984: if ($url ne '') {
4985: if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
4986: return $1;
4987: }
4988: }
1.832 bisitz 4989: my $caname = '';
1.1024 www 4990: my $cadom = '';
1.1028 raeburn 4991: if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024 www 4992: ($cadom,$caname) =
1.832 bisitz 4993: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028 raeburn 4994: } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832 bisitz 4995: $caname = $env{'user.name'};
1.1024 www 4996: $cadom = $env{'user.domain'};
1.832 bisitz 4997: }
1.1028 raeburn 4998: if (($caname ne '') && ($cadom ne '')) {
4999: return "/priv/$cadom/$caname/";
5000: }
5001: return;
1.832 bisitz 5002: }
5003:
5004: ##############################################
5005: =pod
5006:
1.822 bisitz 5007: =item * &head_subbox()
5008:
5009: Inputs: $content (contains HTML code with page functions, etc.)
5010:
5011: Returns: HTML div with $content
5012: To be included in page header
5013:
5014: =cut
5015:
5016: sub head_subbox {
5017: my ($content)=@_;
5018: my $output =
1.993 raeburn 5019: '<div class="LC_head_subbox">'
1.822 bisitz 5020: .$content
5021: .'</div>'
5022: }
5023:
5024: ##############################################
5025: =pod
5026:
5027: =item * &CSTR_pageheader()
5028:
1.1026 raeburn 5029: Input: (optional) filename from which breadcrumb trail is built.
5030: In most cases no input as needed, as $env{'request.filename'}
5031: is appropriate for use in building the breadcrumb trail.
1.822 bisitz 5032:
5033: Returns: HTML div with CSTR path and recent box
1.1075.2.40 raeburn 5034: To be included on Authoring Space pages
1.822 bisitz 5035:
5036: =cut
5037:
5038: sub CSTR_pageheader {
1.1026 raeburn 5039: my ($trailfile) = @_;
5040: if ($trailfile eq '') {
5041: $trailfile = $env{'request.filename'};
5042: }
5043:
5044: # this is for resources; directories have customtitle, and crumbs
5045: # and select recent are created in lonpubdir.pm
5046:
5047: my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022 www 5048: my ($udom,$uname,$thisdisfn)=
1.1075.2.29 raeburn 5049: ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)(?:|/(.*))$});
1.1026 raeburn 5050: my $formaction = "/priv/$udom/$uname/$thisdisfn";
5051: $formaction =~ s{/+}{/}g;
1.822 bisitz 5052:
5053: my $parentpath = '';
5054: my $lastitem = '';
5055: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
5056: $parentpath = $1;
5057: $lastitem = $2;
5058: } else {
5059: $lastitem = $thisdisfn;
5060: }
1.921 bisitz 5061:
5062: my $output =
1.822 bisitz 5063: '<div>'
5064: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
1.1075.2.40 raeburn 5065: .'<b>'.&mt('Authoring Space:').'</b> '
1.822 bisitz 5066: .'<form name="dirs" method="post" action="'.$formaction
1.921 bisitz 5067: .'" target="_top">' #FIXME lonpubdir: target="_parent"
1.1024 www 5068: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv/'.$udom,undef,undef);
1.921 bisitz 5069:
5070: if ($lastitem) {
5071: $output .=
5072: '<span class="LC_filename">'
5073: .$lastitem
5074: .'</span>';
5075: }
5076: $output .=
5077: '<br />'
1.822 bisitz 5078: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
5079: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
5080: .'</form>'
5081: .&Apache::lonmenu::constspaceform()
5082: .'</div>';
1.921 bisitz 5083:
5084: return $output;
1.822 bisitz 5085: }
5086:
1.60 matthew 5087: ###############################################
5088: ###############################################
5089:
5090: =pod
5091:
1.112 bowersj2 5092: =back
5093:
1.549 albertel 5094: =head1 HTML Helpers
1.112 bowersj2 5095:
5096: =over 4
5097:
5098: =item * &bodytag()
1.60 matthew 5099:
5100: Returns a uniform header for LON-CAPA web pages.
5101:
5102: Inputs:
5103:
1.112 bowersj2 5104: =over 4
5105:
5106: =item * $title, A title to be displayed on the page.
5107:
5108: =item * $function, the current role (can be undef).
5109:
5110: =item * $addentries, extra parameters for the <body> tag.
5111:
5112: =item * $bodyonly, if defined, only return the <body> tag.
5113:
5114: =item * $domain, if defined, force a given domain.
5115:
5116: =item * $forcereg, if page should register as content page (relevant for
1.86 www 5117: text interface only)
1.60 matthew 5118:
1.814 bisitz 5119: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
5120: navigational links
1.317 albertel 5121:
1.338 albertel 5122: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
5123:
1.1075.2.12 raeburn 5124: =item * $no_inline_link, if true and in remote mode, don't show the
5125: 'Switch To Inline Menu' link
5126:
1.460 albertel 5127: =item * $args, optional argument valid values are
5128: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 5129: inherit_jsmath -> when creating popup window in a page,
5130: should it have jsmath forced on by the
5131: current page
1.460 albertel 5132:
1.1075.2.15 raeburn 5133: =item * $advtoolsref, optional argument, ref to an array containing
5134: inlineremote items to be added in "Functions" menu below
5135: breadcrumbs.
5136:
1.112 bowersj2 5137: =back
5138:
1.60 matthew 5139: Returns: A uniform header for LON-CAPA web pages.
5140: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
5141: If $bodyonly is undef or zero, an html string containing a <body> tag and
5142: other decorations will be returned.
5143:
5144: =cut
5145:
1.54 www 5146: sub bodytag {
1.831 bisitz 5147: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1075.2.15 raeburn 5148: $no_nav_bar,$bgcolor,$no_inline_link,$args,$advtoolsref)=@_;
1.339 albertel 5149:
1.954 raeburn 5150: my $public;
5151: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
5152: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
5153: $public = 1;
5154: }
1.460 albertel 5155: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1075.2.52 raeburn 5156: my $httphost = $args->{'use_absolute'};
1.339 albertel 5157:
1.183 matthew 5158: $function = &get_users_function() if (!$function);
1.339 albertel 5159: my $img = &designparm($function.'.img',$domain);
5160: my $font = &designparm($function.'.font',$domain);
5161: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
5162:
1.803 bisitz 5163: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 5164: 'bgcolor' => $pgbg,
1.339 albertel 5165: 'text' => $font,
5166: 'alink' => &designparm($function.'.alink',$domain),
5167: 'vlink' => &designparm($function.'.vlink',$domain),
5168: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 5169: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 5170:
1.63 www 5171: # role and realm
1.1075.2.68 raeburn 5172: my ($role,$realm) = split(m{\./},$env{'request.role'},2);
5173: if ($realm) {
5174: $realm = '/'.$realm;
5175: }
1.378 raeburn 5176: if ($role eq 'ca') {
1.479 albertel 5177: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 5178: $realm = &plainname($rname,$rdom);
1.378 raeburn 5179: }
1.55 www 5180: # realm
1.258 albertel 5181: if ($env{'request.course.id'}) {
1.378 raeburn 5182: if ($env{'request.role'} !~ /^cr/) {
5183: $role = &Apache::lonnet::plaintext($role,&course_type());
5184: }
1.898 raeburn 5185: if ($env{'request.course.sec'}) {
5186: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
5187: }
1.359 albertel 5188: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 5189: } else {
5190: $role = &Apache::lonnet::plaintext($role);
1.54 www 5191: }
1.433 albertel 5192:
1.359 albertel 5193: if (!$realm) { $realm=' '; }
1.330 albertel 5194:
1.438 albertel 5195: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 5196:
1.101 www 5197: # construct main body tag
1.359 albertel 5198: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 5199: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 5200:
1.1075.2.38 raeburn 5201: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
5202:
5203: if (($bodyonly) || ($no_nav_bar) || ($env{'form.inhibitmenu'} eq 'yes')) {
1.60 matthew 5204: return $bodytag;
1.1075.2.38 raeburn 5205: }
1.359 albertel 5206:
1.954 raeburn 5207: if ($public) {
1.433 albertel 5208: undef($role);
5209: }
1.359 albertel 5210:
1.762 bisitz 5211: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 5212: #
5213: # Extra info if you are the DC
5214: my $dc_info = '';
5215: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
5216: $env{'course.'.$env{'request.course.id'}.
5217: '.domain'}.'/'})) {
5218: my $cid = $env{'request.course.id'};
1.917 raeburn 5219: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 5220: $dc_info =~ s/\s+$//;
1.359 albertel 5221: }
5222:
1.898 raeburn 5223: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.903 droeschl 5224:
1.1075.2.13 raeburn 5225: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
5226:
1.1075.2.38 raeburn 5227:
5228:
1.1075.2.21 raeburn 5229: my $funclist;
5230: if (($env{'environment.remote'} eq 'on') && ($env{'request.state'} ne 'construct')) {
1.1075.2.52 raeburn 5231: $bodytag .= Apache::lonhtmlcommon::scripttag(Apache::lonmenu::utilityfunctions($httphost), 'start')."\n".
1.1075.2.21 raeburn 5232: Apache::lonmenu::serverform();
5233: my $forbodytag;
5234: &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
5235: $forcereg,$args->{'group'},
5236: $args->{'bread_crumbs'},
5237: $advtoolsref,'',\$forbodytag);
5238: unless (ref($args->{'bread_crumbs'}) eq 'ARRAY') {
5239: $funclist = $forbodytag;
5240: }
5241: } else {
1.903 droeschl 5242:
5243: # if ($env{'request.state'} eq 'construct') {
5244: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
5245: # }
5246:
1.1075.2.38 raeburn 5247: $bodytag .= Apache::lonhtmlcommon::scripttag(
1.1075.2.52 raeburn 5248: Apache::lonmenu::utilityfunctions($httphost), 'start');
1.359 albertel 5249:
1.1075.2.38 raeburn 5250: my ($left,$right) = Apache::lonmenu::primary_menu();
1.1075.2.2 raeburn 5251:
1.916 droeschl 5252: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.1075.2.22 raeburn 5253: if ($dc_info) {
5254: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
1.1075.2.1 raeburn 5255: }
1.1075.2.38 raeburn 5256: $bodytag .= qq|<div id="LC_nav_bar">$left $role<br />
1.1075.2.22 raeburn 5257: <em>$realm</em> $dc_info</div>|;
1.903 droeschl 5258: return $bodytag;
5259: }
1.894 droeschl 5260:
1.927 raeburn 5261: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
1.1075.2.38 raeburn 5262: $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
1.927 raeburn 5263: }
1.916 droeschl 5264:
1.1075.2.38 raeburn 5265: $bodytag .= $right;
1.852 droeschl 5266:
1.917 raeburn 5267: if ($dc_info) {
5268: $dc_info = &dc_courseid_toggle($dc_info);
5269: }
5270: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 5271:
1.1075.2.61 raeburn 5272: #if directed to not display the secondary menu, don't.
5273: if ($args->{'no_secondary_menu'}) {
5274: return $bodytag;
5275: }
1.903 droeschl 5276: #don't show menus for public users
1.954 raeburn 5277: if (!$public){
1.1075.2.52 raeburn 5278: $bodytag .= Apache::lonmenu::secondary_menu($httphost);
1.903 droeschl 5279: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 5280: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
5281: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 5282: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.920 raeburn 5283: $args->{'bread_crumbs'});
5284: } elsif ($forcereg) {
1.1075.2.22 raeburn 5285: $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
5286: $args->{'group'});
1.1075.2.15 raeburn 5287: } else {
1.1075.2.21 raeburn 5288: my $forbodytag;
5289: &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
5290: $forcereg,$args->{'group'},
5291: $args->{'bread_crumbs'},
5292: $advtoolsref,'',\$forbodytag);
5293: unless (ref($args->{'bread_crumbs'}) eq 'ARRAY') {
5294: $bodytag .= $forbodytag;
5295: }
1.920 raeburn 5296: }
1.903 droeschl 5297: }else{
5298: # this is to seperate menu from content when there's no secondary
5299: # menu. Especially needed for public accessible ressources.
5300: $bodytag .= '<hr style="clear:both" />';
5301: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 5302: }
1.903 droeschl 5303:
1.235 raeburn 5304: return $bodytag;
1.1075.2.12 raeburn 5305: }
5306:
5307: #
5308: # Top frame rendering, Remote is up
5309: #
5310:
5311: my $imgsrc = $img;
5312: if ($img =~ /^\/adm/) {
5313: $imgsrc = &lonhttpdurl($img);
5314: }
5315: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
5316:
1.1075.2.60 raeburn 5317: my $help=($no_inline_link?''
5318: :&Apache::loncommon::top_nav_help('Help'));
5319:
1.1075.2.12 raeburn 5320: # Explicit link to get inline menu
5321: my $menu= ($no_inline_link?''
5322: :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
5323:
5324: if ($dc_info) {
5325: $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
5326: }
5327:
1.1075.2.38 raeburn 5328: my $name = &plainname($env{'user.name'},$env{'user.domain'});
5329: unless ($public) {
5330: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'},
5331: undef,'LC_menubuttons_link');
5332: }
5333:
1.1075.2.12 raeburn 5334: unless ($env{'form.inhibitmenu'}) {
5335: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>
1.1075.2.38 raeburn 5336: <ol class="LC_primary_menu LC_floatright LC_right">
1.1075.2.60 raeburn 5337: <li>$help</li>
1.1075.2.12 raeburn 5338: <li>$menu</li>
5339: </ol><div id="LC_realm"> $realm $dc_info</div>|;
5340: }
1.1075.2.13 raeburn 5341: if ($env{'request.state'} eq 'construct') {
5342: if (!$public){
5343: if ($env{'request.state'} eq 'construct') {
5344: $funclist = &Apache::lonhtmlcommon::scripttag(
1.1075.2.52 raeburn 5345: &Apache::lonmenu::utilityfunctions($httphost), 'start').
1.1075.2.13 raeburn 5346: &Apache::lonhtmlcommon::scripttag('','end').
5347: &Apache::lonmenu::innerregister($forcereg,
5348: $args->{'bread_crumbs'});
5349: }
5350: }
5351: }
1.1075.2.21 raeburn 5352: return $bodytag."\n".$funclist;
1.182 matthew 5353: }
5354:
1.917 raeburn 5355: sub dc_courseid_toggle {
5356: my ($dc_info) = @_;
1.980 raeburn 5357: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069 raeburn 5358: '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917 raeburn 5359: &mt('(More ...)').'</a></span>'.
5360: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
5361: }
5362:
1.330 albertel 5363: sub make_attr_string {
5364: my ($register,$attr_ref) = @_;
5365:
5366: if ($attr_ref && !ref($attr_ref)) {
5367: die("addentries Must be a hash ref ".
5368: join(':',caller(1))." ".
5369: join(':',caller(0))." ");
5370: }
5371:
5372: if ($register) {
1.339 albertel 5373: my ($on_load,$on_unload);
5374: foreach my $key (keys(%{$attr_ref})) {
5375: if (lc($key) eq 'onload') {
5376: $on_load.=$attr_ref->{$key}.';';
5377: delete($attr_ref->{$key});
5378:
5379: } elsif (lc($key) eq 'onunload') {
5380: $on_unload.=$attr_ref->{$key}.';';
5381: delete($attr_ref->{$key});
5382: }
5383: }
1.1075.2.12 raeburn 5384: if ($env{'environment.remote'} eq 'on') {
5385: $attr_ref->{'onload'} =
5386: &Apache::lonmenu::loadevents(). $on_load;
5387: $attr_ref->{'onunload'}=
5388: &Apache::lonmenu::unloadevents().$on_unload;
5389: } else {
5390: $attr_ref->{'onload'} = $on_load;
5391: $attr_ref->{'onunload'}= $on_unload;
5392: }
1.330 albertel 5393: }
1.339 albertel 5394:
1.330 albertel 5395: my $attr_string;
1.1075.2.56 raeburn 5396: foreach my $attr (sort(keys(%$attr_ref))) {
1.330 albertel 5397: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
5398: }
5399: return $attr_string;
5400: }
5401:
5402:
1.182 matthew 5403: ###############################################
1.251 albertel 5404: ###############################################
5405:
5406: =pod
5407:
5408: =item * &endbodytag()
5409:
5410: Returns a uniform footer for LON-CAPA web pages.
5411:
1.635 raeburn 5412: Inputs: 1 - optional reference to an args hash
5413: If in the hash, key for noredirectlink has a value which evaluates to true,
5414: a 'Continue' link is not displayed if the page contains an
5415: internal redirect in the <head></head> section,
5416: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 5417:
5418: =cut
5419:
5420: sub endbodytag {
1.635 raeburn 5421: my ($args) = @_;
1.1075.2.6 raeburn 5422: my $endbodytag;
5423: unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
5424: $endbodytag='</body>';
5425: }
1.269 albertel 5426: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 5427: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 5428: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
5429: $endbodytag=
5430: "<br /><a href=\"$env{'internal.head.redirect'}\">".
5431: &mt('Continue').'</a>'.
5432: $endbodytag;
5433: }
1.315 albertel 5434: }
1.251 albertel 5435: return $endbodytag;
5436: }
5437:
1.352 albertel 5438: =pod
5439:
5440: =item * &standard_css()
5441:
5442: Returns a style sheet
5443:
5444: Inputs: (all optional)
5445: domain -> force to color decorate a page for a specific
5446: domain
5447: function -> force usage of a specific rolish color scheme
5448: bgcolor -> override the default page bgcolor
5449:
5450: =cut
5451:
1.343 albertel 5452: sub standard_css {
1.345 albertel 5453: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 5454: $function = &get_users_function() if (!$function);
5455: my $img = &designparm($function.'.img', $domain);
5456: my $tabbg = &designparm($function.'.tabbg', $domain);
5457: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 5458: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 5459: #second colour for later usage
1.345 albertel 5460: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 5461: my $pgbg_or_bgcolor =
5462: $bgcolor ||
1.352 albertel 5463: &designparm($function.'.pgbg', $domain);
1.382 albertel 5464: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 5465: my $alink = &designparm($function.'.alink', $domain);
5466: my $vlink = &designparm($function.'.vlink', $domain);
5467: my $link = &designparm($function.'.link', $domain);
5468:
1.602 albertel 5469: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 5470: my $mono = 'monospace';
1.850 bisitz 5471: my $data_table_head = $sidebg;
5472: my $data_table_light = '#FAFAFA';
1.1060 bisitz 5473: my $data_table_dark = '#E0E0E0';
1.470 banghart 5474: my $data_table_darker = '#CCCCCC';
1.349 albertel 5475: my $data_table_highlight = '#FFFF00';
1.352 albertel 5476: my $mail_new = '#FFBB77';
5477: my $mail_new_hover = '#DD9955';
5478: my $mail_read = '#BBBB77';
5479: my $mail_read_hover = '#999944';
5480: my $mail_replied = '#AAAA88';
5481: my $mail_replied_hover = '#888855';
5482: my $mail_other = '#99BBBB';
5483: my $mail_other_hover = '#669999';
1.391 albertel 5484: my $table_header = '#DDDDDD';
1.489 raeburn 5485: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 5486: my $lg_border_color = '#C8C8C8';
1.952 onken 5487: my $button_hover = '#BF2317';
1.392 albertel 5488:
1.608 albertel 5489: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 5490: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
5491: : '0 3px 0 4px';
1.448 albertel 5492:
1.523 albertel 5493:
1.343 albertel 5494: return <<END;
1.947 droeschl 5495:
5496: /* needed for iframe to allow 100% height in FF */
5497: body, html {
5498: margin: 0;
5499: padding: 0 0.5%;
5500: height: 99%; /* to avoid scrollbars */
5501: }
5502:
1.795 www 5503: body {
1.911 bisitz 5504: font-family: $sans;
5505: line-height:130%;
5506: font-size:0.83em;
5507: color:$font;
1.795 www 5508: }
5509:
1.959 onken 5510: a:focus,
5511: a:focus img {
1.795 www 5512: color: red;
5513: }
1.698 harmsja 5514:
1.911 bisitz 5515: form, .inline {
5516: display: inline;
1.795 www 5517: }
1.721 harmsja 5518:
1.795 www 5519: .LC_right {
1.911 bisitz 5520: text-align:right;
1.795 www 5521: }
5522:
5523: .LC_middle {
1.911 bisitz 5524: vertical-align:middle;
1.795 www 5525: }
1.721 harmsja 5526:
1.1075.2.38 raeburn 5527: .LC_floatleft {
5528: float: left;
5529: }
5530:
5531: .LC_floatright {
5532: float: right;
5533: }
5534:
1.911 bisitz 5535: .LC_400Box {
5536: width:400px;
5537: }
1.721 harmsja 5538:
1.947 droeschl 5539: .LC_iframecontainer {
5540: width: 98%;
5541: margin: 0;
5542: position: fixed;
5543: top: 8.5em;
5544: bottom: 0;
5545: }
5546:
5547: .LC_iframecontainer iframe{
5548: border: none;
5549: width: 100%;
5550: height: 100%;
5551: }
5552:
1.778 bisitz 5553: .LC_filename {
5554: font-family: $mono;
5555: white-space:pre;
1.921 bisitz 5556: font-size: 120%;
1.778 bisitz 5557: }
5558:
5559: .LC_fileicon {
5560: border: none;
5561: height: 1.3em;
5562: vertical-align: text-bottom;
5563: margin-right: 0.3em;
5564: text-decoration:none;
5565: }
5566:
1.1008 www 5567: .LC_setting {
5568: text-decoration:underline;
5569: }
5570:
1.350 albertel 5571: .LC_error {
5572: color: red;
5573: }
1.795 www 5574:
1.1075.2.15 raeburn 5575: .LC_warning {
5576: color: darkorange;
5577: }
5578:
1.457 albertel 5579: .LC_diff_removed {
1.733 bisitz 5580: color: red;
1.394 albertel 5581: }
1.532 albertel 5582:
5583: .LC_info,
1.457 albertel 5584: .LC_success,
5585: .LC_diff_added {
1.350 albertel 5586: color: green;
5587: }
1.795 www 5588:
1.802 bisitz 5589: div.LC_confirm_box {
5590: background-color: #FAFAFA;
5591: border: 1px solid $lg_border_color;
5592: margin-right: 0;
5593: padding: 5px;
5594: }
5595:
5596: div.LC_confirm_box .LC_error img,
5597: div.LC_confirm_box .LC_success img {
5598: vertical-align: middle;
5599: }
5600:
1.440 albertel 5601: .LC_icon {
1.771 droeschl 5602: border: none;
1.790 droeschl 5603: vertical-align: middle;
1.771 droeschl 5604: }
5605:
1.543 albertel 5606: .LC_docs_spacer {
5607: width: 25px;
5608: height: 1px;
1.771 droeschl 5609: border: none;
1.543 albertel 5610: }
1.346 albertel 5611:
1.532 albertel 5612: .LC_internal_info {
1.735 bisitz 5613: color: #999999;
1.532 albertel 5614: }
5615:
1.794 www 5616: .LC_discussion {
1.1050 www 5617: background: $data_table_dark;
1.911 bisitz 5618: border: 1px solid black;
5619: margin: 2px;
1.794 www 5620: }
5621:
5622: .LC_disc_action_left {
1.1050 www 5623: background: $sidebg;
1.911 bisitz 5624: text-align: left;
1.1050 www 5625: padding: 4px;
5626: margin: 2px;
1.794 www 5627: }
5628:
5629: .LC_disc_action_right {
1.1050 www 5630: background: $sidebg;
1.911 bisitz 5631: text-align: right;
1.1050 www 5632: padding: 4px;
5633: margin: 2px;
1.794 www 5634: }
5635:
5636: .LC_disc_new_item {
1.911 bisitz 5637: background: white;
5638: border: 2px solid red;
1.1050 www 5639: margin: 4px;
5640: padding: 4px;
1.794 www 5641: }
5642:
5643: .LC_disc_old_item {
1.911 bisitz 5644: background: white;
1.1050 www 5645: margin: 4px;
5646: padding: 4px;
1.794 www 5647: }
5648:
1.458 albertel 5649: table.LC_pastsubmission {
5650: border: 1px solid black;
5651: margin: 2px;
5652: }
5653:
1.924 bisitz 5654: table#LC_menubuttons {
1.345 albertel 5655: width: 100%;
5656: background: $pgbg;
1.392 albertel 5657: border: 2px;
1.402 albertel 5658: border-collapse: separate;
1.803 bisitz 5659: padding: 0;
1.345 albertel 5660: }
1.392 albertel 5661:
1.801 tempelho 5662: table#LC_title_bar a {
5663: color: $fontmenu;
5664: }
1.836 bisitz 5665:
1.807 droeschl 5666: table#LC_title_bar {
1.819 tempelho 5667: clear: both;
1.836 bisitz 5668: display: none;
1.807 droeschl 5669: }
5670:
1.795 www 5671: table#LC_title_bar,
1.933 droeschl 5672: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 5673: table#LC_title_bar.LC_with_remote {
1.359 albertel 5674: width: 100%;
1.392 albertel 5675: border-color: $pgbg;
5676: border-style: solid;
5677: border-width: $border;
1.379 albertel 5678: background: $pgbg;
1.801 tempelho 5679: color: $fontmenu;
1.392 albertel 5680: border-collapse: collapse;
1.803 bisitz 5681: padding: 0;
1.819 tempelho 5682: margin: 0;
1.359 albertel 5683: }
1.795 www 5684:
1.933 droeschl 5685: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 5686: margin: 0;
5687: padding: 0;
1.933 droeschl 5688: position: relative;
5689: list-style: none;
1.913 droeschl 5690: }
1.933 droeschl 5691: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 5692: display: inline;
5693: }
1.933 droeschl 5694:
5695: .LC_breadcrumb_tools_navigation {
1.913 droeschl 5696: padding: 0;
1.933 droeschl 5697: margin: 0;
5698: float: left;
1.913 droeschl 5699: }
1.933 droeschl 5700: .LC_breadcrumb_tools_tools {
5701: padding: 0;
5702: margin: 0;
1.913 droeschl 5703: float: right;
5704: }
5705:
1.359 albertel 5706: table#LC_title_bar td {
5707: background: $tabbg;
5708: }
1.795 www 5709:
1.911 bisitz 5710: table#LC_menubuttons img {
1.803 bisitz 5711: border: none;
1.346 albertel 5712: }
1.795 www 5713:
1.842 droeschl 5714: .LC_breadcrumbs_component {
1.911 bisitz 5715: float: right;
5716: margin: 0 1em;
1.357 albertel 5717: }
1.842 droeschl 5718: .LC_breadcrumbs_component img {
1.911 bisitz 5719: vertical-align: middle;
1.777 tempelho 5720: }
1.795 www 5721:
1.383 albertel 5722: td.LC_table_cell_checkbox {
5723: text-align: center;
5724: }
1.795 www 5725:
5726: .LC_fontsize_small {
1.911 bisitz 5727: font-size: 70%;
1.705 tempelho 5728: }
5729:
1.844 bisitz 5730: #LC_breadcrumbs {
1.911 bisitz 5731: clear:both;
5732: background: $sidebg;
5733: border-bottom: 1px solid $lg_border_color;
5734: line-height: 2.5em;
1.933 droeschl 5735: overflow: hidden;
1.911 bisitz 5736: margin: 0;
5737: padding: 0;
1.995 raeburn 5738: text-align: left;
1.819 tempelho 5739: }
1.862 bisitz 5740:
1.1075.2.16 raeburn 5741: .LC_head_subbox, .LC_actionbox {
1.911 bisitz 5742: clear:both;
5743: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 5744: border: 1px solid $sidebg;
1.1075.2.16 raeburn 5745: margin: 0 0 10px 0;
1.966 bisitz 5746: padding: 3px;
1.995 raeburn 5747: text-align: left;
1.822 bisitz 5748: }
5749:
1.795 www 5750: .LC_fontsize_medium {
1.911 bisitz 5751: font-size: 85%;
1.705 tempelho 5752: }
5753:
1.795 www 5754: .LC_fontsize_large {
1.911 bisitz 5755: font-size: 120%;
1.705 tempelho 5756: }
5757:
1.346 albertel 5758: .LC_menubuttons_inline_text {
5759: color: $font;
1.698 harmsja 5760: font-size: 90%;
1.701 harmsja 5761: padding-left:3px;
1.346 albertel 5762: }
5763:
1.934 droeschl 5764: .LC_menubuttons_inline_text img{
5765: vertical-align: middle;
5766: }
5767:
1.1051 www 5768: li.LC_menubuttons_inline_text img {
1.951 onken 5769: cursor:pointer;
1.1002 droeschl 5770: text-decoration: none;
1.951 onken 5771: }
5772:
1.526 www 5773: .LC_menubuttons_link {
5774: text-decoration: none;
5775: }
1.795 www 5776:
1.522 albertel 5777: .LC_menubuttons_category {
1.521 www 5778: color: $font;
1.526 www 5779: background: $pgbg;
1.521 www 5780: font-size: larger;
5781: font-weight: bold;
5782: }
5783:
1.346 albertel 5784: td.LC_menubuttons_text {
1.911 bisitz 5785: color: $font;
1.346 albertel 5786: }
1.706 harmsja 5787:
1.346 albertel 5788: .LC_current_location {
5789: background: $tabbg;
5790: }
1.795 www 5791:
1.938 bisitz 5792: table.LC_data_table {
1.347 albertel 5793: border: 1px solid #000000;
1.402 albertel 5794: border-collapse: separate;
1.426 albertel 5795: border-spacing: 1px;
1.610 albertel 5796: background: $pgbg;
1.347 albertel 5797: }
1.795 www 5798:
1.422 albertel 5799: .LC_data_table_dense {
5800: font-size: small;
5801: }
1.795 www 5802:
1.507 raeburn 5803: table.LC_nested_outer {
5804: border: 1px solid #000000;
1.589 raeburn 5805: border-collapse: collapse;
1.803 bisitz 5806: border-spacing: 0;
1.507 raeburn 5807: width: 100%;
5808: }
1.795 www 5809:
1.879 raeburn 5810: table.LC_innerpickbox,
1.507 raeburn 5811: table.LC_nested {
1.803 bisitz 5812: border: none;
1.589 raeburn 5813: border-collapse: collapse;
1.803 bisitz 5814: border-spacing: 0;
1.507 raeburn 5815: width: 100%;
5816: }
1.795 www 5817:
1.911 bisitz 5818: table.LC_data_table tr th,
5819: table.LC_calendar tr th,
1.879 raeburn 5820: table.LC_prior_tries tr th,
5821: table.LC_innerpickbox tr th {
1.349 albertel 5822: font-weight: bold;
5823: background-color: $data_table_head;
1.801 tempelho 5824: color:$fontmenu;
1.701 harmsja 5825: font-size:90%;
1.347 albertel 5826: }
1.795 www 5827:
1.879 raeburn 5828: table.LC_innerpickbox tr th,
5829: table.LC_innerpickbox tr td {
5830: vertical-align: top;
5831: }
5832:
1.711 raeburn 5833: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 5834: background-color: #CCCCCC;
1.711 raeburn 5835: font-weight: bold;
5836: text-align: left;
5837: }
1.795 www 5838:
1.912 bisitz 5839: table.LC_data_table tr.LC_odd_row > td {
5840: background-color: $data_table_light;
5841: padding: 2px;
5842: vertical-align: top;
5843: }
5844:
1.809 bisitz 5845: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 5846: background-color: $data_table_light;
1.912 bisitz 5847: vertical-align: top;
5848: }
5849:
5850: table.LC_data_table tr.LC_even_row > td {
5851: background-color: $data_table_dark;
1.425 albertel 5852: padding: 2px;
1.900 bisitz 5853: vertical-align: top;
1.347 albertel 5854: }
1.795 www 5855:
1.809 bisitz 5856: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 5857: background-color: $data_table_dark;
1.900 bisitz 5858: vertical-align: top;
1.347 albertel 5859: }
1.795 www 5860:
1.425 albertel 5861: table.LC_data_table tr.LC_data_table_highlight td {
5862: background-color: $data_table_darker;
5863: }
1.795 www 5864:
1.639 raeburn 5865: table.LC_data_table tr td.LC_leftcol_header {
5866: background-color: $data_table_head;
5867: font-weight: bold;
5868: }
1.795 www 5869:
1.451 albertel 5870: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5871: table.LC_nested tr.LC_empty_row td {
1.421 albertel 5872: font-weight: bold;
5873: font-style: italic;
5874: text-align: center;
5875: padding: 8px;
1.347 albertel 5876: }
1.795 www 5877:
1.1075.2.30 raeburn 5878: table.LC_data_table tr.LC_empty_row td,
5879: table.LC_data_table tr.LC_footer_row td {
1.940 bisitz 5880: background-color: $sidebg;
5881: }
5882:
5883: table.LC_nested tr.LC_empty_row td {
5884: background-color: #FFFFFF;
5885: }
5886:
1.890 droeschl 5887: table.LC_caption {
5888: }
5889:
1.507 raeburn 5890: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5891: padding: 4ex
5892: }
1.795 www 5893:
1.507 raeburn 5894: table.LC_nested_outer tr th {
5895: font-weight: bold;
1.801 tempelho 5896: color:$fontmenu;
1.507 raeburn 5897: background-color: $data_table_head;
1.701 harmsja 5898: font-size: small;
1.507 raeburn 5899: border-bottom: 1px solid #000000;
5900: }
1.795 www 5901:
1.507 raeburn 5902: table.LC_nested_outer tr td.LC_subheader {
5903: background-color: $data_table_head;
5904: font-weight: bold;
5905: font-size: small;
5906: border-bottom: 1px solid #000000;
5907: text-align: right;
1.451 albertel 5908: }
1.795 www 5909:
1.507 raeburn 5910: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5911: background-color: #CCCCCC;
1.451 albertel 5912: font-weight: bold;
5913: font-size: small;
1.507 raeburn 5914: text-align: center;
5915: }
1.795 www 5916:
1.589 raeburn 5917: table.LC_nested tr.LC_info_row td.LC_left_item,
5918: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5919: text-align: left;
1.451 albertel 5920: }
1.795 www 5921:
1.507 raeburn 5922: table.LC_nested td {
1.735 bisitz 5923: background-color: #FFFFFF;
1.451 albertel 5924: font-size: small;
1.507 raeburn 5925: }
1.795 www 5926:
1.507 raeburn 5927: table.LC_nested_outer tr th.LC_right_item,
5928: table.LC_nested tr.LC_info_row td.LC_right_item,
5929: table.LC_nested tr.LC_odd_row td.LC_right_item,
5930: table.LC_nested tr td.LC_right_item {
1.451 albertel 5931: text-align: right;
5932: }
5933:
1.507 raeburn 5934: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5935: background-color: #EEEEEE;
1.451 albertel 5936: }
5937:
1.473 raeburn 5938: table.LC_createuser {
5939: }
5940:
5941: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5942: font-size: small;
1.473 raeburn 5943: }
5944:
5945: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5946: background-color: #CCCCCC;
1.473 raeburn 5947: font-weight: bold;
5948: text-align: center;
5949: }
5950:
1.349 albertel 5951: table.LC_calendar {
5952: border: 1px solid #000000;
5953: border-collapse: collapse;
1.917 raeburn 5954: width: 98%;
1.349 albertel 5955: }
1.795 www 5956:
1.349 albertel 5957: table.LC_calendar_pickdate {
5958: font-size: xx-small;
5959: }
1.795 www 5960:
1.349 albertel 5961: table.LC_calendar tr td {
5962: border: 1px solid #000000;
5963: vertical-align: top;
1.917 raeburn 5964: width: 14%;
1.349 albertel 5965: }
1.795 www 5966:
1.349 albertel 5967: table.LC_calendar tr td.LC_calendar_day_empty {
5968: background-color: $data_table_dark;
5969: }
1.795 www 5970:
1.779 bisitz 5971: table.LC_calendar tr td.LC_calendar_day_current {
5972: background-color: $data_table_highlight;
1.777 tempelho 5973: }
1.795 www 5974:
1.938 bisitz 5975: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 5976: background-color: $mail_new;
5977: }
1.795 www 5978:
1.938 bisitz 5979: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 5980: background-color: $mail_new_hover;
5981: }
1.795 www 5982:
1.938 bisitz 5983: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 5984: background-color: $mail_read;
5985: }
1.795 www 5986:
1.938 bisitz 5987: /*
5988: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 5989: background-color: $mail_read_hover;
5990: }
1.938 bisitz 5991: */
1.795 www 5992:
1.938 bisitz 5993: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 5994: background-color: $mail_replied;
5995: }
1.795 www 5996:
1.938 bisitz 5997: /*
5998: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 5999: background-color: $mail_replied_hover;
6000: }
1.938 bisitz 6001: */
1.795 www 6002:
1.938 bisitz 6003: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 6004: background-color: $mail_other;
6005: }
1.795 www 6006:
1.938 bisitz 6007: /*
6008: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 6009: background-color: $mail_other_hover;
6010: }
1.938 bisitz 6011: */
1.494 raeburn 6012:
1.777 tempelho 6013: table.LC_data_table tr > td.LC_browser_file,
6014: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 6015: background: #AAEE77;
1.389 albertel 6016: }
1.795 www 6017:
1.777 tempelho 6018: table.LC_data_table tr > td.LC_browser_file_locked,
6019: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 6020: background: #FFAA99;
1.387 albertel 6021: }
1.795 www 6022:
1.777 tempelho 6023: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 6024: background: #888888;
1.779 bisitz 6025: }
1.795 www 6026:
1.777 tempelho 6027: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 6028: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 6029: background: #F8F866;
1.777 tempelho 6030: }
1.795 www 6031:
1.696 bisitz 6032: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 6033: background: #E0E8FF;
1.387 albertel 6034: }
1.696 bisitz 6035:
1.707 bisitz 6036: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 6037: /* background: #77FF77; */
1.707 bisitz 6038: }
1.795 www 6039:
1.707 bisitz 6040: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 6041: border-right: 8px solid #FFFF77;
1.707 bisitz 6042: }
1.795 www 6043:
1.707 bisitz 6044: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 6045: border-right: 8px solid #FFAA77;
1.707 bisitz 6046: }
1.795 www 6047:
1.707 bisitz 6048: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 6049: border-right: 8px solid #FF7777;
1.707 bisitz 6050: }
1.795 www 6051:
1.707 bisitz 6052: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 6053: border-right: 8px solid #AAFF77;
1.707 bisitz 6054: }
1.795 www 6055:
1.707 bisitz 6056: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 6057: border-right: 8px solid #11CC55;
1.707 bisitz 6058: }
6059:
1.388 albertel 6060: span.LC_current_location {
1.701 harmsja 6061: font-size:larger;
1.388 albertel 6062: background: $pgbg;
6063: }
1.387 albertel 6064:
1.1029 www 6065: span.LC_current_nav_location {
6066: font-weight:bold;
6067: background: $sidebg;
6068: }
6069:
1.395 albertel 6070: span.LC_parm_menu_item {
6071: font-size: larger;
6072: }
1.795 www 6073:
1.395 albertel 6074: span.LC_parm_scope_all {
6075: color: red;
6076: }
1.795 www 6077:
1.395 albertel 6078: span.LC_parm_scope_folder {
6079: color: green;
6080: }
1.795 www 6081:
1.395 albertel 6082: span.LC_parm_scope_resource {
6083: color: orange;
6084: }
1.795 www 6085:
1.395 albertel 6086: span.LC_parm_part {
6087: color: blue;
6088: }
1.795 www 6089:
1.911 bisitz 6090: span.LC_parm_folder,
6091: span.LC_parm_symb {
1.395 albertel 6092: font-size: x-small;
6093: font-family: $mono;
6094: color: #AAAAAA;
6095: }
6096:
1.977 bisitz 6097: ul.LC_parm_parmlist li {
6098: display: inline-block;
6099: padding: 0.3em 0.8em;
6100: vertical-align: top;
6101: width: 150px;
6102: border-top:1px solid $lg_border_color;
6103: }
6104:
1.795 www 6105: td.LC_parm_overview_level_menu,
6106: td.LC_parm_overview_map_menu,
6107: td.LC_parm_overview_parm_selectors,
6108: td.LC_parm_overview_restrictions {
1.396 albertel 6109: border: 1px solid black;
6110: border-collapse: collapse;
6111: }
1.795 www 6112:
1.396 albertel 6113: table.LC_parm_overview_restrictions td {
6114: border-width: 1px 4px 1px 4px;
6115: border-style: solid;
6116: border-color: $pgbg;
6117: text-align: center;
6118: }
1.795 www 6119:
1.396 albertel 6120: table.LC_parm_overview_restrictions th {
6121: background: $tabbg;
6122: border-width: 1px 4px 1px 4px;
6123: border-style: solid;
6124: border-color: $pgbg;
6125: }
1.795 www 6126:
1.398 albertel 6127: table#LC_helpmenu {
1.803 bisitz 6128: border: none;
1.398 albertel 6129: height: 55px;
1.803 bisitz 6130: border-spacing: 0;
1.398 albertel 6131: }
6132:
6133: table#LC_helpmenu fieldset legend {
6134: font-size: larger;
6135: }
1.795 www 6136:
1.397 albertel 6137: table#LC_helpmenu_links {
6138: width: 100%;
6139: border: 1px solid black;
6140: background: $pgbg;
1.803 bisitz 6141: padding: 0;
1.397 albertel 6142: border-spacing: 1px;
6143: }
1.795 www 6144:
1.397 albertel 6145: table#LC_helpmenu_links tr td {
6146: padding: 1px;
6147: background: $tabbg;
1.399 albertel 6148: text-align: center;
6149: font-weight: bold;
1.397 albertel 6150: }
1.396 albertel 6151:
1.795 www 6152: table#LC_helpmenu_links a:link,
6153: table#LC_helpmenu_links a:visited,
1.397 albertel 6154: table#LC_helpmenu_links a:active {
6155: text-decoration: none;
6156: color: $font;
6157: }
1.795 www 6158:
1.397 albertel 6159: table#LC_helpmenu_links a:hover {
6160: text-decoration: underline;
6161: color: $vlink;
6162: }
1.396 albertel 6163:
1.417 albertel 6164: .LC_chrt_popup_exists {
6165: border: 1px solid #339933;
6166: margin: -1px;
6167: }
1.795 www 6168:
1.417 albertel 6169: .LC_chrt_popup_up {
6170: border: 1px solid yellow;
6171: margin: -1px;
6172: }
1.795 www 6173:
1.417 albertel 6174: .LC_chrt_popup {
6175: border: 1px solid #8888FF;
6176: background: #CCCCFF;
6177: }
1.795 www 6178:
1.421 albertel 6179: table.LC_pick_box {
6180: border-collapse: separate;
6181: background: white;
6182: border: 1px solid black;
6183: border-spacing: 1px;
6184: }
1.795 www 6185:
1.421 albertel 6186: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 6187: background: $sidebg;
1.421 albertel 6188: font-weight: bold;
1.900 bisitz 6189: text-align: left;
1.740 bisitz 6190: vertical-align: top;
1.421 albertel 6191: width: 184px;
6192: padding: 8px;
6193: }
1.795 www 6194:
1.579 raeburn 6195: table.LC_pick_box td.LC_pick_box_value {
6196: text-align: left;
6197: padding: 8px;
6198: }
1.795 www 6199:
1.579 raeburn 6200: table.LC_pick_box td.LC_pick_box_select {
6201: text-align: left;
6202: padding: 8px;
6203: }
1.795 www 6204:
1.424 albertel 6205: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 6206: padding: 0;
1.421 albertel 6207: height: 1px;
6208: background: black;
6209: }
1.795 www 6210:
1.421 albertel 6211: table.LC_pick_box td.LC_pick_box_submit {
6212: text-align: right;
6213: }
1.795 www 6214:
1.579 raeburn 6215: table.LC_pick_box td.LC_evenrow_value {
6216: text-align: left;
6217: padding: 8px;
6218: background-color: $data_table_light;
6219: }
1.795 www 6220:
1.579 raeburn 6221: table.LC_pick_box td.LC_oddrow_value {
6222: text-align: left;
6223: padding: 8px;
6224: background-color: $data_table_light;
6225: }
1.795 www 6226:
1.579 raeburn 6227: span.LC_helpform_receipt_cat {
6228: font-weight: bold;
6229: }
1.795 www 6230:
1.424 albertel 6231: table.LC_group_priv_box {
6232: background: white;
6233: border: 1px solid black;
6234: border-spacing: 1px;
6235: }
1.795 www 6236:
1.424 albertel 6237: table.LC_group_priv_box td.LC_pick_box_title {
6238: background: $tabbg;
6239: font-weight: bold;
6240: text-align: right;
6241: width: 184px;
6242: }
1.795 www 6243:
1.424 albertel 6244: table.LC_group_priv_box td.LC_groups_fixed {
6245: background: $data_table_light;
6246: text-align: center;
6247: }
1.795 www 6248:
1.424 albertel 6249: table.LC_group_priv_box td.LC_groups_optional {
6250: background: $data_table_dark;
6251: text-align: center;
6252: }
1.795 www 6253:
1.424 albertel 6254: table.LC_group_priv_box td.LC_groups_functionality {
6255: background: $data_table_darker;
6256: text-align: center;
6257: font-weight: bold;
6258: }
1.795 www 6259:
1.424 albertel 6260: table.LC_group_priv td {
6261: text-align: left;
1.803 bisitz 6262: padding: 0;
1.424 albertel 6263: }
6264:
6265: .LC_navbuttons {
6266: margin: 2ex 0ex 2ex 0ex;
6267: }
1.795 www 6268:
1.423 albertel 6269: .LC_topic_bar {
6270: font-weight: bold;
6271: background: $tabbg;
1.918 wenzelju 6272: margin: 1em 0em 1em 2em;
1.805 bisitz 6273: padding: 3px;
1.918 wenzelju 6274: font-size: 1.2em;
1.423 albertel 6275: }
1.795 www 6276:
1.423 albertel 6277: .LC_topic_bar span {
1.918 wenzelju 6278: left: 0.5em;
6279: position: absolute;
1.423 albertel 6280: vertical-align: middle;
1.918 wenzelju 6281: font-size: 1.2em;
1.423 albertel 6282: }
1.795 www 6283:
1.423 albertel 6284: table.LC_course_group_status {
6285: margin: 20px;
6286: }
1.795 www 6287:
1.423 albertel 6288: table.LC_status_selector td {
6289: vertical-align: top;
6290: text-align: center;
1.424 albertel 6291: padding: 4px;
6292: }
1.795 www 6293:
1.599 albertel 6294: div.LC_feedback_link {
1.616 albertel 6295: clear: both;
1.829 kalberla 6296: background: $sidebg;
1.779 bisitz 6297: width: 100%;
1.829 kalberla 6298: padding-bottom: 10px;
6299: border: 1px $tabbg solid;
1.833 kalberla 6300: height: 22px;
6301: line-height: 22px;
6302: padding-top: 5px;
6303: }
6304:
6305: div.LC_feedback_link img {
6306: height: 22px;
1.867 kalberla 6307: vertical-align:middle;
1.829 kalberla 6308: }
6309:
1.911 bisitz 6310: div.LC_feedback_link a {
1.829 kalberla 6311: text-decoration: none;
1.489 raeburn 6312: }
1.795 www 6313:
1.867 kalberla 6314: div.LC_comblock {
1.911 bisitz 6315: display:inline;
1.867 kalberla 6316: color:$font;
6317: font-size:90%;
6318: }
6319:
6320: div.LC_feedback_link div.LC_comblock {
6321: padding-left:5px;
6322: }
6323:
6324: div.LC_feedback_link div.LC_comblock a {
6325: color:$font;
6326: }
6327:
1.489 raeburn 6328: span.LC_feedback_link {
1.858 bisitz 6329: /* background: $feedback_link_bg; */
1.599 albertel 6330: font-size: larger;
6331: }
1.795 www 6332:
1.599 albertel 6333: span.LC_message_link {
1.858 bisitz 6334: /* background: $feedback_link_bg; */
1.599 albertel 6335: font-size: larger;
6336: position: absolute;
6337: right: 1em;
1.489 raeburn 6338: }
1.421 albertel 6339:
1.515 albertel 6340: table.LC_prior_tries {
1.524 albertel 6341: border: 1px solid #000000;
6342: border-collapse: separate;
6343: border-spacing: 1px;
1.515 albertel 6344: }
1.523 albertel 6345:
1.515 albertel 6346: table.LC_prior_tries td {
1.524 albertel 6347: padding: 2px;
1.515 albertel 6348: }
1.523 albertel 6349:
6350: .LC_answer_correct {
1.795 www 6351: background: lightgreen;
6352: color: darkgreen;
6353: padding: 6px;
1.523 albertel 6354: }
1.795 www 6355:
1.523 albertel 6356: .LC_answer_charged_try {
1.797 www 6357: background: #FFAAAA;
1.795 www 6358: color: darkred;
6359: padding: 6px;
1.523 albertel 6360: }
1.795 www 6361:
1.779 bisitz 6362: .LC_answer_not_charged_try,
1.523 albertel 6363: .LC_answer_no_grade,
6364: .LC_answer_late {
1.795 www 6365: background: lightyellow;
1.523 albertel 6366: color: black;
1.795 www 6367: padding: 6px;
1.523 albertel 6368: }
1.795 www 6369:
1.523 albertel 6370: .LC_answer_previous {
1.795 www 6371: background: lightblue;
6372: color: darkblue;
6373: padding: 6px;
1.523 albertel 6374: }
1.795 www 6375:
1.779 bisitz 6376: .LC_answer_no_message {
1.777 tempelho 6377: background: #FFFFFF;
6378: color: black;
1.795 www 6379: padding: 6px;
1.779 bisitz 6380: }
1.795 www 6381:
1.779 bisitz 6382: .LC_answer_unknown {
6383: background: orange;
6384: color: black;
1.795 www 6385: padding: 6px;
1.777 tempelho 6386: }
1.795 www 6387:
1.529 albertel 6388: span.LC_prior_numerical,
6389: span.LC_prior_string,
6390: span.LC_prior_custom,
6391: span.LC_prior_reaction,
6392: span.LC_prior_math {
1.925 bisitz 6393: font-family: $mono;
1.523 albertel 6394: white-space: pre;
6395: }
6396:
1.525 albertel 6397: span.LC_prior_string {
1.925 bisitz 6398: font-family: $mono;
1.525 albertel 6399: white-space: pre;
6400: }
6401:
1.523 albertel 6402: table.LC_prior_option {
6403: width: 100%;
6404: border-collapse: collapse;
6405: }
1.795 www 6406:
1.911 bisitz 6407: table.LC_prior_rank,
1.795 www 6408: table.LC_prior_match {
1.528 albertel 6409: border-collapse: collapse;
6410: }
1.795 www 6411:
1.528 albertel 6412: table.LC_prior_option tr td,
6413: table.LC_prior_rank tr td,
6414: table.LC_prior_match tr td {
1.524 albertel 6415: border: 1px solid #000000;
1.515 albertel 6416: }
6417:
1.855 bisitz 6418: .LC_nobreak {
1.544 albertel 6419: white-space: nowrap;
1.519 raeburn 6420: }
6421:
1.576 raeburn 6422: span.LC_cusr_emph {
6423: font-style: italic;
6424: }
6425:
1.633 raeburn 6426: span.LC_cusr_subheading {
6427: font-weight: normal;
6428: font-size: 85%;
6429: }
6430:
1.861 bisitz 6431: div.LC_docs_entry_move {
1.859 bisitz 6432: border: 1px solid #BBBBBB;
1.545 albertel 6433: background: #DDDDDD;
1.861 bisitz 6434: width: 22px;
1.859 bisitz 6435: padding: 1px;
6436: margin: 0;
1.545 albertel 6437: }
6438:
1.861 bisitz 6439: table.LC_data_table tr > td.LC_docs_entry_commands,
6440: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 6441: font-size: x-small;
6442: }
1.795 www 6443:
1.861 bisitz 6444: .LC_docs_entry_parameter {
6445: white-space: nowrap;
6446: }
6447:
1.544 albertel 6448: .LC_docs_copy {
1.545 albertel 6449: color: #000099;
1.544 albertel 6450: }
1.795 www 6451:
1.544 albertel 6452: .LC_docs_cut {
1.545 albertel 6453: color: #550044;
1.544 albertel 6454: }
1.795 www 6455:
1.544 albertel 6456: .LC_docs_rename {
1.545 albertel 6457: color: #009900;
1.544 albertel 6458: }
1.795 www 6459:
1.544 albertel 6460: .LC_docs_remove {
1.545 albertel 6461: color: #990000;
6462: }
6463:
1.547 albertel 6464: .LC_docs_reinit_warn,
6465: .LC_docs_ext_edit {
6466: font-size: x-small;
6467: }
6468:
1.545 albertel 6469: table.LC_docs_adddocs td,
6470: table.LC_docs_adddocs th {
6471: border: 1px solid #BBBBBB;
6472: padding: 4px;
6473: background: #DDDDDD;
1.543 albertel 6474: }
6475:
1.584 albertel 6476: table.LC_sty_begin {
6477: background: #BBFFBB;
6478: }
1.795 www 6479:
1.584 albertel 6480: table.LC_sty_end {
6481: background: #FFBBBB;
6482: }
6483:
1.589 raeburn 6484: table.LC_double_column {
1.803 bisitz 6485: border-width: 0;
1.589 raeburn 6486: border-collapse: collapse;
6487: width: 100%;
6488: padding: 2px;
6489: }
6490:
6491: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 6492: top: 2px;
1.589 raeburn 6493: left: 2px;
6494: width: 47%;
6495: vertical-align: top;
6496: }
6497:
6498: table.LC_double_column tr td.LC_right_col {
6499: top: 2px;
1.779 bisitz 6500: right: 2px;
1.589 raeburn 6501: width: 47%;
6502: vertical-align: top;
6503: }
6504:
1.591 raeburn 6505: div.LC_left_float {
6506: float: left;
6507: padding-right: 5%;
1.597 albertel 6508: padding-bottom: 4px;
1.591 raeburn 6509: }
6510:
6511: div.LC_clear_float_header {
1.597 albertel 6512: padding-bottom: 2px;
1.591 raeburn 6513: }
6514:
6515: div.LC_clear_float_footer {
1.597 albertel 6516: padding-top: 10px;
1.591 raeburn 6517: clear: both;
6518: }
6519:
1.597 albertel 6520: div.LC_grade_show_user {
1.941 bisitz 6521: /* border-left: 5px solid $sidebg; */
6522: border-top: 5px solid #000000;
6523: margin: 50px 0 0 0;
1.936 bisitz 6524: padding: 15px 0 5px 10px;
1.597 albertel 6525: }
1.795 www 6526:
1.936 bisitz 6527: div.LC_grade_show_user_odd_row {
1.941 bisitz 6528: /* border-left: 5px solid #000000; */
6529: }
6530:
6531: div.LC_grade_show_user div.LC_Box {
6532: margin-right: 50px;
1.597 albertel 6533: }
6534:
6535: div.LC_grade_submissions,
6536: div.LC_grade_message_center,
1.936 bisitz 6537: div.LC_grade_info_links {
1.597 albertel 6538: margin: 5px;
6539: width: 99%;
6540: background: #FFFFFF;
6541: }
1.795 www 6542:
1.597 albertel 6543: div.LC_grade_submissions_header,
1.936 bisitz 6544: div.LC_grade_message_center_header {
1.705 tempelho 6545: font-weight: bold;
6546: font-size: large;
1.597 albertel 6547: }
1.795 www 6548:
1.597 albertel 6549: div.LC_grade_submissions_body,
1.936 bisitz 6550: div.LC_grade_message_center_body {
1.597 albertel 6551: border: 1px solid black;
6552: width: 99%;
6553: background: #FFFFFF;
6554: }
1.795 www 6555:
1.613 albertel 6556: table.LC_scantron_action {
6557: width: 100%;
6558: }
1.795 www 6559:
1.613 albertel 6560: table.LC_scantron_action tr th {
1.698 harmsja 6561: font-weight:bold;
6562: font-style:normal;
1.613 albertel 6563: }
1.795 www 6564:
1.779 bisitz 6565: .LC_edit_problem_header,
1.614 albertel 6566: div.LC_edit_problem_footer {
1.705 tempelho 6567: font-weight: normal;
6568: font-size: medium;
1.602 albertel 6569: margin: 2px;
1.1060 bisitz 6570: background-color: $sidebg;
1.600 albertel 6571: }
1.795 www 6572:
1.600 albertel 6573: div.LC_edit_problem_header,
1.602 albertel 6574: div.LC_edit_problem_header div,
1.614 albertel 6575: div.LC_edit_problem_footer,
6576: div.LC_edit_problem_footer div,
1.602 albertel 6577: div.LC_edit_problem_editxml_header,
6578: div.LC_edit_problem_editxml_header div {
1.600 albertel 6579: margin-top: 5px;
6580: }
1.795 www 6581:
1.600 albertel 6582: div.LC_edit_problem_header_title {
1.705 tempelho 6583: font-weight: bold;
6584: font-size: larger;
1.602 albertel 6585: background: $tabbg;
6586: padding: 3px;
1.1060 bisitz 6587: margin: 0 0 5px 0;
1.602 albertel 6588: }
1.795 www 6589:
1.602 albertel 6590: table.LC_edit_problem_header_title {
6591: width: 100%;
1.600 albertel 6592: background: $tabbg;
1.602 albertel 6593: }
6594:
6595: div.LC_edit_problem_discards {
6596: float: left;
6597: padding-bottom: 5px;
6598: }
1.795 www 6599:
1.602 albertel 6600: div.LC_edit_problem_saves {
6601: float: right;
6602: padding-bottom: 5px;
1.600 albertel 6603: }
1.795 www 6604:
1.1075.2.34 raeburn 6605: .LC_edit_opt {
6606: padding-left: 1em;
6607: white-space: nowrap;
6608: }
6609:
1.1075.2.57 raeburn 6610: .LC_edit_problem_latexhelper{
6611: text-align: right;
6612: }
6613:
6614: #LC_edit_problem_colorful div{
6615: margin-left: 40px;
6616: }
6617:
1.911 bisitz 6618: img.stift {
1.803 bisitz 6619: border-width: 0;
6620: vertical-align: middle;
1.677 riegler 6621: }
1.680 riegler 6622:
1.923 bisitz 6623: table td.LC_mainmenu_col_fieldset {
1.680 riegler 6624: vertical-align: top;
1.777 tempelho 6625: }
1.795 www 6626:
1.716 raeburn 6627: div.LC_createcourse {
1.911 bisitz 6628: margin: 10px 10px 10px 10px;
1.716 raeburn 6629: }
6630:
1.917 raeburn 6631: .LC_dccid {
1.1075.2.38 raeburn 6632: float: right;
1.917 raeburn 6633: margin: 0.2em 0 0 0;
6634: padding: 0;
6635: font-size: 90%;
6636: display:none;
6637: }
6638:
1.897 wenzelju 6639: ol.LC_primary_menu a:hover,
1.721 harmsja 6640: ol#LC_MenuBreadcrumbs a:hover,
6641: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 6642: ul#LC_secondary_menu a:hover,
1.721 harmsja 6643: .LC_FormSectionClearButton input:hover
1.795 www 6644: ul.LC_TabContent li:hover a {
1.952 onken 6645: color:$button_hover;
1.911 bisitz 6646: text-decoration:none;
1.693 droeschl 6647: }
6648:
1.779 bisitz 6649: h1 {
1.911 bisitz 6650: padding: 0;
6651: line-height:130%;
1.693 droeschl 6652: }
1.698 harmsja 6653:
1.911 bisitz 6654: h2,
6655: h3,
6656: h4,
6657: h5,
6658: h6 {
6659: margin: 5px 0 5px 0;
6660: padding: 0;
6661: line-height:130%;
1.693 droeschl 6662: }
1.795 www 6663:
6664: .LC_hcell {
1.911 bisitz 6665: padding:3px 15px 3px 15px;
6666: margin: 0;
6667: background-color:$tabbg;
6668: color:$fontmenu;
6669: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 6670: }
1.795 www 6671:
1.840 bisitz 6672: .LC_Box > .LC_hcell {
1.911 bisitz 6673: margin: 0 -10px 10px -10px;
1.835 bisitz 6674: }
6675:
1.721 harmsja 6676: .LC_noBorder {
1.911 bisitz 6677: border: 0;
1.698 harmsja 6678: }
1.693 droeschl 6679:
1.721 harmsja 6680: .LC_FormSectionClearButton input {
1.911 bisitz 6681: background-color:transparent;
6682: border: none;
6683: cursor:pointer;
6684: text-decoration:underline;
1.693 droeschl 6685: }
1.763 bisitz 6686:
6687: .LC_help_open_topic {
1.911 bisitz 6688: color: #FFFFFF;
6689: background-color: #EEEEFF;
6690: margin: 1px;
6691: padding: 4px;
6692: border: 1px solid #000033;
6693: white-space: nowrap;
6694: /* vertical-align: middle; */
1.759 neumanie 6695: }
1.693 droeschl 6696:
1.911 bisitz 6697: dl,
6698: ul,
6699: div,
6700: fieldset {
6701: margin: 10px 10px 10px 0;
6702: /* overflow: hidden; */
1.693 droeschl 6703: }
1.795 www 6704:
1.1075.2.90 raeburn 6705: article.geogebraweb div {
6706: margin: 0;
6707: }
6708:
1.838 bisitz 6709: fieldset > legend {
1.911 bisitz 6710: font-weight: bold;
6711: padding: 0 5px 0 5px;
1.838 bisitz 6712: }
6713:
1.813 bisitz 6714: #LC_nav_bar {
1.911 bisitz 6715: float: left;
1.995 raeburn 6716: background-color: $pgbg_or_bgcolor;
1.966 bisitz 6717: margin: 0 0 2px 0;
1.807 droeschl 6718: }
6719:
1.916 droeschl 6720: #LC_realm {
6721: margin: 0.2em 0 0 0;
6722: padding: 0;
6723: font-weight: bold;
6724: text-align: center;
1.995 raeburn 6725: background-color: $pgbg_or_bgcolor;
1.916 droeschl 6726: }
6727:
1.911 bisitz 6728: #LC_nav_bar em {
6729: font-weight: bold;
6730: font-style: normal;
1.807 droeschl 6731: }
6732:
1.897 wenzelju 6733: ol.LC_primary_menu {
1.934 droeschl 6734: margin: 0;
1.1075.2.2 raeburn 6735: padding: 0;
1.995 raeburn 6736: background-color: $pgbg_or_bgcolor;
1.807 droeschl 6737: }
6738:
1.852 droeschl 6739: ol#LC_PathBreadcrumbs {
1.911 bisitz 6740: margin: 0;
1.693 droeschl 6741: }
6742:
1.897 wenzelju 6743: ol.LC_primary_menu li {
1.1075.2.2 raeburn 6744: color: RGB(80, 80, 80);
6745: vertical-align: middle;
6746: text-align: left;
6747: list-style: none;
6748: float: left;
6749: }
6750:
6751: ol.LC_primary_menu li a {
6752: display: block;
6753: margin: 0;
6754: padding: 0 5px 0 10px;
6755: text-decoration: none;
6756: }
6757:
6758: ol.LC_primary_menu li ul {
6759: display: none;
6760: width: 10em;
6761: background-color: $data_table_light;
6762: }
6763:
6764: ol.LC_primary_menu li:hover ul, ol.LC_primary_menu li.hover ul {
6765: display: block;
6766: position: absolute;
6767: margin: 0;
6768: padding: 0;
1.1075.2.5 raeburn 6769: z-index: 2;
1.1075.2.2 raeburn 6770: }
6771:
6772: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
6773: font-size: 90%;
1.911 bisitz 6774: vertical-align: top;
1.1075.2.2 raeburn 6775: float: none;
1.1075.2.5 raeburn 6776: border-left: 1px solid black;
6777: border-right: 1px solid black;
1.1075.2.2 raeburn 6778: }
6779:
6780: ol.LC_primary_menu li:hover li a, ol.LC_primary_menu li.hover li a {
1.1075.2.5 raeburn 6781: background-color:$data_table_light;
1.1075.2.2 raeburn 6782: }
6783:
6784: ol.LC_primary_menu li li a:hover {
6785: color:$button_hover;
6786: background-color:$data_table_dark;
1.693 droeschl 6787: }
6788:
1.897 wenzelju 6789: ol.LC_primary_menu li img {
1.911 bisitz 6790: vertical-align: bottom;
1.934 droeschl 6791: height: 1.1em;
1.1075.2.3 raeburn 6792: margin: 0.2em 0 0 0;
1.693 droeschl 6793: }
6794:
1.897 wenzelju 6795: ol.LC_primary_menu a {
1.911 bisitz 6796: color: RGB(80, 80, 80);
6797: text-decoration: none;
1.693 droeschl 6798: }
1.795 www 6799:
1.949 droeschl 6800: ol.LC_primary_menu a.LC_new_message {
6801: font-weight:bold;
6802: color: darkred;
6803: }
6804:
1.975 raeburn 6805: ol.LC_docs_parameters {
6806: margin-left: 0;
6807: padding: 0;
6808: list-style: none;
6809: }
6810:
6811: ol.LC_docs_parameters li {
6812: margin: 0;
6813: padding-right: 20px;
6814: display: inline;
6815: }
6816:
1.976 raeburn 6817: ol.LC_docs_parameters li:before {
6818: content: "\\002022 \\0020";
6819: }
6820:
6821: li.LC_docs_parameters_title {
6822: font-weight: bold;
6823: }
6824:
6825: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
6826: content: "";
6827: }
6828:
1.897 wenzelju 6829: ul#LC_secondary_menu {
1.1075.2.23 raeburn 6830: clear: right;
1.911 bisitz 6831: color: $fontmenu;
6832: background: $tabbg;
6833: list-style: none;
6834: padding: 0;
6835: margin: 0;
6836: width: 100%;
1.995 raeburn 6837: text-align: left;
1.1075.2.4 raeburn 6838: float: left;
1.808 droeschl 6839: }
6840:
1.897 wenzelju 6841: ul#LC_secondary_menu li {
1.911 bisitz 6842: font-weight: bold;
6843: line-height: 1.8em;
6844: border-right: 1px solid black;
6845: vertical-align: middle;
1.1075.2.4 raeburn 6846: float: left;
6847: }
6848:
6849: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
6850: background-color: $data_table_light;
6851: }
6852:
6853: ul#LC_secondary_menu li a {
6854: padding: 0 0.8em;
6855: }
6856:
6857: ul#LC_secondary_menu li ul {
6858: display: none;
6859: }
6860:
6861: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
6862: display: block;
6863: position: absolute;
6864: margin: 0;
6865: padding: 0;
6866: list-style:none;
6867: float: none;
6868: background-color: $data_table_light;
1.1075.2.5 raeburn 6869: z-index: 2;
1.1075.2.10 raeburn 6870: margin-left: -1px;
1.1075.2.4 raeburn 6871: }
6872:
6873: ul#LC_secondary_menu li ul li {
6874: font-size: 90%;
6875: vertical-align: top;
6876: border-left: 1px solid black;
6877: border-right: 1px solid black;
1.1075.2.33 raeburn 6878: background-color: $data_table_light;
1.1075.2.4 raeburn 6879: list-style:none;
6880: float: none;
6881: }
6882:
6883: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
6884: background-color: $data_table_dark;
1.807 droeschl 6885: }
6886:
1.847 tempelho 6887: ul.LC_TabContent {
1.911 bisitz 6888: display:block;
6889: background: $sidebg;
6890: border-bottom: solid 1px $lg_border_color;
6891: list-style:none;
1.1020 raeburn 6892: margin: -1px -10px 0 -10px;
1.911 bisitz 6893: padding: 0;
1.693 droeschl 6894: }
6895:
1.795 www 6896: ul.LC_TabContent li,
6897: ul.LC_TabContentBigger li {
1.911 bisitz 6898: float:left;
1.741 harmsja 6899: }
1.795 www 6900:
1.897 wenzelju 6901: ul#LC_secondary_menu li a {
1.911 bisitz 6902: color: $fontmenu;
6903: text-decoration: none;
1.693 droeschl 6904: }
1.795 www 6905:
1.721 harmsja 6906: ul.LC_TabContent {
1.952 onken 6907: min-height:20px;
1.721 harmsja 6908: }
1.795 www 6909:
6910: ul.LC_TabContent li {
1.911 bisitz 6911: vertical-align:middle;
1.959 onken 6912: padding: 0 16px 0 10px;
1.911 bisitz 6913: background-color:$tabbg;
6914: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 6915: border-left: solid 1px $font;
1.721 harmsja 6916: }
1.795 www 6917:
1.847 tempelho 6918: ul.LC_TabContent .right {
1.911 bisitz 6919: float:right;
1.847 tempelho 6920: }
6921:
1.911 bisitz 6922: ul.LC_TabContent li a,
6923: ul.LC_TabContent li {
6924: color:rgb(47,47,47);
6925: text-decoration:none;
6926: font-size:95%;
6927: font-weight:bold;
1.952 onken 6928: min-height:20px;
6929: }
6930:
1.959 onken 6931: ul.LC_TabContent li a:hover,
6932: ul.LC_TabContent li a:focus {
1.952 onken 6933: color: $button_hover;
1.959 onken 6934: background:none;
6935: outline:none;
1.952 onken 6936: }
6937:
6938: ul.LC_TabContent li:hover {
6939: color: $button_hover;
6940: cursor:pointer;
1.721 harmsja 6941: }
1.795 www 6942:
1.911 bisitz 6943: ul.LC_TabContent li.active {
1.952 onken 6944: color: $font;
1.911 bisitz 6945: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 6946: border-bottom:solid 1px #FFFFFF;
6947: cursor: default;
1.744 ehlerst 6948: }
1.795 www 6949:
1.959 onken 6950: ul.LC_TabContent li.active a {
6951: color:$font;
6952: background:#FFFFFF;
6953: outline: none;
6954: }
1.1047 raeburn 6955:
6956: ul.LC_TabContent li.goback {
6957: float: left;
6958: border-left: none;
6959: }
6960:
1.870 tempelho 6961: #maincoursedoc {
1.911 bisitz 6962: clear:both;
1.870 tempelho 6963: }
6964:
6965: ul.LC_TabContentBigger {
1.911 bisitz 6966: display:block;
6967: list-style:none;
6968: padding: 0;
1.870 tempelho 6969: }
6970:
1.795 www 6971: ul.LC_TabContentBigger li {
1.911 bisitz 6972: vertical-align:bottom;
6973: height: 30px;
6974: font-size:110%;
6975: font-weight:bold;
6976: color: #737373;
1.841 tempelho 6977: }
6978:
1.957 onken 6979: ul.LC_TabContentBigger li.active {
6980: position: relative;
6981: top: 1px;
6982: }
6983:
1.870 tempelho 6984: ul.LC_TabContentBigger li a {
1.911 bisitz 6985: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6986: height: 30px;
6987: line-height: 30px;
6988: text-align: center;
6989: display: block;
6990: text-decoration: none;
1.958 onken 6991: outline: none;
1.741 harmsja 6992: }
1.795 www 6993:
1.870 tempelho 6994: ul.LC_TabContentBigger li.active a {
1.911 bisitz 6995: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6996: color:$font;
1.744 ehlerst 6997: }
1.795 www 6998:
1.870 tempelho 6999: ul.LC_TabContentBigger li b {
1.911 bisitz 7000: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
7001: display: block;
7002: float: left;
7003: padding: 0 30px;
1.957 onken 7004: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 7005: }
7006:
1.956 onken 7007: ul.LC_TabContentBigger li:hover b {
7008: color:$button_hover;
7009: }
7010:
1.870 tempelho 7011: ul.LC_TabContentBigger li.active b {
1.911 bisitz 7012: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
7013: color:$font;
1.957 onken 7014: border: 0;
1.741 harmsja 7015: }
1.693 droeschl 7016:
1.870 tempelho 7017:
1.862 bisitz 7018: ul.LC_CourseBreadcrumbs {
7019: background: $sidebg;
1.1020 raeburn 7020: height: 2em;
1.862 bisitz 7021: padding-left: 10px;
1.1020 raeburn 7022: margin: 0;
1.862 bisitz 7023: list-style-position: inside;
7024: }
7025:
1.911 bisitz 7026: ol#LC_MenuBreadcrumbs,
1.862 bisitz 7027: ol#LC_PathBreadcrumbs {
1.911 bisitz 7028: padding-left: 10px;
7029: margin: 0;
1.933 droeschl 7030: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 7031: }
7032:
1.911 bisitz 7033: ol#LC_MenuBreadcrumbs li,
7034: ol#LC_PathBreadcrumbs li,
1.862 bisitz 7035: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 7036: display: inline;
1.933 droeschl 7037: white-space: normal;
1.693 droeschl 7038: }
7039:
1.823 bisitz 7040: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 7041: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 7042: text-decoration: none;
7043: font-size:90%;
1.693 droeschl 7044: }
1.795 www 7045:
1.969 droeschl 7046: ol#LC_MenuBreadcrumbs h1 {
7047: display: inline;
7048: font-size: 90%;
7049: line-height: 2.5em;
7050: margin: 0;
7051: padding: 0;
7052: }
7053:
1.795 www 7054: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 7055: text-decoration:none;
7056: font-size:100%;
7057: font-weight:bold;
1.693 droeschl 7058: }
1.795 www 7059:
1.840 bisitz 7060: .LC_Box {
1.911 bisitz 7061: border: solid 1px $lg_border_color;
7062: padding: 0 10px 10px 10px;
1.746 neumanie 7063: }
1.795 www 7064:
1.1020 raeburn 7065: .LC_DocsBox {
7066: border: solid 1px $lg_border_color;
7067: padding: 0 0 10px 10px;
7068: }
7069:
1.795 www 7070: .LC_AboutMe_Image {
1.911 bisitz 7071: float:left;
7072: margin-right:10px;
1.747 neumanie 7073: }
1.795 www 7074:
7075: .LC_Clear_AboutMe_Image {
1.911 bisitz 7076: clear:left;
1.747 neumanie 7077: }
1.795 www 7078:
1.721 harmsja 7079: dl.LC_ListStyleClean dt {
1.911 bisitz 7080: padding-right: 5px;
7081: display: table-header-group;
1.693 droeschl 7082: }
7083:
1.721 harmsja 7084: dl.LC_ListStyleClean dd {
1.911 bisitz 7085: display: table-row;
1.693 droeschl 7086: }
7087:
1.721 harmsja 7088: .LC_ListStyleClean,
7089: .LC_ListStyleSimple,
7090: .LC_ListStyleNormal,
1.795 www 7091: .LC_ListStyleSpecial {
1.911 bisitz 7092: /* display:block; */
7093: list-style-position: inside;
7094: list-style-type: none;
7095: overflow: hidden;
7096: padding: 0;
1.693 droeschl 7097: }
7098:
1.721 harmsja 7099: .LC_ListStyleSimple li,
7100: .LC_ListStyleSimple dd,
7101: .LC_ListStyleNormal li,
7102: .LC_ListStyleNormal dd,
7103: .LC_ListStyleSpecial li,
1.795 www 7104: .LC_ListStyleSpecial dd {
1.911 bisitz 7105: margin: 0;
7106: padding: 5px 5px 5px 10px;
7107: clear: both;
1.693 droeschl 7108: }
7109:
1.721 harmsja 7110: .LC_ListStyleClean li,
7111: .LC_ListStyleClean dd {
1.911 bisitz 7112: padding-top: 0;
7113: padding-bottom: 0;
1.693 droeschl 7114: }
7115:
1.721 harmsja 7116: .LC_ListStyleSimple dd,
1.795 www 7117: .LC_ListStyleSimple li {
1.911 bisitz 7118: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 7119: }
7120:
1.721 harmsja 7121: .LC_ListStyleSpecial li,
7122: .LC_ListStyleSpecial dd {
1.911 bisitz 7123: list-style-type: none;
7124: background-color: RGB(220, 220, 220);
7125: margin-bottom: 4px;
1.693 droeschl 7126: }
7127:
1.721 harmsja 7128: table.LC_SimpleTable {
1.911 bisitz 7129: margin:5px;
7130: border:solid 1px $lg_border_color;
1.795 www 7131: }
1.693 droeschl 7132:
1.721 harmsja 7133: table.LC_SimpleTable tr {
1.911 bisitz 7134: padding: 0;
7135: border:solid 1px $lg_border_color;
1.693 droeschl 7136: }
1.795 www 7137:
7138: table.LC_SimpleTable thead {
1.911 bisitz 7139: background:rgb(220,220,220);
1.693 droeschl 7140: }
7141:
1.721 harmsja 7142: div.LC_columnSection {
1.911 bisitz 7143: display: block;
7144: clear: both;
7145: overflow: hidden;
7146: margin: 0;
1.693 droeschl 7147: }
7148:
1.721 harmsja 7149: div.LC_columnSection>* {
1.911 bisitz 7150: float: left;
7151: margin: 10px 20px 10px 0;
7152: overflow:hidden;
1.693 droeschl 7153: }
1.721 harmsja 7154:
1.795 www 7155: table em {
1.911 bisitz 7156: font-weight: bold;
7157: font-style: normal;
1.748 schulted 7158: }
1.795 www 7159:
1.779 bisitz 7160: table.LC_tableBrowseRes,
1.795 www 7161: table.LC_tableOfContent {
1.911 bisitz 7162: border:none;
7163: border-spacing: 1px;
7164: padding: 3px;
7165: background-color: #FFFFFF;
7166: font-size: 90%;
1.753 droeschl 7167: }
1.789 droeschl 7168:
1.911 bisitz 7169: table.LC_tableOfContent {
7170: border-collapse: collapse;
1.789 droeschl 7171: }
7172:
1.771 droeschl 7173: table.LC_tableBrowseRes a,
1.768 schulted 7174: table.LC_tableOfContent a {
1.911 bisitz 7175: background-color: transparent;
7176: text-decoration: none;
1.753 droeschl 7177: }
7178:
1.795 www 7179: table.LC_tableOfContent img {
1.911 bisitz 7180: border: none;
7181: height: 1.3em;
7182: vertical-align: text-bottom;
7183: margin-right: 0.3em;
1.753 droeschl 7184: }
1.757 schulted 7185:
1.795 www 7186: a#LC_content_toolbar_firsthomework {
1.911 bisitz 7187: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 7188: }
7189:
1.795 www 7190: a#LC_content_toolbar_everything {
1.911 bisitz 7191: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 7192: }
7193:
1.795 www 7194: a#LC_content_toolbar_uncompleted {
1.911 bisitz 7195: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 7196: }
7197:
1.795 www 7198: #LC_content_toolbar_clearbubbles {
1.911 bisitz 7199: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 7200: }
7201:
1.795 www 7202: a#LC_content_toolbar_changefolder {
1.911 bisitz 7203: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 7204: }
7205:
1.795 www 7206: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 7207: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 7208: }
7209:
1.1043 raeburn 7210: a#LC_content_toolbar_edittoplevel {
7211: background-image:url(/res/adm/pages/edittoplevel.gif);
7212: }
7213:
1.795 www 7214: ul#LC_toolbar li a:hover {
1.911 bisitz 7215: background-position: bottom center;
1.757 schulted 7216: }
7217:
1.795 www 7218: ul#LC_toolbar {
1.911 bisitz 7219: padding: 0;
7220: margin: 2px;
7221: list-style:none;
7222: position:relative;
7223: background-color:white;
1.1075.2.9 raeburn 7224: overflow: auto;
1.757 schulted 7225: }
7226:
1.795 www 7227: ul#LC_toolbar li {
1.911 bisitz 7228: border:1px solid white;
7229: padding: 0;
7230: margin: 0;
7231: float: left;
7232: display:inline;
7233: vertical-align:middle;
1.1075.2.9 raeburn 7234: white-space: nowrap;
1.911 bisitz 7235: }
1.757 schulted 7236:
1.783 amueller 7237:
1.795 www 7238: a.LC_toolbarItem {
1.911 bisitz 7239: display:block;
7240: padding: 0;
7241: margin: 0;
7242: height: 32px;
7243: width: 32px;
7244: color:white;
7245: border: none;
7246: background-repeat:no-repeat;
7247: background-color:transparent;
1.757 schulted 7248: }
7249:
1.915 droeschl 7250: ul.LC_funclist {
7251: margin: 0;
7252: padding: 0.5em 1em 0.5em 0;
7253: }
7254:
1.933 droeschl 7255: ul.LC_funclist > li:first-child {
7256: font-weight:bold;
7257: margin-left:0.8em;
7258: }
7259:
1.915 droeschl 7260: ul.LC_funclist + ul.LC_funclist {
7261: /*
7262: left border as a seperator if we have more than
7263: one list
7264: */
7265: border-left: 1px solid $sidebg;
7266: /*
7267: this hides the left border behind the border of the
7268: outer box if element is wrapped to the next 'line'
7269: */
7270: margin-left: -1px;
7271: }
7272:
1.843 bisitz 7273: ul.LC_funclist li {
1.915 droeschl 7274: display: inline;
1.782 bisitz 7275: white-space: nowrap;
1.915 droeschl 7276: margin: 0 0 0 25px;
7277: line-height: 150%;
1.782 bisitz 7278: }
7279:
1.974 wenzelju 7280: .LC_hidden {
7281: display: none;
7282: }
7283:
1.1030 www 7284: .LCmodal-overlay {
7285: position:fixed;
7286: top:0;
7287: right:0;
7288: bottom:0;
7289: left:0;
7290: height:100%;
7291: width:100%;
7292: margin:0;
7293: padding:0;
7294: background:#999;
7295: opacity:.75;
7296: filter: alpha(opacity=75);
7297: -moz-opacity: 0.75;
7298: z-index:101;
7299: }
7300:
7301: * html .LCmodal-overlay {
7302: position: absolute;
7303: height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
7304: }
7305:
7306: .LCmodal-window {
7307: position:fixed;
7308: top:50%;
7309: left:50%;
7310: margin:0;
7311: padding:0;
7312: z-index:102;
7313: }
7314:
7315: * html .LCmodal-window {
7316: position:absolute;
7317: }
7318:
7319: .LCclose-window {
7320: position:absolute;
7321: width:32px;
7322: height:32px;
7323: right:8px;
7324: top:8px;
7325: background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
7326: text-indent:-99999px;
7327: overflow:hidden;
7328: cursor:pointer;
7329: }
7330:
1.1075.2.17 raeburn 7331: /*
7332: styles used by TTH when "Default set of options to pass to tth/m
7333: when converting TeX" in course settings has been set
7334:
7335: option passed: -t
7336:
7337: */
7338:
7339: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
7340: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
7341: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
7342: td div.norm {line-height:normal;}
7343:
7344: /*
7345: option passed -y3
7346: */
7347:
7348: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
7349: span.overacc2 {position: relative; left: .8em; top: -1.2ex;}
7350: span.overacc1 {position: relative; left: .6em; top: -1.2ex;}
7351:
1.343 albertel 7352: END
7353: }
7354:
1.306 albertel 7355: =pod
7356:
7357: =item * &headtag()
7358:
7359: Returns a uniform footer for LON-CAPA web pages.
7360:
1.307 albertel 7361: Inputs: $title - optional title for the head
7362: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 7363: $args - optional arguments
1.319 albertel 7364: force_register - if is true call registerurl so the remote is
7365: informed
1.415 albertel 7366: redirect -> array ref of
7367: 1- seconds before redirect occurs
7368: 2- url to redirect to
7369: 3- whether the side effect should occur
1.315 albertel 7370: (side effect of setting
7371: $env{'internal.head.redirect'} to the url
7372: redirected too)
1.352 albertel 7373: domain -> force to color decorate a page for a specific
7374: domain
7375: function -> force usage of a specific rolish color scheme
7376: bgcolor -> override the default page bgcolor
1.460 albertel 7377: no_auto_mt_title
7378: -> prevent &mt()ing the title arg
1.464 albertel 7379:
1.306 albertel 7380: =cut
7381:
7382: sub headtag {
1.313 albertel 7383: my ($title,$head_extra,$args) = @_;
1.306 albertel 7384:
1.363 albertel 7385: my $function = $args->{'function'} || &get_users_function();
7386: my $domain = $args->{'domain'} || &determinedomain();
7387: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.1075.2.52 raeburn 7388: my $httphost = $args->{'use_absolute'};
1.418 albertel 7389: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 7390: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 7391: #time(),
1.418 albertel 7392: $env{'environment.color.timestamp'},
1.363 albertel 7393: $function,$domain,$bgcolor);
7394:
1.369 www 7395: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 7396:
1.308 albertel 7397: my $result =
7398: '<head>'.
1.1075.2.56 raeburn 7399: &font_settings($args);
1.319 albertel 7400:
1.1075.2.72 raeburn 7401: my $inhibitprint;
7402: if ($args->{'print_suppress'}) {
7403: $inhibitprint = &print_suppression();
7404: }
1.1064 raeburn 7405:
1.461 albertel 7406: if (!$args->{'frameset'}) {
7407: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
7408: }
1.1075.2.12 raeburn 7409: if ($args->{'force_register'}) {
7410: $result .= &Apache::lonmenu::registerurl(1);
1.319 albertel 7411: }
1.436 albertel 7412: if (!$args->{'no_nav_bar'}
7413: && !$args->{'only_body'}
7414: && !$args->{'frameset'}) {
1.1075.2.52 raeburn 7415: $result .= &help_menu_js($httphost);
1.1032 www 7416: $result.=&modal_window();
1.1038 www 7417: $result.=&togglebox_script();
1.1034 www 7418: $result.=&wishlist_window();
1.1041 www 7419: $result.=&LCprogressbarUpdate_script();
1.1034 www 7420: } else {
7421: if ($args->{'add_modal'}) {
7422: $result.=&modal_window();
7423: }
7424: if ($args->{'add_wishlist'}) {
7425: $result.=&wishlist_window();
7426: }
1.1038 www 7427: if ($args->{'add_togglebox'}) {
7428: $result.=&togglebox_script();
7429: }
1.1041 www 7430: if ($args->{'add_progressbar'}) {
7431: $result.=&LCprogressbarUpdate_script();
7432: }
1.436 albertel 7433: }
1.314 albertel 7434: if (ref($args->{'redirect'})) {
1.414 albertel 7435: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 7436: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 7437: if (!$inhibit_continue) {
7438: $env{'internal.head.redirect'} = $url;
7439: }
1.313 albertel 7440: $result.=<<ADDMETA
7441: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 7442: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 7443: ADDMETA
1.1075.2.89 raeburn 7444: } else {
7445: unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
7446: my $requrl = $env{'request.uri'};
7447: if ($requrl eq '') {
7448: $requrl = $ENV{'REQUEST_URI'};
7449: $requrl =~ s/\?.+$//;
7450: }
7451: unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
7452: (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
7453: ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
7454: my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
7455: unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
7456: my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
7457: if (ref($domdefs{'offloadnow'}) eq 'HASH') {
7458: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
7459: if ($domdefs{'offloadnow'}{$lonhost}) {
7460: my $newserver = &Apache::lonnet::spareserver(30000,undef,1,$dom_in_use);
7461: if (($newserver) && ($newserver ne $lonhost)) {
7462: my $numsec = 5;
7463: my $timeout = $numsec * 1000;
7464: my ($newurl,$locknum,%locks,$msg);
7465: if ($env{'request.role.adv'}) {
7466: ($locknum,%locks) = &Apache::lonnet::get_locks();
7467: }
7468: my $disable_submit = 0;
7469: if ($requrl =~ /$LONCAPA::assess_re/) {
7470: $disable_submit = 1;
7471: }
7472: if ($locknum) {
7473: my @lockinfo = sort(values(%locks));
7474: $msg = &mt('Once the following tasks are complete: ')."\\n".
7475: join(", ",sort(values(%locks)))."\\n".
7476: &mt('your session will be transferred to a different server, after you click "Roles".');
7477: } else {
7478: if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
7479: $msg = &mt('Your LON-CAPA submission has been recorded')."\\n";
7480: }
7481: $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
7482: $newurl = '/adm/switchserver?otherserver='.$newserver;
7483: if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
7484: $newurl .= '&role='.$env{'request.role'};
7485: }
7486: if ($env{'request.symb'}) {
7487: $newurl .= '&symb='.$env{'request.symb'};
7488: } else {
7489: $newurl .= '&origurl='.$requrl;
7490: }
7491: }
7492: $result.=<<OFFLOAD
7493: <meta http-equiv="pragma" content="no-cache" />
7494: <script type="text/javascript">
1.1075.2.92 raeburn 7495: // <![CDATA[
1.1075.2.89 raeburn 7496: function LC_Offload_Now() {
7497: var dest = "$newurl";
7498: if (dest != '') {
7499: window.location.href="$newurl";
7500: }
7501: }
1.1075.2.92 raeburn 7502: \$(document).ready(function () {
7503: window.alert('$msg');
7504: if ($disable_submit) {
1.1075.2.89 raeburn 7505: \$(".LC_hwk_submit").prop("disabled", true);
7506: \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1075.2.92 raeburn 7507: }
7508: setTimeout('LC_Offload_Now()', $timeout);
7509: });
7510: // ]]>
1.1075.2.89 raeburn 7511: </script>
7512: OFFLOAD
7513: }
7514: }
7515: }
7516: }
7517: }
7518: }
1.313 albertel 7519: }
1.306 albertel 7520: if (!defined($title)) {
7521: $title = 'The LearningOnline Network with CAPA';
7522: }
1.460 albertel 7523: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
7524: $result .= '<title> LON-CAPA '.$title.'</title>'
1.1075.2.61 raeburn 7525: .'<link rel="stylesheet" type="text/css" href="'.$url.'"';
7526: if (!$args->{'frameset'}) {
7527: $result .= ' /';
7528: }
7529: $result .= '>'
1.1064 raeburn 7530: .$inhibitprint
1.414 albertel 7531: .$head_extra;
1.1075.2.42 raeburn 7532: if ($env{'browser.mobile'}) {
7533: $result .= '
7534: <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=0, minimum-scale=1.0, maximum-scale=1.0">
7535: <meta name="apple-mobile-web-app-capable" content="yes" />';
7536: }
1.962 droeschl 7537: return $result.'</head>';
1.306 albertel 7538: }
7539:
7540: =pod
7541:
1.340 albertel 7542: =item * &font_settings()
7543:
7544: Returns neccessary <meta> to set the proper encoding
7545:
1.1075.2.56 raeburn 7546: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340 albertel 7547:
7548: =cut
7549:
7550: sub font_settings {
1.1075.2.56 raeburn 7551: my ($args) = @_;
1.340 albertel 7552: my $headerstring='';
1.1075.2.56 raeburn 7553: if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
7554: ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.340 albertel 7555: $headerstring.=
1.1075.2.61 raeburn 7556: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
7557: if (!$args->{'frameset'}) {
7558: $headerstring.= ' /';
7559: }
7560: $headerstring .= '>'."\n";
1.340 albertel 7561: }
7562: return $headerstring;
7563: }
7564:
1.341 albertel 7565: =pod
7566:
1.1064 raeburn 7567: =item * &print_suppression()
7568:
7569: In course context returns css which causes the body to be blank when media="print",
7570: if printout generation is unavailable for the current resource.
7571:
7572: This could be because:
7573:
7574: (a) printstartdate is in the future
7575:
7576: (b) printenddate is in the past
7577:
7578: (c) there is an active exam block with "printout"
7579: functionality blocked
7580:
7581: Users with pav, pfo or evb privileges are exempt.
7582:
7583: Inputs: none
7584:
7585: =cut
7586:
7587:
7588: sub print_suppression {
7589: my $noprint;
7590: if ($env{'request.course.id'}) {
7591: my $scope = $env{'request.course.id'};
7592: if ((&Apache::lonnet::allowed('pav',$scope)) ||
7593: (&Apache::lonnet::allowed('pfo',$scope))) {
7594: return;
7595: }
7596: if ($env{'request.course.sec'} ne '') {
7597: $scope .= "/$env{'request.course.sec'}";
7598: if ((&Apache::lonnet::allowed('pav',$scope)) ||
7599: (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065 raeburn 7600: return;
1.1064 raeburn 7601: }
7602: }
7603: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7604: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1075.2.73 raeburn 7605: my $blocked = &blocking_status('printout',$cnum,$cdom,undef,1);
1.1064 raeburn 7606: if ($blocked) {
7607: my $checkrole = "cm./$cdom/$cnum";
7608: if ($env{'request.course.sec'} ne '') {
7609: $checkrole .= "/$env{'request.course.sec'}";
7610: }
7611: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
7612: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
7613: $noprint = 1;
7614: }
7615: }
7616: unless ($noprint) {
7617: my $symb = &Apache::lonnet::symbread();
7618: if ($symb ne '') {
7619: my $navmap = Apache::lonnavmaps::navmap->new();
7620: if (ref($navmap)) {
7621: my $res = $navmap->getBySymb($symb);
7622: if (ref($res)) {
7623: if (!$res->resprintable()) {
7624: $noprint = 1;
7625: }
7626: }
7627: }
7628: }
7629: }
7630: if ($noprint) {
7631: return <<"ENDSTYLE";
7632: <style type="text/css" media="print">
7633: body { display:none }
7634: </style>
7635: ENDSTYLE
7636: }
7637: }
7638: return;
7639: }
7640:
7641: =pod
7642:
1.341 albertel 7643: =item * &xml_begin()
7644:
7645: Returns the needed doctype and <html>
7646:
7647: Inputs: none
7648:
7649: =cut
7650:
7651: sub xml_begin {
1.1075.2.61 raeburn 7652: my ($is_frameset) = @_;
1.341 albertel 7653: my $output='';
7654:
7655: if ($env{'browser.mathml'}) {
7656: $output='<?xml version="1.0"?>'
7657: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
7658: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
7659:
7660: # .'<!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">] >'
7661: .'<!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">'
7662: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
7663: .'xmlns="http://www.w3.org/1999/xhtml">';
1.1075.2.61 raeburn 7664: } elsif ($is_frameset) {
7665: $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
7666: '<html>'."\n";
1.341 albertel 7667: } else {
1.1075.2.61 raeburn 7668: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
7669: '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341 albertel 7670: }
7671: return $output;
7672: }
1.340 albertel 7673:
7674: =pod
7675:
1.306 albertel 7676: =item * &start_page()
7677:
7678: Returns a complete <html> .. <body> section for LON-CAPA web pages.
7679:
1.648 raeburn 7680: Inputs:
7681:
7682: =over 4
7683:
7684: $title - optional title for the page
7685:
7686: $head_extra - optional extra HTML to incude inside the <head>
7687:
7688: $args - additional optional args supported are:
7689:
7690: =over 8
7691:
7692: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 7693: arg on
1.814 bisitz 7694: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 7695: add_entries -> additional attributes to add to the <body>
7696: domain -> force to color decorate a page for a
1.317 albertel 7697: specific domain
1.648 raeburn 7698: function -> force usage of a specific rolish color
1.317 albertel 7699: scheme
1.648 raeburn 7700: redirect -> see &headtag()
7701: bgcolor -> override the default page bg color
7702: js_ready -> return a string ready for being used in
1.317 albertel 7703: a javascript writeln
1.648 raeburn 7704: html_encode -> return a string ready for being used in
1.320 albertel 7705: a html attribute
1.648 raeburn 7706: force_register -> if is true will turn on the &bodytag()
1.317 albertel 7707: $forcereg arg
1.648 raeburn 7708: frameset -> if true will start with a <frameset>
1.330 albertel 7709: rather than <body>
1.648 raeburn 7710: skip_phases -> hash ref of
1.338 albertel 7711: head -> skip the <html><head> generation
7712: body -> skip all <body> generation
1.1075.2.12 raeburn 7713: no_inline_link -> if true and in remote mode, don't show the
7714: 'Switch To Inline Menu' link
1.648 raeburn 7715: no_auto_mt_title -> prevent &mt()ing the title arg
7716: inherit_jsmath -> when creating popup window in a page,
7717: should it have jsmath forced on by the
7718: current page
1.867 kalberla 7719: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 7720: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.1075.2.15 raeburn 7721: group -> includes the current group, if page is for a
7722: specific group
1.361 albertel 7723:
1.648 raeburn 7724: =back
1.460 albertel 7725:
1.648 raeburn 7726: =back
1.562 albertel 7727:
1.306 albertel 7728: =cut
7729:
7730: sub start_page {
1.309 albertel 7731: my ($title,$head_extra,$args) = @_;
1.318 albertel 7732: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319 albertel 7733:
1.315 albertel 7734: $env{'internal.start_page'}++;
1.1075.2.15 raeburn 7735: my ($result,@advtools);
1.964 droeschl 7736:
1.338 albertel 7737: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1075.2.62 raeburn 7738: $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338 albertel 7739: }
7740:
7741: if (! exists($args->{'skip_phases'}{'body'}) ) {
7742: if ($args->{'frameset'}) {
7743: my $attr_string = &make_attr_string($args->{'force_register'},
7744: $args->{'add_entries'});
7745: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 7746: } else {
7747: $result .=
7748: &bodytag($title,
7749: $args->{'function'}, $args->{'add_entries'},
7750: $args->{'only_body'}, $args->{'domain'},
7751: $args->{'force_register'}, $args->{'no_nav_bar'},
1.1075.2.12 raeburn 7752: $args->{'bgcolor'}, $args->{'no_inline_link'},
1.1075.2.15 raeburn 7753: $args, \@advtools);
1.831 bisitz 7754: }
1.330 albertel 7755: }
1.338 albertel 7756:
1.315 albertel 7757: if ($args->{'js_ready'}) {
1.713 kaisler 7758: $result = &js_ready($result);
1.315 albertel 7759: }
1.320 albertel 7760: if ($args->{'html_encode'}) {
1.713 kaisler 7761: $result = &html_encode($result);
7762: }
7763:
1.813 bisitz 7764: # Preparation for new and consistent functionlist at top of screen
7765: # if ($args->{'functionlist'}) {
7766: # $result .= &build_functionlist();
7767: #}
7768:
1.964 droeschl 7769: # Don't add anything more if only_body wanted or in const space
7770: return $result if $args->{'only_body'}
7771: || $env{'request.state'} eq 'construct';
1.813 bisitz 7772:
7773: #Breadcrumbs
1.758 kaisler 7774: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
7775: &Apache::lonhtmlcommon::clear_breadcrumbs();
7776: #if any br links exists, add them to the breadcrumbs
7777: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
7778: foreach my $crumb (@{$args->{'bread_crumbs'}}){
7779: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
7780: }
7781: }
1.1075.2.19 raeburn 7782: # if @advtools array contains items add then to the breadcrumbs
7783: if (@advtools > 0) {
7784: &Apache::lonmenu::advtools_crumbs(@advtools);
7785: }
1.758 kaisler 7786:
7787: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
7788: if(exists($args->{'bread_crumbs_component'})){
7789: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
7790: }else{
7791: $result .= &Apache::lonhtmlcommon::breadcrumbs();
7792: }
1.1075.2.24 raeburn 7793: } elsif (($env{'environment.remote'} eq 'on') &&
7794: ($env{'form.inhibitmenu'} ne 'yes') &&
7795: ($env{'request.noversionuri'} =~ m{^/res/}) &&
7796: ($env{'request.noversionuri'} !~ m{^/res/adm/pages/})) {
1.1075.2.21 raeburn 7797: $result .= '<div style="padding:0;margin:0;clear:both"><hr /></div>';
1.320 albertel 7798: }
1.315 albertel 7799: return $result;
1.306 albertel 7800: }
7801:
7802: sub end_page {
1.315 albertel 7803: my ($args) = @_;
7804: $env{'internal.end_page'}++;
1.330 albertel 7805: my $result;
1.335 albertel 7806: if ($args->{'discussion'}) {
7807: my ($target,$parser);
7808: if (ref($args->{'discussion'})) {
7809: ($target,$parser) =($args->{'discussion'}{'target'},
7810: $args->{'discussion'}{'parser'});
7811: }
7812: $result .= &Apache::lonxml::xmlend($target,$parser);
7813: }
1.330 albertel 7814: if ($args->{'frameset'}) {
7815: $result .= '</frameset>';
7816: } else {
1.635 raeburn 7817: $result .= &endbodytag($args);
1.330 albertel 7818: }
1.1075.2.6 raeburn 7819: unless ($args->{'notbody'}) {
7820: $result .= "\n</html>";
7821: }
1.330 albertel 7822:
1.315 albertel 7823: if ($args->{'js_ready'}) {
1.317 albertel 7824: $result = &js_ready($result);
1.315 albertel 7825: }
1.335 albertel 7826:
1.320 albertel 7827: if ($args->{'html_encode'}) {
7828: $result = &html_encode($result);
7829: }
1.335 albertel 7830:
1.315 albertel 7831: return $result;
7832: }
7833:
1.1034 www 7834: sub wishlist_window {
7835: return(<<'ENDWISHLIST');
1.1046 raeburn 7836: <script type="text/javascript">
1.1034 www 7837: // <![CDATA[
7838: // <!-- BEGIN LON-CAPA Internal
7839: function set_wishlistlink(title, path) {
7840: if (!title) {
7841: title = document.title;
7842: title = title.replace(/^LON-CAPA /,'');
7843: }
1.1075.2.65 raeburn 7844: title = encodeURIComponent(title);
1.1075.2.83 raeburn 7845: title = title.replace("'","\\\'");
1.1034 www 7846: if (!path) {
7847: path = location.pathname;
7848: }
1.1075.2.65 raeburn 7849: path = encodeURIComponent(path);
1.1075.2.83 raeburn 7850: path = path.replace("'","\\\'");
1.1034 www 7851: Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
7852: 'wishlistNewLink','width=560,height=350,scrollbars=0');
7853: }
7854: // END LON-CAPA Internal -->
7855: // ]]>
7856: </script>
7857: ENDWISHLIST
7858: }
7859:
1.1030 www 7860: sub modal_window {
7861: return(<<'ENDMODAL');
1.1046 raeburn 7862: <script type="text/javascript">
1.1030 www 7863: // <![CDATA[
7864: // <!-- BEGIN LON-CAPA Internal
7865: var modalWindow = {
7866: parent:"body",
7867: windowId:null,
7868: content:null,
7869: width:null,
7870: height:null,
7871: close:function()
7872: {
7873: $(".LCmodal-window").remove();
7874: $(".LCmodal-overlay").remove();
7875: },
7876: open:function()
7877: {
7878: var modal = "";
7879: modal += "<div class=\"LCmodal-overlay\"></div>";
7880: 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;\">";
7881: modal += this.content;
7882: modal += "</div>";
7883:
7884: $(this.parent).append(modal);
7885:
7886: $(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
7887: $(".LCclose-window").click(function(){modalWindow.close();});
7888: $(".LCmodal-overlay").click(function(){modalWindow.close();});
7889: }
7890: };
1.1075.2.42 raeburn 7891: var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030 www 7892: {
1.1075.2.83 raeburn 7893: source = source.replace("'","'");
1.1030 www 7894: modalWindow.windowId = "myModal";
7895: modalWindow.width = width;
7896: modalWindow.height = height;
1.1075.2.80 raeburn 7897: modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030 www 7898: modalWindow.open();
1.1075.2.87 raeburn 7899: };
1.1030 www 7900: // END LON-CAPA Internal -->
7901: // ]]>
7902: </script>
7903: ENDMODAL
7904: }
7905:
7906: sub modal_link {
1.1075.2.42 raeburn 7907: my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030 www 7908: unless ($width) { $width=480; }
7909: unless ($height) { $height=400; }
1.1031 www 7910: unless ($scrolling) { $scrolling='yes'; }
1.1075.2.42 raeburn 7911: unless ($transparency) { $transparency='true'; }
7912:
1.1074 raeburn 7913: my $target_attr;
7914: if (defined($target)) {
7915: $target_attr = 'target="'.$target.'"';
7916: }
7917: return <<"ENDLINK";
1.1075.2.42 raeburn 7918: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">
1.1074 raeburn 7919: $linktext</a>
7920: ENDLINK
1.1030 www 7921: }
7922:
1.1032 www 7923: sub modal_adhoc_script {
7924: my ($funcname,$width,$height,$content)=@_;
7925: return (<<ENDADHOC);
1.1046 raeburn 7926: <script type="text/javascript">
1.1032 www 7927: // <![CDATA[
7928: var $funcname = function()
7929: {
7930: modalWindow.windowId = "myModal";
7931: modalWindow.width = $width;
7932: modalWindow.height = $height;
7933: modalWindow.content = '$content';
7934: modalWindow.open();
7935: };
7936: // ]]>
7937: </script>
7938: ENDADHOC
7939: }
7940:
1.1041 www 7941: sub modal_adhoc_inner {
7942: my ($funcname,$width,$height,$content)=@_;
7943: my $innerwidth=$width-20;
7944: $content=&js_ready(
1.1042 www 7945: &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
1.1075.2.42 raeburn 7946: &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
7947: $content.
1.1041 www 7948: &end_scrollbox().
1.1075.2.42 raeburn 7949: &end_page()
1.1041 www 7950: );
7951: return &modal_adhoc_script($funcname,$width,$height,$content);
7952: }
7953:
7954: sub modal_adhoc_window {
7955: my ($funcname,$width,$height,$content,$linktext)=@_;
7956: return &modal_adhoc_inner($funcname,$width,$height,$content).
7957: "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
7958: }
7959:
7960: sub modal_adhoc_launch {
7961: my ($funcname,$width,$height,$content)=@_;
7962: return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
7963: <script type="text/javascript">
7964: // <![CDATA[
7965: $funcname();
7966: // ]]>
7967: </script>
7968: ENDLAUNCH
7969: }
7970:
7971: sub modal_adhoc_close {
7972: return (<<ENDCLOSE);
7973: <script type="text/javascript">
7974: // <![CDATA[
7975: modalWindow.close();
7976: // ]]>
7977: </script>
7978: ENDCLOSE
7979: }
7980:
1.1038 www 7981: sub togglebox_script {
7982: return(<<ENDTOGGLE);
7983: <script type="text/javascript">
7984: // <![CDATA[
7985: function LCtoggleDisplay(id,hidetext,showtext) {
7986: link = document.getElementById(id + "link").childNodes[0];
7987: with (document.getElementById(id).style) {
7988: if (display == "none" ) {
7989: display = "inline";
7990: link.nodeValue = hidetext;
7991: } else {
7992: display = "none";
7993: link.nodeValue = showtext;
7994: }
7995: }
7996: }
7997: // ]]>
7998: </script>
7999: ENDTOGGLE
8000: }
8001:
1.1039 www 8002: sub start_togglebox {
8003: my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
8004: unless ($heading) { $heading=''; } else { $heading.=' '; }
8005: unless ($showtext) { $showtext=&mt('show'); }
8006: unless ($hidetext) { $hidetext=&mt('hide'); }
8007: unless ($headerbg) { $headerbg='#FFFFFF'; }
8008: return &start_data_table().
8009: &start_data_table_header_row().
8010: '<td bgcolor="'.$headerbg.'">'.$heading.
8011: '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
8012: $showtext.'\')">'.$showtext.'</a>]</td>'.
8013: &end_data_table_header_row().
8014: '<tr id="'.$id.'" style="display:none""><td>';
8015: }
8016:
8017: sub end_togglebox {
8018: return '</td></tr>'.&end_data_table();
8019: }
8020:
1.1041 www 8021: sub LCprogressbar_script {
1.1045 www 8022: my ($id)=@_;
1.1041 www 8023: return(<<ENDPROGRESS);
8024: <script type="text/javascript">
8025: // <![CDATA[
1.1045 www 8026: \$('#progressbar$id').progressbar({
1.1041 www 8027: value: 0,
8028: change: function(event, ui) {
8029: var newVal = \$(this).progressbar('option', 'value');
8030: \$('.pblabel', this).text(LCprogressTxt);
8031: }
8032: });
8033: // ]]>
8034: </script>
8035: ENDPROGRESS
8036: }
8037:
8038: sub LCprogressbarUpdate_script {
8039: return(<<ENDPROGRESSUPDATE);
8040: <style type="text/css">
8041: .ui-progressbar { position:relative; }
8042: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
8043: </style>
8044: <script type="text/javascript">
8045: // <![CDATA[
1.1045 www 8046: var LCprogressTxt='---';
8047:
8048: function LCupdateProgress(percent,progresstext,id) {
1.1041 www 8049: LCprogressTxt=progresstext;
1.1045 www 8050: \$('#progressbar'+id).progressbar('value',percent);
1.1041 www 8051: }
8052: // ]]>
8053: </script>
8054: ENDPROGRESSUPDATE
8055: }
8056:
1.1042 www 8057: my $LClastpercent;
1.1045 www 8058: my $LCidcnt;
8059: my $LCcurrentid;
1.1042 www 8060:
1.1041 www 8061: sub LCprogressbar {
1.1042 www 8062: my ($r)=(@_);
8063: $LClastpercent=0;
1.1045 www 8064: $LCidcnt++;
8065: $LCcurrentid=$$.'_'.$LCidcnt;
1.1041 www 8066: my $starting=&mt('Starting');
8067: my $content=(<<ENDPROGBAR);
1.1045 www 8068: <div id="progressbar$LCcurrentid">
1.1041 www 8069: <span class="pblabel">$starting</span>
8070: </div>
8071: ENDPROGBAR
1.1045 www 8072: &r_print($r,$content.&LCprogressbar_script($LCcurrentid));
1.1041 www 8073: }
8074:
8075: sub LCprogressbarUpdate {
1.1042 www 8076: my ($r,$val,$text)=@_;
8077: unless ($val) {
8078: if ($LClastpercent) {
8079: $val=$LClastpercent;
8080: } else {
8081: $val=0;
8082: }
8083: }
1.1041 www 8084: if ($val<0) { $val=0; }
8085: if ($val>100) { $val=0; }
1.1042 www 8086: $LClastpercent=$val;
1.1041 www 8087: unless ($text) { $text=$val.'%'; }
8088: $text=&js_ready($text);
1.1044 www 8089: &r_print($r,<<ENDUPDATE);
1.1041 www 8090: <script type="text/javascript">
8091: // <![CDATA[
1.1045 www 8092: LCupdateProgress($val,'$text','$LCcurrentid');
1.1041 www 8093: // ]]>
8094: </script>
8095: ENDUPDATE
1.1035 www 8096: }
8097:
1.1042 www 8098: sub LCprogressbarClose {
8099: my ($r)=@_;
8100: $LClastpercent=0;
1.1044 www 8101: &r_print($r,<<ENDCLOSE);
1.1042 www 8102: <script type="text/javascript">
8103: // <![CDATA[
1.1045 www 8104: \$("#progressbar$LCcurrentid").hide('slow');
1.1042 www 8105: // ]]>
8106: </script>
8107: ENDCLOSE
1.1044 www 8108: }
8109:
8110: sub r_print {
8111: my ($r,$to_print)=@_;
8112: if ($r) {
8113: $r->print($to_print);
8114: $r->rflush();
8115: } else {
8116: print($to_print);
8117: }
1.1042 www 8118: }
8119:
1.320 albertel 8120: sub html_encode {
8121: my ($result) = @_;
8122:
1.322 albertel 8123: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 8124:
8125: return $result;
8126: }
1.1044 www 8127:
1.317 albertel 8128: sub js_ready {
8129: my ($result) = @_;
8130:
1.323 albertel 8131: $result =~ s/[\n\r]/ /xmsg;
8132: $result =~ s/\\/\\\\/xmsg;
8133: $result =~ s/'/\\'/xmsg;
1.372 albertel 8134: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 8135:
8136: return $result;
8137: }
8138:
1.315 albertel 8139: sub validate_page {
8140: if ( exists($env{'internal.start_page'})
1.316 albertel 8141: && $env{'internal.start_page'} > 1) {
8142: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 8143: $env{'internal.start_page'}.' '.
1.316 albertel 8144: $ENV{'request.filename'});
1.315 albertel 8145: }
8146: if ( exists($env{'internal.end_page'})
1.316 albertel 8147: && $env{'internal.end_page'} > 1) {
8148: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 8149: $env{'internal.end_page'}.' '.
1.316 albertel 8150: $env{'request.filename'});
1.315 albertel 8151: }
8152: if ( exists($env{'internal.start_page'})
8153: && ! exists($env{'internal.end_page'})) {
1.316 albertel 8154: &Apache::lonnet::logthis('start_page called without end_page '.
8155: $env{'request.filename'});
1.315 albertel 8156: }
8157: if ( ! exists($env{'internal.start_page'})
8158: && exists($env{'internal.end_page'})) {
1.316 albertel 8159: &Apache::lonnet::logthis('end_page called without start_page'.
8160: $env{'request.filename'});
1.315 albertel 8161: }
1.306 albertel 8162: }
1.315 albertel 8163:
1.996 www 8164:
8165: sub start_scrollbox {
1.1075.2.56 raeburn 8166: my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998 raeburn 8167: unless ($outerwidth) { $outerwidth='520px'; }
8168: unless ($width) { $width='500px'; }
8169: unless ($height) { $height='200px'; }
1.1075 raeburn 8170: my ($table_id,$div_id,$tdcol);
1.1018 raeburn 8171: if ($id ne '') {
1.1075.2.42 raeburn 8172: $table_id = ' id="table_'.$id.'"';
8173: $div_id = ' id="div_'.$id.'"';
1.1018 raeburn 8174: }
1.1075 raeburn 8175: if ($bgcolor ne '') {
8176: $tdcol = "background-color: $bgcolor;";
8177: }
1.1075.2.42 raeburn 8178: my $nicescroll_js;
8179: if ($env{'browser.mobile'}) {
8180: $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
8181: }
1.1075 raeburn 8182: return <<"END";
1.1075.2.42 raeburn 8183: $nicescroll_js
8184:
8185: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
1.1075.2.56 raeburn 8186: <div style="overflow:auto; width:$width; height:$height;"$div_id>
1.1075 raeburn 8187: END
1.996 www 8188: }
8189:
8190: sub end_scrollbox {
1.1036 www 8191: return '</div></td></tr></table>';
1.996 www 8192: }
8193:
1.1075.2.42 raeburn 8194: sub nicescroll_javascript {
8195: my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
8196: my %options;
8197: if (ref($cursor) eq 'HASH') {
8198: %options = %{$cursor};
8199: }
8200: unless ($options{'railalign'} =~ /^left|right$/) {
8201: $options{'railalign'} = 'left';
8202: }
8203: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
8204: my $function = &get_users_function();
8205: $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
8206: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
8207: $options{'cursorcolor'} = '#00F';
8208: }
8209: }
8210: if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
8211: unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
8212: $options{'cursoropacity'}='1.0';
8213: }
8214: } else {
8215: $options{'cursoropacity'}='1.0';
8216: }
8217: if ($options{'cursorfixedheight'} eq 'none') {
8218: delete($options{'cursorfixedheight'});
8219: } else {
8220: unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
8221: }
8222: unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
8223: delete($options{'railoffset'});
8224: }
8225: my @niceoptions;
8226: while (my($key,$value) = each(%options)) {
8227: if ($value =~ /^\{.+\}$/) {
8228: push(@niceoptions,$key.':'.$value);
8229: } else {
8230: push(@niceoptions,$key.':"'.$value.'"');
8231: }
8232: }
8233: my $nicescroll_js = '
8234: $(document).ready(
8235: function() {
8236: $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
8237: }
8238: );
8239: ';
8240: if ($framecheck) {
8241: $nicescroll_js .= '
8242: function expand_div(caller) {
8243: if (top === self) {
8244: document.getElementById("'.$id.'").style.width = "auto";
8245: document.getElementById("'.$id.'").style.height = "auto";
8246: } else {
8247: try {
8248: if (parent.frames) {
8249: if (parent.frames.length > 1) {
8250: var framesrc = parent.frames[1].location.href;
8251: var currsrc = framesrc.replace(/\#.*$/,"");
8252: if ((caller == "search") || (currsrc == "'.$location.'")) {
8253: document.getElementById("'.$id.'").style.width = "auto";
8254: document.getElementById("'.$id.'").style.height = "auto";
8255: }
8256: }
8257: }
8258: } catch (e) {
8259: return;
8260: }
8261: }
8262: return;
8263: }
8264: ';
8265: }
8266: if ($needjsready) {
8267: $nicescroll_js = '
8268: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
8269: } else {
8270: $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
8271: }
8272: return $nicescroll_js;
8273: }
8274:
1.318 albertel 8275: sub simple_error_page {
1.1075.2.49 raeburn 8276: my ($r,$title,$msg,$args) = @_;
8277: if (ref($args) eq 'HASH') {
8278: if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
8279: } else {
8280: $msg = &mt($msg);
8281: }
8282:
1.318 albertel 8283: my $page =
8284: &Apache::loncommon::start_page($title).
1.1075.2.49 raeburn 8285: '<p class="LC_error">'.$msg.'</p>'.
1.318 albertel 8286: &Apache::loncommon::end_page();
8287: if (ref($r)) {
8288: $r->print($page);
1.327 albertel 8289: return;
1.318 albertel 8290: }
8291: return $page;
8292: }
1.347 albertel 8293:
8294: {
1.610 albertel 8295: my @row_count;
1.961 onken 8296:
8297: sub start_data_table_count {
8298: unshift(@row_count, 0);
8299: return;
8300: }
8301:
8302: sub end_data_table_count {
8303: shift(@row_count);
8304: return;
8305: }
8306:
1.347 albertel 8307: sub start_data_table {
1.1018 raeburn 8308: my ($add_class,$id) = @_;
1.422 albertel 8309: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 8310: my $table_id;
8311: if (defined($id)) {
8312: $table_id = ' id="'.$id.'"';
8313: }
1.961 onken 8314: &start_data_table_count();
1.1018 raeburn 8315: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 8316: }
8317:
8318: sub end_data_table {
1.961 onken 8319: &end_data_table_count();
1.389 albertel 8320: return '</table>'."\n";;
1.347 albertel 8321: }
8322:
8323: sub start_data_table_row {
1.974 wenzelju 8324: my ($add_class, $id) = @_;
1.610 albertel 8325: $row_count[0]++;
8326: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 8327: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 8328: $id = (' id="'.$id.'"') unless ($id eq '');
8329: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 8330: }
1.471 banghart 8331:
8332: sub continue_data_table_row {
1.974 wenzelju 8333: my ($add_class, $id) = @_;
1.610 albertel 8334: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 8335: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
8336: $id = (' id="'.$id.'"') unless ($id eq '');
8337: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 8338: }
1.347 albertel 8339:
8340: sub end_data_table_row {
1.389 albertel 8341: return '</tr>'."\n";;
1.347 albertel 8342: }
1.367 www 8343:
1.421 albertel 8344: sub start_data_table_empty_row {
1.707 bisitz 8345: # $row_count[0]++;
1.421 albertel 8346: return '<tr class="LC_empty_row" >'."\n";;
8347: }
8348:
8349: sub end_data_table_empty_row {
8350: return '</tr>'."\n";;
8351: }
8352:
1.367 www 8353: sub start_data_table_header_row {
1.389 albertel 8354: return '<tr class="LC_header_row">'."\n";;
1.367 www 8355: }
8356:
8357: sub end_data_table_header_row {
1.389 albertel 8358: return '</tr>'."\n";;
1.367 www 8359: }
1.890 droeschl 8360:
8361: sub data_table_caption {
8362: my $caption = shift;
8363: return "<caption class=\"LC_caption\">$caption</caption>";
8364: }
1.347 albertel 8365: }
8366:
1.548 albertel 8367: =pod
8368:
8369: =item * &inhibit_menu_check($arg)
8370:
8371: Checks for a inhibitmenu state and generates output to preserve it
8372:
8373: Inputs: $arg - can be any of
8374: - undef - in which case the return value is a string
8375: to add into arguments list of a uri
8376: - 'input' - in which case the return value is a HTML
8377: <form> <input> field of type hidden to
8378: preserve the value
8379: - a url - in which case the return value is the url with
8380: the neccesary cgi args added to preserve the
8381: inhibitmenu state
8382: - a ref to a url - no return value, but the string is
8383: updated to include the neccessary cgi
8384: args to preserve the inhibitmenu state
8385:
8386: =cut
8387:
8388: sub inhibit_menu_check {
8389: my ($arg) = @_;
8390: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
8391: if ($arg eq 'input') {
8392: if ($env{'form.inhibitmenu'}) {
8393: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
8394: } else {
8395: return
8396: }
8397: }
8398: if ($env{'form.inhibitmenu'}) {
8399: if (ref($arg)) {
8400: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
8401: } elsif ($arg eq '') {
8402: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
8403: } else {
8404: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
8405: }
8406: }
8407: if (!ref($arg)) {
8408: return $arg;
8409: }
8410: }
8411:
1.251 albertel 8412: ###############################################
1.182 matthew 8413:
8414: =pod
8415:
1.549 albertel 8416: =back
8417:
8418: =head1 User Information Routines
8419:
8420: =over 4
8421:
1.405 albertel 8422: =item * &get_users_function()
1.182 matthew 8423:
8424: Used by &bodytag to determine the current users primary role.
8425: Returns either 'student','coordinator','admin', or 'author'.
8426:
8427: =cut
8428:
8429: ###############################################
8430: sub get_users_function {
1.815 tempelho 8431: my $function = 'norole';
1.818 tempelho 8432: if ($env{'request.role'}=~/^(st)/) {
8433: $function='student';
8434: }
1.907 raeburn 8435: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 8436: $function='coordinator';
8437: }
1.258 albertel 8438: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 8439: $function='admin';
8440: }
1.826 bisitz 8441: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025 raeburn 8442: ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182 matthew 8443: $function='author';
8444: }
8445: return $function;
1.54 www 8446: }
1.99 www 8447:
8448: ###############################################
8449:
1.233 raeburn 8450: =pod
8451:
1.821 raeburn 8452: =item * &show_course()
8453:
8454: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
8455: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
8456:
8457: Inputs:
8458: None
8459:
8460: Outputs:
8461: Scalar: 1 if 'Course' to be used, 0 otherwise.
8462:
8463: =cut
8464:
8465: ###############################################
8466: sub show_course {
8467: my $course = !$env{'user.adv'};
8468: if (!$env{'user.adv'}) {
8469: foreach my $env (keys(%env)) {
8470: next if ($env !~ m/^user\.priv\./);
8471: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
8472: $course = 0;
8473: last;
8474: }
8475: }
8476: }
8477: return $course;
8478: }
8479:
8480: ###############################################
8481:
8482: =pod
8483:
1.542 raeburn 8484: =item * &check_user_status()
1.274 raeburn 8485:
8486: Determines current status of supplied role for a
8487: specific user. Roles can be active, previous or future.
8488:
8489: Inputs:
8490: user's domain, user's username, course's domain,
1.375 raeburn 8491: course's number, optional section ID.
1.274 raeburn 8492:
8493: Outputs:
8494: role status: active, previous or future.
8495:
8496: =cut
8497:
8498: sub check_user_status {
1.412 raeburn 8499: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073 raeburn 8500: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1075.2.85 raeburn 8501: my @uroles = keys(%userinfo);
1.274 raeburn 8502: my $srchstr;
8503: my $active_chk = 'none';
1.412 raeburn 8504: my $now = time;
1.274 raeburn 8505: if (@uroles > 0) {
1.908 raeburn 8506: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 8507: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
8508: } else {
1.412 raeburn 8509: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
8510: }
8511: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 8512: my $role_end = 0;
8513: my $role_start = 0;
8514: $active_chk = 'active';
1.412 raeburn 8515: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
8516: $role_end = $1;
8517: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
8518: $role_start = $1;
1.274 raeburn 8519: }
8520: }
8521: if ($role_start > 0) {
1.412 raeburn 8522: if ($now < $role_start) {
1.274 raeburn 8523: $active_chk = 'future';
8524: }
8525: }
8526: if ($role_end > 0) {
1.412 raeburn 8527: if ($now > $role_end) {
1.274 raeburn 8528: $active_chk = 'previous';
8529: }
8530: }
8531: }
8532: }
8533: return $active_chk;
8534: }
8535:
8536: ###############################################
8537:
8538: =pod
8539:
1.405 albertel 8540: =item * &get_sections()
1.233 raeburn 8541:
8542: Determines all the sections for a course including
8543: sections with students and sections containing other roles.
1.419 raeburn 8544: Incoming parameters:
8545:
8546: 1. domain
8547: 2. course number
8548: 3. reference to array containing roles for which sections should
8549: be gathered (optional).
8550: 4. reference to array containing status types for which sections
8551: should be gathered (optional).
8552:
8553: If the third argument is undefined, sections are gathered for any role.
8554: If the fourth argument is undefined, sections are gathered for any status.
8555: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 8556:
1.374 raeburn 8557: Returns section hash (keys are section IDs, values are
8558: number of users in each section), subject to the
1.419 raeburn 8559: optional roles filter, optional status filter
1.233 raeburn 8560:
8561: =cut
8562:
8563: ###############################################
8564: sub get_sections {
1.419 raeburn 8565: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 8566: if (!defined($cdom) || !defined($cnum)) {
8567: my $cid = $env{'request.course.id'};
8568:
8569: return if (!defined($cid));
8570:
8571: $cdom = $env{'course.'.$cid.'.domain'};
8572: $cnum = $env{'course.'.$cid.'.num'};
8573: }
8574:
8575: my %sectioncount;
1.419 raeburn 8576: my $now = time;
1.240 albertel 8577:
1.1075.2.33 raeburn 8578: my $check_students = 1;
8579: my $only_students = 0;
8580: if (ref($possible_roles) eq 'ARRAY') {
8581: if (grep(/^st$/,@{$possible_roles})) {
8582: if (@{$possible_roles} == 1) {
8583: $only_students = 1;
8584: }
8585: } else {
8586: $check_students = 0;
8587: }
8588: }
8589:
8590: if ($check_students) {
1.276 albertel 8591: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 8592: my $sec_index = &Apache::loncoursedata::CL_SECTION();
8593: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 8594: my $start_index = &Apache::loncoursedata::CL_START();
8595: my $end_index = &Apache::loncoursedata::CL_END();
8596: my $status;
1.366 albertel 8597: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 8598: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
8599: $data->[$status_index],
8600: $data->[$start_index],
8601: $data->[$end_index]);
8602: if ($stu_status eq 'Active') {
8603: $status = 'active';
8604: } elsif ($end < $now) {
8605: $status = 'previous';
8606: } elsif ($start > $now) {
8607: $status = 'future';
8608: }
8609: if ($section ne '-1' && $section !~ /^\s*$/) {
8610: if ((!defined($possible_status)) || (($status ne '') &&
8611: (grep/^\Q$status\E$/,@{$possible_status}))) {
8612: $sectioncount{$section}++;
8613: }
1.240 albertel 8614: }
8615: }
8616: }
1.1075.2.33 raeburn 8617: if ($only_students) {
8618: return %sectioncount;
8619: }
1.240 albertel 8620: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8621: foreach my $user (sort(keys(%courseroles))) {
8622: if ($user !~ /^(\w{2})/) { next; }
8623: my ($role) = ($user =~ /^(\w{2})/);
8624: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 8625: my ($section,$status);
1.240 albertel 8626: if ($role eq 'cr' &&
8627: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
8628: $section=$1;
8629: }
8630: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
8631: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 8632: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
8633: if ($end == -1 && $start == -1) {
8634: next; #deleted role
8635: }
8636: if (!defined($possible_status)) {
8637: $sectioncount{$section}++;
8638: } else {
8639: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
8640: $status = 'active';
8641: } elsif ($end < $now) {
8642: $status = 'future';
8643: } elsif ($start > $now) {
8644: $status = 'previous';
8645: }
8646: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
8647: $sectioncount{$section}++;
8648: }
8649: }
1.233 raeburn 8650: }
1.366 albertel 8651: return %sectioncount;
1.233 raeburn 8652: }
8653:
1.274 raeburn 8654: ###############################################
1.294 raeburn 8655:
8656: =pod
1.405 albertel 8657:
8658: =item * &get_course_users()
8659:
1.275 raeburn 8660: Retrieves usernames:domains for users in the specified course
8661: with specific role(s), and access status.
8662:
8663: Incoming parameters:
1.277 albertel 8664: 1. course domain
8665: 2. course number
8666: 3. access status: users must have - either active,
1.275 raeburn 8667: previous, future, or all.
1.277 albertel 8668: 4. reference to array of permissible roles
1.288 raeburn 8669: 5. reference to array of section restrictions (optional)
8670: 6. reference to results object (hash of hashes).
8671: 7. reference to optional userdata hash
1.609 raeburn 8672: 8. reference to optional statushash
1.630 raeburn 8673: 9. flag if privileged users (except those set to unhide in
8674: course settings) should be excluded
1.609 raeburn 8675: Keys of top level results hash are roles.
1.275 raeburn 8676: Keys of inner hashes are username:domain, with
8677: values set to access type.
1.288 raeburn 8678: Optional userdata hash returns an array with arguments in the
8679: same order as loncoursedata::get_classlist() for student data.
8680:
1.609 raeburn 8681: Optional statushash returns
8682:
1.288 raeburn 8683: Entries for end, start, section and status are blank because
8684: of the possibility of multiple values for non-student roles.
8685:
1.275 raeburn 8686: =cut
1.405 albertel 8687:
1.275 raeburn 8688: ###############################################
1.405 albertel 8689:
1.275 raeburn 8690: sub get_course_users {
1.630 raeburn 8691: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 8692: my %idx = ();
1.419 raeburn 8693: my %seclists;
1.288 raeburn 8694:
8695: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
8696: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
8697: $idx{end} = &Apache::loncoursedata::CL_END();
8698: $idx{start} = &Apache::loncoursedata::CL_START();
8699: $idx{id} = &Apache::loncoursedata::CL_ID();
8700: $idx{section} = &Apache::loncoursedata::CL_SECTION();
8701: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
8702: $idx{status} = &Apache::loncoursedata::CL_STATUS();
8703:
1.290 albertel 8704: if (grep(/^st$/,@{$roles})) {
1.276 albertel 8705: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 8706: my $now = time;
1.277 albertel 8707: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 8708: my $match = 0;
1.412 raeburn 8709: my $secmatch = 0;
1.419 raeburn 8710: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 8711: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 8712: if ($section eq '') {
8713: $section = 'none';
8714: }
1.291 albertel 8715: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 8716: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 8717: $secmatch = 1;
8718: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 8719: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 8720: $secmatch = 1;
8721: }
8722: } else {
1.419 raeburn 8723: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 8724: $secmatch = 1;
8725: }
1.290 albertel 8726: }
1.412 raeburn 8727: if (!$secmatch) {
8728: next;
8729: }
1.419 raeburn 8730: }
1.275 raeburn 8731: if (defined($$types{'active'})) {
1.288 raeburn 8732: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 8733: push(@{$$users{st}{$student}},'active');
1.288 raeburn 8734: $match = 1;
1.275 raeburn 8735: }
8736: }
8737: if (defined($$types{'previous'})) {
1.609 raeburn 8738: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 8739: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 8740: $match = 1;
1.275 raeburn 8741: }
8742: }
8743: if (defined($$types{'future'})) {
1.609 raeburn 8744: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 8745: push(@{$$users{st}{$student}},'future');
1.288 raeburn 8746: $match = 1;
1.275 raeburn 8747: }
8748: }
1.609 raeburn 8749: if ($match) {
8750: push(@{$seclists{$student}},$section);
8751: if (ref($userdata) eq 'HASH') {
8752: $$userdata{$student} = $$classlist{$student};
8753: }
8754: if (ref($statushash) eq 'HASH') {
8755: $statushash->{$student}{'st'}{$section} = $status;
8756: }
1.288 raeburn 8757: }
1.275 raeburn 8758: }
8759: }
1.412 raeburn 8760: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 8761: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8762: my $now = time;
1.609 raeburn 8763: my %displaystatus = ( previous => 'Expired',
8764: active => 'Active',
8765: future => 'Future',
8766: );
1.1075.2.36 raeburn 8767: my (%nothide,@possdoms);
1.630 raeburn 8768: if ($hidepriv) {
8769: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
8770: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
8771: if ($user !~ /:/) {
8772: $nothide{join(':',split(/[\@]/,$user))}=1;
8773: } else {
8774: $nothide{$user} = 1;
8775: }
8776: }
1.1075.2.36 raeburn 8777: my @possdoms = ($cdom);
8778: if ($coursehash{'checkforpriv'}) {
8779: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
8780: }
1.630 raeburn 8781: }
1.439 raeburn 8782: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 8783: my $match = 0;
1.412 raeburn 8784: my $secmatch = 0;
1.439 raeburn 8785: my $status;
1.412 raeburn 8786: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 8787: $user =~ s/:$//;
1.439 raeburn 8788: my ($end,$start) = split(/:/,$coursepersonnel{$person});
8789: if ($end == -1 || $start == -1) {
8790: next;
8791: }
8792: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
8793: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 8794: my ($uname,$udom) = split(/:/,$user);
8795: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 8796: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 8797: $secmatch = 1;
8798: } elsif ($usec eq '') {
1.420 albertel 8799: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 8800: $secmatch = 1;
8801: }
8802: } else {
8803: if (grep(/^\Q$usec\E$/,@{$sections})) {
8804: $secmatch = 1;
8805: }
8806: }
8807: if (!$secmatch) {
8808: next;
8809: }
1.288 raeburn 8810: }
1.419 raeburn 8811: if ($usec eq '') {
8812: $usec = 'none';
8813: }
1.275 raeburn 8814: if ($uname ne '' && $udom ne '') {
1.630 raeburn 8815: if ($hidepriv) {
1.1075.2.36 raeburn 8816: if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630 raeburn 8817: (!$nothide{$uname.':'.$udom})) {
8818: next;
8819: }
8820: }
1.503 raeburn 8821: if ($end > 0 && $end < $now) {
1.439 raeburn 8822: $status = 'previous';
8823: } elsif ($start > $now) {
8824: $status = 'future';
8825: } else {
8826: $status = 'active';
8827: }
1.277 albertel 8828: foreach my $type (keys(%{$types})) {
1.275 raeburn 8829: if ($status eq $type) {
1.420 albertel 8830: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 8831: push(@{$$users{$role}{$user}},$type);
8832: }
1.288 raeburn 8833: $match = 1;
8834: }
8835: }
1.419 raeburn 8836: if (($match) && (ref($userdata) eq 'HASH')) {
8837: if (!exists($$userdata{$uname.':'.$udom})) {
8838: &get_user_info($udom,$uname,\%idx,$userdata);
8839: }
1.420 albertel 8840: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 8841: push(@{$seclists{$uname.':'.$udom}},$usec);
8842: }
1.609 raeburn 8843: if (ref($statushash) eq 'HASH') {
8844: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
8845: }
1.275 raeburn 8846: }
8847: }
8848: }
8849: }
1.290 albertel 8850: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 8851: if ((defined($cdom)) && (defined($cnum))) {
8852: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
8853: if ( defined($csettings{'internal.courseowner'}) ) {
8854: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 8855: next if ($owner eq '');
8856: my ($ownername,$ownerdom);
8857: if ($owner =~ /^([^:]+):([^:]+)$/) {
8858: $ownername = $1;
8859: $ownerdom = $2;
8860: } else {
8861: $ownername = $owner;
8862: $ownerdom = $cdom;
8863: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 8864: }
8865: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 8866: if (defined($userdata) &&
1.609 raeburn 8867: !exists($$userdata{$owner})) {
8868: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
8869: if (!grep(/^none$/,@{$seclists{$owner}})) {
8870: push(@{$seclists{$owner}},'none');
8871: }
8872: if (ref($statushash) eq 'HASH') {
8873: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 8874: }
1.290 albertel 8875: }
1.279 raeburn 8876: }
8877: }
8878: }
1.419 raeburn 8879: foreach my $user (keys(%seclists)) {
8880: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
8881: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
8882: }
1.275 raeburn 8883: }
8884: return;
8885: }
8886:
1.288 raeburn 8887: sub get_user_info {
8888: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 8889: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
8890: &plainname($uname,$udom,'lastname');
1.291 albertel 8891: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 8892: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 8893: my %idhash = &Apache::lonnet::idrget($udom,($uname));
8894: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 8895: return;
8896: }
1.275 raeburn 8897:
1.472 raeburn 8898: ###############################################
8899:
8900: =pod
8901:
8902: =item * &get_user_quota()
8903:
1.1075.2.41 raeburn 8904: Retrieves quota assigned for storage of user files.
8905: Default is to report quota for portfolio files.
1.472 raeburn 8906:
8907: Incoming parameters:
8908: 1. user's username
8909: 2. user's domain
1.1075.2.41 raeburn 8910: 3. quota name - portfolio, author, or course
8911: (if no quota name provided, defaults to portfolio).
1.1075.2.59 raeburn 8912: 4. crstype - official, unofficial, textbook or community, if quota name is
1.1075.2.42 raeburn 8913: course
1.472 raeburn 8914:
8915: Returns:
1.1075.2.58 raeburn 8916: 1. Disk quota (in MB) assigned to student.
1.536 raeburn 8917: 2. (Optional) Type of setting: custom or default
8918: (individually assigned or default for user's
8919: institutional status).
8920: 3. (Optional) - User's institutional status (e.g., faculty, staff
8921: or student - types as defined in localenroll::inst_usertypes
8922: for user's domain, which determines default quota for user.
8923: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 8924:
8925: If a value has been stored in the user's environment,
1.536 raeburn 8926: it will return that, otherwise it returns the maximal default
1.1075.2.41 raeburn 8927: defined for the user's institutional status(es) in the domain.
1.472 raeburn 8928:
8929: =cut
8930:
8931: ###############################################
8932:
8933:
8934: sub get_user_quota {
1.1075.2.42 raeburn 8935: my ($uname,$udom,$quotaname,$crstype) = @_;
1.536 raeburn 8936: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 8937: if (!defined($udom)) {
8938: $udom = $env{'user.domain'};
8939: }
8940: if (!defined($uname)) {
8941: $uname = $env{'user.name'};
8942: }
8943: if (($udom eq '' || $uname eq '') ||
8944: ($udom eq 'public') && ($uname eq 'public')) {
8945: $quota = 0;
1.536 raeburn 8946: $quotatype = 'default';
8947: $defquota = 0;
1.472 raeburn 8948: } else {
1.536 raeburn 8949: my $inststatus;
1.1075.2.41 raeburn 8950: if ($quotaname eq 'course') {
8951: if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
8952: ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
8953: $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
8954: } else {
8955: my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
8956: $quota = $cenv{'internal.uploadquota'};
8957: }
1.536 raeburn 8958: } else {
1.1075.2.41 raeburn 8959: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
8960: if ($quotaname eq 'author') {
8961: $quota = $env{'environment.authorquota'};
8962: } else {
8963: $quota = $env{'environment.portfolioquota'};
8964: }
8965: $inststatus = $env{'environment.inststatus'};
8966: } else {
8967: my %userenv =
8968: &Apache::lonnet::get('environment',['portfolioquota',
8969: 'authorquota','inststatus'],$udom,$uname);
8970: my ($tmp) = keys(%userenv);
8971: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
8972: if ($quotaname eq 'author') {
8973: $quota = $userenv{'authorquota'};
8974: } else {
8975: $quota = $userenv{'portfolioquota'};
8976: }
8977: $inststatus = $userenv{'inststatus'};
8978: } else {
8979: undef(%userenv);
8980: }
8981: }
8982: }
8983: if ($quota eq '' || wantarray) {
8984: if ($quotaname eq 'course') {
8985: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1075.2.59 raeburn 8986: if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
8987: ($crstype eq 'community') || ($crstype eq 'textbook')) {
1.1075.2.42 raeburn 8988: $defquota = $domdefs{$crstype.'quota'};
8989: }
8990: if ($defquota eq '') {
8991: $defquota = 500;
8992: }
1.1075.2.41 raeburn 8993: } else {
8994: ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
8995: }
8996: if ($quota eq '') {
8997: $quota = $defquota;
8998: $quotatype = 'default';
8999: } else {
9000: $quotatype = 'custom';
9001: }
1.472 raeburn 9002: }
9003: }
1.536 raeburn 9004: if (wantarray) {
9005: return ($quota,$quotatype,$settingstatus,$defquota);
9006: } else {
9007: return $quota;
9008: }
1.472 raeburn 9009: }
9010:
9011: ###############################################
9012:
9013: =pod
9014:
9015: =item * &default_quota()
9016:
1.536 raeburn 9017: Retrieves default quota assigned for storage of user portfolio files,
9018: given an (optional) user's institutional status.
1.472 raeburn 9019:
9020: Incoming parameters:
1.1075.2.42 raeburn 9021:
1.472 raeburn 9022: 1. domain
1.536 raeburn 9023: 2. (Optional) institutional status(es). This is a : separated list of
9024: status types (e.g., faculty, staff, student etc.)
9025: which apply to the user for whom the default is being retrieved.
9026: If the institutional status string in undefined, the domain
1.1075.2.41 raeburn 9027: default quota will be returned.
9028: 3. quota name - portfolio, author, or course
9029: (if no quota name provided, defaults to portfolio).
1.472 raeburn 9030:
9031: Returns:
1.1075.2.42 raeburn 9032:
1.1075.2.58 raeburn 9033: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536 raeburn 9034: 2. (Optional) institutional type which determined the value of the
9035: default quota.
1.472 raeburn 9036:
9037: If a value has been stored in the domain's configuration db,
9038: it will return that, otherwise it returns 20 (for backwards
9039: compatibility with domains which have not set up a configuration
1.1075.2.58 raeburn 9040: db file; the original statically defined portfolio quota was 20 MB).
1.472 raeburn 9041:
1.536 raeburn 9042: If the user's status includes multiple types (e.g., staff and student),
9043: the largest default quota which applies to the user determines the
9044: default quota returned.
9045:
1.472 raeburn 9046: =cut
9047:
9048: ###############################################
9049:
9050:
9051: sub default_quota {
1.1075.2.41 raeburn 9052: my ($udom,$inststatus,$quotaname) = @_;
1.536 raeburn 9053: my ($defquota,$settingstatus);
9054: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 9055: ['quotas'],$udom);
1.1075.2.41 raeburn 9056: my $key = 'defaultquota';
9057: if ($quotaname eq 'author') {
9058: $key = 'authorquota';
9059: }
1.622 raeburn 9060: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 9061: if ($inststatus ne '') {
1.765 raeburn 9062: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 9063: foreach my $item (@statuses) {
1.1075.2.41 raeburn 9064: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
9065: if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711 raeburn 9066: if ($defquota eq '') {
1.1075.2.41 raeburn 9067: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 9068: $settingstatus = $item;
1.1075.2.41 raeburn 9069: } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
9070: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 9071: $settingstatus = $item;
9072: }
9073: }
1.1075.2.41 raeburn 9074: } elsif ($key eq 'defaultquota') {
1.711 raeburn 9075: if ($quotahash{'quotas'}{$item} ne '') {
9076: if ($defquota eq '') {
9077: $defquota = $quotahash{'quotas'}{$item};
9078: $settingstatus = $item;
9079: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
9080: $defquota = $quotahash{'quotas'}{$item};
9081: $settingstatus = $item;
9082: }
1.536 raeburn 9083: }
9084: }
9085: }
9086: }
9087: if ($defquota eq '') {
1.1075.2.41 raeburn 9088: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
9089: $defquota = $quotahash{'quotas'}{$key}{'default'};
9090: } elsif ($key eq 'defaultquota') {
1.711 raeburn 9091: $defquota = $quotahash{'quotas'}{'default'};
9092: }
1.536 raeburn 9093: $settingstatus = 'default';
1.1075.2.42 raeburn 9094: if ($defquota eq '') {
9095: if ($quotaname eq 'author') {
9096: $defquota = 500;
9097: }
9098: }
1.536 raeburn 9099: }
9100: } else {
9101: $settingstatus = 'default';
1.1075.2.41 raeburn 9102: if ($quotaname eq 'author') {
9103: $defquota = 500;
9104: } else {
9105: $defquota = 20;
9106: }
1.536 raeburn 9107: }
9108: if (wantarray) {
9109: return ($defquota,$settingstatus);
1.472 raeburn 9110: } else {
1.536 raeburn 9111: return $defquota;
1.472 raeburn 9112: }
9113: }
9114:
1.1075.2.41 raeburn 9115: ###############################################
9116:
9117: =pod
9118:
1.1075.2.42 raeburn 9119: =item * &excess_filesize_warning()
1.1075.2.41 raeburn 9120:
9121: Returns warning message if upload of file to authoring space, or copying
1.1075.2.42 raeburn 9122: of existing file within authoring space will cause quota for the authoring
9123: space to be exceeded.
9124:
9125: Same, if upload of a file directly to a course/community via Course Editor
9126: will cause quota for uploaded content for the course to be exceeded.
1.1075.2.41 raeburn 9127:
1.1075.2.61 raeburn 9128: Inputs: 7
1.1075.2.42 raeburn 9129: 1. username or coursenum
1.1075.2.41 raeburn 9130: 2. domain
1.1075.2.42 raeburn 9131: 3. context ('author' or 'course')
1.1075.2.41 raeburn 9132: 4. filename of file for which action is being requested
9133: 5. filesize (kB) of file
9134: 6. action being taken: copy or upload.
1.1075.2.59 raeburn 9135: 7. quotatype (in course context -- official, unofficial, community or textbook).
1.1075.2.41 raeburn 9136:
9137: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
9138: otherwise return null.
9139:
1.1075.2.42 raeburn 9140: =back
9141:
1.1075.2.41 raeburn 9142: =cut
9143:
1.1075.2.42 raeburn 9144: sub excess_filesize_warning {
1.1075.2.59 raeburn 9145: my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1075.2.42 raeburn 9146: my $current_disk_usage = 0;
1.1075.2.59 raeburn 9147: my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1075.2.42 raeburn 9148: if ($context eq 'author') {
9149: my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
9150: $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
9151: } else {
9152: foreach my $subdir ('docs','supplemental') {
9153: $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
9154: }
9155: }
1.1075.2.41 raeburn 9156: $disk_quota = int($disk_quota * 1000);
9157: if (($current_disk_usage + $filesize) > $disk_quota) {
1.1075.2.69 raeburn 9158: return '<p class="LC_warning">'.
1.1075.2.41 raeburn 9159: &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1075.2.69 raeburn 9160: '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
9161: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1075.2.41 raeburn 9162: $disk_quota,$current_disk_usage).
9163: '</p>';
9164: }
9165: return;
9166: }
9167:
9168: ###############################################
9169:
9170:
1.384 raeburn 9171: sub get_secgrprole_info {
9172: my ($cdom,$cnum,$needroles,$type) = @_;
9173: my %sections_count = &get_sections($cdom,$cnum);
9174: my @sections = (sort {$a <=> $b} keys(%sections_count));
9175: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
9176: my @groups = sort(keys(%curr_groups));
9177: my $allroles = [];
9178: my $rolehash;
9179: my $accesshash = {
9180: active => 'Currently has access',
9181: future => 'Will have future access',
9182: previous => 'Previously had access',
9183: };
9184: if ($needroles) {
9185: $rolehash = {'all' => 'all'};
1.385 albertel 9186: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
9187: if (&Apache::lonnet::error(%user_roles)) {
9188: undef(%user_roles);
9189: }
9190: foreach my $item (keys(%user_roles)) {
1.384 raeburn 9191: my ($role)=split(/\:/,$item,2);
9192: if ($role eq 'cr') { next; }
9193: if ($role =~ /^cr/) {
9194: $$rolehash{$role} = (split('/',$role))[3];
9195: } else {
9196: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
9197: }
9198: }
9199: foreach my $key (sort(keys(%{$rolehash}))) {
9200: push(@{$allroles},$key);
9201: }
9202: push (@{$allroles},'st');
9203: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
9204: }
9205: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
9206: }
9207:
1.555 raeburn 9208: sub user_picker {
1.994 raeburn 9209: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context) = @_;
1.555 raeburn 9210: my $currdom = $dom;
9211: my %curr_selected = (
9212: srchin => 'dom',
1.580 raeburn 9213: srchby => 'lastname',
1.555 raeburn 9214: );
9215: my $srchterm;
1.625 raeburn 9216: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 9217: if ($srch->{'srchby'} ne '') {
9218: $curr_selected{'srchby'} = $srch->{'srchby'};
9219: }
9220: if ($srch->{'srchin'} ne '') {
9221: $curr_selected{'srchin'} = $srch->{'srchin'};
9222: }
9223: if ($srch->{'srchtype'} ne '') {
9224: $curr_selected{'srchtype'} = $srch->{'srchtype'};
9225: }
9226: if ($srch->{'srchdomain'} ne '') {
9227: $currdom = $srch->{'srchdomain'};
9228: }
9229: $srchterm = $srch->{'srchterm'};
9230: }
9231: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 9232: 'usr' => 'Search criteria',
1.563 raeburn 9233: 'doma' => 'Domain/institution to search',
1.558 albertel 9234: 'uname' => 'username',
9235: 'lastname' => 'last name',
1.555 raeburn 9236: 'lastfirst' => 'last name, first name',
1.558 albertel 9237: 'crs' => 'in this course',
1.576 raeburn 9238: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 9239: 'alc' => 'all LON-CAPA',
1.573 raeburn 9240: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 9241: 'exact' => 'is',
9242: 'contains' => 'contains',
1.569 raeburn 9243: 'begins' => 'begins with',
1.571 raeburn 9244: 'youm' => "You must include some text to search for.",
9245: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
9246: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
9247: 'yomc' => "You must choose a domain when using an institutional directory search.",
9248: 'ymcd' => "You must choose a domain when using a domain search.",
9249: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
9250: 'whse' => "When searching by last,first you must include at least one character in the first name.",
9251: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 9252: );
1.563 raeburn 9253: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
9254: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 9255:
9256: my @srchins = ('crs','dom','alc','instd');
9257:
9258: foreach my $option (@srchins) {
9259: # FIXME 'alc' option unavailable until
9260: # loncreateuser::print_user_query_page()
9261: # has been completed.
9262: next if ($option eq 'alc');
1.880 raeburn 9263: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 9264: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 9265: if ($curr_selected{'srchin'} eq $option) {
9266: $srchinsel .= '
9267: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
9268: } else {
9269: $srchinsel .= '
9270: <option value="'.$option.'">'.$lt{$option}.'</option>';
9271: }
1.555 raeburn 9272: }
1.563 raeburn 9273: $srchinsel .= "\n </select>\n";
1.555 raeburn 9274:
9275: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 9276: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 9277: if ($curr_selected{'srchby'} eq $option) {
9278: $srchbysel .= '
9279: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
9280: } else {
9281: $srchbysel .= '
9282: <option value="'.$option.'">'.$lt{$option}.'</option>';
9283: }
9284: }
9285: $srchbysel .= "\n </select>\n";
9286:
9287: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 9288: foreach my $option ('begins','contains','exact') {
1.555 raeburn 9289: if ($curr_selected{'srchtype'} eq $option) {
9290: $srchtypesel .= '
9291: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
9292: } else {
9293: $srchtypesel .= '
9294: <option value="'.$option.'">'.$lt{$option}.'</option>';
9295: }
9296: }
9297: $srchtypesel .= "\n </select>\n";
9298:
1.558 albertel 9299: my ($newuserscript,$new_user_create);
1.994 raeburn 9300: my $context_dom = $env{'request.role.domain'};
9301: if ($context eq 'requestcrs') {
9302: if ($env{'form.coursedom'} ne '') {
9303: $context_dom = $env{'form.coursedom'};
9304: }
9305: }
1.556 raeburn 9306: if ($forcenewuser) {
1.576 raeburn 9307: if (ref($srch) eq 'HASH') {
1.994 raeburn 9308: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 9309: if ($cancreate) {
9310: $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>';
9311: } else {
1.799 bisitz 9312: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 9313: my %usertypetext = (
9314: official => 'institutional',
9315: unofficial => 'non-institutional',
9316: );
1.799 bisitz 9317: $new_user_create = '<p class="LC_warning">'
9318: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
9319: .' '
9320: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
9321: ,'<a href="'.$helplink.'">','</a>')
9322: .'</p><br />';
1.627 raeburn 9323: }
1.576 raeburn 9324: }
9325: }
9326:
1.556 raeburn 9327: $newuserscript = <<"ENDSCRIPT";
9328:
1.570 raeburn 9329: function setSearch(createnew,callingForm) {
1.556 raeburn 9330: if (createnew == 1) {
1.570 raeburn 9331: for (var i=0; i<callingForm.srchby.length; i++) {
9332: if (callingForm.srchby.options[i].value == 'uname') {
9333: callingForm.srchby.selectedIndex = i;
1.556 raeburn 9334: }
9335: }
1.570 raeburn 9336: for (var i=0; i<callingForm.srchin.length; i++) {
9337: if ( callingForm.srchin.options[i].value == 'dom') {
9338: callingForm.srchin.selectedIndex = i;
1.556 raeburn 9339: }
9340: }
1.570 raeburn 9341: for (var i=0; i<callingForm.srchtype.length; i++) {
9342: if (callingForm.srchtype.options[i].value == 'exact') {
9343: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 9344: }
9345: }
1.570 raeburn 9346: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 9347: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 9348: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 9349: }
9350: }
9351: }
9352: }
9353: ENDSCRIPT
1.558 albertel 9354:
1.556 raeburn 9355: }
9356:
1.555 raeburn 9357: my $output = <<"END_BLOCK";
1.556 raeburn 9358: <script type="text/javascript">
1.824 bisitz 9359: // <![CDATA[
1.570 raeburn 9360: function validateEntry(callingForm) {
1.558 albertel 9361:
1.556 raeburn 9362: var checkok = 1;
1.558 albertel 9363: var srchin;
1.570 raeburn 9364: for (var i=0; i<callingForm.srchin.length; i++) {
9365: if ( callingForm.srchin[i].checked ) {
9366: srchin = callingForm.srchin[i].value;
1.558 albertel 9367: }
9368: }
9369:
1.570 raeburn 9370: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
9371: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
9372: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
9373: var srchterm = callingForm.srchterm.value;
9374: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 9375: var msg = "";
9376:
9377: if (srchterm == "") {
9378: checkok = 0;
1.571 raeburn 9379: msg += "$lt{'youm'}\\n";
1.556 raeburn 9380: }
9381:
1.569 raeburn 9382: if (srchtype== 'begins') {
9383: if (srchterm.length < 2) {
9384: checkok = 0;
1.571 raeburn 9385: msg += "$lt{'thte'}\\n";
1.569 raeburn 9386: }
9387: }
9388:
1.556 raeburn 9389: if (srchtype== 'contains') {
9390: if (srchterm.length < 3) {
9391: checkok = 0;
1.571 raeburn 9392: msg += "$lt{'thet'}\\n";
1.556 raeburn 9393: }
9394: }
9395: if (srchin == 'instd') {
9396: if (srchdomain == '') {
9397: checkok = 0;
1.571 raeburn 9398: msg += "$lt{'yomc'}\\n";
1.556 raeburn 9399: }
9400: }
9401: if (srchin == 'dom') {
9402: if (srchdomain == '') {
9403: checkok = 0;
1.571 raeburn 9404: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 9405: }
9406: }
9407: if (srchby == 'lastfirst') {
9408: if (srchterm.indexOf(",") == -1) {
9409: checkok = 0;
1.571 raeburn 9410: msg += "$lt{'whus'}\\n";
1.556 raeburn 9411: }
9412: if (srchterm.indexOf(",") == srchterm.length -1) {
9413: checkok = 0;
1.571 raeburn 9414: msg += "$lt{'whse'}\\n";
1.556 raeburn 9415: }
9416: }
9417: if (checkok == 0) {
1.571 raeburn 9418: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 9419: return;
9420: }
9421: if (checkok == 1) {
1.570 raeburn 9422: callingForm.submit();
1.556 raeburn 9423: }
9424: }
9425:
9426: $newuserscript
9427:
1.824 bisitz 9428: // ]]>
1.556 raeburn 9429: </script>
1.558 albertel 9430:
9431: $new_user_create
9432:
1.555 raeburn 9433: END_BLOCK
1.558 albertel 9434:
1.876 raeburn 9435: $output .= &Apache::lonhtmlcommon::start_pick_box().
9436: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
9437: $domform.
9438: &Apache::lonhtmlcommon::row_closure().
9439: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
9440: $srchbysel.
9441: $srchtypesel.
9442: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
9443: $srchinsel.
9444: &Apache::lonhtmlcommon::row_closure(1).
9445: &Apache::lonhtmlcommon::end_pick_box().
9446: '<br />';
1.555 raeburn 9447: return $output;
9448: }
9449:
1.612 raeburn 9450: sub user_rule_check {
1.615 raeburn 9451: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 9452: my $response;
9453: if (ref($usershash) eq 'HASH') {
9454: foreach my $user (keys(%{$usershash})) {
9455: my ($uname,$udom) = split(/:/,$user);
9456: next if ($udom eq '' || $uname eq '');
1.615 raeburn 9457: my ($id,$newuser);
1.612 raeburn 9458: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 9459: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 9460: $id = $usershash->{$user}->{'id'};
9461: }
9462: my $inst_response;
9463: if (ref($checks) eq 'HASH') {
9464: if (defined($checks->{'username'})) {
1.615 raeburn 9465: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 9466: &Apache::lonnet::get_instuser($udom,$uname);
9467: } elsif (defined($checks->{'id'})) {
1.615 raeburn 9468: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 9469: &Apache::lonnet::get_instuser($udom,undef,$id);
9470: }
1.615 raeburn 9471: } else {
9472: ($inst_response,%{$inst_results->{$user}}) =
9473: &Apache::lonnet::get_instuser($udom,$uname);
9474: return;
1.612 raeburn 9475: }
1.615 raeburn 9476: if (!$got_rules->{$udom}) {
1.612 raeburn 9477: my %domconfig = &Apache::lonnet::get_dom('configuration',
9478: ['usercreation'],$udom);
9479: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 9480: foreach my $item ('username','id') {
1.612 raeburn 9481: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
9482: $$curr_rules{$udom}{$item} =
9483: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 9484: }
9485: }
9486: }
1.615 raeburn 9487: $got_rules->{$udom} = 1;
1.585 raeburn 9488: }
1.612 raeburn 9489: foreach my $item (keys(%{$checks})) {
9490: if (ref($$curr_rules{$udom}) eq 'HASH') {
9491: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
9492: if (@{$$curr_rules{$udom}{$item}} > 0) {
9493: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
9494: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
9495: if ($rule_check{$rule}) {
9496: $$rulematch{$user}{$item} = $rule;
9497: if ($inst_response eq 'ok') {
1.615 raeburn 9498: if (ref($inst_results) eq 'HASH') {
9499: if (ref($inst_results->{$user}) eq 'HASH') {
9500: if (keys(%{$inst_results->{$user}}) == 0) {
9501: $$alerts{$item}{$udom}{$uname} = 1;
9502: }
1.612 raeburn 9503: }
9504: }
1.615 raeburn 9505: }
9506: last;
1.585 raeburn 9507: }
9508: }
9509: }
9510: }
9511: }
9512: }
9513: }
9514: }
1.612 raeburn 9515: return;
9516: }
9517:
9518: sub user_rule_formats {
9519: my ($domain,$domdesc,$curr_rules,$check) = @_;
9520: my %text = (
9521: 'username' => 'Usernames',
9522: 'id' => 'IDs',
9523: );
9524: my $output;
9525: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
9526: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
9527: if (@{$ruleorder} > 0) {
1.1075.2.20 raeburn 9528: $output = '<br />'.
9529: &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
9530: '<span class="LC_cusr_emph">','</span>',$domdesc).
9531: ' <ul>';
1.612 raeburn 9532: foreach my $rule (@{$ruleorder}) {
9533: if (ref($curr_rules) eq 'ARRAY') {
9534: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
9535: if (ref($rules->{$rule}) eq 'HASH') {
9536: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
9537: $rules->{$rule}{'desc'}.'</li>';
9538: }
9539: }
9540: }
9541: }
9542: $output .= '</ul>';
9543: }
9544: }
9545: return $output;
9546: }
9547:
9548: sub instrule_disallow_msg {
1.615 raeburn 9549: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 9550: my $response;
9551: my %text = (
9552: item => 'username',
9553: items => 'usernames',
9554: match => 'matches',
9555: do => 'does',
9556: action => 'a username',
9557: one => 'one',
9558: );
9559: if ($count > 1) {
9560: $text{'item'} = 'usernames';
9561: $text{'match'} ='match';
9562: $text{'do'} = 'do';
9563: $text{'action'} = 'usernames',
9564: $text{'one'} = 'ones';
9565: }
9566: if ($checkitem eq 'id') {
9567: $text{'items'} = 'IDs';
9568: $text{'item'} = 'ID';
9569: $text{'action'} = 'an ID';
1.615 raeburn 9570: if ($count > 1) {
9571: $text{'item'} = 'IDs';
9572: $text{'action'} = 'IDs';
9573: }
1.612 raeburn 9574: }
1.674 bisitz 9575: $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 9576: if ($mode eq 'upload') {
9577: if ($checkitem eq 'username') {
9578: $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'}.");
9579: } elsif ($checkitem eq 'id') {
1.674 bisitz 9580: $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 9581: }
1.669 raeburn 9582: } elsif ($mode eq 'selfcreate') {
9583: if ($checkitem eq 'id') {
9584: $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.");
9585: }
1.615 raeburn 9586: } else {
9587: if ($checkitem eq 'username') {
9588: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
9589: } elsif ($checkitem eq 'id') {
9590: $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.");
9591: }
1.612 raeburn 9592: }
9593: return $response;
1.585 raeburn 9594: }
9595:
1.624 raeburn 9596: sub personal_data_fieldtitles {
9597: my %fieldtitles = &Apache::lonlocal::texthash (
9598: id => 'Student/Employee ID',
9599: permanentemail => 'E-mail address',
9600: lastname => 'Last Name',
9601: firstname => 'First Name',
9602: middlename => 'Middle Name',
9603: generation => 'Generation',
9604: gen => 'Generation',
1.765 raeburn 9605: inststatus => 'Affiliation',
1.624 raeburn 9606: );
9607: return %fieldtitles;
9608: }
9609:
1.642 raeburn 9610: sub sorted_inst_types {
9611: my ($dom) = @_;
1.1075.2.70 raeburn 9612: my ($usertypes,$order);
9613: my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
9614: if (ref($domdefaults{'inststatus'}) eq 'HASH') {
9615: $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
9616: $order = $domdefaults{'inststatus'}{'inststatusorder'};
9617: } else {
9618: ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
9619: }
1.642 raeburn 9620: my $othertitle = &mt('All users');
9621: if ($env{'request.course.id'}) {
1.668 raeburn 9622: $othertitle = &mt('Any users');
1.642 raeburn 9623: }
9624: my @types;
9625: if (ref($order) eq 'ARRAY') {
9626: @types = @{$order};
9627: }
9628: if (@types == 0) {
9629: if (ref($usertypes) eq 'HASH') {
9630: @types = sort(keys(%{$usertypes}));
9631: }
9632: }
9633: if (keys(%{$usertypes}) > 0) {
9634: $othertitle = &mt('Other users');
9635: }
9636: return ($othertitle,$usertypes,\@types);
9637: }
9638:
1.645 raeburn 9639: sub get_institutional_codes {
9640: my ($settings,$allcourses,$LC_code) = @_;
9641: # Get complete list of course sections to update
9642: my @currsections = ();
9643: my @currxlists = ();
9644: my $coursecode = $$settings{'internal.coursecode'};
9645:
9646: if ($$settings{'internal.sectionnums'} ne '') {
9647: @currsections = split(/,/,$$settings{'internal.sectionnums'});
9648: }
9649:
9650: if ($$settings{'internal.crosslistings'} ne '') {
9651: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
9652: }
9653:
9654: if (@currxlists > 0) {
9655: foreach (@currxlists) {
9656: if (m/^([^:]+):(\w*)$/) {
9657: unless (grep/^$1$/,@{$allcourses}) {
9658: push @{$allcourses},$1;
9659: $$LC_code{$1} = $2;
9660: }
9661: }
9662: }
9663: }
9664:
9665: if (@currsections > 0) {
9666: foreach (@currsections) {
9667: if (m/^(\w+):(\w*)$/) {
9668: my $sec = $coursecode.$1;
9669: my $lc_sec = $2;
9670: unless (grep/^$sec$/,@{$allcourses}) {
9671: push @{$allcourses},$sec;
9672: $$LC_code{$sec} = $lc_sec;
9673: }
9674: }
9675: }
9676: }
9677: return;
9678: }
9679:
1.971 raeburn 9680: sub get_standard_codeitems {
9681: return ('Year','Semester','Department','Number','Section');
9682: }
9683:
1.112 bowersj2 9684: =pod
9685:
1.780 raeburn 9686: =head1 Slot Helpers
9687:
9688: =over 4
9689:
9690: =item * sorted_slots()
9691:
1.1040 raeburn 9692: Sorts an array of slot names in order of an optional sort key,
9693: default sort is by slot start time (earliest first).
1.780 raeburn 9694:
9695: Inputs:
9696:
9697: =over 4
9698:
9699: slotsarr - Reference to array of unsorted slot names.
9700:
9701: slots - Reference to hash of hash, where outer hash keys are slot names.
9702:
1.1040 raeburn 9703: sortkey - Name of key in inner hash to be sorted on (e.g., starttime).
9704:
1.549 albertel 9705: =back
9706:
1.780 raeburn 9707: Returns:
9708:
9709: =over 4
9710:
1.1040 raeburn 9711: sorted - An array of slot names sorted by a specified sort key
9712: (default sort key is start time of the slot).
1.780 raeburn 9713:
9714: =back
9715:
9716: =cut
9717:
9718:
9719: sub sorted_slots {
1.1040 raeburn 9720: my ($slotsarr,$slots,$sortkey) = @_;
9721: if ($sortkey eq '') {
9722: $sortkey = 'starttime';
9723: }
1.780 raeburn 9724: my @sorted;
9725: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
9726: @sorted =
9727: sort {
9728: if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040 raeburn 9729: return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780 raeburn 9730: }
9731: if (ref($slots->{$a})) { return -1;}
9732: if (ref($slots->{$b})) { return 1;}
9733: return 0;
9734: } @{$slotsarr};
9735: }
9736: return @sorted;
9737: }
9738:
1.1040 raeburn 9739: =pod
9740:
9741: =item * get_future_slots()
9742:
9743: Inputs:
9744:
9745: =over 4
9746:
9747: cnum - course number
9748:
9749: cdom - course domain
9750:
9751: now - current UNIX time
9752:
9753: symb - optional symb
9754:
9755: =back
9756:
9757: Returns:
9758:
9759: =over 4
9760:
9761: sorted_reservable - ref to array of student_schedulable slots currently
9762: reservable, ordered by end date of reservation period.
9763:
9764: reservable_now - ref to hash of student_schedulable slots currently
9765: reservable.
9766:
9767: Keys in inner hash are:
9768: (a) symb: either blank or symb to which slot use is restricted.
9769: (b) endreserve: end date of reservation period.
9770:
9771: sorted_future - ref to array of student_schedulable slots reservable in
9772: the future, ordered by start date of reservation period.
9773:
9774: future_reservable - ref to hash of student_schedulable slots reservable
9775: in the future.
9776:
9777: Keys in inner hash are:
9778: (a) symb: either blank or symb to which slot use is restricted.
9779: (b) startreserve: start date of reservation period.
9780:
9781: =back
9782:
9783: =cut
9784:
9785: sub get_future_slots {
9786: my ($cnum,$cdom,$now,$symb) = @_;
9787: my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
9788: my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
9789: foreach my $slot (keys(%slots)) {
9790: next unless($slots{$slot}->{'type'} eq 'schedulable_student');
9791: if ($symb) {
9792: next if (($slots{$slot}->{'symb'} ne '') &&
9793: ($slots{$slot}->{'symb'} ne $symb));
9794: }
9795: if (($slots{$slot}->{'starttime'} > $now) &&
9796: ($slots{$slot}->{'endtime'} > $now)) {
9797: if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
9798: my $userallowed = 0;
9799: if ($slots{$slot}->{'allowedsections'}) {
9800: my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
9801: if (!defined($env{'request.role.sec'})
9802: && grep(/^No section assigned$/,@allowed_sec)) {
9803: $userallowed=1;
9804: } else {
9805: if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
9806: $userallowed=1;
9807: }
9808: }
9809: unless ($userallowed) {
9810: if (defined($env{'request.course.groups'})) {
9811: my @groups = split(/:/,$env{'request.course.groups'});
9812: foreach my $group (@groups) {
9813: if (grep(/^\Q$group\E$/,@allowed_sec)) {
9814: $userallowed=1;
9815: last;
9816: }
9817: }
9818: }
9819: }
9820: }
9821: if ($slots{$slot}->{'allowedusers'}) {
9822: my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
9823: my $user = $env{'user.name'}.':'.$env{'user.domain'};
9824: if (grep(/^\Q$user\E$/,@allowed_users)) {
9825: $userallowed = 1;
9826: }
9827: }
9828: next unless($userallowed);
9829: }
9830: my $startreserve = $slots{$slot}->{'startreserve'};
9831: my $endreserve = $slots{$slot}->{'endreserve'};
9832: my $symb = $slots{$slot}->{'symb'};
9833: if (($startreserve < $now) &&
9834: (!$endreserve || $endreserve > $now)) {
9835: my $lastres = $endreserve;
9836: if (!$lastres) {
9837: $lastres = $slots{$slot}->{'starttime'};
9838: }
9839: $reservable_now{$slot} = {
9840: symb => $symb,
9841: endreserve => $lastres
9842: };
9843: } elsif (($startreserve > $now) &&
9844: (!$endreserve || $endreserve > $startreserve)) {
9845: $future_reservable{$slot} = {
9846: symb => $symb,
9847: startreserve => $startreserve
9848: };
9849: }
9850: }
9851: }
9852: my @unsorted_reservable = keys(%reservable_now);
9853: if (@unsorted_reservable > 0) {
9854: @sorted_reservable =
9855: &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
9856: }
9857: my @unsorted_future = keys(%future_reservable);
9858: if (@unsorted_future > 0) {
9859: @sorted_future =
9860: &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
9861: }
9862: return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
9863: }
1.780 raeburn 9864:
9865: =pod
9866:
1.1057 foxr 9867: =back
9868:
1.549 albertel 9869: =head1 HTTP Helpers
9870:
9871: =over 4
9872:
1.648 raeburn 9873: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 9874:
1.258 albertel 9875: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 9876: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 9877: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 9878:
9879: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
9880: $possible_names is an ref to an array of form element names. As an example:
9881: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 9882: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 9883:
9884: =cut
1.1 albertel 9885:
1.6 albertel 9886: sub get_unprocessed_cgi {
1.25 albertel 9887: my ($query,$possible_names)= @_;
1.26 matthew 9888: # $Apache::lonxml::debug=1;
1.356 albertel 9889: foreach my $pair (split(/&/,$query)) {
9890: my ($name, $value) = split(/=/,$pair);
1.369 www 9891: $name = &unescape($name);
1.25 albertel 9892: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
9893: $value =~ tr/+/ /;
9894: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 9895: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 9896: }
1.16 harris41 9897: }
1.6 albertel 9898: }
9899:
1.112 bowersj2 9900: =pod
9901:
1.648 raeburn 9902: =item * &cacheheader()
1.112 bowersj2 9903:
9904: returns cache-controlling header code
9905:
9906: =cut
9907:
1.7 albertel 9908: sub cacheheader {
1.258 albertel 9909: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 9910: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
9911: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 9912: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
9913: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 9914: return $output;
1.7 albertel 9915: }
9916:
1.112 bowersj2 9917: =pod
9918:
1.648 raeburn 9919: =item * &no_cache($r)
1.112 bowersj2 9920:
9921: specifies header code to not have cache
9922:
9923: =cut
9924:
1.9 albertel 9925: sub no_cache {
1.216 albertel 9926: my ($r) = @_;
9927: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 9928: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 9929: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
9930: $r->no_cache(1);
9931: $r->header_out("Expires" => $date);
9932: $r->header_out("Pragma" => "no-cache");
1.123 www 9933: }
9934:
9935: sub content_type {
1.181 albertel 9936: my ($r,$type,$charset) = @_;
1.299 foxr 9937: if ($r) {
9938: # Note that printout.pl calls this with undef for $r.
9939: &no_cache($r);
9940: }
1.258 albertel 9941: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 9942: unless ($charset) {
9943: $charset=&Apache::lonlocal::current_encoding;
9944: }
9945: if ($charset) { $type.='; charset='.$charset; }
9946: if ($r) {
9947: $r->content_type($type);
9948: } else {
9949: print("Content-type: $type\n\n");
9950: }
1.9 albertel 9951: }
1.25 albertel 9952:
1.112 bowersj2 9953: =pod
9954:
1.648 raeburn 9955: =item * &add_to_env($name,$value)
1.112 bowersj2 9956:
1.258 albertel 9957: adds $name to the %env hash with value
1.112 bowersj2 9958: $value, if $name already exists, the entry is converted to an array
9959: reference and $value is added to the array.
9960:
9961: =cut
9962:
1.25 albertel 9963: sub add_to_env {
9964: my ($name,$value)=@_;
1.258 albertel 9965: if (defined($env{$name})) {
9966: if (ref($env{$name})) {
1.25 albertel 9967: #already have multiple values
1.258 albertel 9968: push(@{ $env{$name} },$value);
1.25 albertel 9969: } else {
9970: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 9971: my $first=$env{$name};
9972: undef($env{$name});
9973: push(@{ $env{$name} },$first,$value);
1.25 albertel 9974: }
9975: } else {
1.258 albertel 9976: $env{$name}=$value;
1.25 albertel 9977: }
1.31 albertel 9978: }
1.149 albertel 9979:
9980: =pod
9981:
1.648 raeburn 9982: =item * &get_env_multiple($name)
1.149 albertel 9983:
1.258 albertel 9984: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 9985: values may be defined and end up as an array ref.
9986:
9987: returns an array of values
9988:
9989: =cut
9990:
9991: sub get_env_multiple {
9992: my ($name) = @_;
9993: my @values;
1.258 albertel 9994: if (defined($env{$name})) {
1.149 albertel 9995: # exists is it an array
1.258 albertel 9996: if (ref($env{$name})) {
9997: @values=@{ $env{$name} };
1.149 albertel 9998: } else {
1.258 albertel 9999: $values[0]=$env{$name};
1.149 albertel 10000: }
10001: }
10002: return(@values);
10003: }
10004:
1.660 raeburn 10005: sub ask_for_embedded_content {
10006: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071 raeburn 10007: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1075.2.11 raeburn 10008: %currsubfile,%unused,$rem);
1.1071 raeburn 10009: my $counter = 0;
10010: my $numnew = 0;
1.987 raeburn 10011: my $numremref = 0;
10012: my $numinvalid = 0;
10013: my $numpathchg = 0;
10014: my $numexisting = 0;
1.1071 raeburn 10015: my $numunused = 0;
10016: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1075.2.53 raeburn 10017: $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071 raeburn 10018: my $heading = &mt('Upload embedded files');
10019: my $buttontext = &mt('Upload');
10020:
1.1075.2.11 raeburn 10021: if ($env{'request.course.id'}) {
1.1075.2.35 raeburn 10022: if ($actionurl eq '/adm/dependencies') {
10023: $navmap = Apache::lonnavmaps::navmap->new();
10024: }
10025: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10026: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1075.2.11 raeburn 10027: }
1.1075.2.35 raeburn 10028: if (($actionurl eq '/adm/portfolio') ||
10029: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984 raeburn 10030: my $current_path='/';
10031: if ($env{'form.currentpath'}) {
10032: $current_path = $env{'form.currentpath'};
10033: }
10034: if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1075.2.35 raeburn 10035: $udom = $cdom;
10036: $uname = $cnum;
1.984 raeburn 10037: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
10038: } else {
10039: $udom = $env{'user.domain'};
10040: $uname = $env{'user.name'};
10041: $url = '/userfiles/portfolio';
10042: }
1.987 raeburn 10043: $toplevel = $url.'/';
1.984 raeburn 10044: $url .= $current_path;
10045: $getpropath = 1;
1.987 raeburn 10046: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
10047: ($actionurl eq '/adm/imsimport')) {
1.1022 www 10048: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026 raeburn 10049: $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987 raeburn 10050: $toplevel = $url;
1.984 raeburn 10051: if ($rest ne '') {
1.987 raeburn 10052: $url .= $rest;
10053: }
10054: } elsif ($actionurl eq '/adm/coursedocs') {
10055: if (ref($args) eq 'HASH') {
1.1071 raeburn 10056: $url = $args->{'docs_url'};
10057: $toplevel = $url;
1.1075.2.11 raeburn 10058: if ($args->{'context'} eq 'paste') {
10059: ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
10060: ($path) =
10061: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
10062: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
10063: $fileloc =~ s{^/}{};
10064: }
1.1071 raeburn 10065: }
10066: } elsif ($actionurl eq '/adm/dependencies') {
10067: if ($env{'request.course.id'} ne '') {
10068: if (ref($args) eq 'HASH') {
10069: $url = $args->{'docs_url'};
10070: $title = $args->{'docs_title'};
1.1075.2.35 raeburn 10071: $toplevel = $url;
10072: unless ($toplevel =~ m{^/}) {
10073: $toplevel = "/$url";
10074: }
1.1075.2.11 raeburn 10075: ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1075.2.35 raeburn 10076: if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
10077: $path = $1;
10078: } else {
10079: ($path) =
10080: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
10081: }
1.1075.2.79 raeburn 10082: if ($toplevel=~/^\/*(uploaded|editupload)/) {
10083: $fileloc = $toplevel;
10084: $fileloc=~ s/^\s*(\S+)\s*$/$1/;
10085: my ($udom,$uname,$fname) =
10086: ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
10087: $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
10088: } else {
10089: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
10090: }
1.1071 raeburn 10091: $fileloc =~ s{^/}{};
10092: ($filename) = ($fileloc =~ m{.+/([^/]+)$});
10093: $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
10094: }
1.987 raeburn 10095: }
1.1075.2.35 raeburn 10096: } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
10097: $udom = $cdom;
10098: $uname = $cnum;
10099: $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
10100: $toplevel = $url;
10101: $path = $url;
10102: $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
10103: $fileloc =~ s{^/}{};
10104: }
10105: foreach my $file (keys(%{$allfiles})) {
10106: my $embed_file;
10107: if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
10108: $embed_file = $1;
10109: } else {
10110: $embed_file = $file;
10111: }
1.1075.2.55 raeburn 10112: my ($absolutepath,$cleaned_file);
10113: if ($embed_file =~ m{^\w+://}) {
10114: $cleaned_file = $embed_file;
1.1075.2.47 raeburn 10115: $newfiles{$cleaned_file} = 1;
10116: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 10117: } else {
1.1075.2.55 raeburn 10118: $cleaned_file = &clean_path($embed_file);
1.987 raeburn 10119: if ($embed_file =~ m{^/}) {
10120: $absolutepath = $embed_file;
10121: }
1.1075.2.47 raeburn 10122: if ($cleaned_file =~ m{/}) {
10123: my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987 raeburn 10124: $path = &check_for_traversal($path,$url,$toplevel);
10125: my $item = $fname;
10126: if ($path ne '') {
10127: $item = $path.'/'.$fname;
10128: $subdependencies{$path}{$fname} = 1;
10129: } else {
10130: $dependencies{$item} = 1;
10131: }
10132: if ($absolutepath) {
10133: $mapping{$item} = $absolutepath;
10134: } else {
10135: $mapping{$item} = $embed_file;
10136: }
10137: } else {
10138: $dependencies{$embed_file} = 1;
10139: if ($absolutepath) {
1.1075.2.47 raeburn 10140: $mapping{$cleaned_file} = $absolutepath;
1.987 raeburn 10141: } else {
1.1075.2.47 raeburn 10142: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 10143: }
10144: }
1.984 raeburn 10145: }
10146: }
1.1071 raeburn 10147: my $dirptr = 16384;
1.984 raeburn 10148: foreach my $path (keys(%subdependencies)) {
1.1071 raeburn 10149: $currsubfile{$path} = {};
1.1075.2.35 raeburn 10150: if (($actionurl eq '/adm/portfolio') ||
10151: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 10152: my ($sublistref,$listerror) =
10153: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
10154: if (ref($sublistref) eq 'ARRAY') {
10155: foreach my $line (@{$sublistref}) {
10156: my ($file_name,$rest) = split(/\&/,$line,2);
1.1071 raeburn 10157: $currsubfile{$path}{$file_name} = 1;
1.1021 raeburn 10158: }
1.984 raeburn 10159: }
1.987 raeburn 10160: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 10161: if (opendir(my $dir,$url.'/'.$path)) {
10162: my @subdir_list = grep(!/^\./,readdir($dir));
1.1071 raeburn 10163: map {$currsubfile{$path}{$_} = 1;} @subdir_list;
10164: }
1.1075.2.11 raeburn 10165: } elsif (($actionurl eq '/adm/dependencies') ||
10166: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1075.2.35 raeburn 10167: ($args->{'context'} eq 'paste')) ||
10168: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 10169: if ($env{'request.course.id'} ne '') {
1.1075.2.35 raeburn 10170: my $dir;
10171: if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
10172: $dir = $fileloc;
10173: } else {
10174: ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
10175: }
1.1071 raeburn 10176: if ($dir ne '') {
10177: my ($sublistref,$listerror) =
10178: &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
10179: if (ref($sublistref) eq 'ARRAY') {
10180: foreach my $line (@{$sublistref}) {
10181: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
10182: undef,$mtime)=split(/\&/,$line,12);
10183: unless (($testdir&$dirptr) ||
10184: ($file_name =~ /^\.\.?$/)) {
10185: $currsubfile{$path}{$file_name} = [$size,$mtime];
10186: }
10187: }
10188: }
10189: }
1.984 raeburn 10190: }
10191: }
10192: foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071 raeburn 10193: if (exists($currsubfile{$path}{$file})) {
1.987 raeburn 10194: my $item = $path.'/'.$file;
10195: unless ($mapping{$item} eq $item) {
10196: $pathchanges{$item} = 1;
10197: }
10198: $existing{$item} = 1;
10199: $numexisting ++;
10200: } else {
10201: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 10202: }
10203: }
1.1071 raeburn 10204: if ($actionurl eq '/adm/dependencies') {
10205: foreach my $path (keys(%currsubfile)) {
10206: if (ref($currsubfile{$path}) eq 'HASH') {
10207: foreach my $file (keys(%{$currsubfile{$path}})) {
10208: unless ($subdependencies{$path}{$file}) {
1.1075.2.11 raeburn 10209: next if (($rem ne '') &&
10210: (($env{"httpref.$rem"."$path/$file"} ne '') ||
10211: (ref($navmap) &&
10212: (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
10213: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
10214: ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071 raeburn 10215: $unused{$path.'/'.$file} = 1;
10216: }
10217: }
10218: }
10219: }
10220: }
1.984 raeburn 10221: }
1.987 raeburn 10222: my %currfile;
1.1075.2.35 raeburn 10223: if (($actionurl eq '/adm/portfolio') ||
10224: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 10225: my ($dirlistref,$listerror) =
10226: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
10227: if (ref($dirlistref) eq 'ARRAY') {
10228: foreach my $line (@{$dirlistref}) {
10229: my ($file_name,$rest) = split(/\&/,$line,2);
10230: $currfile{$file_name} = 1;
10231: }
1.984 raeburn 10232: }
1.987 raeburn 10233: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 10234: if (opendir(my $dir,$url)) {
1.987 raeburn 10235: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 10236: map {$currfile{$_} = 1;} @dir_list;
10237: }
1.1075.2.11 raeburn 10238: } elsif (($actionurl eq '/adm/dependencies') ||
10239: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1075.2.35 raeburn 10240: ($args->{'context'} eq 'paste')) ||
10241: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 10242: if ($env{'request.course.id'} ne '') {
10243: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
10244: if ($dir ne '') {
10245: my ($dirlistref,$listerror) =
10246: &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
10247: if (ref($dirlistref) eq 'ARRAY') {
10248: foreach my $line (@{$dirlistref}) {
10249: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
10250: $size,undef,$mtime)=split(/\&/,$line,12);
10251: unless (($testdir&$dirptr) ||
10252: ($file_name =~ /^\.\.?$/)) {
10253: $currfile{$file_name} = [$size,$mtime];
10254: }
10255: }
10256: }
10257: }
10258: }
1.984 raeburn 10259: }
10260: foreach my $file (keys(%dependencies)) {
1.1071 raeburn 10261: if (exists($currfile{$file})) {
1.987 raeburn 10262: unless ($mapping{$file} eq $file) {
10263: $pathchanges{$file} = 1;
10264: }
10265: $existing{$file} = 1;
10266: $numexisting ++;
10267: } else {
1.984 raeburn 10268: $newfiles{$file} = 1;
10269: }
10270: }
1.1071 raeburn 10271: foreach my $file (keys(%currfile)) {
10272: unless (($file eq $filename) ||
10273: ($file eq $filename.'.bak') ||
10274: ($dependencies{$file})) {
1.1075.2.11 raeburn 10275: if ($actionurl eq '/adm/dependencies') {
1.1075.2.35 raeburn 10276: unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
10277: next if (($rem ne '') &&
10278: (($env{"httpref.$rem".$file} ne '') ||
10279: (ref($navmap) &&
10280: (($navmap->getResourceByUrl($rem.$file) ne '') ||
10281: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
10282: ($navmap->getResourceByUrl($rem.$1)))))));
10283: }
1.1075.2.11 raeburn 10284: }
1.1071 raeburn 10285: $unused{$file} = 1;
10286: }
10287: }
1.1075.2.11 raeburn 10288: if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
10289: ($args->{'context'} eq 'paste')) {
10290: $counter = scalar(keys(%existing));
10291: $numpathchg = scalar(keys(%pathchanges));
10292: return ($output,$counter,$numpathchg,\%existing);
1.1075.2.35 raeburn 10293: } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
10294: (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
10295: $counter = scalar(keys(%existing));
10296: $numpathchg = scalar(keys(%pathchanges));
10297: return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1075.2.11 raeburn 10298: }
1.984 raeburn 10299: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071 raeburn 10300: if ($actionurl eq '/adm/dependencies') {
10301: next if ($embed_file =~ m{^\w+://});
10302: }
1.660 raeburn 10303: $upload_output .= &start_data_table_row().
1.1075.2.35 raeburn 10304: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
1.1071 raeburn 10305: '<span class="LC_filename">'.$embed_file.'</span>';
1.987 raeburn 10306: unless ($mapping{$embed_file} eq $embed_file) {
1.1075.2.35 raeburn 10307: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
10308: &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987 raeburn 10309: }
1.1075.2.35 raeburn 10310: $upload_output .= '</td>';
1.1071 raeburn 10311: if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) {
1.1075.2.35 raeburn 10312: $upload_output.='<td align="right">'.
10313: '<span class="LC_info LC_fontsize_medium">'.
10314: &mt("URL points to web address").'</span>';
1.987 raeburn 10315: $numremref++;
1.660 raeburn 10316: } elsif ($args->{'error_on_invalid_names'}
10317: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1075.2.35 raeburn 10318: $upload_output.='<td align="right"><span class="LC_warning">'.
10319: &mt('Invalid characters').'</span>';
1.987 raeburn 10320: $numinvalid++;
1.660 raeburn 10321: } else {
1.1075.2.35 raeburn 10322: $upload_output .= '<td>'.
10323: &embedded_file_element('upload_embedded',$counter,
1.987 raeburn 10324: $embed_file,\%mapping,
1.1071 raeburn 10325: $allfiles,$codebase,'upload');
10326: $counter ++;
10327: $numnew ++;
1.987 raeburn 10328: }
10329: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
10330: }
10331: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071 raeburn 10332: if ($actionurl eq '/adm/dependencies') {
10333: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
10334: $modify_output .= &start_data_table_row().
10335: '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
10336: '<img src="'.&icon($embed_file).'" border="0" />'.
10337: ' <span class="LC_filename">'.$embed_file.'</span></a></td>'.
10338: '<td>'.$size.'</td>'.
10339: '<td>'.$mtime.'</td>'.
10340: '<td><label><input type="checkbox" name="mod_upload_dep" '.
10341: 'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
10342: $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
10343: '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
10344: &embedded_file_element('upload_embedded',$counter,
10345: $embed_file,\%mapping,
10346: $allfiles,$codebase,'modify').
10347: '</div></td>'.
10348: &end_data_table_row()."\n";
10349: $counter ++;
10350: } else {
10351: $upload_output .= &start_data_table_row().
1.1075.2.35 raeburn 10352: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
10353: '<span class="LC_filename">'.$embed_file.'</span></td>'.
10354: '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071 raeburn 10355: &Apache::loncommon::end_data_table_row()."\n";
10356: }
10357: }
10358: my $delidx = $counter;
10359: foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
10360: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
10361: $delete_output .= &start_data_table_row().
10362: '<td><img src="'.&icon($oldfile).'" />'.
10363: ' <span class="LC_filename">'.$oldfile.'</span></td>'.
10364: '<td>'.$size.'</td>'.
10365: '<td>'.$mtime.'</td>'.
10366: '<td><label><input type="checkbox" name="del_upload_dep" '.
10367: ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
10368: &embedded_file_element('upload_embedded',$delidx,
10369: $oldfile,\%mapping,$allfiles,
10370: $codebase,'delete').'</td>'.
10371: &end_data_table_row()."\n";
10372: $numunused ++;
10373: $delidx ++;
1.987 raeburn 10374: }
10375: if ($upload_output) {
10376: $upload_output = &start_data_table().
10377: $upload_output.
10378: &end_data_table()."\n";
10379: }
1.1071 raeburn 10380: if ($modify_output) {
10381: $modify_output = &start_data_table().
10382: &start_data_table_header_row().
10383: '<th>'.&mt('File').'</th>'.
10384: '<th>'.&mt('Size (KB)').'</th>'.
10385: '<th>'.&mt('Modified').'</th>'.
10386: '<th>'.&mt('Upload replacement?').'</th>'.
10387: &end_data_table_header_row().
10388: $modify_output.
10389: &end_data_table()."\n";
10390: }
10391: if ($delete_output) {
10392: $delete_output = &start_data_table().
10393: &start_data_table_header_row().
10394: '<th>'.&mt('File').'</th>'.
10395: '<th>'.&mt('Size (KB)').'</th>'.
10396: '<th>'.&mt('Modified').'</th>'.
10397: '<th>'.&mt('Delete?').'</th>'.
10398: &end_data_table_header_row().
10399: $delete_output.
10400: &end_data_table()."\n";
10401: }
1.987 raeburn 10402: my $applies = 0;
10403: if ($numremref) {
10404: $applies ++;
10405: }
10406: if ($numinvalid) {
10407: $applies ++;
10408: }
10409: if ($numexisting) {
10410: $applies ++;
10411: }
1.1071 raeburn 10412: if ($counter || $numunused) {
1.987 raeburn 10413: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
10414: ' method="post" enctype="multipart/form-data">'."\n".
1.1071 raeburn 10415: $state.'<h3>'.$heading.'</h3>';
10416: if ($actionurl eq '/adm/dependencies') {
10417: if ($numnew) {
10418: $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
10419: '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
10420: $upload_output.'<br />'."\n";
10421: }
10422: if ($numexisting) {
10423: $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
10424: '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
10425: $modify_output.'<br />'."\n";
10426: $buttontext = &mt('Save changes');
10427: }
10428: if ($numunused) {
10429: $output .= '<h4>'.&mt('Unused files').'</h4>'.
10430: '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
10431: $delete_output.'<br />'."\n";
10432: $buttontext = &mt('Save changes');
10433: }
10434: } else {
10435: $output .= $upload_output.'<br />'."\n";
10436: }
10437: $output .= '<input type ="hidden" name="number_embedded_items" value="'.
10438: $counter.'" />'."\n";
10439: if ($actionurl eq '/adm/dependencies') {
10440: $output .= '<input type ="hidden" name="number_newemb_items" value="'.
10441: $numnew.'" />'."\n";
10442: } elsif ($actionurl eq '') {
1.987 raeburn 10443: $output .= '<input type="hidden" name="phase" value="three" />';
10444: }
10445: } elsif ($applies) {
10446: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
10447: if ($applies > 1) {
10448: $output .=
1.1075.2.35 raeburn 10449: &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987 raeburn 10450: if ($numremref) {
10451: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
10452: }
10453: if ($numinvalid) {
10454: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
10455: }
10456: if ($numexisting) {
10457: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
10458: }
10459: $output .= '</ul><br />';
10460: } elsif ($numremref) {
10461: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
10462: } elsif ($numinvalid) {
10463: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
10464: } elsif ($numexisting) {
10465: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
10466: }
10467: $output .= $upload_output.'<br />';
10468: }
10469: my ($pathchange_output,$chgcount);
1.1071 raeburn 10470: $chgcount = $counter;
1.987 raeburn 10471: if (keys(%pathchanges) > 0) {
10472: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071 raeburn 10473: if ($counter) {
1.987 raeburn 10474: $output .= &embedded_file_element('pathchange',$chgcount,
10475: $embed_file,\%mapping,
1.1071 raeburn 10476: $allfiles,$codebase,'change');
1.987 raeburn 10477: } else {
10478: $pathchange_output .=
10479: &start_data_table_row().
10480: '<td><input type ="checkbox" name="namechange" value="'.
10481: $chgcount.'" checked="checked" /></td>'.
10482: '<td>'.$mapping{$embed_file}.'</td>'.
10483: '<td>'.$embed_file.
10484: &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071 raeburn 10485: \%mapping,$allfiles,$codebase,'change').
1.987 raeburn 10486: '</td>'.&end_data_table_row();
1.660 raeburn 10487: }
1.987 raeburn 10488: $numpathchg ++;
10489: $chgcount ++;
1.660 raeburn 10490: }
10491: }
1.1075.2.35 raeburn 10492: if (($counter) || ($numunused)) {
1.987 raeburn 10493: if ($numpathchg) {
10494: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
10495: $numpathchg.'" />'."\n";
10496: }
10497: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
10498: ($actionurl eq '/adm/imsimport')) {
10499: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
10500: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
10501: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071 raeburn 10502: } elsif ($actionurl eq '/adm/dependencies') {
10503: $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987 raeburn 10504: }
1.1075.2.35 raeburn 10505: $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987 raeburn 10506: } elsif ($numpathchg) {
10507: my %pathchange = ();
10508: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
10509: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
10510: $output .= '<p>'.&mt('or').'</p>';
1.1075.2.35 raeburn 10511: }
1.987 raeburn 10512: }
1.1071 raeburn 10513: return ($output,$counter,$numpathchg);
1.987 raeburn 10514: }
10515:
1.1075.2.47 raeburn 10516: =pod
10517:
10518: =item * clean_path($name)
10519:
10520: Performs clean-up of directories, subdirectories and filename in an
10521: embedded object, referenced in an HTML file which is being uploaded
10522: to a course or portfolio, where
10523: "Upload embedded images/multimedia files if HTML file" checkbox was
10524: checked.
10525:
10526: Clean-up is similar to replacements in lonnet::clean_filename()
10527: except each / between sub-directory and next level is preserved.
10528:
10529: =cut
10530:
10531: sub clean_path {
10532: my ($embed_file) = @_;
10533: $embed_file =~s{^/+}{};
10534: my @contents;
10535: if ($embed_file =~ m{/}) {
10536: @contents = split(/\//,$embed_file);
10537: } else {
10538: @contents = ($embed_file);
10539: }
10540: my $lastidx = scalar(@contents)-1;
10541: for (my $i=0; $i<=$lastidx; $i++) {
10542: $contents[$i]=~s{\\}{/}g;
10543: $contents[$i]=~s/\s+/\_/g;
10544: $contents[$i]=~s{[^/\w\.\-]}{}g;
10545: if ($i == $lastidx) {
10546: $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
10547: }
10548: }
10549: if ($lastidx > 0) {
10550: return join('/',@contents);
10551: } else {
10552: return $contents[0];
10553: }
10554: }
10555:
1.987 raeburn 10556: sub embedded_file_element {
1.1071 raeburn 10557: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987 raeburn 10558: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
10559: (ref($codebase) eq 'HASH'));
10560: my $output;
1.1071 raeburn 10561: if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987 raeburn 10562: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
10563: }
10564: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
10565: &escape($embed_file).'" />';
10566: unless (($context eq 'upload_embedded') &&
10567: ($mapping->{$embed_file} eq $embed_file)) {
10568: $output .='
10569: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
10570: }
10571: my $attrib;
10572: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
10573: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
10574: }
10575: $output .=
10576: "\n\t\t".
10577: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
10578: $attrib.'" />';
10579: if (exists($codebase->{$mapping->{$embed_file}})) {
10580: $output .=
10581: "\n\t\t".
10582: '<input name="codebase_'.$num.'" type="hidden" value="'.
10583: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 10584: }
1.987 raeburn 10585: return $output;
1.660 raeburn 10586: }
10587:
1.1071 raeburn 10588: sub get_dependency_details {
10589: my ($currfile,$currsubfile,$embed_file) = @_;
10590: my ($size,$mtime,$showsize,$showmtime);
10591: if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
10592: if ($embed_file =~ m{/}) {
10593: my ($path,$fname) = split(/\//,$embed_file);
10594: if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
10595: ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
10596: }
10597: } else {
10598: if (ref($currfile->{$embed_file}) eq 'ARRAY') {
10599: ($size,$mtime) = @{$currfile->{$embed_file}};
10600: }
10601: }
10602: $showsize = $size/1024.0;
10603: $showsize = sprintf("%.1f",$showsize);
10604: if ($mtime > 0) {
10605: $showmtime = &Apache::lonlocal::locallocaltime($mtime);
10606: }
10607: }
10608: return ($showsize,$showmtime);
10609: }
10610:
10611: sub ask_embedded_js {
10612: return <<"END";
10613: <script type="text/javascript"">
10614: // <![CDATA[
10615: function toggleBrowse(counter) {
10616: var chkboxid = document.getElementById('mod_upload_dep_'+counter);
10617: var fileid = document.getElementById('embedded_item_'+counter);
10618: var uploaddivid = document.getElementById('moduploaddep_'+counter);
10619: if (chkboxid.checked == true) {
10620: uploaddivid.style.display='block';
10621: } else {
10622: uploaddivid.style.display='none';
10623: fileid.value = '';
10624: }
10625: }
10626: // ]]>
10627: </script>
10628:
10629: END
10630: }
10631:
1.661 raeburn 10632: sub upload_embedded {
10633: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 10634: $current_disk_usage,$hiddenstate,$actionurl) = @_;
10635: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 10636: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
10637: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
10638: my $orig_uploaded_filename =
10639: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 10640: foreach my $type ('orig','ref','attrib','codebase') {
10641: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
10642: $env{'form.embedded_'.$type.'_'.$i} =
10643: &unescape($env{'form.embedded_'.$type.'_'.$i});
10644: }
10645: }
1.661 raeburn 10646: my ($path,$fname) =
10647: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
10648: # no path, whole string is fname
10649: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
10650: $fname = &Apache::lonnet::clean_filename($fname);
10651: # See if there is anything left
10652: next if ($fname eq '');
10653:
10654: # Check if file already exists as a file or directory.
10655: my ($state,$msg);
10656: if ($context eq 'portfolio') {
10657: my $port_path = $dirpath;
10658: if ($group ne '') {
10659: $port_path = "groups/$group/$port_path";
10660: }
1.987 raeburn 10661: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
10662: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 10663: $dir_root,$port_path,$disk_quota,
10664: $current_disk_usage,$uname,$udom);
10665: if ($state eq 'will_exceed_quota'
1.984 raeburn 10666: || $state eq 'file_locked') {
1.661 raeburn 10667: $output .= $msg;
10668: next;
10669: }
10670: } elsif (($context eq 'author') || ($context eq 'testbank')) {
10671: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
10672: if ($state eq 'exists') {
10673: $output .= $msg;
10674: next;
10675: }
10676: }
10677: # Check if extension is valid
10678: if (($fname =~ /\.(\w+)$/) &&
10679: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1075.2.53 raeburn 10680: $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
10681: .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661 raeburn 10682: next;
10683: } elsif (($fname =~ /\.(\w+)$/) &&
10684: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 10685: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 10686: next;
10687: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1075.2.34 raeburn 10688: $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 10689: next;
10690: }
10691: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1075.2.35 raeburn 10692: my $subdir = $path;
10693: $subdir =~ s{/+$}{};
1.661 raeburn 10694: if ($context eq 'portfolio') {
1.984 raeburn 10695: my $result;
10696: if ($state eq 'existingfile') {
10697: $result=
10698: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1075.2.35 raeburn 10699: $dirpath.$env{'form.currentpath'}.$subdir);
1.661 raeburn 10700: } else {
1.984 raeburn 10701: $result=
10702: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 10703: $dirpath.
1.1075.2.35 raeburn 10704: $env{'form.currentpath'}.$subdir);
1.984 raeburn 10705: if ($result !~ m|^/uploaded/|) {
10706: $output .= '<span class="LC_error">'
10707: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
10708: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
10709: .'</span><br />';
10710: next;
10711: } else {
1.987 raeburn 10712: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
10713: $path.$fname.'</span>').'<br />';
1.984 raeburn 10714: }
1.661 raeburn 10715: }
1.1075.2.35 raeburn 10716: } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
10717: my $extendedsubdir = $dirpath.'/'.$subdir;
10718: $extendedsubdir =~ s{/+$}{};
1.987 raeburn 10719: my $result =
1.1075.2.35 raeburn 10720: &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987 raeburn 10721: if ($result !~ m|^/uploaded/|) {
10722: $output .= '<span class="LC_error">'
10723: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
10724: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
10725: .'</span><br />';
10726: next;
10727: } else {
10728: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
10729: $path.$fname.'</span>').'<br />';
1.1075.2.35 raeburn 10730: if ($context eq 'syllabus') {
10731: &Apache::lonnet::make_public_indefinitely($result);
10732: }
1.987 raeburn 10733: }
1.661 raeburn 10734: } else {
10735: # Save the file
10736: my $target = $env{'form.embedded_item_'.$i};
10737: my $fullpath = $dir_root.$dirpath.'/'.$path;
10738: my $dest = $fullpath.$fname;
10739: my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027 raeburn 10740: my @parts=split(/\//,"$dirpath/$path");
1.661 raeburn 10741: my $count;
10742: my $filepath = $dir_root;
1.1027 raeburn 10743: foreach my $subdir (@parts) {
10744: $filepath .= "/$subdir";
10745: if (!-e $filepath) {
1.661 raeburn 10746: mkdir($filepath,0770);
10747: }
10748: }
10749: my $fh;
10750: if (!open($fh,'>'.$dest)) {
10751: &Apache::lonnet::logthis('Failed to create '.$dest);
10752: $output .= '<span class="LC_error">'.
1.1071 raeburn 10753: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
10754: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 10755: '</span><br />';
10756: } else {
10757: if (!print $fh $env{'form.embedded_item_'.$i}) {
10758: &Apache::lonnet::logthis('Failed to write to '.$dest);
10759: $output .= '<span class="LC_error">'.
1.1071 raeburn 10760: &mt('An error occurred while writing the file [_1] for embedded element [_2].',
10761: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 10762: '</span><br />';
10763: } else {
1.987 raeburn 10764: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
10765: $url.'</span>').'<br />';
10766: unless ($context eq 'testbank') {
10767: $footer .= &mt('View embedded file: [_1]',
10768: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
10769: }
10770: }
10771: close($fh);
10772: }
10773: }
10774: if ($env{'form.embedded_ref_'.$i}) {
10775: $pathchange{$i} = 1;
10776: }
10777: }
10778: if ($output) {
10779: $output = '<p>'.$output.'</p>';
10780: }
10781: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
10782: $returnflag = 'ok';
1.1071 raeburn 10783: my $numpathchgs = scalar(keys(%pathchange));
10784: if ($numpathchgs > 0) {
1.987 raeburn 10785: if ($context eq 'portfolio') {
10786: $output .= '<p>'.&mt('or').'</p>';
10787: } elsif ($context eq 'testbank') {
1.1071 raeburn 10788: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
10789: '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987 raeburn 10790: $returnflag = 'modify_orightml';
10791: }
10792: }
1.1071 raeburn 10793: return ($output.$footer,$returnflag,$numpathchgs);
1.987 raeburn 10794: }
10795:
10796: sub modify_html_form {
10797: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
10798: my $end = 0;
10799: my $modifyform;
10800: if ($context eq 'upload_embedded') {
10801: return unless (ref($pathchange) eq 'HASH');
10802: if ($env{'form.number_embedded_items'}) {
10803: $end += $env{'form.number_embedded_items'};
10804: }
10805: if ($env{'form.number_pathchange_items'}) {
10806: $end += $env{'form.number_pathchange_items'};
10807: }
10808: if ($end) {
10809: for (my $i=0; $i<$end; $i++) {
10810: if ($i < $env{'form.number_embedded_items'}) {
10811: next unless($pathchange->{$i});
10812: }
10813: $modifyform .=
10814: &start_data_table_row().
10815: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
10816: 'checked="checked" /></td>'.
10817: '<td>'.$env{'form.embedded_ref_'.$i}.
10818: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
10819: &escape($env{'form.embedded_ref_'.$i}).'" />'.
10820: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
10821: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
10822: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
10823: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
10824: '<td>'.$env{'form.embedded_orig_'.$i}.
10825: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
10826: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
10827: &end_data_table_row();
1.1071 raeburn 10828: }
1.987 raeburn 10829: }
10830: } else {
10831: $modifyform = $pathchgtable;
10832: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
10833: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
10834: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
10835: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
10836: }
10837: }
10838: if ($modifyform) {
1.1071 raeburn 10839: if ($actionurl eq '/adm/dependencies') {
10840: $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
10841: }
1.987 raeburn 10842: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
10843: '<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".
10844: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
10845: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
10846: '</ol></p>'."\n".'<p>'.
10847: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
10848: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
10849: &start_data_table()."\n".
10850: &start_data_table_header_row().
10851: '<th>'.&mt('Change?').'</th>'.
10852: '<th>'.&mt('Current reference').'</th>'.
10853: '<th>'.&mt('Required reference').'</th>'.
10854: &end_data_table_header_row()."\n".
10855: $modifyform.
10856: &end_data_table().'<br />'."\n".$hiddenstate.
10857: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
10858: '</form>'."\n";
10859: }
10860: return;
10861: }
10862:
10863: sub modify_html_refs {
1.1075.2.35 raeburn 10864: my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987 raeburn 10865: my $container;
10866: if ($context eq 'portfolio') {
10867: $container = $env{'form.container'};
10868: } elsif ($context eq 'coursedoc') {
10869: $container = $env{'form.primaryurl'};
1.1071 raeburn 10870: } elsif ($context eq 'manage_dependencies') {
10871: (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
10872: $container = "/$container";
1.1075.2.35 raeburn 10873: } elsif ($context eq 'syllabus') {
10874: $container = $url;
1.987 raeburn 10875: } else {
1.1027 raeburn 10876: $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987 raeburn 10877: }
10878: my (%allfiles,%codebase,$output,$content);
10879: my @changes = &get_env_multiple('form.namechange');
1.1075.2.35 raeburn 10880: unless ((@changes > 0) || ($context eq 'syllabus')) {
1.1071 raeburn 10881: if (wantarray) {
10882: return ('',0,0);
10883: } else {
10884: return;
10885: }
10886: }
10887: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1075.2.35 raeburn 10888: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071 raeburn 10889: unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
10890: if (wantarray) {
10891: return ('',0,0);
10892: } else {
10893: return;
10894: }
10895: }
1.987 raeburn 10896: $content = &Apache::lonnet::getfile($container);
1.1071 raeburn 10897: if ($content eq '-1') {
10898: if (wantarray) {
10899: return ('',0,0);
10900: } else {
10901: return;
10902: }
10903: }
1.987 raeburn 10904: } else {
1.1071 raeburn 10905: unless ($container =~ /^\Q$dir_root\E/) {
10906: if (wantarray) {
10907: return ('',0,0);
10908: } else {
10909: return;
10910: }
10911: }
1.987 raeburn 10912: if (open(my $fh,"<$container")) {
10913: $content = join('', <$fh>);
10914: close($fh);
10915: } else {
1.1071 raeburn 10916: if (wantarray) {
10917: return ('',0,0);
10918: } else {
10919: return;
10920: }
1.987 raeburn 10921: }
10922: }
10923: my ($count,$codebasecount) = (0,0);
10924: my $mm = new File::MMagic;
10925: my $mime_type = $mm->checktype_contents($content);
10926: if ($mime_type eq 'text/html') {
10927: my $parse_result =
10928: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
10929: \%codebase,\$content);
10930: if ($parse_result eq 'ok') {
10931: foreach my $i (@changes) {
10932: my $orig = &unescape($env{'form.embedded_orig_'.$i});
10933: my $ref = &unescape($env{'form.embedded_ref_'.$i});
10934: if ($allfiles{$ref}) {
10935: my $newname = $orig;
10936: my ($attrib_regexp,$codebase);
1.1006 raeburn 10937: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 10938: if ($attrib_regexp =~ /:/) {
10939: $attrib_regexp =~ s/\:/|/g;
10940: }
10941: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
10942: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
10943: $count += $numchg;
1.1075.2.35 raeburn 10944: $allfiles{$newname} = $allfiles{$ref};
1.1075.2.48 raeburn 10945: delete($allfiles{$ref});
1.987 raeburn 10946: }
10947: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 10948: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 10949: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
10950: $codebasecount ++;
10951: }
10952: }
10953: }
1.1075.2.35 raeburn 10954: my $skiprewrites;
1.987 raeburn 10955: if ($count || $codebasecount) {
10956: my $saveresult;
1.1071 raeburn 10957: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1075.2.35 raeburn 10958: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987 raeburn 10959: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
10960: if ($url eq $container) {
10961: my ($fname) = ($container =~ m{/([^/]+)$});
10962: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
10963: $count,'<span class="LC_filename">'.
1.1071 raeburn 10964: $fname.'</span>').'</p>';
1.987 raeburn 10965: } else {
10966: $output = '<p class="LC_error">'.
10967: &mt('Error: update failed for: [_1].',
10968: '<span class="LC_filename">'.
10969: $container.'</span>').'</p>';
10970: }
1.1075.2.35 raeburn 10971: if ($context eq 'syllabus') {
10972: unless ($saveresult eq 'ok') {
10973: $skiprewrites = 1;
10974: }
10975: }
1.987 raeburn 10976: } else {
10977: if (open(my $fh,">$container")) {
10978: print $fh $content;
10979: close($fh);
10980: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
10981: $count,'<span class="LC_filename">'.
10982: $container.'</span>').'</p>';
1.661 raeburn 10983: } else {
1.987 raeburn 10984: $output = '<p class="LC_error">'.
10985: &mt('Error: could not update [_1].',
10986: '<span class="LC_filename">'.
10987: $container.'</span>').'</p>';
1.661 raeburn 10988: }
10989: }
10990: }
1.1075.2.35 raeburn 10991: if (($context eq 'syllabus') && (!$skiprewrites)) {
10992: my ($actionurl,$state);
10993: $actionurl = "/public/$udom/$uname/syllabus";
10994: my ($ignore,$num,$numpathchanges,$existing,$mapping) =
10995: &ask_for_embedded_content($actionurl,$state,\%allfiles,
10996: \%codebase,
10997: {'context' => 'rewrites',
10998: 'ignore_remote_references' => 1,});
10999: if (ref($mapping) eq 'HASH') {
11000: my $rewrites = 0;
11001: foreach my $key (keys(%{$mapping})) {
11002: next if ($key =~ m{^https?://});
11003: my $ref = $mapping->{$key};
11004: my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
11005: my $attrib;
11006: if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
11007: $attrib = join('|',@{$allfiles{$mapping->{$key}}});
11008: }
11009: if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
11010: my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
11011: $rewrites += $numchg;
11012: }
11013: }
11014: if ($rewrites) {
11015: my $saveresult;
11016: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
11017: if ($url eq $container) {
11018: my ($fname) = ($container =~ m{/([^/]+)$});
11019: $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
11020: $count,'<span class="LC_filename">'.
11021: $fname.'</span>').'</p>';
11022: } else {
11023: $output .= '<p class="LC_error">'.
11024: &mt('Error: could not update links in [_1].',
11025: '<span class="LC_filename">'.
11026: $container.'</span>').'</p>';
11027:
11028: }
11029: }
11030: }
11031: }
1.987 raeburn 11032: } else {
11033: &logthis('Failed to parse '.$container.
11034: ' to modify references: '.$parse_result);
1.661 raeburn 11035: }
11036: }
1.1071 raeburn 11037: if (wantarray) {
11038: return ($output,$count,$codebasecount);
11039: } else {
11040: return $output;
11041: }
1.661 raeburn 11042: }
11043:
11044: sub check_for_existing {
11045: my ($path,$fname,$element) = @_;
11046: my ($state,$msg);
11047: if (-d $path.'/'.$fname) {
11048: $state = 'exists';
11049: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
11050: } elsif (-e $path.'/'.$fname) {
11051: $state = 'exists';
11052: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
11053: }
11054: if ($state eq 'exists') {
11055: $msg = '<span class="LC_error">'.$msg.'</span><br />';
11056: }
11057: return ($state,$msg);
11058: }
11059:
11060: sub check_for_upload {
11061: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
11062: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 11063: my $filesize = length($env{'form.'.$element});
11064: if (!$filesize) {
11065: my $msg = '<span class="LC_error">'.
11066: &mt('Unable to upload [_1]. (size = [_2] bytes)',
11067: '<span class="LC_filename">'.$fname.'</span>',
11068: $filesize).'<br />'.
1.1007 raeburn 11069: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 11070: '</span>';
11071: return ('zero_bytes',$msg);
11072: }
11073: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 11074: my $getpropath = 1;
1.1021 raeburn 11075: my ($dirlistref,$listerror) =
11076: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 11077: my $found_file = 0;
11078: my $locked_file = 0;
1.991 raeburn 11079: my @lockers;
11080: my $navmap;
11081: if ($env{'request.course.id'}) {
11082: $navmap = Apache::lonnavmaps::navmap->new();
11083: }
1.1021 raeburn 11084: if (ref($dirlistref) eq 'ARRAY') {
11085: foreach my $line (@{$dirlistref}) {
11086: my ($file_name,$rest)=split(/\&/,$line,2);
11087: if ($file_name eq $fname){
11088: $file_name = $path.$file_name;
11089: if ($group ne '') {
11090: $file_name = $group.$file_name;
11091: }
11092: $found_file = 1;
11093: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
11094: foreach my $lock (@lockers) {
11095: if (ref($lock) eq 'ARRAY') {
11096: my ($symb,$crsid) = @{$lock};
11097: if ($crsid eq $env{'request.course.id'}) {
11098: if (ref($navmap)) {
11099: my $res = $navmap->getBySymb($symb);
11100: foreach my $part (@{$res->parts()}) {
11101: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
11102: unless (($slot_status == $res->RESERVED) ||
11103: ($slot_status == $res->RESERVED_LOCATION)) {
11104: $locked_file = 1;
11105: }
1.991 raeburn 11106: }
1.1021 raeburn 11107: } else {
11108: $locked_file = 1;
1.991 raeburn 11109: }
11110: } else {
11111: $locked_file = 1;
11112: }
11113: }
1.1021 raeburn 11114: }
11115: } else {
11116: my @info = split(/\&/,$rest);
11117: my $currsize = $info[6]/1000;
11118: if ($currsize < $filesize) {
11119: my $extra = $filesize - $currsize;
11120: if (($current_disk_usage + $extra) > $disk_quota) {
1.1075.2.69 raeburn 11121: my $msg = '<p class="LC_warning">'.
1.1021 raeburn 11122: &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.',
1.1075.2.69 raeburn 11123: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
11124: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
11125: $disk_quota,$current_disk_usage).'</p>';
1.1021 raeburn 11126: return ('will_exceed_quota',$msg);
11127: }
1.984 raeburn 11128: }
11129: }
1.661 raeburn 11130: }
11131: }
11132: }
11133: if (($current_disk_usage + $filesize) > $disk_quota){
1.1075.2.69 raeburn 11134: my $msg = '<p class="LC_warning">'.
11135: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
11136: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661 raeburn 11137: return ('will_exceed_quota',$msg);
11138: } elsif ($found_file) {
11139: if ($locked_file) {
1.1075.2.69 raeburn 11140: my $msg = '<p class="LC_warning">';
1.661 raeburn 11141: $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>');
1.1075.2.69 raeburn 11142: $msg .= '</p>';
1.661 raeburn 11143: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
11144: return ('file_locked',$msg);
11145: } else {
1.1075.2.69 raeburn 11146: my $msg = '<p class="LC_error">';
1.984 raeburn 11147: $msg .= &mt(' A file by that name: [_1] was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$port_path.$env{'form.currentpath'});
1.1075.2.69 raeburn 11148: $msg .= '</p>';
1.984 raeburn 11149: return ('existingfile',$msg);
1.661 raeburn 11150: }
11151: }
11152: }
11153:
1.987 raeburn 11154: sub check_for_traversal {
11155: my ($path,$url,$toplevel) = @_;
11156: my @parts=split(/\//,$path);
11157: my $cleanpath;
11158: my $fullpath = $url;
11159: for (my $i=0;$i<@parts;$i++) {
11160: next if ($parts[$i] eq '.');
11161: if ($parts[$i] eq '..') {
11162: $fullpath =~ s{([^/]+/)$}{};
11163: } else {
11164: $fullpath .= $parts[$i].'/';
11165: }
11166: }
11167: if ($fullpath =~ /^\Q$url\E(.*)$/) {
11168: $cleanpath = $1;
11169: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
11170: my $curr_toprel = $1;
11171: my @parts = split(/\//,$curr_toprel);
11172: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
11173: my @urlparts = split(/\//,$url_toprel);
11174: my $doubledots;
11175: my $startdiff = -1;
11176: for (my $i=0; $i<@urlparts; $i++) {
11177: if ($startdiff == -1) {
11178: unless ($urlparts[$i] eq $parts[$i]) {
11179: $startdiff = $i;
11180: $doubledots .= '../';
11181: }
11182: } else {
11183: $doubledots .= '../';
11184: }
11185: }
11186: if ($startdiff > -1) {
11187: $cleanpath = $doubledots;
11188: for (my $i=$startdiff; $i<@parts; $i++) {
11189: $cleanpath .= $parts[$i].'/';
11190: }
11191: }
11192: }
11193: $cleanpath =~ s{(/)$}{};
11194: return $cleanpath;
11195: }
1.31 albertel 11196:
1.1053 raeburn 11197: sub is_archive_file {
11198: my ($mimetype) = @_;
11199: if (($mimetype eq 'application/octet-stream') ||
11200: ($mimetype eq 'application/x-stuffit') ||
11201: ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
11202: return 1;
11203: }
11204: return;
11205: }
11206:
11207: sub decompress_form {
1.1065 raeburn 11208: my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053 raeburn 11209: my %lt = &Apache::lonlocal::texthash (
11210: this => 'This file is an archive file.',
1.1067 raeburn 11211: camt => 'This file is a Camtasia archive file.',
1.1065 raeburn 11212: itsc => 'Its contents are as follows:',
1.1053 raeburn 11213: youm => 'You may wish to extract its contents.',
11214: extr => 'Extract contents',
1.1067 raeburn 11215: auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
11216: proa => 'Process automatically?',
1.1053 raeburn 11217: yes => 'Yes',
11218: no => 'No',
1.1067 raeburn 11219: fold => 'Title for folder containing movie',
11220: movi => 'Title for page containing embedded movie',
1.1053 raeburn 11221: );
1.1065 raeburn 11222: my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067 raeburn 11223: my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065 raeburn 11224: my $info = &list_archive_contents($fileloc,\@paths);
11225: if (@paths) {
11226: foreach my $path (@paths) {
11227: $path =~ s{^/}{};
1.1067 raeburn 11228: if ($path =~ m{^([^/]+)/$}) {
11229: $topdir = $1;
11230: }
1.1065 raeburn 11231: if ($path =~ m{^([^/]+)/}) {
11232: $toplevel{$1} = $path;
11233: } else {
11234: $toplevel{$path} = $path;
11235: }
11236: }
11237: }
1.1067 raeburn 11238: if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1075.2.59 raeburn 11239: my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067 raeburn 11240: "$topdir/media/",
11241: "$topdir/media/$topdir.mp4",
11242: "$topdir/media/FirstFrame.png",
11243: "$topdir/media/player.swf",
11244: "$topdir/media/swfobject.js",
11245: "$topdir/media/expressInstall.swf");
1.1075.2.81 raeburn 11246: my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1075.2.59 raeburn 11247: "$topdir/$topdir.mp4",
11248: "$topdir/$topdir\_config.xml",
11249: "$topdir/$topdir\_controller.swf",
11250: "$topdir/$topdir\_embed.css",
11251: "$topdir/$topdir\_First_Frame.png",
11252: "$topdir/$topdir\_player.html",
11253: "$topdir/$topdir\_Thumbnails.png",
11254: "$topdir/playerProductInstall.swf",
11255: "$topdir/scripts/",
11256: "$topdir/scripts/config_xml.js",
11257: "$topdir/scripts/handlebars.js",
11258: "$topdir/scripts/jquery-1.7.1.min.js",
11259: "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
11260: "$topdir/scripts/modernizr.js",
11261: "$topdir/scripts/player-min.js",
11262: "$topdir/scripts/swfobject.js",
11263: "$topdir/skins/",
11264: "$topdir/skins/configuration_express.xml",
11265: "$topdir/skins/express_show/",
11266: "$topdir/skins/express_show/player-min.css",
11267: "$topdir/skins/express_show/spritesheet.png");
1.1075.2.81 raeburn 11268: my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
11269: "$topdir/$topdir.mp4",
11270: "$topdir/$topdir\_config.xml",
11271: "$topdir/$topdir\_controller.swf",
11272: "$topdir/$topdir\_embed.css",
11273: "$topdir/$topdir\_First_Frame.png",
11274: "$topdir/$topdir\_player.html",
11275: "$topdir/$topdir\_Thumbnails.png",
11276: "$topdir/playerProductInstall.swf",
11277: "$topdir/scripts/",
11278: "$topdir/scripts/config_xml.js",
11279: "$topdir/scripts/techsmith-smart-player.min.js",
11280: "$topdir/skins/",
11281: "$topdir/skins/configuration_express.xml",
11282: "$topdir/skins/express_show/",
11283: "$topdir/skins/express_show/spritesheet.min.css",
11284: "$topdir/skins/express_show/spritesheet.png",
11285: "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1075.2.59 raeburn 11286: my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067 raeburn 11287: if (@diffs == 0) {
1.1075.2.59 raeburn 11288: $is_camtasia = 6;
11289: } else {
1.1075.2.81 raeburn 11290: @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1075.2.59 raeburn 11291: if (@diffs == 0) {
11292: $is_camtasia = 8;
1.1075.2.81 raeburn 11293: } else {
11294: @diffs = &compare_arrays(\@paths,\@camtasia8_4);
11295: if (@diffs == 0) {
11296: $is_camtasia = 8;
11297: }
1.1075.2.59 raeburn 11298: }
1.1067 raeburn 11299: }
11300: }
11301: my $output;
11302: if ($is_camtasia) {
11303: $output = <<"ENDCAM";
11304: <script type="text/javascript" language="Javascript">
11305: // <![CDATA[
11306:
11307: function camtasiaToggle() {
11308: for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
11309: if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1075.2.59 raeburn 11310: if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067 raeburn 11311: document.getElementById('camtasia_titles').style.display='block';
11312: } else {
11313: document.getElementById('camtasia_titles').style.display='none';
11314: }
11315: }
11316: }
11317: return;
11318: }
11319:
11320: // ]]>
11321: </script>
11322: <p>$lt{'camt'}</p>
11323: ENDCAM
1.1065 raeburn 11324: } else {
1.1067 raeburn 11325: $output = '<p>'.$lt{'this'};
11326: if ($info eq '') {
11327: $output .= ' '.$lt{'youm'}.'</p>'."\n";
11328: } else {
11329: $output .= ' '.$lt{'itsc'}.'</p>'."\n".
11330: '<div><pre>'.$info.'</pre></div>';
11331: }
1.1065 raeburn 11332: }
1.1067 raeburn 11333: $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065 raeburn 11334: my $duplicates;
11335: my $num = 0;
11336: if (ref($dirlist) eq 'ARRAY') {
11337: foreach my $item (@{$dirlist}) {
11338: if (ref($item) eq 'ARRAY') {
11339: if (exists($toplevel{$item->[0]})) {
11340: $duplicates .=
11341: &start_data_table_row().
11342: '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
11343: 'value="0" checked="checked" />'.&mt('No').'</label>'.
11344: ' <label><input type="radio" name="archive_overwrite_'.$num.'" '.
11345: 'value="1" />'.&mt('Yes').'</label>'.
11346: '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
11347: '<td>'.$item->[0].'</td>';
11348: if ($item->[2]) {
11349: $duplicates .= '<td>'.&mt('Directory').'</td>';
11350: } else {
11351: $duplicates .= '<td>'.&mt('File').'</td>';
11352: }
11353: $duplicates .= '<td>'.$item->[3].'</td>'.
11354: '<td>'.
11355: &Apache::lonlocal::locallocaltime($item->[4]).
11356: '</td>'.
11357: &end_data_table_row();
11358: $num ++;
11359: }
11360: }
11361: }
11362: }
11363: my $itemcount;
11364: if (@paths > 0) {
11365: $itemcount = scalar(@paths);
11366: } else {
11367: $itemcount = 1;
11368: }
1.1067 raeburn 11369: if ($is_camtasia) {
11370: $output .= $lt{'auto'}.'<br />'.
11371: '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1075.2.59 raeburn 11372: '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067 raeburn 11373: $lt{'yes'}.'</label> <label>'.
11374: '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
11375: $lt{'no'}.'</label></span><br />'.
11376: '<div id="camtasia_titles" style="display:block">'.
11377: &Apache::lonhtmlcommon::start_pick_box().
11378: &Apache::lonhtmlcommon::row_title($lt{'fold'}).
11379: '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
11380: &Apache::lonhtmlcommon::row_closure().
11381: &Apache::lonhtmlcommon::row_title($lt{'movi'}).
11382: '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
11383: &Apache::lonhtmlcommon::row_closure(1).
11384: &Apache::lonhtmlcommon::end_pick_box().
11385: '</div>';
11386: }
1.1065 raeburn 11387: $output .=
11388: '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067 raeburn 11389: '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
11390: "\n";
1.1065 raeburn 11391: if ($duplicates ne '') {
11392: $output .= '<p><span class="LC_warning">'.
11393: &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.
11394: &start_data_table().
11395: &start_data_table_header_row().
11396: '<th>'.&mt('Overwrite?').'</th>'.
11397: '<th>'.&mt('Name').'</th>'.
11398: '<th>'.&mt('Type').'</th>'.
11399: '<th>'.&mt('Size').'</th>'.
11400: '<th>'.&mt('Last modified').'</th>'.
11401: &end_data_table_header_row().
11402: $duplicates.
11403: &end_data_table().
11404: '</p>';
11405: }
1.1067 raeburn 11406: $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053 raeburn 11407: if (ref($hiddenelements) eq 'HASH') {
11408: foreach my $hidden (sort(keys(%{$hiddenelements}))) {
11409: $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
11410: }
11411: }
11412: $output .= <<"END";
1.1067 raeburn 11413: <br />
1.1053 raeburn 11414: <input type="submit" name="decompress" value="$lt{'extr'}" />
11415: </form>
11416: $noextract
11417: END
11418: return $output;
11419: }
11420:
1.1065 raeburn 11421: sub decompression_utility {
11422: my ($program) = @_;
11423: my @utilities = ('tar','gunzip','bunzip2','unzip');
11424: my $location;
11425: if (grep(/^\Q$program\E$/,@utilities)) {
11426: foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
11427: '/usr/sbin/') {
11428: if (-x $dir.$program) {
11429: $location = $dir.$program;
11430: last;
11431: }
11432: }
11433: }
11434: return $location;
11435: }
11436:
11437: sub list_archive_contents {
11438: my ($file,$pathsref) = @_;
11439: my (@cmd,$output);
11440: my $needsregexp;
11441: if ($file =~ /\.zip$/) {
11442: @cmd = (&decompression_utility('unzip'),"-l");
11443: $needsregexp = 1;
11444: } elsif (($file =~ m/\.tar\.gz$/) ||
11445: ($file =~ /\.tgz$/)) {
11446: @cmd = (&decompression_utility('tar'),"-ztf");
11447: } elsif ($file =~ /\.tar\.bz2$/) {
11448: @cmd = (&decompression_utility('tar'),"-jtf");
11449: } elsif ($file =~ m|\.tar$|) {
11450: @cmd = (&decompression_utility('tar'),"-tf");
11451: }
11452: if (@cmd) {
11453: undef($!);
11454: undef($@);
11455: if (open(my $fh,"-|", @cmd, $file)) {
11456: while (my $line = <$fh>) {
11457: $output .= $line;
11458: chomp($line);
11459: my $item;
11460: if ($needsregexp) {
11461: ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/);
11462: } else {
11463: $item = $line;
11464: }
11465: if ($item ne '') {
11466: unless (grep(/^\Q$item\E$/,@{$pathsref})) {
11467: push(@{$pathsref},$item);
11468: }
11469: }
11470: }
11471: close($fh);
11472: }
11473: }
11474: return $output;
11475: }
11476:
1.1053 raeburn 11477: sub decompress_uploaded_file {
11478: my ($file,$dir) = @_;
11479: &Apache::lonnet::appenv({'cgi.file' => $file});
11480: &Apache::lonnet::appenv({'cgi.dir' => $dir});
11481: my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
11482: my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
11483: my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
11484: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
11485: my $decompressed = $env{'cgi.decompressed'};
11486: &Apache::lonnet::delenv('cgi.file');
11487: &Apache::lonnet::delenv('cgi.dir');
11488: &Apache::lonnet::delenv('cgi.decompressed');
11489: return ($decompressed,$result);
11490: }
11491:
1.1055 raeburn 11492: sub process_decompression {
11493: my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
11494: my ($dir,$error,$warning,$output);
1.1075.2.69 raeburn 11495: if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1075.2.34 raeburn 11496: $error = &mt('Filename not a supported archive file type.').
11497: '<br />'.&mt('Filename should end with one of: [_1].',
1.1055 raeburn 11498: '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
11499: } else {
11500: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
11501: if ($docuhome eq 'no_host') {
11502: $error = &mt('Could not determine home server for course.');
11503: } else {
11504: my @ids=&Apache::lonnet::current_machine_ids();
11505: my $currdir = "$dir_root/$destination";
11506: if (grep(/^\Q$docuhome\E$/,@ids)) {
11507: $dir = &LONCAPA::propath($docudom,$docuname).
11508: "$dir_root/$destination";
11509: } else {
11510: $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
11511: "$dir_root/$docudom/$docuname/$destination";
11512: unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
11513: $error = &mt('Archive file not found.');
11514: }
11515: }
1.1065 raeburn 11516: my (@to_overwrite,@to_skip);
11517: if ($env{'form.archive_overwrite_total'} > 0) {
11518: my $total = $env{'form.archive_overwrite_total'};
11519: for (my $i=0; $i<$total; $i++) {
11520: if ($env{'form.archive_overwrite_'.$i} == 1) {
11521: push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
11522: } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
11523: push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
11524: }
11525: }
11526: }
11527: my $numskip = scalar(@to_skip);
11528: if (($numskip > 0) &&
11529: ($numskip == $env{'form.archive_itemcount'})) {
11530: $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');
11531: } elsif ($dir eq '') {
1.1055 raeburn 11532: $error = &mt('Directory containing archive file unavailable.');
11533: } elsif (!$error) {
1.1065 raeburn 11534: my ($decompressed,$display);
11535: if ($numskip > 0) {
11536: my $tempdir = time.'_'.$$.int(rand(10000));
11537: mkdir("$dir/$tempdir",0755);
11538: system("mv $dir/$file $dir/$tempdir/$file");
11539: ($decompressed,$display) =
11540: &decompress_uploaded_file($file,"$dir/$tempdir");
11541: foreach my $item (@to_skip) {
11542: if (($item ne '') && ($item !~ /\.\./)) {
11543: if (-f "$dir/$tempdir/$item") {
11544: unlink("$dir/$tempdir/$item");
11545: } elsif (-d "$dir/$tempdir/$item") {
11546: system("rm -rf $dir/$tempdir/$item");
11547: }
11548: }
11549: }
11550: system("mv $dir/$tempdir/* $dir");
11551: rmdir("$dir/$tempdir");
11552: } else {
11553: ($decompressed,$display) =
11554: &decompress_uploaded_file($file,$dir);
11555: }
1.1055 raeburn 11556: if ($decompressed eq 'ok') {
1.1065 raeburn 11557: $output = '<p class="LC_info">'.
11558: &mt('Files extracted successfully from archive.').
11559: '</p>'."\n";
1.1055 raeburn 11560: my ($warning,$result,@contents);
11561: my ($newdirlistref,$newlisterror) =
11562: &Apache::lonnet::dirlist($currdir,$docudom,
11563: $docuname,1);
11564: my (%is_dir,%changes,@newitems);
11565: my $dirptr = 16384;
1.1065 raeburn 11566: if (ref($newdirlistref) eq 'ARRAY') {
1.1055 raeburn 11567: foreach my $dir_line (@{$newdirlistref}) {
11568: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1065 raeburn 11569: unless (($item =~ /^\.+$/) || ($item eq $file) ||
11570: ((@to_skip > 0) && (grep(/^\Q$item\E$/,@to_skip)))) {
1.1055 raeburn 11571: push(@newitems,$item);
11572: if ($dirptr&$testdir) {
11573: $is_dir{$item} = 1;
11574: }
11575: $changes{$item} = 1;
11576: }
11577: }
11578: }
11579: if (keys(%changes) > 0) {
11580: foreach my $item (sort(@newitems)) {
11581: if ($changes{$item}) {
11582: push(@contents,$item);
11583: }
11584: }
11585: }
11586: if (@contents > 0) {
1.1067 raeburn 11587: my $wantform;
11588: unless ($env{'form.autoextract_camtasia'}) {
11589: $wantform = 1;
11590: }
1.1056 raeburn 11591: my (%children,%parent,%dirorder,%titles);
1.1055 raeburn 11592: my ($count,$datatable) = &get_extracted($docudom,$docuname,
11593: $currdir,\%is_dir,
11594: \%children,\%parent,
1.1056 raeburn 11595: \@contents,\%dirorder,
11596: \%titles,$wantform);
1.1055 raeburn 11597: if ($datatable ne '') {
11598: $output .= &archive_options_form('decompressed',$datatable,
11599: $count,$hiddenelem);
1.1065 raeburn 11600: my $startcount = 6;
1.1055 raeburn 11601: $output .= &archive_javascript($startcount,$count,
1.1056 raeburn 11602: \%titles,\%children);
1.1055 raeburn 11603: }
1.1067 raeburn 11604: if ($env{'form.autoextract_camtasia'}) {
1.1075.2.59 raeburn 11605: my $version = $env{'form.autoextract_camtasia'};
1.1067 raeburn 11606: my %displayed;
11607: my $total = 1;
11608: $env{'form.archive_directory'} = [];
11609: foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
11610: my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
11611: $path =~ s{/$}{};
11612: my $item;
11613: if ($path ne '') {
11614: $item = "$path/$titles{$i}";
11615: } else {
11616: $item = $titles{$i};
11617: }
11618: $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
11619: if ($item eq $contents[0]) {
11620: push(@{$env{'form.archive_directory'}},$i);
11621: $env{'form.archive_'.$i} = 'display';
11622: $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
11623: $displayed{'folder'} = $i;
1.1075.2.59 raeburn 11624: } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
11625: (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067 raeburn 11626: $env{'form.archive_'.$i} = 'display';
11627: $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
11628: $displayed{'web'} = $i;
11629: } else {
1.1075.2.59 raeburn 11630: if ((($item eq "$contents[0]/media") && ($version == 6)) ||
11631: ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
11632: ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067 raeburn 11633: push(@{$env{'form.archive_directory'}},$i);
11634: }
11635: $env{'form.archive_'.$i} = 'dependency';
11636: }
11637: $total ++;
11638: }
11639: for (my $i=1; $i<$total; $i++) {
11640: next if ($i == $displayed{'web'});
11641: next if ($i == $displayed{'folder'});
11642: $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
11643: }
11644: $env{'form.phase'} = 'decompress_cleanup';
11645: $env{'form.archivedelete'} = 1;
11646: $env{'form.archive_count'} = $total-1;
11647: $output .=
11648: &process_extracted_files('coursedocs',$docudom,
11649: $docuname,$destination,
11650: $dir_root,$hiddenelem);
11651: }
1.1055 raeburn 11652: } else {
11653: $warning = &mt('No new items extracted from archive file.');
11654: }
11655: } else {
11656: $output = $display;
11657: $error = &mt('An error occurred during extraction from the archive file.');
11658: }
11659: }
11660: }
11661: }
11662: if ($error) {
11663: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
11664: $error.'</p>'."\n";
11665: }
11666: if ($warning) {
11667: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
11668: }
11669: return $output;
11670: }
11671:
11672: sub get_extracted {
1.1056 raeburn 11673: my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
11674: $titles,$wantform) = @_;
1.1055 raeburn 11675: my $count = 0;
11676: my $depth = 0;
11677: my $datatable;
1.1056 raeburn 11678: my @hierarchy;
1.1055 raeburn 11679: return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056 raeburn 11680: (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
11681: (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055 raeburn 11682: foreach my $item (@{$contents}) {
11683: $count ++;
1.1056 raeburn 11684: @{$dirorder->{$count}} = @hierarchy;
11685: $titles->{$count} = $item;
1.1055 raeburn 11686: &archive_hierarchy($depth,$count,$parent,$children);
11687: if ($wantform) {
11688: $datatable .= &archive_row($is_dir->{$item},$item,
11689: $currdir,$depth,$count);
11690: }
11691: if ($is_dir->{$item}) {
11692: $depth ++;
1.1056 raeburn 11693: push(@hierarchy,$count);
11694: $parent->{$depth} = $count;
1.1055 raeburn 11695: $datatable .=
11696: &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056 raeburn 11697: \$depth,\$count,\@hierarchy,$dirorder,
11698: $children,$parent,$titles,$wantform);
1.1055 raeburn 11699: $depth --;
1.1056 raeburn 11700: pop(@hierarchy);
1.1055 raeburn 11701: }
11702: }
11703: return ($count,$datatable);
11704: }
11705:
11706: sub recurse_extracted_archive {
1.1056 raeburn 11707: my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
11708: $children,$parent,$titles,$wantform) = @_;
1.1055 raeburn 11709: my $result='';
1.1056 raeburn 11710: unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
11711: (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
11712: (ref($dirorder) eq 'HASH')) {
1.1055 raeburn 11713: return $result;
11714: }
11715: my $dirptr = 16384;
11716: my ($newdirlistref,$newlisterror) =
11717: &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
11718: if (ref($newdirlistref) eq 'ARRAY') {
11719: foreach my $dir_line (@{$newdirlistref}) {
11720: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
11721: unless ($item =~ /^\.+$/) {
11722: $$count ++;
1.1056 raeburn 11723: @{$dirorder->{$$count}} = @{$hierarchy};
11724: $titles->{$$count} = $item;
1.1055 raeburn 11725: &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056 raeburn 11726:
1.1055 raeburn 11727: my $is_dir;
11728: if ($dirptr&$testdir) {
11729: $is_dir = 1;
11730: }
11731: if ($wantform) {
11732: $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
11733: }
11734: if ($is_dir) {
11735: $$depth ++;
1.1056 raeburn 11736: push(@{$hierarchy},$$count);
11737: $parent->{$$depth} = $$count;
1.1055 raeburn 11738: $result .=
11739: &recurse_extracted_archive("$currdir/$item",$docudom,
11740: $docuname,$depth,$count,
1.1056 raeburn 11741: $hierarchy,$dirorder,$children,
11742: $parent,$titles,$wantform);
1.1055 raeburn 11743: $$depth --;
1.1056 raeburn 11744: pop(@{$hierarchy});
1.1055 raeburn 11745: }
11746: }
11747: }
11748: }
11749: return $result;
11750: }
11751:
11752: sub archive_hierarchy {
11753: my ($depth,$count,$parent,$children) =@_;
11754: if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
11755: if (exists($parent->{$depth})) {
11756: $children->{$parent->{$depth}} .= $count.':';
11757: }
11758: }
11759: return;
11760: }
11761:
11762: sub archive_row {
11763: my ($is_dir,$item,$currdir,$depth,$count) = @_;
11764: my ($name) = ($item =~ m{([^/]+)$});
11765: my %choices = &Apache::lonlocal::texthash (
1.1059 raeburn 11766: 'display' => 'Add as file',
1.1055 raeburn 11767: 'dependency' => 'Include as dependency',
11768: 'discard' => 'Discard',
11769: );
11770: if ($is_dir) {
1.1059 raeburn 11771: $choices{'display'} = &mt('Add as folder');
1.1055 raeburn 11772: }
1.1056 raeburn 11773: my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
11774: my $offset = 0;
1.1055 raeburn 11775: foreach my $action ('display','dependency','discard') {
1.1056 raeburn 11776: $offset ++;
1.1065 raeburn 11777: if ($action ne 'display') {
11778: $offset ++;
11779: }
1.1055 raeburn 11780: $output .= '<td><span class="LC_nobreak">'.
11781: '<label><input type="radio" name="archive_'.$count.
11782: '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
11783: my $text = $choices{$action};
11784: if ($is_dir) {
11785: $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
11786: if ($action eq 'display') {
1.1059 raeburn 11787: $text = &mt('Add as folder');
1.1055 raeburn 11788: }
1.1056 raeburn 11789: } else {
11790: $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
11791:
11792: }
11793: $output .= ' /> '.$choices{$action}.'</label></span>';
11794: if ($action eq 'dependency') {
11795: $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
11796: &mt('Used by:').' <select name="archive_dependent_on_'.$count.'" '.
11797: 'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
11798: '<option value=""></option>'."\n".
11799: '</select>'."\n".
11800: '</div>';
1.1059 raeburn 11801: } elsif ($action eq 'display') {
11802: $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
11803: &mt('Title:').' <input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
11804: '</div>';
1.1055 raeburn 11805: }
1.1056 raeburn 11806: $output .= '</td>';
1.1055 raeburn 11807: }
11808: $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
11809: &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.(' ' x 2);
11810: for (my $i=0; $i<$depth; $i++) {
11811: $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
11812: }
11813: if ($is_dir) {
11814: $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" /> '."\n".
11815: '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
11816: } else {
11817: $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
11818: }
11819: $output .= ' '.$name.'</td>'."\n".
11820: &end_data_table_row();
11821: return $output;
11822: }
11823:
11824: sub archive_options_form {
1.1065 raeburn 11825: my ($form,$display,$count,$hiddenelem) = @_;
11826: my %lt = &Apache::lonlocal::texthash(
11827: perm => 'Permanently remove archive file?',
11828: hows => 'How should each extracted item be incorporated in the course?',
11829: cont => 'Content actions for all',
11830: addf => 'Add as folder/file',
11831: incd => 'Include as dependency for a displayed file',
11832: disc => 'Discard',
11833: no => 'No',
11834: yes => 'Yes',
11835: save => 'Save',
11836: );
11837: my $output = <<"END";
11838: <form name="$form" method="post" action="">
11839: <p><span class="LC_nobreak">$lt{'perm'}
11840: <label>
11841: <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
11842: </label>
11843:
11844: <label>
11845: <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
11846: </span>
11847: </p>
11848: <input type="hidden" name="phase" value="decompress_cleanup" />
11849: <br />$lt{'hows'}
11850: <div class="LC_columnSection">
11851: <fieldset>
11852: <legend>$lt{'cont'}</legend>
11853: <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" />
11854: <input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
11855: <input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
11856: </fieldset>
11857: </div>
11858: END
11859: return $output.
1.1055 raeburn 11860: &start_data_table()."\n".
1.1065 raeburn 11861: $display."\n".
1.1055 raeburn 11862: &end_data_table()."\n".
11863: '<input type="hidden" name="archive_count" value="'.$count.'" />'.
11864: $hiddenelem.
1.1065 raeburn 11865: '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055 raeburn 11866: '</form>';
11867: }
11868:
11869: sub archive_javascript {
1.1056 raeburn 11870: my ($startcount,$numitems,$titles,$children) = @_;
11871: return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059 raeburn 11872: my $maintitle = $env{'form.comment'};
1.1055 raeburn 11873: my $scripttag = <<START;
11874: <script type="text/javascript">
11875: // <![CDATA[
11876:
11877: function checkAll(form,prefix) {
11878: var idstr = new RegExp("^archive_"+prefix+"_\\\\d+\$");
11879: for (var i=0; i < form.elements.length; i++) {
11880: var id = form.elements[i].id;
11881: if ((id != '') && (id != undefined)) {
11882: if (idstr.test(id)) {
11883: if (form.elements[i].type == 'radio') {
11884: form.elements[i].checked = true;
1.1056 raeburn 11885: var nostart = i-$startcount;
1.1059 raeburn 11886: var offset = nostart%7;
11887: var count = (nostart-offset)/7;
1.1056 raeburn 11888: dependencyCheck(form,count,offset);
1.1055 raeburn 11889: }
11890: }
11891: }
11892: }
11893: }
11894:
11895: function propagateCheck(form,count) {
11896: if (count > 0) {
1.1059 raeburn 11897: var startelement = $startcount + ((count-1) * 7);
11898: for (var j=1; j<6; j++) {
11899: if ((j != 2) && (j != 4)) {
1.1056 raeburn 11900: var item = startelement + j;
11901: if (form.elements[item].type == 'radio') {
11902: if (form.elements[item].checked) {
11903: containerCheck(form,count,j);
11904: break;
11905: }
1.1055 raeburn 11906: }
11907: }
11908: }
11909: }
11910: }
11911:
11912: numitems = $numitems
1.1056 raeburn 11913: var titles = new Array(numitems);
11914: var parents = new Array(numitems);
1.1055 raeburn 11915: for (var i=0; i<numitems; i++) {
1.1056 raeburn 11916: parents[i] = new Array;
1.1055 raeburn 11917: }
1.1059 raeburn 11918: var maintitle = '$maintitle';
1.1055 raeburn 11919:
11920: START
11921:
1.1056 raeburn 11922: foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
11923: my @contents = split(/:/,$children->{$container});
1.1055 raeburn 11924: for (my $i=0; $i<@contents; $i ++) {
11925: $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
11926: }
11927: }
11928:
1.1056 raeburn 11929: foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
11930: $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
11931: }
11932:
1.1055 raeburn 11933: $scripttag .= <<END;
11934:
11935: function containerCheck(form,count,offset) {
11936: if (count > 0) {
1.1056 raeburn 11937: dependencyCheck(form,count,offset);
1.1059 raeburn 11938: var item = (offset+$startcount)+7*(count-1);
1.1055 raeburn 11939: form.elements[item].checked = true;
11940: if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
11941: if (parents[count].length > 0) {
11942: for (var j=0; j<parents[count].length; j++) {
1.1056 raeburn 11943: containerCheck(form,parents[count][j],offset);
11944: }
11945: }
11946: }
11947: }
11948: }
11949:
11950: function dependencyCheck(form,count,offset) {
11951: if (count > 0) {
1.1059 raeburn 11952: var chosen = (offset+$startcount)+7*(count-1);
11953: var depitem = $startcount + ((count-1) * 7) + 4;
1.1056 raeburn 11954: var currtype = form.elements[depitem].type;
11955: if (form.elements[chosen].value == 'dependency') {
11956: document.getElementById('arc_depon_'+count).style.display='block';
11957: form.elements[depitem].options.length = 0;
11958: form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1075.2.11 raeburn 11959: for (var i=1; i<=numitems; i++) {
11960: if (i == count) {
11961: continue;
11962: }
1.1059 raeburn 11963: var startelement = $startcount + (i-1) * 7;
11964: for (var j=1; j<6; j++) {
11965: if ((j != 2) && (j!= 4)) {
1.1056 raeburn 11966: var item = startelement + j;
11967: if (form.elements[item].type == 'radio') {
11968: if (form.elements[item].checked) {
11969: if (form.elements[item].value == 'display') {
11970: var n = form.elements[depitem].options.length;
11971: form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
11972: }
11973: }
11974: }
11975: }
11976: }
11977: }
11978: } else {
11979: document.getElementById('arc_depon_'+count).style.display='none';
11980: form.elements[depitem].options.length = 0;
11981: form.elements[depitem].options[0] = new Option('Select','',true,true);
11982: }
1.1059 raeburn 11983: titleCheck(form,count,offset);
1.1056 raeburn 11984: }
11985: }
11986:
11987: function propagateSelect(form,count,offset) {
11988: if (count > 0) {
1.1065 raeburn 11989: var item = (1+offset+$startcount)+7*(count-1);
1.1056 raeburn 11990: var picked = form.elements[item].options[form.elements[item].selectedIndex].value;
11991: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
11992: if (parents[count].length > 0) {
11993: for (var j=0; j<parents[count].length; j++) {
11994: containerSelect(form,parents[count][j],offset,picked);
1.1055 raeburn 11995: }
11996: }
11997: }
11998: }
11999: }
1.1056 raeburn 12000:
12001: function containerSelect(form,count,offset,picked) {
12002: if (count > 0) {
1.1065 raeburn 12003: var item = (offset+$startcount)+7*(count-1);
1.1056 raeburn 12004: if (form.elements[item].type == 'radio') {
12005: if (form.elements[item].value == 'dependency') {
12006: if (form.elements[item+1].type == 'select-one') {
12007: for (var i=0; i<form.elements[item+1].options.length; i++) {
12008: if (form.elements[item+1].options[i].value == picked) {
12009: form.elements[item+1].selectedIndex = i;
12010: break;
12011: }
12012: }
12013: }
12014: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
12015: if (parents[count].length > 0) {
12016: for (var j=0; j<parents[count].length; j++) {
12017: containerSelect(form,parents[count][j],offset,picked);
12018: }
12019: }
12020: }
12021: }
12022: }
12023: }
12024: }
12025:
1.1059 raeburn 12026: function titleCheck(form,count,offset) {
12027: if (count > 0) {
12028: var chosen = (offset+$startcount)+7*(count-1);
12029: var depitem = $startcount + ((count-1) * 7) + 2;
12030: var currtype = form.elements[depitem].type;
12031: if (form.elements[chosen].value == 'display') {
12032: document.getElementById('arc_title_'+count).style.display='block';
12033: if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
12034: document.getElementById('archive_title_'+count).value=maintitle;
12035: }
12036: } else {
12037: document.getElementById('arc_title_'+count).style.display='none';
12038: if (currtype == 'text') {
12039: document.getElementById('archive_title_'+count).value='';
12040: }
12041: }
12042: }
12043: return;
12044: }
12045:
1.1055 raeburn 12046: // ]]>
12047: </script>
12048: END
12049: return $scripttag;
12050: }
12051:
12052: sub process_extracted_files {
1.1067 raeburn 12053: my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055 raeburn 12054: my $numitems = $env{'form.archive_count'};
12055: return unless ($numitems);
12056: my @ids=&Apache::lonnet::current_machine_ids();
12057: my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067 raeburn 12058: %folders,%containers,%mapinner,%prompttofetch);
1.1055 raeburn 12059: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
12060: if (grep(/^\Q$docuhome\E$/,@ids)) {
12061: $prefix = &LONCAPA::propath($docudom,$docuname);
12062: $pathtocheck = "$dir_root/$destination";
12063: $dir = $dir_root;
12064: $ishome = 1;
12065: } else {
12066: $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
12067: $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
12068: $dir = "$dir_root/$docudom/$docuname";
12069: }
12070: my $currdir = "$dir_root/$destination";
12071: (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
12072: if ($env{'form.folderpath'}) {
12073: my @items = split('&',$env{'form.folderpath'});
12074: $folders{'0'} = $items[-2];
1.1075.2.17 raeburn 12075: if ($env{'form.folderpath'} =~ /\:1$/) {
12076: $containers{'0'}='page';
12077: } else {
12078: $containers{'0'}='sequence';
12079: }
1.1055 raeburn 12080: }
12081: my @archdirs = &get_env_multiple('form.archive_directory');
12082: if ($numitems) {
12083: for (my $i=1; $i<=$numitems; $i++) {
12084: my $path = $env{'form.archive_content_'.$i};
12085: if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
12086: my $item = $1;
12087: $toplevelitems{$item} = $i;
12088: if (grep(/^\Q$i\E$/,@archdirs)) {
12089: $is_dir{$item} = 1;
12090: }
12091: }
12092: }
12093: }
1.1067 raeburn 12094: my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055 raeburn 12095: if (keys(%toplevelitems) > 0) {
12096: my @contents = sort(keys(%toplevelitems));
1.1056 raeburn 12097: (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
12098: \%parent,\@contents,\%dirorder,\%titles);
1.1055 raeburn 12099: }
1.1066 raeburn 12100: my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055 raeburn 12101: if ($numitems) {
12102: for (my $i=1; $i<=$numitems; $i++) {
1.1075.2.11 raeburn 12103: next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055 raeburn 12104: my $path = $env{'form.archive_content_'.$i};
12105: if ($path =~ /^\Q$pathtocheck\E/) {
12106: if ($env{'form.archive_'.$i} eq 'discard') {
12107: if ($prefix ne '' && $path ne '') {
12108: if (-e $prefix.$path) {
1.1066 raeburn 12109: if ((@archdirs > 0) &&
12110: (grep(/^\Q$i\E$/,@archdirs))) {
12111: $todeletedir{$prefix.$path} = 1;
12112: } else {
12113: $todelete{$prefix.$path} = 1;
12114: }
1.1055 raeburn 12115: }
12116: }
12117: } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059 raeburn 12118: my ($docstitle,$title,$url,$outer);
1.1055 raeburn 12119: ($title) = ($path =~ m{/([^/]+)$});
1.1059 raeburn 12120: $docstitle = $env{'form.archive_title_'.$i};
12121: if ($docstitle eq '') {
12122: $docstitle = $title;
12123: }
1.1055 raeburn 12124: $outer = 0;
1.1056 raeburn 12125: if (ref($dirorder{$i}) eq 'ARRAY') {
12126: if (@{$dirorder{$i}} > 0) {
12127: foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055 raeburn 12128: if ($env{'form.archive_'.$item} eq 'display') {
12129: $outer = $item;
12130: last;
12131: }
12132: }
12133: }
12134: }
12135: my ($errtext,$fatal) =
12136: &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
12137: '/'.$folders{$outer}.'.'.
12138: $containers{$outer});
12139: next if ($fatal);
12140: if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
12141: if ($context eq 'coursedocs') {
1.1056 raeburn 12142: $mapinner{$i} = time;
1.1055 raeburn 12143: $folders{$i} = 'default_'.$mapinner{$i};
12144: $containers{$i} = 'sequence';
12145: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
12146: $folders{$i}.'.'.$containers{$i};
12147: my $newidx = &LONCAPA::map::getresidx();
12148: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 12149: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 12150: push(@LONCAPA::map::order,$newidx);
12151: my ($outtext,$errtext) =
12152: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
12153: $docuname.'/'.$folders{$outer}.
1.1075.2.11 raeburn 12154: '.'.$containers{$outer},1,1);
1.1056 raeburn 12155: $newseqid{$i} = $newidx;
1.1067 raeburn 12156: unless ($errtext) {
12157: $result .= '<li>'.&mt('Folder: [_1] added to course',$docstitle).'</li>'."\n";
12158: }
1.1055 raeburn 12159: }
12160: } else {
12161: if ($context eq 'coursedocs') {
12162: my $newidx=&LONCAPA::map::getresidx();
12163: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
12164: $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
12165: $title;
12166: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
12167: mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
12168: }
12169: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
12170: mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
12171: }
12172: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
12173: system("mv $prefix$path $prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title");
1.1056 raeburn 12174: $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
1.1067 raeburn 12175: unless ($ishome) {
12176: my $fetch = "$newdest{$i}/$title";
12177: $fetch =~ s/^\Q$prefix$dir\E//;
12178: $prompttofetch{$fetch} = 1;
12179: }
1.1055 raeburn 12180: }
12181: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 12182: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 12183: push(@LONCAPA::map::order, $newidx);
12184: my ($outtext,$errtext)=
12185: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
12186: $docuname.'/'.$folders{$outer}.
1.1075.2.11 raeburn 12187: '.'.$containers{$outer},1,1);
1.1067 raeburn 12188: unless ($errtext) {
12189: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
12190: $result .= '<li>'.&mt('File: [_1] added to course',$docstitle).'</li>'."\n";
12191: }
12192: }
1.1055 raeburn 12193: }
12194: }
1.1075.2.11 raeburn 12195: }
12196: } else {
12197: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',$path).'<br />';
12198: }
12199: }
12200: for (my $i=1; $i<=$numitems; $i++) {
12201: next unless ($env{'form.archive_'.$i} eq 'dependency');
12202: my $path = $env{'form.archive_content_'.$i};
12203: if ($path =~ /^\Q$pathtocheck\E/) {
12204: my ($title) = ($path =~ m{/([^/]+)$});
12205: $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
12206: if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
12207: if (ref($dirorder{$i}) eq 'ARRAY') {
12208: my ($itemidx,$fullpath,$relpath);
12209: if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
12210: my $container = $dirorder{$referrer{$i}}->[-1];
1.1056 raeburn 12211: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1075.2.11 raeburn 12212: if ($dirorder{$i}->[$j] eq $container) {
12213: $itemidx = $j;
1.1056 raeburn 12214: }
12215: }
1.1075.2.11 raeburn 12216: }
12217: if ($itemidx eq '') {
12218: $itemidx = 0;
12219: }
12220: if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
12221: if ($mapinner{$referrer{$i}}) {
12222: $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
12223: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
12224: if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
12225: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
12226: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
12227: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
12228: if (!-e $fullpath) {
12229: mkdir($fullpath,0755);
1.1056 raeburn 12230: }
12231: }
1.1075.2.11 raeburn 12232: } else {
12233: last;
1.1056 raeburn 12234: }
1.1075.2.11 raeburn 12235: }
12236: }
12237: } elsif ($newdest{$referrer{$i}}) {
12238: $fullpath = $newdest{$referrer{$i}};
12239: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
12240: if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
12241: $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
12242: last;
12243: } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
12244: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
12245: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
12246: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
12247: if (!-e $fullpath) {
12248: mkdir($fullpath,0755);
1.1056 raeburn 12249: }
12250: }
1.1075.2.11 raeburn 12251: } else {
12252: last;
1.1056 raeburn 12253: }
1.1075.2.11 raeburn 12254: }
12255: }
12256: if ($fullpath ne '') {
12257: if (-e "$prefix$path") {
12258: system("mv $prefix$path $fullpath/$title");
12259: }
12260: if (-e "$fullpath/$title") {
12261: my $showpath;
12262: if ($relpath ne '') {
12263: $showpath = "$relpath/$title";
12264: } else {
12265: $showpath = "/$title";
1.1056 raeburn 12266: }
1.1075.2.11 raeburn 12267: $result .= '<li>'.&mt('[_1] included as a dependency',$showpath).'</li>'."\n";
12268: }
12269: unless ($ishome) {
12270: my $fetch = "$fullpath/$title";
12271: $fetch =~ s/^\Q$prefix$dir\E//;
12272: $prompttofetch{$fetch} = 1;
1.1055 raeburn 12273: }
12274: }
12275: }
1.1075.2.11 raeburn 12276: } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
12277: $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
12278: $path,$env{'form.archive_content_'.$referrer{$i}}).'<br />';
1.1055 raeburn 12279: }
12280: } else {
1.1075.2.11 raeburn 12281: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',$path).'<br />';
1.1055 raeburn 12282: }
12283: }
12284: if (keys(%todelete)) {
12285: foreach my $key (keys(%todelete)) {
12286: unlink($key);
1.1066 raeburn 12287: }
12288: }
12289: if (keys(%todeletedir)) {
12290: foreach my $key (keys(%todeletedir)) {
12291: rmdir($key);
12292: }
12293: }
12294: foreach my $dir (sort(keys(%is_dir))) {
12295: if (($pathtocheck ne '') && ($dir ne '')) {
12296: &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055 raeburn 12297: }
12298: }
1.1067 raeburn 12299: if ($result ne '') {
12300: $output .= '<ul>'."\n".
12301: $result."\n".
12302: '</ul>';
12303: }
12304: unless ($ishome) {
12305: my $replicationfail;
12306: foreach my $item (keys(%prompttofetch)) {
12307: my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
12308: unless ($fetchresult eq 'ok') {
12309: $replicationfail .= '<li>'.$item.'</li>'."\n";
12310: }
12311: }
12312: if ($replicationfail) {
12313: $output .= '<p class="LC_error">'.
12314: &mt('Course home server failed to retrieve:').'<ul>'.
12315: $replicationfail.
12316: '</ul></p>';
12317: }
12318: }
1.1055 raeburn 12319: } else {
12320: $warning = &mt('No items found in archive.');
12321: }
12322: if ($error) {
12323: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
12324: $error.'</p>'."\n";
12325: }
12326: if ($warning) {
12327: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
12328: }
12329: return $output;
12330: }
12331:
1.1066 raeburn 12332: sub cleanup_empty_dirs {
12333: my ($path) = @_;
12334: if (($path ne '') && (-d $path)) {
12335: if (opendir(my $dirh,$path)) {
12336: my @dircontents = grep(!/^\./,readdir($dirh));
12337: my $numitems = 0;
12338: foreach my $item (@dircontents) {
12339: if (-d "$path/$item") {
1.1075.2.28 raeburn 12340: &cleanup_empty_dirs("$path/$item");
1.1066 raeburn 12341: if (-e "$path/$item") {
12342: $numitems ++;
12343: }
12344: } else {
12345: $numitems ++;
12346: }
12347: }
12348: if ($numitems == 0) {
12349: rmdir($path);
12350: }
12351: closedir($dirh);
12352: }
12353: }
12354: return;
12355: }
12356:
1.41 ng 12357: =pod
1.45 matthew 12358:
1.1075.2.56 raeburn 12359: =item * &get_folder_hierarchy()
1.1068 raeburn 12360:
12361: Provides hierarchy of names of folders/sub-folders containing the current
12362: item,
12363:
12364: Inputs: 3
12365: - $navmap - navmaps object
12366:
12367: - $map - url for map (either the trigger itself, or map containing
12368: the resource, which is the trigger).
12369:
12370: - $showitem - 1 => show title for map itself; 0 => do not show.
12371:
12372: Outputs: 1 @pathitems - array of folder/subfolder names.
12373:
12374: =cut
12375:
12376: sub get_folder_hierarchy {
12377: my ($navmap,$map,$showitem) = @_;
12378: my @pathitems;
12379: if (ref($navmap)) {
12380: my $mapres = $navmap->getResourceByUrl($map);
12381: if (ref($mapres)) {
12382: my $pcslist = $mapres->map_hierarchy();
12383: if ($pcslist ne '') {
12384: my @pcs = split(/,/,$pcslist);
12385: foreach my $pc (@pcs) {
12386: if ($pc == 1) {
1.1075.2.38 raeburn 12387: push(@pathitems,&mt('Main Content'));
1.1068 raeburn 12388: } else {
12389: my $res = $navmap->getByMapPc($pc);
12390: if (ref($res)) {
12391: my $title = $res->compTitle();
12392: $title =~ s/\W+/_/g;
12393: if ($title ne '') {
12394: push(@pathitems,$title);
12395: }
12396: }
12397: }
12398: }
12399: }
1.1071 raeburn 12400: if ($showitem) {
12401: if ($mapres->{ID} eq '0.0') {
1.1075.2.38 raeburn 12402: push(@pathitems,&mt('Main Content'));
1.1071 raeburn 12403: } else {
12404: my $maptitle = $mapres->compTitle();
12405: $maptitle =~ s/\W+/_/g;
12406: if ($maptitle ne '') {
12407: push(@pathitems,$maptitle);
12408: }
1.1068 raeburn 12409: }
12410: }
12411: }
12412: }
12413: return @pathitems;
12414: }
12415:
12416: =pod
12417:
1.1015 raeburn 12418: =item * &get_turnedin_filepath()
12419:
12420: Determines path in a user's portfolio file for storage of files uploaded
12421: to a specific essayresponse or dropbox item.
12422:
12423: Inputs: 3 required + 1 optional.
12424: $symb is symb for resource, $uname and $udom are for current user (required).
12425: $caller is optional (can be "submission", if routine is called when storing
12426: an upoaded file when "Submit Answer" button was pressed).
12427:
12428: Returns array containing $path and $multiresp.
12429: $path is path in portfolio. $multiresp is 1 if this resource contains more
12430: than one file upload item. Callers of routine should append partid as a
12431: subdirectory to $path in cases where $multiresp is 1.
12432:
12433: Called by: homework/essayresponse.pm and homework/structuretags.pm
12434:
12435: =cut
12436:
12437: sub get_turnedin_filepath {
12438: my ($symb,$uname,$udom,$caller) = @_;
12439: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
12440: my $turnindir;
12441: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
12442: $turnindir = $userhash{'turnindir'};
12443: my ($path,$multiresp);
12444: if ($turnindir eq '') {
12445: if ($caller eq 'submission') {
12446: $turnindir = &mt('turned in');
12447: $turnindir =~ s/\W+/_/g;
12448: my %newhash = (
12449: 'turnindir' => $turnindir,
12450: );
12451: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
12452: }
12453: }
12454: if ($turnindir ne '') {
12455: $path = '/'.$turnindir.'/';
12456: my ($multipart,$turnin,@pathitems);
12457: my $navmap = Apache::lonnavmaps::navmap->new();
12458: if (defined($navmap)) {
12459: my $mapres = $navmap->getResourceByUrl($map);
12460: if (ref($mapres)) {
12461: my $pcslist = $mapres->map_hierarchy();
12462: if ($pcslist ne '') {
12463: foreach my $pc (split(/,/,$pcslist)) {
12464: my $res = $navmap->getByMapPc($pc);
12465: if (ref($res)) {
12466: my $title = $res->compTitle();
12467: $title =~ s/\W+/_/g;
12468: if ($title ne '') {
1.1075.2.48 raeburn 12469: if (($pc > 1) && (length($title) > 12)) {
12470: $title = substr($title,0,12);
12471: }
1.1015 raeburn 12472: push(@pathitems,$title);
12473: }
12474: }
12475: }
12476: }
12477: my $maptitle = $mapres->compTitle();
12478: $maptitle =~ s/\W+/_/g;
12479: if ($maptitle ne '') {
1.1075.2.48 raeburn 12480: if (length($maptitle) > 12) {
12481: $maptitle = substr($maptitle,0,12);
12482: }
1.1015 raeburn 12483: push(@pathitems,$maptitle);
12484: }
12485: unless ($env{'request.state'} eq 'construct') {
12486: my $res = $navmap->getBySymb($symb);
12487: if (ref($res)) {
12488: my $partlist = $res->parts();
12489: my $totaluploads = 0;
12490: if (ref($partlist) eq 'ARRAY') {
12491: foreach my $part (@{$partlist}) {
12492: my @types = $res->responseType($part);
12493: my @ids = $res->responseIds($part);
12494: for (my $i=0; $i < scalar(@ids); $i++) {
12495: if ($types[$i] eq 'essay') {
12496: my $partid = $part.'_'.$ids[$i];
12497: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
12498: $totaluploads ++;
12499: }
12500: }
12501: }
12502: }
12503: if ($totaluploads > 1) {
12504: $multiresp = 1;
12505: }
12506: }
12507: }
12508: }
12509: } else {
12510: return;
12511: }
12512: } else {
12513: return;
12514: }
12515: my $restitle=&Apache::lonnet::gettitle($symb);
12516: $restitle =~ s/\W+/_/g;
12517: if ($restitle eq '') {
12518: $restitle = ($resurl =~ m{/[^/]+$});
12519: if ($restitle eq '') {
12520: $restitle = time;
12521: }
12522: }
1.1075.2.48 raeburn 12523: if (length($restitle) > 12) {
12524: $restitle = substr($restitle,0,12);
12525: }
1.1015 raeburn 12526: push(@pathitems,$restitle);
12527: $path .= join('/',@pathitems);
12528: }
12529: return ($path,$multiresp);
12530: }
12531:
12532: =pod
12533:
1.464 albertel 12534: =back
1.41 ng 12535:
1.112 bowersj2 12536: =head1 CSV Upload/Handling functions
1.38 albertel 12537:
1.41 ng 12538: =over 4
12539:
1.648 raeburn 12540: =item * &upfile_store($r)
1.41 ng 12541:
12542: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 12543: needs $env{'form.upfile'}
1.41 ng 12544: returns $datatoken to be put into hidden field
12545:
12546: =cut
1.31 albertel 12547:
12548: sub upfile_store {
12549: my $r=shift;
1.258 albertel 12550: $env{'form.upfile'}=~s/\r/\n/gs;
12551: $env{'form.upfile'}=~s/\f/\n/gs;
12552: $env{'form.upfile'}=~s/\n+/\n/gs;
12553: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 12554:
1.258 albertel 12555: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
12556: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 12557: {
1.158 raeburn 12558: my $datafile = $r->dir_config('lonDaemons').
12559: '/tmp/'.$datatoken.'.tmp';
12560: if ( open(my $fh,">$datafile") ) {
1.258 albertel 12561: print $fh $env{'form.upfile'};
1.158 raeburn 12562: close($fh);
12563: }
1.31 albertel 12564: }
12565: return $datatoken;
12566: }
12567:
1.56 matthew 12568: =pod
12569:
1.648 raeburn 12570: =item * &load_tmp_file($r)
1.41 ng 12571:
12572: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 12573: needs $env{'form.datatoken'},
12574: sets $env{'form.upfile'} to the contents of the file
1.41 ng 12575:
12576: =cut
1.31 albertel 12577:
12578: sub load_tmp_file {
12579: my $r=shift;
12580: my @studentdata=();
12581: {
1.158 raeburn 12582: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 12583: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 12584: if ( open(my $fh,"<$studentfile") ) {
12585: @studentdata=<$fh>;
12586: close($fh);
12587: }
1.31 albertel 12588: }
1.258 albertel 12589: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 12590: }
12591:
1.56 matthew 12592: =pod
12593:
1.648 raeburn 12594: =item * &upfile_record_sep()
1.41 ng 12595:
12596: Separate uploaded file into records
12597: returns array of records,
1.258 albertel 12598: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 12599:
12600: =cut
1.31 albertel 12601:
12602: sub upfile_record_sep {
1.258 albertel 12603: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 12604: } else {
1.248 albertel 12605: my @records;
1.258 albertel 12606: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 12607: if ($line=~/^\s*$/) { next; }
12608: push(@records,$line);
12609: }
12610: return @records;
1.31 albertel 12611: }
12612: }
12613:
1.56 matthew 12614: =pod
12615:
1.648 raeburn 12616: =item * &record_sep($record)
1.41 ng 12617:
1.258 albertel 12618: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 12619:
12620: =cut
12621:
1.263 www 12622: sub takeleft {
12623: my $index=shift;
12624: return substr('0000'.$index,-4,4);
12625: }
12626:
1.31 albertel 12627: sub record_sep {
12628: my $record=shift;
12629: my %components=();
1.258 albertel 12630: if ($env{'form.upfiletype'} eq 'xml') {
12631: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 12632: my $i=0;
1.356 albertel 12633: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 12634: $field=~s/^(\"|\')//;
12635: $field=~s/(\"|\')$//;
1.263 www 12636: $components{&takeleft($i)}=$field;
1.31 albertel 12637: $i++;
12638: }
1.258 albertel 12639: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 12640: my $i=0;
1.356 albertel 12641: foreach my $field (split(/\t/,$record)) {
1.31 albertel 12642: $field=~s/^(\"|\')//;
12643: $field=~s/(\"|\')$//;
1.263 www 12644: $components{&takeleft($i)}=$field;
1.31 albertel 12645: $i++;
12646: }
12647: } else {
1.561 www 12648: my $separator=',';
1.480 banghart 12649: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 12650: $separator=';';
1.480 banghart 12651: }
1.31 albertel 12652: my $i=0;
1.561 www 12653: # the character we are looking for to indicate the end of a quote or a record
12654: my $looking_for=$separator;
12655: # do not add the characters to the fields
12656: my $ignore=0;
12657: # we just encountered a separator (or the beginning of the record)
12658: my $just_found_separator=1;
12659: # store the field we are working on here
12660: my $field='';
12661: # work our way through all characters in record
12662: foreach my $character ($record=~/(.)/g) {
12663: if ($character eq $looking_for) {
12664: if ($character ne $separator) {
12665: # Found the end of a quote, again looking for separator
12666: $looking_for=$separator;
12667: $ignore=1;
12668: } else {
12669: # Found a separator, store away what we got
12670: $components{&takeleft($i)}=$field;
12671: $i++;
12672: $just_found_separator=1;
12673: $ignore=0;
12674: $field='';
12675: }
12676: next;
12677: }
12678: # single or double quotation marks after a separator indicate beginning of a quote
12679: # we are now looking for the end of the quote and need to ignore separators
12680: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
12681: $looking_for=$character;
12682: next;
12683: }
12684: # ignore would be true after we reached the end of a quote
12685: if ($ignore) { next; }
12686: if (($just_found_separator) && ($character=~/\s/)) { next; }
12687: $field.=$character;
12688: $just_found_separator=0;
1.31 albertel 12689: }
1.561 www 12690: # catch the very last entry, since we never encountered the separator
12691: $components{&takeleft($i)}=$field;
1.31 albertel 12692: }
12693: return %components;
12694: }
12695:
1.144 matthew 12696: ######################################################
12697: ######################################################
12698:
1.56 matthew 12699: =pod
12700:
1.648 raeburn 12701: =item * &upfile_select_html()
1.41 ng 12702:
1.144 matthew 12703: Return HTML code to select a file from the users machine and specify
12704: the file type.
1.41 ng 12705:
12706: =cut
12707:
1.144 matthew 12708: ######################################################
12709: ######################################################
1.31 albertel 12710: sub upfile_select_html {
1.144 matthew 12711: my %Types = (
12712: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 12713: semisv => &mt('Semicolon separated values'),
1.144 matthew 12714: space => &mt('Space separated'),
12715: tab => &mt('Tabulator separated'),
12716: # xml => &mt('HTML/XML'),
12717: );
12718: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 12719: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 12720: foreach my $type (sort(keys(%Types))) {
12721: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
12722: }
12723: $Str .= "</select>\n";
12724: return $Str;
1.31 albertel 12725: }
12726:
1.301 albertel 12727: sub get_samples {
12728: my ($records,$toget) = @_;
12729: my @samples=({});
12730: my $got=0;
12731: foreach my $rec (@$records) {
12732: my %temp = &record_sep($rec);
12733: if (! grep(/\S/, values(%temp))) { next; }
12734: if (%temp) {
12735: $samples[$got]=\%temp;
12736: $got++;
12737: if ($got == $toget) { last; }
12738: }
12739: }
12740: return \@samples;
12741: }
12742:
1.144 matthew 12743: ######################################################
12744: ######################################################
12745:
1.56 matthew 12746: =pod
12747:
1.648 raeburn 12748: =item * &csv_print_samples($r,$records)
1.41 ng 12749:
12750: Prints a table of sample values from each column uploaded $r is an
12751: Apache Request ref, $records is an arrayref from
12752: &Apache::loncommon::upfile_record_sep
12753:
12754: =cut
12755:
1.144 matthew 12756: ######################################################
12757: ######################################################
1.31 albertel 12758: sub csv_print_samples {
12759: my ($r,$records) = @_;
1.662 bisitz 12760: my $samples = &get_samples($records,5);
1.301 albertel 12761:
1.594 raeburn 12762: $r->print(&mt('Samples').'<br />'.&start_data_table().
12763: &start_data_table_header_row());
1.356 albertel 12764: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 12765: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 12766: $r->print(&end_data_table_header_row());
1.301 albertel 12767: foreach my $hash (@$samples) {
1.594 raeburn 12768: $r->print(&start_data_table_row());
1.356 albertel 12769: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 12770: $r->print('<td>');
1.356 albertel 12771: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 12772: $r->print('</td>');
12773: }
1.594 raeburn 12774: $r->print(&end_data_table_row());
1.31 albertel 12775: }
1.594 raeburn 12776: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 12777: }
12778:
1.144 matthew 12779: ######################################################
12780: ######################################################
12781:
1.56 matthew 12782: =pod
12783:
1.648 raeburn 12784: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 12785:
12786: Prints a table to create associations between values and table columns.
1.144 matthew 12787:
1.41 ng 12788: $r is an Apache Request ref,
12789: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 12790: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 12791:
12792: =cut
12793:
1.144 matthew 12794: ######################################################
12795: ######################################################
1.31 albertel 12796: sub csv_print_select_table {
12797: my ($r,$records,$d) = @_;
1.301 albertel 12798: my $i=0;
12799: my $samples = &get_samples($records,1);
1.144 matthew 12800: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 12801: &start_data_table().&start_data_table_header_row().
1.144 matthew 12802: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 12803: '<th>'.&mt('Column').'</th>'.
12804: &end_data_table_header_row()."\n");
1.356 albertel 12805: foreach my $array_ref (@$d) {
12806: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 12807: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 12808:
1.875 bisitz 12809: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 12810: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 12811: $r->print('<option value="none"></option>');
1.356 albertel 12812: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
12813: $r->print('<option value="'.$sample.'"'.
12814: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 12815: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 12816: }
1.594 raeburn 12817: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 12818: $i++;
12819: }
1.594 raeburn 12820: $r->print(&end_data_table());
1.31 albertel 12821: $i--;
12822: return $i;
12823: }
1.56 matthew 12824:
1.144 matthew 12825: ######################################################
12826: ######################################################
12827:
1.56 matthew 12828: =pod
1.31 albertel 12829:
1.648 raeburn 12830: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 12831:
12832: Prints a table of sample values from the upload and can make associate samples to internal names.
12833:
12834: $r is an Apache Request ref,
12835: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
12836: $d is an array of 2 element arrays (internal name, displayed name)
12837:
12838: =cut
12839:
1.144 matthew 12840: ######################################################
12841: ######################################################
1.31 albertel 12842: sub csv_samples_select_table {
12843: my ($r,$records,$d) = @_;
12844: my $i=0;
1.144 matthew 12845: #
1.662 bisitz 12846: my $max_samples = 5;
12847: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 12848: $r->print(&start_data_table().
12849: &start_data_table_header_row().'<th>'.
12850: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
12851: &end_data_table_header_row());
1.301 albertel 12852:
12853: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 12854: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 12855: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 12856: foreach my $option (@$d) {
12857: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 12858: $r->print('<option value="'.$value.'"'.
1.253 albertel 12859: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 12860: $display.'</option>');
1.31 albertel 12861: }
12862: $r->print('</select></td><td>');
1.662 bisitz 12863: foreach my $line (0..($max_samples-1)) {
1.301 albertel 12864: if (defined($samples->[$line]{$key})) {
12865: $r->print($samples->[$line]{$key}."<br />\n");
12866: }
12867: }
1.594 raeburn 12868: $r->print('</td>'.&end_data_table_row());
1.31 albertel 12869: $i++;
12870: }
1.594 raeburn 12871: $r->print(&end_data_table());
1.31 albertel 12872: $i--;
12873: return($i);
1.115 matthew 12874: }
12875:
1.144 matthew 12876: ######################################################
12877: ######################################################
12878:
1.115 matthew 12879: =pod
12880:
1.648 raeburn 12881: =item * &clean_excel_name($name)
1.115 matthew 12882:
12883: Returns a replacement for $name which does not contain any illegal characters.
12884:
12885: =cut
12886:
1.144 matthew 12887: ######################################################
12888: ######################################################
1.115 matthew 12889: sub clean_excel_name {
12890: my ($name) = @_;
12891: $name =~ s/[:\*\?\/\\]//g;
12892: if (length($name) > 31) {
12893: $name = substr($name,0,31);
12894: }
12895: return $name;
1.25 albertel 12896: }
1.84 albertel 12897:
1.85 albertel 12898: =pod
12899:
1.648 raeburn 12900: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 12901:
12902: Returns either 1 or undef
12903:
12904: 1 if the part is to be hidden, undef if it is to be shown
12905:
12906: Arguments are:
12907:
12908: $id the id of the part to be checked
12909: $symb, optional the symb of the resource to check
12910: $udom, optional the domain of the user to check for
12911: $uname, optional the username of the user to check for
12912:
12913: =cut
1.84 albertel 12914:
12915: sub check_if_partid_hidden {
12916: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 12917: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 12918: $symb,$udom,$uname);
1.141 albertel 12919: my $truth=1;
12920: #if the string starts with !, then the list is the list to show not hide
12921: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 12922: my @hiddenlist=split(/,/,$hiddenparts);
12923: foreach my $checkid (@hiddenlist) {
1.141 albertel 12924: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 12925: }
1.141 albertel 12926: return !$truth;
1.84 albertel 12927: }
1.127 matthew 12928:
1.138 matthew 12929:
12930: ############################################################
12931: ############################################################
12932:
12933: =pod
12934:
1.157 matthew 12935: =back
12936:
1.138 matthew 12937: =head1 cgi-bin script and graphing routines
12938:
1.157 matthew 12939: =over 4
12940:
1.648 raeburn 12941: =item * &get_cgi_id()
1.138 matthew 12942:
12943: Inputs: none
12944:
12945: Returns an id which can be used to pass environment variables
12946: to various cgi-bin scripts. These environment variables will
12947: be removed from the users environment after a given time by
12948: the routine &Apache::lonnet::transfer_profile_to_env.
12949:
12950: =cut
12951:
12952: ############################################################
12953: ############################################################
1.152 albertel 12954: my $uniq=0;
1.136 matthew 12955: sub get_cgi_id {
1.154 albertel 12956: $uniq=($uniq+1)%100000;
1.280 albertel 12957: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 12958: }
12959:
1.127 matthew 12960: ############################################################
12961: ############################################################
12962:
12963: =pod
12964:
1.648 raeburn 12965: =item * &DrawBarGraph()
1.127 matthew 12966:
1.138 matthew 12967: Facilitates the plotting of data in a (stacked) bar graph.
12968: Puts plot definition data into the users environment in order for
12969: graph.png to plot it. Returns an <img> tag for the plot.
12970: The bars on the plot are labeled '1','2',...,'n'.
12971:
12972: Inputs:
12973:
12974: =over 4
12975:
12976: =item $Title: string, the title of the plot
12977:
12978: =item $xlabel: string, text describing the X-axis of the plot
12979:
12980: =item $ylabel: string, text describing the Y-axis of the plot
12981:
12982: =item $Max: scalar, the maximum Y value to use in the plot
12983: If $Max is < any data point, the graph will not be rendered.
12984:
1.140 matthew 12985: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 12986: they are plotted. If undefined, default values will be used.
12987:
1.178 matthew 12988: =item $labels: array ref holding the labels to use on the x-axis for the bars.
12989:
1.138 matthew 12990: =item @Values: An array of array references. Each array reference holds data
12991: to be plotted in a stacked bar chart.
12992:
1.239 matthew 12993: =item If the final element of @Values is a hash reference the key/value
12994: pairs will be added to the graph definition.
12995:
1.138 matthew 12996: =back
12997:
12998: Returns:
12999:
13000: An <img> tag which references graph.png and the appropriate identifying
13001: information for the plot.
13002:
1.127 matthew 13003: =cut
13004:
13005: ############################################################
13006: ############################################################
1.134 matthew 13007: sub DrawBarGraph {
1.178 matthew 13008: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 13009: #
13010: if (! defined($colors)) {
13011: $colors = ['#33ff00',
13012: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
13013: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
13014: ];
13015: }
1.228 matthew 13016: my $extra_settings = {};
13017: if (ref($Values[-1]) eq 'HASH') {
13018: $extra_settings = pop(@Values);
13019: }
1.127 matthew 13020: #
1.136 matthew 13021: my $identifier = &get_cgi_id();
13022: my $id = 'cgi.'.$identifier;
1.129 matthew 13023: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 13024: return '';
13025: }
1.225 matthew 13026: #
13027: my @Labels;
13028: if (defined($labels)) {
13029: @Labels = @$labels;
13030: } else {
13031: for (my $i=0;$i<@{$Values[0]};$i++) {
13032: push (@Labels,$i+1);
13033: }
13034: }
13035: #
1.129 matthew 13036: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 13037: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 13038: my %ValuesHash;
13039: my $NumSets=1;
13040: foreach my $array (@Values) {
13041: next if (! ref($array));
1.136 matthew 13042: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 13043: join(',',@$array);
1.129 matthew 13044: }
1.127 matthew 13045: #
1.136 matthew 13046: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 13047: if ($NumBars < 3) {
13048: $width = 120+$NumBars*32;
1.220 matthew 13049: $xskip = 1;
1.225 matthew 13050: $bar_width = 30;
13051: } elsif ($NumBars < 5) {
13052: $width = 120+$NumBars*20;
13053: $xskip = 1;
13054: $bar_width = 20;
1.220 matthew 13055: } elsif ($NumBars < 10) {
1.136 matthew 13056: $width = 120+$NumBars*15;
13057: $xskip = 1;
13058: $bar_width = 15;
13059: } elsif ($NumBars <= 25) {
13060: $width = 120+$NumBars*11;
13061: $xskip = 5;
13062: $bar_width = 8;
13063: } elsif ($NumBars <= 50) {
13064: $width = 120+$NumBars*8;
13065: $xskip = 5;
13066: $bar_width = 4;
13067: } else {
13068: $width = 120+$NumBars*8;
13069: $xskip = 5;
13070: $bar_width = 4;
13071: }
13072: #
1.137 matthew 13073: $Max = 1 if ($Max < 1);
13074: if ( int($Max) < $Max ) {
13075: $Max++;
13076: $Max = int($Max);
13077: }
1.127 matthew 13078: $Title = '' if (! defined($Title));
13079: $xlabel = '' if (! defined($xlabel));
13080: $ylabel = '' if (! defined($ylabel));
1.369 www 13081: $ValuesHash{$id.'.title'} = &escape($Title);
13082: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
13083: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 13084: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 13085: $ValuesHash{$id.'.NumBars'} = $NumBars;
13086: $ValuesHash{$id.'.NumSets'} = $NumSets;
13087: $ValuesHash{$id.'.PlotType'} = 'bar';
13088: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
13089: $ValuesHash{$id.'.height'} = $height;
13090: $ValuesHash{$id.'.width'} = $width;
13091: $ValuesHash{$id.'.xskip'} = $xskip;
13092: $ValuesHash{$id.'.bar_width'} = $bar_width;
13093: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 13094: #
1.228 matthew 13095: # Deal with other parameters
13096: while (my ($key,$value) = each(%$extra_settings)) {
13097: $ValuesHash{$id.'.'.$key} = $value;
13098: }
13099: #
1.646 raeburn 13100: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 13101: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
13102: }
13103:
13104: ############################################################
13105: ############################################################
13106:
13107: =pod
13108:
1.648 raeburn 13109: =item * &DrawXYGraph()
1.137 matthew 13110:
1.138 matthew 13111: Facilitates the plotting of data in an XY graph.
13112: Puts plot definition data into the users environment in order for
13113: graph.png to plot it. Returns an <img> tag for the plot.
13114:
13115: Inputs:
13116:
13117: =over 4
13118:
13119: =item $Title: string, the title of the plot
13120:
13121: =item $xlabel: string, text describing the X-axis of the plot
13122:
13123: =item $ylabel: string, text describing the Y-axis of the plot
13124:
13125: =item $Max: scalar, the maximum Y value to use in the plot
13126: If $Max is < any data point, the graph will not be rendered.
13127:
13128: =item $colors: Array ref containing the hex color codes for the data to be
13129: plotted in. If undefined, default values will be used.
13130:
13131: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
13132:
13133: =item $Ydata: Array ref containing Array refs.
1.185 www 13134: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 13135:
13136: =item %Values: hash indicating or overriding any default values which are
13137: passed to graph.png.
13138: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
13139:
13140: =back
13141:
13142: Returns:
13143:
13144: An <img> tag which references graph.png and the appropriate identifying
13145: information for the plot.
13146:
1.137 matthew 13147: =cut
13148:
13149: ############################################################
13150: ############################################################
13151: sub DrawXYGraph {
13152: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
13153: #
13154: # Create the identifier for the graph
13155: my $identifier = &get_cgi_id();
13156: my $id = 'cgi.'.$identifier;
13157: #
13158: $Title = '' if (! defined($Title));
13159: $xlabel = '' if (! defined($xlabel));
13160: $ylabel = '' if (! defined($ylabel));
13161: my %ValuesHash =
13162: (
1.369 www 13163: $id.'.title' => &escape($Title),
13164: $id.'.xlabel' => &escape($xlabel),
13165: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 13166: $id.'.y_max_value'=> $Max,
13167: $id.'.labels' => join(',',@$Xlabels),
13168: $id.'.PlotType' => 'XY',
13169: );
13170: #
13171: if (defined($colors) && ref($colors) eq 'ARRAY') {
13172: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
13173: }
13174: #
13175: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
13176: return '';
13177: }
13178: my $NumSets=1;
1.138 matthew 13179: foreach my $array (@{$Ydata}){
1.137 matthew 13180: next if (! ref($array));
13181: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
13182: }
1.138 matthew 13183: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 13184: #
13185: # Deal with other parameters
13186: while (my ($key,$value) = each(%Values)) {
13187: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 13188: }
13189: #
1.646 raeburn 13190: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 13191: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
13192: }
13193:
13194: ############################################################
13195: ############################################################
13196:
13197: =pod
13198:
1.648 raeburn 13199: =item * &DrawXYYGraph()
1.138 matthew 13200:
13201: Facilitates the plotting of data in an XY graph with two Y axes.
13202: Puts plot definition data into the users environment in order for
13203: graph.png to plot it. Returns an <img> tag for the plot.
13204:
13205: Inputs:
13206:
13207: =over 4
13208:
13209: =item $Title: string, the title of the plot
13210:
13211: =item $xlabel: string, text describing the X-axis of the plot
13212:
13213: =item $ylabel: string, text describing the Y-axis of the plot
13214:
13215: =item $colors: Array ref containing the hex color codes for the data to be
13216: plotted in. If undefined, default values will be used.
13217:
13218: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
13219:
13220: =item $Ydata1: The first data set
13221:
13222: =item $Min1: The minimum value of the left Y-axis
13223:
13224: =item $Max1: The maximum value of the left Y-axis
13225:
13226: =item $Ydata2: The second data set
13227:
13228: =item $Min2: The minimum value of the right Y-axis
13229:
13230: =item $Max2: The maximum value of the left Y-axis
13231:
13232: =item %Values: hash indicating or overriding any default values which are
13233: passed to graph.png.
13234: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
13235:
13236: =back
13237:
13238: Returns:
13239:
13240: An <img> tag which references graph.png and the appropriate identifying
13241: information for the plot.
1.136 matthew 13242:
13243: =cut
13244:
13245: ############################################################
13246: ############################################################
1.137 matthew 13247: sub DrawXYYGraph {
13248: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
13249: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 13250: #
13251: # Create the identifier for the graph
13252: my $identifier = &get_cgi_id();
13253: my $id = 'cgi.'.$identifier;
13254: #
13255: $Title = '' if (! defined($Title));
13256: $xlabel = '' if (! defined($xlabel));
13257: $ylabel = '' if (! defined($ylabel));
13258: my %ValuesHash =
13259: (
1.369 www 13260: $id.'.title' => &escape($Title),
13261: $id.'.xlabel' => &escape($xlabel),
13262: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 13263: $id.'.labels' => join(',',@$Xlabels),
13264: $id.'.PlotType' => 'XY',
13265: $id.'.NumSets' => 2,
1.137 matthew 13266: $id.'.two_axes' => 1,
13267: $id.'.y1_max_value' => $Max1,
13268: $id.'.y1_min_value' => $Min1,
13269: $id.'.y2_max_value' => $Max2,
13270: $id.'.y2_min_value' => $Min2,
1.136 matthew 13271: );
13272: #
1.137 matthew 13273: if (defined($colors) && ref($colors) eq 'ARRAY') {
13274: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
13275: }
13276: #
13277: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
13278: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 13279: return '';
13280: }
13281: my $NumSets=1;
1.137 matthew 13282: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 13283: next if (! ref($array));
13284: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 13285: }
13286: #
13287: # Deal with other parameters
13288: while (my ($key,$value) = each(%Values)) {
13289: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 13290: }
13291: #
1.646 raeburn 13292: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 13293: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 13294: }
13295:
13296: ############################################################
13297: ############################################################
13298:
13299: =pod
13300:
1.157 matthew 13301: =back
13302:
1.139 matthew 13303: =head1 Statistics helper routines?
13304:
13305: Bad place for them but what the hell.
13306:
1.157 matthew 13307: =over 4
13308:
1.648 raeburn 13309: =item * &chartlink()
1.139 matthew 13310:
13311: Returns a link to the chart for a specific student.
13312:
13313: Inputs:
13314:
13315: =over 4
13316:
13317: =item $linktext: The text of the link
13318:
13319: =item $sname: The students username
13320:
13321: =item $sdomain: The students domain
13322:
13323: =back
13324:
1.157 matthew 13325: =back
13326:
1.139 matthew 13327: =cut
13328:
13329: ############################################################
13330: ############################################################
13331: sub chartlink {
13332: my ($linktext, $sname, $sdomain) = @_;
13333: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 13334: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 13335: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 13336: '">'.$linktext.'</a>';
1.153 matthew 13337: }
13338:
13339: #######################################################
13340: #######################################################
13341:
13342: =pod
13343:
13344: =head1 Course Environment Routines
1.157 matthew 13345:
13346: =over 4
1.153 matthew 13347:
1.648 raeburn 13348: =item * &restore_course_settings()
1.153 matthew 13349:
1.648 raeburn 13350: =item * &store_course_settings()
1.153 matthew 13351:
13352: Restores/Store indicated form parameters from the course environment.
13353: Will not overwrite existing values of the form parameters.
13354:
13355: Inputs:
13356: a scalar describing the data (e.g. 'chart', 'problem_analysis')
13357:
13358: a hash ref describing the data to be stored. For example:
13359:
13360: %Save_Parameters = ('Status' => 'scalar',
13361: 'chartoutputmode' => 'scalar',
13362: 'chartoutputdata' => 'scalar',
13363: 'Section' => 'array',
1.373 raeburn 13364: 'Group' => 'array',
1.153 matthew 13365: 'StudentData' => 'array',
13366: 'Maps' => 'array');
13367:
13368: Returns: both routines return nothing
13369:
1.631 raeburn 13370: =back
13371:
1.153 matthew 13372: =cut
13373:
13374: #######################################################
13375: #######################################################
13376: sub store_course_settings {
1.496 albertel 13377: return &store_settings($env{'request.course.id'},@_);
13378: }
13379:
13380: sub store_settings {
1.153 matthew 13381: # save to the environment
13382: # appenv the same items, just to be safe
1.300 albertel 13383: my $udom = $env{'user.domain'};
13384: my $uname = $env{'user.name'};
1.496 albertel 13385: my ($context,$prefix,$Settings) = @_;
1.153 matthew 13386: my %SaveHash;
13387: my %AppHash;
13388: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 13389: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 13390: my $envname = 'environment.'.$basename;
1.258 albertel 13391: if (exists($env{'form.'.$setting})) {
1.153 matthew 13392: # Save this value away
13393: if ($type eq 'scalar' &&
1.258 albertel 13394: (! exists($env{$envname}) ||
13395: $env{$envname} ne $env{'form.'.$setting})) {
13396: $SaveHash{$basename} = $env{'form.'.$setting};
13397: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 13398: } elsif ($type eq 'array') {
13399: my $stored_form;
1.258 albertel 13400: if (ref($env{'form.'.$setting})) {
1.153 matthew 13401: $stored_form = join(',',
13402: map {
1.369 www 13403: &escape($_);
1.258 albertel 13404: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 13405: } else {
13406: $stored_form =
1.369 www 13407: &escape($env{'form.'.$setting});
1.153 matthew 13408: }
13409: # Determine if the array contents are the same.
1.258 albertel 13410: if ($stored_form ne $env{$envname}) {
1.153 matthew 13411: $SaveHash{$basename} = $stored_form;
13412: $AppHash{$envname} = $stored_form;
13413: }
13414: }
13415: }
13416: }
13417: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 13418: $udom,$uname);
1.153 matthew 13419: if ($put_result !~ /^(ok|delayed)/) {
13420: &Apache::lonnet::logthis('unable to save form parameters, '.
13421: 'got error:'.$put_result);
13422: }
13423: # Make sure these settings stick around in this session, too
1.646 raeburn 13424: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 13425: return;
13426: }
13427:
13428: sub restore_course_settings {
1.499 albertel 13429: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 13430: }
13431:
13432: sub restore_settings {
13433: my ($context,$prefix,$Settings) = @_;
1.153 matthew 13434: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 13435: next if (exists($env{'form.'.$setting}));
1.496 albertel 13436: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 13437: '.'.$setting;
1.258 albertel 13438: if (exists($env{$envname})) {
1.153 matthew 13439: if ($type eq 'scalar') {
1.258 albertel 13440: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 13441: } elsif ($type eq 'array') {
1.258 albertel 13442: $env{'form.'.$setting} = [
1.153 matthew 13443: map {
1.369 www 13444: &unescape($_);
1.258 albertel 13445: } split(',',$env{$envname})
1.153 matthew 13446: ];
13447: }
13448: }
13449: }
1.127 matthew 13450: }
13451:
1.618 raeburn 13452: #######################################################
13453: #######################################################
13454:
13455: =pod
13456:
13457: =head1 Domain E-mail Routines
13458:
13459: =over 4
13460:
1.648 raeburn 13461: =item * &build_recipient_list()
1.618 raeburn 13462:
1.1075.2.44 raeburn 13463: Build recipient lists for following types of e-mail:
1.766 raeburn 13464: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1075.2.44 raeburn 13465: (d) Help requests, (e) Course requests needing approval, (f) loncapa
13466: module change checking, student/employee ID conflict checks, as
13467: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
13468: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618 raeburn 13469:
13470: Inputs:
1.1075.2.44 raeburn 13471: defmail (scalar - email address of default recipient),
13472: mailing type (scalar: errormail, packagesmail, helpdeskmail,
13473: requestsmail, updatesmail, or idconflictsmail).
13474:
1.619 raeburn 13475: defdom (domain for which to retrieve configuration settings),
1.1075.2.44 raeburn 13476:
13477: origmail (scalar - email address of recipient from loncapa.conf,
13478: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 13479:
1.655 raeburn 13480: Returns: comma separated list of addresses to which to send e-mail.
13481:
13482: =back
1.618 raeburn 13483:
13484: =cut
13485:
13486: ############################################################
13487: ############################################################
13488: sub build_recipient_list {
1.619 raeburn 13489: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 13490: my @recipients;
13491: my $otheremails;
13492: my %domconfig =
13493: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
13494: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 13495: if (exists($domconfig{'contacts'}{$mailing})) {
13496: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
13497: my @contacts = ('adminemail','supportemail');
13498: foreach my $item (@contacts) {
13499: if ($domconfig{'contacts'}{$mailing}{$item}) {
13500: my $addr = $domconfig{'contacts'}{$item};
13501: if (!grep(/^\Q$addr\E$/,@recipients)) {
13502: push(@recipients,$addr);
13503: }
1.619 raeburn 13504: }
1.766 raeburn 13505: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 13506: }
13507: }
1.766 raeburn 13508: } elsif ($origmail ne '') {
13509: push(@recipients,$origmail);
1.618 raeburn 13510: }
1.619 raeburn 13511: } elsif ($origmail ne '') {
13512: push(@recipients,$origmail);
1.618 raeburn 13513: }
1.688 raeburn 13514: if (defined($defmail)) {
13515: if ($defmail ne '') {
13516: push(@recipients,$defmail);
13517: }
1.618 raeburn 13518: }
13519: if ($otheremails) {
1.619 raeburn 13520: my @others;
13521: if ($otheremails =~ /,/) {
13522: @others = split(/,/,$otheremails);
1.618 raeburn 13523: } else {
1.619 raeburn 13524: push(@others,$otheremails);
13525: }
13526: foreach my $addr (@others) {
13527: if (!grep(/^\Q$addr\E$/,@recipients)) {
13528: push(@recipients,$addr);
13529: }
1.618 raeburn 13530: }
13531: }
1.619 raeburn 13532: my $recipientlist = join(',',@recipients);
1.618 raeburn 13533: return $recipientlist;
13534: }
13535:
1.127 matthew 13536: ############################################################
13537: ############################################################
1.154 albertel 13538:
1.655 raeburn 13539: =pod
13540:
13541: =head1 Course Catalog Routines
13542:
13543: =over 4
13544:
13545: =item * &gather_categories()
13546:
13547: Converts category definitions - keys of categories hash stored in
13548: coursecategories in configuration.db on the primary library server in a
13549: domain - to an array. Also generates javascript and idx hash used to
13550: generate Domain Coordinator interface for editing Course Categories.
13551:
13552: Inputs:
1.663 raeburn 13553:
1.655 raeburn 13554: categories (reference to hash of category definitions).
1.663 raeburn 13555:
1.655 raeburn 13556: cats (reference to array of arrays/hashes which encapsulates hierarchy of
13557: categories and subcategories).
1.663 raeburn 13558:
1.655 raeburn 13559: idx (reference to hash of counters used in Domain Coordinator interface for
13560: editing Course Categories).
1.663 raeburn 13561:
1.655 raeburn 13562: jsarray (reference to array of categories used to create Javascript arrays for
13563: Domain Coordinator interface for editing Course Categories).
13564:
13565: Returns: nothing
13566:
13567: Side effects: populates cats, idx and jsarray.
13568:
13569: =cut
13570:
13571: sub gather_categories {
13572: my ($categories,$cats,$idx,$jsarray) = @_;
13573: my %counters;
13574: my $num = 0;
13575: foreach my $item (keys(%{$categories})) {
13576: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
13577: if ($container eq '' && $depth == 0) {
13578: $cats->[$depth][$categories->{$item}] = $cat;
13579: } else {
13580: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
13581: }
13582: my ($escitem,$tail) = split(/:/,$item,2);
13583: if ($counters{$tail} eq '') {
13584: $counters{$tail} = $num;
13585: $num ++;
13586: }
13587: if (ref($idx) eq 'HASH') {
13588: $idx->{$item} = $counters{$tail};
13589: }
13590: if (ref($jsarray) eq 'ARRAY') {
13591: push(@{$jsarray->[$counters{$tail}]},$item);
13592: }
13593: }
13594: return;
13595: }
13596:
13597: =pod
13598:
13599: =item * &extract_categories()
13600:
13601: Used to generate breadcrumb trails for course categories.
13602:
13603: Inputs:
1.663 raeburn 13604:
1.655 raeburn 13605: categories (reference to hash of category definitions).
1.663 raeburn 13606:
1.655 raeburn 13607: cats (reference to array of arrays/hashes which encapsulates hierarchy of
13608: categories and subcategories).
1.663 raeburn 13609:
1.655 raeburn 13610: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 13611:
1.655 raeburn 13612: allitems (reference to hash - key is category key
13613: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 13614:
1.655 raeburn 13615: idx (reference to hash of counters used in Domain Coordinator interface for
13616: editing Course Categories).
1.663 raeburn 13617:
1.655 raeburn 13618: jsarray (reference to array of categories used to create Javascript arrays for
13619: Domain Coordinator interface for editing Course Categories).
13620:
1.665 raeburn 13621: subcats (reference to hash of arrays containing all subcategories within each
13622: category, -recursive)
13623:
1.655 raeburn 13624: Returns: nothing
13625:
13626: Side effects: populates trails and allitems hash references.
13627:
13628: =cut
13629:
13630: sub extract_categories {
1.665 raeburn 13631: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 13632: if (ref($categories) eq 'HASH') {
13633: &gather_categories($categories,$cats,$idx,$jsarray);
13634: if (ref($cats->[0]) eq 'ARRAY') {
13635: for (my $i=0; $i<@{$cats->[0]}; $i++) {
13636: my $name = $cats->[0][$i];
13637: my $item = &escape($name).'::0';
13638: my $trailstr;
13639: if ($name eq 'instcode') {
13640: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 13641: } elsif ($name eq 'communities') {
13642: $trailstr = &mt('Communities');
1.655 raeburn 13643: } else {
13644: $trailstr = $name;
13645: }
13646: if ($allitems->{$item} eq '') {
13647: push(@{$trails},$trailstr);
13648: $allitems->{$item} = scalar(@{$trails})-1;
13649: }
13650: my @parents = ($name);
13651: if (ref($cats->[1]{$name}) eq 'ARRAY') {
13652: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
13653: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 13654: if (ref($subcats) eq 'HASH') {
13655: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
13656: }
13657: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
13658: }
13659: } else {
13660: if (ref($subcats) eq 'HASH') {
13661: $subcats->{$item} = [];
1.655 raeburn 13662: }
13663: }
13664: }
13665: }
13666: }
13667: return;
13668: }
13669:
13670: =pod
13671:
1.1075.2.56 raeburn 13672: =item * &recurse_categories()
1.655 raeburn 13673:
13674: Recursively used to generate breadcrumb trails for course categories.
13675:
13676: Inputs:
1.663 raeburn 13677:
1.655 raeburn 13678: cats (reference to array of arrays/hashes which encapsulates hierarchy of
13679: categories and subcategories).
1.663 raeburn 13680:
1.655 raeburn 13681: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 13682:
13683: category (current course category, for which breadcrumb trail is being generated).
13684:
13685: trails (reference to array of breadcrumb trails for each category).
13686:
1.655 raeburn 13687: allitems (reference to hash - key is category key
13688: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 13689:
1.655 raeburn 13690: parents (array containing containers directories for current category,
13691: back to top level).
13692:
13693: Returns: nothing
13694:
13695: Side effects: populates trails and allitems hash references
13696:
13697: =cut
13698:
13699: sub recurse_categories {
1.665 raeburn 13700: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 13701: my $shallower = $depth - 1;
13702: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
13703: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
13704: my $name = $cats->[$depth]{$category}[$k];
13705: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
13706: my $trailstr = join(' -> ',(@{$parents},$category));
13707: if ($allitems->{$item} eq '') {
13708: push(@{$trails},$trailstr);
13709: $allitems->{$item} = scalar(@{$trails})-1;
13710: }
13711: my $deeper = $depth+1;
13712: push(@{$parents},$category);
1.665 raeburn 13713: if (ref($subcats) eq 'HASH') {
13714: my $subcat = &escape($name).':'.$category.':'.$depth;
13715: for (my $j=@{$parents}; $j>=0; $j--) {
13716: my $higher;
13717: if ($j > 0) {
13718: $higher = &escape($parents->[$j]).':'.
13719: &escape($parents->[$j-1]).':'.$j;
13720: } else {
13721: $higher = &escape($parents->[$j]).'::'.$j;
13722: }
13723: push(@{$subcats->{$higher}},$subcat);
13724: }
13725: }
13726: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
13727: $subcats);
1.655 raeburn 13728: pop(@{$parents});
13729: }
13730: } else {
13731: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
13732: my $trailstr = join(' -> ',(@{$parents},$category));
13733: if ($allitems->{$item} eq '') {
13734: push(@{$trails},$trailstr);
13735: $allitems->{$item} = scalar(@{$trails})-1;
13736: }
13737: }
13738: return;
13739: }
13740:
1.663 raeburn 13741: =pod
13742:
1.1075.2.56 raeburn 13743: =item * &assign_categories_table()
1.663 raeburn 13744:
13745: Create a datatable for display of hierarchical categories in a domain,
13746: with checkboxes to allow a course to be categorized.
13747:
13748: Inputs:
13749:
13750: cathash - reference to hash of categories defined for the domain (from
13751: configuration.db)
13752:
13753: currcat - scalar with an & separated list of categories assigned to a course.
13754:
1.919 raeburn 13755: type - scalar contains course type (Course or Community).
13756:
1.663 raeburn 13757: Returns: $output (markup to be displayed)
13758:
13759: =cut
13760:
13761: sub assign_categories_table {
1.919 raeburn 13762: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 13763: my $output;
13764: if (ref($cathash) eq 'HASH') {
13765: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
13766: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
13767: $maxdepth = scalar(@cats);
13768: if (@cats > 0) {
13769: my $itemcount = 0;
13770: if (ref($cats[0]) eq 'ARRAY') {
13771: my @currcategories;
13772: if ($currcat ne '') {
13773: @currcategories = split('&',$currcat);
13774: }
1.919 raeburn 13775: my $table;
1.663 raeburn 13776: for (my $i=0; $i<@{$cats[0]}; $i++) {
13777: my $parent = $cats[0][$i];
1.919 raeburn 13778: next if ($parent eq 'instcode');
13779: if ($type eq 'Community') {
13780: next unless ($parent eq 'communities');
13781: } else {
13782: next if ($parent eq 'communities');
13783: }
1.663 raeburn 13784: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
13785: my $item = &escape($parent).'::0';
13786: my $checked = '';
13787: if (@currcategories > 0) {
13788: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 13789: $checked = ' checked="checked"';
1.663 raeburn 13790: }
13791: }
1.919 raeburn 13792: my $parent_title = $parent;
13793: if ($parent eq 'communities') {
13794: $parent_title = &mt('Communities');
13795: }
13796: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
13797: '<input type="checkbox" name="usecategory" value="'.
13798: $item.'"'.$checked.' />'.$parent_title.'</span>'.
13799: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 13800: my $depth = 1;
13801: push(@path,$parent);
1.919 raeburn 13802: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 13803: pop(@path);
1.919 raeburn 13804: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 13805: $itemcount ++;
13806: }
1.919 raeburn 13807: if ($itemcount) {
13808: $output = &Apache::loncommon::start_data_table().
13809: $table.
13810: &Apache::loncommon::end_data_table();
13811: }
1.663 raeburn 13812: }
13813: }
13814: }
13815: return $output;
13816: }
13817:
13818: =pod
13819:
1.1075.2.56 raeburn 13820: =item * &assign_category_rows()
1.663 raeburn 13821:
13822: Create a datatable row for display of nested categories in a domain,
13823: with checkboxes to allow a course to be categorized,called recursively.
13824:
13825: Inputs:
13826:
13827: itemcount - track row number for alternating colors
13828:
13829: cats - reference to array of arrays/hashes which encapsulates hierarchy of
13830: categories and subcategories.
13831:
13832: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
13833:
13834: parent - parent of current category item
13835:
13836: path - Array containing all categories back up through the hierarchy from the
13837: current category to the top level.
13838:
13839: currcategories - reference to array of current categories assigned to the course
13840:
13841: Returns: $output (markup to be displayed).
13842:
13843: =cut
13844:
13845: sub assign_category_rows {
13846: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
13847: my ($text,$name,$item,$chgstr);
13848: if (ref($cats) eq 'ARRAY') {
13849: my $maxdepth = scalar(@{$cats});
13850: if (ref($cats->[$depth]) eq 'HASH') {
13851: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
13852: my $numchildren = @{$cats->[$depth]{$parent}};
13853: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1075.2.45 raeburn 13854: $text .= '<td><table class="LC_data_table">';
1.663 raeburn 13855: for (my $j=0; $j<$numchildren; $j++) {
13856: $name = $cats->[$depth]{$parent}[$j];
13857: $item = &escape($name).':'.&escape($parent).':'.$depth;
13858: my $deeper = $depth+1;
13859: my $checked = '';
13860: if (ref($currcategories) eq 'ARRAY') {
13861: if (@{$currcategories} > 0) {
13862: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 13863: $checked = ' checked="checked"';
1.663 raeburn 13864: }
13865: }
13866: }
1.664 raeburn 13867: $text .= '<tr><td><span class="LC_nobreak"><label>'.
13868: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 13869: $item.'"'.$checked.' />'.$name.'</label></span>'.
13870: '<input type="hidden" name="catname" value="'.$name.'" />'.
13871: '</td><td>';
1.663 raeburn 13872: if (ref($path) eq 'ARRAY') {
13873: push(@{$path},$name);
13874: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
13875: pop(@{$path});
13876: }
13877: $text .= '</td></tr>';
13878: }
13879: $text .= '</table></td>';
13880: }
13881: }
13882: }
13883: return $text;
13884: }
13885:
1.1075.2.69 raeburn 13886: =pod
13887:
13888: =back
13889:
13890: =cut
13891:
1.655 raeburn 13892: ############################################################
13893: ############################################################
13894:
13895:
1.443 albertel 13896: sub commit_customrole {
1.664 raeburn 13897: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 13898: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 13899: ($start?', '.&mt('starting').' '.localtime($start):'').
13900: ($end?', ending '.localtime($end):'').': <b>'.
13901: &Apache::lonnet::assigncustomrole(
1.664 raeburn 13902: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 13903: '</b><br />';
13904: return $output;
13905: }
13906:
13907: sub commit_standardrole {
1.1075.2.31 raeburn 13908: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits) = @_;
1.541 raeburn 13909: my ($output,$logmsg,$linefeed);
13910: if ($context eq 'auto') {
13911: $linefeed = "\n";
13912: } else {
13913: $linefeed = "<br />\n";
13914: }
1.443 albertel 13915: if ($three eq 'st') {
1.541 raeburn 13916: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1075.2.31 raeburn 13917: $one,$two,$sec,$context,$credits);
1.541 raeburn 13918: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 13919: ($result eq 'unknown_course') || ($result eq 'refused')) {
13920: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 13921: } else {
1.541 raeburn 13922: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 13923: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 13924: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
13925: if ($context eq 'auto') {
13926: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
13927: } else {
13928: $output .= '<b>'.$result.'</b>'.$linefeed.
13929: &mt('Add to classlist').': <b>ok</b>';
13930: }
13931: $output .= $linefeed;
1.443 albertel 13932: }
13933: } else {
13934: $output = &mt('Assigning').' '.$three.' in '.$url.
13935: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 13936: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 13937: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 13938: if ($context eq 'auto') {
13939: $output .= $result.$linefeed;
13940: } else {
13941: $output .= '<b>'.$result.'</b>'.$linefeed;
13942: }
1.443 albertel 13943: }
13944: return $output;
13945: }
13946:
13947: sub commit_studentrole {
1.1075.2.31 raeburn 13948: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
13949: $credits) = @_;
1.626 raeburn 13950: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 13951: if ($context eq 'auto') {
13952: $linefeed = "\n";
13953: } else {
13954: $linefeed = '<br />'."\n";
13955: }
1.443 albertel 13956: if (defined($one) && defined($two)) {
13957: my $cid=$one.'_'.$two;
13958: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
13959: my $secchange = 0;
13960: my $expire_role_result;
13961: my $modify_section_result;
1.628 raeburn 13962: if ($oldsec ne '-1') {
13963: if ($oldsec ne $sec) {
1.443 albertel 13964: $secchange = 1;
1.628 raeburn 13965: my $now = time;
1.443 albertel 13966: my $uurl='/'.$cid;
13967: $uurl=~s/\_/\//g;
13968: if ($oldsec) {
13969: $uurl.='/'.$oldsec;
13970: }
1.626 raeburn 13971: $oldsecurl = $uurl;
1.628 raeburn 13972: $expire_role_result =
1.652 raeburn 13973: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 13974: if ($env{'request.course.sec'} ne '') {
13975: if ($expire_role_result eq 'refused') {
13976: my @roles = ('st');
13977: my @statuses = ('previous');
13978: my @roledoms = ($one);
13979: my $withsec = 1;
13980: my %roleshash =
13981: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
13982: \@statuses,\@roles,\@roledoms,$withsec);
13983: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
13984: my ($oldstart,$oldend) =
13985: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
13986: if ($oldend > 0 && $oldend <= $now) {
13987: $expire_role_result = 'ok';
13988: }
13989: }
13990: }
13991: }
1.443 albertel 13992: $result = $expire_role_result;
13993: }
13994: }
13995: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1075.2.31 raeburn 13996: $modify_section_result =
13997: &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
13998: undef,undef,undef,$sec,
13999: $end,$start,'','',$cid,
14000: '',$context,$credits);
1.443 albertel 14001: if ($modify_section_result =~ /^ok/) {
14002: if ($secchange == 1) {
1.628 raeburn 14003: if ($sec eq '') {
14004: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
14005: } else {
14006: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
14007: }
1.443 albertel 14008: } elsif ($oldsec eq '-1') {
1.628 raeburn 14009: if ($sec eq '') {
14010: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
14011: } else {
14012: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
14013: }
1.443 albertel 14014: } else {
1.628 raeburn 14015: if ($sec eq '') {
14016: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
14017: } else {
14018: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
14019: }
1.443 albertel 14020: }
14021: } else {
1.628 raeburn 14022: if ($secchange) {
14023: $$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;
14024: } else {
14025: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
14026: }
1.443 albertel 14027: }
14028: $result = $modify_section_result;
14029: } elsif ($secchange == 1) {
1.628 raeburn 14030: if ($oldsec eq '') {
1.1075.2.20 raeburn 14031: $$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 14032: } else {
14033: $$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;
14034: }
1.626 raeburn 14035: if ($expire_role_result eq 'refused') {
14036: my $newsecurl = '/'.$cid;
14037: $newsecurl =~ s/\_/\//g;
14038: if ($sec ne '') {
14039: $newsecurl.='/'.$sec;
14040: }
14041: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
14042: if ($sec eq '') {
14043: $$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;
14044: } else {
14045: $$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;
14046: }
14047: }
14048: }
1.443 albertel 14049: }
14050: } else {
1.626 raeburn 14051: $$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 14052: $result = "error: incomplete course id\n";
14053: }
14054: return $result;
14055: }
14056:
1.1075.2.25 raeburn 14057: sub show_role_extent {
14058: my ($scope,$context,$role) = @_;
14059: $scope =~ s{^/}{};
14060: my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
14061: push(@courseroles,'co');
14062: my @authorroles = &Apache::lonuserutils::roles_by_context('author');
14063: if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
14064: $scope =~ s{/}{_};
14065: return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
14066: } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
14067: my ($audom,$auname) = split(/\//,$scope);
14068: return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
14069: &Apache::loncommon::plainname($auname,$audom).'</span>');
14070: } else {
14071: $scope =~ s{/$}{};
14072: return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
14073: &Apache::lonnet::domain($scope,'description').'</span>');
14074: }
14075: }
14076:
1.443 albertel 14077: ############################################################
14078: ############################################################
14079:
1.566 albertel 14080: sub check_clone {
1.578 raeburn 14081: my ($args,$linefeed) = @_;
1.566 albertel 14082: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
14083: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
14084: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
14085: my $clonemsg;
14086: my $can_clone = 0;
1.944 raeburn 14087: my $lctype = lc($args->{'crstype'});
1.908 raeburn 14088: if ($lctype ne 'community') {
14089: $lctype = 'course';
14090: }
1.566 albertel 14091: if ($clonehome eq 'no_host') {
1.944 raeburn 14092: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 14093: $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'});
14094: } else {
14095: $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'});
14096: }
1.566 albertel 14097: } else {
14098: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944 raeburn 14099: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 14100: if ($clonedesc{'type'} ne 'Community') {
14101: $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'});
14102: return ($can_clone, $clonemsg, $cloneid, $clonehome);
14103: }
14104: }
1.882 raeburn 14105: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
14106: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 14107: $can_clone = 1;
14108: } else {
1.1075.2.95 raeburn 14109: my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566 albertel 14110: $args->{'clonedomain'},$args->{'clonecourse'});
1.1075.2.95 raeburn 14111: if ($clonehash{'cloners'} eq '') {
14112: my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
14113: if ($domdefs{'canclone'}) {
14114: unless ($domdefs{'canclone'} eq 'none') {
14115: if ($domdefs{'canclone'} eq 'domain') {
14116: if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
14117: $can_clone = 1;
14118: }
14119: } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
14120: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
14121: if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
14122: $clonehash{'internal.coursecode'},$args->{'crscode'})) {
14123: $can_clone = 1;
14124: }
14125: }
14126: }
1.908 raeburn 14127: }
1.1075.2.95 raeburn 14128: } else {
14129: my @cloners = split(/,/,$clonehash{'cloners'});
14130: if (grep(/^\*$/,@cloners)) {
1.942 raeburn 14131: $can_clone = 1;
1.1075.2.95 raeburn 14132: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942 raeburn 14133: $can_clone = 1;
1.1075.2.96 raeburn 14134: } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
14135: $can_clone = 1;
1.1075.2.95 raeburn 14136: }
14137: unless ($can_clone) {
1.1075.2.96 raeburn 14138: if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
14139: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
1.1075.2.95 raeburn 14140: my (%gotdomdefaults,%gotcodedefaults);
14141: foreach my $cloner (@cloners) {
14142: if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
14143: ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
14144: my (%codedefaults,@code_order);
14145: if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
14146: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
14147: %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
14148: }
14149: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
14150: @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
14151: }
14152: } else {
14153: &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
14154: \%codedefaults,
14155: \@code_order);
14156: $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
14157: $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
14158: }
14159: if (@code_order > 0) {
14160: if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
14161: $cloner,$clonehash{'internal.coursecode'},
14162: $args->{'crscode'})) {
14163: $can_clone = 1;
14164: last;
14165: }
14166: }
14167: }
14168: }
14169: }
1.1075.2.96 raeburn 14170: }
14171: }
14172: unless ($can_clone) {
14173: my $ccrole = 'cc';
14174: if ($args->{'crstype'} eq 'Community') {
14175: $ccrole = 'co';
14176: }
14177: my %roleshash =
14178: &Apache::lonnet::get_my_roles($args->{'ccuname'},
14179: $args->{'ccdomain'},
14180: 'userroles',['active'],[$ccrole],
14181: [$args->{'clonedomain'}]);
14182: if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
14183: $can_clone = 1;
14184: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
14185: $args->{'ccuname'},$args->{'ccdomain'})) {
14186: $can_clone = 1;
1.1075.2.95 raeburn 14187: }
14188: }
14189: unless ($can_clone) {
14190: if ($args->{'crstype'} eq 'Community') {
14191: $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'});
14192: } else {
14193: $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'});
1.578 raeburn 14194: }
1.566 albertel 14195: }
1.578 raeburn 14196: }
1.566 albertel 14197: }
14198: return ($can_clone, $clonemsg, $cloneid, $clonehome);
14199: }
14200:
1.444 albertel 14201: sub construct_course {
1.1075.2.59 raeburn 14202: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category,$coderef) = @_;
1.444 albertel 14203: my $outcome;
1.541 raeburn 14204: my $linefeed = '<br />'."\n";
14205: if ($context eq 'auto') {
14206: $linefeed = "\n";
14207: }
1.566 albertel 14208:
14209: #
14210: # Are we cloning?
14211: #
14212: my ($can_clone, $clonemsg, $cloneid, $clonehome);
14213: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 14214: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 14215: if ($context ne 'auto') {
1.578 raeburn 14216: if ($clonemsg ne '') {
14217: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
14218: }
1.566 albertel 14219: }
14220: $outcome .= $clonemsg.$linefeed;
14221:
14222: if (!$can_clone) {
14223: return (0,$outcome);
14224: }
14225: }
14226:
1.444 albertel 14227: #
14228: # Open course
14229: #
14230: my $crstype = lc($args->{'crstype'});
14231: my %cenv=();
14232: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
14233: $args->{'cdescr'},
14234: $args->{'curl'},
14235: $args->{'course_home'},
14236: $args->{'nonstandard'},
14237: $args->{'crscode'},
14238: $args->{'ccuname'}.':'.
14239: $args->{'ccdomain'},
1.882 raeburn 14240: $args->{'crstype'},
1.885 raeburn 14241: $cnum,$context,$category);
1.444 albertel 14242:
14243: # Note: The testing routines depend on this being output; see
14244: # Utils::Course. This needs to at least be output as a comment
14245: # if anyone ever decides to not show this, and Utils::Course::new
14246: # will need to be suitably modified.
1.541 raeburn 14247: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943 raeburn 14248: if ($$courseid =~ /^error:/) {
14249: return (0,$outcome);
14250: }
14251:
1.444 albertel 14252: #
14253: # Check if created correctly
14254: #
1.479 albertel 14255: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 14256: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 14257: if ($crsuhome eq 'no_host') {
14258: $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
14259: return (0,$outcome);
14260: }
1.541 raeburn 14261: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 14262:
1.444 albertel 14263: #
1.566 albertel 14264: # Do the cloning
14265: #
14266: if ($can_clone && $cloneid) {
14267: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
14268: if ($context ne 'auto') {
14269: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
14270: }
14271: $outcome .= $clonemsg.$linefeed;
14272: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 14273: # Copy all files
1.637 www 14274: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 14275: # Restore URL
1.566 albertel 14276: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 14277: # Restore title
1.566 albertel 14278: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 14279: # Restore creation date, creator and creation context.
14280: $cenv{'internal.created'}=$oldcenv{'internal.created'};
14281: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
14282: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 14283: # Mark as cloned
1.566 albertel 14284: $cenv{'clonedfrom'}=$cloneid;
1.638 www 14285: # Need to clone grading mode
14286: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
14287: $cenv{'grading'}=$newenv{'grading'};
14288: # Do not clone these environment entries
14289: &Apache::lonnet::del('environment',
14290: ['default_enrollment_start_date',
14291: 'default_enrollment_end_date',
14292: 'question.email',
14293: 'policy.email',
14294: 'comment.email',
14295: 'pch.users.denied',
1.725 raeburn 14296: 'plc.users.denied',
14297: 'hidefromcat',
1.1075.2.36 raeburn 14298: 'checkforpriv',
1.1075.2.59 raeburn 14299: 'categories',
14300: 'internal.uniquecode'],
1.638 www 14301: $$crsudom,$$crsunum);
1.1075.2.63 raeburn 14302: if ($args->{'textbook'}) {
14303: $cenv{'internal.textbook'} = $args->{'textbook'};
14304: }
1.444 albertel 14305: }
1.566 albertel 14306:
1.444 albertel 14307: #
14308: # Set environment (will override cloned, if existing)
14309: #
14310: my @sections = ();
14311: my @xlists = ();
14312: if ($args->{'crstype'}) {
14313: $cenv{'type'}=$args->{'crstype'};
14314: }
14315: if ($args->{'crsid'}) {
14316: $cenv{'courseid'}=$args->{'crsid'};
14317: }
14318: if ($args->{'crscode'}) {
14319: $cenv{'internal.coursecode'}=$args->{'crscode'};
14320: }
14321: if ($args->{'crsquota'} ne '') {
14322: $cenv{'internal.coursequota'}=$args->{'crsquota'};
14323: } else {
14324: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
14325: }
14326: if ($args->{'ccuname'}) {
14327: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
14328: ':'.$args->{'ccdomain'};
14329: } else {
14330: $cenv{'internal.courseowner'} = $args->{'curruser'};
14331: }
1.1075.2.31 raeburn 14332: if ($args->{'defaultcredits'}) {
14333: $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
14334: }
1.444 albertel 14335: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
14336: if ($args->{'crssections'}) {
14337: $cenv{'internal.sectionnums'} = '';
14338: if ($args->{'crssections'} =~ m/,/) {
14339: @sections = split/,/,$args->{'crssections'};
14340: } else {
14341: $sections[0] = $args->{'crssections'};
14342: }
14343: if (@sections > 0) {
14344: foreach my $item (@sections) {
14345: my ($sec,$gp) = split/:/,$item;
14346: my $class = $args->{'crscode'}.$sec;
14347: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
14348: $cenv{'internal.sectionnums'} .= $item.',';
14349: unless ($addcheck eq 'ok') {
14350: push @badclasses, $class;
14351: }
14352: }
14353: $cenv{'internal.sectionnums'} =~ s/,$//;
14354: }
14355: }
14356: # do not hide course coordinator from staff listing,
14357: # even if privileged
14358: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1075.2.36 raeburn 14359: # add course coordinator's domain to domains to check for privileged users
14360: # if different to course domain
14361: if ($$crsudom ne $args->{'ccdomain'}) {
14362: $cenv{'checkforpriv'} = $args->{'ccdomain'};
14363: }
1.444 albertel 14364: # add crosslistings
14365: if ($args->{'crsxlist'}) {
14366: $cenv{'internal.crosslistings'}='';
14367: if ($args->{'crsxlist'} =~ m/,/) {
14368: @xlists = split/,/,$args->{'crsxlist'};
14369: } else {
14370: $xlists[0] = $args->{'crsxlist'};
14371: }
14372: if (@xlists > 0) {
14373: foreach my $item (@xlists) {
14374: my ($xl,$gp) = split/:/,$item;
14375: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
14376: $cenv{'internal.crosslistings'} .= $item.',';
14377: unless ($addcheck eq 'ok') {
14378: push @badclasses, $xl;
14379: }
14380: }
14381: $cenv{'internal.crosslistings'} =~ s/,$//;
14382: }
14383: }
14384: if ($args->{'autoadds'}) {
14385: $cenv{'internal.autoadds'}=$args->{'autoadds'};
14386: }
14387: if ($args->{'autodrops'}) {
14388: $cenv{'internal.autodrops'}=$args->{'autodrops'};
14389: }
14390: # check for notification of enrollment changes
14391: my @notified = ();
14392: if ($args->{'notify_owner'}) {
14393: if ($args->{'ccuname'} ne '') {
14394: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
14395: }
14396: }
14397: if ($args->{'notify_dc'}) {
14398: if ($uname ne '') {
1.630 raeburn 14399: push(@notified,$uname.':'.$udom);
1.444 albertel 14400: }
14401: }
14402: if (@notified > 0) {
14403: my $notifylist;
14404: if (@notified > 1) {
14405: $notifylist = join(',',@notified);
14406: } else {
14407: $notifylist = $notified[0];
14408: }
14409: $cenv{'internal.notifylist'} = $notifylist;
14410: }
14411: if (@badclasses > 0) {
14412: my %lt=&Apache::lonlocal::texthash(
14413: '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',
14414: 'dnhr' => 'does not have rights to access enrollment in these classes',
14415: 'adby' => 'as determined by the policies of your institution on access to official classlists'
14416: );
1.541 raeburn 14417: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
14418: ' ('.$lt{'adby'}.')';
14419: if ($context eq 'auto') {
14420: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 14421: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 14422: foreach my $item (@badclasses) {
14423: if ($context eq 'auto') {
14424: $outcome .= " - $item\n";
14425: } else {
14426: $outcome .= "<li>$item</li>\n";
14427: }
14428: }
14429: if ($context eq 'auto') {
14430: $outcome .= $linefeed;
14431: } else {
1.566 albertel 14432: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 14433: }
14434: }
1.444 albertel 14435: }
14436: if ($args->{'no_end_date'}) {
14437: $args->{'endaccess'} = 0;
14438: }
14439: $cenv{'internal.autostart'}=$args->{'enrollstart'};
14440: $cenv{'internal.autoend'}=$args->{'enrollend'};
14441: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
14442: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
14443: if ($args->{'showphotos'}) {
14444: $cenv{'internal.showphotos'}=$args->{'showphotos'};
14445: }
14446: $cenv{'internal.authtype'} = $args->{'authtype'};
14447: $cenv{'internal.autharg'} = $args->{'autharg'};
14448: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
14449: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 14450: 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');
14451: if ($context eq 'auto') {
14452: $outcome .= $krb_msg;
14453: } else {
1.566 albertel 14454: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 14455: }
14456: $outcome .= $linefeed;
1.444 albertel 14457: }
14458: }
14459: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
14460: if ($args->{'setpolicy'}) {
14461: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
14462: }
14463: if ($args->{'setcontent'}) {
14464: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
14465: }
14466: }
14467: if ($args->{'reshome'}) {
14468: $cenv{'reshome'}=$args->{'reshome'}.'/';
14469: $cenv{'reshome'}=~s/\/+$/\//;
14470: }
14471: #
14472: # course has keyed access
14473: #
14474: if ($args->{'setkeys'}) {
14475: $cenv{'keyaccess'}='yes';
14476: }
14477: # if specified, key authority is not course, but user
14478: # only active if keyaccess is yes
14479: if ($args->{'keyauth'}) {
1.487 albertel 14480: my ($user,$domain) = split(':',$args->{'keyauth'});
14481: $user = &LONCAPA::clean_username($user);
14482: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 14483: if ($user ne '' && $domain ne '') {
1.487 albertel 14484: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 14485: }
14486: }
14487:
1.1075.2.59 raeburn 14488: #
14489: # generate and store uniquecode (available to course requester), if course should have one.
14490: #
14491: if ($args->{'uniquecode'}) {
14492: my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
14493: if ($code) {
14494: $cenv{'internal.uniquecode'} = $code;
14495: my %crsinfo =
14496: &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
14497: if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
14498: $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
14499: my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
14500: }
14501: if (ref($coderef)) {
14502: $$coderef = $code;
14503: }
14504: }
14505: }
14506:
1.444 albertel 14507: if ($args->{'disresdis'}) {
14508: $cenv{'pch.roles.denied'}='st';
14509: }
14510: if ($args->{'disablechat'}) {
14511: $cenv{'plc.roles.denied'}='st';
14512: }
14513:
14514: # Record we've not yet viewed the Course Initialization Helper for this
14515: # course
14516: $cenv{'course.helper.not.run'} = 1;
14517: #
14518: # Use new Randomseed
14519: #
14520: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
14521: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
14522: #
14523: # The encryption code and receipt prefix for this course
14524: #
14525: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
14526: $cenv{'internal.encpref'}=100+int(9*rand(99));
14527: #
14528: # By default, use standard grading
14529: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
14530:
1.541 raeburn 14531: $outcome .= $linefeed.&mt('Setting environment').': '.
14532: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 14533: #
14534: # Open all assignments
14535: #
14536: if ($args->{'openall'}) {
14537: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
14538: my %storecontent = ($storeunder => time,
14539: $storeunder.'.type' => 'date_start');
14540:
14541: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 14542: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 14543: }
14544: #
14545: # Set first page
14546: #
14547: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
14548: || ($cloneid)) {
1.445 albertel 14549: use LONCAPA::map;
1.444 albertel 14550: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 14551:
14552: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
14553: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
14554:
1.444 albertel 14555: $outcome .= ($fatal?$errtext:'read ok').' - ';
14556: my $title; my $url;
14557: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 14558: $title=&mt('Syllabus');
1.444 albertel 14559: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
14560: } else {
1.963 raeburn 14561: $title=&mt('Table of Contents');
1.444 albertel 14562: $url='/adm/navmaps';
14563: }
1.445 albertel 14564:
14565: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
14566: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
14567:
14568: if ($errtext) { $fatal=2; }
1.541 raeburn 14569: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 14570: }
1.566 albertel 14571:
14572: return (1,$outcome);
1.444 albertel 14573: }
14574:
1.1075.2.59 raeburn 14575: sub make_unique_code {
14576: my ($cdom,$cnum) = @_;
14577: # get lock on uniquecodes db
14578: my $lockhash = {
14579: $cnum."\0".'uniquecodes' => $env{'user.name'}.
14580: ':'.$env{'user.domain'},
14581: };
14582: my $tries = 0;
14583: my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
14584: my ($code,$error);
14585:
14586: while (($gotlock ne 'ok') && ($tries<3)) {
14587: $tries ++;
14588: sleep 1;
14589: $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
14590: }
14591: if ($gotlock eq 'ok') {
14592: my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
14593: my $gotcode;
14594: my $attempts = 0;
14595: while ((!$gotcode) && ($attempts < 100)) {
14596: $code = &generate_code();
14597: if (!exists($currcodes{$code})) {
14598: $gotcode = 1;
14599: unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
14600: $error = 'nostore';
14601: }
14602: }
14603: $attempts ++;
14604: }
14605: my @del_lock = ($cnum."\0".'uniquecodes');
14606: my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
14607: } else {
14608: $error = 'nolock';
14609: }
14610: return ($code,$error);
14611: }
14612:
14613: sub generate_code {
14614: my $code;
14615: my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
14616: for (my $i=0; $i<6; $i++) {
14617: my $lettnum = int (rand 2);
14618: my $item = '';
14619: if ($lettnum) {
14620: $item = $letts[int( rand(18) )];
14621: } else {
14622: $item = 1+int( rand(8) );
14623: }
14624: $code .= $item;
14625: }
14626: return $code;
14627: }
14628:
1.444 albertel 14629: ############################################################
14630: ############################################################
14631:
1.953 droeschl 14632: #SD
14633: # only Community and Course, or anything else?
1.378 raeburn 14634: sub course_type {
14635: my ($cid) = @_;
14636: if (!defined($cid)) {
14637: $cid = $env{'request.course.id'};
14638: }
1.404 albertel 14639: if (defined($env{'course.'.$cid.'.type'})) {
14640: return $env{'course.'.$cid.'.type'};
1.378 raeburn 14641: } else {
14642: return 'Course';
1.377 raeburn 14643: }
14644: }
1.156 albertel 14645:
1.406 raeburn 14646: sub group_term {
14647: my $crstype = &course_type();
14648: my %names = (
14649: 'Course' => 'group',
1.865 raeburn 14650: 'Community' => 'group',
1.406 raeburn 14651: );
14652: return $names{$crstype};
14653: }
14654:
1.902 raeburn 14655: sub course_types {
1.1075.2.59 raeburn 14656: my @types = ('official','unofficial','community','textbook');
1.902 raeburn 14657: my %typename = (
14658: official => 'Official course',
14659: unofficial => 'Unofficial course',
14660: community => 'Community',
1.1075.2.59 raeburn 14661: textbook => 'Textbook course',
1.902 raeburn 14662: );
14663: return (\@types,\%typename);
14664: }
14665:
1.156 albertel 14666: sub icon {
14667: my ($file)=@_;
1.505 albertel 14668: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 14669: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 14670: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 14671: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
14672: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
14673: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
14674: $curfext.".gif") {
14675: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
14676: $curfext.".gif";
14677: }
14678: }
1.249 albertel 14679: return &lonhttpdurl($iconname);
1.154 albertel 14680: }
1.84 albertel 14681:
1.575 albertel 14682: sub lonhttpdurl {
1.692 www 14683: #
14684: # Had been used for "small fry" static images on separate port 8080.
14685: # Modify here if lightweight http functionality desired again.
14686: # Currently eliminated due to increasing firewall issues.
14687: #
1.575 albertel 14688: my ($url)=@_;
1.692 www 14689: return $url;
1.215 albertel 14690: }
14691:
1.213 albertel 14692: sub connection_aborted {
14693: my ($r)=@_;
14694: $r->print(" ");$r->rflush();
14695: my $c = $r->connection;
14696: return $c->aborted();
14697: }
14698:
1.221 foxr 14699: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 14700: # strings as 'strings'.
14701: sub escape_single {
1.221 foxr 14702: my ($input) = @_;
1.223 albertel 14703: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 14704: $input =~ s/\'/\\\'/g; # Esacpe the 's....
14705: return $input;
14706: }
1.223 albertel 14707:
1.222 foxr 14708: # Same as escape_single, but escape's "'s This
14709: # can be used for "strings"
14710: sub escape_double {
14711: my ($input) = @_;
14712: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
14713: $input =~ s/\"/\\\"/g; # Esacpe the "s....
14714: return $input;
14715: }
1.223 albertel 14716:
1.222 foxr 14717: # Escapes the last element of a full URL.
14718: sub escape_url {
14719: my ($url) = @_;
1.238 raeburn 14720: my @urlslices = split(/\//, $url,-1);
1.369 www 14721: my $lastitem = &escape(pop(@urlslices));
1.1075.2.83 raeburn 14722: return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222 foxr 14723: }
1.462 albertel 14724:
1.820 raeburn 14725: sub compare_arrays {
14726: my ($arrayref1,$arrayref2) = @_;
14727: my (@difference,%count);
14728: @difference = ();
14729: %count = ();
14730: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
14731: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
14732: foreach my $element (keys(%count)) {
14733: if ($count{$element} == 1) {
14734: push(@difference,$element);
14735: }
14736: }
14737: }
14738: return @difference;
14739: }
14740:
1.817 bisitz 14741: # -------------------------------------------------------- Initialize user login
1.462 albertel 14742: sub init_user_environment {
1.463 albertel 14743: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 14744: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
14745:
14746: my $public=($username eq 'public' && $domain eq 'public');
14747:
14748: # See if old ID present, if so, remove
14749:
1.1062 raeburn 14750: my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462 albertel 14751: my $now=time;
14752:
14753: if ($public) {
14754: my $max_public=100;
14755: my $oldest;
14756: my $oldest_time=0;
14757: for(my $next=1;$next<=$max_public;$next++) {
14758: if (-e $lonids."/publicuser_$next.id") {
14759: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
14760: if ($mtime<$oldest_time || !$oldest_time) {
14761: $oldest_time=$mtime;
14762: $oldest=$next;
14763: }
14764: } else {
14765: $cookie="publicuser_$next";
14766: last;
14767: }
14768: }
14769: if (!$cookie) { $cookie="publicuser_$oldest"; }
14770: } else {
1.463 albertel 14771: # if this isn't a robot, kill any existing non-robot sessions
14772: if (!$args->{'robot'}) {
14773: opendir(DIR,$lonids);
14774: while ($filename=readdir(DIR)) {
14775: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
14776: unlink($lonids.'/'.$filename);
14777: }
1.462 albertel 14778: }
1.463 albertel 14779: closedir(DIR);
1.1075.2.84 raeburn 14780: # If there is a undeleted lockfile for the user's paste buffer remove it.
14781: my $namespace = 'nohist_courseeditor';
14782: my $lockingkey = 'paste'."\0".'locked_num';
14783: my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
14784: $domain,$username);
14785: if (exists($lockhash{$lockingkey})) {
14786: my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
14787: unless ($delresult eq 'ok') {
14788: &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
14789: }
14790: }
1.462 albertel 14791: }
14792: # Give them a new cookie
1.463 albertel 14793: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 14794: : $now.$$.int(rand(10000)));
1.463 albertel 14795: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 14796:
14797: # Initialize roles
14798:
1.1062 raeburn 14799: ($userroles,$firstaccenv,$timerintenv) =
14800: &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462 albertel 14801: }
14802: # ------------------------------------ Check browser type and MathML capability
14803:
1.1075.2.77 raeburn 14804: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
14805: $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462 albertel 14806:
14807: # ------------------------------------------------------------- Get environment
14808:
14809: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
14810: my ($tmp) = keys(%userenv);
14811: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
14812: } else {
14813: undef(%userenv);
14814: }
14815: if (($userenv{'interface'}) && (!$form->{'interface'})) {
14816: $form->{'interface'}=$userenv{'interface'};
14817: }
14818: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
14819:
14820: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 14821: foreach my $option ('interface','localpath','localres') {
14822: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 14823: }
14824: # --------------------------------------------------------- Write first profile
14825:
14826: {
14827: my %initial_env =
14828: ("user.name" => $username,
14829: "user.domain" => $domain,
14830: "user.home" => $authhost,
14831: "browser.type" => $clientbrowser,
14832: "browser.version" => $clientversion,
14833: "browser.mathml" => $clientmathml,
14834: "browser.unicode" => $clientunicode,
14835: "browser.os" => $clientos,
1.1075.2.42 raeburn 14836: "browser.mobile" => $clientmobile,
14837: "browser.info" => $clientinfo,
1.1075.2.77 raeburn 14838: "browser.osversion" => $clientosversion,
1.462 albertel 14839: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
14840: "request.course.fn" => '',
14841: "request.course.uri" => '',
14842: "request.course.sec" => '',
14843: "request.role" => 'cm',
14844: "request.role.adv" => $env{'user.adv'},
14845: "request.host" => $ENV{'REMOTE_ADDR'},);
14846:
14847: if ($form->{'localpath'}) {
14848: $initial_env{"browser.localpath"} = $form->{'localpath'};
14849: $initial_env{"browser.localres"} = $form->{'localres'};
14850: }
14851:
14852: if ($form->{'interface'}) {
14853: $form->{'interface'}=~s/\W//gs;
14854: $initial_env{"browser.interface"} = $form->{'interface'};
14855: $env{'browser.interface'}=$form->{'interface'};
14856: }
14857:
1.1075.2.54 raeburn 14858: if ($form->{'iptoken'}) {
14859: my $lonhost = $r->dir_config('lonHostID');
14860: $initial_env{"user.noloadbalance"} = $lonhost;
14861: $env{'user.noloadbalance'} = $lonhost;
14862: }
14863:
1.981 raeburn 14864: my %is_adv = ( is_adv => $env{'user.adv'} );
1.1016 raeburn 14865: my %domdef;
14866: unless ($domain eq 'public') {
14867: %domdef = &Apache::lonnet::get_domain_defaults($domain);
14868: }
1.980 raeburn 14869:
1.1075.2.7 raeburn 14870: foreach my $tool ('aboutme','blog','webdav','portfolio') {
1.724 raeburn 14871: $userenv{'availabletools.'.$tool} =
1.980 raeburn 14872: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
14873: undef,\%userenv,\%domdef,\%is_adv);
1.724 raeburn 14874: }
14875:
1.1075.2.59 raeburn 14876: foreach my $crstype ('official','unofficial','community','textbook') {
1.765 raeburn 14877: $userenv{'canrequest.'.$crstype} =
14878: &Apache::lonnet::usertools_access($username,$domain,$crstype,
1.980 raeburn 14879: 'reload','requestcourses',
14880: \%userenv,\%domdef,\%is_adv);
1.765 raeburn 14881: }
14882:
1.1075.2.14 raeburn 14883: $userenv{'canrequest.author'} =
14884: &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
14885: 'reload','requestauthor',
14886: \%userenv,\%domdef,\%is_adv);
14887: my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
14888: $domain,$username);
14889: my $reqstatus = $reqauthor{'author_status'};
14890: if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
14891: if (ref($reqauthor{'author'}) eq 'HASH') {
14892: $userenv{'requestauthorqueued'} = $reqstatus.':'.
14893: $reqauthor{'author'}{'timestamp'};
14894: }
14895: }
14896:
1.462 albertel 14897: $env{'user.environment'} = "$lonids/$cookie.id";
1.1062 raeburn 14898:
1.462 albertel 14899: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
14900: &GDBM_WRCREAT(),0640)) {
14901: &_add_to_env(\%disk_env,\%initial_env);
14902: &_add_to_env(\%disk_env,\%userenv,'environment.');
14903: &_add_to_env(\%disk_env,$userroles);
1.1062 raeburn 14904: if (ref($firstaccenv) eq 'HASH') {
14905: &_add_to_env(\%disk_env,$firstaccenv);
14906: }
14907: if (ref($timerintenv) eq 'HASH') {
14908: &_add_to_env(\%disk_env,$timerintenv);
14909: }
1.463 albertel 14910: if (ref($args->{'extra_env'})) {
14911: &_add_to_env(\%disk_env,$args->{'extra_env'});
14912: }
1.462 albertel 14913: untie(%disk_env);
14914: } else {
1.705 tempelho 14915: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
14916: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 14917: return 'error: '.$!;
14918: }
14919: }
14920: $env{'request.role'}='cm';
14921: $env{'request.role.adv'}=$env{'user.adv'};
14922: $env{'browser.type'}=$clientbrowser;
14923:
14924: return $cookie;
14925:
14926: }
14927:
14928: sub _add_to_env {
14929: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 14930: if (ref($env_data) eq 'HASH') {
14931: while (my ($key,$value) = each(%$env_data)) {
14932: $idf->{$prefix.$key} = $value;
14933: $env{$prefix.$key} = $value;
14934: }
1.462 albertel 14935: }
14936: }
14937:
1.685 tempelho 14938: # --- Get the symbolic name of a problem and the url
14939: sub get_symb {
14940: my ($request,$silent) = @_;
1.726 raeburn 14941: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 14942: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
14943: if ($symb eq '') {
14944: if (!$silent) {
1.1071 raeburn 14945: if (ref($request)) {
14946: $request->print("Unable to handle ambiguous references:$url:.");
14947: }
1.685 tempelho 14948: return ();
14949: }
14950: }
14951: &Apache::lonenc::check_decrypt(\$symb);
14952: return ($symb);
14953: }
14954:
14955: # --------------------------------------------------------------Get annotation
14956:
14957: sub get_annotation {
14958: my ($symb,$enc) = @_;
14959:
14960: my $key = $symb;
14961: if (!$enc) {
14962: $key =
14963: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
14964: }
14965: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
14966: return $annotation{$key};
14967: }
14968:
14969: sub clean_symb {
1.731 raeburn 14970: my ($symb,$delete_enc) = @_;
1.685 tempelho 14971:
14972: &Apache::lonenc::check_decrypt(\$symb);
14973: my $enc = $env{'request.enc'};
1.731 raeburn 14974: if ($delete_enc) {
1.730 raeburn 14975: delete($env{'request.enc'});
14976: }
1.685 tempelho 14977:
14978: return ($symb,$enc);
14979: }
1.462 albertel 14980:
1.1075.2.69 raeburn 14981: ############################################################
14982: ############################################################
14983:
14984: =pod
14985:
14986: =head1 Routines for building display used to search for courses
14987:
14988:
14989: =over 4
14990:
14991: =item * &build_filters()
14992:
14993: Create markup for a table used to set filters to use when selecting
14994: courses in a domain. Used by lonpickcourse.pm, lonmodifycourse.pm
14995: and quotacheck.pl
14996:
14997:
14998: Inputs:
14999:
15000: filterlist - anonymous array of fields to include as potential filters
15001:
15002: crstype - course type
15003:
15004: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
15005: to pop-open a course selector (will contain "extra element").
15006:
15007: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
15008:
15009: filter - anonymous hash of criteria and their values
15010:
15011: action - form action
15012:
15013: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
15014:
15015: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
15016:
15017: cloneruname - username of owner of new course who wants to clone
15018:
15019: clonerudom - domain of owner of new course who wants to clone
15020:
15021: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
15022:
15023: codetitlesref - reference to array of titles of components in institutional codes (official courses)
15024:
15025: codedom - domain
15026:
15027: formname - value of form element named "form".
15028:
15029: fixeddom - domain, if fixed.
15030:
15031: prevphase - value to assign to form element named "phase" when going back to the previous screen
15032:
15033: cnameelement - name of form element in form on opener page which will receive title of selected course
15034:
15035: cnumelement - name of form element in form on opener page which will receive courseID of selected course
15036:
15037: cdomelement - name of form element in form on opener page which will receive domain of selected course
15038:
15039: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
15040:
15041: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
15042:
15043: clonewarning - warning message about missing information for intended course owner when DC creates a course
15044:
15045:
15046: Returns: $output - HTML for display of search criteria, and hidden form elements.
15047:
15048:
15049: Side Effects: None
15050:
15051: =cut
15052:
15053: # ---------------------------------------------- search for courses based on last activity etc.
15054:
15055: sub build_filters {
15056: my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
15057: $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
15058: $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
15059: $cnameelement,$cnumelement,$cdomelement,$setroles,
15060: $clonetext,$clonewarning) = @_;
15061: my ($list,$jscript);
15062: my $onchange = 'javascript:updateFilters(this)';
15063: my ($domainselectform,$sincefilterform,$createdfilterform,
15064: $ownerdomselectform,$persondomselectform,$instcodeform,
15065: $typeselectform,$instcodetitle);
15066: if ($formname eq '') {
15067: $formname = $caller;
15068: }
15069: foreach my $item (@{$filterlist}) {
15070: unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
15071: ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
15072: if ($item eq 'domainfilter') {
15073: $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
15074: } elsif ($item eq 'coursefilter') {
15075: $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
15076: } elsif ($item eq 'ownerfilter') {
15077: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
15078: } elsif ($item eq 'ownerdomfilter') {
15079: $filter->{'ownerdomfilter'} =
15080: &LONCAPA::clean_domain($filter->{$item});
15081: $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
15082: 'ownerdomfilter',1);
15083: } elsif ($item eq 'personfilter') {
15084: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
15085: } elsif ($item eq 'persondomfilter') {
15086: $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
15087: 'persondomfilter',1);
15088: } else {
15089: $filter->{$item} =~ s/\W//g;
15090: }
15091: if (!$filter->{$item}) {
15092: $filter->{$item} = '';
15093: }
15094: }
15095: if ($item eq 'domainfilter') {
15096: my $allow_blank = 1;
15097: if ($formname eq 'portform') {
15098: $allow_blank=0;
15099: } elsif ($formname eq 'studentform') {
15100: $allow_blank=0;
15101: }
15102: if ($fixeddom) {
15103: $domainselectform = '<input type="hidden" name="domainfilter"'.
15104: ' value="'.$codedom.'" />'.
15105: &Apache::lonnet::domain($codedom,'description');
15106: } else {
15107: $domainselectform = &select_dom_form($filter->{$item},
15108: 'domainfilter',
15109: $allow_blank,'',$onchange);
15110: }
15111: } else {
15112: $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
15113: }
15114: }
15115:
15116: # last course activity filter and selection
15117: $sincefilterform = &timebased_select_form('sincefilter',$filter);
15118:
15119: # course created filter and selection
15120: if (exists($filter->{'createdfilter'})) {
15121: $createdfilterform = &timebased_select_form('createdfilter',$filter);
15122: }
15123:
15124: my %lt = &Apache::lonlocal::texthash(
15125: 'cac' => "$crstype Activity",
15126: 'ccr' => "$crstype Created",
15127: 'cde' => "$crstype Title",
15128: 'cdo' => "$crstype Domain",
15129: 'ins' => 'Institutional Code',
15130: 'inc' => 'Institutional Categorization',
15131: 'cow' => "$crstype Owner/Co-owner",
15132: 'cop' => "$crstype Personnel Includes",
15133: 'cog' => 'Type',
15134: );
15135:
15136: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
15137: my $typeval = 'Course';
15138: if ($crstype eq 'Community') {
15139: $typeval = 'Community';
15140: }
15141: $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
15142: } else {
15143: $typeselectform = '<select name="type" size="1"';
15144: if ($onchange) {
15145: $typeselectform .= ' onchange="'.$onchange.'"';
15146: }
15147: $typeselectform .= '>'."\n";
15148: foreach my $posstype ('Course','Community') {
15149: $typeselectform.='<option value="'.$posstype.'"'.
15150: ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".&mt($posstype)."</option>\n";
15151: }
15152: $typeselectform.="</select>";
15153: }
15154:
15155: my ($cloneableonlyform,$cloneabletitle);
15156: if (exists($filter->{'cloneableonly'})) {
15157: my $cloneableon = '';
15158: my $cloneableoff = ' checked="checked"';
15159: if ($filter->{'cloneableonly'}) {
15160: $cloneableon = $cloneableoff;
15161: $cloneableoff = '';
15162: }
15163: $cloneableonlyform = '<span class="LC_nobreak"><label><input type="radio" name="cloneableonly" value="1" '.$cloneableon.'/> '.&mt('Required').'</label>'.(' 'x3).'<label><input type="radio" name="cloneableonly" value="" '.$cloneableoff.' /> '.&mt('No restriction').'</label></span>';
15164: if ($formname eq 'ccrs') {
1.1075.2.71 raeburn 15165: $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1075.2.69 raeburn 15166: } else {
15167: $cloneabletitle = &mt('Cloneable by you');
15168: }
15169: }
15170: my $officialjs;
15171: if ($crstype eq 'Course') {
15172: if (exists($filter->{'instcodefilter'})) {
15173: # if (($fixeddom) || ($formname eq 'requestcrs') ||
15174: # ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
15175: if ($codedom) {
15176: $officialjs = 1;
15177: ($instcodeform,$jscript,$$numtitlesref) =
15178: &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
15179: $officialjs,$codetitlesref);
15180: if ($jscript) {
15181: $jscript = '<script type="text/javascript">'."\n".
15182: '// <![CDATA['."\n".
15183: $jscript."\n".
15184: '// ]]>'."\n".
15185: '</script>'."\n";
15186: }
15187: }
15188: if ($instcodeform eq '') {
15189: $instcodeform =
15190: '<input type="text" name="instcodefilter" size="10" value="'.
15191: $list->{'instcodefilter'}.'" />';
15192: $instcodetitle = $lt{'ins'};
15193: } else {
15194: $instcodetitle = $lt{'inc'};
15195: }
15196: if ($fixeddom) {
15197: $instcodetitle .= '<br />('.$codedom.')';
15198: }
15199: }
15200: }
15201: my $output = qq|
15202: <form method="post" name="filterpicker" action="$action">
15203: <input type="hidden" name="form" value="$formname" />
15204: |;
15205: if ($formname eq 'modifycourse') {
15206: $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
15207: '<input type="hidden" name="prevphase" value="'.
15208: $prevphase.'" />'."\n";
1.1075.2.82 raeburn 15209: } elsif ($formname eq 'quotacheck') {
15210: $output .= qq|
15211: <input type="hidden" name="sortby" value="" />
15212: <input type="hidden" name="sortorder" value="" />
15213: |;
15214: } else {
1.1075.2.69 raeburn 15215: my $name_input;
15216: if ($cnameelement ne '') {
15217: $name_input = '<input type="hidden" name="cnameelement" value="'.
15218: $cnameelement.'" />';
15219: }
15220: $output .= qq|
15221: <input type="hidden" name="cnumelement" value="$cnumelement" />
15222: <input type="hidden" name="cdomelement" value="$cdomelement" />
15223: $name_input
15224: $roleelement
15225: $multelement
15226: $typeelement
15227: |;
15228: if ($formname eq 'portform') {
15229: $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
15230: }
15231: }
15232: if ($fixeddom) {
15233: $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
15234: }
15235: $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
15236: if ($sincefilterform) {
15237: $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
15238: .$sincefilterform
15239: .&Apache::lonhtmlcommon::row_closure();
15240: }
15241: if ($createdfilterform) {
15242: $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
15243: .$createdfilterform
15244: .&Apache::lonhtmlcommon::row_closure();
15245: }
15246: if ($domainselectform) {
15247: $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
15248: .$domainselectform
15249: .&Apache::lonhtmlcommon::row_closure();
15250: }
15251: if ($typeselectform) {
15252: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
15253: $output .= $typeselectform;
15254: } else {
15255: $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
15256: .$typeselectform
15257: .&Apache::lonhtmlcommon::row_closure();
15258: }
15259: }
15260: if ($instcodeform) {
15261: $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
15262: .$instcodeform
15263: .&Apache::lonhtmlcommon::row_closure();
15264: }
15265: if (exists($filter->{'ownerfilter'})) {
15266: $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
15267: '<table><tr><td>'.&mt('Username').'<br />'.
15268: '<input type="text" name="ownerfilter" size="20" value="'.
15269: $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
15270: $ownerdomselectform.'</td></tr></table>'.
15271: &Apache::lonhtmlcommon::row_closure();
15272: }
15273: if (exists($filter->{'personfilter'})) {
15274: $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
15275: '<table><tr><td>'.&mt('Username').'<br />'.
15276: '<input type="text" name="personfilter" size="20" value="'.
15277: $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
15278: $persondomselectform.'</td></tr></table>'.
15279: &Apache::lonhtmlcommon::row_closure();
15280: }
15281: if (exists($filter->{'coursefilter'})) {
15282: $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
15283: .'<input type="text" name="coursefilter" size="25" value="'
15284: .$list->{'coursefilter'}.'" />'
15285: .&Apache::lonhtmlcommon::row_closure();
15286: }
15287: if ($cloneableonlyform) {
15288: $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
15289: $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
15290: }
15291: if (exists($filter->{'descriptfilter'})) {
15292: $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
15293: .'<input type="text" name="descriptfilter" size="40" value="'
15294: .$list->{'descriptfilter'}.'" />'
15295: .&Apache::lonhtmlcommon::row_closure(1);
15296: }
15297: $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
15298: '<input type="hidden" name="updater" value="" />'."\n".
15299: '<input type="submit" name="gosearch" value="'.
15300: &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
15301: return $jscript.$clonewarning.$output;
15302: }
15303:
15304: =pod
15305:
15306: =item * &timebased_select_form()
15307:
15308: Create markup for a dropdown list used to select a time-based
15309: filter e.g., Course Activity, Course Created, when searching for courses
15310: or communities
15311:
15312: Inputs:
15313:
15314: item - name of form element (sincefilter or createdfilter)
15315:
15316: filter - anonymous hash of criteria and their values
15317:
15318: Returns: HTML for a select box contained a blank, then six time selections,
15319: with value set in incoming form variables currently selected.
15320:
15321: Side Effects: None
15322:
15323: =cut
15324:
15325: sub timebased_select_form {
15326: my ($item,$filter) = @_;
15327: if (ref($filter) eq 'HASH') {
15328: $filter->{$item} =~ s/[^\d-]//g;
15329: if (!$filter->{$item}) { $filter->{$item}=-1; }
15330: return &select_form(
15331: $filter->{$item},
15332: $item,
15333: { '-1' => '',
15334: '86400' => &mt('today'),
15335: '604800' => &mt('last week'),
15336: '2592000' => &mt('last month'),
15337: '7776000' => &mt('last three months'),
15338: '15552000' => &mt('last six months'),
15339: '31104000' => &mt('last year'),
15340: 'select_form_order' =>
15341: ['-1','86400','604800','2592000','7776000',
15342: '15552000','31104000']});
15343: }
15344: }
15345:
15346: =pod
15347:
15348: =item * &js_changer()
15349:
15350: Create script tag containing Javascript used to submit course search form
15351: when course type or domain is changed, and also to hide 'Searching ...' on
15352: page load completion for page showing search result.
15353:
15354: Inputs: None
15355:
15356: Returns: markup containing updateFilters() and hideSearching() javascript functions.
15357:
15358: Side Effects: None
15359:
15360: =cut
15361:
15362: sub js_changer {
15363: return <<ENDJS;
15364: <script type="text/javascript">
15365: // <![CDATA[
15366: function updateFilters(caller) {
15367: if (typeof(caller) != "undefined") {
15368: document.filterpicker.updater.value = caller.name;
15369: }
15370: document.filterpicker.submit();
15371: }
15372:
15373: function hideSearching() {
15374: if (document.getElementById('searching')) {
15375: document.getElementById('searching').style.display = 'none';
15376: }
15377: return;
15378: }
15379:
15380: // ]]>
15381: </script>
15382:
15383: ENDJS
15384: }
15385:
15386: =pod
15387:
15388: =item * &search_courses()
15389:
15390: Process selected filters form course search form and pass to lonnet::courseiddump
15391: to retrieve a hash for which keys are courseIDs which match the selected filters.
15392:
15393: Inputs:
15394:
15395: dom - domain being searched
15396:
15397: type - course type ('Course' or 'Community' or '.' if any).
15398:
15399: filter - anonymous hash of criteria and their values
15400:
15401: numtitles - for institutional codes - number of categories
15402:
15403: cloneruname - optional username of new course owner
15404:
15405: clonerudom - optional domain of new course owner
15406:
1.1075.2.95 raeburn 15407: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
1.1075.2.69 raeburn 15408: (used when DC is using course creation form)
15409:
15410: codetitles - reference to array of titles of components in institutional codes (official courses).
15411:
1.1075.2.95 raeburn 15412: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
15413: (and so can clone automatically)
15414:
15415: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
15416:
15417: reqinstcode - institutional code of new course, where search_courses is used to identify potential
15418: courses to clone
1.1075.2.69 raeburn 15419:
15420: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
15421:
15422:
15423: Side Effects: None
15424:
15425: =cut
15426:
15427:
15428: sub search_courses {
1.1075.2.95 raeburn 15429: my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
15430: $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1075.2.69 raeburn 15431: my (%courses,%showcourses,$cloner);
15432: if (($filter->{'ownerfilter'} ne '') ||
15433: ($filter->{'ownerdomfilter'} ne '')) {
15434: $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
15435: $filter->{'ownerdomfilter'};
15436: }
15437: foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
15438: if (!$filter->{$item}) {
15439: $filter->{$item}='.';
15440: }
15441: }
15442: my $now = time;
15443: my $timefilter =
15444: ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
15445: my ($createdbefore,$createdafter);
15446: if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
15447: $createdbefore = $now;
15448: $createdafter = $now-$filter->{'createdfilter'};
15449: }
15450: my ($instcodefilter,$regexpok);
15451: if ($numtitles) {
15452: if ($env{'form.official'} eq 'on') {
15453: $instcodefilter =
15454: &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
15455: $regexpok = 1;
15456: } elsif ($env{'form.official'} eq 'off') {
15457: $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
15458: unless ($instcodefilter eq '') {
15459: $regexpok = -1;
15460: }
15461: }
15462: } else {
15463: $instcodefilter = $filter->{'instcodefilter'};
15464: }
15465: if ($instcodefilter eq '') { $instcodefilter = '.'; }
15466: if ($type eq '') { $type = '.'; }
15467:
15468: if (($clonerudom ne '') && ($cloneruname ne '')) {
15469: $cloner = $cloneruname.':'.$clonerudom;
15470: }
15471: %courses = &Apache::lonnet::courseiddump($dom,
15472: $filter->{'descriptfilter'},
15473: $timefilter,
15474: $instcodefilter,
15475: $filter->{'combownerfilter'},
15476: $filter->{'coursefilter'},
15477: undef,undef,$type,$regexpok,undef,undef,
1.1075.2.95 raeburn 15478: undef,undef,$cloner,$cc_clone,
1.1075.2.69 raeburn 15479: $filter->{'cloneableonly'},
15480: $createdbefore,$createdafter,undef,
1.1075.2.95 raeburn 15481: $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1075.2.69 raeburn 15482: if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
15483: my $ccrole;
15484: if ($type eq 'Community') {
15485: $ccrole = 'co';
15486: } else {
15487: $ccrole = 'cc';
15488: }
15489: my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
15490: $filter->{'persondomfilter'},
15491: 'userroles',undef,
15492: [$ccrole,'in','ad','ep','ta','cr'],
15493: $dom);
15494: foreach my $role (keys(%rolehash)) {
15495: my ($cnum,$cdom,$courserole) = split(':',$role);
15496: my $cid = $cdom.'_'.$cnum;
15497: if (exists($courses{$cid})) {
15498: if (ref($courses{$cid}) eq 'HASH') {
15499: if (ref($courses{$cid}{roles}) eq 'ARRAY') {
15500: if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
15501: push (@{$courses{$cid}{roles}},$courserole);
15502: }
15503: } else {
15504: $courses{$cid}{roles} = [$courserole];
15505: }
15506: $showcourses{$cid} = $courses{$cid};
15507: }
15508: }
15509: }
15510: %courses = %showcourses;
15511: }
15512: return %courses;
15513: }
15514:
15515: =pod
15516:
15517: =back
15518:
1.1075.2.88 raeburn 15519: =head1 Routines for version requirements for current course.
15520:
15521: =over 4
15522:
15523: =item * &check_release_required()
15524:
15525: Compares required LON-CAPA version with version on server, and
15526: if required version is newer looks for a server with the required version.
15527:
15528: Looks first at servers in user's owen domain; if none suitable, looks at
15529: servers in course's domain are permitted to host sessions for user's domain.
15530:
15531: Inputs:
15532:
15533: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
15534:
15535: $courseid - Course ID of current course
15536:
15537: $rolecode - User's current role in course (for switchserver query string).
15538:
15539: $required - LON-CAPA version needed by course (format: Major.Minor).
15540:
15541:
15542: Returns:
15543:
15544: $switchserver - query string tp append to /adm/switchserver call (if
15545: current server's LON-CAPA version is too old.
15546:
15547: $warning - Message is displayed if no suitable server could be found.
15548:
15549: =cut
15550:
15551: sub check_release_required {
15552: my ($loncaparev,$courseid,$rolecode,$required) = @_;
15553: my ($switchserver,$warning);
15554: if ($required ne '') {
15555: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
15556: my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
15557: if ($reqdmajor ne '' && $reqdminor ne '') {
15558: my $otherserver;
15559: if (($major eq '' && $minor eq '') ||
15560: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
15561: my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
15562: my $switchlcrev =
15563: &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
15564: $userdomserver);
15565: my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
15566: if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
15567: (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
15568: my $cdom = $env{'course.'.$courseid.'.domain'};
15569: if ($cdom ne $env{'user.domain'}) {
15570: my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
15571: my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
15572: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
15573: my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
15574: my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
15575: my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
15576: my $canhost =
15577: &Apache::lonnet::can_host_session($env{'user.domain'},
15578: $coursedomserver,
15579: $remoterev,
15580: $udomdefaults{'remotesessions'},
15581: $defdomdefaults{'hostedsessions'});
15582:
15583: if ($canhost) {
15584: $otherserver = $coursedomserver;
15585: } else {
15586: $warning = &mt('Requires LON-CAPA version [_1].',$env{'course.'.$courseid.'.internal.releaserequired'}).'<br />'. &mt("No suitable server could be found amongst servers in either your own domain or in the course's domain.");
15587: }
15588: } else {
15589: $warning = &mt('Requires LON-CAPA version [_1].',$env{'course.'.$courseid.'.internal.releaserequired'}).'<br />'.&mt("No suitable server could be found amongst servers in your own domain (which is also the course's domain).");
15590: }
15591: } else {
15592: $otherserver = $userdomserver;
15593: }
15594: }
15595: if ($otherserver ne '') {
15596: $switchserver = 'otherserver='.$otherserver.'&role='.$rolecode;
15597: }
15598: }
15599: }
15600: return ($switchserver,$warning);
15601: }
15602:
15603: =pod
15604:
15605: =item * &check_release_result()
15606:
15607: Inputs:
15608:
15609: $switchwarning - Warning message if no suitable server found to host session.
15610:
15611: $switchserver - query string to append to /adm/switchserver containing lonHostID
15612: and current role.
15613:
15614: Returns: HTML to display with information about requirement to switch server.
15615: Either displaying warning with link to Roles/Courses screen or
15616: display link to switchserver.
15617:
1.1075.2.69 raeburn 15618: =cut
15619:
1.1075.2.88 raeburn 15620: sub check_release_result {
15621: my ($switchwarning,$switchserver) = @_;
15622: my $output = &start_page('Selected course unavailable on this server').
15623: '<p class="LC_warning">';
15624: if ($switchwarning) {
15625: $output .= $switchwarning.'<br /><a href="/adm/roles">';
15626: if (&show_course()) {
15627: $output .= &mt('Display courses');
15628: } else {
15629: $output .= &mt('Display roles');
15630: }
15631: $output .= '</a>';
15632: } elsif ($switchserver) {
15633: $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
15634: '<br />'.
15635: '<a href="/adm/switchserver?'.$switchserver.'">'.
15636: &mt('Switch Server').
15637: '</a>';
15638: }
15639: $output .= '</p>'.&end_page();
15640: return $output;
15641: }
15642:
15643: =pod
15644:
15645: =item * &needs_coursereinit()
15646:
15647: Determine if course contents stored for user's session needs to be
15648: refreshed, because content has changed since "Big Hash" last tied.
15649:
15650: Check for change is made if time last checked is more than 10 minutes ago
15651: (by default).
15652:
15653: Inputs:
15654:
15655: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
15656:
15657: $interval (optional) - Time which may elapse (in s) between last check for content
15658: change in current course. (default: 600 s).
15659:
15660: Returns: an array; first element is:
15661:
15662: =over 4
15663:
15664: 'switch' - if content updates mean user's session
15665: needs to be switched to a server running a newer LON-CAPA version
15666:
15667: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
15668: on current server hosting user's session
15669:
15670: '' - if no action required.
15671:
15672: =back
15673:
15674: If first item element is 'switch':
15675:
15676: second item is $switchwarning - Warning message if no suitable server found to host session.
15677:
15678: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
15679: and current role.
15680:
15681: otherwise: no other elements returned.
15682:
15683: =back
15684:
15685: =cut
15686:
15687: sub needs_coursereinit {
15688: my ($loncaparev,$interval) = @_;
15689: return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
15690: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
15691: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
15692: my $now = time;
15693: if ($interval eq '') {
15694: $interval = 600;
15695: }
15696: if (($now-$env{'request.course.timechecked'})>$interval) {
15697: my $lastchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
15698: &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
15699: if ($lastchange > $env{'request.course.tied'}) {
15700: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
15701: if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
15702: my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
15703: if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
15704: &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
15705: $curr_reqd_hash{'internal.releaserequired'}});
15706: my ($switchserver,$switchwarning) =
15707: &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
15708: $curr_reqd_hash{'internal.releaserequired'});
15709: if ($switchwarning ne '' || $switchserver ne '') {
15710: return ('switch',$switchwarning,$switchserver);
15711: }
15712: }
15713: }
15714: return ('update');
15715: }
15716: }
15717: return ();
15718: }
1.1075.2.69 raeburn 15719:
1.1075.2.11 raeburn 15720: sub update_content_constraints {
15721: my ($cdom,$cnum,$chome,$cid) = @_;
15722: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
15723: my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
15724: my %checkresponsetypes;
15725: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
15726: my ($item,$name,$value) = split(/:/,$key);
15727: if ($item eq 'resourcetag') {
15728: if ($name eq 'responsetype') {
15729: $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
15730: }
15731: }
15732: }
15733: my $navmap = Apache::lonnavmaps::navmap->new();
15734: if (defined($navmap)) {
15735: my %allresponses;
15736: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() },1,0)) {
15737: my %responses = $res->responseTypes();
15738: foreach my $key (keys(%responses)) {
15739: next unless(exists($checkresponsetypes{$key}));
15740: $allresponses{$key} += $responses{$key};
15741: }
15742: }
15743: foreach my $key (keys(%allresponses)) {
15744: my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
15745: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
15746: ($reqdmajor,$reqdminor) = ($major,$minor);
15747: }
15748: }
15749: undef($navmap);
15750: }
15751: unless (($reqdmajor eq '') && ($reqdminor eq '')) {
15752: &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
15753: }
15754: return;
15755: }
15756:
1.1075.2.27 raeburn 15757: sub allmaps_incourse {
15758: my ($cdom,$cnum,$chome,$cid) = @_;
15759: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
15760: $cid = $env{'request.course.id'};
15761: $cdom = $env{'course.'.$cid.'.domain'};
15762: $cnum = $env{'course.'.$cid.'.num'};
15763: $chome = $env{'course.'.$cid.'.home'};
15764: }
15765: my %allmaps = ();
15766: my $lastchange =
15767: &Apache::lonnet::get_coursechange($cdom,$cnum);
15768: if ($lastchange > $env{'request.course.tied'}) {
15769: my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
15770: unless ($ferr) {
15771: &update_content_constraints($cdom,$cnum,$chome,$cid);
15772: }
15773: }
15774: my $navmap = Apache::lonnavmaps::navmap->new();
15775: if (defined($navmap)) {
15776: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
15777: $allmaps{$res->src()} = 1;
15778: }
15779: }
15780: return \%allmaps;
15781: }
15782:
1.1075.2.11 raeburn 15783: sub parse_supplemental_title {
15784: my ($title) = @_;
15785:
15786: my ($foldertitle,$renametitle);
15787: if ($title =~ /&&&/) {
15788: $title = &HTML::Entites::decode($title);
15789: }
15790: if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
15791: $renametitle=$4;
15792: my ($time,$uname,$udom) = ($1,$2,$3);
15793: $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
15794: my $name = &plainname($uname,$udom);
15795: $name = &HTML::Entities::encode($name,'"<>&\'');
15796: $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
15797: $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.
15798: $name.': <br />'.$foldertitle;
15799: }
15800: if (wantarray) {
15801: return ($title,$foldertitle,$renametitle);
15802: }
15803: return $title;
15804: }
15805:
1.1075.2.43 raeburn 15806: sub recurse_supplemental {
15807: my ($cnum,$cdom,$suppmap,$numfiles,$errors) = @_;
15808: if ($suppmap) {
15809: my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
15810: if ($fatal) {
15811: $errors ++;
15812: } else {
15813: if ($#LONCAPA::map::resources > 0) {
15814: foreach my $res (@LONCAPA::map::resources) {
15815: my ($title,$src,$ext,$type,$status)=split(/\:/,$res);
15816: if (($src ne '') && ($status eq 'res')) {
1.1075.2.46 raeburn 15817: if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
15818: ($numfiles,$errors) = &recurse_supplemental($cnum,$cdom,$1,$numfiles,$errors);
1.1075.2.43 raeburn 15819: } else {
15820: $numfiles ++;
15821: }
15822: }
15823: }
15824: }
15825: }
15826: }
15827: return ($numfiles,$errors);
15828: }
15829:
1.1075.2.18 raeburn 15830: sub symb_to_docspath {
15831: my ($symb) = @_;
15832: return unless ($symb);
15833: my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
15834: if ($resurl=~/\.(sequence|page)$/) {
15835: $mapurl=$resurl;
15836: } elsif ($resurl eq 'adm/navmaps') {
15837: $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
15838: }
15839: my $mapresobj;
15840: my $navmap = Apache::lonnavmaps::navmap->new();
15841: if (ref($navmap)) {
15842: $mapresobj = $navmap->getResourceByUrl($mapurl);
15843: }
15844: $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
15845: my $type=$2;
15846: my $path;
15847: if (ref($mapresobj)) {
15848: my $pcslist = $mapresobj->map_hierarchy();
15849: if ($pcslist ne '') {
15850: foreach my $pc (split(/,/,$pcslist)) {
15851: next if ($pc <= 1);
15852: my $res = $navmap->getByMapPc($pc);
15853: if (ref($res)) {
15854: my $thisurl = $res->src();
15855: $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
15856: my $thistitle = $res->title();
15857: $path .= '&'.
15858: &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1075.2.46 raeburn 15859: &escape($thistitle).
1.1075.2.18 raeburn 15860: ':'.$res->randompick().
15861: ':'.$res->randomout().
15862: ':'.$res->encrypted().
15863: ':'.$res->randomorder().
15864: ':'.$res->is_page();
15865: }
15866: }
15867: }
15868: $path =~ s/^\&//;
15869: my $maptitle = $mapresobj->title();
15870: if ($mapurl eq 'default') {
1.1075.2.38 raeburn 15871: $maptitle = 'Main Content';
1.1075.2.18 raeburn 15872: }
15873: $path .= (($path ne '')? '&' : '').
15874: &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1075.2.46 raeburn 15875: &escape($maptitle).
1.1075.2.18 raeburn 15876: ':'.$mapresobj->randompick().
15877: ':'.$mapresobj->randomout().
15878: ':'.$mapresobj->encrypted().
15879: ':'.$mapresobj->randomorder().
15880: ':'.$mapresobj->is_page();
15881: } else {
15882: my $maptitle = &Apache::lonnet::gettitle($mapurl);
15883: my $ispage = (($type eq 'page')? 1 : '');
15884: if ($mapurl eq 'default') {
1.1075.2.38 raeburn 15885: $maptitle = 'Main Content';
1.1075.2.18 raeburn 15886: }
15887: $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1075.2.46 raeburn 15888: &escape($maptitle).':::::'.$ispage;
1.1075.2.18 raeburn 15889: }
15890: unless ($mapurl eq 'default') {
15891: $path = 'default&'.
1.1075.2.46 raeburn 15892: &escape('Main Content').
1.1075.2.18 raeburn 15893: ':::::&'.$path;
15894: }
15895: return $path;
15896: }
15897:
1.1075.2.14 raeburn 15898: sub captcha_display {
15899: my ($context,$lonhost) = @_;
15900: my ($output,$error);
15901: my ($captcha,$pubkey,$privkey) = &get_captcha_config($context,$lonhost);
15902: if ($captcha eq 'original') {
15903: $output = &create_captcha();
15904: unless ($output) {
15905: $error = 'captcha';
15906: }
15907: } elsif ($captcha eq 'recaptcha') {
15908: $output = &create_recaptcha($pubkey);
15909: unless ($output) {
15910: $error = 'recaptcha';
15911: }
15912: }
1.1075.2.66 raeburn 15913: return ($output,$error,$captcha);
1.1075.2.14 raeburn 15914: }
15915:
15916: sub captcha_response {
15917: my ($context,$lonhost) = @_;
15918: my ($captcha_chk,$captcha_error);
15919: my ($captcha,$pubkey,$privkey) = &get_captcha_config($context,$lonhost);
15920: if ($captcha eq 'original') {
15921: ($captcha_chk,$captcha_error) = &check_captcha();
15922: } elsif ($captcha eq 'recaptcha') {
15923: $captcha_chk = &check_recaptcha($privkey);
15924: } else {
15925: $captcha_chk = 1;
15926: }
15927: return ($captcha_chk,$captcha_error);
15928: }
15929:
15930: sub get_captcha_config {
15931: my ($context,$lonhost) = @_;
15932: my ($captcha,$pubkey,$privkey,$hashtocheck);
15933: my $hostname = &Apache::lonnet::hostname($lonhost);
15934: my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
15935: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
15936: if ($context eq 'usercreation') {
15937: my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
15938: if (ref($domconfig{$context}) eq 'HASH') {
15939: $hashtocheck = $domconfig{$context}{'cancreate'};
15940: if (ref($hashtocheck) eq 'HASH') {
15941: if ($hashtocheck->{'captcha'} eq 'recaptcha') {
15942: if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
15943: $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
15944: $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
15945: }
15946: if ($privkey && $pubkey) {
15947: $captcha = 'recaptcha';
15948: } else {
15949: $captcha = 'original';
15950: }
15951: } elsif ($hashtocheck->{'captcha'} ne 'notused') {
15952: $captcha = 'original';
15953: }
15954: }
15955: } else {
15956: $captcha = 'captcha';
15957: }
15958: } elsif ($context eq 'login') {
15959: my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
15960: if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
15961: $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
15962: $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
15963: if ($privkey && $pubkey) {
15964: $captcha = 'recaptcha';
15965: } else {
15966: $captcha = 'original';
15967: }
15968: } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
15969: $captcha = 'original';
15970: }
15971: }
15972: return ($captcha,$pubkey,$privkey);
15973: }
15974:
15975: sub create_captcha {
15976: my %captcha_params = &captcha_settings();
15977: my ($output,$maxtries,$tries) = ('',10,0);
15978: while ($tries < $maxtries) {
15979: $tries ++;
15980: my $captcha = Authen::Captcha->new (
15981: output_folder => $captcha_params{'output_dir'},
15982: data_folder => $captcha_params{'db_dir'},
15983: );
15984: my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
15985:
15986: if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
15987: $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
15988: &mt('Type in the letters/numbers shown below').' '.
1.1075.2.66 raeburn 15989: '<input type="text" size="5" name="code" value="" autocomplete="off" />'.
15990: '<br />'.
15991: '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1075.2.14 raeburn 15992: last;
15993: }
15994: }
15995: return $output;
15996: }
15997:
15998: sub captcha_settings {
15999: my %captcha_params = (
16000: output_dir => $Apache::lonnet::perlvar{'lonCaptchaDir'},
16001: www_output_dir => "/captchaspool",
16002: db_dir => $Apache::lonnet::perlvar{'lonCaptchaDb'},
16003: numchars => '5',
16004: );
16005: return %captcha_params;
16006: }
16007:
16008: sub check_captcha {
16009: my ($captcha_chk,$captcha_error);
16010: my $code = $env{'form.code'};
16011: my $md5sum = $env{'form.crypt'};
16012: my %captcha_params = &captcha_settings();
16013: my $captcha = Authen::Captcha->new(
16014: output_folder => $captcha_params{'output_dir'},
16015: data_folder => $captcha_params{'db_dir'},
16016: );
1.1075.2.26 raeburn 16017: $captcha_chk = $captcha->check_code($code,$md5sum);
1.1075.2.14 raeburn 16018: my %captcha_hash = (
16019: 0 => 'Code not checked (file error)',
16020: -1 => 'Failed: code expired',
16021: -2 => 'Failed: invalid code (not in database)',
16022: -3 => 'Failed: invalid code (code does not match crypt)',
16023: );
16024: if ($captcha_chk != 1) {
16025: $captcha_error = $captcha_hash{$captcha_chk}
16026: }
16027: return ($captcha_chk,$captcha_error);
16028: }
16029:
16030: sub create_recaptcha {
16031: my ($pubkey) = @_;
1.1075.2.51 raeburn 16032: my $use_ssl;
16033: if ($ENV{'SERVER_PORT'} == 443) {
16034: $use_ssl = 1;
16035: }
1.1075.2.14 raeburn 16036: my $captcha = Captcha::reCAPTCHA->new;
16037: return $captcha->get_options_setter({theme => 'white'})."\n".
1.1075.2.51 raeburn 16038: $captcha->get_html($pubkey,undef,$use_ssl).
1.1075.2.92 raeburn 16039: &mt('If the text is hard to read, [_1] will replace them.',
1.1075.2.39 raeburn 16040: '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
1.1075.2.14 raeburn 16041: '<br /><br />';
16042: }
16043:
16044: sub check_recaptcha {
16045: my ($privkey) = @_;
16046: my $captcha_chk;
16047: my $captcha = Captcha::reCAPTCHA->new;
16048: my $captcha_result =
16049: $captcha->check_answer(
16050: $privkey,
16051: $ENV{'REMOTE_ADDR'},
16052: $env{'form.recaptcha_challenge_field'},
16053: $env{'form.recaptcha_response_field'},
16054: );
16055: if ($captcha_result->{is_valid}) {
16056: $captcha_chk = 1;
16057: }
16058: return $captcha_chk;
16059: }
16060:
1.1075.2.64 raeburn 16061: sub emailusername_info {
1.1075.2.67 raeburn 16062: my @fields = ('firstname','lastname','institution','web','location','officialemail');
1.1075.2.64 raeburn 16063: my %titles = &Apache::lonlocal::texthash (
16064: lastname => 'Last Name',
16065: firstname => 'First Name',
16066: institution => 'School/college/university',
16067: location => "School's city, state/province, country",
16068: web => "School's web address",
16069: officialemail => 'E-mail address at institution (if different)',
16070: );
16071: return (\@fields,\%titles);
16072: }
16073:
1.1075.2.56 raeburn 16074: sub cleanup_html {
16075: my ($incoming) = @_;
16076: my $outgoing;
16077: if ($incoming ne '') {
16078: $outgoing = $incoming;
16079: $outgoing =~ s/;/;/g;
16080: $outgoing =~ s/\#/#/g;
16081: $outgoing =~ s/\&/&/g;
16082: $outgoing =~ s/</</g;
16083: $outgoing =~ s/>/>/g;
16084: $outgoing =~ s/\(/(/g;
16085: $outgoing =~ s/\)/)/g;
16086: $outgoing =~ s/"/"/g;
16087: $outgoing =~ s/'/'/g;
16088: $outgoing =~ s/\$/$/g;
16089: $outgoing =~ s{/}{/}g;
16090: $outgoing =~ s/=/=/g;
16091: $outgoing =~ s/\\/\/g
16092: }
16093: return $outgoing;
16094: }
16095:
1.1075.2.74 raeburn 16096: # Checks for critical messages and returns a redirect url if one exists.
16097: # $interval indicates how often to check for messages.
16098: sub critical_redirect {
16099: my ($interval) = @_;
16100: if ((time-$env{'user.criticalcheck.time'})>$interval) {
16101: my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
16102: $env{'user.name'});
16103: &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
16104: my $redirecturl;
16105: if ($what[0]) {
16106: if (($what[0] ne 'con_lost') && ($what[0]!~/^error\:/)) {
16107: $redirecturl='/adm/email?critical=display';
16108: my $url=&Apache::lonnet::absolute_url().$redirecturl;
16109: return (1, $url);
16110: }
16111: }
16112: }
16113: return ();
16114: }
16115:
1.1075.2.64 raeburn 16116: # Use:
16117: # my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
16118: #
16119: ##################################################
16120: # password associated functions #
16121: ##################################################
16122: sub des_keys {
16123: # Make a new key for DES encryption.
16124: # Each key has two parts which are returned separately.
16125: # Please note: Each key must be passed through the &hex function
16126: # before it is output to the web browser. The hex versions cannot
16127: # be used to decrypt.
16128: my @hexstr=('0','1','2','3','4','5','6','7',
16129: '8','9','a','b','c','d','e','f');
16130: my $lkey='';
16131: for (0..7) {
16132: $lkey.=$hexstr[rand(15)];
16133: }
16134: my $ukey='';
16135: for (0..7) {
16136: $ukey.=$hexstr[rand(15)];
16137: }
16138: return ($lkey,$ukey);
16139: }
16140:
16141: sub des_decrypt {
16142: my ($key,$cyphertext) = @_;
16143: my $keybin=pack("H16",$key);
16144: my $cypher;
16145: if ($Crypt::DES::VERSION>=2.03) {
16146: $cypher=new Crypt::DES $keybin;
16147: } else {
16148: $cypher=new DES $keybin;
16149: }
16150: my $plaintext=
16151: $cypher->decrypt(unpack("a8",pack("H16",substr($cyphertext,0,16))));
16152: $plaintext.=
16153: $cypher->decrypt(unpack("a8",pack("H16",substr($cyphertext,16,16))));
16154: $plaintext=substr($plaintext,1,ord(substr($plaintext,0,1)) );
16155: return $plaintext;
16156: }
16157:
1.112 bowersj2 16158: 1;
16159: __END__;
1.41 ng 16160:
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