Annotation of loncom/interface/loncommon.pm, revision 1.1208
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1208 ! raeburn 4: # $Id: loncommon.pm,v 1.1207 2015/03/01 22:20:56 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.1208 ! raeburn 5079: if (($key eq 'loginvia') || ($key eq 'headtag')) {
! 5080: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
! 5081: foreach my $hostname (keys(%{$domconfig{'login'}{$key}})) {
! 5082: if (ref($domconfig{'login'}{$key}{$hostname}) eq 'HASH') {
! 5083: if ($key eq 'loginvia') {
! 5084: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
! 5085: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
! 5086: $designhash{$udom.'.login.loginvia'} = $server;
! 5087: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
! 5088:
! 5089: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
! 5090: } else {
! 5091: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
! 5092: }
1.948 raeburn 5093: }
1.1208 ! raeburn 5094: } elsif ($key eq 'headtag') {
! 5095: if ($domconfig{'login'}{'headtag'}{$hostname}{'url'}) {
! 5096: $designhash{$udom.'.login.headtag_'.$hostname} = $domconfig{'login'}{'headtag'}{$hostname}{'url'};
1.948 raeburn 5097: }
1.946 raeburn 5098: }
1.1208 ! raeburn 5099: if ($domconfig{'login'}{$key}{$hostname}{'exempt'}) {
! 5100: $designhash{$udom.'.login.'.$key.'_exempt_'.$hostname} = $domconfig{'login'}{$key}{$hostname}{'exempt'};
! 5101: }
1.946 raeburn 5102: }
5103: }
5104: }
5105: } else {
5106: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
5107: $designhash{$udom.'.login.'.$key.'_'.$img} =
5108: $domconfig{'login'}{$key}{$img};
5109: }
1.699 raeburn 5110: }
5111: } else {
5112: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
5113: }
1.632 raeburn 5114: }
5115: } else {
5116: $legacy{'login'} = 1;
1.518 albertel 5117: }
1.632 raeburn 5118: } else {
5119: $legacy{'login'} = 1;
1.518 albertel 5120: }
5121: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 5122: if (keys(%{$domconfig{'rolecolors'}})) {
5123: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
5124: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
5125: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
5126: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
5127: }
1.518 albertel 5128: }
5129: }
1.632 raeburn 5130: } else {
5131: $legacy{'rolecolors'} = 1;
1.518 albertel 5132: }
1.632 raeburn 5133: } else {
5134: $legacy{'rolecolors'} = 1;
1.518 albertel 5135: }
1.948 raeburn 5136: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
5137: if ($domconfig{'autoenroll'}{'co-owners'}) {
5138: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
5139: }
5140: }
1.632 raeburn 5141: if (keys(%legacy) > 0) {
5142: my %legacyhash = &get_legacy_domconf($udom);
5143: foreach my $item (keys(%legacyhash)) {
5144: if ($item =~ /^\Q$udom\E\.login/) {
5145: if ($legacy{'login'}) {
5146: $designhash{$item} = $legacyhash{$item};
5147: }
5148: } else {
5149: if ($legacy{'rolecolors'}) {
5150: $designhash{$item} = $legacyhash{$item};
5151: }
1.518 albertel 5152: }
5153: }
5154: }
1.632 raeburn 5155: } else {
5156: %designhash = &get_legacy_domconf($udom);
1.518 albertel 5157: }
5158: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
5159: $cachetime);
5160: return %designhash;
5161: }
5162:
1.632 raeburn 5163: sub get_legacy_domconf {
5164: my ($udom) = @_;
5165: my %legacyhash;
5166: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
5167: my $designfile = $designdir.'/'.$udom.'.tab';
5168: if (-e $designfile) {
5169: if ( open (my $fh,"<$designfile") ) {
5170: while (my $line = <$fh>) {
5171: next if ($line =~ /^\#/);
5172: chomp($line);
5173: my ($key,$val)=(split(/\=/,$line));
5174: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
5175: }
5176: close($fh);
5177: }
5178: }
1.1026 raeburn 5179: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632 raeburn 5180: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
5181: }
5182: return %legacyhash;
5183: }
5184:
1.63 www 5185: =pod
5186:
1.112 bowersj2 5187: =item * &domainlogo()
1.63 www 5188:
5189: Inputs: $domain (usually will be undef)
5190:
5191: Returns: A link to a domain logo, if the domain logo exists.
5192: If the domain logo does not exist, a description of the domain.
5193:
5194: =cut
1.112 bowersj2 5195:
1.63 www 5196: ###############################################
5197: sub domainlogo {
1.517 raeburn 5198: my $domain = &determinedomain(shift);
1.518 albertel 5199: my %designhash = &get_domainconf($domain);
1.517 raeburn 5200: # See if there is a logo
5201: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 5202: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 5203: if ($imgsrc =~ m{^/(adm|res)/}) {
5204: if ($imgsrc =~ m{^/res/}) {
5205: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
5206: &Apache::lonnet::repcopy($local_name);
5207: }
5208: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 5209: }
5210: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 5211: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
5212: return &Apache::lonnet::domain($domain,'description');
1.59 www 5213: } else {
1.60 matthew 5214: return '';
1.59 www 5215: }
5216: }
1.63 www 5217: ##############################################
5218:
5219: =pod
5220:
1.112 bowersj2 5221: =item * &designparm()
1.63 www 5222:
5223: Inputs: $which parameter; $domain (usually will be undef)
5224:
5225: Returns: value of designparamter $which
5226:
5227: =cut
1.112 bowersj2 5228:
1.397 albertel 5229:
1.400 albertel 5230: ##############################################
1.397 albertel 5231: sub designparm {
5232: my ($which,$domain)=@_;
5233: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 5234: return $env{'environment.color.'.$which};
1.96 www 5235: }
1.63 www 5236: $domain=&determinedomain($domain);
1.1016 raeburn 5237: my %domdesign;
5238: unless ($domain eq 'public') {
5239: %domdesign = &get_domainconf($domain);
5240: }
1.520 raeburn 5241: my $output;
1.517 raeburn 5242: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 5243: $output = $domdesign{$domain.'.'.$which};
1.63 www 5244: } else {
1.520 raeburn 5245: $output = $defaultdesign{$which};
5246: }
5247: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 5248: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 5249: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 5250: if ($output =~ m{^/res/}) {
5251: my $local_name = &Apache::lonnet::filelocation('',$output);
5252: &Apache::lonnet::repcopy($local_name);
5253: }
1.520 raeburn 5254: $output = &lonhttpdurl($output);
5255: }
1.63 www 5256: }
1.520 raeburn 5257: return $output;
1.63 www 5258: }
1.59 www 5259:
1.822 bisitz 5260: ##############################################
5261: =pod
5262:
1.832 bisitz 5263: =item * &authorspace()
5264:
1.1028 raeburn 5265: Inputs: $url (usually will be undef).
1.832 bisitz 5266:
1.1132 raeburn 5267: Returns: Path to Authoring Space containing the resource or
1.1028 raeburn 5268: directory being viewed (or for which action is being taken).
5269: If $url is provided, and begins /priv/<domain>/<uname>
5270: the path will be that portion of the $context argument.
5271: Otherwise the path will be for the author space of the current
5272: user when the current role is author, or for that of the
5273: co-author/assistant co-author space when the current role
5274: is co-author or assistant co-author.
1.832 bisitz 5275:
5276: =cut
5277:
5278: sub authorspace {
1.1028 raeburn 5279: my ($url) = @_;
5280: if ($url ne '') {
5281: if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
5282: return $1;
5283: }
5284: }
1.832 bisitz 5285: my $caname = '';
1.1024 www 5286: my $cadom = '';
1.1028 raeburn 5287: if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024 www 5288: ($cadom,$caname) =
1.832 bisitz 5289: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028 raeburn 5290: } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832 bisitz 5291: $caname = $env{'user.name'};
1.1024 www 5292: $cadom = $env{'user.domain'};
1.832 bisitz 5293: }
1.1028 raeburn 5294: if (($caname ne '') && ($cadom ne '')) {
5295: return "/priv/$cadom/$caname/";
5296: }
5297: return;
1.832 bisitz 5298: }
5299:
5300: ##############################################
5301: =pod
5302:
1.822 bisitz 5303: =item * &head_subbox()
5304:
5305: Inputs: $content (contains HTML code with page functions, etc.)
5306:
5307: Returns: HTML div with $content
5308: To be included in page header
5309:
5310: =cut
5311:
5312: sub head_subbox {
5313: my ($content)=@_;
5314: my $output =
1.993 raeburn 5315: '<div class="LC_head_subbox">'
1.822 bisitz 5316: .$content
5317: .'</div>'
5318: }
5319:
5320: ##############################################
5321: =pod
5322:
5323: =item * &CSTR_pageheader()
5324:
1.1026 raeburn 5325: Input: (optional) filename from which breadcrumb trail is built.
5326: In most cases no input as needed, as $env{'request.filename'}
5327: is appropriate for use in building the breadcrumb trail.
1.822 bisitz 5328:
5329: Returns: HTML div with CSTR path and recent box
1.1132 raeburn 5330: To be included on Authoring Space pages
1.822 bisitz 5331:
5332: =cut
5333:
5334: sub CSTR_pageheader {
1.1026 raeburn 5335: my ($trailfile) = @_;
5336: if ($trailfile eq '') {
5337: $trailfile = $env{'request.filename'};
5338: }
5339:
5340: # this is for resources; directories have customtitle, and crumbs
5341: # and select recent are created in lonpubdir.pm
5342:
5343: my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022 www 5344: my ($udom,$uname,$thisdisfn)=
1.1113 raeburn 5345: ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)(?:|/(.*))$});
1.1026 raeburn 5346: my $formaction = "/priv/$udom/$uname/$thisdisfn";
5347: $formaction =~ s{/+}{/}g;
1.822 bisitz 5348:
5349: my $parentpath = '';
5350: my $lastitem = '';
5351: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
5352: $parentpath = $1;
5353: $lastitem = $2;
5354: } else {
5355: $lastitem = $thisdisfn;
5356: }
1.921 bisitz 5357:
5358: my $output =
1.822 bisitz 5359: '<div>'
5360: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
1.1132 raeburn 5361: .'<b>'.&mt('Authoring Space:').'</b> '
1.822 bisitz 5362: .'<form name="dirs" method="post" action="'.$formaction
1.921 bisitz 5363: .'" target="_top">' #FIXME lonpubdir: target="_parent"
1.1024 www 5364: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv/'.$udom,undef,undef);
1.921 bisitz 5365:
5366: if ($lastitem) {
5367: $output .=
5368: '<span class="LC_filename">'
5369: .$lastitem
5370: .'</span>';
5371: }
5372: $output .=
5373: '<br />'
1.822 bisitz 5374: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
5375: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
5376: .'</form>'
5377: .&Apache::lonmenu::constspaceform()
5378: .'</div>';
1.921 bisitz 5379:
5380: return $output;
1.822 bisitz 5381: }
5382:
1.60 matthew 5383: ###############################################
5384: ###############################################
5385:
5386: =pod
5387:
1.112 bowersj2 5388: =back
5389:
1.549 albertel 5390: =head1 HTML Helpers
1.112 bowersj2 5391:
5392: =over 4
5393:
5394: =item * &bodytag()
1.60 matthew 5395:
5396: Returns a uniform header for LON-CAPA web pages.
5397:
5398: Inputs:
5399:
1.112 bowersj2 5400: =over 4
5401:
5402: =item * $title, A title to be displayed on the page.
5403:
5404: =item * $function, the current role (can be undef).
5405:
5406: =item * $addentries, extra parameters for the <body> tag.
5407:
5408: =item * $bodyonly, if defined, only return the <body> tag.
5409:
5410: =item * $domain, if defined, force a given domain.
5411:
5412: =item * $forcereg, if page should register as content page (relevant for
1.86 www 5413: text interface only)
1.60 matthew 5414:
1.814 bisitz 5415: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
5416: navigational links
1.317 albertel 5417:
1.338 albertel 5418: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
5419:
1.460 albertel 5420: =item * $args, optional argument valid values are
5421: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 5422: inherit_jsmath -> when creating popup window in a page,
5423: should it have jsmath forced on by the
5424: current page
1.460 albertel 5425:
1.1096 raeburn 5426: =item * $advtoolsref, optional argument, ref to an array containing
5427: inlineremote items to be added in "Functions" menu below
5428: breadcrumbs.
5429:
1.112 bowersj2 5430: =back
5431:
1.60 matthew 5432: Returns: A uniform header for LON-CAPA web pages.
5433: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
5434: If $bodyonly is undef or zero, an html string containing a <body> tag and
5435: other decorations will be returned.
5436:
5437: =cut
5438:
1.54 www 5439: sub bodytag {
1.831 bisitz 5440: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1096 raeburn 5441: $no_nav_bar,$bgcolor,$args,$advtoolsref)=@_;
1.339 albertel 5442:
1.954 raeburn 5443: my $public;
5444: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
5445: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
5446: $public = 1;
5447: }
1.460 albertel 5448: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1154 raeburn 5449: my $httphost = $args->{'use_absolute'};
1.339 albertel 5450:
1.183 matthew 5451: $function = &get_users_function() if (!$function);
1.339 albertel 5452: my $img = &designparm($function.'.img',$domain);
5453: my $font = &designparm($function.'.font',$domain);
5454: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
5455:
1.803 bisitz 5456: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 5457: 'bgcolor' => $pgbg,
1.339 albertel 5458: 'text' => $font,
5459: 'alink' => &designparm($function.'.alink',$domain),
5460: 'vlink' => &designparm($function.'.vlink',$domain),
5461: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 5462: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 5463:
1.63 www 5464: # role and realm
1.1178 raeburn 5465: my ($role,$realm) = split(m{\./},$env{'request.role'},2);
5466: if ($realm) {
5467: $realm = '/'.$realm;
5468: }
1.378 raeburn 5469: if ($role eq 'ca') {
1.479 albertel 5470: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 5471: $realm = &plainname($rname,$rdom);
1.378 raeburn 5472: }
1.55 www 5473: # realm
1.258 albertel 5474: if ($env{'request.course.id'}) {
1.378 raeburn 5475: if ($env{'request.role'} !~ /^cr/) {
5476: $role = &Apache::lonnet::plaintext($role,&course_type());
5477: }
1.898 raeburn 5478: if ($env{'request.course.sec'}) {
5479: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
5480: }
1.359 albertel 5481: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 5482: } else {
5483: $role = &Apache::lonnet::plaintext($role);
1.54 www 5484: }
1.433 albertel 5485:
1.359 albertel 5486: if (!$realm) { $realm=' '; }
1.330 albertel 5487:
1.438 albertel 5488: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 5489:
1.101 www 5490: # construct main body tag
1.359 albertel 5491: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 5492: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 5493:
1.1131 raeburn 5494: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
5495:
1.1130 raeburn 5496: if (($bodyonly) || ($no_nav_bar) || ($env{'form.inhibitmenu'} eq 'yes')) {
1.60 matthew 5497: return $bodytag;
1.1130 raeburn 5498: }
1.359 albertel 5499:
1.954 raeburn 5500: if ($public) {
1.433 albertel 5501: undef($role);
5502: }
1.359 albertel 5503:
1.762 bisitz 5504: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 5505: #
5506: # Extra info if you are the DC
5507: my $dc_info = '';
5508: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
5509: $env{'course.'.$env{'request.course.id'}.
5510: '.domain'}.'/'})) {
5511: my $cid = $env{'request.course.id'};
1.917 raeburn 5512: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 5513: $dc_info =~ s/\s+$//;
1.359 albertel 5514: }
5515:
1.898 raeburn 5516: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853 droeschl 5517:
1.903 droeschl 5518: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
5519:
5520: # if ($env{'request.state'} eq 'construct') {
5521: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
5522: # }
5523:
1.1130 raeburn 5524: $bodytag .= Apache::lonhtmlcommon::scripttag(
1.1154 raeburn 5525: Apache::lonmenu::utilityfunctions($httphost), 'start');
1.359 albertel 5526:
1.1130 raeburn 5527: my ($left,$right) = Apache::lonmenu::primary_menu();
1.359 albertel 5528:
1.916 droeschl 5529: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917 raeburn 5530: if ($dc_info) {
5531: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
5532: }
1.1130 raeburn 5533: $bodytag .= qq|<div id="LC_nav_bar">$left $role<br />
1.916 droeschl 5534: <em>$realm</em> $dc_info</div>|;
1.903 droeschl 5535: return $bodytag;
5536: }
1.894 droeschl 5537:
1.927 raeburn 5538: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
1.1130 raeburn 5539: $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
1.927 raeburn 5540: }
1.916 droeschl 5541:
1.1130 raeburn 5542: $bodytag .= $right;
1.852 droeschl 5543:
1.917 raeburn 5544: if ($dc_info) {
5545: $dc_info = &dc_courseid_toggle($dc_info);
5546: }
5547: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 5548:
1.1169 raeburn 5549: #if directed to not display the secondary menu, don't.
1.1168 raeburn 5550: if ($args->{'no_secondary_menu'}) {
5551: return $bodytag;
5552: }
1.1169 raeburn 5553: #don't show menus for public users
1.954 raeburn 5554: if (!$public){
1.1154 raeburn 5555: $bodytag .= Apache::lonmenu::secondary_menu($httphost);
1.903 droeschl 5556: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 5557: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
5558: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 5559: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.920 raeburn 5560: $args->{'bread_crumbs'});
1.1096 raeburn 5561: } elsif ($forcereg) {
5562: $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
5563: $args->{'group'});
5564: } else {
5565: $bodytag .=
5566: &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
5567: $forcereg,$args->{'group'},
5568: $args->{'bread_crumbs'},
5569: $advtoolsref);
1.920 raeburn 5570: }
1.903 droeschl 5571: }else{
5572: # this is to seperate menu from content when there's no secondary
5573: # menu. Especially needed for public accessible ressources.
5574: $bodytag .= '<hr style="clear:both" />';
5575: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 5576: }
1.903 droeschl 5577:
1.235 raeburn 5578: return $bodytag;
1.182 matthew 5579: }
5580:
1.917 raeburn 5581: sub dc_courseid_toggle {
5582: my ($dc_info) = @_;
1.980 raeburn 5583: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069 raeburn 5584: '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917 raeburn 5585: &mt('(More ...)').'</a></span>'.
5586: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
5587: }
5588:
1.330 albertel 5589: sub make_attr_string {
5590: my ($register,$attr_ref) = @_;
5591:
5592: if ($attr_ref && !ref($attr_ref)) {
5593: die("addentries Must be a hash ref ".
5594: join(':',caller(1))." ".
5595: join(':',caller(0))." ");
5596: }
5597:
5598: if ($register) {
1.339 albertel 5599: my ($on_load,$on_unload);
5600: foreach my $key (keys(%{$attr_ref})) {
5601: if (lc($key) eq 'onload') {
5602: $on_load.=$attr_ref->{$key}.';';
5603: delete($attr_ref->{$key});
5604:
5605: } elsif (lc($key) eq 'onunload') {
5606: $on_unload.=$attr_ref->{$key}.';';
5607: delete($attr_ref->{$key});
5608: }
5609: }
1.953 droeschl 5610: $attr_ref->{'onload'} = $on_load;
5611: $attr_ref->{'onunload'}= $on_unload;
1.330 albertel 5612: }
1.339 albertel 5613:
1.330 albertel 5614: my $attr_string;
1.1159 raeburn 5615: foreach my $attr (sort(keys(%$attr_ref))) {
1.330 albertel 5616: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
5617: }
5618: return $attr_string;
5619: }
5620:
5621:
1.182 matthew 5622: ###############################################
1.251 albertel 5623: ###############################################
5624:
5625: =pod
5626:
5627: =item * &endbodytag()
5628:
5629: Returns a uniform footer for LON-CAPA web pages.
5630:
1.635 raeburn 5631: Inputs: 1 - optional reference to an args hash
5632: If in the hash, key for noredirectlink has a value which evaluates to true,
5633: a 'Continue' link is not displayed if the page contains an
5634: internal redirect in the <head></head> section,
5635: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 5636:
5637: =cut
5638:
5639: sub endbodytag {
1.635 raeburn 5640: my ($args) = @_;
1.1080 raeburn 5641: my $endbodytag;
5642: unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
5643: $endbodytag='</body>';
5644: }
1.269 albertel 5645: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 5646: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 5647: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
5648: $endbodytag=
5649: "<br /><a href=\"$env{'internal.head.redirect'}\">".
5650: &mt('Continue').'</a>'.
5651: $endbodytag;
5652: }
1.315 albertel 5653: }
1.251 albertel 5654: return $endbodytag;
5655: }
5656:
1.352 albertel 5657: =pod
5658:
5659: =item * &standard_css()
5660:
5661: Returns a style sheet
5662:
5663: Inputs: (all optional)
5664: domain -> force to color decorate a page for a specific
5665: domain
5666: function -> force usage of a specific rolish color scheme
5667: bgcolor -> override the default page bgcolor
5668:
5669: =cut
5670:
1.343 albertel 5671: sub standard_css {
1.345 albertel 5672: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 5673: $function = &get_users_function() if (!$function);
5674: my $img = &designparm($function.'.img', $domain);
5675: my $tabbg = &designparm($function.'.tabbg', $domain);
5676: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 5677: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 5678: #second colour for later usage
1.345 albertel 5679: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 5680: my $pgbg_or_bgcolor =
5681: $bgcolor ||
1.352 albertel 5682: &designparm($function.'.pgbg', $domain);
1.382 albertel 5683: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 5684: my $alink = &designparm($function.'.alink', $domain);
5685: my $vlink = &designparm($function.'.vlink', $domain);
5686: my $link = &designparm($function.'.link', $domain);
5687:
1.602 albertel 5688: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 5689: my $mono = 'monospace';
1.850 bisitz 5690: my $data_table_head = $sidebg;
5691: my $data_table_light = '#FAFAFA';
1.1060 bisitz 5692: my $data_table_dark = '#E0E0E0';
1.470 banghart 5693: my $data_table_darker = '#CCCCCC';
1.349 albertel 5694: my $data_table_highlight = '#FFFF00';
1.352 albertel 5695: my $mail_new = '#FFBB77';
5696: my $mail_new_hover = '#DD9955';
5697: my $mail_read = '#BBBB77';
5698: my $mail_read_hover = '#999944';
5699: my $mail_replied = '#AAAA88';
5700: my $mail_replied_hover = '#888855';
5701: my $mail_other = '#99BBBB';
5702: my $mail_other_hover = '#669999';
1.391 albertel 5703: my $table_header = '#DDDDDD';
1.489 raeburn 5704: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 5705: my $lg_border_color = '#C8C8C8';
1.952 onken 5706: my $button_hover = '#BF2317';
1.392 albertel 5707:
1.608 albertel 5708: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 5709: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
5710: : '0 3px 0 4px';
1.448 albertel 5711:
1.523 albertel 5712:
1.343 albertel 5713: return <<END;
1.947 droeschl 5714:
5715: /* needed for iframe to allow 100% height in FF */
5716: body, html {
5717: margin: 0;
5718: padding: 0 0.5%;
5719: height: 99%; /* to avoid scrollbars */
5720: }
5721:
1.795 www 5722: body {
1.911 bisitz 5723: font-family: $sans;
5724: line-height:130%;
5725: font-size:0.83em;
5726: color:$font;
1.795 www 5727: }
5728:
1.959 onken 5729: a:focus,
5730: a:focus img {
1.795 www 5731: color: red;
5732: }
1.698 harmsja 5733:
1.911 bisitz 5734: form, .inline {
5735: display: inline;
1.795 www 5736: }
1.721 harmsja 5737:
1.795 www 5738: .LC_right {
1.911 bisitz 5739: text-align:right;
1.795 www 5740: }
5741:
5742: .LC_middle {
1.911 bisitz 5743: vertical-align:middle;
1.795 www 5744: }
1.721 harmsja 5745:
1.1130 raeburn 5746: .LC_floatleft {
5747: float: left;
5748: }
5749:
5750: .LC_floatright {
5751: float: right;
5752: }
5753:
1.911 bisitz 5754: .LC_400Box {
5755: width:400px;
5756: }
1.721 harmsja 5757:
1.947 droeschl 5758: .LC_iframecontainer {
5759: width: 98%;
5760: margin: 0;
5761: position: fixed;
5762: top: 8.5em;
5763: bottom: 0;
5764: }
5765:
5766: .LC_iframecontainer iframe{
5767: border: none;
5768: width: 100%;
5769: height: 100%;
5770: }
5771:
1.778 bisitz 5772: .LC_filename {
5773: font-family: $mono;
5774: white-space:pre;
1.921 bisitz 5775: font-size: 120%;
1.778 bisitz 5776: }
5777:
5778: .LC_fileicon {
5779: border: none;
5780: height: 1.3em;
5781: vertical-align: text-bottom;
5782: margin-right: 0.3em;
5783: text-decoration:none;
5784: }
5785:
1.1008 www 5786: .LC_setting {
5787: text-decoration:underline;
5788: }
5789:
1.350 albertel 5790: .LC_error {
5791: color: red;
5792: }
1.795 www 5793:
1.1097 bisitz 5794: .LC_warning {
5795: color: darkorange;
5796: }
5797:
1.457 albertel 5798: .LC_diff_removed {
1.733 bisitz 5799: color: red;
1.394 albertel 5800: }
1.532 albertel 5801:
5802: .LC_info,
1.457 albertel 5803: .LC_success,
5804: .LC_diff_added {
1.350 albertel 5805: color: green;
5806: }
1.795 www 5807:
1.802 bisitz 5808: div.LC_confirm_box {
5809: background-color: #FAFAFA;
5810: border: 1px solid $lg_border_color;
5811: margin-right: 0;
5812: padding: 5px;
5813: }
5814:
5815: div.LC_confirm_box .LC_error img,
5816: div.LC_confirm_box .LC_success img {
5817: vertical-align: middle;
5818: }
5819:
1.440 albertel 5820: .LC_icon {
1.771 droeschl 5821: border: none;
1.790 droeschl 5822: vertical-align: middle;
1.771 droeschl 5823: }
5824:
1.543 albertel 5825: .LC_docs_spacer {
5826: width: 25px;
5827: height: 1px;
1.771 droeschl 5828: border: none;
1.543 albertel 5829: }
1.346 albertel 5830:
1.532 albertel 5831: .LC_internal_info {
1.735 bisitz 5832: color: #999999;
1.532 albertel 5833: }
5834:
1.794 www 5835: .LC_discussion {
1.1050 www 5836: background: $data_table_dark;
1.911 bisitz 5837: border: 1px solid black;
5838: margin: 2px;
1.794 www 5839: }
5840:
5841: .LC_disc_action_left {
1.1050 www 5842: background: $sidebg;
1.911 bisitz 5843: text-align: left;
1.1050 www 5844: padding: 4px;
5845: margin: 2px;
1.794 www 5846: }
5847:
5848: .LC_disc_action_right {
1.1050 www 5849: background: $sidebg;
1.911 bisitz 5850: text-align: right;
1.1050 www 5851: padding: 4px;
5852: margin: 2px;
1.794 www 5853: }
5854:
5855: .LC_disc_new_item {
1.911 bisitz 5856: background: white;
5857: border: 2px solid red;
1.1050 www 5858: margin: 4px;
5859: padding: 4px;
1.794 www 5860: }
5861:
5862: .LC_disc_old_item {
1.911 bisitz 5863: background: white;
1.1050 www 5864: margin: 4px;
5865: padding: 4px;
1.794 www 5866: }
5867:
1.458 albertel 5868: table.LC_pastsubmission {
5869: border: 1px solid black;
5870: margin: 2px;
5871: }
5872:
1.924 bisitz 5873: table#LC_menubuttons {
1.345 albertel 5874: width: 100%;
5875: background: $pgbg;
1.392 albertel 5876: border: 2px;
1.402 albertel 5877: border-collapse: separate;
1.803 bisitz 5878: padding: 0;
1.345 albertel 5879: }
1.392 albertel 5880:
1.801 tempelho 5881: table#LC_title_bar a {
5882: color: $fontmenu;
5883: }
1.836 bisitz 5884:
1.807 droeschl 5885: table#LC_title_bar {
1.819 tempelho 5886: clear: both;
1.836 bisitz 5887: display: none;
1.807 droeschl 5888: }
5889:
1.795 www 5890: table#LC_title_bar,
1.933 droeschl 5891: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 5892: table#LC_title_bar.LC_with_remote {
1.359 albertel 5893: width: 100%;
1.392 albertel 5894: border-color: $pgbg;
5895: border-style: solid;
5896: border-width: $border;
1.379 albertel 5897: background: $pgbg;
1.801 tempelho 5898: color: $fontmenu;
1.392 albertel 5899: border-collapse: collapse;
1.803 bisitz 5900: padding: 0;
1.819 tempelho 5901: margin: 0;
1.359 albertel 5902: }
1.795 www 5903:
1.933 droeschl 5904: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 5905: margin: 0;
5906: padding: 0;
1.933 droeschl 5907: position: relative;
5908: list-style: none;
1.913 droeschl 5909: }
1.933 droeschl 5910: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 5911: display: inline;
5912: }
1.933 droeschl 5913:
5914: .LC_breadcrumb_tools_navigation {
1.913 droeschl 5915: padding: 0;
1.933 droeschl 5916: margin: 0;
5917: float: left;
1.913 droeschl 5918: }
1.933 droeschl 5919: .LC_breadcrumb_tools_tools {
5920: padding: 0;
5921: margin: 0;
1.913 droeschl 5922: float: right;
5923: }
5924:
1.359 albertel 5925: table#LC_title_bar td {
5926: background: $tabbg;
5927: }
1.795 www 5928:
1.911 bisitz 5929: table#LC_menubuttons img {
1.803 bisitz 5930: border: none;
1.346 albertel 5931: }
1.795 www 5932:
1.842 droeschl 5933: .LC_breadcrumbs_component {
1.911 bisitz 5934: float: right;
5935: margin: 0 1em;
1.357 albertel 5936: }
1.842 droeschl 5937: .LC_breadcrumbs_component img {
1.911 bisitz 5938: vertical-align: middle;
1.777 tempelho 5939: }
1.795 www 5940:
1.383 albertel 5941: td.LC_table_cell_checkbox {
5942: text-align: center;
5943: }
1.795 www 5944:
5945: .LC_fontsize_small {
1.911 bisitz 5946: font-size: 70%;
1.705 tempelho 5947: }
5948:
1.844 bisitz 5949: #LC_breadcrumbs {
1.911 bisitz 5950: clear:both;
5951: background: $sidebg;
5952: border-bottom: 1px solid $lg_border_color;
5953: line-height: 2.5em;
1.933 droeschl 5954: overflow: hidden;
1.911 bisitz 5955: margin: 0;
5956: padding: 0;
1.995 raeburn 5957: text-align: left;
1.819 tempelho 5958: }
1.862 bisitz 5959:
1.1098 bisitz 5960: .LC_head_subbox, .LC_actionbox {
1.911 bisitz 5961: clear:both;
5962: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 5963: border: 1px solid $sidebg;
1.1098 bisitz 5964: margin: 0 0 10px 0;
1.966 bisitz 5965: padding: 3px;
1.995 raeburn 5966: text-align: left;
1.822 bisitz 5967: }
5968:
1.795 www 5969: .LC_fontsize_medium {
1.911 bisitz 5970: font-size: 85%;
1.705 tempelho 5971: }
5972:
1.795 www 5973: .LC_fontsize_large {
1.911 bisitz 5974: font-size: 120%;
1.705 tempelho 5975: }
5976:
1.346 albertel 5977: .LC_menubuttons_inline_text {
5978: color: $font;
1.698 harmsja 5979: font-size: 90%;
1.701 harmsja 5980: padding-left:3px;
1.346 albertel 5981: }
5982:
1.934 droeschl 5983: .LC_menubuttons_inline_text img{
5984: vertical-align: middle;
5985: }
5986:
1.1051 www 5987: li.LC_menubuttons_inline_text img {
1.951 onken 5988: cursor:pointer;
1.1002 droeschl 5989: text-decoration: none;
1.951 onken 5990: }
5991:
1.526 www 5992: .LC_menubuttons_link {
5993: text-decoration: none;
5994: }
1.795 www 5995:
1.522 albertel 5996: .LC_menubuttons_category {
1.521 www 5997: color: $font;
1.526 www 5998: background: $pgbg;
1.521 www 5999: font-size: larger;
6000: font-weight: bold;
6001: }
6002:
1.346 albertel 6003: td.LC_menubuttons_text {
1.911 bisitz 6004: color: $font;
1.346 albertel 6005: }
1.706 harmsja 6006:
1.346 albertel 6007: .LC_current_location {
6008: background: $tabbg;
6009: }
1.795 www 6010:
1.938 bisitz 6011: table.LC_data_table {
1.347 albertel 6012: border: 1px solid #000000;
1.402 albertel 6013: border-collapse: separate;
1.426 albertel 6014: border-spacing: 1px;
1.610 albertel 6015: background: $pgbg;
1.347 albertel 6016: }
1.795 www 6017:
1.422 albertel 6018: .LC_data_table_dense {
6019: font-size: small;
6020: }
1.795 www 6021:
1.507 raeburn 6022: table.LC_nested_outer {
6023: border: 1px solid #000000;
1.589 raeburn 6024: border-collapse: collapse;
1.803 bisitz 6025: border-spacing: 0;
1.507 raeburn 6026: width: 100%;
6027: }
1.795 www 6028:
1.879 raeburn 6029: table.LC_innerpickbox,
1.507 raeburn 6030: table.LC_nested {
1.803 bisitz 6031: border: none;
1.589 raeburn 6032: border-collapse: collapse;
1.803 bisitz 6033: border-spacing: 0;
1.507 raeburn 6034: width: 100%;
6035: }
1.795 www 6036:
1.911 bisitz 6037: table.LC_data_table tr th,
6038: table.LC_calendar tr th,
1.879 raeburn 6039: table.LC_prior_tries tr th,
6040: table.LC_innerpickbox tr th {
1.349 albertel 6041: font-weight: bold;
6042: background-color: $data_table_head;
1.801 tempelho 6043: color:$fontmenu;
1.701 harmsja 6044: font-size:90%;
1.347 albertel 6045: }
1.795 www 6046:
1.879 raeburn 6047: table.LC_innerpickbox tr th,
6048: table.LC_innerpickbox tr td {
6049: vertical-align: top;
6050: }
6051:
1.711 raeburn 6052: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 6053: background-color: #CCCCCC;
1.711 raeburn 6054: font-weight: bold;
6055: text-align: left;
6056: }
1.795 www 6057:
1.912 bisitz 6058: table.LC_data_table tr.LC_odd_row > td {
6059: background-color: $data_table_light;
6060: padding: 2px;
6061: vertical-align: top;
6062: }
6063:
1.809 bisitz 6064: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 6065: background-color: $data_table_light;
1.912 bisitz 6066: vertical-align: top;
6067: }
6068:
6069: table.LC_data_table tr.LC_even_row > td {
6070: background-color: $data_table_dark;
1.425 albertel 6071: padding: 2px;
1.900 bisitz 6072: vertical-align: top;
1.347 albertel 6073: }
1.795 www 6074:
1.809 bisitz 6075: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 6076: background-color: $data_table_dark;
1.900 bisitz 6077: vertical-align: top;
1.347 albertel 6078: }
1.795 www 6079:
1.425 albertel 6080: table.LC_data_table tr.LC_data_table_highlight td {
6081: background-color: $data_table_darker;
6082: }
1.795 www 6083:
1.639 raeburn 6084: table.LC_data_table tr td.LC_leftcol_header {
6085: background-color: $data_table_head;
6086: font-weight: bold;
6087: }
1.795 www 6088:
1.451 albertel 6089: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 6090: table.LC_nested tr.LC_empty_row td {
1.421 albertel 6091: font-weight: bold;
6092: font-style: italic;
6093: text-align: center;
6094: padding: 8px;
1.347 albertel 6095: }
1.795 www 6096:
1.1114 raeburn 6097: table.LC_data_table tr.LC_empty_row td,
6098: table.LC_data_table tr.LC_footer_row td {
1.940 bisitz 6099: background-color: $sidebg;
6100: }
6101:
6102: table.LC_nested tr.LC_empty_row td {
6103: background-color: #FFFFFF;
6104: }
6105:
1.890 droeschl 6106: table.LC_caption {
6107: }
6108:
1.507 raeburn 6109: table.LC_nested tr.LC_empty_row td {
1.465 albertel 6110: padding: 4ex
6111: }
1.795 www 6112:
1.507 raeburn 6113: table.LC_nested_outer tr th {
6114: font-weight: bold;
1.801 tempelho 6115: color:$fontmenu;
1.507 raeburn 6116: background-color: $data_table_head;
1.701 harmsja 6117: font-size: small;
1.507 raeburn 6118: border-bottom: 1px solid #000000;
6119: }
1.795 www 6120:
1.507 raeburn 6121: table.LC_nested_outer tr td.LC_subheader {
6122: background-color: $data_table_head;
6123: font-weight: bold;
6124: font-size: small;
6125: border-bottom: 1px solid #000000;
6126: text-align: right;
1.451 albertel 6127: }
1.795 www 6128:
1.507 raeburn 6129: table.LC_nested tr.LC_info_row td {
1.735 bisitz 6130: background-color: #CCCCCC;
1.451 albertel 6131: font-weight: bold;
6132: font-size: small;
1.507 raeburn 6133: text-align: center;
6134: }
1.795 www 6135:
1.589 raeburn 6136: table.LC_nested tr.LC_info_row td.LC_left_item,
6137: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 6138: text-align: left;
1.451 albertel 6139: }
1.795 www 6140:
1.507 raeburn 6141: table.LC_nested td {
1.735 bisitz 6142: background-color: #FFFFFF;
1.451 albertel 6143: font-size: small;
1.507 raeburn 6144: }
1.795 www 6145:
1.507 raeburn 6146: table.LC_nested_outer tr th.LC_right_item,
6147: table.LC_nested tr.LC_info_row td.LC_right_item,
6148: table.LC_nested tr.LC_odd_row td.LC_right_item,
6149: table.LC_nested tr td.LC_right_item {
1.451 albertel 6150: text-align: right;
6151: }
6152:
1.507 raeburn 6153: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 6154: background-color: #EEEEEE;
1.451 albertel 6155: }
6156:
1.473 raeburn 6157: table.LC_createuser {
6158: }
6159:
6160: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 6161: font-size: small;
1.473 raeburn 6162: }
6163:
6164: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 6165: background-color: #CCCCCC;
1.473 raeburn 6166: font-weight: bold;
6167: text-align: center;
6168: }
6169:
1.349 albertel 6170: table.LC_calendar {
6171: border: 1px solid #000000;
6172: border-collapse: collapse;
1.917 raeburn 6173: width: 98%;
1.349 albertel 6174: }
1.795 www 6175:
1.349 albertel 6176: table.LC_calendar_pickdate {
6177: font-size: xx-small;
6178: }
1.795 www 6179:
1.349 albertel 6180: table.LC_calendar tr td {
6181: border: 1px solid #000000;
6182: vertical-align: top;
1.917 raeburn 6183: width: 14%;
1.349 albertel 6184: }
1.795 www 6185:
1.349 albertel 6186: table.LC_calendar tr td.LC_calendar_day_empty {
6187: background-color: $data_table_dark;
6188: }
1.795 www 6189:
1.779 bisitz 6190: table.LC_calendar tr td.LC_calendar_day_current {
6191: background-color: $data_table_highlight;
1.777 tempelho 6192: }
1.795 www 6193:
1.938 bisitz 6194: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 6195: background-color: $mail_new;
6196: }
1.795 www 6197:
1.938 bisitz 6198: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 6199: background-color: $mail_new_hover;
6200: }
1.795 www 6201:
1.938 bisitz 6202: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 6203: background-color: $mail_read;
6204: }
1.795 www 6205:
1.938 bisitz 6206: /*
6207: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 6208: background-color: $mail_read_hover;
6209: }
1.938 bisitz 6210: */
1.795 www 6211:
1.938 bisitz 6212: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 6213: background-color: $mail_replied;
6214: }
1.795 www 6215:
1.938 bisitz 6216: /*
6217: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 6218: background-color: $mail_replied_hover;
6219: }
1.938 bisitz 6220: */
1.795 www 6221:
1.938 bisitz 6222: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 6223: background-color: $mail_other;
6224: }
1.795 www 6225:
1.938 bisitz 6226: /*
6227: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 6228: background-color: $mail_other_hover;
6229: }
1.938 bisitz 6230: */
1.494 raeburn 6231:
1.777 tempelho 6232: table.LC_data_table tr > td.LC_browser_file,
6233: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 6234: background: #AAEE77;
1.389 albertel 6235: }
1.795 www 6236:
1.777 tempelho 6237: table.LC_data_table tr > td.LC_browser_file_locked,
6238: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 6239: background: #FFAA99;
1.387 albertel 6240: }
1.795 www 6241:
1.777 tempelho 6242: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 6243: background: #888888;
1.779 bisitz 6244: }
1.795 www 6245:
1.777 tempelho 6246: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 6247: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 6248: background: #F8F866;
1.777 tempelho 6249: }
1.795 www 6250:
1.696 bisitz 6251: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 6252: background: #E0E8FF;
1.387 albertel 6253: }
1.696 bisitz 6254:
1.707 bisitz 6255: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 6256: /* background: #77FF77; */
1.707 bisitz 6257: }
1.795 www 6258:
1.707 bisitz 6259: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 6260: border-right: 8px solid #FFFF77;
1.707 bisitz 6261: }
1.795 www 6262:
1.707 bisitz 6263: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 6264: border-right: 8px solid #FFAA77;
1.707 bisitz 6265: }
1.795 www 6266:
1.707 bisitz 6267: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 6268: border-right: 8px solid #FF7777;
1.707 bisitz 6269: }
1.795 www 6270:
1.707 bisitz 6271: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 6272: border-right: 8px solid #AAFF77;
1.707 bisitz 6273: }
1.795 www 6274:
1.707 bisitz 6275: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 6276: border-right: 8px solid #11CC55;
1.707 bisitz 6277: }
6278:
1.388 albertel 6279: span.LC_current_location {
1.701 harmsja 6280: font-size:larger;
1.388 albertel 6281: background: $pgbg;
6282: }
1.387 albertel 6283:
1.1029 www 6284: span.LC_current_nav_location {
6285: font-weight:bold;
6286: background: $sidebg;
6287: }
6288:
1.395 albertel 6289: span.LC_parm_menu_item {
6290: font-size: larger;
6291: }
1.795 www 6292:
1.395 albertel 6293: span.LC_parm_scope_all {
6294: color: red;
6295: }
1.795 www 6296:
1.395 albertel 6297: span.LC_parm_scope_folder {
6298: color: green;
6299: }
1.795 www 6300:
1.395 albertel 6301: span.LC_parm_scope_resource {
6302: color: orange;
6303: }
1.795 www 6304:
1.395 albertel 6305: span.LC_parm_part {
6306: color: blue;
6307: }
1.795 www 6308:
1.911 bisitz 6309: span.LC_parm_folder,
6310: span.LC_parm_symb {
1.395 albertel 6311: font-size: x-small;
6312: font-family: $mono;
6313: color: #AAAAAA;
6314: }
6315:
1.977 bisitz 6316: ul.LC_parm_parmlist li {
6317: display: inline-block;
6318: padding: 0.3em 0.8em;
6319: vertical-align: top;
6320: width: 150px;
6321: border-top:1px solid $lg_border_color;
6322: }
6323:
1.795 www 6324: td.LC_parm_overview_level_menu,
6325: td.LC_parm_overview_map_menu,
6326: td.LC_parm_overview_parm_selectors,
6327: td.LC_parm_overview_restrictions {
1.396 albertel 6328: border: 1px solid black;
6329: border-collapse: collapse;
6330: }
1.795 www 6331:
1.396 albertel 6332: table.LC_parm_overview_restrictions td {
6333: border-width: 1px 4px 1px 4px;
6334: border-style: solid;
6335: border-color: $pgbg;
6336: text-align: center;
6337: }
1.795 www 6338:
1.396 albertel 6339: table.LC_parm_overview_restrictions th {
6340: background: $tabbg;
6341: border-width: 1px 4px 1px 4px;
6342: border-style: solid;
6343: border-color: $pgbg;
6344: }
1.795 www 6345:
1.398 albertel 6346: table#LC_helpmenu {
1.803 bisitz 6347: border: none;
1.398 albertel 6348: height: 55px;
1.803 bisitz 6349: border-spacing: 0;
1.398 albertel 6350: }
6351:
6352: table#LC_helpmenu fieldset legend {
6353: font-size: larger;
6354: }
1.795 www 6355:
1.397 albertel 6356: table#LC_helpmenu_links {
6357: width: 100%;
6358: border: 1px solid black;
6359: background: $pgbg;
1.803 bisitz 6360: padding: 0;
1.397 albertel 6361: border-spacing: 1px;
6362: }
1.795 www 6363:
1.397 albertel 6364: table#LC_helpmenu_links tr td {
6365: padding: 1px;
6366: background: $tabbg;
1.399 albertel 6367: text-align: center;
6368: font-weight: bold;
1.397 albertel 6369: }
1.396 albertel 6370:
1.795 www 6371: table#LC_helpmenu_links a:link,
6372: table#LC_helpmenu_links a:visited,
1.397 albertel 6373: table#LC_helpmenu_links a:active {
6374: text-decoration: none;
6375: color: $font;
6376: }
1.795 www 6377:
1.397 albertel 6378: table#LC_helpmenu_links a:hover {
6379: text-decoration: underline;
6380: color: $vlink;
6381: }
1.396 albertel 6382:
1.417 albertel 6383: .LC_chrt_popup_exists {
6384: border: 1px solid #339933;
6385: margin: -1px;
6386: }
1.795 www 6387:
1.417 albertel 6388: .LC_chrt_popup_up {
6389: border: 1px solid yellow;
6390: margin: -1px;
6391: }
1.795 www 6392:
1.417 albertel 6393: .LC_chrt_popup {
6394: border: 1px solid #8888FF;
6395: background: #CCCCFF;
6396: }
1.795 www 6397:
1.421 albertel 6398: table.LC_pick_box {
6399: border-collapse: separate;
6400: background: white;
6401: border: 1px solid black;
6402: border-spacing: 1px;
6403: }
1.795 www 6404:
1.421 albertel 6405: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 6406: background: $sidebg;
1.421 albertel 6407: font-weight: bold;
1.900 bisitz 6408: text-align: left;
1.740 bisitz 6409: vertical-align: top;
1.421 albertel 6410: width: 184px;
6411: padding: 8px;
6412: }
1.795 www 6413:
1.579 raeburn 6414: table.LC_pick_box td.LC_pick_box_value {
6415: text-align: left;
6416: padding: 8px;
6417: }
1.795 www 6418:
1.579 raeburn 6419: table.LC_pick_box td.LC_pick_box_select {
6420: text-align: left;
6421: padding: 8px;
6422: }
1.795 www 6423:
1.424 albertel 6424: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 6425: padding: 0;
1.421 albertel 6426: height: 1px;
6427: background: black;
6428: }
1.795 www 6429:
1.421 albertel 6430: table.LC_pick_box td.LC_pick_box_submit {
6431: text-align: right;
6432: }
1.795 www 6433:
1.579 raeburn 6434: table.LC_pick_box td.LC_evenrow_value {
6435: text-align: left;
6436: padding: 8px;
6437: background-color: $data_table_light;
6438: }
1.795 www 6439:
1.579 raeburn 6440: table.LC_pick_box td.LC_oddrow_value {
6441: text-align: left;
6442: padding: 8px;
6443: background-color: $data_table_light;
6444: }
1.795 www 6445:
1.579 raeburn 6446: span.LC_helpform_receipt_cat {
6447: font-weight: bold;
6448: }
1.795 www 6449:
1.424 albertel 6450: table.LC_group_priv_box {
6451: background: white;
6452: border: 1px solid black;
6453: border-spacing: 1px;
6454: }
1.795 www 6455:
1.424 albertel 6456: table.LC_group_priv_box td.LC_pick_box_title {
6457: background: $tabbg;
6458: font-weight: bold;
6459: text-align: right;
6460: width: 184px;
6461: }
1.795 www 6462:
1.424 albertel 6463: table.LC_group_priv_box td.LC_groups_fixed {
6464: background: $data_table_light;
6465: text-align: center;
6466: }
1.795 www 6467:
1.424 albertel 6468: table.LC_group_priv_box td.LC_groups_optional {
6469: background: $data_table_dark;
6470: text-align: center;
6471: }
1.795 www 6472:
1.424 albertel 6473: table.LC_group_priv_box td.LC_groups_functionality {
6474: background: $data_table_darker;
6475: text-align: center;
6476: font-weight: bold;
6477: }
1.795 www 6478:
1.424 albertel 6479: table.LC_group_priv td {
6480: text-align: left;
1.803 bisitz 6481: padding: 0;
1.424 albertel 6482: }
6483:
6484: .LC_navbuttons {
6485: margin: 2ex 0ex 2ex 0ex;
6486: }
1.795 www 6487:
1.423 albertel 6488: .LC_topic_bar {
6489: font-weight: bold;
6490: background: $tabbg;
1.918 wenzelju 6491: margin: 1em 0em 1em 2em;
1.805 bisitz 6492: padding: 3px;
1.918 wenzelju 6493: font-size: 1.2em;
1.423 albertel 6494: }
1.795 www 6495:
1.423 albertel 6496: .LC_topic_bar span {
1.918 wenzelju 6497: left: 0.5em;
6498: position: absolute;
1.423 albertel 6499: vertical-align: middle;
1.918 wenzelju 6500: font-size: 1.2em;
1.423 albertel 6501: }
1.795 www 6502:
1.423 albertel 6503: table.LC_course_group_status {
6504: margin: 20px;
6505: }
1.795 www 6506:
1.423 albertel 6507: table.LC_status_selector td {
6508: vertical-align: top;
6509: text-align: center;
1.424 albertel 6510: padding: 4px;
6511: }
1.795 www 6512:
1.599 albertel 6513: div.LC_feedback_link {
1.616 albertel 6514: clear: both;
1.829 kalberla 6515: background: $sidebg;
1.779 bisitz 6516: width: 100%;
1.829 kalberla 6517: padding-bottom: 10px;
6518: border: 1px $tabbg solid;
1.833 kalberla 6519: height: 22px;
6520: line-height: 22px;
6521: padding-top: 5px;
6522: }
6523:
6524: div.LC_feedback_link img {
6525: height: 22px;
1.867 kalberla 6526: vertical-align:middle;
1.829 kalberla 6527: }
6528:
1.911 bisitz 6529: div.LC_feedback_link a {
1.829 kalberla 6530: text-decoration: none;
1.489 raeburn 6531: }
1.795 www 6532:
1.867 kalberla 6533: div.LC_comblock {
1.911 bisitz 6534: display:inline;
1.867 kalberla 6535: color:$font;
6536: font-size:90%;
6537: }
6538:
6539: div.LC_feedback_link div.LC_comblock {
6540: padding-left:5px;
6541: }
6542:
6543: div.LC_feedback_link div.LC_comblock a {
6544: color:$font;
6545: }
6546:
1.489 raeburn 6547: span.LC_feedback_link {
1.858 bisitz 6548: /* background: $feedback_link_bg; */
1.599 albertel 6549: font-size: larger;
6550: }
1.795 www 6551:
1.599 albertel 6552: span.LC_message_link {
1.858 bisitz 6553: /* background: $feedback_link_bg; */
1.599 albertel 6554: font-size: larger;
6555: position: absolute;
6556: right: 1em;
1.489 raeburn 6557: }
1.421 albertel 6558:
1.515 albertel 6559: table.LC_prior_tries {
1.524 albertel 6560: border: 1px solid #000000;
6561: border-collapse: separate;
6562: border-spacing: 1px;
1.515 albertel 6563: }
1.523 albertel 6564:
1.515 albertel 6565: table.LC_prior_tries td {
1.524 albertel 6566: padding: 2px;
1.515 albertel 6567: }
1.523 albertel 6568:
6569: .LC_answer_correct {
1.795 www 6570: background: lightgreen;
6571: color: darkgreen;
6572: padding: 6px;
1.523 albertel 6573: }
1.795 www 6574:
1.523 albertel 6575: .LC_answer_charged_try {
1.797 www 6576: background: #FFAAAA;
1.795 www 6577: color: darkred;
6578: padding: 6px;
1.523 albertel 6579: }
1.795 www 6580:
1.779 bisitz 6581: .LC_answer_not_charged_try,
1.523 albertel 6582: .LC_answer_no_grade,
6583: .LC_answer_late {
1.795 www 6584: background: lightyellow;
1.523 albertel 6585: color: black;
1.795 www 6586: padding: 6px;
1.523 albertel 6587: }
1.795 www 6588:
1.523 albertel 6589: .LC_answer_previous {
1.795 www 6590: background: lightblue;
6591: color: darkblue;
6592: padding: 6px;
1.523 albertel 6593: }
1.795 www 6594:
1.779 bisitz 6595: .LC_answer_no_message {
1.777 tempelho 6596: background: #FFFFFF;
6597: color: black;
1.795 www 6598: padding: 6px;
1.779 bisitz 6599: }
1.795 www 6600:
1.779 bisitz 6601: .LC_answer_unknown {
6602: background: orange;
6603: color: black;
1.795 www 6604: padding: 6px;
1.777 tempelho 6605: }
1.795 www 6606:
1.529 albertel 6607: span.LC_prior_numerical,
6608: span.LC_prior_string,
6609: span.LC_prior_custom,
6610: span.LC_prior_reaction,
6611: span.LC_prior_math {
1.925 bisitz 6612: font-family: $mono;
1.523 albertel 6613: white-space: pre;
6614: }
6615:
1.525 albertel 6616: span.LC_prior_string {
1.925 bisitz 6617: font-family: $mono;
1.525 albertel 6618: white-space: pre;
6619: }
6620:
1.523 albertel 6621: table.LC_prior_option {
6622: width: 100%;
6623: border-collapse: collapse;
6624: }
1.795 www 6625:
1.911 bisitz 6626: table.LC_prior_rank,
1.795 www 6627: table.LC_prior_match {
1.528 albertel 6628: border-collapse: collapse;
6629: }
1.795 www 6630:
1.528 albertel 6631: table.LC_prior_option tr td,
6632: table.LC_prior_rank tr td,
6633: table.LC_prior_match tr td {
1.524 albertel 6634: border: 1px solid #000000;
1.515 albertel 6635: }
6636:
1.855 bisitz 6637: .LC_nobreak {
1.544 albertel 6638: white-space: nowrap;
1.519 raeburn 6639: }
6640:
1.576 raeburn 6641: span.LC_cusr_emph {
6642: font-style: italic;
6643: }
6644:
1.633 raeburn 6645: span.LC_cusr_subheading {
6646: font-weight: normal;
6647: font-size: 85%;
6648: }
6649:
1.1206 raeburn 6650: span.LC_math-error {
6651: border: solid 1px red; min-width: 1px;
6652: }
6653:
1.861 bisitz 6654: div.LC_docs_entry_move {
1.859 bisitz 6655: border: 1px solid #BBBBBB;
1.545 albertel 6656: background: #DDDDDD;
1.861 bisitz 6657: width: 22px;
1.859 bisitz 6658: padding: 1px;
6659: margin: 0;
1.545 albertel 6660: }
6661:
1.861 bisitz 6662: table.LC_data_table tr > td.LC_docs_entry_commands,
6663: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 6664: font-size: x-small;
6665: }
1.795 www 6666:
1.861 bisitz 6667: .LC_docs_entry_parameter {
6668: white-space: nowrap;
6669: }
6670:
1.544 albertel 6671: .LC_docs_copy {
1.545 albertel 6672: color: #000099;
1.544 albertel 6673: }
1.795 www 6674:
1.544 albertel 6675: .LC_docs_cut {
1.545 albertel 6676: color: #550044;
1.544 albertel 6677: }
1.795 www 6678:
1.544 albertel 6679: .LC_docs_rename {
1.545 albertel 6680: color: #009900;
1.544 albertel 6681: }
1.795 www 6682:
1.544 albertel 6683: .LC_docs_remove {
1.545 albertel 6684: color: #990000;
6685: }
6686:
1.547 albertel 6687: .LC_docs_reinit_warn,
6688: .LC_docs_ext_edit {
6689: font-size: x-small;
6690: }
6691:
1.545 albertel 6692: table.LC_docs_adddocs td,
6693: table.LC_docs_adddocs th {
6694: border: 1px solid #BBBBBB;
6695: padding: 4px;
6696: background: #DDDDDD;
1.543 albertel 6697: }
6698:
1.584 albertel 6699: table.LC_sty_begin {
6700: background: #BBFFBB;
6701: }
1.795 www 6702:
1.584 albertel 6703: table.LC_sty_end {
6704: background: #FFBBBB;
6705: }
6706:
1.589 raeburn 6707: table.LC_double_column {
1.803 bisitz 6708: border-width: 0;
1.589 raeburn 6709: border-collapse: collapse;
6710: width: 100%;
6711: padding: 2px;
6712: }
6713:
6714: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 6715: top: 2px;
1.589 raeburn 6716: left: 2px;
6717: width: 47%;
6718: vertical-align: top;
6719: }
6720:
6721: table.LC_double_column tr td.LC_right_col {
6722: top: 2px;
1.779 bisitz 6723: right: 2px;
1.589 raeburn 6724: width: 47%;
6725: vertical-align: top;
6726: }
6727:
1.591 raeburn 6728: div.LC_left_float {
6729: float: left;
6730: padding-right: 5%;
1.597 albertel 6731: padding-bottom: 4px;
1.591 raeburn 6732: }
6733:
6734: div.LC_clear_float_header {
1.597 albertel 6735: padding-bottom: 2px;
1.591 raeburn 6736: }
6737:
6738: div.LC_clear_float_footer {
1.597 albertel 6739: padding-top: 10px;
1.591 raeburn 6740: clear: both;
6741: }
6742:
1.597 albertel 6743: div.LC_grade_show_user {
1.941 bisitz 6744: /* border-left: 5px solid $sidebg; */
6745: border-top: 5px solid #000000;
6746: margin: 50px 0 0 0;
1.936 bisitz 6747: padding: 15px 0 5px 10px;
1.597 albertel 6748: }
1.795 www 6749:
1.936 bisitz 6750: div.LC_grade_show_user_odd_row {
1.941 bisitz 6751: /* border-left: 5px solid #000000; */
6752: }
6753:
6754: div.LC_grade_show_user div.LC_Box {
6755: margin-right: 50px;
1.597 albertel 6756: }
6757:
6758: div.LC_grade_submissions,
6759: div.LC_grade_message_center,
1.936 bisitz 6760: div.LC_grade_info_links {
1.597 albertel 6761: margin: 5px;
6762: width: 99%;
6763: background: #FFFFFF;
6764: }
1.795 www 6765:
1.597 albertel 6766: div.LC_grade_submissions_header,
1.936 bisitz 6767: div.LC_grade_message_center_header {
1.705 tempelho 6768: font-weight: bold;
6769: font-size: large;
1.597 albertel 6770: }
1.795 www 6771:
1.597 albertel 6772: div.LC_grade_submissions_body,
1.936 bisitz 6773: div.LC_grade_message_center_body {
1.597 albertel 6774: border: 1px solid black;
6775: width: 99%;
6776: background: #FFFFFF;
6777: }
1.795 www 6778:
1.613 albertel 6779: table.LC_scantron_action {
6780: width: 100%;
6781: }
1.795 www 6782:
1.613 albertel 6783: table.LC_scantron_action tr th {
1.698 harmsja 6784: font-weight:bold;
6785: font-style:normal;
1.613 albertel 6786: }
1.795 www 6787:
1.779 bisitz 6788: .LC_edit_problem_header,
1.614 albertel 6789: div.LC_edit_problem_footer {
1.705 tempelho 6790: font-weight: normal;
6791: font-size: medium;
1.602 albertel 6792: margin: 2px;
1.1060 bisitz 6793: background-color: $sidebg;
1.600 albertel 6794: }
1.795 www 6795:
1.600 albertel 6796: div.LC_edit_problem_header,
1.602 albertel 6797: div.LC_edit_problem_header div,
1.614 albertel 6798: div.LC_edit_problem_footer,
6799: div.LC_edit_problem_footer div,
1.602 albertel 6800: div.LC_edit_problem_editxml_header,
6801: div.LC_edit_problem_editxml_header div {
1.600 albertel 6802: margin-top: 5px;
1.1205 golterma 6803: z-index: 100;
1.600 albertel 6804: }
1.795 www 6805:
1.600 albertel 6806: div.LC_edit_problem_header_title {
1.705 tempelho 6807: font-weight: bold;
6808: font-size: larger;
1.602 albertel 6809: background: $tabbg;
6810: padding: 3px;
1.1060 bisitz 6811: margin: 0 0 5px 0;
1.602 albertel 6812: }
1.795 www 6813:
1.602 albertel 6814: table.LC_edit_problem_header_title {
6815: width: 100%;
1.600 albertel 6816: background: $tabbg;
1.602 albertel 6817: }
6818:
6819: div.LC_edit_problem_discards {
6820: float: left;
1.1205 golterma 6821: }
6822:
6823: div.LC_edit_actionbar {
6824: margin: -5px 0px 0px 0px !important;
6825: background-color: $sidebg;
6826: height: 31px;
1.602 albertel 6827: }
1.795 www 6828:
1.602 albertel 6829: div.LC_edit_problem_saves {
6830: float: right;
6831: padding-bottom: 5px;
1.600 albertel 6832: }
1.795 www 6833:
1.1124 bisitz 6834: .LC_edit_opt {
6835: padding-left: 1em;
6836: white-space: nowrap;
6837: }
6838:
1.1152 golterma 6839: .LC_edit_problem_latexhelper{
6840: text-align: right;
6841: }
6842:
6843: #LC_edit_problem_colorful div{
6844: margin-left: 40px;
6845: }
6846:
1.1205 golterma 6847: #LC_edit_problem_codemirror div{
6848: margin-left: 0px;
6849: }
6850:
1.911 bisitz 6851: img.stift {
1.803 bisitz 6852: border-width: 0;
6853: vertical-align: middle;
1.677 riegler 6854: }
1.680 riegler 6855:
1.923 bisitz 6856: table td.LC_mainmenu_col_fieldset {
1.680 riegler 6857: vertical-align: top;
1.777 tempelho 6858: }
1.795 www 6859:
1.716 raeburn 6860: div.LC_createcourse {
1.911 bisitz 6861: margin: 10px 10px 10px 10px;
1.716 raeburn 6862: }
6863:
1.917 raeburn 6864: .LC_dccid {
1.1130 raeburn 6865: float: right;
1.917 raeburn 6866: margin: 0.2em 0 0 0;
6867: padding: 0;
6868: font-size: 90%;
6869: display:none;
6870: }
6871:
1.897 wenzelju 6872: ol.LC_primary_menu a:hover,
1.721 harmsja 6873: ol#LC_MenuBreadcrumbs a:hover,
6874: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 6875: ul#LC_secondary_menu a:hover,
1.721 harmsja 6876: .LC_FormSectionClearButton input:hover
1.795 www 6877: ul.LC_TabContent li:hover a {
1.952 onken 6878: color:$button_hover;
1.911 bisitz 6879: text-decoration:none;
1.693 droeschl 6880: }
6881:
1.779 bisitz 6882: h1 {
1.911 bisitz 6883: padding: 0;
6884: line-height:130%;
1.693 droeschl 6885: }
1.698 harmsja 6886:
1.911 bisitz 6887: h2,
6888: h3,
6889: h4,
6890: h5,
6891: h6 {
6892: margin: 5px 0 5px 0;
6893: padding: 0;
6894: line-height:130%;
1.693 droeschl 6895: }
1.795 www 6896:
6897: .LC_hcell {
1.911 bisitz 6898: padding:3px 15px 3px 15px;
6899: margin: 0;
6900: background-color:$tabbg;
6901: color:$fontmenu;
6902: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 6903: }
1.795 www 6904:
1.840 bisitz 6905: .LC_Box > .LC_hcell {
1.911 bisitz 6906: margin: 0 -10px 10px -10px;
1.835 bisitz 6907: }
6908:
1.721 harmsja 6909: .LC_noBorder {
1.911 bisitz 6910: border: 0;
1.698 harmsja 6911: }
1.693 droeschl 6912:
1.721 harmsja 6913: .LC_FormSectionClearButton input {
1.911 bisitz 6914: background-color:transparent;
6915: border: none;
6916: cursor:pointer;
6917: text-decoration:underline;
1.693 droeschl 6918: }
1.763 bisitz 6919:
6920: .LC_help_open_topic {
1.911 bisitz 6921: color: #FFFFFF;
6922: background-color: #EEEEFF;
6923: margin: 1px;
6924: padding: 4px;
6925: border: 1px solid #000033;
6926: white-space: nowrap;
6927: /* vertical-align: middle; */
1.759 neumanie 6928: }
1.693 droeschl 6929:
1.911 bisitz 6930: dl,
6931: ul,
6932: div,
6933: fieldset {
6934: margin: 10px 10px 10px 0;
6935: /* overflow: hidden; */
1.693 droeschl 6936: }
1.795 www 6937:
1.838 bisitz 6938: fieldset > legend {
1.911 bisitz 6939: font-weight: bold;
6940: padding: 0 5px 0 5px;
1.838 bisitz 6941: }
6942:
1.813 bisitz 6943: #LC_nav_bar {
1.911 bisitz 6944: float: left;
1.995 raeburn 6945: background-color: $pgbg_or_bgcolor;
1.966 bisitz 6946: margin: 0 0 2px 0;
1.807 droeschl 6947: }
6948:
1.916 droeschl 6949: #LC_realm {
6950: margin: 0.2em 0 0 0;
6951: padding: 0;
6952: font-weight: bold;
6953: text-align: center;
1.995 raeburn 6954: background-color: $pgbg_or_bgcolor;
1.916 droeschl 6955: }
6956:
1.911 bisitz 6957: #LC_nav_bar em {
6958: font-weight: bold;
6959: font-style: normal;
1.807 droeschl 6960: }
6961:
1.897 wenzelju 6962: ol.LC_primary_menu {
1.934 droeschl 6963: margin: 0;
1.1076 raeburn 6964: padding: 0;
1.807 droeschl 6965: }
6966:
1.852 droeschl 6967: ol#LC_PathBreadcrumbs {
1.911 bisitz 6968: margin: 0;
1.693 droeschl 6969: }
6970:
1.897 wenzelju 6971: ol.LC_primary_menu li {
1.1076 raeburn 6972: color: RGB(80, 80, 80);
6973: vertical-align: middle;
6974: text-align: left;
6975: list-style: none;
1.1205 golterma 6976: position: relative;
1.1076 raeburn 6977: float: left;
1.1205 golterma 6978: z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
6979: line-height: 1.5em;
1.1076 raeburn 6980: }
6981:
1.1205 golterma 6982: ol.LC_primary_menu li a,
6983: ol.LC_primary_menu li p {
1.1076 raeburn 6984: display: block;
6985: margin: 0;
6986: padding: 0 5px 0 10px;
6987: text-decoration: none;
6988: }
6989:
1.1205 golterma 6990: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
6991: display: inline-block;
6992: width: 95%;
6993: text-align: left;
6994: }
6995:
6996: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
6997: display: inline-block;
6998: width: 5%;
6999: float: right;
7000: text-align: right;
7001: font-size: 70%;
7002: }
7003:
7004: ol.LC_primary_menu ul {
1.1076 raeburn 7005: display: none;
1.1205 golterma 7006: width: 15em;
1.1076 raeburn 7007: background-color: $data_table_light;
1.1205 golterma 7008: position: absolute;
7009: top: 100%;
1.1076 raeburn 7010: }
7011:
1.1205 golterma 7012: ol.LC_primary_menu ul ul {
7013: left: 100%;
7014: top: 0;
7015: }
7016:
7017: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1076 raeburn 7018: display: block;
7019: position: absolute;
7020: margin: 0;
7021: padding: 0;
1.1078 raeburn 7022: z-index: 2;
1.1076 raeburn 7023: }
7024:
7025: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1205 golterma 7026: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1076 raeburn 7027: font-size: 90%;
1.911 bisitz 7028: vertical-align: top;
1.1076 raeburn 7029: float: none;
1.1079 raeburn 7030: border-left: 1px solid black;
7031: border-right: 1px solid black;
1.1205 golterma 7032: /* A dark bottom border to visualize different menu options;
7033: overwritten in the create_submenu routine for the last border-bottom of the menu */
7034: border-bottom: 1px solid $data_table_dark;
1.1076 raeburn 7035: }
7036:
1.1205 golterma 7037: ol.LC_primary_menu li li p:hover {
7038: color:$button_hover;
7039: text-decoration:none;
7040: background-color:$data_table_dark;
1.1076 raeburn 7041: }
7042:
7043: ol.LC_primary_menu li li a:hover {
7044: color:$button_hover;
7045: background-color:$data_table_dark;
1.693 droeschl 7046: }
7047:
1.1205 golterma 7048: /* Font-size equal to the size of the predecessors*/
7049: ol.LC_primary_menu li:hover li li {
7050: font-size: 100%;
7051: }
7052:
1.897 wenzelju 7053: ol.LC_primary_menu li img {
1.911 bisitz 7054: vertical-align: bottom;
1.934 droeschl 7055: height: 1.1em;
1.1077 raeburn 7056: margin: 0.2em 0 0 0;
1.693 droeschl 7057: }
7058:
1.897 wenzelju 7059: ol.LC_primary_menu a {
1.911 bisitz 7060: color: RGB(80, 80, 80);
7061: text-decoration: none;
1.693 droeschl 7062: }
1.795 www 7063:
1.949 droeschl 7064: ol.LC_primary_menu a.LC_new_message {
7065: font-weight:bold;
7066: color: darkred;
7067: }
7068:
1.975 raeburn 7069: ol.LC_docs_parameters {
7070: margin-left: 0;
7071: padding: 0;
7072: list-style: none;
7073: }
7074:
7075: ol.LC_docs_parameters li {
7076: margin: 0;
7077: padding-right: 20px;
7078: display: inline;
7079: }
7080:
1.976 raeburn 7081: ol.LC_docs_parameters li:before {
7082: content: "\\002022 \\0020";
7083: }
7084:
7085: li.LC_docs_parameters_title {
7086: font-weight: bold;
7087: }
7088:
7089: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
7090: content: "";
7091: }
7092:
1.897 wenzelju 7093: ul#LC_secondary_menu {
1.1107 raeburn 7094: clear: right;
1.911 bisitz 7095: color: $fontmenu;
7096: background: $tabbg;
7097: list-style: none;
7098: padding: 0;
7099: margin: 0;
7100: width: 100%;
1.995 raeburn 7101: text-align: left;
1.1107 raeburn 7102: float: left;
1.808 droeschl 7103: }
7104:
1.897 wenzelju 7105: ul#LC_secondary_menu li {
1.911 bisitz 7106: font-weight: bold;
7107: line-height: 1.8em;
1.1107 raeburn 7108: border-right: 1px solid black;
7109: float: left;
7110: }
7111:
7112: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
7113: background-color: $data_table_light;
7114: }
7115:
7116: ul#LC_secondary_menu li a {
1.911 bisitz 7117: padding: 0 0.8em;
1.1107 raeburn 7118: }
7119:
7120: ul#LC_secondary_menu li ul {
7121: display: none;
7122: }
7123:
7124: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
7125: display: block;
7126: position: absolute;
7127: margin: 0;
7128: padding: 0;
7129: list-style:none;
7130: float: none;
7131: background-color: $data_table_light;
7132: z-index: 2;
7133: margin-left: -1px;
7134: }
7135:
7136: ul#LC_secondary_menu li ul li {
7137: font-size: 90%;
7138: vertical-align: top;
7139: border-left: 1px solid black;
1.911 bisitz 7140: border-right: 1px solid black;
1.1119 raeburn 7141: background-color: $data_table_light;
1.1107 raeburn 7142: list-style:none;
7143: float: none;
7144: }
7145:
7146: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
7147: background-color: $data_table_dark;
1.807 droeschl 7148: }
7149:
1.847 tempelho 7150: ul.LC_TabContent {
1.911 bisitz 7151: display:block;
7152: background: $sidebg;
7153: border-bottom: solid 1px $lg_border_color;
7154: list-style:none;
1.1020 raeburn 7155: margin: -1px -10px 0 -10px;
1.911 bisitz 7156: padding: 0;
1.693 droeschl 7157: }
7158:
1.795 www 7159: ul.LC_TabContent li,
7160: ul.LC_TabContentBigger li {
1.911 bisitz 7161: float:left;
1.741 harmsja 7162: }
1.795 www 7163:
1.897 wenzelju 7164: ul#LC_secondary_menu li a {
1.911 bisitz 7165: color: $fontmenu;
7166: text-decoration: none;
1.693 droeschl 7167: }
1.795 www 7168:
1.721 harmsja 7169: ul.LC_TabContent {
1.952 onken 7170: min-height:20px;
1.721 harmsja 7171: }
1.795 www 7172:
7173: ul.LC_TabContent li {
1.911 bisitz 7174: vertical-align:middle;
1.959 onken 7175: padding: 0 16px 0 10px;
1.911 bisitz 7176: background-color:$tabbg;
7177: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 7178: border-left: solid 1px $font;
1.721 harmsja 7179: }
1.795 www 7180:
1.847 tempelho 7181: ul.LC_TabContent .right {
1.911 bisitz 7182: float:right;
1.847 tempelho 7183: }
7184:
1.911 bisitz 7185: ul.LC_TabContent li a,
7186: ul.LC_TabContent li {
7187: color:rgb(47,47,47);
7188: text-decoration:none;
7189: font-size:95%;
7190: font-weight:bold;
1.952 onken 7191: min-height:20px;
7192: }
7193:
1.959 onken 7194: ul.LC_TabContent li a:hover,
7195: ul.LC_TabContent li a:focus {
1.952 onken 7196: color: $button_hover;
1.959 onken 7197: background:none;
7198: outline:none;
1.952 onken 7199: }
7200:
7201: ul.LC_TabContent li:hover {
7202: color: $button_hover;
7203: cursor:pointer;
1.721 harmsja 7204: }
1.795 www 7205:
1.911 bisitz 7206: ul.LC_TabContent li.active {
1.952 onken 7207: color: $font;
1.911 bisitz 7208: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 7209: border-bottom:solid 1px #FFFFFF;
7210: cursor: default;
1.744 ehlerst 7211: }
1.795 www 7212:
1.959 onken 7213: ul.LC_TabContent li.active a {
7214: color:$font;
7215: background:#FFFFFF;
7216: outline: none;
7217: }
1.1047 raeburn 7218:
7219: ul.LC_TabContent li.goback {
7220: float: left;
7221: border-left: none;
7222: }
7223:
1.870 tempelho 7224: #maincoursedoc {
1.911 bisitz 7225: clear:both;
1.870 tempelho 7226: }
7227:
7228: ul.LC_TabContentBigger {
1.911 bisitz 7229: display:block;
7230: list-style:none;
7231: padding: 0;
1.870 tempelho 7232: }
7233:
1.795 www 7234: ul.LC_TabContentBigger li {
1.911 bisitz 7235: vertical-align:bottom;
7236: height: 30px;
7237: font-size:110%;
7238: font-weight:bold;
7239: color: #737373;
1.841 tempelho 7240: }
7241:
1.957 onken 7242: ul.LC_TabContentBigger li.active {
7243: position: relative;
7244: top: 1px;
7245: }
7246:
1.870 tempelho 7247: ul.LC_TabContentBigger li a {
1.911 bisitz 7248: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
7249: height: 30px;
7250: line-height: 30px;
7251: text-align: center;
7252: display: block;
7253: text-decoration: none;
1.958 onken 7254: outline: none;
1.741 harmsja 7255: }
1.795 www 7256:
1.870 tempelho 7257: ul.LC_TabContentBigger li.active a {
1.911 bisitz 7258: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
7259: color:$font;
1.744 ehlerst 7260: }
1.795 www 7261:
1.870 tempelho 7262: ul.LC_TabContentBigger li b {
1.911 bisitz 7263: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
7264: display: block;
7265: float: left;
7266: padding: 0 30px;
1.957 onken 7267: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 7268: }
7269:
1.956 onken 7270: ul.LC_TabContentBigger li:hover b {
7271: color:$button_hover;
7272: }
7273:
1.870 tempelho 7274: ul.LC_TabContentBigger li.active b {
1.911 bisitz 7275: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
7276: color:$font;
1.957 onken 7277: border: 0;
1.741 harmsja 7278: }
1.693 droeschl 7279:
1.870 tempelho 7280:
1.862 bisitz 7281: ul.LC_CourseBreadcrumbs {
7282: background: $sidebg;
1.1020 raeburn 7283: height: 2em;
1.862 bisitz 7284: padding-left: 10px;
1.1020 raeburn 7285: margin: 0;
1.862 bisitz 7286: list-style-position: inside;
7287: }
7288:
1.911 bisitz 7289: ol#LC_MenuBreadcrumbs,
1.862 bisitz 7290: ol#LC_PathBreadcrumbs {
1.911 bisitz 7291: padding-left: 10px;
7292: margin: 0;
1.933 droeschl 7293: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 7294: }
7295:
1.911 bisitz 7296: ol#LC_MenuBreadcrumbs li,
7297: ol#LC_PathBreadcrumbs li,
1.862 bisitz 7298: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 7299: display: inline;
1.933 droeschl 7300: white-space: normal;
1.693 droeschl 7301: }
7302:
1.823 bisitz 7303: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 7304: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 7305: text-decoration: none;
7306: font-size:90%;
1.693 droeschl 7307: }
1.795 www 7308:
1.969 droeschl 7309: ol#LC_MenuBreadcrumbs h1 {
7310: display: inline;
7311: font-size: 90%;
7312: line-height: 2.5em;
7313: margin: 0;
7314: padding: 0;
7315: }
7316:
1.795 www 7317: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 7318: text-decoration:none;
7319: font-size:100%;
7320: font-weight:bold;
1.693 droeschl 7321: }
1.795 www 7322:
1.840 bisitz 7323: .LC_Box {
1.911 bisitz 7324: border: solid 1px $lg_border_color;
7325: padding: 0 10px 10px 10px;
1.746 neumanie 7326: }
1.795 www 7327:
1.1020 raeburn 7328: .LC_DocsBox {
7329: border: solid 1px $lg_border_color;
7330: padding: 0 0 10px 10px;
7331: }
7332:
1.795 www 7333: .LC_AboutMe_Image {
1.911 bisitz 7334: float:left;
7335: margin-right:10px;
1.747 neumanie 7336: }
1.795 www 7337:
7338: .LC_Clear_AboutMe_Image {
1.911 bisitz 7339: clear:left;
1.747 neumanie 7340: }
1.795 www 7341:
1.721 harmsja 7342: dl.LC_ListStyleClean dt {
1.911 bisitz 7343: padding-right: 5px;
7344: display: table-header-group;
1.693 droeschl 7345: }
7346:
1.721 harmsja 7347: dl.LC_ListStyleClean dd {
1.911 bisitz 7348: display: table-row;
1.693 droeschl 7349: }
7350:
1.721 harmsja 7351: .LC_ListStyleClean,
7352: .LC_ListStyleSimple,
7353: .LC_ListStyleNormal,
1.795 www 7354: .LC_ListStyleSpecial {
1.911 bisitz 7355: /* display:block; */
7356: list-style-position: inside;
7357: list-style-type: none;
7358: overflow: hidden;
7359: padding: 0;
1.693 droeschl 7360: }
7361:
1.721 harmsja 7362: .LC_ListStyleSimple li,
7363: .LC_ListStyleSimple dd,
7364: .LC_ListStyleNormal li,
7365: .LC_ListStyleNormal dd,
7366: .LC_ListStyleSpecial li,
1.795 www 7367: .LC_ListStyleSpecial dd {
1.911 bisitz 7368: margin: 0;
7369: padding: 5px 5px 5px 10px;
7370: clear: both;
1.693 droeschl 7371: }
7372:
1.721 harmsja 7373: .LC_ListStyleClean li,
7374: .LC_ListStyleClean dd {
1.911 bisitz 7375: padding-top: 0;
7376: padding-bottom: 0;
1.693 droeschl 7377: }
7378:
1.721 harmsja 7379: .LC_ListStyleSimple dd,
1.795 www 7380: .LC_ListStyleSimple li {
1.911 bisitz 7381: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 7382: }
7383:
1.721 harmsja 7384: .LC_ListStyleSpecial li,
7385: .LC_ListStyleSpecial dd {
1.911 bisitz 7386: list-style-type: none;
7387: background-color: RGB(220, 220, 220);
7388: margin-bottom: 4px;
1.693 droeschl 7389: }
7390:
1.721 harmsja 7391: table.LC_SimpleTable {
1.911 bisitz 7392: margin:5px;
7393: border:solid 1px $lg_border_color;
1.795 www 7394: }
1.693 droeschl 7395:
1.721 harmsja 7396: table.LC_SimpleTable tr {
1.911 bisitz 7397: padding: 0;
7398: border:solid 1px $lg_border_color;
1.693 droeschl 7399: }
1.795 www 7400:
7401: table.LC_SimpleTable thead {
1.911 bisitz 7402: background:rgb(220,220,220);
1.693 droeschl 7403: }
7404:
1.721 harmsja 7405: div.LC_columnSection {
1.911 bisitz 7406: display: block;
7407: clear: both;
7408: overflow: hidden;
7409: margin: 0;
1.693 droeschl 7410: }
7411:
1.721 harmsja 7412: div.LC_columnSection>* {
1.911 bisitz 7413: float: left;
7414: margin: 10px 20px 10px 0;
7415: overflow:hidden;
1.693 droeschl 7416: }
1.721 harmsja 7417:
1.795 www 7418: table em {
1.911 bisitz 7419: font-weight: bold;
7420: font-style: normal;
1.748 schulted 7421: }
1.795 www 7422:
1.779 bisitz 7423: table.LC_tableBrowseRes,
1.795 www 7424: table.LC_tableOfContent {
1.911 bisitz 7425: border:none;
7426: border-spacing: 1px;
7427: padding: 3px;
7428: background-color: #FFFFFF;
7429: font-size: 90%;
1.753 droeschl 7430: }
1.789 droeschl 7431:
1.911 bisitz 7432: table.LC_tableOfContent {
7433: border-collapse: collapse;
1.789 droeschl 7434: }
7435:
1.771 droeschl 7436: table.LC_tableBrowseRes a,
1.768 schulted 7437: table.LC_tableOfContent a {
1.911 bisitz 7438: background-color: transparent;
7439: text-decoration: none;
1.753 droeschl 7440: }
7441:
1.795 www 7442: table.LC_tableOfContent img {
1.911 bisitz 7443: border: none;
7444: height: 1.3em;
7445: vertical-align: text-bottom;
7446: margin-right: 0.3em;
1.753 droeschl 7447: }
1.757 schulted 7448:
1.795 www 7449: a#LC_content_toolbar_firsthomework {
1.911 bisitz 7450: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 7451: }
7452:
1.795 www 7453: a#LC_content_toolbar_everything {
1.911 bisitz 7454: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 7455: }
7456:
1.795 www 7457: a#LC_content_toolbar_uncompleted {
1.911 bisitz 7458: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 7459: }
7460:
1.795 www 7461: #LC_content_toolbar_clearbubbles {
1.911 bisitz 7462: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 7463: }
7464:
1.795 www 7465: a#LC_content_toolbar_changefolder {
1.911 bisitz 7466: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 7467: }
7468:
1.795 www 7469: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 7470: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 7471: }
7472:
1.1043 raeburn 7473: a#LC_content_toolbar_edittoplevel {
7474: background-image:url(/res/adm/pages/edittoplevel.gif);
7475: }
7476:
1.795 www 7477: ul#LC_toolbar li a:hover {
1.911 bisitz 7478: background-position: bottom center;
1.757 schulted 7479: }
7480:
1.795 www 7481: ul#LC_toolbar {
1.911 bisitz 7482: padding: 0;
7483: margin: 2px;
7484: list-style:none;
7485: position:relative;
7486: background-color:white;
1.1082 raeburn 7487: overflow: auto;
1.757 schulted 7488: }
7489:
1.795 www 7490: ul#LC_toolbar li {
1.911 bisitz 7491: border:1px solid white;
7492: padding: 0;
7493: margin: 0;
7494: float: left;
7495: display:inline;
7496: vertical-align:middle;
1.1082 raeburn 7497: white-space: nowrap;
1.911 bisitz 7498: }
1.757 schulted 7499:
1.783 amueller 7500:
1.795 www 7501: a.LC_toolbarItem {
1.911 bisitz 7502: display:block;
7503: padding: 0;
7504: margin: 0;
7505: height: 32px;
7506: width: 32px;
7507: color:white;
7508: border: none;
7509: background-repeat:no-repeat;
7510: background-color:transparent;
1.757 schulted 7511: }
7512:
1.915 droeschl 7513: ul.LC_funclist {
7514: margin: 0;
7515: padding: 0.5em 1em 0.5em 0;
7516: }
7517:
1.933 droeschl 7518: ul.LC_funclist > li:first-child {
7519: font-weight:bold;
7520: margin-left:0.8em;
7521: }
7522:
1.915 droeschl 7523: ul.LC_funclist + ul.LC_funclist {
7524: /*
7525: left border as a seperator if we have more than
7526: one list
7527: */
7528: border-left: 1px solid $sidebg;
7529: /*
7530: this hides the left border behind the border of the
7531: outer box if element is wrapped to the next 'line'
7532: */
7533: margin-left: -1px;
7534: }
7535:
1.843 bisitz 7536: ul.LC_funclist li {
1.915 droeschl 7537: display: inline;
1.782 bisitz 7538: white-space: nowrap;
1.915 droeschl 7539: margin: 0 0 0 25px;
7540: line-height: 150%;
1.782 bisitz 7541: }
7542:
1.974 wenzelju 7543: .LC_hidden {
7544: display: none;
7545: }
7546:
1.1030 www 7547: .LCmodal-overlay {
7548: position:fixed;
7549: top:0;
7550: right:0;
7551: bottom:0;
7552: left:0;
7553: height:100%;
7554: width:100%;
7555: margin:0;
7556: padding:0;
7557: background:#999;
7558: opacity:.75;
7559: filter: alpha(opacity=75);
7560: -moz-opacity: 0.75;
7561: z-index:101;
7562: }
7563:
7564: * html .LCmodal-overlay {
7565: position: absolute;
7566: height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
7567: }
7568:
7569: .LCmodal-window {
7570: position:fixed;
7571: top:50%;
7572: left:50%;
7573: margin:0;
7574: padding:0;
7575: z-index:102;
7576: }
7577:
7578: * html .LCmodal-window {
7579: position:absolute;
7580: }
7581:
7582: .LCclose-window {
7583: position:absolute;
7584: width:32px;
7585: height:32px;
7586: right:8px;
7587: top:8px;
7588: background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
7589: text-indent:-99999px;
7590: overflow:hidden;
7591: cursor:pointer;
7592: }
7593:
1.1100 raeburn 7594: /*
7595: styles used by TTH when "Default set of options to pass to tth/m
7596: when converting TeX" in course settings has been set
7597:
7598: option passed: -t
7599:
7600: */
7601:
7602: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
7603: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
7604: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
7605: td div.norm {line-height:normal;}
7606:
7607: /*
7608: option passed -y3
7609: */
7610:
7611: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
7612: span.overacc2 {position: relative; left: .8em; top: -1.2ex;}
7613: span.overacc1 {position: relative; left: .6em; top: -1.2ex;}
7614:
1.343 albertel 7615: END
7616: }
7617:
1.306 albertel 7618: =pod
7619:
7620: =item * &headtag()
7621:
7622: Returns a uniform footer for LON-CAPA web pages.
7623:
1.307 albertel 7624: Inputs: $title - optional title for the head
7625: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 7626: $args - optional arguments
1.319 albertel 7627: force_register - if is true call registerurl so the remote is
7628: informed
1.415 albertel 7629: redirect -> array ref of
7630: 1- seconds before redirect occurs
7631: 2- url to redirect to
7632: 3- whether the side effect should occur
1.315 albertel 7633: (side effect of setting
7634: $env{'internal.head.redirect'} to the url
7635: redirected too)
1.352 albertel 7636: domain -> force to color decorate a page for a specific
7637: domain
7638: function -> force usage of a specific rolish color scheme
7639: bgcolor -> override the default page bgcolor
1.460 albertel 7640: no_auto_mt_title
7641: -> prevent &mt()ing the title arg
1.464 albertel 7642:
1.306 albertel 7643: =cut
7644:
7645: sub headtag {
1.313 albertel 7646: my ($title,$head_extra,$args) = @_;
1.306 albertel 7647:
1.363 albertel 7648: my $function = $args->{'function'} || &get_users_function();
7649: my $domain = $args->{'domain'} || &determinedomain();
7650: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.1154 raeburn 7651: my $httphost = $args->{'use_absolute'};
1.418 albertel 7652: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 7653: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 7654: #time(),
1.418 albertel 7655: $env{'environment.color.timestamp'},
1.363 albertel 7656: $function,$domain,$bgcolor);
7657:
1.369 www 7658: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 7659:
1.308 albertel 7660: my $result =
7661: '<head>'.
1.1160 raeburn 7662: &font_settings($args);
1.319 albertel 7663:
1.1188 raeburn 7664: my $inhibitprint;
7665: if ($args->{'print_suppress'}) {
7666: $inhibitprint = &print_suppression();
7667: }
1.1064 raeburn 7668:
1.461 albertel 7669: if (!$args->{'frameset'}) {
7670: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
7671: }
1.962 droeschl 7672: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
7673: $result .= Apache::lonxml::display_title();
1.319 albertel 7674: }
1.436 albertel 7675: if (!$args->{'no_nav_bar'}
7676: && !$args->{'only_body'}
7677: && !$args->{'frameset'}) {
1.1154 raeburn 7678: $result .= &help_menu_js($httphost);
1.1032 www 7679: $result.=&modal_window();
1.1038 www 7680: $result.=&togglebox_script();
1.1034 www 7681: $result.=&wishlist_window();
1.1041 www 7682: $result.=&LCprogressbarUpdate_script();
1.1034 www 7683: } else {
7684: if ($args->{'add_modal'}) {
7685: $result.=&modal_window();
7686: }
7687: if ($args->{'add_wishlist'}) {
7688: $result.=&wishlist_window();
7689: }
1.1038 www 7690: if ($args->{'add_togglebox'}) {
7691: $result.=&togglebox_script();
7692: }
1.1041 www 7693: if ($args->{'add_progressbar'}) {
7694: $result.=&LCprogressbarUpdate_script();
7695: }
1.436 albertel 7696: }
1.314 albertel 7697: if (ref($args->{'redirect'})) {
1.414 albertel 7698: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 7699: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 7700: if (!$inhibit_continue) {
7701: $env{'internal.head.redirect'} = $url;
7702: }
1.313 albertel 7703: $result.=<<ADDMETA
7704: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 7705: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 7706: ADDMETA
7707: }
1.306 albertel 7708: if (!defined($title)) {
7709: $title = 'The LearningOnline Network with CAPA';
7710: }
1.460 albertel 7711: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
7712: $result .= '<title> LON-CAPA '.$title.'</title>'
1.1168 raeburn 7713: .'<link rel="stylesheet" type="text/css" href="'.$url.'"';
7714: if (!$args->{'frameset'}) {
7715: $result .= ' /';
7716: }
7717: $result .= '>'
1.1064 raeburn 7718: .$inhibitprint
1.414 albertel 7719: .$head_extra;
1.1137 raeburn 7720: if ($env{'browser.mobile'}) {
7721: $result .= '
7722: <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=0, minimum-scale=1.0, maximum-scale=1.0">
7723: <meta name="apple-mobile-web-app-capable" content="yes" />';
7724: }
1.962 droeschl 7725: return $result.'</head>';
1.306 albertel 7726: }
7727:
7728: =pod
7729:
1.340 albertel 7730: =item * &font_settings()
7731:
7732: Returns neccessary <meta> to set the proper encoding
7733:
1.1160 raeburn 7734: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340 albertel 7735:
7736: =cut
7737:
7738: sub font_settings {
1.1160 raeburn 7739: my ($args) = @_;
1.340 albertel 7740: my $headerstring='';
1.1160 raeburn 7741: if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
7742: ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.1168 raeburn 7743: $headerstring.=
7744: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
7745: if (!$args->{'frameset'}) {
7746: $headerstring.= ' /';
7747: }
7748: $headerstring .= '>'."\n";
1.340 albertel 7749: }
7750: return $headerstring;
7751: }
7752:
1.341 albertel 7753: =pod
7754:
1.1064 raeburn 7755: =item * &print_suppression()
7756:
7757: In course context returns css which causes the body to be blank when media="print",
7758: if printout generation is unavailable for the current resource.
7759:
7760: This could be because:
7761:
7762: (a) printstartdate is in the future
7763:
7764: (b) printenddate is in the past
7765:
7766: (c) there is an active exam block with "printout"
7767: functionality blocked
7768:
7769: Users with pav, pfo or evb privileges are exempt.
7770:
7771: Inputs: none
7772:
7773: =cut
7774:
7775:
7776: sub print_suppression {
7777: my $noprint;
7778: if ($env{'request.course.id'}) {
7779: my $scope = $env{'request.course.id'};
7780: if ((&Apache::lonnet::allowed('pav',$scope)) ||
7781: (&Apache::lonnet::allowed('pfo',$scope))) {
7782: return;
7783: }
7784: if ($env{'request.course.sec'} ne '') {
7785: $scope .= "/$env{'request.course.sec'}";
7786: if ((&Apache::lonnet::allowed('pav',$scope)) ||
7787: (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065 raeburn 7788: return;
1.1064 raeburn 7789: }
7790: }
7791: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7792: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1189 raeburn 7793: my $blocked = &blocking_status('printout',$cnum,$cdom,undef,1);
1.1064 raeburn 7794: if ($blocked) {
7795: my $checkrole = "cm./$cdom/$cnum";
7796: if ($env{'request.course.sec'} ne '') {
7797: $checkrole .= "/$env{'request.course.sec'}";
7798: }
7799: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
7800: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
7801: $noprint = 1;
7802: }
7803: }
7804: unless ($noprint) {
7805: my $symb = &Apache::lonnet::symbread();
7806: if ($symb ne '') {
7807: my $navmap = Apache::lonnavmaps::navmap->new();
7808: if (ref($navmap)) {
7809: my $res = $navmap->getBySymb($symb);
7810: if (ref($res)) {
7811: if (!$res->resprintable()) {
7812: $noprint = 1;
7813: }
7814: }
7815: }
7816: }
7817: }
7818: if ($noprint) {
7819: return <<"ENDSTYLE";
7820: <style type="text/css" media="print">
7821: body { display:none }
7822: </style>
7823: ENDSTYLE
7824: }
7825: }
7826: return;
7827: }
7828:
7829: =pod
7830:
1.341 albertel 7831: =item * &xml_begin()
7832:
7833: Returns the needed doctype and <html>
7834:
7835: Inputs: none
7836:
7837: =cut
7838:
7839: sub xml_begin {
1.1168 raeburn 7840: my ($is_frameset) = @_;
1.341 albertel 7841: my $output='';
7842:
7843: if ($env{'browser.mathml'}) {
7844: $output='<?xml version="1.0"?>'
7845: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
7846: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
7847:
7848: # .'<!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">] >'
7849: .'<!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">'
7850: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
7851: .'xmlns="http://www.w3.org/1999/xhtml">';
1.1168 raeburn 7852: } elsif ($is_frameset) {
7853: $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
7854: '<html>'."\n";
1.341 albertel 7855: } else {
1.1168 raeburn 7856: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
7857: '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341 albertel 7858: }
7859: return $output;
7860: }
1.340 albertel 7861:
7862: =pod
7863:
1.306 albertel 7864: =item * &start_page()
7865:
7866: Returns a complete <html> .. <body> section for LON-CAPA web pages.
7867:
1.648 raeburn 7868: Inputs:
7869:
7870: =over 4
7871:
7872: $title - optional title for the page
7873:
7874: $head_extra - optional extra HTML to incude inside the <head>
7875:
7876: $args - additional optional args supported are:
7877:
7878: =over 8
7879:
7880: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 7881: arg on
1.814 bisitz 7882: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 7883: add_entries -> additional attributes to add to the <body>
7884: domain -> force to color decorate a page for a
1.317 albertel 7885: specific domain
1.648 raeburn 7886: function -> force usage of a specific rolish color
1.317 albertel 7887: scheme
1.648 raeburn 7888: redirect -> see &headtag()
7889: bgcolor -> override the default page bg color
7890: js_ready -> return a string ready for being used in
1.317 albertel 7891: a javascript writeln
1.648 raeburn 7892: html_encode -> return a string ready for being used in
1.320 albertel 7893: a html attribute
1.648 raeburn 7894: force_register -> if is true will turn on the &bodytag()
1.317 albertel 7895: $forcereg arg
1.648 raeburn 7896: frameset -> if true will start with a <frameset>
1.330 albertel 7897: rather than <body>
1.648 raeburn 7898: skip_phases -> hash ref of
1.338 albertel 7899: head -> skip the <html><head> generation
7900: body -> skip all <body> generation
1.648 raeburn 7901: no_auto_mt_title -> prevent &mt()ing the title arg
7902: inherit_jsmath -> when creating popup window in a page,
7903: should it have jsmath forced on by the
7904: current page
1.867 kalberla 7905: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 7906: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.1096 raeburn 7907: group -> includes the current group, if page is for a
7908: specific group
1.361 albertel 7909:
1.648 raeburn 7910: =back
1.460 albertel 7911:
1.648 raeburn 7912: =back
1.562 albertel 7913:
1.306 albertel 7914: =cut
7915:
7916: sub start_page {
1.309 albertel 7917: my ($title,$head_extra,$args) = @_;
1.318 albertel 7918: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319 albertel 7919:
1.315 albertel 7920: $env{'internal.start_page'}++;
1.1096 raeburn 7921: my ($result,@advtools);
1.964 droeschl 7922:
1.338 albertel 7923: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1168 raeburn 7924: $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338 albertel 7925: }
7926:
7927: if (! exists($args->{'skip_phases'}{'body'}) ) {
7928: if ($args->{'frameset'}) {
7929: my $attr_string = &make_attr_string($args->{'force_register'},
7930: $args->{'add_entries'});
7931: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 7932: } else {
7933: $result .=
7934: &bodytag($title,
7935: $args->{'function'}, $args->{'add_entries'},
7936: $args->{'only_body'}, $args->{'domain'},
7937: $args->{'force_register'}, $args->{'no_nav_bar'},
1.1096 raeburn 7938: $args->{'bgcolor'}, $args,
7939: \@advtools);
1.831 bisitz 7940: }
1.330 albertel 7941: }
1.338 albertel 7942:
1.315 albertel 7943: if ($args->{'js_ready'}) {
1.713 kaisler 7944: $result = &js_ready($result);
1.315 albertel 7945: }
1.320 albertel 7946: if ($args->{'html_encode'}) {
1.713 kaisler 7947: $result = &html_encode($result);
7948: }
7949:
1.813 bisitz 7950: # Preparation for new and consistent functionlist at top of screen
7951: # if ($args->{'functionlist'}) {
7952: # $result .= &build_functionlist();
7953: #}
7954:
1.964 droeschl 7955: # Don't add anything more if only_body wanted or in const space
7956: return $result if $args->{'only_body'}
7957: || $env{'request.state'} eq 'construct';
1.813 bisitz 7958:
7959: #Breadcrumbs
1.758 kaisler 7960: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
7961: &Apache::lonhtmlcommon::clear_breadcrumbs();
7962: #if any br links exists, add them to the breadcrumbs
7963: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
7964: foreach my $crumb (@{$args->{'bread_crumbs'}}){
7965: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
7966: }
7967: }
1.1096 raeburn 7968: # if @advtools array contains items add then to the breadcrumbs
7969: if (@advtools > 0) {
7970: &Apache::lonmenu::advtools_crumbs(@advtools);
7971: }
1.758 kaisler 7972:
7973: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
7974: if(exists($args->{'bread_crumbs_component'})){
7975: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
7976: }else{
7977: $result .= &Apache::lonhtmlcommon::breadcrumbs();
7978: }
1.320 albertel 7979: }
1.315 albertel 7980: return $result;
1.306 albertel 7981: }
7982:
7983: sub end_page {
1.315 albertel 7984: my ($args) = @_;
7985: $env{'internal.end_page'}++;
1.330 albertel 7986: my $result;
1.335 albertel 7987: if ($args->{'discussion'}) {
7988: my ($target,$parser);
7989: if (ref($args->{'discussion'})) {
7990: ($target,$parser) =($args->{'discussion'}{'target'},
7991: $args->{'discussion'}{'parser'});
7992: }
7993: $result .= &Apache::lonxml::xmlend($target,$parser);
7994: }
1.330 albertel 7995: if ($args->{'frameset'}) {
7996: $result .= '</frameset>';
7997: } else {
1.635 raeburn 7998: $result .= &endbodytag($args);
1.330 albertel 7999: }
1.1080 raeburn 8000: unless ($args->{'notbody'}) {
8001: $result .= "\n</html>";
8002: }
1.330 albertel 8003:
1.315 albertel 8004: if ($args->{'js_ready'}) {
1.317 albertel 8005: $result = &js_ready($result);
1.315 albertel 8006: }
1.335 albertel 8007:
1.320 albertel 8008: if ($args->{'html_encode'}) {
8009: $result = &html_encode($result);
8010: }
1.335 albertel 8011:
1.315 albertel 8012: return $result;
8013: }
8014:
1.1034 www 8015: sub wishlist_window {
8016: return(<<'ENDWISHLIST');
1.1046 raeburn 8017: <script type="text/javascript">
1.1034 www 8018: // <![CDATA[
8019: // <!-- BEGIN LON-CAPA Internal
8020: function set_wishlistlink(title, path) {
8021: if (!title) {
8022: title = document.title;
8023: title = title.replace(/^LON-CAPA /,'');
8024: }
1.1175 raeburn 8025: title = encodeURIComponent(title);
1.1203 raeburn 8026: title = title.replace("'","\\\'");
1.1034 www 8027: if (!path) {
8028: path = location.pathname;
8029: }
1.1175 raeburn 8030: path = encodeURIComponent(path);
1.1203 raeburn 8031: path = path.replace("'","\\\'");
1.1034 www 8032: Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
8033: 'wishlistNewLink','width=560,height=350,scrollbars=0');
8034: }
8035: // END LON-CAPA Internal -->
8036: // ]]>
8037: </script>
8038: ENDWISHLIST
8039: }
8040:
1.1030 www 8041: sub modal_window {
8042: return(<<'ENDMODAL');
1.1046 raeburn 8043: <script type="text/javascript">
1.1030 www 8044: // <![CDATA[
8045: // <!-- BEGIN LON-CAPA Internal
8046: var modalWindow = {
8047: parent:"body",
8048: windowId:null,
8049: content:null,
8050: width:null,
8051: height:null,
8052: close:function()
8053: {
8054: $(".LCmodal-window").remove();
8055: $(".LCmodal-overlay").remove();
8056: },
8057: open:function()
8058: {
8059: var modal = "";
8060: modal += "<div class=\"LCmodal-overlay\"></div>";
8061: 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;\">";
8062: modal += this.content;
8063: modal += "</div>";
8064:
8065: $(this.parent).append(modal);
8066:
8067: $(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
8068: $(".LCclose-window").click(function(){modalWindow.close();});
8069: $(".LCmodal-overlay").click(function(){modalWindow.close();});
8070: }
8071: };
1.1140 raeburn 8072: var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030 www 8073: {
1.1203 raeburn 8074: source = source.replace("'","'");
1.1030 www 8075: modalWindow.windowId = "myModal";
8076: modalWindow.width = width;
8077: modalWindow.height = height;
1.1196 raeburn 8078: modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030 www 8079: modalWindow.open();
1.1208 ! raeburn 8080: };
1.1030 www 8081: // END LON-CAPA Internal -->
8082: // ]]>
8083: </script>
8084: ENDMODAL
8085: }
8086:
8087: sub modal_link {
1.1140 raeburn 8088: my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030 www 8089: unless ($width) { $width=480; }
8090: unless ($height) { $height=400; }
1.1031 www 8091: unless ($scrolling) { $scrolling='yes'; }
1.1140 raeburn 8092: unless ($transparency) { $transparency='true'; }
8093:
1.1074 raeburn 8094: my $target_attr;
8095: if (defined($target)) {
8096: $target_attr = 'target="'.$target.'"';
8097: }
8098: return <<"ENDLINK";
1.1140 raeburn 8099: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">
1.1074 raeburn 8100: $linktext</a>
8101: ENDLINK
1.1030 www 8102: }
8103:
1.1032 www 8104: sub modal_adhoc_script {
8105: my ($funcname,$width,$height,$content)=@_;
8106: return (<<ENDADHOC);
1.1046 raeburn 8107: <script type="text/javascript">
1.1032 www 8108: // <![CDATA[
8109: var $funcname = function()
8110: {
8111: modalWindow.windowId = "myModal";
8112: modalWindow.width = $width;
8113: modalWindow.height = $height;
8114: modalWindow.content = '$content';
8115: modalWindow.open();
8116: };
8117: // ]]>
8118: </script>
8119: ENDADHOC
8120: }
8121:
1.1041 www 8122: sub modal_adhoc_inner {
8123: my ($funcname,$width,$height,$content)=@_;
8124: my $innerwidth=$width-20;
8125: $content=&js_ready(
1.1140 raeburn 8126: &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
8127: &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
8128: $content.
1.1041 www 8129: &end_scrollbox().
1.1140 raeburn 8130: &end_page()
1.1041 www 8131: );
8132: return &modal_adhoc_script($funcname,$width,$height,$content);
8133: }
8134:
8135: sub modal_adhoc_window {
8136: my ($funcname,$width,$height,$content,$linktext)=@_;
8137: return &modal_adhoc_inner($funcname,$width,$height,$content).
8138: "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
8139: }
8140:
8141: sub modal_adhoc_launch {
8142: my ($funcname,$width,$height,$content)=@_;
8143: return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
8144: <script type="text/javascript">
8145: // <![CDATA[
8146: $funcname();
8147: // ]]>
8148: </script>
8149: ENDLAUNCH
8150: }
8151:
8152: sub modal_adhoc_close {
8153: return (<<ENDCLOSE);
8154: <script type="text/javascript">
8155: // <![CDATA[
8156: modalWindow.close();
8157: // ]]>
8158: </script>
8159: ENDCLOSE
8160: }
8161:
1.1038 www 8162: sub togglebox_script {
8163: return(<<ENDTOGGLE);
8164: <script type="text/javascript">
8165: // <![CDATA[
8166: function LCtoggleDisplay(id,hidetext,showtext) {
8167: link = document.getElementById(id + "link").childNodes[0];
8168: with (document.getElementById(id).style) {
8169: if (display == "none" ) {
8170: display = "inline";
8171: link.nodeValue = hidetext;
8172: } else {
8173: display = "none";
8174: link.nodeValue = showtext;
8175: }
8176: }
8177: }
8178: // ]]>
8179: </script>
8180: ENDTOGGLE
8181: }
8182:
1.1039 www 8183: sub start_togglebox {
8184: my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
8185: unless ($heading) { $heading=''; } else { $heading.=' '; }
8186: unless ($showtext) { $showtext=&mt('show'); }
8187: unless ($hidetext) { $hidetext=&mt('hide'); }
8188: unless ($headerbg) { $headerbg='#FFFFFF'; }
8189: return &start_data_table().
8190: &start_data_table_header_row().
8191: '<td bgcolor="'.$headerbg.'">'.$heading.
8192: '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
8193: $showtext.'\')">'.$showtext.'</a>]</td>'.
8194: &end_data_table_header_row().
8195: '<tr id="'.$id.'" style="display:none""><td>';
8196: }
8197:
8198: sub end_togglebox {
8199: return '</td></tr>'.&end_data_table();
8200: }
8201:
1.1041 www 8202: sub LCprogressbar_script {
1.1045 www 8203: my ($id)=@_;
1.1041 www 8204: return(<<ENDPROGRESS);
8205: <script type="text/javascript">
8206: // <![CDATA[
1.1045 www 8207: \$('#progressbar$id').progressbar({
1.1041 www 8208: value: 0,
8209: change: function(event, ui) {
8210: var newVal = \$(this).progressbar('option', 'value');
8211: \$('.pblabel', this).text(LCprogressTxt);
8212: }
8213: });
8214: // ]]>
8215: </script>
8216: ENDPROGRESS
8217: }
8218:
8219: sub LCprogressbarUpdate_script {
8220: return(<<ENDPROGRESSUPDATE);
8221: <style type="text/css">
8222: .ui-progressbar { position:relative; }
8223: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
8224: </style>
8225: <script type="text/javascript">
8226: // <![CDATA[
1.1045 www 8227: var LCprogressTxt='---';
8228:
8229: function LCupdateProgress(percent,progresstext,id) {
1.1041 www 8230: LCprogressTxt=progresstext;
1.1045 www 8231: \$('#progressbar'+id).progressbar('value',percent);
1.1041 www 8232: }
8233: // ]]>
8234: </script>
8235: ENDPROGRESSUPDATE
8236: }
8237:
1.1042 www 8238: my $LClastpercent;
1.1045 www 8239: my $LCidcnt;
8240: my $LCcurrentid;
1.1042 www 8241:
1.1041 www 8242: sub LCprogressbar {
1.1042 www 8243: my ($r)=(@_);
8244: $LClastpercent=0;
1.1045 www 8245: $LCidcnt++;
8246: $LCcurrentid=$$.'_'.$LCidcnt;
1.1041 www 8247: my $starting=&mt('Starting');
8248: my $content=(<<ENDPROGBAR);
1.1045 www 8249: <div id="progressbar$LCcurrentid">
1.1041 www 8250: <span class="pblabel">$starting</span>
8251: </div>
8252: ENDPROGBAR
1.1045 www 8253: &r_print($r,$content.&LCprogressbar_script($LCcurrentid));
1.1041 www 8254: }
8255:
8256: sub LCprogressbarUpdate {
1.1042 www 8257: my ($r,$val,$text)=@_;
8258: unless ($val) {
8259: if ($LClastpercent) {
8260: $val=$LClastpercent;
8261: } else {
8262: $val=0;
8263: }
8264: }
1.1041 www 8265: if ($val<0) { $val=0; }
8266: if ($val>100) { $val=0; }
1.1042 www 8267: $LClastpercent=$val;
1.1041 www 8268: unless ($text) { $text=$val.'%'; }
8269: $text=&js_ready($text);
1.1044 www 8270: &r_print($r,<<ENDUPDATE);
1.1041 www 8271: <script type="text/javascript">
8272: // <![CDATA[
1.1045 www 8273: LCupdateProgress($val,'$text','$LCcurrentid');
1.1041 www 8274: // ]]>
8275: </script>
8276: ENDUPDATE
1.1035 www 8277: }
8278:
1.1042 www 8279: sub LCprogressbarClose {
8280: my ($r)=@_;
8281: $LClastpercent=0;
1.1044 www 8282: &r_print($r,<<ENDCLOSE);
1.1042 www 8283: <script type="text/javascript">
8284: // <![CDATA[
1.1045 www 8285: \$("#progressbar$LCcurrentid").hide('slow');
1.1042 www 8286: // ]]>
8287: </script>
8288: ENDCLOSE
1.1044 www 8289: }
8290:
8291: sub r_print {
8292: my ($r,$to_print)=@_;
8293: if ($r) {
8294: $r->print($to_print);
8295: $r->rflush();
8296: } else {
8297: print($to_print);
8298: }
1.1042 www 8299: }
8300:
1.320 albertel 8301: sub html_encode {
8302: my ($result) = @_;
8303:
1.322 albertel 8304: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 8305:
8306: return $result;
8307: }
1.1044 www 8308:
1.317 albertel 8309: sub js_ready {
8310: my ($result) = @_;
8311:
1.323 albertel 8312: $result =~ s/[\n\r]/ /xmsg;
8313: $result =~ s/\\/\\\\/xmsg;
8314: $result =~ s/'/\\'/xmsg;
1.372 albertel 8315: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 8316:
8317: return $result;
8318: }
8319:
1.315 albertel 8320: sub validate_page {
8321: if ( exists($env{'internal.start_page'})
1.316 albertel 8322: && $env{'internal.start_page'} > 1) {
8323: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 8324: $env{'internal.start_page'}.' '.
1.316 albertel 8325: $ENV{'request.filename'});
1.315 albertel 8326: }
8327: if ( exists($env{'internal.end_page'})
1.316 albertel 8328: && $env{'internal.end_page'} > 1) {
8329: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 8330: $env{'internal.end_page'}.' '.
1.316 albertel 8331: $env{'request.filename'});
1.315 albertel 8332: }
8333: if ( exists($env{'internal.start_page'})
8334: && ! exists($env{'internal.end_page'})) {
1.316 albertel 8335: &Apache::lonnet::logthis('start_page called without end_page '.
8336: $env{'request.filename'});
1.315 albertel 8337: }
8338: if ( ! exists($env{'internal.start_page'})
8339: && exists($env{'internal.end_page'})) {
1.316 albertel 8340: &Apache::lonnet::logthis('end_page called without start_page'.
8341: $env{'request.filename'});
1.315 albertel 8342: }
1.306 albertel 8343: }
1.315 albertel 8344:
1.996 www 8345:
8346: sub start_scrollbox {
1.1140 raeburn 8347: my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998 raeburn 8348: unless ($outerwidth) { $outerwidth='520px'; }
8349: unless ($width) { $width='500px'; }
8350: unless ($height) { $height='200px'; }
1.1075 raeburn 8351: my ($table_id,$div_id,$tdcol);
1.1018 raeburn 8352: if ($id ne '') {
1.1140 raeburn 8353: $table_id = ' id="table_'.$id.'"';
1.1137 raeburn 8354: $div_id = ' id="div_'.$id.'"';
1.1018 raeburn 8355: }
1.1075 raeburn 8356: if ($bgcolor ne '') {
8357: $tdcol = "background-color: $bgcolor;";
8358: }
1.1137 raeburn 8359: my $nicescroll_js;
8360: if ($env{'browser.mobile'}) {
1.1140 raeburn 8361: $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
8362: }
8363: return <<"END";
8364: $nicescroll_js
8365:
8366: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
8367: <div style="overflow:auto; width:$width; height:$height;"$div_id>
8368: END
8369: }
8370:
8371: sub end_scrollbox {
8372: return '</div></td></tr></table>';
8373: }
8374:
8375: sub nicescroll_javascript {
8376: my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
8377: my %options;
8378: if (ref($cursor) eq 'HASH') {
8379: %options = %{$cursor};
8380: }
8381: unless ($options{'railalign'} =~ /^left|right$/) {
8382: $options{'railalign'} = 'left';
8383: }
8384: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
8385: my $function = &get_users_function();
8386: $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
1.1138 raeburn 8387: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
1.1140 raeburn 8388: $options{'cursorcolor'} = '#00F';
1.1138 raeburn 8389: }
1.1140 raeburn 8390: }
8391: if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
8392: unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
1.1138 raeburn 8393: $options{'cursoropacity'}='1.0';
8394: }
1.1140 raeburn 8395: } else {
8396: $options{'cursoropacity'}='1.0';
8397: }
8398: if ($options{'cursorfixedheight'} eq 'none') {
8399: delete($options{'cursorfixedheight'});
8400: } else {
8401: unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
8402: }
8403: unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
8404: delete($options{'railoffset'});
8405: }
8406: my @niceoptions;
8407: while (my($key,$value) = each(%options)) {
8408: if ($value =~ /^\{.+\}$/) {
8409: push(@niceoptions,$key.':'.$value);
1.1138 raeburn 8410: } else {
1.1140 raeburn 8411: push(@niceoptions,$key.':"'.$value.'"');
1.1138 raeburn 8412: }
1.1140 raeburn 8413: }
8414: my $nicescroll_js = '
1.1137 raeburn 8415: $(document).ready(
1.1140 raeburn 8416: function() {
8417: $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
8418: }
1.1137 raeburn 8419: );
8420: ';
1.1140 raeburn 8421: if ($framecheck) {
8422: $nicescroll_js .= '
8423: function expand_div(caller) {
8424: if (top === self) {
8425: document.getElementById("'.$id.'").style.width = "auto";
8426: document.getElementById("'.$id.'").style.height = "auto";
8427: } else {
8428: try {
8429: if (parent.frames) {
8430: if (parent.frames.length > 1) {
8431: var framesrc = parent.frames[1].location.href;
8432: var currsrc = framesrc.replace(/\#.*$/,"");
8433: if ((caller == "search") || (currsrc == "'.$location.'")) {
8434: document.getElementById("'.$id.'").style.width = "auto";
8435: document.getElementById("'.$id.'").style.height = "auto";
8436: }
8437: }
8438: }
8439: } catch (e) {
8440: return;
8441: }
1.1137 raeburn 8442: }
1.1140 raeburn 8443: return;
1.996 www 8444: }
1.1140 raeburn 8445: ';
8446: }
8447: if ($needjsready) {
8448: $nicescroll_js = '
8449: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
8450: } else {
8451: $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
8452: }
8453: return $nicescroll_js;
1.996 www 8454: }
8455:
1.318 albertel 8456: sub simple_error_page {
1.1150 bisitz 8457: my ($r,$title,$msg,$args) = @_;
1.1151 raeburn 8458: if (ref($args) eq 'HASH') {
8459: if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
8460: } else {
8461: $msg = &mt($msg);
8462: }
1.1150 bisitz 8463:
1.318 albertel 8464: my $page =
8465: &Apache::loncommon::start_page($title).
1.1150 bisitz 8466: '<p class="LC_error">'.$msg.'</p>'.
1.318 albertel 8467: &Apache::loncommon::end_page();
8468: if (ref($r)) {
8469: $r->print($page);
1.327 albertel 8470: return;
1.318 albertel 8471: }
8472: return $page;
8473: }
1.347 albertel 8474:
8475: {
1.610 albertel 8476: my @row_count;
1.961 onken 8477:
8478: sub start_data_table_count {
8479: unshift(@row_count, 0);
8480: return;
8481: }
8482:
8483: sub end_data_table_count {
8484: shift(@row_count);
8485: return;
8486: }
8487:
1.347 albertel 8488: sub start_data_table {
1.1018 raeburn 8489: my ($add_class,$id) = @_;
1.422 albertel 8490: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 8491: my $table_id;
8492: if (defined($id)) {
8493: $table_id = ' id="'.$id.'"';
8494: }
1.961 onken 8495: &start_data_table_count();
1.1018 raeburn 8496: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 8497: }
8498:
8499: sub end_data_table {
1.961 onken 8500: &end_data_table_count();
1.389 albertel 8501: return '</table>'."\n";;
1.347 albertel 8502: }
8503:
8504: sub start_data_table_row {
1.974 wenzelju 8505: my ($add_class, $id) = @_;
1.610 albertel 8506: $row_count[0]++;
8507: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 8508: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 8509: $id = (' id="'.$id.'"') unless ($id eq '');
8510: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 8511: }
1.471 banghart 8512:
8513: sub continue_data_table_row {
1.974 wenzelju 8514: my ($add_class, $id) = @_;
1.610 albertel 8515: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 8516: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
8517: $id = (' id="'.$id.'"') unless ($id eq '');
8518: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 8519: }
1.347 albertel 8520:
8521: sub end_data_table_row {
1.389 albertel 8522: return '</tr>'."\n";;
1.347 albertel 8523: }
1.367 www 8524:
1.421 albertel 8525: sub start_data_table_empty_row {
1.707 bisitz 8526: # $row_count[0]++;
1.421 albertel 8527: return '<tr class="LC_empty_row" >'."\n";;
8528: }
8529:
8530: sub end_data_table_empty_row {
8531: return '</tr>'."\n";;
8532: }
8533:
1.367 www 8534: sub start_data_table_header_row {
1.389 albertel 8535: return '<tr class="LC_header_row">'."\n";;
1.367 www 8536: }
8537:
8538: sub end_data_table_header_row {
1.389 albertel 8539: return '</tr>'."\n";;
1.367 www 8540: }
1.890 droeschl 8541:
8542: sub data_table_caption {
8543: my $caption = shift;
8544: return "<caption class=\"LC_caption\">$caption</caption>";
8545: }
1.347 albertel 8546: }
8547:
1.548 albertel 8548: =pod
8549:
8550: =item * &inhibit_menu_check($arg)
8551:
8552: Checks for a inhibitmenu state and generates output to preserve it
8553:
8554: Inputs: $arg - can be any of
8555: - undef - in which case the return value is a string
8556: to add into arguments list of a uri
8557: - 'input' - in which case the return value is a HTML
8558: <form> <input> field of type hidden to
8559: preserve the value
8560: - a url - in which case the return value is the url with
8561: the neccesary cgi args added to preserve the
8562: inhibitmenu state
8563: - a ref to a url - no return value, but the string is
8564: updated to include the neccessary cgi
8565: args to preserve the inhibitmenu state
8566:
8567: =cut
8568:
8569: sub inhibit_menu_check {
8570: my ($arg) = @_;
8571: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
8572: if ($arg eq 'input') {
8573: if ($env{'form.inhibitmenu'}) {
8574: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
8575: } else {
8576: return
8577: }
8578: }
8579: if ($env{'form.inhibitmenu'}) {
8580: if (ref($arg)) {
8581: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
8582: } elsif ($arg eq '') {
8583: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
8584: } else {
8585: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
8586: }
8587: }
8588: if (!ref($arg)) {
8589: return $arg;
8590: }
8591: }
8592:
1.251 albertel 8593: ###############################################
1.182 matthew 8594:
8595: =pod
8596:
1.549 albertel 8597: =back
8598:
8599: =head1 User Information Routines
8600:
8601: =over 4
8602:
1.405 albertel 8603: =item * &get_users_function()
1.182 matthew 8604:
8605: Used by &bodytag to determine the current users primary role.
8606: Returns either 'student','coordinator','admin', or 'author'.
8607:
8608: =cut
8609:
8610: ###############################################
8611: sub get_users_function {
1.815 tempelho 8612: my $function = 'norole';
1.818 tempelho 8613: if ($env{'request.role'}=~/^(st)/) {
8614: $function='student';
8615: }
1.907 raeburn 8616: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 8617: $function='coordinator';
8618: }
1.258 albertel 8619: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 8620: $function='admin';
8621: }
1.826 bisitz 8622: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025 raeburn 8623: ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182 matthew 8624: $function='author';
8625: }
8626: return $function;
1.54 www 8627: }
1.99 www 8628:
8629: ###############################################
8630:
1.233 raeburn 8631: =pod
8632:
1.821 raeburn 8633: =item * &show_course()
8634:
8635: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
8636: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
8637:
8638: Inputs:
8639: None
8640:
8641: Outputs:
8642: Scalar: 1 if 'Course' to be used, 0 otherwise.
8643:
8644: =cut
8645:
8646: ###############################################
8647: sub show_course {
8648: my $course = !$env{'user.adv'};
8649: if (!$env{'user.adv'}) {
8650: foreach my $env (keys(%env)) {
8651: next if ($env !~ m/^user\.priv\./);
8652: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
8653: $course = 0;
8654: last;
8655: }
8656: }
8657: }
8658: return $course;
8659: }
8660:
8661: ###############################################
8662:
8663: =pod
8664:
1.542 raeburn 8665: =item * &check_user_status()
1.274 raeburn 8666:
8667: Determines current status of supplied role for a
8668: specific user. Roles can be active, previous or future.
8669:
8670: Inputs:
8671: user's domain, user's username, course's domain,
1.375 raeburn 8672: course's number, optional section ID.
1.274 raeburn 8673:
8674: Outputs:
8675: role status: active, previous or future.
8676:
8677: =cut
8678:
8679: sub check_user_status {
1.412 raeburn 8680: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073 raeburn 8681: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1202 raeburn 8682: my @uroles = keys(%userinfo);
1.274 raeburn 8683: my $srchstr;
8684: my $active_chk = 'none';
1.412 raeburn 8685: my $now = time;
1.274 raeburn 8686: if (@uroles > 0) {
1.908 raeburn 8687: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 8688: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
8689: } else {
1.412 raeburn 8690: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
8691: }
8692: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 8693: my $role_end = 0;
8694: my $role_start = 0;
8695: $active_chk = 'active';
1.412 raeburn 8696: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
8697: $role_end = $1;
8698: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
8699: $role_start = $1;
1.274 raeburn 8700: }
8701: }
8702: if ($role_start > 0) {
1.412 raeburn 8703: if ($now < $role_start) {
1.274 raeburn 8704: $active_chk = 'future';
8705: }
8706: }
8707: if ($role_end > 0) {
1.412 raeburn 8708: if ($now > $role_end) {
1.274 raeburn 8709: $active_chk = 'previous';
8710: }
8711: }
8712: }
8713: }
8714: return $active_chk;
8715: }
8716:
8717: ###############################################
8718:
8719: =pod
8720:
1.405 albertel 8721: =item * &get_sections()
1.233 raeburn 8722:
8723: Determines all the sections for a course including
8724: sections with students and sections containing other roles.
1.419 raeburn 8725: Incoming parameters:
8726:
8727: 1. domain
8728: 2. course number
8729: 3. reference to array containing roles for which sections should
8730: be gathered (optional).
8731: 4. reference to array containing status types for which sections
8732: should be gathered (optional).
8733:
8734: If the third argument is undefined, sections are gathered for any role.
8735: If the fourth argument is undefined, sections are gathered for any status.
8736: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 8737:
1.374 raeburn 8738: Returns section hash (keys are section IDs, values are
8739: number of users in each section), subject to the
1.419 raeburn 8740: optional roles filter, optional status filter
1.233 raeburn 8741:
8742: =cut
8743:
8744: ###############################################
8745: sub get_sections {
1.419 raeburn 8746: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 8747: if (!defined($cdom) || !defined($cnum)) {
8748: my $cid = $env{'request.course.id'};
8749:
8750: return if (!defined($cid));
8751:
8752: $cdom = $env{'course.'.$cid.'.domain'};
8753: $cnum = $env{'course.'.$cid.'.num'};
8754: }
8755:
8756: my %sectioncount;
1.419 raeburn 8757: my $now = time;
1.240 albertel 8758:
1.1118 raeburn 8759: my $check_students = 1;
8760: my $only_students = 0;
8761: if (ref($possible_roles) eq 'ARRAY') {
8762: if (grep(/^st$/,@{$possible_roles})) {
8763: if (@{$possible_roles} == 1) {
8764: $only_students = 1;
8765: }
8766: } else {
8767: $check_students = 0;
8768: }
8769: }
8770:
8771: if ($check_students) {
1.276 albertel 8772: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 8773: my $sec_index = &Apache::loncoursedata::CL_SECTION();
8774: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 8775: my $start_index = &Apache::loncoursedata::CL_START();
8776: my $end_index = &Apache::loncoursedata::CL_END();
8777: my $status;
1.366 albertel 8778: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 8779: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
8780: $data->[$status_index],
8781: $data->[$start_index],
8782: $data->[$end_index]);
8783: if ($stu_status eq 'Active') {
8784: $status = 'active';
8785: } elsif ($end < $now) {
8786: $status = 'previous';
8787: } elsif ($start > $now) {
8788: $status = 'future';
8789: }
8790: if ($section ne '-1' && $section !~ /^\s*$/) {
8791: if ((!defined($possible_status)) || (($status ne '') &&
8792: (grep/^\Q$status\E$/,@{$possible_status}))) {
8793: $sectioncount{$section}++;
8794: }
1.240 albertel 8795: }
8796: }
8797: }
1.1118 raeburn 8798: if ($only_students) {
8799: return %sectioncount;
8800: }
1.240 albertel 8801: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8802: foreach my $user (sort(keys(%courseroles))) {
8803: if ($user !~ /^(\w{2})/) { next; }
8804: my ($role) = ($user =~ /^(\w{2})/);
8805: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 8806: my ($section,$status);
1.240 albertel 8807: if ($role eq 'cr' &&
8808: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
8809: $section=$1;
8810: }
8811: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
8812: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 8813: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
8814: if ($end == -1 && $start == -1) {
8815: next; #deleted role
8816: }
8817: if (!defined($possible_status)) {
8818: $sectioncount{$section}++;
8819: } else {
8820: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
8821: $status = 'active';
8822: } elsif ($end < $now) {
8823: $status = 'future';
8824: } elsif ($start > $now) {
8825: $status = 'previous';
8826: }
8827: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
8828: $sectioncount{$section}++;
8829: }
8830: }
1.233 raeburn 8831: }
1.366 albertel 8832: return %sectioncount;
1.233 raeburn 8833: }
8834:
1.274 raeburn 8835: ###############################################
1.294 raeburn 8836:
8837: =pod
1.405 albertel 8838:
8839: =item * &get_course_users()
8840:
1.275 raeburn 8841: Retrieves usernames:domains for users in the specified course
8842: with specific role(s), and access status.
8843:
8844: Incoming parameters:
1.277 albertel 8845: 1. course domain
8846: 2. course number
8847: 3. access status: users must have - either active,
1.275 raeburn 8848: previous, future, or all.
1.277 albertel 8849: 4. reference to array of permissible roles
1.288 raeburn 8850: 5. reference to array of section restrictions (optional)
8851: 6. reference to results object (hash of hashes).
8852: 7. reference to optional userdata hash
1.609 raeburn 8853: 8. reference to optional statushash
1.630 raeburn 8854: 9. flag if privileged users (except those set to unhide in
8855: course settings) should be excluded
1.609 raeburn 8856: Keys of top level results hash are roles.
1.275 raeburn 8857: Keys of inner hashes are username:domain, with
8858: values set to access type.
1.288 raeburn 8859: Optional userdata hash returns an array with arguments in the
8860: same order as loncoursedata::get_classlist() for student data.
8861:
1.609 raeburn 8862: Optional statushash returns
8863:
1.288 raeburn 8864: Entries for end, start, section and status are blank because
8865: of the possibility of multiple values for non-student roles.
8866:
1.275 raeburn 8867: =cut
1.405 albertel 8868:
1.275 raeburn 8869: ###############################################
1.405 albertel 8870:
1.275 raeburn 8871: sub get_course_users {
1.630 raeburn 8872: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 8873: my %idx = ();
1.419 raeburn 8874: my %seclists;
1.288 raeburn 8875:
8876: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
8877: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
8878: $idx{end} = &Apache::loncoursedata::CL_END();
8879: $idx{start} = &Apache::loncoursedata::CL_START();
8880: $idx{id} = &Apache::loncoursedata::CL_ID();
8881: $idx{section} = &Apache::loncoursedata::CL_SECTION();
8882: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
8883: $idx{status} = &Apache::loncoursedata::CL_STATUS();
8884:
1.290 albertel 8885: if (grep(/^st$/,@{$roles})) {
1.276 albertel 8886: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 8887: my $now = time;
1.277 albertel 8888: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 8889: my $match = 0;
1.412 raeburn 8890: my $secmatch = 0;
1.419 raeburn 8891: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 8892: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 8893: if ($section eq '') {
8894: $section = 'none';
8895: }
1.291 albertel 8896: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 8897: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 8898: $secmatch = 1;
8899: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 8900: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 8901: $secmatch = 1;
8902: }
8903: } else {
1.419 raeburn 8904: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 8905: $secmatch = 1;
8906: }
1.290 albertel 8907: }
1.412 raeburn 8908: if (!$secmatch) {
8909: next;
8910: }
1.419 raeburn 8911: }
1.275 raeburn 8912: if (defined($$types{'active'})) {
1.288 raeburn 8913: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 8914: push(@{$$users{st}{$student}},'active');
1.288 raeburn 8915: $match = 1;
1.275 raeburn 8916: }
8917: }
8918: if (defined($$types{'previous'})) {
1.609 raeburn 8919: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 8920: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 8921: $match = 1;
1.275 raeburn 8922: }
8923: }
8924: if (defined($$types{'future'})) {
1.609 raeburn 8925: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 8926: push(@{$$users{st}{$student}},'future');
1.288 raeburn 8927: $match = 1;
1.275 raeburn 8928: }
8929: }
1.609 raeburn 8930: if ($match) {
8931: push(@{$seclists{$student}},$section);
8932: if (ref($userdata) eq 'HASH') {
8933: $$userdata{$student} = $$classlist{$student};
8934: }
8935: if (ref($statushash) eq 'HASH') {
8936: $statushash->{$student}{'st'}{$section} = $status;
8937: }
1.288 raeburn 8938: }
1.275 raeburn 8939: }
8940: }
1.412 raeburn 8941: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 8942: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8943: my $now = time;
1.609 raeburn 8944: my %displaystatus = ( previous => 'Expired',
8945: active => 'Active',
8946: future => 'Future',
8947: );
1.1121 raeburn 8948: my (%nothide,@possdoms);
1.630 raeburn 8949: if ($hidepriv) {
8950: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
8951: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
8952: if ($user !~ /:/) {
8953: $nothide{join(':',split(/[\@]/,$user))}=1;
8954: } else {
8955: $nothide{$user} = 1;
8956: }
8957: }
1.1121 raeburn 8958: my @possdoms = ($cdom);
8959: if ($coursehash{'checkforpriv'}) {
8960: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
8961: }
1.630 raeburn 8962: }
1.439 raeburn 8963: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 8964: my $match = 0;
1.412 raeburn 8965: my $secmatch = 0;
1.439 raeburn 8966: my $status;
1.412 raeburn 8967: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 8968: $user =~ s/:$//;
1.439 raeburn 8969: my ($end,$start) = split(/:/,$coursepersonnel{$person});
8970: if ($end == -1 || $start == -1) {
8971: next;
8972: }
8973: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
8974: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 8975: my ($uname,$udom) = split(/:/,$user);
8976: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 8977: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 8978: $secmatch = 1;
8979: } elsif ($usec eq '') {
1.420 albertel 8980: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 8981: $secmatch = 1;
8982: }
8983: } else {
8984: if (grep(/^\Q$usec\E$/,@{$sections})) {
8985: $secmatch = 1;
8986: }
8987: }
8988: if (!$secmatch) {
8989: next;
8990: }
1.288 raeburn 8991: }
1.419 raeburn 8992: if ($usec eq '') {
8993: $usec = 'none';
8994: }
1.275 raeburn 8995: if ($uname ne '' && $udom ne '') {
1.630 raeburn 8996: if ($hidepriv) {
1.1121 raeburn 8997: if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630 raeburn 8998: (!$nothide{$uname.':'.$udom})) {
8999: next;
9000: }
9001: }
1.503 raeburn 9002: if ($end > 0 && $end < $now) {
1.439 raeburn 9003: $status = 'previous';
9004: } elsif ($start > $now) {
9005: $status = 'future';
9006: } else {
9007: $status = 'active';
9008: }
1.277 albertel 9009: foreach my $type (keys(%{$types})) {
1.275 raeburn 9010: if ($status eq $type) {
1.420 albertel 9011: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 9012: push(@{$$users{$role}{$user}},$type);
9013: }
1.288 raeburn 9014: $match = 1;
9015: }
9016: }
1.419 raeburn 9017: if (($match) && (ref($userdata) eq 'HASH')) {
9018: if (!exists($$userdata{$uname.':'.$udom})) {
9019: &get_user_info($udom,$uname,\%idx,$userdata);
9020: }
1.420 albertel 9021: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 9022: push(@{$seclists{$uname.':'.$udom}},$usec);
9023: }
1.609 raeburn 9024: if (ref($statushash) eq 'HASH') {
9025: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
9026: }
1.275 raeburn 9027: }
9028: }
9029: }
9030: }
1.290 albertel 9031: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 9032: if ((defined($cdom)) && (defined($cnum))) {
9033: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
9034: if ( defined($csettings{'internal.courseowner'}) ) {
9035: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 9036: next if ($owner eq '');
9037: my ($ownername,$ownerdom);
9038: if ($owner =~ /^([^:]+):([^:]+)$/) {
9039: $ownername = $1;
9040: $ownerdom = $2;
9041: } else {
9042: $ownername = $owner;
9043: $ownerdom = $cdom;
9044: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 9045: }
9046: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 9047: if (defined($userdata) &&
1.609 raeburn 9048: !exists($$userdata{$owner})) {
9049: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
9050: if (!grep(/^none$/,@{$seclists{$owner}})) {
9051: push(@{$seclists{$owner}},'none');
9052: }
9053: if (ref($statushash) eq 'HASH') {
9054: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 9055: }
1.290 albertel 9056: }
1.279 raeburn 9057: }
9058: }
9059: }
1.419 raeburn 9060: foreach my $user (keys(%seclists)) {
9061: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
9062: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
9063: }
1.275 raeburn 9064: }
9065: return;
9066: }
9067:
1.288 raeburn 9068: sub get_user_info {
9069: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 9070: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
9071: &plainname($uname,$udom,'lastname');
1.291 albertel 9072: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 9073: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 9074: my %idhash = &Apache::lonnet::idrget($udom,($uname));
9075: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 9076: return;
9077: }
1.275 raeburn 9078:
1.472 raeburn 9079: ###############################################
9080:
9081: =pod
9082:
9083: =item * &get_user_quota()
9084:
1.1134 raeburn 9085: Retrieves quota assigned for storage of user files.
9086: Default is to report quota for portfolio files.
1.472 raeburn 9087:
9088: Incoming parameters:
9089: 1. user's username
9090: 2. user's domain
1.1134 raeburn 9091: 3. quota name - portfolio, author, or course
1.1136 raeburn 9092: (if no quota name provided, defaults to portfolio).
1.1165 raeburn 9093: 4. crstype - official, unofficial, textbook or community, if quota name is
1.1136 raeburn 9094: course
1.472 raeburn 9095:
9096: Returns:
1.1163 raeburn 9097: 1. Disk quota (in MB) assigned to student.
1.536 raeburn 9098: 2. (Optional) Type of setting: custom or default
9099: (individually assigned or default for user's
9100: institutional status).
9101: 3. (Optional) - User's institutional status (e.g., faculty, staff
9102: or student - types as defined in localenroll::inst_usertypes
9103: for user's domain, which determines default quota for user.
9104: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 9105:
9106: If a value has been stored in the user's environment,
1.536 raeburn 9107: it will return that, otherwise it returns the maximal default
1.1134 raeburn 9108: defined for the user's institutional status(es) in the domain.
1.472 raeburn 9109:
9110: =cut
9111:
9112: ###############################################
9113:
9114:
9115: sub get_user_quota {
1.1136 raeburn 9116: my ($uname,$udom,$quotaname,$crstype) = @_;
1.536 raeburn 9117: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 9118: if (!defined($udom)) {
9119: $udom = $env{'user.domain'};
9120: }
9121: if (!defined($uname)) {
9122: $uname = $env{'user.name'};
9123: }
9124: if (($udom eq '' || $uname eq '') ||
9125: ($udom eq 'public') && ($uname eq 'public')) {
9126: $quota = 0;
1.536 raeburn 9127: $quotatype = 'default';
9128: $defquota = 0;
1.472 raeburn 9129: } else {
1.536 raeburn 9130: my $inststatus;
1.1134 raeburn 9131: if ($quotaname eq 'course') {
9132: if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
9133: ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
9134: $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
9135: } else {
9136: my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
9137: $quota = $cenv{'internal.uploadquota'};
9138: }
1.536 raeburn 9139: } else {
1.1134 raeburn 9140: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
9141: if ($quotaname eq 'author') {
9142: $quota = $env{'environment.authorquota'};
9143: } else {
9144: $quota = $env{'environment.portfolioquota'};
9145: }
9146: $inststatus = $env{'environment.inststatus'};
9147: } else {
9148: my %userenv =
9149: &Apache::lonnet::get('environment',['portfolioquota',
9150: 'authorquota','inststatus'],$udom,$uname);
9151: my ($tmp) = keys(%userenv);
9152: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
9153: if ($quotaname eq 'author') {
9154: $quota = $userenv{'authorquota'};
9155: } else {
9156: $quota = $userenv{'portfolioquota'};
9157: }
9158: $inststatus = $userenv{'inststatus'};
9159: } else {
9160: undef(%userenv);
9161: }
9162: }
9163: }
9164: if ($quota eq '' || wantarray) {
9165: if ($quotaname eq 'course') {
9166: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1165 raeburn 9167: if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
9168: ($crstype eq 'community') || ($crstype eq 'textbook')) {
1.1136 raeburn 9169: $defquota = $domdefs{$crstype.'quota'};
9170: }
9171: if ($defquota eq '') {
9172: $defquota = 500;
9173: }
1.1134 raeburn 9174: } else {
9175: ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
9176: }
9177: if ($quota eq '') {
9178: $quota = $defquota;
9179: $quotatype = 'default';
9180: } else {
9181: $quotatype = 'custom';
9182: }
1.472 raeburn 9183: }
9184: }
1.536 raeburn 9185: if (wantarray) {
9186: return ($quota,$quotatype,$settingstatus,$defquota);
9187: } else {
9188: return $quota;
9189: }
1.472 raeburn 9190: }
9191:
9192: ###############################################
9193:
9194: =pod
9195:
9196: =item * &default_quota()
9197:
1.536 raeburn 9198: Retrieves default quota assigned for storage of user portfolio files,
9199: given an (optional) user's institutional status.
1.472 raeburn 9200:
9201: Incoming parameters:
1.1142 raeburn 9202:
1.472 raeburn 9203: 1. domain
1.536 raeburn 9204: 2. (Optional) institutional status(es). This is a : separated list of
9205: status types (e.g., faculty, staff, student etc.)
9206: which apply to the user for whom the default is being retrieved.
9207: If the institutional status string in undefined, the domain
1.1134 raeburn 9208: default quota will be returned.
9209: 3. quota name - portfolio, author, or course
9210: (if no quota name provided, defaults to portfolio).
1.472 raeburn 9211:
9212: Returns:
1.1142 raeburn 9213:
1.1163 raeburn 9214: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536 raeburn 9215: 2. (Optional) institutional type which determined the value of the
9216: default quota.
1.472 raeburn 9217:
9218: If a value has been stored in the domain's configuration db,
9219: it will return that, otherwise it returns 20 (for backwards
9220: compatibility with domains which have not set up a configuration
1.1163 raeburn 9221: db file; the original statically defined portfolio quota was 20 MB).
1.472 raeburn 9222:
1.536 raeburn 9223: If the user's status includes multiple types (e.g., staff and student),
9224: the largest default quota which applies to the user determines the
9225: default quota returned.
9226:
1.472 raeburn 9227: =cut
9228:
9229: ###############################################
9230:
9231:
9232: sub default_quota {
1.1134 raeburn 9233: my ($udom,$inststatus,$quotaname) = @_;
1.536 raeburn 9234: my ($defquota,$settingstatus);
9235: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 9236: ['quotas'],$udom);
1.1134 raeburn 9237: my $key = 'defaultquota';
9238: if ($quotaname eq 'author') {
9239: $key = 'authorquota';
9240: }
1.622 raeburn 9241: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 9242: if ($inststatus ne '') {
1.765 raeburn 9243: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 9244: foreach my $item (@statuses) {
1.1134 raeburn 9245: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
9246: if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711 raeburn 9247: if ($defquota eq '') {
1.1134 raeburn 9248: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 9249: $settingstatus = $item;
1.1134 raeburn 9250: } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
9251: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 9252: $settingstatus = $item;
9253: }
9254: }
1.1134 raeburn 9255: } elsif ($key eq 'defaultquota') {
1.711 raeburn 9256: if ($quotahash{'quotas'}{$item} ne '') {
9257: if ($defquota eq '') {
9258: $defquota = $quotahash{'quotas'}{$item};
9259: $settingstatus = $item;
9260: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
9261: $defquota = $quotahash{'quotas'}{$item};
9262: $settingstatus = $item;
9263: }
1.536 raeburn 9264: }
9265: }
9266: }
9267: }
9268: if ($defquota eq '') {
1.1134 raeburn 9269: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
9270: $defquota = $quotahash{'quotas'}{$key}{'default'};
9271: } elsif ($key eq 'defaultquota') {
1.711 raeburn 9272: $defquota = $quotahash{'quotas'}{'default'};
9273: }
1.536 raeburn 9274: $settingstatus = 'default';
1.1139 raeburn 9275: if ($defquota eq '') {
9276: if ($quotaname eq 'author') {
9277: $defquota = 500;
9278: }
9279: }
1.536 raeburn 9280: }
9281: } else {
9282: $settingstatus = 'default';
1.1134 raeburn 9283: if ($quotaname eq 'author') {
9284: $defquota = 500;
9285: } else {
9286: $defquota = 20;
9287: }
1.536 raeburn 9288: }
9289: if (wantarray) {
9290: return ($defquota,$settingstatus);
1.472 raeburn 9291: } else {
1.536 raeburn 9292: return $defquota;
1.472 raeburn 9293: }
9294: }
9295:
1.1135 raeburn 9296: ###############################################
9297:
9298: =pod
9299:
1.1136 raeburn 9300: =item * &excess_filesize_warning()
1.1135 raeburn 9301:
9302: Returns warning message if upload of file to authoring space, or copying
1.1136 raeburn 9303: of existing file within authoring space will cause quota for the authoring
1.1146 raeburn 9304: space to be exceeded.
1.1136 raeburn 9305:
9306: Same, if upload of a file directly to a course/community via Course Editor
1.1137 raeburn 9307: will cause quota for uploaded content for the course to be exceeded.
1.1135 raeburn 9308:
1.1165 raeburn 9309: Inputs: 7
1.1136 raeburn 9310: 1. username or coursenum
1.1135 raeburn 9311: 2. domain
1.1136 raeburn 9312: 3. context ('author' or 'course')
1.1135 raeburn 9313: 4. filename of file for which action is being requested
9314: 5. filesize (kB) of file
9315: 6. action being taken: copy or upload.
1.1165 raeburn 9316: 7. quotatype (in course context -- official, unofficial, community or textbook).
1.1135 raeburn 9317:
9318: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
1.1142 raeburn 9319: otherwise return null.
9320:
9321: =back
1.1135 raeburn 9322:
9323: =cut
9324:
1.1136 raeburn 9325: sub excess_filesize_warning {
1.1165 raeburn 9326: my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1136 raeburn 9327: my $current_disk_usage = 0;
1.1165 raeburn 9328: my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1136 raeburn 9329: if ($context eq 'author') {
9330: my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
9331: $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
9332: } else {
9333: foreach my $subdir ('docs','supplemental') {
9334: $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
9335: }
9336: }
1.1135 raeburn 9337: $disk_quota = int($disk_quota * 1000);
9338: if (($current_disk_usage + $filesize) > $disk_quota) {
1.1179 bisitz 9339: return '<p class="LC_warning">'.
1.1135 raeburn 9340: &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1179 bisitz 9341: '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
9342: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1135 raeburn 9343: $disk_quota,$current_disk_usage).
9344: '</p>';
9345: }
9346: return;
9347: }
9348:
9349: ###############################################
9350:
9351:
1.1136 raeburn 9352:
9353:
1.384 raeburn 9354: sub get_secgrprole_info {
9355: my ($cdom,$cnum,$needroles,$type) = @_;
9356: my %sections_count = &get_sections($cdom,$cnum);
9357: my @sections = (sort {$a <=> $b} keys(%sections_count));
9358: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
9359: my @groups = sort(keys(%curr_groups));
9360: my $allroles = [];
9361: my $rolehash;
9362: my $accesshash = {
9363: active => 'Currently has access',
9364: future => 'Will have future access',
9365: previous => 'Previously had access',
9366: };
9367: if ($needroles) {
9368: $rolehash = {'all' => 'all'};
1.385 albertel 9369: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
9370: if (&Apache::lonnet::error(%user_roles)) {
9371: undef(%user_roles);
9372: }
9373: foreach my $item (keys(%user_roles)) {
1.384 raeburn 9374: my ($role)=split(/\:/,$item,2);
9375: if ($role eq 'cr') { next; }
9376: if ($role =~ /^cr/) {
9377: $$rolehash{$role} = (split('/',$role))[3];
9378: } else {
9379: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
9380: }
9381: }
9382: foreach my $key (sort(keys(%{$rolehash}))) {
9383: push(@{$allroles},$key);
9384: }
9385: push (@{$allroles},'st');
9386: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
9387: }
9388: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
9389: }
9390:
1.555 raeburn 9391: sub user_picker {
1.994 raeburn 9392: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context) = @_;
1.555 raeburn 9393: my $currdom = $dom;
9394: my %curr_selected = (
9395: srchin => 'dom',
1.580 raeburn 9396: srchby => 'lastname',
1.555 raeburn 9397: );
9398: my $srchterm;
1.625 raeburn 9399: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 9400: if ($srch->{'srchby'} ne '') {
9401: $curr_selected{'srchby'} = $srch->{'srchby'};
9402: }
9403: if ($srch->{'srchin'} ne '') {
9404: $curr_selected{'srchin'} = $srch->{'srchin'};
9405: }
9406: if ($srch->{'srchtype'} ne '') {
9407: $curr_selected{'srchtype'} = $srch->{'srchtype'};
9408: }
9409: if ($srch->{'srchdomain'} ne '') {
9410: $currdom = $srch->{'srchdomain'};
9411: }
9412: $srchterm = $srch->{'srchterm'};
9413: }
9414: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 9415: 'usr' => 'Search criteria',
1.563 raeburn 9416: 'doma' => 'Domain/institution to search',
1.558 albertel 9417: 'uname' => 'username',
9418: 'lastname' => 'last name',
1.555 raeburn 9419: 'lastfirst' => 'last name, first name',
1.558 albertel 9420: 'crs' => 'in this course',
1.576 raeburn 9421: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 9422: 'alc' => 'all LON-CAPA',
1.573 raeburn 9423: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 9424: 'exact' => 'is',
9425: 'contains' => 'contains',
1.569 raeburn 9426: 'begins' => 'begins with',
1.571 raeburn 9427: 'youm' => "You must include some text to search for.",
9428: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
9429: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
9430: 'yomc' => "You must choose a domain when using an institutional directory search.",
9431: 'ymcd' => "You must choose a domain when using a domain search.",
9432: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
9433: 'whse' => "When searching by last,first you must include at least one character in the first name.",
9434: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 9435: );
1.563 raeburn 9436: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
9437: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 9438:
9439: my @srchins = ('crs','dom','alc','instd');
9440:
9441: foreach my $option (@srchins) {
9442: # FIXME 'alc' option unavailable until
9443: # loncreateuser::print_user_query_page()
9444: # has been completed.
9445: next if ($option eq 'alc');
1.880 raeburn 9446: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 9447: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 9448: if ($curr_selected{'srchin'} eq $option) {
9449: $srchinsel .= '
9450: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
9451: } else {
9452: $srchinsel .= '
9453: <option value="'.$option.'">'.$lt{$option}.'</option>';
9454: }
1.555 raeburn 9455: }
1.563 raeburn 9456: $srchinsel .= "\n </select>\n";
1.555 raeburn 9457:
9458: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 9459: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 9460: if ($curr_selected{'srchby'} eq $option) {
9461: $srchbysel .= '
9462: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
9463: } else {
9464: $srchbysel .= '
9465: <option value="'.$option.'">'.$lt{$option}.'</option>';
9466: }
9467: }
9468: $srchbysel .= "\n </select>\n";
9469:
9470: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 9471: foreach my $option ('begins','contains','exact') {
1.555 raeburn 9472: if ($curr_selected{'srchtype'} eq $option) {
9473: $srchtypesel .= '
9474: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
9475: } else {
9476: $srchtypesel .= '
9477: <option value="'.$option.'">'.$lt{$option}.'</option>';
9478: }
9479: }
9480: $srchtypesel .= "\n </select>\n";
9481:
1.558 albertel 9482: my ($newuserscript,$new_user_create);
1.994 raeburn 9483: my $context_dom = $env{'request.role.domain'};
9484: if ($context eq 'requestcrs') {
9485: if ($env{'form.coursedom'} ne '') {
9486: $context_dom = $env{'form.coursedom'};
9487: }
9488: }
1.556 raeburn 9489: if ($forcenewuser) {
1.576 raeburn 9490: if (ref($srch) eq 'HASH') {
1.994 raeburn 9491: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 9492: if ($cancreate) {
9493: $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>';
9494: } else {
1.799 bisitz 9495: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 9496: my %usertypetext = (
9497: official => 'institutional',
9498: unofficial => 'non-institutional',
9499: );
1.799 bisitz 9500: $new_user_create = '<p class="LC_warning">'
9501: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
9502: .' '
9503: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
9504: ,'<a href="'.$helplink.'">','</a>')
9505: .'</p><br />';
1.627 raeburn 9506: }
1.576 raeburn 9507: }
9508: }
9509:
1.556 raeburn 9510: $newuserscript = <<"ENDSCRIPT";
9511:
1.570 raeburn 9512: function setSearch(createnew,callingForm) {
1.556 raeburn 9513: if (createnew == 1) {
1.570 raeburn 9514: for (var i=0; i<callingForm.srchby.length; i++) {
9515: if (callingForm.srchby.options[i].value == 'uname') {
9516: callingForm.srchby.selectedIndex = i;
1.556 raeburn 9517: }
9518: }
1.570 raeburn 9519: for (var i=0; i<callingForm.srchin.length; i++) {
9520: if ( callingForm.srchin.options[i].value == 'dom') {
9521: callingForm.srchin.selectedIndex = i;
1.556 raeburn 9522: }
9523: }
1.570 raeburn 9524: for (var i=0; i<callingForm.srchtype.length; i++) {
9525: if (callingForm.srchtype.options[i].value == 'exact') {
9526: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 9527: }
9528: }
1.570 raeburn 9529: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 9530: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 9531: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 9532: }
9533: }
9534: }
9535: }
9536: ENDSCRIPT
1.558 albertel 9537:
1.556 raeburn 9538: }
9539:
1.555 raeburn 9540: my $output = <<"END_BLOCK";
1.556 raeburn 9541: <script type="text/javascript">
1.824 bisitz 9542: // <![CDATA[
1.570 raeburn 9543: function validateEntry(callingForm) {
1.558 albertel 9544:
1.556 raeburn 9545: var checkok = 1;
1.558 albertel 9546: var srchin;
1.570 raeburn 9547: for (var i=0; i<callingForm.srchin.length; i++) {
9548: if ( callingForm.srchin[i].checked ) {
9549: srchin = callingForm.srchin[i].value;
1.558 albertel 9550: }
9551: }
9552:
1.570 raeburn 9553: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
9554: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
9555: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
9556: var srchterm = callingForm.srchterm.value;
9557: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 9558: var msg = "";
9559:
9560: if (srchterm == "") {
9561: checkok = 0;
1.571 raeburn 9562: msg += "$lt{'youm'}\\n";
1.556 raeburn 9563: }
9564:
1.569 raeburn 9565: if (srchtype== 'begins') {
9566: if (srchterm.length < 2) {
9567: checkok = 0;
1.571 raeburn 9568: msg += "$lt{'thte'}\\n";
1.569 raeburn 9569: }
9570: }
9571:
1.556 raeburn 9572: if (srchtype== 'contains') {
9573: if (srchterm.length < 3) {
9574: checkok = 0;
1.571 raeburn 9575: msg += "$lt{'thet'}\\n";
1.556 raeburn 9576: }
9577: }
9578: if (srchin == 'instd') {
9579: if (srchdomain == '') {
9580: checkok = 0;
1.571 raeburn 9581: msg += "$lt{'yomc'}\\n";
1.556 raeburn 9582: }
9583: }
9584: if (srchin == 'dom') {
9585: if (srchdomain == '') {
9586: checkok = 0;
1.571 raeburn 9587: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 9588: }
9589: }
9590: if (srchby == 'lastfirst') {
9591: if (srchterm.indexOf(",") == -1) {
9592: checkok = 0;
1.571 raeburn 9593: msg += "$lt{'whus'}\\n";
1.556 raeburn 9594: }
9595: if (srchterm.indexOf(",") == srchterm.length -1) {
9596: checkok = 0;
1.571 raeburn 9597: msg += "$lt{'whse'}\\n";
1.556 raeburn 9598: }
9599: }
9600: if (checkok == 0) {
1.571 raeburn 9601: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 9602: return;
9603: }
9604: if (checkok == 1) {
1.570 raeburn 9605: callingForm.submit();
1.556 raeburn 9606: }
9607: }
9608:
9609: $newuserscript
9610:
1.824 bisitz 9611: // ]]>
1.556 raeburn 9612: </script>
1.558 albertel 9613:
9614: $new_user_create
9615:
1.555 raeburn 9616: END_BLOCK
1.558 albertel 9617:
1.876 raeburn 9618: $output .= &Apache::lonhtmlcommon::start_pick_box().
9619: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
9620: $domform.
9621: &Apache::lonhtmlcommon::row_closure().
9622: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
9623: $srchbysel.
9624: $srchtypesel.
9625: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
9626: $srchinsel.
9627: &Apache::lonhtmlcommon::row_closure(1).
9628: &Apache::lonhtmlcommon::end_pick_box().
9629: '<br />';
1.555 raeburn 9630: return $output;
9631: }
9632:
1.612 raeburn 9633: sub user_rule_check {
1.615 raeburn 9634: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 9635: my $response;
9636: if (ref($usershash) eq 'HASH') {
9637: foreach my $user (keys(%{$usershash})) {
9638: my ($uname,$udom) = split(/:/,$user);
9639: next if ($udom eq '' || $uname eq '');
1.615 raeburn 9640: my ($id,$newuser);
1.612 raeburn 9641: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 9642: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 9643: $id = $usershash->{$user}->{'id'};
9644: }
9645: my $inst_response;
9646: if (ref($checks) eq 'HASH') {
9647: if (defined($checks->{'username'})) {
1.615 raeburn 9648: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 9649: &Apache::lonnet::get_instuser($udom,$uname);
9650: } elsif (defined($checks->{'id'})) {
1.615 raeburn 9651: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 9652: &Apache::lonnet::get_instuser($udom,undef,$id);
9653: }
1.615 raeburn 9654: } else {
9655: ($inst_response,%{$inst_results->{$user}}) =
9656: &Apache::lonnet::get_instuser($udom,$uname);
9657: return;
1.612 raeburn 9658: }
1.615 raeburn 9659: if (!$got_rules->{$udom}) {
1.612 raeburn 9660: my %domconfig = &Apache::lonnet::get_dom('configuration',
9661: ['usercreation'],$udom);
9662: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 9663: foreach my $item ('username','id') {
1.612 raeburn 9664: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
9665: $$curr_rules{$udom}{$item} =
9666: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 9667: }
9668: }
9669: }
1.615 raeburn 9670: $got_rules->{$udom} = 1;
1.585 raeburn 9671: }
1.612 raeburn 9672: foreach my $item (keys(%{$checks})) {
9673: if (ref($$curr_rules{$udom}) eq 'HASH') {
9674: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
9675: if (@{$$curr_rules{$udom}{$item}} > 0) {
9676: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
9677: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
9678: if ($rule_check{$rule}) {
9679: $$rulematch{$user}{$item} = $rule;
9680: if ($inst_response eq 'ok') {
1.615 raeburn 9681: if (ref($inst_results) eq 'HASH') {
9682: if (ref($inst_results->{$user}) eq 'HASH') {
9683: if (keys(%{$inst_results->{$user}}) == 0) {
9684: $$alerts{$item}{$udom}{$uname} = 1;
9685: }
1.612 raeburn 9686: }
9687: }
1.615 raeburn 9688: }
9689: last;
1.585 raeburn 9690: }
9691: }
9692: }
9693: }
9694: }
9695: }
9696: }
9697: }
1.612 raeburn 9698: return;
9699: }
9700:
9701: sub user_rule_formats {
9702: my ($domain,$domdesc,$curr_rules,$check) = @_;
9703: my %text = (
9704: 'username' => 'Usernames',
9705: 'id' => 'IDs',
9706: );
9707: my $output;
9708: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
9709: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
9710: if (@{$ruleorder} > 0) {
1.1102 raeburn 9711: $output = '<br />'.
9712: &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
9713: '<span class="LC_cusr_emph">','</span>',$domdesc).
9714: ' <ul>';
1.612 raeburn 9715: foreach my $rule (@{$ruleorder}) {
9716: if (ref($curr_rules) eq 'ARRAY') {
9717: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
9718: if (ref($rules->{$rule}) eq 'HASH') {
9719: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
9720: $rules->{$rule}{'desc'}.'</li>';
9721: }
9722: }
9723: }
9724: }
9725: $output .= '</ul>';
9726: }
9727: }
9728: return $output;
9729: }
9730:
9731: sub instrule_disallow_msg {
1.615 raeburn 9732: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 9733: my $response;
9734: my %text = (
9735: item => 'username',
9736: items => 'usernames',
9737: match => 'matches',
9738: do => 'does',
9739: action => 'a username',
9740: one => 'one',
9741: );
9742: if ($count > 1) {
9743: $text{'item'} = 'usernames';
9744: $text{'match'} ='match';
9745: $text{'do'} = 'do';
9746: $text{'action'} = 'usernames',
9747: $text{'one'} = 'ones';
9748: }
9749: if ($checkitem eq 'id') {
9750: $text{'items'} = 'IDs';
9751: $text{'item'} = 'ID';
9752: $text{'action'} = 'an ID';
1.615 raeburn 9753: if ($count > 1) {
9754: $text{'item'} = 'IDs';
9755: $text{'action'} = 'IDs';
9756: }
1.612 raeburn 9757: }
1.674 bisitz 9758: $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 9759: if ($mode eq 'upload') {
9760: if ($checkitem eq 'username') {
9761: $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'}.");
9762: } elsif ($checkitem eq 'id') {
1.674 bisitz 9763: $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 9764: }
1.669 raeburn 9765: } elsif ($mode eq 'selfcreate') {
9766: if ($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.615 raeburn 9769: } else {
9770: if ($checkitem eq 'username') {
9771: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
9772: } elsif ($checkitem eq 'id') {
9773: $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.");
9774: }
1.612 raeburn 9775: }
9776: return $response;
1.585 raeburn 9777: }
9778:
1.624 raeburn 9779: sub personal_data_fieldtitles {
9780: my %fieldtitles = &Apache::lonlocal::texthash (
9781: id => 'Student/Employee ID',
9782: permanentemail => 'E-mail address',
9783: lastname => 'Last Name',
9784: firstname => 'First Name',
9785: middlename => 'Middle Name',
9786: generation => 'Generation',
9787: gen => 'Generation',
1.765 raeburn 9788: inststatus => 'Affiliation',
1.624 raeburn 9789: );
9790: return %fieldtitles;
9791: }
9792:
1.642 raeburn 9793: sub sorted_inst_types {
9794: my ($dom) = @_;
1.1185 raeburn 9795: my ($usertypes,$order);
9796: my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
9797: if (ref($domdefaults{'inststatus'}) eq 'HASH') {
9798: $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
9799: $order = $domdefaults{'inststatus'}{'inststatusorder'};
9800: } else {
9801: ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
9802: }
1.642 raeburn 9803: my $othertitle = &mt('All users');
9804: if ($env{'request.course.id'}) {
1.668 raeburn 9805: $othertitle = &mt('Any users');
1.642 raeburn 9806: }
9807: my @types;
9808: if (ref($order) eq 'ARRAY') {
9809: @types = @{$order};
9810: }
9811: if (@types == 0) {
9812: if (ref($usertypes) eq 'HASH') {
9813: @types = sort(keys(%{$usertypes}));
9814: }
9815: }
9816: if (keys(%{$usertypes}) > 0) {
9817: $othertitle = &mt('Other users');
9818: }
9819: return ($othertitle,$usertypes,\@types);
9820: }
9821:
1.645 raeburn 9822: sub get_institutional_codes {
9823: my ($settings,$allcourses,$LC_code) = @_;
9824: # Get complete list of course sections to update
9825: my @currsections = ();
9826: my @currxlists = ();
9827: my $coursecode = $$settings{'internal.coursecode'};
9828:
9829: if ($$settings{'internal.sectionnums'} ne '') {
9830: @currsections = split(/,/,$$settings{'internal.sectionnums'});
9831: }
9832:
9833: if ($$settings{'internal.crosslistings'} ne '') {
9834: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
9835: }
9836:
9837: if (@currxlists > 0) {
9838: foreach (@currxlists) {
9839: if (m/^([^:]+):(\w*)$/) {
9840: unless (grep/^$1$/,@{$allcourses}) {
9841: push @{$allcourses},$1;
9842: $$LC_code{$1} = $2;
9843: }
9844: }
9845: }
9846: }
9847:
9848: if (@currsections > 0) {
9849: foreach (@currsections) {
9850: if (m/^(\w+):(\w*)$/) {
9851: my $sec = $coursecode.$1;
9852: my $lc_sec = $2;
9853: unless (grep/^$sec$/,@{$allcourses}) {
9854: push @{$allcourses},$sec;
9855: $$LC_code{$sec} = $lc_sec;
9856: }
9857: }
9858: }
9859: }
9860: return;
9861: }
9862:
1.971 raeburn 9863: sub get_standard_codeitems {
9864: return ('Year','Semester','Department','Number','Section');
9865: }
9866:
1.112 bowersj2 9867: =pod
9868:
1.780 raeburn 9869: =head1 Slot Helpers
9870:
9871: =over 4
9872:
9873: =item * sorted_slots()
9874:
1.1040 raeburn 9875: Sorts an array of slot names in order of an optional sort key,
9876: default sort is by slot start time (earliest first).
1.780 raeburn 9877:
9878: Inputs:
9879:
9880: =over 4
9881:
9882: slotsarr - Reference to array of unsorted slot names.
9883:
9884: slots - Reference to hash of hash, where outer hash keys are slot names.
9885:
1.1040 raeburn 9886: sortkey - Name of key in inner hash to be sorted on (e.g., starttime).
9887:
1.549 albertel 9888: =back
9889:
1.780 raeburn 9890: Returns:
9891:
9892: =over 4
9893:
1.1040 raeburn 9894: sorted - An array of slot names sorted by a specified sort key
9895: (default sort key is start time of the slot).
1.780 raeburn 9896:
9897: =back
9898:
9899: =cut
9900:
9901:
9902: sub sorted_slots {
1.1040 raeburn 9903: my ($slotsarr,$slots,$sortkey) = @_;
9904: if ($sortkey eq '') {
9905: $sortkey = 'starttime';
9906: }
1.780 raeburn 9907: my @sorted;
9908: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
9909: @sorted =
9910: sort {
9911: if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040 raeburn 9912: return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780 raeburn 9913: }
9914: if (ref($slots->{$a})) { return -1;}
9915: if (ref($slots->{$b})) { return 1;}
9916: return 0;
9917: } @{$slotsarr};
9918: }
9919: return @sorted;
9920: }
9921:
1.1040 raeburn 9922: =pod
9923:
9924: =item * get_future_slots()
9925:
9926: Inputs:
9927:
9928: =over 4
9929:
9930: cnum - course number
9931:
9932: cdom - course domain
9933:
9934: now - current UNIX time
9935:
9936: symb - optional symb
9937:
9938: =back
9939:
9940: Returns:
9941:
9942: =over 4
9943:
9944: sorted_reservable - ref to array of student_schedulable slots currently
9945: reservable, ordered by end date of reservation period.
9946:
9947: reservable_now - ref to hash of student_schedulable slots currently
9948: reservable.
9949:
9950: Keys in inner hash are:
9951: (a) symb: either blank or symb to which slot use is restricted.
9952: (b) endreserve: end date of reservation period.
9953:
9954: sorted_future - ref to array of student_schedulable slots reservable in
9955: the future, ordered by start date of reservation period.
9956:
9957: future_reservable - ref to hash of student_schedulable slots reservable
9958: in the future.
9959:
9960: Keys in inner hash are:
9961: (a) symb: either blank or symb to which slot use is restricted.
9962: (b) startreserve: start date of reservation period.
9963:
9964: =back
9965:
9966: =cut
9967:
9968: sub get_future_slots {
9969: my ($cnum,$cdom,$now,$symb) = @_;
9970: my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
9971: my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
9972: foreach my $slot (keys(%slots)) {
9973: next unless($slots{$slot}->{'type'} eq 'schedulable_student');
9974: if ($symb) {
9975: next if (($slots{$slot}->{'symb'} ne '') &&
9976: ($slots{$slot}->{'symb'} ne $symb));
9977: }
9978: if (($slots{$slot}->{'starttime'} > $now) &&
9979: ($slots{$slot}->{'endtime'} > $now)) {
9980: if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
9981: my $userallowed = 0;
9982: if ($slots{$slot}->{'allowedsections'}) {
9983: my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
9984: if (!defined($env{'request.role.sec'})
9985: && grep(/^No section assigned$/,@allowed_sec)) {
9986: $userallowed=1;
9987: } else {
9988: if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
9989: $userallowed=1;
9990: }
9991: }
9992: unless ($userallowed) {
9993: if (defined($env{'request.course.groups'})) {
9994: my @groups = split(/:/,$env{'request.course.groups'});
9995: foreach my $group (@groups) {
9996: if (grep(/^\Q$group\E$/,@allowed_sec)) {
9997: $userallowed=1;
9998: last;
9999: }
10000: }
10001: }
10002: }
10003: }
10004: if ($slots{$slot}->{'allowedusers'}) {
10005: my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
10006: my $user = $env{'user.name'}.':'.$env{'user.domain'};
10007: if (grep(/^\Q$user\E$/,@allowed_users)) {
10008: $userallowed = 1;
10009: }
10010: }
10011: next unless($userallowed);
10012: }
10013: my $startreserve = $slots{$slot}->{'startreserve'};
10014: my $endreserve = $slots{$slot}->{'endreserve'};
10015: my $symb = $slots{$slot}->{'symb'};
10016: if (($startreserve < $now) &&
10017: (!$endreserve || $endreserve > $now)) {
10018: my $lastres = $endreserve;
10019: if (!$lastres) {
10020: $lastres = $slots{$slot}->{'starttime'};
10021: }
10022: $reservable_now{$slot} = {
10023: symb => $symb,
10024: endreserve => $lastres
10025: };
10026: } elsif (($startreserve > $now) &&
10027: (!$endreserve || $endreserve > $startreserve)) {
10028: $future_reservable{$slot} = {
10029: symb => $symb,
10030: startreserve => $startreserve
10031: };
10032: }
10033: }
10034: }
10035: my @unsorted_reservable = keys(%reservable_now);
10036: if (@unsorted_reservable > 0) {
10037: @sorted_reservable =
10038: &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
10039: }
10040: my @unsorted_future = keys(%future_reservable);
10041: if (@unsorted_future > 0) {
10042: @sorted_future =
10043: &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
10044: }
10045: return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
10046: }
1.780 raeburn 10047:
10048: =pod
10049:
1.1057 foxr 10050: =back
10051:
1.549 albertel 10052: =head1 HTTP Helpers
10053:
10054: =over 4
10055:
1.648 raeburn 10056: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 10057:
1.258 albertel 10058: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 10059: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 10060: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 10061:
10062: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
10063: $possible_names is an ref to an array of form element names. As an example:
10064: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 10065: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 10066:
10067: =cut
1.1 albertel 10068:
1.6 albertel 10069: sub get_unprocessed_cgi {
1.25 albertel 10070: my ($query,$possible_names)= @_;
1.26 matthew 10071: # $Apache::lonxml::debug=1;
1.356 albertel 10072: foreach my $pair (split(/&/,$query)) {
10073: my ($name, $value) = split(/=/,$pair);
1.369 www 10074: $name = &unescape($name);
1.25 albertel 10075: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
10076: $value =~ tr/+/ /;
10077: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 10078: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 10079: }
1.16 harris41 10080: }
1.6 albertel 10081: }
10082:
1.112 bowersj2 10083: =pod
10084:
1.648 raeburn 10085: =item * &cacheheader()
1.112 bowersj2 10086:
10087: returns cache-controlling header code
10088:
10089: =cut
10090:
1.7 albertel 10091: sub cacheheader {
1.258 albertel 10092: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 10093: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
10094: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 10095: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
10096: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 10097: return $output;
1.7 albertel 10098: }
10099:
1.112 bowersj2 10100: =pod
10101:
1.648 raeburn 10102: =item * &no_cache($r)
1.112 bowersj2 10103:
10104: specifies header code to not have cache
10105:
10106: =cut
10107:
1.9 albertel 10108: sub no_cache {
1.216 albertel 10109: my ($r) = @_;
10110: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 10111: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 10112: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
10113: $r->no_cache(1);
10114: $r->header_out("Expires" => $date);
10115: $r->header_out("Pragma" => "no-cache");
1.123 www 10116: }
10117:
10118: sub content_type {
1.181 albertel 10119: my ($r,$type,$charset) = @_;
1.299 foxr 10120: if ($r) {
10121: # Note that printout.pl calls this with undef for $r.
10122: &no_cache($r);
10123: }
1.258 albertel 10124: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 10125: unless ($charset) {
10126: $charset=&Apache::lonlocal::current_encoding;
10127: }
10128: if ($charset) { $type.='; charset='.$charset; }
10129: if ($r) {
10130: $r->content_type($type);
10131: } else {
10132: print("Content-type: $type\n\n");
10133: }
1.9 albertel 10134: }
1.25 albertel 10135:
1.112 bowersj2 10136: =pod
10137:
1.648 raeburn 10138: =item * &add_to_env($name,$value)
1.112 bowersj2 10139:
1.258 albertel 10140: adds $name to the %env hash with value
1.112 bowersj2 10141: $value, if $name already exists, the entry is converted to an array
10142: reference and $value is added to the array.
10143:
10144: =cut
10145:
1.25 albertel 10146: sub add_to_env {
10147: my ($name,$value)=@_;
1.258 albertel 10148: if (defined($env{$name})) {
10149: if (ref($env{$name})) {
1.25 albertel 10150: #already have multiple values
1.258 albertel 10151: push(@{ $env{$name} },$value);
1.25 albertel 10152: } else {
10153: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 10154: my $first=$env{$name};
10155: undef($env{$name});
10156: push(@{ $env{$name} },$first,$value);
1.25 albertel 10157: }
10158: } else {
1.258 albertel 10159: $env{$name}=$value;
1.25 albertel 10160: }
1.31 albertel 10161: }
1.149 albertel 10162:
10163: =pod
10164:
1.648 raeburn 10165: =item * &get_env_multiple($name)
1.149 albertel 10166:
1.258 albertel 10167: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 10168: values may be defined and end up as an array ref.
10169:
10170: returns an array of values
10171:
10172: =cut
10173:
10174: sub get_env_multiple {
10175: my ($name) = @_;
10176: my @values;
1.258 albertel 10177: if (defined($env{$name})) {
1.149 albertel 10178: # exists is it an array
1.258 albertel 10179: if (ref($env{$name})) {
10180: @values=@{ $env{$name} };
1.149 albertel 10181: } else {
1.258 albertel 10182: $values[0]=$env{$name};
1.149 albertel 10183: }
10184: }
10185: return(@values);
10186: }
10187:
1.660 raeburn 10188: sub ask_for_embedded_content {
10189: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071 raeburn 10190: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1085 raeburn 10191: %currsubfile,%unused,$rem);
1.1071 raeburn 10192: my $counter = 0;
10193: my $numnew = 0;
1.987 raeburn 10194: my $numremref = 0;
10195: my $numinvalid = 0;
10196: my $numpathchg = 0;
10197: my $numexisting = 0;
1.1071 raeburn 10198: my $numunused = 0;
10199: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1156 raeburn 10200: $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071 raeburn 10201: my $heading = &mt('Upload embedded files');
10202: my $buttontext = &mt('Upload');
10203:
1.1085 raeburn 10204: if ($env{'request.course.id'}) {
1.1123 raeburn 10205: if ($actionurl eq '/adm/dependencies') {
10206: $navmap = Apache::lonnavmaps::navmap->new();
10207: }
10208: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10209: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1085 raeburn 10210: }
1.1123 raeburn 10211: if (($actionurl eq '/adm/portfolio') ||
10212: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984 raeburn 10213: my $current_path='/';
10214: if ($env{'form.currentpath'}) {
10215: $current_path = $env{'form.currentpath'};
10216: }
10217: if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1123 raeburn 10218: $udom = $cdom;
10219: $uname = $cnum;
1.984 raeburn 10220: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
10221: } else {
10222: $udom = $env{'user.domain'};
10223: $uname = $env{'user.name'};
10224: $url = '/userfiles/portfolio';
10225: }
1.987 raeburn 10226: $toplevel = $url.'/';
1.984 raeburn 10227: $url .= $current_path;
10228: $getpropath = 1;
1.987 raeburn 10229: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
10230: ($actionurl eq '/adm/imsimport')) {
1.1022 www 10231: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026 raeburn 10232: $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987 raeburn 10233: $toplevel = $url;
1.984 raeburn 10234: if ($rest ne '') {
1.987 raeburn 10235: $url .= $rest;
10236: }
10237: } elsif ($actionurl eq '/adm/coursedocs') {
10238: if (ref($args) eq 'HASH') {
1.1071 raeburn 10239: $url = $args->{'docs_url'};
10240: $toplevel = $url;
1.1084 raeburn 10241: if ($args->{'context'} eq 'paste') {
10242: ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
10243: ($path) =
10244: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
10245: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
10246: $fileloc =~ s{^/}{};
10247: }
1.1071 raeburn 10248: }
1.1084 raeburn 10249: } elsif ($actionurl eq '/adm/dependencies') {
1.1071 raeburn 10250: if ($env{'request.course.id'} ne '') {
10251: if (ref($args) eq 'HASH') {
10252: $url = $args->{'docs_url'};
10253: $title = $args->{'docs_title'};
1.1126 raeburn 10254: $toplevel = $url;
10255: unless ($toplevel =~ m{^/}) {
10256: $toplevel = "/$url";
10257: }
1.1085 raeburn 10258: ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1126 raeburn 10259: if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
10260: $path = $1;
10261: } else {
10262: ($path) =
10263: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
10264: }
1.1195 raeburn 10265: if ($toplevel=~/^\/*(uploaded|editupload)/) {
10266: $fileloc = $toplevel;
10267: $fileloc=~ s/^\s*(\S+)\s*$/$1/;
10268: my ($udom,$uname,$fname) =
10269: ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
10270: $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
10271: } else {
10272: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
10273: }
1.1071 raeburn 10274: $fileloc =~ s{^/}{};
10275: ($filename) = ($fileloc =~ m{.+/([^/]+)$});
10276: $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
10277: }
1.987 raeburn 10278: }
1.1123 raeburn 10279: } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
10280: $udom = $cdom;
10281: $uname = $cnum;
10282: $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
10283: $toplevel = $url;
10284: $path = $url;
10285: $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
10286: $fileloc =~ s{^/}{};
1.987 raeburn 10287: }
1.1126 raeburn 10288: foreach my $file (keys(%{$allfiles})) {
10289: my $embed_file;
10290: if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
10291: $embed_file = $1;
10292: } else {
10293: $embed_file = $file;
10294: }
1.1158 raeburn 10295: my ($absolutepath,$cleaned_file);
10296: if ($embed_file =~ m{^\w+://}) {
10297: $cleaned_file = $embed_file;
1.1147 raeburn 10298: $newfiles{$cleaned_file} = 1;
10299: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 10300: } else {
1.1158 raeburn 10301: $cleaned_file = &clean_path($embed_file);
1.987 raeburn 10302: if ($embed_file =~ m{^/}) {
10303: $absolutepath = $embed_file;
10304: }
1.1147 raeburn 10305: if ($cleaned_file =~ m{/}) {
10306: my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987 raeburn 10307: $path = &check_for_traversal($path,$url,$toplevel);
10308: my $item = $fname;
10309: if ($path ne '') {
10310: $item = $path.'/'.$fname;
10311: $subdependencies{$path}{$fname} = 1;
10312: } else {
10313: $dependencies{$item} = 1;
10314: }
10315: if ($absolutepath) {
10316: $mapping{$item} = $absolutepath;
10317: } else {
10318: $mapping{$item} = $embed_file;
10319: }
10320: } else {
10321: $dependencies{$embed_file} = 1;
10322: if ($absolutepath) {
1.1147 raeburn 10323: $mapping{$cleaned_file} = $absolutepath;
1.987 raeburn 10324: } else {
1.1147 raeburn 10325: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 10326: }
10327: }
1.984 raeburn 10328: }
10329: }
1.1071 raeburn 10330: my $dirptr = 16384;
1.984 raeburn 10331: foreach my $path (keys(%subdependencies)) {
1.1071 raeburn 10332: $currsubfile{$path} = {};
1.1123 raeburn 10333: if (($actionurl eq '/adm/portfolio') ||
10334: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 10335: my ($sublistref,$listerror) =
10336: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
10337: if (ref($sublistref) eq 'ARRAY') {
10338: foreach my $line (@{$sublistref}) {
10339: my ($file_name,$rest) = split(/\&/,$line,2);
1.1071 raeburn 10340: $currsubfile{$path}{$file_name} = 1;
1.1021 raeburn 10341: }
1.984 raeburn 10342: }
1.987 raeburn 10343: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 10344: if (opendir(my $dir,$url.'/'.$path)) {
10345: my @subdir_list = grep(!/^\./,readdir($dir));
1.1071 raeburn 10346: map {$currsubfile{$path}{$_} = 1;} @subdir_list;
10347: }
1.1084 raeburn 10348: } elsif (($actionurl eq '/adm/dependencies') ||
10349: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 10350: ($args->{'context'} eq 'paste')) ||
10351: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 10352: if ($env{'request.course.id'} ne '') {
1.1123 raeburn 10353: my $dir;
10354: if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
10355: $dir = $fileloc;
10356: } else {
10357: ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
10358: }
1.1071 raeburn 10359: if ($dir ne '') {
10360: my ($sublistref,$listerror) =
10361: &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
10362: if (ref($sublistref) eq 'ARRAY') {
10363: foreach my $line (@{$sublistref}) {
10364: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
10365: undef,$mtime)=split(/\&/,$line,12);
10366: unless (($testdir&$dirptr) ||
10367: ($file_name =~ /^\.\.?$/)) {
10368: $currsubfile{$path}{$file_name} = [$size,$mtime];
10369: }
10370: }
10371: }
10372: }
1.984 raeburn 10373: }
10374: }
10375: foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071 raeburn 10376: if (exists($currsubfile{$path}{$file})) {
1.987 raeburn 10377: my $item = $path.'/'.$file;
10378: unless ($mapping{$item} eq $item) {
10379: $pathchanges{$item} = 1;
10380: }
10381: $existing{$item} = 1;
10382: $numexisting ++;
10383: } else {
10384: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 10385: }
10386: }
1.1071 raeburn 10387: if ($actionurl eq '/adm/dependencies') {
10388: foreach my $path (keys(%currsubfile)) {
10389: if (ref($currsubfile{$path}) eq 'HASH') {
10390: foreach my $file (keys(%{$currsubfile{$path}})) {
10391: unless ($subdependencies{$path}{$file}) {
1.1085 raeburn 10392: next if (($rem ne '') &&
10393: (($env{"httpref.$rem"."$path/$file"} ne '') ||
10394: (ref($navmap) &&
10395: (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
10396: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
10397: ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071 raeburn 10398: $unused{$path.'/'.$file} = 1;
10399: }
10400: }
10401: }
10402: }
10403: }
1.984 raeburn 10404: }
1.987 raeburn 10405: my %currfile;
1.1123 raeburn 10406: if (($actionurl eq '/adm/portfolio') ||
10407: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 10408: my ($dirlistref,$listerror) =
10409: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
10410: if (ref($dirlistref) eq 'ARRAY') {
10411: foreach my $line (@{$dirlistref}) {
10412: my ($file_name,$rest) = split(/\&/,$line,2);
10413: $currfile{$file_name} = 1;
10414: }
1.984 raeburn 10415: }
1.987 raeburn 10416: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 10417: if (opendir(my $dir,$url)) {
1.987 raeburn 10418: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 10419: map {$currfile{$_} = 1;} @dir_list;
10420: }
1.1084 raeburn 10421: } elsif (($actionurl eq '/adm/dependencies') ||
10422: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 10423: ($args->{'context'} eq 'paste')) ||
10424: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 10425: if ($env{'request.course.id'} ne '') {
10426: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
10427: if ($dir ne '') {
10428: my ($dirlistref,$listerror) =
10429: &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
10430: if (ref($dirlistref) eq 'ARRAY') {
10431: foreach my $line (@{$dirlistref}) {
10432: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
10433: $size,undef,$mtime)=split(/\&/,$line,12);
10434: unless (($testdir&$dirptr) ||
10435: ($file_name =~ /^\.\.?$/)) {
10436: $currfile{$file_name} = [$size,$mtime];
10437: }
10438: }
10439: }
10440: }
10441: }
1.984 raeburn 10442: }
10443: foreach my $file (keys(%dependencies)) {
1.1071 raeburn 10444: if (exists($currfile{$file})) {
1.987 raeburn 10445: unless ($mapping{$file} eq $file) {
10446: $pathchanges{$file} = 1;
10447: }
10448: $existing{$file} = 1;
10449: $numexisting ++;
10450: } else {
1.984 raeburn 10451: $newfiles{$file} = 1;
10452: }
10453: }
1.1071 raeburn 10454: foreach my $file (keys(%currfile)) {
10455: unless (($file eq $filename) ||
10456: ($file eq $filename.'.bak') ||
10457: ($dependencies{$file})) {
1.1085 raeburn 10458: if ($actionurl eq '/adm/dependencies') {
1.1126 raeburn 10459: unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
10460: next if (($rem ne '') &&
10461: (($env{"httpref.$rem".$file} ne '') ||
10462: (ref($navmap) &&
10463: (($navmap->getResourceByUrl($rem.$file) ne '') ||
10464: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
10465: ($navmap->getResourceByUrl($rem.$1)))))));
10466: }
1.1085 raeburn 10467: }
1.1071 raeburn 10468: $unused{$file} = 1;
10469: }
10470: }
1.1084 raeburn 10471: if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
10472: ($args->{'context'} eq 'paste')) {
10473: $counter = scalar(keys(%existing));
10474: $numpathchg = scalar(keys(%pathchanges));
1.1123 raeburn 10475: return ($output,$counter,$numpathchg,\%existing);
10476: } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
10477: (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
10478: $counter = scalar(keys(%existing));
10479: $numpathchg = scalar(keys(%pathchanges));
10480: return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1084 raeburn 10481: }
1.984 raeburn 10482: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071 raeburn 10483: if ($actionurl eq '/adm/dependencies') {
10484: next if ($embed_file =~ m{^\w+://});
10485: }
1.660 raeburn 10486: $upload_output .= &start_data_table_row().
1.1123 raeburn 10487: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
1.1071 raeburn 10488: '<span class="LC_filename">'.$embed_file.'</span>';
1.987 raeburn 10489: unless ($mapping{$embed_file} eq $embed_file) {
1.1123 raeburn 10490: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
10491: &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987 raeburn 10492: }
1.1123 raeburn 10493: $upload_output .= '</td>';
1.1071 raeburn 10494: if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) {
1.1123 raeburn 10495: $upload_output.='<td align="right">'.
10496: '<span class="LC_info LC_fontsize_medium">'.
10497: &mt("URL points to web address").'</span>';
1.987 raeburn 10498: $numremref++;
1.660 raeburn 10499: } elsif ($args->{'error_on_invalid_names'}
10500: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1123 raeburn 10501: $upload_output.='<td align="right"><span class="LC_warning">'.
10502: &mt('Invalid characters').'</span>';
1.987 raeburn 10503: $numinvalid++;
1.660 raeburn 10504: } else {
1.1123 raeburn 10505: $upload_output .= '<td>'.
10506: &embedded_file_element('upload_embedded',$counter,
1.987 raeburn 10507: $embed_file,\%mapping,
1.1071 raeburn 10508: $allfiles,$codebase,'upload');
10509: $counter ++;
10510: $numnew ++;
1.987 raeburn 10511: }
10512: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
10513: }
10514: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071 raeburn 10515: if ($actionurl eq '/adm/dependencies') {
10516: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
10517: $modify_output .= &start_data_table_row().
10518: '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
10519: '<img src="'.&icon($embed_file).'" border="0" />'.
10520: ' <span class="LC_filename">'.$embed_file.'</span></a></td>'.
10521: '<td>'.$size.'</td>'.
10522: '<td>'.$mtime.'</td>'.
10523: '<td><label><input type="checkbox" name="mod_upload_dep" '.
10524: 'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
10525: $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
10526: '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
10527: &embedded_file_element('upload_embedded',$counter,
10528: $embed_file,\%mapping,
10529: $allfiles,$codebase,'modify').
10530: '</div></td>'.
10531: &end_data_table_row()."\n";
10532: $counter ++;
10533: } else {
10534: $upload_output .= &start_data_table_row().
1.1123 raeburn 10535: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
10536: '<span class="LC_filename">'.$embed_file.'</span></td>'.
10537: '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071 raeburn 10538: &Apache::loncommon::end_data_table_row()."\n";
10539: }
10540: }
10541: my $delidx = $counter;
10542: foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
10543: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
10544: $delete_output .= &start_data_table_row().
10545: '<td><img src="'.&icon($oldfile).'" />'.
10546: ' <span class="LC_filename">'.$oldfile.'</span></td>'.
10547: '<td>'.$size.'</td>'.
10548: '<td>'.$mtime.'</td>'.
10549: '<td><label><input type="checkbox" name="del_upload_dep" '.
10550: ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
10551: &embedded_file_element('upload_embedded',$delidx,
10552: $oldfile,\%mapping,$allfiles,
10553: $codebase,'delete').'</td>'.
10554: &end_data_table_row()."\n";
10555: $numunused ++;
10556: $delidx ++;
1.987 raeburn 10557: }
10558: if ($upload_output) {
10559: $upload_output = &start_data_table().
10560: $upload_output.
10561: &end_data_table()."\n";
10562: }
1.1071 raeburn 10563: if ($modify_output) {
10564: $modify_output = &start_data_table().
10565: &start_data_table_header_row().
10566: '<th>'.&mt('File').'</th>'.
10567: '<th>'.&mt('Size (KB)').'</th>'.
10568: '<th>'.&mt('Modified').'</th>'.
10569: '<th>'.&mt('Upload replacement?').'</th>'.
10570: &end_data_table_header_row().
10571: $modify_output.
10572: &end_data_table()."\n";
10573: }
10574: if ($delete_output) {
10575: $delete_output = &start_data_table().
10576: &start_data_table_header_row().
10577: '<th>'.&mt('File').'</th>'.
10578: '<th>'.&mt('Size (KB)').'</th>'.
10579: '<th>'.&mt('Modified').'</th>'.
10580: '<th>'.&mt('Delete?').'</th>'.
10581: &end_data_table_header_row().
10582: $delete_output.
10583: &end_data_table()."\n";
10584: }
1.987 raeburn 10585: my $applies = 0;
10586: if ($numremref) {
10587: $applies ++;
10588: }
10589: if ($numinvalid) {
10590: $applies ++;
10591: }
10592: if ($numexisting) {
10593: $applies ++;
10594: }
1.1071 raeburn 10595: if ($counter || $numunused) {
1.987 raeburn 10596: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
10597: ' method="post" enctype="multipart/form-data">'."\n".
1.1071 raeburn 10598: $state.'<h3>'.$heading.'</h3>';
10599: if ($actionurl eq '/adm/dependencies') {
10600: if ($numnew) {
10601: $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
10602: '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
10603: $upload_output.'<br />'."\n";
10604: }
10605: if ($numexisting) {
10606: $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
10607: '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
10608: $modify_output.'<br />'."\n";
10609: $buttontext = &mt('Save changes');
10610: }
10611: if ($numunused) {
10612: $output .= '<h4>'.&mt('Unused files').'</h4>'.
10613: '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
10614: $delete_output.'<br />'."\n";
10615: $buttontext = &mt('Save changes');
10616: }
10617: } else {
10618: $output .= $upload_output.'<br />'."\n";
10619: }
10620: $output .= '<input type ="hidden" name="number_embedded_items" value="'.
10621: $counter.'" />'."\n";
10622: if ($actionurl eq '/adm/dependencies') {
10623: $output .= '<input type ="hidden" name="number_newemb_items" value="'.
10624: $numnew.'" />'."\n";
10625: } elsif ($actionurl eq '') {
1.987 raeburn 10626: $output .= '<input type="hidden" name="phase" value="three" />';
10627: }
10628: } elsif ($applies) {
10629: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
10630: if ($applies > 1) {
10631: $output .=
1.1123 raeburn 10632: &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987 raeburn 10633: if ($numremref) {
10634: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
10635: }
10636: if ($numinvalid) {
10637: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
10638: }
10639: if ($numexisting) {
10640: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
10641: }
10642: $output .= '</ul><br />';
10643: } elsif ($numremref) {
10644: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
10645: } elsif ($numinvalid) {
10646: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
10647: } elsif ($numexisting) {
10648: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
10649: }
10650: $output .= $upload_output.'<br />';
10651: }
10652: my ($pathchange_output,$chgcount);
1.1071 raeburn 10653: $chgcount = $counter;
1.987 raeburn 10654: if (keys(%pathchanges) > 0) {
10655: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071 raeburn 10656: if ($counter) {
1.987 raeburn 10657: $output .= &embedded_file_element('pathchange',$chgcount,
10658: $embed_file,\%mapping,
1.1071 raeburn 10659: $allfiles,$codebase,'change');
1.987 raeburn 10660: } else {
10661: $pathchange_output .=
10662: &start_data_table_row().
10663: '<td><input type ="checkbox" name="namechange" value="'.
10664: $chgcount.'" checked="checked" /></td>'.
10665: '<td>'.$mapping{$embed_file}.'</td>'.
10666: '<td>'.$embed_file.
10667: &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071 raeburn 10668: \%mapping,$allfiles,$codebase,'change').
1.987 raeburn 10669: '</td>'.&end_data_table_row();
1.660 raeburn 10670: }
1.987 raeburn 10671: $numpathchg ++;
10672: $chgcount ++;
1.660 raeburn 10673: }
10674: }
1.1127 raeburn 10675: if (($counter) || ($numunused)) {
1.987 raeburn 10676: if ($numpathchg) {
10677: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
10678: $numpathchg.'" />'."\n";
10679: }
10680: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
10681: ($actionurl eq '/adm/imsimport')) {
10682: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
10683: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
10684: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071 raeburn 10685: } elsif ($actionurl eq '/adm/dependencies') {
10686: $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987 raeburn 10687: }
1.1123 raeburn 10688: $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987 raeburn 10689: } elsif ($numpathchg) {
10690: my %pathchange = ();
10691: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
10692: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
10693: $output .= '<p>'.&mt('or').'</p>';
1.1123 raeburn 10694: }
1.987 raeburn 10695: }
1.1071 raeburn 10696: return ($output,$counter,$numpathchg);
1.987 raeburn 10697: }
10698:
1.1147 raeburn 10699: =pod
10700:
10701: =item * clean_path($name)
10702:
10703: Performs clean-up of directories, subdirectories and filename in an
10704: embedded object, referenced in an HTML file which is being uploaded
10705: to a course or portfolio, where
10706: "Upload embedded images/multimedia files if HTML file" checkbox was
10707: checked.
10708:
10709: Clean-up is similar to replacements in lonnet::clean_filename()
10710: except each / between sub-directory and next level is preserved.
10711:
10712: =cut
10713:
10714: sub clean_path {
10715: my ($embed_file) = @_;
10716: $embed_file =~s{^/+}{};
10717: my @contents;
10718: if ($embed_file =~ m{/}) {
10719: @contents = split(/\//,$embed_file);
10720: } else {
10721: @contents = ($embed_file);
10722: }
10723: my $lastidx = scalar(@contents)-1;
10724: for (my $i=0; $i<=$lastidx; $i++) {
10725: $contents[$i]=~s{\\}{/}g;
10726: $contents[$i]=~s/\s+/\_/g;
10727: $contents[$i]=~s{[^/\w\.\-]}{}g;
10728: if ($i == $lastidx) {
10729: $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
10730: }
10731: }
10732: if ($lastidx > 0) {
10733: return join('/',@contents);
10734: } else {
10735: return $contents[0];
10736: }
10737: }
10738:
1.987 raeburn 10739: sub embedded_file_element {
1.1071 raeburn 10740: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987 raeburn 10741: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
10742: (ref($codebase) eq 'HASH'));
10743: my $output;
1.1071 raeburn 10744: if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987 raeburn 10745: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
10746: }
10747: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
10748: &escape($embed_file).'" />';
10749: unless (($context eq 'upload_embedded') &&
10750: ($mapping->{$embed_file} eq $embed_file)) {
10751: $output .='
10752: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
10753: }
10754: my $attrib;
10755: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
10756: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
10757: }
10758: $output .=
10759: "\n\t\t".
10760: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
10761: $attrib.'" />';
10762: if (exists($codebase->{$mapping->{$embed_file}})) {
10763: $output .=
10764: "\n\t\t".
10765: '<input name="codebase_'.$num.'" type="hidden" value="'.
10766: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 10767: }
1.987 raeburn 10768: return $output;
1.660 raeburn 10769: }
10770:
1.1071 raeburn 10771: sub get_dependency_details {
10772: my ($currfile,$currsubfile,$embed_file) = @_;
10773: my ($size,$mtime,$showsize,$showmtime);
10774: if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
10775: if ($embed_file =~ m{/}) {
10776: my ($path,$fname) = split(/\//,$embed_file);
10777: if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
10778: ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
10779: }
10780: } else {
10781: if (ref($currfile->{$embed_file}) eq 'ARRAY') {
10782: ($size,$mtime) = @{$currfile->{$embed_file}};
10783: }
10784: }
10785: $showsize = $size/1024.0;
10786: $showsize = sprintf("%.1f",$showsize);
10787: if ($mtime > 0) {
10788: $showmtime = &Apache::lonlocal::locallocaltime($mtime);
10789: }
10790: }
10791: return ($showsize,$showmtime);
10792: }
10793:
10794: sub ask_embedded_js {
10795: return <<"END";
10796: <script type="text/javascript"">
10797: // <![CDATA[
10798: function toggleBrowse(counter) {
10799: var chkboxid = document.getElementById('mod_upload_dep_'+counter);
10800: var fileid = document.getElementById('embedded_item_'+counter);
10801: var uploaddivid = document.getElementById('moduploaddep_'+counter);
10802: if (chkboxid.checked == true) {
10803: uploaddivid.style.display='block';
10804: } else {
10805: uploaddivid.style.display='none';
10806: fileid.value = '';
10807: }
10808: }
10809: // ]]>
10810: </script>
10811:
10812: END
10813: }
10814:
1.661 raeburn 10815: sub upload_embedded {
10816: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 10817: $current_disk_usage,$hiddenstate,$actionurl) = @_;
10818: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 10819: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
10820: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
10821: my $orig_uploaded_filename =
10822: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 10823: foreach my $type ('orig','ref','attrib','codebase') {
10824: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
10825: $env{'form.embedded_'.$type.'_'.$i} =
10826: &unescape($env{'form.embedded_'.$type.'_'.$i});
10827: }
10828: }
1.661 raeburn 10829: my ($path,$fname) =
10830: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
10831: # no path, whole string is fname
10832: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
10833: $fname = &Apache::lonnet::clean_filename($fname);
10834: # See if there is anything left
10835: next if ($fname eq '');
10836:
10837: # Check if file already exists as a file or directory.
10838: my ($state,$msg);
10839: if ($context eq 'portfolio') {
10840: my $port_path = $dirpath;
10841: if ($group ne '') {
10842: $port_path = "groups/$group/$port_path";
10843: }
1.987 raeburn 10844: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
10845: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 10846: $dir_root,$port_path,$disk_quota,
10847: $current_disk_usage,$uname,$udom);
10848: if ($state eq 'will_exceed_quota'
1.984 raeburn 10849: || $state eq 'file_locked') {
1.661 raeburn 10850: $output .= $msg;
10851: next;
10852: }
10853: } elsif (($context eq 'author') || ($context eq 'testbank')) {
10854: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
10855: if ($state eq 'exists') {
10856: $output .= $msg;
10857: next;
10858: }
10859: }
10860: # Check if extension is valid
10861: if (($fname =~ /\.(\w+)$/) &&
10862: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1155 bisitz 10863: $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
10864: .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661 raeburn 10865: next;
10866: } elsif (($fname =~ /\.(\w+)$/) &&
10867: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 10868: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 10869: next;
10870: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1120 bisitz 10871: $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 10872: next;
10873: }
10874: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1123 raeburn 10875: my $subdir = $path;
10876: $subdir =~ s{/+$}{};
1.661 raeburn 10877: if ($context eq 'portfolio') {
1.984 raeburn 10878: my $result;
10879: if ($state eq 'existingfile') {
10880: $result=
10881: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1123 raeburn 10882: $dirpath.$env{'form.currentpath'}.$subdir);
1.661 raeburn 10883: } else {
1.984 raeburn 10884: $result=
10885: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 10886: $dirpath.
1.1123 raeburn 10887: $env{'form.currentpath'}.$subdir);
1.984 raeburn 10888: if ($result !~ m|^/uploaded/|) {
10889: $output .= '<span class="LC_error">'
10890: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
10891: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
10892: .'</span><br />';
10893: next;
10894: } else {
1.987 raeburn 10895: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
10896: $path.$fname.'</span>').'<br />';
1.984 raeburn 10897: }
1.661 raeburn 10898: }
1.1123 raeburn 10899: } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
1.1126 raeburn 10900: my $extendedsubdir = $dirpath.'/'.$subdir;
10901: $extendedsubdir =~ s{/+$}{};
1.987 raeburn 10902: my $result =
1.1126 raeburn 10903: &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987 raeburn 10904: if ($result !~ m|^/uploaded/|) {
10905: $output .= '<span class="LC_error">'
10906: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
10907: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
10908: .'</span><br />';
10909: next;
10910: } else {
10911: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
10912: $path.$fname.'</span>').'<br />';
1.1125 raeburn 10913: if ($context eq 'syllabus') {
10914: &Apache::lonnet::make_public_indefinitely($result);
10915: }
1.987 raeburn 10916: }
1.661 raeburn 10917: } else {
10918: # Save the file
10919: my $target = $env{'form.embedded_item_'.$i};
10920: my $fullpath = $dir_root.$dirpath.'/'.$path;
10921: my $dest = $fullpath.$fname;
10922: my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027 raeburn 10923: my @parts=split(/\//,"$dirpath/$path");
1.661 raeburn 10924: my $count;
10925: my $filepath = $dir_root;
1.1027 raeburn 10926: foreach my $subdir (@parts) {
10927: $filepath .= "/$subdir";
10928: if (!-e $filepath) {
1.661 raeburn 10929: mkdir($filepath,0770);
10930: }
10931: }
10932: my $fh;
10933: if (!open($fh,'>'.$dest)) {
10934: &Apache::lonnet::logthis('Failed to create '.$dest);
10935: $output .= '<span class="LC_error">'.
1.1071 raeburn 10936: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
10937: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 10938: '</span><br />';
10939: } else {
10940: if (!print $fh $env{'form.embedded_item_'.$i}) {
10941: &Apache::lonnet::logthis('Failed to write to '.$dest);
10942: $output .= '<span class="LC_error">'.
1.1071 raeburn 10943: &mt('An error occurred while writing the file [_1] for embedded element [_2].',
10944: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 10945: '</span><br />';
10946: } else {
1.987 raeburn 10947: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
10948: $url.'</span>').'<br />';
10949: unless ($context eq 'testbank') {
10950: $footer .= &mt('View embedded file: [_1]',
10951: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
10952: }
10953: }
10954: close($fh);
10955: }
10956: }
10957: if ($env{'form.embedded_ref_'.$i}) {
10958: $pathchange{$i} = 1;
10959: }
10960: }
10961: if ($output) {
10962: $output = '<p>'.$output.'</p>';
10963: }
10964: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
10965: $returnflag = 'ok';
1.1071 raeburn 10966: my $numpathchgs = scalar(keys(%pathchange));
10967: if ($numpathchgs > 0) {
1.987 raeburn 10968: if ($context eq 'portfolio') {
10969: $output .= '<p>'.&mt('or').'</p>';
10970: } elsif ($context eq 'testbank') {
1.1071 raeburn 10971: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
10972: '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987 raeburn 10973: $returnflag = 'modify_orightml';
10974: }
10975: }
1.1071 raeburn 10976: return ($output.$footer,$returnflag,$numpathchgs);
1.987 raeburn 10977: }
10978:
10979: sub modify_html_form {
10980: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
10981: my $end = 0;
10982: my $modifyform;
10983: if ($context eq 'upload_embedded') {
10984: return unless (ref($pathchange) eq 'HASH');
10985: if ($env{'form.number_embedded_items'}) {
10986: $end += $env{'form.number_embedded_items'};
10987: }
10988: if ($env{'form.number_pathchange_items'}) {
10989: $end += $env{'form.number_pathchange_items'};
10990: }
10991: if ($end) {
10992: for (my $i=0; $i<$end; $i++) {
10993: if ($i < $env{'form.number_embedded_items'}) {
10994: next unless($pathchange->{$i});
10995: }
10996: $modifyform .=
10997: &start_data_table_row().
10998: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
10999: 'checked="checked" /></td>'.
11000: '<td>'.$env{'form.embedded_ref_'.$i}.
11001: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
11002: &escape($env{'form.embedded_ref_'.$i}).'" />'.
11003: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
11004: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
11005: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
11006: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
11007: '<td>'.$env{'form.embedded_orig_'.$i}.
11008: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
11009: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
11010: &end_data_table_row();
1.1071 raeburn 11011: }
1.987 raeburn 11012: }
11013: } else {
11014: $modifyform = $pathchgtable;
11015: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
11016: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
11017: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
11018: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
11019: }
11020: }
11021: if ($modifyform) {
1.1071 raeburn 11022: if ($actionurl eq '/adm/dependencies') {
11023: $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
11024: }
1.987 raeburn 11025: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
11026: '<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".
11027: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
11028: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
11029: '</ol></p>'."\n".'<p>'.
11030: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
11031: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
11032: &start_data_table()."\n".
11033: &start_data_table_header_row().
11034: '<th>'.&mt('Change?').'</th>'.
11035: '<th>'.&mt('Current reference').'</th>'.
11036: '<th>'.&mt('Required reference').'</th>'.
11037: &end_data_table_header_row()."\n".
11038: $modifyform.
11039: &end_data_table().'<br />'."\n".$hiddenstate.
11040: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
11041: '</form>'."\n";
11042: }
11043: return;
11044: }
11045:
11046: sub modify_html_refs {
1.1123 raeburn 11047: my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987 raeburn 11048: my $container;
11049: if ($context eq 'portfolio') {
11050: $container = $env{'form.container'};
11051: } elsif ($context eq 'coursedoc') {
11052: $container = $env{'form.primaryurl'};
1.1071 raeburn 11053: } elsif ($context eq 'manage_dependencies') {
11054: (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
11055: $container = "/$container";
1.1123 raeburn 11056: } elsif ($context eq 'syllabus') {
11057: $container = $url;
1.987 raeburn 11058: } else {
1.1027 raeburn 11059: $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987 raeburn 11060: }
11061: my (%allfiles,%codebase,$output,$content);
11062: my @changes = &get_env_multiple('form.namechange');
1.1126 raeburn 11063: unless ((@changes > 0) || ($context eq 'syllabus')) {
1.1071 raeburn 11064: if (wantarray) {
11065: return ('',0,0);
11066: } else {
11067: return;
11068: }
11069: }
11070: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 11071: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071 raeburn 11072: unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
11073: if (wantarray) {
11074: return ('',0,0);
11075: } else {
11076: return;
11077: }
11078: }
1.987 raeburn 11079: $content = &Apache::lonnet::getfile($container);
1.1071 raeburn 11080: if ($content eq '-1') {
11081: if (wantarray) {
11082: return ('',0,0);
11083: } else {
11084: return;
11085: }
11086: }
1.987 raeburn 11087: } else {
1.1071 raeburn 11088: unless ($container =~ /^\Q$dir_root\E/) {
11089: if (wantarray) {
11090: return ('',0,0);
11091: } else {
11092: return;
11093: }
11094: }
1.987 raeburn 11095: if (open(my $fh,"<$container")) {
11096: $content = join('', <$fh>);
11097: close($fh);
11098: } else {
1.1071 raeburn 11099: if (wantarray) {
11100: return ('',0,0);
11101: } else {
11102: return;
11103: }
1.987 raeburn 11104: }
11105: }
11106: my ($count,$codebasecount) = (0,0);
11107: my $mm = new File::MMagic;
11108: my $mime_type = $mm->checktype_contents($content);
11109: if ($mime_type eq 'text/html') {
11110: my $parse_result =
11111: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
11112: \%codebase,\$content);
11113: if ($parse_result eq 'ok') {
11114: foreach my $i (@changes) {
11115: my $orig = &unescape($env{'form.embedded_orig_'.$i});
11116: my $ref = &unescape($env{'form.embedded_ref_'.$i});
11117: if ($allfiles{$ref}) {
11118: my $newname = $orig;
11119: my ($attrib_regexp,$codebase);
1.1006 raeburn 11120: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 11121: if ($attrib_regexp =~ /:/) {
11122: $attrib_regexp =~ s/\:/|/g;
11123: }
11124: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
11125: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
11126: $count += $numchg;
1.1123 raeburn 11127: $allfiles{$newname} = $allfiles{$ref};
1.1148 raeburn 11128: delete($allfiles{$ref});
1.987 raeburn 11129: }
11130: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 11131: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 11132: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
11133: $codebasecount ++;
11134: }
11135: }
11136: }
1.1123 raeburn 11137: my $skiprewrites;
1.987 raeburn 11138: if ($count || $codebasecount) {
11139: my $saveresult;
1.1071 raeburn 11140: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 11141: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987 raeburn 11142: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
11143: if ($url eq $container) {
11144: my ($fname) = ($container =~ m{/([^/]+)$});
11145: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
11146: $count,'<span class="LC_filename">'.
1.1071 raeburn 11147: $fname.'</span>').'</p>';
1.987 raeburn 11148: } else {
11149: $output = '<p class="LC_error">'.
11150: &mt('Error: update failed for: [_1].',
11151: '<span class="LC_filename">'.
11152: $container.'</span>').'</p>';
11153: }
1.1123 raeburn 11154: if ($context eq 'syllabus') {
11155: unless ($saveresult eq 'ok') {
11156: $skiprewrites = 1;
11157: }
11158: }
1.987 raeburn 11159: } else {
11160: if (open(my $fh,">$container")) {
11161: print $fh $content;
11162: close($fh);
11163: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
11164: $count,'<span class="LC_filename">'.
11165: $container.'</span>').'</p>';
1.661 raeburn 11166: } else {
1.987 raeburn 11167: $output = '<p class="LC_error">'.
11168: &mt('Error: could not update [_1].',
11169: '<span class="LC_filename">'.
11170: $container.'</span>').'</p>';
1.661 raeburn 11171: }
11172: }
11173: }
1.1123 raeburn 11174: if (($context eq 'syllabus') && (!$skiprewrites)) {
11175: my ($actionurl,$state);
11176: $actionurl = "/public/$udom/$uname/syllabus";
11177: my ($ignore,$num,$numpathchanges,$existing,$mapping) =
11178: &ask_for_embedded_content($actionurl,$state,\%allfiles,
11179: \%codebase,
11180: {'context' => 'rewrites',
11181: 'ignore_remote_references' => 1,});
11182: if (ref($mapping) eq 'HASH') {
11183: my $rewrites = 0;
11184: foreach my $key (keys(%{$mapping})) {
11185: next if ($key =~ m{^https?://});
11186: my $ref = $mapping->{$key};
11187: my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
11188: my $attrib;
11189: if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
11190: $attrib = join('|',@{$allfiles{$mapping->{$key}}});
11191: }
11192: if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
11193: my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
11194: $rewrites += $numchg;
11195: }
11196: }
11197: if ($rewrites) {
11198: my $saveresult;
11199: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
11200: if ($url eq $container) {
11201: my ($fname) = ($container =~ m{/([^/]+)$});
11202: $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
11203: $count,'<span class="LC_filename">'.
11204: $fname.'</span>').'</p>';
11205: } else {
11206: $output .= '<p class="LC_error">'.
11207: &mt('Error: could not update links in [_1].',
11208: '<span class="LC_filename">'.
11209: $container.'</span>').'</p>';
11210:
11211: }
11212: }
11213: }
11214: }
1.987 raeburn 11215: } else {
11216: &logthis('Failed to parse '.$container.
11217: ' to modify references: '.$parse_result);
1.661 raeburn 11218: }
11219: }
1.1071 raeburn 11220: if (wantarray) {
11221: return ($output,$count,$codebasecount);
11222: } else {
11223: return $output;
11224: }
1.661 raeburn 11225: }
11226:
11227: sub check_for_existing {
11228: my ($path,$fname,$element) = @_;
11229: my ($state,$msg);
11230: if (-d $path.'/'.$fname) {
11231: $state = 'exists';
11232: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
11233: } elsif (-e $path.'/'.$fname) {
11234: $state = 'exists';
11235: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
11236: }
11237: if ($state eq 'exists') {
11238: $msg = '<span class="LC_error">'.$msg.'</span><br />';
11239: }
11240: return ($state,$msg);
11241: }
11242:
11243: sub check_for_upload {
11244: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
11245: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 11246: my $filesize = length($env{'form.'.$element});
11247: if (!$filesize) {
11248: my $msg = '<span class="LC_error">'.
11249: &mt('Unable to upload [_1]. (size = [_2] bytes)',
11250: '<span class="LC_filename">'.$fname.'</span>',
11251: $filesize).'<br />'.
1.1007 raeburn 11252: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 11253: '</span>';
11254: return ('zero_bytes',$msg);
11255: }
11256: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 11257: my $getpropath = 1;
1.1021 raeburn 11258: my ($dirlistref,$listerror) =
11259: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 11260: my $found_file = 0;
11261: my $locked_file = 0;
1.991 raeburn 11262: my @lockers;
11263: my $navmap;
11264: if ($env{'request.course.id'}) {
11265: $navmap = Apache::lonnavmaps::navmap->new();
11266: }
1.1021 raeburn 11267: if (ref($dirlistref) eq 'ARRAY') {
11268: foreach my $line (@{$dirlistref}) {
11269: my ($file_name,$rest)=split(/\&/,$line,2);
11270: if ($file_name eq $fname){
11271: $file_name = $path.$file_name;
11272: if ($group ne '') {
11273: $file_name = $group.$file_name;
11274: }
11275: $found_file = 1;
11276: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
11277: foreach my $lock (@lockers) {
11278: if (ref($lock) eq 'ARRAY') {
11279: my ($symb,$crsid) = @{$lock};
11280: if ($crsid eq $env{'request.course.id'}) {
11281: if (ref($navmap)) {
11282: my $res = $navmap->getBySymb($symb);
11283: foreach my $part (@{$res->parts()}) {
11284: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
11285: unless (($slot_status == $res->RESERVED) ||
11286: ($slot_status == $res->RESERVED_LOCATION)) {
11287: $locked_file = 1;
11288: }
1.991 raeburn 11289: }
1.1021 raeburn 11290: } else {
11291: $locked_file = 1;
1.991 raeburn 11292: }
11293: } else {
11294: $locked_file = 1;
11295: }
11296: }
1.1021 raeburn 11297: }
11298: } else {
11299: my @info = split(/\&/,$rest);
11300: my $currsize = $info[6]/1000;
11301: if ($currsize < $filesize) {
11302: my $extra = $filesize - $currsize;
11303: if (($current_disk_usage + $extra) > $disk_quota) {
1.1179 bisitz 11304: my $msg = '<p class="LC_warning">'.
1.1021 raeburn 11305: &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 11306: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
11307: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
11308: $disk_quota,$current_disk_usage).'</p>';
1.1021 raeburn 11309: return ('will_exceed_quota',$msg);
11310: }
1.984 raeburn 11311: }
11312: }
1.661 raeburn 11313: }
11314: }
11315: }
11316: if (($current_disk_usage + $filesize) > $disk_quota){
1.1179 bisitz 11317: my $msg = '<p class="LC_warning">'.
11318: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
1.1184 raeburn 11319: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661 raeburn 11320: return ('will_exceed_quota',$msg);
11321: } elsif ($found_file) {
11322: if ($locked_file) {
1.1179 bisitz 11323: my $msg = '<p class="LC_warning">';
1.661 raeburn 11324: $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 11325: $msg .= '</p>';
1.661 raeburn 11326: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
11327: return ('file_locked',$msg);
11328: } else {
1.1179 bisitz 11329: my $msg = '<p class="LC_error">';
1.984 raeburn 11330: $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 11331: $msg .= '</p>';
1.984 raeburn 11332: return ('existingfile',$msg);
1.661 raeburn 11333: }
11334: }
11335: }
11336:
1.987 raeburn 11337: sub check_for_traversal {
11338: my ($path,$url,$toplevel) = @_;
11339: my @parts=split(/\//,$path);
11340: my $cleanpath;
11341: my $fullpath = $url;
11342: for (my $i=0;$i<@parts;$i++) {
11343: next if ($parts[$i] eq '.');
11344: if ($parts[$i] eq '..') {
11345: $fullpath =~ s{([^/]+/)$}{};
11346: } else {
11347: $fullpath .= $parts[$i].'/';
11348: }
11349: }
11350: if ($fullpath =~ /^\Q$url\E(.*)$/) {
11351: $cleanpath = $1;
11352: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
11353: my $curr_toprel = $1;
11354: my @parts = split(/\//,$curr_toprel);
11355: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
11356: my @urlparts = split(/\//,$url_toprel);
11357: my $doubledots;
11358: my $startdiff = -1;
11359: for (my $i=0; $i<@urlparts; $i++) {
11360: if ($startdiff == -1) {
11361: unless ($urlparts[$i] eq $parts[$i]) {
11362: $startdiff = $i;
11363: $doubledots .= '../';
11364: }
11365: } else {
11366: $doubledots .= '../';
11367: }
11368: }
11369: if ($startdiff > -1) {
11370: $cleanpath = $doubledots;
11371: for (my $i=$startdiff; $i<@parts; $i++) {
11372: $cleanpath .= $parts[$i].'/';
11373: }
11374: }
11375: }
11376: $cleanpath =~ s{(/)$}{};
11377: return $cleanpath;
11378: }
1.31 albertel 11379:
1.1053 raeburn 11380: sub is_archive_file {
11381: my ($mimetype) = @_;
11382: if (($mimetype eq 'application/octet-stream') ||
11383: ($mimetype eq 'application/x-stuffit') ||
11384: ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
11385: return 1;
11386: }
11387: return;
11388: }
11389:
11390: sub decompress_form {
1.1065 raeburn 11391: my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053 raeburn 11392: my %lt = &Apache::lonlocal::texthash (
11393: this => 'This file is an archive file.',
1.1067 raeburn 11394: camt => 'This file is a Camtasia archive file.',
1.1065 raeburn 11395: itsc => 'Its contents are as follows:',
1.1053 raeburn 11396: youm => 'You may wish to extract its contents.',
11397: extr => 'Extract contents',
1.1067 raeburn 11398: auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
11399: proa => 'Process automatically?',
1.1053 raeburn 11400: yes => 'Yes',
11401: no => 'No',
1.1067 raeburn 11402: fold => 'Title for folder containing movie',
11403: movi => 'Title for page containing embedded movie',
1.1053 raeburn 11404: );
1.1065 raeburn 11405: my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067 raeburn 11406: my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065 raeburn 11407: my $info = &list_archive_contents($fileloc,\@paths);
11408: if (@paths) {
11409: foreach my $path (@paths) {
11410: $path =~ s{^/}{};
1.1067 raeburn 11411: if ($path =~ m{^([^/]+)/$}) {
11412: $topdir = $1;
11413: }
1.1065 raeburn 11414: if ($path =~ m{^([^/]+)/}) {
11415: $toplevel{$1} = $path;
11416: } else {
11417: $toplevel{$path} = $path;
11418: }
11419: }
11420: }
1.1067 raeburn 11421: if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1164 raeburn 11422: my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067 raeburn 11423: "$topdir/media/",
11424: "$topdir/media/$topdir.mp4",
11425: "$topdir/media/FirstFrame.png",
11426: "$topdir/media/player.swf",
11427: "$topdir/media/swfobject.js",
11428: "$topdir/media/expressInstall.swf");
1.1197 raeburn 11429: my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1164 raeburn 11430: "$topdir/$topdir.mp4",
11431: "$topdir/$topdir\_config.xml",
11432: "$topdir/$topdir\_controller.swf",
11433: "$topdir/$topdir\_embed.css",
11434: "$topdir/$topdir\_First_Frame.png",
11435: "$topdir/$topdir\_player.html",
11436: "$topdir/$topdir\_Thumbnails.png",
11437: "$topdir/playerProductInstall.swf",
11438: "$topdir/scripts/",
11439: "$topdir/scripts/config_xml.js",
11440: "$topdir/scripts/handlebars.js",
11441: "$topdir/scripts/jquery-1.7.1.min.js",
11442: "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
11443: "$topdir/scripts/modernizr.js",
11444: "$topdir/scripts/player-min.js",
11445: "$topdir/scripts/swfobject.js",
11446: "$topdir/skins/",
11447: "$topdir/skins/configuration_express.xml",
11448: "$topdir/skins/express_show/",
11449: "$topdir/skins/express_show/player-min.css",
11450: "$topdir/skins/express_show/spritesheet.png");
1.1197 raeburn 11451: my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
11452: "$topdir/$topdir.mp4",
11453: "$topdir/$topdir\_config.xml",
11454: "$topdir/$topdir\_controller.swf",
11455: "$topdir/$topdir\_embed.css",
11456: "$topdir/$topdir\_First_Frame.png",
11457: "$topdir/$topdir\_player.html",
11458: "$topdir/$topdir\_Thumbnails.png",
11459: "$topdir/playerProductInstall.swf",
11460: "$topdir/scripts/",
11461: "$topdir/scripts/config_xml.js",
11462: "$topdir/scripts/techsmith-smart-player.min.js",
11463: "$topdir/skins/",
11464: "$topdir/skins/configuration_express.xml",
11465: "$topdir/skins/express_show/",
11466: "$topdir/skins/express_show/spritesheet.min.css",
11467: "$topdir/skins/express_show/spritesheet.png",
11468: "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1164 raeburn 11469: my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067 raeburn 11470: if (@diffs == 0) {
1.1164 raeburn 11471: $is_camtasia = 6;
11472: } else {
1.1197 raeburn 11473: @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1164 raeburn 11474: if (@diffs == 0) {
11475: $is_camtasia = 8;
1.1197 raeburn 11476: } else {
11477: @diffs = &compare_arrays(\@paths,\@camtasia8_4);
11478: if (@diffs == 0) {
11479: $is_camtasia = 8;
11480: }
1.1164 raeburn 11481: }
1.1067 raeburn 11482: }
11483: }
11484: my $output;
11485: if ($is_camtasia) {
11486: $output = <<"ENDCAM";
11487: <script type="text/javascript" language="Javascript">
11488: // <![CDATA[
11489:
11490: function camtasiaToggle() {
11491: for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
11492: if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1164 raeburn 11493: if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067 raeburn 11494: document.getElementById('camtasia_titles').style.display='block';
11495: } else {
11496: document.getElementById('camtasia_titles').style.display='none';
11497: }
11498: }
11499: }
11500: return;
11501: }
11502:
11503: // ]]>
11504: </script>
11505: <p>$lt{'camt'}</p>
11506: ENDCAM
1.1065 raeburn 11507: } else {
1.1067 raeburn 11508: $output = '<p>'.$lt{'this'};
11509: if ($info eq '') {
11510: $output .= ' '.$lt{'youm'}.'</p>'."\n";
11511: } else {
11512: $output .= ' '.$lt{'itsc'}.'</p>'."\n".
11513: '<div><pre>'.$info.'</pre></div>';
11514: }
1.1065 raeburn 11515: }
1.1067 raeburn 11516: $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065 raeburn 11517: my $duplicates;
11518: my $num = 0;
11519: if (ref($dirlist) eq 'ARRAY') {
11520: foreach my $item (@{$dirlist}) {
11521: if (ref($item) eq 'ARRAY') {
11522: if (exists($toplevel{$item->[0]})) {
11523: $duplicates .=
11524: &start_data_table_row().
11525: '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
11526: 'value="0" checked="checked" />'.&mt('No').'</label>'.
11527: ' <label><input type="radio" name="archive_overwrite_'.$num.'" '.
11528: 'value="1" />'.&mt('Yes').'</label>'.
11529: '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
11530: '<td>'.$item->[0].'</td>';
11531: if ($item->[2]) {
11532: $duplicates .= '<td>'.&mt('Directory').'</td>';
11533: } else {
11534: $duplicates .= '<td>'.&mt('File').'</td>';
11535: }
11536: $duplicates .= '<td>'.$item->[3].'</td>'.
11537: '<td>'.
11538: &Apache::lonlocal::locallocaltime($item->[4]).
11539: '</td>'.
11540: &end_data_table_row();
11541: $num ++;
11542: }
11543: }
11544: }
11545: }
11546: my $itemcount;
11547: if (@paths > 0) {
11548: $itemcount = scalar(@paths);
11549: } else {
11550: $itemcount = 1;
11551: }
1.1067 raeburn 11552: if ($is_camtasia) {
11553: $output .= $lt{'auto'}.'<br />'.
11554: '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1164 raeburn 11555: '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067 raeburn 11556: $lt{'yes'}.'</label> <label>'.
11557: '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
11558: $lt{'no'}.'</label></span><br />'.
11559: '<div id="camtasia_titles" style="display:block">'.
11560: &Apache::lonhtmlcommon::start_pick_box().
11561: &Apache::lonhtmlcommon::row_title($lt{'fold'}).
11562: '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
11563: &Apache::lonhtmlcommon::row_closure().
11564: &Apache::lonhtmlcommon::row_title($lt{'movi'}).
11565: '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
11566: &Apache::lonhtmlcommon::row_closure(1).
11567: &Apache::lonhtmlcommon::end_pick_box().
11568: '</div>';
11569: }
1.1065 raeburn 11570: $output .=
11571: '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067 raeburn 11572: '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
11573: "\n";
1.1065 raeburn 11574: if ($duplicates ne '') {
11575: $output .= '<p><span class="LC_warning">'.
11576: &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.
11577: &start_data_table().
11578: &start_data_table_header_row().
11579: '<th>'.&mt('Overwrite?').'</th>'.
11580: '<th>'.&mt('Name').'</th>'.
11581: '<th>'.&mt('Type').'</th>'.
11582: '<th>'.&mt('Size').'</th>'.
11583: '<th>'.&mt('Last modified').'</th>'.
11584: &end_data_table_header_row().
11585: $duplicates.
11586: &end_data_table().
11587: '</p>';
11588: }
1.1067 raeburn 11589: $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053 raeburn 11590: if (ref($hiddenelements) eq 'HASH') {
11591: foreach my $hidden (sort(keys(%{$hiddenelements}))) {
11592: $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
11593: }
11594: }
11595: $output .= <<"END";
1.1067 raeburn 11596: <br />
1.1053 raeburn 11597: <input type="submit" name="decompress" value="$lt{'extr'}" />
11598: </form>
11599: $noextract
11600: END
11601: return $output;
11602: }
11603:
1.1065 raeburn 11604: sub decompression_utility {
11605: my ($program) = @_;
11606: my @utilities = ('tar','gunzip','bunzip2','unzip');
11607: my $location;
11608: if (grep(/^\Q$program\E$/,@utilities)) {
11609: foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
11610: '/usr/sbin/') {
11611: if (-x $dir.$program) {
11612: $location = $dir.$program;
11613: last;
11614: }
11615: }
11616: }
11617: return $location;
11618: }
11619:
11620: sub list_archive_contents {
11621: my ($file,$pathsref) = @_;
11622: my (@cmd,$output);
11623: my $needsregexp;
11624: if ($file =~ /\.zip$/) {
11625: @cmd = (&decompression_utility('unzip'),"-l");
11626: $needsregexp = 1;
11627: } elsif (($file =~ m/\.tar\.gz$/) ||
11628: ($file =~ /\.tgz$/)) {
11629: @cmd = (&decompression_utility('tar'),"-ztf");
11630: } elsif ($file =~ /\.tar\.bz2$/) {
11631: @cmd = (&decompression_utility('tar'),"-jtf");
11632: } elsif ($file =~ m|\.tar$|) {
11633: @cmd = (&decompression_utility('tar'),"-tf");
11634: }
11635: if (@cmd) {
11636: undef($!);
11637: undef($@);
11638: if (open(my $fh,"-|", @cmd, $file)) {
11639: while (my $line = <$fh>) {
11640: $output .= $line;
11641: chomp($line);
11642: my $item;
11643: if ($needsregexp) {
11644: ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/);
11645: } else {
11646: $item = $line;
11647: }
11648: if ($item ne '') {
11649: unless (grep(/^\Q$item\E$/,@{$pathsref})) {
11650: push(@{$pathsref},$item);
11651: }
11652: }
11653: }
11654: close($fh);
11655: }
11656: }
11657: return $output;
11658: }
11659:
1.1053 raeburn 11660: sub decompress_uploaded_file {
11661: my ($file,$dir) = @_;
11662: &Apache::lonnet::appenv({'cgi.file' => $file});
11663: &Apache::lonnet::appenv({'cgi.dir' => $dir});
11664: my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
11665: my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
11666: my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
11667: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
11668: my $decompressed = $env{'cgi.decompressed'};
11669: &Apache::lonnet::delenv('cgi.file');
11670: &Apache::lonnet::delenv('cgi.dir');
11671: &Apache::lonnet::delenv('cgi.decompressed');
11672: return ($decompressed,$result);
11673: }
11674:
1.1055 raeburn 11675: sub process_decompression {
11676: my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
11677: my ($dir,$error,$warning,$output);
1.1180 raeburn 11678: if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1120 bisitz 11679: $error = &mt('Filename not a supported archive file type.').
11680: '<br />'.&mt('Filename should end with one of: [_1].',
1.1055 raeburn 11681: '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
11682: } else {
11683: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
11684: if ($docuhome eq 'no_host') {
11685: $error = &mt('Could not determine home server for course.');
11686: } else {
11687: my @ids=&Apache::lonnet::current_machine_ids();
11688: my $currdir = "$dir_root/$destination";
11689: if (grep(/^\Q$docuhome\E$/,@ids)) {
11690: $dir = &LONCAPA::propath($docudom,$docuname).
11691: "$dir_root/$destination";
11692: } else {
11693: $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
11694: "$dir_root/$docudom/$docuname/$destination";
11695: unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
11696: $error = &mt('Archive file not found.');
11697: }
11698: }
1.1065 raeburn 11699: my (@to_overwrite,@to_skip);
11700: if ($env{'form.archive_overwrite_total'} > 0) {
11701: my $total = $env{'form.archive_overwrite_total'};
11702: for (my $i=0; $i<$total; $i++) {
11703: if ($env{'form.archive_overwrite_'.$i} == 1) {
11704: push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
11705: } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
11706: push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
11707: }
11708: }
11709: }
11710: my $numskip = scalar(@to_skip);
11711: if (($numskip > 0) &&
11712: ($numskip == $env{'form.archive_itemcount'})) {
11713: $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');
11714: } elsif ($dir eq '') {
1.1055 raeburn 11715: $error = &mt('Directory containing archive file unavailable.');
11716: } elsif (!$error) {
1.1065 raeburn 11717: my ($decompressed,$display);
11718: if ($numskip > 0) {
11719: my $tempdir = time.'_'.$$.int(rand(10000));
11720: mkdir("$dir/$tempdir",0755);
11721: system("mv $dir/$file $dir/$tempdir/$file");
11722: ($decompressed,$display) =
11723: &decompress_uploaded_file($file,"$dir/$tempdir");
11724: foreach my $item (@to_skip) {
11725: if (($item ne '') && ($item !~ /\.\./)) {
11726: if (-f "$dir/$tempdir/$item") {
11727: unlink("$dir/$tempdir/$item");
11728: } elsif (-d "$dir/$tempdir/$item") {
11729: system("rm -rf $dir/$tempdir/$item");
11730: }
11731: }
11732: }
11733: system("mv $dir/$tempdir/* $dir");
11734: rmdir("$dir/$tempdir");
11735: } else {
11736: ($decompressed,$display) =
11737: &decompress_uploaded_file($file,$dir);
11738: }
1.1055 raeburn 11739: if ($decompressed eq 'ok') {
1.1065 raeburn 11740: $output = '<p class="LC_info">'.
11741: &mt('Files extracted successfully from archive.').
11742: '</p>'."\n";
1.1055 raeburn 11743: my ($warning,$result,@contents);
11744: my ($newdirlistref,$newlisterror) =
11745: &Apache::lonnet::dirlist($currdir,$docudom,
11746: $docuname,1);
11747: my (%is_dir,%changes,@newitems);
11748: my $dirptr = 16384;
1.1065 raeburn 11749: if (ref($newdirlistref) eq 'ARRAY') {
1.1055 raeburn 11750: foreach my $dir_line (@{$newdirlistref}) {
11751: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1065 raeburn 11752: unless (($item =~ /^\.+$/) || ($item eq $file) ||
11753: ((@to_skip > 0) && (grep(/^\Q$item\E$/,@to_skip)))) {
1.1055 raeburn 11754: push(@newitems,$item);
11755: if ($dirptr&$testdir) {
11756: $is_dir{$item} = 1;
11757: }
11758: $changes{$item} = 1;
11759: }
11760: }
11761: }
11762: if (keys(%changes) > 0) {
11763: foreach my $item (sort(@newitems)) {
11764: if ($changes{$item}) {
11765: push(@contents,$item);
11766: }
11767: }
11768: }
11769: if (@contents > 0) {
1.1067 raeburn 11770: my $wantform;
11771: unless ($env{'form.autoextract_camtasia'}) {
11772: $wantform = 1;
11773: }
1.1056 raeburn 11774: my (%children,%parent,%dirorder,%titles);
1.1055 raeburn 11775: my ($count,$datatable) = &get_extracted($docudom,$docuname,
11776: $currdir,\%is_dir,
11777: \%children,\%parent,
1.1056 raeburn 11778: \@contents,\%dirorder,
11779: \%titles,$wantform);
1.1055 raeburn 11780: if ($datatable ne '') {
11781: $output .= &archive_options_form('decompressed',$datatable,
11782: $count,$hiddenelem);
1.1065 raeburn 11783: my $startcount = 6;
1.1055 raeburn 11784: $output .= &archive_javascript($startcount,$count,
1.1056 raeburn 11785: \%titles,\%children);
1.1055 raeburn 11786: }
1.1067 raeburn 11787: if ($env{'form.autoextract_camtasia'}) {
1.1164 raeburn 11788: my $version = $env{'form.autoextract_camtasia'};
1.1067 raeburn 11789: my %displayed;
11790: my $total = 1;
11791: $env{'form.archive_directory'} = [];
11792: foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
11793: my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
11794: $path =~ s{/$}{};
11795: my $item;
11796: if ($path ne '') {
11797: $item = "$path/$titles{$i}";
11798: } else {
11799: $item = $titles{$i};
11800: }
11801: $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
11802: if ($item eq $contents[0]) {
11803: push(@{$env{'form.archive_directory'}},$i);
11804: $env{'form.archive_'.$i} = 'display';
11805: $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
11806: $displayed{'folder'} = $i;
1.1164 raeburn 11807: } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
11808: (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067 raeburn 11809: $env{'form.archive_'.$i} = 'display';
11810: $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
11811: $displayed{'web'} = $i;
11812: } else {
1.1164 raeburn 11813: if ((($item eq "$contents[0]/media") && ($version == 6)) ||
11814: ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
11815: ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067 raeburn 11816: push(@{$env{'form.archive_directory'}},$i);
11817: }
11818: $env{'form.archive_'.$i} = 'dependency';
11819: }
11820: $total ++;
11821: }
11822: for (my $i=1; $i<$total; $i++) {
11823: next if ($i == $displayed{'web'});
11824: next if ($i == $displayed{'folder'});
11825: $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
11826: }
11827: $env{'form.phase'} = 'decompress_cleanup';
11828: $env{'form.archivedelete'} = 1;
11829: $env{'form.archive_count'} = $total-1;
11830: $output .=
11831: &process_extracted_files('coursedocs',$docudom,
11832: $docuname,$destination,
11833: $dir_root,$hiddenelem);
11834: }
1.1055 raeburn 11835: } else {
11836: $warning = &mt('No new items extracted from archive file.');
11837: }
11838: } else {
11839: $output = $display;
11840: $error = &mt('An error occurred during extraction from the archive file.');
11841: }
11842: }
11843: }
11844: }
11845: if ($error) {
11846: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
11847: $error.'</p>'."\n";
11848: }
11849: if ($warning) {
11850: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
11851: }
11852: return $output;
11853: }
11854:
11855: sub get_extracted {
1.1056 raeburn 11856: my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
11857: $titles,$wantform) = @_;
1.1055 raeburn 11858: my $count = 0;
11859: my $depth = 0;
11860: my $datatable;
1.1056 raeburn 11861: my @hierarchy;
1.1055 raeburn 11862: return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056 raeburn 11863: (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
11864: (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055 raeburn 11865: foreach my $item (@{$contents}) {
11866: $count ++;
1.1056 raeburn 11867: @{$dirorder->{$count}} = @hierarchy;
11868: $titles->{$count} = $item;
1.1055 raeburn 11869: &archive_hierarchy($depth,$count,$parent,$children);
11870: if ($wantform) {
11871: $datatable .= &archive_row($is_dir->{$item},$item,
11872: $currdir,$depth,$count);
11873: }
11874: if ($is_dir->{$item}) {
11875: $depth ++;
1.1056 raeburn 11876: push(@hierarchy,$count);
11877: $parent->{$depth} = $count;
1.1055 raeburn 11878: $datatable .=
11879: &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056 raeburn 11880: \$depth,\$count,\@hierarchy,$dirorder,
11881: $children,$parent,$titles,$wantform);
1.1055 raeburn 11882: $depth --;
1.1056 raeburn 11883: pop(@hierarchy);
1.1055 raeburn 11884: }
11885: }
11886: return ($count,$datatable);
11887: }
11888:
11889: sub recurse_extracted_archive {
1.1056 raeburn 11890: my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
11891: $children,$parent,$titles,$wantform) = @_;
1.1055 raeburn 11892: my $result='';
1.1056 raeburn 11893: unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
11894: (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
11895: (ref($dirorder) eq 'HASH')) {
1.1055 raeburn 11896: return $result;
11897: }
11898: my $dirptr = 16384;
11899: my ($newdirlistref,$newlisterror) =
11900: &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
11901: if (ref($newdirlistref) eq 'ARRAY') {
11902: foreach my $dir_line (@{$newdirlistref}) {
11903: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
11904: unless ($item =~ /^\.+$/) {
11905: $$count ++;
1.1056 raeburn 11906: @{$dirorder->{$$count}} = @{$hierarchy};
11907: $titles->{$$count} = $item;
1.1055 raeburn 11908: &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056 raeburn 11909:
1.1055 raeburn 11910: my $is_dir;
11911: if ($dirptr&$testdir) {
11912: $is_dir = 1;
11913: }
11914: if ($wantform) {
11915: $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
11916: }
11917: if ($is_dir) {
11918: $$depth ++;
1.1056 raeburn 11919: push(@{$hierarchy},$$count);
11920: $parent->{$$depth} = $$count;
1.1055 raeburn 11921: $result .=
11922: &recurse_extracted_archive("$currdir/$item",$docudom,
11923: $docuname,$depth,$count,
1.1056 raeburn 11924: $hierarchy,$dirorder,$children,
11925: $parent,$titles,$wantform);
1.1055 raeburn 11926: $$depth --;
1.1056 raeburn 11927: pop(@{$hierarchy});
1.1055 raeburn 11928: }
11929: }
11930: }
11931: }
11932: return $result;
11933: }
11934:
11935: sub archive_hierarchy {
11936: my ($depth,$count,$parent,$children) =@_;
11937: if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
11938: if (exists($parent->{$depth})) {
11939: $children->{$parent->{$depth}} .= $count.':';
11940: }
11941: }
11942: return;
11943: }
11944:
11945: sub archive_row {
11946: my ($is_dir,$item,$currdir,$depth,$count) = @_;
11947: my ($name) = ($item =~ m{([^/]+)$});
11948: my %choices = &Apache::lonlocal::texthash (
1.1059 raeburn 11949: 'display' => 'Add as file',
1.1055 raeburn 11950: 'dependency' => 'Include as dependency',
11951: 'discard' => 'Discard',
11952: );
11953: if ($is_dir) {
1.1059 raeburn 11954: $choices{'display'} = &mt('Add as folder');
1.1055 raeburn 11955: }
1.1056 raeburn 11956: my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
11957: my $offset = 0;
1.1055 raeburn 11958: foreach my $action ('display','dependency','discard') {
1.1056 raeburn 11959: $offset ++;
1.1065 raeburn 11960: if ($action ne 'display') {
11961: $offset ++;
11962: }
1.1055 raeburn 11963: $output .= '<td><span class="LC_nobreak">'.
11964: '<label><input type="radio" name="archive_'.$count.
11965: '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
11966: my $text = $choices{$action};
11967: if ($is_dir) {
11968: $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
11969: if ($action eq 'display') {
1.1059 raeburn 11970: $text = &mt('Add as folder');
1.1055 raeburn 11971: }
1.1056 raeburn 11972: } else {
11973: $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
11974:
11975: }
11976: $output .= ' /> '.$choices{$action}.'</label></span>';
11977: if ($action eq 'dependency') {
11978: $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
11979: &mt('Used by:').' <select name="archive_dependent_on_'.$count.'" '.
11980: 'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
11981: '<option value=""></option>'."\n".
11982: '</select>'."\n".
11983: '</div>';
1.1059 raeburn 11984: } elsif ($action eq 'display') {
11985: $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
11986: &mt('Title:').' <input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
11987: '</div>';
1.1055 raeburn 11988: }
1.1056 raeburn 11989: $output .= '</td>';
1.1055 raeburn 11990: }
11991: $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
11992: &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.(' ' x 2);
11993: for (my $i=0; $i<$depth; $i++) {
11994: $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
11995: }
11996: if ($is_dir) {
11997: $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" /> '."\n".
11998: '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
11999: } else {
12000: $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
12001: }
12002: $output .= ' '.$name.'</td>'."\n".
12003: &end_data_table_row();
12004: return $output;
12005: }
12006:
12007: sub archive_options_form {
1.1065 raeburn 12008: my ($form,$display,$count,$hiddenelem) = @_;
12009: my %lt = &Apache::lonlocal::texthash(
12010: perm => 'Permanently remove archive file?',
12011: hows => 'How should each extracted item be incorporated in the course?',
12012: cont => 'Content actions for all',
12013: addf => 'Add as folder/file',
12014: incd => 'Include as dependency for a displayed file',
12015: disc => 'Discard',
12016: no => 'No',
12017: yes => 'Yes',
12018: save => 'Save',
12019: );
12020: my $output = <<"END";
12021: <form name="$form" method="post" action="">
12022: <p><span class="LC_nobreak">$lt{'perm'}
12023: <label>
12024: <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
12025: </label>
12026:
12027: <label>
12028: <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
12029: </span>
12030: </p>
12031: <input type="hidden" name="phase" value="decompress_cleanup" />
12032: <br />$lt{'hows'}
12033: <div class="LC_columnSection">
12034: <fieldset>
12035: <legend>$lt{'cont'}</legend>
12036: <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" />
12037: <input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
12038: <input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
12039: </fieldset>
12040: </div>
12041: END
12042: return $output.
1.1055 raeburn 12043: &start_data_table()."\n".
1.1065 raeburn 12044: $display."\n".
1.1055 raeburn 12045: &end_data_table()."\n".
12046: '<input type="hidden" name="archive_count" value="'.$count.'" />'.
12047: $hiddenelem.
1.1065 raeburn 12048: '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055 raeburn 12049: '</form>';
12050: }
12051:
12052: sub archive_javascript {
1.1056 raeburn 12053: my ($startcount,$numitems,$titles,$children) = @_;
12054: return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059 raeburn 12055: my $maintitle = $env{'form.comment'};
1.1055 raeburn 12056: my $scripttag = <<START;
12057: <script type="text/javascript">
12058: // <![CDATA[
12059:
12060: function checkAll(form,prefix) {
12061: var idstr = new RegExp("^archive_"+prefix+"_\\\\d+\$");
12062: for (var i=0; i < form.elements.length; i++) {
12063: var id = form.elements[i].id;
12064: if ((id != '') && (id != undefined)) {
12065: if (idstr.test(id)) {
12066: if (form.elements[i].type == 'radio') {
12067: form.elements[i].checked = true;
1.1056 raeburn 12068: var nostart = i-$startcount;
1.1059 raeburn 12069: var offset = nostart%7;
12070: var count = (nostart-offset)/7;
1.1056 raeburn 12071: dependencyCheck(form,count,offset);
1.1055 raeburn 12072: }
12073: }
12074: }
12075: }
12076: }
12077:
12078: function propagateCheck(form,count) {
12079: if (count > 0) {
1.1059 raeburn 12080: var startelement = $startcount + ((count-1) * 7);
12081: for (var j=1; j<6; j++) {
12082: if ((j != 2) && (j != 4)) {
1.1056 raeburn 12083: var item = startelement + j;
12084: if (form.elements[item].type == 'radio') {
12085: if (form.elements[item].checked) {
12086: containerCheck(form,count,j);
12087: break;
12088: }
1.1055 raeburn 12089: }
12090: }
12091: }
12092: }
12093: }
12094:
12095: numitems = $numitems
1.1056 raeburn 12096: var titles = new Array(numitems);
12097: var parents = new Array(numitems);
1.1055 raeburn 12098: for (var i=0; i<numitems; i++) {
1.1056 raeburn 12099: parents[i] = new Array;
1.1055 raeburn 12100: }
1.1059 raeburn 12101: var maintitle = '$maintitle';
1.1055 raeburn 12102:
12103: START
12104:
1.1056 raeburn 12105: foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
12106: my @contents = split(/:/,$children->{$container});
1.1055 raeburn 12107: for (my $i=0; $i<@contents; $i ++) {
12108: $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
12109: }
12110: }
12111:
1.1056 raeburn 12112: foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
12113: $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
12114: }
12115:
1.1055 raeburn 12116: $scripttag .= <<END;
12117:
12118: function containerCheck(form,count,offset) {
12119: if (count > 0) {
1.1056 raeburn 12120: dependencyCheck(form,count,offset);
1.1059 raeburn 12121: var item = (offset+$startcount)+7*(count-1);
1.1055 raeburn 12122: form.elements[item].checked = true;
12123: if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
12124: if (parents[count].length > 0) {
12125: for (var j=0; j<parents[count].length; j++) {
1.1056 raeburn 12126: containerCheck(form,parents[count][j],offset);
12127: }
12128: }
12129: }
12130: }
12131: }
12132:
12133: function dependencyCheck(form,count,offset) {
12134: if (count > 0) {
1.1059 raeburn 12135: var chosen = (offset+$startcount)+7*(count-1);
12136: var depitem = $startcount + ((count-1) * 7) + 4;
1.1056 raeburn 12137: var currtype = form.elements[depitem].type;
12138: if (form.elements[chosen].value == 'dependency') {
12139: document.getElementById('arc_depon_'+count).style.display='block';
12140: form.elements[depitem].options.length = 0;
12141: form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1085 raeburn 12142: for (var i=1; i<=numitems; i++) {
12143: if (i == count) {
12144: continue;
12145: }
1.1059 raeburn 12146: var startelement = $startcount + (i-1) * 7;
12147: for (var j=1; j<6; j++) {
12148: if ((j != 2) && (j!= 4)) {
1.1056 raeburn 12149: var item = startelement + j;
12150: if (form.elements[item].type == 'radio') {
12151: if (form.elements[item].checked) {
12152: if (form.elements[item].value == 'display') {
12153: var n = form.elements[depitem].options.length;
12154: form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
12155: }
12156: }
12157: }
12158: }
12159: }
12160: }
12161: } else {
12162: document.getElementById('arc_depon_'+count).style.display='none';
12163: form.elements[depitem].options.length = 0;
12164: form.elements[depitem].options[0] = new Option('Select','',true,true);
12165: }
1.1059 raeburn 12166: titleCheck(form,count,offset);
1.1056 raeburn 12167: }
12168: }
12169:
12170: function propagateSelect(form,count,offset) {
12171: if (count > 0) {
1.1065 raeburn 12172: var item = (1+offset+$startcount)+7*(count-1);
1.1056 raeburn 12173: var picked = form.elements[item].options[form.elements[item].selectedIndex].value;
12174: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
12175: if (parents[count].length > 0) {
12176: for (var j=0; j<parents[count].length; j++) {
12177: containerSelect(form,parents[count][j],offset,picked);
1.1055 raeburn 12178: }
12179: }
12180: }
12181: }
12182: }
1.1056 raeburn 12183:
12184: function containerSelect(form,count,offset,picked) {
12185: if (count > 0) {
1.1065 raeburn 12186: var item = (offset+$startcount)+7*(count-1);
1.1056 raeburn 12187: if (form.elements[item].type == 'radio') {
12188: if (form.elements[item].value == 'dependency') {
12189: if (form.elements[item+1].type == 'select-one') {
12190: for (var i=0; i<form.elements[item+1].options.length; i++) {
12191: if (form.elements[item+1].options[i].value == picked) {
12192: form.elements[item+1].selectedIndex = i;
12193: break;
12194: }
12195: }
12196: }
12197: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
12198: if (parents[count].length > 0) {
12199: for (var j=0; j<parents[count].length; j++) {
12200: containerSelect(form,parents[count][j],offset,picked);
12201: }
12202: }
12203: }
12204: }
12205: }
12206: }
12207: }
12208:
1.1059 raeburn 12209: function titleCheck(form,count,offset) {
12210: if (count > 0) {
12211: var chosen = (offset+$startcount)+7*(count-1);
12212: var depitem = $startcount + ((count-1) * 7) + 2;
12213: var currtype = form.elements[depitem].type;
12214: if (form.elements[chosen].value == 'display') {
12215: document.getElementById('arc_title_'+count).style.display='block';
12216: if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
12217: document.getElementById('archive_title_'+count).value=maintitle;
12218: }
12219: } else {
12220: document.getElementById('arc_title_'+count).style.display='none';
12221: if (currtype == 'text') {
12222: document.getElementById('archive_title_'+count).value='';
12223: }
12224: }
12225: }
12226: return;
12227: }
12228:
1.1055 raeburn 12229: // ]]>
12230: </script>
12231: END
12232: return $scripttag;
12233: }
12234:
12235: sub process_extracted_files {
1.1067 raeburn 12236: my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055 raeburn 12237: my $numitems = $env{'form.archive_count'};
12238: return unless ($numitems);
12239: my @ids=&Apache::lonnet::current_machine_ids();
12240: my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067 raeburn 12241: %folders,%containers,%mapinner,%prompttofetch);
1.1055 raeburn 12242: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
12243: if (grep(/^\Q$docuhome\E$/,@ids)) {
12244: $prefix = &LONCAPA::propath($docudom,$docuname);
12245: $pathtocheck = "$dir_root/$destination";
12246: $dir = $dir_root;
12247: $ishome = 1;
12248: } else {
12249: $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
12250: $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
12251: $dir = "$dir_root/$docudom/$docuname";
12252: }
12253: my $currdir = "$dir_root/$destination";
12254: (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
12255: if ($env{'form.folderpath'}) {
12256: my @items = split('&',$env{'form.folderpath'});
12257: $folders{'0'} = $items[-2];
1.1099 raeburn 12258: if ($env{'form.folderpath'} =~ /\:1$/) {
12259: $containers{'0'}='page';
12260: } else {
12261: $containers{'0'}='sequence';
12262: }
1.1055 raeburn 12263: }
12264: my @archdirs = &get_env_multiple('form.archive_directory');
12265: if ($numitems) {
12266: for (my $i=1; $i<=$numitems; $i++) {
12267: my $path = $env{'form.archive_content_'.$i};
12268: if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
12269: my $item = $1;
12270: $toplevelitems{$item} = $i;
12271: if (grep(/^\Q$i\E$/,@archdirs)) {
12272: $is_dir{$item} = 1;
12273: }
12274: }
12275: }
12276: }
1.1067 raeburn 12277: my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055 raeburn 12278: if (keys(%toplevelitems) > 0) {
12279: my @contents = sort(keys(%toplevelitems));
1.1056 raeburn 12280: (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
12281: \%parent,\@contents,\%dirorder,\%titles);
1.1055 raeburn 12282: }
1.1066 raeburn 12283: my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055 raeburn 12284: if ($numitems) {
12285: for (my $i=1; $i<=$numitems; $i++) {
1.1086 raeburn 12286: next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055 raeburn 12287: my $path = $env{'form.archive_content_'.$i};
12288: if ($path =~ /^\Q$pathtocheck\E/) {
12289: if ($env{'form.archive_'.$i} eq 'discard') {
12290: if ($prefix ne '' && $path ne '') {
12291: if (-e $prefix.$path) {
1.1066 raeburn 12292: if ((@archdirs > 0) &&
12293: (grep(/^\Q$i\E$/,@archdirs))) {
12294: $todeletedir{$prefix.$path} = 1;
12295: } else {
12296: $todelete{$prefix.$path} = 1;
12297: }
1.1055 raeburn 12298: }
12299: }
12300: } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059 raeburn 12301: my ($docstitle,$title,$url,$outer);
1.1055 raeburn 12302: ($title) = ($path =~ m{/([^/]+)$});
1.1059 raeburn 12303: $docstitle = $env{'form.archive_title_'.$i};
12304: if ($docstitle eq '') {
12305: $docstitle = $title;
12306: }
1.1055 raeburn 12307: $outer = 0;
1.1056 raeburn 12308: if (ref($dirorder{$i}) eq 'ARRAY') {
12309: if (@{$dirorder{$i}} > 0) {
12310: foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055 raeburn 12311: if ($env{'form.archive_'.$item} eq 'display') {
12312: $outer = $item;
12313: last;
12314: }
12315: }
12316: }
12317: }
12318: my ($errtext,$fatal) =
12319: &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
12320: '/'.$folders{$outer}.'.'.
12321: $containers{$outer});
12322: next if ($fatal);
12323: if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
12324: if ($context eq 'coursedocs') {
1.1056 raeburn 12325: $mapinner{$i} = time;
1.1055 raeburn 12326: $folders{$i} = 'default_'.$mapinner{$i};
12327: $containers{$i} = 'sequence';
12328: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
12329: $folders{$i}.'.'.$containers{$i};
12330: my $newidx = &LONCAPA::map::getresidx();
12331: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 12332: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 12333: push(@LONCAPA::map::order,$newidx);
12334: my ($outtext,$errtext) =
12335: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
12336: $docuname.'/'.$folders{$outer}.
1.1087 raeburn 12337: '.'.$containers{$outer},1,1);
1.1056 raeburn 12338: $newseqid{$i} = $newidx;
1.1067 raeburn 12339: unless ($errtext) {
12340: $result .= '<li>'.&mt('Folder: [_1] added to course',$docstitle).'</li>'."\n";
12341: }
1.1055 raeburn 12342: }
12343: } else {
12344: if ($context eq 'coursedocs') {
12345: my $newidx=&LONCAPA::map::getresidx();
12346: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
12347: $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
12348: $title;
12349: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
12350: mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
12351: }
12352: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
12353: mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
12354: }
12355: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
12356: system("mv $prefix$path $prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title");
1.1056 raeburn 12357: $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
1.1067 raeburn 12358: unless ($ishome) {
12359: my $fetch = "$newdest{$i}/$title";
12360: $fetch =~ s/^\Q$prefix$dir\E//;
12361: $prompttofetch{$fetch} = 1;
12362: }
1.1055 raeburn 12363: }
12364: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 12365: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 12366: push(@LONCAPA::map::order, $newidx);
12367: my ($outtext,$errtext)=
12368: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
12369: $docuname.'/'.$folders{$outer}.
1.1087 raeburn 12370: '.'.$containers{$outer},1,1);
1.1067 raeburn 12371: unless ($errtext) {
12372: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
12373: $result .= '<li>'.&mt('File: [_1] added to course',$docstitle).'</li>'."\n";
12374: }
12375: }
1.1055 raeburn 12376: }
12377: }
1.1086 raeburn 12378: }
12379: } else {
12380: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',$path).'<br />';
12381: }
12382: }
12383: for (my $i=1; $i<=$numitems; $i++) {
12384: next unless ($env{'form.archive_'.$i} eq 'dependency');
12385: my $path = $env{'form.archive_content_'.$i};
12386: if ($path =~ /^\Q$pathtocheck\E/) {
12387: my ($title) = ($path =~ m{/([^/]+)$});
12388: $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
12389: if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
12390: if (ref($dirorder{$i}) eq 'ARRAY') {
12391: my ($itemidx,$fullpath,$relpath);
12392: if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
12393: my $container = $dirorder{$referrer{$i}}->[-1];
1.1056 raeburn 12394: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1086 raeburn 12395: if ($dirorder{$i}->[$j] eq $container) {
12396: $itemidx = $j;
1.1056 raeburn 12397: }
12398: }
1.1086 raeburn 12399: }
12400: if ($itemidx eq '') {
12401: $itemidx = 0;
12402: }
12403: if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
12404: if ($mapinner{$referrer{$i}}) {
12405: $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
12406: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
12407: if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
12408: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
12409: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
12410: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
12411: if (!-e $fullpath) {
12412: mkdir($fullpath,0755);
1.1056 raeburn 12413: }
12414: }
1.1086 raeburn 12415: } else {
12416: last;
1.1056 raeburn 12417: }
1.1086 raeburn 12418: }
12419: }
12420: } elsif ($newdest{$referrer{$i}}) {
12421: $fullpath = $newdest{$referrer{$i}};
12422: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
12423: if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
12424: $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
12425: last;
12426: } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
12427: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
12428: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
12429: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
12430: if (!-e $fullpath) {
12431: mkdir($fullpath,0755);
1.1056 raeburn 12432: }
12433: }
1.1086 raeburn 12434: } else {
12435: last;
1.1056 raeburn 12436: }
1.1055 raeburn 12437: }
12438: }
1.1086 raeburn 12439: if ($fullpath ne '') {
12440: if (-e "$prefix$path") {
12441: system("mv $prefix$path $fullpath/$title");
12442: }
12443: if (-e "$fullpath/$title") {
12444: my $showpath;
12445: if ($relpath ne '') {
12446: $showpath = "$relpath/$title";
12447: } else {
12448: $showpath = "/$title";
12449: }
12450: $result .= '<li>'.&mt('[_1] included as a dependency',$showpath).'</li>'."\n";
12451: }
12452: unless ($ishome) {
12453: my $fetch = "$fullpath/$title";
12454: $fetch =~ s/^\Q$prefix$dir\E//;
12455: $prompttofetch{$fetch} = 1;
12456: }
12457: }
1.1055 raeburn 12458: }
1.1086 raeburn 12459: } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
12460: $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
12461: $path,$env{'form.archive_content_'.$referrer{$i}}).'<br />';
1.1055 raeburn 12462: }
12463: } else {
12464: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',$path).'<br />';
12465: }
12466: }
12467: if (keys(%todelete)) {
12468: foreach my $key (keys(%todelete)) {
12469: unlink($key);
1.1066 raeburn 12470: }
12471: }
12472: if (keys(%todeletedir)) {
12473: foreach my $key (keys(%todeletedir)) {
12474: rmdir($key);
12475: }
12476: }
12477: foreach my $dir (sort(keys(%is_dir))) {
12478: if (($pathtocheck ne '') && ($dir ne '')) {
12479: &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055 raeburn 12480: }
12481: }
1.1067 raeburn 12482: if ($result ne '') {
12483: $output .= '<ul>'."\n".
12484: $result."\n".
12485: '</ul>';
12486: }
12487: unless ($ishome) {
12488: my $replicationfail;
12489: foreach my $item (keys(%prompttofetch)) {
12490: my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
12491: unless ($fetchresult eq 'ok') {
12492: $replicationfail .= '<li>'.$item.'</li>'."\n";
12493: }
12494: }
12495: if ($replicationfail) {
12496: $output .= '<p class="LC_error">'.
12497: &mt('Course home server failed to retrieve:').'<ul>'.
12498: $replicationfail.
12499: '</ul></p>';
12500: }
12501: }
1.1055 raeburn 12502: } else {
12503: $warning = &mt('No items found in archive.');
12504: }
12505: if ($error) {
12506: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
12507: $error.'</p>'."\n";
12508: }
12509: if ($warning) {
12510: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
12511: }
12512: return $output;
12513: }
12514:
1.1066 raeburn 12515: sub cleanup_empty_dirs {
12516: my ($path) = @_;
12517: if (($path ne '') && (-d $path)) {
12518: if (opendir(my $dirh,$path)) {
12519: my @dircontents = grep(!/^\./,readdir($dirh));
12520: my $numitems = 0;
12521: foreach my $item (@dircontents) {
12522: if (-d "$path/$item") {
1.1111 raeburn 12523: &cleanup_empty_dirs("$path/$item");
1.1066 raeburn 12524: if (-e "$path/$item") {
12525: $numitems ++;
12526: }
12527: } else {
12528: $numitems ++;
12529: }
12530: }
12531: if ($numitems == 0) {
12532: rmdir($path);
12533: }
12534: closedir($dirh);
12535: }
12536: }
12537: return;
12538: }
12539:
1.41 ng 12540: =pod
1.45 matthew 12541:
1.1162 raeburn 12542: =item * &get_folder_hierarchy()
1.1068 raeburn 12543:
12544: Provides hierarchy of names of folders/sub-folders containing the current
12545: item,
12546:
12547: Inputs: 3
12548: - $navmap - navmaps object
12549:
12550: - $map - url for map (either the trigger itself, or map containing
12551: the resource, which is the trigger).
12552:
12553: - $showitem - 1 => show title for map itself; 0 => do not show.
12554:
12555: Outputs: 1 @pathitems - array of folder/subfolder names.
12556:
12557: =cut
12558:
12559: sub get_folder_hierarchy {
12560: my ($navmap,$map,$showitem) = @_;
12561: my @pathitems;
12562: if (ref($navmap)) {
12563: my $mapres = $navmap->getResourceByUrl($map);
12564: if (ref($mapres)) {
12565: my $pcslist = $mapres->map_hierarchy();
12566: if ($pcslist ne '') {
12567: my @pcs = split(/,/,$pcslist);
12568: foreach my $pc (@pcs) {
12569: if ($pc == 1) {
1.1129 raeburn 12570: push(@pathitems,&mt('Main Content'));
1.1068 raeburn 12571: } else {
12572: my $res = $navmap->getByMapPc($pc);
12573: if (ref($res)) {
12574: my $title = $res->compTitle();
12575: $title =~ s/\W+/_/g;
12576: if ($title ne '') {
12577: push(@pathitems,$title);
12578: }
12579: }
12580: }
12581: }
12582: }
1.1071 raeburn 12583: if ($showitem) {
12584: if ($mapres->{ID} eq '0.0') {
1.1129 raeburn 12585: push(@pathitems,&mt('Main Content'));
1.1071 raeburn 12586: } else {
12587: my $maptitle = $mapres->compTitle();
12588: $maptitle =~ s/\W+/_/g;
12589: if ($maptitle ne '') {
12590: push(@pathitems,$maptitle);
12591: }
1.1068 raeburn 12592: }
12593: }
12594: }
12595: }
12596: return @pathitems;
12597: }
12598:
12599: =pod
12600:
1.1015 raeburn 12601: =item * &get_turnedin_filepath()
12602:
12603: Determines path in a user's portfolio file for storage of files uploaded
12604: to a specific essayresponse or dropbox item.
12605:
12606: Inputs: 3 required + 1 optional.
12607: $symb is symb for resource, $uname and $udom are for current user (required).
12608: $caller is optional (can be "submission", if routine is called when storing
12609: an upoaded file when "Submit Answer" button was pressed).
12610:
12611: Returns array containing $path and $multiresp.
12612: $path is path in portfolio. $multiresp is 1 if this resource contains more
12613: than one file upload item. Callers of routine should append partid as a
12614: subdirectory to $path in cases where $multiresp is 1.
12615:
12616: Called by: homework/essayresponse.pm and homework/structuretags.pm
12617:
12618: =cut
12619:
12620: sub get_turnedin_filepath {
12621: my ($symb,$uname,$udom,$caller) = @_;
12622: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
12623: my $turnindir;
12624: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
12625: $turnindir = $userhash{'turnindir'};
12626: my ($path,$multiresp);
12627: if ($turnindir eq '') {
12628: if ($caller eq 'submission') {
12629: $turnindir = &mt('turned in');
12630: $turnindir =~ s/\W+/_/g;
12631: my %newhash = (
12632: 'turnindir' => $turnindir,
12633: );
12634: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
12635: }
12636: }
12637: if ($turnindir ne '') {
12638: $path = '/'.$turnindir.'/';
12639: my ($multipart,$turnin,@pathitems);
12640: my $navmap = Apache::lonnavmaps::navmap->new();
12641: if (defined($navmap)) {
12642: my $mapres = $navmap->getResourceByUrl($map);
12643: if (ref($mapres)) {
12644: my $pcslist = $mapres->map_hierarchy();
12645: if ($pcslist ne '') {
12646: foreach my $pc (split(/,/,$pcslist)) {
12647: my $res = $navmap->getByMapPc($pc);
12648: if (ref($res)) {
12649: my $title = $res->compTitle();
12650: $title =~ s/\W+/_/g;
12651: if ($title ne '') {
1.1149 raeburn 12652: if (($pc > 1) && (length($title) > 12)) {
12653: $title = substr($title,0,12);
12654: }
1.1015 raeburn 12655: push(@pathitems,$title);
12656: }
12657: }
12658: }
12659: }
12660: my $maptitle = $mapres->compTitle();
12661: $maptitle =~ s/\W+/_/g;
12662: if ($maptitle ne '') {
1.1149 raeburn 12663: if (length($maptitle) > 12) {
12664: $maptitle = substr($maptitle,0,12);
12665: }
1.1015 raeburn 12666: push(@pathitems,$maptitle);
12667: }
12668: unless ($env{'request.state'} eq 'construct') {
12669: my $res = $navmap->getBySymb($symb);
12670: if (ref($res)) {
12671: my $partlist = $res->parts();
12672: my $totaluploads = 0;
12673: if (ref($partlist) eq 'ARRAY') {
12674: foreach my $part (@{$partlist}) {
12675: my @types = $res->responseType($part);
12676: my @ids = $res->responseIds($part);
12677: for (my $i=0; $i < scalar(@ids); $i++) {
12678: if ($types[$i] eq 'essay') {
12679: my $partid = $part.'_'.$ids[$i];
12680: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
12681: $totaluploads ++;
12682: }
12683: }
12684: }
12685: }
12686: if ($totaluploads > 1) {
12687: $multiresp = 1;
12688: }
12689: }
12690: }
12691: }
12692: } else {
12693: return;
12694: }
12695: } else {
12696: return;
12697: }
12698: my $restitle=&Apache::lonnet::gettitle($symb);
12699: $restitle =~ s/\W+/_/g;
12700: if ($restitle eq '') {
12701: $restitle = ($resurl =~ m{/[^/]+$});
12702: if ($restitle eq '') {
12703: $restitle = time;
12704: }
12705: }
1.1149 raeburn 12706: if (length($restitle) > 12) {
12707: $restitle = substr($restitle,0,12);
12708: }
1.1015 raeburn 12709: push(@pathitems,$restitle);
12710: $path .= join('/',@pathitems);
12711: }
12712: return ($path,$multiresp);
12713: }
12714:
12715: =pod
12716:
1.464 albertel 12717: =back
1.41 ng 12718:
1.112 bowersj2 12719: =head1 CSV Upload/Handling functions
1.38 albertel 12720:
1.41 ng 12721: =over 4
12722:
1.648 raeburn 12723: =item * &upfile_store($r)
1.41 ng 12724:
12725: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 12726: needs $env{'form.upfile'}
1.41 ng 12727: returns $datatoken to be put into hidden field
12728:
12729: =cut
1.31 albertel 12730:
12731: sub upfile_store {
12732: my $r=shift;
1.258 albertel 12733: $env{'form.upfile'}=~s/\r/\n/gs;
12734: $env{'form.upfile'}=~s/\f/\n/gs;
12735: $env{'form.upfile'}=~s/\n+/\n/gs;
12736: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 12737:
1.258 albertel 12738: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
12739: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 12740: {
1.158 raeburn 12741: my $datafile = $r->dir_config('lonDaemons').
12742: '/tmp/'.$datatoken.'.tmp';
12743: if ( open(my $fh,">$datafile") ) {
1.258 albertel 12744: print $fh $env{'form.upfile'};
1.158 raeburn 12745: close($fh);
12746: }
1.31 albertel 12747: }
12748: return $datatoken;
12749: }
12750:
1.56 matthew 12751: =pod
12752:
1.648 raeburn 12753: =item * &load_tmp_file($r)
1.41 ng 12754:
12755: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 12756: needs $env{'form.datatoken'},
12757: sets $env{'form.upfile'} to the contents of the file
1.41 ng 12758:
12759: =cut
1.31 albertel 12760:
12761: sub load_tmp_file {
12762: my $r=shift;
12763: my @studentdata=();
12764: {
1.158 raeburn 12765: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 12766: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 12767: if ( open(my $fh,"<$studentfile") ) {
12768: @studentdata=<$fh>;
12769: close($fh);
12770: }
1.31 albertel 12771: }
1.258 albertel 12772: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 12773: }
12774:
1.56 matthew 12775: =pod
12776:
1.648 raeburn 12777: =item * &upfile_record_sep()
1.41 ng 12778:
12779: Separate uploaded file into records
12780: returns array of records,
1.258 albertel 12781: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 12782:
12783: =cut
1.31 albertel 12784:
12785: sub upfile_record_sep {
1.258 albertel 12786: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 12787: } else {
1.248 albertel 12788: my @records;
1.258 albertel 12789: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 12790: if ($line=~/^\s*$/) { next; }
12791: push(@records,$line);
12792: }
12793: return @records;
1.31 albertel 12794: }
12795: }
12796:
1.56 matthew 12797: =pod
12798:
1.648 raeburn 12799: =item * &record_sep($record)
1.41 ng 12800:
1.258 albertel 12801: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 12802:
12803: =cut
12804:
1.263 www 12805: sub takeleft {
12806: my $index=shift;
12807: return substr('0000'.$index,-4,4);
12808: }
12809:
1.31 albertel 12810: sub record_sep {
12811: my $record=shift;
12812: my %components=();
1.258 albertel 12813: if ($env{'form.upfiletype'} eq 'xml') {
12814: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 12815: my $i=0;
1.356 albertel 12816: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 12817: $field=~s/^(\"|\')//;
12818: $field=~s/(\"|\')$//;
1.263 www 12819: $components{&takeleft($i)}=$field;
1.31 albertel 12820: $i++;
12821: }
1.258 albertel 12822: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 12823: my $i=0;
1.356 albertel 12824: foreach my $field (split(/\t/,$record)) {
1.31 albertel 12825: $field=~s/^(\"|\')//;
12826: $field=~s/(\"|\')$//;
1.263 www 12827: $components{&takeleft($i)}=$field;
1.31 albertel 12828: $i++;
12829: }
12830: } else {
1.561 www 12831: my $separator=',';
1.480 banghart 12832: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 12833: $separator=';';
1.480 banghart 12834: }
1.31 albertel 12835: my $i=0;
1.561 www 12836: # the character we are looking for to indicate the end of a quote or a record
12837: my $looking_for=$separator;
12838: # do not add the characters to the fields
12839: my $ignore=0;
12840: # we just encountered a separator (or the beginning of the record)
12841: my $just_found_separator=1;
12842: # store the field we are working on here
12843: my $field='';
12844: # work our way through all characters in record
12845: foreach my $character ($record=~/(.)/g) {
12846: if ($character eq $looking_for) {
12847: if ($character ne $separator) {
12848: # Found the end of a quote, again looking for separator
12849: $looking_for=$separator;
12850: $ignore=1;
12851: } else {
12852: # Found a separator, store away what we got
12853: $components{&takeleft($i)}=$field;
12854: $i++;
12855: $just_found_separator=1;
12856: $ignore=0;
12857: $field='';
12858: }
12859: next;
12860: }
12861: # single or double quotation marks after a separator indicate beginning of a quote
12862: # we are now looking for the end of the quote and need to ignore separators
12863: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
12864: $looking_for=$character;
12865: next;
12866: }
12867: # ignore would be true after we reached the end of a quote
12868: if ($ignore) { next; }
12869: if (($just_found_separator) && ($character=~/\s/)) { next; }
12870: $field.=$character;
12871: $just_found_separator=0;
1.31 albertel 12872: }
1.561 www 12873: # catch the very last entry, since we never encountered the separator
12874: $components{&takeleft($i)}=$field;
1.31 albertel 12875: }
12876: return %components;
12877: }
12878:
1.144 matthew 12879: ######################################################
12880: ######################################################
12881:
1.56 matthew 12882: =pod
12883:
1.648 raeburn 12884: =item * &upfile_select_html()
1.41 ng 12885:
1.144 matthew 12886: Return HTML code to select a file from the users machine and specify
12887: the file type.
1.41 ng 12888:
12889: =cut
12890:
1.144 matthew 12891: ######################################################
12892: ######################################################
1.31 albertel 12893: sub upfile_select_html {
1.144 matthew 12894: my %Types = (
12895: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 12896: semisv => &mt('Semicolon separated values'),
1.144 matthew 12897: space => &mt('Space separated'),
12898: tab => &mt('Tabulator separated'),
12899: # xml => &mt('HTML/XML'),
12900: );
12901: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 12902: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 12903: foreach my $type (sort(keys(%Types))) {
12904: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
12905: }
12906: $Str .= "</select>\n";
12907: return $Str;
1.31 albertel 12908: }
12909:
1.301 albertel 12910: sub get_samples {
12911: my ($records,$toget) = @_;
12912: my @samples=({});
12913: my $got=0;
12914: foreach my $rec (@$records) {
12915: my %temp = &record_sep($rec);
12916: if (! grep(/\S/, values(%temp))) { next; }
12917: if (%temp) {
12918: $samples[$got]=\%temp;
12919: $got++;
12920: if ($got == $toget) { last; }
12921: }
12922: }
12923: return \@samples;
12924: }
12925:
1.144 matthew 12926: ######################################################
12927: ######################################################
12928:
1.56 matthew 12929: =pod
12930:
1.648 raeburn 12931: =item * &csv_print_samples($r,$records)
1.41 ng 12932:
12933: Prints a table of sample values from each column uploaded $r is an
12934: Apache Request ref, $records is an arrayref from
12935: &Apache::loncommon::upfile_record_sep
12936:
12937: =cut
12938:
1.144 matthew 12939: ######################################################
12940: ######################################################
1.31 albertel 12941: sub csv_print_samples {
12942: my ($r,$records) = @_;
1.662 bisitz 12943: my $samples = &get_samples($records,5);
1.301 albertel 12944:
1.594 raeburn 12945: $r->print(&mt('Samples').'<br />'.&start_data_table().
12946: &start_data_table_header_row());
1.356 albertel 12947: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 12948: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 12949: $r->print(&end_data_table_header_row());
1.301 albertel 12950: foreach my $hash (@$samples) {
1.594 raeburn 12951: $r->print(&start_data_table_row());
1.356 albertel 12952: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 12953: $r->print('<td>');
1.356 albertel 12954: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 12955: $r->print('</td>');
12956: }
1.594 raeburn 12957: $r->print(&end_data_table_row());
1.31 albertel 12958: }
1.594 raeburn 12959: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 12960: }
12961:
1.144 matthew 12962: ######################################################
12963: ######################################################
12964:
1.56 matthew 12965: =pod
12966:
1.648 raeburn 12967: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 12968:
12969: Prints a table to create associations between values and table columns.
1.144 matthew 12970:
1.41 ng 12971: $r is an Apache Request ref,
12972: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 12973: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 12974:
12975: =cut
12976:
1.144 matthew 12977: ######################################################
12978: ######################################################
1.31 albertel 12979: sub csv_print_select_table {
12980: my ($r,$records,$d) = @_;
1.301 albertel 12981: my $i=0;
12982: my $samples = &get_samples($records,1);
1.144 matthew 12983: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 12984: &start_data_table().&start_data_table_header_row().
1.144 matthew 12985: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 12986: '<th>'.&mt('Column').'</th>'.
12987: &end_data_table_header_row()."\n");
1.356 albertel 12988: foreach my $array_ref (@$d) {
12989: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 12990: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 12991:
1.875 bisitz 12992: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 12993: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 12994: $r->print('<option value="none"></option>');
1.356 albertel 12995: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
12996: $r->print('<option value="'.$sample.'"'.
12997: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 12998: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 12999: }
1.594 raeburn 13000: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 13001: $i++;
13002: }
1.594 raeburn 13003: $r->print(&end_data_table());
1.31 albertel 13004: $i--;
13005: return $i;
13006: }
1.56 matthew 13007:
1.144 matthew 13008: ######################################################
13009: ######################################################
13010:
1.56 matthew 13011: =pod
1.31 albertel 13012:
1.648 raeburn 13013: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 13014:
13015: Prints a table of sample values from the upload and can make associate samples to internal names.
13016:
13017: $r is an Apache Request ref,
13018: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
13019: $d is an array of 2 element arrays (internal name, displayed name)
13020:
13021: =cut
13022:
1.144 matthew 13023: ######################################################
13024: ######################################################
1.31 albertel 13025: sub csv_samples_select_table {
13026: my ($r,$records,$d) = @_;
13027: my $i=0;
1.144 matthew 13028: #
1.662 bisitz 13029: my $max_samples = 5;
13030: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 13031: $r->print(&start_data_table().
13032: &start_data_table_header_row().'<th>'.
13033: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
13034: &end_data_table_header_row());
1.301 albertel 13035:
13036: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 13037: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 13038: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 13039: foreach my $option (@$d) {
13040: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 13041: $r->print('<option value="'.$value.'"'.
1.253 albertel 13042: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 13043: $display.'</option>');
1.31 albertel 13044: }
13045: $r->print('</select></td><td>');
1.662 bisitz 13046: foreach my $line (0..($max_samples-1)) {
1.301 albertel 13047: if (defined($samples->[$line]{$key})) {
13048: $r->print($samples->[$line]{$key}."<br />\n");
13049: }
13050: }
1.594 raeburn 13051: $r->print('</td>'.&end_data_table_row());
1.31 albertel 13052: $i++;
13053: }
1.594 raeburn 13054: $r->print(&end_data_table());
1.31 albertel 13055: $i--;
13056: return($i);
1.115 matthew 13057: }
13058:
1.144 matthew 13059: ######################################################
13060: ######################################################
13061:
1.115 matthew 13062: =pod
13063:
1.648 raeburn 13064: =item * &clean_excel_name($name)
1.115 matthew 13065:
13066: Returns a replacement for $name which does not contain any illegal characters.
13067:
13068: =cut
13069:
1.144 matthew 13070: ######################################################
13071: ######################################################
1.115 matthew 13072: sub clean_excel_name {
13073: my ($name) = @_;
13074: $name =~ s/[:\*\?\/\\]//g;
13075: if (length($name) > 31) {
13076: $name = substr($name,0,31);
13077: }
13078: return $name;
1.25 albertel 13079: }
1.84 albertel 13080:
1.85 albertel 13081: =pod
13082:
1.648 raeburn 13083: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 13084:
13085: Returns either 1 or undef
13086:
13087: 1 if the part is to be hidden, undef if it is to be shown
13088:
13089: Arguments are:
13090:
13091: $id the id of the part to be checked
13092: $symb, optional the symb of the resource to check
13093: $udom, optional the domain of the user to check for
13094: $uname, optional the username of the user to check for
13095:
13096: =cut
1.84 albertel 13097:
13098: sub check_if_partid_hidden {
13099: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 13100: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 13101: $symb,$udom,$uname);
1.141 albertel 13102: my $truth=1;
13103: #if the string starts with !, then the list is the list to show not hide
13104: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 13105: my @hiddenlist=split(/,/,$hiddenparts);
13106: foreach my $checkid (@hiddenlist) {
1.141 albertel 13107: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 13108: }
1.141 albertel 13109: return !$truth;
1.84 albertel 13110: }
1.127 matthew 13111:
1.138 matthew 13112:
13113: ############################################################
13114: ############################################################
13115:
13116: =pod
13117:
1.157 matthew 13118: =back
13119:
1.138 matthew 13120: =head1 cgi-bin script and graphing routines
13121:
1.157 matthew 13122: =over 4
13123:
1.648 raeburn 13124: =item * &get_cgi_id()
1.138 matthew 13125:
13126: Inputs: none
13127:
13128: Returns an id which can be used to pass environment variables
13129: to various cgi-bin scripts. These environment variables will
13130: be removed from the users environment after a given time by
13131: the routine &Apache::lonnet::transfer_profile_to_env.
13132:
13133: =cut
13134:
13135: ############################################################
13136: ############################################################
1.152 albertel 13137: my $uniq=0;
1.136 matthew 13138: sub get_cgi_id {
1.154 albertel 13139: $uniq=($uniq+1)%100000;
1.280 albertel 13140: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 13141: }
13142:
1.127 matthew 13143: ############################################################
13144: ############################################################
13145:
13146: =pod
13147:
1.648 raeburn 13148: =item * &DrawBarGraph()
1.127 matthew 13149:
1.138 matthew 13150: Facilitates the plotting of data in a (stacked) bar graph.
13151: Puts plot definition data into the users environment in order for
13152: graph.png to plot it. Returns an <img> tag for the plot.
13153: The bars on the plot are labeled '1','2',...,'n'.
13154:
13155: Inputs:
13156:
13157: =over 4
13158:
13159: =item $Title: string, the title of the plot
13160:
13161: =item $xlabel: string, text describing the X-axis of the plot
13162:
13163: =item $ylabel: string, text describing the Y-axis of the plot
13164:
13165: =item $Max: scalar, the maximum Y value to use in the plot
13166: If $Max is < any data point, the graph will not be rendered.
13167:
1.140 matthew 13168: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 13169: they are plotted. If undefined, default values will be used.
13170:
1.178 matthew 13171: =item $labels: array ref holding the labels to use on the x-axis for the bars.
13172:
1.138 matthew 13173: =item @Values: An array of array references. Each array reference holds data
13174: to be plotted in a stacked bar chart.
13175:
1.239 matthew 13176: =item If the final element of @Values is a hash reference the key/value
13177: pairs will be added to the graph definition.
13178:
1.138 matthew 13179: =back
13180:
13181: Returns:
13182:
13183: An <img> tag which references graph.png and the appropriate identifying
13184: information for the plot.
13185:
1.127 matthew 13186: =cut
13187:
13188: ############################################################
13189: ############################################################
1.134 matthew 13190: sub DrawBarGraph {
1.178 matthew 13191: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 13192: #
13193: if (! defined($colors)) {
13194: $colors = ['#33ff00',
13195: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
13196: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
13197: ];
13198: }
1.228 matthew 13199: my $extra_settings = {};
13200: if (ref($Values[-1]) eq 'HASH') {
13201: $extra_settings = pop(@Values);
13202: }
1.127 matthew 13203: #
1.136 matthew 13204: my $identifier = &get_cgi_id();
13205: my $id = 'cgi.'.$identifier;
1.129 matthew 13206: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 13207: return '';
13208: }
1.225 matthew 13209: #
13210: my @Labels;
13211: if (defined($labels)) {
13212: @Labels = @$labels;
13213: } else {
13214: for (my $i=0;$i<@{$Values[0]};$i++) {
13215: push (@Labels,$i+1);
13216: }
13217: }
13218: #
1.129 matthew 13219: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 13220: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 13221: my %ValuesHash;
13222: my $NumSets=1;
13223: foreach my $array (@Values) {
13224: next if (! ref($array));
1.136 matthew 13225: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 13226: join(',',@$array);
1.129 matthew 13227: }
1.127 matthew 13228: #
1.136 matthew 13229: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 13230: if ($NumBars < 3) {
13231: $width = 120+$NumBars*32;
1.220 matthew 13232: $xskip = 1;
1.225 matthew 13233: $bar_width = 30;
13234: } elsif ($NumBars < 5) {
13235: $width = 120+$NumBars*20;
13236: $xskip = 1;
13237: $bar_width = 20;
1.220 matthew 13238: } elsif ($NumBars < 10) {
1.136 matthew 13239: $width = 120+$NumBars*15;
13240: $xskip = 1;
13241: $bar_width = 15;
13242: } elsif ($NumBars <= 25) {
13243: $width = 120+$NumBars*11;
13244: $xskip = 5;
13245: $bar_width = 8;
13246: } elsif ($NumBars <= 50) {
13247: $width = 120+$NumBars*8;
13248: $xskip = 5;
13249: $bar_width = 4;
13250: } else {
13251: $width = 120+$NumBars*8;
13252: $xskip = 5;
13253: $bar_width = 4;
13254: }
13255: #
1.137 matthew 13256: $Max = 1 if ($Max < 1);
13257: if ( int($Max) < $Max ) {
13258: $Max++;
13259: $Max = int($Max);
13260: }
1.127 matthew 13261: $Title = '' if (! defined($Title));
13262: $xlabel = '' if (! defined($xlabel));
13263: $ylabel = '' if (! defined($ylabel));
1.369 www 13264: $ValuesHash{$id.'.title'} = &escape($Title);
13265: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
13266: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 13267: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 13268: $ValuesHash{$id.'.NumBars'} = $NumBars;
13269: $ValuesHash{$id.'.NumSets'} = $NumSets;
13270: $ValuesHash{$id.'.PlotType'} = 'bar';
13271: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
13272: $ValuesHash{$id.'.height'} = $height;
13273: $ValuesHash{$id.'.width'} = $width;
13274: $ValuesHash{$id.'.xskip'} = $xskip;
13275: $ValuesHash{$id.'.bar_width'} = $bar_width;
13276: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 13277: #
1.228 matthew 13278: # Deal with other parameters
13279: while (my ($key,$value) = each(%$extra_settings)) {
13280: $ValuesHash{$id.'.'.$key} = $value;
13281: }
13282: #
1.646 raeburn 13283: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 13284: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
13285: }
13286:
13287: ############################################################
13288: ############################################################
13289:
13290: =pod
13291:
1.648 raeburn 13292: =item * &DrawXYGraph()
1.137 matthew 13293:
1.138 matthew 13294: Facilitates the plotting of data in an XY graph.
13295: Puts plot definition data into the users environment in order for
13296: graph.png to plot it. Returns an <img> tag for the plot.
13297:
13298: Inputs:
13299:
13300: =over 4
13301:
13302: =item $Title: string, the title of the plot
13303:
13304: =item $xlabel: string, text describing the X-axis of the plot
13305:
13306: =item $ylabel: string, text describing the Y-axis of the plot
13307:
13308: =item $Max: scalar, the maximum Y value to use in the plot
13309: If $Max is < any data point, the graph will not be rendered.
13310:
13311: =item $colors: Array ref containing the hex color codes for the data to be
13312: plotted in. If undefined, default values will be used.
13313:
13314: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
13315:
13316: =item $Ydata: Array ref containing Array refs.
1.185 www 13317: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 13318:
13319: =item %Values: hash indicating or overriding any default values which are
13320: passed to graph.png.
13321: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
13322:
13323: =back
13324:
13325: Returns:
13326:
13327: An <img> tag which references graph.png and the appropriate identifying
13328: information for the plot.
13329:
1.137 matthew 13330: =cut
13331:
13332: ############################################################
13333: ############################################################
13334: sub DrawXYGraph {
13335: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
13336: #
13337: # Create the identifier for the graph
13338: my $identifier = &get_cgi_id();
13339: my $id = 'cgi.'.$identifier;
13340: #
13341: $Title = '' if (! defined($Title));
13342: $xlabel = '' if (! defined($xlabel));
13343: $ylabel = '' if (! defined($ylabel));
13344: my %ValuesHash =
13345: (
1.369 www 13346: $id.'.title' => &escape($Title),
13347: $id.'.xlabel' => &escape($xlabel),
13348: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 13349: $id.'.y_max_value'=> $Max,
13350: $id.'.labels' => join(',',@$Xlabels),
13351: $id.'.PlotType' => 'XY',
13352: );
13353: #
13354: if (defined($colors) && ref($colors) eq 'ARRAY') {
13355: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
13356: }
13357: #
13358: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
13359: return '';
13360: }
13361: my $NumSets=1;
1.138 matthew 13362: foreach my $array (@{$Ydata}){
1.137 matthew 13363: next if (! ref($array));
13364: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
13365: }
1.138 matthew 13366: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 13367: #
13368: # Deal with other parameters
13369: while (my ($key,$value) = each(%Values)) {
13370: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 13371: }
13372: #
1.646 raeburn 13373: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 13374: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
13375: }
13376:
13377: ############################################################
13378: ############################################################
13379:
13380: =pod
13381:
1.648 raeburn 13382: =item * &DrawXYYGraph()
1.138 matthew 13383:
13384: Facilitates the plotting of data in an XY graph with two Y axes.
13385: Puts plot definition data into the users environment in order for
13386: graph.png to plot it. Returns an <img> tag for the plot.
13387:
13388: Inputs:
13389:
13390: =over 4
13391:
13392: =item $Title: string, the title of the plot
13393:
13394: =item $xlabel: string, text describing the X-axis of the plot
13395:
13396: =item $ylabel: string, text describing the Y-axis of the plot
13397:
13398: =item $colors: Array ref containing the hex color codes for the data to be
13399: plotted in. If undefined, default values will be used.
13400:
13401: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
13402:
13403: =item $Ydata1: The first data set
13404:
13405: =item $Min1: The minimum value of the left Y-axis
13406:
13407: =item $Max1: The maximum value of the left Y-axis
13408:
13409: =item $Ydata2: The second data set
13410:
13411: =item $Min2: The minimum value of the right Y-axis
13412:
13413: =item $Max2: The maximum value of the left Y-axis
13414:
13415: =item %Values: hash indicating or overriding any default values which are
13416: passed to graph.png.
13417: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
13418:
13419: =back
13420:
13421: Returns:
13422:
13423: An <img> tag which references graph.png and the appropriate identifying
13424: information for the plot.
1.136 matthew 13425:
13426: =cut
13427:
13428: ############################################################
13429: ############################################################
1.137 matthew 13430: sub DrawXYYGraph {
13431: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
13432: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 13433: #
13434: # Create the identifier for the graph
13435: my $identifier = &get_cgi_id();
13436: my $id = 'cgi.'.$identifier;
13437: #
13438: $Title = '' if (! defined($Title));
13439: $xlabel = '' if (! defined($xlabel));
13440: $ylabel = '' if (! defined($ylabel));
13441: my %ValuesHash =
13442: (
1.369 www 13443: $id.'.title' => &escape($Title),
13444: $id.'.xlabel' => &escape($xlabel),
13445: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 13446: $id.'.labels' => join(',',@$Xlabels),
13447: $id.'.PlotType' => 'XY',
13448: $id.'.NumSets' => 2,
1.137 matthew 13449: $id.'.two_axes' => 1,
13450: $id.'.y1_max_value' => $Max1,
13451: $id.'.y1_min_value' => $Min1,
13452: $id.'.y2_max_value' => $Max2,
13453: $id.'.y2_min_value' => $Min2,
1.136 matthew 13454: );
13455: #
1.137 matthew 13456: if (defined($colors) && ref($colors) eq 'ARRAY') {
13457: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
13458: }
13459: #
13460: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
13461: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 13462: return '';
13463: }
13464: my $NumSets=1;
1.137 matthew 13465: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 13466: next if (! ref($array));
13467: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 13468: }
13469: #
13470: # Deal with other parameters
13471: while (my ($key,$value) = each(%Values)) {
13472: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 13473: }
13474: #
1.646 raeburn 13475: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 13476: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 13477: }
13478:
13479: ############################################################
13480: ############################################################
13481:
13482: =pod
13483:
1.157 matthew 13484: =back
13485:
1.139 matthew 13486: =head1 Statistics helper routines?
13487:
13488: Bad place for them but what the hell.
13489:
1.157 matthew 13490: =over 4
13491:
1.648 raeburn 13492: =item * &chartlink()
1.139 matthew 13493:
13494: Returns a link to the chart for a specific student.
13495:
13496: Inputs:
13497:
13498: =over 4
13499:
13500: =item $linktext: The text of the link
13501:
13502: =item $sname: The students username
13503:
13504: =item $sdomain: The students domain
13505:
13506: =back
13507:
1.157 matthew 13508: =back
13509:
1.139 matthew 13510: =cut
13511:
13512: ############################################################
13513: ############################################################
13514: sub chartlink {
13515: my ($linktext, $sname, $sdomain) = @_;
13516: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 13517: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 13518: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 13519: '">'.$linktext.'</a>';
1.153 matthew 13520: }
13521:
13522: #######################################################
13523: #######################################################
13524:
13525: =pod
13526:
13527: =head1 Course Environment Routines
1.157 matthew 13528:
13529: =over 4
1.153 matthew 13530:
1.648 raeburn 13531: =item * &restore_course_settings()
1.153 matthew 13532:
1.648 raeburn 13533: =item * &store_course_settings()
1.153 matthew 13534:
13535: Restores/Store indicated form parameters from the course environment.
13536: Will not overwrite existing values of the form parameters.
13537:
13538: Inputs:
13539: a scalar describing the data (e.g. 'chart', 'problem_analysis')
13540:
13541: a hash ref describing the data to be stored. For example:
13542:
13543: %Save_Parameters = ('Status' => 'scalar',
13544: 'chartoutputmode' => 'scalar',
13545: 'chartoutputdata' => 'scalar',
13546: 'Section' => 'array',
1.373 raeburn 13547: 'Group' => 'array',
1.153 matthew 13548: 'StudentData' => 'array',
13549: 'Maps' => 'array');
13550:
13551: Returns: both routines return nothing
13552:
1.631 raeburn 13553: =back
13554:
1.153 matthew 13555: =cut
13556:
13557: #######################################################
13558: #######################################################
13559: sub store_course_settings {
1.496 albertel 13560: return &store_settings($env{'request.course.id'},@_);
13561: }
13562:
13563: sub store_settings {
1.153 matthew 13564: # save to the environment
13565: # appenv the same items, just to be safe
1.300 albertel 13566: my $udom = $env{'user.domain'};
13567: my $uname = $env{'user.name'};
1.496 albertel 13568: my ($context,$prefix,$Settings) = @_;
1.153 matthew 13569: my %SaveHash;
13570: my %AppHash;
13571: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 13572: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 13573: my $envname = 'environment.'.$basename;
1.258 albertel 13574: if (exists($env{'form.'.$setting})) {
1.153 matthew 13575: # Save this value away
13576: if ($type eq 'scalar' &&
1.258 albertel 13577: (! exists($env{$envname}) ||
13578: $env{$envname} ne $env{'form.'.$setting})) {
13579: $SaveHash{$basename} = $env{'form.'.$setting};
13580: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 13581: } elsif ($type eq 'array') {
13582: my $stored_form;
1.258 albertel 13583: if (ref($env{'form.'.$setting})) {
1.153 matthew 13584: $stored_form = join(',',
13585: map {
1.369 www 13586: &escape($_);
1.258 albertel 13587: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 13588: } else {
13589: $stored_form =
1.369 www 13590: &escape($env{'form.'.$setting});
1.153 matthew 13591: }
13592: # Determine if the array contents are the same.
1.258 albertel 13593: if ($stored_form ne $env{$envname}) {
1.153 matthew 13594: $SaveHash{$basename} = $stored_form;
13595: $AppHash{$envname} = $stored_form;
13596: }
13597: }
13598: }
13599: }
13600: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 13601: $udom,$uname);
1.153 matthew 13602: if ($put_result !~ /^(ok|delayed)/) {
13603: &Apache::lonnet::logthis('unable to save form parameters, '.
13604: 'got error:'.$put_result);
13605: }
13606: # Make sure these settings stick around in this session, too
1.646 raeburn 13607: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 13608: return;
13609: }
13610:
13611: sub restore_course_settings {
1.499 albertel 13612: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 13613: }
13614:
13615: sub restore_settings {
13616: my ($context,$prefix,$Settings) = @_;
1.153 matthew 13617: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 13618: next if (exists($env{'form.'.$setting}));
1.496 albertel 13619: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 13620: '.'.$setting;
1.258 albertel 13621: if (exists($env{$envname})) {
1.153 matthew 13622: if ($type eq 'scalar') {
1.258 albertel 13623: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 13624: } elsif ($type eq 'array') {
1.258 albertel 13625: $env{'form.'.$setting} = [
1.153 matthew 13626: map {
1.369 www 13627: &unescape($_);
1.258 albertel 13628: } split(',',$env{$envname})
1.153 matthew 13629: ];
13630: }
13631: }
13632: }
1.127 matthew 13633: }
13634:
1.618 raeburn 13635: #######################################################
13636: #######################################################
13637:
13638: =pod
13639:
13640: =head1 Domain E-mail Routines
13641:
13642: =over 4
13643:
1.648 raeburn 13644: =item * &build_recipient_list()
1.618 raeburn 13645:
1.1144 raeburn 13646: Build recipient lists for following types of e-mail:
1.766 raeburn 13647: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1144 raeburn 13648: (d) Help requests, (e) Course requests needing approval, (f) loncapa
13649: module change checking, student/employee ID conflict checks, as
13650: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
13651: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618 raeburn 13652:
13653: Inputs:
1.619 raeburn 13654: defmail (scalar - email address of default recipient),
1.1144 raeburn 13655: mailing type (scalar: errormail, packagesmail, helpdeskmail,
13656: requestsmail, updatesmail, or idconflictsmail).
13657:
1.619 raeburn 13658: defdom (domain for which to retrieve configuration settings),
1.1144 raeburn 13659:
1.619 raeburn 13660: origmail (scalar - email address of recipient from loncapa.conf,
13661: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 13662:
1.655 raeburn 13663: Returns: comma separated list of addresses to which to send e-mail.
13664:
13665: =back
1.618 raeburn 13666:
13667: =cut
13668:
13669: ############################################################
13670: ############################################################
13671: sub build_recipient_list {
1.619 raeburn 13672: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 13673: my @recipients;
13674: my $otheremails;
13675: my %domconfig =
13676: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
13677: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 13678: if (exists($domconfig{'contacts'}{$mailing})) {
13679: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
13680: my @contacts = ('adminemail','supportemail');
13681: foreach my $item (@contacts) {
13682: if ($domconfig{'contacts'}{$mailing}{$item}) {
13683: my $addr = $domconfig{'contacts'}{$item};
13684: if (!grep(/^\Q$addr\E$/,@recipients)) {
13685: push(@recipients,$addr);
13686: }
1.619 raeburn 13687: }
1.766 raeburn 13688: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 13689: }
13690: }
1.766 raeburn 13691: } elsif ($origmail ne '') {
13692: push(@recipients,$origmail);
1.618 raeburn 13693: }
1.619 raeburn 13694: } elsif ($origmail ne '') {
13695: push(@recipients,$origmail);
1.618 raeburn 13696: }
1.688 raeburn 13697: if (defined($defmail)) {
13698: if ($defmail ne '') {
13699: push(@recipients,$defmail);
13700: }
1.618 raeburn 13701: }
13702: if ($otheremails) {
1.619 raeburn 13703: my @others;
13704: if ($otheremails =~ /,/) {
13705: @others = split(/,/,$otheremails);
1.618 raeburn 13706: } else {
1.619 raeburn 13707: push(@others,$otheremails);
13708: }
13709: foreach my $addr (@others) {
13710: if (!grep(/^\Q$addr\E$/,@recipients)) {
13711: push(@recipients,$addr);
13712: }
1.618 raeburn 13713: }
13714: }
1.619 raeburn 13715: my $recipientlist = join(',',@recipients);
1.618 raeburn 13716: return $recipientlist;
13717: }
13718:
1.127 matthew 13719: ############################################################
13720: ############################################################
1.154 albertel 13721:
1.655 raeburn 13722: =pod
13723:
13724: =head1 Course Catalog Routines
13725:
13726: =over 4
13727:
13728: =item * &gather_categories()
13729:
13730: Converts category definitions - keys of categories hash stored in
13731: coursecategories in configuration.db on the primary library server in a
13732: domain - to an array. Also generates javascript and idx hash used to
13733: generate Domain Coordinator interface for editing Course Categories.
13734:
13735: Inputs:
1.663 raeburn 13736:
1.655 raeburn 13737: categories (reference to hash of category definitions).
1.663 raeburn 13738:
1.655 raeburn 13739: cats (reference to array of arrays/hashes which encapsulates hierarchy of
13740: categories and subcategories).
1.663 raeburn 13741:
1.655 raeburn 13742: idx (reference to hash of counters used in Domain Coordinator interface for
13743: editing Course Categories).
1.663 raeburn 13744:
1.655 raeburn 13745: jsarray (reference to array of categories used to create Javascript arrays for
13746: Domain Coordinator interface for editing Course Categories).
13747:
13748: Returns: nothing
13749:
13750: Side effects: populates cats, idx and jsarray.
13751:
13752: =cut
13753:
13754: sub gather_categories {
13755: my ($categories,$cats,$idx,$jsarray) = @_;
13756: my %counters;
13757: my $num = 0;
13758: foreach my $item (keys(%{$categories})) {
13759: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
13760: if ($container eq '' && $depth == 0) {
13761: $cats->[$depth][$categories->{$item}] = $cat;
13762: } else {
13763: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
13764: }
13765: my ($escitem,$tail) = split(/:/,$item,2);
13766: if ($counters{$tail} eq '') {
13767: $counters{$tail} = $num;
13768: $num ++;
13769: }
13770: if (ref($idx) eq 'HASH') {
13771: $idx->{$item} = $counters{$tail};
13772: }
13773: if (ref($jsarray) eq 'ARRAY') {
13774: push(@{$jsarray->[$counters{$tail}]},$item);
13775: }
13776: }
13777: return;
13778: }
13779:
13780: =pod
13781:
13782: =item * &extract_categories()
13783:
13784: Used to generate breadcrumb trails for course categories.
13785:
13786: Inputs:
1.663 raeburn 13787:
1.655 raeburn 13788: categories (reference to hash of category definitions).
1.663 raeburn 13789:
1.655 raeburn 13790: cats (reference to array of arrays/hashes which encapsulates hierarchy of
13791: categories and subcategories).
1.663 raeburn 13792:
1.655 raeburn 13793: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 13794:
1.655 raeburn 13795: allitems (reference to hash - key is category key
13796: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 13797:
1.655 raeburn 13798: idx (reference to hash of counters used in Domain Coordinator interface for
13799: editing Course Categories).
1.663 raeburn 13800:
1.655 raeburn 13801: jsarray (reference to array of categories used to create Javascript arrays for
13802: Domain Coordinator interface for editing Course Categories).
13803:
1.665 raeburn 13804: subcats (reference to hash of arrays containing all subcategories within each
13805: category, -recursive)
13806:
1.655 raeburn 13807: Returns: nothing
13808:
13809: Side effects: populates trails and allitems hash references.
13810:
13811: =cut
13812:
13813: sub extract_categories {
1.665 raeburn 13814: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 13815: if (ref($categories) eq 'HASH') {
13816: &gather_categories($categories,$cats,$idx,$jsarray);
13817: if (ref($cats->[0]) eq 'ARRAY') {
13818: for (my $i=0; $i<@{$cats->[0]}; $i++) {
13819: my $name = $cats->[0][$i];
13820: my $item = &escape($name).'::0';
13821: my $trailstr;
13822: if ($name eq 'instcode') {
13823: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 13824: } elsif ($name eq 'communities') {
13825: $trailstr = &mt('Communities');
1.655 raeburn 13826: } else {
13827: $trailstr = $name;
13828: }
13829: if ($allitems->{$item} eq '') {
13830: push(@{$trails},$trailstr);
13831: $allitems->{$item} = scalar(@{$trails})-1;
13832: }
13833: my @parents = ($name);
13834: if (ref($cats->[1]{$name}) eq 'ARRAY') {
13835: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
13836: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 13837: if (ref($subcats) eq 'HASH') {
13838: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
13839: }
13840: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
13841: }
13842: } else {
13843: if (ref($subcats) eq 'HASH') {
13844: $subcats->{$item} = [];
1.655 raeburn 13845: }
13846: }
13847: }
13848: }
13849: }
13850: return;
13851: }
13852:
13853: =pod
13854:
1.1162 raeburn 13855: =item * &recurse_categories()
1.655 raeburn 13856:
13857: Recursively used to generate breadcrumb trails for course categories.
13858:
13859: Inputs:
1.663 raeburn 13860:
1.655 raeburn 13861: cats (reference to array of arrays/hashes which encapsulates hierarchy of
13862: categories and subcategories).
1.663 raeburn 13863:
1.655 raeburn 13864: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 13865:
13866: category (current course category, for which breadcrumb trail is being generated).
13867:
13868: trails (reference to array of breadcrumb trails for each category).
13869:
1.655 raeburn 13870: allitems (reference to hash - key is category key
13871: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 13872:
1.655 raeburn 13873: parents (array containing containers directories for current category,
13874: back to top level).
13875:
13876: Returns: nothing
13877:
13878: Side effects: populates trails and allitems hash references
13879:
13880: =cut
13881:
13882: sub recurse_categories {
1.665 raeburn 13883: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 13884: my $shallower = $depth - 1;
13885: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
13886: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
13887: my $name = $cats->[$depth]{$category}[$k];
13888: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
13889: my $trailstr = join(' -> ',(@{$parents},$category));
13890: if ($allitems->{$item} eq '') {
13891: push(@{$trails},$trailstr);
13892: $allitems->{$item} = scalar(@{$trails})-1;
13893: }
13894: my $deeper = $depth+1;
13895: push(@{$parents},$category);
1.665 raeburn 13896: if (ref($subcats) eq 'HASH') {
13897: my $subcat = &escape($name).':'.$category.':'.$depth;
13898: for (my $j=@{$parents}; $j>=0; $j--) {
13899: my $higher;
13900: if ($j > 0) {
13901: $higher = &escape($parents->[$j]).':'.
13902: &escape($parents->[$j-1]).':'.$j;
13903: } else {
13904: $higher = &escape($parents->[$j]).'::'.$j;
13905: }
13906: push(@{$subcats->{$higher}},$subcat);
13907: }
13908: }
13909: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
13910: $subcats);
1.655 raeburn 13911: pop(@{$parents});
13912: }
13913: } else {
13914: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
13915: my $trailstr = join(' -> ',(@{$parents},$category));
13916: if ($allitems->{$item} eq '') {
13917: push(@{$trails},$trailstr);
13918: $allitems->{$item} = scalar(@{$trails})-1;
13919: }
13920: }
13921: return;
13922: }
13923:
1.663 raeburn 13924: =pod
13925:
1.1162 raeburn 13926: =item * &assign_categories_table()
1.663 raeburn 13927:
13928: Create a datatable for display of hierarchical categories in a domain,
13929: with checkboxes to allow a course to be categorized.
13930:
13931: Inputs:
13932:
13933: cathash - reference to hash of categories defined for the domain (from
13934: configuration.db)
13935:
13936: currcat - scalar with an & separated list of categories assigned to a course.
13937:
1.919 raeburn 13938: type - scalar contains course type (Course or Community).
13939:
1.663 raeburn 13940: Returns: $output (markup to be displayed)
13941:
13942: =cut
13943:
13944: sub assign_categories_table {
1.919 raeburn 13945: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 13946: my $output;
13947: if (ref($cathash) eq 'HASH') {
13948: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
13949: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
13950: $maxdepth = scalar(@cats);
13951: if (@cats > 0) {
13952: my $itemcount = 0;
13953: if (ref($cats[0]) eq 'ARRAY') {
13954: my @currcategories;
13955: if ($currcat ne '') {
13956: @currcategories = split('&',$currcat);
13957: }
1.919 raeburn 13958: my $table;
1.663 raeburn 13959: for (my $i=0; $i<@{$cats[0]}; $i++) {
13960: my $parent = $cats[0][$i];
1.919 raeburn 13961: next if ($parent eq 'instcode');
13962: if ($type eq 'Community') {
13963: next unless ($parent eq 'communities');
13964: } else {
13965: next if ($parent eq 'communities');
13966: }
1.663 raeburn 13967: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
13968: my $item = &escape($parent).'::0';
13969: my $checked = '';
13970: if (@currcategories > 0) {
13971: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 13972: $checked = ' checked="checked"';
1.663 raeburn 13973: }
13974: }
1.919 raeburn 13975: my $parent_title = $parent;
13976: if ($parent eq 'communities') {
13977: $parent_title = &mt('Communities');
13978: }
13979: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
13980: '<input type="checkbox" name="usecategory" value="'.
13981: $item.'"'.$checked.' />'.$parent_title.'</span>'.
13982: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 13983: my $depth = 1;
13984: push(@path,$parent);
1.919 raeburn 13985: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 13986: pop(@path);
1.919 raeburn 13987: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 13988: $itemcount ++;
13989: }
1.919 raeburn 13990: if ($itemcount) {
13991: $output = &Apache::loncommon::start_data_table().
13992: $table.
13993: &Apache::loncommon::end_data_table();
13994: }
1.663 raeburn 13995: }
13996: }
13997: }
13998: return $output;
13999: }
14000:
14001: =pod
14002:
1.1162 raeburn 14003: =item * &assign_category_rows()
1.663 raeburn 14004:
14005: Create a datatable row for display of nested categories in a domain,
14006: with checkboxes to allow a course to be categorized,called recursively.
14007:
14008: Inputs:
14009:
14010: itemcount - track row number for alternating colors
14011:
14012: cats - reference to array of arrays/hashes which encapsulates hierarchy of
14013: categories and subcategories.
14014:
14015: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
14016:
14017: parent - parent of current category item
14018:
14019: path - Array containing all categories back up through the hierarchy from the
14020: current category to the top level.
14021:
14022: currcategories - reference to array of current categories assigned to the course
14023:
14024: Returns: $output (markup to be displayed).
14025:
14026: =cut
14027:
14028: sub assign_category_rows {
14029: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
14030: my ($text,$name,$item,$chgstr);
14031: if (ref($cats) eq 'ARRAY') {
14032: my $maxdepth = scalar(@{$cats});
14033: if (ref($cats->[$depth]) eq 'HASH') {
14034: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
14035: my $numchildren = @{$cats->[$depth]{$parent}};
14036: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1145 raeburn 14037: $text .= '<td><table class="LC_data_table">';
1.663 raeburn 14038: for (my $j=0; $j<$numchildren; $j++) {
14039: $name = $cats->[$depth]{$parent}[$j];
14040: $item = &escape($name).':'.&escape($parent).':'.$depth;
14041: my $deeper = $depth+1;
14042: my $checked = '';
14043: if (ref($currcategories) eq 'ARRAY') {
14044: if (@{$currcategories} > 0) {
14045: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 14046: $checked = ' checked="checked"';
1.663 raeburn 14047: }
14048: }
14049: }
1.664 raeburn 14050: $text .= '<tr><td><span class="LC_nobreak"><label>'.
14051: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 14052: $item.'"'.$checked.' />'.$name.'</label></span>'.
14053: '<input type="hidden" name="catname" value="'.$name.'" />'.
14054: '</td><td>';
1.663 raeburn 14055: if (ref($path) eq 'ARRAY') {
14056: push(@{$path},$name);
14057: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
14058: pop(@{$path});
14059: }
14060: $text .= '</td></tr>';
14061: }
14062: $text .= '</table></td>';
14063: }
14064: }
14065: }
14066: return $text;
14067: }
14068:
1.1181 raeburn 14069: =pod
14070:
14071: =back
14072:
14073: =cut
14074:
1.655 raeburn 14075: ############################################################
14076: ############################################################
14077:
14078:
1.443 albertel 14079: sub commit_customrole {
1.664 raeburn 14080: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 14081: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 14082: ($start?', '.&mt('starting').' '.localtime($start):'').
14083: ($end?', ending '.localtime($end):'').': <b>'.
14084: &Apache::lonnet::assigncustomrole(
1.664 raeburn 14085: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 14086: '</b><br />';
14087: return $output;
14088: }
14089:
14090: sub commit_standardrole {
1.1116 raeburn 14091: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits) = @_;
1.541 raeburn 14092: my ($output,$logmsg,$linefeed);
14093: if ($context eq 'auto') {
14094: $linefeed = "\n";
14095: } else {
14096: $linefeed = "<br />\n";
14097: }
1.443 albertel 14098: if ($three eq 'st') {
1.541 raeburn 14099: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1116 raeburn 14100: $one,$two,$sec,$context,$credits);
1.541 raeburn 14101: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 14102: ($result eq 'unknown_course') || ($result eq 'refused')) {
14103: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 14104: } else {
1.541 raeburn 14105: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 14106: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 14107: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
14108: if ($context eq 'auto') {
14109: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
14110: } else {
14111: $output .= '<b>'.$result.'</b>'.$linefeed.
14112: &mt('Add to classlist').': <b>ok</b>';
14113: }
14114: $output .= $linefeed;
1.443 albertel 14115: }
14116: } else {
14117: $output = &mt('Assigning').' '.$three.' in '.$url.
14118: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 14119: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 14120: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 14121: if ($context eq 'auto') {
14122: $output .= $result.$linefeed;
14123: } else {
14124: $output .= '<b>'.$result.'</b>'.$linefeed;
14125: }
1.443 albertel 14126: }
14127: return $output;
14128: }
14129:
14130: sub commit_studentrole {
1.1116 raeburn 14131: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
14132: $credits) = @_;
1.626 raeburn 14133: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 14134: if ($context eq 'auto') {
14135: $linefeed = "\n";
14136: } else {
14137: $linefeed = '<br />'."\n";
14138: }
1.443 albertel 14139: if (defined($one) && defined($two)) {
14140: my $cid=$one.'_'.$two;
14141: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
14142: my $secchange = 0;
14143: my $expire_role_result;
14144: my $modify_section_result;
1.628 raeburn 14145: if ($oldsec ne '-1') {
14146: if ($oldsec ne $sec) {
1.443 albertel 14147: $secchange = 1;
1.628 raeburn 14148: my $now = time;
1.443 albertel 14149: my $uurl='/'.$cid;
14150: $uurl=~s/\_/\//g;
14151: if ($oldsec) {
14152: $uurl.='/'.$oldsec;
14153: }
1.626 raeburn 14154: $oldsecurl = $uurl;
1.628 raeburn 14155: $expire_role_result =
1.652 raeburn 14156: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 14157: if ($env{'request.course.sec'} ne '') {
14158: if ($expire_role_result eq 'refused') {
14159: my @roles = ('st');
14160: my @statuses = ('previous');
14161: my @roledoms = ($one);
14162: my $withsec = 1;
14163: my %roleshash =
14164: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
14165: \@statuses,\@roles,\@roledoms,$withsec);
14166: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
14167: my ($oldstart,$oldend) =
14168: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
14169: if ($oldend > 0 && $oldend <= $now) {
14170: $expire_role_result = 'ok';
14171: }
14172: }
14173: }
14174: }
1.443 albertel 14175: $result = $expire_role_result;
14176: }
14177: }
14178: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1116 raeburn 14179: $modify_section_result =
14180: &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
14181: undef,undef,undef,$sec,
14182: $end,$start,'','',$cid,
14183: '',$context,$credits);
1.443 albertel 14184: if ($modify_section_result =~ /^ok/) {
14185: if ($secchange == 1) {
1.628 raeburn 14186: if ($sec eq '') {
14187: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
14188: } else {
14189: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
14190: }
1.443 albertel 14191: } elsif ($oldsec eq '-1') {
1.628 raeburn 14192: if ($sec eq '') {
14193: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
14194: } else {
14195: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
14196: }
1.443 albertel 14197: } else {
1.628 raeburn 14198: if ($sec eq '') {
14199: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
14200: } else {
14201: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
14202: }
1.443 albertel 14203: }
14204: } else {
1.1115 raeburn 14205: if ($secchange) {
1.628 raeburn 14206: $$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;
14207: } else {
14208: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
14209: }
1.443 albertel 14210: }
14211: $result = $modify_section_result;
14212: } elsif ($secchange == 1) {
1.628 raeburn 14213: if ($oldsec eq '') {
1.1103 raeburn 14214: $$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 14215: } else {
14216: $$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;
14217: }
1.626 raeburn 14218: if ($expire_role_result eq 'refused') {
14219: my $newsecurl = '/'.$cid;
14220: $newsecurl =~ s/\_/\//g;
14221: if ($sec ne '') {
14222: $newsecurl.='/'.$sec;
14223: }
14224: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
14225: if ($sec eq '') {
14226: $$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;
14227: } else {
14228: $$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;
14229: }
14230: }
14231: }
1.443 albertel 14232: }
14233: } else {
1.626 raeburn 14234: $$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 14235: $result = "error: incomplete course id\n";
14236: }
14237: return $result;
14238: }
14239:
1.1108 raeburn 14240: sub show_role_extent {
14241: my ($scope,$context,$role) = @_;
14242: $scope =~ s{^/}{};
14243: my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
14244: push(@courseroles,'co');
14245: my @authorroles = &Apache::lonuserutils::roles_by_context('author');
14246: if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
14247: $scope =~ s{/}{_};
14248: return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
14249: } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
14250: my ($audom,$auname) = split(/\//,$scope);
14251: return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
14252: &Apache::loncommon::plainname($auname,$audom).'</span>');
14253: } else {
14254: $scope =~ s{/$}{};
14255: return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
14256: &Apache::lonnet::domain($scope,'description').'</span>');
14257: }
14258: }
14259:
1.443 albertel 14260: ############################################################
14261: ############################################################
14262:
1.566 albertel 14263: sub check_clone {
1.578 raeburn 14264: my ($args,$linefeed) = @_;
1.566 albertel 14265: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
14266: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
14267: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
14268: my $clonemsg;
14269: my $can_clone = 0;
1.944 raeburn 14270: my $lctype = lc($args->{'crstype'});
1.908 raeburn 14271: if ($lctype ne 'community') {
14272: $lctype = 'course';
14273: }
1.566 albertel 14274: if ($clonehome eq 'no_host') {
1.944 raeburn 14275: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 14276: $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'});
14277: } else {
14278: $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'});
14279: }
1.566 albertel 14280: } else {
14281: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944 raeburn 14282: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 14283: if ($clonedesc{'type'} ne 'Community') {
14284: $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'});
14285: return ($can_clone, $clonemsg, $cloneid, $clonehome);
14286: }
14287: }
1.882 raeburn 14288: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
14289: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 14290: $can_clone = 1;
14291: } else {
14292: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
14293: $args->{'clonedomain'},$args->{'clonecourse'});
14294: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 14295: if (grep(/^\*$/,@cloners)) {
14296: $can_clone = 1;
14297: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
14298: $can_clone = 1;
14299: } else {
1.908 raeburn 14300: my $ccrole = 'cc';
1.944 raeburn 14301: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 14302: $ccrole = 'co';
14303: }
1.578 raeburn 14304: my %roleshash =
14305: &Apache::lonnet::get_my_roles($args->{'ccuname'},
14306: $args->{'ccdomain'},
1.908 raeburn 14307: 'userroles',['active'],[$ccrole],
1.578 raeburn 14308: [$args->{'clonedomain'}]);
1.908 raeburn 14309: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942 raeburn 14310: $can_clone = 1;
14311: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
14312: $can_clone = 1;
14313: } else {
1.944 raeburn 14314: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 14315: $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'});
14316: } else {
14317: $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'});
14318: }
1.578 raeburn 14319: }
1.566 albertel 14320: }
1.578 raeburn 14321: }
1.566 albertel 14322: }
14323: return ($can_clone, $clonemsg, $cloneid, $clonehome);
14324: }
14325:
1.444 albertel 14326: sub construct_course {
1.1166 raeburn 14327: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category,$coderef) = @_;
1.444 albertel 14328: my $outcome;
1.541 raeburn 14329: my $linefeed = '<br />'."\n";
14330: if ($context eq 'auto') {
14331: $linefeed = "\n";
14332: }
1.566 albertel 14333:
14334: #
14335: # Are we cloning?
14336: #
14337: my ($can_clone, $clonemsg, $cloneid, $clonehome);
14338: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 14339: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 14340: if ($context ne 'auto') {
1.578 raeburn 14341: if ($clonemsg ne '') {
14342: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
14343: }
1.566 albertel 14344: }
14345: $outcome .= $clonemsg.$linefeed;
14346:
14347: if (!$can_clone) {
14348: return (0,$outcome);
14349: }
14350: }
14351:
1.444 albertel 14352: #
14353: # Open course
14354: #
14355: my $crstype = lc($args->{'crstype'});
14356: my %cenv=();
14357: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
14358: $args->{'cdescr'},
14359: $args->{'curl'},
14360: $args->{'course_home'},
14361: $args->{'nonstandard'},
14362: $args->{'crscode'},
14363: $args->{'ccuname'}.':'.
14364: $args->{'ccdomain'},
1.882 raeburn 14365: $args->{'crstype'},
1.885 raeburn 14366: $cnum,$context,$category);
1.444 albertel 14367:
14368: # Note: The testing routines depend on this being output; see
14369: # Utils::Course. This needs to at least be output as a comment
14370: # if anyone ever decides to not show this, and Utils::Course::new
14371: # will need to be suitably modified.
1.541 raeburn 14372: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943 raeburn 14373: if ($$courseid =~ /^error:/) {
14374: return (0,$outcome);
14375: }
14376:
1.444 albertel 14377: #
14378: # Check if created correctly
14379: #
1.479 albertel 14380: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 14381: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 14382: if ($crsuhome eq 'no_host') {
14383: $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
14384: return (0,$outcome);
14385: }
1.541 raeburn 14386: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 14387:
1.444 albertel 14388: #
1.566 albertel 14389: # Do the cloning
14390: #
14391: if ($can_clone && $cloneid) {
14392: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
14393: if ($context ne 'auto') {
14394: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
14395: }
14396: $outcome .= $clonemsg.$linefeed;
14397: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 14398: # Copy all files
1.637 www 14399: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 14400: # Restore URL
1.566 albertel 14401: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 14402: # Restore title
1.566 albertel 14403: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 14404: # Restore creation date, creator and creation context.
14405: $cenv{'internal.created'}=$oldcenv{'internal.created'};
14406: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
14407: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 14408: # Mark as cloned
1.566 albertel 14409: $cenv{'clonedfrom'}=$cloneid;
1.638 www 14410: # Need to clone grading mode
14411: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
14412: $cenv{'grading'}=$newenv{'grading'};
14413: # Do not clone these environment entries
14414: &Apache::lonnet::del('environment',
14415: ['default_enrollment_start_date',
14416: 'default_enrollment_end_date',
14417: 'question.email',
14418: 'policy.email',
14419: 'comment.email',
14420: 'pch.users.denied',
1.725 raeburn 14421: 'plc.users.denied',
14422: 'hidefromcat',
1.1121 raeburn 14423: 'checkforpriv',
1.1166 raeburn 14424: 'categories',
14425: 'internal.uniquecode'],
1.638 www 14426: $$crsudom,$$crsunum);
1.1170 raeburn 14427: if ($args->{'textbook'}) {
14428: $cenv{'internal.textbook'} = $args->{'textbook'};
14429: }
1.444 albertel 14430: }
1.566 albertel 14431:
1.444 albertel 14432: #
14433: # Set environment (will override cloned, if existing)
14434: #
14435: my @sections = ();
14436: my @xlists = ();
14437: if ($args->{'crstype'}) {
14438: $cenv{'type'}=$args->{'crstype'};
14439: }
14440: if ($args->{'crsid'}) {
14441: $cenv{'courseid'}=$args->{'crsid'};
14442: }
14443: if ($args->{'crscode'}) {
14444: $cenv{'internal.coursecode'}=$args->{'crscode'};
14445: }
14446: if ($args->{'crsquota'} ne '') {
14447: $cenv{'internal.coursequota'}=$args->{'crsquota'};
14448: } else {
14449: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
14450: }
14451: if ($args->{'ccuname'}) {
14452: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
14453: ':'.$args->{'ccdomain'};
14454: } else {
14455: $cenv{'internal.courseowner'} = $args->{'curruser'};
14456: }
1.1116 raeburn 14457: if ($args->{'defaultcredits'}) {
14458: $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
14459: }
1.444 albertel 14460: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
14461: if ($args->{'crssections'}) {
14462: $cenv{'internal.sectionnums'} = '';
14463: if ($args->{'crssections'} =~ m/,/) {
14464: @sections = split/,/,$args->{'crssections'};
14465: } else {
14466: $sections[0] = $args->{'crssections'};
14467: }
14468: if (@sections > 0) {
14469: foreach my $item (@sections) {
14470: my ($sec,$gp) = split/:/,$item;
14471: my $class = $args->{'crscode'}.$sec;
14472: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
14473: $cenv{'internal.sectionnums'} .= $item.',';
14474: unless ($addcheck eq 'ok') {
14475: push @badclasses, $class;
14476: }
14477: }
14478: $cenv{'internal.sectionnums'} =~ s/,$//;
14479: }
14480: }
14481: # do not hide course coordinator from staff listing,
14482: # even if privileged
14483: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1121 raeburn 14484: # add course coordinator's domain to domains to check for privileged users
14485: # if different to course domain
14486: if ($$crsudom ne $args->{'ccdomain'}) {
14487: $cenv{'checkforpriv'} = $args->{'ccdomain'};
14488: }
1.444 albertel 14489: # add crosslistings
14490: if ($args->{'crsxlist'}) {
14491: $cenv{'internal.crosslistings'}='';
14492: if ($args->{'crsxlist'} =~ m/,/) {
14493: @xlists = split/,/,$args->{'crsxlist'};
14494: } else {
14495: $xlists[0] = $args->{'crsxlist'};
14496: }
14497: if (@xlists > 0) {
14498: foreach my $item (@xlists) {
14499: my ($xl,$gp) = split/:/,$item;
14500: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
14501: $cenv{'internal.crosslistings'} .= $item.',';
14502: unless ($addcheck eq 'ok') {
14503: push @badclasses, $xl;
14504: }
14505: }
14506: $cenv{'internal.crosslistings'} =~ s/,$//;
14507: }
14508: }
14509: if ($args->{'autoadds'}) {
14510: $cenv{'internal.autoadds'}=$args->{'autoadds'};
14511: }
14512: if ($args->{'autodrops'}) {
14513: $cenv{'internal.autodrops'}=$args->{'autodrops'};
14514: }
14515: # check for notification of enrollment changes
14516: my @notified = ();
14517: if ($args->{'notify_owner'}) {
14518: if ($args->{'ccuname'} ne '') {
14519: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
14520: }
14521: }
14522: if ($args->{'notify_dc'}) {
14523: if ($uname ne '') {
1.630 raeburn 14524: push(@notified,$uname.':'.$udom);
1.444 albertel 14525: }
14526: }
14527: if (@notified > 0) {
14528: my $notifylist;
14529: if (@notified > 1) {
14530: $notifylist = join(',',@notified);
14531: } else {
14532: $notifylist = $notified[0];
14533: }
14534: $cenv{'internal.notifylist'} = $notifylist;
14535: }
14536: if (@badclasses > 0) {
14537: my %lt=&Apache::lonlocal::texthash(
14538: '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',
14539: 'dnhr' => 'does not have rights to access enrollment in these classes',
14540: 'adby' => 'as determined by the policies of your institution on access to official classlists'
14541: );
1.541 raeburn 14542: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
14543: ' ('.$lt{'adby'}.')';
14544: if ($context eq 'auto') {
14545: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 14546: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 14547: foreach my $item (@badclasses) {
14548: if ($context eq 'auto') {
14549: $outcome .= " - $item\n";
14550: } else {
14551: $outcome .= "<li>$item</li>\n";
14552: }
14553: }
14554: if ($context eq 'auto') {
14555: $outcome .= $linefeed;
14556: } else {
1.566 albertel 14557: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 14558: }
14559: }
1.444 albertel 14560: }
14561: if ($args->{'no_end_date'}) {
14562: $args->{'endaccess'} = 0;
14563: }
14564: $cenv{'internal.autostart'}=$args->{'enrollstart'};
14565: $cenv{'internal.autoend'}=$args->{'enrollend'};
14566: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
14567: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
14568: if ($args->{'showphotos'}) {
14569: $cenv{'internal.showphotos'}=$args->{'showphotos'};
14570: }
14571: $cenv{'internal.authtype'} = $args->{'authtype'};
14572: $cenv{'internal.autharg'} = $args->{'autharg'};
14573: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
14574: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 14575: 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');
14576: if ($context eq 'auto') {
14577: $outcome .= $krb_msg;
14578: } else {
1.566 albertel 14579: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 14580: }
14581: $outcome .= $linefeed;
1.444 albertel 14582: }
14583: }
14584: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
14585: if ($args->{'setpolicy'}) {
14586: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
14587: }
14588: if ($args->{'setcontent'}) {
14589: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
14590: }
14591: }
14592: if ($args->{'reshome'}) {
14593: $cenv{'reshome'}=$args->{'reshome'}.'/';
14594: $cenv{'reshome'}=~s/\/+$/\//;
14595: }
14596: #
14597: # course has keyed access
14598: #
14599: if ($args->{'setkeys'}) {
14600: $cenv{'keyaccess'}='yes';
14601: }
14602: # if specified, key authority is not course, but user
14603: # only active if keyaccess is yes
14604: if ($args->{'keyauth'}) {
1.487 albertel 14605: my ($user,$domain) = split(':',$args->{'keyauth'});
14606: $user = &LONCAPA::clean_username($user);
14607: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 14608: if ($user ne '' && $domain ne '') {
1.487 albertel 14609: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 14610: }
14611: }
14612:
1.1166 raeburn 14613: #
1.1167 raeburn 14614: # generate and store uniquecode (available to course requester), if course should have one.
1.1166 raeburn 14615: #
14616: if ($args->{'uniquecode'}) {
14617: my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
14618: if ($code) {
14619: $cenv{'internal.uniquecode'} = $code;
1.1167 raeburn 14620: my %crsinfo =
14621: &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
14622: if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
14623: $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
14624: my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
14625: }
1.1166 raeburn 14626: if (ref($coderef)) {
14627: $$coderef = $code;
14628: }
14629: }
14630: }
14631:
1.444 albertel 14632: if ($args->{'disresdis'}) {
14633: $cenv{'pch.roles.denied'}='st';
14634: }
14635: if ($args->{'disablechat'}) {
14636: $cenv{'plc.roles.denied'}='st';
14637: }
14638:
14639: # Record we've not yet viewed the Course Initialization Helper for this
14640: # course
14641: $cenv{'course.helper.not.run'} = 1;
14642: #
14643: # Use new Randomseed
14644: #
14645: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
14646: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
14647: #
14648: # The encryption code and receipt prefix for this course
14649: #
14650: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
14651: $cenv{'internal.encpref'}=100+int(9*rand(99));
14652: #
14653: # By default, use standard grading
14654: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
14655:
1.541 raeburn 14656: $outcome .= $linefeed.&mt('Setting environment').': '.
14657: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 14658: #
14659: # Open all assignments
14660: #
14661: if ($args->{'openall'}) {
14662: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
14663: my %storecontent = ($storeunder => time,
14664: $storeunder.'.type' => 'date_start');
14665:
14666: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 14667: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 14668: }
14669: #
14670: # Set first page
14671: #
14672: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
14673: || ($cloneid)) {
1.445 albertel 14674: use LONCAPA::map;
1.444 albertel 14675: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 14676:
14677: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
14678: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
14679:
1.444 albertel 14680: $outcome .= ($fatal?$errtext:'read ok').' - ';
14681: my $title; my $url;
14682: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 14683: $title=&mt('Syllabus');
1.444 albertel 14684: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
14685: } else {
1.963 raeburn 14686: $title=&mt('Table of Contents');
1.444 albertel 14687: $url='/adm/navmaps';
14688: }
1.445 albertel 14689:
14690: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
14691: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
14692:
14693: if ($errtext) { $fatal=2; }
1.541 raeburn 14694: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 14695: }
1.566 albertel 14696:
14697: return (1,$outcome);
1.444 albertel 14698: }
14699:
1.1166 raeburn 14700: sub make_unique_code {
14701: my ($cdom,$cnum) = @_;
14702: # get lock on uniquecodes db
14703: my $lockhash = {
14704: $cnum."\0".'uniquecodes' => $env{'user.name'}.
14705: ':'.$env{'user.domain'},
14706: };
14707: my $tries = 0;
14708: my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
14709: my ($code,$error);
14710:
14711: while (($gotlock ne 'ok') && ($tries<3)) {
14712: $tries ++;
14713: sleep 1;
14714: $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
14715: }
14716: if ($gotlock eq 'ok') {
14717: my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
14718: my $gotcode;
14719: my $attempts = 0;
14720: while ((!$gotcode) && ($attempts < 100)) {
14721: $code = &generate_code();
14722: if (!exists($currcodes{$code})) {
14723: $gotcode = 1;
14724: unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
14725: $error = 'nostore';
14726: }
14727: }
14728: $attempts ++;
14729: }
14730: my @del_lock = ($cnum."\0".'uniquecodes');
14731: my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
14732: } else {
14733: $error = 'nolock';
14734: }
14735: return ($code,$error);
14736: }
14737:
14738: sub generate_code {
14739: my $code;
14740: my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
14741: for (my $i=0; $i<6; $i++) {
14742: my $lettnum = int (rand 2);
14743: my $item = '';
14744: if ($lettnum) {
14745: $item = $letts[int( rand(18) )];
14746: } else {
14747: $item = 1+int( rand(8) );
14748: }
14749: $code .= $item;
14750: }
14751: return $code;
14752: }
14753:
1.444 albertel 14754: ############################################################
14755: ############################################################
14756:
1.953 droeschl 14757: #SD
14758: # only Community and Course, or anything else?
1.378 raeburn 14759: sub course_type {
14760: my ($cid) = @_;
14761: if (!defined($cid)) {
14762: $cid = $env{'request.course.id'};
14763: }
1.404 albertel 14764: if (defined($env{'course.'.$cid.'.type'})) {
14765: return $env{'course.'.$cid.'.type'};
1.378 raeburn 14766: } else {
14767: return 'Course';
1.377 raeburn 14768: }
14769: }
1.156 albertel 14770:
1.406 raeburn 14771: sub group_term {
14772: my $crstype = &course_type();
14773: my %names = (
14774: 'Course' => 'group',
1.865 raeburn 14775: 'Community' => 'group',
1.406 raeburn 14776: );
14777: return $names{$crstype};
14778: }
14779:
1.902 raeburn 14780: sub course_types {
1.1165 raeburn 14781: my @types = ('official','unofficial','community','textbook');
1.902 raeburn 14782: my %typename = (
14783: official => 'Official course',
14784: unofficial => 'Unofficial course',
14785: community => 'Community',
1.1165 raeburn 14786: textbook => 'Textbook course',
1.902 raeburn 14787: );
14788: return (\@types,\%typename);
14789: }
14790:
1.156 albertel 14791: sub icon {
14792: my ($file)=@_;
1.505 albertel 14793: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 14794: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 14795: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 14796: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
14797: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
14798: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
14799: $curfext.".gif") {
14800: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
14801: $curfext.".gif";
14802: }
14803: }
1.249 albertel 14804: return &lonhttpdurl($iconname);
1.154 albertel 14805: }
1.84 albertel 14806:
1.575 albertel 14807: sub lonhttpdurl {
1.692 www 14808: #
14809: # Had been used for "small fry" static images on separate port 8080.
14810: # Modify here if lightweight http functionality desired again.
14811: # Currently eliminated due to increasing firewall issues.
14812: #
1.575 albertel 14813: my ($url)=@_;
1.692 www 14814: return $url;
1.215 albertel 14815: }
14816:
1.213 albertel 14817: sub connection_aborted {
14818: my ($r)=@_;
14819: $r->print(" ");$r->rflush();
14820: my $c = $r->connection;
14821: return $c->aborted();
14822: }
14823:
1.221 foxr 14824: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 14825: # strings as 'strings'.
14826: sub escape_single {
1.221 foxr 14827: my ($input) = @_;
1.223 albertel 14828: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 14829: $input =~ s/\'/\\\'/g; # Esacpe the 's....
14830: return $input;
14831: }
1.223 albertel 14832:
1.222 foxr 14833: # Same as escape_single, but escape's "'s This
14834: # can be used for "strings"
14835: sub escape_double {
14836: my ($input) = @_;
14837: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
14838: $input =~ s/\"/\\\"/g; # Esacpe the "s....
14839: return $input;
14840: }
1.223 albertel 14841:
1.222 foxr 14842: # Escapes the last element of a full URL.
14843: sub escape_url {
14844: my ($url) = @_;
1.238 raeburn 14845: my @urlslices = split(/\//, $url,-1);
1.369 www 14846: my $lastitem = &escape(pop(@urlslices));
1.1203 raeburn 14847: return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222 foxr 14848: }
1.462 albertel 14849:
1.820 raeburn 14850: sub compare_arrays {
14851: my ($arrayref1,$arrayref2) = @_;
14852: my (@difference,%count);
14853: @difference = ();
14854: %count = ();
14855: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
14856: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
14857: foreach my $element (keys(%count)) {
14858: if ($count{$element} == 1) {
14859: push(@difference,$element);
14860: }
14861: }
14862: }
14863: return @difference;
14864: }
14865:
1.817 bisitz 14866: # -------------------------------------------------------- Initialize user login
1.462 albertel 14867: sub init_user_environment {
1.463 albertel 14868: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 14869: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
14870:
14871: my $public=($username eq 'public' && $domain eq 'public');
14872:
14873: # See if old ID present, if so, remove
14874:
1.1062 raeburn 14875: my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462 albertel 14876: my $now=time;
14877:
14878: if ($public) {
14879: my $max_public=100;
14880: my $oldest;
14881: my $oldest_time=0;
14882: for(my $next=1;$next<=$max_public;$next++) {
14883: if (-e $lonids."/publicuser_$next.id") {
14884: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
14885: if ($mtime<$oldest_time || !$oldest_time) {
14886: $oldest_time=$mtime;
14887: $oldest=$next;
14888: }
14889: } else {
14890: $cookie="publicuser_$next";
14891: last;
14892: }
14893: }
14894: if (!$cookie) { $cookie="publicuser_$oldest"; }
14895: } else {
1.463 albertel 14896: # if this isn't a robot, kill any existing non-robot sessions
14897: if (!$args->{'robot'}) {
14898: opendir(DIR,$lonids);
14899: while ($filename=readdir(DIR)) {
14900: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
14901: unlink($lonids.'/'.$filename);
14902: }
1.462 albertel 14903: }
1.463 albertel 14904: closedir(DIR);
1.1204 raeburn 14905: # If there is a undeleted lockfile for the user's paste buffer remove it.
14906: my $namespace = 'nohist_courseeditor';
14907: my $lockingkey = 'paste'."\0".'locked_num';
14908: my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
14909: $domain,$username);
14910: if (exists($lockhash{$lockingkey})) {
14911: my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
14912: unless ($delresult eq 'ok') {
14913: &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
14914: }
14915: }
1.462 albertel 14916: }
14917: # Give them a new cookie
1.463 albertel 14918: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 14919: : $now.$$.int(rand(10000)));
1.463 albertel 14920: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 14921:
14922: # Initialize roles
14923:
1.1062 raeburn 14924: ($userroles,$firstaccenv,$timerintenv) =
14925: &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462 albertel 14926: }
14927: # ------------------------------------ Check browser type and MathML capability
14928:
1.1194 raeburn 14929: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
14930: $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462 albertel 14931:
14932: # ------------------------------------------------------------- Get environment
14933:
14934: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
14935: my ($tmp) = keys(%userenv);
14936: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
14937: } else {
14938: undef(%userenv);
14939: }
14940: if (($userenv{'interface'}) && (!$form->{'interface'})) {
14941: $form->{'interface'}=$userenv{'interface'};
14942: }
14943: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
14944:
14945: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 14946: foreach my $option ('interface','localpath','localres') {
14947: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 14948: }
14949: # --------------------------------------------------------- Write first profile
14950:
14951: {
14952: my %initial_env =
14953: ("user.name" => $username,
14954: "user.domain" => $domain,
14955: "user.home" => $authhost,
14956: "browser.type" => $clientbrowser,
14957: "browser.version" => $clientversion,
14958: "browser.mathml" => $clientmathml,
14959: "browser.unicode" => $clientunicode,
14960: "browser.os" => $clientos,
1.1137 raeburn 14961: "browser.mobile" => $clientmobile,
1.1141 raeburn 14962: "browser.info" => $clientinfo,
1.1194 raeburn 14963: "browser.osversion" => $clientosversion,
1.462 albertel 14964: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
14965: "request.course.fn" => '',
14966: "request.course.uri" => '',
14967: "request.course.sec" => '',
14968: "request.role" => 'cm',
14969: "request.role.adv" => $env{'user.adv'},
14970: "request.host" => $ENV{'REMOTE_ADDR'},);
14971:
14972: if ($form->{'localpath'}) {
14973: $initial_env{"browser.localpath"} = $form->{'localpath'};
14974: $initial_env{"browser.localres"} = $form->{'localres'};
14975: }
14976:
14977: if ($form->{'interface'}) {
14978: $form->{'interface'}=~s/\W//gs;
14979: $initial_env{"browser.interface"} = $form->{'interface'};
14980: $env{'browser.interface'}=$form->{'interface'};
14981: }
14982:
1.1157 raeburn 14983: if ($form->{'iptoken'}) {
14984: my $lonhost = $r->dir_config('lonHostID');
14985: $initial_env{"user.noloadbalance"} = $lonhost;
14986: $env{'user.noloadbalance'} = $lonhost;
14987: }
14988:
1.981 raeburn 14989: my %is_adv = ( is_adv => $env{'user.adv'} );
1.1016 raeburn 14990: my %domdef;
14991: unless ($domain eq 'public') {
14992: %domdef = &Apache::lonnet::get_domain_defaults($domain);
14993: }
1.980 raeburn 14994:
1.1081 raeburn 14995: foreach my $tool ('aboutme','blog','webdav','portfolio') {
1.724 raeburn 14996: $userenv{'availabletools.'.$tool} =
1.980 raeburn 14997: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
14998: undef,\%userenv,\%domdef,\%is_adv);
1.724 raeburn 14999: }
15000:
1.1165 raeburn 15001: foreach my $crstype ('official','unofficial','community','textbook') {
1.765 raeburn 15002: $userenv{'canrequest.'.$crstype} =
15003: &Apache::lonnet::usertools_access($username,$domain,$crstype,
1.980 raeburn 15004: 'reload','requestcourses',
15005: \%userenv,\%domdef,\%is_adv);
1.765 raeburn 15006: }
15007:
1.1092 raeburn 15008: $userenv{'canrequest.author'} =
15009: &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
15010: 'reload','requestauthor',
15011: \%userenv,\%domdef,\%is_adv);
15012: my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
15013: $domain,$username);
15014: my $reqstatus = $reqauthor{'author_status'};
15015: if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
15016: if (ref($reqauthor{'author'}) eq 'HASH') {
15017: $userenv{'requestauthorqueued'} = $reqstatus.':'.
15018: $reqauthor{'author'}{'timestamp'};
15019: }
15020: }
15021:
1.462 albertel 15022: $env{'user.environment'} = "$lonids/$cookie.id";
1.1062 raeburn 15023:
1.462 albertel 15024: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
15025: &GDBM_WRCREAT(),0640)) {
15026: &_add_to_env(\%disk_env,\%initial_env);
15027: &_add_to_env(\%disk_env,\%userenv,'environment.');
15028: &_add_to_env(\%disk_env,$userroles);
1.1062 raeburn 15029: if (ref($firstaccenv) eq 'HASH') {
15030: &_add_to_env(\%disk_env,$firstaccenv);
15031: }
15032: if (ref($timerintenv) eq 'HASH') {
15033: &_add_to_env(\%disk_env,$timerintenv);
15034: }
1.463 albertel 15035: if (ref($args->{'extra_env'})) {
15036: &_add_to_env(\%disk_env,$args->{'extra_env'});
15037: }
1.462 albertel 15038: untie(%disk_env);
15039: } else {
1.705 tempelho 15040: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
15041: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 15042: return 'error: '.$!;
15043: }
15044: }
15045: $env{'request.role'}='cm';
15046: $env{'request.role.adv'}=$env{'user.adv'};
15047: $env{'browser.type'}=$clientbrowser;
15048:
15049: return $cookie;
15050:
15051: }
15052:
15053: sub _add_to_env {
15054: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 15055: if (ref($env_data) eq 'HASH') {
15056: while (my ($key,$value) = each(%$env_data)) {
15057: $idf->{$prefix.$key} = $value;
15058: $env{$prefix.$key} = $value;
15059: }
1.462 albertel 15060: }
15061: }
15062:
1.685 tempelho 15063: # --- Get the symbolic name of a problem and the url
15064: sub get_symb {
15065: my ($request,$silent) = @_;
1.726 raeburn 15066: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 15067: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
15068: if ($symb eq '') {
15069: if (!$silent) {
1.1071 raeburn 15070: if (ref($request)) {
15071: $request->print("Unable to handle ambiguous references:$url:.");
15072: }
1.685 tempelho 15073: return ();
15074: }
15075: }
15076: &Apache::lonenc::check_decrypt(\$symb);
15077: return ($symb);
15078: }
15079:
15080: # --------------------------------------------------------------Get annotation
15081:
15082: sub get_annotation {
15083: my ($symb,$enc) = @_;
15084:
15085: my $key = $symb;
15086: if (!$enc) {
15087: $key =
15088: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
15089: }
15090: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
15091: return $annotation{$key};
15092: }
15093:
15094: sub clean_symb {
1.731 raeburn 15095: my ($symb,$delete_enc) = @_;
1.685 tempelho 15096:
15097: &Apache::lonenc::check_decrypt(\$symb);
15098: my $enc = $env{'request.enc'};
1.731 raeburn 15099: if ($delete_enc) {
1.730 raeburn 15100: delete($env{'request.enc'});
15101: }
1.685 tempelho 15102:
15103: return ($symb,$enc);
15104: }
1.462 albertel 15105:
1.1181 raeburn 15106: ############################################################
15107: ############################################################
15108:
15109: =pod
15110:
15111: =head1 Routines for building display used to search for courses
15112:
15113:
15114: =over 4
15115:
15116: =item * &build_filters()
15117:
15118: Create markup for a table used to set filters to use when selecting
1.1182 raeburn 15119: courses in a domain. Used by lonpickcourse.pm, lonmodifycourse.pm
15120: and quotacheck.pl
15121:
1.1181 raeburn 15122:
15123: Inputs:
15124:
15125: filterlist - anonymous array of fields to include as potential filters
15126:
15127: crstype - course type
15128:
15129: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
15130: to pop-open a course selector (will contain "extra element").
15131:
15132: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
15133:
15134: filter - anonymous hash of criteria and their values
15135:
15136: action - form action
15137:
15138: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
15139:
1.1182 raeburn 15140: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
1.1181 raeburn 15141:
15142: cloneruname - username of owner of new course who wants to clone
15143:
15144: clonerudom - domain of owner of new course who wants to clone
15145:
15146: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
15147:
15148: codetitlesref - reference to array of titles of components in institutional codes (official courses)
15149:
15150: codedom - domain
15151:
15152: formname - value of form element named "form".
15153:
15154: fixeddom - domain, if fixed.
15155:
15156: prevphase - value to assign to form element named "phase" when going back to the previous screen
15157:
15158: cnameelement - name of form element in form on opener page which will receive title of selected course
15159:
15160: cnumelement - name of form element in form on opener page which will receive courseID of selected course
15161:
15162: cdomelement - name of form element in form on opener page which will receive domain of selected course
15163:
15164: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
15165:
15166: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
15167:
15168: clonewarning - warning message about missing information for intended course owner when DC creates a course
15169:
1.1182 raeburn 15170:
1.1181 raeburn 15171: Returns: $output - HTML for display of search criteria, and hidden form elements.
15172:
1.1182 raeburn 15173:
1.1181 raeburn 15174: Side Effects: None
15175:
15176: =cut
15177:
15178: # ---------------------------------------------- search for courses based on last activity etc.
15179:
15180: sub build_filters {
15181: my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
15182: $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
15183: $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
15184: $cnameelement,$cnumelement,$cdomelement,$setroles,
15185: $clonetext,$clonewarning) = @_;
1.1182 raeburn 15186: my ($list,$jscript);
1.1181 raeburn 15187: my $onchange = 'javascript:updateFilters(this)';
15188: my ($domainselectform,$sincefilterform,$createdfilterform,
15189: $ownerdomselectform,$persondomselectform,$instcodeform,
15190: $typeselectform,$instcodetitle);
15191: if ($formname eq '') {
15192: $formname = $caller;
15193: }
15194: foreach my $item (@{$filterlist}) {
15195: unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
15196: ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
15197: if ($item eq 'domainfilter') {
15198: $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
15199: } elsif ($item eq 'coursefilter') {
15200: $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
15201: } elsif ($item eq 'ownerfilter') {
15202: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
15203: } elsif ($item eq 'ownerdomfilter') {
15204: $filter->{'ownerdomfilter'} =
15205: &LONCAPA::clean_domain($filter->{$item});
15206: $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
15207: 'ownerdomfilter',1);
15208: } elsif ($item eq 'personfilter') {
15209: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
15210: } elsif ($item eq 'persondomfilter') {
15211: $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
15212: 'persondomfilter',1);
15213: } else {
15214: $filter->{$item} =~ s/\W//g;
15215: }
15216: if (!$filter->{$item}) {
15217: $filter->{$item} = '';
15218: }
15219: }
15220: if ($item eq 'domainfilter') {
15221: my $allow_blank = 1;
15222: if ($formname eq 'portform') {
15223: $allow_blank=0;
15224: } elsif ($formname eq 'studentform') {
15225: $allow_blank=0;
15226: }
15227: if ($fixeddom) {
15228: $domainselectform = '<input type="hidden" name="domainfilter"'.
15229: ' value="'.$codedom.'" />'.
15230: &Apache::lonnet::domain($codedom,'description');
15231: } else {
15232: $domainselectform = &select_dom_form($filter->{$item},
15233: 'domainfilter',
15234: $allow_blank,'',$onchange);
15235: }
15236: } else {
15237: $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
15238: }
15239: }
15240:
15241: # last course activity filter and selection
15242: $sincefilterform = &timebased_select_form('sincefilter',$filter);
15243:
15244: # course created filter and selection
15245: if (exists($filter->{'createdfilter'})) {
15246: $createdfilterform = &timebased_select_form('createdfilter',$filter);
15247: }
15248:
15249: my %lt = &Apache::lonlocal::texthash(
15250: 'cac' => "$crstype Activity",
15251: 'ccr' => "$crstype Created",
15252: 'cde' => "$crstype Title",
15253: 'cdo' => "$crstype Domain",
15254: 'ins' => 'Institutional Code',
15255: 'inc' => 'Institutional Categorization',
15256: 'cow' => "$crstype Owner/Co-owner",
15257: 'cop' => "$crstype Personnel Includes",
15258: 'cog' => 'Type',
15259: );
15260:
15261: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
15262: my $typeval = 'Course';
15263: if ($crstype eq 'Community') {
15264: $typeval = 'Community';
15265: }
15266: $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
15267: } else {
15268: $typeselectform = '<select name="type" size="1"';
15269: if ($onchange) {
15270: $typeselectform .= ' onchange="'.$onchange.'"';
15271: }
15272: $typeselectform .= '>'."\n";
15273: foreach my $posstype ('Course','Community') {
15274: $typeselectform.='<option value="'.$posstype.'"'.
15275: ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".&mt($posstype)."</option>\n";
15276: }
15277: $typeselectform.="</select>";
15278: }
15279:
15280: my ($cloneableonlyform,$cloneabletitle);
15281: if (exists($filter->{'cloneableonly'})) {
15282: my $cloneableon = '';
15283: my $cloneableoff = ' checked="checked"';
15284: if ($filter->{'cloneableonly'}) {
15285: $cloneableon = $cloneableoff;
15286: $cloneableoff = '';
15287: }
15288: $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>';
15289: if ($formname eq 'ccrs') {
1.1187 bisitz 15290: $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1181 raeburn 15291: } else {
15292: $cloneabletitle = &mt('Cloneable by you');
15293: }
15294: }
15295: my $officialjs;
15296: if ($crstype eq 'Course') {
15297: if (exists($filter->{'instcodefilter'})) {
1.1182 raeburn 15298: # if (($fixeddom) || ($formname eq 'requestcrs') ||
15299: # ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
15300: if ($codedom) {
1.1181 raeburn 15301: $officialjs = 1;
15302: ($instcodeform,$jscript,$$numtitlesref) =
15303: &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
15304: $officialjs,$codetitlesref);
15305: if ($jscript) {
1.1182 raeburn 15306: $jscript = '<script type="text/javascript">'."\n".
15307: '// <![CDATA['."\n".
15308: $jscript."\n".
15309: '// ]]>'."\n".
15310: '</script>'."\n";
1.1181 raeburn 15311: }
15312: }
15313: if ($instcodeform eq '') {
15314: $instcodeform =
15315: '<input type="text" name="instcodefilter" size="10" value="'.
15316: $list->{'instcodefilter'}.'" />';
15317: $instcodetitle = $lt{'ins'};
15318: } else {
15319: $instcodetitle = $lt{'inc'};
15320: }
15321: if ($fixeddom) {
15322: $instcodetitle .= '<br />('.$codedom.')';
15323: }
15324: }
15325: }
15326: my $output = qq|
15327: <form method="post" name="filterpicker" action="$action">
15328: <input type="hidden" name="form" value="$formname" />
15329: |;
15330: if ($formname eq 'modifycourse') {
15331: $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
15332: '<input type="hidden" name="prevphase" value="'.
15333: $prevphase.'" />'."\n";
1.1198 musolffc 15334: } elsif ($formname eq 'quotacheck') {
15335: $output .= qq|
15336: <input type="hidden" name="sortby" value="" />
15337: <input type="hidden" name="sortorder" value="" />
15338: |;
15339: } else {
1.1181 raeburn 15340: my $name_input;
15341: if ($cnameelement ne '') {
15342: $name_input = '<input type="hidden" name="cnameelement" value="'.
15343: $cnameelement.'" />';
15344: }
15345: $output .= qq|
1.1182 raeburn 15346: <input type="hidden" name="cnumelement" value="$cnumelement" />
15347: <input type="hidden" name="cdomelement" value="$cdomelement" />
1.1181 raeburn 15348: $name_input
15349: $roleelement
15350: $multelement
15351: $typeelement
15352: |;
15353: if ($formname eq 'portform') {
15354: $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
15355: }
15356: }
15357: if ($fixeddom) {
15358: $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
15359: }
15360: $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
15361: if ($sincefilterform) {
15362: $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
15363: .$sincefilterform
15364: .&Apache::lonhtmlcommon::row_closure();
15365: }
15366: if ($createdfilterform) {
15367: $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
15368: .$createdfilterform
15369: .&Apache::lonhtmlcommon::row_closure();
15370: }
15371: if ($domainselectform) {
15372: $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
15373: .$domainselectform
15374: .&Apache::lonhtmlcommon::row_closure();
15375: }
15376: if ($typeselectform) {
15377: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
15378: $output .= $typeselectform;
15379: } else {
15380: $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
15381: .$typeselectform
15382: .&Apache::lonhtmlcommon::row_closure();
15383: }
15384: }
15385: if ($instcodeform) {
15386: $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
15387: .$instcodeform
15388: .&Apache::lonhtmlcommon::row_closure();
15389: }
15390: if (exists($filter->{'ownerfilter'})) {
15391: $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
15392: '<table><tr><td>'.&mt('Username').'<br />'.
15393: '<input type="text" name="ownerfilter" size="20" value="'.
15394: $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
15395: $ownerdomselectform.'</td></tr></table>'.
15396: &Apache::lonhtmlcommon::row_closure();
15397: }
15398: if (exists($filter->{'personfilter'})) {
15399: $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
15400: '<table><tr><td>'.&mt('Username').'<br />'.
15401: '<input type="text" name="personfilter" size="20" value="'.
15402: $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
15403: $persondomselectform.'</td></tr></table>'.
15404: &Apache::lonhtmlcommon::row_closure();
15405: }
15406: if (exists($filter->{'coursefilter'})) {
15407: $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
15408: .'<input type="text" name="coursefilter" size="25" value="'
15409: .$list->{'coursefilter'}.'" />'
15410: .&Apache::lonhtmlcommon::row_closure();
15411: }
15412: if ($cloneableonlyform) {
15413: $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
15414: $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
15415: }
15416: if (exists($filter->{'descriptfilter'})) {
15417: $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
15418: .'<input type="text" name="descriptfilter" size="40" value="'
15419: .$list->{'descriptfilter'}.'" />'
15420: .&Apache::lonhtmlcommon::row_closure(1);
15421: }
15422: $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
15423: '<input type="hidden" name="updater" value="" />'."\n".
15424: '<input type="submit" name="gosearch" value="'.
15425: &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
15426: return $jscript.$clonewarning.$output;
15427: }
15428:
15429: =pod
15430:
15431: =item * &timebased_select_form()
15432:
1.1182 raeburn 15433: Create markup for a dropdown list used to select a time-based
1.1181 raeburn 15434: filter e.g., Course Activity, Course Created, when searching for courses
15435: or communities
15436:
15437: Inputs:
15438:
15439: item - name of form element (sincefilter or createdfilter)
15440:
15441: filter - anonymous hash of criteria and their values
15442:
15443: Returns: HTML for a select box contained a blank, then six time selections,
15444: with value set in incoming form variables currently selected.
15445:
15446: Side Effects: None
15447:
15448: =cut
15449:
15450: sub timebased_select_form {
15451: my ($item,$filter) = @_;
15452: if (ref($filter) eq 'HASH') {
15453: $filter->{$item} =~ s/[^\d-]//g;
15454: if (!$filter->{$item}) { $filter->{$item}=-1; }
15455: return &select_form(
15456: $filter->{$item},
15457: $item,
15458: { '-1' => '',
15459: '86400' => &mt('today'),
15460: '604800' => &mt('last week'),
15461: '2592000' => &mt('last month'),
15462: '7776000' => &mt('last three months'),
15463: '15552000' => &mt('last six months'),
15464: '31104000' => &mt('last year'),
15465: 'select_form_order' =>
15466: ['-1','86400','604800','2592000','7776000',
15467: '15552000','31104000']});
15468: }
15469: }
15470:
15471: =pod
15472:
15473: =item * &js_changer()
15474:
15475: Create script tag containing Javascript used to submit course search form
1.1183 raeburn 15476: when course type or domain is changed, and also to hide 'Searching ...' on
15477: page load completion for page showing search result.
1.1181 raeburn 15478:
15479: Inputs: None
15480:
1.1183 raeburn 15481: Returns: markup containing updateFilters() and hideSearching() javascript functions.
1.1181 raeburn 15482:
15483: Side Effects: None
15484:
15485: =cut
15486:
15487: sub js_changer {
15488: return <<ENDJS;
15489: <script type="text/javascript">
15490: // <![CDATA[
15491: function updateFilters(caller) {
15492: if (typeof(caller) != "undefined") {
15493: document.filterpicker.updater.value = caller.name;
15494: }
15495: document.filterpicker.submit();
15496: }
1.1183 raeburn 15497:
15498: function hideSearching() {
15499: if (document.getElementById('searching')) {
15500: document.getElementById('searching').style.display = 'none';
15501: }
15502: return;
15503: }
15504:
1.1181 raeburn 15505: // ]]>
15506: </script>
15507:
15508: ENDJS
15509: }
15510:
15511: =pod
15512:
1.1182 raeburn 15513: =item * &search_courses()
15514:
15515: Process selected filters form course search form and pass to lonnet::courseiddump
15516: to retrieve a hash for which keys are courseIDs which match the selected filters.
15517:
15518: Inputs:
15519:
15520: dom - domain being searched
15521:
15522: type - course type ('Course' or 'Community' or '.' if any).
15523:
15524: filter - anonymous hash of criteria and their values
15525:
15526: numtitles - for institutional codes - number of categories
15527:
15528: cloneruname - optional username of new course owner
15529:
15530: clonerudom - optional domain of new course owner
15531:
15532: domcloner - Optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
15533: (used when DC is using course creation form)
15534:
15535: codetitles - reference to array of titles of components in institutional codes (official courses).
15536:
15537:
15538: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
15539:
15540:
15541: Side Effects: None
15542:
15543: =cut
15544:
15545:
15546: sub search_courses {
15547: my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles) = @_;
15548: my (%courses,%showcourses,$cloner);
15549: if (($filter->{'ownerfilter'} ne '') ||
15550: ($filter->{'ownerdomfilter'} ne '')) {
15551: $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
15552: $filter->{'ownerdomfilter'};
15553: }
15554: foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
15555: if (!$filter->{$item}) {
15556: $filter->{$item}='.';
15557: }
15558: }
15559: my $now = time;
15560: my $timefilter =
15561: ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
15562: my ($createdbefore,$createdafter);
15563: if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
15564: $createdbefore = $now;
15565: $createdafter = $now-$filter->{'createdfilter'};
15566: }
15567: my ($instcodefilter,$regexpok);
15568: if ($numtitles) {
15569: if ($env{'form.official'} eq 'on') {
15570: $instcodefilter =
15571: &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
15572: $regexpok = 1;
15573: } elsif ($env{'form.official'} eq 'off') {
15574: $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
15575: unless ($instcodefilter eq '') {
15576: $regexpok = -1;
15577: }
15578: }
15579: } else {
15580: $instcodefilter = $filter->{'instcodefilter'};
15581: }
15582: if ($instcodefilter eq '') { $instcodefilter = '.'; }
15583: if ($type eq '') { $type = '.'; }
15584:
15585: if (($clonerudom ne '') && ($cloneruname ne '')) {
15586: $cloner = $cloneruname.':'.$clonerudom;
15587: }
15588: %courses = &Apache::lonnet::courseiddump($dom,
15589: $filter->{'descriptfilter'},
15590: $timefilter,
15591: $instcodefilter,
15592: $filter->{'combownerfilter'},
15593: $filter->{'coursefilter'},
15594: undef,undef,$type,$regexpok,undef,undef,
15595: undef,undef,$cloner,$env{'form.cc_clone'},
15596: $filter->{'cloneableonly'},
15597: $createdbefore,$createdafter,undef,
15598: $domcloner);
15599: if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
15600: my $ccrole;
15601: if ($type eq 'Community') {
15602: $ccrole = 'co';
15603: } else {
15604: $ccrole = 'cc';
15605: }
15606: my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
15607: $filter->{'persondomfilter'},
15608: 'userroles',undef,
15609: [$ccrole,'in','ad','ep','ta','cr'],
15610: $dom);
15611: foreach my $role (keys(%rolehash)) {
15612: my ($cnum,$cdom,$courserole) = split(':',$role);
15613: my $cid = $cdom.'_'.$cnum;
15614: if (exists($courses{$cid})) {
15615: if (ref($courses{$cid}) eq 'HASH') {
15616: if (ref($courses{$cid}{roles}) eq 'ARRAY') {
15617: if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
15618: push (@{$courses{$cid}{roles}},$courserole);
15619: }
15620: } else {
15621: $courses{$cid}{roles} = [$courserole];
15622: }
15623: $showcourses{$cid} = $courses{$cid};
15624: }
15625: }
15626: }
15627: %courses = %showcourses;
15628: }
15629: return %courses;
15630: }
15631:
15632: =pod
15633:
1.1181 raeburn 15634: =back
15635:
1.1207 raeburn 15636: =head1 Routines for version requirements for current course.
15637:
15638: =over 4
15639:
15640: =item * &check_release_required()
15641:
15642: Compares required LON-CAPA version with version on server, and
15643: if required version is newer looks for a server with the required version.
15644:
15645: Looks first at servers in user's owen domain; if none suitable, looks at
15646: servers in course's domain are permitted to host sessions for user's domain.
15647:
15648: Inputs:
15649:
15650: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
15651:
15652: $courseid - Course ID of current course
15653:
15654: $rolecode - User's current role in course (for switchserver query string).
15655:
15656: $required - LON-CAPA version needed by course (format: Major.Minor).
15657:
15658:
15659: Returns:
15660:
15661: $switchserver - query string tp append to /adm/switchserver call (if
15662: current server's LON-CAPA version is too old.
15663:
15664: $warning - Message is displayed if no suitable server could be found.
15665:
15666: =cut
15667:
15668: sub check_release_required {
15669: my ($loncaparev,$courseid,$rolecode,$required) = @_;
15670: my ($switchserver,$warning);
15671: if ($required ne '') {
15672: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
15673: my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
15674: if ($reqdmajor ne '' && $reqdminor ne '') {
15675: my $otherserver;
15676: if (($major eq '' && $minor eq '') ||
15677: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
15678: my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
15679: my $switchlcrev =
15680: &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
15681: $userdomserver);
15682: my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
15683: if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
15684: (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
15685: my $cdom = $env{'course.'.$courseid.'.domain'};
15686: if ($cdom ne $env{'user.domain'}) {
15687: my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
15688: my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
15689: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
15690: my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
15691: my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
15692: my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
15693: my $canhost =
15694: &Apache::lonnet::can_host_session($env{'user.domain'},
15695: $coursedomserver,
15696: $remoterev,
15697: $udomdefaults{'remotesessions'},
15698: $defdomdefaults{'hostedsessions'});
15699:
15700: if ($canhost) {
15701: $otherserver = $coursedomserver;
15702: } else {
15703: $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.");
15704: }
15705: } else {
15706: $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).");
15707: }
15708: } else {
15709: $otherserver = $userdomserver;
15710: }
15711: }
15712: if ($otherserver ne '') {
15713: $switchserver = 'otherserver='.$otherserver.'&role='.$rolecode;
15714: }
15715: }
15716: }
15717: return ($switchserver,$warning);
15718: }
15719:
15720: =pod
15721:
15722: =item * &check_release_result()
15723:
15724: Inputs:
15725:
15726: $switchwarning - Warning message if no suitable server found to host session.
15727:
15728: $switchserver - query string to append to /adm/switchserver containing lonHostID
15729: and current role.
15730:
15731: Returns: HTML to display with information about requirement to switch server.
15732: Either displaying warning with link to Roles/Courses screen or
15733: display link to switchserver.
15734:
1.1181 raeburn 15735: =cut
15736:
1.1207 raeburn 15737: sub check_release_result {
15738: my ($switchwarning,$switchserver) = @_;
15739: my $output = &start_page('Selected course unavailable on this server').
15740: '<p class="LC_warning">';
15741: if ($switchwarning) {
15742: $output .= $switchwarning.'<br /><a href="/adm/roles">';
15743: if (&show_course()) {
15744: $output .= &mt('Display courses');
15745: } else {
15746: $output .= &mt('Display roles');
15747: }
15748: $output .= '</a>';
15749: } elsif ($switchserver) {
15750: $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
15751: '<br />'.
15752: '<a href="/adm/switchserver?'.$switchserver.'">'.
15753: &mt('Switch Server').
15754: '</a>';
15755: }
15756: $output .= '</p>'.&end_page();
15757: return $output;
15758: }
15759:
15760: =pod
15761:
15762: =item * &needs_coursereinit()
15763:
15764: Determine if course contents stored for user's session needs to be
15765: refreshed, because content has changed since "Big Hash" last tied.
15766:
15767: Check for change is made if time last checked is more than 10 minutes ago
15768: (by default).
15769:
15770: Inputs:
15771:
15772: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
15773:
15774: $interval (optional) - Time which may elapse (in s) between last check for content
15775: change in current course. (default: 600 s).
15776:
15777: Returns: an array; first element is:
15778:
15779: =over 4
15780:
15781: 'switch' - if content updates mean user's session
15782: needs to be switched to a server running a newer LON-CAPA version
15783:
15784: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
15785: on current server hosting user's session
15786:
15787: '' - if no action required.
15788:
15789: =back
15790:
15791: If first item element is 'switch':
15792:
15793: second item is $switchwarning - Warning message if no suitable server found to host session.
15794:
15795: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
15796: and current role.
15797:
15798: otherwise: no other elements returned.
15799:
15800: =back
15801:
15802: =cut
15803:
15804: sub needs_coursereinit {
15805: my ($loncaparev,$interval) = @_;
15806: return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
15807: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
15808: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
15809: my $now = time;
15810: if ($interval eq '') {
15811: $interval = 600;
15812: }
15813: if (($now-$env{'request.course.timechecked'})>$interval) {
15814: my $lastchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
15815: &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
15816: if ($lastchange > $env{'request.course.tied'}) {
15817: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
15818: if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
15819: my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
15820: if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
15821: &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
15822: $curr_reqd_hash{'internal.releaserequired'}});
15823: my ($switchserver,$switchwarning) =
15824: &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
15825: $curr_reqd_hash{'internal.releaserequired'});
15826: if ($switchwarning ne '' || $switchserver ne '') {
15827: return ('switch',$switchwarning,$switchserver);
15828: }
15829: }
15830: }
15831: return ('update');
15832: }
15833: }
15834: return ();
15835: }
1.1181 raeburn 15836:
1.1083 raeburn 15837: sub update_content_constraints {
15838: my ($cdom,$cnum,$chome,$cid) = @_;
15839: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
15840: my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
15841: my %checkresponsetypes;
15842: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
15843: my ($item,$name,$value) = split(/:/,$key);
15844: if ($item eq 'resourcetag') {
15845: if ($name eq 'responsetype') {
15846: $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
15847: }
15848: }
15849: }
15850: my $navmap = Apache::lonnavmaps::navmap->new();
15851: if (defined($navmap)) {
15852: my %allresponses;
15853: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() },1,0)) {
15854: my %responses = $res->responseTypes();
15855: foreach my $key (keys(%responses)) {
15856: next unless(exists($checkresponsetypes{$key}));
15857: $allresponses{$key} += $responses{$key};
15858: }
15859: }
15860: foreach my $key (keys(%allresponses)) {
15861: my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
15862: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
15863: ($reqdmajor,$reqdminor) = ($major,$minor);
15864: }
15865: }
15866: undef($navmap);
15867: }
15868: unless (($reqdmajor eq '') && ($reqdminor eq '')) {
15869: &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
15870: }
15871: return;
15872: }
15873:
1.1110 raeburn 15874: sub allmaps_incourse {
15875: my ($cdom,$cnum,$chome,$cid) = @_;
15876: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
15877: $cid = $env{'request.course.id'};
15878: $cdom = $env{'course.'.$cid.'.domain'};
15879: $cnum = $env{'course.'.$cid.'.num'};
15880: $chome = $env{'course.'.$cid.'.home'};
15881: }
15882: my %allmaps = ();
15883: my $lastchange =
15884: &Apache::lonnet::get_coursechange($cdom,$cnum);
15885: if ($lastchange > $env{'request.course.tied'}) {
15886: my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
15887: unless ($ferr) {
15888: &update_content_constraints($cdom,$cnum,$chome,$cid);
15889: }
15890: }
15891: my $navmap = Apache::lonnavmaps::navmap->new();
15892: if (defined($navmap)) {
15893: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
15894: $allmaps{$res->src()} = 1;
15895: }
15896: }
15897: return \%allmaps;
15898: }
15899:
1.1083 raeburn 15900: sub parse_supplemental_title {
15901: my ($title) = @_;
15902:
15903: my ($foldertitle,$renametitle);
15904: if ($title =~ /&&&/) {
15905: $title = &HTML::Entites::decode($title);
15906: }
15907: if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
15908: $renametitle=$4;
15909: my ($time,$uname,$udom) = ($1,$2,$3);
15910: $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
15911: my $name = &plainname($uname,$udom);
15912: $name = &HTML::Entities::encode($name,'"<>&\'');
15913: $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
15914: $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.
15915: $name.': <br />'.$foldertitle;
15916: }
15917: if (wantarray) {
15918: return ($title,$foldertitle,$renametitle);
15919: }
15920: return $title;
15921: }
15922:
1.1143 raeburn 15923: sub recurse_supplemental {
15924: my ($cnum,$cdom,$suppmap,$numfiles,$errors) = @_;
15925: if ($suppmap) {
15926: my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
15927: if ($fatal) {
15928: $errors ++;
15929: } else {
15930: if ($#LONCAPA::map::resources > 0) {
15931: foreach my $res (@LONCAPA::map::resources) {
15932: my ($title,$src,$ext,$type,$status)=split(/\:/,$res);
15933: if (($src ne '') && ($status eq 'res')) {
1.1146 raeburn 15934: if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
15935: ($numfiles,$errors) = &recurse_supplemental($cnum,$cdom,$1,$numfiles,$errors);
1.1143 raeburn 15936: } else {
15937: $numfiles ++;
15938: }
15939: }
15940: }
15941: }
15942: }
15943: }
15944: return ($numfiles,$errors);
15945: }
15946:
1.1101 raeburn 15947: sub symb_to_docspath {
15948: my ($symb) = @_;
15949: return unless ($symb);
15950: my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
15951: if ($resurl=~/\.(sequence|page)$/) {
15952: $mapurl=$resurl;
15953: } elsif ($resurl eq 'adm/navmaps') {
15954: $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
15955: }
15956: my $mapresobj;
15957: my $navmap = Apache::lonnavmaps::navmap->new();
15958: if (ref($navmap)) {
15959: $mapresobj = $navmap->getResourceByUrl($mapurl);
15960: }
15961: $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
15962: my $type=$2;
15963: my $path;
15964: if (ref($mapresobj)) {
15965: my $pcslist = $mapresobj->map_hierarchy();
15966: if ($pcslist ne '') {
15967: foreach my $pc (split(/,/,$pcslist)) {
15968: next if ($pc <= 1);
15969: my $res = $navmap->getByMapPc($pc);
15970: if (ref($res)) {
15971: my $thisurl = $res->src();
15972: $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
15973: my $thistitle = $res->title();
15974: $path .= '&'.
15975: &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1146 raeburn 15976: &escape($thistitle).
1.1101 raeburn 15977: ':'.$res->randompick().
15978: ':'.$res->randomout().
15979: ':'.$res->encrypted().
15980: ':'.$res->randomorder().
15981: ':'.$res->is_page();
15982: }
15983: }
15984: }
15985: $path =~ s/^\&//;
15986: my $maptitle = $mapresobj->title();
15987: if ($mapurl eq 'default') {
1.1129 raeburn 15988: $maptitle = 'Main Content';
1.1101 raeburn 15989: }
15990: $path .= (($path ne '')? '&' : '').
15991: &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 15992: &escape($maptitle).
1.1101 raeburn 15993: ':'.$mapresobj->randompick().
15994: ':'.$mapresobj->randomout().
15995: ':'.$mapresobj->encrypted().
15996: ':'.$mapresobj->randomorder().
15997: ':'.$mapresobj->is_page();
15998: } else {
15999: my $maptitle = &Apache::lonnet::gettitle($mapurl);
16000: my $ispage = (($type eq 'page')? 1 : '');
16001: if ($mapurl eq 'default') {
1.1129 raeburn 16002: $maptitle = 'Main Content';
1.1101 raeburn 16003: }
16004: $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 16005: &escape($maptitle).':::::'.$ispage;
1.1101 raeburn 16006: }
16007: unless ($mapurl eq 'default') {
16008: $path = 'default&'.
1.1146 raeburn 16009: &escape('Main Content').
1.1101 raeburn 16010: ':::::&'.$path;
16011: }
16012: return $path;
16013: }
16014:
1.1094 raeburn 16015: sub captcha_display {
16016: my ($context,$lonhost) = @_;
16017: my ($output,$error);
16018: my ($captcha,$pubkey,$privkey) = &get_captcha_config($context,$lonhost);
1.1095 raeburn 16019: if ($captcha eq 'original') {
1.1094 raeburn 16020: $output = &create_captcha();
16021: unless ($output) {
1.1172 raeburn 16022: $error = 'captcha';
1.1094 raeburn 16023: }
16024: } elsif ($captcha eq 'recaptcha') {
16025: $output = &create_recaptcha($pubkey);
16026: unless ($output) {
1.1172 raeburn 16027: $error = 'recaptcha';
1.1094 raeburn 16028: }
16029: }
1.1176 raeburn 16030: return ($output,$error,$captcha);
1.1094 raeburn 16031: }
16032:
16033: sub captcha_response {
16034: my ($context,$lonhost) = @_;
16035: my ($captcha_chk,$captcha_error);
16036: my ($captcha,$pubkey,$privkey) = &get_captcha_config($context,$lonhost);
1.1095 raeburn 16037: if ($captcha eq 'original') {
1.1094 raeburn 16038: ($captcha_chk,$captcha_error) = &check_captcha();
16039: } elsif ($captcha eq 'recaptcha') {
16040: $captcha_chk = &check_recaptcha($privkey);
16041: } else {
16042: $captcha_chk = 1;
16043: }
16044: return ($captcha_chk,$captcha_error);
16045: }
16046:
16047: sub get_captcha_config {
16048: my ($context,$lonhost) = @_;
1.1095 raeburn 16049: my ($captcha,$pubkey,$privkey,$hashtocheck);
1.1094 raeburn 16050: my $hostname = &Apache::lonnet::hostname($lonhost);
16051: my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
16052: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1.1095 raeburn 16053: if ($context eq 'usercreation') {
16054: my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
16055: if (ref($domconfig{$context}) eq 'HASH') {
16056: $hashtocheck = $domconfig{$context}{'cancreate'};
16057: if (ref($hashtocheck) eq 'HASH') {
16058: if ($hashtocheck->{'captcha'} eq 'recaptcha') {
16059: if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
16060: $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
16061: $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
16062: }
16063: if ($privkey && $pubkey) {
16064: $captcha = 'recaptcha';
16065: } else {
16066: $captcha = 'original';
16067: }
16068: } elsif ($hashtocheck->{'captcha'} ne 'notused') {
16069: $captcha = 'original';
16070: }
1.1094 raeburn 16071: }
1.1095 raeburn 16072: } else {
16073: $captcha = 'captcha';
16074: }
16075: } elsif ($context eq 'login') {
16076: my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
16077: if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
16078: $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
16079: $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
1.1094 raeburn 16080: if ($privkey && $pubkey) {
16081: $captcha = 'recaptcha';
1.1095 raeburn 16082: } else {
16083: $captcha = 'original';
1.1094 raeburn 16084: }
1.1095 raeburn 16085: } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
16086: $captcha = 'original';
1.1094 raeburn 16087: }
16088: }
16089: return ($captcha,$pubkey,$privkey);
16090: }
16091:
16092: sub create_captcha {
16093: my %captcha_params = &captcha_settings();
16094: my ($output,$maxtries,$tries) = ('',10,0);
16095: while ($tries < $maxtries) {
16096: $tries ++;
16097: my $captcha = Authen::Captcha->new (
16098: output_folder => $captcha_params{'output_dir'},
16099: data_folder => $captcha_params{'db_dir'},
16100: );
16101: my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
16102:
16103: if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
16104: $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
16105: &mt('Type in the letters/numbers shown below').' '.
1.1176 raeburn 16106: '<input type="text" size="5" name="code" value="" autocomplete="off" />'.
16107: '<br />'.
16108: '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1094 raeburn 16109: last;
16110: }
16111: }
16112: return $output;
16113: }
16114:
16115: sub captcha_settings {
16116: my %captcha_params = (
16117: output_dir => $Apache::lonnet::perlvar{'lonCaptchaDir'},
16118: www_output_dir => "/captchaspool",
16119: db_dir => $Apache::lonnet::perlvar{'lonCaptchaDb'},
16120: numchars => '5',
16121: );
16122: return %captcha_params;
16123: }
16124:
16125: sub check_captcha {
16126: my ($captcha_chk,$captcha_error);
16127: my $code = $env{'form.code'};
16128: my $md5sum = $env{'form.crypt'};
16129: my %captcha_params = &captcha_settings();
16130: my $captcha = Authen::Captcha->new(
16131: output_folder => $captcha_params{'output_dir'},
16132: data_folder => $captcha_params{'db_dir'},
16133: );
1.1109 raeburn 16134: $captcha_chk = $captcha->check_code($code,$md5sum);
1.1094 raeburn 16135: my %captcha_hash = (
16136: 0 => 'Code not checked (file error)',
16137: -1 => 'Failed: code expired',
16138: -2 => 'Failed: invalid code (not in database)',
16139: -3 => 'Failed: invalid code (code does not match crypt)',
16140: );
16141: if ($captcha_chk != 1) {
16142: $captcha_error = $captcha_hash{$captcha_chk}
16143: }
16144: return ($captcha_chk,$captcha_error);
16145: }
16146:
16147: sub create_recaptcha {
16148: my ($pubkey) = @_;
1.1153 raeburn 16149: my $use_ssl;
16150: if ($ENV{'SERVER_PORT'} == 443) {
16151: $use_ssl = 1;
16152: }
1.1094 raeburn 16153: my $captcha = Captcha::reCAPTCHA->new;
16154: return $captcha->get_options_setter({theme => 'white'})."\n".
1.1153 raeburn 16155: $captcha->get_html($pubkey,undef,$use_ssl).
1.1094 raeburn 16156: &mt('If either word is hard to read, [_1] will replace them.',
1.1133 raeburn 16157: '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
1.1094 raeburn 16158: '<br /><br />';
16159: }
16160:
16161: sub check_recaptcha {
16162: my ($privkey) = @_;
16163: my $captcha_chk;
16164: my $captcha = Captcha::reCAPTCHA->new;
16165: my $captcha_result =
16166: $captcha->check_answer(
16167: $privkey,
16168: $ENV{'REMOTE_ADDR'},
16169: $env{'form.recaptcha_challenge_field'},
16170: $env{'form.recaptcha_response_field'},
16171: );
16172: if ($captcha_result->{is_valid}) {
16173: $captcha_chk = 1;
16174: }
16175: return $captcha_chk;
16176: }
16177:
1.1174 raeburn 16178: sub emailusername_info {
1.1177 raeburn 16179: my @fields = ('firstname','lastname','institution','web','location','officialemail');
1.1174 raeburn 16180: my %titles = &Apache::lonlocal::texthash (
16181: lastname => 'Last Name',
16182: firstname => 'First Name',
16183: institution => 'School/college/university',
16184: location => "School's city, state/province, country",
16185: web => "School's web address",
16186: officialemail => 'E-mail address at institution (if different)',
16187: );
16188: return (\@fields,\%titles);
16189: }
16190:
1.1161 raeburn 16191: sub cleanup_html {
16192: my ($incoming) = @_;
16193: my $outgoing;
16194: if ($incoming ne '') {
16195: $outgoing = $incoming;
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: $outgoing =~ s/"/"/g;
16204: $outgoing =~ s/'/'/g;
16205: $outgoing =~ s/\$/$/g;
16206: $outgoing =~ s{/}{/}g;
16207: $outgoing =~ s/=/=/g;
16208: $outgoing =~ s/\\/\/g
16209: }
16210: return $outgoing;
16211: }
16212:
1.1190 musolffc 16213: # Checks for critical messages and returns a redirect url if one exists.
16214: # $interval indicates how often to check for messages.
16215: sub critical_redirect {
16216: my ($interval) = @_;
16217: if ((time-$env{'user.criticalcheck.time'})>$interval) {
16218: my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
16219: $env{'user.name'});
16220: &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
1.1191 raeburn 16221: my $redirecturl;
1.1190 musolffc 16222: if ($what[0]) {
16223: if (($what[0] ne 'con_lost') && ($what[0]!~/^error\:/)) {
16224: $redirecturl='/adm/email?critical=display';
1.1191 raeburn 16225: my $url=&Apache::lonnet::absolute_url().$redirecturl;
16226: return (1, $url);
1.1190 musolffc 16227: }
1.1191 raeburn 16228: }
16229: }
16230: return ();
1.1190 musolffc 16231: }
16232:
1.1174 raeburn 16233: # Use:
16234: # my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
16235: #
16236: ##################################################
16237: # password associated functions #
16238: ##################################################
16239: sub des_keys {
16240: # Make a new key for DES encryption.
16241: # Each key has two parts which are returned separately.
16242: # Please note: Each key must be passed through the &hex function
16243: # before it is output to the web browser. The hex versions cannot
16244: # be used to decrypt.
16245: my @hexstr=('0','1','2','3','4','5','6','7',
16246: '8','9','a','b','c','d','e','f');
16247: my $lkey='';
16248: for (0..7) {
16249: $lkey.=$hexstr[rand(15)];
16250: }
16251: my $ukey='';
16252: for (0..7) {
16253: $ukey.=$hexstr[rand(15)];
16254: }
16255: return ($lkey,$ukey);
16256: }
16257:
16258: sub des_decrypt {
16259: my ($key,$cyphertext) = @_;
16260: my $keybin=pack("H16",$key);
16261: my $cypher;
16262: if ($Crypt::DES::VERSION>=2.03) {
16263: $cypher=new Crypt::DES $keybin;
16264: } else {
16265: $cypher=new DES $keybin;
16266: }
16267: my $plaintext=
16268: $cypher->decrypt(unpack("a8",pack("H16",substr($cyphertext,0,16))));
16269: $plaintext.=
16270: $cypher->decrypt(unpack("a8",pack("H16",substr($cyphertext,16,16))));
16271: $plaintext=substr($plaintext,1,ord(substr($plaintext,0,1)) );
16272: return $plaintext;
16273: }
16274:
1.112 bowersj2 16275: 1;
16276: __END__;
1.41 ng 16277:
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