Annotation of loncom/interface/loncommon.pm, revision 1.1407
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1407 ! raeburn 4: # $Id: loncommon.pm,v 1.1406 2023/06/10 23:55:36 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.1383 raeburn 64: use Apache::lonnavmaps();
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.1280 raeburn 74: use LONCAPA::LWPReq;
1.1395 raeburn 75: use LONCAPA::map();
1.1328 raeburn 76: use HTTP::Request;
1.657 raeburn 77: use DateTime::TimeZone;
1.1241 raeburn 78: use DateTime::Locale;
1.1220 raeburn 79: use Encode();
1.1091 foxr 80: use Text::Aspell;
1.1094 raeburn 81: use Authen::Captcha;
82: use Captcha::reCAPTCHA;
1.1234 raeburn 83: use JSON::DWIW;
1.1174 raeburn 84: use Crypt::DES;
85: use DynaLoader; # for Crypt::DES version
1.1223 musolffc 86: use MIME::Lite;
87: use MIME::Types;
1.1292 raeburn 88: use File::Copy();
1.1300 raeburn 89: use File::Path();
1.1309 raeburn 90: use String::CRC32();
91: use Short::URL();
1.117 www 92:
1.517 raeburn 93: # ---------------------------------------------- Designs
94: use vars qw(%defaultdesign);
95:
1.22 www 96: my $readit;
97:
1.517 raeburn 98:
1.157 matthew 99: ##
100: ## Global Variables
101: ##
1.46 matthew 102:
1.643 foxr 103:
104: # ----------------------------------------------- SSI with retries:
105: #
106:
107: =pod
108:
1.648 raeburn 109: =head1 Server Side include with retries:
1.643 foxr 110:
111: =over 4
112:
1.648 raeburn 113: =item * &ssi_with_retries(resource,retries form)
1.643 foxr 114:
115: Performs an ssi with some number of retries. Retries continue either
116: until the result is ok or until the retry count supplied by the
117: caller is exhausted.
118:
119: Inputs:
1.648 raeburn 120:
121: =over 4
122:
1.643 foxr 123: resource - Identifies the resource to insert.
1.648 raeburn 124:
1.643 foxr 125: retries - Count of the number of retries allowed.
1.648 raeburn 126:
1.643 foxr 127: form - Hash that identifies the rendering options.
128:
1.648 raeburn 129: =back
130:
131: Returns:
132:
133: =over 4
134:
1.643 foxr 135: content - The content of the response. If retries were exhausted this is empty.
1.648 raeburn 136:
1.643 foxr 137: response - The response from the last attempt (which may or may not have been successful.
138:
1.648 raeburn 139: =back
140:
141: =back
142:
1.643 foxr 143: =cut
144:
145: sub ssi_with_retries {
146: my ($resource, $retries, %form) = @_;
147:
148:
149: my $ok = 0; # True if we got a good response.
150: my $content;
151: my $response;
152:
153: # Try to get the ssi done. within the retries count:
154:
155: do {
156: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
157: $ok = $response->is_success;
1.650 www 158: if (!$ok) {
159: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
160: }
1.643 foxr 161: $retries--;
162: } while (!$ok && ($retries > 0));
163:
164: if (!$ok) {
165: $content = ''; # On error return an empty content.
166: }
167: return ($content, $response);
168:
169: }
170:
171:
172:
1.20 www 173: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 174: my %language;
1.124 www 175: my %supported_language;
1.1088 foxr 176: my %supported_codes;
1.1048 foxr 177: my %latex_language; # For choosing hyphenation in <transl..>
178: my %latex_language_bykey; # for choosing hyphenation from metadata
1.12 harris41 179: my %cprtag;
1.192 taceyjo1 180: my %scprtag;
1.351 www 181: my %fe; my %fd; my %fm;
1.41 ng 182: my %category_extensions;
1.12 harris41 183:
1.46 matthew 184: # ---------------------------------------------- Thesaurus variables
1.144 matthew 185: #
186: # %Keywords:
187: # A hash used by &keyword to determine if a word is considered a keyword.
188: # $thesaurus_db_file
189: # Scalar containing the full path to the thesaurus database.
1.46 matthew 190:
191: my %Keywords;
192: my $thesaurus_db_file;
193:
1.144 matthew 194: #
195: # Initialize values from language.tab, copyright.tab, filetypes.tab,
196: # thesaurus.tab, and filecategories.tab.
197: #
1.18 www 198: BEGIN {
1.46 matthew 199: # Variable initialization
200: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
201: #
1.22 www 202: unless ($readit) {
1.12 harris41 203: # ------------------------------------------------------------------- languages
204: {
1.158 raeburn 205: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
206: '/language.tab';
1.1317 raeburn 207: if ( open(my $fh,'<',$langtabfile) ) {
1.356 albertel 208: while (my $line = <$fh>) {
209: next if ($line=~/^\#/);
210: chomp($line);
1.1088 foxr 211: my ($key,$code,$country,$three,$enc,$val,$sup,$latex)=(split(/\t/,$line));
1.158 raeburn 212: $language{$key}=$val.' - '.$enc;
213: if ($sup) {
214: $supported_language{$key}=$sup;
1.1088 foxr 215: $supported_codes{$key} = $code;
1.158 raeburn 216: }
1.1048 foxr 217: if ($latex) {
218: $latex_language_bykey{$key} = $latex;
1.1088 foxr 219: $latex_language{$code} = $latex;
1.1048 foxr 220: }
1.158 raeburn 221: }
222: close($fh);
223: }
1.12 harris41 224: }
225: # ------------------------------------------------------------------ copyrights
226: {
1.158 raeburn 227: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
228: '/copyright.tab';
1.1317 raeburn 229: if ( open (my $fh,'<',$copyrightfile) ) {
1.356 albertel 230: while (my $line = <$fh>) {
231: next if ($line=~/^\#/);
232: chomp($line);
233: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 234: $cprtag{$key}=$val;
235: }
236: close($fh);
237: }
1.12 harris41 238: }
1.351 www 239: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 240: {
241: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
242: '/source_copyright.tab';
1.1317 raeburn 243: if ( open (my $fh,'<',$sourcecopyrightfile) ) {
1.356 albertel 244: while (my $line = <$fh>) {
245: next if ($line =~ /^\#/);
246: chomp($line);
247: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 248: $scprtag{$key}=$val;
249: }
250: close($fh);
251: }
252: }
1.63 www 253:
1.517 raeburn 254: # -------------------------------------------------------------- default domain designs
1.63 www 255: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 256: my $designfile = $designdir.'/default.tab';
1.1317 raeburn 257: if ( open (my $fh,'<',$designfile) ) {
1.517 raeburn 258: while (my $line = <$fh>) {
259: next if ($line =~ /^\#/);
260: chomp($line);
261: my ($key,$val)=(split(/\=/,$line));
262: if ($val) { $defaultdesign{$key}=$val; }
263: }
264: close($fh);
1.63 www 265: }
266:
1.15 harris41 267: # ------------------------------------------------------------- file categories
268: {
1.158 raeburn 269: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
270: '/filecategories.tab';
1.1317 raeburn 271: if ( open (my $fh,'<',$categoryfile) ) {
1.356 albertel 272: while (my $line = <$fh>) {
273: next if ($line =~ /^\#/);
274: chomp($line);
275: my ($extension,$category)=(split(/\s+/,$line,2));
1.1263 raeburn 276: push(@{$category_extensions{lc($category)}},$extension);
1.158 raeburn 277: }
278: close($fh);
279: }
280:
1.15 harris41 281: }
1.12 harris41 282: # ------------------------------------------------------------------ file types
283: {
1.158 raeburn 284: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
285: '/filetypes.tab';
1.1317 raeburn 286: if ( open (my $fh,'<',$typesfile) ) {
1.356 albertel 287: while (my $line = <$fh>) {
288: next if ($line =~ /^\#/);
289: chomp($line);
290: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 291: if ($descr ne '') {
292: $fe{$ending}=lc($emb);
293: $fd{$ending}=$descr;
1.351 www 294: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 295: }
296: }
297: close($fh);
298: }
1.12 harris41 299: }
1.22 www 300: &Apache::lonnet::logthis(
1.705 tempelho 301: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 302: $readit=1;
1.46 matthew 303: } # end of unless($readit)
1.32 matthew 304:
305: }
1.112 bowersj2 306:
1.42 matthew 307: ###############################################################
308: ## HTML and Javascript Helper Functions ##
309: ###############################################################
310:
311: =pod
312:
1.112 bowersj2 313: =head1 HTML and Javascript Functions
1.42 matthew 314:
1.112 bowersj2 315: =over 4
316:
1.648 raeburn 317: =item * &browser_and_searcher_javascript()
1.112 bowersj2 318:
319: X<browsing, javascript>X<searching, javascript>Returns a string
320: containing javascript with two functions, C<openbrowser> and
321: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
322: tags.
1.42 matthew 323:
1.648 raeburn 324: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 325:
326: inputs: formname, elementname, only, omit
327:
328: formname and elementname indicate the name of the html form and name of
329: the element that the results of the browsing selection are to be placed in.
330:
331: Specifying 'only' will restrict the browser to displaying only files
1.185 www 332: with the given extension. Can be a comma separated list.
1.42 matthew 333:
334: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 335: with the given extension. Can be a comma separated list.
1.42 matthew 336:
1.648 raeburn 337: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 338:
339: Inputs: formname, elementname
340:
341: formname and elementname specify the name of the html form and the name
342: of the element the selection from the search results will be placed in.
1.542 raeburn 343:
1.42 matthew 344: =cut
345:
346: sub browser_and_searcher_javascript {
1.199 albertel 347: my ($mode)=@_;
348: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 349: my $resurl=&escape_single(&lastresurl());
1.42 matthew 350: return <<END;
1.219 albertel 351: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 352: var editbrowser = null;
1.135 albertel 353: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 354: var url = '$resurl/?';
1.42 matthew 355: if (editbrowser == null) {
356: url += 'launch=1&';
357: }
358: url += 'catalogmode=interactive&';
1.199 albertel 359: url += 'mode=$mode&';
1.611 albertel 360: url += 'inhibitmenu=yes&';
1.42 matthew 361: url += 'form=' + formname + '&';
362: if (only != null) {
363: url += 'only=' + only + '&';
1.217 albertel 364: } else {
365: url += 'only=&';
366: }
1.42 matthew 367: if (omit != null) {
368: url += 'omit=' + omit + '&';
1.217 albertel 369: } else {
370: url += 'omit=&';
371: }
1.135 albertel 372: if (titleelement != null) {
373: url += 'titleelement=' + titleelement + '&';
1.217 albertel 374: } else {
375: url += 'titleelement=&';
376: }
1.42 matthew 377: url += 'element=' + elementname + '';
378: var title = 'Browser';
1.435 albertel 379: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 380: options += ',width=700,height=600';
381: editbrowser = open(url,title,options,'1');
382: editbrowser.focus();
383: }
384: var editsearcher;
1.135 albertel 385: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 386: var url = '/adm/searchcat?';
387: if (editsearcher == null) {
388: url += 'launch=1&';
389: }
390: url += 'catalogmode=interactive&';
1.199 albertel 391: url += 'mode=$mode&';
1.42 matthew 392: url += 'form=' + formname + '&';
1.135 albertel 393: if (titleelement != null) {
394: url += 'titleelement=' + titleelement + '&';
1.217 albertel 395: } else {
396: url += 'titleelement=&';
397: }
1.42 matthew 398: url += 'element=' + elementname + '';
399: var title = 'Search';
1.435 albertel 400: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 401: options += ',width=700,height=600';
402: editsearcher = open(url,title,options,'1');
403: editsearcher.focus();
404: }
1.219 albertel 405: // END LON-CAPA Internal -->
1.42 matthew 406: END
1.170 www 407: }
408:
409: sub lastresurl {
1.258 albertel 410: if ($env{'environment.lastresurl'}) {
411: return $env{'environment.lastresurl'}
1.170 www 412: } else {
413: return '/res';
414: }
415: }
416:
417: sub storeresurl {
418: my $resurl=&Apache::lonnet::clutter(shift);
419: unless ($resurl=~/^\/res/) { return 0; }
420: $resurl=~s/\/$//;
421: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 422: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 423: return 1;
1.42 matthew 424: }
425:
1.74 www 426: sub studentbrowser_javascript {
1.111 www 427: unless (
1.258 albertel 428: (($env{'request.course.id'}) &&
1.302 albertel 429: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
430: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
431: '/'.$env{'request.course.sec'})
432: ))
1.258 albertel 433: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 434: ) { return ''; }
1.74 www 435: return (<<'ENDSTDBRW');
1.776 bisitz 436: <script type="text/javascript" language="Javascript">
1.824 bisitz 437: // <![CDATA[
1.74 www 438: var stdeditbrowser;
1.1337 raeburn 439: function openstdbrowser(formname,uname,udom,clicker,roleflag,ignorefilter,courseadv) {
1.74 www 440: var url = '/adm/pickstudent?';
441: var filter;
1.558 albertel 442: if (!ignorefilter) {
443: eval('filter=document.'+formname+'.'+uname+'.value;');
444: }
1.74 www 445: if (filter != null) {
446: if (filter != '') {
447: url += 'filter='+filter+'&';
448: }
449: }
450: url += 'form=' + formname + '&unameelement='+uname+
1.999 www 451: '&udomelement='+udom+
452: '&clicker='+clicker;
1.111 www 453: if (roleflag) { url+="&roles=1"; }
1.1337 raeburn 454: if (courseadv == 'condition') {
455: if (document.getElementById('courseadv')) {
456: courseadv = document.getElementById('courseadv').value;
457: }
458: }
459: if ((courseadv == 'only') || (courseadv == 'none')) { url+="&courseadv="+courseadv; }
1.102 www 460: var title = 'Student_Browser';
1.74 www 461: var options = 'scrollbars=1,resizable=1,menubar=0';
462: options += ',width=700,height=600';
463: stdeditbrowser = open(url,title,options,'1');
464: stdeditbrowser.focus();
465: }
1.824 bisitz 466: // ]]>
1.74 www 467: </script>
468: ENDSTDBRW
469: }
1.42 matthew 470:
1.1003 www 471: sub resourcebrowser_javascript {
472: unless ($env{'request.course.id'}) { return ''; }
1.1004 www 473: return (<<'ENDRESBRW');
1.1003 www 474: <script type="text/javascript" language="Javascript">
475: // <![CDATA[
476: var reseditbrowser;
1.1004 www 477: function openresbrowser(formname,reslink) {
1.1005 www 478: var url = '/adm/pickresource?form='+formname+'&reslink='+reslink;
1.1003 www 479: var title = 'Resource_Browser';
480: var options = 'scrollbars=1,resizable=1,menubar=0';
1.1005 www 481: options += ',width=700,height=500';
1.1004 www 482: reseditbrowser = open(url,title,options,'1');
483: reseditbrowser.focus();
1.1003 www 484: }
485: // ]]>
486: </script>
1.1004 www 487: ENDRESBRW
1.1003 www 488: }
489:
1.74 www 490: sub selectstudent_link {
1.1337 raeburn 491: my ($form,$unameele,$udomele,$courseadv,$clickerid)=@_;
1.999 www 492: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
493: &Apache::lonhtmlcommon::entity_encode($unameele)."','".
494: &Apache::lonhtmlcommon::entity_encode($udomele)."'";
1.258 albertel 495: if ($env{'request.course.id'}) {
1.302 albertel 496: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
497: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
498: '/'.$env{'request.course.sec'})) {
1.111 www 499: return '';
500: }
1.999 www 501: $callargs.=",'".&Apache::lonhtmlcommon::entity_encode($clickerid)."'";
1.1337 raeburn 502: if ($courseadv eq 'only') {
503: $callargs .= ",'',1,'$courseadv'";
504: } elsif ($courseadv eq 'none') {
505: $callargs .= ",'','','$courseadv'";
506: } elsif ($courseadv eq 'condition') {
507: $callargs .= ",'','','$courseadv'";
1.793 raeburn 508: }
509: return '<span class="LC_nobreak">'.
510: '<a href="javascript:openstdbrowser('.$callargs.');">'.
511: &mt('Select User').'</a></span>';
1.74 www 512: }
1.258 albertel 513: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.1012 www 514: $callargs .= ",'',1";
1.793 raeburn 515: return '<span class="LC_nobreak">'.
516: '<a href="javascript:openstdbrowser('.$callargs.');">'.
517: &mt('Select User').'</a></span>';
1.111 www 518: }
519: return '';
1.91 www 520: }
521:
1.1004 www 522: sub selectresource_link {
523: my ($form,$reslink,$arg)=@_;
524:
525: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
526: &Apache::lonhtmlcommon::entity_encode($reslink)."'";
527: unless ($env{'request.course.id'}) { return $arg; }
528: return '<span class="LC_nobreak">'.
529: '<a href="javascript:openresbrowser('.$callargs.');">'.
530: $arg.'</a></span>';
531: }
532:
533:
534:
1.653 raeburn 535: sub authorbrowser_javascript {
536: return <<"ENDAUTHORBRW";
1.776 bisitz 537: <script type="text/javascript" language="JavaScript">
1.824 bisitz 538: // <![CDATA[
1.653 raeburn 539: var stdeditbrowser;
540:
541: function openauthorbrowser(formname,udom) {
542: var url = '/adm/pickauthor?';
543: url += 'form='+formname+'&roledom='+udom;
544: var title = 'Author_Browser';
545: var options = 'scrollbars=1,resizable=1,menubar=0';
546: options += ',width=700,height=600';
547: stdeditbrowser = open(url,title,options,'1');
548: stdeditbrowser.focus();
549: }
550:
1.824 bisitz 551: // ]]>
1.653 raeburn 552: </script>
553: ENDAUTHORBRW
554: }
555:
1.91 www 556: sub coursebrowser_javascript {
1.1116 raeburn 557: my ($domainfilter,$sec_element,$formname,$role_element,$crstype,
1.1221 raeburn 558: $credits_element,$instcode) = @_;
1.932 raeburn 559: my $wintitle = 'Course_Browser';
1.931 raeburn 560: if ($crstype eq 'Community') {
1.932 raeburn 561: $wintitle = 'Community_Browser';
1.909 raeburn 562: }
1.876 raeburn 563: my $id_functions = &javascript_index_functions();
564: my $output = '
1.776 bisitz 565: <script type="text/javascript" language="JavaScript">
1.824 bisitz 566: // <![CDATA[
1.468 raeburn 567: var stdeditbrowser;'."\n";
1.876 raeburn 568:
569: $output .= <<"ENDSTDBRW";
1.909 raeburn 570: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91 www 571: var url = '/adm/pickcourse?';
1.895 raeburn 572: var formid = getFormIdByName(formname);
1.876 raeburn 573: var domainfilter = getDomainFromSelectbox(formname,udom);
1.128 albertel 574: if (domainfilter != null) {
575: if (domainfilter != '') {
576: url += 'domainfilter='+domainfilter+'&';
577: }
578: }
1.91 www 579: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 580: '&cdomelement='+udom+
581: '&cnameelement='+desc;
1.468 raeburn 582: if (extra_element !=null && extra_element != '') {
1.594 raeburn 583: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 584: url += '&roleelement='+extra_element;
585: if (domainfilter == null || domainfilter == '') {
586: url += '&domainfilter='+extra_element;
587: }
1.234 raeburn 588: }
1.468 raeburn 589: else {
590: if (formname == 'portform') {
591: url += '&setroles='+extra_element;
1.800 raeburn 592: } else {
593: if (formname == 'rules') {
594: url += '&fixeddom='+extra_element;
595: }
1.468 raeburn 596: }
597: }
1.230 raeburn 598: }
1.909 raeburn 599: if (type != null && type != '') {
600: url += '&type='+type;
601: }
602: if (type_elem != null && type_elem != '') {
603: url += '&typeelement='+type_elem;
604: }
1.872 raeburn 605: if (formname == 'ccrs') {
606: var ownername = document.forms[formid].ccuname.value;
607: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
1.1238 raeburn 608: url += '&cloner='+ownername+':'+ownerdom;
609: if (type == 'Course') {
610: url += '&crscode='+document.forms[formid].crscode.value;
611: }
1.1221 raeburn 612: }
613: if (formname == 'requestcrs') {
614: url += '&crsdom=$domainfilter&crscode=$instcode';
1.872 raeburn 615: }
1.293 raeburn 616: if (multflag !=null && multflag != '') {
617: url += '&multiple='+multflag;
618: }
1.909 raeburn 619: var title = '$wintitle';
1.91 www 620: var options = 'scrollbars=1,resizable=1,menubar=0';
621: options += ',width=700,height=600';
622: stdeditbrowser = open(url,title,options,'1');
623: stdeditbrowser.focus();
624: }
1.876 raeburn 625: $id_functions
626: ENDSTDBRW
1.1116 raeburn 627: if (($sec_element ne '') || ($role_element ne '') || ($credits_element ne '')) {
628: $output .= &setsec_javascript($sec_element,$formname,$role_element,
629: $credits_element);
1.876 raeburn 630: }
631: $output .= '
632: // ]]>
633: </script>';
634: return $output;
635: }
636:
637: sub javascript_index_functions {
638: return <<"ENDJS";
639:
640: function getFormIdByName(formname) {
641: for (var i=0;i<document.forms.length;i++) {
642: if (document.forms[i].name == formname) {
643: return i;
644: }
645: }
646: return -1;
647: }
648:
649: function getIndexByName(formid,item) {
650: for (var i=0;i<document.forms[formid].elements.length;i++) {
651: if (document.forms[formid].elements[i].name == item) {
652: return i;
653: }
654: }
655: return -1;
656: }
1.468 raeburn 657:
1.876 raeburn 658: function getDomainFromSelectbox(formname,udom) {
659: var userdom;
660: var formid = getFormIdByName(formname);
661: if (formid > -1) {
662: var domid = getIndexByName(formid,udom);
663: if (domid > -1) {
664: if (document.forms[formid].elements[domid].type == 'select-one') {
665: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
666: }
667: if (document.forms[formid].elements[domid].type == 'hidden') {
668: userdom=document.forms[formid].elements[domid].value;
1.468 raeburn 669: }
670: }
671: }
1.876 raeburn 672: return userdom;
673: }
674:
675: ENDJS
1.468 raeburn 676:
1.876 raeburn 677: }
678:
1.1017 raeburn 679: sub javascript_array_indexof {
1.1018 raeburn 680: return <<ENDJS;
1.1017 raeburn 681: <script type="text/javascript" language="JavaScript">
682: // <![CDATA[
683:
684: if (!Array.prototype.indexOf) {
685: Array.prototype.indexOf = function (searchElement /*, fromIndex */ ) {
686: "use strict";
687: if (this === void 0 || this === null) {
688: throw new TypeError();
689: }
690: var t = Object(this);
691: var len = t.length >>> 0;
692: if (len === 0) {
693: return -1;
694: }
695: var n = 0;
696: if (arguments.length > 0) {
697: n = Number(arguments[1]);
1.1088 foxr 698: if (n !== n) { // shortcut for verifying if it is NaN
1.1017 raeburn 699: n = 0;
700: } else if (n !== 0 && n !== (1 / 0) && n !== -(1 / 0)) {
701: n = (n > 0 || -1) * Math.floor(Math.abs(n));
702: }
703: }
704: if (n >= len) {
705: return -1;
706: }
707: var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
708: for (; k < len; k++) {
709: if (k in t && t[k] === searchElement) {
710: return k;
711: }
712: }
713: return -1;
714: }
715: }
716:
717: // ]]>
718: </script>
719:
720: ENDJS
721:
722: }
723:
1.876 raeburn 724: sub userbrowser_javascript {
725: my $id_functions = &javascript_index_functions();
726: return <<"ENDUSERBRW";
727:
1.888 raeburn 728: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876 raeburn 729: var url = '/adm/pickuser?';
730: var userdom = getDomainFromSelectbox(formname,udom);
731: if (userdom != null) {
732: if (userdom != '') {
733: url += 'srchdom='+userdom+'&';
734: }
735: }
736: url += 'form=' + formname + '&unameelement='+uname+
737: '&udomelement='+udom+
738: '&ulastelement='+ulast+
739: '&ufirstelement='+ufirst+
740: '&uemailelement='+uemail+
1.881 raeburn 741: '&hideudomelement='+hideudom+
742: '&coursedom='+crsdom;
1.888 raeburn 743: if ((caller != null) && (caller != undefined)) {
744: url += '&caller='+caller;
745: }
1.876 raeburn 746: var title = 'User_Browser';
747: var options = 'scrollbars=1,resizable=1,menubar=0';
748: options += ',width=700,height=600';
749: var stdeditbrowser = open(url,title,options,'1');
750: stdeditbrowser.focus();
751: }
752:
1.888 raeburn 753: function fix_domain (formname,udom,origdom,uname) {
1.876 raeburn 754: var formid = getFormIdByName(formname);
755: if (formid > -1) {
1.888 raeburn 756: var unameid = getIndexByName(formid,uname);
1.876 raeburn 757: var domid = getIndexByName(formid,udom);
758: var hidedomid = getIndexByName(formid,origdom);
759: if (hidedomid > -1) {
760: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888 raeburn 761: var unameval = document.forms[formid].elements[unameid].value;
762: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
763: if (domid > -1) {
764: var slct = document.forms[formid].elements[domid];
765: if (slct.type == 'select-one') {
766: var i;
767: for (i=0;i<slct.length;i++) {
768: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
769: }
770: }
771: if (slct.type == 'hidden') {
772: slct.value = fixeddom;
1.876 raeburn 773: }
774: }
1.468 raeburn 775: }
776: }
777: }
1.876 raeburn 778: return;
779: }
780:
781: $id_functions
782: ENDUSERBRW
1.468 raeburn 783: }
784:
785: sub setsec_javascript {
1.1116 raeburn 786: my ($sec_element,$formname,$role_element,$credits_element) = @_;
1.905 raeburn 787: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
788: $communityrolestr);
789: if ($role_element ne '') {
790: my @allroles = ('st','ta','ep','in','ad');
791: foreach my $crstype ('Course','Community') {
792: if ($crstype eq 'Community') {
793: foreach my $role (@allroles) {
794: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
795: }
796: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
797: } else {
798: foreach my $role (@allroles) {
799: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
800: }
801: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
802: }
803: }
804: $rolestr = '"'.join('","',@allroles).'"';
805: $courserolestr = '"'.join('","',@courserolenames).'"';
806: $communityrolestr = '"'.join('","',@communityrolenames).'"';
807: }
1.468 raeburn 808: my $setsections = qq|
809: function setSect(sectionlist) {
1.629 raeburn 810: var sectionsArray = new Array();
811: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
812: sectionsArray = sectionlist.split(",");
813: }
1.468 raeburn 814: var numSections = sectionsArray.length;
815: document.$formname.$sec_element.length = 0;
816: if (numSections == 0) {
817: document.$formname.$sec_element.multiple=false;
818: document.$formname.$sec_element.size=1;
819: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
820: } else {
821: if (numSections == 1) {
822: document.$formname.$sec_element.multiple=false;
823: document.$formname.$sec_element.size=1;
824: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
825: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
826: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
827: } else {
828: for (var i=0; i<numSections; i++) {
829: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
830: }
831: document.$formname.$sec_element.multiple=true
832: if (numSections < 3) {
833: document.$formname.$sec_element.size=numSections;
834: } else {
835: document.$formname.$sec_element.size=3;
836: }
837: document.$formname.$sec_element.options[0].selected = false
838: }
839: }
1.91 www 840: }
1.905 raeburn 841:
842: function setRole(crstype) {
1.468 raeburn 843: |;
1.905 raeburn 844: if ($role_element eq '') {
845: $setsections .= ' return;
846: }
847: ';
848: } else {
849: $setsections .= qq|
850: var elementLength = document.$formname.$role_element.length;
851: var allroles = Array($rolestr);
852: var courserolenames = Array($courserolestr);
853: var communityrolenames = Array($communityrolestr);
854: if (elementLength != undefined) {
855: if (document.$formname.$role_element.options[5].value == 'cc') {
856: if (crstype == 'Course') {
857: return;
858: } else {
859: allroles[5] = 'co';
860: for (var i=0; i<6; i++) {
861: document.$formname.$role_element.options[i].value = allroles[i];
862: document.$formname.$role_element.options[i].text = communityrolenames[i];
863: }
864: }
865: } else {
866: if (crstype == 'Community') {
867: return;
868: } else {
869: allroles[5] = 'cc';
870: for (var i=0; i<6; i++) {
871: document.$formname.$role_element.options[i].value = allroles[i];
872: document.$formname.$role_element.options[i].text = courserolenames[i];
873: }
874: }
875: }
876: }
877: return;
878: }
879: |;
880: }
1.1116 raeburn 881: if ($credits_element) {
882: $setsections .= qq|
883: function setCredits(defaultcredits) {
884: document.$formname.$credits_element.value = defaultcredits;
885: return;
886: }
887: |;
888: }
1.468 raeburn 889: return $setsections;
890: }
891:
1.91 www 892: sub selectcourse_link {
1.909 raeburn 893: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
894: $typeelement) = @_;
895: my $type = $selecttype;
1.871 raeburn 896: my $linktext = &mt('Select Course');
897: if ($selecttype eq 'Community') {
1.909 raeburn 898: $linktext = &mt('Select Community');
1.1239 raeburn 899: } elsif ($selecttype eq 'Placement') {
900: $linktext = &mt('Select Placement Test');
1.906 raeburn 901: } elsif ($selecttype eq 'Course/Community') {
902: $linktext = &mt('Select Course/Community');
1.909 raeburn 903: $type = '';
1.1019 raeburn 904: } elsif ($selecttype eq 'Select') {
905: $linktext = &mt('Select');
906: $type = '';
1.871 raeburn 907: }
1.787 bisitz 908: return '<span class="LC_nobreak">'
909: ."<a href='"
910: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
911: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 912: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 913: ."'>".$linktext.'</a>'
1.787 bisitz 914: .'</span>';
1.74 www 915: }
1.42 matthew 916:
1.653 raeburn 917: sub selectauthor_link {
918: my ($form,$udom)=@_;
919: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
920: &mt('Select Author').'</a>';
921: }
922:
1.876 raeburn 923: sub selectuser_link {
1.881 raeburn 924: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 925: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 926: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 927: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 928: ');">'.$linktext.'</a>';
1.876 raeburn 929: }
930:
1.273 raeburn 931: sub check_uncheck_jscript {
932: my $jscript = <<"ENDSCRT";
933: function checkAll(field) {
934: if (field.length > 0) {
935: for (i = 0; i < field.length; i++) {
1.1093 raeburn 936: if (!field[i].disabled) {
937: field[i].checked = true;
938: }
1.273 raeburn 939: }
940: } else {
1.1093 raeburn 941: if (!field.disabled) {
942: field.checked = true;
943: }
1.273 raeburn 944: }
945: }
946:
947: function uncheckAll(field) {
948: if (field.length > 0) {
949: for (i = 0; i < field.length; i++) {
950: field[i].checked = false ;
1.543 albertel 951: }
952: } else {
1.273 raeburn 953: field.checked = false ;
954: }
955: }
956: ENDSCRT
957: return $jscript;
958: }
959:
1.656 www 960: sub select_timezone {
1.1387 raeburn 961: my ($name,$selected,$onchange,$includeempty,$id,$disabled)=@_;
962: my $output='<select name="'.$name.'" '.$id.$onchange.$disabled.'>'."\n";
1.659 raeburn 963: if ($includeempty) {
964: $output .= '<option value=""';
965: if (($selected eq '') || ($selected eq 'local')) {
966: $output .= ' selected="selected" ';
967: }
968: $output .= '> </option>';
969: }
1.657 raeburn 970: my @timezones = DateTime::TimeZone->all_names;
971: foreach my $tzone (@timezones) {
972: $output.= '<option value="'.$tzone.'"';
973: if ($tzone eq $selected) {
974: $output.=' selected="selected"';
975: }
976: $output.=">$tzone</option>\n";
1.656 www 977: }
978: $output.="</select>";
979: return $output;
980: }
1.273 raeburn 981:
1.687 raeburn 982: sub select_datelocale {
1.1256 raeburn 983: my ($name,$selected,$onchange,$includeempty,$disabled)=@_;
984: my $output='<select name="'.$name.'" '.$onchange.$disabled.'>'."\n";
1.687 raeburn 985: if ($includeempty) {
986: $output .= '<option value=""';
987: if ($selected eq '') {
988: $output .= ' selected="selected" ';
989: }
990: $output .= '> </option>';
991: }
1.1241 raeburn 992: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 993: my (@possibles,%locale_names);
1.1241 raeburn 994: my @locales = DateTime::Locale->ids();
995: foreach my $id (@locales) {
996: if ($id ne '') {
997: my ($en_terr,$native_terr);
998: my $loc = DateTime::Locale->load($id);
999: if (ref($loc)) {
1000: $en_terr = $loc->name();
1001: $native_terr = $loc->native_name();
1.687 raeburn 1002: if (grep(/^en$/,@languages) || !@languages) {
1003: if ($en_terr ne '') {
1004: $locale_names{$id} = '('.$en_terr.')';
1005: } elsif ($native_terr ne '') {
1006: $locale_names{$id} = $native_terr;
1007: }
1008: } else {
1009: if ($native_terr ne '') {
1010: $locale_names{$id} = $native_terr.' ';
1011: } elsif ($en_terr ne '') {
1012: $locale_names{$id} = '('.$en_terr.')';
1013: }
1014: }
1.1220 raeburn 1015: $locale_names{$id} = Encode::encode('UTF-8',$locale_names{$id});
1.1241 raeburn 1016: push(@possibles,$id);
1017: }
1.687 raeburn 1018: }
1019: }
1020: foreach my $item (sort(@possibles)) {
1021: $output.= '<option value="'.$item.'"';
1022: if ($item eq $selected) {
1023: $output.=' selected="selected"';
1024: }
1025: $output.=">$item";
1026: if ($locale_names{$item} ne '') {
1.1220 raeburn 1027: $output.=' '.$locale_names{$item};
1.687 raeburn 1028: }
1029: $output.="</option>\n";
1030: }
1031: $output.="</select>";
1032: return $output;
1033: }
1034:
1.792 raeburn 1035: sub select_language {
1.1256 raeburn 1036: my ($name,$selected,$includeempty,$noedit) = @_;
1.792 raeburn 1037: my %langchoices;
1038: if ($includeempty) {
1.1117 raeburn 1039: %langchoices = ('' => 'No language preference');
1.792 raeburn 1040: }
1041: foreach my $id (&languageids()) {
1042: my $code = &supportedlanguagecode($id);
1043: if ($code) {
1044: $langchoices{$code} = &plainlanguagedescription($id);
1045: }
1046: }
1.1117 raeburn 1047: %langchoices = &Apache::lonlocal::texthash(%langchoices);
1.1256 raeburn 1048: return &select_form($selected,$name,\%langchoices,undef,$noedit);
1.792 raeburn 1049: }
1050:
1.42 matthew 1051: =pod
1.36 matthew 1052:
1.1088 foxr 1053:
1054: =item * &list_languages()
1055:
1056: Returns an array reference that is suitable for use in language prompters.
1057: Each array element is itself a two element array. The first element
1058: is the language code. The second element a descsriptiuon of the
1059: language itself. This is suitable for use in e.g.
1060: &Apache::edit::select_arg (once dereferenced that is).
1061:
1062: =cut
1063:
1064: sub list_languages {
1065: my @lang_choices;
1066:
1067: foreach my $id (&languageids()) {
1068: my $code = &supportedlanguagecode($id);
1069: if ($code) {
1070: my $selector = $supported_codes{$id};
1071: my $description = &plainlanguagedescription($id);
1.1263 raeburn 1072: push(@lang_choices, [$selector, $description]);
1.1088 foxr 1073: }
1074: }
1075: return \@lang_choices;
1076: }
1077:
1078: =pod
1079:
1.648 raeburn 1080: =item * &linked_select_forms(...)
1.36 matthew 1081:
1082: linked_select_forms returns a string containing a <script></script> block
1083: and html for two <select> menus. The select menus will be linked in that
1084: changing the value of the first menu will result in new values being placed
1085: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 1086: order unless a defined order is provided.
1.36 matthew 1087:
1088: linked_select_forms takes the following ordered inputs:
1089:
1090: =over 4
1091:
1.112 bowersj2 1092: =item * $formname, the name of the <form> tag
1.36 matthew 1093:
1.112 bowersj2 1094: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 1095:
1.112 bowersj2 1096: =item * $firstdefault, the default value for the first menu
1.36 matthew 1097:
1.112 bowersj2 1098: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 1099:
1.112 bowersj2 1100: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 1101:
1.112 bowersj2 1102: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 1103:
1.609 raeburn 1104: =item * $menuorder, the order of values in the first menu
1105:
1.1115 raeburn 1106: =item * $onchangefirst, additional javascript call to execute for an onchange
1107: event for the first <select> tag
1108:
1109: =item * $onchangesecond, additional javascript call to execute for an onchange
1110: event for the second <select> tag
1111:
1.1245 raeburn 1112: =item * $suffix, to differentiate separate uses of select2data javascript
1113: objects in a page.
1114:
1.41 ng 1115: =back
1116:
1.36 matthew 1117: Below is an example of such a hash. Only the 'text', 'default', and
1118: 'select2' keys must appear as stated. keys(%menu) are the possible
1119: values for the first select menu. The text that coincides with the
1.41 ng 1120: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 1121: and text for the second menu are given in the hash pointed to by
1122: $menu{$choice1}->{'select2'}.
1123:
1.112 bowersj2 1124: my %menu = ( A1 => { text =>"Choice A1" ,
1125: default => "B3",
1126: select2 => {
1127: B1 => "Choice B1",
1128: B2 => "Choice B2",
1129: B3 => "Choice B3",
1130: B4 => "Choice B4"
1.609 raeburn 1131: },
1132: order => ['B4','B3','B1','B2'],
1.112 bowersj2 1133: },
1134: A2 => { text =>"Choice A2" ,
1135: default => "C2",
1136: select2 => {
1137: C1 => "Choice C1",
1138: C2 => "Choice C2",
1139: C3 => "Choice C3"
1.609 raeburn 1140: },
1141: order => ['C2','C1','C3'],
1.112 bowersj2 1142: },
1143: A3 => { text =>"Choice A3" ,
1144: default => "D6",
1145: select2 => {
1146: D1 => "Choice D1",
1147: D2 => "Choice D2",
1148: D3 => "Choice D3",
1149: D4 => "Choice D4",
1150: D5 => "Choice D5",
1151: D6 => "Choice D6",
1152: D7 => "Choice D7"
1.609 raeburn 1153: },
1154: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 1155: }
1156: );
1.36 matthew 1157:
1158: =cut
1159:
1160: sub linked_select_forms {
1161: my ($formname,
1162: $middletext,
1163: $firstdefault,
1164: $firstselectname,
1165: $secondselectname,
1.609 raeburn 1166: $hashref,
1167: $menuorder,
1.1115 raeburn 1168: $onchangefirst,
1.1245 raeburn 1169: $onchangesecond,
1170: $suffix
1.36 matthew 1171: ) = @_;
1172: my $second = "document.$formname.$secondselectname";
1173: my $first = "document.$formname.$firstselectname";
1174: # output the javascript to do the changing
1175: my $result = '';
1.776 bisitz 1176: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 1177: $result.="// <![CDATA[\n";
1.1245 raeburn 1178: $result.="var select2data${suffix} = new Object();\n";
1.36 matthew 1179: $" = '","';
1180: my $debug = '';
1181: foreach my $s1 (sort(keys(%$hashref))) {
1.1245 raeburn 1182: $result.="select2data${suffix}['d_$s1'] = new Object();\n";
1183: $result.="select2data${suffix}['d_$s1'].def = new String('".
1.36 matthew 1184: $hashref->{$s1}->{'default'}."');\n";
1.1245 raeburn 1185: $result.="select2data${suffix}['d_$s1'].values = new Array(";
1.36 matthew 1186: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1187: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1188: @s2values = @{$hashref->{$s1}->{'order'}};
1189: }
1.36 matthew 1190: $result.="\"@s2values\");\n";
1.1245 raeburn 1191: $result.="select2data${suffix}['d_$s1'].texts = new Array(";
1.36 matthew 1192: my @s2texts;
1193: foreach my $value (@s2values) {
1.1263 raeburn 1194: push(@s2texts, $hashref->{$s1}->{'select2'}->{$value});
1.36 matthew 1195: }
1196: $result.="\"@s2texts\");\n";
1197: }
1198: $"=' ';
1199: $result.= <<"END";
1200:
1.1245 raeburn 1201: function select1${suffix}_changed() {
1.36 matthew 1202: // Determine new choice
1.1245 raeburn 1203: var newvalue = "d_" + $first.options[$first.selectedIndex].value;
1.36 matthew 1204: // update select2
1.1245 raeburn 1205: var values = select2data${suffix}[newvalue].values;
1206: var texts = select2data${suffix}[newvalue].texts;
1207: var select2def = select2data${suffix}[newvalue].def;
1.36 matthew 1208: var i;
1209: // out with the old
1.1245 raeburn 1210: $second.options.length = 0;
1211: // in with the new
1.36 matthew 1212: for (i=0;i<values.length; i++) {
1213: $second.options[i] = new Option(values[i]);
1.143 matthew 1214: $second.options[i].value = values[i];
1.36 matthew 1215: $second.options[i].text = texts[i];
1216: if (values[i] == select2def) {
1217: $second.options[i].selected = true;
1218: }
1219: }
1220: }
1.824 bisitz 1221: // ]]>
1.36 matthew 1222: </script>
1223: END
1224: # output the initial values for the selection lists
1.1245 raeburn 1225: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1${suffix}_changed();$onchangefirst\">\n";
1.609 raeburn 1226: my @order = sort(keys(%{$hashref}));
1227: if (ref($menuorder) eq 'ARRAY') {
1228: @order = @{$menuorder};
1229: }
1230: foreach my $value (@order) {
1.36 matthew 1231: $result.=" <option value=\"$value\" ";
1.253 albertel 1232: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1233: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1234: }
1235: $result .= "</select>\n";
1.1400 raeburn 1236: my %select2;
1237: if (ref($hashref->{$firstdefault}) eq 'HASH') {
1238: if (ref($hashref->{$firstdefault}->{'select2'}) eq 'HASH') {
1239: %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1240: }
1241: }
1.36 matthew 1242: $result .= $middletext;
1.1115 raeburn 1243: $result .= "<select size=\"1\" name=\"$secondselectname\"";
1244: if ($onchangesecond) {
1245: $result .= ' onchange="'.$onchangesecond.'"';
1246: }
1247: $result .= ">\n";
1.36 matthew 1248: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1249:
1250: my @secondorder = sort(keys(%select2));
1251: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1252: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1253: }
1254: foreach my $value (@secondorder) {
1.36 matthew 1255: $result.=" <option value=\"$value\" ";
1.253 albertel 1256: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1257: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1258: }
1259: $result .= "</select>\n";
1260: # return $debug;
1261: return $result;
1262: } # end of sub linked_select_forms {
1263:
1.45 matthew 1264: =pod
1.44 bowersj2 1265:
1.1381 raeburn 1266: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid,$links_target)
1.44 bowersj2 1267:
1.112 bowersj2 1268: Returns a string corresponding to an HTML link to the given help
1269: $topic, where $topic corresponds to the name of a .tex file in
1270: /home/httpd/html/adm/help/tex, with underscores replaced by
1271: spaces.
1272:
1273: $text will optionally be linked to the same topic, allowing you to
1274: link text in addition to the graphic. If you do not want to link
1275: text, but wish to specify one of the later parameters, pass an
1276: empty string.
1277:
1278: $stayOnPage is a value that will be interpreted as a boolean. If true,
1279: the link will not open a new window. If false, the link will open
1280: a new window using Javascript. (Default is false.)
1281:
1282: $width and $height are optional numerical parameters that will
1283: override the width and height of the popped up window, which may
1.973 raeburn 1284: be useful for certain help topics with big pictures included.
1285:
1286: $imgid is the id of the img tag used for the help icon. This may be
1287: used in a javascript call to switch the image src. See
1288: lonhtmlcommon::htmlareaselectactive() for an example.
1.44 bowersj2 1289:
1.1381 raeburn 1290: $links_target will optionally be set to a target (_top, _parent or _self).
1291:
1.44 bowersj2 1292: =cut
1293:
1294: sub help_open_topic {
1.1381 raeburn 1295: my ($topic, $text, $stayOnPage, $width, $height, $imgid, $links_target) = @_;
1.48 bowersj2 1296: $text = "" if (not defined $text);
1.44 bowersj2 1297: $stayOnPage = 0 if (not defined $stayOnPage);
1.1033 www 1298: $width = 500 if (not defined $width);
1.44 bowersj2 1299: $height = 400 if (not defined $height);
1300: my $filename = $topic;
1301: $filename =~ s/ /_/g;
1302:
1.48 bowersj2 1303: my $template = "";
1304: my $link;
1.572 banghart 1305:
1.159 www 1306: $topic=~s/\W/\_/g;
1.44 bowersj2 1307:
1.572 banghart 1308: if (!$stayOnPage) {
1.1033 www 1309: $link = "javascript:openMyModal('/adm/help/${filename}.hlp',$width,$height,'yes');";
1.1037 www 1310: } elsif ($stayOnPage eq 'popup') {
1311: $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 1312: } else {
1.48 bowersj2 1313: $link = "/adm/help/${filename}.hlp";
1314: }
1315:
1316: # Add the text
1.1314 raeburn 1317: my $target = ' target="_top"';
1.1381 raeburn 1318: if ($links_target) {
1319: $target = ' target="'.$links_target.'"';
1320: } elsif ((($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) ||
1321: (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'} eq '_self'))) {
1322: $target = '';
1.1378 raeburn 1323: }
1.1380 raeburn 1324: if ($text ne "") {
1.763 bisitz 1325: $template.='<span class="LC_help_open_topic">'
1.1314 raeburn 1326: .'<a'.$target.' href="'.$link.'">'
1.763 bisitz 1327: .$text.'</a>';
1.48 bowersj2 1328: }
1329:
1.763 bisitz 1330: # (Always) Add the graphic
1.179 matthew 1331: my $title = &mt('Online Help');
1.667 raeburn 1332: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973 raeburn 1333: if ($imgid ne '') {
1334: $imgid = ' id="'.$imgid.'"';
1335: }
1.1314 raeburn 1336: $template.=' <a'.$target.' href="'.$link.'" title="'.$title.'">'
1.763 bisitz 1337: .'<img src="'.$helpicon.'" border="0"'
1338: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973 raeburn 1339: .' title="'.$title.'" style="vertical-align:middle;"'.$imgid
1.763 bisitz 1340: .' /></a>';
1341: if ($text ne "") {
1342: $template.='</span>';
1343: }
1.44 bowersj2 1344: return $template;
1345:
1.106 bowersj2 1346: }
1347:
1348: # This is a quicky function for Latex cheatsheet editing, since it
1349: # appears in at least four places
1350: sub helpLatexCheatsheet {
1.1037 www 1351: my ($topic,$text,$not_author,$stayOnPage) = @_;
1.732 raeburn 1352: my $out;
1.106 bowersj2 1353: my $addOther = '';
1.732 raeburn 1354: if ($topic) {
1.1037 www 1355: $addOther = '<span>'.&help_open_topic($topic,&mt($text),$stayOnPage, undef, 600).'</span> ';
1.763 bisitz 1356: }
1357: $out = '<span>' # Start cheatsheet
1358: .$addOther
1359: .'<span>'
1.1037 www 1360: .&help_open_topic('Greek_Symbols',&mt('Greek Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1361: .'</span> <span>'
1.1037 www 1362: .&help_open_topic('Other_Symbols',&mt('Other Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1363: .'</span>';
1.732 raeburn 1364: unless ($not_author) {
1.1186 kruse 1365: $out .= '<span>'
1366: .&help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),$stayOnPage,undef,600)
1367: .'</span> <span>'
1368: .&help_open_topic('Authoring_Multilingual_Problems',&mt('How to create problems in different languages'),$stayOnPage,undef,600)
1.763 bisitz 1369: .'</span>';
1.732 raeburn 1370: }
1.763 bisitz 1371: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1372: return $out;
1.172 www 1373: }
1374:
1.430 albertel 1375: sub general_help {
1376: my $helptopic='Student_Intro';
1377: if ($env{'request.role'}=~/^(ca|au)/) {
1378: $helptopic='Authoring_Intro';
1.907 raeburn 1379: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1380: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1381: } elsif ($env{'request.role'}=~/^dc/) {
1382: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1383: }
1384: return $helptopic;
1385: }
1386:
1387: sub update_help_link {
1388: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1389: my $origurl = $ENV{'REQUEST_URI'};
1390: $origurl=~s|^/~|/priv/|;
1391: my $timestamp = time;
1392: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1393: $$datum = &escape($$datum);
1394: }
1395:
1396: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1397: my $output .= <<"ENDOUTPUT";
1398: <script type="text/javascript">
1.824 bisitz 1399: // <![CDATA[
1.430 albertel 1400: banner_link = '$banner_link';
1.824 bisitz 1401: // ]]>
1.430 albertel 1402: </script>
1403: ENDOUTPUT
1404: return $output;
1405: }
1406:
1407: # now just updates the help link and generates a blue icon
1.193 raeburn 1408: sub help_open_menu {
1.1381 raeburn 1409: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text,$links_target)
1.552 banghart 1410: = @_;
1.949 droeschl 1411: $stayOnPage = 1;
1.430 albertel 1412: my $output;
1413: if ($component_help) {
1414: if (!$text) {
1415: $output=&help_open_topic($component_help,undef,$stayOnPage,
1.1381 raeburn 1416: $width,$height,'',$links_target);
1.430 albertel 1417: } else {
1418: my $help_text;
1419: $help_text=&unescape($topic);
1420: $output='<table><tr><td>'.
1421: &help_open_topic($component_help,$help_text,$stayOnPage,
1.1381 raeburn 1422: $width,$height,'',$links_target).'</td></tr></table>';
1.430 albertel 1423: }
1424: }
1425: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1426: return $output.$banner_link;
1427: }
1428:
1429: sub top_nav_help {
1.1369 raeburn 1430: my ($text,$linkattr) = @_;
1.436 albertel 1431: $text = &mt($text);
1.949 droeschl 1432: my $stay_on_page = 1;
1433:
1.1168 raeburn 1434: my ($link,$banner_link);
1435: unless ($env{'request.noversionuri'} =~ m{^/adm/helpmenu}) {
1436: $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1437: : "javascript:helpMenu('open')";
1438: $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1439: }
1.201 raeburn 1440: my $title = &mt('Get help');
1.1168 raeburn 1441: if ($link) {
1442: return <<"END";
1.436 albertel 1443: $banner_link
1.1369 raeburn 1444: <a href="$link" title="$title" $linkattr>$text</a>
1.436 albertel 1445: END
1.1168 raeburn 1446: } else {
1447: return ' '.$text.' ';
1448: }
1.436 albertel 1449: }
1450:
1451: sub help_menu_js {
1.1154 raeburn 1452: my ($httphost) = @_;
1.949 droeschl 1453: my $stayOnPage = 1;
1.436 albertel 1454: my $width = 620;
1455: my $height = 600;
1.430 albertel 1456: my $helptopic=&general_help();
1.1154 raeburn 1457: my $details_link = $httphost.'/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1458: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1459: my $start_page =
1460: &Apache::loncommon::start_page('Help Menu', undef,
1461: {'frameset' => 1,
1462: 'js_ready' => 1,
1.1154 raeburn 1463: 'use_absolute' => $httphost,
1.331 albertel 1464: 'add_entries' => {
1.1168 raeburn 1465: 'border' => '0',
1.579 raeburn 1466: 'rows' => "110,*",},});
1.331 albertel 1467: my $end_page =
1468: &Apache::loncommon::end_page({'frameset' => 1,
1469: 'js_ready' => 1,});
1470:
1.436 albertel 1471: my $template .= <<"ENDTEMPLATE";
1472: <script type="text/javascript">
1.877 bisitz 1473: // <![CDATA[
1.253 albertel 1474: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1475: var banner_link = '';
1.243 raeburn 1476: function helpMenu(target) {
1477: var caller = this;
1478: if (target == 'open') {
1479: var newWindow = null;
1480: try {
1.262 albertel 1481: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1482: }
1483: catch(error) {
1484: writeHelp(caller);
1485: return;
1486: }
1487: if (newWindow) {
1488: caller = newWindow;
1489: }
1.193 raeburn 1490: }
1.243 raeburn 1491: writeHelp(caller);
1492: return;
1493: }
1494: function writeHelp(caller) {
1.1168 raeburn 1495: caller.document.writeln('$start_page\\n<frame name="bannerframe" src="'+banner_link+'" marginwidth="0" marginheight="0" frameborder="0">\\n');
1496: caller.document.writeln('<frame name="bodyframe" src="$details_link" marginwidth="0" marginheight="0" frameborder="0">\\n$end_page');
1497: caller.document.close();
1498: caller.focus();
1.193 raeburn 1499: }
1.877 bisitz 1500: // END LON-CAPA Internal -->
1.253 albertel 1501: // ]]>
1.436 albertel 1502: </script>
1.193 raeburn 1503: ENDTEMPLATE
1504: return $template;
1505: }
1506:
1.172 www 1507: sub help_open_bug {
1508: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1509: unless ($env{'user.adv'}) { return ''; }
1.172 www 1510: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1511: $text = "" if (not defined $text);
1512: $stayOnPage=1;
1.184 albertel 1513: $width = 600 if (not defined $width);
1514: $height = 600 if (not defined $height);
1.172 www 1515:
1516: $topic=~s/\W+/\+/g;
1517: my $link='';
1518: my $template='';
1.379 albertel 1519: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1520: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1521: if (!$stayOnPage)
1522: {
1523: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1524: }
1525: else
1526: {
1527: $link = $url;
1528: }
1.1314 raeburn 1529:
1.1382 raeburn 1530: my $target = '_top';
1531: if ((($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) ||
1532: (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'} eq '_self'))) {
1533: $target = '_blank';
1.1378 raeburn 1534: }
1.1382 raeburn 1535:
1.172 www 1536: # Add the text
1537: if ($text ne "")
1538: {
1539: $template .=
1540: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.1382 raeburn 1541: "<td bgcolor='#FF5555'><a target=\"$target\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1542: }
1543:
1544: # Add the graphic
1.179 matthew 1545: my $title = &mt('Report a Bug');
1.215 albertel 1546: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1547: $template .= <<"ENDTEMPLATE";
1.1382 raeburn 1548: <a target="$target" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1549: ENDTEMPLATE
1550: if ($text ne '') { $template.='</td></tr></table>' };
1551: return $template;
1552:
1553: }
1554:
1555: sub help_open_faq {
1556: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1557: unless ($env{'user.adv'}) { return ''; }
1.172 www 1558: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1559: $text = "" if (not defined $text);
1560: $stayOnPage=1;
1561: $width = 350 if (not defined $width);
1562: $height = 400 if (not defined $height);
1563:
1564: $topic=~s/\W+/\+/g;
1565: my $link='';
1566: my $template='';
1567: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1568: if (!$stayOnPage)
1569: {
1570: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1571: }
1572: else
1573: {
1574: $link = $url;
1575: }
1576:
1577: # Add the text
1578: if ($text ne "")
1579: {
1580: $template .=
1.173 www 1581: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1582: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1583: }
1584:
1585: # Add the graphic
1.179 matthew 1586: my $title = &mt('View the FAQ');
1.215 albertel 1587: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1588: $template .= <<"ENDTEMPLATE";
1.436 albertel 1589: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1590: ENDTEMPLATE
1591: if ($text ne '') { $template.='</td></tr></table>' };
1592: return $template;
1593:
1.44 bowersj2 1594: }
1.37 matthew 1595:
1.180 matthew 1596: ###############################################################
1597: ###############################################################
1598:
1.45 matthew 1599: =pod
1600:
1.648 raeburn 1601: =item * &change_content_javascript():
1.256 matthew 1602:
1603: This and the next function allow you to create small sections of an
1604: otherwise static HTML page that you can update on the fly with
1605: Javascript, even in Netscape 4.
1606:
1607: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1608: must be written to the HTML page once. It will prove the Javascript
1609: function "change(name, content)". Calling the change function with the
1610: name of the section
1611: you want to update, matching the name passed to C<changable_area>, and
1612: the new content you want to put in there, will put the content into
1613: that area.
1614:
1615: B<Note>: Netscape 4 only reserves enough space for the changable area
1616: to contain room for the original contents. You need to "make space"
1617: for whatever changes you wish to make, and be B<sure> to check your
1618: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1619: it's adequate for updating a one-line status display, but little more.
1620: This script will set the space to 100% width, so you only need to
1621: worry about height in Netscape 4.
1622:
1623: Modern browsers are much less limiting, and if you can commit to the
1624: user not using Netscape 4, this feature may be used freely with
1625: pretty much any HTML.
1626:
1627: =cut
1628:
1629: sub change_content_javascript {
1630: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1631: if ($env{'browser.type'} eq 'netscape' &&
1632: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1633: return (<<NETSCAPE4);
1634: function change(name, content) {
1635: doc = document.layers[name+"___escape"].layers[0].document;
1636: doc.open();
1637: doc.write(content);
1638: doc.close();
1639: }
1640: NETSCAPE4
1641: } else {
1642: # Otherwise, we need to use semi-standards-compliant code
1643: # (technically, "innerHTML" isn't standard but the equivalent
1644: # is really scary, and every useful browser supports it
1645: return (<<DOMBASED);
1646: function change(name, content) {
1647: element = document.getElementById(name);
1648: element.innerHTML = content;
1649: }
1650: DOMBASED
1651: }
1652: }
1653:
1654: =pod
1655:
1.648 raeburn 1656: =item * &changable_area($name,$origContent):
1.256 matthew 1657:
1658: This provides a "changable area" that can be modified on the fly via
1659: the Javascript code provided in C<change_content_javascript>. $name is
1660: the name you will use to reference the area later; do not repeat the
1661: same name on a given HTML page more then once. $origContent is what
1662: the area will originally contain, which can be left blank.
1663:
1664: =cut
1665:
1666: sub changable_area {
1667: my ($name, $origContent) = @_;
1668:
1.258 albertel 1669: if ($env{'browser.type'} eq 'netscape' &&
1670: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1671: # If this is netscape 4, we need to use the Layer tag
1672: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1673: } else {
1674: return "<span id='$name'>$origContent</span>";
1675: }
1676: }
1677:
1678: =pod
1679:
1.648 raeburn 1680: =item * &viewport_geometry_js
1.590 raeburn 1681:
1682: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1683:
1684: =cut
1685:
1686:
1687: sub viewport_geometry_js {
1688: return <<"GEOMETRY";
1689: var Geometry = {};
1690: function init_geometry() {
1691: if (Geometry.init) { return };
1692: Geometry.init=1;
1693: if (window.innerHeight) {
1694: Geometry.getViewportHeight = function() { return window.innerHeight; };
1695: Geometry.getViewportWidth = function() { return window.innerWidth; };
1696: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1697: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1698: }
1699: else if (document.documentElement && document.documentElement.clientHeight) {
1700: Geometry.getViewportHeight =
1701: function() { return document.documentElement.clientHeight; };
1702: Geometry.getViewportWidth =
1703: function() { return document.documentElement.clientWidth; };
1704:
1705: Geometry.getHorizontalScroll =
1706: function() { return document.documentElement.scrollLeft; };
1707: Geometry.getVerticalScroll =
1708: function() { return document.documentElement.scrollTop; };
1709: }
1710: else if (document.body.clientHeight) {
1711: Geometry.getViewportHeight =
1712: function() { return document.body.clientHeight; };
1713: Geometry.getViewportWidth =
1714: function() { return document.body.clientWidth; };
1715: Geometry.getHorizontalScroll =
1716: function() { return document.body.scrollLeft; };
1717: Geometry.getVerticalScroll =
1718: function() { return document.body.scrollTop; };
1719: }
1720: }
1721:
1722: GEOMETRY
1723: }
1724:
1725: =pod
1726:
1.648 raeburn 1727: =item * &viewport_size_js()
1.590 raeburn 1728:
1729: 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.
1730:
1731: =cut
1732:
1733: sub viewport_size_js {
1734: my $geometry = &viewport_geometry_js();
1735: return <<"DIMS";
1736:
1737: $geometry
1738:
1739: function getViewportDims(width,height) {
1740: init_geometry();
1741: width.value = Geometry.getViewportWidth();
1742: height.value = Geometry.getViewportHeight();
1743: return;
1744: }
1745:
1746: DIMS
1747: }
1748:
1749: =pod
1750:
1.648 raeburn 1751: =item * &resize_textarea_js()
1.565 albertel 1752:
1753: emits the needed javascript to resize a textarea to be as big as possible
1754:
1755: creates a function resize_textrea that takes two IDs first should be
1756: the id of the element to resize, second should be the id of a div that
1757: surrounds everything that comes after the textarea, this routine needs
1758: to be attached to the <body> for the onload and onresize events.
1759:
1.648 raeburn 1760: =back
1.565 albertel 1761:
1762: =cut
1763:
1764: sub resize_textarea_js {
1.590 raeburn 1765: my $geometry = &viewport_geometry_js();
1.565 albertel 1766: return <<"RESIZE";
1767: <script type="text/javascript">
1.824 bisitz 1768: // <![CDATA[
1.590 raeburn 1769: $geometry
1.565 albertel 1770:
1.588 albertel 1771: function getX(element) {
1772: var x = 0;
1773: while (element) {
1774: x += element.offsetLeft;
1775: element = element.offsetParent;
1776: }
1777: return x;
1778: }
1779: function getY(element) {
1780: var y = 0;
1781: while (element) {
1782: y += element.offsetTop;
1783: element = element.offsetParent;
1784: }
1785: return y;
1786: }
1787:
1788:
1.565 albertel 1789: function resize_textarea(textarea_id,bottom_id) {
1790: init_geometry();
1791: var textarea = document.getElementById(textarea_id);
1792: //alert(textarea);
1793:
1.588 albertel 1794: var textarea_top = getY(textarea);
1.565 albertel 1795: var textarea_height = textarea.offsetHeight;
1796: var bottom = document.getElementById(bottom_id);
1.588 albertel 1797: var bottom_top = getY(bottom);
1.565 albertel 1798: var bottom_height = bottom.offsetHeight;
1799: var window_height = Geometry.getViewportHeight();
1.588 albertel 1800: var fudge = 23;
1.565 albertel 1801: var new_height = window_height-fudge-textarea_top-bottom_height;
1802: if (new_height < 300) {
1803: new_height = 300;
1804: }
1805: textarea.style.height=new_height+'px';
1806: }
1.824 bisitz 1807: // ]]>
1.565 albertel 1808: </script>
1809: RESIZE
1810:
1811: }
1812:
1.1205 golterma 1813: sub colorfuleditor_js {
1.1248 raeburn 1814: my $browse_or_search;
1815: my $respath;
1816: my ($cnum,$cdom) = &crsauthor_url();
1817: if ($cnum) {
1818: $respath = "/res/$cdom/$cnum/";
1819: my %js_lt = &Apache::lonlocal::texthash(
1820: sunm => 'Sub-directory name',
1821: save => 'Save page to make this permanent',
1822: );
1823: &js_escape(\%js_lt);
1.1400 raeburn 1824: my $showfile_js = &show_crsfiles_js();
1.1248 raeburn 1825: $browse_or_search = <<"END";
1826:
1.1400 raeburn 1827: $showfile_js
1828:
1.1248 raeburn 1829: function toggleChooser(form,element,titleid,only,search) {
1830: var disp = 'none';
1831: if (document.getElementById('chooser_'+element)) {
1832: var curr = document.getElementById('chooser_'+element).style.display;
1833: if (curr == 'none') {
1834: disp='inline';
1835: if (form.elements['chooser_'+element].length) {
1836: for (var i=0; i<form.elements['chooser_'+element].length; i++) {
1837: form.elements['chooser_'+element][i].checked = false;
1838: }
1839: }
1840: toggleResImport(form,element);
1841: }
1842: document.getElementById('chooser_'+element).style.display = disp;
1.1400 raeburn 1843: var dirsel = '';
1844: var filesel = '';
1845: if (document.getElementById('chooser_'+element+'_crsres')) {
1846: var currcrsres = document.getElementById('chooser_'+element+'_crsres').style.display;
1847: if (currcrsres == 'none') {
1848: dirsel = 'coursepath_'+element;
1849: var filesel = 'coursefile_'+element;
1850: var include;
1851: if (document.getElementById('crsres_include_'+element)) {
1852: include = document.getElementById('crsres_include_'+element).value;
1853: }
1.1402 raeburn 1854: populateCrsSelects(form,dirsel,filesel,1,include,1,0,1,1,0);
1.1400 raeburn 1855: }
1856: }
1857: if (document.getElementById('chooser_'+element+'_upload')) {
1858: var currcrsupload = document.getElementById('chooser_'+element+'_upload').style.display;
1859: if (currcrsupload == 'none') {
1860: dirsel = 'crsauthorpath_'+element;
1861: filesel = '';
1.1402 raeburn 1862: populateCrsSelects(form,dirsel,filesel,0,'',1,0,1,0,1);
1.1400 raeburn 1863: }
1864: }
1.1248 raeburn 1865: }
1866: }
1867:
1.1400 raeburn 1868: function toggleCrsFile(form,element) {
1.1248 raeburn 1869: if (document.getElementById('chooser_'+element+'_crsres')) {
1870: var curr = document.getElementById('chooser_'+element+'_crsres').style.display;
1871: if (curr == 'none') {
1.1400 raeburn 1872: if (document.getElementById('coursepath_'+element)) {
1873: var numdirs;
1874: if (document.getElementById('coursepath_'+element).length) {
1875: numdirs = document.getElementById('coursepath_'+element).length;
1876: }
1.1402 raeburn 1877: if ((document.getElementById('hascrsres_'+element)) &&
1878: (document.getElementById('nocrsres_'+element))) {
1879: if (numdirs) {
1880: document.getElementById('hascrsres_'+element).style.display='inline-block';
1881: document.getElementById('nocrsres_'+element).style.display='none';
1882: } else {
1883: document.getElementById('hascrsres_'+element).style.display='none';
1884: document.getElementById('nocrsres_'+element).style.display='inline-block';
1885: }
1886: }
1.1248 raeburn 1887: form.elements['coursepath_'+element].selectedIndex = 0;
1888: if (numdirs > 1) {
1.1400 raeburn 1889: var selelem = form.elements['coursefile_'+element];
1890: var i, len = selelem.options.length -1;
1891: if (len >=0) {
1892: for (i = len; i >= 0; i--) {
1893: selelem.remove(i);
1894: }
1895: selelem.options[0] = new Option('','');
1896: }
1.1248 raeburn 1897: }
1898: }
1.1400 raeburn 1899: }
1.1248 raeburn 1900: document.getElementById('chooser_'+element+'_crsres').style.display = 'block';
1901: }
1902: if (document.getElementById('chooser_'+element+'_upload')) {
1903: document.getElementById('chooser_'+element+'_upload').style.display = 'none';
1904: if (document.getElementById('uploadcrsres_'+element)) {
1905: document.getElementById('uploadcrsres_'+element).value = '';
1906: }
1907: }
1908: return;
1909: }
1910:
1.1400 raeburn 1911: function toggleCrsUpload(form,element) {
1.1248 raeburn 1912: if (document.getElementById('chooser_'+element+'_crsres')) {
1913: document.getElementById('chooser_'+element+'_crsres').style.display = 'none';
1914: }
1915: if (document.getElementById('chooser_'+element+'_upload')) {
1916: var curr = document.getElementById('chooser_'+element+'_upload').style.display;
1917: if (curr == 'none') {
1.1400 raeburn 1918: form.elements['newsubdir_'+element][0].checked = true;
1919: toggleNewsubdir(form,element);
1920: document.getElementById('chooser_'+element+'_upload').style.display = 'block';
1921: if (document.getElementById('uploadcrsres_'+element)) {
1922: document.getElementById('uploadcrsres_'+element).value = '';
1.1248 raeburn 1923: }
1924: }
1925: }
1926: return;
1927: }
1928:
1929: function toggleResImport(form,element) {
1930: var choices = new Array('crsres','upload');
1931: for (var i=0; i<choices.length; i++) {
1932: if (document.getElementById('chooser_'+element+'_'+choices[i])) {
1933: document.getElementById('chooser_'+element+'_'+choices[i]).style.display = 'none';
1934: }
1935: }
1936: }
1937:
1938: function toggleNewsubdir(form,element) {
1939: var newsub = form.elements['newsubdir_'+element];
1940: if (newsub) {
1941: if (newsub.length) {
1942: for (var j=0; j<newsub.length; j++) {
1943: if (newsub[j].checked) {
1944: if (document.getElementById('newsubdirname_'+element)) {
1945: if (newsub[j].value == '1') {
1946: document.getElementById('newsubdirname_'+element).type = "text";
1947: if (document.getElementById('newsubdir_'+element)) {
1948: document.getElementById('newsubdir_'+element).innerHTML = '<br />$js_lt{sunm}';
1949: }
1950: } else {
1951: document.getElementById('newsubdirname_'+element).type = "hidden";
1952: document.getElementById('newsubdirname_'+element).value = "";
1953: document.getElementById('newsubdir_'+element).innerHTML = "";
1954: }
1955: }
1956: break;
1957: }
1958: }
1959: }
1960: }
1961: }
1962:
1963: function updateCrsFile(form,element) {
1964: var directory = form.elements['coursepath_'+element];
1965: var filename = form.elements['coursefile_'+element];
1966: var path = directory.options[directory.selectedIndex].value;
1967: var file = filename.options[filename.selectedIndex].value;
1.1400 raeburn 1968: if (file != '') {
1969: form.elements[element].value = '$respath';
1970: if (path == '/') {
1971: form.elements[element].value += file;
1972: } else {
1973: form.elements[element].value += path+'/'+file;
1974: }
1975: unClean();
1976: if (document.getElementById('previewimg_'+element)) {
1977: document.getElementById('previewimg_'+element).src = form.elements[element].value;
1978: var newsrc = document.getElementById('previewimg_'+element).src;
1979: }
1980: if (document.getElementById('showimg_'+element)) {
1981: document.getElementById('showimg_'+element).innerHTML = '($js_lt{save})';
1982: }
1.1248 raeburn 1983: }
1984: toggleChooser(form,element);
1985: return;
1986: }
1987:
1988: function uploadDone(suffix,name) {
1989: if (name) {
1990: document.forms["lonhomework"].elements[suffix].value = name;
1991: unClean();
1992: toggleChooser(document.forms["lonhomework"],suffix);
1993: }
1994: }
1995:
1996: \$(document).ready(function(){
1997:
1998: \$(document).delegate('form :submit', 'click', function( event ) {
1999: if ( \$( this ).hasClass( "LC_uploadcrsres" ) ) {
2000: var buttonId = this.id;
2001: var suffix = buttonId.toString();
2002: suffix = suffix.replace(/^crsupload_/,'');
2003: event.preventDefault();
2004: document.lonhomework.target = 'crsupload_target_'+suffix;
2005: document.lonhomework.action = '/adm/coursepub?LC_uploadcrsres='+suffix;
2006: \$(this.form).submit();
2007: document.lonhomework.target = '';
2008: if (document.getElementById('crsuploadto_'+suffix)) {
2009: document.lonhomework.action = document.getElementById('crsuploadto_'+suffix).value;
2010: }
2011: return false;
2012: }
2013: });
2014: });
2015: END
2016: }
1.1205 golterma 2017: return <<"COLORFULEDIT"
2018: <script type="text/javascript">
2019: // <![CDATA[>
2020: function fold_box(curDepth, lastresource){
2021:
2022: // we need a list because there can be several blocks you need to fold in one tag
2023: var block = document.getElementsByName('foldblock_'+curDepth);
2024: // but there is only one folding button per tag
2025: var foldbutton = document.getElementById('folding_btn_'+curDepth);
2026:
2027: if(block.item(0).style.display == 'none'){
2028:
2029: foldbutton.value = '@{[&mt("Hide")]}';
2030: for (i = 0; i < block.length; i++){
2031: block.item(i).style.display = '';
2032: }
2033: }else{
2034:
2035: foldbutton.value = '@{[&mt("Show")]}';
2036: for (i = 0; i < block.length; i++){
2037: // block.item(i).style.visibility = 'collapse';
2038: block.item(i).style.display = 'none';
2039: }
2040: };
2041: saveState(lastresource);
2042: }
2043:
2044: function saveState (lastresource) {
2045:
2046: var tag_list = getTagList();
2047: if(tag_list != null){
2048: var timestamp = new Date().getTime();
2049: var key = lastresource;
2050:
2051: // the value pattern is: 'time;key1,value1;key2,value2; ... '
2052: // starting with timestamp
2053: var value = timestamp+';';
2054:
2055: // building the list of key-value pairs
2056: for(var i = 0; i < tag_list.length; i++){
2057: value += tag_list[i]+',';
2058: value += document.getElementsByName(tag_list[i])[0].style.display+';';
2059: }
2060:
2061: // only iterate whole storage if nothing to override
2062: if(localStorage.getItem(key) == null){
2063:
2064: // prevent storage from growing large
2065: if(localStorage.length > 50){
2066: var regex_getTimestamp = /^(?:\d)+;/;
2067: var oldest_timestamp = regex_getTimestamp.exec(localStorage.key(0));
2068: var oldest_key;
2069:
2070: for(var i = 1; i < localStorage.length; i++){
2071: if (regex_getTimestamp.exec(localStorage.key(i)) < oldest_timestamp) {
2072: oldest_key = localStorage.key(i);
2073: oldest_timestamp = regex_getTimestamp.exec(oldest_key);
2074: }
2075: }
2076: localStorage.removeItem(oldest_key);
2077: }
2078: }
2079: localStorage.setItem(key,value);
2080: }
2081: }
2082:
2083: // restore folding status of blocks (on page load)
2084: function restoreState (lastresource) {
2085: if(localStorage.getItem(lastresource) != null){
2086: var key = lastresource;
2087: var value = localStorage.getItem(key);
2088: var regex_delTimestamp = /^\d+;/;
2089:
2090: value.replace(regex_delTimestamp, '');
2091:
2092: var valueArr = value.split(';');
2093: var pairs;
2094: var elements;
2095: for (var i = 0; i < valueArr.length; i++){
2096: pairs = valueArr[i].split(',');
2097: elements = document.getElementsByName(pairs[0]);
2098:
2099: for (var j = 0; j < elements.length; j++){
2100: elements[j].style.display = pairs[1];
2101: if (pairs[1] == "none"){
2102: var regex_id = /([_\\d]+)\$/;
2103: regex_id.exec(pairs[0]);
2104: document.getElementById("folding_btn"+RegExp.\$1).value = "Show";
2105: }
2106: }
2107: }
2108: }
2109: }
2110:
2111: function getTagList () {
2112:
2113: var stringToSearch = document.lonhomework.innerHTML;
2114:
2115: var ret = new Array();
2116: var regex_findBlock = /(foldblock_.*?)"/g;
2117: var tag_list = stringToSearch.match(regex_findBlock);
2118:
2119: if(tag_list != null){
2120: for(var i = 0; i < tag_list.length; i++){
2121: ret.push(tag_list[i].replace(/"/, ''));
2122: }
2123: }
2124: return ret;
2125: }
2126:
2127: function saveScrollPosition (resource) {
2128: var tag_list = getTagList();
2129:
2130: // we dont always want to jump to the first block
2131: // 170 is roughly above the "Problem Editing" header. we just want to save if the user scrolled down further than this
2132: if(\$(window).scrollTop() > 170){
2133: if(tag_list != null){
2134: var result;
2135: for(var i = 0; i < tag_list.length; i++){
2136: if(isElementInViewport(tag_list[i])){
2137: result += tag_list[i]+';';
2138: }
2139: }
2140: sessionStorage.setItem('anchor_'+resource, result);
2141: }
2142: } else {
2143: // we dont need to save zero, just delete the item to leave everything tidy
2144: sessionStorage.removeItem('anchor_'+resource);
2145: }
2146: }
2147:
2148: function restoreScrollPosition(resource){
2149:
2150: var elem = sessionStorage.getItem('anchor_'+resource);
2151: if(elem != null){
2152: var tag_list = elem.split(';');
2153: var elem_list;
2154:
2155: for(var i = 0; i < tag_list.length; i++){
2156: elem_list = document.getElementsByName(tag_list[i]);
2157:
2158: if(elem_list.length > 0){
2159: elem = elem_list[0];
2160: break;
2161: }
2162: }
2163: elem.scrollIntoView();
2164: }
2165: }
2166:
2167: function isElementInViewport(el) {
2168:
2169: // change to last element instead of first
2170: var elem = document.getElementsByName(el);
2171: var rect = elem[0].getBoundingClientRect();
2172:
2173: return (
2174: rect.top >= 0 &&
2175: rect.left >= 0 &&
2176: rect.bottom <= (window.innerHeight || document.documentElement.clientHeight) && /*or $(window).height() */
2177: rect.right <= (window.innerWidth || document.documentElement.clientWidth) /*or $(window).width() */
2178: );
2179: }
2180:
2181: function autosize(depth){
2182: var cmInst = window['cm'+depth];
2183: var fitsizeButton = document.getElementById('fitsize'+depth);
2184:
2185: // is fixed size, switching to dynamic
2186: if (sessionStorage.getItem("autosized_"+depth) == null) {
2187: cmInst.setSize("","auto");
2188: fitsizeButton.value = "@{[&mt('Fixed size')]}";
2189: sessionStorage.setItem("autosized_"+depth, "yes");
2190:
2191: // is dynamic size, switching to fixed
2192: } else {
2193: cmInst.setSize("","300px");
2194: fitsizeButton.value = "@{[&mt('Dynamic size')]}";
2195: sessionStorage.removeItem("autosized_"+depth);
2196: }
2197: }
2198:
1.1248 raeburn 2199: $browse_or_search
1.1205 golterma 2200:
2201: // ]]>
2202: </script>
2203: COLORFULEDIT
2204: }
2205:
2206: sub xmleditor_js {
2207: return <<XMLEDIT
2208: <script type="text/javascript" src="/adm/jQuery/addons/jquery-scrolltofixed.js"></script>
2209: <script type="text/javascript">
2210: // <![CDATA[>
2211:
2212: function saveScrollPosition (resource) {
2213:
2214: var scrollPos = \$(window).scrollTop();
2215: sessionStorage.setItem(resource,scrollPos);
2216: }
2217:
2218: function restoreScrollPosition(resource){
2219:
2220: var scrollPos = sessionStorage.getItem(resource);
2221: \$(window).scrollTop(scrollPos);
2222: }
2223:
2224: // unless internet explorer
2225: if (!(window.navigator.appName == "Microsoft Internet Explorer" && (document.documentMode || document.compatMode))){
2226:
2227: \$(document).ready(function() {
2228: \$(".LC_edit_actionbar").scrollToFixed(\{zIndex: 100\});
2229: });
2230: }
2231:
2232: // inserts text at cursor position into codemirror (xml editor only)
2233: function insertText(text){
2234: cm.focus();
2235: var curPos = cm.getCursor();
2236: cm.replaceRange(text.replace(/ESCAPEDSCRIPT/g,'script'), {line: curPos.line,ch: curPos.ch});
2237: }
2238: // ]]>
2239: </script>
2240: XMLEDIT
2241: }
2242:
2243: sub insert_folding_button {
2244: my $curDepth = $Apache::lonxml::curdepth;
2245: my $lastresource = $env{'request.ambiguous'};
2246:
2247: return "<input type=\"button\" id=\"folding_btn_$curDepth\"
2248: value=\"".&mt('Hide')."\" onclick=\"fold_box('$curDepth','$lastresource')\">";
2249: }
2250:
1.1248 raeburn 2251: sub crsauthor_url {
2252: my ($url) = @_;
2253: if ($url eq '') {
2254: $url = $ENV{'REQUEST_URI'};
2255: }
2256: my ($cnum,$cdom);
2257: if ($env{'request.course.id'}) {
2258: my ($audom,$auname) = ($url =~ m{^/priv/($match_domain)/($match_name)/});
2259: if ($audom ne '' && $auname ne '') {
2260: if (($env{'course.'.$env{'request.course.id'}.'.num'} eq $auname) &&
2261: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $audom)) {
2262: $cnum = $auname;
2263: $cdom = $audom;
2264: }
2265: }
2266: }
2267: return ($cnum,$cdom);
2268: }
2269:
2270: sub import_crsauthor_form {
1.1400 raeburn 2271: my ($firstselectname,$secondselectname,$onchangefirst,$only,$suffix,$disabled) = @_;
1.1248 raeburn 2272: return (0) unless ($env{'request.course.id'});
2273: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
2274: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
2275: my $crshome = $env{'course.'.$env{'request.course.id'}.'.home'};
2276: return (0) unless (($cnum ne '') && ($cdom ne ''));
2277: my @ids=&Apache::lonnet::current_machine_ids();
1.1400 raeburn 2278: my ($output,$is_home,$toppath,%subdirs,%files,%selimport_menus,$include,$exclude);
1.1402 raeburn 2279:
1.1248 raeburn 2280: if (grep(/^\Q$crshome\E$/,@ids)) {
2281: $is_home = 1;
2282: }
1.1400 raeburn 2283: $toppath = "/priv/$cdom/$cnum";
2284: my $nonemptydir = 1;
2285: my $js_only;
2286: if ($only) {
2287: map { $include->{$_} = 1; } split(/\s*,\s*/,$only);
2288: $js_only = join(',',map { &js_escape($_); } sort(keys(%{$include})));
2289: }
2290: $exclude = &Apache::lonnet::priv_exclude();
1.1402 raeburn 2291: &Apache::lonnet::recursedirs($is_home,1,$include,$exclude,1,0,$toppath,'',\%subdirs,\%files);
1.1400 raeburn 2292: my $numdirs = scalar(keys(%files));
1.1248 raeburn 2293: my %lt = &Apache::lonlocal::texthash (
2294: fnam => 'Filename',
2295: dire => 'Directory',
1.1400 raeburn 2296: se => 'Select',
1.1248 raeburn 2297: );
1.1402 raeburn 2298: $output = $lt{'dire'}.': '.
1.1400 raeburn 2299: '<select id="'.$firstselectname.'" name="'.$firstselectname.'" '.
1.1402 raeburn 2300: 'onchange="populateCrsSelects(this.form,'."'$firstselectname','$secondselectname',1,'$js_only',0,1,0,0,0".');">'.
1.1400 raeburn 2301: '<option value="" selected="selected">'.$lt{'se'}.'</option>';
1.1402 raeburn 2302: if ($files{'/'}) {
2303: $output .= '<option value="/">/</option>'."\n";
2304: }
1.1400 raeburn 2305: foreach my $key (sort { lc($a) cmp lc($b) } (keys(%files))) {
1.1402 raeburn 2306: next if ($key eq '/');
1.1400 raeburn 2307: $output .= '<option value="'.$key.'">'.$key.'</option>'."\n";
2308: }
2309: $output .= '</select><br />'."\n".
1.1402 raeburn 2310: $lt{'fnam'}.': <select id="'.$secondselectname.'" name="'.$secondselectname.'">'."\n".
1.1400 raeburn 2311: '<option value="" selected="selected"></option>'."\n".
1.1402 raeburn 2312: '</select>'."\n".
2313: '<input type="hidden" id="crsres_include_'.$suffix.'" value="'.$only.'" />';
1.1400 raeburn 2314: return ($numdirs,$output);
2315: }
2316:
2317: sub show_crsfiles_js {
2318: my $excluderef = &Apache::lonnet::priv_exclude();
2319: my $se = &js_escape(&mt('Select'));
2320: my $exclude;
2321: if (ref($excluderef) eq 'HASH') {
2322: $exclude = join(',', map { &js_escape($_); } sort(keys(%{$excluderef})));
2323: }
2324: my $js = <<"END";
2325:
2326:
1.1402 raeburn 2327: function populateCrsSelects (form,dirsel,filesel,exc,include,setdir,setfile,recurse,nonemptydir,addtopdir) {
1.1400 raeburn 2328: var relpath = '';
2329: if ((setfile) && (dirsel != null) && (dirsel != 'undefined') && (dirsel != '')) {
2330: var currdir = form.elements[dirsel].options[form.elements[dirsel].selectedIndex].value;
2331: if (currdir == '') {
2332: if ((filesel != null) && (filesel != 'undefined') && (filesel != '')) {
2333: selelem = form.elements[filesel];
2334: var j, numfiles = selelem.options.length -1;
2335: if (numfiles >=0) {
2336: for (j = numfiles; j >= 0; j--) {
2337: selelem.remove(j);
2338: }
2339: }
2340: if (selelem.options.length == 0) {
2341: selelem.options[selelem.options.length] = new Option('','');
2342: selelem.selectedIndex = 0;
1.1248 raeburn 2343: }
2344: }
1.1400 raeburn 2345: return;
2346: } else {
2347: relpath = encodeURIComponent(form.elements[dirsel].options[form.elements[dirsel].selectedIndex].value);
1.1248 raeburn 2348: }
2349: }
1.1400 raeburn 2350: var http = new XMLHttpRequest();
2351: var url = "/adm/courseauthor";
2352: var crsrole = "$env{'request.role'}";
2353: var exclude = '';
2354: if (exc) {
2355: exclude = '$exclude';
2356: }
1.1402 raeburn 2357: var params = "role=course&files=1&rec="+recurse+"&nonempty="+nonemptydir+"&exc="+exclude+"&inc="+include+"&addtop="+addtopdir+"&path="+relpath;
1.1400 raeburn 2358: http.open("POST", url, true);
2359: http.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
2360: http.onreadystatechange = function() {
2361: if (http.readyState == 4 && http.status == 200) {
2362: var data = JSON.parse(http.responseText);
2363: var selelem;
2364: if ((setdir) && (dirsel != null) && (dirsel != 'undefined') && (dirsel != '')) {
2365: if (Array.isArray(data.dirs)) {
2366: selelem = form.elements[dirsel];
2367: var i, numdirs = selelem.options.length -1;
2368: if (numdirs >=0) {
2369: for (i = numdirs; i >= 0; i--) {
2370: selelem.remove(i);
2371: }
2372: }
2373: var len = data.dirs.length;
2374: if (len) {
1.1402 raeburn 2375: selelem.options[selelem.options.length] = new Option('$se','');
1.1400 raeburn 2376: var j;
2377: for (j = 0; j < len; j++) {
2378: selelem.options[selelem.options.length] = new Option(data.dirs[j],data.dirs[j]);
2379: }
2380: selelem.selectedIndex = 0;
2381: }
2382: if (!setfile) {
2383: if ((filesel != null) && (filesel != 'undefined') && (filesel != '')) {
2384: selelem = form.elements[filesel];
2385: var j, numfiles = selelem.options.length -1;
2386: if (numfiles >=0) {
2387: for (j = numfiles; j >= 0; j--) {
2388: selelem.remove(j);
2389: }
2390: }
2391: if (selelem.options.length == 0) {
2392: selelem.options[selelem.options.length] = new Option('','');
2393: selelem.selectedIndex = 0;
2394: }
2395: }
2396: }
2397: }
2398: }
2399: if ((setfile) && (filesel != null) && (filesel != 'undefined') && (filesel != '')) {
2400: selelem = form.elements[filesel];
2401: var i, numfiles = selelem.options.length -1;
2402: if (numfiles >=0) {
2403: for (i = numfiles; i >= 0; i--) {
2404: selelem.remove(i);
2405: }
2406: }
2407: var x;
2408: for (x in data.files) {
2409: if (Array.isArray(data.files[x])) {
2410: if (data.files[x].length > 1) {
2411: selelem.options[selelem.options.length] = new Option('$se','');
2412: }
2413: var len = data.files[x].length;
2414: if (len) {
2415: var k;
2416: for (k = 0; k < len; k++) {
2417: selelem.options[selelem.options.length] = new Option(data.files[x][k],data.files[x][k]);
2418: }
2419: selelem.selectedIndex = 0;
2420: }
2421: }
2422: }
2423: if (selelem.options.length == 0) {
2424: selelem.options[selelem.options.length] = new Option('','');
2425: selelem.selectedIndex = 0;
2426: }
1.1248 raeburn 2427: }
2428: }
2429: }
1.1400 raeburn 2430: http.send(params);
1.1248 raeburn 2431: }
1.1400 raeburn 2432: END
1.1248 raeburn 2433: }
2434:
1.565 albertel 2435: =pod
2436:
1.256 matthew 2437: =head1 Excel and CSV file utility routines
2438:
2439: =cut
2440:
2441: ###############################################################
2442: ###############################################################
2443:
2444: =pod
2445:
1.1162 raeburn 2446: =over 4
2447:
1.648 raeburn 2448: =item * &csv_translate($text)
1.37 matthew 2449:
1.185 www 2450: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 2451: format.
2452:
2453: =cut
2454:
1.180 matthew 2455: ###############################################################
2456: ###############################################################
1.37 matthew 2457: sub csv_translate {
2458: my $text = shift;
2459: $text =~ s/\"/\"\"/g;
1.209 albertel 2460: $text =~ s/\n/ /g;
1.37 matthew 2461: return $text;
2462: }
1.180 matthew 2463:
2464: ###############################################################
2465: ###############################################################
2466:
2467: =pod
2468:
1.648 raeburn 2469: =item * &define_excel_formats()
1.180 matthew 2470:
2471: Define some commonly used Excel cell formats.
2472:
2473: Currently supported formats:
2474:
2475: =over 4
2476:
2477: =item header
2478:
2479: =item bold
2480:
2481: =item h1
2482:
2483: =item h2
2484:
2485: =item h3
2486:
1.256 matthew 2487: =item h4
2488:
2489: =item i
2490:
1.180 matthew 2491: =item date
2492:
2493: =back
2494:
2495: Inputs: $workbook
2496:
2497: Returns: $format, a hash reference.
2498:
1.1057 foxr 2499:
1.180 matthew 2500: =cut
2501:
2502: ###############################################################
2503: ###############################################################
2504: sub define_excel_formats {
2505: my ($workbook) = @_;
2506: my $format;
2507: $format->{'header'} = $workbook->add_format(bold => 1,
2508: bottom => 1,
2509: align => 'center');
2510: $format->{'bold'} = $workbook->add_format(bold=>1);
2511: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
2512: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
2513: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 2514: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 2515: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 2516: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 2517: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 2518: return $format;
2519: }
2520:
2521: ###############################################################
2522: ###############################################################
1.113 bowersj2 2523:
2524: =pod
2525:
1.648 raeburn 2526: =item * &create_workbook()
1.255 matthew 2527:
2528: Create an Excel worksheet. If it fails, output message on the
2529: request object and return undefs.
2530:
2531: Inputs: Apache request object
2532:
2533: Returns (undef) on failure,
2534: Excel worksheet object, scalar with filename, and formats
2535: from &Apache::loncommon::define_excel_formats on success
2536:
2537: =cut
2538:
2539: ###############################################################
2540: ###############################################################
2541: sub create_workbook {
2542: my ($r) = @_;
2543: #
2544: # Create the excel spreadsheet
2545: my $filename = '/prtspool/'.
1.258 albertel 2546: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 2547: time.'_'.rand(1000000000).'.xls';
2548: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
2549: if (! defined($workbook)) {
2550: $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928 bisitz 2551: $r->print(
2552: '<p class="LC_error">'
2553: .&mt('Problems occurred in creating the new Excel file.')
2554: .' '.&mt('This error has been logged.')
2555: .' '.&mt('Please alert your LON-CAPA administrator.')
2556: .'</p>'
2557: );
1.255 matthew 2558: return (undef);
2559: }
2560: #
1.1014 foxr 2561: $workbook->set_tempdir(LONCAPA::tempdir());
1.255 matthew 2562: #
2563: my $format = &Apache::loncommon::define_excel_formats($workbook);
2564: return ($workbook,$filename,$format);
2565: }
2566:
2567: ###############################################################
2568: ###############################################################
2569:
2570: =pod
2571:
1.648 raeburn 2572: =item * &create_text_file()
1.113 bowersj2 2573:
1.542 raeburn 2574: Create a file to write to and eventually make available to the user.
1.256 matthew 2575: If file creation fails, outputs an error message on the request object and
2576: return undefs.
1.113 bowersj2 2577:
1.256 matthew 2578: Inputs: Apache request object, and file suffix
1.113 bowersj2 2579:
1.256 matthew 2580: Returns (undef) on failure,
2581: Filehandle and filename on success.
1.113 bowersj2 2582:
2583: =cut
2584:
1.256 matthew 2585: ###############################################################
2586: ###############################################################
2587: sub create_text_file {
2588: my ($r,$suffix) = @_;
2589: if (! defined($suffix)) { $suffix = 'txt'; };
2590: my $fh;
2591: my $filename = '/prtspool/'.
1.258 albertel 2592: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 2593: time.'_'.rand(1000000000).'.'.$suffix;
2594: $fh = Apache::File->new('>/home/httpd'.$filename);
2595: if (! defined($fh)) {
2596: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 2597: $r->print(
2598: '<p class="LC_error">'
2599: .&mt('Problems occurred in creating the output file.')
2600: .' '.&mt('This error has been logged.')
2601: .' '.&mt('Please alert your LON-CAPA administrator.')
2602: .'</p>'
2603: );
1.113 bowersj2 2604: }
1.256 matthew 2605: return ($fh,$filename)
1.113 bowersj2 2606: }
2607:
2608:
1.256 matthew 2609: =pod
1.113 bowersj2 2610:
2611: =back
2612:
2613: =cut
1.37 matthew 2614:
2615: ###############################################################
1.33 matthew 2616: ## Home server <option> list generating code ##
2617: ###############################################################
1.35 matthew 2618:
1.169 www 2619: # ------------------------------------------
2620:
2621: sub domain_select {
1.1289 raeburn 2622: my ($name,$value,$multiple,$incdoms,$excdoms)=@_;
2623: my @possdoms;
2624: if (ref($incdoms) eq 'ARRAY') {
2625: @possdoms = @{$incdoms};
2626: } else {
2627: @possdoms = &Apache::lonnet::all_domains();
2628: }
2629:
1.169 www 2630: my %domains=map {
1.514 albertel 2631: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.1289 raeburn 2632: } @possdoms;
2633:
2634: if ((ref($excdoms) eq 'ARRAY') && (@{$excdoms} > 0)) {
2635: foreach my $dom (@{$excdoms}) {
2636: delete($domains{$dom});
2637: }
2638: }
2639:
1.169 www 2640: if ($multiple) {
2641: $domains{''}=&mt('Any domain');
1.550 albertel 2642: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 2643: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 2644: } else {
1.550 albertel 2645: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970 raeburn 2646: return &select_form($name,$value,\%domains);
1.169 www 2647: }
2648: }
2649:
1.282 albertel 2650: #-------------------------------------------
2651:
2652: =pod
2653:
1.519 raeburn 2654: =head1 Routines for form select boxes
2655:
2656: =over 4
2657:
1.648 raeburn 2658: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 2659:
2660: Returns a string containing a <select> element int multiple mode
2661:
2662:
2663: Args:
2664: $name - name of the <select> element
1.506 raeburn 2665: $value - scalar or array ref of values that should already be selected
1.282 albertel 2666: $size - number of rows long the select element is
1.283 albertel 2667: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 2668: (shown text should already have been &mt())
1.506 raeburn 2669: $order - (optional) array ref of the order to show the elements in
1.283 albertel 2670:
1.282 albertel 2671: =cut
2672:
2673: #-------------------------------------------
1.169 www 2674: sub multiple_select_form {
1.284 albertel 2675: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 2676: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
2677: my $output='';
1.191 matthew 2678: if (! defined($size)) {
2679: $size = 4;
1.283 albertel 2680: if (scalar(keys(%$hash))<4) {
2681: $size = scalar(keys(%$hash));
1.191 matthew 2682: }
2683: }
1.734 bisitz 2684: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 2685: my @order;
1.506 raeburn 2686: if (ref($order) eq 'ARRAY') {
2687: @order = @{$order};
2688: } else {
2689: @order = sort(keys(%$hash));
1.501 banghart 2690: }
2691: if (exists($$hash{'select_form_order'})) {
2692: @order = @{$$hash{'select_form_order'}};
2693: }
2694:
1.284 albertel 2695: foreach my $key (@order) {
1.356 albertel 2696: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 2697: $output.='selected="selected" ' if ($selected{$key});
2698: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 2699: }
2700: $output.="</select>\n";
2701: return $output;
2702: }
2703:
1.88 www 2704: #-------------------------------------------
2705:
2706: =pod
2707:
1.1254 raeburn 2708: =item * &select_form($defdom,$name,$hashref,$onchange,$readonly)
1.88 www 2709:
2710: Returns a string containing a <select name='$name' size='1'> form to
1.970 raeburn 2711: allow a user to select options from a ref to a hash containing:
2712: option_name => displayed text. An optional $onchange can include
1.1254 raeburn 2713: a javascript onchange item, e.g., onchange="this.form.submit();".
2714: An optional arg -- $readonly -- if true will cause the select form
2715: to be disabled, e.g., for the case where an instructor has a section-
2716: specific role, and is viewing/modifying parameters.
1.970 raeburn 2717:
1.88 www 2718: See lonrights.pm for an example invocation and use.
2719:
2720: =cut
2721:
2722: #-------------------------------------------
2723: sub select_form {
1.1228 raeburn 2724: my ($def,$name,$hashref,$onchange,$readonly) = @_;
1.970 raeburn 2725: return unless (ref($hashref) eq 'HASH');
2726: if ($onchange) {
2727: $onchange = ' onchange="'.$onchange.'"';
2728: }
1.1228 raeburn 2729: my $disabled;
2730: if ($readonly) {
2731: $disabled = ' disabled="disabled"';
2732: }
2733: my $selectform = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.128 albertel 2734: my @keys;
1.970 raeburn 2735: if (exists($hashref->{'select_form_order'})) {
2736: @keys=@{$hashref->{'select_form_order'}};
1.128 albertel 2737: } else {
1.970 raeburn 2738: @keys=sort(keys(%{$hashref}));
1.128 albertel 2739: }
1.356 albertel 2740: foreach my $key (@keys) {
2741: $selectform.=
2742: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
2743: ($key eq $def ? 'selected="selected" ' : '').
1.970 raeburn 2744: ">".$hashref->{$key}."</option>\n";
1.88 www 2745: }
2746: $selectform.="</select>";
2747: return $selectform;
2748: }
2749:
1.475 www 2750: # For display filters
2751:
2752: sub display_filter {
1.1074 raeburn 2753: my ($context) = @_;
1.475 www 2754: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 2755: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.1074 raeburn 2756: my $phraseinput = 'hidden';
2757: my $includeinput = 'hidden';
2758: my ($checked,$includetypestext);
2759: if ($env{'form.displayfilter'} eq 'containing') {
2760: $phraseinput = 'text';
2761: if ($context eq 'parmslog') {
2762: $includeinput = 'checkbox';
2763: if ($env{'form.includetypes'}) {
2764: $checked = ' checked="checked"';
2765: }
2766: $includetypestext = &mt('Include parameter types');
2767: }
2768: } else {
2769: $includetypestext = ' ';
2770: }
2771: my ($additional,$secondid,$thirdid);
2772: if ($context eq 'parmslog') {
2773: $additional =
2774: '<label><input type="'.$includeinput.'" name="includetypes"'.
2775: $checked.' name="includetypes" value="1" id="includetypes" />'.
2776: ' <span id="includetypestext">'.$includetypestext.'</span>'.
2777: '</label>';
2778: $secondid = 'includetypes';
2779: $thirdid = 'includetypestext';
2780: }
2781: my $onchange = "javascript:toggleHistoryOptions(this,'containingphrase','$context',
2782: '$secondid','$thirdid')";
2783: return '<span class="LC_nobreak"><label>'.&mt('Records: [_1]',
1.1403 raeburn 2784: &Apache::lonmeta::selectbox('show',$env{'form.show'},'',undef,
1.475 www 2785: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 2786: '</label></span> <span class="LC_nobreak">'.
1.1074 raeburn 2787: &mt('Filter: [_1]',
1.477 www 2788: &select_form($env{'form.displayfilter'},
2789: 'displayfilter',
1.970 raeburn 2790: {'currentfolder' => 'Current folder/page',
1.477 www 2791: 'containing' => 'Containing phrase',
1.1074 raeburn 2792: 'none' => 'None'},$onchange)).' '.
2793: '<input type="'.$phraseinput.'" name="containingphrase" id="containingphrase" size="30" value="'.
2794: &HTML::Entities::encode($env{'form.containingphrase'}).
2795: '" />'.$additional;
2796: }
2797:
2798: sub display_filter_js {
2799: my $includetext = &mt('Include parameter types');
2800: return <<"ENDJS";
2801:
2802: function toggleHistoryOptions(setter,firstid,context,secondid,thirdid) {
2803: var firstType = 'hidden';
2804: if (setter.options[setter.selectedIndex].value == 'containing') {
2805: firstType = 'text';
2806: }
2807: firstObject = document.getElementById(firstid);
2808: if (typeof(firstObject) == 'object') {
2809: if (firstObject.type != firstType) {
2810: changeInputType(firstObject,firstType);
2811: }
2812: }
2813: if (context == 'parmslog') {
2814: var secondType = 'hidden';
2815: if (firstType == 'text') {
2816: secondType = 'checkbox';
2817: }
2818: secondObject = document.getElementById(secondid);
2819: if (typeof(secondObject) == 'object') {
2820: if (secondObject.type != secondType) {
2821: changeInputType(secondObject,secondType);
2822: }
2823: }
2824: var textItem = document.getElementById(thirdid);
2825: var currtext = textItem.innerHTML;
2826: var newtext;
2827: if (firstType == 'text') {
2828: newtext = '$includetext';
2829: } else {
2830: newtext = ' ';
2831: }
2832: if (currtext != newtext) {
2833: textItem.innerHTML = newtext;
2834: }
2835: }
2836: return;
2837: }
2838:
2839: function changeInputType(oldObject,newType) {
2840: var newObject = document.createElement('input');
2841: newObject.type = newType;
2842: if (oldObject.size) {
2843: newObject.size = oldObject.size;
2844: }
2845: if (oldObject.value) {
2846: newObject.value = oldObject.value;
2847: }
2848: if (oldObject.name) {
2849: newObject.name = oldObject.name;
2850: }
2851: if (oldObject.id) {
2852: newObject.id = oldObject.id;
2853: }
2854: oldObject.parentNode.replaceChild(newObject,oldObject);
2855: return;
2856: }
2857:
2858: ENDJS
1.475 www 2859: }
2860:
1.167 www 2861: sub gradeleveldescription {
2862: my $gradelevel=shift;
2863: my %gradelevels=(0 => 'Not specified',
2864: 1 => 'Grade 1',
2865: 2 => 'Grade 2',
2866: 3 => 'Grade 3',
2867: 4 => 'Grade 4',
2868: 5 => 'Grade 5',
2869: 6 => 'Grade 6',
2870: 7 => 'Grade 7',
2871: 8 => 'Grade 8',
2872: 9 => 'Grade 9',
2873: 10 => 'Grade 10',
2874: 11 => 'Grade 11',
2875: 12 => 'Grade 12',
2876: 13 => 'Grade 13',
2877: 14 => '100 Level',
2878: 15 => '200 Level',
2879: 16 => '300 Level',
2880: 17 => '400 Level',
2881: 18 => 'Graduate Level');
2882: return &mt($gradelevels{$gradelevel});
2883: }
2884:
1.163 www 2885: sub select_level_form {
2886: my ($deflevel,$name)=@_;
2887: unless ($deflevel) { $deflevel=0; }
1.167 www 2888: my $selectform = "<select name=\"$name\" size=\"1\">\n";
2889: for (my $i=0; $i<=18; $i++) {
2890: $selectform.="<option value=\"$i\" ".
1.253 albertel 2891: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 2892: ">".&gradeleveldescription($i)."</option>\n";
2893: }
2894: $selectform.="</select>";
2895: return $selectform;
1.163 www 2896: }
1.167 www 2897:
1.35 matthew 2898: #-------------------------------------------
2899:
1.45 matthew 2900: =pod
2901:
1.1256 raeburn 2902: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled)
1.35 matthew 2903:
2904: Returns a string containing a <select name='$name' size='1'> form to
2905: allow a user to select the domain to preform an operation in.
2906: See loncreateuser.pm for an example invocation and use.
2907:
1.90 www 2908: If the $includeempty flag is set, it also includes an empty choice ("no domain
2909: selected");
2910:
1.743 raeburn 2911: If the $showdomdesc flag is set, the domain name is followed by the domain description.
2912:
1.910 raeburn 2913: 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.
2914:
1.1121 raeburn 2915: The optional $incdoms is a reference to an array of domains which will be the only available options.
2916:
2917: The optional $excdoms is a reference to an array of domains which will be excluded from the available options.
1.563 raeburn 2918:
1.1256 raeburn 2919: The optional $disabled argument, if true, adds the disabled attribute to the select tag.
2920:
1.35 matthew 2921: =cut
2922:
2923: #-------------------------------------------
1.34 matthew 2924: sub select_dom_form {
1.1256 raeburn 2925: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled) = @_;
1.872 raeburn 2926: if ($onchange) {
1.874 raeburn 2927: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 2928: }
1.1256 raeburn 2929: if ($disabled) {
2930: $disabled = ' disabled="disabled"';
2931: }
1.1121 raeburn 2932: my (@domains,%exclude);
1.910 raeburn 2933: if (ref($incdoms) eq 'ARRAY') {
2934: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
2935: } else {
2936: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
2937: }
1.90 www 2938: if ($includeempty) { @domains=('',@domains); }
1.1121 raeburn 2939: if (ref($excdoms) eq 'ARRAY') {
2940: map { $exclude{$_} = 1; } @{$excdoms};
2941: }
1.1256 raeburn 2942: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.356 albertel 2943: foreach my $dom (@domains) {
1.1121 raeburn 2944: next if ($exclude{$dom});
1.356 albertel 2945: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 2946: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
2947: if ($showdomdesc) {
2948: if ($dom ne '') {
2949: my $domdesc = &Apache::lonnet::domain($dom,'description');
2950: if ($domdesc ne '') {
2951: $selectdomain .= ' ('.$domdesc.')';
2952: }
2953: }
2954: }
2955: $selectdomain .= "</option>\n";
1.34 matthew 2956: }
2957: $selectdomain.="</select>";
2958: return $selectdomain;
2959: }
2960:
1.35 matthew 2961: #-------------------------------------------
2962:
1.45 matthew 2963: =pod
2964:
1.648 raeburn 2965: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 2966:
1.586 raeburn 2967: input: 4 arguments (two required, two optional) -
2968: $domain - domain of new user
2969: $name - name of form element
2970: $default - Value of 'default' causes a default item to be first
2971: option, and selected by default.
2972: $hide - Value of 'hide' causes hiding of the name of the server,
2973: if 1 server found, or default, if 0 found.
1.594 raeburn 2974: output: returns 2 items:
1.586 raeburn 2975: (a) form element which contains either:
2976: (i) <select name="$name">
2977: <option value="$hostid1">$hostid $servers{$hostid}</option>
2978: <option value="$hostid2">$hostid $servers{$hostid}</option>
2979: </select>
2980: form item if there are multiple library servers in $domain, or
2981: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2982: if there is only one library server in $domain.
2983:
2984: (b) number of library servers found.
2985:
2986: See loncreateuser.pm for example of use.
1.35 matthew 2987:
2988: =cut
2989:
2990: #-------------------------------------------
1.586 raeburn 2991: sub home_server_form_item {
2992: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2993: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2994: my $result;
2995: my $numlib = keys(%servers);
2996: if ($numlib > 1) {
2997: $result .= '<select name="'.$name.'" />'."\n";
2998: if ($default) {
1.804 bisitz 2999: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 3000: '</option>'."\n";
3001: }
3002: foreach my $hostid (sort(keys(%servers))) {
3003: $result.= '<option value="'.$hostid.'">'.
3004: $hostid.' '.$servers{$hostid}."</option>\n";
3005: }
3006: $result .= '</select>'."\n";
3007: } elsif ($numlib == 1) {
3008: my $hostid;
3009: foreach my $item (keys(%servers)) {
3010: $hostid = $item;
3011: }
3012: $result .= '<input type="hidden" name="'.$name.'" value="'.
3013: $hostid.'" />';
3014: if (!$hide) {
3015: $result .= $hostid.' '.$servers{$hostid};
3016: }
3017: $result .= "\n";
3018: } elsif ($default) {
3019: $result .= '<input type="hidden" name="'.$name.
3020: '" value="default" />';
3021: if (!$hide) {
3022: $result .= &mt('default');
3023: }
3024: $result .= "\n";
1.33 matthew 3025: }
1.586 raeburn 3026: return ($result,$numlib);
1.33 matthew 3027: }
1.112 bowersj2 3028:
3029: =pod
3030:
1.534 albertel 3031: =back
3032:
1.112 bowersj2 3033: =cut
1.87 matthew 3034:
3035: ###############################################################
1.112 bowersj2 3036: ## Decoding User Agent ##
1.87 matthew 3037: ###############################################################
3038:
3039: =pod
3040:
1.112 bowersj2 3041: =head1 Decoding the User Agent
3042:
3043: =over 4
3044:
3045: =item * &decode_user_agent()
1.87 matthew 3046:
3047: Inputs: $r
3048:
3049: Outputs:
3050:
3051: =over 4
3052:
1.112 bowersj2 3053: =item * $httpbrowser
1.87 matthew 3054:
1.112 bowersj2 3055: =item * $clientbrowser
1.87 matthew 3056:
1.112 bowersj2 3057: =item * $clientversion
1.87 matthew 3058:
1.112 bowersj2 3059: =item * $clientmathml
1.87 matthew 3060:
1.112 bowersj2 3061: =item * $clientunicode
1.87 matthew 3062:
1.112 bowersj2 3063: =item * $clientos
1.87 matthew 3064:
1.1137 raeburn 3065: =item * $clientmobile
3066:
1.1141 raeburn 3067: =item * $clientinfo
3068:
1.1194 raeburn 3069: =item * $clientosversion
3070:
1.87 matthew 3071: =back
3072:
1.157 matthew 3073: =back
3074:
1.87 matthew 3075: =cut
3076:
3077: ###############################################################
3078: ###############################################################
3079: sub decode_user_agent {
1.247 albertel 3080: my ($r)=@_;
1.87 matthew 3081: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
3082: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
3083: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 3084: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 3085: my $clientbrowser='unknown';
3086: my $clientversion='0';
3087: my $clientmathml='';
3088: my $clientunicode='0';
1.1137 raeburn 3089: my $clientmobile=0;
1.1194 raeburn 3090: my $clientosversion='';
1.87 matthew 3091: for (my $i=0;$i<=$#browsertype;$i++) {
1.1193 raeburn 3092: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\%/,$browsertype[$i]);
1.87 matthew 3093: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
3094: $clientbrowser=$bname;
3095: $httpbrowser=~/$vreg/i;
3096: $clientversion=$1;
3097: $clientmathml=($clientversion>=$minv);
3098: $clientunicode=($clientversion>=$univ);
3099: }
3100: }
3101: my $clientos='unknown';
1.1141 raeburn 3102: my $clientinfo;
1.87 matthew 3103: if (($httpbrowser=~/linux/i) ||
3104: ($httpbrowser=~/unix/i) ||
3105: ($httpbrowser=~/ux/i) ||
3106: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
3107: if (($httpbrowser=~/vax/i) ||
3108: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
3109: if ($httpbrowser=~/next/i) { $clientos='next'; }
3110: if (($httpbrowser=~/mac/i) ||
3111: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1.1194 raeburn 3112: if ($httpbrowser=~/win/i) {
3113: $clientos='win';
3114: if ($httpbrowser =~/Windows\s+NT\s+(\d+\.\d+)/i) {
3115: $clientosversion = $1;
3116: }
3117: }
1.87 matthew 3118: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1.1137 raeburn 3119: if ($httpbrowser=~/(Android|iPod|iPad|iPhone|webOS|Blackberry|Windows Phone|Opera m(?:ob|in)|Fennec)/i) {
3120: $clientmobile=lc($1);
3121: }
1.1141 raeburn 3122: if ($httpbrowser=~ m{Firefox/(\d+\.\d+)}) {
3123: $clientinfo = 'firefox-'.$1;
3124: } elsif ($httpbrowser=~ m{chromeframe/(\d+\.\d+)\.}) {
3125: $clientinfo = 'chromeframe-'.$1;
3126: }
1.87 matthew 3127: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1.1194 raeburn 3128: $clientunicode,$clientos,$clientmobile,$clientinfo,
3129: $clientosversion);
1.87 matthew 3130: }
3131:
1.32 matthew 3132: ###############################################################
3133: ## Authentication changing form generation subroutines ##
3134: ###############################################################
3135: ##
3136: ## All of the authform_xxxxxxx subroutines take their inputs in a
3137: ## hash, and have reasonable default values.
3138: ##
3139: ## formname = the name given in the <form> tag.
1.35 matthew 3140: #-------------------------------------------
3141:
1.45 matthew 3142: =pod
3143:
1.112 bowersj2 3144: =head1 Authentication Routines
3145:
3146: =over 4
3147:
1.648 raeburn 3148: =item * &authform_xxxxxx()
1.35 matthew 3149:
3150: The authform_xxxxxx subroutines provide javascript and html forms which
3151: handle some of the conveniences required for authentication forms.
3152: This is not an optimal method, but it works.
3153:
3154: =over 4
3155:
1.112 bowersj2 3156: =item * authform_header
1.35 matthew 3157:
1.112 bowersj2 3158: =item * authform_authorwarning
1.35 matthew 3159:
1.112 bowersj2 3160: =item * authform_nochange
1.35 matthew 3161:
1.112 bowersj2 3162: =item * authform_kerberos
1.35 matthew 3163:
1.112 bowersj2 3164: =item * authform_internal
1.35 matthew 3165:
1.112 bowersj2 3166: =item * authform_filesystem
1.35 matthew 3167:
1.1310 raeburn 3168: =item * authform_lti
3169:
1.35 matthew 3170: =back
3171:
1.648 raeburn 3172: See loncreateuser.pm for invocation and use examples.
1.157 matthew 3173:
1.35 matthew 3174: =cut
3175:
3176: #-------------------------------------------
1.32 matthew 3177: sub authform_header{
3178: my %in = (
3179: formname => 'cu',
1.80 albertel 3180: kerb_def_dom => '',
1.32 matthew 3181: @_,
3182: );
3183: $in{'formname'} = 'document.' . $in{'formname'};
3184: my $result='';
1.80 albertel 3185:
3186: #---------------------------------------------- Code for upper case translation
3187: my $Javascript_toUpperCase;
3188: unless ($in{kerb_def_dom}) {
3189: $Javascript_toUpperCase =<<"END";
3190: switch (choice) {
3191: case 'krb': currentform.elements[choicearg].value =
3192: currentform.elements[choicearg].value.toUpperCase();
3193: break;
3194: default:
3195: }
3196: END
3197: } else {
3198: $Javascript_toUpperCase = "";
3199: }
3200:
1.165 raeburn 3201: my $radioval = "'nochange'";
1.591 raeburn 3202: if (defined($in{'curr_authtype'})) {
3203: if ($in{'curr_authtype'} ne '') {
3204: $radioval = "'".$in{'curr_authtype'}."arg'";
3205: }
1.174 matthew 3206: }
1.165 raeburn 3207: my $argfield = 'null';
1.591 raeburn 3208: if (defined($in{'mode'})) {
1.165 raeburn 3209: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 3210: if (defined($in{'curr_autharg'})) {
3211: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 3212: $argfield = "'$in{'curr_autharg'}'";
3213: }
3214: }
3215: }
3216: }
3217:
1.32 matthew 3218: $result.=<<"END";
3219: var current = new Object();
1.165 raeburn 3220: current.radiovalue = $radioval;
3221: current.argfield = $argfield;
1.32 matthew 3222:
3223: function changed_radio(choice,currentform) {
3224: var choicearg = choice + 'arg';
3225: // If a radio button in changed, we need to change the argfield
3226: if (current.radiovalue != choice) {
3227: current.radiovalue = choice;
3228: if (current.argfield != null) {
3229: currentform.elements[current.argfield].value = '';
3230: }
3231: if (choice == 'nochange') {
3232: current.argfield = null;
3233: } else {
3234: current.argfield = choicearg;
3235: switch(choice) {
3236: case 'krb':
3237: currentform.elements[current.argfield].value =
3238: "$in{'kerb_def_dom'}";
3239: break;
3240: default:
3241: break;
3242: }
3243: }
3244: }
3245: return;
3246: }
1.22 www 3247:
1.32 matthew 3248: function changed_text(choice,currentform) {
3249: var choicearg = choice + 'arg';
3250: if (currentform.elements[choicearg].value !='') {
1.80 albertel 3251: $Javascript_toUpperCase
1.32 matthew 3252: // clear old field
3253: if ((current.argfield != choicearg) && (current.argfield != null)) {
3254: currentform.elements[current.argfield].value = '';
3255: }
3256: current.argfield = choicearg;
3257: }
3258: set_auth_radio_buttons(choice,currentform);
3259: return;
1.20 www 3260: }
1.32 matthew 3261:
3262: function set_auth_radio_buttons(newvalue,currentform) {
1.986 raeburn 3263: var numauthchoices = currentform.login.length;
3264: if (typeof numauthchoices == "undefined") {
3265: return;
3266: }
1.32 matthew 3267: var i=0;
1.986 raeburn 3268: while (i < numauthchoices) {
1.32 matthew 3269: if (currentform.login[i].value == newvalue) { break; }
3270: i++;
3271: }
1.986 raeburn 3272: if (i == numauthchoices) {
1.32 matthew 3273: return;
3274: }
3275: current.radiovalue = newvalue;
3276: currentform.login[i].checked = true;
3277: return;
3278: }
3279: END
3280: return $result;
3281: }
3282:
1.1106 raeburn 3283: sub authform_authorwarning {
1.32 matthew 3284: my $result='';
1.144 matthew 3285: $result='<i>'.
3286: &mt('As a general rule, only authors or co-authors should be '.
3287: 'filesystem authenticated '.
3288: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 3289: return $result;
3290: }
3291:
1.1106 raeburn 3292: sub authform_nochange {
1.32 matthew 3293: my %in = (
3294: formname => 'document.cu',
3295: kerb_def_dom => 'MSU.EDU',
3296: @_,
3297: );
1.1106 raeburn 3298: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.586 raeburn 3299: my $result;
1.1104 raeburn 3300: if (!$authnum) {
1.1105 raeburn 3301: $result = &mt('Under your current role you are not permitted to change login settings for this user');
1.586 raeburn 3302: } else {
3303: $result = '<label>'.&mt('[_1] Do not change login data',
3304: '<input type="radio" name="login" value="nochange" '.
3305: 'checked="checked" onclick="'.
1.281 albertel 3306: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
3307: '</label>';
1.586 raeburn 3308: }
1.32 matthew 3309: return $result;
3310: }
3311:
1.591 raeburn 3312: sub authform_kerberos {
1.32 matthew 3313: my %in = (
3314: formname => 'document.cu',
3315: kerb_def_dom => 'MSU.EDU',
1.80 albertel 3316: kerb_def_auth => 'krb4',
1.32 matthew 3317: @_,
3318: );
1.586 raeburn 3319: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
1.1259 raeburn 3320: $autharg,$jscall,$disabled);
1.1106 raeburn 3321: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 3322: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 3323: $check5 = ' checked="checked"';
1.80 albertel 3324: } else {
1.772 bisitz 3325: $check4 = ' checked="checked"';
1.80 albertel 3326: }
1.1259 raeburn 3327: if ($in{'readonly'}) {
3328: $disabled = ' disabled="disabled"';
3329: }
1.165 raeburn 3330: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 3331: if (defined($in{'curr_authtype'})) {
3332: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 3333: $krbcheck = ' checked="checked"';
1.623 raeburn 3334: if (defined($in{'mode'})) {
3335: if ($in{'mode'} eq 'modifyuser') {
3336: $krbcheck = '';
3337: }
3338: }
1.591 raeburn 3339: if (defined($in{'curr_kerb_ver'})) {
3340: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 3341: $check5 = ' checked="checked"';
1.591 raeburn 3342: $check4 = '';
3343: } else {
1.772 bisitz 3344: $check4 = ' checked="checked"';
1.591 raeburn 3345: $check5 = '';
3346: }
1.586 raeburn 3347: }
1.591 raeburn 3348: if (defined($in{'curr_autharg'})) {
1.165 raeburn 3349: $krbarg = $in{'curr_autharg'};
3350: }
1.586 raeburn 3351: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 3352: if (defined($in{'curr_autharg'})) {
1.586 raeburn 3353: $result =
3354: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
3355: $in{'curr_autharg'},$krbver);
3356: } else {
3357: $result =
3358: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
3359: }
3360: return $result;
3361: }
3362: }
3363: } else {
3364: if ($authnum == 1) {
1.784 bisitz 3365: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 3366: }
3367: }
1.586 raeburn 3368: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
3369: return;
1.587 raeburn 3370: } elsif ($authtype eq '') {
1.591 raeburn 3371: if (defined($in{'mode'})) {
1.587 raeburn 3372: if ($in{'mode'} eq 'modifycourse') {
3373: if ($authnum == 1) {
1.1259 raeburn 3374: $authtype = '<input type="radio" name="login" value="krb"'.$disabled.' />';
1.587 raeburn 3375: }
3376: }
3377: }
1.586 raeburn 3378: }
3379: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
3380: if ($authtype eq '') {
3381: $authtype = '<input type="radio" name="login" value="krb" '.
3382: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
1.1259 raeburn 3383: $krbcheck.$disabled.' />';
1.586 raeburn 3384: }
3385: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
1.1106 raeburn 3386: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
1.586 raeburn 3387: $in{'curr_authtype'} eq 'krb5') ||
1.1106 raeburn 3388: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
1.586 raeburn 3389: $in{'curr_authtype'} eq 'krb4')) {
3390: $result .= &mt
1.144 matthew 3391: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 3392: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 3393: '<label>'.$authtype,
1.281 albertel 3394: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 3395: 'value="'.$krbarg.'" '.
1.1259 raeburn 3396: 'onchange="'.$jscall.'"'.$disabled.' />',
3397: '<label><input type="radio" name="krbver" value="4" '.$check4.$disabled.' />',
3398: '</label><label><input type="radio" name="krbver" value="5" '.$check5.$disabled.' />',
1.281 albertel 3399: '</label>');
1.586 raeburn 3400: } elsif ($can_assign{'krb4'}) {
3401: $result .= &mt
3402: ('[_1] Kerberos authenticated with domain [_2] '.
3403: '[_3] Version 4 [_4]',
3404: '<label>'.$authtype,
3405: '</label><input type="text" size="10" name="krbarg" '.
3406: 'value="'.$krbarg.'" '.
1.1259 raeburn 3407: 'onchange="'.$jscall.'"'.$disabled.' />',
1.586 raeburn 3408: '<label><input type="hidden" name="krbver" value="4" />',
3409: '</label>');
3410: } elsif ($can_assign{'krb5'}) {
3411: $result .= &mt
3412: ('[_1] Kerberos authenticated with domain [_2] '.
3413: '[_3] Version 5 [_4]',
3414: '<label>'.$authtype,
3415: '</label><input type="text" size="10" name="krbarg" '.
3416: 'value="'.$krbarg.'" '.
1.1259 raeburn 3417: 'onchange="'.$jscall.'"'.$disabled.' />',
1.586 raeburn 3418: '<label><input type="hidden" name="krbver" value="5" />',
3419: '</label>');
3420: }
1.32 matthew 3421: return $result;
3422: }
3423:
1.1106 raeburn 3424: sub authform_internal {
1.586 raeburn 3425: my %in = (
1.32 matthew 3426: formname => 'document.cu',
3427: kerb_def_dom => 'MSU.EDU',
3428: @_,
3429: );
1.1259 raeburn 3430: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1106 raeburn 3431: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259 raeburn 3432: if ($in{'readonly'}) {
3433: $disabled = ' disabled="disabled"';
3434: }
1.591 raeburn 3435: if (defined($in{'curr_authtype'})) {
3436: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 3437: if ($can_assign{'int'}) {
1.772 bisitz 3438: $intcheck = 'checked="checked" ';
1.623 raeburn 3439: if (defined($in{'mode'})) {
3440: if ($in{'mode'} eq 'modifyuser') {
3441: $intcheck = '';
3442: }
3443: }
1.591 raeburn 3444: if (defined($in{'curr_autharg'})) {
1.586 raeburn 3445: $intarg = $in{'curr_autharg'};
3446: }
3447: } else {
3448: $result = &mt('Currently internally authenticated.');
3449: return $result;
1.165 raeburn 3450: }
3451: }
1.586 raeburn 3452: } else {
3453: if ($authnum == 1) {
1.784 bisitz 3454: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 3455: }
3456: }
3457: if (!$can_assign{'int'}) {
3458: return;
1.587 raeburn 3459: } elsif ($authtype eq '') {
1.591 raeburn 3460: if (defined($in{'mode'})) {
1.587 raeburn 3461: if ($in{'mode'} eq 'modifycourse') {
3462: if ($authnum == 1) {
1.1259 raeburn 3463: $authtype = '<input type="radio" name="login" value="int"'.$disabled.' />';
1.587 raeburn 3464: }
3465: }
3466: }
1.165 raeburn 3467: }
1.586 raeburn 3468: $jscall = "javascript:changed_radio('int',$in{'formname'});";
3469: if ($authtype eq '') {
3470: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
1.1259 raeburn 3471: ' onchange="'.$jscall.'" onclick="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3472: }
1.605 bisitz 3473: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.1259 raeburn 3474: $intarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3475: $result = &mt
1.144 matthew 3476: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 3477: '<label>'.$authtype,'</label>'.$autharg);
1.1259 raeburn 3478: $result.='<label><input type="checkbox" name="visible" onclick="if (this.checked) { this.form.intarg.type='."'text'".' } else { this.form.intarg.type='."'password'".' }"'.$disabled.' />'.&mt('Visible input').'</label>';
1.32 matthew 3479: return $result;
3480: }
3481:
1.1104 raeburn 3482: sub authform_local {
1.32 matthew 3483: my %in = (
3484: formname => 'document.cu',
3485: kerb_def_dom => 'MSU.EDU',
3486: @_,
3487: );
1.1259 raeburn 3488: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1106 raeburn 3489: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259 raeburn 3490: if ($in{'readonly'}) {
3491: $disabled = ' disabled="disabled"';
3492: }
1.591 raeburn 3493: if (defined($in{'curr_authtype'})) {
3494: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 3495: if ($can_assign{'loc'}) {
1.772 bisitz 3496: $loccheck = 'checked="checked" ';
1.623 raeburn 3497: if (defined($in{'mode'})) {
3498: if ($in{'mode'} eq 'modifyuser') {
3499: $loccheck = '';
3500: }
3501: }
1.591 raeburn 3502: if (defined($in{'curr_autharg'})) {
1.586 raeburn 3503: $locarg = $in{'curr_autharg'};
3504: }
3505: } else {
3506: $result = &mt('Currently using local (institutional) authentication.');
3507: return $result;
1.165 raeburn 3508: }
3509: }
1.586 raeburn 3510: } else {
3511: if ($authnum == 1) {
1.784 bisitz 3512: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 3513: }
3514: }
3515: if (!$can_assign{'loc'}) {
3516: return;
1.587 raeburn 3517: } elsif ($authtype eq '') {
1.591 raeburn 3518: if (defined($in{'mode'})) {
1.587 raeburn 3519: if ($in{'mode'} eq 'modifycourse') {
3520: if ($authnum == 1) {
1.1259 raeburn 3521: $authtype = '<input type="radio" name="login" value="loc"'.$disabled.' />';
1.587 raeburn 3522: }
3523: }
3524: }
1.165 raeburn 3525: }
1.586 raeburn 3526: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
3527: if ($authtype eq '') {
3528: $authtype = '<input type="radio" name="login" value="loc" '.
3529: $loccheck.' onchange="'.$jscall.'" onclick="'.
1.1259 raeburn 3530: $jscall.'"'.$disabled.' />';
1.586 raeburn 3531: }
3532: $autharg = '<input type="text" size="10" name="locarg" value="'.
1.1259 raeburn 3533: $locarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3534: $result = &mt('[_1] Local Authentication with argument [_2]',
3535: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 3536: return $result;
3537: }
3538:
1.1106 raeburn 3539: sub authform_filesystem {
1.32 matthew 3540: my %in = (
3541: formname => 'document.cu',
3542: kerb_def_dom => 'MSU.EDU',
3543: @_,
3544: );
1.1259 raeburn 3545: my ($fsyscheck,$result,$authtype,$autharg,$jscall,$disabled);
1.1106 raeburn 3546: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259 raeburn 3547: if ($in{'readonly'}) {
3548: $disabled = ' disabled="disabled"';
3549: }
1.591 raeburn 3550: if (defined($in{'curr_authtype'})) {
3551: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 3552: if ($can_assign{'fsys'}) {
1.772 bisitz 3553: $fsyscheck = 'checked="checked" ';
1.623 raeburn 3554: if (defined($in{'mode'})) {
3555: if ($in{'mode'} eq 'modifyuser') {
3556: $fsyscheck = '';
3557: }
3558: }
1.586 raeburn 3559: } else {
3560: $result = &mt('Currently Filesystem Authenticated.');
3561: return $result;
1.1259 raeburn 3562: }
1.586 raeburn 3563: }
3564: } else {
3565: if ($authnum == 1) {
1.784 bisitz 3566: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 3567: }
3568: }
3569: if (!$can_assign{'fsys'}) {
3570: return;
1.587 raeburn 3571: } elsif ($authtype eq '') {
1.591 raeburn 3572: if (defined($in{'mode'})) {
1.587 raeburn 3573: if ($in{'mode'} eq 'modifycourse') {
3574: if ($authnum == 1) {
1.1259 raeburn 3575: $authtype = '<input type="radio" name="login" value="fsys"'.$disabled.' />';
1.587 raeburn 3576: }
3577: }
3578: }
1.586 raeburn 3579: }
3580: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
3581: if ($authtype eq '') {
3582: $authtype = '<input type="radio" name="login" value="fsys" '.
3583: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
1.1259 raeburn 3584: $jscall.'"'.$disabled.' />';
1.586 raeburn 3585: }
1.1310 raeburn 3586: $autharg = '<input type="password" size="10" name="fsysarg" value=""'.
1.1259 raeburn 3587: ' onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3588: $result = &mt
1.144 matthew 3589: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.1310 raeburn 3590: '<label>'.$authtype,'</label>'.$autharg);
3591: return $result;
3592: }
3593:
3594: sub authform_lti {
3595: my %in = (
3596: formname => 'document.cu',
3597: kerb_def_dom => 'MSU.EDU',
3598: @_,
3599: );
3600: my ($lticheck,$result,$authtype,$autharg,$jscall,$disabled);
3601: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
3602: if ($in{'readonly'}) {
3603: $disabled = ' disabled="disabled"';
3604: }
3605: if (defined($in{'curr_authtype'})) {
3606: if ($in{'curr_authtype'} eq 'lti') {
3607: if ($can_assign{'lti'}) {
3608: $lticheck = 'checked="checked" ';
3609: if (defined($in{'mode'})) {
3610: if ($in{'mode'} eq 'modifyuser') {
3611: $lticheck = '';
3612: }
3613: }
3614: } else {
3615: $result = &mt('Currently LTI Authenticated.');
3616: return $result;
3617: }
3618: }
3619: } else {
3620: if ($authnum == 1) {
3621: $authtype = '<input type="hidden" name="login" value="lti" />';
3622: }
3623: }
3624: if (!$can_assign{'lti'}) {
3625: return;
3626: } elsif ($authtype eq '') {
3627: if (defined($in{'mode'})) {
3628: if ($in{'mode'} eq 'modifycourse') {
3629: if ($authnum == 1) {
3630: $authtype = '<input type="radio" name="login" value="lti"'.$disabled.' />';
3631: }
3632: }
3633: }
3634: }
3635: $jscall = "javascript:changed_radio('lti',$in{'formname'});";
3636: if (($authtype eq '') && (($in{'mode'} eq 'modifycourse') || ($in{'curr_authtype'} ne 'lti'))) {
3637: $authtype = '<input type="radio" name="login" value="lti" '.
3638: $lticheck.' onchange="'.$jscall.'" onclick="'.
3639: $jscall.'"'.$disabled.' />';
3640: }
3641: $autharg = '<input type="hidden" name="ltiarg" value="" />';
3642: if ($authtype) {
3643: $result = &mt('[_1] LTI Authenticated',
3644: '<label>'.$authtype.'</label>'.$autharg);
3645: } else {
3646: $result = '<b>'.&mt('LTI Authenticated').'</b>'.
3647: $autharg;
3648: }
1.32 matthew 3649: return $result;
3650: }
3651:
1.586 raeburn 3652: sub get_assignable_auth {
3653: my ($dom) = @_;
3654: if ($dom eq '') {
3655: $dom = $env{'request.role.domain'};
3656: }
3657: my %can_assign = (
3658: krb4 => 1,
3659: krb5 => 1,
3660: int => 1,
3661: loc => 1,
1.1310 raeburn 3662: lti => 1,
1.586 raeburn 3663: );
3664: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
3665: if (ref($domconfig{'usercreation'}) eq 'HASH') {
3666: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
3667: my $authhash = $domconfig{'usercreation'}{'authtypes'};
3668: my $context;
3669: if ($env{'request.role'} =~ /^au/) {
3670: $context = 'author';
1.1259 raeburn 3671: } elsif ($env{'request.role'} =~ /^(dc|dh)/) {
1.586 raeburn 3672: $context = 'domain';
3673: } elsif ($env{'request.course.id'}) {
3674: $context = 'course';
3675: }
3676: if ($context) {
3677: if (ref($authhash->{$context}) eq 'HASH') {
3678: %can_assign = %{$authhash->{$context}};
3679: }
3680: }
3681: }
3682: }
3683: my $authnum = 0;
3684: foreach my $key (keys(%can_assign)) {
3685: if ($can_assign{$key}) {
3686: $authnum ++;
3687: }
3688: }
3689: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
3690: $authnum --;
3691: }
3692: return ($authnum,%can_assign);
3693: }
3694:
1.1331 raeburn 3695: sub check_passwd_rules {
3696: my ($domain,$plainpass) = @_;
3697: my %passwdconf = &Apache::lonnet::get_passwdconf($domain);
3698: my ($min,$max,@chars,@brokerule,$warning);
1.1333 raeburn 3699: $min = $Apache::lonnet::passwdmin;
1.1331 raeburn 3700: if (ref($passwdconf{'chars'}) eq 'ARRAY') {
3701: if ($passwdconf{'min'} =~ /^\d+$/) {
1.1333 raeburn 3702: if ($passwdconf{'min'} > $min) {
3703: $min = $passwdconf{'min'};
3704: }
1.1331 raeburn 3705: }
3706: if ($passwdconf{'max'} =~ /^\d+$/) {
3707: $max = $passwdconf{'max'};
3708: }
3709: @chars = @{$passwdconf{'chars'}};
3710: }
3711: if (($min) && (length($plainpass) < $min)) {
3712: push(@brokerule,'min');
3713: }
3714: if (($max) && (length($plainpass) > $max)) {
3715: push(@brokerule,'max');
3716: }
3717: if (@chars) {
3718: my %rules;
3719: map { $rules{$_} = 1; } @chars;
3720: if ($rules{'uc'}) {
3721: unless ($plainpass =~ /[A-Z]/) {
3722: push(@brokerule,'uc');
3723: }
3724: }
3725: if ($rules{'lc'}) {
1.1332 raeburn 3726: unless ($plainpass =~ /[a-z]/) {
1.1331 raeburn 3727: push(@brokerule,'lc');
3728: }
3729: }
3730: if ($rules{'num'}) {
3731: unless ($plainpass =~ /\d/) {
3732: push(@brokerule,'num');
3733: }
3734: }
3735: if ($rules{'spec'}) {
3736: unless ($plainpass =~ /[!"#$%&'()*+,\-.\/:;<=>?@[\\\]^_`{|}~]/) {
3737: push(@brokerule,'spec');
3738: }
3739: }
3740: }
3741: if (@brokerule) {
3742: my %rulenames = &Apache::lonlocal::texthash(
3743: uc => 'At least one upper case letter',
3744: lc => 'At least one lower case letter',
3745: num => 'At least one number',
3746: spec => 'At least one non-alphanumeric',
3747: );
3748: $rulenames{'uc'} .= ': ABCDEFGHIJKLMNOPQRSTUVWXYZ';
3749: $rulenames{'lc'} .= ': abcdefghijklmnopqrstuvwxyz';
3750: $rulenames{'num'} .= ': 0123456789';
3751: $rulenames{'spec'} .= ': !"\#$%&\'()*+,-./:;<=>?@[\]^_\`{|}~';
3752: $rulenames{'min'} = &mt('Minimum password length: [_1]',$min);
3753: $rulenames{'max'} = &mt('Maximum password length: [_1]',$max);
3754: $warning = &mt('Password did not satisfy the following:').'<ul>';
1.1336 raeburn 3755: foreach my $rule ('min','max','uc','lc','num','spec') {
1.1331 raeburn 3756: if (grep(/^$rule$/,@brokerule)) {
3757: $warning .= '<li>'.$rulenames{$rule}.'</li>';
3758: }
3759: }
3760: $warning .= '</ul>';
3761: }
1.1332 raeburn 3762: if (wantarray) {
3763: return @brokerule;
3764: }
1.1331 raeburn 3765: return $warning;
3766: }
3767:
1.1376 raeburn 3768: sub passwd_validation_js {
1.1377 raeburn 3769: my ($currpasswdval,$domain,$context,$id) = @_;
3770: my (%passwdconf,$alertmsg);
3771: if ($context eq 'linkprot') {
3772: my %domconfig = &Apache::lonnet::get_dom('configuration',['ltisec'],$domain);
3773: if (ref($domconfig{'ltisec'}) eq 'HASH') {
3774: if (ref($domconfig{'ltisec'}{'rules'}) eq 'HASH') {
3775: %passwdconf = %{$domconfig{'ltisec'}{'rules'}};
3776: }
3777: }
3778: if ($id eq 'add') {
3779: $alertmsg = &mt('Secret for added launcher did not satisfy requirement(s):').'\n\n';
3780: } elsif ($id =~ /^\d+$/) {
3781: my $pos = $id+1;
3782: $alertmsg = &mt('Secret for launcher [_1] did not satisfy requirement(s):','#'.$pos).'\n\n';
3783: } else {
3784: $alertmsg = &mt('A secret did not satisfy requirement(s):').'\n\n';
3785: }
3786: } else {
3787: %passwdconf = &Apache::lonnet::get_passwdconf($domain);
3788: $alertmsg = &mt('Initial password did not satisfy requirement(s):').'\n\n';
3789: }
1.1376 raeburn 3790: my ($min,$max,@chars,$numrules,$intargjs,%alert);
3791: $numrules = 0;
3792: $min = $Apache::lonnet::passwdmin;
3793: if (ref($passwdconf{'chars'}) eq 'ARRAY') {
3794: if ($passwdconf{'min'} =~ /^\d+$/) {
3795: if ($passwdconf{'min'} > $min) {
3796: $min = $passwdconf{'min'};
3797: }
3798: }
3799: if ($passwdconf{'max'} =~ /^\d+$/) {
3800: $max = $passwdconf{'max'};
3801: $numrules ++;
3802: }
3803: @chars = @{$passwdconf{'chars'}};
3804: if (@chars) {
3805: $numrules ++;
3806: }
3807: }
3808: if ($min > 0) {
3809: $numrules ++;
3810: }
3811: if (($min > 0) || ($max ne '') || (@chars > 0)) {
3812: if ($min) {
3813: $alert{'min'} = &mt('minimum [quant,_1,character]',$min).'\n';
3814: }
3815: if ($max) {
3816: $alert{'max'} = &mt('maximum [quant,_1,character]',$max).'\n';
3817: }
3818: my (@charalerts,@charrules);
3819: if (@chars) {
3820: if (grep(/^uc$/,@chars)) {
3821: push(@charalerts,&mt('contain at least one upper case letter'));
3822: push(@charrules,'uc');
3823: }
3824: if (grep(/^lc$/,@chars)) {
3825: push(@charalerts,&mt('contain at least one lower case letter'));
3826: push(@charrules,'lc');
3827: }
3828: if (grep(/^num$/,@chars)) {
3829: push(@charalerts,&mt('contain at least one number'));
3830: push(@charrules,'num');
3831: }
3832: if (grep(/^spec$/,@chars)) {
3833: push(@charalerts,&mt('contain at least one non-alphanumeric'));
3834: push(@charrules,'spec');
3835: }
3836: }
3837: $intargjs = qq| var rulesmsg = '';\n|.
3838: qq| var currpwval = $currpasswdval;\n|;
3839: if ($min) {
3840: $intargjs .= qq|
3841: if (currpwval.length < $min) {
3842: rulesmsg += ' - $alert{min}';
3843: }
3844: |;
3845: }
3846: if ($max) {
3847: $intargjs .= qq|
3848: if (currpwval.length > $max) {
3849: rulesmsg += ' - $alert{max}';
3850: }
3851: |;
3852: }
3853: if (@chars > 0) {
3854: my $charrulestr = '"'.join('","',@charrules).'"';
3855: my $charalertstr = '"'.join('","',@charalerts).'"';
3856: $intargjs .= qq| var brokerules = new Array();\n|.
3857: qq| var charrules = new Array($charrulestr);\n|.
3858: qq| var charalerts = new Array($charalertstr);\n|;
3859: my %rules;
3860: map { $rules{$_} = 1; } @chars;
3861: if ($rules{'uc'}) {
3862: $intargjs .= qq|
3863: var ucRegExp = /[A-Z]/;
3864: if (!ucRegExp.test(currpwval)) {
3865: brokerules.push('uc');
3866: }
3867: |;
3868: }
3869: if ($rules{'lc'}) {
3870: $intargjs .= qq|
3871: var lcRegExp = /[a-z]/;
3872: if (!lcRegExp.test(currpwval)) {
3873: brokerules.push('lc');
3874: }
3875: |;
3876: }
3877: if ($rules{'num'}) {
3878: $intargjs .= qq|
3879: var numRegExp = /[0-9]/;
3880: if (!numRegExp.test(currpwval)) {
3881: brokerules.push('num');
3882: }
3883: |;
3884: }
3885: if ($rules{'spec'}) {
3886: $intargjs .= q|
3887: var specRegExp = /[!"#$%&'()*+,\-.\/:;<=>?@[\\^\]_`{\|}~]/;
3888: if (!specRegExp.test(currpwval)) {
3889: brokerules.push('spec');
3890: }
3891: |;
3892: }
3893: $intargjs .= qq|
3894: if (brokerules.length > 0) {
3895: for (var i=0; i<brokerules.length; i++) {
3896: for (var j=0; j<charrules.length; j++) {
3897: if (brokerules[i] == charrules[j]) {
3898: rulesmsg += ' - '+charalerts[j]+'\\n';
3899: break;
3900: }
3901: }
3902: }
3903: }
3904: |;
3905: }
3906: $intargjs .= qq|
3907: if (rulesmsg != '') {
3908: rulesmsg = '$alertmsg'+rulesmsg;
3909: alert(rulesmsg);
3910: return false;
3911: }
3912: |;
3913: }
3914: return ($numrules,$intargjs);
3915: }
3916:
1.80 albertel 3917: ###############################################################
3918: ## Get Kerberos Defaults for Domain ##
3919: ###############################################################
3920: ##
3921: ## Returns default kerberos version and an associated argument
3922: ## as listed in file domain.tab. If not listed, provides
3923: ## appropriate default domain and kerberos version.
3924: ##
3925: #-------------------------------------------
3926:
3927: =pod
3928:
1.648 raeburn 3929: =item * &get_kerberos_defaults()
1.80 albertel 3930:
3931: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 3932: version and domain. If not found, it defaults to version 4 and the
3933: domain of the server.
1.80 albertel 3934:
1.648 raeburn 3935: =over 4
3936:
1.80 albertel 3937: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
3938:
1.648 raeburn 3939: =back
3940:
3941: =back
3942:
1.80 albertel 3943: =cut
3944:
3945: #-------------------------------------------
3946: sub get_kerberos_defaults {
3947: my $domain=shift;
1.641 raeburn 3948: my ($krbdef,$krbdefdom);
3949: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
3950: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
3951: $krbdef = $domdefaults{'auth_def'};
3952: $krbdefdom = $domdefaults{'auth_arg_def'};
3953: } else {
1.80 albertel 3954: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
3955: my $krbdefdom=$1;
3956: $krbdefdom=~tr/a-z/A-Z/;
3957: $krbdef = "krb4";
3958: }
3959: return ($krbdef,$krbdefdom);
3960: }
1.112 bowersj2 3961:
1.32 matthew 3962:
1.46 matthew 3963: ###############################################################
3964: ## Thesaurus Functions ##
3965: ###############################################################
1.20 www 3966:
1.46 matthew 3967: =pod
1.20 www 3968:
1.112 bowersj2 3969: =head1 Thesaurus Functions
3970:
3971: =over 4
3972:
1.648 raeburn 3973: =item * &initialize_keywords()
1.46 matthew 3974:
3975: Initializes the package variable %Keywords if it is empty. Uses the
3976: package variable $thesaurus_db_file.
3977:
3978: =cut
3979:
3980: ###################################################
3981:
3982: sub initialize_keywords {
3983: return 1 if (scalar keys(%Keywords));
3984: # If we are here, %Keywords is empty, so fill it up
3985: # Make sure the file we need exists...
3986: if (! -e $thesaurus_db_file) {
3987: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
3988: " failed because it does not exist");
3989: return 0;
3990: }
3991: # Set up the hash as a database
3992: my %thesaurus_db;
3993: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 3994: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 3995: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
3996: $thesaurus_db_file);
3997: return 0;
3998: }
3999: # Get the average number of appearances of a word.
4000: my $avecount = $thesaurus_db{'average.count'};
4001: # Put keywords (those that appear > average) into %Keywords
4002: while (my ($word,$data)=each (%thesaurus_db)) {
4003: my ($count,undef) = split /:/,$data;
4004: $Keywords{$word}++ if ($count > $avecount);
4005: }
4006: untie %thesaurus_db;
4007: # Remove special values from %Keywords.
1.356 albertel 4008: foreach my $value ('total.count','average.count') {
4009: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 4010: }
1.46 matthew 4011: return 1;
4012: }
4013:
4014: ###################################################
4015:
4016: =pod
4017:
1.648 raeburn 4018: =item * &keyword($word)
1.46 matthew 4019:
4020: Returns true if $word is a keyword. A keyword is a word that appears more
4021: than the average number of times in the thesaurus database. Calls
4022: &initialize_keywords
4023:
4024: =cut
4025:
4026: ###################################################
1.20 www 4027:
4028: sub keyword {
1.46 matthew 4029: return if (!&initialize_keywords());
4030: my $word=lc(shift());
4031: $word=~s/\W//g;
4032: return exists($Keywords{$word});
1.20 www 4033: }
1.46 matthew 4034:
4035: ###############################################################
4036:
4037: =pod
1.20 www 4038:
1.648 raeburn 4039: =item * &get_related_words()
1.46 matthew 4040:
1.160 matthew 4041: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 4042: an array of words. If the keyword is not in the thesaurus, an empty array
4043: will be returned. The order of the words returned is determined by the
4044: database which holds them.
4045:
4046: Uses global $thesaurus_db_file.
4047:
1.1057 foxr 4048:
1.46 matthew 4049: =cut
4050:
4051: ###############################################################
4052: sub get_related_words {
4053: my $keyword = shift;
4054: my %thesaurus_db;
4055: if (! -e $thesaurus_db_file) {
4056: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
4057: "failed because the file does not exist");
4058: return ();
4059: }
4060: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 4061: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 4062: return ();
4063: }
4064: my @Words=();
1.429 www 4065: my $count=0;
1.46 matthew 4066: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 4067: # The first element is the number of times
4068: # the word appears. We do not need it now.
1.429 www 4069: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
4070: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
4071: my $threshold=$mostfrequentcount/10;
4072: foreach my $possibleword (@RelatedWords) {
4073: my ($word,$wordcount)=split(/\,/,$possibleword);
4074: if ($wordcount>$threshold) {
4075: push(@Words,$word);
4076: $count++;
4077: if ($count>10) { last; }
4078: }
1.20 www 4079: }
4080: }
1.46 matthew 4081: untie %thesaurus_db;
4082: return @Words;
1.14 harris41 4083: }
1.1090 foxr 4084: ###############################################################
4085: #
4086: # Spell checking
4087: #
4088:
4089: =pod
4090:
1.1142 raeburn 4091: =back
4092:
1.1090 foxr 4093: =head1 Spell checking
4094:
4095: =over 4
4096:
4097: =item * &check_spelling($wordlist $language)
4098:
4099: Takes a string containing words and feeds it to an external
4100: spellcheck program via a pipeline. Returns a string containing
4101: them mis-spelled words.
4102:
4103: Parameters:
4104:
4105: =over 4
4106:
4107: =item - $wordlist
4108:
4109: String that will be fed into the spellcheck program.
4110:
4111: =item - $language
4112:
4113: Language string that specifies the language for which the spell
4114: check will be performed.
4115:
4116: =back
4117:
4118: =back
4119:
4120: Note: This sub assumes that aspell is installed.
4121:
4122:
4123: =cut
4124:
1.46 matthew 4125:
1.1090 foxr 4126: sub check_spelling {
4127: my ($wordlist, $language) = @_;
1.1091 foxr 4128: my @misspellings;
4129:
4130: # Generate the speller and set the langauge.
4131: # if explicitly selected:
1.1090 foxr 4132:
1.1091 foxr 4133: my $speller = Text::Aspell->new;
1.1090 foxr 4134: if ($language) {
1.1091 foxr 4135: $speller->set_option('lang', $language);
1.1090 foxr 4136: }
4137:
1.1091 foxr 4138: # Turn the word list into an array of words by splittingon whitespace
1.1090 foxr 4139:
1.1091 foxr 4140: my @words = split(/\s+/, $wordlist);
1.1090 foxr 4141:
1.1091 foxr 4142: foreach my $word (@words) {
4143: if(! $speller->check($word)) {
4144: push(@misspellings, $word);
1.1090 foxr 4145: }
4146: }
1.1091 foxr 4147: return join(' ', @misspellings);
4148:
1.1090 foxr 4149: }
4150:
1.61 www 4151: # -------------------------------------------------------------- Plaintext name
1.81 albertel 4152: =pod
4153:
1.112 bowersj2 4154: =head1 User Name Functions
4155:
4156: =over 4
4157:
1.648 raeburn 4158: =item * &plainname($uname,$udom,$first)
1.81 albertel 4159:
1.112 bowersj2 4160: Takes a users logon name and returns it as a string in
1.226 albertel 4161: "first middle last generation" form
4162: if $first is set to 'lastname' then it returns it as
4163: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 4164:
4165: =cut
1.61 www 4166:
1.295 www 4167:
1.81 albertel 4168: ###############################################################
1.61 www 4169: sub plainname {
1.226 albertel 4170: my ($uname,$udom,$first)=@_;
1.537 albertel 4171: return if (!defined($uname) || !defined($udom));
1.295 www 4172: my %names=&getnames($uname,$udom);
1.226 albertel 4173: my $name=&Apache::lonnet::format_name($names{'firstname'},
4174: $names{'middlename'},
4175: $names{'lastname'},
4176: $names{'generation'},$first);
4177: $name=~s/^\s+//;
1.62 www 4178: $name=~s/\s+$//;
4179: $name=~s/\s+/ /g;
1.353 albertel 4180: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 4181: return $name;
1.61 www 4182: }
1.66 www 4183:
4184: # -------------------------------------------------------------------- Nickname
1.81 albertel 4185: =pod
4186:
1.648 raeburn 4187: =item * &nickname($uname,$udom)
1.81 albertel 4188:
4189: Gets a users name and returns it as a string as
4190:
4191: ""nickname""
1.66 www 4192:
1.81 albertel 4193: if the user has a nickname or
4194:
4195: "first middle last generation"
4196:
4197: if the user does not
4198:
4199: =cut
1.66 www 4200:
4201: sub nickname {
4202: my ($uname,$udom)=@_;
1.537 albertel 4203: return if (!defined($uname) || !defined($udom));
1.295 www 4204: my %names=&getnames($uname,$udom);
1.68 albertel 4205: my $name=$names{'nickname'};
1.66 www 4206: if ($name) {
4207: $name='"'.$name.'"';
4208: } else {
4209: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
4210: $names{'lastname'}.' '.$names{'generation'};
4211: $name=~s/\s+$//;
4212: $name=~s/\s+/ /g;
4213: }
4214: return $name;
4215: }
4216:
1.295 www 4217: sub getnames {
4218: my ($uname,$udom)=@_;
1.537 albertel 4219: return if (!defined($uname) || !defined($udom));
1.433 albertel 4220: if ($udom eq 'public' && $uname eq 'public') {
4221: return ('lastname' => &mt('Public'));
4222: }
1.295 www 4223: my $id=$uname.':'.$udom;
4224: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
4225: if ($cached) {
4226: return %{$names};
4227: } else {
4228: my %loadnames=&Apache::lonnet::get('environment',
4229: ['firstname','middlename','lastname','generation','nickname'],
4230: $udom,$uname);
4231: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
4232: return %loadnames;
4233: }
4234: }
1.61 www 4235:
1.542 raeburn 4236: # -------------------------------------------------------------------- getemails
1.648 raeburn 4237:
1.542 raeburn 4238: =pod
4239:
1.648 raeburn 4240: =item * &getemails($uname,$udom)
1.542 raeburn 4241:
4242: Gets a user's email information and returns it as a hash with keys:
4243: notification, critnotification, permanentemail
4244:
4245: For notification and critnotification, values are comma-separated lists
1.648 raeburn 4246: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 4247:
1.648 raeburn 4248:
1.542 raeburn 4249: =cut
4250:
1.648 raeburn 4251:
1.466 albertel 4252: sub getemails {
4253: my ($uname,$udom)=@_;
4254: if ($udom eq 'public' && $uname eq 'public') {
4255: return;
4256: }
1.467 www 4257: if (!$udom) { $udom=$env{'user.domain'}; }
4258: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 4259: my $id=$uname.':'.$udom;
4260: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
4261: if ($cached) {
4262: return %{$names};
4263: } else {
4264: my %loadnames=&Apache::lonnet::get('environment',
4265: ['notification','critnotification',
4266: 'permanentemail'],
4267: $udom,$uname);
4268: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
4269: return %loadnames;
4270: }
4271: }
4272:
1.551 albertel 4273: sub flush_email_cache {
4274: my ($uname,$udom)=@_;
4275: if (!$udom) { $udom =$env{'user.domain'}; }
4276: if (!$uname) { $uname=$env{'user.name'}; }
4277: return if ($udom eq 'public' && $uname eq 'public');
4278: my $id=$uname.':'.$udom;
4279: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
4280: }
4281:
1.728 raeburn 4282: # -------------------------------------------------------------------- getlangs
4283:
4284: =pod
4285:
4286: =item * &getlangs($uname,$udom)
4287:
4288: Gets a user's language preference and returns it as a hash with key:
4289: language.
4290:
4291: =cut
4292:
4293:
4294: sub getlangs {
4295: my ($uname,$udom) = @_;
4296: if (!$udom) { $udom =$env{'user.domain'}; }
4297: if (!$uname) { $uname=$env{'user.name'}; }
4298: my $id=$uname.':'.$udom;
4299: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
4300: if ($cached) {
4301: return %{$langs};
4302: } else {
4303: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
4304: $udom,$uname);
4305: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
4306: return %loadlangs;
4307: }
4308: }
4309:
4310: sub flush_langs_cache {
4311: my ($uname,$udom)=@_;
4312: if (!$udom) { $udom =$env{'user.domain'}; }
4313: if (!$uname) { $uname=$env{'user.name'}; }
4314: return if ($udom eq 'public' && $uname eq 'public');
4315: my $id=$uname.':'.$udom;
4316: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
4317: }
4318:
1.61 www 4319: # ------------------------------------------------------------------ Screenname
1.81 albertel 4320:
4321: =pod
4322:
1.648 raeburn 4323: =item * &screenname($uname,$udom)
1.81 albertel 4324:
4325: Gets a users screenname and returns it as a string
4326:
4327: =cut
1.61 www 4328:
4329: sub screenname {
4330: my ($uname,$udom)=@_;
1.258 albertel 4331: if ($uname eq $env{'user.name'} &&
4332: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 4333: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 4334: return $names{'screenname'};
1.62 www 4335: }
4336:
1.212 albertel 4337:
1.802 bisitz 4338: # ------------------------------------------------------------- Confirm Wrapper
4339: =pod
4340:
1.1142 raeburn 4341: =item * &confirmwrapper($message)
1.802 bisitz 4342:
4343: Wrap messages about completion of operation in box
4344:
4345: =cut
4346:
4347: sub confirmwrapper {
4348: my ($message)=@_;
4349: if ($message) {
4350: return "\n".'<div class="LC_confirm_box">'."\n"
4351: .$message."\n"
4352: .'</div>'."\n";
4353: } else {
4354: return $message;
4355: }
4356: }
4357:
1.62 www 4358: # ------------------------------------------------------------- Message Wrapper
4359:
4360: sub messagewrapper {
1.369 www 4361: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 4362: return
1.441 albertel 4363: '<a href="/adm/email?compose=individual&'.
4364: 'recname='.$username.'&recdom='.$domain.
4365: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 4366: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 4367: }
1.802 bisitz 4368:
1.74 www 4369: # --------------------------------------------------------------- Notes Wrapper
4370:
4371: sub noteswrapper {
4372: my ($link,$un,$do)=@_;
4373: return
1.896 amueller 4374: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 4375: }
1.802 bisitz 4376:
1.62 www 4377: # ------------------------------------------------------------- Aboutme Wrapper
4378:
4379: sub aboutmewrapper {
1.1070 raeburn 4380: my ($link,$username,$domain,$target,$class)=@_;
1.447 raeburn 4381: if (!defined($username) && !defined($domain)) {
4382: return;
4383: }
1.1096 raeburn 4384: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.1070 raeburn 4385: ($target?' target="'.$target.'"':'').($class?' class="'.$class.'"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 4386: }
4387:
4388: # ------------------------------------------------------------ Syllabus Wrapper
4389:
4390: sub syllabuswrapper {
1.707 bisitz 4391: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 4392: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 4393: }
1.14 harris41 4394:
1.1397 raeburn 4395: # -----------------------------------------------------------------------------
4396:
1.1396 raeburn 4397: sub aboutme_on {
4398: my ($uname,$udom)=@_;
4399: unless ($uname) { $uname=$env{'user.name'}; }
4400: unless ($udom) { $udom=$env{'user.domain'}; }
4401: return if ($udom eq 'public' && $uname eq 'public');
4402: my $hashkey=$uname.':'.$udom;
4403: my ($aboutme,$cached)=&Apache::lonnet::is_cached_new('aboutme',$hashkey);
4404: if ($cached) {
4405: return $aboutme;
4406: }
4407: $aboutme = &Apache::lonnet::usertools_access($uname,$udom,'aboutme');
4408: &Apache::lonnet::do_cache_new('aboutme',$hashkey,$aboutme,3600);
4409: return $aboutme;
4410: }
4411:
4412: sub devalidate_aboutme_cache {
4413: my ($uname,$udom)=@_;
4414: if (!$udom) { $udom =$env{'user.domain'}; }
4415: if (!$uname) { $uname=$env{'user.name'}; }
4416: return if ($udom eq 'public' && $uname eq 'public');
4417: my $id=$uname.':'.$udom;
4418: &Apache::lonnet::devalidate_cache_new('aboutme',$id);
4419: }
4420:
1.208 matthew 4421: sub track_student_link {
1.887 raeburn 4422: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 4423: my $link ="/adm/trackstudent?";
1.208 matthew 4424: my $title = 'View recent activity';
4425: if (defined($sname) && $sname !~ /^\s*$/ &&
4426: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 4427: $link .= "selected_student=$sname:$sdom";
1.208 matthew 4428: $title .= ' of this student';
1.268 albertel 4429: }
1.208 matthew 4430: if (defined($target) && $target !~ /^\s*$/) {
4431: $target = qq{target="$target"};
4432: } else {
4433: $target = '';
4434: }
1.268 albertel 4435: if ($start) { $link.='&start='.$start; }
1.887 raeburn 4436: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 4437: $title = &mt($title);
4438: $linktext = &mt($linktext);
1.448 albertel 4439: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
4440: &help_open_topic('View_recent_activity');
1.208 matthew 4441: }
4442:
1.781 raeburn 4443: sub slot_reservations_link {
4444: my ($linktext,$sname,$sdom,$target) = @_;
4445: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
4446: my $title = 'View slot reservation history';
4447: if (defined($sname) && $sname !~ /^\s*$/ &&
4448: defined($sdom) && $sdom !~ /^\s*$/) {
4449: $link .= "&uname=$sname&udom=$sdom";
4450: $title .= ' of this student';
4451: }
4452: if (defined($target) && $target !~ /^\s*$/) {
4453: $target = qq{target="$target"};
4454: } else {
4455: $target = '';
4456: }
4457: $title = &mt($title);
4458: $linktext = &mt($linktext);
4459: return qq{<a href="$link" title="$title" $target>$linktext</a>};
4460: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
4461:
4462: }
4463:
1.508 www 4464: # ===================================================== Display a student photo
4465:
4466:
1.509 albertel 4467: sub student_image_tag {
1.508 www 4468: my ($domain,$user)=@_;
4469: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
4470: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
4471: return '<img src="'.$imgsrc.'" align="right" />';
4472: } else {
4473: return '';
4474: }
4475: }
4476:
1.112 bowersj2 4477: =pod
4478:
4479: =back
4480:
4481: =head1 Access .tab File Data
4482:
4483: =over 4
4484:
1.648 raeburn 4485: =item * &languageids()
1.112 bowersj2 4486:
4487: returns list of all language ids
4488:
4489: =cut
4490:
1.14 harris41 4491: sub languageids {
1.16 harris41 4492: return sort(keys(%language));
1.14 harris41 4493: }
4494:
1.112 bowersj2 4495: =pod
4496:
1.648 raeburn 4497: =item * &languagedescription()
1.112 bowersj2 4498:
4499: returns description of a specified language id
4500:
4501: =cut
4502:
1.14 harris41 4503: sub languagedescription {
1.125 www 4504: my $code=shift;
4505: return ($supported_language{$code}?'* ':'').
4506: $language{$code}.
1.126 www 4507: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 4508: }
4509:
1.1048 foxr 4510: =pod
4511:
4512: =item * &plainlanguagedescription
4513:
4514: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
4515: and the language character encoding (e.g. ISO) separated by a ' - ' string.
4516:
4517: =cut
4518:
1.145 www 4519: sub plainlanguagedescription {
4520: my $code=shift;
4521: return $language{$code};
4522: }
4523:
1.1048 foxr 4524: =pod
4525:
4526: =item * &supportedlanguagecode
4527:
4528: Returns the supported language code (e.g. sptutf maps to pt) given a language
4529: code.
4530:
4531: =cut
4532:
1.145 www 4533: sub supportedlanguagecode {
4534: my $code=shift;
4535: return $supported_language{$code};
1.97 www 4536: }
4537:
1.112 bowersj2 4538: =pod
4539:
1.1048 foxr 4540: =item * &latexlanguage()
4541:
4542: Given a language key code returns the correspondnig language to use
4543: to select the correct hyphenation on LaTeX printouts. This is undef if there
4544: is no supported hyphenation for the language code.
4545:
4546: =cut
4547:
4548: sub latexlanguage {
4549: my $code = shift;
4550: return $latex_language{$code};
4551: }
4552:
4553: =pod
4554:
4555: =item * &latexhyphenation()
4556:
4557: Same as above but what's supplied is the language as it might be stored
4558: in the metadata.
4559:
4560: =cut
4561:
4562: sub latexhyphenation {
4563: my $key = shift;
4564: return $latex_language_bykey{$key};
4565: }
4566:
4567: =pod
4568:
1.648 raeburn 4569: =item * ©rightids()
1.112 bowersj2 4570:
4571: returns list of all copyrights
4572:
4573: =cut
4574:
4575: sub copyrightids {
4576: return sort(keys(%cprtag));
4577: }
4578:
4579: =pod
4580:
1.648 raeburn 4581: =item * ©rightdescription()
1.112 bowersj2 4582:
4583: returns description of a specified copyright id
4584:
4585: =cut
4586:
4587: sub copyrightdescription {
1.166 www 4588: return &mt($cprtag{shift(@_)});
1.112 bowersj2 4589: }
1.197 matthew 4590:
4591: =pod
4592:
1.648 raeburn 4593: =item * &source_copyrightids()
1.192 taceyjo1 4594:
4595: returns list of all source copyrights
4596:
4597: =cut
4598:
4599: sub source_copyrightids {
4600: return sort(keys(%scprtag));
4601: }
4602:
4603: =pod
4604:
1.648 raeburn 4605: =item * &source_copyrightdescription()
1.192 taceyjo1 4606:
4607: returns description of a specified source copyright id
4608:
4609: =cut
4610:
4611: sub source_copyrightdescription {
4612: return &mt($scprtag{shift(@_)});
4613: }
1.112 bowersj2 4614:
4615: =pod
4616:
1.648 raeburn 4617: =item * &filecategories()
1.112 bowersj2 4618:
4619: returns list of all file categories
4620:
4621: =cut
4622:
4623: sub filecategories {
4624: return sort(keys(%category_extensions));
4625: }
4626:
4627: =pod
4628:
1.648 raeburn 4629: =item * &filecategorytypes()
1.112 bowersj2 4630:
4631: returns list of file types belonging to a given file
4632: category
4633:
4634: =cut
4635:
4636: sub filecategorytypes {
1.356 albertel 4637: my ($cat) = @_;
1.1248 raeburn 4638: if (ref($category_extensions{lc($cat)}) eq 'ARRAY') {
4639: return @{$category_extensions{lc($cat)}};
4640: } else {
4641: return ();
4642: }
1.112 bowersj2 4643: }
4644:
4645: =pod
4646:
1.648 raeburn 4647: =item * &fileembstyle()
1.112 bowersj2 4648:
4649: returns embedding style for a specified file type
4650:
4651: =cut
4652:
4653: sub fileembstyle {
4654: return $fe{lc(shift(@_))};
1.169 www 4655: }
4656:
1.351 www 4657: sub filemimetype {
4658: return $fm{lc(shift(@_))};
4659: }
4660:
1.169 www 4661:
4662: sub filecategoryselect {
4663: my ($name,$value)=@_;
1.189 matthew 4664: return &select_form($value,$name,
1.970 raeburn 4665: {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112 bowersj2 4666: }
4667:
4668: =pod
4669:
1.648 raeburn 4670: =item * &filedescription()
1.112 bowersj2 4671:
4672: returns description for a specified file type
4673:
4674: =cut
4675:
4676: sub filedescription {
1.188 matthew 4677: my $file_description = $fd{lc(shift())};
4678: $file_description =~ s:([\[\]]):~$1:g;
4679: return &mt($file_description);
1.112 bowersj2 4680: }
4681:
4682: =pod
4683:
1.648 raeburn 4684: =item * &filedescriptionex()
1.112 bowersj2 4685:
4686: returns description for a specified file type with
4687: extra formatting
4688:
4689: =cut
4690:
4691: sub filedescriptionex {
4692: my $ex=shift;
1.188 matthew 4693: my $file_description = $fd{lc($ex)};
4694: $file_description =~ s:([\[\]]):~$1:g;
4695: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 4696: }
4697:
4698: # End of .tab access
4699: =pod
4700:
4701: =back
4702:
4703: =cut
4704:
4705: # ------------------------------------------------------------------ File Types
4706: sub fileextensions {
4707: return sort(keys(%fe));
4708: }
4709:
1.97 www 4710: # ----------------------------------------------------------- Display Languages
4711: # returns a hash with all desired display languages
4712: #
4713:
4714: sub display_languages {
4715: my %languages=();
1.695 raeburn 4716: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 4717: $languages{$lang}=1;
1.97 www 4718: }
4719: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 4720: if ($env{'form.displaylanguage'}) {
1.356 albertel 4721: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
4722: $languages{$lang}=1;
1.97 www 4723: }
4724: }
4725: return %languages;
1.14 harris41 4726: }
4727:
1.582 albertel 4728: sub languages {
4729: my ($possible_langs) = @_;
1.695 raeburn 4730: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 4731: if (!ref($possible_langs)) {
4732: if( wantarray ) {
4733: return @preferred_langs;
4734: } else {
4735: return $preferred_langs[0];
4736: }
4737: }
4738: my %possibilities = map { $_ => 1 } (@$possible_langs);
4739: my @preferred_possibilities;
4740: foreach my $preferred_lang (@preferred_langs) {
4741: if (exists($possibilities{$preferred_lang})) {
4742: push(@preferred_possibilities, $preferred_lang);
4743: }
4744: }
4745: if( wantarray ) {
4746: return @preferred_possibilities;
4747: }
4748: return $preferred_possibilities[0];
4749: }
4750:
1.742 raeburn 4751: sub user_lang {
4752: my ($touname,$toudom,$fromcid) = @_;
4753: my @userlangs;
4754: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
4755: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
4756: $env{'course.'.$fromcid.'.languages'}));
4757: } else {
4758: my %langhash = &getlangs($touname,$toudom);
4759: if ($langhash{'languages'} ne '') {
4760: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
4761: } else {
4762: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
4763: if ($domdefs{'lang_def'} ne '') {
4764: @userlangs = ($domdefs{'lang_def'});
4765: }
4766: }
4767: }
4768: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
4769: my $user_lh = Apache::localize->get_handle(@languages);
4770: return $user_lh;
4771: }
4772:
4773:
1.112 bowersj2 4774: ###############################################################
4775: ## Student Answer Attempts ##
4776: ###############################################################
4777:
4778: =pod
4779:
4780: =head1 Alternate Problem Views
4781:
4782: =over 4
4783:
1.648 raeburn 4784: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.1199 raeburn 4785: $getattempt, $regexp, $gradesub, $usec, $identifier)
1.112 bowersj2 4786:
4787: Return string with previous attempt on problem. Arguments:
4788:
4789: =over 4
4790:
4791: =item * $symb: Problem, including path
4792:
4793: =item * $username: username of the desired student
4794:
4795: =item * $domain: domain of the desired student
1.14 harris41 4796:
1.112 bowersj2 4797: =item * $course: Course ID
1.14 harris41 4798:
1.112 bowersj2 4799: =item * $getattempt: Leave blank for all attempts, otherwise put
4800: something
1.14 harris41 4801:
1.112 bowersj2 4802: =item * $regexp: if string matches this regexp, the string will be
4803: sent to $gradesub
1.14 harris41 4804:
1.112 bowersj2 4805: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 4806:
1.1199 raeburn 4807: =item * $usec: section of the desired student
4808:
4809: =item * $identifier: counter for student (multiple students one problem) or
4810: problem (one student; whole sequence).
4811:
1.112 bowersj2 4812: =back
1.14 harris41 4813:
1.112 bowersj2 4814: The output string is a table containing all desired attempts, if any.
1.16 harris41 4815:
1.112 bowersj2 4816: =cut
1.1 albertel 4817:
4818: sub get_previous_attempt {
1.1199 raeburn 4819: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub,$usec,$identifier)=@_;
1.1 albertel 4820: my $prevattempts='';
1.43 ng 4821: no strict 'refs';
1.1 albertel 4822: if ($symb) {
1.3 albertel 4823: my (%returnhash)=
4824: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 4825: if ($returnhash{'version'}) {
4826: my %lasthash=();
4827: my $version;
4828: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1212 raeburn 4829: foreach my $key (reverse(sort(split(/\:/,$returnhash{$version.':keys'})))) {
4830: if ($key =~ /\.rawrndseed$/) {
4831: my ($id) = ($key =~ /^(.+)\.rawrndseed$/);
4832: $lasthash{$id.'.rndseed'} = $returnhash{$version.':'.$key};
4833: } else {
4834: $lasthash{$key}=$returnhash{$version.':'.$key};
4835: }
1.19 harris41 4836: }
1.1 albertel 4837: }
1.596 albertel 4838: $prevattempts=&start_data_table().&start_data_table_header_row();
4839: $prevattempts.='<th>'.&mt('History').'</th>';
1.1199 raeburn 4840: my (%typeparts,%lasthidden,%regraded,%hidestatus);
1.945 raeburn 4841: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 4842: foreach my $key (sort(keys(%lasthash))) {
4843: my ($ign,@parts) = split(/\./,$key);
1.41 ng 4844: if ($#parts > 0) {
1.31 albertel 4845: my $data=$parts[-1];
1.989 raeburn 4846: next if ($data eq 'foilorder');
1.31 albertel 4847: pop(@parts);
1.1010 www 4848: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.945 raeburn 4849: if ($data eq 'type') {
4850: unless ($showsurv) {
4851: my $id = join(',',@parts);
4852: $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978 raeburn 4853: if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
4854: $lasthidden{$ign.'.'.$id} = 1;
4855: }
1.945 raeburn 4856: }
1.1199 raeburn 4857: if ($identifier ne '') {
4858: my $id = join(',',@parts);
4859: if (&Apache::lonnet::EXT("resource.$id.problemstatus",$symb,
4860: $domain,$username,$usec,undef,$course) =~ /^no/) {
4861: $hidestatus{$ign.'.'.$id} = 1;
4862: }
4863: }
4864: } elsif ($data eq 'regrader') {
4865: if (($identifier ne '') && (@parts)) {
1.1200 raeburn 4866: my $id = join(',',@parts);
4867: $regraded{$ign.'.'.$id} = 1;
1.1199 raeburn 4868: }
1.1010 www 4869: }
1.31 albertel 4870: } else {
1.41 ng 4871: if ($#parts == 0) {
4872: $prevattempts.='<th>'.$parts[0].'</th>';
4873: } else {
4874: $prevattempts.='<th>'.$ign.'</th>';
4875: }
1.31 albertel 4876: }
1.16 harris41 4877: }
1.596 albertel 4878: $prevattempts.=&end_data_table_header_row();
1.40 ng 4879: if ($getattempt eq '') {
1.1199 raeburn 4880: my (%solved,%resets,%probstatus);
1.1200 raeburn 4881: if (($identifier ne '') && (keys(%regraded) > 0)) {
4882: for ($version=1;$version<=$returnhash{'version'};$version++) {
4883: foreach my $id (keys(%regraded)) {
4884: if (($returnhash{$version.':'.$id.'.regrader'}) &&
4885: ($returnhash{$version.':'.$id.'.tries'} eq '') &&
4886: ($returnhash{$version.':'.$id.'.award'} eq '')) {
4887: push(@{$resets{$id}},$version);
1.1199 raeburn 4888: }
4889: }
4890: }
1.1200 raeburn 4891: }
4892: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1199 raeburn 4893: my (@hidden,@unsolved);
1.945 raeburn 4894: if (%typeparts) {
4895: foreach my $id (keys(%typeparts)) {
1.1199 raeburn 4896: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') ||
4897: ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
1.945 raeburn 4898: push(@hidden,$id);
1.1199 raeburn 4899: } elsif ($identifier ne '') {
4900: unless (($returnhash{$version.':'.$id.'.type'} eq 'survey') ||
4901: ($returnhash{$version.':'.$id.'.type'} eq 'surveycred') ||
4902: ($hidestatus{$id})) {
1.1200 raeburn 4903: next if ((ref($resets{$id}) eq 'ARRAY') && grep(/^\Q$version\E$/,@{$resets{$id}}));
1.1199 raeburn 4904: if ($returnhash{$version.':'.$id.'.solved'} eq 'correct_by_student') {
4905: push(@{$solved{$id}},$version);
4906: } elsif (($returnhash{$version.':'.$id.'.solved'} ne '') &&
4907: (ref($solved{$id}) eq 'ARRAY')) {
4908: my $skip;
4909: if (ref($resets{$id}) eq 'ARRAY') {
4910: foreach my $reset (@{$resets{$id}}) {
4911: if ($reset > $solved{$id}[-1]) {
4912: $skip=1;
4913: last;
4914: }
4915: }
4916: }
4917: unless ($skip) {
4918: my ($ign,$partslist) = split(/\./,$id,2);
4919: push(@unsolved,$partslist);
4920: }
4921: }
4922: }
1.945 raeburn 4923: }
4924: }
4925: }
4926: $prevattempts.=&start_data_table_row().
1.1199 raeburn 4927: '<td>'.&mt('Transaction [_1]',$version);
4928: if (@unsolved) {
4929: $prevattempts .= '<span class="LC_nobreak"><label>'.
4930: '<input type="checkbox" name="HIDE'.$identifier.'" value="'.$version.':'.join('_',@unsolved).'" />'.
4931: &mt('Hide').'</label></span>';
4932: }
4933: $prevattempts .= '</td>';
1.945 raeburn 4934: if (@hidden) {
4935: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 4936: next if ($key =~ /\.foilorder$/);
1.945 raeburn 4937: my $hide;
4938: foreach my $id (@hidden) {
4939: if ($key =~ /^\Q$id\E/) {
4940: $hide = 1;
4941: last;
4942: }
4943: }
4944: if ($hide) {
4945: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
4946: if (($data eq 'award') || ($data eq 'awarddetail')) {
4947: my $value = &format_previous_attempt_value($key,
4948: $returnhash{$version.':'.$key});
1.1173 kruse 4949: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 4950: } else {
4951: $prevattempts.='<td> </td>';
4952: }
4953: } else {
4954: if ($key =~ /\./) {
1.1212 raeburn 4955: my $value = $returnhash{$version.':'.$key};
4956: if ($key =~ /\.rndseed$/) {
4957: my ($id) = ($key =~ /^(.+)\.[^.]+$/);
4958: if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
4959: $value = $returnhash{$version.':'.$id.'.rawrndseed'};
4960: }
4961: }
4962: $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
4963: ' </td>';
1.945 raeburn 4964: } else {
4965: $prevattempts.='<td> </td>';
4966: }
4967: }
4968: }
4969: } else {
4970: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 4971: next if ($key =~ /\.foilorder$/);
1.1212 raeburn 4972: my $value = $returnhash{$version.':'.$key};
4973: if ($key =~ /\.rndseed$/) {
4974: my ($id) = ($key =~ /^(.+)\.[^.]+$/);
4975: if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
4976: $value = $returnhash{$version.':'.$id.'.rawrndseed'};
4977: }
4978: }
4979: $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
4980: ' </td>';
1.945 raeburn 4981: }
4982: }
4983: $prevattempts.=&end_data_table_row();
1.40 ng 4984: }
1.1 albertel 4985: }
1.945 raeburn 4986: my @currhidden = keys(%lasthidden);
1.596 albertel 4987: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 4988: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 4989: next if ($key =~ /\.foilorder$/);
1.945 raeburn 4990: if (%typeparts) {
4991: my $hidden;
4992: foreach my $id (@currhidden) {
4993: if ($key =~ /^\Q$id\E/) {
4994: $hidden = 1;
4995: last;
4996: }
4997: }
4998: if ($hidden) {
4999: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
5000: if (($data eq 'award') || ($data eq 'awarddetail')) {
5001: my $value = &format_previous_attempt_value($key,$lasthash{$key});
5002: if ($key =~/$regexp$/ && (defined &$gradesub)) {
5003: $value = &$gradesub($value);
5004: }
1.1173 kruse 5005: $prevattempts.='<td>'. $value.' </td>';
1.945 raeburn 5006: } else {
5007: $prevattempts.='<td> </td>';
5008: }
5009: } else {
5010: my $value = &format_previous_attempt_value($key,$lasthash{$key});
5011: if ($key =~/$regexp$/ && (defined &$gradesub)) {
5012: $value = &$gradesub($value);
5013: }
1.1173 kruse 5014: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 5015: }
5016: } else {
5017: my $value = &format_previous_attempt_value($key,$lasthash{$key});
5018: if ($key =~/$regexp$/ && (defined &$gradesub)) {
5019: $value = &$gradesub($value);
5020: }
1.1173 kruse 5021: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 5022: }
1.16 harris41 5023: }
1.596 albertel 5024: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 5025: } else {
1.1305 raeburn 5026: my $msg;
5027: if ($symb =~ /ext\.tool$/) {
5028: $msg = &mt('No grade passed back.');
5029: } else {
5030: $msg = &mt('Nothing submitted - no attempts.');
5031: }
1.596 albertel 5032: $prevattempts=
5033: &start_data_table().&start_data_table_row().
1.1305 raeburn 5034: '<td>'.$msg.'</td>'.
1.596 albertel 5035: &end_data_table_row().&end_data_table();
1.1 albertel 5036: }
5037: } else {
1.596 albertel 5038: $prevattempts=
5039: &start_data_table().&start_data_table_row().
5040: '<td>'.&mt('No data.').'</td>'.
5041: &end_data_table_row().&end_data_table();
1.1 albertel 5042: }
1.10 albertel 5043: }
5044:
1.581 albertel 5045: sub format_previous_attempt_value {
5046: my ($key,$value) = @_;
1.1011 www 5047: if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.1173 kruse 5048: $value = &Apache::lonlocal::locallocaltime($value);
1.581 albertel 5049: } elsif (ref($value) eq 'ARRAY') {
1.1173 kruse 5050: $value = &HTML::Entities::encode('('.join(', ', @{ $value }).')','"<>&');
1.988 raeburn 5051: } elsif ($key =~ /answerstring$/) {
5052: my %answers = &Apache::lonnet::str2hash($value);
1.1173 kruse 5053: my @answer = %answers;
5054: %answers = map {&HTML::Entities::encode($_, '"<>&')} @answer;
1.988 raeburn 5055: my @anskeys = sort(keys(%answers));
5056: if (@anskeys == 1) {
5057: my $answer = $answers{$anskeys[0]};
1.1001 raeburn 5058: if ($answer =~ m{\0}) {
5059: $answer =~ s{\0}{,}g;
1.988 raeburn 5060: }
5061: my $tag_internal_answer_name = 'INTERNAL';
5062: if ($anskeys[0] eq $tag_internal_answer_name) {
5063: $value = $answer;
5064: } else {
5065: $value = $anskeys[0].'='.$answer;
5066: }
5067: } else {
5068: foreach my $ans (@anskeys) {
5069: my $answer = $answers{$ans};
1.1001 raeburn 5070: if ($answer =~ m{\0}) {
5071: $answer =~ s{\0}{,}g;
1.988 raeburn 5072: }
5073: $value .= $ans.'='.$answer.'<br />';;
5074: }
5075: }
1.581 albertel 5076: } else {
1.1173 kruse 5077: $value = &HTML::Entities::encode(&unescape($value), '"<>&');
1.581 albertel 5078: }
5079: return $value;
5080: }
5081:
5082:
1.107 albertel 5083: sub relative_to_absolute {
5084: my ($url,$output)=@_;
5085: my $parser=HTML::TokeParser->new(\$output);
5086: my $token;
5087: my $thisdir=$url;
5088: my @rlinks=();
5089: while ($token=$parser->get_token) {
5090: if ($token->[0] eq 'S') {
5091: if ($token->[1] eq 'a') {
5092: if ($token->[2]->{'href'}) {
5093: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
5094: }
5095: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
5096: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
5097: } elsif ($token->[1] eq 'base') {
5098: $thisdir=$token->[2]->{'href'};
5099: }
5100: }
5101: }
5102: $thisdir=~s-/[^/]*$--;
1.356 albertel 5103: foreach my $link (@rlinks) {
1.726 raeburn 5104: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 5105: ($link=~/^\//) ||
5106: ($link=~/^javascript:/i) ||
5107: ($link=~/^mailto:/i) ||
5108: ($link=~/^\#/)) {
5109: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
5110: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 5111: }
5112: }
5113: # -------------------------------------------------- Deal with Applet codebases
5114: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
5115: return $output;
5116: }
5117:
1.112 bowersj2 5118: =pod
5119:
1.648 raeburn 5120: =item * &get_student_view()
1.112 bowersj2 5121:
5122: show a snapshot of what student was looking at
5123:
5124: =cut
5125:
1.10 albertel 5126: sub get_student_view {
1.186 albertel 5127: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 5128: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 5129: my (%form);
1.10 albertel 5130: my @elements=('symb','courseid','domain','username');
5131: foreach my $element (@elements) {
1.186 albertel 5132: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 5133: }
1.186 albertel 5134: if (defined($moreenv)) {
5135: %form=(%form,%{$moreenv});
5136: }
1.236 albertel 5137: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 5138: $feedurl=&Apache::lonnet::clutter($feedurl);
1.1306 raeburn 5139: if (($feedurl =~ /ext\.tool$/) && ($target eq 'tex')) {
5140: $feedurl =~ s{^/adm/wrapper}{};
5141: }
1.650 www 5142: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 5143: $userview=~s/\<body[^\>]*\>//gi;
5144: $userview=~s/\<\/body\>//gi;
5145: $userview=~s/\<html\>//gi;
5146: $userview=~s/\<\/html\>//gi;
5147: $userview=~s/\<head\>//gi;
5148: $userview=~s/\<\/head\>//gi;
5149: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 5150: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 5151: if (wantarray) {
5152: return ($userview,$response);
5153: } else {
5154: return $userview;
5155: }
5156: }
5157:
5158: sub get_student_view_with_retries {
5159: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
5160:
5161: my $ok = 0; # True if we got a good response.
5162: my $content;
5163: my $response;
5164:
5165: # Try to get the student_view done. within the retries count:
5166:
5167: do {
5168: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
5169: $ok = $response->is_success;
5170: if (!$ok) {
5171: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
5172: }
5173: $retries--;
5174: } while (!$ok && ($retries > 0));
5175:
5176: if (!$ok) {
5177: $content = ''; # On error return an empty content.
5178: }
1.651 www 5179: if (wantarray) {
5180: return ($content, $response);
5181: } else {
5182: return $content;
5183: }
1.11 albertel 5184: }
5185:
1.1349 raeburn 5186: sub css_links {
5187: my ($currsymb,$level) = @_;
5188: my ($links,@symbs,%cssrefs,%httpref);
5189: if ($level eq 'map') {
5190: my $navmap = Apache::lonnavmaps::navmap->new();
5191: if (ref($navmap)) {
5192: my ($map,undef,$url)=&Apache::lonnet::decode_symb($currsymb);
5193: my @resources = $navmap->retrieveResources($map,sub { $_[0]->is_problem() },0,0);
5194: foreach my $res (@resources) {
5195: if (ref($res) && $res->symb()) {
5196: push(@symbs,$res->symb());
5197: }
5198: }
5199: }
5200: } else {
5201: @symbs = ($currsymb);
5202: }
5203: foreach my $symb (@symbs) {
5204: my $css_href = &Apache::lonnet::EXT('resource.0.cssfile',$symb);
5205: if ($css_href =~ /\S/) {
5206: unless ($css_href =~ m{https?://}) {
5207: my $url = (&Apache::lonnet::decode_symb($symb))[-1];
5208: my $proburl = &Apache::lonnet::clutter($url);
5209: my ($probdir) = ($proburl =~ m{(.+)/[^/]+$});
5210: unless ($css_href =~ m{^/}) {
5211: $css_href = &Apache::lonnet::hreflocation($probdir,$css_href);
5212: }
5213: if ($css_href =~ m{^/(res|uploaded)/}) {
5214: unless (($httpref{'httpref.'.$css_href}) ||
5215: (&Apache::lonnet::is_on_map($css_href))) {
5216: my $thisurl = $proburl;
5217: if ($env{'httpref.'.$proburl}) {
5218: $thisurl = $env{'httpref.'.$proburl};
5219: }
5220: $httpref{'httpref.'.$css_href} = $thisurl;
5221: }
5222: }
5223: }
5224: $cssrefs{$css_href} = 1;
5225: }
5226: }
5227: if (keys(%httpref)) {
5228: &Apache::lonnet::appenv(\%httpref);
5229: }
5230: if (keys(%cssrefs)) {
5231: foreach my $css_href (keys(%cssrefs)) {
5232: next unless ($css_href =~ m{^(/res/|/uploaded/|https?://)});
5233: $links .= '<link rel="stylesheet" type="text/css" href="'.$css_href.'" />'."\n";
5234: }
5235: }
5236: return $links;
5237: }
5238:
1.112 bowersj2 5239: =pod
5240:
1.648 raeburn 5241: =item * &get_student_answers()
1.112 bowersj2 5242:
5243: show a snapshot of how student was answering problem
5244:
5245: =cut
5246:
1.11 albertel 5247: sub get_student_answers {
1.100 sakharuk 5248: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 5249: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 5250: my (%moreenv);
1.11 albertel 5251: my @elements=('symb','courseid','domain','username');
5252: foreach my $element (@elements) {
1.186 albertel 5253: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 5254: }
1.186 albertel 5255: $moreenv{'grade_target'}='answer';
5256: %moreenv=(%form,%moreenv);
1.497 raeburn 5257: $feedurl = &Apache::lonnet::clutter($feedurl);
5258: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 5259: return $userview;
1.1 albertel 5260: }
1.116 albertel 5261:
5262: =pod
5263:
5264: =item * &submlink()
5265:
1.242 albertel 5266: Inputs: $text $uname $udom $symb $target
1.116 albertel 5267:
5268: Returns: A link to grades.pm such as to see the SUBM view of a student
5269:
5270: =cut
5271:
5272: ###############################################
5273: sub submlink {
1.242 albertel 5274: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 5275: if (!($uname && $udom)) {
5276: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 5277: &Apache::lonnet::whichuser($symb);
1.116 albertel 5278: if (!$symb) { $symb=$cursymb; }
5279: }
1.254 matthew 5280: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 5281: $symb=&escape($symb);
1.960 bisitz 5282: if ($target) { $target=" target=\"$target\""; }
5283: return
5284: '<a href="/adm/grades?command=submission'.
5285: '&symb='.$symb.
5286: '&student='.$uname.
5287: '&userdom='.$udom.'"'.
5288: $target.'>'.$text.'</a>';
1.242 albertel 5289: }
5290: ##############################################
5291:
5292: =pod
5293:
5294: =item * &pgrdlink()
5295:
5296: Inputs: $text $uname $udom $symb $target
5297:
5298: Returns: A link to grades.pm such as to see the PGRD view of a student
5299:
5300: =cut
5301:
5302: ###############################################
5303: sub pgrdlink {
5304: my $link=&submlink(@_);
5305: $link=~s/(&command=submission)/$1&showgrading=yes/;
5306: return $link;
5307: }
5308: ##############################################
5309:
5310: =pod
5311:
5312: =item * &pprmlink()
5313:
5314: Inputs: $text $uname $udom $symb $target
5315:
5316: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 5317: student and a specific resource
1.242 albertel 5318:
5319: =cut
5320:
5321: ###############################################
5322: sub pprmlink {
5323: my ($text,$uname,$udom,$symb,$target)=@_;
5324: if (!($uname && $udom)) {
5325: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 5326: &Apache::lonnet::whichuser($symb);
1.242 albertel 5327: if (!$symb) { $symb=$cursymb; }
5328: }
1.254 matthew 5329: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 5330: $symb=&escape($symb);
1.242 albertel 5331: if ($target) { $target="target=\"$target\""; }
1.595 albertel 5332: return '<a href="/adm/parmset?command=set&'.
5333: 'symb='.$symb.'&uname='.$uname.
5334: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 5335: }
5336: ##############################################
1.37 matthew 5337:
1.112 bowersj2 5338: =pod
5339:
5340: =back
5341:
5342: =cut
5343:
1.37 matthew 5344: ###############################################
1.51 www 5345:
5346:
5347: sub timehash {
1.687 raeburn 5348: my ($thistime) = @_;
5349: my $timezone = &Apache::lonlocal::gettimezone();
5350: my $dt = DateTime->from_epoch(epoch => $thistime)
5351: ->set_time_zone($timezone);
5352: my $wday = $dt->day_of_week();
5353: if ($wday == 7) { $wday = 0; }
5354: return ( 'second' => $dt->second(),
5355: 'minute' => $dt->minute(),
5356: 'hour' => $dt->hour(),
5357: 'day' => $dt->day_of_month(),
5358: 'month' => $dt->month(),
5359: 'year' => $dt->year(),
5360: 'weekday' => $wday,
5361: 'dayyear' => $dt->day_of_year(),
5362: 'dlsav' => $dt->is_dst() );
1.51 www 5363: }
5364:
1.370 www 5365: sub utc_string {
5366: my ($date)=@_;
1.371 www 5367: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 5368: }
5369:
1.51 www 5370: sub maketime {
5371: my %th=@_;
1.687 raeburn 5372: my ($epoch_time,$timezone,$dt);
5373: $timezone = &Apache::lonlocal::gettimezone();
5374: eval {
5375: $dt = DateTime->new( year => $th{'year'},
5376: month => $th{'month'},
5377: day => $th{'day'},
5378: hour => $th{'hour'},
5379: minute => $th{'minute'},
5380: second => $th{'second'},
5381: time_zone => $timezone,
5382: );
5383: };
5384: if (!$@) {
5385: $epoch_time = $dt->epoch;
5386: if ($epoch_time) {
5387: return $epoch_time;
5388: }
5389: }
1.51 www 5390: return POSIX::mktime(
5391: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 5392: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 5393: }
5394:
5395: #########################################
1.51 www 5396:
5397: sub findallcourses {
1.482 raeburn 5398: my ($roles,$uname,$udom) = @_;
1.355 albertel 5399: my %roles;
5400: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 5401: my %courses;
1.51 www 5402: my $now=time;
1.482 raeburn 5403: if (!defined($uname)) {
5404: $uname = $env{'user.name'};
5405: }
5406: if (!defined($udom)) {
5407: $udom = $env{'user.domain'};
5408: }
5409: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.1073 raeburn 5410: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
1.482 raeburn 5411: if (!%roles) {
5412: %roles = (
5413: cc => 1,
1.907 raeburn 5414: co => 1,
1.482 raeburn 5415: in => 1,
5416: ep => 1,
5417: ta => 1,
5418: cr => 1,
5419: st => 1,
5420: );
5421: }
5422: foreach my $entry (keys(%roleshash)) {
5423: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
5424: if ($trole =~ /^cr/) {
5425: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
5426: } else {
5427: next if (!exists($roles{$trole}));
5428: }
5429: if ($tend) {
5430: next if ($tend < $now);
5431: }
5432: if ($tstart) {
5433: next if ($tstart > $now);
5434: }
1.1058 raeburn 5435: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482 raeburn 5436: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058 raeburn 5437: my $value = $trole.'/'.$cdom.'/';
1.482 raeburn 5438: if ($secpart eq '') {
5439: ($cnum,$role) = split(/_/,$cnumpart);
5440: $sec = 'none';
1.1058 raeburn 5441: $value .= $cnum.'/';
1.482 raeburn 5442: } else {
5443: $cnum = $cnumpart;
5444: ($sec,$role) = split(/_/,$secpart);
1.1058 raeburn 5445: $value .= $cnum.'/'.$sec;
5446: }
5447: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
5448: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
5449: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
5450: }
5451: } else {
5452: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490 raeburn 5453: }
1.482 raeburn 5454: }
5455: } else {
5456: foreach my $key (keys(%env)) {
1.483 albertel 5457: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
5458: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 5459: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
5460: next if ($role eq 'ca' || $role eq 'aa');
5461: next if (%roles && !exists($roles{$role}));
5462: my ($starttime,$endtime)=split(/\./,$env{$key});
5463: my $active=1;
5464: if ($starttime) {
5465: if ($now<$starttime) { $active=0; }
5466: }
5467: if ($endtime) {
5468: if ($now>$endtime) { $active=0; }
5469: }
5470: if ($active) {
1.1058 raeburn 5471: my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482 raeburn 5472: if ($sec eq '') {
5473: $sec = 'none';
1.1058 raeburn 5474: } else {
5475: $value .= $sec;
5476: }
5477: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
5478: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
5479: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
5480: }
5481: } else {
5482: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482 raeburn 5483: }
1.474 raeburn 5484: }
5485: }
1.51 www 5486: }
5487: }
1.474 raeburn 5488: return %courses;
1.51 www 5489: }
1.37 matthew 5490:
1.54 www 5491: ###############################################
1.474 raeburn 5492:
5493: sub blockcheck {
1.1372 raeburn 5494: my ($setters,$activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
5495: unless (($activity eq 'docs') || ($activity eq 'reinit') || ($activity eq 'alert')) {
5496: my ($has_evb,$check_ipaccess);
5497: my $dom = $env{'user.domain'};
5498: if ($env{'request.course.id'}) {
5499: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
5500: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
5501: my $checkrole = "cm./$cdom/$cnum";
5502: my $sec = $env{'request.course.sec'};
5503: if ($sec ne '') {
5504: $checkrole .= "/$sec";
5505: }
5506: if ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
5507: ($env{'request.role'} !~ /^st/)) {
5508: $has_evb = 1;
5509: }
5510: unless ($has_evb) {
5511: if (($activity eq 'printout') || ($activity eq 'grades') || ($activity eq 'search') ||
5512: ($activity eq 'boards') || ($activity eq 'groups') || ($activity eq 'chat')) {
5513: if ($udom eq $cdom) {
5514: $check_ipaccess = 1;
5515: }
5516: }
5517: }
1.1375 raeburn 5518: } elsif (($activity eq 'com') || ($activity eq 'port') || ($activity eq 'blogs') ||
5519: ($activity eq 'about') || ($activity eq 'wishlist') || ($activity eq 'passwd')) {
5520: my $checkrole;
5521: if ($env{'request.role.domain'} eq '') {
5522: $checkrole = "cm./$env{'user.domain'}/";
5523: } else {
5524: $checkrole = "cm./$env{'request.role.domain'}/";
5525: }
5526: if (($checkrole) && (&Apache::lonnet::allowed('evb',undef,undef,$checkrole))) {
5527: $has_evb = 1;
5528: }
1.1372 raeburn 5529: }
5530: unless ($has_evb || $check_ipaccess) {
5531: my @machinedoms = &Apache::lonnet::current_machine_domains();
5532: if (($dom eq 'public') && ($activity eq 'port')) {
5533: $dom = $udom;
5534: }
5535: if (($dom ne '') && (grep(/^\Q$dom\E$/,@machinedoms))) {
5536: $check_ipaccess = 1;
5537: } else {
5538: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
5539: my $internet_names = &Apache::lonnet::get_internet_names($lonhost);
5540: my $prim = &Apache::lonnet::domain($dom,'primary');
5541: my $intdom = &Apache::lonnet::internet_dom($prim);
5542: if (($intdom ne '') && (ref($internet_names) eq 'ARRAY')) {
5543: if (grep(/^\Q$intdom\E$/,@{$internet_names})) {
5544: $check_ipaccess = 1;
5545: }
5546: }
5547: }
5548: }
5549: if ($check_ipaccess) {
5550: my ($ipaccessref,$cached)=&Apache::lonnet::is_cached_new('ipaccess',$dom);
5551: unless (defined($cached)) {
5552: my %domconfig =
5553: &Apache::lonnet::get_dom('configuration',['ipaccess'],$dom);
5554: $ipaccessref = &Apache::lonnet::do_cache_new('ipaccess',$dom,$domconfig{'ipaccess'},1800);
5555: }
5556: if ((ref($ipaccessref) eq 'HASH') && ($clientip)) {
5557: foreach my $id (keys(%{$ipaccessref})) {
5558: if (ref($ipaccessref->{$id}) eq 'HASH') {
5559: my $range = $ipaccessref->{$id}->{'ip'};
5560: if ($range) {
5561: if (&Apache::lonnet::ip_match($clientip,$range)) {
5562: if (ref($ipaccessref->{$id}->{'commblocks'}) eq 'HASH') {
5563: if ($ipaccessref->{$id}->{'commblocks'}->{$activity} eq 'on') {
5564: return ('','','',$id,$dom);
5565: last;
5566: }
5567: }
5568: }
5569: }
5570: }
5571: }
5572: }
5573: }
1.1373 raeburn 5574: if (($activity eq 'wishlist') || ($activity eq 'annotate')) {
5575: return ();
5576: }
1.1372 raeburn 5577: }
1.1189 raeburn 5578: if (defined($udom) && defined($uname)) {
5579: # If uname and udom are for a course, check for blocks in the course.
5580: if (($is_course) || (&Apache::lonnet::is_course($udom,$uname))) {
5581: my ($startblock,$endblock,$triggerblock) =
1.1347 raeburn 5582: &get_blocks($setters,$activity,$udom,$uname,$url,$symb,$caller);
1.1189 raeburn 5583: return ($startblock,$endblock,$triggerblock);
5584: }
5585: } else {
1.490 raeburn 5586: $udom = $env{'user.domain'};
5587: $uname = $env{'user.name'};
5588: }
5589:
1.502 raeburn 5590: my $startblock = 0;
5591: my $endblock = 0;
1.1062 raeburn 5592: my $triggerblock = '';
1.1373 raeburn 5593: my %live_courses;
5594: unless (($activity eq 'wishlist') || ($activity eq 'annotate')) {
5595: %live_courses = &findallcourses(undef,$uname,$udom);
5596: }
1.474 raeburn 5597:
1.490 raeburn 5598: # If uname is for a user, and activity is course-specific, i.e.,
5599: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 5600:
1.490 raeburn 5601: if (($activity eq 'boards' || $activity eq 'chat' ||
1.1282 raeburn 5602: $activity eq 'groups' || $activity eq 'printout' ||
1.1346 raeburn 5603: $activity eq 'search' || $activity eq 'reinit' ||
5604: $activity eq 'alert') &&
1.1189 raeburn 5605: ($env{'request.course.id'})) {
1.490 raeburn 5606: foreach my $key (keys(%live_courses)) {
5607: if ($key ne $env{'request.course.id'}) {
5608: delete($live_courses{$key});
5609: }
5610: }
5611: }
5612:
5613: my $otheruser = 0;
5614: my %own_courses;
5615: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
5616: # Resource belongs to user other than current user.
5617: $otheruser = 1;
5618: # Gather courses for current user
5619: %own_courses =
5620: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
5621: }
5622:
5623: # Gather active course roles - course coordinator, instructor,
5624: # exam proctor, ta, student, or custom role.
1.474 raeburn 5625:
5626: foreach my $course (keys(%live_courses)) {
1.482 raeburn 5627: my ($cdom,$cnum);
5628: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
5629: $cdom = $env{'course.'.$course.'.domain'};
5630: $cnum = $env{'course.'.$course.'.num'};
5631: } else {
1.490 raeburn 5632: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 5633: }
5634: my $no_ownblock = 0;
5635: my $no_userblock = 0;
1.533 raeburn 5636: if ($otheruser && $activity ne 'com') {
1.490 raeburn 5637: # Check if current user has 'evb' priv for this
5638: if (defined($own_courses{$course})) {
5639: foreach my $sec (keys(%{$own_courses{$course}})) {
5640: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
5641: if ($sec ne 'none') {
5642: $checkrole .= '/'.$sec;
5643: }
5644: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
5645: $no_ownblock = 1;
5646: last;
5647: }
5648: }
5649: }
5650: # if they have 'evb' priv and are currently not playing student
5651: next if (($no_ownblock) &&
5652: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
5653: }
1.474 raeburn 5654: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 5655: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 5656: if ($sec ne 'none') {
1.482 raeburn 5657: $checkrole .= '/'.$sec;
1.474 raeburn 5658: }
1.490 raeburn 5659: if ($otheruser) {
5660: # Resource belongs to user other than current user.
5661: # Assemble privs for that user, and check for 'evb' priv.
1.1058 raeburn 5662: my (%allroles,%userroles);
5663: if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
5664: foreach my $entry (@{$live_courses{$course}{$sec}}) {
5665: my ($trole,$tdom,$tnum,$tsec);
5666: if ($entry =~ /^cr/) {
5667: ($trole,$tdom,$tnum,$tsec) =
5668: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
5669: } else {
5670: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
5671: }
5672: my ($spec,$area,$trest);
5673: $area = '/'.$tdom.'/'.$tnum;
5674: $trest = $tnum;
5675: if ($tsec ne '') {
5676: $area .= '/'.$tsec;
5677: $trest .= '/'.$tsec;
5678: }
5679: $spec = $trole.'.'.$area;
5680: if ($trole =~ /^cr/) {
5681: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
5682: $tdom,$spec,$trest,$area);
5683: } else {
5684: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
5685: $tdom,$spec,$trest,$area);
5686: }
5687: }
1.1276 raeburn 5688: my ($author,$adv,$rar) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.1058 raeburn 5689: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
5690: if ($1) {
5691: $no_userblock = 1;
5692: last;
5693: }
1.486 raeburn 5694: }
5695: }
1.490 raeburn 5696: } else {
5697: # Resource belongs to current user
5698: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 5699: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
5700: $no_ownblock = 1;
5701: last;
5702: }
1.474 raeburn 5703: }
5704: }
5705: # if they have the evb priv and are currently not playing student
1.482 raeburn 5706: next if (($no_ownblock) &&
1.491 albertel 5707: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 5708: next if ($no_userblock);
1.474 raeburn 5709:
1.1303 raeburn 5710: # Retrieve blocking times and identity of blocker for course
1.490 raeburn 5711: # of specified user, unless user has 'evb' privilege.
1.1284 raeburn 5712:
1.1062 raeburn 5713: my ($start,$end,$trigger) =
1.1347 raeburn 5714: &get_blocks($setters,$activity,$cdom,$cnum,$url,$symb,$caller);
1.502 raeburn 5715: if (($start != 0) &&
5716: (($startblock == 0) || ($startblock > $start))) {
5717: $startblock = $start;
1.1062 raeburn 5718: if ($trigger ne '') {
5719: $triggerblock = $trigger;
5720: }
1.502 raeburn 5721: }
5722: if (($end != 0) &&
5723: (($endblock == 0) || ($endblock < $end))) {
5724: $endblock = $end;
1.1062 raeburn 5725: if ($trigger ne '') {
5726: $triggerblock = $trigger;
5727: }
1.502 raeburn 5728: }
1.490 raeburn 5729: }
1.1062 raeburn 5730: return ($startblock,$endblock,$triggerblock);
1.490 raeburn 5731: }
5732:
5733: sub get_blocks {
1.1347 raeburn 5734: my ($setters,$activity,$cdom,$cnum,$url,$symb,$caller) = @_;
1.490 raeburn 5735: my $startblock = 0;
5736: my $endblock = 0;
1.1062 raeburn 5737: my $triggerblock = '';
1.490 raeburn 5738: my $course = $cdom.'_'.$cnum;
5739: $setters->{$course} = {};
5740: $setters->{$course}{'staff'} = [];
5741: $setters->{$course}{'times'} = [];
1.1062 raeburn 5742: $setters->{$course}{'triggers'} = [];
5743: my (@blockers,%triggered);
5744: my $now = time;
5745: my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
5746: if ($activity eq 'docs') {
1.1348 raeburn 5747: my ($blocked,$nosymbcache,$noenccheck);
1.1347 raeburn 5748: if (($caller eq 'blockedaccess') || ($caller eq 'blockingstatus')) {
5749: $blocked = 1;
5750: $nosymbcache = 1;
1.1348 raeburn 5751: $noenccheck = 1;
1.1347 raeburn 5752: }
1.1348 raeburn 5753: @blockers = &Apache::lonnet::has_comm_blocking('bre',$symb,$url,$nosymbcache,$noenccheck,$blocked,\%commblocks);
1.1062 raeburn 5754: foreach my $block (@blockers) {
5755: if ($block =~ /^firstaccess____(.+)$/) {
5756: my $item = $1;
5757: my $type = 'map';
5758: my $timersymb = $item;
5759: if ($item eq 'course') {
5760: $type = 'course';
5761: } elsif ($item =~ /___\d+___/) {
5762: $type = 'resource';
5763: } else {
5764: $timersymb = &Apache::lonnet::symbread($item);
5765: }
5766: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
5767: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
5768: $triggered{$block} = {
5769: start => $start,
5770: end => $end,
5771: type => $type,
5772: };
5773: }
5774: }
5775: } else {
5776: foreach my $block (keys(%commblocks)) {
5777: if ($block =~ m/^(\d+)____(\d+)$/) {
5778: my ($start,$end) = ($1,$2);
5779: if ($start <= time && $end >= time) {
5780: if (ref($commblocks{$block}) eq 'HASH') {
5781: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
5782: if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
5783: unless(grep(/^\Q$block\E$/,@blockers)) {
5784: push(@blockers,$block);
5785: }
5786: }
5787: }
5788: }
5789: }
5790: } elsif ($block =~ /^firstaccess____(.+)$/) {
5791: my $item = $1;
5792: my $timersymb = $item;
5793: my $type = 'map';
5794: if ($item eq 'course') {
5795: $type = 'course';
5796: } elsif ($item =~ /___\d+___/) {
5797: $type = 'resource';
5798: } else {
5799: $timersymb = &Apache::lonnet::symbread($item);
5800: }
5801: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
5802: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
5803: if ($start && $end) {
5804: if (($start <= time) && ($end >= time)) {
1.1281 raeburn 5805: if (ref($commblocks{$block}) eq 'HASH') {
5806: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
5807: if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
5808: unless(grep(/^\Q$block\E$/,@blockers)) {
5809: push(@blockers,$block);
5810: $triggered{$block} = {
5811: start => $start,
5812: end => $end,
5813: type => $type,
5814: };
5815: }
5816: }
5817: }
1.1062 raeburn 5818: }
5819: }
1.490 raeburn 5820: }
1.1062 raeburn 5821: }
5822: }
5823: }
5824: foreach my $blocker (@blockers) {
5825: my ($staff_name,$staff_dom,$title,$blocks) =
5826: &parse_block_record($commblocks{$blocker});
5827: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
5828: my ($start,$end,$triggertype);
5829: if ($blocker =~ m/^(\d+)____(\d+)$/) {
5830: ($start,$end) = ($1,$2);
5831: } elsif (ref($triggered{$blocker}) eq 'HASH') {
5832: $start = $triggered{$blocker}{'start'};
5833: $end = $triggered{$blocker}{'end'};
5834: $triggertype = $triggered{$blocker}{'type'};
5835: }
5836: if ($start) {
5837: push(@{$$setters{$course}{'times'}}, [$start,$end]);
5838: if ($triggertype) {
5839: push(@{$$setters{$course}{'triggers'}},$triggertype);
5840: } else {
5841: push(@{$$setters{$course}{'triggers'}},0);
5842: }
5843: if ( ($startblock == 0) || ($startblock > $start) ) {
5844: $startblock = $start;
5845: if ($triggertype) {
5846: $triggerblock = $blocker;
1.474 raeburn 5847: }
5848: }
1.1062 raeburn 5849: if ( ($endblock == 0) || ($endblock < $end) ) {
5850: $endblock = $end;
5851: if ($triggertype) {
5852: $triggerblock = $blocker;
5853: }
5854: }
1.474 raeburn 5855: }
5856: }
1.1062 raeburn 5857: return ($startblock,$endblock,$triggerblock);
1.474 raeburn 5858: }
5859:
5860: sub parse_block_record {
5861: my ($record) = @_;
5862: my ($setuname,$setudom,$title,$blocks);
5863: if (ref($record) eq 'HASH') {
5864: ($setuname,$setudom) = split(/:/,$record->{'setter'});
5865: $title = &unescape($record->{'event'});
5866: $blocks = $record->{'blocks'};
5867: } else {
5868: my @data = split(/:/,$record,3);
5869: if (scalar(@data) eq 2) {
5870: $title = $data[1];
5871: ($setuname,$setudom) = split(/@/,$data[0]);
5872: } else {
5873: ($setuname,$setudom,$title) = @data;
5874: }
5875: $blocks = { 'com' => 'on' };
5876: }
5877: return ($setuname,$setudom,$title,$blocks);
5878: }
5879:
1.854 kalberla 5880: sub blocking_status {
1.1372 raeburn 5881: my ($activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
1.1061 raeburn 5882: my %setters;
1.890 droeschl 5883:
1.1061 raeburn 5884: # check for active blocking
1.1372 raeburn 5885: if ($clientip eq '') {
5886: $clientip = &Apache::lonnet::get_requestor_ip();
5887: }
5888: my ($startblock,$endblock,$triggerblock,$by_ip,$blockdom) =
5889: &blockcheck(\%setters,$activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller);
1.1062 raeburn 5890: my $blocked = 0;
1.1372 raeburn 5891: if (($startblock && $endblock) || ($by_ip)) {
1.1062 raeburn 5892: $blocked = 1;
5893: }
1.890 droeschl 5894:
1.1061 raeburn 5895: # caller just wants to know whether a block is active
5896: if (!wantarray) { return $blocked; }
5897:
5898: # build a link to a popup window containing the details
5899: my $querystring = "?activity=$activity";
1.1351 raeburn 5900: # $uname and $udom decide whose portfolio (or information page) the user is trying to look at
5901: if (($activity eq 'port') || ($activity eq 'about') || ($activity eq 'passwd')) {
1.1232 raeburn 5902: $querystring .= "&udom=$udom" if ($udom =~ /^$match_domain$/);
5903: $querystring .= "&uname=$uname" if ($uname =~ /^$match_username$/);
1.1062 raeburn 5904: } elsif ($activity eq 'docs') {
1.1347 raeburn 5905: my $showurl = &Apache::lonenc::check_encrypt($url);
5906: $querystring .= '&url='.&HTML::Entities::encode($showurl,'\'&"<>');
5907: if ($symb) {
5908: my $showsymb = &Apache::lonenc::check_encrypt($symb);
5909: $querystring .= '&symb='.&HTML::Entities::encode($showsymb,'\'&"<>');
5910: }
1.1062 raeburn 5911: }
1.1061 raeburn 5912:
5913: my $output .= <<'END_MYBLOCK';
5914: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
5915: var options = "width=" + w + ",height=" + h + ",";
5916: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
5917: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
5918: var newWin = window.open(url, wdwName, options);
5919: newWin.focus();
5920: }
1.890 droeschl 5921: END_MYBLOCK
1.854 kalberla 5922:
1.1061 raeburn 5923: $output = Apache::lonhtmlcommon::scripttag($output);
1.890 droeschl 5924:
1.1061 raeburn 5925: my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062 raeburn 5926: my $text = &mt('Communication Blocked');
1.1217 raeburn 5927: my $class = 'LC_comblock';
1.1062 raeburn 5928: if ($activity eq 'docs') {
5929: $text = &mt('Content Access Blocked');
1.1217 raeburn 5930: $class = '';
1.1063 raeburn 5931: } elsif ($activity eq 'printout') {
5932: $text = &mt('Printing Blocked');
1.1232 raeburn 5933: } elsif ($activity eq 'passwd') {
5934: $text = &mt('Password Changing Blocked');
1.1345 raeburn 5935: } elsif ($activity eq 'grades') {
5936: $text = &mt('Gradebook Blocked');
1.1346 raeburn 5937: } elsif ($activity eq 'search') {
5938: $text = &mt('Search Blocked');
1.1282 raeburn 5939: } elsif ($activity eq 'alert') {
5940: $text = &mt('Checking Critical Messages Blocked');
5941: } elsif ($activity eq 'reinit') {
5942: $text = &mt('Checking Course Update Blocked');
1.1351 raeburn 5943: } elsif ($activity eq 'about') {
5944: $text = &mt('Access to User Information Pages Blocked');
1.1373 raeburn 5945: } elsif ($activity eq 'wishlist') {
5946: $text = &mt('Access to Stored Links Blocked');
5947: } elsif ($activity eq 'annotate') {
5948: $text = &mt('Access to Annotations Blocked');
1.1062 raeburn 5949: }
1.1061 raeburn 5950: $output .= <<"END_BLOCK";
1.1217 raeburn 5951: <div class='$class'>
1.869 kalberla 5952: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 5953: title='$text'>
5954: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 5955: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 5956: title='$text'>$text</a>
1.867 kalberla 5957: </div>
5958:
5959: END_BLOCK
1.474 raeburn 5960:
1.1061 raeburn 5961: return ($blocked, $output);
1.854 kalberla 5962: }
1.490 raeburn 5963:
1.60 matthew 5964: ###############################################
5965:
1.682 raeburn 5966: sub check_ip_acc {
1.1201 raeburn 5967: my ($acc,$clientip)=@_;
1.682 raeburn 5968: &Apache::lonxml::debug("acc is $acc");
5969: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
5970: return 1;
5971: }
1.1339 raeburn 5972: my ($ip,$allowed);
5973: if (($ENV{'REMOTE_ADDR'} eq '127.0.0.1') ||
5974: ($ENV{'REMOTE_ADDR'} eq &Apache::lonnet::get_host_ip($Apache::lonnet::perlvar{'lonHostID'}))) {
5975: $ip = $env{'request.host'} || $ENV{'REMOTE_ADDR'} || $clientip;
5976: } else {
1.1350 raeburn 5977: my $remote_ip = &Apache::lonnet::get_requestor_ip();
5978: $ip = $remote_ip || $env{'request.host'} || $clientip;
1.1339 raeburn 5979: }
1.682 raeburn 5980:
5981: my $name;
1.1219 raeburn 5982: my %access = (
5983: allowfrom => 1,
5984: denyfrom => 0,
5985: );
5986: my @allows;
5987: my @denies;
5988: foreach my $item (split(',',$acc)) {
5989: $item =~ s/^\s*//;
5990: $item =~ s/\s*$//;
5991: my $pattern;
5992: if ($item =~ /^\!(.+)$/) {
5993: push(@denies,$1);
5994: } else {
5995: push(@allows,$item);
5996: }
5997: }
5998: my $numdenies = scalar(@denies);
5999: my $numallows = scalar(@allows);
6000: my $count = 0;
6001: foreach my $pattern (@denies,@allows) {
6002: $count ++;
6003: my $acctype = 'allowfrom';
6004: if ($count <= $numdenies) {
6005: $acctype = 'denyfrom';
6006: }
1.682 raeburn 6007: if ($pattern =~ /\*$/) {
6008: #35.8.*
6009: $pattern=~s/\*//;
1.1219 raeburn 6010: if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682 raeburn 6011: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
6012: #35.8.3.[34-56]
6013: my $low=$2;
6014: my $high=$3;
6015: $pattern=$1;
6016: if ($ip =~ /^\Q$pattern\E/) {
6017: my $last=(split(/\./,$ip))[3];
1.1219 raeburn 6018: if ($last <=$high && $last >=$low) { $allowed=$access{$acctype}; }
1.682 raeburn 6019: }
6020: } elsif ($pattern =~ /^\*/) {
6021: #*.msu.edu
6022: $pattern=~s/\*//;
6023: if (!defined($name)) {
6024: use Socket;
6025: my $netaddr=inet_aton($ip);
6026: ($name)=gethostbyaddr($netaddr,AF_INET);
6027: }
1.1219 raeburn 6028: if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
1.682 raeburn 6029: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
6030: #127.0.0.1
1.1219 raeburn 6031: if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682 raeburn 6032: } else {
6033: #some.name.com
6034: if (!defined($name)) {
6035: use Socket;
6036: my $netaddr=inet_aton($ip);
6037: ($name)=gethostbyaddr($netaddr,AF_INET);
6038: }
1.1219 raeburn 6039: if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
6040: }
6041: if ($allowed =~ /^(0|1)$/) { last; }
6042: }
6043: if ($allowed eq '') {
6044: if ($numdenies && !$numallows) {
6045: $allowed = 1;
6046: } else {
6047: $allowed = 0;
1.682 raeburn 6048: }
6049: }
6050: return $allowed;
6051: }
6052:
6053: ###############################################
6054:
1.60 matthew 6055: =pod
6056:
1.112 bowersj2 6057: =head1 Domain Template Functions
6058:
6059: =over 4
6060:
6061: =item * &determinedomain()
1.60 matthew 6062:
6063: Inputs: $domain (usually will be undef)
6064:
1.63 www 6065: Returns: Determines which domain should be used for designs
1.60 matthew 6066:
6067: =cut
1.54 www 6068:
1.60 matthew 6069: ###############################################
1.63 www 6070: sub determinedomain {
6071: my $domain=shift;
1.531 albertel 6072: if (! $domain) {
1.60 matthew 6073: # Determine domain if we have not been given one
1.893 raeburn 6074: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 6075: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
6076: if ($env{'request.role.domain'}) {
6077: $domain=$env{'request.role.domain'};
1.60 matthew 6078: }
6079: }
1.63 www 6080: return $domain;
6081: }
6082: ###############################################
1.517 raeburn 6083:
1.518 albertel 6084: sub devalidate_domconfig_cache {
6085: my ($udom)=@_;
6086: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
6087: }
6088:
6089: # ---------------------- Get domain configuration for a domain
6090: sub get_domainconf {
6091: my ($udom) = @_;
6092: my $cachetime=1800;
6093: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
6094: if (defined($cached)) { return %{$result}; }
6095:
6096: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 6097: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 6098: my (%designhash,%legacy);
1.518 albertel 6099: if (keys(%domconfig) > 0) {
6100: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 6101: if (keys(%{$domconfig{'login'}})) {
6102: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 6103: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.1208 raeburn 6104: if (($key eq 'loginvia') || ($key eq 'headtag')) {
6105: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
6106: foreach my $hostname (keys(%{$domconfig{'login'}{$key}})) {
6107: if (ref($domconfig{'login'}{$key}{$hostname}) eq 'HASH') {
6108: if ($key eq 'loginvia') {
6109: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
6110: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
6111: $designhash{$udom.'.login.loginvia'} = $server;
6112: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
6113:
6114: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
6115: } else {
6116: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
6117: }
1.948 raeburn 6118: }
1.1208 raeburn 6119: } elsif ($key eq 'headtag') {
6120: if ($domconfig{'login'}{'headtag'}{$hostname}{'url'}) {
6121: $designhash{$udom.'.login.headtag_'.$hostname} = $domconfig{'login'}{'headtag'}{$hostname}{'url'};
1.948 raeburn 6122: }
1.946 raeburn 6123: }
1.1208 raeburn 6124: if ($domconfig{'login'}{$key}{$hostname}{'exempt'}) {
6125: $designhash{$udom.'.login.'.$key.'_exempt_'.$hostname} = $domconfig{'login'}{$key}{$hostname}{'exempt'};
6126: }
1.946 raeburn 6127: }
6128: }
6129: }
1.1366 raeburn 6130: } elsif ($key eq 'saml') {
6131: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
6132: foreach my $host (keys(%{$domconfig{'login'}{$key}})) {
6133: if (ref($domconfig{'login'}{$key}{$host}) eq 'HASH') {
6134: $designhash{$udom.'.login.'.$key.'_'.$host} = 1;
1.1386 raeburn 6135: foreach my $item ('text','img','alt','url','title','window','notsso') {
1.1366 raeburn 6136: $designhash{$udom.'.login.'.$key.'_'.$item.'_'.$host} = $domconfig{'login'}{$key}{$host}{$item};
6137: }
6138: }
6139: }
6140: }
1.946 raeburn 6141: } else {
6142: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
6143: $designhash{$udom.'.login.'.$key.'_'.$img} =
6144: $domconfig{'login'}{$key}{$img};
6145: }
1.699 raeburn 6146: }
6147: } else {
6148: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
6149: }
1.632 raeburn 6150: }
6151: } else {
6152: $legacy{'login'} = 1;
1.518 albertel 6153: }
1.632 raeburn 6154: } else {
6155: $legacy{'login'} = 1;
1.518 albertel 6156: }
6157: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 6158: if (keys(%{$domconfig{'rolecolors'}})) {
6159: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
6160: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
6161: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
6162: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
6163: }
1.518 albertel 6164: }
6165: }
1.632 raeburn 6166: } else {
6167: $legacy{'rolecolors'} = 1;
1.518 albertel 6168: }
1.632 raeburn 6169: } else {
6170: $legacy{'rolecolors'} = 1;
1.518 albertel 6171: }
1.948 raeburn 6172: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
6173: if ($domconfig{'autoenroll'}{'co-owners'}) {
6174: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
6175: }
6176: }
1.632 raeburn 6177: if (keys(%legacy) > 0) {
6178: my %legacyhash = &get_legacy_domconf($udom);
6179: foreach my $item (keys(%legacyhash)) {
6180: if ($item =~ /^\Q$udom\E\.login/) {
6181: if ($legacy{'login'}) {
6182: $designhash{$item} = $legacyhash{$item};
6183: }
6184: } else {
6185: if ($legacy{'rolecolors'}) {
6186: $designhash{$item} = $legacyhash{$item};
6187: }
1.518 albertel 6188: }
6189: }
6190: }
1.632 raeburn 6191: } else {
6192: %designhash = &get_legacy_domconf($udom);
1.518 albertel 6193: }
6194: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
6195: $cachetime);
6196: return %designhash;
6197: }
6198:
1.632 raeburn 6199: sub get_legacy_domconf {
6200: my ($udom) = @_;
6201: my %legacyhash;
6202: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
6203: my $designfile = $designdir.'/'.$udom.'.tab';
6204: if (-e $designfile) {
1.1317 raeburn 6205: if ( open (my $fh,'<',$designfile) ) {
1.632 raeburn 6206: while (my $line = <$fh>) {
6207: next if ($line =~ /^\#/);
6208: chomp($line);
6209: my ($key,$val)=(split(/\=/,$line));
6210: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
6211: }
6212: close($fh);
6213: }
6214: }
1.1026 raeburn 6215: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632 raeburn 6216: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
6217: }
6218: return %legacyhash;
6219: }
6220:
1.63 www 6221: =pod
6222:
1.112 bowersj2 6223: =item * &domainlogo()
1.63 www 6224:
6225: Inputs: $domain (usually will be undef)
6226:
6227: Returns: A link to a domain logo, if the domain logo exists.
6228: If the domain logo does not exist, a description of the domain.
6229:
6230: =cut
1.112 bowersj2 6231:
1.63 www 6232: ###############################################
6233: sub domainlogo {
1.517 raeburn 6234: my $domain = &determinedomain(shift);
1.518 albertel 6235: my %designhash = &get_domainconf($domain);
1.517 raeburn 6236: # See if there is a logo
6237: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 6238: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 6239: if ($imgsrc =~ m{^/(adm|res)/}) {
6240: if ($imgsrc =~ m{^/res/}) {
6241: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
6242: &Apache::lonnet::repcopy($local_name);
6243: }
6244: $imgsrc = &lonhttpdurl($imgsrc);
1.1374 raeburn 6245: }
6246: my $alttext = $domain;
6247: if ($designhash{$domain.'.login.alttext_domlogo'} ne '') {
6248: $alttext = $designhash{$domain.'.login.alttext_domlogo'};
6249: }
6250: return '<img src="'.$imgsrc.'" alt="'.$alttext.'" id="lclogindomlogo" />';
1.514 albertel 6251: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
6252: return &Apache::lonnet::domain($domain,'description');
1.59 www 6253: } else {
1.60 matthew 6254: return '';
1.59 www 6255: }
6256: }
1.63 www 6257: ##############################################
6258:
6259: =pod
6260:
1.112 bowersj2 6261: =item * &designparm()
1.63 www 6262:
6263: Inputs: $which parameter; $domain (usually will be undef)
6264:
6265: Returns: value of designparamter $which
6266:
6267: =cut
1.112 bowersj2 6268:
1.397 albertel 6269:
1.400 albertel 6270: ##############################################
1.397 albertel 6271: sub designparm {
6272: my ($which,$domain)=@_;
6273: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 6274: return $env{'environment.color.'.$which};
1.96 www 6275: }
1.63 www 6276: $domain=&determinedomain($domain);
1.1016 raeburn 6277: my %domdesign;
6278: unless ($domain eq 'public') {
6279: %domdesign = &get_domainconf($domain);
6280: }
1.520 raeburn 6281: my $output;
1.517 raeburn 6282: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 6283: $output = $domdesign{$domain.'.'.$which};
1.63 www 6284: } else {
1.520 raeburn 6285: $output = $defaultdesign{$which};
6286: }
6287: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 6288: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 6289: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 6290: if ($output =~ m{^/res/}) {
6291: my $local_name = &Apache::lonnet::filelocation('',$output);
6292: &Apache::lonnet::repcopy($local_name);
6293: }
1.520 raeburn 6294: $output = &lonhttpdurl($output);
6295: }
1.63 www 6296: }
1.520 raeburn 6297: return $output;
1.63 www 6298: }
1.59 www 6299:
1.822 bisitz 6300: ##############################################
6301: =pod
6302:
1.832 bisitz 6303: =item * &authorspace()
6304:
1.1028 raeburn 6305: Inputs: $url (usually will be undef).
1.832 bisitz 6306:
1.1132 raeburn 6307: Returns: Path to Authoring Space containing the resource or
1.1028 raeburn 6308: directory being viewed (or for which action is being taken).
6309: If $url is provided, and begins /priv/<domain>/<uname>
6310: the path will be that portion of the $context argument.
6311: Otherwise the path will be for the author space of the current
6312: user when the current role is author, or for that of the
6313: co-author/assistant co-author space when the current role
6314: is co-author or assistant co-author.
1.832 bisitz 6315:
6316: =cut
6317:
6318: sub authorspace {
1.1028 raeburn 6319: my ($url) = @_;
6320: if ($url ne '') {
6321: if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
6322: return $1;
6323: }
6324: }
1.832 bisitz 6325: my $caname = '';
1.1024 www 6326: my $cadom = '';
1.1028 raeburn 6327: if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024 www 6328: ($cadom,$caname) =
1.832 bisitz 6329: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028 raeburn 6330: } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832 bisitz 6331: $caname = $env{'user.name'};
1.1024 www 6332: $cadom = $env{'user.domain'};
1.832 bisitz 6333: }
1.1028 raeburn 6334: if (($caname ne '') && ($cadom ne '')) {
6335: return "/priv/$cadom/$caname/";
6336: }
6337: return;
1.832 bisitz 6338: }
6339:
6340: ##############################################
6341: =pod
6342:
1.822 bisitz 6343: =item * &head_subbox()
6344:
6345: Inputs: $content (contains HTML code with page functions, etc.)
6346:
6347: Returns: HTML div with $content
6348: To be included in page header
6349:
6350: =cut
6351:
6352: sub head_subbox {
6353: my ($content)=@_;
6354: my $output =
1.993 raeburn 6355: '<div class="LC_head_subbox">'
1.822 bisitz 6356: .$content
6357: .'</div>'
6358: }
6359:
6360: ##############################################
6361: =pod
6362:
6363: =item * &CSTR_pageheader()
6364:
1.1026 raeburn 6365: Input: (optional) filename from which breadcrumb trail is built.
6366: In most cases no input as needed, as $env{'request.filename'}
6367: is appropriate for use in building the breadcrumb trail.
1.1379 raeburn 6368: frameset flag
6369: If page header is being requested for use in a frameset, then
6370: the second (option) argument -- frameset will be true, and
6371: the target attribute set for links should be target="_parent".
1.1407 ! raeburn 6372: If $title is supplied as the thitd arg, that will be used to
! 6373: the left of the breadcrumbs tail for the current path.
1.822 bisitz 6374:
6375: Returns: HTML div with CSTR path and recent box
1.1132 raeburn 6376: To be included on Authoring Space pages
1.822 bisitz 6377:
6378: =cut
6379:
6380: sub CSTR_pageheader {
1.1407 ! raeburn 6381: my ($trailfile,$frameset,$title) = @_;
1.1026 raeburn 6382: if ($trailfile eq '') {
6383: $trailfile = $env{'request.filename'};
6384: }
6385:
6386: # this is for resources; directories have customtitle, and crumbs
6387: # and select recent are created in lonpubdir.pm
6388:
6389: my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022 www 6390: my ($udom,$uname,$thisdisfn)=
1.1113 raeburn 6391: ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)(?:|/(.*))$});
1.1026 raeburn 6392: my $formaction = "/priv/$udom/$uname/$thisdisfn";
6393: $formaction =~ s{/+}{/}g;
1.822 bisitz 6394:
6395: my $parentpath = '';
6396: my $lastitem = '';
6397: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
6398: $parentpath = $1;
6399: $lastitem = $2;
6400: } else {
6401: $lastitem = $thisdisfn;
6402: }
1.921 bisitz 6403:
1.1406 raeburn 6404: my $crsauthor;
1.1246 raeburn 6405: if (($env{'request.course.id'}) &&
6406: ($env{'course.'.$env{'request.course.id'}.'.num'} eq $uname) &&
1.1247 raeburn 6407: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom)) {
1.1246 raeburn 6408: $crsauthor = 1;
1.1406 raeburn 6409: if ($title eq '') {
6410: $title = &mt('Course Authoring Space');
6411: }
6412: } elsif ($title eq '') {
1.1246 raeburn 6413: $title = &mt('Authoring Space');
6414: }
6415:
1.1379 raeburn 6416: my ($target,$crumbtarget) = (' target="_top"','_top');
6417: if ($frameset) {
6418: $target = ' target="_parent"';
6419: $crumbtarget = '_parent';
6420: } elsif (($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) {
1.1314 raeburn 6421: $target = '';
6422: $crumbtarget = '';
1.1379 raeburn 6423: } elsif (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'})) {
1.1378 raeburn 6424: $target = ' target="'.$env{'request.deeplink.target'}.'"';
6425: $crumbtarget = $env{'request.deeplink.target'};
6426: }
1.1313 raeburn 6427:
1.921 bisitz 6428: my $output =
1.1407 ! raeburn 6429: '<div>'
1.822 bisitz 6430: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
1.1246 raeburn 6431: .'<b>'.$title.'</b> '
1.1314 raeburn 6432: .'<form name="dirs" method="post" action="'.$formaction.'"'.$target.'>'
6433: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,$crumbtarget,'/priv/'.$udom,undef,undef);
1.921 bisitz 6434:
6435: if ($lastitem) {
6436: $output .=
6437: '<span class="LC_filename">'
6438: .$lastitem
6439: .'</span>';
6440: }
1.1245 raeburn 6441:
1.1246 raeburn 6442: if ($crsauthor) {
1.1379 raeburn 6443: $output .= '</form>'.&Apache::lonmenu::constspaceform($frameset);
1.1246 raeburn 6444: } else {
6445: $output .=
6446: '<br />'
1.1314 raeburn 6447: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/',$crumbtarget,'/priv','','+1',1)."</b></tt><br />"
1.1246 raeburn 6448: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
6449: .'</form>'
1.1379 raeburn 6450: .&Apache::lonmenu::constspaceform($frameset);
1.1246 raeburn 6451: }
1.1407 ! raeburn 6452: $output .= '</div>';
1.921 bisitz 6453:
6454: return $output;
1.822 bisitz 6455: }
6456:
1.60 matthew 6457: ###############################################
6458: ###############################################
6459:
6460: =pod
6461:
1.112 bowersj2 6462: =back
6463:
1.549 albertel 6464: =head1 HTML Helpers
1.112 bowersj2 6465:
6466: =over 4
6467:
6468: =item * &bodytag()
1.60 matthew 6469:
6470: Returns a uniform header for LON-CAPA web pages.
6471:
6472: Inputs:
6473:
1.112 bowersj2 6474: =over 4
6475:
6476: =item * $title, A title to be displayed on the page.
6477:
6478: =item * $function, the current role (can be undef).
6479:
6480: =item * $addentries, extra parameters for the <body> tag.
6481:
6482: =item * $bodyonly, if defined, only return the <body> tag.
6483:
6484: =item * $domain, if defined, force a given domain.
6485:
6486: =item * $forcereg, if page should register as content page (relevant for
1.86 www 6487: text interface only)
1.60 matthew 6488:
1.814 bisitz 6489: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
6490: navigational links
1.317 albertel 6491:
1.338 albertel 6492: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
6493:
1.460 albertel 6494: =item * $args, optional argument valid values are
6495: no_auto_mt_title -> prevents &mt()ing the title arg
1.1274 raeburn 6496: use_absolute -> for external resource or syllabus, this will
6497: contain https://<hostname> if server uses
6498: https (as per hosts.tab), but request is for http
6499: hostname -> hostname, from $r->hostname().
1.460 albertel 6500:
1.1096 raeburn 6501: =item * $advtoolsref, optional argument, ref to an array containing
6502: inlineremote items to be added in "Functions" menu below
6503: breadcrumbs.
6504:
1.1316 raeburn 6505: =item * $ltiscope, optional argument, will be one of: resource, map or
6506: course, if LON-CAPA is in LTI Provider context. Value is
6507: the scope of use, i.e., launch was for access to a single, a map
6508: or the entire course.
6509:
6510: =item * $ltiuri, optional argument, if LON-CAPA is in LTI Provider
6511: context, this will contain the URL for the landing item in
6512: the course, after launch from an LTI Consumer
6513:
1.1318 raeburn 6514: =item * $ltimenu, optional argument, if LON-CAPA is in LTI Provider
6515: context, this will contain a reference to hash of items
6516: to be included in the page header and/or inline menu.
6517:
1.1385 raeburn 6518: =item * $menucoll, optional argument, if specific menu collection is in
6519: effect, either set as the default for the course, or set for
6520: the deeplink paramater for $env{'request.deeplink.login'}
6521: then $menucoll will be the number of that collection.
6522:
6523: =item * $menuref, optional argument, reference to a hash, containing the
6524: menu options included for the menu in effect, based on the
6525: configuration for the numbered menu collection in use.
6526:
6527: =item * $showncrumbsref, reference to a scalar. Calls to lonmenu::innerregister
6528: within &bodytag() can result in calls to lonhtmlcommon::breadcrumbs(),
6529: if so, $showncrumbsref is set there to 1, and will propagate back
6530: via &bodytag() to &start_page(), to prevent lonhtmlcommon::breadcrumbs()
6531: being called a second time.
6532:
1.112 bowersj2 6533: =back
6534:
1.60 matthew 6535: Returns: A uniform header for LON-CAPA web pages.
6536: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
6537: If $bodyonly is undef or zero, an html string containing a <body> tag and
6538: other decorations will be returned.
6539:
6540: =cut
6541:
1.54 www 6542: sub bodytag {
1.831 bisitz 6543: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1359 raeburn 6544: $no_nav_bar,$bgcolor,$args,$advtoolsref,$ltiscope,$ltiuri,
1.1385 raeburn 6545: $ltimenu,$menucoll,$menuref,$showncrumbsref)=@_;
1.339 albertel 6546:
1.954 raeburn 6547: my $public;
6548: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
6549: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
6550: $public = 1;
6551: }
1.460 albertel 6552: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1154 raeburn 6553: my $httphost = $args->{'use_absolute'};
1.1274 raeburn 6554: my $hostname = $args->{'hostname'};
1.339 albertel 6555:
1.183 matthew 6556: $function = &get_users_function() if (!$function);
1.339 albertel 6557: my $img = &designparm($function.'.img',$domain);
6558: my $font = &designparm($function.'.font',$domain);
6559: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
6560:
1.803 bisitz 6561: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 6562: 'bgcolor' => $pgbg,
1.339 albertel 6563: 'text' => $font,
6564: 'alink' => &designparm($function.'.alink',$domain),
6565: 'vlink' => &designparm($function.'.vlink',$domain),
6566: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 6567: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 6568:
1.63 www 6569: # role and realm
1.1178 raeburn 6570: my ($role,$realm) = split(m{\./},$env{'request.role'},2);
6571: if ($realm) {
6572: $realm = '/'.$realm;
6573: }
1.1357 raeburn 6574: if ($role eq 'ca') {
1.479 albertel 6575: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 6576: $realm = &plainname($rname,$rdom);
1.378 raeburn 6577: }
1.55 www 6578: # realm
1.1357 raeburn 6579: my ($cid,$sec);
1.258 albertel 6580: if ($env{'request.course.id'}) {
1.1357 raeburn 6581: $cid = $env{'request.course.id'};
6582: if ($env{'request.course.sec'}) {
6583: $sec = $env{'request.course.sec'};
6584: }
6585: } elsif ($realm =~ m{^/($match_domain)/($match_courseid)(?:|/(\w+))$}) {
6586: if (&Apache::lonnet::is_course($1,$2)) {
6587: $cid = $1.'_'.$2;
6588: $sec = $3;
6589: }
6590: }
6591: if ($cid) {
1.378 raeburn 6592: if ($env{'request.role'} !~ /^cr/) {
6593: $role = &Apache::lonnet::plaintext($role,&course_type());
1.1257 raeburn 6594: } elsif ($role =~ m{^cr/($match_domain)/\1-domainconfig/(\w+)$}) {
1.1269 raeburn 6595: if ($env{'request.role.desc'}) {
6596: $role = $env{'request.role.desc'};
6597: } else {
6598: $role = &mt('Helpdesk[_1]',' '.$2);
6599: }
1.1257 raeburn 6600: } else {
6601: $role = (split(/\//,$role,4))[-1];
1.378 raeburn 6602: }
1.1357 raeburn 6603: if ($sec) {
6604: $role .= (' 'x2).'- '.&mt('section:').' '.$sec;
1.898 raeburn 6605: }
1.1357 raeburn 6606: $realm = $env{'course.'.$cid.'.description'};
1.378 raeburn 6607: } else {
6608: $role = &Apache::lonnet::plaintext($role);
1.54 www 6609: }
1.433 albertel 6610:
1.359 albertel 6611: if (!$realm) { $realm=' '; }
1.330 albertel 6612:
1.438 albertel 6613: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 6614:
1.101 www 6615: # construct main body tag
1.359 albertel 6616: my $bodytag = "<body $extra_body_attr>".
1.1235 raeburn 6617: &Apache::lontexconvert::init_math_support();
1.252 albertel 6618:
1.1131 raeburn 6619: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6620:
1.1130 raeburn 6621: if (($bodyonly) || ($no_nav_bar) || ($env{'form.inhibitmenu'} eq 'yes')) {
1.60 matthew 6622: return $bodytag;
1.1130 raeburn 6623: }
1.359 albertel 6624:
1.954 raeburn 6625: if ($public) {
1.433 albertel 6626: undef($role);
6627: }
1.1318 raeburn 6628:
1.1359 raeburn 6629: my $showcrstitle = 1;
1.1357 raeburn 6630: if (($cid) && ($env{'request.lti.login'})) {
1.1318 raeburn 6631: if (ref($ltimenu) eq 'HASH') {
6632: unless ($ltimenu->{'role'}) {
6633: undef($role);
6634: }
6635: unless ($ltimenu->{'coursetitle'}) {
6636: $realm=' ';
1.1359 raeburn 6637: $showcrstitle = 0;
6638: }
6639: }
6640: } elsif (($cid) && ($menucoll)) {
6641: if (ref($menuref) eq 'HASH') {
6642: unless ($menuref->{'role'}) {
6643: undef($role);
6644: }
6645: unless ($menuref->{'crs'}) {
6646: $realm=' ';
6647: $showcrstitle = 0;
1.1318 raeburn 6648: }
6649: }
6650: }
6651:
1.762 bisitz 6652: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 6653: #
6654: # Extra info if you are the DC
6655: my $dc_info = '';
1.1359 raeburn 6656: if (($env{'user.adv'}) && ($env{'request.course.id'}) && $showcrstitle &&
1.1357 raeburn 6657: (exists($env{'user.role.dc./'.$env{'course.'.$cid.'.domain'}.'/'}))) {
1.917 raeburn 6658: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 6659: $dc_info =~ s/\s+$//;
1.359 albertel 6660: }
6661:
1.1237 raeburn 6662: my $crstype;
1.1357 raeburn 6663: if ($cid) {
6664: $crstype = $env{'course.'.$cid.'.type'};
1.1237 raeburn 6665: } elsif ($args->{'crstype'}) {
6666: $crstype = $args->{'crstype'};
6667: }
6668: if (($crstype eq 'Placement') && (!$env{'request.role.adv'})) {
6669: undef($role);
6670: } else {
1.1242 raeburn 6671: $role = '<span class="LC_nobreak">('.$role.')</span>' if ($role && !$env{'browser.mobile'});
1.1237 raeburn 6672: }
1.853 droeschl 6673:
1.903 droeschl 6674: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
6675:
6676: # if ($env{'request.state'} eq 'construct') {
6677: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
6678: # }
6679:
1.1130 raeburn 6680: $bodytag .= Apache::lonhtmlcommon::scripttag(
1.1154 raeburn 6681: Apache::lonmenu::utilityfunctions($httphost), 'start');
1.359 albertel 6682:
1.1318 raeburn 6683: unless ($args->{'no_primary_menu'}) {
1.1369 raeburn 6684: my ($left,$right) = Apache::lonmenu::primary_menu($crstype,$ltimenu,$menucoll,$menuref,
1.1380 raeburn 6685: $args->{'links_disabled'},
6686: $args->{'links_target'});
1.359 albertel 6687:
1.1318 raeburn 6688: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
6689: if ($dc_info) {
6690: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
6691: }
6692: $bodytag .= qq|<div id="LC_nav_bar">$left $role<br />
6693: <em>$realm</em> $dc_info</div>|;
6694: return $bodytag;
6695: }
1.894 droeschl 6696:
1.1318 raeburn 6697: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
6698: $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
6699: }
1.916 droeschl 6700:
1.1318 raeburn 6701: $bodytag .= $right;
1.852 droeschl 6702:
1.1318 raeburn 6703: if ($dc_info) {
6704: $dc_info = &dc_courseid_toggle($dc_info);
6705: }
6706: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.917 raeburn 6707: }
1.916 droeschl 6708:
1.1169 raeburn 6709: #if directed to not display the secondary menu, don't.
1.1168 raeburn 6710: if ($args->{'no_secondary_menu'}) {
6711: return $bodytag;
6712: }
1.1169 raeburn 6713: #don't show menus for public users
1.954 raeburn 6714: if (!$public){
1.1318 raeburn 6715: unless ($args->{'no_inline_menu'}) {
6716: $bodytag .= Apache::lonmenu::secondary_menu($httphost,$ltiscope,$ltimenu,
1.1359 raeburn 6717: $args->{'no_primary_menu'},
1.1369 raeburn 6718: $menucoll,$menuref,
1.1380 raeburn 6719: $args->{'links_disabled'},
6720: $args->{'links_target'});
1.1318 raeburn 6721: }
1.903 droeschl 6722: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 6723: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
6724: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 6725: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.1385 raeburn 6726: $args->{'bread_crumbs'},'','',$hostname,
6727: $ltiscope,$ltiuri,$showncrumbsref);
1.1096 raeburn 6728: } elsif ($forcereg) {
6729: $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
1.1385 raeburn 6730: $args->{'group'},$args->{'hide_buttons'},
6731: $hostname,$ltiscope,$ltiuri,$showncrumbsref);
1.1096 raeburn 6732: } else {
6733: $bodytag .=
6734: &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
6735: $forcereg,$args->{'group'},
6736: $args->{'bread_crumbs'},
1.1274 raeburn 6737: $advtoolsref,'',$hostname);
1.920 raeburn 6738: }
1.903 droeschl 6739: }else{
6740: # this is to seperate menu from content when there's no secondary
6741: # menu. Especially needed for public accessible ressources.
6742: $bodytag .= '<hr style="clear:both" />';
6743: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 6744: }
1.903 droeschl 6745:
1.235 raeburn 6746: return $bodytag;
1.182 matthew 6747: }
6748:
1.917 raeburn 6749: sub dc_courseid_toggle {
6750: my ($dc_info) = @_;
1.980 raeburn 6751: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069 raeburn 6752: '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917 raeburn 6753: &mt('(More ...)').'</a></span>'.
6754: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
6755: }
6756:
1.330 albertel 6757: sub make_attr_string {
6758: my ($register,$attr_ref) = @_;
6759:
6760: if ($attr_ref && !ref($attr_ref)) {
6761: die("addentries Must be a hash ref ".
6762: join(':',caller(1))." ".
6763: join(':',caller(0))." ");
6764: }
6765:
6766: if ($register) {
1.339 albertel 6767: my ($on_load,$on_unload);
6768: foreach my $key (keys(%{$attr_ref})) {
6769: if (lc($key) eq 'onload') {
6770: $on_load.=$attr_ref->{$key}.';';
6771: delete($attr_ref->{$key});
6772:
6773: } elsif (lc($key) eq 'onunload') {
6774: $on_unload.=$attr_ref->{$key}.';';
6775: delete($attr_ref->{$key});
6776: }
6777: }
1.953 droeschl 6778: $attr_ref->{'onload'} = $on_load;
6779: $attr_ref->{'onunload'}= $on_unload;
1.330 albertel 6780: }
1.339 albertel 6781:
1.330 albertel 6782: my $attr_string;
1.1159 raeburn 6783: foreach my $attr (sort(keys(%$attr_ref))) {
1.330 albertel 6784: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
6785: }
6786: return $attr_string;
6787: }
6788:
6789:
1.182 matthew 6790: ###############################################
1.251 albertel 6791: ###############################################
6792:
6793: =pod
6794:
6795: =item * &endbodytag()
6796:
6797: Returns a uniform footer for LON-CAPA web pages.
6798:
1.635 raeburn 6799: Inputs: 1 - optional reference to an args hash
6800: If in the hash, key for noredirectlink has a value which evaluates to true,
6801: a 'Continue' link is not displayed if the page contains an
6802: internal redirect in the <head></head> section,
6803: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 6804:
6805: =cut
6806:
6807: sub endbodytag {
1.635 raeburn 6808: my ($args) = @_;
1.1080 raeburn 6809: my $endbodytag;
6810: unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
6811: $endbodytag='</body>';
6812: }
1.315 albertel 6813: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 6814: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
1.1386 raeburn 6815: my ($endbodyjs,$idattr);
6816: if ($env{'internal.head.to_opener'}) {
6817: my $linkid = 'LC_continue_link';
6818: $idattr = ' id="'.$linkid.'"';
6819: my $redirect_for_js = &js_escape($env{'internal.head.redirect'});
6820: $endbodyjs=<<ENDJS;
6821: <script type="text/javascript">
6822: // <![CDATA[
6823: function ebFunction(evt) {
6824: evt.preventDefault();
6825: var dest = '$redirect_for_js';
6826: if (window.opener != null && !window.opener.closed) {
6827: window.opener.location.href=dest;
6828: window.close();
6829: } else {
6830: window.location.href=dest;
6831: }
6832: return false;
6833: }
6834:
6835: \$(document).ready(function () {
6836: if (document.getElementById('$linkid')) {
6837: var clickelem = document.getElementById('$linkid');
6838: clickelem.addEventListener('click',ebFunction,false);
6839: }
6840: });
6841: // ]]>
6842: </script>
6843: ENDJS
6844: }
1.635 raeburn 6845: $endbodytag=
1.1386 raeburn 6846: "$endbodyjs<br /><a href=\"$env{'internal.head.redirect'}\"$idattr>".
1.635 raeburn 6847: &mt('Continue').'</a>'.
6848: $endbodytag;
6849: }
1.315 albertel 6850: }
1.251 albertel 6851: return $endbodytag;
6852: }
6853:
1.352 albertel 6854: =pod
6855:
6856: =item * &standard_css()
6857:
6858: Returns a style sheet
6859:
6860: Inputs: (all optional)
6861: domain -> force to color decorate a page for a specific
6862: domain
6863: function -> force usage of a specific rolish color scheme
6864: bgcolor -> override the default page bgcolor
6865:
6866: =cut
6867:
1.343 albertel 6868: sub standard_css {
1.345 albertel 6869: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 6870: $function = &get_users_function() if (!$function);
6871: my $img = &designparm($function.'.img', $domain);
6872: my $tabbg = &designparm($function.'.tabbg', $domain);
6873: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 6874: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 6875: #second colour for later usage
1.345 albertel 6876: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 6877: my $pgbg_or_bgcolor =
6878: $bgcolor ||
1.352 albertel 6879: &designparm($function.'.pgbg', $domain);
1.382 albertel 6880: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 6881: my $alink = &designparm($function.'.alink', $domain);
6882: my $vlink = &designparm($function.'.vlink', $domain);
6883: my $link = &designparm($function.'.link', $domain);
6884:
1.602 albertel 6885: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 6886: my $mono = 'monospace';
1.850 bisitz 6887: my $data_table_head = $sidebg;
6888: my $data_table_light = '#FAFAFA';
1.1060 bisitz 6889: my $data_table_dark = '#E0E0E0';
1.470 banghart 6890: my $data_table_darker = '#CCCCCC';
1.349 albertel 6891: my $data_table_highlight = '#FFFF00';
1.352 albertel 6892: my $mail_new = '#FFBB77';
6893: my $mail_new_hover = '#DD9955';
6894: my $mail_read = '#BBBB77';
6895: my $mail_read_hover = '#999944';
6896: my $mail_replied = '#AAAA88';
6897: my $mail_replied_hover = '#888855';
6898: my $mail_other = '#99BBBB';
6899: my $mail_other_hover = '#669999';
1.391 albertel 6900: my $table_header = '#DDDDDD';
1.489 raeburn 6901: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 6902: my $lg_border_color = '#C8C8C8';
1.952 onken 6903: my $button_hover = '#BF2317';
1.392 albertel 6904:
1.608 albertel 6905: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 6906: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
6907: : '0 3px 0 4px';
1.448 albertel 6908:
1.523 albertel 6909:
1.343 albertel 6910: return <<END;
1.947 droeschl 6911:
6912: /* needed for iframe to allow 100% height in FF */
6913: body, html {
6914: margin: 0;
6915: padding: 0 0.5%;
6916: height: 99%; /* to avoid scrollbars */
6917: }
6918:
1.795 www 6919: body {
1.911 bisitz 6920: font-family: $sans;
6921: line-height:130%;
6922: font-size:0.83em;
6923: color:$font;
1.795 www 6924: }
6925:
1.959 onken 6926: a:focus,
6927: a:focus img {
1.795 www 6928: color: red;
6929: }
1.698 harmsja 6930:
1.911 bisitz 6931: form, .inline {
6932: display: inline;
1.795 www 6933: }
1.721 harmsja 6934:
1.795 www 6935: .LC_right {
1.911 bisitz 6936: text-align:right;
1.795 www 6937: }
6938:
6939: .LC_middle {
1.911 bisitz 6940: vertical-align:middle;
1.795 www 6941: }
1.721 harmsja 6942:
1.1130 raeburn 6943: .LC_floatleft {
6944: float: left;
6945: }
6946:
6947: .LC_floatright {
6948: float: right;
6949: }
6950:
1.911 bisitz 6951: .LC_400Box {
6952: width:400px;
6953: }
1.721 harmsja 6954:
1.947 droeschl 6955: .LC_iframecontainer {
6956: width: 98%;
6957: margin: 0;
6958: position: fixed;
6959: top: 8.5em;
6960: bottom: 0;
6961: }
6962:
6963: .LC_iframecontainer iframe{
6964: border: none;
6965: width: 100%;
6966: height: 100%;
6967: }
6968:
1.778 bisitz 6969: .LC_filename {
6970: font-family: $mono;
6971: white-space:pre;
1.921 bisitz 6972: font-size: 120%;
1.778 bisitz 6973: }
6974:
6975: .LC_fileicon {
6976: border: none;
6977: height: 1.3em;
6978: vertical-align: text-bottom;
6979: margin-right: 0.3em;
6980: text-decoration:none;
6981: }
6982:
1.1008 www 6983: .LC_setting {
6984: text-decoration:underline;
6985: }
6986:
1.350 albertel 6987: .LC_error {
6988: color: red;
6989: }
1.795 www 6990:
1.1097 bisitz 6991: .LC_warning {
6992: color: darkorange;
6993: }
6994:
1.457 albertel 6995: .LC_diff_removed {
1.733 bisitz 6996: color: red;
1.394 albertel 6997: }
1.532 albertel 6998:
6999: .LC_info,
1.457 albertel 7000: .LC_success,
7001: .LC_diff_added {
1.350 albertel 7002: color: green;
7003: }
1.795 www 7004:
1.802 bisitz 7005: div.LC_confirm_box {
7006: background-color: #FAFAFA;
7007: border: 1px solid $lg_border_color;
7008: margin-right: 0;
7009: padding: 5px;
7010: }
7011:
7012: div.LC_confirm_box .LC_error img,
7013: div.LC_confirm_box .LC_success img {
7014: vertical-align: middle;
7015: }
7016:
1.1242 raeburn 7017: .LC_maxwidth {
7018: max-width: 100%;
7019: height: auto;
7020: }
7021:
1.1243 raeburn 7022: .LC_textsize_mobile {
7023: \@media only screen and (max-device-width: 480px) {
7024: -webkit-text-size-adjust:100%; -moz-text-size-adjust:100%; -ms-text-size-adjust:100%;
7025: }
7026: }
7027:
1.440 albertel 7028: .LC_icon {
1.771 droeschl 7029: border: none;
1.790 droeschl 7030: vertical-align: middle;
1.771 droeschl 7031: }
7032:
1.543 albertel 7033: .LC_docs_spacer {
7034: width: 25px;
7035: height: 1px;
1.771 droeschl 7036: border: none;
1.543 albertel 7037: }
1.346 albertel 7038:
1.532 albertel 7039: .LC_internal_info {
1.735 bisitz 7040: color: #999999;
1.532 albertel 7041: }
7042:
1.794 www 7043: .LC_discussion {
1.1050 www 7044: background: $data_table_dark;
1.911 bisitz 7045: border: 1px solid black;
7046: margin: 2px;
1.794 www 7047: }
7048:
7049: .LC_disc_action_left {
1.1050 www 7050: background: $sidebg;
1.911 bisitz 7051: text-align: left;
1.1050 www 7052: padding: 4px;
7053: margin: 2px;
1.794 www 7054: }
7055:
7056: .LC_disc_action_right {
1.1050 www 7057: background: $sidebg;
1.911 bisitz 7058: text-align: right;
1.1050 www 7059: padding: 4px;
7060: margin: 2px;
1.794 www 7061: }
7062:
7063: .LC_disc_new_item {
1.911 bisitz 7064: background: white;
7065: border: 2px solid red;
1.1050 www 7066: margin: 4px;
7067: padding: 4px;
1.794 www 7068: }
7069:
7070: .LC_disc_old_item {
1.911 bisitz 7071: background: white;
1.1050 www 7072: margin: 4px;
7073: padding: 4px;
1.794 www 7074: }
7075:
1.458 albertel 7076: table.LC_pastsubmission {
7077: border: 1px solid black;
7078: margin: 2px;
7079: }
7080:
1.924 bisitz 7081: table#LC_menubuttons {
1.345 albertel 7082: width: 100%;
7083: background: $pgbg;
1.392 albertel 7084: border: 2px;
1.402 albertel 7085: border-collapse: separate;
1.803 bisitz 7086: padding: 0;
1.345 albertel 7087: }
1.392 albertel 7088:
1.801 tempelho 7089: table#LC_title_bar a {
7090: color: $fontmenu;
7091: }
1.836 bisitz 7092:
1.807 droeschl 7093: table#LC_title_bar {
1.819 tempelho 7094: clear: both;
1.836 bisitz 7095: display: none;
1.807 droeschl 7096: }
7097:
1.795 www 7098: table#LC_title_bar,
1.933 droeschl 7099: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 7100: table#LC_title_bar.LC_with_remote {
1.359 albertel 7101: width: 100%;
1.392 albertel 7102: border-color: $pgbg;
7103: border-style: solid;
7104: border-width: $border;
1.379 albertel 7105: background: $pgbg;
1.801 tempelho 7106: color: $fontmenu;
1.392 albertel 7107: border-collapse: collapse;
1.803 bisitz 7108: padding: 0;
1.819 tempelho 7109: margin: 0;
1.359 albertel 7110: }
1.795 www 7111:
1.933 droeschl 7112: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 7113: margin: 0;
7114: padding: 0;
1.933 droeschl 7115: position: relative;
7116: list-style: none;
1.913 droeschl 7117: }
1.933 droeschl 7118: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 7119: display: inline;
7120: }
1.933 droeschl 7121:
7122: .LC_breadcrumb_tools_navigation {
1.913 droeschl 7123: padding: 0;
1.933 droeschl 7124: margin: 0;
7125: float: left;
1.913 droeschl 7126: }
1.933 droeschl 7127: .LC_breadcrumb_tools_tools {
7128: padding: 0;
7129: margin: 0;
1.913 droeschl 7130: float: right;
7131: }
7132:
1.1240 raeburn 7133: .LC_placement_prog {
7134: padding-right: 20px;
7135: font-weight: bold;
7136: font-size: 90%;
7137: }
7138:
1.359 albertel 7139: table#LC_title_bar td {
7140: background: $tabbg;
7141: }
1.795 www 7142:
1.911 bisitz 7143: table#LC_menubuttons img {
1.803 bisitz 7144: border: none;
1.346 albertel 7145: }
1.795 www 7146:
1.842 droeschl 7147: .LC_breadcrumbs_component {
1.911 bisitz 7148: float: right;
7149: margin: 0 1em;
1.357 albertel 7150: }
1.842 droeschl 7151: .LC_breadcrumbs_component img {
1.911 bisitz 7152: vertical-align: middle;
1.777 tempelho 7153: }
1.795 www 7154:
1.1243 raeburn 7155: .LC_breadcrumbs_hoverable {
7156: background: $sidebg;
7157: }
7158:
1.383 albertel 7159: td.LC_table_cell_checkbox {
7160: text-align: center;
7161: }
1.795 www 7162:
7163: .LC_fontsize_small {
1.911 bisitz 7164: font-size: 70%;
1.705 tempelho 7165: }
7166:
1.844 bisitz 7167: #LC_breadcrumbs {
1.911 bisitz 7168: clear:both;
7169: background: $sidebg;
7170: border-bottom: 1px solid $lg_border_color;
7171: line-height: 2.5em;
1.933 droeschl 7172: overflow: hidden;
1.911 bisitz 7173: margin: 0;
7174: padding: 0;
1.995 raeburn 7175: text-align: left;
1.819 tempelho 7176: }
1.862 bisitz 7177:
1.1098 bisitz 7178: .LC_head_subbox, .LC_actionbox {
1.911 bisitz 7179: clear:both;
7180: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 7181: border: 1px solid $sidebg;
1.1098 bisitz 7182: margin: 0 0 10px 0;
1.966 bisitz 7183: padding: 3px;
1.995 raeburn 7184: text-align: left;
1.822 bisitz 7185: }
7186:
1.795 www 7187: .LC_fontsize_medium {
1.911 bisitz 7188: font-size: 85%;
1.705 tempelho 7189: }
7190:
1.795 www 7191: .LC_fontsize_large {
1.911 bisitz 7192: font-size: 120%;
1.705 tempelho 7193: }
7194:
1.346 albertel 7195: .LC_menubuttons_inline_text {
7196: color: $font;
1.698 harmsja 7197: font-size: 90%;
1.701 harmsja 7198: padding-left:3px;
1.346 albertel 7199: }
7200:
1.934 droeschl 7201: .LC_menubuttons_inline_text img{
7202: vertical-align: middle;
7203: }
7204:
1.1051 www 7205: li.LC_menubuttons_inline_text img {
1.951 onken 7206: cursor:pointer;
1.1002 droeschl 7207: text-decoration: none;
1.951 onken 7208: }
7209:
1.526 www 7210: .LC_menubuttons_link {
7211: text-decoration: none;
7212: }
1.795 www 7213:
1.522 albertel 7214: .LC_menubuttons_category {
1.521 www 7215: color: $font;
1.526 www 7216: background: $pgbg;
1.521 www 7217: font-size: larger;
7218: font-weight: bold;
7219: }
7220:
1.346 albertel 7221: td.LC_menubuttons_text {
1.911 bisitz 7222: color: $font;
1.346 albertel 7223: }
1.706 harmsja 7224:
1.346 albertel 7225: .LC_current_location {
7226: background: $tabbg;
7227: }
1.795 www 7228:
1.1286 raeburn 7229: td.LC_zero_height {
7230: line-height: 0;
7231: cellpadding: 0;
7232: }
7233:
1.938 bisitz 7234: table.LC_data_table {
1.347 albertel 7235: border: 1px solid #000000;
1.402 albertel 7236: border-collapse: separate;
1.426 albertel 7237: border-spacing: 1px;
1.610 albertel 7238: background: $pgbg;
1.347 albertel 7239: }
1.795 www 7240:
1.422 albertel 7241: .LC_data_table_dense {
7242: font-size: small;
7243: }
1.795 www 7244:
1.507 raeburn 7245: table.LC_nested_outer {
7246: border: 1px solid #000000;
1.589 raeburn 7247: border-collapse: collapse;
1.803 bisitz 7248: border-spacing: 0;
1.507 raeburn 7249: width: 100%;
7250: }
1.795 www 7251:
1.879 raeburn 7252: table.LC_innerpickbox,
1.507 raeburn 7253: table.LC_nested {
1.803 bisitz 7254: border: none;
1.589 raeburn 7255: border-collapse: collapse;
1.803 bisitz 7256: border-spacing: 0;
1.507 raeburn 7257: width: 100%;
7258: }
1.795 www 7259:
1.911 bisitz 7260: table.LC_data_table tr th,
7261: table.LC_calendar tr th,
1.879 raeburn 7262: table.LC_prior_tries tr th,
7263: table.LC_innerpickbox tr th {
1.349 albertel 7264: font-weight: bold;
7265: background-color: $data_table_head;
1.801 tempelho 7266: color:$fontmenu;
1.701 harmsja 7267: font-size:90%;
1.347 albertel 7268: }
1.795 www 7269:
1.879 raeburn 7270: table.LC_innerpickbox tr th,
7271: table.LC_innerpickbox tr td {
7272: vertical-align: top;
7273: }
7274:
1.711 raeburn 7275: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 7276: background-color: #CCCCCC;
1.711 raeburn 7277: font-weight: bold;
7278: text-align: left;
7279: }
1.795 www 7280:
1.912 bisitz 7281: table.LC_data_table tr.LC_odd_row > td {
7282: background-color: $data_table_light;
7283: padding: 2px;
7284: vertical-align: top;
7285: }
7286:
1.809 bisitz 7287: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 7288: background-color: $data_table_light;
1.912 bisitz 7289: vertical-align: top;
7290: }
7291:
7292: table.LC_data_table tr.LC_even_row > td {
7293: background-color: $data_table_dark;
1.425 albertel 7294: padding: 2px;
1.900 bisitz 7295: vertical-align: top;
1.347 albertel 7296: }
1.795 www 7297:
1.809 bisitz 7298: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 7299: background-color: $data_table_dark;
1.900 bisitz 7300: vertical-align: top;
1.347 albertel 7301: }
1.795 www 7302:
1.425 albertel 7303: table.LC_data_table tr.LC_data_table_highlight td {
7304: background-color: $data_table_darker;
7305: }
1.795 www 7306:
1.639 raeburn 7307: table.LC_data_table tr td.LC_leftcol_header {
7308: background-color: $data_table_head;
7309: font-weight: bold;
7310: }
1.795 www 7311:
1.451 albertel 7312: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 7313: table.LC_nested tr.LC_empty_row td {
1.421 albertel 7314: font-weight: bold;
7315: font-style: italic;
7316: text-align: center;
7317: padding: 8px;
1.347 albertel 7318: }
1.795 www 7319:
1.1114 raeburn 7320: table.LC_data_table tr.LC_empty_row td,
7321: table.LC_data_table tr.LC_footer_row td {
1.940 bisitz 7322: background-color: $sidebg;
7323: }
7324:
7325: table.LC_nested tr.LC_empty_row td {
7326: background-color: #FFFFFF;
7327: }
7328:
1.890 droeschl 7329: table.LC_caption {
7330: }
7331:
1.507 raeburn 7332: table.LC_nested tr.LC_empty_row td {
1.465 albertel 7333: padding: 4ex
7334: }
1.795 www 7335:
1.507 raeburn 7336: table.LC_nested_outer tr th {
7337: font-weight: bold;
1.801 tempelho 7338: color:$fontmenu;
1.507 raeburn 7339: background-color: $data_table_head;
1.701 harmsja 7340: font-size: small;
1.507 raeburn 7341: border-bottom: 1px solid #000000;
7342: }
1.795 www 7343:
1.507 raeburn 7344: table.LC_nested_outer tr td.LC_subheader {
7345: background-color: $data_table_head;
7346: font-weight: bold;
7347: font-size: small;
7348: border-bottom: 1px solid #000000;
7349: text-align: right;
1.451 albertel 7350: }
1.795 www 7351:
1.507 raeburn 7352: table.LC_nested tr.LC_info_row td {
1.735 bisitz 7353: background-color: #CCCCCC;
1.451 albertel 7354: font-weight: bold;
7355: font-size: small;
1.507 raeburn 7356: text-align: center;
7357: }
1.795 www 7358:
1.589 raeburn 7359: table.LC_nested tr.LC_info_row td.LC_left_item,
7360: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 7361: text-align: left;
1.451 albertel 7362: }
1.795 www 7363:
1.507 raeburn 7364: table.LC_nested td {
1.735 bisitz 7365: background-color: #FFFFFF;
1.451 albertel 7366: font-size: small;
1.507 raeburn 7367: }
1.795 www 7368:
1.507 raeburn 7369: table.LC_nested_outer tr th.LC_right_item,
7370: table.LC_nested tr.LC_info_row td.LC_right_item,
7371: table.LC_nested tr.LC_odd_row td.LC_right_item,
7372: table.LC_nested tr td.LC_right_item {
1.451 albertel 7373: text-align: right;
7374: }
7375:
1.507 raeburn 7376: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 7377: background-color: #EEEEEE;
1.451 albertel 7378: }
7379:
1.473 raeburn 7380: table.LC_createuser {
7381: }
7382:
7383: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 7384: font-size: small;
1.473 raeburn 7385: }
7386:
7387: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 7388: background-color: #CCCCCC;
1.473 raeburn 7389: font-weight: bold;
7390: text-align: center;
7391: }
7392:
1.349 albertel 7393: table.LC_calendar {
7394: border: 1px solid #000000;
7395: border-collapse: collapse;
1.917 raeburn 7396: width: 98%;
1.349 albertel 7397: }
1.795 www 7398:
1.349 albertel 7399: table.LC_calendar_pickdate {
7400: font-size: xx-small;
7401: }
1.795 www 7402:
1.349 albertel 7403: table.LC_calendar tr td {
7404: border: 1px solid #000000;
7405: vertical-align: top;
1.917 raeburn 7406: width: 14%;
1.349 albertel 7407: }
1.795 www 7408:
1.349 albertel 7409: table.LC_calendar tr td.LC_calendar_day_empty {
7410: background-color: $data_table_dark;
7411: }
1.795 www 7412:
1.779 bisitz 7413: table.LC_calendar tr td.LC_calendar_day_current {
7414: background-color: $data_table_highlight;
1.777 tempelho 7415: }
1.795 www 7416:
1.938 bisitz 7417: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 7418: background-color: $mail_new;
7419: }
1.795 www 7420:
1.938 bisitz 7421: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 7422: background-color: $mail_new_hover;
7423: }
1.795 www 7424:
1.938 bisitz 7425: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 7426: background-color: $mail_read;
7427: }
1.795 www 7428:
1.938 bisitz 7429: /*
7430: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 7431: background-color: $mail_read_hover;
7432: }
1.938 bisitz 7433: */
1.795 www 7434:
1.938 bisitz 7435: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 7436: background-color: $mail_replied;
7437: }
1.795 www 7438:
1.938 bisitz 7439: /*
7440: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 7441: background-color: $mail_replied_hover;
7442: }
1.938 bisitz 7443: */
1.795 www 7444:
1.938 bisitz 7445: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 7446: background-color: $mail_other;
7447: }
1.795 www 7448:
1.938 bisitz 7449: /*
7450: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 7451: background-color: $mail_other_hover;
7452: }
1.938 bisitz 7453: */
1.494 raeburn 7454:
1.777 tempelho 7455: table.LC_data_table tr > td.LC_browser_file,
7456: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 7457: background: #AAEE77;
1.389 albertel 7458: }
1.795 www 7459:
1.777 tempelho 7460: table.LC_data_table tr > td.LC_browser_file_locked,
7461: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 7462: background: #FFAA99;
1.387 albertel 7463: }
1.795 www 7464:
1.777 tempelho 7465: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 7466: background: #888888;
1.779 bisitz 7467: }
1.795 www 7468:
1.777 tempelho 7469: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 7470: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 7471: background: #F8F866;
1.777 tempelho 7472: }
1.795 www 7473:
1.696 bisitz 7474: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 7475: background: #E0E8FF;
1.387 albertel 7476: }
1.696 bisitz 7477:
1.707 bisitz 7478: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 7479: /* background: #77FF77; */
1.707 bisitz 7480: }
1.795 www 7481:
1.707 bisitz 7482: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 7483: border-right: 8px solid #FFFF77;
1.707 bisitz 7484: }
1.795 www 7485:
1.707 bisitz 7486: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 7487: border-right: 8px solid #FFAA77;
1.707 bisitz 7488: }
1.795 www 7489:
1.707 bisitz 7490: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 7491: border-right: 8px solid #FF7777;
1.707 bisitz 7492: }
1.795 www 7493:
1.707 bisitz 7494: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 7495: border-right: 8px solid #AAFF77;
1.707 bisitz 7496: }
1.795 www 7497:
1.707 bisitz 7498: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 7499: border-right: 8px solid #11CC55;
1.707 bisitz 7500: }
7501:
1.388 albertel 7502: span.LC_current_location {
1.701 harmsja 7503: font-size:larger;
1.388 albertel 7504: background: $pgbg;
7505: }
1.387 albertel 7506:
1.1029 www 7507: span.LC_current_nav_location {
7508: font-weight:bold;
7509: background: $sidebg;
7510: }
7511:
1.395 albertel 7512: span.LC_parm_menu_item {
7513: font-size: larger;
7514: }
1.795 www 7515:
1.395 albertel 7516: span.LC_parm_scope_all {
7517: color: red;
7518: }
1.795 www 7519:
1.395 albertel 7520: span.LC_parm_scope_folder {
7521: color: green;
7522: }
1.795 www 7523:
1.395 albertel 7524: span.LC_parm_scope_resource {
7525: color: orange;
7526: }
1.795 www 7527:
1.395 albertel 7528: span.LC_parm_part {
7529: color: blue;
7530: }
1.795 www 7531:
1.911 bisitz 7532: span.LC_parm_folder,
7533: span.LC_parm_symb {
1.395 albertel 7534: font-size: x-small;
7535: font-family: $mono;
7536: color: #AAAAAA;
7537: }
7538:
1.977 bisitz 7539: ul.LC_parm_parmlist li {
7540: display: inline-block;
7541: padding: 0.3em 0.8em;
7542: vertical-align: top;
7543: width: 150px;
7544: border-top:1px solid $lg_border_color;
7545: }
7546:
1.795 www 7547: td.LC_parm_overview_level_menu,
7548: td.LC_parm_overview_map_menu,
7549: td.LC_parm_overview_parm_selectors,
7550: td.LC_parm_overview_restrictions {
1.396 albertel 7551: border: 1px solid black;
7552: border-collapse: collapse;
7553: }
1.795 www 7554:
1.1285 raeburn 7555: span.LC_parm_recursive,
7556: td.LC_parm_recursive {
7557: font-weight: bold;
7558: font-size: smaller;
7559: }
7560:
1.396 albertel 7561: table.LC_parm_overview_restrictions td {
7562: border-width: 1px 4px 1px 4px;
7563: border-style: solid;
7564: border-color: $pgbg;
7565: text-align: center;
7566: }
1.795 www 7567:
1.396 albertel 7568: table.LC_parm_overview_restrictions th {
7569: background: $tabbg;
7570: border-width: 1px 4px 1px 4px;
7571: border-style: solid;
7572: border-color: $pgbg;
7573: }
1.795 www 7574:
1.398 albertel 7575: table#LC_helpmenu {
1.803 bisitz 7576: border: none;
1.398 albertel 7577: height: 55px;
1.803 bisitz 7578: border-spacing: 0;
1.398 albertel 7579: }
7580:
7581: table#LC_helpmenu fieldset legend {
7582: font-size: larger;
7583: }
1.795 www 7584:
1.397 albertel 7585: table#LC_helpmenu_links {
7586: width: 100%;
7587: border: 1px solid black;
7588: background: $pgbg;
1.803 bisitz 7589: padding: 0;
1.397 albertel 7590: border-spacing: 1px;
7591: }
1.795 www 7592:
1.397 albertel 7593: table#LC_helpmenu_links tr td {
7594: padding: 1px;
7595: background: $tabbg;
1.399 albertel 7596: text-align: center;
7597: font-weight: bold;
1.397 albertel 7598: }
1.396 albertel 7599:
1.795 www 7600: table#LC_helpmenu_links a:link,
7601: table#LC_helpmenu_links a:visited,
1.397 albertel 7602: table#LC_helpmenu_links a:active {
7603: text-decoration: none;
7604: color: $font;
7605: }
1.795 www 7606:
1.397 albertel 7607: table#LC_helpmenu_links a:hover {
7608: text-decoration: underline;
7609: color: $vlink;
7610: }
1.396 albertel 7611:
1.417 albertel 7612: .LC_chrt_popup_exists {
7613: border: 1px solid #339933;
7614: margin: -1px;
7615: }
1.795 www 7616:
1.417 albertel 7617: .LC_chrt_popup_up {
7618: border: 1px solid yellow;
7619: margin: -1px;
7620: }
1.795 www 7621:
1.417 albertel 7622: .LC_chrt_popup {
7623: border: 1px solid #8888FF;
7624: background: #CCCCFF;
7625: }
1.795 www 7626:
1.421 albertel 7627: table.LC_pick_box {
7628: border-collapse: separate;
7629: background: white;
7630: border: 1px solid black;
7631: border-spacing: 1px;
7632: }
1.795 www 7633:
1.421 albertel 7634: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 7635: background: $sidebg;
1.421 albertel 7636: font-weight: bold;
1.900 bisitz 7637: text-align: left;
1.740 bisitz 7638: vertical-align: top;
1.421 albertel 7639: width: 184px;
7640: padding: 8px;
7641: }
1.795 www 7642:
1.579 raeburn 7643: table.LC_pick_box td.LC_pick_box_value {
7644: text-align: left;
7645: padding: 8px;
7646: }
1.795 www 7647:
1.579 raeburn 7648: table.LC_pick_box td.LC_pick_box_select {
7649: text-align: left;
7650: padding: 8px;
7651: }
1.795 www 7652:
1.424 albertel 7653: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 7654: padding: 0;
1.421 albertel 7655: height: 1px;
7656: background: black;
7657: }
1.795 www 7658:
1.421 albertel 7659: table.LC_pick_box td.LC_pick_box_submit {
7660: text-align: right;
7661: }
1.795 www 7662:
1.579 raeburn 7663: table.LC_pick_box td.LC_evenrow_value {
7664: text-align: left;
7665: padding: 8px;
7666: background-color: $data_table_light;
7667: }
1.795 www 7668:
1.579 raeburn 7669: table.LC_pick_box td.LC_oddrow_value {
7670: text-align: left;
7671: padding: 8px;
7672: background-color: $data_table_light;
7673: }
1.795 www 7674:
1.579 raeburn 7675: span.LC_helpform_receipt_cat {
7676: font-weight: bold;
7677: }
1.795 www 7678:
1.424 albertel 7679: table.LC_group_priv_box {
7680: background: white;
7681: border: 1px solid black;
7682: border-spacing: 1px;
7683: }
1.795 www 7684:
1.424 albertel 7685: table.LC_group_priv_box td.LC_pick_box_title {
7686: background: $tabbg;
7687: font-weight: bold;
7688: text-align: right;
7689: width: 184px;
7690: }
1.795 www 7691:
1.424 albertel 7692: table.LC_group_priv_box td.LC_groups_fixed {
7693: background: $data_table_light;
7694: text-align: center;
7695: }
1.795 www 7696:
1.424 albertel 7697: table.LC_group_priv_box td.LC_groups_optional {
7698: background: $data_table_dark;
7699: text-align: center;
7700: }
1.795 www 7701:
1.424 albertel 7702: table.LC_group_priv_box td.LC_groups_functionality {
7703: background: $data_table_darker;
7704: text-align: center;
7705: font-weight: bold;
7706: }
1.795 www 7707:
1.424 albertel 7708: table.LC_group_priv td {
7709: text-align: left;
1.803 bisitz 7710: padding: 0;
1.424 albertel 7711: }
7712:
7713: .LC_navbuttons {
7714: margin: 2ex 0ex 2ex 0ex;
7715: }
1.795 www 7716:
1.423 albertel 7717: .LC_topic_bar {
7718: font-weight: bold;
7719: background: $tabbg;
1.918 wenzelju 7720: margin: 1em 0em 1em 2em;
1.805 bisitz 7721: padding: 3px;
1.918 wenzelju 7722: font-size: 1.2em;
1.423 albertel 7723: }
1.795 www 7724:
1.423 albertel 7725: .LC_topic_bar span {
1.918 wenzelju 7726: left: 0.5em;
7727: position: absolute;
1.423 albertel 7728: vertical-align: middle;
1.918 wenzelju 7729: font-size: 1.2em;
1.423 albertel 7730: }
1.795 www 7731:
1.423 albertel 7732: table.LC_course_group_status {
7733: margin: 20px;
7734: }
1.795 www 7735:
1.423 albertel 7736: table.LC_status_selector td {
7737: vertical-align: top;
7738: text-align: center;
1.424 albertel 7739: padding: 4px;
7740: }
1.795 www 7741:
1.599 albertel 7742: div.LC_feedback_link {
1.616 albertel 7743: clear: both;
1.829 kalberla 7744: background: $sidebg;
1.779 bisitz 7745: width: 100%;
1.829 kalberla 7746: padding-bottom: 10px;
7747: border: 1px $tabbg solid;
1.833 kalberla 7748: height: 22px;
7749: line-height: 22px;
7750: padding-top: 5px;
7751: }
7752:
7753: div.LC_feedback_link img {
7754: height: 22px;
1.867 kalberla 7755: vertical-align:middle;
1.829 kalberla 7756: }
7757:
1.911 bisitz 7758: div.LC_feedback_link a {
1.829 kalberla 7759: text-decoration: none;
1.489 raeburn 7760: }
1.795 www 7761:
1.867 kalberla 7762: div.LC_comblock {
1.911 bisitz 7763: display:inline;
1.867 kalberla 7764: color:$font;
7765: font-size:90%;
7766: }
7767:
7768: div.LC_feedback_link div.LC_comblock {
7769: padding-left:5px;
7770: }
7771:
7772: div.LC_feedback_link div.LC_comblock a {
7773: color:$font;
7774: }
7775:
1.489 raeburn 7776: span.LC_feedback_link {
1.858 bisitz 7777: /* background: $feedback_link_bg; */
1.599 albertel 7778: font-size: larger;
7779: }
1.795 www 7780:
1.599 albertel 7781: span.LC_message_link {
1.858 bisitz 7782: /* background: $feedback_link_bg; */
1.599 albertel 7783: font-size: larger;
7784: position: absolute;
7785: right: 1em;
1.489 raeburn 7786: }
1.421 albertel 7787:
1.515 albertel 7788: table.LC_prior_tries {
1.524 albertel 7789: border: 1px solid #000000;
7790: border-collapse: separate;
7791: border-spacing: 1px;
1.515 albertel 7792: }
1.523 albertel 7793:
1.515 albertel 7794: table.LC_prior_tries td {
1.524 albertel 7795: padding: 2px;
1.515 albertel 7796: }
1.523 albertel 7797:
7798: .LC_answer_correct {
1.795 www 7799: background: lightgreen;
7800: color: darkgreen;
7801: padding: 6px;
1.523 albertel 7802: }
1.795 www 7803:
1.523 albertel 7804: .LC_answer_charged_try {
1.797 www 7805: background: #FFAAAA;
1.795 www 7806: color: darkred;
7807: padding: 6px;
1.523 albertel 7808: }
1.795 www 7809:
1.779 bisitz 7810: .LC_answer_not_charged_try,
1.523 albertel 7811: .LC_answer_no_grade,
7812: .LC_answer_late {
1.795 www 7813: background: lightyellow;
1.523 albertel 7814: color: black;
1.795 www 7815: padding: 6px;
1.523 albertel 7816: }
1.795 www 7817:
1.523 albertel 7818: .LC_answer_previous {
1.795 www 7819: background: lightblue;
7820: color: darkblue;
7821: padding: 6px;
1.523 albertel 7822: }
1.795 www 7823:
1.779 bisitz 7824: .LC_answer_no_message {
1.777 tempelho 7825: background: #FFFFFF;
7826: color: black;
1.795 www 7827: padding: 6px;
1.779 bisitz 7828: }
1.795 www 7829:
1.1334 raeburn 7830: .LC_answer_unknown,
7831: .LC_answer_warning {
1.779 bisitz 7832: background: orange;
7833: color: black;
1.795 www 7834: padding: 6px;
1.777 tempelho 7835: }
1.795 www 7836:
1.529 albertel 7837: span.LC_prior_numerical,
7838: span.LC_prior_string,
7839: span.LC_prior_custom,
7840: span.LC_prior_reaction,
7841: span.LC_prior_math {
1.925 bisitz 7842: font-family: $mono;
1.523 albertel 7843: white-space: pre;
7844: }
7845:
1.525 albertel 7846: span.LC_prior_string {
1.925 bisitz 7847: font-family: $mono;
1.525 albertel 7848: white-space: pre;
7849: }
7850:
1.523 albertel 7851: table.LC_prior_option {
7852: width: 100%;
7853: border-collapse: collapse;
7854: }
1.795 www 7855:
1.911 bisitz 7856: table.LC_prior_rank,
1.795 www 7857: table.LC_prior_match {
1.528 albertel 7858: border-collapse: collapse;
7859: }
1.795 www 7860:
1.528 albertel 7861: table.LC_prior_option tr td,
7862: table.LC_prior_rank tr td,
7863: table.LC_prior_match tr td {
1.524 albertel 7864: border: 1px solid #000000;
1.515 albertel 7865: }
7866:
1.855 bisitz 7867: .LC_nobreak {
1.544 albertel 7868: white-space: nowrap;
1.519 raeburn 7869: }
7870:
1.576 raeburn 7871: span.LC_cusr_emph {
7872: font-style: italic;
7873: }
7874:
1.633 raeburn 7875: span.LC_cusr_subheading {
7876: font-weight: normal;
7877: font-size: 85%;
7878: }
7879:
1.861 bisitz 7880: div.LC_docs_entry_move {
1.859 bisitz 7881: border: 1px solid #BBBBBB;
1.545 albertel 7882: background: #DDDDDD;
1.861 bisitz 7883: width: 22px;
1.859 bisitz 7884: padding: 1px;
7885: margin: 0;
1.545 albertel 7886: }
7887:
1.861 bisitz 7888: table.LC_data_table tr > td.LC_docs_entry_commands,
7889: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 7890: font-size: x-small;
7891: }
1.795 www 7892:
1.861 bisitz 7893: .LC_docs_entry_parameter {
7894: white-space: nowrap;
7895: }
7896:
1.544 albertel 7897: .LC_docs_copy {
1.545 albertel 7898: color: #000099;
1.544 albertel 7899: }
1.795 www 7900:
1.544 albertel 7901: .LC_docs_cut {
1.545 albertel 7902: color: #550044;
1.544 albertel 7903: }
1.795 www 7904:
1.544 albertel 7905: .LC_docs_rename {
1.545 albertel 7906: color: #009900;
1.544 albertel 7907: }
1.795 www 7908:
1.544 albertel 7909: .LC_docs_remove {
1.545 albertel 7910: color: #990000;
7911: }
7912:
1.1284 raeburn 7913: .LC_docs_alias {
7914: color: #440055;
7915: }
7916:
1.1286 raeburn 7917: .LC_domprefs_email,
1.1284 raeburn 7918: .LC_docs_alias_name,
1.547 albertel 7919: .LC_docs_reinit_warn,
7920: .LC_docs_ext_edit {
7921: font-size: x-small;
7922: }
7923:
1.545 albertel 7924: table.LC_docs_adddocs td,
7925: table.LC_docs_adddocs th {
7926: border: 1px solid #BBBBBB;
7927: padding: 4px;
7928: background: #DDDDDD;
1.543 albertel 7929: }
7930:
1.584 albertel 7931: table.LC_sty_begin {
7932: background: #BBFFBB;
7933: }
1.795 www 7934:
1.584 albertel 7935: table.LC_sty_end {
7936: background: #FFBBBB;
7937: }
7938:
1.589 raeburn 7939: table.LC_double_column {
1.803 bisitz 7940: border-width: 0;
1.589 raeburn 7941: border-collapse: collapse;
7942: width: 100%;
7943: padding: 2px;
7944: }
7945:
7946: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 7947: top: 2px;
1.589 raeburn 7948: left: 2px;
7949: width: 47%;
7950: vertical-align: top;
7951: }
7952:
7953: table.LC_double_column tr td.LC_right_col {
7954: top: 2px;
1.779 bisitz 7955: right: 2px;
1.589 raeburn 7956: width: 47%;
7957: vertical-align: top;
7958: }
7959:
1.591 raeburn 7960: div.LC_left_float {
7961: float: left;
7962: padding-right: 5%;
1.597 albertel 7963: padding-bottom: 4px;
1.591 raeburn 7964: }
7965:
7966: div.LC_clear_float_header {
1.597 albertel 7967: padding-bottom: 2px;
1.591 raeburn 7968: }
7969:
7970: div.LC_clear_float_footer {
1.597 albertel 7971: padding-top: 10px;
1.591 raeburn 7972: clear: both;
7973: }
7974:
1.597 albertel 7975: div.LC_grade_show_user {
1.941 bisitz 7976: /* border-left: 5px solid $sidebg; */
7977: border-top: 5px solid #000000;
7978: margin: 50px 0 0 0;
1.936 bisitz 7979: padding: 15px 0 5px 10px;
1.597 albertel 7980: }
1.795 www 7981:
1.936 bisitz 7982: div.LC_grade_show_user_odd_row {
1.941 bisitz 7983: /* border-left: 5px solid #000000; */
7984: }
7985:
7986: div.LC_grade_show_user div.LC_Box {
7987: margin-right: 50px;
1.597 albertel 7988: }
7989:
7990: div.LC_grade_submissions,
7991: div.LC_grade_message_center,
1.936 bisitz 7992: div.LC_grade_info_links {
1.597 albertel 7993: margin: 5px;
7994: width: 99%;
7995: background: #FFFFFF;
7996: }
1.795 www 7997:
1.597 albertel 7998: div.LC_grade_submissions_header,
1.936 bisitz 7999: div.LC_grade_message_center_header {
1.705 tempelho 8000: font-weight: bold;
8001: font-size: large;
1.597 albertel 8002: }
1.795 www 8003:
1.597 albertel 8004: div.LC_grade_submissions_body,
1.936 bisitz 8005: div.LC_grade_message_center_body {
1.597 albertel 8006: border: 1px solid black;
8007: width: 99%;
8008: background: #FFFFFF;
8009: }
1.795 www 8010:
1.613 albertel 8011: table.LC_scantron_action {
8012: width: 100%;
8013: }
1.795 www 8014:
1.613 albertel 8015: table.LC_scantron_action tr th {
1.698 harmsja 8016: font-weight:bold;
8017: font-style:normal;
1.613 albertel 8018: }
1.795 www 8019:
1.779 bisitz 8020: .LC_edit_problem_header,
1.614 albertel 8021: div.LC_edit_problem_footer {
1.705 tempelho 8022: font-weight: normal;
8023: font-size: medium;
1.602 albertel 8024: margin: 2px;
1.1060 bisitz 8025: background-color: $sidebg;
1.600 albertel 8026: }
1.795 www 8027:
1.600 albertel 8028: div.LC_edit_problem_header,
1.602 albertel 8029: div.LC_edit_problem_header div,
1.614 albertel 8030: div.LC_edit_problem_footer,
8031: div.LC_edit_problem_footer div,
1.602 albertel 8032: div.LC_edit_problem_editxml_header,
8033: div.LC_edit_problem_editxml_header div {
1.1205 golterma 8034: z-index: 100;
1.600 albertel 8035: }
1.795 www 8036:
1.600 albertel 8037: div.LC_edit_problem_header_title {
1.705 tempelho 8038: font-weight: bold;
8039: font-size: larger;
1.602 albertel 8040: background: $tabbg;
8041: padding: 3px;
1.1060 bisitz 8042: margin: 0 0 5px 0;
1.602 albertel 8043: }
1.795 www 8044:
1.602 albertel 8045: table.LC_edit_problem_header_title {
8046: width: 100%;
1.600 albertel 8047: background: $tabbg;
1.602 albertel 8048: }
8049:
1.1205 golterma 8050: div.LC_edit_actionbar {
8051: background-color: $sidebg;
1.1218 droeschl 8052: margin: 0;
8053: padding: 0;
8054: line-height: 200%;
1.602 albertel 8055: }
1.795 www 8056:
1.1218 droeschl 8057: div.LC_edit_actionbar div{
8058: padding: 0;
8059: margin: 0;
8060: display: inline-block;
1.600 albertel 8061: }
1.795 www 8062:
1.1124 bisitz 8063: .LC_edit_opt {
8064: padding-left: 1em;
8065: white-space: nowrap;
8066: }
8067:
1.1152 golterma 8068: .LC_edit_problem_latexhelper{
8069: text-align: right;
8070: }
8071:
8072: #LC_edit_problem_colorful div{
8073: margin-left: 40px;
8074: }
8075:
1.1205 golterma 8076: #LC_edit_problem_codemirror div{
8077: margin-left: 0px;
8078: }
8079:
1.911 bisitz 8080: img.stift {
1.803 bisitz 8081: border-width: 0;
8082: vertical-align: middle;
1.677 riegler 8083: }
1.680 riegler 8084:
1.923 bisitz 8085: table td.LC_mainmenu_col_fieldset {
1.680 riegler 8086: vertical-align: top;
1.777 tempelho 8087: }
1.795 www 8088:
1.716 raeburn 8089: div.LC_createcourse {
1.911 bisitz 8090: margin: 10px 10px 10px 10px;
1.716 raeburn 8091: }
8092:
1.917 raeburn 8093: .LC_dccid {
1.1130 raeburn 8094: float: right;
1.917 raeburn 8095: margin: 0.2em 0 0 0;
8096: padding: 0;
8097: font-size: 90%;
8098: display:none;
8099: }
8100:
1.897 wenzelju 8101: ol.LC_primary_menu a:hover,
1.721 harmsja 8102: ol#LC_MenuBreadcrumbs a:hover,
8103: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 8104: ul#LC_secondary_menu a:hover,
1.721 harmsja 8105: .LC_FormSectionClearButton input:hover
1.795 www 8106: ul.LC_TabContent li:hover a {
1.952 onken 8107: color:$button_hover;
1.911 bisitz 8108: text-decoration:none;
1.693 droeschl 8109: }
8110:
1.779 bisitz 8111: h1 {
1.911 bisitz 8112: padding: 0;
8113: line-height:130%;
1.693 droeschl 8114: }
1.698 harmsja 8115:
1.911 bisitz 8116: h2,
8117: h3,
8118: h4,
8119: h5,
8120: h6 {
8121: margin: 5px 0 5px 0;
8122: padding: 0;
8123: line-height:130%;
1.693 droeschl 8124: }
1.795 www 8125:
8126: .LC_hcell {
1.911 bisitz 8127: padding:3px 15px 3px 15px;
8128: margin: 0;
8129: background-color:$tabbg;
8130: color:$fontmenu;
8131: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 8132: }
1.795 www 8133:
1.840 bisitz 8134: .LC_Box > .LC_hcell {
1.911 bisitz 8135: margin: 0 -10px 10px -10px;
1.835 bisitz 8136: }
8137:
1.721 harmsja 8138: .LC_noBorder {
1.911 bisitz 8139: border: 0;
1.698 harmsja 8140: }
1.693 droeschl 8141:
1.721 harmsja 8142: .LC_FormSectionClearButton input {
1.911 bisitz 8143: background-color:transparent;
8144: border: none;
8145: cursor:pointer;
8146: text-decoration:underline;
1.693 droeschl 8147: }
1.763 bisitz 8148:
8149: .LC_help_open_topic {
1.911 bisitz 8150: color: #FFFFFF;
8151: background-color: #EEEEFF;
8152: margin: 1px;
8153: padding: 4px;
8154: border: 1px solid #000033;
8155: white-space: nowrap;
8156: /* vertical-align: middle; */
1.759 neumanie 8157: }
1.693 droeschl 8158:
1.911 bisitz 8159: dl,
8160: ul,
8161: div,
8162: fieldset {
8163: margin: 10px 10px 10px 0;
8164: /* overflow: hidden; */
1.693 droeschl 8165: }
1.795 www 8166:
1.1404 raeburn 8167: fieldset#LC_selectuser {
8168: margin: 0;
8169: padding: 0;
8170: }
8171:
1.1211 raeburn 8172: article.geogebraweb div {
8173: margin: 0;
8174: }
8175:
1.838 bisitz 8176: fieldset > legend {
1.911 bisitz 8177: font-weight: bold;
8178: padding: 0 5px 0 5px;
1.838 bisitz 8179: }
8180:
1.813 bisitz 8181: #LC_nav_bar {
1.911 bisitz 8182: float: left;
1.995 raeburn 8183: background-color: $pgbg_or_bgcolor;
1.966 bisitz 8184: margin: 0 0 2px 0;
1.807 droeschl 8185: }
8186:
1.916 droeschl 8187: #LC_realm {
8188: margin: 0.2em 0 0 0;
8189: padding: 0;
8190: font-weight: bold;
8191: text-align: center;
1.995 raeburn 8192: background-color: $pgbg_or_bgcolor;
1.916 droeschl 8193: }
8194:
1.911 bisitz 8195: #LC_nav_bar em {
8196: font-weight: bold;
8197: font-style: normal;
1.807 droeschl 8198: }
8199:
1.897 wenzelju 8200: ol.LC_primary_menu {
1.934 droeschl 8201: margin: 0;
1.1076 raeburn 8202: padding: 0;
1.807 droeschl 8203: }
8204:
1.852 droeschl 8205: ol#LC_PathBreadcrumbs {
1.911 bisitz 8206: margin: 0;
1.693 droeschl 8207: }
8208:
1.897 wenzelju 8209: ol.LC_primary_menu li {
1.1076 raeburn 8210: color: RGB(80, 80, 80);
8211: vertical-align: middle;
8212: text-align: left;
8213: list-style: none;
1.1205 golterma 8214: position: relative;
1.1076 raeburn 8215: float: left;
1.1205 golterma 8216: z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
8217: line-height: 1.5em;
1.1076 raeburn 8218: }
8219:
1.1205 golterma 8220: ol.LC_primary_menu li a,
8221: ol.LC_primary_menu li p {
1.1076 raeburn 8222: display: block;
8223: margin: 0;
8224: padding: 0 5px 0 10px;
8225: text-decoration: none;
8226: }
8227:
1.1205 golterma 8228: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
8229: display: inline-block;
8230: width: 95%;
8231: text-align: left;
8232: }
8233:
8234: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
8235: display: inline-block;
8236: width: 5%;
8237: float: right;
8238: text-align: right;
8239: font-size: 70%;
8240: }
8241:
8242: ol.LC_primary_menu ul {
1.1076 raeburn 8243: display: none;
1.1205 golterma 8244: width: 15em;
1.1076 raeburn 8245: background-color: $data_table_light;
1.1205 golterma 8246: position: absolute;
8247: top: 100%;
1.1076 raeburn 8248: }
8249:
1.1205 golterma 8250: ol.LC_primary_menu ul ul {
8251: left: 100%;
8252: top: 0;
8253: }
8254:
8255: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1076 raeburn 8256: display: block;
8257: position: absolute;
8258: margin: 0;
8259: padding: 0;
1.1078 raeburn 8260: z-index: 2;
1.1076 raeburn 8261: }
8262:
8263: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1205 golterma 8264: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1076 raeburn 8265: font-size: 90%;
1.911 bisitz 8266: vertical-align: top;
1.1076 raeburn 8267: float: none;
1.1079 raeburn 8268: border-left: 1px solid black;
8269: border-right: 1px solid black;
1.1205 golterma 8270: /* A dark bottom border to visualize different menu options;
8271: overwritten in the create_submenu routine for the last border-bottom of the menu */
8272: border-bottom: 1px solid $data_table_dark;
1.1076 raeburn 8273: }
8274:
1.1205 golterma 8275: ol.LC_primary_menu li li p:hover {
8276: color:$button_hover;
8277: text-decoration:none;
8278: background-color:$data_table_dark;
1.1076 raeburn 8279: }
8280:
8281: ol.LC_primary_menu li li a:hover {
8282: color:$button_hover;
8283: background-color:$data_table_dark;
1.693 droeschl 8284: }
8285:
1.1205 golterma 8286: /* Font-size equal to the size of the predecessors*/
8287: ol.LC_primary_menu li:hover li li {
8288: font-size: 100%;
8289: }
8290:
1.897 wenzelju 8291: ol.LC_primary_menu li img {
1.911 bisitz 8292: vertical-align: bottom;
1.934 droeschl 8293: height: 1.1em;
1.1077 raeburn 8294: margin: 0.2em 0 0 0;
1.693 droeschl 8295: }
8296:
1.897 wenzelju 8297: ol.LC_primary_menu a {
1.911 bisitz 8298: color: RGB(80, 80, 80);
8299: text-decoration: none;
1.693 droeschl 8300: }
1.795 www 8301:
1.949 droeschl 8302: ol.LC_primary_menu a.LC_new_message {
8303: font-weight:bold;
8304: color: darkred;
8305: }
8306:
1.975 raeburn 8307: ol.LC_docs_parameters {
8308: margin-left: 0;
8309: padding: 0;
8310: list-style: none;
8311: }
8312:
8313: ol.LC_docs_parameters li {
8314: margin: 0;
8315: padding-right: 20px;
8316: display: inline;
8317: }
8318:
1.976 raeburn 8319: ol.LC_docs_parameters li:before {
8320: content: "\\002022 \\0020";
8321: }
8322:
8323: li.LC_docs_parameters_title {
8324: font-weight: bold;
8325: }
8326:
8327: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
8328: content: "";
8329: }
8330:
1.897 wenzelju 8331: ul#LC_secondary_menu {
1.1107 raeburn 8332: clear: right;
1.911 bisitz 8333: color: $fontmenu;
8334: background: $tabbg;
8335: list-style: none;
8336: padding: 0;
8337: margin: 0;
8338: width: 100%;
1.995 raeburn 8339: text-align: left;
1.1107 raeburn 8340: float: left;
1.808 droeschl 8341: }
8342:
1.897 wenzelju 8343: ul#LC_secondary_menu li {
1.911 bisitz 8344: font-weight: bold;
8345: line-height: 1.8em;
1.1107 raeburn 8346: border-right: 1px solid black;
8347: float: left;
8348: }
8349:
8350: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
8351: background-color: $data_table_light;
8352: }
8353:
8354: ul#LC_secondary_menu li a {
1.911 bisitz 8355: padding: 0 0.8em;
1.1107 raeburn 8356: }
8357:
8358: ul#LC_secondary_menu li ul {
8359: display: none;
8360: }
8361:
8362: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
8363: display: block;
8364: position: absolute;
8365: margin: 0;
8366: padding: 0;
8367: list-style:none;
8368: float: none;
8369: background-color: $data_table_light;
8370: z-index: 2;
8371: margin-left: -1px;
8372: }
8373:
8374: ul#LC_secondary_menu li ul li {
8375: font-size: 90%;
8376: vertical-align: top;
8377: border-left: 1px solid black;
1.911 bisitz 8378: border-right: 1px solid black;
1.1119 raeburn 8379: background-color: $data_table_light;
1.1107 raeburn 8380: list-style:none;
8381: float: none;
8382: }
8383:
8384: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
8385: background-color: $data_table_dark;
1.807 droeschl 8386: }
8387:
1.847 tempelho 8388: ul.LC_TabContent {
1.911 bisitz 8389: display:block;
8390: background: $sidebg;
8391: border-bottom: solid 1px $lg_border_color;
8392: list-style:none;
1.1020 raeburn 8393: margin: -1px -10px 0 -10px;
1.911 bisitz 8394: padding: 0;
1.693 droeschl 8395: }
8396:
1.795 www 8397: ul.LC_TabContent li,
8398: ul.LC_TabContentBigger li {
1.911 bisitz 8399: float:left;
1.741 harmsja 8400: }
1.795 www 8401:
1.897 wenzelju 8402: ul#LC_secondary_menu li a {
1.911 bisitz 8403: color: $fontmenu;
8404: text-decoration: none;
1.693 droeschl 8405: }
1.795 www 8406:
1.721 harmsja 8407: ul.LC_TabContent {
1.952 onken 8408: min-height:20px;
1.721 harmsja 8409: }
1.795 www 8410:
8411: ul.LC_TabContent li {
1.911 bisitz 8412: vertical-align:middle;
1.959 onken 8413: padding: 0 16px 0 10px;
1.911 bisitz 8414: background-color:$tabbg;
8415: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 8416: border-left: solid 1px $font;
1.721 harmsja 8417: }
1.795 www 8418:
1.847 tempelho 8419: ul.LC_TabContent .right {
1.911 bisitz 8420: float:right;
1.847 tempelho 8421: }
8422:
1.911 bisitz 8423: ul.LC_TabContent li a,
8424: ul.LC_TabContent li {
8425: color:rgb(47,47,47);
8426: text-decoration:none;
8427: font-size:95%;
8428: font-weight:bold;
1.952 onken 8429: min-height:20px;
8430: }
8431:
1.959 onken 8432: ul.LC_TabContent li a:hover,
8433: ul.LC_TabContent li a:focus {
1.952 onken 8434: color: $button_hover;
1.959 onken 8435: background:none;
8436: outline:none;
1.952 onken 8437: }
8438:
8439: ul.LC_TabContent li:hover {
8440: color: $button_hover;
8441: cursor:pointer;
1.721 harmsja 8442: }
1.795 www 8443:
1.911 bisitz 8444: ul.LC_TabContent li.active {
1.952 onken 8445: color: $font;
1.911 bisitz 8446: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 8447: border-bottom:solid 1px #FFFFFF;
8448: cursor: default;
1.744 ehlerst 8449: }
1.795 www 8450:
1.959 onken 8451: ul.LC_TabContent li.active a {
8452: color:$font;
8453: background:#FFFFFF;
8454: outline: none;
8455: }
1.1047 raeburn 8456:
8457: ul.LC_TabContent li.goback {
8458: float: left;
8459: border-left: none;
8460: }
8461:
1.870 tempelho 8462: #maincoursedoc {
1.911 bisitz 8463: clear:both;
1.870 tempelho 8464: }
8465:
8466: ul.LC_TabContentBigger {
1.911 bisitz 8467: display:block;
8468: list-style:none;
8469: padding: 0;
1.870 tempelho 8470: }
8471:
1.795 www 8472: ul.LC_TabContentBigger li {
1.911 bisitz 8473: vertical-align:bottom;
8474: height: 30px;
8475: font-size:110%;
8476: font-weight:bold;
8477: color: #737373;
1.841 tempelho 8478: }
8479:
1.957 onken 8480: ul.LC_TabContentBigger li.active {
8481: position: relative;
8482: top: 1px;
8483: }
8484:
1.870 tempelho 8485: ul.LC_TabContentBigger li a {
1.911 bisitz 8486: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
8487: height: 30px;
8488: line-height: 30px;
8489: text-align: center;
8490: display: block;
8491: text-decoration: none;
1.958 onken 8492: outline: none;
1.741 harmsja 8493: }
1.795 www 8494:
1.870 tempelho 8495: ul.LC_TabContentBigger li.active a {
1.911 bisitz 8496: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
8497: color:$font;
1.744 ehlerst 8498: }
1.795 www 8499:
1.870 tempelho 8500: ul.LC_TabContentBigger li b {
1.911 bisitz 8501: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
8502: display: block;
8503: float: left;
8504: padding: 0 30px;
1.957 onken 8505: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 8506: }
8507:
1.956 onken 8508: ul.LC_TabContentBigger li:hover b {
8509: color:$button_hover;
8510: }
8511:
1.870 tempelho 8512: ul.LC_TabContentBigger li.active b {
1.911 bisitz 8513: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
8514: color:$font;
1.957 onken 8515: border: 0;
1.741 harmsja 8516: }
1.693 droeschl 8517:
1.870 tempelho 8518:
1.862 bisitz 8519: ul.LC_CourseBreadcrumbs {
8520: background: $sidebg;
1.1020 raeburn 8521: height: 2em;
1.862 bisitz 8522: padding-left: 10px;
1.1020 raeburn 8523: margin: 0;
1.862 bisitz 8524: list-style-position: inside;
8525: }
8526:
1.911 bisitz 8527: ol#LC_MenuBreadcrumbs,
1.862 bisitz 8528: ol#LC_PathBreadcrumbs {
1.911 bisitz 8529: padding-left: 10px;
8530: margin: 0;
1.933 droeschl 8531: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 8532: }
8533:
1.911 bisitz 8534: ol#LC_MenuBreadcrumbs li,
8535: ol#LC_PathBreadcrumbs li,
1.862 bisitz 8536: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 8537: display: inline;
1.933 droeschl 8538: white-space: normal;
1.693 droeschl 8539: }
8540:
1.823 bisitz 8541: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 8542: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 8543: text-decoration: none;
8544: font-size:90%;
1.693 droeschl 8545: }
1.795 www 8546:
1.969 droeschl 8547: ol#LC_MenuBreadcrumbs h1 {
8548: display: inline;
8549: font-size: 90%;
8550: line-height: 2.5em;
8551: margin: 0;
8552: padding: 0;
8553: }
8554:
1.795 www 8555: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 8556: text-decoration:none;
8557: font-size:100%;
8558: font-weight:bold;
1.693 droeschl 8559: }
1.795 www 8560:
1.840 bisitz 8561: .LC_Box {
1.911 bisitz 8562: border: solid 1px $lg_border_color;
8563: padding: 0 10px 10px 10px;
1.746 neumanie 8564: }
1.795 www 8565:
1.1020 raeburn 8566: .LC_DocsBox {
8567: border: solid 1px $lg_border_color;
8568: padding: 0 0 10px 10px;
8569: }
8570:
1.795 www 8571: .LC_AboutMe_Image {
1.911 bisitz 8572: float:left;
8573: margin-right:10px;
1.747 neumanie 8574: }
1.795 www 8575:
8576: .LC_Clear_AboutMe_Image {
1.911 bisitz 8577: clear:left;
1.747 neumanie 8578: }
1.795 www 8579:
1.721 harmsja 8580: dl.LC_ListStyleClean dt {
1.911 bisitz 8581: padding-right: 5px;
8582: display: table-header-group;
1.693 droeschl 8583: }
8584:
1.721 harmsja 8585: dl.LC_ListStyleClean dd {
1.911 bisitz 8586: display: table-row;
1.693 droeschl 8587: }
8588:
1.721 harmsja 8589: .LC_ListStyleClean,
8590: .LC_ListStyleSimple,
8591: .LC_ListStyleNormal,
1.795 www 8592: .LC_ListStyleSpecial {
1.911 bisitz 8593: /* display:block; */
8594: list-style-position: inside;
8595: list-style-type: none;
8596: overflow: hidden;
8597: padding: 0;
1.693 droeschl 8598: }
8599:
1.721 harmsja 8600: .LC_ListStyleSimple li,
8601: .LC_ListStyleSimple dd,
8602: .LC_ListStyleNormal li,
8603: .LC_ListStyleNormal dd,
8604: .LC_ListStyleSpecial li,
1.795 www 8605: .LC_ListStyleSpecial dd {
1.911 bisitz 8606: margin: 0;
8607: padding: 5px 5px 5px 10px;
8608: clear: both;
1.693 droeschl 8609: }
8610:
1.721 harmsja 8611: .LC_ListStyleClean li,
8612: .LC_ListStyleClean dd {
1.911 bisitz 8613: padding-top: 0;
8614: padding-bottom: 0;
1.693 droeschl 8615: }
8616:
1.721 harmsja 8617: .LC_ListStyleSimple dd,
1.795 www 8618: .LC_ListStyleSimple li {
1.911 bisitz 8619: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 8620: }
8621:
1.721 harmsja 8622: .LC_ListStyleSpecial li,
8623: .LC_ListStyleSpecial dd {
1.911 bisitz 8624: list-style-type: none;
8625: background-color: RGB(220, 220, 220);
8626: margin-bottom: 4px;
1.693 droeschl 8627: }
8628:
1.721 harmsja 8629: table.LC_SimpleTable {
1.911 bisitz 8630: margin:5px;
8631: border:solid 1px $lg_border_color;
1.795 www 8632: }
1.693 droeschl 8633:
1.721 harmsja 8634: table.LC_SimpleTable tr {
1.911 bisitz 8635: padding: 0;
8636: border:solid 1px $lg_border_color;
1.693 droeschl 8637: }
1.795 www 8638:
8639: table.LC_SimpleTable thead {
1.911 bisitz 8640: background:rgb(220,220,220);
1.693 droeschl 8641: }
8642:
1.721 harmsja 8643: div.LC_columnSection {
1.911 bisitz 8644: display: block;
8645: clear: both;
8646: overflow: hidden;
8647: margin: 0;
1.693 droeschl 8648: }
8649:
1.721 harmsja 8650: div.LC_columnSection>* {
1.911 bisitz 8651: float: left;
8652: margin: 10px 20px 10px 0;
8653: overflow:hidden;
1.693 droeschl 8654: }
1.721 harmsja 8655:
1.795 www 8656: table em {
1.911 bisitz 8657: font-weight: bold;
8658: font-style: normal;
1.748 schulted 8659: }
1.795 www 8660:
1.779 bisitz 8661: table.LC_tableBrowseRes,
1.795 www 8662: table.LC_tableOfContent {
1.911 bisitz 8663: border:none;
8664: border-spacing: 1px;
8665: padding: 3px;
8666: background-color: #FFFFFF;
8667: font-size: 90%;
1.753 droeschl 8668: }
1.789 droeschl 8669:
1.911 bisitz 8670: table.LC_tableOfContent {
8671: border-collapse: collapse;
1.789 droeschl 8672: }
8673:
1.771 droeschl 8674: table.LC_tableBrowseRes a,
1.768 schulted 8675: table.LC_tableOfContent a {
1.911 bisitz 8676: background-color: transparent;
8677: text-decoration: none;
1.753 droeschl 8678: }
8679:
1.795 www 8680: table.LC_tableOfContent img {
1.911 bisitz 8681: border: none;
8682: height: 1.3em;
8683: vertical-align: text-bottom;
8684: margin-right: 0.3em;
1.753 droeschl 8685: }
1.757 schulted 8686:
1.795 www 8687: a#LC_content_toolbar_firsthomework {
1.911 bisitz 8688: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 8689: }
8690:
1.795 www 8691: a#LC_content_toolbar_everything {
1.911 bisitz 8692: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 8693: }
8694:
1.795 www 8695: a#LC_content_toolbar_uncompleted {
1.911 bisitz 8696: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 8697: }
8698:
1.795 www 8699: #LC_content_toolbar_clearbubbles {
1.911 bisitz 8700: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 8701: }
8702:
1.795 www 8703: a#LC_content_toolbar_changefolder {
1.911 bisitz 8704: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 8705: }
8706:
1.795 www 8707: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 8708: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 8709: }
8710:
1.1043 raeburn 8711: a#LC_content_toolbar_edittoplevel {
8712: background-image:url(/res/adm/pages/edittoplevel.gif);
8713: }
8714:
1.1384 raeburn 8715: a#LC_content_toolbar_printout {
8716: background-image:url(/res/adm/pages/printout.gif);
8717: }
8718:
1.795 www 8719: ul#LC_toolbar li a:hover {
1.911 bisitz 8720: background-position: bottom center;
1.757 schulted 8721: }
8722:
1.795 www 8723: ul#LC_toolbar {
1.911 bisitz 8724: padding: 0;
8725: margin: 2px;
8726: list-style:none;
8727: position:relative;
8728: background-color:white;
1.1082 raeburn 8729: overflow: auto;
1.757 schulted 8730: }
8731:
1.795 www 8732: ul#LC_toolbar li {
1.911 bisitz 8733: border:1px solid white;
8734: padding: 0;
8735: margin: 0;
8736: float: left;
8737: display:inline;
8738: vertical-align:middle;
1.1082 raeburn 8739: white-space: nowrap;
1.911 bisitz 8740: }
1.757 schulted 8741:
1.783 amueller 8742:
1.795 www 8743: a.LC_toolbarItem {
1.911 bisitz 8744: display:block;
8745: padding: 0;
8746: margin: 0;
8747: height: 32px;
8748: width: 32px;
8749: color:white;
8750: border: none;
8751: background-repeat:no-repeat;
8752: background-color:transparent;
1.757 schulted 8753: }
8754:
1.915 droeschl 8755: ul.LC_funclist {
8756: margin: 0;
8757: padding: 0.5em 1em 0.5em 0;
8758: }
8759:
1.933 droeschl 8760: ul.LC_funclist > li:first-child {
8761: font-weight:bold;
8762: margin-left:0.8em;
8763: }
8764:
1.915 droeschl 8765: ul.LC_funclist + ul.LC_funclist {
8766: /*
8767: left border as a seperator if we have more than
8768: one list
8769: */
8770: border-left: 1px solid $sidebg;
8771: /*
8772: this hides the left border behind the border of the
8773: outer box if element is wrapped to the next 'line'
8774: */
8775: margin-left: -1px;
8776: }
8777:
1.843 bisitz 8778: ul.LC_funclist li {
1.915 droeschl 8779: display: inline;
1.782 bisitz 8780: white-space: nowrap;
1.915 droeschl 8781: margin: 0 0 0 25px;
8782: line-height: 150%;
1.782 bisitz 8783: }
8784:
1.974 wenzelju 8785: .LC_hidden {
8786: display: none;
8787: }
8788:
1.1030 www 8789: .LCmodal-overlay {
8790: position:fixed;
8791: top:0;
8792: right:0;
8793: bottom:0;
8794: left:0;
8795: height:100%;
8796: width:100%;
8797: margin:0;
8798: padding:0;
8799: background:#999;
8800: opacity:.75;
8801: filter: alpha(opacity=75);
8802: -moz-opacity: 0.75;
8803: z-index:101;
8804: }
8805:
8806: * html .LCmodal-overlay {
8807: position: absolute;
8808: height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
8809: }
8810:
8811: .LCmodal-window {
8812: position:fixed;
8813: top:50%;
8814: left:50%;
8815: margin:0;
8816: padding:0;
8817: z-index:102;
8818: }
8819:
8820: * html .LCmodal-window {
8821: position:absolute;
8822: }
8823:
8824: .LCclose-window {
8825: position:absolute;
8826: width:32px;
8827: height:32px;
8828: right:8px;
8829: top:8px;
8830: background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
8831: text-indent:-99999px;
8832: overflow:hidden;
8833: cursor:pointer;
8834: }
8835:
1.1369 raeburn 8836: .LCisDisabled {
8837: cursor: not-allowed;
8838: opacity: 0.5;
8839: }
8840:
8841: a[aria-disabled="true"] {
8842: color: currentColor;
8843: display: inline-block; /* For IE11/ MS Edge bug */
8844: pointer-events: none;
8845: text-decoration: none;
8846: }
8847:
1.1335 raeburn 8848: pre.LC_wordwrap {
8849: white-space: pre-wrap;
8850: white-space: -moz-pre-wrap;
8851: white-space: -pre-wrap;
8852: white-space: -o-pre-wrap;
8853: word-wrap: break-word;
8854: }
8855:
1.1100 raeburn 8856: /*
1.1231 damieng 8857: styles used for response display
8858: */
8859: div.LC_radiofoil, div.LC_rankfoil {
8860: margin: .5em 0em .5em 0em;
8861: }
8862: table.LC_itemgroup {
8863: margin-top: 1em;
8864: }
8865:
8866: /*
1.1100 raeburn 8867: styles used by TTH when "Default set of options to pass to tth/m
8868: when converting TeX" in course settings has been set
8869:
8870: option passed: -t
8871:
8872: */
8873:
8874: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
8875: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
8876: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
8877: td div.norm {line-height:normal;}
8878:
8879: /*
8880: option passed -y3
8881: */
8882:
8883: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
8884: span.overacc2 {position: relative; left: .8em; top: -1.2ex;}
8885: span.overacc1 {position: relative; left: .6em; top: -1.2ex;}
8886:
1.1230 damieng 8887: /*
8888: sections with roles, for content only
8889: */
8890: section[class^="role-"] {
8891: padding-left: 10px;
8892: padding-right: 5px;
8893: margin-top: 8px;
8894: margin-bottom: 8px;
8895: border: 1px solid #2A4;
8896: border-radius: 5px;
8897: box-shadow: 0px 1px 1px #BBB;
8898: }
8899: section[class^="role-"]>h1 {
8900: position: relative;
8901: margin: 0px;
8902: padding-top: 10px;
8903: padding-left: 40px;
8904: }
8905: section[class^="role-"]>h1:before {
8906: position: absolute;
8907: left: -5px;
8908: top: 5px;
8909: }
8910: section.role-activity>h1:before {
8911: content:url('/adm/daxe/images/section_icons/activity.png');
8912: }
8913: section.role-advice>h1:before {
8914: content:url('/adm/daxe/images/section_icons/advice.png');
8915: }
8916: section.role-bibliography>h1:before {
8917: content:url('/adm/daxe/images/section_icons/bibliography.png');
8918: }
8919: section.role-citation>h1:before {
8920: content:url('/adm/daxe/images/section_icons/citation.png');
8921: }
8922: section.role-conclusion>h1:before {
8923: content:url('/adm/daxe/images/section_icons/conclusion.png');
8924: }
8925: section.role-definition>h1:before {
8926: content:url('/adm/daxe/images/section_icons/definition.png');
8927: }
8928: section.role-demonstration>h1:before {
8929: content:url('/adm/daxe/images/section_icons/demonstration.png');
8930: }
8931: section.role-example>h1:before {
8932: content:url('/adm/daxe/images/section_icons/example.png');
8933: }
8934: section.role-explanation>h1:before {
8935: content:url('/adm/daxe/images/section_icons/explanation.png');
8936: }
8937: section.role-introduction>h1:before {
8938: content:url('/adm/daxe/images/section_icons/introduction.png');
8939: }
8940: section.role-method>h1:before {
8941: content:url('/adm/daxe/images/section_icons/method.png');
8942: }
8943: section.role-more_information>h1:before {
8944: content:url('/adm/daxe/images/section_icons/more_information.png');
8945: }
8946: section.role-objectives>h1:before {
8947: content:url('/adm/daxe/images/section_icons/objectives.png');
8948: }
8949: section.role-prerequisites>h1:before {
8950: content:url('/adm/daxe/images/section_icons/prerequisites.png');
8951: }
8952: section.role-remark>h1:before {
8953: content:url('/adm/daxe/images/section_icons/remark.png');
8954: }
8955: section.role-reminder>h1:before {
8956: content:url('/adm/daxe/images/section_icons/reminder.png');
8957: }
8958: section.role-summary>h1:before {
8959: content:url('/adm/daxe/images/section_icons/summary.png');
8960: }
8961: section.role-syntax>h1:before {
8962: content:url('/adm/daxe/images/section_icons/syntax.png');
8963: }
8964: section.role-warning>h1:before {
8965: content:url('/adm/daxe/images/section_icons/warning.png');
8966: }
8967:
1.1269 raeburn 8968: #LC_minitab_header {
8969: float:left;
8970: width:100%;
8971: background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
8972: font-size:93%;
8973: line-height:normal;
8974: margin: 0.5em 0 0.5em 0;
8975: }
8976: #LC_minitab_header ul {
8977: margin:0;
8978: padding:10px 10px 0;
8979: list-style:none;
8980: }
8981: #LC_minitab_header li {
8982: float:left;
8983: background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
8984: margin:0;
8985: padding:0 0 0 9px;
8986: }
8987: #LC_minitab_header a {
8988: display:block;
8989: background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
8990: padding:5px 15px 4px 6px;
8991: }
8992: #LC_minitab_header #LC_current_minitab {
8993: background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
8994: }
8995: #LC_minitab_header #LC_current_minitab a {
8996: background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
8997: padding-bottom:5px;
8998: }
8999:
9000:
1.343 albertel 9001: END
9002: }
9003:
1.306 albertel 9004: =pod
9005:
9006: =item * &headtag()
9007:
9008: Returns a uniform footer for LON-CAPA web pages.
9009:
1.307 albertel 9010: Inputs: $title - optional title for the head
9011: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 9012: $args - optional arguments
1.319 albertel 9013: force_register - if is true call registerurl so the remote is
9014: informed
1.415 albertel 9015: redirect -> array ref of
9016: 1- seconds before redirect occurs
9017: 2- url to redirect to
9018: 3- whether the side effect should occur
1.315 albertel 9019: (side effect of setting
9020: $env{'internal.head.redirect'} to the url
1.1386 raeburn 9021: redirected to)
9022: 4- whether the redirect target should be
9023: the opener of the current (pop-up)
9024: window (side effect of setting
9025: $env{'internal.head.to_opener'} to
9026: 1, if true.
1.1388 raeburn 9027: 5- whether encrypt check should be skipped
1.352 albertel 9028: domain -> force to color decorate a page for a specific
9029: domain
9030: function -> force usage of a specific rolish color scheme
9031: bgcolor -> override the default page bgcolor
1.460 albertel 9032: no_auto_mt_title
9033: -> prevent &mt()ing the title arg
1.464 albertel 9034:
1.306 albertel 9035: =cut
9036:
9037: sub headtag {
1.313 albertel 9038: my ($title,$head_extra,$args) = @_;
1.306 albertel 9039:
1.363 albertel 9040: my $function = $args->{'function'} || &get_users_function();
9041: my $domain = $args->{'domain'} || &determinedomain();
9042: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.1154 raeburn 9043: my $httphost = $args->{'use_absolute'};
1.418 albertel 9044: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 9045: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 9046: #time(),
1.418 albertel 9047: $env{'environment.color.timestamp'},
1.363 albertel 9048: $function,$domain,$bgcolor);
9049:
1.369 www 9050: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 9051:
1.308 albertel 9052: my $result =
9053: '<head>'.
1.1160 raeburn 9054: &font_settings($args);
1.319 albertel 9055:
1.1188 raeburn 9056: my $inhibitprint;
9057: if ($args->{'print_suppress'}) {
9058: $inhibitprint = &print_suppression();
9059: }
1.1064 raeburn 9060:
1.461 albertel 9061: if (!$args->{'frameset'}) {
9062: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
9063: }
1.962 droeschl 9064: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
9065: $result .= Apache::lonxml::display_title();
1.319 albertel 9066: }
1.436 albertel 9067: if (!$args->{'no_nav_bar'}
9068: && !$args->{'only_body'}
9069: && !$args->{'frameset'}) {
1.1154 raeburn 9070: $result .= &help_menu_js($httphost);
1.1032 www 9071: $result.=&modal_window();
1.1038 www 9072: $result.=&togglebox_script();
1.1034 www 9073: $result.=&wishlist_window();
1.1041 www 9074: $result.=&LCprogressbarUpdate_script();
1.1034 www 9075: } else {
9076: if ($args->{'add_modal'}) {
9077: $result.=&modal_window();
9078: }
9079: if ($args->{'add_wishlist'}) {
9080: $result.=&wishlist_window();
9081: }
1.1038 www 9082: if ($args->{'add_togglebox'}) {
9083: $result.=&togglebox_script();
9084: }
1.1041 www 9085: if ($args->{'add_progressbar'}) {
9086: $result.=&LCprogressbarUpdate_script();
9087: }
1.436 albertel 9088: }
1.314 albertel 9089: if (ref($args->{'redirect'})) {
1.1388 raeburn 9090: my ($time,$url,$inhibit_continue,$to_opener,$skip_enc_check) = @{$args->{'redirect'}};
9091: if (!$skip_enc_check) {
9092: $url = &Apache::lonenc::check_encrypt($url);
9093: }
1.414 albertel 9094: if (!$inhibit_continue) {
9095: $env{'internal.head.redirect'} = $url;
9096: }
1.1386 raeburn 9097: $result.=<<"ADDMETA";
1.313 albertel 9098: <meta http-equiv="pragma" content="no-cache" />
1.1386 raeburn 9099: ADDMETA
9100: if ($to_opener) {
9101: $env{'internal.head.to_opener'} = 1;
9102: my $dest = &js_escape($url);
9103: my $timeout = int($time * 1000);
9104: $result .=<<"ENDJS";
9105: <script type="text/javascript">
9106: // <![CDATA[
9107: function LC_To_Opener() {
9108: var dest = '$dest';
9109: if (dest != '') {
9110: if (window.opener != null && !window.opener.closed) {
9111: window.opener.location.href=dest;
9112: window.close();
9113: } else {
9114: window.location.href=dest;
9115: }
9116: }
9117: }
9118: \$(document).ready(function () {
9119: setTimeout('LC_To_Opener()',$timeout);
9120: });
9121: // ]]>
9122: </script>
9123: ENDJS
9124: } else {
9125: $result.=<<"ADDMETA";
1.344 albertel 9126: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 9127: ADDMETA
1.1386 raeburn 9128: }
1.1210 raeburn 9129: } else {
9130: unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
9131: my $requrl = $env{'request.uri'};
9132: if ($requrl eq '') {
9133: $requrl = $ENV{'REQUEST_URI'};
9134: $requrl =~ s/\?.+$//;
9135: }
9136: unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
9137: (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
9138: ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
9139: my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
9140: unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
9141: my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
1.1340 raeburn 9142: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
1.1352 raeburn 9143: my ($offload,$offloadoth);
1.1210 raeburn 9144: if (ref($domdefs{'offloadnow'}) eq 'HASH') {
9145: if ($domdefs{'offloadnow'}{$lonhost}) {
1.1340 raeburn 9146: $offload = 1;
1.1353 raeburn 9147: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
9148: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
9149: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
9150: $offloadoth = 1;
9151: $dom_in_use = $env{'user.domain'};
9152: }
9153: }
1.1340 raeburn 9154: }
9155: }
9156: unless ($offload) {
9157: if (ref($domdefs{'offloadoth'}) eq 'HASH') {
9158: if ($domdefs{'offloadoth'}{$lonhost}) {
9159: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
9160: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
9161: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
9162: $offload = 1;
1.1352 raeburn 9163: $offloadoth = 1;
1.1340 raeburn 9164: $dom_in_use = $env{'user.domain'};
9165: }
1.1210 raeburn 9166: }
1.1340 raeburn 9167: }
9168: }
9169: }
9170: if ($offload) {
1.1358 raeburn 9171: my $newserver = &Apache::lonnet::spareserver(undef,30000,undef,1,$dom_in_use);
1.1352 raeburn 9172: if (($newserver eq '') && ($offloadoth)) {
9173: my @domains = &Apache::lonnet::current_machine_domains();
9174: if (($dom_in_use ne '') && (!grep(/^\Q$dom_in_use\E$/,@domains))) {
9175: ($newserver) = &Apache::lonnet::choose_server($dom_in_use);
9176: }
9177: }
1.1340 raeburn 9178: if (($newserver) && ($newserver ne $lonhost)) {
9179: my $numsec = 5;
9180: my $timeout = $numsec * 1000;
9181: my ($newurl,$locknum,%locks,$msg);
9182: if ($env{'request.role.adv'}) {
9183: ($locknum,%locks) = &Apache::lonnet::get_locks();
9184: }
9185: my $disable_submit = 0;
9186: if ($requrl =~ /$LONCAPA::assess_re/) {
9187: $disable_submit = 1;
9188: }
9189: if ($locknum) {
9190: my @lockinfo = sort(values(%locks));
1.1354 raeburn 9191: $msg = &mt('Once the following tasks are complete:')." \n".
1.1340 raeburn 9192: join(", ",sort(values(%locks)))."\n";
9193: if (&show_course()) {
9194: $msg .= &mt('your session will be transferred to a different server, after you click "Courses".');
9195: } else {
9196: $msg .= &mt('your session will be transferred to a different server, after you click "Roles".');
1.1210 raeburn 9197: }
1.1340 raeburn 9198: } else {
9199: if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
9200: $msg = &mt('Your LON-CAPA submission has been recorded')."\n";
9201: }
9202: $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
9203: $newurl = '/adm/switchserver?otherserver='.$newserver;
9204: if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
9205: $newurl .= '&role='.$env{'request.role'};
9206: }
9207: if ($env{'request.symb'}) {
9208: my $shownsymb = &Apache::lonenc::check_encrypt($env{'request.symb'});
9209: if ($shownsymb =~ m{^/enc/}) {
9210: my $reqdmajor = 2;
9211: my $reqdminor = 11;
9212: my $reqdsubminor = 3;
9213: my $newserverrev = &Apache::lonnet::get_server_loncaparev('',$newserver);
9214: my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$newserver);
9215: my ($major,$minor,$subminor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.(\d+|)[\w.\-]+\'?$/);
9216: if (($major eq '' && $minor eq '') ||
9217: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)) ||
9218: (($reqdmajor == $major) && ($reqdminor == $minor) && (($subminor eq '') ||
9219: ($reqdsubminor > $subminor))))) {
9220: undef($shownsymb);
9221: }
1.1210 raeburn 9222: }
1.1340 raeburn 9223: if ($shownsymb) {
9224: &js_escape(\$shownsymb);
9225: $newurl .= '&symb='.$shownsymb;
1.1210 raeburn 9226: }
1.1340 raeburn 9227: } else {
9228: my $shownurl = &Apache::lonenc::check_encrypt($requrl);
9229: &js_escape(\$shownurl);
9230: $newurl .= '&origurl='.$shownurl;
1.1210 raeburn 9231: }
1.1340 raeburn 9232: }
9233: &js_escape(\$msg);
9234: $result.=<<OFFLOAD
1.1210 raeburn 9235: <meta http-equiv="pragma" content="no-cache" />
9236: <script type="text/javascript">
1.1215 raeburn 9237: // <![CDATA[
1.1210 raeburn 9238: function LC_Offload_Now() {
9239: var dest = "$newurl";
9240: if (dest != '') {
9241: window.location.href="$newurl";
9242: }
9243: }
1.1214 raeburn 9244: \$(document).ready(function () {
9245: window.alert('$msg');
9246: if ($disable_submit) {
1.1210 raeburn 9247: \$(".LC_hwk_submit").prop("disabled", true);
9248: \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1214 raeburn 9249: }
9250: setTimeout('LC_Offload_Now()', $timeout);
9251: });
1.1215 raeburn 9252: // ]]>
1.1210 raeburn 9253: </script>
9254: OFFLOAD
9255: }
9256: }
9257: }
9258: }
9259: }
1.313 albertel 9260: }
1.306 albertel 9261: if (!defined($title)) {
9262: $title = 'The LearningOnline Network with CAPA';
9263: }
1.460 albertel 9264: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
9265: $result .= '<title> LON-CAPA '.$title.'</title>'
1.1168 raeburn 9266: .'<link rel="stylesheet" type="text/css" href="'.$url.'"';
9267: if (!$args->{'frameset'}) {
9268: $result .= ' /';
9269: }
9270: $result .= '>'
1.1064 raeburn 9271: .$inhibitprint
1.414 albertel 9272: .$head_extra;
1.1242 raeburn 9273: my $clientmobile;
9274: if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
9275: (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
9276: } else {
9277: $clientmobile = $env{'browser.mobile'};
9278: }
9279: if ($clientmobile) {
1.1137 raeburn 9280: $result .= '
9281: <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=0, minimum-scale=1.0, maximum-scale=1.0">
9282: <meta name="apple-mobile-web-app-capable" content="yes" />';
9283: }
1.1278 raeburn 9284: $result .= '<meta name="google" content="notranslate" />'."\n";
1.962 droeschl 9285: return $result.'</head>';
1.306 albertel 9286: }
9287:
9288: =pod
9289:
1.340 albertel 9290: =item * &font_settings()
9291:
9292: Returns neccessary <meta> to set the proper encoding
9293:
1.1160 raeburn 9294: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340 albertel 9295:
9296: =cut
9297:
9298: sub font_settings {
1.1160 raeburn 9299: my ($args) = @_;
1.340 albertel 9300: my $headerstring='';
1.1160 raeburn 9301: if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
9302: ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.1168 raeburn 9303: $headerstring.=
9304: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
9305: if (!$args->{'frameset'}) {
9306: $headerstring.= ' /';
9307: }
9308: $headerstring .= '>'."\n";
1.340 albertel 9309: }
9310: return $headerstring;
9311: }
9312:
1.341 albertel 9313: =pod
9314:
1.1064 raeburn 9315: =item * &print_suppression()
9316:
9317: In course context returns css which causes the body to be blank when media="print",
9318: if printout generation is unavailable for the current resource.
9319:
9320: This could be because:
9321:
9322: (a) printstartdate is in the future
9323:
9324: (b) printenddate is in the past
9325:
9326: (c) there is an active exam block with "printout"
9327: functionality blocked
9328:
9329: Users with pav, pfo or evb privileges are exempt.
9330:
9331: Inputs: none
9332:
9333: =cut
9334:
9335:
9336: sub print_suppression {
9337: my $noprint;
9338: if ($env{'request.course.id'}) {
9339: my $scope = $env{'request.course.id'};
9340: if ((&Apache::lonnet::allowed('pav',$scope)) ||
9341: (&Apache::lonnet::allowed('pfo',$scope))) {
9342: return;
9343: }
9344: if ($env{'request.course.sec'} ne '') {
9345: $scope .= "/$env{'request.course.sec'}";
9346: if ((&Apache::lonnet::allowed('pav',$scope)) ||
9347: (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065 raeburn 9348: return;
1.1064 raeburn 9349: }
9350: }
9351: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9352: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372 raeburn 9353: my $clientip = &Apache::lonnet::get_requestor_ip();
9354: my $blocked = &blocking_status('printout',$clientip,$cnum,$cdom,undef,1);
1.1064 raeburn 9355: if ($blocked) {
9356: my $checkrole = "cm./$cdom/$cnum";
9357: if ($env{'request.course.sec'} ne '') {
9358: $checkrole .= "/$env{'request.course.sec'}";
9359: }
9360: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
9361: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
9362: $noprint = 1;
9363: }
9364: }
9365: unless ($noprint) {
9366: my $symb = &Apache::lonnet::symbread();
9367: if ($symb ne '') {
9368: my $navmap = Apache::lonnavmaps::navmap->new();
9369: if (ref($navmap)) {
9370: my $res = $navmap->getBySymb($symb);
9371: if (ref($res)) {
9372: if (!$res->resprintable()) {
9373: $noprint = 1;
9374: }
9375: }
9376: }
9377: }
9378: }
9379: if ($noprint) {
9380: return <<"ENDSTYLE";
9381: <style type="text/css" media="print">
9382: body { display:none }
9383: </style>
9384: ENDSTYLE
9385: }
9386: }
9387: return;
9388: }
9389:
9390: =pod
9391:
1.341 albertel 9392: =item * &xml_begin()
9393:
9394: Returns the needed doctype and <html>
9395:
9396: Inputs: none
9397:
9398: =cut
9399:
9400: sub xml_begin {
1.1168 raeburn 9401: my ($is_frameset) = @_;
1.341 albertel 9402: my $output='';
9403:
9404: if ($env{'browser.mathml'}) {
9405: $output='<?xml version="1.0"?>'
9406: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
9407: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
9408:
9409: # .'<!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">] >'
9410: .'<!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">'
9411: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
9412: .'xmlns="http://www.w3.org/1999/xhtml">';
1.1168 raeburn 9413: } elsif ($is_frameset) {
9414: $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
9415: '<html>'."\n";
1.341 albertel 9416: } else {
1.1168 raeburn 9417: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
9418: '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341 albertel 9419: }
9420: return $output;
9421: }
1.340 albertel 9422:
9423: =pod
9424:
1.306 albertel 9425: =item * &start_page()
9426:
9427: Returns a complete <html> .. <body> section for LON-CAPA web pages.
9428:
1.648 raeburn 9429: Inputs:
9430:
9431: =over 4
9432:
9433: $title - optional title for the page
9434:
9435: $head_extra - optional extra HTML to incude inside the <head>
9436:
9437: $args - additional optional args supported are:
9438:
9439: =over 8
9440:
9441: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 9442: arg on
1.814 bisitz 9443: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 9444: add_entries -> additional attributes to add to the <body>
9445: domain -> force to color decorate a page for a
1.317 albertel 9446: specific domain
1.648 raeburn 9447: function -> force usage of a specific rolish color
1.317 albertel 9448: scheme
1.648 raeburn 9449: redirect -> see &headtag()
9450: bgcolor -> override the default page bg color
9451: js_ready -> return a string ready for being used in
1.317 albertel 9452: a javascript writeln
1.648 raeburn 9453: html_encode -> return a string ready for being used in
1.320 albertel 9454: a html attribute
1.648 raeburn 9455: force_register -> if is true will turn on the &bodytag()
1.317 albertel 9456: $forcereg arg
1.648 raeburn 9457: frameset -> if true will start with a <frameset>
1.330 albertel 9458: rather than <body>
1.648 raeburn 9459: skip_phases -> hash ref of
1.338 albertel 9460: head -> skip the <html><head> generation
9461: body -> skip all <body> generation
1.648 raeburn 9462: no_auto_mt_title -> prevent &mt()ing the title arg
1.867 kalberla 9463: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 9464: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.1272 raeburn 9465: bread_crumbs_nomenu -> if true will pass false as the value of $menulink
9466: to lonhtmlcommon::breadcrumbs
1.1096 raeburn 9467: group -> includes the current group, if page is for a
1.1274 raeburn 9468: specific group
9469: use_absolute -> for request for external resource or syllabus, this
9470: will contain https://<hostname> if server uses
9471: https (as per hosts.tab), but request is for http
9472: hostname -> hostname, originally from $r->hostname(), (optional).
1.1369 raeburn 9473: links_disabled -> Links in primary and secondary menus are disabled
9474: (Can enable them once page has loaded - see lonroles.pm
9475: for an example).
1.1380 raeburn 9476: links_target -> Target for links, e.g., _parent (optional).
1.361 albertel 9477:
1.648 raeburn 9478: =back
1.460 albertel 9479:
1.648 raeburn 9480: =back
1.562 albertel 9481:
1.306 albertel 9482: =cut
9483:
9484: sub start_page {
1.309 albertel 9485: my ($title,$head_extra,$args) = @_;
1.318 albertel 9486: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319 albertel 9487:
1.315 albertel 9488: $env{'internal.start_page'}++;
1.1359 raeburn 9489: my ($result,@advtools,$ltiscope,$ltiuri,%ltimenu,$menucoll,%menu);
1.964 droeschl 9490:
1.338 albertel 9491: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1168 raeburn 9492: $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338 albertel 9493: }
1.1316 raeburn 9494:
9495: if (($env{'request.course.id'}) && ($env{'request.lti.login'})) {
1.1318 raeburn 9496: if ($env{'course.'.$env{'request.course.id'}.'.lti.override'}) {
9497: unless ($env{'course.'.$env{'request.course.id'}.'.lti.topmenu'}) {
9498: $args->{'no_primary_menu'} = 1;
9499: }
9500: unless ($env{'course.'.$env{'request.course.id'}.'.lti.inlinemenu'}) {
9501: $args->{'no_inline_menu'} = 1;
9502: }
9503: if ($env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'}) {
9504: map { $ltimenu{$_} = 1; } split(/,/,$env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'});
9505: }
9506: } else {
9507: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9508: my %lti = &Apache::lonnet::get_domain_lti($cdom,'provider');
9509: if (ref($lti{$env{'request.lti.login'}}) eq 'HASH') {
9510: unless ($lti{$env{'request.lti.login'}}{'topmenu'}) {
9511: $args->{'no_primary_menu'} = 1;
9512: }
9513: unless ($lti{$env{'request.lti.login'}}{'inlinemenu'}) {
9514: $args->{'no_inline_menu'} = 1;
9515: }
9516: if (ref($lti{$env{'request.lti.login'}}{'lcmenu'}) eq 'ARRAY') {
9517: map { $ltimenu{$_} = 1; } @{$lti{$env{'request.lti.login'}}{'lcmenu'}};
9518: }
9519: }
9520: }
1.1316 raeburn 9521: ($ltiscope,$ltiuri) = &LONCAPA::ltiutils::lti_provider_scope($env{'request.lti.uri'},
9522: $env{'course.'.$env{'request.course.id'}.'.domain'},
9523: $env{'course.'.$env{'request.course.id'}.'.num'});
1.1359 raeburn 9524: } elsif ($env{'request.course.id'}) {
9525: my $expiretime=600;
9526: if ((time-$env{'course.'.$env{'request.course.id'}.'.last_cache'}) > $expiretime) {
9527: &Apache::lonnet::coursedescription($env{'request.course.id'},{'freshen_cache' => 1});
9528: }
9529: my ($deeplinkmenu,$menuref);
9530: ($menucoll,$deeplinkmenu,$menuref) = &menucoll_in_effect();
9531: if ($menucoll) {
9532: if (ref($menuref) eq 'HASH') {
9533: %menu = %{$menuref};
9534: }
9535: if ($menu{'top'} eq 'n') {
9536: $args->{'no_primary_menu'} = 1;
9537: }
9538: if ($menu{'inline'} eq 'n') {
9539: unless (&Apache::lonnet::allowed('opa')) {
9540: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9541: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
9542: my $crstype = &course_type();
9543: my $now = time;
9544: my $ccrole;
9545: if ($crstype eq 'Community') {
9546: $ccrole = 'co';
9547: } else {
9548: $ccrole = 'cc';
9549: }
9550: if ($env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum}) {
9551: my ($start,$end) = split(/\./,$env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum});
9552: if ((($start) && ($start<0)) ||
9553: (($end) && ($end<$now)) ||
9554: (($start) && ($now<$start))) {
9555: $args->{'no_inline_menu'} = 1;
9556: }
9557: } else {
9558: $args->{'no_inline_menu'} = 1;
9559: }
9560: }
9561: }
9562: }
1.1316 raeburn 9563: }
1.1359 raeburn 9564:
1.1385 raeburn 9565: my $showncrumbs;
1.338 albertel 9566: if (! exists($args->{'skip_phases'}{'body'}) ) {
9567: if ($args->{'frameset'}) {
9568: my $attr_string = &make_attr_string($args->{'force_register'},
9569: $args->{'add_entries'});
9570: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 9571: } else {
9572: $result .=
9573: &bodytag($title,
9574: $args->{'function'}, $args->{'add_entries'},
9575: $args->{'only_body'}, $args->{'domain'},
9576: $args->{'force_register'}, $args->{'no_nav_bar'},
1.1096 raeburn 9577: $args->{'bgcolor'}, $args,
1.1385 raeburn 9578: \@advtools,$ltiscope,$ltiuri,\%ltimenu,$menucoll,
9579: \%menu,\$showncrumbs);
1.831 bisitz 9580: }
1.330 albertel 9581: }
1.338 albertel 9582:
1.315 albertel 9583: if ($args->{'js_ready'}) {
1.713 kaisler 9584: $result = &js_ready($result);
1.315 albertel 9585: }
1.320 albertel 9586: if ($args->{'html_encode'}) {
1.713 kaisler 9587: $result = &html_encode($result);
9588: }
9589:
1.813 bisitz 9590: # Preparation for new and consistent functionlist at top of screen
9591: # if ($args->{'functionlist'}) {
9592: # $result .= &build_functionlist();
9593: #}
9594:
1.964 droeschl 9595: # Don't add anything more if only_body wanted or in const space
9596: return $result if $args->{'only_body'}
9597: || $env{'request.state'} eq 'construct';
1.813 bisitz 9598:
9599: #Breadcrumbs
1.758 kaisler 9600: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
1.1385 raeburn 9601: unless ($showncrumbs) {
1.758 kaisler 9602: &Apache::lonhtmlcommon::clear_breadcrumbs();
9603: #if any br links exists, add them to the breadcrumbs
9604: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
9605: foreach my $crumb (@{$args->{'bread_crumbs'}}){
9606: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
9607: }
9608: }
1.1096 raeburn 9609: # if @advtools array contains items add then to the breadcrumbs
9610: if (@advtools > 0) {
9611: &Apache::lonmenu::advtools_crumbs(@advtools);
9612: }
1.1272 raeburn 9613: my $menulink;
9614: # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
9615: if ((exists($args->{'bread_crumbs_nomenu'})) ||
1.1312 raeburn 9616: ($ltiscope eq 'map') || ($ltiscope eq 'resource') ||
1.1272 raeburn 9617: ((($args->{'crstype'} eq 'Placement') || (($env{'request.course.id'}) &&
9618: ($env{'course.'.$env{'request.course.id'}.'.type'} eq 'Placement'))) &&
9619: (!$env{'request.role.adv'}))) {
9620: $menulink = 0;
9621: } else {
9622: undef($menulink);
9623: }
1.1385 raeburn 9624: my $linkprotout;
9625: if ($env{'request.deeplink.login'}) {
9626: my $linkprotout = &Apache::lonmenu::linkprot_exit();
9627: if ($linkprotout) {
9628: &Apache::lonhtmlcommon::add_breadcrumb_tool('tools',$linkprotout);
9629: }
9630: }
1.758 kaisler 9631: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
9632: if(exists($args->{'bread_crumbs_component'})){
1.1272 raeburn 9633: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},'',$menulink);
1.1237 raeburn 9634: } else {
1.1272 raeburn 9635: $result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink);
1.758 kaisler 9636: }
1.1385 raeburn 9637: }
1.320 albertel 9638: }
1.315 albertel 9639: return $result;
1.306 albertel 9640: }
9641:
9642: sub end_page {
1.315 albertel 9643: my ($args) = @_;
9644: $env{'internal.end_page'}++;
1.330 albertel 9645: my $result;
1.335 albertel 9646: if ($args->{'discussion'}) {
9647: my ($target,$parser);
9648: if (ref($args->{'discussion'})) {
9649: ($target,$parser) =($args->{'discussion'}{'target'},
9650: $args->{'discussion'}{'parser'});
9651: }
9652: $result .= &Apache::lonxml::xmlend($target,$parser);
9653: }
1.330 albertel 9654: if ($args->{'frameset'}) {
9655: $result .= '</frameset>';
9656: } else {
1.635 raeburn 9657: $result .= &endbodytag($args);
1.330 albertel 9658: }
1.1080 raeburn 9659: unless ($args->{'notbody'}) {
9660: $result .= "\n</html>";
9661: }
1.330 albertel 9662:
1.315 albertel 9663: if ($args->{'js_ready'}) {
1.317 albertel 9664: $result = &js_ready($result);
1.315 albertel 9665: }
1.335 albertel 9666:
1.320 albertel 9667: if ($args->{'html_encode'}) {
9668: $result = &html_encode($result);
9669: }
1.335 albertel 9670:
1.315 albertel 9671: return $result;
9672: }
9673:
1.1359 raeburn 9674: sub menucoll_in_effect {
9675: my ($menucoll,$deeplinkmenu,%menu);
9676: if ($env{'request.course.id'}) {
9677: $menucoll = $env{'course.'.$env{'request.course.id'}.'.menudefault'};
1.1362 raeburn 9678: if ($env{'request.deeplink.login'}) {
1.1370 raeburn 9679: my ($deeplink_symb,$deeplink,$check_login_symb);
1.1362 raeburn 9680: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
9681: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9682: if ($env{'request.noversionuri'} =~ m{^/(res|uploaded)/}) {
9683: if ($env{'request.noversionuri'} =~ /\.(page|sequence)$/) {
9684: my $navmap = Apache::lonnavmaps::navmap->new();
9685: if (ref($navmap)) {
9686: $deeplink = $navmap->get_mapparam(undef,
9687: &Apache::lonnet::declutter($env{'request.noversionuri'}),
9688: '0.deeplink');
1.1370 raeburn 9689: } else {
9690: $check_login_symb = 1;
1.1362 raeburn 9691: }
9692: } else {
1.1370 raeburn 9693: my $symb = &Apache::lonnet::symbread();
9694: if ($symb) {
9695: $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$symb);
9696: } else {
9697: $check_login_symb = 1;
9698: }
1.1362 raeburn 9699: }
9700: } else {
1.1370 raeburn 9701: $check_login_symb = 1;
9702: }
9703: if ($check_login_symb) {
1.1362 raeburn 9704: $deeplink_symb = &deeplink_login_symb($cnum,$cdom);
9705: if ($deeplink_symb =~ /\.(page|sequence)$/) {
9706: my $mapname = &Apache::lonnet::deversion((&Apache::lonnet::decode_symb($deeplink_symb))[2]);
9707: my $navmap = Apache::lonnavmaps::navmap->new();
9708: if (ref($navmap)) {
9709: $deeplink = $navmap->get_mapparam(undef,$mapname,'0.deeplink');
9710: }
9711: } else {
9712: $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$deeplink_symb);
9713: }
9714: }
1.1359 raeburn 9715: if ($deeplink ne '') {
1.1378 raeburn 9716: my ($state,$others,$listed,$scope,$protect,$display,$target) = split(/,/,$deeplink);
1.1359 raeburn 9717: if ($display =~ /^\d+$/) {
9718: $deeplinkmenu = 1;
9719: $menucoll = $display;
9720: }
9721: }
9722: }
9723: if ($menucoll) {
9724: %menu = &page_menu($env{'course.'.$env{'request.course.id'}.'.menucollections'},$menucoll);
9725: }
9726: }
9727: return ($menucoll,$deeplinkmenu,\%menu);
9728: }
9729:
1.1362 raeburn 9730: sub deeplink_login_symb {
9731: my ($cnum,$cdom) = @_;
9732: my $login_symb;
9733: if ($env{'request.deeplink.login'}) {
1.1364 raeburn 9734: $login_symb = &symb_from_tinyurl($env{'request.deeplink.login'},$cnum,$cdom);
9735: }
9736: return $login_symb;
9737: }
9738:
9739: sub symb_from_tinyurl {
9740: my ($url,$cnum,$cdom) = @_;
9741: if ($url =~ m{^\Q/tiny/$cdom/\E(\w+)$}) {
9742: my $key = $1;
9743: my ($tinyurl,$login);
9744: my ($result,$cached)=&Apache::lonnet::is_cached_new('tiny',$cdom."\0".$key);
9745: if (defined($cached)) {
9746: $tinyurl = $result;
9747: } else {
9748: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
9749: my %currtiny = &Apache::lonnet::get('tiny',[$key],$cdom,$configuname);
9750: if ($currtiny{$key} ne '') {
9751: $tinyurl = $currtiny{$key};
9752: &Apache::lonnet::do_cache_new('tiny',$cdom."\0".$key,$currtiny{$key},600);
1.1362 raeburn 9753: }
1.1364 raeburn 9754: }
9755: if ($tinyurl ne '') {
9756: my ($cnumreq,$symb) = split(/\&/,$tinyurl);
9757: if (wantarray) {
9758: return ($cnumreq,$symb);
9759: } elsif ($cnumreq eq $cnum) {
9760: return $symb;
1.1362 raeburn 9761: }
9762: }
9763: }
1.1364 raeburn 9764: if (wantarray) {
9765: return ();
9766: } else {
9767: return;
9768: }
1.1362 raeburn 9769: }
9770:
1.1405 raeburn 9771: sub usable_exttools {
9772: my %tooltypes;
9773: if ($env{'request.course.id'}) {
9774: if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'}) {
9775: if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'both') {
9776: %tooltypes = (
9777: crs => 1,
9778: dom => 1,
9779: );
9780: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'crs') {
9781: $tooltypes{'crs'} = 1;
9782: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'dom') {
9783: $tooltypes{'dom'} = 1;
9784: }
9785: } else {
9786: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9787: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
9788: my $crstype = lc($env{'course.'.$env{'request.course.id'}.'.type'});
9789: if ($crstype eq '') {
9790: $crstype = 'course';
9791: }
9792: if ($crstype eq 'course') {
9793: if ($env{'course.'.$env{'request.course.id'}.'internal.coursecode'}) {
9794: $crstype = 'official';
9795: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.textbook'}) {
9796: $crstype = 'textbook';
9797: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.lti'}) {
9798: $crstype = 'lti';
9799: } else {
9800: $crstype = 'unofficial';
9801: }
9802: }
9803: my %domdefaults = &Apache::lonnet::get_domain_defaults($cdom);
9804: if ($domdefaults{$crstype.'domexttool'}) {
9805: $tooltypes{'dom'} = 1;
9806: }
9807: if ($domdefaults{$crstype.'exttool'}) {
9808: $tooltypes{'crs'} = 1;
9809: }
9810: }
9811: }
9812: return %tooltypes;
9813: }
9814:
1.1034 www 9815: sub wishlist_window {
9816: return(<<'ENDWISHLIST');
1.1046 raeburn 9817: <script type="text/javascript">
1.1034 www 9818: // <![CDATA[
9819: // <!-- BEGIN LON-CAPA Internal
9820: function set_wishlistlink(title, path) {
9821: if (!title) {
9822: title = document.title;
9823: title = title.replace(/^LON-CAPA /,'');
9824: }
1.1175 raeburn 9825: title = encodeURIComponent(title);
1.1203 raeburn 9826: title = title.replace("'","\\\'");
1.1034 www 9827: if (!path) {
9828: path = location.pathname;
9829: }
1.1175 raeburn 9830: path = encodeURIComponent(path);
1.1203 raeburn 9831: path = path.replace("'","\\\'");
1.1034 www 9832: Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
9833: 'wishlistNewLink','width=560,height=350,scrollbars=0');
9834: }
9835: // END LON-CAPA Internal -->
9836: // ]]>
9837: </script>
9838: ENDWISHLIST
9839: }
9840:
1.1030 www 9841: sub modal_window {
9842: return(<<'ENDMODAL');
1.1046 raeburn 9843: <script type="text/javascript">
1.1030 www 9844: // <![CDATA[
9845: // <!-- BEGIN LON-CAPA Internal
9846: var modalWindow = {
9847: parent:"body",
9848: windowId:null,
9849: content:null,
9850: width:null,
9851: height:null,
9852: close:function()
9853: {
9854: $(".LCmodal-window").remove();
9855: $(".LCmodal-overlay").remove();
9856: },
9857: open:function()
9858: {
9859: var modal = "";
9860: modal += "<div class=\"LCmodal-overlay\"></div>";
9861: 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;\">";
9862: modal += this.content;
9863: modal += "</div>";
9864:
9865: $(this.parent).append(modal);
9866:
9867: $(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
9868: $(".LCclose-window").click(function(){modalWindow.close();});
9869: $(".LCmodal-overlay").click(function(){modalWindow.close();});
9870: }
9871: };
1.1140 raeburn 9872: var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030 www 9873: {
1.1266 raeburn 9874: source = source.replace(/'/g,"'");
1.1030 www 9875: modalWindow.windowId = "myModal";
9876: modalWindow.width = width;
9877: modalWindow.height = height;
1.1196 raeburn 9878: modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030 www 9879: modalWindow.open();
1.1208 raeburn 9880: };
1.1030 www 9881: // END LON-CAPA Internal -->
9882: // ]]>
9883: </script>
9884: ENDMODAL
9885: }
9886:
9887: sub modal_link {
1.1140 raeburn 9888: my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030 www 9889: unless ($width) { $width=480; }
9890: unless ($height) { $height=400; }
1.1031 www 9891: unless ($scrolling) { $scrolling='yes'; }
1.1140 raeburn 9892: unless ($transparency) { $transparency='true'; }
9893:
1.1074 raeburn 9894: my $target_attr;
9895: if (defined($target)) {
9896: $target_attr = 'target="'.$target.'"';
9897: }
9898: return <<"ENDLINK";
1.1336 raeburn 9899: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">$linktext</a>
1.1074 raeburn 9900: ENDLINK
1.1030 www 9901: }
9902:
1.1032 www 9903: sub modal_adhoc_script {
1.1365 raeburn 9904: my ($funcname,$width,$height,$content,$possmathjax)=@_;
9905: my $mathjax;
9906: if ($possmathjax) {
9907: $mathjax = <<'ENDJAX';
9908: if (typeof MathJax == 'object') {
9909: MathJax.Hub.Queue(["Typeset",MathJax.Hub]);
9910: }
9911: ENDJAX
9912: }
1.1032 www 9913: return (<<ENDADHOC);
1.1046 raeburn 9914: <script type="text/javascript">
1.1032 www 9915: // <![CDATA[
9916: var $funcname = function()
9917: {
9918: modalWindow.windowId = "myModal";
9919: modalWindow.width = $width;
9920: modalWindow.height = $height;
9921: modalWindow.content = '$content';
9922: modalWindow.open();
1.1365 raeburn 9923: $mathjax
1.1032 www 9924: };
9925: // ]]>
9926: </script>
9927: ENDADHOC
9928: }
9929:
1.1041 www 9930: sub modal_adhoc_inner {
1.1365 raeburn 9931: my ($funcname,$width,$height,$content,$possmathjax)=@_;
1.1041 www 9932: my $innerwidth=$width-20;
9933: $content=&js_ready(
1.1140 raeburn 9934: &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
9935: &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
9936: $content.
1.1041 www 9937: &end_scrollbox().
1.1140 raeburn 9938: &end_page()
1.1041 www 9939: );
1.1365 raeburn 9940: return &modal_adhoc_script($funcname,$width,$height,$content,$possmathjax);
1.1041 www 9941: }
9942:
9943: sub modal_adhoc_window {
1.1365 raeburn 9944: my ($funcname,$width,$height,$content,$linktext,$possmathjax)=@_;
9945: return &modal_adhoc_inner($funcname,$width,$height,$content,$possmathjax).
1.1041 www 9946: "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
9947: }
9948:
9949: sub modal_adhoc_launch {
9950: my ($funcname,$width,$height,$content)=@_;
9951: return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
9952: <script type="text/javascript">
9953: // <![CDATA[
9954: $funcname();
9955: // ]]>
9956: </script>
9957: ENDLAUNCH
9958: }
9959:
9960: sub modal_adhoc_close {
9961: return (<<ENDCLOSE);
9962: <script type="text/javascript">
9963: // <![CDATA[
9964: modalWindow.close();
9965: // ]]>
9966: </script>
9967: ENDCLOSE
9968: }
9969:
1.1038 www 9970: sub togglebox_script {
9971: return(<<ENDTOGGLE);
9972: <script type="text/javascript">
9973: // <![CDATA[
9974: function LCtoggleDisplay(id,hidetext,showtext) {
9975: link = document.getElementById(id + "link").childNodes[0];
9976: with (document.getElementById(id).style) {
9977: if (display == "none" ) {
9978: display = "inline";
9979: link.nodeValue = hidetext;
9980: } else {
9981: display = "none";
9982: link.nodeValue = showtext;
9983: }
9984: }
9985: }
9986: // ]]>
9987: </script>
9988: ENDTOGGLE
9989: }
9990:
1.1039 www 9991: sub start_togglebox {
9992: my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
9993: unless ($heading) { $heading=''; } else { $heading.=' '; }
9994: unless ($showtext) { $showtext=&mt('show'); }
9995: unless ($hidetext) { $hidetext=&mt('hide'); }
9996: unless ($headerbg) { $headerbg='#FFFFFF'; }
9997: return &start_data_table().
9998: &start_data_table_header_row().
9999: '<td bgcolor="'.$headerbg.'">'.$heading.
10000: '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
10001: $showtext.'\')">'.$showtext.'</a>]</td>'.
10002: &end_data_table_header_row().
10003: '<tr id="'.$id.'" style="display:none""><td>';
10004: }
10005:
10006: sub end_togglebox {
10007: return '</td></tr>'.&end_data_table();
10008: }
10009:
1.1041 www 10010: sub LCprogressbar_script {
1.1302 raeburn 10011: my ($id,$number_to_do)=@_;
10012: if ($number_to_do) {
10013: return(<<ENDPROGRESS);
1.1041 www 10014: <script type="text/javascript">
10015: // <![CDATA[
1.1045 www 10016: \$('#progressbar$id').progressbar({
1.1041 www 10017: value: 0,
10018: change: function(event, ui) {
10019: var newVal = \$(this).progressbar('option', 'value');
10020: \$('.pblabel', this).text(LCprogressTxt);
10021: }
10022: });
10023: // ]]>
10024: </script>
10025: ENDPROGRESS
1.1302 raeburn 10026: } else {
10027: return(<<ENDPROGRESS);
10028: <script type="text/javascript">
10029: // <![CDATA[
10030: \$('#progressbar$id').progressbar({
10031: value: false,
10032: create: function(event, ui) {
10033: \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
10034: \$('.ui-progressbar-overlay', this).css({'margin':'0'});
10035: }
10036: });
10037: // ]]>
10038: </script>
10039: ENDPROGRESS
10040: }
1.1041 www 10041: }
10042:
10043: sub LCprogressbarUpdate_script {
10044: return(<<ENDPROGRESSUPDATE);
10045: <style type="text/css">
10046: .ui-progressbar { position:relative; }
1.1302 raeburn 10047: .progress-label {position: absolute; width: 100%; text-align: center; top: 1px; font-weight: bold; text-shadow: 1px 1px 0 #fff;margin: 0; line-height: 200%; }
1.1041 www 10048: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
10049: </style>
10050: <script type="text/javascript">
10051: // <![CDATA[
1.1045 www 10052: var LCprogressTxt='---';
10053:
1.1302 raeburn 10054: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041 www 10055: LCprogressTxt=progresstext;
1.1302 raeburn 10056: if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
10057: \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
10058: } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
1.1301 raeburn 10059: \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
10060: } else {
10061: \$('#progressbar'+id).progressbar('value',percent);
10062: }
1.1041 www 10063: }
10064: // ]]>
10065: </script>
10066: ENDPROGRESSUPDATE
10067: }
10068:
1.1042 www 10069: my $LClastpercent;
1.1045 www 10070: my $LCidcnt;
10071: my $LCcurrentid;
1.1042 www 10072:
1.1041 www 10073: sub LCprogressbar {
1.1302 raeburn 10074: my ($r,$number_to_do,$preamble)=@_;
1.1042 www 10075: $LClastpercent=0;
1.1045 www 10076: $LCidcnt++;
10077: $LCcurrentid=$$.'_'.$LCidcnt;
1.1302 raeburn 10078: my ($starting,$content);
10079: if ($number_to_do) {
10080: $starting=&mt('Starting');
10081: $content=(<<ENDPROGBAR);
10082: $preamble
1.1045 www 10083: <div id="progressbar$LCcurrentid">
1.1041 www 10084: <span class="pblabel">$starting</span>
10085: </div>
10086: ENDPROGBAR
1.1302 raeburn 10087: } else {
10088: $starting=&mt('Loading...');
10089: $LClastpercent='false';
10090: $content=(<<ENDPROGBAR);
10091: $preamble
10092: <div id="progressbar$LCcurrentid">
10093: <div class="progress-label">$starting</div>
10094: </div>
10095: ENDPROGBAR
10096: }
10097: &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041 www 10098: }
10099:
10100: sub LCprogressbarUpdate {
1.1302 raeburn 10101: my ($r,$val,$text,$number_to_do)=@_;
10102: if ($number_to_do) {
10103: unless ($val) {
10104: if ($LClastpercent) {
10105: $val=$LClastpercent;
10106: } else {
10107: $val=0;
10108: }
10109: }
10110: if ($val<0) { $val=0; }
10111: if ($val>100) { $val=0; }
10112: $LClastpercent=$val;
10113: unless ($text) { $text=$val.'%'; }
10114: } else {
10115: $val = 'false';
1.1042 www 10116: }
1.1041 www 10117: $text=&js_ready($text);
1.1044 www 10118: &r_print($r,<<ENDUPDATE);
1.1041 www 10119: <script type="text/javascript">
10120: // <![CDATA[
1.1302 raeburn 10121: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041 www 10122: // ]]>
10123: </script>
10124: ENDUPDATE
1.1035 www 10125: }
10126:
1.1042 www 10127: sub LCprogressbarClose {
10128: my ($r)=@_;
10129: $LClastpercent=0;
1.1044 www 10130: &r_print($r,<<ENDCLOSE);
1.1042 www 10131: <script type="text/javascript">
10132: // <![CDATA[
1.1045 www 10133: \$("#progressbar$LCcurrentid").hide('slow');
1.1042 www 10134: // ]]>
10135: </script>
10136: ENDCLOSE
1.1044 www 10137: }
10138:
10139: sub r_print {
10140: my ($r,$to_print)=@_;
10141: if ($r) {
10142: $r->print($to_print);
10143: $r->rflush();
10144: } else {
10145: print($to_print);
10146: }
1.1042 www 10147: }
10148:
1.320 albertel 10149: sub html_encode {
10150: my ($result) = @_;
10151:
1.322 albertel 10152: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 10153:
10154: return $result;
10155: }
1.1044 www 10156:
1.317 albertel 10157: sub js_ready {
10158: my ($result) = @_;
10159:
1.323 albertel 10160: $result =~ s/[\n\r]/ /xmsg;
10161: $result =~ s/\\/\\\\/xmsg;
10162: $result =~ s/'/\\'/xmsg;
1.372 albertel 10163: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 10164:
10165: return $result;
10166: }
10167:
1.315 albertel 10168: sub validate_page {
10169: if ( exists($env{'internal.start_page'})
1.316 albertel 10170: && $env{'internal.start_page'} > 1) {
10171: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 10172: $env{'internal.start_page'}.' '.
1.316 albertel 10173: $ENV{'request.filename'});
1.315 albertel 10174: }
10175: if ( exists($env{'internal.end_page'})
1.316 albertel 10176: && $env{'internal.end_page'} > 1) {
10177: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 10178: $env{'internal.end_page'}.' '.
1.316 albertel 10179: $env{'request.filename'});
1.315 albertel 10180: }
10181: if ( exists($env{'internal.start_page'})
10182: && ! exists($env{'internal.end_page'})) {
1.316 albertel 10183: &Apache::lonnet::logthis('start_page called without end_page '.
10184: $env{'request.filename'});
1.315 albertel 10185: }
10186: if ( ! exists($env{'internal.start_page'})
10187: && exists($env{'internal.end_page'})) {
1.316 albertel 10188: &Apache::lonnet::logthis('end_page called without start_page'.
10189: $env{'request.filename'});
1.315 albertel 10190: }
1.306 albertel 10191: }
1.315 albertel 10192:
1.996 www 10193:
10194: sub start_scrollbox {
1.1140 raeburn 10195: my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998 raeburn 10196: unless ($outerwidth) { $outerwidth='520px'; }
10197: unless ($width) { $width='500px'; }
10198: unless ($height) { $height='200px'; }
1.1075 raeburn 10199: my ($table_id,$div_id,$tdcol);
1.1018 raeburn 10200: if ($id ne '') {
1.1140 raeburn 10201: $table_id = ' id="table_'.$id.'"';
1.1137 raeburn 10202: $div_id = ' id="div_'.$id.'"';
1.1018 raeburn 10203: }
1.1075 raeburn 10204: if ($bgcolor ne '') {
10205: $tdcol = "background-color: $bgcolor;";
10206: }
1.1137 raeburn 10207: my $nicescroll_js;
10208: if ($env{'browser.mobile'}) {
1.1140 raeburn 10209: $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
10210: }
10211: return <<"END";
10212: $nicescroll_js
10213:
10214: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
10215: <div style="overflow:auto; width:$width; height:$height;"$div_id>
10216: END
10217: }
10218:
10219: sub end_scrollbox {
10220: return '</div></td></tr></table>';
10221: }
10222:
10223: sub nicescroll_javascript {
10224: my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
10225: my %options;
10226: if (ref($cursor) eq 'HASH') {
10227: %options = %{$cursor};
10228: }
10229: unless ($options{'railalign'} =~ /^left|right$/) {
10230: $options{'railalign'} = 'left';
10231: }
10232: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
10233: my $function = &get_users_function();
10234: $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
1.1138 raeburn 10235: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
1.1140 raeburn 10236: $options{'cursorcolor'} = '#00F';
1.1138 raeburn 10237: }
1.1140 raeburn 10238: }
10239: if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
10240: unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
1.1138 raeburn 10241: $options{'cursoropacity'}='1.0';
10242: }
1.1140 raeburn 10243: } else {
10244: $options{'cursoropacity'}='1.0';
10245: }
10246: if ($options{'cursorfixedheight'} eq 'none') {
10247: delete($options{'cursorfixedheight'});
10248: } else {
10249: unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
10250: }
10251: unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
10252: delete($options{'railoffset'});
10253: }
10254: my @niceoptions;
10255: while (my($key,$value) = each(%options)) {
10256: if ($value =~ /^\{.+\}$/) {
10257: push(@niceoptions,$key.':'.$value);
1.1138 raeburn 10258: } else {
1.1140 raeburn 10259: push(@niceoptions,$key.':"'.$value.'"');
1.1138 raeburn 10260: }
1.1140 raeburn 10261: }
10262: my $nicescroll_js = '
1.1137 raeburn 10263: $(document).ready(
1.1140 raeburn 10264: function() {
10265: $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
10266: }
1.1137 raeburn 10267: );
10268: ';
1.1140 raeburn 10269: if ($framecheck) {
10270: $nicescroll_js .= '
10271: function expand_div(caller) {
10272: if (top === self) {
10273: document.getElementById("'.$id.'").style.width = "auto";
10274: document.getElementById("'.$id.'").style.height = "auto";
10275: } else {
10276: try {
10277: if (parent.frames) {
10278: if (parent.frames.length > 1) {
10279: var framesrc = parent.frames[1].location.href;
10280: var currsrc = framesrc.replace(/\#.*$/,"");
10281: if ((caller == "search") || (currsrc == "'.$location.'")) {
10282: document.getElementById("'.$id.'").style.width = "auto";
10283: document.getElementById("'.$id.'").style.height = "auto";
10284: }
10285: }
10286: }
10287: } catch (e) {
10288: return;
10289: }
1.1137 raeburn 10290: }
1.1140 raeburn 10291: return;
1.996 www 10292: }
1.1140 raeburn 10293: ';
10294: }
10295: if ($needjsready) {
10296: $nicescroll_js = '
10297: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
10298: } else {
10299: $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
10300: }
10301: return $nicescroll_js;
1.996 www 10302: }
10303:
1.318 albertel 10304: sub simple_error_page {
1.1150 bisitz 10305: my ($r,$title,$msg,$args) = @_;
1.1304 raeburn 10306: my %displayargs;
1.1151 raeburn 10307: if (ref($args) eq 'HASH') {
10308: if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
1.1304 raeburn 10309: if ($args->{'only_body'}) {
10310: $displayargs{'only_body'} = 1;
10311: }
10312: if ($args->{'no_nav_bar'}) {
10313: $displayargs{'no_nav_bar'} = 1;
10314: }
1.1151 raeburn 10315: } else {
10316: $msg = &mt($msg);
10317: }
1.1150 bisitz 10318:
1.318 albertel 10319: my $page =
1.1304 raeburn 10320: &Apache::loncommon::start_page($title,'',\%displayargs).
1.1150 bisitz 10321: '<p class="LC_error">'.$msg.'</p>'.
1.318 albertel 10322: &Apache::loncommon::end_page();
10323: if (ref($r)) {
10324: $r->print($page);
1.327 albertel 10325: return;
1.318 albertel 10326: }
10327: return $page;
10328: }
1.347 albertel 10329:
10330: {
1.610 albertel 10331: my @row_count;
1.961 onken 10332:
10333: sub start_data_table_count {
10334: unshift(@row_count, 0);
10335: return;
10336: }
10337:
10338: sub end_data_table_count {
10339: shift(@row_count);
10340: return;
10341: }
10342:
1.347 albertel 10343: sub start_data_table {
1.1018 raeburn 10344: my ($add_class,$id) = @_;
1.422 albertel 10345: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 10346: my $table_id;
10347: if (defined($id)) {
10348: $table_id = ' id="'.$id.'"';
10349: }
1.961 onken 10350: &start_data_table_count();
1.1018 raeburn 10351: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 10352: }
10353:
10354: sub end_data_table {
1.961 onken 10355: &end_data_table_count();
1.389 albertel 10356: return '</table>'."\n";;
1.347 albertel 10357: }
10358:
10359: sub start_data_table_row {
1.974 wenzelju 10360: my ($add_class, $id) = @_;
1.610 albertel 10361: $row_count[0]++;
10362: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 10363: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 10364: $id = (' id="'.$id.'"') unless ($id eq '');
10365: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 10366: }
1.471 banghart 10367:
10368: sub continue_data_table_row {
1.974 wenzelju 10369: my ($add_class, $id) = @_;
1.610 albertel 10370: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 10371: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
10372: $id = (' id="'.$id.'"') unless ($id eq '');
10373: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 10374: }
1.347 albertel 10375:
10376: sub end_data_table_row {
1.389 albertel 10377: return '</tr>'."\n";;
1.347 albertel 10378: }
1.367 www 10379:
1.421 albertel 10380: sub start_data_table_empty_row {
1.707 bisitz 10381: # $row_count[0]++;
1.421 albertel 10382: return '<tr class="LC_empty_row" >'."\n";;
10383: }
10384:
10385: sub end_data_table_empty_row {
10386: return '</tr>'."\n";;
10387: }
10388:
1.367 www 10389: sub start_data_table_header_row {
1.389 albertel 10390: return '<tr class="LC_header_row">'."\n";;
1.367 www 10391: }
10392:
10393: sub end_data_table_header_row {
1.389 albertel 10394: return '</tr>'."\n";;
1.367 www 10395: }
1.890 droeschl 10396:
10397: sub data_table_caption {
10398: my $caption = shift;
10399: return "<caption class=\"LC_caption\">$caption</caption>";
10400: }
1.347 albertel 10401: }
10402:
1.548 albertel 10403: =pod
10404:
10405: =item * &inhibit_menu_check($arg)
10406:
10407: Checks for a inhibitmenu state and generates output to preserve it
10408:
10409: Inputs: $arg - can be any of
10410: - undef - in which case the return value is a string
10411: to add into arguments list of a uri
10412: - 'input' - in which case the return value is a HTML
10413: <form> <input> field of type hidden to
10414: preserve the value
10415: - a url - in which case the return value is the url with
10416: the neccesary cgi args added to preserve the
10417: inhibitmenu state
10418: - a ref to a url - no return value, but the string is
10419: updated to include the neccessary cgi
10420: args to preserve the inhibitmenu state
10421:
10422: =cut
10423:
10424: sub inhibit_menu_check {
10425: my ($arg) = @_;
10426: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
10427: if ($arg eq 'input') {
10428: if ($env{'form.inhibitmenu'}) {
10429: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
10430: } else {
10431: return
10432: }
10433: }
10434: if ($env{'form.inhibitmenu'}) {
10435: if (ref($arg)) {
10436: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
10437: } elsif ($arg eq '') {
10438: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
10439: } else {
10440: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
10441: }
10442: }
10443: if (!ref($arg)) {
10444: return $arg;
10445: }
10446: }
10447:
1.251 albertel 10448: ###############################################
1.182 matthew 10449:
10450: =pod
10451:
1.549 albertel 10452: =back
10453:
10454: =head1 User Information Routines
10455:
10456: =over 4
10457:
1.405 albertel 10458: =item * &get_users_function()
1.182 matthew 10459:
10460: Used by &bodytag to determine the current users primary role.
10461: Returns either 'student','coordinator','admin', or 'author'.
10462:
10463: =cut
10464:
10465: ###############################################
10466: sub get_users_function {
1.815 tempelho 10467: my $function = 'norole';
1.818 tempelho 10468: if ($env{'request.role'}=~/^(st)/) {
10469: $function='student';
10470: }
1.907 raeburn 10471: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 10472: $function='coordinator';
10473: }
1.258 albertel 10474: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 10475: $function='admin';
10476: }
1.826 bisitz 10477: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025 raeburn 10478: ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182 matthew 10479: $function='author';
10480: }
10481: return $function;
1.54 www 10482: }
1.99 www 10483:
10484: ###############################################
10485:
1.233 raeburn 10486: =pod
10487:
1.821 raeburn 10488: =item * &show_course()
10489:
10490: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
10491: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
10492:
10493: Inputs:
10494: None
10495:
10496: Outputs:
10497: Scalar: 1 if 'Course' to be used, 0 otherwise.
10498:
10499: =cut
10500:
10501: ###############################################
10502: sub show_course {
10503: my $course = !$env{'user.adv'};
10504: if (!$env{'user.adv'}) {
10505: foreach my $env (keys(%env)) {
10506: next if ($env !~ m/^user\.priv\./);
10507: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
10508: $course = 0;
10509: last;
10510: }
10511: }
10512: }
10513: return $course;
10514: }
10515:
10516: ###############################################
10517:
10518: =pod
10519:
1.542 raeburn 10520: =item * &check_user_status()
1.274 raeburn 10521:
10522: Determines current status of supplied role for a
10523: specific user. Roles can be active, previous or future.
10524:
10525: Inputs:
10526: user's domain, user's username, course's domain,
1.375 raeburn 10527: course's number, optional section ID.
1.274 raeburn 10528:
10529: Outputs:
10530: role status: active, previous or future.
10531:
10532: =cut
10533:
10534: sub check_user_status {
1.412 raeburn 10535: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073 raeburn 10536: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1202 raeburn 10537: my @uroles = keys(%userinfo);
1.274 raeburn 10538: my $srchstr;
10539: my $active_chk = 'none';
1.412 raeburn 10540: my $now = time;
1.274 raeburn 10541: if (@uroles > 0) {
1.908 raeburn 10542: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 10543: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
10544: } else {
1.412 raeburn 10545: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
10546: }
10547: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 10548: my $role_end = 0;
10549: my $role_start = 0;
10550: $active_chk = 'active';
1.412 raeburn 10551: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
10552: $role_end = $1;
10553: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
10554: $role_start = $1;
1.274 raeburn 10555: }
10556: }
10557: if ($role_start > 0) {
1.412 raeburn 10558: if ($now < $role_start) {
1.274 raeburn 10559: $active_chk = 'future';
10560: }
10561: }
10562: if ($role_end > 0) {
1.412 raeburn 10563: if ($now > $role_end) {
1.274 raeburn 10564: $active_chk = 'previous';
10565: }
10566: }
10567: }
10568: }
10569: return $active_chk;
10570: }
10571:
10572: ###############################################
10573:
10574: =pod
10575:
1.405 albertel 10576: =item * &get_sections()
1.233 raeburn 10577:
10578: Determines all the sections for a course including
10579: sections with students and sections containing other roles.
1.419 raeburn 10580: Incoming parameters:
10581:
10582: 1. domain
10583: 2. course number
10584: 3. reference to array containing roles for which sections should
10585: be gathered (optional).
10586: 4. reference to array containing status types for which sections
10587: should be gathered (optional).
10588:
10589: If the third argument is undefined, sections are gathered for any role.
10590: If the fourth argument is undefined, sections are gathered for any status.
10591: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 10592:
1.374 raeburn 10593: Returns section hash (keys are section IDs, values are
10594: number of users in each section), subject to the
1.419 raeburn 10595: optional roles filter, optional status filter
1.233 raeburn 10596:
10597: =cut
10598:
10599: ###############################################
10600: sub get_sections {
1.419 raeburn 10601: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 10602: if (!defined($cdom) || !defined($cnum)) {
10603: my $cid = $env{'request.course.id'};
10604:
10605: return if (!defined($cid));
10606:
10607: $cdom = $env{'course.'.$cid.'.domain'};
10608: $cnum = $env{'course.'.$cid.'.num'};
10609: }
10610:
10611: my %sectioncount;
1.419 raeburn 10612: my $now = time;
1.240 albertel 10613:
1.1118 raeburn 10614: my $check_students = 1;
10615: my $only_students = 0;
10616: if (ref($possible_roles) eq 'ARRAY') {
10617: if (grep(/^st$/,@{$possible_roles})) {
10618: if (@{$possible_roles} == 1) {
10619: $only_students = 1;
10620: }
10621: } else {
10622: $check_students = 0;
10623: }
10624: }
10625:
10626: if ($check_students) {
1.276 albertel 10627: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 10628: my $sec_index = &Apache::loncoursedata::CL_SECTION();
10629: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 10630: my $start_index = &Apache::loncoursedata::CL_START();
10631: my $end_index = &Apache::loncoursedata::CL_END();
10632: my $status;
1.366 albertel 10633: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 10634: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
10635: $data->[$status_index],
10636: $data->[$start_index],
10637: $data->[$end_index]);
10638: if ($stu_status eq 'Active') {
10639: $status = 'active';
10640: } elsif ($end < $now) {
10641: $status = 'previous';
10642: } elsif ($start > $now) {
10643: $status = 'future';
10644: }
10645: if ($section ne '-1' && $section !~ /^\s*$/) {
10646: if ((!defined($possible_status)) || (($status ne '') &&
10647: (grep/^\Q$status\E$/,@{$possible_status}))) {
10648: $sectioncount{$section}++;
10649: }
1.240 albertel 10650: }
10651: }
10652: }
1.1118 raeburn 10653: if ($only_students) {
10654: return %sectioncount;
10655: }
1.240 albertel 10656: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
10657: foreach my $user (sort(keys(%courseroles))) {
10658: if ($user !~ /^(\w{2})/) { next; }
10659: my ($role) = ($user =~ /^(\w{2})/);
10660: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 10661: my ($section,$status);
1.240 albertel 10662: if ($role eq 'cr' &&
10663: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
10664: $section=$1;
10665: }
10666: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
10667: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 10668: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
10669: if ($end == -1 && $start == -1) {
10670: next; #deleted role
10671: }
10672: if (!defined($possible_status)) {
10673: $sectioncount{$section}++;
10674: } else {
10675: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
10676: $status = 'active';
10677: } elsif ($end < $now) {
10678: $status = 'future';
10679: } elsif ($start > $now) {
10680: $status = 'previous';
10681: }
10682: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
10683: $sectioncount{$section}++;
10684: }
10685: }
1.233 raeburn 10686: }
1.366 albertel 10687: return %sectioncount;
1.233 raeburn 10688: }
10689:
1.274 raeburn 10690: ###############################################
1.294 raeburn 10691:
10692: =pod
1.405 albertel 10693:
10694: =item * &get_course_users()
10695:
1.275 raeburn 10696: Retrieves usernames:domains for users in the specified course
10697: with specific role(s), and access status.
10698:
10699: Incoming parameters:
1.277 albertel 10700: 1. course domain
10701: 2. course number
10702: 3. access status: users must have - either active,
1.275 raeburn 10703: previous, future, or all.
1.277 albertel 10704: 4. reference to array of permissible roles
1.288 raeburn 10705: 5. reference to array of section restrictions (optional)
10706: 6. reference to results object (hash of hashes).
10707: 7. reference to optional userdata hash
1.609 raeburn 10708: 8. reference to optional statushash
1.630 raeburn 10709: 9. flag if privileged users (except those set to unhide in
10710: course settings) should be excluded
1.609 raeburn 10711: Keys of top level results hash are roles.
1.275 raeburn 10712: Keys of inner hashes are username:domain, with
10713: values set to access type.
1.288 raeburn 10714: Optional userdata hash returns an array with arguments in the
10715: same order as loncoursedata::get_classlist() for student data.
10716:
1.609 raeburn 10717: Optional statushash returns
10718:
1.288 raeburn 10719: Entries for end, start, section and status are blank because
10720: of the possibility of multiple values for non-student roles.
10721:
1.275 raeburn 10722: =cut
1.405 albertel 10723:
1.275 raeburn 10724: ###############################################
1.405 albertel 10725:
1.275 raeburn 10726: sub get_course_users {
1.630 raeburn 10727: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 10728: my %idx = ();
1.419 raeburn 10729: my %seclists;
1.288 raeburn 10730:
10731: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
10732: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
10733: $idx{end} = &Apache::loncoursedata::CL_END();
10734: $idx{start} = &Apache::loncoursedata::CL_START();
10735: $idx{id} = &Apache::loncoursedata::CL_ID();
10736: $idx{section} = &Apache::loncoursedata::CL_SECTION();
10737: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
10738: $idx{status} = &Apache::loncoursedata::CL_STATUS();
10739:
1.290 albertel 10740: if (grep(/^st$/,@{$roles})) {
1.276 albertel 10741: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 10742: my $now = time;
1.277 albertel 10743: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 10744: my $match = 0;
1.412 raeburn 10745: my $secmatch = 0;
1.419 raeburn 10746: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 10747: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 10748: if ($section eq '') {
10749: $section = 'none';
10750: }
1.291 albertel 10751: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 10752: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 10753: $secmatch = 1;
10754: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 10755: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 10756: $secmatch = 1;
10757: }
10758: } else {
1.419 raeburn 10759: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 10760: $secmatch = 1;
10761: }
1.290 albertel 10762: }
1.412 raeburn 10763: if (!$secmatch) {
10764: next;
10765: }
1.419 raeburn 10766: }
1.275 raeburn 10767: if (defined($$types{'active'})) {
1.288 raeburn 10768: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 10769: push(@{$$users{st}{$student}},'active');
1.288 raeburn 10770: $match = 1;
1.275 raeburn 10771: }
10772: }
10773: if (defined($$types{'previous'})) {
1.609 raeburn 10774: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 10775: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 10776: $match = 1;
1.275 raeburn 10777: }
10778: }
10779: if (defined($$types{'future'})) {
1.609 raeburn 10780: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 10781: push(@{$$users{st}{$student}},'future');
1.288 raeburn 10782: $match = 1;
1.275 raeburn 10783: }
10784: }
1.609 raeburn 10785: if ($match) {
10786: push(@{$seclists{$student}},$section);
10787: if (ref($userdata) eq 'HASH') {
10788: $$userdata{$student} = $$classlist{$student};
10789: }
10790: if (ref($statushash) eq 'HASH') {
10791: $statushash->{$student}{'st'}{$section} = $status;
10792: }
1.288 raeburn 10793: }
1.275 raeburn 10794: }
10795: }
1.412 raeburn 10796: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 10797: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
10798: my $now = time;
1.609 raeburn 10799: my %displaystatus = ( previous => 'Expired',
10800: active => 'Active',
10801: future => 'Future',
10802: );
1.1121 raeburn 10803: my (%nothide,@possdoms);
1.630 raeburn 10804: if ($hidepriv) {
10805: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
10806: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
10807: if ($user !~ /:/) {
10808: $nothide{join(':',split(/[\@]/,$user))}=1;
10809: } else {
10810: $nothide{$user} = 1;
10811: }
10812: }
1.1121 raeburn 10813: my @possdoms = ($cdom);
10814: if ($coursehash{'checkforpriv'}) {
10815: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
10816: }
1.630 raeburn 10817: }
1.439 raeburn 10818: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 10819: my $match = 0;
1.412 raeburn 10820: my $secmatch = 0;
1.439 raeburn 10821: my $status;
1.412 raeburn 10822: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 10823: $user =~ s/:$//;
1.439 raeburn 10824: my ($end,$start) = split(/:/,$coursepersonnel{$person});
10825: if ($end == -1 || $start == -1) {
10826: next;
10827: }
10828: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
10829: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 10830: my ($uname,$udom) = split(/:/,$user);
10831: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 10832: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 10833: $secmatch = 1;
10834: } elsif ($usec eq '') {
1.420 albertel 10835: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 10836: $secmatch = 1;
10837: }
10838: } else {
10839: if (grep(/^\Q$usec\E$/,@{$sections})) {
10840: $secmatch = 1;
10841: }
10842: }
10843: if (!$secmatch) {
10844: next;
10845: }
1.288 raeburn 10846: }
1.419 raeburn 10847: if ($usec eq '') {
10848: $usec = 'none';
10849: }
1.275 raeburn 10850: if ($uname ne '' && $udom ne '') {
1.630 raeburn 10851: if ($hidepriv) {
1.1121 raeburn 10852: if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630 raeburn 10853: (!$nothide{$uname.':'.$udom})) {
10854: next;
10855: }
10856: }
1.503 raeburn 10857: if ($end > 0 && $end < $now) {
1.439 raeburn 10858: $status = 'previous';
10859: } elsif ($start > $now) {
10860: $status = 'future';
10861: } else {
10862: $status = 'active';
10863: }
1.277 albertel 10864: foreach my $type (keys(%{$types})) {
1.275 raeburn 10865: if ($status eq $type) {
1.420 albertel 10866: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 10867: push(@{$$users{$role}{$user}},$type);
10868: }
1.288 raeburn 10869: $match = 1;
10870: }
10871: }
1.419 raeburn 10872: if (($match) && (ref($userdata) eq 'HASH')) {
10873: if (!exists($$userdata{$uname.':'.$udom})) {
10874: &get_user_info($udom,$uname,\%idx,$userdata);
10875: }
1.420 albertel 10876: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 10877: push(@{$seclists{$uname.':'.$udom}},$usec);
10878: }
1.609 raeburn 10879: if (ref($statushash) eq 'HASH') {
10880: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
10881: }
1.275 raeburn 10882: }
10883: }
10884: }
10885: }
1.290 albertel 10886: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 10887: if ((defined($cdom)) && (defined($cnum))) {
10888: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
10889: if ( defined($csettings{'internal.courseowner'}) ) {
10890: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 10891: next if ($owner eq '');
10892: my ($ownername,$ownerdom);
10893: if ($owner =~ /^([^:]+):([^:]+)$/) {
10894: $ownername = $1;
10895: $ownerdom = $2;
10896: } else {
10897: $ownername = $owner;
10898: $ownerdom = $cdom;
10899: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 10900: }
10901: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 10902: if (defined($userdata) &&
1.609 raeburn 10903: !exists($$userdata{$owner})) {
10904: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
10905: if (!grep(/^none$/,@{$seclists{$owner}})) {
10906: push(@{$seclists{$owner}},'none');
10907: }
10908: if (ref($statushash) eq 'HASH') {
10909: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 10910: }
1.290 albertel 10911: }
1.279 raeburn 10912: }
10913: }
10914: }
1.419 raeburn 10915: foreach my $user (keys(%seclists)) {
10916: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
10917: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
10918: }
1.275 raeburn 10919: }
10920: return;
10921: }
10922:
1.288 raeburn 10923: sub get_user_info {
10924: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 10925: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
10926: &plainname($uname,$udom,'lastname');
1.291 albertel 10927: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 10928: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 10929: my %idhash = &Apache::lonnet::idrget($udom,($uname));
10930: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 10931: return;
10932: }
1.275 raeburn 10933:
1.472 raeburn 10934: ###############################################
10935:
10936: =pod
10937:
10938: =item * &get_user_quota()
10939:
1.1134 raeburn 10940: Retrieves quota assigned for storage of user files.
10941: Default is to report quota for portfolio files.
1.472 raeburn 10942:
10943: Incoming parameters:
10944: 1. user's username
10945: 2. user's domain
1.1134 raeburn 10946: 3. quota name - portfolio, author, or course
1.1136 raeburn 10947: (if no quota name provided, defaults to portfolio).
1.1237 raeburn 10948: 4. crstype - official, unofficial, textbook, placement or community,
10949: if quota name is course
1.472 raeburn 10950:
10951: Returns:
1.1163 raeburn 10952: 1. Disk quota (in MB) assigned to student.
1.536 raeburn 10953: 2. (Optional) Type of setting: custom or default
10954: (individually assigned or default for user's
10955: institutional status).
10956: 3. (Optional) - User's institutional status (e.g., faculty, staff
10957: or student - types as defined in localenroll::inst_usertypes
10958: for user's domain, which determines default quota for user.
10959: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 10960:
10961: If a value has been stored in the user's environment,
1.536 raeburn 10962: it will return that, otherwise it returns the maximal default
1.1134 raeburn 10963: defined for the user's institutional status(es) in the domain.
1.472 raeburn 10964:
10965: =cut
10966:
10967: ###############################################
10968:
10969:
10970: sub get_user_quota {
1.1136 raeburn 10971: my ($uname,$udom,$quotaname,$crstype) = @_;
1.536 raeburn 10972: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 10973: if (!defined($udom)) {
10974: $udom = $env{'user.domain'};
10975: }
10976: if (!defined($uname)) {
10977: $uname = $env{'user.name'};
10978: }
10979: if (($udom eq '' || $uname eq '') ||
10980: ($udom eq 'public') && ($uname eq 'public')) {
10981: $quota = 0;
1.536 raeburn 10982: $quotatype = 'default';
10983: $defquota = 0;
1.472 raeburn 10984: } else {
1.536 raeburn 10985: my $inststatus;
1.1134 raeburn 10986: if ($quotaname eq 'course') {
10987: if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
10988: ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
10989: $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
10990: } else {
10991: my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
10992: $quota = $cenv{'internal.uploadquota'};
10993: }
1.536 raeburn 10994: } else {
1.1134 raeburn 10995: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
10996: if ($quotaname eq 'author') {
10997: $quota = $env{'environment.authorquota'};
10998: } else {
10999: $quota = $env{'environment.portfolioquota'};
11000: }
11001: $inststatus = $env{'environment.inststatus'};
11002: } else {
11003: my %userenv =
11004: &Apache::lonnet::get('environment',['portfolioquota',
11005: 'authorquota','inststatus'],$udom,$uname);
11006: my ($tmp) = keys(%userenv);
11007: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
11008: if ($quotaname eq 'author') {
11009: $quota = $userenv{'authorquota'};
11010: } else {
11011: $quota = $userenv{'portfolioquota'};
11012: }
11013: $inststatus = $userenv{'inststatus'};
11014: } else {
11015: undef(%userenv);
11016: }
11017: }
11018: }
11019: if ($quota eq '' || wantarray) {
11020: if ($quotaname eq 'course') {
11021: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1165 raeburn 11022: if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
1.1237 raeburn 11023: ($crstype eq 'community') || ($crstype eq 'textbook') ||
11024: ($crstype eq 'placement')) {
1.1136 raeburn 11025: $defquota = $domdefs{$crstype.'quota'};
11026: }
11027: if ($defquota eq '') {
11028: $defquota = 500;
11029: }
1.1134 raeburn 11030: } else {
11031: ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
11032: }
11033: if ($quota eq '') {
11034: $quota = $defquota;
11035: $quotatype = 'default';
11036: } else {
11037: $quotatype = 'custom';
11038: }
1.472 raeburn 11039: }
11040: }
1.536 raeburn 11041: if (wantarray) {
11042: return ($quota,$quotatype,$settingstatus,$defquota);
11043: } else {
11044: return $quota;
11045: }
1.472 raeburn 11046: }
11047:
11048: ###############################################
11049:
11050: =pod
11051:
11052: =item * &default_quota()
11053:
1.536 raeburn 11054: Retrieves default quota assigned for storage of user portfolio files,
11055: given an (optional) user's institutional status.
1.472 raeburn 11056:
11057: Incoming parameters:
1.1142 raeburn 11058:
1.472 raeburn 11059: 1. domain
1.536 raeburn 11060: 2. (Optional) institutional status(es). This is a : separated list of
11061: status types (e.g., faculty, staff, student etc.)
11062: which apply to the user for whom the default is being retrieved.
11063: If the institutional status string in undefined, the domain
1.1134 raeburn 11064: default quota will be returned.
11065: 3. quota name - portfolio, author, or course
11066: (if no quota name provided, defaults to portfolio).
1.472 raeburn 11067:
11068: Returns:
1.1142 raeburn 11069:
1.1163 raeburn 11070: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536 raeburn 11071: 2. (Optional) institutional type which determined the value of the
11072: default quota.
1.472 raeburn 11073:
11074: If a value has been stored in the domain's configuration db,
11075: it will return that, otherwise it returns 20 (for backwards
11076: compatibility with domains which have not set up a configuration
1.1163 raeburn 11077: db file; the original statically defined portfolio quota was 20 MB).
1.472 raeburn 11078:
1.536 raeburn 11079: If the user's status includes multiple types (e.g., staff and student),
11080: the largest default quota which applies to the user determines the
11081: default quota returned.
11082:
1.472 raeburn 11083: =cut
11084:
11085: ###############################################
11086:
11087:
11088: sub default_quota {
1.1134 raeburn 11089: my ($udom,$inststatus,$quotaname) = @_;
1.536 raeburn 11090: my ($defquota,$settingstatus);
11091: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 11092: ['quotas'],$udom);
1.1134 raeburn 11093: my $key = 'defaultquota';
11094: if ($quotaname eq 'author') {
11095: $key = 'authorquota';
11096: }
1.622 raeburn 11097: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 11098: if ($inststatus ne '') {
1.765 raeburn 11099: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 11100: foreach my $item (@statuses) {
1.1134 raeburn 11101: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
11102: if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711 raeburn 11103: if ($defquota eq '') {
1.1134 raeburn 11104: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 11105: $settingstatus = $item;
1.1134 raeburn 11106: } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
11107: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 11108: $settingstatus = $item;
11109: }
11110: }
1.1134 raeburn 11111: } elsif ($key eq 'defaultquota') {
1.711 raeburn 11112: if ($quotahash{'quotas'}{$item} ne '') {
11113: if ($defquota eq '') {
11114: $defquota = $quotahash{'quotas'}{$item};
11115: $settingstatus = $item;
11116: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
11117: $defquota = $quotahash{'quotas'}{$item};
11118: $settingstatus = $item;
11119: }
1.536 raeburn 11120: }
11121: }
11122: }
11123: }
11124: if ($defquota eq '') {
1.1134 raeburn 11125: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
11126: $defquota = $quotahash{'quotas'}{$key}{'default'};
11127: } elsif ($key eq 'defaultquota') {
1.711 raeburn 11128: $defquota = $quotahash{'quotas'}{'default'};
11129: }
1.536 raeburn 11130: $settingstatus = 'default';
1.1139 raeburn 11131: if ($defquota eq '') {
11132: if ($quotaname eq 'author') {
11133: $defquota = 500;
11134: }
11135: }
1.536 raeburn 11136: }
11137: } else {
11138: $settingstatus = 'default';
1.1134 raeburn 11139: if ($quotaname eq 'author') {
11140: $defquota = 500;
11141: } else {
11142: $defquota = 20;
11143: }
1.536 raeburn 11144: }
11145: if (wantarray) {
11146: return ($defquota,$settingstatus);
1.472 raeburn 11147: } else {
1.536 raeburn 11148: return $defquota;
1.472 raeburn 11149: }
11150: }
11151:
1.1135 raeburn 11152: ###############################################
11153:
11154: =pod
11155:
1.1136 raeburn 11156: =item * &excess_filesize_warning()
1.1135 raeburn 11157:
11158: Returns warning message if upload of file to authoring space, or copying
1.1136 raeburn 11159: of existing file within authoring space will cause quota for the authoring
1.1146 raeburn 11160: space to be exceeded.
1.1136 raeburn 11161:
11162: Same, if upload of a file directly to a course/community via Course Editor
1.1137 raeburn 11163: will cause quota for uploaded content for the course to be exceeded.
1.1135 raeburn 11164:
1.1165 raeburn 11165: Inputs: 7
1.1136 raeburn 11166: 1. username or coursenum
1.1135 raeburn 11167: 2. domain
1.1136 raeburn 11168: 3. context ('author' or 'course')
1.1135 raeburn 11169: 4. filename of file for which action is being requested
11170: 5. filesize (kB) of file
11171: 6. action being taken: copy or upload.
1.1237 raeburn 11172: 7. quotatype (in course context -- official, unofficial, textbook, placement or community).
1.1135 raeburn 11173:
11174: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
1.1142 raeburn 11175: otherwise return null.
11176:
11177: =back
1.1135 raeburn 11178:
11179: =cut
11180:
1.1136 raeburn 11181: sub excess_filesize_warning {
1.1165 raeburn 11182: my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1136 raeburn 11183: my $current_disk_usage = 0;
1.1165 raeburn 11184: my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1136 raeburn 11185: if ($context eq 'author') {
11186: my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
11187: $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
11188: } else {
11189: foreach my $subdir ('docs','supplemental') {
11190: $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
11191: }
11192: }
1.1135 raeburn 11193: $disk_quota = int($disk_quota * 1000);
11194: if (($current_disk_usage + $filesize) > $disk_quota) {
1.1179 bisitz 11195: return '<p class="LC_warning">'.
1.1135 raeburn 11196: &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1179 bisitz 11197: '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
11198: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1135 raeburn 11199: $disk_quota,$current_disk_usage).
11200: '</p>';
11201: }
11202: return;
11203: }
11204:
11205: ###############################################
11206:
11207:
1.1136 raeburn 11208:
11209:
1.384 raeburn 11210: sub get_secgrprole_info {
11211: my ($cdom,$cnum,$needroles,$type) = @_;
11212: my %sections_count = &get_sections($cdom,$cnum);
11213: my @sections = (sort {$a <=> $b} keys(%sections_count));
11214: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
11215: my @groups = sort(keys(%curr_groups));
11216: my $allroles = [];
11217: my $rolehash;
11218: my $accesshash = {
11219: active => 'Currently has access',
11220: future => 'Will have future access',
11221: previous => 'Previously had access',
11222: };
11223: if ($needroles) {
11224: $rolehash = {'all' => 'all'};
1.385 albertel 11225: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11226: if (&Apache::lonnet::error(%user_roles)) {
11227: undef(%user_roles);
11228: }
11229: foreach my $item (keys(%user_roles)) {
1.384 raeburn 11230: my ($role)=split(/\:/,$item,2);
11231: if ($role eq 'cr') { next; }
11232: if ($role =~ /^cr/) {
11233: $$rolehash{$role} = (split('/',$role))[3];
11234: } else {
11235: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
11236: }
11237: }
11238: foreach my $key (sort(keys(%{$rolehash}))) {
11239: push(@{$allroles},$key);
11240: }
11241: push (@{$allroles},'st');
11242: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
11243: }
11244: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
11245: }
11246:
1.555 raeburn 11247: sub user_picker {
1.1279 raeburn 11248: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555 raeburn 11249: my $currdom = $dom;
1.1253 raeburn 11250: my @alldoms = &Apache::lonnet::all_domains();
11251: if (@alldoms == 1) {
11252: my %domsrch = &Apache::lonnet::get_dom('configuration',
11253: ['directorysrch'],$alldoms[0]);
11254: my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
11255: my $showdom = $domdesc;
11256: if ($showdom eq '') {
11257: $showdom = $dom;
11258: }
11259: if (ref($domsrch{'directorysrch'}) eq 'HASH') {
11260: if ((!$domsrch{'directorysrch'}{'available'}) &&
11261: ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
11262: return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
11263: }
11264: }
11265: }
1.555 raeburn 11266: my %curr_selected = (
11267: srchin => 'dom',
1.580 raeburn 11268: srchby => 'lastname',
1.555 raeburn 11269: );
11270: my $srchterm;
1.625 raeburn 11271: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 11272: if ($srch->{'srchby'} ne '') {
11273: $curr_selected{'srchby'} = $srch->{'srchby'};
11274: }
11275: if ($srch->{'srchin'} ne '') {
11276: $curr_selected{'srchin'} = $srch->{'srchin'};
11277: }
11278: if ($srch->{'srchtype'} ne '') {
11279: $curr_selected{'srchtype'} = $srch->{'srchtype'};
11280: }
11281: if ($srch->{'srchdomain'} ne '') {
11282: $currdom = $srch->{'srchdomain'};
11283: }
11284: $srchterm = $srch->{'srchterm'};
11285: }
1.1222 damieng 11286: my %html_lt=&Apache::lonlocal::texthash(
1.573 raeburn 11287: 'usr' => 'Search criteria',
1.563 raeburn 11288: 'doma' => 'Domain/institution to search',
1.558 albertel 11289: 'uname' => 'username',
11290: 'lastname' => 'last name',
1.555 raeburn 11291: 'lastfirst' => 'last name, first name',
1.558 albertel 11292: 'crs' => 'in this course',
1.576 raeburn 11293: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 11294: 'alc' => 'all LON-CAPA',
1.573 raeburn 11295: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 11296: 'exact' => 'is',
11297: 'contains' => 'contains',
1.569 raeburn 11298: 'begins' => 'begins with',
1.1222 damieng 11299: );
11300: my %js_lt=&Apache::lonlocal::texthash(
1.571 raeburn 11301: 'youm' => "You must include some text to search for.",
11302: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
11303: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
11304: 'yomc' => "You must choose a domain when using an institutional directory search.",
11305: 'ymcd' => "You must choose a domain when using a domain search.",
11306: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
11307: 'whse' => "When searching by last,first you must include at least one character in the first name.",
11308: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 11309: );
1.1222 damieng 11310: &html_escape(\%html_lt);
11311: &js_escape(\%js_lt);
1.1255 raeburn 11312: my $domform;
1.1277 raeburn 11313: my $allow_blank = 1;
1.1255 raeburn 11314: if ($fixeddom) {
1.1277 raeburn 11315: $allow_blank = 0;
11316: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1255 raeburn 11317: } else {
1.1287 raeburn 11318: my $defdom = $env{'request.role.domain'};
1.1288 raeburn 11319: my ($trusted,$untrusted);
1.1287 raeburn 11320: if (($context eq 'requestcrs') || ($context eq 'course')) {
1.1288 raeburn 11321: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('enroll',$defdom);
1.1287 raeburn 11322: } elsif ($context eq 'author') {
1.1288 raeburn 11323: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('othcoau',$defdom);
1.1287 raeburn 11324: } elsif ($context eq 'domain') {
1.1288 raeburn 11325: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('domroles',$defdom);
1.1287 raeburn 11326: }
1.1288 raeburn 11327: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,$trusted,$untrusted);
1.1255 raeburn 11328: }
1.563 raeburn 11329: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 11330:
11331: my @srchins = ('crs','dom','alc','instd');
11332:
11333: foreach my $option (@srchins) {
11334: # FIXME 'alc' option unavailable until
11335: # loncreateuser::print_user_query_page()
11336: # has been completed.
11337: next if ($option eq 'alc');
1.880 raeburn 11338: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 11339: next if ($option eq 'crs' && !$env{'request.course.id'});
1.1279 raeburn 11340: next if (($option eq 'instd') && ($noinstd));
1.563 raeburn 11341: if ($curr_selected{'srchin'} eq $option) {
11342: $srchinsel .= '
1.1222 damieng 11343: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563 raeburn 11344: } else {
11345: $srchinsel .= '
1.1222 damieng 11346: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563 raeburn 11347: }
1.555 raeburn 11348: }
1.563 raeburn 11349: $srchinsel .= "\n </select>\n";
1.555 raeburn 11350:
11351: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 11352: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 11353: if ($curr_selected{'srchby'} eq $option) {
11354: $srchbysel .= '
1.1222 damieng 11355: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 11356: } else {
11357: $srchbysel .= '
1.1222 damieng 11358: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 11359: }
11360: }
11361: $srchbysel .= "\n </select>\n";
11362:
11363: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 11364: foreach my $option ('begins','contains','exact') {
1.555 raeburn 11365: if ($curr_selected{'srchtype'} eq $option) {
11366: $srchtypesel .= '
1.1222 damieng 11367: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 11368: } else {
11369: $srchtypesel .= '
1.1222 damieng 11370: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 11371: }
11372: }
11373: $srchtypesel .= "\n </select>\n";
11374:
1.558 albertel 11375: my ($newuserscript,$new_user_create);
1.994 raeburn 11376: my $context_dom = $env{'request.role.domain'};
11377: if ($context eq 'requestcrs') {
11378: if ($env{'form.coursedom'} ne '') {
11379: $context_dom = $env{'form.coursedom'};
11380: }
11381: }
1.556 raeburn 11382: if ($forcenewuser) {
1.576 raeburn 11383: if (ref($srch) eq 'HASH') {
1.994 raeburn 11384: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 11385: if ($cancreate) {
11386: $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>';
11387: } else {
1.799 bisitz 11388: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 11389: my %usertypetext = (
11390: official => 'institutional',
11391: unofficial => 'non-institutional',
11392: );
1.799 bisitz 11393: $new_user_create = '<p class="LC_warning">'
11394: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
11395: .' '
11396: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
11397: ,'<a href="'.$helplink.'">','</a>')
11398: .'</p><br />';
1.627 raeburn 11399: }
1.576 raeburn 11400: }
11401: }
11402:
1.556 raeburn 11403: $newuserscript = <<"ENDSCRIPT";
11404:
1.570 raeburn 11405: function setSearch(createnew,callingForm) {
1.556 raeburn 11406: if (createnew == 1) {
1.570 raeburn 11407: for (var i=0; i<callingForm.srchby.length; i++) {
11408: if (callingForm.srchby.options[i].value == 'uname') {
11409: callingForm.srchby.selectedIndex = i;
1.556 raeburn 11410: }
11411: }
1.570 raeburn 11412: for (var i=0; i<callingForm.srchin.length; i++) {
11413: if ( callingForm.srchin.options[i].value == 'dom') {
11414: callingForm.srchin.selectedIndex = i;
1.556 raeburn 11415: }
11416: }
1.570 raeburn 11417: for (var i=0; i<callingForm.srchtype.length; i++) {
11418: if (callingForm.srchtype.options[i].value == 'exact') {
11419: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 11420: }
11421: }
1.570 raeburn 11422: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 11423: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 11424: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 11425: }
11426: }
11427: }
11428: }
11429: ENDSCRIPT
1.558 albertel 11430:
1.556 raeburn 11431: }
11432:
1.555 raeburn 11433: my $output = <<"END_BLOCK";
1.556 raeburn 11434: <script type="text/javascript">
1.824 bisitz 11435: // <![CDATA[
1.570 raeburn 11436: function validateEntry(callingForm) {
1.558 albertel 11437:
1.556 raeburn 11438: var checkok = 1;
1.558 albertel 11439: var srchin;
1.570 raeburn 11440: for (var i=0; i<callingForm.srchin.length; i++) {
11441: if ( callingForm.srchin[i].checked ) {
11442: srchin = callingForm.srchin[i].value;
1.558 albertel 11443: }
11444: }
11445:
1.570 raeburn 11446: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
11447: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
11448: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
11449: var srchterm = callingForm.srchterm.value;
11450: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 11451: var msg = "";
11452:
11453: if (srchterm == "") {
11454: checkok = 0;
1.1222 damieng 11455: msg += "$js_lt{'youm'}\\n";
1.556 raeburn 11456: }
11457:
1.569 raeburn 11458: if (srchtype== 'begins') {
11459: if (srchterm.length < 2) {
11460: checkok = 0;
1.1222 damieng 11461: msg += "$js_lt{'thte'}\\n";
1.569 raeburn 11462: }
11463: }
11464:
1.556 raeburn 11465: if (srchtype== 'contains') {
11466: if (srchterm.length < 3) {
11467: checkok = 0;
1.1222 damieng 11468: msg += "$js_lt{'thet'}\\n";
1.556 raeburn 11469: }
11470: }
11471: if (srchin == 'instd') {
11472: if (srchdomain == '') {
11473: checkok = 0;
1.1222 damieng 11474: msg += "$js_lt{'yomc'}\\n";
1.556 raeburn 11475: }
11476: }
11477: if (srchin == 'dom') {
11478: if (srchdomain == '') {
11479: checkok = 0;
1.1222 damieng 11480: msg += "$js_lt{'ymcd'}\\n";
1.556 raeburn 11481: }
11482: }
11483: if (srchby == 'lastfirst') {
11484: if (srchterm.indexOf(",") == -1) {
11485: checkok = 0;
1.1222 damieng 11486: msg += "$js_lt{'whus'}\\n";
1.556 raeburn 11487: }
11488: if (srchterm.indexOf(",") == srchterm.length -1) {
11489: checkok = 0;
1.1222 damieng 11490: msg += "$js_lt{'whse'}\\n";
1.556 raeburn 11491: }
11492: }
11493: if (checkok == 0) {
1.1222 damieng 11494: alert("$js_lt{'thfo'}\\n"+msg);
1.556 raeburn 11495: return;
11496: }
11497: if (checkok == 1) {
1.570 raeburn 11498: callingForm.submit();
1.556 raeburn 11499: }
11500: }
11501:
11502: $newuserscript
11503:
1.824 bisitz 11504: // ]]>
1.556 raeburn 11505: </script>
1.558 albertel 11506:
11507: $new_user_create
11508:
1.555 raeburn 11509: END_BLOCK
1.558 albertel 11510:
1.876 raeburn 11511: $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1222 damieng 11512: &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876 raeburn 11513: $domform.
11514: &Apache::lonhtmlcommon::row_closure().
1.1222 damieng 11515: &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876 raeburn 11516: $srchbysel.
11517: $srchtypesel.
11518: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
11519: $srchinsel.
11520: &Apache::lonhtmlcommon::row_closure(1).
11521: &Apache::lonhtmlcommon::end_pick_box().
11522: '<br />';
1.1253 raeburn 11523: return ($output,1);
1.555 raeburn 11524: }
11525:
1.612 raeburn 11526: sub user_rule_check {
1.615 raeburn 11527: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1226 raeburn 11528: my ($response,%inst_response);
1.612 raeburn 11529: if (ref($usershash) eq 'HASH') {
1.1226 raeburn 11530: if (keys(%{$usershash}) > 1) {
11531: my (%by_username,%by_id,%userdoms);
11532: my $checkid;
11533: if (ref($checks) eq 'HASH') {
11534: if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
11535: $checkid = 1;
11536: }
11537: }
11538: foreach my $user (keys(%{$usershash})) {
11539: my ($uname,$udom) = split(/:/,$user);
11540: if ($checkid) {
11541: if (ref($usershash->{$user}) eq 'HASH') {
11542: if ($usershash->{$user}->{'id'} ne '') {
1.1227 raeburn 11543: $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname;
1.1226 raeburn 11544: $userdoms{$udom} = 1;
1.1227 raeburn 11545: if (ref($inst_results) eq 'HASH') {
11546: $inst_results->{$uname.':'.$udom} = {};
11547: }
1.1226 raeburn 11548: }
11549: }
11550: } else {
11551: $by_username{$udom}{$uname} = 1;
11552: $userdoms{$udom} = 1;
1.1227 raeburn 11553: if (ref($inst_results) eq 'HASH') {
11554: $inst_results->{$uname.':'.$udom} = {};
11555: }
1.1226 raeburn 11556: }
11557: }
11558: foreach my $udom (keys(%userdoms)) {
11559: if (!$got_rules->{$udom}) {
11560: my %domconfig = &Apache::lonnet::get_dom('configuration',
11561: ['usercreation'],$udom);
11562: if (ref($domconfig{'usercreation'}) eq 'HASH') {
11563: foreach my $item ('username','id') {
11564: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
1.1227 raeburn 11565: $$curr_rules{$udom}{$item} =
11566: $domconfig{'usercreation'}{$item.'_rule'};
1.1226 raeburn 11567: }
11568: }
11569: }
11570: $got_rules->{$udom} = 1;
11571: }
1.612 raeburn 11572: }
1.1226 raeburn 11573: if ($checkid) {
11574: foreach my $udom (keys(%by_id)) {
11575: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
11576: if ($outcome eq 'ok') {
1.1227 raeburn 11577: foreach my $id (keys(%{$by_id{$udom}})) {
11578: my $uname = $by_id{$udom}{$id};
11579: $inst_response{$uname.':'.$udom} = $outcome;
11580: }
1.1226 raeburn 11581: if (ref($results) eq 'HASH') {
11582: foreach my $uname (keys(%{$results})) {
1.1227 raeburn 11583: if (exists($inst_response{$uname.':'.$udom})) {
11584: $inst_response{$uname.':'.$udom} = $outcome;
11585: $inst_results->{$uname.':'.$udom} = $results->{$uname};
11586: }
1.1226 raeburn 11587: }
11588: }
11589: }
1.612 raeburn 11590: }
1.615 raeburn 11591: } else {
1.1226 raeburn 11592: foreach my $udom (keys(%by_username)) {
11593: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
11594: if ($outcome eq 'ok') {
1.1227 raeburn 11595: foreach my $uname (keys(%{$by_username{$udom}})) {
11596: $inst_response{$uname.':'.$udom} = $outcome;
11597: }
1.1226 raeburn 11598: if (ref($results) eq 'HASH') {
11599: foreach my $uname (keys(%{$results})) {
11600: $inst_results->{$uname.':'.$udom} = $results->{$uname};
11601: }
11602: }
11603: }
11604: }
1.612 raeburn 11605: }
1.1226 raeburn 11606: } elsif (keys(%{$usershash}) == 1) {
11607: my $user = (keys(%{$usershash}))[0];
11608: my ($uname,$udom) = split(/:/,$user);
11609: if (($udom ne '') && ($uname ne '')) {
11610: if (ref($usershash->{$user}) eq 'HASH') {
11611: if (ref($checks) eq 'HASH') {
11612: if (defined($checks->{'username'})) {
11613: ($inst_response{$user},%{$inst_results->{$user}}) =
11614: &Apache::lonnet::get_instuser($udom,$uname);
11615: } elsif (defined($checks->{'id'})) {
11616: if ($usershash->{$user}->{'id'} ne '') {
11617: ($inst_response{$user},%{$inst_results->{$user}}) =
11618: &Apache::lonnet::get_instuser($udom,undef,
11619: $usershash->{$user}->{'id'});
11620: } else {
11621: ($inst_response{$user},%{$inst_results->{$user}}) =
11622: &Apache::lonnet::get_instuser($udom,$uname);
11623: }
1.585 raeburn 11624: }
1.1226 raeburn 11625: } else {
11626: ($inst_response{$user},%{$inst_results->{$user}}) =
11627: &Apache::lonnet::get_instuser($udom,$uname);
11628: return;
11629: }
11630: if (!$got_rules->{$udom}) {
11631: my %domconfig = &Apache::lonnet::get_dom('configuration',
11632: ['usercreation'],$udom);
11633: if (ref($domconfig{'usercreation'}) eq 'HASH') {
11634: foreach my $item ('username','id') {
11635: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
11636: $$curr_rules{$udom}{$item} =
11637: $domconfig{'usercreation'}{$item.'_rule'};
11638: }
11639: }
11640: }
11641: $got_rules->{$udom} = 1;
1.585 raeburn 11642: }
11643: }
1.1226 raeburn 11644: } else {
11645: return;
11646: }
11647: } else {
11648: return;
11649: }
11650: foreach my $user (keys(%{$usershash})) {
11651: my ($uname,$udom) = split(/:/,$user);
11652: next if (($udom eq '') || ($uname eq ''));
11653: my $id;
1.1227 raeburn 11654: if (ref($inst_results) eq 'HASH') {
11655: if (ref($inst_results->{$user}) eq 'HASH') {
11656: $id = $inst_results->{$user}->{'id'};
11657: }
11658: }
11659: if ($id eq '') {
11660: if (ref($usershash->{$user})) {
11661: $id = $usershash->{$user}->{'id'};
11662: }
1.585 raeburn 11663: }
1.612 raeburn 11664: foreach my $item (keys(%{$checks})) {
11665: if (ref($$curr_rules{$udom}) eq 'HASH') {
11666: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
11667: if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1226 raeburn 11668: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
11669: $$curr_rules{$udom}{$item});
1.612 raeburn 11670: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
11671: if ($rule_check{$rule}) {
11672: $$rulematch{$user}{$item} = $rule;
1.1226 raeburn 11673: if ($inst_response{$user} eq 'ok') {
1.615 raeburn 11674: if (ref($inst_results) eq 'HASH') {
11675: if (ref($inst_results->{$user}) eq 'HASH') {
11676: if (keys(%{$inst_results->{$user}}) == 0) {
11677: $$alerts{$item}{$udom}{$uname} = 1;
1.1227 raeburn 11678: } elsif ($item eq 'id') {
11679: if ($inst_results->{$user}->{'id'} eq '') {
11680: $$alerts{$item}{$udom}{$uname} = 1;
11681: }
1.615 raeburn 11682: }
1.612 raeburn 11683: }
11684: }
1.615 raeburn 11685: }
11686: last;
1.585 raeburn 11687: }
11688: }
11689: }
11690: }
11691: }
11692: }
11693: }
11694: }
1.612 raeburn 11695: return;
11696: }
11697:
11698: sub user_rule_formats {
11699: my ($domain,$domdesc,$curr_rules,$check) = @_;
11700: my %text = (
11701: 'username' => 'Usernames',
11702: 'id' => 'IDs',
11703: );
11704: my $output;
11705: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
11706: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
11707: if (@{$ruleorder} > 0) {
1.1102 raeburn 11708: $output = '<br />'.
11709: &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
11710: '<span class="LC_cusr_emph">','</span>',$domdesc).
11711: ' <ul>';
1.612 raeburn 11712: foreach my $rule (@{$ruleorder}) {
11713: if (ref($curr_rules) eq 'ARRAY') {
11714: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
11715: if (ref($rules->{$rule}) eq 'HASH') {
11716: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
11717: $rules->{$rule}{'desc'}.'</li>';
11718: }
11719: }
11720: }
11721: }
11722: $output .= '</ul>';
11723: }
11724: }
11725: return $output;
11726: }
11727:
11728: sub instrule_disallow_msg {
1.615 raeburn 11729: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 11730: my $response;
11731: my %text = (
11732: item => 'username',
11733: items => 'usernames',
11734: match => 'matches',
11735: do => 'does',
11736: action => 'a username',
11737: one => 'one',
11738: );
11739: if ($count > 1) {
11740: $text{'item'} = 'usernames';
11741: $text{'match'} ='match';
11742: $text{'do'} = 'do';
11743: $text{'action'} = 'usernames',
11744: $text{'one'} = 'ones';
11745: }
11746: if ($checkitem eq 'id') {
11747: $text{'items'} = 'IDs';
11748: $text{'item'} = 'ID';
11749: $text{'action'} = 'an ID';
1.615 raeburn 11750: if ($count > 1) {
11751: $text{'item'} = 'IDs';
11752: $text{'action'} = 'IDs';
11753: }
1.612 raeburn 11754: }
1.674 bisitz 11755: $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 11756: if ($mode eq 'upload') {
11757: if ($checkitem eq 'username') {
11758: $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'}.");
11759: } elsif ($checkitem eq 'id') {
1.674 bisitz 11760: $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 11761: }
1.669 raeburn 11762: } elsif ($mode eq 'selfcreate') {
11763: if ($checkitem eq 'id') {
11764: $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.");
11765: }
1.615 raeburn 11766: } else {
11767: if ($checkitem eq 'username') {
11768: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
11769: } elsif ($checkitem eq 'id') {
11770: $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.");
11771: }
1.612 raeburn 11772: }
11773: return $response;
1.585 raeburn 11774: }
11775:
1.624 raeburn 11776: sub personal_data_fieldtitles {
11777: my %fieldtitles = &Apache::lonlocal::texthash (
11778: id => 'Student/Employee ID',
11779: permanentemail => 'E-mail address',
11780: lastname => 'Last Name',
11781: firstname => 'First Name',
11782: middlename => 'Middle Name',
11783: generation => 'Generation',
11784: gen => 'Generation',
1.765 raeburn 11785: inststatus => 'Affiliation',
1.624 raeburn 11786: );
11787: return %fieldtitles;
11788: }
11789:
1.642 raeburn 11790: sub sorted_inst_types {
11791: my ($dom) = @_;
1.1185 raeburn 11792: my ($usertypes,$order);
11793: my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
11794: if (ref($domdefaults{'inststatus'}) eq 'HASH') {
11795: $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
11796: $order = $domdefaults{'inststatus'}{'inststatusorder'};
11797: } else {
11798: ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
11799: }
1.642 raeburn 11800: my $othertitle = &mt('All users');
11801: if ($env{'request.course.id'}) {
1.668 raeburn 11802: $othertitle = &mt('Any users');
1.642 raeburn 11803: }
11804: my @types;
11805: if (ref($order) eq 'ARRAY') {
11806: @types = @{$order};
11807: }
11808: if (@types == 0) {
11809: if (ref($usertypes) eq 'HASH') {
11810: @types = sort(keys(%{$usertypes}));
11811: }
11812: }
11813: if (keys(%{$usertypes}) > 0) {
11814: $othertitle = &mt('Other users');
11815: }
11816: return ($othertitle,$usertypes,\@types);
11817: }
11818:
1.645 raeburn 11819: sub get_institutional_codes {
1.1361 raeburn 11820: my ($cdom,$crs,$settings,$allcourses,$LC_code) = @_;
1.645 raeburn 11821: # Get complete list of course sections to update
11822: my @currsections = ();
11823: my @currxlists = ();
1.1361 raeburn 11824: my (%unclutteredsec,%unclutteredlcsec);
1.645 raeburn 11825: my $coursecode = $$settings{'internal.coursecode'};
1.1361 raeburn 11826: my $crskey = $crs.':'.$coursecode;
11827: @{$unclutteredsec{$crskey}} = ();
11828: @{$unclutteredlcsec{$crskey}} = ();
1.645 raeburn 11829:
11830: if ($$settings{'internal.sectionnums'} ne '') {
11831: @currsections = split(/,/,$$settings{'internal.sectionnums'});
11832: }
11833:
11834: if ($$settings{'internal.crosslistings'} ne '') {
11835: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
11836: }
11837:
11838: if (@currxlists > 0) {
1.1361 raeburn 11839: foreach my $xl (@currxlists) {
11840: if ($xl =~ /^([^:]+):(\w*)$/) {
1.645 raeburn 11841: unless (grep/^$1$/,@{$allcourses}) {
1.1263 raeburn 11842: push(@{$allcourses},$1);
1.645 raeburn 11843: $$LC_code{$1} = $2;
11844: }
11845: }
11846: }
11847: }
1.1361 raeburn 11848:
1.645 raeburn 11849: if (@currsections > 0) {
1.1361 raeburn 11850: foreach my $sec (@currsections) {
11851: if ($sec =~ m/^(\w+):(\w*)$/ ) {
11852: my $instsec = $1;
1.645 raeburn 11853: my $lc_sec = $2;
1.1361 raeburn 11854: unless (grep/^\Q$instsec\E$/,@{$unclutteredsec{$crskey}}) {
11855: push(@{$unclutteredsec{$crskey}},$instsec);
11856: push(@{$unclutteredlcsec{$crskey}},$lc_sec);
11857: }
11858: }
11859: }
11860: }
11861:
11862: if (@{$unclutteredsec{$crskey}} > 0) {
11863: my %formattedsec = &Apache::lonnet::auto_instsec_reformat($cdom,'clutter',\%unclutteredsec);
11864: if ((ref($formattedsec{$crskey}) eq 'ARRAY') && (ref($unclutteredlcsec{$crskey}) eq 'ARRAY')) {
11865: for (my $i=0; $i<@{$formattedsec{$crskey}}; $i++) {
11866: my $sec = $coursecode.$formattedsec{$crskey}[$i];
11867: unless (grep/^\Q$sec\E$/,@{$allcourses}) {
1.1263 raeburn 11868: push(@{$allcourses},$sec);
1.1361 raeburn 11869: $$LC_code{$sec} = $unclutteredlcsec{$crskey}[$i];
1.645 raeburn 11870: }
11871: }
11872: }
11873: }
11874: return;
11875: }
11876:
1.971 raeburn 11877: sub get_standard_codeitems {
11878: return ('Year','Semester','Department','Number','Section');
11879: }
11880:
1.112 bowersj2 11881: =pod
11882:
1.780 raeburn 11883: =head1 Slot Helpers
11884:
11885: =over 4
11886:
11887: =item * sorted_slots()
11888:
1.1040 raeburn 11889: Sorts an array of slot names in order of an optional sort key,
11890: default sort is by slot start time (earliest first).
1.780 raeburn 11891:
11892: Inputs:
11893:
11894: =over 4
11895:
11896: slotsarr - Reference to array of unsorted slot names.
11897:
11898: slots - Reference to hash of hash, where outer hash keys are slot names.
11899:
1.1040 raeburn 11900: sortkey - Name of key in inner hash to be sorted on (e.g., starttime).
11901:
1.549 albertel 11902: =back
11903:
1.780 raeburn 11904: Returns:
11905:
11906: =over 4
11907:
1.1040 raeburn 11908: sorted - An array of slot names sorted by a specified sort key
11909: (default sort key is start time of the slot).
1.780 raeburn 11910:
11911: =back
11912:
11913: =cut
11914:
11915:
11916: sub sorted_slots {
1.1040 raeburn 11917: my ($slotsarr,$slots,$sortkey) = @_;
11918: if ($sortkey eq '') {
11919: $sortkey = 'starttime';
11920: }
1.780 raeburn 11921: my @sorted;
11922: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
11923: @sorted =
11924: sort {
11925: if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040 raeburn 11926: return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780 raeburn 11927: }
11928: if (ref($slots->{$a})) { return -1;}
11929: if (ref($slots->{$b})) { return 1;}
11930: return 0;
11931: } @{$slotsarr};
11932: }
11933: return @sorted;
11934: }
11935:
1.1040 raeburn 11936: =pod
11937:
11938: =item * get_future_slots()
11939:
11940: Inputs:
11941:
11942: =over 4
11943:
11944: cnum - course number
11945:
11946: cdom - course domain
11947:
11948: now - current UNIX time
11949:
11950: symb - optional symb
11951:
11952: =back
11953:
11954: Returns:
11955:
11956: =over 4
11957:
11958: sorted_reservable - ref to array of student_schedulable slots currently
11959: reservable, ordered by end date of reservation period.
11960:
11961: reservable_now - ref to hash of student_schedulable slots currently
11962: reservable.
11963:
11964: Keys in inner hash are:
11965: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 11966: (b) endreserve: end date of reservation period.
11967: (c) uniqueperiod: start,end dates when slot is to be uniquely
11968: selected.
1.1040 raeburn 11969:
11970: sorted_future - ref to array of student_schedulable slots reservable in
11971: the future, ordered by start date of reservation period.
11972:
11973: future_reservable - ref to hash of student_schedulable slots reservable
11974: in the future.
11975:
11976: Keys in inner hash are:
11977: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 11978: (b) startreserve: start date of reservation period.
11979: (c) uniqueperiod: start,end dates when slot is to be uniquely
11980: selected.
1.1040 raeburn 11981:
11982: =back
11983:
11984: =cut
11985:
11986: sub get_future_slots {
11987: my ($cnum,$cdom,$now,$symb) = @_;
1.1229 raeburn 11988: my $map;
11989: if ($symb) {
11990: ($map) = &Apache::lonnet::decode_symb($symb);
11991: }
1.1040 raeburn 11992: my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
11993: my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
11994: foreach my $slot (keys(%slots)) {
11995: next unless($slots{$slot}->{'type'} eq 'schedulable_student');
11996: if ($symb) {
1.1229 raeburn 11997: if ($slots{$slot}->{'symb'} ne '') {
11998: my $canuse;
11999: my %oksymbs;
12000: my @slotsymbs = split(/\s*,\s*/,$slots{$slot}->{'symb'});
12001: map { $oksymbs{$_} = 1; } @slotsymbs;
12002: if ($oksymbs{$symb}) {
12003: $canuse = 1;
12004: } else {
12005: foreach my $item (@slotsymbs) {
12006: if ($item =~ /\.(page|sequence)$/) {
12007: (undef,undef,my $sloturl) = &Apache::lonnet::decode_symb($item);
12008: if (($map ne '') && ($map eq $sloturl)) {
12009: $canuse = 1;
12010: last;
12011: }
12012: }
12013: }
12014: }
12015: next unless ($canuse);
12016: }
1.1040 raeburn 12017: }
12018: if (($slots{$slot}->{'starttime'} > $now) &&
12019: ($slots{$slot}->{'endtime'} > $now)) {
12020: if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
12021: my $userallowed = 0;
12022: if ($slots{$slot}->{'allowedsections'}) {
12023: my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
12024: if (!defined($env{'request.role.sec'})
12025: && grep(/^No section assigned$/,@allowed_sec)) {
12026: $userallowed=1;
12027: } else {
12028: if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
12029: $userallowed=1;
12030: }
12031: }
12032: unless ($userallowed) {
12033: if (defined($env{'request.course.groups'})) {
12034: my @groups = split(/:/,$env{'request.course.groups'});
12035: foreach my $group (@groups) {
12036: if (grep(/^\Q$group\E$/,@allowed_sec)) {
12037: $userallowed=1;
12038: last;
12039: }
12040: }
12041: }
12042: }
12043: }
12044: if ($slots{$slot}->{'allowedusers'}) {
12045: my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
12046: my $user = $env{'user.name'}.':'.$env{'user.domain'};
12047: if (grep(/^\Q$user\E$/,@allowed_users)) {
12048: $userallowed = 1;
12049: }
12050: }
12051: next unless($userallowed);
12052: }
12053: my $startreserve = $slots{$slot}->{'startreserve'};
12054: my $endreserve = $slots{$slot}->{'endreserve'};
12055: my $symb = $slots{$slot}->{'symb'};
1.1250 raeburn 12056: my $uniqueperiod;
12057: if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
12058: $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
12059: }
1.1040 raeburn 12060: if (($startreserve < $now) &&
12061: (!$endreserve || $endreserve > $now)) {
12062: my $lastres = $endreserve;
12063: if (!$lastres) {
12064: $lastres = $slots{$slot}->{'starttime'};
12065: }
12066: $reservable_now{$slot} = {
12067: symb => $symb,
1.1250 raeburn 12068: endreserve => $lastres,
12069: uniqueperiod => $uniqueperiod,
1.1040 raeburn 12070: };
12071: } elsif (($startreserve > $now) &&
12072: (!$endreserve || $endreserve > $startreserve)) {
12073: $future_reservable{$slot} = {
12074: symb => $symb,
1.1250 raeburn 12075: startreserve => $startreserve,
12076: uniqueperiod => $uniqueperiod,
1.1040 raeburn 12077: };
12078: }
12079: }
12080: }
12081: my @unsorted_reservable = keys(%reservable_now);
12082: if (@unsorted_reservable > 0) {
12083: @sorted_reservable =
12084: &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
12085: }
12086: my @unsorted_future = keys(%future_reservable);
12087: if (@unsorted_future > 0) {
12088: @sorted_future =
12089: &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
12090: }
12091: return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
12092: }
1.780 raeburn 12093:
12094: =pod
12095:
1.1057 foxr 12096: =back
12097:
1.549 albertel 12098: =head1 HTTP Helpers
12099:
12100: =over 4
12101:
1.648 raeburn 12102: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 12103:
1.258 albertel 12104: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 12105: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 12106: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 12107:
12108: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
12109: $possible_names is an ref to an array of form element names. As an example:
12110: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 12111: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 12112:
12113: =cut
1.1 albertel 12114:
1.6 albertel 12115: sub get_unprocessed_cgi {
1.25 albertel 12116: my ($query,$possible_names)= @_;
1.26 matthew 12117: # $Apache::lonxml::debug=1;
1.356 albertel 12118: foreach my $pair (split(/&/,$query)) {
12119: my ($name, $value) = split(/=/,$pair);
1.369 www 12120: $name = &unescape($name);
1.25 albertel 12121: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
12122: $value =~ tr/+/ /;
12123: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 12124: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 12125: }
1.16 harris41 12126: }
1.6 albertel 12127: }
12128:
1.112 bowersj2 12129: =pod
12130:
1.648 raeburn 12131: =item * &cacheheader()
1.112 bowersj2 12132:
12133: returns cache-controlling header code
12134:
12135: =cut
12136:
1.7 albertel 12137: sub cacheheader {
1.258 albertel 12138: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 12139: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
12140: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 12141: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
12142: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 12143: return $output;
1.7 albertel 12144: }
12145:
1.112 bowersj2 12146: =pod
12147:
1.648 raeburn 12148: =item * &no_cache($r)
1.112 bowersj2 12149:
12150: specifies header code to not have cache
12151:
12152: =cut
12153:
1.9 albertel 12154: sub no_cache {
1.216 albertel 12155: my ($r) = @_;
12156: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 12157: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 12158: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
12159: $r->no_cache(1);
12160: $r->header_out("Expires" => $date);
12161: $r->header_out("Pragma" => "no-cache");
1.123 www 12162: }
12163:
12164: sub content_type {
1.181 albertel 12165: my ($r,$type,$charset) = @_;
1.299 foxr 12166: if ($r) {
12167: # Note that printout.pl calls this with undef for $r.
12168: &no_cache($r);
12169: }
1.258 albertel 12170: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 12171: unless ($charset) {
12172: $charset=&Apache::lonlocal::current_encoding;
12173: }
12174: if ($charset) { $type.='; charset='.$charset; }
12175: if ($r) {
12176: $r->content_type($type);
12177: } else {
12178: print("Content-type: $type\n\n");
12179: }
1.9 albertel 12180: }
1.25 albertel 12181:
1.112 bowersj2 12182: =pod
12183:
1.648 raeburn 12184: =item * &add_to_env($name,$value)
1.112 bowersj2 12185:
1.258 albertel 12186: adds $name to the %env hash with value
1.112 bowersj2 12187: $value, if $name already exists, the entry is converted to an array
12188: reference and $value is added to the array.
12189:
12190: =cut
12191:
1.25 albertel 12192: sub add_to_env {
12193: my ($name,$value)=@_;
1.258 albertel 12194: if (defined($env{$name})) {
12195: if (ref($env{$name})) {
1.25 albertel 12196: #already have multiple values
1.258 albertel 12197: push(@{ $env{$name} },$value);
1.25 albertel 12198: } else {
12199: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 12200: my $first=$env{$name};
12201: undef($env{$name});
12202: push(@{ $env{$name} },$first,$value);
1.25 albertel 12203: }
12204: } else {
1.258 albertel 12205: $env{$name}=$value;
1.25 albertel 12206: }
1.31 albertel 12207: }
1.149 albertel 12208:
12209: =pod
12210:
1.648 raeburn 12211: =item * &get_env_multiple($name)
1.149 albertel 12212:
1.258 albertel 12213: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 12214: values may be defined and end up as an array ref.
12215:
12216: returns an array of values
12217:
12218: =cut
12219:
12220: sub get_env_multiple {
12221: my ($name) = @_;
12222: my @values;
1.258 albertel 12223: if (defined($env{$name})) {
1.149 albertel 12224: # exists is it an array
1.258 albertel 12225: if (ref($env{$name})) {
12226: @values=@{ $env{$name} };
1.149 albertel 12227: } else {
1.258 albertel 12228: $values[0]=$env{$name};
1.149 albertel 12229: }
12230: }
12231: return(@values);
12232: }
12233:
1.1249 damieng 12234: # Looks at given dependencies, and returns something depending on the context.
12235: # For coursedocs paste, returns (undef, $counter, $numpathchg, \%existing).
12236: # For syllabus rewrites, returns (undef, $counter, $numpathchg, \%existing, \%mapping).
12237: # For all other contexts, returns ($output, $counter, $numpathchg).
12238: # $output: string with the HTML output. Can contain missing dependencies with an upload form, existing dependencies, and dependencies no longer in use.
12239: # $counter: integer with the number of existing dependencies when no HTML output is returned, and the number of missing dependencies when an HTML output is returned.
12240: # $numpathchg: integer with the number of cleaned up dependency paths.
12241: # \%existing: hash reference clean path -> 1 only for existing dependencies.
12242: # \%mapping: hash reference clean path -> original path for all dependencies.
12243: # @param {string} actionurl - The path to the handler, indicative of the context.
12244: # @param {string} state - Can contain HTML with hidden inputs that will be added to the output form.
12245: # @param {hash reference} allfiles - List of file info from lonnet::extract_embedded_items
12246: # @param {hash reference} codebase - undef, not modified by lonnet::extract_embedded_items ?
12247: # @param {hash reference} args - More parameters ! Possible keys: error_on_invalid_names (boolean), ignore_remote_references (boolean), current_path (string), docs_url (string), docs_title (string), context (string)
12248: # @return {Array} - array depending on the context (not a reference)
1.660 raeburn 12249: sub ask_for_embedded_content {
1.1249 damieng 12250: # NOTE: documentation was added afterwards, it could be wrong
1.660 raeburn 12251: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071 raeburn 12252: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1085 raeburn 12253: %currsubfile,%unused,$rem);
1.1071 raeburn 12254: my $counter = 0;
12255: my $numnew = 0;
1.987 raeburn 12256: my $numremref = 0;
12257: my $numinvalid = 0;
12258: my $numpathchg = 0;
12259: my $numexisting = 0;
1.1071 raeburn 12260: my $numunused = 0;
12261: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1156 raeburn 12262: $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071 raeburn 12263: my $heading = &mt('Upload embedded files');
12264: my $buttontext = &mt('Upload');
12265:
1.1249 damieng 12266: # fills these variables based on the context:
12267: # $navmap, $cdom, $cnum, $udom, $uname, $url, $toplevel, $getpropath,
12268: # $path, $fileloc, $title, $rem, $filename
1.1085 raeburn 12269: if ($env{'request.course.id'}) {
1.1123 raeburn 12270: if ($actionurl eq '/adm/dependencies') {
12271: $navmap = Apache::lonnavmaps::navmap->new();
12272: }
12273: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
12274: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1085 raeburn 12275: }
1.1123 raeburn 12276: if (($actionurl eq '/adm/portfolio') ||
12277: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984 raeburn 12278: my $current_path='/';
12279: if ($env{'form.currentpath'}) {
12280: $current_path = $env{'form.currentpath'};
12281: }
12282: if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1123 raeburn 12283: $udom = $cdom;
12284: $uname = $cnum;
1.984 raeburn 12285: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
12286: } else {
12287: $udom = $env{'user.domain'};
12288: $uname = $env{'user.name'};
12289: $url = '/userfiles/portfolio';
12290: }
1.987 raeburn 12291: $toplevel = $url.'/';
1.984 raeburn 12292: $url .= $current_path;
12293: $getpropath = 1;
1.987 raeburn 12294: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
12295: ($actionurl eq '/adm/imsimport')) {
1.1022 www 12296: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026 raeburn 12297: $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987 raeburn 12298: $toplevel = $url;
1.984 raeburn 12299: if ($rest ne '') {
1.987 raeburn 12300: $url .= $rest;
12301: }
12302: } elsif ($actionurl eq '/adm/coursedocs') {
12303: if (ref($args) eq 'HASH') {
1.1071 raeburn 12304: $url = $args->{'docs_url'};
12305: $toplevel = $url;
1.1084 raeburn 12306: if ($args->{'context'} eq 'paste') {
12307: ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
12308: ($path) =
12309: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
12310: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
12311: $fileloc =~ s{^/}{};
12312: }
1.1071 raeburn 12313: }
1.1084 raeburn 12314: } elsif ($actionurl eq '/adm/dependencies') {
1.1071 raeburn 12315: if ($env{'request.course.id'} ne '') {
12316: if (ref($args) eq 'HASH') {
12317: $url = $args->{'docs_url'};
12318: $title = $args->{'docs_title'};
1.1126 raeburn 12319: $toplevel = $url;
12320: unless ($toplevel =~ m{^/}) {
12321: $toplevel = "/$url";
12322: }
1.1085 raeburn 12323: ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1126 raeburn 12324: if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
12325: $path = $1;
12326: } else {
12327: ($path) =
12328: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
12329: }
1.1195 raeburn 12330: if ($toplevel=~/^\/*(uploaded|editupload)/) {
12331: $fileloc = $toplevel;
12332: $fileloc=~ s/^\s*(\S+)\s*$/$1/;
12333: my ($udom,$uname,$fname) =
12334: ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
12335: $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
12336: } else {
12337: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
12338: }
1.1071 raeburn 12339: $fileloc =~ s{^/}{};
12340: ($filename) = ($fileloc =~ m{.+/([^/]+)$});
12341: $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
12342: }
1.987 raeburn 12343: }
1.1123 raeburn 12344: } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
12345: $udom = $cdom;
12346: $uname = $cnum;
12347: $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
12348: $toplevel = $url;
12349: $path = $url;
12350: $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
12351: $fileloc =~ s{^/}{};
1.987 raeburn 12352: }
1.1249 damieng 12353:
12354: # parses the dependency paths to get some info
12355: # fills $newfiles, $mapping, $subdependencies, $dependencies
12356: # $newfiles: hash URL -> 1 for new files or external URLs
12357: # (will be completed later)
12358: # $mapping:
12359: # for external URLs: external URL -> external URL
12360: # for relative paths: clean path -> original path
12361: # $subdependencies: hash clean path -> clean file name -> 1 for relative paths in subdirectories
12362: # $dependencies: hash clean or not file name -> 1 for relative paths not in subdirectories
1.1126 raeburn 12363: foreach my $file (keys(%{$allfiles})) {
12364: my $embed_file;
12365: if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
12366: $embed_file = $1;
12367: } else {
12368: $embed_file = $file;
12369: }
1.1158 raeburn 12370: my ($absolutepath,$cleaned_file);
12371: if ($embed_file =~ m{^\w+://}) {
12372: $cleaned_file = $embed_file;
1.1147 raeburn 12373: $newfiles{$cleaned_file} = 1;
12374: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 12375: } else {
1.1158 raeburn 12376: $cleaned_file = &clean_path($embed_file);
1.987 raeburn 12377: if ($embed_file =~ m{^/}) {
12378: $absolutepath = $embed_file;
12379: }
1.1147 raeburn 12380: if ($cleaned_file =~ m{/}) {
12381: my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987 raeburn 12382: $path = &check_for_traversal($path,$url,$toplevel);
12383: my $item = $fname;
12384: if ($path ne '') {
12385: $item = $path.'/'.$fname;
12386: $subdependencies{$path}{$fname} = 1;
12387: } else {
12388: $dependencies{$item} = 1;
12389: }
12390: if ($absolutepath) {
12391: $mapping{$item} = $absolutepath;
12392: } else {
12393: $mapping{$item} = $embed_file;
12394: }
12395: } else {
12396: $dependencies{$embed_file} = 1;
12397: if ($absolutepath) {
1.1147 raeburn 12398: $mapping{$cleaned_file} = $absolutepath;
1.987 raeburn 12399: } else {
1.1147 raeburn 12400: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 12401: }
12402: }
1.984 raeburn 12403: }
12404: }
1.1249 damieng 12405:
12406: # looks for all existing files in dependency subdirectories (from $subdependencies filled above)
12407: # and lists
12408: # fills $currsubfile, $pathchanges, $existing, $numexisting, $newfiles, $unused
12409: # $currsubfile: hash clean path -> file name -> 1 for all existing files in the path
12410: # $pathchanges: hash clean path -> 1 if the file in subdirectory exists and
12411: # the path had to be cleaned up
12412: # $existing: hash clean path -> 1 if the file exists
12413: # $numexisting: number of keys in $existing
12414: # $newfiles: updated with clean path -> 1 for files in subdirectories that do not exist
12415: # $unused: only for /adm/dependencies, hash clean path -> 1 for existing files in
12416: # dependency subdirectories that are
12417: # not listed as dependencies, with some exceptions using $rem
1.1071 raeburn 12418: my $dirptr = 16384;
1.984 raeburn 12419: foreach my $path (keys(%subdependencies)) {
1.1071 raeburn 12420: $currsubfile{$path} = {};
1.1123 raeburn 12421: if (($actionurl eq '/adm/portfolio') ||
12422: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 12423: my ($sublistref,$listerror) =
12424: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
12425: if (ref($sublistref) eq 'ARRAY') {
12426: foreach my $line (@{$sublistref}) {
12427: my ($file_name,$rest) = split(/\&/,$line,2);
1.1071 raeburn 12428: $currsubfile{$path}{$file_name} = 1;
1.1021 raeburn 12429: }
1.984 raeburn 12430: }
1.987 raeburn 12431: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 12432: if (opendir(my $dir,$url.'/'.$path)) {
12433: my @subdir_list = grep(!/^\./,readdir($dir));
1.1071 raeburn 12434: map {$currsubfile{$path}{$_} = 1;} @subdir_list;
12435: }
1.1084 raeburn 12436: } elsif (($actionurl eq '/adm/dependencies') ||
12437: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 12438: ($args->{'context'} eq 'paste')) ||
12439: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 12440: if ($env{'request.course.id'} ne '') {
1.1123 raeburn 12441: my $dir;
12442: if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
12443: $dir = $fileloc;
12444: } else {
12445: ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
12446: }
1.1071 raeburn 12447: if ($dir ne '') {
12448: my ($sublistref,$listerror) =
12449: &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
12450: if (ref($sublistref) eq 'ARRAY') {
12451: foreach my $line (@{$sublistref}) {
12452: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
12453: undef,$mtime)=split(/\&/,$line,12);
12454: unless (($testdir&$dirptr) ||
12455: ($file_name =~ /^\.\.?$/)) {
12456: $currsubfile{$path}{$file_name} = [$size,$mtime];
12457: }
12458: }
12459: }
12460: }
1.984 raeburn 12461: }
12462: }
12463: foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071 raeburn 12464: if (exists($currsubfile{$path}{$file})) {
1.987 raeburn 12465: my $item = $path.'/'.$file;
12466: unless ($mapping{$item} eq $item) {
12467: $pathchanges{$item} = 1;
12468: }
12469: $existing{$item} = 1;
12470: $numexisting ++;
12471: } else {
12472: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 12473: }
12474: }
1.1071 raeburn 12475: if ($actionurl eq '/adm/dependencies') {
12476: foreach my $path (keys(%currsubfile)) {
12477: if (ref($currsubfile{$path}) eq 'HASH') {
12478: foreach my $file (keys(%{$currsubfile{$path}})) {
12479: unless ($subdependencies{$path}{$file}) {
1.1085 raeburn 12480: next if (($rem ne '') &&
12481: (($env{"httpref.$rem"."$path/$file"} ne '') ||
12482: (ref($navmap) &&
12483: (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
12484: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
12485: ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071 raeburn 12486: $unused{$path.'/'.$file} = 1;
12487: }
12488: }
12489: }
12490: }
12491: }
1.984 raeburn 12492: }
1.1249 damieng 12493:
12494: # fills $currfile, hash file name -> 1 or [$size,$mtime]
12495: # for files in $url or $fileloc (target directory) in some contexts
1.987 raeburn 12496: my %currfile;
1.1123 raeburn 12497: if (($actionurl eq '/adm/portfolio') ||
12498: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 12499: my ($dirlistref,$listerror) =
12500: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
12501: if (ref($dirlistref) eq 'ARRAY') {
12502: foreach my $line (@{$dirlistref}) {
12503: my ($file_name,$rest) = split(/\&/,$line,2);
12504: $currfile{$file_name} = 1;
12505: }
1.984 raeburn 12506: }
1.987 raeburn 12507: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 12508: if (opendir(my $dir,$url)) {
1.987 raeburn 12509: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 12510: map {$currfile{$_} = 1;} @dir_list;
12511: }
1.1084 raeburn 12512: } elsif (($actionurl eq '/adm/dependencies') ||
12513: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 12514: ($args->{'context'} eq 'paste')) ||
12515: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 12516: if ($env{'request.course.id'} ne '') {
12517: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
12518: if ($dir ne '') {
12519: my ($dirlistref,$listerror) =
12520: &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
12521: if (ref($dirlistref) eq 'ARRAY') {
12522: foreach my $line (@{$dirlistref}) {
12523: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
12524: $size,undef,$mtime)=split(/\&/,$line,12);
12525: unless (($testdir&$dirptr) ||
12526: ($file_name =~ /^\.\.?$/)) {
12527: $currfile{$file_name} = [$size,$mtime];
12528: }
12529: }
12530: }
12531: }
12532: }
1.984 raeburn 12533: }
1.1249 damieng 12534: # updates $pathchanges, $existing, $numexisting, $newfiles and $unused for files that
12535: # are not in subdirectories, using $currfile
1.984 raeburn 12536: foreach my $file (keys(%dependencies)) {
1.1071 raeburn 12537: if (exists($currfile{$file})) {
1.987 raeburn 12538: unless ($mapping{$file} eq $file) {
12539: $pathchanges{$file} = 1;
12540: }
12541: $existing{$file} = 1;
12542: $numexisting ++;
12543: } else {
1.984 raeburn 12544: $newfiles{$file} = 1;
12545: }
12546: }
1.1071 raeburn 12547: foreach my $file (keys(%currfile)) {
12548: unless (($file eq $filename) ||
12549: ($file eq $filename.'.bak') ||
12550: ($dependencies{$file})) {
1.1085 raeburn 12551: if ($actionurl eq '/adm/dependencies') {
1.1126 raeburn 12552: unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
12553: next if (($rem ne '') &&
12554: (($env{"httpref.$rem".$file} ne '') ||
12555: (ref($navmap) &&
12556: (($navmap->getResourceByUrl($rem.$file) ne '') ||
12557: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
12558: ($navmap->getResourceByUrl($rem.$1)))))));
12559: }
1.1085 raeburn 12560: }
1.1071 raeburn 12561: $unused{$file} = 1;
12562: }
12563: }
1.1249 damieng 12564:
12565: # returns some results for coursedocs paste and syllabus rewrites ($output is undef)
1.1084 raeburn 12566: if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
12567: ($args->{'context'} eq 'paste')) {
12568: $counter = scalar(keys(%existing));
12569: $numpathchg = scalar(keys(%pathchanges));
1.1123 raeburn 12570: return ($output,$counter,$numpathchg,\%existing);
12571: } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
12572: (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
12573: $counter = scalar(keys(%existing));
12574: $numpathchg = scalar(keys(%pathchanges));
12575: return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1084 raeburn 12576: }
1.1249 damieng 12577:
12578: # returns HTML otherwise, with dependency results and to ask for more uploads
12579:
12580: # $upload_output: missing dependencies (with upload form)
12581: # $modify_output: uploaded dependencies (in use)
12582: # $delete_output: files no longer in use (unused files are not listed for londocs, bug?)
1.984 raeburn 12583: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071 raeburn 12584: if ($actionurl eq '/adm/dependencies') {
12585: next if ($embed_file =~ m{^\w+://});
12586: }
1.660 raeburn 12587: $upload_output .= &start_data_table_row().
1.1123 raeburn 12588: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
1.1071 raeburn 12589: '<span class="LC_filename">'.$embed_file.'</span>';
1.987 raeburn 12590: unless ($mapping{$embed_file} eq $embed_file) {
1.1123 raeburn 12591: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
12592: &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987 raeburn 12593: }
1.1123 raeburn 12594: $upload_output .= '</td>';
1.1071 raeburn 12595: if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) {
1.1123 raeburn 12596: $upload_output.='<td align="right">'.
12597: '<span class="LC_info LC_fontsize_medium">'.
12598: &mt("URL points to web address").'</span>';
1.987 raeburn 12599: $numremref++;
1.660 raeburn 12600: } elsif ($args->{'error_on_invalid_names'}
12601: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1123 raeburn 12602: $upload_output.='<td align="right"><span class="LC_warning">'.
12603: &mt('Invalid characters').'</span>';
1.987 raeburn 12604: $numinvalid++;
1.660 raeburn 12605: } else {
1.1123 raeburn 12606: $upload_output .= '<td>'.
12607: &embedded_file_element('upload_embedded',$counter,
1.987 raeburn 12608: $embed_file,\%mapping,
1.1071 raeburn 12609: $allfiles,$codebase,'upload');
12610: $counter ++;
12611: $numnew ++;
1.987 raeburn 12612: }
12613: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
12614: }
12615: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071 raeburn 12616: if ($actionurl eq '/adm/dependencies') {
12617: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
12618: $modify_output .= &start_data_table_row().
12619: '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
12620: '<img src="'.&icon($embed_file).'" border="0" />'.
12621: ' <span class="LC_filename">'.$embed_file.'</span></a></td>'.
12622: '<td>'.$size.'</td>'.
12623: '<td>'.$mtime.'</td>'.
12624: '<td><label><input type="checkbox" name="mod_upload_dep" '.
12625: 'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
12626: $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
12627: '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
12628: &embedded_file_element('upload_embedded',$counter,
12629: $embed_file,\%mapping,
12630: $allfiles,$codebase,'modify').
12631: '</div></td>'.
12632: &end_data_table_row()."\n";
12633: $counter ++;
12634: } else {
12635: $upload_output .= &start_data_table_row().
1.1123 raeburn 12636: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
12637: '<span class="LC_filename">'.$embed_file.'</span></td>'.
12638: '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071 raeburn 12639: &Apache::loncommon::end_data_table_row()."\n";
12640: }
12641: }
12642: my $delidx = $counter;
12643: foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
12644: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
12645: $delete_output .= &start_data_table_row().
12646: '<td><img src="'.&icon($oldfile).'" />'.
12647: ' <span class="LC_filename">'.$oldfile.'</span></td>'.
12648: '<td>'.$size.'</td>'.
12649: '<td>'.$mtime.'</td>'.
12650: '<td><label><input type="checkbox" name="del_upload_dep" '.
12651: ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
12652: &embedded_file_element('upload_embedded',$delidx,
12653: $oldfile,\%mapping,$allfiles,
12654: $codebase,'delete').'</td>'.
12655: &end_data_table_row()."\n";
12656: $numunused ++;
12657: $delidx ++;
1.987 raeburn 12658: }
12659: if ($upload_output) {
12660: $upload_output = &start_data_table().
12661: $upload_output.
12662: &end_data_table()."\n";
12663: }
1.1071 raeburn 12664: if ($modify_output) {
12665: $modify_output = &start_data_table().
12666: &start_data_table_header_row().
12667: '<th>'.&mt('File').'</th>'.
12668: '<th>'.&mt('Size (KB)').'</th>'.
12669: '<th>'.&mt('Modified').'</th>'.
12670: '<th>'.&mt('Upload replacement?').'</th>'.
12671: &end_data_table_header_row().
12672: $modify_output.
12673: &end_data_table()."\n";
12674: }
12675: if ($delete_output) {
12676: $delete_output = &start_data_table().
12677: &start_data_table_header_row().
12678: '<th>'.&mt('File').'</th>'.
12679: '<th>'.&mt('Size (KB)').'</th>'.
12680: '<th>'.&mt('Modified').'</th>'.
12681: '<th>'.&mt('Delete?').'</th>'.
12682: &end_data_table_header_row().
12683: $delete_output.
12684: &end_data_table()."\n";
12685: }
1.987 raeburn 12686: my $applies = 0;
12687: if ($numremref) {
12688: $applies ++;
12689: }
12690: if ($numinvalid) {
12691: $applies ++;
12692: }
12693: if ($numexisting) {
12694: $applies ++;
12695: }
1.1071 raeburn 12696: if ($counter || $numunused) {
1.987 raeburn 12697: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
12698: ' method="post" enctype="multipart/form-data">'."\n".
1.1071 raeburn 12699: $state.'<h3>'.$heading.'</h3>';
12700: if ($actionurl eq '/adm/dependencies') {
12701: if ($numnew) {
12702: $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
12703: '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
12704: $upload_output.'<br />'."\n";
12705: }
12706: if ($numexisting) {
12707: $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
12708: '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
12709: $modify_output.'<br />'."\n";
12710: $buttontext = &mt('Save changes');
12711: }
12712: if ($numunused) {
12713: $output .= '<h4>'.&mt('Unused files').'</h4>'.
12714: '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
12715: $delete_output.'<br />'."\n";
12716: $buttontext = &mt('Save changes');
12717: }
12718: } else {
12719: $output .= $upload_output.'<br />'."\n";
12720: }
12721: $output .= '<input type ="hidden" name="number_embedded_items" value="'.
12722: $counter.'" />'."\n";
12723: if ($actionurl eq '/adm/dependencies') {
12724: $output .= '<input type ="hidden" name="number_newemb_items" value="'.
12725: $numnew.'" />'."\n";
12726: } elsif ($actionurl eq '') {
1.987 raeburn 12727: $output .= '<input type="hidden" name="phase" value="three" />';
12728: }
12729: } elsif ($applies) {
12730: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
12731: if ($applies > 1) {
12732: $output .=
1.1123 raeburn 12733: &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987 raeburn 12734: if ($numremref) {
12735: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
12736: }
12737: if ($numinvalid) {
12738: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
12739: }
12740: if ($numexisting) {
12741: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
12742: }
12743: $output .= '</ul><br />';
12744: } elsif ($numremref) {
12745: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
12746: } elsif ($numinvalid) {
12747: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
12748: } elsif ($numexisting) {
12749: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
12750: }
12751: $output .= $upload_output.'<br />';
12752: }
12753: my ($pathchange_output,$chgcount);
1.1071 raeburn 12754: $chgcount = $counter;
1.987 raeburn 12755: if (keys(%pathchanges) > 0) {
12756: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071 raeburn 12757: if ($counter) {
1.987 raeburn 12758: $output .= &embedded_file_element('pathchange',$chgcount,
12759: $embed_file,\%mapping,
1.1071 raeburn 12760: $allfiles,$codebase,'change');
1.987 raeburn 12761: } else {
12762: $pathchange_output .=
12763: &start_data_table_row().
12764: '<td><input type ="checkbox" name="namechange" value="'.
12765: $chgcount.'" checked="checked" /></td>'.
12766: '<td>'.$mapping{$embed_file}.'</td>'.
12767: '<td>'.$embed_file.
12768: &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071 raeburn 12769: \%mapping,$allfiles,$codebase,'change').
1.987 raeburn 12770: '</td>'.&end_data_table_row();
1.660 raeburn 12771: }
1.987 raeburn 12772: $numpathchg ++;
12773: $chgcount ++;
1.660 raeburn 12774: }
12775: }
1.1127 raeburn 12776: if (($counter) || ($numunused)) {
1.987 raeburn 12777: if ($numpathchg) {
12778: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
12779: $numpathchg.'" />'."\n";
12780: }
12781: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
12782: ($actionurl eq '/adm/imsimport')) {
12783: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
12784: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
12785: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071 raeburn 12786: } elsif ($actionurl eq '/adm/dependencies') {
12787: $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987 raeburn 12788: }
1.1123 raeburn 12789: $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987 raeburn 12790: } elsif ($numpathchg) {
12791: my %pathchange = ();
12792: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
12793: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
12794: $output .= '<p>'.&mt('or').'</p>';
1.1123 raeburn 12795: }
1.987 raeburn 12796: }
1.1071 raeburn 12797: return ($output,$counter,$numpathchg);
1.987 raeburn 12798: }
12799:
1.1147 raeburn 12800: =pod
12801:
12802: =item * clean_path($name)
12803:
12804: Performs clean-up of directories, subdirectories and filename in an
12805: embedded object, referenced in an HTML file which is being uploaded
12806: to a course or portfolio, where
12807: "Upload embedded images/multimedia files if HTML file" checkbox was
12808: checked.
12809:
12810: Clean-up is similar to replacements in lonnet::clean_filename()
12811: except each / between sub-directory and next level is preserved.
12812:
12813: =cut
12814:
12815: sub clean_path {
12816: my ($embed_file) = @_;
12817: $embed_file =~s{^/+}{};
12818: my @contents;
12819: if ($embed_file =~ m{/}) {
12820: @contents = split(/\//,$embed_file);
12821: } else {
12822: @contents = ($embed_file);
12823: }
12824: my $lastidx = scalar(@contents)-1;
12825: for (my $i=0; $i<=$lastidx; $i++) {
12826: $contents[$i]=~s{\\}{/}g;
12827: $contents[$i]=~s/\s+/\_/g;
12828: $contents[$i]=~s{[^/\w\.\-]}{}g;
12829: if ($i == $lastidx) {
12830: $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
12831: }
12832: }
12833: if ($lastidx > 0) {
12834: return join('/',@contents);
12835: } else {
12836: return $contents[0];
12837: }
12838: }
12839:
1.987 raeburn 12840: sub embedded_file_element {
1.1071 raeburn 12841: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987 raeburn 12842: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
12843: (ref($codebase) eq 'HASH'));
12844: my $output;
1.1071 raeburn 12845: if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987 raeburn 12846: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
12847: }
12848: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
12849: &escape($embed_file).'" />';
12850: unless (($context eq 'upload_embedded') &&
12851: ($mapping->{$embed_file} eq $embed_file)) {
12852: $output .='
12853: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
12854: }
12855: my $attrib;
12856: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
12857: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
12858: }
12859: $output .=
12860: "\n\t\t".
12861: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
12862: $attrib.'" />';
12863: if (exists($codebase->{$mapping->{$embed_file}})) {
12864: $output .=
12865: "\n\t\t".
12866: '<input name="codebase_'.$num.'" type="hidden" value="'.
12867: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 12868: }
1.987 raeburn 12869: return $output;
1.660 raeburn 12870: }
12871:
1.1071 raeburn 12872: sub get_dependency_details {
12873: my ($currfile,$currsubfile,$embed_file) = @_;
12874: my ($size,$mtime,$showsize,$showmtime);
12875: if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
12876: if ($embed_file =~ m{/}) {
12877: my ($path,$fname) = split(/\//,$embed_file);
12878: if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
12879: ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
12880: }
12881: } else {
12882: if (ref($currfile->{$embed_file}) eq 'ARRAY') {
12883: ($size,$mtime) = @{$currfile->{$embed_file}};
12884: }
12885: }
12886: $showsize = $size/1024.0;
12887: $showsize = sprintf("%.1f",$showsize);
12888: if ($mtime > 0) {
12889: $showmtime = &Apache::lonlocal::locallocaltime($mtime);
12890: }
12891: }
12892: return ($showsize,$showmtime);
12893: }
12894:
12895: sub ask_embedded_js {
12896: return <<"END";
12897: <script type="text/javascript"">
12898: // <![CDATA[
12899: function toggleBrowse(counter) {
12900: var chkboxid = document.getElementById('mod_upload_dep_'+counter);
12901: var fileid = document.getElementById('embedded_item_'+counter);
12902: var uploaddivid = document.getElementById('moduploaddep_'+counter);
12903: if (chkboxid.checked == true) {
12904: uploaddivid.style.display='block';
12905: } else {
12906: uploaddivid.style.display='none';
12907: fileid.value = '';
12908: }
12909: }
12910: // ]]>
12911: </script>
12912:
12913: END
12914: }
12915:
1.661 raeburn 12916: sub upload_embedded {
12917: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 12918: $current_disk_usage,$hiddenstate,$actionurl) = @_;
12919: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 12920: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
12921: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
12922: my $orig_uploaded_filename =
12923: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 12924: foreach my $type ('orig','ref','attrib','codebase') {
12925: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
12926: $env{'form.embedded_'.$type.'_'.$i} =
12927: &unescape($env{'form.embedded_'.$type.'_'.$i});
12928: }
12929: }
1.661 raeburn 12930: my ($path,$fname) =
12931: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
12932: # no path, whole string is fname
12933: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
12934: $fname = &Apache::lonnet::clean_filename($fname);
12935: # See if there is anything left
12936: next if ($fname eq '');
12937:
12938: # Check if file already exists as a file or directory.
12939: my ($state,$msg);
12940: if ($context eq 'portfolio') {
12941: my $port_path = $dirpath;
12942: if ($group ne '') {
12943: $port_path = "groups/$group/$port_path";
12944: }
1.987 raeburn 12945: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
12946: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 12947: $dir_root,$port_path,$disk_quota,
12948: $current_disk_usage,$uname,$udom);
12949: if ($state eq 'will_exceed_quota'
1.984 raeburn 12950: || $state eq 'file_locked') {
1.661 raeburn 12951: $output .= $msg;
12952: next;
12953: }
12954: } elsif (($context eq 'author') || ($context eq 'testbank')) {
12955: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
12956: if ($state eq 'exists') {
12957: $output .= $msg;
12958: next;
12959: }
12960: }
12961: # Check if extension is valid
12962: if (($fname =~ /\.(\w+)$/) &&
12963: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1155 bisitz 12964: $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
12965: .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661 raeburn 12966: next;
12967: } elsif (($fname =~ /\.(\w+)$/) &&
12968: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 12969: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 12970: next;
12971: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1120 bisitz 12972: $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 12973: next;
12974: }
12975: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1123 raeburn 12976: my $subdir = $path;
12977: $subdir =~ s{/+$}{};
1.661 raeburn 12978: if ($context eq 'portfolio') {
1.984 raeburn 12979: my $result;
12980: if ($state eq 'existingfile') {
12981: $result=
12982: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1123 raeburn 12983: $dirpath.$env{'form.currentpath'}.$subdir);
1.661 raeburn 12984: } else {
1.984 raeburn 12985: $result=
12986: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 12987: $dirpath.
1.1123 raeburn 12988: $env{'form.currentpath'}.$subdir);
1.984 raeburn 12989: if ($result !~ m|^/uploaded/|) {
12990: $output .= '<span class="LC_error">'
12991: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
12992: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
12993: .'</span><br />';
12994: next;
12995: } else {
1.987 raeburn 12996: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
12997: $path.$fname.'</span>').'<br />';
1.984 raeburn 12998: }
1.661 raeburn 12999: }
1.1123 raeburn 13000: } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
1.1126 raeburn 13001: my $extendedsubdir = $dirpath.'/'.$subdir;
13002: $extendedsubdir =~ s{/+$}{};
1.987 raeburn 13003: my $result =
1.1126 raeburn 13004: &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987 raeburn 13005: if ($result !~ m|^/uploaded/|) {
13006: $output .= '<span class="LC_error">'
13007: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
13008: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
13009: .'</span><br />';
13010: next;
13011: } else {
13012: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13013: $path.$fname.'</span>').'<br />';
1.1125 raeburn 13014: if ($context eq 'syllabus') {
13015: &Apache::lonnet::make_public_indefinitely($result);
13016: }
1.987 raeburn 13017: }
1.661 raeburn 13018: } else {
13019: # Save the file
13020: my $target = $env{'form.embedded_item_'.$i};
13021: my $fullpath = $dir_root.$dirpath.'/'.$path;
13022: my $dest = $fullpath.$fname;
13023: my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027 raeburn 13024: my @parts=split(/\//,"$dirpath/$path");
1.661 raeburn 13025: my $count;
13026: my $filepath = $dir_root;
1.1027 raeburn 13027: foreach my $subdir (@parts) {
13028: $filepath .= "/$subdir";
13029: if (!-e $filepath) {
1.661 raeburn 13030: mkdir($filepath,0770);
13031: }
13032: }
13033: my $fh;
13034: if (!open($fh,'>'.$dest)) {
13035: &Apache::lonnet::logthis('Failed to create '.$dest);
13036: $output .= '<span class="LC_error">'.
1.1071 raeburn 13037: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
13038: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 13039: '</span><br />';
13040: } else {
13041: if (!print $fh $env{'form.embedded_item_'.$i}) {
13042: &Apache::lonnet::logthis('Failed to write to '.$dest);
13043: $output .= '<span class="LC_error">'.
1.1071 raeburn 13044: &mt('An error occurred while writing the file [_1] for embedded element [_2].',
13045: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 13046: '</span><br />';
13047: } else {
1.987 raeburn 13048: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13049: $url.'</span>').'<br />';
13050: unless ($context eq 'testbank') {
13051: $footer .= &mt('View embedded file: [_1]',
13052: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
13053: }
13054: }
13055: close($fh);
13056: }
13057: }
13058: if ($env{'form.embedded_ref_'.$i}) {
13059: $pathchange{$i} = 1;
13060: }
13061: }
13062: if ($output) {
13063: $output = '<p>'.$output.'</p>';
13064: }
13065: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
13066: $returnflag = 'ok';
1.1071 raeburn 13067: my $numpathchgs = scalar(keys(%pathchange));
13068: if ($numpathchgs > 0) {
1.987 raeburn 13069: if ($context eq 'portfolio') {
13070: $output .= '<p>'.&mt('or').'</p>';
13071: } elsif ($context eq 'testbank') {
1.1071 raeburn 13072: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
13073: '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987 raeburn 13074: $returnflag = 'modify_orightml';
13075: }
13076: }
1.1071 raeburn 13077: return ($output.$footer,$returnflag,$numpathchgs);
1.987 raeburn 13078: }
13079:
13080: sub modify_html_form {
13081: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
13082: my $end = 0;
13083: my $modifyform;
13084: if ($context eq 'upload_embedded') {
13085: return unless (ref($pathchange) eq 'HASH');
13086: if ($env{'form.number_embedded_items'}) {
13087: $end += $env{'form.number_embedded_items'};
13088: }
13089: if ($env{'form.number_pathchange_items'}) {
13090: $end += $env{'form.number_pathchange_items'};
13091: }
13092: if ($end) {
13093: for (my $i=0; $i<$end; $i++) {
13094: if ($i < $env{'form.number_embedded_items'}) {
13095: next unless($pathchange->{$i});
13096: }
13097: $modifyform .=
13098: &start_data_table_row().
13099: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
13100: 'checked="checked" /></td>'.
13101: '<td>'.$env{'form.embedded_ref_'.$i}.
13102: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
13103: &escape($env{'form.embedded_ref_'.$i}).'" />'.
13104: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
13105: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
13106: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
13107: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
13108: '<td>'.$env{'form.embedded_orig_'.$i}.
13109: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
13110: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
13111: &end_data_table_row();
1.1071 raeburn 13112: }
1.987 raeburn 13113: }
13114: } else {
13115: $modifyform = $pathchgtable;
13116: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
13117: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
13118: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
13119: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
13120: }
13121: }
13122: if ($modifyform) {
1.1071 raeburn 13123: if ($actionurl eq '/adm/dependencies') {
13124: $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
13125: }
1.987 raeburn 13126: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
13127: '<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".
13128: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
13129: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
13130: '</ol></p>'."\n".'<p>'.
13131: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
13132: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
13133: &start_data_table()."\n".
13134: &start_data_table_header_row().
13135: '<th>'.&mt('Change?').'</th>'.
13136: '<th>'.&mt('Current reference').'</th>'.
13137: '<th>'.&mt('Required reference').'</th>'.
13138: &end_data_table_header_row()."\n".
13139: $modifyform.
13140: &end_data_table().'<br />'."\n".$hiddenstate.
13141: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
13142: '</form>'."\n";
13143: }
13144: return;
13145: }
13146:
13147: sub modify_html_refs {
1.1123 raeburn 13148: my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987 raeburn 13149: my $container;
13150: if ($context eq 'portfolio') {
13151: $container = $env{'form.container'};
13152: } elsif ($context eq 'coursedoc') {
13153: $container = $env{'form.primaryurl'};
1.1071 raeburn 13154: } elsif ($context eq 'manage_dependencies') {
13155: (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
13156: $container = "/$container";
1.1123 raeburn 13157: } elsif ($context eq 'syllabus') {
13158: $container = $url;
1.987 raeburn 13159: } else {
1.1027 raeburn 13160: $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987 raeburn 13161: }
13162: my (%allfiles,%codebase,$output,$content);
13163: my @changes = &get_env_multiple('form.namechange');
1.1126 raeburn 13164: unless ((@changes > 0) || ($context eq 'syllabus')) {
1.1071 raeburn 13165: if (wantarray) {
13166: return ('',0,0);
13167: } else {
13168: return;
13169: }
13170: }
13171: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 13172: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071 raeburn 13173: unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
13174: if (wantarray) {
13175: return ('',0,0);
13176: } else {
13177: return;
13178: }
13179: }
1.987 raeburn 13180: $content = &Apache::lonnet::getfile($container);
1.1071 raeburn 13181: if ($content eq '-1') {
13182: if (wantarray) {
13183: return ('',0,0);
13184: } else {
13185: return;
13186: }
13187: }
1.987 raeburn 13188: } else {
1.1071 raeburn 13189: unless ($container =~ /^\Q$dir_root\E/) {
13190: if (wantarray) {
13191: return ('',0,0);
13192: } else {
13193: return;
13194: }
13195: }
1.1317 raeburn 13196: if (open(my $fh,'<',$container)) {
1.987 raeburn 13197: $content = join('', <$fh>);
13198: close($fh);
13199: } else {
1.1071 raeburn 13200: if (wantarray) {
13201: return ('',0,0);
13202: } else {
13203: return;
13204: }
1.987 raeburn 13205: }
13206: }
13207: my ($count,$codebasecount) = (0,0);
13208: my $mm = new File::MMagic;
13209: my $mime_type = $mm->checktype_contents($content);
13210: if ($mime_type eq 'text/html') {
13211: my $parse_result =
13212: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
13213: \%codebase,\$content);
13214: if ($parse_result eq 'ok') {
13215: foreach my $i (@changes) {
13216: my $orig = &unescape($env{'form.embedded_orig_'.$i});
13217: my $ref = &unescape($env{'form.embedded_ref_'.$i});
13218: if ($allfiles{$ref}) {
13219: my $newname = $orig;
13220: my ($attrib_regexp,$codebase);
1.1006 raeburn 13221: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 13222: if ($attrib_regexp =~ /:/) {
13223: $attrib_regexp =~ s/\:/|/g;
13224: }
13225: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
13226: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
13227: $count += $numchg;
1.1123 raeburn 13228: $allfiles{$newname} = $allfiles{$ref};
1.1148 raeburn 13229: delete($allfiles{$ref});
1.987 raeburn 13230: }
13231: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 13232: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 13233: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
13234: $codebasecount ++;
13235: }
13236: }
13237: }
1.1123 raeburn 13238: my $skiprewrites;
1.987 raeburn 13239: if ($count || $codebasecount) {
13240: my $saveresult;
1.1071 raeburn 13241: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 13242: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987 raeburn 13243: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
13244: if ($url eq $container) {
13245: my ($fname) = ($container =~ m{/([^/]+)$});
13246: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
13247: $count,'<span class="LC_filename">'.
1.1071 raeburn 13248: $fname.'</span>').'</p>';
1.987 raeburn 13249: } else {
13250: $output = '<p class="LC_error">'.
13251: &mt('Error: update failed for: [_1].',
13252: '<span class="LC_filename">'.
13253: $container.'</span>').'</p>';
13254: }
1.1123 raeburn 13255: if ($context eq 'syllabus') {
13256: unless ($saveresult eq 'ok') {
13257: $skiprewrites = 1;
13258: }
13259: }
1.987 raeburn 13260: } else {
1.1317 raeburn 13261: if (open(my $fh,'>',$container)) {
1.987 raeburn 13262: print $fh $content;
13263: close($fh);
13264: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
13265: $count,'<span class="LC_filename">'.
13266: $container.'</span>').'</p>';
1.661 raeburn 13267: } else {
1.987 raeburn 13268: $output = '<p class="LC_error">'.
13269: &mt('Error: could not update [_1].',
13270: '<span class="LC_filename">'.
13271: $container.'</span>').'</p>';
1.661 raeburn 13272: }
13273: }
13274: }
1.1123 raeburn 13275: if (($context eq 'syllabus') && (!$skiprewrites)) {
13276: my ($actionurl,$state);
13277: $actionurl = "/public/$udom/$uname/syllabus";
13278: my ($ignore,$num,$numpathchanges,$existing,$mapping) =
13279: &ask_for_embedded_content($actionurl,$state,\%allfiles,
13280: \%codebase,
13281: {'context' => 'rewrites',
13282: 'ignore_remote_references' => 1,});
13283: if (ref($mapping) eq 'HASH') {
13284: my $rewrites = 0;
13285: foreach my $key (keys(%{$mapping})) {
13286: next if ($key =~ m{^https?://});
13287: my $ref = $mapping->{$key};
13288: my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
13289: my $attrib;
13290: if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
13291: $attrib = join('|',@{$allfiles{$mapping->{$key}}});
13292: }
13293: if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
13294: my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
13295: $rewrites += $numchg;
13296: }
13297: }
13298: if ($rewrites) {
13299: my $saveresult;
13300: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
13301: if ($url eq $container) {
13302: my ($fname) = ($container =~ m{/([^/]+)$});
13303: $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
13304: $count,'<span class="LC_filename">'.
13305: $fname.'</span>').'</p>';
13306: } else {
13307: $output .= '<p class="LC_error">'.
13308: &mt('Error: could not update links in [_1].',
13309: '<span class="LC_filename">'.
13310: $container.'</span>').'</p>';
13311:
13312: }
13313: }
13314: }
13315: }
1.987 raeburn 13316: } else {
13317: &logthis('Failed to parse '.$container.
13318: ' to modify references: '.$parse_result);
1.661 raeburn 13319: }
13320: }
1.1071 raeburn 13321: if (wantarray) {
13322: return ($output,$count,$codebasecount);
13323: } else {
13324: return $output;
13325: }
1.661 raeburn 13326: }
13327:
13328: sub check_for_existing {
13329: my ($path,$fname,$element) = @_;
13330: my ($state,$msg);
13331: if (-d $path.'/'.$fname) {
13332: $state = 'exists';
13333: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
13334: } elsif (-e $path.'/'.$fname) {
13335: $state = 'exists';
13336: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
13337: }
13338: if ($state eq 'exists') {
13339: $msg = '<span class="LC_error">'.$msg.'</span><br />';
13340: }
13341: return ($state,$msg);
13342: }
13343:
13344: sub check_for_upload {
13345: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
13346: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 13347: my $filesize = length($env{'form.'.$element});
13348: if (!$filesize) {
13349: my $msg = '<span class="LC_error">'.
13350: &mt('Unable to upload [_1]. (size = [_2] bytes)',
13351: '<span class="LC_filename">'.$fname.'</span>',
13352: $filesize).'<br />'.
1.1007 raeburn 13353: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 13354: '</span>';
13355: return ('zero_bytes',$msg);
13356: }
13357: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 13358: my $getpropath = 1;
1.1021 raeburn 13359: my ($dirlistref,$listerror) =
13360: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 13361: my $found_file = 0;
13362: my $locked_file = 0;
1.991 raeburn 13363: my @lockers;
13364: my $navmap;
13365: if ($env{'request.course.id'}) {
13366: $navmap = Apache::lonnavmaps::navmap->new();
13367: }
1.1021 raeburn 13368: if (ref($dirlistref) eq 'ARRAY') {
13369: foreach my $line (@{$dirlistref}) {
13370: my ($file_name,$rest)=split(/\&/,$line,2);
13371: if ($file_name eq $fname){
13372: $file_name = $path.$file_name;
13373: if ($group ne '') {
13374: $file_name = $group.$file_name;
13375: }
13376: $found_file = 1;
13377: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
13378: foreach my $lock (@lockers) {
13379: if (ref($lock) eq 'ARRAY') {
13380: my ($symb,$crsid) = @{$lock};
13381: if ($crsid eq $env{'request.course.id'}) {
13382: if (ref($navmap)) {
13383: my $res = $navmap->getBySymb($symb);
13384: foreach my $part (@{$res->parts()}) {
13385: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
13386: unless (($slot_status == $res->RESERVED) ||
13387: ($slot_status == $res->RESERVED_LOCATION)) {
13388: $locked_file = 1;
13389: }
1.991 raeburn 13390: }
1.1021 raeburn 13391: } else {
13392: $locked_file = 1;
1.991 raeburn 13393: }
13394: } else {
13395: $locked_file = 1;
13396: }
13397: }
1.1021 raeburn 13398: }
13399: } else {
13400: my @info = split(/\&/,$rest);
13401: my $currsize = $info[6]/1000;
13402: if ($currsize < $filesize) {
13403: my $extra = $filesize - $currsize;
13404: if (($current_disk_usage + $extra) > $disk_quota) {
1.1179 bisitz 13405: my $msg = '<p class="LC_warning">'.
1.1021 raeburn 13406: &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 13407: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
13408: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
13409: $disk_quota,$current_disk_usage).'</p>';
1.1021 raeburn 13410: return ('will_exceed_quota',$msg);
13411: }
1.984 raeburn 13412: }
13413: }
1.661 raeburn 13414: }
13415: }
13416: }
13417: if (($current_disk_usage + $filesize) > $disk_quota){
1.1179 bisitz 13418: my $msg = '<p class="LC_warning">'.
13419: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
1.1184 raeburn 13420: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661 raeburn 13421: return ('will_exceed_quota',$msg);
13422: } elsif ($found_file) {
13423: if ($locked_file) {
1.1179 bisitz 13424: my $msg = '<p class="LC_warning">';
1.661 raeburn 13425: $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 13426: $msg .= '</p>';
1.661 raeburn 13427: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
13428: return ('file_locked',$msg);
13429: } else {
1.1179 bisitz 13430: my $msg = '<p class="LC_error">';
1.984 raeburn 13431: $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 13432: $msg .= '</p>';
1.984 raeburn 13433: return ('existingfile',$msg);
1.661 raeburn 13434: }
13435: }
13436: }
13437:
1.987 raeburn 13438: sub check_for_traversal {
13439: my ($path,$url,$toplevel) = @_;
13440: my @parts=split(/\//,$path);
13441: my $cleanpath;
13442: my $fullpath = $url;
13443: for (my $i=0;$i<@parts;$i++) {
13444: next if ($parts[$i] eq '.');
13445: if ($parts[$i] eq '..') {
13446: $fullpath =~ s{([^/]+/)$}{};
13447: } else {
13448: $fullpath .= $parts[$i].'/';
13449: }
13450: }
13451: if ($fullpath =~ /^\Q$url\E(.*)$/) {
13452: $cleanpath = $1;
13453: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
13454: my $curr_toprel = $1;
13455: my @parts = split(/\//,$curr_toprel);
13456: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
13457: my @urlparts = split(/\//,$url_toprel);
13458: my $doubledots;
13459: my $startdiff = -1;
13460: for (my $i=0; $i<@urlparts; $i++) {
13461: if ($startdiff == -1) {
13462: unless ($urlparts[$i] eq $parts[$i]) {
13463: $startdiff = $i;
13464: $doubledots .= '../';
13465: }
13466: } else {
13467: $doubledots .= '../';
13468: }
13469: }
13470: if ($startdiff > -1) {
13471: $cleanpath = $doubledots;
13472: for (my $i=$startdiff; $i<@parts; $i++) {
13473: $cleanpath .= $parts[$i].'/';
13474: }
13475: }
13476: }
13477: $cleanpath =~ s{(/)$}{};
13478: return $cleanpath;
13479: }
1.31 albertel 13480:
1.1053 raeburn 13481: sub is_archive_file {
13482: my ($mimetype) = @_;
13483: if (($mimetype eq 'application/octet-stream') ||
13484: ($mimetype eq 'application/x-stuffit') ||
13485: ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
13486: return 1;
13487: }
13488: return;
13489: }
13490:
13491: sub decompress_form {
1.1065 raeburn 13492: my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053 raeburn 13493: my %lt = &Apache::lonlocal::texthash (
13494: this => 'This file is an archive file.',
1.1067 raeburn 13495: camt => 'This file is a Camtasia archive file.',
1.1065 raeburn 13496: itsc => 'Its contents are as follows:',
1.1053 raeburn 13497: youm => 'You may wish to extract its contents.',
13498: extr => 'Extract contents',
1.1067 raeburn 13499: auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
13500: proa => 'Process automatically?',
1.1053 raeburn 13501: yes => 'Yes',
13502: no => 'No',
1.1067 raeburn 13503: fold => 'Title for folder containing movie',
13504: movi => 'Title for page containing embedded movie',
1.1053 raeburn 13505: );
1.1065 raeburn 13506: my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067 raeburn 13507: my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065 raeburn 13508: my $info = &list_archive_contents($fileloc,\@paths);
13509: if (@paths) {
13510: foreach my $path (@paths) {
13511: $path =~ s{^/}{};
1.1067 raeburn 13512: if ($path =~ m{^([^/]+)/$}) {
13513: $topdir = $1;
13514: }
1.1065 raeburn 13515: if ($path =~ m{^([^/]+)/}) {
13516: $toplevel{$1} = $path;
13517: } else {
13518: $toplevel{$path} = $path;
13519: }
13520: }
13521: }
1.1067 raeburn 13522: if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1164 raeburn 13523: my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067 raeburn 13524: "$topdir/media/",
13525: "$topdir/media/$topdir.mp4",
13526: "$topdir/media/FirstFrame.png",
13527: "$topdir/media/player.swf",
13528: "$topdir/media/swfobject.js",
13529: "$topdir/media/expressInstall.swf");
1.1197 raeburn 13530: my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1164 raeburn 13531: "$topdir/$topdir.mp4",
13532: "$topdir/$topdir\_config.xml",
13533: "$topdir/$topdir\_controller.swf",
13534: "$topdir/$topdir\_embed.css",
13535: "$topdir/$topdir\_First_Frame.png",
13536: "$topdir/$topdir\_player.html",
13537: "$topdir/$topdir\_Thumbnails.png",
13538: "$topdir/playerProductInstall.swf",
13539: "$topdir/scripts/",
13540: "$topdir/scripts/config_xml.js",
13541: "$topdir/scripts/handlebars.js",
13542: "$topdir/scripts/jquery-1.7.1.min.js",
13543: "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
13544: "$topdir/scripts/modernizr.js",
13545: "$topdir/scripts/player-min.js",
13546: "$topdir/scripts/swfobject.js",
13547: "$topdir/skins/",
13548: "$topdir/skins/configuration_express.xml",
13549: "$topdir/skins/express_show/",
13550: "$topdir/skins/express_show/player-min.css",
13551: "$topdir/skins/express_show/spritesheet.png");
1.1197 raeburn 13552: my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
13553: "$topdir/$topdir.mp4",
13554: "$topdir/$topdir\_config.xml",
13555: "$topdir/$topdir\_controller.swf",
13556: "$topdir/$topdir\_embed.css",
13557: "$topdir/$topdir\_First_Frame.png",
13558: "$topdir/$topdir\_player.html",
13559: "$topdir/$topdir\_Thumbnails.png",
13560: "$topdir/playerProductInstall.swf",
13561: "$topdir/scripts/",
13562: "$topdir/scripts/config_xml.js",
13563: "$topdir/scripts/techsmith-smart-player.min.js",
13564: "$topdir/skins/",
13565: "$topdir/skins/configuration_express.xml",
13566: "$topdir/skins/express_show/",
13567: "$topdir/skins/express_show/spritesheet.min.css",
13568: "$topdir/skins/express_show/spritesheet.png",
13569: "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1164 raeburn 13570: my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067 raeburn 13571: if (@diffs == 0) {
1.1164 raeburn 13572: $is_camtasia = 6;
13573: } else {
1.1197 raeburn 13574: @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1164 raeburn 13575: if (@diffs == 0) {
13576: $is_camtasia = 8;
1.1197 raeburn 13577: } else {
13578: @diffs = &compare_arrays(\@paths,\@camtasia8_4);
13579: if (@diffs == 0) {
13580: $is_camtasia = 8;
13581: }
1.1164 raeburn 13582: }
1.1067 raeburn 13583: }
13584: }
13585: my $output;
13586: if ($is_camtasia) {
13587: $output = <<"ENDCAM";
13588: <script type="text/javascript" language="Javascript">
13589: // <![CDATA[
13590:
13591: function camtasiaToggle() {
13592: for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
13593: if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1164 raeburn 13594: if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067 raeburn 13595: document.getElementById('camtasia_titles').style.display='block';
13596: } else {
13597: document.getElementById('camtasia_titles').style.display='none';
13598: }
13599: }
13600: }
13601: return;
13602: }
13603:
13604: // ]]>
13605: </script>
13606: <p>$lt{'camt'}</p>
13607: ENDCAM
1.1065 raeburn 13608: } else {
1.1067 raeburn 13609: $output = '<p>'.$lt{'this'};
13610: if ($info eq '') {
13611: $output .= ' '.$lt{'youm'}.'</p>'."\n";
13612: } else {
13613: $output .= ' '.$lt{'itsc'}.'</p>'."\n".
13614: '<div><pre>'.$info.'</pre></div>';
13615: }
1.1065 raeburn 13616: }
1.1067 raeburn 13617: $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065 raeburn 13618: my $duplicates;
13619: my $num = 0;
13620: if (ref($dirlist) eq 'ARRAY') {
13621: foreach my $item (@{$dirlist}) {
13622: if (ref($item) eq 'ARRAY') {
13623: if (exists($toplevel{$item->[0]})) {
13624: $duplicates .=
13625: &start_data_table_row().
13626: '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
13627: 'value="0" checked="checked" />'.&mt('No').'</label>'.
13628: ' <label><input type="radio" name="archive_overwrite_'.$num.'" '.
13629: 'value="1" />'.&mt('Yes').'</label>'.
13630: '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
13631: '<td>'.$item->[0].'</td>';
13632: if ($item->[2]) {
13633: $duplicates .= '<td>'.&mt('Directory').'</td>';
13634: } else {
13635: $duplicates .= '<td>'.&mt('File').'</td>';
13636: }
13637: $duplicates .= '<td>'.$item->[3].'</td>'.
13638: '<td>'.
13639: &Apache::lonlocal::locallocaltime($item->[4]).
13640: '</td>'.
13641: &end_data_table_row();
13642: $num ++;
13643: }
13644: }
13645: }
13646: }
13647: my $itemcount;
13648: if (@paths > 0) {
13649: $itemcount = scalar(@paths);
13650: } else {
13651: $itemcount = 1;
13652: }
1.1067 raeburn 13653: if ($is_camtasia) {
13654: $output .= $lt{'auto'}.'<br />'.
13655: '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1164 raeburn 13656: '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067 raeburn 13657: $lt{'yes'}.'</label> <label>'.
13658: '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
13659: $lt{'no'}.'</label></span><br />'.
13660: '<div id="camtasia_titles" style="display:block">'.
13661: &Apache::lonhtmlcommon::start_pick_box().
13662: &Apache::lonhtmlcommon::row_title($lt{'fold'}).
13663: '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
13664: &Apache::lonhtmlcommon::row_closure().
13665: &Apache::lonhtmlcommon::row_title($lt{'movi'}).
13666: '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
13667: &Apache::lonhtmlcommon::row_closure(1).
13668: &Apache::lonhtmlcommon::end_pick_box().
13669: '</div>';
13670: }
1.1065 raeburn 13671: $output .=
13672: '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067 raeburn 13673: '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
13674: "\n";
1.1065 raeburn 13675: if ($duplicates ne '') {
13676: $output .= '<p><span class="LC_warning">'.
13677: &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.
13678: &start_data_table().
13679: &start_data_table_header_row().
13680: '<th>'.&mt('Overwrite?').'</th>'.
13681: '<th>'.&mt('Name').'</th>'.
13682: '<th>'.&mt('Type').'</th>'.
13683: '<th>'.&mt('Size').'</th>'.
13684: '<th>'.&mt('Last modified').'</th>'.
13685: &end_data_table_header_row().
13686: $duplicates.
13687: &end_data_table().
13688: '</p>';
13689: }
1.1067 raeburn 13690: $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053 raeburn 13691: if (ref($hiddenelements) eq 'HASH') {
13692: foreach my $hidden (sort(keys(%{$hiddenelements}))) {
13693: $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
13694: }
13695: }
13696: $output .= <<"END";
1.1067 raeburn 13697: <br />
1.1053 raeburn 13698: <input type="submit" name="decompress" value="$lt{'extr'}" />
13699: </form>
13700: $noextract
13701: END
13702: return $output;
13703: }
13704:
1.1065 raeburn 13705: sub decompression_utility {
13706: my ($program) = @_;
13707: my @utilities = ('tar','gunzip','bunzip2','unzip');
13708: my $location;
13709: if (grep(/^\Q$program\E$/,@utilities)) {
13710: foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
13711: '/usr/sbin/') {
13712: if (-x $dir.$program) {
13713: $location = $dir.$program;
13714: last;
13715: }
13716: }
13717: }
13718: return $location;
13719: }
13720:
13721: sub list_archive_contents {
13722: my ($file,$pathsref) = @_;
13723: my (@cmd,$output);
13724: my $needsregexp;
13725: if ($file =~ /\.zip$/) {
13726: @cmd = (&decompression_utility('unzip'),"-l");
13727: $needsregexp = 1;
13728: } elsif (($file =~ m/\.tar\.gz$/) ||
13729: ($file =~ /\.tgz$/)) {
13730: @cmd = (&decompression_utility('tar'),"-ztf");
13731: } elsif ($file =~ /\.tar\.bz2$/) {
13732: @cmd = (&decompression_utility('tar'),"-jtf");
13733: } elsif ($file =~ m|\.tar$|) {
13734: @cmd = (&decompression_utility('tar'),"-tf");
13735: }
13736: if (@cmd) {
13737: undef($!);
13738: undef($@);
13739: if (open(my $fh,"-|", @cmd, $file)) {
13740: while (my $line = <$fh>) {
13741: $output .= $line;
13742: chomp($line);
13743: my $item;
13744: if ($needsregexp) {
13745: ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/);
13746: } else {
13747: $item = $line;
13748: }
13749: if ($item ne '') {
13750: unless (grep(/^\Q$item\E$/,@{$pathsref})) {
13751: push(@{$pathsref},$item);
13752: }
13753: }
13754: }
13755: close($fh);
13756: }
13757: }
13758: return $output;
13759: }
13760:
1.1053 raeburn 13761: sub decompress_uploaded_file {
13762: my ($file,$dir) = @_;
13763: &Apache::lonnet::appenv({'cgi.file' => $file});
13764: &Apache::lonnet::appenv({'cgi.dir' => $dir});
13765: my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
13766: my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
13767: my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
13768: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
13769: my $decompressed = $env{'cgi.decompressed'};
13770: &Apache::lonnet::delenv('cgi.file');
13771: &Apache::lonnet::delenv('cgi.dir');
13772: &Apache::lonnet::delenv('cgi.decompressed');
13773: return ($decompressed,$result);
13774: }
13775:
1.1055 raeburn 13776: sub process_decompression {
13777: my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1292 raeburn 13778: unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
13779: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
13780: &mt('Unexpected file path.').'</p>'."\n";
13781: }
13782: unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
13783: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
13784: &mt('Unexpected course context.').'</p>'."\n";
13785: }
1.1293 raeburn 13786: unless ($file eq &Apache::lonnet::clean_filename($file)) {
1.1292 raeburn 13787: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
13788: &mt('Filename contained unexpected characters.').'</p>'."\n";
13789: }
1.1055 raeburn 13790: my ($dir,$error,$warning,$output);
1.1180 raeburn 13791: if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1120 bisitz 13792: $error = &mt('Filename not a supported archive file type.').
13793: '<br />'.&mt('Filename should end with one of: [_1].',
1.1055 raeburn 13794: '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
13795: } else {
13796: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
13797: if ($docuhome eq 'no_host') {
13798: $error = &mt('Could not determine home server for course.');
13799: } else {
13800: my @ids=&Apache::lonnet::current_machine_ids();
13801: my $currdir = "$dir_root/$destination";
13802: if (grep(/^\Q$docuhome\E$/,@ids)) {
13803: $dir = &LONCAPA::propath($docudom,$docuname).
13804: "$dir_root/$destination";
13805: } else {
13806: $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
13807: "$dir_root/$docudom/$docuname/$destination";
13808: unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
13809: $error = &mt('Archive file not found.');
13810: }
13811: }
1.1065 raeburn 13812: my (@to_overwrite,@to_skip);
13813: if ($env{'form.archive_overwrite_total'} > 0) {
13814: my $total = $env{'form.archive_overwrite_total'};
13815: for (my $i=0; $i<$total; $i++) {
13816: if ($env{'form.archive_overwrite_'.$i} == 1) {
13817: push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
13818: } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
13819: push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
13820: }
13821: }
13822: }
13823: my $numskip = scalar(@to_skip);
1.1292 raeburn 13824: my $numoverwrite = scalar(@to_overwrite);
13825: if (($numskip) && (!$numoverwrite)) {
1.1065 raeburn 13826: $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');
13827: } elsif ($dir eq '') {
1.1055 raeburn 13828: $error = &mt('Directory containing archive file unavailable.');
13829: } elsif (!$error) {
1.1065 raeburn 13830: my ($decompressed,$display);
1.1292 raeburn 13831: if (($numskip) || ($numoverwrite)) {
1.1065 raeburn 13832: my $tempdir = time.'_'.$$.int(rand(10000));
13833: mkdir("$dir/$tempdir",0755);
1.1292 raeburn 13834: if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
13835: ($decompressed,$display) =
13836: &decompress_uploaded_file($file,"$dir/$tempdir");
13837: foreach my $item (@to_skip) {
13838: if (($item ne '') && ($item !~ /\.\./)) {
13839: if (-f "$dir/$tempdir/$item") {
13840: unlink("$dir/$tempdir/$item");
13841: } elsif (-d "$dir/$tempdir/$item") {
1.1300 raeburn 13842: &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
1.1292 raeburn 13843: }
13844: }
13845: }
13846: foreach my $item (@to_overwrite) {
13847: if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
13848: if (($item ne '') && ($item !~ /\.\./)) {
13849: if (-f "$dir/$item") {
13850: unlink("$dir/$item");
13851: } elsif (-d "$dir/$item") {
1.1300 raeburn 13852: &File::Path::remove_tree("$dir/$item",{ safe => 1 });
1.1292 raeburn 13853: }
13854: &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
13855: }
1.1065 raeburn 13856: }
13857: }
1.1292 raeburn 13858: if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
1.1300 raeburn 13859: &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
1.1292 raeburn 13860: }
1.1065 raeburn 13861: }
13862: } else {
13863: ($decompressed,$display) =
13864: &decompress_uploaded_file($file,$dir);
13865: }
1.1055 raeburn 13866: if ($decompressed eq 'ok') {
1.1065 raeburn 13867: $output = '<p class="LC_info">'.
13868: &mt('Files extracted successfully from archive.').
13869: '</p>'."\n";
1.1055 raeburn 13870: my ($warning,$result,@contents);
13871: my ($newdirlistref,$newlisterror) =
13872: &Apache::lonnet::dirlist($currdir,$docudom,
13873: $docuname,1);
13874: my (%is_dir,%changes,@newitems);
13875: my $dirptr = 16384;
1.1065 raeburn 13876: if (ref($newdirlistref) eq 'ARRAY') {
1.1055 raeburn 13877: foreach my $dir_line (@{$newdirlistref}) {
13878: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1292 raeburn 13879: unless (($item =~ /^\.+$/) || ($item eq $file)) {
1.1055 raeburn 13880: push(@newitems,$item);
13881: if ($dirptr&$testdir) {
13882: $is_dir{$item} = 1;
13883: }
13884: $changes{$item} = 1;
13885: }
13886: }
13887: }
13888: if (keys(%changes) > 0) {
13889: foreach my $item (sort(@newitems)) {
13890: if ($changes{$item}) {
13891: push(@contents,$item);
13892: }
13893: }
13894: }
13895: if (@contents > 0) {
1.1067 raeburn 13896: my $wantform;
13897: unless ($env{'form.autoextract_camtasia'}) {
13898: $wantform = 1;
13899: }
1.1056 raeburn 13900: my (%children,%parent,%dirorder,%titles);
1.1055 raeburn 13901: my ($count,$datatable) = &get_extracted($docudom,$docuname,
13902: $currdir,\%is_dir,
13903: \%children,\%parent,
1.1056 raeburn 13904: \@contents,\%dirorder,
13905: \%titles,$wantform);
1.1055 raeburn 13906: if ($datatable ne '') {
13907: $output .= &archive_options_form('decompressed',$datatable,
13908: $count,$hiddenelem);
1.1065 raeburn 13909: my $startcount = 6;
1.1055 raeburn 13910: $output .= &archive_javascript($startcount,$count,
1.1056 raeburn 13911: \%titles,\%children);
1.1055 raeburn 13912: }
1.1067 raeburn 13913: if ($env{'form.autoextract_camtasia'}) {
1.1164 raeburn 13914: my $version = $env{'form.autoextract_camtasia'};
1.1067 raeburn 13915: my %displayed;
13916: my $total = 1;
13917: $env{'form.archive_directory'} = [];
13918: foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
13919: my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
13920: $path =~ s{/$}{};
13921: my $item;
13922: if ($path ne '') {
13923: $item = "$path/$titles{$i}";
13924: } else {
13925: $item = $titles{$i};
13926: }
13927: $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
13928: if ($item eq $contents[0]) {
13929: push(@{$env{'form.archive_directory'}},$i);
13930: $env{'form.archive_'.$i} = 'display';
13931: $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
13932: $displayed{'folder'} = $i;
1.1164 raeburn 13933: } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
13934: (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067 raeburn 13935: $env{'form.archive_'.$i} = 'display';
13936: $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
13937: $displayed{'web'} = $i;
13938: } else {
1.1164 raeburn 13939: if ((($item eq "$contents[0]/media") && ($version == 6)) ||
13940: ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
13941: ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067 raeburn 13942: push(@{$env{'form.archive_directory'}},$i);
13943: }
13944: $env{'form.archive_'.$i} = 'dependency';
13945: }
13946: $total ++;
13947: }
13948: for (my $i=1; $i<$total; $i++) {
13949: next if ($i == $displayed{'web'});
13950: next if ($i == $displayed{'folder'});
13951: $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
13952: }
13953: $env{'form.phase'} = 'decompress_cleanup';
13954: $env{'form.archivedelete'} = 1;
13955: $env{'form.archive_count'} = $total-1;
13956: $output .=
13957: &process_extracted_files('coursedocs',$docudom,
13958: $docuname,$destination,
13959: $dir_root,$hiddenelem);
13960: }
1.1055 raeburn 13961: } else {
13962: $warning = &mt('No new items extracted from archive file.');
13963: }
13964: } else {
13965: $output = $display;
13966: $error = &mt('An error occurred during extraction from the archive file.');
13967: }
13968: }
13969: }
13970: }
13971: if ($error) {
13972: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
13973: $error.'</p>'."\n";
13974: }
13975: if ($warning) {
13976: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
13977: }
13978: return $output;
13979: }
13980:
13981: sub get_extracted {
1.1056 raeburn 13982: my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
13983: $titles,$wantform) = @_;
1.1055 raeburn 13984: my $count = 0;
13985: my $depth = 0;
13986: my $datatable;
1.1056 raeburn 13987: my @hierarchy;
1.1055 raeburn 13988: return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056 raeburn 13989: (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
13990: (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055 raeburn 13991: foreach my $item (@{$contents}) {
13992: $count ++;
1.1056 raeburn 13993: @{$dirorder->{$count}} = @hierarchy;
13994: $titles->{$count} = $item;
1.1055 raeburn 13995: &archive_hierarchy($depth,$count,$parent,$children);
13996: if ($wantform) {
13997: $datatable .= &archive_row($is_dir->{$item},$item,
13998: $currdir,$depth,$count);
13999: }
14000: if ($is_dir->{$item}) {
14001: $depth ++;
1.1056 raeburn 14002: push(@hierarchy,$count);
14003: $parent->{$depth} = $count;
1.1055 raeburn 14004: $datatable .=
14005: &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056 raeburn 14006: \$depth,\$count,\@hierarchy,$dirorder,
14007: $children,$parent,$titles,$wantform);
1.1055 raeburn 14008: $depth --;
1.1056 raeburn 14009: pop(@hierarchy);
1.1055 raeburn 14010: }
14011: }
14012: return ($count,$datatable);
14013: }
14014:
14015: sub recurse_extracted_archive {
1.1056 raeburn 14016: my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
14017: $children,$parent,$titles,$wantform) = @_;
1.1055 raeburn 14018: my $result='';
1.1056 raeburn 14019: unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
14020: (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
14021: (ref($dirorder) eq 'HASH')) {
1.1055 raeburn 14022: return $result;
14023: }
14024: my $dirptr = 16384;
14025: my ($newdirlistref,$newlisterror) =
14026: &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
14027: if (ref($newdirlistref) eq 'ARRAY') {
14028: foreach my $dir_line (@{$newdirlistref}) {
14029: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
14030: unless ($item =~ /^\.+$/) {
14031: $$count ++;
1.1056 raeburn 14032: @{$dirorder->{$$count}} = @{$hierarchy};
14033: $titles->{$$count} = $item;
1.1055 raeburn 14034: &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056 raeburn 14035:
1.1055 raeburn 14036: my $is_dir;
14037: if ($dirptr&$testdir) {
14038: $is_dir = 1;
14039: }
14040: if ($wantform) {
14041: $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
14042: }
14043: if ($is_dir) {
14044: $$depth ++;
1.1056 raeburn 14045: push(@{$hierarchy},$$count);
14046: $parent->{$$depth} = $$count;
1.1055 raeburn 14047: $result .=
14048: &recurse_extracted_archive("$currdir/$item",$docudom,
14049: $docuname,$depth,$count,
1.1056 raeburn 14050: $hierarchy,$dirorder,$children,
14051: $parent,$titles,$wantform);
1.1055 raeburn 14052: $$depth --;
1.1056 raeburn 14053: pop(@{$hierarchy});
1.1055 raeburn 14054: }
14055: }
14056: }
14057: }
14058: return $result;
14059: }
14060:
14061: sub archive_hierarchy {
14062: my ($depth,$count,$parent,$children) =@_;
14063: if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
14064: if (exists($parent->{$depth})) {
14065: $children->{$parent->{$depth}} .= $count.':';
14066: }
14067: }
14068: return;
14069: }
14070:
14071: sub archive_row {
14072: my ($is_dir,$item,$currdir,$depth,$count) = @_;
14073: my ($name) = ($item =~ m{([^/]+)$});
14074: my %choices = &Apache::lonlocal::texthash (
1.1059 raeburn 14075: 'display' => 'Add as file',
1.1055 raeburn 14076: 'dependency' => 'Include as dependency',
14077: 'discard' => 'Discard',
14078: );
14079: if ($is_dir) {
1.1059 raeburn 14080: $choices{'display'} = &mt('Add as folder');
1.1055 raeburn 14081: }
1.1056 raeburn 14082: my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
14083: my $offset = 0;
1.1055 raeburn 14084: foreach my $action ('display','dependency','discard') {
1.1056 raeburn 14085: $offset ++;
1.1065 raeburn 14086: if ($action ne 'display') {
14087: $offset ++;
14088: }
1.1055 raeburn 14089: $output .= '<td><span class="LC_nobreak">'.
14090: '<label><input type="radio" name="archive_'.$count.
14091: '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
14092: my $text = $choices{$action};
14093: if ($is_dir) {
14094: $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
14095: if ($action eq 'display') {
1.1059 raeburn 14096: $text = &mt('Add as folder');
1.1055 raeburn 14097: }
1.1056 raeburn 14098: } else {
14099: $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
14100:
14101: }
14102: $output .= ' /> '.$choices{$action}.'</label></span>';
14103: if ($action eq 'dependency') {
14104: $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
14105: &mt('Used by:').' <select name="archive_dependent_on_'.$count.'" '.
14106: 'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
14107: '<option value=""></option>'."\n".
14108: '</select>'."\n".
14109: '</div>';
1.1059 raeburn 14110: } elsif ($action eq 'display') {
14111: $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
14112: &mt('Title:').' <input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
14113: '</div>';
1.1055 raeburn 14114: }
1.1056 raeburn 14115: $output .= '</td>';
1.1055 raeburn 14116: }
14117: $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
14118: &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.(' ' x 2);
14119: for (my $i=0; $i<$depth; $i++) {
14120: $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
14121: }
14122: if ($is_dir) {
14123: $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" /> '."\n".
14124: '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
14125: } else {
14126: $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
14127: }
14128: $output .= ' '.$name.'</td>'."\n".
14129: &end_data_table_row();
14130: return $output;
14131: }
14132:
14133: sub archive_options_form {
1.1065 raeburn 14134: my ($form,$display,$count,$hiddenelem) = @_;
14135: my %lt = &Apache::lonlocal::texthash(
14136: perm => 'Permanently remove archive file?',
14137: hows => 'How should each extracted item be incorporated in the course?',
14138: cont => 'Content actions for all',
14139: addf => 'Add as folder/file',
14140: incd => 'Include as dependency for a displayed file',
14141: disc => 'Discard',
14142: no => 'No',
14143: yes => 'Yes',
14144: save => 'Save',
14145: );
14146: my $output = <<"END";
14147: <form name="$form" method="post" action="">
14148: <p><span class="LC_nobreak">$lt{'perm'}
14149: <label>
14150: <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
14151: </label>
14152:
14153: <label>
14154: <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
14155: </span>
14156: </p>
14157: <input type="hidden" name="phase" value="decompress_cleanup" />
14158: <br />$lt{'hows'}
14159: <div class="LC_columnSection">
14160: <fieldset>
14161: <legend>$lt{'cont'}</legend>
14162: <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" />
14163: <input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
14164: <input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
14165: </fieldset>
14166: </div>
14167: END
14168: return $output.
1.1055 raeburn 14169: &start_data_table()."\n".
1.1065 raeburn 14170: $display."\n".
1.1055 raeburn 14171: &end_data_table()."\n".
14172: '<input type="hidden" name="archive_count" value="'.$count.'" />'.
14173: $hiddenelem.
1.1065 raeburn 14174: '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055 raeburn 14175: '</form>';
14176: }
14177:
14178: sub archive_javascript {
1.1056 raeburn 14179: my ($startcount,$numitems,$titles,$children) = @_;
14180: return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059 raeburn 14181: my $maintitle = $env{'form.comment'};
1.1055 raeburn 14182: my $scripttag = <<START;
14183: <script type="text/javascript">
14184: // <![CDATA[
14185:
14186: function checkAll(form,prefix) {
14187: var idstr = new RegExp("^archive_"+prefix+"_\\\\d+\$");
14188: for (var i=0; i < form.elements.length; i++) {
14189: var id = form.elements[i].id;
14190: if ((id != '') && (id != undefined)) {
14191: if (idstr.test(id)) {
14192: if (form.elements[i].type == 'radio') {
14193: form.elements[i].checked = true;
1.1056 raeburn 14194: var nostart = i-$startcount;
1.1059 raeburn 14195: var offset = nostart%7;
14196: var count = (nostart-offset)/7;
1.1056 raeburn 14197: dependencyCheck(form,count,offset);
1.1055 raeburn 14198: }
14199: }
14200: }
14201: }
14202: }
14203:
14204: function propagateCheck(form,count) {
14205: if (count > 0) {
1.1059 raeburn 14206: var startelement = $startcount + ((count-1) * 7);
14207: for (var j=1; j<6; j++) {
14208: if ((j != 2) && (j != 4)) {
1.1056 raeburn 14209: var item = startelement + j;
14210: if (form.elements[item].type == 'radio') {
14211: if (form.elements[item].checked) {
14212: containerCheck(form,count,j);
14213: break;
14214: }
1.1055 raeburn 14215: }
14216: }
14217: }
14218: }
14219: }
14220:
14221: numitems = $numitems
1.1056 raeburn 14222: var titles = new Array(numitems);
14223: var parents = new Array(numitems);
1.1055 raeburn 14224: for (var i=0; i<numitems; i++) {
1.1056 raeburn 14225: parents[i] = new Array;
1.1055 raeburn 14226: }
1.1059 raeburn 14227: var maintitle = '$maintitle';
1.1055 raeburn 14228:
14229: START
14230:
1.1056 raeburn 14231: foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
14232: my @contents = split(/:/,$children->{$container});
1.1055 raeburn 14233: for (my $i=0; $i<@contents; $i ++) {
14234: $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
14235: }
14236: }
14237:
1.1056 raeburn 14238: foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
14239: $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
14240: }
14241:
1.1055 raeburn 14242: $scripttag .= <<END;
14243:
14244: function containerCheck(form,count,offset) {
14245: if (count > 0) {
1.1056 raeburn 14246: dependencyCheck(form,count,offset);
1.1059 raeburn 14247: var item = (offset+$startcount)+7*(count-1);
1.1055 raeburn 14248: form.elements[item].checked = true;
14249: if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
14250: if (parents[count].length > 0) {
14251: for (var j=0; j<parents[count].length; j++) {
1.1056 raeburn 14252: containerCheck(form,parents[count][j],offset);
14253: }
14254: }
14255: }
14256: }
14257: }
14258:
14259: function dependencyCheck(form,count,offset) {
14260: if (count > 0) {
1.1059 raeburn 14261: var chosen = (offset+$startcount)+7*(count-1);
14262: var depitem = $startcount + ((count-1) * 7) + 4;
1.1056 raeburn 14263: var currtype = form.elements[depitem].type;
14264: if (form.elements[chosen].value == 'dependency') {
14265: document.getElementById('arc_depon_'+count).style.display='block';
14266: form.elements[depitem].options.length = 0;
14267: form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1085 raeburn 14268: for (var i=1; i<=numitems; i++) {
14269: if (i == count) {
14270: continue;
14271: }
1.1059 raeburn 14272: var startelement = $startcount + (i-1) * 7;
14273: for (var j=1; j<6; j++) {
14274: if ((j != 2) && (j!= 4)) {
1.1056 raeburn 14275: var item = startelement + j;
14276: if (form.elements[item].type == 'radio') {
14277: if (form.elements[item].checked) {
14278: if (form.elements[item].value == 'display') {
14279: var n = form.elements[depitem].options.length;
14280: form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
14281: }
14282: }
14283: }
14284: }
14285: }
14286: }
14287: } else {
14288: document.getElementById('arc_depon_'+count).style.display='none';
14289: form.elements[depitem].options.length = 0;
14290: form.elements[depitem].options[0] = new Option('Select','',true,true);
14291: }
1.1059 raeburn 14292: titleCheck(form,count,offset);
1.1056 raeburn 14293: }
14294: }
14295:
14296: function propagateSelect(form,count,offset) {
14297: if (count > 0) {
1.1065 raeburn 14298: var item = (1+offset+$startcount)+7*(count-1);
1.1056 raeburn 14299: var picked = form.elements[item].options[form.elements[item].selectedIndex].value;
14300: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
14301: if (parents[count].length > 0) {
14302: for (var j=0; j<parents[count].length; j++) {
14303: containerSelect(form,parents[count][j],offset,picked);
1.1055 raeburn 14304: }
14305: }
14306: }
14307: }
14308: }
1.1056 raeburn 14309:
14310: function containerSelect(form,count,offset,picked) {
14311: if (count > 0) {
1.1065 raeburn 14312: var item = (offset+$startcount)+7*(count-1);
1.1056 raeburn 14313: if (form.elements[item].type == 'radio') {
14314: if (form.elements[item].value == 'dependency') {
14315: if (form.elements[item+1].type == 'select-one') {
14316: for (var i=0; i<form.elements[item+1].options.length; i++) {
14317: if (form.elements[item+1].options[i].value == picked) {
14318: form.elements[item+1].selectedIndex = i;
14319: break;
14320: }
14321: }
14322: }
14323: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
14324: if (parents[count].length > 0) {
14325: for (var j=0; j<parents[count].length; j++) {
14326: containerSelect(form,parents[count][j],offset,picked);
14327: }
14328: }
14329: }
14330: }
14331: }
14332: }
14333: }
14334:
1.1059 raeburn 14335: function titleCheck(form,count,offset) {
14336: if (count > 0) {
14337: var chosen = (offset+$startcount)+7*(count-1);
14338: var depitem = $startcount + ((count-1) * 7) + 2;
14339: var currtype = form.elements[depitem].type;
14340: if (form.elements[chosen].value == 'display') {
14341: document.getElementById('arc_title_'+count).style.display='block';
14342: if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
14343: document.getElementById('archive_title_'+count).value=maintitle;
14344: }
14345: } else {
14346: document.getElementById('arc_title_'+count).style.display='none';
14347: if (currtype == 'text') {
14348: document.getElementById('archive_title_'+count).value='';
14349: }
14350: }
14351: }
14352: return;
14353: }
14354:
1.1055 raeburn 14355: // ]]>
14356: </script>
14357: END
14358: return $scripttag;
14359: }
14360:
14361: sub process_extracted_files {
1.1067 raeburn 14362: my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055 raeburn 14363: my $numitems = $env{'form.archive_count'};
1.1294 raeburn 14364: return if ((!$numitems) || ($numitems =~ /\D/));
1.1055 raeburn 14365: my @ids=&Apache::lonnet::current_machine_ids();
14366: my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067 raeburn 14367: %folders,%containers,%mapinner,%prompttofetch);
1.1055 raeburn 14368: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
14369: if (grep(/^\Q$docuhome\E$/,@ids)) {
14370: $prefix = &LONCAPA::propath($docudom,$docuname);
14371: $pathtocheck = "$dir_root/$destination";
14372: $dir = $dir_root;
14373: $ishome = 1;
14374: } else {
14375: $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
14376: $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1294 raeburn 14377: $dir = "$dir_root/$docudom/$docuname";
1.1055 raeburn 14378: }
14379: my $currdir = "$dir_root/$destination";
14380: (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
14381: if ($env{'form.folderpath'}) {
14382: my @items = split('&',$env{'form.folderpath'});
14383: $folders{'0'} = $items[-2];
1.1099 raeburn 14384: if ($env{'form.folderpath'} =~ /\:1$/) {
14385: $containers{'0'}='page';
14386: } else {
14387: $containers{'0'}='sequence';
14388: }
1.1055 raeburn 14389: }
14390: my @archdirs = &get_env_multiple('form.archive_directory');
14391: if ($numitems) {
14392: for (my $i=1; $i<=$numitems; $i++) {
14393: my $path = $env{'form.archive_content_'.$i};
14394: if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
14395: my $item = $1;
14396: $toplevelitems{$item} = $i;
14397: if (grep(/^\Q$i\E$/,@archdirs)) {
14398: $is_dir{$item} = 1;
14399: }
14400: }
14401: }
14402: }
1.1067 raeburn 14403: my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055 raeburn 14404: if (keys(%toplevelitems) > 0) {
14405: my @contents = sort(keys(%toplevelitems));
1.1056 raeburn 14406: (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
14407: \%parent,\@contents,\%dirorder,\%titles);
1.1055 raeburn 14408: }
1.1066 raeburn 14409: my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055 raeburn 14410: if ($numitems) {
14411: for (my $i=1; $i<=$numitems; $i++) {
1.1086 raeburn 14412: next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055 raeburn 14413: my $path = $env{'form.archive_content_'.$i};
14414: if ($path =~ /^\Q$pathtocheck\E/) {
14415: if ($env{'form.archive_'.$i} eq 'discard') {
14416: if ($prefix ne '' && $path ne '') {
14417: if (-e $prefix.$path) {
1.1066 raeburn 14418: if ((@archdirs > 0) &&
14419: (grep(/^\Q$i\E$/,@archdirs))) {
14420: $todeletedir{$prefix.$path} = 1;
14421: } else {
14422: $todelete{$prefix.$path} = 1;
14423: }
1.1055 raeburn 14424: }
14425: }
14426: } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059 raeburn 14427: my ($docstitle,$title,$url,$outer);
1.1055 raeburn 14428: ($title) = ($path =~ m{/([^/]+)$});
1.1059 raeburn 14429: $docstitle = $env{'form.archive_title_'.$i};
14430: if ($docstitle eq '') {
14431: $docstitle = $title;
14432: }
1.1055 raeburn 14433: $outer = 0;
1.1056 raeburn 14434: if (ref($dirorder{$i}) eq 'ARRAY') {
14435: if (@{$dirorder{$i}} > 0) {
14436: foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055 raeburn 14437: if ($env{'form.archive_'.$item} eq 'display') {
14438: $outer = $item;
14439: last;
14440: }
14441: }
14442: }
14443: }
14444: my ($errtext,$fatal) =
14445: &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
14446: '/'.$folders{$outer}.'.'.
14447: $containers{$outer});
14448: next if ($fatal);
14449: if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
14450: if ($context eq 'coursedocs') {
1.1056 raeburn 14451: $mapinner{$i} = time;
1.1055 raeburn 14452: $folders{$i} = 'default_'.$mapinner{$i};
14453: $containers{$i} = 'sequence';
14454: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
14455: $folders{$i}.'.'.$containers{$i};
14456: my $newidx = &LONCAPA::map::getresidx();
14457: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 14458: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 14459: push(@LONCAPA::map::order,$newidx);
14460: my ($outtext,$errtext) =
14461: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
14462: $docuname.'/'.$folders{$outer}.
1.1087 raeburn 14463: '.'.$containers{$outer},1,1);
1.1056 raeburn 14464: $newseqid{$i} = $newidx;
1.1067 raeburn 14465: unless ($errtext) {
1.1294 raeburn 14466: $result .= '<li>'.&mt('Folder: [_1] added to course',
14467: &HTML::Entities::encode($docstitle,'<>&"')).
14468: '</li>'."\n";
1.1067 raeburn 14469: }
1.1055 raeburn 14470: }
14471: } else {
14472: if ($context eq 'coursedocs') {
14473: my $newidx=&LONCAPA::map::getresidx();
14474: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
14475: $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
14476: $title;
1.1392 raeburn 14477: if (($outer !~ /\D/) &&
14478: (($mapinner{$outer} eq 'default') || ($mapinner{$outer} !~ /\D/)) &&
14479: ($newidx !~ /\D/)) {
1.1294 raeburn 14480: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
14481: mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
14482: }
14483: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
14484: mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
14485: }
14486: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
14487: if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
14488: $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
14489: unless ($ishome) {
14490: my $fetch = "$newdest{$i}/$title";
14491: $fetch =~ s/^\Q$prefix$dir\E//;
14492: $prompttofetch{$fetch} = 1;
14493: }
1.1292 raeburn 14494: }
1.1067 raeburn 14495: }
1.1294 raeburn 14496: $LONCAPA::map::resources[$newidx]=
14497: $docstitle.':'.$url.':false:normal:res';
14498: push(@LONCAPA::map::order, $newidx);
14499: my ($outtext,$errtext)=
14500: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
14501: $docuname.'/'.$folders{$outer}.
14502: '.'.$containers{$outer},1,1);
14503: unless ($errtext) {
14504: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
14505: $result .= '<li>'.&mt('File: [_1] added to course',
14506: &HTML::Entities::encode($docstitle,'<>&"')).
14507: '</li>'."\n";
14508: }
1.1067 raeburn 14509: }
1.1294 raeburn 14510: } else {
14511: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
14512: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1296 raeburn 14513: }
1.1055 raeburn 14514: }
14515: }
1.1086 raeburn 14516: }
14517: } else {
1.1294 raeburn 14518: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
14519: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1086 raeburn 14520: }
14521: }
14522: for (my $i=1; $i<=$numitems; $i++) {
14523: next unless ($env{'form.archive_'.$i} eq 'dependency');
14524: my $path = $env{'form.archive_content_'.$i};
14525: if ($path =~ /^\Q$pathtocheck\E/) {
14526: my ($title) = ($path =~ m{/([^/]+)$});
14527: $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
14528: if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
14529: if (ref($dirorder{$i}) eq 'ARRAY') {
14530: my ($itemidx,$fullpath,$relpath);
14531: if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
14532: my $container = $dirorder{$referrer{$i}}->[-1];
1.1056 raeburn 14533: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1086 raeburn 14534: if ($dirorder{$i}->[$j] eq $container) {
14535: $itemidx = $j;
1.1056 raeburn 14536: }
14537: }
1.1086 raeburn 14538: }
14539: if ($itemidx eq '') {
14540: $itemidx = 0;
14541: }
14542: if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
14543: if ($mapinner{$referrer{$i}}) {
14544: $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
14545: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
14546: if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
14547: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
14548: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
14549: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
14550: if (!-e $fullpath) {
14551: mkdir($fullpath,0755);
1.1056 raeburn 14552: }
14553: }
1.1086 raeburn 14554: } else {
14555: last;
1.1056 raeburn 14556: }
1.1086 raeburn 14557: }
14558: }
14559: } elsif ($newdest{$referrer{$i}}) {
14560: $fullpath = $newdest{$referrer{$i}};
14561: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
14562: if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
14563: $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
14564: last;
14565: } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
14566: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
14567: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
14568: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
14569: if (!-e $fullpath) {
14570: mkdir($fullpath,0755);
1.1056 raeburn 14571: }
14572: }
1.1086 raeburn 14573: } else {
14574: last;
1.1056 raeburn 14575: }
1.1055 raeburn 14576: }
14577: }
1.1086 raeburn 14578: if ($fullpath ne '') {
14579: if (-e "$prefix$path") {
1.1292 raeburn 14580: unless (rename("$prefix$path","$fullpath/$title")) {
14581: $warning .= &mt('Failed to rename dependency').'<br />';
14582: }
1.1086 raeburn 14583: }
14584: if (-e "$fullpath/$title") {
14585: my $showpath;
14586: if ($relpath ne '') {
14587: $showpath = "$relpath/$title";
14588: } else {
14589: $showpath = "/$title";
14590: }
1.1294 raeburn 14591: $result .= '<li>'.&mt('[_1] included as a dependency',
14592: &HTML::Entities::encode($showpath,'<>&"')).
14593: '</li>'."\n";
1.1292 raeburn 14594: unless ($ishome) {
14595: my $fetch = "$fullpath/$title";
14596: $fetch =~ s/^\Q$prefix$dir\E//;
14597: $prompttofetch{$fetch} = 1;
14598: }
1.1086 raeburn 14599: }
14600: }
1.1055 raeburn 14601: }
1.1086 raeburn 14602: } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
14603: $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1294 raeburn 14604: &HTML::Entities::encode($path,'<>&"'),
14605: &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
14606: '<br />';
1.1055 raeburn 14607: }
14608: } else {
1.1294 raeburn 14609: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
1.1296 raeburn 14610: &HTML::Entities::encode($path)).'<br />';
1.1055 raeburn 14611: }
14612: }
14613: if (keys(%todelete)) {
14614: foreach my $key (keys(%todelete)) {
14615: unlink($key);
1.1066 raeburn 14616: }
14617: }
14618: if (keys(%todeletedir)) {
14619: foreach my $key (keys(%todeletedir)) {
14620: rmdir($key);
14621: }
14622: }
14623: foreach my $dir (sort(keys(%is_dir))) {
14624: if (($pathtocheck ne '') && ($dir ne '')) {
14625: &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055 raeburn 14626: }
14627: }
1.1067 raeburn 14628: if ($result ne '') {
14629: $output .= '<ul>'."\n".
14630: $result."\n".
14631: '</ul>';
14632: }
14633: unless ($ishome) {
14634: my $replicationfail;
14635: foreach my $item (keys(%prompttofetch)) {
14636: my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
14637: unless ($fetchresult eq 'ok') {
14638: $replicationfail .= '<li>'.$item.'</li>'."\n";
14639: }
14640: }
14641: if ($replicationfail) {
14642: $output .= '<p class="LC_error">'.
14643: &mt('Course home server failed to retrieve:').'<ul>'.
14644: $replicationfail.
14645: '</ul></p>';
14646: }
14647: }
1.1055 raeburn 14648: } else {
14649: $warning = &mt('No items found in archive.');
14650: }
14651: if ($error) {
14652: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14653: $error.'</p>'."\n";
14654: }
14655: if ($warning) {
14656: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
14657: }
14658: return $output;
14659: }
14660:
1.1066 raeburn 14661: sub cleanup_empty_dirs {
14662: my ($path) = @_;
14663: if (($path ne '') && (-d $path)) {
14664: if (opendir(my $dirh,$path)) {
14665: my @dircontents = grep(!/^\./,readdir($dirh));
14666: my $numitems = 0;
14667: foreach my $item (@dircontents) {
14668: if (-d "$path/$item") {
1.1111 raeburn 14669: &cleanup_empty_dirs("$path/$item");
1.1066 raeburn 14670: if (-e "$path/$item") {
14671: $numitems ++;
14672: }
14673: } else {
14674: $numitems ++;
14675: }
14676: }
14677: if ($numitems == 0) {
14678: rmdir($path);
14679: }
14680: closedir($dirh);
14681: }
14682: }
14683: return;
14684: }
14685:
1.41 ng 14686: =pod
1.45 matthew 14687:
1.1162 raeburn 14688: =item * &get_folder_hierarchy()
1.1068 raeburn 14689:
14690: Provides hierarchy of names of folders/sub-folders containing the current
14691: item,
14692:
14693: Inputs: 3
14694: - $navmap - navmaps object
14695:
14696: - $map - url for map (either the trigger itself, or map containing
14697: the resource, which is the trigger).
14698:
14699: - $showitem - 1 => show title for map itself; 0 => do not show.
14700:
14701: Outputs: 1 @pathitems - array of folder/subfolder names.
14702:
14703: =cut
14704:
14705: sub get_folder_hierarchy {
14706: my ($navmap,$map,$showitem) = @_;
14707: my @pathitems;
14708: if (ref($navmap)) {
14709: my $mapres = $navmap->getResourceByUrl($map);
14710: if (ref($mapres)) {
14711: my $pcslist = $mapres->map_hierarchy();
14712: if ($pcslist ne '') {
14713: my @pcs = split(/,/,$pcslist);
14714: foreach my $pc (@pcs) {
14715: if ($pc == 1) {
1.1129 raeburn 14716: push(@pathitems,&mt('Main Content'));
1.1068 raeburn 14717: } else {
14718: my $res = $navmap->getByMapPc($pc);
14719: if (ref($res)) {
14720: my $title = $res->compTitle();
14721: $title =~ s/\W+/_/g;
14722: if ($title ne '') {
14723: push(@pathitems,$title);
14724: }
14725: }
14726: }
14727: }
14728: }
1.1071 raeburn 14729: if ($showitem) {
14730: if ($mapres->{ID} eq '0.0') {
1.1129 raeburn 14731: push(@pathitems,&mt('Main Content'));
1.1071 raeburn 14732: } else {
14733: my $maptitle = $mapres->compTitle();
14734: $maptitle =~ s/\W+/_/g;
14735: if ($maptitle ne '') {
14736: push(@pathitems,$maptitle);
14737: }
1.1068 raeburn 14738: }
14739: }
14740: }
14741: }
14742: return @pathitems;
14743: }
14744:
14745: =pod
14746:
1.1015 raeburn 14747: =item * &get_turnedin_filepath()
14748:
14749: Determines path in a user's portfolio file for storage of files uploaded
14750: to a specific essayresponse or dropbox item.
14751:
14752: Inputs: 3 required + 1 optional.
14753: $symb is symb for resource, $uname and $udom are for current user (required).
14754: $caller is optional (can be "submission", if routine is called when storing
14755: an upoaded file when "Submit Answer" button was pressed).
14756:
14757: Returns array containing $path and $multiresp.
14758: $path is path in portfolio. $multiresp is 1 if this resource contains more
14759: than one file upload item. Callers of routine should append partid as a
14760: subdirectory to $path in cases where $multiresp is 1.
14761:
14762: Called by: homework/essayresponse.pm and homework/structuretags.pm
14763:
14764: =cut
14765:
14766: sub get_turnedin_filepath {
14767: my ($symb,$uname,$udom,$caller) = @_;
14768: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
14769: my $turnindir;
14770: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
14771: $turnindir = $userhash{'turnindir'};
14772: my ($path,$multiresp);
14773: if ($turnindir eq '') {
14774: if ($caller eq 'submission') {
14775: $turnindir = &mt('turned in');
14776: $turnindir =~ s/\W+/_/g;
14777: my %newhash = (
14778: 'turnindir' => $turnindir,
14779: );
14780: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
14781: }
14782: }
14783: if ($turnindir ne '') {
14784: $path = '/'.$turnindir.'/';
14785: my ($multipart,$turnin,@pathitems);
14786: my $navmap = Apache::lonnavmaps::navmap->new();
14787: if (defined($navmap)) {
14788: my $mapres = $navmap->getResourceByUrl($map);
14789: if (ref($mapres)) {
14790: my $pcslist = $mapres->map_hierarchy();
14791: if ($pcslist ne '') {
14792: foreach my $pc (split(/,/,$pcslist)) {
14793: my $res = $navmap->getByMapPc($pc);
14794: if (ref($res)) {
14795: my $title = $res->compTitle();
14796: $title =~ s/\W+/_/g;
14797: if ($title ne '') {
1.1149 raeburn 14798: if (($pc > 1) && (length($title) > 12)) {
14799: $title = substr($title,0,12);
14800: }
1.1015 raeburn 14801: push(@pathitems,$title);
14802: }
14803: }
14804: }
14805: }
14806: my $maptitle = $mapres->compTitle();
14807: $maptitle =~ s/\W+/_/g;
14808: if ($maptitle ne '') {
1.1149 raeburn 14809: if (length($maptitle) > 12) {
14810: $maptitle = substr($maptitle,0,12);
14811: }
1.1015 raeburn 14812: push(@pathitems,$maptitle);
14813: }
14814: unless ($env{'request.state'} eq 'construct') {
14815: my $res = $navmap->getBySymb($symb);
14816: if (ref($res)) {
14817: my $partlist = $res->parts();
14818: my $totaluploads = 0;
14819: if (ref($partlist) eq 'ARRAY') {
14820: foreach my $part (@{$partlist}) {
14821: my @types = $res->responseType($part);
14822: my @ids = $res->responseIds($part);
14823: for (my $i=0; $i < scalar(@ids); $i++) {
14824: if ($types[$i] eq 'essay') {
14825: my $partid = $part.'_'.$ids[$i];
14826: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
14827: $totaluploads ++;
14828: }
14829: }
14830: }
14831: }
14832: if ($totaluploads > 1) {
14833: $multiresp = 1;
14834: }
14835: }
14836: }
14837: }
14838: } else {
14839: return;
14840: }
14841: } else {
14842: return;
14843: }
14844: my $restitle=&Apache::lonnet::gettitle($symb);
14845: $restitle =~ s/\W+/_/g;
14846: if ($restitle eq '') {
14847: $restitle = ($resurl =~ m{/[^/]+$});
14848: if ($restitle eq '') {
14849: $restitle = time;
14850: }
14851: }
1.1149 raeburn 14852: if (length($restitle) > 12) {
14853: $restitle = substr($restitle,0,12);
14854: }
1.1015 raeburn 14855: push(@pathitems,$restitle);
14856: $path .= join('/',@pathitems);
14857: }
14858: return ($path,$multiresp);
14859: }
14860:
14861: =pod
14862:
1.464 albertel 14863: =back
1.41 ng 14864:
1.112 bowersj2 14865: =head1 CSV Upload/Handling functions
1.38 albertel 14866:
1.41 ng 14867: =over 4
14868:
1.648 raeburn 14869: =item * &upfile_store($r)
1.41 ng 14870:
14871: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 14872: needs $env{'form.upfile'}
1.41 ng 14873: returns $datatoken to be put into hidden field
14874:
14875: =cut
1.31 albertel 14876:
14877: sub upfile_store {
14878: my $r=shift;
1.258 albertel 14879: $env{'form.upfile'}=~s/\r/\n/gs;
14880: $env{'form.upfile'}=~s/\f/\n/gs;
14881: $env{'form.upfile'}=~s/\n+/\n/gs;
14882: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 14883:
1.1299 raeburn 14884: my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
14885: '_enroll_'.$env{'request.course.id'}.'_'.
14886: time.'_'.$$);
14887: return if ($datatoken eq '');
14888:
1.31 albertel 14889: {
1.158 raeburn 14890: my $datafile = $r->dir_config('lonDaemons').
14891: '/tmp/'.$datatoken.'.tmp';
1.1317 raeburn 14892: if ( open(my $fh,'>',$datafile) ) {
1.258 albertel 14893: print $fh $env{'form.upfile'};
1.158 raeburn 14894: close($fh);
14895: }
1.31 albertel 14896: }
14897: return $datatoken;
14898: }
14899:
1.56 matthew 14900: =pod
14901:
1.1290 raeburn 14902: =item * &load_tmp_file($r,$datatoken)
1.41 ng 14903:
14904: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1290 raeburn 14905: $datatoken is the name to assign to the temporary file.
1.258 albertel 14906: sets $env{'form.upfile'} to the contents of the file
1.41 ng 14907:
14908: =cut
1.31 albertel 14909:
14910: sub load_tmp_file {
1.1290 raeburn 14911: my ($r,$datatoken) = @_;
14912: return if ($datatoken eq '');
1.31 albertel 14913: my @studentdata=();
14914: {
1.158 raeburn 14915: my $studentfile = $r->dir_config('lonDaemons').
1.1290 raeburn 14916: '/tmp/'.$datatoken.'.tmp';
1.1317 raeburn 14917: if ( open(my $fh,'<',$studentfile) ) {
1.158 raeburn 14918: @studentdata=<$fh>;
14919: close($fh);
14920: }
1.31 albertel 14921: }
1.258 albertel 14922: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 14923: }
14924:
1.1290 raeburn 14925: sub valid_datatoken {
14926: my ($datatoken) = @_;
1.1325 raeburn 14927: if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1290 raeburn 14928: return $datatoken;
14929: }
14930: return;
14931: }
14932:
1.56 matthew 14933: =pod
14934:
1.648 raeburn 14935: =item * &upfile_record_sep()
1.41 ng 14936:
14937: Separate uploaded file into records
14938: returns array of records,
1.258 albertel 14939: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 14940:
14941: =cut
1.31 albertel 14942:
14943: sub upfile_record_sep {
1.258 albertel 14944: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 14945: } else {
1.248 albertel 14946: my @records;
1.258 albertel 14947: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 14948: if ($line=~/^\s*$/) { next; }
14949: push(@records,$line);
14950: }
14951: return @records;
1.31 albertel 14952: }
14953: }
14954:
1.56 matthew 14955: =pod
14956:
1.648 raeburn 14957: =item * &record_sep($record)
1.41 ng 14958:
1.258 albertel 14959: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 14960:
14961: =cut
14962:
1.263 www 14963: sub takeleft {
14964: my $index=shift;
14965: return substr('0000'.$index,-4,4);
14966: }
14967:
1.31 albertel 14968: sub record_sep {
14969: my $record=shift;
14970: my %components=();
1.258 albertel 14971: if ($env{'form.upfiletype'} eq 'xml') {
14972: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 14973: my $i=0;
1.356 albertel 14974: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 14975: $field=~s/^(\"|\')//;
14976: $field=~s/(\"|\')$//;
1.263 www 14977: $components{&takeleft($i)}=$field;
1.31 albertel 14978: $i++;
14979: }
1.258 albertel 14980: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 14981: my $i=0;
1.356 albertel 14982: foreach my $field (split(/\t/,$record)) {
1.31 albertel 14983: $field=~s/^(\"|\')//;
14984: $field=~s/(\"|\')$//;
1.263 www 14985: $components{&takeleft($i)}=$field;
1.31 albertel 14986: $i++;
14987: }
14988: } else {
1.561 www 14989: my $separator=',';
1.480 banghart 14990: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 14991: $separator=';';
1.480 banghart 14992: }
1.31 albertel 14993: my $i=0;
1.561 www 14994: # the character we are looking for to indicate the end of a quote or a record
14995: my $looking_for=$separator;
14996: # do not add the characters to the fields
14997: my $ignore=0;
14998: # we just encountered a separator (or the beginning of the record)
14999: my $just_found_separator=1;
15000: # store the field we are working on here
15001: my $field='';
15002: # work our way through all characters in record
15003: foreach my $character ($record=~/(.)/g) {
15004: if ($character eq $looking_for) {
15005: if ($character ne $separator) {
15006: # Found the end of a quote, again looking for separator
15007: $looking_for=$separator;
15008: $ignore=1;
15009: } else {
15010: # Found a separator, store away what we got
15011: $components{&takeleft($i)}=$field;
15012: $i++;
15013: $just_found_separator=1;
15014: $ignore=0;
15015: $field='';
15016: }
15017: next;
15018: }
15019: # single or double quotation marks after a separator indicate beginning of a quote
15020: # we are now looking for the end of the quote and need to ignore separators
15021: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
15022: $looking_for=$character;
15023: next;
15024: }
15025: # ignore would be true after we reached the end of a quote
15026: if ($ignore) { next; }
15027: if (($just_found_separator) && ($character=~/\s/)) { next; }
15028: $field.=$character;
15029: $just_found_separator=0;
1.31 albertel 15030: }
1.561 www 15031: # catch the very last entry, since we never encountered the separator
15032: $components{&takeleft($i)}=$field;
1.31 albertel 15033: }
15034: return %components;
15035: }
15036:
1.144 matthew 15037: ######################################################
15038: ######################################################
15039:
1.56 matthew 15040: =pod
15041:
1.648 raeburn 15042: =item * &upfile_select_html()
1.41 ng 15043:
1.144 matthew 15044: Return HTML code to select a file from the users machine and specify
15045: the file type.
1.41 ng 15046:
15047: =cut
15048:
1.144 matthew 15049: ######################################################
15050: ######################################################
1.31 albertel 15051: sub upfile_select_html {
1.144 matthew 15052: my %Types = (
15053: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 15054: semisv => &mt('Semicolon separated values'),
1.144 matthew 15055: space => &mt('Space separated'),
15056: tab => &mt('Tabulator separated'),
15057: # xml => &mt('HTML/XML'),
15058: );
15059: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 15060: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 15061: foreach my $type (sort(keys(%Types))) {
15062: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
15063: }
15064: $Str .= "</select>\n";
15065: return $Str;
1.31 albertel 15066: }
15067:
1.301 albertel 15068: sub get_samples {
15069: my ($records,$toget) = @_;
15070: my @samples=({});
15071: my $got=0;
15072: foreach my $rec (@$records) {
15073: my %temp = &record_sep($rec);
15074: if (! grep(/\S/, values(%temp))) { next; }
15075: if (%temp) {
15076: $samples[$got]=\%temp;
15077: $got++;
15078: if ($got == $toget) { last; }
15079: }
15080: }
15081: return \@samples;
15082: }
15083:
1.144 matthew 15084: ######################################################
15085: ######################################################
15086:
1.56 matthew 15087: =pod
15088:
1.648 raeburn 15089: =item * &csv_print_samples($r,$records)
1.41 ng 15090:
15091: Prints a table of sample values from each column uploaded $r is an
15092: Apache Request ref, $records is an arrayref from
15093: &Apache::loncommon::upfile_record_sep
15094:
15095: =cut
15096:
1.144 matthew 15097: ######################################################
15098: ######################################################
1.31 albertel 15099: sub csv_print_samples {
15100: my ($r,$records) = @_;
1.662 bisitz 15101: my $samples = &get_samples($records,5);
1.301 albertel 15102:
1.594 raeburn 15103: $r->print(&mt('Samples').'<br />'.&start_data_table().
15104: &start_data_table_header_row());
1.356 albertel 15105: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 15106: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 15107: $r->print(&end_data_table_header_row());
1.301 albertel 15108: foreach my $hash (@$samples) {
1.594 raeburn 15109: $r->print(&start_data_table_row());
1.356 albertel 15110: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 15111: $r->print('<td>');
1.356 albertel 15112: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 15113: $r->print('</td>');
15114: }
1.594 raeburn 15115: $r->print(&end_data_table_row());
1.31 albertel 15116: }
1.594 raeburn 15117: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 15118: }
15119:
1.144 matthew 15120: ######################################################
15121: ######################################################
15122:
1.56 matthew 15123: =pod
15124:
1.648 raeburn 15125: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 15126:
15127: Prints a table to create associations between values and table columns.
1.144 matthew 15128:
1.41 ng 15129: $r is an Apache Request ref,
15130: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 15131: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 15132:
15133: =cut
15134:
1.144 matthew 15135: ######################################################
15136: ######################################################
1.31 albertel 15137: sub csv_print_select_table {
15138: my ($r,$records,$d) = @_;
1.301 albertel 15139: my $i=0;
15140: my $samples = &get_samples($records,1);
1.144 matthew 15141: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 15142: &start_data_table().&start_data_table_header_row().
1.144 matthew 15143: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 15144: '<th>'.&mt('Column').'</th>'.
15145: &end_data_table_header_row()."\n");
1.356 albertel 15146: foreach my $array_ref (@$d) {
15147: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 15148: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 15149:
1.875 bisitz 15150: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 15151: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 15152: $r->print('<option value="none"></option>');
1.356 albertel 15153: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
15154: $r->print('<option value="'.$sample.'"'.
15155: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 15156: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 15157: }
1.594 raeburn 15158: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 15159: $i++;
15160: }
1.594 raeburn 15161: $r->print(&end_data_table());
1.31 albertel 15162: $i--;
15163: return $i;
15164: }
1.56 matthew 15165:
1.144 matthew 15166: ######################################################
15167: ######################################################
15168:
1.56 matthew 15169: =pod
1.31 albertel 15170:
1.648 raeburn 15171: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 15172:
15173: Prints a table of sample values from the upload and can make associate samples to internal names.
15174:
15175: $r is an Apache Request ref,
15176: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
15177: $d is an array of 2 element arrays (internal name, displayed name)
15178:
15179: =cut
15180:
1.144 matthew 15181: ######################################################
15182: ######################################################
1.31 albertel 15183: sub csv_samples_select_table {
15184: my ($r,$records,$d) = @_;
15185: my $i=0;
1.144 matthew 15186: #
1.662 bisitz 15187: my $max_samples = 5;
15188: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 15189: $r->print(&start_data_table().
15190: &start_data_table_header_row().'<th>'.
15191: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
15192: &end_data_table_header_row());
1.301 albertel 15193:
15194: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 15195: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 15196: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 15197: foreach my $option (@$d) {
15198: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 15199: $r->print('<option value="'.$value.'"'.
1.253 albertel 15200: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 15201: $display.'</option>');
1.31 albertel 15202: }
15203: $r->print('</select></td><td>');
1.662 bisitz 15204: foreach my $line (0..($max_samples-1)) {
1.301 albertel 15205: if (defined($samples->[$line]{$key})) {
15206: $r->print($samples->[$line]{$key}."<br />\n");
15207: }
15208: }
1.594 raeburn 15209: $r->print('</td>'.&end_data_table_row());
1.31 albertel 15210: $i++;
15211: }
1.594 raeburn 15212: $r->print(&end_data_table());
1.31 albertel 15213: $i--;
15214: return($i);
1.115 matthew 15215: }
15216:
1.144 matthew 15217: ######################################################
15218: ######################################################
15219:
1.115 matthew 15220: =pod
15221:
1.648 raeburn 15222: =item * &clean_excel_name($name)
1.115 matthew 15223:
15224: Returns a replacement for $name which does not contain any illegal characters.
15225:
15226: =cut
15227:
1.144 matthew 15228: ######################################################
15229: ######################################################
1.115 matthew 15230: sub clean_excel_name {
15231: my ($name) = @_;
15232: $name =~ s/[:\*\?\/\\]//g;
15233: if (length($name) > 31) {
15234: $name = substr($name,0,31);
15235: }
15236: return $name;
1.25 albertel 15237: }
1.84 albertel 15238:
1.85 albertel 15239: =pod
15240:
1.648 raeburn 15241: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 15242:
15243: Returns either 1 or undef
15244:
15245: 1 if the part is to be hidden, undef if it is to be shown
15246:
15247: Arguments are:
15248:
15249: $id the id of the part to be checked
15250: $symb, optional the symb of the resource to check
15251: $udom, optional the domain of the user to check for
15252: $uname, optional the username of the user to check for
15253:
15254: =cut
1.84 albertel 15255:
15256: sub check_if_partid_hidden {
15257: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 15258: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 15259: $symb,$udom,$uname);
1.141 albertel 15260: my $truth=1;
15261: #if the string starts with !, then the list is the list to show not hide
15262: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 15263: my @hiddenlist=split(/,/,$hiddenparts);
15264: foreach my $checkid (@hiddenlist) {
1.141 albertel 15265: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 15266: }
1.141 albertel 15267: return !$truth;
1.84 albertel 15268: }
1.127 matthew 15269:
1.138 matthew 15270:
15271: ############################################################
15272: ############################################################
15273:
15274: =pod
15275:
1.157 matthew 15276: =back
15277:
1.138 matthew 15278: =head1 cgi-bin script and graphing routines
15279:
1.157 matthew 15280: =over 4
15281:
1.648 raeburn 15282: =item * &get_cgi_id()
1.138 matthew 15283:
15284: Inputs: none
15285:
15286: Returns an id which can be used to pass environment variables
15287: to various cgi-bin scripts. These environment variables will
15288: be removed from the users environment after a given time by
15289: the routine &Apache::lonnet::transfer_profile_to_env.
15290:
15291: =cut
15292:
15293: ############################################################
15294: ############################################################
1.152 albertel 15295: my $uniq=0;
1.136 matthew 15296: sub get_cgi_id {
1.154 albertel 15297: $uniq=($uniq+1)%100000;
1.280 albertel 15298: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 15299: }
15300:
1.127 matthew 15301: ############################################################
15302: ############################################################
15303:
15304: =pod
15305:
1.648 raeburn 15306: =item * &DrawBarGraph()
1.127 matthew 15307:
1.138 matthew 15308: Facilitates the plotting of data in a (stacked) bar graph.
15309: Puts plot definition data into the users environment in order for
15310: graph.png to plot it. Returns an <img> tag for the plot.
15311: The bars on the plot are labeled '1','2',...,'n'.
15312:
15313: Inputs:
15314:
15315: =over 4
15316:
15317: =item $Title: string, the title of the plot
15318:
15319: =item $xlabel: string, text describing the X-axis of the plot
15320:
15321: =item $ylabel: string, text describing the Y-axis of the plot
15322:
15323: =item $Max: scalar, the maximum Y value to use in the plot
15324: If $Max is < any data point, the graph will not be rendered.
15325:
1.140 matthew 15326: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 15327: they are plotted. If undefined, default values will be used.
15328:
1.178 matthew 15329: =item $labels: array ref holding the labels to use on the x-axis for the bars.
15330:
1.138 matthew 15331: =item @Values: An array of array references. Each array reference holds data
15332: to be plotted in a stacked bar chart.
15333:
1.239 matthew 15334: =item If the final element of @Values is a hash reference the key/value
15335: pairs will be added to the graph definition.
15336:
1.138 matthew 15337: =back
15338:
15339: Returns:
15340:
15341: An <img> tag which references graph.png and the appropriate identifying
15342: information for the plot.
15343:
1.127 matthew 15344: =cut
15345:
15346: ############################################################
15347: ############################################################
1.134 matthew 15348: sub DrawBarGraph {
1.178 matthew 15349: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 15350: #
15351: if (! defined($colors)) {
15352: $colors = ['#33ff00',
15353: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
15354: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
15355: ];
15356: }
1.228 matthew 15357: my $extra_settings = {};
15358: if (ref($Values[-1]) eq 'HASH') {
15359: $extra_settings = pop(@Values);
15360: }
1.127 matthew 15361: #
1.136 matthew 15362: my $identifier = &get_cgi_id();
15363: my $id = 'cgi.'.$identifier;
1.129 matthew 15364: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 15365: return '';
15366: }
1.225 matthew 15367: #
15368: my @Labels;
15369: if (defined($labels)) {
15370: @Labels = @$labels;
15371: } else {
15372: for (my $i=0;$i<@{$Values[0]};$i++) {
1.1263 raeburn 15373: push(@Labels,$i+1);
1.225 matthew 15374: }
15375: }
15376: #
1.129 matthew 15377: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 15378: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 15379: my %ValuesHash;
15380: my $NumSets=1;
15381: foreach my $array (@Values) {
15382: next if (! ref($array));
1.136 matthew 15383: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 15384: join(',',@$array);
1.129 matthew 15385: }
1.127 matthew 15386: #
1.136 matthew 15387: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 15388: if ($NumBars < 3) {
15389: $width = 120+$NumBars*32;
1.220 matthew 15390: $xskip = 1;
1.225 matthew 15391: $bar_width = 30;
15392: } elsif ($NumBars < 5) {
15393: $width = 120+$NumBars*20;
15394: $xskip = 1;
15395: $bar_width = 20;
1.220 matthew 15396: } elsif ($NumBars < 10) {
1.136 matthew 15397: $width = 120+$NumBars*15;
15398: $xskip = 1;
15399: $bar_width = 15;
15400: } elsif ($NumBars <= 25) {
15401: $width = 120+$NumBars*11;
15402: $xskip = 5;
15403: $bar_width = 8;
15404: } elsif ($NumBars <= 50) {
15405: $width = 120+$NumBars*8;
15406: $xskip = 5;
15407: $bar_width = 4;
15408: } else {
15409: $width = 120+$NumBars*8;
15410: $xskip = 5;
15411: $bar_width = 4;
15412: }
15413: #
1.137 matthew 15414: $Max = 1 if ($Max < 1);
15415: if ( int($Max) < $Max ) {
15416: $Max++;
15417: $Max = int($Max);
15418: }
1.127 matthew 15419: $Title = '' if (! defined($Title));
15420: $xlabel = '' if (! defined($xlabel));
15421: $ylabel = '' if (! defined($ylabel));
1.369 www 15422: $ValuesHash{$id.'.title'} = &escape($Title);
15423: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
15424: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 15425: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 15426: $ValuesHash{$id.'.NumBars'} = $NumBars;
15427: $ValuesHash{$id.'.NumSets'} = $NumSets;
15428: $ValuesHash{$id.'.PlotType'} = 'bar';
15429: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
15430: $ValuesHash{$id.'.height'} = $height;
15431: $ValuesHash{$id.'.width'} = $width;
15432: $ValuesHash{$id.'.xskip'} = $xskip;
15433: $ValuesHash{$id.'.bar_width'} = $bar_width;
15434: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 15435: #
1.228 matthew 15436: # Deal with other parameters
15437: while (my ($key,$value) = each(%$extra_settings)) {
15438: $ValuesHash{$id.'.'.$key} = $value;
15439: }
15440: #
1.646 raeburn 15441: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 15442: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
15443: }
15444:
15445: ############################################################
15446: ############################################################
15447:
15448: =pod
15449:
1.648 raeburn 15450: =item * &DrawXYGraph()
1.137 matthew 15451:
1.138 matthew 15452: Facilitates the plotting of data in an XY graph.
15453: Puts plot definition data into the users environment in order for
15454: graph.png to plot it. Returns an <img> tag for the plot.
15455:
15456: Inputs:
15457:
15458: =over 4
15459:
15460: =item $Title: string, the title of the plot
15461:
15462: =item $xlabel: string, text describing the X-axis of the plot
15463:
15464: =item $ylabel: string, text describing the Y-axis of the plot
15465:
15466: =item $Max: scalar, the maximum Y value to use in the plot
15467: If $Max is < any data point, the graph will not be rendered.
15468:
15469: =item $colors: Array ref containing the hex color codes for the data to be
15470: plotted in. If undefined, default values will be used.
15471:
15472: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
15473:
15474: =item $Ydata: Array ref containing Array refs.
1.185 www 15475: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 15476:
15477: =item %Values: hash indicating or overriding any default values which are
15478: passed to graph.png.
15479: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
15480:
15481: =back
15482:
15483: Returns:
15484:
15485: An <img> tag which references graph.png and the appropriate identifying
15486: information for the plot.
15487:
1.137 matthew 15488: =cut
15489:
15490: ############################################################
15491: ############################################################
15492: sub DrawXYGraph {
15493: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
15494: #
15495: # Create the identifier for the graph
15496: my $identifier = &get_cgi_id();
15497: my $id = 'cgi.'.$identifier;
15498: #
15499: $Title = '' if (! defined($Title));
15500: $xlabel = '' if (! defined($xlabel));
15501: $ylabel = '' if (! defined($ylabel));
15502: my %ValuesHash =
15503: (
1.369 www 15504: $id.'.title' => &escape($Title),
15505: $id.'.xlabel' => &escape($xlabel),
15506: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 15507: $id.'.y_max_value'=> $Max,
15508: $id.'.labels' => join(',',@$Xlabels),
15509: $id.'.PlotType' => 'XY',
15510: );
15511: #
15512: if (defined($colors) && ref($colors) eq 'ARRAY') {
15513: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
15514: }
15515: #
15516: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
15517: return '';
15518: }
15519: my $NumSets=1;
1.138 matthew 15520: foreach my $array (@{$Ydata}){
1.137 matthew 15521: next if (! ref($array));
15522: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
15523: }
1.138 matthew 15524: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 15525: #
15526: # Deal with other parameters
15527: while (my ($key,$value) = each(%Values)) {
15528: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 15529: }
15530: #
1.646 raeburn 15531: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 15532: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
15533: }
15534:
15535: ############################################################
15536: ############################################################
15537:
15538: =pod
15539:
1.648 raeburn 15540: =item * &DrawXYYGraph()
1.138 matthew 15541:
15542: Facilitates the plotting of data in an XY graph with two Y axes.
15543: Puts plot definition data into the users environment in order for
15544: graph.png to plot it. Returns an <img> tag for the plot.
15545:
15546: Inputs:
15547:
15548: =over 4
15549:
15550: =item $Title: string, the title of the plot
15551:
15552: =item $xlabel: string, text describing the X-axis of the plot
15553:
15554: =item $ylabel: string, text describing the Y-axis of the plot
15555:
15556: =item $colors: Array ref containing the hex color codes for the data to be
15557: plotted in. If undefined, default values will be used.
15558:
15559: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
15560:
15561: =item $Ydata1: The first data set
15562:
15563: =item $Min1: The minimum value of the left Y-axis
15564:
15565: =item $Max1: The maximum value of the left Y-axis
15566:
15567: =item $Ydata2: The second data set
15568:
15569: =item $Min2: The minimum value of the right Y-axis
15570:
15571: =item $Max2: The maximum value of the left Y-axis
15572:
15573: =item %Values: hash indicating or overriding any default values which are
15574: passed to graph.png.
15575: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
15576:
15577: =back
15578:
15579: Returns:
15580:
15581: An <img> tag which references graph.png and the appropriate identifying
15582: information for the plot.
1.136 matthew 15583:
15584: =cut
15585:
15586: ############################################################
15587: ############################################################
1.137 matthew 15588: sub DrawXYYGraph {
15589: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
15590: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 15591: #
15592: # Create the identifier for the graph
15593: my $identifier = &get_cgi_id();
15594: my $id = 'cgi.'.$identifier;
15595: #
15596: $Title = '' if (! defined($Title));
15597: $xlabel = '' if (! defined($xlabel));
15598: $ylabel = '' if (! defined($ylabel));
15599: my %ValuesHash =
15600: (
1.369 www 15601: $id.'.title' => &escape($Title),
15602: $id.'.xlabel' => &escape($xlabel),
15603: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 15604: $id.'.labels' => join(',',@$Xlabels),
15605: $id.'.PlotType' => 'XY',
15606: $id.'.NumSets' => 2,
1.137 matthew 15607: $id.'.two_axes' => 1,
15608: $id.'.y1_max_value' => $Max1,
15609: $id.'.y1_min_value' => $Min1,
15610: $id.'.y2_max_value' => $Max2,
15611: $id.'.y2_min_value' => $Min2,
1.136 matthew 15612: );
15613: #
1.137 matthew 15614: if (defined($colors) && ref($colors) eq 'ARRAY') {
15615: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
15616: }
15617: #
15618: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
15619: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 15620: return '';
15621: }
15622: my $NumSets=1;
1.137 matthew 15623: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 15624: next if (! ref($array));
15625: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 15626: }
15627: #
15628: # Deal with other parameters
15629: while (my ($key,$value) = each(%Values)) {
15630: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 15631: }
15632: #
1.646 raeburn 15633: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 15634: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 15635: }
15636:
15637: ############################################################
15638: ############################################################
15639:
15640: =pod
15641:
1.157 matthew 15642: =back
15643:
1.139 matthew 15644: =head1 Statistics helper routines?
15645:
15646: Bad place for them but what the hell.
15647:
1.157 matthew 15648: =over 4
15649:
1.648 raeburn 15650: =item * &chartlink()
1.139 matthew 15651:
15652: Returns a link to the chart for a specific student.
15653:
15654: Inputs:
15655:
15656: =over 4
15657:
15658: =item $linktext: The text of the link
15659:
15660: =item $sname: The students username
15661:
15662: =item $sdomain: The students domain
15663:
15664: =back
15665:
1.157 matthew 15666: =back
15667:
1.139 matthew 15668: =cut
15669:
15670: ############################################################
15671: ############################################################
15672: sub chartlink {
15673: my ($linktext, $sname, $sdomain) = @_;
15674: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 15675: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 15676: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 15677: '">'.$linktext.'</a>';
1.153 matthew 15678: }
15679:
15680: #######################################################
15681: #######################################################
15682:
15683: =pod
15684:
15685: =head1 Course Environment Routines
1.157 matthew 15686:
15687: =over 4
1.153 matthew 15688:
1.648 raeburn 15689: =item * &restore_course_settings()
1.153 matthew 15690:
1.648 raeburn 15691: =item * &store_course_settings()
1.153 matthew 15692:
15693: Restores/Store indicated form parameters from the course environment.
15694: Will not overwrite existing values of the form parameters.
15695:
15696: Inputs:
15697: a scalar describing the data (e.g. 'chart', 'problem_analysis')
15698:
15699: a hash ref describing the data to be stored. For example:
15700:
15701: %Save_Parameters = ('Status' => 'scalar',
15702: 'chartoutputmode' => 'scalar',
15703: 'chartoutputdata' => 'scalar',
15704: 'Section' => 'array',
1.373 raeburn 15705: 'Group' => 'array',
1.153 matthew 15706: 'StudentData' => 'array',
15707: 'Maps' => 'array');
15708:
15709: Returns: both routines return nothing
15710:
1.631 raeburn 15711: =back
15712:
1.153 matthew 15713: =cut
15714:
15715: #######################################################
15716: #######################################################
15717: sub store_course_settings {
1.496 albertel 15718: return &store_settings($env{'request.course.id'},@_);
15719: }
15720:
15721: sub store_settings {
1.153 matthew 15722: # save to the environment
15723: # appenv the same items, just to be safe
1.300 albertel 15724: my $udom = $env{'user.domain'};
15725: my $uname = $env{'user.name'};
1.496 albertel 15726: my ($context,$prefix,$Settings) = @_;
1.153 matthew 15727: my %SaveHash;
15728: my %AppHash;
15729: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 15730: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 15731: my $envname = 'environment.'.$basename;
1.258 albertel 15732: if (exists($env{'form.'.$setting})) {
1.153 matthew 15733: # Save this value away
15734: if ($type eq 'scalar' &&
1.258 albertel 15735: (! exists($env{$envname}) ||
15736: $env{$envname} ne $env{'form.'.$setting})) {
15737: $SaveHash{$basename} = $env{'form.'.$setting};
15738: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 15739: } elsif ($type eq 'array') {
15740: my $stored_form;
1.258 albertel 15741: if (ref($env{'form.'.$setting})) {
1.153 matthew 15742: $stored_form = join(',',
15743: map {
1.369 www 15744: &escape($_);
1.258 albertel 15745: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 15746: } else {
15747: $stored_form =
1.369 www 15748: &escape($env{'form.'.$setting});
1.153 matthew 15749: }
15750: # Determine if the array contents are the same.
1.258 albertel 15751: if ($stored_form ne $env{$envname}) {
1.153 matthew 15752: $SaveHash{$basename} = $stored_form;
15753: $AppHash{$envname} = $stored_form;
15754: }
15755: }
15756: }
15757: }
15758: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 15759: $udom,$uname);
1.153 matthew 15760: if ($put_result !~ /^(ok|delayed)/) {
15761: &Apache::lonnet::logthis('unable to save form parameters, '.
15762: 'got error:'.$put_result);
15763: }
15764: # Make sure these settings stick around in this session, too
1.646 raeburn 15765: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 15766: return;
15767: }
15768:
15769: sub restore_course_settings {
1.499 albertel 15770: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 15771: }
15772:
15773: sub restore_settings {
15774: my ($context,$prefix,$Settings) = @_;
1.153 matthew 15775: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 15776: next if (exists($env{'form.'.$setting}));
1.496 albertel 15777: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 15778: '.'.$setting;
1.258 albertel 15779: if (exists($env{$envname})) {
1.153 matthew 15780: if ($type eq 'scalar') {
1.258 albertel 15781: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 15782: } elsif ($type eq 'array') {
1.258 albertel 15783: $env{'form.'.$setting} = [
1.153 matthew 15784: map {
1.369 www 15785: &unescape($_);
1.258 albertel 15786: } split(',',$env{$envname})
1.153 matthew 15787: ];
15788: }
15789: }
15790: }
1.127 matthew 15791: }
15792:
1.618 raeburn 15793: #######################################################
15794: #######################################################
15795:
15796: =pod
15797:
15798: =head1 Domain E-mail Routines
15799:
15800: =over 4
15801:
1.648 raeburn 15802: =item * &build_recipient_list()
1.618 raeburn 15803:
1.1144 raeburn 15804: Build recipient lists for following types of e-mail:
1.766 raeburn 15805: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1144 raeburn 15806: (d) Help requests, (e) Course requests needing approval, (f) loncapa
15807: module change checking, student/employee ID conflict checks, as
15808: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
15809: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618 raeburn 15810:
15811: Inputs:
1.619 raeburn 15812: defmail (scalar - email address of default recipient),
1.1144 raeburn 15813: mailing type (scalar: errormail, packagesmail, helpdeskmail,
15814: requestsmail, updatesmail, or idconflictsmail).
15815:
1.619 raeburn 15816: defdom (domain for which to retrieve configuration settings),
1.1144 raeburn 15817:
1.619 raeburn 15818: origmail (scalar - email address of recipient from loncapa.conf,
1.1297 raeburn 15819: i.e., predates configuration by DC via domainprefs.pm
15820:
15821: $requname username of requester (if mailing type is helpdeskmail)
15822:
15823: $requdom domain of requester (if mailing type is helpdeskmail)
15824:
15825: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
15826:
1.618 raeburn 15827:
1.655 raeburn 15828: Returns: comma separated list of addresses to which to send e-mail.
15829:
15830: =back
1.618 raeburn 15831:
15832: =cut
15833:
15834: ############################################################
15835: ############################################################
15836: sub build_recipient_list {
1.1297 raeburn 15837: my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618 raeburn 15838: my @recipients;
1.1270 raeburn 15839: my ($otheremails,$lastresort,$allbcc,$addtext);
1.618 raeburn 15840: my %domconfig =
1.1270 raeburn 15841: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618 raeburn 15842: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 15843: if (exists($domconfig{'contacts'}{$mailing})) {
15844: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
15845: my @contacts = ('adminemail','supportemail');
15846: foreach my $item (@contacts) {
15847: if ($domconfig{'contacts'}{$mailing}{$item}) {
15848: my $addr = $domconfig{'contacts'}{$item};
15849: if (!grep(/^\Q$addr\E$/,@recipients)) {
15850: push(@recipients,$addr);
15851: }
1.619 raeburn 15852: }
1.1270 raeburn 15853: }
15854: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
15855: if ($mailing eq 'helpdeskmail') {
15856: if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
15857: my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
15858: my @ok_bccs;
15859: foreach my $bcc (@bccs) {
15860: $bcc =~ s/^\s+//g;
15861: $bcc =~ s/\s+$//g;
15862: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
15863: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
15864: push(@ok_bccs,$bcc);
15865: }
15866: }
15867: }
15868: if (@ok_bccs > 0) {
15869: $allbcc = join(', ',@ok_bccs);
15870: }
15871: }
15872: $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618 raeburn 15873: }
15874: }
1.766 raeburn 15875: } elsif ($origmail ne '') {
1.1270 raeburn 15876: $lastresort = $origmail;
1.618 raeburn 15877: }
1.1297 raeburn 15878: if ($mailing eq 'helpdeskmail') {
15879: if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
15880: (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
15881: my ($inststatus,$inststatus_checked);
15882: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
15883: ($env{'user.domain'} ne 'public')) {
15884: $inststatus_checked = 1;
15885: $inststatus = $env{'environment.inststatus'};
15886: }
15887: unless ($inststatus_checked) {
15888: if (($requname ne '') && ($requdom ne '')) {
15889: if (($requname =~ /^$match_username$/) &&
15890: ($requdom =~ /^$match_domain$/) &&
15891: (&Apache::lonnet::domain($requdom))) {
15892: my $requhome = &Apache::lonnet::homeserver($requname,
15893: $requdom);
15894: unless ($requhome eq 'no_host') {
15895: my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
15896: $inststatus = $userenv{'inststatus'};
15897: $inststatus_checked = 1;
15898: }
15899: }
15900: }
15901: }
15902: unless ($inststatus_checked) {
15903: if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
15904: my %srch = (srchby => 'email',
15905: srchdomain => $defdom,
15906: srchterm => $reqemail,
15907: srchtype => 'exact');
15908: my %srch_results = &Apache::lonnet::usersearch(\%srch);
15909: foreach my $uname (keys(%srch_results)) {
15910: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
15911: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
15912: $inststatus_checked = 1;
15913: last;
15914: }
15915: }
15916: unless ($inststatus_checked) {
15917: my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
15918: if ($dirsrchres eq 'ok') {
15919: foreach my $uname (keys(%srch_results)) {
15920: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
15921: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
15922: $inststatus_checked = 1;
15923: last;
15924: }
15925: }
15926: }
15927: }
15928: }
15929: }
15930: if ($inststatus ne '') {
15931: foreach my $status (split(/\:/,$inststatus)) {
15932: if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
15933: my @contacts = ('adminemail','supportemail');
15934: foreach my $item (@contacts) {
15935: if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
15936: my $addr = $domconfig{'contacts'}{'overrides'}{$status};
15937: if (!grep(/^\Q$addr\E$/,@recipients)) {
15938: push(@recipients,$addr);
15939: }
15940: }
15941: }
15942: $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
15943: if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
15944: my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
15945: my @ok_bccs;
15946: foreach my $bcc (@bccs) {
15947: $bcc =~ s/^\s+//g;
15948: $bcc =~ s/\s+$//g;
15949: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
15950: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
15951: push(@ok_bccs,$bcc);
15952: }
15953: }
15954: }
15955: if (@ok_bccs > 0) {
15956: $allbcc = join(', ',@ok_bccs);
15957: }
15958: }
15959: $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
15960: last;
15961: }
15962: }
15963: }
15964: }
15965: }
1.619 raeburn 15966: } elsif ($origmail ne '') {
1.1270 raeburn 15967: $lastresort = $origmail;
15968: }
1.1297 raeburn 15969: if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1270 raeburn 15970: unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
15971: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
15972: my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
15973: my %what = (
15974: perlvar => 1,
15975: );
15976: my $primary = &Apache::lonnet::domain($defdom,'primary');
15977: if ($primary) {
15978: my $gotaddr;
15979: my ($result,$returnhash) =
15980: &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
15981: if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
15982: if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
15983: $lastresort = $returnhash->{'lonSupportEMail'};
15984: $gotaddr = 1;
15985: }
15986: }
15987: unless ($gotaddr) {
15988: my $uintdom = &Apache::lonnet::internet_dom($primary);
15989: my $intdom = &Apache::lonnet::internet_dom($lonhost);
15990: unless ($uintdom eq $intdom) {
15991: my %domconfig =
15992: &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
15993: if (ref($domconfig{'contacts'}) eq 'HASH') {
15994: if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
15995: my @contacts = ('adminemail','supportemail');
15996: foreach my $item (@contacts) {
15997: if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
15998: my $addr = $domconfig{'contacts'}{$item};
15999: if (!grep(/^\Q$addr\E$/,@recipients)) {
16000: push(@recipients,$addr);
16001: }
16002: }
16003: }
16004: if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
16005: $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
16006: }
16007: if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
16008: my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
16009: my @ok_bccs;
16010: foreach my $bcc (@bccs) {
16011: $bcc =~ s/^\s+//g;
16012: $bcc =~ s/\s+$//g;
16013: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16014: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16015: push(@ok_bccs,$bcc);
16016: }
16017: }
16018: }
16019: if (@ok_bccs > 0) {
16020: $allbcc = join(', ',@ok_bccs);
16021: }
16022: }
16023: $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
16024: }
16025: }
16026: }
16027: }
16028: }
16029: }
1.618 raeburn 16030: }
1.688 raeburn 16031: if (defined($defmail)) {
16032: if ($defmail ne '') {
16033: push(@recipients,$defmail);
16034: }
1.618 raeburn 16035: }
16036: if ($otheremails) {
1.619 raeburn 16037: my @others;
16038: if ($otheremails =~ /,/) {
16039: @others = split(/,/,$otheremails);
1.618 raeburn 16040: } else {
1.619 raeburn 16041: push(@others,$otheremails);
16042: }
16043: foreach my $addr (@others) {
16044: if (!grep(/^\Q$addr\E$/,@recipients)) {
16045: push(@recipients,$addr);
16046: }
1.618 raeburn 16047: }
16048: }
1.1298 raeburn 16049: if ($mailing eq 'helpdeskmail') {
1.1270 raeburn 16050: if ((!@recipients) && ($lastresort ne '')) {
16051: push(@recipients,$lastresort);
16052: }
16053: } elsif ($lastresort ne '') {
16054: if (!grep(/^\Q$lastresort\E$/,@recipients)) {
16055: push(@recipients,$lastresort);
16056: }
16057: }
1.1271 raeburn 16058: my $recipientlist = join(',',@recipients);
1.1270 raeburn 16059: if (wantarray) {
16060: return ($recipientlist,$allbcc,$addtext);
16061: } else {
16062: return $recipientlist;
16063: }
1.618 raeburn 16064: }
16065:
1.127 matthew 16066: ############################################################
16067: ############################################################
1.154 albertel 16068:
1.655 raeburn 16069: =pod
16070:
1.1224 musolffc 16071: =over 4
16072:
1.1223 musolffc 16073: =item * &mime_email()
16074:
16075: Sends an email with a possible attachment
16076:
16077: Inputs:
16078:
16079: =over 4
16080:
16081: from - Sender's email address
16082:
1.1343 raeburn 16083: replyto - Reply-To email address
16084:
1.1223 musolffc 16085: to - Email address of recipient
16086:
16087: subject - Subject of email
16088:
16089: body - Body of email
16090:
16091: cc_string - Carbon copy email address
16092:
16093: bcc - Blind carbon copy email address
16094:
16095: attachment_path - Path of file to be attached
16096:
16097: file_name - Name of file to be attached
16098:
16099: attachment_text - The body of an attachment of type "TEXT"
16100:
16101: =back
16102:
16103: =back
16104:
16105: =cut
16106:
16107: ############################################################
16108: ############################################################
16109:
16110: sub mime_email {
1.1343 raeburn 16111: my ($from,$replyto,$to,$subject,$body,$cc_string,$bcc,$attachment_path,
16112: $file_name,$attachment_text) = @_;
16113:
1.1223 musolffc 16114: my $msg = MIME::Lite->new(
16115: From => $from,
16116: To => $to,
16117: Subject => $subject,
16118: Type =>'TEXT',
16119: Data => $body,
16120: );
1.1343 raeburn 16121: if ($replyto ne '') {
16122: $msg->add("Reply-To" => $replyto);
16123: }
1.1223 musolffc 16124: if ($cc_string ne '') {
16125: $msg->add("Cc" => $cc_string);
16126: }
16127: if ($bcc ne '') {
16128: $msg->add("Bcc" => $bcc);
16129: }
16130: $msg->attr("content-type" => "text/plain");
16131: $msg->attr("content-type.charset" => "UTF-8");
16132: # Attach file if given
16133: if ($attachment_path) {
16134: unless ($file_name) {
16135: if ($attachment_path =~ m-/([^/]+)$-) { $file_name = $1; }
16136: }
16137: my ($type, $encoding) = MIME::Types::by_suffix($attachment_path);
16138: $msg->attach(Type => $type,
16139: Path => $attachment_path,
16140: Filename => $file_name
16141: );
16142: # Otherwise attach text if given
16143: } elsif ($attachment_text) {
16144: $msg->attach(Type => 'TEXT',
16145: Data => $attachment_text);
16146: }
16147: # Send it
16148: $msg->send('sendmail');
16149: }
16150:
16151: ############################################################
16152: ############################################################
16153:
16154: =pod
16155:
1.655 raeburn 16156: =head1 Course Catalog Routines
16157:
16158: =over 4
16159:
16160: =item * &gather_categories()
16161:
16162: Converts category definitions - keys of categories hash stored in
16163: coursecategories in configuration.db on the primary library server in a
16164: domain - to an array. Also generates javascript and idx hash used to
16165: generate Domain Coordinator interface for editing Course Categories.
16166:
16167: Inputs:
1.663 raeburn 16168:
1.655 raeburn 16169: categories (reference to hash of category definitions).
1.663 raeburn 16170:
1.655 raeburn 16171: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16172: categories and subcategories).
1.663 raeburn 16173:
1.655 raeburn 16174: idx (reference to hash of counters used in Domain Coordinator interface for
16175: editing Course Categories).
1.663 raeburn 16176:
1.655 raeburn 16177: jsarray (reference to array of categories used to create Javascript arrays for
16178: Domain Coordinator interface for editing Course Categories).
16179:
16180: Returns: nothing
16181:
16182: Side effects: populates cats, idx and jsarray.
16183:
16184: =cut
16185:
16186: sub gather_categories {
16187: my ($categories,$cats,$idx,$jsarray) = @_;
16188: my %counters;
16189: my $num = 0;
16190: foreach my $item (keys(%{$categories})) {
16191: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
16192: if ($container eq '' && $depth == 0) {
16193: $cats->[$depth][$categories->{$item}] = $cat;
16194: } else {
16195: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
16196: }
16197: my ($escitem,$tail) = split(/:/,$item,2);
16198: if ($counters{$tail} eq '') {
16199: $counters{$tail} = $num;
16200: $num ++;
16201: }
16202: if (ref($idx) eq 'HASH') {
16203: $idx->{$item} = $counters{$tail};
16204: }
16205: if (ref($jsarray) eq 'ARRAY') {
16206: push(@{$jsarray->[$counters{$tail}]},$item);
16207: }
16208: }
16209: return;
16210: }
16211:
16212: =pod
16213:
16214: =item * &extract_categories()
16215:
16216: Used to generate breadcrumb trails for course categories.
16217:
16218: Inputs:
1.663 raeburn 16219:
1.655 raeburn 16220: categories (reference to hash of category definitions).
1.663 raeburn 16221:
1.655 raeburn 16222: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16223: categories and subcategories).
1.663 raeburn 16224:
1.655 raeburn 16225: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 16226:
1.655 raeburn 16227: allitems (reference to hash - key is category key
16228: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 16229:
1.655 raeburn 16230: idx (reference to hash of counters used in Domain Coordinator interface for
16231: editing Course Categories).
1.663 raeburn 16232:
1.655 raeburn 16233: jsarray (reference to array of categories used to create Javascript arrays for
16234: Domain Coordinator interface for editing Course Categories).
16235:
1.665 raeburn 16236: subcats (reference to hash of arrays containing all subcategories within each
16237: category, -recursive)
16238:
1.1321 raeburn 16239: maxd (reference to hash used to hold max depth for all top-level categories).
16240:
1.655 raeburn 16241: Returns: nothing
16242:
16243: Side effects: populates trails and allitems hash references.
16244:
16245: =cut
16246:
16247: sub extract_categories {
1.1321 raeburn 16248: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655 raeburn 16249: if (ref($categories) eq 'HASH') {
16250: &gather_categories($categories,$cats,$idx,$jsarray);
16251: if (ref($cats->[0]) eq 'ARRAY') {
16252: for (my $i=0; $i<@{$cats->[0]}; $i++) {
16253: my $name = $cats->[0][$i];
16254: my $item = &escape($name).'::0';
16255: my $trailstr;
16256: if ($name eq 'instcode') {
16257: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 16258: } elsif ($name eq 'communities') {
16259: $trailstr = &mt('Communities');
1.1239 raeburn 16260: } elsif ($name eq 'placement') {
16261: $trailstr = &mt('Placement Tests');
1.655 raeburn 16262: } else {
16263: $trailstr = $name;
16264: }
16265: if ($allitems->{$item} eq '') {
16266: push(@{$trails},$trailstr);
16267: $allitems->{$item} = scalar(@{$trails})-1;
16268: }
16269: my @parents = ($name);
16270: if (ref($cats->[1]{$name}) eq 'ARRAY') {
16271: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
16272: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 16273: if (ref($subcats) eq 'HASH') {
16274: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
16275: }
1.1321 raeburn 16276: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665 raeburn 16277: }
16278: } else {
16279: if (ref($subcats) eq 'HASH') {
16280: $subcats->{$item} = [];
1.655 raeburn 16281: }
1.1321 raeburn 16282: if (ref($maxd) eq 'HASH') {
16283: $maxd->{$name} = 1;
16284: }
1.655 raeburn 16285: }
16286: }
16287: }
16288: }
16289: return;
16290: }
16291:
16292: =pod
16293:
1.1162 raeburn 16294: =item * &recurse_categories()
1.655 raeburn 16295:
16296: Recursively used to generate breadcrumb trails for course categories.
16297:
16298: Inputs:
1.663 raeburn 16299:
1.655 raeburn 16300: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16301: categories and subcategories).
1.663 raeburn 16302:
1.655 raeburn 16303: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 16304:
16305: category (current course category, for which breadcrumb trail is being generated).
16306:
16307: trails (reference to array of breadcrumb trails for each category).
16308:
1.655 raeburn 16309: allitems (reference to hash - key is category key
16310: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 16311:
1.655 raeburn 16312: parents (array containing containers directories for current category,
16313: back to top level).
16314:
16315: Returns: nothing
16316:
16317: Side effects: populates trails and allitems hash references
16318:
16319: =cut
16320:
16321: sub recurse_categories {
1.1321 raeburn 16322: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655 raeburn 16323: my $shallower = $depth - 1;
16324: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
16325: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
16326: my $name = $cats->[$depth]{$category}[$k];
16327: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321 raeburn 16328: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 16329: if ($allitems->{$item} eq '') {
16330: push(@{$trails},$trailstr);
16331: $allitems->{$item} = scalar(@{$trails})-1;
16332: }
16333: my $deeper = $depth+1;
16334: push(@{$parents},$category);
1.665 raeburn 16335: if (ref($subcats) eq 'HASH') {
16336: my $subcat = &escape($name).':'.$category.':'.$depth;
16337: for (my $j=@{$parents}; $j>=0; $j--) {
16338: my $higher;
16339: if ($j > 0) {
16340: $higher = &escape($parents->[$j]).':'.
16341: &escape($parents->[$j-1]).':'.$j;
16342: } else {
16343: $higher = &escape($parents->[$j]).'::'.$j;
16344: }
16345: push(@{$subcats->{$higher}},$subcat);
16346: }
16347: }
16348: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1321 raeburn 16349: $subcats,$maxd);
1.655 raeburn 16350: pop(@{$parents});
16351: }
16352: } else {
16353: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321 raeburn 16354: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 16355: if ($allitems->{$item} eq '') {
16356: push(@{$trails},$trailstr);
16357: $allitems->{$item} = scalar(@{$trails})-1;
16358: }
1.1321 raeburn 16359: if (ref($maxd) eq 'HASH') {
16360: if ($depth > $maxd->{$parents->[0]}) {
16361: $maxd->{$parents->[0]} = $depth;
16362: }
16363: }
1.655 raeburn 16364: }
16365: return;
16366: }
16367:
1.663 raeburn 16368: =pod
16369:
1.1162 raeburn 16370: =item * &assign_categories_table()
1.663 raeburn 16371:
16372: Create a datatable for display of hierarchical categories in a domain,
16373: with checkboxes to allow a course to be categorized.
16374:
16375: Inputs:
16376:
16377: cathash - reference to hash of categories defined for the domain (from
16378: configuration.db)
16379:
16380: currcat - scalar with an & separated list of categories assigned to a course.
16381:
1.919 raeburn 16382: type - scalar contains course type (Course or Community).
16383:
1.1260 raeburn 16384: disabled - scalar (optional) contains disabled="disabled" if input elements are
16385: to be readonly (e.g., Domain Helpdesk role viewing course settings).
16386:
1.663 raeburn 16387: Returns: $output (markup to be displayed)
16388:
16389: =cut
16390:
16391: sub assign_categories_table {
1.1259 raeburn 16392: my ($cathash,$currcat,$type,$disabled) = @_;
1.663 raeburn 16393: my $output;
16394: if (ref($cathash) eq 'HASH') {
1.1321 raeburn 16395: my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
16396: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663 raeburn 16397: $maxdepth = scalar(@cats);
16398: if (@cats > 0) {
16399: my $itemcount = 0;
16400: if (ref($cats[0]) eq 'ARRAY') {
16401: my @currcategories;
16402: if ($currcat ne '') {
16403: @currcategories = split('&',$currcat);
16404: }
1.919 raeburn 16405: my $table;
1.663 raeburn 16406: for (my $i=0; $i<@{$cats[0]}; $i++) {
16407: my $parent = $cats[0][$i];
1.919 raeburn 16408: next if ($parent eq 'instcode');
16409: if ($type eq 'Community') {
16410: next unless ($parent eq 'communities');
1.1239 raeburn 16411: } elsif ($type eq 'Placement') {
16412: next unless ($parent eq 'placement');
1.919 raeburn 16413: } else {
1.1239 raeburn 16414: next if (($parent eq 'communities') || ($parent eq 'placement'));
1.919 raeburn 16415: }
1.663 raeburn 16416: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
16417: my $item = &escape($parent).'::0';
16418: my $checked = '';
16419: if (@currcategories > 0) {
16420: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 16421: $checked = ' checked="checked"';
1.663 raeburn 16422: }
16423: }
1.919 raeburn 16424: my $parent_title = $parent;
16425: if ($parent eq 'communities') {
16426: $parent_title = &mt('Communities');
1.1239 raeburn 16427: } elsif ($parent eq 'placement') {
16428: $parent_title = &mt('Placement Tests');
1.919 raeburn 16429: }
16430: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
16431: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 16432: $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919 raeburn 16433: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 16434: my $depth = 1;
16435: push(@path,$parent);
1.1259 raeburn 16436: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663 raeburn 16437: pop(@path);
1.919 raeburn 16438: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 16439: $itemcount ++;
16440: }
1.919 raeburn 16441: if ($itemcount) {
16442: $output = &Apache::loncommon::start_data_table().
16443: $table.
16444: &Apache::loncommon::end_data_table();
16445: }
1.663 raeburn 16446: }
16447: }
16448: }
16449: return $output;
16450: }
16451:
16452: =pod
16453:
1.1162 raeburn 16454: =item * &assign_category_rows()
1.663 raeburn 16455:
16456: Create a datatable row for display of nested categories in a domain,
16457: with checkboxes to allow a course to be categorized,called recursively.
16458:
16459: Inputs:
16460:
16461: itemcount - track row number for alternating colors
16462:
16463: cats - reference to array of arrays/hashes which encapsulates hierarchy of
16464: categories and subcategories.
16465:
16466: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
16467:
16468: parent - parent of current category item
16469:
16470: path - Array containing all categories back up through the hierarchy from the
16471: current category to the top level.
16472:
16473: currcategories - reference to array of current categories assigned to the course
16474:
1.1260 raeburn 16475: disabled - scalar (optional) contains disabled="disabled" if input elements are
16476: to be readonly (e.g., Domain Helpdesk role viewing course settings).
16477:
1.663 raeburn 16478: Returns: $output (markup to be displayed).
16479:
16480: =cut
16481:
16482: sub assign_category_rows {
1.1259 raeburn 16483: my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663 raeburn 16484: my ($text,$name,$item,$chgstr);
16485: if (ref($cats) eq 'ARRAY') {
16486: my $maxdepth = scalar(@{$cats});
16487: if (ref($cats->[$depth]) eq 'HASH') {
16488: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
16489: my $numchildren = @{$cats->[$depth]{$parent}};
16490: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1145 raeburn 16491: $text .= '<td><table class="LC_data_table">';
1.663 raeburn 16492: for (my $j=0; $j<$numchildren; $j++) {
16493: $name = $cats->[$depth]{$parent}[$j];
16494: $item = &escape($name).':'.&escape($parent).':'.$depth;
16495: my $deeper = $depth+1;
16496: my $checked = '';
16497: if (ref($currcategories) eq 'ARRAY') {
16498: if (@{$currcategories} > 0) {
16499: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 16500: $checked = ' checked="checked"';
1.663 raeburn 16501: }
16502: }
16503: }
1.664 raeburn 16504: $text .= '<tr><td><span class="LC_nobreak"><label>'.
16505: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 16506: $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675 raeburn 16507: '<input type="hidden" name="catname" value="'.$name.'" />'.
16508: '</td><td>';
1.663 raeburn 16509: if (ref($path) eq 'ARRAY') {
16510: push(@{$path},$name);
1.1259 raeburn 16511: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663 raeburn 16512: pop(@{$path});
16513: }
16514: $text .= '</td></tr>';
16515: }
16516: $text .= '</table></td>';
16517: }
16518: }
16519: }
16520: return $text;
16521: }
16522:
1.1181 raeburn 16523: =pod
16524:
16525: =back
16526:
16527: =cut
16528:
1.655 raeburn 16529: ############################################################
16530: ############################################################
16531:
16532:
1.443 albertel 16533: sub commit_customrole {
1.664 raeburn 16534: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.1399 raeburn 16535: my $result = &Apache::lonnet::assigncustomrole(
16536: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context);
1.630 raeburn 16537: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 16538: ($start?', '.&mt('starting').' '.localtime($start):'').
1.1399 raeburn 16539: ($end?', ending '.localtime($end):'').': <b>'.$result.'</b><br />';
16540: if (wantarray) {
16541: return ($output,$result);
16542: } else {
16543: return $output;
16544: }
1.443 albertel 16545: }
16546:
16547: sub commit_standardrole {
1.1116 raeburn 16548: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits) = @_;
1.1399 raeburn 16549: my ($output,$logmsg,$linefeed,$result);
1.541 raeburn 16550: if ($context eq 'auto') {
16551: $linefeed = "\n";
16552: } else {
16553: $linefeed = "<br />\n";
16554: }
1.443 albertel 16555: if ($three eq 'st') {
1.1399 raeburn 16556: $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
16557: $one,$two,$sec,$context,$credits);
1.541 raeburn 16558: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 16559: ($result eq 'unknown_course') || ($result eq 'refused')) {
16560: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 16561: } else {
1.541 raeburn 16562: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 16563: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 16564: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
16565: if ($context eq 'auto') {
16566: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
16567: } else {
16568: $output .= '<b>'.$result.'</b>'.$linefeed.
16569: &mt('Add to classlist').': <b>ok</b>';
16570: }
16571: $output .= $linefeed;
1.443 albertel 16572: }
16573: } else {
16574: $output = &mt('Assigning').' '.$three.' in '.$url.
16575: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 16576: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.1399 raeburn 16577: $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 16578: if ($context eq 'auto') {
16579: $output .= $result.$linefeed;
16580: } else {
16581: $output .= '<b>'.$result.'</b>'.$linefeed;
16582: }
1.443 albertel 16583: }
1.1399 raeburn 16584: if (wantarray) {
16585: return ($output,$result);
16586: } else {
16587: return $output;
16588: }
1.443 albertel 16589: }
16590:
16591: sub commit_studentrole {
1.1116 raeburn 16592: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
16593: $credits) = @_;
1.626 raeburn 16594: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 16595: if ($context eq 'auto') {
16596: $linefeed = "\n";
16597: } else {
16598: $linefeed = '<br />'."\n";
16599: }
1.443 albertel 16600: if (defined($one) && defined($two)) {
16601: my $cid=$one.'_'.$two;
16602: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
16603: my $secchange = 0;
16604: my $expire_role_result;
16605: my $modify_section_result;
1.628 raeburn 16606: if ($oldsec ne '-1') {
16607: if ($oldsec ne $sec) {
1.443 albertel 16608: $secchange = 1;
1.628 raeburn 16609: my $now = time;
1.443 albertel 16610: my $uurl='/'.$cid;
16611: $uurl=~s/\_/\//g;
16612: if ($oldsec) {
16613: $uurl.='/'.$oldsec;
16614: }
1.626 raeburn 16615: $oldsecurl = $uurl;
1.628 raeburn 16616: $expire_role_result =
1.1398 raeburn 16617: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','','',$context);
1.628 raeburn 16618: if ($env{'request.course.sec'} ne '') {
16619: if ($expire_role_result eq 'refused') {
16620: my @roles = ('st');
16621: my @statuses = ('previous');
16622: my @roledoms = ($one);
16623: my $withsec = 1;
16624: my %roleshash =
16625: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
16626: \@statuses,\@roles,\@roledoms,$withsec);
16627: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
16628: my ($oldstart,$oldend) =
16629: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
16630: if ($oldend > 0 && $oldend <= $now) {
16631: $expire_role_result = 'ok';
16632: }
16633: }
16634: }
16635: }
1.443 albertel 16636: $result = $expire_role_result;
16637: }
16638: }
16639: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1116 raeburn 16640: $modify_section_result =
16641: &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
16642: undef,undef,undef,$sec,
16643: $end,$start,'','',$cid,
16644: '',$context,$credits);
1.443 albertel 16645: if ($modify_section_result =~ /^ok/) {
16646: if ($secchange == 1) {
1.628 raeburn 16647: if ($sec eq '') {
16648: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
16649: } else {
16650: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
16651: }
1.443 albertel 16652: } elsif ($oldsec eq '-1') {
1.628 raeburn 16653: if ($sec eq '') {
16654: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
16655: } else {
16656: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
16657: }
1.443 albertel 16658: } else {
1.628 raeburn 16659: if ($sec eq '') {
16660: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
16661: } else {
16662: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
16663: }
1.443 albertel 16664: }
16665: } else {
1.1115 raeburn 16666: if ($secchange) {
1.628 raeburn 16667: $$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;
16668: } else {
16669: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
16670: }
1.443 albertel 16671: }
16672: $result = $modify_section_result;
16673: } elsif ($secchange == 1) {
1.628 raeburn 16674: if ($oldsec eq '') {
1.1103 raeburn 16675: $$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 16676: } else {
16677: $$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;
16678: }
1.626 raeburn 16679: if ($expire_role_result eq 'refused') {
16680: my $newsecurl = '/'.$cid;
16681: $newsecurl =~ s/\_/\//g;
16682: if ($sec ne '') {
16683: $newsecurl.='/'.$sec;
16684: }
16685: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
16686: if ($sec eq '') {
16687: $$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;
16688: } else {
16689: $$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;
16690: }
16691: }
16692: }
1.443 albertel 16693: }
16694: } else {
1.626 raeburn 16695: $$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 16696: $result = "error: incomplete course id\n";
16697: }
16698: return $result;
16699: }
16700:
1.1108 raeburn 16701: sub show_role_extent {
16702: my ($scope,$context,$role) = @_;
16703: $scope =~ s{^/}{};
16704: my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
16705: push(@courseroles,'co');
16706: my @authorroles = &Apache::lonuserutils::roles_by_context('author');
16707: if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
16708: $scope =~ s{/}{_};
16709: return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
16710: } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
16711: my ($audom,$auname) = split(/\//,$scope);
16712: return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
16713: &Apache::loncommon::plainname($auname,$audom).'</span>');
16714: } else {
16715: $scope =~ s{/$}{};
16716: return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
16717: &Apache::lonnet::domain($scope,'description').'</span>');
16718: }
16719: }
16720:
1.443 albertel 16721: ############################################################
16722: ############################################################
16723:
1.566 albertel 16724: sub check_clone {
1.578 raeburn 16725: my ($args,$linefeed) = @_;
1.566 albertel 16726: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
16727: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
16728: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
1.1344 raeburn 16729: my $clonetitle;
16730: my @clonemsg;
1.566 albertel 16731: my $can_clone = 0;
1.944 raeburn 16732: my $lctype = lc($args->{'crstype'});
1.908 raeburn 16733: if ($lctype ne 'community') {
16734: $lctype = 'course';
16735: }
1.566 albertel 16736: if ($clonehome eq 'no_host') {
1.944 raeburn 16737: if ($args->{'crstype'} eq 'Community') {
1.1344 raeburn 16738: push(@clonemsg,({
16739: mt => 'No new community created.',
16740: args => [],
16741: },
16742: {
16743: mt => 'A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',
16744: args => [$args->{'clonedomain'}.':'.$args->{'clonedomain'}],
16745: }));
1.908 raeburn 16746: } else {
1.1344 raeburn 16747: push(@clonemsg,({
16748: mt => 'No new course created.',
16749: args => [],
16750: },
16751: {
16752: mt => 'A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',
16753: args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
16754: }));
16755: }
1.566 albertel 16756: } else {
16757: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.1344 raeburn 16758: $clonetitle = $clonedesc{'description'};
1.944 raeburn 16759: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 16760: if ($clonedesc{'type'} ne 'Community') {
1.1344 raeburn 16761: push(@clonemsg,({
16762: mt => 'No new community created.',
16763: args => [],
16764: },
16765: {
16766: mt => 'A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',
16767: args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
16768: }));
16769: return ($can_clone,\@clonemsg,$cloneid,$clonehome);
1.908 raeburn 16770: }
16771: }
1.1262 raeburn 16772: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882 raeburn 16773: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 16774: $can_clone = 1;
16775: } else {
1.1221 raeburn 16776: my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566 albertel 16777: $args->{'clonedomain'},$args->{'clonecourse'});
1.1221 raeburn 16778: if ($clonehash{'cloners'} eq '') {
16779: my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
16780: if ($domdefs{'canclone'}) {
16781: unless ($domdefs{'canclone'} eq 'none') {
16782: if ($domdefs{'canclone'} eq 'domain') {
16783: if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
16784: $can_clone = 1;
16785: }
16786: } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
16787: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
16788: if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
16789: $clonehash{'internal.coursecode'},$args->{'crscode'})) {
16790: $can_clone = 1;
16791: }
16792: }
16793: }
16794: }
1.578 raeburn 16795: } else {
1.1221 raeburn 16796: my @cloners = split(/,/,$clonehash{'cloners'});
16797: if (grep(/^\*$/,@cloners)) {
1.942 raeburn 16798: $can_clone = 1;
1.1221 raeburn 16799: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942 raeburn 16800: $can_clone = 1;
1.1225 raeburn 16801: } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
16802: $can_clone = 1;
1.1221 raeburn 16803: }
16804: unless ($can_clone) {
1.1225 raeburn 16805: if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
16806: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
1.1221 raeburn 16807: my (%gotdomdefaults,%gotcodedefaults);
16808: foreach my $cloner (@cloners) {
16809: if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
16810: ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
16811: my (%codedefaults,@code_order);
16812: if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
16813: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
16814: %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
16815: }
16816: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
16817: @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
16818: }
16819: } else {
16820: &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
16821: \%codedefaults,
16822: \@code_order);
16823: $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
16824: $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
16825: }
16826: if (@code_order > 0) {
16827: if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
16828: $cloner,$clonehash{'internal.coursecode'},
16829: $args->{'crscode'})) {
16830: $can_clone = 1;
16831: last;
16832: }
16833: }
16834: }
16835: }
16836: }
1.1225 raeburn 16837: }
16838: }
16839: unless ($can_clone) {
16840: my $ccrole = 'cc';
16841: if ($args->{'crstype'} eq 'Community') {
16842: $ccrole = 'co';
16843: }
16844: my %roleshash =
16845: &Apache::lonnet::get_my_roles($args->{'ccuname'},
16846: $args->{'ccdomain'},
16847: 'userroles',['active'],[$ccrole],
16848: [$args->{'clonedomain'}]);
16849: if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
16850: $can_clone = 1;
16851: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
16852: $args->{'ccuname'},$args->{'ccdomain'})) {
16853: $can_clone = 1;
1.1221 raeburn 16854: }
16855: }
16856: unless ($can_clone) {
16857: if ($args->{'crstype'} eq 'Community') {
1.1344 raeburn 16858: push(@clonemsg,({
16859: mt => 'No new community created.',
16860: args => [],
16861: },
16862: {
16863: 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]).',
16864: args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
16865: }));
1.942 raeburn 16866: } else {
1.1344 raeburn 16867: push(@clonemsg,({
16868: mt => 'No new course created.',
16869: args => [],
16870: },
16871: {
16872: 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]).',
16873: args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
16874: }));
1.1221 raeburn 16875: }
1.566 albertel 16876: }
1.578 raeburn 16877: }
1.566 albertel 16878: }
1.1344 raeburn 16879: return ($can_clone,\@clonemsg,$cloneid,$clonehome,$clonetitle);
1.566 albertel 16880: }
16881:
1.444 albertel 16882: sub construct_course {
1.1262 raeburn 16883: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
1.1344 raeburn 16884: $cnum,$category,$coderef,$callercontext,$user_lh) = @_;
16885: my ($outcome,$msgref,$clonemsgref);
1.541 raeburn 16886: my $linefeed = '<br />'."\n";
16887: if ($context eq 'auto') {
16888: $linefeed = "\n";
16889: }
1.566 albertel 16890:
16891: #
16892: # Are we cloning?
16893: #
1.1344 raeburn 16894: my ($can_clone,$cloneid,$clonehome,$clonetitle);
1.566 albertel 16895: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.1344 raeburn 16896: ($can_clone,$clonemsgref,$cloneid,$clonehome,$clonetitle) = &check_clone($args,$linefeed);
1.566 albertel 16897: if (!$can_clone) {
1.1344 raeburn 16898: return (0,$outcome,$clonemsgref);
1.566 albertel 16899: }
16900: }
16901:
1.444 albertel 16902: #
16903: # Open course
16904: #
1.1239 raeburn 16905: my $showncrstype;
16906: if ($args->{'crstype'} eq 'Placement') {
16907: $showncrstype = 'placement test';
16908: } else {
16909: $showncrstype = lc($args->{'crstype'});
16910: }
1.444 albertel 16911: my %cenv=();
16912: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
16913: $args->{'cdescr'},
16914: $args->{'curl'},
16915: $args->{'course_home'},
16916: $args->{'nonstandard'},
16917: $args->{'crscode'},
16918: $args->{'ccuname'}.':'.
16919: $args->{'ccdomain'},
1.882 raeburn 16920: $args->{'crstype'},
1.1344 raeburn 16921: $cnum,$context,$category,
16922: $callercontext);
1.444 albertel 16923:
16924: # Note: The testing routines depend on this being output; see
16925: # Utils::Course. This needs to at least be output as a comment
16926: # if anyone ever decides to not show this, and Utils::Course::new
16927: # will need to be suitably modified.
1.1344 raeburn 16928: if (($callercontext eq 'auto') && ($user_lh ne '')) {
16929: $outcome .= &mt_user($user_lh,'New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
16930: } else {
16931: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
16932: }
1.943 raeburn 16933: if ($$courseid =~ /^error:/) {
1.1344 raeburn 16934: return (0,$outcome,$clonemsgref);
1.943 raeburn 16935: }
16936:
1.444 albertel 16937: #
16938: # Check if created correctly
16939: #
1.479 albertel 16940: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 16941: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 16942: if ($crsuhome eq 'no_host') {
1.1344 raeburn 16943: if (($callercontext eq 'auto') && ($user_lh ne '')) {
16944: $outcome .= &mt_user($user_lh,
16945: 'Course creation failed, unrecognized course home server.');
16946: } else {
16947: $outcome .= &mt('Course creation failed, unrecognized course home server.');
16948: }
16949: $outcome .= $linefeed;
16950: return (0,$outcome,$clonemsgref);
1.943 raeburn 16951: }
1.541 raeburn 16952: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 16953:
1.444 albertel 16954: #
1.566 albertel 16955: # Do the cloning
16956: #
1.1344 raeburn 16957: my @clonemsg;
1.566 albertel 16958: if ($can_clone && $cloneid) {
1.1344 raeburn 16959: push(@clonemsg,
16960: {
16961: mt => 'Created [_1] by cloning from [_2]',
16962: args => [$showncrstype,$clonetitle],
16963: });
1.566 albertel 16964: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 16965: # Copy all files
1.1344 raeburn 16966: my @info =
16967: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},
16968: $args->{'dateshift'},$args->{'crscode'},
16969: $args->{'ccuname'}.':'.$args->{'ccdomain'},
16970: $args->{'tinyurls'});
16971: if (@info) {
16972: push(@clonemsg,@info);
16973: }
1.444 albertel 16974: # Restore URL
1.566 albertel 16975: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 16976: # Restore title
1.566 albertel 16977: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 16978: # Restore creation date, creator and creation context.
16979: $cenv{'internal.created'}=$oldcenv{'internal.created'};
16980: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
16981: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 16982: # Mark as cloned
1.566 albertel 16983: $cenv{'clonedfrom'}=$cloneid;
1.638 www 16984: # Need to clone grading mode
16985: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
16986: $cenv{'grading'}=$newenv{'grading'};
16987: # Do not clone these environment entries
16988: &Apache::lonnet::del('environment',
16989: ['default_enrollment_start_date',
16990: 'default_enrollment_end_date',
16991: 'question.email',
16992: 'policy.email',
16993: 'comment.email',
16994: 'pch.users.denied',
1.725 raeburn 16995: 'plc.users.denied',
16996: 'hidefromcat',
1.1121 raeburn 16997: 'checkforpriv',
1.1355 raeburn 16998: 'categories'],
1.638 www 16999: $$crsudom,$$crsunum);
1.1170 raeburn 17000: if ($args->{'textbook'}) {
17001: $cenv{'internal.textbook'} = $args->{'textbook'};
17002: }
1.444 albertel 17003: }
1.566 albertel 17004:
1.444 albertel 17005: #
17006: # Set environment (will override cloned, if existing)
17007: #
17008: my @sections = ();
17009: my @xlists = ();
17010: if ($args->{'crstype'}) {
17011: $cenv{'type'}=$args->{'crstype'};
17012: }
1.1371 raeburn 17013: if ($args->{'lti'}) {
17014: $cenv{'internal.lti'}=$args->{'lti'};
17015: }
1.444 albertel 17016: if ($args->{'crsid'}) {
17017: $cenv{'courseid'}=$args->{'crsid'};
17018: }
17019: if ($args->{'crscode'}) {
17020: $cenv{'internal.coursecode'}=$args->{'crscode'};
17021: }
17022: if ($args->{'crsquota'} ne '') {
17023: $cenv{'internal.coursequota'}=$args->{'crsquota'};
17024: } else {
17025: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
17026: }
17027: if ($args->{'ccuname'}) {
17028: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
17029: ':'.$args->{'ccdomain'};
17030: } else {
17031: $cenv{'internal.courseowner'} = $args->{'curruser'};
17032: }
1.1116 raeburn 17033: if ($args->{'defaultcredits'}) {
17034: $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
17035: }
1.444 albertel 17036: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
17037: if ($args->{'crssections'}) {
17038: $cenv{'internal.sectionnums'} = '';
17039: if ($args->{'crssections'} =~ m/,/) {
17040: @sections = split/,/,$args->{'crssections'};
17041: } else {
17042: $sections[0] = $args->{'crssections'};
17043: }
17044: if (@sections > 0) {
17045: foreach my $item (@sections) {
17046: my ($sec,$gp) = split/:/,$item;
17047: my $class = $args->{'crscode'}.$sec;
17048: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
17049: $cenv{'internal.sectionnums'} .= $item.',';
17050: unless ($addcheck eq 'ok') {
1.1263 raeburn 17051: push(@badclasses,$class);
1.444 albertel 17052: }
17053: }
17054: $cenv{'internal.sectionnums'} =~ s/,$//;
17055: }
17056: }
17057: # do not hide course coordinator from staff listing,
17058: # even if privileged
17059: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1121 raeburn 17060: # add course coordinator's domain to domains to check for privileged users
17061: # if different to course domain
17062: if ($$crsudom ne $args->{'ccdomain'}) {
17063: $cenv{'checkforpriv'} = $args->{'ccdomain'};
17064: }
1.444 albertel 17065: # add crosslistings
17066: if ($args->{'crsxlist'}) {
17067: $cenv{'internal.crosslistings'}='';
17068: if ($args->{'crsxlist'} =~ m/,/) {
17069: @xlists = split/,/,$args->{'crsxlist'};
17070: } else {
17071: $xlists[0] = $args->{'crsxlist'};
17072: }
17073: if (@xlists > 0) {
17074: foreach my $item (@xlists) {
17075: my ($xl,$gp) = split/:/,$item;
17076: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
17077: $cenv{'internal.crosslistings'} .= $item.',';
17078: unless ($addcheck eq 'ok') {
1.1263 raeburn 17079: push(@badclasses,$xl);
1.444 albertel 17080: }
17081: }
17082: $cenv{'internal.crosslistings'} =~ s/,$//;
17083: }
17084: }
17085: if ($args->{'autoadds'}) {
17086: $cenv{'internal.autoadds'}=$args->{'autoadds'};
17087: }
17088: if ($args->{'autodrops'}) {
17089: $cenv{'internal.autodrops'}=$args->{'autodrops'};
17090: }
17091: # check for notification of enrollment changes
17092: my @notified = ();
17093: if ($args->{'notify_owner'}) {
17094: if ($args->{'ccuname'} ne '') {
17095: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
17096: }
17097: }
17098: if ($args->{'notify_dc'}) {
17099: if ($uname ne '') {
1.630 raeburn 17100: push(@notified,$uname.':'.$udom);
1.444 albertel 17101: }
17102: }
17103: if (@notified > 0) {
17104: my $notifylist;
17105: if (@notified > 1) {
17106: $notifylist = join(',',@notified);
17107: } else {
17108: $notifylist = $notified[0];
17109: }
17110: $cenv{'internal.notifylist'} = $notifylist;
17111: }
17112: if (@badclasses > 0) {
17113: my %lt=&Apache::lonlocal::texthash(
1.1264 raeburn 17114: 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
17115: 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
17116: 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444 albertel 17117: );
1.1264 raeburn 17118: my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
17119: &mt('That is because the user identified as the course owner ([_1]) does not have rights to access enrollment in these classes, as determined by the policies of your institution on access to official classlists',$cenv{'internal.courseowner'}).$linefeed.$lt{'itis'};
1.541 raeburn 17120: if ($context eq 'auto') {
17121: $outcome .= $badclass_msg.$linefeed;
1.1261 raeburn 17122: } else {
1.566 albertel 17123: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1261 raeburn 17124: }
17125: foreach my $item (@badclasses) {
1.541 raeburn 17126: if ($context eq 'auto') {
1.1261 raeburn 17127: $outcome .= " - $item\n";
1.541 raeburn 17128: } else {
1.1261 raeburn 17129: $outcome .= "<li>$item</li>\n";
1.541 raeburn 17130: }
1.1261 raeburn 17131: }
17132: if ($context eq 'auto') {
17133: $outcome .= $linefeed;
17134: } else {
17135: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 17136: }
1.444 albertel 17137: }
17138: if ($args->{'no_end_date'}) {
17139: $args->{'endaccess'} = 0;
17140: }
17141: $cenv{'internal.autostart'}=$args->{'enrollstart'};
17142: $cenv{'internal.autoend'}=$args->{'enrollend'};
17143: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
17144: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
17145: if ($args->{'showphotos'}) {
17146: $cenv{'internal.showphotos'}=$args->{'showphotos'};
17147: }
17148: $cenv{'internal.authtype'} = $args->{'authtype'};
17149: $cenv{'internal.autharg'} = $args->{'autharg'};
17150: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
17151: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 17152: 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');
17153: if ($context eq 'auto') {
17154: $outcome .= $krb_msg;
17155: } else {
1.566 albertel 17156: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 17157: }
17158: $outcome .= $linefeed;
1.444 albertel 17159: }
17160: }
17161: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
17162: if ($args->{'setpolicy'}) {
17163: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17164: }
17165: if ($args->{'setcontent'}) {
17166: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17167: }
1.1251 raeburn 17168: if ($args->{'setcomment'}) {
17169: $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17170: }
1.444 albertel 17171: }
17172: if ($args->{'reshome'}) {
17173: $cenv{'reshome'}=$args->{'reshome'}.'/';
17174: $cenv{'reshome'}=~s/\/+$/\//;
17175: }
17176: #
17177: # course has keyed access
17178: #
17179: if ($args->{'setkeys'}) {
17180: $cenv{'keyaccess'}='yes';
17181: }
17182: # if specified, key authority is not course, but user
17183: # only active if keyaccess is yes
17184: if ($args->{'keyauth'}) {
1.487 albertel 17185: my ($user,$domain) = split(':',$args->{'keyauth'});
17186: $user = &LONCAPA::clean_username($user);
17187: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 17188: if ($user ne '' && $domain ne '') {
1.487 albertel 17189: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 17190: }
17191: }
17192:
1.1166 raeburn 17193: #
1.1167 raeburn 17194: # generate and store uniquecode (available to course requester), if course should have one.
1.1166 raeburn 17195: #
17196: if ($args->{'uniquecode'}) {
17197: my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
17198: if ($code) {
17199: $cenv{'internal.uniquecode'} = $code;
1.1167 raeburn 17200: my %crsinfo =
17201: &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
17202: if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
17203: $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
17204: my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
17205: }
1.1166 raeburn 17206: if (ref($coderef)) {
17207: $$coderef = $code;
17208: }
17209: }
17210: }
17211:
1.444 albertel 17212: if ($args->{'disresdis'}) {
17213: $cenv{'pch.roles.denied'}='st';
17214: }
17215: if ($args->{'disablechat'}) {
17216: $cenv{'plc.roles.denied'}='st';
17217: }
17218:
17219: # Record we've not yet viewed the Course Initialization Helper for this
17220: # course
17221: $cenv{'course.helper.not.run'} = 1;
17222: #
17223: # Use new Randomseed
17224: #
17225: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
17226: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
17227: #
17228: # The encryption code and receipt prefix for this course
17229: #
17230: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
17231: $cenv{'internal.encpref'}=100+int(9*rand(99));
17232: #
17233: # By default, use standard grading
17234: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
17235:
1.541 raeburn 17236: $outcome .= $linefeed.&mt('Setting environment').': '.
17237: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 17238: #
17239: # Open all assignments
17240: #
17241: if ($args->{'openall'}) {
1.1341 raeburn 17242: my $opendate = time;
17243: if ($args->{'openallfrom'} =~ /^\d+$/) {
17244: $opendate = $args->{'openallfrom'};
17245: }
1.444 albertel 17246: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
1.1341 raeburn 17247: my %storecontent = ($storeunder => $opendate,
1.444 albertel 17248: $storeunder.'.type' => 'date_start');
1.1341 raeburn 17249: $outcome .= &mt('All assignments open starting [_1]',
17250: &Apache::lonlocal::locallocaltime($opendate)).': '.
17251: &Apache::lonnet::cput
17252: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 17253: }
17254: #
17255: # Set first page
17256: #
17257: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
17258: || ($cloneid)) {
17259: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 17260:
17261: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
17262: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
17263:
1.444 albertel 17264: $outcome .= ($fatal?$errtext:'read ok').' - ';
17265: my $title; my $url;
17266: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 17267: $title=&mt('Syllabus');
1.444 albertel 17268: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
17269: } else {
1.963 raeburn 17270: $title=&mt('Table of Contents');
1.444 albertel 17271: $url='/adm/navmaps';
17272: }
1.445 albertel 17273:
17274: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
17275: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
17276:
17277: if ($errtext) { $fatal=2; }
1.541 raeburn 17278: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 17279: }
1.566 albertel 17280:
1.1237 raeburn 17281: #
17282: # Set params for Placement Tests
17283: #
1.1239 raeburn 17284: if ($args->{'crstype'} eq 'Placement') {
17285: my %storecontent;
17286: my $prefix=$$crsudom.'_'.$$crsunum.'.0.';
17287: my %defaults = (
17288: buttonshide => { value => 'yes',
17289: type => 'string_yesno',},
17290: type => { value => 'randomizetry',
17291: type => 'string_questiontype',},
17292: maxtries => { value => 1,
17293: type => 'int_pos',},
17294: problemstatus => { value => 'no',
17295: type => 'string_problemstatus',},
17296: );
17297: foreach my $key (keys(%defaults)) {
17298: $storecontent{$prefix.$key} = $defaults{$key}{'value'};
17299: $storecontent{$prefix.$key.'.type'} = $defaults{$key}{'type'};
17300: }
1.1237 raeburn 17301: &Apache::lonnet::cput
17302: ('resourcedata',\%storecontent,$$crsudom,$$crsunum);
17303: }
17304:
1.1344 raeburn 17305: return (1,$outcome,\@clonemsg);
1.444 albertel 17306: }
17307:
1.1166 raeburn 17308: sub make_unique_code {
17309: my ($cdom,$cnum) = @_;
17310: # get lock on uniquecodes db
17311: my $lockhash = {
17312: $cnum."\0".'uniquecodes' => $env{'user.name'}.
17313: ':'.$env{'user.domain'},
17314: };
17315: my $tries = 0;
17316: my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
17317: my ($code,$error);
17318:
17319: while (($gotlock ne 'ok') && ($tries<3)) {
17320: $tries ++;
17321: sleep 1;
17322: $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
17323: }
17324: if ($gotlock eq 'ok') {
17325: my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
17326: my $gotcode;
17327: my $attempts = 0;
17328: while ((!$gotcode) && ($attempts < 100)) {
17329: $code = &generate_code();
17330: if (!exists($currcodes{$code})) {
17331: $gotcode = 1;
17332: unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
17333: $error = 'nostore';
17334: }
17335: }
17336: $attempts ++;
17337: }
17338: my @del_lock = ($cnum."\0".'uniquecodes');
17339: my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
17340: } else {
17341: $error = 'nolock';
17342: }
17343: return ($code,$error);
17344: }
17345:
17346: sub generate_code {
17347: my $code;
17348: my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
17349: for (my $i=0; $i<6; $i++) {
17350: my $lettnum = int (rand 2);
17351: my $item = '';
17352: if ($lettnum) {
17353: $item = $letts[int( rand(18) )];
17354: } else {
17355: $item = 1+int( rand(8) );
17356: }
17357: $code .= $item;
17358: }
17359: return $code;
17360: }
17361:
1.444 albertel 17362: ############################################################
17363: ############################################################
17364:
1.1237 raeburn 17365: # Community, Course and Placement Test
1.378 raeburn 17366: sub course_type {
17367: my ($cid) = @_;
17368: if (!defined($cid)) {
17369: $cid = $env{'request.course.id'};
17370: }
1.404 albertel 17371: if (defined($env{'course.'.$cid.'.type'})) {
17372: return $env{'course.'.$cid.'.type'};
1.378 raeburn 17373: } else {
17374: return 'Course';
1.377 raeburn 17375: }
17376: }
1.156 albertel 17377:
1.406 raeburn 17378: sub group_term {
17379: my $crstype = &course_type();
17380: my %names = (
17381: 'Course' => 'group',
1.865 raeburn 17382: 'Community' => 'group',
1.1237 raeburn 17383: 'Placement' => 'group',
1.406 raeburn 17384: );
17385: return $names{$crstype};
17386: }
17387:
1.902 raeburn 17388: sub course_types {
1.1310 raeburn 17389: my @types = ('official','unofficial','community','textbook','placement','lti');
1.902 raeburn 17390: my %typename = (
17391: official => 'Official course',
17392: unofficial => 'Unofficial course',
17393: community => 'Community',
1.1165 raeburn 17394: textbook => 'Textbook course',
1.1237 raeburn 17395: placement => 'Placement test',
1.1310 raeburn 17396: lti => 'LTI provider',
1.902 raeburn 17397: );
17398: return (\@types,\%typename);
17399: }
17400:
1.156 albertel 17401: sub icon {
17402: my ($file)=@_;
1.505 albertel 17403: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 17404: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 17405: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 17406: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
17407: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
17408: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
17409: $curfext.".gif") {
17410: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
17411: $curfext.".gif";
17412: }
17413: }
1.249 albertel 17414: return &lonhttpdurl($iconname);
1.154 albertel 17415: }
1.84 albertel 17416:
1.575 albertel 17417: sub lonhttpdurl {
1.692 www 17418: #
17419: # Had been used for "small fry" static images on separate port 8080.
17420: # Modify here if lightweight http functionality desired again.
17421: # Currently eliminated due to increasing firewall issues.
17422: #
1.575 albertel 17423: my ($url)=@_;
1.692 www 17424: return $url;
1.215 albertel 17425: }
17426:
1.213 albertel 17427: sub connection_aborted {
17428: my ($r)=@_;
17429: $r->print(" ");$r->rflush();
17430: my $c = $r->connection;
17431: return $c->aborted();
17432: }
17433:
1.221 foxr 17434: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 17435: # strings as 'strings'.
17436: sub escape_single {
1.221 foxr 17437: my ($input) = @_;
1.223 albertel 17438: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 17439: $input =~ s/\'/\\\'/g; # Esacpe the 's....
17440: return $input;
17441: }
1.223 albertel 17442:
1.222 foxr 17443: # Same as escape_single, but escape's "'s This
17444: # can be used for "strings"
17445: sub escape_double {
17446: my ($input) = @_;
17447: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
17448: $input =~ s/\"/\\\"/g; # Esacpe the "s....
17449: return $input;
17450: }
1.223 albertel 17451:
1.222 foxr 17452: # Escapes the last element of a full URL.
17453: sub escape_url {
17454: my ($url) = @_;
1.238 raeburn 17455: my @urlslices = split(/\//, $url,-1);
1.369 www 17456: my $lastitem = &escape(pop(@urlslices));
1.1203 raeburn 17457: return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222 foxr 17458: }
1.462 albertel 17459:
1.820 raeburn 17460: sub compare_arrays {
17461: my ($arrayref1,$arrayref2) = @_;
17462: my (@difference,%count);
17463: @difference = ();
17464: %count = ();
17465: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
17466: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
17467: foreach my $element (keys(%count)) {
17468: if ($count{$element} == 1) {
17469: push(@difference,$element);
17470: }
17471: }
17472: }
17473: return @difference;
17474: }
17475:
1.1322 raeburn 17476: sub lon_status_items {
17477: my %defaults = (
17478: E => 100,
17479: W => 4,
17480: N => 1,
1.1324 raeburn 17481: U => 5,
1.1322 raeburn 17482: threshold => 200,
17483: sysmail => 2500,
17484: );
17485: my %names = (
17486: E => 'Errors',
17487: W => 'Warnings',
17488: N => 'Notices',
1.1324 raeburn 17489: U => 'Unsent',
1.1322 raeburn 17490: );
17491: return (\%defaults,\%names);
17492: }
17493:
1.817 bisitz 17494: # -------------------------------------------------------- Initialize user login
1.462 albertel 17495: sub init_user_environment {
1.463 albertel 17496: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 17497: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
17498:
17499: my $public=($username eq 'public' && $domain eq 'public');
17500:
1.1062 raeburn 17501: my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462 albertel 17502: my $now=time;
17503:
17504: if ($public) {
17505: my $max_public=100;
17506: my $oldest;
17507: my $oldest_time=0;
17508: for(my $next=1;$next<=$max_public;$next++) {
17509: if (-e $lonids."/publicuser_$next.id") {
17510: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
17511: if ($mtime<$oldest_time || !$oldest_time) {
17512: $oldest_time=$mtime;
17513: $oldest=$next;
17514: }
17515: } else {
17516: $cookie="publicuser_$next";
17517: last;
17518: }
17519: }
17520: if (!$cookie) { $cookie="publicuser_$oldest"; }
17521: } else {
1.1275 raeburn 17522: # See if old ID present, if so, remove if this isn't a robot,
17523: # killing any existing non-robot sessions
1.463 albertel 17524: if (!$args->{'robot'}) {
17525: opendir(DIR,$lonids);
17526: while ($filename=readdir(DIR)) {
17527: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1320 raeburn 17528: if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
17529: &GDBM_READER(),0640)) {
1.1295 raeburn 17530: my $linkedfile;
1.1320 raeburn 17531: if (exists($oldenv{'user.linkedenv'})) {
17532: $linkedfile = $oldenv{'user.linkedenv'};
1.1295 raeburn 17533: }
1.1320 raeburn 17534: untie(%oldenv);
17535: if (unlink("$lonids/$filename")) {
17536: if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
17537: if (-l "$lonids/$linkedfile.id") {
17538: unlink("$lonids/$linkedfile.id");
17539: }
1.1295 raeburn 17540: }
17541: }
17542: } else {
17543: unlink($lonids.'/'.$filename);
17544: }
1.463 albertel 17545: }
1.462 albertel 17546: }
1.463 albertel 17547: closedir(DIR);
1.1204 raeburn 17548: # If there is a undeleted lockfile for the user's paste buffer remove it.
17549: my $namespace = 'nohist_courseeditor';
17550: my $lockingkey = 'paste'."\0".'locked_num';
17551: my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
17552: $domain,$username);
17553: if (exists($lockhash{$lockingkey})) {
17554: my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
17555: unless ($delresult eq 'ok') {
17556: &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
17557: }
17558: }
1.462 albertel 17559: }
17560: # Give them a new cookie
1.463 albertel 17561: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 17562: : $now.$$.int(rand(10000)));
1.463 albertel 17563: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 17564:
17565: # Initialize roles
17566:
1.1062 raeburn 17567: ($userroles,$firstaccenv,$timerintenv) =
17568: &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462 albertel 17569: }
17570: # ------------------------------------ Check browser type and MathML capability
17571:
1.1194 raeburn 17572: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
17573: $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462 albertel 17574:
17575: # ------------------------------------------------------------- Get environment
17576:
17577: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
17578: my ($tmp) = keys(%userenv);
1.1275 raeburn 17579: if ($tmp =~ /^(con_lost|error|no_such_host)/i) {
1.462 albertel 17580: undef(%userenv);
17581: }
17582: if (($userenv{'interface'}) && (!$form->{'interface'})) {
17583: $form->{'interface'}=$userenv{'interface'};
17584: }
17585: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
17586:
17587: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 17588: foreach my $option ('interface','localpath','localres') {
17589: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 17590: }
17591: # --------------------------------------------------------- Write first profile
17592:
17593: {
1.1350 raeburn 17594: my $ip = &Apache::lonnet::get_requestor_ip($r);
1.462 albertel 17595: my %initial_env =
17596: ("user.name" => $username,
17597: "user.domain" => $domain,
17598: "user.home" => $authhost,
17599: "browser.type" => $clientbrowser,
17600: "browser.version" => $clientversion,
17601: "browser.mathml" => $clientmathml,
17602: "browser.unicode" => $clientunicode,
17603: "browser.os" => $clientos,
1.1137 raeburn 17604: "browser.mobile" => $clientmobile,
1.1141 raeburn 17605: "browser.info" => $clientinfo,
1.1194 raeburn 17606: "browser.osversion" => $clientosversion,
1.462 albertel 17607: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
17608: "request.course.fn" => '',
17609: "request.course.uri" => '',
17610: "request.course.sec" => '',
17611: "request.role" => 'cm',
17612: "request.role.adv" => $env{'user.adv'},
1.1350 raeburn 17613: "request.host" => $ip,);
1.462 albertel 17614:
17615: if ($form->{'localpath'}) {
17616: $initial_env{"browser.localpath"} = $form->{'localpath'};
17617: $initial_env{"browser.localres"} = $form->{'localres'};
17618: }
17619:
17620: if ($form->{'interface'}) {
17621: $form->{'interface'}=~s/\W//gs;
17622: $initial_env{"browser.interface"} = $form->{'interface'};
17623: $env{'browser.interface'}=$form->{'interface'};
17624: }
17625:
1.1157 raeburn 17626: if ($form->{'iptoken'}) {
17627: my $lonhost = $r->dir_config('lonHostID');
17628: $initial_env{"user.noloadbalance"} = $lonhost;
17629: $env{'user.noloadbalance'} = $lonhost;
17630: }
17631:
1.1268 raeburn 17632: if ($form->{'noloadbalance'}) {
17633: my @hosts = &Apache::lonnet::current_machine_ids();
17634: my $hosthere = $form->{'noloadbalance'};
17635: if (grep(/^\Q$hosthere\E$/,@hosts)) {
17636: $initial_env{"user.noloadbalance"} = $hosthere;
17637: $env{'user.noloadbalance'} = $hosthere;
17638: }
17639: }
17640:
1.1016 raeburn 17641: unless ($domain eq 'public') {
1.1273 raeburn 17642: my %is_adv = ( is_adv => $env{'user.adv'} );
17643: my %domdef = &Apache::lonnet::get_domain_defaults($domain);
17644:
1.1387 raeburn 17645: foreach my $tool ('aboutme','blog','webdav','portfolio','timezone') {
1.1273 raeburn 17646: $userenv{'availabletools.'.$tool} =
17647: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
17648: undef,\%userenv,\%domdef,\%is_adv);
17649: }
1.980 raeburn 17650:
1.1311 raeburn 17651: foreach my $crstype ('official','unofficial','community','textbook','placement','lti') {
1.1273 raeburn 17652: $userenv{'canrequest.'.$crstype} =
17653: &Apache::lonnet::usertools_access($username,$domain,$crstype,
17654: 'reload','requestcourses',
17655: \%userenv,\%domdef,\%is_adv);
17656: }
1.724 raeburn 17657:
1.1273 raeburn 17658: $userenv{'canrequest.author'} =
17659: &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
17660: 'reload','requestauthor',
1.980 raeburn 17661: \%userenv,\%domdef,\%is_adv);
1.1273 raeburn 17662: my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
17663: $domain,$username);
17664: my $reqstatus = $reqauthor{'author_status'};
17665: if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
17666: if (ref($reqauthor{'author'}) eq 'HASH') {
17667: $userenv{'requestauthorqueued'} = $reqstatus.':'.
17668: $reqauthor{'author'}{'timestamp'};
17669: }
1.1092 raeburn 17670: }
1.1287 raeburn 17671: my ($types,$typename) = &course_types();
17672: if (ref($types) eq 'ARRAY') {
17673: my @options = ('approval','validate','autolimit');
17674: my $optregex = join('|',@options);
17675: my (%willtrust,%trustchecked);
17676: foreach my $type (@{$types}) {
17677: my $dom_str = $env{'environment.reqcrsotherdom.'.$type};
17678: if ($dom_str ne '') {
17679: my $updatedstr = '';
17680: my @possdomains = split(',',$dom_str);
17681: foreach my $entry (@possdomains) {
17682: my ($extdom,$extopt) = split(':',$entry);
17683: unless ($trustchecked{$extdom}) {
17684: $willtrust{$extdom} = &Apache::lonnet::will_trust('reqcrs',$domain,$extdom);
17685: $trustchecked{$extdom} = 1;
17686: }
17687: if ($willtrust{$extdom}) {
17688: $updatedstr .= $entry.',';
17689: }
17690: }
17691: $updatedstr =~ s/,$//;
17692: if ($updatedstr) {
17693: $userenv{'reqcrsotherdom.'.$type} = $updatedstr;
17694: } else {
17695: delete($userenv{'reqcrsotherdom.'.$type});
17696: }
17697: }
17698: }
17699: }
1.1092 raeburn 17700: }
1.462 albertel 17701: $env{'user.environment'} = "$lonids/$cookie.id";
1.1062 raeburn 17702:
1.462 albertel 17703: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
17704: &GDBM_WRCREAT(),0640)) {
17705: &_add_to_env(\%disk_env,\%initial_env);
17706: &_add_to_env(\%disk_env,\%userenv,'environment.');
17707: &_add_to_env(\%disk_env,$userroles);
1.1062 raeburn 17708: if (ref($firstaccenv) eq 'HASH') {
17709: &_add_to_env(\%disk_env,$firstaccenv);
17710: }
17711: if (ref($timerintenv) eq 'HASH') {
17712: &_add_to_env(\%disk_env,$timerintenv);
17713: }
1.463 albertel 17714: if (ref($args->{'extra_env'})) {
17715: &_add_to_env(\%disk_env,$args->{'extra_env'});
17716: }
1.462 albertel 17717: untie(%disk_env);
17718: } else {
1.705 tempelho 17719: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
17720: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 17721: return 'error: '.$!;
17722: }
17723: }
17724: $env{'request.role'}='cm';
17725: $env{'request.role.adv'}=$env{'user.adv'};
17726: $env{'browser.type'}=$clientbrowser;
17727:
17728: return $cookie;
17729:
17730: }
17731:
17732: sub _add_to_env {
17733: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 17734: if (ref($env_data) eq 'HASH') {
17735: while (my ($key,$value) = each(%$env_data)) {
17736: $idf->{$prefix.$key} = $value;
17737: $env{$prefix.$key} = $value;
17738: }
1.462 albertel 17739: }
17740: }
17741:
1.685 tempelho 17742: # --- Get the symbolic name of a problem and the url
17743: sub get_symb {
17744: my ($request,$silent) = @_;
1.726 raeburn 17745: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 17746: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
17747: if ($symb eq '') {
17748: if (!$silent) {
1.1071 raeburn 17749: if (ref($request)) {
17750: $request->print("Unable to handle ambiguous references:$url:.");
17751: }
1.685 tempelho 17752: return ();
17753: }
17754: }
17755: &Apache::lonenc::check_decrypt(\$symb);
17756: return ($symb);
17757: }
17758:
17759: # --------------------------------------------------------------Get annotation
17760:
17761: sub get_annotation {
17762: my ($symb,$enc) = @_;
17763:
17764: my $key = $symb;
17765: if (!$enc) {
17766: $key =
17767: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
17768: }
17769: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
17770: return $annotation{$key};
17771: }
17772:
17773: sub clean_symb {
1.731 raeburn 17774: my ($symb,$delete_enc) = @_;
1.685 tempelho 17775:
17776: &Apache::lonenc::check_decrypt(\$symb);
17777: my $enc = $env{'request.enc'};
1.731 raeburn 17778: if ($delete_enc) {
1.730 raeburn 17779: delete($env{'request.enc'});
17780: }
1.685 tempelho 17781:
17782: return ($symb,$enc);
17783: }
1.462 albertel 17784:
1.1181 raeburn 17785: ############################################################
17786: ############################################################
17787:
17788: =pod
17789:
17790: =head1 Routines for building display used to search for courses
17791:
17792:
17793: =over 4
17794:
17795: =item * &build_filters()
17796:
17797: Create markup for a table used to set filters to use when selecting
1.1182 raeburn 17798: courses in a domain. Used by lonpickcourse.pm, lonmodifycourse.pm
17799: and quotacheck.pl
17800:
1.1181 raeburn 17801:
17802: Inputs:
17803:
17804: filterlist - anonymous array of fields to include as potential filters
17805:
17806: crstype - course type
17807:
17808: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
17809: to pop-open a course selector (will contain "extra element").
17810:
17811: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
17812:
17813: filter - anonymous hash of criteria and their values
17814:
17815: action - form action
17816:
17817: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
17818:
1.1182 raeburn 17819: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
1.1181 raeburn 17820:
17821: cloneruname - username of owner of new course who wants to clone
17822:
17823: clonerudom - domain of owner of new course who wants to clone
17824:
17825: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
17826:
17827: codetitlesref - reference to array of titles of components in institutional codes (official courses)
17828:
17829: codedom - domain
17830:
17831: formname - value of form element named "form".
17832:
17833: fixeddom - domain, if fixed.
17834:
17835: prevphase - value to assign to form element named "phase" when going back to the previous screen
17836:
17837: cnameelement - name of form element in form on opener page which will receive title of selected course
17838:
17839: cnumelement - name of form element in form on opener page which will receive courseID of selected course
17840:
17841: cdomelement - name of form element in form on opener page which will receive domain of selected course
17842:
17843: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
17844:
17845: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
17846:
17847: clonewarning - warning message about missing information for intended course owner when DC creates a course
17848:
1.1182 raeburn 17849:
1.1181 raeburn 17850: Returns: $output - HTML for display of search criteria, and hidden form elements.
17851:
1.1182 raeburn 17852:
1.1181 raeburn 17853: Side Effects: None
17854:
17855: =cut
17856:
17857: # ---------------------------------------------- search for courses based on last activity etc.
17858:
17859: sub build_filters {
17860: my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
17861: $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
17862: $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
17863: $cnameelement,$cnumelement,$cdomelement,$setroles,
17864: $clonetext,$clonewarning) = @_;
1.1182 raeburn 17865: my ($list,$jscript);
1.1181 raeburn 17866: my $onchange = 'javascript:updateFilters(this)';
17867: my ($domainselectform,$sincefilterform,$createdfilterform,
17868: $ownerdomselectform,$persondomselectform,$instcodeform,
17869: $typeselectform,$instcodetitle);
17870: if ($formname eq '') {
17871: $formname = $caller;
17872: }
17873: foreach my $item (@{$filterlist}) {
17874: unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
17875: ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
17876: if ($item eq 'domainfilter') {
17877: $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
17878: } elsif ($item eq 'coursefilter') {
17879: $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
17880: } elsif ($item eq 'ownerfilter') {
17881: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
17882: } elsif ($item eq 'ownerdomfilter') {
17883: $filter->{'ownerdomfilter'} =
17884: &LONCAPA::clean_domain($filter->{$item});
17885: $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
17886: 'ownerdomfilter',1);
17887: } elsif ($item eq 'personfilter') {
17888: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
17889: } elsif ($item eq 'persondomfilter') {
17890: $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
17891: 'persondomfilter',1);
17892: } else {
17893: $filter->{$item} =~ s/\W//g;
17894: }
17895: if (!$filter->{$item}) {
17896: $filter->{$item} = '';
17897: }
17898: }
17899: if ($item eq 'domainfilter') {
17900: my $allow_blank = 1;
17901: if ($formname eq 'portform') {
17902: $allow_blank=0;
17903: } elsif ($formname eq 'studentform') {
17904: $allow_blank=0;
17905: }
17906: if ($fixeddom) {
17907: $domainselectform = '<input type="hidden" name="domainfilter"'.
17908: ' value="'.$codedom.'" />'.
17909: &Apache::lonnet::domain($codedom,'description');
17910: } else {
17911: $domainselectform = &select_dom_form($filter->{$item},
17912: 'domainfilter',
17913: $allow_blank,'',$onchange);
17914: }
17915: } else {
17916: $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
17917: }
17918: }
17919:
17920: # last course activity filter and selection
17921: $sincefilterform = &timebased_select_form('sincefilter',$filter);
17922:
17923: # course created filter and selection
17924: if (exists($filter->{'createdfilter'})) {
17925: $createdfilterform = &timebased_select_form('createdfilter',$filter);
17926: }
17927:
1.1239 raeburn 17928: my $prefix = $crstype;
17929: if ($crstype eq 'Placement') {
17930: $prefix = 'Placement Test'
17931: }
1.1181 raeburn 17932: my %lt = &Apache::lonlocal::texthash(
1.1239 raeburn 17933: 'cac' => "$prefix Activity",
17934: 'ccr' => "$prefix Created",
17935: 'cde' => "$prefix Title",
17936: 'cdo' => "$prefix Domain",
1.1181 raeburn 17937: 'ins' => 'Institutional Code',
17938: 'inc' => 'Institutional Categorization',
1.1239 raeburn 17939: 'cow' => "$prefix Owner/Co-owner",
17940: 'cop' => "$prefix Personnel Includes",
1.1181 raeburn 17941: 'cog' => 'Type',
17942: );
17943:
17944: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
17945: my $typeval = 'Course';
17946: if ($crstype eq 'Community') {
17947: $typeval = 'Community';
1.1239 raeburn 17948: } elsif ($crstype eq 'Placement') {
17949: $typeval = 'Placement';
1.1181 raeburn 17950: }
17951: $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
17952: } else {
17953: $typeselectform = '<select name="type" size="1"';
17954: if ($onchange) {
17955: $typeselectform .= ' onchange="'.$onchange.'"';
17956: }
17957: $typeselectform .= '>'."\n";
1.1237 raeburn 17958: foreach my $posstype ('Course','Community','Placement') {
1.1239 raeburn 17959: my $shown;
17960: if ($posstype eq 'Placement') {
17961: $shown = &mt('Placement Test');
17962: } else {
17963: $shown = &mt($posstype);
17964: }
1.1181 raeburn 17965: $typeselectform.='<option value="'.$posstype.'"'.
1.1239 raeburn 17966: ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".$shown."</option>\n";
1.1181 raeburn 17967: }
17968: $typeselectform.="</select>";
17969: }
17970:
17971: my ($cloneableonlyform,$cloneabletitle);
17972: if (exists($filter->{'cloneableonly'})) {
17973: my $cloneableon = '';
17974: my $cloneableoff = ' checked="checked"';
17975: if ($filter->{'cloneableonly'}) {
17976: $cloneableon = $cloneableoff;
17977: $cloneableoff = '';
17978: }
17979: $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>';
17980: if ($formname eq 'ccrs') {
1.1187 bisitz 17981: $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1181 raeburn 17982: } else {
17983: $cloneabletitle = &mt('Cloneable by you');
17984: }
17985: }
17986: my $officialjs;
17987: if ($crstype eq 'Course') {
17988: if (exists($filter->{'instcodefilter'})) {
1.1182 raeburn 17989: # if (($fixeddom) || ($formname eq 'requestcrs') ||
17990: # ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
17991: if ($codedom) {
1.1181 raeburn 17992: $officialjs = 1;
17993: ($instcodeform,$jscript,$$numtitlesref) =
17994: &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
17995: $officialjs,$codetitlesref);
17996: if ($jscript) {
1.1182 raeburn 17997: $jscript = '<script type="text/javascript">'."\n".
17998: '// <![CDATA['."\n".
17999: $jscript."\n".
18000: '// ]]>'."\n".
18001: '</script>'."\n";
1.1181 raeburn 18002: }
18003: }
18004: if ($instcodeform eq '') {
18005: $instcodeform =
18006: '<input type="text" name="instcodefilter" size="10" value="'.
18007: $list->{'instcodefilter'}.'" />';
18008: $instcodetitle = $lt{'ins'};
18009: } else {
18010: $instcodetitle = $lt{'inc'};
18011: }
18012: if ($fixeddom) {
18013: $instcodetitle .= '<br />('.$codedom.')';
18014: }
18015: }
18016: }
18017: my $output = qq|
18018: <form method="post" name="filterpicker" action="$action">
18019: <input type="hidden" name="form" value="$formname" />
18020: |;
18021: if ($formname eq 'modifycourse') {
18022: $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
18023: '<input type="hidden" name="prevphase" value="'.
18024: $prevphase.'" />'."\n";
1.1198 musolffc 18025: } elsif ($formname eq 'quotacheck') {
18026: $output .= qq|
18027: <input type="hidden" name="sortby" value="" />
18028: <input type="hidden" name="sortorder" value="" />
18029: |;
18030: } else {
1.1181 raeburn 18031: my $name_input;
18032: if ($cnameelement ne '') {
18033: $name_input = '<input type="hidden" name="cnameelement" value="'.
18034: $cnameelement.'" />';
18035: }
18036: $output .= qq|
1.1182 raeburn 18037: <input type="hidden" name="cnumelement" value="$cnumelement" />
18038: <input type="hidden" name="cdomelement" value="$cdomelement" />
1.1181 raeburn 18039: $name_input
18040: $roleelement
18041: $multelement
18042: $typeelement
18043: |;
18044: if ($formname eq 'portform') {
18045: $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
18046: }
18047: }
18048: if ($fixeddom) {
18049: $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
18050: }
18051: $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
18052: if ($sincefilterform) {
18053: $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
18054: .$sincefilterform
18055: .&Apache::lonhtmlcommon::row_closure();
18056: }
18057: if ($createdfilterform) {
18058: $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
18059: .$createdfilterform
18060: .&Apache::lonhtmlcommon::row_closure();
18061: }
18062: if ($domainselectform) {
18063: $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
18064: .$domainselectform
18065: .&Apache::lonhtmlcommon::row_closure();
18066: }
18067: if ($typeselectform) {
18068: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
18069: $output .= $typeselectform;
18070: } else {
18071: $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
18072: .$typeselectform
18073: .&Apache::lonhtmlcommon::row_closure();
18074: }
18075: }
18076: if ($instcodeform) {
18077: $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
18078: .$instcodeform
18079: .&Apache::lonhtmlcommon::row_closure();
18080: }
18081: if (exists($filter->{'ownerfilter'})) {
18082: $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
18083: '<table><tr><td>'.&mt('Username').'<br />'.
18084: '<input type="text" name="ownerfilter" size="20" value="'.
18085: $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
18086: $ownerdomselectform.'</td></tr></table>'.
18087: &Apache::lonhtmlcommon::row_closure();
18088: }
18089: if (exists($filter->{'personfilter'})) {
18090: $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
18091: '<table><tr><td>'.&mt('Username').'<br />'.
18092: '<input type="text" name="personfilter" size="20" value="'.
18093: $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
18094: $persondomselectform.'</td></tr></table>'.
18095: &Apache::lonhtmlcommon::row_closure();
18096: }
18097: if (exists($filter->{'coursefilter'})) {
18098: $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
18099: .'<input type="text" name="coursefilter" size="25" value="'
18100: .$list->{'coursefilter'}.'" />'
18101: .&Apache::lonhtmlcommon::row_closure();
18102: }
18103: if ($cloneableonlyform) {
18104: $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
18105: $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
18106: }
18107: if (exists($filter->{'descriptfilter'})) {
18108: $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
18109: .'<input type="text" name="descriptfilter" size="40" value="'
18110: .$list->{'descriptfilter'}.'" />'
18111: .&Apache::lonhtmlcommon::row_closure(1);
18112: }
18113: $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
18114: '<input type="hidden" name="updater" value="" />'."\n".
18115: '<input type="submit" name="gosearch" value="'.
18116: &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
18117: return $jscript.$clonewarning.$output;
18118: }
18119:
18120: =pod
18121:
18122: =item * &timebased_select_form()
18123:
1.1182 raeburn 18124: Create markup for a dropdown list used to select a time-based
1.1181 raeburn 18125: filter e.g., Course Activity, Course Created, when searching for courses
18126: or communities
18127:
18128: Inputs:
18129:
18130: item - name of form element (sincefilter or createdfilter)
18131:
18132: filter - anonymous hash of criteria and their values
18133:
18134: Returns: HTML for a select box contained a blank, then six time selections,
18135: with value set in incoming form variables currently selected.
18136:
18137: Side Effects: None
18138:
18139: =cut
18140:
18141: sub timebased_select_form {
18142: my ($item,$filter) = @_;
18143: if (ref($filter) eq 'HASH') {
18144: $filter->{$item} =~ s/[^\d-]//g;
18145: if (!$filter->{$item}) { $filter->{$item}=-1; }
18146: return &select_form(
18147: $filter->{$item},
18148: $item,
18149: { '-1' => '',
18150: '86400' => &mt('today'),
18151: '604800' => &mt('last week'),
18152: '2592000' => &mt('last month'),
18153: '7776000' => &mt('last three months'),
18154: '15552000' => &mt('last six months'),
18155: '31104000' => &mt('last year'),
18156: 'select_form_order' =>
18157: ['-1','86400','604800','2592000','7776000',
18158: '15552000','31104000']});
18159: }
18160: }
18161:
18162: =pod
18163:
18164: =item * &js_changer()
18165:
18166: Create script tag containing Javascript used to submit course search form
1.1183 raeburn 18167: when course type or domain is changed, and also to hide 'Searching ...' on
18168: page load completion for page showing search result.
1.1181 raeburn 18169:
18170: Inputs: None
18171:
1.1183 raeburn 18172: Returns: markup containing updateFilters() and hideSearching() javascript functions.
1.1181 raeburn 18173:
18174: Side Effects: None
18175:
18176: =cut
18177:
18178: sub js_changer {
18179: return <<ENDJS;
18180: <script type="text/javascript">
18181: // <![CDATA[
18182: function updateFilters(caller) {
18183: if (typeof(caller) != "undefined") {
18184: document.filterpicker.updater.value = caller.name;
18185: }
18186: document.filterpicker.submit();
18187: }
1.1183 raeburn 18188:
18189: function hideSearching() {
18190: if (document.getElementById('searching')) {
18191: document.getElementById('searching').style.display = 'none';
18192: }
18193: return;
18194: }
18195:
1.1181 raeburn 18196: // ]]>
18197: </script>
18198:
18199: ENDJS
18200: }
18201:
18202: =pod
18203:
1.1182 raeburn 18204: =item * &search_courses()
18205:
18206: Process selected filters form course search form and pass to lonnet::courseiddump
18207: to retrieve a hash for which keys are courseIDs which match the selected filters.
18208:
18209: Inputs:
18210:
18211: dom - domain being searched
18212:
18213: type - course type ('Course' or 'Community' or '.' if any).
18214:
18215: filter - anonymous hash of criteria and their values
18216:
18217: numtitles - for institutional codes - number of categories
18218:
18219: cloneruname - optional username of new course owner
18220:
18221: clonerudom - optional domain of new course owner
18222:
1.1221 raeburn 18223: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
1.1182 raeburn 18224: (used when DC is using course creation form)
18225:
18226: codetitles - reference to array of titles of components in institutional codes (official courses).
18227:
1.1221 raeburn 18228: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
18229: (and so can clone automatically)
18230:
18231: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
18232:
18233: reqinstcode - institutional code of new course, where search_courses is used to identify potential
18234: courses to clone
1.1182 raeburn 18235:
18236: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
18237:
18238:
18239: Side Effects: None
18240:
18241: =cut
18242:
18243:
18244: sub search_courses {
1.1221 raeburn 18245: my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
18246: $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1182 raeburn 18247: my (%courses,%showcourses,$cloner);
18248: if (($filter->{'ownerfilter'} ne '') ||
18249: ($filter->{'ownerdomfilter'} ne '')) {
18250: $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
18251: $filter->{'ownerdomfilter'};
18252: }
18253: foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
18254: if (!$filter->{$item}) {
18255: $filter->{$item}='.';
18256: }
18257: }
18258: my $now = time;
18259: my $timefilter =
18260: ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
18261: my ($createdbefore,$createdafter);
18262: if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
18263: $createdbefore = $now;
18264: $createdafter = $now-$filter->{'createdfilter'};
18265: }
18266: my ($instcodefilter,$regexpok);
18267: if ($numtitles) {
18268: if ($env{'form.official'} eq 'on') {
18269: $instcodefilter =
18270: &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
18271: $regexpok = 1;
18272: } elsif ($env{'form.official'} eq 'off') {
18273: $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
18274: unless ($instcodefilter eq '') {
18275: $regexpok = -1;
18276: }
18277: }
18278: } else {
18279: $instcodefilter = $filter->{'instcodefilter'};
18280: }
18281: if ($instcodefilter eq '') { $instcodefilter = '.'; }
18282: if ($type eq '') { $type = '.'; }
18283:
18284: if (($clonerudom ne '') && ($cloneruname ne '')) {
18285: $cloner = $cloneruname.':'.$clonerudom;
18286: }
18287: %courses = &Apache::lonnet::courseiddump($dom,
18288: $filter->{'descriptfilter'},
18289: $timefilter,
18290: $instcodefilter,
18291: $filter->{'combownerfilter'},
18292: $filter->{'coursefilter'},
18293: undef,undef,$type,$regexpok,undef,undef,
1.1221 raeburn 18294: undef,undef,$cloner,$cc_clone,
1.1182 raeburn 18295: $filter->{'cloneableonly'},
18296: $createdbefore,$createdafter,undef,
1.1221 raeburn 18297: $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1182 raeburn 18298: if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
18299: my $ccrole;
18300: if ($type eq 'Community') {
18301: $ccrole = 'co';
18302: } else {
18303: $ccrole = 'cc';
18304: }
18305: my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
18306: $filter->{'persondomfilter'},
18307: 'userroles',undef,
18308: [$ccrole,'in','ad','ep','ta','cr'],
18309: $dom);
18310: foreach my $role (keys(%rolehash)) {
18311: my ($cnum,$cdom,$courserole) = split(':',$role);
18312: my $cid = $cdom.'_'.$cnum;
18313: if (exists($courses{$cid})) {
18314: if (ref($courses{$cid}) eq 'HASH') {
18315: if (ref($courses{$cid}{roles}) eq 'ARRAY') {
18316: if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1263 raeburn 18317: push(@{$courses{$cid}{roles}},$courserole);
1.1182 raeburn 18318: }
18319: } else {
18320: $courses{$cid}{roles} = [$courserole];
18321: }
18322: $showcourses{$cid} = $courses{$cid};
18323: }
18324: }
18325: }
18326: %courses = %showcourses;
18327: }
18328: return %courses;
18329: }
18330:
18331: =pod
18332:
1.1181 raeburn 18333: =back
18334:
1.1207 raeburn 18335: =head1 Routines for version requirements for current course.
18336:
18337: =over 4
18338:
18339: =item * &check_release_required()
18340:
18341: Compares required LON-CAPA version with version on server, and
18342: if required version is newer looks for a server with the required version.
18343:
18344: Looks first at servers in user's owen domain; if none suitable, looks at
18345: servers in course's domain are permitted to host sessions for user's domain.
18346:
18347: Inputs:
18348:
18349: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
18350:
18351: $courseid - Course ID of current course
18352:
18353: $rolecode - User's current role in course (for switchserver query string).
18354:
18355: $required - LON-CAPA version needed by course (format: Major.Minor).
18356:
18357:
18358: Returns:
18359:
18360: $switchserver - query string tp append to /adm/switchserver call (if
18361: current server's LON-CAPA version is too old.
18362:
18363: $warning - Message is displayed if no suitable server could be found.
18364:
18365: =cut
18366:
18367: sub check_release_required {
18368: my ($loncaparev,$courseid,$rolecode,$required) = @_;
18369: my ($switchserver,$warning);
18370: if ($required ne '') {
18371: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
18372: my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
18373: if ($reqdmajor ne '' && $reqdminor ne '') {
18374: my $otherserver;
18375: if (($major eq '' && $minor eq '') ||
18376: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
18377: my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
18378: my $switchlcrev =
18379: &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
18380: $userdomserver);
18381: my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
18382: if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
18383: (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
18384: my $cdom = $env{'course.'.$courseid.'.domain'};
18385: if ($cdom ne $env{'user.domain'}) {
18386: my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
18387: my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
18388: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
18389: my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
18390: my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
18391: my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
18392: my $canhost =
18393: &Apache::lonnet::can_host_session($env{'user.domain'},
18394: $coursedomserver,
18395: $remoterev,
18396: $udomdefaults{'remotesessions'},
18397: $defdomdefaults{'hostedsessions'});
18398:
18399: if ($canhost) {
18400: $otherserver = $coursedomserver;
18401: } else {
18402: $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.");
18403: }
18404: } else {
18405: $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).");
18406: }
18407: } else {
18408: $otherserver = $userdomserver;
18409: }
18410: }
18411: if ($otherserver ne '') {
18412: $switchserver = 'otherserver='.$otherserver.'&role='.$rolecode;
18413: }
18414: }
18415: }
18416: return ($switchserver,$warning);
18417: }
18418:
18419: =pod
18420:
18421: =item * &check_release_result()
18422:
18423: Inputs:
18424:
18425: $switchwarning - Warning message if no suitable server found to host session.
18426:
18427: $switchserver - query string to append to /adm/switchserver containing lonHostID
18428: and current role.
18429:
18430: Returns: HTML to display with information about requirement to switch server.
18431: Either displaying warning with link to Roles/Courses screen or
18432: display link to switchserver.
18433:
1.1181 raeburn 18434: =cut
18435:
1.1207 raeburn 18436: sub check_release_result {
18437: my ($switchwarning,$switchserver) = @_;
18438: my $output = &start_page('Selected course unavailable on this server').
18439: '<p class="LC_warning">';
18440: if ($switchwarning) {
18441: $output .= $switchwarning.'<br /><a href="/adm/roles">';
18442: if (&show_course()) {
18443: $output .= &mt('Display courses');
18444: } else {
18445: $output .= &mt('Display roles');
18446: }
18447: $output .= '</a>';
18448: } elsif ($switchserver) {
18449: $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
18450: '<br />'.
18451: '<a href="/adm/switchserver?'.$switchserver.'">'.
18452: &mt('Switch Server').
18453: '</a>';
18454: }
18455: $output .= '</p>'.&end_page();
18456: return $output;
18457: }
18458:
18459: =pod
18460:
18461: =item * &needs_coursereinit()
18462:
18463: Determine if course contents stored for user's session needs to be
18464: refreshed, because content has changed since "Big Hash" last tied.
18465:
18466: Check for change is made if time last checked is more than 10 minutes ago
18467: (by default).
18468:
18469: Inputs:
18470:
18471: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
18472:
18473: $interval (optional) - Time which may elapse (in s) between last check for content
18474: change in current course. (default: 600 s).
18475:
18476: Returns: an array; first element is:
18477:
18478: =over 4
18479:
18480: 'switch' - if content updates mean user's session
18481: needs to be switched to a server running a newer LON-CAPA version
18482:
18483: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
18484: on current server hosting user's session
18485:
18486: '' - if no action required.
18487:
18488: =back
18489:
18490: If first item element is 'switch':
18491:
18492: second item is $switchwarning - Warning message if no suitable server found to host session.
18493:
18494: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
18495: and current role.
18496:
18497: otherwise: no other elements returned.
18498:
18499: =back
18500:
18501: =cut
18502:
18503: sub needs_coursereinit {
18504: my ($loncaparev,$interval) = @_;
18505: return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
18506: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
18507: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
18508: my $now = time;
18509: if ($interval eq '') {
18510: $interval = 600;
18511: }
18512: if (($now-$env{'request.course.timechecked'})>$interval) {
1.1282 raeburn 18513: &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
1.1372 raeburn 18514: my $blocked = &blocking_status('reinit',undef,$cnum,$cdom,undef,1);
1.1282 raeburn 18515: if ($blocked) {
18516: return ();
18517: }
1.1391 raeburn 18518: my $update;
18519: my $lastmainchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
18520: my $lastsuppchange = &Apache::lonnet::get_suppchange($cdom,$cnum);
18521: if ($lastmainchange > $env{'request.course.tied'}) {
18522: my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
18523: if ($needswitch) {
18524: return ('switch',$switchwarning,$switchserver);
18525: }
18526: $update = 'main';
18527: }
18528: if ($lastsuppchange > $env{'request.course.suppupdated'}) {
18529: if ($update) {
18530: $update = 'both';
18531: } else {
18532: my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
18533: if ($needswitch) {
18534: return ('switch',$switchwarning,$switchserver);
18535: } else {
18536: $update = 'supp';
1.1207 raeburn 18537: }
18538: }
1.1391 raeburn 18539: return ($update);
18540: }
18541: }
18542: return ();
18543: }
18544:
18545: sub switch_for_update {
18546: my ($loncaparev,$cdom,$cnum) = @_;
18547: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
18548: if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
18549: my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
18550: if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
18551: &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
18552: $curr_reqd_hash{'internal.releaserequired'}});
18553: my ($switchserver,$switchwarning) =
18554: &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
18555: $curr_reqd_hash{'internal.releaserequired'});
18556: if ($switchwarning ne '' || $switchserver ne '') {
18557: return ('switch',$switchwarning,$switchserver);
18558: }
1.1207 raeburn 18559: }
18560: }
18561: return ();
18562: }
1.1181 raeburn 18563:
1.1083 raeburn 18564: sub update_content_constraints {
1.1395 raeburn 18565: my ($cdom,$cnum,$chome,$cid) = @_;
1.1083 raeburn 18566: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
18567: my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
1.1307 raeburn 18568: my (%checkresponsetypes,%checkcrsrestypes);
1.1083 raeburn 18569: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
1.1236 raeburn 18570: my ($item,$name,$value) = split(/:/,$key);
1.1083 raeburn 18571: if ($item eq 'resourcetag') {
18572: if ($name eq 'responsetype') {
18573: $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
18574: }
1.1307 raeburn 18575: } elsif ($item eq 'course') {
18576: if ($name eq 'courserestype') {
18577: $checkcrsrestypes{$value} = $Apache::lonnet::needsrelease{$key};
18578: }
1.1083 raeburn 18579: }
18580: }
18581: my $navmap = Apache::lonnavmaps::navmap->new();
18582: if (defined($navmap)) {
1.1307 raeburn 18583: my (%allresponses,%allcrsrestypes);
18584: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() || $_[0]->is_tool() },1,0)) {
18585: if ($res->is_tool()) {
18586: if ($allcrsrestypes{'exttool'}) {
18587: $allcrsrestypes{'exttool'} ++;
18588: } else {
18589: $allcrsrestypes{'exttool'} = 1;
18590: }
18591: next;
18592: }
1.1083 raeburn 18593: my %responses = $res->responseTypes();
18594: foreach my $key (keys(%responses)) {
18595: next unless(exists($checkresponsetypes{$key}));
18596: $allresponses{$key} += $responses{$key};
18597: }
18598: }
18599: foreach my $key (keys(%allresponses)) {
18600: my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
18601: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
18602: ($reqdmajor,$reqdminor) = ($major,$minor);
18603: }
18604: }
1.1307 raeburn 18605: foreach my $key (keys(%allcrsrestypes)) {
1.1308 raeburn 18606: my ($major,$minor) = split(/\./,$checkcrsrestypes{$key});
1.1307 raeburn 18607: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
18608: ($reqdmajor,$reqdminor) = ($major,$minor);
18609: }
18610: }
1.1083 raeburn 18611: undef($navmap);
18612: }
1.1391 raeburn 18613: if (&Apache::lonnet::count_supptools($cnum,$cdom,1)) {
1.1308 raeburn 18614: my ($major,$minor) = split(/\./,$checkcrsrestypes{'exttool'});
18615: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
18616: ($reqdmajor,$reqdminor) = ($major,$minor);
18617: }
18618: }
1.1083 raeburn 18619: unless (($reqdmajor eq '') && ($reqdminor eq '')) {
18620: &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
18621: }
18622: return;
18623: }
18624:
1.1110 raeburn 18625: sub allmaps_incourse {
18626: my ($cdom,$cnum,$chome,$cid) = @_;
18627: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
18628: $cid = $env{'request.course.id'};
18629: $cdom = $env{'course.'.$cid.'.domain'};
18630: $cnum = $env{'course.'.$cid.'.num'};
18631: $chome = $env{'course.'.$cid.'.home'};
18632: }
18633: my %allmaps = ();
18634: my $lastchange =
18635: &Apache::lonnet::get_coursechange($cdom,$cnum);
18636: if ($lastchange > $env{'request.course.tied'}) {
18637: my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
18638: unless ($ferr) {
1.1395 raeburn 18639: &update_content_constraints($cdom,$cnum,$chome,$cid);
1.1110 raeburn 18640: }
18641: }
18642: my $navmap = Apache::lonnavmaps::navmap->new();
18643: if (defined($navmap)) {
18644: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
18645: $allmaps{$res->src()} = 1;
18646: }
18647: }
18648: return \%allmaps;
18649: }
18650:
1.1083 raeburn 18651: sub parse_supplemental_title {
18652: my ($title) = @_;
18653:
18654: my ($foldertitle,$renametitle);
18655: if ($title =~ /&&&/) {
18656: $title = &HTML::Entites::decode($title);
18657: }
18658: if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
18659: $renametitle=$4;
18660: my ($time,$uname,$udom) = ($1,$2,$3);
18661: $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
18662: my $name = &plainname($uname,$udom);
18663: $name = &HTML::Entities::encode($name,'"<>&\'');
18664: $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
1.1401 raeburn 18665: $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.$name;
1.1402 raeburn 18666: if ($foldertitle ne '') {
1.1401 raeburn 18667: $title .= ': <br />'.$foldertitle;
18668: }
1.1083 raeburn 18669: }
18670: if (wantarray) {
18671: return ($title,$foldertitle,$renametitle);
18672: }
18673: return $title;
18674: }
18675:
1.1395 raeburn 18676: sub get_supplemental {
18677: my ($cnum,$cdom,$ignorecache,$possdel)=@_;
18678: my $hashid=$cnum.':'.$cdom;
18679: my ($supplemental,$cached,$set_httprefs);
18680: unless ($ignorecache) {
18681: ($supplemental,$cached) = &Apache::lonnet::is_cached_new('supplemental',$hashid);
18682: }
18683: unless (defined($cached)) {
18684: my $chome=&Apache::lonnet::homeserver($cnum,$cdom);
18685: unless ($chome eq 'no_host') {
18686: my @order = @LONCAPA::map::order;
18687: my @resources = @LONCAPA::map::resources;
18688: my @resparms = @LONCAPA::map::resparms;
18689: my @zombies = @LONCAPA::map::zombies;
18690: my ($errors,%ids,%hidden);
18691: $errors =
18692: &recurse_supplemental($cnum,$cdom,'supplemental.sequence',
18693: $errors,$possdel,\%ids,\%hidden);
18694: @LONCAPA::map::order = @order;
18695: @LONCAPA::map::resources = @resources;
18696: @LONCAPA::map::resparms = @resparms;
18697: @LONCAPA::map::zombies = @zombies;
18698: $set_httprefs = 1;
18699: if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
18700: &Apache::lonnet::appenv({'request.course.suppupdated' => time});
18701: }
18702: $supplemental = {
18703: ids => \%ids,
18704: hidden => \%hidden,
18705: };
18706: &Apache::lonnet::do_cache_new('supplemental',$hashid,$supplemental,600);
18707: }
18708: }
18709: return ($supplemental,$set_httprefs);
18710: }
18711:
1.1143 raeburn 18712: sub recurse_supplemental {
1.1391 raeburn 18713: my ($cnum,$cdom,$suppmap,$errors,$possdel,$suppids,$hiddensupp,$hidden) = @_;
18714: if (($suppmap) && (ref($suppids) eq 'HASH') && (ref($hiddensupp) eq 'HASH')) {
18715: my $mapnum;
18716: if ($suppmap eq 'supplemental.sequence') {
18717: $mapnum = 0;
18718: } else {
18719: ($mapnum) = ($suppmap =~ /^supplemental_(\d+)\.sequence$/);
18720: }
1.1143 raeburn 18721: my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
18722: if ($fatal) {
18723: $errors ++;
18724: } else {
1.1389 raeburn 18725: my @order = @LONCAPA::map::order;
18726: if (@order > 0) {
18727: my @resources = @LONCAPA::map::resources;
1.1391 raeburn 18728: my @resparms = @LONCAPA::map::resparms;
1.1389 raeburn 18729: foreach my $idx (@order) {
18730: my ($title,$src,$ext,$type,$status)=split(/\:/,$resources[$idx]);
1.1143 raeburn 18731: if (($src ne '') && ($status eq 'res')) {
1.1391 raeburn 18732: my $id = $mapnum.':'.$idx;
18733: push(@{$suppids->{$src}},$id);
18734: if (($hidden) || (&get_supp_parameter($resparms[$idx],'parameter_hiddenresource') =~ /^yes/i)) {
18735: $hiddensupp->{$id} = 1;
18736: }
1.1146 raeburn 18737: if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
1.1391 raeburn 18738: $errors = &recurse_supplemental($cnum,$cdom,$1,$errors,$possdel,$suppids,
18739: $hiddensupp,$hiddensupp->{$id});
1.1143 raeburn 18740: } else {
1.1391 raeburn 18741: my $allowed;
18742: if (($env{'request.role.adv'}) || (!$hiddensupp->{$id})) {
18743: $allowed = 1;
18744: } elsif ($possdel) {
18745: foreach my $item (@{$suppids->{$src}}) {
18746: next if ($item eq $id);
18747: unless ($hiddensupp->{$item}) {
18748: $allowed = 1;
18749: last;
18750: }
18751: }
18752: if ((!$allowed) && (exists($env{'httpref.'.$src}))) {
18753: &Apache::lonnet::delenv('httpref.'.$src);
18754: }
18755: }
18756: if ($allowed && (!exists($env{'httpref.'.$src}))) {
18757: &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
1.1308 raeburn 18758: }
1.1143 raeburn 18759: }
18760: }
18761: }
18762: }
18763: }
18764: }
1.1391 raeburn 18765: return $errors;
18766: }
18767:
18768: sub set_supp_httprefs {
18769: my ($cnum,$cdom,$supplemental,$possdel) = @_;
18770: if (ref($supplemental) eq 'HASH') {
18771: if ((ref($supplemental->{'ids'}) eq 'HASH') && (ref($supplemental->{'hidden'}) eq 'HASH')) {
18772: foreach my $src (keys(%{$supplemental->{'ids'}})) {
18773: next if ($src =~ /\.sequence$/);
18774: if (ref($supplemental->{'ids'}->{$src}) eq 'ARRAY') {
18775: my $allowed;
18776: if ($env{'request.role.adv'}) {
18777: $allowed = 1;
18778: } else {
18779: foreach my $id (@{$supplemental->{'ids'}->{$src}}) {
18780: unless ($supplemental->{'hidden'}->{$id}) {
18781: $allowed = 1;
18782: last;
18783: }
18784: }
18785: }
18786: if (exists($env{'httpref.'.$src})) {
18787: if ($possdel) {
18788: unless ($allowed) {
18789: &Apache::lonnet::delenv('httpref.'.$src);
18790: }
18791: }
18792: } elsif ($allowed) {
18793: &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
18794: }
18795: }
18796: }
18797: if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
18798: &Apache::lonnet::appenv({'request.course.suppupdated' => time});
18799: }
18800: }
18801: }
18802: }
18803:
18804: sub get_supp_parameter {
18805: my ($resparm,$name)=@_;
18806: return if ($resparm eq '');
18807: my $value=undef;
18808: my $ptype=undef;
18809: foreach (split('&&&',$resparm)) {
18810: my ($thistype,$thisname,$thisvalue)=split('___',$_);
18811: if ($thisname eq $name) {
18812: $value=$thisvalue;
18813: $ptype=$thistype;
18814: }
18815: }
18816: return $value;
1.1143 raeburn 18817: }
18818:
1.1101 raeburn 18819: sub symb_to_docspath {
1.1267 raeburn 18820: my ($symb,$navmapref) = @_;
18821: return unless ($symb && ref($navmapref));
1.1101 raeburn 18822: my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
18823: if ($resurl=~/\.(sequence|page)$/) {
18824: $mapurl=$resurl;
18825: } elsif ($resurl eq 'adm/navmaps') {
18826: $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
18827: }
18828: my $mapresobj;
1.1267 raeburn 18829: unless (ref($$navmapref)) {
18830: $$navmapref = Apache::lonnavmaps::navmap->new();
18831: }
18832: if (ref($$navmapref)) {
18833: $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1101 raeburn 18834: }
18835: $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
18836: my $type=$2;
18837: my $path;
18838: if (ref($mapresobj)) {
18839: my $pcslist = $mapresobj->map_hierarchy();
18840: if ($pcslist ne '') {
18841: foreach my $pc (split(/,/,$pcslist)) {
18842: next if ($pc <= 1);
1.1267 raeburn 18843: my $res = $$navmapref->getByMapPc($pc);
1.1101 raeburn 18844: if (ref($res)) {
18845: my $thisurl = $res->src();
18846: $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
18847: my $thistitle = $res->title();
18848: $path .= '&'.
18849: &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1146 raeburn 18850: &escape($thistitle).
1.1101 raeburn 18851: ':'.$res->randompick().
18852: ':'.$res->randomout().
18853: ':'.$res->encrypted().
18854: ':'.$res->randomorder().
18855: ':'.$res->is_page();
18856: }
18857: }
18858: }
18859: $path =~ s/^\&//;
18860: my $maptitle = $mapresobj->title();
18861: if ($mapurl eq 'default') {
1.1129 raeburn 18862: $maptitle = 'Main Content';
1.1101 raeburn 18863: }
18864: $path .= (($path ne '')? '&' : '').
18865: &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 18866: &escape($maptitle).
1.1101 raeburn 18867: ':'.$mapresobj->randompick().
18868: ':'.$mapresobj->randomout().
18869: ':'.$mapresobj->encrypted().
18870: ':'.$mapresobj->randomorder().
18871: ':'.$mapresobj->is_page();
18872: } else {
18873: my $maptitle = &Apache::lonnet::gettitle($mapurl);
18874: my $ispage = (($type eq 'page')? 1 : '');
18875: if ($mapurl eq 'default') {
1.1129 raeburn 18876: $maptitle = 'Main Content';
1.1101 raeburn 18877: }
18878: $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 18879: &escape($maptitle).':::::'.$ispage;
1.1101 raeburn 18880: }
18881: unless ($mapurl eq 'default') {
18882: $path = 'default&'.
1.1146 raeburn 18883: &escape('Main Content').
1.1101 raeburn 18884: ':::::&'.$path;
18885: }
18886: return $path;
18887: }
18888:
1.1393 raeburn 18889: sub validate_folderpath {
18890: my ($supplementalflag,$allowed,$coursenum,$coursedom) = @_;
18891: if ($env{'form.folderpath'} ne '') {
18892: my @items = split(/\&/,$env{'form.folderpath'});
1.1394 raeburn 18893: my ($badpath,$changed,$got_supp,$supppath,%supphidden,%suppids);
1.1393 raeburn 18894: for (my $i=0; $i<@items; $i++) {
18895: my $odd = $i%2;
18896: if (($odd) && (!$supplementalflag) && ($items[$i] !~ /^[^:]*:(|\d+):(|1):(|1):(|1):(|1)$/)) {
18897: $badpath = 1;
1.1394 raeburn 18898: } elsif ($odd && $supplementalflag) {
1.1393 raeburn 18899: my $idx = $i-1;
1.1394 raeburn 18900: if ($items[$i] =~ /^([^:]*)::(|1):::$/) {
18901: my $esc_name = $1;
18902: if ((!$allowed) || ($items[$idx] eq 'supplemental')) {
18903: $supppath .= '&'.$esc_name;
18904: $changed = 1;
18905: } else {
18906: $supppath .= '&'.$items[$i];
18907: }
18908: } elsif (($allowed) && ($items[$idx] ne 'supplemental')) {
18909: $changed = 1;
1.1393 raeburn 18910: my $is_hidden;
18911: unless ($got_supp) {
1.1395 raeburn 18912: my ($supplemental) = &get_supplemental($coursenum,$coursedom);
1.1393 raeburn 18913: if (ref($supplemental) eq 'HASH') {
18914: if (ref($supplemental->{'hidden'}) eq 'HASH') {
18915: %supphidden = %{$supplemental->{'hidden'}};
18916: }
18917: if (ref($supplemental->{'ids'}) eq 'HASH') {
18918: %suppids = %{$supplemental->{'ids'}};
18919: }
18920: }
18921: $got_supp = 1;
18922: }
18923: if (ref($suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}) eq 'ARRAY') {
18924: my $mapid = $suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}->[0];
18925: if ($supphidden{$mapid}) {
18926: $is_hidden = 1;
18927: }
18928: }
1.1394 raeburn 18929: $supppath .= '&'.$items[$i].'::'.$is_hidden.':::';
18930: } else {
18931: $supppath .= '&'.$items[$i];
1.1393 raeburn 18932: }
18933: } elsif ((!$odd) && ($items[$i] !~ /^(default|supplemental)(|_\d+)$/)) {
18934: $badpath = 1;
1.1394 raeburn 18935: } elsif ($supplementalflag) {
1.1393 raeburn 18936: $supppath .= '&'.$items[$i];
18937: }
18938: last if ($badpath);
18939: }
18940: if ($badpath) {
18941: delete($env{'form.folderpath'});
1.1394 raeburn 18942: } elsif ($changed && $supplementalflag) {
1.1393 raeburn 18943: $supppath =~ s/^\&//;
18944: $env{'form.folderpath'} = $supppath;
18945: }
18946: }
18947: return;
18948: }
18949:
1.1094 raeburn 18950: sub captcha_display {
1.1327 raeburn 18951: my ($context,$lonhost,$defdom) = @_;
1.1094 raeburn 18952: my ($output,$error);
1.1234 raeburn 18953: my ($captcha,$pubkey,$privkey,$version) =
1.1327 raeburn 18954: &get_captcha_config($context,$lonhost,$defdom);
1.1095 raeburn 18955: if ($captcha eq 'original') {
1.1094 raeburn 18956: $output = &create_captcha();
18957: unless ($output) {
1.1172 raeburn 18958: $error = 'captcha';
1.1094 raeburn 18959: }
18960: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 18961: $output = &create_recaptcha($pubkey,$version);
1.1094 raeburn 18962: unless ($output) {
1.1172 raeburn 18963: $error = 'recaptcha';
1.1094 raeburn 18964: }
18965: }
1.1234 raeburn 18966: return ($output,$error,$captcha,$version);
1.1094 raeburn 18967: }
18968:
18969: sub captcha_response {
1.1327 raeburn 18970: my ($context,$lonhost,$defdom) = @_;
1.1094 raeburn 18971: my ($captcha_chk,$captcha_error);
1.1327 raeburn 18972: my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1095 raeburn 18973: if ($captcha eq 'original') {
1.1094 raeburn 18974: ($captcha_chk,$captcha_error) = &check_captcha();
18975: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 18976: $captcha_chk = &check_recaptcha($privkey,$version);
1.1094 raeburn 18977: } else {
18978: $captcha_chk = 1;
18979: }
18980: return ($captcha_chk,$captcha_error);
18981: }
18982:
18983: sub get_captcha_config {
1.1327 raeburn 18984: my ($context,$lonhost,$dom_in_effect) = @_;
1.1234 raeburn 18985: my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1094 raeburn 18986: my $hostname = &Apache::lonnet::hostname($lonhost);
18987: my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
18988: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1.1095 raeburn 18989: if ($context eq 'usercreation') {
18990: my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
18991: if (ref($domconfig{$context}) eq 'HASH') {
18992: $hashtocheck = $domconfig{$context}{'cancreate'};
18993: if (ref($hashtocheck) eq 'HASH') {
18994: if ($hashtocheck->{'captcha'} eq 'recaptcha') {
18995: if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
18996: $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
18997: $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
18998: }
18999: if ($privkey && $pubkey) {
19000: $captcha = 'recaptcha';
1.1234 raeburn 19001: $version = $hashtocheck->{'recaptchaversion'};
19002: if ($version ne '2') {
19003: $version = 1;
19004: }
1.1095 raeburn 19005: } else {
19006: $captcha = 'original';
19007: }
19008: } elsif ($hashtocheck->{'captcha'} ne 'notused') {
19009: $captcha = 'original';
19010: }
1.1094 raeburn 19011: }
1.1095 raeburn 19012: } else {
19013: $captcha = 'captcha';
19014: }
19015: } elsif ($context eq 'login') {
19016: my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
19017: if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
19018: $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
19019: $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
1.1094 raeburn 19020: if ($privkey && $pubkey) {
19021: $captcha = 'recaptcha';
1.1234 raeburn 19022: $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
19023: if ($version ne '2') {
19024: $version = 1;
19025: }
1.1095 raeburn 19026: } else {
19027: $captcha = 'original';
1.1094 raeburn 19028: }
1.1095 raeburn 19029: } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
19030: $captcha = 'original';
1.1094 raeburn 19031: }
1.1327 raeburn 19032: } elsif ($context eq 'passwords') {
19033: if ($dom_in_effect) {
19034: my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
19035: if ($passwdconf{'captcha'} eq 'recaptcha') {
19036: if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
19037: $pubkey = $passwdconf{'recaptchakeys'}{'public'};
19038: $privkey = $passwdconf{'recaptchakeys'}{'private'};
19039: }
19040: if ($privkey && $pubkey) {
19041: $captcha = 'recaptcha';
19042: $version = $passwdconf{'recaptchaversion'};
19043: if ($version ne '2') {
19044: $version = 1;
19045: }
19046: } else {
19047: $captcha = 'original';
19048: }
19049: } elsif ($passwdconf{'captcha'} ne 'notused') {
19050: $captcha = 'original';
19051: }
19052: }
19053: }
1.1234 raeburn 19054: return ($captcha,$pubkey,$privkey,$version);
1.1094 raeburn 19055: }
19056:
19057: sub create_captcha {
19058: my %captcha_params = &captcha_settings();
19059: my ($output,$maxtries,$tries) = ('',10,0);
19060: while ($tries < $maxtries) {
19061: $tries ++;
19062: my $captcha = Authen::Captcha->new (
19063: output_folder => $captcha_params{'output_dir'},
19064: data_folder => $captcha_params{'db_dir'},
19065: );
19066: my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
19067:
19068: if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
19069: $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
1.1367 raeburn 19070: '<span class="LC_nobreak">'.
1.1094 raeburn 19071: &mt('Type in the letters/numbers shown below').' '.
1.1390 raeburn 19072: '<input type="text" size="5" name="code" value="" autocomplete="new-password" />'.
1.1367 raeburn 19073: '</span><br />'.
1.1176 raeburn 19074: '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1094 raeburn 19075: last;
19076: }
19077: }
1.1323 raeburn 19078: if ($output eq '') {
19079: &Apache::lonnet::logthis("Failed to create Captcha code after $tries attempts.");
19080: }
1.1094 raeburn 19081: return $output;
19082: }
19083:
19084: sub captcha_settings {
19085: my %captcha_params = (
19086: output_dir => $Apache::lonnet::perlvar{'lonCaptchaDir'},
19087: www_output_dir => "/captchaspool",
19088: db_dir => $Apache::lonnet::perlvar{'lonCaptchaDb'},
19089: numchars => '5',
19090: );
19091: return %captcha_params;
19092: }
19093:
19094: sub check_captcha {
19095: my ($captcha_chk,$captcha_error);
19096: my $code = $env{'form.code'};
19097: my $md5sum = $env{'form.crypt'};
19098: my %captcha_params = &captcha_settings();
19099: my $captcha = Authen::Captcha->new(
19100: output_folder => $captcha_params{'output_dir'},
19101: data_folder => $captcha_params{'db_dir'},
19102: );
1.1109 raeburn 19103: $captcha_chk = $captcha->check_code($code,$md5sum);
1.1094 raeburn 19104: my %captcha_hash = (
19105: 0 => 'Code not checked (file error)',
19106: -1 => 'Failed: code expired',
19107: -2 => 'Failed: invalid code (not in database)',
19108: -3 => 'Failed: invalid code (code does not match crypt)',
19109: );
19110: if ($captcha_chk != 1) {
19111: $captcha_error = $captcha_hash{$captcha_chk}
19112: }
19113: return ($captcha_chk,$captcha_error);
19114: }
19115:
19116: sub create_recaptcha {
1.1234 raeburn 19117: my ($pubkey,$version) = @_;
19118: if ($version >= 2) {
1.1367 raeburn 19119: return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>'.
19120: '<div style="padding:0;clear:both;margin:0;border:0"></div>';
1.1234 raeburn 19121: } else {
19122: my $use_ssl;
19123: if ($ENV{'SERVER_PORT'} == 443) {
19124: $use_ssl = 1;
19125: }
19126: my $captcha = Captcha::reCAPTCHA->new;
19127: return $captcha->get_options_setter({theme => 'white'})."\n".
19128: $captcha->get_html($pubkey,undef,$use_ssl).
19129: &mt('If the text is hard to read, [_1] will replace them.',
19130: '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
19131: '<br /><br />';
19132: }
1.1094 raeburn 19133: }
19134:
19135: sub check_recaptcha {
1.1234 raeburn 19136: my ($privkey,$version) = @_;
1.1094 raeburn 19137: my $captcha_chk;
1.1350 raeburn 19138: my $ip = &Apache::lonnet::get_requestor_ip();
1.1234 raeburn 19139: if ($version >= 2) {
19140: my %info = (
19141: secret => $privkey,
19142: response => $env{'form.g-recaptcha-response'},
1.1350 raeburn 19143: remoteip => $ip,
1.1234 raeburn 19144: );
1.1280 raeburn 19145: my $request=new HTTP::Request('POST','https://www.google.com/recaptcha/api/siteverify');
19146: $request->content(join('&',map {
19147: my $name = escape($_);
19148: "$name=" . ( ref($info{$_}) eq 'ARRAY'
19149: ? join("&$name=", map {escape($_) } @{$info{$_}})
19150: : &escape($info{$_}) );
19151: } keys(%info)));
19152: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',10,1);
1.1234 raeburn 19153: if ($response->is_success) {
19154: my $data = JSON::DWIW->from_json($response->decoded_content);
19155: if (ref($data) eq 'HASH') {
19156: if ($data->{'success'}) {
19157: $captcha_chk = 1;
19158: }
19159: }
19160: }
19161: } else {
19162: my $captcha = Captcha::reCAPTCHA->new;
19163: my $captcha_result =
19164: $captcha->check_answer(
19165: $privkey,
1.1350 raeburn 19166: $ip,
1.1234 raeburn 19167: $env{'form.recaptcha_challenge_field'},
19168: $env{'form.recaptcha_response_field'},
19169: );
19170: if ($captcha_result->{is_valid}) {
19171: $captcha_chk = 1;
19172: }
1.1094 raeburn 19173: }
19174: return $captcha_chk;
19175: }
19176:
1.1174 raeburn 19177: sub emailusername_info {
1.1244 raeburn 19178: my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1174 raeburn 19179: my %titles = &Apache::lonlocal::texthash (
19180: lastname => 'Last Name',
19181: firstname => 'First Name',
19182: institution => 'School/college/university',
19183: location => "School's city, state/province, country",
19184: web => "School's web address",
19185: officialemail => 'E-mail address at institution (if different)',
1.1244 raeburn 19186: id => 'Student/Employee ID',
1.1174 raeburn 19187: );
19188: return (\@fields,\%titles);
19189: }
19190:
1.1161 raeburn 19191: sub cleanup_html {
19192: my ($incoming) = @_;
19193: my $outgoing;
19194: if ($incoming ne '') {
19195: $outgoing = $incoming;
19196: $outgoing =~ s/;/;/g;
19197: $outgoing =~ s/\#/#/g;
19198: $outgoing =~ s/\&/&/g;
19199: $outgoing =~ s/</</g;
19200: $outgoing =~ s/>/>/g;
19201: $outgoing =~ s/\(/(/g;
19202: $outgoing =~ s/\)/)/g;
19203: $outgoing =~ s/"/"/g;
19204: $outgoing =~ s/'/'/g;
19205: $outgoing =~ s/\$/$/g;
19206: $outgoing =~ s{/}{/}g;
19207: $outgoing =~ s/=/=/g;
19208: $outgoing =~ s/\\/\/g
19209: }
19210: return $outgoing;
19211: }
19212:
1.1190 musolffc 19213: # Checks for critical messages and returns a redirect url if one exists.
19214: # $interval indicates how often to check for messages.
1.1282 raeburn 19215: # $context is the calling context -- roles, grades, contents, menu or flip.
1.1190 musolffc 19216: sub critical_redirect {
1.1282 raeburn 19217: my ($interval,$context) = @_;
1.1356 raeburn 19218: unless (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
19219: return ();
19220: }
1.1190 musolffc 19221: if ((time-$env{'user.criticalcheck.time'})>$interval) {
1.1282 raeburn 19222: if (($env{'request.course.id'}) && (($context eq 'flip') || ($context eq 'contents'))) {
19223: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
19224: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372 raeburn 19225: my $blocked = &blocking_status('alert',undef,$cnum,$cdom,undef,1);
1.1282 raeburn 19226: if ($blocked) {
19227: my $checkrole = "cm./$cdom/$cnum";
19228: if ($env{'request.course.sec'} ne '') {
19229: $checkrole .= "/$env{'request.course.sec'}";
19230: }
19231: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
19232: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
19233: return;
19234: }
19235: }
19236: }
1.1190 musolffc 19237: my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
19238: $env{'user.name'});
19239: &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
1.1191 raeburn 19240: my $redirecturl;
1.1190 musolffc 19241: if ($what[0]) {
1.1356 raeburn 19242: if (($what[0] ne 'con_lost') && ($what[0] ne 'no_such_host') && ($what[0]!~/^error\:/)) {
1.1190 musolffc 19243: $redirecturl='/adm/email?critical=display';
1.1191 raeburn 19244: my $url=&Apache::lonnet::absolute_url().$redirecturl;
19245: return (1, $url);
1.1190 musolffc 19246: }
1.1191 raeburn 19247: }
19248: }
19249: return ();
1.1190 musolffc 19250: }
19251:
1.1174 raeburn 19252: # Use:
19253: # my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
19254: #
19255: ##################################################
19256: # password associated functions #
19257: ##################################################
19258: sub des_keys {
19259: # Make a new key for DES encryption.
19260: # Each key has two parts which are returned separately.
19261: # Please note: Each key must be passed through the &hex function
19262: # before it is output to the web browser. The hex versions cannot
19263: # be used to decrypt.
19264: my @hexstr=('0','1','2','3','4','5','6','7',
19265: '8','9','a','b','c','d','e','f');
19266: my $lkey='';
19267: for (0..7) {
19268: $lkey.=$hexstr[rand(15)];
19269: }
19270: my $ukey='';
19271: for (0..7) {
19272: $ukey.=$hexstr[rand(15)];
19273: }
19274: return ($lkey,$ukey);
19275: }
19276:
19277: sub des_decrypt {
19278: my ($key,$cyphertext) = @_;
19279: my $keybin=pack("H16",$key);
19280: my $cypher;
19281: if ($Crypt::DES::VERSION>=2.03) {
19282: $cypher=new Crypt::DES $keybin;
19283: } else {
19284: $cypher=new DES $keybin;
19285: }
1.1233 raeburn 19286: my $plaintext='';
19287: my $cypherlength = length($cyphertext);
19288: my $numchunks = int($cypherlength/32);
19289: for (my $j=0; $j<$numchunks; $j++) {
19290: my $start = $j*32;
19291: my $cypherblock = substr($cyphertext,$start,32);
19292: my $chunk =
19293: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
19294: $chunk .=
19295: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
19296: $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
19297: $plaintext .= $chunk;
19298: }
1.1174 raeburn 19299: return $plaintext;
19300: }
19301:
1.1344 raeburn 19302: sub get_requested_shorturls {
1.1309 raeburn 19303: my ($cdom,$cnum,$navmap) = @_;
19304: return unless (ref($navmap));
1.1344 raeburn 19305: my ($numnew,$errors);
1.1309 raeburn 19306: my @toshorten = &Apache::loncommon::get_env_multiple('form.addtiny');
19307: if (@toshorten) {
19308: my (%maps,%resources,%titles);
19309: &Apache::loncourserespicker::enumerate_course_contents($navmap,\%maps,\%resources,\%titles,
19310: 'shorturls',$cdom,$cnum);
19311: if (keys(%resources)) {
1.1344 raeburn 19312: my %tocreate;
1.1309 raeburn 19313: foreach my $item (sort {$a <=> $b} (@toshorten)) {
19314: my $symb = $resources{$item};
19315: if ($symb) {
19316: $tocreate{$cnum.'&'.$symb} = 1;
19317: }
19318: }
1.1344 raeburn 19319: if (keys(%tocreate)) {
19320: ($numnew,$errors) = &make_short_symbs($cdom,$cnum,
19321: \%tocreate);
19322: }
1.1309 raeburn 19323: }
1.1344 raeburn 19324: }
19325: return ($numnew,$errors);
19326: }
19327:
19328: sub make_short_symbs {
19329: my ($cdom,$cnum,$tocreateref,$lockuser) = @_;
19330: my ($numnew,@errors);
19331: if (ref($tocreateref) eq 'HASH') {
19332: my %tocreate = %{$tocreateref};
1.1309 raeburn 19333: if (keys(%tocreate)) {
19334: my %coursetiny = &Apache::lonnet::dump('tiny',$cdom,$cnum);
19335: my $su = Short::URL->new(no_vowels => 1);
19336: my $init = '';
19337: my (%newunique,%addcourse,%courseonly,%failed);
19338: # get lock on tiny db
19339: my $now = time;
1.1344 raeburn 19340: if ($lockuser eq '') {
19341: $lockuser = $env{'user.name'}.':'.$env{'user.domain'};
19342: }
1.1309 raeburn 19343: my $lockhash = {
1.1344 raeburn 19344: "lock\0$now" => $lockuser,
1.1309 raeburn 19345: };
19346: my $tries = 0;
19347: my $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
19348: my ($code,$error);
19349: while (($gotlock ne 'ok') && ($tries<3)) {
19350: $tries ++;
19351: sleep 1;
1.1319 raeburn 19352: $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
1.1309 raeburn 19353: }
19354: if ($gotlock eq 'ok') {
19355: $init = &shorten_symbs($cdom,$init,$su,\%coursetiny,\%tocreate,\%newunique,
19356: \%addcourse,\%courseonly,\%failed);
19357: if (keys(%failed)) {
19358: my $numfailed = scalar(keys(%failed));
19359: push(@errors,&mt('error: could not obtain unique six character URL for [quant,_1,resource]',$numfailed));
19360: }
19361: if (keys(%newunique)) {
19362: my $putres = &Apache::lonnet::newput_dom('tiny',\%newunique,$cdom);
19363: if ($putres eq 'ok') {
19364: $numnew = scalar(keys(%newunique));
19365: my $newputres = &Apache::lonnet::newput('tiny',\%addcourse,$cdom,$cnum);
19366: unless ($newputres eq 'ok') {
19367: push(@errors,&mt('error: could not store course look-up of short URLs'));
19368: }
19369: } else {
19370: push(@errors,&mt('error: could not store unique six character URLs'));
19371: }
19372: }
19373: my $dellockres = &Apache::lonnet::del_dom('tiny',["lock\0$now"],$cdom);
19374: unless ($dellockres eq 'ok') {
19375: push(@errors,&mt('error: could not release lockfile'));
19376: }
19377: } else {
19378: push(@errors,&mt('error: could not obtain lockfile'));
19379: }
19380: if (keys(%courseonly)) {
19381: my $result = &Apache::lonnet::newput('tiny',\%courseonly,$cdom,$cnum);
19382: if ($result ne 'ok') {
19383: push(@errors,&mt('error: could not update course look-up of short URLs'));
19384: }
19385: }
19386: }
19387: }
19388: return ($numnew,\@errors);
19389: }
19390:
19391: sub shorten_symbs {
19392: my ($cdom,$init,$su,$coursetiny,$tocreate,$newunique,$addcourse,$courseonly,$failed) = @_;
19393: return unless ((ref($su)) && (ref($coursetiny) eq 'HASH') && (ref($tocreate) eq 'HASH') &&
19394: (ref($newunique) eq 'HASH') && (ref($addcourse) eq 'HASH') &&
19395: (ref($courseonly) eq 'HASH') && (ref($failed) eq 'HASH'));
19396: my (%possibles,%collisions);
19397: foreach my $key (keys(%{$tocreate})) {
19398: my $num = String::CRC32::crc32($key);
19399: my $tiny = $su->encode($num,$init);
19400: if ($tiny) {
19401: $possibles{$tiny} = $key;
19402: }
19403: }
19404: if (!$init) {
19405: $init = 1;
19406: } else {
19407: $init ++;
19408: }
19409: if (keys(%possibles)) {
19410: my @posstiny = keys(%possibles);
19411: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
19412: my %currtiny = &Apache::lonnet::get('tiny',\@posstiny,$cdom,$configuname);
19413: if (keys(%currtiny)) {
19414: foreach my $key (keys(%currtiny)) {
19415: next if ($currtiny{$key} eq '');
19416: if ($currtiny{$key} eq $possibles{$key}) {
19417: my ($tcnum,$tsymb) = split(/\&/,$currtiny{$key});
19418: unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
19419: $courseonly->{$tsymb} = $key;
19420: }
19421: } else {
19422: $collisions{$possibles{$key}} = 1;
19423: }
19424: delete($possibles{$key});
19425: }
19426: }
19427: foreach my $key (keys(%possibles)) {
19428: $newunique->{$key} = $possibles{$key};
19429: my ($tcnum,$tsymb) = split(/\&/,$possibles{$key});
19430: unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
19431: $addcourse->{$tsymb} = $key;
19432: }
19433: }
19434: }
19435: if (keys(%collisions)) {
19436: if ($init <5) {
19437: if (!$init) {
19438: $init = 1;
19439: } else {
19440: $init ++;
19441: }
19442: $init = &shorten_symbs($cdom,$init,$su,$coursetiny,\%collisions,
19443: $newunique,$addcourse,$courseonly,$failed);
19444: } else {
19445: foreach my $key (keys(%collisions)) {
19446: $failed->{$key} = 1;
19447: }
19448: }
19449: }
19450: return $init;
19451: }
19452:
1.1328 raeburn 19453: sub is_nonframeable {
1.1329 raeburn 19454: my ($url,$absolute,$hostname,$ip,$nocache) = @_;
19455: my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
1.1330 raeburn 19456: return if (($remprotocol eq '') || ($remhost eq ''));
1.1329 raeburn 19457:
19458: $remprotocol = lc($remprotocol);
19459: $remhost = lc($remhost);
19460: my $remport = 80;
19461: if ($remprotocol eq 'https') {
19462: $remport = 443;
19463: }
1.1330 raeburn 19464: my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
1.1329 raeburn 19465: if ($cached) {
19466: unless ($nocache) {
19467: if ($result) {
19468: return 1;
19469: } else {
19470: return 0;
19471: }
19472: }
19473: }
1.1328 raeburn 19474: my $uselink;
19475: my $request = new HTTP::Request('HEAD',$url);
19476: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',5);
19477: if ($response->is_success()) {
19478: my $secpolicy = lc($response->header('content-security-policy'));
19479: my $xframeop = lc($response->header('x-frame-options'));
19480: $secpolicy =~ s/^\s+|\s+$//g;
19481: $xframeop =~ s/^\s+|\s+$//g;
19482: if (($secpolicy ne '') || ($xframeop ne '')) {
1.1329 raeburn 19483: my $remotehost = $remprotocol.'://'.$remhost;
1.1328 raeburn 19484: my ($origin,$protocol,$port);
19485: if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
19486: $port = $ENV{'SERVER_PORT'};
19487: } else {
19488: $port = 80;
19489: }
19490: if ($absolute eq '') {
19491: $protocol = 'http:';
19492: if ($port == 443) {
19493: $protocol = 'https:';
19494: }
19495: $origin = $protocol.'//'.lc($hostname);
19496: } else {
19497: $origin = lc($absolute);
19498: ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
19499: }
19500: if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
19501: my $framepolicy = $1;
19502: $framepolicy =~ s/^\s+|\s+$//g;
19503: my @policies = split(/\s+/,$framepolicy);
19504: if (@policies) {
19505: if (grep(/^\Q'none'\E$/,@policies)) {
19506: $uselink = 1;
19507: } else {
19508: $uselink = 1;
19509: if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
19510: (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
19511: (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
19512: undef($uselink);
19513: }
19514: if ($uselink) {
19515: if (grep(/^\Q'self'\E$/,@policies)) {
19516: if (($origin ne '') && ($remotehost eq $origin)) {
19517: undef($uselink);
19518: }
19519: }
19520: }
19521: if ($uselink) {
19522: my @possok;
19523: if ($ip ne '') {
19524: push(@possok,$ip);
19525: }
19526: my $hoststr = '';
19527: foreach my $part (reverse(split(/\./,$hostname))) {
19528: if ($hoststr eq '') {
19529: $hoststr = $part;
19530: } else {
19531: $hoststr = "$part.$hoststr";
19532: }
19533: if ($hoststr eq $hostname) {
19534: push(@possok,$hostname);
19535: } else {
19536: push(@possok,"*.$hoststr");
19537: }
19538: }
19539: if (@possok) {
19540: foreach my $poss (@possok) {
19541: last if (!$uselink);
19542: foreach my $policy (@policies) {
19543: if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
19544: undef($uselink);
19545: last;
19546: }
19547: }
19548: }
19549: }
19550: }
19551: }
19552: }
19553: } elsif ($xframeop ne '') {
19554: $uselink = 1;
19555: my @policies = split(/\s*,\s*/,$xframeop);
19556: if (@policies) {
19557: unless (grep(/^deny$/,@policies)) {
19558: if ($origin ne '') {
19559: if (grep(/^sameorigin$/,@policies)) {
19560: if ($remotehost eq $origin) {
19561: undef($uselink);
19562: }
19563: }
19564: if ($uselink) {
19565: foreach my $policy (@policies) {
19566: if ($policy =~ /^allow-from\s*(.+)$/) {
19567: my $allowfrom = $1;
19568: if (($allowfrom ne '') && ($allowfrom eq $origin)) {
19569: undef($uselink);
19570: last;
19571: }
19572: }
19573: }
19574: }
19575: }
19576: }
19577: }
19578: }
19579: }
19580: }
1.1329 raeburn 19581: if ($nocache) {
19582: if ($cached) {
19583: my $devalidate;
19584: if ($uselink && !$result) {
19585: $devalidate = 1;
19586: } elsif (!$uselink && $result) {
19587: $devalidate = 1;
19588: }
19589: if ($devalidate) {
19590: &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
19591: }
19592: }
19593: } else {
19594: if ($uselink) {
19595: $result = 1;
19596: } else {
19597: $result = 0;
19598: }
19599: &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
19600: }
1.1328 raeburn 19601: return $uselink;
19602: }
19603:
1.1359 raeburn 19604: sub page_menu {
19605: my ($menucolls,$menunum) = @_;
19606: my %menu;
19607: foreach my $item (split(/;/,$menucolls)) {
19608: my ($num,$value) = split(/\%/,$item);
19609: if ($num eq $menunum) {
19610: my @entries = split(/\&/,$value);
19611: foreach my $entry (@entries) {
19612: my ($name,$fields) = split(/=/,$entry);
1.1368 raeburn 19613: if (($name eq 'top') || ($name eq 'inline') || ($name eq 'foot') || ($name eq 'main')) {
1.1359 raeburn 19614: $menu{$name} = $fields;
19615: } else {
19616: my @shown;
19617: if ($fields =~ /,/) {
19618: @shown = split(/,/,$fields);
19619: } else {
19620: @shown = ($fields);
19621: }
19622: if (@shown) {
19623: foreach my $field (@shown) {
19624: next if ($field eq '');
19625: $menu{$field} = 1;
19626: }
19627: }
19628: }
19629: }
19630: }
19631: }
19632: return %menu;
19633: }
19634:
1.112 bowersj2 19635: 1;
19636: __END__;
1.41 ng 19637:
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