Annotation of loncom/interface/loncommon.pm, revision 1.1207
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1207 ! raeburn 4: # $Id: loncommon.pm,v 1.1206 2015/02/25 19:22:24 raeburn Exp $
1.10 albertel 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.1 albertel 28:
29: # Makes a table out of the previous attempts
1.2 albertel 30: # Inputs result_from_symbread, user, domain, course_id
1.16 harris41 31: # Reads in non-network-related .tab files
1.1 albertel 32:
1.35 matthew 33: # POD header:
34:
1.45 matthew 35: =pod
36:
1.35 matthew 37: =head1 NAME
38:
39: Apache::loncommon - pile of common routines
40:
41: =head1 SYNOPSIS
42:
1.112 bowersj2 43: Common routines for manipulating connections, student answers,
44: domains, common Javascript fragments, etc.
1.35 matthew 45:
1.112 bowersj2 46: =head1 OVERVIEW
1.35 matthew 47:
1.112 bowersj2 48: A collection of commonly used subroutines that don't have a natural
49: home anywhere else. This collection helps remove
1.35 matthew 50: redundancy from other modules and increase efficiency of memory usage.
51:
52: =cut
53:
54: # End of POD header
1.1 albertel 55: package Apache::loncommon;
56:
57: use strict;
1.258 albertel 58: use Apache::lonnet;
1.46 matthew 59: use GDBM_File;
1.51 www 60: use POSIX qw(strftime mktime);
1.82 www 61: use Apache::lonmenu();
1.498 albertel 62: use Apache::lonenc();
1.117 www 63: use Apache::lonlocal;
1.685 tempelho 64: use Apache::lonnet();
1.139 matthew 65: use HTML::Entities;
1.334 albertel 66: use Apache::lonhtmlcommon();
67: use Apache::loncoursedata();
1.344 albertel 68: use Apache::lontexconvert();
1.444 albertel 69: use Apache::lonclonecourse();
1.1108 raeburn 70: use Apache::lonuserutils();
1.1110 raeburn 71: use Apache::lonuserstate();
1.1182 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.1091 foxr 76: use Text::Aspell;
1.1094 raeburn 77: use Authen::Captcha;
78: use Captcha::reCAPTCHA;
1.1174 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.1088 foxr 165: my %supported_codes;
1.1048 foxr 166: my %latex_language; # For choosing hyphenation in <transl..>
167: my %latex_language_bykey; # for choosing hyphenation from metadata
1.12 harris41 168: my %cprtag;
1.192 taceyjo1 169: my %scprtag;
1.351 www 170: my %fe; my %fd; my %fm;
1.41 ng 171: my %category_extensions;
1.12 harris41 172:
1.46 matthew 173: # ---------------------------------------------- Thesaurus variables
1.144 matthew 174: #
175: # %Keywords:
176: # A hash used by &keyword to determine if a word is considered a keyword.
177: # $thesaurus_db_file
178: # Scalar containing the full path to the thesaurus database.
1.46 matthew 179:
180: my %Keywords;
181: my $thesaurus_db_file;
182:
1.144 matthew 183: #
184: # Initialize values from language.tab, copyright.tab, filetypes.tab,
185: # thesaurus.tab, and filecategories.tab.
186: #
1.18 www 187: BEGIN {
1.46 matthew 188: # Variable initialization
189: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
190: #
1.22 www 191: unless ($readit) {
1.12 harris41 192: # ------------------------------------------------------------------- languages
193: {
1.158 raeburn 194: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
195: '/language.tab';
196: if ( open(my $fh,"<$langtabfile") ) {
1.356 albertel 197: while (my $line = <$fh>) {
198: next if ($line=~/^\#/);
199: chomp($line);
1.1088 foxr 200: my ($key,$code,$country,$three,$enc,$val,$sup,$latex)=(split(/\t/,$line));
1.158 raeburn 201: $language{$key}=$val.' - '.$enc;
202: if ($sup) {
203: $supported_language{$key}=$sup;
1.1088 foxr 204: $supported_codes{$key} = $code;
1.158 raeburn 205: }
1.1048 foxr 206: if ($latex) {
207: $latex_language_bykey{$key} = $latex;
1.1088 foxr 208: $latex_language{$code} = $latex;
1.1048 foxr 209: }
1.158 raeburn 210: }
211: close($fh);
212: }
1.12 harris41 213: }
214: # ------------------------------------------------------------------ copyrights
215: {
1.158 raeburn 216: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
217: '/copyright.tab';
218: if ( open (my $fh,"<$copyrightfile") ) {
1.356 albertel 219: while (my $line = <$fh>) {
220: next if ($line=~/^\#/);
221: chomp($line);
222: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 223: $cprtag{$key}=$val;
224: }
225: close($fh);
226: }
1.12 harris41 227: }
1.351 www 228: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 229: {
230: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
231: '/source_copyright.tab';
232: if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356 albertel 233: while (my $line = <$fh>) {
234: next if ($line =~ /^\#/);
235: chomp($line);
236: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 237: $scprtag{$key}=$val;
238: }
239: close($fh);
240: }
241: }
1.63 www 242:
1.517 raeburn 243: # -------------------------------------------------------------- default domain designs
1.63 www 244: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 245: my $designfile = $designdir.'/default.tab';
246: if ( open (my $fh,"<$designfile") ) {
247: while (my $line = <$fh>) {
248: next if ($line =~ /^\#/);
249: chomp($line);
250: my ($key,$val)=(split(/\=/,$line));
251: if ($val) { $defaultdesign{$key}=$val; }
252: }
253: close($fh);
1.63 www 254: }
255:
1.15 harris41 256: # ------------------------------------------------------------- file categories
257: {
1.158 raeburn 258: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
259: '/filecategories.tab';
260: if ( open (my $fh,"<$categoryfile") ) {
1.356 albertel 261: while (my $line = <$fh>) {
262: next if ($line =~ /^\#/);
263: chomp($line);
264: my ($extension,$category)=(split(/\s+/,$line,2));
1.158 raeburn 265: push @{$category_extensions{lc($category)}},$extension;
266: }
267: close($fh);
268: }
269:
1.15 harris41 270: }
1.12 harris41 271: # ------------------------------------------------------------------ file types
272: {
1.158 raeburn 273: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
274: '/filetypes.tab';
275: if ( open (my $fh,"<$typesfile") ) {
1.356 albertel 276: while (my $line = <$fh>) {
277: next if ($line =~ /^\#/);
278: chomp($line);
279: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 280: if ($descr ne '') {
281: $fe{$ending}=lc($emb);
282: $fd{$ending}=$descr;
1.351 www 283: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 284: }
285: }
286: close($fh);
287: }
1.12 harris41 288: }
1.22 www 289: &Apache::lonnet::logthis(
1.705 tempelho 290: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 291: $readit=1;
1.46 matthew 292: } # end of unless($readit)
1.32 matthew 293:
294: }
1.112 bowersj2 295:
1.42 matthew 296: ###############################################################
297: ## HTML and Javascript Helper Functions ##
298: ###############################################################
299:
300: =pod
301:
1.112 bowersj2 302: =head1 HTML and Javascript Functions
1.42 matthew 303:
1.112 bowersj2 304: =over 4
305:
1.648 raeburn 306: =item * &browser_and_searcher_javascript()
1.112 bowersj2 307:
308: X<browsing, javascript>X<searching, javascript>Returns a string
309: containing javascript with two functions, C<openbrowser> and
310: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
311: tags.
1.42 matthew 312:
1.648 raeburn 313: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 314:
315: inputs: formname, elementname, only, omit
316:
317: formname and elementname indicate the name of the html form and name of
318: the element that the results of the browsing selection are to be placed in.
319:
320: Specifying 'only' will restrict the browser to displaying only files
1.185 www 321: with the given extension. Can be a comma separated list.
1.42 matthew 322:
323: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 324: with the given extension. Can be a comma separated list.
1.42 matthew 325:
1.648 raeburn 326: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 327:
328: Inputs: formname, elementname
329:
330: formname and elementname specify the name of the html form and the name
331: of the element the selection from the search results will be placed in.
1.542 raeburn 332:
1.42 matthew 333: =cut
334:
335: sub browser_and_searcher_javascript {
1.199 albertel 336: my ($mode)=@_;
337: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 338: my $resurl=&escape_single(&lastresurl());
1.42 matthew 339: return <<END;
1.219 albertel 340: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 341: var editbrowser = null;
1.135 albertel 342: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 343: var url = '$resurl/?';
1.42 matthew 344: if (editbrowser == null) {
345: url += 'launch=1&';
346: }
347: url += 'catalogmode=interactive&';
1.199 albertel 348: url += 'mode=$mode&';
1.611 albertel 349: url += 'inhibitmenu=yes&';
1.42 matthew 350: url += 'form=' + formname + '&';
351: if (only != null) {
352: url += 'only=' + only + '&';
1.217 albertel 353: } else {
354: url += 'only=&';
355: }
1.42 matthew 356: if (omit != null) {
357: url += 'omit=' + omit + '&';
1.217 albertel 358: } else {
359: url += 'omit=&';
360: }
1.135 albertel 361: if (titleelement != null) {
362: url += 'titleelement=' + titleelement + '&';
1.217 albertel 363: } else {
364: url += 'titleelement=&';
365: }
1.42 matthew 366: url += 'element=' + elementname + '';
367: var title = 'Browser';
1.435 albertel 368: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 369: options += ',width=700,height=600';
370: editbrowser = open(url,title,options,'1');
371: editbrowser.focus();
372: }
373: var editsearcher;
1.135 albertel 374: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 375: var url = '/adm/searchcat?';
376: if (editsearcher == null) {
377: url += 'launch=1&';
378: }
379: url += 'catalogmode=interactive&';
1.199 albertel 380: url += 'mode=$mode&';
1.42 matthew 381: url += 'form=' + formname + '&';
1.135 albertel 382: if (titleelement != null) {
383: url += 'titleelement=' + titleelement + '&';
1.217 albertel 384: } else {
385: url += 'titleelement=&';
386: }
1.42 matthew 387: url += 'element=' + elementname + '';
388: var title = 'Search';
1.435 albertel 389: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 390: options += ',width=700,height=600';
391: editsearcher = open(url,title,options,'1');
392: editsearcher.focus();
393: }
1.219 albertel 394: // END LON-CAPA Internal -->
1.42 matthew 395: END
1.170 www 396: }
397:
398: sub lastresurl {
1.258 albertel 399: if ($env{'environment.lastresurl'}) {
400: return $env{'environment.lastresurl'}
1.170 www 401: } else {
402: return '/res';
403: }
404: }
405:
406: sub storeresurl {
407: my $resurl=&Apache::lonnet::clutter(shift);
408: unless ($resurl=~/^\/res/) { return 0; }
409: $resurl=~s/\/$//;
410: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 411: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 412: return 1;
1.42 matthew 413: }
414:
1.74 www 415: sub studentbrowser_javascript {
1.111 www 416: unless (
1.258 albertel 417: (($env{'request.course.id'}) &&
1.302 albertel 418: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
419: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
420: '/'.$env{'request.course.sec'})
421: ))
1.258 albertel 422: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 423: ) { return ''; }
1.74 www 424: return (<<'ENDSTDBRW');
1.776 bisitz 425: <script type="text/javascript" language="Javascript">
1.824 bisitz 426: // <![CDATA[
1.74 www 427: var stdeditbrowser;
1.999 www 428: function openstdbrowser(formname,uname,udom,clicker,roleflag,ignorefilter,courseadvonly) {
1.74 www 429: var url = '/adm/pickstudent?';
430: var filter;
1.558 albertel 431: if (!ignorefilter) {
432: eval('filter=document.'+formname+'.'+uname+'.value;');
433: }
1.74 www 434: if (filter != null) {
435: if (filter != '') {
436: url += 'filter='+filter+'&';
437: }
438: }
439: url += 'form=' + formname + '&unameelement='+uname+
1.999 www 440: '&udomelement='+udom+
441: '&clicker='+clicker;
1.111 www 442: if (roleflag) { url+="&roles=1"; }
1.793 raeburn 443: if (courseadvonly) { url+="&courseadvonly=1"; }
1.102 www 444: var title = 'Student_Browser';
1.74 www 445: var options = 'scrollbars=1,resizable=1,menubar=0';
446: options += ',width=700,height=600';
447: stdeditbrowser = open(url,title,options,'1');
448: stdeditbrowser.focus();
449: }
1.824 bisitz 450: // ]]>
1.74 www 451: </script>
452: ENDSTDBRW
453: }
1.42 matthew 454:
1.1003 www 455: sub resourcebrowser_javascript {
456: unless ($env{'request.course.id'}) { return ''; }
1.1004 www 457: return (<<'ENDRESBRW');
1.1003 www 458: <script type="text/javascript" language="Javascript">
459: // <![CDATA[
460: var reseditbrowser;
1.1004 www 461: function openresbrowser(formname,reslink) {
1.1005 www 462: var url = '/adm/pickresource?form='+formname+'&reslink='+reslink;
1.1003 www 463: var title = 'Resource_Browser';
464: var options = 'scrollbars=1,resizable=1,menubar=0';
1.1005 www 465: options += ',width=700,height=500';
1.1004 www 466: reseditbrowser = open(url,title,options,'1');
467: reseditbrowser.focus();
1.1003 www 468: }
469: // ]]>
470: </script>
1.1004 www 471: ENDRESBRW
1.1003 www 472: }
473:
1.74 www 474: sub selectstudent_link {
1.999 www 475: my ($form,$unameele,$udomele,$courseadvonly,$clickerid)=@_;
476: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
477: &Apache::lonhtmlcommon::entity_encode($unameele)."','".
478: &Apache::lonhtmlcommon::entity_encode($udomele)."'";
1.258 albertel 479: if ($env{'request.course.id'}) {
1.302 albertel 480: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
481: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
482: '/'.$env{'request.course.sec'})) {
1.111 www 483: return '';
484: }
1.999 www 485: $callargs.=",'".&Apache::lonhtmlcommon::entity_encode($clickerid)."'";
1.793 raeburn 486: if ($courseadvonly) {
487: $callargs .= ",'',1,1";
488: }
489: return '<span class="LC_nobreak">'.
490: '<a href="javascript:openstdbrowser('.$callargs.');">'.
491: &mt('Select User').'</a></span>';
1.74 www 492: }
1.258 albertel 493: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.1012 www 494: $callargs .= ",'',1";
1.793 raeburn 495: return '<span class="LC_nobreak">'.
496: '<a href="javascript:openstdbrowser('.$callargs.');">'.
497: &mt('Select User').'</a></span>';
1.111 www 498: }
499: return '';
1.91 www 500: }
501:
1.1004 www 502: sub selectresource_link {
503: my ($form,$reslink,$arg)=@_;
504:
505: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
506: &Apache::lonhtmlcommon::entity_encode($reslink)."'";
507: unless ($env{'request.course.id'}) { return $arg; }
508: return '<span class="LC_nobreak">'.
509: '<a href="javascript:openresbrowser('.$callargs.');">'.
510: $arg.'</a></span>';
511: }
512:
513:
514:
1.653 raeburn 515: sub authorbrowser_javascript {
516: return <<"ENDAUTHORBRW";
1.776 bisitz 517: <script type="text/javascript" language="JavaScript">
1.824 bisitz 518: // <![CDATA[
1.653 raeburn 519: var stdeditbrowser;
520:
521: function openauthorbrowser(formname,udom) {
522: var url = '/adm/pickauthor?';
523: url += 'form='+formname+'&roledom='+udom;
524: var title = 'Author_Browser';
525: var options = 'scrollbars=1,resizable=1,menubar=0';
526: options += ',width=700,height=600';
527: stdeditbrowser = open(url,title,options,'1');
528: stdeditbrowser.focus();
529: }
530:
1.824 bisitz 531: // ]]>
1.653 raeburn 532: </script>
533: ENDAUTHORBRW
534: }
535:
1.91 www 536: sub coursebrowser_javascript {
1.1116 raeburn 537: my ($domainfilter,$sec_element,$formname,$role_element,$crstype,
538: $credits_element) = @_;
1.932 raeburn 539: my $wintitle = 'Course_Browser';
1.931 raeburn 540: if ($crstype eq 'Community') {
1.932 raeburn 541: $wintitle = 'Community_Browser';
1.909 raeburn 542: }
1.876 raeburn 543: my $id_functions = &javascript_index_functions();
544: my $output = '
1.776 bisitz 545: <script type="text/javascript" language="JavaScript">
1.824 bisitz 546: // <![CDATA[
1.468 raeburn 547: var stdeditbrowser;'."\n";
1.876 raeburn 548:
549: $output .= <<"ENDSTDBRW";
1.909 raeburn 550: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91 www 551: var url = '/adm/pickcourse?';
1.895 raeburn 552: var formid = getFormIdByName(formname);
1.876 raeburn 553: var domainfilter = getDomainFromSelectbox(formname,udom);
1.128 albertel 554: if (domainfilter != null) {
555: if (domainfilter != '') {
556: url += 'domainfilter='+domainfilter+'&';
557: }
558: }
1.91 www 559: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 560: '&cdomelement='+udom+
561: '&cnameelement='+desc;
1.468 raeburn 562: if (extra_element !=null && extra_element != '') {
1.594 raeburn 563: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 564: url += '&roleelement='+extra_element;
565: if (domainfilter == null || domainfilter == '') {
566: url += '&domainfilter='+extra_element;
567: }
1.234 raeburn 568: }
1.468 raeburn 569: else {
570: if (formname == 'portform') {
571: url += '&setroles='+extra_element;
1.800 raeburn 572: } else {
573: if (formname == 'rules') {
574: url += '&fixeddom='+extra_element;
575: }
1.468 raeburn 576: }
577: }
1.230 raeburn 578: }
1.909 raeburn 579: if (type != null && type != '') {
580: url += '&type='+type;
581: }
582: if (type_elem != null && type_elem != '') {
583: url += '&typeelement='+type_elem;
584: }
1.872 raeburn 585: if (formname == 'ccrs') {
586: var ownername = document.forms[formid].ccuname.value;
587: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
588: url += '&cloner='+ownername+':'+ownerdom;
589: }
1.293 raeburn 590: if (multflag !=null && multflag != '') {
591: url += '&multiple='+multflag;
592: }
1.909 raeburn 593: var title = '$wintitle';
1.91 www 594: var options = 'scrollbars=1,resizable=1,menubar=0';
595: options += ',width=700,height=600';
596: stdeditbrowser = open(url,title,options,'1');
597: stdeditbrowser.focus();
598: }
1.876 raeburn 599: $id_functions
600: ENDSTDBRW
1.1116 raeburn 601: if (($sec_element ne '') || ($role_element ne '') || ($credits_element ne '')) {
602: $output .= &setsec_javascript($sec_element,$formname,$role_element,
603: $credits_element);
1.876 raeburn 604: }
605: $output .= '
606: // ]]>
607: </script>';
608: return $output;
609: }
610:
611: sub javascript_index_functions {
612: return <<"ENDJS";
613:
614: function getFormIdByName(formname) {
615: for (var i=0;i<document.forms.length;i++) {
616: if (document.forms[i].name == formname) {
617: return i;
618: }
619: }
620: return -1;
621: }
622:
623: function getIndexByName(formid,item) {
624: for (var i=0;i<document.forms[formid].elements.length;i++) {
625: if (document.forms[formid].elements[i].name == item) {
626: return i;
627: }
628: }
629: return -1;
630: }
1.468 raeburn 631:
1.876 raeburn 632: function getDomainFromSelectbox(formname,udom) {
633: var userdom;
634: var formid = getFormIdByName(formname);
635: if (formid > -1) {
636: var domid = getIndexByName(formid,udom);
637: if (domid > -1) {
638: if (document.forms[formid].elements[domid].type == 'select-one') {
639: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
640: }
641: if (document.forms[formid].elements[domid].type == 'hidden') {
642: userdom=document.forms[formid].elements[domid].value;
1.468 raeburn 643: }
644: }
645: }
1.876 raeburn 646: return userdom;
647: }
648:
649: ENDJS
1.468 raeburn 650:
1.876 raeburn 651: }
652:
1.1017 raeburn 653: sub javascript_array_indexof {
1.1018 raeburn 654: return <<ENDJS;
1.1017 raeburn 655: <script type="text/javascript" language="JavaScript">
656: // <![CDATA[
657:
658: if (!Array.prototype.indexOf) {
659: Array.prototype.indexOf = function (searchElement /*, fromIndex */ ) {
660: "use strict";
661: if (this === void 0 || this === null) {
662: throw new TypeError();
663: }
664: var t = Object(this);
665: var len = t.length >>> 0;
666: if (len === 0) {
667: return -1;
668: }
669: var n = 0;
670: if (arguments.length > 0) {
671: n = Number(arguments[1]);
1.1088 foxr 672: if (n !== n) { // shortcut for verifying if it is NaN
1.1017 raeburn 673: n = 0;
674: } else if (n !== 0 && n !== (1 / 0) && n !== -(1 / 0)) {
675: n = (n > 0 || -1) * Math.floor(Math.abs(n));
676: }
677: }
678: if (n >= len) {
679: return -1;
680: }
681: var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
682: for (; k < len; k++) {
683: if (k in t && t[k] === searchElement) {
684: return k;
685: }
686: }
687: return -1;
688: }
689: }
690:
691: // ]]>
692: </script>
693:
694: ENDJS
695:
696: }
697:
1.876 raeburn 698: sub userbrowser_javascript {
699: my $id_functions = &javascript_index_functions();
700: return <<"ENDUSERBRW";
701:
1.888 raeburn 702: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876 raeburn 703: var url = '/adm/pickuser?';
704: var userdom = getDomainFromSelectbox(formname,udom);
705: if (userdom != null) {
706: if (userdom != '') {
707: url += 'srchdom='+userdom+'&';
708: }
709: }
710: url += 'form=' + formname + '&unameelement='+uname+
711: '&udomelement='+udom+
712: '&ulastelement='+ulast+
713: '&ufirstelement='+ufirst+
714: '&uemailelement='+uemail+
1.881 raeburn 715: '&hideudomelement='+hideudom+
716: '&coursedom='+crsdom;
1.888 raeburn 717: if ((caller != null) && (caller != undefined)) {
718: url += '&caller='+caller;
719: }
1.876 raeburn 720: var title = 'User_Browser';
721: var options = 'scrollbars=1,resizable=1,menubar=0';
722: options += ',width=700,height=600';
723: var stdeditbrowser = open(url,title,options,'1');
724: stdeditbrowser.focus();
725: }
726:
1.888 raeburn 727: function fix_domain (formname,udom,origdom,uname) {
1.876 raeburn 728: var formid = getFormIdByName(formname);
729: if (formid > -1) {
1.888 raeburn 730: var unameid = getIndexByName(formid,uname);
1.876 raeburn 731: var domid = getIndexByName(formid,udom);
732: var hidedomid = getIndexByName(formid,origdom);
733: if (hidedomid > -1) {
734: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888 raeburn 735: var unameval = document.forms[formid].elements[unameid].value;
736: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
737: if (domid > -1) {
738: var slct = document.forms[formid].elements[domid];
739: if (slct.type == 'select-one') {
740: var i;
741: for (i=0;i<slct.length;i++) {
742: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
743: }
744: }
745: if (slct.type == 'hidden') {
746: slct.value = fixeddom;
1.876 raeburn 747: }
748: }
1.468 raeburn 749: }
750: }
751: }
1.876 raeburn 752: return;
753: }
754:
755: $id_functions
756: ENDUSERBRW
1.468 raeburn 757: }
758:
759: sub setsec_javascript {
1.1116 raeburn 760: my ($sec_element,$formname,$role_element,$credits_element) = @_;
1.905 raeburn 761: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
762: $communityrolestr);
763: if ($role_element ne '') {
764: my @allroles = ('st','ta','ep','in','ad');
765: foreach my $crstype ('Course','Community') {
766: if ($crstype eq 'Community') {
767: foreach my $role (@allroles) {
768: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
769: }
770: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
771: } else {
772: foreach my $role (@allroles) {
773: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
774: }
775: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
776: }
777: }
778: $rolestr = '"'.join('","',@allroles).'"';
779: $courserolestr = '"'.join('","',@courserolenames).'"';
780: $communityrolestr = '"'.join('","',@communityrolenames).'"';
781: }
1.468 raeburn 782: my $setsections = qq|
783: function setSect(sectionlist) {
1.629 raeburn 784: var sectionsArray = new Array();
785: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
786: sectionsArray = sectionlist.split(",");
787: }
1.468 raeburn 788: var numSections = sectionsArray.length;
789: document.$formname.$sec_element.length = 0;
790: if (numSections == 0) {
791: document.$formname.$sec_element.multiple=false;
792: document.$formname.$sec_element.size=1;
793: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
794: } else {
795: if (numSections == 1) {
796: document.$formname.$sec_element.multiple=false;
797: document.$formname.$sec_element.size=1;
798: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
799: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
800: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
801: } else {
802: for (var i=0; i<numSections; i++) {
803: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
804: }
805: document.$formname.$sec_element.multiple=true
806: if (numSections < 3) {
807: document.$formname.$sec_element.size=numSections;
808: } else {
809: document.$formname.$sec_element.size=3;
810: }
811: document.$formname.$sec_element.options[0].selected = false
812: }
813: }
1.91 www 814: }
1.905 raeburn 815:
816: function setRole(crstype) {
1.468 raeburn 817: |;
1.905 raeburn 818: if ($role_element eq '') {
819: $setsections .= ' return;
820: }
821: ';
822: } else {
823: $setsections .= qq|
824: var elementLength = document.$formname.$role_element.length;
825: var allroles = Array($rolestr);
826: var courserolenames = Array($courserolestr);
827: var communityrolenames = Array($communityrolestr);
828: if (elementLength != undefined) {
829: if (document.$formname.$role_element.options[5].value == 'cc') {
830: if (crstype == 'Course') {
831: return;
832: } else {
833: allroles[5] = 'co';
834: for (var i=0; i<6; i++) {
835: document.$formname.$role_element.options[i].value = allroles[i];
836: document.$formname.$role_element.options[i].text = communityrolenames[i];
837: }
838: }
839: } else {
840: if (crstype == 'Community') {
841: return;
842: } else {
843: allroles[5] = 'cc';
844: for (var i=0; i<6; i++) {
845: document.$formname.$role_element.options[i].value = allroles[i];
846: document.$formname.$role_element.options[i].text = courserolenames[i];
847: }
848: }
849: }
850: }
851: return;
852: }
853: |;
854: }
1.1116 raeburn 855: if ($credits_element) {
856: $setsections .= qq|
857: function setCredits(defaultcredits) {
858: document.$formname.$credits_element.value = defaultcredits;
859: return;
860: }
861: |;
862: }
1.468 raeburn 863: return $setsections;
864: }
865:
1.91 www 866: sub selectcourse_link {
1.909 raeburn 867: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
868: $typeelement) = @_;
869: my $type = $selecttype;
1.871 raeburn 870: my $linktext = &mt('Select Course');
871: if ($selecttype eq 'Community') {
1.909 raeburn 872: $linktext = &mt('Select Community');
1.906 raeburn 873: } elsif ($selecttype eq 'Course/Community') {
874: $linktext = &mt('Select Course/Community');
1.909 raeburn 875: $type = '';
1.1019 raeburn 876: } elsif ($selecttype eq 'Select') {
877: $linktext = &mt('Select');
878: $type = '';
1.871 raeburn 879: }
1.787 bisitz 880: return '<span class="LC_nobreak">'
881: ."<a href='"
882: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
883: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 884: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 885: ."'>".$linktext.'</a>'
1.787 bisitz 886: .'</span>';
1.74 www 887: }
1.42 matthew 888:
1.653 raeburn 889: sub selectauthor_link {
890: my ($form,$udom)=@_;
891: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
892: &mt('Select Author').'</a>';
893: }
894:
1.876 raeburn 895: sub selectuser_link {
1.881 raeburn 896: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 897: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 898: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 899: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 900: ');">'.$linktext.'</a>';
1.876 raeburn 901: }
902:
1.273 raeburn 903: sub check_uncheck_jscript {
904: my $jscript = <<"ENDSCRT";
905: function checkAll(field) {
906: if (field.length > 0) {
907: for (i = 0; i < field.length; i++) {
1.1093 raeburn 908: if (!field[i].disabled) {
909: field[i].checked = true;
910: }
1.273 raeburn 911: }
912: } else {
1.1093 raeburn 913: if (!field.disabled) {
914: field.checked = true;
915: }
1.273 raeburn 916: }
917: }
918:
919: function uncheckAll(field) {
920: if (field.length > 0) {
921: for (i = 0; i < field.length; i++) {
922: field[i].checked = false ;
1.543 albertel 923: }
924: } else {
1.273 raeburn 925: field.checked = false ;
926: }
927: }
928: ENDSCRT
929: return $jscript;
930: }
931:
1.656 www 932: sub select_timezone {
1.659 raeburn 933: my ($name,$selected,$onchange,$includeempty)=@_;
934: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
935: if ($includeempty) {
936: $output .= '<option value=""';
937: if (($selected eq '') || ($selected eq 'local')) {
938: $output .= ' selected="selected" ';
939: }
940: $output .= '> </option>';
941: }
1.657 raeburn 942: my @timezones = DateTime::TimeZone->all_names;
943: foreach my $tzone (@timezones) {
944: $output.= '<option value="'.$tzone.'"';
945: if ($tzone eq $selected) {
946: $output.=' selected="selected"';
947: }
948: $output.=">$tzone</option>\n";
1.656 www 949: }
950: $output.="</select>";
951: return $output;
952: }
1.273 raeburn 953:
1.687 raeburn 954: sub select_datelocale {
955: my ($name,$selected,$onchange,$includeempty)=@_;
956: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
957: if ($includeempty) {
958: $output .= '<option value=""';
959: if ($selected eq '') {
960: $output .= ' selected="selected" ';
961: }
962: $output .= '> </option>';
963: }
964: my (@possibles,%locale_names);
965: my @locales = DateTime::Locale::Catalog::Locales;
966: foreach my $locale (@locales) {
967: if (ref($locale) eq 'HASH') {
968: my $id = $locale->{'id'};
969: if ($id ne '') {
970: my $en_terr = $locale->{'en_territory'};
971: my $native_terr = $locale->{'native_territory'};
1.695 raeburn 972: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 973: if (grep(/^en$/,@languages) || !@languages) {
974: if ($en_terr ne '') {
975: $locale_names{$id} = '('.$en_terr.')';
976: } elsif ($native_terr ne '') {
977: $locale_names{$id} = $native_terr;
978: }
979: } else {
980: if ($native_terr ne '') {
981: $locale_names{$id} = $native_terr.' ';
982: } elsif ($en_terr ne '') {
983: $locale_names{$id} = '('.$en_terr.')';
984: }
985: }
986: push (@possibles,$id);
987: }
988: }
989: }
990: foreach my $item (sort(@possibles)) {
991: $output.= '<option value="'.$item.'"';
992: if ($item eq $selected) {
993: $output.=' selected="selected"';
994: }
995: $output.=">$item";
996: if ($locale_names{$item} ne '') {
997: $output.=" $locale_names{$item}</option>\n";
998: }
999: $output.="</option>\n";
1000: }
1001: $output.="</select>";
1002: return $output;
1003: }
1004:
1.792 raeburn 1005: sub select_language {
1006: my ($name,$selected,$includeempty) = @_;
1007: my %langchoices;
1008: if ($includeempty) {
1.1117 raeburn 1009: %langchoices = ('' => 'No language preference');
1.792 raeburn 1010: }
1011: foreach my $id (&languageids()) {
1012: my $code = &supportedlanguagecode($id);
1013: if ($code) {
1014: $langchoices{$code} = &plainlanguagedescription($id);
1015: }
1016: }
1.1117 raeburn 1017: %langchoices = &Apache::lonlocal::texthash(%langchoices);
1.970 raeburn 1018: return &select_form($selected,$name,\%langchoices);
1.792 raeburn 1019: }
1020:
1.42 matthew 1021: =pod
1.36 matthew 1022:
1.1088 foxr 1023:
1024: =item * &list_languages()
1025:
1026: Returns an array reference that is suitable for use in language prompters.
1027: Each array element is itself a two element array. The first element
1028: is the language code. The second element a descsriptiuon of the
1029: language itself. This is suitable for use in e.g.
1030: &Apache::edit::select_arg (once dereferenced that is).
1031:
1032: =cut
1033:
1034: sub list_languages {
1035: my @lang_choices;
1036:
1037: foreach my $id (&languageids()) {
1038: my $code = &supportedlanguagecode($id);
1039: if ($code) {
1040: my $selector = $supported_codes{$id};
1041: my $description = &plainlanguagedescription($id);
1042: push (@lang_choices, [$selector, $description]);
1043: }
1044: }
1045: return \@lang_choices;
1046: }
1047:
1048: =pod
1049:
1.648 raeburn 1050: =item * &linked_select_forms(...)
1.36 matthew 1051:
1052: linked_select_forms returns a string containing a <script></script> block
1053: and html for two <select> menus. The select menus will be linked in that
1054: changing the value of the first menu will result in new values being placed
1055: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 1056: order unless a defined order is provided.
1.36 matthew 1057:
1058: linked_select_forms takes the following ordered inputs:
1059:
1060: =over 4
1061:
1.112 bowersj2 1062: =item * $formname, the name of the <form> tag
1.36 matthew 1063:
1.112 bowersj2 1064: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 1065:
1.112 bowersj2 1066: =item * $firstdefault, the default value for the first menu
1.36 matthew 1067:
1.112 bowersj2 1068: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 1069:
1.112 bowersj2 1070: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 1071:
1.112 bowersj2 1072: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 1073:
1.609 raeburn 1074: =item * $menuorder, the order of values in the first menu
1075:
1.1115 raeburn 1076: =item * $onchangefirst, additional javascript call to execute for an onchange
1077: event for the first <select> tag
1078:
1079: =item * $onchangesecond, additional javascript call to execute for an onchange
1080: event for the second <select> tag
1081:
1.41 ng 1082: =back
1083:
1.36 matthew 1084: Below is an example of such a hash. Only the 'text', 'default', and
1085: 'select2' keys must appear as stated. keys(%menu) are the possible
1086: values for the first select menu. The text that coincides with the
1.41 ng 1087: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 1088: and text for the second menu are given in the hash pointed to by
1089: $menu{$choice1}->{'select2'}.
1090:
1.112 bowersj2 1091: my %menu = ( A1 => { text =>"Choice A1" ,
1092: default => "B3",
1093: select2 => {
1094: B1 => "Choice B1",
1095: B2 => "Choice B2",
1096: B3 => "Choice B3",
1097: B4 => "Choice B4"
1.609 raeburn 1098: },
1099: order => ['B4','B3','B1','B2'],
1.112 bowersj2 1100: },
1101: A2 => { text =>"Choice A2" ,
1102: default => "C2",
1103: select2 => {
1104: C1 => "Choice C1",
1105: C2 => "Choice C2",
1106: C3 => "Choice C3"
1.609 raeburn 1107: },
1108: order => ['C2','C1','C3'],
1.112 bowersj2 1109: },
1110: A3 => { text =>"Choice A3" ,
1111: default => "D6",
1112: select2 => {
1113: D1 => "Choice D1",
1114: D2 => "Choice D2",
1115: D3 => "Choice D3",
1116: D4 => "Choice D4",
1117: D5 => "Choice D5",
1118: D6 => "Choice D6",
1119: D7 => "Choice D7"
1.609 raeburn 1120: },
1121: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 1122: }
1123: );
1.36 matthew 1124:
1125: =cut
1126:
1127: sub linked_select_forms {
1128: my ($formname,
1129: $middletext,
1130: $firstdefault,
1131: $firstselectname,
1132: $secondselectname,
1.609 raeburn 1133: $hashref,
1134: $menuorder,
1.1115 raeburn 1135: $onchangefirst,
1136: $onchangesecond
1.36 matthew 1137: ) = @_;
1138: my $second = "document.$formname.$secondselectname";
1139: my $first = "document.$formname.$firstselectname";
1140: # output the javascript to do the changing
1141: my $result = '';
1.776 bisitz 1142: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 1143: $result.="// <![CDATA[\n";
1.36 matthew 1144: $result.="var select2data = new Object();\n";
1145: $" = '","';
1146: my $debug = '';
1147: foreach my $s1 (sort(keys(%$hashref))) {
1148: $result.="select2data.d_$s1 = new Object();\n";
1149: $result.="select2data.d_$s1.def = new String('".
1150: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 1151: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 1152: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1153: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1154: @s2values = @{$hashref->{$s1}->{'order'}};
1155: }
1.36 matthew 1156: $result.="\"@s2values\");\n";
1157: $result.="select2data.d_$s1.texts = new Array(";
1158: my @s2texts;
1159: foreach my $value (@s2values) {
1160: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
1161: }
1162: $result.="\"@s2texts\");\n";
1163: }
1164: $"=' ';
1165: $result.= <<"END";
1166:
1167: function select1_changed() {
1168: // Determine new choice
1169: var newvalue = "d_" + $first.value;
1170: // update select2
1171: var values = select2data[newvalue].values;
1172: var texts = select2data[newvalue].texts;
1173: var select2def = select2data[newvalue].def;
1174: var i;
1175: // out with the old
1176: for (i = 0; i < $second.options.length; i++) {
1177: $second.options[i] = null;
1178: }
1179: // in with the nuclear
1180: for (i=0;i<values.length; i++) {
1181: $second.options[i] = new Option(values[i]);
1.143 matthew 1182: $second.options[i].value = values[i];
1.36 matthew 1183: $second.options[i].text = texts[i];
1184: if (values[i] == select2def) {
1185: $second.options[i].selected = true;
1186: }
1187: }
1188: }
1.824 bisitz 1189: // ]]>
1.36 matthew 1190: </script>
1191: END
1192: # output the initial values for the selection lists
1.1115 raeburn 1193: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed();$onchangefirst\">\n";
1.609 raeburn 1194: my @order = sort(keys(%{$hashref}));
1195: if (ref($menuorder) eq 'ARRAY') {
1196: @order = @{$menuorder};
1197: }
1198: foreach my $value (@order) {
1.36 matthew 1199: $result.=" <option value=\"$value\" ";
1.253 albertel 1200: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1201: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1202: }
1203: $result .= "</select>\n";
1204: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1205: $result .= $middletext;
1.1115 raeburn 1206: $result .= "<select size=\"1\" name=\"$secondselectname\"";
1207: if ($onchangesecond) {
1208: $result .= ' onchange="'.$onchangesecond.'"';
1209: }
1210: $result .= ">\n";
1.36 matthew 1211: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1212:
1213: my @secondorder = sort(keys(%select2));
1214: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1215: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1216: }
1217: foreach my $value (@secondorder) {
1.36 matthew 1218: $result.=" <option value=\"$value\" ";
1.253 albertel 1219: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1220: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1221: }
1222: $result .= "</select>\n";
1223: # return $debug;
1224: return $result;
1225: } # end of sub linked_select_forms {
1226:
1.45 matthew 1227: =pod
1.44 bowersj2 1228:
1.973 raeburn 1229: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid)
1.44 bowersj2 1230:
1.112 bowersj2 1231: Returns a string corresponding to an HTML link to the given help
1232: $topic, where $topic corresponds to the name of a .tex file in
1233: /home/httpd/html/adm/help/tex, with underscores replaced by
1234: spaces.
1235:
1236: $text will optionally be linked to the same topic, allowing you to
1237: link text in addition to the graphic. If you do not want to link
1238: text, but wish to specify one of the later parameters, pass an
1239: empty string.
1240:
1241: $stayOnPage is a value that will be interpreted as a boolean. If true,
1242: the link will not open a new window. If false, the link will open
1243: a new window using Javascript. (Default is false.)
1244:
1245: $width and $height are optional numerical parameters that will
1246: override the width and height of the popped up window, which may
1.973 raeburn 1247: be useful for certain help topics with big pictures included.
1248:
1249: $imgid is the id of the img tag used for the help icon. This may be
1250: used in a javascript call to switch the image src. See
1251: lonhtmlcommon::htmlareaselectactive() for an example.
1.44 bowersj2 1252:
1253: =cut
1254:
1255: sub help_open_topic {
1.973 raeburn 1256: my ($topic, $text, $stayOnPage, $width, $height, $imgid) = @_;
1.48 bowersj2 1257: $text = "" if (not defined $text);
1.44 bowersj2 1258: $stayOnPage = 0 if (not defined $stayOnPage);
1.1033 www 1259: $width = 500 if (not defined $width);
1.44 bowersj2 1260: $height = 400 if (not defined $height);
1261: my $filename = $topic;
1262: $filename =~ s/ /_/g;
1263:
1.48 bowersj2 1264: my $template = "";
1265: my $link;
1.572 banghart 1266:
1.159 www 1267: $topic=~s/\W/\_/g;
1.44 bowersj2 1268:
1.572 banghart 1269: if (!$stayOnPage) {
1.1033 www 1270: $link = "javascript:openMyModal('/adm/help/${filename}.hlp',$width,$height,'yes');";
1.1037 www 1271: } elsif ($stayOnPage eq 'popup') {
1272: $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 1273: } else {
1.48 bowersj2 1274: $link = "/adm/help/${filename}.hlp";
1275: }
1276:
1277: # Add the text
1.755 neumanie 1278: if ($text ne "") {
1.763 bisitz 1279: $template.='<span class="LC_help_open_topic">'
1280: .'<a target="_top" href="'.$link.'">'
1281: .$text.'</a>';
1.48 bowersj2 1282: }
1283:
1.763 bisitz 1284: # (Always) Add the graphic
1.179 matthew 1285: my $title = &mt('Online Help');
1.667 raeburn 1286: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973 raeburn 1287: if ($imgid ne '') {
1288: $imgid = ' id="'.$imgid.'"';
1289: }
1.763 bisitz 1290: $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
1291: .'<img src="'.$helpicon.'" border="0"'
1292: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973 raeburn 1293: .' title="'.$title.'" style="vertical-align:middle;"'.$imgid
1.763 bisitz 1294: .' /></a>';
1295: if ($text ne "") {
1296: $template.='</span>';
1297: }
1.44 bowersj2 1298: return $template;
1299:
1.106 bowersj2 1300: }
1301:
1302: # This is a quicky function for Latex cheatsheet editing, since it
1303: # appears in at least four places
1304: sub helpLatexCheatsheet {
1.1037 www 1305: my ($topic,$text,$not_author,$stayOnPage) = @_;
1.732 raeburn 1306: my $out;
1.106 bowersj2 1307: my $addOther = '';
1.732 raeburn 1308: if ($topic) {
1.1037 www 1309: $addOther = '<span>'.&help_open_topic($topic,&mt($text),$stayOnPage, undef, 600).'</span> ';
1.763 bisitz 1310: }
1311: $out = '<span>' # Start cheatsheet
1312: .$addOther
1313: .'<span>'
1.1037 www 1314: .&help_open_topic('Greek_Symbols',&mt('Greek Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1315: .'</span> <span>'
1.1037 www 1316: .&help_open_topic('Other_Symbols',&mt('Other Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1317: .'</span>';
1.732 raeburn 1318: unless ($not_author) {
1.1186 kruse 1319: $out .= '<span>'
1320: .&help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),$stayOnPage,undef,600)
1321: .'</span> <span>'
1322: .&help_open_topic('Authoring_Multilingual_Problems',&mt('How to create problems in different languages'),$stayOnPage,undef,600)
1.763 bisitz 1323: .'</span>';
1.732 raeburn 1324: }
1.763 bisitz 1325: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1326: return $out;
1.172 www 1327: }
1328:
1.430 albertel 1329: sub general_help {
1330: my $helptopic='Student_Intro';
1331: if ($env{'request.role'}=~/^(ca|au)/) {
1332: $helptopic='Authoring_Intro';
1.907 raeburn 1333: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1334: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1335: } elsif ($env{'request.role'}=~/^dc/) {
1336: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1337: }
1338: return $helptopic;
1339: }
1340:
1341: sub update_help_link {
1342: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1343: my $origurl = $ENV{'REQUEST_URI'};
1344: $origurl=~s|^/~|/priv/|;
1345: my $timestamp = time;
1346: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1347: $$datum = &escape($$datum);
1348: }
1349:
1350: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1351: my $output .= <<"ENDOUTPUT";
1352: <script type="text/javascript">
1.824 bisitz 1353: // <![CDATA[
1.430 albertel 1354: banner_link = '$banner_link';
1.824 bisitz 1355: // ]]>
1.430 albertel 1356: </script>
1357: ENDOUTPUT
1358: return $output;
1359: }
1360:
1361: # now just updates the help link and generates a blue icon
1.193 raeburn 1362: sub help_open_menu {
1.430 albertel 1363: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1364: = @_;
1.949 droeschl 1365: $stayOnPage = 1;
1.430 albertel 1366: my $output;
1367: if ($component_help) {
1368: if (!$text) {
1369: $output=&help_open_topic($component_help,undef,$stayOnPage,
1370: $width,$height);
1371: } else {
1372: my $help_text;
1373: $help_text=&unescape($topic);
1374: $output='<table><tr><td>'.
1375: &help_open_topic($component_help,$help_text,$stayOnPage,
1376: $width,$height).'</td></tr></table>';
1377: }
1378: }
1379: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1380: return $output.$banner_link;
1381: }
1382:
1383: sub top_nav_help {
1384: my ($text) = @_;
1.436 albertel 1385: $text = &mt($text);
1.949 droeschl 1386: my $stay_on_page = 1;
1387:
1.1168 raeburn 1388: my ($link,$banner_link);
1389: unless ($env{'request.noversionuri'} =~ m{^/adm/helpmenu}) {
1390: $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1391: : "javascript:helpMenu('open')";
1392: $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1393: }
1.201 raeburn 1394: my $title = &mt('Get help');
1.1168 raeburn 1395: if ($link) {
1396: return <<"END";
1.436 albertel 1397: $banner_link
1.1159 raeburn 1398: <a href="$link" title="$title">$text</a>
1.436 albertel 1399: END
1.1168 raeburn 1400: } else {
1401: return ' '.$text.' ';
1402: }
1.436 albertel 1403: }
1404:
1405: sub help_menu_js {
1.1154 raeburn 1406: my ($httphost) = @_;
1.949 droeschl 1407: my $stayOnPage = 1;
1.436 albertel 1408: my $width = 620;
1409: my $height = 600;
1.430 albertel 1410: my $helptopic=&general_help();
1.1154 raeburn 1411: my $details_link = $httphost.'/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1412: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1413: my $start_page =
1414: &Apache::loncommon::start_page('Help Menu', undef,
1415: {'frameset' => 1,
1416: 'js_ready' => 1,
1.1154 raeburn 1417: 'use_absolute' => $httphost,
1.331 albertel 1418: 'add_entries' => {
1.1168 raeburn 1419: 'border' => '0',
1.579 raeburn 1420: 'rows' => "110,*",},});
1.331 albertel 1421: my $end_page =
1422: &Apache::loncommon::end_page({'frameset' => 1,
1423: 'js_ready' => 1,});
1424:
1.436 albertel 1425: my $template .= <<"ENDTEMPLATE";
1426: <script type="text/javascript">
1.877 bisitz 1427: // <![CDATA[
1.253 albertel 1428: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1429: var banner_link = '';
1.243 raeburn 1430: function helpMenu(target) {
1431: var caller = this;
1432: if (target == 'open') {
1433: var newWindow = null;
1434: try {
1.262 albertel 1435: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1436: }
1437: catch(error) {
1438: writeHelp(caller);
1439: return;
1440: }
1441: if (newWindow) {
1442: caller = newWindow;
1443: }
1.193 raeburn 1444: }
1.243 raeburn 1445: writeHelp(caller);
1446: return;
1447: }
1448: function writeHelp(caller) {
1.1168 raeburn 1449: caller.document.writeln('$start_page\\n<frame name="bannerframe" src="'+banner_link+'" marginwidth="0" marginheight="0" frameborder="0">\\n');
1450: caller.document.writeln('<frame name="bodyframe" src="$details_link" marginwidth="0" marginheight="0" frameborder="0">\\n$end_page');
1451: caller.document.close();
1452: caller.focus();
1.193 raeburn 1453: }
1.877 bisitz 1454: // END LON-CAPA Internal -->
1.253 albertel 1455: // ]]>
1.436 albertel 1456: </script>
1.193 raeburn 1457: ENDTEMPLATE
1458: return $template;
1459: }
1460:
1.172 www 1461: sub help_open_bug {
1462: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1463: unless ($env{'user.adv'}) { return ''; }
1.172 www 1464: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1465: $text = "" if (not defined $text);
1466: $stayOnPage=1;
1.184 albertel 1467: $width = 600 if (not defined $width);
1468: $height = 600 if (not defined $height);
1.172 www 1469:
1470: $topic=~s/\W+/\+/g;
1471: my $link='';
1472: my $template='';
1.379 albertel 1473: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1474: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1475: if (!$stayOnPage)
1476: {
1477: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1478: }
1479: else
1480: {
1481: $link = $url;
1482: }
1483: # Add the text
1484: if ($text ne "")
1485: {
1486: $template .=
1487: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1488: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1489: }
1490:
1491: # Add the graphic
1.179 matthew 1492: my $title = &mt('Report a Bug');
1.215 albertel 1493: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1494: $template .= <<"ENDTEMPLATE";
1.436 albertel 1495: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1496: ENDTEMPLATE
1497: if ($text ne '') { $template.='</td></tr></table>' };
1498: return $template;
1499:
1500: }
1501:
1502: sub help_open_faq {
1503: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1504: unless ($env{'user.adv'}) { return ''; }
1.172 www 1505: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1506: $text = "" if (not defined $text);
1507: $stayOnPage=1;
1508: $width = 350 if (not defined $width);
1509: $height = 400 if (not defined $height);
1510:
1511: $topic=~s/\W+/\+/g;
1512: my $link='';
1513: my $template='';
1514: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1515: if (!$stayOnPage)
1516: {
1517: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1518: }
1519: else
1520: {
1521: $link = $url;
1522: }
1523:
1524: # Add the text
1525: if ($text ne "")
1526: {
1527: $template .=
1.173 www 1528: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1529: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1530: }
1531:
1532: # Add the graphic
1.179 matthew 1533: my $title = &mt('View the FAQ');
1.215 albertel 1534: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1535: $template .= <<"ENDTEMPLATE";
1.436 albertel 1536: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1537: ENDTEMPLATE
1538: if ($text ne '') { $template.='</td></tr></table>' };
1539: return $template;
1540:
1.44 bowersj2 1541: }
1.37 matthew 1542:
1.180 matthew 1543: ###############################################################
1544: ###############################################################
1545:
1.45 matthew 1546: =pod
1547:
1.648 raeburn 1548: =item * &change_content_javascript():
1.256 matthew 1549:
1550: This and the next function allow you to create small sections of an
1551: otherwise static HTML page that you can update on the fly with
1552: Javascript, even in Netscape 4.
1553:
1554: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1555: must be written to the HTML page once. It will prove the Javascript
1556: function "change(name, content)". Calling the change function with the
1557: name of the section
1558: you want to update, matching the name passed to C<changable_area>, and
1559: the new content you want to put in there, will put the content into
1560: that area.
1561:
1562: B<Note>: Netscape 4 only reserves enough space for the changable area
1563: to contain room for the original contents. You need to "make space"
1564: for whatever changes you wish to make, and be B<sure> to check your
1565: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1566: it's adequate for updating a one-line status display, but little more.
1567: This script will set the space to 100% width, so you only need to
1568: worry about height in Netscape 4.
1569:
1570: Modern browsers are much less limiting, and if you can commit to the
1571: user not using Netscape 4, this feature may be used freely with
1572: pretty much any HTML.
1573:
1574: =cut
1575:
1576: sub change_content_javascript {
1577: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1578: if ($env{'browser.type'} eq 'netscape' &&
1579: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1580: return (<<NETSCAPE4);
1581: function change(name, content) {
1582: doc = document.layers[name+"___escape"].layers[0].document;
1583: doc.open();
1584: doc.write(content);
1585: doc.close();
1586: }
1587: NETSCAPE4
1588: } else {
1589: # Otherwise, we need to use semi-standards-compliant code
1590: # (technically, "innerHTML" isn't standard but the equivalent
1591: # is really scary, and every useful browser supports it
1592: return (<<DOMBASED);
1593: function change(name, content) {
1594: element = document.getElementById(name);
1595: element.innerHTML = content;
1596: }
1597: DOMBASED
1598: }
1599: }
1600:
1601: =pod
1602:
1.648 raeburn 1603: =item * &changable_area($name,$origContent):
1.256 matthew 1604:
1605: This provides a "changable area" that can be modified on the fly via
1606: the Javascript code provided in C<change_content_javascript>. $name is
1607: the name you will use to reference the area later; do not repeat the
1608: same name on a given HTML page more then once. $origContent is what
1609: the area will originally contain, which can be left blank.
1610:
1611: =cut
1612:
1613: sub changable_area {
1614: my ($name, $origContent) = @_;
1615:
1.258 albertel 1616: if ($env{'browser.type'} eq 'netscape' &&
1617: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1618: # If this is netscape 4, we need to use the Layer tag
1619: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1620: } else {
1621: return "<span id='$name'>$origContent</span>";
1622: }
1623: }
1624:
1625: =pod
1626:
1.648 raeburn 1627: =item * &viewport_geometry_js
1.590 raeburn 1628:
1629: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1630:
1631: =cut
1632:
1633:
1634: sub viewport_geometry_js {
1635: return <<"GEOMETRY";
1636: var Geometry = {};
1637: function init_geometry() {
1638: if (Geometry.init) { return };
1639: Geometry.init=1;
1640: if (window.innerHeight) {
1641: Geometry.getViewportHeight = function() { return window.innerHeight; };
1642: Geometry.getViewportWidth = function() { return window.innerWidth; };
1643: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1644: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1645: }
1646: else if (document.documentElement && document.documentElement.clientHeight) {
1647: Geometry.getViewportHeight =
1648: function() { return document.documentElement.clientHeight; };
1649: Geometry.getViewportWidth =
1650: function() { return document.documentElement.clientWidth; };
1651:
1652: Geometry.getHorizontalScroll =
1653: function() { return document.documentElement.scrollLeft; };
1654: Geometry.getVerticalScroll =
1655: function() { return document.documentElement.scrollTop; };
1656: }
1657: else if (document.body.clientHeight) {
1658: Geometry.getViewportHeight =
1659: function() { return document.body.clientHeight; };
1660: Geometry.getViewportWidth =
1661: function() { return document.body.clientWidth; };
1662: Geometry.getHorizontalScroll =
1663: function() { return document.body.scrollLeft; };
1664: Geometry.getVerticalScroll =
1665: function() { return document.body.scrollTop; };
1666: }
1667: }
1668:
1669: GEOMETRY
1670: }
1671:
1672: =pod
1673:
1.648 raeburn 1674: =item * &viewport_size_js()
1.590 raeburn 1675:
1676: 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.
1677:
1678: =cut
1679:
1680: sub viewport_size_js {
1681: my $geometry = &viewport_geometry_js();
1682: return <<"DIMS";
1683:
1684: $geometry
1685:
1686: function getViewportDims(width,height) {
1687: init_geometry();
1688: width.value = Geometry.getViewportWidth();
1689: height.value = Geometry.getViewportHeight();
1690: return;
1691: }
1692:
1693: DIMS
1694: }
1695:
1696: =pod
1697:
1.648 raeburn 1698: =item * &resize_textarea_js()
1.565 albertel 1699:
1700: emits the needed javascript to resize a textarea to be as big as possible
1701:
1702: creates a function resize_textrea that takes two IDs first should be
1703: the id of the element to resize, second should be the id of a div that
1704: surrounds everything that comes after the textarea, this routine needs
1705: to be attached to the <body> for the onload and onresize events.
1706:
1.648 raeburn 1707: =back
1.565 albertel 1708:
1709: =cut
1710:
1711: sub resize_textarea_js {
1.590 raeburn 1712: my $geometry = &viewport_geometry_js();
1.565 albertel 1713: return <<"RESIZE";
1714: <script type="text/javascript">
1.824 bisitz 1715: // <![CDATA[
1.590 raeburn 1716: $geometry
1.565 albertel 1717:
1.588 albertel 1718: function getX(element) {
1719: var x = 0;
1720: while (element) {
1721: x += element.offsetLeft;
1722: element = element.offsetParent;
1723: }
1724: return x;
1725: }
1726: function getY(element) {
1727: var y = 0;
1728: while (element) {
1729: y += element.offsetTop;
1730: element = element.offsetParent;
1731: }
1732: return y;
1733: }
1734:
1735:
1.565 albertel 1736: function resize_textarea(textarea_id,bottom_id) {
1737: init_geometry();
1738: var textarea = document.getElementById(textarea_id);
1739: //alert(textarea);
1740:
1.588 albertel 1741: var textarea_top = getY(textarea);
1.565 albertel 1742: var textarea_height = textarea.offsetHeight;
1743: var bottom = document.getElementById(bottom_id);
1.588 albertel 1744: var bottom_top = getY(bottom);
1.565 albertel 1745: var bottom_height = bottom.offsetHeight;
1746: var window_height = Geometry.getViewportHeight();
1.588 albertel 1747: var fudge = 23;
1.565 albertel 1748: var new_height = window_height-fudge-textarea_top-bottom_height;
1749: if (new_height < 300) {
1750: new_height = 300;
1751: }
1752: textarea.style.height=new_height+'px';
1753: }
1.824 bisitz 1754: // ]]>
1.565 albertel 1755: </script>
1756: RESIZE
1757:
1758: }
1759:
1.1205 golterma 1760: sub colorfuleditor_js {
1761: return <<"COLORFULEDIT"
1762: <script type="text/javascript">
1763: // <![CDATA[>
1764: function fold_box(curDepth, lastresource){
1765:
1766: // we need a list because there can be several blocks you need to fold in one tag
1767: var block = document.getElementsByName('foldblock_'+curDepth);
1768: // but there is only one folding button per tag
1769: var foldbutton = document.getElementById('folding_btn_'+curDepth);
1770:
1771: if(block.item(0).style.display == 'none'){
1772:
1773: foldbutton.value = '@{[&mt("Hide")]}';
1774: for (i = 0; i < block.length; i++){
1775: block.item(i).style.display = '';
1776: }
1777: }else{
1778:
1779: foldbutton.value = '@{[&mt("Show")]}';
1780: for (i = 0; i < block.length; i++){
1781: // block.item(i).style.visibility = 'collapse';
1782: block.item(i).style.display = 'none';
1783: }
1784: };
1785: saveState(lastresource);
1786: }
1787:
1788: function saveState (lastresource) {
1789:
1790: var tag_list = getTagList();
1791: if(tag_list != null){
1792: var timestamp = new Date().getTime();
1793: var key = lastresource;
1794:
1795: // the value pattern is: 'time;key1,value1;key2,value2; ... '
1796: // starting with timestamp
1797: var value = timestamp+';';
1798:
1799: // building the list of key-value pairs
1800: for(var i = 0; i < tag_list.length; i++){
1801: value += tag_list[i]+',';
1802: value += document.getElementsByName(tag_list[i])[0].style.display+';';
1803: }
1804:
1805: // only iterate whole storage if nothing to override
1806: if(localStorage.getItem(key) == null){
1807:
1808: // prevent storage from growing large
1809: if(localStorage.length > 50){
1810: var regex_getTimestamp = /^(?:\d)+;/;
1811: var oldest_timestamp = regex_getTimestamp.exec(localStorage.key(0));
1812: var oldest_key;
1813:
1814: for(var i = 1; i < localStorage.length; i++){
1815: if (regex_getTimestamp.exec(localStorage.key(i)) < oldest_timestamp) {
1816: oldest_key = localStorage.key(i);
1817: oldest_timestamp = regex_getTimestamp.exec(oldest_key);
1818: }
1819: }
1820: localStorage.removeItem(oldest_key);
1821: }
1822: }
1823: localStorage.setItem(key,value);
1824: }
1825: }
1826:
1827: // restore folding status of blocks (on page load)
1828: function restoreState (lastresource) {
1829: if(localStorage.getItem(lastresource) != null){
1830: var key = lastresource;
1831: var value = localStorage.getItem(key);
1832: var regex_delTimestamp = /^\d+;/;
1833:
1834: value.replace(regex_delTimestamp, '');
1835:
1836: var valueArr = value.split(';');
1837: var pairs;
1838: var elements;
1839: for (var i = 0; i < valueArr.length; i++){
1840: pairs = valueArr[i].split(',');
1841: elements = document.getElementsByName(pairs[0]);
1842:
1843: for (var j = 0; j < elements.length; j++){
1844: elements[j].style.display = pairs[1];
1845: if (pairs[1] == "none"){
1846: var regex_id = /([_\\d]+)\$/;
1847: regex_id.exec(pairs[0]);
1848: document.getElementById("folding_btn"+RegExp.\$1).value = "Show";
1849: }
1850: }
1851: }
1852: }
1853: }
1854:
1855: function getTagList () {
1856:
1857: var stringToSearch = document.lonhomework.innerHTML;
1858:
1859: var ret = new Array();
1860: var regex_findBlock = /(foldblock_.*?)"/g;
1861: var tag_list = stringToSearch.match(regex_findBlock);
1862:
1863: if(tag_list != null){
1864: for(var i = 0; i < tag_list.length; i++){
1865: ret.push(tag_list[i].replace(/"/, ''));
1866: }
1867: }
1868: return ret;
1869: }
1870:
1871: function saveScrollPosition (resource) {
1872: var tag_list = getTagList();
1873:
1874: // we dont always want to jump to the first block
1875: // 170 is roughly above the "Problem Editing" header. we just want to save if the user scrolled down further than this
1876: if(\$(window).scrollTop() > 170){
1877: if(tag_list != null){
1878: var result;
1879: for(var i = 0; i < tag_list.length; i++){
1880: if(isElementInViewport(tag_list[i])){
1881: result += tag_list[i]+';';
1882: }
1883: }
1884: sessionStorage.setItem('anchor_'+resource, result);
1885: }
1886: } else {
1887: // we dont need to save zero, just delete the item to leave everything tidy
1888: sessionStorage.removeItem('anchor_'+resource);
1889: }
1890: }
1891:
1892: function restoreScrollPosition(resource){
1893:
1894: var elem = sessionStorage.getItem('anchor_'+resource);
1895: if(elem != null){
1896: var tag_list = elem.split(';');
1897: var elem_list;
1898:
1899: for(var i = 0; i < tag_list.length; i++){
1900: elem_list = document.getElementsByName(tag_list[i]);
1901:
1902: if(elem_list.length > 0){
1903: elem = elem_list[0];
1904: break;
1905: }
1906: }
1907: elem.scrollIntoView();
1908: }
1909: }
1910:
1911: function isElementInViewport(el) {
1912:
1913: // change to last element instead of first
1914: var elem = document.getElementsByName(el);
1915: var rect = elem[0].getBoundingClientRect();
1916:
1917: return (
1918: rect.top >= 0 &&
1919: rect.left >= 0 &&
1920: rect.bottom <= (window.innerHeight || document.documentElement.clientHeight) && /*or $(window).height() */
1921: rect.right <= (window.innerWidth || document.documentElement.clientWidth) /*or $(window).width() */
1922: );
1923: }
1924:
1925: function autosize(depth){
1926: var cmInst = window['cm'+depth];
1927: var fitsizeButton = document.getElementById('fitsize'+depth);
1928:
1929: // is fixed size, switching to dynamic
1930: if (sessionStorage.getItem("autosized_"+depth) == null) {
1931: cmInst.setSize("","auto");
1932: fitsizeButton.value = "@{[&mt('Fixed size')]}";
1933: sessionStorage.setItem("autosized_"+depth, "yes");
1934:
1935: // is dynamic size, switching to fixed
1936: } else {
1937: cmInst.setSize("","300px");
1938: fitsizeButton.value = "@{[&mt('Dynamic size')]}";
1939: sessionStorage.removeItem("autosized_"+depth);
1940: }
1941: }
1942:
1943:
1944:
1945: // ]]>
1946: </script>
1947: COLORFULEDIT
1948: }
1949:
1950: sub xmleditor_js {
1951: return <<XMLEDIT
1952: <script type="text/javascript" src="/adm/jQuery/addons/jquery-scrolltofixed.js"></script>
1953: <script type="text/javascript">
1954: // <![CDATA[>
1955:
1956: function saveScrollPosition (resource) {
1957:
1958: var scrollPos = \$(window).scrollTop();
1959: sessionStorage.setItem(resource,scrollPos);
1960: }
1961:
1962: function restoreScrollPosition(resource){
1963:
1964: var scrollPos = sessionStorage.getItem(resource);
1965: \$(window).scrollTop(scrollPos);
1966: }
1967:
1968: // unless internet explorer
1969: if (!(window.navigator.appName == "Microsoft Internet Explorer" && (document.documentMode || document.compatMode))){
1970:
1971: \$(document).ready(function() {
1972: \$(".LC_edit_actionbar").scrollToFixed(\{zIndex: 100\});
1973: });
1974: }
1975:
1976: // inserts text at cursor position into codemirror (xml editor only)
1977: function insertText(text){
1978: cm.focus();
1979: var curPos = cm.getCursor();
1980: cm.replaceRange(text.replace(/ESCAPEDSCRIPT/g,'script'), {line: curPos.line,ch: curPos.ch});
1981: }
1982: // ]]>
1983: </script>
1984: XMLEDIT
1985: }
1986:
1987: sub insert_folding_button {
1988: my $curDepth = $Apache::lonxml::curdepth;
1989: my $lastresource = $env{'request.ambiguous'};
1990:
1991: return "<input type=\"button\" id=\"folding_btn_$curDepth\"
1992: value=\"".&mt('Hide')."\" onclick=\"fold_box('$curDepth','$lastresource')\">";
1993: }
1994:
1.565 albertel 1995: =pod
1996:
1.256 matthew 1997: =head1 Excel and CSV file utility routines
1998:
1999: =cut
2000:
2001: ###############################################################
2002: ###############################################################
2003:
2004: =pod
2005:
1.1162 raeburn 2006: =over 4
2007:
1.648 raeburn 2008: =item * &csv_translate($text)
1.37 matthew 2009:
1.185 www 2010: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 2011: format.
2012:
2013: =cut
2014:
1.180 matthew 2015: ###############################################################
2016: ###############################################################
1.37 matthew 2017: sub csv_translate {
2018: my $text = shift;
2019: $text =~ s/\"/\"\"/g;
1.209 albertel 2020: $text =~ s/\n/ /g;
1.37 matthew 2021: return $text;
2022: }
1.180 matthew 2023:
2024: ###############################################################
2025: ###############################################################
2026:
2027: =pod
2028:
1.648 raeburn 2029: =item * &define_excel_formats()
1.180 matthew 2030:
2031: Define some commonly used Excel cell formats.
2032:
2033: Currently supported formats:
2034:
2035: =over 4
2036:
2037: =item header
2038:
2039: =item bold
2040:
2041: =item h1
2042:
2043: =item h2
2044:
2045: =item h3
2046:
1.256 matthew 2047: =item h4
2048:
2049: =item i
2050:
1.180 matthew 2051: =item date
2052:
2053: =back
2054:
2055: Inputs: $workbook
2056:
2057: Returns: $format, a hash reference.
2058:
1.1057 foxr 2059:
1.180 matthew 2060: =cut
2061:
2062: ###############################################################
2063: ###############################################################
2064: sub define_excel_formats {
2065: my ($workbook) = @_;
2066: my $format;
2067: $format->{'header'} = $workbook->add_format(bold => 1,
2068: bottom => 1,
2069: align => 'center');
2070: $format->{'bold'} = $workbook->add_format(bold=>1);
2071: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
2072: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
2073: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 2074: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 2075: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 2076: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 2077: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 2078: return $format;
2079: }
2080:
2081: ###############################################################
2082: ###############################################################
1.113 bowersj2 2083:
2084: =pod
2085:
1.648 raeburn 2086: =item * &create_workbook()
1.255 matthew 2087:
2088: Create an Excel worksheet. If it fails, output message on the
2089: request object and return undefs.
2090:
2091: Inputs: Apache request object
2092:
2093: Returns (undef) on failure,
2094: Excel worksheet object, scalar with filename, and formats
2095: from &Apache::loncommon::define_excel_formats on success
2096:
2097: =cut
2098:
2099: ###############################################################
2100: ###############################################################
2101: sub create_workbook {
2102: my ($r) = @_;
2103: #
2104: # Create the excel spreadsheet
2105: my $filename = '/prtspool/'.
1.258 albertel 2106: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 2107: time.'_'.rand(1000000000).'.xls';
2108: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
2109: if (! defined($workbook)) {
2110: $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928 bisitz 2111: $r->print(
2112: '<p class="LC_error">'
2113: .&mt('Problems occurred in creating the new Excel file.')
2114: .' '.&mt('This error has been logged.')
2115: .' '.&mt('Please alert your LON-CAPA administrator.')
2116: .'</p>'
2117: );
1.255 matthew 2118: return (undef);
2119: }
2120: #
1.1014 foxr 2121: $workbook->set_tempdir(LONCAPA::tempdir());
1.255 matthew 2122: #
2123: my $format = &Apache::loncommon::define_excel_formats($workbook);
2124: return ($workbook,$filename,$format);
2125: }
2126:
2127: ###############################################################
2128: ###############################################################
2129:
2130: =pod
2131:
1.648 raeburn 2132: =item * &create_text_file()
1.113 bowersj2 2133:
1.542 raeburn 2134: Create a file to write to and eventually make available to the user.
1.256 matthew 2135: If file creation fails, outputs an error message on the request object and
2136: return undefs.
1.113 bowersj2 2137:
1.256 matthew 2138: Inputs: Apache request object, and file suffix
1.113 bowersj2 2139:
1.256 matthew 2140: Returns (undef) on failure,
2141: Filehandle and filename on success.
1.113 bowersj2 2142:
2143: =cut
2144:
1.256 matthew 2145: ###############################################################
2146: ###############################################################
2147: sub create_text_file {
2148: my ($r,$suffix) = @_;
2149: if (! defined($suffix)) { $suffix = 'txt'; };
2150: my $fh;
2151: my $filename = '/prtspool/'.
1.258 albertel 2152: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 2153: time.'_'.rand(1000000000).'.'.$suffix;
2154: $fh = Apache::File->new('>/home/httpd'.$filename);
2155: if (! defined($fh)) {
2156: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 2157: $r->print(
2158: '<p class="LC_error">'
2159: .&mt('Problems occurred in creating the output file.')
2160: .' '.&mt('This error has been logged.')
2161: .' '.&mt('Please alert your LON-CAPA administrator.')
2162: .'</p>'
2163: );
1.113 bowersj2 2164: }
1.256 matthew 2165: return ($fh,$filename)
1.113 bowersj2 2166: }
2167:
2168:
1.256 matthew 2169: =pod
1.113 bowersj2 2170:
2171: =back
2172:
2173: =cut
1.37 matthew 2174:
2175: ###############################################################
1.33 matthew 2176: ## Home server <option> list generating code ##
2177: ###############################################################
1.35 matthew 2178:
1.169 www 2179: # ------------------------------------------
2180:
2181: sub domain_select {
2182: my ($name,$value,$multiple)=@_;
2183: my %domains=map {
1.514 albertel 2184: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 2185: } &Apache::lonnet::all_domains();
1.169 www 2186: if ($multiple) {
2187: $domains{''}=&mt('Any domain');
1.550 albertel 2188: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 2189: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 2190: } else {
1.550 albertel 2191: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970 raeburn 2192: return &select_form($name,$value,\%domains);
1.169 www 2193: }
2194: }
2195:
1.282 albertel 2196: #-------------------------------------------
2197:
2198: =pod
2199:
1.519 raeburn 2200: =head1 Routines for form select boxes
2201:
2202: =over 4
2203:
1.648 raeburn 2204: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 2205:
2206: Returns a string containing a <select> element int multiple mode
2207:
2208:
2209: Args:
2210: $name - name of the <select> element
1.506 raeburn 2211: $value - scalar or array ref of values that should already be selected
1.282 albertel 2212: $size - number of rows long the select element is
1.283 albertel 2213: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 2214: (shown text should already have been &mt())
1.506 raeburn 2215: $order - (optional) array ref of the order to show the elements in
1.283 albertel 2216:
1.282 albertel 2217: =cut
2218:
2219: #-------------------------------------------
1.169 www 2220: sub multiple_select_form {
1.284 albertel 2221: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 2222: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
2223: my $output='';
1.191 matthew 2224: if (! defined($size)) {
2225: $size = 4;
1.283 albertel 2226: if (scalar(keys(%$hash))<4) {
2227: $size = scalar(keys(%$hash));
1.191 matthew 2228: }
2229: }
1.734 bisitz 2230: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 2231: my @order;
1.506 raeburn 2232: if (ref($order) eq 'ARRAY') {
2233: @order = @{$order};
2234: } else {
2235: @order = sort(keys(%$hash));
1.501 banghart 2236: }
2237: if (exists($$hash{'select_form_order'})) {
2238: @order = @{$$hash{'select_form_order'}};
2239: }
2240:
1.284 albertel 2241: foreach my $key (@order) {
1.356 albertel 2242: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 2243: $output.='selected="selected" ' if ($selected{$key});
2244: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 2245: }
2246: $output.="</select>\n";
2247: return $output;
2248: }
2249:
1.88 www 2250: #-------------------------------------------
2251:
2252: =pod
2253:
1.970 raeburn 2254: =item * &select_form($defdom,$name,$hashref,$onchange)
1.88 www 2255:
2256: Returns a string containing a <select name='$name' size='1'> form to
1.970 raeburn 2257: allow a user to select options from a ref to a hash containing:
2258: option_name => displayed text. An optional $onchange can include
2259: a javascript onchange item, e.g., onchange="this.form.submit();"
2260:
1.88 www 2261: See lonrights.pm for an example invocation and use.
2262:
2263: =cut
2264:
2265: #-------------------------------------------
2266: sub select_form {
1.970 raeburn 2267: my ($def,$name,$hashref,$onchange) = @_;
2268: return unless (ref($hashref) eq 'HASH');
2269: if ($onchange) {
2270: $onchange = ' onchange="'.$onchange.'"';
2271: }
2272: my $selectform = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.128 albertel 2273: my @keys;
1.970 raeburn 2274: if (exists($hashref->{'select_form_order'})) {
2275: @keys=@{$hashref->{'select_form_order'}};
1.128 albertel 2276: } else {
1.970 raeburn 2277: @keys=sort(keys(%{$hashref}));
1.128 albertel 2278: }
1.356 albertel 2279: foreach my $key (@keys) {
2280: $selectform.=
2281: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
2282: ($key eq $def ? 'selected="selected" ' : '').
1.970 raeburn 2283: ">".$hashref->{$key}."</option>\n";
1.88 www 2284: }
2285: $selectform.="</select>";
2286: return $selectform;
2287: }
2288:
1.475 www 2289: # For display filters
2290:
2291: sub display_filter {
1.1074 raeburn 2292: my ($context) = @_;
1.475 www 2293: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 2294: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.1074 raeburn 2295: my $phraseinput = 'hidden';
2296: my $includeinput = 'hidden';
2297: my ($checked,$includetypestext);
2298: if ($env{'form.displayfilter'} eq 'containing') {
2299: $phraseinput = 'text';
2300: if ($context eq 'parmslog') {
2301: $includeinput = 'checkbox';
2302: if ($env{'form.includetypes'}) {
2303: $checked = ' checked="checked"';
2304: }
2305: $includetypestext = &mt('Include parameter types');
2306: }
2307: } else {
2308: $includetypestext = ' ';
2309: }
2310: my ($additional,$secondid,$thirdid);
2311: if ($context eq 'parmslog') {
2312: $additional =
2313: '<label><input type="'.$includeinput.'" name="includetypes"'.
2314: $checked.' name="includetypes" value="1" id="includetypes" />'.
2315: ' <span id="includetypestext">'.$includetypestext.'</span>'.
2316: '</label>';
2317: $secondid = 'includetypes';
2318: $thirdid = 'includetypestext';
2319: }
2320: my $onchange = "javascript:toggleHistoryOptions(this,'containingphrase','$context',
2321: '$secondid','$thirdid')";
2322: return '<span class="LC_nobreak"><label>'.&mt('Records: [_1]',
1.475 www 2323: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
2324: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 2325: '</label></span> <span class="LC_nobreak">'.
1.1074 raeburn 2326: &mt('Filter: [_1]',
1.477 www 2327: &select_form($env{'form.displayfilter'},
2328: 'displayfilter',
1.970 raeburn 2329: {'currentfolder' => 'Current folder/page',
1.477 www 2330: 'containing' => 'Containing phrase',
1.1074 raeburn 2331: 'none' => 'None'},$onchange)).' '.
2332: '<input type="'.$phraseinput.'" name="containingphrase" id="containingphrase" size="30" value="'.
2333: &HTML::Entities::encode($env{'form.containingphrase'}).
2334: '" />'.$additional;
2335: }
2336:
2337: sub display_filter_js {
2338: my $includetext = &mt('Include parameter types');
2339: return <<"ENDJS";
2340:
2341: function toggleHistoryOptions(setter,firstid,context,secondid,thirdid) {
2342: var firstType = 'hidden';
2343: if (setter.options[setter.selectedIndex].value == 'containing') {
2344: firstType = 'text';
2345: }
2346: firstObject = document.getElementById(firstid);
2347: if (typeof(firstObject) == 'object') {
2348: if (firstObject.type != firstType) {
2349: changeInputType(firstObject,firstType);
2350: }
2351: }
2352: if (context == 'parmslog') {
2353: var secondType = 'hidden';
2354: if (firstType == 'text') {
2355: secondType = 'checkbox';
2356: }
2357: secondObject = document.getElementById(secondid);
2358: if (typeof(secondObject) == 'object') {
2359: if (secondObject.type != secondType) {
2360: changeInputType(secondObject,secondType);
2361: }
2362: }
2363: var textItem = document.getElementById(thirdid);
2364: var currtext = textItem.innerHTML;
2365: var newtext;
2366: if (firstType == 'text') {
2367: newtext = '$includetext';
2368: } else {
2369: newtext = ' ';
2370: }
2371: if (currtext != newtext) {
2372: textItem.innerHTML = newtext;
2373: }
2374: }
2375: return;
2376: }
2377:
2378: function changeInputType(oldObject,newType) {
2379: var newObject = document.createElement('input');
2380: newObject.type = newType;
2381: if (oldObject.size) {
2382: newObject.size = oldObject.size;
2383: }
2384: if (oldObject.value) {
2385: newObject.value = oldObject.value;
2386: }
2387: if (oldObject.name) {
2388: newObject.name = oldObject.name;
2389: }
2390: if (oldObject.id) {
2391: newObject.id = oldObject.id;
2392: }
2393: oldObject.parentNode.replaceChild(newObject,oldObject);
2394: return;
2395: }
2396:
2397: ENDJS
1.475 www 2398: }
2399:
1.167 www 2400: sub gradeleveldescription {
2401: my $gradelevel=shift;
2402: my %gradelevels=(0 => 'Not specified',
2403: 1 => 'Grade 1',
2404: 2 => 'Grade 2',
2405: 3 => 'Grade 3',
2406: 4 => 'Grade 4',
2407: 5 => 'Grade 5',
2408: 6 => 'Grade 6',
2409: 7 => 'Grade 7',
2410: 8 => 'Grade 8',
2411: 9 => 'Grade 9',
2412: 10 => 'Grade 10',
2413: 11 => 'Grade 11',
2414: 12 => 'Grade 12',
2415: 13 => 'Grade 13',
2416: 14 => '100 Level',
2417: 15 => '200 Level',
2418: 16 => '300 Level',
2419: 17 => '400 Level',
2420: 18 => 'Graduate Level');
2421: return &mt($gradelevels{$gradelevel});
2422: }
2423:
1.163 www 2424: sub select_level_form {
2425: my ($deflevel,$name)=@_;
2426: unless ($deflevel) { $deflevel=0; }
1.167 www 2427: my $selectform = "<select name=\"$name\" size=\"1\">\n";
2428: for (my $i=0; $i<=18; $i++) {
2429: $selectform.="<option value=\"$i\" ".
1.253 albertel 2430: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 2431: ">".&gradeleveldescription($i)."</option>\n";
2432: }
2433: $selectform.="</select>";
2434: return $selectform;
1.163 www 2435: }
1.167 www 2436:
1.35 matthew 2437: #-------------------------------------------
2438:
1.45 matthew 2439: =pod
2440:
1.1121 raeburn 2441: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms)
1.35 matthew 2442:
2443: Returns a string containing a <select name='$name' size='1'> form to
2444: allow a user to select the domain to preform an operation in.
2445: See loncreateuser.pm for an example invocation and use.
2446:
1.90 www 2447: If the $includeempty flag is set, it also includes an empty choice ("no domain
2448: selected");
2449:
1.743 raeburn 2450: If the $showdomdesc flag is set, the domain name is followed by the domain description.
2451:
1.910 raeburn 2452: 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.
2453:
1.1121 raeburn 2454: The optional $incdoms is a reference to an array of domains which will be the only available options.
2455:
2456: The optional $excdoms is a reference to an array of domains which will be excluded from the available options.
1.563 raeburn 2457:
1.35 matthew 2458: =cut
2459:
2460: #-------------------------------------------
1.34 matthew 2461: sub select_dom_form {
1.1121 raeburn 2462: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms) = @_;
1.872 raeburn 2463: if ($onchange) {
1.874 raeburn 2464: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 2465: }
1.1121 raeburn 2466: my (@domains,%exclude);
1.910 raeburn 2467: if (ref($incdoms) eq 'ARRAY') {
2468: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
2469: } else {
2470: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
2471: }
1.90 www 2472: if ($includeempty) { @domains=('',@domains); }
1.1121 raeburn 2473: if (ref($excdoms) eq 'ARRAY') {
2474: map { $exclude{$_} = 1; } @{$excdoms};
2475: }
1.743 raeburn 2476: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 2477: foreach my $dom (@domains) {
1.1121 raeburn 2478: next if ($exclude{$dom});
1.356 albertel 2479: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 2480: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
2481: if ($showdomdesc) {
2482: if ($dom ne '') {
2483: my $domdesc = &Apache::lonnet::domain($dom,'description');
2484: if ($domdesc ne '') {
2485: $selectdomain .= ' ('.$domdesc.')';
2486: }
2487: }
2488: }
2489: $selectdomain .= "</option>\n";
1.34 matthew 2490: }
2491: $selectdomain.="</select>";
2492: return $selectdomain;
2493: }
2494:
1.35 matthew 2495: #-------------------------------------------
2496:
1.45 matthew 2497: =pod
2498:
1.648 raeburn 2499: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 2500:
1.586 raeburn 2501: input: 4 arguments (two required, two optional) -
2502: $domain - domain of new user
2503: $name - name of form element
2504: $default - Value of 'default' causes a default item to be first
2505: option, and selected by default.
2506: $hide - Value of 'hide' causes hiding of the name of the server,
2507: if 1 server found, or default, if 0 found.
1.594 raeburn 2508: output: returns 2 items:
1.586 raeburn 2509: (a) form element which contains either:
2510: (i) <select name="$name">
2511: <option value="$hostid1">$hostid $servers{$hostid}</option>
2512: <option value="$hostid2">$hostid $servers{$hostid}</option>
2513: </select>
2514: form item if there are multiple library servers in $domain, or
2515: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2516: if there is only one library server in $domain.
2517:
2518: (b) number of library servers found.
2519:
2520: See loncreateuser.pm for example of use.
1.35 matthew 2521:
2522: =cut
2523:
2524: #-------------------------------------------
1.586 raeburn 2525: sub home_server_form_item {
2526: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2527: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2528: my $result;
2529: my $numlib = keys(%servers);
2530: if ($numlib > 1) {
2531: $result .= '<select name="'.$name.'" />'."\n";
2532: if ($default) {
1.804 bisitz 2533: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 2534: '</option>'."\n";
2535: }
2536: foreach my $hostid (sort(keys(%servers))) {
2537: $result.= '<option value="'.$hostid.'">'.
2538: $hostid.' '.$servers{$hostid}."</option>\n";
2539: }
2540: $result .= '</select>'."\n";
2541: } elsif ($numlib == 1) {
2542: my $hostid;
2543: foreach my $item (keys(%servers)) {
2544: $hostid = $item;
2545: }
2546: $result .= '<input type="hidden" name="'.$name.'" value="'.
2547: $hostid.'" />';
2548: if (!$hide) {
2549: $result .= $hostid.' '.$servers{$hostid};
2550: }
2551: $result .= "\n";
2552: } elsif ($default) {
2553: $result .= '<input type="hidden" name="'.$name.
2554: '" value="default" />';
2555: if (!$hide) {
2556: $result .= &mt('default');
2557: }
2558: $result .= "\n";
1.33 matthew 2559: }
1.586 raeburn 2560: return ($result,$numlib);
1.33 matthew 2561: }
1.112 bowersj2 2562:
2563: =pod
2564:
1.534 albertel 2565: =back
2566:
1.112 bowersj2 2567: =cut
1.87 matthew 2568:
2569: ###############################################################
1.112 bowersj2 2570: ## Decoding User Agent ##
1.87 matthew 2571: ###############################################################
2572:
2573: =pod
2574:
1.112 bowersj2 2575: =head1 Decoding the User Agent
2576:
2577: =over 4
2578:
2579: =item * &decode_user_agent()
1.87 matthew 2580:
2581: Inputs: $r
2582:
2583: Outputs:
2584:
2585: =over 4
2586:
1.112 bowersj2 2587: =item * $httpbrowser
1.87 matthew 2588:
1.112 bowersj2 2589: =item * $clientbrowser
1.87 matthew 2590:
1.112 bowersj2 2591: =item * $clientversion
1.87 matthew 2592:
1.112 bowersj2 2593: =item * $clientmathml
1.87 matthew 2594:
1.112 bowersj2 2595: =item * $clientunicode
1.87 matthew 2596:
1.112 bowersj2 2597: =item * $clientos
1.87 matthew 2598:
1.1137 raeburn 2599: =item * $clientmobile
2600:
1.1141 raeburn 2601: =item * $clientinfo
2602:
1.1194 raeburn 2603: =item * $clientosversion
2604:
1.87 matthew 2605: =back
2606:
1.157 matthew 2607: =back
2608:
1.87 matthew 2609: =cut
2610:
2611: ###############################################################
2612: ###############################################################
2613: sub decode_user_agent {
1.247 albertel 2614: my ($r)=@_;
1.87 matthew 2615: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2616: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2617: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2618: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2619: my $clientbrowser='unknown';
2620: my $clientversion='0';
2621: my $clientmathml='';
2622: my $clientunicode='0';
1.1137 raeburn 2623: my $clientmobile=0;
1.1194 raeburn 2624: my $clientosversion='';
1.87 matthew 2625: for (my $i=0;$i<=$#browsertype;$i++) {
1.1193 raeburn 2626: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\%/,$browsertype[$i]);
1.87 matthew 2627: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2628: $clientbrowser=$bname;
2629: $httpbrowser=~/$vreg/i;
2630: $clientversion=$1;
2631: $clientmathml=($clientversion>=$minv);
2632: $clientunicode=($clientversion>=$univ);
2633: }
2634: }
2635: my $clientos='unknown';
1.1141 raeburn 2636: my $clientinfo;
1.87 matthew 2637: if (($httpbrowser=~/linux/i) ||
2638: ($httpbrowser=~/unix/i) ||
2639: ($httpbrowser=~/ux/i) ||
2640: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2641: if (($httpbrowser=~/vax/i) ||
2642: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2643: if ($httpbrowser=~/next/i) { $clientos='next'; }
2644: if (($httpbrowser=~/mac/i) ||
2645: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1.1194 raeburn 2646: if ($httpbrowser=~/win/i) {
2647: $clientos='win';
2648: if ($httpbrowser =~/Windows\s+NT\s+(\d+\.\d+)/i) {
2649: $clientosversion = $1;
2650: }
2651: }
1.87 matthew 2652: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1.1137 raeburn 2653: if ($httpbrowser=~/(Android|iPod|iPad|iPhone|webOS|Blackberry|Windows Phone|Opera m(?:ob|in)|Fennec)/i) {
2654: $clientmobile=lc($1);
2655: }
1.1141 raeburn 2656: if ($httpbrowser=~ m{Firefox/(\d+\.\d+)}) {
2657: $clientinfo = 'firefox-'.$1;
2658: } elsif ($httpbrowser=~ m{chromeframe/(\d+\.\d+)\.}) {
2659: $clientinfo = 'chromeframe-'.$1;
2660: }
1.87 matthew 2661: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1.1194 raeburn 2662: $clientunicode,$clientos,$clientmobile,$clientinfo,
2663: $clientosversion);
1.87 matthew 2664: }
2665:
1.32 matthew 2666: ###############################################################
2667: ## Authentication changing form generation subroutines ##
2668: ###############################################################
2669: ##
2670: ## All of the authform_xxxxxxx subroutines take their inputs in a
2671: ## hash, and have reasonable default values.
2672: ##
2673: ## formname = the name given in the <form> tag.
1.35 matthew 2674: #-------------------------------------------
2675:
1.45 matthew 2676: =pod
2677:
1.112 bowersj2 2678: =head1 Authentication Routines
2679:
2680: =over 4
2681:
1.648 raeburn 2682: =item * &authform_xxxxxx()
1.35 matthew 2683:
2684: The authform_xxxxxx subroutines provide javascript and html forms which
2685: handle some of the conveniences required for authentication forms.
2686: This is not an optimal method, but it works.
2687:
2688: =over 4
2689:
1.112 bowersj2 2690: =item * authform_header
1.35 matthew 2691:
1.112 bowersj2 2692: =item * authform_authorwarning
1.35 matthew 2693:
1.112 bowersj2 2694: =item * authform_nochange
1.35 matthew 2695:
1.112 bowersj2 2696: =item * authform_kerberos
1.35 matthew 2697:
1.112 bowersj2 2698: =item * authform_internal
1.35 matthew 2699:
1.112 bowersj2 2700: =item * authform_filesystem
1.35 matthew 2701:
2702: =back
2703:
1.648 raeburn 2704: See loncreateuser.pm for invocation and use examples.
1.157 matthew 2705:
1.35 matthew 2706: =cut
2707:
2708: #-------------------------------------------
1.32 matthew 2709: sub authform_header{
2710: my %in = (
2711: formname => 'cu',
1.80 albertel 2712: kerb_def_dom => '',
1.32 matthew 2713: @_,
2714: );
2715: $in{'formname'} = 'document.' . $in{'formname'};
2716: my $result='';
1.80 albertel 2717:
2718: #---------------------------------------------- Code for upper case translation
2719: my $Javascript_toUpperCase;
2720: unless ($in{kerb_def_dom}) {
2721: $Javascript_toUpperCase =<<"END";
2722: switch (choice) {
2723: case 'krb': currentform.elements[choicearg].value =
2724: currentform.elements[choicearg].value.toUpperCase();
2725: break;
2726: default:
2727: }
2728: END
2729: } else {
2730: $Javascript_toUpperCase = "";
2731: }
2732:
1.165 raeburn 2733: my $radioval = "'nochange'";
1.591 raeburn 2734: if (defined($in{'curr_authtype'})) {
2735: if ($in{'curr_authtype'} ne '') {
2736: $radioval = "'".$in{'curr_authtype'}."arg'";
2737: }
1.174 matthew 2738: }
1.165 raeburn 2739: my $argfield = 'null';
1.591 raeburn 2740: if (defined($in{'mode'})) {
1.165 raeburn 2741: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2742: if (defined($in{'curr_autharg'})) {
2743: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2744: $argfield = "'$in{'curr_autharg'}'";
2745: }
2746: }
2747: }
2748: }
2749:
1.32 matthew 2750: $result.=<<"END";
2751: var current = new Object();
1.165 raeburn 2752: current.radiovalue = $radioval;
2753: current.argfield = $argfield;
1.32 matthew 2754:
2755: function changed_radio(choice,currentform) {
2756: var choicearg = choice + 'arg';
2757: // If a radio button in changed, we need to change the argfield
2758: if (current.radiovalue != choice) {
2759: current.radiovalue = choice;
2760: if (current.argfield != null) {
2761: currentform.elements[current.argfield].value = '';
2762: }
2763: if (choice == 'nochange') {
2764: current.argfield = null;
2765: } else {
2766: current.argfield = choicearg;
2767: switch(choice) {
2768: case 'krb':
2769: currentform.elements[current.argfield].value =
2770: "$in{'kerb_def_dom'}";
2771: break;
2772: default:
2773: break;
2774: }
2775: }
2776: }
2777: return;
2778: }
1.22 www 2779:
1.32 matthew 2780: function changed_text(choice,currentform) {
2781: var choicearg = choice + 'arg';
2782: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2783: $Javascript_toUpperCase
1.32 matthew 2784: // clear old field
2785: if ((current.argfield != choicearg) && (current.argfield != null)) {
2786: currentform.elements[current.argfield].value = '';
2787: }
2788: current.argfield = choicearg;
2789: }
2790: set_auth_radio_buttons(choice,currentform);
2791: return;
1.20 www 2792: }
1.32 matthew 2793:
2794: function set_auth_radio_buttons(newvalue,currentform) {
1.986 raeburn 2795: var numauthchoices = currentform.login.length;
2796: if (typeof numauthchoices == "undefined") {
2797: return;
2798: }
1.32 matthew 2799: var i=0;
1.986 raeburn 2800: while (i < numauthchoices) {
1.32 matthew 2801: if (currentform.login[i].value == newvalue) { break; }
2802: i++;
2803: }
1.986 raeburn 2804: if (i == numauthchoices) {
1.32 matthew 2805: return;
2806: }
2807: current.radiovalue = newvalue;
2808: currentform.login[i].checked = true;
2809: return;
2810: }
2811: END
2812: return $result;
2813: }
2814:
1.1106 raeburn 2815: sub authform_authorwarning {
1.32 matthew 2816: my $result='';
1.144 matthew 2817: $result='<i>'.
2818: &mt('As a general rule, only authors or co-authors should be '.
2819: 'filesystem authenticated '.
2820: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2821: return $result;
2822: }
2823:
1.1106 raeburn 2824: sub authform_nochange {
1.32 matthew 2825: my %in = (
2826: formname => 'document.cu',
2827: kerb_def_dom => 'MSU.EDU',
2828: @_,
2829: );
1.1106 raeburn 2830: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.586 raeburn 2831: my $result;
1.1104 raeburn 2832: if (!$authnum) {
1.1105 raeburn 2833: $result = &mt('Under your current role you are not permitted to change login settings for this user');
1.586 raeburn 2834: } else {
2835: $result = '<label>'.&mt('[_1] Do not change login data',
2836: '<input type="radio" name="login" value="nochange" '.
2837: 'checked="checked" onclick="'.
1.281 albertel 2838: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2839: '</label>';
1.586 raeburn 2840: }
1.32 matthew 2841: return $result;
2842: }
2843:
1.591 raeburn 2844: sub authform_kerberos {
1.32 matthew 2845: my %in = (
2846: formname => 'document.cu',
2847: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2848: kerb_def_auth => 'krb4',
1.32 matthew 2849: @_,
2850: );
1.586 raeburn 2851: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2852: $autharg,$jscall);
1.1106 raeburn 2853: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2854: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2855: $check5 = ' checked="checked"';
1.80 albertel 2856: } else {
1.772 bisitz 2857: $check4 = ' checked="checked"';
1.80 albertel 2858: }
1.165 raeburn 2859: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2860: if (defined($in{'curr_authtype'})) {
2861: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2862: $krbcheck = ' checked="checked"';
1.623 raeburn 2863: if (defined($in{'mode'})) {
2864: if ($in{'mode'} eq 'modifyuser') {
2865: $krbcheck = '';
2866: }
2867: }
1.591 raeburn 2868: if (defined($in{'curr_kerb_ver'})) {
2869: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2870: $check5 = ' checked="checked"';
1.591 raeburn 2871: $check4 = '';
2872: } else {
1.772 bisitz 2873: $check4 = ' checked="checked"';
1.591 raeburn 2874: $check5 = '';
2875: }
1.586 raeburn 2876: }
1.591 raeburn 2877: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2878: $krbarg = $in{'curr_autharg'};
2879: }
1.586 raeburn 2880: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2881: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2882: $result =
2883: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2884: $in{'curr_autharg'},$krbver);
2885: } else {
2886: $result =
2887: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2888: }
2889: return $result;
2890: }
2891: }
2892: } else {
2893: if ($authnum == 1) {
1.784 bisitz 2894: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2895: }
2896: }
1.586 raeburn 2897: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2898: return;
1.587 raeburn 2899: } elsif ($authtype eq '') {
1.591 raeburn 2900: if (defined($in{'mode'})) {
1.587 raeburn 2901: if ($in{'mode'} eq 'modifycourse') {
2902: if ($authnum == 1) {
1.1104 raeburn 2903: $authtype = '<input type="radio" name="login" value="krb" />';
1.587 raeburn 2904: }
2905: }
2906: }
1.586 raeburn 2907: }
2908: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2909: if ($authtype eq '') {
2910: $authtype = '<input type="radio" name="login" value="krb" '.
2911: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2912: $krbcheck.' />';
2913: }
2914: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
1.1106 raeburn 2915: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
1.586 raeburn 2916: $in{'curr_authtype'} eq 'krb5') ||
1.1106 raeburn 2917: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
1.586 raeburn 2918: $in{'curr_authtype'} eq 'krb4')) {
2919: $result .= &mt
1.144 matthew 2920: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2921: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2922: '<label>'.$authtype,
1.281 albertel 2923: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2924: 'value="'.$krbarg.'" '.
1.144 matthew 2925: 'onchange="'.$jscall.'" />',
1.281 albertel 2926: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2927: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2928: '</label>');
1.586 raeburn 2929: } elsif ($can_assign{'krb4'}) {
2930: $result .= &mt
2931: ('[_1] Kerberos authenticated with domain [_2] '.
2932: '[_3] Version 4 [_4]',
2933: '<label>'.$authtype,
2934: '</label><input type="text" size="10" name="krbarg" '.
2935: 'value="'.$krbarg.'" '.
2936: 'onchange="'.$jscall.'" />',
2937: '<label><input type="hidden" name="krbver" value="4" />',
2938: '</label>');
2939: } elsif ($can_assign{'krb5'}) {
2940: $result .= &mt
2941: ('[_1] Kerberos authenticated with domain [_2] '.
2942: '[_3] Version 5 [_4]',
2943: '<label>'.$authtype,
2944: '</label><input type="text" size="10" name="krbarg" '.
2945: 'value="'.$krbarg.'" '.
2946: 'onchange="'.$jscall.'" />',
2947: '<label><input type="hidden" name="krbver" value="5" />',
2948: '</label>');
2949: }
1.32 matthew 2950: return $result;
2951: }
2952:
1.1106 raeburn 2953: sub authform_internal {
1.586 raeburn 2954: my %in = (
1.32 matthew 2955: formname => 'document.cu',
2956: kerb_def_dom => 'MSU.EDU',
2957: @_,
2958: );
1.586 raeburn 2959: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
1.1106 raeburn 2960: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2961: if (defined($in{'curr_authtype'})) {
2962: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2963: if ($can_assign{'int'}) {
1.772 bisitz 2964: $intcheck = 'checked="checked" ';
1.623 raeburn 2965: if (defined($in{'mode'})) {
2966: if ($in{'mode'} eq 'modifyuser') {
2967: $intcheck = '';
2968: }
2969: }
1.591 raeburn 2970: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2971: $intarg = $in{'curr_autharg'};
2972: }
2973: } else {
2974: $result = &mt('Currently internally authenticated.');
2975: return $result;
1.165 raeburn 2976: }
2977: }
1.586 raeburn 2978: } else {
2979: if ($authnum == 1) {
1.784 bisitz 2980: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 2981: }
2982: }
2983: if (!$can_assign{'int'}) {
2984: return;
1.587 raeburn 2985: } elsif ($authtype eq '') {
1.591 raeburn 2986: if (defined($in{'mode'})) {
1.587 raeburn 2987: if ($in{'mode'} eq 'modifycourse') {
2988: if ($authnum == 1) {
1.1104 raeburn 2989: $authtype = '<input type="radio" name="login" value="int" />';
1.587 raeburn 2990: }
2991: }
2992: }
1.165 raeburn 2993: }
1.586 raeburn 2994: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2995: if ($authtype eq '') {
2996: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2997: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2998: }
1.605 bisitz 2999: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 3000: $intarg.'" onchange="'.$jscall.'" />';
3001: $result = &mt
1.144 matthew 3002: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 3003: '<label>'.$authtype,'</label>'.$autharg);
1.824 bisitz 3004: $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 3005: return $result;
3006: }
3007:
1.1104 raeburn 3008: sub authform_local {
1.32 matthew 3009: my %in = (
3010: formname => 'document.cu',
3011: kerb_def_dom => 'MSU.EDU',
3012: @_,
3013: );
1.586 raeburn 3014: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
1.1106 raeburn 3015: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 3016: if (defined($in{'curr_authtype'})) {
3017: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 3018: if ($can_assign{'loc'}) {
1.772 bisitz 3019: $loccheck = 'checked="checked" ';
1.623 raeburn 3020: if (defined($in{'mode'})) {
3021: if ($in{'mode'} eq 'modifyuser') {
3022: $loccheck = '';
3023: }
3024: }
1.591 raeburn 3025: if (defined($in{'curr_autharg'})) {
1.586 raeburn 3026: $locarg = $in{'curr_autharg'};
3027: }
3028: } else {
3029: $result = &mt('Currently using local (institutional) authentication.');
3030: return $result;
1.165 raeburn 3031: }
3032: }
1.586 raeburn 3033: } else {
3034: if ($authnum == 1) {
1.784 bisitz 3035: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 3036: }
3037: }
3038: if (!$can_assign{'loc'}) {
3039: return;
1.587 raeburn 3040: } elsif ($authtype eq '') {
1.591 raeburn 3041: if (defined($in{'mode'})) {
1.587 raeburn 3042: if ($in{'mode'} eq 'modifycourse') {
3043: if ($authnum == 1) {
1.1104 raeburn 3044: $authtype = '<input type="radio" name="login" value="loc" />';
1.587 raeburn 3045: }
3046: }
3047: }
1.165 raeburn 3048: }
1.586 raeburn 3049: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
3050: if ($authtype eq '') {
3051: $authtype = '<input type="radio" name="login" value="loc" '.
3052: $loccheck.' onchange="'.$jscall.'" onclick="'.
3053: $jscall.'" />';
3054: }
3055: $autharg = '<input type="text" size="10" name="locarg" value="'.
3056: $locarg.'" onchange="'.$jscall.'" />';
3057: $result = &mt('[_1] Local Authentication with argument [_2]',
3058: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 3059: return $result;
3060: }
3061:
1.1106 raeburn 3062: sub authform_filesystem {
1.32 matthew 3063: my %in = (
3064: formname => 'document.cu',
3065: kerb_def_dom => 'MSU.EDU',
3066: @_,
3067: );
1.586 raeburn 3068: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
1.1106 raeburn 3069: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 3070: if (defined($in{'curr_authtype'})) {
3071: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 3072: if ($can_assign{'fsys'}) {
1.772 bisitz 3073: $fsyscheck = 'checked="checked" ';
1.623 raeburn 3074: if (defined($in{'mode'})) {
3075: if ($in{'mode'} eq 'modifyuser') {
3076: $fsyscheck = '';
3077: }
3078: }
1.586 raeburn 3079: } else {
3080: $result = &mt('Currently Filesystem Authenticated.');
3081: return $result;
3082: }
3083: }
3084: } else {
3085: if ($authnum == 1) {
1.784 bisitz 3086: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 3087: }
3088: }
3089: if (!$can_assign{'fsys'}) {
3090: return;
1.587 raeburn 3091: } elsif ($authtype eq '') {
1.591 raeburn 3092: if (defined($in{'mode'})) {
1.587 raeburn 3093: if ($in{'mode'} eq 'modifycourse') {
3094: if ($authnum == 1) {
1.1104 raeburn 3095: $authtype = '<input type="radio" name="login" value="fsys" />';
1.587 raeburn 3096: }
3097: }
3098: }
1.586 raeburn 3099: }
3100: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
3101: if ($authtype eq '') {
3102: $authtype = '<input type="radio" name="login" value="fsys" '.
3103: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
3104: $jscall.'" />';
3105: }
3106: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
3107: ' onchange="'.$jscall.'" />';
3108: $result = &mt
1.144 matthew 3109: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 3110: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 3111: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 3112: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 3113: 'onchange="'.$jscall.'" />');
1.32 matthew 3114: return $result;
3115: }
3116:
1.586 raeburn 3117: sub get_assignable_auth {
3118: my ($dom) = @_;
3119: if ($dom eq '') {
3120: $dom = $env{'request.role.domain'};
3121: }
3122: my %can_assign = (
3123: krb4 => 1,
3124: krb5 => 1,
3125: int => 1,
3126: loc => 1,
3127: );
3128: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
3129: if (ref($domconfig{'usercreation'}) eq 'HASH') {
3130: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
3131: my $authhash = $domconfig{'usercreation'}{'authtypes'};
3132: my $context;
3133: if ($env{'request.role'} =~ /^au/) {
3134: $context = 'author';
3135: } elsif ($env{'request.role'} =~ /^dc/) {
3136: $context = 'domain';
3137: } elsif ($env{'request.course.id'}) {
3138: $context = 'course';
3139: }
3140: if ($context) {
3141: if (ref($authhash->{$context}) eq 'HASH') {
3142: %can_assign = %{$authhash->{$context}};
3143: }
3144: }
3145: }
3146: }
3147: my $authnum = 0;
3148: foreach my $key (keys(%can_assign)) {
3149: if ($can_assign{$key}) {
3150: $authnum ++;
3151: }
3152: }
3153: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
3154: $authnum --;
3155: }
3156: return ($authnum,%can_assign);
3157: }
3158:
1.80 albertel 3159: ###############################################################
3160: ## Get Kerberos Defaults for Domain ##
3161: ###############################################################
3162: ##
3163: ## Returns default kerberos version and an associated argument
3164: ## as listed in file domain.tab. If not listed, provides
3165: ## appropriate default domain and kerberos version.
3166: ##
3167: #-------------------------------------------
3168:
3169: =pod
3170:
1.648 raeburn 3171: =item * &get_kerberos_defaults()
1.80 albertel 3172:
3173: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 3174: version and domain. If not found, it defaults to version 4 and the
3175: domain of the server.
1.80 albertel 3176:
1.648 raeburn 3177: =over 4
3178:
1.80 albertel 3179: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
3180:
1.648 raeburn 3181: =back
3182:
3183: =back
3184:
1.80 albertel 3185: =cut
3186:
3187: #-------------------------------------------
3188: sub get_kerberos_defaults {
3189: my $domain=shift;
1.641 raeburn 3190: my ($krbdef,$krbdefdom);
3191: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
3192: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
3193: $krbdef = $domdefaults{'auth_def'};
3194: $krbdefdom = $domdefaults{'auth_arg_def'};
3195: } else {
1.80 albertel 3196: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
3197: my $krbdefdom=$1;
3198: $krbdefdom=~tr/a-z/A-Z/;
3199: $krbdef = "krb4";
3200: }
3201: return ($krbdef,$krbdefdom);
3202: }
1.112 bowersj2 3203:
1.32 matthew 3204:
1.46 matthew 3205: ###############################################################
3206: ## Thesaurus Functions ##
3207: ###############################################################
1.20 www 3208:
1.46 matthew 3209: =pod
1.20 www 3210:
1.112 bowersj2 3211: =head1 Thesaurus Functions
3212:
3213: =over 4
3214:
1.648 raeburn 3215: =item * &initialize_keywords()
1.46 matthew 3216:
3217: Initializes the package variable %Keywords if it is empty. Uses the
3218: package variable $thesaurus_db_file.
3219:
3220: =cut
3221:
3222: ###################################################
3223:
3224: sub initialize_keywords {
3225: return 1 if (scalar keys(%Keywords));
3226: # If we are here, %Keywords is empty, so fill it up
3227: # Make sure the file we need exists...
3228: if (! -e $thesaurus_db_file) {
3229: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
3230: " failed because it does not exist");
3231: return 0;
3232: }
3233: # Set up the hash as a database
3234: my %thesaurus_db;
3235: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 3236: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 3237: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
3238: $thesaurus_db_file);
3239: return 0;
3240: }
3241: # Get the average number of appearances of a word.
3242: my $avecount = $thesaurus_db{'average.count'};
3243: # Put keywords (those that appear > average) into %Keywords
3244: while (my ($word,$data)=each (%thesaurus_db)) {
3245: my ($count,undef) = split /:/,$data;
3246: $Keywords{$word}++ if ($count > $avecount);
3247: }
3248: untie %thesaurus_db;
3249: # Remove special values from %Keywords.
1.356 albertel 3250: foreach my $value ('total.count','average.count') {
3251: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 3252: }
1.46 matthew 3253: return 1;
3254: }
3255:
3256: ###################################################
3257:
3258: =pod
3259:
1.648 raeburn 3260: =item * &keyword($word)
1.46 matthew 3261:
3262: Returns true if $word is a keyword. A keyword is a word that appears more
3263: than the average number of times in the thesaurus database. Calls
3264: &initialize_keywords
3265:
3266: =cut
3267:
3268: ###################################################
1.20 www 3269:
3270: sub keyword {
1.46 matthew 3271: return if (!&initialize_keywords());
3272: my $word=lc(shift());
3273: $word=~s/\W//g;
3274: return exists($Keywords{$word});
1.20 www 3275: }
1.46 matthew 3276:
3277: ###############################################################
3278:
3279: =pod
1.20 www 3280:
1.648 raeburn 3281: =item * &get_related_words()
1.46 matthew 3282:
1.160 matthew 3283: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 3284: an array of words. If the keyword is not in the thesaurus, an empty array
3285: will be returned. The order of the words returned is determined by the
3286: database which holds them.
3287:
3288: Uses global $thesaurus_db_file.
3289:
1.1057 foxr 3290:
1.46 matthew 3291: =cut
3292:
3293: ###############################################################
3294: sub get_related_words {
3295: my $keyword = shift;
3296: my %thesaurus_db;
3297: if (! -e $thesaurus_db_file) {
3298: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
3299: "failed because the file does not exist");
3300: return ();
3301: }
3302: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 3303: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 3304: return ();
3305: }
3306: my @Words=();
1.429 www 3307: my $count=0;
1.46 matthew 3308: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 3309: # The first element is the number of times
3310: # the word appears. We do not need it now.
1.429 www 3311: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
3312: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
3313: my $threshold=$mostfrequentcount/10;
3314: foreach my $possibleword (@RelatedWords) {
3315: my ($word,$wordcount)=split(/\,/,$possibleword);
3316: if ($wordcount>$threshold) {
3317: push(@Words,$word);
3318: $count++;
3319: if ($count>10) { last; }
3320: }
1.20 www 3321: }
3322: }
1.46 matthew 3323: untie %thesaurus_db;
3324: return @Words;
1.14 harris41 3325: }
1.1090 foxr 3326: ###############################################################
3327: #
3328: # Spell checking
3329: #
3330:
3331: =pod
3332:
1.1142 raeburn 3333: =back
3334:
1.1090 foxr 3335: =head1 Spell checking
3336:
3337: =over 4
3338:
3339: =item * &check_spelling($wordlist $language)
3340:
3341: Takes a string containing words and feeds it to an external
3342: spellcheck program via a pipeline. Returns a string containing
3343: them mis-spelled words.
3344:
3345: Parameters:
3346:
3347: =over 4
3348:
3349: =item - $wordlist
3350:
3351: String that will be fed into the spellcheck program.
3352:
3353: =item - $language
3354:
3355: Language string that specifies the language for which the spell
3356: check will be performed.
3357:
3358: =back
3359:
3360: =back
3361:
3362: Note: This sub assumes that aspell is installed.
3363:
3364:
3365: =cut
3366:
1.46 matthew 3367:
1.1090 foxr 3368: sub check_spelling {
3369: my ($wordlist, $language) = @_;
1.1091 foxr 3370: my @misspellings;
3371:
3372: # Generate the speller and set the langauge.
3373: # if explicitly selected:
1.1090 foxr 3374:
1.1091 foxr 3375: my $speller = Text::Aspell->new;
1.1090 foxr 3376: if ($language) {
1.1091 foxr 3377: $speller->set_option('lang', $language);
1.1090 foxr 3378: }
3379:
1.1091 foxr 3380: # Turn the word list into an array of words by splittingon whitespace
1.1090 foxr 3381:
1.1091 foxr 3382: my @words = split(/\s+/, $wordlist);
1.1090 foxr 3383:
1.1091 foxr 3384: foreach my $word (@words) {
3385: if(! $speller->check($word)) {
3386: push(@misspellings, $word);
1.1090 foxr 3387: }
3388: }
1.1091 foxr 3389: return join(' ', @misspellings);
3390:
1.1090 foxr 3391: }
3392:
1.61 www 3393: # -------------------------------------------------------------- Plaintext name
1.81 albertel 3394: =pod
3395:
1.112 bowersj2 3396: =head1 User Name Functions
3397:
3398: =over 4
3399:
1.648 raeburn 3400: =item * &plainname($uname,$udom,$first)
1.81 albertel 3401:
1.112 bowersj2 3402: Takes a users logon name and returns it as a string in
1.226 albertel 3403: "first middle last generation" form
3404: if $first is set to 'lastname' then it returns it as
3405: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 3406:
3407: =cut
1.61 www 3408:
1.295 www 3409:
1.81 albertel 3410: ###############################################################
1.61 www 3411: sub plainname {
1.226 albertel 3412: my ($uname,$udom,$first)=@_;
1.537 albertel 3413: return if (!defined($uname) || !defined($udom));
1.295 www 3414: my %names=&getnames($uname,$udom);
1.226 albertel 3415: my $name=&Apache::lonnet::format_name($names{'firstname'},
3416: $names{'middlename'},
3417: $names{'lastname'},
3418: $names{'generation'},$first);
3419: $name=~s/^\s+//;
1.62 www 3420: $name=~s/\s+$//;
3421: $name=~s/\s+/ /g;
1.353 albertel 3422: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 3423: return $name;
1.61 www 3424: }
1.66 www 3425:
3426: # -------------------------------------------------------------------- Nickname
1.81 albertel 3427: =pod
3428:
1.648 raeburn 3429: =item * &nickname($uname,$udom)
1.81 albertel 3430:
3431: Gets a users name and returns it as a string as
3432:
3433: ""nickname""
1.66 www 3434:
1.81 albertel 3435: if the user has a nickname or
3436:
3437: "first middle last generation"
3438:
3439: if the user does not
3440:
3441: =cut
1.66 www 3442:
3443: sub nickname {
3444: my ($uname,$udom)=@_;
1.537 albertel 3445: return if (!defined($uname) || !defined($udom));
1.295 www 3446: my %names=&getnames($uname,$udom);
1.68 albertel 3447: my $name=$names{'nickname'};
1.66 www 3448: if ($name) {
3449: $name='"'.$name.'"';
3450: } else {
3451: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
3452: $names{'lastname'}.' '.$names{'generation'};
3453: $name=~s/\s+$//;
3454: $name=~s/\s+/ /g;
3455: }
3456: return $name;
3457: }
3458:
1.295 www 3459: sub getnames {
3460: my ($uname,$udom)=@_;
1.537 albertel 3461: return if (!defined($uname) || !defined($udom));
1.433 albertel 3462: if ($udom eq 'public' && $uname eq 'public') {
3463: return ('lastname' => &mt('Public'));
3464: }
1.295 www 3465: my $id=$uname.':'.$udom;
3466: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
3467: if ($cached) {
3468: return %{$names};
3469: } else {
3470: my %loadnames=&Apache::lonnet::get('environment',
3471: ['firstname','middlename','lastname','generation','nickname'],
3472: $udom,$uname);
3473: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
3474: return %loadnames;
3475: }
3476: }
1.61 www 3477:
1.542 raeburn 3478: # -------------------------------------------------------------------- getemails
1.648 raeburn 3479:
1.542 raeburn 3480: =pod
3481:
1.648 raeburn 3482: =item * &getemails($uname,$udom)
1.542 raeburn 3483:
3484: Gets a user's email information and returns it as a hash with keys:
3485: notification, critnotification, permanentemail
3486:
3487: For notification and critnotification, values are comma-separated lists
1.648 raeburn 3488: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 3489:
1.648 raeburn 3490:
1.542 raeburn 3491: =cut
3492:
1.648 raeburn 3493:
1.466 albertel 3494: sub getemails {
3495: my ($uname,$udom)=@_;
3496: if ($udom eq 'public' && $uname eq 'public') {
3497: return;
3498: }
1.467 www 3499: if (!$udom) { $udom=$env{'user.domain'}; }
3500: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 3501: my $id=$uname.':'.$udom;
3502: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
3503: if ($cached) {
3504: return %{$names};
3505: } else {
3506: my %loadnames=&Apache::lonnet::get('environment',
3507: ['notification','critnotification',
3508: 'permanentemail'],
3509: $udom,$uname);
3510: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
3511: return %loadnames;
3512: }
3513: }
3514:
1.551 albertel 3515: sub flush_email_cache {
3516: my ($uname,$udom)=@_;
3517: if (!$udom) { $udom =$env{'user.domain'}; }
3518: if (!$uname) { $uname=$env{'user.name'}; }
3519: return if ($udom eq 'public' && $uname eq 'public');
3520: my $id=$uname.':'.$udom;
3521: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
3522: }
3523:
1.728 raeburn 3524: # -------------------------------------------------------------------- getlangs
3525:
3526: =pod
3527:
3528: =item * &getlangs($uname,$udom)
3529:
3530: Gets a user's language preference and returns it as a hash with key:
3531: language.
3532:
3533: =cut
3534:
3535:
3536: sub getlangs {
3537: my ($uname,$udom) = @_;
3538: if (!$udom) { $udom =$env{'user.domain'}; }
3539: if (!$uname) { $uname=$env{'user.name'}; }
3540: my $id=$uname.':'.$udom;
3541: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
3542: if ($cached) {
3543: return %{$langs};
3544: } else {
3545: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
3546: $udom,$uname);
3547: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
3548: return %loadlangs;
3549: }
3550: }
3551:
3552: sub flush_langs_cache {
3553: my ($uname,$udom)=@_;
3554: if (!$udom) { $udom =$env{'user.domain'}; }
3555: if (!$uname) { $uname=$env{'user.name'}; }
3556: return if ($udom eq 'public' && $uname eq 'public');
3557: my $id=$uname.':'.$udom;
3558: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
3559: }
3560:
1.61 www 3561: # ------------------------------------------------------------------ Screenname
1.81 albertel 3562:
3563: =pod
3564:
1.648 raeburn 3565: =item * &screenname($uname,$udom)
1.81 albertel 3566:
3567: Gets a users screenname and returns it as a string
3568:
3569: =cut
1.61 www 3570:
3571: sub screenname {
3572: my ($uname,$udom)=@_;
1.258 albertel 3573: if ($uname eq $env{'user.name'} &&
3574: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 3575: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 3576: return $names{'screenname'};
1.62 www 3577: }
3578:
1.212 albertel 3579:
1.802 bisitz 3580: # ------------------------------------------------------------- Confirm Wrapper
3581: =pod
3582:
1.1142 raeburn 3583: =item * &confirmwrapper($message)
1.802 bisitz 3584:
3585: Wrap messages about completion of operation in box
3586:
3587: =cut
3588:
3589: sub confirmwrapper {
3590: my ($message)=@_;
3591: if ($message) {
3592: return "\n".'<div class="LC_confirm_box">'."\n"
3593: .$message."\n"
3594: .'</div>'."\n";
3595: } else {
3596: return $message;
3597: }
3598: }
3599:
1.62 www 3600: # ------------------------------------------------------------- Message Wrapper
3601:
3602: sub messagewrapper {
1.369 www 3603: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 3604: return
1.441 albertel 3605: '<a href="/adm/email?compose=individual&'.
3606: 'recname='.$username.'&recdom='.$domain.
3607: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 3608: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 3609: }
1.802 bisitz 3610:
1.74 www 3611: # --------------------------------------------------------------- Notes Wrapper
3612:
3613: sub noteswrapper {
3614: my ($link,$un,$do)=@_;
3615: return
1.896 amueller 3616: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 3617: }
1.802 bisitz 3618:
1.62 www 3619: # ------------------------------------------------------------- Aboutme Wrapper
3620:
3621: sub aboutmewrapper {
1.1070 raeburn 3622: my ($link,$username,$domain,$target,$class)=@_;
1.447 raeburn 3623: if (!defined($username) && !defined($domain)) {
3624: return;
3625: }
1.1096 raeburn 3626: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.1070 raeburn 3627: ($target?' target="'.$target.'"':'').($class?' class="'.$class.'"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 3628: }
3629:
3630: # ------------------------------------------------------------ Syllabus Wrapper
3631:
3632: sub syllabuswrapper {
1.707 bisitz 3633: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 3634: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 3635: }
1.14 harris41 3636:
1.802 bisitz 3637: # -----------------------------------------------------------------------------
3638:
1.208 matthew 3639: sub track_student_link {
1.887 raeburn 3640: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 3641: my $link ="/adm/trackstudent?";
1.208 matthew 3642: my $title = 'View recent activity';
3643: if (defined($sname) && $sname !~ /^\s*$/ &&
3644: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 3645: $link .= "selected_student=$sname:$sdom";
1.208 matthew 3646: $title .= ' of this student';
1.268 albertel 3647: }
1.208 matthew 3648: if (defined($target) && $target !~ /^\s*$/) {
3649: $target = qq{target="$target"};
3650: } else {
3651: $target = '';
3652: }
1.268 albertel 3653: if ($start) { $link.='&start='.$start; }
1.887 raeburn 3654: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 3655: $title = &mt($title);
3656: $linktext = &mt($linktext);
1.448 albertel 3657: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
3658: &help_open_topic('View_recent_activity');
1.208 matthew 3659: }
3660:
1.781 raeburn 3661: sub slot_reservations_link {
3662: my ($linktext,$sname,$sdom,$target) = @_;
3663: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
3664: my $title = 'View slot reservation history';
3665: if (defined($sname) && $sname !~ /^\s*$/ &&
3666: defined($sdom) && $sdom !~ /^\s*$/) {
3667: $link .= "&uname=$sname&udom=$sdom";
3668: $title .= ' of this student';
3669: }
3670: if (defined($target) && $target !~ /^\s*$/) {
3671: $target = qq{target="$target"};
3672: } else {
3673: $target = '';
3674: }
3675: $title = &mt($title);
3676: $linktext = &mt($linktext);
3677: return qq{<a href="$link" title="$title" $target>$linktext</a>};
3678: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
3679:
3680: }
3681:
1.508 www 3682: # ===================================================== Display a student photo
3683:
3684:
1.509 albertel 3685: sub student_image_tag {
1.508 www 3686: my ($domain,$user)=@_;
3687: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
3688: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
3689: return '<img src="'.$imgsrc.'" align="right" />';
3690: } else {
3691: return '';
3692: }
3693: }
3694:
1.112 bowersj2 3695: =pod
3696:
3697: =back
3698:
3699: =head1 Access .tab File Data
3700:
3701: =over 4
3702:
1.648 raeburn 3703: =item * &languageids()
1.112 bowersj2 3704:
3705: returns list of all language ids
3706:
3707: =cut
3708:
1.14 harris41 3709: sub languageids {
1.16 harris41 3710: return sort(keys(%language));
1.14 harris41 3711: }
3712:
1.112 bowersj2 3713: =pod
3714:
1.648 raeburn 3715: =item * &languagedescription()
1.112 bowersj2 3716:
3717: returns description of a specified language id
3718:
3719: =cut
3720:
1.14 harris41 3721: sub languagedescription {
1.125 www 3722: my $code=shift;
3723: return ($supported_language{$code}?'* ':'').
3724: $language{$code}.
1.126 www 3725: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 3726: }
3727:
1.1048 foxr 3728: =pod
3729:
3730: =item * &plainlanguagedescription
3731:
3732: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
3733: and the language character encoding (e.g. ISO) separated by a ' - ' string.
3734:
3735: =cut
3736:
1.145 www 3737: sub plainlanguagedescription {
3738: my $code=shift;
3739: return $language{$code};
3740: }
3741:
1.1048 foxr 3742: =pod
3743:
3744: =item * &supportedlanguagecode
3745:
3746: Returns the supported language code (e.g. sptutf maps to pt) given a language
3747: code.
3748:
3749: =cut
3750:
1.145 www 3751: sub supportedlanguagecode {
3752: my $code=shift;
3753: return $supported_language{$code};
1.97 www 3754: }
3755:
1.112 bowersj2 3756: =pod
3757:
1.1048 foxr 3758: =item * &latexlanguage()
3759:
3760: Given a language key code returns the correspondnig language to use
3761: to select the correct hyphenation on LaTeX printouts. This is undef if there
3762: is no supported hyphenation for the language code.
3763:
3764: =cut
3765:
3766: sub latexlanguage {
3767: my $code = shift;
3768: return $latex_language{$code};
3769: }
3770:
3771: =pod
3772:
3773: =item * &latexhyphenation()
3774:
3775: Same as above but what's supplied is the language as it might be stored
3776: in the metadata.
3777:
3778: =cut
3779:
3780: sub latexhyphenation {
3781: my $key = shift;
3782: return $latex_language_bykey{$key};
3783: }
3784:
3785: =pod
3786:
1.648 raeburn 3787: =item * ©rightids()
1.112 bowersj2 3788:
3789: returns list of all copyrights
3790:
3791: =cut
3792:
3793: sub copyrightids {
3794: return sort(keys(%cprtag));
3795: }
3796:
3797: =pod
3798:
1.648 raeburn 3799: =item * ©rightdescription()
1.112 bowersj2 3800:
3801: returns description of a specified copyright id
3802:
3803: =cut
3804:
3805: sub copyrightdescription {
1.166 www 3806: return &mt($cprtag{shift(@_)});
1.112 bowersj2 3807: }
1.197 matthew 3808:
3809: =pod
3810:
1.648 raeburn 3811: =item * &source_copyrightids()
1.192 taceyjo1 3812:
3813: returns list of all source copyrights
3814:
3815: =cut
3816:
3817: sub source_copyrightids {
3818: return sort(keys(%scprtag));
3819: }
3820:
3821: =pod
3822:
1.648 raeburn 3823: =item * &source_copyrightdescription()
1.192 taceyjo1 3824:
3825: returns description of a specified source copyright id
3826:
3827: =cut
3828:
3829: sub source_copyrightdescription {
3830: return &mt($scprtag{shift(@_)});
3831: }
1.112 bowersj2 3832:
3833: =pod
3834:
1.648 raeburn 3835: =item * &filecategories()
1.112 bowersj2 3836:
3837: returns list of all file categories
3838:
3839: =cut
3840:
3841: sub filecategories {
3842: return sort(keys(%category_extensions));
3843: }
3844:
3845: =pod
3846:
1.648 raeburn 3847: =item * &filecategorytypes()
1.112 bowersj2 3848:
3849: returns list of file types belonging to a given file
3850: category
3851:
3852: =cut
3853:
3854: sub filecategorytypes {
1.356 albertel 3855: my ($cat) = @_;
3856: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 3857: }
3858:
3859: =pod
3860:
1.648 raeburn 3861: =item * &fileembstyle()
1.112 bowersj2 3862:
3863: returns embedding style for a specified file type
3864:
3865: =cut
3866:
3867: sub fileembstyle {
3868: return $fe{lc(shift(@_))};
1.169 www 3869: }
3870:
1.351 www 3871: sub filemimetype {
3872: return $fm{lc(shift(@_))};
3873: }
3874:
1.169 www 3875:
3876: sub filecategoryselect {
3877: my ($name,$value)=@_;
1.189 matthew 3878: return &select_form($value,$name,
1.970 raeburn 3879: {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112 bowersj2 3880: }
3881:
3882: =pod
3883:
1.648 raeburn 3884: =item * &filedescription()
1.112 bowersj2 3885:
3886: returns description for a specified file type
3887:
3888: =cut
3889:
3890: sub filedescription {
1.188 matthew 3891: my $file_description = $fd{lc(shift())};
3892: $file_description =~ s:([\[\]]):~$1:g;
3893: return &mt($file_description);
1.112 bowersj2 3894: }
3895:
3896: =pod
3897:
1.648 raeburn 3898: =item * &filedescriptionex()
1.112 bowersj2 3899:
3900: returns description for a specified file type with
3901: extra formatting
3902:
3903: =cut
3904:
3905: sub filedescriptionex {
3906: my $ex=shift;
1.188 matthew 3907: my $file_description = $fd{lc($ex)};
3908: $file_description =~ s:([\[\]]):~$1:g;
3909: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3910: }
3911:
3912: # End of .tab access
3913: =pod
3914:
3915: =back
3916:
3917: =cut
3918:
3919: # ------------------------------------------------------------------ File Types
3920: sub fileextensions {
3921: return sort(keys(%fe));
3922: }
3923:
1.97 www 3924: # ----------------------------------------------------------- Display Languages
3925: # returns a hash with all desired display languages
3926: #
3927:
3928: sub display_languages {
3929: my %languages=();
1.695 raeburn 3930: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3931: $languages{$lang}=1;
1.97 www 3932: }
3933: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3934: if ($env{'form.displaylanguage'}) {
1.356 albertel 3935: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3936: $languages{$lang}=1;
1.97 www 3937: }
3938: }
3939: return %languages;
1.14 harris41 3940: }
3941:
1.582 albertel 3942: sub languages {
3943: my ($possible_langs) = @_;
1.695 raeburn 3944: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3945: if (!ref($possible_langs)) {
3946: if( wantarray ) {
3947: return @preferred_langs;
3948: } else {
3949: return $preferred_langs[0];
3950: }
3951: }
3952: my %possibilities = map { $_ => 1 } (@$possible_langs);
3953: my @preferred_possibilities;
3954: foreach my $preferred_lang (@preferred_langs) {
3955: if (exists($possibilities{$preferred_lang})) {
3956: push(@preferred_possibilities, $preferred_lang);
3957: }
3958: }
3959: if( wantarray ) {
3960: return @preferred_possibilities;
3961: }
3962: return $preferred_possibilities[0];
3963: }
3964:
1.742 raeburn 3965: sub user_lang {
3966: my ($touname,$toudom,$fromcid) = @_;
3967: my @userlangs;
3968: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3969: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3970: $env{'course.'.$fromcid.'.languages'}));
3971: } else {
3972: my %langhash = &getlangs($touname,$toudom);
3973: if ($langhash{'languages'} ne '') {
3974: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3975: } else {
3976: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3977: if ($domdefs{'lang_def'} ne '') {
3978: @userlangs = ($domdefs{'lang_def'});
3979: }
3980: }
3981: }
3982: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3983: my $user_lh = Apache::localize->get_handle(@languages);
3984: return $user_lh;
3985: }
3986:
3987:
1.112 bowersj2 3988: ###############################################################
3989: ## Student Answer Attempts ##
3990: ###############################################################
3991:
3992: =pod
3993:
3994: =head1 Alternate Problem Views
3995:
3996: =over 4
3997:
1.648 raeburn 3998: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.1199 raeburn 3999: $getattempt, $regexp, $gradesub, $usec, $identifier)
1.112 bowersj2 4000:
4001: Return string with previous attempt on problem. Arguments:
4002:
4003: =over 4
4004:
4005: =item * $symb: Problem, including path
4006:
4007: =item * $username: username of the desired student
4008:
4009: =item * $domain: domain of the desired student
1.14 harris41 4010:
1.112 bowersj2 4011: =item * $course: Course ID
1.14 harris41 4012:
1.112 bowersj2 4013: =item * $getattempt: Leave blank for all attempts, otherwise put
4014: something
1.14 harris41 4015:
1.112 bowersj2 4016: =item * $regexp: if string matches this regexp, the string will be
4017: sent to $gradesub
1.14 harris41 4018:
1.112 bowersj2 4019: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 4020:
1.1199 raeburn 4021: =item * $usec: section of the desired student
4022:
4023: =item * $identifier: counter for student (multiple students one problem) or
4024: problem (one student; whole sequence).
4025:
1.112 bowersj2 4026: =back
1.14 harris41 4027:
1.112 bowersj2 4028: The output string is a table containing all desired attempts, if any.
1.16 harris41 4029:
1.112 bowersj2 4030: =cut
1.1 albertel 4031:
4032: sub get_previous_attempt {
1.1199 raeburn 4033: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub,$usec,$identifier)=@_;
1.1 albertel 4034: my $prevattempts='';
1.43 ng 4035: no strict 'refs';
1.1 albertel 4036: if ($symb) {
1.3 albertel 4037: my (%returnhash)=
4038: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 4039: if ($returnhash{'version'}) {
4040: my %lasthash=();
4041: my $version;
4042: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 4043: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
4044: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 4045: }
1.1 albertel 4046: }
1.596 albertel 4047: $prevattempts=&start_data_table().&start_data_table_header_row();
4048: $prevattempts.='<th>'.&mt('History').'</th>';
1.1199 raeburn 4049: my (%typeparts,%lasthidden,%regraded,%hidestatus);
1.945 raeburn 4050: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 4051: foreach my $key (sort(keys(%lasthash))) {
4052: my ($ign,@parts) = split(/\./,$key);
1.41 ng 4053: if ($#parts > 0) {
1.31 albertel 4054: my $data=$parts[-1];
1.989 raeburn 4055: next if ($data eq 'foilorder');
1.31 albertel 4056: pop(@parts);
1.1010 www 4057: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.945 raeburn 4058: if ($data eq 'type') {
4059: unless ($showsurv) {
4060: my $id = join(',',@parts);
4061: $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978 raeburn 4062: if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
4063: $lasthidden{$ign.'.'.$id} = 1;
4064: }
1.945 raeburn 4065: }
1.1199 raeburn 4066: if ($identifier ne '') {
4067: my $id = join(',',@parts);
4068: if (&Apache::lonnet::EXT("resource.$id.problemstatus",$symb,
4069: $domain,$username,$usec,undef,$course) =~ /^no/) {
4070: $hidestatus{$ign.'.'.$id} = 1;
4071: }
4072: }
4073: } elsif ($data eq 'regrader') {
4074: if (($identifier ne '') && (@parts)) {
1.1200 raeburn 4075: my $id = join(',',@parts);
4076: $regraded{$ign.'.'.$id} = 1;
1.1199 raeburn 4077: }
1.1010 www 4078: }
1.31 albertel 4079: } else {
1.41 ng 4080: if ($#parts == 0) {
4081: $prevattempts.='<th>'.$parts[0].'</th>';
4082: } else {
4083: $prevattempts.='<th>'.$ign.'</th>';
4084: }
1.31 albertel 4085: }
1.16 harris41 4086: }
1.596 albertel 4087: $prevattempts.=&end_data_table_header_row();
1.40 ng 4088: if ($getattempt eq '') {
1.1199 raeburn 4089: my (%solved,%resets,%probstatus);
1.1200 raeburn 4090: if (($identifier ne '') && (keys(%regraded) > 0)) {
4091: for ($version=1;$version<=$returnhash{'version'};$version++) {
4092: foreach my $id (keys(%regraded)) {
4093: if (($returnhash{$version.':'.$id.'.regrader'}) &&
4094: ($returnhash{$version.':'.$id.'.tries'} eq '') &&
4095: ($returnhash{$version.':'.$id.'.award'} eq '')) {
4096: push(@{$resets{$id}},$version);
1.1199 raeburn 4097: }
4098: }
4099: }
1.1200 raeburn 4100: }
4101: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1199 raeburn 4102: my (@hidden,@unsolved);
1.945 raeburn 4103: if (%typeparts) {
4104: foreach my $id (keys(%typeparts)) {
1.1199 raeburn 4105: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') ||
4106: ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
1.945 raeburn 4107: push(@hidden,$id);
1.1199 raeburn 4108: } elsif ($identifier ne '') {
4109: unless (($returnhash{$version.':'.$id.'.type'} eq 'survey') ||
4110: ($returnhash{$version.':'.$id.'.type'} eq 'surveycred') ||
4111: ($hidestatus{$id})) {
1.1200 raeburn 4112: next if ((ref($resets{$id}) eq 'ARRAY') && grep(/^\Q$version\E$/,@{$resets{$id}}));
1.1199 raeburn 4113: if ($returnhash{$version.':'.$id.'.solved'} eq 'correct_by_student') {
4114: push(@{$solved{$id}},$version);
4115: } elsif (($returnhash{$version.':'.$id.'.solved'} ne '') &&
4116: (ref($solved{$id}) eq 'ARRAY')) {
4117: my $skip;
4118: if (ref($resets{$id}) eq 'ARRAY') {
4119: foreach my $reset (@{$resets{$id}}) {
4120: if ($reset > $solved{$id}[-1]) {
4121: $skip=1;
4122: last;
4123: }
4124: }
4125: }
4126: unless ($skip) {
4127: my ($ign,$partslist) = split(/\./,$id,2);
4128: push(@unsolved,$partslist);
4129: }
4130: }
4131: }
1.945 raeburn 4132: }
4133: }
4134: }
4135: $prevattempts.=&start_data_table_row().
1.1199 raeburn 4136: '<td>'.&mt('Transaction [_1]',$version);
4137: if (@unsolved) {
4138: $prevattempts .= '<span class="LC_nobreak"><label>'.
4139: '<input type="checkbox" name="HIDE'.$identifier.'" value="'.$version.':'.join('_',@unsolved).'" />'.
4140: &mt('Hide').'</label></span>';
4141: }
4142: $prevattempts .= '</td>';
1.945 raeburn 4143: if (@hidden) {
4144: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 4145: next if ($key =~ /\.foilorder$/);
1.945 raeburn 4146: my $hide;
4147: foreach my $id (@hidden) {
4148: if ($key =~ /^\Q$id\E/) {
4149: $hide = 1;
4150: last;
4151: }
4152: }
4153: if ($hide) {
4154: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
4155: if (($data eq 'award') || ($data eq 'awarddetail')) {
4156: my $value = &format_previous_attempt_value($key,
4157: $returnhash{$version.':'.$key});
1.1173 kruse 4158: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 4159: } else {
4160: $prevattempts.='<td> </td>';
4161: }
4162: } else {
4163: if ($key =~ /\./) {
4164: my $value = &format_previous_attempt_value($key,
4165: $returnhash{$version.':'.$key});
1.1173 kruse 4166: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 4167: } else {
4168: $prevattempts.='<td> </td>';
4169: }
4170: }
4171: }
4172: } else {
4173: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 4174: next if ($key =~ /\.foilorder$/);
1.945 raeburn 4175: my $value = &format_previous_attempt_value($key,
4176: $returnhash{$version.':'.$key});
1.1173 kruse 4177: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 4178: }
4179: }
4180: $prevattempts.=&end_data_table_row();
1.40 ng 4181: }
1.1 albertel 4182: }
1.945 raeburn 4183: my @currhidden = keys(%lasthidden);
1.596 albertel 4184: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 4185: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 4186: next if ($key =~ /\.foilorder$/);
1.945 raeburn 4187: if (%typeparts) {
4188: my $hidden;
4189: foreach my $id (@currhidden) {
4190: if ($key =~ /^\Q$id\E/) {
4191: $hidden = 1;
4192: last;
4193: }
4194: }
4195: if ($hidden) {
4196: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
4197: if (($data eq 'award') || ($data eq 'awarddetail')) {
4198: my $value = &format_previous_attempt_value($key,$lasthash{$key});
4199: if ($key =~/$regexp$/ && (defined &$gradesub)) {
4200: $value = &$gradesub($value);
4201: }
1.1173 kruse 4202: $prevattempts.='<td>'. $value.' </td>';
1.945 raeburn 4203: } else {
4204: $prevattempts.='<td> </td>';
4205: }
4206: } else {
4207: my $value = &format_previous_attempt_value($key,$lasthash{$key});
4208: if ($key =~/$regexp$/ && (defined &$gradesub)) {
4209: $value = &$gradesub($value);
4210: }
1.1173 kruse 4211: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 4212: }
4213: } else {
4214: my $value = &format_previous_attempt_value($key,$lasthash{$key});
4215: if ($key =~/$regexp$/ && (defined &$gradesub)) {
4216: $value = &$gradesub($value);
4217: }
1.1173 kruse 4218: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 4219: }
1.16 harris41 4220: }
1.596 albertel 4221: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 4222: } else {
1.596 albertel 4223: $prevattempts=
4224: &start_data_table().&start_data_table_row().
4225: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
4226: &end_data_table_row().&end_data_table();
1.1 albertel 4227: }
4228: } else {
1.596 albertel 4229: $prevattempts=
4230: &start_data_table().&start_data_table_row().
4231: '<td>'.&mt('No data.').'</td>'.
4232: &end_data_table_row().&end_data_table();
1.1 albertel 4233: }
1.10 albertel 4234: }
4235:
1.581 albertel 4236: sub format_previous_attempt_value {
4237: my ($key,$value) = @_;
1.1011 www 4238: if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.1173 kruse 4239: $value = &Apache::lonlocal::locallocaltime($value);
1.581 albertel 4240: } elsif (ref($value) eq 'ARRAY') {
1.1173 kruse 4241: $value = &HTML::Entities::encode('('.join(', ', @{ $value }).')','"<>&');
1.988 raeburn 4242: } elsif ($key =~ /answerstring$/) {
4243: my %answers = &Apache::lonnet::str2hash($value);
1.1173 kruse 4244: my @answer = %answers;
4245: %answers = map {&HTML::Entities::encode($_, '"<>&')} @answer;
1.988 raeburn 4246: my @anskeys = sort(keys(%answers));
4247: if (@anskeys == 1) {
4248: my $answer = $answers{$anskeys[0]};
1.1001 raeburn 4249: if ($answer =~ m{\0}) {
4250: $answer =~ s{\0}{,}g;
1.988 raeburn 4251: }
4252: my $tag_internal_answer_name = 'INTERNAL';
4253: if ($anskeys[0] eq $tag_internal_answer_name) {
4254: $value = $answer;
4255: } else {
4256: $value = $anskeys[0].'='.$answer;
4257: }
4258: } else {
4259: foreach my $ans (@anskeys) {
4260: my $answer = $answers{$ans};
1.1001 raeburn 4261: if ($answer =~ m{\0}) {
4262: $answer =~ s{\0}{,}g;
1.988 raeburn 4263: }
4264: $value .= $ans.'='.$answer.'<br />';;
4265: }
4266: }
1.581 albertel 4267: } else {
1.1173 kruse 4268: $value = &HTML::Entities::encode(&unescape($value), '"<>&');
1.581 albertel 4269: }
4270: return $value;
4271: }
4272:
4273:
1.107 albertel 4274: sub relative_to_absolute {
4275: my ($url,$output)=@_;
4276: my $parser=HTML::TokeParser->new(\$output);
4277: my $token;
4278: my $thisdir=$url;
4279: my @rlinks=();
4280: while ($token=$parser->get_token) {
4281: if ($token->[0] eq 'S') {
4282: if ($token->[1] eq 'a') {
4283: if ($token->[2]->{'href'}) {
4284: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
4285: }
4286: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
4287: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
4288: } elsif ($token->[1] eq 'base') {
4289: $thisdir=$token->[2]->{'href'};
4290: }
4291: }
4292: }
4293: $thisdir=~s-/[^/]*$--;
1.356 albertel 4294: foreach my $link (@rlinks) {
1.726 raeburn 4295: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 4296: ($link=~/^\//) ||
4297: ($link=~/^javascript:/i) ||
4298: ($link=~/^mailto:/i) ||
4299: ($link=~/^\#/)) {
4300: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
4301: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 4302: }
4303: }
4304: # -------------------------------------------------- Deal with Applet codebases
4305: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
4306: return $output;
4307: }
4308:
1.112 bowersj2 4309: =pod
4310:
1.648 raeburn 4311: =item * &get_student_view()
1.112 bowersj2 4312:
4313: show a snapshot of what student was looking at
4314:
4315: =cut
4316:
1.10 albertel 4317: sub get_student_view {
1.186 albertel 4318: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 4319: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 4320: my (%form);
1.10 albertel 4321: my @elements=('symb','courseid','domain','username');
4322: foreach my $element (@elements) {
1.186 albertel 4323: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 4324: }
1.186 albertel 4325: if (defined($moreenv)) {
4326: %form=(%form,%{$moreenv});
4327: }
1.236 albertel 4328: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 4329: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 4330: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 4331: $userview=~s/\<body[^\>]*\>//gi;
4332: $userview=~s/\<\/body\>//gi;
4333: $userview=~s/\<html\>//gi;
4334: $userview=~s/\<\/html\>//gi;
4335: $userview=~s/\<head\>//gi;
4336: $userview=~s/\<\/head\>//gi;
4337: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 4338: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 4339: if (wantarray) {
4340: return ($userview,$response);
4341: } else {
4342: return $userview;
4343: }
4344: }
4345:
4346: sub get_student_view_with_retries {
4347: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
4348:
4349: my $ok = 0; # True if we got a good response.
4350: my $content;
4351: my $response;
4352:
4353: # Try to get the student_view done. within the retries count:
4354:
4355: do {
4356: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
4357: $ok = $response->is_success;
4358: if (!$ok) {
4359: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
4360: }
4361: $retries--;
4362: } while (!$ok && ($retries > 0));
4363:
4364: if (!$ok) {
4365: $content = ''; # On error return an empty content.
4366: }
1.651 www 4367: if (wantarray) {
4368: return ($content, $response);
4369: } else {
4370: return $content;
4371: }
1.11 albertel 4372: }
4373:
1.112 bowersj2 4374: =pod
4375:
1.648 raeburn 4376: =item * &get_student_answers()
1.112 bowersj2 4377:
4378: show a snapshot of how student was answering problem
4379:
4380: =cut
4381:
1.11 albertel 4382: sub get_student_answers {
1.100 sakharuk 4383: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 4384: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 4385: my (%moreenv);
1.11 albertel 4386: my @elements=('symb','courseid','domain','username');
4387: foreach my $element (@elements) {
1.186 albertel 4388: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 4389: }
1.186 albertel 4390: $moreenv{'grade_target'}='answer';
4391: %moreenv=(%form,%moreenv);
1.497 raeburn 4392: $feedurl = &Apache::lonnet::clutter($feedurl);
4393: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 4394: return $userview;
1.1 albertel 4395: }
1.116 albertel 4396:
4397: =pod
4398:
4399: =item * &submlink()
4400:
1.242 albertel 4401: Inputs: $text $uname $udom $symb $target
1.116 albertel 4402:
4403: Returns: A link to grades.pm such as to see the SUBM view of a student
4404:
4405: =cut
4406:
4407: ###############################################
4408: sub submlink {
1.242 albertel 4409: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 4410: if (!($uname && $udom)) {
4411: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 4412: &Apache::lonnet::whichuser($symb);
1.116 albertel 4413: if (!$symb) { $symb=$cursymb; }
4414: }
1.254 matthew 4415: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 4416: $symb=&escape($symb);
1.960 bisitz 4417: if ($target) { $target=" target=\"$target\""; }
4418: return
4419: '<a href="/adm/grades?command=submission'.
4420: '&symb='.$symb.
4421: '&student='.$uname.
4422: '&userdom='.$udom.'"'.
4423: $target.'>'.$text.'</a>';
1.242 albertel 4424: }
4425: ##############################################
4426:
4427: =pod
4428:
4429: =item * &pgrdlink()
4430:
4431: Inputs: $text $uname $udom $symb $target
4432:
4433: Returns: A link to grades.pm such as to see the PGRD view of a student
4434:
4435: =cut
4436:
4437: ###############################################
4438: sub pgrdlink {
4439: my $link=&submlink(@_);
4440: $link=~s/(&command=submission)/$1&showgrading=yes/;
4441: return $link;
4442: }
4443: ##############################################
4444:
4445: =pod
4446:
4447: =item * &pprmlink()
4448:
4449: Inputs: $text $uname $udom $symb $target
4450:
4451: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 4452: student and a specific resource
1.242 albertel 4453:
4454: =cut
4455:
4456: ###############################################
4457: sub pprmlink {
4458: my ($text,$uname,$udom,$symb,$target)=@_;
4459: if (!($uname && $udom)) {
4460: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 4461: &Apache::lonnet::whichuser($symb);
1.242 albertel 4462: if (!$symb) { $symb=$cursymb; }
4463: }
1.254 matthew 4464: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 4465: $symb=&escape($symb);
1.242 albertel 4466: if ($target) { $target="target=\"$target\""; }
1.595 albertel 4467: return '<a href="/adm/parmset?command=set&'.
4468: 'symb='.$symb.'&uname='.$uname.
4469: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 4470: }
4471: ##############################################
1.37 matthew 4472:
1.112 bowersj2 4473: =pod
4474:
4475: =back
4476:
4477: =cut
4478:
1.37 matthew 4479: ###############################################
1.51 www 4480:
4481:
4482: sub timehash {
1.687 raeburn 4483: my ($thistime) = @_;
4484: my $timezone = &Apache::lonlocal::gettimezone();
4485: my $dt = DateTime->from_epoch(epoch => $thistime)
4486: ->set_time_zone($timezone);
4487: my $wday = $dt->day_of_week();
4488: if ($wday == 7) { $wday = 0; }
4489: return ( 'second' => $dt->second(),
4490: 'minute' => $dt->minute(),
4491: 'hour' => $dt->hour(),
4492: 'day' => $dt->day_of_month(),
4493: 'month' => $dt->month(),
4494: 'year' => $dt->year(),
4495: 'weekday' => $wday,
4496: 'dayyear' => $dt->day_of_year(),
4497: 'dlsav' => $dt->is_dst() );
1.51 www 4498: }
4499:
1.370 www 4500: sub utc_string {
4501: my ($date)=@_;
1.371 www 4502: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 4503: }
4504:
1.51 www 4505: sub maketime {
4506: my %th=@_;
1.687 raeburn 4507: my ($epoch_time,$timezone,$dt);
4508: $timezone = &Apache::lonlocal::gettimezone();
4509: eval {
4510: $dt = DateTime->new( year => $th{'year'},
4511: month => $th{'month'},
4512: day => $th{'day'},
4513: hour => $th{'hour'},
4514: minute => $th{'minute'},
4515: second => $th{'second'},
4516: time_zone => $timezone,
4517: );
4518: };
4519: if (!$@) {
4520: $epoch_time = $dt->epoch;
4521: if ($epoch_time) {
4522: return $epoch_time;
4523: }
4524: }
1.51 www 4525: return POSIX::mktime(
4526: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 4527: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 4528: }
4529:
4530: #########################################
1.51 www 4531:
4532: sub findallcourses {
1.482 raeburn 4533: my ($roles,$uname,$udom) = @_;
1.355 albertel 4534: my %roles;
4535: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 4536: my %courses;
1.51 www 4537: my $now=time;
1.482 raeburn 4538: if (!defined($uname)) {
4539: $uname = $env{'user.name'};
4540: }
4541: if (!defined($udom)) {
4542: $udom = $env{'user.domain'};
4543: }
4544: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.1073 raeburn 4545: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
1.482 raeburn 4546: if (!%roles) {
4547: %roles = (
4548: cc => 1,
1.907 raeburn 4549: co => 1,
1.482 raeburn 4550: in => 1,
4551: ep => 1,
4552: ta => 1,
4553: cr => 1,
4554: st => 1,
4555: );
4556: }
4557: foreach my $entry (keys(%roleshash)) {
4558: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
4559: if ($trole =~ /^cr/) {
4560: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
4561: } else {
4562: next if (!exists($roles{$trole}));
4563: }
4564: if ($tend) {
4565: next if ($tend < $now);
4566: }
4567: if ($tstart) {
4568: next if ($tstart > $now);
4569: }
1.1058 raeburn 4570: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482 raeburn 4571: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058 raeburn 4572: my $value = $trole.'/'.$cdom.'/';
1.482 raeburn 4573: if ($secpart eq '') {
4574: ($cnum,$role) = split(/_/,$cnumpart);
4575: $sec = 'none';
1.1058 raeburn 4576: $value .= $cnum.'/';
1.482 raeburn 4577: } else {
4578: $cnum = $cnumpart;
4579: ($sec,$role) = split(/_/,$secpart);
1.1058 raeburn 4580: $value .= $cnum.'/'.$sec;
4581: }
4582: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
4583: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
4584: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
4585: }
4586: } else {
4587: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490 raeburn 4588: }
1.482 raeburn 4589: }
4590: } else {
4591: foreach my $key (keys(%env)) {
1.483 albertel 4592: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
4593: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 4594: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
4595: next if ($role eq 'ca' || $role eq 'aa');
4596: next if (%roles && !exists($roles{$role}));
4597: my ($starttime,$endtime)=split(/\./,$env{$key});
4598: my $active=1;
4599: if ($starttime) {
4600: if ($now<$starttime) { $active=0; }
4601: }
4602: if ($endtime) {
4603: if ($now>$endtime) { $active=0; }
4604: }
4605: if ($active) {
1.1058 raeburn 4606: my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482 raeburn 4607: if ($sec eq '') {
4608: $sec = 'none';
1.1058 raeburn 4609: } else {
4610: $value .= $sec;
4611: }
4612: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
4613: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
4614: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
4615: }
4616: } else {
4617: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482 raeburn 4618: }
1.474 raeburn 4619: }
4620: }
1.51 www 4621: }
4622: }
1.474 raeburn 4623: return %courses;
1.51 www 4624: }
1.37 matthew 4625:
1.54 www 4626: ###############################################
1.474 raeburn 4627:
4628: sub blockcheck {
1.1189 raeburn 4629: my ($setters,$activity,$uname,$udom,$url,$is_course) = @_;
1.490 raeburn 4630:
1.1189 raeburn 4631: if (defined($udom) && defined($uname)) {
4632: # If uname and udom are for a course, check for blocks in the course.
4633: if (($is_course) || (&Apache::lonnet::is_course($udom,$uname))) {
4634: my ($startblock,$endblock,$triggerblock) =
4635: &get_blocks($setters,$activity,$udom,$uname,$url);
4636: return ($startblock,$endblock,$triggerblock);
4637: }
4638: } else {
1.490 raeburn 4639: $udom = $env{'user.domain'};
4640: $uname = $env{'user.name'};
4641: }
4642:
1.502 raeburn 4643: my $startblock = 0;
4644: my $endblock = 0;
1.1062 raeburn 4645: my $triggerblock = '';
1.482 raeburn 4646: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 4647:
1.490 raeburn 4648: # If uname is for a user, and activity is course-specific, i.e.,
4649: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 4650:
1.490 raeburn 4651: if (($activity eq 'boards' || $activity eq 'chat' ||
1.1189 raeburn 4652: $activity eq 'groups' || $activity eq 'printout') &&
4653: ($env{'request.course.id'})) {
1.490 raeburn 4654: foreach my $key (keys(%live_courses)) {
4655: if ($key ne $env{'request.course.id'}) {
4656: delete($live_courses{$key});
4657: }
4658: }
4659: }
4660:
4661: my $otheruser = 0;
4662: my %own_courses;
4663: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
4664: # Resource belongs to user other than current user.
4665: $otheruser = 1;
4666: # Gather courses for current user
4667: %own_courses =
4668: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
4669: }
4670:
4671: # Gather active course roles - course coordinator, instructor,
4672: # exam proctor, ta, student, or custom role.
1.474 raeburn 4673:
4674: foreach my $course (keys(%live_courses)) {
1.482 raeburn 4675: my ($cdom,$cnum);
4676: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
4677: $cdom = $env{'course.'.$course.'.domain'};
4678: $cnum = $env{'course.'.$course.'.num'};
4679: } else {
1.490 raeburn 4680: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 4681: }
4682: my $no_ownblock = 0;
4683: my $no_userblock = 0;
1.533 raeburn 4684: if ($otheruser && $activity ne 'com') {
1.490 raeburn 4685: # Check if current user has 'evb' priv for this
4686: if (defined($own_courses{$course})) {
4687: foreach my $sec (keys(%{$own_courses{$course}})) {
4688: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
4689: if ($sec ne 'none') {
4690: $checkrole .= '/'.$sec;
4691: }
4692: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4693: $no_ownblock = 1;
4694: last;
4695: }
4696: }
4697: }
4698: # if they have 'evb' priv and are currently not playing student
4699: next if (($no_ownblock) &&
4700: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
4701: }
1.474 raeburn 4702: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 4703: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 4704: if ($sec ne 'none') {
1.482 raeburn 4705: $checkrole .= '/'.$sec;
1.474 raeburn 4706: }
1.490 raeburn 4707: if ($otheruser) {
4708: # Resource belongs to user other than current user.
4709: # Assemble privs for that user, and check for 'evb' priv.
1.1058 raeburn 4710: my (%allroles,%userroles);
4711: if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
4712: foreach my $entry (@{$live_courses{$course}{$sec}}) {
4713: my ($trole,$tdom,$tnum,$tsec);
4714: if ($entry =~ /^cr/) {
4715: ($trole,$tdom,$tnum,$tsec) =
4716: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
4717: } else {
4718: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
4719: }
4720: my ($spec,$area,$trest);
4721: $area = '/'.$tdom.'/'.$tnum;
4722: $trest = $tnum;
4723: if ($tsec ne '') {
4724: $area .= '/'.$tsec;
4725: $trest .= '/'.$tsec;
4726: }
4727: $spec = $trole.'.'.$area;
4728: if ($trole =~ /^cr/) {
4729: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
4730: $tdom,$spec,$trest,$area);
4731: } else {
4732: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
4733: $tdom,$spec,$trest,$area);
4734: }
4735: }
4736: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
4737: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
4738: if ($1) {
4739: $no_userblock = 1;
4740: last;
4741: }
1.486 raeburn 4742: }
4743: }
1.490 raeburn 4744: } else {
4745: # Resource belongs to current user
4746: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 4747: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4748: $no_ownblock = 1;
4749: last;
4750: }
1.474 raeburn 4751: }
4752: }
4753: # if they have the evb priv and are currently not playing student
1.482 raeburn 4754: next if (($no_ownblock) &&
1.491 albertel 4755: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 4756: next if ($no_userblock);
1.474 raeburn 4757:
1.866 kalberla 4758: # Retrieve blocking times and identity of locker for course
1.490 raeburn 4759: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 4760:
1.1062 raeburn 4761: my ($start,$end,$trigger) =
4762: &get_blocks($setters,$activity,$cdom,$cnum,$url);
1.502 raeburn 4763: if (($start != 0) &&
4764: (($startblock == 0) || ($startblock > $start))) {
4765: $startblock = $start;
1.1062 raeburn 4766: if ($trigger ne '') {
4767: $triggerblock = $trigger;
4768: }
1.502 raeburn 4769: }
4770: if (($end != 0) &&
4771: (($endblock == 0) || ($endblock < $end))) {
4772: $endblock = $end;
1.1062 raeburn 4773: if ($trigger ne '') {
4774: $triggerblock = $trigger;
4775: }
1.502 raeburn 4776: }
1.490 raeburn 4777: }
1.1062 raeburn 4778: return ($startblock,$endblock,$triggerblock);
1.490 raeburn 4779: }
4780:
4781: sub get_blocks {
1.1062 raeburn 4782: my ($setters,$activity,$cdom,$cnum,$url) = @_;
1.490 raeburn 4783: my $startblock = 0;
4784: my $endblock = 0;
1.1062 raeburn 4785: my $triggerblock = '';
1.490 raeburn 4786: my $course = $cdom.'_'.$cnum;
4787: $setters->{$course} = {};
4788: $setters->{$course}{'staff'} = [];
4789: $setters->{$course}{'times'} = [];
1.1062 raeburn 4790: $setters->{$course}{'triggers'} = [];
4791: my (@blockers,%triggered);
4792: my $now = time;
4793: my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
4794: if ($activity eq 'docs') {
4795: @blockers = &Apache::lonnet::has_comm_blocking('bre',undef,$url,\%commblocks);
4796: foreach my $block (@blockers) {
4797: if ($block =~ /^firstaccess____(.+)$/) {
4798: my $item = $1;
4799: my $type = 'map';
4800: my $timersymb = $item;
4801: if ($item eq 'course') {
4802: $type = 'course';
4803: } elsif ($item =~ /___\d+___/) {
4804: $type = 'resource';
4805: } else {
4806: $timersymb = &Apache::lonnet::symbread($item);
4807: }
4808: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
4809: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
4810: $triggered{$block} = {
4811: start => $start,
4812: end => $end,
4813: type => $type,
4814: };
4815: }
4816: }
4817: } else {
4818: foreach my $block (keys(%commblocks)) {
4819: if ($block =~ m/^(\d+)____(\d+)$/) {
4820: my ($start,$end) = ($1,$2);
4821: if ($start <= time && $end >= time) {
4822: if (ref($commblocks{$block}) eq 'HASH') {
4823: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
4824: if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
4825: unless(grep(/^\Q$block\E$/,@blockers)) {
4826: push(@blockers,$block);
4827: }
4828: }
4829: }
4830: }
4831: }
4832: } elsif ($block =~ /^firstaccess____(.+)$/) {
4833: my $item = $1;
4834: my $timersymb = $item;
4835: my $type = 'map';
4836: if ($item eq 'course') {
4837: $type = 'course';
4838: } elsif ($item =~ /___\d+___/) {
4839: $type = 'resource';
4840: } else {
4841: $timersymb = &Apache::lonnet::symbread($item);
4842: }
4843: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
4844: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
4845: if ($start && $end) {
4846: if (($start <= time) && ($end >= time)) {
4847: unless (grep(/^\Q$block\E$/,@blockers)) {
4848: push(@blockers,$block);
4849: $triggered{$block} = {
4850: start => $start,
4851: end => $end,
4852: type => $type,
4853: };
4854: }
4855: }
1.490 raeburn 4856: }
1.1062 raeburn 4857: }
4858: }
4859: }
4860: foreach my $blocker (@blockers) {
4861: my ($staff_name,$staff_dom,$title,$blocks) =
4862: &parse_block_record($commblocks{$blocker});
4863: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
4864: my ($start,$end,$triggertype);
4865: if ($blocker =~ m/^(\d+)____(\d+)$/) {
4866: ($start,$end) = ($1,$2);
4867: } elsif (ref($triggered{$blocker}) eq 'HASH') {
4868: $start = $triggered{$blocker}{'start'};
4869: $end = $triggered{$blocker}{'end'};
4870: $triggertype = $triggered{$blocker}{'type'};
4871: }
4872: if ($start) {
4873: push(@{$$setters{$course}{'times'}}, [$start,$end]);
4874: if ($triggertype) {
4875: push(@{$$setters{$course}{'triggers'}},$triggertype);
4876: } else {
4877: push(@{$$setters{$course}{'triggers'}},0);
4878: }
4879: if ( ($startblock == 0) || ($startblock > $start) ) {
4880: $startblock = $start;
4881: if ($triggertype) {
4882: $triggerblock = $blocker;
1.474 raeburn 4883: }
4884: }
1.1062 raeburn 4885: if ( ($endblock == 0) || ($endblock < $end) ) {
4886: $endblock = $end;
4887: if ($triggertype) {
4888: $triggerblock = $blocker;
4889: }
4890: }
1.474 raeburn 4891: }
4892: }
1.1062 raeburn 4893: return ($startblock,$endblock,$triggerblock);
1.474 raeburn 4894: }
4895:
4896: sub parse_block_record {
4897: my ($record) = @_;
4898: my ($setuname,$setudom,$title,$blocks);
4899: if (ref($record) eq 'HASH') {
4900: ($setuname,$setudom) = split(/:/,$record->{'setter'});
4901: $title = &unescape($record->{'event'});
4902: $blocks = $record->{'blocks'};
4903: } else {
4904: my @data = split(/:/,$record,3);
4905: if (scalar(@data) eq 2) {
4906: $title = $data[1];
4907: ($setuname,$setudom) = split(/@/,$data[0]);
4908: } else {
4909: ($setuname,$setudom,$title) = @data;
4910: }
4911: $blocks = { 'com' => 'on' };
4912: }
4913: return ($setuname,$setudom,$title,$blocks);
4914: }
4915:
1.854 kalberla 4916: sub blocking_status {
1.1189 raeburn 4917: my ($activity,$uname,$udom,$url,$is_course) = @_;
1.1061 raeburn 4918: my %setters;
1.890 droeschl 4919:
1.1061 raeburn 4920: # check for active blocking
1.1062 raeburn 4921: my ($startblock,$endblock,$triggerblock) =
1.1189 raeburn 4922: &blockcheck(\%setters,$activity,$uname,$udom,$url,$is_course);
1.1062 raeburn 4923: my $blocked = 0;
4924: if ($startblock && $endblock) {
4925: $blocked = 1;
4926: }
1.890 droeschl 4927:
1.1061 raeburn 4928: # caller just wants to know whether a block is active
4929: if (!wantarray) { return $blocked; }
4930:
4931: # build a link to a popup window containing the details
4932: my $querystring = "?activity=$activity";
4933: # $uname and $udom decide whose portfolio the user is trying to look at
1.1062 raeburn 4934: if ($activity eq 'port') {
4935: $querystring .= "&udom=$udom" if $udom;
4936: $querystring .= "&uname=$uname" if $uname;
4937: } elsif ($activity eq 'docs') {
4938: $querystring .= '&url='.&HTML::Entities::encode($url,'&"');
4939: }
1.1061 raeburn 4940:
4941: my $output .= <<'END_MYBLOCK';
4942: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
4943: var options = "width=" + w + ",height=" + h + ",";
4944: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
4945: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
4946: var newWin = window.open(url, wdwName, options);
4947: newWin.focus();
4948: }
1.890 droeschl 4949: END_MYBLOCK
1.854 kalberla 4950:
1.1061 raeburn 4951: $output = Apache::lonhtmlcommon::scripttag($output);
1.890 droeschl 4952:
1.1061 raeburn 4953: my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062 raeburn 4954: my $text = &mt('Communication Blocked');
4955: if ($activity eq 'docs') {
4956: $text = &mt('Content Access Blocked');
1.1063 raeburn 4957: } elsif ($activity eq 'printout') {
4958: $text = &mt('Printing Blocked');
1.1062 raeburn 4959: }
1.1061 raeburn 4960: $output .= <<"END_BLOCK";
1.867 kalberla 4961: <div class='LC_comblock'>
1.869 kalberla 4962: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4963: title='$text'>
4964: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 4965: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4966: title='$text'>$text</a>
1.867 kalberla 4967: </div>
4968:
4969: END_BLOCK
1.474 raeburn 4970:
1.1061 raeburn 4971: return ($blocked, $output);
1.854 kalberla 4972: }
1.490 raeburn 4973:
1.60 matthew 4974: ###############################################
4975:
1.682 raeburn 4976: sub check_ip_acc {
1.1201 raeburn 4977: my ($acc,$clientip)=@_;
1.682 raeburn 4978: &Apache::lonxml::debug("acc is $acc");
4979: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
4980: return 1;
4981: }
4982: my $allowed=0;
1.1201 raeburn 4983: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'} || $clientip;
1.682 raeburn 4984:
4985: my $name;
4986: foreach my $pattern (split(',',$acc)) {
4987: $pattern =~ s/^\s*//;
4988: $pattern =~ s/\s*$//;
4989: if ($pattern =~ /\*$/) {
4990: #35.8.*
4991: $pattern=~s/\*//;
4992: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4993: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
4994: #35.8.3.[34-56]
4995: my $low=$2;
4996: my $high=$3;
4997: $pattern=$1;
4998: if ($ip =~ /^\Q$pattern\E/) {
4999: my $last=(split(/\./,$ip))[3];
5000: if ($last <=$high && $last >=$low) { $allowed=1; }
5001: }
5002: } elsif ($pattern =~ /^\*/) {
5003: #*.msu.edu
5004: $pattern=~s/\*//;
5005: if (!defined($name)) {
5006: use Socket;
5007: my $netaddr=inet_aton($ip);
5008: ($name)=gethostbyaddr($netaddr,AF_INET);
5009: }
5010: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
5011: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
5012: #127.0.0.1
5013: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
5014: } else {
5015: #some.name.com
5016: if (!defined($name)) {
5017: use Socket;
5018: my $netaddr=inet_aton($ip);
5019: ($name)=gethostbyaddr($netaddr,AF_INET);
5020: }
5021: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
5022: }
5023: if ($allowed) { last; }
5024: }
5025: return $allowed;
5026: }
5027:
5028: ###############################################
5029:
1.60 matthew 5030: =pod
5031:
1.112 bowersj2 5032: =head1 Domain Template Functions
5033:
5034: =over 4
5035:
5036: =item * &determinedomain()
1.60 matthew 5037:
5038: Inputs: $domain (usually will be undef)
5039:
1.63 www 5040: Returns: Determines which domain should be used for designs
1.60 matthew 5041:
5042: =cut
1.54 www 5043:
1.60 matthew 5044: ###############################################
1.63 www 5045: sub determinedomain {
5046: my $domain=shift;
1.531 albertel 5047: if (! $domain) {
1.60 matthew 5048: # Determine domain if we have not been given one
1.893 raeburn 5049: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 5050: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
5051: if ($env{'request.role.domain'}) {
5052: $domain=$env{'request.role.domain'};
1.60 matthew 5053: }
5054: }
1.63 www 5055: return $domain;
5056: }
5057: ###############################################
1.517 raeburn 5058:
1.518 albertel 5059: sub devalidate_domconfig_cache {
5060: my ($udom)=@_;
5061: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
5062: }
5063:
5064: # ---------------------- Get domain configuration for a domain
5065: sub get_domainconf {
5066: my ($udom) = @_;
5067: my $cachetime=1800;
5068: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
5069: if (defined($cached)) { return %{$result}; }
5070:
5071: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 5072: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 5073: my (%designhash,%legacy);
1.518 albertel 5074: if (keys(%domconfig) > 0) {
5075: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 5076: if (keys(%{$domconfig{'login'}})) {
5077: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 5078: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.946 raeburn 5079: if ($key eq 'loginvia') {
5080: if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') {
1.1013 raeburn 5081: foreach my $hostname (keys(%{$domconfig{'login'}{'loginvia'}})) {
1.948 raeburn 5082: if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') {
5083: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
5084: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
5085: $designhash{$udom.'.login.loginvia'} = $server;
5086: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
5087:
5088: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
5089: } else {
1.1013 raeburn 5090: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
1.948 raeburn 5091: }
5092: if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) {
5093: $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'};
5094: }
1.946 raeburn 5095: }
5096: }
5097: }
5098: }
5099: } else {
5100: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
5101: $designhash{$udom.'.login.'.$key.'_'.$img} =
5102: $domconfig{'login'}{$key}{$img};
5103: }
1.699 raeburn 5104: }
5105: } else {
5106: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
5107: }
1.632 raeburn 5108: }
5109: } else {
5110: $legacy{'login'} = 1;
1.518 albertel 5111: }
1.632 raeburn 5112: } else {
5113: $legacy{'login'} = 1;
1.518 albertel 5114: }
5115: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 5116: if (keys(%{$domconfig{'rolecolors'}})) {
5117: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
5118: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
5119: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
5120: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
5121: }
1.518 albertel 5122: }
5123: }
1.632 raeburn 5124: } else {
5125: $legacy{'rolecolors'} = 1;
1.518 albertel 5126: }
1.632 raeburn 5127: } else {
5128: $legacy{'rolecolors'} = 1;
1.518 albertel 5129: }
1.948 raeburn 5130: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
5131: if ($domconfig{'autoenroll'}{'co-owners'}) {
5132: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
5133: }
5134: }
1.632 raeburn 5135: if (keys(%legacy) > 0) {
5136: my %legacyhash = &get_legacy_domconf($udom);
5137: foreach my $item (keys(%legacyhash)) {
5138: if ($item =~ /^\Q$udom\E\.login/) {
5139: if ($legacy{'login'}) {
5140: $designhash{$item} = $legacyhash{$item};
5141: }
5142: } else {
5143: if ($legacy{'rolecolors'}) {
5144: $designhash{$item} = $legacyhash{$item};
5145: }
1.518 albertel 5146: }
5147: }
5148: }
1.632 raeburn 5149: } else {
5150: %designhash = &get_legacy_domconf($udom);
1.518 albertel 5151: }
5152: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
5153: $cachetime);
5154: return %designhash;
5155: }
5156:
1.632 raeburn 5157: sub get_legacy_domconf {
5158: my ($udom) = @_;
5159: my %legacyhash;
5160: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
5161: my $designfile = $designdir.'/'.$udom.'.tab';
5162: if (-e $designfile) {
5163: if ( open (my $fh,"<$designfile") ) {
5164: while (my $line = <$fh>) {
5165: next if ($line =~ /^\#/);
5166: chomp($line);
5167: my ($key,$val)=(split(/\=/,$line));
5168: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
5169: }
5170: close($fh);
5171: }
5172: }
1.1026 raeburn 5173: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632 raeburn 5174: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
5175: }
5176: return %legacyhash;
5177: }
5178:
1.63 www 5179: =pod
5180:
1.112 bowersj2 5181: =item * &domainlogo()
1.63 www 5182:
5183: Inputs: $domain (usually will be undef)
5184:
5185: Returns: A link to a domain logo, if the domain logo exists.
5186: If the domain logo does not exist, a description of the domain.
5187:
5188: =cut
1.112 bowersj2 5189:
1.63 www 5190: ###############################################
5191: sub domainlogo {
1.517 raeburn 5192: my $domain = &determinedomain(shift);
1.518 albertel 5193: my %designhash = &get_domainconf($domain);
1.517 raeburn 5194: # See if there is a logo
5195: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 5196: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 5197: if ($imgsrc =~ m{^/(adm|res)/}) {
5198: if ($imgsrc =~ m{^/res/}) {
5199: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
5200: &Apache::lonnet::repcopy($local_name);
5201: }
5202: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 5203: }
5204: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 5205: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
5206: return &Apache::lonnet::domain($domain,'description');
1.59 www 5207: } else {
1.60 matthew 5208: return '';
1.59 www 5209: }
5210: }
1.63 www 5211: ##############################################
5212:
5213: =pod
5214:
1.112 bowersj2 5215: =item * &designparm()
1.63 www 5216:
5217: Inputs: $which parameter; $domain (usually will be undef)
5218:
5219: Returns: value of designparamter $which
5220:
5221: =cut
1.112 bowersj2 5222:
1.397 albertel 5223:
1.400 albertel 5224: ##############################################
1.397 albertel 5225: sub designparm {
5226: my ($which,$domain)=@_;
5227: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 5228: return $env{'environment.color.'.$which};
1.96 www 5229: }
1.63 www 5230: $domain=&determinedomain($domain);
1.1016 raeburn 5231: my %domdesign;
5232: unless ($domain eq 'public') {
5233: %domdesign = &get_domainconf($domain);
5234: }
1.520 raeburn 5235: my $output;
1.517 raeburn 5236: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 5237: $output = $domdesign{$domain.'.'.$which};
1.63 www 5238: } else {
1.520 raeburn 5239: $output = $defaultdesign{$which};
5240: }
5241: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 5242: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 5243: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 5244: if ($output =~ m{^/res/}) {
5245: my $local_name = &Apache::lonnet::filelocation('',$output);
5246: &Apache::lonnet::repcopy($local_name);
5247: }
1.520 raeburn 5248: $output = &lonhttpdurl($output);
5249: }
1.63 www 5250: }
1.520 raeburn 5251: return $output;
1.63 www 5252: }
1.59 www 5253:
1.822 bisitz 5254: ##############################################
5255: =pod
5256:
1.832 bisitz 5257: =item * &authorspace()
5258:
1.1028 raeburn 5259: Inputs: $url (usually will be undef).
1.832 bisitz 5260:
1.1132 raeburn 5261: Returns: Path to Authoring Space containing the resource or
1.1028 raeburn 5262: directory being viewed (or for which action is being taken).
5263: If $url is provided, and begins /priv/<domain>/<uname>
5264: the path will be that portion of the $context argument.
5265: Otherwise the path will be for the author space of the current
5266: user when the current role is author, or for that of the
5267: co-author/assistant co-author space when the current role
5268: is co-author or assistant co-author.
1.832 bisitz 5269:
5270: =cut
5271:
5272: sub authorspace {
1.1028 raeburn 5273: my ($url) = @_;
5274: if ($url ne '') {
5275: if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
5276: return $1;
5277: }
5278: }
1.832 bisitz 5279: my $caname = '';
1.1024 www 5280: my $cadom = '';
1.1028 raeburn 5281: if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024 www 5282: ($cadom,$caname) =
1.832 bisitz 5283: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028 raeburn 5284: } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832 bisitz 5285: $caname = $env{'user.name'};
1.1024 www 5286: $cadom = $env{'user.domain'};
1.832 bisitz 5287: }
1.1028 raeburn 5288: if (($caname ne '') && ($cadom ne '')) {
5289: return "/priv/$cadom/$caname/";
5290: }
5291: return;
1.832 bisitz 5292: }
5293:
5294: ##############################################
5295: =pod
5296:
1.822 bisitz 5297: =item * &head_subbox()
5298:
5299: Inputs: $content (contains HTML code with page functions, etc.)
5300:
5301: Returns: HTML div with $content
5302: To be included in page header
5303:
5304: =cut
5305:
5306: sub head_subbox {
5307: my ($content)=@_;
5308: my $output =
1.993 raeburn 5309: '<div class="LC_head_subbox">'
1.822 bisitz 5310: .$content
5311: .'</div>'
5312: }
5313:
5314: ##############################################
5315: =pod
5316:
5317: =item * &CSTR_pageheader()
5318:
1.1026 raeburn 5319: Input: (optional) filename from which breadcrumb trail is built.
5320: In most cases no input as needed, as $env{'request.filename'}
5321: is appropriate for use in building the breadcrumb trail.
1.822 bisitz 5322:
5323: Returns: HTML div with CSTR path and recent box
1.1132 raeburn 5324: To be included on Authoring Space pages
1.822 bisitz 5325:
5326: =cut
5327:
5328: sub CSTR_pageheader {
1.1026 raeburn 5329: my ($trailfile) = @_;
5330: if ($trailfile eq '') {
5331: $trailfile = $env{'request.filename'};
5332: }
5333:
5334: # this is for resources; directories have customtitle, and crumbs
5335: # and select recent are created in lonpubdir.pm
5336:
5337: my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022 www 5338: my ($udom,$uname,$thisdisfn)=
1.1113 raeburn 5339: ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)(?:|/(.*))$});
1.1026 raeburn 5340: my $formaction = "/priv/$udom/$uname/$thisdisfn";
5341: $formaction =~ s{/+}{/}g;
1.822 bisitz 5342:
5343: my $parentpath = '';
5344: my $lastitem = '';
5345: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
5346: $parentpath = $1;
5347: $lastitem = $2;
5348: } else {
5349: $lastitem = $thisdisfn;
5350: }
1.921 bisitz 5351:
5352: my $output =
1.822 bisitz 5353: '<div>'
5354: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
1.1132 raeburn 5355: .'<b>'.&mt('Authoring Space:').'</b> '
1.822 bisitz 5356: .'<form name="dirs" method="post" action="'.$formaction
1.921 bisitz 5357: .'" target="_top">' #FIXME lonpubdir: target="_parent"
1.1024 www 5358: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv/'.$udom,undef,undef);
1.921 bisitz 5359:
5360: if ($lastitem) {
5361: $output .=
5362: '<span class="LC_filename">'
5363: .$lastitem
5364: .'</span>';
5365: }
5366: $output .=
5367: '<br />'
1.822 bisitz 5368: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
5369: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
5370: .'</form>'
5371: .&Apache::lonmenu::constspaceform()
5372: .'</div>';
1.921 bisitz 5373:
5374: return $output;
1.822 bisitz 5375: }
5376:
1.60 matthew 5377: ###############################################
5378: ###############################################
5379:
5380: =pod
5381:
1.112 bowersj2 5382: =back
5383:
1.549 albertel 5384: =head1 HTML Helpers
1.112 bowersj2 5385:
5386: =over 4
5387:
5388: =item * &bodytag()
1.60 matthew 5389:
5390: Returns a uniform header for LON-CAPA web pages.
5391:
5392: Inputs:
5393:
1.112 bowersj2 5394: =over 4
5395:
5396: =item * $title, A title to be displayed on the page.
5397:
5398: =item * $function, the current role (can be undef).
5399:
5400: =item * $addentries, extra parameters for the <body> tag.
5401:
5402: =item * $bodyonly, if defined, only return the <body> tag.
5403:
5404: =item * $domain, if defined, force a given domain.
5405:
5406: =item * $forcereg, if page should register as content page (relevant for
1.86 www 5407: text interface only)
1.60 matthew 5408:
1.814 bisitz 5409: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
5410: navigational links
1.317 albertel 5411:
1.338 albertel 5412: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
5413:
1.460 albertel 5414: =item * $args, optional argument valid values are
5415: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 5416: inherit_jsmath -> when creating popup window in a page,
5417: should it have jsmath forced on by the
5418: current page
1.460 albertel 5419:
1.1096 raeburn 5420: =item * $advtoolsref, optional argument, ref to an array containing
5421: inlineremote items to be added in "Functions" menu below
5422: breadcrumbs.
5423:
1.112 bowersj2 5424: =back
5425:
1.60 matthew 5426: Returns: A uniform header for LON-CAPA web pages.
5427: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
5428: If $bodyonly is undef or zero, an html string containing a <body> tag and
5429: other decorations will be returned.
5430:
5431: =cut
5432:
1.54 www 5433: sub bodytag {
1.831 bisitz 5434: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1096 raeburn 5435: $no_nav_bar,$bgcolor,$args,$advtoolsref)=@_;
1.339 albertel 5436:
1.954 raeburn 5437: my $public;
5438: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
5439: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
5440: $public = 1;
5441: }
1.460 albertel 5442: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1154 raeburn 5443: my $httphost = $args->{'use_absolute'};
1.339 albertel 5444:
1.183 matthew 5445: $function = &get_users_function() if (!$function);
1.339 albertel 5446: my $img = &designparm($function.'.img',$domain);
5447: my $font = &designparm($function.'.font',$domain);
5448: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
5449:
1.803 bisitz 5450: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 5451: 'bgcolor' => $pgbg,
1.339 albertel 5452: 'text' => $font,
5453: 'alink' => &designparm($function.'.alink',$domain),
5454: 'vlink' => &designparm($function.'.vlink',$domain),
5455: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 5456: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 5457:
1.63 www 5458: # role and realm
1.1178 raeburn 5459: my ($role,$realm) = split(m{\./},$env{'request.role'},2);
5460: if ($realm) {
5461: $realm = '/'.$realm;
5462: }
1.378 raeburn 5463: if ($role eq 'ca') {
1.479 albertel 5464: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 5465: $realm = &plainname($rname,$rdom);
1.378 raeburn 5466: }
1.55 www 5467: # realm
1.258 albertel 5468: if ($env{'request.course.id'}) {
1.378 raeburn 5469: if ($env{'request.role'} !~ /^cr/) {
5470: $role = &Apache::lonnet::plaintext($role,&course_type());
5471: }
1.898 raeburn 5472: if ($env{'request.course.sec'}) {
5473: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
5474: }
1.359 albertel 5475: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 5476: } else {
5477: $role = &Apache::lonnet::plaintext($role);
1.54 www 5478: }
1.433 albertel 5479:
1.359 albertel 5480: if (!$realm) { $realm=' '; }
1.330 albertel 5481:
1.438 albertel 5482: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 5483:
1.101 www 5484: # construct main body tag
1.359 albertel 5485: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 5486: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 5487:
1.1131 raeburn 5488: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
5489:
1.1130 raeburn 5490: if (($bodyonly) || ($no_nav_bar) || ($env{'form.inhibitmenu'} eq 'yes')) {
1.60 matthew 5491: return $bodytag;
1.1130 raeburn 5492: }
1.359 albertel 5493:
1.954 raeburn 5494: if ($public) {
1.433 albertel 5495: undef($role);
5496: }
1.359 albertel 5497:
1.762 bisitz 5498: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 5499: #
5500: # Extra info if you are the DC
5501: my $dc_info = '';
5502: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
5503: $env{'course.'.$env{'request.course.id'}.
5504: '.domain'}.'/'})) {
5505: my $cid = $env{'request.course.id'};
1.917 raeburn 5506: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 5507: $dc_info =~ s/\s+$//;
1.359 albertel 5508: }
5509:
1.898 raeburn 5510: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853 droeschl 5511:
1.903 droeschl 5512: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
5513:
5514: # if ($env{'request.state'} eq 'construct') {
5515: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
5516: # }
5517:
1.1130 raeburn 5518: $bodytag .= Apache::lonhtmlcommon::scripttag(
1.1154 raeburn 5519: Apache::lonmenu::utilityfunctions($httphost), 'start');
1.359 albertel 5520:
1.1130 raeburn 5521: my ($left,$right) = Apache::lonmenu::primary_menu();
1.359 albertel 5522:
1.916 droeschl 5523: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917 raeburn 5524: if ($dc_info) {
5525: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
5526: }
1.1130 raeburn 5527: $bodytag .= qq|<div id="LC_nav_bar">$left $role<br />
1.916 droeschl 5528: <em>$realm</em> $dc_info</div>|;
1.903 droeschl 5529: return $bodytag;
5530: }
1.894 droeschl 5531:
1.927 raeburn 5532: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
1.1130 raeburn 5533: $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
1.927 raeburn 5534: }
1.916 droeschl 5535:
1.1130 raeburn 5536: $bodytag .= $right;
1.852 droeschl 5537:
1.917 raeburn 5538: if ($dc_info) {
5539: $dc_info = &dc_courseid_toggle($dc_info);
5540: }
5541: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 5542:
1.1169 raeburn 5543: #if directed to not display the secondary menu, don't.
1.1168 raeburn 5544: if ($args->{'no_secondary_menu'}) {
5545: return $bodytag;
5546: }
1.1169 raeburn 5547: #don't show menus for public users
1.954 raeburn 5548: if (!$public){
1.1154 raeburn 5549: $bodytag .= Apache::lonmenu::secondary_menu($httphost);
1.903 droeschl 5550: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 5551: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
5552: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 5553: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.920 raeburn 5554: $args->{'bread_crumbs'});
1.1096 raeburn 5555: } elsif ($forcereg) {
5556: $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
5557: $args->{'group'});
5558: } else {
5559: $bodytag .=
5560: &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
5561: $forcereg,$args->{'group'},
5562: $args->{'bread_crumbs'},
5563: $advtoolsref);
1.920 raeburn 5564: }
1.903 droeschl 5565: }else{
5566: # this is to seperate menu from content when there's no secondary
5567: # menu. Especially needed for public accessible ressources.
5568: $bodytag .= '<hr style="clear:both" />';
5569: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 5570: }
1.903 droeschl 5571:
1.235 raeburn 5572: return $bodytag;
1.182 matthew 5573: }
5574:
1.917 raeburn 5575: sub dc_courseid_toggle {
5576: my ($dc_info) = @_;
1.980 raeburn 5577: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069 raeburn 5578: '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917 raeburn 5579: &mt('(More ...)').'</a></span>'.
5580: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
5581: }
5582:
1.330 albertel 5583: sub make_attr_string {
5584: my ($register,$attr_ref) = @_;
5585:
5586: if ($attr_ref && !ref($attr_ref)) {
5587: die("addentries Must be a hash ref ".
5588: join(':',caller(1))." ".
5589: join(':',caller(0))." ");
5590: }
5591:
5592: if ($register) {
1.339 albertel 5593: my ($on_load,$on_unload);
5594: foreach my $key (keys(%{$attr_ref})) {
5595: if (lc($key) eq 'onload') {
5596: $on_load.=$attr_ref->{$key}.';';
5597: delete($attr_ref->{$key});
5598:
5599: } elsif (lc($key) eq 'onunload') {
5600: $on_unload.=$attr_ref->{$key}.';';
5601: delete($attr_ref->{$key});
5602: }
5603: }
1.953 droeschl 5604: $attr_ref->{'onload'} = $on_load;
5605: $attr_ref->{'onunload'}= $on_unload;
1.330 albertel 5606: }
1.339 albertel 5607:
1.330 albertel 5608: my $attr_string;
1.1159 raeburn 5609: foreach my $attr (sort(keys(%$attr_ref))) {
1.330 albertel 5610: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
5611: }
5612: return $attr_string;
5613: }
5614:
5615:
1.182 matthew 5616: ###############################################
1.251 albertel 5617: ###############################################
5618:
5619: =pod
5620:
5621: =item * &endbodytag()
5622:
5623: Returns a uniform footer for LON-CAPA web pages.
5624:
1.635 raeburn 5625: Inputs: 1 - optional reference to an args hash
5626: If in the hash, key for noredirectlink has a value which evaluates to true,
5627: a 'Continue' link is not displayed if the page contains an
5628: internal redirect in the <head></head> section,
5629: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 5630:
5631: =cut
5632:
5633: sub endbodytag {
1.635 raeburn 5634: my ($args) = @_;
1.1080 raeburn 5635: my $endbodytag;
5636: unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
5637: $endbodytag='</body>';
5638: }
1.269 albertel 5639: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 5640: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 5641: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
5642: $endbodytag=
5643: "<br /><a href=\"$env{'internal.head.redirect'}\">".
5644: &mt('Continue').'</a>'.
5645: $endbodytag;
5646: }
1.315 albertel 5647: }
1.251 albertel 5648: return $endbodytag;
5649: }
5650:
1.352 albertel 5651: =pod
5652:
5653: =item * &standard_css()
5654:
5655: Returns a style sheet
5656:
5657: Inputs: (all optional)
5658: domain -> force to color decorate a page for a specific
5659: domain
5660: function -> force usage of a specific rolish color scheme
5661: bgcolor -> override the default page bgcolor
5662:
5663: =cut
5664:
1.343 albertel 5665: sub standard_css {
1.345 albertel 5666: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 5667: $function = &get_users_function() if (!$function);
5668: my $img = &designparm($function.'.img', $domain);
5669: my $tabbg = &designparm($function.'.tabbg', $domain);
5670: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 5671: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 5672: #second colour for later usage
1.345 albertel 5673: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 5674: my $pgbg_or_bgcolor =
5675: $bgcolor ||
1.352 albertel 5676: &designparm($function.'.pgbg', $domain);
1.382 albertel 5677: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 5678: my $alink = &designparm($function.'.alink', $domain);
5679: my $vlink = &designparm($function.'.vlink', $domain);
5680: my $link = &designparm($function.'.link', $domain);
5681:
1.602 albertel 5682: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 5683: my $mono = 'monospace';
1.850 bisitz 5684: my $data_table_head = $sidebg;
5685: my $data_table_light = '#FAFAFA';
1.1060 bisitz 5686: my $data_table_dark = '#E0E0E0';
1.470 banghart 5687: my $data_table_darker = '#CCCCCC';
1.349 albertel 5688: my $data_table_highlight = '#FFFF00';
1.352 albertel 5689: my $mail_new = '#FFBB77';
5690: my $mail_new_hover = '#DD9955';
5691: my $mail_read = '#BBBB77';
5692: my $mail_read_hover = '#999944';
5693: my $mail_replied = '#AAAA88';
5694: my $mail_replied_hover = '#888855';
5695: my $mail_other = '#99BBBB';
5696: my $mail_other_hover = '#669999';
1.391 albertel 5697: my $table_header = '#DDDDDD';
1.489 raeburn 5698: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 5699: my $lg_border_color = '#C8C8C8';
1.952 onken 5700: my $button_hover = '#BF2317';
1.392 albertel 5701:
1.608 albertel 5702: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 5703: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
5704: : '0 3px 0 4px';
1.448 albertel 5705:
1.523 albertel 5706:
1.343 albertel 5707: return <<END;
1.947 droeschl 5708:
5709: /* needed for iframe to allow 100% height in FF */
5710: body, html {
5711: margin: 0;
5712: padding: 0 0.5%;
5713: height: 99%; /* to avoid scrollbars */
5714: }
5715:
1.795 www 5716: body {
1.911 bisitz 5717: font-family: $sans;
5718: line-height:130%;
5719: font-size:0.83em;
5720: color:$font;
1.795 www 5721: }
5722:
1.959 onken 5723: a:focus,
5724: a:focus img {
1.795 www 5725: color: red;
5726: }
1.698 harmsja 5727:
1.911 bisitz 5728: form, .inline {
5729: display: inline;
1.795 www 5730: }
1.721 harmsja 5731:
1.795 www 5732: .LC_right {
1.911 bisitz 5733: text-align:right;
1.795 www 5734: }
5735:
5736: .LC_middle {
1.911 bisitz 5737: vertical-align:middle;
1.795 www 5738: }
1.721 harmsja 5739:
1.1130 raeburn 5740: .LC_floatleft {
5741: float: left;
5742: }
5743:
5744: .LC_floatright {
5745: float: right;
5746: }
5747:
1.911 bisitz 5748: .LC_400Box {
5749: width:400px;
5750: }
1.721 harmsja 5751:
1.947 droeschl 5752: .LC_iframecontainer {
5753: width: 98%;
5754: margin: 0;
5755: position: fixed;
5756: top: 8.5em;
5757: bottom: 0;
5758: }
5759:
5760: .LC_iframecontainer iframe{
5761: border: none;
5762: width: 100%;
5763: height: 100%;
5764: }
5765:
1.778 bisitz 5766: .LC_filename {
5767: font-family: $mono;
5768: white-space:pre;
1.921 bisitz 5769: font-size: 120%;
1.778 bisitz 5770: }
5771:
5772: .LC_fileicon {
5773: border: none;
5774: height: 1.3em;
5775: vertical-align: text-bottom;
5776: margin-right: 0.3em;
5777: text-decoration:none;
5778: }
5779:
1.1008 www 5780: .LC_setting {
5781: text-decoration:underline;
5782: }
5783:
1.350 albertel 5784: .LC_error {
5785: color: red;
5786: }
1.795 www 5787:
1.1097 bisitz 5788: .LC_warning {
5789: color: darkorange;
5790: }
5791:
1.457 albertel 5792: .LC_diff_removed {
1.733 bisitz 5793: color: red;
1.394 albertel 5794: }
1.532 albertel 5795:
5796: .LC_info,
1.457 albertel 5797: .LC_success,
5798: .LC_diff_added {
1.350 albertel 5799: color: green;
5800: }
1.795 www 5801:
1.802 bisitz 5802: div.LC_confirm_box {
5803: background-color: #FAFAFA;
5804: border: 1px solid $lg_border_color;
5805: margin-right: 0;
5806: padding: 5px;
5807: }
5808:
5809: div.LC_confirm_box .LC_error img,
5810: div.LC_confirm_box .LC_success img {
5811: vertical-align: middle;
5812: }
5813:
1.440 albertel 5814: .LC_icon {
1.771 droeschl 5815: border: none;
1.790 droeschl 5816: vertical-align: middle;
1.771 droeschl 5817: }
5818:
1.543 albertel 5819: .LC_docs_spacer {
5820: width: 25px;
5821: height: 1px;
1.771 droeschl 5822: border: none;
1.543 albertel 5823: }
1.346 albertel 5824:
1.532 albertel 5825: .LC_internal_info {
1.735 bisitz 5826: color: #999999;
1.532 albertel 5827: }
5828:
1.794 www 5829: .LC_discussion {
1.1050 www 5830: background: $data_table_dark;
1.911 bisitz 5831: border: 1px solid black;
5832: margin: 2px;
1.794 www 5833: }
5834:
5835: .LC_disc_action_left {
1.1050 www 5836: background: $sidebg;
1.911 bisitz 5837: text-align: left;
1.1050 www 5838: padding: 4px;
5839: margin: 2px;
1.794 www 5840: }
5841:
5842: .LC_disc_action_right {
1.1050 www 5843: background: $sidebg;
1.911 bisitz 5844: text-align: right;
1.1050 www 5845: padding: 4px;
5846: margin: 2px;
1.794 www 5847: }
5848:
5849: .LC_disc_new_item {
1.911 bisitz 5850: background: white;
5851: border: 2px solid red;
1.1050 www 5852: margin: 4px;
5853: padding: 4px;
1.794 www 5854: }
5855:
5856: .LC_disc_old_item {
1.911 bisitz 5857: background: white;
1.1050 www 5858: margin: 4px;
5859: padding: 4px;
1.794 www 5860: }
5861:
1.458 albertel 5862: table.LC_pastsubmission {
5863: border: 1px solid black;
5864: margin: 2px;
5865: }
5866:
1.924 bisitz 5867: table#LC_menubuttons {
1.345 albertel 5868: width: 100%;
5869: background: $pgbg;
1.392 albertel 5870: border: 2px;
1.402 albertel 5871: border-collapse: separate;
1.803 bisitz 5872: padding: 0;
1.345 albertel 5873: }
1.392 albertel 5874:
1.801 tempelho 5875: table#LC_title_bar a {
5876: color: $fontmenu;
5877: }
1.836 bisitz 5878:
1.807 droeschl 5879: table#LC_title_bar {
1.819 tempelho 5880: clear: both;
1.836 bisitz 5881: display: none;
1.807 droeschl 5882: }
5883:
1.795 www 5884: table#LC_title_bar,
1.933 droeschl 5885: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 5886: table#LC_title_bar.LC_with_remote {
1.359 albertel 5887: width: 100%;
1.392 albertel 5888: border-color: $pgbg;
5889: border-style: solid;
5890: border-width: $border;
1.379 albertel 5891: background: $pgbg;
1.801 tempelho 5892: color: $fontmenu;
1.392 albertel 5893: border-collapse: collapse;
1.803 bisitz 5894: padding: 0;
1.819 tempelho 5895: margin: 0;
1.359 albertel 5896: }
1.795 www 5897:
1.933 droeschl 5898: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 5899: margin: 0;
5900: padding: 0;
1.933 droeschl 5901: position: relative;
5902: list-style: none;
1.913 droeschl 5903: }
1.933 droeschl 5904: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 5905: display: inline;
5906: }
1.933 droeschl 5907:
5908: .LC_breadcrumb_tools_navigation {
1.913 droeschl 5909: padding: 0;
1.933 droeschl 5910: margin: 0;
5911: float: left;
1.913 droeschl 5912: }
1.933 droeschl 5913: .LC_breadcrumb_tools_tools {
5914: padding: 0;
5915: margin: 0;
1.913 droeschl 5916: float: right;
5917: }
5918:
1.359 albertel 5919: table#LC_title_bar td {
5920: background: $tabbg;
5921: }
1.795 www 5922:
1.911 bisitz 5923: table#LC_menubuttons img {
1.803 bisitz 5924: border: none;
1.346 albertel 5925: }
1.795 www 5926:
1.842 droeschl 5927: .LC_breadcrumbs_component {
1.911 bisitz 5928: float: right;
5929: margin: 0 1em;
1.357 albertel 5930: }
1.842 droeschl 5931: .LC_breadcrumbs_component img {
1.911 bisitz 5932: vertical-align: middle;
1.777 tempelho 5933: }
1.795 www 5934:
1.383 albertel 5935: td.LC_table_cell_checkbox {
5936: text-align: center;
5937: }
1.795 www 5938:
5939: .LC_fontsize_small {
1.911 bisitz 5940: font-size: 70%;
1.705 tempelho 5941: }
5942:
1.844 bisitz 5943: #LC_breadcrumbs {
1.911 bisitz 5944: clear:both;
5945: background: $sidebg;
5946: border-bottom: 1px solid $lg_border_color;
5947: line-height: 2.5em;
1.933 droeschl 5948: overflow: hidden;
1.911 bisitz 5949: margin: 0;
5950: padding: 0;
1.995 raeburn 5951: text-align: left;
1.819 tempelho 5952: }
1.862 bisitz 5953:
1.1098 bisitz 5954: .LC_head_subbox, .LC_actionbox {
1.911 bisitz 5955: clear:both;
5956: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 5957: border: 1px solid $sidebg;
1.1098 bisitz 5958: margin: 0 0 10px 0;
1.966 bisitz 5959: padding: 3px;
1.995 raeburn 5960: text-align: left;
1.822 bisitz 5961: }
5962:
1.795 www 5963: .LC_fontsize_medium {
1.911 bisitz 5964: font-size: 85%;
1.705 tempelho 5965: }
5966:
1.795 www 5967: .LC_fontsize_large {
1.911 bisitz 5968: font-size: 120%;
1.705 tempelho 5969: }
5970:
1.346 albertel 5971: .LC_menubuttons_inline_text {
5972: color: $font;
1.698 harmsja 5973: font-size: 90%;
1.701 harmsja 5974: padding-left:3px;
1.346 albertel 5975: }
5976:
1.934 droeschl 5977: .LC_menubuttons_inline_text img{
5978: vertical-align: middle;
5979: }
5980:
1.1051 www 5981: li.LC_menubuttons_inline_text img {
1.951 onken 5982: cursor:pointer;
1.1002 droeschl 5983: text-decoration: none;
1.951 onken 5984: }
5985:
1.526 www 5986: .LC_menubuttons_link {
5987: text-decoration: none;
5988: }
1.795 www 5989:
1.522 albertel 5990: .LC_menubuttons_category {
1.521 www 5991: color: $font;
1.526 www 5992: background: $pgbg;
1.521 www 5993: font-size: larger;
5994: font-weight: bold;
5995: }
5996:
1.346 albertel 5997: td.LC_menubuttons_text {
1.911 bisitz 5998: color: $font;
1.346 albertel 5999: }
1.706 harmsja 6000:
1.346 albertel 6001: .LC_current_location {
6002: background: $tabbg;
6003: }
1.795 www 6004:
1.938 bisitz 6005: table.LC_data_table {
1.347 albertel 6006: border: 1px solid #000000;
1.402 albertel 6007: border-collapse: separate;
1.426 albertel 6008: border-spacing: 1px;
1.610 albertel 6009: background: $pgbg;
1.347 albertel 6010: }
1.795 www 6011:
1.422 albertel 6012: .LC_data_table_dense {
6013: font-size: small;
6014: }
1.795 www 6015:
1.507 raeburn 6016: table.LC_nested_outer {
6017: border: 1px solid #000000;
1.589 raeburn 6018: border-collapse: collapse;
1.803 bisitz 6019: border-spacing: 0;
1.507 raeburn 6020: width: 100%;
6021: }
1.795 www 6022:
1.879 raeburn 6023: table.LC_innerpickbox,
1.507 raeburn 6024: table.LC_nested {
1.803 bisitz 6025: border: none;
1.589 raeburn 6026: border-collapse: collapse;
1.803 bisitz 6027: border-spacing: 0;
1.507 raeburn 6028: width: 100%;
6029: }
1.795 www 6030:
1.911 bisitz 6031: table.LC_data_table tr th,
6032: table.LC_calendar tr th,
1.879 raeburn 6033: table.LC_prior_tries tr th,
6034: table.LC_innerpickbox tr th {
1.349 albertel 6035: font-weight: bold;
6036: background-color: $data_table_head;
1.801 tempelho 6037: color:$fontmenu;
1.701 harmsja 6038: font-size:90%;
1.347 albertel 6039: }
1.795 www 6040:
1.879 raeburn 6041: table.LC_innerpickbox tr th,
6042: table.LC_innerpickbox tr td {
6043: vertical-align: top;
6044: }
6045:
1.711 raeburn 6046: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 6047: background-color: #CCCCCC;
1.711 raeburn 6048: font-weight: bold;
6049: text-align: left;
6050: }
1.795 www 6051:
1.912 bisitz 6052: table.LC_data_table tr.LC_odd_row > td {
6053: background-color: $data_table_light;
6054: padding: 2px;
6055: vertical-align: top;
6056: }
6057:
1.809 bisitz 6058: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 6059: background-color: $data_table_light;
1.912 bisitz 6060: vertical-align: top;
6061: }
6062:
6063: table.LC_data_table tr.LC_even_row > td {
6064: background-color: $data_table_dark;
1.425 albertel 6065: padding: 2px;
1.900 bisitz 6066: vertical-align: top;
1.347 albertel 6067: }
1.795 www 6068:
1.809 bisitz 6069: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 6070: background-color: $data_table_dark;
1.900 bisitz 6071: vertical-align: top;
1.347 albertel 6072: }
1.795 www 6073:
1.425 albertel 6074: table.LC_data_table tr.LC_data_table_highlight td {
6075: background-color: $data_table_darker;
6076: }
1.795 www 6077:
1.639 raeburn 6078: table.LC_data_table tr td.LC_leftcol_header {
6079: background-color: $data_table_head;
6080: font-weight: bold;
6081: }
1.795 www 6082:
1.451 albertel 6083: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 6084: table.LC_nested tr.LC_empty_row td {
1.421 albertel 6085: font-weight: bold;
6086: font-style: italic;
6087: text-align: center;
6088: padding: 8px;
1.347 albertel 6089: }
1.795 www 6090:
1.1114 raeburn 6091: table.LC_data_table tr.LC_empty_row td,
6092: table.LC_data_table tr.LC_footer_row td {
1.940 bisitz 6093: background-color: $sidebg;
6094: }
6095:
6096: table.LC_nested tr.LC_empty_row td {
6097: background-color: #FFFFFF;
6098: }
6099:
1.890 droeschl 6100: table.LC_caption {
6101: }
6102:
1.507 raeburn 6103: table.LC_nested tr.LC_empty_row td {
1.465 albertel 6104: padding: 4ex
6105: }
1.795 www 6106:
1.507 raeburn 6107: table.LC_nested_outer tr th {
6108: font-weight: bold;
1.801 tempelho 6109: color:$fontmenu;
1.507 raeburn 6110: background-color: $data_table_head;
1.701 harmsja 6111: font-size: small;
1.507 raeburn 6112: border-bottom: 1px solid #000000;
6113: }
1.795 www 6114:
1.507 raeburn 6115: table.LC_nested_outer tr td.LC_subheader {
6116: background-color: $data_table_head;
6117: font-weight: bold;
6118: font-size: small;
6119: border-bottom: 1px solid #000000;
6120: text-align: right;
1.451 albertel 6121: }
1.795 www 6122:
1.507 raeburn 6123: table.LC_nested tr.LC_info_row td {
1.735 bisitz 6124: background-color: #CCCCCC;
1.451 albertel 6125: font-weight: bold;
6126: font-size: small;
1.507 raeburn 6127: text-align: center;
6128: }
1.795 www 6129:
1.589 raeburn 6130: table.LC_nested tr.LC_info_row td.LC_left_item,
6131: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 6132: text-align: left;
1.451 albertel 6133: }
1.795 www 6134:
1.507 raeburn 6135: table.LC_nested td {
1.735 bisitz 6136: background-color: #FFFFFF;
1.451 albertel 6137: font-size: small;
1.507 raeburn 6138: }
1.795 www 6139:
1.507 raeburn 6140: table.LC_nested_outer tr th.LC_right_item,
6141: table.LC_nested tr.LC_info_row td.LC_right_item,
6142: table.LC_nested tr.LC_odd_row td.LC_right_item,
6143: table.LC_nested tr td.LC_right_item {
1.451 albertel 6144: text-align: right;
6145: }
6146:
1.507 raeburn 6147: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 6148: background-color: #EEEEEE;
1.451 albertel 6149: }
6150:
1.473 raeburn 6151: table.LC_createuser {
6152: }
6153:
6154: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 6155: font-size: small;
1.473 raeburn 6156: }
6157:
6158: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 6159: background-color: #CCCCCC;
1.473 raeburn 6160: font-weight: bold;
6161: text-align: center;
6162: }
6163:
1.349 albertel 6164: table.LC_calendar {
6165: border: 1px solid #000000;
6166: border-collapse: collapse;
1.917 raeburn 6167: width: 98%;
1.349 albertel 6168: }
1.795 www 6169:
1.349 albertel 6170: table.LC_calendar_pickdate {
6171: font-size: xx-small;
6172: }
1.795 www 6173:
1.349 albertel 6174: table.LC_calendar tr td {
6175: border: 1px solid #000000;
6176: vertical-align: top;
1.917 raeburn 6177: width: 14%;
1.349 albertel 6178: }
1.795 www 6179:
1.349 albertel 6180: table.LC_calendar tr td.LC_calendar_day_empty {
6181: background-color: $data_table_dark;
6182: }
1.795 www 6183:
1.779 bisitz 6184: table.LC_calendar tr td.LC_calendar_day_current {
6185: background-color: $data_table_highlight;
1.777 tempelho 6186: }
1.795 www 6187:
1.938 bisitz 6188: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 6189: background-color: $mail_new;
6190: }
1.795 www 6191:
1.938 bisitz 6192: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 6193: background-color: $mail_new_hover;
6194: }
1.795 www 6195:
1.938 bisitz 6196: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 6197: background-color: $mail_read;
6198: }
1.795 www 6199:
1.938 bisitz 6200: /*
6201: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 6202: background-color: $mail_read_hover;
6203: }
1.938 bisitz 6204: */
1.795 www 6205:
1.938 bisitz 6206: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 6207: background-color: $mail_replied;
6208: }
1.795 www 6209:
1.938 bisitz 6210: /*
6211: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 6212: background-color: $mail_replied_hover;
6213: }
1.938 bisitz 6214: */
1.795 www 6215:
1.938 bisitz 6216: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 6217: background-color: $mail_other;
6218: }
1.795 www 6219:
1.938 bisitz 6220: /*
6221: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 6222: background-color: $mail_other_hover;
6223: }
1.938 bisitz 6224: */
1.494 raeburn 6225:
1.777 tempelho 6226: table.LC_data_table tr > td.LC_browser_file,
6227: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 6228: background: #AAEE77;
1.389 albertel 6229: }
1.795 www 6230:
1.777 tempelho 6231: table.LC_data_table tr > td.LC_browser_file_locked,
6232: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 6233: background: #FFAA99;
1.387 albertel 6234: }
1.795 www 6235:
1.777 tempelho 6236: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 6237: background: #888888;
1.779 bisitz 6238: }
1.795 www 6239:
1.777 tempelho 6240: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 6241: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 6242: background: #F8F866;
1.777 tempelho 6243: }
1.795 www 6244:
1.696 bisitz 6245: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 6246: background: #E0E8FF;
1.387 albertel 6247: }
1.696 bisitz 6248:
1.707 bisitz 6249: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 6250: /* background: #77FF77; */
1.707 bisitz 6251: }
1.795 www 6252:
1.707 bisitz 6253: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 6254: border-right: 8px solid #FFFF77;
1.707 bisitz 6255: }
1.795 www 6256:
1.707 bisitz 6257: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 6258: border-right: 8px solid #FFAA77;
1.707 bisitz 6259: }
1.795 www 6260:
1.707 bisitz 6261: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 6262: border-right: 8px solid #FF7777;
1.707 bisitz 6263: }
1.795 www 6264:
1.707 bisitz 6265: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 6266: border-right: 8px solid #AAFF77;
1.707 bisitz 6267: }
1.795 www 6268:
1.707 bisitz 6269: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 6270: border-right: 8px solid #11CC55;
1.707 bisitz 6271: }
6272:
1.388 albertel 6273: span.LC_current_location {
1.701 harmsja 6274: font-size:larger;
1.388 albertel 6275: background: $pgbg;
6276: }
1.387 albertel 6277:
1.1029 www 6278: span.LC_current_nav_location {
6279: font-weight:bold;
6280: background: $sidebg;
6281: }
6282:
1.395 albertel 6283: span.LC_parm_menu_item {
6284: font-size: larger;
6285: }
1.795 www 6286:
1.395 albertel 6287: span.LC_parm_scope_all {
6288: color: red;
6289: }
1.795 www 6290:
1.395 albertel 6291: span.LC_parm_scope_folder {
6292: color: green;
6293: }
1.795 www 6294:
1.395 albertel 6295: span.LC_parm_scope_resource {
6296: color: orange;
6297: }
1.795 www 6298:
1.395 albertel 6299: span.LC_parm_part {
6300: color: blue;
6301: }
1.795 www 6302:
1.911 bisitz 6303: span.LC_parm_folder,
6304: span.LC_parm_symb {
1.395 albertel 6305: font-size: x-small;
6306: font-family: $mono;
6307: color: #AAAAAA;
6308: }
6309:
1.977 bisitz 6310: ul.LC_parm_parmlist li {
6311: display: inline-block;
6312: padding: 0.3em 0.8em;
6313: vertical-align: top;
6314: width: 150px;
6315: border-top:1px solid $lg_border_color;
6316: }
6317:
1.795 www 6318: td.LC_parm_overview_level_menu,
6319: td.LC_parm_overview_map_menu,
6320: td.LC_parm_overview_parm_selectors,
6321: td.LC_parm_overview_restrictions {
1.396 albertel 6322: border: 1px solid black;
6323: border-collapse: collapse;
6324: }
1.795 www 6325:
1.396 albertel 6326: table.LC_parm_overview_restrictions td {
6327: border-width: 1px 4px 1px 4px;
6328: border-style: solid;
6329: border-color: $pgbg;
6330: text-align: center;
6331: }
1.795 www 6332:
1.396 albertel 6333: table.LC_parm_overview_restrictions th {
6334: background: $tabbg;
6335: border-width: 1px 4px 1px 4px;
6336: border-style: solid;
6337: border-color: $pgbg;
6338: }
1.795 www 6339:
1.398 albertel 6340: table#LC_helpmenu {
1.803 bisitz 6341: border: none;
1.398 albertel 6342: height: 55px;
1.803 bisitz 6343: border-spacing: 0;
1.398 albertel 6344: }
6345:
6346: table#LC_helpmenu fieldset legend {
6347: font-size: larger;
6348: }
1.795 www 6349:
1.397 albertel 6350: table#LC_helpmenu_links {
6351: width: 100%;
6352: border: 1px solid black;
6353: background: $pgbg;
1.803 bisitz 6354: padding: 0;
1.397 albertel 6355: border-spacing: 1px;
6356: }
1.795 www 6357:
1.397 albertel 6358: table#LC_helpmenu_links tr td {
6359: padding: 1px;
6360: background: $tabbg;
1.399 albertel 6361: text-align: center;
6362: font-weight: bold;
1.397 albertel 6363: }
1.396 albertel 6364:
1.795 www 6365: table#LC_helpmenu_links a:link,
6366: table#LC_helpmenu_links a:visited,
1.397 albertel 6367: table#LC_helpmenu_links a:active {
6368: text-decoration: none;
6369: color: $font;
6370: }
1.795 www 6371:
1.397 albertel 6372: table#LC_helpmenu_links a:hover {
6373: text-decoration: underline;
6374: color: $vlink;
6375: }
1.396 albertel 6376:
1.417 albertel 6377: .LC_chrt_popup_exists {
6378: border: 1px solid #339933;
6379: margin: -1px;
6380: }
1.795 www 6381:
1.417 albertel 6382: .LC_chrt_popup_up {
6383: border: 1px solid yellow;
6384: margin: -1px;
6385: }
1.795 www 6386:
1.417 albertel 6387: .LC_chrt_popup {
6388: border: 1px solid #8888FF;
6389: background: #CCCCFF;
6390: }
1.795 www 6391:
1.421 albertel 6392: table.LC_pick_box {
6393: border-collapse: separate;
6394: background: white;
6395: border: 1px solid black;
6396: border-spacing: 1px;
6397: }
1.795 www 6398:
1.421 albertel 6399: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 6400: background: $sidebg;
1.421 albertel 6401: font-weight: bold;
1.900 bisitz 6402: text-align: left;
1.740 bisitz 6403: vertical-align: top;
1.421 albertel 6404: width: 184px;
6405: padding: 8px;
6406: }
1.795 www 6407:
1.579 raeburn 6408: table.LC_pick_box td.LC_pick_box_value {
6409: text-align: left;
6410: padding: 8px;
6411: }
1.795 www 6412:
1.579 raeburn 6413: table.LC_pick_box td.LC_pick_box_select {
6414: text-align: left;
6415: padding: 8px;
6416: }
1.795 www 6417:
1.424 albertel 6418: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 6419: padding: 0;
1.421 albertel 6420: height: 1px;
6421: background: black;
6422: }
1.795 www 6423:
1.421 albertel 6424: table.LC_pick_box td.LC_pick_box_submit {
6425: text-align: right;
6426: }
1.795 www 6427:
1.579 raeburn 6428: table.LC_pick_box td.LC_evenrow_value {
6429: text-align: left;
6430: padding: 8px;
6431: background-color: $data_table_light;
6432: }
1.795 www 6433:
1.579 raeburn 6434: table.LC_pick_box td.LC_oddrow_value {
6435: text-align: left;
6436: padding: 8px;
6437: background-color: $data_table_light;
6438: }
1.795 www 6439:
1.579 raeburn 6440: span.LC_helpform_receipt_cat {
6441: font-weight: bold;
6442: }
1.795 www 6443:
1.424 albertel 6444: table.LC_group_priv_box {
6445: background: white;
6446: border: 1px solid black;
6447: border-spacing: 1px;
6448: }
1.795 www 6449:
1.424 albertel 6450: table.LC_group_priv_box td.LC_pick_box_title {
6451: background: $tabbg;
6452: font-weight: bold;
6453: text-align: right;
6454: width: 184px;
6455: }
1.795 www 6456:
1.424 albertel 6457: table.LC_group_priv_box td.LC_groups_fixed {
6458: background: $data_table_light;
6459: text-align: center;
6460: }
1.795 www 6461:
1.424 albertel 6462: table.LC_group_priv_box td.LC_groups_optional {
6463: background: $data_table_dark;
6464: text-align: center;
6465: }
1.795 www 6466:
1.424 albertel 6467: table.LC_group_priv_box td.LC_groups_functionality {
6468: background: $data_table_darker;
6469: text-align: center;
6470: font-weight: bold;
6471: }
1.795 www 6472:
1.424 albertel 6473: table.LC_group_priv td {
6474: text-align: left;
1.803 bisitz 6475: padding: 0;
1.424 albertel 6476: }
6477:
6478: .LC_navbuttons {
6479: margin: 2ex 0ex 2ex 0ex;
6480: }
1.795 www 6481:
1.423 albertel 6482: .LC_topic_bar {
6483: font-weight: bold;
6484: background: $tabbg;
1.918 wenzelju 6485: margin: 1em 0em 1em 2em;
1.805 bisitz 6486: padding: 3px;
1.918 wenzelju 6487: font-size: 1.2em;
1.423 albertel 6488: }
1.795 www 6489:
1.423 albertel 6490: .LC_topic_bar span {
1.918 wenzelju 6491: left: 0.5em;
6492: position: absolute;
1.423 albertel 6493: vertical-align: middle;
1.918 wenzelju 6494: font-size: 1.2em;
1.423 albertel 6495: }
1.795 www 6496:
1.423 albertel 6497: table.LC_course_group_status {
6498: margin: 20px;
6499: }
1.795 www 6500:
1.423 albertel 6501: table.LC_status_selector td {
6502: vertical-align: top;
6503: text-align: center;
1.424 albertel 6504: padding: 4px;
6505: }
1.795 www 6506:
1.599 albertel 6507: div.LC_feedback_link {
1.616 albertel 6508: clear: both;
1.829 kalberla 6509: background: $sidebg;
1.779 bisitz 6510: width: 100%;
1.829 kalberla 6511: padding-bottom: 10px;
6512: border: 1px $tabbg solid;
1.833 kalberla 6513: height: 22px;
6514: line-height: 22px;
6515: padding-top: 5px;
6516: }
6517:
6518: div.LC_feedback_link img {
6519: height: 22px;
1.867 kalberla 6520: vertical-align:middle;
1.829 kalberla 6521: }
6522:
1.911 bisitz 6523: div.LC_feedback_link a {
1.829 kalberla 6524: text-decoration: none;
1.489 raeburn 6525: }
1.795 www 6526:
1.867 kalberla 6527: div.LC_comblock {
1.911 bisitz 6528: display:inline;
1.867 kalberla 6529: color:$font;
6530: font-size:90%;
6531: }
6532:
6533: div.LC_feedback_link div.LC_comblock {
6534: padding-left:5px;
6535: }
6536:
6537: div.LC_feedback_link div.LC_comblock a {
6538: color:$font;
6539: }
6540:
1.489 raeburn 6541: span.LC_feedback_link {
1.858 bisitz 6542: /* background: $feedback_link_bg; */
1.599 albertel 6543: font-size: larger;
6544: }
1.795 www 6545:
1.599 albertel 6546: span.LC_message_link {
1.858 bisitz 6547: /* background: $feedback_link_bg; */
1.599 albertel 6548: font-size: larger;
6549: position: absolute;
6550: right: 1em;
1.489 raeburn 6551: }
1.421 albertel 6552:
1.515 albertel 6553: table.LC_prior_tries {
1.524 albertel 6554: border: 1px solid #000000;
6555: border-collapse: separate;
6556: border-spacing: 1px;
1.515 albertel 6557: }
1.523 albertel 6558:
1.515 albertel 6559: table.LC_prior_tries td {
1.524 albertel 6560: padding: 2px;
1.515 albertel 6561: }
1.523 albertel 6562:
6563: .LC_answer_correct {
1.795 www 6564: background: lightgreen;
6565: color: darkgreen;
6566: padding: 6px;
1.523 albertel 6567: }
1.795 www 6568:
1.523 albertel 6569: .LC_answer_charged_try {
1.797 www 6570: background: #FFAAAA;
1.795 www 6571: color: darkred;
6572: padding: 6px;
1.523 albertel 6573: }
1.795 www 6574:
1.779 bisitz 6575: .LC_answer_not_charged_try,
1.523 albertel 6576: .LC_answer_no_grade,
6577: .LC_answer_late {
1.795 www 6578: background: lightyellow;
1.523 albertel 6579: color: black;
1.795 www 6580: padding: 6px;
1.523 albertel 6581: }
1.795 www 6582:
1.523 albertel 6583: .LC_answer_previous {
1.795 www 6584: background: lightblue;
6585: color: darkblue;
6586: padding: 6px;
1.523 albertel 6587: }
1.795 www 6588:
1.779 bisitz 6589: .LC_answer_no_message {
1.777 tempelho 6590: background: #FFFFFF;
6591: color: black;
1.795 www 6592: padding: 6px;
1.779 bisitz 6593: }
1.795 www 6594:
1.779 bisitz 6595: .LC_answer_unknown {
6596: background: orange;
6597: color: black;
1.795 www 6598: padding: 6px;
1.777 tempelho 6599: }
1.795 www 6600:
1.529 albertel 6601: span.LC_prior_numerical,
6602: span.LC_prior_string,
6603: span.LC_prior_custom,
6604: span.LC_prior_reaction,
6605: span.LC_prior_math {
1.925 bisitz 6606: font-family: $mono;
1.523 albertel 6607: white-space: pre;
6608: }
6609:
1.525 albertel 6610: span.LC_prior_string {
1.925 bisitz 6611: font-family: $mono;
1.525 albertel 6612: white-space: pre;
6613: }
6614:
1.523 albertel 6615: table.LC_prior_option {
6616: width: 100%;
6617: border-collapse: collapse;
6618: }
1.795 www 6619:
1.911 bisitz 6620: table.LC_prior_rank,
1.795 www 6621: table.LC_prior_match {
1.528 albertel 6622: border-collapse: collapse;
6623: }
1.795 www 6624:
1.528 albertel 6625: table.LC_prior_option tr td,
6626: table.LC_prior_rank tr td,
6627: table.LC_prior_match tr td {
1.524 albertel 6628: border: 1px solid #000000;
1.515 albertel 6629: }
6630:
1.855 bisitz 6631: .LC_nobreak {
1.544 albertel 6632: white-space: nowrap;
1.519 raeburn 6633: }
6634:
1.576 raeburn 6635: span.LC_cusr_emph {
6636: font-style: italic;
6637: }
6638:
1.633 raeburn 6639: span.LC_cusr_subheading {
6640: font-weight: normal;
6641: font-size: 85%;
6642: }
6643:
1.1206 raeburn 6644: span.LC_math-error {
6645: border: solid 1px red; min-width: 1px;
6646: }
6647:
1.861 bisitz 6648: div.LC_docs_entry_move {
1.859 bisitz 6649: border: 1px solid #BBBBBB;
1.545 albertel 6650: background: #DDDDDD;
1.861 bisitz 6651: width: 22px;
1.859 bisitz 6652: padding: 1px;
6653: margin: 0;
1.545 albertel 6654: }
6655:
1.861 bisitz 6656: table.LC_data_table tr > td.LC_docs_entry_commands,
6657: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 6658: font-size: x-small;
6659: }
1.795 www 6660:
1.861 bisitz 6661: .LC_docs_entry_parameter {
6662: white-space: nowrap;
6663: }
6664:
1.544 albertel 6665: .LC_docs_copy {
1.545 albertel 6666: color: #000099;
1.544 albertel 6667: }
1.795 www 6668:
1.544 albertel 6669: .LC_docs_cut {
1.545 albertel 6670: color: #550044;
1.544 albertel 6671: }
1.795 www 6672:
1.544 albertel 6673: .LC_docs_rename {
1.545 albertel 6674: color: #009900;
1.544 albertel 6675: }
1.795 www 6676:
1.544 albertel 6677: .LC_docs_remove {
1.545 albertel 6678: color: #990000;
6679: }
6680:
1.547 albertel 6681: .LC_docs_reinit_warn,
6682: .LC_docs_ext_edit {
6683: font-size: x-small;
6684: }
6685:
1.545 albertel 6686: table.LC_docs_adddocs td,
6687: table.LC_docs_adddocs th {
6688: border: 1px solid #BBBBBB;
6689: padding: 4px;
6690: background: #DDDDDD;
1.543 albertel 6691: }
6692:
1.584 albertel 6693: table.LC_sty_begin {
6694: background: #BBFFBB;
6695: }
1.795 www 6696:
1.584 albertel 6697: table.LC_sty_end {
6698: background: #FFBBBB;
6699: }
6700:
1.589 raeburn 6701: table.LC_double_column {
1.803 bisitz 6702: border-width: 0;
1.589 raeburn 6703: border-collapse: collapse;
6704: width: 100%;
6705: padding: 2px;
6706: }
6707:
6708: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 6709: top: 2px;
1.589 raeburn 6710: left: 2px;
6711: width: 47%;
6712: vertical-align: top;
6713: }
6714:
6715: table.LC_double_column tr td.LC_right_col {
6716: top: 2px;
1.779 bisitz 6717: right: 2px;
1.589 raeburn 6718: width: 47%;
6719: vertical-align: top;
6720: }
6721:
1.591 raeburn 6722: div.LC_left_float {
6723: float: left;
6724: padding-right: 5%;
1.597 albertel 6725: padding-bottom: 4px;
1.591 raeburn 6726: }
6727:
6728: div.LC_clear_float_header {
1.597 albertel 6729: padding-bottom: 2px;
1.591 raeburn 6730: }
6731:
6732: div.LC_clear_float_footer {
1.597 albertel 6733: padding-top: 10px;
1.591 raeburn 6734: clear: both;
6735: }
6736:
1.597 albertel 6737: div.LC_grade_show_user {
1.941 bisitz 6738: /* border-left: 5px solid $sidebg; */
6739: border-top: 5px solid #000000;
6740: margin: 50px 0 0 0;
1.936 bisitz 6741: padding: 15px 0 5px 10px;
1.597 albertel 6742: }
1.795 www 6743:
1.936 bisitz 6744: div.LC_grade_show_user_odd_row {
1.941 bisitz 6745: /* border-left: 5px solid #000000; */
6746: }
6747:
6748: div.LC_grade_show_user div.LC_Box {
6749: margin-right: 50px;
1.597 albertel 6750: }
6751:
6752: div.LC_grade_submissions,
6753: div.LC_grade_message_center,
1.936 bisitz 6754: div.LC_grade_info_links {
1.597 albertel 6755: margin: 5px;
6756: width: 99%;
6757: background: #FFFFFF;
6758: }
1.795 www 6759:
1.597 albertel 6760: div.LC_grade_submissions_header,
1.936 bisitz 6761: div.LC_grade_message_center_header {
1.705 tempelho 6762: font-weight: bold;
6763: font-size: large;
1.597 albertel 6764: }
1.795 www 6765:
1.597 albertel 6766: div.LC_grade_submissions_body,
1.936 bisitz 6767: div.LC_grade_message_center_body {
1.597 albertel 6768: border: 1px solid black;
6769: width: 99%;
6770: background: #FFFFFF;
6771: }
1.795 www 6772:
1.613 albertel 6773: table.LC_scantron_action {
6774: width: 100%;
6775: }
1.795 www 6776:
1.613 albertel 6777: table.LC_scantron_action tr th {
1.698 harmsja 6778: font-weight:bold;
6779: font-style:normal;
1.613 albertel 6780: }
1.795 www 6781:
1.779 bisitz 6782: .LC_edit_problem_header,
1.614 albertel 6783: div.LC_edit_problem_footer {
1.705 tempelho 6784: font-weight: normal;
6785: font-size: medium;
1.602 albertel 6786: margin: 2px;
1.1060 bisitz 6787: background-color: $sidebg;
1.600 albertel 6788: }
1.795 www 6789:
1.600 albertel 6790: div.LC_edit_problem_header,
1.602 albertel 6791: div.LC_edit_problem_header div,
1.614 albertel 6792: div.LC_edit_problem_footer,
6793: div.LC_edit_problem_footer div,
1.602 albertel 6794: div.LC_edit_problem_editxml_header,
6795: div.LC_edit_problem_editxml_header div {
1.600 albertel 6796: margin-top: 5px;
1.1205 golterma 6797: z-index: 100;
1.600 albertel 6798: }
1.795 www 6799:
1.600 albertel 6800: div.LC_edit_problem_header_title {
1.705 tempelho 6801: font-weight: bold;
6802: font-size: larger;
1.602 albertel 6803: background: $tabbg;
6804: padding: 3px;
1.1060 bisitz 6805: margin: 0 0 5px 0;
1.602 albertel 6806: }
1.795 www 6807:
1.602 albertel 6808: table.LC_edit_problem_header_title {
6809: width: 100%;
1.600 albertel 6810: background: $tabbg;
1.602 albertel 6811: }
6812:
6813: div.LC_edit_problem_discards {
6814: float: left;
1.1205 golterma 6815: }
6816:
6817: div.LC_edit_actionbar {
6818: margin: -5px 0px 0px 0px !important;
6819: background-color: $sidebg;
6820: height: 31px;
1.602 albertel 6821: }
1.795 www 6822:
1.602 albertel 6823: div.LC_edit_problem_saves {
6824: float: right;
6825: padding-bottom: 5px;
1.600 albertel 6826: }
1.795 www 6827:
1.1124 bisitz 6828: .LC_edit_opt {
6829: padding-left: 1em;
6830: white-space: nowrap;
6831: }
6832:
1.1152 golterma 6833: .LC_edit_problem_latexhelper{
6834: text-align: right;
6835: }
6836:
6837: #LC_edit_problem_colorful div{
6838: margin-left: 40px;
6839: }
6840:
1.1205 golterma 6841: #LC_edit_problem_codemirror div{
6842: margin-left: 0px;
6843: }
6844:
1.911 bisitz 6845: img.stift {
1.803 bisitz 6846: border-width: 0;
6847: vertical-align: middle;
1.677 riegler 6848: }
1.680 riegler 6849:
1.923 bisitz 6850: table td.LC_mainmenu_col_fieldset {
1.680 riegler 6851: vertical-align: top;
1.777 tempelho 6852: }
1.795 www 6853:
1.716 raeburn 6854: div.LC_createcourse {
1.911 bisitz 6855: margin: 10px 10px 10px 10px;
1.716 raeburn 6856: }
6857:
1.917 raeburn 6858: .LC_dccid {
1.1130 raeburn 6859: float: right;
1.917 raeburn 6860: margin: 0.2em 0 0 0;
6861: padding: 0;
6862: font-size: 90%;
6863: display:none;
6864: }
6865:
1.897 wenzelju 6866: ol.LC_primary_menu a:hover,
1.721 harmsja 6867: ol#LC_MenuBreadcrumbs a:hover,
6868: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 6869: ul#LC_secondary_menu a:hover,
1.721 harmsja 6870: .LC_FormSectionClearButton input:hover
1.795 www 6871: ul.LC_TabContent li:hover a {
1.952 onken 6872: color:$button_hover;
1.911 bisitz 6873: text-decoration:none;
1.693 droeschl 6874: }
6875:
1.779 bisitz 6876: h1 {
1.911 bisitz 6877: padding: 0;
6878: line-height:130%;
1.693 droeschl 6879: }
1.698 harmsja 6880:
1.911 bisitz 6881: h2,
6882: h3,
6883: h4,
6884: h5,
6885: h6 {
6886: margin: 5px 0 5px 0;
6887: padding: 0;
6888: line-height:130%;
1.693 droeschl 6889: }
1.795 www 6890:
6891: .LC_hcell {
1.911 bisitz 6892: padding:3px 15px 3px 15px;
6893: margin: 0;
6894: background-color:$tabbg;
6895: color:$fontmenu;
6896: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 6897: }
1.795 www 6898:
1.840 bisitz 6899: .LC_Box > .LC_hcell {
1.911 bisitz 6900: margin: 0 -10px 10px -10px;
1.835 bisitz 6901: }
6902:
1.721 harmsja 6903: .LC_noBorder {
1.911 bisitz 6904: border: 0;
1.698 harmsja 6905: }
1.693 droeschl 6906:
1.721 harmsja 6907: .LC_FormSectionClearButton input {
1.911 bisitz 6908: background-color:transparent;
6909: border: none;
6910: cursor:pointer;
6911: text-decoration:underline;
1.693 droeschl 6912: }
1.763 bisitz 6913:
6914: .LC_help_open_topic {
1.911 bisitz 6915: color: #FFFFFF;
6916: background-color: #EEEEFF;
6917: margin: 1px;
6918: padding: 4px;
6919: border: 1px solid #000033;
6920: white-space: nowrap;
6921: /* vertical-align: middle; */
1.759 neumanie 6922: }
1.693 droeschl 6923:
1.911 bisitz 6924: dl,
6925: ul,
6926: div,
6927: fieldset {
6928: margin: 10px 10px 10px 0;
6929: /* overflow: hidden; */
1.693 droeschl 6930: }
1.795 www 6931:
1.838 bisitz 6932: fieldset > legend {
1.911 bisitz 6933: font-weight: bold;
6934: padding: 0 5px 0 5px;
1.838 bisitz 6935: }
6936:
1.813 bisitz 6937: #LC_nav_bar {
1.911 bisitz 6938: float: left;
1.995 raeburn 6939: background-color: $pgbg_or_bgcolor;
1.966 bisitz 6940: margin: 0 0 2px 0;
1.807 droeschl 6941: }
6942:
1.916 droeschl 6943: #LC_realm {
6944: margin: 0.2em 0 0 0;
6945: padding: 0;
6946: font-weight: bold;
6947: text-align: center;
1.995 raeburn 6948: background-color: $pgbg_or_bgcolor;
1.916 droeschl 6949: }
6950:
1.911 bisitz 6951: #LC_nav_bar em {
6952: font-weight: bold;
6953: font-style: normal;
1.807 droeschl 6954: }
6955:
1.897 wenzelju 6956: ol.LC_primary_menu {
1.934 droeschl 6957: margin: 0;
1.1076 raeburn 6958: padding: 0;
1.807 droeschl 6959: }
6960:
1.852 droeschl 6961: ol#LC_PathBreadcrumbs {
1.911 bisitz 6962: margin: 0;
1.693 droeschl 6963: }
6964:
1.897 wenzelju 6965: ol.LC_primary_menu li {
1.1076 raeburn 6966: color: RGB(80, 80, 80);
6967: vertical-align: middle;
6968: text-align: left;
6969: list-style: none;
1.1205 golterma 6970: position: relative;
1.1076 raeburn 6971: float: left;
1.1205 golterma 6972: z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
6973: line-height: 1.5em;
1.1076 raeburn 6974: }
6975:
1.1205 golterma 6976: ol.LC_primary_menu li a,
6977: ol.LC_primary_menu li p {
1.1076 raeburn 6978: display: block;
6979: margin: 0;
6980: padding: 0 5px 0 10px;
6981: text-decoration: none;
6982: }
6983:
1.1205 golterma 6984: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
6985: display: inline-block;
6986: width: 95%;
6987: text-align: left;
6988: }
6989:
6990: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
6991: display: inline-block;
6992: width: 5%;
6993: float: right;
6994: text-align: right;
6995: font-size: 70%;
6996: }
6997:
6998: ol.LC_primary_menu ul {
1.1076 raeburn 6999: display: none;
1.1205 golterma 7000: width: 15em;
1.1076 raeburn 7001: background-color: $data_table_light;
1.1205 golterma 7002: position: absolute;
7003: top: 100%;
1.1076 raeburn 7004: }
7005:
1.1205 golterma 7006: ol.LC_primary_menu ul ul {
7007: left: 100%;
7008: top: 0;
7009: }
7010:
7011: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1076 raeburn 7012: display: block;
7013: position: absolute;
7014: margin: 0;
7015: padding: 0;
1.1078 raeburn 7016: z-index: 2;
1.1076 raeburn 7017: }
7018:
7019: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1205 golterma 7020: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1076 raeburn 7021: font-size: 90%;
1.911 bisitz 7022: vertical-align: top;
1.1076 raeburn 7023: float: none;
1.1079 raeburn 7024: border-left: 1px solid black;
7025: border-right: 1px solid black;
1.1205 golterma 7026: /* A dark bottom border to visualize different menu options;
7027: overwritten in the create_submenu routine for the last border-bottom of the menu */
7028: border-bottom: 1px solid $data_table_dark;
1.1076 raeburn 7029: }
7030:
1.1205 golterma 7031: ol.LC_primary_menu li li p:hover {
7032: color:$button_hover;
7033: text-decoration:none;
7034: background-color:$data_table_dark;
1.1076 raeburn 7035: }
7036:
7037: ol.LC_primary_menu li li a:hover {
7038: color:$button_hover;
7039: background-color:$data_table_dark;
1.693 droeschl 7040: }
7041:
1.1205 golterma 7042: /* Font-size equal to the size of the predecessors*/
7043: ol.LC_primary_menu li:hover li li {
7044: font-size: 100%;
7045: }
7046:
1.897 wenzelju 7047: ol.LC_primary_menu li img {
1.911 bisitz 7048: vertical-align: bottom;
1.934 droeschl 7049: height: 1.1em;
1.1077 raeburn 7050: margin: 0.2em 0 0 0;
1.693 droeschl 7051: }
7052:
1.897 wenzelju 7053: ol.LC_primary_menu a {
1.911 bisitz 7054: color: RGB(80, 80, 80);
7055: text-decoration: none;
1.693 droeschl 7056: }
1.795 www 7057:
1.949 droeschl 7058: ol.LC_primary_menu a.LC_new_message {
7059: font-weight:bold;
7060: color: darkred;
7061: }
7062:
1.975 raeburn 7063: ol.LC_docs_parameters {
7064: margin-left: 0;
7065: padding: 0;
7066: list-style: none;
7067: }
7068:
7069: ol.LC_docs_parameters li {
7070: margin: 0;
7071: padding-right: 20px;
7072: display: inline;
7073: }
7074:
1.976 raeburn 7075: ol.LC_docs_parameters li:before {
7076: content: "\\002022 \\0020";
7077: }
7078:
7079: li.LC_docs_parameters_title {
7080: font-weight: bold;
7081: }
7082:
7083: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
7084: content: "";
7085: }
7086:
1.897 wenzelju 7087: ul#LC_secondary_menu {
1.1107 raeburn 7088: clear: right;
1.911 bisitz 7089: color: $fontmenu;
7090: background: $tabbg;
7091: list-style: none;
7092: padding: 0;
7093: margin: 0;
7094: width: 100%;
1.995 raeburn 7095: text-align: left;
1.1107 raeburn 7096: float: left;
1.808 droeschl 7097: }
7098:
1.897 wenzelju 7099: ul#LC_secondary_menu li {
1.911 bisitz 7100: font-weight: bold;
7101: line-height: 1.8em;
1.1107 raeburn 7102: border-right: 1px solid black;
7103: float: left;
7104: }
7105:
7106: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
7107: background-color: $data_table_light;
7108: }
7109:
7110: ul#LC_secondary_menu li a {
1.911 bisitz 7111: padding: 0 0.8em;
1.1107 raeburn 7112: }
7113:
7114: ul#LC_secondary_menu li ul {
7115: display: none;
7116: }
7117:
7118: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
7119: display: block;
7120: position: absolute;
7121: margin: 0;
7122: padding: 0;
7123: list-style:none;
7124: float: none;
7125: background-color: $data_table_light;
7126: z-index: 2;
7127: margin-left: -1px;
7128: }
7129:
7130: ul#LC_secondary_menu li ul li {
7131: font-size: 90%;
7132: vertical-align: top;
7133: border-left: 1px solid black;
1.911 bisitz 7134: border-right: 1px solid black;
1.1119 raeburn 7135: background-color: $data_table_light;
1.1107 raeburn 7136: list-style:none;
7137: float: none;
7138: }
7139:
7140: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
7141: background-color: $data_table_dark;
1.807 droeschl 7142: }
7143:
1.847 tempelho 7144: ul.LC_TabContent {
1.911 bisitz 7145: display:block;
7146: background: $sidebg;
7147: border-bottom: solid 1px $lg_border_color;
7148: list-style:none;
1.1020 raeburn 7149: margin: -1px -10px 0 -10px;
1.911 bisitz 7150: padding: 0;
1.693 droeschl 7151: }
7152:
1.795 www 7153: ul.LC_TabContent li,
7154: ul.LC_TabContentBigger li {
1.911 bisitz 7155: float:left;
1.741 harmsja 7156: }
1.795 www 7157:
1.897 wenzelju 7158: ul#LC_secondary_menu li a {
1.911 bisitz 7159: color: $fontmenu;
7160: text-decoration: none;
1.693 droeschl 7161: }
1.795 www 7162:
1.721 harmsja 7163: ul.LC_TabContent {
1.952 onken 7164: min-height:20px;
1.721 harmsja 7165: }
1.795 www 7166:
7167: ul.LC_TabContent li {
1.911 bisitz 7168: vertical-align:middle;
1.959 onken 7169: padding: 0 16px 0 10px;
1.911 bisitz 7170: background-color:$tabbg;
7171: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 7172: border-left: solid 1px $font;
1.721 harmsja 7173: }
1.795 www 7174:
1.847 tempelho 7175: ul.LC_TabContent .right {
1.911 bisitz 7176: float:right;
1.847 tempelho 7177: }
7178:
1.911 bisitz 7179: ul.LC_TabContent li a,
7180: ul.LC_TabContent li {
7181: color:rgb(47,47,47);
7182: text-decoration:none;
7183: font-size:95%;
7184: font-weight:bold;
1.952 onken 7185: min-height:20px;
7186: }
7187:
1.959 onken 7188: ul.LC_TabContent li a:hover,
7189: ul.LC_TabContent li a:focus {
1.952 onken 7190: color: $button_hover;
1.959 onken 7191: background:none;
7192: outline:none;
1.952 onken 7193: }
7194:
7195: ul.LC_TabContent li:hover {
7196: color: $button_hover;
7197: cursor:pointer;
1.721 harmsja 7198: }
1.795 www 7199:
1.911 bisitz 7200: ul.LC_TabContent li.active {
1.952 onken 7201: color: $font;
1.911 bisitz 7202: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 7203: border-bottom:solid 1px #FFFFFF;
7204: cursor: default;
1.744 ehlerst 7205: }
1.795 www 7206:
1.959 onken 7207: ul.LC_TabContent li.active a {
7208: color:$font;
7209: background:#FFFFFF;
7210: outline: none;
7211: }
1.1047 raeburn 7212:
7213: ul.LC_TabContent li.goback {
7214: float: left;
7215: border-left: none;
7216: }
7217:
1.870 tempelho 7218: #maincoursedoc {
1.911 bisitz 7219: clear:both;
1.870 tempelho 7220: }
7221:
7222: ul.LC_TabContentBigger {
1.911 bisitz 7223: display:block;
7224: list-style:none;
7225: padding: 0;
1.870 tempelho 7226: }
7227:
1.795 www 7228: ul.LC_TabContentBigger li {
1.911 bisitz 7229: vertical-align:bottom;
7230: height: 30px;
7231: font-size:110%;
7232: font-weight:bold;
7233: color: #737373;
1.841 tempelho 7234: }
7235:
1.957 onken 7236: ul.LC_TabContentBigger li.active {
7237: position: relative;
7238: top: 1px;
7239: }
7240:
1.870 tempelho 7241: ul.LC_TabContentBigger li a {
1.911 bisitz 7242: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
7243: height: 30px;
7244: line-height: 30px;
7245: text-align: center;
7246: display: block;
7247: text-decoration: none;
1.958 onken 7248: outline: none;
1.741 harmsja 7249: }
1.795 www 7250:
1.870 tempelho 7251: ul.LC_TabContentBigger li.active a {
1.911 bisitz 7252: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
7253: color:$font;
1.744 ehlerst 7254: }
1.795 www 7255:
1.870 tempelho 7256: ul.LC_TabContentBigger li b {
1.911 bisitz 7257: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
7258: display: block;
7259: float: left;
7260: padding: 0 30px;
1.957 onken 7261: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 7262: }
7263:
1.956 onken 7264: ul.LC_TabContentBigger li:hover b {
7265: color:$button_hover;
7266: }
7267:
1.870 tempelho 7268: ul.LC_TabContentBigger li.active b {
1.911 bisitz 7269: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
7270: color:$font;
1.957 onken 7271: border: 0;
1.741 harmsja 7272: }
1.693 droeschl 7273:
1.870 tempelho 7274:
1.862 bisitz 7275: ul.LC_CourseBreadcrumbs {
7276: background: $sidebg;
1.1020 raeburn 7277: height: 2em;
1.862 bisitz 7278: padding-left: 10px;
1.1020 raeburn 7279: margin: 0;
1.862 bisitz 7280: list-style-position: inside;
7281: }
7282:
1.911 bisitz 7283: ol#LC_MenuBreadcrumbs,
1.862 bisitz 7284: ol#LC_PathBreadcrumbs {
1.911 bisitz 7285: padding-left: 10px;
7286: margin: 0;
1.933 droeschl 7287: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 7288: }
7289:
1.911 bisitz 7290: ol#LC_MenuBreadcrumbs li,
7291: ol#LC_PathBreadcrumbs li,
1.862 bisitz 7292: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 7293: display: inline;
1.933 droeschl 7294: white-space: normal;
1.693 droeschl 7295: }
7296:
1.823 bisitz 7297: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 7298: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 7299: text-decoration: none;
7300: font-size:90%;
1.693 droeschl 7301: }
1.795 www 7302:
1.969 droeschl 7303: ol#LC_MenuBreadcrumbs h1 {
7304: display: inline;
7305: font-size: 90%;
7306: line-height: 2.5em;
7307: margin: 0;
7308: padding: 0;
7309: }
7310:
1.795 www 7311: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 7312: text-decoration:none;
7313: font-size:100%;
7314: font-weight:bold;
1.693 droeschl 7315: }
1.795 www 7316:
1.840 bisitz 7317: .LC_Box {
1.911 bisitz 7318: border: solid 1px $lg_border_color;
7319: padding: 0 10px 10px 10px;
1.746 neumanie 7320: }
1.795 www 7321:
1.1020 raeburn 7322: .LC_DocsBox {
7323: border: solid 1px $lg_border_color;
7324: padding: 0 0 10px 10px;
7325: }
7326:
1.795 www 7327: .LC_AboutMe_Image {
1.911 bisitz 7328: float:left;
7329: margin-right:10px;
1.747 neumanie 7330: }
1.795 www 7331:
7332: .LC_Clear_AboutMe_Image {
1.911 bisitz 7333: clear:left;
1.747 neumanie 7334: }
1.795 www 7335:
1.721 harmsja 7336: dl.LC_ListStyleClean dt {
1.911 bisitz 7337: padding-right: 5px;
7338: display: table-header-group;
1.693 droeschl 7339: }
7340:
1.721 harmsja 7341: dl.LC_ListStyleClean dd {
1.911 bisitz 7342: display: table-row;
1.693 droeschl 7343: }
7344:
1.721 harmsja 7345: .LC_ListStyleClean,
7346: .LC_ListStyleSimple,
7347: .LC_ListStyleNormal,
1.795 www 7348: .LC_ListStyleSpecial {
1.911 bisitz 7349: /* display:block; */
7350: list-style-position: inside;
7351: list-style-type: none;
7352: overflow: hidden;
7353: padding: 0;
1.693 droeschl 7354: }
7355:
1.721 harmsja 7356: .LC_ListStyleSimple li,
7357: .LC_ListStyleSimple dd,
7358: .LC_ListStyleNormal li,
7359: .LC_ListStyleNormal dd,
7360: .LC_ListStyleSpecial li,
1.795 www 7361: .LC_ListStyleSpecial dd {
1.911 bisitz 7362: margin: 0;
7363: padding: 5px 5px 5px 10px;
7364: clear: both;
1.693 droeschl 7365: }
7366:
1.721 harmsja 7367: .LC_ListStyleClean li,
7368: .LC_ListStyleClean dd {
1.911 bisitz 7369: padding-top: 0;
7370: padding-bottom: 0;
1.693 droeschl 7371: }
7372:
1.721 harmsja 7373: .LC_ListStyleSimple dd,
1.795 www 7374: .LC_ListStyleSimple li {
1.911 bisitz 7375: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 7376: }
7377:
1.721 harmsja 7378: .LC_ListStyleSpecial li,
7379: .LC_ListStyleSpecial dd {
1.911 bisitz 7380: list-style-type: none;
7381: background-color: RGB(220, 220, 220);
7382: margin-bottom: 4px;
1.693 droeschl 7383: }
7384:
1.721 harmsja 7385: table.LC_SimpleTable {
1.911 bisitz 7386: margin:5px;
7387: border:solid 1px $lg_border_color;
1.795 www 7388: }
1.693 droeschl 7389:
1.721 harmsja 7390: table.LC_SimpleTable tr {
1.911 bisitz 7391: padding: 0;
7392: border:solid 1px $lg_border_color;
1.693 droeschl 7393: }
1.795 www 7394:
7395: table.LC_SimpleTable thead {
1.911 bisitz 7396: background:rgb(220,220,220);
1.693 droeschl 7397: }
7398:
1.721 harmsja 7399: div.LC_columnSection {
1.911 bisitz 7400: display: block;
7401: clear: both;
7402: overflow: hidden;
7403: margin: 0;
1.693 droeschl 7404: }
7405:
1.721 harmsja 7406: div.LC_columnSection>* {
1.911 bisitz 7407: float: left;
7408: margin: 10px 20px 10px 0;
7409: overflow:hidden;
1.693 droeschl 7410: }
1.721 harmsja 7411:
1.795 www 7412: table em {
1.911 bisitz 7413: font-weight: bold;
7414: font-style: normal;
1.748 schulted 7415: }
1.795 www 7416:
1.779 bisitz 7417: table.LC_tableBrowseRes,
1.795 www 7418: table.LC_tableOfContent {
1.911 bisitz 7419: border:none;
7420: border-spacing: 1px;
7421: padding: 3px;
7422: background-color: #FFFFFF;
7423: font-size: 90%;
1.753 droeschl 7424: }
1.789 droeschl 7425:
1.911 bisitz 7426: table.LC_tableOfContent {
7427: border-collapse: collapse;
1.789 droeschl 7428: }
7429:
1.771 droeschl 7430: table.LC_tableBrowseRes a,
1.768 schulted 7431: table.LC_tableOfContent a {
1.911 bisitz 7432: background-color: transparent;
7433: text-decoration: none;
1.753 droeschl 7434: }
7435:
1.795 www 7436: table.LC_tableOfContent img {
1.911 bisitz 7437: border: none;
7438: height: 1.3em;
7439: vertical-align: text-bottom;
7440: margin-right: 0.3em;
1.753 droeschl 7441: }
1.757 schulted 7442:
1.795 www 7443: a#LC_content_toolbar_firsthomework {
1.911 bisitz 7444: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 7445: }
7446:
1.795 www 7447: a#LC_content_toolbar_everything {
1.911 bisitz 7448: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 7449: }
7450:
1.795 www 7451: a#LC_content_toolbar_uncompleted {
1.911 bisitz 7452: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 7453: }
7454:
1.795 www 7455: #LC_content_toolbar_clearbubbles {
1.911 bisitz 7456: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 7457: }
7458:
1.795 www 7459: a#LC_content_toolbar_changefolder {
1.911 bisitz 7460: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 7461: }
7462:
1.795 www 7463: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 7464: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 7465: }
7466:
1.1043 raeburn 7467: a#LC_content_toolbar_edittoplevel {
7468: background-image:url(/res/adm/pages/edittoplevel.gif);
7469: }
7470:
1.795 www 7471: ul#LC_toolbar li a:hover {
1.911 bisitz 7472: background-position: bottom center;
1.757 schulted 7473: }
7474:
1.795 www 7475: ul#LC_toolbar {
1.911 bisitz 7476: padding: 0;
7477: margin: 2px;
7478: list-style:none;
7479: position:relative;
7480: background-color:white;
1.1082 raeburn 7481: overflow: auto;
1.757 schulted 7482: }
7483:
1.795 www 7484: ul#LC_toolbar li {
1.911 bisitz 7485: border:1px solid white;
7486: padding: 0;
7487: margin: 0;
7488: float: left;
7489: display:inline;
7490: vertical-align:middle;
1.1082 raeburn 7491: white-space: nowrap;
1.911 bisitz 7492: }
1.757 schulted 7493:
1.783 amueller 7494:
1.795 www 7495: a.LC_toolbarItem {
1.911 bisitz 7496: display:block;
7497: padding: 0;
7498: margin: 0;
7499: height: 32px;
7500: width: 32px;
7501: color:white;
7502: border: none;
7503: background-repeat:no-repeat;
7504: background-color:transparent;
1.757 schulted 7505: }
7506:
1.915 droeschl 7507: ul.LC_funclist {
7508: margin: 0;
7509: padding: 0.5em 1em 0.5em 0;
7510: }
7511:
1.933 droeschl 7512: ul.LC_funclist > li:first-child {
7513: font-weight:bold;
7514: margin-left:0.8em;
7515: }
7516:
1.915 droeschl 7517: ul.LC_funclist + ul.LC_funclist {
7518: /*
7519: left border as a seperator if we have more than
7520: one list
7521: */
7522: border-left: 1px solid $sidebg;
7523: /*
7524: this hides the left border behind the border of the
7525: outer box if element is wrapped to the next 'line'
7526: */
7527: margin-left: -1px;
7528: }
7529:
1.843 bisitz 7530: ul.LC_funclist li {
1.915 droeschl 7531: display: inline;
1.782 bisitz 7532: white-space: nowrap;
1.915 droeschl 7533: margin: 0 0 0 25px;
7534: line-height: 150%;
1.782 bisitz 7535: }
7536:
1.974 wenzelju 7537: .LC_hidden {
7538: display: none;
7539: }
7540:
1.1030 www 7541: .LCmodal-overlay {
7542: position:fixed;
7543: top:0;
7544: right:0;
7545: bottom:0;
7546: left:0;
7547: height:100%;
7548: width:100%;
7549: margin:0;
7550: padding:0;
7551: background:#999;
7552: opacity:.75;
7553: filter: alpha(opacity=75);
7554: -moz-opacity: 0.75;
7555: z-index:101;
7556: }
7557:
7558: * html .LCmodal-overlay {
7559: position: absolute;
7560: height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
7561: }
7562:
7563: .LCmodal-window {
7564: position:fixed;
7565: top:50%;
7566: left:50%;
7567: margin:0;
7568: padding:0;
7569: z-index:102;
7570: }
7571:
7572: * html .LCmodal-window {
7573: position:absolute;
7574: }
7575:
7576: .LCclose-window {
7577: position:absolute;
7578: width:32px;
7579: height:32px;
7580: right:8px;
7581: top:8px;
7582: background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
7583: text-indent:-99999px;
7584: overflow:hidden;
7585: cursor:pointer;
7586: }
7587:
1.1100 raeburn 7588: /*
7589: styles used by TTH when "Default set of options to pass to tth/m
7590: when converting TeX" in course settings has been set
7591:
7592: option passed: -t
7593:
7594: */
7595:
7596: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
7597: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
7598: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
7599: td div.norm {line-height:normal;}
7600:
7601: /*
7602: option passed -y3
7603: */
7604:
7605: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
7606: span.overacc2 {position: relative; left: .8em; top: -1.2ex;}
7607: span.overacc1 {position: relative; left: .6em; top: -1.2ex;}
7608:
1.343 albertel 7609: END
7610: }
7611:
1.306 albertel 7612: =pod
7613:
7614: =item * &headtag()
7615:
7616: Returns a uniform footer for LON-CAPA web pages.
7617:
1.307 albertel 7618: Inputs: $title - optional title for the head
7619: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 7620: $args - optional arguments
1.319 albertel 7621: force_register - if is true call registerurl so the remote is
7622: informed
1.415 albertel 7623: redirect -> array ref of
7624: 1- seconds before redirect occurs
7625: 2- url to redirect to
7626: 3- whether the side effect should occur
1.315 albertel 7627: (side effect of setting
7628: $env{'internal.head.redirect'} to the url
7629: redirected too)
1.352 albertel 7630: domain -> force to color decorate a page for a specific
7631: domain
7632: function -> force usage of a specific rolish color scheme
7633: bgcolor -> override the default page bgcolor
1.460 albertel 7634: no_auto_mt_title
7635: -> prevent &mt()ing the title arg
1.464 albertel 7636:
1.306 albertel 7637: =cut
7638:
7639: sub headtag {
1.313 albertel 7640: my ($title,$head_extra,$args) = @_;
1.306 albertel 7641:
1.363 albertel 7642: my $function = $args->{'function'} || &get_users_function();
7643: my $domain = $args->{'domain'} || &determinedomain();
7644: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.1154 raeburn 7645: my $httphost = $args->{'use_absolute'};
1.418 albertel 7646: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 7647: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 7648: #time(),
1.418 albertel 7649: $env{'environment.color.timestamp'},
1.363 albertel 7650: $function,$domain,$bgcolor);
7651:
1.369 www 7652: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 7653:
1.308 albertel 7654: my $result =
7655: '<head>'.
1.1160 raeburn 7656: &font_settings($args);
1.319 albertel 7657:
1.1188 raeburn 7658: my $inhibitprint;
7659: if ($args->{'print_suppress'}) {
7660: $inhibitprint = &print_suppression();
7661: }
1.1064 raeburn 7662:
1.461 albertel 7663: if (!$args->{'frameset'}) {
7664: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
7665: }
1.962 droeschl 7666: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
7667: $result .= Apache::lonxml::display_title();
1.319 albertel 7668: }
1.436 albertel 7669: if (!$args->{'no_nav_bar'}
7670: && !$args->{'only_body'}
7671: && !$args->{'frameset'}) {
1.1154 raeburn 7672: $result .= &help_menu_js($httphost);
1.1032 www 7673: $result.=&modal_window();
1.1038 www 7674: $result.=&togglebox_script();
1.1034 www 7675: $result.=&wishlist_window();
1.1041 www 7676: $result.=&LCprogressbarUpdate_script();
1.1034 www 7677: } else {
7678: if ($args->{'add_modal'}) {
7679: $result.=&modal_window();
7680: }
7681: if ($args->{'add_wishlist'}) {
7682: $result.=&wishlist_window();
7683: }
1.1038 www 7684: if ($args->{'add_togglebox'}) {
7685: $result.=&togglebox_script();
7686: }
1.1041 www 7687: if ($args->{'add_progressbar'}) {
7688: $result.=&LCprogressbarUpdate_script();
7689: }
1.436 albertel 7690: }
1.314 albertel 7691: if (ref($args->{'redirect'})) {
1.414 albertel 7692: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 7693: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 7694: if (!$inhibit_continue) {
7695: $env{'internal.head.redirect'} = $url;
7696: }
1.313 albertel 7697: $result.=<<ADDMETA
7698: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 7699: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 7700: ADDMETA
7701: }
1.306 albertel 7702: if (!defined($title)) {
7703: $title = 'The LearningOnline Network with CAPA';
7704: }
1.460 albertel 7705: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
7706: $result .= '<title> LON-CAPA '.$title.'</title>'
1.1168 raeburn 7707: .'<link rel="stylesheet" type="text/css" href="'.$url.'"';
7708: if (!$args->{'frameset'}) {
7709: $result .= ' /';
7710: }
7711: $result .= '>'
1.1064 raeburn 7712: .$inhibitprint
1.414 albertel 7713: .$head_extra;
1.1137 raeburn 7714: if ($env{'browser.mobile'}) {
7715: $result .= '
7716: <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=0, minimum-scale=1.0, maximum-scale=1.0">
7717: <meta name="apple-mobile-web-app-capable" content="yes" />';
7718: }
1.962 droeschl 7719: return $result.'</head>';
1.306 albertel 7720: }
7721:
7722: =pod
7723:
1.340 albertel 7724: =item * &font_settings()
7725:
7726: Returns neccessary <meta> to set the proper encoding
7727:
1.1160 raeburn 7728: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340 albertel 7729:
7730: =cut
7731:
7732: sub font_settings {
1.1160 raeburn 7733: my ($args) = @_;
1.340 albertel 7734: my $headerstring='';
1.1160 raeburn 7735: if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
7736: ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.1168 raeburn 7737: $headerstring.=
7738: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
7739: if (!$args->{'frameset'}) {
7740: $headerstring.= ' /';
7741: }
7742: $headerstring .= '>'."\n";
1.340 albertel 7743: }
7744: return $headerstring;
7745: }
7746:
1.341 albertel 7747: =pod
7748:
1.1064 raeburn 7749: =item * &print_suppression()
7750:
7751: In course context returns css which causes the body to be blank when media="print",
7752: if printout generation is unavailable for the current resource.
7753:
7754: This could be because:
7755:
7756: (a) printstartdate is in the future
7757:
7758: (b) printenddate is in the past
7759:
7760: (c) there is an active exam block with "printout"
7761: functionality blocked
7762:
7763: Users with pav, pfo or evb privileges are exempt.
7764:
7765: Inputs: none
7766:
7767: =cut
7768:
7769:
7770: sub print_suppression {
7771: my $noprint;
7772: if ($env{'request.course.id'}) {
7773: my $scope = $env{'request.course.id'};
7774: if ((&Apache::lonnet::allowed('pav',$scope)) ||
7775: (&Apache::lonnet::allowed('pfo',$scope))) {
7776: return;
7777: }
7778: if ($env{'request.course.sec'} ne '') {
7779: $scope .= "/$env{'request.course.sec'}";
7780: if ((&Apache::lonnet::allowed('pav',$scope)) ||
7781: (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065 raeburn 7782: return;
1.1064 raeburn 7783: }
7784: }
7785: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7786: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1189 raeburn 7787: my $blocked = &blocking_status('printout',$cnum,$cdom,undef,1);
1.1064 raeburn 7788: if ($blocked) {
7789: my $checkrole = "cm./$cdom/$cnum";
7790: if ($env{'request.course.sec'} ne '') {
7791: $checkrole .= "/$env{'request.course.sec'}";
7792: }
7793: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
7794: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
7795: $noprint = 1;
7796: }
7797: }
7798: unless ($noprint) {
7799: my $symb = &Apache::lonnet::symbread();
7800: if ($symb ne '') {
7801: my $navmap = Apache::lonnavmaps::navmap->new();
7802: if (ref($navmap)) {
7803: my $res = $navmap->getBySymb($symb);
7804: if (ref($res)) {
7805: if (!$res->resprintable()) {
7806: $noprint = 1;
7807: }
7808: }
7809: }
7810: }
7811: }
7812: if ($noprint) {
7813: return <<"ENDSTYLE";
7814: <style type="text/css" media="print">
7815: body { display:none }
7816: </style>
7817: ENDSTYLE
7818: }
7819: }
7820: return;
7821: }
7822:
7823: =pod
7824:
1.341 albertel 7825: =item * &xml_begin()
7826:
7827: Returns the needed doctype and <html>
7828:
7829: Inputs: none
7830:
7831: =cut
7832:
7833: sub xml_begin {
1.1168 raeburn 7834: my ($is_frameset) = @_;
1.341 albertel 7835: my $output='';
7836:
7837: if ($env{'browser.mathml'}) {
7838: $output='<?xml version="1.0"?>'
7839: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
7840: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
7841:
7842: # .'<!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">] >'
7843: .'<!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">'
7844: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
7845: .'xmlns="http://www.w3.org/1999/xhtml">';
1.1168 raeburn 7846: } elsif ($is_frameset) {
7847: $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
7848: '<html>'."\n";
1.341 albertel 7849: } else {
1.1168 raeburn 7850: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
7851: '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341 albertel 7852: }
7853: return $output;
7854: }
1.340 albertel 7855:
7856: =pod
7857:
1.306 albertel 7858: =item * &start_page()
7859:
7860: Returns a complete <html> .. <body> section for LON-CAPA web pages.
7861:
1.648 raeburn 7862: Inputs:
7863:
7864: =over 4
7865:
7866: $title - optional title for the page
7867:
7868: $head_extra - optional extra HTML to incude inside the <head>
7869:
7870: $args - additional optional args supported are:
7871:
7872: =over 8
7873:
7874: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 7875: arg on
1.814 bisitz 7876: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 7877: add_entries -> additional attributes to add to the <body>
7878: domain -> force to color decorate a page for a
1.317 albertel 7879: specific domain
1.648 raeburn 7880: function -> force usage of a specific rolish color
1.317 albertel 7881: scheme
1.648 raeburn 7882: redirect -> see &headtag()
7883: bgcolor -> override the default page bg color
7884: js_ready -> return a string ready for being used in
1.317 albertel 7885: a javascript writeln
1.648 raeburn 7886: html_encode -> return a string ready for being used in
1.320 albertel 7887: a html attribute
1.648 raeburn 7888: force_register -> if is true will turn on the &bodytag()
1.317 albertel 7889: $forcereg arg
1.648 raeburn 7890: frameset -> if true will start with a <frameset>
1.330 albertel 7891: rather than <body>
1.648 raeburn 7892: skip_phases -> hash ref of
1.338 albertel 7893: head -> skip the <html><head> generation
7894: body -> skip all <body> generation
1.648 raeburn 7895: no_auto_mt_title -> prevent &mt()ing the title arg
7896: inherit_jsmath -> when creating popup window in a page,
7897: should it have jsmath forced on by the
7898: current page
1.867 kalberla 7899: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 7900: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.1096 raeburn 7901: group -> includes the current group, if page is for a
7902: specific group
1.361 albertel 7903:
1.648 raeburn 7904: =back
1.460 albertel 7905:
1.648 raeburn 7906: =back
1.562 albertel 7907:
1.306 albertel 7908: =cut
7909:
7910: sub start_page {
1.309 albertel 7911: my ($title,$head_extra,$args) = @_;
1.318 albertel 7912: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319 albertel 7913:
1.315 albertel 7914: $env{'internal.start_page'}++;
1.1096 raeburn 7915: my ($result,@advtools);
1.964 droeschl 7916:
1.338 albertel 7917: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1168 raeburn 7918: $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338 albertel 7919: }
7920:
7921: if (! exists($args->{'skip_phases'}{'body'}) ) {
7922: if ($args->{'frameset'}) {
7923: my $attr_string = &make_attr_string($args->{'force_register'},
7924: $args->{'add_entries'});
7925: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 7926: } else {
7927: $result .=
7928: &bodytag($title,
7929: $args->{'function'}, $args->{'add_entries'},
7930: $args->{'only_body'}, $args->{'domain'},
7931: $args->{'force_register'}, $args->{'no_nav_bar'},
1.1096 raeburn 7932: $args->{'bgcolor'}, $args,
7933: \@advtools);
1.831 bisitz 7934: }
1.330 albertel 7935: }
1.338 albertel 7936:
1.315 albertel 7937: if ($args->{'js_ready'}) {
1.713 kaisler 7938: $result = &js_ready($result);
1.315 albertel 7939: }
1.320 albertel 7940: if ($args->{'html_encode'}) {
1.713 kaisler 7941: $result = &html_encode($result);
7942: }
7943:
1.813 bisitz 7944: # Preparation for new and consistent functionlist at top of screen
7945: # if ($args->{'functionlist'}) {
7946: # $result .= &build_functionlist();
7947: #}
7948:
1.964 droeschl 7949: # Don't add anything more if only_body wanted or in const space
7950: return $result if $args->{'only_body'}
7951: || $env{'request.state'} eq 'construct';
1.813 bisitz 7952:
7953: #Breadcrumbs
1.758 kaisler 7954: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
7955: &Apache::lonhtmlcommon::clear_breadcrumbs();
7956: #if any br links exists, add them to the breadcrumbs
7957: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
7958: foreach my $crumb (@{$args->{'bread_crumbs'}}){
7959: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
7960: }
7961: }
1.1096 raeburn 7962: # if @advtools array contains items add then to the breadcrumbs
7963: if (@advtools > 0) {
7964: &Apache::lonmenu::advtools_crumbs(@advtools);
7965: }
1.758 kaisler 7966:
7967: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
7968: if(exists($args->{'bread_crumbs_component'})){
7969: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
7970: }else{
7971: $result .= &Apache::lonhtmlcommon::breadcrumbs();
7972: }
1.320 albertel 7973: }
1.315 albertel 7974: return $result;
1.306 albertel 7975: }
7976:
7977: sub end_page {
1.315 albertel 7978: my ($args) = @_;
7979: $env{'internal.end_page'}++;
1.330 albertel 7980: my $result;
1.335 albertel 7981: if ($args->{'discussion'}) {
7982: my ($target,$parser);
7983: if (ref($args->{'discussion'})) {
7984: ($target,$parser) =($args->{'discussion'}{'target'},
7985: $args->{'discussion'}{'parser'});
7986: }
7987: $result .= &Apache::lonxml::xmlend($target,$parser);
7988: }
1.330 albertel 7989: if ($args->{'frameset'}) {
7990: $result .= '</frameset>';
7991: } else {
1.635 raeburn 7992: $result .= &endbodytag($args);
1.330 albertel 7993: }
1.1080 raeburn 7994: unless ($args->{'notbody'}) {
7995: $result .= "\n</html>";
7996: }
1.330 albertel 7997:
1.315 albertel 7998: if ($args->{'js_ready'}) {
1.317 albertel 7999: $result = &js_ready($result);
1.315 albertel 8000: }
1.335 albertel 8001:
1.320 albertel 8002: if ($args->{'html_encode'}) {
8003: $result = &html_encode($result);
8004: }
1.335 albertel 8005:
1.315 albertel 8006: return $result;
8007: }
8008:
1.1034 www 8009: sub wishlist_window {
8010: return(<<'ENDWISHLIST');
1.1046 raeburn 8011: <script type="text/javascript">
1.1034 www 8012: // <![CDATA[
8013: // <!-- BEGIN LON-CAPA Internal
8014: function set_wishlistlink(title, path) {
8015: if (!title) {
8016: title = document.title;
8017: title = title.replace(/^LON-CAPA /,'');
8018: }
1.1175 raeburn 8019: title = encodeURIComponent(title);
1.1203 raeburn 8020: title = title.replace("'","\\\'");
1.1034 www 8021: if (!path) {
8022: path = location.pathname;
8023: }
1.1175 raeburn 8024: path = encodeURIComponent(path);
1.1203 raeburn 8025: path = path.replace("'","\\\'");
1.1034 www 8026: Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
8027: 'wishlistNewLink','width=560,height=350,scrollbars=0');
8028: }
8029: // END LON-CAPA Internal -->
8030: // ]]>
8031: </script>
8032: ENDWISHLIST
8033: }
8034:
1.1030 www 8035: sub modal_window {
8036: return(<<'ENDMODAL');
1.1046 raeburn 8037: <script type="text/javascript">
1.1030 www 8038: // <![CDATA[
8039: // <!-- BEGIN LON-CAPA Internal
8040: var modalWindow = {
8041: parent:"body",
8042: windowId:null,
8043: content:null,
8044: width:null,
8045: height:null,
8046: close:function()
8047: {
8048: $(".LCmodal-window").remove();
8049: $(".LCmodal-overlay").remove();
8050: },
8051: open:function()
8052: {
8053: var modal = "";
8054: modal += "<div class=\"LCmodal-overlay\"></div>";
8055: 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;\">";
8056: modal += this.content;
8057: modal += "</div>";
8058:
8059: $(this.parent).append(modal);
8060:
8061: $(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
8062: $(".LCclose-window").click(function(){modalWindow.close();});
8063: $(".LCmodal-overlay").click(function(){modalWindow.close();});
8064: }
8065: };
1.1140 raeburn 8066: var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030 www 8067: {
1.1203 raeburn 8068: source = source.replace("'","'");
1.1030 www 8069: modalWindow.windowId = "myModal";
8070: modalWindow.width = width;
8071: modalWindow.height = height;
1.1196 raeburn 8072: modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030 www 8073: modalWindow.open();
8074: };
8075: // END LON-CAPA Internal -->
8076: // ]]>
8077: </script>
8078: ENDMODAL
8079: }
8080:
8081: sub modal_link {
1.1140 raeburn 8082: my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030 www 8083: unless ($width) { $width=480; }
8084: unless ($height) { $height=400; }
1.1031 www 8085: unless ($scrolling) { $scrolling='yes'; }
1.1140 raeburn 8086: unless ($transparency) { $transparency='true'; }
8087:
1.1074 raeburn 8088: my $target_attr;
8089: if (defined($target)) {
8090: $target_attr = 'target="'.$target.'"';
8091: }
8092: return <<"ENDLINK";
1.1140 raeburn 8093: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">
1.1074 raeburn 8094: $linktext</a>
8095: ENDLINK
1.1030 www 8096: }
8097:
1.1032 www 8098: sub modal_adhoc_script {
8099: my ($funcname,$width,$height,$content)=@_;
8100: return (<<ENDADHOC);
1.1046 raeburn 8101: <script type="text/javascript">
1.1032 www 8102: // <![CDATA[
8103: var $funcname = function()
8104: {
8105: modalWindow.windowId = "myModal";
8106: modalWindow.width = $width;
8107: modalWindow.height = $height;
8108: modalWindow.content = '$content';
8109: modalWindow.open();
8110: };
8111: // ]]>
8112: </script>
8113: ENDADHOC
8114: }
8115:
1.1041 www 8116: sub modal_adhoc_inner {
8117: my ($funcname,$width,$height,$content)=@_;
8118: my $innerwidth=$width-20;
8119: $content=&js_ready(
1.1140 raeburn 8120: &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
8121: &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
8122: $content.
1.1041 www 8123: &end_scrollbox().
1.1140 raeburn 8124: &end_page()
1.1041 www 8125: );
8126: return &modal_adhoc_script($funcname,$width,$height,$content);
8127: }
8128:
8129: sub modal_adhoc_window {
8130: my ($funcname,$width,$height,$content,$linktext)=@_;
8131: return &modal_adhoc_inner($funcname,$width,$height,$content).
8132: "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
8133: }
8134:
8135: sub modal_adhoc_launch {
8136: my ($funcname,$width,$height,$content)=@_;
8137: return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
8138: <script type="text/javascript">
8139: // <![CDATA[
8140: $funcname();
8141: // ]]>
8142: </script>
8143: ENDLAUNCH
8144: }
8145:
8146: sub modal_adhoc_close {
8147: return (<<ENDCLOSE);
8148: <script type="text/javascript">
8149: // <![CDATA[
8150: modalWindow.close();
8151: // ]]>
8152: </script>
8153: ENDCLOSE
8154: }
8155:
1.1038 www 8156: sub togglebox_script {
8157: return(<<ENDTOGGLE);
8158: <script type="text/javascript">
8159: // <![CDATA[
8160: function LCtoggleDisplay(id,hidetext,showtext) {
8161: link = document.getElementById(id + "link").childNodes[0];
8162: with (document.getElementById(id).style) {
8163: if (display == "none" ) {
8164: display = "inline";
8165: link.nodeValue = hidetext;
8166: } else {
8167: display = "none";
8168: link.nodeValue = showtext;
8169: }
8170: }
8171: }
8172: // ]]>
8173: </script>
8174: ENDTOGGLE
8175: }
8176:
1.1039 www 8177: sub start_togglebox {
8178: my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
8179: unless ($heading) { $heading=''; } else { $heading.=' '; }
8180: unless ($showtext) { $showtext=&mt('show'); }
8181: unless ($hidetext) { $hidetext=&mt('hide'); }
8182: unless ($headerbg) { $headerbg='#FFFFFF'; }
8183: return &start_data_table().
8184: &start_data_table_header_row().
8185: '<td bgcolor="'.$headerbg.'">'.$heading.
8186: '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
8187: $showtext.'\')">'.$showtext.'</a>]</td>'.
8188: &end_data_table_header_row().
8189: '<tr id="'.$id.'" style="display:none""><td>';
8190: }
8191:
8192: sub end_togglebox {
8193: return '</td></tr>'.&end_data_table();
8194: }
8195:
1.1041 www 8196: sub LCprogressbar_script {
1.1045 www 8197: my ($id)=@_;
1.1041 www 8198: return(<<ENDPROGRESS);
8199: <script type="text/javascript">
8200: // <![CDATA[
1.1045 www 8201: \$('#progressbar$id').progressbar({
1.1041 www 8202: value: 0,
8203: change: function(event, ui) {
8204: var newVal = \$(this).progressbar('option', 'value');
8205: \$('.pblabel', this).text(LCprogressTxt);
8206: }
8207: });
8208: // ]]>
8209: </script>
8210: ENDPROGRESS
8211: }
8212:
8213: sub LCprogressbarUpdate_script {
8214: return(<<ENDPROGRESSUPDATE);
8215: <style type="text/css">
8216: .ui-progressbar { position:relative; }
8217: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
8218: </style>
8219: <script type="text/javascript">
8220: // <![CDATA[
1.1045 www 8221: var LCprogressTxt='---';
8222:
8223: function LCupdateProgress(percent,progresstext,id) {
1.1041 www 8224: LCprogressTxt=progresstext;
1.1045 www 8225: \$('#progressbar'+id).progressbar('value',percent);
1.1041 www 8226: }
8227: // ]]>
8228: </script>
8229: ENDPROGRESSUPDATE
8230: }
8231:
1.1042 www 8232: my $LClastpercent;
1.1045 www 8233: my $LCidcnt;
8234: my $LCcurrentid;
1.1042 www 8235:
1.1041 www 8236: sub LCprogressbar {
1.1042 www 8237: my ($r)=(@_);
8238: $LClastpercent=0;
1.1045 www 8239: $LCidcnt++;
8240: $LCcurrentid=$$.'_'.$LCidcnt;
1.1041 www 8241: my $starting=&mt('Starting');
8242: my $content=(<<ENDPROGBAR);
1.1045 www 8243: <div id="progressbar$LCcurrentid">
1.1041 www 8244: <span class="pblabel">$starting</span>
8245: </div>
8246: ENDPROGBAR
1.1045 www 8247: &r_print($r,$content.&LCprogressbar_script($LCcurrentid));
1.1041 www 8248: }
8249:
8250: sub LCprogressbarUpdate {
1.1042 www 8251: my ($r,$val,$text)=@_;
8252: unless ($val) {
8253: if ($LClastpercent) {
8254: $val=$LClastpercent;
8255: } else {
8256: $val=0;
8257: }
8258: }
1.1041 www 8259: if ($val<0) { $val=0; }
8260: if ($val>100) { $val=0; }
1.1042 www 8261: $LClastpercent=$val;
1.1041 www 8262: unless ($text) { $text=$val.'%'; }
8263: $text=&js_ready($text);
1.1044 www 8264: &r_print($r,<<ENDUPDATE);
1.1041 www 8265: <script type="text/javascript">
8266: // <![CDATA[
1.1045 www 8267: LCupdateProgress($val,'$text','$LCcurrentid');
1.1041 www 8268: // ]]>
8269: </script>
8270: ENDUPDATE
1.1035 www 8271: }
8272:
1.1042 www 8273: sub LCprogressbarClose {
8274: my ($r)=@_;
8275: $LClastpercent=0;
1.1044 www 8276: &r_print($r,<<ENDCLOSE);
1.1042 www 8277: <script type="text/javascript">
8278: // <![CDATA[
1.1045 www 8279: \$("#progressbar$LCcurrentid").hide('slow');
1.1042 www 8280: // ]]>
8281: </script>
8282: ENDCLOSE
1.1044 www 8283: }
8284:
8285: sub r_print {
8286: my ($r,$to_print)=@_;
8287: if ($r) {
8288: $r->print($to_print);
8289: $r->rflush();
8290: } else {
8291: print($to_print);
8292: }
1.1042 www 8293: }
8294:
1.320 albertel 8295: sub html_encode {
8296: my ($result) = @_;
8297:
1.322 albertel 8298: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 8299:
8300: return $result;
8301: }
1.1044 www 8302:
1.317 albertel 8303: sub js_ready {
8304: my ($result) = @_;
8305:
1.323 albertel 8306: $result =~ s/[\n\r]/ /xmsg;
8307: $result =~ s/\\/\\\\/xmsg;
8308: $result =~ s/'/\\'/xmsg;
1.372 albertel 8309: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 8310:
8311: return $result;
8312: }
8313:
1.315 albertel 8314: sub validate_page {
8315: if ( exists($env{'internal.start_page'})
1.316 albertel 8316: && $env{'internal.start_page'} > 1) {
8317: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 8318: $env{'internal.start_page'}.' '.
1.316 albertel 8319: $ENV{'request.filename'});
1.315 albertel 8320: }
8321: if ( exists($env{'internal.end_page'})
1.316 albertel 8322: && $env{'internal.end_page'} > 1) {
8323: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 8324: $env{'internal.end_page'}.' '.
1.316 albertel 8325: $env{'request.filename'});
1.315 albertel 8326: }
8327: if ( exists($env{'internal.start_page'})
8328: && ! exists($env{'internal.end_page'})) {
1.316 albertel 8329: &Apache::lonnet::logthis('start_page called without end_page '.
8330: $env{'request.filename'});
1.315 albertel 8331: }
8332: if ( ! exists($env{'internal.start_page'})
8333: && exists($env{'internal.end_page'})) {
1.316 albertel 8334: &Apache::lonnet::logthis('end_page called without start_page'.
8335: $env{'request.filename'});
1.315 albertel 8336: }
1.306 albertel 8337: }
1.315 albertel 8338:
1.996 www 8339:
8340: sub start_scrollbox {
1.1140 raeburn 8341: my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998 raeburn 8342: unless ($outerwidth) { $outerwidth='520px'; }
8343: unless ($width) { $width='500px'; }
8344: unless ($height) { $height='200px'; }
1.1075 raeburn 8345: my ($table_id,$div_id,$tdcol);
1.1018 raeburn 8346: if ($id ne '') {
1.1140 raeburn 8347: $table_id = ' id="table_'.$id.'"';
1.1137 raeburn 8348: $div_id = ' id="div_'.$id.'"';
1.1018 raeburn 8349: }
1.1075 raeburn 8350: if ($bgcolor ne '') {
8351: $tdcol = "background-color: $bgcolor;";
8352: }
1.1137 raeburn 8353: my $nicescroll_js;
8354: if ($env{'browser.mobile'}) {
1.1140 raeburn 8355: $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
8356: }
8357: return <<"END";
8358: $nicescroll_js
8359:
8360: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
8361: <div style="overflow:auto; width:$width; height:$height;"$div_id>
8362: END
8363: }
8364:
8365: sub end_scrollbox {
8366: return '</div></td></tr></table>';
8367: }
8368:
8369: sub nicescroll_javascript {
8370: my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
8371: my %options;
8372: if (ref($cursor) eq 'HASH') {
8373: %options = %{$cursor};
8374: }
8375: unless ($options{'railalign'} =~ /^left|right$/) {
8376: $options{'railalign'} = 'left';
8377: }
8378: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
8379: my $function = &get_users_function();
8380: $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
1.1138 raeburn 8381: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
1.1140 raeburn 8382: $options{'cursorcolor'} = '#00F';
1.1138 raeburn 8383: }
1.1140 raeburn 8384: }
8385: if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
8386: unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
1.1138 raeburn 8387: $options{'cursoropacity'}='1.0';
8388: }
1.1140 raeburn 8389: } else {
8390: $options{'cursoropacity'}='1.0';
8391: }
8392: if ($options{'cursorfixedheight'} eq 'none') {
8393: delete($options{'cursorfixedheight'});
8394: } else {
8395: unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
8396: }
8397: unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
8398: delete($options{'railoffset'});
8399: }
8400: my @niceoptions;
8401: while (my($key,$value) = each(%options)) {
8402: if ($value =~ /^\{.+\}$/) {
8403: push(@niceoptions,$key.':'.$value);
1.1138 raeburn 8404: } else {
1.1140 raeburn 8405: push(@niceoptions,$key.':"'.$value.'"');
1.1138 raeburn 8406: }
1.1140 raeburn 8407: }
8408: my $nicescroll_js = '
1.1137 raeburn 8409: $(document).ready(
1.1140 raeburn 8410: function() {
8411: $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
8412: }
1.1137 raeburn 8413: );
8414: ';
1.1140 raeburn 8415: if ($framecheck) {
8416: $nicescroll_js .= '
8417: function expand_div(caller) {
8418: if (top === self) {
8419: document.getElementById("'.$id.'").style.width = "auto";
8420: document.getElementById("'.$id.'").style.height = "auto";
8421: } else {
8422: try {
8423: if (parent.frames) {
8424: if (parent.frames.length > 1) {
8425: var framesrc = parent.frames[1].location.href;
8426: var currsrc = framesrc.replace(/\#.*$/,"");
8427: if ((caller == "search") || (currsrc == "'.$location.'")) {
8428: document.getElementById("'.$id.'").style.width = "auto";
8429: document.getElementById("'.$id.'").style.height = "auto";
8430: }
8431: }
8432: }
8433: } catch (e) {
8434: return;
8435: }
1.1137 raeburn 8436: }
1.1140 raeburn 8437: return;
1.996 www 8438: }
1.1140 raeburn 8439: ';
8440: }
8441: if ($needjsready) {
8442: $nicescroll_js = '
8443: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
8444: } else {
8445: $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
8446: }
8447: return $nicescroll_js;
1.996 www 8448: }
8449:
1.318 albertel 8450: sub simple_error_page {
1.1150 bisitz 8451: my ($r,$title,$msg,$args) = @_;
1.1151 raeburn 8452: if (ref($args) eq 'HASH') {
8453: if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
8454: } else {
8455: $msg = &mt($msg);
8456: }
1.1150 bisitz 8457:
1.318 albertel 8458: my $page =
8459: &Apache::loncommon::start_page($title).
1.1150 bisitz 8460: '<p class="LC_error">'.$msg.'</p>'.
1.318 albertel 8461: &Apache::loncommon::end_page();
8462: if (ref($r)) {
8463: $r->print($page);
1.327 albertel 8464: return;
1.318 albertel 8465: }
8466: return $page;
8467: }
1.347 albertel 8468:
8469: {
1.610 albertel 8470: my @row_count;
1.961 onken 8471:
8472: sub start_data_table_count {
8473: unshift(@row_count, 0);
8474: return;
8475: }
8476:
8477: sub end_data_table_count {
8478: shift(@row_count);
8479: return;
8480: }
8481:
1.347 albertel 8482: sub start_data_table {
1.1018 raeburn 8483: my ($add_class,$id) = @_;
1.422 albertel 8484: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 8485: my $table_id;
8486: if (defined($id)) {
8487: $table_id = ' id="'.$id.'"';
8488: }
1.961 onken 8489: &start_data_table_count();
1.1018 raeburn 8490: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 8491: }
8492:
8493: sub end_data_table {
1.961 onken 8494: &end_data_table_count();
1.389 albertel 8495: return '</table>'."\n";;
1.347 albertel 8496: }
8497:
8498: sub start_data_table_row {
1.974 wenzelju 8499: my ($add_class, $id) = @_;
1.610 albertel 8500: $row_count[0]++;
8501: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 8502: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 8503: $id = (' id="'.$id.'"') unless ($id eq '');
8504: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 8505: }
1.471 banghart 8506:
8507: sub continue_data_table_row {
1.974 wenzelju 8508: my ($add_class, $id) = @_;
1.610 albertel 8509: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 8510: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
8511: $id = (' id="'.$id.'"') unless ($id eq '');
8512: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 8513: }
1.347 albertel 8514:
8515: sub end_data_table_row {
1.389 albertel 8516: return '</tr>'."\n";;
1.347 albertel 8517: }
1.367 www 8518:
1.421 albertel 8519: sub start_data_table_empty_row {
1.707 bisitz 8520: # $row_count[0]++;
1.421 albertel 8521: return '<tr class="LC_empty_row" >'."\n";;
8522: }
8523:
8524: sub end_data_table_empty_row {
8525: return '</tr>'."\n";;
8526: }
8527:
1.367 www 8528: sub start_data_table_header_row {
1.389 albertel 8529: return '<tr class="LC_header_row">'."\n";;
1.367 www 8530: }
8531:
8532: sub end_data_table_header_row {
1.389 albertel 8533: return '</tr>'."\n";;
1.367 www 8534: }
1.890 droeschl 8535:
8536: sub data_table_caption {
8537: my $caption = shift;
8538: return "<caption class=\"LC_caption\">$caption</caption>";
8539: }
1.347 albertel 8540: }
8541:
1.548 albertel 8542: =pod
8543:
8544: =item * &inhibit_menu_check($arg)
8545:
8546: Checks for a inhibitmenu state and generates output to preserve it
8547:
8548: Inputs: $arg - can be any of
8549: - undef - in which case the return value is a string
8550: to add into arguments list of a uri
8551: - 'input' - in which case the return value is a HTML
8552: <form> <input> field of type hidden to
8553: preserve the value
8554: - a url - in which case the return value is the url with
8555: the neccesary cgi args added to preserve the
8556: inhibitmenu state
8557: - a ref to a url - no return value, but the string is
8558: updated to include the neccessary cgi
8559: args to preserve the inhibitmenu state
8560:
8561: =cut
8562:
8563: sub inhibit_menu_check {
8564: my ($arg) = @_;
8565: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
8566: if ($arg eq 'input') {
8567: if ($env{'form.inhibitmenu'}) {
8568: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
8569: } else {
8570: return
8571: }
8572: }
8573: if ($env{'form.inhibitmenu'}) {
8574: if (ref($arg)) {
8575: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
8576: } elsif ($arg eq '') {
8577: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
8578: } else {
8579: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
8580: }
8581: }
8582: if (!ref($arg)) {
8583: return $arg;
8584: }
8585: }
8586:
1.251 albertel 8587: ###############################################
1.182 matthew 8588:
8589: =pod
8590:
1.549 albertel 8591: =back
8592:
8593: =head1 User Information Routines
8594:
8595: =over 4
8596:
1.405 albertel 8597: =item * &get_users_function()
1.182 matthew 8598:
8599: Used by &bodytag to determine the current users primary role.
8600: Returns either 'student','coordinator','admin', or 'author'.
8601:
8602: =cut
8603:
8604: ###############################################
8605: sub get_users_function {
1.815 tempelho 8606: my $function = 'norole';
1.818 tempelho 8607: if ($env{'request.role'}=~/^(st)/) {
8608: $function='student';
8609: }
1.907 raeburn 8610: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 8611: $function='coordinator';
8612: }
1.258 albertel 8613: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 8614: $function='admin';
8615: }
1.826 bisitz 8616: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025 raeburn 8617: ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182 matthew 8618: $function='author';
8619: }
8620: return $function;
1.54 www 8621: }
1.99 www 8622:
8623: ###############################################
8624:
1.233 raeburn 8625: =pod
8626:
1.821 raeburn 8627: =item * &show_course()
8628:
8629: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
8630: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
8631:
8632: Inputs:
8633: None
8634:
8635: Outputs:
8636: Scalar: 1 if 'Course' to be used, 0 otherwise.
8637:
8638: =cut
8639:
8640: ###############################################
8641: sub show_course {
8642: my $course = !$env{'user.adv'};
8643: if (!$env{'user.adv'}) {
8644: foreach my $env (keys(%env)) {
8645: next if ($env !~ m/^user\.priv\./);
8646: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
8647: $course = 0;
8648: last;
8649: }
8650: }
8651: }
8652: return $course;
8653: }
8654:
8655: ###############################################
8656:
8657: =pod
8658:
1.542 raeburn 8659: =item * &check_user_status()
1.274 raeburn 8660:
8661: Determines current status of supplied role for a
8662: specific user. Roles can be active, previous or future.
8663:
8664: Inputs:
8665: user's domain, user's username, course's domain,
1.375 raeburn 8666: course's number, optional section ID.
1.274 raeburn 8667:
8668: Outputs:
8669: role status: active, previous or future.
8670:
8671: =cut
8672:
8673: sub check_user_status {
1.412 raeburn 8674: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073 raeburn 8675: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1202 raeburn 8676: my @uroles = keys(%userinfo);
1.274 raeburn 8677: my $srchstr;
8678: my $active_chk = 'none';
1.412 raeburn 8679: my $now = time;
1.274 raeburn 8680: if (@uroles > 0) {
1.908 raeburn 8681: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 8682: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
8683: } else {
1.412 raeburn 8684: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
8685: }
8686: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 8687: my $role_end = 0;
8688: my $role_start = 0;
8689: $active_chk = 'active';
1.412 raeburn 8690: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
8691: $role_end = $1;
8692: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
8693: $role_start = $1;
1.274 raeburn 8694: }
8695: }
8696: if ($role_start > 0) {
1.412 raeburn 8697: if ($now < $role_start) {
1.274 raeburn 8698: $active_chk = 'future';
8699: }
8700: }
8701: if ($role_end > 0) {
1.412 raeburn 8702: if ($now > $role_end) {
1.274 raeburn 8703: $active_chk = 'previous';
8704: }
8705: }
8706: }
8707: }
8708: return $active_chk;
8709: }
8710:
8711: ###############################################
8712:
8713: =pod
8714:
1.405 albertel 8715: =item * &get_sections()
1.233 raeburn 8716:
8717: Determines all the sections for a course including
8718: sections with students and sections containing other roles.
1.419 raeburn 8719: Incoming parameters:
8720:
8721: 1. domain
8722: 2. course number
8723: 3. reference to array containing roles for which sections should
8724: be gathered (optional).
8725: 4. reference to array containing status types for which sections
8726: should be gathered (optional).
8727:
8728: If the third argument is undefined, sections are gathered for any role.
8729: If the fourth argument is undefined, sections are gathered for any status.
8730: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 8731:
1.374 raeburn 8732: Returns section hash (keys are section IDs, values are
8733: number of users in each section), subject to the
1.419 raeburn 8734: optional roles filter, optional status filter
1.233 raeburn 8735:
8736: =cut
8737:
8738: ###############################################
8739: sub get_sections {
1.419 raeburn 8740: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 8741: if (!defined($cdom) || !defined($cnum)) {
8742: my $cid = $env{'request.course.id'};
8743:
8744: return if (!defined($cid));
8745:
8746: $cdom = $env{'course.'.$cid.'.domain'};
8747: $cnum = $env{'course.'.$cid.'.num'};
8748: }
8749:
8750: my %sectioncount;
1.419 raeburn 8751: my $now = time;
1.240 albertel 8752:
1.1118 raeburn 8753: my $check_students = 1;
8754: my $only_students = 0;
8755: if (ref($possible_roles) eq 'ARRAY') {
8756: if (grep(/^st$/,@{$possible_roles})) {
8757: if (@{$possible_roles} == 1) {
8758: $only_students = 1;
8759: }
8760: } else {
8761: $check_students = 0;
8762: }
8763: }
8764:
8765: if ($check_students) {
1.276 albertel 8766: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 8767: my $sec_index = &Apache::loncoursedata::CL_SECTION();
8768: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 8769: my $start_index = &Apache::loncoursedata::CL_START();
8770: my $end_index = &Apache::loncoursedata::CL_END();
8771: my $status;
1.366 albertel 8772: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 8773: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
8774: $data->[$status_index],
8775: $data->[$start_index],
8776: $data->[$end_index]);
8777: if ($stu_status eq 'Active') {
8778: $status = 'active';
8779: } elsif ($end < $now) {
8780: $status = 'previous';
8781: } elsif ($start > $now) {
8782: $status = 'future';
8783: }
8784: if ($section ne '-1' && $section !~ /^\s*$/) {
8785: if ((!defined($possible_status)) || (($status ne '') &&
8786: (grep/^\Q$status\E$/,@{$possible_status}))) {
8787: $sectioncount{$section}++;
8788: }
1.240 albertel 8789: }
8790: }
8791: }
1.1118 raeburn 8792: if ($only_students) {
8793: return %sectioncount;
8794: }
1.240 albertel 8795: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8796: foreach my $user (sort(keys(%courseroles))) {
8797: if ($user !~ /^(\w{2})/) { next; }
8798: my ($role) = ($user =~ /^(\w{2})/);
8799: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 8800: my ($section,$status);
1.240 albertel 8801: if ($role eq 'cr' &&
8802: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
8803: $section=$1;
8804: }
8805: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
8806: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 8807: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
8808: if ($end == -1 && $start == -1) {
8809: next; #deleted role
8810: }
8811: if (!defined($possible_status)) {
8812: $sectioncount{$section}++;
8813: } else {
8814: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
8815: $status = 'active';
8816: } elsif ($end < $now) {
8817: $status = 'future';
8818: } elsif ($start > $now) {
8819: $status = 'previous';
8820: }
8821: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
8822: $sectioncount{$section}++;
8823: }
8824: }
1.233 raeburn 8825: }
1.366 albertel 8826: return %sectioncount;
1.233 raeburn 8827: }
8828:
1.274 raeburn 8829: ###############################################
1.294 raeburn 8830:
8831: =pod
1.405 albertel 8832:
8833: =item * &get_course_users()
8834:
1.275 raeburn 8835: Retrieves usernames:domains for users in the specified course
8836: with specific role(s), and access status.
8837:
8838: Incoming parameters:
1.277 albertel 8839: 1. course domain
8840: 2. course number
8841: 3. access status: users must have - either active,
1.275 raeburn 8842: previous, future, or all.
1.277 albertel 8843: 4. reference to array of permissible roles
1.288 raeburn 8844: 5. reference to array of section restrictions (optional)
8845: 6. reference to results object (hash of hashes).
8846: 7. reference to optional userdata hash
1.609 raeburn 8847: 8. reference to optional statushash
1.630 raeburn 8848: 9. flag if privileged users (except those set to unhide in
8849: course settings) should be excluded
1.609 raeburn 8850: Keys of top level results hash are roles.
1.275 raeburn 8851: Keys of inner hashes are username:domain, with
8852: values set to access type.
1.288 raeburn 8853: Optional userdata hash returns an array with arguments in the
8854: same order as loncoursedata::get_classlist() for student data.
8855:
1.609 raeburn 8856: Optional statushash returns
8857:
1.288 raeburn 8858: Entries for end, start, section and status are blank because
8859: of the possibility of multiple values for non-student roles.
8860:
1.275 raeburn 8861: =cut
1.405 albertel 8862:
1.275 raeburn 8863: ###############################################
1.405 albertel 8864:
1.275 raeburn 8865: sub get_course_users {
1.630 raeburn 8866: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 8867: my %idx = ();
1.419 raeburn 8868: my %seclists;
1.288 raeburn 8869:
8870: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
8871: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
8872: $idx{end} = &Apache::loncoursedata::CL_END();
8873: $idx{start} = &Apache::loncoursedata::CL_START();
8874: $idx{id} = &Apache::loncoursedata::CL_ID();
8875: $idx{section} = &Apache::loncoursedata::CL_SECTION();
8876: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
8877: $idx{status} = &Apache::loncoursedata::CL_STATUS();
8878:
1.290 albertel 8879: if (grep(/^st$/,@{$roles})) {
1.276 albertel 8880: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 8881: my $now = time;
1.277 albertel 8882: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 8883: my $match = 0;
1.412 raeburn 8884: my $secmatch = 0;
1.419 raeburn 8885: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 8886: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 8887: if ($section eq '') {
8888: $section = 'none';
8889: }
1.291 albertel 8890: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 8891: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 8892: $secmatch = 1;
8893: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 8894: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 8895: $secmatch = 1;
8896: }
8897: } else {
1.419 raeburn 8898: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 8899: $secmatch = 1;
8900: }
1.290 albertel 8901: }
1.412 raeburn 8902: if (!$secmatch) {
8903: next;
8904: }
1.419 raeburn 8905: }
1.275 raeburn 8906: if (defined($$types{'active'})) {
1.288 raeburn 8907: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 8908: push(@{$$users{st}{$student}},'active');
1.288 raeburn 8909: $match = 1;
1.275 raeburn 8910: }
8911: }
8912: if (defined($$types{'previous'})) {
1.609 raeburn 8913: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 8914: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 8915: $match = 1;
1.275 raeburn 8916: }
8917: }
8918: if (defined($$types{'future'})) {
1.609 raeburn 8919: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 8920: push(@{$$users{st}{$student}},'future');
1.288 raeburn 8921: $match = 1;
1.275 raeburn 8922: }
8923: }
1.609 raeburn 8924: if ($match) {
8925: push(@{$seclists{$student}},$section);
8926: if (ref($userdata) eq 'HASH') {
8927: $$userdata{$student} = $$classlist{$student};
8928: }
8929: if (ref($statushash) eq 'HASH') {
8930: $statushash->{$student}{'st'}{$section} = $status;
8931: }
1.288 raeburn 8932: }
1.275 raeburn 8933: }
8934: }
1.412 raeburn 8935: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 8936: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8937: my $now = time;
1.609 raeburn 8938: my %displaystatus = ( previous => 'Expired',
8939: active => 'Active',
8940: future => 'Future',
8941: );
1.1121 raeburn 8942: my (%nothide,@possdoms);
1.630 raeburn 8943: if ($hidepriv) {
8944: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
8945: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
8946: if ($user !~ /:/) {
8947: $nothide{join(':',split(/[\@]/,$user))}=1;
8948: } else {
8949: $nothide{$user} = 1;
8950: }
8951: }
1.1121 raeburn 8952: my @possdoms = ($cdom);
8953: if ($coursehash{'checkforpriv'}) {
8954: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
8955: }
1.630 raeburn 8956: }
1.439 raeburn 8957: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 8958: my $match = 0;
1.412 raeburn 8959: my $secmatch = 0;
1.439 raeburn 8960: my $status;
1.412 raeburn 8961: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 8962: $user =~ s/:$//;
1.439 raeburn 8963: my ($end,$start) = split(/:/,$coursepersonnel{$person});
8964: if ($end == -1 || $start == -1) {
8965: next;
8966: }
8967: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
8968: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 8969: my ($uname,$udom) = split(/:/,$user);
8970: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 8971: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 8972: $secmatch = 1;
8973: } elsif ($usec eq '') {
1.420 albertel 8974: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 8975: $secmatch = 1;
8976: }
8977: } else {
8978: if (grep(/^\Q$usec\E$/,@{$sections})) {
8979: $secmatch = 1;
8980: }
8981: }
8982: if (!$secmatch) {
8983: next;
8984: }
1.288 raeburn 8985: }
1.419 raeburn 8986: if ($usec eq '') {
8987: $usec = 'none';
8988: }
1.275 raeburn 8989: if ($uname ne '' && $udom ne '') {
1.630 raeburn 8990: if ($hidepriv) {
1.1121 raeburn 8991: if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630 raeburn 8992: (!$nothide{$uname.':'.$udom})) {
8993: next;
8994: }
8995: }
1.503 raeburn 8996: if ($end > 0 && $end < $now) {
1.439 raeburn 8997: $status = 'previous';
8998: } elsif ($start > $now) {
8999: $status = 'future';
9000: } else {
9001: $status = 'active';
9002: }
1.277 albertel 9003: foreach my $type (keys(%{$types})) {
1.275 raeburn 9004: if ($status eq $type) {
1.420 albertel 9005: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 9006: push(@{$$users{$role}{$user}},$type);
9007: }
1.288 raeburn 9008: $match = 1;
9009: }
9010: }
1.419 raeburn 9011: if (($match) && (ref($userdata) eq 'HASH')) {
9012: if (!exists($$userdata{$uname.':'.$udom})) {
9013: &get_user_info($udom,$uname,\%idx,$userdata);
9014: }
1.420 albertel 9015: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 9016: push(@{$seclists{$uname.':'.$udom}},$usec);
9017: }
1.609 raeburn 9018: if (ref($statushash) eq 'HASH') {
9019: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
9020: }
1.275 raeburn 9021: }
9022: }
9023: }
9024: }
1.290 albertel 9025: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 9026: if ((defined($cdom)) && (defined($cnum))) {
9027: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
9028: if ( defined($csettings{'internal.courseowner'}) ) {
9029: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 9030: next if ($owner eq '');
9031: my ($ownername,$ownerdom);
9032: if ($owner =~ /^([^:]+):([^:]+)$/) {
9033: $ownername = $1;
9034: $ownerdom = $2;
9035: } else {
9036: $ownername = $owner;
9037: $ownerdom = $cdom;
9038: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 9039: }
9040: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 9041: if (defined($userdata) &&
1.609 raeburn 9042: !exists($$userdata{$owner})) {
9043: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
9044: if (!grep(/^none$/,@{$seclists{$owner}})) {
9045: push(@{$seclists{$owner}},'none');
9046: }
9047: if (ref($statushash) eq 'HASH') {
9048: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 9049: }
1.290 albertel 9050: }
1.279 raeburn 9051: }
9052: }
9053: }
1.419 raeburn 9054: foreach my $user (keys(%seclists)) {
9055: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
9056: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
9057: }
1.275 raeburn 9058: }
9059: return;
9060: }
9061:
1.288 raeburn 9062: sub get_user_info {
9063: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 9064: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
9065: &plainname($uname,$udom,'lastname');
1.291 albertel 9066: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 9067: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 9068: my %idhash = &Apache::lonnet::idrget($udom,($uname));
9069: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 9070: return;
9071: }
1.275 raeburn 9072:
1.472 raeburn 9073: ###############################################
9074:
9075: =pod
9076:
9077: =item * &get_user_quota()
9078:
1.1134 raeburn 9079: Retrieves quota assigned for storage of user files.
9080: Default is to report quota for portfolio files.
1.472 raeburn 9081:
9082: Incoming parameters:
9083: 1. user's username
9084: 2. user's domain
1.1134 raeburn 9085: 3. quota name - portfolio, author, or course
1.1136 raeburn 9086: (if no quota name provided, defaults to portfolio).
1.1165 raeburn 9087: 4. crstype - official, unofficial, textbook or community, if quota name is
1.1136 raeburn 9088: course
1.472 raeburn 9089:
9090: Returns:
1.1163 raeburn 9091: 1. Disk quota (in MB) assigned to student.
1.536 raeburn 9092: 2. (Optional) Type of setting: custom or default
9093: (individually assigned or default for user's
9094: institutional status).
9095: 3. (Optional) - User's institutional status (e.g., faculty, staff
9096: or student - types as defined in localenroll::inst_usertypes
9097: for user's domain, which determines default quota for user.
9098: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 9099:
9100: If a value has been stored in the user's environment,
1.536 raeburn 9101: it will return that, otherwise it returns the maximal default
1.1134 raeburn 9102: defined for the user's institutional status(es) in the domain.
1.472 raeburn 9103:
9104: =cut
9105:
9106: ###############################################
9107:
9108:
9109: sub get_user_quota {
1.1136 raeburn 9110: my ($uname,$udom,$quotaname,$crstype) = @_;
1.536 raeburn 9111: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 9112: if (!defined($udom)) {
9113: $udom = $env{'user.domain'};
9114: }
9115: if (!defined($uname)) {
9116: $uname = $env{'user.name'};
9117: }
9118: if (($udom eq '' || $uname eq '') ||
9119: ($udom eq 'public') && ($uname eq 'public')) {
9120: $quota = 0;
1.536 raeburn 9121: $quotatype = 'default';
9122: $defquota = 0;
1.472 raeburn 9123: } else {
1.536 raeburn 9124: my $inststatus;
1.1134 raeburn 9125: if ($quotaname eq 'course') {
9126: if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
9127: ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
9128: $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
9129: } else {
9130: my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
9131: $quota = $cenv{'internal.uploadquota'};
9132: }
1.536 raeburn 9133: } else {
1.1134 raeburn 9134: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
9135: if ($quotaname eq 'author') {
9136: $quota = $env{'environment.authorquota'};
9137: } else {
9138: $quota = $env{'environment.portfolioquota'};
9139: }
9140: $inststatus = $env{'environment.inststatus'};
9141: } else {
9142: my %userenv =
9143: &Apache::lonnet::get('environment',['portfolioquota',
9144: 'authorquota','inststatus'],$udom,$uname);
9145: my ($tmp) = keys(%userenv);
9146: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
9147: if ($quotaname eq 'author') {
9148: $quota = $userenv{'authorquota'};
9149: } else {
9150: $quota = $userenv{'portfolioquota'};
9151: }
9152: $inststatus = $userenv{'inststatus'};
9153: } else {
9154: undef(%userenv);
9155: }
9156: }
9157: }
9158: if ($quota eq '' || wantarray) {
9159: if ($quotaname eq 'course') {
9160: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1165 raeburn 9161: if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
9162: ($crstype eq 'community') || ($crstype eq 'textbook')) {
1.1136 raeburn 9163: $defquota = $domdefs{$crstype.'quota'};
9164: }
9165: if ($defquota eq '') {
9166: $defquota = 500;
9167: }
1.1134 raeburn 9168: } else {
9169: ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
9170: }
9171: if ($quota eq '') {
9172: $quota = $defquota;
9173: $quotatype = 'default';
9174: } else {
9175: $quotatype = 'custom';
9176: }
1.472 raeburn 9177: }
9178: }
1.536 raeburn 9179: if (wantarray) {
9180: return ($quota,$quotatype,$settingstatus,$defquota);
9181: } else {
9182: return $quota;
9183: }
1.472 raeburn 9184: }
9185:
9186: ###############################################
9187:
9188: =pod
9189:
9190: =item * &default_quota()
9191:
1.536 raeburn 9192: Retrieves default quota assigned for storage of user portfolio files,
9193: given an (optional) user's institutional status.
1.472 raeburn 9194:
9195: Incoming parameters:
1.1142 raeburn 9196:
1.472 raeburn 9197: 1. domain
1.536 raeburn 9198: 2. (Optional) institutional status(es). This is a : separated list of
9199: status types (e.g., faculty, staff, student etc.)
9200: which apply to the user for whom the default is being retrieved.
9201: If the institutional status string in undefined, the domain
1.1134 raeburn 9202: default quota will be returned.
9203: 3. quota name - portfolio, author, or course
9204: (if no quota name provided, defaults to portfolio).
1.472 raeburn 9205:
9206: Returns:
1.1142 raeburn 9207:
1.1163 raeburn 9208: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536 raeburn 9209: 2. (Optional) institutional type which determined the value of the
9210: default quota.
1.472 raeburn 9211:
9212: If a value has been stored in the domain's configuration db,
9213: it will return that, otherwise it returns 20 (for backwards
9214: compatibility with domains which have not set up a configuration
1.1163 raeburn 9215: db file; the original statically defined portfolio quota was 20 MB).
1.472 raeburn 9216:
1.536 raeburn 9217: If the user's status includes multiple types (e.g., staff and student),
9218: the largest default quota which applies to the user determines the
9219: default quota returned.
9220:
1.472 raeburn 9221: =cut
9222:
9223: ###############################################
9224:
9225:
9226: sub default_quota {
1.1134 raeburn 9227: my ($udom,$inststatus,$quotaname) = @_;
1.536 raeburn 9228: my ($defquota,$settingstatus);
9229: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 9230: ['quotas'],$udom);
1.1134 raeburn 9231: my $key = 'defaultquota';
9232: if ($quotaname eq 'author') {
9233: $key = 'authorquota';
9234: }
1.622 raeburn 9235: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 9236: if ($inststatus ne '') {
1.765 raeburn 9237: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 9238: foreach my $item (@statuses) {
1.1134 raeburn 9239: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
9240: if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711 raeburn 9241: if ($defquota eq '') {
1.1134 raeburn 9242: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 9243: $settingstatus = $item;
1.1134 raeburn 9244: } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
9245: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 9246: $settingstatus = $item;
9247: }
9248: }
1.1134 raeburn 9249: } elsif ($key eq 'defaultquota') {
1.711 raeburn 9250: if ($quotahash{'quotas'}{$item} ne '') {
9251: if ($defquota eq '') {
9252: $defquota = $quotahash{'quotas'}{$item};
9253: $settingstatus = $item;
9254: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
9255: $defquota = $quotahash{'quotas'}{$item};
9256: $settingstatus = $item;
9257: }
1.536 raeburn 9258: }
9259: }
9260: }
9261: }
9262: if ($defquota eq '') {
1.1134 raeburn 9263: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
9264: $defquota = $quotahash{'quotas'}{$key}{'default'};
9265: } elsif ($key eq 'defaultquota') {
1.711 raeburn 9266: $defquota = $quotahash{'quotas'}{'default'};
9267: }
1.536 raeburn 9268: $settingstatus = 'default';
1.1139 raeburn 9269: if ($defquota eq '') {
9270: if ($quotaname eq 'author') {
9271: $defquota = 500;
9272: }
9273: }
1.536 raeburn 9274: }
9275: } else {
9276: $settingstatus = 'default';
1.1134 raeburn 9277: if ($quotaname eq 'author') {
9278: $defquota = 500;
9279: } else {
9280: $defquota = 20;
9281: }
1.536 raeburn 9282: }
9283: if (wantarray) {
9284: return ($defquota,$settingstatus);
1.472 raeburn 9285: } else {
1.536 raeburn 9286: return $defquota;
1.472 raeburn 9287: }
9288: }
9289:
1.1135 raeburn 9290: ###############################################
9291:
9292: =pod
9293:
1.1136 raeburn 9294: =item * &excess_filesize_warning()
1.1135 raeburn 9295:
9296: Returns warning message if upload of file to authoring space, or copying
1.1136 raeburn 9297: of existing file within authoring space will cause quota for the authoring
1.1146 raeburn 9298: space to be exceeded.
1.1136 raeburn 9299:
9300: Same, if upload of a file directly to a course/community via Course Editor
1.1137 raeburn 9301: will cause quota for uploaded content for the course to be exceeded.
1.1135 raeburn 9302:
1.1165 raeburn 9303: Inputs: 7
1.1136 raeburn 9304: 1. username or coursenum
1.1135 raeburn 9305: 2. domain
1.1136 raeburn 9306: 3. context ('author' or 'course')
1.1135 raeburn 9307: 4. filename of file for which action is being requested
9308: 5. filesize (kB) of file
9309: 6. action being taken: copy or upload.
1.1165 raeburn 9310: 7. quotatype (in course context -- official, unofficial, community or textbook).
1.1135 raeburn 9311:
9312: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
1.1142 raeburn 9313: otherwise return null.
9314:
9315: =back
1.1135 raeburn 9316:
9317: =cut
9318:
1.1136 raeburn 9319: sub excess_filesize_warning {
1.1165 raeburn 9320: my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1136 raeburn 9321: my $current_disk_usage = 0;
1.1165 raeburn 9322: my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1136 raeburn 9323: if ($context eq 'author') {
9324: my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
9325: $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
9326: } else {
9327: foreach my $subdir ('docs','supplemental') {
9328: $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
9329: }
9330: }
1.1135 raeburn 9331: $disk_quota = int($disk_quota * 1000);
9332: if (($current_disk_usage + $filesize) > $disk_quota) {
1.1179 bisitz 9333: return '<p class="LC_warning">'.
1.1135 raeburn 9334: &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1179 bisitz 9335: '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
9336: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1135 raeburn 9337: $disk_quota,$current_disk_usage).
9338: '</p>';
9339: }
9340: return;
9341: }
9342:
9343: ###############################################
9344:
9345:
1.1136 raeburn 9346:
9347:
1.384 raeburn 9348: sub get_secgrprole_info {
9349: my ($cdom,$cnum,$needroles,$type) = @_;
9350: my %sections_count = &get_sections($cdom,$cnum);
9351: my @sections = (sort {$a <=> $b} keys(%sections_count));
9352: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
9353: my @groups = sort(keys(%curr_groups));
9354: my $allroles = [];
9355: my $rolehash;
9356: my $accesshash = {
9357: active => 'Currently has access',
9358: future => 'Will have future access',
9359: previous => 'Previously had access',
9360: };
9361: if ($needroles) {
9362: $rolehash = {'all' => 'all'};
1.385 albertel 9363: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
9364: if (&Apache::lonnet::error(%user_roles)) {
9365: undef(%user_roles);
9366: }
9367: foreach my $item (keys(%user_roles)) {
1.384 raeburn 9368: my ($role)=split(/\:/,$item,2);
9369: if ($role eq 'cr') { next; }
9370: if ($role =~ /^cr/) {
9371: $$rolehash{$role} = (split('/',$role))[3];
9372: } else {
9373: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
9374: }
9375: }
9376: foreach my $key (sort(keys(%{$rolehash}))) {
9377: push(@{$allroles},$key);
9378: }
9379: push (@{$allroles},'st');
9380: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
9381: }
9382: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
9383: }
9384:
1.555 raeburn 9385: sub user_picker {
1.994 raeburn 9386: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context) = @_;
1.555 raeburn 9387: my $currdom = $dom;
9388: my %curr_selected = (
9389: srchin => 'dom',
1.580 raeburn 9390: srchby => 'lastname',
1.555 raeburn 9391: );
9392: my $srchterm;
1.625 raeburn 9393: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 9394: if ($srch->{'srchby'} ne '') {
9395: $curr_selected{'srchby'} = $srch->{'srchby'};
9396: }
9397: if ($srch->{'srchin'} ne '') {
9398: $curr_selected{'srchin'} = $srch->{'srchin'};
9399: }
9400: if ($srch->{'srchtype'} ne '') {
9401: $curr_selected{'srchtype'} = $srch->{'srchtype'};
9402: }
9403: if ($srch->{'srchdomain'} ne '') {
9404: $currdom = $srch->{'srchdomain'};
9405: }
9406: $srchterm = $srch->{'srchterm'};
9407: }
9408: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 9409: 'usr' => 'Search criteria',
1.563 raeburn 9410: 'doma' => 'Domain/institution to search',
1.558 albertel 9411: 'uname' => 'username',
9412: 'lastname' => 'last name',
1.555 raeburn 9413: 'lastfirst' => 'last name, first name',
1.558 albertel 9414: 'crs' => 'in this course',
1.576 raeburn 9415: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 9416: 'alc' => 'all LON-CAPA',
1.573 raeburn 9417: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 9418: 'exact' => 'is',
9419: 'contains' => 'contains',
1.569 raeburn 9420: 'begins' => 'begins with',
1.571 raeburn 9421: 'youm' => "You must include some text to search for.",
9422: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
9423: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
9424: 'yomc' => "You must choose a domain when using an institutional directory search.",
9425: 'ymcd' => "You must choose a domain when using a domain search.",
9426: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
9427: 'whse' => "When searching by last,first you must include at least one character in the first name.",
9428: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 9429: );
1.563 raeburn 9430: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
9431: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 9432:
9433: my @srchins = ('crs','dom','alc','instd');
9434:
9435: foreach my $option (@srchins) {
9436: # FIXME 'alc' option unavailable until
9437: # loncreateuser::print_user_query_page()
9438: # has been completed.
9439: next if ($option eq 'alc');
1.880 raeburn 9440: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 9441: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 9442: if ($curr_selected{'srchin'} eq $option) {
9443: $srchinsel .= '
9444: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
9445: } else {
9446: $srchinsel .= '
9447: <option value="'.$option.'">'.$lt{$option}.'</option>';
9448: }
1.555 raeburn 9449: }
1.563 raeburn 9450: $srchinsel .= "\n </select>\n";
1.555 raeburn 9451:
9452: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 9453: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 9454: if ($curr_selected{'srchby'} eq $option) {
9455: $srchbysel .= '
9456: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
9457: } else {
9458: $srchbysel .= '
9459: <option value="'.$option.'">'.$lt{$option}.'</option>';
9460: }
9461: }
9462: $srchbysel .= "\n </select>\n";
9463:
9464: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 9465: foreach my $option ('begins','contains','exact') {
1.555 raeburn 9466: if ($curr_selected{'srchtype'} eq $option) {
9467: $srchtypesel .= '
9468: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
9469: } else {
9470: $srchtypesel .= '
9471: <option value="'.$option.'">'.$lt{$option}.'</option>';
9472: }
9473: }
9474: $srchtypesel .= "\n </select>\n";
9475:
1.558 albertel 9476: my ($newuserscript,$new_user_create);
1.994 raeburn 9477: my $context_dom = $env{'request.role.domain'};
9478: if ($context eq 'requestcrs') {
9479: if ($env{'form.coursedom'} ne '') {
9480: $context_dom = $env{'form.coursedom'};
9481: }
9482: }
1.556 raeburn 9483: if ($forcenewuser) {
1.576 raeburn 9484: if (ref($srch) eq 'HASH') {
1.994 raeburn 9485: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 9486: if ($cancreate) {
9487: $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>';
9488: } else {
1.799 bisitz 9489: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 9490: my %usertypetext = (
9491: official => 'institutional',
9492: unofficial => 'non-institutional',
9493: );
1.799 bisitz 9494: $new_user_create = '<p class="LC_warning">'
9495: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
9496: .' '
9497: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
9498: ,'<a href="'.$helplink.'">','</a>')
9499: .'</p><br />';
1.627 raeburn 9500: }
1.576 raeburn 9501: }
9502: }
9503:
1.556 raeburn 9504: $newuserscript = <<"ENDSCRIPT";
9505:
1.570 raeburn 9506: function setSearch(createnew,callingForm) {
1.556 raeburn 9507: if (createnew == 1) {
1.570 raeburn 9508: for (var i=0; i<callingForm.srchby.length; i++) {
9509: if (callingForm.srchby.options[i].value == 'uname') {
9510: callingForm.srchby.selectedIndex = i;
1.556 raeburn 9511: }
9512: }
1.570 raeburn 9513: for (var i=0; i<callingForm.srchin.length; i++) {
9514: if ( callingForm.srchin.options[i].value == 'dom') {
9515: callingForm.srchin.selectedIndex = i;
1.556 raeburn 9516: }
9517: }
1.570 raeburn 9518: for (var i=0; i<callingForm.srchtype.length; i++) {
9519: if (callingForm.srchtype.options[i].value == 'exact') {
9520: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 9521: }
9522: }
1.570 raeburn 9523: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 9524: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 9525: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 9526: }
9527: }
9528: }
9529: }
9530: ENDSCRIPT
1.558 albertel 9531:
1.556 raeburn 9532: }
9533:
1.555 raeburn 9534: my $output = <<"END_BLOCK";
1.556 raeburn 9535: <script type="text/javascript">
1.824 bisitz 9536: // <![CDATA[
1.570 raeburn 9537: function validateEntry(callingForm) {
1.558 albertel 9538:
1.556 raeburn 9539: var checkok = 1;
1.558 albertel 9540: var srchin;
1.570 raeburn 9541: for (var i=0; i<callingForm.srchin.length; i++) {
9542: if ( callingForm.srchin[i].checked ) {
9543: srchin = callingForm.srchin[i].value;
1.558 albertel 9544: }
9545: }
9546:
1.570 raeburn 9547: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
9548: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
9549: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
9550: var srchterm = callingForm.srchterm.value;
9551: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 9552: var msg = "";
9553:
9554: if (srchterm == "") {
9555: checkok = 0;
1.571 raeburn 9556: msg += "$lt{'youm'}\\n";
1.556 raeburn 9557: }
9558:
1.569 raeburn 9559: if (srchtype== 'begins') {
9560: if (srchterm.length < 2) {
9561: checkok = 0;
1.571 raeburn 9562: msg += "$lt{'thte'}\\n";
1.569 raeburn 9563: }
9564: }
9565:
1.556 raeburn 9566: if (srchtype== 'contains') {
9567: if (srchterm.length < 3) {
9568: checkok = 0;
1.571 raeburn 9569: msg += "$lt{'thet'}\\n";
1.556 raeburn 9570: }
9571: }
9572: if (srchin == 'instd') {
9573: if (srchdomain == '') {
9574: checkok = 0;
1.571 raeburn 9575: msg += "$lt{'yomc'}\\n";
1.556 raeburn 9576: }
9577: }
9578: if (srchin == 'dom') {
9579: if (srchdomain == '') {
9580: checkok = 0;
1.571 raeburn 9581: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 9582: }
9583: }
9584: if (srchby == 'lastfirst') {
9585: if (srchterm.indexOf(",") == -1) {
9586: checkok = 0;
1.571 raeburn 9587: msg += "$lt{'whus'}\\n";
1.556 raeburn 9588: }
9589: if (srchterm.indexOf(",") == srchterm.length -1) {
9590: checkok = 0;
1.571 raeburn 9591: msg += "$lt{'whse'}\\n";
1.556 raeburn 9592: }
9593: }
9594: if (checkok == 0) {
1.571 raeburn 9595: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 9596: return;
9597: }
9598: if (checkok == 1) {
1.570 raeburn 9599: callingForm.submit();
1.556 raeburn 9600: }
9601: }
9602:
9603: $newuserscript
9604:
1.824 bisitz 9605: // ]]>
1.556 raeburn 9606: </script>
1.558 albertel 9607:
9608: $new_user_create
9609:
1.555 raeburn 9610: END_BLOCK
1.558 albertel 9611:
1.876 raeburn 9612: $output .= &Apache::lonhtmlcommon::start_pick_box().
9613: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
9614: $domform.
9615: &Apache::lonhtmlcommon::row_closure().
9616: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
9617: $srchbysel.
9618: $srchtypesel.
9619: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
9620: $srchinsel.
9621: &Apache::lonhtmlcommon::row_closure(1).
9622: &Apache::lonhtmlcommon::end_pick_box().
9623: '<br />';
1.555 raeburn 9624: return $output;
9625: }
9626:
1.612 raeburn 9627: sub user_rule_check {
1.615 raeburn 9628: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 9629: my $response;
9630: if (ref($usershash) eq 'HASH') {
9631: foreach my $user (keys(%{$usershash})) {
9632: my ($uname,$udom) = split(/:/,$user);
9633: next if ($udom eq '' || $uname eq '');
1.615 raeburn 9634: my ($id,$newuser);
1.612 raeburn 9635: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 9636: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 9637: $id = $usershash->{$user}->{'id'};
9638: }
9639: my $inst_response;
9640: if (ref($checks) eq 'HASH') {
9641: if (defined($checks->{'username'})) {
1.615 raeburn 9642: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 9643: &Apache::lonnet::get_instuser($udom,$uname);
9644: } elsif (defined($checks->{'id'})) {
1.615 raeburn 9645: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 9646: &Apache::lonnet::get_instuser($udom,undef,$id);
9647: }
1.615 raeburn 9648: } else {
9649: ($inst_response,%{$inst_results->{$user}}) =
9650: &Apache::lonnet::get_instuser($udom,$uname);
9651: return;
1.612 raeburn 9652: }
1.615 raeburn 9653: if (!$got_rules->{$udom}) {
1.612 raeburn 9654: my %domconfig = &Apache::lonnet::get_dom('configuration',
9655: ['usercreation'],$udom);
9656: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 9657: foreach my $item ('username','id') {
1.612 raeburn 9658: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
9659: $$curr_rules{$udom}{$item} =
9660: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 9661: }
9662: }
9663: }
1.615 raeburn 9664: $got_rules->{$udom} = 1;
1.585 raeburn 9665: }
1.612 raeburn 9666: foreach my $item (keys(%{$checks})) {
9667: if (ref($$curr_rules{$udom}) eq 'HASH') {
9668: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
9669: if (@{$$curr_rules{$udom}{$item}} > 0) {
9670: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
9671: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
9672: if ($rule_check{$rule}) {
9673: $$rulematch{$user}{$item} = $rule;
9674: if ($inst_response eq 'ok') {
1.615 raeburn 9675: if (ref($inst_results) eq 'HASH') {
9676: if (ref($inst_results->{$user}) eq 'HASH') {
9677: if (keys(%{$inst_results->{$user}}) == 0) {
9678: $$alerts{$item}{$udom}{$uname} = 1;
9679: }
1.612 raeburn 9680: }
9681: }
1.615 raeburn 9682: }
9683: last;
1.585 raeburn 9684: }
9685: }
9686: }
9687: }
9688: }
9689: }
9690: }
9691: }
1.612 raeburn 9692: return;
9693: }
9694:
9695: sub user_rule_formats {
9696: my ($domain,$domdesc,$curr_rules,$check) = @_;
9697: my %text = (
9698: 'username' => 'Usernames',
9699: 'id' => 'IDs',
9700: );
9701: my $output;
9702: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
9703: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
9704: if (@{$ruleorder} > 0) {
1.1102 raeburn 9705: $output = '<br />'.
9706: &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
9707: '<span class="LC_cusr_emph">','</span>',$domdesc).
9708: ' <ul>';
1.612 raeburn 9709: foreach my $rule (@{$ruleorder}) {
9710: if (ref($curr_rules) eq 'ARRAY') {
9711: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
9712: if (ref($rules->{$rule}) eq 'HASH') {
9713: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
9714: $rules->{$rule}{'desc'}.'</li>';
9715: }
9716: }
9717: }
9718: }
9719: $output .= '</ul>';
9720: }
9721: }
9722: return $output;
9723: }
9724:
9725: sub instrule_disallow_msg {
1.615 raeburn 9726: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 9727: my $response;
9728: my %text = (
9729: item => 'username',
9730: items => 'usernames',
9731: match => 'matches',
9732: do => 'does',
9733: action => 'a username',
9734: one => 'one',
9735: );
9736: if ($count > 1) {
9737: $text{'item'} = 'usernames';
9738: $text{'match'} ='match';
9739: $text{'do'} = 'do';
9740: $text{'action'} = 'usernames',
9741: $text{'one'} = 'ones';
9742: }
9743: if ($checkitem eq 'id') {
9744: $text{'items'} = 'IDs';
9745: $text{'item'} = 'ID';
9746: $text{'action'} = 'an ID';
1.615 raeburn 9747: if ($count > 1) {
9748: $text{'item'} = 'IDs';
9749: $text{'action'} = 'IDs';
9750: }
1.612 raeburn 9751: }
1.674 bisitz 9752: $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 9753: if ($mode eq 'upload') {
9754: if ($checkitem eq 'username') {
9755: $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'}.");
9756: } elsif ($checkitem eq 'id') {
1.674 bisitz 9757: $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 9758: }
1.669 raeburn 9759: } elsif ($mode eq 'selfcreate') {
9760: if ($checkitem eq 'id') {
9761: $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.");
9762: }
1.615 raeburn 9763: } else {
9764: if ($checkitem eq 'username') {
9765: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
9766: } elsif ($checkitem eq 'id') {
9767: $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.");
9768: }
1.612 raeburn 9769: }
9770: return $response;
1.585 raeburn 9771: }
9772:
1.624 raeburn 9773: sub personal_data_fieldtitles {
9774: my %fieldtitles = &Apache::lonlocal::texthash (
9775: id => 'Student/Employee ID',
9776: permanentemail => 'E-mail address',
9777: lastname => 'Last Name',
9778: firstname => 'First Name',
9779: middlename => 'Middle Name',
9780: generation => 'Generation',
9781: gen => 'Generation',
1.765 raeburn 9782: inststatus => 'Affiliation',
1.624 raeburn 9783: );
9784: return %fieldtitles;
9785: }
9786:
1.642 raeburn 9787: sub sorted_inst_types {
9788: my ($dom) = @_;
1.1185 raeburn 9789: my ($usertypes,$order);
9790: my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
9791: if (ref($domdefaults{'inststatus'}) eq 'HASH') {
9792: $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
9793: $order = $domdefaults{'inststatus'}{'inststatusorder'};
9794: } else {
9795: ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
9796: }
1.642 raeburn 9797: my $othertitle = &mt('All users');
9798: if ($env{'request.course.id'}) {
1.668 raeburn 9799: $othertitle = &mt('Any users');
1.642 raeburn 9800: }
9801: my @types;
9802: if (ref($order) eq 'ARRAY') {
9803: @types = @{$order};
9804: }
9805: if (@types == 0) {
9806: if (ref($usertypes) eq 'HASH') {
9807: @types = sort(keys(%{$usertypes}));
9808: }
9809: }
9810: if (keys(%{$usertypes}) > 0) {
9811: $othertitle = &mt('Other users');
9812: }
9813: return ($othertitle,$usertypes,\@types);
9814: }
9815:
1.645 raeburn 9816: sub get_institutional_codes {
9817: my ($settings,$allcourses,$LC_code) = @_;
9818: # Get complete list of course sections to update
9819: my @currsections = ();
9820: my @currxlists = ();
9821: my $coursecode = $$settings{'internal.coursecode'};
9822:
9823: if ($$settings{'internal.sectionnums'} ne '') {
9824: @currsections = split(/,/,$$settings{'internal.sectionnums'});
9825: }
9826:
9827: if ($$settings{'internal.crosslistings'} ne '') {
9828: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
9829: }
9830:
9831: if (@currxlists > 0) {
9832: foreach (@currxlists) {
9833: if (m/^([^:]+):(\w*)$/) {
9834: unless (grep/^$1$/,@{$allcourses}) {
9835: push @{$allcourses},$1;
9836: $$LC_code{$1} = $2;
9837: }
9838: }
9839: }
9840: }
9841:
9842: if (@currsections > 0) {
9843: foreach (@currsections) {
9844: if (m/^(\w+):(\w*)$/) {
9845: my $sec = $coursecode.$1;
9846: my $lc_sec = $2;
9847: unless (grep/^$sec$/,@{$allcourses}) {
9848: push @{$allcourses},$sec;
9849: $$LC_code{$sec} = $lc_sec;
9850: }
9851: }
9852: }
9853: }
9854: return;
9855: }
9856:
1.971 raeburn 9857: sub get_standard_codeitems {
9858: return ('Year','Semester','Department','Number','Section');
9859: }
9860:
1.112 bowersj2 9861: =pod
9862:
1.780 raeburn 9863: =head1 Slot Helpers
9864:
9865: =over 4
9866:
9867: =item * sorted_slots()
9868:
1.1040 raeburn 9869: Sorts an array of slot names in order of an optional sort key,
9870: default sort is by slot start time (earliest first).
1.780 raeburn 9871:
9872: Inputs:
9873:
9874: =over 4
9875:
9876: slotsarr - Reference to array of unsorted slot names.
9877:
9878: slots - Reference to hash of hash, where outer hash keys are slot names.
9879:
1.1040 raeburn 9880: sortkey - Name of key in inner hash to be sorted on (e.g., starttime).
9881:
1.549 albertel 9882: =back
9883:
1.780 raeburn 9884: Returns:
9885:
9886: =over 4
9887:
1.1040 raeburn 9888: sorted - An array of slot names sorted by a specified sort key
9889: (default sort key is start time of the slot).
1.780 raeburn 9890:
9891: =back
9892:
9893: =cut
9894:
9895:
9896: sub sorted_slots {
1.1040 raeburn 9897: my ($slotsarr,$slots,$sortkey) = @_;
9898: if ($sortkey eq '') {
9899: $sortkey = 'starttime';
9900: }
1.780 raeburn 9901: my @sorted;
9902: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
9903: @sorted =
9904: sort {
9905: if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040 raeburn 9906: return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780 raeburn 9907: }
9908: if (ref($slots->{$a})) { return -1;}
9909: if (ref($slots->{$b})) { return 1;}
9910: return 0;
9911: } @{$slotsarr};
9912: }
9913: return @sorted;
9914: }
9915:
1.1040 raeburn 9916: =pod
9917:
9918: =item * get_future_slots()
9919:
9920: Inputs:
9921:
9922: =over 4
9923:
9924: cnum - course number
9925:
9926: cdom - course domain
9927:
9928: now - current UNIX time
9929:
9930: symb - optional symb
9931:
9932: =back
9933:
9934: Returns:
9935:
9936: =over 4
9937:
9938: sorted_reservable - ref to array of student_schedulable slots currently
9939: reservable, ordered by end date of reservation period.
9940:
9941: reservable_now - ref to hash of student_schedulable slots currently
9942: reservable.
9943:
9944: Keys in inner hash are:
9945: (a) symb: either blank or symb to which slot use is restricted.
9946: (b) endreserve: end date of reservation period.
9947:
9948: sorted_future - ref to array of student_schedulable slots reservable in
9949: the future, ordered by start date of reservation period.
9950:
9951: future_reservable - ref to hash of student_schedulable slots reservable
9952: in the future.
9953:
9954: Keys in inner hash are:
9955: (a) symb: either blank or symb to which slot use is restricted.
9956: (b) startreserve: start date of reservation period.
9957:
9958: =back
9959:
9960: =cut
9961:
9962: sub get_future_slots {
9963: my ($cnum,$cdom,$now,$symb) = @_;
9964: my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
9965: my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
9966: foreach my $slot (keys(%slots)) {
9967: next unless($slots{$slot}->{'type'} eq 'schedulable_student');
9968: if ($symb) {
9969: next if (($slots{$slot}->{'symb'} ne '') &&
9970: ($slots{$slot}->{'symb'} ne $symb));
9971: }
9972: if (($slots{$slot}->{'starttime'} > $now) &&
9973: ($slots{$slot}->{'endtime'} > $now)) {
9974: if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
9975: my $userallowed = 0;
9976: if ($slots{$slot}->{'allowedsections'}) {
9977: my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
9978: if (!defined($env{'request.role.sec'})
9979: && grep(/^No section assigned$/,@allowed_sec)) {
9980: $userallowed=1;
9981: } else {
9982: if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
9983: $userallowed=1;
9984: }
9985: }
9986: unless ($userallowed) {
9987: if (defined($env{'request.course.groups'})) {
9988: my @groups = split(/:/,$env{'request.course.groups'});
9989: foreach my $group (@groups) {
9990: if (grep(/^\Q$group\E$/,@allowed_sec)) {
9991: $userallowed=1;
9992: last;
9993: }
9994: }
9995: }
9996: }
9997: }
9998: if ($slots{$slot}->{'allowedusers'}) {
9999: my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
10000: my $user = $env{'user.name'}.':'.$env{'user.domain'};
10001: if (grep(/^\Q$user\E$/,@allowed_users)) {
10002: $userallowed = 1;
10003: }
10004: }
10005: next unless($userallowed);
10006: }
10007: my $startreserve = $slots{$slot}->{'startreserve'};
10008: my $endreserve = $slots{$slot}->{'endreserve'};
10009: my $symb = $slots{$slot}->{'symb'};
10010: if (($startreserve < $now) &&
10011: (!$endreserve || $endreserve > $now)) {
10012: my $lastres = $endreserve;
10013: if (!$lastres) {
10014: $lastres = $slots{$slot}->{'starttime'};
10015: }
10016: $reservable_now{$slot} = {
10017: symb => $symb,
10018: endreserve => $lastres
10019: };
10020: } elsif (($startreserve > $now) &&
10021: (!$endreserve || $endreserve > $startreserve)) {
10022: $future_reservable{$slot} = {
10023: symb => $symb,
10024: startreserve => $startreserve
10025: };
10026: }
10027: }
10028: }
10029: my @unsorted_reservable = keys(%reservable_now);
10030: if (@unsorted_reservable > 0) {
10031: @sorted_reservable =
10032: &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
10033: }
10034: my @unsorted_future = keys(%future_reservable);
10035: if (@unsorted_future > 0) {
10036: @sorted_future =
10037: &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
10038: }
10039: return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
10040: }
1.780 raeburn 10041:
10042: =pod
10043:
1.1057 foxr 10044: =back
10045:
1.549 albertel 10046: =head1 HTTP Helpers
10047:
10048: =over 4
10049:
1.648 raeburn 10050: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 10051:
1.258 albertel 10052: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 10053: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 10054: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 10055:
10056: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
10057: $possible_names is an ref to an array of form element names. As an example:
10058: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 10059: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 10060:
10061: =cut
1.1 albertel 10062:
1.6 albertel 10063: sub get_unprocessed_cgi {
1.25 albertel 10064: my ($query,$possible_names)= @_;
1.26 matthew 10065: # $Apache::lonxml::debug=1;
1.356 albertel 10066: foreach my $pair (split(/&/,$query)) {
10067: my ($name, $value) = split(/=/,$pair);
1.369 www 10068: $name = &unescape($name);
1.25 albertel 10069: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
10070: $value =~ tr/+/ /;
10071: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 10072: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 10073: }
1.16 harris41 10074: }
1.6 albertel 10075: }
10076:
1.112 bowersj2 10077: =pod
10078:
1.648 raeburn 10079: =item * &cacheheader()
1.112 bowersj2 10080:
10081: returns cache-controlling header code
10082:
10083: =cut
10084:
1.7 albertel 10085: sub cacheheader {
1.258 albertel 10086: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 10087: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
10088: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 10089: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
10090: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 10091: return $output;
1.7 albertel 10092: }
10093:
1.112 bowersj2 10094: =pod
10095:
1.648 raeburn 10096: =item * &no_cache($r)
1.112 bowersj2 10097:
10098: specifies header code to not have cache
10099:
10100: =cut
10101:
1.9 albertel 10102: sub no_cache {
1.216 albertel 10103: my ($r) = @_;
10104: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 10105: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 10106: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
10107: $r->no_cache(1);
10108: $r->header_out("Expires" => $date);
10109: $r->header_out("Pragma" => "no-cache");
1.123 www 10110: }
10111:
10112: sub content_type {
1.181 albertel 10113: my ($r,$type,$charset) = @_;
1.299 foxr 10114: if ($r) {
10115: # Note that printout.pl calls this with undef for $r.
10116: &no_cache($r);
10117: }
1.258 albertel 10118: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 10119: unless ($charset) {
10120: $charset=&Apache::lonlocal::current_encoding;
10121: }
10122: if ($charset) { $type.='; charset='.$charset; }
10123: if ($r) {
10124: $r->content_type($type);
10125: } else {
10126: print("Content-type: $type\n\n");
10127: }
1.9 albertel 10128: }
1.25 albertel 10129:
1.112 bowersj2 10130: =pod
10131:
1.648 raeburn 10132: =item * &add_to_env($name,$value)
1.112 bowersj2 10133:
1.258 albertel 10134: adds $name to the %env hash with value
1.112 bowersj2 10135: $value, if $name already exists, the entry is converted to an array
10136: reference and $value is added to the array.
10137:
10138: =cut
10139:
1.25 albertel 10140: sub add_to_env {
10141: my ($name,$value)=@_;
1.258 albertel 10142: if (defined($env{$name})) {
10143: if (ref($env{$name})) {
1.25 albertel 10144: #already have multiple values
1.258 albertel 10145: push(@{ $env{$name} },$value);
1.25 albertel 10146: } else {
10147: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 10148: my $first=$env{$name};
10149: undef($env{$name});
10150: push(@{ $env{$name} },$first,$value);
1.25 albertel 10151: }
10152: } else {
1.258 albertel 10153: $env{$name}=$value;
1.25 albertel 10154: }
1.31 albertel 10155: }
1.149 albertel 10156:
10157: =pod
10158:
1.648 raeburn 10159: =item * &get_env_multiple($name)
1.149 albertel 10160:
1.258 albertel 10161: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 10162: values may be defined and end up as an array ref.
10163:
10164: returns an array of values
10165:
10166: =cut
10167:
10168: sub get_env_multiple {
10169: my ($name) = @_;
10170: my @values;
1.258 albertel 10171: if (defined($env{$name})) {
1.149 albertel 10172: # exists is it an array
1.258 albertel 10173: if (ref($env{$name})) {
10174: @values=@{ $env{$name} };
1.149 albertel 10175: } else {
1.258 albertel 10176: $values[0]=$env{$name};
1.149 albertel 10177: }
10178: }
10179: return(@values);
10180: }
10181:
1.660 raeburn 10182: sub ask_for_embedded_content {
10183: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071 raeburn 10184: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1085 raeburn 10185: %currsubfile,%unused,$rem);
1.1071 raeburn 10186: my $counter = 0;
10187: my $numnew = 0;
1.987 raeburn 10188: my $numremref = 0;
10189: my $numinvalid = 0;
10190: my $numpathchg = 0;
10191: my $numexisting = 0;
1.1071 raeburn 10192: my $numunused = 0;
10193: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1156 raeburn 10194: $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071 raeburn 10195: my $heading = &mt('Upload embedded files');
10196: my $buttontext = &mt('Upload');
10197:
1.1085 raeburn 10198: if ($env{'request.course.id'}) {
1.1123 raeburn 10199: if ($actionurl eq '/adm/dependencies') {
10200: $navmap = Apache::lonnavmaps::navmap->new();
10201: }
10202: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10203: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1085 raeburn 10204: }
1.1123 raeburn 10205: if (($actionurl eq '/adm/portfolio') ||
10206: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984 raeburn 10207: my $current_path='/';
10208: if ($env{'form.currentpath'}) {
10209: $current_path = $env{'form.currentpath'};
10210: }
10211: if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1123 raeburn 10212: $udom = $cdom;
10213: $uname = $cnum;
1.984 raeburn 10214: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
10215: } else {
10216: $udom = $env{'user.domain'};
10217: $uname = $env{'user.name'};
10218: $url = '/userfiles/portfolio';
10219: }
1.987 raeburn 10220: $toplevel = $url.'/';
1.984 raeburn 10221: $url .= $current_path;
10222: $getpropath = 1;
1.987 raeburn 10223: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
10224: ($actionurl eq '/adm/imsimport')) {
1.1022 www 10225: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026 raeburn 10226: $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987 raeburn 10227: $toplevel = $url;
1.984 raeburn 10228: if ($rest ne '') {
1.987 raeburn 10229: $url .= $rest;
10230: }
10231: } elsif ($actionurl eq '/adm/coursedocs') {
10232: if (ref($args) eq 'HASH') {
1.1071 raeburn 10233: $url = $args->{'docs_url'};
10234: $toplevel = $url;
1.1084 raeburn 10235: if ($args->{'context'} eq 'paste') {
10236: ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
10237: ($path) =
10238: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
10239: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
10240: $fileloc =~ s{^/}{};
10241: }
1.1071 raeburn 10242: }
1.1084 raeburn 10243: } elsif ($actionurl eq '/adm/dependencies') {
1.1071 raeburn 10244: if ($env{'request.course.id'} ne '') {
10245: if (ref($args) eq 'HASH') {
10246: $url = $args->{'docs_url'};
10247: $title = $args->{'docs_title'};
1.1126 raeburn 10248: $toplevel = $url;
10249: unless ($toplevel =~ m{^/}) {
10250: $toplevel = "/$url";
10251: }
1.1085 raeburn 10252: ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1126 raeburn 10253: if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
10254: $path = $1;
10255: } else {
10256: ($path) =
10257: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
10258: }
1.1195 raeburn 10259: if ($toplevel=~/^\/*(uploaded|editupload)/) {
10260: $fileloc = $toplevel;
10261: $fileloc=~ s/^\s*(\S+)\s*$/$1/;
10262: my ($udom,$uname,$fname) =
10263: ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
10264: $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
10265: } else {
10266: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
10267: }
1.1071 raeburn 10268: $fileloc =~ s{^/}{};
10269: ($filename) = ($fileloc =~ m{.+/([^/]+)$});
10270: $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
10271: }
1.987 raeburn 10272: }
1.1123 raeburn 10273: } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
10274: $udom = $cdom;
10275: $uname = $cnum;
10276: $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
10277: $toplevel = $url;
10278: $path = $url;
10279: $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
10280: $fileloc =~ s{^/}{};
1.987 raeburn 10281: }
1.1126 raeburn 10282: foreach my $file (keys(%{$allfiles})) {
10283: my $embed_file;
10284: if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
10285: $embed_file = $1;
10286: } else {
10287: $embed_file = $file;
10288: }
1.1158 raeburn 10289: my ($absolutepath,$cleaned_file);
10290: if ($embed_file =~ m{^\w+://}) {
10291: $cleaned_file = $embed_file;
1.1147 raeburn 10292: $newfiles{$cleaned_file} = 1;
10293: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 10294: } else {
1.1158 raeburn 10295: $cleaned_file = &clean_path($embed_file);
1.987 raeburn 10296: if ($embed_file =~ m{^/}) {
10297: $absolutepath = $embed_file;
10298: }
1.1147 raeburn 10299: if ($cleaned_file =~ m{/}) {
10300: my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987 raeburn 10301: $path = &check_for_traversal($path,$url,$toplevel);
10302: my $item = $fname;
10303: if ($path ne '') {
10304: $item = $path.'/'.$fname;
10305: $subdependencies{$path}{$fname} = 1;
10306: } else {
10307: $dependencies{$item} = 1;
10308: }
10309: if ($absolutepath) {
10310: $mapping{$item} = $absolutepath;
10311: } else {
10312: $mapping{$item} = $embed_file;
10313: }
10314: } else {
10315: $dependencies{$embed_file} = 1;
10316: if ($absolutepath) {
1.1147 raeburn 10317: $mapping{$cleaned_file} = $absolutepath;
1.987 raeburn 10318: } else {
1.1147 raeburn 10319: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 10320: }
10321: }
1.984 raeburn 10322: }
10323: }
1.1071 raeburn 10324: my $dirptr = 16384;
1.984 raeburn 10325: foreach my $path (keys(%subdependencies)) {
1.1071 raeburn 10326: $currsubfile{$path} = {};
1.1123 raeburn 10327: if (($actionurl eq '/adm/portfolio') ||
10328: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 10329: my ($sublistref,$listerror) =
10330: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
10331: if (ref($sublistref) eq 'ARRAY') {
10332: foreach my $line (@{$sublistref}) {
10333: my ($file_name,$rest) = split(/\&/,$line,2);
1.1071 raeburn 10334: $currsubfile{$path}{$file_name} = 1;
1.1021 raeburn 10335: }
1.984 raeburn 10336: }
1.987 raeburn 10337: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 10338: if (opendir(my $dir,$url.'/'.$path)) {
10339: my @subdir_list = grep(!/^\./,readdir($dir));
1.1071 raeburn 10340: map {$currsubfile{$path}{$_} = 1;} @subdir_list;
10341: }
1.1084 raeburn 10342: } elsif (($actionurl eq '/adm/dependencies') ||
10343: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 10344: ($args->{'context'} eq 'paste')) ||
10345: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 10346: if ($env{'request.course.id'} ne '') {
1.1123 raeburn 10347: my $dir;
10348: if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
10349: $dir = $fileloc;
10350: } else {
10351: ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
10352: }
1.1071 raeburn 10353: if ($dir ne '') {
10354: my ($sublistref,$listerror) =
10355: &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
10356: if (ref($sublistref) eq 'ARRAY') {
10357: foreach my $line (@{$sublistref}) {
10358: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
10359: undef,$mtime)=split(/\&/,$line,12);
10360: unless (($testdir&$dirptr) ||
10361: ($file_name =~ /^\.\.?$/)) {
10362: $currsubfile{$path}{$file_name} = [$size,$mtime];
10363: }
10364: }
10365: }
10366: }
1.984 raeburn 10367: }
10368: }
10369: foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071 raeburn 10370: if (exists($currsubfile{$path}{$file})) {
1.987 raeburn 10371: my $item = $path.'/'.$file;
10372: unless ($mapping{$item} eq $item) {
10373: $pathchanges{$item} = 1;
10374: }
10375: $existing{$item} = 1;
10376: $numexisting ++;
10377: } else {
10378: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 10379: }
10380: }
1.1071 raeburn 10381: if ($actionurl eq '/adm/dependencies') {
10382: foreach my $path (keys(%currsubfile)) {
10383: if (ref($currsubfile{$path}) eq 'HASH') {
10384: foreach my $file (keys(%{$currsubfile{$path}})) {
10385: unless ($subdependencies{$path}{$file}) {
1.1085 raeburn 10386: next if (($rem ne '') &&
10387: (($env{"httpref.$rem"."$path/$file"} ne '') ||
10388: (ref($navmap) &&
10389: (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
10390: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
10391: ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071 raeburn 10392: $unused{$path.'/'.$file} = 1;
10393: }
10394: }
10395: }
10396: }
10397: }
1.984 raeburn 10398: }
1.987 raeburn 10399: my %currfile;
1.1123 raeburn 10400: if (($actionurl eq '/adm/portfolio') ||
10401: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 10402: my ($dirlistref,$listerror) =
10403: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
10404: if (ref($dirlistref) eq 'ARRAY') {
10405: foreach my $line (@{$dirlistref}) {
10406: my ($file_name,$rest) = split(/\&/,$line,2);
10407: $currfile{$file_name} = 1;
10408: }
1.984 raeburn 10409: }
1.987 raeburn 10410: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 10411: if (opendir(my $dir,$url)) {
1.987 raeburn 10412: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 10413: map {$currfile{$_} = 1;} @dir_list;
10414: }
1.1084 raeburn 10415: } elsif (($actionurl eq '/adm/dependencies') ||
10416: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 10417: ($args->{'context'} eq 'paste')) ||
10418: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 10419: if ($env{'request.course.id'} ne '') {
10420: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
10421: if ($dir ne '') {
10422: my ($dirlistref,$listerror) =
10423: &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
10424: if (ref($dirlistref) eq 'ARRAY') {
10425: foreach my $line (@{$dirlistref}) {
10426: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
10427: $size,undef,$mtime)=split(/\&/,$line,12);
10428: unless (($testdir&$dirptr) ||
10429: ($file_name =~ /^\.\.?$/)) {
10430: $currfile{$file_name} = [$size,$mtime];
10431: }
10432: }
10433: }
10434: }
10435: }
1.984 raeburn 10436: }
10437: foreach my $file (keys(%dependencies)) {
1.1071 raeburn 10438: if (exists($currfile{$file})) {
1.987 raeburn 10439: unless ($mapping{$file} eq $file) {
10440: $pathchanges{$file} = 1;
10441: }
10442: $existing{$file} = 1;
10443: $numexisting ++;
10444: } else {
1.984 raeburn 10445: $newfiles{$file} = 1;
10446: }
10447: }
1.1071 raeburn 10448: foreach my $file (keys(%currfile)) {
10449: unless (($file eq $filename) ||
10450: ($file eq $filename.'.bak') ||
10451: ($dependencies{$file})) {
1.1085 raeburn 10452: if ($actionurl eq '/adm/dependencies') {
1.1126 raeburn 10453: unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
10454: next if (($rem ne '') &&
10455: (($env{"httpref.$rem".$file} ne '') ||
10456: (ref($navmap) &&
10457: (($navmap->getResourceByUrl($rem.$file) ne '') ||
10458: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
10459: ($navmap->getResourceByUrl($rem.$1)))))));
10460: }
1.1085 raeburn 10461: }
1.1071 raeburn 10462: $unused{$file} = 1;
10463: }
10464: }
1.1084 raeburn 10465: if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
10466: ($args->{'context'} eq 'paste')) {
10467: $counter = scalar(keys(%existing));
10468: $numpathchg = scalar(keys(%pathchanges));
1.1123 raeburn 10469: return ($output,$counter,$numpathchg,\%existing);
10470: } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
10471: (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
10472: $counter = scalar(keys(%existing));
10473: $numpathchg = scalar(keys(%pathchanges));
10474: return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1084 raeburn 10475: }
1.984 raeburn 10476: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071 raeburn 10477: if ($actionurl eq '/adm/dependencies') {
10478: next if ($embed_file =~ m{^\w+://});
10479: }
1.660 raeburn 10480: $upload_output .= &start_data_table_row().
1.1123 raeburn 10481: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
1.1071 raeburn 10482: '<span class="LC_filename">'.$embed_file.'</span>';
1.987 raeburn 10483: unless ($mapping{$embed_file} eq $embed_file) {
1.1123 raeburn 10484: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
10485: &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987 raeburn 10486: }
1.1123 raeburn 10487: $upload_output .= '</td>';
1.1071 raeburn 10488: if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) {
1.1123 raeburn 10489: $upload_output.='<td align="right">'.
10490: '<span class="LC_info LC_fontsize_medium">'.
10491: &mt("URL points to web address").'</span>';
1.987 raeburn 10492: $numremref++;
1.660 raeburn 10493: } elsif ($args->{'error_on_invalid_names'}
10494: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1123 raeburn 10495: $upload_output.='<td align="right"><span class="LC_warning">'.
10496: &mt('Invalid characters').'</span>';
1.987 raeburn 10497: $numinvalid++;
1.660 raeburn 10498: } else {
1.1123 raeburn 10499: $upload_output .= '<td>'.
10500: &embedded_file_element('upload_embedded',$counter,
1.987 raeburn 10501: $embed_file,\%mapping,
1.1071 raeburn 10502: $allfiles,$codebase,'upload');
10503: $counter ++;
10504: $numnew ++;
1.987 raeburn 10505: }
10506: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
10507: }
10508: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071 raeburn 10509: if ($actionurl eq '/adm/dependencies') {
10510: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
10511: $modify_output .= &start_data_table_row().
10512: '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
10513: '<img src="'.&icon($embed_file).'" border="0" />'.
10514: ' <span class="LC_filename">'.$embed_file.'</span></a></td>'.
10515: '<td>'.$size.'</td>'.
10516: '<td>'.$mtime.'</td>'.
10517: '<td><label><input type="checkbox" name="mod_upload_dep" '.
10518: 'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
10519: $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
10520: '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
10521: &embedded_file_element('upload_embedded',$counter,
10522: $embed_file,\%mapping,
10523: $allfiles,$codebase,'modify').
10524: '</div></td>'.
10525: &end_data_table_row()."\n";
10526: $counter ++;
10527: } else {
10528: $upload_output .= &start_data_table_row().
1.1123 raeburn 10529: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
10530: '<span class="LC_filename">'.$embed_file.'</span></td>'.
10531: '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071 raeburn 10532: &Apache::loncommon::end_data_table_row()."\n";
10533: }
10534: }
10535: my $delidx = $counter;
10536: foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
10537: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
10538: $delete_output .= &start_data_table_row().
10539: '<td><img src="'.&icon($oldfile).'" />'.
10540: ' <span class="LC_filename">'.$oldfile.'</span></td>'.
10541: '<td>'.$size.'</td>'.
10542: '<td>'.$mtime.'</td>'.
10543: '<td><label><input type="checkbox" name="del_upload_dep" '.
10544: ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
10545: &embedded_file_element('upload_embedded',$delidx,
10546: $oldfile,\%mapping,$allfiles,
10547: $codebase,'delete').'</td>'.
10548: &end_data_table_row()."\n";
10549: $numunused ++;
10550: $delidx ++;
1.987 raeburn 10551: }
10552: if ($upload_output) {
10553: $upload_output = &start_data_table().
10554: $upload_output.
10555: &end_data_table()."\n";
10556: }
1.1071 raeburn 10557: if ($modify_output) {
10558: $modify_output = &start_data_table().
10559: &start_data_table_header_row().
10560: '<th>'.&mt('File').'</th>'.
10561: '<th>'.&mt('Size (KB)').'</th>'.
10562: '<th>'.&mt('Modified').'</th>'.
10563: '<th>'.&mt('Upload replacement?').'</th>'.
10564: &end_data_table_header_row().
10565: $modify_output.
10566: &end_data_table()."\n";
10567: }
10568: if ($delete_output) {
10569: $delete_output = &start_data_table().
10570: &start_data_table_header_row().
10571: '<th>'.&mt('File').'</th>'.
10572: '<th>'.&mt('Size (KB)').'</th>'.
10573: '<th>'.&mt('Modified').'</th>'.
10574: '<th>'.&mt('Delete?').'</th>'.
10575: &end_data_table_header_row().
10576: $delete_output.
10577: &end_data_table()."\n";
10578: }
1.987 raeburn 10579: my $applies = 0;
10580: if ($numremref) {
10581: $applies ++;
10582: }
10583: if ($numinvalid) {
10584: $applies ++;
10585: }
10586: if ($numexisting) {
10587: $applies ++;
10588: }
1.1071 raeburn 10589: if ($counter || $numunused) {
1.987 raeburn 10590: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
10591: ' method="post" enctype="multipart/form-data">'."\n".
1.1071 raeburn 10592: $state.'<h3>'.$heading.'</h3>';
10593: if ($actionurl eq '/adm/dependencies') {
10594: if ($numnew) {
10595: $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
10596: '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
10597: $upload_output.'<br />'."\n";
10598: }
10599: if ($numexisting) {
10600: $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
10601: '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
10602: $modify_output.'<br />'."\n";
10603: $buttontext = &mt('Save changes');
10604: }
10605: if ($numunused) {
10606: $output .= '<h4>'.&mt('Unused files').'</h4>'.
10607: '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
10608: $delete_output.'<br />'."\n";
10609: $buttontext = &mt('Save changes');
10610: }
10611: } else {
10612: $output .= $upload_output.'<br />'."\n";
10613: }
10614: $output .= '<input type ="hidden" name="number_embedded_items" value="'.
10615: $counter.'" />'."\n";
10616: if ($actionurl eq '/adm/dependencies') {
10617: $output .= '<input type ="hidden" name="number_newemb_items" value="'.
10618: $numnew.'" />'."\n";
10619: } elsif ($actionurl eq '') {
1.987 raeburn 10620: $output .= '<input type="hidden" name="phase" value="three" />';
10621: }
10622: } elsif ($applies) {
10623: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
10624: if ($applies > 1) {
10625: $output .=
1.1123 raeburn 10626: &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987 raeburn 10627: if ($numremref) {
10628: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
10629: }
10630: if ($numinvalid) {
10631: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
10632: }
10633: if ($numexisting) {
10634: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
10635: }
10636: $output .= '</ul><br />';
10637: } elsif ($numremref) {
10638: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
10639: } elsif ($numinvalid) {
10640: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
10641: } elsif ($numexisting) {
10642: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
10643: }
10644: $output .= $upload_output.'<br />';
10645: }
10646: my ($pathchange_output,$chgcount);
1.1071 raeburn 10647: $chgcount = $counter;
1.987 raeburn 10648: if (keys(%pathchanges) > 0) {
10649: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071 raeburn 10650: if ($counter) {
1.987 raeburn 10651: $output .= &embedded_file_element('pathchange',$chgcount,
10652: $embed_file,\%mapping,
1.1071 raeburn 10653: $allfiles,$codebase,'change');
1.987 raeburn 10654: } else {
10655: $pathchange_output .=
10656: &start_data_table_row().
10657: '<td><input type ="checkbox" name="namechange" value="'.
10658: $chgcount.'" checked="checked" /></td>'.
10659: '<td>'.$mapping{$embed_file}.'</td>'.
10660: '<td>'.$embed_file.
10661: &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071 raeburn 10662: \%mapping,$allfiles,$codebase,'change').
1.987 raeburn 10663: '</td>'.&end_data_table_row();
1.660 raeburn 10664: }
1.987 raeburn 10665: $numpathchg ++;
10666: $chgcount ++;
1.660 raeburn 10667: }
10668: }
1.1127 raeburn 10669: if (($counter) || ($numunused)) {
1.987 raeburn 10670: if ($numpathchg) {
10671: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
10672: $numpathchg.'" />'."\n";
10673: }
10674: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
10675: ($actionurl eq '/adm/imsimport')) {
10676: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
10677: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
10678: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071 raeburn 10679: } elsif ($actionurl eq '/adm/dependencies') {
10680: $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987 raeburn 10681: }
1.1123 raeburn 10682: $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987 raeburn 10683: } elsif ($numpathchg) {
10684: my %pathchange = ();
10685: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
10686: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
10687: $output .= '<p>'.&mt('or').'</p>';
1.1123 raeburn 10688: }
1.987 raeburn 10689: }
1.1071 raeburn 10690: return ($output,$counter,$numpathchg);
1.987 raeburn 10691: }
10692:
1.1147 raeburn 10693: =pod
10694:
10695: =item * clean_path($name)
10696:
10697: Performs clean-up of directories, subdirectories and filename in an
10698: embedded object, referenced in an HTML file which is being uploaded
10699: to a course or portfolio, where
10700: "Upload embedded images/multimedia files if HTML file" checkbox was
10701: checked.
10702:
10703: Clean-up is similar to replacements in lonnet::clean_filename()
10704: except each / between sub-directory and next level is preserved.
10705:
10706: =cut
10707:
10708: sub clean_path {
10709: my ($embed_file) = @_;
10710: $embed_file =~s{^/+}{};
10711: my @contents;
10712: if ($embed_file =~ m{/}) {
10713: @contents = split(/\//,$embed_file);
10714: } else {
10715: @contents = ($embed_file);
10716: }
10717: my $lastidx = scalar(@contents)-1;
10718: for (my $i=0; $i<=$lastidx; $i++) {
10719: $contents[$i]=~s{\\}{/}g;
10720: $contents[$i]=~s/\s+/\_/g;
10721: $contents[$i]=~s{[^/\w\.\-]}{}g;
10722: if ($i == $lastidx) {
10723: $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
10724: }
10725: }
10726: if ($lastidx > 0) {
10727: return join('/',@contents);
10728: } else {
10729: return $contents[0];
10730: }
10731: }
10732:
1.987 raeburn 10733: sub embedded_file_element {
1.1071 raeburn 10734: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987 raeburn 10735: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
10736: (ref($codebase) eq 'HASH'));
10737: my $output;
1.1071 raeburn 10738: if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987 raeburn 10739: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
10740: }
10741: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
10742: &escape($embed_file).'" />';
10743: unless (($context eq 'upload_embedded') &&
10744: ($mapping->{$embed_file} eq $embed_file)) {
10745: $output .='
10746: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
10747: }
10748: my $attrib;
10749: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
10750: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
10751: }
10752: $output .=
10753: "\n\t\t".
10754: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
10755: $attrib.'" />';
10756: if (exists($codebase->{$mapping->{$embed_file}})) {
10757: $output .=
10758: "\n\t\t".
10759: '<input name="codebase_'.$num.'" type="hidden" value="'.
10760: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 10761: }
1.987 raeburn 10762: return $output;
1.660 raeburn 10763: }
10764:
1.1071 raeburn 10765: sub get_dependency_details {
10766: my ($currfile,$currsubfile,$embed_file) = @_;
10767: my ($size,$mtime,$showsize,$showmtime);
10768: if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
10769: if ($embed_file =~ m{/}) {
10770: my ($path,$fname) = split(/\//,$embed_file);
10771: if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
10772: ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
10773: }
10774: } else {
10775: if (ref($currfile->{$embed_file}) eq 'ARRAY') {
10776: ($size,$mtime) = @{$currfile->{$embed_file}};
10777: }
10778: }
10779: $showsize = $size/1024.0;
10780: $showsize = sprintf("%.1f",$showsize);
10781: if ($mtime > 0) {
10782: $showmtime = &Apache::lonlocal::locallocaltime($mtime);
10783: }
10784: }
10785: return ($showsize,$showmtime);
10786: }
10787:
10788: sub ask_embedded_js {
10789: return <<"END";
10790: <script type="text/javascript"">
10791: // <![CDATA[
10792: function toggleBrowse(counter) {
10793: var chkboxid = document.getElementById('mod_upload_dep_'+counter);
10794: var fileid = document.getElementById('embedded_item_'+counter);
10795: var uploaddivid = document.getElementById('moduploaddep_'+counter);
10796: if (chkboxid.checked == true) {
10797: uploaddivid.style.display='block';
10798: } else {
10799: uploaddivid.style.display='none';
10800: fileid.value = '';
10801: }
10802: }
10803: // ]]>
10804: </script>
10805:
10806: END
10807: }
10808:
1.661 raeburn 10809: sub upload_embedded {
10810: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 10811: $current_disk_usage,$hiddenstate,$actionurl) = @_;
10812: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 10813: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
10814: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
10815: my $orig_uploaded_filename =
10816: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 10817: foreach my $type ('orig','ref','attrib','codebase') {
10818: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
10819: $env{'form.embedded_'.$type.'_'.$i} =
10820: &unescape($env{'form.embedded_'.$type.'_'.$i});
10821: }
10822: }
1.661 raeburn 10823: my ($path,$fname) =
10824: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
10825: # no path, whole string is fname
10826: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
10827: $fname = &Apache::lonnet::clean_filename($fname);
10828: # See if there is anything left
10829: next if ($fname eq '');
10830:
10831: # Check if file already exists as a file or directory.
10832: my ($state,$msg);
10833: if ($context eq 'portfolio') {
10834: my $port_path = $dirpath;
10835: if ($group ne '') {
10836: $port_path = "groups/$group/$port_path";
10837: }
1.987 raeburn 10838: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
10839: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 10840: $dir_root,$port_path,$disk_quota,
10841: $current_disk_usage,$uname,$udom);
10842: if ($state eq 'will_exceed_quota'
1.984 raeburn 10843: || $state eq 'file_locked') {
1.661 raeburn 10844: $output .= $msg;
10845: next;
10846: }
10847: } elsif (($context eq 'author') || ($context eq 'testbank')) {
10848: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
10849: if ($state eq 'exists') {
10850: $output .= $msg;
10851: next;
10852: }
10853: }
10854: # Check if extension is valid
10855: if (($fname =~ /\.(\w+)$/) &&
10856: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1155 bisitz 10857: $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
10858: .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661 raeburn 10859: next;
10860: } elsif (($fname =~ /\.(\w+)$/) &&
10861: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 10862: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 10863: next;
10864: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1120 bisitz 10865: $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 10866: next;
10867: }
10868: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1123 raeburn 10869: my $subdir = $path;
10870: $subdir =~ s{/+$}{};
1.661 raeburn 10871: if ($context eq 'portfolio') {
1.984 raeburn 10872: my $result;
10873: if ($state eq 'existingfile') {
10874: $result=
10875: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1123 raeburn 10876: $dirpath.$env{'form.currentpath'}.$subdir);
1.661 raeburn 10877: } else {
1.984 raeburn 10878: $result=
10879: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 10880: $dirpath.
1.1123 raeburn 10881: $env{'form.currentpath'}.$subdir);
1.984 raeburn 10882: if ($result !~ m|^/uploaded/|) {
10883: $output .= '<span class="LC_error">'
10884: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
10885: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
10886: .'</span><br />';
10887: next;
10888: } else {
1.987 raeburn 10889: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
10890: $path.$fname.'</span>').'<br />';
1.984 raeburn 10891: }
1.661 raeburn 10892: }
1.1123 raeburn 10893: } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
1.1126 raeburn 10894: my $extendedsubdir = $dirpath.'/'.$subdir;
10895: $extendedsubdir =~ s{/+$}{};
1.987 raeburn 10896: my $result =
1.1126 raeburn 10897: &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987 raeburn 10898: if ($result !~ m|^/uploaded/|) {
10899: $output .= '<span class="LC_error">'
10900: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
10901: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
10902: .'</span><br />';
10903: next;
10904: } else {
10905: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
10906: $path.$fname.'</span>').'<br />';
1.1125 raeburn 10907: if ($context eq 'syllabus') {
10908: &Apache::lonnet::make_public_indefinitely($result);
10909: }
1.987 raeburn 10910: }
1.661 raeburn 10911: } else {
10912: # Save the file
10913: my $target = $env{'form.embedded_item_'.$i};
10914: my $fullpath = $dir_root.$dirpath.'/'.$path;
10915: my $dest = $fullpath.$fname;
10916: my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027 raeburn 10917: my @parts=split(/\//,"$dirpath/$path");
1.661 raeburn 10918: my $count;
10919: my $filepath = $dir_root;
1.1027 raeburn 10920: foreach my $subdir (@parts) {
10921: $filepath .= "/$subdir";
10922: if (!-e $filepath) {
1.661 raeburn 10923: mkdir($filepath,0770);
10924: }
10925: }
10926: my $fh;
10927: if (!open($fh,'>'.$dest)) {
10928: &Apache::lonnet::logthis('Failed to create '.$dest);
10929: $output .= '<span class="LC_error">'.
1.1071 raeburn 10930: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
10931: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 10932: '</span><br />';
10933: } else {
10934: if (!print $fh $env{'form.embedded_item_'.$i}) {
10935: &Apache::lonnet::logthis('Failed to write to '.$dest);
10936: $output .= '<span class="LC_error">'.
1.1071 raeburn 10937: &mt('An error occurred while writing the file [_1] for embedded element [_2].',
10938: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 10939: '</span><br />';
10940: } else {
1.987 raeburn 10941: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
10942: $url.'</span>').'<br />';
10943: unless ($context eq 'testbank') {
10944: $footer .= &mt('View embedded file: [_1]',
10945: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
10946: }
10947: }
10948: close($fh);
10949: }
10950: }
10951: if ($env{'form.embedded_ref_'.$i}) {
10952: $pathchange{$i} = 1;
10953: }
10954: }
10955: if ($output) {
10956: $output = '<p>'.$output.'</p>';
10957: }
10958: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
10959: $returnflag = 'ok';
1.1071 raeburn 10960: my $numpathchgs = scalar(keys(%pathchange));
10961: if ($numpathchgs > 0) {
1.987 raeburn 10962: if ($context eq 'portfolio') {
10963: $output .= '<p>'.&mt('or').'</p>';
10964: } elsif ($context eq 'testbank') {
1.1071 raeburn 10965: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
10966: '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987 raeburn 10967: $returnflag = 'modify_orightml';
10968: }
10969: }
1.1071 raeburn 10970: return ($output.$footer,$returnflag,$numpathchgs);
1.987 raeburn 10971: }
10972:
10973: sub modify_html_form {
10974: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
10975: my $end = 0;
10976: my $modifyform;
10977: if ($context eq 'upload_embedded') {
10978: return unless (ref($pathchange) eq 'HASH');
10979: if ($env{'form.number_embedded_items'}) {
10980: $end += $env{'form.number_embedded_items'};
10981: }
10982: if ($env{'form.number_pathchange_items'}) {
10983: $end += $env{'form.number_pathchange_items'};
10984: }
10985: if ($end) {
10986: for (my $i=0; $i<$end; $i++) {
10987: if ($i < $env{'form.number_embedded_items'}) {
10988: next unless($pathchange->{$i});
10989: }
10990: $modifyform .=
10991: &start_data_table_row().
10992: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
10993: 'checked="checked" /></td>'.
10994: '<td>'.$env{'form.embedded_ref_'.$i}.
10995: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
10996: &escape($env{'form.embedded_ref_'.$i}).'" />'.
10997: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
10998: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
10999: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
11000: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
11001: '<td>'.$env{'form.embedded_orig_'.$i}.
11002: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
11003: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
11004: &end_data_table_row();
1.1071 raeburn 11005: }
1.987 raeburn 11006: }
11007: } else {
11008: $modifyform = $pathchgtable;
11009: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
11010: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
11011: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
11012: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
11013: }
11014: }
11015: if ($modifyform) {
1.1071 raeburn 11016: if ($actionurl eq '/adm/dependencies') {
11017: $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
11018: }
1.987 raeburn 11019: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
11020: '<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".
11021: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
11022: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
11023: '</ol></p>'."\n".'<p>'.
11024: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
11025: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
11026: &start_data_table()."\n".
11027: &start_data_table_header_row().
11028: '<th>'.&mt('Change?').'</th>'.
11029: '<th>'.&mt('Current reference').'</th>'.
11030: '<th>'.&mt('Required reference').'</th>'.
11031: &end_data_table_header_row()."\n".
11032: $modifyform.
11033: &end_data_table().'<br />'."\n".$hiddenstate.
11034: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
11035: '</form>'."\n";
11036: }
11037: return;
11038: }
11039:
11040: sub modify_html_refs {
1.1123 raeburn 11041: my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987 raeburn 11042: my $container;
11043: if ($context eq 'portfolio') {
11044: $container = $env{'form.container'};
11045: } elsif ($context eq 'coursedoc') {
11046: $container = $env{'form.primaryurl'};
1.1071 raeburn 11047: } elsif ($context eq 'manage_dependencies') {
11048: (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
11049: $container = "/$container";
1.1123 raeburn 11050: } elsif ($context eq 'syllabus') {
11051: $container = $url;
1.987 raeburn 11052: } else {
1.1027 raeburn 11053: $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987 raeburn 11054: }
11055: my (%allfiles,%codebase,$output,$content);
11056: my @changes = &get_env_multiple('form.namechange');
1.1126 raeburn 11057: unless ((@changes > 0) || ($context eq 'syllabus')) {
1.1071 raeburn 11058: if (wantarray) {
11059: return ('',0,0);
11060: } else {
11061: return;
11062: }
11063: }
11064: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 11065: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071 raeburn 11066: unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
11067: if (wantarray) {
11068: return ('',0,0);
11069: } else {
11070: return;
11071: }
11072: }
1.987 raeburn 11073: $content = &Apache::lonnet::getfile($container);
1.1071 raeburn 11074: if ($content eq '-1') {
11075: if (wantarray) {
11076: return ('',0,0);
11077: } else {
11078: return;
11079: }
11080: }
1.987 raeburn 11081: } else {
1.1071 raeburn 11082: unless ($container =~ /^\Q$dir_root\E/) {
11083: if (wantarray) {
11084: return ('',0,0);
11085: } else {
11086: return;
11087: }
11088: }
1.987 raeburn 11089: if (open(my $fh,"<$container")) {
11090: $content = join('', <$fh>);
11091: close($fh);
11092: } else {
1.1071 raeburn 11093: if (wantarray) {
11094: return ('',0,0);
11095: } else {
11096: return;
11097: }
1.987 raeburn 11098: }
11099: }
11100: my ($count,$codebasecount) = (0,0);
11101: my $mm = new File::MMagic;
11102: my $mime_type = $mm->checktype_contents($content);
11103: if ($mime_type eq 'text/html') {
11104: my $parse_result =
11105: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
11106: \%codebase,\$content);
11107: if ($parse_result eq 'ok') {
11108: foreach my $i (@changes) {
11109: my $orig = &unescape($env{'form.embedded_orig_'.$i});
11110: my $ref = &unescape($env{'form.embedded_ref_'.$i});
11111: if ($allfiles{$ref}) {
11112: my $newname = $orig;
11113: my ($attrib_regexp,$codebase);
1.1006 raeburn 11114: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 11115: if ($attrib_regexp =~ /:/) {
11116: $attrib_regexp =~ s/\:/|/g;
11117: }
11118: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
11119: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
11120: $count += $numchg;
1.1123 raeburn 11121: $allfiles{$newname} = $allfiles{$ref};
1.1148 raeburn 11122: delete($allfiles{$ref});
1.987 raeburn 11123: }
11124: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 11125: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 11126: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
11127: $codebasecount ++;
11128: }
11129: }
11130: }
1.1123 raeburn 11131: my $skiprewrites;
1.987 raeburn 11132: if ($count || $codebasecount) {
11133: my $saveresult;
1.1071 raeburn 11134: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 11135: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987 raeburn 11136: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
11137: if ($url eq $container) {
11138: my ($fname) = ($container =~ m{/([^/]+)$});
11139: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
11140: $count,'<span class="LC_filename">'.
1.1071 raeburn 11141: $fname.'</span>').'</p>';
1.987 raeburn 11142: } else {
11143: $output = '<p class="LC_error">'.
11144: &mt('Error: update failed for: [_1].',
11145: '<span class="LC_filename">'.
11146: $container.'</span>').'</p>';
11147: }
1.1123 raeburn 11148: if ($context eq 'syllabus') {
11149: unless ($saveresult eq 'ok') {
11150: $skiprewrites = 1;
11151: }
11152: }
1.987 raeburn 11153: } else {
11154: if (open(my $fh,">$container")) {
11155: print $fh $content;
11156: close($fh);
11157: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
11158: $count,'<span class="LC_filename">'.
11159: $container.'</span>').'</p>';
1.661 raeburn 11160: } else {
1.987 raeburn 11161: $output = '<p class="LC_error">'.
11162: &mt('Error: could not update [_1].',
11163: '<span class="LC_filename">'.
11164: $container.'</span>').'</p>';
1.661 raeburn 11165: }
11166: }
11167: }
1.1123 raeburn 11168: if (($context eq 'syllabus') && (!$skiprewrites)) {
11169: my ($actionurl,$state);
11170: $actionurl = "/public/$udom/$uname/syllabus";
11171: my ($ignore,$num,$numpathchanges,$existing,$mapping) =
11172: &ask_for_embedded_content($actionurl,$state,\%allfiles,
11173: \%codebase,
11174: {'context' => 'rewrites',
11175: 'ignore_remote_references' => 1,});
11176: if (ref($mapping) eq 'HASH') {
11177: my $rewrites = 0;
11178: foreach my $key (keys(%{$mapping})) {
11179: next if ($key =~ m{^https?://});
11180: my $ref = $mapping->{$key};
11181: my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
11182: my $attrib;
11183: if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
11184: $attrib = join('|',@{$allfiles{$mapping->{$key}}});
11185: }
11186: if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
11187: my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
11188: $rewrites += $numchg;
11189: }
11190: }
11191: if ($rewrites) {
11192: my $saveresult;
11193: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
11194: if ($url eq $container) {
11195: my ($fname) = ($container =~ m{/([^/]+)$});
11196: $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
11197: $count,'<span class="LC_filename">'.
11198: $fname.'</span>').'</p>';
11199: } else {
11200: $output .= '<p class="LC_error">'.
11201: &mt('Error: could not update links in [_1].',
11202: '<span class="LC_filename">'.
11203: $container.'</span>').'</p>';
11204:
11205: }
11206: }
11207: }
11208: }
1.987 raeburn 11209: } else {
11210: &logthis('Failed to parse '.$container.
11211: ' to modify references: '.$parse_result);
1.661 raeburn 11212: }
11213: }
1.1071 raeburn 11214: if (wantarray) {
11215: return ($output,$count,$codebasecount);
11216: } else {
11217: return $output;
11218: }
1.661 raeburn 11219: }
11220:
11221: sub check_for_existing {
11222: my ($path,$fname,$element) = @_;
11223: my ($state,$msg);
11224: if (-d $path.'/'.$fname) {
11225: $state = 'exists';
11226: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
11227: } elsif (-e $path.'/'.$fname) {
11228: $state = 'exists';
11229: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
11230: }
11231: if ($state eq 'exists') {
11232: $msg = '<span class="LC_error">'.$msg.'</span><br />';
11233: }
11234: return ($state,$msg);
11235: }
11236:
11237: sub check_for_upload {
11238: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
11239: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 11240: my $filesize = length($env{'form.'.$element});
11241: if (!$filesize) {
11242: my $msg = '<span class="LC_error">'.
11243: &mt('Unable to upload [_1]. (size = [_2] bytes)',
11244: '<span class="LC_filename">'.$fname.'</span>',
11245: $filesize).'<br />'.
1.1007 raeburn 11246: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 11247: '</span>';
11248: return ('zero_bytes',$msg);
11249: }
11250: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 11251: my $getpropath = 1;
1.1021 raeburn 11252: my ($dirlistref,$listerror) =
11253: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 11254: my $found_file = 0;
11255: my $locked_file = 0;
1.991 raeburn 11256: my @lockers;
11257: my $navmap;
11258: if ($env{'request.course.id'}) {
11259: $navmap = Apache::lonnavmaps::navmap->new();
11260: }
1.1021 raeburn 11261: if (ref($dirlistref) eq 'ARRAY') {
11262: foreach my $line (@{$dirlistref}) {
11263: my ($file_name,$rest)=split(/\&/,$line,2);
11264: if ($file_name eq $fname){
11265: $file_name = $path.$file_name;
11266: if ($group ne '') {
11267: $file_name = $group.$file_name;
11268: }
11269: $found_file = 1;
11270: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
11271: foreach my $lock (@lockers) {
11272: if (ref($lock) eq 'ARRAY') {
11273: my ($symb,$crsid) = @{$lock};
11274: if ($crsid eq $env{'request.course.id'}) {
11275: if (ref($navmap)) {
11276: my $res = $navmap->getBySymb($symb);
11277: foreach my $part (@{$res->parts()}) {
11278: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
11279: unless (($slot_status == $res->RESERVED) ||
11280: ($slot_status == $res->RESERVED_LOCATION)) {
11281: $locked_file = 1;
11282: }
1.991 raeburn 11283: }
1.1021 raeburn 11284: } else {
11285: $locked_file = 1;
1.991 raeburn 11286: }
11287: } else {
11288: $locked_file = 1;
11289: }
11290: }
1.1021 raeburn 11291: }
11292: } else {
11293: my @info = split(/\&/,$rest);
11294: my $currsize = $info[6]/1000;
11295: if ($currsize < $filesize) {
11296: my $extra = $filesize - $currsize;
11297: if (($current_disk_usage + $extra) > $disk_quota) {
1.1179 bisitz 11298: my $msg = '<p class="LC_warning">'.
1.1021 raeburn 11299: &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.1179 bisitz 11300: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
11301: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
11302: $disk_quota,$current_disk_usage).'</p>';
1.1021 raeburn 11303: return ('will_exceed_quota',$msg);
11304: }
1.984 raeburn 11305: }
11306: }
1.661 raeburn 11307: }
11308: }
11309: }
11310: if (($current_disk_usage + $filesize) > $disk_quota){
1.1179 bisitz 11311: my $msg = '<p class="LC_warning">'.
11312: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
1.1184 raeburn 11313: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661 raeburn 11314: return ('will_exceed_quota',$msg);
11315: } elsif ($found_file) {
11316: if ($locked_file) {
1.1179 bisitz 11317: my $msg = '<p class="LC_warning">';
1.661 raeburn 11318: $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.1179 bisitz 11319: $msg .= '</p>';
1.661 raeburn 11320: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
11321: return ('file_locked',$msg);
11322: } else {
1.1179 bisitz 11323: my $msg = '<p class="LC_error">';
1.984 raeburn 11324: $msg .= &mt(' A file by that name: [_1] was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$port_path.$env{'form.currentpath'});
1.1179 bisitz 11325: $msg .= '</p>';
1.984 raeburn 11326: return ('existingfile',$msg);
1.661 raeburn 11327: }
11328: }
11329: }
11330:
1.987 raeburn 11331: sub check_for_traversal {
11332: my ($path,$url,$toplevel) = @_;
11333: my @parts=split(/\//,$path);
11334: my $cleanpath;
11335: my $fullpath = $url;
11336: for (my $i=0;$i<@parts;$i++) {
11337: next if ($parts[$i] eq '.');
11338: if ($parts[$i] eq '..') {
11339: $fullpath =~ s{([^/]+/)$}{};
11340: } else {
11341: $fullpath .= $parts[$i].'/';
11342: }
11343: }
11344: if ($fullpath =~ /^\Q$url\E(.*)$/) {
11345: $cleanpath = $1;
11346: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
11347: my $curr_toprel = $1;
11348: my @parts = split(/\//,$curr_toprel);
11349: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
11350: my @urlparts = split(/\//,$url_toprel);
11351: my $doubledots;
11352: my $startdiff = -1;
11353: for (my $i=0; $i<@urlparts; $i++) {
11354: if ($startdiff == -1) {
11355: unless ($urlparts[$i] eq $parts[$i]) {
11356: $startdiff = $i;
11357: $doubledots .= '../';
11358: }
11359: } else {
11360: $doubledots .= '../';
11361: }
11362: }
11363: if ($startdiff > -1) {
11364: $cleanpath = $doubledots;
11365: for (my $i=$startdiff; $i<@parts; $i++) {
11366: $cleanpath .= $parts[$i].'/';
11367: }
11368: }
11369: }
11370: $cleanpath =~ s{(/)$}{};
11371: return $cleanpath;
11372: }
1.31 albertel 11373:
1.1053 raeburn 11374: sub is_archive_file {
11375: my ($mimetype) = @_;
11376: if (($mimetype eq 'application/octet-stream') ||
11377: ($mimetype eq 'application/x-stuffit') ||
11378: ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
11379: return 1;
11380: }
11381: return;
11382: }
11383:
11384: sub decompress_form {
1.1065 raeburn 11385: my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053 raeburn 11386: my %lt = &Apache::lonlocal::texthash (
11387: this => 'This file is an archive file.',
1.1067 raeburn 11388: camt => 'This file is a Camtasia archive file.',
1.1065 raeburn 11389: itsc => 'Its contents are as follows:',
1.1053 raeburn 11390: youm => 'You may wish to extract its contents.',
11391: extr => 'Extract contents',
1.1067 raeburn 11392: auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
11393: proa => 'Process automatically?',
1.1053 raeburn 11394: yes => 'Yes',
11395: no => 'No',
1.1067 raeburn 11396: fold => 'Title for folder containing movie',
11397: movi => 'Title for page containing embedded movie',
1.1053 raeburn 11398: );
1.1065 raeburn 11399: my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067 raeburn 11400: my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065 raeburn 11401: my $info = &list_archive_contents($fileloc,\@paths);
11402: if (@paths) {
11403: foreach my $path (@paths) {
11404: $path =~ s{^/}{};
1.1067 raeburn 11405: if ($path =~ m{^([^/]+)/$}) {
11406: $topdir = $1;
11407: }
1.1065 raeburn 11408: if ($path =~ m{^([^/]+)/}) {
11409: $toplevel{$1} = $path;
11410: } else {
11411: $toplevel{$path} = $path;
11412: }
11413: }
11414: }
1.1067 raeburn 11415: if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1164 raeburn 11416: my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067 raeburn 11417: "$topdir/media/",
11418: "$topdir/media/$topdir.mp4",
11419: "$topdir/media/FirstFrame.png",
11420: "$topdir/media/player.swf",
11421: "$topdir/media/swfobject.js",
11422: "$topdir/media/expressInstall.swf");
1.1197 raeburn 11423: my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1164 raeburn 11424: "$topdir/$topdir.mp4",
11425: "$topdir/$topdir\_config.xml",
11426: "$topdir/$topdir\_controller.swf",
11427: "$topdir/$topdir\_embed.css",
11428: "$topdir/$topdir\_First_Frame.png",
11429: "$topdir/$topdir\_player.html",
11430: "$topdir/$topdir\_Thumbnails.png",
11431: "$topdir/playerProductInstall.swf",
11432: "$topdir/scripts/",
11433: "$topdir/scripts/config_xml.js",
11434: "$topdir/scripts/handlebars.js",
11435: "$topdir/scripts/jquery-1.7.1.min.js",
11436: "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
11437: "$topdir/scripts/modernizr.js",
11438: "$topdir/scripts/player-min.js",
11439: "$topdir/scripts/swfobject.js",
11440: "$topdir/skins/",
11441: "$topdir/skins/configuration_express.xml",
11442: "$topdir/skins/express_show/",
11443: "$topdir/skins/express_show/player-min.css",
11444: "$topdir/skins/express_show/spritesheet.png");
1.1197 raeburn 11445: my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
11446: "$topdir/$topdir.mp4",
11447: "$topdir/$topdir\_config.xml",
11448: "$topdir/$topdir\_controller.swf",
11449: "$topdir/$topdir\_embed.css",
11450: "$topdir/$topdir\_First_Frame.png",
11451: "$topdir/$topdir\_player.html",
11452: "$topdir/$topdir\_Thumbnails.png",
11453: "$topdir/playerProductInstall.swf",
11454: "$topdir/scripts/",
11455: "$topdir/scripts/config_xml.js",
11456: "$topdir/scripts/techsmith-smart-player.min.js",
11457: "$topdir/skins/",
11458: "$topdir/skins/configuration_express.xml",
11459: "$topdir/skins/express_show/",
11460: "$topdir/skins/express_show/spritesheet.min.css",
11461: "$topdir/skins/express_show/spritesheet.png",
11462: "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1164 raeburn 11463: my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067 raeburn 11464: if (@diffs == 0) {
1.1164 raeburn 11465: $is_camtasia = 6;
11466: } else {
1.1197 raeburn 11467: @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1164 raeburn 11468: if (@diffs == 0) {
11469: $is_camtasia = 8;
1.1197 raeburn 11470: } else {
11471: @diffs = &compare_arrays(\@paths,\@camtasia8_4);
11472: if (@diffs == 0) {
11473: $is_camtasia = 8;
11474: }
1.1164 raeburn 11475: }
1.1067 raeburn 11476: }
11477: }
11478: my $output;
11479: if ($is_camtasia) {
11480: $output = <<"ENDCAM";
11481: <script type="text/javascript" language="Javascript">
11482: // <![CDATA[
11483:
11484: function camtasiaToggle() {
11485: for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
11486: if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1164 raeburn 11487: if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067 raeburn 11488: document.getElementById('camtasia_titles').style.display='block';
11489: } else {
11490: document.getElementById('camtasia_titles').style.display='none';
11491: }
11492: }
11493: }
11494: return;
11495: }
11496:
11497: // ]]>
11498: </script>
11499: <p>$lt{'camt'}</p>
11500: ENDCAM
1.1065 raeburn 11501: } else {
1.1067 raeburn 11502: $output = '<p>'.$lt{'this'};
11503: if ($info eq '') {
11504: $output .= ' '.$lt{'youm'}.'</p>'."\n";
11505: } else {
11506: $output .= ' '.$lt{'itsc'}.'</p>'."\n".
11507: '<div><pre>'.$info.'</pre></div>';
11508: }
1.1065 raeburn 11509: }
1.1067 raeburn 11510: $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065 raeburn 11511: my $duplicates;
11512: my $num = 0;
11513: if (ref($dirlist) eq 'ARRAY') {
11514: foreach my $item (@{$dirlist}) {
11515: if (ref($item) eq 'ARRAY') {
11516: if (exists($toplevel{$item->[0]})) {
11517: $duplicates .=
11518: &start_data_table_row().
11519: '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
11520: 'value="0" checked="checked" />'.&mt('No').'</label>'.
11521: ' <label><input type="radio" name="archive_overwrite_'.$num.'" '.
11522: 'value="1" />'.&mt('Yes').'</label>'.
11523: '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
11524: '<td>'.$item->[0].'</td>';
11525: if ($item->[2]) {
11526: $duplicates .= '<td>'.&mt('Directory').'</td>';
11527: } else {
11528: $duplicates .= '<td>'.&mt('File').'</td>';
11529: }
11530: $duplicates .= '<td>'.$item->[3].'</td>'.
11531: '<td>'.
11532: &Apache::lonlocal::locallocaltime($item->[4]).
11533: '</td>'.
11534: &end_data_table_row();
11535: $num ++;
11536: }
11537: }
11538: }
11539: }
11540: my $itemcount;
11541: if (@paths > 0) {
11542: $itemcount = scalar(@paths);
11543: } else {
11544: $itemcount = 1;
11545: }
1.1067 raeburn 11546: if ($is_camtasia) {
11547: $output .= $lt{'auto'}.'<br />'.
11548: '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1164 raeburn 11549: '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067 raeburn 11550: $lt{'yes'}.'</label> <label>'.
11551: '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
11552: $lt{'no'}.'</label></span><br />'.
11553: '<div id="camtasia_titles" style="display:block">'.
11554: &Apache::lonhtmlcommon::start_pick_box().
11555: &Apache::lonhtmlcommon::row_title($lt{'fold'}).
11556: '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
11557: &Apache::lonhtmlcommon::row_closure().
11558: &Apache::lonhtmlcommon::row_title($lt{'movi'}).
11559: '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
11560: &Apache::lonhtmlcommon::row_closure(1).
11561: &Apache::lonhtmlcommon::end_pick_box().
11562: '</div>';
11563: }
1.1065 raeburn 11564: $output .=
11565: '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067 raeburn 11566: '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
11567: "\n";
1.1065 raeburn 11568: if ($duplicates ne '') {
11569: $output .= '<p><span class="LC_warning">'.
11570: &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.
11571: &start_data_table().
11572: &start_data_table_header_row().
11573: '<th>'.&mt('Overwrite?').'</th>'.
11574: '<th>'.&mt('Name').'</th>'.
11575: '<th>'.&mt('Type').'</th>'.
11576: '<th>'.&mt('Size').'</th>'.
11577: '<th>'.&mt('Last modified').'</th>'.
11578: &end_data_table_header_row().
11579: $duplicates.
11580: &end_data_table().
11581: '</p>';
11582: }
1.1067 raeburn 11583: $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053 raeburn 11584: if (ref($hiddenelements) eq 'HASH') {
11585: foreach my $hidden (sort(keys(%{$hiddenelements}))) {
11586: $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
11587: }
11588: }
11589: $output .= <<"END";
1.1067 raeburn 11590: <br />
1.1053 raeburn 11591: <input type="submit" name="decompress" value="$lt{'extr'}" />
11592: </form>
11593: $noextract
11594: END
11595: return $output;
11596: }
11597:
1.1065 raeburn 11598: sub decompression_utility {
11599: my ($program) = @_;
11600: my @utilities = ('tar','gunzip','bunzip2','unzip');
11601: my $location;
11602: if (grep(/^\Q$program\E$/,@utilities)) {
11603: foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
11604: '/usr/sbin/') {
11605: if (-x $dir.$program) {
11606: $location = $dir.$program;
11607: last;
11608: }
11609: }
11610: }
11611: return $location;
11612: }
11613:
11614: sub list_archive_contents {
11615: my ($file,$pathsref) = @_;
11616: my (@cmd,$output);
11617: my $needsregexp;
11618: if ($file =~ /\.zip$/) {
11619: @cmd = (&decompression_utility('unzip'),"-l");
11620: $needsregexp = 1;
11621: } elsif (($file =~ m/\.tar\.gz$/) ||
11622: ($file =~ /\.tgz$/)) {
11623: @cmd = (&decompression_utility('tar'),"-ztf");
11624: } elsif ($file =~ /\.tar\.bz2$/) {
11625: @cmd = (&decompression_utility('tar'),"-jtf");
11626: } elsif ($file =~ m|\.tar$|) {
11627: @cmd = (&decompression_utility('tar'),"-tf");
11628: }
11629: if (@cmd) {
11630: undef($!);
11631: undef($@);
11632: if (open(my $fh,"-|", @cmd, $file)) {
11633: while (my $line = <$fh>) {
11634: $output .= $line;
11635: chomp($line);
11636: my $item;
11637: if ($needsregexp) {
11638: ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/);
11639: } else {
11640: $item = $line;
11641: }
11642: if ($item ne '') {
11643: unless (grep(/^\Q$item\E$/,@{$pathsref})) {
11644: push(@{$pathsref},$item);
11645: }
11646: }
11647: }
11648: close($fh);
11649: }
11650: }
11651: return $output;
11652: }
11653:
1.1053 raeburn 11654: sub decompress_uploaded_file {
11655: my ($file,$dir) = @_;
11656: &Apache::lonnet::appenv({'cgi.file' => $file});
11657: &Apache::lonnet::appenv({'cgi.dir' => $dir});
11658: my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
11659: my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
11660: my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
11661: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
11662: my $decompressed = $env{'cgi.decompressed'};
11663: &Apache::lonnet::delenv('cgi.file');
11664: &Apache::lonnet::delenv('cgi.dir');
11665: &Apache::lonnet::delenv('cgi.decompressed');
11666: return ($decompressed,$result);
11667: }
11668:
1.1055 raeburn 11669: sub process_decompression {
11670: my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
11671: my ($dir,$error,$warning,$output);
1.1180 raeburn 11672: if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1120 bisitz 11673: $error = &mt('Filename not a supported archive file type.').
11674: '<br />'.&mt('Filename should end with one of: [_1].',
1.1055 raeburn 11675: '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
11676: } else {
11677: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
11678: if ($docuhome eq 'no_host') {
11679: $error = &mt('Could not determine home server for course.');
11680: } else {
11681: my @ids=&Apache::lonnet::current_machine_ids();
11682: my $currdir = "$dir_root/$destination";
11683: if (grep(/^\Q$docuhome\E$/,@ids)) {
11684: $dir = &LONCAPA::propath($docudom,$docuname).
11685: "$dir_root/$destination";
11686: } else {
11687: $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
11688: "$dir_root/$docudom/$docuname/$destination";
11689: unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
11690: $error = &mt('Archive file not found.');
11691: }
11692: }
1.1065 raeburn 11693: my (@to_overwrite,@to_skip);
11694: if ($env{'form.archive_overwrite_total'} > 0) {
11695: my $total = $env{'form.archive_overwrite_total'};
11696: for (my $i=0; $i<$total; $i++) {
11697: if ($env{'form.archive_overwrite_'.$i} == 1) {
11698: push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
11699: } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
11700: push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
11701: }
11702: }
11703: }
11704: my $numskip = scalar(@to_skip);
11705: if (($numskip > 0) &&
11706: ($numskip == $env{'form.archive_itemcount'})) {
11707: $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');
11708: } elsif ($dir eq '') {
1.1055 raeburn 11709: $error = &mt('Directory containing archive file unavailable.');
11710: } elsif (!$error) {
1.1065 raeburn 11711: my ($decompressed,$display);
11712: if ($numskip > 0) {
11713: my $tempdir = time.'_'.$$.int(rand(10000));
11714: mkdir("$dir/$tempdir",0755);
11715: system("mv $dir/$file $dir/$tempdir/$file");
11716: ($decompressed,$display) =
11717: &decompress_uploaded_file($file,"$dir/$tempdir");
11718: foreach my $item (@to_skip) {
11719: if (($item ne '') && ($item !~ /\.\./)) {
11720: if (-f "$dir/$tempdir/$item") {
11721: unlink("$dir/$tempdir/$item");
11722: } elsif (-d "$dir/$tempdir/$item") {
11723: system("rm -rf $dir/$tempdir/$item");
11724: }
11725: }
11726: }
11727: system("mv $dir/$tempdir/* $dir");
11728: rmdir("$dir/$tempdir");
11729: } else {
11730: ($decompressed,$display) =
11731: &decompress_uploaded_file($file,$dir);
11732: }
1.1055 raeburn 11733: if ($decompressed eq 'ok') {
1.1065 raeburn 11734: $output = '<p class="LC_info">'.
11735: &mt('Files extracted successfully from archive.').
11736: '</p>'."\n";
1.1055 raeburn 11737: my ($warning,$result,@contents);
11738: my ($newdirlistref,$newlisterror) =
11739: &Apache::lonnet::dirlist($currdir,$docudom,
11740: $docuname,1);
11741: my (%is_dir,%changes,@newitems);
11742: my $dirptr = 16384;
1.1065 raeburn 11743: if (ref($newdirlistref) eq 'ARRAY') {
1.1055 raeburn 11744: foreach my $dir_line (@{$newdirlistref}) {
11745: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1065 raeburn 11746: unless (($item =~ /^\.+$/) || ($item eq $file) ||
11747: ((@to_skip > 0) && (grep(/^\Q$item\E$/,@to_skip)))) {
1.1055 raeburn 11748: push(@newitems,$item);
11749: if ($dirptr&$testdir) {
11750: $is_dir{$item} = 1;
11751: }
11752: $changes{$item} = 1;
11753: }
11754: }
11755: }
11756: if (keys(%changes) > 0) {
11757: foreach my $item (sort(@newitems)) {
11758: if ($changes{$item}) {
11759: push(@contents,$item);
11760: }
11761: }
11762: }
11763: if (@contents > 0) {
1.1067 raeburn 11764: my $wantform;
11765: unless ($env{'form.autoextract_camtasia'}) {
11766: $wantform = 1;
11767: }
1.1056 raeburn 11768: my (%children,%parent,%dirorder,%titles);
1.1055 raeburn 11769: my ($count,$datatable) = &get_extracted($docudom,$docuname,
11770: $currdir,\%is_dir,
11771: \%children,\%parent,
1.1056 raeburn 11772: \@contents,\%dirorder,
11773: \%titles,$wantform);
1.1055 raeburn 11774: if ($datatable ne '') {
11775: $output .= &archive_options_form('decompressed',$datatable,
11776: $count,$hiddenelem);
1.1065 raeburn 11777: my $startcount = 6;
1.1055 raeburn 11778: $output .= &archive_javascript($startcount,$count,
1.1056 raeburn 11779: \%titles,\%children);
1.1055 raeburn 11780: }
1.1067 raeburn 11781: if ($env{'form.autoextract_camtasia'}) {
1.1164 raeburn 11782: my $version = $env{'form.autoextract_camtasia'};
1.1067 raeburn 11783: my %displayed;
11784: my $total = 1;
11785: $env{'form.archive_directory'} = [];
11786: foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
11787: my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
11788: $path =~ s{/$}{};
11789: my $item;
11790: if ($path ne '') {
11791: $item = "$path/$titles{$i}";
11792: } else {
11793: $item = $titles{$i};
11794: }
11795: $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
11796: if ($item eq $contents[0]) {
11797: push(@{$env{'form.archive_directory'}},$i);
11798: $env{'form.archive_'.$i} = 'display';
11799: $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
11800: $displayed{'folder'} = $i;
1.1164 raeburn 11801: } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
11802: (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067 raeburn 11803: $env{'form.archive_'.$i} = 'display';
11804: $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
11805: $displayed{'web'} = $i;
11806: } else {
1.1164 raeburn 11807: if ((($item eq "$contents[0]/media") && ($version == 6)) ||
11808: ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
11809: ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067 raeburn 11810: push(@{$env{'form.archive_directory'}},$i);
11811: }
11812: $env{'form.archive_'.$i} = 'dependency';
11813: }
11814: $total ++;
11815: }
11816: for (my $i=1; $i<$total; $i++) {
11817: next if ($i == $displayed{'web'});
11818: next if ($i == $displayed{'folder'});
11819: $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
11820: }
11821: $env{'form.phase'} = 'decompress_cleanup';
11822: $env{'form.archivedelete'} = 1;
11823: $env{'form.archive_count'} = $total-1;
11824: $output .=
11825: &process_extracted_files('coursedocs',$docudom,
11826: $docuname,$destination,
11827: $dir_root,$hiddenelem);
11828: }
1.1055 raeburn 11829: } else {
11830: $warning = &mt('No new items extracted from archive file.');
11831: }
11832: } else {
11833: $output = $display;
11834: $error = &mt('An error occurred during extraction from the archive file.');
11835: }
11836: }
11837: }
11838: }
11839: if ($error) {
11840: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
11841: $error.'</p>'."\n";
11842: }
11843: if ($warning) {
11844: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
11845: }
11846: return $output;
11847: }
11848:
11849: sub get_extracted {
1.1056 raeburn 11850: my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
11851: $titles,$wantform) = @_;
1.1055 raeburn 11852: my $count = 0;
11853: my $depth = 0;
11854: my $datatable;
1.1056 raeburn 11855: my @hierarchy;
1.1055 raeburn 11856: return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056 raeburn 11857: (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
11858: (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055 raeburn 11859: foreach my $item (@{$contents}) {
11860: $count ++;
1.1056 raeburn 11861: @{$dirorder->{$count}} = @hierarchy;
11862: $titles->{$count} = $item;
1.1055 raeburn 11863: &archive_hierarchy($depth,$count,$parent,$children);
11864: if ($wantform) {
11865: $datatable .= &archive_row($is_dir->{$item},$item,
11866: $currdir,$depth,$count);
11867: }
11868: if ($is_dir->{$item}) {
11869: $depth ++;
1.1056 raeburn 11870: push(@hierarchy,$count);
11871: $parent->{$depth} = $count;
1.1055 raeburn 11872: $datatable .=
11873: &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056 raeburn 11874: \$depth,\$count,\@hierarchy,$dirorder,
11875: $children,$parent,$titles,$wantform);
1.1055 raeburn 11876: $depth --;
1.1056 raeburn 11877: pop(@hierarchy);
1.1055 raeburn 11878: }
11879: }
11880: return ($count,$datatable);
11881: }
11882:
11883: sub recurse_extracted_archive {
1.1056 raeburn 11884: my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
11885: $children,$parent,$titles,$wantform) = @_;
1.1055 raeburn 11886: my $result='';
1.1056 raeburn 11887: unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
11888: (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
11889: (ref($dirorder) eq 'HASH')) {
1.1055 raeburn 11890: return $result;
11891: }
11892: my $dirptr = 16384;
11893: my ($newdirlistref,$newlisterror) =
11894: &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
11895: if (ref($newdirlistref) eq 'ARRAY') {
11896: foreach my $dir_line (@{$newdirlistref}) {
11897: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
11898: unless ($item =~ /^\.+$/) {
11899: $$count ++;
1.1056 raeburn 11900: @{$dirorder->{$$count}} = @{$hierarchy};
11901: $titles->{$$count} = $item;
1.1055 raeburn 11902: &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056 raeburn 11903:
1.1055 raeburn 11904: my $is_dir;
11905: if ($dirptr&$testdir) {
11906: $is_dir = 1;
11907: }
11908: if ($wantform) {
11909: $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
11910: }
11911: if ($is_dir) {
11912: $$depth ++;
1.1056 raeburn 11913: push(@{$hierarchy},$$count);
11914: $parent->{$$depth} = $$count;
1.1055 raeburn 11915: $result .=
11916: &recurse_extracted_archive("$currdir/$item",$docudom,
11917: $docuname,$depth,$count,
1.1056 raeburn 11918: $hierarchy,$dirorder,$children,
11919: $parent,$titles,$wantform);
1.1055 raeburn 11920: $$depth --;
1.1056 raeburn 11921: pop(@{$hierarchy});
1.1055 raeburn 11922: }
11923: }
11924: }
11925: }
11926: return $result;
11927: }
11928:
11929: sub archive_hierarchy {
11930: my ($depth,$count,$parent,$children) =@_;
11931: if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
11932: if (exists($parent->{$depth})) {
11933: $children->{$parent->{$depth}} .= $count.':';
11934: }
11935: }
11936: return;
11937: }
11938:
11939: sub archive_row {
11940: my ($is_dir,$item,$currdir,$depth,$count) = @_;
11941: my ($name) = ($item =~ m{([^/]+)$});
11942: my %choices = &Apache::lonlocal::texthash (
1.1059 raeburn 11943: 'display' => 'Add as file',
1.1055 raeburn 11944: 'dependency' => 'Include as dependency',
11945: 'discard' => 'Discard',
11946: );
11947: if ($is_dir) {
1.1059 raeburn 11948: $choices{'display'} = &mt('Add as folder');
1.1055 raeburn 11949: }
1.1056 raeburn 11950: my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
11951: my $offset = 0;
1.1055 raeburn 11952: foreach my $action ('display','dependency','discard') {
1.1056 raeburn 11953: $offset ++;
1.1065 raeburn 11954: if ($action ne 'display') {
11955: $offset ++;
11956: }
1.1055 raeburn 11957: $output .= '<td><span class="LC_nobreak">'.
11958: '<label><input type="radio" name="archive_'.$count.
11959: '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
11960: my $text = $choices{$action};
11961: if ($is_dir) {
11962: $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
11963: if ($action eq 'display') {
1.1059 raeburn 11964: $text = &mt('Add as folder');
1.1055 raeburn 11965: }
1.1056 raeburn 11966: } else {
11967: $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
11968:
11969: }
11970: $output .= ' /> '.$choices{$action}.'</label></span>';
11971: if ($action eq 'dependency') {
11972: $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
11973: &mt('Used by:').' <select name="archive_dependent_on_'.$count.'" '.
11974: 'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
11975: '<option value=""></option>'."\n".
11976: '</select>'."\n".
11977: '</div>';
1.1059 raeburn 11978: } elsif ($action eq 'display') {
11979: $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
11980: &mt('Title:').' <input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
11981: '</div>';
1.1055 raeburn 11982: }
1.1056 raeburn 11983: $output .= '</td>';
1.1055 raeburn 11984: }
11985: $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
11986: &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.(' ' x 2);
11987: for (my $i=0; $i<$depth; $i++) {
11988: $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
11989: }
11990: if ($is_dir) {
11991: $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" /> '."\n".
11992: '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
11993: } else {
11994: $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
11995: }
11996: $output .= ' '.$name.'</td>'."\n".
11997: &end_data_table_row();
11998: return $output;
11999: }
12000:
12001: sub archive_options_form {
1.1065 raeburn 12002: my ($form,$display,$count,$hiddenelem) = @_;
12003: my %lt = &Apache::lonlocal::texthash(
12004: perm => 'Permanently remove archive file?',
12005: hows => 'How should each extracted item be incorporated in the course?',
12006: cont => 'Content actions for all',
12007: addf => 'Add as folder/file',
12008: incd => 'Include as dependency for a displayed file',
12009: disc => 'Discard',
12010: no => 'No',
12011: yes => 'Yes',
12012: save => 'Save',
12013: );
12014: my $output = <<"END";
12015: <form name="$form" method="post" action="">
12016: <p><span class="LC_nobreak">$lt{'perm'}
12017: <label>
12018: <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
12019: </label>
12020:
12021: <label>
12022: <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
12023: </span>
12024: </p>
12025: <input type="hidden" name="phase" value="decompress_cleanup" />
12026: <br />$lt{'hows'}
12027: <div class="LC_columnSection">
12028: <fieldset>
12029: <legend>$lt{'cont'}</legend>
12030: <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" />
12031: <input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
12032: <input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
12033: </fieldset>
12034: </div>
12035: END
12036: return $output.
1.1055 raeburn 12037: &start_data_table()."\n".
1.1065 raeburn 12038: $display."\n".
1.1055 raeburn 12039: &end_data_table()."\n".
12040: '<input type="hidden" name="archive_count" value="'.$count.'" />'.
12041: $hiddenelem.
1.1065 raeburn 12042: '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055 raeburn 12043: '</form>';
12044: }
12045:
12046: sub archive_javascript {
1.1056 raeburn 12047: my ($startcount,$numitems,$titles,$children) = @_;
12048: return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059 raeburn 12049: my $maintitle = $env{'form.comment'};
1.1055 raeburn 12050: my $scripttag = <<START;
12051: <script type="text/javascript">
12052: // <![CDATA[
12053:
12054: function checkAll(form,prefix) {
12055: var idstr = new RegExp("^archive_"+prefix+"_\\\\d+\$");
12056: for (var i=0; i < form.elements.length; i++) {
12057: var id = form.elements[i].id;
12058: if ((id != '') && (id != undefined)) {
12059: if (idstr.test(id)) {
12060: if (form.elements[i].type == 'radio') {
12061: form.elements[i].checked = true;
1.1056 raeburn 12062: var nostart = i-$startcount;
1.1059 raeburn 12063: var offset = nostart%7;
12064: var count = (nostart-offset)/7;
1.1056 raeburn 12065: dependencyCheck(form,count,offset);
1.1055 raeburn 12066: }
12067: }
12068: }
12069: }
12070: }
12071:
12072: function propagateCheck(form,count) {
12073: if (count > 0) {
1.1059 raeburn 12074: var startelement = $startcount + ((count-1) * 7);
12075: for (var j=1; j<6; j++) {
12076: if ((j != 2) && (j != 4)) {
1.1056 raeburn 12077: var item = startelement + j;
12078: if (form.elements[item].type == 'radio') {
12079: if (form.elements[item].checked) {
12080: containerCheck(form,count,j);
12081: break;
12082: }
1.1055 raeburn 12083: }
12084: }
12085: }
12086: }
12087: }
12088:
12089: numitems = $numitems
1.1056 raeburn 12090: var titles = new Array(numitems);
12091: var parents = new Array(numitems);
1.1055 raeburn 12092: for (var i=0; i<numitems; i++) {
1.1056 raeburn 12093: parents[i] = new Array;
1.1055 raeburn 12094: }
1.1059 raeburn 12095: var maintitle = '$maintitle';
1.1055 raeburn 12096:
12097: START
12098:
1.1056 raeburn 12099: foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
12100: my @contents = split(/:/,$children->{$container});
1.1055 raeburn 12101: for (my $i=0; $i<@contents; $i ++) {
12102: $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
12103: }
12104: }
12105:
1.1056 raeburn 12106: foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
12107: $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
12108: }
12109:
1.1055 raeburn 12110: $scripttag .= <<END;
12111:
12112: function containerCheck(form,count,offset) {
12113: if (count > 0) {
1.1056 raeburn 12114: dependencyCheck(form,count,offset);
1.1059 raeburn 12115: var item = (offset+$startcount)+7*(count-1);
1.1055 raeburn 12116: form.elements[item].checked = true;
12117: if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
12118: if (parents[count].length > 0) {
12119: for (var j=0; j<parents[count].length; j++) {
1.1056 raeburn 12120: containerCheck(form,parents[count][j],offset);
12121: }
12122: }
12123: }
12124: }
12125: }
12126:
12127: function dependencyCheck(form,count,offset) {
12128: if (count > 0) {
1.1059 raeburn 12129: var chosen = (offset+$startcount)+7*(count-1);
12130: var depitem = $startcount + ((count-1) * 7) + 4;
1.1056 raeburn 12131: var currtype = form.elements[depitem].type;
12132: if (form.elements[chosen].value == 'dependency') {
12133: document.getElementById('arc_depon_'+count).style.display='block';
12134: form.elements[depitem].options.length = 0;
12135: form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1085 raeburn 12136: for (var i=1; i<=numitems; i++) {
12137: if (i == count) {
12138: continue;
12139: }
1.1059 raeburn 12140: var startelement = $startcount + (i-1) * 7;
12141: for (var j=1; j<6; j++) {
12142: if ((j != 2) && (j!= 4)) {
1.1056 raeburn 12143: var item = startelement + j;
12144: if (form.elements[item].type == 'radio') {
12145: if (form.elements[item].checked) {
12146: if (form.elements[item].value == 'display') {
12147: var n = form.elements[depitem].options.length;
12148: form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
12149: }
12150: }
12151: }
12152: }
12153: }
12154: }
12155: } else {
12156: document.getElementById('arc_depon_'+count).style.display='none';
12157: form.elements[depitem].options.length = 0;
12158: form.elements[depitem].options[0] = new Option('Select','',true,true);
12159: }
1.1059 raeburn 12160: titleCheck(form,count,offset);
1.1056 raeburn 12161: }
12162: }
12163:
12164: function propagateSelect(form,count,offset) {
12165: if (count > 0) {
1.1065 raeburn 12166: var item = (1+offset+$startcount)+7*(count-1);
1.1056 raeburn 12167: var picked = form.elements[item].options[form.elements[item].selectedIndex].value;
12168: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
12169: if (parents[count].length > 0) {
12170: for (var j=0; j<parents[count].length; j++) {
12171: containerSelect(form,parents[count][j],offset,picked);
1.1055 raeburn 12172: }
12173: }
12174: }
12175: }
12176: }
1.1056 raeburn 12177:
12178: function containerSelect(form,count,offset,picked) {
12179: if (count > 0) {
1.1065 raeburn 12180: var item = (offset+$startcount)+7*(count-1);
1.1056 raeburn 12181: if (form.elements[item].type == 'radio') {
12182: if (form.elements[item].value == 'dependency') {
12183: if (form.elements[item+1].type == 'select-one') {
12184: for (var i=0; i<form.elements[item+1].options.length; i++) {
12185: if (form.elements[item+1].options[i].value == picked) {
12186: form.elements[item+1].selectedIndex = i;
12187: break;
12188: }
12189: }
12190: }
12191: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
12192: if (parents[count].length > 0) {
12193: for (var j=0; j<parents[count].length; j++) {
12194: containerSelect(form,parents[count][j],offset,picked);
12195: }
12196: }
12197: }
12198: }
12199: }
12200: }
12201: }
12202:
1.1059 raeburn 12203: function titleCheck(form,count,offset) {
12204: if (count > 0) {
12205: var chosen = (offset+$startcount)+7*(count-1);
12206: var depitem = $startcount + ((count-1) * 7) + 2;
12207: var currtype = form.elements[depitem].type;
12208: if (form.elements[chosen].value == 'display') {
12209: document.getElementById('arc_title_'+count).style.display='block';
12210: if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
12211: document.getElementById('archive_title_'+count).value=maintitle;
12212: }
12213: } else {
12214: document.getElementById('arc_title_'+count).style.display='none';
12215: if (currtype == 'text') {
12216: document.getElementById('archive_title_'+count).value='';
12217: }
12218: }
12219: }
12220: return;
12221: }
12222:
1.1055 raeburn 12223: // ]]>
12224: </script>
12225: END
12226: return $scripttag;
12227: }
12228:
12229: sub process_extracted_files {
1.1067 raeburn 12230: my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055 raeburn 12231: my $numitems = $env{'form.archive_count'};
12232: return unless ($numitems);
12233: my @ids=&Apache::lonnet::current_machine_ids();
12234: my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067 raeburn 12235: %folders,%containers,%mapinner,%prompttofetch);
1.1055 raeburn 12236: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
12237: if (grep(/^\Q$docuhome\E$/,@ids)) {
12238: $prefix = &LONCAPA::propath($docudom,$docuname);
12239: $pathtocheck = "$dir_root/$destination";
12240: $dir = $dir_root;
12241: $ishome = 1;
12242: } else {
12243: $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
12244: $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
12245: $dir = "$dir_root/$docudom/$docuname";
12246: }
12247: my $currdir = "$dir_root/$destination";
12248: (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
12249: if ($env{'form.folderpath'}) {
12250: my @items = split('&',$env{'form.folderpath'});
12251: $folders{'0'} = $items[-2];
1.1099 raeburn 12252: if ($env{'form.folderpath'} =~ /\:1$/) {
12253: $containers{'0'}='page';
12254: } else {
12255: $containers{'0'}='sequence';
12256: }
1.1055 raeburn 12257: }
12258: my @archdirs = &get_env_multiple('form.archive_directory');
12259: if ($numitems) {
12260: for (my $i=1; $i<=$numitems; $i++) {
12261: my $path = $env{'form.archive_content_'.$i};
12262: if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
12263: my $item = $1;
12264: $toplevelitems{$item} = $i;
12265: if (grep(/^\Q$i\E$/,@archdirs)) {
12266: $is_dir{$item} = 1;
12267: }
12268: }
12269: }
12270: }
1.1067 raeburn 12271: my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055 raeburn 12272: if (keys(%toplevelitems) > 0) {
12273: my @contents = sort(keys(%toplevelitems));
1.1056 raeburn 12274: (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
12275: \%parent,\@contents,\%dirorder,\%titles);
1.1055 raeburn 12276: }
1.1066 raeburn 12277: my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055 raeburn 12278: if ($numitems) {
12279: for (my $i=1; $i<=$numitems; $i++) {
1.1086 raeburn 12280: next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055 raeburn 12281: my $path = $env{'form.archive_content_'.$i};
12282: if ($path =~ /^\Q$pathtocheck\E/) {
12283: if ($env{'form.archive_'.$i} eq 'discard') {
12284: if ($prefix ne '' && $path ne '') {
12285: if (-e $prefix.$path) {
1.1066 raeburn 12286: if ((@archdirs > 0) &&
12287: (grep(/^\Q$i\E$/,@archdirs))) {
12288: $todeletedir{$prefix.$path} = 1;
12289: } else {
12290: $todelete{$prefix.$path} = 1;
12291: }
1.1055 raeburn 12292: }
12293: }
12294: } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059 raeburn 12295: my ($docstitle,$title,$url,$outer);
1.1055 raeburn 12296: ($title) = ($path =~ m{/([^/]+)$});
1.1059 raeburn 12297: $docstitle = $env{'form.archive_title_'.$i};
12298: if ($docstitle eq '') {
12299: $docstitle = $title;
12300: }
1.1055 raeburn 12301: $outer = 0;
1.1056 raeburn 12302: if (ref($dirorder{$i}) eq 'ARRAY') {
12303: if (@{$dirorder{$i}} > 0) {
12304: foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055 raeburn 12305: if ($env{'form.archive_'.$item} eq 'display') {
12306: $outer = $item;
12307: last;
12308: }
12309: }
12310: }
12311: }
12312: my ($errtext,$fatal) =
12313: &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
12314: '/'.$folders{$outer}.'.'.
12315: $containers{$outer});
12316: next if ($fatal);
12317: if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
12318: if ($context eq 'coursedocs') {
1.1056 raeburn 12319: $mapinner{$i} = time;
1.1055 raeburn 12320: $folders{$i} = 'default_'.$mapinner{$i};
12321: $containers{$i} = 'sequence';
12322: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
12323: $folders{$i}.'.'.$containers{$i};
12324: my $newidx = &LONCAPA::map::getresidx();
12325: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 12326: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 12327: push(@LONCAPA::map::order,$newidx);
12328: my ($outtext,$errtext) =
12329: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
12330: $docuname.'/'.$folders{$outer}.
1.1087 raeburn 12331: '.'.$containers{$outer},1,1);
1.1056 raeburn 12332: $newseqid{$i} = $newidx;
1.1067 raeburn 12333: unless ($errtext) {
12334: $result .= '<li>'.&mt('Folder: [_1] added to course',$docstitle).'</li>'."\n";
12335: }
1.1055 raeburn 12336: }
12337: } else {
12338: if ($context eq 'coursedocs') {
12339: my $newidx=&LONCAPA::map::getresidx();
12340: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
12341: $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
12342: $title;
12343: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
12344: mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
12345: }
12346: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
12347: mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
12348: }
12349: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
12350: system("mv $prefix$path $prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title");
1.1056 raeburn 12351: $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
1.1067 raeburn 12352: unless ($ishome) {
12353: my $fetch = "$newdest{$i}/$title";
12354: $fetch =~ s/^\Q$prefix$dir\E//;
12355: $prompttofetch{$fetch} = 1;
12356: }
1.1055 raeburn 12357: }
12358: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 12359: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 12360: push(@LONCAPA::map::order, $newidx);
12361: my ($outtext,$errtext)=
12362: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
12363: $docuname.'/'.$folders{$outer}.
1.1087 raeburn 12364: '.'.$containers{$outer},1,1);
1.1067 raeburn 12365: unless ($errtext) {
12366: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
12367: $result .= '<li>'.&mt('File: [_1] added to course',$docstitle).'</li>'."\n";
12368: }
12369: }
1.1055 raeburn 12370: }
12371: }
1.1086 raeburn 12372: }
12373: } else {
12374: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',$path).'<br />';
12375: }
12376: }
12377: for (my $i=1; $i<=$numitems; $i++) {
12378: next unless ($env{'form.archive_'.$i} eq 'dependency');
12379: my $path = $env{'form.archive_content_'.$i};
12380: if ($path =~ /^\Q$pathtocheck\E/) {
12381: my ($title) = ($path =~ m{/([^/]+)$});
12382: $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
12383: if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
12384: if (ref($dirorder{$i}) eq 'ARRAY') {
12385: my ($itemidx,$fullpath,$relpath);
12386: if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
12387: my $container = $dirorder{$referrer{$i}}->[-1];
1.1056 raeburn 12388: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1086 raeburn 12389: if ($dirorder{$i}->[$j] eq $container) {
12390: $itemidx = $j;
1.1056 raeburn 12391: }
12392: }
1.1086 raeburn 12393: }
12394: if ($itemidx eq '') {
12395: $itemidx = 0;
12396: }
12397: if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
12398: if ($mapinner{$referrer{$i}}) {
12399: $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
12400: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
12401: if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
12402: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
12403: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
12404: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
12405: if (!-e $fullpath) {
12406: mkdir($fullpath,0755);
1.1056 raeburn 12407: }
12408: }
1.1086 raeburn 12409: } else {
12410: last;
1.1056 raeburn 12411: }
1.1086 raeburn 12412: }
12413: }
12414: } elsif ($newdest{$referrer{$i}}) {
12415: $fullpath = $newdest{$referrer{$i}};
12416: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
12417: if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
12418: $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
12419: last;
12420: } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
12421: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
12422: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
12423: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
12424: if (!-e $fullpath) {
12425: mkdir($fullpath,0755);
1.1056 raeburn 12426: }
12427: }
1.1086 raeburn 12428: } else {
12429: last;
1.1056 raeburn 12430: }
1.1055 raeburn 12431: }
12432: }
1.1086 raeburn 12433: if ($fullpath ne '') {
12434: if (-e "$prefix$path") {
12435: system("mv $prefix$path $fullpath/$title");
12436: }
12437: if (-e "$fullpath/$title") {
12438: my $showpath;
12439: if ($relpath ne '') {
12440: $showpath = "$relpath/$title";
12441: } else {
12442: $showpath = "/$title";
12443: }
12444: $result .= '<li>'.&mt('[_1] included as a dependency',$showpath).'</li>'."\n";
12445: }
12446: unless ($ishome) {
12447: my $fetch = "$fullpath/$title";
12448: $fetch =~ s/^\Q$prefix$dir\E//;
12449: $prompttofetch{$fetch} = 1;
12450: }
12451: }
1.1055 raeburn 12452: }
1.1086 raeburn 12453: } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
12454: $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
12455: $path,$env{'form.archive_content_'.$referrer{$i}}).'<br />';
1.1055 raeburn 12456: }
12457: } else {
12458: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',$path).'<br />';
12459: }
12460: }
12461: if (keys(%todelete)) {
12462: foreach my $key (keys(%todelete)) {
12463: unlink($key);
1.1066 raeburn 12464: }
12465: }
12466: if (keys(%todeletedir)) {
12467: foreach my $key (keys(%todeletedir)) {
12468: rmdir($key);
12469: }
12470: }
12471: foreach my $dir (sort(keys(%is_dir))) {
12472: if (($pathtocheck ne '') && ($dir ne '')) {
12473: &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055 raeburn 12474: }
12475: }
1.1067 raeburn 12476: if ($result ne '') {
12477: $output .= '<ul>'."\n".
12478: $result."\n".
12479: '</ul>';
12480: }
12481: unless ($ishome) {
12482: my $replicationfail;
12483: foreach my $item (keys(%prompttofetch)) {
12484: my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
12485: unless ($fetchresult eq 'ok') {
12486: $replicationfail .= '<li>'.$item.'</li>'."\n";
12487: }
12488: }
12489: if ($replicationfail) {
12490: $output .= '<p class="LC_error">'.
12491: &mt('Course home server failed to retrieve:').'<ul>'.
12492: $replicationfail.
12493: '</ul></p>';
12494: }
12495: }
1.1055 raeburn 12496: } else {
12497: $warning = &mt('No items found in archive.');
12498: }
12499: if ($error) {
12500: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
12501: $error.'</p>'."\n";
12502: }
12503: if ($warning) {
12504: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
12505: }
12506: return $output;
12507: }
12508:
1.1066 raeburn 12509: sub cleanup_empty_dirs {
12510: my ($path) = @_;
12511: if (($path ne '') && (-d $path)) {
12512: if (opendir(my $dirh,$path)) {
12513: my @dircontents = grep(!/^\./,readdir($dirh));
12514: my $numitems = 0;
12515: foreach my $item (@dircontents) {
12516: if (-d "$path/$item") {
1.1111 raeburn 12517: &cleanup_empty_dirs("$path/$item");
1.1066 raeburn 12518: if (-e "$path/$item") {
12519: $numitems ++;
12520: }
12521: } else {
12522: $numitems ++;
12523: }
12524: }
12525: if ($numitems == 0) {
12526: rmdir($path);
12527: }
12528: closedir($dirh);
12529: }
12530: }
12531: return;
12532: }
12533:
1.41 ng 12534: =pod
1.45 matthew 12535:
1.1162 raeburn 12536: =item * &get_folder_hierarchy()
1.1068 raeburn 12537:
12538: Provides hierarchy of names of folders/sub-folders containing the current
12539: item,
12540:
12541: Inputs: 3
12542: - $navmap - navmaps object
12543:
12544: - $map - url for map (either the trigger itself, or map containing
12545: the resource, which is the trigger).
12546:
12547: - $showitem - 1 => show title for map itself; 0 => do not show.
12548:
12549: Outputs: 1 @pathitems - array of folder/subfolder names.
12550:
12551: =cut
12552:
12553: sub get_folder_hierarchy {
12554: my ($navmap,$map,$showitem) = @_;
12555: my @pathitems;
12556: if (ref($navmap)) {
12557: my $mapres = $navmap->getResourceByUrl($map);
12558: if (ref($mapres)) {
12559: my $pcslist = $mapres->map_hierarchy();
12560: if ($pcslist ne '') {
12561: my @pcs = split(/,/,$pcslist);
12562: foreach my $pc (@pcs) {
12563: if ($pc == 1) {
1.1129 raeburn 12564: push(@pathitems,&mt('Main Content'));
1.1068 raeburn 12565: } else {
12566: my $res = $navmap->getByMapPc($pc);
12567: if (ref($res)) {
12568: my $title = $res->compTitle();
12569: $title =~ s/\W+/_/g;
12570: if ($title ne '') {
12571: push(@pathitems,$title);
12572: }
12573: }
12574: }
12575: }
12576: }
1.1071 raeburn 12577: if ($showitem) {
12578: if ($mapres->{ID} eq '0.0') {
1.1129 raeburn 12579: push(@pathitems,&mt('Main Content'));
1.1071 raeburn 12580: } else {
12581: my $maptitle = $mapres->compTitle();
12582: $maptitle =~ s/\W+/_/g;
12583: if ($maptitle ne '') {
12584: push(@pathitems,$maptitle);
12585: }
1.1068 raeburn 12586: }
12587: }
12588: }
12589: }
12590: return @pathitems;
12591: }
12592:
12593: =pod
12594:
1.1015 raeburn 12595: =item * &get_turnedin_filepath()
12596:
12597: Determines path in a user's portfolio file for storage of files uploaded
12598: to a specific essayresponse or dropbox item.
12599:
12600: Inputs: 3 required + 1 optional.
12601: $symb is symb for resource, $uname and $udom are for current user (required).
12602: $caller is optional (can be "submission", if routine is called when storing
12603: an upoaded file when "Submit Answer" button was pressed).
12604:
12605: Returns array containing $path and $multiresp.
12606: $path is path in portfolio. $multiresp is 1 if this resource contains more
12607: than one file upload item. Callers of routine should append partid as a
12608: subdirectory to $path in cases where $multiresp is 1.
12609:
12610: Called by: homework/essayresponse.pm and homework/structuretags.pm
12611:
12612: =cut
12613:
12614: sub get_turnedin_filepath {
12615: my ($symb,$uname,$udom,$caller) = @_;
12616: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
12617: my $turnindir;
12618: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
12619: $turnindir = $userhash{'turnindir'};
12620: my ($path,$multiresp);
12621: if ($turnindir eq '') {
12622: if ($caller eq 'submission') {
12623: $turnindir = &mt('turned in');
12624: $turnindir =~ s/\W+/_/g;
12625: my %newhash = (
12626: 'turnindir' => $turnindir,
12627: );
12628: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
12629: }
12630: }
12631: if ($turnindir ne '') {
12632: $path = '/'.$turnindir.'/';
12633: my ($multipart,$turnin,@pathitems);
12634: my $navmap = Apache::lonnavmaps::navmap->new();
12635: if (defined($navmap)) {
12636: my $mapres = $navmap->getResourceByUrl($map);
12637: if (ref($mapres)) {
12638: my $pcslist = $mapres->map_hierarchy();
12639: if ($pcslist ne '') {
12640: foreach my $pc (split(/,/,$pcslist)) {
12641: my $res = $navmap->getByMapPc($pc);
12642: if (ref($res)) {
12643: my $title = $res->compTitle();
12644: $title =~ s/\W+/_/g;
12645: if ($title ne '') {
1.1149 raeburn 12646: if (($pc > 1) && (length($title) > 12)) {
12647: $title = substr($title,0,12);
12648: }
1.1015 raeburn 12649: push(@pathitems,$title);
12650: }
12651: }
12652: }
12653: }
12654: my $maptitle = $mapres->compTitle();
12655: $maptitle =~ s/\W+/_/g;
12656: if ($maptitle ne '') {
1.1149 raeburn 12657: if (length($maptitle) > 12) {
12658: $maptitle = substr($maptitle,0,12);
12659: }
1.1015 raeburn 12660: push(@pathitems,$maptitle);
12661: }
12662: unless ($env{'request.state'} eq 'construct') {
12663: my $res = $navmap->getBySymb($symb);
12664: if (ref($res)) {
12665: my $partlist = $res->parts();
12666: my $totaluploads = 0;
12667: if (ref($partlist) eq 'ARRAY') {
12668: foreach my $part (@{$partlist}) {
12669: my @types = $res->responseType($part);
12670: my @ids = $res->responseIds($part);
12671: for (my $i=0; $i < scalar(@ids); $i++) {
12672: if ($types[$i] eq 'essay') {
12673: my $partid = $part.'_'.$ids[$i];
12674: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
12675: $totaluploads ++;
12676: }
12677: }
12678: }
12679: }
12680: if ($totaluploads > 1) {
12681: $multiresp = 1;
12682: }
12683: }
12684: }
12685: }
12686: } else {
12687: return;
12688: }
12689: } else {
12690: return;
12691: }
12692: my $restitle=&Apache::lonnet::gettitle($symb);
12693: $restitle =~ s/\W+/_/g;
12694: if ($restitle eq '') {
12695: $restitle = ($resurl =~ m{/[^/]+$});
12696: if ($restitle eq '') {
12697: $restitle = time;
12698: }
12699: }
1.1149 raeburn 12700: if (length($restitle) > 12) {
12701: $restitle = substr($restitle,0,12);
12702: }
1.1015 raeburn 12703: push(@pathitems,$restitle);
12704: $path .= join('/',@pathitems);
12705: }
12706: return ($path,$multiresp);
12707: }
12708:
12709: =pod
12710:
1.464 albertel 12711: =back
1.41 ng 12712:
1.112 bowersj2 12713: =head1 CSV Upload/Handling functions
1.38 albertel 12714:
1.41 ng 12715: =over 4
12716:
1.648 raeburn 12717: =item * &upfile_store($r)
1.41 ng 12718:
12719: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 12720: needs $env{'form.upfile'}
1.41 ng 12721: returns $datatoken to be put into hidden field
12722:
12723: =cut
1.31 albertel 12724:
12725: sub upfile_store {
12726: my $r=shift;
1.258 albertel 12727: $env{'form.upfile'}=~s/\r/\n/gs;
12728: $env{'form.upfile'}=~s/\f/\n/gs;
12729: $env{'form.upfile'}=~s/\n+/\n/gs;
12730: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 12731:
1.258 albertel 12732: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
12733: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 12734: {
1.158 raeburn 12735: my $datafile = $r->dir_config('lonDaemons').
12736: '/tmp/'.$datatoken.'.tmp';
12737: if ( open(my $fh,">$datafile") ) {
1.258 albertel 12738: print $fh $env{'form.upfile'};
1.158 raeburn 12739: close($fh);
12740: }
1.31 albertel 12741: }
12742: return $datatoken;
12743: }
12744:
1.56 matthew 12745: =pod
12746:
1.648 raeburn 12747: =item * &load_tmp_file($r)
1.41 ng 12748:
12749: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 12750: needs $env{'form.datatoken'},
12751: sets $env{'form.upfile'} to the contents of the file
1.41 ng 12752:
12753: =cut
1.31 albertel 12754:
12755: sub load_tmp_file {
12756: my $r=shift;
12757: my @studentdata=();
12758: {
1.158 raeburn 12759: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 12760: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 12761: if ( open(my $fh,"<$studentfile") ) {
12762: @studentdata=<$fh>;
12763: close($fh);
12764: }
1.31 albertel 12765: }
1.258 albertel 12766: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 12767: }
12768:
1.56 matthew 12769: =pod
12770:
1.648 raeburn 12771: =item * &upfile_record_sep()
1.41 ng 12772:
12773: Separate uploaded file into records
12774: returns array of records,
1.258 albertel 12775: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 12776:
12777: =cut
1.31 albertel 12778:
12779: sub upfile_record_sep {
1.258 albertel 12780: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 12781: } else {
1.248 albertel 12782: my @records;
1.258 albertel 12783: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 12784: if ($line=~/^\s*$/) { next; }
12785: push(@records,$line);
12786: }
12787: return @records;
1.31 albertel 12788: }
12789: }
12790:
1.56 matthew 12791: =pod
12792:
1.648 raeburn 12793: =item * &record_sep($record)
1.41 ng 12794:
1.258 albertel 12795: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 12796:
12797: =cut
12798:
1.263 www 12799: sub takeleft {
12800: my $index=shift;
12801: return substr('0000'.$index,-4,4);
12802: }
12803:
1.31 albertel 12804: sub record_sep {
12805: my $record=shift;
12806: my %components=();
1.258 albertel 12807: if ($env{'form.upfiletype'} eq 'xml') {
12808: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 12809: my $i=0;
1.356 albertel 12810: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 12811: $field=~s/^(\"|\')//;
12812: $field=~s/(\"|\')$//;
1.263 www 12813: $components{&takeleft($i)}=$field;
1.31 albertel 12814: $i++;
12815: }
1.258 albertel 12816: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 12817: my $i=0;
1.356 albertel 12818: foreach my $field (split(/\t/,$record)) {
1.31 albertel 12819: $field=~s/^(\"|\')//;
12820: $field=~s/(\"|\')$//;
1.263 www 12821: $components{&takeleft($i)}=$field;
1.31 albertel 12822: $i++;
12823: }
12824: } else {
1.561 www 12825: my $separator=',';
1.480 banghart 12826: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 12827: $separator=';';
1.480 banghart 12828: }
1.31 albertel 12829: my $i=0;
1.561 www 12830: # the character we are looking for to indicate the end of a quote or a record
12831: my $looking_for=$separator;
12832: # do not add the characters to the fields
12833: my $ignore=0;
12834: # we just encountered a separator (or the beginning of the record)
12835: my $just_found_separator=1;
12836: # store the field we are working on here
12837: my $field='';
12838: # work our way through all characters in record
12839: foreach my $character ($record=~/(.)/g) {
12840: if ($character eq $looking_for) {
12841: if ($character ne $separator) {
12842: # Found the end of a quote, again looking for separator
12843: $looking_for=$separator;
12844: $ignore=1;
12845: } else {
12846: # Found a separator, store away what we got
12847: $components{&takeleft($i)}=$field;
12848: $i++;
12849: $just_found_separator=1;
12850: $ignore=0;
12851: $field='';
12852: }
12853: next;
12854: }
12855: # single or double quotation marks after a separator indicate beginning of a quote
12856: # we are now looking for the end of the quote and need to ignore separators
12857: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
12858: $looking_for=$character;
12859: next;
12860: }
12861: # ignore would be true after we reached the end of a quote
12862: if ($ignore) { next; }
12863: if (($just_found_separator) && ($character=~/\s/)) { next; }
12864: $field.=$character;
12865: $just_found_separator=0;
1.31 albertel 12866: }
1.561 www 12867: # catch the very last entry, since we never encountered the separator
12868: $components{&takeleft($i)}=$field;
1.31 albertel 12869: }
12870: return %components;
12871: }
12872:
1.144 matthew 12873: ######################################################
12874: ######################################################
12875:
1.56 matthew 12876: =pod
12877:
1.648 raeburn 12878: =item * &upfile_select_html()
1.41 ng 12879:
1.144 matthew 12880: Return HTML code to select a file from the users machine and specify
12881: the file type.
1.41 ng 12882:
12883: =cut
12884:
1.144 matthew 12885: ######################################################
12886: ######################################################
1.31 albertel 12887: sub upfile_select_html {
1.144 matthew 12888: my %Types = (
12889: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 12890: semisv => &mt('Semicolon separated values'),
1.144 matthew 12891: space => &mt('Space separated'),
12892: tab => &mt('Tabulator separated'),
12893: # xml => &mt('HTML/XML'),
12894: );
12895: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 12896: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 12897: foreach my $type (sort(keys(%Types))) {
12898: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
12899: }
12900: $Str .= "</select>\n";
12901: return $Str;
1.31 albertel 12902: }
12903:
1.301 albertel 12904: sub get_samples {
12905: my ($records,$toget) = @_;
12906: my @samples=({});
12907: my $got=0;
12908: foreach my $rec (@$records) {
12909: my %temp = &record_sep($rec);
12910: if (! grep(/\S/, values(%temp))) { next; }
12911: if (%temp) {
12912: $samples[$got]=\%temp;
12913: $got++;
12914: if ($got == $toget) { last; }
12915: }
12916: }
12917: return \@samples;
12918: }
12919:
1.144 matthew 12920: ######################################################
12921: ######################################################
12922:
1.56 matthew 12923: =pod
12924:
1.648 raeburn 12925: =item * &csv_print_samples($r,$records)
1.41 ng 12926:
12927: Prints a table of sample values from each column uploaded $r is an
12928: Apache Request ref, $records is an arrayref from
12929: &Apache::loncommon::upfile_record_sep
12930:
12931: =cut
12932:
1.144 matthew 12933: ######################################################
12934: ######################################################
1.31 albertel 12935: sub csv_print_samples {
12936: my ($r,$records) = @_;
1.662 bisitz 12937: my $samples = &get_samples($records,5);
1.301 albertel 12938:
1.594 raeburn 12939: $r->print(&mt('Samples').'<br />'.&start_data_table().
12940: &start_data_table_header_row());
1.356 albertel 12941: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 12942: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 12943: $r->print(&end_data_table_header_row());
1.301 albertel 12944: foreach my $hash (@$samples) {
1.594 raeburn 12945: $r->print(&start_data_table_row());
1.356 albertel 12946: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 12947: $r->print('<td>');
1.356 albertel 12948: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 12949: $r->print('</td>');
12950: }
1.594 raeburn 12951: $r->print(&end_data_table_row());
1.31 albertel 12952: }
1.594 raeburn 12953: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 12954: }
12955:
1.144 matthew 12956: ######################################################
12957: ######################################################
12958:
1.56 matthew 12959: =pod
12960:
1.648 raeburn 12961: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 12962:
12963: Prints a table to create associations between values and table columns.
1.144 matthew 12964:
1.41 ng 12965: $r is an Apache Request ref,
12966: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 12967: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 12968:
12969: =cut
12970:
1.144 matthew 12971: ######################################################
12972: ######################################################
1.31 albertel 12973: sub csv_print_select_table {
12974: my ($r,$records,$d) = @_;
1.301 albertel 12975: my $i=0;
12976: my $samples = &get_samples($records,1);
1.144 matthew 12977: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 12978: &start_data_table().&start_data_table_header_row().
1.144 matthew 12979: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 12980: '<th>'.&mt('Column').'</th>'.
12981: &end_data_table_header_row()."\n");
1.356 albertel 12982: foreach my $array_ref (@$d) {
12983: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 12984: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 12985:
1.875 bisitz 12986: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 12987: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 12988: $r->print('<option value="none"></option>');
1.356 albertel 12989: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
12990: $r->print('<option value="'.$sample.'"'.
12991: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 12992: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 12993: }
1.594 raeburn 12994: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 12995: $i++;
12996: }
1.594 raeburn 12997: $r->print(&end_data_table());
1.31 albertel 12998: $i--;
12999: return $i;
13000: }
1.56 matthew 13001:
1.144 matthew 13002: ######################################################
13003: ######################################################
13004:
1.56 matthew 13005: =pod
1.31 albertel 13006:
1.648 raeburn 13007: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 13008:
13009: Prints a table of sample values from the upload and can make associate samples to internal names.
13010:
13011: $r is an Apache Request ref,
13012: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
13013: $d is an array of 2 element arrays (internal name, displayed name)
13014:
13015: =cut
13016:
1.144 matthew 13017: ######################################################
13018: ######################################################
1.31 albertel 13019: sub csv_samples_select_table {
13020: my ($r,$records,$d) = @_;
13021: my $i=0;
1.144 matthew 13022: #
1.662 bisitz 13023: my $max_samples = 5;
13024: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 13025: $r->print(&start_data_table().
13026: &start_data_table_header_row().'<th>'.
13027: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
13028: &end_data_table_header_row());
1.301 albertel 13029:
13030: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 13031: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 13032: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 13033: foreach my $option (@$d) {
13034: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 13035: $r->print('<option value="'.$value.'"'.
1.253 albertel 13036: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 13037: $display.'</option>');
1.31 albertel 13038: }
13039: $r->print('</select></td><td>');
1.662 bisitz 13040: foreach my $line (0..($max_samples-1)) {
1.301 albertel 13041: if (defined($samples->[$line]{$key})) {
13042: $r->print($samples->[$line]{$key}."<br />\n");
13043: }
13044: }
1.594 raeburn 13045: $r->print('</td>'.&end_data_table_row());
1.31 albertel 13046: $i++;
13047: }
1.594 raeburn 13048: $r->print(&end_data_table());
1.31 albertel 13049: $i--;
13050: return($i);
1.115 matthew 13051: }
13052:
1.144 matthew 13053: ######################################################
13054: ######################################################
13055:
1.115 matthew 13056: =pod
13057:
1.648 raeburn 13058: =item * &clean_excel_name($name)
1.115 matthew 13059:
13060: Returns a replacement for $name which does not contain any illegal characters.
13061:
13062: =cut
13063:
1.144 matthew 13064: ######################################################
13065: ######################################################
1.115 matthew 13066: sub clean_excel_name {
13067: my ($name) = @_;
13068: $name =~ s/[:\*\?\/\\]//g;
13069: if (length($name) > 31) {
13070: $name = substr($name,0,31);
13071: }
13072: return $name;
1.25 albertel 13073: }
1.84 albertel 13074:
1.85 albertel 13075: =pod
13076:
1.648 raeburn 13077: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 13078:
13079: Returns either 1 or undef
13080:
13081: 1 if the part is to be hidden, undef if it is to be shown
13082:
13083: Arguments are:
13084:
13085: $id the id of the part to be checked
13086: $symb, optional the symb of the resource to check
13087: $udom, optional the domain of the user to check for
13088: $uname, optional the username of the user to check for
13089:
13090: =cut
1.84 albertel 13091:
13092: sub check_if_partid_hidden {
13093: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 13094: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 13095: $symb,$udom,$uname);
1.141 albertel 13096: my $truth=1;
13097: #if the string starts with !, then the list is the list to show not hide
13098: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 13099: my @hiddenlist=split(/,/,$hiddenparts);
13100: foreach my $checkid (@hiddenlist) {
1.141 albertel 13101: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 13102: }
1.141 albertel 13103: return !$truth;
1.84 albertel 13104: }
1.127 matthew 13105:
1.138 matthew 13106:
13107: ############################################################
13108: ############################################################
13109:
13110: =pod
13111:
1.157 matthew 13112: =back
13113:
1.138 matthew 13114: =head1 cgi-bin script and graphing routines
13115:
1.157 matthew 13116: =over 4
13117:
1.648 raeburn 13118: =item * &get_cgi_id()
1.138 matthew 13119:
13120: Inputs: none
13121:
13122: Returns an id which can be used to pass environment variables
13123: to various cgi-bin scripts. These environment variables will
13124: be removed from the users environment after a given time by
13125: the routine &Apache::lonnet::transfer_profile_to_env.
13126:
13127: =cut
13128:
13129: ############################################################
13130: ############################################################
1.152 albertel 13131: my $uniq=0;
1.136 matthew 13132: sub get_cgi_id {
1.154 albertel 13133: $uniq=($uniq+1)%100000;
1.280 albertel 13134: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 13135: }
13136:
1.127 matthew 13137: ############################################################
13138: ############################################################
13139:
13140: =pod
13141:
1.648 raeburn 13142: =item * &DrawBarGraph()
1.127 matthew 13143:
1.138 matthew 13144: Facilitates the plotting of data in a (stacked) bar graph.
13145: Puts plot definition data into the users environment in order for
13146: graph.png to plot it. Returns an <img> tag for the plot.
13147: The bars on the plot are labeled '1','2',...,'n'.
13148:
13149: Inputs:
13150:
13151: =over 4
13152:
13153: =item $Title: string, the title of the plot
13154:
13155: =item $xlabel: string, text describing the X-axis of the plot
13156:
13157: =item $ylabel: string, text describing the Y-axis of the plot
13158:
13159: =item $Max: scalar, the maximum Y value to use in the plot
13160: If $Max is < any data point, the graph will not be rendered.
13161:
1.140 matthew 13162: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 13163: they are plotted. If undefined, default values will be used.
13164:
1.178 matthew 13165: =item $labels: array ref holding the labels to use on the x-axis for the bars.
13166:
1.138 matthew 13167: =item @Values: An array of array references. Each array reference holds data
13168: to be plotted in a stacked bar chart.
13169:
1.239 matthew 13170: =item If the final element of @Values is a hash reference the key/value
13171: pairs will be added to the graph definition.
13172:
1.138 matthew 13173: =back
13174:
13175: Returns:
13176:
13177: An <img> tag which references graph.png and the appropriate identifying
13178: information for the plot.
13179:
1.127 matthew 13180: =cut
13181:
13182: ############################################################
13183: ############################################################
1.134 matthew 13184: sub DrawBarGraph {
1.178 matthew 13185: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 13186: #
13187: if (! defined($colors)) {
13188: $colors = ['#33ff00',
13189: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
13190: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
13191: ];
13192: }
1.228 matthew 13193: my $extra_settings = {};
13194: if (ref($Values[-1]) eq 'HASH') {
13195: $extra_settings = pop(@Values);
13196: }
1.127 matthew 13197: #
1.136 matthew 13198: my $identifier = &get_cgi_id();
13199: my $id = 'cgi.'.$identifier;
1.129 matthew 13200: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 13201: return '';
13202: }
1.225 matthew 13203: #
13204: my @Labels;
13205: if (defined($labels)) {
13206: @Labels = @$labels;
13207: } else {
13208: for (my $i=0;$i<@{$Values[0]};$i++) {
13209: push (@Labels,$i+1);
13210: }
13211: }
13212: #
1.129 matthew 13213: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 13214: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 13215: my %ValuesHash;
13216: my $NumSets=1;
13217: foreach my $array (@Values) {
13218: next if (! ref($array));
1.136 matthew 13219: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 13220: join(',',@$array);
1.129 matthew 13221: }
1.127 matthew 13222: #
1.136 matthew 13223: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 13224: if ($NumBars < 3) {
13225: $width = 120+$NumBars*32;
1.220 matthew 13226: $xskip = 1;
1.225 matthew 13227: $bar_width = 30;
13228: } elsif ($NumBars < 5) {
13229: $width = 120+$NumBars*20;
13230: $xskip = 1;
13231: $bar_width = 20;
1.220 matthew 13232: } elsif ($NumBars < 10) {
1.136 matthew 13233: $width = 120+$NumBars*15;
13234: $xskip = 1;
13235: $bar_width = 15;
13236: } elsif ($NumBars <= 25) {
13237: $width = 120+$NumBars*11;
13238: $xskip = 5;
13239: $bar_width = 8;
13240: } elsif ($NumBars <= 50) {
13241: $width = 120+$NumBars*8;
13242: $xskip = 5;
13243: $bar_width = 4;
13244: } else {
13245: $width = 120+$NumBars*8;
13246: $xskip = 5;
13247: $bar_width = 4;
13248: }
13249: #
1.137 matthew 13250: $Max = 1 if ($Max < 1);
13251: if ( int($Max) < $Max ) {
13252: $Max++;
13253: $Max = int($Max);
13254: }
1.127 matthew 13255: $Title = '' if (! defined($Title));
13256: $xlabel = '' if (! defined($xlabel));
13257: $ylabel = '' if (! defined($ylabel));
1.369 www 13258: $ValuesHash{$id.'.title'} = &escape($Title);
13259: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
13260: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 13261: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 13262: $ValuesHash{$id.'.NumBars'} = $NumBars;
13263: $ValuesHash{$id.'.NumSets'} = $NumSets;
13264: $ValuesHash{$id.'.PlotType'} = 'bar';
13265: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
13266: $ValuesHash{$id.'.height'} = $height;
13267: $ValuesHash{$id.'.width'} = $width;
13268: $ValuesHash{$id.'.xskip'} = $xskip;
13269: $ValuesHash{$id.'.bar_width'} = $bar_width;
13270: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 13271: #
1.228 matthew 13272: # Deal with other parameters
13273: while (my ($key,$value) = each(%$extra_settings)) {
13274: $ValuesHash{$id.'.'.$key} = $value;
13275: }
13276: #
1.646 raeburn 13277: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 13278: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
13279: }
13280:
13281: ############################################################
13282: ############################################################
13283:
13284: =pod
13285:
1.648 raeburn 13286: =item * &DrawXYGraph()
1.137 matthew 13287:
1.138 matthew 13288: Facilitates the plotting of data in an XY graph.
13289: Puts plot definition data into the users environment in order for
13290: graph.png to plot it. Returns an <img> tag for the plot.
13291:
13292: Inputs:
13293:
13294: =over 4
13295:
13296: =item $Title: string, the title of the plot
13297:
13298: =item $xlabel: string, text describing the X-axis of the plot
13299:
13300: =item $ylabel: string, text describing the Y-axis of the plot
13301:
13302: =item $Max: scalar, the maximum Y value to use in the plot
13303: If $Max is < any data point, the graph will not be rendered.
13304:
13305: =item $colors: Array ref containing the hex color codes for the data to be
13306: plotted in. If undefined, default values will be used.
13307:
13308: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
13309:
13310: =item $Ydata: Array ref containing Array refs.
1.185 www 13311: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 13312:
13313: =item %Values: hash indicating or overriding any default values which are
13314: passed to graph.png.
13315: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
13316:
13317: =back
13318:
13319: Returns:
13320:
13321: An <img> tag which references graph.png and the appropriate identifying
13322: information for the plot.
13323:
1.137 matthew 13324: =cut
13325:
13326: ############################################################
13327: ############################################################
13328: sub DrawXYGraph {
13329: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
13330: #
13331: # Create the identifier for the graph
13332: my $identifier = &get_cgi_id();
13333: my $id = 'cgi.'.$identifier;
13334: #
13335: $Title = '' if (! defined($Title));
13336: $xlabel = '' if (! defined($xlabel));
13337: $ylabel = '' if (! defined($ylabel));
13338: my %ValuesHash =
13339: (
1.369 www 13340: $id.'.title' => &escape($Title),
13341: $id.'.xlabel' => &escape($xlabel),
13342: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 13343: $id.'.y_max_value'=> $Max,
13344: $id.'.labels' => join(',',@$Xlabels),
13345: $id.'.PlotType' => 'XY',
13346: );
13347: #
13348: if (defined($colors) && ref($colors) eq 'ARRAY') {
13349: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
13350: }
13351: #
13352: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
13353: return '';
13354: }
13355: my $NumSets=1;
1.138 matthew 13356: foreach my $array (@{$Ydata}){
1.137 matthew 13357: next if (! ref($array));
13358: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
13359: }
1.138 matthew 13360: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 13361: #
13362: # Deal with other parameters
13363: while (my ($key,$value) = each(%Values)) {
13364: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 13365: }
13366: #
1.646 raeburn 13367: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 13368: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
13369: }
13370:
13371: ############################################################
13372: ############################################################
13373:
13374: =pod
13375:
1.648 raeburn 13376: =item * &DrawXYYGraph()
1.138 matthew 13377:
13378: Facilitates the plotting of data in an XY graph with two Y axes.
13379: Puts plot definition data into the users environment in order for
13380: graph.png to plot it. Returns an <img> tag for the plot.
13381:
13382: Inputs:
13383:
13384: =over 4
13385:
13386: =item $Title: string, the title of the plot
13387:
13388: =item $xlabel: string, text describing the X-axis of the plot
13389:
13390: =item $ylabel: string, text describing the Y-axis of the plot
13391:
13392: =item $colors: Array ref containing the hex color codes for the data to be
13393: plotted in. If undefined, default values will be used.
13394:
13395: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
13396:
13397: =item $Ydata1: The first data set
13398:
13399: =item $Min1: The minimum value of the left Y-axis
13400:
13401: =item $Max1: The maximum value of the left Y-axis
13402:
13403: =item $Ydata2: The second data set
13404:
13405: =item $Min2: The minimum value of the right Y-axis
13406:
13407: =item $Max2: The maximum value of the left Y-axis
13408:
13409: =item %Values: hash indicating or overriding any default values which are
13410: passed to graph.png.
13411: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
13412:
13413: =back
13414:
13415: Returns:
13416:
13417: An <img> tag which references graph.png and the appropriate identifying
13418: information for the plot.
1.136 matthew 13419:
13420: =cut
13421:
13422: ############################################################
13423: ############################################################
1.137 matthew 13424: sub DrawXYYGraph {
13425: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
13426: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 13427: #
13428: # Create the identifier for the graph
13429: my $identifier = &get_cgi_id();
13430: my $id = 'cgi.'.$identifier;
13431: #
13432: $Title = '' if (! defined($Title));
13433: $xlabel = '' if (! defined($xlabel));
13434: $ylabel = '' if (! defined($ylabel));
13435: my %ValuesHash =
13436: (
1.369 www 13437: $id.'.title' => &escape($Title),
13438: $id.'.xlabel' => &escape($xlabel),
13439: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 13440: $id.'.labels' => join(',',@$Xlabels),
13441: $id.'.PlotType' => 'XY',
13442: $id.'.NumSets' => 2,
1.137 matthew 13443: $id.'.two_axes' => 1,
13444: $id.'.y1_max_value' => $Max1,
13445: $id.'.y1_min_value' => $Min1,
13446: $id.'.y2_max_value' => $Max2,
13447: $id.'.y2_min_value' => $Min2,
1.136 matthew 13448: );
13449: #
1.137 matthew 13450: if (defined($colors) && ref($colors) eq 'ARRAY') {
13451: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
13452: }
13453: #
13454: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
13455: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 13456: return '';
13457: }
13458: my $NumSets=1;
1.137 matthew 13459: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 13460: next if (! ref($array));
13461: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 13462: }
13463: #
13464: # Deal with other parameters
13465: while (my ($key,$value) = each(%Values)) {
13466: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 13467: }
13468: #
1.646 raeburn 13469: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 13470: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 13471: }
13472:
13473: ############################################################
13474: ############################################################
13475:
13476: =pod
13477:
1.157 matthew 13478: =back
13479:
1.139 matthew 13480: =head1 Statistics helper routines?
13481:
13482: Bad place for them but what the hell.
13483:
1.157 matthew 13484: =over 4
13485:
1.648 raeburn 13486: =item * &chartlink()
1.139 matthew 13487:
13488: Returns a link to the chart for a specific student.
13489:
13490: Inputs:
13491:
13492: =over 4
13493:
13494: =item $linktext: The text of the link
13495:
13496: =item $sname: The students username
13497:
13498: =item $sdomain: The students domain
13499:
13500: =back
13501:
1.157 matthew 13502: =back
13503:
1.139 matthew 13504: =cut
13505:
13506: ############################################################
13507: ############################################################
13508: sub chartlink {
13509: my ($linktext, $sname, $sdomain) = @_;
13510: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 13511: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 13512: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 13513: '">'.$linktext.'</a>';
1.153 matthew 13514: }
13515:
13516: #######################################################
13517: #######################################################
13518:
13519: =pod
13520:
13521: =head1 Course Environment Routines
1.157 matthew 13522:
13523: =over 4
1.153 matthew 13524:
1.648 raeburn 13525: =item * &restore_course_settings()
1.153 matthew 13526:
1.648 raeburn 13527: =item * &store_course_settings()
1.153 matthew 13528:
13529: Restores/Store indicated form parameters from the course environment.
13530: Will not overwrite existing values of the form parameters.
13531:
13532: Inputs:
13533: a scalar describing the data (e.g. 'chart', 'problem_analysis')
13534:
13535: a hash ref describing the data to be stored. For example:
13536:
13537: %Save_Parameters = ('Status' => 'scalar',
13538: 'chartoutputmode' => 'scalar',
13539: 'chartoutputdata' => 'scalar',
13540: 'Section' => 'array',
1.373 raeburn 13541: 'Group' => 'array',
1.153 matthew 13542: 'StudentData' => 'array',
13543: 'Maps' => 'array');
13544:
13545: Returns: both routines return nothing
13546:
1.631 raeburn 13547: =back
13548:
1.153 matthew 13549: =cut
13550:
13551: #######################################################
13552: #######################################################
13553: sub store_course_settings {
1.496 albertel 13554: return &store_settings($env{'request.course.id'},@_);
13555: }
13556:
13557: sub store_settings {
1.153 matthew 13558: # save to the environment
13559: # appenv the same items, just to be safe
1.300 albertel 13560: my $udom = $env{'user.domain'};
13561: my $uname = $env{'user.name'};
1.496 albertel 13562: my ($context,$prefix,$Settings) = @_;
1.153 matthew 13563: my %SaveHash;
13564: my %AppHash;
13565: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 13566: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 13567: my $envname = 'environment.'.$basename;
1.258 albertel 13568: if (exists($env{'form.'.$setting})) {
1.153 matthew 13569: # Save this value away
13570: if ($type eq 'scalar' &&
1.258 albertel 13571: (! exists($env{$envname}) ||
13572: $env{$envname} ne $env{'form.'.$setting})) {
13573: $SaveHash{$basename} = $env{'form.'.$setting};
13574: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 13575: } elsif ($type eq 'array') {
13576: my $stored_form;
1.258 albertel 13577: if (ref($env{'form.'.$setting})) {
1.153 matthew 13578: $stored_form = join(',',
13579: map {
1.369 www 13580: &escape($_);
1.258 albertel 13581: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 13582: } else {
13583: $stored_form =
1.369 www 13584: &escape($env{'form.'.$setting});
1.153 matthew 13585: }
13586: # Determine if the array contents are the same.
1.258 albertel 13587: if ($stored_form ne $env{$envname}) {
1.153 matthew 13588: $SaveHash{$basename} = $stored_form;
13589: $AppHash{$envname} = $stored_form;
13590: }
13591: }
13592: }
13593: }
13594: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 13595: $udom,$uname);
1.153 matthew 13596: if ($put_result !~ /^(ok|delayed)/) {
13597: &Apache::lonnet::logthis('unable to save form parameters, '.
13598: 'got error:'.$put_result);
13599: }
13600: # Make sure these settings stick around in this session, too
1.646 raeburn 13601: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 13602: return;
13603: }
13604:
13605: sub restore_course_settings {
1.499 albertel 13606: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 13607: }
13608:
13609: sub restore_settings {
13610: my ($context,$prefix,$Settings) = @_;
1.153 matthew 13611: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 13612: next if (exists($env{'form.'.$setting}));
1.496 albertel 13613: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 13614: '.'.$setting;
1.258 albertel 13615: if (exists($env{$envname})) {
1.153 matthew 13616: if ($type eq 'scalar') {
1.258 albertel 13617: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 13618: } elsif ($type eq 'array') {
1.258 albertel 13619: $env{'form.'.$setting} = [
1.153 matthew 13620: map {
1.369 www 13621: &unescape($_);
1.258 albertel 13622: } split(',',$env{$envname})
1.153 matthew 13623: ];
13624: }
13625: }
13626: }
1.127 matthew 13627: }
13628:
1.618 raeburn 13629: #######################################################
13630: #######################################################
13631:
13632: =pod
13633:
13634: =head1 Domain E-mail Routines
13635:
13636: =over 4
13637:
1.648 raeburn 13638: =item * &build_recipient_list()
1.618 raeburn 13639:
1.1144 raeburn 13640: Build recipient lists for following types of e-mail:
1.766 raeburn 13641: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1144 raeburn 13642: (d) Help requests, (e) Course requests needing approval, (f) loncapa
13643: module change checking, student/employee ID conflict checks, as
13644: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
13645: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618 raeburn 13646:
13647: Inputs:
1.619 raeburn 13648: defmail (scalar - email address of default recipient),
1.1144 raeburn 13649: mailing type (scalar: errormail, packagesmail, helpdeskmail,
13650: requestsmail, updatesmail, or idconflictsmail).
13651:
1.619 raeburn 13652: defdom (domain for which to retrieve configuration settings),
1.1144 raeburn 13653:
1.619 raeburn 13654: origmail (scalar - email address of recipient from loncapa.conf,
13655: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 13656:
1.655 raeburn 13657: Returns: comma separated list of addresses to which to send e-mail.
13658:
13659: =back
1.618 raeburn 13660:
13661: =cut
13662:
13663: ############################################################
13664: ############################################################
13665: sub build_recipient_list {
1.619 raeburn 13666: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 13667: my @recipients;
13668: my $otheremails;
13669: my %domconfig =
13670: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
13671: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 13672: if (exists($domconfig{'contacts'}{$mailing})) {
13673: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
13674: my @contacts = ('adminemail','supportemail');
13675: foreach my $item (@contacts) {
13676: if ($domconfig{'contacts'}{$mailing}{$item}) {
13677: my $addr = $domconfig{'contacts'}{$item};
13678: if (!grep(/^\Q$addr\E$/,@recipients)) {
13679: push(@recipients,$addr);
13680: }
1.619 raeburn 13681: }
1.766 raeburn 13682: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 13683: }
13684: }
1.766 raeburn 13685: } elsif ($origmail ne '') {
13686: push(@recipients,$origmail);
1.618 raeburn 13687: }
1.619 raeburn 13688: } elsif ($origmail ne '') {
13689: push(@recipients,$origmail);
1.618 raeburn 13690: }
1.688 raeburn 13691: if (defined($defmail)) {
13692: if ($defmail ne '') {
13693: push(@recipients,$defmail);
13694: }
1.618 raeburn 13695: }
13696: if ($otheremails) {
1.619 raeburn 13697: my @others;
13698: if ($otheremails =~ /,/) {
13699: @others = split(/,/,$otheremails);
1.618 raeburn 13700: } else {
1.619 raeburn 13701: push(@others,$otheremails);
13702: }
13703: foreach my $addr (@others) {
13704: if (!grep(/^\Q$addr\E$/,@recipients)) {
13705: push(@recipients,$addr);
13706: }
1.618 raeburn 13707: }
13708: }
1.619 raeburn 13709: my $recipientlist = join(',',@recipients);
1.618 raeburn 13710: return $recipientlist;
13711: }
13712:
1.127 matthew 13713: ############################################################
13714: ############################################################
1.154 albertel 13715:
1.655 raeburn 13716: =pod
13717:
13718: =head1 Course Catalog Routines
13719:
13720: =over 4
13721:
13722: =item * &gather_categories()
13723:
13724: Converts category definitions - keys of categories hash stored in
13725: coursecategories in configuration.db on the primary library server in a
13726: domain - to an array. Also generates javascript and idx hash used to
13727: generate Domain Coordinator interface for editing Course Categories.
13728:
13729: Inputs:
1.663 raeburn 13730:
1.655 raeburn 13731: categories (reference to hash of category definitions).
1.663 raeburn 13732:
1.655 raeburn 13733: cats (reference to array of arrays/hashes which encapsulates hierarchy of
13734: categories and subcategories).
1.663 raeburn 13735:
1.655 raeburn 13736: idx (reference to hash of counters used in Domain Coordinator interface for
13737: editing Course Categories).
1.663 raeburn 13738:
1.655 raeburn 13739: jsarray (reference to array of categories used to create Javascript arrays for
13740: Domain Coordinator interface for editing Course Categories).
13741:
13742: Returns: nothing
13743:
13744: Side effects: populates cats, idx and jsarray.
13745:
13746: =cut
13747:
13748: sub gather_categories {
13749: my ($categories,$cats,$idx,$jsarray) = @_;
13750: my %counters;
13751: my $num = 0;
13752: foreach my $item (keys(%{$categories})) {
13753: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
13754: if ($container eq '' && $depth == 0) {
13755: $cats->[$depth][$categories->{$item}] = $cat;
13756: } else {
13757: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
13758: }
13759: my ($escitem,$tail) = split(/:/,$item,2);
13760: if ($counters{$tail} eq '') {
13761: $counters{$tail} = $num;
13762: $num ++;
13763: }
13764: if (ref($idx) eq 'HASH') {
13765: $idx->{$item} = $counters{$tail};
13766: }
13767: if (ref($jsarray) eq 'ARRAY') {
13768: push(@{$jsarray->[$counters{$tail}]},$item);
13769: }
13770: }
13771: return;
13772: }
13773:
13774: =pod
13775:
13776: =item * &extract_categories()
13777:
13778: Used to generate breadcrumb trails for course categories.
13779:
13780: Inputs:
1.663 raeburn 13781:
1.655 raeburn 13782: categories (reference to hash of category definitions).
1.663 raeburn 13783:
1.655 raeburn 13784: cats (reference to array of arrays/hashes which encapsulates hierarchy of
13785: categories and subcategories).
1.663 raeburn 13786:
1.655 raeburn 13787: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 13788:
1.655 raeburn 13789: allitems (reference to hash - key is category key
13790: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 13791:
1.655 raeburn 13792: idx (reference to hash of counters used in Domain Coordinator interface for
13793: editing Course Categories).
1.663 raeburn 13794:
1.655 raeburn 13795: jsarray (reference to array of categories used to create Javascript arrays for
13796: Domain Coordinator interface for editing Course Categories).
13797:
1.665 raeburn 13798: subcats (reference to hash of arrays containing all subcategories within each
13799: category, -recursive)
13800:
1.655 raeburn 13801: Returns: nothing
13802:
13803: Side effects: populates trails and allitems hash references.
13804:
13805: =cut
13806:
13807: sub extract_categories {
1.665 raeburn 13808: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 13809: if (ref($categories) eq 'HASH') {
13810: &gather_categories($categories,$cats,$idx,$jsarray);
13811: if (ref($cats->[0]) eq 'ARRAY') {
13812: for (my $i=0; $i<@{$cats->[0]}; $i++) {
13813: my $name = $cats->[0][$i];
13814: my $item = &escape($name).'::0';
13815: my $trailstr;
13816: if ($name eq 'instcode') {
13817: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 13818: } elsif ($name eq 'communities') {
13819: $trailstr = &mt('Communities');
1.655 raeburn 13820: } else {
13821: $trailstr = $name;
13822: }
13823: if ($allitems->{$item} eq '') {
13824: push(@{$trails},$trailstr);
13825: $allitems->{$item} = scalar(@{$trails})-1;
13826: }
13827: my @parents = ($name);
13828: if (ref($cats->[1]{$name}) eq 'ARRAY') {
13829: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
13830: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 13831: if (ref($subcats) eq 'HASH') {
13832: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
13833: }
13834: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
13835: }
13836: } else {
13837: if (ref($subcats) eq 'HASH') {
13838: $subcats->{$item} = [];
1.655 raeburn 13839: }
13840: }
13841: }
13842: }
13843: }
13844: return;
13845: }
13846:
13847: =pod
13848:
1.1162 raeburn 13849: =item * &recurse_categories()
1.655 raeburn 13850:
13851: Recursively used to generate breadcrumb trails for course categories.
13852:
13853: Inputs:
1.663 raeburn 13854:
1.655 raeburn 13855: cats (reference to array of arrays/hashes which encapsulates hierarchy of
13856: categories and subcategories).
1.663 raeburn 13857:
1.655 raeburn 13858: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 13859:
13860: category (current course category, for which breadcrumb trail is being generated).
13861:
13862: trails (reference to array of breadcrumb trails for each category).
13863:
1.655 raeburn 13864: allitems (reference to hash - key is category key
13865: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 13866:
1.655 raeburn 13867: parents (array containing containers directories for current category,
13868: back to top level).
13869:
13870: Returns: nothing
13871:
13872: Side effects: populates trails and allitems hash references
13873:
13874: =cut
13875:
13876: sub recurse_categories {
1.665 raeburn 13877: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 13878: my $shallower = $depth - 1;
13879: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
13880: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
13881: my $name = $cats->[$depth]{$category}[$k];
13882: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
13883: my $trailstr = join(' -> ',(@{$parents},$category));
13884: if ($allitems->{$item} eq '') {
13885: push(@{$trails},$trailstr);
13886: $allitems->{$item} = scalar(@{$trails})-1;
13887: }
13888: my $deeper = $depth+1;
13889: push(@{$parents},$category);
1.665 raeburn 13890: if (ref($subcats) eq 'HASH') {
13891: my $subcat = &escape($name).':'.$category.':'.$depth;
13892: for (my $j=@{$parents}; $j>=0; $j--) {
13893: my $higher;
13894: if ($j > 0) {
13895: $higher = &escape($parents->[$j]).':'.
13896: &escape($parents->[$j-1]).':'.$j;
13897: } else {
13898: $higher = &escape($parents->[$j]).'::'.$j;
13899: }
13900: push(@{$subcats->{$higher}},$subcat);
13901: }
13902: }
13903: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
13904: $subcats);
1.655 raeburn 13905: pop(@{$parents});
13906: }
13907: } else {
13908: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
13909: my $trailstr = join(' -> ',(@{$parents},$category));
13910: if ($allitems->{$item} eq '') {
13911: push(@{$trails},$trailstr);
13912: $allitems->{$item} = scalar(@{$trails})-1;
13913: }
13914: }
13915: return;
13916: }
13917:
1.663 raeburn 13918: =pod
13919:
1.1162 raeburn 13920: =item * &assign_categories_table()
1.663 raeburn 13921:
13922: Create a datatable for display of hierarchical categories in a domain,
13923: with checkboxes to allow a course to be categorized.
13924:
13925: Inputs:
13926:
13927: cathash - reference to hash of categories defined for the domain (from
13928: configuration.db)
13929:
13930: currcat - scalar with an & separated list of categories assigned to a course.
13931:
1.919 raeburn 13932: type - scalar contains course type (Course or Community).
13933:
1.663 raeburn 13934: Returns: $output (markup to be displayed)
13935:
13936: =cut
13937:
13938: sub assign_categories_table {
1.919 raeburn 13939: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 13940: my $output;
13941: if (ref($cathash) eq 'HASH') {
13942: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
13943: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
13944: $maxdepth = scalar(@cats);
13945: if (@cats > 0) {
13946: my $itemcount = 0;
13947: if (ref($cats[0]) eq 'ARRAY') {
13948: my @currcategories;
13949: if ($currcat ne '') {
13950: @currcategories = split('&',$currcat);
13951: }
1.919 raeburn 13952: my $table;
1.663 raeburn 13953: for (my $i=0; $i<@{$cats[0]}; $i++) {
13954: my $parent = $cats[0][$i];
1.919 raeburn 13955: next if ($parent eq 'instcode');
13956: if ($type eq 'Community') {
13957: next unless ($parent eq 'communities');
13958: } else {
13959: next if ($parent eq 'communities');
13960: }
1.663 raeburn 13961: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
13962: my $item = &escape($parent).'::0';
13963: my $checked = '';
13964: if (@currcategories > 0) {
13965: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 13966: $checked = ' checked="checked"';
1.663 raeburn 13967: }
13968: }
1.919 raeburn 13969: my $parent_title = $parent;
13970: if ($parent eq 'communities') {
13971: $parent_title = &mt('Communities');
13972: }
13973: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
13974: '<input type="checkbox" name="usecategory" value="'.
13975: $item.'"'.$checked.' />'.$parent_title.'</span>'.
13976: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 13977: my $depth = 1;
13978: push(@path,$parent);
1.919 raeburn 13979: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 13980: pop(@path);
1.919 raeburn 13981: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 13982: $itemcount ++;
13983: }
1.919 raeburn 13984: if ($itemcount) {
13985: $output = &Apache::loncommon::start_data_table().
13986: $table.
13987: &Apache::loncommon::end_data_table();
13988: }
1.663 raeburn 13989: }
13990: }
13991: }
13992: return $output;
13993: }
13994:
13995: =pod
13996:
1.1162 raeburn 13997: =item * &assign_category_rows()
1.663 raeburn 13998:
13999: Create a datatable row for display of nested categories in a domain,
14000: with checkboxes to allow a course to be categorized,called recursively.
14001:
14002: Inputs:
14003:
14004: itemcount - track row number for alternating colors
14005:
14006: cats - reference to array of arrays/hashes which encapsulates hierarchy of
14007: categories and subcategories.
14008:
14009: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
14010:
14011: parent - parent of current category item
14012:
14013: path - Array containing all categories back up through the hierarchy from the
14014: current category to the top level.
14015:
14016: currcategories - reference to array of current categories assigned to the course
14017:
14018: Returns: $output (markup to be displayed).
14019:
14020: =cut
14021:
14022: sub assign_category_rows {
14023: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
14024: my ($text,$name,$item,$chgstr);
14025: if (ref($cats) eq 'ARRAY') {
14026: my $maxdepth = scalar(@{$cats});
14027: if (ref($cats->[$depth]) eq 'HASH') {
14028: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
14029: my $numchildren = @{$cats->[$depth]{$parent}};
14030: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1145 raeburn 14031: $text .= '<td><table class="LC_data_table">';
1.663 raeburn 14032: for (my $j=0; $j<$numchildren; $j++) {
14033: $name = $cats->[$depth]{$parent}[$j];
14034: $item = &escape($name).':'.&escape($parent).':'.$depth;
14035: my $deeper = $depth+1;
14036: my $checked = '';
14037: if (ref($currcategories) eq 'ARRAY') {
14038: if (@{$currcategories} > 0) {
14039: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 14040: $checked = ' checked="checked"';
1.663 raeburn 14041: }
14042: }
14043: }
1.664 raeburn 14044: $text .= '<tr><td><span class="LC_nobreak"><label>'.
14045: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 14046: $item.'"'.$checked.' />'.$name.'</label></span>'.
14047: '<input type="hidden" name="catname" value="'.$name.'" />'.
14048: '</td><td>';
1.663 raeburn 14049: if (ref($path) eq 'ARRAY') {
14050: push(@{$path},$name);
14051: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
14052: pop(@{$path});
14053: }
14054: $text .= '</td></tr>';
14055: }
14056: $text .= '</table></td>';
14057: }
14058: }
14059: }
14060: return $text;
14061: }
14062:
1.1181 raeburn 14063: =pod
14064:
14065: =back
14066:
14067: =cut
14068:
1.655 raeburn 14069: ############################################################
14070: ############################################################
14071:
14072:
1.443 albertel 14073: sub commit_customrole {
1.664 raeburn 14074: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 14075: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 14076: ($start?', '.&mt('starting').' '.localtime($start):'').
14077: ($end?', ending '.localtime($end):'').': <b>'.
14078: &Apache::lonnet::assigncustomrole(
1.664 raeburn 14079: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 14080: '</b><br />';
14081: return $output;
14082: }
14083:
14084: sub commit_standardrole {
1.1116 raeburn 14085: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits) = @_;
1.541 raeburn 14086: my ($output,$logmsg,$linefeed);
14087: if ($context eq 'auto') {
14088: $linefeed = "\n";
14089: } else {
14090: $linefeed = "<br />\n";
14091: }
1.443 albertel 14092: if ($three eq 'st') {
1.541 raeburn 14093: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1116 raeburn 14094: $one,$two,$sec,$context,$credits);
1.541 raeburn 14095: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 14096: ($result eq 'unknown_course') || ($result eq 'refused')) {
14097: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 14098: } else {
1.541 raeburn 14099: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 14100: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 14101: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
14102: if ($context eq 'auto') {
14103: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
14104: } else {
14105: $output .= '<b>'.$result.'</b>'.$linefeed.
14106: &mt('Add to classlist').': <b>ok</b>';
14107: }
14108: $output .= $linefeed;
1.443 albertel 14109: }
14110: } else {
14111: $output = &mt('Assigning').' '.$three.' in '.$url.
14112: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 14113: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 14114: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 14115: if ($context eq 'auto') {
14116: $output .= $result.$linefeed;
14117: } else {
14118: $output .= '<b>'.$result.'</b>'.$linefeed;
14119: }
1.443 albertel 14120: }
14121: return $output;
14122: }
14123:
14124: sub commit_studentrole {
1.1116 raeburn 14125: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
14126: $credits) = @_;
1.626 raeburn 14127: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 14128: if ($context eq 'auto') {
14129: $linefeed = "\n";
14130: } else {
14131: $linefeed = '<br />'."\n";
14132: }
1.443 albertel 14133: if (defined($one) && defined($two)) {
14134: my $cid=$one.'_'.$two;
14135: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
14136: my $secchange = 0;
14137: my $expire_role_result;
14138: my $modify_section_result;
1.628 raeburn 14139: if ($oldsec ne '-1') {
14140: if ($oldsec ne $sec) {
1.443 albertel 14141: $secchange = 1;
1.628 raeburn 14142: my $now = time;
1.443 albertel 14143: my $uurl='/'.$cid;
14144: $uurl=~s/\_/\//g;
14145: if ($oldsec) {
14146: $uurl.='/'.$oldsec;
14147: }
1.626 raeburn 14148: $oldsecurl = $uurl;
1.628 raeburn 14149: $expire_role_result =
1.652 raeburn 14150: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 14151: if ($env{'request.course.sec'} ne '') {
14152: if ($expire_role_result eq 'refused') {
14153: my @roles = ('st');
14154: my @statuses = ('previous');
14155: my @roledoms = ($one);
14156: my $withsec = 1;
14157: my %roleshash =
14158: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
14159: \@statuses,\@roles,\@roledoms,$withsec);
14160: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
14161: my ($oldstart,$oldend) =
14162: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
14163: if ($oldend > 0 && $oldend <= $now) {
14164: $expire_role_result = 'ok';
14165: }
14166: }
14167: }
14168: }
1.443 albertel 14169: $result = $expire_role_result;
14170: }
14171: }
14172: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1116 raeburn 14173: $modify_section_result =
14174: &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
14175: undef,undef,undef,$sec,
14176: $end,$start,'','',$cid,
14177: '',$context,$credits);
1.443 albertel 14178: if ($modify_section_result =~ /^ok/) {
14179: if ($secchange == 1) {
1.628 raeburn 14180: if ($sec eq '') {
14181: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
14182: } else {
14183: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
14184: }
1.443 albertel 14185: } elsif ($oldsec eq '-1') {
1.628 raeburn 14186: if ($sec eq '') {
14187: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
14188: } else {
14189: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
14190: }
1.443 albertel 14191: } else {
1.628 raeburn 14192: if ($sec eq '') {
14193: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
14194: } else {
14195: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
14196: }
1.443 albertel 14197: }
14198: } else {
1.1115 raeburn 14199: if ($secchange) {
1.628 raeburn 14200: $$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;
14201: } else {
14202: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
14203: }
1.443 albertel 14204: }
14205: $result = $modify_section_result;
14206: } elsif ($secchange == 1) {
1.628 raeburn 14207: if ($oldsec eq '') {
1.1103 raeburn 14208: $$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 14209: } else {
14210: $$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;
14211: }
1.626 raeburn 14212: if ($expire_role_result eq 'refused') {
14213: my $newsecurl = '/'.$cid;
14214: $newsecurl =~ s/\_/\//g;
14215: if ($sec ne '') {
14216: $newsecurl.='/'.$sec;
14217: }
14218: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
14219: if ($sec eq '') {
14220: $$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;
14221: } else {
14222: $$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;
14223: }
14224: }
14225: }
1.443 albertel 14226: }
14227: } else {
1.626 raeburn 14228: $$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 14229: $result = "error: incomplete course id\n";
14230: }
14231: return $result;
14232: }
14233:
1.1108 raeburn 14234: sub show_role_extent {
14235: my ($scope,$context,$role) = @_;
14236: $scope =~ s{^/}{};
14237: my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
14238: push(@courseroles,'co');
14239: my @authorroles = &Apache::lonuserutils::roles_by_context('author');
14240: if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
14241: $scope =~ s{/}{_};
14242: return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
14243: } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
14244: my ($audom,$auname) = split(/\//,$scope);
14245: return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
14246: &Apache::loncommon::plainname($auname,$audom).'</span>');
14247: } else {
14248: $scope =~ s{/$}{};
14249: return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
14250: &Apache::lonnet::domain($scope,'description').'</span>');
14251: }
14252: }
14253:
1.443 albertel 14254: ############################################################
14255: ############################################################
14256:
1.566 albertel 14257: sub check_clone {
1.578 raeburn 14258: my ($args,$linefeed) = @_;
1.566 albertel 14259: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
14260: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
14261: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
14262: my $clonemsg;
14263: my $can_clone = 0;
1.944 raeburn 14264: my $lctype = lc($args->{'crstype'});
1.908 raeburn 14265: if ($lctype ne 'community') {
14266: $lctype = 'course';
14267: }
1.566 albertel 14268: if ($clonehome eq 'no_host') {
1.944 raeburn 14269: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 14270: $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'});
14271: } else {
14272: $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'});
14273: }
1.566 albertel 14274: } else {
14275: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944 raeburn 14276: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 14277: if ($clonedesc{'type'} ne 'Community') {
14278: $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'});
14279: return ($can_clone, $clonemsg, $cloneid, $clonehome);
14280: }
14281: }
1.882 raeburn 14282: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
14283: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 14284: $can_clone = 1;
14285: } else {
14286: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
14287: $args->{'clonedomain'},$args->{'clonecourse'});
14288: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 14289: if (grep(/^\*$/,@cloners)) {
14290: $can_clone = 1;
14291: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
14292: $can_clone = 1;
14293: } else {
1.908 raeburn 14294: my $ccrole = 'cc';
1.944 raeburn 14295: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 14296: $ccrole = 'co';
14297: }
1.578 raeburn 14298: my %roleshash =
14299: &Apache::lonnet::get_my_roles($args->{'ccuname'},
14300: $args->{'ccdomain'},
1.908 raeburn 14301: 'userroles',['active'],[$ccrole],
1.578 raeburn 14302: [$args->{'clonedomain'}]);
1.908 raeburn 14303: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942 raeburn 14304: $can_clone = 1;
14305: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
14306: $can_clone = 1;
14307: } else {
1.944 raeburn 14308: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 14309: $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'});
14310: } else {
14311: $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'});
14312: }
1.578 raeburn 14313: }
1.566 albertel 14314: }
1.578 raeburn 14315: }
1.566 albertel 14316: }
14317: return ($can_clone, $clonemsg, $cloneid, $clonehome);
14318: }
14319:
1.444 albertel 14320: sub construct_course {
1.1166 raeburn 14321: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category,$coderef) = @_;
1.444 albertel 14322: my $outcome;
1.541 raeburn 14323: my $linefeed = '<br />'."\n";
14324: if ($context eq 'auto') {
14325: $linefeed = "\n";
14326: }
1.566 albertel 14327:
14328: #
14329: # Are we cloning?
14330: #
14331: my ($can_clone, $clonemsg, $cloneid, $clonehome);
14332: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 14333: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 14334: if ($context ne 'auto') {
1.578 raeburn 14335: if ($clonemsg ne '') {
14336: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
14337: }
1.566 albertel 14338: }
14339: $outcome .= $clonemsg.$linefeed;
14340:
14341: if (!$can_clone) {
14342: return (0,$outcome);
14343: }
14344: }
14345:
1.444 albertel 14346: #
14347: # Open course
14348: #
14349: my $crstype = lc($args->{'crstype'});
14350: my %cenv=();
14351: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
14352: $args->{'cdescr'},
14353: $args->{'curl'},
14354: $args->{'course_home'},
14355: $args->{'nonstandard'},
14356: $args->{'crscode'},
14357: $args->{'ccuname'}.':'.
14358: $args->{'ccdomain'},
1.882 raeburn 14359: $args->{'crstype'},
1.885 raeburn 14360: $cnum,$context,$category);
1.444 albertel 14361:
14362: # Note: The testing routines depend on this being output; see
14363: # Utils::Course. This needs to at least be output as a comment
14364: # if anyone ever decides to not show this, and Utils::Course::new
14365: # will need to be suitably modified.
1.541 raeburn 14366: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943 raeburn 14367: if ($$courseid =~ /^error:/) {
14368: return (0,$outcome);
14369: }
14370:
1.444 albertel 14371: #
14372: # Check if created correctly
14373: #
1.479 albertel 14374: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 14375: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 14376: if ($crsuhome eq 'no_host') {
14377: $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
14378: return (0,$outcome);
14379: }
1.541 raeburn 14380: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 14381:
1.444 albertel 14382: #
1.566 albertel 14383: # Do the cloning
14384: #
14385: if ($can_clone && $cloneid) {
14386: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
14387: if ($context ne 'auto') {
14388: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
14389: }
14390: $outcome .= $clonemsg.$linefeed;
14391: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 14392: # Copy all files
1.637 www 14393: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 14394: # Restore URL
1.566 albertel 14395: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 14396: # Restore title
1.566 albertel 14397: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 14398: # Restore creation date, creator and creation context.
14399: $cenv{'internal.created'}=$oldcenv{'internal.created'};
14400: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
14401: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 14402: # Mark as cloned
1.566 albertel 14403: $cenv{'clonedfrom'}=$cloneid;
1.638 www 14404: # Need to clone grading mode
14405: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
14406: $cenv{'grading'}=$newenv{'grading'};
14407: # Do not clone these environment entries
14408: &Apache::lonnet::del('environment',
14409: ['default_enrollment_start_date',
14410: 'default_enrollment_end_date',
14411: 'question.email',
14412: 'policy.email',
14413: 'comment.email',
14414: 'pch.users.denied',
1.725 raeburn 14415: 'plc.users.denied',
14416: 'hidefromcat',
1.1121 raeburn 14417: 'checkforpriv',
1.1166 raeburn 14418: 'categories',
14419: 'internal.uniquecode'],
1.638 www 14420: $$crsudom,$$crsunum);
1.1170 raeburn 14421: if ($args->{'textbook'}) {
14422: $cenv{'internal.textbook'} = $args->{'textbook'};
14423: }
1.444 albertel 14424: }
1.566 albertel 14425:
1.444 albertel 14426: #
14427: # Set environment (will override cloned, if existing)
14428: #
14429: my @sections = ();
14430: my @xlists = ();
14431: if ($args->{'crstype'}) {
14432: $cenv{'type'}=$args->{'crstype'};
14433: }
14434: if ($args->{'crsid'}) {
14435: $cenv{'courseid'}=$args->{'crsid'};
14436: }
14437: if ($args->{'crscode'}) {
14438: $cenv{'internal.coursecode'}=$args->{'crscode'};
14439: }
14440: if ($args->{'crsquota'} ne '') {
14441: $cenv{'internal.coursequota'}=$args->{'crsquota'};
14442: } else {
14443: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
14444: }
14445: if ($args->{'ccuname'}) {
14446: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
14447: ':'.$args->{'ccdomain'};
14448: } else {
14449: $cenv{'internal.courseowner'} = $args->{'curruser'};
14450: }
1.1116 raeburn 14451: if ($args->{'defaultcredits'}) {
14452: $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
14453: }
1.444 albertel 14454: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
14455: if ($args->{'crssections'}) {
14456: $cenv{'internal.sectionnums'} = '';
14457: if ($args->{'crssections'} =~ m/,/) {
14458: @sections = split/,/,$args->{'crssections'};
14459: } else {
14460: $sections[0] = $args->{'crssections'};
14461: }
14462: if (@sections > 0) {
14463: foreach my $item (@sections) {
14464: my ($sec,$gp) = split/:/,$item;
14465: my $class = $args->{'crscode'}.$sec;
14466: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
14467: $cenv{'internal.sectionnums'} .= $item.',';
14468: unless ($addcheck eq 'ok') {
14469: push @badclasses, $class;
14470: }
14471: }
14472: $cenv{'internal.sectionnums'} =~ s/,$//;
14473: }
14474: }
14475: # do not hide course coordinator from staff listing,
14476: # even if privileged
14477: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1121 raeburn 14478: # add course coordinator's domain to domains to check for privileged users
14479: # if different to course domain
14480: if ($$crsudom ne $args->{'ccdomain'}) {
14481: $cenv{'checkforpriv'} = $args->{'ccdomain'};
14482: }
1.444 albertel 14483: # add crosslistings
14484: if ($args->{'crsxlist'}) {
14485: $cenv{'internal.crosslistings'}='';
14486: if ($args->{'crsxlist'} =~ m/,/) {
14487: @xlists = split/,/,$args->{'crsxlist'};
14488: } else {
14489: $xlists[0] = $args->{'crsxlist'};
14490: }
14491: if (@xlists > 0) {
14492: foreach my $item (@xlists) {
14493: my ($xl,$gp) = split/:/,$item;
14494: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
14495: $cenv{'internal.crosslistings'} .= $item.',';
14496: unless ($addcheck eq 'ok') {
14497: push @badclasses, $xl;
14498: }
14499: }
14500: $cenv{'internal.crosslistings'} =~ s/,$//;
14501: }
14502: }
14503: if ($args->{'autoadds'}) {
14504: $cenv{'internal.autoadds'}=$args->{'autoadds'};
14505: }
14506: if ($args->{'autodrops'}) {
14507: $cenv{'internal.autodrops'}=$args->{'autodrops'};
14508: }
14509: # check for notification of enrollment changes
14510: my @notified = ();
14511: if ($args->{'notify_owner'}) {
14512: if ($args->{'ccuname'} ne '') {
14513: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
14514: }
14515: }
14516: if ($args->{'notify_dc'}) {
14517: if ($uname ne '') {
1.630 raeburn 14518: push(@notified,$uname.':'.$udom);
1.444 albertel 14519: }
14520: }
14521: if (@notified > 0) {
14522: my $notifylist;
14523: if (@notified > 1) {
14524: $notifylist = join(',',@notified);
14525: } else {
14526: $notifylist = $notified[0];
14527: }
14528: $cenv{'internal.notifylist'} = $notifylist;
14529: }
14530: if (@badclasses > 0) {
14531: my %lt=&Apache::lonlocal::texthash(
14532: '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',
14533: 'dnhr' => 'does not have rights to access enrollment in these classes',
14534: 'adby' => 'as determined by the policies of your institution on access to official classlists'
14535: );
1.541 raeburn 14536: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
14537: ' ('.$lt{'adby'}.')';
14538: if ($context eq 'auto') {
14539: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 14540: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 14541: foreach my $item (@badclasses) {
14542: if ($context eq 'auto') {
14543: $outcome .= " - $item\n";
14544: } else {
14545: $outcome .= "<li>$item</li>\n";
14546: }
14547: }
14548: if ($context eq 'auto') {
14549: $outcome .= $linefeed;
14550: } else {
1.566 albertel 14551: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 14552: }
14553: }
1.444 albertel 14554: }
14555: if ($args->{'no_end_date'}) {
14556: $args->{'endaccess'} = 0;
14557: }
14558: $cenv{'internal.autostart'}=$args->{'enrollstart'};
14559: $cenv{'internal.autoend'}=$args->{'enrollend'};
14560: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
14561: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
14562: if ($args->{'showphotos'}) {
14563: $cenv{'internal.showphotos'}=$args->{'showphotos'};
14564: }
14565: $cenv{'internal.authtype'} = $args->{'authtype'};
14566: $cenv{'internal.autharg'} = $args->{'autharg'};
14567: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
14568: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 14569: 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');
14570: if ($context eq 'auto') {
14571: $outcome .= $krb_msg;
14572: } else {
1.566 albertel 14573: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 14574: }
14575: $outcome .= $linefeed;
1.444 albertel 14576: }
14577: }
14578: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
14579: if ($args->{'setpolicy'}) {
14580: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
14581: }
14582: if ($args->{'setcontent'}) {
14583: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
14584: }
14585: }
14586: if ($args->{'reshome'}) {
14587: $cenv{'reshome'}=$args->{'reshome'}.'/';
14588: $cenv{'reshome'}=~s/\/+$/\//;
14589: }
14590: #
14591: # course has keyed access
14592: #
14593: if ($args->{'setkeys'}) {
14594: $cenv{'keyaccess'}='yes';
14595: }
14596: # if specified, key authority is not course, but user
14597: # only active if keyaccess is yes
14598: if ($args->{'keyauth'}) {
1.487 albertel 14599: my ($user,$domain) = split(':',$args->{'keyauth'});
14600: $user = &LONCAPA::clean_username($user);
14601: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 14602: if ($user ne '' && $domain ne '') {
1.487 albertel 14603: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 14604: }
14605: }
14606:
1.1166 raeburn 14607: #
1.1167 raeburn 14608: # generate and store uniquecode (available to course requester), if course should have one.
1.1166 raeburn 14609: #
14610: if ($args->{'uniquecode'}) {
14611: my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
14612: if ($code) {
14613: $cenv{'internal.uniquecode'} = $code;
1.1167 raeburn 14614: my %crsinfo =
14615: &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
14616: if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
14617: $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
14618: my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
14619: }
1.1166 raeburn 14620: if (ref($coderef)) {
14621: $$coderef = $code;
14622: }
14623: }
14624: }
14625:
1.444 albertel 14626: if ($args->{'disresdis'}) {
14627: $cenv{'pch.roles.denied'}='st';
14628: }
14629: if ($args->{'disablechat'}) {
14630: $cenv{'plc.roles.denied'}='st';
14631: }
14632:
14633: # Record we've not yet viewed the Course Initialization Helper for this
14634: # course
14635: $cenv{'course.helper.not.run'} = 1;
14636: #
14637: # Use new Randomseed
14638: #
14639: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
14640: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
14641: #
14642: # The encryption code and receipt prefix for this course
14643: #
14644: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
14645: $cenv{'internal.encpref'}=100+int(9*rand(99));
14646: #
14647: # By default, use standard grading
14648: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
14649:
1.541 raeburn 14650: $outcome .= $linefeed.&mt('Setting environment').': '.
14651: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 14652: #
14653: # Open all assignments
14654: #
14655: if ($args->{'openall'}) {
14656: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
14657: my %storecontent = ($storeunder => time,
14658: $storeunder.'.type' => 'date_start');
14659:
14660: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 14661: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 14662: }
14663: #
14664: # Set first page
14665: #
14666: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
14667: || ($cloneid)) {
1.445 albertel 14668: use LONCAPA::map;
1.444 albertel 14669: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 14670:
14671: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
14672: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
14673:
1.444 albertel 14674: $outcome .= ($fatal?$errtext:'read ok').' - ';
14675: my $title; my $url;
14676: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 14677: $title=&mt('Syllabus');
1.444 albertel 14678: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
14679: } else {
1.963 raeburn 14680: $title=&mt('Table of Contents');
1.444 albertel 14681: $url='/adm/navmaps';
14682: }
1.445 albertel 14683:
14684: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
14685: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
14686:
14687: if ($errtext) { $fatal=2; }
1.541 raeburn 14688: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 14689: }
1.566 albertel 14690:
14691: return (1,$outcome);
1.444 albertel 14692: }
14693:
1.1166 raeburn 14694: sub make_unique_code {
14695: my ($cdom,$cnum) = @_;
14696: # get lock on uniquecodes db
14697: my $lockhash = {
14698: $cnum."\0".'uniquecodes' => $env{'user.name'}.
14699: ':'.$env{'user.domain'},
14700: };
14701: my $tries = 0;
14702: my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
14703: my ($code,$error);
14704:
14705: while (($gotlock ne 'ok') && ($tries<3)) {
14706: $tries ++;
14707: sleep 1;
14708: $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
14709: }
14710: if ($gotlock eq 'ok') {
14711: my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
14712: my $gotcode;
14713: my $attempts = 0;
14714: while ((!$gotcode) && ($attempts < 100)) {
14715: $code = &generate_code();
14716: if (!exists($currcodes{$code})) {
14717: $gotcode = 1;
14718: unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
14719: $error = 'nostore';
14720: }
14721: }
14722: $attempts ++;
14723: }
14724: my @del_lock = ($cnum."\0".'uniquecodes');
14725: my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
14726: } else {
14727: $error = 'nolock';
14728: }
14729: return ($code,$error);
14730: }
14731:
14732: sub generate_code {
14733: my $code;
14734: my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
14735: for (my $i=0; $i<6; $i++) {
14736: my $lettnum = int (rand 2);
14737: my $item = '';
14738: if ($lettnum) {
14739: $item = $letts[int( rand(18) )];
14740: } else {
14741: $item = 1+int( rand(8) );
14742: }
14743: $code .= $item;
14744: }
14745: return $code;
14746: }
14747:
1.444 albertel 14748: ############################################################
14749: ############################################################
14750:
1.953 droeschl 14751: #SD
14752: # only Community and Course, or anything else?
1.378 raeburn 14753: sub course_type {
14754: my ($cid) = @_;
14755: if (!defined($cid)) {
14756: $cid = $env{'request.course.id'};
14757: }
1.404 albertel 14758: if (defined($env{'course.'.$cid.'.type'})) {
14759: return $env{'course.'.$cid.'.type'};
1.378 raeburn 14760: } else {
14761: return 'Course';
1.377 raeburn 14762: }
14763: }
1.156 albertel 14764:
1.406 raeburn 14765: sub group_term {
14766: my $crstype = &course_type();
14767: my %names = (
14768: 'Course' => 'group',
1.865 raeburn 14769: 'Community' => 'group',
1.406 raeburn 14770: );
14771: return $names{$crstype};
14772: }
14773:
1.902 raeburn 14774: sub course_types {
1.1165 raeburn 14775: my @types = ('official','unofficial','community','textbook');
1.902 raeburn 14776: my %typename = (
14777: official => 'Official course',
14778: unofficial => 'Unofficial course',
14779: community => 'Community',
1.1165 raeburn 14780: textbook => 'Textbook course',
1.902 raeburn 14781: );
14782: return (\@types,\%typename);
14783: }
14784:
1.156 albertel 14785: sub icon {
14786: my ($file)=@_;
1.505 albertel 14787: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 14788: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 14789: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 14790: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
14791: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
14792: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
14793: $curfext.".gif") {
14794: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
14795: $curfext.".gif";
14796: }
14797: }
1.249 albertel 14798: return &lonhttpdurl($iconname);
1.154 albertel 14799: }
1.84 albertel 14800:
1.575 albertel 14801: sub lonhttpdurl {
1.692 www 14802: #
14803: # Had been used for "small fry" static images on separate port 8080.
14804: # Modify here if lightweight http functionality desired again.
14805: # Currently eliminated due to increasing firewall issues.
14806: #
1.575 albertel 14807: my ($url)=@_;
1.692 www 14808: return $url;
1.215 albertel 14809: }
14810:
1.213 albertel 14811: sub connection_aborted {
14812: my ($r)=@_;
14813: $r->print(" ");$r->rflush();
14814: my $c = $r->connection;
14815: return $c->aborted();
14816: }
14817:
1.221 foxr 14818: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 14819: # strings as 'strings'.
14820: sub escape_single {
1.221 foxr 14821: my ($input) = @_;
1.223 albertel 14822: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 14823: $input =~ s/\'/\\\'/g; # Esacpe the 's....
14824: return $input;
14825: }
1.223 albertel 14826:
1.222 foxr 14827: # Same as escape_single, but escape's "'s This
14828: # can be used for "strings"
14829: sub escape_double {
14830: my ($input) = @_;
14831: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
14832: $input =~ s/\"/\\\"/g; # Esacpe the "s....
14833: return $input;
14834: }
1.223 albertel 14835:
1.222 foxr 14836: # Escapes the last element of a full URL.
14837: sub escape_url {
14838: my ($url) = @_;
1.238 raeburn 14839: my @urlslices = split(/\//, $url,-1);
1.369 www 14840: my $lastitem = &escape(pop(@urlslices));
1.1203 raeburn 14841: return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222 foxr 14842: }
1.462 albertel 14843:
1.820 raeburn 14844: sub compare_arrays {
14845: my ($arrayref1,$arrayref2) = @_;
14846: my (@difference,%count);
14847: @difference = ();
14848: %count = ();
14849: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
14850: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
14851: foreach my $element (keys(%count)) {
14852: if ($count{$element} == 1) {
14853: push(@difference,$element);
14854: }
14855: }
14856: }
14857: return @difference;
14858: }
14859:
1.817 bisitz 14860: # -------------------------------------------------------- Initialize user login
1.462 albertel 14861: sub init_user_environment {
1.463 albertel 14862: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 14863: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
14864:
14865: my $public=($username eq 'public' && $domain eq 'public');
14866:
14867: # See if old ID present, if so, remove
14868:
1.1062 raeburn 14869: my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462 albertel 14870: my $now=time;
14871:
14872: if ($public) {
14873: my $max_public=100;
14874: my $oldest;
14875: my $oldest_time=0;
14876: for(my $next=1;$next<=$max_public;$next++) {
14877: if (-e $lonids."/publicuser_$next.id") {
14878: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
14879: if ($mtime<$oldest_time || !$oldest_time) {
14880: $oldest_time=$mtime;
14881: $oldest=$next;
14882: }
14883: } else {
14884: $cookie="publicuser_$next";
14885: last;
14886: }
14887: }
14888: if (!$cookie) { $cookie="publicuser_$oldest"; }
14889: } else {
1.463 albertel 14890: # if this isn't a robot, kill any existing non-robot sessions
14891: if (!$args->{'robot'}) {
14892: opendir(DIR,$lonids);
14893: while ($filename=readdir(DIR)) {
14894: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
14895: unlink($lonids.'/'.$filename);
14896: }
1.462 albertel 14897: }
1.463 albertel 14898: closedir(DIR);
1.1204 raeburn 14899: # If there is a undeleted lockfile for the user's paste buffer remove it.
14900: my $namespace = 'nohist_courseeditor';
14901: my $lockingkey = 'paste'."\0".'locked_num';
14902: my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
14903: $domain,$username);
14904: if (exists($lockhash{$lockingkey})) {
14905: my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
14906: unless ($delresult eq 'ok') {
14907: &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
14908: }
14909: }
1.462 albertel 14910: }
14911: # Give them a new cookie
1.463 albertel 14912: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 14913: : $now.$$.int(rand(10000)));
1.463 albertel 14914: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 14915:
14916: # Initialize roles
14917:
1.1062 raeburn 14918: ($userroles,$firstaccenv,$timerintenv) =
14919: &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462 albertel 14920: }
14921: # ------------------------------------ Check browser type and MathML capability
14922:
1.1194 raeburn 14923: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
14924: $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462 albertel 14925:
14926: # ------------------------------------------------------------- Get environment
14927:
14928: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
14929: my ($tmp) = keys(%userenv);
14930: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
14931: } else {
14932: undef(%userenv);
14933: }
14934: if (($userenv{'interface'}) && (!$form->{'interface'})) {
14935: $form->{'interface'}=$userenv{'interface'};
14936: }
14937: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
14938:
14939: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 14940: foreach my $option ('interface','localpath','localres') {
14941: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 14942: }
14943: # --------------------------------------------------------- Write first profile
14944:
14945: {
14946: my %initial_env =
14947: ("user.name" => $username,
14948: "user.domain" => $domain,
14949: "user.home" => $authhost,
14950: "browser.type" => $clientbrowser,
14951: "browser.version" => $clientversion,
14952: "browser.mathml" => $clientmathml,
14953: "browser.unicode" => $clientunicode,
14954: "browser.os" => $clientos,
1.1137 raeburn 14955: "browser.mobile" => $clientmobile,
1.1141 raeburn 14956: "browser.info" => $clientinfo,
1.1194 raeburn 14957: "browser.osversion" => $clientosversion,
1.462 albertel 14958: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
14959: "request.course.fn" => '',
14960: "request.course.uri" => '',
14961: "request.course.sec" => '',
14962: "request.role" => 'cm',
14963: "request.role.adv" => $env{'user.adv'},
14964: "request.host" => $ENV{'REMOTE_ADDR'},);
14965:
14966: if ($form->{'localpath'}) {
14967: $initial_env{"browser.localpath"} = $form->{'localpath'};
14968: $initial_env{"browser.localres"} = $form->{'localres'};
14969: }
14970:
14971: if ($form->{'interface'}) {
14972: $form->{'interface'}=~s/\W//gs;
14973: $initial_env{"browser.interface"} = $form->{'interface'};
14974: $env{'browser.interface'}=$form->{'interface'};
14975: }
14976:
1.1157 raeburn 14977: if ($form->{'iptoken'}) {
14978: my $lonhost = $r->dir_config('lonHostID');
14979: $initial_env{"user.noloadbalance"} = $lonhost;
14980: $env{'user.noloadbalance'} = $lonhost;
14981: }
14982:
1.981 raeburn 14983: my %is_adv = ( is_adv => $env{'user.adv'} );
1.1016 raeburn 14984: my %domdef;
14985: unless ($domain eq 'public') {
14986: %domdef = &Apache::lonnet::get_domain_defaults($domain);
14987: }
1.980 raeburn 14988:
1.1081 raeburn 14989: foreach my $tool ('aboutme','blog','webdav','portfolio') {
1.724 raeburn 14990: $userenv{'availabletools.'.$tool} =
1.980 raeburn 14991: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
14992: undef,\%userenv,\%domdef,\%is_adv);
1.724 raeburn 14993: }
14994:
1.1165 raeburn 14995: foreach my $crstype ('official','unofficial','community','textbook') {
1.765 raeburn 14996: $userenv{'canrequest.'.$crstype} =
14997: &Apache::lonnet::usertools_access($username,$domain,$crstype,
1.980 raeburn 14998: 'reload','requestcourses',
14999: \%userenv,\%domdef,\%is_adv);
1.765 raeburn 15000: }
15001:
1.1092 raeburn 15002: $userenv{'canrequest.author'} =
15003: &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
15004: 'reload','requestauthor',
15005: \%userenv,\%domdef,\%is_adv);
15006: my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
15007: $domain,$username);
15008: my $reqstatus = $reqauthor{'author_status'};
15009: if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
15010: if (ref($reqauthor{'author'}) eq 'HASH') {
15011: $userenv{'requestauthorqueued'} = $reqstatus.':'.
15012: $reqauthor{'author'}{'timestamp'};
15013: }
15014: }
15015:
1.462 albertel 15016: $env{'user.environment'} = "$lonids/$cookie.id";
1.1062 raeburn 15017:
1.462 albertel 15018: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
15019: &GDBM_WRCREAT(),0640)) {
15020: &_add_to_env(\%disk_env,\%initial_env);
15021: &_add_to_env(\%disk_env,\%userenv,'environment.');
15022: &_add_to_env(\%disk_env,$userroles);
1.1062 raeburn 15023: if (ref($firstaccenv) eq 'HASH') {
15024: &_add_to_env(\%disk_env,$firstaccenv);
15025: }
15026: if (ref($timerintenv) eq 'HASH') {
15027: &_add_to_env(\%disk_env,$timerintenv);
15028: }
1.463 albertel 15029: if (ref($args->{'extra_env'})) {
15030: &_add_to_env(\%disk_env,$args->{'extra_env'});
15031: }
1.462 albertel 15032: untie(%disk_env);
15033: } else {
1.705 tempelho 15034: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
15035: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 15036: return 'error: '.$!;
15037: }
15038: }
15039: $env{'request.role'}='cm';
15040: $env{'request.role.adv'}=$env{'user.adv'};
15041: $env{'browser.type'}=$clientbrowser;
15042:
15043: return $cookie;
15044:
15045: }
15046:
15047: sub _add_to_env {
15048: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 15049: if (ref($env_data) eq 'HASH') {
15050: while (my ($key,$value) = each(%$env_data)) {
15051: $idf->{$prefix.$key} = $value;
15052: $env{$prefix.$key} = $value;
15053: }
1.462 albertel 15054: }
15055: }
15056:
1.685 tempelho 15057: # --- Get the symbolic name of a problem and the url
15058: sub get_symb {
15059: my ($request,$silent) = @_;
1.726 raeburn 15060: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 15061: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
15062: if ($symb eq '') {
15063: if (!$silent) {
1.1071 raeburn 15064: if (ref($request)) {
15065: $request->print("Unable to handle ambiguous references:$url:.");
15066: }
1.685 tempelho 15067: return ();
15068: }
15069: }
15070: &Apache::lonenc::check_decrypt(\$symb);
15071: return ($symb);
15072: }
15073:
15074: # --------------------------------------------------------------Get annotation
15075:
15076: sub get_annotation {
15077: my ($symb,$enc) = @_;
15078:
15079: my $key = $symb;
15080: if (!$enc) {
15081: $key =
15082: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
15083: }
15084: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
15085: return $annotation{$key};
15086: }
15087:
15088: sub clean_symb {
1.731 raeburn 15089: my ($symb,$delete_enc) = @_;
1.685 tempelho 15090:
15091: &Apache::lonenc::check_decrypt(\$symb);
15092: my $enc = $env{'request.enc'};
1.731 raeburn 15093: if ($delete_enc) {
1.730 raeburn 15094: delete($env{'request.enc'});
15095: }
1.685 tempelho 15096:
15097: return ($symb,$enc);
15098: }
1.462 albertel 15099:
1.1181 raeburn 15100: ############################################################
15101: ############################################################
15102:
15103: =pod
15104:
15105: =head1 Routines for building display used to search for courses
15106:
15107:
15108: =over 4
15109:
15110: =item * &build_filters()
15111:
15112: Create markup for a table used to set filters to use when selecting
1.1182 raeburn 15113: courses in a domain. Used by lonpickcourse.pm, lonmodifycourse.pm
15114: and quotacheck.pl
15115:
1.1181 raeburn 15116:
15117: Inputs:
15118:
15119: filterlist - anonymous array of fields to include as potential filters
15120:
15121: crstype - course type
15122:
15123: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
15124: to pop-open a course selector (will contain "extra element").
15125:
15126: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
15127:
15128: filter - anonymous hash of criteria and their values
15129:
15130: action - form action
15131:
15132: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
15133:
1.1182 raeburn 15134: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
1.1181 raeburn 15135:
15136: cloneruname - username of owner of new course who wants to clone
15137:
15138: clonerudom - domain of owner of new course who wants to clone
15139:
15140: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
15141:
15142: codetitlesref - reference to array of titles of components in institutional codes (official courses)
15143:
15144: codedom - domain
15145:
15146: formname - value of form element named "form".
15147:
15148: fixeddom - domain, if fixed.
15149:
15150: prevphase - value to assign to form element named "phase" when going back to the previous screen
15151:
15152: cnameelement - name of form element in form on opener page which will receive title of selected course
15153:
15154: cnumelement - name of form element in form on opener page which will receive courseID of selected course
15155:
15156: cdomelement - name of form element in form on opener page which will receive domain of selected course
15157:
15158: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
15159:
15160: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
15161:
15162: clonewarning - warning message about missing information for intended course owner when DC creates a course
15163:
1.1182 raeburn 15164:
1.1181 raeburn 15165: Returns: $output - HTML for display of search criteria, and hidden form elements.
15166:
1.1182 raeburn 15167:
1.1181 raeburn 15168: Side Effects: None
15169:
15170: =cut
15171:
15172: # ---------------------------------------------- search for courses based on last activity etc.
15173:
15174: sub build_filters {
15175: my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
15176: $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
15177: $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
15178: $cnameelement,$cnumelement,$cdomelement,$setroles,
15179: $clonetext,$clonewarning) = @_;
1.1182 raeburn 15180: my ($list,$jscript);
1.1181 raeburn 15181: my $onchange = 'javascript:updateFilters(this)';
15182: my ($domainselectform,$sincefilterform,$createdfilterform,
15183: $ownerdomselectform,$persondomselectform,$instcodeform,
15184: $typeselectform,$instcodetitle);
15185: if ($formname eq '') {
15186: $formname = $caller;
15187: }
15188: foreach my $item (@{$filterlist}) {
15189: unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
15190: ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
15191: if ($item eq 'domainfilter') {
15192: $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
15193: } elsif ($item eq 'coursefilter') {
15194: $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
15195: } elsif ($item eq 'ownerfilter') {
15196: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
15197: } elsif ($item eq 'ownerdomfilter') {
15198: $filter->{'ownerdomfilter'} =
15199: &LONCAPA::clean_domain($filter->{$item});
15200: $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
15201: 'ownerdomfilter',1);
15202: } elsif ($item eq 'personfilter') {
15203: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
15204: } elsif ($item eq 'persondomfilter') {
15205: $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
15206: 'persondomfilter',1);
15207: } else {
15208: $filter->{$item} =~ s/\W//g;
15209: }
15210: if (!$filter->{$item}) {
15211: $filter->{$item} = '';
15212: }
15213: }
15214: if ($item eq 'domainfilter') {
15215: my $allow_blank = 1;
15216: if ($formname eq 'portform') {
15217: $allow_blank=0;
15218: } elsif ($formname eq 'studentform') {
15219: $allow_blank=0;
15220: }
15221: if ($fixeddom) {
15222: $domainselectform = '<input type="hidden" name="domainfilter"'.
15223: ' value="'.$codedom.'" />'.
15224: &Apache::lonnet::domain($codedom,'description');
15225: } else {
15226: $domainselectform = &select_dom_form($filter->{$item},
15227: 'domainfilter',
15228: $allow_blank,'',$onchange);
15229: }
15230: } else {
15231: $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
15232: }
15233: }
15234:
15235: # last course activity filter and selection
15236: $sincefilterform = &timebased_select_form('sincefilter',$filter);
15237:
15238: # course created filter and selection
15239: if (exists($filter->{'createdfilter'})) {
15240: $createdfilterform = &timebased_select_form('createdfilter',$filter);
15241: }
15242:
15243: my %lt = &Apache::lonlocal::texthash(
15244: 'cac' => "$crstype Activity",
15245: 'ccr' => "$crstype Created",
15246: 'cde' => "$crstype Title",
15247: 'cdo' => "$crstype Domain",
15248: 'ins' => 'Institutional Code',
15249: 'inc' => 'Institutional Categorization',
15250: 'cow' => "$crstype Owner/Co-owner",
15251: 'cop' => "$crstype Personnel Includes",
15252: 'cog' => 'Type',
15253: );
15254:
15255: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
15256: my $typeval = 'Course';
15257: if ($crstype eq 'Community') {
15258: $typeval = 'Community';
15259: }
15260: $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
15261: } else {
15262: $typeselectform = '<select name="type" size="1"';
15263: if ($onchange) {
15264: $typeselectform .= ' onchange="'.$onchange.'"';
15265: }
15266: $typeselectform .= '>'."\n";
15267: foreach my $posstype ('Course','Community') {
15268: $typeselectform.='<option value="'.$posstype.'"'.
15269: ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".&mt($posstype)."</option>\n";
15270: }
15271: $typeselectform.="</select>";
15272: }
15273:
15274: my ($cloneableonlyform,$cloneabletitle);
15275: if (exists($filter->{'cloneableonly'})) {
15276: my $cloneableon = '';
15277: my $cloneableoff = ' checked="checked"';
15278: if ($filter->{'cloneableonly'}) {
15279: $cloneableon = $cloneableoff;
15280: $cloneableoff = '';
15281: }
15282: $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>';
15283: if ($formname eq 'ccrs') {
1.1187 bisitz 15284: $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1181 raeburn 15285: } else {
15286: $cloneabletitle = &mt('Cloneable by you');
15287: }
15288: }
15289: my $officialjs;
15290: if ($crstype eq 'Course') {
15291: if (exists($filter->{'instcodefilter'})) {
1.1182 raeburn 15292: # if (($fixeddom) || ($formname eq 'requestcrs') ||
15293: # ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
15294: if ($codedom) {
1.1181 raeburn 15295: $officialjs = 1;
15296: ($instcodeform,$jscript,$$numtitlesref) =
15297: &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
15298: $officialjs,$codetitlesref);
15299: if ($jscript) {
1.1182 raeburn 15300: $jscript = '<script type="text/javascript">'."\n".
15301: '// <![CDATA['."\n".
15302: $jscript."\n".
15303: '// ]]>'."\n".
15304: '</script>'."\n";
1.1181 raeburn 15305: }
15306: }
15307: if ($instcodeform eq '') {
15308: $instcodeform =
15309: '<input type="text" name="instcodefilter" size="10" value="'.
15310: $list->{'instcodefilter'}.'" />';
15311: $instcodetitle = $lt{'ins'};
15312: } else {
15313: $instcodetitle = $lt{'inc'};
15314: }
15315: if ($fixeddom) {
15316: $instcodetitle .= '<br />('.$codedom.')';
15317: }
15318: }
15319: }
15320: my $output = qq|
15321: <form method="post" name="filterpicker" action="$action">
15322: <input type="hidden" name="form" value="$formname" />
15323: |;
15324: if ($formname eq 'modifycourse') {
15325: $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
15326: '<input type="hidden" name="prevphase" value="'.
15327: $prevphase.'" />'."\n";
1.1198 musolffc 15328: } elsif ($formname eq 'quotacheck') {
15329: $output .= qq|
15330: <input type="hidden" name="sortby" value="" />
15331: <input type="hidden" name="sortorder" value="" />
15332: |;
15333: } else {
1.1181 raeburn 15334: my $name_input;
15335: if ($cnameelement ne '') {
15336: $name_input = '<input type="hidden" name="cnameelement" value="'.
15337: $cnameelement.'" />';
15338: }
15339: $output .= qq|
1.1182 raeburn 15340: <input type="hidden" name="cnumelement" value="$cnumelement" />
15341: <input type="hidden" name="cdomelement" value="$cdomelement" />
1.1181 raeburn 15342: $name_input
15343: $roleelement
15344: $multelement
15345: $typeelement
15346: |;
15347: if ($formname eq 'portform') {
15348: $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
15349: }
15350: }
15351: if ($fixeddom) {
15352: $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
15353: }
15354: $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
15355: if ($sincefilterform) {
15356: $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
15357: .$sincefilterform
15358: .&Apache::lonhtmlcommon::row_closure();
15359: }
15360: if ($createdfilterform) {
15361: $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
15362: .$createdfilterform
15363: .&Apache::lonhtmlcommon::row_closure();
15364: }
15365: if ($domainselectform) {
15366: $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
15367: .$domainselectform
15368: .&Apache::lonhtmlcommon::row_closure();
15369: }
15370: if ($typeselectform) {
15371: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
15372: $output .= $typeselectform;
15373: } else {
15374: $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
15375: .$typeselectform
15376: .&Apache::lonhtmlcommon::row_closure();
15377: }
15378: }
15379: if ($instcodeform) {
15380: $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
15381: .$instcodeform
15382: .&Apache::lonhtmlcommon::row_closure();
15383: }
15384: if (exists($filter->{'ownerfilter'})) {
15385: $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
15386: '<table><tr><td>'.&mt('Username').'<br />'.
15387: '<input type="text" name="ownerfilter" size="20" value="'.
15388: $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
15389: $ownerdomselectform.'</td></tr></table>'.
15390: &Apache::lonhtmlcommon::row_closure();
15391: }
15392: if (exists($filter->{'personfilter'})) {
15393: $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
15394: '<table><tr><td>'.&mt('Username').'<br />'.
15395: '<input type="text" name="personfilter" size="20" value="'.
15396: $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
15397: $persondomselectform.'</td></tr></table>'.
15398: &Apache::lonhtmlcommon::row_closure();
15399: }
15400: if (exists($filter->{'coursefilter'})) {
15401: $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
15402: .'<input type="text" name="coursefilter" size="25" value="'
15403: .$list->{'coursefilter'}.'" />'
15404: .&Apache::lonhtmlcommon::row_closure();
15405: }
15406: if ($cloneableonlyform) {
15407: $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
15408: $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
15409: }
15410: if (exists($filter->{'descriptfilter'})) {
15411: $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
15412: .'<input type="text" name="descriptfilter" size="40" value="'
15413: .$list->{'descriptfilter'}.'" />'
15414: .&Apache::lonhtmlcommon::row_closure(1);
15415: }
15416: $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
15417: '<input type="hidden" name="updater" value="" />'."\n".
15418: '<input type="submit" name="gosearch" value="'.
15419: &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
15420: return $jscript.$clonewarning.$output;
15421: }
15422:
15423: =pod
15424:
15425: =item * &timebased_select_form()
15426:
1.1182 raeburn 15427: Create markup for a dropdown list used to select a time-based
1.1181 raeburn 15428: filter e.g., Course Activity, Course Created, when searching for courses
15429: or communities
15430:
15431: Inputs:
15432:
15433: item - name of form element (sincefilter or createdfilter)
15434:
15435: filter - anonymous hash of criteria and their values
15436:
15437: Returns: HTML for a select box contained a blank, then six time selections,
15438: with value set in incoming form variables currently selected.
15439:
15440: Side Effects: None
15441:
15442: =cut
15443:
15444: sub timebased_select_form {
15445: my ($item,$filter) = @_;
15446: if (ref($filter) eq 'HASH') {
15447: $filter->{$item} =~ s/[^\d-]//g;
15448: if (!$filter->{$item}) { $filter->{$item}=-1; }
15449: return &select_form(
15450: $filter->{$item},
15451: $item,
15452: { '-1' => '',
15453: '86400' => &mt('today'),
15454: '604800' => &mt('last week'),
15455: '2592000' => &mt('last month'),
15456: '7776000' => &mt('last three months'),
15457: '15552000' => &mt('last six months'),
15458: '31104000' => &mt('last year'),
15459: 'select_form_order' =>
15460: ['-1','86400','604800','2592000','7776000',
15461: '15552000','31104000']});
15462: }
15463: }
15464:
15465: =pod
15466:
15467: =item * &js_changer()
15468:
15469: Create script tag containing Javascript used to submit course search form
1.1183 raeburn 15470: when course type or domain is changed, and also to hide 'Searching ...' on
15471: page load completion for page showing search result.
1.1181 raeburn 15472:
15473: Inputs: None
15474:
1.1183 raeburn 15475: Returns: markup containing updateFilters() and hideSearching() javascript functions.
1.1181 raeburn 15476:
15477: Side Effects: None
15478:
15479: =cut
15480:
15481: sub js_changer {
15482: return <<ENDJS;
15483: <script type="text/javascript">
15484: // <![CDATA[
15485: function updateFilters(caller) {
15486: if (typeof(caller) != "undefined") {
15487: document.filterpicker.updater.value = caller.name;
15488: }
15489: document.filterpicker.submit();
15490: }
1.1183 raeburn 15491:
15492: function hideSearching() {
15493: if (document.getElementById('searching')) {
15494: document.getElementById('searching').style.display = 'none';
15495: }
15496: return;
15497: }
15498:
1.1181 raeburn 15499: // ]]>
15500: </script>
15501:
15502: ENDJS
15503: }
15504:
15505: =pod
15506:
1.1182 raeburn 15507: =item * &search_courses()
15508:
15509: Process selected filters form course search form and pass to lonnet::courseiddump
15510: to retrieve a hash for which keys are courseIDs which match the selected filters.
15511:
15512: Inputs:
15513:
15514: dom - domain being searched
15515:
15516: type - course type ('Course' or 'Community' or '.' if any).
15517:
15518: filter - anonymous hash of criteria and their values
15519:
15520: numtitles - for institutional codes - number of categories
15521:
15522: cloneruname - optional username of new course owner
15523:
15524: clonerudom - optional domain of new course owner
15525:
15526: domcloner - Optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
15527: (used when DC is using course creation form)
15528:
15529: codetitles - reference to array of titles of components in institutional codes (official courses).
15530:
15531:
15532: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
15533:
15534:
15535: Side Effects: None
15536:
15537: =cut
15538:
15539:
15540: sub search_courses {
15541: my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles) = @_;
15542: my (%courses,%showcourses,$cloner);
15543: if (($filter->{'ownerfilter'} ne '') ||
15544: ($filter->{'ownerdomfilter'} ne '')) {
15545: $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
15546: $filter->{'ownerdomfilter'};
15547: }
15548: foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
15549: if (!$filter->{$item}) {
15550: $filter->{$item}='.';
15551: }
15552: }
15553: my $now = time;
15554: my $timefilter =
15555: ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
15556: my ($createdbefore,$createdafter);
15557: if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
15558: $createdbefore = $now;
15559: $createdafter = $now-$filter->{'createdfilter'};
15560: }
15561: my ($instcodefilter,$regexpok);
15562: if ($numtitles) {
15563: if ($env{'form.official'} eq 'on') {
15564: $instcodefilter =
15565: &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
15566: $regexpok = 1;
15567: } elsif ($env{'form.official'} eq 'off') {
15568: $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
15569: unless ($instcodefilter eq '') {
15570: $regexpok = -1;
15571: }
15572: }
15573: } else {
15574: $instcodefilter = $filter->{'instcodefilter'};
15575: }
15576: if ($instcodefilter eq '') { $instcodefilter = '.'; }
15577: if ($type eq '') { $type = '.'; }
15578:
15579: if (($clonerudom ne '') && ($cloneruname ne '')) {
15580: $cloner = $cloneruname.':'.$clonerudom;
15581: }
15582: %courses = &Apache::lonnet::courseiddump($dom,
15583: $filter->{'descriptfilter'},
15584: $timefilter,
15585: $instcodefilter,
15586: $filter->{'combownerfilter'},
15587: $filter->{'coursefilter'},
15588: undef,undef,$type,$regexpok,undef,undef,
15589: undef,undef,$cloner,$env{'form.cc_clone'},
15590: $filter->{'cloneableonly'},
15591: $createdbefore,$createdafter,undef,
15592: $domcloner);
15593: if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
15594: my $ccrole;
15595: if ($type eq 'Community') {
15596: $ccrole = 'co';
15597: } else {
15598: $ccrole = 'cc';
15599: }
15600: my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
15601: $filter->{'persondomfilter'},
15602: 'userroles',undef,
15603: [$ccrole,'in','ad','ep','ta','cr'],
15604: $dom);
15605: foreach my $role (keys(%rolehash)) {
15606: my ($cnum,$cdom,$courserole) = split(':',$role);
15607: my $cid = $cdom.'_'.$cnum;
15608: if (exists($courses{$cid})) {
15609: if (ref($courses{$cid}) eq 'HASH') {
15610: if (ref($courses{$cid}{roles}) eq 'ARRAY') {
15611: if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
15612: push (@{$courses{$cid}{roles}},$courserole);
15613: }
15614: } else {
15615: $courses{$cid}{roles} = [$courserole];
15616: }
15617: $showcourses{$cid} = $courses{$cid};
15618: }
15619: }
15620: }
15621: %courses = %showcourses;
15622: }
15623: return %courses;
15624: }
15625:
15626: =pod
15627:
1.1181 raeburn 15628: =back
15629:
1.1207 ! raeburn 15630: =head1 Routines for version requirements for current course.
! 15631:
! 15632: =over 4
! 15633:
! 15634: =item * &check_release_required()
! 15635:
! 15636: Compares required LON-CAPA version with version on server, and
! 15637: if required version is newer looks for a server with the required version.
! 15638:
! 15639: Looks first at servers in user's owen domain; if none suitable, looks at
! 15640: servers in course's domain are permitted to host sessions for user's domain.
! 15641:
! 15642: Inputs:
! 15643:
! 15644: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
! 15645:
! 15646: $courseid - Course ID of current course
! 15647:
! 15648: $rolecode - User's current role in course (for switchserver query string).
! 15649:
! 15650: $required - LON-CAPA version needed by course (format: Major.Minor).
! 15651:
! 15652:
! 15653: Returns:
! 15654:
! 15655: $switchserver - query string tp append to /adm/switchserver call (if
! 15656: current server's LON-CAPA version is too old.
! 15657:
! 15658: $warning - Message is displayed if no suitable server could be found.
! 15659:
! 15660: =cut
! 15661:
! 15662: sub check_release_required {
! 15663: my ($loncaparev,$courseid,$rolecode,$required) = @_;
! 15664: my ($switchserver,$warning);
! 15665: if ($required ne '') {
! 15666: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
! 15667: my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
! 15668: if ($reqdmajor ne '' && $reqdminor ne '') {
! 15669: my $otherserver;
! 15670: if (($major eq '' && $minor eq '') ||
! 15671: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
! 15672: my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
! 15673: my $switchlcrev =
! 15674: &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
! 15675: $userdomserver);
! 15676: my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
! 15677: if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
! 15678: (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
! 15679: my $cdom = $env{'course.'.$courseid.'.domain'};
! 15680: if ($cdom ne $env{'user.domain'}) {
! 15681: my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
! 15682: my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
! 15683: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
! 15684: my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
! 15685: my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
! 15686: my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
! 15687: my $canhost =
! 15688: &Apache::lonnet::can_host_session($env{'user.domain'},
! 15689: $coursedomserver,
! 15690: $remoterev,
! 15691: $udomdefaults{'remotesessions'},
! 15692: $defdomdefaults{'hostedsessions'});
! 15693:
! 15694: if ($canhost) {
! 15695: $otherserver = $coursedomserver;
! 15696: } else {
! 15697: $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.");
! 15698: }
! 15699: } else {
! 15700: $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).");
! 15701: }
! 15702: } else {
! 15703: $otherserver = $userdomserver;
! 15704: }
! 15705: }
! 15706: if ($otherserver ne '') {
! 15707: $switchserver = 'otherserver='.$otherserver.'&role='.$rolecode;
! 15708: }
! 15709: }
! 15710: }
! 15711: return ($switchserver,$warning);
! 15712: }
! 15713:
! 15714: =pod
! 15715:
! 15716: =item * &check_release_result()
! 15717:
! 15718: Inputs:
! 15719:
! 15720: $switchwarning - Warning message if no suitable server found to host session.
! 15721:
! 15722: $switchserver - query string to append to /adm/switchserver containing lonHostID
! 15723: and current role.
! 15724:
! 15725: Returns: HTML to display with information about requirement to switch server.
! 15726: Either displaying warning with link to Roles/Courses screen or
! 15727: display link to switchserver.
! 15728:
1.1181 raeburn 15729: =cut
15730:
1.1207 ! raeburn 15731: sub check_release_result {
! 15732: my ($switchwarning,$switchserver) = @_;
! 15733: my $output = &start_page('Selected course unavailable on this server').
! 15734: '<p class="LC_warning">';
! 15735: if ($switchwarning) {
! 15736: $output .= $switchwarning.'<br /><a href="/adm/roles">';
! 15737: if (&show_course()) {
! 15738: $output .= &mt('Display courses');
! 15739: } else {
! 15740: $output .= &mt('Display roles');
! 15741: }
! 15742: $output .= '</a>';
! 15743: } elsif ($switchserver) {
! 15744: $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
! 15745: '<br />'.
! 15746: '<a href="/adm/switchserver?'.$switchserver.'">'.
! 15747: &mt('Switch Server').
! 15748: '</a>';
! 15749: }
! 15750: $output .= '</p>'.&end_page();
! 15751: return $output;
! 15752: }
! 15753:
! 15754: =pod
! 15755:
! 15756: =item * &needs_coursereinit()
! 15757:
! 15758: Determine if course contents stored for user's session needs to be
! 15759: refreshed, because content has changed since "Big Hash" last tied.
! 15760:
! 15761: Check for change is made if time last checked is more than 10 minutes ago
! 15762: (by default).
! 15763:
! 15764: Inputs:
! 15765:
! 15766: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
! 15767:
! 15768: $interval (optional) - Time which may elapse (in s) between last check for content
! 15769: change in current course. (default: 600 s).
! 15770:
! 15771: Returns: an array; first element is:
! 15772:
! 15773: =over 4
! 15774:
! 15775: 'switch' - if content updates mean user's session
! 15776: needs to be switched to a server running a newer LON-CAPA version
! 15777:
! 15778: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
! 15779: on current server hosting user's session
! 15780:
! 15781: '' - if no action required.
! 15782:
! 15783: =back
! 15784:
! 15785: If first item element is 'switch':
! 15786:
! 15787: second item is $switchwarning - Warning message if no suitable server found to host session.
! 15788:
! 15789: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
! 15790: and current role.
! 15791:
! 15792: otherwise: no other elements returned.
! 15793:
! 15794: =back
! 15795:
! 15796: =cut
! 15797:
! 15798: sub needs_coursereinit {
! 15799: my ($loncaparev,$interval) = @_;
! 15800: return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
! 15801: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
! 15802: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
! 15803: my $now = time;
! 15804: if ($interval eq '') {
! 15805: $interval = 600;
! 15806: }
! 15807: if (($now-$env{'request.course.timechecked'})>$interval) {
! 15808: my $lastchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
! 15809: &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
! 15810: if ($lastchange > $env{'request.course.tied'}) {
! 15811: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
! 15812: if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
! 15813: my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
! 15814: if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
! 15815: &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
! 15816: $curr_reqd_hash{'internal.releaserequired'}});
! 15817: my ($switchserver,$switchwarning) =
! 15818: &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
! 15819: $curr_reqd_hash{'internal.releaserequired'});
! 15820: if ($switchwarning ne '' || $switchserver ne '') {
! 15821: return ('switch',$switchwarning,$switchserver);
! 15822: }
! 15823: }
! 15824: }
! 15825: return ('update');
! 15826: }
! 15827: }
! 15828: return ();
! 15829: }
1.1181 raeburn 15830:
1.1083 raeburn 15831: sub update_content_constraints {
15832: my ($cdom,$cnum,$chome,$cid) = @_;
15833: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
15834: my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
15835: my %checkresponsetypes;
15836: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
15837: my ($item,$name,$value) = split(/:/,$key);
15838: if ($item eq 'resourcetag') {
15839: if ($name eq 'responsetype') {
15840: $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
15841: }
15842: }
15843: }
15844: my $navmap = Apache::lonnavmaps::navmap->new();
15845: if (defined($navmap)) {
15846: my %allresponses;
15847: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() },1,0)) {
15848: my %responses = $res->responseTypes();
15849: foreach my $key (keys(%responses)) {
15850: next unless(exists($checkresponsetypes{$key}));
15851: $allresponses{$key} += $responses{$key};
15852: }
15853: }
15854: foreach my $key (keys(%allresponses)) {
15855: my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
15856: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
15857: ($reqdmajor,$reqdminor) = ($major,$minor);
15858: }
15859: }
15860: undef($navmap);
15861: }
15862: unless (($reqdmajor eq '') && ($reqdminor eq '')) {
15863: &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
15864: }
15865: return;
15866: }
15867:
1.1110 raeburn 15868: sub allmaps_incourse {
15869: my ($cdom,$cnum,$chome,$cid) = @_;
15870: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
15871: $cid = $env{'request.course.id'};
15872: $cdom = $env{'course.'.$cid.'.domain'};
15873: $cnum = $env{'course.'.$cid.'.num'};
15874: $chome = $env{'course.'.$cid.'.home'};
15875: }
15876: my %allmaps = ();
15877: my $lastchange =
15878: &Apache::lonnet::get_coursechange($cdom,$cnum);
15879: if ($lastchange > $env{'request.course.tied'}) {
15880: my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
15881: unless ($ferr) {
15882: &update_content_constraints($cdom,$cnum,$chome,$cid);
15883: }
15884: }
15885: my $navmap = Apache::lonnavmaps::navmap->new();
15886: if (defined($navmap)) {
15887: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
15888: $allmaps{$res->src()} = 1;
15889: }
15890: }
15891: return \%allmaps;
15892: }
15893:
1.1083 raeburn 15894: sub parse_supplemental_title {
15895: my ($title) = @_;
15896:
15897: my ($foldertitle,$renametitle);
15898: if ($title =~ /&&&/) {
15899: $title = &HTML::Entites::decode($title);
15900: }
15901: if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
15902: $renametitle=$4;
15903: my ($time,$uname,$udom) = ($1,$2,$3);
15904: $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
15905: my $name = &plainname($uname,$udom);
15906: $name = &HTML::Entities::encode($name,'"<>&\'');
15907: $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
15908: $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.
15909: $name.': <br />'.$foldertitle;
15910: }
15911: if (wantarray) {
15912: return ($title,$foldertitle,$renametitle);
15913: }
15914: return $title;
15915: }
15916:
1.1143 raeburn 15917: sub recurse_supplemental {
15918: my ($cnum,$cdom,$suppmap,$numfiles,$errors) = @_;
15919: if ($suppmap) {
15920: my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
15921: if ($fatal) {
15922: $errors ++;
15923: } else {
15924: if ($#LONCAPA::map::resources > 0) {
15925: foreach my $res (@LONCAPA::map::resources) {
15926: my ($title,$src,$ext,$type,$status)=split(/\:/,$res);
15927: if (($src ne '') && ($status eq 'res')) {
1.1146 raeburn 15928: if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
15929: ($numfiles,$errors) = &recurse_supplemental($cnum,$cdom,$1,$numfiles,$errors);
1.1143 raeburn 15930: } else {
15931: $numfiles ++;
15932: }
15933: }
15934: }
15935: }
15936: }
15937: }
15938: return ($numfiles,$errors);
15939: }
15940:
1.1101 raeburn 15941: sub symb_to_docspath {
15942: my ($symb) = @_;
15943: return unless ($symb);
15944: my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
15945: if ($resurl=~/\.(sequence|page)$/) {
15946: $mapurl=$resurl;
15947: } elsif ($resurl eq 'adm/navmaps') {
15948: $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
15949: }
15950: my $mapresobj;
15951: my $navmap = Apache::lonnavmaps::navmap->new();
15952: if (ref($navmap)) {
15953: $mapresobj = $navmap->getResourceByUrl($mapurl);
15954: }
15955: $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
15956: my $type=$2;
15957: my $path;
15958: if (ref($mapresobj)) {
15959: my $pcslist = $mapresobj->map_hierarchy();
15960: if ($pcslist ne '') {
15961: foreach my $pc (split(/,/,$pcslist)) {
15962: next if ($pc <= 1);
15963: my $res = $navmap->getByMapPc($pc);
15964: if (ref($res)) {
15965: my $thisurl = $res->src();
15966: $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
15967: my $thistitle = $res->title();
15968: $path .= '&'.
15969: &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1146 raeburn 15970: &escape($thistitle).
1.1101 raeburn 15971: ':'.$res->randompick().
15972: ':'.$res->randomout().
15973: ':'.$res->encrypted().
15974: ':'.$res->randomorder().
15975: ':'.$res->is_page();
15976: }
15977: }
15978: }
15979: $path =~ s/^\&//;
15980: my $maptitle = $mapresobj->title();
15981: if ($mapurl eq 'default') {
1.1129 raeburn 15982: $maptitle = 'Main Content';
1.1101 raeburn 15983: }
15984: $path .= (($path ne '')? '&' : '').
15985: &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 15986: &escape($maptitle).
1.1101 raeburn 15987: ':'.$mapresobj->randompick().
15988: ':'.$mapresobj->randomout().
15989: ':'.$mapresobj->encrypted().
15990: ':'.$mapresobj->randomorder().
15991: ':'.$mapresobj->is_page();
15992: } else {
15993: my $maptitle = &Apache::lonnet::gettitle($mapurl);
15994: my $ispage = (($type eq 'page')? 1 : '');
15995: if ($mapurl eq 'default') {
1.1129 raeburn 15996: $maptitle = 'Main Content';
1.1101 raeburn 15997: }
15998: $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 15999: &escape($maptitle).':::::'.$ispage;
1.1101 raeburn 16000: }
16001: unless ($mapurl eq 'default') {
16002: $path = 'default&'.
1.1146 raeburn 16003: &escape('Main Content').
1.1101 raeburn 16004: ':::::&'.$path;
16005: }
16006: return $path;
16007: }
16008:
1.1094 raeburn 16009: sub captcha_display {
16010: my ($context,$lonhost) = @_;
16011: my ($output,$error);
16012: my ($captcha,$pubkey,$privkey) = &get_captcha_config($context,$lonhost);
1.1095 raeburn 16013: if ($captcha eq 'original') {
1.1094 raeburn 16014: $output = &create_captcha();
16015: unless ($output) {
1.1172 raeburn 16016: $error = 'captcha';
1.1094 raeburn 16017: }
16018: } elsif ($captcha eq 'recaptcha') {
16019: $output = &create_recaptcha($pubkey);
16020: unless ($output) {
1.1172 raeburn 16021: $error = 'recaptcha';
1.1094 raeburn 16022: }
16023: }
1.1176 raeburn 16024: return ($output,$error,$captcha);
1.1094 raeburn 16025: }
16026:
16027: sub captcha_response {
16028: my ($context,$lonhost) = @_;
16029: my ($captcha_chk,$captcha_error);
16030: my ($captcha,$pubkey,$privkey) = &get_captcha_config($context,$lonhost);
1.1095 raeburn 16031: if ($captcha eq 'original') {
1.1094 raeburn 16032: ($captcha_chk,$captcha_error) = &check_captcha();
16033: } elsif ($captcha eq 'recaptcha') {
16034: $captcha_chk = &check_recaptcha($privkey);
16035: } else {
16036: $captcha_chk = 1;
16037: }
16038: return ($captcha_chk,$captcha_error);
16039: }
16040:
16041: sub get_captcha_config {
16042: my ($context,$lonhost) = @_;
1.1095 raeburn 16043: my ($captcha,$pubkey,$privkey,$hashtocheck);
1.1094 raeburn 16044: my $hostname = &Apache::lonnet::hostname($lonhost);
16045: my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
16046: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1.1095 raeburn 16047: if ($context eq 'usercreation') {
16048: my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
16049: if (ref($domconfig{$context}) eq 'HASH') {
16050: $hashtocheck = $domconfig{$context}{'cancreate'};
16051: if (ref($hashtocheck) eq 'HASH') {
16052: if ($hashtocheck->{'captcha'} eq 'recaptcha') {
16053: if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
16054: $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
16055: $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
16056: }
16057: if ($privkey && $pubkey) {
16058: $captcha = 'recaptcha';
16059: } else {
16060: $captcha = 'original';
16061: }
16062: } elsif ($hashtocheck->{'captcha'} ne 'notused') {
16063: $captcha = 'original';
16064: }
1.1094 raeburn 16065: }
1.1095 raeburn 16066: } else {
16067: $captcha = 'captcha';
16068: }
16069: } elsif ($context eq 'login') {
16070: my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
16071: if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
16072: $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
16073: $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
1.1094 raeburn 16074: if ($privkey && $pubkey) {
16075: $captcha = 'recaptcha';
1.1095 raeburn 16076: } else {
16077: $captcha = 'original';
1.1094 raeburn 16078: }
1.1095 raeburn 16079: } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
16080: $captcha = 'original';
1.1094 raeburn 16081: }
16082: }
16083: return ($captcha,$pubkey,$privkey);
16084: }
16085:
16086: sub create_captcha {
16087: my %captcha_params = &captcha_settings();
16088: my ($output,$maxtries,$tries) = ('',10,0);
16089: while ($tries < $maxtries) {
16090: $tries ++;
16091: my $captcha = Authen::Captcha->new (
16092: output_folder => $captcha_params{'output_dir'},
16093: data_folder => $captcha_params{'db_dir'},
16094: );
16095: my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
16096:
16097: if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
16098: $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
16099: &mt('Type in the letters/numbers shown below').' '.
1.1176 raeburn 16100: '<input type="text" size="5" name="code" value="" autocomplete="off" />'.
16101: '<br />'.
16102: '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1094 raeburn 16103: last;
16104: }
16105: }
16106: return $output;
16107: }
16108:
16109: sub captcha_settings {
16110: my %captcha_params = (
16111: output_dir => $Apache::lonnet::perlvar{'lonCaptchaDir'},
16112: www_output_dir => "/captchaspool",
16113: db_dir => $Apache::lonnet::perlvar{'lonCaptchaDb'},
16114: numchars => '5',
16115: );
16116: return %captcha_params;
16117: }
16118:
16119: sub check_captcha {
16120: my ($captcha_chk,$captcha_error);
16121: my $code = $env{'form.code'};
16122: my $md5sum = $env{'form.crypt'};
16123: my %captcha_params = &captcha_settings();
16124: my $captcha = Authen::Captcha->new(
16125: output_folder => $captcha_params{'output_dir'},
16126: data_folder => $captcha_params{'db_dir'},
16127: );
1.1109 raeburn 16128: $captcha_chk = $captcha->check_code($code,$md5sum);
1.1094 raeburn 16129: my %captcha_hash = (
16130: 0 => 'Code not checked (file error)',
16131: -1 => 'Failed: code expired',
16132: -2 => 'Failed: invalid code (not in database)',
16133: -3 => 'Failed: invalid code (code does not match crypt)',
16134: );
16135: if ($captcha_chk != 1) {
16136: $captcha_error = $captcha_hash{$captcha_chk}
16137: }
16138: return ($captcha_chk,$captcha_error);
16139: }
16140:
16141: sub create_recaptcha {
16142: my ($pubkey) = @_;
1.1153 raeburn 16143: my $use_ssl;
16144: if ($ENV{'SERVER_PORT'} == 443) {
16145: $use_ssl = 1;
16146: }
1.1094 raeburn 16147: my $captcha = Captcha::reCAPTCHA->new;
16148: return $captcha->get_options_setter({theme => 'white'})."\n".
1.1153 raeburn 16149: $captcha->get_html($pubkey,undef,$use_ssl).
1.1094 raeburn 16150: &mt('If either word is hard to read, [_1] will replace them.',
1.1133 raeburn 16151: '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
1.1094 raeburn 16152: '<br /><br />';
16153: }
16154:
16155: sub check_recaptcha {
16156: my ($privkey) = @_;
16157: my $captcha_chk;
16158: my $captcha = Captcha::reCAPTCHA->new;
16159: my $captcha_result =
16160: $captcha->check_answer(
16161: $privkey,
16162: $ENV{'REMOTE_ADDR'},
16163: $env{'form.recaptcha_challenge_field'},
16164: $env{'form.recaptcha_response_field'},
16165: );
16166: if ($captcha_result->{is_valid}) {
16167: $captcha_chk = 1;
16168: }
16169: return $captcha_chk;
16170: }
16171:
1.1174 raeburn 16172: sub emailusername_info {
1.1177 raeburn 16173: my @fields = ('firstname','lastname','institution','web','location','officialemail');
1.1174 raeburn 16174: my %titles = &Apache::lonlocal::texthash (
16175: lastname => 'Last Name',
16176: firstname => 'First Name',
16177: institution => 'School/college/university',
16178: location => "School's city, state/province, country",
16179: web => "School's web address",
16180: officialemail => 'E-mail address at institution (if different)',
16181: );
16182: return (\@fields,\%titles);
16183: }
16184:
1.1161 raeburn 16185: sub cleanup_html {
16186: my ($incoming) = @_;
16187: my $outgoing;
16188: if ($incoming ne '') {
16189: $outgoing = $incoming;
16190: $outgoing =~ s/;/;/g;
16191: $outgoing =~ s/\#/#/g;
16192: $outgoing =~ s/\&/&/g;
16193: $outgoing =~ s/</</g;
16194: $outgoing =~ s/>/>/g;
16195: $outgoing =~ s/\(/(/g;
16196: $outgoing =~ s/\)/)/g;
16197: $outgoing =~ s/"/"/g;
16198: $outgoing =~ s/'/'/g;
16199: $outgoing =~ s/\$/$/g;
16200: $outgoing =~ s{/}{/}g;
16201: $outgoing =~ s/=/=/g;
16202: $outgoing =~ s/\\/\/g
16203: }
16204: return $outgoing;
16205: }
16206:
1.1190 musolffc 16207: # Checks for critical messages and returns a redirect url if one exists.
16208: # $interval indicates how often to check for messages.
16209: sub critical_redirect {
16210: my ($interval) = @_;
16211: if ((time-$env{'user.criticalcheck.time'})>$interval) {
16212: my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
16213: $env{'user.name'});
16214: &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
1.1191 raeburn 16215: my $redirecturl;
1.1190 musolffc 16216: if ($what[0]) {
16217: if (($what[0] ne 'con_lost') && ($what[0]!~/^error\:/)) {
16218: $redirecturl='/adm/email?critical=display';
1.1191 raeburn 16219: my $url=&Apache::lonnet::absolute_url().$redirecturl;
16220: return (1, $url);
1.1190 musolffc 16221: }
1.1191 raeburn 16222: }
16223: }
16224: return ();
1.1190 musolffc 16225: }
16226:
1.1174 raeburn 16227: # Use:
16228: # my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
16229: #
16230: ##################################################
16231: # password associated functions #
16232: ##################################################
16233: sub des_keys {
16234: # Make a new key for DES encryption.
16235: # Each key has two parts which are returned separately.
16236: # Please note: Each key must be passed through the &hex function
16237: # before it is output to the web browser. The hex versions cannot
16238: # be used to decrypt.
16239: my @hexstr=('0','1','2','3','4','5','6','7',
16240: '8','9','a','b','c','d','e','f');
16241: my $lkey='';
16242: for (0..7) {
16243: $lkey.=$hexstr[rand(15)];
16244: }
16245: my $ukey='';
16246: for (0..7) {
16247: $ukey.=$hexstr[rand(15)];
16248: }
16249: return ($lkey,$ukey);
16250: }
16251:
16252: sub des_decrypt {
16253: my ($key,$cyphertext) = @_;
16254: my $keybin=pack("H16",$key);
16255: my $cypher;
16256: if ($Crypt::DES::VERSION>=2.03) {
16257: $cypher=new Crypt::DES $keybin;
16258: } else {
16259: $cypher=new DES $keybin;
16260: }
16261: my $plaintext=
16262: $cypher->decrypt(unpack("a8",pack("H16",substr($cyphertext,0,16))));
16263: $plaintext.=
16264: $cypher->decrypt(unpack("a8",pack("H16",substr($cyphertext,16,16))));
16265: $plaintext=substr($plaintext,1,ord(substr($plaintext,0,1)) );
16266: return $plaintext;
16267: }
16268:
1.112 bowersj2 16269: 1;
16270: __END__;
1.41 ng 16271:
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